Package org.cyclos.impl.utils.cluster

Interface ClusterHandler

All Superinterfaces:

CustomBean

All Known Implementing Classes:

AbstractClusterHandlerImpl, HazelcastClusterHandlerImpl, NoClusterHandlerImpl

public interface ClusterHandler
extends CustomBean

Handler for Cyclos 4 cluster, providing aspects like caches and task synchronization

Method Summary

Modifier and Type	Method	Description
void	awakePollingTasks(Set<PollingTask> pollingTasksToAwake)	Awakes the given PollingTasks
CacheHandlerImplementor	getCacheHandler()	Returns the CacheHandler managed by this cluster
String	getHostId()	Returns the current host identifier
<K,V> LocalStorage<K,V>	getLocalStorage(LocalStorageType<K,V> type)	Returns the local storage for the given type
PushNotificationHandler	getPushNotificationHandler()	Returns the PushNotificationHandler which can be used to publish / subscribe to push notification events
<K extends Serializable,V extends Serializable> SharedStorage<K,V>	getSharedStorage(SharedStorageType<K,V> type)	Returns a shared storage with a given name
long	getStartupTime()	Returns when the cluster was started up
boolean	isAlive()	Returns whether the cluster (or local instance) is still alive
boolean	isCluster()	Returns whether we're actually running in a cluster or as a single node installation
boolean	lockDatabase()	Checks that there is no other Cyclos instance using the database and afterwards, locks the database.
void	runBackgroundTasks(List<Long> ids)	Executes the background tasks with the given ids.
boolean	runInitialization(ApplicationInitializationListener listener)	Attempts to execute the given ApplicationInitializationListener#onApplicationInitialization(org.cyclos.impl.ApplicationHandler).
boolean	runPollingTask(PollingTask task, boolean awake, Date nextExecution)	Attempts to execute the given PollingTask, except if it is already running in some other cluster node (in this case, returning false).

Method Detail

awakePollingTasks

void awakePollingTasks(Set<PollingTask> pollingTasksToAwake)

Awakes the given PollingTasks

getCacheHandler

CacheHandlerImplementor getCacheHandler()

Returns the CacheHandler managed by this cluster

getHostId

String getHostId()

Returns the current host identifier

getLocalStorage

<K,V> LocalStorage<K,V> getLocalStorage(LocalStorageType<K,V> type)

Returns the local storage for the given type

getPushNotificationHandler

PushNotificationHandler getPushNotificationHandler()

Returns the PushNotificationHandler which can be used to publish / subscribe to push notification events

getSharedStorage

<K extends Serializable,V extends Serializable> SharedStorage<K,V> getSharedStorage(SharedStorageType<K,V> type)

Returns a shared storage with a given name

getStartupTime

long getStartupTime()

Returns when the cluster was started up

isAlive

boolean isAlive()

Returns whether the cluster (or local instance) is still alive

isCluster

boolean isCluster()

Returns whether we're actually running in a cluster or as a single node installation

lockDatabase

boolean lockDatabase()

Checks that there is no other Cyclos instance using the database and afterwards, locks the database. Returns whether the database was actually locked.

runBackgroundTasks

void runBackgroundTasks(List<Long> ids)

Executes the background tasks with the given ids. The CyclosProperties.getMaxBackgroundTasks() is respected.

runInitialization

boolean runInitialization(ApplicationInitializationListener listener)

Attempts to execute the given ApplicationInitializationListener#onApplicationInitialization(org.cyclos.impl.ApplicationHandler). In some cases (for example, the initialization was already executed), it might do nothing, and just return false

runPollingTask

boolean runPollingTask(PollingTask task,
                       boolean awake,
                       Date nextExecution)

Attempts to execute the given PollingTask, except if it is already running in some other cluster node (in this case, returning false). The CyclosProperties.getMaxBackgroundTasks() is respected.

Parameters:

task - The task to run

awake - A flag indicating whether the given task has been manually awake (true) or is executing after a timeout (false)

nextExecution - The date it is scheduled the next execution