org.apache.commons.chain.web.faces: public class: FacesWebContext

org.apache.commons.chain.web.faces
public class: FacesWebContext [javadoc | source]

java.lang.Object
   java.util.AbstractMap
      java.util.HashMap
         org.apache.commons.chain.impl.ContextBase
            org.apache.commons.chain.web.WebContext
               org.apache.commons.chain.web.faces.FacesWebContext

All Implemented Interfaces:
Context, Map, Serializable, Cloneable

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

author: Craig - R. McClanahan

version: $ - Revision: 480477 $ $Date: 2006-11-29 08:34:52 +0000 (Wed, 29 Nov 2006) $

Constructor:

Constructor:
public FacesWebContext() { } Construct an uninitialized FacesWebContext instance.
public FacesWebContext(FacesContext context) { initialize(context); } Construct a FacesWebContext instance that is initialized with the specified JavaServer Faces API objects. Parameters: `context` - The `FacesContext` for this request

 public FacesWebContext() {

}

Construct an uninitialized FacesWebContext instance.

 public FacesWebContext(FacesContext context) {
        initialize(context);
}

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

Parameters:

context - The FacesContext for this request

Method from org.apache.commons.chain.web.faces.FacesWebContext Summary:
getApplicationScope, getContext, getCookies, getHeader, getHeaderValues, getInitParam, getParam, getParamValues, getRequestScope, getSessionScope, initialize, release

Methods from org.apache.commons.chain.web.WebContext:
getApplicationScope, getCookies, getHeader, getHeaderValues, getInitParam, getParam, getParamValues, getRequestScope, getSessionScope

Methods from org.apache.commons.chain.impl.ContextBase:
clear, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, values

Methods from java.util.HashMap:
clear, clone, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values

Methods from java.util.AbstractMap:
clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, toString, values

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from org.apache.commons.chain.web.faces.FacesWebContext Detail:
public Map getApplicationScope() { return (context.getExternalContext().getApplicationMap()); } See the WebContext 's Javadoc.
public FacesContext getContext() { // ---------------------------------------------------------- Public Methods return (this.context); } Return the `FacesContext` instance for the request associated with this FacesWebContext .
public Map getCookies() { return (context.getExternalContext().getRequestCookieMap()); } See the WebContext 's Javadoc.
public Map getHeader() { return (context.getExternalContext().getRequestHeaderMap()); } See the WebContext 's Javadoc.
public Map getHeaderValues() { return (context.getExternalContext().getRequestHeaderValuesMap()); } See the WebContext 's Javadoc.
public Map getInitParam() { return (context.getExternalContext().getInitParameterMap()); } See the WebContext 's Javadoc.
public Map getParam() { return (context.getExternalContext().getRequestParameterMap()); } See the WebContext 's Javadoc.
public Map getParamValues() { return (context.getExternalContext().getRequestParameterValuesMap()); } See the WebContext 's Javadoc.
public Map getRequestScope() { return (context.getExternalContext().getRequestMap()); } See the WebContext 's Javadoc.
public Map getSessionScope() { return (context.getExternalContext().getSessionMap()); } See the WebContext 's Javadoc.
public void initialize(FacesContext context) { this.context = context; } Initialize (or reinitialize) this FacesWebContext instance for the specified JavaServer Faces API objects.
public void release() { context = null; } 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.

Method from org.apache.commons.chain.web.faces.FacesWebContext Detail:

 public Map getApplicationScope() {
    return (context.getExternalContext().getApplicationMap());
}

WebContext

 public FacesContext getContext() {
    // ---------------------------------------------------------- Public Methods
    return (this.context);
}

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

 public Map getCookies() {
        return (context.getExternalContext().getRequestCookieMap());
}

WebContext

 public Map getHeader() {
    return (context.getExternalContext().getRequestHeaderMap());
}

WebContext

 public Map getHeaderValues() {
    return (context.getExternalContext().getRequestHeaderValuesMap());
}

WebContext

 public Map getInitParam() {
    return (context.getExternalContext().getInitParameterMap());
}

WebContext

 public Map getParam() {
    return (context.getExternalContext().getRequestParameterMap());
}

WebContext

 public Map getParamValues() {
    return (context.getExternalContext().getRequestParameterValuesMap());
}

WebContext

 public Map getRequestScope() {
    return (context.getExternalContext().getRequestMap());
}

WebContext

 public Map getSessionScope() {
    return (context.getExternalContext().getSessionMap());
}

WebContext

 public  void initialize(FacesContext context) {
        this.context = context;
}

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

 public  void release() {
        context = null;
}

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.