javax.servlet

Interface AsyncContext

public interface AsyncContext

Since:

3.0

Version:

$Rev: 881527 $ $Date: 2009-11-17 16:14:26 -0500 (Tue, 17 Nov 2009) $

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 servletContext, String path)
void	dispatch(String path)
ServletRequest	getRequest()
ServletResponse	getResponse()
long	getTimeout() Returns current timeout value in milliseconds.
boolean	hasOriginalRequestAndResponse()
void	setTimeout(long timeoutMilliseconds)
void	start(Runnable run)

Field Detail

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_QUERY_STRING

static final String ASYNC_QUERY_STRING

See Also:

Constant Field Values

ASYNC_REQUEST_URI

static final String ASYNC_REQUEST_URI

See Also:

Constant Field Values

ASYNC_SERVLET_PATH

static final String ASYNC_SERVLET_PATH

See Also:

Constant Field Values

Method Detail

addListener

void addListener(AsyncListener listener)
                 throws IllegalStateException

Throws:

IllegalStateException

addListener

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

Throws:

IllegalStateException

complete

void complete()

createListener

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

Throws:

ServletException

dispatch

void dispatch()
              throws IllegalStateException

Throws:

IllegalStateException

dispatch

void dispatch(ServletContext servletContext,
            String path)
              throws IllegalStateException

Throws:

IllegalStateException

dispatch

void dispatch(String path)
              throws IllegalStateException

Throws:

IllegalStateException

getRequest

ServletRequest getRequest()

getResponse

ServletResponse getResponse()

getTimeout

long getTimeout()

Returns current timeout value in milliseconds. Zero or less means no timeout. If setTimeout has not been called, the container-specific default timeout is returned.

Returns:

timeout in milliseconds

hasOriginalRequestAndResponse

boolean hasOriginalRequestAndResponse()

setTimeout

void setTimeout(long timeoutMilliseconds)
                throws IllegalStateException

Throws:

IllegalStateException

start

void start(Runnable run)