org.springframework.webflow.context.portlet
Interface FlowUrlHandler

All Known Implementing Classes:
DefaultFlowUrlHandler

public interface FlowUrlHandler

A interface for parsing and generating flow URLs. Encapsulates a specific flow URL format.

Author:
Keith Donald, Scott Andrews

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.
 

Method Detail

getFlowExecutionKey

String getFlowExecutionKey(javax.portlet.PortletRequest request)
Extract the flow execution from the request.

Parameters:
request - the request
Returns:
the flow execution key, or null if no flow execution key is present

setFlowExecutionRenderParameter

void setFlowExecutionRenderParameter(String flowExecutionKey,
                                     javax.portlet.ActionResponse response)
Set the flow execution key render parameter.

Parameters:
flowExecutionKey - the key
response - the action response

setFlowExecutionInSession

void setFlowExecutionInSession(String flowExecutionKey,
                               javax.portlet.RenderRequest request)
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

Parameters:
flowExecutionKey - the key
request - the render request

createFlowExecutionUrl

String createFlowExecutionUrl(String flowId,
                              String flowExecutionKey,
                              javax.portlet.RenderResponse response)
Creates a flow execution URL suitable for use as an action URL.

Parameters:
flowId - the flow id
flowExecutionKey - the flow execution key
response - the render response
Returns:
the execution url