org.resoa.persistence

Class Persistor

java.lang.Object

org.resoa.persistence.Persistor

All Implemented Interfaces:

org.resoa.grid.GatewayEventListener, org.resoa.grid.ResoaPersistence

public class Persistor
extends java.lang.Object
implements org.resoa.grid.ResoaPersistence

Central Implementation of ResoaPersistence for both BTREE and RDBMS persistence in Resoa Grids

Nested Class Summary

Nested classes/interfaces inherited from interface org.resoa.grid.ResoaPersistence

org.resoa.grid.ResoaPersistence.PeristenceFactory, org.resoa.grid.ResoaPersistence.Policy

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DIR_DEFAULT_DATABASE Default root path for storage
static java.lang.String	DIR_DEFAULT_JOURNAL Default root path for journal
static org.resoa.util.Priority	GRIDPRIORITY Priority of persistence grid messages
static java.lang.String	KEY_DIR_DATABASE
static java.lang.String	KEY_DIR_JOURNAL
static int	MAXSYNCTIME_Seconds Default timeout for Persistence Slave synchronization during startup in seconds
static int	TIMEOUT_MASTERCOMMIT Default timeout for MASTERCOMMIT transactions in seconds
static int	TIMEOUT_SLAVECOMMIT Default timeout for SLAVECOMMIT transactions in seconds
static int	TIMEOUT_TASKCANCELS Timeout for transaction cancellation cache, default is 3 minutes.

Constructor Summary

Constructors

Constructor and Description
Persistor(org.resoa.topology.GridInfo gridInfo) Constructor for local default configuration
Persistor(org.resoa.service.ResoaServiceDomainExplorer domainExplorer, org.resoa.node.ResoaGateway gateway, CacheManager cacheManager) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
PersistentDomain	addPersistenceDomain(org.resoa.service.DomainDescriptor persistentDomainDesc, PersistenceConfig persistConfig) Enable persistence for a domain
<T> void	createNew(T instance)
<T> void	createNew(T instance, org.resoa.util.Priority prio)
<T> void	createNew(T instance, org.resoa.grid.ResoaPersistence.Policy policy)
<T> void	createNew(T instance, org.resoa.grid.ResoaPersistence.Policy policy, org.resoa.util.Priority prio)
void	delete(java.lang.Class<?> type, java.lang.Object key)
void	delete(java.lang.Class<?> type, java.lang.Object key, org.resoa.util.Priority prio)
void	delete(java.lang.Class<?> type, java.lang.Object key, org.resoa.grid.ResoaPersistence.Policy policy)
void	delete(java.lang.Class<?> type, java.lang.Object key, org.resoa.grid.ResoaPersistence.Policy policy, org.resoa.util.Priority prio)
<T> void	delete(T instance)
<T> void	delete(T instance, org.resoa.util.Priority prio)
<T> void	delete(T instance, org.resoa.grid.ResoaPersistence.Policy policy)
<T> void	delete(T instance, org.resoa.grid.ResoaPersistence.Policy policy, org.resoa.util.Priority prio)
void	executeTask(Task task, PersistentDomain domain) Execute a task (called by PersistentDomain for Slave Commit processing)
boolean	exists(java.lang.Class<?> type, java.lang.Object key) checks, if an instance exists in storage
<T> boolean	exists(T instance)
CacheManager	getCacheManager()
DatabaseManager	getDatabaseManager(java.lang.String dbType) Get a database manager instance for a sql database
java.lang.String	getDatabaseRootDir()
org.resoa.node.DataSourceProvider	getDataSourceProvider()
DatabaseTransition	getDbTransition(java.lang.String serviceDomain)
DatabaseTransition	getDbTransitionForType(java.lang.String typeName)
org.resoa.service.ResoaServiceDomainExplorer	getDomainExplorer()
ExecutionLogManager	getExecutionLogManager(java.lang.String domain) Return the ExecutionLogManager for a domain
org.resoa.topology.GridInfo	getGridInfo()
java.lang.String	getJournalRootDir()
java.lang.String	getNodeName()
PersistenceMode	getPersistenceMode(java.lang.String domain)
PersistencePolicy	getPersistencePolicy(org.resoa.grid.ResoaPersistence.Policy policy) Returns the policy implementation
PersistencePolicy	getPersistencePolicy(java.lang.String policyName) Returns the policy implementation
PersistentDomain	getPersistentDomainDescriptor(java.lang.String domain) Return the persistence domain descriptor
java.util.List<PersistentDomain>	getPersistentDomains() Get all active peristent domains
<T> PersistentType<T>	getPersistentType(java.lang.Class<T> persistentType) Get a peristent type descriptor
PersistentType<?>	getPersistentType(java.lang.String typeName) Get a peristentType descriptor
org.resoa.node.ResoaGateway	getResoaGateway()
TaskThreadPool	getThreadPool()
TransactionLogger	getTransactionLogger()
void	indicatePersistenceError(Task task, PersistentDomain domain, org.resoa.exception.PersistenceException pex) Handles Persistence exceptions during final storage processing
boolean	isDomainMaster(java.lang.String domain)
void	onDomainDeployment(org.resoa.service.DomainDescriptor persistentDomainDesc)
void	onDomainUnDeployment(java.lang.String domain)
void	onGatewayStop()
void	onNodeDisconnect(org.resoa.stack.config.StackProfile profile)
void	processExecutionLog(ExecLog log, boolean isIntialLog) Process an ExecutionLog.
<T> T	read(java.lang.Class<T> type, java.lang.Object key)
<T> java.util.List<T>	read(java.lang.Class<T> type, org.resoa.grid.RecordSet processingRules)
org.resoa.grid.RecordSet	readJSON(java.lang.Class<?> type, org.resoa.grid.RecordSet processingRules, boolean requestKeysOnly)
java.lang.String	readJSON(java.lang.Class<?> type, java.lang.String key)
int	requestExecutionLog(PersistentDomain persistentDomain) Request the executionLog from Master
void	setCacheManager(CacheManager cacheManager) Set the cache manager instance.
void	setDatabaseRootDir(java.lang.String dbRootDir, boolean mergeWithGatwayPath)
void	setDataSourceProvider(org.resoa.node.DataSourceProvider dataSourceProvider)
void	setGridInfo(org.resoa.topology.GridInfo gridInfo)
void	setJournalRootDir(java.lang.String dbJournalDir, boolean mergeWithGatwayPath)
void	setPersistenceMode(java.lang.String domain, PersistenceMode newMode) Set the peristence mode
void	setStateListener(StateListener stateListener) Register a listener for task status changes
protected void	startSynchronization(PersistentDomain pdom) Wait for the end of the synchronization of persistent mode MASTER/SLAVE.
void	stop(boolean waitForPoolThreadsEnd) Stop all persistent services
<T> void	store(java.util.List<T> instances, org.resoa.grid.ResoaPersistence.Policy policy, org.resoa.util.Priority prio)
<T> void	store(T instance)
<T> void	store(T instance, org.resoa.util.Priority prio)
<T> void	store(T instance, org.resoa.grid.ResoaPersistence.Policy policy)
<T> void	store(T instance, org.resoa.grid.ResoaPersistence.Policy policy, org.resoa.util.Priority prio)
void	updateTaskStatus(TaskStatus newStatus, Task task) Updates the task status with broadcast to status change listeners
PersistencePolicy	validatePersistencePolicy(Task task, PersistencePolicy currentPolicy, boolean isCreateNew) Validate the policy.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MAXSYNCTIME_Seconds

public static int MAXSYNCTIME_Seconds

Default timeout for Persistence Slave synchronization during startup in seconds

GRIDPRIORITY

public static org.resoa.util.Priority GRIDPRIORITY

Priority of persistence grid messages

TIMEOUT_MASTERCOMMIT

public static int TIMEOUT_MASTERCOMMIT

Default timeout for MASTERCOMMIT transactions in seconds

TIMEOUT_SLAVECOMMIT

public static int TIMEOUT_SLAVECOMMIT

Default timeout for SLAVECOMMIT transactions in seconds

TIMEOUT_TASKCANCELS

public static int TIMEOUT_TASKCANCELS

Timeout for transaction cancellation cache, default is 3 minutes. Used within resoa.perstistence

DIR_DEFAULT_DATABASE

public static java.lang.String DIR_DEFAULT_DATABASE

Default root path for storage

DIR_DEFAULT_JOURNAL

public static java.lang.String DIR_DEFAULT_JOURNAL

Default root path for journal

KEY_DIR_JOURNAL

public static java.lang.String KEY_DIR_JOURNAL

KEY_DIR_DATABASE

public static java.lang.String KEY_DIR_DATABASE

Constructor Detail

Persistor

public Persistor(org.resoa.topology.GridInfo gridInfo)

Constructor for local default configuration

Parameters:

gridInfo -

Persistor

public Persistor(org.resoa.service.ResoaServiceDomainExplorer domainExplorer,
         org.resoa.node.ResoaGateway gateway,
         CacheManager cacheManager)

Constructor

Parameters:

gateway - the gateway to use for grid persistence

domainExplorer -

cacheManager -

Method Detail

getDataSourceProvider

public org.resoa.node.DataSourceProvider getDataSourceProvider()

Returns:

the dataSourceProvider

setDataSourceProvider

public void setDataSourceProvider(org.resoa.node.DataSourceProvider dataSourceProvider)

Parameters:

dataSourceProvider - the dataSourceProvider to set

setStateListener

public void setStateListener(StateListener stateListener)

Register a listener for task status changes

Parameters:

stateListener - the stateListener to set

getCacheManager

public CacheManager getCacheManager()

Returns:

the CacheManager

getDatabaseManager

public DatabaseManager getDatabaseManager(java.lang.String dbType)
                                   throws org.resoa.exception.PersistenceException

Get a database manager instance for a sql database

Parameters:

dbType - the database type (currently supported: mysql, postgresql)

Throws:

org.resoa.exception.ResoaException

org.resoa.exception.PersistenceException

setCacheManager

public void setCacheManager(CacheManager cacheManager)

Set the cache manager instance. By default a MemoryCacheManager is used. Set a custom CacheManager before persistent domain deployment.

Parameters:

cacheManager -

getGridInfo

public org.resoa.topology.GridInfo getGridInfo()

Returns:

the gridInfo

setGridInfo

public void setGridInfo(org.resoa.topology.GridInfo gridInfo)

Parameters:

gridInfo - the gridInfo to set

getResoaGateway

public org.resoa.node.ResoaGateway getResoaGateway()

Returns:

the Resoa Gateway

getNodeName

public java.lang.String getNodeName()

Returns:

the nodeName

getDatabaseRootDir

public java.lang.String getDatabaseRootDir()

Returns:

the databaseRootDir

setDatabaseRootDir

public void setDatabaseRootDir(java.lang.String dbRootDir,
                      boolean mergeWithGatwayPath)

Parameters:

dbRootDir - the dbRootPath to set

mergeWithGatwayPath - if true, the path will be combined with the gateway config root path

getJournalRootDir

public java.lang.String getJournalRootDir()

Returns:

the databaseRootPath

setJournalRootDir

public void setJournalRootDir(java.lang.String dbJournalDir,
                     boolean mergeWithGatwayPath)

Parameters:

dbJournalDir - the dbRootPath to set

mergeWithGatwayPath - if true, the path will be combined with the gateway config root path

getThreadPool

public TaskThreadPool getThreadPool()

Returns:

the Thread pool

getDbTransition

public DatabaseTransition getDbTransition(java.lang.String serviceDomain)

Parameters:

serviceDomain - the service domain name

Returns:

the dbTransition

getDbTransitionForType

public DatabaseTransition getDbTransitionForType(java.lang.String typeName)

Parameters:

typeName - the entity name

Returns:

the dbTransition

getDomainExplorer

public org.resoa.service.ResoaServiceDomainExplorer getDomainExplorer()

Returns:

the domainExplorer

updateTaskStatus

public void updateTaskStatus(TaskStatus newStatus,
                    Task task)

Updates the task status with broadcast to status change listeners

Parameters:

newStatus - the new status

task - the task

getPersistenceMode

public PersistenceMode getPersistenceMode(java.lang.String domain)

Parameters:

domain - the Service domain name

Returns:

the persistence mode of a domain

setPersistenceMode

public void setPersistenceMode(java.lang.String domain,
                      PersistenceMode newMode)

Set the peristence mode

Parameters:

domain -

newMode -

getPersistentDomainDescriptor

public PersistentDomain getPersistentDomainDescriptor(java.lang.String domain)

Return the persistence domain descriptor

Parameters:

domain - the service domain name

Returns:

the PersistenceDomain descriptor

getPersistentDomains

public java.util.List<PersistentDomain> getPersistentDomains()

Get all active peristent domains

isDomainMaster

public boolean isDomainMaster(java.lang.String domain)

Parameters:

domain - the service domain name

Returns:

true, if the service domain runs in MASTER mode

getPersistentType

public PersistentType<?> getPersistentType(java.lang.String typeName)

Get a peristentType descriptor

Parameters:

typeName - the class name

Returns:

the PersistentType Descriptor for a class name

getPersistentType

public <T> PersistentType<T> getPersistentType(java.lang.Class<T> persistentType)

Get a peristent type descriptor

Type Parameters:

T -

Parameters:

persistentType - the persistent class name

Returns:

the PersistentDescriptor for a class

onDomainDeployment

public void onDomainDeployment(org.resoa.service.DomainDescriptor persistentDomainDesc)
                        throws org.resoa.exception.ResoaException

Specified by:

onDomainDeployment in interface org.resoa.grid.GatewayEventListener

Throws:

org.resoa.exception.ResoaException

addPersistenceDomain

public PersistentDomain addPersistenceDomain(org.resoa.service.DomainDescriptor persistentDomainDesc,
                                    PersistenceConfig persistConfig)
                                      throws org.resoa.exception.PersistenceException

Enable persistence for a domain

Parameters:

persistentDomainDesc -

persistConfig -

Throws:

org.resoa.exception.PersistenceException

getTransactionLogger

public TransactionLogger getTransactionLogger()
                                       throws org.resoa.exception.PersistenceException

Returns:

the transactionLogger for Task errors (persistence domain resoa.persistence)

Throws:

org.resoa.exception.PersistenceException

onDomainUnDeployment

public void onDomainUnDeployment(java.lang.String domain)

Specified by:

onDomainUnDeployment in interface org.resoa.grid.GatewayEventListener

startSynchronization

protected void startSynchronization(PersistentDomain pdom)

Wait for the end of the synchronization of persistent mode MASTER/SLAVE.

stop

public void stop(boolean waitForPoolThreadsEnd)

Stop all persistent services

Parameters:

waitForPoolThreadsEnd -

getPersistencePolicy

public PersistencePolicy getPersistencePolicy(org.resoa.grid.ResoaPersistence.Policy policy)

Returns the policy implementation

Parameters:

policy -

Returns:

the implementation instance of the policy

getPersistencePolicy

public PersistencePolicy getPersistencePolicy(java.lang.String policyName)

Returns the policy implementation

Parameters:

policyName - the policy as String

Returns:

the implementation instance of the policy, LOGFILEPERSIST is default.

validatePersistencePolicy

public PersistencePolicy validatePersistencePolicy(Task task,
                                          PersistencePolicy currentPolicy,
                                          boolean isCreateNew)

Validate the policy. CreateNew Instructions will need MASTERCOMMIT policy in any case.

Parameters:

task -

currentPolicy -

isCreateNew -

getExecutionLogManager

public ExecutionLogManager getExecutionLogManager(java.lang.String domain)

Return the ExecutionLogManager for a domain

Parameters:

domain -

requestExecutionLog

public int requestExecutionLog(PersistentDomain persistentDomain)

Request the executionLog from Master

Parameters:

persistentDomain - the persistent domain descriptor

Returns:

the number of nodes, the request is send to

processExecutionLog

public void processExecutionLog(ExecLog log,
                       boolean isIntialLog)
                         throws org.resoa.exception.PersistenceException

Process an ExecutionLog. Invoked by ExeclogService on Master execution log arrival

Parameters:

log - the ExecutionLog

Throws:

org.resoa.exception.PersistenceException

executeTask

public void executeTask(Task task,
               PersistentDomain domain)

Execute a task (called by PersistentDomain for Slave Commit processing)

indicatePersistenceError

public void indicatePersistenceError(Task task,
                            PersistentDomain domain,
                            org.resoa.exception.PersistenceException pex)

Handles Persistence exceptions during final storage processing

Parameters:

task - the Task causing the error

domain - the domain

pex - the causing exception

onGatewayStop

public void onGatewayStop()

Specified by:

onGatewayStop in interface org.resoa.grid.GatewayEventListener

onNodeDisconnect

public void onNodeDisconnect(org.resoa.stack.config.StackProfile profile)

Specified by:

onNodeDisconnect in interface org.resoa.grid.GatewayEventListener

store

public <T> void store(T instance,
             org.resoa.grid.ResoaPersistence.Policy policy,
             org.resoa.util.Priority prio)
           throws org.resoa.exception.PersistenceException

Throws:

org.resoa.exception.PersistenceException

store

public <T> void store(T instance,
             org.resoa.grid.ResoaPersistence.Policy policy)
           throws org.resoa.exception.PersistenceException

Specified by:

store in interface org.resoa.grid.ResoaPersistence

Throws:

org.resoa.exception.PersistenceException

store

public <T> void store(T instance,
             org.resoa.util.Priority prio)
           throws org.resoa.exception.PersistenceException

Throws:

org.resoa.exception.PersistenceException

store

public <T> void store(T instance)
           throws org.resoa.exception.PersistenceException

Specified by:

store in interface org.resoa.grid.ResoaPersistence

Throws:

org.resoa.exception.PersistenceException

store

public <T> void store(java.util.List<T> instances,
             org.resoa.grid.ResoaPersistence.Policy policy,
             org.resoa.util.Priority prio)
           throws org.resoa.exception.PersistenceException

Throws:

org.resoa.exception.PersistenceException

createNew

public <T> void createNew(T instance,
                 org.resoa.grid.ResoaPersistence.Policy policy,
                 org.resoa.util.Priority prio)
               throws org.resoa.exception.PersistenceException

Throws:

org.resoa.exception.PersistenceException

createNew

public <T> void createNew(T instance,
                 org.resoa.util.Priority prio)
               throws org.resoa.exception.PersistenceException

Throws:

org.resoa.exception.PersistenceException

createNew

public <T> void createNew(T instance,
                 org.resoa.grid.ResoaPersistence.Policy policy)
               throws org.resoa.exception.PersistenceException

Throws:

org.resoa.exception.PersistenceException

createNew

public <T> void createNew(T instance)
               throws org.resoa.exception.PersistenceException

Specified by:

createNew in interface org.resoa.grid.ResoaPersistence

Throws:

org.resoa.exception.PersistenceException

delete

public <T> void delete(T instance)
            throws org.resoa.exception.PersistenceException

Specified by:

delete in interface org.resoa.grid.ResoaPersistence

Throws:

org.resoa.exception.PersistenceException

delete

public <T> void delete(T instance,
              org.resoa.grid.ResoaPersistence.Policy policy)
            throws org.resoa.exception.PersistenceException

Specified by:

delete in interface org.resoa.grid.ResoaPersistence

Throws:

org.resoa.exception.PersistenceException

delete

public <T> void delete(T instance,
              org.resoa.util.Priority prio)
            throws org.resoa.exception.PersistenceException

Throws:

org.resoa.exception.PersistenceException

delete

public <T> void delete(T instance,
              org.resoa.grid.ResoaPersistence.Policy policy,
              org.resoa.util.Priority prio)
            throws org.resoa.exception.PersistenceException

Throws:

org.resoa.exception.PersistenceException

delete

public void delete(java.lang.Class<?> type,
          java.lang.Object key,
          org.resoa.util.Priority prio)
            throws org.resoa.exception.PersistenceException

Throws:

org.resoa.exception.PersistenceException

delete

public void delete(java.lang.Class<?> type,
          java.lang.Object key,
          org.resoa.grid.ResoaPersistence.Policy policy)
            throws org.resoa.exception.PersistenceException

Specified by:

delete in interface org.resoa.grid.ResoaPersistence

Throws:

org.resoa.exception.PersistenceException

delete

public void delete(java.lang.Class<?> type,
          java.lang.Object key)
            throws org.resoa.exception.PersistenceException

Specified by:

delete in interface org.resoa.grid.ResoaPersistence

Throws:

org.resoa.exception.PersistenceException

delete

public void delete(java.lang.Class<?> type,
          java.lang.Object key,
          org.resoa.grid.ResoaPersistence.Policy policy,
          org.resoa.util.Priority prio)
            throws org.resoa.exception.PersistenceException

Throws:

org.resoa.exception.PersistenceException

exists

public <T> boolean exists(T instance)

Specified by:

exists in interface org.resoa.grid.ResoaPersistence

exists

public boolean exists(java.lang.Class<?> type,
             java.lang.Object key)

checks, if an instance exists in storage

Specified by:

exists in interface org.resoa.grid.ResoaPersistence

Parameters:

type - the type

key - the key

Returns:

true if exists

read

public <T> T read(java.lang.Class<T> type,
         java.lang.Object key)

Specified by:

read in interface org.resoa.grid.ResoaPersistence

readJSON

public java.lang.String readJSON(java.lang.Class<?> type,
                        java.lang.String key)

read

public <T> java.util.List<T> read(java.lang.Class<T> type,
                         org.resoa.grid.RecordSet processingRules)

Specified by:

read in interface org.resoa.grid.ResoaPersistence

readJSON

public org.resoa.grid.RecordSet readJSON(java.lang.Class<?> type,
                                org.resoa.grid.RecordSet processingRules,
                                boolean requestKeysOnly)
                                  throws java.util.regex.PatternSyntaxException

Throws:

java.util.regex.PatternSyntaxException