AsyncContextImpl (Apache Tomcat 7.0.109 API Documentation)

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

All Implemented Interfaces:: AsyncContext, AsyncContextCallback

public class AsyncContextImpl
extends Object
implements AsyncContext, AsyncContextCallback

Field Summary

Fields
Modifier and Type Field and Description

protected static StringManager sm
- Fields inherited from interface javax.servlet.AsyncContext
  ASYNC_CONTEXT_PATH, ASYNC_PATH_INFO, ASYNC_QUERY_STRING, ASYNC_REQUEST_URI, ASYNC_SERVLET_PATH

Fields
Modifier and Type	Field and Description
`protected static StringManager`	`sm`

Constructor Summary

Constructors
Constructor and Description

AsyncContextImpl(Request request)

Constructors
Constructor and Description
`AsyncContextImpl(Request request)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addListener(AsyncListener listener)`
`void`	`addListener(AsyncListener listener, ServletRequest servletRequest, ServletResponse servletResponse)`
`void`	`complete()`
`<T extends AsyncListener> T`	`createListener(Class<T> clazz)`
`void`	`dispatch()`
`void`	`dispatch(ServletContext servletContext, String path)`
`void`	`dispatch(String path)`
`protected void`	`doInternalDispatch()`
`void`	`fireOnComplete()`
`ServletRequest`	`getRequest()`
`ServletResponse`	`getResponse()`
`long`	`getTimeout()` Get the current timeout.
`boolean`	`hasOriginalRequestAndResponse()`
`boolean`	`isAvailable()` Reports if the web application associated with this async request is available.
`boolean`	`isStarted()`
`void`	`recycle()`
`void`	`setErrorState(Throwable t, boolean fireOnError)`
`void`	`setStarted(Context context, ServletRequest request, ServletResponse response, boolean originalRequestResponse)`
`void`	`setTimeout(long timeout)` Set the timeout.
`void`	`start(Runnable run)`
`boolean`	`timeout()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - sm
```
protected static final StringManager sm
```
- Constructor Detail
  - AsyncContextImpl
```
public AsyncContextImpl(Request request)
```
- Method Detail
  - complete
```
public void complete()
```
    Specified by:
    
    complete in interface AsyncContext
  - fireOnComplete
```
public void fireOnComplete()
```
    Specified by:
    
    fireOnComplete in interface AsyncContextCallback
  - timeout
```
public boolean timeout()
```
  - dispatch
```
public void dispatch()
```
    Specified by:
    
    dispatch in interface AsyncContext
  - dispatch
```
public void dispatch(String path)
```
    Specified by:
    
    dispatch in interface AsyncContext
    
    Parameters:
    path - The path to which the request/response should be dispatched relative to the ServletContext from which this async request was started.
  - dispatch
```
public void dispatch(ServletContext servletContext,
            String path)
```
    Specified by:
    
    dispatch in interface AsyncContext
    
    Parameters:
    servletContext - The ServletContext to which the request/response should be dispatched.
    path - The path to which the request/response should be dispatched relative to the specified ServletContext.
  - getRequest
```
public ServletRequest getRequest()
```
    Specified by:
    
    getRequest in interface AsyncContext
  - getResponse
```
public ServletResponse getResponse()
```
    Specified by:
    
    getResponse in interface AsyncContext
  - start
```
public void start(Runnable run)
```
    Specified by:
    
    start in interface AsyncContext
  - addListener
```
public void addListener(AsyncListener listener)
```
    Specified by:
    
    addListener in interface AsyncContext
  - addListener
```
public void addListener(AsyncListener listener,
               ServletRequest servletRequest,
               ServletResponse servletResponse)
```
    Specified by:
    
    addListener in interface AsyncContext
  - createListener
```
public <T extends AsyncListener> T createListener(Class<T> clazz)
                                       throws ServletException
```
    Specified by:
    
    createListener in interface AsyncContext
    
    Throws:
    
    ServletException
  - recycle
```
public void recycle()
```
  - isStarted
```
public boolean isStarted()
```
  - setStarted
```
public void setStarted(Context context,
              ServletRequest request,
              ServletResponse response,
              boolean originalRequestResponse)
```
  - hasOriginalRequestAndResponse
```
public boolean hasOriginalRequestAndResponse()
```
    Specified by:
    
    hasOriginalRequestAndResponse in interface AsyncContext
  - doInternalDispatch
```
protected void doInternalDispatch()
                           throws ServletException,
                                  IOException
```
    Throws:
    
    ServletException
    
    IOException
  - getTimeout
```
public long getTimeout()
```
    Description copied from interface: AsyncContext
    
    Get the current timeout.
    
    Specified by:
    
    getTimeout in interface AsyncContext
    
    Returns:
    The timeout in milliseconds. 0 or less indicates no timeout.
  - setTimeout
```
public void setTimeout(long timeout)
```
    Description copied from interface: AsyncContext
    
    Set the timeout.
    
    Specified by:
    
    setTimeout in interface AsyncContext
    
    Parameters:
    timeout - The timeout in milliseconds. 0 or less indicates no timeout.
  - isAvailable
```
public boolean isAvailable()
```
    Description copied from interface: AsyncContextCallback
    
    Reports if the web application associated with this async request is available.
    
    Specified by:
    
    isAvailable in interface AsyncContextCallback
    
    Returns:
    true if the associated web application is available, otherwise false
  - setErrorState
```
public void setErrorState(Throwable t,
                 boolean fireOnError)
```

Class AsyncContextImpl

Field Summary

Fields inherited from interface javax.servlet.AsyncContext

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

sm

Constructor Detail

AsyncContextImpl

Method Detail

complete

fireOnComplete

timeout

dispatch

dispatch

dispatch

getRequest

getResponse

start

addListener

addListener

createListener

recycle

isStarted

setStarted

hasOriginalRequestAndResponse

doInternalDispatch

getTimeout

setTimeout

isAvailable

setErrorState