Modifier and Type	Class and Description
private static class	AsyncContextImpl.AsyncRunnable
private static class	AsyncContextImpl.DebugException
private static class	AsyncContextImpl.RunnableWrapper

Modifier and Type	Field and Description
private final Object	asyncContextLock
private Context	context
private volatile Runnable	dispatch
private AsyncEvent	event
private final AtomicBoolean	hasErrorProcessingStarted
private final AtomicBoolean	hasOnErrorReturned
private boolean	hasOriginalRequestAndResponse
private final List<AsyncListenerWrapper>	listeners
private static final Log	log
private volatile Request	request
private volatile ServletRequest	servletRequest
private volatile ServletResponse	servletResponse
protected static final StringManager	sm
private long	timeout

Access	Constructor and Description
public	AsyncContextImpl(Request request)

Method Summary

Modifier and Type	Method and Description
public void	addListener(AsyncListener an AsyncListener that will be called with AsyncEvent objects listener) Implements jakarta.servlet.AsyncContext.addListener. 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 servletRequest, ServletResponse the ServletResponse that will be passed with the AsyncEvent servletResponse) Implements jakarta.servlet.AsyncContext.addListener. Adds an event listener that will be called when different AsyncEvents fire
private void	check()
private void	clearServletRequestResponse()
public void	complete() Implements jakarta.servlet.AsyncContext.complete. Completes the async request processing and closes the response stream
public <T extends AsyncListener> T	createListener(Class<T> The class to instantiate to create the listener clazz) Implements jakarta.servlet.AsyncContext.createListener. Creates and returns an AsyncListener object
public void	decrementInProgressAsyncCount() Implements org.apache.coyote.AsyncContextCallback.decrementInProgressAsyncCount. Used to notify the Context that async processing has ended.
public void	dispatch() Implements jakarta.servlet.AsyncContext.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) Implements jakarta.servlet.AsyncContext.dispatch.
public void	dispatch(ServletContext The `ServletContext` to which the request/response should be dispatched. servletContext, String The path to which the request/response should be dispatched relative to the specified `ServletContext`. path) Implements jakarta.servlet.AsyncContext.dispatch.
protected void	doInternalDispatch()
public void	fireOnComplete() Implements org.apache.coyote.AsyncContextCallback.fireOnComplete.
public ServletRequest	getRequest() Implements jakarta.servlet.AsyncContext.getRequest.
public ServletResponse	getResponse() Implements jakarta.servlet.AsyncContext.getResponse.
public long	getTimeout() Implements jakarta.servlet.AsyncContext.getTimeout. Get the current timeout.
public boolean	hasOriginalRequestAndResponse() Implements jakarta.servlet.AsyncContext.hasOriginalRequestAndResponse.
public void	incrementInProgressAsyncCount() Implements org.apache.coyote.AsyncContextCallback.incrementInProgressAsyncCount. Used to notify the Context that async processing has started.
public boolean	isAvailable() Implements org.apache.coyote.AsyncContextCallback.isAvailable. Reports if the web application associated with this async request is available.
public boolean	isStarted()
private void	logDebug(String method)
public void	recycle()
public void	setErrorState(Throwable t, boolean fireOnError)
public void	setStarted(Context context, ServletRequest request, ServletResponse response, boolean originalRequestResponse)
public void	setTimeout(long The timeout in milliseconds. 0 or less indicates no timeout. timeout) Implements jakarta.servlet.AsyncContext.setTimeout. Set the timeout.
public void	start(final Runnable a Runnable that the new thread will run run) Implements jakarta.servlet.AsyncContext.start. Starts a new thread to process the asynchronous request
public boolean	timeout()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

asyncContextLock	back to summary
private final Object asyncContextLock

context	back to summary
private Context context

dispatch	back to summary
private volatile Runnable dispatch

event	back to summary
private AsyncEvent event

hasErrorProcessingStarted	back to summary
private final AtomicBoolean hasErrorProcessingStarted

hasOnErrorReturned	back to summary
private final AtomicBoolean hasOnErrorReturned

hasOriginalRequestAndResponse	back to summary
private boolean hasOriginalRequestAndResponse

listeners	back to summary
private final List<AsyncListenerWrapper> listeners

log	back to summary
private static final Log log

request	back to summary
private volatile Request request

servletRequest	back to summary
private volatile ServletRequest servletRequest

servletResponse	back to summary
private volatile ServletResponse servletResponse

sm	back to summary
protected static final StringManager sm

timeout	back to summary
private long timeout

Constructor Detail

AsyncContextImpl	back to summary
public AsyncContextImpl(Request request)

Method Detail

addListener	back to summary
public void addListener(AsyncListener listener) Implements jakarta.servlet.AsyncContext.addListener. Doc from jakarta.servlet.AsyncContext.addListener. Adds an event listener that will be called for different AsyncEvents fire Parameters listener:AsyncListener an AsyncListener that will be called with AsyncEvent objects Annotations @Override

addListener

back to summary

public void addListener(AsyncListener listener)

Implements jakarta.servlet.AsyncContext.addListener.

Doc from jakarta.servlet.AsyncContext.addListener.

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

Parameters

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

Annotations

@Override

addListener	back to summary
public void addListener(AsyncListener listener, ServletRequest servletRequest, ServletResponse servletResponse) Implements jakarta.servlet.AsyncContext.addListener. Doc from jakarta.servlet.AsyncContext.addListener. Adds an event listener that will be called when different AsyncEvents fire Parameters listener:AsyncListener an AsyncListener that will be called with AsyncEvent objects servletRequest:ServletRequest the ServletRequest that will be passed with the AsyncEvent servletResponse:ServletResponse the ServletResponse that will be passed with the AsyncEvent Annotations @Override

addListener

back to summary

public void addListener(AsyncListener listener, ServletRequest servletRequest, ServletResponse servletResponse)

Implements jakarta.servlet.AsyncContext.addListener.

Doc from jakarta.servlet.AsyncContext.addListener.

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

Parameters

listener:AsyncListener: an AsyncListener that will be called with AsyncEvent objects
servletRequest:ServletRequest: the ServletRequest that will be passed with the AsyncEvent
servletResponse:ServletResponse: the ServletResponse that will be passed with the AsyncEvent

Annotations

@Override

check	back to summary
private void check()

clearServletRequestResponse	back to summary
private void clearServletRequestResponse()

complete	back to summary
public void complete() Implements jakarta.servlet.AsyncContext.complete. Doc from jakarta.servlet.AsyncContext.complete. Completes the async request processing and closes the response stream Annotations @Override

complete

back to summary

public void complete()

Implements jakarta.servlet.AsyncContext.complete.

Doc from jakarta.servlet.AsyncContext.complete.

Completes the async request processing and closes the response stream

Annotations

@Override

createListener	back to summary
public <T extends AsyncListener> T createListener(Class<T> clazz) throws ServletException Implements jakarta.servlet.AsyncContext.createListener. Doc from jakarta.servlet.AsyncContext.createListener. 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 Annotations @SuppressWarnings:unchecked @Override Exceptions ServletException: if the listener cannot be created

createListener

back to summary

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

Implements jakarta.servlet.AsyncContext.createListener.

Doc from jakarta.servlet.AsyncContext.createListener.

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

Annotations

@SuppressWarnings:unchecked
@Override

Exceptions

ServletException:: if the listener cannot be created

decrementInProgressAsyncCount back to summary

decrementInProgressAsyncCount	back to summary
public void decrementInProgressAsyncCount() Implements org.apache.coyote.AsyncContextCallback.decrementInProgressAsyncCount. Doc from org.apache.coyote.AsyncContextCallback.decrementInProgressAsyncCount. Used to notify the Context that async processing has ended. Specifically, for the counting of in-progress async requests to work correctly, this must be called exactly once every time the `AsyncStateMachine` transitions to DISPATCHED from any other state. Annotations @Override

public void decrementInProgressAsyncCount()

Implements org.apache.coyote.AsyncContextCallback.decrementInProgressAsyncCount.

Doc from org.apache.coyote.AsyncContextCallback.decrementInProgressAsyncCount.

Used to notify the Context that async processing has ended. Specifically, for the counting of in-progress async requests to work correctly, this must be called exactly once every time the AsyncStateMachine transitions to DISPATCHED from any other state.

Annotations

@Override

dispatch	back to summary
public void dispatch() Implements jakarta.servlet.AsyncContext.dispatch. Annotations @Override

dispatch

back to summary

public void dispatch()

Implements jakarta.servlet.AsyncContext.dispatch.

Annotations

@Override

dispatch back to summary

dispatch	back to summary
public void dispatch(String path) Implements jakarta.servlet.AsyncContext.dispatch. Parameters path:String Doc from jakarta.servlet.AsyncContext.dispatch. The path to which the request/response should be dispatched relative to the `ServletContext` from which this async request was started. Annotations @Override

public void dispatch(String path)

Implements jakarta.servlet.AsyncContext.dispatch.

Parameters

path:String

Doc from jakarta.servlet.AsyncContext.dispatch.

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

Annotations

@Override

dispatch back to summary

dispatch	back to summary
public void dispatch(ServletContext servletContext, String path) Implements jakarta.servlet.AsyncContext.dispatch. Parameters servletContext:ServletContext Doc from jakarta.servlet.AsyncContext.dispatch. The `ServletContext` to which the request/response should be dispatched. path:String Doc from jakarta.servlet.AsyncContext.dispatch. The path to which the request/response should be dispatched relative to the specified `ServletContext`. Annotations @Override

public void dispatch(ServletContext servletContext, String path)

Implements jakarta.servlet.AsyncContext.dispatch.

Parameters

servletContext:ServletContext

Doc from jakarta.servlet.AsyncContext.dispatch.

The ServletContext to which the request/response should be dispatched.

path:String

Doc from jakarta.servlet.AsyncContext.dispatch.

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

Annotations

@Override

doInternalDispatch	back to summary
protected void doInternalDispatch() throws ServletException, IOException

fireOnComplete	back to summary
public void fireOnComplete() Implements org.apache.coyote.AsyncContextCallback.fireOnComplete. Annotations @Override

fireOnComplete

back to summary

public void fireOnComplete()

Implements org.apache.coyote.AsyncContextCallback.fireOnComplete.

Annotations

@Override

getRequest	back to summary
public ServletRequest getRequest() Implements jakarta.servlet.AsyncContext.getRequest. Returns:ServletRequest Doc from jakarta.servlet.AsyncContext.getRequest. a reference to the ServletRequest object Annotations @Override

getRequest

back to summary

public ServletRequest getRequest()

Implements jakarta.servlet.AsyncContext.getRequest.

Returns:ServletRequest

Doc from jakarta.servlet.AsyncContext.getRequest.

a reference to the ServletRequest object

Annotations

@Override

getResponse	back to summary
public ServletResponse getResponse() Implements jakarta.servlet.AsyncContext.getResponse. Returns:ServletResponse Doc from jakarta.servlet.AsyncContext.getResponse. a reference to the ServletResponse object Annotations @Override

getResponse

back to summary

public ServletResponse getResponse()

Implements jakarta.servlet.AsyncContext.getResponse.

Returns:ServletResponse

Doc from jakarta.servlet.AsyncContext.getResponse.

a reference to the ServletResponse object

Annotations

@Override

getTimeout	back to summary
public long getTimeout() Implements jakarta.servlet.AsyncContext.getTimeout. Doc from jakarta.servlet.AsyncContext.getTimeout. Get the current timeout. Returns:long The timeout in milliseconds. 0 or less indicates no timeout. Annotations @Override

getTimeout

back to summary

public long getTimeout()

Implements jakarta.servlet.AsyncContext.getTimeout.

Doc from jakarta.servlet.AsyncContext.getTimeout.

Get the current timeout.

Returns:long

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

Annotations

@Override

hasOriginalRequestAndResponse	back to summary
public boolean hasOriginalRequestAndResponse() Implements jakarta.servlet.AsyncContext.hasOriginalRequestAndResponse. Returns:boolean Doc from jakarta.servlet.AsyncContext.hasOriginalRequestAndResponse. true if the Request and Response are the original ones Annotations @Override

hasOriginalRequestAndResponse

back to summary

public boolean hasOriginalRequestAndResponse()

Implements jakarta.servlet.AsyncContext.hasOriginalRequestAndResponse.

Returns:boolean

Doc from jakarta.servlet.AsyncContext.hasOriginalRequestAndResponse.

true if the Request and Response are the original ones

Annotations

@Override

incrementInProgressAsyncCount back to summary

incrementInProgressAsyncCount	back to summary
public void incrementInProgressAsyncCount() Implements org.apache.coyote.AsyncContextCallback.incrementInProgressAsyncCount. Doc from org.apache.coyote.AsyncContextCallback.incrementInProgressAsyncCount. Used to notify the Context that async processing has started. Specifically, for the counting of in-progress async requests to work correctly, this must be called exactly once every time the `AsyncStateMachine` transitions from DISPATCHED to any other state. Annotations @Override

public void incrementInProgressAsyncCount()

Implements org.apache.coyote.AsyncContextCallback.incrementInProgressAsyncCount.

Doc from org.apache.coyote.AsyncContextCallback.incrementInProgressAsyncCount.

Used to notify the Context that async processing has started. Specifically, for the counting of in-progress async requests to work correctly, this must be called exactly once every time the AsyncStateMachine transitions from DISPATCHED to any other state.

Annotations

@Override

isAvailable back to summary

isAvailable	back to summary
public boolean isAvailable() Implements org.apache.coyote.AsyncContextCallback.isAvailable. Doc from org.apache.coyote.AsyncContextCallback.isAvailable. Reports if the web application associated with this async request is available. Returns:boolean `true` if the associated web application is available, otherwise `false` Annotations @Override

public boolean isAvailable()

Implements org.apache.coyote.AsyncContextCallback.isAvailable.

Doc from org.apache.coyote.AsyncContextCallback.isAvailable.

Reports if the web application associated with this async request is available.

Returns:boolean

true if the associated web application is available, otherwise false

Annotations

@Override

isStarted	back to summary
public boolean isStarted()

logDebug	back to summary
private void logDebug(String method)

recycle	back to summary
public void recycle()

setErrorState	back to summary
public void setErrorState(Throwable t, boolean fireOnError)

setStarted	back to summary
public void setStarted(Context context, ServletRequest request, ServletResponse response, boolean originalRequestResponse)

setTimeout	back to summary
public void setTimeout(long timeout) Implements jakarta.servlet.AsyncContext.setTimeout. Doc from jakarta.servlet.AsyncContext.setTimeout. Set the timeout. Parameters timeout:long The timeout in milliseconds. 0 or less indicates no timeout. Annotations @Override

setTimeout

back to summary

public void setTimeout(long timeout)

Implements jakarta.servlet.AsyncContext.setTimeout.

Doc from jakarta.servlet.AsyncContext.setTimeout.

Set the timeout.

Parameters

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

Annotations

@Override

start	back to summary
public void start(final Runnable run) Implements jakarta.servlet.AsyncContext.start. Doc from jakarta.servlet.AsyncContext.start. Starts a new thread to process the asynchronous request Parameters run:Runnable a Runnable that the new thread will run Annotations @Override

start

back to summary

public void start(final Runnable run)

Implements jakarta.servlet.AsyncContext.start.

Doc from jakarta.servlet.AsyncContext.start.

Starts a new thread to process the asynchronous request

Parameters

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

Annotations

@Override

timeout	back to summary
public boolean timeout()

org.apache.catalina.core back to summary

private Class AsyncContextImpl.AsyncRunnable

Class Inheritance

extends Object
implements Runnable

java.lang.Object
org.apache.catalina.core.AsyncContextImpl.AsyncRunnable

All Implemented Interfaces

java.lang.Runnable

Field Summary

Modifier and Type	Field and Description
private final AsyncDispatcher	applicationDispatcher
private final Request	request
private final ServletRequest	servletRequest
private final ServletResponse	servletResponse

Constructor Summary

Access	Constructor and Description
pack-priv	AsyncRunnable(Request request, AsyncDispatcher applicationDispatcher, ServletRequest servletRequest, ServletResponse servletResponse)

Method Summary

Modifier and Type	Method and Description
public void	run() Implements java.lang.Runnable.run. Runs this operation.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

applicationDispatcher	back to summary
private final AsyncDispatcher applicationDispatcher

request	back to summary
private final Request request

servletRequest	back to summary
private final ServletRequest servletRequest

servletResponse	back to summary
private final ServletResponse servletResponse

Constructor Detail

AsyncRunnable	back to summary
pack-priv AsyncRunnable(Request request, AsyncDispatcher applicationDispatcher, ServletRequest servletRequest, ServletResponse servletResponse)

Method Detail

run

back to summary

public void run()

Implements java.lang.Runnable.run.

Doc from java.lang.Runnable.run.

Runs this operation.

Annotations

@Override

public Class AsyncContextImpl

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class AsyncContextImpl.AsyncRunnable

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class AsyncContextImpl.DebugException

Field Summary

Constructor Summary

Field Detail

Constructor Detail

private Class AsyncContextImpl.RunnableWrapper

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

Modifier and Type	Field and Description
private final Context	context
private final Request	coyoteRequest
private final Runnable	wrapped