Module io.helidon.webclient.api

Package io.helidon.webclient.api

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 io.helidon.webclient.api.ClientRequest

ClientRequest.OutputStreamHandler

Method Summary

Modifier and Type	Method	Description
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.
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.
Tls	tls()	TLS configuration (may be disabled - e.g.
ClientUri	uri()	URI of this request.

Methods inherited from interface io.helidon.webclient.api.ClientRequest

accept, accept, 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, requestEntity, resolvedUri, sendExpectContinue, skipUriEncoding, submit, submit, tls, uri, uri, 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

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

proxy

Proxy proxy()

Proxy configuration (may be no-proxy).

Returns:

proxy

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