|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object | +--org.apache.catalina.connector.RequestWrapper
Abstract convenience class that wraps a Catalina-internal Request object. By default, all methods are delegated to the wrapped request, but subclasses can override individual methods as required to provide the functionality that they require.
| Field Summary | |
protected Request |
request
The wrapped request. |
| Constructor Summary | |
RequestWrapper(Request request)
Construct a wrapper for the specified request. |
|
| Method Summary | |
javax.servlet.ServletInputStream |
createInputStream()
Create and return a ServletInputStream to read the content associated with this Request. |
void |
finishRequest()
Perform whatever actions are required to flush and close the input stream or reader, in a single operation. |
java.lang.String |
getAuthorization()
Return the authorization credentials sent with this request. |
Connector |
getConnector()
Return the Connector through which this Request was received. |
Context |
getContext()
Return the Context within which this Request is being processed. |
java.lang.String |
getInfo()
Return descriptive information about this Request implementation and the corresponding version number, in the format <description>/<version>. |
javax.servlet.ServletRequest |
getRequest()
Return the ServletRequest for which this object
is the facade. |
Response |
getResponse()
Return the Response with which this Request is associated. |
java.net.Socket |
getSocket()
Return the Socket (if any) through which this Request was received. |
java.io.InputStream |
getStream()
Return the input stream associated with this Request. |
Request |
getWrappedRequest()
Return the wrapped request. |
Wrapper |
getWrapper()
Return the Wrapper within which this Request is being processed. |
void |
recycle()
Release all object references, and initialize instance variables, in preparation for reuse of this object. |
void |
setAuthorization(java.lang.String authorization)
Set the authorization credentials sent with this request. |
void |
setConnector(Connector connector)
Set the Connector through which this Request was received. |
void |
setContentLength(int length)
Set the content length associated with this Request. |
void |
setContentType(java.lang.String type)
Set the content type (and optionally the character encoding) associated with this Request. |
void |
setContext(Context context)
Set the Context within which this Request is being processed. |
void |
setProtocol(java.lang.String protocol)
Set the protocol name and version associated with this Request. |
void |
setRemoteAddr(java.lang.String remote)
Set the remote IP address associated with this Request. |
void |
setResponse(Response response)
Set the Response with which this Request is associated. |
void |
setScheme(java.lang.String scheme)
Set the name of the scheme associated with this request. |
void |
setSecure(boolean secure)
Set the value to be returned by isSecure()
for this Request. |
void |
setServerName(java.lang.String name)
Set the name of the server (virtual host) to process this request. |
void |
setServerPort(int port)
Set the port number of the server to process this request. |
void |
setSocket(java.net.Socket socket)
Set the Socket (if any) through which this Request was received. |
void |
setStream(java.io.InputStream stream)
Set the input stream associated with this Request. |
void |
setWrapper(Wrapper wrapper)
Set the Wrapper within which this Request is being processed. |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface org.apache.catalina.Request |
getNote, getNoteNames, removeNote, setNote |
| Field Detail |
protected Request request
| Constructor Detail |
public RequestWrapper(Request request)
request - The request to be wrapped| Method Detail |
public Request getWrappedRequest()
public java.lang.String getAuthorization()
getAuthorization in interface Requestpublic void setAuthorization(java.lang.String authorization)
setAuthorization in interface Requestauthorization - The new authorization credentialspublic Connector getConnector()
getConnector in interface Requestpublic void setConnector(Connector connector)
setConnector in interface Requestconnector - The new connectorpublic Context getContext()
getContext in interface Requestpublic void setContext(Context context)
getContextPath(),
and thus enables parsing of the request URI.setContext in interface Requestcontext - The newly associated Contextpublic java.lang.String getInfo()
<description>/<version>.getInfo in interface Requestpublic javax.servlet.ServletRequest getRequest()
ServletRequest for which this object
is the facade.getRequest in interface Requestpublic Response getResponse()
getResponse in interface Requestpublic void setResponse(Response response)
setResponse in interface Requestresponse - The new associated responsepublic java.net.Socket getSocket()
getSocket in interface Requestpublic void setSocket(java.net.Socket socket)
setSocket in interface Requestsocket - The socket through which this request was receivedpublic java.io.InputStream getStream()
getStream in interface Requestpublic void setStream(java.io.InputStream stream)
setStream in interface Requeststream - The new input streampublic Wrapper getWrapper()
getWrapper in interface Requestpublic void setWrapper(Wrapper wrapper)
setWrapper in interface Requestwrapper - The newly associated Wrapper
public javax.servlet.ServletInputStream createInputStream()
throws java.io.IOException
createInputStream in interface Requestjava.io.IOException - if an input/output error occurs
public void finishRequest()
throws java.io.IOException
finishRequest in interface Requestjava.io.IOException - if an input/output error occurspublic void recycle()
recycle in interface Requestpublic void setContentLength(int length)
setContentLength in interface Requestlength - The new content lengthpublic void setContentType(java.lang.String type)
text/html; charset=ISO-8859-4.setContentType in interface Requesttype - The new content typepublic void setProtocol(java.lang.String protocol)
setProtocol in interface Requestprotocol - Protocol name and versionpublic void setRemoteAddr(java.lang.String remote)
getRemoteHost()
if that method is called.setRemoteAddr in interface Requestremote - The remote IP addresspublic void setScheme(java.lang.String scheme)
http, https, and ftp.setScheme in interface Requestscheme - The schemepublic void setSecure(boolean secure)
isSecure()
for this Request.setSecure in interface Requestsecure - The new isSecure valuepublic void setServerName(java.lang.String name)
setServerName in interface Requestname - The server namepublic void setServerPort(int port)
setServerPort in interface Requestport - The server port
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||