Package org.eclipse.jetty.server.internal

Class HttpConnection

java.lang.Object

org.eclipse.jetty.io.AbstractConnection

org.eclipse.jetty.server.AbstractMetaDataConnection

org.eclipse.jetty.server.internal.HttpConnection

All Implemented Interfaces:

Closeable, AutoCloseable, Runnable, Connection, Connection.UpgradeFrom, Connection.UpgradeTo, ConnectionMetaData, Attributes, Invocable

public class HttpConnection
extends AbstractMetaDataConnection
implements Runnable, Connection.UpgradeFrom, Connection.UpgradeTo, ConnectionMetaData

A Connection that handles the HTTP protocol.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	HttpConnection.HttpStreamOverHTTP1
protected class	HttpConnection.RequestHandler

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

Attributes.Layer, Attributes.Lazy, Attributes.Mapped, Attributes.Synthetic

Nested classes/interfaces inherited from interface org.eclipse.jetty.io.Connection

Connection.Listener, Connection.UpgradeFrom, Connection.UpgradeTo

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

ConnectionMetaData.Wrapper

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.Attributes

NULL

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

__nonBlocking, NOOP

Constructor Summary

Constructors

Constructor	Description
HttpConnection(HttpConfiguration configuration, Connector connector, EndPoint endPoint)
HttpConnection(HttpConfiguration configuration, Connector connector, EndPoint endPoint, boolean recordComplianceViolations)	Deprecated, for removal: This API element is subject to removal in a future version. use HttpConnection(HttpConfiguration, Connector, EndPoint) instead.

Method Summary

Modifier and Type	Method	Description
void	asyncReadFillInterested()
void	clearAttributes()	Clear all attribute names
void	close()	Performs a logical close of this connection.
Object	getAttribute(String name)	Get an attribute
Set<String>	getAttributeNameSet()	Get the immutable set of attribute names.
long	getBytesIn()
long	getBytesOut()
static HttpConnection	getCurrentConnection()	Get the current connection that this thread is dispatched to.
HttpGenerator	getGenerator()
HttpChannel	getHttpChannel()
HttpVersion	getHttpVersion()
String	getId()
Invocable.InvocationType	getInvocationType()
long	getMessagesIn()
long	getMessagesOut()
HttpParser	getParser()
String	getProtocol()
Server	getServer()
boolean	isPersistent()
boolean	isRecordHttpComplianceViolations()	Deprecated, for removal: This API element is subject to removal in a future version. No replacement, no longer used within HttpConnection, will be removed in Jetty 12.1.0
boolean	isRequestBufferEmpty()
boolean	isUseInputDirectByteBuffers()
boolean	isUseOutputDirectByteBuffers()
protected HttpChannel	newHttpChannel(Server server, HttpConfiguration configuration)
protected HttpGenerator	newHttpGenerator()
protected HttpParser	newHttpParser(HttpCompliance compliance)
protected HttpConnection.HttpStreamOverHTTP1	newHttpStream(String method, String uri, HttpVersion version)
protected HttpConnection.RequestHandler	newRequestHandler()
void	onFillable()	Callback method invoked when the endpoint is ready to be read.
protected void	onFillInterestedFailed(Throwable cause)	Callback method invoked when the endpoint failed to be ready to be read.
boolean	onIdleExpired(TimeoutException timeout)	Callback method invoked upon an idle timeout event.
void	onOpen()	Callback method invoked when this connection is opened.
ByteBuffer	onUpgradeFrom()	Invoked during an upgrade to produce a buffer containing bytes that have not been consumed by this connection, and that must be consumed by the upgrade-to connection.
void	onUpgradeTo(ByteBuffer buffer)	Invoked during an upgrade to receive a buffer containing bytes that have not been consumed by the upgrade-from connection, and that must be consumed by this connection.
Object	removeAttribute(String name)	Remove an attribute
void	run()
Object	setAttribute(String name, Object attribute)	Set an attribute
protected static HttpConnection	setCurrentConnection(HttpConnection connection)
void	setUseInputDirectByteBuffers(boolean useInputDirectByteBuffers)
void	setUseOutputDirectByteBuffers(boolean useOutputDirectByteBuffers)
String	toConnectionString()

Methods inherited from class org.eclipse.jetty.server.AbstractMetaDataConnection

getConnection, getConnector, getHttpConfiguration, getLocalSocketAddress, getRemoteSocketAddress

Methods inherited from class org.eclipse.jetty.io.AbstractConnection

addEventListener, failedCallback, fillInterested, getCreatedTimeStamp, getEndPoint, getExecutor, getInputBufferSize, isFillInterested, onClose, onReadTimeout, removeEventListener, setInputBufferSize, toString, tryFillInterested

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.jetty.util.Attributes

asAttributeMap, equals, hashCode

Methods inherited from interface org.eclipse.jetty.server.ConnectionMetaData

getConnection, getConnector, getHttpConfiguration, getLocalSocketAddress, getRemoteSocketAddress, getServerAuthority, isPushSupported, isSecure

Constructor Details

HttpConnection

@Deprecated(since="12.0.6",
            forRemoval=true)
public HttpConnection(HttpConfiguration configuration,
 Connector connector,
 EndPoint endPoint,
 boolean recordComplianceViolations)

Deprecated, for removal: This API element is subject to removal in a future version.

use HttpConnection(HttpConfiguration, Connector, EndPoint) instead. Will be removed in Jetty 12.1.0

HttpConnection

public HttpConnection(HttpConfiguration configuration,
 Connector connector,
 EndPoint endPoint)

Method Details

getCurrentConnection

public static HttpConnection getCurrentConnection()

Get the current connection that this thread is dispatched to. Note that a thread may be processing a request asynchronously and thus not be dispatched to the connection.

Returns:

the current HttpConnection or null

See Also:

• for a more general way to access the HttpConnection

setCurrentConnection

protected static HttpConnection setCurrentConnection(HttpConnection connection)

getInvocationType

public Invocable.InvocationType getInvocationType()

Specified by:

getInvocationType in interface Invocable

Overrides:

getInvocationType in class AbstractConnection

Returns:

The InvocationType of this object

isRecordHttpComplianceViolations

@Deprecated(since="12.0.6",
            forRemoval=true)
public boolean isRecordHttpComplianceViolations()

Deprecated, for removal: This API element is subject to removal in a future version.

No replacement, no longer used within HttpConnection, will be removed in Jetty 12.1.0

newHttpGenerator

protected HttpGenerator newHttpGenerator()

newHttpParser

protected HttpParser newHttpParser(HttpCompliance compliance)

newHttpChannel

protected HttpChannel newHttpChannel(Server server,
 HttpConfiguration configuration)

newHttpStream

protected HttpConnection.HttpStreamOverHTTP1 newHttpStream(String method,
 String uri,
 HttpVersion version)

newRequestHandler

protected HttpConnection.RequestHandler newRequestHandler()

getServer

public Server getServer()

getHttpChannel

public HttpChannel getHttpChannel()

getParser

public HttpParser getParser()

getGenerator

public HttpGenerator getGenerator()

getId

public String getId()

Specified by:

getId in interface ConnectionMetaData

Returns:

a unique (within the lifetime of the JVM) identifier string for the network connection to the JVM

getHttpVersion

public HttpVersion getHttpVersion()

Specified by:

getHttpVersion in interface ConnectionMetaData

getProtocol

public String getProtocol()

Specified by:

getProtocol in interface ConnectionMetaData

isPersistent

public boolean isPersistent()

Specified by:

isPersistent in interface ConnectionMetaData

removeAttribute

public Object removeAttribute(String name)

Description copied from interface: Attributes

Remove an attribute

Specified by:

removeAttribute in interface Attributes

Parameters:

name - the attribute to remove

Returns:

the value of the attribute if removed, else null

setAttribute

public Object setAttribute(String name,
 Object attribute)

Description copied from interface: Attributes

Set an attribute

Specified by:

setAttribute in interface Attributes

Parameters:

name - the attribute to set

attribute - the value to set. A null value is equivalent to removing the attribute.

Returns:

the previous value of the attribute if set, else null

getAttribute

public Object getAttribute(String name)

Description copied from interface: Attributes

Get an attribute

Specified by:

getAttribute in interface Attributes

Parameters:

name - the attribute to get

Returns:

the value of the attribute, or null if no such attribute exists

getAttributeNameSet

public Set<String> getAttributeNameSet()

Description copied from interface: Attributes

Get the immutable set of attribute names.

Specified by:

getAttributeNameSet in interface Attributes

Returns:

Set of attribute names, or an empty set if there are no attributes.

clearAttributes

public void clearAttributes()

Description copied from interface: Attributes

Clear all attribute names

Specified by:

clearAttributes in interface Attributes

getMessagesIn

public long getMessagesIn()

Specified by:

getMessagesIn in interface Connection

Overrides:

getMessagesIn in class AbstractConnection

getMessagesOut

public long getMessagesOut()

Specified by:

getMessagesOut in interface Connection

Overrides:

getMessagesOut in class AbstractConnection

isUseInputDirectByteBuffers

public boolean isUseInputDirectByteBuffers()

setUseInputDirectByteBuffers

public void setUseInputDirectByteBuffers(boolean useInputDirectByteBuffers)

isUseOutputDirectByteBuffers

public boolean isUseOutputDirectByteBuffers()

setUseOutputDirectByteBuffers

public void setUseOutputDirectByteBuffers(boolean useOutputDirectByteBuffers)

onUpgradeFrom

public ByteBuffer onUpgradeFrom()

Description copied from interface: Connection.UpgradeFrom

Invoked during an upgrade to produce a buffer containing bytes that have not been consumed by this connection, and that must be consumed by the upgrade-to connection.

Specified by:

onUpgradeFrom in interface Connection.UpgradeFrom

Returns:

a buffer of unconsumed bytes to pass to the upgrade-to connection. The buffer does not belong to any pool and should be discarded after having consumed its bytes. The returned buffer may be null if there are no unconsumed bytes.

onUpgradeTo

public void onUpgradeTo(ByteBuffer buffer)

Description copied from interface: Connection.UpgradeTo

Invoked during an upgrade to receive a buffer containing bytes that have not been consumed by the upgrade-from connection, and that must be consumed by this connection.

Specified by:

onUpgradeTo in interface Connection.UpgradeTo

Parameters:

buffer - a non-null buffer of unconsumed bytes received from the upgrade-from connection. The buffer does not belong to any pool and should be discarded after having consumed its bytes.

isRequestBufferEmpty

public boolean isRequestBufferEmpty()

onFillable

public void onFillable()

Description copied from class: AbstractConnection

Callback method invoked when the endpoint is ready to be read.

Specified by:

onFillable in class AbstractConnection

See Also:

• AbstractConnection.fillInterested()

onFillInterestedFailed

protected void onFillInterestedFailed(Throwable cause)

Description copied from class: AbstractConnection

Callback method invoked when the endpoint failed to be ready to be read.

Overrides:

onFillInterestedFailed in class AbstractConnection

Parameters:

cause - the exception that caused the failure

onIdleExpired

public boolean onIdleExpired(TimeoutException timeout)

Description copied from interface: Connection

Callback method invoked upon an idle timeout event.

Implementations of this method may return true to indicate that the idle timeout handling should proceed normally, typically failing the EndPoint and causing it to be closed.

When false is returned, the handling of the idle timeout event is halted immediately and the EndPoint left in the state it was before the idle timeout event.

Specified by:

onIdleExpired in interface Connection

Overrides:

onIdleExpired in class AbstractConnection

Returns:

true to let the EndPoint handle the idle timeout, false to tell the EndPoint to halt the handling of the idle timeout.

close

public void close()

Description copied from interface: Connection

Performs a logical close of this connection.

For simple connections, this may just mean to delegate the close to the associated EndPoint but, for example, SSL connections should write the SSL close message before closing the associated EndPoint.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface Connection

Overrides:

close in class AbstractConnection

onOpen

public void onOpen()

Description copied from interface: Connection

Callback method invoked when this connection is opened.

Creators of the connection implementation are responsible for calling this method.

Specified by:

onOpen in interface Connection

Overrides:

onOpen in class AbstractConnection

run

public void run()

Specified by:

run in interface Runnable

asyncReadFillInterested

public void asyncReadFillInterested()

getBytesIn

public long getBytesIn()

Specified by:

getBytesIn in interface Connection

Overrides:

getBytesIn in class AbstractConnection

getBytesOut

public long getBytesOut()

Specified by:

getBytesOut in interface Connection

Overrides:

getBytesOut in class AbstractConnection

toConnectionString

public String toConnectionString()

Overrides:

toConnectionString in class AbstractConnection