java.lang.Object
- org.cyclos.impl.AbstractServerComponent
- - org.cyclos.impl.AbstractGlobalServerComponent
  - - org.cyclos.impl.BaseGlobalHandlerImpl
    - - org.cyclos.impl.utils.cluster.AbstractClusterHandlerImpl

All Implemented Interfaces:

CustomBean, ClusterHandler

Direct Known Subclasses:

HazelcastClusterHandlerImpl, NoClusterHandlerImpl
```
public abstract class AbstractClusterHandlerImpl
extends BaseGlobalHandlerImpl
implements ClusterHandler
```
Base implementation for ClusterHandler

Nested Class Summary

Nested Classes
Modifier and Type Class Description

class AbstractClusterHandlerImpl.FinishedExecutionsHandlerImpl
- Nested classes/interfaces inherited from interface org.cyclos.impl.utils.cluster.ClusterHandler
  ClusterHandler.FinishedExecutionsHandler

Field Summary

Fields
Modifier and Type	Field	Description
`protected ApplicationContext`	`applicationContext`
`protected BackgroundTaskHandlerImplementor`	`backgroundTaskHandler`
`protected BeanHandler`	`beanHandler`
`protected CyclosProperties`	`cyclosProperties`
`protected DatabaseManager`	`databaseManager`
`protected DbLockHandler`	`dbLockHandler`
`static String`	`IGNORE_DB_LOCK_PROPERTY`
`protected boolean`	`ignoreDbLock`
`protected InvokerHandler`	`invokerHandler`
`protected LockHandler`	`lockHandler`
`protected NativeQueryHandler`	`nativeQueryHandler`
`protected PollingTaskHandlerImplementor`	`pollingTaskHandler`
`protected RawEntityManagerHandler`	`rawEntityManagerHandler`
`protected SystemMonitorServiceLocal`	`systemMonitorService`

Fields inherited from class org.cyclos.impl.AbstractServerComponent
accountHandler, configurationHandler, dataTranslationHandler, notificationHandler, profileFieldHandler, transactionHandler, translationHandler

Constructor Summary

Constructors
Constructor Description

AbstractClusterHandlerImpl()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`awakePollingTasks(Set<PollingTask> pollingTasksToAwake)`	Awakes the given `PollingTask`s
`protected <K,V> LocalStorage<K,V>`	`createLocalStorage(LocalStorageType<K,V> type)`
`protected <K,V> ReplicatedStorage<K,V>`	`createReplicatedStorage(ReplicatedStorageType type)`
`protected <K extends Serializable,V extends Serializable> SharedStorage<K,V>`	`createSharedStorage(SharedStorageType<K,V> type)`	Actually creates a new shared storage.
`protected abstract void`	`doRemoveFinishedBackgroundTaskExecutions(List<Long> ids)`
`protected abstract BlockingQueue<BackgroundTaskExecutionContext>`	`getBackgroundTaskQueue()`
`int`	`getBackgroundTasksQueueSize()`	Returns the current size of the background tasks queue
`protected abstract int`	`getBackgroundTaskThreads()`
`CacheHandlerImplementor`	`getCacheHandler()`	Returns the `CacheHandler` managed by this cluster
`<K,V> LocalStorage<K,V>`	`getLocalStorage(LocalStorageType<K,V> type)`	Returns the local storage for the given type
`PollingTaskHandlerImplementor`	`getPollingTaskHandler()`	Returns the `PollingTaskHandler` managed by this cluster
`PushNotificationHandler`	`getPushNotificationHandler()`	Returns the `PushNotificationHandler` which can be used to publish / subscribe to push notification events
`int`	`getRemainingBackgroundTaskCapacity()`	Returns number of `BackgroundTaskExecution` the cluster can accept.
`<K extends Serializable,V extends Serializable> ReplicatedStorage<K,V>`	`getReplicatedStorage(ReplicatedStorageType type)`	Returns a simple storage with a given name
`<K extends Serializable,V extends Serializable> SharedStorage<K,V>`	`getSharedStorage(SharedStorageType<K,V> type)`	Returns a shared storage with a given name
`protected void`	`initialize()`
`protected abstract CacheHandlerImplementor`	`instantiateCacheHandler()`
`protected abstract PollingTaskHandlerImplementor`	`instantiatePollingTaskHandler()`
`protected abstract PushNotificationHandler`	`instantiatePushNotificationHandler()`
`boolean`	`isCausedByShutdown(Throwable e)`	Returns whether the given exception was caused by a server shutdown.
`boolean`	`lockDatabase()`	Checks that there is no other Cyclos instance using the database and afterwards, locks the database.
`protected void`	`runBackgroundTask(BackgroundTaskExecutionContext task)`
`void`	`runBackgroundTasks(List<BackgroundTaskExecutionContext> tasks)`	Executes the background tasks with the given ids.
`boolean`	`runInitialization(ApplicationInitializationListener listener)`	Attempts to execute the given `ApplicationInitializationListener.onApplicationInitialization()`.
`boolean`	`runUpgradeInitialization(ApplicationUpgradeInitializationListener listener)`	Attempts to execute the given `ApplicationUpgradeInitializationListener.onApplicationUpgradeInitialization()`.
`protected abstract boolean`	`shouldEnsureDatabaseIsNotLocked()`
`protected abstract boolean`	`shouldUnlockDatabase()`
`protected void`	`shutdown()`

Methods inherited from class org.cyclos.impl.AbstractGlobalServerComponent
getBaseEntityManagerHandler, getEntityManager

Methods inherited from class org.cyclos.impl.AbstractServerComponent
dataTranslationProxy, dataTranslationProxy, delete, detach, doDataTranslationProxy, find, flush, from, getApplicationContext, getFormatter, getFormatter, getFormatter, getLogger, getRemoteAddress, getSessionData, mailContentBuilder, message, message, persist, processBatch, processBatch, refresh, remove, selectFrom, subQuery, update

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.cyclos.impl.utils.cluster.ClusterHandler
finishBackgroundTaskExecution, getBackgroundTaskExecutions, getFinishedBackgroundTaskExecutions, getHostId, getMemberRunningTask, getMembersData, getRunningPollingTasks, isAlive, isCluster

- Field Detail
  - IGNORE_DB_LOCK_PROPERTY
```
public static final String IGNORE_DB_LOCK_PROPERTY
```
    See Also:
    
    Constant Field Values
  - ignoreDbLock
```
protected boolean ignoreDbLock
```
  - pollingTaskHandler
```
protected PollingTaskHandlerImplementor pollingTaskHandler
```
  - applicationContext
```
@Autowired
protected ApplicationContext applicationContext
```
  - beanHandler
```
@Autowired
protected BeanHandler beanHandler
```
  - cyclosProperties
```
@Autowired
protected CyclosProperties cyclosProperties
```
  - backgroundTaskHandler
```
@Autowired
@Lazy
protected BackgroundTaskHandlerImplementor backgroundTaskHandler
```
  - invokerHandler
```
@Autowired
protected InvokerHandler invokerHandler
```
  - lockHandler
```
@Autowired
protected LockHandler lockHandler
```
  - rawEntityManagerHandler
```
@Autowired
@Lazy
protected RawEntityManagerHandler rawEntityManagerHandler
```
  - nativeQueryHandler
```
@Autowired
protected NativeQueryHandler nativeQueryHandler
```
  - dbLockHandler
```
protected DbLockHandler dbLockHandler
```
  - databaseManager
```
@Autowired
protected DatabaseManager databaseManager
```
  - systemMonitorService
```
@Lazy
@Autowired
protected SystemMonitorServiceLocal systemMonitorService
```
- Constructor Detail
  - AbstractClusterHandlerImpl
```
public AbstractClusterHandlerImpl()
```
- Method Detail
  - awakePollingTasks
```
public void awakePollingTasks(Set<PollingTask> pollingTasksToAwake)
```
    Description copied from interface: ClusterHandler
    
    Awakes the given PollingTasks
    
    Specified by:
    
    awakePollingTasks in interface ClusterHandler
  - getBackgroundTasksQueueSize
```
public int getBackgroundTasksQueueSize()
```
    Description copied from interface: ClusterHandler
    
    Returns the current size of the background tasks queue
    
    Specified by:
    
    getBackgroundTasksQueueSize in interface ClusterHandler
  - getCacheHandler
```
public final CacheHandlerImplementor getCacheHandler()
```
    Description copied from interface: ClusterHandler
    
    Returns the CacheHandler managed by this cluster
    
    Specified by:
    
    getCacheHandler in interface ClusterHandler
  - getLocalStorage
```
public <K,V> LocalStorage<K,V> getLocalStorage(LocalStorageType<K,V> type)
```
    Description copied from interface: ClusterHandler
    
    Returns the local storage for the given type
    
    Specified by:
    
    getLocalStorage in interface ClusterHandler
  - getPollingTaskHandler
```
public final PollingTaskHandlerImplementor getPollingTaskHandler()
```
    Description copied from interface: ClusterHandler
    
    Returns the PollingTaskHandler managed by this cluster
    
    Specified by:
    
    getPollingTaskHandler in interface ClusterHandler
  - getPushNotificationHandler
```
public final PushNotificationHandler getPushNotificationHandler()
```
    Description copied from interface: ClusterHandler
    
    Returns the PushNotificationHandler which can be used to publish / subscribe to push notification events
    
    Specified by:
    
    getPushNotificationHandler in interface ClusterHandler
  - getRemainingBackgroundTaskCapacity
```
public int getRemainingBackgroundTaskCapacity()
```
    Description copied from interface: ClusterHandler
    
    Returns number of BackgroundTaskExecution the cluster can accept.
    
    Specified by:
    
    getRemainingBackgroundTaskCapacity in interface ClusterHandler
  - getReplicatedStorage
```
public <K extends Serializable,V extends Serializable> ReplicatedStorage<K,V> getReplicatedStorage(ReplicatedStorageType type)
```
    Description copied from interface: ClusterHandler
    
    Returns a simple storage with a given name
    
    Specified by:
    
    getReplicatedStorage in interface ClusterHandler
  - getSharedStorage
```
public final <K extends Serializable,V extends Serializable> SharedStorage<K,V> getSharedStorage(SharedStorageType<K,V> type)
```
    Description copied from interface: ClusterHandler
    
    Returns a shared storage with a given name
    
    Specified by:
    
    getSharedStorage in interface ClusterHandler
  - isCausedByShutdown
```
public boolean isCausedByShutdown(Throwable e)
```
    Description copied from interface: ClusterHandler
    
    Returns whether the given exception was caused by a server shutdown. For example, InterruptedExceptions are considered to be caused by a shutdown.
    
    Specified by:
    
    isCausedByShutdown in interface ClusterHandler
  - lockDatabase
```
public boolean lockDatabase()
```
    Description copied from interface: ClusterHandler
    
    Checks that there is no other Cyclos instance using the database and afterwards, locks the database. Returns whether the database was actually locked.
    
    Specified by:
    
    lockDatabase in interface ClusterHandler
  - runBackgroundTasks
```
public final void runBackgroundTasks(List<BackgroundTaskExecutionContext> tasks)
```
    Description copied from interface: ClusterHandler
    
    Executes the background tasks with the given ids. The CyclosProperties.getMaxBackgroundTasks() is respected.
    
    Specified by:
    
    runBackgroundTasks in interface ClusterHandler
  - runInitialization
```
public boolean runInitialization(ApplicationInitializationListener listener)
```
    Description copied from interface: ClusterHandler
    
    Attempts to execute the given ApplicationInitializationListener.onApplicationInitialization(). In some cases (for example, the initialization was already executed), it might do nothing, and just return false
    
    Specified by:
    
    runInitialization in interface ClusterHandler
  - runUpgradeInitialization
```
public boolean runUpgradeInitialization(ApplicationUpgradeInitializationListener listener)
```
    Description copied from interface: ClusterHandler
    
    Attempts to execute the given ApplicationUpgradeInitializationListener.onApplicationUpgradeInitialization(). In some cases (for example, the initialization was already executed), it might do nothing, and just return false
    
    Specified by:
    
    runUpgradeInitialization in interface ClusterHandler
  - createLocalStorage
```
protected <K,V> LocalStorage<K,V> createLocalStorage(LocalStorageType<K,V> type)
```
  - createReplicatedStorage
```
protected <K,V> ReplicatedStorage<K,V> createReplicatedStorage(ReplicatedStorageType type)
```
  - createSharedStorage
```
protected <K extends Serializable,V extends Serializable> SharedStorage<K,V> createSharedStorage(SharedStorageType<K,V> type)
```
    Actually creates a new shared storage. The resulting value will be cached for the given name.
  - doRemoveFinishedBackgroundTaskExecutions
```
protected abstract void doRemoveFinishedBackgroundTaskExecutions(List<Long> ids)
```
  - getBackgroundTaskQueue
```
protected abstract BlockingQueue<BackgroundTaskExecutionContext> getBackgroundTaskQueue()
```
  - getBackgroundTaskThreads
```
protected abstract int getBackgroundTaskThreads()
```
  - initialize
```
protected void initialize()
```
  - instantiateCacheHandler
```
protected abstract CacheHandlerImplementor instantiateCacheHandler()
```
  - instantiatePollingTaskHandler
```
protected abstract PollingTaskHandlerImplementor instantiatePollingTaskHandler()
```
  - instantiatePushNotificationHandler
```
protected abstract PushNotificationHandler instantiatePushNotificationHandler()
```
  - runBackgroundTask
```
protected void runBackgroundTask(BackgroundTaskExecutionContext task)
```
  - shouldEnsureDatabaseIsNotLocked
```
protected abstract boolean shouldEnsureDatabaseIsNotLocked()
```
  - shouldUnlockDatabase
```
protected abstract boolean shouldUnlockDatabase()
```
  - shutdown
```
protected void shutdown()
```

Class AbstractClusterHandlerImpl

Nested Class Summary

Nested classes/interfaces inherited from interface org.cyclos.impl.utils.cluster.ClusterHandler

Field Summary

Fields inherited from class org.cyclos.impl.AbstractServerComponent

Constructor Summary

Method Summary

Methods inherited from class org.cyclos.impl.AbstractGlobalServerComponent

Methods inherited from class org.cyclos.impl.AbstractServerComponent

Methods inherited from class java.lang.Object

Methods inherited from interface org.cyclos.impl.utils.cluster.ClusterHandler

Field Detail

IGNORE_DB_LOCK_PROPERTY

ignoreDbLock

pollingTaskHandler

applicationContext

beanHandler

cyclosProperties

backgroundTaskHandler

invokerHandler

lockHandler

rawEntityManagerHandler

nativeQueryHandler

dbLockHandler

databaseManager

systemMonitorService

Constructor Detail

AbstractClusterHandlerImpl

Method Detail

awakePollingTasks

getBackgroundTasksQueueSize

getCacheHandler

getLocalStorage

getPollingTaskHandler

getPushNotificationHandler

getRemainingBackgroundTaskCapacity

getReplicatedStorage

getSharedStorage

isCausedByShutdown

lockDatabase

runBackgroundTasks

runInitialization

runUpgradeInitialization

createLocalStorage

createReplicatedStorage

createSharedStorage

doRemoveFinishedBackgroundTaskExecutions

getBackgroundTaskQueue

getBackgroundTaskThreads

initialize

instantiateCacheHandler

instantiatePollingTaskHandler

instantiatePushNotificationHandler

runBackgroundTask

shouldEnsureDatabaseIsNotLocked

shouldUnlockDatabase

shutdown