org.springframework.webflow.executor.support
Interface FlowExecutorArgumentExtractor

All Known Implementing Classes:

FlowExecutorArgumentHandler, FlowIdMappingArgumentHandlerWrapper, FlowNavigationHandlerArgumentExtractor, RequestParameterFlowExecutorArgumentHandler, RequestPathFlowExecutorArgumentHandler

public interface FlowExecutorArgumentExtractor

A helper strategy used by the FlowRequestHandler to extract FlowExecutor method arguments from a request initiated by an ExternalContext. The extracted arguments were typically exposed in the previous response (the response that resulted in a new request) using a FlowExecutorArgumentExposer.

Author:

Keith Donald, Erwin Vervaet

Method Summary

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.
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.

Method Detail

isFlowIdPresent

boolean isFlowIdPresent(ExternalContext context)

Returns true if the flow id is extractable from the context.

Parameters:

context - the context in which a external user event occured

Returns:

true if extractable, false if not

extractFlowId

java.lang.String extractFlowId(ExternalContext context)
                               throws FlowExecutorArgumentExtractionException

Extracts the flow id from the external context.

Parameters:

context - the context in which a external user event occured

Returns:

the extracted flow id

Throws:

FlowExecutorArgumentExtractionException - if the flow id could not be extracted

isFlowExecutionKeyPresent

boolean isFlowExecutionKeyPresent(ExternalContext context)

Returns true if the flow execution key is extractable from the context.

Parameters:

context - the context in which a external user event occured

Returns:

true if extractable, false if not

extractFlowExecutionKey

java.lang.String extractFlowExecutionKey(ExternalContext context)
                                         throws FlowExecutorArgumentExtractionException

Extract the flow execution key from the external context.

Parameters:

context - the context in which the external user event occured

Returns:

the obtained flow execution key

Throws:

FlowExecutorArgumentExtractionException - if the flow execution key could not be extracted

isEventIdPresent

boolean isEventIdPresent(ExternalContext context)

Returns true if the event id is extractable from the context.

Parameters:

context - the context in which a external user event occured

Returns:

true if extractable, false if not

extractEventId

java.lang.String extractEventId(ExternalContext context)
                                throws FlowExecutorArgumentExtractionException

Extract the flow execution event id from the external context.

This method should only be called if a FlowExecutionKey was successfully extracted, indicating a request to resume a flow execution.

Parameters:

context - the context in which a external user event occured

Returns:

the event id

Throws:

FlowExecutorArgumentExtractionException - if the event id could not be extracted