org.springframework.statemachine.ensemble

Class StateMachineEnsembleObjectSupport<S,E>

java.lang.Object

org.springframework.statemachine.support.LifecycleObjectSupport

org.springframework.statemachine.ensemble.StateMachineEnsembleObjectSupport<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:

ZookeeperStateMachineEnsemble

public abstract class StateMachineEnsembleObjectSupport<S,E>
extends LifecycleObjectSupport
implements StateMachineEnsemble<S,E>

Support class for implementing StateMachineEnsembles.

Author:

Janne Valkealahti

Constructor Summary

Constructors

Constructor and Description
StateMachineEnsembleObjectSupport()

Method Summary

Modifier and Type	Method and Description
void	addEnsembleListener(EnsembleListener<S,E> listener) Adds the ensemble listener.
abstract void	join(StateMachine<S,E> stateMachine) Request a join to a state machine ensemble.
abstract void	leave(StateMachine<S,E> stateMachine) Request a leave from an ensemble.
protected void	notifyError(StateMachineEnsembleException exception)
protected void	notifyGranted(StateMachine<S,E> stateMachine)
protected void	notifyJoined(StateMachine<S,E> stateMachine, StateMachineContext<S,E> context)
protected void	notifyLeft(StateMachine<S,E> stateMachine, StateMachineContext<S,E> context)
protected void	notifyRevoked(StateMachine<S,E> stateMachine)
protected void	notifyStateChanged(StateMachineContext<S,E> context)
void	removeEnsembleListener(EnsembleListener<S,E> listener) Removes the ensemble listener.

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.statemachine.ensemble.StateMachineEnsemble

getLeader, getState, setState

Constructor Detail

StateMachineEnsembleObjectSupport

public StateMachineEnsembleObjectSupport()

Method Detail

join

public abstract 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>

Parameters:

stateMachine - the state machine

leave

public abstract 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>

Parameters:

stateMachine - the state machine

addEnsembleListener

public void addEnsembleListener(EnsembleListener<S,E> listener)

Description copied from interface: StateMachineEnsemble

Adds the ensemble listener.

Specified by:

addEnsembleListener in interface StateMachineEnsemble<S,E>

Parameters:

listener - the listener

removeEnsembleListener

public void removeEnsembleListener(EnsembleListener<S,E> listener)

Description copied from interface: StateMachineEnsemble

Removes the ensemble listener.

Specified by:

removeEnsembleListener in interface StateMachineEnsemble<S,E>

Parameters:

listener - the listener

notifyJoined

protected void notifyJoined(StateMachine<S,E> stateMachine,
                            StateMachineContext<S,E> context)

notifyLeft

protected void notifyLeft(StateMachine<S,E> stateMachine,
                          StateMachineContext<S,E> context)

notifyError

protected void notifyError(StateMachineEnsembleException exception)

notifyGranted

protected void notifyGranted(StateMachine<S,E> stateMachine)

notifyRevoked

protected void notifyRevoked(StateMachine<S,E> stateMachine)

notifyStateChanged

protected void notifyStateChanged(StateMachineContext<S,E> context)