MqttClientBuilderBase (hivemq-mqtt-client 1.3.0 API)

Type Parameters:

B - the type of the builder.

All Known Subinterfaces:

Mqtt3ClientBuilder, Mqtt5ClientBuilder, MqttClientBuilder
```
@DoNotImplement
public interface MqttClientBuilderBase<B extends MqttClientBuilderBase<B>>
```
Builder base for an MqttClient.

Since:

1.0

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`B`	`addConnectedListener(@NotNull MqttClientConnectedListener connectedListener)` Adds a listener which is notified when the client is connected (a successful ConnAck message is received).
`B`	`addDisconnectedListener(@NotNull MqttClientDisconnectedListener disconnectedListener)` Adds a listener which is notified when the client is disconnected (with or without a Disconnect message) or the connection fails.
`MqttClientAutoReconnectBuilder.Nested<? extends B>`	`automaticReconnect()` Fluent counterpart of `automaticReconnect(MqttClientAutoReconnect)`.
`B`	`automaticReconnect(@Nullable MqttClientAutoReconnect autoReconnect)` Sets the optional `automatic reconnect strategy`.
`B`	`automaticReconnectWithDefaultConfig()` Uses automatic reconnect with the default configuration.
`MqttClientExecutorConfigBuilder.Nested<? extends B>`	`executorConfig()` Fluent counterpart of `executorConfig(MqttClientExecutorConfig)`.
`B`	`executorConfig(@NotNull MqttClientExecutorConfig executorConfig)` Sets the `executor configuration`.
`B`	`identifier(@NotNull MqttClientIdentifier identifier)` Sets the `Client Identifier`.
`B`	`identifier(@NotNull String identifier)` Sets the `Client Identifier`.
`B`	`serverAddress(@NotNull InetSocketAddress address)` Sets the `server address` to connect to.
`B`	`serverHost(@NotNull InetAddress host)` Sets the `server host` to connect to.
`B`	`serverHost(@NotNull 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.
`MqttClientTransportConfigBuilder.Nested<? extends B>`	`transportConfig()` Fluent counterpart of `transportConfig(MqttClientTransportConfig)`.
`B`	`transportConfig(@NotNull MqttClientTransportConfig transportConfig)` Sets the `transport configuration`.
`default MqttClientSslConfigBuilder.Nested<? extends B>`	`useSsl()` Deprecated. use `sslConfig()`.
`default B`	`useSsl(@Nullable MqttClientSslConfig sslConfig)` Deprecated. use `sslConfig(MqttClientSslConfig)`.
`default B`	`useSslWithDefaultConfig()` Deprecated. use `sslWithDefaultConfig()`.
`default MqttWebSocketConfigBuilder.Nested<? extends B>`	`useWebSocket()` Deprecated. use `webSocketConfig()`.
`default B`	`useWebSocket(@Nullable MqttWebSocketConfig webSocketConfig)` Deprecated. use `webSocketConfig(MqttWebSocketConfig)`.
`default B`	`useWebSocketWithDefaultConfig()` Deprecated. use `webSocketWithDefaultConfig()`.
`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
  - identifier
```
@CheckReturnValue
 @NotNull
B identifier(@NotNull
                                         @NotNull String identifier)
```
    Sets the Client Identifier.
    
    Parameters:
    
    identifier - the string representation of the Client Identifier.
    
    Returns:
    
    the builder.
  - identifier
```
@CheckReturnValue
 @NotNull
B identifier(@NotNull
                                         @NotNull MqttClientIdentifier identifier)
```
    Sets the Client Identifier.
    
    Parameters:
    
    identifier - the Client Identifier.
    
    Returns:
    
    the builder.
  - serverAddress
```
@CheckReturnValue
 @NotNull
B serverAddress(@NotNull
                                            @NotNull InetSocketAddress address)
```
    Sets the server address to connect to.
    
    Parameters:
    
    address - the server address.
    
    Returns:
    
    the builder
    
    Since:
    
    1.1
  - serverHost
```
@CheckReturnValue
 @NotNull
B serverHost(@NotNull
                                         @NotNull String host)
```
    Sets the server host to connect to.
    
    Parameters:
    
    host - the server host.
    
    Returns:
    
    the builder.
  - serverHost
```
@CheckReturnValue
 @NotNull
B serverHost(@NotNull
                                         @NotNull InetAddress host)
```
    Sets the server host to connect to.
    
    Parameters:
    
    host - the server host.
    
    Returns:
    
    the builder.
    
    Since:
    
    1.1
  - serverPort
```
@CheckReturnValue
 @NotNull
B serverPort(int port)
```
    Sets the server port to connect to.
    
    Parameters:
    
    port - the server port.
    
    Returns:
    
    the builder.
  - useSslWithDefaultConfig
```
@Deprecated
 @NotNull
default B useSslWithDefaultConfig()
```
    Deprecated. use sslWithDefaultConfig().
    
    Use sslWithDefaultConfig().
    
    Returns:
    
    use sslWithDefaultConfig().
  - sslWithDefaultConfig
```
@CheckReturnValue
 @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.
    
    Since:
    
    1.1
  - useSsl
```
@Deprecated
 @NotNull
default B useSsl(@Nullable
                                       @Nullable MqttClientSslConfig sslConfig)
```
    Deprecated. use sslConfig(MqttClientSslConfig).
    
    Use sslConfig(MqttClientSslConfig).
    
    Parameters:
    
    sslConfig - use sslConfig(MqttClientSslConfig).
    
    Returns:
    
    use sslConfig(MqttClientSslConfig).
  - sslConfig
```
@CheckReturnValue
 @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.
    
    Since:
    
    1.1
  - useSsl
```
@Deprecated
default MqttClientSslConfigBuilder.Nested<? extends B> useSsl()
```
    Deprecated. use sslConfig().
    
    Use sslConfig().
    
    Returns:
    
    use sslConfig().
  - sslConfig
```
@CheckReturnValue
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.
    
    Since:
    
    1.1
    
    See Also:
    
    sslConfig(MqttClientSslConfig)
  - useWebSocketWithDefaultConfig
```
@Deprecated
 @NotNull
default B useWebSocketWithDefaultConfig()
```
    Deprecated. use webSocketWithDefaultConfig().
    
    Use webSocketWithDefaultConfig().
    
    Returns:
    
    use webSocketWithDefaultConfig().
  - webSocketWithDefaultConfig
```
@CheckReturnValue
 @NotNull
B webSocketWithDefaultConfig()
```
    Sets the WebSocket transport configuration to the default configuration.
    
    Returns:
    
    the builder.
    
    Since:
    
    1.1
  - useWebSocket
```
@Deprecated
 @NotNull
default B useWebSocket(@Nullable
                                             @Nullable MqttWebSocketConfig webSocketConfig)
```
    Deprecated. use webSocketConfig(MqttWebSocketConfig).
    
    Use webSocketConfig(MqttWebSocketConfig).
    
    Parameters:
    
    webSocketConfig - use webSocketConfig(MqttWebSocketConfig).
    
    Returns:
    
    use webSocketConfig(MqttWebSocketConfig).
  - webSocketConfig
```
@CheckReturnValue
 @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.
    
    Since:
    
    1.1
  - useWebSocket
```
@Deprecated
default MqttWebSocketConfigBuilder.Nested<? extends B> useWebSocket()
```
    Deprecated. use webSocketConfig().
    
    Use webSocketConfig().
    
    Returns:
    
    use webSocketConfig().
  - webSocketConfig
```
@CheckReturnValue
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.
    
    Since:
    
    1.1
    
    See Also:
    
    webSocketConfig(MqttWebSocketConfig)
  - transportConfig
```
@CheckReturnValue
 @NotNull
B transportConfig(@NotNull
                                              @NotNull MqttClientTransportConfig transportConfig)
```
    Sets the transport configuration.
    
    Parameters:
    
    transportConfig - the transport configuration.
    
    Returns:
    
    the builder.
    
    Since:
    
    1.1
  - transportConfig
```
@CheckReturnValue
MqttClientTransportConfigBuilder.Nested<? extends B> transportConfig()
```
    Fluent counterpart of transportConfig(MqttClientTransportConfig).
    Calling MqttClientTransportConfigBuilder.Nested.applyTransportConfig() on the returned builder has the effect of extending the current transport configuration.
    
    Returns:
    
    the fluent builder for the transport configuration.
    
    Since:
    
    1.1
    
    See Also:
    
    transportConfig(MqttClientTransportConfig)
  - executorConfig
```
@CheckReturnValue
 @NotNull
B executorConfig(@NotNull
                                             @NotNull MqttClientExecutorConfig executorConfig)
```
    Sets the executor configuration.
    
    Parameters:
    
    executorConfig - the executor configuration.
    
    Returns:
    
    the builder.
  - executorConfig
```
@CheckReturnValue
MqttClientExecutorConfigBuilder.Nested<? extends B> executorConfig()
```
    Fluent counterpart of executorConfig(MqttClientExecutorConfig).
    Calling MqttClientExecutorConfigBuilder.Nested.applyExecutorConfig() on the returned builder has the effect of extending the current executor configuration.
    
    Returns:
    
    the fluent builder for the executor configuration.
    
    See Also:
    
    executorConfig(MqttClientExecutorConfig)
  - automaticReconnectWithDefaultConfig
```
@CheckReturnValue
 @NotNull
B automaticReconnectWithDefaultConfig()
```
    Uses automatic reconnect with the default configuration.
    
    Returns:
    
    the builder.
    
    Since:
    
    1.1
  - automaticReconnect
```
@CheckReturnValue
 @NotNull
B automaticReconnect(@Nullable
                                                 @Nullable MqttClientAutoReconnect autoReconnect)
```
    Sets the optional automatic reconnect strategy.
    
    Parameters:
    
    autoReconnect - the automatic reconnect strategy or null to remove any previously set automatic reconnect strategy.
    
    Returns:
    
    the builder.
    
    Since:
    
    1.1
  - automaticReconnect
```
@CheckReturnValue
MqttClientAutoReconnectBuilder.Nested<? extends B> automaticReconnect()
```
    Fluent counterpart of automaticReconnect(MqttClientAutoReconnect).
    Calling MqttClientAutoReconnectBuilder.Nested#applyAutomaticReconnect() on the returned builder has the effect of extending the current automatic reconnect strategy.
    
    Returns:
    
    the fluent builder for the automatic reconnect strategy.
    
    Since:
    
    1.1
    
    See Also:
    
    automaticReconnect(MqttClientAutoReconnect)
  - addConnectedListener
```
@CheckReturnValue
 @NotNull
B addConnectedListener(@NotNull
                                                   @NotNull MqttClientConnectedListener connectedListener)
```
    Adds a listener which is notified when the client is connected (a successful ConnAck message is received).
    The listeners are called in the same order in which they are added.
    
    Parameters:
    
    connectedListener - the listener to add.
    
    Returns:
    
    the builder.
    
    Since:
    
    1.1
  - addDisconnectedListener
```
@CheckReturnValue
 @NotNull
B addDisconnectedListener(@NotNull
                                                      @NotNull MqttClientDisconnectedListener disconnectedListener)
```
    Adds a listener which is notified when the client is disconnected (with or without a Disconnect message) or the connection fails.
    The listeners are called in the same order in which they are added.
    
    Parameters:
    
    disconnectedListener - the listener to add.
    
    Returns:
    
    the builder.
    
    Since:
    
    1.1

Interface MqttClientBuilderBase<B extends MqttClientBuilderBase<B>>

Method Summary

Method Detail

identifier

identifier

serverAddress

serverHost

serverHost

serverPort

useSslWithDefaultConfig

sslWithDefaultConfig

useSsl

sslConfig

useSsl

sslConfig

useWebSocketWithDefaultConfig

webSocketWithDefaultConfig

useWebSocket

webSocketConfig

useWebSocket

webSocketConfig

transportConfig

transportConfig

executorConfig

executorConfig

automaticReconnectWithDefaultConfig

automaticReconnect

automaticReconnect

addConnectedListener

addDisconnectedListener