You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by or...@apache.org on 2024/02/25 14:55:09 UTC
(camel) branch main updated (d778e5f952c -> d9843654a8a)
This is an automated email from the ASF dual-hosted git repository.
orpiske pushed a change to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
from d778e5f952c CAMEL-20459: documentation fixes for the log EIP.
new 5b5c44d4a0b CAMEL-20459: minor documentation tweaks for the event message EIP.
new 42e966705c9 CAMEL-20459: minor documentation tweaks for the dead letter channel EIP.
new 3878d31b141 CAMEL-20459: documentation fixes for the loop EIP.
new 77958d468c3 CAMEL-20459: documentation fixes for the marshal EIP.
new f18511884ef CAMEL-20459: documentation fixes for the message EIP.
new 683a007327b CAMEL-20459: documentation fixes for the message broker EIP.
new db7cb04b844 CAMEL-20459: documentation fixes for the message bus EIP.
new e71a70bbca5 CAMEL-20459: documentation fixes for the message dispatcher EIP.
new 0a01c08d284 CAMEL-20459: documentation fixes for the message endpoint EIP.
new 6dfef1d76be CAMEL-20459: documentation fixes for the message expiration EIP.
new 0219a595be5 CAMEL-20459: minor documentation tweaks for the from EIP.
new 1f2d2cae47a CAMEL-20459: minor documentation tweaks for the message history EIP.
new 8baa04777fd CAMEL-20459: minor documentation tweaks for the message router EIP.
new dcdfe21ed99 CAMEL-20459: minor documentation tweaks for the message translator EIP.
new dfe894ae18a CAMEL-20459: minor documentation tweaks for the messaging gateway EIP.
new e9dcd3afe47 CAMEL-20459: minor documentation tweaks for the messaging mapper EIP.
new 440eed62d69 CAMEL-20459: minor documentation tweaks for the multicast EIP.
new bc7ffb42b76 CAMEL-20459: minor documentation tweaks for the normalizer EIP.
new 3e1ffa93332 CAMEL-20459: minor documentation tweaks for the onFallback EIP.
new d9843654a8a CAMEL-20459: minor documentation tweaks for the pipeline EIP.
The 20 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
.../modules/eips/pages/dead-letter-channel.adoc | 54 +++++++++++--
.../docs/modules/eips/pages/event-message.adoc | 2 +-
.../src/main/docs/modules/eips/pages/from-eip.adoc | 2 +
.../src/main/docs/modules/eips/pages/loop-eip.adoc | 6 +-
.../main/docs/modules/eips/pages/marshal-eip.adoc | 11 +--
.../docs/modules/eips/pages/message-broker.adoc | 2 +-
.../main/docs/modules/eips/pages/message-bus.adoc | 4 +-
.../modules/eips/pages/message-dispatcher.adoc | 4 +-
.../docs/modules/eips/pages/message-endpoint.adoc | 2 +-
.../modules/eips/pages/message-expiration.adoc | 2 +-
.../docs/modules/eips/pages/message-history.adoc | 92 +++++++++++++++++-----
.../docs/modules/eips/pages/message-router.adoc | 12 +--
.../modules/eips/pages/message-translator.adoc | 8 +-
.../src/main/docs/modules/eips/pages/message.adoc | 15 ++--
.../docs/modules/eips/pages/messaging-gateway.adoc | 4 +-
.../docs/modules/eips/pages/messaging-mapper.adoc | 6 +-
.../docs/modules/eips/pages/multicast-eip.adoc | 34 ++++----
.../main/docs/modules/eips/pages/normalizer.adoc | 62 ++++++++-------
.../docs/modules/eips/pages/onFallback-eip.adoc | 4 +-
.../main/docs/modules/eips/pages/pipeline-eip.adoc | 18 +++--
20 files changed, 224 insertions(+), 120 deletions(-)
(camel) 13/20: CAMEL-20459: minor documentation tweaks for the message router EIP.
Posted by or...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
orpiske pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
commit 8baa04777fd4bda627f4e827ff230221aff8a4db
Author: Otavio R. Piske <an...@gmail.com>
AuthorDate: Sun Feb 25 14:48:39 2024 +0100
CAMEL-20459: minor documentation tweaks for the message router EIP.
Signed-off-by: Otavio R. Piske <an...@gmail.com>
---
.../src/main/docs/modules/eips/pages/message-router.adoc | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/message-router.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/message-router.adoc
index 9fa5aed7d5f..62d580b926d 100644
--- a/core/camel-core-engine/src/main/docs/modules/eips/pages/message-router.adoc
+++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/message-router.adoc
@@ -4,17 +4,17 @@
The
http://www.enterpriseintegrationpatterns.com/MessageRouter.html[Message
Router] from the xref:enterprise-integration-patterns.adoc[EIP patterns]
-allows you to consume from an input destination, evaluate some predicate
+allows you to consume from an input destination, evaluate some predicate,
then choose the right output destination.
image::eip/MessageRouter.gif[image]
-In Camel the Message Router can be archived in different ways such as:
+In Camel, the Message Router can be archived in different ways such as:
-* You can use the xref:choice-eip.adoc[Content Based Router] to evaluate and choose the output destination.
+* You can use the xref:choice-eip.adoc[Content-Based Router] to evaluate and choose the output destination.
* The xref:routingSlip-eip.adoc[Routing Slip] and xref:dynamicRouter-eip.adoc[Dynamic Router] EIPs can also be used for choosing which destination to route messages.
-The xref:choice-eip.adoc[Content Based Router] is recommended to use when you have multiple predicates to evaluate
+The xref:choice-eip.adoc[Content-Based Router] is recommended to use when you have multiple predicates to evaluate
where to send the message.
The xref:routingSlip-eip.adoc[Routing Slip] and xref:dynamicRouter-eip.adoc[Dynamic Router] are arguably
@@ -24,8 +24,8 @@ to choose where the message should go.
== Example
The following example shows how to route a request from an input
-direct:a endpoint to either direct:b, direct:c, or direct:d depending on
-the evaluation of various xref:manual::predicate.adoc[Predicate]:
+`direct:a` endpoint to either `direct:b`, `direct:c`, or `direct:d` depending on
+the evaluation of various xref:manual::predicate.adoc[Predicates]:
[tabs]
====
(camel) 16/20: CAMEL-20459: minor documentation tweaks for the messaging mapper EIP.
Posted by or...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
orpiske pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
commit e9dcd3afe4712425b658a3bdd7106b53221eb7dc
Author: Otavio R. Piske <an...@gmail.com>
AuthorDate: Sun Feb 25 14:54:00 2024 +0100
CAMEL-20459: minor documentation tweaks for the messaging mapper EIP.
Signed-off-by: Otavio R. Piske <an...@gmail.com>
---
.../src/main/docs/modules/eips/pages/messaging-mapper.adoc | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/messaging-mapper.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/messaging-mapper.adoc
index 9319dc98dd4..fbc792c17dc 100644
--- a/core/camel-core-engine/src/main/docs/modules/eips/pages/messaging-mapper.adoc
+++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/messaging-mapper.adoc
@@ -9,15 +9,15 @@ How do you move data between domain objects and the messaging infrastructure whi
image::eip/MessagingMapperClassDiagram.gif[image]
Create a separate Messaging Mapper that contains the mapping logic between the messaging infrastructure and the domain objects.
-Neither the objects nor the infrastructure have knowledge of the Messaging Mapper's existence.
+Neither the objects nor the infrastructure has knowledge of the Messaging Mapper's existence.
The Messaging Mapper accesses one or more domain objects and converts them into a message as required by the messaging channel.
It also performs the opposite function, creating or updating domain objects based on incoming messages.
Since the Messaging Mapper is implemented as a separate class that references the domain object(s)
and the messaging layer, neither layer is aware of the other. The layers don't even know about the Messaging Mapper.
-With Camel this pattern is often implemented directly via Camel components that provides
-xref:manual::type-converter.adoc[Type Converter]'s from the messaging infrastructure to common Java types or
+With Camel, this pattern is often implemented directly via Camel components that provide
+xref:manual::type-converter.adoc[Type Converters] from the messaging infrastructure to common Java types or
Java Objects representing the data model of the component in question. Combining this with the
xref:message-translator.adoc[Message Translator] to have the Messaging Mapper EIP pattern.
(camel) 20/20: CAMEL-20459: minor documentation tweaks for the pipeline EIP.
Posted by or...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
orpiske pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
commit d9843654a8a41a86706985ada55ee20d287c5db0
Author: Otavio R. Piske <an...@gmail.com>
AuthorDate: Sun Feb 25 15:04:06 2024 +0100
CAMEL-20459: minor documentation tweaks for the pipeline EIP.
Signed-off-by: Otavio R. Piske <an...@gmail.com>
---
.../src/main/docs/modules/eips/pages/pipeline-eip.adoc | 18 ++++++++++--------
1 file changed, 10 insertions(+), 8 deletions(-)
diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/pipeline-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/pipeline-eip.adoc
index 2f3e078006d..30b0edcdb1f 100644
--- a/core/camel-core-engine/src/main/docs/modules/eips/pages/pipeline-eip.adoc
+++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/pipeline-eip.adoc
@@ -12,7 +12,7 @@ from the xref:enterprise-integration-patterns.adoc[EIP patterns] in various ways
image::eip/PipesAndFilters.gif[image]
With Camel, you can separate your processing across multiple independent
-xref:manual::endpoint.adoc[Endpoint]'s which can then be chained
+xref:manual::endpoint.adoc[Endpoints] which can then be chained
together.
== Options
@@ -61,7 +61,7 @@ XML::
----
====
-Though pipeline is the default mode of operation when you specify
+Though a pipeline is the default mode of operation when you specify
multiple outputs in Camel. Therefore, it's much more common to see this with Camel:
[tabs]
@@ -93,16 +93,18 @@ XML::
The opposite to `pipeline` is xref:multicast-eip.adoc[`multicast`].
A xref:multicast-eip.adoc[Multicast] EIP routes a copy of the same message into each of its outputs,
-where these messages are processed independently. Pipeline EIP however, will route the same message
-sequentially in the pipeline where the output from the previous step is input to the next. The same principle
+where these messages are processed independently.
+Pipeline EIP, however, will route the same message
+sequentially in the pipeline where the output from the previous step is input to the next.
+The same principle
from the Linux shell with chaining commands together with pipe (`|`).
-=== When using pipeline is necessary
+=== When using a pipeline is necessary
-Using pipeline becomes necessary when you need to group together a series of steps into a single logical step.
-For example in the example below where xref:multicast-eip.adoc[Multicast] EIP is in use, to process the same
+Using a pipeline becomes necessary when you need to group together a series of steps into a single logical step.
+For example, in the example below where xref:multicast-eip.adoc[Multicast] EIP is in use, to process the same
message in two different pipelines. The first pipeline calls the something bean, and the second pipeline
-calls the foo and bar beans and then route the message to another queue.
+calls the foo and bar beans and then routes the message to another queue.
[tabs]
====
(camel) 12/20: CAMEL-20459: minor documentation tweaks for the message history EIP.
Posted by or...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
orpiske pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
commit 1f2d2cae47a74275e588db18f38eece2b7932be4
Author: Otavio R. Piske <an...@gmail.com>
AuthorDate: Sun Feb 25 14:47:13 2024 +0100
CAMEL-20459: minor documentation tweaks for the message history EIP.
Signed-off-by: Otavio R. Piske <an...@gmail.com>
---
.../docs/modules/eips/pages/message-history.adoc | 92 +++++++++++++++++-----
1 file changed, 71 insertions(+), 21 deletions(-)
diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/message-history.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/message-history.adoc
index 445a875ecc7..db27953ad21 100644
--- a/core/camel-core-engine/src/main/docs/modules/eips/pages/message-history.adoc
+++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/message-history.adoc
@@ -8,7 +8,8 @@ The Message History from the EIP patterns allows for analyzing and debugging the
image::eip/MessageHistory.gif[image]
-Attaching a Message History to the message will provide a list of all applications that the message passed through since its origination.
+Attaching a Message History to the message will provide a list of all applications
+that the message has passed through since its origination.
== Enabling Message History
@@ -21,13 +22,18 @@ in a `java.util.concurrent.CopyOnWriteArrayList` due to the need of being thread
The Message History can be enabled or disabled per CamelContext or per route (disabled by default).
For example, you can turn it on with:
+[tabs]
+====
+
+Java::
++
[source,java]
----
camelContext.setMessageHistory(true);
----
-Or in XML
-
+XML::
++
[source,xml]
----
<camelContext messageHistory="true">
@@ -35,26 +41,37 @@ Or in XML
</camelContext>
----
+====
+
Or when using Spring Boot or Quarkus, you can enable this in the configuration file:
+[tabs]
+====
+
+Quarkus::
++
[source,properties]
----
-camel.springboot.message-history = true
+camel.quarkus.message-history = true
----
-And in Quarkus:
+Spring Boot::
++
[source,properties]
----
-camel.quarkus.message-history = true
+camel.springboot.message-history = true
----
+====
+
=== Route level Message History
You can also enable or disable message history per route.
-When doing this then Camel can only gather message history in the routes where this is enabled,
-which means you may not have full coverage. You may still want to do this, for example to capture
-the history in a critical route to help pin-point where the route is slow.
+When doing this, then Camel can only gather message history in the routes where this is enabled,
+which means you may not have full coverage.
+You may still want to do this, for example, to capture
+the history in a critical route to help pinpoint where the route is slow.
A route level configuration overrides the global configuration.
@@ -71,6 +88,11 @@ from("jms:cheese")
You can also turn off message history per route:
+[tabs]
+====
+
+Java::
++
[source,java]
----
from("jms:cheese")
@@ -80,8 +102,8 @@ from("jms:cheese")
.to("jms:wine");
----
-And in XML:
-
+XML::
++
[source,xml]
----
<route messageHistory="true">
@@ -92,6 +114,8 @@ And in XML:
</route>
----
+====
+
=== Enabling source location information
Camel is capable of gathering precise source file:line-number for each EIPs in the routes.
@@ -99,13 +123,19 @@ When enabled, then the message history will output this information in the route
To enable source location:
+[tabs]
+====
+
+Java::
++
+
[source,java]
----
camelContext.setSourceLocationEnabled(true);
----
-Or in XML
-
+XML::
++
[source,xml]
----
<camelContext sourceLocationEnabled="true">
@@ -113,20 +143,31 @@ Or in XML
</camelContext>
----
+====
+
Or when using Spring Boot or Quarkus, you can enable this in the configuration file:
+[tabs]
+====
+
+Quarkus::
++
[source,properties]
----
-camel.springboot.source-location-enabled = true
+camel.quarkus.source-location-enabled = true
----
-And in Quarkus:
+Spring Boot::
++
[source,properties]
----
-camel.quarkus.source-location-enabled = true
+camel.springboot.source-location-enabled = true
----
+====
+
+
== Route stack-trace in exceptions logged by error handler
If Message History is enabled, then Camel will include this information,
@@ -157,10 +198,10 @@ java.lang.IllegalArgumentException: The number is too low
at org.apache.camel.builder.RouteBuilder.configureRoutes(RouteBuilder.java:553) ~[camel-core-model-3.20.0.jar:3.20.0]
----
-When Message History is enabled then the full history is logged as shown above. Here we can see the full path
+When Message History is enabled, then the full history is logged as shown above. Here we can see the full path
the message has been routed.
-When Message History is disabled (by default) then the error handler logs a brief history with the last node
+When Message History is disabled, as it is by default, then the error handler logs a brief history with the last node
where the exception occurred as shown below:
[source,text]
@@ -186,7 +227,7 @@ java.lang.IllegalArgumentException: The number is too low
Here you can see the Message History only outputs the input (route1) and the last step
where the exception occurred (throwException1).
-Notice that the source column is empty, because source location is not enabled.
+Notice that the source column is empty because the source location is not enabled.
When enabled then, you can see exactly which source file and line number the message routed:
[source,text]
@@ -197,7 +238,7 @@ Message History
---------------------------------------------------------------------------------------------------------------------------------------
Source ID Processor Elapsed (ms)
MyJavaRouteBuilder:29 route1/route1 from[timer://java?period=2s] 10
-MyJavaRouteBuilder:32 route1/setBody1 setBody[bean[MyJavaRouteBuilder method:randomNumbe 1
+MyJavaRouteBuilder:32 route1/setBody1 setBody[bean[MyJavaRouteBuilder method:randomNumber 1
MyJavaRouteBuilder:33 route1/log1 log 1
MyJavaRouteBuilder:34 route1/filter1 filter[simple{${body} < 30}] 0
MyJavaRouteBuilder:35 route1/throwException1 throwException[java.lang.IllegalArgumentException] 0
@@ -227,14 +268,21 @@ The xref:manual::error-handler.adoc[Error Handler] does not log the
message body/header details (to avoid logging sensitive message body details).
You can enable this with `logExhaustedMessageBody` on the error handler as shown:
+[tabs]
+====
+
+Java::
++
[source,java]
----
errorHandler(defaultErrorHandler().logExhaustedMessageBody(true));
----
+XML::
++
In XML configuring this is a bit different, as you configure this in the `redeliveryPolicy`
of the `<errorHandler>` as shown:
-
++
[source,xml]
----
<camelContext messageHistory="true" errorHandlerRef="myErrorHandler" xmlns="http://camel.apache.org/schema/spring">
@@ -252,6 +300,8 @@ of the `<errorHandler>` as shown:
</camelContext>
----
+====
+
== MessageHistory API
When message history is enabled during routing Camel captures how the `Exchange` is routed,
(camel) 04/20: CAMEL-20459: documentation fixes for the marshal EIP.
Posted by or...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
orpiske pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
commit 77958d468c3cd2da03b9c437a27a2499d173ce77
Author: Otavio R. Piske <an...@gmail.com>
AuthorDate: Sun Feb 25 14:31:35 2024 +0100
CAMEL-20459: documentation fixes for the marshal EIP.
Signed-off-by: Otavio R. Piske <an...@gmail.com>
---
.../src/main/docs/modules/eips/pages/marshal-eip.adoc | 11 ++++++-----
1 file changed, 6 insertions(+), 5 deletions(-)
diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/marshal-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/marshal-eip.adoc
index 96207985c40..6a905e338e5 100644
--- a/core/camel-core-engine/src/main/docs/modules/eips/pages/marshal-eip.adoc
+++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/marshal-eip.adoc
@@ -8,13 +8,13 @@ image::eip/MessageTranslator.gif[image]
Camel has support for message transformation using several techniques.
One such technique is xref:components:dataformats:index.adoc[Data Formats],
-where marshal and unmarshal comes from.
+where marshal and unmarshal come from.
-So in other words the xref:marshal-eip.adoc[Marshal] and xref:unmarshal-eip.adoc[Unmarshal] EIPs
+So in other words, the xref:marshal-eip.adoc[Marshal] and xref:unmarshal-eip.adoc[Unmarshal] EIPs
are used with xref:dataformats:index.adoc[Data Formats].
-- _Marshal_ - Transforms the message body (such as Java object) into a binary or textual format, ready to be wired over the network.
-- _Unmarshal_ - Transforms data in some binary or textual format (such as received over the network)
+- `marshal`: transforms the message body (such as Java object) into a binary or textual format, ready to be wired over the network.
+- `unmarshal`: transforms data in some binary or textual format (such as received over the network)
into a Java object; or some other representation according to the data format being used.
== Example
@@ -24,7 +24,8 @@ Each file is then transformed into Java Objects using xref:dataformats:jaxb-data
Then a xref:ROOT:bean-component.adoc[Bean] is invoked that takes in the Java object.
Then the reverse operation happens to transform the Java objects back into XML also via JAXB,
-but using the `marshal` operation. And finally the message is routed to a xref:ROOT:jms-component.adoc[JMS] queue.
+but using the `marshal` operation.
+And finally, the message is routed to a xref:ROOT:jms-component.adoc[JMS] queue.
[tabs]
====
(camel) 11/20: CAMEL-20459: minor documentation tweaks for the from EIP.
Posted by or...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
orpiske pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
commit 0219a595be5f5421d2d190ba7448b893e5ffbd43
Author: Otavio R. Piske <an...@gmail.com>
AuthorDate: Sun Feb 25 14:40:29 2024 +0100
CAMEL-20459: minor documentation tweaks for the from EIP.
Signed-off-by: Otavio R. Piske <an...@gmail.com>
---
core/camel-core-engine/src/main/docs/modules/eips/pages/from-eip.adoc | 2 ++
1 file changed, 2 insertions(+)
diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/from-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/from-eip.adoc
index ac6a8709c09..08919b53387 100644
--- a/core/camel-core-engine/src/main/docs/modules/eips/pages/from-eip.adoc
+++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/from-eip.adoc
@@ -11,6 +11,8 @@ as the input (source) to the route.
The `from` EIP is the input.
+NOTE: the Java DSL also provides a `fromF` EIP, which can be used to avoid concatenating route parameters and making the code harder to read.
+
== Options
// eip options: START
(camel) 19/20: CAMEL-20459: minor documentation tweaks for the onFallback EIP.
Posted by or...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
orpiske pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
commit 3e1ffa93332473cf44ac61df02b9a8efbf895783
Author: Otavio R. Piske <an...@gmail.com>
AuthorDate: Sun Feb 25 15:02:32 2024 +0100
CAMEL-20459: minor documentation tweaks for the onFallback EIP.
Signed-off-by: Otavio R. Piske <an...@gmail.com>
---
.../src/main/docs/modules/eips/pages/onFallback-eip.adoc | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/onFallback-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/onFallback-eip.adoc
index 80f979c9fa7..f641a292097 100644
--- a/core/camel-core-engine/src/main/docs/modules/eips/pages/onFallback-eip.adoc
+++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/onFallback-eip.adoc
@@ -8,7 +8,7 @@
If you are using *onFallback* then that is intended to be local processing only where you can do a message transformation or call a bean or something as the fallback.
-If you need to call an external service over the network then you should use *onFallbackViaNetwork* that runs in another independent *HystrixCommand* that uses its own thread pool to not exhaust the first command.
+If you need to call an external service over the network, then you should use *onFallbackViaNetwork* that runs in another independent *HystrixCommand* that uses its own thread pool to not exhaust the first command.
== Options
@@ -25,7 +25,7 @@ include::partial$eip-exchangeProperties.adoc[]
== Using fallback
The *onFallback* is used by xref:circuitBreaker-eip.adoc[Circuit Breaker] EIPs to execute a fallback route.
-For examples how to use this see the various Circuit Breaker implementations:
+For example, how to use this see the various Circuit Breaker implementations:
- xref:fault-tolerance-eip.adoc[FaultTolerance EIP] - MicroProfile Fault Tolerance Circuit Breaker
- xref:resilience4j-eip.adoc[Resilience4j EIP] - Resilience4j Circuit Breaker
(camel) 08/20: CAMEL-20459: documentation fixes for the message dispatcher EIP.
Posted by or...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
orpiske pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
commit e71a70bbca5cddb17d76e4b27f261a2c0b622820
Author: Otavio R. Piske <an...@gmail.com>
AuthorDate: Sun Feb 25 14:36:32 2024 +0100
CAMEL-20459: documentation fixes for the message dispatcher EIP.
Signed-off-by: Otavio R. Piske <an...@gmail.com>
---
.../src/main/docs/modules/eips/pages/message-dispatcher.adoc | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/message-dispatcher.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/message-dispatcher.adoc
index a34c9b2ec16..000a32a3bdf 100644
--- a/core/camel-core-engine/src/main/docs/modules/eips/pages/message-dispatcher.adoc
+++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/message-dispatcher.adoc
@@ -6,11 +6,11 @@ from the xref:enterprise-integration-patterns.adoc[EIP patterns] book.
image::eip/MessageDispatcher.gif[image]
-In Camel the Message Dispatcher can be achieved in different ways such as:
+In Apache Camel, the Message Dispatcher can be achieved in different ways such as:
* You can use a component like xref:ROOT:jms-component.adoc[JMS] with selectors
to implement a xref:selective-consumer.adoc[Selective Consumer] as the Message Dispatcher implementation.
* Or you can use a xref:message-endpoint.adoc[Message Endpoint] as the Message Dispatcher itself, or
- combine this with the xref:choice-eip.adoc[Content Based Router] as the Message Dispatcher.
+ combine this with the xref:choice-eip.adoc[Content-Based Router] as the Message Dispatcher.
(camel) 10/20: CAMEL-20459: documentation fixes for the message expiration EIP.
Posted by or...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
orpiske pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
commit 6dfef1d76bee42eb69096573ec043d47d2212a82
Author: Otavio R. Piske <an...@gmail.com>
AuthorDate: Sun Feb 25 14:38:22 2024 +0100
CAMEL-20459: documentation fixes for the message expiration EIP.
Signed-off-by: Otavio R. Piske <an...@gmail.com>
---
.../src/main/docs/modules/eips/pages/message-expiration.adoc | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/message-expiration.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/message-expiration.adoc
index 89245a93ecb..bf084ea03f4 100644
--- a/core/camel-core-engine/src/main/docs/modules/eips/pages/message-expiration.adoc
+++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/message-expiration.adoc
@@ -14,7 +14,7 @@ Set the Message Expiration to specify a time limit how long the message is viabl
Message expiration is supported by some Camel components such as xref:ROOT:jms-component.adoc[JMS],
which uses _time-to-live_ to specify for how long the message is valid.
-IMPORTANT: When using message expiration then mind about keeping clock's synchronized among the systems.
+IMPORTANT: When using message expiration, then mind about keeping the systems clocks' synchronized among the systems.
== Example
(camel) 01/20: CAMEL-20459: minor documentation tweaks for the event message EIP.
Posted by or...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
orpiske pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
commit 5b5c44d4a0b1fa243769b437f12c6ec4c55ab751
Author: Otavio R. Piske <an...@gmail.com>
AuthorDate: Sun Feb 25 14:22:34 2024 +0100
CAMEL-20459: minor documentation tweaks for the event message EIP.
Signed-off-by: Otavio R. Piske <an...@gmail.com>
---
.../src/main/docs/modules/eips/pages/event-message.adoc | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/event-message.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/event-message.adoc
index 02a74f06437..9249bf2ca93 100644
--- a/core/camel-core-engine/src/main/docs/modules/eips/pages/event-message.adoc
+++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/event-message.adoc
@@ -63,7 +63,7 @@ XML::
----
====
-== Using setExchangePattern EIP
+== Using `setExchangePattern` EIP
You can specify the
xref:manual::exchange-pattern.adoc[Exchange Pattern] using `setExchangePattern` in the DSL.
(camel) 14/20: CAMEL-20459: minor documentation tweaks for the message translator EIP.
Posted by or...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
orpiske pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
commit dcdfe21ed99eb319f73c8cd5b381bfc5d2a864c1
Author: Otavio R. Piske <an...@gmail.com>
AuthorDate: Sun Feb 25 14:51:08 2024 +0100
CAMEL-20459: minor documentation tweaks for the message translator EIP.
Signed-off-by: Otavio R. Piske <an...@gmail.com>
---
.../src/main/docs/modules/eips/pages/message-translator.adoc | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/message-translator.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/message-translator.adoc
index f2871683b38..606f7be154a 100644
--- a/core/camel-core-engine/src/main/docs/modules/eips/pages/message-translator.adoc
+++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/message-translator.adoc
@@ -19,14 +19,14 @@ The Message Translator can be done in different ways in Camel:
== Example
-Each of above approaches is documented in the following examples:
+Each of the approaches above is documented in the following examples:
=== Message Translator with Transform EIP
You can use a xref:transform-eip.adoc[Transform] which uses an
xref:manual::expression.adoc[Expression] to do the transformation:
-In the example below we prepend Hello to the message body using the
+In the example below, we prepend Hello to the message body using the
xref:components:languages:simple-language.adoc[Simple] language:
[tabs]
@@ -56,7 +56,7 @@ XML::
=== Message Translator with Bean
-You can transform a message using Camels
+You can transform a message using Camel's
xref:manual::bean-integration.adoc[Bean Integration] to call any method on a bean
that performs the message translation:
@@ -114,7 +114,7 @@ XML::
=== Message Translator using Templating Components
You can also consume a message from one destination, transform it with something like
-xref:ROOT:velocity-component.adoc[Velocity] or xref:ROOT:xquery-component.adoc[XQuery] and then send
+xref:ROOT:velocity-component.adoc[Velocity] or xref:ROOT:xquery-component.adoc[XQuery], and then send
it on to another destination.
[tabs]
(camel) 09/20: CAMEL-20459: documentation fixes for the message endpoint EIP.
Posted by or...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
orpiske pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
commit 0a01c08d284545c13170bae34381fe0bb4b019b8
Author: Otavio R. Piske <an...@gmail.com>
AuthorDate: Sun Feb 25 14:37:03 2024 +0100
CAMEL-20459: documentation fixes for the message endpoint EIP.
Signed-off-by: Otavio R. Piske <an...@gmail.com>
---
.../src/main/docs/modules/eips/pages/message-endpoint.adoc | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/message-endpoint.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/message-endpoint.adoc
index b6121616f97..fbc92af86a4 100644
--- a/core/camel-core-engine/src/main/docs/modules/eips/pages/message-endpoint.adoc
+++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/message-endpoint.adoc
@@ -14,7 +14,7 @@ image::eip/MessageEndpointSolution.gif[image]
Connect an application to a messaging channel using a Message Endpoint, a client of the messaging system that the application can then use to send or receive messages.
-When using the xref:manual::dsl.adoc[DSL] to create xref:manual::routes.adoc[Routes] you
+When using the xref:manual::dsl.adoc[DSL] to create xref:manual::routes.adoc[Routes], you
typically refer to Message Endpoints by their xref:manual::uris.adoc[URIs]
rather than directly using the
https://www.javadoc.io/doc/org.apache.camel/camel-api/current/org/apache/camel/Endpoint.html[Endpoint]
(camel) 18/20: CAMEL-20459: minor documentation tweaks for the normalizer EIP.
Posted by or...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
orpiske pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
commit bc7ffb42b76d4098935e0fa8d04ab81be1a81de0
Author: Otavio R. Piske <an...@gmail.com>
AuthorDate: Sun Feb 25 15:01:45 2024 +0100
CAMEL-20459: minor documentation tweaks for the normalizer EIP.
Signed-off-by: Otavio R. Piske <an...@gmail.com>
---
.../main/docs/modules/eips/pages/normalizer.adoc | 62 ++++++++++++----------
1 file changed, 35 insertions(+), 27 deletions(-)
diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/normalizer.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/normalizer.adoc
index 57fc2ff37f5..26742f62688 100644
--- a/core/camel-core-engine/src/main/docs/modules/eips/pages/normalizer.adoc
+++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/normalizer.adoc
@@ -9,8 +9,8 @@ but arrive in different formats. The normalizer transforms the incoming messages
image::eip/NormalizerDetail.gif[image]
-In Apache Camel, you can implement the normalizer pattern by combining a xref:choice-eip.adoc[Content Based Router],
-which detects the incoming message's format, with a collection of different xref:message-translator.adoc[Message Translator]'s,
+In Apache Camel, you can implement the normalizer pattern by combining a xref:choice-eip.adoc[Content-Based Router],
+which detects the incoming message's format, with a collection of different xref:message-translator.adoc[Message Translators],
which transform the different incoming formats into a common format.
== Example
@@ -18,6 +18,11 @@ which transform the different incoming formats into a common format.
This example shows a Message Normalizer that converts two types of XML messages into a common format.
Messages in this common format are then routed.
+[tabs]
+====
+
+Java::
++
[source,java]
----
// we need to normalize two types of incoming messages
@@ -29,31 +34,9 @@ from("direct:start")
.to("mock:result");
----
-In this case we're using a Java xref:ROOT:bean-component.adoc[Bean] as the normalizer.
-
-The class looks like this:
-
-[source,java]
-----
-// Java
-public class MyNormalizer {
-
- public void employeeToPerson(Exchange exchange, @XPath("/employee/name/text()") String name) {
- exchange.getMessage().setBody(createPerson(name));
- }
-
- public void customerToPerson(Exchange exchange, @XPath("/customer/@name") String name) {
- exchange.getMessage().setBody(createPerson(name));
- }
-
- private String createPerson(String name) {
- return "<person name=\" + name + \"/>";
- }
-}
-----
-
-The same example in XML:
+XML::
++
[source,xml]
----
<camelContext xmlns="http://camel.apache.org/schema/spring">
@@ -76,7 +59,32 @@ The same example in XML:
<bean id="normalizer" class="org.apache.camel.processor.MyNormalizer"/>
----
+====
+
+In this case, we're using a Java xref:ROOT:bean-component.adoc[Bean] as the normalizer.
+
+The class looks like this:
+
+[source,java]
+----
+// Java
+public class MyNormalizer {
+
+ public void employeeToPerson(Exchange exchange, @XPath("/employee/name/text()") String name) {
+ exchange.getMessage().setBody(createPerson(name));
+ }
+
+ public void customerToPerson(Exchange exchange, @XPath("/customer/@name") String name) {
+ exchange.getMessage().setBody(createPerson(name));
+ }
+
+ private String createPerson(String name) {
+ return "<person name=\" + name + \"/>";
+ }
+}
+----
+
In case there are many incoming formats, then the xref:choice-eip.adoc[Content Based Router]
-may end up with too many choices. In this situation then an alternative is to use xref:toD-eip.adoc[Dynamic to]
+may end up with too many choices. In this situation, then an alternative is to use xref:toD-eip.adoc[Dynamic to]
that computes a xref:ROOT:bean-component.adoc[Bean] endpoint, to be called that acts as
xref:message-translator.adoc[Message Translator].
(camel) 06/20: CAMEL-20459: documentation fixes for the message broker EIP.
Posted by or...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
orpiske pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
commit 683a007327b7af6b3f8f635f7cd1dafc83c34464
Author: Otavio R. Piske <an...@gmail.com>
AuthorDate: Sun Feb 25 14:35:18 2024 +0100
CAMEL-20459: documentation fixes for the message broker EIP.
Signed-off-by: Otavio R. Piske <an...@gmail.com>
---
.../src/main/docs/modules/eips/pages/message-broker.adoc | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/message-broker.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/message-broker.adoc
index 87d3c05ed94..9833378fd27 100644
--- a/core/camel-core-engine/src/main/docs/modules/eips/pages/message-broker.adoc
+++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/message-broker.adoc
@@ -14,6 +14,6 @@ determine the correct destination and route the message to the correct channel.
Camel supports integration with existing message broker systems such as xref:ROOT:kafka-component.adoc[Kafka], xref:ROOT:spring-rabbitmq-component.adoc[RabbitMQ],
and cloud queue systems such as xref:ROOT:aws2-s3-component.adoc[AWS SQS], and others.
-These Camel components allows to both send and receive data from message brokers.
+These Camel components allow to both send and receive data from message brokers.
(camel) 07/20: CAMEL-20459: documentation fixes for the message bus EIP.
Posted by or...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
orpiske pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
commit db7cb04b8442c424b47bb3b2741dffe8b77be254
Author: Otavio R. Piske <an...@gmail.com>
AuthorDate: Sun Feb 25 14:35:49 2024 +0100
CAMEL-20459: documentation fixes for the message bus EIP.
Signed-off-by: Otavio R. Piske <an...@gmail.com>
---
.../src/main/docs/modules/eips/pages/message-bus.adoc | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/message-bus.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/message-bus.adoc
index 912fff631a1..ccbde62f77f 100644
--- a/core/camel-core-engine/src/main/docs/modules/eips/pages/message-bus.adoc
+++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/message-bus.adoc
@@ -9,12 +9,12 @@ consumers to be decoupled.
image::eip/MessageBusSolution.gif[image]
-A messaging system such as Apache ActiveMQ can be used as Message Bus.
+A messaging system such as Apache ActiveMQ can be used as a Message Bus.
== Example
The following demonstrates how the Camel message bus can be used to
-ingest message into the bus with the xref:ROOT:jms-component.adoc[JMS] component.
+ingest a message into the bus with the xref:ROOT:jms-component.adoc[JMS] component.
[tabs]
====
(camel) 17/20: CAMEL-20459: minor documentation tweaks for the multicast EIP.
Posted by or...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
orpiske pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
commit 440eed62d69a0d28915b6be2c36fbc4470959978
Author: Otavio R. Piske <an...@gmail.com>
AuthorDate: Sun Feb 25 14:59:18 2024 +0100
CAMEL-20459: minor documentation tweaks for the multicast EIP.
Signed-off-by: Otavio R. Piske <an...@gmail.com>
---
.../docs/modules/eips/pages/multicast-eip.adoc | 34 +++++++++++-----------
1 file changed, 17 insertions(+), 17 deletions(-)
diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/multicast-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/multicast-eip.adoc
index bad961b9949..e75cae1e6a5 100644
--- a/core/camel-core-engine/src/main/docs/modules/eips/pages/multicast-eip.adoc
+++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/multicast-eip.adoc
@@ -6,14 +6,14 @@
:supportlevel: Stable
:tabs-sync-option:
-The Multicast EIP allows to route *the same* message to a number of xref:manual::endpoint.adoc[endpoints]
+The Multicast EIP allows routing *the same* message to a number of xref:manual::endpoint.adoc[endpoints]
and process them in a different way.
image::eip/RecipientListIcon.gif[image]
-The Multicast EIP has many features and is also used as baseline for
+The Multicast EIP has many features and is also used as a baseline for
the xref:recipientList-eip.adoc[Recipient List] and xref:split-eip.adoc[Split] EIPs.
-For example the Multicast EIP is capable of aggregating each multicasted message into a single
+For example, the Multicast EIP is capable of aggregating each multicasted message into a single
_response_ message as the result after the Multicast EIP.
== Options
@@ -30,8 +30,8 @@ include::partial$eip-exchangeProperties.adoc[]
== Using Multicast
-The following example shows how to take a request from the direct:a
-endpoint, then multicast these request to direct:x, direct:y, and direct:z.
+The following example shows how to take a request from the `direct:a`
+endpoint, then multicast these requests to `direct:x`, `direct:y`, and `direct:z`.
[tabs]
====
@@ -61,9 +61,9 @@ XML::
----
====
-By default, Multicast EIP runs in single threaded mode, which mean
+By default, Multicast EIP runs in single threaded mode, which means
that the next multicasted message is processed only when the previous is finished.
-This means that direct:b must be done before Camel will call direct:c and so on.
+This means that `direct:b` must be done before Camel will call `direct:c` and so on.
=== Multicasting with parallel processing
@@ -111,8 +111,8 @@ thread that called the multicast, then make sure to enable the synchronous optio
You may want to continue routing the exchange after the Multicast EIP.
-In the example above then sending to mock:result happens after the Multicast EIP has finished.
-In other words direct:y, direct:y, and direct:z should be completed first, before the message
+In the example below, then sending to `mock:result` happens after the Multicast EIP has finished.
+In other words, `direct:x`, `direct:y`, and `direct:z` should be completed first, before the message
continues.
[tabs]
@@ -195,7 +195,7 @@ We can refer to the FQN class name with `#class:` syntax as shown below:
The Multicast, Recipient List, and Splitter EIPs have special support for using `AggregationStrategy` with
access to the original input exchange. You may want to use this when you aggregate messages and
there has been a failure in one of the messages, which you then want to enrich on the original
-input message and return as response; it's the aggregate method with 3 exchange parameters.
+input message and return as response; it's the aggregate method with three exchange parameters.
====
=== Stop processing in case of exception
@@ -204,12 +204,12 @@ The Multicast EIP will by default continue to process
the entire exchange even in case one of the
multicasted messages will throw an exception during routing.
-For example if you want to multicast to 3 destinations and the 2nd
+For example, if you want to multicast to three destinations and the second
destination fails by an exception. What Camel does by default is to
process the remainder destinations. You have the chance to deal with the exception
when aggregating using an `AggregationStrategy`.
-But sometimes you just want Camel to stop and let the exception be
+But sometimes you want Camel to stop and let the exception be
propagated back, and let the Camel xref:manual::error-handler.adoc[Error Handler]
handle it. You can do this by specifying that it should stop in case of an
exception occurred. This is done by the `stopOnException` option as
@@ -269,7 +269,7 @@ XML::
====
In the example above, then `MyProcessor` is causing a failure and throws an exception.
-This means the Multicast EIP will stop after this, and not the last route (direct:baz).
+This means the Multicast EIP will stop after this, and not the last route (`direct:baz`).
=== Preparing the message by deep copying before multicasting
@@ -277,16 +277,16 @@ The multicast EIP will copy the source
exchange and multicast each copy. However, the copy
is a shallow copy, so in case you have mutable message bodies, then
any changes will be visible by the other copied messages. If you want to
-use a deep clone copy then you need to use a custom `onPrepare` which
+use a deep clone copy, then you need to use a custom `onPrepare` which
allows you to create a deep copy of the message body in the `Processor`.
-Notice the `onPrepare` can be used for any kind of custom logic which
+Notice the `onPrepare` can be used for any kind of custom logic that
you would like to execute before the xref:manual::exchange.adoc[Exchange] is
being multicasted.
== See Also
-Because Multicast EIP is baseline for
+Because Multicast EIP is a baseline for
the xref:recipientList-eip.adoc[Recipient List] and xref:split-eip.adoc[Split] EIPs,
-then you can find more information in those EIPs about features that is also available
+then you can find more information in those EIPs about features that are also available
with Multicast EIP.
(camel) 02/20: CAMEL-20459: minor documentation tweaks for the dead letter channel EIP.
Posted by or...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
orpiske pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
commit 42e966705c963b3b1d3ee38662be84110554105a
Author: Otavio R. Piske <an...@gmail.com>
AuthorDate: Sun Feb 25 14:27:19 2024 +0100
CAMEL-20459: minor documentation tweaks for the dead letter channel EIP.
Signed-off-by: Otavio R. Piske <an...@gmail.com>
---
.../modules/eips/pages/dead-letter-channel.adoc | 54 +++++++++++++++++++---
1 file changed, 47 insertions(+), 7 deletions(-)
diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/dead-letter-channel.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/dead-letter-channel.adoc
index 90c33144433..3bcf96669cb 100644
--- a/core/camel-core-engine/src/main/docs/modules/eips/pages/dead-letter-channel.adoc
+++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/dead-letter-channel.adoc
@@ -144,14 +144,18 @@ The exchange is then complete, and from the client point of view, the message is
For instance, configuring the dead letter channel as:
+[tabs]
+====
+Java::
++
[source,java]
----
errorHandler(deadLetterChannel("jms:queue:dead")
.maximumRedeliveries(3).redeliveryDelay(5000));
----
-And in XML:
-
+XML::
++
[source,xml]
----
<errorHandler id="myErrorHandler" type="DeadLetterChannel"
@@ -160,6 +164,8 @@ And in XML:
</errorHandler>
----
+====
+
The Dead Letter error handler will clear the caused exception (`setException(null)`), by moving the caused exception to a property on the xref:manual::exchange.adoc[Exchange], with the key `Exchange.EXCEPTION_CAUGHT`.
Then the xref:manual::exchange.adoc[Exchange]
is moved to the `jms:queue:dead` destination, and the client will not notice the failure.
@@ -194,6 +200,11 @@ There is also a *useOriginalBody* option, which only keeps the original message
not change the message headers.
====
+[tabs]
+====
+Java::
++
+
[source,java]
----
// will use the original message (body and headers)
@@ -201,8 +212,10 @@ errorHandler(deadLetterChannel("jms:queue:dead")
.useOriginalMessage().maximumRedeliveries(5).redeliveryDelay(5000);
----
+XML::
++
And in XML, you set `useOriginalMessage=true` on the `<errorHandler>` as shown:
-
++
[source,xml]
----
<errorHandler id="myErrorHandler" type="DeadLetterChannel" useOriginalMessage="true"
@@ -211,6 +224,8 @@ And in XML, you set `useOriginalMessage=true` on the `<errorHandler>` as shown:
</errorHandler>
----
+====
+
Then the messages routed to the `jms:queue:dead` is the original input.
If we want to manually retry, we can move the JMS message from the failed to the input queue, with no problem as the message is the same as the original we received.
@@ -230,7 +245,12 @@ When the Dead Letter Channel is doing redelivery, it's possible to configure a x
executed just _before_ every redelivery attempt.
This can be used for situations where you need to alter the message before it's redelivered.
-For example, in Java DSL you can do:
+For example, you can do:
+
+[tabs]
+====
+Java::
++
[source,java]
----
@@ -239,8 +259,10 @@ errorHandler(deadLetterChannel("jms:queue:dead")
.onRedeliver(new MyOnRedeliveryProcessor());
----
+XML::
++
And in XML DSL, you specify a bean id via `onRedeliveryRef` on the `<errorHandler>` as shown:
-
++
[source,xml]
----
<bean id="myRedeliveryProcessor" class="com.foo.MyRedeliveryProcessor"/>
@@ -251,6 +273,8 @@ And in XML DSL, you specify a bean id via `onRedeliveryRef` on the `<errorHandle
</errorHandler>
----
+====
+
TIP: Camel also supports xref:manual::exception-clause.adoc[onException] to use `onRedeliver`.
This means you can do special on redelivery for different exceptions, as opposed to `onRedelivery` set on
Dead Letter Channel (or xref:manual::defaulterrorhandler.adoc[Default Error Handler]) can be viewed as global scoped.
@@ -275,13 +299,20 @@ public static class MyPrepareProcessor implements Processor {
Then configure the error handler to use the processor as follows:
+[tabs]
+====
+Java::
++
+
[source,java]
----
errorHandler(deadLetterChannel("jms:dead").onPrepareFailure(new MyPrepareProcessor()));
----
+XML::
++
Configuring this from Spring XML is done with the `onPrepareFailureRef` to refer to the processor as a `<bean>` as shown:
-
++
[source,xml]
----
<bean id="myPrepare"
@@ -290,6 +321,8 @@ Configuring this from Spring XML is done with the `onPrepareFailureRef` to refer
<errorHandler id="dlc" type="DeadLetterChannel" deadLetterUri="jms:dead" onPrepareFailureRef="myPrepare"/>
----
+====
+
=== Calling a processor when an exception occurred
With the `onExceptionOccurred` you can call a custom processor right after an exception was thrown,
@@ -313,19 +346,26 @@ public static class OnErrorLogger implements Processor {
You can then configure the Dead Letter Channel to use this as shown:
+[tabs]
+====
+Java::
++
[source,java]
----
errorHandler(deadLetterChannel("jms:dead").onExceptionOccurred(new OnErrorLogger()));
----
+XML::
++
Configuring this from Spring XML is done with the `onExceptionOccurredRef` to refer to the processor as a `<bean>` as shown:
-
++
[source,xml]
----
<bean id="myErrorLogger" class="com.foo.OnErrorLogger"/>
<errorHandler id="dlc" type="DeadLetterChannel" deadLetterUri="jms:dead" onExceptionOccurredRef="myErrorLogger"/>
----
+====
=== Redeliver Delay Pattern
(camel) 05/20: CAMEL-20459: documentation fixes for the message EIP.
Posted by or...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
orpiske pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
commit f18511884ef9412271905d5a2021e7d6cf58f9e4
Author: Otavio R. Piske <an...@gmail.com>
AuthorDate: Sun Feb 25 14:34:51 2024 +0100
CAMEL-20459: documentation fixes for the message EIP.
Signed-off-by: Otavio R. Piske <an...@gmail.com>
---
.../src/main/docs/modules/eips/pages/message.adoc | 15 ++++++++-------
1 file changed, 8 insertions(+), 7 deletions(-)
diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/message.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/message.adoc
index 3fbecb787fb..8ce190220c4 100644
--- a/core/camel-core-engine/src/main/docs/modules/eips/pages/message.adoc
+++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/message.adoc
@@ -13,13 +13,14 @@ of the xref:manual::exchange.adoc[Exchange].
The message contains the following information:
-- _body_ - the message body (i.e. payload)
-- _headers_ - headers with additional information
-- _messageId_ - Unique id of the message.
+- `_body_`: the message body (i.e., payload)
+- `_headers_`: headers with additional information
+- `_messageId_`: Unique id of the message.
By default, the message uses the same id as `Exchange.getExchangeId` as messages are associated with the
- `Exchange` and using different IDs does not offer much value. Another reason is to optimize for performance to avoid generating new IDs.
+ `Exchange` and using different IDs offers little value.
+Another reason is to optimize for performance to avoid generating new IDs.
A few Camel components do provide their own message IDs such as the JMS components.
-- _timestamp_ - The timestamp the message originates from.
- Some systems like JMS, Kafka, AWS have a timestamp on the event/message, that Camel received.
- This method returns the timestamp, if a timestamp exists.
+- `_timestamp_`: the timestamp the message originates from.
+Some systems like JMS, Kafka, AWS have a timestamp on the event/message that Camel receives.
+This method returns the timestamp if a timestamp exists.
(camel) 03/20: CAMEL-20459: documentation fixes for the loop EIP.
Posted by or...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
orpiske pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
commit 3878d31b14127d1a897159ac7dc8777d53f1752b
Author: Otavio R. Piske <an...@gmail.com>
AuthorDate: Sun Feb 25 14:29:12 2024 +0100
CAMEL-20459: documentation fixes for the loop EIP.
Signed-off-by: Otavio R. Piske <an...@gmail.com>
---
.../src/main/docs/modules/eips/pages/loop-eip.adoc | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/loop-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/loop-eip.adoc
index 24eba63a394..5253775b343 100644
--- a/core/camel-core-engine/src/main/docs/modules/eips/pages/loop-eip.adoc
+++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/loop-eip.adoc
@@ -109,7 +109,7 @@ from("direct:c")
== Using copy mode
Now suppose we send a message to direct:start endpoint containing the letter A.
-The output of processing this route will be that, each mock:loop endpoint will receive AB as message.
+The output of processing this route will be that, each mock:loop endpoint will receive AB as the message.
[tabs]
====
@@ -146,13 +146,13 @@ XML::
----
====
-However, if we do *not* enable copy mode then mock:loop will receive "AB", "ABB", "ABBB", etc. messages.
+However, if we do *not* enable copy mode, then mock:loop will receive `_"AB"_`, `_"ABB"_`, `_"ABBB"_`, etc. messages.
== Looping using while
The loop can act like a while loop that loops until the expression evaluates to `false` or `null`.
-For example the route below loops while the length of the message body is 5 or fewer characters.
+For example, the route below loops while the length of the message body is five or fewer characters.
Notice that the DSL uses `loopDoWhile`.
[tabs]
(camel) 15/20: CAMEL-20459: minor documentation tweaks for the messaging gateway EIP.
Posted by or...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
orpiske pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
commit dfe894ae18a118aed8fde483a53f8c78e88f0023
Author: Otavio R. Piske <an...@gmail.com>
AuthorDate: Sun Feb 25 14:53:01 2024 +0100
CAMEL-20459: minor documentation tweaks for the messaging gateway EIP.
Signed-off-by: Otavio R. Piske <an...@gmail.com>
---
.../src/main/docs/modules/eips/pages/messaging-gateway.adoc | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/messaging-gateway.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/messaging-gateway.adoc
index c19316acb8e..19e42219584 100644
--- a/core/camel-core-engine/src/main/docs/modules/eips/pages/messaging-gateway.adoc
+++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/messaging-gateway.adoc
@@ -8,10 +8,10 @@ How do you encapsulate access to the messaging system from the rest of the appli
image::eip/MessagingGatewaySolution.gif[image]
-Use a Messaging Gateway, a class than wraps messaging-specific method calls and exposes domain-specific methods to the application.
+Use a Messaging Gateway, a class that wraps messaging-specific method calls and exposes domain-specific methods to the application.
Camel has several endpoint components that support the Messaging Gateway from the EIP patterns.
-Components like xref:ROOT:bean-component.adoc[Bean] provides a way to bind a Java interface to the message exchange.
+Components like xref:ROOT:bean-component.adoc[Bean] provide a way to bind a Java interface to the message exchange.
Another approach is to use `@Produce` annotations (xref:manual::pojo-producing.adoc[POJO Producing])
which also can be used to hide Camel APIs and thereby encapsulate access, acting as a Messaging Gateway EIP solution.