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:

Cloneable, Context, Map, Serializable

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: 1.5 $ $Date: 2004/02/25 00:01:04 $

Author:

Craig R. McClanahan

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class java.util.Map

Map.Entry

Field Summary

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

Constructor Summary

ServletWebContext()
Construct an uninitialized ServletWebContext instance.

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

Method Summary

Map	getApplicationScope() Return a mutable Map that maps application scope attribute names to their values.
javax.servlet.ServletContext	getContext() Return the ServletContext for this context.
Map	getHeader() Return an immutable Map that maps header names to the first (or only) header value (as a String).
Map	getHeaderValues() Return an immutable Map that maps header names to the set of all values specified in the request (as a String array).
Map	getInitParam() Return an immutable Map that maps context application initialization parameters to their values.
Map	getParam() Return an immutable Map that maps request parameter names to the first (or only) value (as a String).
Map	getParamValues() Return an immutable Map that maps request parameter names to the set of all values (as a String array).
javax.servlet.http.HttpServletRequest	getRequest() Return the HttpServletRequest for this context.
Map	getRequestScope() Return a mutable Map that maps request scope attribute names to their values.
javax.servlet.http.HttpServletResponse	getResponse() Return the HttpServletResponse for this context.
Map	getSessionScope() Return a mutable Map that maps session scope attribute names to their values.
void	initialize(javax.servlet.ServletContext context, javax.servlet.http.HttpServletRequest request, javax.servlet.http.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 javax.servlet.ServletContext context

The ServletContext for this web application.

request

protected javax.servlet.http.HttpServletRequest request

The HttpServletRequest for this request.

response

protected javax.servlet.http.HttpServletResponse response

The HttpServletResponse for this request.

Constructor Detail

ServletWebContext

public ServletWebContext()

Construct an uninitialized ServletWebContext instance.

ServletWebContext

public ServletWebContext(javax.servlet.ServletContext context,
                         javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.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 javax.servlet.ServletContext getContext()

Return the ServletContext for this context.

getRequest

public javax.servlet.http.HttpServletRequest getRequest()

Return the HttpServletRequest for this context.

getResponse

public javax.servlet.http.HttpServletResponse getResponse()

Return the HttpServletResponse for this context.

initialize

public void initialize(javax.servlet.ServletContext context,
                       javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.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()

Description copied from class: WebContext

Return a mutable Map that maps application scope attribute names to their values.

Specified by:

getApplicationScope in class WebContext

getHeader

public Map getHeader()

Description copied from class: WebContext

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.

Specified by:

getHeader in class WebContext

getHeaderValues

public Map getHeaderValues()

Description copied from class: WebContext

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.

Specified by:

getHeaderValues in class WebContext

getInitParam

public Map getInitParam()

Description copied from class: WebContext

Return an immutable Map that maps context application initialization parameters to their values.

Specified by:

getInitParam in class WebContext

getParam

public Map getParam()

Description copied from class: WebContext

Return an immutable Map that maps request parameter names to the first (or only) value (as a String).

Specified by:

getParam in class WebContext

getParamValues

public Map getParamValues()

Description copied from class: WebContext

Return an immutable Map that maps request parameter names to the set of all values (as a String array).

Specified by:

getParamValues in class WebContext

getRequestScope

public Map getRequestScope()

Description copied from class: WebContext

Return a mutable Map that maps request scope attribute names to their values.

Specified by:

getRequestScope in class WebContext

getSessionScope

public Map getSessionScope()

Description copied from class: WebContext

Return a mutable Map that maps session scope attribute names to their values.

Specified by:

getSessionScope in class WebContext