javax.servlet

クラス AsyncEvent

java.lang.Object

javax.servlet.AsyncEvent

public class AsyncEvent
extends Object

ServletRequestで開始された非同期操作(ServletRequest.startAsync() またはServletRequest.startAsync(ServletRequest, ServletResponse)の呼び出し) が完了した、もしくはタイムアウトした、エラーが発生したときに発生するイベントです。

導入されたバージョン:

Servlet 3.0

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

コンストラクタ

コンストラクタと説明
AsyncEvent(AsyncContext context) 与えられたAsyncContextからAsyncEventを生成します。
AsyncEvent(AsyncContext context, ServletRequest request, ServletResponse response) 与えられたAsyncContextとServletRequestとServletResponseからAsyncEventを生成します。
AsyncEvent(AsyncContext context, ServletRequest request, ServletResponse response, Throwable throwable) 与えられたAsyncContextとServletRequestとServletResponseとThrowableからAsyncEventを生成します。
AsyncEvent(AsyncContext context, Throwable throwable) 与えられたAsyncContextとThrowableからAsyncEventを生成します。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
AsyncContext	getAsyncContext() このAsyncEventからAsyncContextを取得します。
ServletRequest	getSuppliedRequest() このAsyncEventからServletRequestを取得します。
ServletResponse	getSuppliedResponse() このAsyncEventからServletResponseを取得します。
Throwable	getThrowable() このAsyncEventからThrowableを取得します。

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

AsyncEvent

public AsyncEvent(AsyncContext context)

与えられたAsyncContextからAsyncEventを生成します。

パラメータ:

context - このAsyncEventと共に配信されるAsyncContext

AsyncEvent

public AsyncEvent(AsyncContext context,
                  ServletRequest request,
                  ServletResponse response)

与えられたAsyncContextとServletRequestとServletResponseからAsyncEventを生成します。

パラメータ:

context - このAsyncEventと共に配信されるAsyncContext

request - このAsyncEventと共に配信されるServletRequest

response - このAsyncEventと共に配信されるServletResponse

AsyncEvent

public AsyncEvent(AsyncContext context,
                  Throwable throwable)

与えられたAsyncContextとThrowableからAsyncEventを生成します。

パラメータ:

context - このAsyncEventと共に配信されるAsyncContext

throwable - このAsyncEventと共に配信されるThrowable

AsyncEvent

public AsyncEvent(AsyncContext context,
                  ServletRequest request,
                  ServletResponse response,
                  Throwable throwable)

与えられたAsyncContextとServletRequestとServletResponseとThrowableからAsyncEventを生成します。

パラメータ:

context - このAsyncEventと共に配信されるAsyncContext

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は上記のメソッドに提供されるServletRequestと同じになります。 AsyncListenerがAsyncContext.addListener(AsyncListener)を使用して追加された場合、このメソッドはnullを返す必要があります。

戻り値:

このAsyncEventの初期化に使用されたServletRequest、ServletRequest無しでこのAsyncEventが初期化された場合はnull

getSuppliedResponse

public ServletResponse getSuppliedResponse()

このAsyncEventからServletResponseを取得します。

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

戻り値:

このAsyncEventの初期化に使用されたServletResponse、ServletResponse無しでこのAsyncEventが初期化された場合はnull

getThrowable

public Throwable getThrowable()

このAsyncEventからThrowableを取得します。

戻り値:

このAsyncEventの初期化に使用されたThrowable、Throwable無しでこのAsyncEventが初期化された場合はnull