Interface Http2ClientRequest

All Superinterfaces:

ClientRequest<Http2ClientRequest>

public interface Http2ClientRequest
extends ClientRequest<Http2ClientRequest>

Request of HTTP/2 client.

Nested Class Summary

Nested classes/interfaces inherited from interface ClientRequest

ClientRequest.OutputStreamHandler

Modifier and Type	Interface	Description
static interface	ClientRequest.OutputStreamHandler	Handle output stream.

Method Summary

Modifier and Type	Method	Description
Http2ClientRequest	flowControlTimeout(Duration timeout)	Outbound flow control blocking timeout.
Http2ClientResponse	outputStream(ClientRequest.OutputStreamHandler outputStreamConsumer)	Handle output stream and submit the request.
Http2ClientRequest	priority(int priority)	Priority defines a weight between 1 and 256 (inclusive) to prioritize this stream by the server.
Http2ClientRequest	priorKnowledge(boolean priorKnowledge)	Configure prior knowledge of HTTP/2 (e.g.
default Http2ClientResponse	request()	Request without an entity.
Http2ClientRequest	requestPrefetch(int requestPrefetch)	Configure request prefetch, increases both connection and stream inbound flow control window and may send window updates to inform the server, depending on flow control strategy.
Http2ClientResponse	submit(Object entity)	Submit an entity.

Methods inherited from interface ClientRequest

accept, accept, address, connection, contentType, followRedirects, followRedirects, fragment, fragment, header, header, header, headers, headers, headers, keepAlive, maxRedirects, maxRedirects, outputStream, path, pathParam, property, proxy, queryParam, readContinueTimeout, readTimeout, request, request, requestEntity, requestEntity, resolvedUri, sendExpectContinue, skipUriEncoding, sni, sni, submit, submit, tls, uri, uri, uri

Modifier and Type	Method	Description
default Http2ClientRequest	accept(MediaType... acceptedTypes)	Accepted media types.
default Http2ClientRequest	accept(HttpMediaType... accepted)	Accepted media types.
default Http2ClientRequest	address(SocketAddress socketAddress)	Socket address to use.
Http2ClientRequest	connection(ClientConnection connection)	This method is for explicit connection use by this request.
default Http2ClientRequest	contentType(MediaType contentType)	Sets the content type of the request.
boolean	followRedirects()	Whether to follow redirects.
Http2ClientRequest	followRedirects(boolean followRedirects)	Whether to follow redirects.
Http2ClientRequest	fragment(UriFragment fragment)	Set fragment of the URI.
default Http2ClientRequest	fragment(String fragment)	Set fragment of the URI.
Http2ClientRequest	header(Header header)	Set an HTTP header.
default Http2ClientRequest	header(HeaderName name, String... values)	Set an HTTP header.
default Http2ClientRequest	header(HeaderName name, List<String> values)	Set an HTTP header with multiple values.
ClientRequestHeaders	headers()	Get a (mutable) instance of outgoing headers.
Http2ClientRequest	headers(Headers headers)	Configure headers.
Http2ClientRequest	headers(Consumer<ClientRequestHeaders> headersConsumer)	Update headers.
Http2ClientRequest	keepAlive(boolean keepAlive)	Whether to use keep alive with this request.
int	maxRedirects()	Maximal number of redirects to follow.
Http2ClientRequest	maxRedirects(int maxRedirects)	Max number of the followed redirects.
default <T> ClientResponseTyped<T>	outputStream(ClientRequest.OutputStreamHandler outputStreamConsumer, Class<T> requestedType)	Handle output stream and request a specific type.
default Http2ClientRequest	path(String uri)	Configure path to call.
Http2ClientRequest	pathParam(String name, String value)	Replace a placeholder in URI with an actual value.
Http2ClientRequest	property(String propertyName, String propertyValue)	Add a property to be used by this request.
Http2ClientRequest	proxy(Proxy proxy)	Proxy configuration for this specific request.
Http2ClientRequest	queryParam(String name, String... values)	Add query parameter.
Http2ClientRequest	readContinueTimeout(Duration readContinueTimeout)	Read 100-Continue timeout for this request.
Http2ClientRequest	readTimeout(Duration readTimeout)	Read timeout for this request.
default <E> ClientResponseTyped<E>	request(GenericType<E> type)	Request without sending an entity.
default <E> ClientResponseTyped<E>	request(Class<E> type)	Request without sending an entity.
default <E> E	requestEntity(GenericType<E> type)	Request entity without sending a request entity, asking for entity only.
default <E> E	requestEntity(Class<E> type)	Request entity without sending a request entity, asking for entity only.
UriInfo	resolvedUri()	Resolved URI that will be used to invoke this request.
Http2ClientRequest	sendExpectContinue(boolean sendExpectContinue)	Whether Expect 100-Continue header is sent to verify server availability before sending an entity.
Http2ClientRequest	skipUriEncoding(boolean skip)	Disable uri encoding.
default Http2ClientRequest	sni(SniConfig sni)	Configure client-side TLS SNI for this request.
default Http2ClientRequest	sni(Consumer<SniConfig.Builder> sni)	Configure client-side TLS SNI for this request.
default <E> ClientResponseTyped<E>	submit(Object entity, GenericType<E> requestedType)	Submit an entity and request a specific type.
default <E> ClientResponseTyped<E>	submit(Object entity, Class<E> requestedType)	Submit an entity and request a specific type.
Http2ClientRequest	tls(Tls tls)	TLS configuration for this specific request.
Http2ClientRequest	uri(ClientUri uri)	Configure request URI.
default Http2ClientRequest	uri(String uri)	Configure URI.
Http2ClientRequest	uri(URI uri)	Configure URI.

Method Details

priority

Http2ClientRequest priority(int priority)

Priority defines a weight between 1 and 256 (inclusive) to prioritize this stream by the server. Priorities are a suggestion.

Parameters:

priority - priority to configure for this stream (request/response)

Returns:

updated request

priorKnowledge

Http2ClientRequest priorKnowledge(boolean priorKnowledge)

Configure prior knowledge of HTTP/2 (e.g. we know the server supports it and we do not need to handle upgrade).

Parameters:

priorKnowledge - set to true to skip HTTP/1.1 upgrade process and use prior knowledge

Returns:

updated request

requestPrefetch

Http2ClientRequest requestPrefetch(int requestPrefetch)

Configure request prefetch, increases both connection and stream inbound flow control window and may send window updates to inform the server, depending on flow control strategy.

Parameters:

requestPrefetch - inbound flow control window increment in bytes

Returns:

updated request

flowControlTimeout

Http2ClientRequest flowControlTimeout(Duration timeout)

Outbound flow control blocking timeout.

Parameters:

timeout - duration

Returns:

updated request

request

default Http2ClientResponse request()

Description copied from interface: ClientRequest

Request without an entity.

Specified by:

request in interface ClientRequest<Http2ClientRequest>

Returns:

response

submit

Http2ClientResponse submit(Object entity)

Description copied from interface: ClientRequest

Submit an entity.

Specified by:

submit in interface ClientRequest<Http2ClientRequest>

Parameters:

entity - request entity

Returns:

response

outputStream

Http2ClientResponse outputStream(ClientRequest.OutputStreamHandler outputStreamConsumer)

Description copied from interface: ClientRequest

Handle output stream and submit the request.

Specified by:

outputStream in interface ClientRequest<Http2ClientRequest>

Parameters:

outputStreamConsumer - output stream to write request entity

Returns:

response