javax.servlet

Interface AsyncContext

public interface AsyncContext

The execution context of an asynchronous operation on a servlet request. The context is created by calling ServletRequest.startAsync() or ServletRequest.startAsync(javax.servlet.ServletRequest,javax.servlet.ServletResponse). Subsequent call to these methods return the same context instance.

Since:

3.0

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ASYNC_CONTEXT_PATH Name of the attribute for the context path.
static java.lang.String	ASYNC_PATH_INFO Name of the attribute for the path info.
static java.lang.String	ASYNC_QUERY_STRING Name of the attribute for the query string.
static java.lang.String	ASYNC_REQUEST_URI Name of the attribute for the request URI.
static java.lang.String	ASYNC_SERVLET_PATH Name of the attribute for the servlet path.

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(AsyncListener listener) Adds a listener to receive AsyncEvents for this context.
void	addListener(AsyncListener listener, ServletRequest request, ServletResponse response) Adds a listener to receive AsyncEvents for this context.
void	complete() Completes this asynchronous operation.
<T extends AsyncListener> T	createListener(java.lang.Class<T> t) Instantiates an AsyncListener from the given class.
void	dispatch() Dispatches the request/response pair to the servlet container.
void	dispatch(ServletContext context, java.lang.String path) Dispatches the request/response pair to the specified path and context.
void	dispatch(java.lang.String path) Dispatches the request/response pair to the specified path.
ServletRequest	getRequest() Returns the original request.
ServletResponse	getResponse() Returns the original response.
long	getTimeout() Returns the timeout in milliseconds for this context.
boolean	hasOriginalRequestAndResponse() Indicates whether this context was initialized with the original request/response pair.
void	setTimeout(long timeout) Sets the timeout in milliseconds for this context.
void	start(java.lang.Runnable runnable) Requests the servlet container to execute the specified runnable.

Field Detail

ASYNC_REQUEST_URI

static final java.lang.String ASYNC_REQUEST_URI

Name of the attribute for the request URI.

See Also:

dispatch(java.lang.String), dispatch(javax.servlet.ServletContext,java.lang.String), Constant Field Values

ASYNC_CONTEXT_PATH

static final java.lang.String ASYNC_CONTEXT_PATH

Name of the attribute for the context path.

See Also:

dispatch(java.lang.String), dispatch(javax.servlet.ServletContext,java.lang.String), Constant Field Values

ASYNC_PATH_INFO

static final java.lang.String ASYNC_PATH_INFO

Name of the attribute for the path info.

See Also:

dispatch(java.lang.String), dispatch(javax.servlet.ServletContext,java.lang.String), Constant Field Values

ASYNC_SERVLET_PATH

static final java.lang.String ASYNC_SERVLET_PATH

Name of the attribute for the servlet path.

See Also:

dispatch(java.lang.String), dispatch(javax.servlet.ServletContext,java.lang.String), Constant Field Values

ASYNC_QUERY_STRING

static final java.lang.String ASYNC_QUERY_STRING

Name of the attribute for the query string.

See Also:

dispatch(java.lang.String), dispatch(javax.servlet.ServletContext,java.lang.String), Constant Field Values

Method Detail

getRequest

ServletRequest getRequest()

Returns the original request.

getResponse

ServletResponse getResponse()

Returns the original response.

hasOriginalRequestAndResponse

boolean hasOriginalRequestAndResponse()

Indicates whether this context was initialized with the original request/response pair.

dispatch

void dispatch()

Dispatches the request/response pair to the servlet container. If ServletRequest.startAsync(javax.servlet.ServletRequest,javax.servlet.ServletResponse) was called with a HttpServletRequest, then the URI for dispatch will be its request-URI, otherwise the URI will be that of the request when it was last dispatched. The dispatcher type of the request is DispatcherType.ASYNC. This method returns immediately.

Throws:

java.lang.IllegalStateException - if complete() was called, or a dispatch method was called but the startAsync method was not called

See Also:

ServletRequest.getDispatcherType()

dispatch

void dispatch(java.lang.String path)

Dispatches the request/response pair to the specified path. The dispatcher type of the request is DispatcherType.ASYNC. This method returns immediately.

Parameters:

path - the dispatch target within the servlet context of this async context

Throws:

java.lang.IllegalStateException - if complete() was called, or a dispatch method was called but the startAsync method was not called

See Also:

ServletRequest.getDispatcherType()

dispatch

void dispatch(ServletContext context,
            java.lang.String path)

Dispatches the request/response pair to the specified path and context. The dispatcher type of the request is DispatcherType.ASYNC. This method returns immediately.

Parameters:

path - the dispatch target within the specified servlet context

context - the servlet context

Throws:

java.lang.IllegalStateException - if complete() was called, or a dispatch method was called but the startAsync method was not called

See Also:

ServletRequest.getDispatcherType()

complete

void complete()

Completes this asynchronous operation. The associated response is closed.

start

void start(java.lang.Runnable runnable)

Requests the servlet container to execute the specified runnable.

addListener

void addListener(AsyncListener listener)

Adds a listener to receive AsyncEvents for this context.

addListener

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

Adds a listener to receive AsyncEvents for this context. The specified request and response will be passed in the event.

createListener

<T extends AsyncListener> T createListener(java.lang.Class<T> t)
                                       throws ServletException

Instantiates an AsyncListener from the given class.

Throws:

ServletException

setTimeout

void setTimeout(long timeout)

Sets the timeout in milliseconds for this context.

getTimeout

long getTimeout()

Returns the timeout in milliseconds for this context.