| java.lang.Object
 org.springframework.webflow.engine.builder.FlowArtifactFactory
| FlowArtifactFactory | | public class FlowArtifactFactory (Code) | | A factory for core web flow elements such as
Flow flows ,
State states , and
Transition transitions .
This factory encapsulates the construction of each Flow implementation as
well as each core artifact type. Subclasses may customize how the core elements
are created, useful for plugging in custom implementations.
author:
Keith Donald
author:
Erwin Vervaet |
| Method Summary | |
| public State | createActionState(String id, Flow flow, Action[] entryActions, Action[] actions, Transition[] transitions, FlowExecutionExceptionHandler[] exceptionHandlers, Action[] exitActions, AttributeMap attributes)
Factory method that creates a new action state, a state where a system
action is executed. | | public State | createDecisionState(String id, Flow flow, Action[] entryActions, Transition[] transitions, FlowExecutionExceptionHandler[] exceptionHandlers, Action[] exitActions, AttributeMap attributes)
Factory method that creates a new decision state, a state where a flow
routing decision is made. | | public State | createEndState(String id, Flow flow, Action[] entryActions, ViewSelector viewSelector, AttributeMapper outputMapper, FlowExecutionExceptionHandler[] exceptionHandlers, AttributeMap attributes)
Factory method that creates a new end state, a state where an executing
flow session terminates. | | public Flow | createFlow(String id, AttributeMap attributes)
Factory method that creates a new
Flow definition object.
Note this method does not return a fully configured Flow instance, it
only encapsulates the selection of implementation. | | public State | createSubflowState(String id, Flow flow, Action[] entryActions, Flow subflow, FlowAttributeMapper attributeMapper, Transition[] transitions, FlowExecutionExceptionHandler[] exceptionHandlers, Action[] exitActions, AttributeMap attributes)
Factory method that creates a new subflow state, a state where a parent
flow spawns another flow as a subflow. | | public Transition | createTransition(TargetStateResolver targetStateResolver, TransitionCriteria matchingCriteria, TransitionCriteria executionCriteria, AttributeMap attributes)
Factory method that creates a new transition, a path from one step in a
flow to another. | | public State | createViewState(String id, Flow flow, Action[] entryActions, ViewSelector viewSelector, Action[] renderActions, Transition[] transitions, FlowExecutionExceptionHandler[] exceptionHandlers, Action[] exitActions, AttributeMap attributes)
Factory method that creates a new view state, a state where a user is
allowed to participate in the flow. |
| createActionState | | public State createActionState(String id, Flow flow, Action[] entryActions, Action[] actions, Transition[] transitions, FlowExecutionExceptionHandler[] exceptionHandlers, Action[] exitActions, AttributeMap attributes) throws FlowArtifactLookupException(Code) | | Factory method that creates a new action state, a state where a system
action is executed. This method is an atomic operation that returns a
fully initialized state. It encapsulates the selection of the action
state implementation as well as the state assembly.
Parameters:
id - the identifier to assign to the state, must be unique to itsowning flow (required)
Parameters:
flow - the flow that will own (contain) this state (required)
Parameters:
entryActions - any state entry actions; may be null
Parameters:
actions - the actions to execute when the state is entered(required)
Parameters:
transitions - any transitions (paths) out of this state; may be null
Parameters:
exceptionHandlers - any exception handlers; may be null
Parameters:
exitActions - any state exit actions; may be null
Parameters:
attributes - attributes to assign to the State, which may also beused to affect state construction; may be null the fully initialized action state instance
throws:
FlowArtifactLookupException - an exception occured creating thestate |
| createDecisionState | | public State createDecisionState(String id, Flow flow, Action[] entryActions, Transition[] transitions, FlowExecutionExceptionHandler[] exceptionHandlers, Action[] exitActions, AttributeMap attributes) throws FlowArtifactLookupException(Code) | | Factory method that creates a new decision state, a state where a flow
routing decision is made. This method is an atomic operation that returns
a fully initialized state. It encapsulates the selection of the decision
state implementation as well as the state assembly.
Parameters:
id - the identifier to assign to the state, must be unique to itsowning flow (required)
Parameters:
flow - the flow that will own (contain) this state (required)
Parameters:
entryActions - any state entry actions; may be null
Parameters:
transitions - any transitions (paths) out of this state
Parameters:
exceptionHandlers - any exception handlers; may be null
Parameters:
exitActions - any state exit actions; may be null
Parameters:
attributes - attributes to assign to the State, which may also beused to affect state construction; may be null the fully initialized decision state instance
throws:
FlowArtifactLookupException - an exception occured creating thestate |
| createEndState | | public State createEndState(String id, Flow flow, Action[] entryActions, ViewSelector viewSelector, AttributeMapper outputMapper, FlowExecutionExceptionHandler[] exceptionHandlers, AttributeMap attributes) throws FlowArtifactLookupException(Code) | | Factory method that creates a new end state, a state where an executing
flow session terminates. This method is an atomic operation that returns
a fully initialized state. It encapsulates the selection of the end state
implementation as well as the state assembly.
Parameters:
id - the identifier to assign to the state, must be unique to itsowning flow (required)
Parameters:
flow - the flow that will own (contain) this state (required)
Parameters:
entryActions - any state entry actions; may be null
Parameters:
viewSelector - the state confirmation view selector strategy; may benull
Parameters:
outputMapper - the state output mapper; may be null
Parameters:
exceptionHandlers - any exception handlers; may be null
Parameters:
attributes - attributes to assign to the State, which may also beused to affect state construction; may be null the fully initialized subflow state instance
throws:
FlowArtifactLookupException - an exception occured creating thestate |
| createFlow | | public Flow createFlow(String id, AttributeMap attributes) throws FlowArtifactLookupException(Code) | | Factory method that creates a new
Flow definition object.
Note this method does not return a fully configured Flow instance, it
only encapsulates the selection of implementation. A
FlowAssembler delegating to a calling
FlowBuilder is
expected to assemble the Flow fully before returning it to external
clients.
Parameters:
id - the flow identifier, should be unique to all flows in anapplication (required)
Parameters:
attributes - attributes to assign to the Flow, which may also beused to affect flow construction; may be null the initial flow instance, ready for assembly by a FlowBuilder
throws:
FlowArtifactLookupException - an exception occured creating theFlow instance |
| createSubflowState | | public State createSubflowState(String id, Flow flow, Action[] entryActions, Flow subflow, FlowAttributeMapper attributeMapper, Transition[] transitions, FlowExecutionExceptionHandler[] exceptionHandlers, Action[] exitActions, AttributeMap attributes) throws FlowArtifactLookupException(Code) | | Factory method that creates a new subflow state, a state where a parent
flow spawns another flow as a subflow. This method is an atomic operation
that returns a fully initialized state. It encapsulates the selection of
the subflow state implementation as well as the state assembly.
Parameters:
id - the identifier to assign to the state, must be unique to itsowning flow (required)
Parameters:
flow - the flow that will own (contain) this state (required)
Parameters:
entryActions - any state entry actions; may be null
Parameters:
subflow - the subflow definition (required)
Parameters:
attributeMapper - the subflow input and output attribute mapper; maybe null
Parameters:
transitions - any transitions (paths) out of this state
Parameters:
exceptionHandlers - any exception handlers; may be null
Parameters:
exitActions - any state exit actions; may be null
Parameters:
attributes - attributes to assign to the State, which may also beused to affect state construction; may be null the fully initialized subflow state instance
throws:
FlowArtifactLookupException - an exception occured creating thestate |
| createTransition | | public Transition createTransition(TargetStateResolver targetStateResolver, TransitionCriteria matchingCriteria, TransitionCriteria executionCriteria, AttributeMap attributes) throws FlowArtifactLookupException(Code) | | Factory method that creates a new transition, a path from one step in a
flow to another. This method is an atomic operation that returns a fully
initialized transition. It encapsulates the selection of the transition
implementation as well as the transition assembly.
Parameters:
targetStateResolver - the resolver of the target state of the transition (required)
Parameters:
matchingCriteria - the criteria that matches the transition; may benull
Parameters:
executionCriteria - the criteria that governs execution of thetransition after match; may be null
Parameters:
attributes - attributes to assign to the transition, which may alsobe used to affect transition construction; may be null the fully initialized transition instance
throws:
FlowArtifactLookupException - an exception occured creating thetransition |
| createViewState | | public State createViewState(String id, Flow flow, Action[] entryActions, ViewSelector viewSelector, Action[] renderActions, Transition[] transitions, FlowExecutionExceptionHandler[] exceptionHandlers, Action[] exitActions, AttributeMap attributes) throws FlowArtifactLookupException(Code) | | Factory method that creates a new view state, a state where a user is
allowed to participate in the flow. This method is an atomic operation
that returns a fully initialized state. It encapsulates the selection of
the view state implementation as well as the state assembly.
Parameters:
id - the identifier to assign to the state, must be unique to itsowning flow (required)
Parameters:
flow - the flow that will own (contain) this state (required)
Parameters:
entryActions - any state entry actions; may be null
Parameters:
viewSelector - the state view selector strategy; may be null
Parameters:
renderActions - any 'render actions' to execute on entry and refresh;may be null
Parameters:
transitions - any transitions (paths) out of this state; may be null
Parameters:
exceptionHandlers - any exception handlers; may be null
Parameters:
exitActions - any state exit actions; may be null
Parameters:
attributes - attributes to assign to the State, which may also beused to affect state construction; may be null the fully initialized view state instance
throws:
FlowArtifactLookupException - an exception occured creating thestate |
|
|