Module io.helidon.webclient.websocket

Package io.helidon.webclient.websocket

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

java.lang.Object

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

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

io.helidon.webclient.websocket.WsClientConfig.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>, Prototype.ConfiguredBuilder<BUILDER,PROTOTYPE>

Direct Known Subclasses:

WsClientConfig.Builder

Enclosing interface:

WsClientConfig

public abstract static class WsClientConfig.BuilderBase<BUILDER extends WsClientConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends WsClientConfig>
extends HttpClientConfig.BuilderBase<BUILDER,PROTOTYPE>
implements Prototype.ConfiguredBuilder<BUILDER,PROTOTYPE>

Fluent API builder base for WsClient.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	WsClientConfig.BuilderBase.WsClientConfigImpl	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
Optional<Config>	config()	If this instance was configured, this would be the config instance used.
BUILDER	config(Config config)	Update builder from configuration (node of this type).
BUILDER	from(WsClientConfig prototype)	Update this builder from an existing prototype instance.
BUILDER	from(WsClientConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
protected void	preBuildPrototype()	Handles providers and decorators.
WsClientProtocolConfig	protocolConfig()	WebSocket specific configuration.
BUILDER	protocolConfig(WsClientProtocolConfig protocolConfig)	WebSocket specific configuration.
BUILDER	protocolConfig(Consumer<WsClientProtocolConfig.Builder> consumer)	WebSocket specific configuration.
BUILDER	protocolConfig(Supplier<? extends WsClientProtocolConfig> supplier)	WebSocket specific configuration.
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

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

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

discoverService, discoverServices

Constructor Details

BuilderBase

protected BuilderBase()

Protected to support extensibility.

Method Details

from

public BUILDER from(WsClientConfig 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(WsClientConfig.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

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 Prototype.ConfiguredBuilder<BUILDER extends WsClientConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends WsClientConfig>

Overrides:

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

Parameters:

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

Returns:

updated builder instance

protocolConfig

public BUILDER protocolConfig(WsClientProtocolConfig protocolConfig)

WebSocket specific configuration.

Parameters:

protocolConfig - protocol specific configuration

Returns:

updated builder instance

See Also:

• protocolConfig()

protocolConfig

public BUILDER protocolConfig(Consumer<WsClientProtocolConfig.Builder> consumer)

WebSocket specific configuration.

Parameters:

consumer - consumer of builder for protocol specific configuration

Returns:

updated builder instance

See Also:

• protocolConfig()

protocolConfig

public BUILDER protocolConfig(Supplier<? extends WsClientProtocolConfig> supplier)

WebSocket specific configuration.

Parameters:

supplier - supplier of protocol specific configuration

Returns:

updated builder instance

See Also:

• protocolConfig()

protocolConfig

public WsClientProtocolConfig protocolConfig()

WebSocket specific configuration.

Returns:

the protocol config

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 WsClientConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends WsClientConfig>

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 WsClientConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends WsClientConfig>

preBuildPrototype

protected void preBuildPrototype()

Handles providers and decorators.

Overrides:

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

validatePrototype

protected void validatePrototype()

Validates required properties.

Overrides:

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