Class WebClientConfig.Builder

java.lang.Object

io.helidon.webclient.api.HttpConfigBase.BuilderBase<WebClientConfig.Builder, WebClientConfig>

io.helidon.webclient.api.HttpClientConfig.BuilderBase<WebClientConfig.Builder, WebClientConfig>

io.helidon.webclient.api.WebClientConfig.BuilderBase<WebClientConfig.Builder, WebClientConfig>

io.helidon.webclient.api.WebClientConfig.Builder

All Implemented Interfaces:

Prototype.Builder<WebClientConfig.Builder, WebClientConfig>, Builder<WebClientConfig.Builder, WebClient>, ConfigBuilderSupport.ConfiguredBuilder<WebClientConfig.Builder, WebClientConfig>, Supplier<WebClient>

Enclosing interface:

WebClientConfig

public static class WebClientConfig.Builder
extends WebClientConfig.BuilderBase<WebClientConfig.Builder, WebClientConfig>
implements Builder<WebClientConfig.Builder, WebClient>

Fluent API builder for WebClient.

Nested Class Summary

Nested classes/interfaces inherited from class WebClientConfig.BuilderBase

WebClientConfig.BuilderBase.WebClientConfigImpl

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 HttpClientConfig.BuilderBase

HttpClientConfig.BuilderBase.HttpClientConfigImpl

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

Nested classes/interfaces inherited from class HttpConfigBase.BuilderBase

HttpConfigBase.BuilderBase.HttpConfigBaseImpl

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

Method Summary

Modifier and Type	Method	Description
WebClient	build()	Create an instance from this builder.
WebClientConfig	buildPrototype()	Create an instance of the prototype.

Methods inherited from class WebClientConfig.BuilderBase

addHeader, addHeader, addHeader, addHeader, addHeader, addHeader, addProtocolConfig, addProtocolConfigs, addProtocolPreference, addProtocolPreference, addRedirectSensitiveHeader, baseUri, baseUri, clearProtocolConfigs, clearProtocolPreference, config, from, from, preBuildPrototype, protocolConfigs, protocolConfigs, protocolConfigsDiscoverServices, protocolConfigsDiscoverServices, protocolPreference, protocolPreference, toString, validatePrototype

Modifier and Type	Method	Description
WebClientConfig.Builder	addHeader(HeaderName name, int value)	Add a default header value.
WebClientConfig.Builder	addHeader(HeaderName name, long value)	Add a default header value.
WebClientConfig.Builder	addHeader(HeaderName name, String value)	Add a default header value.
WebClientConfig.Builder	addHeader(String name, int value)	Add default header value.
WebClientConfig.Builder	addHeader(String name, long value)	Add default header value.
WebClientConfig.Builder	addHeader(String name, String value)	Add default header value.
WebClientConfig.Builder	addProtocolConfig(ProtocolConfig protocolConfig)	Configuration of client protocols.
WebClientConfig.Builder	addProtocolConfigs(List<? extends ProtocolConfig> protocolConfigs)	Configuration of client protocols.
WebClientConfig.Builder	addProtocolPreference(String protocolPreference)	List of HTTP protocol IDs by order of preference.
WebClientConfig.Builder	addProtocolPreference(List<String> protocolPreference)	List of HTTP protocol IDs by order of preference.
WebClientConfig.Builder	addRedirectSensitiveHeader(String headerName)	Add a header name to strip on cross-origin redirects.
WebClientConfig.Builder	baseUri(String baseUri)	Base URI of the client.
WebClientConfig.Builder	baseUri(URI baseUri)	Base URI of the client.
WebClientConfig.Builder	clearProtocolConfigs()	Clear all protocolConfigs.
WebClientConfig.Builder	clearProtocolPreference()	Clear all protocolPreference.
WebClientConfig.Builder	config(Config config)	Update builder from configuration (node of this type).
WebClientConfig.Builder	from(WebClientConfig prototype)	Update this builder from an existing prototype instance.
WebClientConfig.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.
WebClientConfig.Builder	protocolConfigs(List<? extends ProtocolConfig> protocolConfigs)	Configuration of client protocols.
boolean	protocolConfigsDiscoverServices()	Service discovery flag for WebClientConfig.BuilderBase.protocolConfigs().
WebClientConfig.Builder	protocolConfigsDiscoverServices(boolean protocolConfigsDiscoverServices)	Service discovery flag for WebClientConfig.BuilderBase.protocolConfigs().
List<String>	protocolPreference()	List of HTTP protocol IDs by order of preference.
WebClientConfig.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 HttpClientConfig.BuilderBase

addDefaultHeadersMap, addHeader, addHeaders, addMediaSupport, addMediaSupports, addRedirectSensitiveHeader, addRedirectSensitiveHeaders, addService, addServices, altSvc, altSvc, altSvc, altSvc, baseAddress, baseAddress, baseFragment, baseFragment, baseQuery, baseQuery, baseUri, baseUri, clearAltSvc, clearBaseAddress, clearBaseFragment, clearBaseQuery, clearBaseUri, clearCookieManager, clearHeaders, clearMediaSupports, clearRedirectSensitiveHeaders, clearServices, clearSni, connectionCacheSize, connectionCacheSize, connectionListener, connectionListener, contentEncoding, contentEncoding, contentEncoding, contentEncoding, contentEncoding, cookieManager, cookieManager, cookieManager, cookieManager, defaultHeadersMap, defaultHeadersMap, dnsAddressLookup, dnsAddressLookup, dnsResolver, dnsResolver, executor, executor, filterRedirectHeaders, filterRedirectHeaders, followCrossOriginEntityRedirects, followCrossOriginEntityRedirects, from, from, headers, headers, maxInMemoryEntity, maxInMemoryEntity, mediaContext, mediaContext, mediaContext, mediaContext, mediaContext, mediaSupports, mediaSupports, mediaTypeParserMode, mediaTypeParserMode, readContinueTimeout, readContinueTimeout, redirectSensitiveHeaders, redirectSensitiveHeaders, relativeUris, relativeUris, sendExpectContinue, sendExpectContinue, serviceRegistry, serviceRegistry, services, services, servicesDiscoverServices, servicesDiscoverServices, shareConnectionCache, shareConnectionCache, sni, sni, sni, sni, socketOptions, socketOptions, socketOptions, socketOptions, writeBufferSize, writeBufferSize

Modifier and Type	Method	Description
WebClientConfig.Builder	addDefaultHeadersMap(Map<String,String> defaultHeadersMap)	Default headers to be used in every request from configuration.
WebClientConfig.Builder	addHeader(Header header)	Default headers to be used in every request.
WebClientConfig.Builder	addHeaders(Set<? extends Header> headers)	Default headers to be used in every request.
WebClientConfig.Builder	addMediaSupport(MediaSupport mediaSupport)	Media supports (manually added).
WebClientConfig.Builder	addMediaSupports(List<? extends MediaSupport> mediaSupports)	Media supports (manually added).
WebClientConfig.Builder	addRedirectSensitiveHeader(HeaderName redirectSensitiveHeader)	Request header names to strip on cross-origin redirects.
WebClientConfig.Builder	addRedirectSensitiveHeaders(Set<? extends HeaderName> redirectSensitiveHeaders)	Request header names to strip on cross-origin redirects.
WebClientConfig.Builder	addService(WebClientService service)	WebClient services.
WebClientConfig.Builder	addServices(List<? extends WebClientService> services)	WebClient services.
Optional<ClientAltSvcConfig>	altSvc()	Client policy for accepting and using HTTP Alt-Svc response advertisements.
WebClientConfig.Builder	altSvc(ClientAltSvcConfig altSvc)	Client policy for accepting and using HTTP Alt-Svc response advertisements.
WebClientConfig.Builder	altSvc(Consumer<ClientAltSvcConfig.Builder> consumer)	Client policy for accepting and using HTTP Alt-Svc response advertisements.
WebClientConfig.Builder	altSvc(Supplier<? extends ClientAltSvcConfig> supplier)	Client policy for accepting and using HTTP Alt-Svc response advertisements.
Optional<SocketAddress>	baseAddress()	Base address used by the client in all requests.
WebClientConfig.Builder	baseAddress(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).
WebClientConfig.Builder	baseFragment(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.
WebClientConfig.Builder	baseQuery(UriQuery baseQuery)	Base query used by the client in all requests.
Optional<ClientUri>	baseUri()	Base uri used by the client in all requests.
WebClientConfig.Builder	baseUri(ClientUri baseUri)	Base uri used by the client in all requests.
WebClientConfig.Builder	clearAltSvc()	Clear existing value of altSvc.
WebClientConfig.Builder	clearBaseAddress()	Clear existing value of baseAddress.
WebClientConfig.Builder	clearBaseFragment()	Clear existing value of baseFragment.
WebClientConfig.Builder	clearBaseQuery()	Clear existing value of baseQuery.
WebClientConfig.Builder	clearBaseUri()	Clear existing value of baseUri.
WebClientConfig.Builder	clearCookieManager()	Clear existing value of cookieManager.
WebClientConfig.Builder	clearHeaders()	Clear all headers.
WebClientConfig.Builder	clearMediaSupports()	Clear all mediaSupports.
WebClientConfig.Builder	clearRedirectSensitiveHeaders()	Clear all redirectSensitiveHeaders.
WebClientConfig.Builder	clearServices()	Clear all services.
WebClientConfig.Builder	clearSni()	Clear existing value of sni.
int	connectionCacheSize()	Maximum number of reusable physical connections each HTTP protocol retains for a single connection target.
WebClientConfig.Builder	connectionCacheSize(int connectionCacheSize)	Maximum number of reusable physical connections each HTTP protocol retains for a single connection target.
ConnectionListener	connectionListener()	Socket lifecycle callbacks.
WebClientConfig.Builder	connectionListener(ConnectionListener connectionListener)	Socket lifecycle callbacks.
Optional<ContentEncodingContext>	contentEncoding()	Configure the listener specific ContentEncodingContext.
WebClientConfig.Builder	contentEncoding(ContentEncodingContext contentEncoding)	Configure the listener specific ContentEncodingContext.
WebClientConfig.Builder	contentEncoding(ContentEncodingContextConfig contentEncoding)	Configure the listener specific ContentEncodingContext.
WebClientConfig.Builder	contentEncoding(Consumer<ContentEncodingContextConfig.Builder> consumer)	Configure the listener specific ContentEncodingContext.
WebClientConfig.Builder	contentEncoding(Supplier<? extends ContentEncodingContext> supplier)	Configure the listener specific ContentEncodingContext.
Optional<WebClientCookieManager>	cookieManager()	WebClient cookie manager.
WebClientConfig.Builder	cookieManager(WebClientCookieManager cookieManager)	WebClient cookie manager.
WebClientConfig.Builder	cookieManager(WebClientCookieManagerConfig cookieManager)	WebClient cookie manager.
WebClientConfig.Builder	cookieManager(Consumer<WebClientCookieManagerConfig.Builder> consumer)	WebClient cookie manager.
Map<String,String>	defaultHeadersMap()	Default headers to be used in every request from configuration.
WebClientConfig.Builder	defaultHeadersMap(Map<String,String> defaultHeadersMap)	Default headers to be used in every request from configuration.
Optional<DnsAddressLookup>	dnsAddressLookup()	DNS address lookup preferences to be used by this client.
WebClientConfig.Builder	dnsAddressLookup(DnsAddressLookup dnsAddressLookup)	DNS address lookup preferences to be used by this client.
Optional<DnsResolver>	dnsResolver()	DNS resolver to be used by this client.
WebClientConfig.Builder	dnsResolver(DnsResolver dnsResolver)	DNS resolver to be used by this client.
Optional<ExecutorService>	executor()	Client executor service.
WebClientConfig.Builder	executor(ExecutorService executor)	Client executor service.
boolean	filterRedirectHeaders()	Whether headers sensitive to cross-origin redirects should be filtered before the redirected request is sent.
WebClientConfig.Builder	filterRedirectHeaders(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.
WebClientConfig.Builder	followCrossOriginEntityRedirects(boolean followCrossOriginEntityRedirects)	Whether redirects that preserve request method and entity may be followed across origins.
WebClientConfig.Builder	from(HttpClientConfig prototype)	Update this builder from an existing prototype instance.
WebClientConfig.Builder	from(HttpClientConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
Set<Header>	headers()	Default headers to be used in every request.
WebClientConfig.Builder	headers(Set<? extends 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.
WebClientConfig.Builder	maxInMemoryEntity(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.
WebClientConfig.Builder	mediaContext(MediaContext mediaContext)	Configure the listener specific MediaContext.
WebClientConfig.Builder	mediaContext(MediaContextConfig mediaContext)	Configure the listener specific MediaContext.
WebClientConfig.Builder	mediaContext(Consumer<MediaContextConfig.Builder> consumer)	Configure the listener specific MediaContext.
WebClientConfig.Builder	mediaContext(Supplier<? extends MediaContext> supplier)	Configure the listener specific MediaContext.
List<MediaSupport>	mediaSupports()	Media supports (manually added).
WebClientConfig.Builder	mediaSupports(List<? extends MediaSupport> mediaSupports)	Media supports (manually added).
ParserMode	mediaTypeParserMode()	Configure media type parsing mode for HTTP Content-Type header.
WebClientConfig.Builder	mediaTypeParserMode(ParserMode mediaTypeParserMode)	Configure media type parsing mode for HTTP Content-Type header.
Duration	readContinueTimeout()	Socket 100-Continue read timeout.
WebClientConfig.Builder	readContinueTimeout(Duration readContinueTimeout)	Socket 100-Continue read timeout.
Set<HeaderName>	redirectSensitiveHeaders()	Request header names to strip on cross-origin redirects.
WebClientConfig.Builder	redirectSensitiveHeaders(Set<? extends 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.
WebClientConfig.Builder	relativeUris(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.
WebClientConfig.Builder	sendExpectContinue(boolean sendExpectContinue)	Whether Expect-100-Continue header is sent to verify server availability before sending an entity.
Optional<ServiceRegistry>	serviceRegistry()	Service registry used to discover providers and services.
WebClientConfig.Builder	serviceRegistry(ServiceRegistry serviceRegistry)	Service registry used to discover providers and services.
List<WebClientService>	services()	WebClient services.
WebClientConfig.Builder	services(List<? extends WebClientService> services)	WebClient services.
boolean	servicesDiscoverServices()	Service discovery flag for HttpClientConfig.BuilderBase.services().
WebClientConfig.Builder	servicesDiscoverServices(boolean servicesDiscoverServices)	Service discovery flag for HttpClientConfig.BuilderBase.services().
boolean	shareConnectionCache()	Whether to use protocol-specific JVM-wide connection caches shared by compatible WebClient instances.
WebClientConfig.Builder	shareConnectionCache(boolean shareConnectionCache)	Whether to use protocol-specific JVM-wide connection caches shared by compatible WebClient instances.
Optional<SniConfig>	sni()	Client-side TLS SNI configuration.
WebClientConfig.Builder	sni(SniConfig sni)	Client-side TLS SNI configuration.
WebClientConfig.Builder	sni(Consumer<SniConfig.Builder> consumer)	Client-side TLS SNI configuration.
WebClientConfig.Builder	sni(Supplier<? extends SniConfig> supplier)	Client-side TLS SNI configuration.
Optional<SocketOptions>	socketOptions()	Socket options for connections opened by this client.
WebClientConfig.Builder	socketOptions(SocketOptions socketOptions)	Socket options for connections opened by this client.
WebClientConfig.Builder	socketOptions(Consumer<SocketOptions.Builder> consumer)	Socket options for connections opened by this client.
WebClientConfig.Builder	socketOptions(Supplier<? extends SocketOptions> supplier)	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.
WebClientConfig.Builder	writeBufferSize(int writeBufferSize)	Buffer size used when writing data to the underlying socket on a client TCP connection.

Methods inherited from class 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

Modifier and Type	Method	Description
WebClientConfig.Builder	addProperties(Map<String,String> properties)	Properties configured for this client.
WebClientConfig.Builder	clearConnectTimeout()	Clear existing value of connectTimeout.
WebClientConfig.Builder	clearReadTimeout()	Clear existing value of readTimeout.
protected Optional<Config>	config()	Configuration used to configure this instance.
Optional<Duration>	connectTimeout()	Connect timeout.
WebClientConfig.Builder	connectTimeout(Duration connectTimeout)	Connect timeout.
boolean	followRedirects()	Whether to follow redirects.
WebClientConfig.Builder	followRedirects(boolean followRedirects)	Whether to follow redirects.
WebClientConfig.Builder	from(HttpConfigBase prototype)	Update this builder from an existing prototype instance.
WebClientConfig.Builder	from(HttpConfigBase.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
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).
WebClientConfig.Builder	keepAlive(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.
WebClientConfig.Builder	maxRedirects(int maxRedirects)	Max number of followed redirects.
Map<String,String>	properties()	Properties configured for this client.
WebClientConfig.Builder	properties(Map<String,String> properties)	Properties configured for this client.
Optional<Proxy>	proxy()	Proxy configuration to be used for requests.
WebClientConfig.Builder	proxy(Proxy proxy)	Proxy configuration to be used for requests.
WebClientConfig.Builder	proxy(Consumer<Proxy.Builder> consumer)	Proxy configuration to be used for requests.
WebClientConfig.Builder	proxy(Supplier<? extends Proxy> supplier)	Proxy configuration to be used for requests.
WebClientConfig.Builder	putProperty(String key, String property)	Properties configured for this client.
Optional<Duration>	readTimeout()	Read timeout.
WebClientConfig.Builder	readTimeout(Duration readTimeout)	Read timeout.
Optional<Tls>	tls()	TLS configuration for any TLS request from this client.
WebClientConfig.Builder	tls(Tls tls)	TLS configuration for any TLS request from this client.
WebClientConfig.Builder	tls(TlsConfig tls)	TLS configuration for any TLS request from this client.
WebClientConfig.Builder	tls(Consumer<TlsConfig.Builder> consumer)	TLS configuration for any TLS request from this client.
WebClientConfig.Builder	tls(Supplier<? extends Tls> supplier)	TLS configuration for any TLS request from this client.

Methods inherited from class Object

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

Methods inherited from interface Builder

get, identity, update

Modifier and Type	Method	Description
default WebClient	get()
default WebClientConfig.Builder	identity()	Instance of this builder as the correct type.
default WebClientConfig.Builder	update(Consumer<WebClientConfig.Builder> consumer)	Update the builder in a fluent API way.

Methods inherited from interface Prototype.Builder

self

Modifier and Type	Method	Description
default WebClientConfig.Builder	self()	Instance of this builder as the correct type.

Method Details

buildPrototype

public WebClientConfig buildPrototype()

Create an instance of the prototype. Calling this method may update this builder from providers and decorators, so repeated calls may have side effects.

Specified by:

buildPrototype in interface Prototype.Builder<WebClientConfig.Builder, WebClientConfig>

Returns:

an instance of the setup object created from this builder

build

public WebClient build()

Create an instance from this builder. Calling this method may update this builder from providers and decorators, so repeated calls may have side effects.

Specified by:

build in interface Builder<WebClientConfig.Builder, WebClient>

Returns:

instance of the built type