Package org.springframework.statemachine.ensemble

Interface StateMachineEnsemble<S,E>

Type Parameters:

S - the type of state

E - the type of event

All Known Implementing Classes:

LeaderZookeeperStateMachineEnsemble, StateMachineEnsembleObjectSupport, ZookeeperStateMachineEnsemble

public interface StateMachineEnsemble<S,E>

StateMachineEnsemble is a contract between a StateMachine and arbitrary ensemble of other StateMachines.

Author:

Janne Valkealahti

Method Summary

Modifier and Type	Method	Description
void	addEnsembleListener(EnsembleListener<S,E> listener)	Adds the ensemble listener.
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.
void	removeEnsembleListener(EnsembleListener<S,E> listener)	Removes the ensemble listener.
void	setState(StateMachineContext<S,E> context)	Sets the state as a StateMachineContext.

Method Details

join

void join(StateMachine<S,E> stateMachine)

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.

Parameters:

stateMachine - the state machine

leave

void leave(StateMachine<S,E> stateMachine)

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.

Parameters:

stateMachine - the state machine

addEnsembleListener

void addEnsembleListener(EnsembleListener<S,E> listener)

Adds the ensemble listener.

Parameters:

listener - the listener

removeEnsembleListener

void removeEnsembleListener(EnsembleListener<S,E> listener)

Removes the ensemble listener.

Parameters:

listener - the listener

setState

void setState(StateMachineContext<S,E> context)

Sets the state as a StateMachineContext.

Parameters:

context - the state machine context

getState

StateMachineContext<S,E> getState()

Gets the state as a StateMachineContext.

Returns:

the state machine context

getLeader

StateMachine<S,E> getLeader()

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

Returns:

the ensemble leader