Jakarta EE 11.0.0 · jakarta.servlet.AsyncListener · APIdia, the JavaDoc alternative

Modifier and Type	Method and Description
public void	onComplete(AsyncEvent the AsyncEvent indicating that an asynchronous operation has been completed event) Notifies this AsyncListener that an asynchronous operation has been completed.
public void	onError(AsyncEvent the AsyncEvent indicating that an asynchronous operation has failed to complete event) Notifies this AsyncListener that an asynchronous operation has failed to complete.
public void	onStartAsync(AsyncEvent the AsyncEvent indicating that a new asynchronous cycle is being initiated event) Notifies this AsyncListener that a new asynchronous cycle is being initiated via a call to one of the `ServletRequest#startAsync` methods.
public void	onTimeout(AsyncEvent the AsyncEvent indicating that an asynchronous operation has timed out event) Notifies this AsyncListener that an asynchronous operation has timed out.

Method Detail

onComplete back to summary

onComplete	back to summary
public void onComplete(AsyncEvent event) throws IOException Notifies this AsyncListener that an asynchronous operation has been completed. The `AsyncContext` corresponding to the asynchronous operation that has been completed may be obtained by calling `getAsyncContext` on the given `event`. In addition, if this AsyncListener had been registered via a call to `AsyncContext#addListener(AsyncListener, ServletRequest, ServletResponse)`, the supplied ServletRequest and ServletResponse objects may be retrieved by calling `getSuppliedRequest` and `getSuppliedResponse`, respectively, on the given `event`. Parameters event:AsyncEvent the AsyncEvent indicating that an asynchronous operation has been completed Exceptions IOException: if an I/O related error has occurred during the processing of the given AsyncEvent

public void onComplete(AsyncEvent event) throws IOException

Notifies this AsyncListener that an asynchronous operation has been completed.

The AsyncContext corresponding to the asynchronous operation that has been completed may be obtained by calling getAsyncContext on the given event.

In addition, if this AsyncListener had been registered via a call to AsyncContext#addListener(AsyncListener, ServletRequest, ServletResponse), the supplied ServletRequest and ServletResponse objects may be retrieved by calling getSuppliedRequest and getSuppliedResponse, respectively, on the given event.

Parameters

event:AsyncEvent: the AsyncEvent indicating that an asynchronous operation has been completed

Exceptions

IOException:: if an I/O related error has occurred during the processing of the given AsyncEvent

onError back to summary

onError	back to summary
public void onError(AsyncEvent event) throws IOException Notifies this AsyncListener that an asynchronous operation has failed to complete. The `AsyncContext` corresponding to the asynchronous operation that failed to complete may be obtained by calling `getAsyncContext` on the given `event`. In addition, if this AsyncListener had been registered via a call to `AsyncContext#addListener(AsyncListener, ServletRequest, ServletResponse)`, the supplied ServletRequest and ServletResponse objects may be retrieved by calling `getSuppliedRequest` and `getSuppliedResponse`, respectively, on the given `event`. Parameters event:AsyncEvent the AsyncEvent indicating that an asynchronous operation has failed to complete Exceptions IOException: if an I/O related error has occurred during the processing of the given AsyncEvent

public void onError(AsyncEvent event) throws IOException

Notifies this AsyncListener that an asynchronous operation has failed to complete.

The AsyncContext corresponding to the asynchronous operation that failed to complete may be obtained by calling getAsyncContext on the given event.

Parameters

event:AsyncEvent: the AsyncEvent indicating that an asynchronous operation has failed to complete

Exceptions

IOException:: if an I/O related error has occurred during the processing of the given AsyncEvent

onStartAsync back to summary

onStartAsync	back to summary
public void onStartAsync(AsyncEvent event) throws IOException Notifies this AsyncListener that a new asynchronous cycle is being initiated via a call to one of the `ServletRequest#startAsync` methods. The `AsyncContext` corresponding to the asynchronous operation that is being reinitialized may be obtained by calling `getAsyncContext` on the given `event`. In addition, if this AsyncListener had been registered via a call to `AsyncContext#addListener(AsyncListener, ServletRequest, ServletResponse)`, the supplied ServletRequest and ServletResponse objects may be retrieved by calling `getSuppliedRequest` and `getSuppliedResponse`, respectively, on the given `event`. This AsyncListener will not receive any events related to the new asynchronous cycle unless it registers itself (via a call to `AsyncContext#addListener`) with the AsyncContext that is delivered as part of the given AsyncEvent. Parameters event:AsyncEvent the AsyncEvent indicating that a new asynchronous cycle is being initiated Exceptions IOException: if an I/O related error has occurred during the processing of the given AsyncEvent

public void onStartAsync(AsyncEvent event) throws IOException

Notifies this AsyncListener that a new asynchronous cycle is being initiated via a call to one of the ServletRequest#startAsync methods.

The AsyncContext corresponding to the asynchronous operation that is being reinitialized may be obtained by calling getAsyncContext on the given event.

This AsyncListener will not receive any events related to the new asynchronous cycle unless it registers itself (via a call to AsyncContext#addListener) with the AsyncContext that is delivered as part of the given AsyncEvent.

Parameters

event:AsyncEvent: the AsyncEvent indicating that a new asynchronous cycle is being initiated

Exceptions

IOException:: if an I/O related error has occurred during the processing of the given AsyncEvent

onTimeout back to summary

onTimeout	back to summary
public void onTimeout(AsyncEvent event) throws IOException Notifies this AsyncListener that an asynchronous operation has timed out. The `AsyncContext` corresponding to the asynchronous operation that has timed out may be obtained by calling `getAsyncContext` on the given `event`. In addition, if this AsyncListener had been registered via a call to `AsyncContext#addListener(AsyncListener, ServletRequest, ServletResponse)`, the supplied ServletRequest and ServletResponse objects may be retrieved by calling `getSuppliedRequest` and `getSuppliedResponse`, respectively, on the given `event`. Parameters event:AsyncEvent the AsyncEvent indicating that an asynchronous operation has timed out Exceptions IOException: if an I/O related error has occurred during the processing of the given AsyncEvent

public void onTimeout(AsyncEvent event) throws IOException

Notifies this AsyncListener that an asynchronous operation has timed out.

The AsyncContext corresponding to the asynchronous operation that has timed out may be obtained by calling getAsyncContext on the given event.

Parameters

event:AsyncEvent: the AsyncEvent indicating that an asynchronous operation has timed out

Exceptions

IOException:: if an I/O related error has occurred during the processing of the given AsyncEvent

public Interface AsyncListener

Method Summary

Method Detail