Module cloud.piranha.webapp.impl

Package cloud.piranha.webapp.impl

Class DefaultAsyncContext

java.lang.Object

cloud.piranha.webapp.impl.DefaultAsyncContext

All Implemented Interfaces:

AsyncContext

public class DefaultAsyncContext
extends java.lang.Object
implements AsyncContext

The default AsyncContext.

Author:

Manfred Riem ([email protected])

Field Summary

Fields inherited from interface javax.servlet.AsyncContext

ASYNC_CONTEXT_PATH, ASYNC_MAPPING, ASYNC_PATH_INFO, ASYNC_QUERY_STRING, ASYNC_REQUEST_URI, ASYNC_SERVLET_PATH

Constructor Summary

Constructors

Constructor	Description
DefaultAsyncContext(ServletRequest asyncStartRequest, ServletResponse asyncStartResponse)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addListener(AsyncListener listener)	Add the listener.
void	addListener(AsyncListener listener, ServletRequest request, ServletResponse response)	Add the listener.
void	complete()	Complete the async context.
<T extends AsyncListener> T	createListener(java.lang.Class<T> type)	Create the listener.
void	dispatch()	Dispatch the request.
void	dispatch(java.lang.String path)	Dispatch the request.
void	dispatch(ServletContext servletContext, java.lang.String path)	Dispatch.
ServletRequest	getRequest()	Get the asyncStartRequest.
ServletResponse	getResponse()	Get the asyncStartResponse.
long	getTimeout()	Get the timeout.
boolean	hasOriginalRequestAndResponse()	Do we have the original asyncStartRequest and asyncStartResponse?
void	onTimeOut()
void	setTimeout(long timeout)	Set the timeout.
void	start(java.lang.Runnable runnable)	Start the thread.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DefaultAsyncContext

public DefaultAsyncContext(ServletRequest asyncStartRequest, ServletResponse asyncStartResponse)

Constructor.

Parameters:

asyncStartRequest - the servlet asyncStartRequest.

asyncStartResponse - the servlet asyncStartResponse.

Method Details

addListener

public void addListener(AsyncListener listener)

Add the listener.

Specified by:

addListener in interface AsyncContext

Parameters:

listener - the listener.

See Also:

AsyncContext.addListener(javax.servlet.AsyncListener)

addListener

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

Add the listener.

Specified by:

addListener in interface AsyncContext

Parameters:

listener - the listener.

request - the servlet asyncStartRequest.

response - the servlet asyncStartResponse.

createListener

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

Create the listener.

Specified by:

createListener in interface AsyncContext

Type Parameters:

T - the class.

Parameters:

type - the type.

Returns:

the listener.

Throws:

ServletException - when a Servlet error occurs.

dispatch

public void dispatch()

Description copied from interface: AsyncContext

Dispatch the request.

Specified by:

dispatch in interface AsyncContext

See Also:

AsyncContext.dispatch()

dispatch

public void dispatch(java.lang.String path)

Description copied from interface: AsyncContext

Dispatch the request.

Specified by:

dispatch in interface AsyncContext

Parameters:

path - the path.

See Also:

AsyncContext.dispatch(java.lang.String)

dispatch

public void dispatch(ServletContext servletContext, java.lang.String path)

Dispatch.

Specified by:

dispatch in interface AsyncContext

Parameters:

servletContext - the servlet context.

path - the path.

complete

public void complete()

Complete the async context.

Specified by:

complete in interface AsyncContext

onTimeOut

public void onTimeOut()

getRequest

public ServletRequest getRequest()

Get the asyncStartRequest.

Specified by:

getRequest in interface AsyncContext

Returns:

the asyncStartRequest.

See Also:

AsyncContext.getRequest()

getResponse

public ServletResponse getResponse()

Get the asyncStartResponse.

Specified by:

getResponse in interface AsyncContext

Returns:

the asyncStartResponse.

See Also:

AsyncContext.getResponse()

getTimeout

public long getTimeout()

Get the timeout.

Specified by:

getTimeout in interface AsyncContext

Returns:

the timeout.

See Also:

AsyncContext.getTimeout()

hasOriginalRequestAndResponse

public boolean hasOriginalRequestAndResponse()

Do we have the original asyncStartRequest and asyncStartResponse?

Specified by:

hasOriginalRequestAndResponse in interface AsyncContext

Returns:

true if we do, false otherwise.

setTimeout

public void setTimeout(long timeout)

Set the timeout.

Specified by:

setTimeout in interface AsyncContext

Parameters:

timeout - the timeout.

start

public void start(java.lang.Runnable runnable)

Start the thread.

Specified by:

start in interface AsyncContext

Parameters:

runnable - the runnable.