Modified: websites/production/camel/content/sql-component.html
==============================================================================
--- websites/production/camel/content/sql-component.html (original)
+++ websites/production/camel/content/sql-component.html Fri Jul 29 14:19:49 
2016
@@ -113,7 +113,7 @@ where
   id = :#${property.myId}
 order by
   name]]></script>
-</div></div><p>In the file you can use multilines and format the SQL as you 
wish. And also use comments such as the&#160;&#8211; dash line.</p><p>You can 
append query options to the URI in the following format, 
<code>?option=value&amp;option=value&amp;...</code></p><h3 
id="SQLComponent-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>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>batch</code></p></td><td colspan="1" 
rowspan="1" class="confluenceTd"><p><code>boolean</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.7
 .5, 2.8.4 and 2.9:</strong> Execute SQL batch update statements. See notes 
below on how the treatment of the inbound message body changes if this is set 
to <code>true</code>.</p></td></tr><tr><td colspan="1" rowspan="1" 
class="confluenceTd"><p><code>dataSourceRef</code></p></td><td colspan="1" 
rowspan="1" class="confluenceTd"><p><code>String</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>Deprecated and will be removed in 
Camel 3.0:</strong> Reference to a <code>DataSource</code> to look up in the 
registry. Use <code>dataSource=#theName</code> instead.</p></td></tr><tr><td 
colspan="1" rowspan="1" 
class="confluenceTd"><p><code>dataSource</code></p></td><td colspan="1" 
rowspan="1" class="confluenceTd"><p><code>String</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.11:</s
 trong> Reference to a <code>DataSource</code> to look up in the 
registry.</p></td></tr><tr><td colspan="1" rowspan="1" 
class="confluenceTd"><p><code>placeholder</code></p></td><td colspan="1" 
rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1" 
rowspan="1" class="confluenceTd"><p><code>#</code></p></td><td colspan="1" 
rowspan="1" class="confluenceTd"><p><strong>Camel 2.4:</strong> Specifies a 
character that will be replaced to <code>?</code> in SQL query. Notice, that it 
is simple <code>String.replaceAll()</code> operation and no SQL parsing is 
involved (quoted strings will also change). This replacement is 
<strong>only</strong> happening if the endpoint is created using the 
<code>SqlComponent</code>. If you manually create the endpoint, then use the 
expected <code>?</code> sign instead.</p></td></tr><tr><td colspan="1" 
rowspan="1" class="confluenceTd"><code>usePlaceholder</code></td><td 
colspan="1" rowspan="1" class="confluenceTd"><code>boolean</code></td
 ><td colspan="1" rowspan="1" class="confluenceTd"><code>true</code></td><td 
 >colspan="1" rowspan="1" class="confluenceTd"><strong>Camel 2.17:</strong> 
 >Sets whether to use placeholder and replace all placeholder characters with ? 
 >sign in the SQL queries.</td></tr><tr><td colspan="1" rowspan="1" 
 >class="confluenceTd"><p><code>template.&lt;xxx&gt;</code></p></td><td 
 >colspan="1" rowspan="1" class="confluenceTd"><p>&#160;</p></td><td 
 >colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td 
 >colspan="1" rowspan="1" class="confluenceTd"><p>Sets additional options on 
 >the Spring <code>JdbcTemplate</code> that is used behind the scenes to 
 >execute the queries. For instance, <code>template.maxRows=10</code>. For 
 >detailed documentation, see the <a shape="rect" class="external-link" 
 >href="http://static.springframework.org/spring/docs/2.5.x/api/org/springframework/jdbc/core/JdbcTemplate.html";
 > rel="nofollow">JdbcTemplate javadoc</a> documentation.</p></td></tr><tr><td 
 >colspan="1" 
 rowspan="1" 
class="confluenceTd"><p><code>allowNamedParameters</code></p></td><td 
colspan="1" rowspan="1" 
class="confluenceTd"><p><code>boolean</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.11:</strong> Whether to 
allow using named parameters in the queries.</p></td></tr><tr><td colspan="1" 
rowspan="1" class="confluenceTd"><p><code>processingStrategy</code></p></td><td 
colspan="1" rowspan="1" class="confluenceTd"><p>&#160;</p></td><td colspan="1" 
rowspan="1" class="confluenceTd"><p>&#160;</p></td><td colspan="1" rowspan="1" 
class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL consumer 
only:</strong> Allows to plugin to use a custom 
<code>org.apache.camel.component.sql.SqlProcessingStrategy</code> to execute 
queries when the consumer has processed the rows/batch.</p></td></tr><tr><td 
colspan="1" rowspan="1" class="confluenceTd"><p><code>prepareStatementStrate
 gy</code></p></td><td colspan="1" rowspan="1" 
class="confluenceTd"><p>&#160;</p></td><td colspan="1" rowspan="1" 
class="confluenceTd"><p>&#160;</p></td><td colspan="1" rowspan="1" 
class="confluenceTd"><p><strong>Camel 2.11:</strong> Allows to plugin to use a 
custom <code>org.apache.camel.component.sql.SqlPrepareStatementStrategy</code> 
to control preparation of the query and prepared 
statement.</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>long</code></p></td><td colspan="1" 
rowspan="1" class="confluenceTd"><p><code>500</code></p></td><td colspan="1" 
rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL 
consumer only:</strong> Delay in milliseconds between each 
poll.</p></td></tr><tr><td colspan="1" rowspan="1" 
class="confluenceTd"><p><code>consumer.initialDelay</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>1000</code></p></td><td colspan="1" rowspan="1" 
class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL consumer 
only:</strong> Milliseconds before polling starts.</p></td></tr><tr><td 
colspan="1" rowspan="1" 
class="confluenceTd"><p><code>consumer.useFixedDelay</code></p></td><td 
colspan="1" rowspan="1" 
class="confluenceTd"><p><code>boolean</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:</strong> <strong>SQL 
consumer only:</strong> 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><tr><td colspan="1" rowspan="1" 
class="confluenceTd"><p><code
 >maxMessagesPerPoll</code></p></td><td colspan="1" rowspan="1" 
 >class="confluenceTd"><p><code>int</code></p></td><td colspan="1" rowspan="1" 
 >class="confluenceTd"><p><code>0</code></p></td><td colspan="1" rowspan="1" 
 >class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL consumer 
 >only:</strong> An integer value to define the maximum number of messages to 
 >gather per poll. By default, no maximum is set.</p></td></tr><tr><td 
 >colspan="1" rowspan="1" 
 >class="confluenceTd"><p><code>useIterator</code></p></td><td colspan="1" 
 >rowspan="1" class="confluenceTd"><p><code>boolean</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.11:</strong> 
 ><strong>SQL consumer only:</strong> If <code>true</code> each row returned 
 >when polling will be processed individually. If <code>false</code> the entire 
 ><code>java.util.List</code> of data is set as the IN body.<span> Notice in 
 >Camel 2.15.x o
 r older you need to prefix this option with consumer., eg 
consumer.useIterator=true.</span></p></td></tr><tr><td colspan="1" rowspan="1" 
class="confluenceTd"><p><code>routeEmptyResultSet</code></p></td><td 
colspan="1" rowspan="1" 
class="confluenceTd"><p><code>boolean</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:</strong> <strong>SQL 
consumer only:</strong> Whether to route a single empty <a shape="rect" 
href="exchange.html">Exchange</a> if there was no data to poll.<span> Notice in 
Camel 2.15.x or older you need to prefix this option with consumer., eg 
consumer.useIterator=true.</span></p></td></tr><tr><td colspan="1" rowspan="1" 
class="confluenceTd"><p><code>onConsume</code></p></td><td colspan="1" 
rowspan="1" class="confluenceTd"><p><code>String</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.11:</strong> <strong>SQL consumer 
only:</strong> After processing each row then this query can be executed, if 
the <a shape="rect" href="exchange.html">Exchange</a> was processed 
successfully, for example to mark the row as processed. The query can have 
parameter.<span> Notice in Camel 2.15.x or older you need to prefix this option 
with consumer., eg consumer.useIterator=true.</span></p></td></tr><tr><td 
colspan="1" rowspan="1" 
class="confluenceTd"><p><code>onConsumeFailed</code></p></td><td colspan="1" 
rowspan="1" class="confluenceTd"><p><code>String</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.11:</strong> <strong>SQL 
consumer only:</strong> After processing each row then this query can be 
executed, if the <a shape="rect" href="exchange.html">Exchange</a> failed, for 
example to mark the row as failed. The query can have param
 eter.<span> Notice in Camel 2.15.x or older you need to prefix this option 
with consumer., eg consumer.useIterator=true.</span></p></td></tr><tr><td 
colspan="1" rowspan="1" 
class="confluenceTd"><p><code>onConsumeBatchComplete</code></p></td><td 
colspan="1" rowspan="1" class="confluenceTd"><p><code>String</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.11:</strong> 
<strong>SQL consumer only:</strong> After processing the entire batch, this 
query can be executed to bulk update rows etc. The query cannot have 
parameters.<span> Notice in Camel 2.15.x or older you need to prefix this 
option with consumer., eg 
consumer.useIterator=true.</span></p></td></tr><tr><td colspan="1" rowspan="1" 
class="confluenceTd"><p><code>expectedUpdateCount</code></p></td><td 
colspan="1" rowspan="1" class="confluenceTd"><p><code>int</code></p></td><td 
colspan="1" rowspan="1" class="confluenceTd"><p
 ><code>-1</code></p></td><td colspan="1" rowspan="1" 
 >class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL consumer 
 >only:</strong> If using <code>consumer.onConsume</code> then this option can 
 >be used to set an expected number of rows being updated. Typically you may 
 >set this to <code>1</code> to expect one row to be updated.<span> Notice in 
 >Camel 2.15.x or older you need to prefix this option with consumer., eg 
 >consumer.useIterator=true.</span></p></td></tr><tr><td colspan="1" 
 >rowspan="1" 
 >class="confluenceTd"><p><code>breakBatchOnConsumeFail</code></p></td><td 
 >colspan="1" rowspan="1" 
 >class="confluenceTd"><p><code>boolean</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:</strong> 
 ><strong>SQL consumer only:</strong> If using <code>consumer.onConsume</code> 
 >and it fails, then this option controls whether to break out of the batch or 
 >continue processing the nex
 t row from the batch. Notice in Camel 2.15.x or older you need to prefix this 
option with consumer., eg consumer.useIterator=true.</p></td></tr><tr><td 
colspan="1" rowspan="1" 
class="confluenceTd"><p><code>alwaysPopulateStatement</code></p></td><td 
colspan="1" rowspan="1" 
class="confluenceTd"><p><code>boolean</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:</strong> <strong>SQL 
producer only:</strong> If enabled then the <code>populateStatement</code> 
method from 
<code>org.apache.camel.component.sql.SqlPrepareStatementStrategy</code> is 
always invoked, also if there is no expected parameters to be prepared. When 
this is <code>false</code> then the <code>populateStatement</code> is only 
invoked if there is 1 or more expected parameters to be set; for example this 
avoids reading the message body/headers for SQL queries with no 
parameters.</p></td></tr><tr><td colspan="1
 " rowspan="1" class="confluenceTd"><p><code>separator</code></p></td><td 
colspan="1" rowspan="1" class="confluenceTd"><p><code>char</code></p></td><td 
colspan="1" rowspan="1" class="confluenceTd"><p><code>,</code></p></td><td 
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11.1:</strong> 
The separator to use when parameter values is taken from message body (if the 
body is a String type), to be inserted at # placeholders. Notice if you use 
named parameters, then a <code>Map</code> type is used 
instead.</p></td></tr><tr><td colspan="1" rowspan="1" 
class="confluenceTd"><p><code>outputType</code></p></td><td colspan="1" 
rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1" 
rowspan="1" class="confluenceTd"><p><code>SelectList</code></p></td><td 
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.12.0:</strong> 
Make the output of consumer or producer to <code>SelectList</code> as List of 
Map, or <code>SelectOne</code> as single Java ob
 ject in the following way:<br clear="none"> a) If the query has only single 
column, then that JDBC Column object is returned. (such as <code>SELECT COUNT( 
* ) FROM PROJECT</code> will return a Long object.<br clear="none"> b) If the 
query has more than one column, then it will return a Map of that result.<br 
clear="none"> c) If the <code>outputClass</code> is set, then it will convert 
the query result into an Java bean object by calling all the setters that match 
the column names. It will assume your class has a default constructor to create 
instance with.<br clear="none"> d) If the query resulted in more than one rows, 
it throws an non-unique result exception.</p><p>From <strong>Camel 
2.14.1</strong> onwards the SelectList also supports mapping each row to a Java 
object as the SelectOne does <span>(only step c)</span>.</p><p>From 
<strong>Camel 2.18</strong> onwards there is a new StreamList outputType that 
streams the result of the query using an Iterator. It can be used with the <
 a shape="rect" href="splitter.html">Splitter</a> EIP in streaming mode to 
process the ResultSet in streaming fashion. This StreamList do not support 
batch mode, but you can use outputClass to map each row to a 
class.</p></td></tr><tr><td colspan="1" rowspan="1" 
class="confluenceTd"><p><code>outputClass</code></p></td><td colspan="1" 
rowspan="1" class="confluenceTd"><p><code>String</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.12.0:</strong> Specify the 
full package and class name to use as conversion when 
<code>outputType=SelectOne</code>.</p></td></tr><tr><td colspan="1" rowspan="1" 
class="confluenceTd"><p><code>outputHeader</code></p></td><td colspan="1" 
rowspan="1" class="confluenceTd"><code>String</code></td><td colspan="1" 
rowspan="1" class="confluenceTd"><code>null</code></td><td colspan="1" 
rowspan="1" class="confluenceTd"><p><strong>Camel 2.15:</strong> To store
  the result as a header instead of the message body. This allows to preserve 
the existing message body as-is.</p></td></tr><tr><td colspan="1" rowspan="1" 
class="confluenceTd"><p><code>parametersCount</code></p></td><td colspan="1" 
rowspan="1" class="confluenceTd"><p><code>int</code></p></td><td colspan="1" 
rowspan="1" class="confluenceTd"><p><code>0</code></p></td><td colspan="1" 
rowspan="1" class="confluenceTd"><p><strong>Camel 2.11.2/2.12.0</strong> If set 
greater than zero, then Camel will use this count value of parameters to 
replace instead of querying via JDBC metadata API. This is useful if the JDBC 
vendor could not return correct parameters count, then user may override 
instead.</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>boolean</code></p></td><td colspan="1" 
rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1" 
rowspan="1" class="confluence
 Td"><p><strong>Camel 2.12.0</strong> If set, will ignore the results of the 
SQL query and use the existing IN message as the OUT message for the 
continuation of processing</p></td></tr><tr><td colspan="1" rowspan="1" 
class="confluenceTd"><code>useMessageBodyForSql</code></td><td colspan="1" 
rowspan="1" class="confluenceTd"><code>boolean</code></td><td colspan="1" 
rowspan="1" class="confluenceTd"><code>false</code></td><td colspan="1" 
rowspan="1" class="confluenceTd"><strong>Camel 2.16:</strong> Whether to use 
the message body as the SQL and then headers for parameters. If this option is 
enabled then the SQL in the uri is not used. The SQL parameters must then be 
provided in a header with the key <code>CamelSqlParameters</code>. This option 
is only for the producer.</td></tr><tr><td colspan="1" rowspan="1" 
class="confluenceTd"><code>transacted</code></td><td colspan="1" rowspan="1" 
class="confluenceTd"><code>boolean</code></td><td colspan="1" rowspan="1" 
class="confluenceTd"><code>fa
 lse</code></td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Camel 
2.16.2:</strong> <strong>SQL consumer only:</strong>Enables or disables 
transaction. If enabled then if processing an exchange failed then the consumer 
break out processing any further exchanges to cause a rollback 
eager</td></tr></tbody></table></div></div><h3 
id="SQLComponent-Treatmentofthemessagebody">Treatment of the message 
body</h3><p>The SQL component tries to convert the message body to an object of 
<code>java.util.Iterator</code> type and then uses this iterator to fill the 
query parameters (where each query parameter is represented by a <code>#</code> 
symbol (or configured placeholder) in the endpoint URI). If the message body is 
not an array or collection, the conversion results in an iterator that iterates 
over only one object, which is the body itself.</p><p>For example, if the 
message body is an instance of <code>java.util.List</code>, the first item in 
the list is substituted into the first 
 occurrence of <code>#</code> in the SQL query, the second item in the list is 
substituted into the second occurrence of <code>#</code>, and so on.</p><p>If 
<code>batch</code> is set to <code>true</code>, then the interpretation of the 
inbound message body changes slightly &#8211; instead of an iterator of 
parameters, the component expects an iterator that contains the parameter 
iterators; the size of the outer iterator determines the batch size.</p><p>From 
Camel 2.16 onwards you can use the option&#160;<span>useMessageBodyForSql that 
allows to use the message body as the SQL statement, and then the SQL 
parameters must be provided in a header with the 
key&#160;SqlConstants.SQL_PARAMETERS. This allows the SQL component to work 
more dynamic as the SQL query is from the message body.</span></p><h3 
id="SQLComponent-Resultofthequery">Result of the query</h3><p>For 
<code>select</code> operations, the result is an instance of 
<code>List&lt;Map&lt;String, Object&gt;&gt;</code> type, as retur
 ned by the <a shape="rect" class="external-link" 
href="http://static.springframework.org/spring/docs/2.5.x/api/org/springframework/jdbc/core/JdbcTemplate.html#queryForList(java.lang.String,%20java.lang.Object%91%93)"
 rel="nofollow">JdbcTemplate.queryForList()</a> method. For <code>update</code> 
operations, the result is the number of updated rows, returned as an 
<code>Integer</code>.</p><p>By default, the result is placed in the message 
body.&#160; If the outputHeader parameter is set, the result is placed in the 
header.&#160; This is an alternative to using a full message enrichment pattern 
to add headers, it provides a concise syntax for querying a sequence or some 
other small value into a header.&#160; It is convenient to use outputHeader and 
outputType together:</p><div class="code panel pdl" style="border-width: 
1px;"><div class="codeContent panelContent pdl">
+</div></div><p>In the file you can use multilines and format the SQL as you 
wish. And also use comments such as the&#160;&#8211; dash line.</p><p>You can 
append query options to the URI in the following format, 
<code>?option=value&amp;option=value&amp;...</code></p><h3 
id="SQLComponent-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>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>batch</code></p></td><td colspan="1" 
rowspan="1" class="confluenceTd"><p><code>boolean</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.7
 .5, 2.8.4 and 2.9:</strong> Execute SQL batch update statements. See notes 
below on how the treatment of the inbound message body changes if this is set 
to <code>true</code>.</p></td></tr><tr><td colspan="1" rowspan="1" 
class="confluenceTd"><p><code>dataSourceRef</code></p></td><td colspan="1" 
rowspan="1" class="confluenceTd"><p><code>String</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>Deprecated and will be removed in 
Camel 3.0:</strong> Reference to a <code>DataSource</code> to look up in the 
registry. Use <code>dataSource=#theName</code> instead.</p></td></tr><tr><td 
colspan="1" rowspan="1" 
class="confluenceTd"><p><code>dataSource</code></p></td><td colspan="1" 
rowspan="1" class="confluenceTd"><p><code>String</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.11:</s
 trong> Reference to a <code>DataSource</code> to look up in the 
registry.</p></td></tr><tr><td colspan="1" rowspan="1" 
class="confluenceTd"><p><code>placeholder</code></p></td><td colspan="1" 
rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1" 
rowspan="1" class="confluenceTd"><p><code>#</code></p></td><td colspan="1" 
rowspan="1" class="confluenceTd"><p><strong>Camel 2.4:</strong> Specifies a 
character that will be replaced to <code>?</code> in SQL query. Notice, that it 
is simple <code>String.replaceAll()</code> operation and no SQL parsing is 
involved (quoted strings will also change). This replacement is 
<strong>only</strong> happening if the endpoint is created using the 
<code>SqlComponent</code>. If you manually create the endpoint, then use the 
expected <code>?</code> sign instead.</p></td></tr><tr><td colspan="1" 
rowspan="1" class="confluenceTd"><code>usePlaceholder</code></td><td 
colspan="1" rowspan="1" class="confluenceTd"><code>boolean</code></td
 ><td colspan="1" rowspan="1" class="confluenceTd"><code>true</code></td><td 
 >colspan="1" rowspan="1" class="confluenceTd"><strong>Camel 2.17:</strong> 
 >Sets whether to use placeholder and replace all placeholder characters with ? 
 >sign in the SQL queries.</td></tr><tr><td colspan="1" rowspan="1" 
 >class="confluenceTd"><p><code>template.&lt;xxx&gt;</code></p></td><td 
 >colspan="1" rowspan="1" class="confluenceTd"><p>&#160;</p></td><td 
 >colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td 
 >colspan="1" rowspan="1" class="confluenceTd"><p>Sets additional options on 
 >the Spring <code>JdbcTemplate</code> that is used behind the scenes to 
 >execute the queries. For instance, <code>template.maxRows=10</code>. For 
 >detailed documentation, see the <a shape="rect" class="external-link" 
 >href="http://static.springframework.org/spring/docs/2.5.x/api/org/springframework/jdbc/core/JdbcTemplate.html";
 > rel="nofollow">JdbcTemplate javadoc</a> documentation.</p></td></tr><tr><td 
 >colspan="1" 
 rowspan="1" 
class="confluenceTd"><p><code>allowNamedParameters</code></p></td><td 
colspan="1" rowspan="1" 
class="confluenceTd"><p><code>boolean</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.11:</strong> Whether to 
allow using named parameters in the queries.</p></td></tr><tr><td colspan="1" 
rowspan="1" class="confluenceTd"><p><code>processingStrategy</code></p></td><td 
colspan="1" rowspan="1" class="confluenceTd"><p>&#160;</p></td><td colspan="1" 
rowspan="1" class="confluenceTd"><p>&#160;</p></td><td colspan="1" rowspan="1" 
class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL consumer 
only:</strong> Allows to plugin to use a custom 
<code>org.apache.camel.component.sql.SqlProcessingStrategy</code> to execute 
queries when the consumer has processed the rows/batch.</p></td></tr><tr><td 
colspan="1" rowspan="1" class="confluenceTd"><p><code>prepareStatementStrate
 gy</code></p></td><td colspan="1" rowspan="1" 
class="confluenceTd"><p>&#160;</p></td><td colspan="1" rowspan="1" 
class="confluenceTd"><p>&#160;</p></td><td colspan="1" rowspan="1" 
class="confluenceTd"><p><strong>Camel 2.11:</strong> Allows to plugin to use a 
custom <code>org.apache.camel.component.sql.SqlPrepareStatementStrategy</code> 
to control preparation of the query and prepared 
statement.</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>long</code></p></td><td colspan="1" 
rowspan="1" class="confluenceTd"><p><code>500</code></p></td><td colspan="1" 
rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL 
consumer only:</strong> Delay in milliseconds between each 
poll.</p></td></tr><tr><td colspan="1" rowspan="1" 
class="confluenceTd"><p><code>consumer.initialDelay</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>1000</code></p></td><td colspan="1" rowspan="1" 
class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL consumer 
only:</strong> Milliseconds before polling starts.</p></td></tr><tr><td 
colspan="1" rowspan="1" 
class="confluenceTd"><p><code>consumer.useFixedDelay</code></p></td><td 
colspan="1" rowspan="1" 
class="confluenceTd"><p><code>boolean</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:</strong> <strong>SQL 
consumer only:</strong> 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><tr><td colspan="1" rowspan="1" 
class="confluenceTd"><p><code
 >maxMessagesPerPoll</code></p></td><td colspan="1" rowspan="1" 
 >class="confluenceTd"><p><code>int</code></p></td><td colspan="1" rowspan="1" 
 >class="confluenceTd"><p><code>0</code></p></td><td colspan="1" rowspan="1" 
 >class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL consumer 
 >only:</strong> An integer value to define the maximum number of messages to 
 >gather per poll. By default, no maximum is set.</p></td></tr><tr><td 
 >colspan="1" rowspan="1" 
 >class="confluenceTd"><p><code>useIterator</code></p></td><td colspan="1" 
 >rowspan="1" class="confluenceTd"><p><code>boolean</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.11:</strong> 
 ><strong>SQL consumer only:</strong> If <code>true</code> each row returned 
 >when polling will be processed individually. If <code>false</code> the entire 
 ><code>java.util.List</code> of data is set as the IN body.<span> Notice in 
 >Camel 2.15.x o
 r older you need to prefix this option with consumer., eg 
consumer.useIterator=true.</span></p></td></tr><tr><td colspan="1" rowspan="1" 
class="confluenceTd"><p><code>routeEmptyResultSet</code></p></td><td 
colspan="1" rowspan="1" 
class="confluenceTd"><p><code>boolean</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:</strong> <strong>SQL 
consumer only:</strong> Whether to route a single empty <a shape="rect" 
href="exchange.html">Exchange</a> if there was no data to poll.<span> Notice in 
Camel 2.15.x or older you need to prefix this option with consumer., eg 
consumer.useIterator=true.</span></p></td></tr><tr><td colspan="1" rowspan="1" 
class="confluenceTd"><p><code>onConsume</code></p></td><td colspan="1" 
rowspan="1" class="confluenceTd"><p><code>String</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.11:</strong> <strong>SQL consumer 
only:</strong> After processing each row then this query can be executed, if 
the <a shape="rect" href="exchange.html">Exchange</a> was processed 
successfully, for example to mark the row as processed. The query can have 
parameter.<span> Notice in Camel 2.15.x or older you need to prefix this option 
with consumer., eg consumer.useIterator=true.</span></p></td></tr><tr><td 
colspan="1" rowspan="1" 
class="confluenceTd"><p><code>onConsumeFailed</code></p></td><td colspan="1" 
rowspan="1" class="confluenceTd"><p><code>String</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.11:</strong> <strong>SQL 
consumer only:</strong> After processing each row then this query can be 
executed, if the <a shape="rect" href="exchange.html">Exchange</a> failed, for 
example to mark the row as failed. The query can have param
 eter.<span> Notice in Camel 2.15.x or older you need to prefix this option 
with consumer., eg consumer.useIterator=true.</span></p></td></tr><tr><td 
colspan="1" rowspan="1" 
class="confluenceTd"><p><code>onConsumeBatchComplete</code></p></td><td 
colspan="1" rowspan="1" class="confluenceTd"><p><code>String</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.11:</strong> 
<strong>SQL consumer only:</strong> After processing the entire batch, this 
query can be executed to bulk update rows etc. The query cannot have 
parameters.<span> Notice in Camel 2.15.x or older you need to prefix this 
option with consumer., eg 
consumer.useIterator=true.</span></p></td></tr><tr><td colspan="1" rowspan="1" 
class="confluenceTd"><p><code>expectedUpdateCount</code></p></td><td 
colspan="1" rowspan="1" class="confluenceTd"><p><code>int</code></p></td><td 
colspan="1" rowspan="1" class="confluenceTd"><p
 ><code>-1</code></p></td><td colspan="1" rowspan="1" 
 >class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL consumer 
 >only:</strong> If using <code>consumer.onConsume</code> then this option can 
 >be used to set an expected number of rows being updated. Typically you may 
 >set this to <code>1</code> to expect one row to be updated.<span> Notice in 
 >Camel 2.15.x or older you need to prefix this option with consumer., eg 
 >consumer.useIterator=true.</span></p></td></tr><tr><td colspan="1" 
 >rowspan="1" 
 >class="confluenceTd"><p><code>breakBatchOnConsumeFail</code></p></td><td 
 >colspan="1" rowspan="1" 
 >class="confluenceTd"><p><code>boolean</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:</strong> 
 ><strong>SQL consumer only:</strong> If using <code>consumer.onConsume</code> 
 >and it fails, then this option controls whether to break out of the batch or 
 >continue processing the nex
 t row from the batch. Notice in Camel 2.15.x or older you need to prefix this 
option with consumer., eg consumer.useIterator=true.</p></td></tr><tr><td 
colspan="1" rowspan="1" 
class="confluenceTd"><p><code>alwaysPopulateStatement</code></p></td><td 
colspan="1" rowspan="1" 
class="confluenceTd"><p><code>boolean</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:</strong> <strong>SQL 
producer only:</strong> If enabled then the <code>populateStatement</code> 
method from 
<code>org.apache.camel.component.sql.SqlPrepareStatementStrategy</code> is 
always invoked, also if there is no expected parameters to be prepared. When 
this is <code>false</code> then the <code>populateStatement</code> is only 
invoked if there is 1 or more expected parameters to be set; for example this 
avoids reading the message body/headers for SQL queries with no 
parameters.</p></td></tr><tr><td colspan="1
 " rowspan="1" class="confluenceTd"><p><code>separator</code></p></td><td 
colspan="1" rowspan="1" class="confluenceTd"><p><code>char</code></p></td><td 
colspan="1" rowspan="1" class="confluenceTd"><p><code>,</code></p></td><td 
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11.1:</strong> 
The separator to use when parameter values is taken from message body (if the 
body is a String type), to be inserted at # placeholders. Notice if you use 
named parameters, then a <code>Map</code> type is used 
instead.</p></td></tr><tr><td colspan="1" rowspan="1" 
class="confluenceTd"><p><code>outputType</code></p></td><td colspan="1" 
rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1" 
rowspan="1" class="confluenceTd"><p><code>SelectList</code></p></td><td 
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.12.0:</strong> 
Make the output of consumer or producer. <code>SelectList</code> will output a 
List of Map. <code>SelectOne</code> will output
  single Java object in the following way:<br clear="none"> a) If the query has 
only single column, then that JDBC Column object is returned. (such as 
<code>SELECT COUNT( * ) FROM PROJECT</code> will return a Long object.<br 
clear="none"> b) If the query has more than one column, then it will return a 
Map of that result.<br clear="none"> c) If the <code>outputClass</code> is set, 
then it will convert the query result into an Java bean object by calling all 
the setters that match the column names. It will assume your class has a 
default constructor to create instance with.<br clear="none"> d) If the query 
resulted in more than one rows, it throws an non-unique result 
exception.</p><p>From <strong>Camel 2.14.1</strong> onwards the SelectList also 
supports mapping each row to a Java object as the SelectOne does <span>(only 
step c)</span>.</p><p>From <strong>Camel 2.18</strong> onwards there is a new 
StreamList outputType that streams the result of the query using an Iterator. 
It can be 
 used with the <a shape="rect" href="splitter.html">Splitter</a> EIP in 
streaming mode to process the ResultSet in streaming fashion. This StreamList 
do not support batch mode, but you can use outputClass to map each row to a 
class.</p></td></tr><tr><td colspan="1" rowspan="1" 
class="confluenceTd"><p><code>outputClass</code></p></td><td colspan="1" 
rowspan="1" class="confluenceTd"><p><code>String</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.12.0:</strong> Specify the 
full package and class name to use as conversion when 
<code>outputType=SelectOne</code>.</p></td></tr><tr><td colspan="1" rowspan="1" 
class="confluenceTd"><p><code>outputHeader</code></p></td><td colspan="1" 
rowspan="1" class="confluenceTd"><code>String</code></td><td colspan="1" 
rowspan="1" class="confluenceTd"><code>null</code></td><td colspan="1" 
rowspan="1" class="confluenceTd"><p><strong>Camel 2.15:</s
 trong> To store the result as a header instead of the message body. This 
allows to preserve the existing message body as-is.</p></td></tr><tr><td 
colspan="1" rowspan="1" 
class="confluenceTd"><p><code>parametersCount</code></p></td><td colspan="1" 
rowspan="1" class="confluenceTd"><p><code>int</code></p></td><td colspan="1" 
rowspan="1" class="confluenceTd"><p><code>0</code></p></td><td colspan="1" 
rowspan="1" class="confluenceTd"><p><strong>Camel 2.11.2/2.12.0</strong> If set 
greater than zero, then Camel will use this count value of parameters to 
replace instead of querying via JDBC metadata API. This is useful if the JDBC 
vendor could not return correct parameters count, then user may override 
instead.</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>boolean</code></p></td><td colspan="1" 
rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1" 
rowspan="1" cl
 ass="confluenceTd"><p><strong>Camel 2.12.0</strong> If set, will ignore the 
results of the SQL query and use the existing IN message as the OUT message for 
the continuation of processing</p></td></tr><tr><td colspan="1" rowspan="1" 
class="confluenceTd"><code>useMessageBodyForSql</code></td><td colspan="1" 
rowspan="1" class="confluenceTd"><code>boolean</code></td><td colspan="1" 
rowspan="1" class="confluenceTd"><code>false</code></td><td colspan="1" 
rowspan="1" class="confluenceTd"><strong>Camel 2.16:</strong> Whether to use 
the message body as the SQL and then headers for parameters. If this option is 
enabled then the SQL in the uri is not used. The SQL parameters must then be 
provided in a header with the key <code>CamelSqlParameters</code>. This option 
is only for the producer.</td></tr><tr><td colspan="1" rowspan="1" 
class="confluenceTd"><code>transacted</code></td><td colspan="1" rowspan="1" 
class="confluenceTd"><code>boolean</code></td><td colspan="1" rowspan="1" 
class="conflue
 nceTd"><code>false</code></td><td colspan="1" rowspan="1" 
class="confluenceTd"><strong>Camel 2.16.2:</strong> <strong>SQL consumer 
only:</strong>Enables or disables transaction. If enabled then if processing an 
exchange failed then the consumer break out processing any further exchanges to 
cause a rollback eager</td></tr></tbody></table></div></div><h3 
id="SQLComponent-Treatmentofthemessagebody">Treatment of the message 
body</h3><p>The SQL component tries to convert the message body to an object of 
<code>java.util.Iterator</code> type and then uses this iterator to fill the 
query parameters (where each query parameter is represented by a <code>#</code> 
symbol (or configured placeholder) in the endpoint URI). If the message body is 
not an array or collection, the conversion results in an iterator that iterates 
over only one object, which is the body itself.</p><p>For example, if the 
message body is an instance of <code>java.util.List</code>, the first item in 
the list is substituted 
 into the first occurrence of <code>#</code> in the SQL query, the second item 
in the list is substituted into the second occurrence of <code>#</code>, and so 
on.</p><p>If <code>batch</code> is set to <code>true</code>, then the 
interpretation of the inbound message body changes slightly &#8211; instead of 
an iterator of parameters, the component expects an iterator that contains the 
parameter iterators; the size of the outer iterator determines the batch 
size.</p><p>From Camel 2.16 onwards you can use the 
option&#160;<span>useMessageBodyForSql that allows to use the message body as 
the SQL statement, and then the SQL parameters must be provided in a header 
with the key&#160;SqlConstants.SQL_PARAMETERS. This allows the SQL component to 
work more dynamic as the SQL query is from the message body.</span></p><h3 
id="SQLComponent-Resultofthequery">Result of the query</h3><p>For 
<code>select</code> operations, the result is an instance of 
<code>List&lt;Map&lt;String, Object&gt;&gt;</code>
  type, as returned by the <a shape="rect" class="external-link" 
href="http://static.springframework.org/spring/docs/2.5.x/api/org/springframework/jdbc/core/JdbcTemplate.html#queryForList(java.lang.String,%20java.lang.Object%91%93)"
 rel="nofollow">JdbcTemplate.queryForList()</a> method. For <code>update</code> 
operations, the result is the number of updated rows, returned as an 
<code>Integer</code>.</p><p>By default, the result is placed in the message 
body.&#160; If the outputHeader parameter is set, the result is placed in the 
header.&#160; This is an alternative to using a full message enrichment pattern 
to add headers, it provides a concise syntax for querying a sequence or some 
other small value into a header.&#160; It is convenient to use outputHeader and 
outputType together:</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[from(&quot;jms:order.inbox&quot;)
        .to(&quot;sql:select order_seq.nextval from 
dual?outputHeader=OrderId&amp;outputType=SelectOne&quot;)
        .to(&quot;jms:order.booking&quot;);]]></script>
@@ -222,7 +222,7 @@ template.requestBodyAndHeader(&quot;dire
 <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>&#160;</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>&#160;</p><p>&#160;</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">&#160;</div></div><p 
class="wysiwyg-macro-body">The SQL Server&#160;<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>&#160;</p><p>&#160;</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>&#160;</p>{snippet:id=e1|lang=xml|url=camel/t
 
runk/components/camel-sql/src/test/resources/org/apache/camel/processor/idempotent/jdbc/spring.xml}<p></p><p>&#160;</p><p>And
 finally we can create our JDBC idempotent repository in the spring XML file as 
well:</p><p>&#160;</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>&#160;</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">&#160;</p><p>&#160;</p><p 
class="confluenceTh">&#160;</p><p>Parameter</p><p>&#160;</p><p 
class="confluenceTh">&#160;</p><p>Default 
Value</p><p>&#160;</p><p>Description</p><p>&#160;</p><p>&#160;</p><p 
class="confluenceTd">&#160;</p><p>createTableIfNotExists</p><p>&#160;</p><p 
class="confluenceTd">&#160;</p><p>true</p><p>&#160;</p><p>Defines whether or 
not Camel sh
 ould try to create the table if it doesn't 
exist.</p><p>&#160;</p><p>&#160;</p><p 
class="confluenceTd">&#160;</p><p>tableExistsString</p><p>&#160;</p><p 
class="confluenceTd">&#160;</p><p>SELECT 1 FROM CAMEL_MESSAGEPROCESSED WHERE 1 
= 0</p><p>&#160;</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>&#160;</p><p>&#160;</p><p 
class="confluenceTd">&#160;</p><p>createString</p><p>&#160;</p><p 
class="confluenceTd">&#160;</p><p>CREATE TABLE CAMEL_MESSAGEPROCESSED 
(processorName VARCHAR(255), messageId VARCHAR(100), createdAt 
TIMESTAMP)</p><p>&#160;</p><p>The statement which is used to create the 
table.</p><p>&#160;</p><p>&#160;</p><p 
class="confluenceTd">&#160;</p><p>queryString</p><p>&#160;</p><p 
class="confluenceTd">&#160;</p><p>SELECT COUNT(*) FROM CAMEL_MESSAGEPROCESSED 
WHERE processorName = ? AND messageId = ?</p><p>&#160;</p><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>) and 
the second one is the message id 
(<code>String</code>).</p><p>&#160;</p><p>&#160;</p><p 
class="confluenceTd">&#160;</p><p>insertString</p><p>&#160;</p><p 
class="confluenceTd">&#160;</p><p>INSERT INTO CAMEL_MESSAGEPROCESSED 
(processorName, messageId, createdAt) VALUES (?, ?, ?)</p><p>&#160;</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>&#160;</p><p 
class="confluenceTd">&#160;</p><p>deleteString</p><p>&#160;</p><p 
class="confluenceTd">&#160;</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>&#160;</p><p>A customized 
<code>org.apache.camel.processor.idempotent.jdbc.JdbcMessageIdRepository</code> 
could look 
like:</p><p>&#160;</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>&#160;</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">&#160;</div></div><p>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.</p><p>&#160;</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">&#160;</p><p>&#160;</p><p 
class="confluenceTh">&#160;</p><p>Option</p><p>&#160;</p><p 
class="confluenceTh">&#160;</p><p>Type</p><p>&#160;</p><p>Description</p><p>&#160;</p><p>&#160;</p><p
 class="confluenceTd">&#160;</p><p><code>dataSource</code></p><p>&#160;</p><p 
class="confluenceTd">&#160;</p><p><code>DataSourc
 e</code></p><p>&#160;</p><p><strong>Mandatory:</strong> The 
<code>javax.sql.DataSource</code> to use for accessing the 
database.</p><p>&#160;</p><p>&#160;</p><p 
class="confluenceTd">&#160;</p><p><code>repositoryName</code></p><p>&#160;</p><p
 
class="confluenceTd">&#160;</p><p><code>String</code></p><p>&#160;</p><p><strong>Mandatory:</strong>
 The name of the repository.</p><p>&#160;</p><p>&#160;</p><p 
class="confluenceTd">&#160;</p><p><code>transactionManager</code></p><p>&#160;</p><p
 
class="confluenceTd">&#160;</p><p><code>TransactionManager</code></p><p>&#160;</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>&#160;</p><p>&#160;</p><p 
class="confluenceTd">&#160;</p><p><code>lobHandler</code></p><p>&#160;</p><p 
class="confluenceTd">&#160;</p><p><code>LobHandler</code></p><p>&#160;</p><p>A 
<code>org.springframework.jdbc.sup
 port.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>&#160;</p><p>&#160;</p><p 
class="confluenceTd">&#160;</p><p><code>returnOldExchange</code></p><p>&#160;</p><p
 class="confluenceTd">&#160;</p><p>boolean</p><p>&#160;</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>&#160;</p><p>&#160;</p><p 
class="confluenceTd">&#160;</p><p><code>useRecovery</code></p><p>&#160;</p><p 
class="confluenceTd">&#160;</p><p>boolean</p><p>&#160;</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>&#160;</p><p>&#160;</p><p 
class="confluenceTd">&#160;</p><p><code>recove
 ryInterval</code></p><p>&#160;</p><p 
class="confluenceTd">&#160;</p><p>long</p><p>&#160;</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>&#160;</p><p>&#160;</p><p 
class="confluenceTd">&#160;</p><p><code>maximumRedeliveries</code></p><p>&#160;</p><p
 class="confluenceTd">&#160;</p><p>int</p><p>&#160;</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>&#160;</p><p>&#160;</p><p 
class="confluenceTd">&#160;</p><p><code>deadLetterUri</code></p><p>&#160;</p><p 
class="confluenceTd">&#160;</p><p>String</p><p>&#160;</p><p>An endpoint uri for 
a <a shape="rect" href="dead-letter-channel.html">Dea
 d 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>&#160;</p><p>&#160;</p><p 
class="confluenceTd">&#160;</p><p><code>storeBodyAsText</code></p><p>&#160;</p><p
 class="confluenceTd">&#160;</p><p>boolean</p><p>&#160;</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>&#160;</p><p>&#160;</p><p 
class="confluenceTd">&#160;</p><p><code>headersToStoreAsText</code></p><p>&#160;</p><p
 
class="confluenceTd">&#160;</p><p><code>List&lt;String&gt;</code></p><p>&#160;</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>&#160;</p><p>&#160;</p><p 
class="confluenceTd">&#160;</p><p><code>optimisticLocking</code></p><p>&#160;</
 p><p 
class="confluenceTd">&#160;</p><p><code>false</code></p><p>&#160;</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>&#160;</p><p 
class="confluenceTd">&#160;</p><p><code>jdbcOptimisticLockingExceptionMapper</code></p><p>&#160;</p><p
 class="confluenceTd">&#160;</p><p>&#160;</p><p>&#160;</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>&#160;</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 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 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 resubmitted and send out again.</p><p>Th
 e following headers is set when an <a shape="rect" 
href="exchange.html">Exchange</a> is being recovered/redelivered:</p><p 
class="confluenceTable">&#160;</p><p>&#160;</p><p 
class="confluenceTh">&#160;</p><p>Header</p><p>&#160;</p><p 
class="confluenceTh">&#160;</p><p>Type</p><p>&#160;</p><p>Description</p><p>&#160;</p><p>&#160;</p><p
 
class="confluenceTd">&#160;</p><p><code>Exchange.REDELIVERED</code></p><p>&#160;</p><p
 class="confluenceTd">&#160;</p><p>Boolean</p><p>&#160;</p><p>Is set to true to 
indicate the <a shape="rect" href="exchange.html">Exchange</a> is being 
redelivered.</p><p>&#160;</p><p 
class="confluenceTd">&#160;</p><p><code>Exchange.REDELIVERY_COUNTER</code></p><p>&#160;</p><p
 class="confluenceTd">&#160;</p><p>Integer</p><p>&#160;</p><p>The redelivery 
attempt, starting from 1.</p><p>&#160;</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 i
 s 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 t
 he 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">
+</div></div><p>CREATE TABLE CAMEL_MESSAGEPROCESSED ( processorName 
VARCHAR(255), messageId VARCHAR(100), createdAt TIMESTAMP 
)</p><p>&#160;</p><p>&#160;</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">&#160;</div></div><p 
class="wysiwyg-macro-body">The SQL Server&#160;<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>&#160;</p><p>&#160;</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>&#160;</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>&#160;</p><p>&#160;</p><p>And
 finally we can create our JDBC idempotent repository in the spring XML file as 
well:</p><p>&#160;</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>&#160;</p><p>&#160;</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">&#160;</p><p>&#160;</p><p 
class="confluenceTh">&#160;</p><p>Parameter</p><p>&#160;</p><p 
class="confluenceTh">&#160;</p><p>Default 
Value</p><p>&#160;</p><p>Description</p><p>&#160;</p><p>&#160;</p><p 
class="confluenceTd">&#160;</p><p>createTableIfNotExists</p><p>&#160;</p><p 
class="confluenceTd">&#160;</p><p>true</p><p>&#160;</p><p>Defin
 es whether or not Camel should try to create the table if it doesn't 
exist.</p><p>&#160;</p><p>&#160;</p><p 
class="confluenceTd">&#160;</p><p>tableExistsString</p><p>&#160;</p><p 
class="confluenceTd">&#160;</p><p>SELECT 1 FROM CAMEL_MESSAGEPROCESSED WHERE 1 
= 0</p><p>&#160;</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>&#160;</p><p>&#160;</p><p 
class="confluenceTd">&#160;</p><p>createString</p><p>&#160;</p><p 
class="confluenceTd">&#160;</p><p>CREATE TABLE CAMEL_MESSAGEPROCESSED 
(processorName VARCHAR(255), messageId VARCHAR(100), createdAt 
TIMESTAMP)</p><p>&#160;</p><p>The statement which is used to create the 
table.</p><p>&#160;</p><p>&#160;</p><p 
class="confluenceTd">&#160;</p><p>queryString</p><p>&#160;</p><p 
class="confluenceTd">&#160;</p><p>SELECT COUNT(*) FROM CAMEL_MESSAGEPROCESSED 
WHERE processorName = ? AND messageId = ?</p><p>&#160;</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>&#160;</p><p>&#160;</p><p 
class="confluenceTd">&#160;</p><p>insertString</p><p>&#160;</p><p 
class="confluenceTd">&#160;</p><p>INSERT INTO CAMEL_MESSAGEPROCESSED 
(processorName, messageId, createdAt) VALUES (?, ?, ?)</p><p>&#160;</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>&#160;</p><p 
class="confluenceTd">&#160;</p><p>deleteString</p><p>&#160;</p><p 
class="confluenceTd">&#160;</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>&#160;</p><p>A customized 
<code>org.apache.camel.processor.idempotent.jdbc.JdbcMessageIdRepository</code> 
could look 
like:</p><p>&#160;</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>&#160;</p><p>&#160;</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">&#160;</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>&#160;</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">&#160;</p><p>&#160;</p><p 
class="confluenceTh">&#160;</p><p>Option</p><p>&#160;</p><p 
class="confluenceTh">&#160;</p><p>Type</p><p>&#160;</p><p>Description</p><p>&#160;</p><p>&#160;</p><p
 class="confluenceTd">&#160;</p><p><code>dataSource</code></p><p>&#160;</p><p 
class="con
 
fluenceTd">&#160;</p><p><code>DataSource</code></p><p>&#160;</p><p><strong>Mandatory:</strong>
 The <code>javax.sql.DataSource</code> to use for accessing the 
database.</p><p>&#160;</p><p>&#160;</p><p 
class="confluenceTd">&#160;</p><p><code>repositoryName</code></p><p>&#160;</p><p
 
class="confluenceTd">&#160;</p><p><code>String</code></p><p>&#160;</p><p><strong>Mandatory:</strong>
 The name of the repository.</p><p>&#160;</p><p>&#160;</p><p 
class="confluenceTd">&#160;</p><p><code>transactionManager</code></p><p>&#160;</p><p
 
class="confluenceTd">&#160;</p><p><code>TransactionManager</code></p><p>&#160;</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>&#160;</p><p>&#160;</p><p 
class="confluenceTd">&#160;</p><p><code>lobHandler</code></p><p>&#160;</p><p 
class="confluenceTd">&#160;</p><p><code>LobHandler</code></p><p>&#160;</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>&#160;</p><p>&#160;</p><p 
class="confluenceTd">&#160;</p><p><code>returnOldExchange</code></p><p>&#160;</p><p
 class="confluenceTd">&#160;</p><p>boolean</p><p>&#160;</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>&#160;</p><p>&#160;</p><p 
class="confluenceTd">&#160;</p><p><code>useRecovery</code></p><p>&#160;</p><p 
class="confluenceTd">&#160;</p><p>boolean</p><p>&#160;</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>&#160;</p><p>&#160;</p><p class="
 confluenceTd">&#160;</p><p><code>recoveryInterval</code></p><p>&#160;</p><p 
class="confluenceTd">&#160;</p><p>long</p><p>&#160;</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>&#160;</p><p>&#160;</p><p 
class="confluenceTd">&#160;</p><p><code>maximumRedeliveries</code></p><p>&#160;</p><p
 class="confluenceTd">&#160;</p><p>int</p><p>&#160;</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>&#160;</p><p>&#160;</p><p 
class="confluenceTd">&#160;</p><p><code>deadLetterUri</code></p><p>&#160;</p><p 
class="confluenceTd">&#160;</p><p>String</p><p>&#160;</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>&#160;</p><p>&#160;</p><p 
class="confluenceTd">&#160;</p><p><code>storeBodyAsText</code></p><p>&#160;</p><p
 class="confluenceTd">&#160;</p><p>boolean</p><p>&#160;</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>&#160;</p><p>&#160;</p><p 
class="confluenceTd">&#160;</p><p><code>headersToStoreAsText</code></p><p>&#160;</p><p
 
class="confluenceTd">&#160;</p><p><code>List&lt;String&gt;</code></p><p>&#160;</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>&#160;</p><p>&#160;</p><p class="confluenceTd">&#160;</p><p><code>
 optimisticLocking</code></p><p>&#160;</p><p 
class="confluenceTd">&#160;</p><p><code>false</code></p><p>&#160;</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>&#160;</p><p 
class="confluenceTd">&#160;</p><p><code>jdbcOptimisticLockingExceptionMapper</code></p><p>&#160;</p><p
 class="confluenceTd">&#160;</p><p>&#160;</p><p>&#160;</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>&#160;</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">&#160;</p><p>&#160;</p><p 
class="confluenceTh">&#160;</p><p>Header</p><p>&#160;</p><p 
class="confluenceTh">&#160;</p><p>Type</p><p>&#160;</p><p>Description</p><p>&#160;</p><p>&#160;</p><p
 
class="confluenceTd">&#160;</p><p><code>Exchange.REDELIVERED</code></p><p>&#160;</p><p
 class="confluenceTd">&#160;</p><p>Boolean</p><p>&#160;</p><p>Is set to true to 
indicate the <a shape="rect" href="exchange.html">Exchange</a> is being 
redelivered.</p><p>&#160;</p><p 
class="confluenceTd">&#160;</p><p><code>Exchange.REDELIVERY_COUNTER</code></p><p>&#160;</p><p
 class="confluenceTd">&#160;</p><p>Integer</p><p>&#160;</p><p>The redelivery 
attempt, starting from 1.</p><p>&#160;</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>&#160;</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>


Reply via email to