Package com.hivemq.client.mqtt.mqtt5

Interface Mqtt5ClientConfig

All Superinterfaces:

MqttClientConfig

@DoNotImplement
public interface Mqtt5ClientConfig
extends MqttClientConfig

Configuration of an Mqtt5Client.

Since:

1.0

Method Summary

Modifier and Type	Method	Description
@NotNull Mqtt5ClientAdvancedConfig	getAdvancedConfig()
@NotNull Optional<Mqtt5ClientConnectionConfig>	getConnectionConfig()	Returns the optional connection configuration of the client.
@NotNull Optional<Mqtt5EnhancedAuthMechanism>	getEnhancedAuthMechanism()	Returns the optional enhanced authentication and/or authorization mechanism of the client.
@NotNull Optional<Mqtt5SimpleAuth>	getSimpleAuth()	Returns the optional simple authentication and/or authorization related data of the client.
@NotNull Optional<Mqtt5WillPublish>	getWillPublish()	Returns the optional Will Publish of the client.

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

getAutomaticReconnect, getClientIdentifier, getConnectedListeners, getDisconnectedListeners, getExecutorConfig, getMqttVersion, getServerAddress, getServerHost, getServerPort, getSslConfig, getState, getTransportConfig, getWebSocketConfig

Method Details

getConnectionConfig

@NotNull
@NotNull Optional<Mqtt5ClientConnectionConfig> getConnectionConfig()

Description copied from interface: MqttClientConfig

Returns the optional connection configuration of the client. It is present if the client is connected and has received the ConnAck message.

Specified by:

getConnectionConfig in interface MqttClientConfig

Returns:

the optional connection configuration of the client.

getAdvancedConfig

@NotNull
@NotNull Mqtt5ClientAdvancedConfig getAdvancedConfig()

Returns:

the advanced configuration of the client.

getSimpleAuth

@NotNull
@NotNull Optional<Mqtt5SimpleAuth> getSimpleAuth()

Returns the optional simple authentication and/or authorization related data of the client.

It is used as default if Mqtt5Connect.simpleAuth is not set during connect.

Keep in mind that the data is stored with the client in memory. If you want to use it only during connect or if you use a different token for each connection please set Mqtt5Connect.simpleAuth instead.

Returns:

the optional simple authentication and/or authorization related data of the client.

Since:

1.1

getEnhancedAuthMechanism

@NotNull
@NotNull Optional<Mqtt5EnhancedAuthMechanism> getEnhancedAuthMechanism()

Returns the optional enhanced authentication and/or authorization mechanism of the client.

It is used as default if Mqtt5Connect.enhancedAuthMechanism is not set during connect.

Keep in mind that the mechanism is stored with the client in memory. If you use a different mechanism for each connection please set Mqtt5Connect.enhancedAuthMechanism instead.

Returns:

the optional enhanced authentication and/or authorization mechanism of the client.

Since:

1.1

getWillPublish

@NotNull
@NotNull Optional<Mqtt5WillPublish> getWillPublish()

Returns the optional Will Publish of the client.

It is used as default if Mqtt5Connect.willPublish is not set during connect.

Keep in mind that the Will Publish is stored with the client in memory. If you use a different Will Publish for each connection please set Mqtt5Connect.willPublish instead.

Returns:

the optional Will Publish of the client.

Since:

1.1