javax.servlet

インタフェース AsyncListener

すべてのスーパーインタフェース:

EventListener

public interface AsyncListener
extends EventListener

このリスナーが追加されたServletRequestで開始された非同期操作が完了した、タイムアウトした、エラーが発生した場合に通知されるリスナー。

導入されたバージョン:

Servlet 3.0

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	onComplete(AsyncEvent event) このAsyncListenerに非同期操作が完了したことを通知します。
void	onError(AsyncEvent event) このAsyncListenerに非同期操作が完了する事に失敗したことを通知します。
void	onStartAsync(AsyncEvent event) このAsyncListenerにServletRequest.startAsync()メソッドのうちの一つが使用されて新しい非同期サイクルが開始されたことを通知します。
void	onTimeout(AsyncEvent event) このAsyncListenerに非同期操作がタイムアウトしたことを通知します。

メソッドの詳細

onComplete

void onComplete(AsyncEvent event)
         throws IOException

このAsyncListenerに非同期操作が完了したことを通知します。

与えられたイベントでgetAsyncContextを呼び出すことで完了した非同期操作に対応するAsyncContextを取得できます。

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

パラメータ:

event - 非同期操作が完了したことを示すAsyncEvent

例外:

IOException - 指定されたAsyncEventの処理中にI/O関連のエラーが発生した場合

onTimeout

void onTimeout(AsyncEvent event)
        throws IOException

このAsyncListenerに非同期操作がタイムアウトしたことを通知します。

与えられたイベントでgetAsyncContextを呼び出すことでタイムアウトした非同期操作に対応するAsyncContextを取得できます。

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

パラメータ:

event - 非同期操作がタイムアウトしたことを示すAsyncEvent

例外:

IOException - 指定されたAsyncEventの処理中にI/O関連のエラーが発生した場合

onError

void onError(AsyncEvent event)
      throws IOException

このAsyncListenerに非同期操作が完了する事に失敗したことを通知します。

与えられたイベントでgetAsyncContextを呼び出すことで完了する事に失敗した非同期操作に対応するAsyncContextを取得できます。

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

パラメータ:

event - 非同期操作の完了する事に失敗したことを示すAsyncEvent

例外:

IOException - 指定されたAsyncEventの処理中にI/O関連のエラーが発生した場合

onStartAsync

void onStartAsync(AsyncEvent event)
           throws IOException

このAsyncListenerにServletRequest.startAsync()メソッドのうちの一つが使用されて新しい非同期サイクルが開始されたことを通知します。

与えられたイベントでgetAsyncContextを呼び出すことで再初期化されている非同期操作に対応するAsyncContextを取得できます。

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

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

パラメータ:

event - 新しい非同期サイクルが開始されていることを示すAsyncEvent

例外:

IOException - 指定されたAsyncEventの処理中にI/O関連のエラーが発生した場合