パッケージ jakarta.servlet

クラス AsyncEvent

java.lang.ObjectSE
jakarta.servlet.AsyncEvent

public class AsyncEvent extends ObjectSE
ServletRequest で(ServletRequest.startAsync() または ServletRequest.startAsync(ServletRequest, ServletResponse) の呼び出しを介して)開始された非同期操作が完了、タイムアウト、エラーを生成したときに発生するイベント。
導入:
Servlet 3.0
  • コンストラクターの詳細

    • AsyncEvent

      public AsyncEvent(AsyncContext context)
      指定された AsyncContext から AsyncEvent を構築します。
      パラメーター:
      context - この AsyncEvent とともに提供される AsyncContex
    • AsyncEvent

      public AsyncEvent(AsyncContext context, ServletRequest request, ServletResponse response)
      指定された AsyncContext、ServletRequest、ServletResponse から AsyncEvent を構築します。
      パラメーター:
      context - この AsyncEvent とともに提供される AsyncContex
      request - この AsyncEvent とともに提供される ServletRequest
      response - この AsyncEvent とともに提供される ServletResponse
    • AsyncEvent

      public AsyncEvent(AsyncContext context, ThrowableSE throwable)
      指定された AsyncContext と Throwable から AsyncEvent を構築します。
      パラメーター:
      context - この AsyncEvent とともに提供される AsyncContex
      throwable - この AsyncEvent で提供される Throwable
    • AsyncEvent

      public AsyncEvent(AsyncContext context, ServletRequest request, ServletResponse response, ThrowableSE throwable)
      指定された AsyncContext、ServletRequest、ServletResponse、Throwable から AsyncEvent を構築します。
      パラメーター:
      context - この AsyncEvent とともに提供される AsyncContex
      request - この AsyncEvent とともに提供される ServletRequest
      response - この AsyncEvent とともに提供される ServletResponse
      throwable - この AsyncEvent で提供される Throwable
  • メソッドの詳細

    • getAsyncContext

      public AsyncContext getAsyncContext()
      この AsyncEvent から AsyncContext を取得します。
      戻り値:
      この AsyncEvent を初期化するために使用された AsyncContext
    • getSuppliedRequest

      public ServletRequest getSuppliedRequest()
      この AsyncEvent から ServletRequest を取得します。

      この AsyncEvent が配信されている AsyncListener が AsyncContext.addListener(AsyncListener, ServletRequest, ServletResponse) を使用して追加された場合、返される ServletRequest は、上記のメソッドに提供されたものと同じになります。AsyncListener が AsyncContext.addListener(AsyncListener) を介して追加された場合、このメソッドは null を返す必要があります。

      戻り値:
      この AsyncEvent の初期化に使用された ServletRequest、またはこの AsyncEvent が ServletRequest なしで初期化された場合は null
    • getSuppliedResponse

      public ServletResponse getSuppliedResponse()
      この AsyncEvent から ServletResponse を取得します。

      この AsyncEvent が配信されている AsyncListener が AsyncContext.addListener(AsyncListener, ServletRequest, ServletResponse) を使用して追加された場合、返される ServletResponse は、上記のメソッドに提供されたものと同じになります。AsyncListener が AsyncContext.addListener(AsyncListener) を介して追加された場合、このメソッドは null を返す必要があります。

      戻り値:
      この AsyncEvent の初期化に使用された ServletResponse、またはこの AsyncEvent が ServletResponse なしで初期化された場合は null
    • getThrowable

      public ThrowableSE getThrowable()
      この AsyncEvent から Throwable を取得します。
      戻り値:
      この AsyncEvent を初期化するために使用された Throwable、またはこの AsyncEvent が Throwable なしで初期化された場合は null