Package com.hivemq.client.mqtt

Interface MqttClientSslConfig

@DoNotImplement
public interface MqttClientSslConfig

Configuration for a secure transport to use by MQTT clients.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field	Description
static final long	DEFAULT_HANDSHAKE_TIMEOUT_MS	The default SSL/TLS handshake timeout in milliseconds.

Method Summary

Modifier and Type	Method	Description
static @NotNull MqttClientSslConfigBuilder	builder()	Creates a builder for a secure transport configuration.
@NotNull MqttClientSslConfigBuilder	extend()	Creates a builder for extending this secure transport configuration.
@NotNull Optional<@Immutable List<@NotNull String>>	getCipherSuites()	The optional user defined cipher suites.
long	getHandshakeTimeoutMs()
@NotNull Optional<HostnameVerifier>	getHostnameVerifier()
@NotNull Optional<KeyManagerFactory>	getKeyManagerFactory()
@NotNull Optional<@Immutable List<@NotNull String>>	getProtocols()	The optional user defined protocols.
@NotNull Optional<TrustManagerFactory>	getTrustManagerFactory()

Field Details

DEFAULT_HANDSHAKE_TIMEOUT_MS

static final long DEFAULT_HANDSHAKE_TIMEOUT_MS

The default SSL/TLS handshake timeout in milliseconds.

See Also:

• Constant Field Values

Method Details

builder

@NotNull
static @NotNull MqttClientSslConfigBuilder builder()

Creates a builder for a secure transport configuration.

Returns:

the created builder for a secure transport configuration.

getKeyManagerFactory

@NotNull
@NotNull Optional<KeyManagerFactory> getKeyManagerFactory()

Returns:

the optional user defined KeyManagerFactory.

getTrustManagerFactory

@NotNull
@NotNull Optional<TrustManagerFactory> getTrustManagerFactory()

Returns:

the optional user defined TrustManagerFactory.

getCipherSuites

@NotNull
@NotNull Optional<@Immutable List<@NotNull String>> getCipherSuites()

The optional user defined cipher suites. If absent, the default cipher suites of Netty (network communication framework) will be used.

Returns:

the optional user defined cipher suites.

getProtocols

@NotNull
@NotNull Optional<@Immutable List<@NotNull String>> getProtocols()

The optional user defined protocols. If absent, the default protocols of Netty (network communication framework) will be used.

Returns:

the optional user defined protocols.

getHandshakeTimeoutMs

long getHandshakeTimeoutMs()

Returns:

the SSL/TLS handshake timeout in milliseconds.

getHostnameVerifier

@NotNull
@NotNull Optional<HostnameVerifier> getHostnameVerifier()

Returns:

the optional user defined hostname verifier. If absent, https hostname verification is performed.

Since:

1.2

extend

@NotNull
@NotNull MqttClientSslConfigBuilder extend()

Creates a builder for extending this secure transport configuration.

Returns:

the created builder.

Since:

1.1