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)
このメソッドのデフォルトの動作はラップされたリクエストオブジェクトのauthenticateを呼び出すことです。
|
String |
changeSessionId()
このメソッドのデフォルトの動作はラップされたリクエストオブジェクトのchangeSessionId()を返すことです。
|
String |
getAuthType()
このメソッドのデフォルトの動作はラップされたリクエストオブジェクトのgetAuthType()を返すことです。
|
String |
getContextPath()
このメソッドのデフォルトの動作はラップされたリクエストオブジェクトのgetContextPath()を返すことです。
|
Cookie[] |
getCookies()
このメソッドのデフォルトの動作はラップされたリクエストオブジェクトのgetCookies()を返すことです。
|
long |
getDateHeader(String name)
このメソッドのデフォルトの動作はラップされたリクエストオブジェクトのgetDateHeader(String name)を返すことです。
|
String |
getHeader(String name)
このメソッドのデフォルトの動作はラップされたリクエストオブジェクトのgetHeader(String name)を返すことです。
|
Enumeration<String> |
getHeaderNames()
このメソッドのデフォルトの動作はラップされたリクエストオブジェクトのgetHeaderNames()を返すことです。
|
Enumeration<String> |
getHeaders(String name)
このメソッドのデフォルトの動作はラップされたリクエストオブジェクトのgetHeaders(String name)を返すことです。
|
HttpServletMapping |
getHttpServletMapping()
このメソッドのデフォルトの動作はラップされたリクエストオブジェクトのgetServletMapping()を返すことです。
|
int |
getIntHeader(String name)
このメソッドのデフォルトの動作はラップされたリクエストオブジェクトの getIntHeader(String name)を返すことです。
|
String |
getMethod()
このメソッドのデフォルトの動作はラップされたリクエストオブジェクトのgetMethod()を返すことです。
|
Part |
getPart(String name)
このメソッドのデフォルトの動作はラップされたリクエストオブジェクトのgetPartを呼び出すことです。
|
Collection<Part> |
getParts()
このメソッドのデフォルトの動作はラップされたリクエストオブジェクトのgetPartsを呼び出すことです。
|
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)を返すことです。
|
Map<String,String> |
getTrailerFields()
このメソッドのデフォルトの動作はラップされたリクエストオブジェクトのgetTrailerFieldsを呼び出すことです。
|
Principal |
getUserPrincipal()
このメソッドのデフォルトの動作はラップされたリクエストオブジェクトのgetUserPrincipal()を返すことです。
|
boolean |
isRequestedSessionIdFromCookie()
このメソッドのデフォルトの動作はラップされたリクエストオブジェクトのisRequestedSessionIdFromCookie()を返すことです。
|
boolean |
isRequestedSessionIdFromUrl()
非推奨です。
Java Servlet API の Version 4.0 からは代わりに
isRequestedSessionIdFromURL() を使用してください |
boolean |
isRequestedSessionIdFromURL()
このメソッドのデフォルトの動作はラップされたリクエストオブジェクトのisRequestedSessionIdFromURL()を返すことです。
|
boolean |
isRequestedSessionIdValid()
このメソッドのデフォルトの動作はラップされたリクエストオブジェクトのisRequestedSessionIdValid()を返すことです。
|
boolean |
isTrailerFieldsReady()
このメソッドのデフォルトの動作はラップされたリクエストオブジェクトのisTrailerFieldsReadyを呼び出すことです。
|
boolean |
isUserInRole(String role)
このメソッドのデフォルトの動作はラップされたリクエストオブジェクトのisUserInRole(String role)を返すことです。
|
void |
login(String username,
String password)
このメソッドのデフォルトの動作はラップされたリクエストオブジェクトのloginを呼び出すことです。
|
void |
logout()
このメソッドのデフォルトの動作はラップされたリクエストオブジェクトのlogoutを呼び出すことです。
|
PushBuilder |
newPushBuilder()
このメソッドのデフォルトの動作はラップされたリクエストオブジェクトのnewPushBuilderを呼び出すことです。
|
<T extends HttpUpgradeHandler> |
upgrade(Class<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
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
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
IllegalArgumentException
- requestがnullpublic String getAuthType()
getAuthType
インタフェース内 HttpServletRequest
public Cookie[] getCookies()
getCookies
インタフェース内 HttpServletRequest
Cookie
オブジェクトを含む配列、送信されたCookieがない場合はnull
public long getDateHeader(String name)
getDateHeader
インタフェース内 HttpServletRequest
name
- ヘッダーの名前を指定するString
long
値、リクエストのヘッダーに名前が含まれない場合は-1public String getHeader(String name)
getHeader
インタフェース内 HttpServletRequest
name
- ヘッダー名を指定する名前のString
String
、リクエストのヘッダーがその名前を持たない場合はnull
public Enumeration<String> getHeaders(String name)
getHeaders
インタフェース内 HttpServletRequest
name
- ヘッダーの名前を示す String
public Enumeration<String> getHeaderNames()
getHeaderNames
インタフェース内 HttpServletRequest
public int getIntHeader(String name)
getIntHeader
インタフェース内 HttpServletRequest
name
- ヘッダーの名前を示す String
public HttpServletMapping getHttpServletMapping()
getHttpServletMapping
インタフェース内 HttpServletRequest
HttpServletMapping
のインスタンスpublic String getMethod()
getMethod
インタフェース内 HttpServletRequest
String
public String getPathInfo()
getPathInfo
インタフェース内 HttpServletRequest
String
、URLに拡張パス情報がない場合はnull
public String getPathTranslated()
getPathTranslated
インタフェース内 HttpServletRequest
String
、URLに拡張パスの情報がない場合はnull
public String getContextPath()
getContextPath
インタフェース内 HttpServletRequest
String
ServletContext.getContextPath()
public String getQueryString()
getQueryString
インタフェース内 HttpServletRequest
String
、URLにクエリ文字列が含まれない場合はnull
、この値はコンテナによってデコードされないpublic String getRemoteUser()
getRemoteUser
インタフェース内 HttpServletRequest
String
、ユーザーのログイン名が不明な場合はnull
public boolean isUserInRole(String role)
isUserInRole
インタフェース内 HttpServletRequest
role
- ロールの名前を示すString
boolean
、ユーザーが認証されていない場合はfalse
public Principal getUserPrincipal()
getUserPrincipal
インタフェース内 HttpServletRequest
java.security.Principal
、ユーザーが認証されていない場合はnull
public String getRequestedSessionId()
getRequestedSessionId
インタフェース内 HttpServletRequest
String
、リクエストがセッションIDを指定しない場合はnull
HttpServletRequest.isRequestedSessionIdValid()
public String getRequestURI()
getRequestURI
インタフェース内 HttpServletRequest
String
HttpUtils.getRequestURL(javax.servlet.http.HttpServletRequest)
public StringBuffer getRequestURL()
getRequestURL
インタフェース内 HttpServletRequest
StringBuffer
のオブジェクトpublic String getServletPath()
getServletPath
インタフェース内 HttpServletRequest
String
がデコードされたもの、リクエストの処理に使用されたサーブレットが"/*"パターンを使用して一致した場合は空の文字列public HttpSession getSession(boolean create)
getSession
インタフェース内 HttpServletRequest
create
- true
の場合、必要に応じてこのリクエストのために新しいセッションを作成する、false
の場合、現在のセッションが存在しない場合はnull
を返すHttpSession
、create
がfalse
でリクエストが有効なセッションを持っていない場合はnull
HttpServletRequest.getSession()
public HttpSession getSession()
getSession
インタフェース内 HttpServletRequest
HttpSession
HttpServletRequest.getSession(boolean)
public String changeSessionId()
changeSessionId
インタフェース内 HttpServletRequest
public boolean isRequestedSessionIdValid()
isRequestedSessionIdValid
インタフェース内 HttpServletRequest
true
、そうでない場合はfalse
HttpServletRequest.getRequestedSessionId()
,
HttpServletRequest.getSession(boolean)
,
HttpSessionContext
public boolean isRequestedSessionIdFromCookie()
isRequestedSessionIdFromCookie
インタフェース内 HttpServletRequest
true
、そうでない場合はfalse
HttpServletRequest.getSession(boolean)
public boolean isRequestedSessionIdFromURL()
isRequestedSessionIdFromURL
インタフェース内 HttpServletRequest
true
、そうでない場合はfalse
HttpServletRequest.getSession(boolean)
@Deprecated public boolean isRequestedSessionIdFromUrl()
isRequestedSessionIdFromURL()
を使用してくださいisRequestedSessionIdFromUrl
インタフェース内 HttpServletRequest
true
、そうでない場合はfalse
public boolean authenticate(HttpServletResponse response) throws IOException, ServletException
authenticate
インタフェース内 HttpServletRequest
response
- このHttpServletRequest
に関連するHttpServletResponse
getUserPrincipal
とgetRemoteUser
、getAuthType
によって返される値としてnull以外の値が設定されている場合にtrue
、
認証が不完全で、基礎となるログインメカニズムがメッセージ(例えばチャレンジ)とHTTPステータスコードをユーザーへのレスポンスとして返す場合はfalse
IOException
- このリクエストからの読み取り中または指定されたレスポンスへの書き込み中に入出力エラーが発生した場合ServletException
- 認証に失敗し、呼び出し側がエラーの処理を担当している場合(つまり基礎となるログインメカニズムでメッセージとHTTPステータスコードをユーザーに返すように設定していない場合)public void login(String username, String password) throws ServletException
login
インタフェース内 HttpServletRequest
username
- ユーザーのログイン識別子に対応するString
の値password
- 識別されたユーザーに対応するパスワードのString
ServletException
- 設定されたログインメカニズムがユーザ名とパスワードの認証をサポートしていない場合、
またはnull以外の呼び出し元認証情報が(ログインの前に)すでに設定されている場合、
または指定されたユーザ名とパスワードの検証に失敗した場合public void logout() throws ServletException
logout
インタフェース内 HttpServletRequest
ServletException
- ログアウトに失敗したpublic Collection<Part> getParts() throws IOException, ServletException
返されたCollection
へのいかなる変更もこのHttpServletRequestWrapper
に影響を与えてはいけません。
getParts
インタフェース内 HttpServletRequest
Part
要素の(空の可能性のある)Collection
IOException
- このリクエストのPart
要素の取得中にI/Oエラーが発生した場合ServletException
- このリクエストがmultipart/form-data
でない場合MultipartConfig.maxFileSize()
,
MultipartConfig.maxRequestSize()
public Part getPart(String name) throws IOException, ServletException
getPart
インタフェース内 HttpServletRequest
name
- 要求するPart
の名前Part
、このリクエストがmultipart/form-data
だけど要求されたPart
が含まれてない場合はnull
IOException
- 要求されたPart
の取得中にI/Oエラーが発生した場合ServletException
- このリクエストがmultipart/form-data
でない場合MultipartConfig.maxFileSize()
,
MultipartConfig.maxRequestSize()
public <T extends HttpUpgradeHandler> T upgrade(Class<T> handlerClass) throws IOException, ServletException
HttpUpgradeHandler
のインスタンスを作成し、httpプロトコルのアップグレードプロセスに使用します。upgrade
インタフェース内 HttpServletRequest
T
- handlerClass
のHttpUpgradeHandler
を拡張するClass
handlerClass
- アップグレードに使用するHttpUpgradeHandler
HttpUpgradeHandler
のインスタンスIOException
- アップグレード中にI/Oエラーが発生したServletException
- 与えられたhandlerClass
のインスタンス化に失敗したHttpUpgradeHandler
,
WebConnection
public PushBuilder newPushBuilder()
newPushBuilder
インタフェース内 HttpServletRequest
PushBuilder
、プッシュがサポートされていない場合はnullpublic Map<String,String> getTrailerFields()
getTrailerFields
インタフェース内 HttpServletRequest
HttpServletRequest.isTrailerFieldsReady()
がtrueを返す場合は空のMapを返すpublic boolean isTrailerFieldsReady()
isTrailerFieldsReady
インタフェース内 HttpServletRequest
Copyright © 1999-2017, Oracle and/or its affiliates. All Rights Reserved. Use is subject to license terms. Portions Copyright © 1999-2002 The Apache Software Foundation. Portions Copyright © 2017- @megascus. Translated by @megascus.