Micronaut MQTT Configuration Reference
Every documented configuration property of Micronaut MQTT, with types, descriptions, and defaults.
115 properties across 5 sections
Micronaut Mqtt Core Config Properties
Configuration properties for MqttConfigurationProperties
| Property | Type | Description |
|---|---|---|
mqtt.enabled | boolean | Enables Micronaut MQTT integration. Default value true |
Micronaut Mqtt Hivemq Config Properties
Configuration properties for MqttClientConfigurationProperties
| Property | Type | Description |
|---|---|---|
mqtt.client.clean-start | boolean | Set true if a new sessions should be started for connection (v5 only). |
mqtt.client.session-expiry-interval | java.lang.Long | The session expiry interval in seconds (v5 only). |
mqtt.client.receive-maximum | java.lang.Integer | The maximum amount of not acknowledged publishes with QoS 1 or 2 the client accepts from the server concurrently (v5 only). |
mqtt.client.maximum-packet-size | java.lang.Integer | The maximum packet size the client sends to the server (v5 only). |
mqtt.client.topic-alias-maximum | java.lang.Integer | The maximum amount of topic aliases the client accepts from the server (v5 only). |
mqtt.client.request-response-info | boolean | Whether the client requests response information from the server (v5 only). |
mqtt.client.request-problem-info | boolean | Whether the client requests problem information from the server (v5 only). |
mqtt.client.user-properties | java.util.Map | The user defined properties that should be sent for every message (v5 only). |
mqtt.client.clean-session | boolean | Set true if a new session should be started for connection (v3 only). |
mqtt.client.server-uri | java.net.URI | the uri of server to connect to as [schema]://[serverHost]:[serverPort]. |
mqtt.client.client-id | java.lang.String | the client identifier. |
mqtt.client.mqtt-version | int | the MQTT version to use. |
mqtt.client.connection-timeout | java.time.Duration | the connection timeout. |
mqtt.client.manual-acks | boolean | an optional boolean to set the client in manual acknowledge mode. |
mqtt.client.password | byte | the password to use for MQTT connections. |
mqtt.client.user-name | java.lang.String | the username to use for MQTT connections. |
mqtt.client.max-reconnect-delay | long | the maximal delay for reconnecting. |
mqtt.client.keep-alive-interval | int | the keep alive interval. |
mqtt.client.automatic-reconnect | boolean | true is automatic reconnect should be performed. |
mqtt.client.custom-web-socket-headers | java.util.Map | the custom headers that should be sent with web socket connections. |
mqtt.client.https-hostname-verification-enabled | boolean | true if hostname verification should be used. |
mqtt.client.sslhostname-verifier | javax.net.ssl.HostnameVerifier | the hostname verifier to use for hostname verification. |
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 | byte | The message payload |
mqtt.client.will-message.qos | int | The message qos |
mqtt.client.will-message.retained | boolean | True if the message should be retained |
Micronaut Mqtt Ssl Config Properties
Configuration properties for MqttCertificateConfiguration
Micronaut Mqttv3 Config Properties
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.manual-acks | java.lang.Boolean | An optional boolean to set the client in manual acknowledge mode |
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 |
Configuration properties for MqttConnectOptions
| Property | Type | Description |
|---|---|---|
mqtt.client.password | char | |
mqtt.client.user-name | java.lang.String | |
mqtt.client.max-reconnect-delay | int | |
mqtt.client.keep-alive-interval | int | |
mqtt.client.mqtt-version | int | |
mqtt.client.max-inflight | int | |
mqtt.client.connection-timeout | int | |
mqtt.client.clean-session | boolean | |
mqtt.client.server-uris | java.lang.String | |
mqtt.client.automatic-reconnect | boolean | |
mqtt.client.executor-service-timeout | int | |
mqtt.client.custom-web-socket-headers | java.util.Properties |
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 | byte | The message payload |
mqtt.client.will-message.qos | int | The message qos |
mqtt.client.will-message.retained | boolean | True if the message should be retained |
Micronaut Mqttv5 Config Properties
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.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 |
Configuration properties for MqttConnectionOptions
| Property | Type | Description |
|---|---|---|
mqtt.client.will-message-properties | org.eclipse.paho.mqttv5.common.packet.MqttProperties | |
mqtt.client.user-name | java.lang.String | |
mqtt.client.password | byte | |
mqtt.client.clean-start | boolean | |
mqtt.client.keep-alive-interval | int | |
mqtt.client.connection-timeout | 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 | byte | |
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 |
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 | byte | The message payload |
mqtt.client.will-message.qos | int | The message qos |
mqtt.client.will-message.retained | boolean | True if the message should be retained |
Configuration properties for MqttProperties
| Property | Type | Description |
|---|---|---|
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 | byte | |
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 | byte | |
mqtt.client.will-message.properties.subscription-identifiers | java.util.List | |
mqtt.client.will-message.properties.subscription-identifier | java.lang.Integer |
No properties match this filter.