org.cyclos.impl.utils.cluster

Interface ClusterHandler

All Superinterfaces:

org.cyclos.impl.CustomBean

public interface ClusterHandler
extends org.cyclos.impl.CustomBean

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

Author:

luis

Method Summary

Modifier and Type	Method and Description
void	awakePollingTasks(java.util.Set<org.cyclos.impl.utils.tasks.PollingTask> pollingTasksToAwake) Awakes the given PollingTasks
void	blockUntilReady(java.lang.String key) If there is a write block for the key then it blocks the current thread until the write lock is released. Otherwise it do nothing.
<T> T	doWithSessionTimeoutMap(com.google.common.base.Function<java.util.Map<java.lang.String,java.lang.Long>,T> callback) Runs the given function with access to the session timeout map, making sure the access to it is synchronized
org.cyclos.impl.utils.cache.CacheHandlerImplementor	getCacheHandler() Returns the CacheHandler managed by this cluster
java.lang.String	getHostId() Returns the current host identifier
java.util.Map<java.lang.String,java.lang.Long>	getSessionTimeoutMap() Returns the Map which stores the session timeouts
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
void	runBackgroundTasks(java.util.List<java.lang.Long> ids) Executes the background tasks with the given ids.
boolean	runInitialization(org.cyclos.impl.ApplicationInitializationListener listener) Attempts to execute the given ApplicationInitializationListener#onApplicationInitialization(org.cyclos.impl.ApplicationHandler).
boolean	runPollingTask(org.cyclos.impl.utils.tasks.PollingTask task, boolean awake) Attempts to execute the given PollingTask, except if it is already running in some other cluster node (in this case, returning false).
java.lang.Runnable	writelock(java.lang.String key) Locks the key for write (exclusive lock).

Method Detail

awakePollingTasks

void awakePollingTasks(java.util.Set<org.cyclos.impl.utils.tasks.PollingTask> pollingTasksToAwake)

Awakes the given PollingTasks

blockUntilReady

void blockUntilReady(java.lang.String key)
              throws java.lang.InterruptedException

If there is a write block for the key then it blocks the current thread until the write lock is released.
Otherwise it do nothing.

Parameters:

key -

Throws:

java.lang.InterruptedException

doWithSessionTimeoutMap

<T> T doWithSessionTimeoutMap(com.google.common.base.Function<java.util.Map<java.lang.String,java.lang.Long>,T> callback)

Runs the given function with access to the session timeout map, making sure the access to it is synchronized

getCacheHandler

org.cyclos.impl.utils.cache.CacheHandlerImplementor getCacheHandler()

Returns the CacheHandler managed by this cluster

getHostId

java.lang.String getHostId()

Returns the current host identifier

getSessionTimeoutMap

java.util.Map<java.lang.String,java.lang.Long> getSessionTimeoutMap()

Returns the Map which stores the session timeouts

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

runBackgroundTasks

void runBackgroundTasks(java.util.List<java.lang.Long> ids)

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

runInitialization

boolean runInitialization(org.cyclos.impl.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(org.cyclos.impl.utils.tasks.PollingTask task,
                       boolean awake)

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)

writelock

java.lang.Runnable writelock(java.lang.String key)

Locks the key for write (exclusive lock).

Returns:

Runnable instance that MUST be ran to release the lock.