Interface WsClientConfig

All Superinterfaces:

HttpClientConfig, HttpConfigBase, Prototype.Api, Prototype.Factory<WsClient>

All Known Implementing Classes:

WsClientConfig.BuilderBase.WsClientConfigImpl

public interface WsClientConfig
extends Prototype.Api, HttpClientConfig

WebSocket full webclient configuration. The client configuration also contains all necessary configuration for HTTP, as WebSocket upgrades from HTTP.

See Also:

• WebClient.client(io.helidon.webclient.spi.Protocol, io.helidon.webclient.spi.ProtocolConfig)
• builder()
• create()

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static WsClientConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static WsClientConfig.Builder	builder(WsClientConfig instance)	Create a new fluent API builder from an existing instance.
static WsClientConfig	create()	Create a new instance with default values.
static WsClientConfig	create(Config config)	Create a new instance from configuration.
WsClientProtocolConfig	protocolConfig()	WebSocket specific configuration.

Methods inherited from interface HttpClientConfig

altSvc, baseAddress, baseFragment, baseQuery, baseUri, connectionCacheSize, connectionListener, contentEncoding, cookieManager, defaultHeadersMap, defaultRequestHeaders, 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.
default ClientRequestHeaders	defaultRequestHeaders()	Default headers as a headers object.
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 interface HttpConfigBase

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 interface Prototype.Factory

build

Modifier and Type	Method	Description
WsClient	build()	Create a new instance of the runtime type from this config object.

Method Details

builder

static WsClientConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static WsClientConfig.Builder builder(WsClientConfig instance)

Create a new fluent API builder from an existing instance.

Parameters:

instance - an existing instance used as a base for the builder

Returns:

a builder based on an instance

create

static WsClientConfig create(Config config)

Create a new instance from configuration.

Parameters:

config - used to configure the new instance

Returns:

a new instance configured from configuration

create

static WsClientConfig create()

Create a new instance with default values.

Returns:

a new instance

protocolConfig

WsClientProtocolConfig protocolConfig()

WebSocket specific configuration.

Returns:

protocol specific configuration