Module org.eclipse.jetty.ee8.nested

Package org.eclipse.jetty.ee8.nested

Class HttpChannel

java.lang.Object

org.eclipse.jetty.ee8.nested.HttpChannel

All Implemented Interfaces:

Runnable, HttpOutput.Interceptor

public class HttpChannel
extends Object
implements Runnable, HttpOutput.Interceptor

The state machine that processes a request/response cycle interpreting the HTTP and Servlet semantic.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	HttpChannel.Listener	Listener for HttpChannel events.
static class	HttpChannel.TransientListeners	Deprecated.

Constructor Summary

Constructors

Constructor	Description
HttpChannel(ContextHandler contextHandler, org.eclipse.jetty.server.ConnectionMetaData connectionMetaData)

Method Summary

Modifier and Type	Method	Description
void	abort(Throwable failure)	If a write or similar operation to this channel fails, then this method should be called.
boolean	addListener(HttpChannel.Listener listener)	Deprecated.
protected void	commit(org.eclipse.jetty.http.MetaData.Response info)
void	ensureConsumeAllOrNotPersistent()
protected boolean	eof()	Mark the channel's input as EOF.
protected void	execute(Runnable task)
boolean	failAllContent(Throwable failure)	Fail all content that is currently stored within the channel.
boolean	failed(Throwable failure)	Fail the channel's input.
org.eclipse.jetty.io.ByteBufferPool	getByteBufferPool()
long	getBytesWritten()
org.eclipse.jetty.http.MetaData.Response	getCommittedMetaData()
org.eclipse.jetty.io.Connection	getConnection()
org.eclipse.jetty.server.ConnectionMetaData	getConnectionMetaData()
org.eclipse.jetty.server.Connector	getConnector()
ContextHandler	getContextHandler()
ContextHandler.CoreContextRequest	getCoreRequest()
org.eclipse.jetty.server.Response	getCoreResponse()
org.eclipse.jetty.io.EndPoint	getEndPoint()
org.eclipse.jetty.server.HttpConfiguration	getHttpConfiguration()
long	getIdleTimeout()	Get the idle timeout.
InetSocketAddress	getLocalAddress()
String	getLocalName()	Return the local name of the connected channel.
int	getLocalPort()	Return the Local Port of the connected channel.
HttpOutput.Interceptor	getNextInterceptor()
InetSocketAddress	getRemoteAddress()
Request	getRequest()
long	getRequests()	Get the number of requests handled by this connection.
Response	getResponse()
org.eclipse.jetty.util.thread.Scheduler	getScheduler()
org.eclipse.jetty.server.Server	getServer()
org.eclipse.jetty.util.HostPort	getServerAuthority()	Get return the HttpConfiguration server authority override.
HttpChannelState	getState()
List<HttpChannel.Listener>	getTransientListeners()	Deprecated.
org.eclipse.jetty.io.EndPoint	getTunnellingEndPoint()
boolean	handle()
protected void	handleException(Throwable failure)	Sends an error 500, performing a special logic to detect whether the request is suspended, to avoid concurrent writes from the application.
boolean	isCommitted()
boolean	isPersistent()
boolean	isRequestCompleted()
boolean	isResponseCompleted()
boolean	isSendError()
boolean	isTunnellingSupported()
boolean	isUseOutputDirectByteBuffers()
boolean	needContent()	Notify the channel that content is needed.
protected HttpInput	newHttpInput()
protected HttpOutput	newHttpOutput()
void	onBadMessage(org.eclipse.jetty.http.BadMessageException failure)
void	onCompleted()
void	onProcess(org.eclipse.jetty.server.Response coreResponse, org.eclipse.jetty.util.Callback coreCallback)
void	onRequest(ContextHandler.CoreContextRequest coreRequest)
HttpInput.Content	produceContent()	Produce a HttpInput.Content object with data currently stored within the channel.
void	recycle()
boolean	removeListener(HttpChannel.Listener listener)	Deprecated.
void	resetBuffer()	Reset the buffers.
void	run()
void	send102Processing(org.eclipse.jetty.http.HttpFields headers)
void	send103EarlyHints(org.eclipse.jetty.http.HttpFields headers)
boolean	sendErrorOrAbort(String message)
boolean	sendResponse(org.eclipse.jetty.http.MetaData.Response info, ByteBuffer content, boolean complete)
protected boolean	sendResponse(org.eclipse.jetty.http.MetaData.Response response, ByteBuffer content, boolean complete, org.eclipse.jetty.util.Callback callback)
void	sendResponseAndComplete()
void	setIdleTimeout(long timeoutMs)	Set the idle timeout.
String	toString()
protected Throwable	unwrap(Throwable failure, Class<?>... targets)	Unwrap failure causes to find target class
void	write(ByteBuffer content, boolean complete, org.eclipse.jetty.util.Callback callback)	Non-Blocking write, committing the response if needed.

Methods inherited from class java.lang.Object

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

Constructor Details

HttpChannel

public HttpChannel(ContextHandler contextHandler,
 org.eclipse.jetty.server.ConnectionMetaData connectionMetaData)

Method Details

getContextHandler

public ContextHandler getContextHandler()

isSendError

public boolean isSendError()

newHttpInput

protected HttpInput newHttpInput()

getConnectionMetaData

public org.eclipse.jetty.server.ConnectionMetaData getConnectionMetaData()

needContent

public boolean needContent()

Notify the channel that content is needed. If some content is immediately available, true is returned and produceContent() has to be called and will return a non-null object. If no content is immediately available, an attempt to produce content must be made; if new content has been produced, true is returned; otherwise HttpInput.onContentProducible() is called once some content arrives and produceContent() can be called without returning null. If a failure happens, then HttpInput.onContentProducible() will be called and an error content will return the error on the next call to produceContent().

Returns:

true if content is immediately available.

produceContent

public HttpInput.Content produceContent()

Produce a HttpInput.Content object with data currently stored within the channel. The produced content can be special (meaning calling HttpInput.Content.isSpecial() returns true) if the channel reached a special state, like EOF or an error. Once a special content has been returned, all subsequent calls to this method will always return a special content of the same kind and needContent() will always return true. The returned content is "raw", i.e.: not decoded.

Returns:

a HttpInput.Content object if one is immediately available without blocking, null otherwise.

failAllContent

public boolean failAllContent(Throwable failure)

Fail all content that is currently stored within the channel.

Parameters:

failure - the failure to fail the content with.

Returns:

true if EOF was reached while failing all content, false otherwise.

failed

public boolean failed(Throwable failure)

Fail the channel's input.

Parameters:

failure - the failure.

Returns:

true if the channel needs to be rescheduled.

eof

protected boolean eof()

Mark the channel's input as EOF.

Returns:

true if the channel needs to be rescheduled.

newHttpOutput

protected HttpOutput newHttpOutput()

getState

public HttpChannelState getState()

addListener

@Deprecated
public boolean addListener(HttpChannel.Listener listener)

Deprecated.

Add a transient Listener to the HttpChannel.

Listeners added by this method will only be notified if the HttpChannel has been constructed with an instance of HttpChannel.TransientListeners as an AbstractConnector provided listener

Transient listeners are removed after every request cycle

Parameters:

listener - the listener to add

Returns:

true if the listener was added.

removeListener

@Deprecated
public boolean removeListener(HttpChannel.Listener listener)

Deprecated.

getTransientListeners

@Deprecated
public List<HttpChannel.Listener> getTransientListeners()

Deprecated.

getBytesWritten

public long getBytesWritten()

getRequests

public long getRequests()

Get the number of requests handled by this connection.

Returns:

the number of requests handled by this connection

getConnector

public org.eclipse.jetty.server.Connector getConnector()

getCommittedMetaData

public org.eclipse.jetty.http.MetaData.Response getCommittedMetaData()

getIdleTimeout

public long getIdleTimeout()

Get the idle timeout.

This is implemented as a call to EndPoint.getIdleTimeout(), but may be overridden by channels that have timeouts different from their connections.

Returns:

the idle timeout (in milliseconds)

setIdleTimeout

public void setIdleTimeout(long timeoutMs)

Set the idle timeout.

This is implemented as a call to EndPoint.setIdleTimeout(long), but may be overridden by channels that have timeouts different from their connections.

Parameters:

timeoutMs - the idle timeout in milliseconds

getByteBufferPool

public org.eclipse.jetty.io.ByteBufferPool getByteBufferPool()

getHttpConfiguration

public org.eclipse.jetty.server.HttpConfiguration getHttpConfiguration()

getServer

public org.eclipse.jetty.server.Server getServer()

getCoreRequest

public ContextHandler.CoreContextRequest getCoreRequest()

getRequest

public Request getRequest()

getCoreResponse

public org.eclipse.jetty.server.Response getCoreResponse()

getResponse

public Response getResponse()

getConnection

public org.eclipse.jetty.io.Connection getConnection()

getEndPoint

public org.eclipse.jetty.io.EndPoint getEndPoint()

getLocalName

public String getLocalName()

Return the local name of the connected channel.

This is the host name after the connector is bound and the connection is accepted.

Value can be overridden by HttpConfiguration.setLocalAddress(SocketAddress).

Note: some connectors are not based on IP networking, and default behavior here will result in a null return. Use HttpConfiguration.setLocalAddress(SocketAddress) to set the value to an acceptable host name.

Returns:

the local name, or null

getLocalPort

public int getLocalPort()

Return the Local Port of the connected channel.

This is the port the connector is bound to and is accepting connections on.

Value can be overridden by HttpConfiguration.setLocalAddress(SocketAddress).

Note: some connectors are not based on IP networking, and default behavior here will result in a value of 0 returned. Use HttpConfiguration.setLocalAddress(SocketAddress) to set the value to an acceptable port.

Returns:

the local port, or 0 if unspecified

getLocalAddress

public InetSocketAddress getLocalAddress()

getRemoteAddress

public InetSocketAddress getRemoteAddress()

getServerAuthority

public org.eclipse.jetty.util.HostPort getServerAuthority()

Get return the HttpConfiguration server authority override.

Returns:

return the HttpConfiguration server authority override

send102Processing

public void send102Processing(org.eclipse.jetty.http.HttpFields headers)
                       throws IOException

Throws:

IOException

send103EarlyHints

public void send103EarlyHints(org.eclipse.jetty.http.HttpFields headers)
                       throws IOException

Throws:

IOException

recycle

public void recycle()

run

public void run()

Specified by:

run in interface Runnable

handle

public boolean handle()

Returns:

True if the channel is ready to continue handling (ie it is not suspended)

ensureConsumeAllOrNotPersistent

public void ensureConsumeAllOrNotPersistent()

sendErrorOrAbort

public boolean sendErrorOrAbort(String message)

Parameters:

message - the error message.

Returns:

true if we have sent an error, false if we have aborted.

handleException

protected void handleException(Throwable failure)

Sends an error 500, performing a special logic to detect whether the request is suspended, to avoid concurrent writes from the application.

It may happen that the application suspends, and then throws an exception, while an application spawned thread writes the response content; in such case, we attempt to commit the error directly bypassing the ErrorHandler mechanisms and the response OutputStream.

Parameters:

failure - the Throwable that caused the problem

unwrap

protected Throwable unwrap(Throwable failure,
 Class<?>... targets)

Unwrap failure causes to find target class

Parameters:

failure - The throwable to have its causes unwrapped

targets - Exception classes that we should not unwrap

Returns:

A target throwable or null

sendResponseAndComplete

public void sendResponseAndComplete()

toString

public String toString()

Overrides:

toString in class Object

onRequest

public void onRequest(ContextHandler.CoreContextRequest coreRequest)

onProcess

public void onProcess(org.eclipse.jetty.server.Response coreResponse,
 org.eclipse.jetty.util.Callback coreCallback)

onCompleted

public void onCompleted()

onBadMessage

public void onBadMessage(org.eclipse.jetty.http.BadMessageException failure)

sendResponse

protected boolean sendResponse(org.eclipse.jetty.http.MetaData.Response response,
 ByteBuffer content,
 boolean complete,
 org.eclipse.jetty.util.Callback callback)

sendResponse

public boolean sendResponse(org.eclipse.jetty.http.MetaData.Response info,
 ByteBuffer content,
 boolean complete)
                     throws IOException

Throws:

IOException

commit

protected void commit(org.eclipse.jetty.http.MetaData.Response info)

isCommitted

public boolean isCommitted()

isRequestCompleted

public boolean isRequestCompleted()

Returns:

True if the request lifecycle is completed

isResponseCompleted

public boolean isResponseCompleted()

Returns:

True if the response is completely written.

isPersistent

public boolean isPersistent()

write

public void write(ByteBuffer content,
 boolean complete,
 org.eclipse.jetty.util.Callback callback)

Non-Blocking write, committing the response if needed.

Called as last link in HttpOutput.Filter chain

Specified by:

write in interface HttpOutput.Interceptor

Parameters:

content - the content buffer to write

complete - whether the content is complete for the response

callback - Callback when complete or failed

resetBuffer

public void resetBuffer()

Description copied from interface: HttpOutput.Interceptor

Reset the buffers.

If the Interceptor contains buffers then reset them.

Specified by:

resetBuffer in interface HttpOutput.Interceptor

getNextInterceptor

public HttpOutput.Interceptor getNextInterceptor()

Specified by:

getNextInterceptor in interface HttpOutput.Interceptor

Returns:

The next Interceptor in the chain or null if this is the last Interceptor in the chain.

execute

protected void execute(Runnable task)

getScheduler

public org.eclipse.jetty.util.thread.Scheduler getScheduler()

isUseOutputDirectByteBuffers

public boolean isUseOutputDirectByteBuffers()

abort

public void abort(Throwable failure)

If a write or similar operation to this channel fails, then this method should be called.

Parameters:

failure - the failure that caused the abort.

isTunnellingSupported

public boolean isTunnellingSupported()

getTunnellingEndPoint

public org.eclipse.jetty.io.EndPoint getTunnellingEndPoint()