Author: buildbot
Date: Tue Nov 11 13:18:56 2014
New Revision: 928754
Log:
Production update by buildbot for camel
Modified:
websites/production/camel/content/cache/main.pageCache
websites/production/camel/content/mqtt.html
Modified: websites/production/camel/content/cache/main.pageCache
==============================================================================
Binary files - no diff available.
Modified: websites/production/camel/content/mqtt.html
==============================================================================
--- websites/production/camel/content/mqtt.html (original)
+++ websites/production/camel/content/mqtt.html Tue Nov 11 13:18:56 2014
@@ -96,7 +96,7 @@
</div></div><h3 id="MQTT-URIformat">URI format</h3><div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
<script class="theme: Default; brush: java; gutter: false"
type="syntaxhighlighter"><![CDATA[mqtt://name[?options]
]]></script>
-</div></div><p>Where <strong>name</strong> is the name you want to assign the
component.</p><h3 id="MQTT-Options">Options</h3><div
class="confluenceTableSmall"><div class="table-wrap"><table
class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh"><p>Property</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Default</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>host</code></p></td><td colspan="1"
rowspan="1"
class="confluenceTd"><p><code>tcp://127.0.0.1:1883</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>The URI of the MQTT broker to
connect too - this component also supports SSL - e.g.
<em>ssl://127.0.0.1:8883</em></p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>localAddress</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1" rowspan="1"
class="confluence
Td"><p>The local InetAddress and port to use</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>connectAttemptsMax</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>-1</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>The maximum number of attempts
to establish an initial connection - <strong><em>-1</em></strong> in
infinite.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>reconnectAttemptsMax</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>-1</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>The maximum number of attempts
to re-establish a connection after failure - <strong><em>-1</em></strong> in
infinite.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>reconnectDelay</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>10</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>The time in mil
liseconds between attempts to reestablish an initial or failed
connection</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>reconnectBackOffMultiplier</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>2.0</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>The multiplier to use to the
delay between connection attempts for successive failed connection
attempts</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>reconnectDelayMax</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>30000</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>The maximum time in milliseconds between a
new attempt to establish a connection. So even using the
reconnectBackOffMultiplier, this property will define the maximum delay before
another connection attempt to the MQTT broker</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>qualityOfService</code></p></td><
td colspan="1" rowspan="1"
class="confluenceTd"><p><code>AtLeastOnce</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>The MQTT Quality of Service to use for
message exchanges. It can be one of <strong>AtMostOnce</strong>,
<strong>AtLeastOnce</strong> or
<strong>ExactlyOnce</strong></p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>subscribeTopicName</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>The name of the Topic to subscribe to for
messages</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>publishTopicName</code></p></td><td colspan="1"
rowspan="1"
class="confluenceTd"><p><code><em>camel/mqtt/test</em></code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>The default Topic to publish
messages on</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>byDefaultRetain</code></p></td><td colspan="
1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>The default retain policy to be
used on messages sent to the MQTT broker</p></td></tr><tr><td colspan="1"
rowspan="1"
class="confluenceTd"><p><code>mqttTopicPropertyName</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p
class="p1"><em>MQTTTopicPropertyName</em></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>The property name to look for on an Exchange for an
individual published message. If this is set - the name will be used as the
Topic to publish a message to the MQTT message broker. This option is removed
since camel 2.14.0.</p><p><strong>Since Camel 2.14.0</strong>, Camel uses
"<strong><span style="line-height:
1.4285715;">CamelMQTTSubscribeTopic</span></strong><span style="line-height:
1.4285715;">" to store the topic name of the MQTT consumer into the message
header, and "</span><span style="line-height: 1.4285715;"><strong>CamelM
QTTPublishTopic</strong>" to look up the topic name of the MQTT producer from
the message header. </span></p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>mqttRetainPropertyName</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>MQTTRetain</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>The property name to look for on an
Exchange for an individual published message. If this is set (expects a Boolean
value) - then the retain property will be set on the message sent to the MQTT
message broker.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>mqttQosPropertyName</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>MQTTQos</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>The property name to look for on an
Exchange for an individual published message. If this is set (one of
<strong>AtMostOnce</strong>, <strong>AtLeastOnce</strong> or
<strong>ExactlyOnce</st
rong> ) - then that QoS will be set on the message sent to the MQTT message
broker.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>connectWaitInSeconds</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>10</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>Delay in seconds the Component
will wait for a connection to be established to the MQTT
broker</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>disconnectWaitInSeconds</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>5</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>the number of seconds the
Component will wait for a valid disconnect on stop() from the MQTT
broker</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>sendWaitInSeconds</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>5</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>The
maximum time the Component will wait for a receipt from the MQTT broker to
acknowledge a published message before throwing an
exception</p></td></tr></tbody></table></div></div><p>You can append query
options to the URI in the following format,
<code>?option=value&option=value&...</code></p><h3
id="MQTT-Samples">Samples</h3><p>Sending messages:</p><div class="code panel
pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+</div></div><p>Where <strong>name</strong> is the name you want to assign the
component.</p><h3 id="MQTT-Options">Options</h3><div
class="confluenceTableSmall"><div class="table-wrap"><table
class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh"><p>Property</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Default</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>host</code></p></td><td colspan="1"
rowspan="1"
class="confluenceTd"><p><code>tcp://127.0.0.1:1883</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>The URI of the MQTT broker to
connect too - this component also supports SSL - e.g.
<em>ssl://127.0.0.1:8883</em></p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>localAddress</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1" rowspan="1"
class="confluence
Td"><p>The local InetAddress and port to use</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><pre>userName</pre></td><td colspan="1"
rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd">userName to be used for authentication against the MQTT
broker</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><pre>password</pre></td><td colspan="1" rowspan="1"
class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd">password to be used for authentication against the MQTT
broker</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>connectAttemptsMax</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>-1</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>The maximum number of attempts to establish
an initial connection - <strong><em>-1</em></strong> in
infinite.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>reconnectAttem
ptsMax</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>-1</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>The maximum number of attempts to re-establish a
connection after failure - <strong><em>-1</em></strong> in
infinite.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>reconnectDelay</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>10</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>The time in milliseconds between attempts
to reestablish an initial or failed connection</p></td></tr><tr><td colspan="1"
rowspan="1"
class="confluenceTd"><p><code>reconnectBackOffMultiplier</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>2.0</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>The multiplier to use to the
delay between connection attempts for successive failed connection
attempts</p></td></tr><tr><td colspan="1" rowspan="1" class="conf
luenceTd"><p><code>reconnectDelayMax</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>30000</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>The maximum time in milliseconds between a
new attempt to establish a connection. So even using the
reconnectBackOffMultiplier, this property will define the maximum delay before
another connection attempt to the MQTT broker</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>qualityOfService</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>AtLeastOnce</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>The MQTT Quality of Service to use for
message exchanges. It can be one of <strong>AtMostOnce</strong>,
<strong>AtLeastOnce</strong> or
<strong>ExactlyOnce</strong></p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>subscribeTopicName</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>The name of the Topic to
subscribe to for messages</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>publishTopicName</code></p></td><td colspan="1"
rowspan="1"
class="confluenceTd"><p><code><em>camel/mqtt/test</em></code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>The default Topic to publish
messages on</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>byDefaultRetain</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>The default retain policy to be used on
messages sent to the MQTT broker</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>mqttTopicPropertyName</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p
class="p1"><em>MQTTTopicPropertyName</em></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>The property name to loo
k for on an Exchange for an individual published message. If this is set - the
name will be used as the Topic to publish a message to the MQTT message broker.
This option is removed since camel 2.14.0.</p><p><strong>Since Camel
2.14.0</strong>, Camel uses "<strong><span style="line-height:
1.4285715;">CamelMQTTSubscribeTopic</span></strong><span style="line-height:
1.4285715;">" to store the topic name of the MQTT consumer into the message
header, and "</span><span style="line-height:
1.4285715;"><strong>CamelMQTTPublishTopic</strong>" to look up the topic name
of the MQTT producer from the message header. </span></p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>mqttRetainPropertyName</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>MQTTRetain</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>The property name to look for on an
Exchange for an individual published message. If this is set (expects a Boolean
value) - t
hen the retain property will be set on the message sent to the MQTT message
broker.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>mqttQosPropertyName</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>MQTTQos</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>The property name to look for on an
Exchange for an individual published message. If this is set (one of
<strong>AtMostOnce</strong>, <strong>AtLeastOnce</strong> or
<strong>ExactlyOnce</strong> ) - then that QoS will be set on the message sent
to the MQTT message broker.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>connectWaitInSeconds</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>10</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>Delay in seconds the Component
will wait for a connection to be established to the MQTT
broker</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceT
d"><p><code>disconnectWaitInSeconds</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>5</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>the number of seconds the Component will wait for a
valid disconnect on stop() from the MQTT broker</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>sendWaitInSeconds</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>5</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>The maximum time the Component will wait
for a receipt from the MQTT broker to acknowledge a published message before
throwing an exception</p></td></tr></tbody></table></div></div><p>You can
append query options to the URI in the following format,
<code>?option=value&option=value&...</code></p><h3
id="MQTT-Samples">Samples</h3><p>Sending messages:</p><div class="code panel
pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
<script class="theme: Default; brush: java; gutter: false"
type="syntaxhighlighter"><![CDATA[from("direct:foo").to("mqtt:cheese?publishTopicName=test.mqtt.topic");
]]></script>
</div></div><p>Consuming messages:</p><div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
