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/26 11:08:40 UTC
(camel) branch main updated (41ce5b4fb2f -> 189431e894e)
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 41ce5b4fb2f CAMEL-20453 - Azure CosmosDB CloudEvent transformer (#13298)
new 3b3fff0804f CAMEL-20459: minor documentation tweaks for the point-to-point channel EIP.
new 05c92bb0057 CAMEL-20459: minor documentation tweaks and fixes for the log EIP.
new d0d01ba634d CAMEL-20459: documentation fixes for the poll enricher EIP.
new 15a57062e47 CAMEL-20459: documentation fixes for the polling consumer EIP.
new aabbd79c66a CAMEL-20459: documentation fixes for the processor EIP.
new 311fda39016 CAMEL-20459: documentation fixes for the process manager EIP.
new 189431e894e CAMEL-20459: documentation fixes for the publish-subscribe channel EIP.
The 7 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:
.../src/main/docs/modules/eips/pages/log-eip.adoc | 4 +--
.../modules/eips/pages/point-to-point-channel.adoc | 4 +--
.../docs/modules/eips/pages/pollEnrich-eip.adoc | 34 ++++++++++++----------
.../docs/modules/eips/pages/polling-consumer.adoc | 10 +++----
.../main/docs/modules/eips/pages/process-eip.adoc | 22 ++++++++++----
.../docs/modules/eips/pages/process-manager.adoc | 6 ++--
.../eips/pages/publish-subscribe-channel.adoc | 6 ++--
7 files changed, 49 insertions(+), 37 deletions(-)
(camel) 07/07: CAMEL-20459: documentation fixes for the publish-subscribe 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 189431e894eafe7e1672b4067030f4193e9405ad
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Mon Feb 26 11:11:15 2024 +0100
CAMEL-20459: documentation fixes for the publish-subscribe channel EIP.
---
.../src/main/docs/modules/eips/pages/publish-subscribe-channel.adoc | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/publish-subscribe-channel.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/publish-subscribe-channel.adoc
index b52482f4559..074a1c9e561 100644
--- a/core/camel-core-engine/src/main/docs/modules/eips/pages/publish-subscribe-channel.adoc
+++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/publish-subscribe-channel.adoc
@@ -2,7 +2,7 @@
:tabs-sync-option:
Camel supports the
-http://www.enterpriseintegrationpatterns.com/PublishSubscribeChannel.html[Publish Subscribe Channel]
+http://www.enterpriseintegrationpatterns.com/PublishSubscribeChannel.html[Publish-Subscribe Channel]
from the xref:enterprise-integration-patterns.adoc[EIP patterns].
How can the sender broadcast an event to all interested receivers?
@@ -18,13 +18,13 @@ The Publish-Subscribe Channel is supported in Camel by messaging based xref:ROOT
* xref:ROOT:seda-component.adoc[SEDA] for internal Camel seda queue based messaging
* xref:ROOT:spring-rabbitmq-component.adoc[Spring RabbitMQ] for working with AMQP Queues (RabbitMQ)
-There are also messaging based in the cloud from cloud providers such as Amazon, Google and Azure.
+There is also messaging based in the cloud from cloud providers such as Amazon, Google and Azure.
TIP: See also the related xref:point-to-point-channel.adoc[Point to Point Channel] EIP
== Example
-The following example demonstrates publish sbuscriber messaging using
+The following example demonstrates publish subscriber messaging using
the xref:ROOT:jms-component.adoc[JMS] component with JMS topics:
[tabs]
(camel) 06/07: CAMEL-20459: documentation fixes for the process manager 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 311fda390163a43bddcf5eef3d8e8ffdc94e9488
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Mon Feb 26 11:10:28 2024 +0100
CAMEL-20459: documentation fixes for the process manager EIP.
---
.../src/main/docs/modules/eips/pages/process-manager.adoc | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/process-manager.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/process-manager.adoc
index 60a06d0a3e5..b22a96d640b 100644
--- a/core/camel-core-engine/src/main/docs/modules/eips/pages/process-manager.adoc
+++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/process-manager.adoc
@@ -12,13 +12,13 @@ image::eip/ProcessManager.gif[image]
Use a central processing unit, a Process Manager, to maintain the state of the sequence and determine
the next processing step based on intermediate results.
-With Camel this pattern is implemented by using the xref:dynamicRouter-eip.adoc[Dynamic Router] EIP.
+With Camel, this pattern is implemented by using the xref:dynamicRouter-eip.adoc[Dynamic Router] EIP.
Camel's implementation of the dynamic router maintains the state of the sequence, and allows
to determine the next processing step based dynamically.
-== Routing Slip vs Dynamic Router
+== Routing Slip vs. Dynamic Router
-On the other hand the xref:routingSlip-eip.adoc[Routing Slip] EIP demonstrates how a message can be routed
+On the other hand, the xref:routingSlip-eip.adoc[Routing Slip] EIP demonstrates how a message can be routed
through a dynamic series of processing steps. The solution of the Routing Slip is based on two key assumptions:
- the sequence of processing steps has to be determined up-front
(camel) 05/07: CAMEL-20459: documentation fixes for the processor 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 aabbd79c66ac304894a00e7aa641fb76af688d6e
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Mon Feb 26 11:09:10 2024 +0100
CAMEL-20459: documentation fixes for the processor EIP.
---
.../main/docs/modules/eips/pages/process-eip.adoc | 22 ++++++++++++++++------
1 file changed, 16 insertions(+), 6 deletions(-)
diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/process-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/process-eip.adoc
index 2819852dff4..e0aed468a11 100644
--- a/core/camel-core-engine/src/main/docs/modules/eips/pages/process-eip.adoc
+++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/process-eip.adoc
@@ -21,7 +21,7 @@ image::eip/message_flow_in_route.png[image]
A route first starts with a consumer (think `from` in the DSL) that populates the initial
exchange. At each processor step, the out message from the previous step is the in
message of the next. In many cases, processors don’t set an out message, so in this case
-the in message is reused. At the end of a route, the xref:manual::exchange-pattern.adoc[Messageg Exchange Pattern] (MEP)
+the in message is reused. At the end of a route, the xref:manual::exchange-pattern.adoc[Message Exchange Pattern] (MEP)
of the exchange determines whether a reply needs to be sent back to the caller of the route. If the MEP is `InOnly`,
no reply will be sent back. If it’s `InOut`, Camel will take the out message from the last
step and return it.
@@ -29,7 +29,7 @@ step and return it.
== Processor API
The `Processor` interface is a central API in Camel.
-Its API is purposely designed to be both simple and flexible in the form of a single functional method:
+Its API is purposely designed to be both straightforward and flexible in the form of a single functional method:
[source,java]
----
@@ -73,14 +73,21 @@ from("activemq:myQueue")
You can also call a processor by its bean id, if the processor
has been enlisted in the xref:manual::registry.adoc[Registry], such as with the id `myProcessor`:
+[tabs]
+====
+
+Java::
++
[source,java]
----
from("activemq:myQueue")
.process("myProcessor");
----
+XML::
++
And in XML you can refer to the fully qualified class name via `#class:` syntax:
-
++
[source,xml]
----
<route>
@@ -89,8 +96,10 @@ And in XML you can refer to the fully qualified class name via `#class:` syntax:
</route>
----
+Spring XML::
++
Or if you use Spring XML you can create the processor via `<bean>`:
-
++
[source,xml]
----
<beans>
@@ -108,8 +117,9 @@ Or if you use Spring XML you can create the processor via `<bean>`:
</beans>
----
+====
-=== Why use process when you can use to instead?
+=== Why use `process` when you can use `to` instead?
The process can be used in routes as an anonymous inner class such:
@@ -125,5 +135,5 @@ The process can be used in routes as an anonymous inner class such:
----
This is usable for quickly whirling up some code. If the code in the
-inner class gets a bit more complicated it is of course advised to
+inner class gets a bit more complicated, it is advised to
refactor it into a separate class.
(camel) 03/07: CAMEL-20459: documentation fixes for the poll enricher 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 d0d01ba634d6a71b43f30ec9261419bb72c6fe77
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Mon Feb 26 10:59:28 2024 +0100
CAMEL-20459: documentation fixes for the poll enricher EIP.
---
.../docs/modules/eips/pages/pollEnrich-eip.adoc | 34 ++++++++++++----------
1 file changed, 18 insertions(+), 16 deletions(-)
diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/pollEnrich-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/pollEnrich-eip.adoc
index 6648d93e415..a0a13bce497 100644
--- a/core/camel-core-engine/src/main/docs/modules/eips/pages/pollEnrich-eip.adoc
+++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/pollEnrich-eip.adoc
@@ -23,13 +23,13 @@ In Camel the Content Enricher can be done in several ways:
The most natural Camel approach is using xref:enrich-eip.adoc[Enrich] EIP,
which comes as two kinds:
-* xref:enrich-eip.adoc[Enrich] EIP - This is the most common content enricher that uses a `Producer` to obtain the data.
-It is usually used for xref:requestReply-eip.adoc[Request Reply] messaging, for instance to invoke an external web service.
+* xref:enrich-eip.adoc[Enrich] EIP: This is the most common content enricher that uses a `Producer` to obtain the data.
+It is usually used for xref:requestReply-eip.adoc[Request Reply] messaging, for instance, to invoke an external web service.
-* xref:pollEnrich-eip.adoc[Poll Enrich] EIP - Uses a xref:polling-consumer.adoc[Polling
+* xref:pollEnrich-eip.adoc[Poll Enrich] EIP: Uses a xref:polling-consumer.adoc[Polling
Consumer] to obtain the additional data. It is usually used for
-xref:event-message.adoc[Event Message] messaging, for instance to read a
-file or download a xref:ROOT:ftp-component.adoc[FTP] file.
+xref:event-message.adoc[Event Message] messaging, for instance, to read a
+file or download a file using xref:ROOT:ftp-component.adoc[FTP].
NOTE: This page documents the Poll Enrich EIP.
@@ -48,21 +48,23 @@ include::partial$eip-exchangeProperties.adoc[]
== Content enrichment using Poll Enrich EIP
`pollEnrich` uses a xref:polling-consumer.adoc[Polling Consumer] to obtain the additional data.
-It is usually used for xref:event-message.adoc[Event Message] messaging, for instance to read a file or download a FTP file.
+It is usually used for xref:event-message.adoc[Event Message] messaging,
+for instance, to read a file or download a file using FTP.
The `pollEnrich` works just the same as `enrich`,
-however as it uses a xref:polling-consumer.adoc[Polling Consumer] we have three methods when polling:
+however, as it uses a xref:polling-consumer.adoc[Polling Consumer], we have three methods when polling:
-* `receive` - Waits until a message is available and then returns it. *Warning* that this method could block indefinitely if no messages are available.
-* `receiveNoWait` - Attempts to receive a message exchange immediately without waiting and returning `null` if a message exchange is not available yet.
-* `receive(timeout)` - Attempts to receive a message exchange, waiting up to the given timeout to expire if a message is not yet available. Returns the message or `null` if the timeout expired.
+* `receive`: Waits until a message is available and then returns it. *Warning* that this method could block indefinitely if no messages are available.
+* `receiveNoWait`: Attempts to receive a message exchange immediately without waiting and returning `null` if a message exchange is not available yet.
+* `receive(timeout)`: Attempts to receive a message exchange, waiting up to the given timeout to expire if a message is not yet available. Returns the message or `null` if the timeout expired.
=== Poll Enrich with timeout
It is good practice to use timeout value.
By default, Camel will use the `receive` which may block until there is a message available.
-It is therefore recommended to always provide a timeout value, to make this clear that we may wait for a message, until the timeout is hit.
+It is therefore recommended to always provide a timeout value,
+to make this clear that we may wait for a message until the timeout is hit.
You can pass in a timeout value that determines which method to use:
@@ -70,7 +72,7 @@ You can pass in a timeout value that determines which method to use:
* if timeout is `0` then `receiveNoWait` is selected
* otherwise, `receive(timeout)` is selected
-The timeout values is in millis.
+The timeout values are in milliseconds.
=== Using Poll Enrich
@@ -112,7 +114,7 @@ from("direct:start")
.to("mock:result");
----
-In the example Camel will poll a file (timeout 10 seconds).
+In the example, Camel will poll a file (timeout 10 seconds).
The `AggregationStrategy` is then used to merge the file with the existing `Exchange`.
In XML DSL you use `pollEnrich` as follows:
@@ -134,8 +136,8 @@ In XML DSL you use `pollEnrich` as follows:
=== Using Poll Enrich with Rest DSL
-You can also use `pollEnrich` with xref:manual::rest-dsl.adoc[Rest DSL] to
-for example download a file from xref:ROOT:aws2-s3-component.adoc[AWS S3] as the response of an API call.
+You can also use `pollEnrich` with xref:manual::rest-dsl.adoc[Rest DSL] to,
+for example, download a file from xref:ROOT:aws2-s3-component.adoc[AWS S3] as the response of an API call.
[source,xml]
----
@@ -151,7 +153,7 @@ for example download a file from xref:ROOT:aws2-s3-component.adoc[AWS S3] as the
</rest>
----
-Notice that the enriched endpoint is a constant, however Camel also supports dynamic endpoints which is covered next.
+Notice that the enriched endpoint is a constant, however, Camel also supports dynamic endpoints which is covered next.
=== Poll Enrich with Dynamic Endpoints
(camel) 02/07: CAMEL-20459: minor documentation tweaks and fixes for the log 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 05c92bb0057b94735018ab1a011a91a2fb2567ed
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Mon Feb 26 10:53:03 2024 +0100
CAMEL-20459: minor documentation tweaks and fixes for the log EIP.
- Fix rendering two of the tables
---
core/camel-core-engine/src/main/docs/modules/eips/pages/log-eip.adoc | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/log-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/log-eip.adoc
index 31c4fdba159..02329ab5235 100644
--- a/core/camel-core-engine/src/main/docs/modules/eips/pages/log-eip.adoc
+++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/log-eip.adoc
@@ -164,7 +164,7 @@ from("direct:start").routeId("fooRoute")
----
XML::
-
++
[source,xml]
----
<route id="fooRoute">
@@ -207,7 +207,7 @@ camelContext.getGlobalOptions().put(Exchange.LOG_EIP_NAME, "com.foo.myapp");
----
XML::
-
++
[source,xml]
----
<camelContext>
(camel) 01/07: CAMEL-20459: minor documentation tweaks for the point-to-point 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 3b3fff0804f04079f8a6bf87ee9445e41bee2d27
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Mon Feb 26 10:50:50 2024 +0100
CAMEL-20459: minor documentation tweaks for the point-to-point channel EIP.
---
.../src/main/docs/modules/eips/pages/point-to-point-channel.adoc | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/point-to-point-channel.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/point-to-point-channel.adoc
index c2c1aa0a53e..75f1b378f7b 100644
--- a/core/camel-core-engine/src/main/docs/modules/eips/pages/point-to-point-channel.adoc
+++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/point-to-point-channel.adoc
@@ -5,7 +5,7 @@ Camel supports the
http://www.enterpriseintegrationpatterns.com/PointToPointChannel.html[Point
to Point Channel] from the xref:enterprise-integration-patterns.adoc[EIP patterns].
-An application is using Messaging to make remote procedure calls (RPC’s) or transfer documents.
+An application is using Messaging to make remote procedure calls (RPC) or transfer documents.
How can the caller be sure that exactly one receiver will receive the document or perform the call?
@@ -20,7 +20,7 @@ The Point to Point Channel is supported in Camel by messaging based xref:ROOT:in
* xref:ROOT:seda-component.adoc[SEDA] for internal Camel seda queue based messaging
* xref:ROOT:spring-rabbitmq-component.adoc[Spring RabbitMQ] for working with AMQP Queues (RabbitMQ)
-There are also messaging based in the cloud from cloud providers such as Amazon, Google and Azure.
+There is also messaging based in the cloud from cloud providers such as Amazon, Google and Azure.
TIP: See also the related xref:publish-subscribe-channel.adoc[Publish Scribe Channel] EIP
(camel) 04/07: CAMEL-20459: documentation fixes for the polling consumer 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 15a57062e477674f188bad9d4b834296a200818e
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Mon Feb 26 11:04:47 2024 +0100
CAMEL-20459: documentation fixes for the polling consumer EIP.
---
.../src/main/docs/modules/eips/pages/polling-consumer.adoc | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/polling-consumer.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/polling-consumer.adoc
index 180a6f6aa58..d06b4717559 100644
--- a/core/camel-core-engine/src/main/docs/modules/eips/pages/polling-consumer.adoc
+++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/polling-consumer.adoc
@@ -31,10 +31,10 @@ method.
If you need to use Polling Consumer from within a route, then the xref:pollEnrich-eip.adoc[Poll Enrich] EIP can be used.
-On the other hand if you need to use Polling Consumer programmatically,
+On the other hand, if you need to use Polling Consumer programmatically,
then using xref:manual::consumertemplate.adoc[ConsumerTemplate] is a good choice.
-And if you want to use the lower level Camel APIs then you can create the `PollingConsumer` instance to be used.
+And if you want to use the lower level Camel APIs, then you can create the `PollingConsumer` instance to be used.
=== Using Polling Consumer from Java
@@ -69,8 +69,8 @@ https://github.com/apache/camel/blob/main/core/camel-api/src/main/java/org/apach
In Camel there are two kinds of `PollingConsumer` implementations:
-- _Custom_ - Some components have their own custom implementation of `PollingConsumer` which is optimized for the given component.
-- _Default_ - `EventDrivenPollingConsumer` is the default implementation otherwise.
+- _Custom_: Some components have their own custom implementation of `PollingConsumer` which is optimized for the given component.
+- _Default_: `EventDrivenPollingConsumer` is the default implementation otherwise.
The `EventDrivenPollingConsumer` supports the following options:
@@ -78,7 +78,7 @@ The `EventDrivenPollingConsumer` supports the following options:
[width="100%",cols="34%,33%,33%",options="header",]
|=======================================================================
|Option |Default |Description
-|`pollingConsumerQueueSize` |`1000` | The queue size for the internal hand-off queue between the polling consumer,
+|`pollingConsumerQueueSize` |`1000` | The queue size for the internal hand-off queue between the polling consumer
and producers sending data into the queue.
|`pollingConsumerBlockWhenFull` |`true` | Whether to block any producer if the internal queue is full.