public interface AsyncListener extends EventListener
Modifier and Type | Method and Description |
---|---|
void |
onComplete(AsyncEvent event)
Notifies this AsyncListener that an asynchronous operation
has been completed.
|
void |
onError(AsyncEvent event)
Notifies this AsyncListener that an asynchronous operation
has failed to complete.
|
void |
onStartAsync(AsyncEvent event)
Notifies this AsyncListener that a new asynchronous cycle is being
initiated via a call to one of the
ServletRequest.startAsync()
methods. |
void |
onTimeout(AsyncEvent event)
Notifies this AsyncListener that an asynchronous operation
has timed out.
|
void onComplete(AsyncEvent event) throws IOException
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.
event
- the AsyncEvent indicating that an asynchronous
operation has been completedIOException
- if an I/O related error has occurred during the
processing of the given AsyncEventvoid onTimeout(AsyncEvent event) throws IOException
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.
event
- the AsyncEvent indicating that an asynchronous
operation has timed outIOException
- if an I/O related error has occurred during the
processing of the given AsyncEventvoid onError(AsyncEvent event) throws IOException
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.
event
- the AsyncEvent indicating that an asynchronous
operation has failed to completeIOException
- if an I/O related error has occurred during the
processing of the given AsyncEventvoid onStartAsync(AsyncEvent event) throws IOException
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(javax.servlet.AsyncListener)
) with the AsyncContext that
is delivered as part of the given AsyncEvent.
event
- the AsyncEvent indicating that a new asynchronous
cycle is being initiatedIOException
- if an I/O related error has occurred during the
processing of the given AsyncEventCopyright © 2018 JBoss by Red Hat. All rights reserved.