Package org.springframework.statemachine.support

Interface StateMachineExecutor<S,E>

Type Parameters:

S - the type of state

E - the type of event

All Superinterfaces:

StateMachineReactiveLifecycle

All Known Implementing Classes:

ReactiveStateMachineExecutor

public interface StateMachineExecutor<S,E>
extends StateMachineReactiveLifecycle

Interface for a StateMachine event executor.

Author:

Janne Valkealahti

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	StateMachineExecutor.ExecutorExceptionHolder
static class	StateMachineExecutor.MonoSinkStateMachineExecutorCallback
static interface	StateMachineExecutor.StateMachineExecutorCallback	Completion callback to notify back complete or error.
static interface	StateMachineExecutor.StateMachineExecutorTransit<S,E>	Callback interface when executor wants to handle transit.

Method Summary

Modifier and Type	Method	Description
void	addStateMachineInterceptor(StateMachineInterceptor<S,E> interceptor)	Adds the state machine interceptor.
reactor.core.publisher.Mono<Void>	executeTriggerlessTransitions(StateContext<S,E> context, State<S,E> state)	Execute and check all triggerless transitions.
void	queueDeferredEvent(org.springframework.messaging.Message<E> message)	Queue deferred event.
reactor.core.publisher.Mono<Void>	queueEvent(reactor.core.publisher.Mono<org.springframework.messaging.Message<E>> message, StateMachineExecutor.StateMachineExecutorCallback callback)	Queue event.
void	setForwardedInitialEvent(org.springframework.messaging.Message<E> message)	Set initial forwarded event.
void	setInitialEnabled(boolean enabled)	Sets the if initial stage is enabled.
void	setStateMachineExecutorTransit(StateMachineExecutor.StateMachineExecutorTransit<S,E> stateMachineExecutorTransit)	Sets the state machine executor transit.

Methods inherited from interface org.springframework.statemachine.support.StateMachineReactiveLifecycle

startReactively, stopReactively

Method Details

queueEvent

reactor.core.publisher.Mono<Void> queueEvent(reactor.core.publisher.Mono<org.springframework.messaging.Message<E>> message,
 StateMachineExecutor.StateMachineExecutorCallback callback)

Queue event.

Parameters:

message - the message

callback - the executor callback

Returns:

completion when event is queued

queueDeferredEvent

void queueDeferredEvent(org.springframework.messaging.Message<E> message)

Queue deferred event.

Parameters:

message - the message

executeTriggerlessTransitions

reactor.core.publisher.Mono<Void> executeTriggerlessTransitions(StateContext<S,E> context,
 State<S,E> state)

Execute and check all triggerless transitions.

Parameters:

context - the state context

state - the state

Returns:

completion when handled

setInitialEnabled

void setInitialEnabled(boolean enabled)

Sets the if initial stage is enabled.

Parameters:

enabled - the new flag

setForwardedInitialEvent

void setForwardedInitialEvent(org.springframework.messaging.Message<E> message)

Set initial forwarded event.

Parameters:

message - the forwarded message

See Also:

• StateMachineAccess.setForwardedInitialEvent(Message)

setStateMachineExecutorTransit

void setStateMachineExecutorTransit(StateMachineExecutor.StateMachineExecutorTransit<S,E> stateMachineExecutorTransit)

Sets the state machine executor transit.

Parameters:

stateMachineExecutorTransit - the state machine executor transit

addStateMachineInterceptor

void addStateMachineInterceptor(StateMachineInterceptor<S,E> interceptor)

Adds the state machine interceptor.

Parameters:

interceptor - the interceptor