Page History

...

Paho component provides connector for the MQTT messaging protocol using the Eclipse Paho library. Paho is one of the most popular MQTT libraries, so if you would like to integrate it with your Java project - Camel Paho connector is a way to go.

URI format

paho:queueName[?options]

For example the following snippet reads messages from the MQTT broker installed on the same host as the Camel router:

from("paho:some/queue").
  to("mock:test");

While the snippet below sends message to the MQTT broker:

from("direct:test").
  to("paho:some/target/queue");

You can append query options to the URI in the following format: ?option=value&option=value&... . For example this is how to read messages from the remote MQTT broker: 

from("paho:some/queue?brokerUrl=tcp://iot.eclipse.org:1883").
  to("mock:test");

Adding the component to the project

...

<repositories>
  <repository>
    <id>eclipse-paho</id>
    <url>https://repo.eclipse.org/content/repositories/paho-releases</url>
    <snapshots>
      <enabled>false</enabled>
    </snapshots>
  </repository>
</repositories>

Default payload type

By default Camel Paho component operates on the binary payloads extracted out of (or put into) the MQTT message:

// Receive payload
byte[] payload = (byte[]) consumerTemplate.receiveBody("paho:topic");
 
// Send payload
byte[] payload = "message".getBytes();
producerTemplate.sendBody("paho:topic", payload);

But of course Camel build-in type conversion API can perform the automatic data type conversions transformations for you. In the example below Camel automatically converts binary payload into String (and conversely):

// Receive payload
String payload = consumerTemplate.receiveBody("paho:topic", String.class);
 
// Send payload
String payload = "message";
producerTemplate.sendBody("paho:topic", payload);

URI

...

paho:queueName[?options]

You can append query options to the URI in the following format: ?option=value&option=value&... .

URI Options

For example the convention-over-configuration approach used in Camel is really handy for the most of the situations, but sometimes you would like to have more fine-grained control over the MQTT client connection. To cover such situations just add the bean of type org.eclipse.paho.client.mqttv3.MqttConnectOptions to your Camel registry. For Spring applications that would means adding bean to your application context. The snippet below uses password-based authentication to connect to the MQTT broker:

@Bean
MqttConnectOptions connectOptions() {
  MqttConnectOptions connectOptions = new MqttConnectOptions();
  connectOptions.setUserName("henry");
  connectOptions.setPassword("secret".toCharArray());
  return connectOptions;
}

Headers

The following headers are recognized by the Paho component:

Examples

Read messages from the MQTT broker installed on the same host as the Camel router:

from("paho:some/queue").
  to("mock:test");

Read messages from the remote MQTT broker: 

from("paho:some/queue?brokerUrl=tcp://iot.eclipse.org:1883").
  to("mock:test");

Send message to the MQTT broker:

...