|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--javax.servlet.ServletRequestWrapper
Wraps a servlet request in another request. Filters may use ServletRequestWrapper to modify the headers passed to the servlet.
The default methods just call the wrapped request methods.
Constructor Summary | |
ServletRequestWrapper(ServletRequest request)
Create a new ServletRequestWrapper wrapping the enclosed request. |
Method Summary | |
java.lang.Object |
getAttribute(java.lang.String name)
Returns an attribute value. |
java.util.Enumeration |
getAttributeNames()
Enumerates all attribute names in the request. |
java.lang.String |
getCharacterEncoding()
Returns the character encoding of the POSTed data. |
int |
getContentLength()
Returns the content length of the data. |
java.lang.String |
getContentType()
Returns the request's mime-type. |
ServletInputStream |
getInputStream()
Returns an InputStream to retrieve POST data from the request. |
java.util.Locale |
getLocale()
Returns the request's preferred locale. |
java.util.Enumeration |
getLocales()
Returns an enumeration of all locales acceptable by the client. |
java.lang.String |
getParameter(java.lang.String name)
Returns a form parameter. |
java.util.Enumeration |
getParameterNames()
Returns an enumeration of all form parameter names. |
java.lang.String[] |
getParameterValues(java.lang.String name)
Returns all values of a form parameter. |
java.lang.String |
getProtocol()
Returns the prococol, e.g. |
java.io.BufferedReader |
getReader()
Returns a reader to read POSTed data. |
java.lang.String |
getRealPath(java.lang.String uri)
Deprecated. |
java.lang.String |
getRemoteAddr()
Returns the IP address of the remote host, i.e. |
java.lang.String |
getRemoteHost()
Returns the DNS hostname of the remote host, i.e. |
ServletRequest |
getRequest()
Gets the request object being wrapped. |
RequestDispatcher |
getRequestDispatcher(java.lang.String uri)
Returns a request dispatcher for later inclusion or forwarding. |
java.lang.String |
getScheme()
Returns the request scheme, e.g. |
java.lang.String |
getServerName()
Returns the server name handling the request. |
int |
getServerPort()
Returns the server port handling the request, e.g. |
boolean |
isSecure()
Returns true if the connection is secure, e.g. |
void |
removeAttribute(java.lang.String name)
Removes the given attribute. |
void |
setAttribute(java.lang.String name,
java.lang.Object o)
Sets an attribute value. |
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)
Method Detail |
public void setRequest(ServletRequest request)
java.lang.IllegalArgumentException
- if the request is nullpublic ServletRequest getRequest()
public java.lang.String getProtocol()
getProtocol
in interface ServletRequest
public java.lang.String getScheme()
getScheme
in interface ServletRequest
public java.lang.String getServerName()
getServerName
in interface ServletRequest
public int getServerPort()
getServerPort
in interface ServletRequest
public java.lang.String getRemoteAddr()
getRemoteAddr
in interface ServletRequest
public java.lang.String getRemoteHost()
getRemoteHost
in interface ServletRequest
public java.lang.String getParameter(java.lang.String name)
getParameter
returns the first.
For example, calling getParameter("a")
with the
the query string a=1&a=2
will return "1".
getParameter
in interface ServletRequest
name
- the form parameter to returnpublic java.lang.String[] getParameterValues(java.lang.String name)
For example, calling getParameterValues("a")
with the the query string a=1&a=2
will
return ["1", "2"].
getParameterValues
in interface ServletRequest
name
- the form parameter to returnpublic java.util.Enumeration getParameterNames()
Enumeration e = request.getParameterNames();
while (e.hasMoreElements()) {
String name = (String) e.nextElement();
out.println(name + ": " + request.getParameter(name));
}
getParameterNames
in interface ServletRequest
public ServletInputStream getInputStream() throws java.io.IOException
getInputStream
in interface ServletRequest
public java.io.BufferedReader getReader() throws java.io.IOException, java.lang.IllegalStateException
getCharacterEncoding()
getReader
in interface ServletRequest
public java.lang.String getCharacterEncoding()
getCharacterEncoding
in interface ServletRequest
public int getContentLength()
The upshot is, rely on the input stream to end when the data completes.
getContentLength
in interface ServletRequest
public java.lang.String getContentType()
getContentType
in interface ServletRequest
public java.util.Locale getLocale()
getLocale
in interface ServletRequest
public java.util.Enumeration getLocales()
getLocales
in interface ServletRequest
public boolean isSecure()
isSecure
in interface ServletRequest
public java.lang.Object getAttribute(java.lang.String name)
getAttribute
in interface ServletRequest
name
- the attribute namepublic void setAttribute(java.lang.String name, java.lang.Object o)
setAttribute
in interface ServletRequest
name
- the attribute nameo
- the attribute valuepublic java.util.Enumeration getAttributeNames()
getAttributeNames
in interface ServletRequest
public void removeAttribute(java.lang.String name)
removeAttribute
in interface ServletRequest
name
- the attribute namepublic RequestDispatcher getRequestDispatcher(java.lang.String uri)
uri
is relative to the request URI. Absolute URIs are relative to
the application prefix (getContextPath()
).
If getRequestURI()
is /myapp/dir/test.jsp and the
uri
is "inc.jsp", the resulting page is
/myapp/dir/inc.jsp.
RequestDispatcher disp;
disp = getRequestDispatcher("inc.jsp?a=b");
disp.include(request, response);
getRequestDispatcher
in interface ServletRequest
uri
- path relative to getRequestURI()
(including query string) for the included file.public java.lang.String getRealPath(java.lang.String uri)
getRealPath
in interface ServletRequest
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |