Package org.apache.commons.chain.web.jakarta.servlet

Class ServletWebContext

java.lang.Object

java.util.AbstractMap<String,Object>

java.util.HashMap<String,Object>

org.apache.commons.chain.impl.ContextBase

org.apache.commons.chain.web.jakarta.WebContext

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

All Implemented Interfaces:

Serializable, Cloneable, Map<String,Object>, 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).

Author:

Craig R. McClanahan

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

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

Map.Entry<K,V>

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getApplicationScope()	See the WebContext's Javadoc.
jakarta.servlet.ServletContext	getContext()	Return the ServletContext for this context.
Map<String,jakarta.servlet.http.Cookie>	getCookies()	See the WebContext's Javadoc.
Map<String,String>	getHeader()	See the WebContext's Javadoc.
Map<String,String[]>	getHeaderValues()	See the WebContext's Javadoc.
Map<String,String>	getInitParam()	See the WebContext's Javadoc.
Map<String,String>	getParam()	See the WebContext's Javadoc.
Map<String,String[]>	getParamValues()	See the WebContext's Javadoc.
jakarta.servlet.http.HttpServletRequest	getRequest()	Return the HttpServletRequest for this context.
Map<String,Object>	getRequestScope()	See the WebContext's Javadoc.
jakarta.servlet.http.HttpServletResponse	getResponse()	Return the HttpServletResponse for this context.
Map<String,Object>	getSessionScope()	See the WebContext's Javadoc.
void	initialize(jakarta.servlet.ServletContext context, jakarta.servlet.http.HttpServletRequest request, jakarta.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, compute, computeIfAbsent, computeIfPresent, containsKey, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll, 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

compute, computeIfAbsent, computeIfPresent, containsKey, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll, size

Constructor Details

ServletWebContext

public ServletWebContext()

Construct an uninitialized ServletWebContext instance.

ServletWebContext

public ServletWebContext(jakarta.servlet.ServletContext context,
 jakarta.servlet.http.HttpServletRequest request,
 jakarta.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 Details

getContext

public jakarta.servlet.ServletContext getContext()

Return the ServletContext for this context.

Returns:

The ServletContext for this context.

getRequest

public jakarta.servlet.http.HttpServletRequest getRequest()

Return the HttpServletRequest for this context.

Returns:

The HttpServletRequest for this context.

getResponse

public jakarta.servlet.http.HttpServletResponse getResponse()

Return the HttpServletResponse for this context.

Returns:

The HttpServletResponse for this context.

initialize

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

See the WebContext's Javadoc.

Specified by:

getApplicationScope in class WebContext

Returns:

Application scope Map.

getHeader

public Map<String,String> getHeader()

See the WebContext's Javadoc.

Specified by:

getHeader in class WebContext

Returns:

Header values Map.

getHeaderValues

public Map<String,String[]> getHeaderValues()

See the WebContext's Javadoc.

Specified by:

getHeaderValues in class WebContext

Returns:

Header values Map.

getInitParam

public Map<String,String> getInitParam()

See the WebContext's Javadoc.

Specified by:

getInitParam in class WebContext

Returns:

Initialization parameter Map.

getParam

public Map<String,String> getParam()

See the WebContext's Javadoc.

Specified by:

getParam in class WebContext

Returns:

Request parameter Map.

getParamValues

public Map<String,String[]> getParamValues()

See the WebContext's Javadoc.

Specified by:

getParamValues in class WebContext

Returns:

Request parameter Map.

getCookies

public Map<String,jakarta.servlet.http.Cookie> getCookies()

See the WebContext's Javadoc.

Specified by:

getCookies in class WebContext

Returns:

Map of Cookies.

Since:

Chain 1.1

getRequestScope

public Map<String,Object> getRequestScope()

See the WebContext's Javadoc.

Specified by:

getRequestScope in class WebContext

Returns:

Request scope Map.

getSessionScope

public Map<String,Object> getSessionScope()

See the WebContext's Javadoc.

Specified by:

getSessionScope in class WebContext

Returns:

Session scope Map.