Class FlowExecutionListenerAdapter
java.lang.Object
org.springframework.webflow.execution.FlowExecutionListenerAdapter
- All Implemented Interfaces:
FlowExecutionListener
Deprecated.
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.
- Author:
- Erwin Vervaet, Keith Donald, Scott Andrews
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
eventSignaled
(RequestContext context, Event event) Deprecated.Called when an event is signaled in the current state, but prior to any state transition.void
exceptionThrown
(RequestContext context, FlowExecutionException exception) Deprecated.Called when an exception is thrown during a flow execution, before the exception is handled by any registeredhandler
.void
paused
(RequestContext context) Deprecated.Called when a flow execution is paused, for instance when it is waiting for user input (after event processing).void
requestProcessed
(RequestContext context) Deprecated.Called when a client request has completed processing.void
requestSubmitted
(RequestContext context) Deprecated.Called when any client request is submitted to manipulate this flow execution.void
resuming
(RequestContext context) Deprecated.Called after a flow execution is successfully reactivated after pause (but before event processing).void
sessionCreating
(RequestContext context, FlowDefinition definition) Deprecated.Called to indicate a new flow definition session is about to be created.void
sessionEnded
(RequestContext context, FlowSession session, String outcome, AttributeMap<?> output) Deprecated.Called when a flow execution session ends.void
sessionEnding
(RequestContext context, FlowSession session, String outcome, MutableAttributeMap<?> output) Deprecated.Called when the active flow execution session has been asked to end but before it has ended.void
sessionStarted
(RequestContext context, FlowSession session) Deprecated.Called after a new flow session has started.void
sessionStarting
(RequestContext context, FlowSession session, MutableAttributeMap<?> input) Deprecated.Called after a new flow session has been created but before it starts.void
stateEntered
(RequestContext context, StateDefinition previousState, StateDefinition newState) Deprecated.Called when a state transitions, after the transition occurred.void
stateEntering
(RequestContext context, StateDefinition state) Deprecated.Called when a state transitions, after the transition is matched but before the transition occurs.void
transitionExecuting
(RequestContext context, TransitionDefinition transition) Deprecated.Called when a transition is matched but before the transition occurs.void
viewRendered
(RequestContext context, View view, StateDefinition viewState) Deprecated.Called after a view has completed rendering.void
viewRendering
(RequestContext context, View view, StateDefinition viewState) Deprecated.Called when a view is about to render in a view-state, before any render actions are executed.
-
Constructor Details
-
FlowExecutionListenerAdapter
public FlowExecutionListenerAdapter()Deprecated.
-
-
Method Details
-
requestSubmitted
Deprecated.Description copied from interface:FlowExecutionListener
Called when any client request is submitted to manipulate this flow execution. This call happens before request processing.- Specified by:
requestSubmitted
in interfaceFlowExecutionListener
- Parameters:
context
- the current flow request context
-
requestProcessed
Deprecated.Description copied from interface:FlowExecutionListener
Called when a client request has completed processing.- Specified by:
requestProcessed
in interfaceFlowExecutionListener
- Parameters:
context
- the source of the event
-
sessionCreating
Deprecated.Description copied from interface:FlowExecutionListener
Called to indicate a new flow definition session is about to be created. 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.- Specified by:
sessionCreating
in interfaceFlowExecutionListener
- Parameters:
context
- the current flow request contextdefinition
- the flow for which a new session is starting
-
sessionStarting
public void sessionStarting(RequestContext context, FlowSession session, MutableAttributeMap<?> input) Deprecated.Description copied from interface:FlowExecutionListener
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.- Specified by:
sessionStarting
in interfaceFlowExecutionListener
- Parameters:
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 startup
-
sessionStarted
Deprecated.Description copied from interface:FlowExecutionListener
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.- Specified by:
sessionStarted
in interfaceFlowExecutionListener
- Parameters:
context
- the current flow request contextsession
- the session that was started
-
eventSignaled
Deprecated.Description copied from interface:FlowExecutionListener
Called when an event is signaled in the current state, but prior to any state transition.- Specified by:
eventSignaled
in interfaceFlowExecutionListener
- Parameters:
context
- the current flow request contextevent
- the event that occurred
-
transitionExecuting
Deprecated.Description copied from interface:FlowExecutionListener
Called when a transition is matched but before the transition occurs.- Specified by:
transitionExecuting
in interfaceFlowExecutionListener
- Parameters:
context
- the current flow request contexttransition
- the proposed transition
-
stateEntering
public void stateEntering(RequestContext context, StateDefinition state) throws EnterStateVetoException Deprecated.Description copied from interface:FlowExecutionListener
Called when a state transitions, after the transition is matched but before the transition occurs.- Specified by:
stateEntering
in interfaceFlowExecutionListener
- Parameters:
context
- the current flow request contextstate
- the proposed state to transition to- Throws:
EnterStateVetoException
- when entering the state is not allowed
-
viewRendered
Deprecated.Description copied from interface:FlowExecutionListener
Called after a view has completed rendering.- Specified by:
viewRendered
in interfaceFlowExecutionListener
- Parameters:
context
- the current flow request contextview
- the view that renderedviewState
- the current view state
-
viewRendering
Deprecated.Description copied from interface:FlowExecutionListener
Called when a view is about to render in a view-state, before any render actions are executed.- Specified by:
viewRendering
in interfaceFlowExecutionListener
- Parameters:
context
- the current flow request contextview
- the view that is about to renderviewState
- the current view state
-
stateEntered
public void stateEntered(RequestContext context, StateDefinition previousState, StateDefinition newState) Deprecated.Description copied from interface:FlowExecutionListener
Called when a state transitions, after the transition occurred.- Specified by:
stateEntered
in interfaceFlowExecutionListener
- Parameters:
context
- the current flow request contextpreviousState
- from state of the transitionnewState
- to state of the transition
-
paused
Deprecated.Description copied from interface:FlowExecutionListener
Called when a flow execution is paused, for instance when it is waiting for user input (after event processing).- Specified by:
paused
in interfaceFlowExecutionListener
- Parameters:
context
- the current flow request context
-
resuming
Deprecated.Description copied from interface:FlowExecutionListener
Called after a flow execution is successfully reactivated after pause (but before event processing).- Specified by:
resuming
in interfaceFlowExecutionListener
- Parameters:
context
- the current flow request context
-
sessionEnding
public void sessionEnding(RequestContext context, FlowSession session, String outcome, MutableAttributeMap<?> output) Deprecated.Description copied from interface:FlowExecutionListener
Called when the active flow execution session has been asked to end but before it has ended.- Specified by:
sessionEnding
in interfaceFlowExecutionListener
- Parameters:
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 returned
-
sessionEnded
public void sessionEnded(RequestContext context, FlowSession session, String outcome, AttributeMap<?> output) Deprecated.Description copied from interface:FlowExecutionListener
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.- Specified by:
sessionEnded
in interfaceFlowExecutionListener
- Parameters:
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 session
-
exceptionThrown
Deprecated.Description copied from interface:FlowExecutionListener
Called when an exception is thrown during a flow execution, before the exception is handled by any registeredhandler
.- Specified by:
exceptionThrown
in interfaceFlowExecutionListener
- Parameters:
context
- the current flow request contextexception
- the exception that occurred
-
FlowExecutionListener
has default methods (made possible by a Java 8 baseline) and can be implemented directly without the need for this adapter.