org.apache.catalina.connector
クラス HttpRequestWrapper

java.lang.Object
  |
  +--org.apache.catalina.connector.RequestWrapper
        |
        +--org.apache.catalina.connector.HttpRequestWrapper
すべての実装インタフェース:
HttpRequest, Request

public abstract class HttpRequestWrapper
extends RequestWrapper
implements HttpRequest

Abstract convenience class that wraps a Catalina-internal HttpRequest object. By default, all methods are delegated to the wrapped request, but subclasses can override individual methods as required to provide the functionality that they require.

バージョン:
$Revision: 1.2 $ $Date: 2001/07/22 20:25:06 $
作成者:
Craig R. McClanahan

クラス org.apache.catalina.connector.RequestWrapper から継承したフィールド
request
 
コンストラクタの概要
HttpRequestWrapper(HttpRequest request)
          Construct a wrapper for the specified request.
 
メソッドの概要
 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 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 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.
 
クラス org.apache.catalina.connector.RequestWrapper から継承したメソッド
createInputStream, finishRequest, getAuthorization, getConnector, getContext, getInfo, getRequest, getResponse, getSocket, getStream, getWrappedRequest, getWrapper, recycle, setAuthorization, setConnector, setContentLength, setContentType, setContext, setProtocol, setRemoteAddr, setResponse, setScheme, setSecure, setServerName, setServerPort, setSocket, setStream, setWrapper
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
インタフェース org.apache.catalina.HttpRequest から継承したメソッド
addParameter, clearParameters
 
インタフェース 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
 

コンストラクタの詳細

HttpRequestWrapper

public HttpRequestWrapper(HttpRequest request)
Construct a wrapper for the specified request.
パラメータ:
request - The request to be wrapped
メソッドの詳細

addCookie

public void addCookie(javax.servlet.http.Cookie cookie)
Add a Cookie to the set of Cookies associated with this Request.
定義:
インタフェース HttpRequest 内の addCookie
パラメータ:
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.
定義:
インタフェース HttpRequest 内の addHeader
パラメータ:
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().
定義:
インタフェース HttpRequest 内の addLocale
パラメータ:
locale - The new preferred Locale

clearCookies

public void clearCookies()
Clear the collection of Cookies associated with this Request.
定義:
インタフェース HttpRequest 内の clearCookies

clearHeaders

public void clearHeaders()
Clear the collection of Headers associated with this Request.
定義:
インタフェース HttpRequest 内の clearHeaders

clearLocales

public void clearLocales()
Clear the collection of Locales associated with this Request.
定義:
インタフェース HttpRequest 内の clearLocales

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".
定義:
インタフェース HttpRequest 内の setAuthType
パラメータ:
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.
定義:
インタフェース HttpRequest 内の setContextPath
パラメータ:
path - The context path

setMethod

public void setMethod(java.lang.String method)
Set the HTTP request method used for this Request.
定義:
インタフェース HttpRequest 内の setMethod
パラメータ:
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.
定義:
インタフェース HttpRequest 内の setQueryString
パラメータ:
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.
定義:
インタフェース HttpRequest 内の setPathInfo
パラメータ:
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.
定義:
インタフェース HttpRequest 内の setRequestedSessionCookie
パラメータ:
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.
定義:
インタフェース HttpRequest 内の setRequestedSessionId
パラメータ:
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.
定義:
インタフェース HttpRequest 内の setRequestedSessionURL
パラメータ:
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.
定義:
インタフェース HttpRequest 内の setRequestURI
パラメータ:
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.
定義:
インタフェース HttpRequest 内の setServletPath
パラメータ:
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.
定義:
インタフェース HttpRequest 内の setUserPrincipal
パラメータ:
principal - The user Principal


Copyright ? 2000-2001 Apache Software Foundation. All Rights Reserved.