AsyncContext (Apache Tomcat 7.0.109 API Documentation)

All Known Implementing Classes:

AsyncContextImpl
```
public interface AsyncContext
```
TODO SERVLET3 - Add comments

Since:

Servlet 3.0

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ASYNC_CONTEXT_PATH`
`static String`	`ASYNC_PATH_INFO`
`static String`	`ASYNC_QUERY_STRING`
`static String`	`ASYNC_REQUEST_URI`
`static String`	`ASYNC_SERVLET_PATH`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addListener(AsyncListener listener)`
`void`	`addListener(AsyncListener listener, ServletRequest request, ServletResponse response)`
`void`	`complete()`
`<T extends AsyncListener> T`	`createListener(Class<T> clazz)`
`void`	`dispatch()`
`void`	`dispatch(ServletContext context, String path)`
`void`	`dispatch(String path)`
`ServletRequest`	`getRequest()`
`ServletResponse`	`getResponse()`
`long`	`getTimeout()` Get the current timeout.
`boolean`	`hasOriginalRequestAndResponse()`
`void`	`setTimeout(long timeout)` Set the timeout.
`void`	`start(Runnable run)`

- Field Detail
  - ASYNC_REQUEST_URI
```
static final String ASYNC_REQUEST_URI
```
    See Also:
    Constant Field Values
  - ASYNC_CONTEXT_PATH
```
static final String ASYNC_CONTEXT_PATH
```
    See Also:
    Constant Field Values
  - ASYNC_PATH_INFO
```
static final String ASYNC_PATH_INFO
```
    See Also:
    Constant Field Values
  - ASYNC_SERVLET_PATH
```
static final String ASYNC_SERVLET_PATH
```
    See Also:
    Constant Field Values
  - ASYNC_QUERY_STRING
```
static final String ASYNC_QUERY_STRING
```
    See Also:
    Constant Field Values
- Method Detail
  - getRequest
```
ServletRequest getRequest()
```
  - getResponse
```
ServletResponse getResponse()
```
  - hasOriginalRequestAndResponse
```
boolean hasOriginalRequestAndResponse()
```
  - dispatch
```
void dispatch()
```
    Throws:
    
    IllegalStateException - if this method is called when the request is not in asynchronous mode. The request is in asynchronous mode after ServletRequest.startAsync() or ServletRequest.startAsync(ServletRequest, ServletResponse) has been called and before complete() or any other dispatch() method has been called.
  - dispatch
```
void dispatch(String path)
```
    Parameters:
    path - The path to which the request/response should be dispatched relative to the ServletContext from which this async request was started.
    
    Throws:
    
    IllegalStateException - if this method is called when the request is not in asynchronous mode. The request is in asynchronous mode after ServletRequest.startAsync() or ServletRequest.startAsync(ServletRequest, ServletResponse) has been called and before complete() or any other dispatch() method has been called.
  - dispatch
```
void dispatch(ServletContext context,
            String path)
```
    Parameters:
    path - The path to which the request/response should be dispatched relative to the specified ServletContext.
    context - The ServletContext to which the request/response should be dispatched.
    
    Throws:
    
    IllegalStateException - if this method is called when the request is not in asynchronous mode. The request is in asynchronous mode after ServletRequest.startAsync() or ServletRequest.startAsync(ServletRequest, ServletResponse) has been called and before complete() or any other dispatch() method has been called.
  - complete
```
void complete()
```
  - start
```
void start(Runnable run)
```
  - addListener
```
void addListener(AsyncListener listener)
```
  - addListener
```
void addListener(AsyncListener listener,
               ServletRequest request,
               ServletResponse response)
```
  - createListener
```
<T extends AsyncListener> T createListener(Class<T> clazz)
                                       throws ServletException
```
    Throws:
    
    ServletException
  - setTimeout
```
void setTimeout(long timeout)
```
    Set the timeout.
    
    Parameters:
    timeout - The timeout in milliseconds. 0 or less indicates no timeout.
  - getTimeout
```
long getTimeout()
```
    Get the current timeout.
    
    Returns:
    The timeout in milliseconds. 0 or less indicates no timeout.

Interface AsyncContext

Field Summary

Method Summary

Field Detail

ASYNC_REQUEST_URI

ASYNC_CONTEXT_PATH

ASYNC_PATH_INFO

ASYNC_SERVLET_PATH

ASYNC_QUERY_STRING

Method Detail

getRequest

getResponse

hasOriginalRequestAndResponse

dispatch

dispatch

dispatch

complete

start

addListener

addListener

createListener

setTimeout

getTimeout