Module io.helidon.nima.common.tls

Package io.helidon.nima.common.tls

Class Tls

java.lang.Object

io.helidon.nima.common.tls.Tls

public abstract sealed class Tls
extends Object

TLS configuration - common for server and client.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Tls.Builder	Fluent API builder for Tls.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ENDPOINT_IDENTIFICATION_HTTPS	HTTPS endpoint identification algorithm, verifies certificate cn against host name.
static final String	ENDPOINT_IDENTIFICATION_NONE	Disable host name verification.

Method Summary

Modifier and Type	Method	Description
static Tls.Builder	builder()	A new fluent API builder.
static Tls	create(Config config)	Create TLS configuration from config.
SSLServerSocket	createServerSocket()	Create a TLS socket for a server.
SSLSocket	createSocket(String alpnProtocol)	Create a socket for the chosen protocol.
boolean	enabled()	Whether this TLS configuration is enabled or not.
boolean	equals(Object o)
int	hashCode()
final SSLEngine	newEngine()	SSL engine from this configuration.
void	reload(Tls tls)	Reload reloadable TLS components with the new configuration.
SSLContext	sslContext()	SSL context based on the configured values.
SSLParameters	sslParameters()	SSL parameters.

Methods inherited from class java.lang.Object

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

Field Details

ENDPOINT_IDENTIFICATION_HTTPS

public static final String ENDPOINT_IDENTIFICATION_HTTPS

HTTPS endpoint identification algorithm, verifies certificate cn against host name.

See Also:

• Tls.Builder.endpointIdentificationAlgorithm(String)
• Constant Field Values

ENDPOINT_IDENTIFICATION_NONE

public static final String ENDPOINT_IDENTIFICATION_NONE

Disable host name verification.

See Also:

• Tls.Builder.endpointIdentificationAlgorithm(String)
• Constant Field Values

Method Details

builder

public static Tls.Builder builder()

A new fluent API builder.

Returns:

builder

create

public static Tls create(Config config)

Create TLS configuration from config.

Parameters:

config - located on the node of the tls configuration (usually this is ssl)

Returns:

a new TLS configuration

newEngine

public final SSLEngine newEngine()

SSL engine from this configuration.

Returns:

SSL Engine

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

createServerSocket

public SSLServerSocket createServerSocket()

Create a TLS socket for a server.

Returns:

a new server socket ready for TLS communication

createSocket

public SSLSocket createSocket(String alpnProtocol)

Create a socket for the chosen protocol.

Parameters:

alpnProtocol - protocol to use

Returns:

a new socket ready for TLS communication

sslContext

public SSLContext sslContext()

SSL context based on the configured values.

Returns:

SSL context

sslParameters

public SSLParameters sslParameters()

SSL parameters.

Returns:

SSL parameters

reload

public void reload(Tls tls)

Reload reloadable TLS components with the new configuration.

Parameters:

tls - new TLS configuration

enabled

public boolean enabled()

Whether this TLS configuration is enabled or not.

Returns:

whether TLS is enabled