Package org.chenile.stm

Interface STMFlowStore

All Known Implementing Classes:

DummyStore, STMFlowStoreImpl

public interface STMFlowStore

An interface that is used by a State Transition Machine implementation to obtain the State Transition Diagram configuration. This is also useful to get the metadata that has been configured in the state machine. The metadata can power a HATEOAS interface.

Author:

Raja Shankar Kolluru

Method Summary

Modifier and Type	Method	Description
Collection<StateDescriptor>	getAllStates()
STMAutomaticStateComputation<?>	getAutomaticStateComputation(AutomaticStateDescriptor sd)
String	getDefaultFlow()
StateEntityRetrievalStrategy<? extends StateEntity>	getDefaultRetrievalStrategy()
STMAction<?>	getEntryAction(State state)
EventInformation	getEventInformation(String eventId)
STMAction<?>	getExitAction(State state)
State	getInitialState(State state)	Obtains the correct state descriptor to start operations with given the current state.
STMSecurityStrategy	getSecurityStrategy(String flowId)
StateDescriptor	getStateInfo(State state)
STMTransitionAction<?>	getTransitionAction(Transition transition)

Method Details

getInitialState

State getInitialState(State state)
               throws STMException

Obtains the correct state descriptor to start operations with given the current state.

Parameters:

state -

Returns:

the initial state for the particular flow if the flow was specified. initial state of the default flow if flow unspecified.

Throws:

STMException

getStateInfo

StateDescriptor getStateInfo(State state)

Parameters:

state -

Returns:

the state info.

getEntryAction

STMAction<?> getEntryAction(State state)

Parameters:

state -

Returns:

the entry action for the state.

getExitAction

STMAction<?> getExitAction(State state)

Parameters:

state -

Returns:

the exit action for the state

getTransitionAction

STMTransitionAction<?> getTransitionAction(Transition transition)

getAutomaticStateComputation

STMAutomaticStateComputation<?> getAutomaticStateComputation(AutomaticStateDescriptor sd)

getDefaultRetrievalStrategy

StateEntityRetrievalStrategy<? extends StateEntity> getDefaultRetrievalStrategy()

Returns:

getSecurityStrategy

STMSecurityStrategy getSecurityStrategy(String flowId)

Parameters:

flowId -

Returns:

getEventInformation

EventInformation getEventInformation(String eventId)

getAllStates

Collection<StateDescriptor> getAllStates()

getDefaultFlow

String getDefaultFlow()