Package org.cyclos.impl.utils.cluster

Class AbstractClusterHandlerImpl

java.lang.Object

org.cyclos.impl.utils.cluster.AbstractClusterHandlerImpl

All Implemented Interfaces:

CustomBean, ClusterHandler

Direct Known Subclasses:

HazelcastClusterHandlerImpl, NoClusterHandlerImpl

public abstract class AbstractClusterHandlerImpl
extends Object
implements ClusterHandler

Base implementation for ClusterHandler

Field Summary

Fields

Modifier and Type	Field	Description
protected ApplicationContext	applicationContext
protected BackgroundTaskHandlerImplementor	backgroundTaskHandler
protected BeanHandler	beanHandler
protected ConversionHandler	conversionHandler
protected CyclosProperties	cyclosProperties
protected DatabaseManager	databaseManager
protected DataSource	dataSource
protected InvokerHandler	invokerHandler
protected PollingTaskHandlerImplementor	pollingTaskHandler
protected RawEntityManagerHandler	rawEntityManagerHandler
protected TaskScheduler	taskScheduler

Constructor Summary

Constructors

Constructor	Description
AbstractClusterHandlerImpl()

Method Summary

Modifier and Type	Method	Description
void	awakePollingTasks(Set<PollingTask> pollingTasksToAwake)	Awakes the given PollingTasks
protected <K,V> LocalStorage<K,V>	createLocalStorage(LocalStorageType<K,V> type)
protected <K extends Serializable,V extends Serializable> SharedStorage<K,V>	createSharedStorage(SharedStorageType<K,V> type)	Actually creates a new shared storage.
protected void	doRunBackgroundTask(Long id)
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
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
protected void	initialize()
protected abstract CacheHandlerImplementor	instantiateCacheHandler()
protected abstract PushNotificationHandler	instantiatePushNotificationHandler()
boolean	lockDatabase()	Checks that there is no other Cyclos instance using the database and afterwards, locks the database.
protected void	runBackgroundTask(Long id)
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).
protected abstract boolean	shouldEnsureDatabaseIsNotLocked()
protected abstract boolean	shouldUnlockDatabase()
protected void	shutdown()

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

getHostId, getStartupTime, isAlive, isCluster

Field Detail

applicationContext

@Autowired
protected ApplicationContext applicationContext

beanHandler

@Autowired
protected BeanHandler beanHandler

taskScheduler

@Autowired
protected TaskScheduler taskScheduler

cyclosProperties

@Autowired
protected CyclosProperties cyclosProperties

pollingTaskHandler

@Autowired
protected PollingTaskHandlerImplementor pollingTaskHandler

backgroundTaskHandler

@Autowired
@Lazy
protected BackgroundTaskHandlerImplementor backgroundTaskHandler

invokerHandler

@Autowired
protected InvokerHandler invokerHandler

rawEntityManagerHandler

@Autowired
@Lazy
protected RawEntityManagerHandler rawEntityManagerHandler

conversionHandler

@Autowired
@Lazy
protected ConversionHandler conversionHandler

dataSource

@Autowired
protected DataSource dataSource

databaseManager

@Autowired
protected DatabaseManager databaseManager

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

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

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

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

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 void runBackgroundTasks(List<Long> ids)

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(org.cyclos.impl.ApplicationHandler). In some cases (for example, the initialization was already executed), it might do nothing, and just return false

Specified by:

runInitialization in interface ClusterHandler

runPollingTask

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

Description copied from interface: ClusterHandler

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.

Specified by:

runPollingTask in interface ClusterHandler

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

createLocalStorage

protected <K,V> LocalStorage<K,V> createLocalStorage(LocalStorageType<K,V> 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.

doRunBackgroundTask

protected void doRunBackgroundTask(Long id)

initialize

protected void initialize()

instantiateCacheHandler

protected abstract CacheHandlerImplementor instantiateCacheHandler()

instantiatePushNotificationHandler

protected abstract PushNotificationHandler instantiatePushNotificationHandler()

runBackgroundTask

protected void runBackgroundTask(Long id)

shouldEnsureDatabaseIsNotLocked

protected abstract boolean shouldEnsureDatabaseIsNotLocked()

shouldUnlockDatabase

protected abstract boolean shouldUnlockDatabase()

shutdown

protected void shutdown()