Package org.springframework.statemachine.config.builders

Class StateMachineConfigurationBuilder<S,E>

java.lang.Object

org.springframework.statemachine.config.common.annotation.AbstractAnnotationBuilder<O>

org.springframework.statemachine.config.common.annotation.AbstractConfiguredAnnotationBuilder<ConfigurationData<S,E>,StateMachineConfigurationConfigurer<S,E>,StateMachineConfigurationBuilder<S,E>>

org.springframework.statemachine.config.builders.StateMachineConfigurationBuilder<S,E>

Type Parameters:

S - the type of state

E - the type of event

All Implemented Interfaces:

StateMachineConfigurationConfigurer<S,E>, AnnotationBuilder<ConfigurationData<S,E>>

public class StateMachineConfigurationBuilder<S,E>
extends AbstractConfiguredAnnotationBuilder<ConfigurationData<S,E>,StateMachineConfigurationConfigurer<S,E>,StateMachineConfigurationBuilder<S,E>>
implements StateMachineConfigurationConfigurer<S,E>

AnnotationBuilder for StatesData.

Author:

Janne Valkealahti

Constructor Summary

Constructors

Constructor	Description
StateMachineConfigurationBuilder()	Instantiates a new state machine configuration builder.
StateMachineConfigurationBuilder(ObjectPostProcessor<Object> objectPostProcessor)	Instantiates a new state machine configuration builder.
StateMachineConfigurationBuilder(ObjectPostProcessor<Object> objectPostProcessor, boolean allowConfigurersOfSameType)	Instantiates a new state machine configuration builder.

Method Summary

Modifier and Type	Method	Description
protected ConfigurationData<S,E>	performBuild()	Subclasses must implement this method to build the object that is being returned.
void	setAutoStart(boolean autoStart)	Sets the auto start.
void	setBeanFactory(org.springframework.beans.factory.BeanFactory beanFactory)	Sets the bean factory.
void	setEventSecurityAccessDecisionManager(org.springframework.security.access.AccessDecisionManager eventSecurityAccessDecisionManager)	Sets the security event access decision manager.
void	setEventSecurityRule(SecurityRule eventSecurityRule)	Sets the event security rule.
void	setMachineId(String machineId)	Sets the machine id.
void	setRegionExecutionPolicy(RegionExecutionPolicy regionExecutionPolicy)	Sets the region execution policy.
void	setSecurityEnabled(boolean securityEnabled)	Sets the security enabled.
void	setStateDoActionPolicy(StateDoActionPolicy stateDoActionPolicy, Long stateDoActionPolicyTimeout)	Sets the state do action policy and timeout.
void	setStateMachineEnsemble(StateMachineEnsemble<S,E> ensemble)	Sets the state machine ensemble.
void	setStateMachineListeners(List<StateMachineListener<S,E>> listeners)	Sets the state machine listeners.
void	setStateMachineMonitor(StateMachineMonitor<S,E> stateMachineMonitor)	Sets the state machine monitor.
void	setStateMachineRuntimePersister(StateMachineRuntimePersister<S,E,?> persister)	Sets the state machine runtime persister.
void	setTransitionConflictPolicy(TransitionConflictPolicy transitionConflictPolicy)	Sets the transition conflict policy.
void	setTransitionSecurityAccessDecisionManager(org.springframework.security.access.AccessDecisionManager transitionSecurityAccessDecisionManager)	Sets the security transition access decision manager.
void	setTransitionSecurityRule(SecurityRule transitionSecurityRule)	Sets the transition security rule.
void	setVerifier(StateMachineModelVerifier<S,E> verifier)	Sets the state machine model verifier.
void	setVerifierEnabled(boolean verifierEnabled)	Sets the verifier enabled.
ConfigurationConfigurer<S,E>	withConfiguration()	Gets a configurer for generic config.
DistributedStateMachineConfigurer<S,E>	withDistributed()	Gets a configurer for distributed state machine config.
MonitoringConfigurer<S,E>	withMonitoring()	Gets a configurer for state machine monitoring.
PersistenceConfigurer<S,E>	withPersistence()	Gets a configurer for state machine persistence.
SecurityConfigurer<S,E>	withSecurity()	Gets a configurer for securing state machine.
VerifierConfigurer<S,E>	withVerifier()	Gets a configurer for state machine model verifier.

Methods inherited from class org.springframework.statemachine.config.common.annotation.AbstractConfiguredAnnotationBuilder

apply, beforeConfigureMains, beforeConfigurePosts, beforeInit, doBuild, getConfigurer, getConfigurers, getOrApply, getOrBuild, getSharedObject, getSharedObjects, objectPostProcessor, postProcess, removeConfigurer, removeConfigurers, setSharedObject

Methods inherited from class org.springframework.statemachine.config.common.annotation.AbstractAnnotationBuilder

build, getObject

Methods inherited from class java.lang.Object

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

Constructor Details

StateMachineConfigurationBuilder

public StateMachineConfigurationBuilder()

Instantiates a new state machine configuration builder.

StateMachineConfigurationBuilder

public StateMachineConfigurationBuilder(ObjectPostProcessor<Object> objectPostProcessor,
 boolean allowConfigurersOfSameType)

Instantiates a new state machine configuration builder.

Parameters:

objectPostProcessor - the object post processor

allowConfigurersOfSameType - the allow configurers of same type

StateMachineConfigurationBuilder

public StateMachineConfigurationBuilder(ObjectPostProcessor<Object> objectPostProcessor)

Instantiates a new state machine configuration builder.

Parameters:

objectPostProcessor - the object post processor

Method Details

withConfiguration

public ConfigurationConfigurer<S,E> withConfiguration()
                                               throws Exception

Description copied from interface: StateMachineConfigurationConfigurer

Gets a configurer for generic config.

Specified by:

withConfiguration in interface StateMachineConfigurationConfigurer<S,E>

Returns:

ConfigurationConfigurer for chaining

Throws:

Exception - if configuration error happens

withDistributed

public DistributedStateMachineConfigurer<S,E> withDistributed()
                                                       throws Exception

Description copied from interface: StateMachineConfigurationConfigurer

Gets a configurer for distributed state machine config.

Specified by:

withDistributed in interface StateMachineConfigurationConfigurer<S,E>

Returns:

DistributedStateMachineConfigurer for chaining

Throws:

Exception - if configuration error happens

withSecurity

public SecurityConfigurer<S,E> withSecurity()
                                     throws Exception

Description copied from interface: StateMachineConfigurationConfigurer

Gets a configurer for securing state machine.

Specified by:

withSecurity in interface StateMachineConfigurationConfigurer<S,E>

Returns:

SecurityConfigurer for chaining

Throws:

Exception - if configuration error happens

withVerifier

public VerifierConfigurer<S,E> withVerifier()
                                     throws Exception

Description copied from interface: StateMachineConfigurationConfigurer

Gets a configurer for state machine model verifier.

Specified by:

withVerifier in interface StateMachineConfigurationConfigurer<S,E>

Returns:

VerifierConfigurer for chaining

Throws:

Exception - if configuration error happens

withMonitoring

public MonitoringConfigurer<S,E> withMonitoring()
                                         throws Exception

Description copied from interface: StateMachineConfigurationConfigurer

Gets a configurer for state machine monitoring.

Specified by:

withMonitoring in interface StateMachineConfigurationConfigurer<S,E>

Returns:

MonitoringConfigurer for chaining

Throws:

Exception - if configuration error happens

withPersistence

public PersistenceConfigurer<S,E> withPersistence()
                                           throws Exception

Description copied from interface: StateMachineConfigurationConfigurer

Gets a configurer for state machine persistence.

Specified by:

withPersistence in interface StateMachineConfigurationConfigurer<S,E>

Returns:

PersistenceConfigurer for chaining

Throws:

Exception - if configuration error happens

performBuild

protected ConfigurationData<S,E> performBuild()
                                       throws Exception

Description copied from class: AbstractConfiguredAnnotationBuilder

Subclasses must implement this method to build the object that is being returned.

Specified by:

performBuild in class AbstractConfiguredAnnotationBuilder<ConfigurationData<S,E>,StateMachineConfigurationConfigurer<S,E>,StateMachineConfigurationBuilder<S,E>>

Returns:

Object build by this builder

Throws:

Exception - if error occurred

setMachineId

public void setMachineId(String machineId)

Sets the machine id.

Parameters:

machineId - the new machine id

setBeanFactory

public void setBeanFactory(org.springframework.beans.factory.BeanFactory beanFactory)

Sets the bean factory.

Parameters:

beanFactory - the new bean factory

setStateMachineEnsemble

public void setStateMachineEnsemble(StateMachineEnsemble<S,E> ensemble)

Sets the state machine ensemble.

Parameters:

ensemble - the ensemble

setAutoStart

public void setAutoStart(boolean autoStart)

Sets the auto start.

Parameters:

autoStart - the new autostart flag

setStateMachineListeners

public void setStateMachineListeners(List<StateMachineListener<S,E>> listeners)

Sets the state machine listeners.

Parameters:

listeners - the listeners

setSecurityEnabled

public void setSecurityEnabled(boolean securityEnabled)

Sets the security enabled.

Parameters:

securityEnabled - the new security enabled

setVerifierEnabled

public void setVerifierEnabled(boolean verifierEnabled)

Sets the verifier enabled.

Parameters:

verifierEnabled - the new verifier enabled

setStateMachineMonitor

public void setStateMachineMonitor(StateMachineMonitor<S,E> stateMachineMonitor)

Sets the state machine monitor.

Parameters:

stateMachineMonitor - the state machine monitor

setTransitionSecurityAccessDecisionManager

public void setTransitionSecurityAccessDecisionManager(org.springframework.security.access.AccessDecisionManager transitionSecurityAccessDecisionManager)

Sets the security transition access decision manager.

Parameters:

transitionSecurityAccessDecisionManager - the new security transition access decision manager

setEventSecurityAccessDecisionManager

public void setEventSecurityAccessDecisionManager(org.springframework.security.access.AccessDecisionManager eventSecurityAccessDecisionManager)

Sets the security event access decision manager.

Parameters:

eventSecurityAccessDecisionManager - the new security event access decision manager

setEventSecurityRule

public void setEventSecurityRule(SecurityRule eventSecurityRule)

Sets the event security rule.

Parameters:

eventSecurityRule - the new event security rule

setTransitionSecurityRule

public void setTransitionSecurityRule(SecurityRule transitionSecurityRule)

Sets the transition security rule.

Parameters:

transitionSecurityRule - the new event security rule

setVerifier

public void setVerifier(StateMachineModelVerifier<S,E> verifier)

Sets the state machine model verifier.

Parameters:

verifier - the state machine model verifier

setStateMachineRuntimePersister

public void setStateMachineRuntimePersister(StateMachineRuntimePersister<S,E,?> persister)

Sets the state machine runtime persister.

Parameters:

persister - the state machine runtime persister

setTransitionConflictPolicy

public void setTransitionConflictPolicy(TransitionConflictPolicy transitionConflictPolicy)

Sets the transition conflict policy.

Parameters:

transitionConflictPolicy - the new transition conflict policy

setStateDoActionPolicy

public void setStateDoActionPolicy(StateDoActionPolicy stateDoActionPolicy,
 Long stateDoActionPolicyTimeout)

Sets the state do action policy and timeout.

Parameters:

stateDoActionPolicy - the new state do action policy

stateDoActionPolicyTimeout - the new state do action policy timeout

setRegionExecutionPolicy

public void setRegionExecutionPolicy(RegionExecutionPolicy regionExecutionPolicy)

Sets the region execution policy.

Parameters:

regionExecutionPolicy - the region execution policy