org.springframework.webflow.execution.servlet
Class ServletFlowExecutionManager

java.lang.Object
  org.springframework.webflow.execution.FlowExecutionManager
      org.springframework.webflow.execution.servlet.ServletFlowExecutionManager

All Implemented Interfaces:

org.springframework.beans.factory.BeanFactoryAware, FlowExecutionListenerLoader

public class ServletFlowExecutionManager
extends FlowExecutionManager

Flow execution manager to manage flow executions using HTTP servlet requests and the HTTP session.

Author:

Erwin Vervaet, Keith Donald

Field Summary

Fields inherited from class org.springframework.webflow.execution.FlowExecutionManager

CURRENT_STATE_ID_ATTRIBUTE, FLOW_EXECUTION_CONTEXT_ATTRIBUTE, FLOW_EXECUTION_ID_ATTRIBUTE, FLOW_EXECUTION_ID_PARAMETER, FLOW_ID_PARAMETER, logger, NOT_SET_EVENT_ID

Constructor Summary

ServletFlowExecutionManager()
Creates an HTTP-servlet based flow execution manager.

ServletFlowExecutionManager(Flow flow)
Creates an HTTP-servlet based flow execution manager.

ServletFlowExecutionManager(FlowLocator flowLocator)
Creates an HTTP-servlet based flow execution manager.

Method Summary

protected Event	createEvent(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Create a flow event wrapping given request and response.
ViewDescriptor	handle(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) The main entry point into managed HTTP-based flow executions.
ViewDescriptor	handle(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, FlowExecutionListener flowExecutionListener) The main entry point into managed HTTP-based flow executions.
protected void	initDefaults() Set default properties for this manager.

Methods inherited from class org.springframework.webflow.execution.FlowExecutionManager

addListener, addListener, createFlowExecution, getBeanFactory, getConversionService, getFlow, getFlow, getFlowExecutionId, getFlowExecutionIdParameterName, getFlowIdParameterName, getFlowLocator, getListeners, getNotSetEventIdParameterMarker, getStorage, getTransactionSynchronizer, onEvent, onEvent, prepareViewDescriptor, removeListener, setBeanFactory, setConversionService, setFlow, setFlowLocator, setListener, setListener, setListenerMap, setListeners, setListeners, setStorage, setTransactionSynchronizer

Methods inherited from class java.lang.Object

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

Constructor Detail

ServletFlowExecutionManager

public ServletFlowExecutionManager()

Creates an HTTP-servlet based flow execution manager.

ServletFlowExecutionManager

public ServletFlowExecutionManager(Flow flow)

Creates an HTTP-servlet based flow execution manager.

Parameters:

flow - the flow to manage

ServletFlowExecutionManager

public ServletFlowExecutionManager(FlowLocator flowLocator)

Creates an HTTP-servlet based flow execution manager.

Parameters:

flowLocator - the locator to find flows to manage

Method Detail

initDefaults

protected void initDefaults()

Set default properties for this manager.

handle

public ViewDescriptor handle(javax.servlet.http.HttpServletRequest request,
                             javax.servlet.http.HttpServletResponse response)
                      throws java.lang.Exception

The main entry point into managed HTTP-based flow executions.

Parameters:

request - the current HTTP request

response - the current HTTP response

Returns:

the view descriptor of the model and view to render

Throws:

java.lang.Exception - in case of errors

handle

public ViewDescriptor handle(javax.servlet.http.HttpServletRequest request,
                             javax.servlet.http.HttpServletResponse response,
                             FlowExecutionListener flowExecutionListener)
                      throws java.lang.Exception

The main entry point into managed HTTP-based flow executions.

Parameters:

request - the current HTTP request

response - the current HTTP response

flowExecutionListener - a listener interested in flow execution lifecycle events that happen while handling this request

Returns:

the view descriptor of the model and view to render

Throws:

java.lang.Exception - in case of errors

createEvent

protected Event createEvent(javax.servlet.http.HttpServletRequest request,
                            javax.servlet.http.HttpServletResponse response)

Create a flow event wrapping given request and response. Subclasses can override this, e.g. when they want to use special names for the request parameters.