HttpRequest (Catalina Internal API Documentation)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.catalina
Interface HttpRequest

All Superinterfaces:: Request

All Known Implementing Classes:: HttpRequestBase, HttpRequestWrapper

public interface HttpRequest
extends Request

An HttpRequest is the Catalina internal facade for an HttpServletRequest that is to be processed, in order to produce the corresponding HttpResponse.

Version:: $Revision: 1.4 $ $Date: 2001/08/01 03:04:04 $
Author:: Craig R. McClanahan

Method Summary

void addCookie(javax.servlet.http.Cookie cookie)
          Add a Cookie to the set of Cookies associated with this Request.

void addHeader(java.lang.String name, java.lang.String value)
          Add a Header to the set of Headers associated with this Request.

void addLocale(java.util.Locale locale)
          Add a Locale to the set of preferred Locales for this Request.

void addParameter(java.lang.String name, java.lang.String[] values)
          Add a parameter name and corresponding set of values to this Request.

void clearCookies()
          Clear the collection of Cookies associated with this Request.

void clearHeaders()
          Clear the collection of Headers associated with this Request.

void clearLocales()
          Clear the collection of Locales associated with this Request.

void clearParameters()
          Clear the collection of parameters associated with this Request.

void setAuthType(java.lang.String type)
          Set the authentication type used for this request, if any; otherwise set the type to null.

void setContextPath(java.lang.String path)
          Set the context path for this Request.

void setMethod(java.lang.String method)
          Set the HTTP request method used for this Request.

void setPathInfo(java.lang.String path)
          Set the path information for this Request.

void setQueryString(java.lang.String query)
          Set the query string for this Request.

void setRequestedSessionCookie(boolean flag)
          Set a flag indicating whether or not the requested session ID for this request came in through a cookie.

void setRequestedSessionId(java.lang.String id)
          Set the requested session ID for this request.

void setRequestedSessionURL(boolean flag)
          Set a flag indicating whether or not the requested session ID for this request came in through a URL.

void setRequestURI(java.lang.String uri)
          Set the unparsed request URI for this Request.

void setServletPath(java.lang.String path)
          Set the servlet path for this Request.

void setUserPrincipal(java.security.Principal principal)
          Set the Principal who has been authenticated for this Request.

Methods inherited from interface org.apache.catalina.Request

createInputStream, finishRequest, getAuthorization, getConnector, getContext, getInfo, getNote, getNoteNames, getRequest, getResponse, getSocket, getStream, getWrapper, recycle, removeNote, setAuthorization, setConnector, setContentLength, setContentType, setContext, setNote, setProtocol, setRemoteAddr, setResponse, setScheme, setSecure, setServerName, setServerPort, setSocket, setStream, setWrapper

Method Detail

addCookie


public void addCookie(javax.servlet.http.Cookie cookie)

Add a Cookie to the set of Cookies associated with this Request.

Parameters:: cookie - The new cookie

addHeader


public void addHeader(java.lang.String name,
                      java.lang.String value)

Add a Header to the set of Headers associated with this Request.

Parameters:: name - The new header name; value - The new header value

addLocale


public void addLocale(java.util.Locale locale)

Add a Locale to the set of preferred Locales for this Request. The first added Locale will be the first one returned by getLocales().

Parameters:: locale - The new preferred Locale

addParameter


public void addParameter(java.lang.String name,
                         java.lang.String[] values)

Add a parameter name and corresponding set of values to this Request. (This is used when restoring the original request on a form based login).

Parameters:: name - Name of this request parameter; values - Corresponding values for this request parameter

clearCookies


public void clearCookies()

Clear the collection of Cookies associated with this Request.

clearHeaders


public void clearHeaders()

Clear the collection of Headers associated with this Request.

clearLocales


public void clearLocales()

Clear the collection of Locales associated with this Request.

clearParameters


public void clearParameters()

Clear the collection of parameters associated with this Request.

setAuthType


public void setAuthType(java.lang.String type)

Set the authentication type used for this request, if any; otherwise set the type to null. Typical values are "BASIC", "DIGEST", or "SSL".

Parameters:: type - The authentication type used

setContextPath


public void setContextPath(java.lang.String path)

Set the context path for this Request. This will normally be called when the associated Context is mapping the Request to a particular Wrapper.

Parameters:: path - The context path

setMethod


public void setMethod(java.lang.String method)

Set the HTTP request method used for this Request.

Parameters:: method - The request method

setQueryString


public void setQueryString(java.lang.String query)

Set the query string for this Request. This will normally be called by the HTTP Connector, when it parses the request headers.

Parameters:: query - The query string

setPathInfo


public void setPathInfo(java.lang.String path)

Set the path information for this Request. This will normally be called when the associated Context is mapping the Request to a particular Wrapper.

Parameters:: path - The path information

setRequestedSessionCookie


public void setRequestedSessionCookie(boolean flag)

Set a flag indicating whether or not the requested session ID for this request came in through a cookie. This is normally called by the HTTP Connector, when it parses the request headers.

Parameters:: flag - The new flag

setRequestedSessionId


public void setRequestedSessionId(java.lang.String id)

Set the requested session ID for this request. This is normally called by the HTTP Connector, when it parses the request headers.

Parameters:: id - The new session id

setRequestedSessionURL


public void setRequestedSessionURL(boolean flag)

Set a flag indicating whether or not the requested session ID for this request came in through a URL. This is normally called by the HTTP Connector, when it parses the request headers.

Parameters:: flag - The new flag

setRequestURI


public void setRequestURI(java.lang.String uri)

Set the unparsed request URI for this Request. This will normally be called by the HTTP Connector, when it parses the request headers.

Parameters:: uri - The request URI

setServletPath


public void setServletPath(java.lang.String path)

Set the servlet path for this Request. This will normally be called when the associated Context is mapping the Request to a particular Wrapper.

Parameters:: path - The servlet path

setUserPrincipal


public void setUserPrincipal(java.security.Principal principal)

Set the Principal who has been authenticated for this Request. This value is also used to calculate the value to be returned by the getRemoteUser() method.

Parameters:: principal - The user Principal