ServletRequest (Java Servlet 4.0)

既知のサブインタフェースのリスト:

HttpServletRequest

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

HttpServletRequestWrapper, ServletRequestWrapper
```
public interface ServletRequest
```
サーブレットにクライアントからのリクエストの情報を提供するオブジェクトを定義します。サーブレットコンテナはServletRequestオブジェクトを作成し、サーブレットのserviceメソッドへの引数として渡します。
ServletRequestオブジェクトはパラメータ名と値、属性、および入力ストリームを含むデータを提供します。 ServletRequestを拡張するインターフェースは追加のプロトコル固有のデータを提供できます。（たとえば、HTTPのデータはHttpServletRequestによって提供されます。）

作成者:

Various

関連項目:

HttpServletRequest

メソッドのサマリー

すべてのメソッドインスタンス・メソッド abstractメソッド非推奨のメソッド
修飾子とタイプ	メソッドと説明
`AsyncContext`	`getAsyncContext()` このリクエストで`startAsync()`または`startAsync(ServletRequest,ServletResponse)`の最新の呼び出しによって作成または再初期化されたAsyncContextを取得します。
`Object`	`getAttribute(String name)` 名前の付いた属性の値を`Object`として返します。
`Enumeration<String>`	`getAttributeNames()` このリクエストで利用可能な属性の値を含む`Enumeration`を返します。
`String`	`getCharacterEncoding()` このリクエストのボディで使用されている文字エンコーディングの名前を返します。
`int`	`getContentLength()` リクエストボディの入力ストリームによって利用可能な長さをバイト単位で返します。
`long`	`getContentLengthLong()` リクエストボディの入力ストリームによって利用可能な長さをバイト単位で返します。
`String`	`getContentType()` リクエストボディのMIME形式を返します。
`DispatcherType`	`getDispatcherType()` このリクエストのdispatcher typeを取得します。
`ServletInputStream`	`getInputStream()` リクエストボディを`ServletInputStream`を利用してバイナリデータとして取得します。
`String`	`getLocalAddr()` リクエストを受信したインターフェースのインターネットプロトコル(IP)アドレスを返します。
`Locale`	`getLocale()` Accept-Languageヘッダーの値からクライアントがコンテンツを受け入れる優先の`Locale`(ロケール、地域、言語)を返します。
`Enumeration<Locale>`	`getLocales()` Accept-Languageヘッダーの値からクライアントが受け入れられるlocale(ロケール、地域、言語)の優先度の降順で示す`Locale`オブジェクトの`Enumeration`を返します。
`String`	`getLocalName()` リクエストを受信したインターフェースのインターネットプロトコル(IP)ホスト名を返します。
`int`	`getLocalPort()` リクエストを受信したインターフェースのインターネットプロトコル(IP)ポート番号を返します。
`String`	`getParameter(String name)` リクエストパラメーターを`String`として返します。
`Map<String,String[]>`	`getParameterMap()` リクエストのパラメーターの java.util.Map を返します。
`Enumeration<String>`	`getParameterNames()` リクエストに含まれるパラメーターの名前を含む`String`の`Enumeration`を返します。
`String[]`	`getParameterValues(String name)` リクエストパラメーターに含まれるすべての値を`String`オブジェクトの配列として返します。
`String`	`getProtocol()` リクエストに使用されたプロトコルの名前とバージョンをHTTP/1.1のようにprotocol/majorVersion.minorVersionの形式で返します。
`BufferedReader`	`getReader()` リクエストボディを`BufferedReader`.を利用して文字データとして取得します。
`String`	`getRealPath(String path)` 非推奨です。 Version 2.1 から`ServletContext.getRealPath(java.lang.String)`に置き換えられました
`String`	`getRemoteAddr()` リクエストを送信したクライアントまたは最後のプロキシのインターネットプロトコル(IP)アドレスを返します。
`String`	`getRemoteHost()` リクエストを送信したクライアントまたは最後のプロキシの完全修飾名(FQN)を返します。
`int`	`getRemotePort()` リクエストを送信したクライアントまたは最後のプロキシのインターネットプロトコル(IP)送信元ポートを返します。
`RequestDispatcher`	`getRequestDispatcher(String path)` 指定されたパスにあるリソースのラッパーとして機能する`RequestDispatcher`のオブジェクトを返します。
`String`	`getScheme()` リクエストを作るのに使用されたスキーマを返します。
`String`	`getServerName()` リクエストが送られたサーバーのホスト名を返します。
`int`	`getServerPort()` リクエストが送られたサーバーのポート番号を返します。
`ServletContext`	`getServletContext()` このServletRequestが最後にディスパッチされたサーブレットコンテキストを返します。
`boolean`	`isAsyncStarted()` このリクエストが非同期モードになっているかどうかをチェックします。
`boolean`	`isAsyncSupported()` このリクエストが非同期操作をサポートしているかどうかをチェックします。
`boolean`	`isSecure()` このリクエストがHTTPSなどのセキュアなチャネルを使用して行われたかどうかを示すbooleanを返します。
`void`	`removeAttribute(String name)` このリクエストから属性を削除します。
`void`	`setAttribute(String name, Object o)` このリクエストに属性を保存します。
`void`	`setCharacterEncoding(String env)` このリクエストのボディで使用されている文字エンコーディングの名前を上書きします。
`AsyncContext`	`startAsync()` このリクエストを非同期実行モードにし、オリジナルの(ラップされてない)ServletRequestとServletResponseのオブジェクトで`AsyncContext`を初期化します。
`AsyncContext`	`startAsync(ServletRequest servletRequest, ServletResponse servletResponse)` このリクエストを非同期実行モードにし、与えられたServletRequestとServletResponseのオブジェクトで`AsyncContext`を初期化します。

- メソッドの詳細
  - getAttribute
```
Object getAttribute(String name)
```
    名前の付いた属性の値をObjectとして返します。指定された名前の属性が存在しない場合はnullを返します。
    属性は2つの方法で設定されます。サーブレットコンテナはリクエストに関する利用可能なカスタム情報を生成するために属性を設定してもよいです。たとえば、HTTPSを使用して行われたリクエストの場合、javax.servlet.request.X509Certificateの属性からクライアントの証明書に関する情報を取得できます。属性はsetAttribute(java.lang.String, java.lang.Object)を使用してプログラムで設定することもできます。これによりRequestDispatcher の呼び出しの前に情報をリクエストに埋め込むことができます。
    属性名は、パッケージ名と同じ規則に従う必要があります。この仕様ではjava.*、javax.*、sun.*と一致する名前を予約しています。
    
    パラメータ:
    
    name - 属性の名前を示すString
    
    戻り値:
    
    属性の値を含むObject、属性が存在しない場合はnull
  - getAttributeNames
```
Enumeration<String> getAttributeNames()
```
    このリクエストで利用可能な属性の値を含むEnumerationを返します。このメソッドは利用可能な属性がない場合、空のEnumerationを返します。
    
    戻り値:
    
    このリクエストの属性の名前を含む文字列のEnumeration
  - getCharacterEncoding
```
String getCharacterEncoding()
```
    このリクエストのボディで使用されている文字エンコーディングの名前を返します。このメソッドはリクエストの文字エンコーディングが指定されていない場合はnullを返します。リクエストの文字エンコーディングを指定する方法は優先度順で次の通りです。
    - リクエスト毎(getCharacterEncoding()を使用)
    - ウェブアプリ毎 (ServletContext.setRequestCharacterEncoding(java.lang.String)やデプロイメントディスクリプタを使用)
    - コンテナ(コンテナにデプロイされたすべてのウェブアプリケーションに設定するためにベンダー固有の方法を使用)
    戻り値:
    
    文字エンコーディングの名前を含むString、指定がない場合はnull
  - setCharacterEncoding
```
void setCharacterEncoding(String env)
                   throws UnsupportedEncodingException
```
    このリクエストのボディで使用されている文字エンコーディングの名前を上書きします。このメソッドはリクエストパラメータを読み込む前、もしくはgetReader()を使用して入力を読み取る前に呼び出す必要があります。それ以外の場合、効果はありません。
    
    パラメータ:
    
    env - 文字エンコーディングの名前を含むString
    
    例外:
    
    UnsupportedEncodingException - このServletRequestにキャラクターエンコーディングを設定してもよい状態で、指定したエンコーディングが不正な場合。
  - getContentLength
```
int getContentLength()
```
    リクエストボディの入力ストリームによって利用可能な長さをバイト単位で返します。長さがわからない場合やInteger.MAX_VALUEより大きい場合は-1を返します。 HTTPサーブレットの場合、CGIの変数CONTENT_LENGTHの値と同じです。
    訳注：CGIはサーブレットが生まれる前にあったウェブアプリケーションを作るための仕組みです。現在はほぼ使われていません。
    
    戻り値:
    
    リクエストボディの長さを含むint。長さがわからない場合やInteger.MAX_VALUEより大きい場合は-1を返す
  - getContentLengthLong
```
long getContentLengthLong()
```
    リクエストボディの入力ストリームによって利用可能な長さをバイト単位で返します。長さがわからない場合は-1を返します。 HTTPサーブレットの場合、CGIの変数CONTENT_LENGTHの値と同じです。
    訳注：CGIはサーブレットが生まれる前にあったウェブアプリケーションを作るための仕組みです。現在はほぼ使われていません。
    
    戻り値:
    
    リクエストボディの長さを含むlong。長さがわからない場合は-1を返す
    
    導入されたバージョン:
    
    Servlet 3.1
  - getContentType
```
String getContentType()
```
    リクエストボディのMIME形式を返します。MIME形式が不明の場合はnullを返します。 HTTPサーブレットの場合、CGI変数のCONTENT_TYPEの値と同じです。
    訳注：CGIはサーブレットが生まれる前にあったウェブアプリケーションを作るための仕組みです。現在はほぼ使われていません。
    
    戻り値:
    
    リクエストボディのMIME形式を含むString。MIME形式が不明の場合はnullを返す
  - getInputStream
```
ServletInputStream getInputStream()
                           throws IOException
```
    リクエストボディをServletInputStreamを利用してバイナリデータとして取得します。このメソッドとgetReader()はどちらかしか呼び出せません。
    
    戻り値:
    
    リクエストボディを含む ServletInputStreamのオブジェクト
    
    例外:
    
    IllegalStateException - getReader() メソッドがこのリクエストですでに呼び出されていた場合
    
    IOException - I/Oエラーが発生した
  - getParameter
```
String getParameter(String name)
```
    リクエストパラメーターをStringとして返します。パラメーターが存在しない場合はnullを返します。リクエストパラメーターはリクエストと同時に送られる追加の情報です。HTTPサーブレットではリクエストパラメーターはクエリ文字列やフォームからPOSTされたデータを含みます。
    このメソッドはパラメーターが確実に一つの場合のみ呼び出すことができます。もし二つ以上あるかもしれない場合はgetParameterValues(java.lang.String)を使用してください。
    もしこのメソッドを複数の値のあるパラメーターに使用した場合、getParameterValuesが返す値の最初の値のみを取得できます。
    もしHTTP POSTリクエストのようにパラメーターがリクエストボディで送られた場合、 getInputStream()やgetReader()で直接リクエストボディを読み取るとこのメソッドの実行が妨害される可能性があります。
    
    パラメータ:
    
    name - パラメーターの名前を指定するString
    
    戻り値:
    
    パラメーターを代表する単一の値の String
    
    関連項目:
    
    getParameterValues(java.lang.String)
  - getParameterNames
```
Enumeration<String> getParameterNames()
```
    リクエストに含まれるパラメーターの名前を含むStringのEnumerationを返します。リクエストにパラメーターがない場合は空のEnumerationを返します。
    
    戻り値:
    
    リクエストに含まれるパラメーターの名前を含むStringのEnumeration、リクエストにパラメーターがない場合は空のEnumeration
  - getParameterValues
```
String[] getParameterValues(String name)
```
    リクエストパラメーターに含まれるすべての値をStringオブジェクトの配列として返します。
    もしパラメーターが単一の値を持つ場合、その配列の長さは1です。
    
    パラメータ:
    
    name - 値が要求されているパラメーターの名前を含めた String
    
    戻り値:
    
    パラメーターの値が含められた String オブジェクトの配列
    
    関連項目:
    
    getParameter(java.lang.String)
  - getParameterMap
```
Map<String,String[]> getParameterMap()
```
    リクエストのパラメーターの java.util.Map を返します。
    リクエストパラメーターはリクエストと同時に送られる追加の情報です。 HTTPサーブレットではリクエストパラメーターはクエリ文字列やフォームからPOSTされたデータを含みます。
    
    戻り値:
    
    パラメーターのキーのStringとパラメーターの値のStringの配列を含めるイミュータブルな java.util.Map
  - getProtocol
```
String getProtocol()
```
    リクエストに使用されたプロトコルの名前とバージョンをHTTP/1.1のようにprotocol/majorVersion.minorVersionの形式で返します。 HTTPサーブレットの場合、CGI変数のSERVER_PROTOCOLの値と同じです。
    訳注：CGIはサーブレットが生まれる前にあったウェブアプリケーションを作るための仕組みです。現在はほぼ使われていません。
    
    戻り値:
    
    プロトコルの名前とバージョンを含むString
  - getScheme
```
String getScheme()
```
    リクエストを作るのに使用されたスキーマを返します。例えばhttpやhttps、ftpなどです。 RFC 1738に記載されているようにスキーマが異なる場合はURLの構築に異なるルールが適用されます。
    
    戻り値:
    
    リクエストを作るのに使用されたスキーマの名前を含むString
  - getServerName
```
String getServerName()
```
    リクエストが送られたサーバーのホスト名を返します。 Hostヘッダーが存在する場合は":"の前の部分、もしくは解決されたサーバー名、サーバーのIPアドレスなどです。
    
    戻り値:
    
    サーバーの名前を含む String
  - getServerPort
```
int getServerPort()
```
    リクエストが送られたサーバーのポート番号を返します。 Hostヘッダーが存在する場合は":"の後ろの部分、もしくはクライアントのコネクションを受け付けたサーバーのポートです。
    
    戻り値:
    
    ポート番号を指定する整数
  - getReader
```
BufferedReader getReader()
                  throws IOException
```
    リクエストボディをBufferedReader.を利用して文字データとして取得します。 Readerはリクエストボディに使用されている文字エンコーディングに従って文字データを変換します。このメソッドとgetInputStream()はどちらかしか呼び出せません。
    
    戻り値:
    
    リクエストボディを含む BufferedReader
    
    例外:
    
    UnsupportedEncodingException - 使用されている文字エンコーディングがサポートされておらず、テキストがデコードできなかった場合
    
    IllegalStateException - getInputStream() メソッドがこのリクエストですでに呼び出されていた場合
    
    IOException - I/Oエラーが発生した
    
    関連項目:
    
    getInputStream()
  - getRemoteAddr
```
String getRemoteAddr()
```
    リクエストを送信したクライアントまたは最後のプロキシのインターネットプロトコル(IP)アドレスを返します。 HTTPサーブレットの場合、CGI変数のREMOTE_ADDRの値と同じです。
    訳注：CGIはサーブレットが生まれる前にあったウェブアプリケーションを作るための仕組みです。現在はほぼ使われていません。
    
    戻り値:
    
    クライアントがリクエストを送信したIPアドレスを含む String
  - getRemoteHost
```
String getRemoteHost()
```
    リクエストを送信したクライアントまたは最後のプロキシの完全修飾名(FQN)を返します。エンジンがパフォーマンスを向上させるためにホスト名を解決できない、またはホスト名を解決しないことを選択した場合、このメソッドはIPアドレスのドット文字列形式を返します。 HTTPサーブレットの場合、CGI変数の REMOTE_HOSTの値と同じです。
    訳注：CGIはサーブレットが生まれる前にあったウェブアプリケーションを作るための仕組みです。現在はほぼ使われていません。
    
    戻り値:
    
    クライアントの完全修飾名(FQN)を含む String
  - setAttribute
```
void setAttribute(String name,
                  Object o)
```
    このリクエストに属性を保存します。属性はリクエストの度にリセットされます。このメソッドはRequestDispatcherと組み合わせて使用されることがよくあります。
    属性名はパッケージ名と同じ規則に従う必要があります。 java.*やjavax.*、com.sun.*で始まる名前は、Sun Microsystemsが使用するために予約されています。
    Objectとしてnullが渡された場合、removeAttribute(java.lang.String)を呼び出されたのと同じ効果を及ぼします。
    リクエストがサーブレットからRequestDispatcherによって別のウェブアプリケーションにディスパッチされた場合、このメソッドで設定されたオブジェクトは呼び出し側のサーブレットでは正しく取得できないことがあることを注意してください。
    
    パラメータ:
    
    name - 属性の名前を示す String
    
    o - 保存する Object
  - removeAttribute
```
void removeAttribute(String name)
```
    このリクエストから属性を削除します。属性はリクエストが処理されている間だけ永続化されているため、通常はこのメソッドは不要です。
    属性名はパッケージ名と同じ規則に従う必要があります。 java.*やjavax.*、com.sun.*で始まる名前は、Sun Microsystemsが使用するために予約されています。
    
    パラメータ:
    
    name - 削除する属性の名前を示す String
  - getLocale
```
Locale getLocale()
```
    Accept-Languageヘッダーの値からクライアントがコンテンツを受け入れる優先のLocale(ロケール、地域、言語)を返します。クライアントリクエストにAccept-Languageヘッダーが存在しない場合、このメソッドはサーバーのデフォルトのlocaleを返します。
    
    戻り値:
    
    クライアントの優先 Locale
  - getLocales
```
Enumeration<Locale> getLocales()
```
    Accept-Languageヘッダーの値からクライアントが受け入れられるlocale(ロケール、地域、言語)の優先度の降順で示すLocaleオブジェクトのEnumerationを返します。クライアントリクエストにAccept-Languageヘッダーが存在しない場合、このメソッドはサーバーのデフォルトのlocaleである単一のLocaleを含むEnumerationを返します。
    
    戻り値:
    
    クライアントの優先LocaleのオブジェクトのEnumeration
  - isSecure
```
boolean isSecure()
```
    このリクエストがHTTPSなどのセキュアなチャネルを使用して行われたかどうかを示すbooleanを返します。
    
    戻り値:
    
    このリクエストがHTTPSなどのセキュアなチャネルを使用して行われたかどうかを示すboolean
  - getRequestDispatcher
```
RequestDispatcher getRequestDispatcher(String path)
```
    指定されたパスにあるリソースのラッパーとして機能するRequestDispatcherのオブジェクトを返します。 RequestDispatcherオブジェクトを使用することでリクエストを別のリソースに転送したり、リソースをレスポンスに含めることができます。リソースは動的なものでも静的なものでもかまいません。
    指定されたパス名は相対パスにすることができますが現在のサーブレットのコンテキスト外には拡張できません。パスが "/"で始まる場合、現在のコンテキストルートからの相対パスとして解釈されます。サーブレットコンテナがRequestDispatcherを返せない場合、このメソッドはnullを返します。
    このメソッドとServletContext.getRequestDispatcher(java.lang.String)の違いはこのメソッドが相対パスを取ることができることです。
    
    パラメータ:
    
    path - リソースへのパス名を指定する String、相対パスの場合は現在のサーブレットからの相対パスでなければならない
    
    戻り値:
    
    指定されたパスにあるリソースのラッパーとして機能するRequestDispatcherのオブジェクト、サーブレットコンテナがRequestDispatcherを返せない場合はnull
    
    関連項目:
    
    RequestDispatcher, ServletContext.getRequestDispatcher(java.lang.String)
  - getRealPath
```
String getRealPath(String path)
```
    非推奨です。 Version 2.1 からServletContext.getRealPath(java.lang.String)に置き換えられました
    
    パラメータ:
    
    path - 実際のパスが返されるパス
    
    戻り値:
    
    実際のパス、変換できない場合はnull
  - getRemotePort
```
int getRemotePort()
```
    リクエストを送信したクライアントまたは最後のプロキシのインターネットプロトコル(IP)送信元ポートを返します。
    
    戻り値:
    
    ポート番号を指定する整数
    
    導入されたバージョン:
    
    Servlet 2.4
  - getLocalName
```
String getLocalName()
```
    リクエストを受信したインターフェースのインターネットプロトコル(IP)ホスト名を返します。
    
    戻り値:
    
    リクエストを受信したIPのホスト名を含む String
    
    導入されたバージョン:
    
    Servlet 2.4
  - getLocalAddr
```
String getLocalAddr()
```
    リクエストを受信したインターフェースのインターネットプロトコル(IP)アドレスを返します。
    
    戻り値:
    
    リクエストを受信したIPアドレスを含む String
    
    導入されたバージョン:
    
    Servlet 2.4
  - getLocalPort
```
int getLocalPort()
```
    リクエストを受信したインターフェースのインターネットプロトコル(IP)ポート番号を返します。
    
    戻り値:
    
    ポート番号を指定する整数
    
    導入されたバージョン:
    
    Servlet 2.4
  - getServletContext
```
ServletContext getServletContext()
```
    このServletRequestが最後にディスパッチされたサーブレットコンテキストを返します。
    
    戻り値:
    
    このServletRequestが最後にディスパッチされたサーブレットコンテキスト
    
    導入されたバージョン:
    
    Servlet 3.0
  - startAsync
```
AsyncContext startAsync()
                 throws IllegalStateException
```
    このリクエストを非同期実行モードにし、オリジナルの(ラップされてない)ServletRequestとServletResponseのオブジェクトでAsyncContextを初期化します。
    このメソッドを呼び出すと返されたAsyncContextのAsyncContext.complete()が呼び出されるか非同期操作がタイムアウトになるまで関連するレスポンスのコミットが遅延されます。
    返されたAsyncContextでAsyncContext.hasOriginalRequestAndResponse()を呼び出すとtrueが返されます。このリクエストが非同期モードにされた後にアウトバウンド方向に呼び出されたフィルターは インバウンド呼び出し中に追加したすべてのリクエストおよび/またはレスポンスラッパーが非同期操作の間、呼び出しを滞留させる必要はありません、つまり、それらの関連リソースのいずれかが解放される可能性があります。
    このメソッドは各AsyncListenerをそのonStartAsyncメソッドで呼び出した後、 startAsyncメソッドのうちの1つの最新の呼び出しによって返されたAsyncContextに登録されたAsyncListenerインスタンス(が存在する場合)のリストをクリアします。
    その後にこのメソッドまたはオーバーロードされたメソッドを呼び出すと必要に応じて再初期化された同じAsyncContextのインスタンスが返されます。
    
    戻り値:
    
    (再)初期化されたAsyncContext
    
    例外:
    
    IllegalStateException - このリクエストが非同期操作をサポートしないフィルタまたはサーブレットのスコープ内にある場合(isAsyncSupported()がfalseを返す場合)、またはこのメソッドが非同期ディスパッチ(AsyncContext.dispatch()メソッドの一つで行われる)なしで再度呼び出されディスパッチの範囲外で呼び出された場合、または同じディスパッチの範囲内で再度呼び出された場合、またはレスポンスがすでに閉じられている場合
    
    導入されたバージョン:
    
    Servlet 3.0
    
    関連項目:
    
    AsyncContext.dispatch()
  - startAsync
```
AsyncContext startAsync(ServletRequest servletRequest,
                        ServletResponse servletResponse)
                 throws IllegalStateException
```
    このリクエストを非同期実行モードにし、与えられたServletRequestとServletResponseのオブジェクトでAsyncContextを初期化します。
    引数のServletRequestとServletResponseはサーブレットのservice メソッドもしくはフィルターのdoFilterメソッドの各々が呼び出されたスコープでの同じインスタンスであるか、 ServletRequestWrapperやServletResponseWrapperでそれらをラップしたものである必要があります。
    このメソッドを呼び出すと返されたAsyncContextのAsyncContext.complete()が呼び出されるか非同期操作がタイムアウトになるまで関連するレスポンスのコミットが遅延されます。
    引数として渡されたServletRequestとServletResponseがオリジナルのものもしくはアプリケーションが提供するラッパーでない限りは返されたAsyncContextでAsyncContext.hasOriginalRequestAndResponse()を呼び出すとfalseが返されます。このリクエストが非同期モードにされた後にアウトバウンド方向に呼び出されたいくつかのフィルターは インバウンド呼び出し中に追加したすべてのリクエストおよび/またはレスポンスラッパーが非同期操作の間、呼び出しを滞留させる必要があるかもしれず、それらの関連リソースは解放されないかもしれません。フィルターのインバウンド呼び出し中に適用されたServletRequestWrapperは与えられたServletRequest (ServletRequestWrapperを含みません)がAsyncContextを初期化しAsyncContext.getRequest()の呼び出しによって返される場合のみ解放されます。
    このメソッドは各AsyncListenerをそのonStartAsyncメソッドで呼び出した後、 startAsyncメソッドのうちの1つの最新の呼び出しによって返されたAsyncContextに登録されたAsyncListenerインスタンス(が存在する場合)のリストをクリアします。
    その後にこのメソッドまたはオーバーロードされた引数のないメソッドを呼び出すと必要に応じて再初期化された同じAsyncContextのインスタンスが返されます。このメソッドの呼び出しのあとに引数のないメソッドの呼び出しがあった場合、指定された（場合によってはラップされた）リクエストおよびレスポンスのオブジェクトは返されたAsyncContextにロックされたままになります。
    
    パラメータ:
    
    servletRequest - AsyncContextの初期化に使用するServletRequest
    
    servletResponse - AsyncContextの初期化に使用するServletResponse
    
    戻り値:
    
    (再)初期化されたAsyncContext
    
    例外:
    
    IllegalStateException - このリクエストが非同期操作をサポートしないフィルタまたはサーブレットのスコープ内にある場合(isAsyncSupported()がfalseを返す場合)、またはこのメソッドが非同期ディスパッチ(AsyncContext.dispatch()メソッドの一つで行われる)なしで再度呼び出されディスパッチの範囲外で呼び出された場合、または同じディスパッチの範囲内で再度呼び出された場合、またはレスポンスがすでに閉じられている場合
    
    導入されたバージョン:
    
    Servlet 3.0
  - isAsyncStarted
```
boolean isAsyncStarted()
```
    このリクエストが非同期モードになっているかどうかをチェックします。
    ServletRequestはstartAsync()やstartAsync(ServletRequest,ServletResponse)の呼び出しで非同期モードになります。
    このメソッドは非同期実行モードになってからAsyncContext.dispatch()を使ってディスパッチされている場合や AsyncContext.complete()が呼ばれて非同期実行モードから開放されている場合にはfalseを返します。
    
    戻り値:
    
    このリクエストが非同期モードになっている場合はtrue、そうでない場合はfalse
    
    導入されたバージョン:
    
    Servlet 3.0
  - isAsyncSupported
```
boolean isAsyncSupported()
```
    このリクエストが非同期操作をサポートしているかどうかをチェックします。
    このリクエストが非同期処理をサポートできるとアノテーションがつけられていないかデプロイメントディスクリプタにフラグが立てられていないフィルターまたはサーブレットのスコープ内にある場合、このリクエストに対して非同期操作は無効になります。
    
    戻り値:
    
    true if this request supports asynchronous operation, false otherwise
    
    導入されたバージョン:
    
    Servlet 3.0
  - getAsyncContext
```
AsyncContext getAsyncContext()
```
    このリクエストでstartAsync()またはstartAsync(ServletRequest,ServletResponse)の最新の呼び出しによって作成または再初期化されたAsyncContextを取得します。
    
    戻り値:
    
    このリクエストでstartAsync()またはstartAsync(ServletRequest,ServletResponse)の最新の呼び出しによって作成または再初期化されたAsyncContext
    
    例外:
    
    IllegalStateException - このリクエストが非同期モードになっていない場合、つまりstartAsync()もstartAsync(ServletRequest,ServletResponse)も呼び出されていない場合
    
    導入されたバージョン:
    
    Servlet 3.0
  - getDispatcherType
```
DispatcherType getDispatcherType()
```
    このリクエストのdispatcher typeを取得します。
    リクエストのdispatcher typeは、リクエストに適用する必要があるフィルターを選択するためにコンテナによって使用されます。一致するdispatcher typeとURLパターンを持つフィルターのみが適用されます。
    リクエストのdispatcher typeを照会するように設定されたフィルターを複数のdispatcher typeに対して許可すると、フィルターはdispatcher typeに応じてリクエストを個別に処理できます。
    リクエストのdispatcher typeの初期値はDispatcherType.REQUESTとして定義されます。 RequestDispatcher.forward(ServletRequest, ServletResponse)またはRequestDispatcher.include(ServletRequest, ServletResponse)を介してディスパッチされたリクエストのdispatcher typeはそれぞれDispatcherType.FORWARDまたはDispatcherType.INCLUDEとして与えられ、 AsyncContext.dispatch()メソッドで行われる非同期リクエストのdispatcher typeはDispatcherType.ASYNCとして与えられます。最後にコンテナのエラー処理メカニズムによってエラーページにディスパッチされたリクエストのdispatcher typeはDispatcherType.ERRORとして与えられます。
    
    戻り値:
    
    リクエストのdispatcher type
    
    導入されたバージョン:
    
    Servlet 3.0
    
    関連項目:
    
    DispatcherType

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.

インタフェース ServletRequest

メソッドのサマリー

メソッドの詳細

getAttribute

getAttributeNames

getCharacterEncoding

setCharacterEncoding

getContentLength

getContentLengthLong

getContentType

getInputStream

getParameter

getParameterNames

getParameterValues

getParameterMap

getProtocol

getScheme

getServerName

getServerPort

getReader

getRemoteAddr

getRemoteHost

setAttribute

removeAttribute

getLocale

getLocales

isSecure

getRequestDispatcher

getRealPath

getRemotePort

getLocalName

getLocalAddr

getLocalPort

getServletContext

startAsync

startAsync

isAsyncStarted

isAsyncSupported

getAsyncContext

getDispatcherType