Author: buildbot
Date: Sun Oct 20 17:19:22 2013
New Revision: 883473
Log:
Production update by buildbot for camel
Modified:
websites/production/camel/content/book-component-appendix.html
websites/production/camel/content/book-in-one-page.html
websites/production/camel/content/cache/main.pageCache
websites/production/camel/content/jpa.html
Modified: websites/production/camel/content/book-component-appendix.html
==============================================================================
--- websites/production/camel/content/book-component-appendix.html (original)
+++ websites/production/camel/content/book-component-appendix.html Sun Oct 20
17:19:22 2013
@@ -10091,14 +10091,14 @@ jpa:entityClassName[?options]
<h3><a shape="rect" name="BookComponentAppendix-Options"></a>Options</h3>
<div class="confluenceTableSmall"><div class="table-wrap">
-<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh"> Name </th><th colspan="1" rowspan="1"
class="confluenceTh"> Default Value </th><th colspan="1" rowspan="1"
class="confluenceTh"> Description </th></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>entityType</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <em>entityClassName</em> </td><td colspan="1" rowspan="1"
class="confluenceTd"> Overrides the <em>entityClassName</em> from the URI.
</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>persistenceUnit</tt> </td><td colspan="1" rowspan="1" class="confluenceTd">
<tt>camel</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> The JPA
persistence unit used by default. </td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>consumeDelete</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>true</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>JPA consumer only:</b>
If <tt>true</tt>, the entity is deleted after it is consumed; if
<tt>false</tt>, the entity is not deleted. </td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>consumeLockEntity</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>true</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <b>JPA consumer only:</b>
Specifies whether or not to set an exclusive lock on each entity bean while
processing the results from polling. </td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>flushOnSend</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>true</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>JPA producer only:</b> Flushes the <a shape="rect"
class="external-link"
href="http://java.sun.com/javaee/5/docs/api/javax/persistence/EntityManager.html";
rel="nofollow">EntityManager</a> after the entity bean has been persisted.
</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>maximumResults</tt> </td
><td colspan="1" rowspan="1" class="confluenceTd"> <tt>-1</tt> </td><td
>colspan="1" rowspan="1" class="confluenceTd"> <b>JPA consumer only:</b> Set
>the maximum number of results to retrieve on the <a shape="rect"
>class="external-link"
>href="http://java.sun.com/javaee/5/docs/api/javax/persistence/Query.html";
>rel="nofollow">Query</a>. </td></tr><tr><td colspan="1" rowspan="1"
>class="confluenceTd"> <tt>transactionManager</tt> </td><td colspan="1"
>rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1"
>rowspan="1" class="confluenceTd"> This option is <a shape="rect"
>href="registry.html" title="Registry">Registry</a> based which requires the
><tt>#</tt> notation so that the given <tt>transactionManager</tt> being
>specified can be looked up properly, e.g.
><tt>transactionManager=#myTransactionManager</tt>. It specifies the
>transaction manager to use. If none provided, Camel will use a
><tt>JpaTransactionManager</tt> by default. Can be used to set a JTA
>transaction manager (for
integration with an EJB container). </td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>consumer.delay</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>500</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>JPA consumer only:</b> Delay in milliseconds between
each poll. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>consumer.initialDelay</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>1000</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>JPA consumer only:</b> Milliseconds before polling
starts. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>consumer.useFixedDelay</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>JPA consumer only:</b> Set to <tt>true</tt> to use
fixed delay between polls, otherwise fixed rate is used. See <a shape="rect"
class="external-link" href="http://java.sun.com/j2
se/1.5.0/docs/api/java/util/concurrent/ScheduledExecutorService.html"
rel="nofollow">ScheduledExecutorService</a> in JDK for details.
</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>maxMessagesPerPoll</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>0</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>JPA consumer only:</b> An integer value to define the
maximum number of messages to gather per poll. By default, no maximum is set.
Can be used to avoid polling many thousands of messages when starting up the
server. Set a value of 0 or negative to disable. </td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>consumer.query</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>JPA consumer only:</b> To use a custom query when
consuming data. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>consumer.namedQuery</tt> </td><td colspan="1" row
span="1" class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>JPA consumer only:</b> To use a named query when
consuming data. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>consumer.nativeQuery</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>JPA consumer only:</b> To use a custom native query
when consuming data. You may want to use the option
<tt>consumer.resultClass</tt> also when using native queries. </td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>consumer.parameters</tt>
</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.12: JPA consumer
only:</b> the parameters map which will be used for building the query. The
parameters is an instance of Map which key is String and value is Object.
</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>consum
er.resultClass</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>Camel 2.7: JPA consumer only:</b> Defines the type of
the returned payload (we will call
<tt>entityManager.createNativeQuery(nativeQuery, resultClass)</tt> instead of
<tt>entityManager.createNativeQuery(nativeQuery)</tt>). Without this option, we
will return an object array. Only has an affect when using in conjunction with
native query when consuming data. </td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>consumer.transacted</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <b>Camel 2.7.5/2.8.3/2.9: JPA consumer
only:</b> Whether to run the consumer in transacted mode, by which all messages
will either commit or rollback, when the entire batch has been processed. The
default behavior (false) is to commit all the previously successfully processed
mess
ages, and only rollback the last failed message. </td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>consumer.lockModeType</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>WRITE</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.11.2/2.12:</b> To
configure the lock mode on the consumer. The possible values is defined in the
enum <tt>javax.persistence.LockModeType</tt>. </td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>usePersist</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <b>Camel 2.5: JPA producer only:</b>
Indicates to use <tt>entityManager.persist(entity)</tt> instead of
<tt>entityManager.merge(entity)</tt>. Note:
<tt>entityManager.persist(entity)</tt> doesn't work for detached entities
(where the EntityManager has to execute an UPDATE instead of an INSERT query)!
</td></tr></tbody></table>
+<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh"> Name </th><th colspan="1" rowspan="1"
class="confluenceTh"> Default Value </th><th colspan="1" rowspan="1"
class="confluenceTh"> Description </th></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>entityType</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <em>entityClassName</em> </td><td colspan="1" rowspan="1"
class="confluenceTd"> Overrides the <em>entityClassName</em> from the URI.
</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>persistenceUnit</tt> </td><td colspan="1" rowspan="1" class="confluenceTd">
<tt>camel</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> The JPA
persistence unit used by default. </td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>consumeDelete</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>true</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>JPA consumer only:</b>
If <tt>true</tt>, the entity is deleted after it is consumed; if
<tt>false</tt>, the entity is not deleted. </td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>consumeLockEntity</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>true</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <b>JPA consumer only:</b>
Specifies whether or not to set an exclusive lock on each entity bean while
processing the results from polling. </td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>flushOnSend</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>true</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>JPA producer only:</b> Flushes the <a shape="rect"
class="external-link"
href="http://java.sun.com/javaee/5/docs/api/javax/persistence/EntityManager.html";
rel="nofollow">EntityManager</a> after the entity bean has been persisted.
</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>maximumResults</tt> </td
><td colspan="1" rowspan="1" class="confluenceTd"> <tt>-1</tt> </td><td
>colspan="1" rowspan="1" class="confluenceTd"> <b>JPA consumer only:</b> Set
>the maximum number of results to retrieve on the <a shape="rect"
>class="external-link"
>href="http://java.sun.com/javaee/5/docs/api/javax/persistence/Query.html";
>rel="nofollow">Query</a>. </td></tr><tr><td colspan="1" rowspan="1"
>class="confluenceTd"> <tt>transactionManager</tt> </td><td colspan="1"
>rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1"
>rowspan="1" class="confluenceTd"> This option is <a shape="rect"
>href="registry.html" title="Registry">Registry</a> based which requires the
><tt>#</tt> notation so that the given <tt>transactionManager</tt> being
>specified can be looked up properly, e.g.
><tt>transactionManager=#myTransactionManager</tt>. It specifies the
>transaction manager to use. If none provided, Camel will use a
><tt>JpaTransactionManager</tt> by default. Can be used to set a JTA
>transaction manager (for
integration with an EJB container). </td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>consumer.delay</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>500</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>JPA consumer only:</b> Delay in milliseconds between
each poll. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>consumer.initialDelay</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>1000</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>JPA consumer only:</b> Milliseconds before polling
starts. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>consumer.useFixedDelay</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>JPA consumer only:</b> Set to <tt>true</tt> to use
fixed delay between polls, otherwise fixed rate is used. See <a shape="rect"
class="external-link" href="http://java.sun.com/j2
se/1.5.0/docs/api/java/util/concurrent/ScheduledExecutorService.html"
rel="nofollow">ScheduledExecutorService</a> in JDK for details.
</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>maxMessagesPerPoll</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>0</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>JPA consumer only:</b> An integer value to define the
maximum number of messages to gather per poll. By default, no maximum is set.
Can be used to avoid polling many thousands of messages when starting up the
server. Set a value of 0 or negative to disable. </td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>consumer.query</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>JPA consumer only:</b> To use a custom query when
consuming data. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>consumer.namedQuery</tt> </td><td colspan="1" row
span="1" class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>JPA consumer only:</b> To use a named query when
consuming data. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>consumer.nativeQuery</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>JPA consumer only:</b> To use a custom native query
when consuming data. You may want to use the option
<tt>consumer.resultClass</tt> also when using native queries. </td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>consumer.parameters</tt>
</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.12: JPA consumer
only:</b> This option is <a shape="rect" href="registry.html"
title="Registry">Registry</a> based which requires the <tt>#</tt> notation.
This key/value mapping is used for building the query parameters. It's is
expected to
be of the generic type <tt>java.util.Map<String, Object></tt> where the
keys are the named parameters of a given JPA query and the values are their
corresponding effective values you want to select for. </td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>consumer.resultClass</tt>
</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.7: JPA consumer
only:</b> Defines the type of the returned payload (we will call
<tt>entityManager.createNativeQuery(nativeQuery, resultClass)</tt> instead of
<tt>entityManager.createNativeQuery(nativeQuery)</tt>). Without this option, we
will return an object array. Only has an affect when using in conjunction with
native query when consuming data. </td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>consumer.transacted</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"
> <b>Camel 2.7.5/2.8.3/2.9: JPA consumer only:</b> Whether to run the consumer
> in transacted mode, by which all messages will either commit or rollback,
> when the entire batch has been processed. The default behavior (false) is to
> commit all the previously successfully processed messages, and only rollback
> the last failed message. </td></tr><tr><td colspan="1" rowspan="1"
> class="confluenceTd"> <tt>consumer.lockModeType</tt> </td><td colspan="1"
> rowspan="1" class="confluenceTd"> <tt>WRITE</tt> </td><td colspan="1"
> rowspan="1" class="confluenceTd"> <b>Camel 2.11.2/2.12:</b> To configure the
> lock mode on the consumer. The possible values is defined in the enum
> <tt>javax.persistence.LockModeType</tt>. </td></tr><tr><td colspan="1"
> rowspan="1" class="confluenceTd"> <tt>usePersist</tt> </td><td colspan="1"
> rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1"
> rowspan="1" class="confluenceTd"> <b>Camel 2.5: JPA producer only:</b>
> Indicates to use <tt>entityManager.persist(en
tity)</tt> instead of <tt>entityManager.merge(entity)</tt>. Note:
<tt>entityManager.persist(entity)</tt> doesn't work for detached entities
(where the EntityManager has to execute an UPDATE instead of an INSERT query)!
</td></tr></tbody></table>
</div>
</div>
<h3><a shape="rect" name="BookComponentAppendix-MessageHeaders"></a>Message
Headers</h3>
<p>Camel adds the following message headers to the exchange:</p>
<div class="confluenceTableSmall"><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"> <tt>CamelJpaTemplate</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>JpaTemplate</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <b>Not supported since Camel 2.12:</b> The
<tt>JpaTemplate</tt> object that is used to access the entity bean. You need
this object in some situations, for instance in a type converter or when you
are doing some custom processing. See <a shape="rect" class="external-link"
href="https://issues.apache.org/jira/browse/CAMEL-5932";>CAMEL-5932</a> for the
reason why the support for this header has been dropped. </td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>CamelEntityManager</tt>
</td><td colspan="1" rowspan="1" class="confluen
ceTd"> <tt>EntityManager</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>Camel 2.12: JPA consumer / Camel 2.12.2: JPA
producer:</b> The JPA <tt>EntityManager</tt> object being used by
<tt>JpaConsumer</tt> or <tt>JpaProducer</tt>. </td></tr></tbody></table>
+<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"> <tt>CamelJpaTemplate</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>JpaTemplate</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <b>Not supported anymore since Camel
2.12:</b> The <tt>JpaTemplate</tt> object that is used to access the entity
bean. You need this object in some situations, for instance in a type converter
or when you are doing some custom processing. See <a shape="rect"
class="external-link"
href="https://issues.apache.org/jira/browse/CAMEL-5932";>CAMEL-5932</a> for the
reason why the support for this header has been dropped. </td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>CamelEntityManager</tt>
</td><td colspan="1" rowspan="1" class="
confluenceTd"> <tt>EntityManager</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>Camel 2.12: JPA consumer / Camel 2.12.2: JPA
producer:</b> The JPA <tt>EntityManager</tt> object being used by
<tt>JpaConsumer</tt> or <tt>JpaProducer</tt>. </td></tr></tbody></table>
</div>
</div>
Modified: websites/production/camel/content/book-in-one-page.html
==============================================================================
--- websites/production/camel/content/book-in-one-page.html (original)
+++ websites/production/camel/content/book-in-one-page.html Sun Oct 20 17:19:22
2013
@@ -31579,14 +31579,14 @@ jpa:entityClassName[?options]
<h3><a shape="rect" name="BookInOnePage-Options"></a>Options</h3>
<div class="confluenceTableSmall"><div class="table-wrap">
-<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh"> Name </th><th colspan="1" rowspan="1"
class="confluenceTh"> Default Value </th><th colspan="1" rowspan="1"
class="confluenceTh"> Description </th></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>entityType</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <em>entityClassName</em> </td><td colspan="1" rowspan="1"
class="confluenceTd"> Overrides the <em>entityClassName</em> from the URI.
</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>persistenceUnit</tt> </td><td colspan="1" rowspan="1" class="confluenceTd">
<tt>camel</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> The JPA
persistence unit used by default. </td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>consumeDelete</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>true</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>JPA consumer only:</b>
If <tt>true</tt>, the entity is deleted after it is consumed; if
<tt>false</tt>, the entity is not deleted. </td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>consumeLockEntity</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>true</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <b>JPA consumer only:</b>
Specifies whether or not to set an exclusive lock on each entity bean while
processing the results from polling. </td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>flushOnSend</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>true</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>JPA producer only:</b> Flushes the <a shape="rect"
class="external-link"
href="http://java.sun.com/javaee/5/docs/api/javax/persistence/EntityManager.html";
rel="nofollow">EntityManager</a> after the entity bean has been persisted.
</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>maximumResults</tt> </td
><td colspan="1" rowspan="1" class="confluenceTd"> <tt>-1</tt> </td><td
>colspan="1" rowspan="1" class="confluenceTd"> <b>JPA consumer only:</b> Set
>the maximum number of results to retrieve on the <a shape="rect"
>class="external-link"
>href="http://java.sun.com/javaee/5/docs/api/javax/persistence/Query.html";
>rel="nofollow">Query</a>. </td></tr><tr><td colspan="1" rowspan="1"
>class="confluenceTd"> <tt>transactionManager</tt> </td><td colspan="1"
>rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1"
>rowspan="1" class="confluenceTd"> This option is <a shape="rect"
>href="registry.html" title="Registry">Registry</a> based which requires the
><tt>#</tt> notation so that the given <tt>transactionManager</tt> being
>specified can be looked up properly, e.g.
><tt>transactionManager=#myTransactionManager</tt>. It specifies the
>transaction manager to use. If none provided, Camel will use a
><tt>JpaTransactionManager</tt> by default. Can be used to set a JTA
>transaction manager (for
integration with an EJB container). </td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>consumer.delay</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>500</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>JPA consumer only:</b> Delay in milliseconds between
each poll. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>consumer.initialDelay</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>1000</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>JPA consumer only:</b> Milliseconds before polling
starts. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>consumer.useFixedDelay</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>JPA consumer only:</b> Set to <tt>true</tt> to use
fixed delay between polls, otherwise fixed rate is used. See <a shape="rect"
class="external-link" href="http://java.sun.com/j2
se/1.5.0/docs/api/java/util/concurrent/ScheduledExecutorService.html"
rel="nofollow">ScheduledExecutorService</a> in JDK for details.
</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>maxMessagesPerPoll</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>0</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>JPA consumer only:</b> An integer value to define the
maximum number of messages to gather per poll. By default, no maximum is set.
Can be used to avoid polling many thousands of messages when starting up the
server. Set a value of 0 or negative to disable. </td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>consumer.query</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>JPA consumer only:</b> To use a custom query when
consuming data. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>consumer.namedQuery</tt> </td><td colspan="1" row
span="1" class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>JPA consumer only:</b> To use a named query when
consuming data. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>consumer.nativeQuery</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>JPA consumer only:</b> To use a custom native query
when consuming data. You may want to use the option
<tt>consumer.resultClass</tt> also when using native queries. </td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>consumer.parameters</tt>
</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.12: JPA consumer
only:</b> the parameters map which will be used for building the query. The
parameters is an instance of Map which key is String and value is Object.
</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>consum
er.resultClass</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>Camel 2.7: JPA consumer only:</b> Defines the type of
the returned payload (we will call
<tt>entityManager.createNativeQuery(nativeQuery, resultClass)</tt> instead of
<tt>entityManager.createNativeQuery(nativeQuery)</tt>). Without this option, we
will return an object array. Only has an affect when using in conjunction with
native query when consuming data. </td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>consumer.transacted</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <b>Camel 2.7.5/2.8.3/2.9: JPA consumer
only:</b> Whether to run the consumer in transacted mode, by which all messages
will either commit or rollback, when the entire batch has been processed. The
default behavior (false) is to commit all the previously successfully processed
mess
ages, and only rollback the last failed message. </td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>consumer.lockModeType</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>WRITE</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.11.2/2.12:</b> To
configure the lock mode on the consumer. The possible values is defined in the
enum <tt>javax.persistence.LockModeType</tt>. </td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>usePersist</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <b>Camel 2.5: JPA producer only:</b>
Indicates to use <tt>entityManager.persist(entity)</tt> instead of
<tt>entityManager.merge(entity)</tt>. Note:
<tt>entityManager.persist(entity)</tt> doesn't work for detached entities
(where the EntityManager has to execute an UPDATE instead of an INSERT query)!
</td></tr></tbody></table>
+<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh"> Name </th><th colspan="1" rowspan="1"
class="confluenceTh"> Default Value </th><th colspan="1" rowspan="1"
class="confluenceTh"> Description </th></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>entityType</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <em>entityClassName</em> </td><td colspan="1" rowspan="1"
class="confluenceTd"> Overrides the <em>entityClassName</em> from the URI.
</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>persistenceUnit</tt> </td><td colspan="1" rowspan="1" class="confluenceTd">
<tt>camel</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> The JPA
persistence unit used by default. </td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>consumeDelete</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>true</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>JPA consumer only:</b>
If <tt>true</tt>, the entity is deleted after it is consumed; if
<tt>false</tt>, the entity is not deleted. </td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>consumeLockEntity</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>true</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <b>JPA consumer only:</b>
Specifies whether or not to set an exclusive lock on each entity bean while
processing the results from polling. </td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>flushOnSend</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>true</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>JPA producer only:</b> Flushes the <a shape="rect"
class="external-link"
href="http://java.sun.com/javaee/5/docs/api/javax/persistence/EntityManager.html";
rel="nofollow">EntityManager</a> after the entity bean has been persisted.
</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>maximumResults</tt> </td
><td colspan="1" rowspan="1" class="confluenceTd"> <tt>-1</tt> </td><td
>colspan="1" rowspan="1" class="confluenceTd"> <b>JPA consumer only:</b> Set
>the maximum number of results to retrieve on the <a shape="rect"
>class="external-link"
>href="http://java.sun.com/javaee/5/docs/api/javax/persistence/Query.html";
>rel="nofollow">Query</a>. </td></tr><tr><td colspan="1" rowspan="1"
>class="confluenceTd"> <tt>transactionManager</tt> </td><td colspan="1"
>rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1"
>rowspan="1" class="confluenceTd"> This option is <a shape="rect"
>href="registry.html" title="Registry">Registry</a> based which requires the
><tt>#</tt> notation so that the given <tt>transactionManager</tt> being
>specified can be looked up properly, e.g.
><tt>transactionManager=#myTransactionManager</tt>. It specifies the
>transaction manager to use. If none provided, Camel will use a
><tt>JpaTransactionManager</tt> by default. Can be used to set a JTA
>transaction manager (for
integration with an EJB container). </td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>consumer.delay</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>500</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>JPA consumer only:</b> Delay in milliseconds between
each poll. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>consumer.initialDelay</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>1000</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>JPA consumer only:</b> Milliseconds before polling
starts. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>consumer.useFixedDelay</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>JPA consumer only:</b> Set to <tt>true</tt> to use
fixed delay between polls, otherwise fixed rate is used. See <a shape="rect"
class="external-link" href="http://java.sun.com/j2
se/1.5.0/docs/api/java/util/concurrent/ScheduledExecutorService.html"
rel="nofollow">ScheduledExecutorService</a> in JDK for details.
</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>maxMessagesPerPoll</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>0</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>JPA consumer only:</b> An integer value to define the
maximum number of messages to gather per poll. By default, no maximum is set.
Can be used to avoid polling many thousands of messages when starting up the
server. Set a value of 0 or negative to disable. </td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>consumer.query</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>JPA consumer only:</b> To use a custom query when
consuming data. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>consumer.namedQuery</tt> </td><td colspan="1" row
span="1" class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>JPA consumer only:</b> To use a named query when
consuming data. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>consumer.nativeQuery</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>JPA consumer only:</b> To use a custom native query
when consuming data. You may want to use the option
<tt>consumer.resultClass</tt> also when using native queries. </td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>consumer.parameters</tt>
</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.12: JPA consumer
only:</b> This option is <a shape="rect" href="registry.html"
title="Registry">Registry</a> based which requires the <tt>#</tt> notation.
This key/value mapping is used for building the query parameters. It's is
expected to
be of the generic type <tt>java.util.Map<String, Object></tt> where the
keys are the named parameters of a given JPA query and the values are their
corresponding effective values you want to select for. </td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>consumer.resultClass</tt>
</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.7: JPA consumer
only:</b> Defines the type of the returned payload (we will call
<tt>entityManager.createNativeQuery(nativeQuery, resultClass)</tt> instead of
<tt>entityManager.createNativeQuery(nativeQuery)</tt>). Without this option, we
will return an object array. Only has an affect when using in conjunction with
native query when consuming data. </td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>consumer.transacted</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"
> <b>Camel 2.7.5/2.8.3/2.9: JPA consumer only:</b> Whether to run the consumer
> in transacted mode, by which all messages will either commit or rollback,
> when the entire batch has been processed. The default behavior (false) is to
> commit all the previously successfully processed messages, and only rollback
> the last failed message. </td></tr><tr><td colspan="1" rowspan="1"
> class="confluenceTd"> <tt>consumer.lockModeType</tt> </td><td colspan="1"
> rowspan="1" class="confluenceTd"> <tt>WRITE</tt> </td><td colspan="1"
> rowspan="1" class="confluenceTd"> <b>Camel 2.11.2/2.12:</b> To configure the
> lock mode on the consumer. The possible values is defined in the enum
> <tt>javax.persistence.LockModeType</tt>. </td></tr><tr><td colspan="1"
> rowspan="1" class="confluenceTd"> <tt>usePersist</tt> </td><td colspan="1"
> rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1"
> rowspan="1" class="confluenceTd"> <b>Camel 2.5: JPA producer only:</b>
> Indicates to use <tt>entityManager.persist(en
tity)</tt> instead of <tt>entityManager.merge(entity)</tt>. Note:
<tt>entityManager.persist(entity)</tt> doesn't work for detached entities
(where the EntityManager has to execute an UPDATE instead of an INSERT query)!
</td></tr></tbody></table>
</div>
</div>
<h3><a shape="rect" name="BookInOnePage-MessageHeaders"></a>Message
Headers</h3>
<p>Camel adds the following message headers to the exchange:</p>
<div class="confluenceTableSmall"><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"> <tt>CamelJpaTemplate</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>JpaTemplate</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <b>Not supported since Camel 2.12:</b> The
<tt>JpaTemplate</tt> object that is used to access the entity bean. You need
this object in some situations, for instance in a type converter or when you
are doing some custom processing. See <a shape="rect" class="external-link"
href="https://issues.apache.org/jira/browse/CAMEL-5932";>CAMEL-5932</a> for the
reason why the support for this header has been dropped. </td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>CamelEntityManager</tt>
</td><td colspan="1" rowspan="1" class="confluen
ceTd"> <tt>EntityManager</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>Camel 2.12: JPA consumer / Camel 2.12.2: JPA
producer:</b> The JPA <tt>EntityManager</tt> object being used by
<tt>JpaConsumer</tt> or <tt>JpaProducer</tt>. </td></tr></tbody></table>
+<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"> <tt>CamelJpaTemplate</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>JpaTemplate</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <b>Not supported anymore since Camel
2.12:</b> The <tt>JpaTemplate</tt> object that is used to access the entity
bean. You need this object in some situations, for instance in a type converter
or when you are doing some custom processing. See <a shape="rect"
class="external-link"
href="https://issues.apache.org/jira/browse/CAMEL-5932";>CAMEL-5932</a> for the
reason why the support for this header has been dropped. </td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>CamelEntityManager</tt>
</td><td colspan="1" rowspan="1" class="
confluenceTd"> <tt>EntityManager</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>Camel 2.12: JPA consumer / Camel 2.12.2: JPA
producer:</b> The JPA <tt>EntityManager</tt> object being used by
<tt>JpaConsumer</tt> or <tt>JpaProducer</tt>. </td></tr></tbody></table>
</div>
</div>
Modified: websites/production/camel/content/cache/main.pageCache
==============================================================================
Binary files - no diff available.
Modified: websites/production/camel/content/jpa.html
==============================================================================
--- websites/production/camel/content/jpa.html (original)
+++ websites/production/camel/content/jpa.html Sun Oct 20 17:19:22 2013
@@ -133,14 +133,14 @@ jpa:entityClassName[?options]
<h3><a shape="rect" name="JPA-Options"></a>Options</h3>
<div class="confluenceTableSmall"><div class="table-wrap">
-<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh"> Name </th><th colspan="1" rowspan="1"
class="confluenceTh"> Default Value </th><th colspan="1" rowspan="1"
class="confluenceTh"> Description </th></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>entityType</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <em>entityClassName</em> </td><td colspan="1" rowspan="1"
class="confluenceTd"> Overrides the <em>entityClassName</em> from the URI.
</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>persistenceUnit</tt> </td><td colspan="1" rowspan="1" class="confluenceTd">
<tt>camel</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> The JPA
persistence unit used by default. </td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>consumeDelete</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>true</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>JPA consumer only:</b>
If <tt>true</tt>, the entity is deleted after it is consumed; if
<tt>false</tt>, the entity is not deleted. </td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>consumeLockEntity</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>true</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <b>JPA consumer only:</b>
Specifies whether or not to set an exclusive lock on each entity bean while
processing the results from polling. </td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>flushOnSend</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>true</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>JPA producer only:</b> Flushes the <a shape="rect"
class="external-link"
href="http://java.sun.com/javaee/5/docs/api/javax/persistence/EntityManager.html";
rel="nofollow">EntityManager</a> after the entity bean has been persisted.
</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>maximumResults</tt> </td
><td colspan="1" rowspan="1" class="confluenceTd"> <tt>-1</tt> </td><td
>colspan="1" rowspan="1" class="confluenceTd"> <b>JPA consumer only:</b> Set
>the maximum number of results to retrieve on the <a shape="rect"
>class="external-link"
>href="http://java.sun.com/javaee/5/docs/api/javax/persistence/Query.html";
>rel="nofollow">Query</a>. </td></tr><tr><td colspan="1" rowspan="1"
>class="confluenceTd"> <tt>transactionManager</tt> </td><td colspan="1"
>rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1"
>rowspan="1" class="confluenceTd"> This option is <a shape="rect"
>href="registry.html" title="Registry">Registry</a> based which requires the
><tt>#</tt> notation so that the given <tt>transactionManager</tt> being
>specified can be looked up properly, e.g.
><tt>transactionManager=#myTransactionManager</tt>. It specifies the
>transaction manager to use. If none provided, Camel will use a
><tt>JpaTransactionManager</tt> by default. Can be used to set a JTA
>transaction manager (for
integration with an EJB container). </td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>consumer.delay</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>500</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>JPA consumer only:</b> Delay in milliseconds between
each poll. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>consumer.initialDelay</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>1000</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>JPA consumer only:</b> Milliseconds before polling
starts. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>consumer.useFixedDelay</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>JPA consumer only:</b> Set to <tt>true</tt> to use
fixed delay between polls, otherwise fixed rate is used. See <a shape="rect"
class="external-link" href="http://java.sun.com/j2
se/1.5.0/docs/api/java/util/concurrent/ScheduledExecutorService.html"
rel="nofollow">ScheduledExecutorService</a> in JDK for details.
</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>maxMessagesPerPoll</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>0</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>JPA consumer only:</b> An integer value to define the
maximum number of messages to gather per poll. By default, no maximum is set.
Can be used to avoid polling many thousands of messages when starting up the
server. Set a value of 0 or negative to disable. </td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>consumer.query</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>JPA consumer only:</b> To use a custom query when
consuming data. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>consumer.namedQuery</tt> </td><td colspan="1" row
span="1" class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>JPA consumer only:</b> To use a named query when
consuming data. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>consumer.nativeQuery</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>JPA consumer only:</b> To use a custom native query
when consuming data. You may want to use the option
<tt>consumer.resultClass</tt> also when using native queries. </td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>consumer.parameters</tt>
</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.12: JPA consumer
only:</b> the parameters map which will be used for building the query. The
parameters is an instance of Map which key is String and value is Object.
</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>consum
er.resultClass</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>Camel 2.7: JPA consumer only:</b> Defines the type of
the returned payload (we will call
<tt>entityManager.createNativeQuery(nativeQuery, resultClass)</tt> instead of
<tt>entityManager.createNativeQuery(nativeQuery)</tt>). Without this option, we
will return an object array. Only has an affect when using in conjunction with
native query when consuming data. </td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>consumer.transacted</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <b>Camel 2.7.5/2.8.3/2.9: JPA consumer
only:</b> Whether to run the consumer in transacted mode, by which all messages
will either commit or rollback, when the entire batch has been processed. The
default behavior (false) is to commit all the previously successfully processed
mess
ages, and only rollback the last failed message. </td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>consumer.lockModeType</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>WRITE</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.11.2/2.12:</b> To
configure the lock mode on the consumer. The possible values is defined in the
enum <tt>javax.persistence.LockModeType</tt>. </td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>usePersist</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <b>Camel 2.5: JPA producer only:</b>
Indicates to use <tt>entityManager.persist(entity)</tt> instead of
<tt>entityManager.merge(entity)</tt>. Note:
<tt>entityManager.persist(entity)</tt> doesn't work for detached entities
(where the EntityManager has to execute an UPDATE instead of an INSERT query)!
</td></tr></tbody></table>
+<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh"> Name </th><th colspan="1" rowspan="1"
class="confluenceTh"> Default Value </th><th colspan="1" rowspan="1"
class="confluenceTh"> Description </th></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>entityType</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <em>entityClassName</em> </td><td colspan="1" rowspan="1"
class="confluenceTd"> Overrides the <em>entityClassName</em> from the URI.
</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>persistenceUnit</tt> </td><td colspan="1" rowspan="1" class="confluenceTd">
<tt>camel</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> The JPA
persistence unit used by default. </td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>consumeDelete</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>true</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>JPA consumer only:</b>
If <tt>true</tt>, the entity is deleted after it is consumed; if
<tt>false</tt>, the entity is not deleted. </td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>consumeLockEntity</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>true</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <b>JPA consumer only:</b>
Specifies whether or not to set an exclusive lock on each entity bean while
processing the results from polling. </td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>flushOnSend</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>true</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>JPA producer only:</b> Flushes the <a shape="rect"
class="external-link"
href="http://java.sun.com/javaee/5/docs/api/javax/persistence/EntityManager.html";
rel="nofollow">EntityManager</a> after the entity bean has been persisted.
</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>maximumResults</tt> </td
><td colspan="1" rowspan="1" class="confluenceTd"> <tt>-1</tt> </td><td
>colspan="1" rowspan="1" class="confluenceTd"> <b>JPA consumer only:</b> Set
>the maximum number of results to retrieve on the <a shape="rect"
>class="external-link"
>href="http://java.sun.com/javaee/5/docs/api/javax/persistence/Query.html";
>rel="nofollow">Query</a>. </td></tr><tr><td colspan="1" rowspan="1"
>class="confluenceTd"> <tt>transactionManager</tt> </td><td colspan="1"
>rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1"
>rowspan="1" class="confluenceTd"> This option is <a shape="rect"
>href="registry.html" title="Registry">Registry</a> based which requires the
><tt>#</tt> notation so that the given <tt>transactionManager</tt> being
>specified can be looked up properly, e.g.
><tt>transactionManager=#myTransactionManager</tt>. It specifies the
>transaction manager to use. If none provided, Camel will use a
><tt>JpaTransactionManager</tt> by default. Can be used to set a JTA
>transaction manager (for
integration with an EJB container). </td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>consumer.delay</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>500</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>JPA consumer only:</b> Delay in milliseconds between
each poll. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>consumer.initialDelay</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>1000</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>JPA consumer only:</b> Milliseconds before polling
starts. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>consumer.useFixedDelay</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>JPA consumer only:</b> Set to <tt>true</tt> to use
fixed delay between polls, otherwise fixed rate is used. See <a shape="rect"
class="external-link" href="http://java.sun.com/j2
se/1.5.0/docs/api/java/util/concurrent/ScheduledExecutorService.html"
rel="nofollow">ScheduledExecutorService</a> in JDK for details.
</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>maxMessagesPerPoll</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>0</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>JPA consumer only:</b> An integer value to define the
maximum number of messages to gather per poll. By default, no maximum is set.
Can be used to avoid polling many thousands of messages when starting up the
server. Set a value of 0 or negative to disable. </td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>consumer.query</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>JPA consumer only:</b> To use a custom query when
consuming data. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>consumer.namedQuery</tt> </td><td colspan="1" row
span="1" class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>JPA consumer only:</b> To use a named query when
consuming data. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>consumer.nativeQuery</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>JPA consumer only:</b> To use a custom native query
when consuming data. You may want to use the option
<tt>consumer.resultClass</tt> also when using native queries. </td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>consumer.parameters</tt>
</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.12: JPA consumer
only:</b> This option is <a shape="rect" href="registry.html"
title="Registry">Registry</a> based which requires the <tt>#</tt> notation.
This key/value mapping is used for building the query parameters. It's is
expected to
be of the generic type <tt>java.util.Map<String, Object></tt> where the
keys are the named parameters of a given JPA query and the values are their
corresponding effective values you want to select for. </td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>consumer.resultClass</tt>
</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.7: JPA consumer
only:</b> Defines the type of the returned payload (we will call
<tt>entityManager.createNativeQuery(nativeQuery, resultClass)</tt> instead of
<tt>entityManager.createNativeQuery(nativeQuery)</tt>). Without this option, we
will return an object array. Only has an affect when using in conjunction with
native query when consuming data. </td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>consumer.transacted</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"
> <b>Camel 2.7.5/2.8.3/2.9: JPA consumer only:</b> Whether to run the consumer
> in transacted mode, by which all messages will either commit or rollback,
> when the entire batch has been processed. The default behavior (false) is to
> commit all the previously successfully processed messages, and only rollback
> the last failed message. </td></tr><tr><td colspan="1" rowspan="1"
> class="confluenceTd"> <tt>consumer.lockModeType</tt> </td><td colspan="1"
> rowspan="1" class="confluenceTd"> <tt>WRITE</tt> </td><td colspan="1"
> rowspan="1" class="confluenceTd"> <b>Camel 2.11.2/2.12:</b> To configure the
> lock mode on the consumer. The possible values is defined in the enum
> <tt>javax.persistence.LockModeType</tt>. </td></tr><tr><td colspan="1"
> rowspan="1" class="confluenceTd"> <tt>usePersist</tt> </td><td colspan="1"
> rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1"
> rowspan="1" class="confluenceTd"> <b>Camel 2.5: JPA producer only:</b>
> Indicates to use <tt>entityManager.persist(en
tity)</tt> instead of <tt>entityManager.merge(entity)</tt>. Note:
<tt>entityManager.persist(entity)</tt> doesn't work for detached entities
(where the EntityManager has to execute an UPDATE instead of an INSERT query)!
</td></tr></tbody></table>
</div>
</div>
<h3><a shape="rect" name="JPA-MessageHeaders"></a>Message Headers</h3>
<p>Camel adds the following message headers to the exchange:</p>
<div class="confluenceTableSmall"><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"> <tt>CamelJpaTemplate</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>JpaTemplate</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <b>Not supported since Camel 2.12:</b> The
<tt>JpaTemplate</tt> object that is used to access the entity bean. You need
this object in some situations, for instance in a type converter or when you
are doing some custom processing. See <a shape="rect" class="external-link"
href="https://issues.apache.org/jira/browse/CAMEL-5932";>CAMEL-5932</a> for the
reason why the support for this header has been dropped. </td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>CamelEntityManager</tt>
</td><td colspan="1" rowspan="1" class="confluen
ceTd"> <tt>EntityManager</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>Camel 2.12: JPA consumer / Camel 2.12.2: JPA
producer:</b> The JPA <tt>EntityManager</tt> object being used by
<tt>JpaConsumer</tt> or <tt>JpaProducer</tt>. </td></tr></tbody></table>
+<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"> <tt>CamelJpaTemplate</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>JpaTemplate</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <b>Not supported anymore since Camel
2.12:</b> The <tt>JpaTemplate</tt> object that is used to access the entity
bean. You need this object in some situations, for instance in a type converter
or when you are doing some custom processing. See <a shape="rect"
class="external-link"
href="https://issues.apache.org/jira/browse/CAMEL-5932";>CAMEL-5932</a> for the
reason why the support for this header has been dropped. </td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>CamelEntityManager</tt>
</td><td colspan="1" rowspan="1" class="
confluenceTd"> <tt>EntityManager</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>Camel 2.12: JPA consumer / Camel 2.12.2: JPA
producer:</b> The JPA <tt>EntityManager</tt> object being used by
<tt>JpaConsumer</tt> or <tt>JpaProducer</tt>. </td></tr></tbody></table>
</div>
</div>
