Class WebClientConfig.BuilderBase.WebClientConfigImpl

java.lang.Object

io.helidon.webclient.api.HttpConfigBase.BuilderBase.HttpConfigBaseImpl

io.helidon.webclient.api.HttpClientConfig.BuilderBase.HttpClientConfigImpl

io.helidon.webclient.api.WebClientConfig.BuilderBase.WebClientConfigImpl

All Implemented Interfaces:

Prototype.Api, Prototype.Factory<WebClient>, HttpClientConfig, HttpConfigBase, WebClientConfig, Supplier<WebClient>

Enclosing class:

WebClientConfig.BuilderBase<BUILDER extends WebClientConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends WebClientConfig>

protected static class WebClientConfig.BuilderBase.WebClientConfigImpl
extends HttpClientConfig.BuilderBase.HttpClientConfigImpl
implements WebClientConfig, Supplier<WebClient>

Generated implementation of the prototype, can be extended by descendant prototype implementations.

Nested Class Summary

Nested classes/interfaces inherited from interface HttpClientConfig

HttpClientConfig.Builder, HttpClientConfig.BuilderBase<BUILDER, PROTOTYPE>

Modifier and Type	Interface	Description
static class	HttpClientConfig.Builder	Fluent API builder for HttpClientConfig.
static class	HttpClientConfig.BuilderBase<BUILDER extends HttpClientConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends HttpClientConfig>	Fluent API builder base for HttpClientConfig.

Nested classes/interfaces inherited from interface HttpConfigBase

HttpConfigBase.Builder, HttpConfigBase.BuilderBase<BUILDER, PROTOTYPE>

Modifier and Type	Interface	Description
static class	HttpConfigBase.Builder	Fluent API builder for HttpConfigBase.
static class	HttpConfigBase.BuilderBase<BUILDER extends HttpConfigBase.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends HttpConfigBase>	Fluent API builder base for HttpConfigBase.

Nested classes/interfaces inherited from interface WebClientConfig

WebClientConfig.Builder, WebClientConfig.BuilderBase<BUILDER, PROTOTYPE>

Modifier and Type	Interface	Description
static class	WebClientConfig.Builder	Fluent API builder for WebClient.
static class	WebClientConfig.BuilderBase<BUILDER extends WebClientConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends WebClientConfig>	Fluent API builder base for WebClientConfig.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	WebClientConfigImpl(WebClientConfig.BuilderBase<?,?> builder)	Create an instance providing a builder.

Method Summary

Modifier and Type	Method	Description
WebClient	build()	Create a new runtime instance from this prototype.
boolean	equals(Object o)
WebClient	get()
int	hashCode()
List<ProtocolConfig>	protocolConfigs()	Configuration of client protocols.
List<String>	protocolPreference()	List of HTTP protocol IDs by order of preference.
String	toString()

Methods inherited from class HttpClientConfig.BuilderBase.HttpClientConfigImpl

altSvc, baseAddress, baseFragment, baseQuery, baseUri, connectionCacheSize, connectionListener, contentEncoding, cookieManager, defaultHeadersMap, dnsAddressLookup, dnsResolver, executor, filterRedirectHeaders, followCrossOriginEntityRedirects, headers, maxInMemoryEntity, mediaContext, mediaSupports, mediaTypeParserMode, readContinueTimeout, redirectSensitiveHeaders, relativeUris, sendExpectContinue, services, shareConnectionCache, sni, socketOptions, writeBufferSize

Modifier and Type	Method	Description
Optional<ClientAltSvcConfig>	altSvc()	Client policy for accepting and using HTTP Alt-Svc response advertisements.
Optional<SocketAddress>	baseAddress()	Base address used by the client in all requests.
Optional<UriFragment>	baseFragment()	Base fragment used by the client in all requests (unless overwritten on per-request basis).
Optional<UriQuery>	baseQuery()	Base query used by the client in all requests.
Optional<ClientUri>	baseUri()	Base uri used by the client in all requests.
int	connectionCacheSize()	Maximum number of reusable physical connections each HTTP protocol retains for a single connection target.
ConnectionListener	connectionListener()	Socket lifecycle callbacks.
ContentEncodingContext	contentEncoding()	Configure the listener specific ContentEncodingContext.
Optional<WebClientCookieManager>	cookieManager()	WebClient cookie manager.
Map<String,String>	defaultHeadersMap()	Default headers to be used in every request from configuration.
DnsAddressLookup	dnsAddressLookup()	DNS address lookup preferences to be used by this client.
DnsResolver	dnsResolver()	DNS resolver to be used by this client.
ExecutorService	executor()	Client executor service.
boolean	filterRedirectHeaders()	Whether headers sensitive to cross-origin redirects should be filtered before the redirected request is sent.
boolean	followCrossOriginEntityRedirects()	Whether redirects that preserve request method and entity may be followed across origins.
Set<Header>	headers()	Default headers to be used in every request.
int	maxInMemoryEntity()	If the entity is expected to be smaller that this number of bytes, it would be buffered in memory to optimize performance.
MediaContext	mediaContext()	Configure the listener specific MediaContext.
List<MediaSupport>	mediaSupports()	Media supports (manually added).
ParserMode	mediaTypeParserMode()	Configure media type parsing mode for HTTP Content-Type header.
Duration	readContinueTimeout()	Socket 100-Continue read timeout.
Set<HeaderName>	redirectSensitiveHeaders()	Request header names to strip on cross-origin redirects.
boolean	relativeUris()	Can be set to true to force the use of relative URIs in all requests, regardless of the presence or absence of proxies or no-proxy lists.
boolean	sendExpectContinue()	Whether Expect-100-Continue header is sent to verify server availability before sending an entity.
List<WebClientService>	services()	WebClient services.
boolean	shareConnectionCache()	Whether to use protocol-specific JVM-wide connection caches shared by compatible WebClient instances.
Optional<SniConfig>	sni()	Client-side TLS SNI configuration.
SocketOptions	socketOptions()	Socket options for connections opened by this client.
int	writeBufferSize()	Buffer size used when writing data to the underlying socket on a client TCP connection.

Methods inherited from class HttpConfigBase.BuilderBase.HttpConfigBaseImpl

connectTimeout, followRedirects, keepAlive, maxRedirects, properties, proxy, readTimeout, tls

Modifier and Type	Method	Description
Optional<Duration>	connectTimeout()	Connect timeout.
boolean	followRedirects()	Whether to follow redirects.
boolean	keepAlive()	Determines if connection keep alive is enabled (NOT socket keep alive, but HTTP connection keep alive, to re-use the same connection for multiple requests).
int	maxRedirects()	Max number of followed redirects.
Map<String,String>	properties()	Properties configured for this client.
Proxy	proxy()	Proxy configuration to be used for requests.
Optional<Duration>	readTimeout()	Read timeout.
Tls	tls()	TLS configuration for any TLS request from this client.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface HttpClientConfig

defaultRequestHeaders

Modifier and Type	Method	Description
default ClientRequestHeaders	defaultRequestHeaders()	Default headers as a headers object.

Constructor Details

WebClientConfigImpl

protected WebClientConfigImpl(WebClientConfig.BuilderBase<?,?> builder)

Create an instance providing a builder.

Parameters:

builder - extending builder base of this prototype

Method Details

build

public WebClient build()

Create a new runtime instance from this prototype.

Specified by:

build in interface Prototype.Factory<WebClient>

Returns:

new configured runtime instance

get

public WebClient get()

Specified by:

get in interface Supplier<WebClient>

protocolConfigs

public List<ProtocolConfig> protocolConfigs()

Description copied from interface: WebClientConfig

Configuration of client protocols.

Specified by:

protocolConfigs in interface WebClientConfig

Returns:

client protocol configurations

protocolPreference

public List<String> protocolPreference()

Description copied from interface: WebClientConfig

List of HTTP protocol IDs by order of preference. If left empty, all discovered providers will be used, ordered by weight.

For example if both HTTP/2 and HTTP/1.1 providers are available (considering HTTP/2 has higher weights), for ALPN we will send h2 and http/1.1 and decide based on response. If TLS is not used, we would attempt an upgrade (or use prior knowledge if configured in WebClientConfig.protocolConfigs()).

Specified by:

protocolPreference in interface WebClientConfig

Returns:

list of HTTP protocol IDs in order of preference

toString

public String toString()

Overrides:

toString in class HttpClientConfig.BuilderBase.HttpClientConfigImpl

equals

public boolean equals(Object o)

Overrides:

equals in class HttpClientConfig.BuilderBase.HttpClientConfigImpl

hashCode

public int hashCode()

Overrides:

hashCode in class HttpClientConfig.BuilderBase.HttpClientConfigImpl