javax.servlet.http
クラス HttpServletRequestWrapper

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

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

HttpServletRequest, ServletRequest

public class HttpServletRequestWrapper

extends ServletRequestWrapper

implements HttpServletRequest

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

導入されたバージョン:

v 2.3

関連項目:

HttpServletRequest

インタフェース javax.servlet.http.HttpServletRequest から継承したフィールド

BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

コンストラクタの概要

HttpServletRequestWrapper(HttpServletRequest request)
指定したリクエストをラッピングしたリクエスト・オブジェクトを構築します。

メソッドの概要

String	getAuthType() このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエスト・オブジェクトにあるgetAuthType()メソッドがそのまま呼び出されます。
String	getContextPath() このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエスト・オブジェクトにあるgetContextPath()メソッドをそのまま呼び出します。
Cookie[]	getCookies() このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエスト・オブジェクトにあるgetCookies()メソッドをそのまま呼び出します。
long	getDateHeader(String name) このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエスト・オブジェクトにあるgetDateHeader(String name)メソッドをそのまま呼び出します。
String	getHeader(String name) このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエスト・オブジェクトにあるgetHeader(String name)メソッドをそのまま呼び出します。
Enumeration	getHeaderNames() このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエスト・オブジェクトにあるgetHeaderNames()メソッドをそのまま呼び出します。
Enumeration	getHeaders(String name) このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエスト・オブジェクトにあるgetHeaders(String name)メソッドをそのまま呼び出します。
int	getIntHeader(String name) このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエスト・オブジェクトにあるgetIntHeader(String name)メソッドをそのまま呼び出します。
String	getMethod() このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエスト・オブジェクトにあるgetMethod()メソッドをそのまま呼び出します。
String	getPathInfo() このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエスト・オブジェクトにあるgetPathInfo()メソッドをそのまま呼び出します。
String	getPathTranslated() このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエスト・オブジェクトにあるgetPathTranslated()メソッドをそのまま呼び出します。
String	getQueryString() このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエスト・オブジェクトにあるgetQueryString()メソッドをそのまま呼び出します。
String	getRemoteUser() このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエスト・オブジェクトにあるgetRemoteUser()メソッドをそのまま呼び出します。
String	getRequestedSessionId() このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエスト・オブジェクトにあるgetRequestedSessionId()メソッドをそのまま呼び出します。
String	getRequestURI() このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエスト・オブジェクトにあるgetRequestURI()メソッドをそのまま呼び出します。
StringBuffer	getRequestURL() このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエスト・オブジェクトにあるgetRequestURL()メソッドをそのまま呼び出します。
String	getServletPath() このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエスト・オブジェクトにあるgetServletPath()メソッドをそのまま呼び出します。
HttpSession	getSession() このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエスト・オブジェクトにあるgetSession()メソッドをそのまま呼び出します。
HttpSession	getSession(boolean create) このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエスト・オブジェクトにあるgetSession(boolean create)メソッドをそのまま呼び出します。
Principal	getUserPrincipal() このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエスト・オブジェクトにあるgetUserPrincipal()メソッドをそのまま呼び出します。
boolean	isRequestedSessionIdFromCookie() このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエスト・オブジェクトにあるisRequestedSessionIdFromCookie()メソッドをそのまま呼び出します。
boolean	isRequestedSessionIdFromUrl() このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエスト・オブジェクトにあるisRequestedSessionIdFromUrl()メソッドをそのまま呼び出します。
boolean	isRequestedSessionIdFromURL() このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエスト・オブジェクトにあるisRequestedSessionIdFromURL()メソッドをそのまま呼び出します。
boolean	isRequestedSessionIdValid() このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエスト・オブジェクトにあるisRequestedSessionIdValid()メソッドをそのまま呼び出します。
boolean	isUserInRole(String role) このメソッドにおけるデフォルトのふるまいとして、ラップされたリクエスト・オブジェクトにあるisUserInRole(String role)メソッドをそのまま呼び出します。

クラス javax.servlet.ServletRequestWrapper から継承したメソッド

getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentType, getInputStream, getLocale, getLocales, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRequest, getRequestDispatcher, getScheme, getServerName, getServerPort, isSecure, removeAttribute, setAttribute, setCharacterEncoding, setRequest

クラス java.lang.Object から継承したメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

インタフェース javax.servlet.ServletRequest から継承したメソッド

getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentType, getInputStream, getLocale, getLocales, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRequestDispatcher, getScheme, getServerName, getServerPort, isSecure, removeAttribute, setAttribute, setCharacterEncoding

コンストラクタの詳細

HttpServletRequestWrapper

public HttpServletRequestWrapper(HttpServletRequest request)

指定したリクエストをラッピングしたリクエスト・オブジェクトを構築します。

例外:

IllegalArgumentException - request が null である場合

メソッドの詳細

getAuthType

public String getAuthType()

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

定義:

インタフェース HttpServletRequest 内の getAuthType

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

戻り値:

認証スキームを表す静的メンバBASIC_AUTH、FORM_AUTH、 CLIENT_CERT_AUTH、DIGEST_AUTHのいずれか。 （== 演算子で比較可能） リクエストが認証されていない場合は null

getCookies

public Cookie[] getCookies()

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

定義:

インタフェース HttpServletRequest 内の getCookies

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

戻り値:

このリクエストに付加されているCookieの配列。 リクエストにCookieが付加されていない場合はnull

getDateHeader

public long getDateHeader(String name)

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

定義:

インタフェース HttpServletRequest 内の getDateHeader

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

パラメータ:

name - ヘッダ名を表すString

戻り値:

日付を表すlong値。 日付は、1970年1月1日グリニッジ標準時00:00:00.000 からの経過時間をミリ秒で表した数値。 指定された名前を持つヘッダがこのリクエストに存在しない場合は * -1

例外:

IllegalArgumentException - ヘッダの値を日付に変換できない場合

getHeader

public String getHeader(String name)

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

定義:

インタフェース HttpServletRequest 内の getHeader

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

パラメータ:

name - ヘッダ名を表すString

戻り値:

要求したヘッダの値を持つString。 指定した名前を持つヘッダが存在しない場合はnull

getHeaders

public Enumeration getHeaders(String name)

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

定義:

インタフェース HttpServletRequest 内の getHeaders

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

パラメータ:

name - ヘッダ名を表すString

戻り値:

リクエストヘッダの値を持つEnumeration。 このリクエストが指定された名前のヘッダを持たない場合、 空のEnumerationを返す。 コンテナがヘッダ情報へのアクセスを禁止している場合、 nullを返す

getHeaderNames

public Enumeration getHeaderNames()

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

定義:

インタフェース HttpServletRequest 内の getHeaderNames

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

戻り値:

このリクエストとともに送信された全てのヘッダの名前の Enumeration。 リクエストがヘッダを持たない場合は空のEnumerationを返す。 Servletがこのメソッドを用いることを Servletコンテナが禁止している場合はnull

getIntHeader

public int getIntHeader(String name)

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

定義:

インタフェース HttpServletRequest 内の getIntHeader

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

パラメータ:

name - リクエストヘッダ名を表すString

戻り値:

リクエストヘッダの値を表す整数。 指定された名前のヘッダをリクエストが持たない場合は -1

例外:

NumberFormatException - ヘッダの値をint に変換できなかった場合

getMethod

public String getMethod()

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

定義:

インタフェース HttpServletRequest 内の getMethod

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

戻り値:

このリクエストを生成したメソッドの名前を表すString

getPathInfo

public String getPathInfo()

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

定義:

インタフェース HttpServletRequest 内の getPathInfo

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

戻り値:

Webコンテナによってデコードされた、 拡張パス情報を表すString。 拡張パス情報とは、リクエストされたURLのうち、 Servletのパスの後ろからクエリ文字列の前までの文字列。 URLが拡張パス情報を持たない場合はnullを返す

getPathTranslated

public String getPathTranslated()

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

定義:

インタフェース HttpServletRequest 内の getPathTranslated

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

戻り値:

実際のパスを表すString。 URLが拡張パス情報を持っていない場合は nullを返す

getContextPath

public String getContextPath()

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

定義:

インタフェース HttpServletRequest 内の getContextPath

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

戻り値:

リクエストされたURIのうち、 リクエストのコンテキストを指す部分のString

getQueryString

public String getQueryString()

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

定義:

インタフェース HttpServletRequest 内の getQueryString

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

戻り値:

クエリ文字列を表すString。 URLがクエリ文字列を持たない場合はnullを返します。 値はコンテナによってデコードされません。

getRemoteUser

public String getRemoteUser()

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

定義:

インタフェース HttpServletRequest 内の getRemoteUser

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

戻り値:

このリクエストを生成したユーザのログイン名を表す String。 ユーザのログイン名が分からない場合はnullを返します。

isUserInRole

public boolean isUserInRole(String role)

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

定義:

インタフェース HttpServletRequest 内の isUserInRole

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

パラメータ:

role - ロール名を表すString

戻り値:

このリクエストを生成したユーザが指定されたロールに属するかどうかを表すboolean。 ユーザが認証されていない場合はfalseを返す

getUserPrincipal

public Principal getUserPrincipal()

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

定義:

インタフェース HttpServletRequest 内の getUserPrincipal

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

戻り値:

このリクエストを生成したユーザの名前を含む java.security.Principal。 ユーザが認証されていない場合はnullを返す

getRequestedSessionId

public String getRequestedSessionId()

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

定義:

インタフェース HttpServletRequest 内の getRequestedSessionId

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

戻り値:

セッションIDを表すString。 リクエストがセッションIDを持ってない場合は null

関連項目:

HttpServletRequest.isRequestedSessionIdValid()

getRequestURI

public String getRequestURI()

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

定義:

インタフェース HttpServletRequest 内の getRequestURI

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

戻り値:

URLのうちプロトコル名からクエリ文字列までの部分を表す String

関連項目:

HttpUtils.getRequestURL(javax.servlet.http.HttpServletRequest)

getRequestURL

public StringBuffer getRequestURL()

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

定義:

インタフェース HttpServletRequest 内の getRequestURL

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

戻り値:

再構築されたURLを持つStringBuffer

getServletPath

public String getServletPath()

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

定義:

インタフェース HttpServletRequest 内の getServletPath

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

戻り値:

リクエストされたURLによって指定された、 呼び出されたServletの名前もしくはパスを含む String。

getSession

public HttpSession getSession(boolean create)

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

定義:

インタフェース HttpServletRequest 内の getSession

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

パラメータ:

必要に応じてこのリクエストのために新しいセッションを生成する場合はtrue。 - この値をfalseにすると、 現在のセッションが存在しない場合にnullを返す

戻り値:

このリクエストに関連づけられているHttpSession。 createの値がfalse である場合、リクエストが有効なセッションを持っていなければ null

関連項目:

HttpServletRequest.getSession()

getSession

public HttpSession getSession()

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

定義:

インタフェース HttpServletRequest 内の getSession

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

戻り値:

このリクエストに関連づけられているHttpSession

関連項目:

HttpServletRequest.getSession(boolean)

isRequestedSessionIdValid

public boolean isRequestedSessionIdValid()

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

定義:

インタフェース HttpServletRequest 内の isRequestedSessionIdValid

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

戻り値:

このリクエストが現在のセッションのコンテキストにおいて有効なセッションのIDを持っている場合はtrueを返し、そうでない場合はfalseを返します。

関連項目:

HttpServletRequest.getRequestedSessionId(), HttpServletRequest.getSession(boolean), HttpSessionContext

isRequestedSessionIdFromCookie

public boolean isRequestedSessionIdFromCookie()

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

定義:

インタフェース HttpServletRequest 内の isRequestedSessionIdFromCookie

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

戻り値:

セッションIDがCookieとして送られてきた場合は true。 そうでない場合はfalse

関連項目:

HttpServletRequest.getSession(boolean)

isRequestedSessionIdFromURL

public boolean isRequestedSessionIdFromURL()

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

定義:

インタフェース HttpServletRequest 内の isRequestedSessionIdFromURL

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

戻り値:

セッションIDがURLの一部分として送られてきた場合は true。 そうでない場合はfalse

関連項目:

HttpServletRequest.getSession(boolean)

isRequestedSessionIdFromUrl

public boolean isRequestedSessionIdFromUrl()

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

定義:

インタフェース HttpServletRequest 内の isRequestedSessionIdFromUrl