Modifier and Type	Class and Description
public static enum	ServletChannelState.Action The actions to take as the channel moves from state to state.
private static enum	ServletChannelState.InputState
private static enum	ServletChannelState.OutputState
private static enum	ServletChannelState.RequestState
public static enum	ServletChannelState.State

Modifier and Type	Field and Description
private List<AsyncListener>	_asyncListeners
private boolean	_asyncWritePossible
private AsyncContextEvent	_event
private Throwable	_failure
private boolean	_failureListener
private boolean	_initial
private ServletChannelState.InputState	_inputState
private final AutoLock	_lock
private Thread	_onTimeoutThread
private ServletChannelState.OutputState	_outputState
private ServletChannelState.RequestState	_requestState
private boolean	_sendError
private final ServletChannel	_servletChannel
private ServletChannelState.State	_state
private long	_timeoutMs
private static final long	DEFAULT_TIMEOUT
private static final Logger	LOG

Access	Constructor and Description
protected	ServletChannelState(ServletChannel servletChannel)

Method Summary

Modifier and Type	Method and Description
public void	abort(Throwable failure)
private boolean	abortResponse(Throwable failure)
public void	addListener(AsyncListener listener)
public void	asyncError(Throwable the error. failure) This method is called when a failure occurs asynchronously to normal handling.
protected void	cancelTimeout()
protected void	cancelTimeout(AsyncContextEvent event)
public void	complete()
protected void	completed(Throwable failure)
public Throwable	completeResponse()
protected void	completing()
public void	dispatch(ServletContext context, String path)
pack-priv void	errorHandling() Called when an asynchronous call to `ErrorHandler.handle()` is about to happen.
pack-priv void	errorHandlingComplete(Throwable the failure reported by the error handling, or `null` if there was no failure failure) Called when the `Callback` passed to `ErrorHandler.handle()` is completed.
public AsyncContextEvent	getAsyncContextEvent()
public Object	getAttribute(String name)
public ServletContextHandler	getContextHandler()
public ServletChannel	getServletChannel()
public ServletChannelState.State	getState()
public String	getStatusString()
private String	getStatusStringLocked()
public long	getTimeout()
public ServletChannelState.Action	Returns: Next handling of the request should proceed handling()
public boolean	hasListener(AsyncListener listener)
public boolean	isAborted()
public boolean	isAsync()
public boolean	isAsyncStarted()
pack-priv boolean	isCompleted()
public boolean	isExpired()
public boolean	isIdle()
public boolean	isInitial()
public boolean	isInputUnready()
public boolean	isResponseCommitted()
public boolean	isResponseCompleted()
public boolean	isSendError()
public boolean	isSuspended()
pack-priv AutoLock	lock()
private ServletChannelState.Action	nextAction(boolean handling)
public void	onContentAdded() Called to indicate that some content was produced and is ready for consumption.
protected void	onError(Throwable th)
public boolean	onIdleTimeout(TimeoutException timeout)
public boolean	onReadEof()
public void	onReadIdle() Called to indicate that the content is being consumed.
public boolean	Returns: true if woken onReadReady() Called to signal that the channel is ready for a callback.
public void	onReadUnready() Called to indicate that no content is currently available, more content has been demanded and may be available, but that a handling thread may need to produce (fill/parse) it.
protected void	onTimeout()
public boolean	onWritePossible()
public void	openOutput()
protected void	recycle()
public void	removeAttribute(String name)
pack-priv void	runInContext(AsyncContextEvent event, Runnable runnable)
protected void	scheduleDispatch()
private void	sendError(Throwable th)
public void	sendError(int code, String message)
public void	setAttribute(String name, Object attribute)
public void	setTimeout(long ms)
public void	startAsync(AsyncContextEvent event)
protected void	timeout()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
private String	toStringLocked()
protected ServletChannelState.Action	Returns: next actions be handled again (e.g. because of a resume that happened before unhandle was called) unhandle() Signal that the HttpConnection has finished handling the request.
public void	upgrade()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

_asyncListeners	back to summary
private List<AsyncListener> _asyncListeners

_asyncWritePossible	back to summary
private boolean _asyncWritePossible

_event	back to summary
private AsyncContextEvent _event

_failure	back to summary
private Throwable _failure

_failureListener	back to summary
private boolean _failureListener

_initial	back to summary
private boolean _initial

_inputState	back to summary
private ServletChannelState.InputState _inputState

_lock	back to summary
private final AutoLock _lock

_onTimeoutThread	back to summary
private Thread _onTimeoutThread

_outputState	back to summary
private ServletChannelState.OutputState _outputState

_requestState	back to summary
private ServletChannelState.RequestState _requestState

_sendError	back to summary
private boolean _sendError

_servletChannel	back to summary
private final ServletChannel _servletChannel

_state	back to summary
private ServletChannelState.State _state

_timeoutMs	back to summary
private long _timeoutMs

DEFAULT_TIMEOUT	back to summary
private static final long DEFAULT_TIMEOUT

LOG	back to summary
private static final Logger LOG

Constructor Detail

ServletChannelState	back to summary
protected ServletChannelState(ServletChannel servletChannel)

Method Detail

abort	back to summary
public void abort(Throwable failure)

abortResponse	back to summary
private boolean abortResponse(Throwable failure)

addListener	back to summary
public void addListener(AsyncListener listener)

asyncError back to summary

asyncError	back to summary
public void asyncError(Throwable failure) This method is called when a failure occurs asynchronously to normal handling. If the request is async, we arrange for the exception to be thrown from the normal handling loop and then actually handled by `onError(Throwable)` Parameters failure:Throwable the error.

public void asyncError(Throwable failure)

This method is called when a failure occurs asynchronously to normal handling. If the request is async, we arrange for the exception to be thrown from the normal handling loop and then actually handled by onError(Throwable)

Parameters

failure:Throwable: the error.

cancelTimeout	back to summary
protected void cancelTimeout()

cancelTimeout	back to summary
protected void cancelTimeout(AsyncContextEvent event)

complete	back to summary
public void complete()

completed	back to summary
protected void completed(Throwable failure)

completeResponse	back to summary
public Throwable completeResponse()

completing	back to summary
protected void completing()

dispatch	back to summary
public void dispatch(ServletContext context, String path)

errorHandling back to summary

errorHandling	back to summary
pack-priv void errorHandling() Called when an asynchronous call to `ErrorHandler.handle()` is about to happen. See Also `errorHandlingComplete(Throwable)`

pack-priv void errorHandling()

Called when an asynchronous call to ErrorHandler.handle() is about to happen.

See Also: errorHandlingComplete(Throwable)

errorHandlingComplete back to summary

errorHandlingComplete	back to summary
pack-priv void errorHandlingComplete(Throwable failure) Called when the `Callback` passed to `ErrorHandler.handle()` is completed. Parameters failure:Throwable the failure reported by the error handling, or `null` if there was no failure

pack-priv void errorHandlingComplete(Throwable failure)

Called when the Callback passed to ErrorHandler.handle() is completed.

Parameters

failure:Throwable: the failure reported by the error handling, or null if there was no failure

getAsyncContextEvent	back to summary
public AsyncContextEvent getAsyncContextEvent()

getAttribute	back to summary
public Object getAttribute(String name)

getContextHandler	back to summary
public ServletContextHandler getContextHandler()

getServletChannel	back to summary
public ServletChannel getServletChannel()

getState	back to summary
public ServletChannelState.State getState()

getStatusString	back to summary
public String getStatusString()

getStatusStringLocked	back to summary
private String getStatusStringLocked()

getTimeout	back to summary
public long getTimeout()

handling	back to summary
public ServletChannelState.Action handling() Returns:ServletChannelState.Action Next handling of the request should proceed

hasListener	back to summary
public boolean hasListener(AsyncListener listener)

isAborted	back to summary
public boolean isAborted()

isAsync	back to summary
public boolean isAsync()

isAsyncStarted	back to summary
public boolean isAsyncStarted()

isCompleted	back to summary
pack-priv boolean isCompleted()

isExpired	back to summary
public boolean isExpired()

isIdle	back to summary
public boolean isIdle()

isInitial	back to summary
public boolean isInitial()

isInputUnready	back to summary
public boolean isInputUnready()

isResponseCommitted	back to summary
public boolean isResponseCommitted()

isResponseCompleted	back to summary
public boolean isResponseCompleted()

isSendError	back to summary
public boolean isSendError()

isSuspended	back to summary
public boolean isSuspended()

lock	back to summary
pack-priv AutoLock lock()

nextAction	back to summary
private ServletChannelState.Action nextAction(boolean handling)

onContentAdded	back to summary
public void onContentAdded() Called to indicate that some content was produced and is ready for consumption.

onError	back to summary
protected void onError(Throwable th)

onIdleTimeout	back to summary
public boolean onIdleTimeout(TimeoutException timeout)

onReadEof	back to summary
public boolean onReadEof()

onReadIdle	back to summary
public void onReadIdle() Called to indicate that the content is being consumed.

onReadReady

back to summary

public boolean onReadReady()

Called to signal that the channel is ready for a callback.

Returns:boolean: true if woken

onReadUnready	back to summary
public void onReadUnready() Called to indicate that no content is currently available, more content has been demanded and may be available, but that a handling thread may need to produce (fill/parse) it.

onTimeout	back to summary
protected void onTimeout()

onWritePossible	back to summary
public boolean onWritePossible()

openOutput	back to summary
public void openOutput()

recycle	back to summary
protected void recycle()

removeAttribute	back to summary
public void removeAttribute(String name)

runInContext	back to summary
pack-priv void runInContext(AsyncContextEvent event, Runnable runnable)

scheduleDispatch	back to summary
protected void scheduleDispatch()

sendError	back to summary
private void sendError(Throwable th)

sendError	back to summary
public void sendError(int code, String message)

setAttribute	back to summary
public void setAttribute(String name, Object attribute)

setTimeout	back to summary
public void setTimeout(long ms)

startAsync	back to summary
public void startAsync(AsyncContextEvent event)

timeout	back to summary
protected void timeout()

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

toStringLocked	back to summary
private String toStringLocked()

unhandle

back to summary

protected ServletChannelState.Action 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:ServletChannelState.Action: next actions be handled again (e.g. because of a resume that happened before unhandle was called)

upgrade	back to summary
public void upgrade()

org.eclipse.jetty.ee10.servlet back to summary

public final Enum ServletChannelState.Action

Class Inheritance

extends Enum<ServletChannelState.Action>

java.lang.Object
java.lang.Enum
org.eclipse.jetty.ee10.servlet.ServletChannelState.Action

The actions to take as the channel moves from state to state.

Field Summary

Modifier and Type	Field and Description
public static final ServletChannelState.Action	ASYNC_DISPATCH
public static final ServletChannelState.Action	ASYNC_ERROR
public static final ServletChannelState.Action	ASYNC_TIMEOUT
public static final ServletChannelState.Action	COMPLETE
public static final ServletChannelState.Action	DISPATCH
public static final ServletChannelState.Action	READ_CALLBACK
public static final ServletChannelState.Action	SEND_ERROR
public static final ServletChannelState.Action	TERMINATED
public static final ServletChannelState.Action	WAIT
public static final ServletChannelState.Action	WRITE_CALLBACK

Constructor Summary

Access	Constructor and Description
private	Action()

Method Summary

Modifier and Type	Method and Description
public static ServletChannelState.Action	valueOf(String name)
public static ServletChannelState.Action[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ASYNC_DISPATCH	back to summary
public static final ServletChannelState.Action ASYNC_DISPATCH

ASYNC_ERROR	back to summary
public static final ServletChannelState.Action ASYNC_ERROR

ASYNC_TIMEOUT	back to summary
public static final ServletChannelState.Action ASYNC_TIMEOUT

COMPLETE	back to summary
public static final ServletChannelState.Action COMPLETE

DISPATCH	back to summary
public static final ServletChannelState.Action DISPATCH

READ_CALLBACK	back to summary
public static final ServletChannelState.Action READ_CALLBACK

SEND_ERROR	back to summary
public static final ServletChannelState.Action SEND_ERROR

TERMINATED	back to summary
public static final ServletChannelState.Action TERMINATED

WAIT	back to summary
public static final ServletChannelState.Action WAIT

WRITE_CALLBACK	back to summary
public static final ServletChannelState.Action WRITE_CALLBACK

Constructor Detail

Action	back to summary
private Action()

Method Detail

valueOf	back to summary
public static ServletChannelState.Action valueOf(String name)

values	back to summary
public static ServletChannelState.Action[] values()

org.eclipse.jetty.ee10.servlet back to summary

private final Enum ServletChannelState.InputState

Class Inheritance

extends Enum<ServletChannelState.InputState>

java.lang.Object
java.lang.Enum
org.eclipse.jetty.ee10.servlet.ServletChannelState.InputState

Field Summary

Modifier and Type	Field and Description
public static final ServletChannelState.InputState	IDLE
public static final ServletChannelState.InputState	READY
public static final ServletChannelState.InputState	UNREADY

Constructor Summary

Access	Constructor and Description
private	InputState()

Method Summary

Modifier and Type	Method and Description
public static ServletChannelState.InputState	valueOf(String name)
public static ServletChannelState.InputState[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

IDLE	back to summary
public static final ServletChannelState.InputState IDLE

READY	back to summary
public static final ServletChannelState.InputState READY

UNREADY	back to summary
public static final ServletChannelState.InputState UNREADY

Constructor Detail

InputState	back to summary
private InputState()

Method Detail

valueOf	back to summary
public static ServletChannelState.InputState valueOf(String name)

values	back to summary
public static ServletChannelState.InputState[] values()

org.eclipse.jetty.ee10.servlet back to summary

private final Enum ServletChannelState.OutputState

Class Inheritance

extends Enum<ServletChannelState.OutputState>

java.lang.Object
java.lang.Enum
org.eclipse.jetty.ee10.servlet.ServletChannelState.OutputState

Field Summary

Modifier and Type	Field and Description
public static final ServletChannelState.OutputState	ABORTED
public static final ServletChannelState.OutputState	COMPLETED
public static final ServletChannelState.OutputState	IDLE
public static final ServletChannelState.OutputState	OPEN

Constructor Summary

Access	Constructor and Description
private	OutputState()

Method Summary

Modifier and Type	Method and Description
public static ServletChannelState.OutputState	valueOf(String name)
public static ServletChannelState.OutputState[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ABORTED	back to summary
public static final ServletChannelState.OutputState ABORTED

COMPLETED	back to summary
public static final ServletChannelState.OutputState COMPLETED

IDLE	back to summary
public static final ServletChannelState.OutputState IDLE

OPEN	back to summary
public static final ServletChannelState.OutputState OPEN

Constructor Detail

OutputState	back to summary
private OutputState()

Method Detail

valueOf	back to summary
public static ServletChannelState.OutputState valueOf(String name)

values	back to summary
public static ServletChannelState.OutputState[] values()

org.eclipse.jetty.ee10.servlet back to summary

private final Enum ServletChannelState.RequestState

Class Inheritance

extends Enum<ServletChannelState.RequestState>

java.lang.Object
java.lang.Enum
org.eclipse.jetty.ee10.servlet.ServletChannelState.RequestState

Field Summary

Modifier and Type	Field and Description
public static final ServletChannelState.RequestState	ASYNC
public static final ServletChannelState.RequestState	BLOCKING
public static final ServletChannelState.RequestState	COMPLETE
public static final ServletChannelState.RequestState	COMPLETED
public static final ServletChannelState.RequestState	COMPLETING
public static final ServletChannelState.RequestState	DISPATCH
public static final ServletChannelState.RequestState	ERRORING
public static final ServletChannelState.RequestState	EXPIRE
public static final ServletChannelState.RequestState	EXPIRING

Constructor Summary

Access	Constructor and Description
private	RequestState()

Method Summary

Modifier and Type	Method and Description
public static ServletChannelState.RequestState	valueOf(String name)
public static ServletChannelState.RequestState[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ASYNC	back to summary
public static final ServletChannelState.RequestState ASYNC

BLOCKING	back to summary
public static final ServletChannelState.RequestState BLOCKING

COMPLETE	back to summary
public static final ServletChannelState.RequestState COMPLETE

COMPLETED	back to summary
public static final ServletChannelState.RequestState COMPLETED

COMPLETING	back to summary
public static final ServletChannelState.RequestState COMPLETING

DISPATCH	back to summary
public static final ServletChannelState.RequestState DISPATCH

ERRORING	back to summary
public static final ServletChannelState.RequestState ERRORING

EXPIRE	back to summary
public static final ServletChannelState.RequestState EXPIRE

EXPIRING	back to summary
public static final ServletChannelState.RequestState EXPIRING

Constructor Detail

RequestState	back to summary
private RequestState()

Method Detail

valueOf	back to summary
public static ServletChannelState.RequestState valueOf(String name)

values	back to summary
public static ServletChannelState.RequestState[] values()

org.eclipse.jetty.ee10.servlet back to summary

public final Enum ServletChannelState.State

Class Inheritance

extends Enum<ServletChannelState.State>

java.lang.Object
java.lang.Enum
org.eclipse.jetty.ee10.servlet.ServletChannelState.State

Field Summary

Modifier and Type	Field and Description
public static final ServletChannelState.State	HANDLING
public static final ServletChannelState.State	IDLE
public static final ServletChannelState.State	UPGRADED
public static final ServletChannelState.State	WAITING
public static final ServletChannelState.State	WOKEN

Constructor Summary

Access	Constructor and Description
private	State()

Method Summary

Modifier and Type	Method and Description
public static ServletChannelState.State	valueOf(String name)
public static ServletChannelState.State[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

HANDLING	back to summary
public static final ServletChannelState.State HANDLING

IDLE	back to summary
public static final ServletChannelState.State IDLE

UPGRADED	back to summary
public static final ServletChannelState.State UPGRADED

WAITING	back to summary
public static final ServletChannelState.State WAITING

WOKEN	back to summary
public static final ServletChannelState.State WOKEN

Constructor Detail

State	back to summary
private State()

Method Detail

valueOf	back to summary
public static ServletChannelState.State valueOf(String name)

values	back to summary
public static ServletChannelState.State[] values()

public Class ServletChannelState

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum ServletChannelState.Action

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Enum ServletChannelState.InputState

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Enum ServletChannelState.OutputState

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Enum ServletChannelState.RequestState

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum ServletChannelState.State

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail