Package org.chenile.stm.impl

Class STMFlowStoreImpl

java.lang.Object

org.chenile.stm.impl.STMFlowStoreImpl

All Implemented Interfaces:

TransientActionsAwareDescriptor, STMFlowStore

Direct Known Subclasses:

DummyStore

public class STMFlowStoreImpl
extends Object
implements STMFlowStore, TransientActionsAwareDescriptor

A base implementation of STMFlowStore FlowStoreReaders parse various representations of the flow (such as in an xml or in a db) and call the addflow() method in this class. Look at XmlFlowReader for an example.

All of the functionality of FlowConfigurator interface is handled by this class. The only part that is missing is the parsing part which is expected to be provided by the parsing sub class. Besides flow configurations, other things such as ScriptingStrategy, entry actions, exit actions and ComponentPropertiesHelper are handled by this base class.

Author:

Raja Shankar Kolluru

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,StateTagDescriptor>	actionTagsMap
private BeanFactoryAdapter	beanFactory
private ComponentPropertiesHelper	componentPropertiesHelper
private STMAutomaticStateComputation<?>	defaultAutomaticStateComputation
protected String	defaultFlowId
protected STMTransitionAction<?>	defaultTransitionAction
private EnablementStrategy	enablementStrategy
protected STMAction<?>	entryAction
protected Map<String,EventInformation>	eventInfos
protected STMAction<?>	exitAction
protected Map<String,FlowDescriptor>	flows
private static final Logger	LOGGER
static final String	PATH_TO_DEFAULT_STM_CONFIGURATION
protected StateEntityRetrievalStrategy<? extends StateEntity>	retrievalStrategy
private ScriptingStrategy	scriptingStrategy
protected STMActionsInfoProvider	stmActionsInfoProvider

Constructor Summary

Constructors

Constructor	Description
STMFlowStoreImpl()	Always initialize the action tags first

Method Summary

Modifier and Type	Method	Description
void	addEventInformation(EventInformation eventInformation)
void	addFlow(FlowDescriptor fd)	This method is called during STD parsing.
void	addStateTag(StateTagDescriptor std)
private State	correctState(State state)
Collection<StateDescriptor>	getAllStates()
STMAutomaticStateComputation<?>	getAutomaticStateComputation(AutomaticStateDescriptor sd)
BeanFactoryAdapter	getBeanFactory()
STMAutomaticStateComputation<?>	getDefaultAutomaticStateComputation()
String	getDefaultFlow()
String	getDefaultFlowId()
StateEntityRetrievalStrategy<? extends StateEntity>	getDefaultRetrievalStrategy()
EnablementStrategy	getEnablementStrategy()
STMAction<?>	getEntryAction(State state)
EventInformation	getEventInformation(String eventId)
STMAction<?>	getExitAction(State state)
FlowDescriptor	getFlow(String flowId)
FlowDescriptor	getFlowInfo()
FlowDescriptor	getFlowInfo(String flowId)
State	getInitialState(State state)	Obtains the correct state descriptor to start operations with given the current state.
STMSecurityStrategy	getSecurityStrategy(String flowId)
StateDescriptor	getStateInfo(String flowId, String stateId)
StateDescriptor	getStateInfo(State state)
STMTransitionAction<?>	getTransitionAction(Transition transition)
void	include(String file)
Object	makeAction(String componentName, boolean enableInlineScriptsInProperties)
Object	makeAutomaticStateComputation(String componentName, boolean enableInlineScriptsInProperties)
Object	makeComponent(String componentName)
EnablementStrategy	makeEnablementStrategy(String componentName)
Object	makeRetrievalStrategy(String componentName)
Object	makeScriptingStrategy(String componentName)
Object	makeSecurityStrategy(String componentName)
Object	makeTransitionAction(String componentName, boolean enableInlineScriptsInProperties)
void	setBeanFactory(BeanFactoryAdapter beanFactory)
void	setDefaultAutomaticStateComputation(STMAutomaticStateComputation<?> defaultAutomaticStateComputation)
void	setDefaultFlow(FlowDescriptor fd)
void	setDefaultTransitionAction(String componentName)
void	setDefaultTransitionAction(STMTransitionAction<?> transitionAction)
void	setEnablementStrategy(String componentName)
void	setEnablementStrategy(EnablementStrategy enablementStrategy)
void	setEntryAction(String componentName, boolean enableInlineScriptsInProperties)
void	setEntryAction(STMAction<?> entryAction)
void	setExitAction(String componentName, boolean enableInlineScriptsInProperties)
void	setExitAction(STMAction<?> exitAction)
void	setScriptingStrategy(String componentName)	Called during parsing time when the scripting-strategy is defined in the configuration.
void	setScriptingStrategy(ScriptingStrategy scriptingStrategy)
String	toJson()
Map<String,Object>	toMap()
String	toString()
void	validate()	Make sure that the state machine is set up right.

Methods inherited from class java.lang.Object

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

Field Details

LOGGER

private static final Logger LOGGER

PATH_TO_DEFAULT_STM_CONFIGURATION

public static final String PATH_TO_DEFAULT_STM_CONFIGURATION

See Also:

• Constant Field Values

actionTagsMap

protected Map<String,StateTagDescriptor> actionTagsMap

flows

protected Map<String,FlowDescriptor> flows

eventInfos

protected Map<String,EventInformation> eventInfos

stmActionsInfoProvider

protected STMActionsInfoProvider stmActionsInfoProvider

entryAction

protected STMAction<?> entryAction

exitAction

protected STMAction<?> exitAction

defaultFlowId

protected String defaultFlowId

beanFactory

private BeanFactoryAdapter beanFactory

retrievalStrategy

protected StateEntityRetrievalStrategy<? extends StateEntity> retrievalStrategy

scriptingStrategy

private ScriptingStrategy scriptingStrategy

componentPropertiesHelper

private ComponentPropertiesHelper componentPropertiesHelper

defaultTransitionAction

protected STMTransitionAction<?> defaultTransitionAction

enablementStrategy

private EnablementStrategy enablementStrategy

defaultAutomaticStateComputation

private STMAutomaticStateComputation<?> defaultAutomaticStateComputation

Constructor Details

STMFlowStoreImpl

public STMFlowStoreImpl()

Always initialize the action tags first

Method Details

include

public void include(String file)
             throws Exception

Throws:

Exception

getStateInfo

public StateDescriptor getStateInfo(String flowId,
 String stateId)

getFlow

public FlowDescriptor getFlow(String flowId)

addStateTag

public void addStateTag(StateTagDescriptor std)

addFlow

public void addFlow(FlowDescriptor fd)

This method is called during STD parsing. Every flow would result in a call to this so that the flow gets added to the configuration.

Parameters:

fd - flow descriptor

setDefaultFlow

public void setDefaultFlow(FlowDescriptor fd)

makeComponent

public Object makeComponent(String componentName)
                     throws STMException

Throws:

STMException

makeTransitionAction

public Object makeTransitionAction(String componentName,
 boolean enableInlineScriptsInProperties)
                            throws STMException

Throws:

STMException

makeAction

public Object makeAction(String componentName,
 boolean enableInlineScriptsInProperties)
                  throws STMException

Throws:

STMException

makeAutomaticStateComputation

public Object makeAutomaticStateComputation(String componentName,
 boolean enableInlineScriptsInProperties)
                                     throws STMException

Throws:

STMException

validate

public void validate()
              throws Exception

Make sure that the state machine is set up right.

Throws:

Exception

getFlowInfo

public FlowDescriptor getFlowInfo()

getFlowInfo

public FlowDescriptor getFlowInfo(String flowId)

setEntryAction

public void setEntryAction(String componentName,
 boolean enableInlineScriptsInProperties)
                    throws STMException

Throws:

STMException

setExitAction

public void setExitAction(String componentName,
 boolean enableInlineScriptsInProperties)
                   throws STMException

Throws:

STMException

setDefaultTransitionAction

public void setDefaultTransitionAction(String componentName)
                                throws STMException

Throws:

STMException

setDefaultTransitionAction

public void setDefaultTransitionAction(STMTransitionAction<?> transitionAction)

getDefaultFlowId

public String getDefaultFlowId()

setScriptingStrategy

public void setScriptingStrategy(String componentName)
                          throws STMException

Called during parsing time when the scripting-strategy is defined in the configuration. In case of XML configuration, this method is called when the <scripting-strategy ...> xml element is encountered during parsing

Parameters:

componentName -

Throws:

STMException

makeScriptingStrategy

public Object makeScriptingStrategy(String componentName)
                             throws STMException

Throws:

STMException

makeSecurityStrategy

public Object makeSecurityStrategy(String componentName)
                            throws STMException

Throws:

STMException

makeRetrievalStrategy

public Object makeRetrievalStrategy(String componentName)
                             throws STMException

Throws:

STMException

setScriptingStrategy

public void setScriptingStrategy(ScriptingStrategy scriptingStrategy)

makeEnablementStrategy

public EnablementStrategy makeEnablementStrategy(String componentName)
                                          throws STMException

Throws:

STMException

setEnablementStrategy

public void setEnablementStrategy(String componentName)
                           throws STMException

Throws:

STMException

setEnablementStrategy

public void setEnablementStrategy(EnablementStrategy enablementStrategy)

getEntryAction

public STMAction<?> getEntryAction(State state)

Specified by:

getEntryAction in interface STMFlowStore

Returns:

the entry action for the state.

getExitAction

public STMAction<?> getExitAction(State state)

Specified by:

getExitAction in interface STMFlowStore

Returns:

the exit action for the state

getTransitionAction

public STMTransitionAction<?> getTransitionAction(Transition transition)

Specified by:

getTransitionAction in interface STMFlowStore

getAutomaticStateComputation

public STMAutomaticStateComputation<?> getAutomaticStateComputation(AutomaticStateDescriptor sd)

Specified by:

getAutomaticStateComputation in interface STMFlowStore

correctState

private State correctState(State state)

getStateInfo

public StateDescriptor getStateInfo(State state)

Specified by:

getStateInfo in interface STMFlowStore

Returns:

the state info.

getInitialState

public State getInitialState(State state)
                      throws STMException

Description copied from interface: STMFlowStore

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

Specified by:

getInitialState in interface STMFlowStore

Returns:

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

Throws:

STMException

setEntryAction

public void setEntryAction(STMAction<?> entryAction)

Specified by:

setEntryAction in interface TransientActionsAwareDescriptor

setExitAction

public void setExitAction(STMAction<?> exitAction)

Specified by:

setExitAction in interface TransientActionsAwareDescriptor

getBeanFactory

public BeanFactoryAdapter getBeanFactory()

setBeanFactory

public void setBeanFactory(BeanFactoryAdapter beanFactory)

getDefaultRetrievalStrategy

public StateEntityRetrievalStrategy<? extends StateEntity> getDefaultRetrievalStrategy()

Specified by:

getDefaultRetrievalStrategy in interface STMFlowStore

Returns:

getSecurityStrategy

public STMSecurityStrategy getSecurityStrategy(String flowId)

Specified by:

getSecurityStrategy in interface STMFlowStore

Returns:

toString

public String toString()

Overrides:

toString in class Object

toJson

public String toJson()

toMap

public Map<String,Object> toMap()

addEventInformation

public void addEventInformation(EventInformation eventInformation)

getEventInformation

public EventInformation getEventInformation(String eventId)

Specified by:

getEventInformation in interface STMFlowStore

getAllStates

public Collection<StateDescriptor> getAllStates()

Specified by:

getAllStates in interface STMFlowStore

getDefaultFlow

public String getDefaultFlow()

Specified by:

getDefaultFlow in interface STMFlowStore

getEnablementStrategy

public EnablementStrategy getEnablementStrategy()

getDefaultAutomaticStateComputation

public STMAutomaticStateComputation<?> getDefaultAutomaticStateComputation()

setDefaultAutomaticStateComputation

public void setDefaultAutomaticStateComputation(STMAutomaticStateComputation<?> defaultAutomaticStateComputation)