com.hivemq.client.mqtt

Interface MqttClientTransportConfigBuilderBase<B extends MqttClientTransportConfigBuilderBase<B>>

All Known Subinterfaces:

MqttClientTransportConfigBuilder, MqttClientTransportConfigBuilder.Nested<P>

All Known Implementing Classes:

MqttClientTransportConfigImplBuilder.Default, MqttClientTransportConfigImplBuilder.Nested

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

Builder base for a MqttClientTransportConfig.

Since:

1.1

Method Summary

Modifier and Type	Method and Description
B	serverAddress(@NotNull java.net.InetSocketAddress address) Sets the server address to connect to.
B	serverHost(@NotNull java.net.InetAddress host) Sets the server host to connect to.
B	serverHost(@NotNull java.lang.String host) Sets the server host to connect to.
B	serverPort(int port) Sets the server port to connect to.
MqttClientSslConfigBuilder.Nested<? extends B>	sslConfig() Fluent counterpart of sslConfig(MqttClientSslConfig).
B	sslConfig(@Nullable MqttClientSslConfig sslConfig) Sets the optional secure transport configuration.
B	sslWithDefaultConfig() Sets the secure transport configuration to the default configuration.
MqttWebSocketConfigBuilder.Nested<? extends B>	webSocketConfig() Fluent counterpart of webSocketConfig(MqttWebSocketConfig).
B	webSocketConfig(@Nullable MqttWebSocketConfig webSocketConfig) Sets the optional WebSocket transport configuration.
B	webSocketWithDefaultConfig() Sets the WebSocket transport configuration to the default configuration.

Method Detail

serverAddress

@NotNull
B serverAddress(@NotNull
                         @NotNull java.net.InetSocketAddress address)

Sets the server address to connect to.

Parameters:

address - the server address.

Returns:

the builder.

serverHost

@NotNull
B serverHost(@NotNull
                      @NotNull java.lang.String host)

Sets the server host to connect to.

Parameters:

host - the server host.

Returns:

the builder.

serverHost

@NotNull
B serverHost(@NotNull
                      @NotNull java.net.InetAddress host)

Sets the server host to connect to.

Parameters:

host - the server host.

Returns:

the builder.

serverPort

@NotNull
B serverPort(int port)

Sets the server port to connect to.

Parameters:

port - the server port.

Returns:

the builder.

sslWithDefaultConfig

@NotNull
B sslWithDefaultConfig()

Sets the secure transport configuration to the default configuration.

This means that the systems default trust store, ciphers and protocols are used.

Returns:

the builder.

sslConfig

@NotNull
B sslConfig(@Nullable
                     @Nullable MqttClientSslConfig sslConfig)

Sets the optional secure transport configuration.

Parameters:

sslConfig - the secure transport configuration or null to remove any previously set secure transport configuration.

Returns:

the builder.

sslConfig

@NotNull
MqttClientSslConfigBuilder.Nested<? extends B> sslConfig()

Fluent counterpart of sslConfig(MqttClientSslConfig).

Calling MqttClientSslConfigBuilder.Nested.applySslConfig() on the returned builder has the effect of extending the current secure transport configuration.

Returns:

the fluent builder for the secure transport configuration.

See Also:

sslConfig(MqttClientSslConfig)

webSocketWithDefaultConfig

@NotNull
B webSocketWithDefaultConfig()

Sets the WebSocket transport configuration to the default configuration.

Returns:

the builder.

webSocketConfig

@NotNull
B webSocketConfig(@Nullable
                           @Nullable MqttWebSocketConfig webSocketConfig)

Sets the optional WebSocket transport configuration.

Parameters:

webSocketConfig - the WebSocket transport configuration or null to remove any previously set WebSocket transport configuration.

Returns:

the builder.

webSocketConfig

@NotNull
MqttWebSocketConfigBuilder.Nested<? extends B> webSocketConfig()

Fluent counterpart of webSocketConfig(MqttWebSocketConfig).

Calling MqttWebSocketConfigBuilder.Nested.applyWebSocketConfig() on the returned builder has the effect of extending the current WebSocket transport configuration.

Returns:

the fluent builder for the WebSocket configuration.

See Also:

webSocketConfig(MqttWebSocketConfig)