|
Java EE 5 SDK | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectjavax.servlet.ServletRequestWrapper
public class ServletRequestWrapper
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.
ServletRequest| 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. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public ServletRequestWrapper(ServletRequest request)
IllegalArgumentException - if the request is null| Method Detail |
|---|
public ServletRequest getRequest()
public void setRequest(ServletRequest request)
IllegalArgumentException - if the request is null.public Object getAttribute(String name)
getAttribute in interface ServletRequestname - a String specifying the name of
the attribute
Object containing the value
of the attribute, or null if
the attribute does not existpublic Enumeration getAttributeNames()
getAttributeNames in interface ServletRequestEnumeration of strings
containing the names
of the request's attributespublic String getCharacterEncoding()
getCharacterEncoding in interface ServletRequestString containing the name of
the character encoding, or null
if the request does not specify a character encoding
public void setCharacterEncoding(String enc)
throws UnsupportedEncodingException
setCharacterEncoding in interface ServletRequestenc - 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 invalidpublic int getContentLength()
getContentLength in interface ServletRequestpublic String getContentType()
getContentType in interface ServletRequestString containing the name
of the MIME type of
the request, or null if the type is not known
public ServletInputStream getInputStream()
throws IOException
getInputStream in interface ServletRequestServletInputStream object containing
the body of the request
IOException - if an input or output exception occurredpublic String getParameter(String name)
getParameter in interface ServletRequestname - a String specifying the
name of the parameter
String representing the
single value of the parameterServletRequest.getParameterValues(java.lang.String)public Map getParameterMap()
getParameterMap in interface ServletRequestpublic Enumeration getParameterNames()
getParameterNames in interface ServletRequestEnumeration of String
objects, each String containing
the name of a request parameter; or an
empty Enumeration if the
request has no parameterspublic String[] getParameterValues(String name)
getParameterValues in interface ServletRequestname - a String containing the name of
the parameter whose value is requested
String objects
containing the parameter's valuesServletRequest.getParameter(java.lang.String)public String getProtocol()
getProtocol in interface ServletRequestString containing the protocol
name and version numberpublic String getScheme()
getScheme in interface ServletRequestString containing the name
of the scheme used to make this requestpublic String getServerName()
getServerName in interface ServletRequestString containing the name
of the serverpublic int getServerPort()
getServerPort in interface ServletRequest
public BufferedReader getReader()
throws IOException
getReader in interface ServletRequestBufferedReader
containing the body of the request
IOException - if an input or output exception occurredServletRequest.getInputStream()public String getRemoteAddr()
getRemoteAddr in interface ServletRequestString containing the
IP address of the client that sent the requestpublic String getRemoteHost()
getRemoteHost in interface ServletRequestString containing the fully
qualified name of the client
public void setAttribute(String name,
Object o)
setAttribute in interface ServletRequestname - a String specifying
the name of the attributeo - the Object to be storedpublic void removeAttribute(String name)
removeAttribute in interface ServletRequestname - a String specifying
the name of the attribute to removepublic Locale getLocale()
getLocale in interface ServletRequestLocale for the clientpublic Enumeration getLocales()
getLocales in interface ServletRequestEnumeration of preferred
Locale objects for the clientpublic boolean isSecure()
isSecure in interface ServletRequestpublic RequestDispatcher getRequestDispatcher(String path)
getRequestDispatcher in interface ServletRequestpath - a String specifying the pathname
to the resource. If it is relative, it must be
relative against the current servlet.
RequestDispatcher object
that acts as a wrapper for the resource
at the specified path, or null
if the servlet container cannot return a
RequestDispatcherRequestDispatcher,
ServletContext.getRequestDispatcher(java.lang.String)public String getRealPath(String path)
getRealPath in interface ServletRequestpublic int getRemotePort()
getRemotePort in interface ServletRequestpublic String getLocalName()
getLocalName in interface ServletRequestString containing the host
name of the IP on which the request was received.public String getLocalAddr()
getLocalAddr in interface ServletRequestString containing the
IP address on which the request was received.public int getLocalPort()
getLocalPort in interface ServletRequest
|
Java EE 5 SDK | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
Copyright 2006 Sun Microsystems, Inc. All rights reserved.