com.hivemq.client.mqtt

Interface MqttClientSslConfigBuilderBase<B extends MqttClientSslConfigBuilderBase<B>>

Type Parameters:

B - the type of the builder.

All Known Subinterfaces:

MqttClientSslConfigBuilder, MqttClientSslConfigBuilder.Nested<P>

@DoNotImplement
public interface MqttClientSslConfigBuilderBase<B extends MqttClientSslConfigBuilderBase<B>>

Builder base for a MqttClientSslConfig.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
B	cipherSuites(@Nullable Collection<String> cipherSuites) Sets the optional user defined cipher suites.
B	handshakeTimeout(long timeout, @NotNull TimeUnit timeUnit) Sets the SSL/TLS handshake timeout.
B	hostnameVerifier(@Nullable HostnameVerifier hostnameVerifier) Sets the optional user defined hostname verifier.
B	keyManagerFactory(@Nullable KeyManagerFactory keyManagerFactory) Sets the optional user defined key manager factory.
B	protocols(@Nullable Collection<String> protocols) Sets the optional user defined protocols.
B	trustManagerFactory(@Nullable TrustManagerFactory trustManagerFactory) Sets the optional user defined trust manager factory.

Method Detail

keyManagerFactory

@CheckReturnValue
 @NotNull
B keyManagerFactory(@Nullable
                                                @Nullable KeyManagerFactory keyManagerFactory)

Sets the optional user defined key manager factory.

Parameters:

keyManagerFactory - the key manager factory or null to remove any previously set key manager factory.

Returns:

the builder.

trustManagerFactory

@CheckReturnValue
 @NotNull
B trustManagerFactory(@Nullable
                                                  @Nullable TrustManagerFactory trustManagerFactory)

Sets the optional user defined trust manager factory.

Parameters:

trustManagerFactory - the trust manager factory or null to remove any previously set trust manager factory

Returns:

the builder.

cipherSuites

@CheckReturnValue
 @NotNull
B cipherSuites(@Nullable
                                           @Nullable Collection<String> cipherSuites)

Sets the optional user defined cipher suites.

Parameters:

cipherSuites - the cipher suites or null to use the default cipher suites of Netty (network communication framework).

Returns:

the builder.

protocols

@CheckReturnValue
 @NotNull
B protocols(@Nullable
                                        @Nullable Collection<String> protocols)

Sets the optional user defined protocols.

Parameters:

protocols - the protocols or null to use the default protocols of Netty (network communication framework).

Returns:

the builder.

handshakeTimeout

@CheckReturnValue
 @NotNull
B handshakeTimeout(long timeout,
                                               @NotNull
                                               @NotNull TimeUnit timeUnit)

Sets the SSL/TLS handshake timeout.

The timeout in milliseconds must be in the range: [0, Integer.MAX_VALUE].

Parameters:

timeout - the SSL/TLS handshake timeout or 0 to disable the timeout.

timeUnit - the time unit of the given timeout (this timeout only supports millisecond precision).

Returns:

the builder.

hostnameVerifier

@CheckReturnValue
 @NotNull
B hostnameVerifier(@Nullable
                                               @Nullable HostnameVerifier hostnameVerifier)

Sets the optional user defined hostname verifier.

Parameters:

hostnameVerifier - the hostname verifier or null to use https hostname verification.

Returns:

the builder.

Since:

1.2