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

java.lang.Object
  extended by java.util.AbstractMap<K,V>
      extended by java.util.HashMap
          extended by org.apache.commons.chain.impl.ContextBase
              extended by org.apache.commons.chain.web.WebContext
                  extended by org.apache.commons.chain.web.faces.FacesWebContext
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, java.util.Map, 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: 1.5 $ $Date: 2004/02/25 00:01:06 $
Author:
Craig R. McClanahan
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from interface java.util.Map
java.util.Map.Entry<K,V>
 
Field Summary
private  javax.faces.context.FacesContext context
          The FacesContext instance for the request represented by this WebContext.
 
Constructor Summary
FacesWebContext()
          Construct an uninitialized FacesWebContext instance.
FacesWebContext(javax.faces.context.FacesContext context)
          Construct a FacesWebContext instance that is initialized with the specified JavaServer Faces API objects.
 
Method Summary
 java.util.Map getApplicationScope()
          Return a mutable Map that maps application scope attribute names to their values.
 javax.faces.context.FacesContext getContext()
          Return the FacesContext instance for the request associated with this FacesWebContext.
 java.util.Map getHeader()
          Return an immutable Map that maps header names to the first (or only) header value (as a String).
 java.util.Map getHeaderValues()
          Return an immutable Map that maps header names to the set of all values specified in the request (as a String array).
 java.util.Map getInitParam()
          Return an immutable Map that maps context application initialization parameters to their values.
 java.util.Map getParam()
          Return an immutable Map that maps request parameter names to the first (or only) value (as a String).
 java.util.Map getParamValues()
          Return an immutable Map that maps request parameter names to the set of all values (as a String array).
 java.util.Map getRequestScope()
          Return a mutable Map that maps request scope attribute names to their values.
 java.util.Map getSessionScope()
          Return a mutable Map that maps session scope attribute names to their values.
 void initialize(javax.faces.context.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, containsKey, 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
containsKey, equals, hashCode, size
 

Field Detail

context

private javax.faces.context.FacesContext context

The FacesContext instance for the request represented by this WebContext.

Constructor Detail

FacesWebContext

public FacesWebContext()

Construct an uninitialized FacesWebContext instance.


FacesWebContext

public FacesWebContext(javax.faces.context.FacesContext context)

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

Parameters:
context - The FacesContext for this request
Method Detail

getContext

public javax.faces.context.FacesContext getContext()

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


initialize

public void initialize(javax.faces.context.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 java.util.Map getApplicationScope()
Description copied from class: WebContext

Return a mutable Map that maps application scope attribute names to their values.

Specified by:
getApplicationScope in class WebContext

getHeader

public java.util.Map getHeader()
Description copied from class: WebContext

Return an immutable Map that maps header names to the first (or only) header value (as a String). Header names must be matched in a case-insensitive manner.

Specified by:
getHeader in class WebContext

getHeaderValues

public java.util.Map getHeaderValues()
Description copied from class: WebContext

Return an immutable Map that maps header names to the set of all values specified in the request (as a String array). Header names must be matched in a case-insensitive manner.

Specified by:
getHeaderValues in class WebContext

getInitParam

public java.util.Map getInitParam()
Description copied from class: WebContext

Return an immutable Map that maps context application initialization parameters to their values.

Specified by:
getInitParam in class WebContext

getParam

public java.util.Map getParam()
Description copied from class: WebContext

Return an immutable Map that maps request parameter names to the first (or only) value (as a String).

Specified by:
getParam in class WebContext

getParamValues

public java.util.Map getParamValues()
Description copied from class: WebContext

Return an immutable Map that maps request parameter names to the set of all values (as a String array).

Specified by:
getParamValues in class WebContext

getRequestScope

public java.util.Map getRequestScope()
Description copied from class: WebContext

Return a mutable Map that maps request scope attribute names to their values.

Specified by:
getRequestScope in class WebContext

getSessionScope

public java.util.Map getSessionScope()
Description copied from class: WebContext

Return a mutable Map that maps session scope attribute names to their values.

Specified by:
getSessionScope in class WebContext