Author: buildbot
Date: Fri Jun 8 10:17:56 2012
New Revision: 820813
Log:
Production update by buildbot for camel
Modified:
websites/production/camel/content/cache/main.pageCache
websites/production/camel/content/websocket.html
Modified: websites/production/camel/content/cache/main.pageCache
==============================================================================
Binary files - no diff available.
Modified: websites/production/camel/content/websocket.html
==============================================================================
--- websites/production/camel/content/websocket.html (original)
+++ websites/production/camel/content/websocket.html Fri Jun 8 10:17:56 2012
@@ -92,43 +92,30 @@ websocket:<span class="code-comment">//h
<p>You can append query options to the URI in the following format,
<tt>?option=value&option=value&...</tt></p>
-<h3><a shape="rect" name="Websocket-Options"></a>Options</h3>
-
-<div class="confluenceTableSmall"><div class="table-wrap">
-<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh"> Name </th><th colspan="1" rowspan="1"
class="confluenceTh"> Default Value </th><th colspan="1" rowspan="1"
class="confluenceTh"> Description </th></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> sslContextParameters </td><td colspan="1" rowspan="1"
class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd"> Reference to a
<tt>org.apache.camel.util.jsse.SSLContextParameters</tt> 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>. <br
clear="none" class="atl-forced-newline"> </td></tr></tbody></table>
-</div>
-</div>
-
-<p>You can append query options to the URI in the following format,
<tt>?option=value&option=value&...</tt></p>
-
-<p>Here is some examples on How to pass the parameters</p>
+<h3><a shape="rect" name="Websocket-ComponentOptions"></a>Component
Options</h3>
-<p>To use ssl and websocket secure -->
websocket://localhost:8443?/test?sslContextParametersRef=#sslContextParameters</p>
-
-<h3><a shape="rect" name="Websocket-MessageHeaders"></a>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>
+<p>The <tt>WebsocketComponent</tt> can be configured prior to use, to setup
host, to act as a websocket server. </p>
<div class="confluenceTableSmall"><div class="table-wrap">
-<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh"> Key</th><th colspan="1" rowspan="1" class="confluenceTh">
Description </th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>WebsocketConstants.SEND_TO_ALL</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> Sends the message to all clients which are currently
connected. You can use the <tt>sendToAll</tt> option on the endpoint instead of
using this header. </td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>WebsocketConstants.CONNECTION_KEY</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> Sends the message to the client
with the given connection key. </td></tr></tbody></table>
+<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh"> Option </th><th colspan="1" rowspan="1"
class="confluenceTh"> Default </th><th colspan="1" rowspan="1"
class="confluenceTh"> Description </th></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> host </td><td colspan="1" rowspan="1"
class="confluenceTd"> 0.0.0.0 </td><td colspan="1" rowspan="1"
class="confluenceTd"> The hostname. </td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> port </td><td colspan="1" rowspan="1"
class="confluenceTd"> 9292 </td><td colspan="1" rowspan="1"
class="confluenceTd"> The port number. </td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"> staticResources </td><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> 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 se
rvice the static resources, eg such as an index.html file. If this option has
not been configured, then no server is started. </td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"> sslContextParameters </td><td colspan="1"
rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd"> Reference to a
<tt>org.apache.camel.util.jsse.SSLContextParameters</tt> 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>. <br
clear="none" class="atl-forced-newline"> </td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>enableJmx</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1"
rowspan="1" class="confluence
Td"> 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. </td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>sslKeyPassword</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>Consumer only</b>: The password for the keystore when
using SSL. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>sslPassword</tt> </td><td colspan="1" rowspan="1" class="confluenceTd">
<tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd">
<b>Consumer only</b>: The password when using SSL. </td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>sslKeystore</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <b>Consumer only</b>: The path to
the keystore. </td></tr><tr><t
d colspan="1" rowspan="1" class="confluenceTd"> <tt>minThreads</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <b>Consumer only</b>: To set a
value for minimum number of threads in server thread pool. </td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>maxThreads</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <b>Consumer only</b>: To set a
value for maximum number of threads in server thread pool. </td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>threadPool</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <b>Consumer only</b>: To use a
custom thread pool for the server. </td></tr></tbody></table>
</div>
</div>
-<h3><a shape="rect" name="Websocket-ComponentOptions"></a>Component
Options</h3>
+<h3><a shape="rect" name="Websocket-EndpointOptions"></a>Endpoint Options</h3>
-<p>The <tt>WebsocketComponent</tt> must be configured prior to use, to setup
host, to act as a websocket server. </p>
+<p>The <tt>WebsocketEndpoint</tt> can be configured prior to use</p>
<div class="confluenceTableSmall"><div class="table-wrap">
-<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh"> Option </th><th colspan="1" rowspan="1"
class="confluenceTh"> Default </th><th colspan="1" rowspan="1"
class="confluenceTh"> Description </th></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> Host </td><td colspan="1" rowspan="1"
class="confluenceTd"> 0.0.0.0 </td><td colspan="1" rowspan="1"
class="confluenceTd"> The hostname. </td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> Port </td><td colspan="1" rowspan="1"
class="confluenceTd"> 9292 </td><td colspan="1" rowspan="1"
class="confluenceTd"> The port number. </td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"> StaticResources </td><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> Path for static resources such as index.html
files etc. </td></tr></tbody></table>
+<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh"> Option </th><th colspan="1" rowspan="1"
class="confluenceTh"> Default </th><th colspan="1" rowspan="1"
class="confluenceTh"> Description </th></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> sslContextParameters </td><td colspan="1" rowspan="1"
class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd"> Reference to a
<tt>org.apache.camel.util.jsse.SSLContextParameters</tt> 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>. <br
clear="none" class="atl-forced-newline"> </td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"> sendToAll </td><td colspan="1" rowsp
an="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>Producer only:</b> To send to all websocket
subscribers. Can be used to configure on endpoint level, instead of having to
use the <tt>WebsocketConstants.SEND_TO_ALL</tt> header on the message.
</td></tr></tbody></table>
</div>
</div>
-<h3><a shape="rect" name="Websocket-EndpointOptions"></a>Endpoint Options</h3>
+<h3><a shape="rect" name="Websocket-MessageHeaders"></a>Message Headers</h3>
-<p>The <tt>WebsocketEndpoint</tt> can be configured prior to use</p>
+<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="confluenceTableSmall"><div class="table-wrap">
-<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh"> Option </th><th colspan="1" rowspan="1"
class="confluenceTh"> Default </th><th colspan="1" rowspan="1"
class="confluenceTh"> Description </th></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> sendToAll </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> To send to all websocket subscribers. Can be used to
configure on endpoint level, instead of having to use the
<tt>WebsocketConstants.SEND_TO_ALL</tt> header on the message.
</td></tr></tbody></table>
+<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh"> Key</th><th colspan="1" rowspan="1" class="confluenceTh">
Description </th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>WebsocketConstants.SEND_TO_ALL</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> Sends the message to all clients which are currently
connected. You can use the <tt>sendToAll</tt> option on the endpoint instead of
using this header. </td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>WebsocketConstants.CONNECTION_KEY</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> Sends the message to the client
with the given connection key. </td></tr></tbody></table>
</div>
</div>
@@ -230,7 +217,7 @@ commetdComponent.setSslContextParameters
<h3><a shape="rect" name="Websocket-SeeAlso"></a>See Also</h3>
<ul><li><a shape="rect" href="configuring-camel.html" title="Configuring
Camel">Configuring Camel</a></li><li><a shape="rect" href="component.html"
title="Component">Component</a></li><li><a shape="rect" href="endpoint.html"
title="Endpoint">Endpoint</a></li><li><a shape="rect"
href="getting-started.html" title="Getting Started">Getting
Started</a></li></ul>
-<ul class="alternate" type="square"><li><a shape="rect" href="ahc.html"
title="AHC">AHC</a></li></ul>
+<ul class="alternate" type="square"><li><a shape="rect" href="ahc.html"
title="AHC">AHC</a></li><li><a shape="rect" href="jetty.html"
title="Jetty">Jetty</a></li><li><a shape="rect"
href="twitter-websocket-example.html" title="Twitter Websocket Example">Twitter
Websocket Example</a> demonstrates how to poll a constant feed of twitter
searches and publish results in real time using web socket to a web
page.</li></ul>
</div>
</td>
<td valign="top">
