HttpServletRequest (Java Servlet 4.0)

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

ServletRequest

既知の実装クラスのリスト:

HttpServletRequestWrapper
```
public interface HttpServletRequest
extends ServletRequest
```
ServletRequestを拡張してHTTPサーブレットのためのリクエストの情報を提供します。
サーブレットコンテナはHttpServletRequestを作成してサーブレットのservice(doGet、doPost、など)メソッドの引数として渡します。

作成者:

Various

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`static String`	`BASIC_AUTH` ベーシック認証のための識別文字列です。
`static String`	`CLIENT_CERT_AUTH` クライアント証明書認証のための識別文字列です。
`static String`	`DIGEST_AUTH` ダイジェスト認証のための識別文字列です。
`static String`	`FORM_AUTH` フォーム認証のための識別文字列です。

メソッドのサマリー

すべてのメソッドインスタンス・メソッド abstractメソッドデフォルト・メソッド非推奨のメソッド
修飾子とタイプ	メソッドと説明
`boolean`	`authenticate(HttpServletResponse response)` `ServletContext`用に設定されたコンテナログインメカニズムを使用して、このリクエストを行うユーザーを認証します。
`String`	`changeSessionId()` このリクエストに関連付けられている現在のセッションのセッションIDを変更し、新しいセッションIDを返します。
`String`	`getAuthType()` サーブレットを保護するために使用される認証方式の名前を返します。
`String`	`getContextPath()` リクエストURIからリクエストのコンテキストを示す部分を返します。
`Cookie[]`	`getCookies()` このリクエストでクライアントが送信したすべての`Cookie`オブジェクトを含む配列を返します。
`long`	`getDateHeader(String name)` リクエストヘッダーの指定された値の`Date`オブジェクトを表す`long` 値を返します。
`String`	`getHeader(String name)` リクエストヘッダーの指定された値を`String`として返します。
`Enumeration<String>`	`getHeaderNames()` リクエストに含まれるすべてのヘッダーの名前のEnumerationを返します。
`Enumeration<String>`	`getHeaders(String name)` リクエストヘッダーの指定された値を`String`オブジェクトの`Enumeration`として返します。
`default HttpServletMapping`	`getHttpServletMapping()` この`HttpServletRequest`が呼び出された`HttpServlet`の`HttpServletMapping`を返します。
`int`	`getIntHeader(String name)` リクエストヘッダーの指定された値を`int`として返します。
`String`	`getMethod()` リクエストが行われたHTTPのメソッドの名前を返します。
`Part`	`getPart(String name)` 与えられた名前で`Part`を取得します。
`Collection<Part>`	`getParts()` `multipart/form-data`によって提供されるこのリクエストのすべての`Part`要素を取得します。
`String`	`getPathInfo()` このリクエストを行ったときにクライアントが送信したURLに関連付けられた拡張パス情報を返します。
`String`	`getPathTranslated()` サーブレット名の後ろからクエリ文字列の前の拡張パス情報を実際のパスに変換したものを返します。
`String`	`getQueryString()` リクエストURLからパスの後に含まれるクエリ文字列を返します。
`String`	`getRemoteUser()` ユーザーが認証されている場合にこのリクエストを行うユーザーのログイン名を返します。
`String`	`getRequestedSessionId()` クライアントによって指定されたセッションIDを返します。
`String`	`getRequestURI()` このリクエストのURLのうち、プロトコル名からHTTPリクエストの最初の行のクエリ文字列までの部分を返します。
`StringBuffer`	`getRequestURL()` クライアントがリクエストに使用したURLを再構成します。
`String`	`getServletPath()` サーブレットを呼び出すこのリクエストのURLの一部を返します。
`HttpSession`	`getSession()` このリクエストに関連付けられている現在のセッションを返します。
`HttpSession`	`getSession(boolean create)` このリクエストに関連付けられている現在の`HttpSession`を返します。
`default Map<String,String>`	`getTrailerFields()` リクエストのトレーラーフィールドを取得します。
`Principal`	`getUserPrincipal()` 現在の認証されたユーザの名前を含む`java.security.Principal`のオブジェクトを返します。
`boolean`	`isRequestedSessionIdFromCookie()` 要求されたセッションIDがHTTP Cookieとしてサーバーに送信されたかどうかを確認します。
`boolean`	`isRequestedSessionIdFromUrl()` 非推奨です。 Java Servlet API Version 2.1 から`isRequestedSessionIdFromURL()`に置き換えられました。
`boolean`	`isRequestedSessionIdFromURL()` 要求されたセッションIDがリクエストURLの一部としてサーバーに送信されたかどうかを確認します。
`boolean`	`isRequestedSessionIdValid()` 要求されたセッションIDがまだ有効かどうかを確認します。
`default boolean`	`isTrailerFieldsReady()` トレーラーフィールドが`getTrailerFields()`を使用して読み込み可能かどうかを示すbooleanを返します。
`boolean`	`isUserInRole(String role)` 認証されたユーザが指定された論理的な"ロール"に含まれているかどうかを示すbooleanを返します。
`void`	`login(String username, String password)` 提供されたユーザ名とパスワードを`ServletContext`用に設定されたウェブコンテナログインメカニズムによって使用されるパスワード検証機構で検証します。
`void`	`logout()` リクエストで`getUserPrincipal`、`getRemoteUser`、`getAuthType`が呼び出されたときに返される値として`null`を設定します。
`default PushBuilder`	`newPushBuilder()` 現在のリクエストからサーバープッシュレスポンスを発行するための`PushBuilder`の新しいインスタンスを作成します。
`<T extends HttpUpgradeHandler> T`	`upgrade(Class<T> handlerClass)` 指定されたクラスで`HttpUpgradeHandler`のインスタンスを作成し、httpプロトコルのアップグレードプロセスに使用します。

インタフェースから継承されたメソッド javax.servlet.ServletRequest
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

- フィールドの詳細
  - BASIC_AUTH
```
static final String BASIC_AUTH
```
    ベーシック認証のための識別文字列です。 "BASIC"
    
    関連項目:
    
    定数フィールド値
  - FORM_AUTH
```
static final String FORM_AUTH
```
    フォーム認証のための識別文字列です。 "FORM"
    
    関連項目:
    
    定数フィールド値
  - CLIENT_CERT_AUTH
```
static final String CLIENT_CERT_AUTH
```
    クライアント証明書認証のための識別文字列です。 "CLIENT_CERT"
    
    関連項目:
    
    定数フィールド値
  - DIGEST_AUTH
```
static final String DIGEST_AUTH
```
    ダイジェスト認証のための識別文字列です。 "DIGEST"
    
    関連項目:
    
    定数フィールド値
- メソッドの詳細
  - getAuthType
```
String getAuthType()
```
    サーブレットを保護するために使用される認証方式の名前を返します。すべてのサーブレットコンテナは、ベーシック認証、フォーム認証およびクライアントの証明書認証をサポートしており、さらにダイジェスト認証をサポートしているかもしれません。サーブレットが認証されていない場合はnullを返します。
    CGIの変数AUTH_TYPEの値と同じです。
    訳注：CGIはサーブレットが生まれる前にあったウェブアプリケーションを作るための仕組みです。現在はほぼ使われていません。
    
    戻り値:
    
    静的メンバー変数BASIC_AUTH、FORM_AUTH、CLIENT_CERT_AUTH、DIGEST_AUTH(==で比較もできる)のうちの一つ、または認証スキームを示すコンテナ固有の文字列のいずれか、リクエストが認証されなかった場合はnull
  - getCookies
```
Cookie[] getCookies()
```
    このリクエストでクライアントが送信したすべてのCookieオブジェクトを含む配列を返します。このメソッドは、送信されたCookieがない場合はnullを返します。
    
    戻り値:
    
    このリクエストでクライアントが送信したすべてのCookieオブジェクトを含む配列、送信されたCookieがない場合はnull
  - getDateHeader
```
long getDateHeader(String name)
```
    リクエストヘッダーの指定された値のDateオブジェクトを表すlong 値を返します。このメソッドはIf-Modified-Sinceのような日付を含むヘッダーに使用します。
    返される日付は1970 年 1 月 1 日 00:00:00 GMT からのミリ秒数です。ヘッダー名は大文字小文字を区別しません。
    リクエストのヘッダーに指定された名前が存在しない場合はこのメソッドは-1を返します。もしヘッダーを日付に変換できない場合、このメソッドはIllegalArgumentExceptionを投げます。
    
    パラメータ:
    
    name - ヘッダーの名前を指定するString
    
    戻り値:
    
    指定されたヘッダーの日付の1970 年 1 月 1 日 00:00:00 GMT からのミリ秒数を表すlong値、リクエストのヘッダーに名前が含まれない場合は-1
    
    例外:
    
    IllegalArgumentException - ヘッダーの値を日付に変換できなかった
  - getHeader
```
String getHeader(String name)
```
    リクエストヘッダーの指定された値をStringとして返します。リクエストが指定された名前のヘッダーを含まない場合はnullを返します。もしヘッダーに同じ名前で複数の値が含まれていた場合、このメソッドはリクエストの最初のヘッダーを返します。ヘッダー名は大文字小文字を区別しません。このメソッドは任意のリクエストヘッダーに対して使用できます。
    
    パラメータ:
    
    name - ヘッダー名を指定する名前のString
    
    戻り値:
    
    リクエストのヘッダーの値を含むString、リクエストのヘッダーがその名前を持たない場合はnull
  - getHeaders
```
Enumeration<String> getHeaders(String name)
```
    リクエストヘッダーの指定された値をStringオブジェクトのEnumerationとして返します。
    Accept-Languageのようないくつかのヘッダーはクライアントからカンマで区切られたリストとして送信されるのではなく、異なる値を持つ複数のヘッダーとして送信されます。
    リクエストに指定した名前のヘッダーが含まれない場合はこのメソッドは空のEnumerationを返します。ヘッダー名は大文字小文字を区別しません。このメソッドは任意のリクエストヘッダーに対して使用できます。
    
    パラメータ:
    
    name - ヘッダーの名前を示す String
    
    戻り値:
    
    要求されたヘッダーの値を含むEnumeration、リクエストにその名前のヘッダーがない場合は空のEnumeration、コンテナがヘッダー情報へのアクセスを許可しない場合はnull
  - getHeaderNames
```
Enumeration<String> getHeaderNames()
```
    リクエストに含まれるすべてのヘッダーの名前のEnumerationを返します。リクエストにヘッダーがない場合はこのメソッドは空のEnumerationを返します。
    サーブレットコンテナによってはサーブレットはこのメソッドを使用してヘッダーにアクセスすることを許されていません。その場合このメソッドはnullを返します。
    
    戻り値:
    
    このリクエストで送られたすべてのヘッダ名のEnumeration、リクエストにヘッダーがない場合は空のEnumeration、サーブレットコンテナがサーブレットでこのメソッドの使用を許可しない場合はnull
  - getIntHeader
```
int getIntHeader(String name)
```
    リクエストヘッダーの指定された値をintとして返します。
    リクエストのヘッダーに指定された名前が存在しない場合はこのメソッドは-1を返します。ヘッダーを整数に変換できない場合、このメソッドはNumberFormatExceptionを投げます。
    ヘッダー名は大文字小文字を区別しません。
    
    パラメータ:
    
    name - ヘッダーの名前を示す String
    
    戻り値:
    
    リクエストヘッダーの値を表す整数、リクエストのヘッダーに名前が含まれない場合は-1
    
    例外:
    
    NumberFormatException - ヘッダーの値をintに変換できなかった
  - getHttpServletMapping
```
default HttpServletMapping getHttpServletMapping()
```
    このHttpServletRequestが呼び出されたHttpServletのHttpServletMappingを返します。該当するFilterのマッピングは結果に表示されません。現在のアクティブなServlet呼び出しが、ServletRequest.getRequestDispatcher(java.lang.String)後のRequestDispatcher.forward(javax.servlet.ServletRequest, javax.servlet.ServletResponse)の呼び出しによって行われた場合、返されるHttpServletMappingはRequestDispatcherを取得するために使用されたパスに対応します。現在のアクティブなServlet呼び出しが、ServletRequest.getRequestDispatcher(java.lang.String)後のRequestDispatcher.include(javax.servlet.ServletRequest, javax.servlet.ServletResponse)の呼び出しによって行われた場合、返されるHttpServletMappingは呼び出しシーケンスの最初のServletを呼び出す原因となったパスに対応します。現在のアクティブなServlet呼び出しが、AsyncContext.dispatch()の呼び出しによって行われた場合、返されるHttpServletMappingは呼び出しシーケンスの最初のServletを呼び出す原因となったパスに対応します。 HttpServletMappingに関連する追加のリクエストの属性については、RequestDispatcher.FORWARD_MAPPING、 RequestDispatcher.INCLUDE_MAPPING、AsyncContext.ASYNC_MAPPINGを参照してください。現在のアクティブなServlet呼び出しが、ServletContext.getNamedDispatcher(java.lang.String)の呼び出しによって行われた場合、返されたHttpServletMappingはこのリクエストに最後に適用されたマッピングのパスに対応するものです。
    
    返されるオブジェクトは不変です。 Servlet 4.0準拠の実装では、このメソッドをオーバーライドする必要があります。
    
    Implementation Requirements:
    
    デフォルトの実装ではMatchValue、PatternおよびServletNameとしての空の文字列を返し、MappingMatchとしてnullを返すHttpServletMappingが返されます。
    
    戻り値:
    
    現在のリクエストが呼び出された方法を示すHttpServletMappingのインスタンス
    
    導入されたバージョン:
    
    4.0
  - getMethod
```
String getMethod()
```
    リクエストが行われたHTTPのメソッドの名前を返します。たとえば、GETやPOST、PUTです。 CGIの変数REQUEST_METHODの値と同じです。
    訳注：CGIはサーブレットが生まれる前にあったウェブアプリケーションを作るための仕組みです。現在はほぼ使われていません。
    
    戻り値:
    
    リクエストが行われたメソッドの名前を示すString
  - getPathInfo
```
String getPathInfo()
```
    このリクエストを行ったときにクライアントが送信したURLに関連付けられた拡張パス情報を返します。拡張パス情報はサーブレットのパスの後ろからクエリ文字列の前までで"/"文字で始まります。
    このメソッドは拡張パス情報が存在しない場合はnullを返します。
    CGIの変数PATH_INFOの値と同じです。
    訳注：CGIはサーブレットが生まれる前にあったウェブアプリケーションを作るための仕組みです。現在はほぼ使われていません。
    
    戻り値:
    
    ウェブコンテナによってデコードされ、サーブレットパスの後からリクエストURLのクエリ文字列の前までの拡張パス情報を指定するString、URLに拡張パス情報がない場合はnull
  - getPathTranslated
```
String getPathTranslated()
```
    サーブレット名の後ろからクエリ文字列の前の拡張パス情報を実際のパスに変換したものを返します。 CGIの変数PATH_TRANSLATEDの値と同じです。
    URLに拡張パス情報がない場合、このメソッドはnullを返します。サーブレットコンテナは何らかの理由で(ウェブアプリケーションがアーカイブから実行されたときなど)仮想パスを実際のパスに変換できない場合があります。ウェブコンテナはこの文字列をデコードしません。
    訳注：CGIはサーブレットが生まれる前にあったウェブアプリケーションを作るための仕組みです。現在はほぼ使われていません。
    
    戻り値:
    
    実際のパスを示すString、URLに拡張パスの情報がない場合はnull
  - newPushBuilder
```
default PushBuilder newPushBuilder()
```
    現在のリクエストからサーバープッシュレスポンスを発行するためのPushBuilderの新しいインスタンスを作成します。現在の接続がサーバープッシュをサポートしていないか、またはサーバープッシュがSETTINGS_ENABLE_PUSH設定フレーム値0(ゼロ)でクライアントによって無効化されている場合、このメソッドはnullを返します。
    
    Implementation Requirements:
    
    デフォルト実装ではnullを返します。
    
    戻り値:
    
    現在のリクエストからサーバープッシュレスポンスを発行するためのPushBuilder、プッシュがサポートされていない場合はnull
    
    導入されたバージョン:
    
    Servlet 4.0
  - getContextPath
```
String getContextPath()
```
    リクエストURIからリクエストのコンテキストを示す部分を返します。コンテキストパスは常にリクエストURIの最初に来ます。パスは "/"文字で始まりますが、 "/"文字で終わらないパスです。デフォルト(ルート)コンテキストのサーブレットの場合、このメソッドは ""を返します。コンテナはこの文字列をデコードしません。
    サーブレットコンテナが複数のコンテキストパスによってコンテキストに一致する可能性があります。そのような場合、このメソッドはリクエストによって使用される実際のコンテキストパスを返し、それはServletContext.getContextPath()メソッドによって返されるパスと異なる場合があります。 ServletContext.getContextPath()によって返されるコンテキストパスはアプリケーションのプライマリコンテキストパスまたは優先コンテキストパスと見なす必要があります。
    
    戻り値:
    
    リクエストURIからリクエストのコンテキストを示す部分を示す String
    
    関連項目:
    
    ServletContext.getContextPath()
  - getQueryString
```
String getQueryString()
```
    リクエストURLからパスの後に含まれるクエリ文字列を返します。このメソッドは、URLにクエリ文字列がない場合はnullを返します。 CGIの変数QUERY_STRINGの値と同じです。
    訳注：CGIはサーブレットが生まれる前にあったウェブアプリケーションを作るための仕組みです。現在はほぼ使われていません。
    
    戻り値:
    
    クエリ文字列を含むString、URLにクエリ文字列が含まれない場合はnull、この値はコンテナによってデコードされない
  - getRemoteUser
```
String getRemoteUser()
```
    ユーザーが認証されている場合にこのリクエストを行うユーザーのログイン名を返します。ユーザーが認証されていない場合はnullを返します。後続のリクエストごとにユーザー名を送信するかどうかはブラウザと認証タイプに依存します。 CGIの変数REMOTE_USERの値と同じです。
    訳注：CGIはサーブレットが生まれる前にあったウェブアプリケーションを作るための仕組みです。現在はほぼ使われていません。
    
    戻り値:
    
    このリクエストを行ったユーザーのログイン名を示す String、ユーザーのログイン名が不明な場合はnull
  - isUserInRole
```
boolean isUserInRole(String role)
```
    認証されたユーザが指定された論理的な"ロール"に含まれているかどうかを示すbooleanを返します。ロールとロールのメンバーシップはデプロイメントディスクリプタを使用して定義できます。ユーザーが認証されていない場合、このメソッドはfalseを返します。
    ロール名 "*"はisUserInRoleを呼び出す時に引数として使用されるべきではありません。 isUserInRoleの"*"での呼び出しはfalseを返す必要があります。テスト対象のセキュリティロールのロール名が"**"でアプリケーションがロール名が「**」のアプリケーションセキュリティロールを宣言していない場合、 isUserInRoleは、ユーザーが認証されている場合のみtrueを返す必要があります。つまり、getRemoteUser()とgetUserPrincipal()が両方ともnull以外の値を返す場合のみです。それ以外の場合、コンテナはユーザーのアプリケーションロールのメンバーシップを確認する必要があります。
    
    パラメータ:
    
    role - ロールの名前を示すString
    
    戻り値:
    
    このリクエストを行うユーザが指定されたロールに属しているかどうかを示すboolean、ユーザーが認証されていない場合はfalse
  - getUserPrincipal
```
Principal getUserPrincipal()
```
    現在の認証されたユーザの名前を含むjava.security.Principalのオブジェクトを返します。ユーザーが認証されていない場合、このメソッドはnullを返します。
    
    戻り値:
    
    このリクエストを送るユーザの名前を含むjava.security.Principal、ユーザーが認証されていない場合はnull
  - getRequestedSessionId
```
String getRequestedSessionId()
```
    クライアントによって指定されたセッションIDを返します。これはこのリクエストの現在の有効なセッションIDと同じではない可能性があります。クライアントがセッションIDを指定しなかった場合、このメソッドはnullを返します。
    
    戻り値:
    
    指定されたセッションIDのString、リクエストがセッションIDを指定しない場合はnull
    
    関連項目:
    
    isRequestedSessionIdValid()
  - getRequestURI
```
String getRequestURI()
```
    このリクエストのURLのうち、プロトコル名からHTTPリクエストの最初の行のクエリ文字列までの部分を返します。ウェブコンテナはこの文字列をデコードしません。
    例えば：
    
    HTTPリクエストの最初の行戻り値
    POST /some/path.html HTTP/1.1 /some/path.html
    GET http://foo.bar/a.html HTTP/1.0 /a.html
    HEAD /xyz?a=b HTTP/1.1 /xyz
    
    スキームとホストでURLを再構築するには、 HttpUtils.getRequestURL(javax.servlet.http.HttpServletRequest)を使用してください。
    訳注：HttpUtils.getRequestURL(javax.servlet.http.HttpServletRequest)は非推奨なので代替APIのgetRequestURL()を使用してください。
    
    戻り値:
    
    プロトコル名からクエリ文字列までのURLの部分を含むString
    
    関連項目:
    
    HttpUtils.getRequestURL(javax.servlet.http.HttpServletRequest)
  - getRequestURL
```
StringBuffer getRequestURL()
```
    クライアントがリクエストに使用したURLを再構成します。返されるURLには、プロトコルとサーバー名、ポート番号、サーバーパスが含まれますが、クエリ文字列パラメーターは含まれません。
    このリクエストがRequestDispatcher.forward(javax.servlet.ServletRequest, javax.servlet.ServletResponse)を使用して転送された場合、再構築されたURLのサーバーパスはクライアントによって指定されたサーバーパスではなくRequestDispatcherを取得するために使用されたパスを反映しなければいけません。
    このメソッドは文字列ではなくStringBufferを返すので、たとえばクエリパラメータを追加したりとURLを簡単に変更できます。
    このメソッドは、リダイレクトメッセージの作成やエラーの報告に便利です。
    
    戻り値:
    
    再構成されたURLを含むStringBufferのオブジェクト
  - getServletPath
```
String getServletPath()
```
    サーブレットを呼び出すこのリクエストのURLの一部を返します。このパスは"/"文字で始まりサーブレット名またはサーブレットへのパスを含みますが、余分なパス情報やクエリ文字列は含まれません。 CGIの変数SCRIPT_NAMEの値と同じです。
    このメソッドはこのリクエストの処理に使用されたサーブレットが "/*"パターンを使用して一致した場合は空の文字列（""）を返します。
    訳注：CGIはサーブレットが生まれる前にあったウェブアプリケーションを作るための仕組みです。現在はほぼ使われていません。
    
    戻り値:
    
    リクエストURLで指定されている呼び出されるサーブレットの名前またはパスを含むStringがデコードされたもの、リクエストの処理に使用されたサーブレットが"/*"パターンを使用して一致した場合は空の文字列
  - getSession
```
HttpSession getSession(boolean create)
```
    このリクエストに関連付けられている現在のHttpSessionを返します。現在のセッションがなくcreateがtrueの場合は新しいセッションを返します。
    createがfalseで、リクエストに有効なHttpSessionがない場合、このメソッドはnullを返します。
    セッションが正しく維持されていることを確認するにはレスポンスがコミットされる前にこのメソッドを呼び出す必要があります。コンテナがセッションの整合性を維持するためにCookieを使用しており、レスポンスがコミットされた後に新しいセッションを作成するよう要求された場合はIllegalStateExceptionが投げられます。
    
    パラメータ:
    
    create - trueの場合、必要に応じてこのリクエストのために新しいセッションを作成する、falseの場合、現在のセッションが存在しない場合はnullを返す
    
    戻り値:
    
    このリクエストに関連付けられているHttpSession、createがfalseでリクエストが有効なセッションを持っていない場合はnull
    
    関連項目:
    
    getSession()
  - getSession
```
HttpSession getSession()
```
    このリクエストに関連付けられている現在のセッションを返します。リクエストがセッションを持たない場合はセッションを作成します。
    
    戻り値:
    
    このリクエストに関連付けられているHttpSession
    
    関連項目:
    
    getSession(boolean)
  - changeSessionId
```
String changeSessionId()
```
    このリクエストに関連付けられている現在のセッションのセッションIDを変更し、新しいセッションIDを返します。
    
    戻り値:
    
    新しいセッションID
    
    例外:
    
    IllegalStateException - リクエストに関連付けられたセッションが存在しない
    
    導入されたバージョン:
    
    Servlet 3.1
  - isRequestedSessionIdValid
```
boolean isRequestedSessionIdValid()
```
    要求されたセッションIDがまだ有効かどうかを確認します。
    クライアントがセッションIDを指定しなかった場合、このメソッドはfalseを返します。
    
    戻り値:
    
    このリクエストが現在のセッションコンテキスト内の有効なセッションのIDを持っている場合はtrue、そうでない場合はfalse
    
    関連項目:
    
    getRequestedSessionId(), getSession(boolean), HttpSessionContext
  - isRequestedSessionIdFromCookie
```
boolean isRequestedSessionIdFromCookie()
```
    要求されたセッションIDがHTTP Cookieとしてサーバーに送信されたかどうかを確認します。
    
    戻り値:
    
    セッションIDがHTTP Cookieとしてサーバーに送信された場合はtrue、そうでない場合はfalse
    
    関連項目:
    
    getSession(boolean)
  - isRequestedSessionIdFromURL
```
boolean isRequestedSessionIdFromURL()
```
    要求されたセッションIDがリクエストURLの一部としてサーバーに送信されたかどうかを確認します。
    
    戻り値:
    
    セッションIDがリクエストURLの一部としてサーバーに送信された場合はtrue、そうでない場合はfalse
    
    関連項目:
    
    getSession(boolean)
  - isRequestedSessionIdFromUrl
```
@Deprecated
boolean isRequestedSessionIdFromUrl()
```
    非推奨です。 Java Servlet API Version 2.1 からisRequestedSessionIdFromURL()に置き換えられました。
    
    戻り値:
    
    セッションIDがリクエストURLの一部としてサーバーに送信された場合はtrue、そうでない場合はfalse
  - authenticate
```
boolean authenticate(HttpServletResponse response)
              throws IOException,
                     ServletException
```
    ServletContext用に設定されたコンテナログインメカニズムを使用して、このリクエストを行うユーザーを認証します。
    このメソッドは引数のHttpServletResponseを変更してコミットするかもしれません。
    
    パラメータ:
    
    response - このHttpServletRequestに関連するHttpServletResponse
    
    戻り値:
    
    getUserPrincipalとgetRemoteUser、getAuthTypeによって返される値としてnull以外の値が設定されている場合にtrue、認証が不完全で、基礎となるログインメカニズムがメッセージ（例えばチャレンジ）とHTTPステータスコードをユーザーへのレスポンスとして返す場合はfalse
    
    例外:
    
    IOException - このリクエストからの読み取り中または指定されたレスポンスへの書き込み中に入出力エラーが発生した場合
    
    IllegalStateException - ログインメカニズムがレスポンスの変更を試みたときに、すでにコミットされていた場合
    
    ServletException - 認証に失敗し、呼び出し側がエラーの処理を担当している場合（つまり基礎となるログインメカニズムでメッセージとHTTPステータスコードをユーザーに返すように設定していない場合）
    
    導入されたバージョン:
    
    Servlet 3.0
  - login
```
void login(String username,
           String password)
    throws ServletException
```
    提供されたユーザ名とパスワードをServletContext用に設定されたウェブコンテナログインメカニズムによって使用されるパスワード検証機構で検証します。
    このメソッドは、 ServletContext用に設定されたログイン機構がユーザー名のパスワード検証をサポートしているとき、かつログイン呼び出し時にリクエストの呼び出し元の身元が確立されていないとき（つまりgetUserPrincipal、getRemoteUser、getAuthTypeがnullを返す）、かつ提供された資格証明の検証が成功した場合にServletExceptionを投げずに処理を戻します。それ以外の場合はこのメソッドは以下に説明するようにServletExceptionを投げます。
    訳注：サーブレットAPIを使用してログインを行なえるような設定をしているときに、ユーザーがまだログインしておらず、このメソッドでログインに成功した場合にのみServletExceptionを投げずに処理を戻します。
    このメソッドが例外を投げないで処理を返すときはgetUserPrincipal、getRemoteUser、getAuthType から返される値としてnull以外の値を設定するべきです。
    
    パラメータ:
    
    username - ユーザーのログイン識別子に対応するStringの値
    
    password - 識別されたユーザーに対応するパスワードのString
    
    例外:
    
    ServletException - 設定されたログインメカニズムがユーザ名とパスワードの認証をサポートしていない場合、またはnull以外の呼び出し元認証情報が(ログインの前に)すでに設定されている場合、または指定されたユーザ名とパスワードの検証に失敗した場合
    
    導入されたバージョン:
    
    Servlet 3.0
  - logout
```
void logout()
     throws ServletException
```
    リクエストでgetUserPrincipal、getRemoteUser、getAuthTypeが呼び出されたときに返される値としてnullを設定します。
    
    例外:
    
    ServletException - ログアウトに失敗した
    
    導入されたバージョン:
    
    Servlet 3.0
  - getParts
```
Collection<Part> getParts()
                   throws IOException,
                          ServletException
```
    multipart/form-dataによって提供されるこのリクエストのすべてのPart要素を取得します。
    このリクエストがmultipart/form-dataだけれどもPart要素を含まない場合、返されるCollectionは空になるでしょう。
    返されたCollectionへのいかなる変更もこのHttpServletRequestに影響を与えてはいけません。
    
    戻り値:
    
    このリクエストのPart要素の(空の可能性のある)Collection
    
    例外:
    
    IOException - このリクエストのPart要素の取得中にI/Oエラーが発生した場合
    
    ServletException - このリクエストがmultipart/form-dataでない場合
    
    IllegalStateException - リクエストボディがmaxRequestSizeより大きい場合、もしくはリクエスト内のPartのいずれかがmaxFileSize,より大きい場合、もしくはデプロイメントディスクリプタに@MultipartConfigまたはmultipart-configが存在しない場合
    
    導入されたバージョン:
    
    Servlet 3.0
    
    関連項目:
    
    MultipartConfig.maxFileSize(), MultipartConfig.maxRequestSize()
  - getPart
```
Part getPart(String name)
      throws IOException,
             ServletException
```
    与えられた名前でPartを取得します。
    
    パラメータ:
    
    name - 要求するPartの名前
    
    戻り値:
    
    与えられた名前のPart、このリクエストがmultipart/form-dataだけど要求されたPartが含まれてない場合はnull
    
    例外:
    
    IOException - 要求されたPartの取得中にI/Oエラーが発生した場合
    
    ServletException - このリクエストがmultipart/form-dataでない場合
    
    IllegalStateException - リクエストボディがmaxRequestSizeより大きい場合、もしくはリクエスト内のPartのいずれかがmaxFileSize,より大きい場合、もしくはデプロイメントディスクリプタに@MultipartConfigまたはmultipart-configが存在しない場合
    
    導入されたバージョン:
    
    Servlet 3.0
    
    関連項目:
    
    MultipartConfig.maxFileSize(), MultipartConfig.maxRequestSize()
  - upgrade
```
<T extends HttpUpgradeHandler> T upgrade(Class<T> handlerClass)
                                  throws IOException,
                                         ServletException
```
    指定されたクラスでHttpUpgradeHandlerのインスタンスを作成し、httpプロトコルのアップグレードプロセスに使用します。
    
    型パラメータ:
    
    T - handlerClassのHttpUpgradeHandlerを拡張するClass
    
    パラメータ:
    
    handlerClass - アップグレードに使用するHttpUpgradeHandler
    
    戻り値:
    
    HttpUpgradeHandlerのインスタンス
    
    例外:
    
    IOException - アップグレード中にI/Oエラーが発生した
    
    ServletException - 与えられたhandlerClassのインスタンス化に失敗した
    
    導入されたバージョン:
    
    Servlet 3.1
    
    関連項目:
    
    HttpUpgradeHandler, WebConnection
  - getTrailerFields
```
default Map<String,String> getTrailerFields()
```
    リクエストのトレーラーフィールドを取得します。
    返されるMapはHttpServletRequestオブジェクトによって追跡されていないため、返されるMapへの変更はHttpServletRequestオブジェクトには反映されません。その逆もそうです。
    
    isTrailerFieldsReady()は例外を発生させずにこのメソッドを安全に呼び出すことができるかどうかを調べるために最初に呼び出す必要があります。
    
    Implementation Requirements:
    
    デフォルト実装は空のMapを返します。
    
    戻り値:
    
    プロトコルレベルでの大文字小文字に関係なく、すべてのキーが小文字であるトレーラーフィールドのMap、トレーラーフィールドがないがisTrailerFieldsReady()がtrueを返す場合は空のMapを返す
    
    例外:
    
    IllegalStateException - if isTrailerFieldsReady() is false
    
    導入されたバージョン:
    
    Servlet 4.0
  - isTrailerFieldsReady
```
default boolean isTrailerFieldsReady()
```
    トレーラーフィールドがgetTrailerFields()を使用して読み込み可能かどうかを示すbooleanを返します。このメソッドは、リクエストにトレーラーがないことがわかっている場合、たとえば、HTTP 1.0などで基本プロトコルがトレーラーフィールドをサポートしていない場合、またはリクエストがHTTP 1.1のチャンクエンコーディングでない場合には即座にtrueを返します。また、次の条件の両方が満たされていればtrueを返します。
    1. アプリケーションはすべてのリクエストデータを読み取り、ServletRequest.getReader()もしくはServletRequest.getInputStream()からEOFが返された。
    2. クライアントによって送信されたすべてのトレーラーフィールドが受信された。この場合クライアントがトレーラーフィールドをまったく送信していない可能性があることに注意してください。
    Implementation Requirements:
    
    デフォルト実装ではfalseを返します。
    
    戻り値:
    
    トレーラーフィールドが読み込み可能かを示すboolean
    
    導入されたバージョン:
    
    Servlet 4.0

HTTPリクエストの最初の行	戻り値
POST /some/path.html HTTP/1.1		/some/path.html
GET http://foo.bar/a.html HTTP/1.0		/a.html
HEAD /xyz?a=b HTTP/1.1		/xyz

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.

インタフェース HttpServletRequest

フィールドのサマリー

メソッドのサマリー

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

フィールドの詳細

BASIC_AUTH

FORM_AUTH

CLIENT_CERT_AUTH

DIGEST_AUTH

メソッドの詳細

getAuthType

getCookies

getDateHeader

getHeader

getHeaders

getHeaderNames

getIntHeader

getHttpServletMapping

getMethod

getPathInfo

getPathTranslated

newPushBuilder

getContextPath

getQueryString

getRemoteUser

isUserInRole

getUserPrincipal

getRequestedSessionId

getRequestURI

getRequestURL

getServletPath

getSession

getSession

changeSessionId

isRequestedSessionIdValid

isRequestedSessionIdFromCookie

isRequestedSessionIdFromURL

isRequestedSessionIdFromUrl

authenticate

login

logout

getParts

getPart

upgrade

getTrailerFields

isTrailerFieldsReady