You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by bu...@apache.org on 2014/02/25 16:22:17 UTC
svn commit: r899164 [2/6] - in /websites/production/camel/content: ./
2010/05/26/ 2014/02/ 2014/02/25/ cache/
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 Tue Feb 25 15:22:16 2014
@@ -368,37 +368,17 @@ 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.</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>
+<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">
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-amqp</artifactId>
<version>${camel.version}</version> <!-- use the same version as your Camel core version -->
</dependency>
]]></script>
-</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[
-amqp:[queue:|topic:]destinationName[?options]
+</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[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>
-
-<h3 id="BookComponentAppendix-SeeAlso.1">See Also</h3>
+</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">
<p class="title">Prerequisites</p>
@@ -745,124 +725,13 @@ 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>
-<h2 id="BookComponentAppendix-BeanValidationComponent">Bean Validation Component</h2><p><strong>Available as of Camel 2.3</strong></p><p>The Validation component performs bean validation of the message body using the Java Bean Validation API (<a shape="rect" class="external-link" href="http://jcp.org/en/jsr/detail?id=303" rel="nofollow">JSR 303</a>). Camel uses the reference implementation, which is <a shape="rect" class="external-link" href="http://docs.jboss.org/hibernate/validator/4.3/reference/en-US/html_single/" rel="nofollow">Hibernate Validator</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-bean-validator</artifactId>
- <version>x.y.z</version>
- <!-- use the same version as your Camel core version -->
-</dependency>
-]]></script>
-</div></div><h3 id="BookComponentAppendix-URIformat.4">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[bean-validator:label[?options]
-]]></script>
-</div></div><p>or</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[bean-validator://label[?options]
-]]></script>
-</div></div><p>Where <strong>label</strong> is an arbitrary text value describing the endpoint.<br clear="none"> You can append query options to the URI in the following format, ?option=value&option=value&...</p><h3 id="BookComponentAppendix-URIOptions.1">URI Options</h3><div class="confluenceTableSmall">
-<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>group</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>javax.validation.groups.Default</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> The custom validation group to use. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>validationProviderResolver</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> Depends on JSR303 jar provided. </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> Camel <strong>2.13.0</strong>: Reference to a custom <code>javax.validation.ValidationProviderResolver</code> in the <a shape="rect" href="registry.html" title="Registry">Registry</a>. </p>
</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>messageInterpolator</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>org.hibernate.validator.engine.<br clear="none" class="atl-forced-newline">ResourceBundleMessageInterpolator</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> Reference to a custom <code>javax.validation.MessageInterpolator</code> in the <a shape="rect" href="registry.html" title="Registry">Registry</a>. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>traversableResolver</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>org.hibernate.validator.engine.resolver.<br clear="none" class="atl-forced-newline">DefaultTraversableResolver</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> Reference to a custom <code>javax.validation.TraversableResolver</code> in the <a shape="rect" href="registry.html" title="Registry">Registry</a>. </p><
/td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>constraintValidatorFactory</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>org.hibernate.validator.engine.<br clear="none" class="atl-forced-newline">ConstraintValidatorFactoryImpl</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> Reference to a custom <code>javax.validation.ConstraintValidatorFactory</code> in the <a shape="rect" href="registry.html" title="Registry">Registry</a>. </p></td></tr></tbody></table>
-</div><h3 id="BookComponentAppendix-ServiceMix4/OSGiDeployment.">ServiceMix4/OSGi Deployment.</h3><p>The bean-validator when deployed in an OSGi environment requires a little help to accommodate the resource loading specified in JSR303, this was fixed in Servicemix-Specs 1.6-SNAPSHOT.</p><p>The other way to load Hibernate Validator in the OSGi environment is to use dedicated <code>ValidationProviderResolver</code> implementation, just as <code>org.apache.camel.component.bean.validator.HibernateValidationProviderResolver</code>. The snippet below demonstrates this approach. Keep in mind that you can use <code>HibernateValidationProviderResolver</code> starting from the Camel 2.13.0.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeHeader panelHeader pdl" style="border-bottom-width: 1px;"><b>Using HibernateValidationProviderResolver</b></div><div class="codeContent panelContent pdl">
-<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[from("direct:test").
- to("bean-validator://ValidationProviderResolverTest?validationProviderResolver=#myValidationProviderResolver");
-
-...
-
-<bean id="myValidationProviderResolver" class="org.apache.camel.component.bean.validator.HibernateValidationProviderResolver"/> ]]></script>
-</div></div><h3 id="BookComponentAppendix-Example">Example</h3><p>Assumed we have a java bean with the following annotations</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeHeader panelHeader pdl" style="border-bottom-width: 1px;"><b>Car.java</b></div><div class="codeContent panelContent pdl">
-<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[public class Car {
-
- @NotNull
- private String manufacturer;
-
- @NotNull
- @Size(min = 5, max = 14, groups = OptionalChecks.class)
- private String licensePlate;
-
- // getter and setter
-}
-]]></script>
-</div></div><p>and an interface definition for our custom validation group</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeHeader panelHeader pdl" style="border-bottom-width: 1px;"><b>OptionalChecks.java</b></div><div class="codeContent panelContent pdl">
-<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[public interface OptionalChecks {
-}
-]]></script>
-</div></div><p>with the following Camel route, only the <strong>@NotNull</strong> constraints on the attributes manufacturer and licensePlate will be validated (Camel uses the default group <code>javax.validation.groups.Default</code>).</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[from("direct:start")
-.to("bean-validator://x")
-.to("mock:end")
-]]></script>
-</div></div><p>If you want to check the constraints from the group <code>OptionalChecks</code>, you have to define the route like this</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[from("direct:start")
-.to("bean-validator://x?group=OptionalChecks")
-.to("mock:end")
-]]></script>
-</div></div><p>If you want to check the constraints from both groups, you have to define a new interface first</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeHeader panelHeader pdl" style="border-bottom-width: 1px;"><b>AllChecks.java</b></div><div class="codeContent panelContent pdl">
-<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[@GroupSequence({Default.class, OptionalChecks.class})
-public interface AllChecks {
-}
-]]></script>
-</div></div><p>and then your route definition should looks like this</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[from("direct:start")
-.to("bean-validator://x?group=AllChecks")
-.to("mock:end")
-]]></script>
-</div></div><p>And if you have to provide your own message interpolator, traversable resolver and constraint validator factory, you have to write a route like this</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[<bean id="myMessageInterpolator" class="my.ConstraintValidatorFactory" />
-<bean id="myTraversableResolver" class="my.TraversableResolver" />
-<bean id="myConstraintValidatorFactory" class="my.ConstraintValidatorFactory" />
-
-from("direct:start")
-.to("bean-validator://x?group=AllChecks&messageInterpolator=#myMessageInterpolator
-&traversableResolver=#myTraversableResolver&constraintValidatorFactory=#myConstraintValidatorFactory")
-.to("mock:end")
-]]></script>
-</div></div><p>It's also possible to describe your constraints as XML and not as Java annotations. In this case, you have to provide the file <code>META-INF/validation.xml</code> which could looks like this</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeHeader panelHeader pdl" style="border-bottom-width: 1px;"><b>validation.xml</b></div><div class="codeContent panelContent pdl">
-<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[<?xml version="1.0" encoding="UTF-8"?>
-<validation-config
- xmlns="http://jboss.org/xml/ns/javax/validation/configuration"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://jboss.org/xml/ns/javax/validation/configuration">
- <default-provider>org.hibernate.validator.HibernateValidator</default-provider>
- <message-interpolator>org.hibernate.validator.engine.ResourceBundleMessageInterpolator</message-interpolator>
- <traversable-resolver>org.hibernate.validator.engine.resolver.DefaultTraversableResolver</traversable-resolver>
- <constraint-validator-factory>org.hibernate.validator.engine.ConstraintValidatorFactoryImpl</constraint-validator-factory>
-
- <constraint-mapping>/constraints-car.xml</constraint-mapping>
-</validation-config>
-]]></script>
-</div></div><p>and the <code>constraints-car.xml</code> file</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeHeader panelHeader pdl" style="border-bottom-width: 1px;"><b>constraints-car.xml</b></div><div class="codeContent panelContent pdl">
-<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[<?xml version="1.0" encoding="UTF-8"?>
-<constraint-mappings xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://jboss.org/xml/ns/javax/validation/mapping validation-mapping-1.0.xsd"
- xmlns="http://jboss.org/xml/ns/javax/validation/mapping">
- <default-package>org.apache.camel.component.bean.validator</default-package>
-
- <bean class="CarWithoutAnnotations" ignore-annotations="true">
- <field name="manufacturer">
- <constraint annotation="javax.validation.constraints.NotNull" />
- </field>
-
- <field name="licensePlate">
- <constraint annotation="javax.validation.constraints.NotNull" />
-
- <constraint annotation="javax.validation.constraints.Size">
- <groups>
- <value>org.apache.camel.component.bean.validator.OptionalChecks</value>
- </groups>
- <element name="min">5</element>
- <element name="max">14</element>
- </constraint>
- </field>
- </bean>
-</constraint-mappings>
-]]></script>
-</div></div><p></p><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>
+<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>
-<h3 id="BookComponentAppendix-URIformat.5">URI format</h3>
+<h3 id="BookComponentAppendix-URIformat.4">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[
@@ -900,7 +769,7 @@ browse:someName[?options]
</div></div>
-<h3 id="BookComponentAppendix-SeeAlso.6">See Also</h3>
+<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">
<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[<dependency>
@@ -910,7 +779,7 @@ browse:someName[?options]
<!-- use the same version as your Camel core version -->
</dependency>
]]></script>
-</div></div><h3 id="BookComponentAppendix-URIformat.6">URI format</h3><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+</div></div><h3 id="BookComponentAppendix-URIformat.5">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[cache://cacheName[?options]
]]></script>
</div></div><p>You can append query options to the URI in the following format, <code>?option=value&option=#beanRef&...</code></p><h3 id="BookComponentAppendix-Options.3">Options</h3><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p> Name </p></th><th colspan="1" rowspan="1" class="confluenceTh"><p> Default Value </p></th><th colspan="1" rowspan="1" class="confluenceTh"><p> Description </p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>maxElementsInMemory</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>1000</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> The number of elements that may be stored in the defined cache </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>memoryStoreEvictionPolicy</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>MemoryStoreEvictionPolicy.LFU</code> </p></td
><td colspan="1" rowspan="1" class="confluenceTd"><p> The number of elements that may be stored in the defined cache. Options include</p>
@@ -1090,7 +959,7 @@ browse:someName[?options]
<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>
-<h3 id="BookComponentAppendix-URIformat.7">URI format</h3>
+<h3 id="BookComponentAppendix-URIformat.6">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[
@@ -1154,7 +1023,7 @@ For example to use the <code>MyFooBean</
</div>
-<h3 id="BookComponentAppendix-SeeAlso.7">See Also</h3>
+<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>
@@ -1174,7 +1043,7 @@ Using this component in combination with
]]></script>
</div></div>
-<h3 id="BookComponentAppendix-URIformat.8">URI format</h3>
+<h3 id="BookComponentAppendix-URIformat.7">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[
@@ -1269,7 +1138,7 @@ commetdComponent.setSslContextParameters
</div></div>
-<h3 id="BookComponentAppendix-SeeAlso.8">See Also</h3>
+<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>
@@ -1291,7 +1160,7 @@ commetdComponent.setSslContextParameters
]]></script>
</div></div>
-<h3 id="BookComponentAppendix-URIformat.9">URI format</h3>
+<h3 id="BookComponentAppendix-URIformat.8">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[
@@ -1312,7 +1181,7 @@ camelContextId:localEndpointName[?option
<p>You can append query options to the URI in the following format, <code>?option=value&option=value&...</code></p>
-<h3 id="BookComponentAppendix-Example.1">Example</h3>
+<h3 id="BookComponentAppendix-Example">Example</h3>
<p>In this example we'll create a black box context, then we'll use it from another CamelContext.</p>
@@ -1414,7 +1283,7 @@ registry.bind("accounts", blac
<ul class="alternate"><li>Bruce Schneier's Applied Cryptography</li><li>Beginning Cryptography with Java by David Hook</li><li>The ever insightful Wikipedia <a shape="rect" class="external-link" href="http://en.wikipedia.org/wiki/Digital_signature" rel="nofollow">Digital_signatures</a></li></ul>
-<h3 id="BookComponentAppendix-URIformat.10">URI format</h3>
+<h3 id="BookComponentAppendix-URIformat.9">URI format</h3>
<p>As mentioned Camel provides a pair of crypto endpoints to create and verify signatures</p>
@@ -1643,7 +1512,7 @@ template.send("direct:alias-verify&
]]></script>
</div></div>
-<h3 id="BookComponentAppendix-SeeAlso.9">See Also</h3>
+<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">
@@ -1659,11 +1528,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.rbtoc1392707955014 {padding: 0px;}
-div.rbtoc1392707955014 ul {list-style: disc;margin-left: 0px;}
-div.rbtoc1392707955014 li {margin-left: 0px;padding-left: 0px;}
+div.rbtoc1393341581747 {padding: 0px;}
+div.rbtoc1393341581747 ul {list-style: disc;margin-left: 0px;}
+div.rbtoc1393341581747 li {margin-left: 0px;padding-left: 0px;}
-/*]]>*/</style></p><div class="toc-macro rbtoc1392707955014">
+/*]]>*/</style></p><div class="toc-macro rbtoc1393341581747">
<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>
@@ -1688,7 +1557,7 @@ div.rbtoc1392707955014 li {margin-left:
<p>If you want to learn about CXF dependencies you can checkout the <code><a shape="rect" class="external-link" href="http://svn.apache.org/repos/asf/cxf/trunk/distribution/src/main/release/lib/WHICH_JARS">WHICH-JARS</a></code> text file.</p>
</div>
</div>
-<h3 id="BookComponentAppendix-URIformat.11">URI format</h3><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<h3 id="BookComponentAppendix-URIformat.10">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[cxf:bean:cxfEndpoint[?options]
]]></script>
</div></div><p>Where <strong>cxfEndpoint</strong> represents a bean ID that references a bean in the Spring bean registry. With this URI format, most of the endpoint details are specified in the bean definition.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
@@ -2276,7 +2145,7 @@ public static class MyProcessor implemen
}
}
]]></script>
-</div></div><p><strong>Message Mode:</strong> Attachments are not supported as it does not process the message at all.</p><h3 id="BookComponentAppendix-StreamingSupportinPAYLOADmode">Streaming Support in PAYLOAD mode</h3><p>In 2.8.2, the camel-cxf component now supports streaming of incoming messages when using PAYLOAD mode. Previously, the incoming messages would have been completely DOM parsed. For large messages, this is time consuming and uses a significant amount of memory. Starting in 2.8.2, the incoming messages can remain as a javax.xml.transform.Source while being routed and, if nothing modifies the payload, can then be directly streamed out to the target destination. For common "simple proxy" use cases (example: from("cxf:...").to("cxf:...")), this can provide very significant performance increases as well as significantly lowered memory requirements.</p><p>However, there are cases where streaming may not be appropriate or desired. Due to the streaming nature, invalid inco
ming XML may not be caught until later in the processing chain. Also, certain actions may require the message to be DOM parsed anyway (like WS-Security or message tracing and such) in which case the advantages of the streaming is limited. At this point, there are two ways to control the streaming:</p><ul><li>Endpoint property: you can add "allowStreaming=false" as an endpoint property to turn the streaming on/off.</li></ul><ul><li>Component property: the CxfComponent object also has an allowStreaming property that can set the default for endpoints created from that component.</li></ul><ul><li>Global system property: you can add a system property of "org.apache.camel.component.cxf.streaming" to "false" to turn if off. That sets the global default, but setting the endpoint property above will override this value for that endpoint.</li></ul><p></p><h3 id="BookComponentAppendix-SeeAlso.10">See Also</h3>
+</div></div><p><strong>Message Mode:</strong> Attachments are not supported as it does not process the message at all.</p><h3 id="BookComponentAppendix-StreamingSupportinPAYLOADmode">Streaming Support in PAYLOAD mode</h3><p>In 2.8.2, the camel-cxf component now supports streaming of incoming messages when using PAYLOAD mode. Previously, the incoming messages would have been completely DOM parsed. For large messages, this is time consuming and uses a significant amount of memory. Starting in 2.8.2, the incoming messages can remain as a javax.xml.transform.Source while being routed and, if nothing modifies the payload, can then be directly streamed out to the target destination. For common "simple proxy" use cases (example: from("cxf:...").to("cxf:...")), this can provide very significant performance increases as well as significantly lowered memory requirements.</p><p>However, there are cases where streaming may not be appropriate or desired. Due to the streaming nature, invalid inco
ming XML may not be caught until later in the processing chain. Also, certain actions may require the message to be DOM parsed anyway (like WS-Security or message tracing and such) in which case the advantages of the streaming is limited. At this point, there are two ways to control the streaming:</p><ul><li>Endpoint property: you can add "allowStreaming=false" as an endpoint property to turn the streaming on/off.</li></ul><ul><li>Component property: the CxfComponent object also has an allowStreaming property that can set the default for endpoints created from that component.</li></ul><ul><li>Global system property: you can add a system property of "org.apache.camel.component.cxf.streaming" to "false" to turn if off. That sets the global default, but setting the endpoint property above will override this value for that endpoint.</li></ul><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>
@@ -2291,7 +2160,7 @@ public static class MyProcessor implemen
</div>
-<h3 id="BookComponentAppendix-URIformat.12">URI format</h3>
+<h3 id="BookComponentAppendix-URIformat.11">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[
@@ -2359,7 +2228,7 @@ cxfbean:serviceBeanRef
<version>x.x.x</version> <!-- use the same version as your Camel core version -->
</dependency>
]]></script>
-</div></div><h3 id="BookComponentAppendix-URIformat.13">URI format</h3><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+</div></div><h3 id="BookComponentAppendix-URIformat.12">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[cxfrs://address?options
]]></script>
</div></div><p>Where <strong>address</strong> represents the CXF endpoint's address</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
@@ -2368,12 +2237,7 @@ cxfbean:serviceBeanRef
</div></div><p>Where <strong>rsEndpoint</strong> represents the spring bean's name which presents the CXFRS client or server</p><p>For either style above, you can append options to the URI as follows:</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[cxfrs:bean:cxfEndpoint?resourceClasses=org.apache.camel.rs.Example
]]></script>
-</div></div><h3 id="BookComponentAppendix-Options.9">Options</h3><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p> Name </p></th><th colspan="1" rowspan="1" class="confluenceTh"><p> Description </p></th><th colspan="1" rowspan="1" class="confluenceTh"><p> Example </p></th><th colspan="1" rowspan="1" class="confluenceTh"><p> Required? </p></th><th colspan="1" rowspan="1" class="confluenceTh"><p> default value </p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>resourceClasses</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> The resource classes which you want to export as REST service. Multiple classes can be separated by comma. </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>resourceClasses=org.apache.camel.rs.Example1,</code><br clear="none">
-<code>org.apache.camel.rs.Exchange2</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> No </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <em>None</em> </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>resourceClass</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <strong>Deprecated</strong>: Use <code>resourceClasses</code> The resource class which you want to export as REST service. </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>resourceClass =org.apache.camel.rs.Example1</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> No </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <em>None</em> </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>httpClientAPI</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <strong>new to Camel 2.1</strong> If it is true, the CxfRsProducer will use the HttpClientAPI to invoke the se
rvice <br clear="none" class="atl-forced-newline">
-If it is false, the CxfRsProducer will use the ProxyClientAPI to invoke the service </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> httpClientAPI=true </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> No </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <em>true</em> </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> synchronous </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> New in 2.5, this option will let CxfRsConsumer decide to use sync or async API to do the underlying work. The default value is false which means it will try to use async API by default. </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> synchronous=true </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> No </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> false </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> throwExceptionOnFailure </p></td><td colspan="1" rowspan="1" class="confluenc
eTd"><p> New in 2.6, this option tells the CxfRsProducer to inspect return codes and will generate an Exception if the return code is larger than 207. </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> throwExceptionOnFailure=true </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> No </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> true </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>maxClientCacheSize</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> New in 2.6, you can set a IN message header CamelDestinationOverrideUrl to dynamically override the target destination Web Service or REST Service defined in your routes.  The implementation caches CXF clients or ClientFactoryBean in CxfProvider and CxfRsProvider.  This option allows you to configure the maximum size of the cache. <br clear="none" class="atl-forced-newline"> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> maxClien
tCacheSize=5 </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> No <br clear="none" class="atl-forced-newline"> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> 10 </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>setDefaultBus</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> New in 2.9.0. Will set the default bus when CXF endpoint create a bus by itself </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>setDefaultBus=true</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> No </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>false</code> </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>bus</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> New in 2.9.0. A default bus created by CXF Bus Factory. Use <code>#</code> notation to reference a bus object from the registry. The referenced object must be an instance of <code
>org.apache.cxf.Bus</code>. </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>bus=#busName</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> No </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <em>None</em> </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>bindingStyle</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <strong>As of 2.11</strong>. Sets how requests and responses will be mapped to/from Camel. Two values are possible: </p>
-<ul class="alternate"><li><code>SimpleConsumer</code> => see the <a shape="rect" href="#BookComponentAppendix-ConsumingaRESTRequest-SimpleBindingStyle">Consuming a REST Request with the Simple Binding Style</a> below.</li><li><code>Default</code> => the default style. For consumers this passes on a <code>MessageContentsList</code> to the route, requiring low-level processing in the route.</li></ul>
-</td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>bindingStyle=SimpleConsumer</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> No </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <em>Default</em> </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>providers</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <strong>Since Camel 2.12.2</strong> set custom JAX-RS providers list to the CxfRs endpoint. </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> No </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <em>None</em> </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>schemaLocations</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <strong>Since Camel 2.12.2</strong> Sets the locations of the schemas which can be used to validate the incoming XML or JAXB-driven JSON. </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> NO <
/p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <em>None</em> </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>features</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <strong>Since Camel 2.12.3</strong> Set the feature list to the CxfRs endpoint. </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> No </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <em>None</em> </p></td></tr></tbody></table></div>
-<p>You can also configure the CXF REST endpoint through the spring configuration. Since there are lots of difference between the CXF REST client and CXF REST Server, we provide different configuration for them.<br clear="none"> Please check out the <a shape="rect" class="external-link" href="http://svn.apache.org/repos/asf/camel/trunk/components/camel-cxf/src/main/resources/schema/cxfEndpoint.xsd">schema file</a> and <a shape="rect" class="external-link" href="http://cwiki.apache.org/CXF20DOC/jax-rs.html">CXF REST user guide</a> for more information.</p><h3 id="BookComponentAppendix-HowtoconfiguretheRESTendpointinCamel">How to configure the REST endpoint in Camel</h3><p>In <a shape="rect" class="external-link" href="http://svn.apache.org/repos/asf/camel/trunk/components/camel-cxf/src/main/resources/schema/cxfEndpoint.xsd">camel-cxf schema file</a>, there are two elements for the REST endpoint definition. <strong>cxf:rsServer</strong> for REST consumer, <strong>cxf:rsClient</strong>
for REST producer.<br clear="none"> You can find a Camel REST service route configuration example here.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+</div></div><h3 id="BookComponentAppendix-Options.9">Options</h3><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Name</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Description</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Example</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Required?</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>default value</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>resourceClasses</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The resource classes which you want to export as REST service. Multiple classes can be separated by comma.</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>resourceClasses=org.apache.camel.rs.Example1,</code><br clear="none"> <code>org.apache.camel.rs.Exchange2</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>No</p></td><td colspa
n="1" rowspan="1" class="confluenceTd"><p><em>None</em></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>resourceClass</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Deprecated</strong>: Use <code>resourceClasses</code> The resource class which you want to export as REST service.</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>resourceClass =org.apache.camel.rs.Example1</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><em>None</em></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>httpClientAPI</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>new to Camel 2.1</strong> If it is true, the CxfRsProducer will use the HttpClientAPI to invoke the service <br clear="none" class="atl-forced-newline"> If it is false, the CxfRsProducer will use the ProxyClientAPI to invoke the service</p></td
><td colspan="1" rowspan="1" class="confluenceTd"><p>httpClientAPI=true</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><em>true</em></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>synchronous</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>New in 2.5, this option will let CxfRsConsumer decide to use sync or async API to do the underlying work. The default value is false which means it will try to use async API by default.</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>synchronous=true</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>false</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>throwExceptionOnFailure</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>New in 2.6, this option tells the CxfRsProducer to inspect return codes and will generate an Exception
if the return code is larger than 207.</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>throwExceptionOnFailure=true</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>true</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>maxClientCacheSize</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>New in 2.6, you can set a IN message header CamelDestinationOverrideUrl to dynamically override the target destination Web Service or REST Service defined in your routes.  The implementation caches CXF clients or ClientFactoryBean in CxfProvider and CxfRsProvider.  This option allows you to configure the maximum size of the cache.</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>maxClientCacheSize=5</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>10</p></td></tr><tr><td colspan=
"1" rowspan="1" class="confluenceTd"><p><code>setDefaultBus</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>New in 2.9.0. Will set the default bus when CXF endpoint create a bus by itself</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>setDefaultBus=true</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>bus</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>New in 2.9.0. A default bus created by CXF Bus Factory. Use <code>#</code> notation to reference a bus object from the registry. The referenced object must be an instance of <code>org.apache.cxf.Bus</code>.</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>bus=#busName</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1" rowspan="1" class="confluenceT
d"><p><em>None</em></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>bindingStyle</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>As of 2.11</strong>. Sets how requests and responses will be mapped to/from Camel. Two values are possible:</p><ul class="alternate"><li><code>SimpleConsumer</code> => see the <a shape="rect" href="#BookComponentAppendix-ConsumingaRESTRequest-SimpleBindingStyle">Consuming a REST Request with the Simple Binding Style</a> below.</li><li><code>Default</code> => the default style. For consumers this passes on a <code>MessageContentsList</code> to the route, requiring low-level processing in the route.</li></ul></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>bindingStyle=SimpleConsumer</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><em>Default</em></p></td></tr><tr><td colspan="1" rowspan="1" class="conflu
enceTd"><span>providers</span></td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Since Camel 2.12.2</strong><span> set custom JAX-RS providers list to the CxfRs endpoint.</span></td><td colspan="1" rowspan="1" class="confluenceTd">providers=#MyProviders</td><td colspan="1" rowspan="1" class="confluenceTd">No</td><td colspan="1" rowspan="1" class="confluenceTd"><em>None</em></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><span>schemaLocations</span></td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Since Camel 2.12.2</strong><span> Sets the locations of the schemas which can be used to validate the incoming XML or JAXB-driven JSON.</span></td><td colspan="1" rowspan="1" class="confluenceTd">schemaLocations=#MySchemaLocations</td><td colspan="1" rowspan="1" class="confluenceTd">No</td><td colspan="1" rowspan="1" class="confluenceTd"><em>None</em></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><span>features</span></td><td colspan="1"
rowspan="1" class="confluenceTd"><strong>Since Camel 2.12.3</strong><span> Set the feature list to the CxfRs endpoint.</span></td><td colspan="1" rowspan="1" class="confluenceTd">features=#MyFeatures</td><td colspan="1" rowspan="1" class="confluenceTd">No</td><td colspan="1" rowspan="1" class="confluenceTd"><em>None</em></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">properties</td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Since Camel 2.12.4</strong><span> Set the properties to the CxfRs endpoint.</span></td><td colspan="1" rowspan="1" class="confluenceTd">properties=#MyProperties</td><td colspan="1" rowspan="1" class="confluenceTd">No</td><td colspan="1" rowspan="1" class="confluenceTd"><em>None</em></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">inInterceptors</td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Since Camel 2.12.4</strong><span> Set the inInterceptors to the CxfRs endpoint.</span></td><td colspan="1" rowspan="1
" class="confluenceTd">inInterceptors=#MyInterceptors</td><td colspan="1" rowspan="1" class="confluenceTd">No</td><td colspan="1" rowspan="1" class="confluenceTd"><em>None</em></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">outInterceptors</td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Since Camel 2.12.4</strong><span> Set the outInterceptor to the CxfRs endpoint.</span></td><td colspan="1" rowspan="1" class="confluenceTd"><span>outInterceptors=#MyInterceptors</span></td><td colspan="1" rowspan="1" class="confluenceTd"><span>No</span></td><td colspan="1" rowspan="1" class="confluenceTd"><em>None</em></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">inFaultInterceptors</td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Since Camel 2.12.4</strong><span> Set the inFaultInterceptors to the CxfRs endpoint.</span></td><td colspan="1" rowspan="1" class="confluenceTd"><span>inFaultInterceptors=#MyInterceptors</span></td><td colspan="1" row
span="1" class="confluenceTd"><span>No</span></td><td colspan="1" rowspan="1" class="confluenceTd"><em>None</em></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">outFaultIntercetpros</td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Since Camel 2.12.4</strong><span> Set the outFaultInterceptors to the CxfRs endpoint.</span></td><td colspan="1" rowspan="1" class="confluenceTd"><span>outFaultInterceptors=#MyInterceptors</span></td><td colspan="1" rowspan="1" class="confluenceTd"><span>No</span></td><td colspan="1" rowspan="1" class="confluenceTd"><em>None</em></td></tr></tbody></table></div><p>You can also configure the CXF REST endpoint through the spring configuration. Since there are lots of difference between the CXF REST client and CXF REST Server, we provide different configuration for them.<br clear="none"> Please check out the <a shape="rect" class="external-link" href="http://svn.apache.org/repos/asf/camel/trunk/components/camel-cxf/src/main/resources/
schema/cxfEndpoint.xsd">schema file</a> and <a shape="rect" class="external-link" href="http://cwiki.apache.org/CXF20DOC/jax-rs.html">CXF REST user guide</a> for more information.</p><h3 id="BookComponentAppendix-HowtoconfiguretheRESTendpointinCamel">How to configure the REST endpoint in Camel</h3><p>In <a shape="rect" class="external-link" href="http://svn.apache.org/repos/asf/camel/trunk/components/camel-cxf/src/main/resources/schema/cxfEndpoint.xsd">camel-cxf schema file</a>, there are two elements for the REST endpoint definition. <strong>cxf:rsServer</strong> for REST consumer, <strong>cxf:rsClient</strong> for REST producer.<br clear="none"> You can find a Camel REST service route configuration example here.</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[
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
@@ -2624,7 +2488,7 @@ inMessage.setHeader(CxfConstants.CAMEL_C
<p>Camel will use the <a shape="rect" href="log.html">throughput logger</a> when sending dataset's. </p>
-<h3 id="BookComponentAppendix-URIformat.14">URI format</h3>
+<h3 id="BookComponentAppendix-URIformat.13">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[
@@ -2653,7 +2517,7 @@ dataset:name[?options]
]]></script>
</div></div>
-<h3 id="BookComponentAppendix-Example.2">Example</h3>
+<h3 id="BookComponentAppendix-Example.1">Example</h3>
<p>For example, to test that a set of messages are sent to a queue and then consumed from the queue without losing any messages:</p>
@@ -2676,7 +2540,7 @@ from("activemq:SomeQueue").to(
<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Property</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Type</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>defaultBody</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>Object</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code><hello>world!</hello></code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> Specifies the default message body. For SimpleDataSet it is a constant payload; though if you want to create custom payloads per message, create your own derivation of <code>DataSetSupport</code>. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>reportCount</code> </p></td><td colspan="1" rowspan="1" class="confl
uenceTd"><p> <code>long</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>-1</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> Specifies the number of messages to be received before reporting progress. Useful for showing progress of a large load test. If < 0, then <code>size</code> / 5, if is 0 then <code>size</code>, else set to <code>reportCount</code> value.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>size</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>long</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>10</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Specifies how many messages to send/consume.</p></td></tr></tbody></table>
</div>
-<h3 id="BookComponentAppendix-SeeAlso.11">See Also</h3>
+<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>
@@ -2694,7 +2558,7 @@ from("activemq:SomeQueue").to(
<p>If you do not wish to delete the object when it has been processed, you can specify <code>consumeDelete=false</code> on the URI. This will result in the POJO being processed each poll.</p>
-<h3 id="BookComponentAppendix-URIformat.15">URI format</h3>
+<h3 id="BookComponentAppendix-URIformat.14">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[
@@ -2709,7 +2573,7 @@ db4o:className[?options]
<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p> Name </p></th><th colspan="1" rowspan="1" class="confluenceTh"><p> Default Value </p></th><th colspan="1" rowspan="1" class="confluenceTh"><p> Description </p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>consumeDelete</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>true</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> Option for <code>Db4oConsumer</code> only. Specifies whether or not the entity is deleted after it is consumed.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>consumer.delay</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>500</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> Option for consumer only. Delay in millis between each poll. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>consumer.initialDel
ay</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>1000</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> Option for consumer only. Millis before polling starts. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>consumer.userFixedDelay</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>false</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> Option for consumer only. Set to <code>true</code> to use fixed delay between polls, otherwise fixed rate is used. See <a shape="rect" class="external-link" href="http://java.sun.com/j2se/1.5.0/docs/api/java/util/concurrent/ScheduledExecutorService.html" rel="nofollow">ScheduledExecutorService</a> in JDK for details. </p></td></tr></tbody></table>
</div>
-<h3 id="BookComponentAppendix-SeeAlso.12">See Also</h3>
+<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">
<p class="title">Asynchronous</p>
@@ -2725,7 +2589,7 @@ db4o:className[?options]
<p>The <a shape="rect" href="vm.html">VM</a> component provides connections between Camel contexts as long they run in the same <strong>JVM</strong>.</p>
</div>
</div>
-<h3 id="BookComponentAppendix-URIformat.16">URI format</h3><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<h3 id="BookComponentAppendix-URIformat.15">URI format</h3><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
<script class="theme: Default; brush: text; gutter: false" type="syntaxhighlighter"><![CDATA[direct:someName[?options]
]]></script>
</div></div><p>Where <strong>someName</strong> can be any string to uniquely identify the endpoint</p><h3 id="BookComponentAppendix-Options.12">Options</h3><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Name</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Default Value</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>allowMultipleConsumers</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>@deprecated</strong> If set to <code>false</code>, then when a second consumer is started on the endpoint, an <code>IllegalStateException</code> is thrown. <strong>Will be removed in Camel 2.1:</strong> Direct endpoint does not support multiple consumers.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"
><p><code>block</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11.1:</strong> If sending a message to a direct endpoint which has no active consumer, then we can tell the producer to block and wait for the consumer to become active.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>timeout</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>30000</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11.1:</strong> The timeout value to use if block is enabled.</p></td></tr></tbody></table></div><pre>You can append query options to the URI in the following format, ?option=value&option=value&...</pre><p> </p><h3 id="BookComponentAppendix-Samples.1">Samples</h3><p>In the route below we use the direct component to link the two routes together:</p><div class="code panel pdl" style="border-
width: 1px;"><div class="codeContent panelContent pdl">
@@ -2750,7 +2614,7 @@ from("direct:processOrder")
<to uri="activemq:queue:order.out"/>
</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.13">See Also</h3>
+</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>
@@ -2783,7 +2647,7 @@ If you use Apache ServiceMix or Apache K
]]></script>
</div></div>
-<h3 id="BookComponentAppendix-URIformat.17">URI format</h3>
+<h3 id="BookComponentAppendix-URIformat.16">URI format</h3>
<p>The URI scheme for a DNS component is as follows</p>
@@ -2849,7 +2713,7 @@ The name to lookup must be provided in t
<p>The query must be provided in the header with key <code>"dns.query"</code>.</p>
-<h3 id="BookComponentAppendix-SeeAlso.14">See Also</h3>
+<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>
<p><strong>Available as of Camel 2.4</strong></p>
@@ -2869,7 +2733,7 @@ The name to lookup must be provided in t
</div></div>
-<h3 id="BookComponentAppendix-URIformat.18">URI format</h3>
+<h3 id="BookComponentAppendix-URIformat.17">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[
@@ -3009,10 +2873,10 @@ However if you need to access a applicat
-<h3 id="BookComponentAppendix-SeeAlso.15">See Also</h3>
+<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.19">URI format</h3><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<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">
@@ -3033,10 +2897,10 @@ To configure Esper via a configuration f
<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[ EventBean newEvent = exchange.getIn(EsperMessage.class).getNewEvent();
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.16">See Also</h3>
+</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.20">URI format</h3><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<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">
@@ -3056,7 +2920,7 @@ To configure Esper via a configuration f
<p>Beware the JDK File IO API is a bit limited in detecting whether another application is currently writing/copying a file. And the implementation can be different depending on OS platform as well. This could lead to that Camel thinks the file is not locked by another process and start consuming it. Therefore you have to do you own investigation what suites your environment. To help with this Camel provides different <code>readLock</code> options and <code>doneFileName</code> option that you can use. See also the section <em>Consuming files from folders where others drop files directly</em>.</p>
</div>
</div>
-<h3 id="BookComponentAppendix-URIOptions.2">URI Options</h3><h4 id="BookComponentAppendix-Common">Common</h4><div class="confluenceTableSmall">
+<h3 id="BookComponentAppendix-URIOptions.1">URI Options</h3><h4 id="BookComponentAppendix-Common">Common</h4><div class="confluenceTableSmall">
<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p> Name </p></th><th colspan="1" rowspan="1" class="confluenceTh"><p> Default Value </p></th><th colspan="1" rowspan="1" class="confluenceTh"><p> Description </p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>autoCreate</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>true</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> Automatically create missing directories in the file's pathname. For the file consumer, that means creating the starting directory. For the file producer, it means the directory the files should be written to. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>bufferSize</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> 128kb </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> Write buffer sized in bytes. </p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p> <code>fileName</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>null</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> Use <a shape="rect" href="expression.html" title="Expression">Expression</a> such as <a shape="rect" href="file-language.html" title="File Language">File Language</a> to dynamically set the filename. For consumers, it's used as a filename filter. For producers, it's used to evaluate the filename to write. If an expression is set, it take precedence over the <code>CamelFileName</code> header. (<strong>Note:</strong> The header itself can also be an <a shape="rect" href="expression.html" title="Expression">Expression</a>). The expression options support both <code>String</code> and <code>Expression</code> types. If the expression is a <code>String</code> type, it is <strong>always</strong> evaluated using the <a shape="rect" href="file-language.html" title="File Language">File Language</a>. If the e
xpression is an <code>Expression</code> type, the specified <code>Expression</code> type is used - this allows you, for instance, to use <a shape="rect" href="ognl.html" title="OGNL">OGNL</a> expressions. For the consumer, you can use it to filter filenames, so you can for instance consume today's file using the <a shape="rect" href="file-language.html" title="File Language">File Language</a> syntax: <code>mydata-${date:now:yyyyMMdd}.txt</code>. From <strong>Camel 2.11</strong> onwards the producers support the <code>CamelOverruleFileName</code> header which takes precedence over any existing <code>CamelFileName</code> header; the <code>CamelOverruleFileName</code> is a header that is used only once, and makes it easier as this avoids to temporary store <code>CamelFileName</code> and have to restore it afterwards. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>flatten</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>false</code
> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> Flatten is used to flatten the file name path to strip any leading paths, so it's just the file name. This allows you to consume recursively into sub-directories, but when you eg write the files to another directory they will be written in a single directory. Setting this to <code>true</code> on the producer enforces that any file name recived in <code>CamelFileName</code> header will be stripped for any leading paths. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>charset</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>null</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <strong>Camel 2.9.3:</strong> this option is used to specify the encoding of the file, and camel will set the Exchange property with <code>Exchange.CHARSET_NAME</code> with the value of this option. You can use this on the consumer, to specify the encodings of the files, whic
h allow Camel to know the charset it should load the file content in case the file content is being accessed. Likewise when writing a file, you can use this option to specify which charset to write the file as well. See further below for a examples and more important details. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>copyAndDeleteOnRenameFail</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>true</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <strong>Camel 2.9</strong>: whether to fallback and do a copy and delete file, in case the file could not be renamed directly. This option is not available for the <a shape="rect" href="ftp2.html" title="FTP2">FTP</a> component. </p></td></tr></tbody></table>
</div><h4 id="BookComponentAppendix-Consumer">Consumer</h4><div class="confluenceTableSmall">
<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p> Name </p></th><th colspan="1" rowspan="1" class="confluenceTh"><p> Default Value </p></th><th colspan="1" rowspan="1" class="confluenceTh"><p> Description </p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>initialDelay</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>1000</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> Milliseconds before polling the file/directory starts. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>delay</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>500</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> Milliseconds before the next poll of the file/directory. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>useFixedDelay</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> 
</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> Controls if fixed delay or fixed rate is used. See <a shape="rect" class="external-link" href="http://java.sun.com/j2se/1.5.0/docs/api/java/util/concurrent/ScheduledExecutorService.html" rel="nofollow">ScheduledExecutorService</a> in JDK for details. In <strong>Camel 2.7.x</strong> or older the default value is <code>false</code>. From <strong>Camel 2.8</strong> onwards the default value is <code>true</code>. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>runLoggingLevel</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>TRACE</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <strong>Camel 2.8:</strong> The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>recursive</code> </p></td><td colspan="1" rowspan="
1" class="confluenceTd"><p> <code>false</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> If a directory, will look for files in all the sub-directories as well. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>delete</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>false</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> If <code>true</code>, the file will be deleted <strong>after</strong> it is processed </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>noop</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>false</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> If <code>true</code>, the file is not moved or deleted in any way. This option is good for readonly data, or for <a shape="rect" href="etl.html" title="ETL">ETL</a> type requirements. If <code>noop=true</code>, Camel will set <code>idempotent=true</code> as well,
to avoid consuming the same files over and over again. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>preMove</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>null</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <a shape="rect" href="expression.html" title="Expression">Expression</a> (such as <a shape="rect" href="file-language.html" title="File Language">File Language</a>) used to dynamically set the filename when moving it <strong>before</strong> processing. For example to move in-progress files into the <code>order</code> directory set this value to <code>order</code>. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>move</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>.camel</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <a shape="rect" href="expression.html" title="Expression">Expression</a> (such as <a shape="rect" href="file
-language.html" title="File Language">File Language</a>) used to dynamically set the filename when moving it <strong>after</strong> processing. To move files into a <code>.done</code> subdirectory just enter <code>.done</code>. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>moveFailed</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>null</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <a shape="rect" href="expression.html" title="Expression">Expression</a> (such as <a shape="rect" href="file-language.html" title="File Language">File Language</a>) used to dynamically set a different target directory when moving files after processing (configured via <code>move</code> defined above) failed. For example, to move files into a <code>.error</code> subdirectory use: <code>.error</code>. Note: When moving the files to the “fail” location Camel will <strong>handle</strong> the error and will not pick up
the file again. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>include</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>null</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> Is used to include files, if filename matches the regex pattern. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>exclude</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>null</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> Is used to exclude files, if filename matches the regex pattern. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>antInclude</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>null</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <strong>Camel 2.10:</strong> Ant style filter inclusion, for example <code>antInclude=*</code><code><strong>/</strong></code><code>.txt</code>. Mu
ltiple inclusions may be specified in comma-delimited format. See <a shape="rect" href="#BookComponentAppendix-FilteringusingANTpathmatcher">below</a> for more details about ant path filters. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>antExclude</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>null</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <strong>Camel 2.10:</strong> Ant style filter exclusion. If both <code>antInclude</code> and <code>antExclude</code> are used, <code>antExclude</code> takes precedence over <code>antInclude</code>. Multiple exclusions may be specified in comma-delimited format. See <a shape="rect" href="#BookComponentAppendix-FilteringusingANTpathmatcher">below</a> for more details about ant path filters. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>antFilterCaseSensitive</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>t
rue</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <strong>Camel 2.11:</strong> Ant style filter which is case sensitive or not. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>idempotent</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>false</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> Option to use the <a shape="rect" href="idempotent-consumer.html" title="Idempotent Consumer">Idempotent Consumer</a> EIP pattern to let Camel skip already processed files. Will by default use a memory based LRUCache that holds 1000 entries. If <code>noop=true</code> then idempotent will be enabled as well to avoid consuming the same files over and over again. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>idempotentKey</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>Expression</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>
<strong>Camel 2.11:</strong> To use a custom idempotent key. By default the absolute path of the file is used. You can use the <a shape="rect" href="file-language.html" title="File Language">File Language</a>, for example to use the file name and file size, you can do: </p>
@@ -3065,7 +2929,7 @@ To configure Esper via a configuration f
</div></div>
<p>. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>idempotentRepository</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>null</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> A pluggable repository <a shape="rect" class="external-link" href="http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/spi/IdempotentRepository.html">org.apache.camel.spi.IdempotentRepository</a> which by default use <code>MemoryMessageIdRepository</code> if none is specified and <code>idempotent</code> is <code>true</code>. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>inProgressRepository</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>memory</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> A pluggable in-progress repository <a shape="rect" class="external-link" href="http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/
camel/spi/IdempotentRepository.html">org.apache.camel.spi.IdempotentRepository</a>. The in-progress repository is used to account the current in progress files being consumed. By default a memory based repository is used. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>filter</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>null</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> Pluggable filter as a <code>org.apache.camel.component.file.GenericFileFilter</code> class. Will skip files if filter returns <code>false</code> in its <code>accept()</code> method. More details in section below. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>sorter</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>null</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> Pluggable sorter as a <a shape="rect" class="external-link" href="http://java.sun.com/j2se/1.5.0
/docs/api/java/util/Comparator.html" rel="nofollow">java.util.Comparator<org.apache.camel.component.file.GenericFile></a> class. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>sortBy</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>null</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> Built-in sort using the <a shape="rect" href="file-language.html" title="File Language">File Language</a>. Supports nested sorts, so you can have a sort by file name and as a 2nd group sort by modified date. See sorting section below for details. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>readLock</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>markerFile</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> Used by consumer, to only poll the files if it has exclusive read-lock on the file (i.e. the file is not in-progress or being written). Camel
will wait until the file lock is granted. <br clear="none" class="atl-forced-newline">
[... 2062 lines stripped ...]