Nested and Inner Type Summary

Modifier and Type	Class and Description
public static interface	ConnectionFactory.Configuring A ConnectionFactory that can configure the connector.
public static interface	ConnectionFactory.Detecting Connections created by this factory MUST implement `Connection.UpgradeTo`.
public static interface	ConnectionFactory.Upgrading

Method Summary

Modifier and Type	Method and Description
public String	getProtocol() Returns: A string representing the primary protocol name.
public List<String>	getProtocols() Returns: A list of alternative protocol names/versions including the primary protocol.
public Connection	Returns: a new `Connection` newConnection(Connector The `Connector` creating this connection connector, EndPoint the `EndPoint` associated with the connection endPoint) Creates a new `Connection` with the given parameters

Method Detail

getProtocol	back to summary
public String getProtocol() Returns:String A string representing the primary protocol name.

getProtocols	back to summary
public List<String> getProtocols() Returns:List<String> A list of alternative protocol names/versions including the primary protocol.

newConnection back to summary

newConnection	back to summary
public Connection newConnection(Connector connector, EndPoint endPoint) Creates a new `Connection` with the given parameters Parameters connector:Connector The `Connector` creating this connection endPoint:EndPoint the `EndPoint` associated with the connection Returns:Connection a new `Connection`

public Connection newConnection(Connector connector, EndPoint endPoint)

Creates a new Connection with the given parameters

Parameters

connector:Connector: The Connector creating this connection
endPoint:EndPoint: the EndPoint associated with the connection

Returns:Connection

a new Connection

org.eclipse.jetty.server back to summary

public Interface ConnectionFactory.Configuring

Known Direct Implementers: org.eclipse.jetty.server.SslConnectionFactory

A ConnectionFactory that can configure the connector.

Method Summary

Modifier and Type	Method and Description
public void	configure(Connector The connector to configure connector) Called during `Connector#start()`.

Inherited from org.eclipse.jetty.server.ConnectionFactory:: getProtocol getProtocols newConnection

Method Detail

configure back to summary

configure	back to summary
public void configure(Connector connector) Called during `Connector#start()`. Parameters connector:Connector The connector to configure

public void configure(Connector connector)

Called during Connector#start().

Parameters

connector:Connector: The connector to configure

org.eclipse.jetty.server back to summary

public Interface ConnectionFactory.Detecting

Known Direct Implementers: org.eclipse.jetty.server.ProxyConnectionFactory.ProxyV1ConnectionFactory, org.eclipse.jetty.server.ProxyConnectionFactory.ProxyV2ConnectionFactory, org.eclipse.jetty.server.SslConnectionFactory, org.eclipse.jetty.server.DetectorConnectionFactory

Connections created by this factory MUST implement Connection.UpgradeTo.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static enum	ConnectionFactory.Detecting.Detection The possible outcomes of the `detect(ByteBuffer)` method.

Method Summary

Modifier and Type Method and Description

Modifier and Type	Method and Description
public ConnectionFactory.Detecting.Detection	Returns: One of: `Detection#RECOGNIZED` if this `Detecting` instance can work with the bytes in the buffer `Detection#NOT_RECOGNIZED` if this `Detecting` instance cannot work with the bytes in the buffer `Detection#NEED_MORE_BYTES` if this `Detecting` instance requires more bytes to make a decision detect(ByteBuffer the buffer. buffer) Check the bytes in the given `buffer` to figure out if this `Detecting` instance can work with them or not.

public ConnectionFactory.Detecting.Detection

Returns:

One of:

Detection#RECOGNIZED if this Detecting instance can work with the bytes in the buffer
Detection#NOT_RECOGNIZED if this Detecting instance cannot work with the bytes in the buffer
Detection#NEED_MORE_BYTES if this Detecting instance requires more bytes to make a decision

detect(ByteBuffer

the buffer.

buffer)

Check the bytes in the given buffer to figure out if this Detecting instance can work with them or not.

Inherited from org.eclipse.jetty.server.ConnectionFactory:: getProtocol getProtocols newConnection

Method Detail

detect back to summary

detect	back to summary
public ConnectionFactory.Detecting.Detection detect(ByteBuffer buffer) Check the bytes in the given `buffer` to figure out if this `Detecting` instance can work with them or not. The `buffer` MUST be left untouched by this method: bytes MUST NOT be consumed and MUST NOT be modified. Parameters buffer:ByteBuffer the buffer. Returns:ConnectionFactory.Detecting.Detection One of: `Detection#RECOGNIZED` if this `Detecting` instance can work with the bytes in the buffer `Detection#NOT_RECOGNIZED` if this `Detecting` instance cannot work with the bytes in the buffer `Detection#NEED_MORE_BYTES` if this `Detecting` instance requires more bytes to make a decision

public ConnectionFactory.Detecting.Detection detect(ByteBuffer buffer)

Check the bytes in the given buffer to figure out if this Detecting instance can work with them or not.

The buffer MUST be left untouched by this method: bytes MUST NOT be consumed and MUST NOT be modified.

Parameters

buffer:ByteBuffer: the buffer.

Returns:ConnectionFactory.Detecting.Detection

One of:

Detection#RECOGNIZED if this Detecting instance can work with the bytes in the buffer
Detection#NOT_RECOGNIZED if this Detecting instance cannot work with the bytes in the buffer
Detection#NEED_MORE_BYTES if this Detecting instance requires more bytes to make a decision

org.eclipse.jetty.server back to summary

public final Enum ConnectionFactory.Detecting.Detection

Class Inheritance

extends Enum<ConnectionFactory.Detecting.Detection>

java.lang.Object
java.lang.Enum
org.eclipse.jetty.server.ConnectionFactory.Detecting.Detection

The possible outcomes of the detect(ByteBuffer) method.

Field Summary

Modifier and Type	Field and Description
public static final ConnectionFactory.Detecting.Detection	NEED_MORE_BYTES A `Detecting` requires more bytes to make a decision.
public static final ConnectionFactory.Detecting.Detection	NOT_RECOGNIZED A `Detecting` cannot work with the given bytes.
public static final ConnectionFactory.Detecting.Detection	RECOGNIZED A `Detecting` can work with the given bytes.

Constructor Summary

Access	Constructor and Description
private	Detection()

Method Summary

Modifier and Type	Method and Description
public static ConnectionFactory.Detecting.Detection	valueOf(String name)
public static ConnectionFactory.Detecting.Detection[]	values()

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

Field Detail

NEED_MORE_BYTES	back to summary
public static final ConnectionFactory.Detecting.Detection NEED_MORE_BYTES A `Detecting` requires more bytes to make a decision.

NOT_RECOGNIZED	back to summary
public static final ConnectionFactory.Detecting.Detection NOT_RECOGNIZED A `Detecting` cannot work with the given bytes.

RECOGNIZED	back to summary
public static final ConnectionFactory.Detecting.Detection RECOGNIZED A `Detecting` can work with the given bytes.

Constructor Detail

Detection	back to summary
private Detection()

Method Detail

valueOf	back to summary
public static ConnectionFactory.Detecting.Detection valueOf(String name)

values	back to summary
public static ConnectionFactory.Detecting.Detection[] values()

org.eclipse.jetty.server back to summary

public Interface ConnectionFactory.Upgrading

extends ConnectionFactory

Method Summary

Modifier and Type	Method and Description
public Connection	Returns: Null to indicate that request processing should continue normally without upgrading. A new connection instance to indicate that the upgrade should proceed. upgradeConnection(Connector The connector to upgrade for. connector, EndPoint The endpoint of the connection. endPoint, MetaData.Request The meta data of the upgrade request. upgradeRequest, HttpFields.Mutable The fields to be sent with the 101 response responseFields) Create a connection for an upgrade request.

Modifier and Type

Method and Description

public Connection

Returns:

Null to indicate that request processing should continue normally without upgrading. A new connection instance to indicate that the upgrade should proceed.

upgradeConnection(Connector

The connector to upgrade for.

connector, EndPoint

The endpoint of the connection.

endPoint, MetaData.Request

The meta data of the upgrade request.

upgradeRequest, HttpFields.Mutable

The fields to be sent with the 101 response

responseFields)

Create a connection for an upgrade request.

Inherited from org.eclipse.jetty.server.ConnectionFactory:: getProtocol getProtocols newConnection

Method Detail

upgradeConnection back to summary

public Connection upgradeConnection(Connector connector, EndPoint endPoint, MetaData.Request upgradeRequest, HttpFields.Mutable responseFields) throws BadMessageException

Create a connection for an upgrade request.

This is a variation of newConnection(Connector, EndPoint) that can create (and/or customise) a connection for an upgrade request. Implementations may call newConnection(Connector, EndPoint) or may construct the connection instance themselves.

Parameters

connector:Connector: The connector to upgrade for.
endPoint:EndPoint: The endpoint of the connection.
upgradeRequest:MetaData.Request: The meta data of the upgrade request.
responseFields:HttpFields.Mutable: The fields to be sent with the 101 response

Returns:Connection

Null to indicate that request processing should continue normally without upgrading. A new connection instance to indicate that the upgrade should proceed.

Exceptions

BadMessageException:: Thrown to indicate the upgrade attempt was illegal and that a bad message response should be sent.