Nested and Inner Type Summary

Modifier and Type	Class and Description
public static interface	ClientConnectionFactory.Decorator Wraps another ClientConnectionFactory.
public abstract static class	ClientConnectionFactory.Info A holder for a list of protocol strings identifying an application protocol (for example `["h2", "h2-17", "h2-16"]`) and a `ClientConnectionFactory` that creates connections that speak that network protocol.

Field Summary

Modifier and Type	Field and Description
public static final String	CLIENT_CONTEXT_KEY

Method Summary

Modifier and Type	Method and Description
public default Connection	customize(Connection connection, Map<String, Object> context)
public Connection	newConnection(EndPoint the `org.eclipse.jetty.io.EndPoint` to link the newly created connection to endPoint, Map<String, Object> the context data to create the connection context) Returns: a new `Connection`

Field Detail

CLIENT_CONTEXT_KEY	back to summary
public static final String CLIENT_CONTEXT_KEY

Method Detail

customize	back to summary
public default Connection customize(Connection connection, Map<String, Object> context)

newConnection	back to summary
public Connection newConnection(EndPoint endPoint, Map<String, Object> context) throws IOException Parameters endPoint:EndPoint the `org.eclipse.jetty.io.EndPoint` to link the newly created connection to context:Map<String, Object> the context data to create the connection Returns:Connection a new `Connection` Exceptions IOException: if the connection cannot be created

org.eclipse.jetty.io back to summary

public Interface ClientConnectionFactory.Decorator

Wraps another ClientConnectionFactory.

This is typically done by protocols that send "preface" bytes with some metadata before other protocols. The metadata could be, for example, proxying information or authentication information.

Method Summary

Modifier and Type	Method and Description
public ClientConnectionFactory	Returns: the wrapping ClientConnectionFactory apply(ClientConnectionFactory the ClientConnectionFactory to wrap factory) Wraps the given `factory`.

Method Detail

apply back to summary

apply	back to summary
public ClientConnectionFactory apply(ClientConnectionFactory factory) Wraps the given `factory`. Parameters factory:ClientConnectionFactory the ClientConnectionFactory to wrap Returns:ClientConnectionFactory the wrapping ClientConnectionFactory

public ClientConnectionFactory apply(ClientConnectionFactory factory)

Wraps the given factory.

Parameters

factory:ClientConnectionFactory: the ClientConnectionFactory to wrap

Returns:ClientConnectionFactory

the wrapping ClientConnectionFactory

org.eclipse.jetty.io back to summary

public abstract Class ClientConnectionFactory.Info

Class Inheritance

extends ContainerLifeCycle

java.lang.Object
org.eclipse.jetty.util.component.AbstractLifeCycle
org.eclipse.jetty.util.component.ContainerLifeCycle
org.eclipse.jetty.io.ClientConnectionFactory.Info

A holder for a list of protocol strings identifying an application protocol (for example ["h2", "h2-17", "h2-16"]) and a ClientConnectionFactory that creates connections that speak that network protocol.

Field Summary

Modifier and Type	Field and Description
private final ClientConnectionFactory	factory

Constructor Summary

Access	Constructor and Description
public	Info(ClientConnectionFactory factory)

Method Summary

Modifier and Type	Method and Description
public ClientConnectionFactory	getClientConnectionFactory()
public abstract List<String>	getProtocols(boolean secure)
public boolean	Returns: whether one of the protocols of this class is present in the candidates matches(List<String> the candidates to match against candidates, boolean whether the protocol should be a secure one secure) Tests whether one of the protocols of this class is also present in the given candidates list.
public void	upgrade(EndPoint endPoint, Map<String, Object> context)

Field Detail

factory	back to summary
private final ClientConnectionFactory factory

Constructor Detail

Info	back to summary
public Info(ClientConnectionFactory factory)

Method Detail

getClientConnectionFactory	back to summary
public ClientConnectionFactory getClientConnectionFactory()

getProtocols	back to summary
public abstract List<String> getProtocols(boolean secure)

matches	back to summary
public boolean matches(List<String> candidates, boolean secure) Tests whether one of the protocols of this class is also present in the given candidates list. Parameters candidates:List<String> the candidates to match against secure:boolean whether the protocol should be a secure one Returns:boolean whether one of the protocols of this class is present in the candidates

matches

back to summary

public boolean matches(List<String> candidates, boolean secure)

Tests whether one of the protocols of this class is also present in the given candidates list.

Parameters

candidates:List<String>: the candidates to match against
secure:boolean: whether the protocol should be a secure one

Returns:boolean

whether one of the protocols of this class is present in the candidates

upgrade	back to summary
public void upgrade(EndPoint endPoint, Map<String, Object> context)