public class HttpServletRequestWrapper extends ServletRequestWrapper implements HttpServletRequest
このクラスは、Wrapper または Decorator パターンを実装します。メソッドは、デフォルトでラップされたリクエストオブジェクトへの呼び出しを実行します。
HttpServletRequest
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH
コンストラクターと説明 |
---|
HttpServletRequestWrapper(HttpServletRequest request) 指定されたリクエストをラップするリクエストオブジェクトを構築します。 |
修飾子と型 | メソッドと説明 |
---|---|
boolean | authenticate(HttpServletResponse response) このメソッドのデフォルトの動作は、ラップされたリクエストオブジェクトで認証を呼び出すことです。 |
StringSE | changeSessionId() このメソッドのデフォルトの動作では、ラップされたリクエストオブジェクトの changeSessionId() が返されます。 |
StringSE | getAuthType() このメソッドのデフォルトの動作では、ラップされたリクエストオブジェクトの getAuthType() が返されます。 |
StringSE | getContextPath() このメソッドのデフォルトの動作では、ラップされたリクエストオブジェクトの getContextPath() が返されます。 |
Cookie[] | getCookies() このメソッドのデフォルトの動作では、ラップされたリクエストオブジェクトの getCookies() が返されます。 |
long | getDateHeader(StringSE name) このメソッドのデフォルトの動作は、ラップされたリクエストオブジェクトに getDateHeader(String name) を返すことです。 |
StringSE | getHeader(StringSE name) このメソッドのデフォルトの動作は、ラップされたリクエストオブジェクトに getHeader(String name) を返すことです。 |
EnumerationSE<StringSE> | getHeaderNames() このメソッドのデフォルトの動作では、ラップされたリクエストオブジェクトの getHeaderNames() が返されます。 |
EnumerationSE<StringSE> | getHeaders(StringSE name) このメソッドのデフォルトの動作は、ラップされたリクエストオブジェクトに getHeaders(String name) を返すことです。 |
HttpServletMapping | getHttpServletMapping() このメソッドのデフォルトの動作では、ラップされたリクエストオブジェクトの getServletMapping() が返されます。 |
int | getIntHeader(StringSE name) このメソッドのデフォルトの動作は、ラップされたリクエストオブジェクトに getIntHeader(String name) を返すことです。 |
StringSE | getMethod() このメソッドのデフォルトの動作では、ラップされたリクエストオブジェクトの getMethod() が返されます。 |
Part | getPart(StringSE name) このメソッドのデフォルトの動作は、ラップされたリクエストオブジェクトで getPart を呼び出すことです。 |
CollectionSE<Part> | getParts() このメソッドのデフォルトの動作は、ラップされたリクエストオブジェクトで getParts を呼び出すことです。 |
StringSE | getPathInfo() このメソッドのデフォルトの動作では、ラップされたリクエストオブジェクトの getPathInfo() が返されます。 |
StringSE | getPathTranslated() このメソッドのデフォルトの動作では、ラップされたリクエストオブジェクトの getPathTranslated() が返されます。 |
StringSE | getQueryString() このメソッドのデフォルトの動作では、ラップされたリクエストオブジェクトの getQueryString() が返されます。 |
StringSE | getRemoteUser() このメソッドのデフォルトの動作では、ラップされたリクエストオブジェクトの getRemoteUser() が返されます。 |
StringSE | getRequestedSessionId() このメソッドのデフォルトの動作では、ラップされたリクエストオブジェクトの getRequestedSessionId() が返されます。 |
StringSE | getRequestURI() このメソッドのデフォルトの動作では、ラップされたリクエストオブジェクトの getRequestURI() が返されます。 |
StringBufferSE | getRequestURL() このメソッドのデフォルトの動作では、ラップされたリクエストオブジェクトの getRequestURL() が返されます。 |
StringSE | getServletPath() このメソッドのデフォルトの動作では、ラップされたリクエストオブジェクトの getServletPath() が返されます。 |
HttpSession | getSession() このメソッドのデフォルトの動作では、ラップされたリクエストオブジェクトの getSession() が返されます。 |
HttpSession | getSession(boolean create) このメソッドのデフォルトの動作は、ラップされたリクエストオブジェクトに対して getSession(boolean create) を返すことです。 |
MapSE<StringSE, StringSE> | getTrailerFields() このメソッドのデフォルトの動作は、ラップされたリクエストオブジェクトで getTrailerFields を呼び出すことです。 |
PrincipalSE | getUserPrincipal() このメソッドのデフォルトの動作では、ラップされたリクエストオブジェクトの getUserPrincipal() が返されます。 |
boolean | isRequestedSessionIdFromCookie() このメソッドのデフォルトの動作では、ラップされたリクエストオブジェクトの isRequestedSessionIdFromCookie() が返されます。 |
boolean | isRequestedSessionIdFromUrl() 使用すべきではありません。 Java Servlet API のバージョン 4.0 以降では、代わりに isRequestedSessionIdFromURL() を使用してください。 |
boolean | isRequestedSessionIdFromURL() このメソッドのデフォルトの動作では、ラップされたリクエストオブジェクトの isRequestedSessionIdFromURL() が返されます。 |
boolean | isRequestedSessionIdValid() このメソッドのデフォルトの動作では、ラップされたリクエストオブジェクトの isRequestedSessionIdValid() が返されます。 |
boolean | isTrailerFieldsReady() このメソッドのデフォルトの動作は、ラップされたリクエストオブジェクトで isTrailerFieldsReady を呼び出すことです。 |
boolean | isUserInRole(StringSE role) このメソッドのデフォルトの動作は、ラップされたリクエストオブジェクトで isUserInRole(String role)を返すことです。 |
void | login(StringSE username, StringSE password) このメソッドのデフォルトの動作は、ラップされたリクエストオブジェクトでログインを呼び出すことです。 |
void | logout() このメソッドのデフォルトの動作は、ラップされたリクエストオブジェクトでログインを呼び出すことです。 |
PushBuilder | newPushBuilder() このメソッドのデフォルトの動作は、ラップされたリクエストオブジェクトで newPushBuilder を呼び出すことです。 |
<T extends HttpUpgradeHandler> | upgrade(ClassSE<T> handlerClass) 指定されたクラスの HttpUpgradeHandler のインスタンスを作成し、http プロトコルのアップグレード処理に使用します。 |
getAsyncContext, getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentLengthLong, getContentType, getDispatcherType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequest, getRequestDispatcher, getScheme, getServerName, getServerPort, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, isWrapperFor, isWrapperFor, removeAttribute, setAttribute, setCharacterEncoding, setRequest, startAsync, startAsync
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE
getAsyncContext, getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentLengthLong, getContentType, getDispatcherType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getScheme, getServerName, getServerPort, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, removeAttribute, setAttribute, setCharacterEncoding, startAsync, startAsync
public HttpServletRequestWrapper(HttpServletRequest request)
request
- ラップされる HttpServletRequest
。IllegalArgumentExceptionSE
- リクエストが null の場合 public StringSE getAuthType()
HttpServletRequest
の getAuthType
null
public Cookie[] getCookies()
HttpServletRequest
の getCookies
Cookies
の配列、またはリクエストに Cookie がない場合は null
public long getDateHeader(StringSE name)
HttpServletRequest
の getDateHeader
name
- ヘッダーの名前を指定する String
long
値、または名前付きヘッダーがリクエストに含まれていない場合は -1public StringSE getHeader(StringSE name)
HttpServletRequest
の getHeader
name
- ヘッダー名を指定する String
String
、またはリクエストにその名前のヘッダーがない場合は null
public EnumerationSE<StringSE> getHeaders(StringSE name)
HttpServletRequest
の getHeaders
name
- ヘッダー名を指定する String
Enumeration
リクエストにその名前のヘッダーがない場合、空の列挙を返します。コンテナーがヘッダー情報へのアクセスを許可しない場合、null を返します public EnumerationSE<StringSE> getHeaderNames()
HttpServletRequest
の getHeaderNames
null
public int getIntHeader(StringSE name)
HttpServletRequest
の getIntHeader
name
- リクエストヘッダーの名前を指定する String
public HttpServletMapping getHttpServletMapping()
このメソッドのデフォルトの動作では、ラップされたリクエストオブジェクトの getServletMapping() が返されます。
HttpServletRequest
の getHttpServletMapping
HttpServletMapping
のインスタンス。public StringSE getMethod()
HttpServletRequest
の getMethod
String
public StringSE getPathInfo()
HttpServletRequest
の getPathInfo
String
。リクエスト URL 内のサーブレットパスの後、クエリ文字列の前にある追加のパス情報を指定します。または、URL に追加のパス情報がない場合は null
public StringSE getPathTranslated()
HttpServletRequest
の getPathTranslated
String
、または URL に追加のパス情報がない場合は null
public StringSE getContextPath()
HttpServletRequest
の getContextPath
String
ServletContext.getContextPath()
public StringSE getQueryString()
HttpServletRequest
の getQueryString
String
または URL にクエリ文字列が含まれていない場合は null
値はコンテナーによってデコードされません。public StringSE getRemoteUser()
HttpServletRequest
の getRemoteUser
String
、またはユーザーのログインが不明な場合は null
public boolean isUserInRole(StringSE role)
HttpServletRequest
の isUserInRole
role
- ロールの名前を指定する String
boolean
。ユーザーが認証されていない場合、false
public PrincipalSE getUserPrincipal()
HttpServletRequest
の getUserPrincipal
java.security.Principal
。ユーザーが認証されていない場合、null
public StringSE getRequestedSessionId()
HttpServletRequest
の getRequestedSessionId
String
、またはリクエストがセッション ID を指定しなかった場合は null
HttpServletRequest.isRequestedSessionIdValid()
public StringSE getRequestURI()
HttpServletRequest
の getRequestURI
String
HttpUtils.getRequestURL(javax.servlet.http.HttpServletRequest)
public StringBufferSE getRequestURL()
HttpServletRequest
の getRequestURL
StringBuffer
オブジェクト public StringSE getServletPath()
HttpServletRequest
の getServletPath
String
、デコード、リクエストの処理に使用されるサーブレットが "/*" パターンを使用して一致する場合は空の文字列。public HttpSession getSession(boolean create)
HttpServletRequest
の getSession
create
- 必要に応じて、このリクエストの新しいセッションを作成する true
。現在のセッションがない場合に null
を返す false
HttpSession
または create
が false
でリクエストに有効なセッションがない場合は null
HttpServletRequest.getSession()
public HttpSession getSession()
HttpServletRequest
の getSession
HttpSession
HttpServletRequest.getSession(boolean)
public StringSE changeSessionId()
HttpServletRequest
の changeSessionId
public boolean isRequestedSessionIdValid()
HttpServletRequest
の isRequestedSessionIdValid
true
。それ以外の場合は false
HttpServletRequest.getRequestedSessionId()
, HttpServletRequest.getSession(boolean)
, HttpSessionContext
public boolean isRequestedSessionIdFromCookie()
HttpServletRequest
の isRequestedSessionIdFromCookie
true
。それ以外の場合、false
HttpServletRequest.getSession(boolean)
public boolean isRequestedSessionIdFromURL()
HttpServletRequest
の isRequestedSessionIdFromURL
true
。それ以外の場合、false
HttpServletRequest.getSession(boolean)
@DeprecatedSE public boolean isRequestedSessionIdFromUrl()
isRequestedSessionIdFromURL()
を使用してください。HttpServletRequest
の isRequestedSessionIdFromUrl
true
。それ以外の場合、false
public boolean authenticate(HttpServletResponse response) throws IOExceptionSE, ServletException
HttpServletRequest
の authenticate
response
- この HttpServletRequest
に関連付けられた HttpServletResponse
getUserPrincipal
、getRemoteUser
、getAuthType
によって返される値として確立された、または確立された場合の true
。認証が不完全で、基盤となるログインメカニズムがレスポンスで、ユーザーに返されるメッセージ(チャレンジなど)と HTTP ステータスコードをコミットした場合は、false
を返します。IOExceptionSE
- このリクエストからの読み取り中または指定されたレスポンスへの書き込み中に入力または出力エラーが発生した場合 ServletException
- 認証が失敗し、呼び出し元がエラーを処理する責任がある場合 (すなわち、基礎となるログインメカニズムは、ユーザーに返されるメッセージと HTTP ステータスコードを確立しませんでした)public void login(StringSE username, StringSE password) throws ServletException
HttpServletRequest
の login
username
- ユーザーのログイン ID に対応する String
値。password
- 識別されたユーザーに対応するパスワード String
。ServletException
- 構成されたログインメカニズムがユーザー名パスワード認証をサポートしていない場合、または null 以外の発信者 ID がすでに確立されている場合(ログイン呼び出しの前)、または提供されたユーザー名とパスワードの検証が失敗した場合 public void logout() throws ServletException
HttpServletRequest
の logout
ServletException
- ログアウトに失敗した場合 public CollectionSE<Part> getParts() throws IOExceptionSE, ServletException
返された Collection
に対する変更は、この HttpServletRequestWrapper
に影響してはなりません。
HttpServletRequest
の getParts
Part
コンポーネントの(おそらく空の) Collection
IOExceptionSE
- このリクエストの Part
コンポーネントの取得中に I/O エラーが発生した場合 ServletException
- このリクエストが型 multipart/form-data
でない場合 MultipartConfig.maxFileSize()
, MultipartConfig.maxRequestSize()
public Part getPart(StringSE name) throws IOExceptionSE, ServletException
HttpServletRequest
の getPart
name
- リクエストされた Part
の名前 Part
、またはリクエスト型が multipart/form-data
でも Part
が含まれていない場合は null
IOExceptionSE
- リクエストされた Part
の取得中に I/O エラーが発生した場合 ServletException
- このリクエストが型 multipart/form-data
でない場合 MultipartConfig.maxFileSize()
, MultipartConfig.maxRequestSize()
public <T extends HttpUpgradeHandler> T upgrade(ClassSE<T> handlerClass) throws IOExceptionSE, ServletException
HttpUpgradeHandler
のインスタンスを作成し、http プロトコルのアップグレード処理に使用します。HttpServletRequest
の upgrade
T
- handlerClass
の HttpUpgradeHandler
を継承する Class
。handlerClass
- アップグレードに使用される HttpUpgradeHandler
クラス。HttpUpgradeHandler
のインスタンス IOExceptionSE
- アップグレード中に I/O エラーが発生した場合 ServletException
- 指定された handlerClass
のインスタンス化に失敗した場合 HttpUpgradeHandler
, WebConnection
public PushBuilder newPushBuilder()
HttpServletRequest
の newPushBuilder
PushBuilder
。プッシュがサポートされていない場合は nullpublic MapSE<StringSE,StringSE> getTrailerFields()
HttpServletRequest
の getTrailerFields
HttpServletRequest.isTrailerFieldsReady()
が true を返している場合、空のマップが返されます。public boolean isTrailerFieldsReady()
HttpServletRequest
の isTrailerFieldsReady
Copyright © 2019 Eclipse Foundation.
Use is subject to license terms.