PortletWebContext

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.commons.chain.web.portlet
Class PortletWebContext

java.lang.Object
  java.util.AbstractMap<K,V>
      java.util.HashMap
          org.apache.commons.chain.impl.ContextBase
              org.apache.commons.chain.web.WebContext
                  org.apache.commons.chain.web.portlet.PortletWebContext

All Implemented Interfaces:: java.io.Serializable, java.lang.Cloneable, java.util.Map, Context

public class PortletWebContext
extends WebContext
extends WebContext

Concrete implementation of WebContext suitable for use in portlets. The abstract methods are mapped to the appropriate collections of the underlying portlet context, request, and response instances that are passed to the constructor (or the initialize method).

Version:: $Revision: 480477 $ $Date: 2006-11-29 08:34:52 +0000 (Wed, 29 Nov 2006) $
Author:: Craig R. McClanahan
See Also:: Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap
`java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>`

Nested classes/interfaces inherited from interface java.util.Map
`java.util.Map.Entry<K,V>`

Field Summary
`private java.util.Map`	`applicationScope` The lazily instantiated `Map` of application scope attributes.
`protected javax.portlet.PortletContext`	`context` The `PortletContext` for this web application.
`private java.util.Map`	`header` The lazily instantiated `Map` of header name-value combinations (immutable).
`private java.util.Map`	`headerValues` The lazily instantitated `Map` of header name-values combinations (immutable).
`private java.util.Map`	`initParam` The lazily instantiated `Map` of context initialization parameters.
`private java.util.Map`	`param` The lazily instantiated `Map` of request parameter name-value.
`private java.util.Map`	`paramValues` The lazily instantiated `Map` of request parameter name-values.
`protected javax.portlet.PortletRequest`	`request` The `PortletRequest` for this request.
`private java.util.Map`	`requestScope` The lazily instantiated `Map` of request scope attributes.
`protected javax.portlet.PortletResponse`	`response` The `PortletResponse` for this request.
`private java.util.Map`	`sessionScope` The lazily instantiated `Map` of session scope attributes.

Constructor Summary
`PortletWebContext()` Construct an uninitialized `PortletWebContext` instance.
`PortletWebContext(javax.portlet.PortletContext context, javax.portlet.PortletRequest request, javax.portlet.PortletResponse response)` Construct a `PortletWebContext` instance that is initialized with the specified Portlet API objects.

Method Summary
`java.util.Map`	`getApplicationScope()` See the `WebContext`'s Javadoc.
`javax.portlet.PortletContext`	`getContext()` Return the `PortletContext` for this context.
`java.util.Map`	`getCookies()` Returns an empty Map - portlets don't support Cookies.
`java.util.Map`	`getHeader()` See the `WebContext`'s Javadoc.
`java.util.Map`	`getHeaderValues()` See the `WebContext`'s Javadoc.
`java.util.Map`	`getInitParam()` See the `WebContext`'s Javadoc.
`java.util.Map`	`getParam()` See the `WebContext`'s Javadoc.
`java.util.Map`	`getParamValues()` See the `WebContext`'s Javadoc.
`javax.portlet.PortletRequest`	`getRequest()` Return the `PortletRequest` for this context.
`java.util.Map`	`getRequestScope()` See the `WebContext`'s Javadoc.
`javax.portlet.PortletResponse`	`getResponse()` Return the `PortletResponse` for this context.
`java.util.Map`	`getSessionScope()` See the `WebContext`'s Javadoc.
`void`	`initialize(javax.portlet.PortletContext context, javax.portlet.PortletRequest request, javax.portlet.PortletResponse response)` Initialize (or reinitialize) this `PortletWebContext` instance for the specified Portlet 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

applicationScope

private java.util.Map applicationScope

The lazily instantiated Map of application scope attributes.

context

protected javax.portlet.PortletContext context

The PortletContext for this web application.

header

private java.util.Map header

The lazily instantiated Map of header name-value combinations (immutable).

headerValues

private java.util.Map headerValues

The lazily instantitated Map of header name-values combinations (immutable).

initParam

private java.util.Map initParam

The lazily instantiated Map of context initialization parameters.

param

private java.util.Map param

The lazily instantiated Map of request parameter name-value.

paramValues

private java.util.Map paramValues

The lazily instantiated Map of request parameter name-values.

request

protected javax.portlet.PortletRequest request

The PortletRequest for this request.

requestScope

private java.util.Map requestScope

The lazily instantiated Map of request scope attributes.

response

protected javax.portlet.PortletResponse response

The PortletResponse for this request.

sessionScope

private java.util.Map sessionScope

The lazily instantiated Map of session scope attributes.

Constructor Detail