org.statefulj.framework.core.annotations

Annotation Type StatefulController

@Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Documented
 @Component
public @interface StatefulController

The StatefulController annotation defines a Finite State Machine for the specified managed Entity. A StatefulController is a Spring Component that will be managed by Spring via Component scanning.

Author:

Andrew Hall

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
Class<?>	clazz The Entity class managed by the StatefulController
String	startState The Starting State.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	blockingStates Defines the set of "Blocking" States.
String	factoryId The bean Id of the Factory for this Entity.
String	finderId The bean Id of the Finder for this Entity.
Transition[]	noops A set of NOOP Transition
String	persisterId The bean Id of the Persister for this Entity.
int	retryAttempts Specify the number of times StatefulJ should attempt to handle the event.
int	retryInterval The interval, in milliseconds, between each retry attempt
String	stateField The name of the managed State field.
String	value The value may indicate a suggestion for a logical component name, to be turned into a Spring bean in case of an auto-detected component.

Element Detail

startState

public abstract String startState

The Starting State. When the StatefulJ framework is invoked without a Stateful Entity, then the framework will create a new instance of the Stateful Entity via the Factory bean. The StatefulJ Framework will set the state of the newly created Stateful Entity to the startState value.

Returns:

Starting State

clazz

public abstract Class<?> clazz

The Entity class managed by the StatefulController

Returns:

Entity Class

value

public abstract String value

The value may indicate a suggestion for a logical component name, to be turned into a Spring bean in case of an auto-detected component.

Returns:

the suggested component name, if any

Default:

""

stateField

public abstract String stateField

The name of the managed State field. If blank, the Entity will be inspected for a field annotated with State

Returns:

Name of the State field

Default:

""

factoryId

public abstract String factoryId

The bean Id of the Factory for this Entity. The Factory Class must implement the Factory Interface. If not specified, the StatefulJ Framework will use the default Factory Implementation.

Returns:

Id of the Factory Bean

Default:

""

finderId

public abstract String finderId

The bean Id of the Finder for this Entity. The Finder Class must implement the Finder Interface. If not specified, the StatefulJ Framework will use the default Finder Implementation.

Returns:

Id of the Finder Bean

Default:

""

persisterId

public abstract String persisterId

The bean Id of the Persister for this Entity. The Persister is responsible for updating the State field for the Stateful Entity. The Persister must implement the Persister Interface. If not specified, the StatefulJ Framework will use the default Persister Implementation.

Returns:

Id of the Persister Bean

Default:

""

blockingStates

public abstract String[] blockingStates

Defines the set of "Blocking" States. A Blocking State is a State that "block" an event from being handled until the FSM transitions out of the Blocking State

Returns:

Array of Blocking States

Default:

{}

noops

public abstract Transition[] noops

A set of NOOP Transition

Returns:

Array of NOOP Transitions

Default:

{}

retryAttempts

public abstract int retryAttempts

Specify the number of times StatefulJ should attempt to handle the event. If retryAttempts is -1, then it will always attempt to handle the event

Returns:

number of retry attempts

Default:

20

retryInterval

public abstract int retryInterval

The interval, in milliseconds, between each retry attempt

Returns:

retry interval in milliseconds

Default:

250