Class TlsConfig.Builder

java.lang.Object

io.helidon.common.tls.TlsMaterial.BuilderBase<TlsConfig.Builder, TlsConfig>

io.helidon.common.tls.TlsConfig.BuilderBase<TlsConfig.Builder, TlsConfig>

io.helidon.common.tls.TlsConfig.Builder

All Implemented Interfaces:

Prototype.Builder<TlsConfig.Builder, TlsConfig>, Builder<TlsConfig.Builder, Tls>, ConfigBuilderSupport.ConfiguredBuilder<TlsConfig.Builder, TlsConfig>, Supplier<Tls>

Enclosing interface:

TlsConfig

public static class TlsConfig.Builder
extends TlsConfig.BuilderBase<TlsConfig.Builder, TlsConfig>
implements Builder<TlsConfig.Builder, Tls>

Fluent API builder for Tls.

Nested Class Summary

Nested classes/interfaces inherited from class TlsConfig.BuilderBase

TlsConfig.BuilderBase.TlsConfigImpl

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

Nested classes/interfaces inherited from class TlsMaterial.BuilderBase

TlsMaterial.BuilderBase.TlsMaterialImpl

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

Method Summary

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

Methods inherited from class TlsConfig.BuilderBase

addApplicationProtocol, addApplicationProtocols, addEnabledCipherSuite, addEnabledCipherSuites, addEnabledProtocol, addEnabledProtocols, applicationProtocols, applicationProtocols, clearApplicationProtocols, clearEnabledCipherSuites, clearEnabledProtocols, clearProvider, clearSslContext, clearSslParameters, clientAuth, clientAuth, config, enabled, enabled, enabledCipherSuites, enabledCipherSuites, enabledProtocols, enabledProtocols, endpointIdentificationAlgorithm, endpointIdentificationAlgorithm, from, from, manager, manager, managerDiscoverServices, managerDiscoverServices, preBuildPrototype, protocol, protocol, provider, provider, sessionCacheSize, sessionCacheSize, sessionTimeout, sessionTimeout, sslContext, sslContext, sslParameters, sslParameters, toString, validatePrototype

Modifier and Type	Method	Description
TlsConfig.Builder	addApplicationProtocol(String applicationProtocol)	Configure list of supported application protocols (such as h2) for application layer protocol negotiation (ALPN).
TlsConfig.Builder	addApplicationProtocols(List<String> applicationProtocols)	Configure list of supported application protocols (such as h2) for application layer protocol negotiation (ALPN).
TlsConfig.Builder	addEnabledCipherSuite(String enabledCipherSuite)	Enabled cipher suites for TLS communication.
TlsConfig.Builder	addEnabledCipherSuites(List<String> enabledCipherSuites)	Enabled cipher suites for TLS communication.
TlsConfig.Builder	addEnabledProtocol(String enabledProtocol)	Enabled protocols for TLS communication.
TlsConfig.Builder	addEnabledProtocols(List<String> enabledProtocols)	Enabled protocols for TLS communication.
List<String>	applicationProtocols()	Configure list of supported application protocols (such as h2) for application layer protocol negotiation (ALPN).
TlsConfig.Builder	applicationProtocols(List<String> applicationProtocols)	Configure list of supported application protocols (such as h2) for application layer protocol negotiation (ALPN).
TlsConfig.Builder	clearApplicationProtocols()	Clear all applicationProtocols.
TlsConfig.Builder	clearEnabledCipherSuites()	Clear all enabledCipherSuites.
TlsConfig.Builder	clearEnabledProtocols()	Clear all enabledProtocols.
TlsConfig.Builder	clearProvider()	Clear existing value of provider.
TlsConfig.Builder	clearSslContext()	Clear existing value of sslContext.
TlsConfig.Builder	clearSslParameters()	Clear existing value of sslParameters.
TlsClientAuth	clientAuth()	Configure requirement for mutual TLS.
TlsConfig.Builder	clientAuth(TlsClientAuth clientAuth)	Configure requirement for mutual TLS.
TlsConfig.Builder	config(Config config)	Update builder from configuration (node of this type).
boolean	enabled()	Flag indicating whether Tls is enabled.
TlsConfig.Builder	enabled(boolean enabled)	Flag indicating whether Tls is enabled.
List<String>	enabledCipherSuites()	Enabled cipher suites for TLS communication.
TlsConfig.Builder	enabledCipherSuites(List<String> enabledCipherSuites)	Enabled cipher suites for TLS communication.
List<String>	enabledProtocols()	Enabled protocols for TLS communication.
TlsConfig.Builder	enabledProtocols(List<String> enabledProtocols)	Enabled protocols for TLS communication.
String	endpointIdentificationAlgorithm()	Identification algorithm for SSL endpoints.
TlsConfig.Builder	endpointIdentificationAlgorithm(String endpointIdentificationAlgorithm)	Identification algorithm for SSL endpoints.
TlsConfig.Builder	from(TlsConfig prototype)	Update this builder from an existing prototype instance.
TlsConfig.Builder	from(TlsConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
Optional<TlsManager>	manager()	The configured TLS manager.
TlsConfig.Builder	manager(TlsManager manager)	The configured TLS manager.
boolean	managerDiscoverServices()	Service discovery flag for TlsConfig.BuilderBase.manager().
TlsConfig.Builder	managerDiscoverServices(boolean managerDiscoverServices)	Service discovery flag for TlsConfig.BuilderBase.manager().
protected void	preBuildPrototype()	Handles providers and decorators.
String	protocol()	Configure the protocol used to obtain an instance of SSLContext.
TlsConfig.Builder	protocol(String protocol)	Configure the protocol used to obtain an instance of SSLContext.
Optional<String>	provider()	Use explicit provider to obtain an instance of SSLContext.
TlsConfig.Builder	provider(String provider)	Use explicit provider to obtain an instance of SSLContext.
int	sessionCacheSize()	SSL session cache size.
TlsConfig.Builder	sessionCacheSize(int sessionCacheSize)	SSL session cache size.
Duration	sessionTimeout()	SSL session timeout.
TlsConfig.Builder	sessionTimeout(Duration sessionTimeout)	SSL session timeout.
Optional<SSLContext>	sslContext()	Provide a fully configured SSLContext.
TlsConfig.Builder	sslContext(SSLContext sslContext)	Provide a fully configured SSLContext.
Optional<SSLParameters>	sslParameters()	Configure SSL parameters.
TlsConfig.Builder	sslParameters(SSLParameters sslParameters)	Configure SSL parameters.
String	toString()
protected void	validatePrototype()	Validates required properties.

Methods inherited from class TlsMaterial.BuilderBase

addPrivateKeyCertChain, addPrivateKeyCertChain, addTrust, addTrust, clearInternalKeystoreProvider, clearInternalKeystoreType, clearKeyManagerFactoryAlgorithm, clearKeyManagerFactoryProvider, clearPrivateKey, clearPrivateKeyCertChain, clearRevocation, clearSecureRandom, clearSecureRandomAlgorithm, clearSecureRandomProvider, clearTrust, clearTrustManagerFactoryAlgorithm, clearTrustManagerFactoryProvider, config, from, from, internalKeystoreProvider, internalKeystoreProvider, internalKeystoreType, internalKeystoreType, keyManagerFactoryAlgorithm, keyManagerFactoryAlgorithm, keyManagerFactoryProvider, keyManagerFactoryProvider, privateKey, privateKey, privateKey, privateKey, privateKeyCertChain, privateKeyCertChain, privateKeyCertChain, privateKeyCertChain, revocation, revocation, revocation, revocation, secureRandom, secureRandom, secureRandomAlgorithm, secureRandomAlgorithm, secureRandomProvider, secureRandomProvider, trust, trust, trust, trust, trustAll, trustAll, trustManagerFactoryAlgorithm, trustManagerFactoryAlgorithm, trustManagerFactoryProvider, trustManagerFactoryProvider

Modifier and Type	Method	Description
TlsConfig.Builder	addPrivateKeyCertChain(X509Certificate privateKeyCertChain)	Certificate chain of the private key.
TlsConfig.Builder	addPrivateKeyCertChain(List<? extends X509Certificate> privateKeyCertChain)	Certificate chain of the private key.
TlsConfig.Builder	addTrust(X509Certificate trust)	List of certificates that form the trust manager.
TlsConfig.Builder	addTrust(List<? extends X509Certificate> trust)	List of certificates that form the trust manager.
TlsConfig.Builder	clearInternalKeystoreProvider()	Clear existing value of internalKeystoreProvider.
TlsConfig.Builder	clearInternalKeystoreType()	Clear existing value of internalKeystoreType.
TlsConfig.Builder	clearKeyManagerFactoryAlgorithm()	Clear existing value of keyManagerFactoryAlgorithm.
TlsConfig.Builder	clearKeyManagerFactoryProvider()	Clear existing value of keyManagerFactoryProvider.
TlsConfig.Builder	clearPrivateKey()	Clear existing value of privateKey.
TlsConfig.Builder	clearPrivateKeyCertChain()	Clear all privateKeyCertChain.
TlsConfig.Builder	clearRevocation()	Clear existing value of revocation.
TlsConfig.Builder	clearSecureRandom()	Clear existing value of secureRandom.
TlsConfig.Builder	clearSecureRandomAlgorithm()	Clear existing value of secureRandomAlgorithm.
TlsConfig.Builder	clearSecureRandomProvider()	Clear existing value of secureRandomProvider.
TlsConfig.Builder	clearTrust()	Clear all trust.
TlsConfig.Builder	clearTrustManagerFactoryAlgorithm()	Clear existing value of trustManagerFactoryAlgorithm.
TlsConfig.Builder	clearTrustManagerFactoryProvider()	Clear existing value of trustManagerFactoryProvider.
protected Optional<Config>	config()	Configuration used to configure this instance.
TlsConfig.Builder	from(TlsMaterial prototype)	Update this builder from an existing prototype instance.
TlsConfig.Builder	from(TlsMaterial.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
Optional<String>	internalKeystoreProvider()	Provider of the key stores used internally to create a key and trust manager factories.
TlsConfig.Builder	internalKeystoreProvider(String internalKeystoreProvider)	Provider of the key stores used internally to create a key and trust manager factories.
Optional<String>	internalKeystoreType()	Type of the key stores used internally to create a key and trust manager factories.
TlsConfig.Builder	internalKeystoreType(String internalKeystoreType)	Type of the key stores used internally to create a key and trust manager factories.
Optional<String>	keyManagerFactoryAlgorithm()	Algorithm of the key manager factory used when private key is defined.
TlsConfig.Builder	keyManagerFactoryAlgorithm(String keyManagerFactoryAlgorithm)	Algorithm of the key manager factory used when private key is defined.
Optional<String>	keyManagerFactoryProvider()	Key manager factory provider.
TlsConfig.Builder	keyManagerFactoryProvider(String keyManagerFactoryProvider)	Key manager factory provider.
Optional<PrivateKey>	privateKey()	Private key to use.
TlsConfig.Builder	privateKey(Keys privateKey)	Private key to use.
TlsConfig.Builder	privateKey(PrivateKey privateKey)	Private key to use.
TlsConfig.Builder	privateKey(Consumer<Keys.Builder> consumer)	Private key to use.
List<X509Certificate>	privateKeyCertChain()	Certificate chain of the private key.
TlsConfig.Builder	privateKeyCertChain(Keys privateKeyCertChain)	Certificate chain of the private key.
TlsConfig.Builder	privateKeyCertChain(Consumer<Keys.Builder> consumer)	Certificate chain of the private key.
TlsConfig.Builder	privateKeyCertChain(List<? extends X509Certificate> privateKeyCertChain)	Certificate chain of the private key.
Optional<RevocationConfig>	revocation()	Certificate revocation check configuration.
TlsConfig.Builder	revocation(RevocationConfig revocation)	Certificate revocation check configuration.
TlsConfig.Builder	revocation(Consumer<RevocationConfig.Builder> consumer)	Certificate revocation check configuration.
TlsConfig.Builder	revocation(Supplier<? extends RevocationConfig> supplier)	Certificate revocation check configuration.
Optional<SecureRandom>	secureRandom()	Explicit secure random to use.
TlsConfig.Builder	secureRandom(SecureRandom secureRandom)	Explicit secure random to use.
Optional<String>	secureRandomAlgorithm()	Algorithm to use when creating a new secure random.
TlsConfig.Builder	secureRandomAlgorithm(String secureRandomAlgorithm)	Algorithm to use when creating a new secure random.
Optional<String>	secureRandomProvider()	Provider to use when creating a new secure random.
TlsConfig.Builder	secureRandomProvider(String secureRandomProvider)	Provider to use when creating a new secure random.
List<X509Certificate>	trust()	List of certificates that form the trust manager.
TlsConfig.Builder	trust(Keys trust)	List of certificates that form the trust manager.
TlsConfig.Builder	trust(Consumer<Keys.Builder> consumer)	List of certificates that form the trust manager.
TlsConfig.Builder	trust(List<? extends X509Certificate> trust)	List of certificates that form the trust manager.
boolean	trustAll()	Trust any certificate provided by the other side of communication.
TlsConfig.Builder	trustAll(boolean trustAll)	Trust any certificate provided by the other side of communication.
Optional<String>	trustManagerFactoryAlgorithm()	Trust manager factory algorithm.
TlsConfig.Builder	trustManagerFactoryAlgorithm(String trustManagerFactoryAlgorithm)	Trust manager factory algorithm.
Optional<String>	trustManagerFactoryProvider()	Trust manager factory provider to use.
TlsConfig.Builder	trustManagerFactoryProvider(String trustManagerFactoryProvider)	Trust manager factory provider to use.

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 Tls	get()
default TlsConfig.Builder	identity()	Instance of this builder as the correct type.
default TlsConfig.Builder	update(Consumer<TlsConfig.Builder> consumer)	Update the builder in a fluent API way.

Methods inherited from interface Prototype.Builder

self

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

Method Details

buildPrototype

public TlsConfig 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<TlsConfig.Builder, TlsConfig>

Returns:

an instance of the setup object created from this builder

build

public Tls 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<TlsConfig.Builder, Tls>

Returns:

instance of the built type