FileDocCategorySizeDatePackage
Request.javaAPI DocGlassfish v2 API11153Fri May 04 22:31:52 BST 2007org.apache.catalina

Request

public interface Request
A Request is the Catalina-internal facade for a ServletRequest that is to be processed, in order to produce the corresponding Response.
author
Craig R. McClanahan
version
$Revision: 1.5 $ $Date: 2007/05/05 05:31:51 $

Fields Summary
Constructors Summary
Methods Summary
public javax.servlet.ServletInputStreamcreateInputStream()
Create and return a ServletInputStream to read the content associated with this Request.

exception
IOException if an input/output error occurs

public voidfinishRequest()
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.StringgetAuthorization()
Return the authorization credentials sent with this request.

public booleangetCheckRestrictedResources()
Return whether or not access to resources under WEB-INF or META-INF needs to be checked.

public ConnectorgetConnector()
Return the Connector through which this Request was received.

public ContextgetContext()
Return the Context within which this Request is being processed.

public javax.servlet.FilterChaingetFilterChain()
Get filter chain associated with the request.

public HostgetHost()
Return the Host within which this Request is being processed.

public java.lang.StringgetInfo()
Return descriptive information about this Request implementation and the corresponding version number, in the format <description>/<version>.

public java.lang.StringgetJrouteId()
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.ObjectgetNote(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.IteratorgetNoteNames()
Return an Iterator containing the String names of all notes bindings that exist for this request.

public javax.servlet.ServletRequestgetRequest()
Return the ServletRequest for which this object is the facade.

public ResponsegetResponse()
Return the Response with which this Request is associated.

public java.net.SocketgetSocket()
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.InputStreamgetStream()
Return the input stream associated with this Request.

public ValveContextgetValveContext()
Get valve context.

public WrappergetWrapper()
Return the Wrapper within which this Request is being processed.

public voidrecycle()
Release all object references, and initialize instance variables, in preparation for reuse of this object.

public voidremoveNote(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 voidsetAuthorization(java.lang.String authorization)
Set the authorization credentials sent with this request.

param
authorization The new authorization credentials

public voidsetCheckRestrictedResources(boolean check)
Set whether or not access to resources under WEB-INF or META-INF needs to be checked.

public voidsetConnector(Connector connector)
Set the Connector through which this Request was received.

param
connector The new connector

public voidsetContentLength(int length)
Set the content length associated with this Request.

param
length The new content length

public voidsetContentType(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 voidsetContext(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 voidsetFilterChain(javax.servlet.FilterChain filterChain)
Set filter chain associated with the request.

param
filterChain new filter chain

public voidsetHost(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 voidsetNote(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 voidsetProtocol(java.lang.String protocol)
Set the protocol name and version associated with this Request.

param
protocol Protocol name and version

public voidsetRemoteAddr(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 voidsetResponse(Response response)
Set the Response with which this Request is associated.

param
response The new associated response

public voidsetScheme(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 voidsetSecure(boolean secure)
Set the value to be returned by isSecure() for this Request.

param
secure The new isSecure value

public voidsetServerName(java.lang.String name)
Set the name of the server (virtual host) to process this request.

param
name The server name

public voidsetServerPort(int port)
Set the port number of the server to process this request.

param
port The server port

public voidsetSocket(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 voidsetStream(java.io.InputStream stream)
Set the input stream associated with this Request.

param
stream The new input stream

public voidsetValveContext(ValveContext valveContext)
Set valve context.

param
valveContext New valve context object

public voidsetWrapper(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