javax.servlet
クラス ServletRequestWrapper

java.lang.Object
  |
  +--javax.servlet.ServletRequestWrapper

すべての実装インタフェース:

ServletRequest

直系の既知のサブクラス:

HttpServletRequestWrapper

public class ServletRequestWrapper

extends Object

implements ServletRequest

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

導入されたバージョン:

v 2.3

関連項目:

ServletRequest

コンストラクタの概要

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

メソッドの概要

Object	getAttribute(String name) このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエスト・オブジェクトにあるgetAttribute(String name)メソッドをそのまま呼び出します。
Enumeration	getAttributeNames() このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエスト・オブジェクトにあるgetAttributeNames()メソッドをそのまま呼び出します。
String	getCharacterEncoding() このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエスト・オブジェクトにあるgetCharacterEncoding()メソッドをそのまま呼び出します。
int	getContentLength() このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエスト・オブジェクトにあるgetContentLength()メソッドをそのまま呼び出します。
String	getContentType() このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエスト・オブジェクトにあるgetContentType()メソッドがそのまま呼び出します。
ServletInputStream	getInputStream() このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエスト・オブジェクトにあるgetInputStream()メソッドをそのまま呼び出します。
Locale	getLocale() このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエスト・オブジェクトにあるgetLocale()メソッドをそのまま呼び出します。
Enumeration	getLocales() このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエスト・オブジェクトにあるgetLocales()メソッドをそのまま呼び出します。
String	getParameter(String name) このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエスト・オブジェクトにあるgetParameter(String name)メソッドをそのまま呼び出します。
Map	getParameterMap() このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエスト・オブジェクトにあるgetParameterMap()メソッドをそのまま呼び出します。
Enumeration	getParameterNames() このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエスト・オブジェクトにあるgetParameterNames()メソッドをそのまま呼び出します。
String[]	getParameterValues(String name) このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエスト・オブジェクトにあるgetParameterValues(String name)メソッドをそのまま呼び出します。
String	getProtocol() このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエスト・オブジェクトにあるgetProtocol()メソッドをそのまま呼び出します。
BufferedReader	getReader() このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエスト・オブジェクトにあるgetReader()メソッドをそのまま呼び出します。
String	getRealPath(String path) このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエスト・オブジェクトにあるgetRealPath(String path)メソッドをそのまま呼び出します。
String	getRemoteAddr() このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエスト・オブジェクトにあるgetRemoteAddr()メソッドをそのまま呼び出します。
String	getRemoteHost() このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエスト・オブジェクトにあるgetRemoteHost()メソッドをそのまま呼び出します。
ServletRequest	getRequest() ラップされたリクエスト・オブジェクトを返します。
RequestDispatcher	getRequestDispatcher(String path) このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエスト・オブジェクトにあるgetRequestDispatcher(String path)メソッドをそのまま呼び出します。
String	getScheme() このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエスト・オブジェクトにあるgetScheme()メソッドをそのまま呼び出します。
String	getServerName() このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエスト・オブジェクトにあるgetServerName()メソッドをそのまま呼び出します。
int	getServerPort() このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエスト・オブジェクトにあるgetServerPort()メソッドをそのまま呼び出します。
boolean	isSecure() このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエスト・オブジェクトにあるisSecure()メソッドをそのまま呼び出します。
void	removeAttribute(String name) このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエスト・オブジェクトにあるremoveAttribute(String name)メソッドをそのまま呼び出します。
void	setAttribute(String name, Object o) このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエスト・オブジェクトにあるsetAttribute(String name, Object o)メソッドをそのまま呼び出します。
void	setCharacterEncoding(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アダプタを作ります。

例外:

IllegalArgumentException - request が null である場合

メソッドの詳細

getRequest

public ServletRequest getRequest()

ラップされたリクエスト・オブジェクトを返します。

setRequest

public void setRequest(ServletRequest request)

ラップされるリクエスト・オブジェクトをセットします。

例外:

IllegalArgumentException - request が null である場合

getAttribute

public Object getAttribute(String name)

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

定義:

インタフェース ServletRequest 内の getAttribute

インタフェース javax.servlet.ServletRequest からコピーされたタグ:

パラメータ:

name - 属性の名前を指定する String

戻り値:

属性の値が含まれている Object。 指定された名前の属性が無い場合は null

getAttributeNames

public Enumeration getAttributeNames()

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

定義:

インタフェース ServletRequest 内の getAttributeNames

インタフェース javax.servlet.ServletRequest からコピーされたタグ:

戻り値:

リクエストに付随する属性名を含む文字列からなる Enumeration

getCharacterEncoding

public String getCharacterEncoding()

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

定義:

インタフェース ServletRequest 内の getCharacterEncoding

インタフェース javax.servlet.ServletRequest からコピーされたタグ:

戻り値:

文字エンコーディングの名前を含む String 。 リクエストに文字エンコーディングの指定が無い場合は null

setCharacterEncoding

public void setCharacterEncoding(String enc)
                          throws UnsupportedEncodingException

このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエスト・オブジェクト上に文字エンコーディングをセットします。

定義:

インタフェース ServletRequest 内の setCharacterEncoding

インタフェース javax.servlet.ServletRequest からコピーされたタグ:

パラメータ:

env - 文字エンコーディング名を含む String

例外:

UnsupportedEncodingException - 有効な文字エンコーディング名でない場合

getContentLength

public int getContentLength()

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

定義:

インタフェース ServletRequest 内の getContentLength

インタフェース javax.servlet.ServletRequest からコピーされたタグ:

戻り値:

リクエストのメッセージボディの長さを表す整数値。 長さがわからない場合は -1

getContentType

public String getContentType()

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

定義:

インタフェース ServletRequest 内の getContentType

インタフェース javax.servlet.ServletRequest からコピーされたタグ:

戻り値:

リクエストの MIME タイプの名前を含む String

getInputStream

public ServletInputStream getInputStream()
                                  throws IOException

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

定義:

インタフェース ServletRequest 内の getInputStream

インタフェース javax.servlet.ServletRequest からコピーされたタグ:

例外:

IllegalStateException - このリクエストですでに ServletRequest.getReader() メソッドが実行されている場合

IOException - 入出力の例外が発生した場合

getParameter

public String getParameter(String name)

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

定義:

インタフェース ServletRequest 内の getParameter

インタフェース javax.servlet.ServletRequest からコピーされたタグ:

パラメータ:

name - パラメータの名前を指定する String

戻り値:

単一のパラメータの値を表す String

関連項目:

ServletRequest.getParameterValues(java.lang.String)

getParameterMap

public Map getParameterMap()

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

定義:

インタフェース ServletRequest 内の getParameterMap

インタフェース javax.servlet.ServletRequest からコピーされたタグ:

戻り値:

パラメータ名が key 、パラメータ値がマップの値と なっている不変な java.util.Map。 パラメータマップの key は String 型。 パラメータマップの値は String の配列です。

getParameterNames

public Enumeration getParameterNames()

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

定義:

インタフェース ServletRequest 内の getParameterNames

インタフェース javax.servlet.ServletRequest からコピーされたタグ:

戻り値:

String オブジェクトで構成された Enumeration。String は各リクエストパラメータの名前。 パラメータが無い場合は空の Enumeration。

getParameterValues

public String[] getParameterValues(String name)

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

定義:

インタフェース ServletRequest 内の getParameterValues

インタフェース javax.servlet.ServletRequest からコピーされたタグ:

パラメータ:

name - 取得したいパラメータの名前を指定する String

戻り値:

パラメータの値が入っている String オブジェクトの配列

関連項目:

ServletRequest.getParameter(java.lang.String)

getProtocol

public String getProtocol()

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

定義:

インタフェース ServletRequest 内の getProtocol

インタフェース javax.servlet.ServletRequest からコピーされたタグ:

戻り値:

プロトコル名とバージョンを示す String

getScheme

public String getScheme()

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

定義:

インタフェース ServletRequest 内の getScheme

インタフェース javax.servlet.ServletRequest からコピーされたタグ:

戻り値:

このリクエストに使われたスキームを示す String

getServerName

public String getServerName()

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

定義:

インタフェース ServletRequest 内の getServerName

インタフェース javax.servlet.ServletRequest からコピーされたタグ:

戻り値:

リクエストが送り込まれたサーバの名前を示す String

getServerPort

public int getServerPort()

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

定義:

インタフェース ServletRequest 内の getServerPort

インタフェース javax.servlet.ServletRequest からコピーされたタグ:

戻り値:

ポート番号を示す整数値

getReader

public BufferedReader getReader()
                         throws IOException

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

定義:

インタフェース ServletRequest 内の getReader

インタフェース javax.servlet.ServletRequest からコピーされたタグ:

戻り値:

リクエストのメッセージボディを含む BufferedReader

例外:

UnsupportedEncodingException - サポートされてない文字エンコーディングが使われているかテキストをデコード出来なかった場合

IllegalStateException - このリクエストにおいてすでに ServletRequest.getInputStream() メソッドが実行されていた場合 入出力で例外が発生した場合

関連項目:

ServletRequest.getInputStream()

getRemoteAddr

public String getRemoteAddr()

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

定義:

インタフェース ServletRequest 内の getRemoteAddr

インタフェース javax.servlet.ServletRequest からコピーされたタグ:

戻り値:

リクエストを送ってきたクライアントの IP アドレスを示す String

getRemoteHost

public String getRemoteHost()

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

定義:

インタフェース ServletRequest 内の getRemoteHost

インタフェース javax.servlet.ServletRequest からコピーされたタグ:

戻り値:

クライアントの FQDN(Fullu Qualified Domain Name) を示す String

setAttribute

public void setAttribute(String name,
                         Object o)

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

定義:

インタフェース ServletRequest 内の setAttribute

インタフェース javax.servlet.ServletRequest からコピーされたタグ:

パラメータ:

name - 属性名を示す String

o - セットするObject

removeAttribute

public void removeAttribute(String name)

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

定義:

インタフェース ServletRequest 内の removeAttribute

インタフェース javax.servlet.ServletRequest からコピーされたタグ:

パラメータ:

name - 削除する属性の名前を示す String

getLocale

public Locale getLocale()

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

定義:

インタフェース ServletRequest 内の getLocale

インタフェース javax.servlet.ServletRequest からコピーされたタグ:

戻り値:

クライアントに適していると想定される Locale

getLocales

public Enumeration getLocales()

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

定義:

インタフェース ServletRequest 内の getLocales

インタフェース javax.servlet.ServletRequest からコピーされたタグ:

戻り値:

クライアントに適していると想定される Localeで構成される Enumeration

isSecure

public boolean isSecure()

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

定義:

インタフェース ServletRequest 内の isSecure

インタフェース javax.servlet.ServletRequest からコピーされたタグ:

戻り値:

リクエストがセキュアなチャネルを使って送られたものかどうかを示す boolean

getRequestDispatcher

public RequestDispatcher getRequestDispatcher(String path)

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

定義:

インタフェース ServletRequest 内の getRequestDispatcher

インタフェース javax.servlet.ServletRequest からコピーされたタグ:

パラメータ:

path - リソースのパス名を指定する String

戻り値:

指定されたパスに位置するリソースのラッパとして動作する RequestDispatcherオブジェクト

関連項目:

RequestDispatcher, ServletContext.getRequestDispatcher(java.lang.String)

getRealPath

public String getRealPath(String path)

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

定義:

インタフェース ServletRequest 内の getRealPath