|
Spring Web Flow | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.springframework.webflow.execution.FlowExecutionListenerAdapter
public abstract class FlowExecutionListenerAdapter
An abstract adapter class for listeners (observers) of flow execution lifecycle events. The methods in this class are empty. This class exists as convenience for creating listener objects; subclass it and override what you need.
Constructor Summary | |
---|---|
FlowExecutionListenerAdapter()
|
Method Summary | |
---|---|
void |
eventSignaled(RequestContext context,
Event event)
Called when an event is signaled in the current state, but prior to any state transition. |
void |
exceptionThrown(RequestContext context,
FlowExecutionException exception)
Called when an exception is thrown during a flow execution, before the exception is handled by any registered handler . |
void |
paused(RequestContext context)
Called when a flow execution is paused, for instance when it is waiting for user input (after event processing). |
void |
requestProcessed(RequestContext context)
Called when a client request has completed processing. |
void |
requestSubmitted(RequestContext context)
Called when any client request is submitted to manipulate this flow execution. |
void |
resuming(RequestContext context)
Called after a flow execution is successfully reactivated after pause (but before event processing). |
void |
sessionCreating(RequestContext context,
FlowDefinition definition)
Called to indicate a new flow definition session is about to be created. |
void |
sessionEnded(RequestContext context,
FlowSession session,
java.lang.String outcome,
AttributeMap<?> output)
Called when a flow execution session ends. |
void |
sessionEnding(RequestContext context,
FlowSession session,
java.lang.String outcome,
MutableAttributeMap<?> output)
Called when the active flow execution session has been asked to end but before it has ended. |
void |
sessionStarted(RequestContext context,
FlowSession session)
Called after a new flow session has started. |
void |
sessionStarting(RequestContext context,
FlowSession session,
MutableAttributeMap<?> input)
Called after a new flow session has been created but before it starts. |
void |
stateEntered(RequestContext context,
StateDefinition previousState,
StateDefinition newState)
Called when a state transitions, after the transition occurred. |
void |
stateEntering(RequestContext context,
StateDefinition state)
Called when a state transitions, after the transition is matched but before the transition occurs. |
void |
transitionExecuting(RequestContext context,
TransitionDefinition transition)
Called when a transition is matched but before the transition occurs. |
void |
viewRendered(RequestContext context,
View view,
StateDefinition viewState)
Called after a view has completed rendering. |
void |
viewRendering(RequestContext context,
View view,
StateDefinition viewState)
Called when a view is about to render in a view-state, before any render actions are executed. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public FlowExecutionListenerAdapter()
Method Detail |
---|
public void requestSubmitted(RequestContext context)
FlowExecutionListener
requestSubmitted
in interface FlowExecutionListener
context
- the current flow request contextpublic void requestProcessed(RequestContext context)
FlowExecutionListener
requestProcessed
in interface FlowExecutionListener
context
- the source of the eventpublic void sessionCreating(RequestContext context, FlowDefinition definition)
FlowExecutionListener
sessionCreating
in interface FlowExecutionListener
context
- the current flow request contextdefinition
- the flow for which a new session is startingpublic void sessionStarting(RequestContext context, FlowSession session, MutableAttributeMap<?> input)
FlowExecutionListener
sessionStarting
in interface FlowExecutionListener
context
- the current flow request contextsession
- the session that was createdinput
- a mutable input map - attributes placed in this map are eligible for input mapping by the flow
definition at startuppublic void sessionStarted(RequestContext context, FlowSession session)
FlowExecutionListener
sessionStarted
in interface FlowExecutionListener
context
- the current flow request contextsession
- the session that was startedpublic void eventSignaled(RequestContext context, Event event)
FlowExecutionListener
eventSignaled
in interface FlowExecutionListener
context
- the current flow request contextevent
- the event that occurredpublic void transitionExecuting(RequestContext context, TransitionDefinition transition)
FlowExecutionListener
transitionExecuting
in interface FlowExecutionListener
context
- the current flow request contexttransition
- the proposed transitionpublic void stateEntering(RequestContext context, StateDefinition state) throws EnterStateVetoException
FlowExecutionListener
stateEntering
in interface FlowExecutionListener
context
- the current flow request contextstate
- the proposed state to transition to
EnterStateVetoException
- when entering the state is not allowedpublic void viewRendered(RequestContext context, View view, StateDefinition viewState)
FlowExecutionListener
viewRendered
in interface FlowExecutionListener
context
- the current flow request contextview
- the view that renderedviewState
- the current view statepublic void viewRendering(RequestContext context, View view, StateDefinition viewState)
FlowExecutionListener
viewRendering
in interface FlowExecutionListener
context
- the current flow request contextview
- the view that is about to renderviewState
- the current view statepublic void stateEntered(RequestContext context, StateDefinition previousState, StateDefinition newState)
FlowExecutionListener
stateEntered
in interface FlowExecutionListener
context
- the current flow request contextpreviousState
- from state of the transitionnewState
- to state of the transitionpublic void paused(RequestContext context)
FlowExecutionListener
paused
in interface FlowExecutionListener
context
- the current flow request contextpublic void resuming(RequestContext context)
FlowExecutionListener
resuming
in interface FlowExecutionListener
context
- the current flow request contextpublic void sessionEnding(RequestContext context, FlowSession session, java.lang.String outcome, MutableAttributeMap<?> output)
FlowExecutionListener
sessionEnding
in interface FlowExecutionListener
context
- the current flow request contextsession
- the current active session that is endingoutcome
- the outcome reached by the ending session, generally the id of the terminating end-stateoutput
- the flow output produced by the ending session, this map may be modified by this listener to affect
the output returnedpublic void sessionEnded(RequestContext context, FlowSession session, java.lang.String outcome, AttributeMap<?> output)
FlowExecutionListener
sessionEnded
in interface FlowExecutionListener
context
- the current flow request contextsession
- ending flow sessionoutcome
- the outcome reached by the ended session, generally the id of the terminating end-stateoutput
- the flow output returned by the ending sessionpublic void exceptionThrown(RequestContext context, FlowExecutionException exception)
FlowExecutionListener
handler
.
exceptionThrown
in interface FlowExecutionListener
context
- the current flow request contextexception
- the exception that occurred
|
Spring Web Flow | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |