ServletRequestWrapper

JavaServlet

previous page next page

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.servlet Class ServletRequestWrapper

java.lang.Object
  |
  +--javax.servlet.ServletRequestWrapper

Direct Known Subclasses:: HttpServletRequestWrapper

public class ServletRequestWrapper
extends java.lang.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:: v 2.3
See Also:: ServletRequest

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

Method Summary
`java.lang.Object`	`getAttribute(java.lang.String name)` The default behavior of this method is to call getAttribute(String name) on the wrapped request object.
`java.util.Enumeration`	`getAttributeNames()` The default behavior of this method is to return getAttributeNames() on the wrapped request object.
`java.lang.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.
`java.lang.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.
`java.util.Locale`	`getLocale()` The default behavior of this method is to return getLocale() on the wrapped request object.
`java.util.Enumeration`	`getLocales()` The default behavior of this method is to return getLocales() on the wrapped request object.
`java.lang.String`	`getParameter(java.lang.String name)` The default behavior of this method is to return getParameter(String name) on the wrapped request object.
`java.util.Map`	`getParameterMap()` The default behavior of this method is to return getParameterMap() on the wrapped request object.
`java.util.Enumeration`	`getParameterNames()` The default behavior of this method is to return getParameterNames() on the wrapped request object.
`java.lang.String[]`	`getParameterValues(java.lang.String name)` The default behavior of this method is to return getParameterValues(String name) on the wrapped request object.
`java.lang.String`	`getProtocol()` The default behavior of this method is to return getProtocol() on the wrapped request object.
`java.io.BufferedReader`	`getReader()` The default behavior of this method is to return getReader() on the wrapped request object.
`java.lang.String`	`getRealPath(java.lang.String path)` The default behavior of this method is to return getRealPath(String path) on the wrapped request object.
`java.lang.String`	`getRemoteAddr()` The default behavior of this method is to return getRemoteAddr() on the wrapped request object.
`java.lang.String`	`getRemoteHost()` The default behavior of this method is to return getRemoteHost() on the wrapped request object.
`ServletRequest`	`getRequest()` Return the wrapped request object.
`RequestDispatcher`	`getRequestDispatcher(java.lang.String path)` The default behavior of this method is to return getRequestDispatcher(String path) on the wrapped request object.
`java.lang.String`	`getScheme()` The default behavior of this method is to return getScheme() on the wrapped request object.
`java.lang.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(java.lang.String name)` The default behavior of this method is to call removeAttribute(String name) on the wrapped request object.
`void`	`setAttribute(java.lang.String name, java.lang.Object o)` The default behavior of this method is to return setAttribute(String name, Object o) on the wrapped request object.
`void`	`setCharacterEncoding(java.lang.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.

Methods inherited from class java.lang.Object

clone, 
equals, 
finalize, 
getClass, 
hashCode, 
notify, 
notifyAll, 
toString, 
wait, 
wait, 
wait

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

getRequest

public ServletRequest getRequest()

Return the wrapped request object.

setRequest

public void setRequest(ServletRequest request)

Sets the request object being wrapped.

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

getAttribute

public java.lang.Object getAttribute(java.lang.String name)

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

Specified by:: getAttribute in interface ServletRequest

getAttributeNames

public java.util.Enumeration getAttributeNames()

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

Specified by:: getAttributeNames in interface ServletRequest

getCharacterEncoding

public java.lang.String getCharacterEncoding()

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

Specified by:: getCharacterEncoding in interface ServletRequest

setCharacterEncoding

public void setCharacterEncoding(java.lang.String enc)
                          throws java.io.UnsupportedEncodingException

The default behavior of this method is to set the character encoding on the wrapped request object.

Specified by:: setCharacterEncoding in interface ServletRequest

getContentLength

public int getContentLength()

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

Specified by:: getContentLength in interface ServletRequest

getContentType

public java.lang.String getContentType()

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

Specified by:: getContentType in interface ServletRequest

getInputStream

public ServletInputStream getInputStream()
                                  throws java.io.IOException

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

Specified by:: getInputStream in interface ServletRequest

getParameter

public java.lang.String getParameter(java.lang.String name)

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

Specified by:: getParameter in interface ServletRequest

getParameterMap

public java.util.Map getParameterMap()

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

Specified by:: getParameterMap in interface ServletRequest

getParameterNames

public java.util.Enumeration getParameterNames()

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

Specified by:: getParameterNames in interface ServletRequest

getParameterValues

public java.lang.String[] getParameterValues(java.lang.String name)

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

Specified by:: getParameterValues in interface ServletRequest

getProtocol

public java.lang.String getProtocol()

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

Specified by:: getProtocol in interface ServletRequest

getScheme

public java.lang.String getScheme()

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

Specified by:: getScheme in interface ServletRequest

getServerName

public java.lang.String getServerName()

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

Specified by:: getServerName in interface ServletRequest

getServerPort

public int getServerPort()

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

Specified by:: getServerPort in interface ServletRequest

getReader

public java.io.BufferedReader getReader()
                                 throws java.io.IOException

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

Specified by:: getReader in interface ServletRequest

getRemoteAddr

public java.lang.String getRemoteAddr()

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

Specified by:: getRemoteAddr in interface ServletRequest

getRemoteHost

public java.lang.String getRemoteHost()

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

Specified by:: getRemoteHost in interface ServletRequest

setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.Object o)

The default behavior of this method is to return setAttribute(String name, Object o) on the wrapped request object.

Specified by:: setAttribute in interface ServletRequest

removeAttribute

public void removeAttribute(java.lang.String name)

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

Specified by:: removeAttribute in interface ServletRequest

getLocale

public java.util.Locale getLocale()

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

Specified by:: getLocale in interface ServletRequest

getLocales

public java.util.Enumeration getLocales()

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

Specified by:: getLocales in interface ServletRequest

isSecure

public boolean isSecure()

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

Specified by:: isSecure in interface ServletRequest

getRequestDispatcher

public RequestDispatcher getRequestDispatcher(java.lang.String path)

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

Specified by:: getRequestDispatcher in interface ServletRequest

getRealPath

public java.lang.String getRealPath(java.lang.String path)

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

Specified by:: getRealPath in interface ServletRequest