Class HttpClientTransportDynamic
- All Implemented Interfaces:
HttpClient.Aware, HttpClientTransport, ClientConnectionFactory, Container, Destroyable, Dumpable, Dumpable.DumpableContainer, LifeCycle
A HttpClientTransport that can dynamically switch among different application protocols.
Applications create HttpClientTransportDynamic instances specifying all the application protocols it supports, in order of preference. The typical case is when the server supports both HTTP/1.1 and HTTP/2, but the client does not know that. In this case, the application will create a HttpClientTransportDynamic in this way:
ClientConnector clientConnector = new ClientConnector();
// Configure the clientConnector.
// Prepare the application protocols.
ClientConnectionFactory.Info h1 = HttpClientConnectionFactory.HTTP11;
HTTP2Client http2Client = new HTTP2Client(clientConnector);
ClientConnectionFactory.Info h2 = new ClientConnectionFactoryOverHTTP2.HTTP2(http2Client);
// Create the HttpClientTransportDynamic, preferring h2 over h1.
HttpClientTransport transport = new HttpClientTransportDynamic(clientConnector, h2, h1);
// Create the HttpClient.
client = new HttpClient(transport);
Note how in the code above the HttpClientTransportDynamic has been created with the application
protocols h2 and h1, without the need to specify TLS (which is implied by the request
scheme) or ALPN (which is implied by HTTP/2 over TLS).
When a request is first sent, (scheme, host, port) are not enough to identify the destination
because the same origin may speak different protocols.
For example, the Jetty server supports speaking clear-text http/1.1 and h2c on the same port.
Imagine a client sending a h2c request to that port; this will create a destination and connections
that speak h2c; it won't be possible to use the connections from that destination to send
http/1.1 requests.
Therefore a destination is identified by a Origin and
applications can customize the creation of the origin (for example depending on request protocol
version, or request headers, or request attributes, or even request path) by overriding
HttpClientTransport.newOrigin(Request).
-
Nested Class Summary
Nested classes/interfaces inherited from class AbstractLifeCycle
AbstractLifeCycle.AbstractLifeCycleListener, AbstractLifeCycle.StopExceptionNested classes/interfaces inherited from interface ClientConnectionFactory
ClientConnectionFactory.Decorator, ClientConnectionFactory.InfoNested classes/interfaces inherited from interface Container
Container.InheritedListener, Container.ListenerNested classes/interfaces inherited from interface Dumpable
Dumpable.DumpableContainerNested classes/interfaces inherited from interface LifeCycle
LifeCycle.Listener -
Field Summary
Fields inherited from interface ClientConnectionFactory
CLIENT_CONTEXT_KEYFields inherited from interface HttpClientTransport
HTTP_CONNECTION_PROMISE_CONTEXT_KEY, HTTP_DESTINATION_CONTEXT_KEY -
Constructor Summary
ConstructorsConstructorDescriptionCreates a dynamic transport that speaks only HTTP/1.1.Deprecated, for removal: This API element is subject to removal in a future version.HttpClientTransportDynamic(ClientConnector connector, ClientConnectionFactory.Info... infos) Creates a dynamic transport with the givenClientConnectorand the given protocols, in order of preference (first the most preferred). -
Method Summary
Modifier and TypeMethodDescriptionnewConnection(EndPoint endPoint, Map<String, Object> context) newDestination(Origin origin) Creates a new, transport-specific,HttpDestinationobject.protected ConnectionnewNegotiatedConnection(EndPoint endPoint, Map<String, Object> context) Creates a new Origin with the given request.voidMethods inherited from class AbstractConnectorHttpClientTransport
connect, connect, doStart, getClientConnector, getSelectorsMethods inherited from class AbstractHttpClientTransport
connectFailed, getConnectionPoolFactory, getHttpClient, setConnectionPoolFactory, setHttpClientMethods inherited from class ContainerLifeCycle
addBean, addBean, addEventListener, addManaged, contains, destroy, doStop, dump, dump, dump, dumpObjects, dumpStdErr, getBean, getBeans, getBeans, getContainedBeans, getContainedBeans, installBean, installBean, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, removeEventListener, setBeans, start, stop, unmanage, updateBean, updateBean, updateBeans, updateBeansMethods inherited from class AbstractLifeCycle
getEventListeners, getState, getState, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, setEventListeners, start, stop, toStringMethods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface ClientConnectionFactory
customizeMethods inherited from interface Container
getCachedBeans, getEventListenersMethods inherited from interface Dumpable.DumpableContainer
isDumpable
-
Constructor Details
-
HttpClientTransportDynamic
public HttpClientTransportDynamic()Creates a dynamic transport that speaks only HTTP/1.1. -
HttpClientTransportDynamic
@Deprecated(since="12.0.7", forRemoval=true) public HttpClientTransportDynamic(ClientConnectionFactory.Info... infos) Deprecated, for removal: This API element is subject to removal in a future version.Creates a dynamic transport that speaks the given protocols, in order of preference (first the most preferred).
- Parameters:
infos- the protocols this dynamic transport speaks
-
HttpClientTransportDynamic
Creates a dynamic transport with the given
ClientConnectorand the given protocols, in order of preference (first the most preferred).- Parameters:
connector- the ClientConnector used by this transportinfos- the application protocols that this transport can speak
-
-
Method Details
-
newOrigin
Description copied from interface:HttpClientTransportCreates a new Origin with the given request.- Parameters:
request- the request that triggers the creation of the Origin- Returns:
- an Origin that identifies a destination
-
newDestination
Description copied from interface:HttpClientTransportCreates a new, transport-specific,HttpDestinationobject.HttpDestinationcontrols the destination-connection cardinality: protocols like HTTP have 1-N cardinality, while multiplexed protocols like HTTP/2 have a 1-1 cardinality.- Parameters:
origin- the destination origin- Returns:
- a new, transport-specific,
HttpDestinationobject
-
newConnection
- Parameters:
endPoint- theEndPointto link the newly created connection tocontext- the context data to create the connection- Returns:
- a new
Connection - Throws:
IOException- if the connection cannot be created
-
upgrade
-
newNegotiatedConnection
protected Connection newNegotiatedConnection(EndPoint endPoint, Map<String, Object> context) throws IOException- Throws:
IOException
-
HttpClientTransportDynamic(ClientConnector, ClientConnectionFactory.Info...)