org.springframework.webflow.context.portlet
Class DefaultFlowUrlHandler

java.lang.Object
  extended by org.springframework.webflow.context.portlet.DefaultFlowUrlHandler
All Implemented Interfaces:
FlowUrlHandler

public class DefaultFlowUrlHandler
extends Object
implements FlowUrlHandler

Default flow URL handler for SWF 2.

Author:
Scott Andrews

Constructor Summary
DefaultFlowUrlHandler()
           
 
Method Summary
 String createFlowExecutionUrl(String flowId, String flowExecutionKey, javax.portlet.RenderResponse response)
          Creates a flow execution URL suitable for use as an action URL.
 String getFlowExecutionKey(javax.portlet.PortletRequest request)
          Extract the flow execution from the request.
 void setFlowExecutionInSession(String flowExecutionKey, javax.portlet.RenderRequest request)
          Set the flow execution key into the portlet session.
 void setFlowExecutionRenderParameter(String flowExecutionKey, javax.portlet.ActionResponse response)
          Set the flow execution key render parameter.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DefaultFlowUrlHandler

public DefaultFlowUrlHandler()
Method Detail

getFlowExecutionKey

public String getFlowExecutionKey(javax.portlet.PortletRequest request)
Description copied from interface: FlowUrlHandler
Extract the flow execution from the request.

Specified by:
getFlowExecutionKey in interface FlowUrlHandler
Parameters:
request - the request
Returns:
the flow execution key, or null if no flow execution key is present

setFlowExecutionRenderParameter

public void setFlowExecutionRenderParameter(String flowExecutionKey,
                                            javax.portlet.ActionResponse response)
Description copied from interface: FlowUrlHandler
Set the flow execution key render parameter.

Specified by:
setFlowExecutionRenderParameter in interface FlowUrlHandler
Parameters:
flowExecutionKey - the key
response - the action response

setFlowExecutionInSession

public void setFlowExecutionInSession(String flowExecutionKey,
                                      javax.portlet.RenderRequest request)
Description copied from interface: FlowUrlHandler
Set the flow execution key into the portlet session. This should only be used when the portlet is started before any action requests are made

Specified by:
setFlowExecutionInSession in interface FlowUrlHandler
Parameters:
flowExecutionKey - the key
request - the render request

createFlowExecutionUrl

public String createFlowExecutionUrl(String flowId,
                                     String flowExecutionKey,
                                     javax.portlet.RenderResponse response)
Description copied from interface: FlowUrlHandler
Creates a flow execution URL suitable for use as an action URL.

Specified by:
createFlowExecutionUrl in interface FlowUrlHandler
Parameters:
flowId - the flow id
flowExecutionKey - the flow execution key
response - the render response
Returns:
the execution url