StandardServletAsyncWebRequest (Spring Framework 5.1.8.RELEASE API)

java.lang.ObjectSE
- org.springframework.web.context.request.AbstractRequestAttributes
- - org.springframework.web.context.request.ServletRequestAttributes
  - - org.springframework.web.context.request.ServletWebRequest
    - - org.springframework.web.context.request.async.StandardServletAsyncWebRequest

実装されたすべてのインターフェース:
EventListenerSE, AsyncListenerEE, AsyncWebRequest, NativeWebRequest, RequestAttributes, WebRequest
```
public class StandardServletAsyncWebRequest
extends ServletWebRequest
implements AsyncWebRequest, AsyncListenerEE
```
AsyncWebRequest の Servlet 3.0 実装。
非同期リクエストに含まれるサーブレットとすべてのフィルターは、サーブレット API を使用するか、<async-supported>true</async-supported> 要素をサーブレットに追加して web.xml のフィルター宣言を有効にして、非同期サポートを有効にする必要があります。
導入:
3.2
作成者:
Rossen Stoyanchev

フィールドサマリー
- クラス org.springframework.web.context.request.ServletRequestAttributes から継承されたフィールド
  DESTRUCTION_CALLBACK_NAME_PREFIX, immutableValueTypes
- クラス org.springframework.web.context.request.AbstractRequestAttributes から継承されたフィールド
  requestDestructionCallbacks
- インターフェース org.springframework.web.context.request.RequestAttributes から継承されたフィールド
  REFERENCE_REQUEST, REFERENCE_SESSION, SCOPE_REQUEST, SCOPE_SESSION

コンストラクターのサマリー

コンストラクター
コンストラクターと説明
`StandardServletAsyncWebRequest(HttpServletRequestEE request, HttpServletResponseEE response)` 指定されたリクエスト / レスポンスペアの新しいインスタンスを作成します。

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`void`	`addCompletionHandler(RunnableSE runnable)` リクエスト処理が完了したときに呼び出すハンドラーを追加します。
`void`	`addErrorHandler(ConsumerSE<ThrowableSE> exceptionHandler)` リクエストの同時処理中にエラーが発生したときに呼び出すハンドラーを追加します。
`void`	`addTimeoutHandler(RunnableSE timeoutHandler)` 並行処理がタイムアウトしたときに呼び出すハンドラーを追加します。
`void`	`dispatch()` アプリケーションスレッドでの同時実行後に処理を再開するために、コンテナーにリクエストをディスパッチします。
`boolean`	`isAsyncComplete()` 非同期リクエスト処理が完了したかどうか。
`boolean`	`isAsyncStarted()` `AsyncWebRequest.startAsync()` の呼び出し後、リクエストが非同期モードかどうか。
`void`	`onComplete(AsyncEventEE event)` この AsyncListener に非同期操作が完了したことを通知します。
`void`	`onError(AsyncEventEE event)` この AsyncListener に、非同期操作の補完に失敗したことを通知します。
`void`	`onStartAsync(AsyncEventEE event)` `ServletRequest.startAsync()`EE メソッドの 1 つを呼び出して、新しい非同期サイクルが開始されていることを、この AsyncListener に通知します。
`void`	`onTimeout(AsyncEventEE event)` この AsyncListener に、非同期操作がタイムアウトしたことを通知します。
`void`	`setTimeout(LongSE timeout)` Servlet 3 非同期処理では、コンテナー処理スレッドが終了した後にタイムアウト期間が始まります。
`void`	`startAsync()` 非同期リクエスト処理の開始をマークして、メイン処理スレッドが終了したときに、別のスレッドでさらに処理するためにレスポンスが開いたままになるようにします。

クラス org.springframework.web.context.request.ServletWebRequest から継承されたメソッド
checkNotModified, checkNotModified, checkNotModified, getContextPath, getDescription, getHeader, getHeaderNames, getHeaderValues, getHttpMethod, getLocale, getNativeRequest, getNativeRequest, getNativeResponse, getNativeResponse, getParameter, getParameterMap, getParameterNames, getParameterValues, getRemoteUser, getUserPrincipal, isNotModified, isSecure, isUserInRole, toString

クラス org.springframework.web.context.request.ServletRequestAttributes から継承されたメソッド
getAttribute, getAttributeNames, getRequest, getResponse, getSession, getSessionId, getSessionMutex, isImmutableSessionAttribute, registerDestructionCallback, registerSessionDestructionCallback, removeAttribute, resolveReference, setAttribute, updateAccessedSessionAttributes

クラス org.springframework.web.context.request.AbstractRequestAttributes から継承されたメソッド
isRequestActive, registerRequestDestructionCallback, removeRequestDestructionCallback, requestCompleted

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, waitSE, waitSE, waitSE

インターフェース org.springframework.web.context.request.NativeWebRequest から継承されたメソッド
getNativeRequest, getNativeRequest, getNativeResponse, getNativeResponse

インターフェース org.springframework.web.context.request.WebRequest から継承されたメソッド
checkNotModified, checkNotModified, checkNotModified, getContextPath, getDescription, getHeader, getHeaderNames, getHeaderValues, getLocale, getParameter, getParameterMap, getParameterNames, getParameterValues, getRemoteUser, getUserPrincipal, isSecure, isUserInRole

インターフェース org.springframework.web.context.request.RequestAttributes から継承されたメソッド
getAttribute, getAttributeNames, getSessionId, getSessionMutex, registerDestructionCallback, removeAttribute, resolveReference, setAttribute

- コンストラクターの詳細
  - StandardServletAsyncWebRequest
```
public StandardServletAsyncWebRequest(HttpServletRequestEE request,
                                      HttpServletResponseEE response)
```
    指定されたリクエスト / レスポンスペアの新しいインスタンスを作成します。
    パラメーター:
    request - 現在の HTTP リクエスト
    response - 現在の HTTP レスポンス
- メソッドの詳細
  - setTimeout
```
public void setTimeout(LongSE timeout)
```
    Servlet 3 非同期処理では、コンテナー処理スレッドが終了した後にタイムアウト期間が始まります。
    次で指定:
    インターフェース AsyncWebRequest の setTimeout
    パラメーター:
    timeout - ミリ秒単位の時間。null はタイムアウトがないことを意味します。つまり、コンテナーのデフォルトのタイムアウトに依存します。
  - addTimeoutHandler
```
public void addTimeoutHandler(RunnableSE timeoutHandler)
```
    インターフェースからコピーされた説明: AsyncWebRequest
    並行処理がタイムアウトしたときに呼び出すハンドラーを追加します。
    次で指定:
    インターフェース AsyncWebRequest の addTimeoutHandler
  - addErrorHandler
```
public void addErrorHandler(ConsumerSE<ThrowableSE> exceptionHandler)
```
    インターフェースからコピーされた説明: AsyncWebRequest
    リクエストの同時処理中にエラーが発生したときに呼び出すハンドラーを追加します。
    次で指定:
    インターフェース AsyncWebRequest の addErrorHandler
  - addCompletionHandler
```
public void addCompletionHandler(RunnableSE runnable)
```
    インターフェースからコピーされた説明: AsyncWebRequest
    リクエスト処理が完了したときに呼び出すハンドラーを追加します。
    次で指定:
    インターフェース AsyncWebRequest の addCompletionHandler
  - isAsyncStarted
```
public boolean isAsyncStarted()
```
    インターフェースからコピーされた説明: AsyncWebRequest
    AsyncWebRequest.startAsync() の呼び出し後、リクエストが非同期モードかどうか。非同期処理が開始されなかった場合、完了した場合、リクエストがさらなる処理のためにディスパッチされた場合、"false" を返します。
    次で指定:
    インターフェース AsyncWebRequest の isAsyncStarted
  - isAsyncComplete
```
public boolean isAsyncComplete()
```
    非同期リクエスト処理が完了したかどうか。
    非同期処理が完了した後、リクエストオブジェクトとレスポンスオブジェクトの使用を避けることが重要です。サーブレットコンテナーは、しばしば再利用します。
    次で指定:
    インターフェース AsyncWebRequest の isAsyncComplete
  - startAsync
```
public void startAsync()
```
    インターフェースからコピーされた説明: AsyncWebRequest
    非同期リクエスト処理の開始をマークして、メイン処理スレッドが終了したときに、別のスレッドでさらに処理するためにレスポンスが開いたままになるようにします。
    次で指定:
    インターフェース AsyncWebRequest の startAsync
  - dispatch
```
public void dispatch()
```
    インターフェースからコピーされた説明: AsyncWebRequest
    アプリケーションスレッドでの同時実行後に処理を再開するために、コンテナーにリクエストをディスパッチします。
    次で指定:
    インターフェース AsyncWebRequest の dispatch
  - onStartAsync
```
public void onStartAsync(AsyncEventEE event)
                  throws IOExceptionSE
```
    インターフェースからコピーされた説明: javax.servlet.AsyncListenerEE
    ServletRequest.startAsync()EE メソッドの 1 つを呼び出して、新しい非同期サイクルが開始されていることを、この AsyncListener に通知します。
    再初期化される非同期操作に対応する AsyncContextEE は、特定の event で getAsyncContextEE を呼び出すことで取得できます。
    さらに、この AsyncListener が AsyncContext.addListener(AsyncListener, ServletRequest, ServletResponse)EE の呼び出しを介して登録されていた場合、提供された ServletRequest および ServletResponse オブジェクトは、指定された event でそれぞれ getSuppliedRequestEE および getSuppliedResponseEE を呼び出すことで取得できます。
    この AsyncListener は、指定された AsyncEvent の一部として配信される AsyncContext に自身を（AsyncContext.addListener(javax.servlet.AsyncListener)EE への呼び出しを介して）登録しない限り、新しい非同期サイクルに関連するイベントを受け取りません。
    次で指定:
    インターフェース AsyncListenerEE の onStartAsyncEE
    パラメーター:
    event - 新しい非同期サイクルが開始されていることを示す AsyncEvent
    例外:
    IOExceptionSE - 指定された AsyncEvent の処理中に I/O 関連のエラーが発生した場合
  - onError
```
public void onError(AsyncEventEE event)
             throws IOExceptionSE
```
    インターフェースからコピーされた説明: javax.servlet.AsyncListenerEE
    この AsyncListener に、非同期操作の補完に失敗したことを通知します。
    完了できなかった非同期操作に対応する AsyncContextEE は、指定されたイベントで getAsyncContextEE を呼び出すことによって取得できます。
    さらに、この AsyncListener が AsyncContext.addListener(AsyncListener, ServletRequest, ServletResponse)EE の呼び出しを介して登録されていた場合、提供された ServletRequest および ServletResponse オブジェクトは、指定された event でそれぞれ getSuppliedRequestEE および getSuppliedResponseEE を呼び出すことで取得できます。
    次で指定:
    インターフェース AsyncListenerEE の onErrorEE
    パラメーター:
    event - 非同期操作が完了できなかったことを示す AsyncEvent
    例外:
    IOExceptionSE - 指定された AsyncEvent の処理中に I/O 関連のエラーが発生した場合
  - onTimeout
```
public void onTimeout(AsyncEventEE event)
               throws IOExceptionSE
```
    インターフェースからコピーされた説明: javax.servlet.AsyncListenerEE
    この AsyncListener に、非同期操作がタイムアウトしたことを通知します。
    タイムアウトになった非同期操作に対応する AsyncContextEE は、指定されたイベントで getAsyncContextEE を呼び出すことによって取得できます。
    さらに、この AsyncListener が AsyncContext.addListener(AsyncListener, ServletRequest, ServletResponse)EE の呼び出しを介して登録されていた場合、提供された ServletRequest および ServletResponse オブジェクトは、指定された event でそれぞれ getSuppliedRequestEE および getSuppliedResponseEE を呼び出すことで取得できます。
    次で指定:
    インターフェース AsyncListenerEE の onTimeoutEE
    パラメーター:
    event - 非同期操作がタイムアウトしたことを示す AsyncEvent
    例外:
    IOExceptionSE - 指定された AsyncEvent の処理中に I/O 関連のエラーが発生した場合
  - onComplete
```
public void onComplete(AsyncEventEE event)
                throws IOExceptionSE
```
    インターフェースからコピーされた説明: javax.servlet.AsyncListenerEE
    この AsyncListener に非同期操作が完了したことを通知します。
    完了した非同期操作に対応する AsyncContextEE は、特定のイベントで getAsyncContextEE を呼び出すことによって取得できます。
    さらに、この AsyncListener が AsyncContext.addListener(AsyncListener, ServletRequest, ServletResponse)EE の呼び出しを介して登録されていた場合、提供された ServletRequest および ServletResponse オブジェクトは、指定された event でそれぞれ getSuppliedRequestEE および getSuppliedResponseEE を呼び出すことで取得できます。
    次で指定:
    インターフェース AsyncListenerEE の onCompleteEE
    パラメーター:
    event - 非同期操作が完了したことを示す AsyncEvent
    例外:
    IOExceptionSE - 指定された AsyncEvent の処理中に I/O 関連のエラーが発生した場合

クラス StandardServletAsyncWebRequest

フィールドサマリー

クラス org.springframework.web.context.request.ServletRequestAttributes から継承されたフィールド

クラス org.springframework.web.context.request.AbstractRequestAttributes から継承されたフィールド

インターフェース org.springframework.web.context.request.RequestAttributes から継承されたフィールド

コンストラクターのサマリー

メソッドのサマリー

クラス org.springframework.web.context.request.ServletWebRequest から継承されたメソッド

クラス org.springframework.web.context.request.ServletRequestAttributes から継承されたメソッド

クラス org.springframework.web.context.request.AbstractRequestAttributes から継承されたメソッド

クラス java.lang.ObjectSE から継承されたメソッド

インターフェース org.springframework.web.context.request.NativeWebRequest から継承されたメソッド

インターフェース org.springframework.web.context.request.WebRequest から継承されたメソッド

インターフェース org.springframework.web.context.request.RequestAttributes から継承されたメソッド

コンストラクターの詳細

StandardServletAsyncWebRequest

メソッドの詳細

setTimeout

addTimeoutHandler

addErrorHandler

addCompletionHandler

isAsyncStarted

isAsyncComplete

startAsync

dispatch

onStartAsync

onError

onTimeout

onComplete