org.springframework.statemachine.support

Class StateMachineInterceptorAdapter<S,E>

java.lang.Object

org.springframework.statemachine.support.StateMachineInterceptorAdapter<S,E>

Type Parameters:

S - the type of state

E - the type of event

All Implemented Interfaces:

StateMachineInterceptor<S,E>

Direct Known Subclasses:

AbstractPersistingStateMachineInterceptor, StateMachineSecurityInterceptor

public class StateMachineInterceptorAdapter<S,E>
extends java.lang.Object
implements StateMachineInterceptor<S,E>

Adapter helper implementation for StateMachineInterceptor.

Author:

Janne Valkealahti

Constructor Summary

Constructors

Constructor and Description
StateMachineInterceptorAdapter()

Method Summary

Modifier and Type	Method and Description
void	postStateChange(State<S,E> state, org.springframework.messaging.Message<E> message, Transition<S,E> transition, StateMachine<S,E> stateMachine) Called after a state change.
void	postStateChange(State<S,E> state, org.springframework.messaging.Message<E> message, Transition<S,E> transition, StateMachine<S,E> stateMachine, StateMachine<S,E> rootStateMachine) Called after a state change.
StateContext<S,E>	postTransition(StateContext<S,E> stateContext) Called after of a transition if transition happened.
org.springframework.messaging.Message<E>	preEvent(org.springframework.messaging.Message<E> message, StateMachine<S,E> stateMachine) Called before message is sent to processing.
void	preStateChange(State<S,E> state, org.springframework.messaging.Message<E> message, Transition<S,E> transition, StateMachine<S,E> stateMachine) Called prior of a state change.
void	preStateChange(State<S,E> state, org.springframework.messaging.Message<E> message, Transition<S,E> transition, StateMachine<S,E> stateMachine, StateMachine<S,E> rootStateMachine) Called prior of a state change.
StateContext<S,E>	preTransition(StateContext<S,E> stateContext) Called prior of a start of a transition.
java.lang.Exception	stateMachineError(StateMachine<S,E> stateMachine, java.lang.Exception exception) State when state machine is about to enter error it can't recover.

Methods inherited from class java.lang.Object

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

Constructor Detail

StateMachineInterceptorAdapter

public StateMachineInterceptorAdapter()

Method Detail

preEvent

public org.springframework.messaging.Message<E> preEvent(org.springframework.messaging.Message<E> message,
                                                         StateMachine<S,E> stateMachine)

Description copied from interface: StateMachineInterceptor

Called before message is sent to processing. Throwing exception or returning null will skip the message.

Specified by:

preEvent in interface StateMachineInterceptor<S,E>

Parameters:

message - the message

stateMachine - the state machine

Returns:

the intercepted message

preStateChange

public void preStateChange(State<S,E> state,
                           org.springframework.messaging.Message<E> message,
                           Transition<S,E> transition,
                           StateMachine<S,E> stateMachine)

Description copied from interface: StateMachineInterceptor

Called prior of a state change. Throwing an exception from this method will stop a state change logic.

Specified by:

preStateChange in interface StateMachineInterceptor<S,E>

Parameters:

state - the state

message - the message

transition - the transition

stateMachine - the state machine

preStateChange

public void preStateChange(State<S,E> state,
                           org.springframework.messaging.Message<E> message,
                           Transition<S,E> transition,
                           StateMachine<S,E> stateMachine,
                           StateMachine<S,E> rootStateMachine)

Description copied from interface: StateMachineInterceptor

Called prior of a state change. Throwing an exception from this method will stop a state change logic.

Specified by:

preStateChange in interface StateMachineInterceptor<S,E>

Parameters:

state - the state

message - the message

transition - the transition

stateMachine - the state machine

rootStateMachine - the root state machine

postStateChange

public void postStateChange(State<S,E> state,
                            org.springframework.messaging.Message<E> message,
                            Transition<S,E> transition,
                            StateMachine<S,E> stateMachine)

Description copied from interface: StateMachineInterceptor

Called after a state change.

Specified by:

postStateChange in interface StateMachineInterceptor<S,E>

Parameters:

state - the state

message - the message

transition - the transition

stateMachine - the state machine

postStateChange

public void postStateChange(State<S,E> state,
                            org.springframework.messaging.Message<E> message,
                            Transition<S,E> transition,
                            StateMachine<S,E> stateMachine,
                            StateMachine<S,E> rootStateMachine)

Description copied from interface: StateMachineInterceptor

Called after a state change.

Specified by:

postStateChange in interface StateMachineInterceptor<S,E>

Parameters:

state - the state

message - the message

transition - the transition

stateMachine - the state machine

rootStateMachine - the root state machine

preTransition

public StateContext<S,E> preTransition(StateContext<S,E> stateContext)

Description copied from interface: StateMachineInterceptor

Called prior of a start of a transition. Returning null from this method will break the transtion chain.

Specified by:

preTransition in interface StateMachineInterceptor<S,E>

Parameters:

stateContext - the state context

Returns:

the state context

postTransition

public StateContext<S,E> postTransition(StateContext<S,E> stateContext)

Description copied from interface: StateMachineInterceptor

Called after of a transition if transition happened.

Specified by:

postTransition in interface StateMachineInterceptor<S,E>

Parameters:

stateContext - the state context

Returns:

the state context

stateMachineError

public java.lang.Exception stateMachineError(StateMachine<S,E> stateMachine,
                                             java.lang.Exception exception)

Description copied from interface: StateMachineInterceptor

State when state machine is about to enter error it can't recover.

Specified by:

stateMachineError in interface StateMachineInterceptor<S,E>

Parameters:

stateMachine - the state machine

exception - the exception

Returns:

the exception