FlowIdMappingArgumentHandlerWrapper (Spring Web Flow 1.0.5 API)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.springframework.webflow.executor.support
Class FlowIdMappingArgumentHandlerWrapper

java.lang.Object
  org.springframework.webflow.executor.support.FlowExecutorArgumentHandler
      org.springframework.webflow.executor.support.FlowIdMappingArgumentHandlerWrapper

All Implemented Interfaces:: FlowExecutorArgumentExposer, FlowExecutorArgumentExtractor

public class FlowIdMappingArgumentHandlerWrapper
extends FlowExecutorArgumentHandler
extends FlowExecutorArgumentHandler

Flow executor argument handler that wraps another argument handler and applies a public to private flow id mapping. This can be used to avoid literal flow ids in URLs that launch flows.

For example, when used in combination with RequestPathFlowExecutorArgumentHandler the url http://localhost/springair/reservation/booking.html would launch a new execution of the booking-flow flow, assuming a context path of /springair, a servlet mapping of /reservation/* and a flow id mapping of booking->booking-flow (the .html suffix would be removed by RequestPathFlowExecutorArgumentHandler.extractFlowId(ExternalContext).

Since:: 1.0.2
Author:: Andrej Zachar, Erwin Vervaet
See Also:: RequestParameterFlowExecutorArgumentHandler, RequestPathFlowExecutorArgumentHandler

Constructor Summary
`FlowIdMappingArgumentHandlerWrapper()` Default constructor for bean style usage.

Method Summary
`void`	`addMapping(java.lang.String publicFlowId, java.lang.String privateFlowId)` Add a flow id mapping, overwriting any previous mapping for the same flow ids.
`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.
`FlowExecutorArgumentHandler`	`getArgumentHandler()` Returns the wrapped argument handler.
`protected java.util.Properties`	`getMappings()` Returns the public-to-private flow id mappings in use.
`boolean`	`isEventIdPresent(ExternalContext context)` Returns true if the event id is extractable from the context.
`boolean`	`isFallback()` Should we fall back to the flow id extracted by the wrapped argument handler if no mapping is defined for a flow id? Default is true.
`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`	`setArgumentHandler(FlowExecutorArgumentHandler argumentHandler)` Set the wrapped argument handler.
`void`	`setFallback(boolean fallback)` Set whether or not to fall back on the flow id extracted by the wrapped argument handler if no mapping is defined for a flow id.
`void`	`setMappings(java.util.Properties mappings)` Set the mappings between client-submitted flow identifiers and internal flow identifiers.

Methods inherited from class org.springframework.webflow.executor.support.FlowExecutorArgumentHandler
applyDefaultFlowId, encodeValue, exposeFlowExecutionContext, getDefaultFlowId, getEventIdArgumentName, getFlowExecutionContextAttributeName, getFlowExecutionKeyArgumentName, getFlowExecutionKeyAttributeName, getFlowIdArgumentName, getUrlEncodingScheme, isRedirectContextRelative, makeRedirectUrlContextRelativeIfNecessary, setDefaultFlowId, setEventIdArgumentName, setFlowExecutionContextAttributeName, setFlowExecutionKeyArgumentName, setFlowExecutionKeyAttributeName, setFlowIdArgumentName, setRedirectContextRelative, setUrlEncodingScheme

Methods inherited from class org.springframework.webflow.executor.support.FlowExecutorArgumentHandler

applyDefaultFlowId, encodeValue, exposeFlowExecutionContext, getDefaultFlowId, getEventIdArgumentName, getFlowExecutionContextAttributeName, getFlowExecutionKeyArgumentName, getFlowExecutionKeyAttributeName, getFlowIdArgumentName, getUrlEncodingScheme, isRedirectContextRelative, makeRedirectUrlContextRelativeIfNecessary, setDefaultFlowId, setEventIdArgumentName, setFlowExecutionContextAttributeName, setFlowExecutionKeyArgumentName, setFlowExecutionKeyAttributeName, setFlowIdArgumentName, setRedirectContextRelative, setUrlEncodingScheme

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

FlowIdMappingArgumentHandlerWrapper

public FlowIdMappingArgumentHandlerWrapper()

Default constructor for bean style usage.

See Also:: setArgumentHandler(FlowExecutorArgumentHandler), setMappings(Properties), setFallback(boolean)

Method Detail

getArgumentHandler

public FlowExecutorArgumentHandler getArgumentHandler()

Returns the wrapped argument handler.

setArgumentHandler

public void setArgumentHandler(FlowExecutorArgumentHandler argumentHandler)

Set the wrapped argument handler.

getMappings

protected java.util.Properties getMappings()

Returns the public-to-private flow id mappings in use.

setMappings

public void setMappings(java.util.Properties mappings)

Set the mappings between client-submitted flow identifiers and internal flow identifiers. Overwrites any previous mappings.

Parameters:: mappings - the public to private flow id mappings

addMapping

public void addMapping(java.lang.String publicFlowId,
                       java.lang.String privateFlowId)

Add a flow id mapping, overwriting any previous mapping for the same flow ids.

Parameters:: publicFlowId - how the flow will be identified publically (to web clients); privateFlowId - how the flow is identified internally (in the flow definition registry)

isFallback

public boolean isFallback()

Should we fall back to the flow id extracted by the wrapped argument handler if no mapping is defined for a flow id? Default is true.

setFallback

public void setFallback(boolean fallback)

Set whether or not to fall back on the flow id extracted by the wrapped argument handler if no mapping is defined for a flow id. Default is true. When false an exception is thrown when there is a mapping failure.