org.apache.catalina.connector
クラス RequestWrapper

java.lang.Object
  |
  +--org.apache.catalina.connector.RequestWrapper
すべての実装インタフェース:
Request
直系の既知のサブクラス:
HttpRequestWrapper

public abstract class RequestWrapper
extends java.lang.Object
implements Request

Abstract convenience class that wraps a Catalina-internal Request 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.3 $ $Date: 2001/07/22 20:25:06 $
作成者:
Craig R. McClanahan

フィールドの概要
protected  Request request
          The wrapped request.
 
コンストラクタの概要
RequestWrapper(Request request)
          Construct a wrapper for the specified request.
 
メソッドの概要
 javax.servlet.ServletInputStream createInputStream()
          Create and return a ServletInputStream to read the content associated with this Request.
 void finishRequest()
          Perform whatever actions are required to flush and close the input stream or reader, in a single operation.
 java.lang.String getAuthorization()
          Return the authorization credentials sent with this request.
 Connector getConnector()
          Return the Connector through which this Request was received.
 Context getContext()
          Return the Context within which this Request is being processed.
 java.lang.String getInfo()
          Return descriptive information about this Request implementation and the corresponding version number, in the format <description>/<version>.
 javax.servlet.ServletRequest getRequest()
          Return the ServletRequest for which this object is the facade.
 Response getResponse()
          Return the Response with which this Request is associated.
 java.net.Socket getSocket()
          Return the Socket (if any) through which this Request was received.
 java.io.InputStream getStream()
          Return the input stream associated with this Request.
 Request getWrappedRequest()
          Return the wrapped request.
 Wrapper getWrapper()
          Return the Wrapper within which this Request is being processed.
 void recycle()
          Release all object references, and initialize instance variables, in preparation for reuse of this object.
 void setAuthorization(java.lang.String authorization)
          Set the authorization credentials sent with this request.
 void setConnector(Connector connector)
          Set the Connector through which this Request was received.
 void setContentLength(int length)
          Set the content length associated with this Request.
 void setContentType(java.lang.String type)
          Set the content type (and optionally the character encoding) associated with this Request.
 void setContext(Context context)
          Set the Context within which this Request is being processed.
 void setProtocol(java.lang.String protocol)
          Set the protocol name and version associated with this Request.
 void setRemoteAddr(java.lang.String remote)
          Set the remote IP address associated with this Request.
 void setResponse(Response response)
          Set the Response with which this Request is associated.
 void setScheme(java.lang.String scheme)
          Set the name of the scheme associated with this request.
 void setSecure(boolean secure)
          Set the value to be returned by isSecure() for this Request.
 void setServerName(java.lang.String name)
          Set the name of the server (virtual host) to process this request.
 void setServerPort(int port)
          Set the port number of the server to process this request.
 void setSocket(java.net.Socket socket)
          Set the Socket (if any) through which this Request was received.
 void setStream(java.io.InputStream stream)
          Set the input stream associated with this Request.
 void setWrapper(Wrapper wrapper)
          Set the Wrapper within which this Request is being processed.
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
インタフェース org.apache.catalina.Request から継承したメソッド
getNote, getNoteNames, removeNote, setNote
 

フィールドの詳細

request

protected Request request
The wrapped request.
コンストラクタの詳細

RequestWrapper

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

getWrappedRequest

public Request getWrappedRequest()
Return the wrapped request.

getAuthorization

public java.lang.String getAuthorization()
Return the authorization credentials sent with this request.
定義:
インタフェース Request 内の getAuthorization

setAuthorization

public void setAuthorization(java.lang.String authorization)
Set the authorization credentials sent with this request.
定義:
インタフェース Request 内の setAuthorization
パラメータ:
authorization - The new authorization credentials

getConnector

public Connector getConnector()
Return the Connector through which this Request was received.
定義:
インタフェース Request 内の getConnector

setConnector

public void setConnector(Connector connector)
Set the Connector through which this Request was received.
定義:
インタフェース Request 内の setConnector
パラメータ:
connector - The new connector

getContext

public Context getContext()
Return the Context within which this Request is being processed.
定義:
インタフェース Request 内の getContext

setContext

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.
定義:
インタフェース Request 内の setContext
パラメータ:
context - The newly associated Context

getInfo

public java.lang.String getInfo()
Return descriptive information about this Request implementation and the corresponding version number, in the format <description>/<version>.
定義:
インタフェース Request 内の getInfo

getRequest

public javax.servlet.ServletRequest getRequest()
Return the ServletRequest for which this object is the facade.
定義:
インタフェース Request 内の getRequest

getResponse

public Response getResponse()
Return the Response with which this Request is associated.
定義:
インタフェース Request 内の getResponse

setResponse

public void setResponse(Response response)
Set the Response with which this Request is associated.
定義:
インタフェース Request 内の setResponse
パラメータ:
response - The new associated response

getSocket

public java.net.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.
定義:
インタフェース Request 内の getSocket

setSocket

public void setSocket(java.net.Socket socket)
Set the Socket (if any) through which this Request was received.
定義:
インタフェース Request 内の setSocket
パラメータ:
socket - The socket through which this request was received

getStream

public java.io.InputStream getStream()
Return the input stream associated with this Request.
定義:
インタフェース Request 内の getStream

setStream

public void setStream(java.io.InputStream stream)
Set the input stream associated with this Request.
定義:
インタフェース Request 内の setStream
パラメータ:
stream - The new input stream

getWrapper

public Wrapper getWrapper()
Return the Wrapper within which this Request is being processed.
定義:
インタフェース Request 内の getWrapper

setWrapper

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.
定義:
インタフェース Request 内の setWrapper
パラメータ:
wrapper - The newly associated Wrapper

createInputStream

public javax.servlet.ServletInputStream createInputStream()
                                                   throws java.io.IOException
Create and return a ServletInputStream to read the content associated with this Request.
定義:
インタフェース Request 内の createInputStream
例外:
java.io.IOException - if an input/output error occurs

finishRequest

public void finishRequest()
                   throws java.io.IOException
Perform whatever actions are required to flush and close the input stream or reader, in a single operation.
定義:
インタフェース Request 内の finishRequest
例外:
java.io.IOException - if an input/output error occurs

recycle

public void recycle()
Release all object references, and initialize instance variables, in preparation for reuse of this object.
定義:
インタフェース Request 内の recycle

setContentLength

public void setContentLength(int length)
Set the content length associated with this Request.
定義:
インタフェース Request 内の setContentLength
パラメータ:
length - The new content length

setContentType

public void setContentType(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.
定義:
インタフェース Request 内の setContentType
パラメータ:
type - The new content type

setProtocol

public void setProtocol(java.lang.String protocol)
Set the protocol name and version associated with this Request.
定義:
インタフェース Request 内の setProtocol
パラメータ:
protocol - Protocol name and version

setRemoteAddr

public void setRemoteAddr(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.
定義:
インタフェース Request 内の setRemoteAddr
パラメータ:
remote - The remote IP address

setScheme

public void setScheme(java.lang.String scheme)
Set the name of the scheme associated with this request. Typical values are http, https, and ftp.
定義:
インタフェース Request 内の setScheme
パラメータ:
scheme - The scheme

setSecure

public void setSecure(boolean secure)
Set the value to be returned by isSecure() for this Request.
定義:
インタフェース Request 内の setSecure
パラメータ:
secure - The new isSecure value

setServerName

public void setServerName(java.lang.String name)
Set the name of the server (virtual host) to process this request.
定義:
インタフェース Request 内の setServerName
パラメータ:
name - The server name

setServerPort

public void setServerPort(int port)
Set the port number of the server to process this request.
定義:
インタフェース Request 内の setServerPort
パラメータ:
port - The server port


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