Class PortletWebContext

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.portlet.PortletWebContext
All Implemented Interfaces:
Serializable, Cloneable, Map, Context
public class PortletWebContext 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:

  • Field Details

    • applicationScope

      private Map applicationScope

      The lazily instantiated Map of application scope attributes.

    • context

      protected javax.portlet.PortletContext context

      The PortletContext for this web application.

    • headerValues

      private Map headerValues

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

    • initParam

      private Map initParam

      The lazily instantiated Map of context initialization parameters.

    • param

      private Map param

      The lazily instantiated Map of request parameter name-value.

    • paramValues

      private Map paramValues

      The lazily instantiated Map of request parameter name-values.

    • request

      protected javax.portlet.PortletRequest request

      The PortletRequest for this request.

    • requestScope

      private Map requestScope

      The lazily instantiated Map of request scope attributes.

    • response

      protected javax.portlet.PortletResponse response

      The PortletResponse for this request.

    • sessionScope

      private Map sessionScope

      The lazily instantiated Map of session scope attributes.

  • Constructor Details

    • PortletWebContext

      public PortletWebContext()

      Construct an uninitialized PortletWebContext instance.

    • PortletWebContext

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

      Parameters:
      context - The PortletContext for this web application
      request - The PortletRequest for this request
      response - The PortletResponse for this request

  • Method Details

    • getContext

      public javax.portlet.PortletContext getContext()

      Return the PortletContext for this context.

      Returns:
      The PortletContext for this request

    • getRequest

      public javax.portlet.PortletRequest getRequest()

      Return the PortletRequest for this context.

      Returns:
      The PortletRequest for this context.

    • getResponse

      public javax.portlet.PortletResponse getResponse()

      Return the PortletResponse for this context.

      Returns:
      The PortletResponse for this context.

    • initialize

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

      Parameters:
      context - The PortletContext for this web application
      request - The PortletRequest for this request
      response - The PortletResponse 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 getApplicationScope()
      See the WebContext's Javadoc.
      Specified by:
      getApplicationScope in class WebContext
      Returns:
      Application scope Map.

    • getHeader

      public Map getHeader()
      See the WebContext's Javadoc.
      Specified by:
      getHeader in class WebContext
      Returns:
      Header values Map.

    • getHeaderValues

      public Map getHeaderValues()
      See the WebContext's Javadoc.
      Specified by:
      getHeaderValues in class WebContext
      Returns:
      Header values Map.

    • getInitParam

      public Map getInitParam()
      See the WebContext's Javadoc.
      Specified by:
      getInitParam in class WebContext
      Returns:
      Initialization parameter Map.

    • getParam

      public Map getParam()
      See the WebContext's Javadoc.
      Specified by:
      getParam in class WebContext
      Returns:
      Request parameter Map.

    • getParamValues

      public Map getParamValues()
      See the WebContext's Javadoc.
      Specified by:
      getParamValues in class WebContext
      Returns:
      Request parameter Map.

    • getCookies

      public Map getCookies()
      Returns an empty Map - portlets don't support Cookies.
      Specified by:
      getCookies in class WebContext
      Returns:
      An empty Map.
      Since:
      Chain 1.1

    • getRequestScope

      public Map getRequestScope()
      See the WebContext's Javadoc.
      Specified by:
      getRequestScope in class WebContext
      Returns:
      Request scope Map.

    • getSessionScope

      public Map getSessionScope()
      See the WebContext's Javadoc.
      Specified by:
      getSessionScope in class WebContext
      Returns:
      Session scope Map.