パッケージ jakarta.servlet

インターフェース AsyncListener

  • すべてのスーパーインターフェース:
    EventListenerSE
    public interface AsyncListener
extends EventListenerSE
    リスナーが追加された ServletRequest で開始された非同期操作が完了、タイムアウト、エラーになった場合に通知されるリスナー。
    導入:
    Servlet 3.0

    • メソッドの詳細

      • onComplete

        void onComplete​(AsyncEvent event)
         throws IOExceptionSE
        この AsyncListener に非同期操作が完了したことを通知します。

        完了した非同期操作に対応する AsyncContext は、特定のイベントで getAsyncContext を呼び出すことによって取得できます。

        さらに、この AsyncListener が AsyncContext.addListener(AsyncListener, ServletRequest, ServletResponse) の呼び出しを介して登録されていた場合、提供された ServletRequest および ServletResponse オブジェクトは、指定された event でそれぞれ getSuppliedRequest および getSuppliedResponse を呼び出すことで取得できます。

        パラメーター:
        event - 非同期操作が完了したことを示す AsyncEvent
        例外:
        IOExceptionSE - 指定された AsyncEvent の処理中に I/O 関連のエラーが発生した場合

      • onTimeout

        void onTimeout​(AsyncEvent event)
        throws IOExceptionSE
        この AsyncListener に、非同期操作がタイムアウトしたことを通知します。

        タイムアウトになった非同期操作に対応する AsyncContext は、指定されたイベントで getAsyncContext を呼び出すことによって取得できます。

        さらに、この AsyncListener が AsyncContext.addListener(AsyncListener, ServletRequest, ServletResponse) の呼び出しを介して登録されていた場合、提供された ServletRequest および ServletResponse オブジェクトは、指定された event でそれぞれ getSuppliedRequest および getSuppliedResponse を呼び出すことで取得できます。

        パラメーター:
        event - 非同期操作がタイムアウトしたことを示す AsyncEvent
        例外:
        IOExceptionSE - 指定された AsyncEvent の処理中に I/O 関連のエラーが発生した場合

      • onError

        void onError​(AsyncEvent event)
      throws IOExceptionSE
        この AsyncListener に、非同期操作の完了に失敗したことを通知します。

        完了できなかった非同期操作に対応する AsyncContext は、指定されたイベントで getAsyncContext を呼び出すことによって取得できます。

        さらに、この AsyncListener が AsyncContext.addListener(AsyncListener, ServletRequest, ServletResponse) の呼び出しを介して登録されていた場合、提供された ServletRequest および ServletResponse オブジェクトは、指定された event でそれぞれ getSuppliedRequest および getSuppliedResponse を呼び出すことで取得できます。

        パラメーター:
        event - 非同期操作が完了できなかったことを示す AsyncEvent
        例外:
        IOExceptionSE - 指定された AsyncEvent の処理中に I/O 関連のエラーが発生した場合

      • onStartAsync

        void onStartAsync​(AsyncEvent event)
           throws IOExceptionSE
        ServletRequest.startAsync() メソッドの 1 つを呼び出して、新しい非同期サイクルが開始されていることを、この AsyncListener に通知します。

        再初期化される非同期操作に対応する AsyncContext は、特定の event で getAsyncContext を呼び出すことで取得できます。

        さらに、この AsyncListener が AsyncContext.addListener(AsyncListener, ServletRequest, ServletResponse) の呼び出しを介して登録されていた場合、提供された ServletRequest および ServletResponse オブジェクトは、指定された event でそれぞれ getSuppliedRequest および getSuppliedResponse を呼び出すことで取得できます。

        この AsyncListener は、指定された AsyncEvent の一部として配信される AsyncContext に自身を（AsyncContext.addListener(jakarta.servlet.AsyncListener) への呼び出しを介して）登録しない限り、新しい非同期サイクルに関連するイベントを受け取りません。

        パラメーター:
        event - 新しい非同期サイクルが開始されていることを示す AsyncEvent
        例外:
        IOExceptionSE - 指定された AsyncEvent の処理中に I/O 関連のエラーが発生した場合