Modified: websites/production/camel/content/websocket.html
==============================================================================
--- websites/production/camel/content/websocket.html (original)
+++ websites/production/camel/content/websocket.html Tue Feb 18 07:21:04 2014
@@ -96,10 +96,10 @@
<h3 id="Websocket-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[websocket://hostname[:port][/resourceUri][?options]
]]></script>
-</div></div><p>You can append query options to the URI in the following
format, <code>?option=value&option=value&...</code></p><h3
id="Websocket-ComponentOptions">Component Options</h3><p>The
<code>WebsocketComponent</code> can be configured prior to use, to setup host,
to act as a websocket server.</p><table class="confluenceTable"><tbody><tr><th
colspan="1" rowspan="1" class="confluenceTh"><p> Option </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> host
</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> 0.0.0.0
</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> The hostname.
</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> port
</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> 9292 </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> The port num
ber. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>
staticResources </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>
<code>null</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>
Path for static resources such as index.html files etc. If this option has been
configured, then a server is started on the given hostname and port, to service
the static resources, eg such as an index.html file. If this option has not
been configured, then no server is started. </p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p> sslContextParameters </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> Reference to a
<code>org.apache.camel.util.jsse.SSLContextParameters</code> in the <a
shape="rect" class="external-link"
href="http://camel.apache.org/registry.html";>Registry</a>. This reference
overrides any configured SSLContextParameters at the component leve
l.  See <a shape="rect" href="camel-configuration-utilities.html"
title="Camel Configuration Utilities">Using the JSSE Configuration Utility</a>.
</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>
<code>enableJmx</code> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> <code>false</code> </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> If this option is true, Jetty JMX support
will be enabled for this endpoint. See <a shape="rect"
href="#Websocket-JettyJMXsupport">Jetty JMX support</a> for more details.
</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>
<code>sslKeyPassword</code> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> <code>null</code> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> <strong>Consumer only</strong>: The password for the
keystore when using SSL. </p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p> <code>sslPassword</code> </p></td><td colspan="1
" rowspan="1" class="confluenceTd"><p> <code>null</code> </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> <strong>Consumer
only</strong>: The password when using SSL. </p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p> <code>sslKeystore</code> </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> <code>null</code> </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> <strong>Consumer
only</strong>: The path to the keystore. </p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p> <code>minThreads</code> </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> <code>null</code> </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> <strong>Consumer
only</strong>: To set a value for minimum number of threads in server thread
pool. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>
<code>maxThreads</code> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> <code>null</code> </p></td>
<td colspan="1" rowspan="1" class="confluenceTd"><p> <strong>Consumer
only</strong>: To set a value for maximum number of threads in server thread
pool. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>
<code>threadPool</code> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> <code>null</code> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> <strong>Consumer only</strong>: To use a custom thread
pool for the server. </p></td></tr></tbody></table>
-<h3 id="Websocket-EndpointOptions">Endpoint Options</h3><p>The
<code>WebsocketEndpoint</code> can be configured prior to use</p><table
class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh"><p> Option </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> sslContextParametersRef </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> <strong>Deprecated and will be removed in
Camel 3.0:</strong> Reference to a
<code>org.apache.camel.util.jsse.SSLContextParameters</code> in the <a
shape="rect" class="external-link"
href="http://camel.apache.org/registry.html";>Registry</a>.  This reference
overrides any configured SSLContextParameters at the component level. See <a
shape="rect" href="camel-configuration-utilities.html" titl
e="Camel Configuration Utilities">Using the JSSE Configuration Utility</a>.
Use the <code>sslContextParameters</code> option instead </p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p> sslContextParameters
</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> <strong>Camel 2.11.1:</strong>
Reference to a <code>org.apache.camel.util.jsse.SSLContextParameters</code> in
the <a shape="rect" class="external-link"
href="http://camel.apache.org/registry.html";>Registry</a>. This reference
overrides any configured SSLContextParameters at the component level.  See
<a shape="rect" href="camel-configuration-utilities.html" title="Camel
Configuration Utilities">Using the JSSE Configuration Utility</a>.
</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>
sendToAll </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>
<code>null</code> </p></td><td colspan="1" rowspan="1" c
lass="confluenceTd"><p> <strong>Producer only:</strong> To send to all
websocket subscribers. Can be used to configure on endpoint level, instead of
having to use the <code>WebsocketConstants.SEND_TO_ALL</code> header on the
message. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>
staticResources </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>
<code>null</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>
The root directory for the web resources or classpath. Use the protocol file:
or classpath: depending if you want that the component loads the resource from
file system or classpath. </p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p> bufferSize </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> <code>null</code> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> <strong>Camel 2.12.3:</strong> set the buffer size of
the websocketServlet, which is also the max frame byte size (default
8192) </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>
maxIdleTime </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>
<code>null</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>
<strong>Camel 2.12.3:</strong> set the time in ms that the websocket created by
the websocketServlet may be idle before closing. (default is 300000)
</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>
maxTextMessageSize </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> <code>null</code> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> <strong>Camel 2.12.3:</strong> can be used to set the
size in characters that the websocket created by the websocketServlet may be
accept before closing. </p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p> maxBinaryMessageSize </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> <code>null</code> </p></td><td colspan="1"
rowspan="1" class="confluenceTd">
<p> <strong>Camel 2.12.3:</strong> can be used to set the size in bytes that
the websocket created by the websocketServlet may be accept before closing.
(Default is -1 - or unlimited) </p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p> minVersion </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> <code>null</code> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> <strong>Camel 2.12.3:</strong> can be used to set the
minimum protocol version accepted for the websocketServlet. (Default 13 - the
RFC6455 version)</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="Websocket-ComponentOptions">Component Options</h3><p>The
<code>WebsocketComponent</code> can be configured prior to use, to setup host,
to act as a websocket server.</p><div class="table-wrap"><table
class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh"><p> Option </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> host </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> 0.0.0.0 </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> The hostname. </p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p> port </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> 9292 </p></td><td colspan="1" rowspan="1" class="conflu
enceTd"><p> The port number. </p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p> staticResources </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> <code>null</code> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> Path for static resources such as index.html files
etc. If this option has been configured, then a server is started on the given
hostname and port, to service the static resources, eg such as an index.html
file. If this option has not been configured, then no server is started.
</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>
sslContextParameters </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> Reference to a
<code>org.apache.camel.util.jsse.SSLContextParameters</code> in the <a
shape="rect" class="external-link"
href="http://camel.apache.org/registry.html";>Registry</a>. This reference
overrides any configured SSLContextParamete
rs at the component level.  See <a shape="rect"
href="camel-configuration-utilities.html">Using the JSSE Configuration
Utility</a>. </p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p> <code>enableJmx</code> </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> <code>false</code> </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> If this option is true, Jetty
JMX support will be enabled for this endpoint. See <a shape="rect"
href="#Websocket-JettyJMXsupport">Jetty JMX support</a> for more details.
</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>
<code>sslKeyPassword</code> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> <code>null</code> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> <strong>Consumer only</strong>: The password for the
keystore when using SSL. </p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p> <code>sslPassword</code> </p></td><td colspan="1"
rowspan="1"
class="confluenceTd"><p> <code>null</code> </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> <strong>Consumer only</strong>: The
password when using SSL. </p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p> <code>sslKeystore</code> </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> <code>null</code> </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> <strong>Consumer only</strong>: The path
to the keystore. </p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p> <code>minThreads</code> </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> <code>null</code> </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> <strong>Consumer only</strong>: To set a
value for minimum number of threads in server thread pool.
</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>
<code>maxThreads</code> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> <code>null</code> </p></td><td colspan="1
" rowspan="1" class="confluenceTd"><p> <strong>Consumer only</strong>: To set
a value for maximum number of threads in server thread pool.
</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>
<code>threadPool</code> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> <code>null</code> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> <strong>Consumer only</strong>: To use a custom thread
pool for the server. </p></td></tr></tbody></table></div>
+<h3 id="Websocket-EndpointOptions">Endpoint Options</h3><p>The
<code>WebsocketEndpoint</code> can be configured prior to use</p><div
class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1"
rowspan="1" class="confluenceTh"><p> Option </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> sslContextParametersRef
</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> <strong>Deprecated and will be
removed in Camel 3.0:</strong> Reference to a
<code>org.apache.camel.util.jsse.SSLContextParameters</code> in the <a
shape="rect" class="external-link"
href="http://camel.apache.org/registry.html";>Registry</a>.  This reference
overrides any configured SSLContextParameters at the component level. See <a
shape="rect" href="camel-configurat
ion-utilities.html">Using the JSSE Configuration Utility</a>. Use the
<code>sslContextParameters</code> option instead </p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p> sslContextParameters
</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> <strong>Camel 2.11.1:</strong>
Reference to a <code>org.apache.camel.util.jsse.SSLContextParameters</code> in
the <a shape="rect" class="external-link"
href="http://camel.apache.org/registry.html";>Registry</a>. This reference
overrides any configured SSLContextParameters at the component level.  See
<a shape="rect" href="camel-configuration-utilities.html">Using the JSSE
Configuration Utility</a>. </p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p> sendToAll </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> <code>null</code> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> <strong>Producer only:</stro
ng> To send to all websocket subscribers. Can be used to configure on endpoint
level, instead of having to use the <code>WebsocketConstants.SEND_TO_ALL</code>
header on the message. </p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p> staticResources </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> <code>null</code> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> The root directory for the web resources or classpath.
Use the protocol file: or classpath: depending if you want that the component
loads the resource from file system or classpath. </p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p> bufferSize </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> <code>null</code> </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> <strong>Camel 2.12.3:</strong>
set the buffer size of the websocketServlet, which is also the max frame byte
size (default 8192) </p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p> maxIdleTime </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> <code>null</code> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> <strong>Camel 2.12.3:</strong> set the time in ms that
the websocket created by the websocketServlet may be idle before closing.
(default is 300000) </p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p> maxTextMessageSize </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> <code>null</code> </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> <strong>Camel 2.12.3:</strong> can be used
to set the size in characters that the websocket created by the
websocketServlet may be accept before closing. </p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p> maxBinaryMessageSize
</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>null</code>
</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <strong>Camel
2.12.3:</strong> can be used to se
t the size in bytes that the websocket created by the websocketServlet may be
accept before closing. (Default is -1 - or unlimited) </p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p> minVersion </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> <code>null</code> </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> <strong>Camel 2.12.3:</strong>
can be used to set the minimum protocol version accepted for the
websocketServlet. (Default 13 - the RFC6455
version)</p></td></tr></tbody></table></div>
-<p> </p><h3 id="Websocket-MessageHeaders">Message Headers</h3><p>The
websocket component uses 2 headers to indicate to either send messages back to
a single/current client, or to all clients.</p><table
class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh"><p> Key</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p> Description </p></th></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p>
<code>WebsocketConstants.SEND_TO_ALL</code> </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> Sends the message to all clients which are
currently connected. You can use the <code>sendToAll</code> option on the
endpoint instead of using this header. </p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p>
<code>WebsocketConstants.CONNECTION_KEY</code> </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> Sends the message to the client with the
given connection key. </p></td></tr></tbody></table>
+<p> </p><h3 id="Websocket-MessageHeaders">Message Headers</h3><p>The
websocket component uses 2 headers to indicate to either send messages back to
a single/current client, or to all clients.</p><div class="table-wrap"><table
class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh"><p> Key</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p> Description </p></th></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p>
<code>WebsocketConstants.SEND_TO_ALL</code> </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> Sends the message to all clients which are
currently connected. You can use the <code>sendToAll</code> option on the
endpoint instead of using this header. </p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p>
<code>WebsocketConstants.CONNECTION_KEY</code> </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> Sends the message to the client with the
given connection key. </p></td></tr></tbody></t
able></div>
<h3 id="Websocket-Usage">Usage</h3><p>In this example we let Camel exposes a
websocket server which clients can communicate with. The websocket server uses
the default host and port, which would be <code>0.0.0.0:9292</code>.<br
clear="none"> The example will send back an echo of the input. To send back a
message, we need to send the transformed message to the same endpoint
<code>"websocket://echo"</code>. This is needed<br clear="none"> because by
default the messaging is InOnly.</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[
// expose a echo websocket client, that sends back an echo
Modified: websites/production/camel/content/wire-tap.html
==============================================================================
--- websites/production/camel/content/wire-tap.html (original)
+++ websites/production/camel/content/wire-tap.html Tue Feb 18 07:21:04 2014
@@ -93,7 +93,7 @@
<p>If you <a shape="rect"
href="wire-tap.html">Wire Tap</a> a stream message body then you should
consider enabling <a shape="rect" href="stream-caching.html">Stream caching</a>
to ensure the message body can be read at each endpoint. See more details at <a
shape="rect" href="stream-caching.html">Stream caching</a>.</p>
</div>
</div>
-<h3 id="WireTap-Options">Options</h3><table
class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh"><p> Name </p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p> Default Value </p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p> Description </p></th></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p> <code>uri</code> </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> The URI of the endpoint to which the wire-tapped
message will be sent. You should use either <code>uri</code> or
<code>ref</code>. </p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p> <code>ref</code> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> Reference identifier of the endpoint to which the
wire-tapped message will be sent. You should use either <code>uri</code> or
<code>ref</code>. <
/p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>
<code>executorServiceRef</code> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> Reference identifier of a custom <a shape="rect"
href="threading-model.html" title="Threading Model">Thread Pool</a> to use when
processing the wire-tapped messages. If not set, Camel will use a default
thread pool. </p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p> <code>processorRef</code> </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> Reference identifier of a custom <a shape="rect"
href="processor.html" title="Processor">Processor</a> to use for creating a new
message (e.g., the "send a new message" mode). See below. </p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p> <code>copy</code> </p></td><td
colspan="1" rowspan="1" class="conf
luenceTd"><p> <code>true</code> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> <strong>Camel 2.3</strong>: Whether to copy the <a
shape="rect" href="exchange.html" title="Exchange">Exchange</a> before
wire-tapping the message. </p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p> <code>onPrepareRef</code> </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> <strong>Camel 2.8:</strong> Reference identifier of a
custom <a shape="rect" href="processor.html" title="Processor">Processor</a> to
prepare the copy of the <a shape="rect" href="exchange.html"
title="Exchange">Exchange</a> to be wire-tapped. This allows you to do any
custom logic, such as deep-cloning the message payload.
</p></td></tr></tbody></table>
+<h3 id="WireTap-Options">Options</h3><div class="table-wrap"><table
class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh"><p> Name </p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p> Default Value </p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p> Description </p></th></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p> <code>uri</code> </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> The URI of the endpoint to which the wire-tapped
message will be sent. You should use either <code>uri</code> or
<code>ref</code>. </p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p> <code>ref</code> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> Reference identifier of the endpoint to which the
wire-tapped message will be sent. You should use either <code>uri</code
> or <code>ref</code>. </p></td></tr><tr><td colspan="1" rowspan="1"
> class="confluenceTd"><p> <code>executorServiceRef</code> </p></td><td
> colspan="1" rowspan="1" class="confluenceTd"><p> </p></td><td
> colspan="1" rowspan="1" class="confluenceTd"><p> Reference identifier of a
> custom <a shape="rect" href="threading-model.html">Thread Pool</a> to use
> when processing the wire-tapped messages. If not set, Camel will use a
> default thread pool. </p></td></tr><tr><td colspan="1" rowspan="1"
> class="confluenceTd"><p> <code>processorRef</code> </p></td><td colspan="1"
> rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1"
> rowspan="1" class="confluenceTd"><p> Reference identifier of a custom <a
> shape="rect" href="processor.html">Processor</a> to use for creating a new
> message (e.g., the "send a new message" mode). See below.
> </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>
> <code>copy</code> </p></td><td colspan="1" rowspan="1"
> class="confluenceTd"><p> <cod
e>true</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>
<strong>Camel 2.3</strong>: Whether to copy the <a shape="rect"
href="exchange.html">Exchange</a> before wire-tapping the message.
</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>
<code>onPrepareRef</code> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> <strong>Camel 2.8:</strong> Reference identifier of a
custom <a shape="rect" href="processor.html">Processor</a> to prepare the copy
of the <a shape="rect" href="exchange.html">Exchange</a> to be wire-tapped.
This allows you to do any custom logic, such as deep-cloning the message
payload. </p></td></tr></tbody></table></div>
<h3 id="WireTap-WireTapthreadpool">WireTap thread pool</h3><p>The <a
shape="rect" href="wire-tap.html">Wire Tap</a> uses a thread pool to process
the tapped messages. This thread pool will by default use the settings detailed
at <a shape="rect" href="threading-model.html">Threading Model</a>. In
particular, when the pool is exhausted (with all threads utilized), further
wiretaps will be executed synchronously by the calling thread. To remedy this,
you can configure an explicit thread pool on the <a shape="rect"
href="wire-tap.html">Wire Tap</a> having either a different rejection policy, a
larger worker queue, or more worker threads.</p><h3
id="WireTap-WireTapnode">WireTap node</h3><p>Camel's Wire Tap node supports two
flavors when tapping an <a shape="rect"
href="exchange.html">Exchange</a>:</p><p>-With the traditional Wire Tap, Camel
will copy the original <a shape="rect" href="exchange.html">Exchange</a> and
set its <a shape="rect" href="exchange-pattern.html">Exchange Pattern</a
> to <strong>InOnly</strong>, as we want the tapped <a shape="rect"
> href="exchange.html">Exchange</a> to be sent in a <em>fire and forget</em>
> style. The tapped <a shape="rect" href="exchange.html">Exchange</a> is then
> sent in a separate thread so it can run in parallel with the
> original.</p><p>-Camel also provides an option of sending a new <a
> shape="rect" href="exchange.html">Exchange</a> allowing you to populate it
> with new values.</p><h4
> id="WireTap-Sendingacopy(traditionalwiretap)">Sending a copy (traditional
> wiretap)</h4><p><strong>Using the <a shape="rect"
> href="fluent-builders.html">Fluent Builders</a></strong></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:start")
Modified: websites/production/camel/content/xmpp.html
==============================================================================
--- websites/production/camel/content/xmpp.html (original)
+++ websites/production/camel/content/xmpp.html Tue Feb 18 07:21:04 2014
@@ -97,8 +97,8 @@
</div></div><h3 id="XMPP-URIformat">URI format</h3><div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
<script class="theme: Default; brush: text; gutter: false"
type="syntaxhighlighter"><![CDATA[xmpp://[login@]hostname[:port][/participant][?Options]
]]></script>
-</div></div><p>The component supports both room based and private
person-person conversations.<br clear="none"> The component supports both
producer and consumer (you can get messages from XMPP or send messages to
XMPP). Consumer mode supports rooms starting.</p><p>You can append query
options to the URI in the following format,
<code>?option=value&option=value&...</code></p><h3
id="XMPP-Options">Options</h3><table class="confluenceTable"><tbody><tr><th
colspan="1" rowspan="1" class="confluenceTh"><p> Name </p></th><th colspan="1"
rowspan="1" class="confluenceTh"><p> Description </p></th></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p> <code>room</code> </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> If this option is specified,
the component will connect to MUC (Multi User Chat). Usually, the domain name
for MUC is different from the login domain. For example, if you are
<code>super...@jabber.org</code> and want to join the <code>krypton</code> ro
om, then the room URL is <code>kryp...@conference.jabber.org</code>. Note the
<code>conference</code> part.<br clear="none">
-It is not a requirement to provide the full room JID. If the <code>room</code>
parameter does not contain the <code>@</code> symbol, the domain part will be
discovered and added by Camel</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p> <code>user</code> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> User name (without server name). If not specified,
anonymous login will be attempted. </p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p> <code>password</code> </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> Password.
</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>
<code>resource</code> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> XMPP resource. The default is <code>Camel</code>.
</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>
<code>createAccount</code> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> If <code>true</code>, an attempt to create a
n account will be made. Default is <code>false</code>. </p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p> <code>participant</code>
</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> JID (Jabber ID)
of person to receive messages. <code>room</code> parameter has precedence over
<code>participant</code>. </p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p> <code>nickname</code> </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> Use nickname when joining room. If room is
specified and nickname is not, <code>user</code> will be used for the nickname.
</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>
<code>serviceName</code> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> The name of the service you are connecting to. For
Google Talk, this would be <code>gmail.com</code>. </p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p>
<code>testConnectionOnStartup</code> </p></td><td cols
pan="1" rowspan="1" class="confluenceTd"><p> <strong>Camel 2.11</strong>
Specifies whether to test the connection on startup. This is used to ensure
that the XMPP client has a valid connection to the XMPP server when the route
starts. Camel throws an exception on startup if a connection cannot be
established. When this option is set to false, Camel will attempt to establish
a "lazy" connection when needed by a producer, and will poll for a consumer
connection until the connection is established. Default is <code>true</code>.
</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>
<code>connectionPollDelay</code> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> <strong>Camel 2.11</strong> The amount of time in
seconds between polls to verify the health of the XMPP connection, or between
attempts to establish an initial consumer connection. Camel will try to
re-establish a connection if it has become inactive. Default is <code>10
seconds</code>.</p></td><
/tr></tbody></table>
+</div></div><p>The component supports both room based and private
person-person conversations.<br clear="none"> The component supports both
producer and consumer (you can get messages from XMPP or send messages to
XMPP). Consumer mode supports rooms starting.</p><p>You can append query
options to the URI in the following format,
<code>?option=value&option=value&...</code></p><h3
id="XMPP-Options">Options</h3><div class="table-wrap"><table
class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh"><p> Name </p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p> Description </p></th></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p> <code>room</code> </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> If this option is specified, the component
will connect to MUC (Multi User Chat). Usually, the domain name for MUC is
different from the login domain. For example, if you are
<code>super...@jabber.org</code> and want to join the
<code>krypton</code> room, then the room URL is
<code>kryp...@conference.jabber.org</code>. Note the <code>conference</code>
part.<br clear="none">
+It is not a requirement to provide the full room JID. If the <code>room</code>
parameter does not contain the <code>@</code> symbol, the domain part will be
discovered and added by Camel</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p> <code>user</code> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> User name (without server name). If not specified,
anonymous login will be attempted. </p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p> <code>password</code> </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> Password.
</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>
<code>resource</code> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> XMPP resource. The default is <code>Camel</code>.
</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>
<code>createAccount</code> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> If <code>true</code>, an attempt to create a
n account will be made. Default is <code>false</code>. </p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p> <code>participant</code>
</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> JID (Jabber ID)
of person to receive messages. <code>room</code> parameter has precedence over
<code>participant</code>. </p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p> <code>nickname</code> </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> Use nickname when joining room. If room is
specified and nickname is not, <code>user</code> will be used for the nickname.
</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>
<code>serviceName</code> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> The name of the service you are connecting to. For
Google Talk, this would be <code>gmail.com</code>. </p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p>
<code>testConnectionOnStartup</code> </p></td><td cols
pan="1" rowspan="1" class="confluenceTd"><p> <strong>Camel 2.11</strong>
Specifies whether to test the connection on startup. This is used to ensure
that the XMPP client has a valid connection to the XMPP server when the route
starts. Camel throws an exception on startup if a connection cannot be
established. When this option is set to false, Camel will attempt to establish
a "lazy" connection when needed by a producer, and will poll for a consumer
connection until the connection is established. Default is <code>true</code>.
</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>
<code>connectionPollDelay</code> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> <strong>Camel 2.11</strong> The amount of time in
seconds between polls to verify the health of the XMPP connection, or between
attempts to establish an initial consumer connection. Camel will try to
re-establish a connection if it has become inactive. Default is <code>10
seconds</code>.</p></td><
/tr></tbody></table></div>
<h3 id="XMPP-HeadersandsettingSubjectorLanguage">Headers and setting Subject
or Language</h3><p>Camel sets the message IN headers as properties on the XMPP
message. You can configure a <code>HeaderFilterStategy</code> if you need
custom filtering of headers.<br clear="none"> The <strong>Subject</strong> and
<strong>Language</strong> of the XMPP message are also set if they are provided
as IN headers.</p><h3 id="XMPP-Examples">Examples</h3><p>User
<code>superman</code> to join room <code>krypton</code> at <code>jabber</code>
server with password, <code>secret</code>:</p><div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
<script class="theme: Default; brush: text; gutter: false"
type="syntaxhighlighter"><![CDATA[xmpp://super...@jabber.org/?room=kryp...@conference.jabber.org&password=secret
]]></script>
