| org.springframework.webflow.execution.FlowExecutionListener
All known Subclasses: org.springframework.webflow.execution.FlowExecutionListenerAdapter,
| FlowExecutionListener | | public interface FlowExecutionListener (Code) | | 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. Another listener may
track flow execution navigation history to support bread crumbs. Another may
perform auditing, or setup and tear down connections to a transactional
resource.
Note that flow execution listeners are registered with a flow execution when
that execution is created by a
FlowExecutionFactory factory or
restored by a
org.springframework.webflow.execution.repository.FlowExecutionRepository .
Typically a listener will not be registered with a flow execution at
runtime, when the flow execution is already active.
See Also: FlowDefinition
See Also: StateDefinition
See Also: FlowExecution
See Also: RequestContext
See Also: Event
See Also: ViewSelection
author:
Keith Donald
author:
Erwin Vervaet |
| Method Summary | |
| public void | eventSignaled(RequestContext context, Event event)
Called when an event is signaled in the current state, but prior to any
state transition. | | public void | exceptionThrown(RequestContext context, FlowExecutionException exception)
Called when an exception is thrown during a flow execution, before the
exception is handled by any registered
FlowExecutionExceptionHandler handler . | | public void | paused(RequestContext context, ViewSelection selectedView)
Called when a flow execution is paused, for instance when it is waiting
for user input (after event processing). | | public void | requestProcessed(RequestContext context)
Called when a client request has completed processing. | | public void | requestSubmitted(RequestContext context)
Called when any client request is submitted to manipulate this flow
execution. | | public void | resumed(RequestContext context)
Called after a flow execution is successfully reactivated after pause
(but before event processing). | | public void | sessionCreated(RequestContext context, FlowSession session)
Called after a new flow session has been created but before it starts. | | public void | sessionEnded(RequestContext context, FlowSession session, AttributeMap output)
Called when a flow execution session ends. | | public void | sessionEnding(RequestContext context, FlowSession session, MutableAttributeMap output)
Called when the active flow execution session has been asked to end but
before it has ended. | | public void | sessionStarted(RequestContext context, FlowSession session)
Called after a new flow session has started. | | public void | sessionStarting(RequestContext context, FlowDefinition definition, MutableAttributeMap input)
Called to indicate a new flow definition session is about to be created
and started. | | public void | stateEntered(RequestContext context, StateDefinition previousState, StateDefinition state)
Called when a state transitions, after the transition occured. | | public void | stateEntering(RequestContext context, StateDefinition state)
Called when a state transitions, after the transition is matched but
before the transition occurs. |
| eventSignaled | | public void eventSignaled(RequestContext context, Event event)(Code) | | Called when an event is signaled in the current state, but prior to any
state transition.
Parameters:
context - the source of the event
Parameters:
event - the event that occured |
| exceptionThrown | | public void exceptionThrown(RequestContext context, FlowExecutionException exception)(Code) | | Called when an exception is thrown during a flow execution, before the
exception is handled by any registered
FlowExecutionExceptionHandler handler .
Parameters:
context - the source of the exception
Parameters:
exception - the exception that occurred |
| paused | | public void paused(RequestContext context, ViewSelection selectedView)(Code) | | Called when a flow execution is paused, for instance when it is waiting
for user input (after event processing).
Parameters:
context - the source of the event
Parameters:
selectedView - the view that will display |
| requestProcessed | | public void requestProcessed(RequestContext context)(Code) | | Called when a client request has completed processing.
Parameters:
context - the source of the event |
| requestSubmitted | | public void requestSubmitted(RequestContext context)(Code) | | Called when any client request is submitted to manipulate this flow
execution. This call happens before request processing.
Parameters:
context - the source of the event |
| resumed | | public void resumed(RequestContext context)(Code) | | Called after a flow execution is successfully reactivated after pause
(but before event processing).
Parameters:
context - the source of the event |
| sessionCreated | | public void sessionCreated(RequestContext context, FlowSession session)(Code) | | Called after a new flow session has been created but before it starts.
Useful for setting arbitrary attributes in the session before the flow
starts.
Parameters:
context - the source of the event
Parameters:
session - the session that was created
since:
1.0.2 |
| sessionEnded | | public void sessionEnded(RequestContext context, FlowSession session, AttributeMap output)(Code) | | Called when a flow execution session ends. If the ended session was the
root session of the flow execution, the entire flow execution also ends.
Parameters:
context - the source of the event
Parameters:
session - ending flow session
Parameters:
output - final, unmodifiable output returned by the ended session |
| sessionEnding | | public void sessionEnding(RequestContext context, FlowSession session, MutableAttributeMap output)(Code) | | Called when the active flow execution session has been asked to end but
before it has ended.
Parameters:
context - the source of the event
Parameters:
session - the current active session that is ending
Parameters:
output - the flow output produced by the ending session, this mapmay be modified by this listener to affect the output returned |
| sessionStarted | | public void sessionStarted(RequestContext context, FlowSession session)(Code) | | Called after a new flow session has started. At this point the flow's
start state has been entered and any other startup behaviors have been
executed.
Parameters:
context - the source of the event
Parameters:
session - the session that was started |
| sessionStarting | | public void sessionStarting(RequestContext context, FlowDefinition definition, MutableAttributeMap input)(Code) | | Called to indicate a new flow definition session is about to be created
and started. Called before the session is created. An exception may be
thrown from this method to veto the start operation. Any type of runtime
exception can be used for this purpose.
Parameters:
context - the source of the event
Parameters:
definition - the flow for which a new session is starting
Parameters:
input - a mutable input map - attributes placed in this map areeligible for input mapping by the flow definition at startup |
| stateEntered | | public void stateEntered(RequestContext context, StateDefinition previousState, StateDefinition state)(Code) | | Called when a state transitions, after the transition occured.
Parameters:
context - the source of the event
Parameters:
previousState - from state of the transition
Parameters:
state - to state of the transition |
|
|