Modified: websites/production/camel/content/book-component-appendix.html
==============================================================================
--- websites/production/camel/content/book-component-appendix.html (original)
+++ websites/production/camel/content/book-component-appendix.html Sun Feb 1
07:19:29 2015
@@ -87,12 +87,7 @@
<tbody>
<tr>
<td valign="top" width="100%">
-<div class="wiki-content maincontent"><div class="chapter"
id="chapter-component-appendix">
-<h1 id="BookComponentAppendix-ComponentAppendix">Component Appendix</h1>
-
-<p>There now follows the documentation on each Camel component.</p>
-
-<h2 id="BookComponentAppendix-ActiveMQComponent">ActiveMQ Component</h2>
+<div class="wiki-content maincontent"><div class="chapter"
id="chapter-component-appendix"><h1
id="BookComponentAppendix-ComponentAppendix">Component Appendix</h1><p>There
now follows the documentation on each Camel component.</p><h2
id="BookComponentAppendix-ActiveMQComponent">ActiveMQ Component</h2>
<p>The ActiveMQ component allows messages to be sent to a <a shape="rect"
class="external-link" href="http://java.sun.com/products/jms/"
rel="nofollow">JMS</a> Queue or Topic or messages to be consumed from a JMS
Queue or Topic using <a shape="rect" class="external-link"
href="http://activemq.apache.org/" title="The most popular and powerful open
source message broker">Apache ActiveMQ</a>. </p>
@@ -367,9 +362,7 @@ droppable = false}
<h3 id="BookComponentAppendix-SeeAlso">See Also</h3>
-<ul><li><a shape="rect" href="configuring-camel.html">Configuring
Camel</a></li><li><a shape="rect"
href="component.html">Component</a></li><li><a shape="rect"
href="endpoint.html">Endpoint</a></li><li><a shape="rect"
href="getting-started.html">Getting Started</a></li></ul>
-<div class="error"><span class="error">Unable to render {include}</span> The
included page could not be found.</div>
-<h2 id="BookComponentAppendix-AMQP">AMQP</h2><p><strong>Available as of Camel
X.X</strong></p><p>The <strong>amqp:</strong> component supports the <a
shape="rect" class="external-link" href="http://www.amqp.org/"
rel="nofollow">AMQP protocol</a> using the Client API of the <a shape="rect"
class="external-link" href="http://qpid.apache.org/">Qpid</a> project. In case
you want to use AMQP with RabbitMQ you might also be interested in the <a
shape="rect" href="rabbitmq.html">Camel RabbitMQ</a> component.</p><p>Maven
users will need to add the following dependency to their <code>pom.xml</code>
for this component:</p><div class="code panel pdl" style="border-width:
1px;"><div class="codeContent panelContent pdl">
+<ul><li><a shape="rect" href="configuring-camel.html">Configuring
Camel</a></li><li><a shape="rect"
href="component.html">Component</a></li><li><a shape="rect"
href="endpoint.html">Endpoint</a></li><li><a shape="rect"
href="getting-started.html">Getting Started</a></li></ul> <div
class="error"><span class="error">Unable to render {include}</span> The
included page could not be found.</div> <h2
id="BookComponentAppendix-AMQP">AMQP</h2><p><strong>Available as of Camel
X.X</strong></p><p>The <strong>amqp:</strong> component supports the <a
shape="rect" class="external-link" href="http://www.amqp.org/"
rel="nofollow">AMQP protocol</a> using the Client API of the <a shape="rect"
class="external-link" href="http://qpid.apache.org/">Qpid</a> project. In case
you want to use AMQP with RabbitMQ you might also be interested in the <a
shape="rect" href="rabbitmq.html">Camel RabbitMQ</a> component.</p><p>Maven
users will need to add the following dependency to their <code>pom.xml</code>
for thi
s component:</p><div class="code panel pdl" style="border-width: 1px;"><div
class="codeContent panelContent pdl">
<script class="theme: Default; brush: xml; gutter: false"
type="syntaxhighlighter"><![CDATA[<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-amqp</artifactId>
@@ -380,8 +373,7 @@ droppable = false}
<script class="theme: Default; brush: java; gutter: false"
type="syntaxhighlighter"><![CDATA[amqp:[queue:|topic:]destinationName[?options]
]]></script>
</div></div><h3 id="BookComponentAppendix-AMQPOptions">AMQP Options</h3><p>You
can specify all of the various configuration options of the <a shape="rect"
href="jms.html">JMS</a> component after the destination name.</p><p></p><h3
id="BookComponentAppendix-SeeAlso.1">See Also</h3>
-<ul><li><a shape="rect" href="configuring-camel.html">Configuring
Camel</a></li><li><a shape="rect"
href="component.html">Component</a></li><li><a shape="rect"
href="endpoint.html">Endpoint</a></li><li><a shape="rect"
href="getting-started.html">Getting Started</a></li></ul>
-<h2 id="BookComponentAppendix-SQSComponent">SQS
Component</h2><p><strong>Available as of Camel 2.6</strong></p><p>The sqs
component supports sending and receiving messages to <a shape="rect"
class="external-link" href="http://aws.amazon.com/sqs" rel="nofollow">Amazon's
SQS</a> service.</p> <div class="aui-message hint shadowed
information-macro">
+<ul><li><a shape="rect" href="configuring-camel.html">Configuring
Camel</a></li><li><a shape="rect"
href="component.html">Component</a></li><li><a shape="rect"
href="endpoint.html">Endpoint</a></li><li><a shape="rect"
href="getting-started.html">Getting Started</a></li></ul> <h2
id="BookComponentAppendix-SQSComponent">SQS Component</h2><p><strong>Available
as of Camel 2.6</strong></p><p>The sqs component supports sending and receiving
messages to <a shape="rect" class="external-link"
href="http://aws.amazon.com/sqs" rel="nofollow">Amazon's SQS</a> service.</p>
<div class="aui-message hint shadowed information-macro">
<p class="title">Prerequisites</p>
<span class="aui-icon icon-hint">Icon</span>
<div class="message-content">
@@ -426,8 +418,7 @@ registry.bind("client", client
.to("mock:result");
]]></script>
</div></div><p>In the above code, if an exchange doesn't have an appropriate
header, it will not make it through the filter AND also not be deleted from the
SQS queue. After 5000 miliseconds, the message will become visible to other
consumers.</p><p></p><h3 id="BookComponentAppendix-SeeAlso.2">See Also</h3>
-<ul><li><a shape="rect" href="configuring-camel.html">Configuring
Camel</a></li><li><a shape="rect"
href="component.html">Component</a></li><li><a shape="rect"
href="endpoint.html">Endpoint</a></li><li><a shape="rect"
href="getting-started.html">Getting Started</a></li></ul><ul
class="alternate"><li><a shape="rect" href="aws.html">AWS
Component</a></li></ul>
-<h2 id="BookComponentAppendix-AtomComponent">Atom Component</h2>
+<ul><li><a shape="rect" href="configuring-camel.html">Configuring
Camel</a></li><li><a shape="rect"
href="component.html">Component</a></li><li><a shape="rect"
href="endpoint.html">Endpoint</a></li><li><a shape="rect"
href="getting-started.html">Getting Started</a></li></ul><ul
class="alternate"><li><a shape="rect" href="aws.html">AWS
Component</a></li></ul> <h2 id="BookComponentAppendix-AtomComponent">Atom
Component</h2>
<p>The <strong>atom:</strong> component is used for polling Atom feeds.</p>
@@ -584,8 +575,7 @@ public class BlogService {
<h3 id="BookComponentAppendix-SeeAlso.3">See Also</h3>
<ul><li><a shape="rect" href="configuring-camel.html">Configuring
Camel</a></li><li><a shape="rect"
href="component.html">Component</a></li><li><a shape="rect"
href="endpoint.html">Endpoint</a></li><li><a shape="rect"
href="getting-started.html">Getting Started</a></li></ul>
-<ul class="alternate"><li><a shape="rect" href="rss.html">RSS</a></li></ul>
-<h2 id="BookComponentAppendix-BeanComponent">Bean Component</h2>
+<ul class="alternate"><li><a shape="rect" href="rss.html">RSS</a></li></ul>
<h2 id="BookComponentAppendix-BeanComponent">Bean Component</h2>
<p>The <strong>bean:</strong> component binds beans to Camel message
exchanges.</p>
@@ -722,9 +712,7 @@ from("direct:start").bean(Exam
<h3 id="BookComponentAppendix-SeeAlso.4">See Also</h3>
<ul><li><a shape="rect" href="configuring-camel.html">Configuring
Camel</a></li><li><a shape="rect"
href="component.html">Component</a></li><li><a shape="rect"
href="endpoint.html">Endpoint</a></li><li><a shape="rect"
href="getting-started.html">Getting Started</a></li></ul>
-<ul><li><a shape="rect" href="class.html">Class</a> component</li><li><a
shape="rect" href="bean-binding.html">Bean Binding</a></li><li><a shape="rect"
href="bean-integration.html">Bean Integration</a></li></ul>
-<div class="error"><span class="error">Unable to render {include}</span> The
included page could not be found.</div>
-<h2 id="BookComponentAppendix-BrowseComponent">Browse Component</h2>
+<ul><li><a shape="rect" href="class.html">Class</a> component</li><li><a
shape="rect" href="bean-binding.html">Bean Binding</a></li><li><a shape="rect"
href="bean-integration.html">Bean Integration</a></li></ul> <div
class="error"><span class="error">Unable to render {include}</span> The
included page could not be found.</div> <h2
id="BookComponentAppendix-BrowseComponent">Browse Component</h2>
<p>The Browse component provides a simple <a shape="rect"
href="browsableendpoint.html">BrowsableEndpoint</a> which can be useful for
testing, visualisation tools or debugging. The exchanges sent to the endpoint
are all available to be browsed.</p>
@@ -768,8 +756,7 @@ browse:someName[?options]
<h3 id="BookComponentAppendix-SeeAlso.5">See Also</h3>
-<ul><li><a shape="rect" href="configuring-camel.html">Configuring
Camel</a></li><li><a shape="rect"
href="component.html">Component</a></li><li><a shape="rect"
href="endpoint.html">Endpoint</a></li><li><a shape="rect"
href="getting-started.html">Getting Started</a></li></ul>
-<h2 id="BookComponentAppendix-CacheComponent">Cache
Component</h2><p><strong>Available as of Camel 2.1</strong></p><p>The
<strong>cache</strong> component enables you to perform caching operations
using EHCache as the Cache Implementation. The cache itself is created on
demand or if a cache of that name already exists then it is simply utilized
with its original settings.</p><p>This component supports producer and event
based consumer endpoints.</p><p>The Cache consumer is an event based consumer
and can be used to listen and respond to specific cache activities. If you need
to perform selections from a pre-existing cache, use the processors defined for
the cache component.</p><p>Maven users will need to add the following
dependency to their <code>pom.xml</code> for this component:</p><div
class="code panel pdl" style="border-width: 1px;"><div class="codeContent
panelContent pdl">
+<ul><li><a shape="rect" href="configuring-camel.html">Configuring
Camel</a></li><li><a shape="rect"
href="component.html">Component</a></li><li><a shape="rect"
href="endpoint.html">Endpoint</a></li><li><a shape="rect"
href="getting-started.html">Getting Started</a></li></ul> <h2
id="BookComponentAppendix-CacheComponent">Cache
Component</h2><p><strong>Available as of Camel 2.1</strong></p><p>The
<strong>cache</strong> component enables you to perform caching operations
using EHCache as the Cache Implementation. The cache itself is created on
demand or if a cache of that name already exists then it is simply utilized
with its original settings.</p><p>This component supports producer and event
based consumer endpoints.</p><p>The Cache consumer is an event based consumer
and can be used to listen and respond to specific cache activities. If you need
to perform selections from a pre-existing cache, use the processors defined for
the cache component.</p><p>Maven users will need to add the
following dependency to their <code>pom.xml</code> for this
component:</p><div class="code panel pdl" style="border-width: 1px;"><div
class="codeContent panelContent pdl">
<script class="theme: Default; brush: xml; gutter: false"
type="syntaxhighlighter"><![CDATA[<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-cache</artifactId>
@@ -951,8 +938,7 @@ browse:someName[?options]
<p>It might be useful to read the <a shape="rect"
class="external-link" href="http://ehcache.org/documentation"
rel="nofollow">EHCache manual</a> to get a better understanding of the Camel
Cache replication mechanism.</p>
</div>
</div>
-<h4 id="BookComponentAppendix-Example:JMScachereplication">Example: JMS cache
replication</h4><p>JMS replication is the most powerful and secured replication
method. Used together with Camel Cache replication makes it also rather
simple.<br clear="none"> An example is available on <a shape="rect"
href="cachereplicationjmsexample.html">a separate page</a>.</p>
-<h2 id="BookComponentAppendix-ClassComponent">Class Component</h2>
+<h4 id="BookComponentAppendix-Example:JMScachereplication">Example: JMS cache
replication</h4><p>JMS replication is the most powerful and secured replication
method. Used together with Camel Cache replication makes it also rather
simple.<br clear="none"> An example is available on <a shape="rect"
href="cachereplicationjmsexample.html">a separate page</a>.</p> <h2
id="BookComponentAppendix-ClassComponent">Class Component</h2>
<p><strong>Available as of Camel 2.4</strong></p>
<p>The <strong>class:</strong> component binds beans to Camel message
exchanges. It works in the same way as the <a shape="rect"
href="bean.html">Bean</a> component but instead of looking up beans from a <a
shape="rect" href="registry.html">Registry</a> it creates the bean based on the
class name.</p>
@@ -1023,8 +1009,7 @@ For example to use the <code>MyFooBean</
<h3 id="BookComponentAppendix-SeeAlso.6">See Also</h3>
<ul><li><a shape="rect" href="configuring-camel.html">Configuring
Camel</a></li><li><a shape="rect"
href="component.html">Component</a></li><li><a shape="rect"
href="endpoint.html">Endpoint</a></li><li><a shape="rect"
href="getting-started.html">Getting Started</a></li></ul>
-<ul><li><a shape="rect" href="bean.html">Bean</a></li><li><a shape="rect"
href="bean-binding.html">Bean Binding</a></li><li><a shape="rect"
href="bean-integration.html">Bean Integration</a></li></ul>
-<h2 id="BookComponentAppendix-CometdComponent">Cometd Component</h2><p>The
<strong>cometd:</strong> component is a transport for working with the <a
shape="rect" class="external-link" href="http://www.mortbay.org/jetty"
rel="nofollow">jetty</a> implementation of the <a shape="rect"
class="external-link"
href="http://docs.codehaus.org/display/JETTY/Cometd+%28aka+Bayeux%29"
rel="nofollow">cometd/bayeux protocol</a>.<br clear="none"> Using this
component in combination with the dojo toolkit library it's possible to push
Camel messages directly into the browser using an AJAX based
mechanism.</p><p>Maven users will need to add the following dependency to their
<code>pom.xml</code> for this component:</p><div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<ul><li><a shape="rect" href="bean.html">Bean</a></li><li><a shape="rect"
href="bean-binding.html">Bean Binding</a></li><li><a shape="rect"
href="bean-integration.html">Bean Integration</a></li></ul> <h2
id="BookComponentAppendix-CometdComponent">Cometd Component</h2><p>The
<strong>cometd:</strong> component is a transport for working with the <a
shape="rect" class="external-link" href="http://www.mortbay.org/jetty"
rel="nofollow">jetty</a> implementation of the <a shape="rect"
class="external-link"
href="http://docs.codehaus.org/display/JETTY/Cometd+%28aka+Bayeux%29"
rel="nofollow">cometd/bayeux protocol</a>.<br clear="none"> Using this
component in combination with the dojo toolkit library it's possible to push
Camel messages directly into the browser using an AJAX based
mechanism.</p><p>Maven users will need to add the following dependency to their
<code>pom.xml</code> for this component:</p><div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelConte
nt pdl">
<script class="theme: Default; brush: xml; gutter: false"
type="syntaxhighlighter"><![CDATA[<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-cometd</artifactId>
@@ -1082,8 +1067,7 @@ commetdComponent.setSslContextParameters
<to
uri="cometds://127.0.0.1:443/service/test?baseResource=file:./target/test-classes/webapp&timeout=240000&interval=0&maxInterval=30000&multiFrameInterval=1500&jsonCommented=true&logLevel=2"/>...
]]></script>
</div></div><p></p><h3 id="BookComponentAppendix-SeeAlso.7">See Also</h3>
-<ul><li><a shape="rect" href="configuring-camel.html">Configuring
Camel</a></li><li><a shape="rect"
href="component.html">Component</a></li><li><a shape="rect"
href="endpoint.html">Endpoint</a></li><li><a shape="rect"
href="getting-started.html">Getting Started</a></li></ul>
-<h2 id="BookComponentAppendix-ContextComponent">Context Component</h2>
+<ul><li><a shape="rect" href="configuring-camel.html">Configuring
Camel</a></li><li><a shape="rect"
href="component.html">Component</a></li><li><a shape="rect"
href="endpoint.html">Endpoint</a></li><li><a shape="rect"
href="getting-started.html">Getting Started</a></li></ul> <h2
id="BookComponentAppendix-ContextComponent">Context Component</h2>
<p><strong>Available as of Camel 2.7</strong></p>
@@ -1199,8 +1183,7 @@ registry.bind("accounts", blac
<p>A context component instance can have many public input and output
endpoints that can be accessed from outside it's CamelContext. When there are
many it is recommended that you use logical names for them to hide the
middleware as shown above.</p>
-<p>However when there is only one input, output or error/dead letter endpoint
in a component we recommend using the common posix shell names
<strong>in</strong>, <strong>out</strong> and <strong>err</strong></p>
-<h2 id="BookComponentAppendix-CryptocomponentforDigitalSignatures">Crypto
component for Digital Signatures</h2><p><strong>Available as of Camel
2.3</strong></p><p>With Camel cryptographic endpoints and Java's Cryptographic
extension it is easy to create Digital Signatures for <a shape="rect"
href="exchange.html">Exchange</a>s. Camel provides a pair of flexible endpoints
which get used in concert to create a signature for an exchange in one part of
the exchange's workflow and then verify the signature in a later part of the
workflow.</p><p>Maven users will need to add the following dependency to their
<code>pom.xml</code> for this component:</p><div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<p>However when there is only one input, output or error/dead letter endpoint
in a component we recommend using the common posix shell names
<strong>in</strong>, <strong>out</strong> and <strong>err</strong></p> <h2
id="BookComponentAppendix-CryptocomponentforDigitalSignatures">Crypto component
for Digital Signatures</h2><p><strong>Available as of Camel
2.3</strong></p><p>With Camel cryptographic endpoints and Java's Cryptographic
extension it is easy to create Digital Signatures for <a shape="rect"
href="exchange.html">Exchange</a>s. Camel provides a pair of flexible endpoints
which get used in concert to create a signature for an exchange in one part of
the exchange's workflow and then verify the signature in a later part of the
workflow.</p><p>Maven users will need to add the following dependency to their
<code>pom.xml</code> for this component:</p><div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
<script class="theme: Default; brush: xml; gutter: false"
type="syntaxhighlighter"><![CDATA[<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-crypto</artifactId>
@@ -1346,8 +1329,7 @@ signed.getIn().setHeader(KEYSTORE_ALIAS,
template.send("direct:alias-verify", signed);
]]></script>
</div></div><p></p><h3 id="BookComponentAppendix-SeeAlso.8">See Also</h3>
-<ul><li><a shape="rect" href="configuring-camel.html">Configuring
Camel</a></li><li><a shape="rect"
href="component.html">Component</a></li><li><a shape="rect"
href="endpoint.html">Endpoint</a></li><li><a shape="rect"
href="getting-started.html">Getting Started</a></li></ul><ul><li><a
shape="rect" href="crypto.html">Crypto</a> Crypto is also available as a <a
shape="rect" href="data-format.html">Data Format</a></li></ul>
-<h2 id="BookComponentAppendix-CXFComponent">CXF Component</h2> <div
class="aui-message warning shadowed information-macro">
+<ul><li><a shape="rect" href="configuring-camel.html">Configuring
Camel</a></li><li><a shape="rect"
href="component.html">Component</a></li><li><a shape="rect"
href="endpoint.html">Endpoint</a></li><li><a shape="rect"
href="getting-started.html">Getting Started</a></li></ul><ul><li><a
shape="rect" href="crypto.html">Crypto</a> Crypto is also available as a <a
shape="rect" href="data-format.html">Data Format</a></li></ul> <h2
id="BookComponentAppendix-CXFComponent">CXF Component</h2> <div
class="aui-message warning shadowed information-macro">
<span class="aui-icon icon-warning">Icon</span>
<div class="message-content">
<p>When using CXF as a consumer, the <a
shape="rect" href="cxf-bean-component.html">CXF Bean Component</a> allows you
to factor out how message payloads are received from their processing as a
RESTful or SOAP web service. This has the potential of using a multitude of
transports to consume web services. The bean component's configuration is also
simpler and provides the fastest method to implement web services using Camel
and CXF.</p>
@@ -1360,11 +1342,11 @@ template.send("direct:alias-verify&
</div>
</div>
<p>The <strong>cxf:</strong> component provides integration with <a
shape="rect" href="http://cxf.apache.org">Apache CXF</a> for connecting to
JAX-WS services hosted in CXF.</p><p><style type="text/css">/*<![CDATA[*/
-div.rbtoc1422440314485 {padding: 0px;}
-div.rbtoc1422440314485 ul {list-style: disc;margin-left: 0px;}
-div.rbtoc1422440314485 li {margin-left: 0px;padding-left: 0px;}
+div.rbtoc1422775101202 {padding: 0px;}
+div.rbtoc1422775101202 ul {list-style: disc;margin-left: 0px;}
+div.rbtoc1422775101202 li {margin-left: 0px;padding-left: 0px;}
-/*]]>*/</style></p><div class="toc-macro rbtoc1422440314485">
+/*]]>*/</style></p><div class="toc-macro rbtoc1422775101202">
<ul class="toc-indentation"><li><a shape="rect" href="#CXF-CXFComponent">CXF
Component</a>
<ul class="toc-indentation"><li><a shape="rect" href="#CXF-URIformat">URI
format</a></li><li><a shape="rect" href="#CXF-Options">Options</a>
<ul class="toc-indentation"><li><a shape="rect"
href="#CXF-Thedescriptionsofthedataformats">The descriptions of the
dataformats</a>
@@ -1954,8 +1936,7 @@ public static class MyProcessor implemen
</cxf:properties>
</cxf:cxfEndpoint>]]></script>
</div></div><p>It is noted that the default CXF dispatch client does not send
a specific SOAPAction header. Therefore, when the target service requires a
specific SOAPAction value, it is supplied in the Camel header using the key
SOAPAction (case-insensitive).</p><p> </p><p></p><h3
id="BookComponentAppendix-SeeAlso.9">See Also</h3>
-<ul><li><a shape="rect" href="configuring-camel.html">Configuring
Camel</a></li><li><a shape="rect"
href="component.html">Component</a></li><li><a shape="rect"
href="endpoint.html">Endpoint</a></li><li><a shape="rect"
href="getting-started.html">Getting Started</a></li></ul>
-<h2 id="BookComponentAppendix-CXFBeanComponent">CXF Bean Component</h2><p>The
<strong>cxfbean:</strong> component allows other Camel endpoints to send
exchange and invoke Web service bean objects. <strong>Currently, it only
supports JAX-RS and JAX-WS (new to Camel 2.1) annotated service
beans.</strong></p> <div class="aui-message hint shadowed information-macro">
+<ul><li><a shape="rect" href="configuring-camel.html">Configuring
Camel</a></li><li><a shape="rect"
href="component.html">Component</a></li><li><a shape="rect"
href="endpoint.html">Endpoint</a></li><li><a shape="rect"
href="getting-started.html">Getting Started</a></li></ul> <h2
id="BookComponentAppendix-CXFBeanComponent">CXF Bean Component</h2><p>The
<strong>cxfbean:</strong> component allows other Camel endpoints to send
exchange and invoke Web service bean objects. <strong>Currently, it only
supports JAX-RS and JAX-WS (new to Camel 2.1) annotated service
beans.</strong></p> <div class="aui-message hint shadowed information-macro">
<span class="aui-icon icon-hint">Icon</span>
<div class="message-content">
<p><code>CxfBeanEndpoint</code> is a
<code>ProcessorEndpoint</code> so it has no consumers. It works similarly to a
Bean component.</p>
@@ -1999,8 +1980,7 @@ public static class MyProcessor implemen
<bean class="org.apache.camel.wsdl_first.PersonImpl"
id="jaxwsBean" />
]]></script>
-</div></div><p>That's it. Once the route is started, the web service is ready
for business. A HTTP client can make a request and receive response.</p>
-<h2 id="BookComponentAppendix-CXFRSComponent">CXFRS Component</h2> <div
class="aui-message warning shadowed information-macro">
+</div></div><p>That's it. Once the route is started, the web service is ready
for business. A HTTP client can make a request and receive response.</p> <h2
id="BookComponentAppendix-CXFRSComponent">CXFRS Component</h2> <div
class="aui-message warning shadowed information-macro">
<span class="aui-icon icon-warning">Icon</span>
<div class="message-content">
<p>When using CXF as a consumer, the <a
shape="rect" href="cxf-bean-component.html">CXF Bean Component</a> allows you
to factor out how message payloads are received from their processing as a
RESTful or SOAP web service. This has the potential of using a multitude of
transports to consume web services. The bean component's configuration is also
simpler and provides the fastest method to implement web services using Camel
and CXF.</p>
@@ -2264,8 +2244,7 @@ queryMap.put("q1", "new&q
queryMap.put("q2", "world");
inMessage.setHeader(CxfConstants.CAMEL_CXF_RS_QUERY_MAP, queryMap);
]]></script>
-</div></div>
-<h2 id="BookComponentAppendix-DataSetComponent">DataSet Component</h2>
+</div></div> <h2 id="BookComponentAppendix-DataSetComponent">DataSet
Component</h2>
<a shape="rect" href="testing.html">Testing</a> of distributed and
asynchronous processing is notoriously difficult. The <a shape="rect"
href="mock.html">Mock</a>, <a shape="rect" href="test.html">Test</a> and <a
shape="rect" href="dataset.html">DataSet</a> endpoints work great with the <a
shape="rect" href="testing.html">Camel Testing Framework</a> to simplify your
unit and integration testing using <a shape="rect"
href="enterprise-integration-patterns.html">Enterprise Integration Patterns</a>
and Camel's large range of <a shape="rect"
href="components.html">Components</a> together with the powerful <a
shape="rect" href="bean-integration.html">Bean Integration</a>.
@@ -2327,8 +2306,7 @@ from("activemq:SomeQueue").to(
<h3 id="BookComponentAppendix-SeeAlso.10">See Also</h3>
<ul><li><a shape="rect" href="configuring-camel.html">Configuring
Camel</a></li><li><a shape="rect"
href="component.html">Component</a></li><li><a shape="rect"
href="endpoint.html">Endpoint</a></li><li><a shape="rect"
href="getting-started.html">Getting Started</a></li></ul>
-<ul><li><a shape="rect" href="spring-testing.html">Spring Testing</a></li></ul>
-<h2 id="BookComponentAppendix-Db4oComponent">Db4o Component</h2>
+<ul><li><a shape="rect" href="spring-testing.html">Spring
Testing</a></li></ul> <h2 id="BookComponentAppendix-Db4oComponent">Db4o
Component</h2>
<p><strong>Available as of Camel 2.5</strong></p>
<p>The <strong>db4o:</strong> component allows you to work with <a
shape="rect" class="external-link" href="http://www.db4o.com"
rel="nofollow">db4o</a> NoSQL database. The camel-db4o library is provided by
the <a shape="rect" class="external-link"
href="http://code.google.com/p/camel-extra/" rel="nofollow">Camel Extra</a>
project which hosts all *GPL related components for Camel.</p>
@@ -2359,8 +2337,7 @@ db4o:className[?options]
</div>
<h3 id="BookComponentAppendix-SeeAlso.11">See Also</h3>
-<ul><li><a shape="rect" href="configuring-camel.html">Configuring
Camel</a></li><li><a shape="rect"
href="component.html">Component</a></li><li><a shape="rect"
href="endpoint.html">Endpoint</a></li><li><a shape="rect"
href="getting-started.html">Getting Started</a></li></ul>
-<h2 id="BookComponentAppendix-DirectComponent">Direct Component</h2><p>The
<strong>direct:</strong> component provides direct, synchronous invocation of
any consumers when a producer sends a message exchange.<br clear="none"> This
endpoint can be used to connect existing routes in the <strong>same</strong>
camel context.</p> <div class="aui-message success shadowed
information-macro">
+<ul><li><a shape="rect" href="configuring-camel.html">Configuring
Camel</a></li><li><a shape="rect"
href="component.html">Component</a></li><li><a shape="rect"
href="endpoint.html">Endpoint</a></li><li><a shape="rect"
href="getting-started.html">Getting Started</a></li></ul> <h2
id="BookComponentAppendix-DirectComponent">Direct Component</h2><p>The
<strong>direct:</strong> component provides direct, synchronous invocation of
any consumers when a producer sends a message exchange.<br clear="none"> This
endpoint can be used to connect existing routes in the <strong>same</strong>
camel context.</p> <div class="aui-message success shadowed
information-macro">
<p class="title">Asynchronous</p>
<span class="aui-icon icon-success">Icon</span>
<div class="message-content">
@@ -2400,8 +2377,7 @@ from("direct:processOrder")
</route>
]]></script>
</div></div><p>See also samples from the <a shape="rect"
href="seda.html">SEDA</a> component, how they can be used
together.</p><p></p><h3 id="BookComponentAppendix-SeeAlso.12">See Also</h3>
-<ul><li><a shape="rect" href="configuring-camel.html">Configuring
Camel</a></li><li><a shape="rect"
href="component.html">Component</a></li><li><a shape="rect"
href="endpoint.html">Endpoint</a></li><li><a shape="rect"
href="getting-started.html">Getting Started</a></li></ul><ul
class="alternate"><li><a shape="rect" href="seda.html">SEDA</a></li><li><a
shape="rect" href="vm.html">VM</a></li></ul>
-<h2 id="BookComponentAppendix-DNS">DNS</h2><p><strong>Available as of Camel
2.7</strong></p><p>This is an additional component for Camel to run DNS
queries, using DNSJava. The component is a thin layer on top of <a shape="rect"
class="external-link" href="http://www.xbill.org/dnsjava/"
rel="nofollow">DNSJava</a>.<br clear="none"> The component offers the following
operations:</p><ul class="alternate"><li>ip, to resolve a domain by its
ip</li><li>lookup, to lookup information about the domain</li><li>dig, to run
DNS queries</li></ul> <div class="aui-message hint shadowed
information-macro">
+<ul><li><a shape="rect" href="configuring-camel.html">Configuring
Camel</a></li><li><a shape="rect"
href="component.html">Component</a></li><li><a shape="rect"
href="endpoint.html">Endpoint</a></li><li><a shape="rect"
href="getting-started.html">Getting Started</a></li></ul><ul
class="alternate"><li><a shape="rect" href="seda.html">SEDA</a></li><li><a
shape="rect" href="vm.html">VM</a></li></ul> <h2
id="BookComponentAppendix-DNS">DNS</h2><p><strong>Available as of Camel
2.7</strong></p><p>This is an additional component for Camel to run DNS
queries, using DNSJava. The component is a thin layer on top of <a shape="rect"
class="external-link" href="http://www.xbill.org/dnsjava/"
rel="nofollow">DNSJava</a>.<br clear="none"> The component offers the following
operations:</p><ul class="alternate"><li>ip, to resolve a domain by its
ip</li><li>lookup, to lookup information about the domain</li><li>dig, to run
DNS queries</li></ul> <div class="aui-message hint shadowed
information-macro"
>
<p class="title">Requires SUN JVM</p>
<span class="aui-icon icon-hint">Icon</span>
<div class="message-content">
@@ -2438,8 +2414,7 @@ from("direct:processOrder")
</route>
]]></script>
</div></div><p>The query must be provided in the header with key
<code>"dns.query"</code>.</p><p></p><h3
id="BookComponentAppendix-SeeAlso.13">See Also</h3>
-<ul><li><a shape="rect" href="configuring-camel.html">Configuring
Camel</a></li><li><a shape="rect"
href="component.html">Component</a></li><li><a shape="rect"
href="endpoint.html">Endpoint</a></li><li><a shape="rect"
href="getting-started.html">Getting Started</a></li></ul>
-<h2 id="BookComponentAppendix-EJBComponent">EJB Component</h2>
+<ul><li><a shape="rect" href="configuring-camel.html">Configuring
Camel</a></li><li><a shape="rect"
href="component.html">Component</a></li><li><a shape="rect"
href="endpoint.html">Endpoint</a></li><li><a shape="rect"
href="getting-started.html">Getting Started</a></li></ul> <h2
id="BookComponentAppendix-EJBComponent">EJB Component</h2>
<p><strong>Available as of Camel 2.4</strong></p>
<p>The <strong>ejb:</strong> component binds EJBs to Camel message
exchanges.</p>
@@ -2599,8 +2574,7 @@ However if you need to access a applicat
<h3 id="BookComponentAppendix-SeeAlso.14">See Also</h3>
<ul><li><a shape="rect" href="configuring-camel.html">Configuring
Camel</a></li><li><a shape="rect"
href="component.html">Component</a></li><li><a shape="rect"
href="endpoint.html">Endpoint</a></li><li><a shape="rect"
href="getting-started.html">Getting Started</a></li></ul>
-<ul><li><a shape="rect" href="bean.html">Bean</a></li><li><a shape="rect"
href="bean-binding.html">Bean Binding</a></li><li><a shape="rect"
href="bean-integration.html">Bean Integration</a></li></ul>
-<h2 id="BookComponentAppendix-Esper">Esper</h2><p>The Esper component supports
the <a shape="rect" class="external-link" href="http://esper.codehaus.org"
rel="nofollow">Esper Library</a> for Event Stream Processing. The
<strong>camel-esper</strong> library is provided by the <a shape="rect"
class="external-link" href="http://code.google.com/p/camel-extra/"
rel="nofollow">Camel Extra</a> project which hosts all *GPL related components
for Camel.</p><h3 id="BookComponentAppendix-URIformat.18">URI format</h3><div
class="code panel pdl" style="border-width: 1px;"><div class="codeContent
panelContent pdl">
+<ul><li><a shape="rect" href="bean.html">Bean</a></li><li><a shape="rect"
href="bean-binding.html">Bean Binding</a></li><li><a shape="rect"
href="bean-integration.html">Bean Integration</a></li></ul> <h2
id="BookComponentAppendix-Esper">Esper</h2><p>The Esper component supports the
<a shape="rect" class="external-link" href="http://esper.codehaus.org"
rel="nofollow">Esper Library</a> for Event Stream Processing. The
<strong>camel-esper</strong> library is provided by the <a shape="rect"
class="external-link" href="http://code.google.com/p/camel-extra/"
rel="nofollow">Camel Extra</a> project which hosts all *GPL related components
for Camel.</p><h3 id="BookComponentAppendix-URIformat.18">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[esper:name[?options]
]]></script>
</div></div><p>When consuming from an Esper endpoint you must specify a
<strong>pattern</strong> or <strong>eql</strong> statement to query the event
stream.</p><p>Pattern example:</p><div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
@@ -2622,9 +2596,7 @@ To configure Esper via a configuration f
EventBean oldEvent = exchange.getIn(EsperMessage.class).getOldEvent();
]]></script>
</div></div><p>By default if you get the body of
<code>org.apacheextras.camel.component.esper.EsperMessage</code> it returns the
new <code>EventBean</code> as in previous versions.</p><h3
id="BookComponentAppendix-Demo">Demo</h3><p>There is a <a shape="rect"
class="external-link"
href="http://code.google.com/p/camel-extra/wiki/EsperDemo" rel="nofollow">demo
which shows how to work with ActiveMQ, Camel and Esper</a> in the <a
shape="rect" class="external-link" href="http://code.google.com/p/camel-extra/"
rel="nofollow">Camel Extra</a> project</p><p></p><h3
id="BookComponentAppendix-SeeAlso.15">See Also</h3>
-<ul><li><a shape="rect" href="configuring-camel.html">Configuring
Camel</a></li><li><a shape="rect"
href="component.html">Component</a></li><li><a shape="rect"
href="endpoint.html">Endpoint</a></li><li><a shape="rect"
href="getting-started.html">Getting Started</a></li></ul><ul><li><a
shape="rect" class="external-link"
href="http://code.google.com/p/camel-extra/wiki/EsperDemo" rel="nofollow">Esper
Camel Demo</a></li></ul>
-<div class="error"><span class="error">Unable to render {include}</span> The
included page could not be found.</div>
-<h2 id="BookComponentAppendix-FileComponent">File Component</h2><p>The File
component provides access to file systems, allowing files to be processed by
any other Camel <a shape="rect" href="components.html">Components</a> or
messages from other components to be saved to disk.</p><h3
id="BookComponentAppendix-URIformat.19">URI format</h3><div class="code panel
pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<ul><li><a shape="rect" href="configuring-camel.html">Configuring
Camel</a></li><li><a shape="rect"
href="component.html">Component</a></li><li><a shape="rect"
href="endpoint.html">Endpoint</a></li><li><a shape="rect"
href="getting-started.html">Getting Started</a></li></ul><ul><li><a
shape="rect" class="external-link"
href="http://code.google.com/p/camel-extra/wiki/EsperDemo" rel="nofollow">Esper
Camel Demo</a></li></ul> <div class="error"><span class="error">Unable to
render {include}</span> The included page could not be found.</div> <h2
id="BookComponentAppendix-FileComponent">File Component</h2><p>The File
component provides access to file systems, allowing files to be processed by
any other Camel <a shape="rect" href="components.html">Components</a> or
messages from other components to be saved to disk.</p><h3
id="BookComponentAppendix-URIformat.19">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[file:directoryName[?options]
]]></script>
</div></div><p>or</p><div class="code panel pdl" style="border-width:
1px;"><div class="codeContent panelContent pdl">
@@ -3151,8 +3123,7 @@ protected RouteBuilder createRouteBuilde
</div>
</div>
<h3 id="BookComponentAppendix-Debuglogging">Debug logging</h3><p>This
component has log level <strong>TRACE</strong> that can be helpful if you have
problems.</p><p></p><h3 id="BookComponentAppendix-SeeAlso.16">See Also</h3>
-<ul><li><a shape="rect" href="configuring-camel.html">Configuring
Camel</a></li><li><a shape="rect"
href="component.html">Component</a></li><li><a shape="rect"
href="endpoint.html">Endpoint</a></li><li><a shape="rect"
href="getting-started.html">Getting Started</a></li></ul><ul
class="alternate"><li><a shape="rect" href="file-language.html">File
Language</a></li><li><a shape="rect" href="ftp2.html">FTP</a></li><li><a
shape="rect" href="polling-consumer.html">Polling Consumer</a></li></ul>
-<h2 id="BookComponentAppendix-FlatpackComponent">Flatpack Component</h2>
+<ul><li><a shape="rect" href="configuring-camel.html">Configuring
Camel</a></li><li><a shape="rect"
href="component.html">Component</a></li><li><a shape="rect"
href="endpoint.html">Endpoint</a></li><li><a shape="rect"
href="getting-started.html">Getting Started</a></li></ul><ul
class="alternate"><li><a shape="rect" href="file-language.html">File
Language</a></li><li><a shape="rect" href="ftp2.html">FTP</a></li><li><a
shape="rect" href="polling-consumer.html">Polling Consumer</a></li></ul> <h2
id="BookComponentAppendix-FlatpackComponent">Flatpack Component</h2>
<p>The Flatpack component supports fixed width and delimited file parsing via
the <a shape="rect" class="external-link"
href="http://flatpack.sourceforge.net" rel="nofollow">FlatPack library</a>.<br
clear="none">
<strong>Notice:</strong> This component only supports consuming from flatpack
files to Object model. You can not (yet) write from Object model to flatpack
format.</p>
@@ -3329,8 +3300,7 @@ from("seda:people").marshal(df
</div></div>
<h3 id="BookComponentAppendix-SeeAlso.17">See Also</h3>
-<ul><li><a shape="rect" href="configuring-camel.html">Configuring
Camel</a></li><li><a shape="rect"
href="component.html">Component</a></li><li><a shape="rect"
href="endpoint.html">Endpoint</a></li><li><a shape="rect"
href="getting-started.html">Getting Started</a></li></ul>
-<h2 id="BookComponentAppendix-FreeMarker">FreeMarker</h2><p>The
<strong>freemarker:</strong> component allows for processing a message using a
<a shape="rect" class="external-link" href="http://freemarker.org/"
rel="nofollow">FreeMarker</a> template. This can be ideal when using <a
shape="rect" href="templating.html">Templating</a> to generate responses for
requests.</p><p>Maven users will need to add the following dependency to their
<code>pom.xml</code> for this component:</p><div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<ul><li><a shape="rect" href="configuring-camel.html">Configuring
Camel</a></li><li><a shape="rect"
href="component.html">Component</a></li><li><a shape="rect"
href="endpoint.html">Endpoint</a></li><li><a shape="rect"
href="getting-started.html">Getting Started</a></li></ul> <h2
id="BookComponentAppendix-FreeMarker">FreeMarker</h2><p>The
<strong>freemarker:</strong> component allows for processing a message using a
<a shape="rect" class="external-link" href="http://freemarker.org/"
rel="nofollow">FreeMarker</a> template. This can be ideal when using <a
shape="rect" href="templating.html">Templating</a> to generate responses for
requests.</p><p>Maven users will need to add the following dependency to their
<code>pom.xml</code> for this component:</p><div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
<script class="theme: Default; brush: xml; gutter: false"
type="syntaxhighlighter"><![CDATA[<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-freemarker</artifactId>
@@ -3425,8 +3395,7 @@ protected RouteBuilder createRouteBuilde
}
]]></script>
</div></div><p></p><h3 id="BookComponentAppendix-SeeAlso.18">See Also</h3>
-<ul><li><a shape="rect" href="configuring-camel.html">Configuring
Camel</a></li><li><a shape="rect"
href="component.html">Component</a></li><li><a shape="rect"
href="endpoint.html">Endpoint</a></li><li><a shape="rect"
href="getting-started.html">Getting Started</a></li></ul>
-<h2 id="BookComponentAppendix-FTP/SFTP/FTPSComponent">FTP/SFTP/FTPS
Component</h2><p>This component provides access to remote file systems over the
FTP and SFTP protocols.</p><p>Maven users will need to add the following
dependency to their <code>pom.xml</code> for this component:</p><div
class="code panel pdl" style="border-width: 1px;"><div class="codeContent
panelContent pdl">
+<ul><li><a shape="rect" href="configuring-camel.html">Configuring
Camel</a></li><li><a shape="rect"
href="component.html">Component</a></li><li><a shape="rect"
href="endpoint.html">Endpoint</a></li><li><a shape="rect"
href="getting-started.html">Getting Started</a></li></ul> <h2
id="BookComponentAppendix-FTP/SFTP/FTPSComponent">FTP/SFTP/FTPS
Component</h2><p>This component provides access to remote file systems over the
FTP and SFTP protocols.</p><p>Maven users will need to add the following
dependency to their <code>pom.xml</code> for this component:</p><div
class="code panel pdl" style="border-width: 1px;"><div class="codeContent
panelContent pdl">
<script class="theme: Default; brush: xml; gutter: false"
type="syntaxhighlighter"><![CDATA[<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-ftp</artifactId>
@@ -3745,8 +3714,7 @@ public class MyFileFilter<T> imple
<script class="theme: Default; brush: java; gutter: false"
type="syntaxhighlighter"><![CDATA[String data =
template.retrieveBodyNoWait("ftp://admin@localhost:21/nolist/?password=admin&stepwise=false&useList=false&ignoreFileNotFoundOrPermissionError=true&fileName=report.txt&delete=true",
String.class);
]]></script>
</div></div><h3 id="BookComponentAppendix-Debuglogging.1">Debug
logging</h3><p>This component has log level <strong>TRACE</strong> that can be
helpful if you have problems.</p><p></p><h3
id="BookComponentAppendix-SeeAlso.19">See Also</h3>
-<ul><li><a shape="rect" href="configuring-camel.html">Configuring
Camel</a></li><li><a shape="rect"
href="component.html">Component</a></li><li><a shape="rect"
href="endpoint.html">Endpoint</a></li><li><a shape="rect"
href="getting-started.html">Getting Started</a></li></ul><ul
class="alternate"><li><a shape="rect" href="file2.html">File2</a></li></ul>
-<h2 id="BookComponentAppendix-CamelComponentsforGoogleAppEngine">Camel
Components for Google App Engine</h2>
+<ul><li><a shape="rect" href="configuring-camel.html">Configuring
Camel</a></li><li><a shape="rect"
href="component.html">Component</a></li><li><a shape="rect"
href="endpoint.html">Endpoint</a></li><li><a shape="rect"
href="getting-started.html">Getting Started</a></li></ul><ul
class="alternate"><li><a shape="rect" href="file2.html">File2</a></li></ul> <h2
id="BookComponentAppendix-CamelComponentsforGoogleAppEngine">Camel Components
for Google App Engine</h2>
<div class="aui-message success shadowed information-macro">
<p class="title">Tutorials</p>
@@ -3875,8 +3843,7 @@ http://java.sun.com/xml/ns/javaee/web-ap
]]></script>
</div></div>
-<p>The location of the Spring application context XML file is given by the
<code>contextConfigLocation</code> init parameter. The <code>appctx.xml</code>
file must be on the classpath. The servlet mapping makes the Camel application
accessible under <code>http://<appname>.appspot.com/camel/...</code> when
deployed to Google App Engine where <code><appname></code> must be
replaced by a real GAE application name. The second servlet mapping is used
internally by the task queueing service for background processing via <a
shape="rect" class="external-link" href="http://www.webhooks.org/"
rel="nofollow">web hooks</a>. This mapping is relevant for the <a shape="rect"
href="gtask.html">gtask</a> component and is explained there in more detail.
</p>
-<h2 id="BookComponentAppendix-HazelcastComponent">Hazelcast
Component</h2><p><strong>Available as of Camel 2.7</strong></p><p>The
<strong>hazelcast:</strong> component allows you to work with the <a
shape="rect" class="external-link" href="http://www.hazelcast.com"
rel="nofollow">Hazelcast</a> distributed data grid / cache. Hazelcast is a in
memory data grid, entirely written in Java (single jar). It offers a great
palette of different data stores like map, multi map (same key, n values),
queue, list and atomic number. The main reason to use Hazelcast is its simple
cluster support. If you have enabled multicast on your network you can run a
cluster with hundred nodes with no extra configuration. Hazelcast can simply
configured to add additional features like n copies between nodes (default is
1), cache persistence, network configuration (if needed), near cache, enviction
and so on. For more information consult the Hazelcast documentation on <a
shape="rect" class="external-link" href
="http://www.hazelcast.com/docs.jsp"
rel="nofollow">http://www.hazelcast.com/docs.jsp</a>.</p><p>Maven users will
need to add the following dependency to their <code>pom.xml</code> for this
component:</p><div class="code panel pdl" style="border-width: 1px;"><div
class="codeContent panelContent pdl">
+<p>The location of the Spring application context XML file is given by the
<code>contextConfigLocation</code> init parameter. The <code>appctx.xml</code>
file must be on the classpath. The servlet mapping makes the Camel application
accessible under <code>http://<appname>.appspot.com/camel/...</code> when
deployed to Google App Engine where <code><appname></code> must be
replaced by a real GAE application name. The second servlet mapping is used
internally by the task queueing service for background processing via <a
shape="rect" class="external-link" href="http://www.webhooks.org/"
rel="nofollow">web hooks</a>. This mapping is relevant for the <a shape="rect"
href="gtask.html">gtask</a> component and is explained there in more detail.
</p> <h2 id="BookComponentAppendix-HazelcastComponent">Hazelcast
Component</h2><p><strong>Available as of Camel 2.7</strong></p><p>The
<strong>hazelcast:</strong> component allows you to work with the <a
shape="rect" class="external-link"
href="http://www.hazelcast.com" rel="nofollow">Hazelcast</a> distributed data
grid / cache. Hazelcast is a in memory data grid, entirely written in Java
(single jar). It offers a great palette of different data stores like map,
multi map (same key, n values), queue, list and atomic number. The main reason
to use Hazelcast is its simple cluster support. If you have enabled multicast
on your network you can run a cluster with hundred nodes with no extra
configuration. Hazelcast can simply configured to add additional features like
n copies between nodes (default is 1), cache persistence, network configuration
(if needed), near cache, enviction and so on. For more information consult the
Hazelcast documentation on <a shape="rect" class="external-link"
href="http://www.hazelcast.com/docs.jsp"
rel="nofollow">http://www.hazelcast.com/docs.jsp</a>.</p><p>Maven users will
need to add the following dependency to their <code>pom.xml</code> for this
component:</p><div class="code panel pdl" st
yle="border-width: 1px;"><div class="codeContent panelContent pdl">
<script class="theme: Default; brush: xml; gutter: false"
type="syntaxhighlighter"><![CDATA[<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-hazelcast</artifactId>
@@ -4461,8 +4428,7 @@ template.sendBodyAndHeader("direct:
<p>Header variables have changed in Camel 2.8</p>
</div>
</div>
-<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>Type</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1"
rowspan="1"
class="confluenceTd"><p><code>CamelHazelcastListenerTime</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>Long</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>time of the event in millis
<strong><a shape="rect" class="unresolved" href="#">Version
2.8</a></strong></p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>CamelHazelcastListenerType</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>the map consumer sets here
"instancelistener" <strong><a shape="rect" class="unresolved" href="#">Version
2.8</a></strong></p></td></tr>
<tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>CamelHazelcastListenerActionn</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>type of event - here
<strong>added</strong> or <strong>removed</strong>. <strong><a shape="rect"
class="unresolved" href="#">Version 2.8</a></strong></p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>CamelHazelcastInstanceHost</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>host name of the instance
<strong><a shape="rect" class="unresolved" href="#">Version
2.8</a></strong></p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>CamelHazelcastInstancePort</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>Integer</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>port n
umber of the instance <strong><a shape="rect" class="unresolved"
href="#">Version 2.8</a></strong></p></td></tr></tbody></table></div>
-<h2 id="BookComponentAppendix-HDFSComponent">HDFS
Component</h2><p><strong>Available as of Camel 2.8</strong></p><p>The
<strong>hdfs</strong> component enables you to read and write messages from/to
an HDFS file system. HDFS is the distributed file system at the heart of <a
shape="rect" class="external-link"
href="http://hadoop.apache.org">Hadoop</a>.</p><p>Maven users will need to add
the following dependency to their <code>pom.xml</code> for this
component:</p><div class="code panel pdl" style="border-width: 1px;"><div
class="codeContent panelContent pdl">
+<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>Type</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1"
rowspan="1"
class="confluenceTd"><p><code>CamelHazelcastListenerTime</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>Long</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>time of the event in millis
<strong><a shape="rect" class="unresolved" href="#">Version
2.8</a></strong></p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>CamelHazelcastListenerType</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>the map consumer sets here
"instancelistener" <strong><a shape="rect" class="unresolved" href="#">Version
2.8</a></strong></p></td></tr>
<tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>CamelHazelcastListenerActionn</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>type of event - here
<strong>added</strong> or <strong>removed</strong>. <strong><a shape="rect"
class="unresolved" href="#">Version 2.8</a></strong></p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>CamelHazelcastInstanceHost</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>host name of the instance
<strong><a shape="rect" class="unresolved" href="#">Version
2.8</a></strong></p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>CamelHazelcastInstancePort</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>Integer</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>port n
umber of the instance <strong><a shape="rect" class="unresolved"
href="#">Version 2.8</a></strong></p></td></tr></tbody></table></div> <h2
id="BookComponentAppendix-HDFSComponent">HDFS
Component</h2><p><strong>Available as of Camel 2.8</strong></p><p>The
<strong>hdfs</strong> component enables you to read and write messages from/to
an HDFS file system. HDFS is the distributed file system at the heart of <a
shape="rect" class="external-link"
href="http://hadoop.apache.org">Hadoop</a>.</p><p>Maven users will need to add
the following dependency to their <code>pom.xml</code> for this
component:</p><div class="code panel pdl" style="border-width: 1px;"><div
class="codeContent panelContent pdl">
<script class="theme: Default; brush: xml; gutter: false"
type="syntaxhighlighter"><![CDATA[<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-hdfs</artifactId>
@@ -4488,8 +4454,7 @@ template.sendBodyAndHeader("direct:
<p>for example:</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[hdfs://localhost/tmp/simple-file?splitStrategy=IDLE:1000,BYTES:5
]]></script>
-</div></div><p>it means: a new file is created either when it has been idle
for more than 1 second or if more than 5 bytes have been written. So, running
<code>hadoop fs -ls /tmp/simple-file</code> you'll see that multiple files have
been created.</p><h3 id="BookComponentAppendix-MessageHeaders.4">Message
Headers</h3><p>The following headers are supported by this component:</p><h4
id="BookComponentAppendix-Produceronly">Producer only</h4><div
class="confluenceTableSmall"><div class="table-wrap"><table
class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh"><p>Header</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>CamelFileName</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.13:</strong>
Specifies the name of the file to write (relative to the endpoint path). The
name can be a <code>String</code> or an <a shape="rect" href="
expression.html">Expression</a> object. Only relevant when not using a split
strategy.</p></td></tr></tbody></table></div></div><h3
id="BookComponentAppendix-Controllingtoclosefilestream">Controlling to close
file stream</h3><p><strong>Available as of Camel 2.10.4</strong></p><p>When
using the <a shape="rect" href="hdfs.html">HDFS</a> producer
<strong>without</strong> a split strategy, then the file output stream is by
default closed after the write. However you may want to keep the stream open,
and only explicitly close the stream later. For that you can use the header
<code>HdfsConstants.HDFS_CLOSE</code> (value = <code>"CamelHdfsClose"</code>)
to control this. Setting this value to a boolean allows you to explicit control
whether the stream should be closed or not.</p><p>Notice this does not apply if
you use a split strategy, as there are various strategies that can control when
the stream is closed.</p><h3
id="BookComponentAppendix-UsingthiscomponentinOSGi">Using this component
in OSGi</h3><p>This component is fully functional in an OSGi environment,
however, it requires some actions from the user. Hadoop uses the thread context
class loader in order to load resources. Usually, the thread context
classloader will be the bundle class loader of the bundle that contains the
routes. So, the default configuration files need to be visible from the bundle
class loader. A typical way to deal with it is to keep a copy of
core-default.xml in your bundle root. That file can be found in the
hadoop-common.jar.</p>
-<h2 id="BookComponentAppendix-HibernateComponent">Hibernate Component</h2>
+</div></div><p>it means: a new file is created either when it has been idle
for more than 1 second or if more than 5 bytes have been written. So, running
<code>hadoop fs -ls /tmp/simple-file</code> you'll see that multiple files have
been created.</p><h3 id="BookComponentAppendix-MessageHeaders.4">Message
Headers</h3><p>The following headers are supported by this component:</p><h4
id="BookComponentAppendix-Produceronly">Producer only</h4><div
class="confluenceTableSmall"><div class="table-wrap"><table
class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh"><p>Header</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>CamelFileName</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.13:</strong>
Specifies the name of the file to write (relative to the endpoint path). The
name can be a <code>String</code> or an <a shape="rect" href="
expression.html">Expression</a> object. Only relevant when not using a split
strategy.</p></td></tr></tbody></table></div></div><h3
id="BookComponentAppendix-Controllingtoclosefilestream">Controlling to close
file stream</h3><p><strong>Available as of Camel 2.10.4</strong></p><p>When
using the <a shape="rect" href="hdfs.html">HDFS</a> producer
<strong>without</strong> a split strategy, then the file output stream is by
default closed after the write. However you may want to keep the stream open,
and only explicitly close the stream later. For that you can use the header
<code>HdfsConstants.HDFS_CLOSE</code> (value = <code>"CamelHdfsClose"</code>)
to control this. Setting this value to a boolean allows you to explicit control
whether the stream should be closed or not.</p><p>Notice this does not apply if
you use a split strategy, as there are various strategies that can control when
the stream is closed.</p><h3
id="BookComponentAppendix-UsingthiscomponentinOSGi">Using this component
in OSGi</h3><p>This component is fully functional in an OSGi environment,
however, it requires some actions from the user. Hadoop uses the thread context
class loader in order to load resources. Usually, the thread context
classloader will be the bundle class loader of the bundle that contains the
routes. So, the default configuration files need to be visible from the bundle
class loader. A typical way to deal with it is to keep a copy of
core-default.xml in your bundle root. That file can be found in the
hadoop-common.jar.</p> <h2
id="BookComponentAppendix-HibernateComponent">Hibernate Component</h2>
<p>The <strong>hibernate:</strong> component allows you to work with databases
using Hibernate as the object relational mapping technology to map POJOs to
database tables. The <strong>camel-hibernate</strong> library is provided by
the <a shape="rect" class="external-link"
href="http://code.google.com/p/camel-extra/" rel="nofollow">Camel Extra</a>
project which hosts all *GPL related components for Camel.</p>
@@ -4536,8 +4501,43 @@ hibernate:[entityClassName][?options]
<h3 id="BookComponentAppendix-SeeAlso.20">See Also</h3>
<ul><li><a shape="rect" href="configuring-camel.html">Configuring
Camel</a></li><li><a shape="rect"
href="component.html">Component</a></li><li><a shape="rect"
href="endpoint.html">Endpoint</a></li><li><a shape="rect"
href="getting-started.html">Getting Started</a></li></ul>
-<ul class="alternate"><li><a shape="rect"
href="hibernate-example.html">Hibernate Example</a></li></ul>
-<h2 id="BookComponentAppendix-HL7Component">HL7 Component</h2><p>The
<strong>HL7</strong> component is used for working with the HL7 MLLP protocol
and <a shape="rect" class="external-link"
href="http://www.hl7.org/implement/standards/product_brief.cfm?product_id=185"
rel="nofollow">HL7 v2 messages</a> using the <a shape="rect"
class="external-link" href="http://hl7api.sourceforge.net" rel="nofollow">HAPI
library</a>.</p><p>This component supports the following:</p><ul
class="alternate"><li>HL7 MLLP codec for <a shape="rect"
href="mina2.html">Mina</a></li><li>HL7 MLLP codec for <a shape="rect"
href="netty4.html">Netty4</a> from <strong>Camel 2.15</strong>
onwards</li><li><a shape="rect" href="type-converter.html">Type Converter</a>
from/to HAPI and String</li><li>HL7 DataFormat using the HAPI library</li><li
class="confluence-link">Even more ease-of-use as it's integrated well with the
<a shape="rect" href="mina2.html">camel-mina2</a> component.</li></ul><p>Maven
users will
need to add the following dependency to their <code>pom.xml</code> for this
component:</p><div class="code panel pdl" style="border-width: 1px;"><div
class="codeContent panelContent pdl">
+<ul class="alternate"><li><a shape="rect"
href="hibernate-example.html">Hibernate Example</a></li></ul> <h2
id="BookComponentAppendix-HipchatComponent">Hipchat
Component</h2><p><strong>Available as of Camel 2.15.0</strong></p><p>The
Hipchat component supports producing and consuming messages from/to <a
shape="rect" class="external-link" href="https://www.hipchat.com"
rel="nofollow">Hipchat</a> service.</p> <div class="aui-message hint
shadowed information-macro">
+ <p class="title">Prerequisites</p>
+ <span class="aui-icon icon-hint">Icon</span>
+ <div class="message-content">
+ <p>You must have a valid Hipchat user account and
get a <a shape="rect" class="external-link"
href="https://www.hipchat.com/account/api" rel="nofollow">personal access
token</a> that you can use to produce/consume messages.</p>
+ </div>
+ </div>
+<h3 id="BookComponentAppendix-URIFormat.1">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[hipchat://[host][:port]?options
+]]></script>
+</div></div><p>You can append query options to the URI in the following
format, ?options=value&option2=value&...</p><h3
id="BookComponentAppendix-URIOptions.4">URI 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>Context</p></th><th colspan="1" rowspan="1"
class="confluenceTh">Required</th><th colspan="1" rowspan="1"
class="confluenceTh">Producer/Consumer</th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><span>authToken</span></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>Shared</p></td><td colspan="1"
rowspan="1" class="confluenceTd">Yes</td><td colspan="1" rowspan="1"
class="conflu
enceTd">Both</td><td colspan="1" rowspan="1"
class="confluenceTd">Authorization token(personal access token) obtained from
<a shape="rect" class="external-link"
href="https://www.hipchat.com/account/api"
rel="nofollow">Hipchat</a><p> </p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><span>protocol</span></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>http</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>Shared</p></td><td colspan="1"
rowspan="1" class="confluenceTd">No</td><td colspan="1" rowspan="1"
class="confluenceTd">Both</td><td colspan="1" rowspan="1"
class="confluenceTd"><p>Default protocol to connect to the Hipchat
server</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><span>consumeUsers</span></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Shared</p></td><td colspan="1" rowspan="1"
class="confluenceTd">
No</td><td colspan="1" rowspan="1" class="confluenceTd">Consumer</td><td
colspan="1" rowspan="1" class="confluenceTd"><p>Comma separated list of user
@Mentions or emails whose messages to the owner of authToken must be
consumed</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd">host</td><td colspan="1" rowspan="1"
class="confluenceTd">api.hipchat.com</td><td colspan="1" rowspan="1"
class="confluenceTd">Shared</td><td colspan="1" rowspan="1"
class="confluenceTd">No</td><td colspan="1" rowspan="1"
class="confluenceTd">Both</td><td colspan="1" rowspan="1"
class="confluenceTd">The API host of the Hipchat to connect to</td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd">port</td><td colspan="1"
rowspan="1" class="confluenceTd">80</td><td colspan="1" rowspan="1"
class="confluenceTd">Shared</td><td colspan="1" rowspan="1"
class="confluenceTd">No</td><td colspan="1" rowspan="1"
class="confluenceTd">Both</td><td colspan="1" rowspan="1"
class="confluenceTd">The port t
o connect to on the Hipchat host</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd">delay</td><td colspan="1" rowspan="1"
class="confluenceTd">5000</td><td colspan="1" rowspan="1"
class="confluenceTd">Shared</td><td colspan="1" rowspan="1"
class="confluenceTd">No</td><td colspan="1" rowspan="1"
class="confluenceTd">Consumer</td><td colspan="1" rowspan="1"
class="confluenceTd">The poll interval in millisec for consuming messages from
consumeUsers provided. Please read about <a shape="rect" class="external-link"
href="https://www.hipchat.com/docs/apiv2/rate_limiting" rel="nofollow">rate
limits</a> before increasing this.</td></tr></tbody></table></div><h3
id="BookComponentAppendix-ScheduledPollConsumer">Scheduled Poll
Consumer</h3><p>This component implements the <a shape="rect"
href="polling-consumer.html">ScheduledPollConsumer</a>. Only the last message
from the provided 'consumeUsers' are retrieved and sent as Exchange body. If
you do not want the same message to be retr
ieved again when there are no new messages on next poll then you can add the
<a shape="rect" href="idempotent-consumer.html">idempotent consumer</a> as
shown below. All the options on the <a shape="rect"
href="polling-consumer.html">ScheduledPollConsumer</a> can also be used
for more control on the consumer.</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[@Override
+public void configure() throws Exception {
+ String hipchatEndpointUri =
"hipchat://?authToken=XXXX&consumeUsers=@Joe,@John";
+ from(hipchatEndpointUri)
+ .idempotentConsumer(
+ simple("${in.header.HipchatMessageDate}
${in.header.HipchatFromUser}"),
+ MemoryIdempotentRepository.memoryIdempotentRepository(200)
+ )
+ .to("mock:result");
+}]]></script>
+</div></div><h4
id="BookComponentAppendix-MessageheaderssetbytheHipchatconsumer">Message
headers set by the Hipchat consumer</h4><div class="confluenceTableSmall"><div
class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1"
rowspan="1" class="confluenceTh"><p>Header</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Constant</p></th><th colspan="1" rowspan="1"
class="confluenceTh">Type</th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><span>HipchatFromUser</span></td><td
colspan="1" rowspan="1"
class="confluenceTd"><span>HipchatConstants.FROM_USER</span></td><td
colspan="1" rowspan="1" class="confluenceTd"><em>String</em></td><td
colspan="1" rowspan="1" class="confluenceTd"><span>The body has the message
that was sent from this user to the owner of authToken</span></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd">HipchatMessageDate</td><td
colspan="1" rowspa
n="1" class="confluenceTd"><span>HipchatConstants.</span>MESSAGE_DATE</td><td
colspan="1" rowspan="1" class="confluenceTd"><em>String</em></td><td
colspan="1" rowspan="1" class="confluenceTd">The date message was sent. The
format is ISO-8601 as present in the Hipchat <a shape="rect"
class="external-link"
href="https://www.hipchat.com/docs/apiv2/method/view_recent_privatechat_history"
rel="nofollow">response</a>.</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd">HipchatFromUserResponseStatus</td><td colspan="1"
rowspan="1"
class="confluenceTd">HipchatConstants.FROM_USER_RESPONSE_STATUS </td><td
colspan="1" rowspan="1" class="confluenceTd"><em><a shape="rect"
class="external-link"
href="http://hc.apache.org/httpcomponents-core-4.2.x/httpcore/apidocs/org/apache/http/StatusLine.html">StatusLine</a></em></td><td
colspan="1" rowspan="1" class="confluenceTd">The status of the API response
received.</td></tr></tbody></table></div></div><h3
id="BookComponentAppendix-HipchatP
roducer">Hipchat Producer</h3><p>Producer can send messages to both Room's and
User's simultaneously. The body of the exchange is sent as message. Sample
usage is shown below. Appropriate headers needs to be set.</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[@Override
+ public void configure() throws Exception {
+ String hipchatEndpointUri = "hipchat://?authToken=XXXX";
+ from("direct:start")
+ .to(hipchatEndpointUri)
+ .to("mock:result");
+ }]]></script>
+</div></div><h4
id="BookComponentAppendix-MessageheadersevaluatedbytheHipchatproducer">Message
headers evaluated by the Hipchat producer</h4><div
class="confluenceTableSmall"><div class="table-wrap"><table
class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh"><p>Header</p></th><th colspan="1" rowspan="1"
class="confluenceTh">Constant</th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Type</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd">HipchatToUser</td><td colspan="1" rowspan="1"
class="confluenceTd"><span>HipchatConstants.TO_USER</span></td><td colspan="1"
rowspan="1" class="confluenceTd"><em>String</em></td><td colspan="1"
rowspan="1" class="confluenceTd">The Hipchat user to which the message needs to
be sent.</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd">HipchatToRoom</td><td colspan="1" rowspan="1"
class="confluenceTd"><span>HipchatConstan
ts.TO_ROOM</span></td><td colspan="1" rowspan="1"
class="confluenceTd"><em>String</em></td><td colspan="1" rowspan="1"
class="confluenceTd">The Hipchat room to which the message needs to be
sent.</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd">HipchatMessageFormat</td><td colspan="1" rowspan="1"
class="confluenceTd">HipchatConstants.MESSAGE_FORMAT</td><td colspan="1"
rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1"
class="confluenceTd">Valid formats are 'text' or 'html'. <strong>Default:
'text'</strong></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd">HipchatMessageBackgroundColor</td><td colspan="1"
rowspan="1"
class="confluenceTd">HipchatConstants.MESSAGE_BACKGROUND_COLOR</td><td
colspan="1" rowspan="1" class="confluenceTd"><em>String</em></td><td
colspan="1" rowspan="1" class="confluenceTd">Valid color values are 'yellow',
'green', 'red', 'purple', 'gray', 'random'. <strong>Default: 'yellow' (Room
Only)</strong> </td></tr><tr
><td colspan="1" rowspan="1"
>class="confluenceTd">HipchatTriggerNotification</td><td colspan="1"
>rowspan="1" class="confluenceTd">HipchatConstants.TRIGGER_NOTIFY</td><td
>colspan="1" rowspan="1" class="confluenceTd"><em>String</em></td><td
>colspan="1" rowspan="1" class="confluenceTd">Valid values are 'true' or
>'false'. Whether this message should trigger a user notification (change the
>tab color, play a sound, notify mobile phones, etc). <strong>Default: 'false'
>(Room Only) </strong></td></tr></tbody></table></div></div><h4
>id="BookComponentAppendix-MessageheaderssetbytheHipchatproducer">Message
>headers set by the Hipchat producer</h4><div
>class="confluenceTableSmall"><div class="table-wrap"><table
>class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
>class="confluenceTh"><p>Header</p></th><th colspan="1" rowspan="1"
>class="confluenceTh"><p>Constant</p></th><th colspan="1" rowspan="1"
>class="confluenceTh">Type</th><th colspan="1" rowspan="1"
>class="confluenceTh"><p>Descripti
on</p></th></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd">HipchatToUserResponseStatus</td><td colspan="1"
rowspan="1"
class="confluenceTd">HipchatConstants.TO_USER_RESPONSE_STATUS</td><td
colspan="1" rowspan="1" class="confluenceTd"><em><a shape="rect"
class="external-link"
href="http://hc.apache.org/httpcomponents-core-4.2.x/httpcore/apidocs/org/apache/http/StatusLine.html">StatusLine</a></em></td><td
colspan="1" rowspan="1" class="confluenceTd"><span>The status of the API
response received when message sent to the user.</span></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd">HipchatFromUserResponseStatus</td><td colspan="1"
rowspan="1"
class="confluenceTd">HipchatConstants.TO_ROOM_RESPONSE_STATUS</td><td
colspan="1" rowspan="1" class="confluenceTd"><em><a shape="rect"
class="external-link"
href="http://hc.apache.org/httpcomponents-core-4.2.x/httpcore/apidocs/org/apache/http/StatusLine.html">StatusLine</a></em></td><td
colspan="1" rowspan="1" class="confluen
ceTd"><span>The status of the API response received when message sent to the
room.</span></td></tr></tbody></table></div></div><h4
id="BookComponentAppendix-Dependencies.2"><span style="font-size:
16.0px;line-height: 1.5625;">Dependencies</span></h4><p>Maven users will need
to add the following dependency to their pom.xml.</p><div class="code panel
pdl" style="border-width: 1px;"><div class="codeHeader panelHeader pdl"
style="border-bottom-width: 1px;"><b>pom.xml</b></div><div class="codeContent
panelContent pdl">
+<script class="theme: Default; brush: xml; gutter: false"
type="syntaxhighlighter"><![CDATA[<dependency>
+ <groupId>org.apache.camel</groupId>
+ <artifactId>camel-hipchat</artifactId>
+ <version>${camel-version}</version>
+</dependency>
+]]></script>
+</div></div><p>where <code>${camel-version</code>} must be replaced by
the actual version of Camel (2.15.0 or higher)</p><h2
id="BookComponentAppendix-HL7Component">HL7 Component</h2><p>The
<strong>HL7</strong> component is used for working with the HL7 MLLP protocol
and <a shape="rect" class="external-link"
href="http://www.hl7.org/implement/standards/product_brief.cfm?product_id=185"
rel="nofollow">HL7 v2 messages</a> using the <a shape="rect"
class="external-link" href="http://hl7api.sourceforge.net" rel="nofollow">HAPI
library</a>.</p><p>This component supports the following:</p><ul
class="alternate"><li>HL7 MLLP codec for <a shape="rect"
href="mina2.html">Mina</a></li><li>HL7 MLLP codec for <a shape="rect"
href="netty4.html">Netty4</a> from <strong>Camel 2.15</strong>
onwards</li><li><a shape="rect" href="type-converter.html">Type Converter</a>
from/to HAPI and String</li><li>HL7 DataFormat using the HAPI library</li><li
class="confluence-link">Even more ease-of-
use as it's integrated well with the <a shape="rect"
href="mina2.html">camel-mina2</a> component.</li></ul><p>Maven users will need
to add the following dependency to their <code>pom.xml</code> for this
component:</p><div class="code panel pdl" style="border-width: 1px;"><div
class="codeContent panelContent pdl">
<script class="theme: Default; brush: xml; gutter: false"
type="syntaxhighlighter"><![CDATA[<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-hl7</artifactId>
@@ -4631,7 +4631,7 @@ String patientId = msg.getQRD().getWhoSu
<script class="theme: Default; brush: java; gutter: false"
type="syntaxhighlighter"><![CDATA[
from("direct:hl7in").marshal().hl7().to("jms:queue:hl7out");
from("jms:queue:hl7out").unmarshal().hl7().to("patientLookupService");
]]></script>
-</div></div><p> </p><p> </p><h3
id="BookComponentAppendix-MessageHeaders.5">Message Headers</h3><p>The
unmarshal operation adds these fields from the MSH segment as headers on the
Camel message:</p><div class="confluenceTableSmall"><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>MSH field</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Example</p></th></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>CamelHL7SendingApplication</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>MSH-3</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>MYSERVER</code></p></td></tr><tr><td colspan="1"
rowspan="1"
class="confluenceTd"><p><code>CamelHL7SendingFacility</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>MSH-4</code></p></td><td
colspan="1" rowspan="1" clas
s="confluenceTd"><p><code>MYSERVERAPP</code></p></td></tr><tr><td colspan="1"
rowspan="1"
class="confluenceTd"><p><code>CamelHL7ReceivingApplication</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>MSH-5</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>MYCLIENT</code></p></td></tr><tr><td colspan="1"
rowspan="1"
class="confluenceTd"><p><code>CamelHL7ReceivingFacility</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>MSH-6</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>MYCLIENTAPP</code></p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>CamelHL7Timestamp</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>MSH-7</code></p></td><td colspan="1"
rowspan="1"
class="confluenceTd"><p><code>20071231235900</code></p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>CamelHL7Security</code></p></td><td colspan="1"
rowspan="1" class=
"confluenceTd"><p><code>MSH-8</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>null</code></p></td></tr><tr><td colspan="1"
rowspan="1"
class="confluenceTd"><p><code>CamelHL7MessageType</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>MSH-9-1</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>ADT</code></p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>CamelHL7TriggerEvent</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>MSH-9-2</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>A01</code></p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>CamelHL7MessageControl</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>MSH-10</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>1234</code></p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>CamelHL7ProcessingId</c
ode></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>MSH-11</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>P</code></p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>CamelHL7VersionId</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>MSH-12</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>2.4</code></p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><code>CamelHL7Context </code><code><br
clear="none"></code></td><td colspan="1" rowspan="1"
class="confluenceTd">-</td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>(Camel 2.14)</strong> contains the <a
shape="rect" class="external-link"
href="http://hl7api.sourceforge.net/base/apidocs/ca/uhn/hl7v2/HapiContext.html"
rel="nofollow">HapiContext</a> that<br clear="none">was used to parse the
message</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><code>CamelHL7Charset</code></td><
td colspan="1" rowspan="1" class="confluenceTd"><code>MSH-18</code></td><td
colspan="1" rowspan="1" class="confluenceTd"><strong>(Camel 2.14.1)</strong>
<code><br clear="none">UNICODE
UTF-8</code></td></tr></tbody></table></div></div><p>All headers
except <code>CamelHL7Context </code>are <code>String</code> types. If a
header value is missing, its value is <code>null</code>.</p><h3
id="BookComponentAppendix-Options.21">Options</h3><p>The HL7 Data Format
supports the following options:</p><div class="confluenceTableSmall"><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><code>validate</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>true</p></td><td colspan="1"
rowspan="1" class="c
onfluenceTd"><p>Whether the HAPI Parser should validate the message using the
default validation rules. It is recommended to use the <code>parser</code> or
<code>hapiContext</code> option and initialize it with the desired HAPI <a
shape="rect" class="external-link"
href="http://hl7api.sourceforge.net/base/apidocs/ca/uhn/hl7v2/validation/ValidationContext.html"
rel="nofollow"><code>ValidationContext</code></a></p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>parser</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>ca.uhn.hl7v2.parser.GenericParser</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>Custom parser to be used. Must
be of type <a shape="rect" class="external-link"
href="http://hl7api.sourceforge.net/base/apidocs/ca/uhn/hl7v2/parser/Parser.html"
rel="nofollow"><code>ca.uhn.hl7v2.parser.Parser</code></a>. Note that <a
shape="rect" class="external-link"
href="http://hl7api.sourceforge.net/base/apidocs/ca/uhn/hl
7v2/parser/GenericParser.html" rel="nofollow"><code>GenericParser</code></a>
also allows to parse XML-encoded HL7v2 messages</p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><code>hapiContext</code></td><td
colspan="1" rowspan="1"
class="confluenceTd"><code>ca.uhn.hl7v2.DefaultHapiContext</code></td><td
colspan="1" rowspan="1" class="confluenceTd"><strong>Camel 2.14:</strong>
Custom HAPI context that can define a custom parser, custom ValidationContext
etc. This gives you full control over the HL7 parsing and rendering
process.</td></tr></tbody></table></div></div><h3
id="BookComponentAppendix-Dependencies.2">Dependencies</h3><p>To use HL7 in
your Camel routes you'll need to add a dependency on <strong>camel-hl7</strong>
listed above, which implements this data format.</p><p>The HAPI library is
split into a <a shape="rect" class="external-link"
href="http://repo1.maven.org/maven2/ca/uhn/hapi/hapi-base" rel="nofollow">base
library</a> and several structure libraries,
one for each HL7v2 message version:</p><ul><li><a shape="rect"
class="external-link"
href="http://repo1.maven.org/maven2/ca/uhn/hapi/hapi-structures-v21"
rel="nofollow">v2.1 structures library</a></li><li><a shape="rect"
class="external-link"
href="http://repo1.maven.org/maven2/ca/uhn/hapi/hapi-structures-v22"
rel="nofollow">v2.2 structures library</a></li><li><a shape="rect"
class="external-link"
href="http://repo1.maven.org/maven2/ca/uhn/hapi/hapi-structures-v23"
rel="nofollow">v2.3 structures library</a></li><li><a shape="rect"
class="external-link"
href="http://repo1.maven.org/maven2/ca/uhn/hapi/hapi-structures-v231"
rel="nofollow">v2.3.1 structures library</a></li><li><a shape="rect"
class="external-link"
href="http://repo1.maven.org/maven2/ca/uhn/hapi/hapi-structures-v24"
rel="nofollow">v2.4 structures library</a></li><li><a shape="rect"
class="external-link"
href="http://repo1.maven.org/maven2/ca/uhn/hapi/hapi-structures-v25"
rel="nofollow">v2.5 structures library</a></li><l
i><a shape="rect" class="external-link"
href="http://repo1.maven.org/maven2/ca/uhn/hapi/hapi-structures-v251"
rel="nofollow">v2.5.1 structures library</a></li><li><a shape="rect"
class="external-link"
href="http://repo1.maven.org/maven2/ca/uhn/hapi/hapi-structures-v26"
rel="nofollow">v2.6 structures library</a></li></ul><p>By default
<code>camel-hl7</code> only references the HAPI <a shape="rect"
class="external-link"
href="http://repo1.maven.org/maven2/ca/uhn/hapi/hapi-base" rel="nofollow">base
library</a>. Applications are responsible for including structure libraries
themselves. For example, if an application works with HL7v2 message versions
2.4 and 2.5 then the following dependencies must be added:</p><div class="code
panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
[... 617 lines stripped ...]