| org.springframework.webflow.execution |
|
Core, stable abstractions for representing runtime executions of flow definitions.
The central concept defined by this package is the
{@link org.springframework.webflow.execution.FlowExecution} interface, which represents
a single instance of a top-level flow definition.
The following classes and interfaces are of particular interest:
-
{@link org.springframework.webflow.execution.FlowExecutionFactory} - An abstract
factory for creating new flow executions.
-
{@link org.springframework.webflow.execution.repository.FlowExecutionRepository} - A DAO
for persisting and restoring existing flow executions.
-
{@link org.springframework.webflow.execution.FlowExecutionListener} - An observer
interface to be implemented by objects that are interested in flow execution
lifecycle events.
Package Usage example:
// create flow execution
FlowDefinition definition = ...
FlowExecutionFactory factory = ...
FlowExecution execution = factory.createFlowExecution(definition);
// start execution
ExternalContext context = ...
ViewSelection response = execution.start(null, context);
This package depends on the definition package.
|
| Java Source File Name | Type | Comment |
| Action.java | Interface | A command that executes a behavior and returns a logical execution result a
calling flow execution can respond to.
Actions typically delegate down to the application (or service) layer to
perform business operations. |
| EnterStateVetoException.java | Class | Exception thrown to veto the entering of a state of a flow. |
| Event.java | Class | Signals the occurrence of something an active flow execution should respond
to. |
| FlowExecution.java | Interface | A top-level instance of a flow definition that carries out definition
execution on behalf of a single client. |
| FlowExecutionContext.java | Interface | Provides contextual information about a flow execution. |
| FlowExecutionException.java | Class | Base class for exceptions that occur within a flow while it is executing. |
| FlowExecutionFactory.java | Interface | An abstract factory for creating flow exections. |
| FlowExecutionListener.java | Interface | Interface to be implemented by objects that wish to listen and respond to the
lifecycle of
FlowExecution flow executions .
An 'observer' that is very aspect like, allowing you to insert 'cross
cutting' behavior at well-defined points within one or more well-defined flow
execution lifecycles.
For example, one custom listener may apply security checks at the flow
execution level, preventing a flow from starting or a state from entering if
the curent user does not have the necessary permissions. |
| FlowExecutionListenerAdapter.java | Class | An abstract adapter class for listeners (observers) of flow execution
lifecycle events. |
| FlowSession.java | Interface | A single, local instantiation of a
FlowDefinition flow definition launched within an overall flow execution.
This object maintains all instance state including session status within
exactly one governing FlowExecution, as well as the current flow state. |
| FlowSessionStatus.java | Class | Type-safe enumeration of possible flow session statuses. |
| RequestContext.java | Interface | A context for a single request to manipulate a flow execution. |
| ScopeType.java | Class | An enumeration of the core scope types of Spring Web Flow. |
| ViewSelection.java | Class | Abstract base class for value objects that provide callers into a flow
execution information about a logical response to issue and the data
necessary to issue it.
This class is a generic marker returned when a request into an executing flow
has completed processing, indicating a client response needs to be issued. |