Package org.eclipse.jetty.server.internal

Class HttpChannelState

java.lang.Object

org.eclipse.jetty.server.internal.HttpChannelState

All Implemented Interfaces:

Components, HttpChannel, Invocable

public class HttpChannelState
extends Object
implements HttpChannel, Components

A Channel represents a sequence of request cycles from the same connection with only a single request cycle may be active at once for each channel.

Many methods return Runnables to indicate that further work is needed. These can be given to an ExecutionStrategy instead of calling known methods like HttpChannel.handle().

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HttpChannelState.ChannelRequest
static class	HttpChannelState.ChannelResponse	The Channel's implementation of the Response API.

Nested classes/interfaces inherited from interface org.eclipse.jetty.server.HttpChannel

HttpChannel.DefaultFactory, HttpChannel.Factory

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.thread.Invocable

Invocable.Callable, Invocable.InvocationType, Invocable.ReadyTask, Invocable.Task

Field Summary

Fields inherited from interface org.eclipse.jetty.util.thread.Invocable

__nonBlocking, NOOP

Constructor Summary

Constructors

Constructor	Description
HttpChannelState(ConnectionMetaData connectionMetaData)

Method Summary

Modifier and Type	Method	Description
void	addHttpStreamWrapper(Function<HttpStream,HttpStream> onStreamEvent)
ByteBufferPool	getByteBufferPool()
Attributes	getCache()	A map-like object that can be used as a cache (for example, as a cookie cache).
ComplianceViolation.Listener	getComplianceViolationListener()
ConnectionMetaData	getConnectionMetaData()
Executor	getExecutor()
HttpConfiguration	getHttpConfiguration()
HttpStream	getHttpStream()
Invocable.InvocationType	getInvocationType()
Request	getRequest()	Returns the Request object, if available.
Response	getResponse()
Scheduler	getScheduler()
Server	getServer()
ThreadPool	getThreadPool()
void	initialize()	Initialize the HttpChannel when a new cycle of request handling begins.
boolean	isRequestHandled()
Runnable	onClose()	Notifies this HttpChannel that an asynchronous close happened.
Runnable	onContentAvailable()	HttpStream invokes this method when more HTTP request content is available.
Runnable	onFailure(Throwable x)	Notifies this HttpChannel that an asynchronous failure happened.
Runnable	onIdleTimeout(TimeoutException t)	Notifies this HttpChannel that an idle timeout happened.
Runnable	onRemoteFailure(Throwable x)	Notifies this HttpChannel that an asynchronous notification was received indicating a remote failure happened.
Runnable	onRequest(MetaData.Request request)	Start request handling by returning a Runnable that will call Request.Handler.handle(Request, Response, Callback).
void	recycle()	Recycle the HttpChannel, so that a new cycle of calling HttpChannel.setHttpStream(HttpStream), HttpChannel.onRequest(MetaData.Request) etc.
void	setHttpStream(HttpStream stream)	Set the HttpStream to associate to this channel..
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

HttpChannelState

public HttpChannelState(ConnectionMetaData connectionMetaData)

Method Details

initialize

public void initialize()

Description copied from interface: HttpChannel

Initialize the HttpChannel when a new cycle of request handling begins.

Specified by:

initialize in interface HttpChannel

See Also:

• HttpChannel.recycle()

getComplianceViolationListener

public ComplianceViolation.Listener getComplianceViolationListener()

Specified by:

getComplianceViolationListener in interface HttpChannel

Returns:

the active ComplianceViolation.Listener

recycle

public void recycle()

Description copied from interface: HttpChannel

Recycle the HttpChannel, so that a new cycle of calling HttpChannel.setHttpStream(HttpStream), HttpChannel.onRequest(MetaData.Request) etc. may be performed on the channel.

Specified by:

recycle in interface HttpChannel

See Also:

• HttpChannel.initialize()

getHttpConfiguration

public HttpConfiguration getHttpConfiguration()

getHttpStream

public HttpStream getHttpStream()

setHttpStream

public void setHttpStream(HttpStream stream)

Description copied from interface: HttpChannel

Set the HttpStream to associate to this channel..

Specified by:

setHttpStream in interface HttpChannel

Parameters:

stream - the HttpStream to associate to this channel.

getServer

public Server getServer()

getConnectionMetaData

public ConnectionMetaData getConnectionMetaData()

Specified by:

getConnectionMetaData in interface HttpChannel

Returns:

the ConnectionMetaData associated with this channel.

getByteBufferPool

public ByteBufferPool getByteBufferPool()

Specified by:

getByteBufferPool in interface Components

Returns:

the ByteBufferPool associated with the Request

getScheduler

public Scheduler getScheduler()

Specified by:

getScheduler in interface Components

Returns:

the Scheduler associated with the Request

getThreadPool

public ThreadPool getThreadPool()

Specified by:

getThreadPool in interface Components

Returns:

the ThreadPool associated with the Request

getExecutor

public Executor getExecutor()

Specified by:

getExecutor in interface Components

Returns:

the Executor associated with the Request

getCache

public Attributes getCache()

Description copied from interface: Components

A map-like object that can be used as a cache (for example, as a cookie cache).

The cache will have a life cycle limited by the connection, i.e. no cache map will live longer that the connection associated with it. However, a cache may have a shorter life than a connection (e.g. it may be discarded for implementation reasons). A cache map is guaranteed to be given to only a single request concurrently (scoped by HttpChannelState), so objects saved there do not need to be made safe from access by simultaneous request. If the connection is known to be non-persistent then the cache may be a noop cache and discard all items set on it.

Specified by:

getCache in interface Components

Returns:

A map-like object, which may be an empty implementation that discards all items.

onRequest

public Runnable onRequest(MetaData.Request request)

Start request handling by returning a Runnable that will call Request.Handler.handle(Request, Response, Callback).

Specified by:

onRequest in interface HttpChannel

Parameters:

request - The request metadata to handle.

Returns:

A Runnable that will call Request.Handler.handle(Request, Response, Callback). Unlike all other Runnables returned by HttpChannel methods, this runnable should not be mutually excluded or serialized. Specifically other Runnables returned by methods on this class can be run concurrently with the Runnable returned from this method.

getRequest

public Request getRequest()

Description copied from interface: HttpChannel

Returns the Request object, if available.

The Request object is only available after a call to HttpChannel.onRequest(MetaData.Request) has been made.

Specified by:

getRequest in interface HttpChannel

Returns:

the Request object, or null if the Request object is not yet available.

getResponse

public Response getResponse()

isRequestHandled

public boolean isRequestHandled()

Specified by:

isRequestHandled in interface HttpChannel

Returns:

whether the request has been passed to the root Handler.

onContentAvailable

public Runnable onContentAvailable()

Description copied from interface: HttpChannel

HttpStream invokes this method when more HTTP request content is available.

Specified by:

onContentAvailable in interface HttpChannel

Returns:

the last Runnable passed to Request.demand(Runnable), or null if there is no demand for content.

getInvocationType

public Invocable.InvocationType getInvocationType()

Specified by:

getInvocationType in interface Invocable

Returns:

The InvocationType of this object

onIdleTimeout

public Runnable onIdleTimeout(TimeoutException t)

Description copied from interface: HttpChannel

Notifies this HttpChannel that an idle timeout happened.

Specified by:

onIdleTimeout in interface HttpChannel

Parameters:

t - the timeout.

Returns:

a Runnable that performs the timeout action, or null if no action need be performed by the calling thread

See Also:

• Request.addIdleTimeoutListener(Predicate)

onFailure

public Runnable onFailure(Throwable x)

Description copied from interface: HttpChannel

Notifies this HttpChannel that an asynchronous failure happened.

Typical failure examples could be protocol failures (for example, invalid request bytes).

Specified by:

onFailure in interface HttpChannel

Parameters:

x - the failure cause.

Returns:

a Runnable that performs the failure action, or null if no failure action needs be performed by the calling thread

See Also:

• Request.addFailureListener(Consumer)

onRemoteFailure

public Runnable onRemoteFailure(Throwable x)

Description copied from interface: HttpChannel

Notifies this HttpChannel that an asynchronous notification was received indicating a remote failure happened.

Typical failure examples could be HTTP/2 resets.

Specified by:

onRemoteFailure in interface HttpChannel

Parameters:

x - the failure cause.

Returns:

a Runnable that performs the failure action, or null if no failure action needs be performed by the calling thread

See Also:

• Request.addFailureListener(Consumer)

onClose

public Runnable onClose()

Description copied from interface: HttpChannel

Notifies this HttpChannel that an asynchronous close happened.

Specified by:

onClose in interface HttpChannel

Returns:

a Runnable that performs the close action, or null if no close action needs be performed by the calling thread

addHttpStreamWrapper

public void addHttpStreamWrapper(Function<HttpStream,HttpStream> onStreamEvent)

toString

public String toString()

Overrides:

toString in class Object