This is an automated email from the ASF dual-hosted git repository.
acosentino pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel.git
commit 539fafec271bf51316eff9d0fbb52841634a5e0e
Author: Andrea Cosentino <anco...@gmail.com>
AuthorDate: Mon Feb 26 10:38:18 2018 +0100
Added automatic generation makers for enricher docs
---
camel-core/src/main/docs/eips/enrich-eip.adoc | 33 ++++++++++++++-------------
1 file changed, 17 insertions(+), 16 deletions(-)
diff --git a/camel-core/src/main/docs/eips/enrich-eip.adoc
b/camel-core/src/main/docs/eips/enrich-eip.adoc
index 68cf1b7..c93ac4e 100644
--- a/camel-core/src/main/docs/eips/enrich-eip.adoc
+++ b/camel-core/src/main/docs/eips/enrich-eip.adoc
@@ -5,6 +5,23 @@ Camel supports the Content Enricher from the EIP patterns
using a Message Transl
image:http://www.enterpriseintegrationpatterns.com/img/DataEnricher.gif[image]
+// eip options: START
+The Enrich EIP supports 7 options which are listed below:
+
+
+[width="100%",cols="2,5,^1,2",options="header"]
+|===
+| Name | Description | Default | Type
+| *strategyRef* | Refers to an AggregationStrategy to be used to merge the
reply from the external service, into a single outgoing message. By default
Camel will use the reply from the external service as outgoing message. | |
String
+| *strategyMethodName* | This option can be used to explicit declare the
method name to use, when using POJOs as the AggregationStrategy. | | String
+| *strategyMethodAllowNull* | If this option is false then the aggregate
method is not used if there was no data to enrich. If this option is true then
null values is used as the oldExchange (when no data to enrich), when using
POJOs as the AggregationStrategy. | false | Boolean
+| *aggregateOnException* | If this option is false then the aggregate method
is not used if there was an exception thrown while trying to retrieve the data
to enrich from the resource. Setting this option to true allows end users to
control what to do if there was an exception in the aggregate method. For
example to suppress the exception or set a custom message body etc. | false |
Boolean
+| *shareUnitOfWork* | Shares the org.apache.camel.spi.UnitOfWork with the
parent and the resource exchange. Enrich will by default not share unit of work
between the parent exchange and the resource exchange. This means the resource
exchange has its own individual unit of work. | false | Boolean
+| *cacheSize* | Sets the maximum size used by the
org.apache.camel.impl.ProducerCache which is used to cache and reuse producer
when uris are reused. | | Integer
+| *ignoreInvalidEndpoint* | Ignore the invalidate endpoint exception when try
to create a producer with that endpoint | false | Boolean
+|===
+// eip options: END
+
=== Content enrichment using a Message Translator or a Processor
You can use Templating to consume a message from one destination, transform it
with something like Velocity or XQuery, and then send it on to another
destination. For example using InOnly (one way messaging)
@@ -82,22 +99,6 @@ Instead of using enrich you can use Recipient List and have
dynamic endpoints an
From *Camel 2.16* onwards both `enrich` and `pollEnrich` supports dynamic
endpoints that uses an Expression to compute the uri, which allows to use data
from the current Exchange. In other words all what is told above no longer
apply and it just works.
====
-=== Enrich Options
-[width="100%",cols="3,2,6",options="header"]
-|===
-| Option | Default Value | Description
-| `uri` | | The endpoint uri for the external service to enrich from. You
must use either uri or ref. *Important:* From Camel 2.16 onwards, this option
is removed, and you use an Expression to configure the uri, such as Simple or
Constant or any other dynamic language that can compute the uri dynamically
using values from the current Exchange.
-| `ref` | | Refers to the endpoint for the external service to enrich from.
You must use either `uri` or `ref`. *Important:* From *Camel 2.16* onwards,
this option is removed, and you use an Expression to configure the uri, such as
Simple or Constant or any other dynamic language that can compute the uri
dynamically using values from the current Exchange.
-| `expression` | | *Camel 2.16*: Mandatory. The Expression to configure the
uri, such as Simple or Constant or any other dynamic language that can compute
the uri dynamically using values from the current Exchange.
-| `strategyRef` | | Refers to an `AggregationStrategy` to be used to merge
the reply from the external service, into a single outgoing message. By default
Camel will use the reply from the external service as outgoing message. From
*Camel 2.12* onwards you can also use a POJO as the AggregationStrategy, see
the Aggregate page for more details.
-| `strategyMethodName` | | *Camel 2.12*: This option can be used to explicit
declare the method name to use, when using POJOs as the `AggregationStrategy`.
See the Aggregate page for more details.
-| `strategyMethodAllowNull` | `false` | *Camel 2.12*: If this option is
`false` then the aggregate method is *not* used if there was no data to enrich.
If this option is `true` then `null` values is used as the `oldExchange` (when
no data to enrich), when using POJOs as the `AggregationStrategy`. See the
Aggregate page for more details.
-| `aggregateOnException` | `false` | *Camel 2.14*: If this option is `false`
then the aggregate method is *not* used if there was an exception thrown while
trying to retrieve the data to enrich from the resource. Setting this option to
true allows end users to control what to do if there was an exception in the
aggregate method. For example to suppress the exception or set a custom message
body etc.
-| `shareUnitOfWork` | `false` | *Camel 2.16*: Shares the unit of work with
the parent and the resource exchange. Enrich will by default not share unit of
work between the parent exchange and the resource exchange. This means the
resource exchange has its own individual unit of work. See Splitter for more
information and example.
-| `cacheSize` | | *Camel 2.16*: Allows to configure the cache size for the
ProducerCache which caches producers for reuse in the enrich. Will by default
use the default cache size which is 1000. Setting the value to -1 allows to
turn off the cache all together.
-| `ignoreInvalidEndpoint` | false | *Camel 2.16*: Whether to ignore an
endpoint URI that could not be resolved. If disabled, Camel will throw an
exception identifying the invalid endpoint URI.
-|===
-
A little enrich example using Java:
[source,java]
--
To stop receiving notification emails like this one, please contact
acosent...@apache.org.
