Package org.springframework.statemachine.persist

Class AbstractPersistingStateMachineInterceptor<S,E,T>

java.lang.Object

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

org.springframework.statemachine.persist.AbstractPersistingStateMachineInterceptor<S,E,T>

Type Parameters:

S - the type of state

E - the type of event

T - the type of persister context object

All Implemented Interfaces:

StateMachinePersist<S,E,T>, StateMachineInterceptor<S,E>

Direct Known Subclasses:

JpaPersistingStateMachineInterceptor, MongoDbPersistingStateMachineInterceptor, RedisPersistingStateMachineInterceptor

public abstract class AbstractPersistingStateMachineInterceptor<S,E,T>
extends StateMachineInterceptorAdapter<S,E>
implements StateMachinePersist<S,E,T>

Base class for StateMachineInterceptor persisting StateMachineContexts. This class is to be used as a base implementation which wants to persist a machine which is about to kept running as normal use case for persistence is to stop machine, persist and then start it again.

Constructor Summary

Constructors

Constructor	Description
AbstractPersistingStateMachineInterceptor()

Method Summary

Modifier and Type	Method	Description
protected StateMachineContext<S,E>	buildStateMachineContext(StateMachine<S,E> stateMachine, StateMachine<S,E> rootStateMachine, State<S,E> state)	Deprecated. in favour of buildStateMachineContext(StateMachine, StateMachine, State, Message)
protected StateMachineContext<S,E>	buildStateMachineContext(StateMachine<S,E> stateMachine, StateMachine<S,E> rootStateMachine, State<S,E> state, org.springframework.messaging.Message<E> message)	Builds the state machine context.
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.
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.
abstract StateMachineContext<S,E>	read(T contextObj)	Read StateMachineContext from persistent store.
void	setExtendedStateVariablesFunction(Function<StateMachine<S,E>,Map<Object,Object>> extendedStateVariablesFunction)	Sets the function creating extended state variables.
abstract void	write(StateMachineContext<S,E> context, T contextObj)	Write StateMachineContext into persistent store.

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

postTransition, preEvent, preTransition, stateMachineError

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractPersistingStateMachineInterceptor

public AbstractPersistingStateMachineInterceptor()

Method Details

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>

Overrides:

preStateChange in class StateMachineInterceptorAdapter<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,
 StateMachine<S,E> rootStateMachine)

Description copied from interface: StateMachineInterceptor

Called after a state change.

Specified by:

postStateChange in interface StateMachineInterceptor<S,E>

Overrides:

postStateChange in class StateMachineInterceptorAdapter<S,E>

Parameters:

state - the state

message - the message

transition - the transition

stateMachine - the state machine

rootStateMachine - the root state machine

write

public abstract void write(StateMachineContext<S,E> context,
 T contextObj)
                    throws Exception

Write StateMachineContext into persistent store.

Specified by:

write in interface StateMachinePersist<S,E,T>

Parameters:

context - the state machine context

contextObj - the context object

Throws:

Exception - the exception

read

public abstract StateMachineContext<S,E> read(T contextObj)
                                       throws Exception

Read StateMachineContext from persistent store.

Specified by:

read in interface StateMachinePersist<S,E,T>

Parameters:

contextObj - the context object

Returns:

the state machine context

Throws:

Exception - the exception

setExtendedStateVariablesFunction

public void setExtendedStateVariablesFunction(Function<StateMachine<S,E>,Map<Object,Object>> extendedStateVariablesFunction)

Sets the function creating extended state variables.

Parameters:

extendedStateVariablesFunction - the extended state variables function

buildStateMachineContext

@Deprecated
protected StateMachineContext<S,E> buildStateMachineContext(StateMachine<S,E> stateMachine,
 StateMachine<S,E> rootStateMachine,
 State<S,E> state)

Deprecated.

in favour of buildStateMachineContext(StateMachine, StateMachine, State, Message)

Builds the state machine context. Note, for backward compatibility this method doesn't pass event or headers into a StateMachineContext. Implementor of this class, if using this method should move over to buildStateMachineContext(StateMachine, StateMachine, State, Message).

Parameters:

stateMachine - the state machine

rootStateMachine - the root state machine

state - the state

Returns:

the state machine context

buildStateMachineContext

protected StateMachineContext<S,E> buildStateMachineContext(StateMachine<S,E> stateMachine,
 StateMachine<S,E> rootStateMachine,
 State<S,E> state,
 org.springframework.messaging.Message<E> message)

Builds the state machine context.

Parameters:

stateMachine - the state machine

rootStateMachine - the root state machine

state - the state

message - the message

Returns:

the state machine context