Mergedoc
Translation

javax.servlet
クラス ServletRequestWrapper

java.lang.Object
  上位を拡張 javax.servlet.ServletRequestWrapper
すべての実装されたインタフェース:
ServletRequest
直系の既知のサブクラス:
HttpServletRequestWrapper

public class ServletRequestWrapper
extends java.lang.Object
implements ServletRequest

Servlet に対するリクエストを改変したい開発者たちの手でサブクラス化による拡張を可能とする、ServletRequest インタフェースの簡潔な実装方法を提供します。 このクラスは、Wrapper パターン もしくは Decorator パターンに基づいて実装されています。各々のメソッドは、ラップされたリクエストオブジェクトのメソッドをデフォルトで呼び出します。

導入されたバージョン:
v 2.3
関連項目:
ServletRequest

コンストラクタの概要
ServletRequestWrapper(ServletRequest request)
          指定したリクエストオブジェクトをラッピングした ServletRequest アダプタを作ります。
 
メソッドの概要
 java.lang.Object getAttribute(java.lang.String name)
          このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクトにある getAttribute(String name) メソッドをそのまま呼び出します。
 java.util.Enumeration getAttributeNames()
          このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクトにある getAttributeNames() メソッドをそのまま呼び出します。
 java.lang.String getCharacterEncoding()
          このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクトにある getCharacterEncoding() メソッドをそのまま呼び出します。
 int getContentLength()
          このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクトにある getContentLength() メソッドをそのまま呼び出します。
 java.lang.String getContentType()
          このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクトにある getContentType()メソッドがそのまま呼び出します。
 ServletInputStream getInputStream()
          このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクトにある getInputStream() メソッドをそのまま呼び出します。
 java.lang.String getLocalAddr()
          このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクトにある getLocalAddr() メソッドをそのまま呼び出します。
 java.util.Locale getLocale()
          このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクトにある getLocale() メソッドをそのまま呼び出します。
 java.util.Enumeration getLocales()
          このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクトにある getLocales() メソッドをそのまま呼び出します。
 java.lang.String getLocalName()
          このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクトにある getLocalName() メソッドをそのまま呼び出します。
 int getLocalPort()
          このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクトにある getLocalPort() メソッドをそのまま呼び出します。
 java.lang.String getParameter(java.lang.String name)
          このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクトにある getParameter(String name) メソッドをそのまま呼び出します。
 java.util.Map getParameterMap()
          このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクトにある getParameterMap() メソッドをそのまま呼び出します。
 java.util.Enumeration getParameterNames()
          このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクトにある getParameterNames() メソッドをそのまま呼び出します。
 java.lang.String[] getParameterValues(java.lang.String name)
          このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクトにある getParameterValues(String name) メソッドをそのまま呼び出します。
 java.lang.String getProtocol()
          このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクトにある getProtocol() メソッドをそのまま呼び出します。
 java.io.BufferedReader getReader()
          このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクトにある getReader() メソッドをそのまま呼び出します。
 java.lang.String getRealPath(java.lang.String path)
          このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクトにある getRealPath(String path) メソッドをそのまま呼び出します。
 java.lang.String getRemoteAddr()
          このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクトにある getRemoteAddr() メソッドをそのまま呼び出します。
 java.lang.String getRemoteHost()
          このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクトにある getRemoteHost() メソッドをそのまま呼び出します。
 int getRemotePort()
          このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクトにある getRemotePort() メソッドをそのまま呼び出します。
 ServletRequest getRequest()
          ラップされたリクエストオブジェクトを返します。
 RequestDispatcher getRequestDispatcher(java.lang.String path)
          このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクトにある getRequestDispatcher(String path) メソッドをそのまま呼び出します。
 java.lang.String getScheme()
          このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクトにある getScheme() メソッドをそのまま呼び出します。
 java.lang.String getServerName()
          このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクトにある getServerName() メソッドをそのまま呼び出します。
 int getServerPort()
          このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクトにある getServerPort() メソッドをそのまま呼び出します。
 boolean isSecure()
          このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクトにある isSecure() メソッドをそのまま呼び出します。
 void removeAttribute(java.lang.String name)
          このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクトにある removeAttribute(String name) メソッドをそのまま呼び出します。
 void setAttribute(java.lang.String name, java.lang.Object o)
          このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクトにある setAttribute(String name, Object o) メソッドをそのまま呼び出します。
 void setCharacterEncoding(java.lang.String enc)
          このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクト上に文字エンコーディングをセットします。
 void setRequest(ServletRequest request)
          ラップされるリクエストオブジェクトをセットします。
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

ServletRequestWrapper

public ServletRequestWrapper(ServletRequest request)
指定したリクエストオブジェクトをラッピングした ServletRequest アダプタを作ります。

例外:
java.lang.IllegalArgumentException - request が null である場合
メソッドの詳細

getRequest

public ServletRequest getRequest()
ラップされたリクエストオブジェクトを返します。


setRequest

public void setRequest(ServletRequest request)
ラップされるリクエストオブジェクトをセットします。

例外:
java.lang.IllegalArgumentException - request が null である場合

getAttribute

public java.lang.Object getAttribute(java.lang.String name)
このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクトにある getAttribute(String name) メソッドをそのまま呼び出します。

定義:
インタフェース ServletRequest 内の getAttribute
パラメータ:
name - 属性の名前を指定する String
戻り値:
属性の値が含まれている Object。 指定された名前の属性が無い場合は null

getAttributeNames

public java.util.Enumeration getAttributeNames()
このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクトにある getAttributeNames() メソッドをそのまま呼び出します。

定義:
インタフェース ServletRequest 内の getAttributeNames
戻り値:
リクエストに付随する属性名を含む文字列からなる Enumeration

getCharacterEncoding

public java.lang.String getCharacterEncoding()
このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクトにある getCharacterEncoding() メソッドをそのまま呼び出します。

定義:
インタフェース ServletRequest 内の getCharacterEncoding
戻り値:
文字エンコーディングの名前を含む String 。 リクエストに文字エンコーディングの指定が無い場合は null

setCharacterEncoding

public void setCharacterEncoding(java.lang.String enc)
                          throws java.io.UnsupportedEncodingException
このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクト上に文字エンコーディングをセットします。

定義:
インタフェース ServletRequest 内の setCharacterEncoding
パラメータ:
enc - 文字エンコーディング名を含む String
例外:
java.io.UnsupportedEncodingException - 有効な文字エンコーディング名でない場合

getContentLength

public int getContentLength()
このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクトにある getContentLength() メソッドをそのまま呼び出します。

定義:
インタフェース ServletRequest 内の getContentLength
戻り値:
リクエストのメッセージボディの長さを表す整数値。 長さがわからない場合は -1

getContentType

public java.lang.String getContentType()
このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクトにある getContentType()メソッドがそのまま呼び出します。

定義:
インタフェース ServletRequest 内の getContentType
戻り値:
リクエストの MIME タイプの名前を含む String

getInputStream

public ServletInputStream getInputStream()
                                  throws java.io.IOException
このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクトにある getInputStream() メソッドをそのまま呼び出します。

定義:
インタフェース ServletRequest 内の getInputStream
戻り値:
リクエストのメッセージボディを含む ServletInputStream オブジェクト
例外:
java.io.IOException - 入出力の例外が発生した場合

getParameter

public java.lang.String getParameter(java.lang.String name)
このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクトにある getParameter(String name) メソッドをそのまま呼び出します。

定義:
インタフェース ServletRequest 内の getParameter
パラメータ:
name - パラメータの名前を指定する String
戻り値:
単一のパラメータの値を表す String
関連項目:
ServletRequest.getParameterValues(java.lang.String)

getParameterMap

public java.util.Map getParameterMap()
このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクトにある getParameterMap() メソッドをそのまま呼び出します。

定義:
インタフェース ServletRequest 内の getParameterMap
戻り値:
パラメータ名が key 、パラメータ値がマップの値と なっている不変な java.util.Map。 パラメータマップの key は String 型。 パラメータマップの値は String の配列です。

getParameterNames

public java.util.Enumeration getParameterNames()
このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクトにある getParameterNames() メソッドをそのまま呼び出します。

定義:
インタフェース ServletRequest 内の getParameterNames
戻り値:
String オブジェクトで構成された EnumerationString は各リクエストパラメータの名前。 パラメータが無い場合は空の Enumeration

getParameterValues

public java.lang.String[] getParameterValues(java.lang.String name)
このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクトにある getParameterValues(String name) メソッドをそのまま呼び出します。

定義:
インタフェース ServletRequest 内の getParameterValues
パラメータ:
name - 取得したいパラメータの名前を指定する String
戻り値:
パラメータの値が入っている String オブジェクトの配列
関連項目:
ServletRequest.getParameter(java.lang.String)

getProtocol

public java.lang.String getProtocol()
このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクトにある getProtocol() メソッドをそのまま呼び出します。

定義:
インタフェース ServletRequest 内の getProtocol
戻り値:
プロトコル名とバージョンを示す String

getScheme

public java.lang.String getScheme()
このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクトにある getScheme() メソッドをそのまま呼び出します。

定義:
インタフェース ServletRequest 内の getScheme
戻り値:
このリクエストに使われたスキームを示す String

getServerName

public java.lang.String getServerName()
このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクトにある getServerName() メソッドをそのまま呼び出します。

定義:
インタフェース ServletRequest 内の getServerName
戻り値:
サーバの名前を示す String

getServerPort

public int getServerPort()
このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクトにある getServerPort() メソッドをそのまま呼び出します。

定義:
インタフェース ServletRequest 内の getServerPort
戻り値:
ポート番号を示す整数値

getReader

public java.io.BufferedReader getReader()
                                 throws java.io.IOException
このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクトにある getReader() メソッドをそのまま呼び出します。

定義:
インタフェース ServletRequest 内の getReader
戻り値:
リクエストのメッセージボディを含む BufferedReader
例外:
java.io.IOException - 入出力例外が発生した場合
関連項目:
ServletRequest.getInputStream()

getRemoteAddr

public java.lang.String getRemoteAddr()
このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクトにある getRemoteAddr() メソッドをそのまま呼び出します。

定義:
インタフェース ServletRequest 内の getRemoteAddr
戻り値:
リクエストを送ってきたクライアントの IP アドレスを示す String

getRemoteHost

public java.lang.String getRemoteHost()
このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクトにある getRemoteHost() メソッドをそのまま呼び出します。

定義:
インタフェース ServletRequest 内の getRemoteHost
戻り値:
クライアントの FQDN (Fullu Qualified Domain Name) を示す String

setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.Object o)
このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクトにある setAttribute(String name, Object o) メソッドをそのまま呼び出します。

定義:
インタフェース ServletRequest 内の setAttribute
パラメータ:
name - 属性名を示す String
o - セットする Object

removeAttribute

public void removeAttribute(java.lang.String name)
このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクトにある removeAttribute(String name) メソッドをそのまま呼び出します。

定義:
インタフェース ServletRequest 内の removeAttribute
パラメータ:
name - 削除する属性の名前を示す String

getLocale

public java.util.Locale getLocale()
このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクトにある getLocale() メソッドをそのまま呼び出します。

定義:
インタフェース ServletRequest 内の getLocale
戻り値:
クライアントに適していると想定される Locale

getLocales

public java.util.Enumeration getLocales()
このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクトにある getLocales() メソッドをそのまま呼び出します。

定義:
インタフェース ServletRequest 内の getLocales
戻り値:
クライアントに適していると想定される Locale で構成される Enumeration

isSecure

public boolean isSecure()
このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクトにある isSecure() メソッドをそのまま呼び出します。

定義:
インタフェース ServletRequest 内の isSecure
戻り値:
リクエストがセキュアなチャネルを使って送られたものかどうかを示す boolean

getRequestDispatcher

public RequestDispatcher getRequestDispatcher(java.lang.String path)
このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクトにある getRequestDispatcher(String path) メソッドをそのまま呼び出します。

定義:
インタフェース ServletRequest 内の getRequestDispatcher
パラメータ:
path - リソースのパス名を指定する String。 相対パスの場合は現在の Servlet に対しての位置。
戻り値:
指定されたパスに位置するリソースのラッパとして動作する RequestDispatcher オブジェクト。 または Servlet コンテナが RequestDispatcher を返せない場合は null
関連項目:
RequestDispatcher, ServletContext.getRequestDispatcher(java.lang.String)

getRealPath

public java.lang.String getRealPath(java.lang.String path)
このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクトにある getRealPath(String path) メソッドをそのまま呼び出します。

定義:
インタフェース ServletRequest 内の getRealPath

getRemotePort

public int getRemotePort()
このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクトにある getRemotePort() メソッドをそのまま呼び出します。

定義:
インタフェース ServletRequest 内の getRemotePort
戻り値:
ポート番号を示す整数値
導入されたバージョン:
2.4

getLocalName

public java.lang.String getLocalName()
このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクトにある getLocalName() メソッドをそのまま呼び出します。

定義:
インタフェース ServletRequest 内の getLocalName
戻り値:
リクエストを受け取った IP のホスト名を示す String
導入されたバージョン:
2.4

getLocalAddr

public java.lang.String getLocalAddr()
このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクトにある getLocalAddr() メソッドをそのまま呼び出します。

定義:
インタフェース ServletRequest 内の getLocalAddr
戻り値:
リクエストを受け取った IP アドレスを示す String
導入されたバージョン:
2.4

getLocalPort

public int getLocalPort()
このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエストオブジェクトにある getLocalPort() メソッドをそのまま呼び出します。

定義:
インタフェース ServletRequest 内の getLocalPort
戻り値:
ポート番号を示す整数値
導入されたバージョン:
2.4

Mergedoc
Translation

Copyright © 2000- The Apache Software Foundation. All rights Reserved.