org.apache.commons.chain.web.servlet
Class ServletWebContext

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.servlet.ServletWebContext

All Implemented Interfaces:

Serializable, Cloneable, Map, Context

public class ServletWebContext
extends WebContext

Concrete implementation of WebContext suitable for use in Servlets and JSP pages. The abstract methods are mapped to the appropriate collections of the underlying servlet 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

AbstractMap.SimpleEntry, AbstractMap.SimpleImmutableEntry

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry

Field Summary

protected ServletContext	context The ServletContext for this web application.
protected HttpServletRequest	request The HttpServletRequest for this request.
protected HttpServletResponse	response The HttpServletResponse for this request.

Constructor Summary

ServletWebContext()
Construct an uninitialized ServletWebContext instance.

ServletWebContext(ServletContext context, HttpServletRequest request, HttpServletResponse response)
Construct a ServletWebContext instance that is initialized with the specified Servlet API objects.

Method Summary

Map	getApplicationScope() See the WebContext's Javadoc.
ServletContext	getContext() Return the ServletContext for this context.
Map	getCookies() See the WebContext's Javadoc.
Map	getHeader() See the WebContext's Javadoc.
Map	getHeaderValues() See the WebContext's Javadoc.
Map	getInitParam() See the WebContext's Javadoc.
Map	getParam() See the WebContext's Javadoc.
Map	getParamValues() See the WebContext's Javadoc.
HttpServletRequest	getRequest() Return the HttpServletRequest for this context.
Map	getRequestScope() See the WebContext's Javadoc.
HttpServletResponse	getResponse() Return the HttpServletResponse for this context.
Map	getSessionScope() See the WebContext's Javadoc.
void	initialize(ServletContext context, HttpServletRequest request, HttpServletResponse response) Initialize (or reinitialize) this ServletWebContext instance for the specified Servlet 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

protected ServletContext context

The ServletContext for this web application.

request

protected HttpServletRequest request

The HttpServletRequest for this request.

response

protected HttpServletResponse response

The HttpServletResponse for this request.

Constructor Detail

ServletWebContext

public ServletWebContext()

Construct an uninitialized ServletWebContext instance.

ServletWebContext

public ServletWebContext(ServletContext context,
                         HttpServletRequest request,
                         HttpServletResponse response)

Construct a ServletWebContext instance that is initialized with the specified Servlet API objects.

Parameters:

context - The ServletContext for this web application

request - The HttpServletRequest for this request

response - The HttpServletResponse for this request

Method Detail

getContext

public ServletContext getContext()

Return the ServletContext for this context.

Returns:

The ServletContext for this context.

getRequest

public HttpServletRequest getRequest()

Return the HttpServletRequest for this context.

Returns:

The HttpServletRequest for this context.

getResponse

public HttpServletResponse getResponse()

Return the HttpServletResponse for this context.

Returns:

The HttpServletResponse for this context.

initialize

public void initialize(ServletContext context,
                       HttpServletRequest request,
                       HttpServletResponse response)

Initialize (or reinitialize) this ServletWebContext instance for the specified Servlet API objects.

Parameters:

context - The ServletContext for this web application

request - The HttpServletRequest for this request

response - The HttpServletResponse 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()

See the WebContext's Javadoc.

Specified by:

getCookies in class WebContext

Returns:

Map of Cookies.

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.