Configuration Reference

Version:1.0.0

Mqtt Ssl Config Properties

🔗
Table 1. Configuration Properties for MqttCertificateConfiguration
Property Type Description

mqtt.client.ssl.certificate-authority

Readable

The certificate authority location

mqtt.client.ssl.certificate

Readable

The client certificate location

mqtt.client.ssl.private-key

Readable

The client private key location

mqtt.client.ssl.password

[C

The key password

Mqttv3 Config Properties

🔗
Table 2. Configuration Properties for MqttClientConfigurationProperties$WillMessage
Property Type Description

mqtt.client.will-message.topic

java.lang.String

The topic to publish to

mqtt.client.will-message.payload

[B

The message payload

mqtt.client.will-message.qos

int

The message qos

mqtt.client.will-message.retained

boolean

If the message should be retained
🔗
Table 3. Configuration Properties for MqttClientConfigurationProperties
Property Type Description

mqtt.client.server-uri

java.lang.String

The server URI

mqtt.client.client-id

java.lang.String

The client ID

mqtt.client.connection-timeout

java.time.Duration

How long to wait for a connection

mqtt.client.manual-acks

java.lang.Boolean

Set to true if you wish to manually acknowledge messages

mqtt.client.password

class [C

mqtt.client.user-name

java.lang.String

mqtt.client.max-reconnect-delay

int

mqtt.client.keep-alive-interval

int

mqtt.client.max-inflight

int

mqtt.client.clean-session

boolean

mqtt.client.server-uris

java.lang.String[]

mqtt.client.mqtt-version

int

mqtt.client.automatic-reconnect

boolean

mqtt.client.executor-service-timeout

int

mqtt.client.custom-web-socket-headers

java.util.Properties

mqtt.client.socket-factory

javax.net.SocketFactory

mqtt.client.sslproperties

java.util.Properties

mqtt.client.https-hostname-verification-enabled

boolean

mqtt.client.sslhostname-verifier

javax.net.ssl.HostnameVerifier

Mqttv5 Config Properties

🔗
Table 4. Configuration Properties for MqttClientConfigurationProperties
Property Type Description

mqtt.client.server-uri

java.lang.String

The server URI

mqtt.client.client-id

java.lang.String

The client ID

mqtt.client.connection-timeout

java.time.Duration

How long to wait for a connection

mqtt.client.user-name

java.lang.String

mqtt.client.password

class [B

mqtt.client.clean-start

boolean

mqtt.client.keep-alive-interval

int

mqtt.client.max-reconnect-delay

int

mqtt.client.server-uris

java.lang.String[]

mqtt.client.automatic-reconnect

boolean

mqtt.client.session-expiry-interval

java.lang.Long

mqtt.client.receive-maximum

java.lang.Integer

mqtt.client.maximum-packet-size

java.lang.Long

mqtt.client.topic-alias-maximum

java.lang.Integer

mqtt.client.request-response-info

boolean

mqtt.client.request-problem-info

boolean

mqtt.client.user-properties

java.util.List

mqtt.client.auth-method

java.lang.String

mqtt.client.auth-data

class [B

mqtt.client.use-subscription-identifiers

boolean

mqtt.client.custom-web-socket-headers

java.util.Map

mqtt.client.send-reason-messages

boolean

mqtt.client.executor-service-timeout

int

mqtt.client.socket-factory

javax.net.SocketFactory

mqtt.client.sslproperties

java.util.Properties

mqtt.client.https-hostname-verification-enabled

boolean

mqtt.client.sslhostname-verifier

javax.net.ssl.HostnameVerifier
🔗
Table 5. Configuration Properties for MqttClientConfigurationProperties$WillMessage
Property Type Description

mqtt.client.will-message-properties

org.eclipse.paho.mqttv5.common.packet.MqttProperties

mqtt.client.will-message.topic

java.lang.String

The topic to publish to

mqtt.client.will-message.payload

[B

The message payload

mqtt.client.will-message.qos

int

The message qos

mqtt.client.will-message.retained

boolean

If the message should be retained

mqtt.client.will-message.properties.valid-properties

java.lang.Byte[]

mqtt.client.will-message.properties.request-response-info

java.lang.Boolean

mqtt.client.will-message.properties.request-problem-info

java.lang.Boolean

mqtt.client.will-message.properties.will-delay-interval

java.lang.Long

mqtt.client.will-message.properties.receive-maximum

java.lang.Integer

mqtt.client.will-message.properties.maximum-qo-s

java.lang.Integer

mqtt.client.will-message.properties.maximum-packet-size

java.lang.Long

mqtt.client.will-message.properties.retain-available

boolean

mqtt.client.will-message.properties.assigned-client-identifier

java.lang.String

mqtt.client.will-message.properties.topic-alias-maximum

java.lang.Integer

mqtt.client.will-message.properties.topic-alias

java.lang.Integer

mqtt.client.will-message.properties.server-keep-alive

java.lang.Integer

mqtt.client.will-message.properties.response-info

java.lang.String

mqtt.client.will-message.properties.server-reference

java.lang.String

mqtt.client.will-message.properties.wildcard-subscriptions-available

boolean

mqtt.client.will-message.properties.subscription-identifiers-available

boolean

mqtt.client.will-message.properties.shared-subscription-available

boolean

mqtt.client.will-message.properties.session-expiry-interval

java.lang.Long

mqtt.client.will-message.properties.authentication-method

java.lang.String

mqtt.client.will-message.properties.authentication-data

class [B

mqtt.client.will-message.properties.reason-string

java.lang.String

mqtt.client.will-message.properties.user-properties

java.util.List

mqtt.client.will-message.properties.payload-format

boolean

mqtt.client.will-message.properties.message-expiry-interval

java.lang.Long

mqtt.client.will-message.properties.content-type

java.lang.String

mqtt.client.will-message.properties.response-topic

java.lang.String

mqtt.client.will-message.properties.correlation-data

class [B

mqtt.client.will-message.properties.subscription-identifiers

java.util.List

mqtt.client.will-message.properties.subscription-identifier

java.lang.Integer

mqtt.client.will-message.properties

org.eclipse.paho.mqttv5.common.packet.MqttProperties

The message properties