org.springframework.webflow.executor.jsf
Class JsfExternalContext

java.lang.Object
  org.springframework.webflow.executor.jsf.JsfExternalContext

All Implemented Interfaces:

ExternalContext

public class JsfExternalContext
extends java.lang.Object
implements ExternalContext

Provides contextual information about a JSF environment that has interacted with SWF.

Author:

Keith Donald

Constructor Summary

JsfExternalContext(javax.faces.context.FacesContext facesContext)
Creates a JSF External Context.

Method Summary

java.lang.String	getActionId() Returns the action identifier.
SharedAttributeMap	getApplicationMap() Provides access to the external application map, providing a storage for data local to the current user application and accessible to both internal and external SWF artifacts.
java.lang.String	getContextPath() Returns the path (or identifier) of the application that is executing.
java.lang.String	getDispatcherPath() Returns the path (or identifier) of the dispatcher within the application that dispatched this request.
javax.faces.context.FacesContext	getFacesContext() Returns the JSF FacesContext.
SharedAttributeMap	getGlobalSessionMap() Provides access to the global external session map, providing a storage for data globally accross the user session and accessible to both internal and external SWF artifacts.
java.lang.String	getOutcome() Returns the action outcome.
MutableAttributeMap	getRequestMap() Provides access to the external request attribute map, providing a storage for data local to the current user request and accessible to both internal and external SWF artifacts.
ParameterMap	getRequestParameterMap() Provides access to the parameters associated with the user request that led to SWF being called.
java.lang.String	getRequestPathInfo() Returns the path info of this external request.
SharedAttributeMap	getSessionMap() Provides access to the external session map, providing a storage for data local to the current user session and accessible to both internal and external SWF artifacts.
void	handleNavigationCalled(java.lang.String actionId, java.lang.String outcome) Records the action and outcome context information when navigation handling occurs.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

JsfExternalContext

public JsfExternalContext(javax.faces.context.FacesContext facesContext)

Creates a JSF External Context.

Parameters:

facesContext - the JSF faces context

Method Detail

getContextPath

public java.lang.String getContextPath()

Description copied from interface: ExternalContext

Returns the path (or identifier) of the application that is executing.

Specified by:

getContextPath in interface ExternalContext

Returns:

the application context path (e.g. "/myapp")

getDispatcherPath

public java.lang.String getDispatcherPath()

Description copied from interface: ExternalContext

Returns the path (or identifier) of the dispatcher within the application that dispatched this request.

Specified by:

getDispatcherPath in interface ExternalContext

Returns:

the dispatcher path (e.g. "/dispatcher")

getRequestPathInfo

public java.lang.String getRequestPathInfo()

Description copied from interface: ExternalContext

Returns the path info of this external request. Could be null.

Specified by:

getRequestPathInfo in interface ExternalContext

Returns:

the request path info (e.g. "/flows.htm")

getRequestParameterMap

public ParameterMap getRequestParameterMap()

Description copied from interface: ExternalContext

Provides access to the parameters associated with the user request that led to SWF being called. This map is expected to be immutable and cannot be changed.

Specified by:

getRequestParameterMap in interface ExternalContext

Returns:

the immutable request parameter map

getRequestMap

public MutableAttributeMap getRequestMap()

Description copied from interface: ExternalContext

Provides access to the external request attribute map, providing a storage for data local to the current user request and accessible to both internal and external SWF artifacts.

Specified by:

getRequestMap in interface ExternalContext

Returns:

the mutable request attribute map

getSessionMap

public SharedAttributeMap getSessionMap()

Description copied from interface: ExternalContext

Provides access to the external session map, providing a storage for data local to the current user session and accessible to both internal and external SWF artifacts.

Specified by:

getSessionMap in interface ExternalContext

Returns:

the mutable session attribute map

getGlobalSessionMap

public SharedAttributeMap getGlobalSessionMap()

Description copied from interface: ExternalContext

Provides access to the global external session map, providing a storage for data globally accross the user session and accessible to both internal and external SWF artifacts.

Note: most external context implementations do not distinguish between the concept of a "local" user session scope and a "global" session scope. The Portlet world does, but not the Servlet for example. In those cases calling this method returns the same map as calling ExternalContext.getSessionMap().

Specified by:

getGlobalSessionMap in interface ExternalContext

Returns:

the mutable global session attribute map

getApplicationMap

public SharedAttributeMap getApplicationMap()

Description copied from interface: ExternalContext

Provides access to the external application map, providing a storage for data local to the current user application and accessible to both internal and external SWF artifacts.

Specified by:

getApplicationMap in interface ExternalContext

Returns:

the mutable application attribute map

getFacesContext

public javax.faces.context.FacesContext getFacesContext()

Returns the JSF FacesContext.

getActionId

public java.lang.String getActionId()

Returns the action identifier.

getOutcome

public java.lang.String getOutcome()

Returns the action outcome.

handleNavigationCalled

public void handleNavigationCalled(java.lang.String actionId,
                                   java.lang.String outcome)

Records the action and outcome context information when navigation handling occurs.

Parameters:

actionId - the from action identifier

outcome - the action outcome

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object