Module io.helidon.webclient.api

Package io.helidon.webclient.api

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

java.lang.Object

io.helidon.webclient.api.HttpConfigBase.BuilderBase<BUILDER,PROTOTYPE>

io.helidon.webclient.api.HttpClientConfig.BuilderBase<BUILDER,PROTOTYPE>

io.helidon.webclient.api.WebClientConfig.BuilderBase<BUILDER,PROTOTYPE>

Type Parameters:

BUILDER - type of the builder extending this abstract builder

PROTOTYPE - type of the prototype interface that would be built by Prototype.Builder.buildPrototype()

All Implemented Interfaces:

Prototype.Builder<BUILDER,PROTOTYPE>, ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>, ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>

Direct Known Subclasses:

WebClientConfig.Builder

Enclosing interface:

WebClientConfig

public abstract static class WebClientConfig.BuilderBase<BUILDER extends WebClientConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends WebClientConfig>
extends HttpClientConfig.BuilderBase<BUILDER,PROTOTYPE>
implements ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>

Fluent API builder base for WebClient.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	WebClientConfig.BuilderBase.WebClientConfigImpl	Generated implementation of the prototype, can be extended by descendant prototype implementations.

Nested classes/interfaces inherited from class io.helidon.webclient.api.HttpClientConfig.BuilderBase

HttpClientConfig.BuilderBase.HttpClientConfigImpl

Nested classes/interfaces inherited from class io.helidon.webclient.api.HttpConfigBase.BuilderBase

HttpConfigBase.BuilderBase.HttpConfigBaseImpl

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BuilderBase()	Protected to support extensibility.

Method Summary

Modifier and Type	Method	Description
BUILDER	addProtocolConfig(ProtocolConfig protocolConfig)	Configuration of client protocols.
BUILDER	addProtocolConfigs(List<? extends ProtocolConfig> protocolConfigs)	Configuration of client protocols.
BUILDER	addProtocolPreference(String protocolPreference)	List of HTTP protocol IDs by order of preference.
BUILDER	addProtocolPreference(List<String> protocolPreference)	List of HTTP protocol IDs by order of preference.
Optional<Config>	config()	If this instance was configured, this would be the config instance used.
BUILDER	config(Config config)	Deprecated. use config(io.helidon.config.Config)
BUILDER	config(Config config)	Update builder from configuration (node of this type).
BUILDER	from(WebClientConfig prototype)	Update this builder from an existing prototype instance.
BUILDER	from(WebClientConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
protected void	preBuildPrototype()	Handles providers and decorators.
List<ProtocolConfig>	protocolConfigs()	Configuration of client protocols.
BUILDER	protocolConfigs(List<? extends ProtocolConfig> protocolConfigs)	Configuration of client protocols.
BUILDER	protocolConfigsDiscoverServices(boolean discoverServices)	Configuration of client protocols.
List<String>	protocolPreference()	List of HTTP protocol IDs by order of preference.
BUILDER	protocolPreference(List<String> protocolPreference)	List of HTTP protocol IDs by order of preference.
String	toString()
protected void	validatePrototype()	Validates required properties.

Methods inherited from class io.helidon.webclient.api.HttpClientConfig.BuilderBase

addDefaultHeadersMap, addHeader, addHeader, addHeader, addHeader, addHeader, addHeader, addHeader, addHeaders, addMediaSupport, addMediaSupports, addService, addServices, baseFragment, baseFragment, baseQuery, baseQuery, baseUri, baseUri, baseUri, baseUri, baseUri, clearBaseFragment, clearBaseQuery, clearBaseUri, clearCookieManager, connectionCacheSize, connectionCacheSize, contentEncoding, contentEncoding, contentEncoding, contentEncoding, contentEncoding, cookieManager, cookieManager, cookieManager, cookieManager, defaultHeadersMap, defaultHeadersMap, dnsAddressLookup, dnsAddressLookup, dnsResolver, dnsResolver, executor, executor, from, from, headers, headers, maxInMemoryEntity, maxInMemoryEntity, mediaContext, mediaContext, mediaContext, mediaContext, mediaContext, mediaSupports, mediaSupports, mediaTypeParserMode, mediaTypeParserMode, readContinueTimeout, readContinueTimeout, relativeUris, relativeUris, sendExpectContinue, sendExpectContinue, services, services, servicesDiscoverServices, shareConnectionCache, shareConnectionCache, socketOptions, socketOptions, socketOptions, socketOptions, writeBufferSize, writeBufferSize

Methods inherited from class io.helidon.webclient.api.HttpConfigBase.BuilderBase

addProperties, clearConnectTimeout, clearReadTimeout, connectTimeout, connectTimeout, followRedirects, followRedirects, from, from, keepAlive, keepAlive, maxRedirects, maxRedirects, properties, properties, proxy, proxy, proxy, proxy, putProperty, readTimeout, readTimeout, tls, tls, tls, tls, tls

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.helidon.builder.api.Prototype.Builder

buildPrototype, self

Constructor Details

BuilderBase

protected BuilderBase()

Protected to support extensibility.

Method Details

from

public BUILDER from(WebClientConfig prototype)

Update this builder from an existing prototype instance. This method disables automatic service discovery.

Parameters:

prototype - existing prototype to update this builder from

Returns:

updated builder instance

from

public BUILDER from(WebClientConfig.BuilderBase<?,?> builder)

Update this builder from an existing prototype builder instance.

Parameters:

builder - existing builder prototype to update this builder from

Returns:

updated builder instance

config

@Deprecated
public BUILDER config(Config config)

Deprecated.

use config(io.helidon.config.Config)

Update builder from configuration (node of this type). If a value is present in configuration, it would override currently configured values.

Specified by:

config in interface ConfigBuilderSupport.ConfiguredBuilder<BUILDER extends WebClientConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends WebClientConfig>

Overrides:

config in class HttpClientConfig.BuilderBase<BUILDER extends WebClientConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends WebClientConfig>

Parameters:

config - configuration instance used to obtain values to update this builder

Returns:

updated builder instance

config

public BUILDER config(Config config)

Update builder from configuration (node of this type). If a value is present in configuration, it would override currently configured values.

Specified by:

config in interface ConfigBuilderSupport.ConfiguredBuilder<BUILDER extends WebClientConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends WebClientConfig>

Overrides:

config in class HttpClientConfig.BuilderBase<BUILDER extends WebClientConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends WebClientConfig>

Parameters:

config - configuration instance used to obtain values to update this builder

Returns:

updated builder instance

protocolConfigsDiscoverServices

public BUILDER protocolConfigsDiscoverServices(boolean discoverServices)

Configuration of client protocols.

Parameters:

discoverServices - whether to discover implementations through service loader

Returns:

updated builder instance

See Also:

• protocolConfigs()

protocolConfigs

public BUILDER protocolConfigs(List<? extends ProtocolConfig> protocolConfigs)

Configuration of client protocols.

Parameters:

protocolConfigs - client protocol configurations

Returns:

updated builder instance

See Also:

• protocolConfigs()

addProtocolConfigs

public BUILDER addProtocolConfigs(List<? extends ProtocolConfig> protocolConfigs)

Configuration of client protocols.

Parameters:

protocolConfigs - client protocol configurations

Returns:

updated builder instance

See Also:

• protocolConfigs()

addProtocolConfig

public BUILDER addProtocolConfig(ProtocolConfig protocolConfig)

Configuration of client protocols.

Parameters:

protocolConfig - client protocol configurations

Returns:

updated builder instance

See Also:

• protocolConfigs()

protocolPreference

public BUILDER protocolPreference(List<String> protocolPreference)

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 protocolConfigs()).

Parameters:

protocolPreference - list of HTTP protocol IDs in order of preference

Returns:

updated builder instance

See Also:

• protocolPreference()

addProtocolPreference

public BUILDER addProtocolPreference(List<String> protocolPreference)

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 protocolConfigs()).

Parameters:

protocolPreference - list of HTTP protocol IDs in order of preference

Returns:

updated builder instance

See Also:

• protocolPreference()

addProtocolPreference

public BUILDER addProtocolPreference(String protocolPreference)

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 protocolConfigs()).

Parameters:

protocolPreference - list of HTTP protocol IDs in order of preference

Returns:

updated builder instance

See Also:

• protocolPreference()

protocolConfigs

public List<ProtocolConfig> protocolConfigs()

Configuration of client protocols.

Returns:

the protocol configs

protocolPreference

public List<String> protocolPreference()

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 protocolConfigs()).

Returns:

the protocol preference

config

public Optional<Config> config()

If this instance was configured, this would be the config instance used.

Overrides:

config in class HttpClientConfig.BuilderBase<BUILDER extends WebClientConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends WebClientConfig>

Returns:

config node used to configure this builder, or empty if not configured

toString

public String toString()

Overrides:

toString in class HttpClientConfig.BuilderBase<BUILDER extends WebClientConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends WebClientConfig>

preBuildPrototype

protected void preBuildPrototype()

Handles providers and decorators.

Overrides:

preBuildPrototype in class HttpClientConfig.BuilderBase<BUILDER extends WebClientConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends WebClientConfig>

validatePrototype

protected void validatePrototype()

Validates required properties.

Overrides:

validatePrototype in class HttpClientConfig.BuilderBase<BUILDER extends WebClientConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends WebClientConfig>