Tomcat 10.1.19 · jakarta.servlet.AsyncContext · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
public static final String	ASYNC_CONTEXT_PATH The attribute name for the Context Path of the async request
public static final String	ASYNC_MAPPING The attribute name for the Mapping of the async request
public static final String	ASYNC_PATH_INFO The attribute name for the Path Info of the async request
public static final String	ASYNC_QUERY_STRING The attribute name for the Query String of the async request
public static final String	ASYNC_REQUEST_URI The attribute name for the URI of the async request
public static final String	ASYNC_SERVLET_PATH The attribute name for the Servlet Path of the async request

Method Summary

Modifier and Type	Method and Description
public void	addListener(AsyncListener an AsyncListener that will be called with AsyncEvent objects listener) Adds an event listener that will be called for different AsyncEvents fire
public void	addListener(AsyncListener an AsyncListener that will be called with AsyncEvent objects listener, ServletRequest the ServletRequest that will be passed with the AsyncEvent request, ServletResponse the ServletResponse that will be passed with the AsyncEvent response) Adds an event listener that will be called when different AsyncEvents fire
public void	complete() Completes the async request processing and closes the response stream
public < The type to create that extends AsyncListener T extends AsyncListener> T	Returns: the newly created AsyncListener object createListener(Class<T> The class to instantiate to create the listener clazz) Creates and returns an AsyncListener object
public void	dispatch()
public void	dispatch(String The path to which the request/response should be dispatched relative to the `ServletContext` from which this async request was started. path)
public void	dispatch(ServletContext The `ServletContext` to which the request/response should be dispatched. context, String The path to which the request/response should be dispatched relative to the specified `ServletContext`. path)
public ServletRequest	Returns: a reference to the ServletRequest object getRequest()
public ServletResponse	Returns: a reference to the ServletResponse object getResponse()
public long	Returns: The timeout in milliseconds. 0 or less indicates no timeout. getTimeout() Get the current timeout.
public boolean	Returns: true if the Request and Response are the original ones hasOriginalRequestAndResponse()
public void	setTimeout(long The timeout in milliseconds. 0 or less indicates no timeout. timeout) Set the timeout.
public void	start(Runnable a Runnable that the new thread will run run) Starts a new thread to process the asynchronous request

ASYNC_CONTEXT_PATH	back to summary
public static final String ASYNC_CONTEXT_PATH The attribute name for the Context Path of the async request

ASYNC_MAPPING	back to summary
public static final String ASYNC_MAPPING The attribute name for the Mapping of the async request

ASYNC_PATH_INFO	back to summary
public static final String ASYNC_PATH_INFO The attribute name for the Path Info of the async request

ASYNC_QUERY_STRING	back to summary
public static final String ASYNC_QUERY_STRING The attribute name for the Query String of the async request

ASYNC_REQUEST_URI	back to summary
public static final String ASYNC_REQUEST_URI The attribute name for the URI of the async request

ASYNC_SERVLET_PATH	back to summary
public static final String ASYNC_SERVLET_PATH The attribute name for the Servlet Path of the async request

Method Detail

addListener	back to summary
public void addListener(AsyncListener listener) Adds an event listener that will be called for different AsyncEvents fire Parameters listener:AsyncListener an AsyncListener that will be called with AsyncEvent objects

addListener

back to summary

public void addListener(AsyncListener listener)

Adds an event listener that will be called for different AsyncEvents fire

Parameters

listener:AsyncListener: an AsyncListener that will be called with AsyncEvent objects

addListener	back to summary
public void addListener(AsyncListener listener, ServletRequest request, ServletResponse response) Adds an event listener that will be called when different AsyncEvents fire Parameters listener:AsyncListener an AsyncListener that will be called with AsyncEvent objects request:ServletRequest the ServletRequest that will be passed with the AsyncEvent response:ServletResponse the ServletResponse that will be passed with the AsyncEvent

addListener

back to summary

public void addListener(AsyncListener listener, ServletRequest request, ServletResponse response)

Adds an event listener that will be called when different AsyncEvents fire

Parameters

listener:AsyncListener: an AsyncListener that will be called with AsyncEvent objects
request:ServletRequest: the ServletRequest that will be passed with the AsyncEvent
response:ServletResponse: the ServletResponse that will be passed with the AsyncEvent

complete	back to summary
public void complete() Completes the async request processing and closes the response stream

createListener	back to summary
public <T extends AsyncListener> T createListener(Class<T> clazz) throws ServletException Creates and returns an AsyncListener object Parameters <T> The type to create that extends AsyncListener clazz:Class<T> The class to instantiate to create the listener Returns:T the newly created AsyncListener object Exceptions ServletException: if the listener cannot be created

createListener

back to summary

public <T extends AsyncListener> T createListener(Class<T> clazz) throws ServletException

Creates and returns an AsyncListener object

Parameters

<T>: The type to create that extends AsyncListener
clazz:Class<T>: The class to instantiate to create the listener

Returns:T

the newly created AsyncListener object

Exceptions

ServletException:: if the listener cannot be created

dispatch back to summary

dispatch	back to summary
public void dispatch() Exceptions IllegalStateException: if this method is called when the request is not in asynchronous mode. The request is in asynchronous mode after `jakarta.servlet.http.HttpServletRequest#startAsync()` or `jakarta.servlet.http.HttpServletRequest#startAsync(ServletRequest, ServletResponse)` has been called and before `complete()` or any other dispatch() method has been called.

public void dispatch()

Exceptions

IllegalStateException:: if this method is called when the request is not in asynchronous mode. The request is in asynchronous mode after jakarta.servlet.http.HttpServletRequest#startAsync() or jakarta.servlet.http.HttpServletRequest#startAsync(ServletRequest, ServletResponse) has been called and before complete() or any other dispatch() method has been called.

dispatch back to summary

dispatch	back to summary
public void dispatch(String path) Parameters path:String The path to which the request/response should be dispatched relative to the `ServletContext` from which this async request was started. Exceptions IllegalStateException: if this method is called when the request is not in asynchronous mode. The request is in asynchronous mode after `jakarta.servlet.http.HttpServletRequest#startAsync()` or `jakarta.servlet.http.HttpServletRequest#startAsync(ServletRequest, ServletResponse)` has been called and before `complete()` or any other dispatch() method has been called.

public void dispatch(String path)

Parameters

path:String: The path to which the request/response should be dispatched relative to the ServletContext from which this async request was started.

Exceptions

IllegalStateException:: if this method is called when the request is not in asynchronous mode. The request is in asynchronous mode after jakarta.servlet.http.HttpServletRequest#startAsync() or jakarta.servlet.http.HttpServletRequest#startAsync(ServletRequest, ServletResponse) has been called and before complete() or any other dispatch() method has been called.

dispatch back to summary

dispatch	back to summary
public void dispatch(ServletContext context, String path) Parameters context:ServletContext The `ServletContext` to which the request/response should be dispatched. path:String The path to which the request/response should be dispatched relative to the specified `ServletContext`. Exceptions IllegalStateException: if this method is called when the request is not in asynchronous mode. The request is in asynchronous mode after `jakarta.servlet.http.HttpServletRequest#startAsync()` or `jakarta.servlet.http.HttpServletRequest#startAsync(ServletRequest, ServletResponse)` has been called and before `complete()` or any other dispatch() method has been called.

public void dispatch(ServletContext context, String path)

Parameters

context:ServletContext: The ServletContext to which the request/response should be dispatched.
path:String: The path to which the request/response should be dispatched relative to the specified ServletContext.

Exceptions

IllegalStateException:: if this method is called when the request is not in asynchronous mode. The request is in asynchronous mode after jakarta.servlet.http.HttpServletRequest#startAsync() or jakarta.servlet.http.HttpServletRequest#startAsync(ServletRequest, ServletResponse) has been called and before complete() or any other dispatch() method has been called.

getRequest	back to summary
public ServletRequest getRequest() Returns:ServletRequest a reference to the ServletRequest object

getResponse	back to summary
public ServletResponse getResponse() Returns:ServletResponse a reference to the ServletResponse object

getTimeout	back to summary
public long getTimeout() Get the current timeout. Returns:long The timeout in milliseconds. 0 or less indicates no timeout.

getTimeout

back to summary

public long getTimeout()

Get the current timeout.

Returns:long: The timeout in milliseconds. 0 or less indicates no timeout.

hasOriginalRequestAndResponse	back to summary
public boolean hasOriginalRequestAndResponse() Returns:boolean true if the Request and Response are the original ones

setTimeout	back to summary
public void setTimeout(long timeout) Set the timeout. Parameters timeout:long The timeout in milliseconds. 0 or less indicates no timeout.

setTimeout

back to summary

public void setTimeout(long timeout)

Set the timeout.

Parameters

timeout:long: The timeout in milliseconds. 0 or less indicates no timeout.

start	back to summary
public void start(Runnable run) Starts a new thread to process the asynchronous request Parameters run:Runnable a Runnable that the new thread will run

start

back to summary

public void start(Runnable run)

Starts a new thread to process the asynchronous request

Parameters

run:Runnable: a Runnable that the new thread will run

public Interface AsyncContext

Field Summary

Method Summary

Field Detail

Method Detail