sendToMqtt

Send messages to a MQTT broker.

Experimental Feature: This processor is currently considered experimental and should not be used in production environments.

All messages are delivered with a Quality of Service (QoS) level of 1, which means a guarantee of "at least once" delivery.

Supports MQTT version 3.1.1.

Properties

Name Summary

Name	Summary
`mqttBrokerUrl`	URL to the MQTT broker. Typically, MQTT supports TCP and SSL protocols. For example: `tcp://localhost:port` or `ssl://localhost:port`. Required.
`topic`	Topic name to publish messages to. Required.
`authenticationConfigKey`	Key from the server configuration used to look up the credentials needed to connect to the MQTT broker. Optional and uses no authentication by default.
`connectionTimeoutMillis`	Connection timeout value. Optional.
`receiveTimeoutMillis`	Socket timeout value. Optional.
`externalSystemDetails`
`name`	Optional, descriptive name for the processor.
`id`	Required identifier of the processor, unique across all processors within the flow. Must be between 3 and 30 characters long; contain only lower and uppercase alphabetical characters (a-z and A-Z), numbers, dashes ("-"), and underscores ("_"); and start with an alphabetical character. In other words, it adheres to the regex pattern `[a-zA-Z][a-zA-Z0-9_-]{2,29}`.
`exchangeProperties`	Optional set of custom properties in a simple jdk-format, that are added to the message exchange properties before processing the incoming payload. Any existing properties with the same name will be replaced by properties defined here.
`retainPayloadOnFailure`	Whether the incoming payload is available for error processing on failure. Defaults to `false`.

mqttBrokerUrl

URL to the MQTT broker. Typically, MQTT supports TCP and SSL protocols. For example: tcp://localhost:port or ssl://localhost:port. Required.

topic

Topic name to publish messages to. Required.

authenticationConfigKey

Key from the server configuration used to look up the credentials needed to connect to the MQTT broker. Optional and uses no authentication by default.

connectionTimeoutMillis

Connection timeout value. Optional.

receiveTimeoutMillis

Socket timeout value. Optional.

externalSystemDetails

name

Optional, descriptive name for the processor.

id

Required identifier of the processor, unique across all processors within the flow. Must be between 3 and 30 characters long; contain only lower and uppercase alphabetical characters (a-z and A-Z), numbers, dashes ("-"), and underscores ("_"); and start with an alphabetical character. In other words, it adheres to the regex pattern [a-zA-Z][a-zA-Z0-9_-]{2,29}.

exchangeProperties

Optional set of custom properties in a simple jdk-format, that are added to the message exchange properties before processing the incoming payload. Any existing properties with the same name will be replaced by properties defined here.

retainPayloadOnFailure

Whether the incoming payload is available for error processing on failure. Defaults to false.

Sub-builders

Name	Summary
externalSystemDetails	Strategy for describing the external system integration. Optional.
circuitBreakerStrategy	Strategy for configuring the processor’s circuit breaker. Optional.
messageLoggingStrategy	Strategy for describing how a processor’s message is logged on the server.
payloadArchivingStrategy	Strategy for archiving payloads.
inboundTransformationStrategy	Strategy that customizes the conversion of an incoming payload by a processor (e.g., string to object). Should be used when the processor’s default conversion logic cannot be used.

Name

Summary

externalSystemDetails

Strategy for describing the external system integration. Optional.

circuitBreakerStrategy

Strategy for configuring the processor’s circuit breaker. Optional.

messageLoggingStrategy

Strategy for describing how a processor’s message is logged on the server.

payloadArchivingStrategy

Strategy for archiving payloads.

inboundTransformationStrategy

Strategy that customizes the conversion of an incoming payload by a processor (e.g., string to object). Should be used when the processor’s default conversion logic cannot be used.

Details

Authentication

The authenticationConfigKey property supports secrets of type UserNameAndPassword. See the Secret Types documentation for formatting details.

Was this page helpful?