ServletRequestWrapper (Java EE 5 SDK)

javax.servlet Class ServletRequestWrapper

java.lang.Object
  javax.servlet.ServletRequestWrapper

所有已实现的接口:

ServletRequest

直接已知子类:

HttpServletRequestWrapper

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.

从以下版本开始:

v 2.3

另请参见:

ServletRequest

ServletRequestWrapper

public ServletRequestWrapper(ServletRequest request)

Creates a ServletRequest adaptor wrapping the given request object.

抛出异常:

IllegalArgumentException - if the request is null

getRequest

public ServletRequest getRequest()

Return the wrapped request object.

setRequest

public void setRequest(ServletRequest request)

Sets the request object being wrapped.

抛出异常:

IllegalArgumentException - if the request is null.

getAttribute

public Object getAttribute(String name)

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

规范说明:

getAttribute in interface ServletRequest

参数:

name - a String specifying the name of the attribute

返回:

an Object containing the value of the attribute, or null if the attribute does not exist

getAttributeNames

public Enumeration getAttributeNames()

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

规范说明:

getAttributeNames in interface ServletRequest

返回:

an Enumeration of strings containing the names of the request's attributes

getCharacterEncoding

public String getCharacterEncoding()

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

规范说明:

getCharacterEncoding in interface ServletRequest

返回:

a String containing the name of the character encoding, or null if the request does not specify a character encoding

setCharacterEncoding

public void setCharacterEncoding(String enc)
                          throws UnsupportedEncodingException

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

规范说明:

setCharacterEncoding in interface ServletRequest

参数:

enc - String containing the name of the character encoding.

抛出异常:

UnsupportedEncodingException - if this ServletRequest is still in a state where a character encoding may be set, but the specified encoding is invalid

getContentLength

public int getContentLength()

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

规范说明:

getContentLength in interface ServletRequest

返回:

an integer containing the length of the request body or -1 if the length is not known

getContentType

public String getContentType()

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

规范说明:

getContentType in interface ServletRequest

返回:

a String containing the name of the MIME type of the request, or null if the type is not known

getInputStream

public ServletInputStream getInputStream()
                                  throws IOException

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

规范说明:

getInputStream in interface ServletRequest

返回:

a ServletInputStream object containing the body of the request

抛出异常:

IOException - if an input or output exception occurred

getParameter

public String getParameter(String name)

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

规范说明:

getParameter in interface ServletRequest

参数:

name - a String specifying the name of the parameter

返回:

a String representing the single value of the parameter

另请参见:

ServletRequest.getParameterValues(java.lang.String)

getParameterMap

public Map getParameterMap()

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

规范说明:

getParameterMap in interface ServletRequest

返回:

an immutable java.util.Map containing parameter names as keys and parameter values as map values. The keys in the parameter map are of type String. The values in the parameter map are of type String array.

getParameterNames

public Enumeration getParameterNames()

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

规范说明:

getParameterNames in interface ServletRequest

返回:

an Enumeration of String objects, each String containing the name of a request parameter; or an empty Enumeration if the request has no parameters

getParameterValues

public String[] getParameterValues(String name)

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

规范说明:

getParameterValues in interface ServletRequest

参数:

name - a String containing the name of the parameter whose value is requested

返回:

an array of String objects containing the parameter's values

另请参见:

ServletRequest.getParameter(java.lang.String)

getProtocol

public String getProtocol()

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

规范说明:

getProtocol in interface ServletRequest

返回:

a String containing the protocol name and version number

getScheme

public String getScheme()

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

规范说明:

getScheme in interface ServletRequest

返回:

a String containing the name of the scheme used to make this request

getServerName

public String getServerName()

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

规范说明:

getServerName in interface ServletRequest

返回:

a String containing the name of the server

getServerPort

public int getServerPort()

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

规范说明:

getServerPort in interface ServletRequest

返回:

an integer specifying the port number

getReader

public BufferedReader getReader()
                         throws IOException

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

规范说明:

getReader in interface ServletRequest

返回:

a BufferedReader containing the body of the request

抛出异常:

IOException - if an input or output exception occurred

另请参见:

ServletRequest.getInputStream()

getRemoteAddr

public String getRemoteAddr()

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

规范说明:

getRemoteAddr in interface ServletRequest

返回:

a String containing the IP address of the client that sent the request

getRemoteHost

public String getRemoteHost()

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

规范说明:

getRemoteHost in interface ServletRequest

返回:

a String containing the fully qualified name of the client

setAttribute

public 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.

规范说明:

setAttribute in interface ServletRequest

参数:

name - a String specifying the name of the attribute

o - the Object to be stored

removeAttribute

public void removeAttribute(String name)

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

规范说明:

removeAttribute in interface ServletRequest

参数:

name - a String specifying the name of the attribute to remove

getLocale

public Locale getLocale()

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

规范说明:

getLocale in interface ServletRequest

返回:

the preferred Locale for the client

getLocales

public Enumeration getLocales()

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

规范说明:

getLocales in interface ServletRequest

返回:

an Enumeration of preferred Locale objects for the client

isSecure

public boolean isSecure()

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

规范说明:

isSecure in interface ServletRequest

返回:

a boolean indicating if the request was made using a secure channel

getRequestDispatcher

public RequestDispatcher getRequestDispatcher(String path)

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

规范说明:

getRequestDispatcher in interface ServletRequest

参数:

path - a String specifying the pathname to the resource. If it is relative, it must be relative against the current servlet.

返回:

a RequestDispatcher object that acts as a wrapper for the resource at the specified path, or null if the servlet container cannot return a RequestDispatcher

另请参见:

RequestDispatcher, ServletContext.getRequestDispatcher(java.lang.String)

getRealPath

public String getRealPath(String path)

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

规范说明:

getRealPath in interface ServletRequest

getRemotePort

public int getRemotePort()

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

规范说明:

getRemotePort in interface ServletRequest

返回:

an integer specifying the port number

从以下版本开始:

2.4

getLocalName

public String getLocalName()

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

规范说明:

getLocalName in interface ServletRequest

返回:

a String containing the host name of the IP on which the request was received.

从以下版本开始:

2.4

getLocalAddr

public String getLocalAddr()

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

规范说明:

getLocalAddr in interface ServletRequest

返回:

a String containing the IP address on which the request was received.

从以下版本开始:

2.4

getLocalPort

public int getLocalPort()

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

规范说明:

getLocalPort in interface ServletRequest

返回:

an integer specifying the port number

从以下版本开始:

2.4

版权所有 2007 Sun Microsystems, Inc. 保留所有权利。 请遵守许可证条款。深圳电信培训中心.徐海蛟老师教学参考.