Module io.helidon.webserver

Package io.helidon.webserver

Class TlsConfig.Builder

java.lang.Object

io.helidon.webserver.TlsConfig.Builder

All Implemented Interfaces:

Builder<TlsConfig>, Supplier<TlsConfig>

Enclosing class:

TlsConfig

public static class TlsConfig.Builder
extends Object
implements Builder<TlsConfig>

Fluent API builder for TlsConfig.

Method Summary

Modifier and Type	Method	Description
TlsConfig	build()
TlsConfig.Builder	config(Config config)	Update this builder from configuration.
TlsConfig.Builder	enabled(boolean enabled)	Whether the TLS config should be enabled or not.
TlsConfig.Builder	enabledProtocols(String... protocols)	Configures the TLS protocols to enable with the server socket.
TlsConfig.Builder	enabledProtocols(Collection<String> protocols)	Configures the TLS protocols to enable with the server socket.
TlsConfig.Builder	privateKey(KeyConfig privateKeyConfig)	Configure private key to use for SSL context.
TlsConfig.Builder	privateKey(Supplier<KeyConfig> privateKeyConfigBuilder)	Configure private key to use for SSL context.
TlsConfig.Builder	sessionCacheSize(long sessionCacheSize)	Set the size of the cache used for storing SSL session objects.
TlsConfig.Builder	sessionTimeout(long timeout, TimeUnit unit)	Set the timeout for the cached SSL session objects.
TlsConfig.Builder	sessionTimeoutSeconds(long sessionTimeout)	Set the timeout for the cached SSL session objects, in seconds.
TlsConfig.Builder	sslContext(SSLContext context)	Configures a SSLContext to use with the server socket.
TlsConfig.Builder	trust(KeyConfig trustConfig)	Set the trust key configuration to be used to validate certificates.
TlsConfig.Builder	trust(Supplier<KeyConfig> trustConfigBuilder)	Set the trust key configuration to be used to validate certificates.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.helidon.common.Builder

get

Method Detail

build

public TlsConfig build()

Specified by:

build in interface Builder<TlsConfig>

config

public TlsConfig.Builder config(Config config)

Update this builder from configuration.

Parameters:

config - config on the node of SSL configuration

Returns:

this builder

sslContext

public TlsConfig.Builder sslContext(SSLContext context)

Configures a SSLContext to use with the server socket. If not null then the server enforces an SSL communication.

Parameters:

context - a SSL context to use

Returns:

this builder

enabledProtocols

public TlsConfig.Builder enabledProtocols(String... protocols)

Configures the TLS protocols to enable with the server socket.

Parameters:

protocols - protocols to enable, if empty, enables defaults

Returns:

this builder

Throws:

NullPointerException - in case the protocols is null

enabledProtocols

public TlsConfig.Builder enabledProtocols(Collection<String> protocols)

Configures the TLS protocols to enable with the server socket.

Parameters:

protocols - protocols to enable, if empty enables the default protocols

Returns:

this builder

Throws:

NullPointerException - in case the protocols is null

privateKey

public TlsConfig.Builder privateKey(KeyConfig privateKeyConfig)

Configure private key to use for SSL context.

Parameters:

privateKeyConfig - the required private key configuration parameter

Returns:

this builder

privateKey

public TlsConfig.Builder privateKey(Supplier<KeyConfig> privateKeyConfigBuilder)

Configure private key to use for SSL context.

Parameters:

privateKeyConfigBuilder - the required private key configuration parameter

Returns:

this builder

trust

public TlsConfig.Builder trust(KeyConfig trustConfig)

Set the trust key configuration to be used to validate certificates.

Parameters:

trustConfig - the trust configuration

Returns:

this builder

trust

public TlsConfig.Builder trust(Supplier<KeyConfig> trustConfigBuilder)

Set the trust key configuration to be used to validate certificates.

Parameters:

trustConfigBuilder - the trust configuration builder

Returns:

this builder

sessionCacheSize

public TlsConfig.Builder sessionCacheSize(long sessionCacheSize)

Set the size of the cache used for storing SSL session objects. 0 to use the default value.

Parameters:

sessionCacheSize - the session cache size

Returns:

this builder

sessionTimeoutSeconds

public TlsConfig.Builder sessionTimeoutSeconds(long sessionTimeout)

Set the timeout for the cached SSL session objects, in seconds. 0 to use the default value.

Parameters:

sessionTimeout - the session timeout

Returns:

this builder

sessionTimeout

public TlsConfig.Builder sessionTimeout(long timeout,
                                        TimeUnit unit)

Set the timeout for the cached SSL session objects. 0 to use the default value.

Parameters:

timeout - the session timeout amount

unit - the session timeout time unit

Returns:

this builder

enabled

public TlsConfig.Builder enabled(boolean enabled)

Whether the TLS config should be enabled or not.

Parameters:

enabled - configure to false to disable SSL context (and SSL support on the server)

Returns:

this builder