Mergedoc
Translation

javax.servlet.http
クラス HttpServletRequestWrapper

java.lang.Object
  上位を拡張 javax.servlet.ServletRequestWrapper
      上位を拡張 javax.servlet.http.HttpServletRequestWrapper
すべての実装されたインタフェース:
HttpServletRequest, ServletRequest

public class HttpServletRequestWrapper
extends ServletRequestWrapper
implements HttpServletRequest

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

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

フィールドの概要
 
インタフェース javax.servlet.http.HttpServletRequest から継承されたフィールド
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH
 
コンストラクタの概要
HttpServletRequestWrapper(HttpServletRequest request)
          指定したリクエストをラッピングしたリクエストオブジェクトを構築します。
 
メソッドの概要
 java.lang.String getAuthType()
          このメソッドにおけるデフォルトの振舞いとして、ラップされたリクエストオブジェクトにある getAuthType() メソッドがそのまま呼び出されます。
 java.lang.String getContextPath()
          このメソッドにおけるデフォルトの振舞いとして、ラップされたリクエストオブジェクトにある getContextPath() メソッドをそのまま呼び出します。
 Cookie[] getCookies()
          このメソッドにおけるデフォルトの振舞いとして、ラップされたリクエストオブジェクトにある getCookies() メソッドをそのまま呼び出します。
 long getDateHeader(java.lang.String name)
          このメソッドにおけるデフォルトの振舞いとして、ラップされたリクエストオブジェクトにある getDateHeader(String name) メソッドをそのまま呼び出します。
 java.lang.String getHeader(java.lang.String name)
          このメソッドにおけるデフォルトの振舞いとして、ラップされたリクエストオブジェクトにある getHeader(String name) メソッドをそのまま呼び出します。
 java.util.Enumeration getHeaderNames()
          このメソッドにおけるデフォルトの振舞いとして、ラップされたリクエストオブジェクトにある getHeaderNames() メソッドをそのまま呼び出します。
 java.util.Enumeration getHeaders(java.lang.String name)
          このメソッドにおけるデフォルトの振舞いとして、ラップされたリクエストオブジェクトにある getHeaders(String name) メソッドをそのまま呼び出します。
 int getIntHeader(java.lang.String name)
          このメソッドにおけるデフォルトの振舞いとして、ラップされたリクエストオブジェクトにある getIntHeader(String name) メソッドをそのまま呼び出します。
 java.lang.String getMethod()
          このメソッドにおけるデフォルトの振舞いとして、ラップされたリクエストオブジェクトにある getMethod() メソッドをそのまま呼び出します。
 java.lang.String getPathInfo()
          このメソッドにおけるデフォルトの振舞いとして、ラップされたリクエストオブジェクトにある getPathInfo() メソッドをそのまま呼び出します。
 java.lang.String getPathTranslated()
          このメソッドにおけるデフォルトの振舞いとして、ラップされたリクエストオブジェクトにある getPathTranslated() メソッドをそのまま呼び出します。
 java.lang.String getQueryString()
          このメソッドにおけるデフォルトの振舞いとして、ラップされたリクエストオブジェクトにある getQueryString() メソッドをそのまま呼び出します。
 java.lang.String getRemoteUser()
          このメソッドにおけるデフォルトの振舞いとして、ラップされたリクエストオブジェクトにある getRemoteUser() メソッドをそのまま呼び出します。
 java.lang.String getRequestedSessionId()
          このメソッドにおけるデフォルトの振舞いとして、ラップされたリクエストオブジェクトにある getRequestedSessionId() メソッドをそのまま呼び出します。
 java.lang.String getRequestURI()
          このメソッドにおけるデフォルトの振舞いとして、ラップされたリクエストオブジェクトにある getRequestURI() メソッドをそのまま呼び出します。
 java.lang.StringBuffer getRequestURL()
          このメソッドにおけるデフォルトの振舞いとして、ラップされたリクエストオブジェクトにある getRequestURL() メソッドをそのまま呼び出します。
 java.lang.String getServletPath()
          このメソッドにおけるデフォルトの振舞いとして、ラップされたリクエストオブジェクトにある getServletPath() メソッドをそのまま呼び出します。
 HttpSession getSession()
          このメソッドにおけるデフォルトの振舞いとして、ラップされたリクエストオブジェクトにある getSession() メソッドをそのまま呼び出します。
 HttpSession getSession(boolean create)
          このメソッドにおけるデフォルトの振舞いとして、ラップされたリクエストオブジェクトにある getSession(boolean create) メソッドをそのまま呼び出します。
 java.security.Principal getUserPrincipal()
          このメソッドにおけるデフォルトの振舞いとして、ラップされたリクエストオブジェクトにある getUserPrincipal() メソッドをそのまま呼び出します。
 boolean isRequestedSessionIdFromCookie()
          このメソッドにおけるデフォルトの振舞いとして、ラップされたリクエストオブジェクトにある isRequestedSessionIdFromCookie() メソッドをそのまま呼び出します。
 boolean isRequestedSessionIdFromUrl()
          このメソッドにおけるデフォルトの振舞いとして、ラップされたリクエストオブジェクトにある isRequestedSessionIdFromUrl() メソッドをそのまま呼び出します。
 boolean isRequestedSessionIdFromURL()
          このメソッドにおけるデフォルトの振舞いとして、ラップされたリクエストオブジェクトにある isRequestedSessionIdFromURL() メソッドをそのまま呼び出します。
 boolean isRequestedSessionIdValid()
          このメソッドにおけるデフォルトの振舞いとして、ラップされたリクエストオブジェクトにある isRequestedSessionIdValid() メソッドをそのまま呼び出します。
 boolean isUserInRole(java.lang.String role)
          このメソッドにおけるデフォルトの振舞いとして、ラップされたリクエストオブジェクトにある isUserInRole(String role) メソッドをそのまま呼び出します。
 
クラス javax.servlet.ServletRequestWrapper から継承されたメソッド
getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, 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, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getScheme, getServerName, getServerPort, isSecure, removeAttribute, setAttribute, setCharacterEncoding
 

コンストラクタの詳細

HttpServletRequestWrapper

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

パラメータ:
request - ラップするリクエスト
例外:
java.lang.IllegalArgumentException - request が null である場合
メソッドの詳細

getAuthType

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

定義:
インタフェース HttpServletRequest 内の getAuthType
戻り値:
認証スキームを表す静的メンバ BASIC_AUTH、FORM_AUTH、CLIENT_CERT_AUTH、DIGEST_AUTH またはコンテナ指定文字列のいずれか (== 演算子で比較可能) 。リクエストが認証されていない場合は null

getCookies

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

定義:
インタフェース HttpServletRequest 内の getCookies
戻り値:
このリクエストに付加されている Cookie の配列。 リクエストに Cookie が付加されていない場合は null

getDateHeader

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

定義:
インタフェース HttpServletRequest 内の getDateHeader
パラメータ:
name - ヘッダ名を表す String
戻り値:
日付を表す long 値。 日付は、1970年1月1日グリニッジ標準時 00:00:00.000 からの経過時間をミリ秒で表した数値。 指定された名前を持つヘッダがこのリクエストに存在しない場合は -1。

getHeader

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

定義:
インタフェース HttpServletRequest 内の getHeader
パラメータ:
name - ヘッダ名を表す String
戻り値:
要求したヘッダの値を持つ String。 指定した名前を持つヘッダが存在しない場合は null

getHeaders

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

定義:
インタフェース HttpServletRequest 内の getHeaders
パラメータ:
name - ヘッダ名を表す String
戻り値:
リクエストヘッダの値を持つ Enumeration。 このリクエストが指定された名前のヘッダを持たない場合、空の Enumeration を返す。 コンテナがヘッダ情報へのアクセスを禁止している場合、null を返す

getHeaderNames

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

定義:
インタフェース HttpServletRequest 内の getHeaderNames
戻り値:
このリクエストとともに送信された全てのヘッダの名前の Enumeration。 リクエストがヘッダを持たない場合は空の Enumeration を返す。 Servlet がこのメソッドを用いることを Servlet コンテナが禁止している場合は null

getIntHeader

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

定義:
インタフェース HttpServletRequest 内の getIntHeader
パラメータ:
name - リクエストヘッダ名を表す String
戻り値:
リクエストヘッダの値を表す整数。 指定された名前のヘッダをリクエストが持たない場合は -1。

getMethod

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

定義:
インタフェース HttpServletRequest 内の getMethod
戻り値:
このリクエストを生成したメソッドの名前を表す String

getPathInfo

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

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

getPathTranslated

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

定義:
インタフェース HttpServletRequest 内の getPathTranslated
戻り値:
実際のパスを表す String。 URL が拡張パス情報を持っていない場合は null を返す。

getContextPath

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

定義:
インタフェース HttpServletRequest 内の getContextPath
戻り値:
リクエストされた URI のうち、リクエストのコンテキストを指す部分の String

getQueryString

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

定義:
インタフェース HttpServletRequest 内の getQueryString
戻り値:
クエリ文字列を表す String。 URL がクエリ文字列を持たない場合は null を返します。 値はコンテナによってデコードされません。

getRemoteUser

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

定義:
インタフェース HttpServletRequest 内の getRemoteUser
戻り値:
このリクエストを生成したユーザのログイン名を表す String。 ユーザのログイン名が分からない場合は null を返します。

isUserInRole

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

定義:
インタフェース HttpServletRequest 内の isUserInRole
パラメータ:
role - ロール名を表す String
戻り値:
このリクエストを生成したユーザが指定されたロールに属するかどうかを表す boolean。 ユーザが認証されていない場合は false を返す。

getUserPrincipal

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

定義:
インタフェース HttpServletRequest 内の getUserPrincipal
戻り値:
このリクエストを生成したユーザの名前を含む java.security.Principal。 ユーザが認証されていない場合は null を返す。

getRequestedSessionId

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

定義:
インタフェース HttpServletRequest 内の getRequestedSessionId
戻り値:
セッション ID を表す String。 リクエストがセッション ID を持ってない場合は null
関連項目:
HttpServletRequest.isRequestedSessionIdValid()

getRequestURI

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

定義:
インタフェース HttpServletRequest 内の getRequestURI
戻り値:
URL のうちプロトコル名からクエリ文字列までの部分を表す String
関連項目:
HttpUtils.getRequestURL(javax.servlet.http.HttpServletRequest)

getRequestURL

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

定義:
インタフェース HttpServletRequest 内の getRequestURL
戻り値:
再構築された URL を持つ StringBuffer

getServletPath

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

定義:
インタフェース HttpServletRequest 内の getServletPath
戻り値:
リクエストされた URL によって呼び出された Servlet の名前もしくはパスを含むものをデコードした String。 Servlet のリクエスト処理で "/*" パターンにマッチした場合は空の文字列。

getSession

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

定義:
インタフェース HttpServletRequest 内の getSession
パラメータ:
create - 必要に応じてこのリクエストのために新しいセッションを生成する場合は true。 この値を false にすると、現在のセッションが存在しない場合に null を返す。
戻り値:
このリクエストに関連づけられている HttpSessioncreate の値が false である場合、リクエストが有効なセッションを持っていなければ null
関連項目:
HttpServletRequest.getSession()

getSession

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

定義:
インタフェース HttpServletRequest 内の getSession
戻り値:
このリクエストに関連づけられている HttpSession
関連項目:
HttpServletRequest.getSession(boolean)

isRequestedSessionIdValid

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

定義:
インタフェース HttpServletRequest 内の isRequestedSessionIdValid
戻り値:
このリクエストが現在のセッションのコンテキストにおいて有効なセッションの ID を持っている場合は true を返し、そうでない場合は false を返します。
関連項目:
HttpServletRequest.getRequestedSessionId(), HttpServletRequest.getSession(boolean), HttpSessionContext

isRequestedSessionIdFromCookie

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

定義:
インタフェース HttpServletRequest 内の isRequestedSessionIdFromCookie
戻り値:
セッション ID が Cookie として送られてきた場合は true。 そうでない場合は false
関連項目:
HttpServletRequest.getSession(boolean)

isRequestedSessionIdFromURL

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

定義:
インタフェース HttpServletRequest 内の isRequestedSessionIdFromURL
戻り値:
セッション ID が URL の一部分として送られてきた場合は true。そうでない場合は false
関連項目:
HttpServletRequest.getSession(boolean)

isRequestedSessionIdFromUrl

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

定義:
インタフェース HttpServletRequest 内の isRequestedSessionIdFromUrl

Mergedoc
Translation

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