|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.springframework.webflow.executor.support.FlowExecutorArgumentHandler
org.springframework.webflow.executor.support.RequestParameterFlowExecutorArgumentHandler
public class RequestParameterFlowExecutorArgumentHandler
Default FlowExecutor
argument handler that extracts flow executor method arguments from the
ExternalContext.getRequestParameterMap()
and exposes arguments as URL encoded request parameters.
Constructor Summary | |
---|---|
RequestParameterFlowExecutorArgumentHandler()
|
Method Summary | |
---|---|
protected void |
appendFlowExecutorPath(java.lang.StringBuffer url,
ExternalContext context)
Append the URL path to the flow executor capable of accepting new requests. |
protected void |
appendQueryParameter(java.lang.StringBuffer url,
java.lang.Object key,
java.lang.Object value)
Appends a single query parameter to a URL. |
protected void |
appendQueryParameters(java.lang.StringBuffer url,
java.util.Map parameters)
Append query parameters to the redirect URL. |
java.lang.String |
createExternalUrl(ExternalRedirect redirect,
java.lang.String flowExecutionKey,
ExternalContext context)
Create a URL path that when redirected to communicates with an external system outside of Spring Web Flow. |
java.lang.String |
createFlowDefinitionUrl(FlowDefinitionRedirect flowDefinitionRedirect,
ExternalContext context)
Create a URL that when redirected to launches a entirely new execution of a flow definition (starts a new conversation). |
java.lang.String |
createFlowExecutionUrl(java.lang.String flowExecutionKey,
FlowExecutionContext flowExecution,
ExternalContext context)
Create a URL path that when redirected to renders the current (or last) view selection made by the flow execution identified by the flow execution key. |
java.lang.String |
extractEventId(ExternalContext context)
Extract the flow execution event id from the external context. |
java.lang.String |
extractFlowExecutionKey(ExternalContext context)
Extract the flow execution key from the external context. |
java.lang.String |
extractFlowId(ExternalContext context)
Extracts the flow id from the external context. |
protected java.lang.String |
findParameter(java.lang.String logicalParameterName,
ParameterMap parameters)
Obtain a named parameter from the request parameters. |
java.lang.String |
getParameterValueDelimiter()
Returns the delimiter used to parse a parameter value when a value is embedded in a parameter name (e.g. |
boolean |
isEventIdPresent(ExternalContext context)
Returns true if the event id is extractable from the context. |
boolean |
isFlowExecutionKeyPresent(ExternalContext context)
Returns true if the flow execution key is extractable from the context. |
boolean |
isFlowIdPresent(ExternalContext context)
Returns true if the flow id is extractable from the context. |
void |
setParameterValueDelimiter(java.lang.String parameterValueDelimiter)
Set the delimiter used to parse a parameter value when a value is embedded in a parameter name (e.g. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public RequestParameterFlowExecutorArgumentHandler()
Method Detail |
---|
public java.lang.String getParameterValueDelimiter()
public void setParameterValueDelimiter(java.lang.String parameterValueDelimiter)
public boolean isFlowIdPresent(ExternalContext context)
FlowExecutorArgumentExtractor
isFlowIdPresent
in interface FlowExecutorArgumentExtractor
isFlowIdPresent
in class FlowExecutorArgumentHandler
context
- the context in which a external user event occured
public java.lang.String extractFlowId(ExternalContext context) throws FlowExecutorArgumentExtractionException
FlowExecutorArgumentExtractor
extractFlowId
in interface FlowExecutorArgumentExtractor
extractFlowId
in class FlowExecutorArgumentHandler
context
- the context in which a external user event occured
FlowExecutorArgumentExtractionException
- if the flow id could not be extractedpublic boolean isFlowExecutionKeyPresent(ExternalContext context)
FlowExecutorArgumentExtractor
isFlowExecutionKeyPresent
in interface FlowExecutorArgumentExtractor
isFlowExecutionKeyPresent
in class FlowExecutorArgumentHandler
context
- the context in which a external user event occured
public java.lang.String extractFlowExecutionKey(ExternalContext context) throws FlowExecutorArgumentExtractionException
FlowExecutorArgumentExtractor
extractFlowExecutionKey
in interface FlowExecutorArgumentExtractor
extractFlowExecutionKey
in class FlowExecutorArgumentHandler
context
- the context in which the external user event occured
FlowExecutorArgumentExtractionException
- if the flow execution key could not be extractedpublic boolean isEventIdPresent(ExternalContext context)
FlowExecutorArgumentExtractor
isEventIdPresent
in interface FlowExecutorArgumentExtractor
isEventIdPresent
in class FlowExecutorArgumentHandler
context
- the context in which a external user event occured
public java.lang.String extractEventId(ExternalContext context) throws FlowExecutorArgumentExtractionException
FlowExecutorArgumentExtractor
This method should only be called if a FlowExecutionKey
was successfully extracted, indicating a request
to resume a flow execution.
extractEventId
in interface FlowExecutorArgumentExtractor
extractEventId
in class FlowExecutorArgumentHandler
context
- the context in which a external user event occured
FlowExecutorArgumentExtractionException
- if the event id could not be extractedprotected java.lang.String findParameter(java.lang.String logicalParameterName, ParameterMap parameters)
logicalParameterName
- the logical name of the request parameterparameters
- the available parameter map
null
if the parameter does not exist in given requestpublic java.lang.String createFlowDefinitionUrl(FlowDefinitionRedirect flowDefinitionRedirect, ExternalContext context)
FlowExecutorArgumentExposer
createFlowDefinitionUrl
in interface FlowExecutorArgumentExposer
createFlowDefinitionUrl
in class FlowExecutorArgumentHandler
flowDefinitionRedirect
- the flow definition redirect view selectioncontext
- the external context
public java.lang.String createFlowExecutionUrl(java.lang.String flowExecutionKey, FlowExecutionContext flowExecution, ExternalContext context)
FlowExecutorArgumentExposer
createFlowExecutionUrl
in interface FlowExecutorArgumentExposer
createFlowExecutionUrl
in class FlowExecutorArgumentHandler
flowExecutionKey
- the flow execution keyflowExecution
- the flow executioncontext
- the external context
FlowExecutionRedirect
public java.lang.String createExternalUrl(ExternalRedirect redirect, java.lang.String flowExecutionKey, ExternalContext context)
FlowExecutorArgumentExposer
createExternalUrl
in interface FlowExecutorArgumentExposer
createExternalUrl
in class FlowExecutorArgumentHandler
redirect
- the external redirect requestflowExecutionKey
- the flow execution key to send through the redirect (optional)context
- the external context
protected void appendFlowExecutorPath(java.lang.StringBuffer url, ExternalContext context)
url
- the url buffer to append tocontext
- the context of this requestprotected void appendQueryParameters(java.lang.StringBuffer url, java.util.Map parameters)
url
- the StringBuffer to append the parameters toparameters
- Map that contains attributesprotected void appendQueryParameter(java.lang.StringBuffer url, java.lang.Object key, java.lang.Object value)
url
- the target url to append tokey
- the parameter namevalue
- the parameter value
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |