HiveMQ

Camel HiveMQ MQTT Client support

What’s inside

Please refer to the above links for usage and configuration details.

Maven coordinates

<dependency>
    <groupId>org.apache.camel.springboot</groupId>
    <artifactId>camel-hivemq-starter</artifactId>
</dependency>

Spring Boot Auto-Configuration

The starter supports 14 options, which are listed below.

Name Description Default Type

camel.component.hivemq.autowired-enabled

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

Boolean

camel.component.hivemq.bridge-error-handler

Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored.

false

Boolean

camel.component.hivemq.clean-start

Whether to initiate a clean start (MQTT 5) upon connecting to the broker.

true

Boolean

camel.component.hivemq.client-id

Client identifier used when connecting to the HiveMQ broker.

String

camel.component.hivemq.configuration

Component configuration. The option is a org.apache.camel.component.hivemq.HiveMQConfiguration type.

HiveMQConfiguration

camel.component.hivemq.enabled

Whether to enable auto configuration of the hivemq component. This is enabled by default.

Boolean

camel.component.hivemq.host

Hostname or IP address of the HiveMQ MQTT broker.

localhost

String

camel.component.hivemq.lazy-start-producer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

Boolean

camel.component.hivemq.password

Password for authentication with the HiveMQ broker.

String

camel.component.hivemq.port

Port number of the HiveMQ MQTT broker.

1883

Integer

camel.component.hivemq.qos

Default Quality of Service (QoS) level to use for messages.

at-least-once

MqttQos

camel.component.hivemq.retained

Whether published messages should be retained by the MQTT broker.

false

Boolean

camel.component.hivemq.ssl

Whether to enable SSL/TLS encryption for the broker connection.

false

Boolean

camel.component.hivemq.username

Username for authentication with the HiveMQ broker.

String
Back to top