Modified: websites/production/camel/content/cache/main.pageCache ============================================================================== Binary files - no diff available.
Modified: websites/production/camel/content/dataset.html ============================================================================== --- websites/production/camel/content/dataset.html (original) +++ websites/production/camel/content/dataset.html Mon Jan 30 23:19:04 2017 @@ -88,28 +88,34 @@ <div class="wiki-content maincontent"><h2 id="DataSet-DataSetComponent">DataSet Component</h2><p><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>.</p><p>The DataSet component provides a mechanism to easily perform load & soak testing of your system. It works by allowing you to create <a shape="rect" class="external-link" href="http://camel.apache.org/maven/current/c amel-core/apidocs/org/apache/camel/component/dataset/DataSet.html">DataSet instances</a> both as a source of messages and as a way to assert that the data set is received.</p><p>Camel will use the <a shape="rect" href="log.html">throughput logger</a> when sending dataset's.</p><h3 id="DataSet-URIformat">URI format</h3><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> <script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[dataset:name[?options] ]]></script> -</div></div><p>Where <strong>name</strong> is used to find the <a shape="rect" class="external-link" href="http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/component/dataset/DataSet.html";>DataSet instance</a> in the <a shape="rect" href="registry.html">Registry</a></p><p>Camel ships with a support implementation of <code>org.apache.camel.component.dataset.DataSet</code>, the <code>org.apache.camel.component.dataset.DataSetSupport</code> class, that can be used as a base for implementing your own DataSet. Camel also ships with some implementations that can be used for testing:  <code>org.apache.camel.component.dataset.SimpleDataSet</code>, <code><span>org.apache.camel.component.dataset.ListDataSet</span></code><span> and </span><code><span><span>org.apache.camel.component.dataset.FileDataSet</span></span></code><span><span>, all of which extend <code>DataSetSupport</code>.</span></span></p><h3 id="DataSet-Options">Options</h3><div class="conflu enceTableSmall"><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>produceDelay</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>3</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Allows a delay in ms to be specified, which causes producers to pause in order to simulate slow producers. Uses a minimum of 3 ms delay unless you set this option to -1 to force no delay at all.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>consumeDelay</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>0</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Allows a delay in ms to be specified, which causes consumers to pause in order to simulate slow consumers.</p></td></tr><tr><t d colspan="1" rowspan="1" class="confluenceTd"><p><code>preloadSize</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>0</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Sets how many messages should be preloaded (sent) before the route completes its initialization.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>initialDelay</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>1000</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.1:</strong> Time period in millis to wait before starting sending messages.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>minRate</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>0</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Wait until the DataSet contains at least this number of messages</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><code>dataSetIndex</code></td><td colspan="1" ro wspan="1" class="confluenceTd"><code>lenient</code></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.17:</strong> Controls the behavior of the <em>CamelDataSetIndex</em> header. The supported values are <code>strict</code>, <code>lenient</code> and <code>off</code>. The default behavior prior to <strong>Camel 2.17</strong> can be restored using <code><span>dataSetIndex</span>=strict</code></p><p>For consumers:<br clear="none"> - <code>strict</code> or <code>lenient</code> => The <em>CamelDataSetIndex</em> header will always be set<br clear="none"> - <code>off</code> => The <em>CamelDataSetIndex</em> header will not be set</p><p>For producers:<br clear="none"> - <code>strict</code> => The <em>CamelDataSetIndex</em> header must be present and the value of the header will be verified<br clear="none"> - <code>lenient</code> => If the <em>CamelDataSetIndex</em> header is present, the value of the header will be verified. If the header is not present, it will be set.<br clear="none"> - <code>off</code> => If the <em>CamelDataSetIndex</em> header is present, the value of the header will not be verified. If the header is not present, it will not be set.</p></td></tr></tbody></table> -</div></div><p>You can append query options to the URI in the following format, <code>?option=value&option=value&...</code></p><h3 id="DataSet-ConfiguringDataSet">Configuring DataSet</h3><p>Camel will lookup in the <a shape="rect" href="registry.html">Registry</a> for a bean implementing the DataSet interface. So you can register your own DataSet as:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> -<script class="brush: xml; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[ <bean id="myDataSet" class="com.mycompany.MyDataSet"> - <property name="size" value="100"/> - </bean> +</div></div><p>Where <strong><code>name</code></strong> is used to find the <a shape="rect" class="external-link" href="http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/component/dataset/DataSet.html";>DataSet instance</a> in the <a shape="rect" href="registry.html">Registry</a></p><p>Camel ships with a support implementation of <strong><code>org.apache.camel.component.dataset.DataSet</code></strong>, the <strong><code>org.apache.camel.component.dataset.DataSetSupport</code></strong> class, that can be used as a base for implementing your own <strong><code>DataSet</code></strong>.</p><p>Camel also ships with some implementations that can be used for testing:  </p><ul><li><strong><code>org.apache.camel.component.dataset.SimpleDataSet</code></strong></li><li><strong><code>org.apache.camel.component.dataset.ListDataSet</code></strong><span> <br clear="none"></span></li><li><strong><code>org.apache.camel.component.dataset.FileDataSet</code></strong><span><sp an><br clear="none"></span></span></li></ul><p><span><span>all of which extend <strong><code>DataSetSupport</code></strong>.</span></span></p><h3 id="DataSet-Options">Options</h3><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>produceDelay</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>3</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Allows a delay in ms to be specified, which causes producers to pause in order to simulate slow producers.</p><p>Uses a minimum of <strong><code>3ms</code></strong> delay. Set to <strong><code>-1</code></strong> to force no delay at all.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>consumeDelay</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>0</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Allows a delay in ms to be specified, which cau ses consumers to pause in order to simulate slow consumers.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>preloadSize</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>0</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Sets how many messages should be pre-loaded (sent) before the route completes its initialization.</p></td></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><strong>Camel 2.1:</strong> Time period in milliseconds to wait before starting sending messages.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>minRate</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>0</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Wait until the <strong><code>DataSet</code></stro ng> contains at least this number of messages.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><code>dataSetIndex</code></td><td colspan="1" rowspan="1" class="confluenceTd"><code>lenient</code></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.17:</strong> Controls the behavior of the <strong><code>CamelDataSetIndex</code></strong> header.</p><p>The supported values are:</p> + <ul><li><strong><code>strict</code></strong></li><li><strong><code>lenient</code></strong></li><li><strong><code>off</code></strong></li></ul><p>The default behavior prior to <strong>Camel 2.17</strong> can be restored using <strong><code>dataSetIndex=strict</code></strong>.</p> + <div class="table-wrap"> + <table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh">Client Type</th><th colspan="1" rowspan="1" class="confluenceTh"><code>dataSetIndex</code> Value</th><th colspan="1" rowspan="1" class="confluenceTh"><strong><code>CamelDataSetIndex</code></strong> Header Behavior</th></tr><tr><td colspan="1" rowspan="3" class="confluenceTd">Consumer<br clear="none"><br clear="none"></td><td colspan="1" rowspan="1" class="confluenceTd"><code>strict</code></td><td colspan="1" rowspan="2" class="confluenceTd" style="text-align: left;">The header will always be set.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><code>lenient</code></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><code>off</code></td><td colspan="1" rowspan="1" class="confluenceTd">The header will NOT be set.</td></tr><tr><td colspan="1" rowspan="3" class="confluenceTd">Producer<br clear="none"><br clear="none"></td><td colspan="1" rowspan="1" class="conflu enceTd"><code>strict</code></td><td colspan="1" rowspan="1" class="confluenceTd">The header must be present and the value of the header will be verified.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><code>lenient</code></td><td colspan="1" rowspan="1" class="confluenceTd">If the header is present, the value of the header will be verified. If the header is not present, it will be set.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><code>off</code></td><td colspan="1" rowspan="1" class="confluenceTd">If the header is present, the value of the header will not be verified. If the header is not present, it will not be set.</td></tr></tbody></table> + </div></td></tr></tbody></table> +</div></div><p>You can append query options to the URI in the following format: <strong><code>?option=value&option=value&...</code></strong></p><h3 id="DataSet-ConfiguringDataSet">Configuring DataSet</h3><p>Camel will lookup in the <a shape="rect" href="registry.html">Registry</a> for a bean implementing the <strong><code>DataSet</code></strong> interface. So you can register your own <strong><code>DataSet</code></strong> as:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> +<script class="brush: xml; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[<bean id="myDataSet" class="com.mycompany.MyDataSet"> + <property name="size" value="100"/> +</bean> ]]></script> </div></div><h3 id="DataSet-Example">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><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> -<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[// send the dataset to a queue -from("dataset:foo").to("activemq:SomeQueue"); +<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[// Send the dataset to a queue +from("dataset:foo") + .to("activemq:SomeQueue"); -// now lets test that the messages are consumed correctly -from("activemq:SomeQueue").to("dataset:foo"); +// Now lets test that the messages are consumed correctly +from("activemq:SomeQueue") + .to("dataset:foo"); ]]></script> -</div></div><p>The above would look in the <a shape="rect" href="registry.html">Registry</a> to find the <strong>foo</strong> DataSet instance which is used to create the messages.</p><p>Then you create a DataSet implementation, such as using the <code>SimpleDataSet</code> as described below, configuring things like how big the data set is and what the messages look like etc.  </p><p> </p><h2 id="DataSet-DataSetSupport(abstractclass)"><code>DataSetSupport</code> (abstract class)</h2><p>The DataSetSupport abstract class is a nice starting point for new DataSets, and provides some useful features to derived classes.</p><h3 id="DataSet-PropertiesonDataSetSupport">Properties on DataSetSupport</h3><div class="confluenceTableSmall"><div class="table-wrap"> - <table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Property</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>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>defaultHeaders</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>Map<String,Object></code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</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>outputTransformer</code></p></td><td colspan="1" rowspan="1" class="confluenceTd">< p><code>org.apache.camel.Processor</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><span style="font-family: monospace;">null</span></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> </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><tr><td colspan="1" rowspan="1" class="confluenceTd"><code>reportCount</code></td><td colspan="1" rowspan="1" class="confluenceTd"><code>long</code></td><td colspan="1" rowspan="1" class="confluenceTd"><code>-1</code></td><td colspan="1" rowspan="1" class="confluenceTd"><span>Specifies the number of messages to be received before reporting progress. Useful for showing progress of a large load test. If < 0, then < /span><code>size</code><span> / 5, if is 0 then </span><code>size</code><span>, else set to </span><code>reportCount</code><span> value.</span></td></tr></tbody></table> -</div></div><h3 id="DataSet-SimpleDataSet"><code>SimpleDataSet</code></h3><p>The <code>SimpleDataSet</code> extends <code>DataSetSupport</code>, and adds a default body.</p><h3 id="DataSet-AdditionalPropertiesonSimpleDataSet">Additional Properties on SimpleDataSet</h3><div class="confluenceTableSmall"><div class="table-wrap"> - <table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Property</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>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. By default, the <code>SimpleDataSet</code> produces the same constant payload for each exchange. If you want to customize the payload for each exchange, create a Camel <code>Processor</code> and configure the <code>SimpleDataSet</code> to use it by setting the <code>outputTransformer</code> property.</p></td>< /tr></tbody></table> -</div></div><h3 id="DataSet-ListDataSet(Camel2.17)"><code>ListDataSet (Camel 2.17)</code></h3><p>The List<code>DataSet</code> extends <code>DataSetSupport</code>, and adds a list of default bodies.</p><h3 id="DataSet-AdditionalPropertiesonListDataSet">Additional Properties on ListDataSet</h3><div class="confluenceTableSmall"><div class="table-wrap"> - <table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Property</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>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>defaultBodies</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>List<Object></code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>empty LinkedList<Object></code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Specifies the default message body. By default, the <code>ListDataSet</code><span> selects a constant payload from the list of <code>defaultBodies</code> using the <code>CamelDataSetIndex</code>. If you want to customize the payload, create a Camel </span><code>Processor</code> and configure the <code>ListDataSet</code><span> to use i t by setting the </span><code>outputTransformer</code><span> property.</span></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>the size of the defaultBodies list</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><span>Specifies how many messages to send/consume. This value can be different from the size of the <code>defaultBodies</code> list. If the value is less than the size of the <code>defaultBodies</code> list, some of the list elements will not be used. If the value is greater than the size of the <code>defaultBodies</code> list, the payload for the exchange will be selected using the modulus of the <code>CamelDataSetIndex</code> and the size of the <code>defaultBodies</code> list (i.e. <code>CamelDataSetIndex % defaultBodies.size()</code> )</span></p></td></tr></tbody></table> -</div></div><h3 id="DataSet-FileDataSet(Camel2.17)"><code>FileDataSet (Camel 2.17)</code></h3><p>The <code>SimpleDataSet</code> extends <code>ListDataSet</code>, and adds support for loading the bodies from a file.</p><h3 id="DataSet-AdditionalPropertiesonFileDataSet">Additional Properties on FileDataSet</h3><div class="confluenceTableSmall"><div class="table-wrap"> - <table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Property</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>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>sourceFile</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>File</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><span style="font-family: monospace;">null</span></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Specifies the source file for payloads</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>delimiter</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><span style="font-family: monospace;">\z</span></p></td><td colspan="1" rows pan="1" class="confluenceTd"><p>Specifies the delimiter pattern used by a <code>java.util.Scanner</code> to split the file into multiple payloads.</p></td></tr></tbody></table> +</div></div><p>The above would look in the <a shape="rect" href="registry.html">Registry</a> to find the <strong><code>foo</code></strong> <strong><code>DataSet</code></strong> instance which is used to create the messages. Then you create a <strong>DataSet</strong> implementation, such as using the <strong><code>SimpleDataSet</code></strong> as described below, configuring things like how big the data set is and what the messages look like etc.  </p><p> </p><h2 id="DataSet-DataSetSupport(abstractclass)"><strong><code>DataSetSupport</code></strong> (abstract class)</h2><p>The <strong><code>DataSetSupport</code></strong> abstract class is a nice starting point for new DataSets, and provides some useful features to derived classes.</p><h3 id="DataSet-PropertiesonDataSetSupport">Properties on <code>DataSetSupport</code></h3><div class="confluenceTableSmall"><div class="table-wrap"> + <table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Property</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>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>defaultHeaders</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>Map<String,Object></code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Specifies the default message body.</p><p>For <strong><code>SimpleDataSet</code></strong> it is a constant payload; though if you want to create custom payloads per message, create your own derivation of <strong><code>DataSetSupport</code></strong>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>outputTransformer</code>< /p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>org.apache.camel.Processor</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><span style="font-family: monospace;">null</span></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> </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><tr><td colspan="1" rowspan="1" class="confluenceTd"><code>reportCount</code></td><td colspan="1" rowspan="1" class="confluenceTd"><code>long</code></td><td colspan="1" rowspan="1" class="confluenceTd"><code>-1</code></td><td colspan="1" rowspan="1" class="confluenceTd"><p><span>Specifies the number of messages to be received before reporting progress. Useful for showing progress of a large load test. </span></p><p><span>If < 0, then </span><strong><code>size</code></strong><span><strong> / 5</strong></span></p><p><span>If == 0 then </span><strong><code>size</code></strong><span> </span></p><p><span>Else set to </span><strong><code>reportCount</code></strong><span> value.</span></p></td></tr></tbody></table> +</div></div><h3 id="DataSet-SimpleDataSet"><code>SimpleDataSet</code></h3><p>The <strong><code>SimpleDataSet</code></strong> extends <strong><code>DataSetSupport</code></strong>, and adds a default body.</p><h3 id="DataSet-AdditionalPropertiesonSimpleDataSet">Additional Properties on SimpleDataSet</h3><div class="confluenceTableSmall"><div class="table-wrap"> + <table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Property</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>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. By default, the <strong><code>SimpleDataSet</code></strong> produces the same constant payload for each exchange. If you want to customize the payload for each exchange, create a Camel <strong><code>Processor</code></strong> and configure the <strong><code>SimpleDataSet</code></strong> to use it by setting the <strong><code>outputTransformer</code></strong> property.</p></td></tr></tbody></table> +</div></div><h3 id="DataSet-ListDataSet(Camel2.17)"><code>ListDataSet (Camel 2.17)</code></h3><p>The <strong><code>ListDataSet</code></strong> extends <strong><code>DataSetSupport</code></strong>, and adds a list of default bodies.</p><h3 id="DataSet-AdditionalPropertiesonListDataSet">Additional Properties on ListDataSet</h3><div class="confluenceTableSmall"><div class="table-wrap"> + <table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Property</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>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>defaultBodies</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>List<Object></code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>empty LinkedList<Object></code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Specifies the default message body. By default, the <strong><code>ListDataSet</code></strong><span> selects a constant payload from the list of <strong><code>defaultBodies</code></strong> using the <strong><code>CamelDataSetIndex</code></strong>. If you want to customize the payload, create a Camel </span><strong><code>Processor</code ></strong> and configure the <strong><code>ListDataSet</code></strong><span> >to use it by setting the ></span><strong><code>outputTransformer</code></strong><span> >property.</span></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>the size of >the <strong><code>defaultBodies</code></strong> list</p></td><td >colspan="1" rowspan="1" class="confluenceTd"><p><span>Specifies how many >messages to send/consume. This value can be different from the size of the ><strong><code>defaultBodies</code></strong> list. If the value is less than >the size of the <strong><code>defaultBodies</code></strong> list, some of the >list elements will not be used. If the value is greater than the size of the ><strong><code>defaultBodies</code></strong> list, the payload for the >exchange will be selected using the modulus of the <strong><c ode>CamelDataSetIndex</code></strong> and the size of the <strong><code>defaultBodies</code></strong> list (i.e. <code><strong>CamelDataSetIndex</strong> <strong>% defaultBodies.size()</strong></code> )</span></p></td></tr></tbody></table> +</div></div><h3 id="DataSet-FileDataSet(Camel2.17)"><code>FileDataSet (Camel 2.17)</code></h3><p>The <strong><code>SimpleDataSet</code></strong> extends <strong><code>ListDataSet</code></strong>, and adds support for loading the bodies from a file.</p><h3 id="DataSet-AdditionalPropertiesonFileDataSet">Additional Properties on <code>FileDataSet</code></h3><div class="confluenceTableSmall"><div class="table-wrap"> + <table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Property</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>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>sourceFile</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>File</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><span style="font-family: monospace;">null</span></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Specifies the source file for payloads</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>delimiter</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><span style="font-family: monospace;">\z</span></p></td><td colspan="1" rows pan="1" class="confluenceTd"><p>Specifies the delimiter pattern used by a <strong><code>java.util.Scanner</code></strong> to split the file into multiple payloads.</p></td></tr></tbody></table> </div></div><p></p><h3 id="DataSet-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><ul><li><a shape="rect" href="spring-testing.html">Spring Testing</a></li></ul></div> </td> Modified: websites/production/camel/content/sql-component.html ============================================================================== --- websites/production/camel/content/sql-component.html (original) +++ websites/production/camel/content/sql-component.html Mon Jan 30 23:19:04 2017 @@ -220,21 +220,38 @@ template.requestBodyAndHeader("dire .to("sql:select * from projects where project in (:#in:names) order by id") .to("log:query") .to("mock:query");]]></script> -</div></div><p> </p><h2 id="SQLComponent-UsingtheJDBCbasedidempotentrepository">Using the JDBC based idempotent repository</h2><p><strong>Available as of Camel 2.7</strong>: In this section we will use the JDBC based idempotent repository.</p><div class="confluence-information-macro confluence-information-macro-tip"><p class="title">Abstract class</p><span class="aui-icon aui-icon-small aui-iconfont-approve confluence-information-macro-icon"></span><div class="confluence-information-macro-body"> </div></div><p>From Camel 2.9 onwards there is an abstract class <code>org.apache.camel.processor.idempotent.jdbc.AbstractJdbcMessageIdRepository</code> you can extend to build custom JDBC idempotent repository.</p><p> </p><p>First we have to create the database table which will be used by the idempotent repository. For <strong>Camel 2.7</strong>, we use the following schema:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> -<script class="brush: sql; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[Â ]]></script> -</div></div><p>CREATE TABLE CAMEL_MESSAGEPROCESSED ( processorName VARCHAR(255), messageId VARCHAR(100) )</p><p> </p><p>In <strong>Camel 2.8</strong>, we added the createdAt column:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> -<script class="brush: sql; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[Â ]]></script> -</div></div><p>CREATE TABLE CAMEL_MESSAGEPROCESSED ( processorName VARCHAR(255), messageId VARCHAR(100), createdAt TIMESTAMP )</p><p> </p><p> </p><div class="confluence-information-macro confluence-information-macro-warning"><span class="aui-icon aui-icon-small aui-iconfont-error confluence-information-macro-icon"></span><div class="confluence-information-macro-body"> </div></div><p class="wysiwyg-macro-body">The SQL Server <strong>TIMESTAMP</strong> type is a fixed-length binary-string type. It does not map to any of the JDBC time types: <strong>DATE</strong>, <strong>TIME</strong>, or <strong>TIMESTAMP</strong>.</p><p> </p><p> </p><p>We recommend to have a unique constraint on the columns processorName and messageId. Because the syntax for this constraint differs for database to database, we do not show it here.</p><p>Second we need to setup a <code>javax.sql.DataSource</code> in the spring XML file:</p><p> </p><p>{snippet:id=e1|lang=xml|url=came l/trunk/components/camel-sql/src/test/resources/org/apache/camel/processor/idempotent/jdbc/spring.xml}</p><p> </p><p> </p><p>And finally we can create our JDBC idempotent repository in the spring XML file as well:</p><p> </p><p>{snippet:id=e2|lang=xml|url=camel/trunk/components/camel-sql/src/test/resources/org/apache/camel/processor/idempotent/jdbc/spring.xml}</p><p> </p><p> </p><p>Customize the JdbcMessageIdRepository</p><p>Starting with <strong>Camel 2.9.1</strong> you have a few options to tune the <code>org.apache.camel.processor.idempotent.jdbc.JdbcMessageIdRepository</code> for your needs:</p><p class="confluenceTable"> </p><p> </p><p class="confluenceTh"> </p><p>Parameter</p><p> </p><p class="confluenceTh"> </p><p>Default Value</p><p> </p><p>Description</p><p> </p><p> </p><p class="confluenceTd"> </p><p>createTableIfNotExists</p><p> </p><p class="confluenceTd"> </p><p>true</p><p> </p><p>Defin es whether or not Camel should try to create the table if it doesn't exist.</p><p> </p><p> </p><p class="confluenceTd"> </p><p>tableExistsString</p><p> </p><p class="confluenceTd"> </p><p>SELECT 1 FROM CAMEL_MESSAGEPROCESSED WHERE 1 = 0</p><p> </p><p>This query is used to figure out whether the table already exists or not. It must throw an exception to indicate the table doesn't exist.</p><p> </p><p> </p><p class="confluenceTd"> </p><p>createString</p><p> </p><p class="confluenceTd"> </p><p>CREATE TABLE CAMEL_MESSAGEPROCESSED (processorName VARCHAR(255), messageId VARCHAR(100), createdAt TIMESTAMP)</p><p> </p><p>The statement which is used to create the table.</p><p> </p><p> </p><p class="confluenceTd"> </p><p>queryString</p><p> </p><p class="confluenceTd"> </p><p>SELECT COUNT(*) FROM CAMEL_MESSAGEPROCESSED WHERE processorName = ? AND messageId = ?</p><p> </p><p>The query which is used to figur e out whether the message already exists in the repository (the result is not equals to '0'). It takes two parameters. This first one is the processor name (<code>String</code>) and the second one is the message id (<code>String</code>).</p><p> </p><p> </p><p class="confluenceTd"> </p><p>insertString</p><p> </p><p class="confluenceTd"> </p><p>INSERT INTO CAMEL_MESSAGEPROCESSED (processorName, messageId, createdAt) VALUES (?, ?, ?)</p><p> </p><p>The statement which is used to add the entry into the table. It takes three parameter. The first one is the processor name (<code>String</code>), the second one is the message id (<code>String</code>) and the third one is the timestamp (<code>java.sql.Timestamp</code>) when this entry was added to the repository.</p><p> </p><p class="confluenceTd"> </p><p>deleteString</p><p> </p><p class="confluenceTd"> </p><p>DELETE FROM CAMEL_MESSAGEPROCESSED WHERE processorName = ? AND messageId = ?</p><p>& #160;</p><p>The statement which is used to delete the entry from the database. It takes two parameter. This first one is the processor name (<code>String</code>) and the second one is the message id (<code>String</code>).</p><p> </p><p>A customized <code>org.apache.camel.processor.idempotent.jdbc.JdbcMessageIdRepository</code> could look like:</p><p> </p><p>{snippet:id=e1|lang=xml|url=camel/trunk/components/camel-sql/src/test/resources/org/apache/camel/processor/idempotent/jdbc/customized-spring.xml}</p><p> </p><p> </p><p>Using the JDBC based aggregation repository</p><p><strong>Available as of Camel 2.6</strong></p><div class="confluence-information-macro confluence-information-macro-information"><p class="title">Using JdbcAggregationRepository in Camel 2.6</p><span class="aui-icon aui-icon-small aui-iconfont-info confluence-information-macro-icon"></span><div class="confluence-information-macro-body"> </div></div><p>In Camel 2.6, the JdbcAggregationReposit ory is provided in the <code>camel-jdbc-aggregator</code> component. From Camel 2.7 onwards, the <code>JdbcAggregationRepository</code> is provided in the <code>camel-sql</code> component.</p><p> </p><p><code>JdbcAggregationRepository</code> is an <code>AggregationRepository</code> which on the fly persists the aggregated messages. This ensures that you will not loose messages, as the default aggregator will use an in memory only <code>AggregationRepository</code>.<br clear="none"> The <code>JdbcAggregationRepository</code> allows together with Camel to provide persistent support for the <a shape="rect" href="aggregator2.html">Aggregator</a>.</p><p>It has the following options:</p><p class="confluenceTable"> </p><p> </p><p class="confluenceTh"> </p><p>Option</p><p> </p><p class="confluenceTh"> </p><p>Type</p><p> </p><p>Description</p><p> </p><p> </p><p class="confluenceTd"> </p><p><code>dataSource</code></p><p> </p><p class="con fluenceTd"> </p><p><code>DataSource</code></p><p> </p><p><strong>Mandatory:</strong> The <code>javax.sql.DataSource</code> to use for accessing the database.</p><p> </p><p> </p><p class="confluenceTd"> </p><p><code>repositoryName</code></p><p> </p><p class="confluenceTd"> </p><p><code>String</code></p><p> </p><p><strong>Mandatory:</strong> The name of the repository.</p><p> </p><p> </p><p class="confluenceTd"> </p><p><code>transactionManager</code></p><p> </p><p class="confluenceTd"> </p><p><code>TransactionManager</code></p><p> </p><p><strong>Mandatory:</strong> The <code>org.springframework.transaction.PlatformTransactionManager</code> to mange transactions for the database. The TransactionManager must be able to support databases.</p><p> </p><p> </p><p class="confluenceTd"> </p><p><code>lobHandler</code></p><p> </p><p class="confluenceTd"> </p><p><code>LobHandler</code></p><p> </p> <p>A <code>org.springframework.jdbc.support.lob.LobHandler</code> to handle Lob types in the database. Use this option to use a vendor specific LobHandler, for example when using Oracle.</p><p> </p><p> </p><p class="confluenceTd"> </p><p><code>returnOldExchange</code></p><p> </p><p class="confluenceTd"> </p><p>boolean</p><p> </p><p>Whether the get operation should return the old existing Exchange if any existed. By default this option is <code>false</code> to optimize as we do not need the old exchange when aggregating.</p><p> </p><p> </p><p class="confluenceTd"> </p><p><code>useRecovery</code></p><p> </p><p class="confluenceTd"> </p><p>boolean</p><p> </p><p>Whether or not recovery is enabled. This option is by default <code>true</code>. When enabled the Camel <a shape="rect" href="aggregator2.html">Aggregator</a> automatic recover failed aggregated exchange and have them resubmitted.</p><p> </p><p> </p><p class=" confluenceTd"> </p><p><code>recoveryInterval</code></p><p> </p><p class="confluenceTd"> </p><p>long</p><p> </p><p>If recovery is enabled then a background task is run every x'th time to scan for failed exchanges to recover and resubmit. By default this interval is 5000 millis.</p><p> </p><p> </p><p class="confluenceTd"> </p><p><code>maximumRedeliveries</code></p><p> </p><p class="confluenceTd"> </p><p>int</p><p> </p><p>Allows you to limit the maximum number of redelivery attempts for a recovered exchange. If enabled then the Exchange will be moved to the dead letter channel if all redelivery attempts failed. By default this option is disabled. If this option is used then the <code>deadLetterUri</code> option must also be provided.</p><p> </p><p> </p><p class="confluenceTd"> </p><p><code>deadLetterUri</code></p><p> </p><p class="confluenceTd"> </p><p>String</p><p> </p><p>An endpoint uri for a <a shape="re ct" href="dead-letter-channel.html">Dead Letter Channel</a> where exhausted recovered Exchanges will be moved. If this option is used then the <code>maximumRedeliveries</code> option must also be provided.</p><p> </p><p> </p><p class="confluenceTd"> </p><p><code>storeBodyAsText</code></p><p> </p><p class="confluenceTd"> </p><p>boolean</p><p> </p><p><strong>Camel 2.11:</strong> Whether to store the message body as String which is human readable. By default this option is <code>false</code> storing the body in binary format.</p><p> </p><p> </p><p class="confluenceTd"> </p><p><code>headersToStoreAsText</code></p><p> </p><p class="confluenceTd"> </p><p><code>List<String></code></p><p> </p><p><strong>Camel 2.11:</strong> Allows to store headers as String which is human readable. By default this option is disabled, storing the headers in binary format.</p><p> </p><p> </p><p class="confluenceTd"> </p><p><code> optimisticLocking</code></p><p> </p><p class="confluenceTd"> </p><p><code>false</code></p><p> </p><p><strong>Camel 2.12:</strong> To turn on optimistic locking, which often would be needed in clustered environments where multiple Camel applications shared the same JDBC based aggregation repository.</p><p> </p><p class="confluenceTd"> </p><p><code>jdbcOptimisticLockingExceptionMapper</code></p><p> </p><p class="confluenceTd"> </p><p> </p><p> </p><p><strong>Camel 2.12:</strong> Allows to plugin a custom <code>org.apache.camel.processor.aggregate.jdbc.JdbcOptimisticLockingExceptionMapper</code> to map vendor specific error codes to an optimistick locking error, for Camel to perform a retry. This requires <code>optimisticLocking</code> to be enabled.</p><p> </p><p>What is preserved when persisting</p><p><code>JdbcAggregationRepository</code> will only preserve any <code>Serializable</code> compatible data types. If a data type is not suc h a type its dropped and a <code>WARN</code> is logged. And it only persists the <code>Message</code> body and the <code>Message</code> headers. The <code>Exchange</code> properties are <strong>not</strong> persisted.</p><p>From Camel 2.11 onwards you can store the message body and select(ed) headers as String in separate columns.</p><p>Recovery</p><p>The <code>JdbcAggregationRepository</code> will by default recover any failed <a shape="rect" href="exchange.html">Exchange</a>. It does this by having a background tasks that scans for failed <a shape="rect" href="exchange.html">Exchange</a>s in the persistent store. You can use the <code>checkInterval</code> option to set how often this task runs. The recovery works as transactional which ensures that Camel will try to recover and redeliver the failed <a shape="rect" href="exchange.html">Exchange</a>. Any <a shape="rect" href="exchange.html">Exchange</a> which was found to be recovered will be restored from the persistent store and r esubmitted and send out again.</p><p>The following headers is set when an <a shape="rect" href="exchange.html">Exchange</a> is being recovered/redelivered:</p><p class="confluenceTable"> </p><p> </p><p class="confluenceTh"> </p><p>Header</p><p> </p><p class="confluenceTh"> </p><p>Type</p><p> </p><p>Description</p><p> </p><p> </p><p class="confluenceTd"> </p><p><code>Exchange.REDELIVERED</code></p><p> </p><p class="confluenceTd"> </p><p>Boolean</p><p> </p><p>Is set to true to indicate the <a shape="rect" href="exchange.html">Exchange</a> is being redelivered.</p><p> </p><p class="confluenceTd"> </p><p><code>Exchange.REDELIVERY_COUNTER</code></p><p> </p><p class="confluenceTd"> </p><p>Integer</p><p> </p><p>The redelivery attempt, starting from 1.</p><p> </p><p>Only when an <a shape="rect" href="exchange.html">Exchange</a> has been successfully processed it will be marked as complete which happens when the <code>confirm</code> method is invoked on the <code>AggregationRepository</code>. This means if the same <a shape="rect" href="exchange.html">Exchange</a> fails again it will be kept retried until it success.</p><p>You can use option <code>maximumRedeliveries</code> to limit the maximum number of redelivery attempts for a given recovered <a shape="rect" href="exchange.html">Exchange</a>. You must also set the <code>deadLetterUri</code> option so Camel knows where to send the <a shape="rect" href="exchange.html">Exchange</a> when the <code>maximumRedeliveries</code> was hit.</p><p>You can see some examples in the unit tests of camel-sql, for example <a shape="rect" class="external-link" href="https://svn.apache.org/repos/asf/camel/trunk/components/camel-sql/src/test/java/org/apache/camel/processor/aggregate/jdbc/JdbcAggregateRecoverDeadLetterChannelTest.java";>this test</a>.</p><p>Database</p><p>To be operational, each aggregator uses two table: the aggregation and completed one. By convention the completed has the same name as the aggregation one suffixed with <code>"_COMPLETED"</code>. The name must be configured in the Spring bean with the <code>RepositoryName</code> property. In the following example aggregation will be used.</p><p>The table structure definition of both table are identical: in both case a String value is used as key (<strong>id</strong>) whereas a Blob contains the exchange serialized in byte array.<br clear="none"> However one difference should be remembered: the <strong>id</strong> field does not have the same content depending on the table.<br clear="none"> In the aggregation table <strong>id</strong> holds the correlation Id used by the component to aggregate the messages. In the completed table, <strong>id</strong> holds the id of the exchange stored in corresponding the blob field.</p><p>Here is the SQL query used to create the tables, just replace <code>"aggregation"</code> with your aggregator repository name.</p><div class ="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> -<script class="brush: sql; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[Â ]]></script> -</div></div><p>CREATE TABLE aggregation ( id varchar(255) NOT NULL, exchange blob NOT NULL, constraint aggregation_pk PRIMARY KEY (id) ); CREATE TABLE aggregation_completed ( id varchar(255) NOT NULL, exchange blob NOT NULL, constraint aggregation_completed_pk PRIMARY KEY (id) );</p><p> </p><p>Storing body and headers as text</p><p><strong>Available as of Camel 2.11</strong></p><p>You can configure the <code>JdbcAggregationRepository</code> to store message body and select(ed) headers as String in separate columns. For example to store the body, and the following two headers <code>companyName</code> and <code>accountName</code> use the following SQL:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> -<script class="brush: sql; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[Â ]]></script> -</div></div><p>CREATE TABLE aggregationRepo3 ( id varchar(255) NOT NULL, exchange blob NOT NULL, body varchar(1000), companyName varchar(1000), accountName varchar(1000), constraint aggregationRepo3_pk PRIMARY KEY (id) ); CREATE TABLE aggregationRepo3_completed ( id varchar(255) NOT NULL, exchange blob NOT NULL, body varchar(1000), companyName varchar(1000), accountName varchar(1000), constraint aggregationRepo3_completed_pk PRIMARY KEY (id) );</p><p> </p><p>And then configure the repository to enable this behavior as shown below:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> -<script class="brush: xml; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[Â ]]></script> -</div></div><p><bean id="repo3" class="org.apache.camel.processor.aggregate.jdbc.JdbcAggregationRepository"> <property name="repositoryName" value="aggregationRepo3"/> <property name="transactionManager" ref="txManager3"/> <property name="dataSource" ref="dataSource3"/> <!-- configure to store the message body and following headers as text in the repo --> <property name="storeBodyAsText" value="true"/> <property name="headersToStoreAsText"> <list> <value>companyName</value> <value>accountName</value> </list> </property> </bean></p><p> </p><p>Codec (Serialization)</p><p>Since they can contain any type of payload, Exchanges are not serializable by design. It is converted into a byte array to be stored in a database BLOB field. All those conversions are handled by the <code>JdbcCodec</code> class. One detail of the code requires your attention: the <code>ClassLoadingAwareObjectInputStream</co de>.</p><p>The <code>ClassLoadingAwareObjectInputStream</code> has been reused from the <a shape="rect" class="external-link" href="http://activemq.apache.org/";>Apache ActiveMQ</a> project. It wraps an <code>ObjectInputStream</code> and use it with the <code>ContextClassLoader</code> rather than the <code>currentThread</code> one. The benefit is to be able to load classes exposed by other bundles. This allows the exchange body and headers to have custom types object references.</p><p>Transaction</p><p>A Spring <code>PlatformTransactionManager</code> is required to orchestrate transaction.</p><p>Service (Start/Stop)</p><p>The <code>start</code> method verify the connection of the database and the presence of the required tables. If anything is wrong it will fail during starting.</p><p>Aggregator configuration</p><p>Depending on the targeted environment, the aggregator might need some configuration. As you already know, each aggregator should have its own repository (with the correspo nding pair of table created in the database) and a data source. If the default lobHandler is not adapted to your database system, it can be injected with the <code>lobHandler</code> property.</p><p>Here is the declaration for Oracle:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> -<script class="brush: xml; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[Â ]]></script> -</div></div><p><bean id="lobHandler" class="org.springframework.jdbc.support.lob.OracleLobHandler"> <property name="nativeJdbcExtractor" ref="nativeJdbcExtractor"/> </bean> <bean id="nativeJdbcExtractor" class="org.springframework.jdbc.support.nativejdbc.CommonsDbcpNativeJdbcExtractor"/> <bean id="repo" class="org.apache.camel.processor.aggregate.jdbc.JdbcAggregationRepository"> <property name="transactionManager" ref="transactionManager"/> <property name="repositoryName" value="aggregation"/> <property name="dataSource" ref="dataSource"/> <!-- Only with Oracle, else use default --> <property name="lobHandler" ref="lobHandler"/> </bean></p><p> </p><p>Optimistic locking</p><p>From <strong>Camel 2.12</strong> onwards you can turn on <code>optimisticLocking</code> and use this JDBC based aggregation repository in a clustered environment where multiple Camel applications shared the same database for the aggregation r epository. If there is a race condition there JDBC driver will throw a vendor specific exception which the <code>JdbcAggregationRepository</code> can react upon. To know which caused exceptions from the JDBC driver is regarded as an optimistick locking error we need a mapper to do this. Therefore there is a <code>org.apache.camel.processor.aggregate.jdbc.JdbcOptimisticLockingExceptionMapper</code> allows you to implement your custom logic if needed. There is a default implementation <code>org.apache.camel.processor.aggregate.jdbc.DefaultJdbcOptimisticLockingExceptionMapper</code> which works as follows:</p><p>The following check is done:</p><p>If the caused exception is an <code>SQLException</code> then the SQLState is checked if starts with 23.</p><p>If the caused exception is a <code>DataIntegrityViolationException</code></p><p>If the caused exception class name has "ConstraintViolation" in its name.</p><p>optional checking for FQN class name matches if any class names has been co nfigured</p><p>You can in addition add FQN classnames, and if any of the caused exception (or any nested) equals any of the FQN class names, then its an optimistick locking error.</p><p>Here is an example, where we define 2 extra FQN class names from the JDBC vendor.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> -<script class="brush: xml; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[Â ]]></script> -</div></div><p><bean id="repo" class="org.apache.camel.processor.aggregate.jdbc.JdbcAggregationRepository"> <property name="transactionManager" ref="transactionManager"/> <property name="repositoryName" value="aggregation"/> <property name="dataSource" ref="dataSource"/> <property name"jdbcOptimisticLockingExceptionMapper" ref="myExceptionMapper"/> </bean> <!-- use the default mapper with extra FQN class names from our JDBC driver --> <bean id="myExceptionMapper" class="org.apache.camel.processor.aggregate.jdbc.DefaultJdbcOptimisticLockingExceptionMapper"> <property name="classNames"> <util:set> <value>com.foo.sql.MyViolationExceptoion</value> <value>com.foo.sql.MyOtherViolationExceptoion</value> </util:set> </property> </bean></p><p> </p><p></p><h3 id="SQLComponent-SeeAlso">See Also</h3> +</div></div><p> </p><h2 id="SQLComponent-UsingtheJDBCbasedidempotentrepository">Using the JDBC based idempotent repository</h2><p><strong>Available as of Camel 2.7</strong>: In this section we will use the JDBC based idempotent repository.</p><div class="confluence-information-macro confluence-information-macro-tip"><p class="title">Abstract class</p><span class="aui-icon aui-icon-small aui-iconfont-approve confluence-information-macro-icon"></span><div class="confluence-information-macro-body"> From Camel 2.9 onwards there is an abstract class <code>org.apache.camel.processor.idempotent.jdbc.AbstractJdbcMessageIdRepository</code> you can extend to build custom JDBC idempotent repository.</div></div><p>First we have to create the database table which will be used by the idempotent repository. For <strong>Camel 2.7</strong>, we use the following schema:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> +<script class="brush: sql; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[CREATE TABLE CAMEL_MESSAGEPROCESSED ( processorName VARCHAR(255), messageId VARCHAR(100) )Â ]]></script> +</div></div><p>In <strong>Camel 2.8</strong>, we added the createdAt column:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> +<script class="brush: sql; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[CREATE TABLE CAMEL_MESSAGEPROCESSED ( processorName VARCHAR(255), messageId VARCHAR(100), createdAt TIMESTAMP )Â ]]></script> +</div></div><div class="confluence-information-macro confluence-information-macro-warning"><span class="aui-icon aui-icon-small aui-iconfont-error confluence-information-macro-icon"></span><div class="confluence-information-macro-body"> The SQL Server <strong>TIMESTAMP</strong> type is a fixed-length binary-string type. It does not map to any of the JDBC time types: <strong>DATE</strong>, <strong>TIME</strong>, or <strong>TIMESTAMP</strong>.</div></div><p> </p><p>We recommend to have a unique constraint on the columns processorName and messageId. Because the syntax for this constraint differs for database to database, we do not show it here.</p><p>Second we need to setup a <code>javax.sql.DataSource</code> in the spring XML file:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> +<script class="brush: xml; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[<jdbc:embedded-database id="dataSource" type="DERBY" />Â ]]></script> +</div></div><p><br clear="none">And finally we can create our JDBC idempotent repository in the spring XML file as well:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> +<script class="brush: xml; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[ <bean id="messageIdRepository" class="org.apache.camel.processor.idempotent.jdbc.JdbcMessageIdRepository"> + <constructor-arg ref="dataSource" /> + <constructor-arg value="myProcessorName" /> + </bean>Â ]]></script> +</div></div><p><br clear="none">Customize the JdbcMessageIdRepository</p><p>Starting with <strong>Camel 2.9.1</strong> you have a few options to tune the <code>org.apache.camel.processor.idempotent.jdbc.JdbcMessageIdRepository</code> for your needs:</p><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh">Parameter</th><th colspan="1" rowspan="1" class="confluenceTh">Default Value</th><th colspan="1" rowspan="1" class="confluenceTh">Description</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">createTableIfNotExists</td><td colspan="1" rowspan="1" class="confluenceTd">true</td><td colspan="1" rowspan="1" class="confluenceTd">Defines whether or not Camel should try to create the table if it doesn't exist.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">tableExistsString</td><td colspan="1" rowspan="1" class="confluenceTd">SELECT 1 FROM CAMEL_MESSAGEPROCESSED WHERE 1 = 0</td><td colspan="1" rowspan= "1" class="confluenceTd">This query is used to figure out whether the table already exists or not. It must throw an exception to indicate the table doesn't exist.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>createString</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>CREATE TABLE CAMEL_MESSAGEPROCESSED (processorName VARCHAR(255), messageId VARCHAR(100), createdAt TIMESTAMP)</p></td><td colspan="1" rowspan="1" class="confluenceTd">The statement which is used to create the table.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">queryString</td><td colspan="1" rowspan="1" class="confluenceTd">SELECT COUNT(*) FROM CAMEL_MESSAGEPROCESSED WHERE processorName = ? AND messageId = ?</td><td colspan="1" rowspan="1" class="confluenceTd"><p>The query which is used to figure out whether the message already exists in the repository (the result is not equals to '0'). It takes two parameters. This first one is the processor name (<code>String</code>) a nd the second one is the message id (<code>String</code>).</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">insertString</td><td colspan="1" rowspan="1" class="confluenceTd">INSERT INTO CAMEL_MESSAGEPROCESSED (processorName, messageId, createdAt) VALUES (?, ?, ?)</td><td colspan="1" rowspan="1" class="confluenceTd"><p>The statement which is used to add the entry into the table. It takes three parameter. The first one is the processor name (<code>String</code>), the second one is the message id (<code>String</code>) and the third one is the timestamp (<code>java.sql.Timestamp</code>) when this entry was added to the repository.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">deleteString</td><td colspan="1" rowspan="1" class="confluenceTd">DELETE FROM CAMEL_MESSAGEPROCESSED WHERE processorName = ? AND messageId = ?</td><td colspan="1" rowspan="1" class="confluenceTd"><p>The statement which is used to delete the entry from the database. It takes two parameter. This first one is the processor name (<code>String</code>) and the second one is the message id (<code>String</code>).</p></td></tr></tbody></table></div><p> </p><p>A customized <code>org.apache.camel.processor.idempotent.jdbc.JdbcMessageIdRepository</code> could look like:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> +<script class="brush: xml; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[ <bean id="messageIdRepository" class="org.apache.camel.processor.idempotent.jdbc.JdbcMessageIdRepository"> + <constructor-arg ref="dataSource" /> + <constructor-arg value="myProcessorName" /> + <property name="tableExistsString" value="SELECT 1 FROM CUSTOMIZED_MESSAGE_REPOSITORY WHERE 1 = 0" /> + <property name="createString" value="CREATE TABLE CUSTOMIZED_MESSAGE_REPOSITORY (processorName VARCHAR(255), messageId VARCHAR(100), createdAt TIMESTAMP)" /> + <property name="queryString" value="SELECT COUNT(*) FROM CUSTOMIZED_MESSAGE_REPOSITORY WHERE processorName = ? AND messageId = ?" /> + <property name="insertString" value="INSERT INTO CUSTOMIZED_MESSAGE_REPOSITORY (processorName, messageId, createdAt) VALUES (?, ?, ?)" /> + <property name="deleteString" value="DELETE FROM CUSTOMIZED_MESSAGE_REPOSITORY WHERE processorName = ? AND messageId = ?" /> + </bean>]]></script> +</div></div><p><br clear="none">Using the JDBC based aggregation repository</p><p><strong>Available as of Camel 2.6</strong></p><div class="confluence-information-macro confluence-information-macro-information"><p class="title">Using JdbcAggregationRepository in Camel 2.6</p><span class="aui-icon aui-icon-small aui-iconfont-info confluence-information-macro-icon"></span><div class="confluence-information-macro-body"> In Camel 2.6, the JdbcAggregationRepository is provided in the <code>camel-jdbc-aggregator</code> component. From Camel 2.7 onwards, the <code>JdbcAggregationRepository</code> is provided in the <code>camel-sql</code> component.</div></div><p><code>JdbcAggregationRepository</code> is an <code>AggregationRepository</code> which on the fly persists the aggregated messages. This ensures that you will not loose messages, as the default aggregator will use an in memory only <code>AggregationRepository</code>.</p><p>The <code>JdbcAggregation Repository</code> allows together with Camel to provide persistent support for the <a shape="rect" href="aggregator2.html">Aggregator</a>.</p><p>It has the following options:</p><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh">Option</th><th colspan="1" rowspan="1" class="confluenceTh">Type</th><th colspan="1" rowspan="1" class="confluenceTh">Description</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><span>dataSource</span></td><td colspan="1" rowspan="1" class="confluenceTd"><span>DataSource</span></td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Mandatory:</strong> The <code>javax.sql.DataSource</code> to use for accessing the database.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><span>repositoryName</span></td><td colspan="1" rowspan="1" class="confluenceTd"><span>String</span></td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Mandatory:</strong > The name of the repository.</td></tr><tr><td colspan="1" rowspan="1" >class="confluenceTd"><span>transactionManager</span></td><td colspan="1" >rowspan="1" class="confluenceTd"><span>TransactionManager</span></td><td >colspan="1" rowspan="1" >class="confluenceTd"><p><strong>Mandatory:</strong> The <code>org.springframework.transaction.PlatformTransactionManager</code> to > mange transactions for the database. The TransactionManager must be able to >support databases.</p></td></tr><tr><td colspan="1" rowspan="1" >class="confluenceTd">lobHandler</td><td colspan="1" rowspan="1" >class="confluenceTd"><span>LobHandler</span></td><td colspan="1" rowspan="1" >class="confluenceTd">A <code>org.springframework.jdbc.support.lob.LobHandler</code> to > handle Lob types in the database. Use this option to use a vendor specific >LobHandler, for example when using Oracle.</td></tr><tr><td colspan="1" >rowspan="1" class="confluenceTd"><span>returnOldExchange</span></td><td >colspan= "1" rowspan="1" class="confluenceTd">boolean</td><td colspan="1" rowspan="1" class="confluenceTd">Whether the get operation should return the old existing Exchange if any existed. By default this option is <code>false</code> to optimize as we do not need the old exchange when aggregating.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">useRecovery</td><td colspan="1" rowspan="1" class="confluenceTd">boolean</td><td colspan="1" rowspan="1" class="confluenceTd">Whether or not recovery is enabled. This option is by default <code>true</code>. When enabled the Camel <a shape="rect" href="aggregator2.html">Aggregator</a> automatic recover failed aggregated exchange and have them resubmitted.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">recoveryInterval</td><td colspan="1" rowspan="1" class="confluenceTd">long</td><td colspan="1" rowspan="1" class="confluenceTd"><p>If recovery is enabled then a background task is run every x'th time t o scan for failed exchanges to recover and resubmit. By default this interval is 5000 millis.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><span>maximumRedeliveries</span></td><td colspan="1" rowspan="1" class="confluenceTd">int</td><td colspan="1" rowspan="1" class="confluenceTd">Allows you to limit the maximum number of redelivery attempts for a recovered exchange. If enabled then the Exchange will be moved to the dead letter channel if all redelivery attempts failed. By default this option is disabled. If this option is used then the <code>deadLetterUri</code> option must also be provided.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>deadLetterUri</code></p></td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1" class="confluenceTd"><p>An endpoint uri for a <a shape="rect" href="dead-letter-channel.html">Dead Letter Channel</a> where exhausted recovered Exchanges will be moved. If this option is used then the <code>maximumRedeliveries</code> option must also be provided.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><span>storeBodyAsText</span></td><td colspan="1" rowspan="1" class="confluenceTd">boolean</td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> Whether to store the message body as String which is human readable. By default this option is <code>false</code> storing the body in binary format.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">headersToStoreAsText</td><td colspan="1" rowspan="1" class="confluenceTd"><span>List<String></span></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <strong>Camel 2.11:</strong> Allows to store headers as String which is human readable. By default this option is disabled, storing the headers in binary format.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">jdbcOptimisticLocki ngExceptionMapper</td><td colspan="1" rowspan="1" class="confluenceTd">jdbcOptimisticLockingExceptionMapper</td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.12:</strong> Allows to plugin a custom <code>org.apache.camel.processor.aggregate.jdbc.JdbcOptimisticLockingExceptionMapper</code> to map vendor specific error codes to an optimistick locking error, for Camel to perform a retry. This requires <code>optimisticLocking</code> to be enabled.</p></td></tr></tbody></table></div><div class="confluence-information-macro confluence-information-macro-information"><p class="title">Optimistic Locking</p><span class="aui-icon aui-icon-small aui-iconfont-info confluence-information-macro-icon"></span><div class="confluence-information-macro-body"><p>Optimistic locking is set to on by default.  If two exchanges attempt to insert at the same time an exception will thrown, caught, converted to an OptimisticLockingException, and rethrown.   ;</p></div></div><h3 id="SQLComponent-Whatispreservedwhenpersisting">What is preserved when persisting</h3><p><code>JdbcAggregationRepository</code> will only preserve any <code>Serializable</code> compatible data types. If a data type is not such a type its dropped and a <code>WARN</code> is logged. And it only persists the <code>Message</code> body and the <code>Message</code> headers. The <code>Exchange</code> properties are <strong>not</strong> persisted.</p><p>From Camel 2.11 onwards you can store the message body and select(ed) headers as String in separate columns.</p><p>Recovery</p><p>The <code>JdbcAggregationRepository</code> will by default recover any failed <a shape="rect" href="exchange.html">Exchange</a>. It does this by having a background tasks that scans for failed <a shape="rect" href="exchange.html">Exchange</a>s in the persistent store. You can use the <code>checkInterval</code> option to set how often this task runs. The recovery works as transactional which ens ures that Camel will try to recover and redeliver the failed <a shape="rect" href="exchange.html">Exchange</a>. Any <a shape="rect" href="exchange.html">Exchange</a> which was found to be recovered will be restored from the persistent store and resubmitted and send out again.</p><p>The following headers is set when an <a shape="rect" href="exchange.html">Exchange</a> is being recovered/redelivered:</p><p class="confluenceTable"> </p><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh">Header</th><th colspan="1" rowspan="1" class="confluenceTh">Type</th><th colspan="1" rowspan="1" class="confluenceTh">Description</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">Exchange.REDELIVERED</td><td colspan="1" rowspan="1" class="confluenceTd">Boolean</td><td colspan="1" rowspan="1" class="confluenceTd">Is set to true to indicate the <a shape="rect" href="exchange.html">Exchange</a> is being redelivered.< /td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><span>Exchange.REDELIVERY_COUNTER</span></td><td colspan="1" rowspan="1" class="confluenceTd">Integer</td><td colspan="1" rowspan="1" class="confluenceTd">The redelivery attempt, starting from 1.</td></tr></tbody></table></div><p> </p><p>Only when an <a shape="rect" href="exchange.html">Exchange</a> has been successfully processed it will be marked as complete which happens when the <code>confirm</code> method is invoked on the <code>AggregationRepository</code>. This means if the same <a shape="rect" href="exchange.html">Exchange</a> fails again it will be kept retried until it success.</p><p>You can use option <code>maximumRedeliveries</code> to limit the maximum number of redelivery attempts for a given recovered <a shape="rect" href="exchange.html">Exchange</a>. You must also set the <code>deadLetterUri</code> option so Camel knows where to send the <a shape="rect" href="exchange.html">Exchange</a> when the <code >maximumRedeliveries</code> was hit.</p><p>You can see some examples in the >unit tests of camel-sql, for example <a shape="rect" class="external-link" >href="https://svn.apache.org/repos/asf/camel/trunk/components/camel-sql/src/test/java/org/apache/camel/processor/aggregate/jdbc/JdbcAggregateRecoverDeadLetterChannelTest.java";>this > test</a>.</p><p>Database</p><p>To be operational, each aggregator uses two >table: the aggregation and completed one. By convention the completed has the >same name as the aggregation one suffixed with <code>"_COMPLETED"</code>. The >name must be configured in the Spring bean with the ><code>RepositoryName</code> property. In the following example aggregation >will be used.</p><p>The table structure definition of both table are >identical: in both case a String value is used as key (<strong>id</strong>) >whereas a Blob contains the exchange serialized in byte array.<br >clear="none"> However one difference should be remembered: the ><strong>id</strong> field does no t have the same content depending on the table.<br clear="none"> In the aggregation table <strong>id</strong> holds the correlation Id used by the component to aggregate the messages. In the completed table, <strong>id</strong> holds the id of the exchange stored in corresponding the blob field.</p><p>Here is the SQL query used to create the tables, just replace <code>"aggregation"</code> with your aggregator repository name.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> +<script class="brush: sql; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[Â CREATE TABLE aggregation ( id varchar(255) NOT NULL, exchange blob NOT NULL, constraint aggregation_pk PRIMARY KEY (id) ); CREATE TABLE aggregation_completed ( id varchar(255) NOT NULL, exchange blob NOT NULL, constraint aggregation_completed_pk PRIMARY KEY (id) );]]></script> +</div></div><p>Storing body and headers as text</p><p><strong>Available as of Camel 2.11</strong></p><p>You can configure the <code>JdbcAggregationRepository</code> to store message body and select(ed) headers as String in separate columns. For example to store the body, and the following two headers <code>companyName</code> and <code>accountName</code> use the following SQL:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> +<script class="brush: sql; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[CREATE TABLE aggregationRepo3 ( id varchar(255) NOT NULL, exchange blob NOT NULL, body varchar(1000), companyName varchar(1000), accountName varchar(1000), constraint aggregationRepo3_pk PRIMARY KEY (id) ); CREATE TABLE aggregationRepo3_completed ( id varchar(255) NOT NULL, exchange blob NOT NULL, body varchar(1000), companyName varchar(1000), accountName varchar(1000), constraint aggregationRepo3_completed_pk PRIMARY KEY (id) );]]></script> +</div></div><p>And then configure the repository to enable this behavior as shown below:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> +<script class="brush: xml; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[Â <bean id="repo3" class="org.apache.camel.processor.aggregate.jdbc.JdbcAggregationRepository"> <property name="repositoryName" value="aggregationRepo3"/> <property name="transactionManager" ref="txManager3"/> <property name="dataSource" ref="dataSource3"/> <!-- configure to store the message body and following headers as text in the repo --> <property name="storeBodyAsText" value="true"/> <property name="headersToStoreAsText"> <list> <value>companyName</value> <value>accountName</value> </list> </property> </bean>]]></script> +</div></div><p>Codec (Serialization)</p><p>Since they can contain any type of payload, Exchanges are not serializable by design. It is converted into a byte array to be stored in a database BLOB field. All those conversions are handled by the <code>JdbcCodec</code> class. One detail of the code requires your attention: the <code>ClassLoadingAwareObjectInputStream</code>.</p><p>The <code>ClassLoadingAwareObjectInputStream</code> has been reused from the <a shape="rect" class="external-link" href="http://activemq.apache.org/";>Apache ActiveMQ</a> project. It wraps an <code>ObjectInputStream</code> and use it with the <code>ContextClassLoader</code> rather than the <code>currentThread</code> one. The benefit is to be able to load classes exposed by other bundles. This allows the exchange body and headers to have custom types object references.</p><p>Transaction</p><p>A Spring <code>PlatformTransactionManager</code> is required to orchestrate transaction.</p><p>Service (Start/Stop)</p><p >The <code>start</code> method verify the connection of the database and the >presence of the required tables. If anything is wrong it will fail during >starting.</p><p>Aggregator configuration</p><p>Depending on the targeted >environment, the aggregator might need some configuration. As you already >know, each aggregator should have its own repository (with the corresponding >pair of table created in the database) and a data source. If the default >lobHandler is not adapted to your database system, it can be injected with >the <code>lobHandler</code> property.</p><p>Here is the declaration for >Oracle:</p><div class="code panel pdl" style="border-width: 1px;"><div >class="codeContent panelContent pdl"> +<script class="brush: xml; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[Â <bean id="lobHandler" class="org.springframework.jdbc.support.lob.OracleLobHandler"> <property name="nativeJdbcExtractor" ref="nativeJdbcExtractor"/> </bean> <bean id="nativeJdbcExtractor" class="org.springframework.jdbc.support.nativejdbc.CommonsDbcpNativeJdbcExtractor"/> <bean id="repo" class="org.apache.camel.processor.aggregate.jdbc.JdbcAggregationRepository"> <property name="transactionManager" ref="transactionManager"/> <property name="repositoryName" value="aggregation"/> <property name="dataSource" ref="dataSource"/> <!-- Only with Oracle, else use default --> <property name="lobHandler" ref="lobHandler"/> </bean>]]></script> +</div></div><p>Optimistic locking</p><p>From <strong>Camel 2.12</strong> onwards you can turn on <code>optimisticLocking</code> and use this JDBC based aggregation repository in a clustered environment where multiple Camel applications shared the same database for the aggregation repository. If there is a race condition there JDBC driver will throw a vendor specific exception which the <code>JdbcAggregationRepository</code> can react upon. To know which caused exceptions from the JDBC driver is regarded as an optimistick locking error we need a mapper to do this. Therefore there is a <code>org.apache.camel.processor.aggregate.jdbc.JdbcOptimisticLockingExceptionMapper</code> allows you to implement your custom logic if needed. There is a default implementation <code>org.apache.camel.processor.aggregate.jdbc.DefaultJdbcOptimisticLockingExceptionMapper</code> which works as follows:</p><p>The following check is done:</p><p>If the caused exception is an <code>SQLException</code> then th e SQLState is checked if starts with 23.</p><p>If the caused exception is a <code>DataIntegrityViolationException</code></p><p>If the caused exception class name has "ConstraintViolation" in its name.</p><p>optional checking for FQN class name matches if any class names has been configured</p><p>You can in addition add FQN classnames, and if any of the caused exception (or any nested) equals any of the FQN class names, then its an optimistick locking error.</p><p>Here is an example, where we define 2 extra FQN class names from the JDBC vendor.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> +<script class="brush: xml; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[Â <bean id="repo" class="org.apache.camel.processor.aggregate.jdbc.JdbcAggregationRepository"> <property name="transactionManager" ref="transactionManager"/> <property name="repositoryName" value="aggregation"/> <property name="dataSource" ref="dataSource"/> <property name"jdbcOptimisticLockingExceptionMapper" ref="myExceptionMapper"/> </bean> <!-- use the default mapper with extra FQN class names from our JDBC driver --> <bean id="myExceptionMapper" class="org.apache.camel.processor.aggregate.jdbc.DefaultJdbcOptimisticLockingExceptionMapper"> <property name="classNames"> <util:set> <value>com.foo.sql.MyViolationExceptoion</value> <value>com.foo.sql.MyOtherViolationExceptoion</value& gt; </util:set> </property> </bean>]]></script> +</div></div><p> </p><p></p><h3 id="SQLComponent-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><p><a shape="rect" href="sql-stored-procedure.html">SQL Stored Procedure</a></p><p><a shape="rect" href="jdbc.html">JDBC</a></p></div> </td> <td valign="top">
