Package org.chenile.stm.impl

Class ConfigBasedEnablementStrategy

java.lang.Object

org.chenile.stm.impl.ConfigBasedEnablementStrategy

All Implemented Interfaces:

EnablementStrategy

public class ConfigBasedEnablementStrategy
extends Object
implements EnablementStrategy

Provides an enablement strategy based on configuration. This requires a configuration provider.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADD_PROPERTY
(package private) String	addTransitionProperty
(package private) ConfigProvider	configProvider
static final String	ENABLED_PROPERTY
(package private) String	enabledProperty
(package private) static final String	ENABLEMENT
(package private) String	prefix

Constructor Summary

Constructors

Constructor	Description
ConfigBasedEnablementStrategy(ConfigProvider configProvider)
ConfigBasedEnablementStrategy(ConfigProvider configProvider, String prefix)

Method Summary

Modifier and Type	Method	Description
Collection<StateDescriptor>	addDynamicStates(FlowDescriptor flowInfo)
Map<String,Transition>	addDynamicTransitions(StateDescriptor sd)
private void	addEventInformationToTransition(Transition transition, StateDescriptor sd)
void	addMetadataToState(StateDescriptor sd)
void	addMetadataToTransition(Transition t, StateDescriptor sd)
StateDescriptor	getStateInfo(State state, FlowDescriptor flowDescriptor)
boolean	isEventEnabled(StateDescriptor sd, EventInformation eventInformation)
boolean	isStateEnabled(StateDescriptor sd)
private boolean	propEnabled(String prop)
void	setAddTransitionProperty(String addTransitionProperty)
void	setEnabledProperty(String enabledProperty)

Methods inherited from class java.lang.Object

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

Field Details

ENABLED_PROPERTY

public static final String ENABLED_PROPERTY

See Also:

• Constant Field Values

ADD_PROPERTY

public static final String ADD_PROPERTY

See Also:

• Constant Field Values

enabledProperty

String enabledProperty

addTransitionProperty

String addTransitionProperty

ENABLEMENT

static final String ENABLEMENT

See Also:

• Constant Field Values

prefix

String prefix

configProvider

ConfigProvider configProvider

Constructor Details

ConfigBasedEnablementStrategy

public ConfigBasedEnablementStrategy(ConfigProvider configProvider)

ConfigBasedEnablementStrategy

public ConfigBasedEnablementStrategy(ConfigProvider configProvider,
 String prefix)

Method Details

setEnabledProperty

public void setEnabledProperty(String enabledProperty)

setAddTransitionProperty

public void setAddTransitionProperty(String addTransitionProperty)

isStateEnabled

public boolean isStateEnabled(StateDescriptor sd)

Specified by:

isStateEnabled in interface EnablementStrategy

isEventEnabled

public boolean isEventEnabled(StateDescriptor sd,
 EventInformation eventInformation)

Specified by:

isEventEnabled in interface EnablementStrategy

Parameters:

sd - state descriptor

eventInformation - - event information

Returns:

For every state or event it looks for a property in the configuration which is named after the * state or event. For example to enable state State1 on entity Entity1, we will need Entity1.State1.enabled = true * If this config is missing or set to true then the State is enabled. If it is explicitly set to false * then it is disabled. *

Similarly, for an event Event1 that belongs to state State1 of entity Entity1 the property * Entity1.State1.Event1.enabled must be explicitly set to false. Else if it is missing or set to true, * then the event is considered enabled.

addDynamicTransitions

public Map<String,Transition> addDynamicTransitions(StateDescriptor sd)

Specified by:

addDynamicTransitions in interface EnablementStrategy

Parameters:

sd -

Returns:

Allows for the addition of transitions in the property files.

addEventInformationToTransition

private void addEventInformationToTransition(Transition transition,
 StateDescriptor sd)

Parameters:

transition -

sd -

addMetadataToTransition

public void addMetadataToTransition(Transition t,
 StateDescriptor sd)

Specified by:

addMetadataToTransition in interface EnablementStrategy

Parameters:

t -

sd - Allows for metadata to be added to a transition in property file.

getStateInfo

public StateDescriptor getStateInfo(State state,
 FlowDescriptor flowDescriptor)

Specified by:

getStateInfo in interface EnablementStrategy

addDynamicStates

public Collection<StateDescriptor> addDynamicStates(FlowDescriptor flowInfo)

Specified by:

addDynamicStates in interface EnablementStrategy

addMetadataToState

public void addMetadataToState(StateDescriptor sd)

Specified by:

addMetadataToState in interface EnablementStrategy

propEnabled

private boolean propEnabled(String prop)