Request (Catalina Internal API Documentation)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A Request is the Catalina-internal facade for a
ServletRequest
that is to be processed, in order to
produce the corresponding Response
.
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> . |
java.lang.Object |
getNote(java.lang.String name)
Return the object bound with the specified name to the internal notes for this request, or null if no such binding exists. |
java.util.Iterator |
getNoteNames()
Return an Iterator containing the String names of all notes bindings that exist for this request. |
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. |
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 |
removeNote(java.lang.String name)
Remove any object bound to the specified name in the internal notes for this request. |
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 |
setNote(java.lang.String name,
java.lang.Object value)
Bind an object to a specified name in the internal notes associated with this request, replacing any existing binding for this name. |
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. |
Method Detail |
public java.lang.String getAuthorization()
public void setAuthorization(java.lang.String authorization)
authorization
- The new authorization credentialspublic Connector getConnector()
public void setConnector(Connector connector)
connector
- The new connectorpublic Context getContext()
public void setContext(Context context)
getContextPath()
,
and thus enables parsing of the request URI.
context
- The newly associated Contextpublic java.lang.String getInfo()
<description>/<version>
.
public javax.servlet.ServletRequest getRequest()
ServletRequest
for which this object
is the facade.
public Response getResponse()
public void setResponse(Response response)
response
- The new associated responsepublic java.net.Socket getSocket()
public void setSocket(java.net.Socket socket)
socket
- The socket through which this request was receivedpublic java.io.InputStream getStream()
public void setStream(java.io.InputStream stream)
stream
- The new input streampublic Wrapper getWrapper()
public void setWrapper(Wrapper wrapper)
wrapper
- The newly associated Wrapperpublic javax.servlet.ServletInputStream createInputStream() throws java.io.IOException
java.io.IOException
- if an input/output error occurspublic void finishRequest() throws java.io.IOException
java.io.IOException
- if an input/output error occurspublic java.lang.Object getNote(java.lang.String name)
null
if no such binding exists.
name
- Name of the note to be returnedpublic java.util.Iterator getNoteNames()
public void recycle()
public void removeNote(java.lang.String name)
name
- Name of the note to be removedpublic void setContentLength(int length)
length
- The new content lengthpublic void setContentType(java.lang.String type)
text/html; charset=ISO-8859-4
.
type
- The new content typepublic void setNote(java.lang.String name, java.lang.Object value)
name
- Name to which the object should be boundvalue
- Object to be bound to the specified namepublic void setProtocol(java.lang.String protocol)
protocol
- Protocol name and versionpublic void setRemoteAddr(java.lang.String remote)
getRemoteHost()
if that method is called.
remote
- The remote IP addresspublic void setScheme(java.lang.String scheme)
http
, https
, and ftp
.
scheme
- The schemepublic void setSecure(boolean secure)
isSecure()
for this Request.
secure
- The new isSecure valuepublic void setServerName(java.lang.String name)
name
- The server namepublic void setServerPort(int port)
port
- The server port
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |