Package com.hivemq.client.mqtt.mqtt5

Interface Mqtt5ClientBuilder

All Superinterfaces:

MqttClientBuilderBase<Mqtt5ClientBuilder>

@DoNotImplement
public interface Mqtt5ClientBuilder
extends MqttClientBuilderBase<Mqtt5ClientBuilder>

Builder for an Mqtt5Client.

Since:

1.0

Method Summary

Modifier and Type	Method	Description
@NotNull Mqtt5ClientAdvancedConfigBuilder.Nested<? extends Mqtt5ClientBuilder>	advancedConfig()	Fluent counterpart of advancedConfig(Mqtt5ClientAdvancedConfig).
@NotNull Mqtt5ClientBuilder	advancedConfig(@NotNull Mqtt5ClientAdvancedConfig advancedConfig)	Sets the advanced configuration.
@NotNull Mqtt5Client	build()	Builds the Mqtt5Client.
@NotNull Mqtt5AsyncClient	buildAsync()	Builds the Mqtt5AsyncClient.
@NotNull Mqtt5BlockingClient	buildBlocking()	Builds the Mqtt5BlockingClient.
@NotNull Mqtt5RxClient	buildRx()	Builds the Mqtt5RxClient.
@NotNull Mqtt5ClientBuilder	enhancedAuth(@Nullable Mqtt5EnhancedAuthMechanism enhancedAuthMechanism)	Sets the enhanced authentication and/or authorization mechanism.
@NotNull Mqtt5SimpleAuthBuilder.Nested<? extends Mqtt5ClientBuilder>	simpleAuth()	Fluent counterpart of simpleAuth(Mqtt5SimpleAuth).
@NotNull Mqtt5ClientBuilder	simpleAuth(@Nullable Mqtt5SimpleAuth simpleAuth)	Sets the optional simple authentication and/or authorization related data.
@NotNull Mqtt5WillPublishBuilder.Nested<? extends Mqtt5ClientBuilder>	willPublish()	Fluent counterpart of willPublish(Mqtt5Publish).
@NotNull Mqtt5ClientBuilder	willPublish(@Nullable Mqtt5Publish willPublish)	Sets the optional Will Publish.

Methods inherited from interface com.hivemq.client.mqtt.MqttClientBuilderBase

addConnectedListener, addDisconnectedListener, automaticReconnect, automaticReconnect, automaticReconnectWithDefaultConfig, executorConfig, executorConfig, identifier, identifier, serverAddress, serverHost, serverHost, serverPort, sslConfig, sslConfig, sslWithDefaultConfig, transportConfig, transportConfig, useSsl, useSsl, useSslWithDefaultConfig, useWebSocket, useWebSocket, useWebSocketWithDefaultConfig, webSocketConfig, webSocketConfig, webSocketWithDefaultConfig

Method Details

advancedConfig

@CheckReturnValue
@NotNull
@NotNull Mqtt5ClientBuilder advancedConfig(@NotNull
 @NotNull Mqtt5ClientAdvancedConfig advancedConfig)

Sets the advanced configuration.

Parameters:

advancedConfig - the advanced configuration.

Returns:

the builder.

advancedConfig

@CheckReturnValue
@NotNull Mqtt5ClientAdvancedConfigBuilder.Nested<? extends Mqtt5ClientBuilder> advancedConfig()

Fluent counterpart of advancedConfig(Mqtt5ClientAdvancedConfig).

Calling Mqtt5ClientAdvancedConfigBuilder.Nested.applyAdvancedConfig() on the returned builder has the effect of extending the current advanced configuration.

Returns:

the fluent builder for the advanced configuration.

See Also:

• advancedConfig(Mqtt5ClientAdvancedConfig)

simpleAuth

@CheckReturnValue
@NotNull
@NotNull Mqtt5ClientBuilder simpleAuth(@Nullable
 @Nullable Mqtt5SimpleAuth simpleAuth)

Sets the optional simple authentication and/or authorization related data.

Parameters:

simpleAuth - the simple auth related data or null to remove any previously set simple auth related data.

Returns:

the builder.

Since:

1.1

simpleAuth

@CheckReturnValue
@NotNull Mqtt5SimpleAuthBuilder.Nested<? extends Mqtt5ClientBuilder> simpleAuth()

Fluent counterpart of simpleAuth(Mqtt5SimpleAuth).

Calling Mqtt5SimpleAuthBuilder.Nested.Complete.applySimpleAuth() on the returned builder has the same effect as calling simpleAuth(Mqtt5SimpleAuth) with the result of Mqtt5SimpleAuthBuilder.Complete.build().

Returns:

the fluent builder for the simple auth related data.

Since:

1.1

See Also:

• simpleAuth(Mqtt5SimpleAuth)

enhancedAuth

@CheckReturnValue
@NotNull
@NotNull Mqtt5ClientBuilder enhancedAuth(@Nullable
 @Nullable Mqtt5EnhancedAuthMechanism enhancedAuthMechanism)

Sets the enhanced authentication and/or authorization mechanism.

Parameters:

enhancedAuthMechanism - the enhanced auth mechanism or null to remove any previously set enhanced auth mechanism.

Returns:

the builder.

Since:

1.1

willPublish

@CheckReturnValue
@NotNull
@NotNull Mqtt5ClientBuilder willPublish(@Nullable
 @Nullable Mqtt5Publish willPublish)

Sets the optional Will Publish.

Parameters:

willPublish - the Will Publish or null to remove any previously set Will Publish.

Returns:

the builder.

Since:

1.1

willPublish

@CheckReturnValue
@NotNull Mqtt5WillPublishBuilder.Nested<? extends Mqtt5ClientBuilder> willPublish()

Fluent counterpart of willPublish(Mqtt5Publish).

Calling Mqtt5WillPublishBuilder.Nested.Complete.applyWillPublish() on the returned builder has the same effect as calling willPublish(Mqtt5Publish) with the result of Mqtt5WillPublishBuilder.Complete.build().

Returns:

the fluent builder for the Will Publish.

Since:

1.1

See Also:

• willPublish(Mqtt5Publish)

build

@CheckReturnValue
@NotNull
@NotNull Mqtt5Client build()

Builds the Mqtt5Client.

Returns:

the built Mqtt5Client.

buildRx

@CheckReturnValue
@NotNull
@NotNull Mqtt5RxClient buildRx()

Builds the Mqtt5RxClient.

Returns:

the built Mqtt5RxClient.

buildAsync

@CheckReturnValue
@NotNull
@NotNull Mqtt5AsyncClient buildAsync()

Builds the Mqtt5AsyncClient.

Returns:

the built Mqtt5AsyncClient.

buildBlocking

@CheckReturnValue
@NotNull
@NotNull Mqtt5BlockingClient buildBlocking()

Builds the Mqtt5BlockingClient.

Returns:

the built Mqtt5BlockingClient.