org.springframework.webflow.executor.jsf
Class FlowNavigationHandler

java.lang.Object
  javax.faces.application.NavigationHandler
      org.springframework.web.jsf.DecoratingNavigationHandler
          org.springframework.webflow.executor.jsf.FlowNavigationHandler

public class FlowNavigationHandler
extends org.springframework.web.jsf.DecoratingNavigationHandler

An implementation of a JSF NavigationHandler that provides integration with Spring Web Flow. It delegates handling to the standard NavigationHandler implementation when a navigation request does not pertain to a flow execution.

Specifically, the following navigation handler algorithm is implemented:

• If a flow execution is not currently in progress:
  • If the specified logical outcome is of the form flowId:xxx, look up the corresponding Flow definition with that id and launch a new flow execution in the starting state. Expose information to indicate that this flow is in progress and render the starting ViewSelection.
  • If the specified logical outcome is not of the form flowId:xxx, simply delegate to the standard NavigationHandler implementation and return.
• If a flow execution is currently in progress:
  • Load the reference to the current in-progress flow execution using the submitted _flowExecutionKey parameter.
  • Resume the flow execution by signaling what action outcome (aka event) the user took in the current state.
  • Once state event processing to complete, render the ViewSelection returned.

Author:

Craig McClanahan, Colin Sampaleanu, Keith Donald

Field Summary

protected org.apache.commons.logging.Log

logger Logger, usable by subclasses.

Constructor Summary

FlowNavigationHandler()
Create a new FlowNavigationHandler using the default constructor.

FlowNavigationHandler(javax.faces.application.NavigationHandler originalNavigationHandler)
Create a new FlowNavigationHandler, wrapping the specified standard navigation handler implementation.

Method Summary

protected MutableAttributeMap	createInput(FlowExecution flowExecution, ExternalContext context) Factory method that creates the input attribute map for a newly created FlowExecution.
FlowExecutorArgumentExtractor	getArgumentExtractor() Returns the argument extractor used by this navigation handler.
void	handleNavigation(javax.faces.context.FacesContext facesContext, java.lang.String fromAction, java.lang.String outcome, javax.faces.application.NavigationHandler originalNavigationHandler)
void	setArgumentExtractor(FlowExecutorArgumentExtractor argumentExtractor) Sets the argument extractor to use.

Methods inherited from class org.springframework.web.jsf.DecoratingNavigationHandler

callNextHandlerInChain, getDecoratedNavigationHandler, handleNavigation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger

protected final org.apache.commons.logging.Log logger

Logger, usable by subclasses.

Constructor Detail

FlowNavigationHandler

public FlowNavigationHandler()

Create a new FlowNavigationHandler using the default constructor.

FlowNavigationHandler

public FlowNavigationHandler(javax.faces.application.NavigationHandler originalNavigationHandler)

Create a new FlowNavigationHandler, wrapping the specified standard navigation handler implementation.

Parameters:

originalNavigationHandler - Standard NavigationHandler we are wrapping

Method Detail

getArgumentExtractor

public FlowExecutorArgumentExtractor getArgumentExtractor()

Returns the argument extractor used by this navigation handler.

setArgumentExtractor

public void setArgumentExtractor(FlowExecutorArgumentExtractor argumentExtractor)

Sets the argument extractor to use.

handleNavigation

public void handleNavigation(javax.faces.context.FacesContext facesContext,
                             java.lang.String fromAction,
                             java.lang.String outcome,
                             javax.faces.application.NavigationHandler originalNavigationHandler)

Specified by:

handleNavigation in class org.springframework.web.jsf.DecoratingNavigationHandler

createInput

protected MutableAttributeMap createInput(FlowExecution flowExecution,
                                          ExternalContext context)

Factory method that creates the input attribute map for a newly created FlowExecution. TODO - add support for input mappings here

Parameters:

flowExecution - the new flow execution (yet to be started)

context - the external context

Returns:

the input map