Class HttpClientRequest

java.lang.Object

io.helidon.webclient.api.ClientRequestBase<HttpClientRequest, HttpClientResponse>

io.helidon.webclient.api.HttpClientRequest

All Implemented Interfaces:

ClientRequest<HttpClientRequest>, FullClientRequest<HttpClientRequest>

public class HttpClientRequest
extends ClientRequestBase<HttpClientRequest, HttpClientResponse>

Client request of any client that support HTTP protocol. This allows configuration of a request, such as setting headers, query parameters etc. Terminating methods are ClientRequestBase.submit(Object) (and its variants), and ClientRequestBase.request() (and its variants).

Nested Class Summary

Nested classes/interfaces inherited from interface ClientRequest

ClientRequest.OutputStreamHandler

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

Field Summary

Fields inherited from class ClientRequestBase

PROXY_CONNECTION, USER_AGENT_HEADER

Modifier and Type	Field	Description
static final Header	PROXY_CONNECTION	Proxy connection header.
static final Header	USER_AGENT_HEADER	Helidon user agent request header.

Method Summary

Modifier and Type	Method	Description
protected HttpClientResponse	doOutputStream(ClientRequest.OutputStreamHandler outputStreamConsumer)	Submit a request entity provided through an output stream.
protected HttpClientResponse	doSubmit(Object entity)	Submit a request entity.
HttpClientRequest	protocolId(String protocol)	Use an explicit version of HTTP by defining its ALPN protocol ID.

Methods inherited from class ClientRequestBase

additionalHeaders, address, address, clearConnection, clearSelectedProxyRoute, clientConfig, connection, connection, crossesRedirectOriginBoundary, followRedirects, followRedirects, fragment, header, headers, headers, headers, invokeServices, invokeServices, invokeServices, keepAlive, keepAlive, maxRedirects, maxRedirects, mediaContext, method, outputStream, path, pathParam, pathParams, properties, property, proxy, proxy, queryParam, readContinueTimeout, readContinueTimeout, readTimeout, readTimeout, request, requestId, requestWithoutRouteCleanup, resolvedUri, resolveUri, sanitizeRedirectSensitiveHeaders, selectedProxyRoute, selectedProxyRoute, sendExpectContinue, sendExpectContinue, skipUriEncoding, skipUriEncoding, sni, sni, submit, tls, tls, uri, uri, uri, uri

Modifier and Type	Method	Description
protected void	additionalHeaders()	Append additional headers before sending the request.
Optional<SocketAddress>	address()	Address of the connection, if configured.
HttpClientRequest	address(SocketAddress socketAddress)	Socket address to use.
final void	clearConnection()	Clear an internally supplied connection without changing other request state.
void	clearSelectedProxyRoute()	Clear retained route state after the current top-level request invocation, or when it no longer matches a finalized request target.
protected HttpClientConfig	clientConfig()	Associated client configuration.
Optional<ClientConnection>	connection()	Possible explicit connection to use (such as when using a proxy).
HttpClientRequest	connection(ClientConnection connection)	This method is for explicit connection use by this request.
protected final boolean	crossesRedirectOriginBoundary(ClientUri requestUri)	Whether a redirect from this request to the provided URI would cross, or has already crossed, an origin boundary.
boolean	followRedirects()	Whether to follow redirects.
HttpClientRequest	followRedirects(boolean followRedirects)	Whether to follow redirects.
HttpClientRequest	fragment(UriFragment fragment)	Set fragment of the URI.
HttpClientRequest	header(Header header)	Set an HTTP header.
ClientRequestHeaders	headers()	Get a (mutable) instance of outgoing headers.
HttpClientRequest	headers(Headers headers)	Configure headers.
HttpClientRequest	headers(Consumer<ClientRequestHeaders> headersConsumer)	Update headers.
protected WebClientServiceResponse	invokeServices(WebClient webClient, WebClientService.TransportChain httpCallChain, CompletableFuture<WebClientServiceRequest> whenSent, CompletableFuture<WebClientServiceResponse> whenComplete, ClientUri usedUri)	Invoke configured client services and publish applicable transport response context before they unwind.
protected WebClientServiceResponse	invokeServices(WebClientService.Chain httpCallChain, CompletableFuture<WebClientServiceRequest> whenSent, CompletableFuture<WebClientServiceResponse> whenComplete, ClientUri usedUri)	Invoke configured client services.
protected WebClientServiceResponse	invokeServices(WebClientService.WireProtocolChain httpCallChain, CompletableFuture<WebClientServiceRequest> whenSent, CompletableFuture<WebClientServiceResponse> whenComplete, ClientUri usedUri)	Invoke configured client services.
boolean	keepAlive()	Whether to use keep-alive connection (if relevant for the used HTTP version).
HttpClientRequest	keepAlive(boolean keepAlive)	Whether to use keep alive with this request.
int	maxRedirects()	Maximal number of redirects to follow.
HttpClientRequest	maxRedirects(int maxRedirects)	Max number of the followed redirects.
protected MediaContext	mediaContext()	Media context configured for this request.
Method	method()	HTTP method to be invoked.
HttpClientResponse	outputStream(ClientRequest.OutputStreamHandler outputStreamConsumer)	Handle output stream and submit the request.
HttpClientRequest	path(String uri)	Configure path to call.
HttpClientRequest	pathParam(String name, String value)	Replace a placeholder in URI with an actual value.
Map<String,String>	pathParams()	Replace a placeholder in URI with an actual value.
Map<String,String>	properties()	Properties configured by a user or by other components.
HttpClientRequest	property(String propertyName, String propertyValue)	Add a property to be used by this request.
Proxy	proxy()	Proxy configuration (may be no-proxy).
HttpClientRequest	proxy(Proxy proxy)	Proxy configuration for this specific request.
HttpClientRequest	queryParam(String name, String... values)	Add query parameter.
Duration	readContinueTimeout()	Read 100-Continue timeout.
HttpClientRequest	readContinueTimeout(Duration readContinueTimeout)	Read 100-Continue timeout for this request.
Duration	readTimeout()	Read timeout.
HttpClientRequest	readTimeout(Duration readTimeout)	Read timeout for this request.
HttpClientResponse	request()	Request without an entity.
String	requestId()	Request ID.
protected final HttpClientResponse	requestWithoutRouteCleanup()	Submit an internal request that participates in the enclosing top-level request's selected route.
ClientUri	resolvedUri()	Resolved URI that will be used to invoke this request.
protected ClientUri	resolveUri(ClientUri toResolve)	Resolve possible templated URI definition against the provided ClientUri, extracting possible query information into the provided writable query.
protected final void	sanitizeRedirectSensitiveHeaders(ClientUri requestUri, ClientRequestHeaders requestHeaders)	Remove headers that must not cross redirect trust boundaries.
Optional<ProxyRoute>	selectedProxyRoute()	Effective proxy route already selected during the current top-level request invocation.
void	selectedProxyRoute(ProxyRoute proxyRoute)	Retain an effective proxy route while handing a request between protocol implementations in the current top-level request invocation.
Optional<Boolean>	sendExpectContinue()	Whether Expect 100-Continue header is sent to verify server availability before sending an entity.
HttpClientRequest	sendExpectContinue(boolean sendExpectContinue)	Whether Expect 100-Continue header is sent to verify server availability before sending an entity.
boolean	skipUriEncoding()	Whether to skip URI encoding.
HttpClientRequest	skipUriEncoding(boolean skip)	Disable uri encoding.
Optional<SniConfig>	sni()	Request-level SNI configuration.
HttpClientRequest	sni(SniConfig sni)	Configure client-side TLS SNI for this request.
HttpClientResponse	submit(Object entity)	Submit an entity.
Tls	tls()	TLS configuration (may be disabled - e.g.
HttpClientRequest	tls(Tls tls)	TLS configuration for this specific request.
ClientUri	uri()	URI of this request.
HttpClientRequest	uri(ClientUri uri)	Configure request URI.
HttpClientRequest	uri(String uri)	Configure URI.
HttpClientRequest	uri(URI uri)	Configure URI.

Methods inherited from class Object

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

Methods inherited from interface ClientRequest

accept, accept, contentType, fragment, header, header, outputStream, request, request, requestEntity, requestEntity, sni, submit, submit

Modifier and Type	Method	Description
default HttpClientRequest	accept(MediaType... acceptedTypes)	Accepted media types.
default HttpClientRequest	accept(HttpMediaType... accepted)	Accepted media types.
default HttpClientRequest	contentType(MediaType contentType)	Sets the content type of the request.
default HttpClientRequest	fragment(String fragment)	Set fragment of the URI.
default HttpClientRequest	header(HeaderName name, String... values)	Set an HTTP header.
default HttpClientRequest	header(HeaderName name, List<String> values)	Set an HTTP header with multiple values.
default <T> ClientResponseTyped<T>	outputStream(ClientRequest.OutputStreamHandler outputStreamConsumer, Class<T> requestedType)	Handle output stream and request a specific type.
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.
default HttpClientRequest	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.

Method Details

protocolId

public HttpClientRequest protocolId(String protocol)

Use an explicit version of HTTP by defining its ALPN protocol ID. Constants are defined on each version specific client. For example to use HTTP/2, h2 is the protocol ID. For TLS, we will attempt only h2 negotiation, for plaintext requests, we will either attempt an upgrade from HTTP/1.1, or use prior knowledge according to HTTP/2 protocol configuration. This method is a no-op when called on a version specific HTTP client.

Parameters:

protocol - HTTP protocol ID to use

Returns:

updated request

doSubmit

protected HttpClientResponse doSubmit(Object entity)

Description copied from class: ClientRequestBase

Submit a request entity.

Specified by:

doSubmit in class ClientRequestBase<HttpClientRequest, HttpClientResponse>

Parameters:

entity - request entity

Returns:

HTTP client response

doOutputStream

protected HttpClientResponse doOutputStream(ClientRequest.OutputStreamHandler outputStreamConsumer)

Description copied from class: ClientRequestBase

Submit a request entity provided through an output stream.

Specified by:

doOutputStream in class ClientRequestBase<HttpClientRequest, HttpClientResponse>

Parameters:

outputStreamConsumer - output stream handler

Returns:

HTTP client response