Interface FullClientRequest<T extends ClientRequest<T>>

Type Parameters:

T - type of the implementation, to support fluent API

All Superinterfaces:

ClientRequest<T>

All Known Implementing Classes:

ClientRequestBase, HttpClientRequest

public interface FullClientRequest<T extends ClientRequest<T>>
extends ClientRequest<T>

Client request with getters for all configurable options, used for integration with HTTP version implementations.

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
default Optional<SocketAddress>	address()	Address of the connection, if configured.
default void	clearSelectedProxyRoute()	Clear retained route state after the current top-level request invocation, or when it no longer matches a finalized request target.
Optional<ClientConnection>	connection()	Possible explicit connection to use (such as when using a proxy).
boolean	keepAlive()	Whether to use keep-alive connection (if relevant for the used HTTP version).
Method	method()	HTTP method of this request.
Map<String,String>	pathParams()	Replace a placeholder in URI with an actual value.
Map<String,String>	properties()	Configured properties.
Proxy	proxy()	Proxy configuration (may be no-proxy).
Duration	readContinueTimeout()	Read 100-Continue timeout.
Duration	readTimeout()	Read timeout.
String	requestId()	Request ID.
default Optional<ProxyRoute>	selectedProxyRoute()	Effective proxy route already selected during the current top-level request invocation.
default 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.
boolean	skipUriEncoding()	Whether to skip URI encoding.
default Optional<SniConfig>	sni()	Request-level SNI configuration.
Tls	tls()	TLS configuration (may be disabled - e.g.
ClientUri	uri()	URI of this request.

Methods inherited from interface ClientRequest

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

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

Method Details

pathParams

Map<String,String> pathParams()

Replace a placeholder in URI with an actual value.

Returns:

a map of path parameters

method

Method method()

HTTP method of this request.

Returns:

method

uri

ClientUri uri()

URI of this request.

Returns:

client URI

properties

Map<String,String> properties()

Configured properties.

Returns:

properties

requestId

String requestId()

Request ID.

Returns:

id of this request

connection

Optional<ClientConnection> connection()

Possible explicit connection to use (such as when using a proxy).

Returns:

client connection if explicitly defined

address

default Optional<SocketAddress> address()

Address of the connection, if configured.

Returns:

socket address - may be an InetSocketAddress or UnixDomainSocketAddress

readTimeout

Duration readTimeout()

Read timeout.

Returns:

read timeout of this request

readContinueTimeout

Duration readContinueTimeout()

Read 100-Continue timeout.

Returns:

read 100-Continue timeout of this request

tls

Tls tls()

TLS configuration (may be disabled - e.g. use plaintext).

Returns:

TLS configuration

sni

default Optional<SniConfig> sni()

Request-level SNI configuration.

Returns:

SNI configuration if configured

proxy

Proxy proxy()

Proxy configuration (may be no-proxy).

Returns:

proxy

selectedProxyRoute

default Optional<ProxyRoute> selectedProxyRoute()

Effective proxy route already selected during the current top-level request invocation. The route may be shared with protocol fallbacks and other internal handoffs in that invocation.

Returns:

selected proxy route, or empty when this request still needs route selection

selectedProxyRoute

default void selectedProxyRoute(ProxyRoute proxyRoute)

Retain an effective proxy route while handing a request between protocol implementations in the current top-level request invocation. The default implementation validates and otherwise ignores the route.

Parameters:

proxyRoute - selected proxy route

clearSelectedProxyRoute

default void clearSelectedProxyRoute()

Clear retained route state after the current top-level request invocation, or when it no longer matches a finalized request target. The default implementation has no effect.

keepAlive

boolean keepAlive()

Whether to use keep-alive connection (if relevant for the used HTTP version).

Returns:

whether to use keep alive

skipUriEncoding

boolean skipUriEncoding()

Whether to skip URI encoding.

Returns:

whether to skip encoding

sendExpectContinue

Optional<Boolean> sendExpectContinue()

Whether Expect 100-Continue header is sent to verify server availability before sending an entity. Overrides the setting from HttpClientConfig.sendExpectContinue().

Returns:

Expect 100-Continue value if set