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 WebClientConfig.

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	addHeader(HeaderName name, int value)	Add a default header value.
BUILDER	addHeader(HeaderName name, long value)	Add a default header value.
BUILDER	addHeader(HeaderName name, String value)	Add a default header value.
BUILDER	addHeader(String name, int value)	Add default header value.
BUILDER	addHeader(String name, long value)	Add default header value.
BUILDER	addHeader(String name, String value)	Add default header value.
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.
BUILDER	baseUri(String baseUri)	Base URI of the client.
BUILDER	baseUri(URI baseUri)	Base URI of the client.
BUILDER	clearProtocolConfigs()	Clear all protocolConfigs.
BUILDER	clearProtocolPreference()	Clear all protocolPreference.
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.
boolean	protocolConfigsDiscoverServices()	Service discovery flag for protocolConfigs().
BUILDER	protocolConfigsDiscoverServices(boolean protocolConfigsDiscoverServices)	Service discovery flag for protocolConfigs().
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, addHeaders, addMediaSupport, addMediaSupports, addService, addServices, baseAddress, baseAddress, baseFragment, baseFragment, baseQuery, baseQuery, baseUri, baseUri, clearBaseAddress, clearBaseFragment, clearBaseQuery, clearBaseUri, clearCookieManager, clearHeaders, clearMediaSupports, clearServices, connectionCacheSize, connectionCacheSize, connectionListener, connectionListener, 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, servicesDiscoverServices, shareConnectionCache, shareConnectionCache, socketOptions, socketOptions, socketOptions, socketOptions, writeBufferSize, writeBufferSize

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

addProperties, clearConnectTimeout, clearReadTimeout, config, 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

baseUri

public BUILDER baseUri(URI baseUri)

Base URI of the client.

Overrides:

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

Parameters:

baseUri - base URI to use, query is extracted to base query (if any)

Returns:

updated builder instance

baseUri

public BUILDER baseUri(String baseUri)

Base URI of the client.

Overrides:

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

Parameters:

baseUri - base URI to use, query is extracted to base query (if any)

Returns:

updated builder instance

addHeader

public BUILDER addHeader(HeaderName name,
 String value)

Add a default header value.

Overrides:

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

Parameters:

name - name of the header

value - value of the header

Returns:

updated builder instance

addHeader

public BUILDER addHeader(HeaderName name,
 int value)

Add a default header value.

Overrides:

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

Parameters:

name - name of the header

value - value of the header

Returns:

updated builder instance

addHeader

public BUILDER addHeader(HeaderName name,
 long value)

Add a default header value.

Overrides:

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

Parameters:

name - name of the header

value - value of the header

Returns:

updated builder instance

addHeader

public BUILDER addHeader(String name,
 String value)

Add default header value. This method is not optimal and should only be used when the header name is really obtained from a string, in other cases, use an alternative with HeaderName or Header.

Overrides:

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

Parameters:

name - name of the header

value - value of the header

Returns:

updated builder instance

addHeader

public BUILDER addHeader(String name,
 int value)

Add default header value. This method is not optimal and should only be used when the header name is really obtained from a string, in other cases, use an alternative with HeaderName or Header.

Overrides:

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

Parameters:

name - name of the header

value - value of the header

Returns:

updated builder instance

addHeader

public BUILDER addHeader(String name,
 long value)

Add default header value. This method is not optimal and should only be used when the header name is really obtained from a string, in other cases, use an alternative with HeaderName or Header.

Overrides:

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

Parameters:

name - name of the header

value - value of the header

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

clearProtocolConfigs

public BUILDER clearProtocolConfigs()

Clear all protocolConfigs.

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 - add single client protocol configurations

Returns:

updated builder instance

See Also:

• protocolConfigs()

clearProtocolPreference

public BUILDER clearProtocolPreference()

Clear all protocolPreference.

Returns:

updated builder instance

See Also:

• protocolPreference()

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 - add single list of HTTP protocol IDs in order of preference

Returns:

updated builder instance

See Also:

• protocolPreference()

protocolConfigsDiscoverServices

public BUILDER protocolConfigsDiscoverServices(boolean protocolConfigsDiscoverServices)

Service discovery flag for protocolConfigs(). If set to true, services will be discovered from Java service loader, or Helidon ServiceRegistry.

Parameters:

protocolConfigsDiscoverServices - whether to enable automatic service discovery

Returns:

updated builder instance

See Also:

• protocolConfigsDiscoverServices()

protocolConfigs

public List<ProtocolConfig> protocolConfigs()

Configuration of client protocols.

Returns:

client protocol configurations

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:

list of HTTP protocol IDs in order of preference

protocolConfigsDiscoverServices

public boolean protocolConfigsDiscoverServices()

Service discovery flag for protocolConfigs(). If set to true, services will be discovered from Java service loader, or Helidon ServiceRegistry.

Returns:

whether to enable automatic service discovery

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>