org.springframework.statemachine.zookeeper

Class ZookeeperStateMachineEnsemble<S,E>

java.lang.Object

org.springframework.statemachine.support.LifecycleObjectSupport

org.springframework.statemachine.ensemble.StateMachineEnsembleObjectSupport<S,E>

org.springframework.statemachine.zookeeper.ZookeeperStateMachineEnsemble<S,E>

Type Parameters:

S - the type of state

E - the type of event

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle, StateMachineEnsemble<S,E>

Direct Known Subclasses:

LeaderZookeeperStateMachineEnsemble

public class ZookeeperStateMachineEnsemble<S,E>
extends StateMachineEnsembleObjectSupport<S,E>

StateMachineEnsemble backed by a zookeeper.

Author:

Janne Valkealahti

Constructor Summary

Constructors

Constructor and Description
ZookeeperStateMachineEnsemble(org.apache.curator.framework.CuratorFramework curatorClient, java.lang.String basePath) Instantiates a new zookeeper state machine ensemble.
ZookeeperStateMachineEnsemble(org.apache.curator.framework.CuratorFramework curatorClient, java.lang.String basePath, boolean cleanState, int logSize) Instantiates a new zookeeper state machine ensemble.

Method Summary

Modifier and Type	Method and Description
protected void	doStart() Subclasses may implement this method with the start behavior.
protected void	doStop() Subclasses may implement this method with the stop behavior.
StateMachine<S,E>	getLeader() Gets the ensemble leader.
StateMachineContext<S,E>	getState() Gets the state as a StateMachineContext.
void	join(StateMachine<S,E> stateMachine) Request a join to a state machine ensemble.
void	leave(StateMachine<S,E> stateMachine) Request a leave from an ensemble.
protected void	onInit() Subclasses may implement this for initialization logic.
protected void	registerWatcherForStatePath() Register existing CuratorWatcher for a state path.
void	setState(StateMachineContext<S,E> context) Sets the state as a StateMachineContext.
java.lang.String	toString()

Methods inherited from class org.springframework.statemachine.ensemble.StateMachineEnsembleObjectSupport

addEnsembleListener, notifyError, notifyGranted, notifyJoined, notifyLeft, notifyRevoked, notifyStateChanged, removeEnsembleListener

Methods inherited from class org.springframework.statemachine.support.LifecycleObjectSupport

afterPropertiesSet, destroy, doDestroy, getBeanFactory, getPhase, getTaskExecutor, getTaskScheduler, isAutoStartup, isRunning, setAutoStartup, setBeanFactory, setPhase, setTaskExecutor, setTaskScheduler, start, stop, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

ZookeeperStateMachineEnsemble

public ZookeeperStateMachineEnsemble(org.apache.curator.framework.CuratorFramework curatorClient,
                                     java.lang.String basePath)

Instantiates a new zookeeper state machine ensemble.

Parameters:

curatorClient - the curator client

basePath - the base zookeeper path

ZookeeperStateMachineEnsemble

public ZookeeperStateMachineEnsemble(org.apache.curator.framework.CuratorFramework curatorClient,
                                     java.lang.String basePath,
                                     boolean cleanState,
                                     int logSize)

Instantiates a new zookeeper state machine ensemble.

Parameters:

curatorClient - the curator client

basePath - the base zookeeper path

cleanState - if true clean existing state

logSize - the log size

Method Detail

onInit

protected void onInit()
               throws java.lang.Exception

Description copied from class: LifecycleObjectSupport

Subclasses may implement this for initialization logic. Called during the InitializingBean phase. Implementor should always call super method not to break initialization chain.

Overrides:

onInit in class LifecycleObjectSupport

Throws:

java.lang.Exception - exception

doStart

protected void doStart()

Description copied from class: LifecycleObjectSupport

Subclasses may implement this method with the start behavior. This method will be invoked while holding the LifecycleObjectSupport.lifecycleLock.

Overrides:

doStart in class LifecycleObjectSupport

doStop

protected void doStop()

Description copied from class: LifecycleObjectSupport

Subclasses may implement this method with the stop behavior. This method will be invoked while holding the LifecycleObjectSupport.lifecycleLock.

Overrides:

doStop in class LifecycleObjectSupport

join

public void join(StateMachine<S,E> stateMachine)

Description copied from interface: StateMachineEnsemble

Request a join to a state machine ensemble. This method is a request to join an ensemble and doesn't guarantee a requester will eventually successfully join. Join operation needs to be used together with EnsembleListener and EnsembleListener.stateMachineJoined(StateMachine, StateMachineContext) is called with a StateMachine instance for successful join.

Specified by:

join in interface StateMachineEnsemble<S,E>

Specified by:

join in class StateMachineEnsembleObjectSupport<S,E>

Parameters:

stateMachine - the state machine

getLeader

public StateMachine<S,E> getLeader()

Description copied from interface: StateMachineEnsemble

Gets the ensemble leader. If returned machine is NULL it indicates that this ensemble doesn't know any leader.

Returns:

the ensemble leader

leave

public void leave(StateMachine<S,E> stateMachine)

Description copied from interface: StateMachineEnsemble

Request a leave from an ensemble. This method is a request to leave an ensemble. After this method is called no further processing is done for a instance of StateMachine. Additionally EnsembleListener.stateMachineLeft(StateMachine, StateMachineContext) is called when leave request is fully processed.

Specified by:

leave in interface StateMachineEnsemble<S,E>

Specified by:

leave in class StateMachineEnsembleObjectSupport<S,E>

Parameters:

stateMachine - the state machine

setState

public void setState(StateMachineContext<S,E> context)

Description copied from interface: StateMachineEnsemble

Sets the state as a StateMachineContext.

Parameters:

context - the state machine context

getState

public StateMachineContext<S,E> getState()

Description copied from interface: StateMachineEnsemble

Gets the state as a StateMachineContext.

Returns:

the state machine context

registerWatcherForStatePath

protected void registerWatcherForStatePath()

Register existing CuratorWatcher for a state path.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object