javax.servlet

Class ServletRequestWrapper

public class ServletRequestWrapper extends Object implements ServletRequest

Provides a convenient implementation of the ServletRequest interface that can be subclassed by developers wishing to adapt the request to a Servlet. This class implements the Wrapper or Decorator pattern. Methods default to calling through to the wrapped request object.

Since: Servlet 2.3

Version: $Revision: 1.4 $ $Date: 2004/09/23 08:05:18 $

See Also:

Constructor Summary
	ServletRequestWrapper(ServletRequest request) Creates a ServletRequest adaptor wrapping the given request object.

Method Summary
Object	getAttribute(String name) The default behavior of this method is to call getAttribute(String name) on the wrapped request object.
Enumeration	getAttributeNames() The default behavior of this method is to return getAttributeNames() on the wrapped request object.
String	getCharacterEncoding() The default behavior of this method is to return getCharacterEncoding() on the wrapped request object.
int	getContentLength() The default behavior of this method is to return getContentLength() on the wrapped request object.
String	getContentType() The default behavior of this method is to return getContentType() on the wrapped request object.
ServletInputStream	getInputStream() The default behavior of this method is to return getInputStream() on the wrapped request object.
String	getLocalAddr() The default behavior of this method is to return getLocalAddr() on the wrapped request object.
Locale	getLocale() The default behavior of this method is to return getLocale() on the wrapped request object.
Enumeration	getLocales() The default behavior of this method is to return getLocales() on the wrapped request object.
String	getLocalName() The default behavior of this method is to return getLocalName() on the wrapped request object.
int	getLocalPort() The default behavior of this method is to return getLocalPort() on the wrapped request object.
String	getParameter(String name) The default behavior of this method is to return getParameter(String name) on the wrapped request object.
Map	getParameterMap() The default behavior of this method is to return getParameterMap() on the wrapped request object.
Enumeration	getParameterNames() The default behavior of this method is to return getParameterNames() on the wrapped request object.
String[]	getParameterValues(String name) The default behavior of this method is to return getParameterValues(String name) on the wrapped request object.
String	getProtocol() The default behavior of this method is to return getProtocol() on the wrapped request object.
BufferedReader	getReader() The default behavior of this method is to return getReader() on the wrapped request object.
String	getRealPath(String path) The default behavior of this method is to return getRealPath(String path) on the wrapped request object.
String	getRemoteAddr() The default behavior of this method is to return getRemoteAddr() on the wrapped request object.
String	getRemoteHost() The default behavior of this method is to return getRemoteHost() on the wrapped request object.
int	getRemotePort() The default behavior of this method is to return getRemotePort() on the wrapped request object.
ServletRequest	getRequest() Return the wrapped request object.
RequestDispatcher	getRequestDispatcher(String path) The default behavior of this method is to return getRequestDispatcher(String path) on the wrapped request object.
String	getScheme() The default behavior of this method is to return getScheme() on the wrapped request object.
String	getServerName() The default behavior of this method is to return getServerName() on the wrapped request object.
int	getServerPort() The default behavior of this method is to return getServerPort() on the wrapped request object.
boolean	isSecure() The default behavior of this method is to return isSecure() on the wrapped request object.
void	removeAttribute(String name) The default behavior of this method is to call removeAttribute(String name) on the wrapped request object.
void	setAttribute(String name, Object o) The default behavior of this method is to return setAttribute(String name, Object o) on the wrapped request object.
void	setCharacterEncoding(String enc) The default behavior of this method is to set the character encoding on the wrapped request object.
void	setRequest(ServletRequest request) Sets the request object being wrapped.

Constructor Detail

ServletRequestWrapper

public ServletRequestWrapper(ServletRequest request)

Creates a ServletRequest adaptor wrapping the given request object.

Throws: java.lang.IllegalArgumentException if the request is null

Method Detail

getAttribute

public Object getAttribute(String name)

The default behavior of this method is to call getAttribute(String name) on the wrapped request object.

getAttributeNames

public Enumeration getAttributeNames()

The default behavior of this method is to return getAttributeNames() on the wrapped request object.

getCharacterEncoding

public String getCharacterEncoding()

The default behavior of this method is to return getCharacterEncoding() on the wrapped request object.

getContentLength

public int getContentLength()

The default behavior of this method is to return getContentLength() on the wrapped request object.

getContentType

public String getContentType()

The default behavior of this method is to return getContentType() on the wrapped request object.

getInputStream

public ServletInputStream getInputStream()

The default behavior of this method is to return getInputStream() on the wrapped request object.

getLocalAddr

public String getLocalAddr()

The default behavior of this method is to return getLocalAddr() on the wrapped request object.

Since: Servlet 2.4

getLocale

public Locale getLocale()

The default behavior of this method is to return getLocale() on the wrapped request object.

getLocales

public Enumeration getLocales()

The default behavior of this method is to return getLocales() on the wrapped request object.

getLocalName

public String getLocalName()

The default behavior of this method is to return getLocalName() on the wrapped request object.

Since: Servlet 2.4

getLocalPort

public int getLocalPort()

The default behavior of this method is to return getLocalPort() on the wrapped request object.

Since: Servlet 2.4

getParameter

public String getParameter(String name)

The default behavior of this method is to return getParameter(String name) on the wrapped request object.

getParameterMap

public Map getParameterMap()

The default behavior of this method is to return getParameterMap() on the wrapped request object.

getParameterNames

public Enumeration getParameterNames()

The default behavior of this method is to return getParameterNames() on the wrapped request object.

getParameterValues

public String[] getParameterValues(String name)

The default behavior of this method is to return getParameterValues(String name) on the wrapped request object.

getProtocol

public String getProtocol()

The default behavior of this method is to return getProtocol() on the wrapped request object.

getReader

public BufferedReader getReader()

The default behavior of this method is to return getReader() on the wrapped request object.

getRealPath

public String getRealPath(String path)

The default behavior of this method is to return getRealPath(String path) on the wrapped request object.

getRemoteAddr

public String getRemoteAddr()

The default behavior of this method is to return getRemoteAddr() on the wrapped request object.

getRemoteHost

public String getRemoteHost()

The default behavior of this method is to return getRemoteHost() on the wrapped request object.

getRemotePort

public int getRemotePort()

The default behavior of this method is to return getRemotePort() on the wrapped request object.

Since: Servlet 2.4

Throws: java.lang.IllegalArgumentException if the request is null.