Package org.springframework.webflow.execution

Class FlowExecutionListenerAdapter

java.lang.Object
org.springframework.webflow.execution.FlowExecutionListenerAdapter
All Implemented Interfaces:
FlowExecutionListener
public abstract class FlowExecutionListenerAdapter extends Object implements FlowExecutionListener
Deprecated.
as of 5.0 FlowExecutionListener has default methods (made possible by a Java 8 baseline) and can be implemented directly without the need for this adapter.
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 Details

    • FlowExecutionListenerAdapter

      public FlowExecutionListenerAdapter()
      Deprecated.

  • Method Details

    • requestSubmitted

      public void requestSubmitted(RequestContext context)
      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 interface FlowExecutionListener
      Parameters:
      context - the current flow request context

    • requestProcessed

      public void requestProcessed(RequestContext context)
      Deprecated.
      Description copied from interface: FlowExecutionListener
      Called when a client request has completed processing.
      Specified by:
      requestProcessed in interface FlowExecutionListener
      Parameters:
      context - the source of the event

    • sessionCreating

      public void sessionCreating(RequestContext context, FlowDefinition definition)
      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 interface FlowExecutionListener
      Parameters:
      context - the current flow request context
      definition - 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 interface FlowExecutionListener
      Parameters:
      context - the current flow request context
      session - the session that was created
      input - a mutable input map - attributes placed in this map are eligible for input mapping by the flow definition at startup

    • sessionStarted

      public void sessionStarted(RequestContext context, FlowSession session)
      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 interface FlowExecutionListener
      Parameters:
      context - the current flow request context
      session - the session that was started

    • eventSignaled

      public void eventSignaled(RequestContext context, Event event)
      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 interface FlowExecutionListener
      Parameters:
      context - the current flow request context
      event - the event that occurred

    • transitionExecuting

      public void transitionExecuting(RequestContext context, TransitionDefinition transition)
      Deprecated.
      Description copied from interface: FlowExecutionListener
      Called when a transition is matched but before the transition occurs.
      Specified by:
      transitionExecuting in interface FlowExecutionListener
      Parameters:
      context - the current flow request context
      transition - 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 interface FlowExecutionListener
      Parameters:
      context - the current flow request context
      state - the proposed state to transition to
      Throws:
      EnterStateVetoException - when entering the state is not allowed

    • viewRendered

      public void viewRendered(RequestContext context, View view, StateDefinition viewState)
      Deprecated.
      Description copied from interface: FlowExecutionListener
      Called after a view has completed rendering.
      Specified by:
      viewRendered in interface FlowExecutionListener
      Parameters:
      context - the current flow request context
      view - the view that rendered
      viewState - the current view state

    • viewRendering

      public void viewRendering(RequestContext context, View view, StateDefinition viewState)
      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 interface FlowExecutionListener
      Parameters:
      context - the current flow request context
      view - the view that is about to render
      viewState - 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 interface FlowExecutionListener
      Parameters:
      context - the current flow request context
      previousState - from state of the transition
      newState - to state of the transition

    • paused

      public void paused(RequestContext context)
      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 interface FlowExecutionListener
      Parameters:
      context - the current flow request context

    • resuming

      public void resuming(RequestContext context)
      Deprecated.
      Description copied from interface: FlowExecutionListener
      Called after a flow execution is successfully reactivated after pause (but before event processing).
      Specified by:
      resuming in interface FlowExecutionListener
      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 interface FlowExecutionListener
      Parameters:
      context - the current flow request context
      session - the current active session that is ending
      outcome - the outcome reached by the ending session, generally the id of the terminating end-state
      output - 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 interface FlowExecutionListener
      Parameters:
      context - the current flow request context
      session - ending flow session
      outcome - the outcome reached by the ended session, generally the id of the terminating end-state
      output - the flow output returned by the ending session

    • exceptionThrown

      public void exceptionThrown(RequestContext context, FlowExecutionException exception)
      Deprecated.
      Description copied from interface: FlowExecutionListener
      Called when an exception is thrown during a flow execution, before the exception is handled by any registered handler.
      Specified by:
      exceptionThrown in interface FlowExecutionListener
      Parameters:
      context - the current flow request context
      exception - the exception that occurred