- java.lang.Object
-
- javax.servlet.AsyncEvent
-
public class AsyncEvent extends Object
Event that gets fired when the asynchronous operation initiated on a ServletRequest (via a call toServletRequest.startAsync()orServletRequest.startAsync(ServletRequest, ServletResponse)) has completed, timed out, or produced an error.- Since:
- Servlet 3.0
-
-
Constructor Summary
Constructors Constructor and Description AsyncEvent(AsyncContext context)Constructs an AsyncEvent from the given AsyncContext.AsyncEvent(AsyncContext context, ServletRequest request, ServletResponse response)Constructs an AsyncEvent from the given AsyncContext, ServletRequest, and ServletResponse.AsyncEvent(AsyncContext context, ServletRequest request, ServletResponse response, Throwable throwable)Constructs an AsyncEvent from the given AsyncContext, ServletRequest, ServletResponse, and Throwable.AsyncEvent(AsyncContext context, Throwable throwable)Constructs an AsyncEvent from the given AsyncContext and Throwable.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description AsyncContextgetAsyncContext()Gets the AsyncContext from this AsyncEvent.ServletRequestgetSuppliedRequest()Gets the ServletRequest from this AsyncEvent.ServletResponsegetSuppliedResponse()Gets the ServletResponse from this AsyncEvent.ThrowablegetThrowable()Gets the Throwable from this AsyncEvent.
-
-
-
Constructor Detail
-
AsyncEvent
public AsyncEvent(AsyncContext context)
Constructs an AsyncEvent from the given AsyncContext.- Parameters:
context- the AsyncContex to be delivered with this AsyncEvent
-
AsyncEvent
public AsyncEvent(AsyncContext context, ServletRequest request, ServletResponse response)
Constructs an AsyncEvent from the given AsyncContext, ServletRequest, and ServletResponse.- Parameters:
context- the AsyncContex to be delivered with this AsyncEventrequest- the ServletRequest to be delivered with this AsyncEventresponse- the ServletResponse to be delivered with this AsyncEvent
-
AsyncEvent
public AsyncEvent(AsyncContext context, Throwable throwable)
Constructs an AsyncEvent from the given AsyncContext and Throwable.- Parameters:
context- the AsyncContex to be delivered with this AsyncEventthrowable- the Throwable to be delivered with this AsyncEvent
-
AsyncEvent
public AsyncEvent(AsyncContext context, ServletRequest request, ServletResponse response, Throwable throwable)
Constructs an AsyncEvent from the given AsyncContext, ServletRequest, ServletResponse, and Throwable.- Parameters:
context- the AsyncContex to be delivered with this AsyncEventrequest- the ServletRequest to be delivered with this AsyncEventresponse- the ServletResponse to be delivered with this AsyncEventthrowable- the Throwable to be delivered with this AsyncEvent
-
-
Method Detail
-
getAsyncContext
public AsyncContext getAsyncContext()
Gets the AsyncContext from this AsyncEvent.- Returns:
- the AsyncContext that was used to initialize this AsyncEvent
-
getSuppliedRequest
public ServletRequest getSuppliedRequest()
Gets the ServletRequest from this AsyncEvent.If the AsyncListener to which this AsyncEvent is being delivered was added using
AsyncContext.addListener(AsyncListener, ServletRequest, ServletResponse), the returned ServletRequest will be the same as the one supplied to the above method. If the AsyncListener was added viaAsyncContext.addListener(AsyncListener), this method must return null.- Returns:
- the ServletRequest that was used to initialize this AsyncEvent, or null if this AsyncEvent was initialized without any ServletRequest
-
getSuppliedResponse
public ServletResponse getSuppliedResponse()
Gets the ServletResponse from this AsyncEvent.If the AsyncListener to which this AsyncEvent is being delivered was added using
AsyncContext.addListener(AsyncListener, ServletRequest, ServletResponse), the returned ServletResponse will be the same as the one supplied to the above method. If the AsyncListener was added viaAsyncContext.addListener(AsyncListener), this method must return null.- Returns:
- the ServletResponse that was used to initialize this AsyncEvent, or null if this AsyncEvent was initialized without any ServletResponse
-
getThrowable
public Throwable getThrowable()
Gets the Throwable from this AsyncEvent.- Returns:
- the Throwable that was used to initialize this AsyncEvent, or null if this AsyncEvent was initialized without any Throwable
-
-
Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/servlet/asyncevent.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.