org.eclipse.jetty.server

Class HttpChannelState

java.lang.Object

org.eclipse.jetty.server.HttpChannelState

All Implemented Interfaces:

javax.servlet.AsyncContext

public class HttpChannelState
extends Object
implements javax.servlet.AsyncContext

Implementation of AsyncContext interface that holds the state of request-response cycle.

STATE	ACTION
	handling()	startAsync()	unhandle()	dispatch()	complete()	completed()
IDLE:	DISPATCHED				COMPLETECALLED??
DISPATCHED:		ASYNCSTARTED	COMPLETING
ASYNCSTARTED:			ASYNCWAIT	REDISPATCHING	COMPLETECALLED
REDISPATCHING:			REDISPATCHED
ASYNCWAIT:				REDISPATCH	COMPLETECALLED
REDISPATCH:	REDISPATCHED
REDISPATCHED:		ASYNCSTARTED	COMPLETING
COMPLETECALLED:	COMPLETING		COMPLETING
COMPLETING:	COMPLETING					COMPLETED
COMPLETED:

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	HttpChannelState.AsyncEventState
class	HttpChannelState.AsyncTimeout
static class	HttpChannelState.State

Field Summary

Fields inherited from interface javax.servlet.AsyncContext

ASYNC_CONTEXT_PATH, ASYNC_PATH_INFO, ASYNC_QUERY_STRING, ASYNC_REQUEST_URI, ASYNC_SERVLET_PATH

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HttpChannelState(HttpChannel<?> channel)

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(javax.servlet.AsyncListener listener)
void	addListener(javax.servlet.AsyncListener listener, javax.servlet.ServletRequest request, javax.servlet.ServletResponse response)
void	cancel()
protected void	cancelTimeout()
void	complete()
protected void	completed()
<T extends javax.servlet.AsyncListener> T	createListener(Class<T> clazz)
void	dispatch()
void	dispatch(javax.servlet.ServletContext context, String path)
void	dispatch(String path)
protected void	error(Throwable th)
protected void	expired()
HttpChannelState.AsyncEventState	getAsyncEventState()
Object	getAttribute(String name)
Request	getBaseRequest()
ContextHandler	getContextHandler()
javax.servlet.ServletRequest	getRequest()
javax.servlet.ServletResponse	getResponse()
javax.servlet.ServletResponse	getServletResponse()
HttpChannelState.State	getState()
String	getStatusString()
long	getTimeout()
protected boolean	handling()
boolean	hasOriginalRequestAndResponse()
boolean	isAsync()
boolean	isDispatched()
boolean	isExpired()
boolean	isInitial()
boolean	isSuspended()
protected void	recycle()
void	removeAttribute(String name)
protected void	scheduleDispatch()
protected void	scheduleTimeout()
void	setAttribute(String name, Object attribute)
void	setTimeout(long ms)
void	start(Runnable run)
void	startAsync()
void	startAsync(javax.servlet.ServletContext context, javax.servlet.ServletRequest request, javax.servlet.ServletResponse response)
String	toString()
protected boolean	unhandle() Signal that the HttpConnection has finished handling the request.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpChannelState

protected HttpChannelState(HttpChannel<?> channel)

Method Detail

getState

public HttpChannelState.State getState()

addListener

public void addListener(javax.servlet.AsyncListener listener)

Specified by:

addListener in interface javax.servlet.AsyncContext

addListener

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

Specified by:

addListener in interface javax.servlet.AsyncContext

setTimeout

public void setTimeout(long ms)

Specified by:

setTimeout in interface javax.servlet.AsyncContext

getTimeout

public long getTimeout()

Specified by:

getTimeout in interface javax.servlet.AsyncContext

getAsyncEventState

public HttpChannelState.AsyncEventState getAsyncEventState()

toString

public String toString()

Overrides:

toString in class Object

getStatusString

public String getStatusString()

handling

protected boolean handling()

Returns:

true if the handling of the request should proceed

startAsync

public void startAsync()

startAsync

public void startAsync(javax.servlet.ServletContext context,
              javax.servlet.ServletRequest request,
              javax.servlet.ServletResponse response)

error

protected void error(Throwable th)

unhandle

protected boolean unhandle()

Signal that the HttpConnection has finished handling the request. For blocking connectors, this call may block if the request has been suspended (startAsync called).

Returns:

true if handling is complete, false if the request should be handled again (eg because of a resume that happened before unhandle was called)

dispatch

public void dispatch()

Specified by:

dispatch in interface javax.servlet.AsyncContext

isDispatched

public boolean isDispatched()

expired

protected void expired()

complete

public void complete()

Specified by:

complete in interface javax.servlet.AsyncContext

createListener

public <T extends javax.servlet.AsyncListener> T createListener(Class<T> clazz)
                                                     throws javax.servlet.ServletException

Specified by:

createListener in interface javax.servlet.AsyncContext

Throws:

javax.servlet.ServletException

completed

protected void completed()

recycle

protected void recycle()

cancel

public void cancel()

scheduleDispatch

protected void scheduleDispatch()

scheduleTimeout

protected void scheduleTimeout()

cancelTimeout

protected void cancelTimeout()

isExpired

public boolean isExpired()

isInitial

public boolean isInitial()

isSuspended

public boolean isSuspended()

isAsync

public boolean isAsync()

dispatch

public void dispatch(javax.servlet.ServletContext context,
            String path)

Specified by:

dispatch in interface javax.servlet.AsyncContext

dispatch

public void dispatch(String path)

Specified by:

dispatch in interface javax.servlet.AsyncContext

getBaseRequest

public Request getBaseRequest()

getRequest

public javax.servlet.ServletRequest getRequest()

Specified by:

getRequest in interface javax.servlet.AsyncContext

getResponse

public javax.servlet.ServletResponse getResponse()

Specified by:

getResponse in interface javax.servlet.AsyncContext

start

public void start(Runnable run)

Specified by:

start in interface javax.servlet.AsyncContext

hasOriginalRequestAndResponse

public boolean hasOriginalRequestAndResponse()

Specified by:

hasOriginalRequestAndResponse in interface javax.servlet.AsyncContext

getContextHandler

public ContextHandler getContextHandler()

getServletResponse

public javax.servlet.ServletResponse getServletResponse()

getAttribute

public Object getAttribute(String name)

removeAttribute

public void removeAttribute(String name)

setAttribute

public void setAttribute(String name,
                Object attribute)