Module org.eclipse.jetty.server

Package org.eclipse.jetty.server

Interface HttpChannel

All Superinterfaces:

org.eclipse.jetty.util.thread.Invocable

public interface HttpChannel
extends org.eclipse.jetty.util.thread.Invocable

Represents the state of an HTTP request/response cycle.

HttpChannel links the lower (closer to the network) layer HttpStream with the upper (application code) layer Handler.

An HttpChannel instance may be used for many HTTP request/response cycles from the same connection; however, only a single cycle may be active at any time.

Default implementations of this interface may be created via HttpChannel.DefaultFactory.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	HttpChannel.DefaultFactory	The factory that creates default implementations of HttpChannel.
static interface	HttpChannel.Factory	A factory for HttpChannel instances.

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

org.eclipse.jetty.util.thread.Invocable.Callable, org.eclipse.jetty.util.thread.Invocable.InvocationType, org.eclipse.jetty.util.thread.Invocable.ReadyTask, org.eclipse.jetty.util.thread.Invocable.Task

Field Summary

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

__nonBlocking, NOOP

Method Summary

Modifier and Type	Method	Description
static HttpChannel	from(Request request)
org.eclipse.jetty.http.ComplianceViolation.Listener	getComplianceViolationListener()
ConnectionMetaData	getConnectionMetaData()
Request	getRequest()	Returns the Request object, if available.
void	initialize()	Initialize the HttpChannel when a new cycle of request handling begins.
boolean	isRequestHandled()
default 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 failure)	Notifies this HttpChannel that an asynchronous failure happened.
Runnable	onIdleTimeout(TimeoutException idleTimeout)	Notifies this HttpChannel that an idle timeout happened.
Runnable	onRemoteFailure(Throwable failure)	Notifies this HttpChannel that an asynchronous notification was received indicating a remote failure happened.
Runnable	onRequest(org.eclipse.jetty.http.MetaData.Request metaData)	HttpStream invokes this method when the metadata of an HTTP request (method, URI and headers, but not content) has been parsed.
void	recycle()	Recycle the HttpChannel, so that a new cycle of calling setHttpStream(HttpStream), onRequest(MetaData.Request) etc. may be performed on the channel.
void	setHttpStream(HttpStream httpStream)	Set the HttpStream to associate to this channel..

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

getInvocationType

Method Details

getConnectionMetaData

ConnectionMetaData getConnectionMetaData()

Returns:

the ConnectionMetaData associated with this channel.

setHttpStream

void setHttpStream(HttpStream httpStream)

Set the HttpStream to associate to this channel..

Parameters:

httpStream - the HttpStream to associate to this channel.

isRequestHandled

boolean isRequestHandled()

Returns:

whether the request has been passed to the root Handler.

onRequest

Runnable onRequest(org.eclipse.jetty.http.MetaData.Request metaData)

HttpStream invokes this method when the metadata of an HTTP request (method, URI and headers, but not content) has been parsed.

The returned Runnable invokes the root Handler.

Parameters:

metaData - the HTTP request metadata.

Returns:

a Runnable that invokes the root Handler.

getRequest

Request getRequest()

Returns the Request object, if available.

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

Returns:

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

onContentAvailable

Runnable onContentAvailable()

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

Returns:

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

onIdleTimeout

Runnable onIdleTimeout(TimeoutException idleTimeout)

Notifies this HttpChannel that an idle timeout happened.

Parameters:

idleTimeout - 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

Runnable onFailure(Throwable failure)

Notifies this HttpChannel that an asynchronous failure happened.

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

Parameters:

failure - 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

Runnable onRemoteFailure(Throwable failure)

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

Typical failure examples could be HTTP/2 resets.

Parameters:

failure - 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

default Runnable onClose()

Notifies this HttpChannel that an asynchronous close happened.

Returns:

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

recycle

void recycle()

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

See Also:

• initialize()

initialize

void initialize()

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

See Also:

• recycle()

getComplianceViolationListener

org.eclipse.jetty.http.ComplianceViolation.Listener getComplianceViolationListener()

Returns:

the active ComplianceViolation.Listener

from

static HttpChannel from(Request request)

Parameters:

request - attempt to resolve the HttpChannel from the provided request

Returns:

the HttpChannel if found

Throws:

IllegalStateException - if unable to find HttpChannel