org.apache.commons.chain.web: abstract public class: WebContext

org.apache.commons.chain.web
abstract public class: WebContext [javadoc | source]

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

All Implemented Interfaces:
Context, Map, Serializable, Cloneable

Direct Known Subclasses:
ServletWebContext, FacesWebContext, PortletWebContext

Abstract base implementation of org.apache.commons.chain.Context that provides web based applications that use it a "generic" view of HTTP related requests and responses, without tying the application to a particular underlying Java API (such as servlets). It is expected that a concrete subclass of WebContext for each API (such as org.apache.commons.chain.web.servlet.ServletWebContext ) will support adapting that particular API's implementation of request and response objects into this generic framework.

The characteristics of a web request/response are made visible via a series of JavaBeans properties (and mapped to read-only attributes of the same name, as supported by ContextBase .

author: Craig - R. McClanahan

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

Method from org.apache.commons.chain.web.WebContext Summary:
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.WebContext Detail:
abstract public Map getApplicationScope() Return a mutable `Map` that maps application scope attribute names to their values.
abstract public Map getCookies() Return an immutable `Map` that maps cookie names to the set of cookies specified in the request.
abstract public Map getHeader() 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.
abstract public Map getHeaderValues() 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.
abstract public Map getInitParam() Return an immutable `Map` that maps context application initialization parameters to their values.
abstract public Map getParam() Return an immutable `Map` that maps request parameter names to the first (or only) value (as a String).
abstract public Map getParamValues() Return an immutable `Map` that maps request parameter names to the set of all values (as a String array).
abstract public Map getRequestScope() Return a mutable `Map` that maps request scope attribute names to their values.
abstract public Map getSessionScope() Return a mutable `Map` that maps session scope attribute names to their values.