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

All Implemented Interfaces:
    Request

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

An HttpRequest is the Catalina internal facade for an HttpServletRequest that is to be processed, in order to produce the corresponding HttpResponse.
Method from org.apache.catalina.HttpRequest Summary:
addCookie,   addHeader,   addLocale,   addParameter,   clearCookies,   clearHeaders,   clearLocales,   clearParameters,   getContextPathMB,   getDecodedRequestURI,   getDecodedRequestURIMB,   getPathInfoMB,   getRequestPathMB,   getServletPathMB,   setAuthType,   setContextPath,   setDecodedRequestURI,   setMethod,   setPathInfo,   setQueryString,   setRequestURI,   setRequestedSessionCookie,   setRequestedSessionId,   setRequestedSessionURL,   setServletPath,   setUserPrincipal
Method from org.apache.catalina.HttpRequest Detail:
 public  void addCookie(Cookie cookie)
    Add a Cookie to the set of Cookies associated with this Request.
 public  void addHeader(String name,
    String value)
    Add a Header to the set of Headers associated with this Request.
 public  void addLocale(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().
 public  void addParameter(String name,
    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).
 public  void clearCookies()
    Clear the collection of Cookies associated with this Request.
 public  void clearHeaders()
    Clear the collection of Headers associated with this Request.
 public  void clearLocales()
    Clear the collection of Locales associated with this Request.
 public  void clearParameters()
    Clear the collection of parameters associated with this Request.
 public MessageBytes getContextPathMB()
    Get the context path.
 public String getDecodedRequestURI()
    Get the decoded request URI.
 public MessageBytes getDecodedRequestURIMB()
    Get the decoded request URI.
 public MessageBytes getPathInfoMB()
    Get the path info.
 public MessageBytes getRequestPathMB()
    Get the request path.
 public MessageBytes getServletPathMB()
    Get the servlet path.
 public  void setAuthType(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".
 public  void setContextPath(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.
 public  void setDecodedRequestURI(String uri)
    Set the decoded request URI.
 public  void setMethod(String method)
    Set the HTTP request method used for this Request.
 public  void setPathInfo(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.
 public  void setQueryString(String query)
    Set the query string for this Request. This will normally be called by the HTTP Connector, when it parses the request headers.
 public  void setRequestURI(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.
 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.
 public  void setRequestedSessionId(String id)
    Set the requested session ID for this request. This is normally called by the HTTP Connector, when it parses the request headers.
 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.
 public  void setServletPath(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.
 public  void setUserPrincipal(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.