Class Http2ClientImpl

java.lang.Object

io.helidon.webclient.http2.Http2ClientImpl

All Implemented Interfaces:

RuntimeType.Api<Http2ClientConfig>, HttpClient<Http2ClientRequest>, ReleasableResource, Http2Client, HttpClientSpi

public class Http2ClientImpl
extends Object
implements Http2Client, HttpClientSpi

Implementation of HTTP2 client.

Nested Class Summary

Nested classes/interfaces inherited from interface HttpClientSpi

HttpClientSpi.SupportLevel

Modifier and Type	Interface	Description
static enum	HttpClientSpi.SupportLevel	How does the provider support the request.

Field Summary

Fields inherited from interface Http2Client

PROTOCOL, PROTOCOL_ID

Modifier and Type	Field	Description
static final Protocol<Http2Client, Http2ClientProtocolConfig>	PROTOCOL	Protocol to use to obtain an instance of http/2 specific client from WebClient.client(io.helidon.webclient.spi.Protocol).
static final String	PROTOCOL_ID	HTTP/2 protocol ID, as used by ALPN.

Method Summary

Modifier and Type	Method	Description
ClientRequest<?>	clientRequest(FullClientRequest<?> clientRequest, ClientUri clientUri)	Create a client request based on the provided HTTP request that is for the version of this client.
void	closeResource()	Gracefully close all opened client specific connections.
Http2ClientRequest	method(Method method)	Create a request for a method.
Http2ClientConfig	prototype()	The prototype as it was received when creating this runtime object instance.
void	responseReceived(WebClientProtocolResponse response)	Notification invoked after the WebClient receives a transport response, regardless of the protocol that produced it.
HttpClientSpi.SupportLevel	supports(FullClientRequest<?> clientRequest, ClientUri clientUri)	Return whether this HTTP version can handle the provided request.

Methods inherited from class Object

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

Methods inherited from interface HttpClient

delete, delete, get, get, head, head, options, options, patch, patch, post, post, put, put, trace, trace

Modifier and Type	Method	Description
default Http2ClientRequest	delete()	Shortcut for delete method with default path.
default Http2ClientRequest	delete(String uri)	Shortcut for delete method with a path.
default Http2ClientRequest	get()	Shortcut for get method with default path.
default Http2ClientRequest	get(String uri)	Shortcut for get method with a path.
default Http2ClientRequest	head()	Shortcut for head method with default path.
default Http2ClientRequest	head(String uri)	Shortcut for head method with a path.
default Http2ClientRequest	options()	Shortcut for options method with default path.
default Http2ClientRequest	options(String uri)	Shortcut for options method with a path.
default Http2ClientRequest	patch()	Shortcut for patch method with default path.
default Http2ClientRequest	patch(String uri)	Shortcut for patch method with a path.
default Http2ClientRequest	post()	Shortcut for post method with default path.
default Http2ClientRequest	post(String uri)	Shortcut for post method with a path.
default Http2ClientRequest	put()	Shortcut for put method with default path.
default Http2ClientRequest	put(String uri)	Shortcut for put method with a path.
default Http2ClientRequest	trace()	Shortcut for trace method with default path.
default Http2ClientRequest	trace(String uri)	Shortcut for trace method with a path.

Methods inherited from interface HttpClientSpi

isTcp

Modifier and Type	Method	Description
default boolean	isTcp()	For TCP based protocols, we can do ALPN negotiation, obtain a connection, and then let the client handle the protocol.

Methods inherited from interface ReleasableResource

releaseResource

Modifier and Type	Method	Description
default void	releaseResource()	Releases the resource, and if this resource is re-usable, enabled reuse.

Method Details

method

public Http2ClientRequest method(Method method)

Description copied from interface: HttpClient

Create a request for a method.

Specified by:

method in interface HttpClient<Http2ClientRequest>

Parameters:

method - HTTP method

Returns:

a new request (not thread safe)

prototype

public Http2ClientConfig prototype()

Description copied from interface: RuntimeType.Api

The prototype as it was received when creating this runtime object instance.

Specified by:

prototype in interface RuntimeType.Api<Http2ClientConfig>

Returns:

prototype object used to create this instance

supports

public HttpClientSpi.SupportLevel supports(FullClientRequest<?> clientRequest,
 ClientUri clientUri)

Description copied from interface: HttpClientSpi

Return whether this HTTP version can handle the provided request.

Examples:

• HTTP/1.1 always returns HttpClientSpi.SupportLevel.COMPATIBLE, as it is the fallback protocol of all other protocols
• A protocol with a reusable connection returns HttpClientSpi.SupportLevel.SUPPORTED
• A dynamically discovered protocol can move between HttpClientSpi.SupportLevel.NOT_SUPPORTED and HttpClientSpi.SupportLevel.SUPPORTED as endpoint information becomes available or expires

So how can we get to HTTP/2 with prior knowledge, or HTTP/3? There are the following options:

• An explicit protocol id is configured for the request - HttpClientRequest.protocolId(String)
• There is no fallback protocol enabled, in such a case, we use the one with highest priority - see WebClientConfig.BuilderBase.addProtocolPreference(String)
• The client dynamically learns that another protocol is viable for the endpoint
• This protocol version already handled a request to such an endpoint and has the connection available

Note that this result is cached and revalidated for later requests. Implementations must make this method cheap and safe to invoke repeatedly, including for concurrent requests.

Specified by:

supports in interface HttpClientSpi

Parameters:

clientRequest - HTTP request

clientUri - URI to invoke

Returns:

support level for this protocol and request

responseReceived

public void responseReceived(WebClientProtocolResponse response)

Description copied from interface: HttpClientSpi

Notification invoked after the WebClient receives a transport response, regardless of the protocol that produced it.

An implementation may inspect response metadata relevant to its protocol. For example, it may learn about an alternative service from an Alt-Svc response header received over another protocol.

Specified by:

responseReceived in interface HttpClientSpi

Parameters:

response - received protocol response

clientRequest

public ClientRequest<?> clientRequest(FullClientRequest<?> clientRequest,
 ClientUri clientUri)

Description copied from interface: HttpClientSpi

Create a client request based on the provided HTTP request that is for the version of this client.

Specified by:

clientRequest in interface HttpClientSpi

Parameters:

clientRequest - request configuration

clientUri - URI to invoke (resolved)

Returns:

a new request

closeResource

public void closeResource()

Description copied from interface: HttpClient

Gracefully close all opened client specific connections.

Specified by:

closeResource in interface HttpClient<Http2ClientRequest>

Specified by:

closeResource in interface ReleasableResource