Package org.springframework.statemachine.ensemble

Class CompositeEnsembleListener<S,E>

java.lang.Object

org.springframework.statemachine.listener.AbstractCompositeListener<EnsembleListener<S,E>>

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

Type Parameters:

S - the type of state

E - the type of event

All Implemented Interfaces:

EnsembleListener<S,E>

public class CompositeEnsembleListener<S,E>
extends AbstractCompositeListener<EnsembleListener<S,E>>
implements EnsembleListener<S,E>

Default EnsembleListener dispatcher.

Author:

Janne Valkealahti

Constructor Summary

Constructors

Constructor	Description
CompositeEnsembleListener()

Method Summary

Modifier and Type	Method	Description
void	ensembleError(StateMachineEnsembleException exception)	Called when StateMachineEnsemble resulted an error.
void	ensembleLeaderGranted(StateMachine<S,E> stateMachine)	Called when a state machine is granted a leader role in an ensemble.
void	ensembleLeaderRevoked(StateMachine<S,E> stateMachine)	Called when a state machine is revoked from a leader role in an ensemble.
void	stateChanged(StateMachineContext<S,E> context)	Called when ensemble is discovering a state change.
void	stateMachineJoined(StateMachine<S,E> stateMachine, StateMachineContext<S,E> context)	Called when state machine joined an ensemble.
void	stateMachineLeft(StateMachine<S,E> stateMachine, StateMachineContext<S,E> context)	Called when state machine left an ensemble.

Methods inherited from class org.springframework.statemachine.listener.AbstractCompositeListener

getListeners, register, setListeners, unregister

Methods inherited from class java.lang.Object

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

Constructor Details

CompositeEnsembleListener

public CompositeEnsembleListener()

Method Details

stateMachineJoined

public void stateMachineJoined(StateMachine<S,E> stateMachine,
 StateMachineContext<S,E> context)

Description copied from interface: EnsembleListener

Called when state machine joined an ensemble. This callback is guaranteed to be called for a StateMachine who requested a join. User of this listener should check that a StateMachine is the one interested of. Implementation may choose to notify other StateMachine joins if it is able to do so. This may be called multiple time in case ensemble has made a choice to leave machine due to ensemble errors.

Specified by:

stateMachineJoined in interface EnsembleListener<S,E>

Parameters:

stateMachine - the state machine

context - the state machine context

stateMachineLeft

public void stateMachineLeft(StateMachine<S,E> stateMachine,
 StateMachineContext<S,E> context)

Description copied from interface: EnsembleListener

Called when state machine left an ensemble. This callback is guaranteed to be called for a StateMachine who requested a leave. User of this listener should check that a StateMachine is the one interested of. Implementation may choose to notify other StateMachine leaves if it is able to do so.

Specified by:

stateMachineLeft in interface EnsembleListener<S,E>

Parameters:

stateMachine - the state machine

context - the state machine context

stateChanged

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

Description copied from interface: EnsembleListener

Called when ensemble is discovering a state change.

Specified by:

stateChanged in interface EnsembleListener<S,E>

Parameters:

context - the state machine context

ensembleError

public void ensembleError(StateMachineEnsembleException exception)

Description copied from interface: EnsembleListener

Called when StateMachineEnsemble resulted an error.

Specified by:

ensembleError in interface EnsembleListener<S,E>

Parameters:

exception - the exception

ensembleLeaderGranted

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

Description copied from interface: EnsembleListener

Called when a state machine is granted a leader role in an ensemble.

Specified by:

ensembleLeaderGranted in interface EnsembleListener<S,E>

Parameters:

stateMachine - the state machine

ensembleLeaderRevoked

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

Description copied from interface: EnsembleListener

Called when a state machine is revoked from a leader role in an ensemble.

Specified by:

ensembleLeaderRevoked in interface EnsembleListener<S,E>

Parameters:

stateMachine - the state machine