File	Doc	Category	Size	Date	Package
Request.java	API Doc	Glassfish v2 API	11153	Fri May 04 22:31:52 BST 2007	org.apache.catalina

Request

Fields Summary

Constructors Summary

Methods Summary
public javax.servlet.ServletInputStream	createInputStream() Create and return a ServletInputStream to read the content associated with this Request. exception IOException if an input/output error occurs
public void	finishRequest() Perform whatever actions are required to flush and close the input stream or reader, in a single operation. exception IOException if an input/output error occurs
public java.lang.String	getAuthorization() Return the authorization credentials sent with this request.
public boolean	getCheckRestrictedResources() Return whether or not access to resources under WEB-INF or META-INF needs to be checked.
public Connector	getConnector() Return the Connector through which this Request was received.
public Context	getContext() Return the Context within which this Request is being processed.
public javax.servlet.FilterChain	getFilterChain() Get filter chain associated with the request.
public Host	getHost() Return the Host within which this Request is being processed.
public java.lang.String	getInfo() Return descriptive information about this Request implementation and the corresponding version number, in the format <description>/<version>.
public java.lang.String	getJrouteId() Gets the jroute id of this request, which may have been sent as a separate JROUTE cookie or appended to the session identifier encoded in the URI (if cookies have been disabled). return The jroute id of this request, or null if this request does not carry any jroute id
public 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. param name Name of the note to be returned
public java.util.Iterator	getNoteNames() Return an Iterator containing the String names of all notes bindings that exist for this request.
public javax.servlet.ServletRequest	getRequest() Return the ServletRequest for which this object is the facade.
public Response	getResponse() Return the Response with which this Request is associated.
public java.net.Socket	getSocket() Return the Socket (if any) through which this Request was received. This should only be used to access underlying state information about this Socket, such as the SSLSession associated with an SSLSocket.
public java.io.InputStream	getStream() Return the input stream associated with this Request.
public ValveContext	getValveContext() Get valve context.
public Wrapper	getWrapper() Return the Wrapper within which this Request is being processed.
public void	recycle() Release all object references, and initialize instance variables, in preparation for reuse of this object.
public void	removeNote(java.lang.String name) Remove any object bound to the specified name in the internal notes for this request. param name Name of the note to be removed
public void	setAuthorization(java.lang.String authorization) Set the authorization credentials sent with this request. param authorization The new authorization credentials
public void	setCheckRestrictedResources(boolean check) Set whether or not access to resources under WEB-INF or META-INF needs to be checked.
public void	setConnector(Connector connector) Set the Connector through which this Request was received. param connector The new connector
public void	setContentLength(int length) Set the content length associated with this Request. param length The new content length
public void	setContentType(java.lang.String type) Set the content type (and optionally the character encoding) associated with this Request. For example, text/html; charset=ISO-8859-4. param type The new content type
public void	setContext(Context context) Set the Context within which this Request is being processed. This must be called as soon as the appropriate Context is identified, because it identifies the value to be returned by getContextPath(), and thus enables parsing of the request URI. param context The newly associated Context
public void	setFilterChain(javax.servlet.FilterChain filterChain) Set filter chain associated with the request. param filterChain new filter chain
public void	setHost(Host host) Set the Host within which this Request is being processed. This must be called as soon as the appropriate Host is identified, and before the Request is passed to a context. param host The newly associated Host
public 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. param name Name to which the object should be bound param value Object to be bound to the specified name
public void	setProtocol(java.lang.String protocol) Set the protocol name and version associated with this Request. param protocol Protocol name and version
public void	setRemoteAddr(java.lang.String remote) Set the remote IP address associated with this Request. NOTE: This value will be used to resolve the value for getRemoteHost() if that method is called. param remote The remote IP address
public void	setResponse(Response response) Set the Response with which this Request is associated. param response The new associated response
public void	setScheme(java.lang.String scheme) Set the name of the scheme associated with this request. Typical values are http, https, and ftp. param scheme The scheme
public void	setSecure(boolean secure) Set the value to be returned by isSecure() for this Request. param secure The new isSecure value
public void	setServerName(java.lang.String name) Set the name of the server (virtual host) to process this request. param name The server name
public void	setServerPort(int port) Set the port number of the server to process this request. param port The server port
public void	setSocket(java.net.Socket socket) Set the Socket (if any) through which this Request was received. param socket The socket through which this request was received
public void	setStream(java.io.InputStream stream) Set the input stream associated with this Request. param stream The new input stream
public void	setValveContext(ValveContext valveContext) Set valve context. param valveContext New valve context object
public void	setWrapper(Wrapper wrapper) Set the Wrapper within which this Request is being processed. This must be called as soon as the appropriate Wrapper is identified, and before the Request is ultimately passed to an application servlet. param wrapper The newly associated Wrapper