org.springframework.webflow.context.portlet

Class DefaultFlowUrlHandler

java.lang.Object

org.springframework.webflow.context.portlet.DefaultFlowUrlHandler

All Implemented Interfaces:

FlowUrlHandler

public class DefaultFlowUrlHandler
extends java.lang.Object
implements FlowUrlHandler

Default flow URL handler for SWF 2.

Author:

Scott Andrews

Constructor Summary

Constructors

Constructor and Description
DefaultFlowUrlHandler()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	createFlowExecutionUrl(java.lang.String flowId, java.lang.String flowExecutionKey, javax.portlet.RenderResponse response) Creates a flow execution URL during a render phase suitable to invoke Web Flow in a portlet environment
java.lang.String	createFlowExecutionUrl(java.lang.String flowId, java.lang.String flowExecutionKey, javax.portlet.ResourceResponse response) Creates a flow execution URL during a resource phase suitable to invoke Web Flow in a portlet environment
java.lang.String	getFlowExecutionKey(javax.portlet.PortletRequest request) Extract the flow execution from the request.
void	setFlowExecutionInSession(java.lang.String flowExecutionKey, javax.portlet.RenderRequest request) Set the flow execution key into the portlet session.
void	setFlowExecutionInSession(java.lang.String flowExecutionKey, javax.portlet.ResourceRequest request) Set the flow execution key into the portlet session.
void	setFlowExecutionRenderParameter(java.lang.String flowExecutionKey, javax.portlet.ActionResponse response) Set the flow execution key render parameter.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultFlowUrlHandler

public DefaultFlowUrlHandler()

Method Detail

getFlowExecutionKey

public java.lang.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(java.lang.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(java.lang.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 in a render request when the portlet is started before any action requests are made

Specified by:

setFlowExecutionInSession in interface FlowUrlHandler

Parameters:

flowExecutionKey - the key

request - the request

setFlowExecutionInSession

public void setFlowExecutionInSession(java.lang.String flowExecutionKey,
                             javax.portlet.ResourceRequest request)

Description copied from interface: FlowUrlHandler

Set the flow execution key into the portlet session. This should only be used in a resource request when the portlet is started before any action requests are made

Specified by:

setFlowExecutionInSession in interface FlowUrlHandler

Parameters:

flowExecutionKey - the key

request - the request

createFlowExecutionUrl

public java.lang.String createFlowExecutionUrl(java.lang.String flowId,
                                      java.lang.String flowExecutionKey,
                                      javax.portlet.RenderResponse response)

Description copied from interface: FlowUrlHandler

Creates a flow execution URL during a render phase suitable to invoke Web Flow in a portlet environment

Specified by:

createFlowExecutionUrl in interface FlowUrlHandler

Parameters:

flowId - the flow id

flowExecutionKey - the flow execution key

response - the response

Returns:

the execution url

createFlowExecutionUrl

public java.lang.String createFlowExecutionUrl(java.lang.String flowId,
                                      java.lang.String flowExecutionKey,
                                      javax.portlet.ResourceResponse response)

Description copied from interface: FlowUrlHandler

Creates a flow execution URL during a resource phase suitable to invoke Web Flow in a portlet environment

Specified by:

createFlowExecutionUrl in interface FlowUrlHandler

Parameters:

flowId - the flow id

flowExecutionKey - the flow execution key

response - the response

Returns:

the execution url