Package org.apache.commons.chain.web.javax.faces

Class FacesWebContext

java.lang.Object

java.util.AbstractMap<String,Object>

java.util.HashMap<String,Object>

org.apache.commons.chain.impl.ContextBase

org.apache.commons.chain.web.javax.WebContext

org.apache.commons.chain.web.javax.faces.FacesWebContext

All Implemented Interfaces:

Serializable, Cloneable, Map<String,Object>, org.apache.commons.chain.Context

public class FacesWebContext
extends WebContext

Concrete implementation of WebContext suitable for use in JavaServer Faces apps. The abstract methods are mapped to the appropriate collections of the underlying FacesContext instance that is passed to the constructor (or the initialize method).

Version:

$Revision$ $Date$

Author:

Craig R. McClanahan

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor	Description
FacesWebContext()	Construct an uninitialized FacesWebContext instance.
FacesWebContext(FacesContext context)	Construct a FacesWebContext instance that is initialized with the specified JavaServer Faces API objects.

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getApplicationScope()	See the WebContext's Javadoc.
FacesContext	getContext()	Return the FacesContext instance for the request associated with this FacesWebContext.
Map<String,Cookie>	getCookies()	See the WebContext's Javadoc.
Map<String,String>	getHeader()	See the WebContext's Javadoc.
Map<String,String[]>	getHeaderValues()	See the WebContext's Javadoc.
Map<String,String>	getInitParam()	See the WebContext's Javadoc.
Map<String,String>	getParam()	See the WebContext's Javadoc.
Map<String,String[]>	getParamValues()	See the WebContext's Javadoc.
Map<String,Object>	getRequestScope()	See the WebContext's Javadoc.
Map<String,Object>	getSessionScope()	See the WebContext's Javadoc.
void	initialize(FacesContext context)	Initialize (or reinitialize) this FacesWebContext instance for the specified JavaServer Faces API objects.
void	release()	Release references to allocated resources acquired in initialize() of via subsequent processing.

Methods inherited from class org.apache.commons.chain.impl.ContextBase

clear, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, values

Methods inherited from class java.util.HashMap

clone, compute, computeIfAbsent, computeIfPresent, containsKey, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll, size

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, containsKey, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll, size

Constructor Details

FacesWebContext

public FacesWebContext()

Construct an uninitialized FacesWebContext instance.

FacesWebContext

public FacesWebContext(FacesContext context)

Construct a FacesWebContext instance that is initialized with the specified JavaServer Faces API objects.

Parameters:

context - The FacesContext for this request

Method Details

getContext

public FacesContext getContext()

Return the FacesContext instance for the request associated with this FacesWebContext.

Returns:

The FacesContext for this request

initialize

public void initialize(FacesContext context)

Initialize (or reinitialize) this FacesWebContext instance for the specified JavaServer Faces API objects.

Parameters:

context - The FacesContext for this request

release

public void release()

Release references to allocated resources acquired in initialize() of via subsequent processing. After this method is called, subsequent calls to any other method than initialize() will return undefined results.

getApplicationScope

public Map<String,Object> getApplicationScope()

See the WebContext's Javadoc.

Specified by:

getApplicationScope in class WebContext

Returns:

Application scope Map.

getHeader

public Map<String,String> getHeader()

See the WebContext's Javadoc.

Specified by:

getHeader in class WebContext

Returns:

Header values Map.

getHeaderValues

public Map<String,String[]> getHeaderValues()

See the WebContext's Javadoc.

Specified by:

getHeaderValues in class WebContext

Returns:

Header values Map.

getInitParam

public Map<String,String> getInitParam()

See the WebContext's Javadoc.

Specified by:

getInitParam in class WebContext

Returns:

Initialization parameter Map.

getParam

public Map<String,String> getParam()

See the WebContext's Javadoc.

Specified by:

getParam in class WebContext

Returns:

Request parameter Map.

getParamValues

public Map<String,String[]> getParamValues()

See the WebContext's Javadoc.

Specified by:

getParamValues in class WebContext

Returns:

Request parameter Map.

getCookies

public Map<String,Cookie> getCookies()

See the WebContext's Javadoc.

Specified by:

getCookies in class WebContext

Returns:

Map of Cookies.

Since:

Chain 1.1

getRequestScope

public Map<String,Object> getRequestScope()

See the WebContext's Javadoc.

Specified by:

getRequestScope in class WebContext

Returns:

Request scope Map.

getSessionScope

public Map<String,Object> getSessionScope()

See the WebContext's Javadoc.

Specified by:

getSessionScope in class WebContext

Returns:

Session scope Map.