Save This Page
Home » glassfish-v2ur2-b04-src » org.apache » catalina » [javadoc | source]
org.apache.catalina
public interface: Request [javadoc | source]

All Known Implementing Classes:
    HttpRequestWrapper, CoyoteRequest, PwcCoyoteRequest, DummyRequest, CoyoteRequest, HttpRequest

A Request is the Catalina-internal facade for a ServletRequest that is to be processed, in order to produce the corresponding Response.
Method from org.apache.catalina.Request Summary:
createInputStream,   finishRequest,   getAuthorization,   getCheckRestrictedResources,   getConnector,   getContext,   getFilterChain,   getHost,   getInfo,   getJrouteId,   getNote,   getNoteNames,   getRequest,   getResponse,   getSocket,   getStream,   getValveContext,   getWrapper,   recycle,   removeNote,   setAuthorization,   setCheckRestrictedResources,   setConnector,   setContentLength,   setContentType,   setContext,   setFilterChain,   setHost,   setNote,   setProtocol,   setRemoteAddr,   setResponse,   setScheme,   setSecure,   setServerName,   setServerPort,   setSocket,   setStream,   setValveContext,   setWrapper
Method from org.apache.catalina.Request Detail:
 public ServletInputStream createInputStream() throws IOException
    Create and return a ServletInputStream to read the content associated with this Request.
 public  void finishRequest() throws IOException
    Perform whatever actions are required to flush and close the input stream or reader, in a single operation.
 public 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 FilterChain getFilterChain()
    Get filter chain associated with the request.
 public Host getHost()
    Return the Host within which this Request is being processed.
 public String getInfo()
    Return descriptive information about this Request implementation and the corresponding version number, in the format <description>/<version>.
 public 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).
 public Object getNote(String name)
    Return the object bound with the specified name to the internal notes for this request, or null if no such binding exists.
 public Iterator getNoteNames()
    Return an Iterator containing the String names of all notes bindings that exist for this request.
 public 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 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 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(String name)
    Remove any object bound to the specified name in the internal notes for this request.
 public  void setAuthorization(String authorization)
    Set the authorization credentials sent with this request.
 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.
 public  void setContentLength(int length)
    Set the content length associated with this Request.
 public  void setContentType(String type)
    Set the content type (and optionally the character encoding) associated with this Request. For example, text/html; charset=ISO-8859-4.
 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.
 public  void setFilterChain(FilterChain filterChain)
    Set filter chain associated with the request.
 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.
 public  void setNote(String name,
    Object value)
    Bind an object to a specified name in the internal notes associated with this request, replacing any existing binding for this name.
 public  void setProtocol(String protocol)
    Set the protocol name and version associated with this Request.
 public  void setRemoteAddr(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.
 public  void setResponse(Response response)
    Set the Response with which this Request is associated.
 public  void setScheme(String scheme)
    Set the name of the scheme associated with this request. Typical values are http, https, and ftp.
 public  void setSecure(boolean secure)
    Set the value to be returned by isSecure() for this Request.
 public  void setServerName(String name)
    Set the name of the server (virtual host) to process this request.
 public  void setServerPort(int port)
    Set the port number of the server to process this request.
 public  void setSocket(Socket socket)
    Set the Socket (if any) through which this Request was received.
 public  void setStream(InputStream stream)
    Set the input stream associated with this Request.
 public  void setValveContext(ValveContext valveContext)
    Set valve context.
 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.