Package com.hivemq.swarm.extension.sdk.security

Interface SecurityProviderOutput

public interface SecurityProviderOutput

Since:

4.6.0

Method Summary

Modifier and Type	Method	Description
@NotNull SecurityProviderOutput	cipherSuites(@Nullable Collection<String> cipherSuites)	Sets the optional user defined cipher suites.
@NotNull SecurityProviderOutput	handshakeTimeout(long handshakeTimeout, @NotNull TimeUnit timeUnit)	Sets the SSL/TLS handshake timeout.
@NotNull SecurityProviderOutput	hostnameVerifier(@Nullable HostnameVerifier hostnameVerifier)	Sets the optional user defined hostname verifier.
@NotNull SecurityProviderOutput	keyManagerFactory(@Nullable KeyManagerFactory keyManagerFactory)	Sets the optional user defined KeyManagerFactory.
@NotNull SecurityProviderOutput	protocols(@Nullable Collection<String> protocols)	Sets the optional user defined protocols.
@NotNull SecurityProviderOutput	trustManagerFactory(@Nullable TrustManagerFactory trustManagerFactory)	Sets the optional user defined TrustManagerFactory.
@NotNull SecurityProviderOutput	userNamePassword(@NotNull String username, byte @Nullable [] password)	Configures username password authentication.

Method Detail

userNamePassword

@NotNull
@NotNull SecurityProviderOutput userNamePassword(@NotNull
                                                 @NotNull String username,
                                                 byte @Nullable [] password)

Configures username password authentication.

Parameters:

username - the username.

password - the password.

Returns:

this.

Since:

4.6.0

keyManagerFactory

@NotNull
@NotNull SecurityProviderOutput keyManagerFactory(@Nullable
                                                  @Nullable KeyManagerFactory keyManagerFactory)

Sets the optional user defined KeyManagerFactory.

Parameters:

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

Returns:

this.

Since:

4.6.0

trustManagerFactory

@NotNull
@NotNull SecurityProviderOutput trustManagerFactory(@Nullable
                                                    @Nullable TrustManagerFactory trustManagerFactory)

Sets the optional user defined TrustManagerFactory.

Parameters:

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

Returns:

this.

Since:

4.6.0

cipherSuites

@NotNull
@NotNull SecurityProviderOutput 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:

this.

Since:

4.6.0

protocols

@NotNull
@NotNull SecurityProviderOutput 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:

this.

Since:

4.6.0

handshakeTimeout

@NotNull
@NotNull SecurityProviderOutput handshakeTimeout(long handshakeTimeout,
                                                 @NotNull
                                                 @NotNull TimeUnit timeUnit)

Sets the SSL/TLS handshake timeout.

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

Parameters:

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

Returns:

this.

Since:

4.6.0

hostnameVerifier

@NotNull
@NotNull SecurityProviderOutput hostnameVerifier(@Nullable
                                                 @Nullable HostnameVerifier hostnameVerifier)

Sets the optional user defined hostname verifier.

Parameters:

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

Returns:

this.

Since:

4.6.0