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/19 15:49:53 UTC
(camel) branch main updated (8b5a1923925 -> a55c79bb059)
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 8b5a1923925 CAMEL-20410: documentation fixes for camel-seda
new bea198e4488 CAMEL-20410: documentation fixes for camel-debug
new 128b3a039a9 CAMEL-20410: documentation fixes for camel-digitalocean
new b17950eac1e CAMEL-20410: documentation fixes for camel-direct
new de0fab2100e CAMEL-20410: documentation fixes for camel-disruptor
new 4a997b40cfb CAMEL-20410: documentation fixes for camel-djl
new 001876768d3 CAMEL-20410: documentation fixes for camel-dns
new 7309e326d45 CAMEL-20410: documentation fixes for camel-docker
new 14e1081292c CAMEL-20410: documentation fixes for camel-drill
new bc9c933f49e CAMEL-20410: documentation fixes for camel-dropbox
new a55c79bb059 CAMEL-20410: documentation fixes for camel-dynamic-router
The 10 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:
components/camel-debug/src/main/docs/debug.adoc | 12 ++--
.../src/main/docs/digitalocean-component.adoc | 23 ++++----
.../src/main/docs/direct-component.adoc | 24 ++++----
.../src/main/docs/disruptor-component.adoc | 64 +++++++++++-----------
.../src/main/docs/disruptor-vm-component.adoc | 39 ++++++-------
.../camel-djl/src/main/docs/djl-component.adoc | 13 ++---
.../camel-dns/src/main/docs/dns-component.adoc | 20 +++----
.../src/main/docs/docker-component.adoc | 11 ++--
.../camel-drill/src/main/docs/drill-component.adoc | 5 +-
.../src/main/docs/dropbox-component.adoc | 30 +++++-----
.../src/main/docs/dynamic-router-component.adoc | 24 ++++----
.../docs/dynamic-router-control-component.adoc | 4 +-
12 files changed, 140 insertions(+), 129 deletions(-)
(camel) 10/10: CAMEL-20410: documentation fixes for camel-dynamic-router
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 a55c79bb05912e557c9041705b2693054e88c5f1
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Mon Feb 19 13:21:52 2024 +0100
CAMEL-20410: documentation fixes for camel-dynamic-router
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
---
.../src/main/docs/dynamic-router-component.adoc | 24 +++++++++++++---------
.../docs/dynamic-router-control-component.adoc | 4 ++--
2 files changed, 16 insertions(+), 12 deletions(-)
diff --git a/components/camel-dynamic-router/src/main/docs/dynamic-router-component.adoc b/components/camel-dynamic-router/src/main/docs/dynamic-router-component.adoc
index 3139a804257..26e5bf074ca 100644
--- a/components/camel-dynamic-router/src/main/docs/dynamic-router-component.adoc
+++ b/components/camel-dynamic-router/src/main/docs/dynamic-router-component.adoc
@@ -34,7 +34,7 @@ sent to.
_Dynamic Rule Base_:: The Dynamic Router should have a list of routing recipients' criteria that define the terms under
which an exchange is suitable for them to receive.
* *core*: implements a dynamic version of a `Routing Slip` for this purpose, but that is not inherently dynamic in
-terms of its content. If the content of this slip will be dynamic, it will be up to the user to define and implement
+terms of its content. If the content of this slip is dynamic, it will be up to the user to define and implement
that capability.
* *component*: builds the rule base at runtime, and maintains it as participants subscribe or unsubscribe via the
control channel.
@@ -93,20 +93,23 @@ implementation group: 'org.apache.camel', name: 'camel-dynamic-router', version:
// use the same version as your Camel core version
----
-The Dynamic Router component is used in the same way that other components are used. Simply include the dynamic-router
+The Dynamic Router component is used in the same way that other components are used. Include the dynamic-router
URI as a consumer in a route, along with the channel name.
-In Java:
+[tabs]
+====
+Java::
++
.Example Java DSL Route Definition
[source,java]
----
-// Send message to the Dynamic Router channel named "orders"
+// Send a message to the Dynamic Router channel named "orders"
from("direct:start").to("dynamic-router:orders");
----
-And the same route using XML DSL:
-
+Spring XML::
++
.Example XML Route Definition
[source,xml]
----
@@ -115,6 +118,7 @@ And the same route using XML DSL:
<to uri="dynamic-router:nameOfYourChannel"/>
</route>
----
+====
== Dynamic Router EIP Component Use Cases
@@ -131,7 +135,7 @@ If we have a simple point-of-sale application, we might have services that:
2. Adjust inventory counts
3. Process returns
-For the purpose of this example, the exact steps that each service carries out is not as important as the fact that
+For the purpose of this example, the exact steps that each service carries out are not as important as the fact that
each service needs to be notified that it needs to do something under the right condition(s). So, each service will
subscribe to participate in routing:
@@ -195,10 +199,10 @@ from("direct:start")
Note the `.process(myOrderProcessor)` step. If incoming messages need to be validated, enriched, transformed, or
otherwise augmented, that can be done before the Dynamic Router receives the message. Then, when the Dynamic Router
-receives a message, it checks the `Exchange` against all subscriptions for the "orders" channel to determine if it is
+receives a message, it checks the `Exchange` against all subscriptions for the _orders_ channel to determine if it is
suitable for any of the recipients. Orders should have a header (`command` -> `processOrder`), so the message will be
-routed to the orders service, and the inventory service. The system will process the order details, and then the
-inventory service will deduct from merchandise counts. Likewise, returns should have a header
+routed to the _orders_ service, and the inventory service. The system will process the order details, and then the
+inventory service will deduct from merchandize counts. Likewise, returns should have a header
(`command` -> `processReturn`), so the message will be routed to the returns service, where the return details will be
processed, and the inventory service will increase the relevant merchandise counts.
diff --git a/components/camel-dynamic-router/src/main/docs/dynamic-router-control-component.adoc b/components/camel-dynamic-router/src/main/docs/dynamic-router-control-component.adoc
index c15af172275..d84087e4cf9 100644
--- a/components/camel-dynamic-router/src/main/docs/dynamic-router-control-component.adoc
+++ b/components/camel-dynamic-router/src/main/docs/dynamic-router-control-component.adoc
@@ -152,8 +152,8 @@ producerTemplate.sendBody("dynamic-router-control:unsubscribe", controlMessage);
To determine if an exchange is suitable for any of the participants, all predicates for the participants that are
subscribed to the channel are evaluated until the first result of "true" is found, by default. If the Dynamic Router
is configured with the `recipientMode` set to `allMatch`, then all recipients with matching predicates will be
-selected. The exchange will be routed to the corresponding endpoint(s). The rule base contains a default filter that
-is registered at the least priority (which is the highest integer number). Like the "default" case of a switch
+selected. The exchange will be routed to the corresponding endpoint(s). The rule base contains a default filter
+registered at the least priority (which is the highest integer number). Like the "default" case of a switch
statement in Java, any message that is not appropriate for any registered participants will be processed by this
filter. The filter logs information about the dropped message at *debug* level, by default. To turn the level up to
*warn*, include `warnDroppedMessage=true` in the component URI.
(camel) 09/10: CAMEL-20410: documentation fixes for camel-dropbox
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 bc9c933f49e313564472ea072b7649338de7c921
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Mon Feb 19 13:15:19 2024 +0100
CAMEL-20410: documentation fixes for camel-dropbox
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
---
.../src/main/docs/dropbox-component.adoc | 30 +++++++++++-----------
1 file changed, 15 insertions(+), 15 deletions(-)
diff --git a/components/camel-dropbox/src/main/docs/dropbox-component.adoc b/components/camel-dropbox/src/main/docs/dropbox-component.adoc
index 8f0db7d406f..af0452629df 100644
--- a/components/camel-dropbox/src/main/docs/dropbox-component.adoc
+++ b/components/camel-dropbox/src/main/docs/dropbox-component.adoc
@@ -25,7 +25,7 @@ component has the following features:
* As a producer, download files, move files between remote directories,
delete files/dir, upload files and search files by queries
-In order to work with Dropbox API you need to obtain an *accessToken*,
+To work with Dropbox API, you need to obtain an *accessToken*,
*expireIn*, *refreshToken*, *apiKey*, *apiSecret* and a *clientIdentifier.* +
You can refer to the
https://dropbox.tech/developers/migrating-app-permissions-and-access-tokens[Dropbox
@@ -70,7 +70,7 @@ perform on Dropbox remote folder.
|`search` |search files on Dropbox based on string queries
|===
-*Operations* require additional options to work, some are mandatory for
+*Operations* require additional options to work. Some are mandatory for
the specific operation.
@@ -95,7 +95,7 @@ include::partial$component-endpoint-headers.adoc[]
Delete files on Dropbox.
-Works only as Camel producer.
+Works only as a Camel producer.
Below are listed the options for this operation:
@@ -136,7 +136,7 @@ The following objects are set on message body result:
Download files from Dropbox.
-Works as Camel producer or Camel consumer.
+Works as a Camel producer or Camel consumer.
Below are listed the options for this operation:
@@ -174,9 +174,9 @@ The following objects are set on message body result:
|===
|Object type |Description
-|`byte[]` or `CachedOutputStream` if stream caching is enabled |in case of single file download, stream representing the file downloaded
+|`byte[]` or `CachedOutputStream` if stream caching is enabled |in case of single file download, stream represents the file downloaded
-|`Map<String, byte[]>` or `Map<String, CachedOutputStream>` if stream caching is enabled |in case of multiple files download, a map with as key the path of the
+|`Map<String, byte[]>` or `Map<String, CachedOutputStream>` if stream caching is enabled |in the case of multiple files downloaded, a map with as a key the path of the
remote file downloaded and as value the stream representing the file
downloaded
|===
@@ -185,7 +185,7 @@ downloaded
Move files on Dropbox between one folder to another.
-Works only as Camel producer.
+Works only as a Camel producer.
Below are listed the options for this operation:
@@ -223,7 +223,7 @@ The following objects are set on message body result:
Upload files on Dropbox.
-Works as Camel producer.
+Works as a Camel producer.
Below are listed the options for this operation:
@@ -232,13 +232,13 @@ Below are listed the options for this operation:
|Property |Mandatory |Description
|`uploadMode` |`true` |add or force this option specifies how a file should be saved on
-dropbox: in case of "add" the new file will be renamed if a file with the same
-name already exists on dropbox. In case of "force" if a file with the same name already exists on
+dropbox: in the case of `add`, the new file will be renamed if a file with the same
+name already exists on dropbox. In the case of `force`, if a file with the same name already exists on
dropbox, this will be overwritten.
|`localPath` |`false` |Folder or file to upload on Dropbox from the local filesystem.
-If this option has been configured then it takes precedence over uploading as a single
-file with content from the Camel message body (message body is converted into a byte array).
+If this option has been configured, then it takes precedence over uploading as a single
+file with content from the Camel message body (the message body is converted into a byte array).
|`remotePath` |`false` |Folder destination on Dropbox. If the property is not set, the component
will upload the file on a remote path equal to the local path. With Windows or without an absolute
@@ -288,14 +288,14 @@ The following objects are set on message body result:
|`String` |in case of single file upload, result of the upload operation, OK or KO
-|`Map<String, DropboxResultCode>` |in case of multiple files upload, a map with as key the path of the
+|`Map<String, DropboxResultCode>` |in the case of multiple files upload, a map with as a key the path of the
remote file uploaded and as value the result of the upload operation, OK
or KO
|===
== Search operation
-Search inside a remote Dropbox folder including its sub directories.
+Search inside a remote Dropbox folder including its subdirectories.
Works as Camel producer and as Camel consumer.
@@ -336,7 +336,7 @@ The following objects are set on message body result:
|===
|Object type |Description
-|`List<com.dropbox.core.v2.files.SearchMatchV2>` |list of file path founded. For more information on this object refer to
+|`List<com.dropbox.core.v2.files.SearchMatchV2>` |list of the file path found. For more information on this object, refer to
https://javadoc.io/doc/com.dropbox.core/dropbox-core-sdk/latest/com/dropbox/core/v2/files/SearchMatchV2.html[Dropbox documentation].
|===
(camel) 06/10: CAMEL-20410: documentation fixes for camel-dns
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 001876768d328ce2386c842bd65850bf065cd514
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Mon Feb 19 13:09:07 2024 +0100
CAMEL-20410: documentation fixes for camel-dns
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
---
.../camel-dns/src/main/docs/dns-component.adoc | 20 ++++++++++----------
1 file changed, 10 insertions(+), 10 deletions(-)
diff --git a/components/camel-dns/src/main/docs/dns-component.adoc b/components/camel-dns/src/main/docs/dns-component.adoc
index 90e850c13cf..4be3372f6e5 100644
--- a/components/camel-dns/src/main/docs/dns-component.adoc
+++ b/components/camel-dns/src/main/docs/dns-component.adoc
@@ -19,9 +19,9 @@ DNSJava. The component is a thin layer on top of
http://www.xbill.org/dnsjava/[DNSJava].
The component offers the following operations:
-* ip, to resolve a domain by its ip
-* lookup, to lookup information about the domain
-* dig, to run DNS queries
+* `ip`: to resolve a domain by its ip
+* `lookup`: to lookup information about the domain
+* `dig`: to run DNS queries
[NOTE]
====
@@ -85,10 +85,10 @@ include::partial$component-endpoint-headers.adoc[]
</route>
----
-This looks up a domain's IP. For example, www.example.com resolves to
-192.0.32.10. +
- The IP address to lookup must be provided in the header with key
-`"dns.domain"`.
+This looks up a domain's IP. For example, _www.example.com_ resolves to
+192.0.32.10.
+
+The IP address to lookup must be provided in the header with key `"dns.domain"`.
=== DNS lookup
@@ -121,11 +121,11 @@ The query must be provided in the header with key `"dns.query"`.
== Dns Activation Policy
-DnsActivationPolicy can be used to dynamically start and stop routes based on dns state.
+The `DnsActivationPolicy` can be used to dynamically start and stop routes based on dns state.
-If you have instances of the same component running in different regions you can configure a route in each region to activate only if dns is pointing to its region.
+If you have instances of the same component running in different regions, you can configure a route in each region to activate only if dns is pointing to its region.
-i.e. You may have an instance in NYC and an instance in SFO. You would configure a service CNAME service.example.com to point to nyc-service.example.com to bring NYC instance up and SFO instance down. When you change the CNAME service.example.com to point to sfo-service.example.com -- nyc instance would stop its routes and sfo will bring its routes up. This allows you to switch regions without restarting actual components.
+For example, you may have an instance in NYC and an instance in SFO. You would configure a service CNAME service.example.com to point to nyc-service.example.com to bring NYC instance up and SFO instance down. When you change the CNAME service.example.com to point to sfo-service.example.com -- nyc instance would stop its routes and sfo will bring its routes up. This allows you to switch regions without restarting actual components.
[source,xml]
----
(camel) 05/10: CAMEL-20410: documentation fixes for camel-djl
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 4a997b40cfbd634621668e6f185f401098787ac5
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Mon Feb 19 13:07:02 2024 +0100
CAMEL-20410: documentation fixes for camel-djl
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
---
components/camel-djl/src/main/docs/djl-component.adoc | 13 +++++--------
1 file changed, 5 insertions(+), 8 deletions(-)
diff --git a/components/camel-djl/src/main/docs/djl-component.adoc b/components/camel-djl/src/main/docs/djl-component.adoc
index 380780bee66..d00fbbaaaac 100644
--- a/components/camel-djl/src/main/docs/djl-component.adoc
+++ b/components/camel-djl/src/main/docs/djl-component.adoc
@@ -14,13 +14,10 @@
*{component-header}*
-The *Deep Java Library* component is used to infer Deep Learning models from message exchanges data.
-This component uses https://djl.ai/[Deep Java Library] as underlying library.
+The *Deep Java Library* component is used to infer deep learning models from message exchanges data.
+This component uses the https://djl.ai/[Deep Java Library] as the underlying library.
-In order to use the DJL component, Maven users will need to add the
-following dependency to their `pom.xml`:
-
-*pom.xml*
+To use the DJL component, Maven users will need to add the following dependency to their `pom.xml`:
[source,xml]
----
@@ -80,7 +77,7 @@ The following table contains supported models in the model zoo:
== DJL Engine implementation
-Because DJL is deep learning framework agnostic, you don't have to make a choice between frameworks when creating your projects.
+Because DJL is deep learning framework-agnostic, you don't have to make a choice between frameworks when creating your projects.
You can switch frameworks at any point.
To ensure the best performance, DJL also provides automatic CPU/GPU choice based on hardware configuration.
@@ -193,7 +190,7 @@ from("file:/data/mnist/0/10.png")
=== Custom deep learning model
[source,java]
----
-// create deep learning model
+// create a deep learning model
Model model = Model.newInstance();
model.setBlock(new Mlp(28 * 28, 10, new int[]{128, 64}));
model.load(Paths.get(MODEL_DIR), MODEL_NAME);
(camel) 02/10: CAMEL-20410: documentation fixes for camel-digitalocean
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 128b3a039a91c096a0f1d0a52875ddf1ab6513a2
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Mon Feb 19 12:44:13 2024 +0100
CAMEL-20410: documentation fixes for camel-digitalocean
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
---
.../src/main/docs/digitalocean-component.adoc | 23 +++++++++++-----------
1 file changed, 12 insertions(+), 11 deletions(-)
diff --git a/components/camel-digitalocean/src/main/docs/digitalocean-component.adoc b/components/camel-digitalocean/src/main/docs/digitalocean-component.adoc
index 4b048630eee..ad23fb431ce 100644
--- a/components/camel-digitalocean/src/main/docs/digitalocean-component.adoc
+++ b/components/camel-digitalocean/src/main/docs/digitalocean-component.adoc
@@ -14,7 +14,7 @@
*{component-header}*
-The DigitalOcean component allows you to manage Droplets and resources within the DigitalOcean cloud with **Camel** by encapsulating https://www.digitalocean.com/community/projects/api-client-in-java[digitalocean-api-java]. All of the functionality that you are familiar with in the DigitalOcean control panel is also available through this Camel component.
+The DigitalOcean component allows you to manage Droplets and resources within the DigitalOcean cloud with **Camel** by encapsulating https://www.digitalocean.com/community/projects/api-client-in-java[digitalocean-api-java]. All the functionality that you are familiar with in the DigitalOcean control panel is also available through this Camel component.
== Prerequisites
@@ -62,7 +62,8 @@ All message bodies returned are using objects provided by the **digitalocean-api
== API Rate Limits
-DigitalOcean REST API encapsulated by camel-digitalocean component is subjected to API Rate Limiting. You can find the per method limits in the https://developers.digitalocean.com/documentation/v2/#rate-limit[API Rate Limits documentation].
+DigitalOcean REST API encapsulated by camel-digitalocean component is subjected to API Rate Limiting.
+ou can find the per-method limits in the https://developers.digitalocean.com/documentation/v2/#rate-limit[API Rate Limits documentation].
== Account endpoint
@@ -79,7 +80,7 @@ DigitalOcean REST API encapsulated by camel-digitalocean component is subjected
|===
| operation | Description | Headers | Result
| `list`
-| list all of the Block Storage volumes available on your account
+| list all the Block Storage volumes available on your account
|
| `List<com.myjeeva.digitalocean.pojo.Volume>`
@@ -272,9 +273,9 @@ DigitalOcean REST API encapsulated by camel-digitalocean component is subjected
| operation | Description | Headers | Result
| `list` | list images available on your account | `CamelDigitalOceanType`* _DigitalOceanImageTypes_ | `List<com.myjeeva.digitalocean.pojo.Image>`
| `ownList` | retrieve only the private images of a user | | `List<com.myjeeva.digitalocean.pojo.Image>`
-| `listActions` | retrieve all actions that have been executed on a Image | `CamelDigitalOceanId` _Integer_ | `List<com.myjeeva.digitalocean.pojo.Action>`
+| `listActions` | retrieve all actions that have been executed on an Image | `CamelDigitalOceanId` _Integer_ | `List<com.myjeeva.digitalocean.pojo.Action>`
| `get` | retrieve information about an image (public or private) by id| `CamelDigitalOceanId` _Integer_| `com.myjeeva.digitalocean.pojo.Image`
-| `get` | retrieve information about an public image by slug| `CamelDigitalOceanDropletImage` _String_| `com.myjeeva.digitalocean.pojo.Image`
+| `get` | retrieve information about a public image by slug| `CamelDigitalOceanDropletImage` _String_| `com.myjeeva.digitalocean.pojo.Image`
| `update`
| update an image
@@ -298,7 +299,7 @@ DigitalOcean REST API encapsulated by camel-digitalocean component is subjected
[width="100%",cols="2,5,^1,2",options="header"]
|===
| operation | Description | Headers | Result
-| `list` | list all of the snapshots available on your account | `CamelDigitalOceanType`* _DigitalOceanSnapshotTypes_ | `List<com.myjeeva.digitalocean.pojo.Snapshot>`
+| `list` | list all the snapshots available on your account | `CamelDigitalOceanType`* _DigitalOceanSnapshotTypes_ | `List<com.myjeeva.digitalocean.pojo.Snapshot>`
| `get` | retrieve information about a snapshot| `CamelDigitalOceanId` _Integer_| `com.myjeeva.digitalocean.pojo.Snapshot`
| `delete` | delete an snapshot| `CamelDigitalOceanId` _Integer_ | `com.myjeeva.digitalocean.pojo.Delete`
|===
@@ -308,7 +309,7 @@ DigitalOcean REST API encapsulated by camel-digitalocean component is subjected
[width="100%",cols="2,5,^1,2",options="header"]
|===
| operation | Description | Headers | Result
-| `list` | list all of the keys in your account | | `List<com.myjeeva.digitalocean.pojo.Key>`
+| `list` | list all the keys in your account | | `List<com.myjeeva.digitalocean.pojo.Key>`
| `get` | retrieve information about a key by id| `CamelDigitalOceanId` _Integer_| `com.myjeeva.digitalocean.pojo.Key`
| `get` | retrieve information about a key by fingerprint| `CamelDigitalOceanKeyFingerprint` _String_| `com.myjeeva.digitalocean.pojo.Key`
@@ -333,7 +334,7 @@ DigitalOcean REST API encapsulated by camel-digitalocean component is subjected
[width="100%",cols="2,5,^1,2",options="header"]
|===
| operation | Description | Headers | Result
-| `list` | list all of the regions that are available | | `List<com.myjeeva.digitalocean.pojo.Region>`
+| `list` | list all the regions that are available | | `List<com.myjeeva.digitalocean.pojo.Region>`
|===
== Sizes endpoint
@@ -341,7 +342,7 @@ DigitalOcean REST API encapsulated by camel-digitalocean component is subjected
[width="100%",cols="2,5,^1,2",options="header"]
|===
| operation | Description | Headers | Result
-| `list` | list all of the sizes that are available | | `List<com.myjeeva.digitalocean.pojo.Size>`
+| `list` | list all the sizes that are available | | `List<com.myjeeva.digitalocean.pojo.Size>`
|===
== Floating IPs endpoint
@@ -349,7 +350,7 @@ DigitalOcean REST API encapsulated by camel-digitalocean component is subjected
[width="100%",cols="2,5,^1,2",options="header"]
|===
| operation | Description | Headers | Result
-| `list` | list all of the Floating IPs available on your account | | `List<com.myjeeva.digitalocean.pojo.FloatingIP>`
+| `list` | list all the Floating IPs available on your account | | `List<com.myjeeva.digitalocean.pojo.FloatingIP>`
| `create` | create a new Floating IP assigned to a Droplet | `CamelDigitalOceanId` _Integer_ | `List<com.myjeeva.digitalocean.pojo.FloatingIP>`
| `create` | create a new Floating IP assigned to a Region | `CamelDigitalOceanRegion` _String_ | `List<com.myjeeva.digitalocean.pojo.FloatingIP>`
| `get` | retrieve information about a Floating IP| `CamelDigitalOceanFloatingIPAddress` _String_| `com.myjeeva.digitalocean.pojo.Key`
@@ -361,7 +362,7 @@ DigitalOcean REST API encapsulated by camel-digitalocean component is subjected
`CamelDigitalOceanDropletId` _Integer_
| `com.myjeeva.digitalocean.pojo.Action`
-| `unassign` | unassign a Floating IP | `CamelDigitalOceanFloatingIPAddress` _String_ | `com.myjeeva.digitalocean.pojo.Action`
+| `unassign` | un-assign a Floating IP | `CamelDigitalOceanFloatingIPAddress` _String_ | `com.myjeeva.digitalocean.pojo.Action`
| `listActions` | retrieve all actions that have been executed on a Floating IP | `CamelDigitalOceanFloatingIPAddress` _String_ | `List<com.myjeeva.digitalocean.pojo.Action>`
|===
(camel) 03/10: CAMEL-20410: documentation fixes for camel-direct
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 b17950eac1ecaab556fb2310d1bf7118a2322402
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Mon Feb 19 12:47:38 2024 +0100
CAMEL-20410: documentation fixes for camel-direct
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
---
.../src/main/docs/direct-component.adoc | 24 +++++++++++++---------
1 file changed, 14 insertions(+), 10 deletions(-)
diff --git a/components/camel-direct/src/main/docs/direct-component.adoc b/components/camel-direct/src/main/docs/direct-component.adoc
index 48ff1bff66c..a922401a77a 100644
--- a/components/camel-direct/src/main/docs/direct-component.adoc
+++ b/components/camel-direct/src/main/docs/direct-component.adoc
@@ -16,8 +16,8 @@
*{component-header}*
The Direct component provides direct, synchronous invocation of any
-consumers when a producer sends a message exchange. +
- This endpoint can be used to connect existing routes in the *same*
+consumers when a producer sends a message exchange.
+This endpoint can be used to connect existing routes in the *same*
camel context.
[TIP]
@@ -32,10 +32,10 @@ any consumers when a producer sends a message exchange.
[source]
----
-direct:someName[?options]
+direct:someId[?options]
----
-Where *someName* can be any string to uniquely identify the endpoint
+Where _someId_ can be any string to uniquely identify the endpoint.
// component-configure options: START
@@ -54,9 +54,12 @@ include::partial$component-endpoint-options.adoc[]
== Samples
-In the route below we use the direct component to link the two routes
-together:
+In the route below, we use the direct component to link the two routes together:
+[tabs]
+====
+Java::
++
[source,java]
----
from("activemq:queue:order.in")
@@ -68,8 +71,8 @@ from("direct:processOrder")
.to("activemq:queue:order.out");
----
-And the sample using spring DSL:
-
+Spring XML::
++
[source,xml]
----
<route>
@@ -85,8 +88,9 @@ And the sample using spring DSL:
</route>
----
-See also samples from the xref:seda-component.adoc[SEDA] component, how they can
-be used together.
+====
+
+See also samples from the xref:seda-component.adoc[SEDA] component, how they can be used together.
(camel) 04/10: CAMEL-20410: documentation fixes for camel-disruptor
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 de0fab2100eb00f5aa655fd3f27e2d37f9134f46
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Mon Feb 19 13:04:54 2024 +0100
CAMEL-20410: documentation fixes for camel-disruptor
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
---
.../src/main/docs/disruptor-component.adoc | 64 +++++++++++-----------
.../src/main/docs/disruptor-vm-component.adoc | 39 ++++++-------
2 files changed, 53 insertions(+), 50 deletions(-)
diff --git a/components/camel-disruptor/src/main/docs/disruptor-component.adoc b/components/camel-disruptor/src/main/docs/disruptor-component.adoc
index 76e6898a0eb..2d80873d689 100644
--- a/components/camel-disruptor/src/main/docs/disruptor-component.adoc
+++ b/components/camel-disruptor/src/main/docs/disruptor-component.adoc
@@ -15,38 +15,39 @@
*{component-header}*
The Disruptor component provides asynchronous
-https://en.wikipedia.org/wiki/Staged_event-driven_architecture[SEDA] behavior much as the
-standard SEDA component, but utilizes a
-https://github.com/LMAX-Exchange/disruptor[Disruptor] instead of a
+https://en.wikipedia.org/wiki/Staged_event-driven_architecture[SEDA] behavior similarly to the
+standard SEDA component.
+However, it uses a https://github.com/LMAX-Exchange/disruptor[Disruptor] instead of a
http://docs.oracle.com/javase/1.5.0/docs/api/java/util/concurrent/BlockingQueue.html[BlockingQueue]
-utilized by the standard xref:seda-component.adoc[SEDA]. Alternatively, a *disruptor-vm:* endpoint is supported by this component.
+used by the standard xref:seda-component.adoc[SEDA].
+Alternatively, this component supports a xref:disruptor-vm-component.adoc[disruptor-vm] endpoint.
The main advantage of choosing to use the Disruptor component over the
SEDA is performance in use cases where there is high
contention between producer(s) and/or multicasted or concurrent
-Consumers. In those cases, significant increases of throughput and
+Consumers. In those cases, significant increases in throughput and
reduction of latency has been observed. Performance in scenarios without
contention is comparable to the SEDA component.
-The Disruptor is implemented with the intention of mimicing the
-behaviour and options of the SEDA component as much as possible.
-The main differences with the them are the following:
+The Disruptor is implemented with the intention of mimicking the
+behavior and options of the SEDA component as much as possible.
+The main differences between them are the following:
* The buffer used is always bounded in size (default 1024 exchanges).
-* As a the buffer is always bouded, the default behaviour for the
+* As the buffer is always bounded, the default behavior for the
Disruptor is to block while the buffer is full instead of throwing an
-exception. This default behaviour may be configured on the component
+exception. This default behavior may be configured on the component
(see options).
-* The Disruptor enpoints don't implement the BrowsableEndpoint
+* The Disruptor endpoints don't implement the `BrowsableEndpoint`
interface. As such, the exchanges currently in the Disruptor can't be
-retrieved, only the amount of exchanges.
+retrieved, only the number of exchanges.
* The Disruptor requires its consumers (multicasted or otherwise) to be
statically configured. Adding or removing consumers on the fly requires
complete flushing of all pending exchanges in the Disruptor.
* As a result of the reconfiguration: Data sent over a Disruptor is
directly processed and 'gone' if there is at least one consumer, late
joiners only get new exchanges published after they've joined.
-* The *pollTimeout* option is not supported by the Disruptor component.
+* The `pollTimeout` option is not supported by the Disruptor component.
* When a producer blocks on a full Disruptor, it does not respond to
thread interrupts.
@@ -66,10 +67,10 @@ for this component:
== URI format
-----------------------------
- disruptor:someName[?options]
+ disruptor:someId[?options]
-----------------------------
-Where **someName** can be any string that uniquely identifies the
+Where _someId_ can be any string that uniquely identifies the
endpoint within the current CamelContext.
== Options
@@ -100,20 +101,20 @@ published. The following strategies can be chosen:
|Name |Description |Advice
|Blocking | Blocking strategy that uses a lock and condition variable for Consumers
-waiting on a barrier. | This strategy can be used when throughput and low-latency are not as
+waiting on a barrier. | This strategy can be used when throughput and low latency are not as
important as CPU resource.
-|Sleeping |Sleeping strategy that initially spins, then uses a Thread.yield(), and
+|Sleeping |Sleeping strategy that initially spins then uses a `Thread.yield()`, and
eventually for the minimum number of nanos the OS and JVM will allow
while the Consumers are waiting on a barrier. |This strategy is a good compromise between performance and CPU resource.
Latency spikes can occur after quiet periods.
|BusySpin |Busy Spin strategy that uses a busy spin loop for Consumers waiting on a
-barrier. |This strategy will use CPU resource to avoid syscalls which can
+barrier. |This strategy will use CPU resource to avoid _syscalls_ which can
introduce latency jitter. It is best used when threads can be bound to
specific CPU cores.
-|Yielding |Yielding strategy that uses a Thread.yield() for Consumers waiting on a
+|Yielding |Yielding strategy that uses a `Thread.yield()` for Consumers waiting on a
barrier after an initially spinning. |This strategy is a good compromise between performance and CPU resource
without incurring significant latency spikes.
|=======================================================================
@@ -147,10 +148,10 @@ thread pools you can use:
from("disruptor:stageName?concurrentConsumers=5").process(...)
--------------------------------------------------------------
-As for the difference between the two, note a thread pool can
-increase/shrink dynamically at runtime depending on load, whereas the
+As for the difference between the two, note that a thread pool can
+increase/shrink dynamically at runtime depending on load. Whereas the
number of concurrent consumers is always fixed and supported by the
-Disruptor internally so performance will be higher.
+Disruptor internally, so performance will be higher.
== Thread pools
@@ -166,13 +167,14 @@ Can wind up with adding a normal
http://docs.oracle.com/javase/1.5.0/docs/api/java/util/concurrent/BlockingQueue.html[BlockingQueue]
to be used in conjunction with the Disruptor, effectively negating part
of the performance gains achieved by using the Disruptor. Instead, it is
-advices to directly configure number of threads that process messages on
+advices to directly configure the number of threads that process messages on
a Disruptor endpoint using the concurrentConsumers option.
== Sample
-In the route below we use the Disruptor to send the request to this
-async queue to be able to send a fire-and-forget message for further
+In the route below, we use the Disruptor to send the request to this
+async queue.
+As such, it is able to send a _fire-and-forget_ message for further
processing in another thread, and return a constant reply in this thread
to the original caller.
@@ -189,7 +191,7 @@ public void configure() {
}
-------------------------------------------------
-Here we send a Hello World message and expects the reply to be OK.
+Here we send a _Hello World_ message and expect the reply to be _OK_.
[source,java]
-----------------------------------------------------------------
@@ -204,7 +206,7 @@ unit test.
== Using multipleConsumers
-In this example we have defined two consumers and registered them as
+In this example, we have defined two consumers and registered them as
spring beans.
[source,xml]
@@ -221,10 +223,10 @@ spring beans.
-------------------------------------------------------------------------------------------
Since we have specified multipleConsumers=true on the Disruptor foo
-endpoint we can have those two or more consumers receive their own copy
-of the message as a kind of pub-sub style messaging. As the beans are
-part of an unit test they simply send the message to a mock endpoint,
-but notice how we can use @Consume to consume from the Disruptor.
+endpoint, we can have those two or more consumers receive their own copy
+of the message as a kind of _publish/subscriber_ style messaging.
+As the beans are part of a unit test, they simply send the message to a mock endpoint,
+but notice how we can use _@Consume_ to consume from the Disruptor.
[source,java]
-------------------------------------------
diff --git a/components/camel-disruptor/src/main/docs/disruptor-vm-component.adoc b/components/camel-disruptor/src/main/docs/disruptor-vm-component.adoc
index 3ebaa2d4a11..b0964702b29 100644
--- a/components/camel-disruptor/src/main/docs/disruptor-vm-component.adoc
+++ b/components/camel-disruptor/src/main/docs/disruptor-vm-component.adoc
@@ -15,17 +15,18 @@
*{component-header}*
The Disruptor component provides asynchronous
-https://en.wikipedia.org/wiki/Staged_event-driven_architecture[SEDA] behavior much as the
-standard SEDA component, but utilizes a
-https://github.com/LMAX-Exchange/disruptor[Disruptor] instead of a
+https://en.wikipedia.org/wiki/Staged_event-driven_architecture[SEDA] behavior similarly to the
+standard SEDA component.
+However, it uses a https://github.com/LMAX-Exchange/disruptor[Disruptor] instead of a
http://docs.oracle.com/javase/1.5.0/docs/api/java/util/concurrent/BlockingQueue.html[BlockingQueue]
-utilized by the standard xref:seda-component.adoc[SEDA]. Alternatively, a *disruptor-vm:* endpoint is supported by this component. As with the SEDA
-component, buffers of the *disruptor:* endpoints are only visible within
+used by the standard xref:seda-component.adoc[SEDA].
+
+As with the SEDA component, buffers of the Disruptor endpoints are only visible within
a *single* CamelContext and no support is
provided for persistence or recovery. The buffers of the
-**disruptor-vm:** endpoints also provides support for communication
-across CamelContexts instances so you can use this mechanism to
-communicate across web applications (provided that *camel-disruptor.jar*
+**disruptor-vm:** endpoints also provide support for communication
+across CamelContexts instances, so you can use this mechanism to
+communicate across web applications (as long as *camel-disruptor.jar*
is on the *system/boot* classpath).
The main advantage of choosing to use the Disruptor component over the
@@ -35,25 +36,25 @@ consumers. In those cases, significant increases of throughput and
reduction of latency has been observed. Performance in scenarios without
contention is comparable to the SEDA component.
-The Disruptor is implemented with the intention of mimicing the
-behaviour and options of the SEDA component as much as possible.
-The main differences with the them are the following:
+The Disruptor is implemented with the intention of mimicking the
+behavior and options of the SEDA component as much as possible.
+The main differences between them are the following:
* The buffer used is always bounded in size (default 1024 exchanges).
-* As a the buffer is always bouded, the default behaviour for the
+* As the buffer is always bouded, the default behaviour for the
Disruptor is to block while the buffer is full instead of throwing an
-exception. This default behaviour may be configured on the component
+exception. This default behavior may be configured on the component
(see options).
-* The Disruptor enpoints don't implement the BrowsableEndpoint
+* The Disruptor endpoints don't implement the `BrowsableEndpoint`
interface. As such, the exchanges currently in the Disruptor can't be
-retrieved, only the amount of exchanges.
+retrieved, only the number of exchanges.
* The Disruptor requires its consumers (multicasted or otherwise) to be
statically configured. Adding or removing consumers on the fly requires
complete flushing of all pending exchanges in the Disruptor.
* As a result of the reconfiguration: Data sent over a Disruptor is
directly processed and 'gone' if there is at least one consumer, late
joiners only get new exchanges published after they've joined.
-* The *pollTimeout* option is not supported by the Disruptor component.
+* The `pollTimeout` option is not supported by the Disruptor component.
* When a producer blocks on a full Disruptor, it does not respond to
thread interrupts.
@@ -73,10 +74,10 @@ for this component:
== URI format
--------------------------------
- disruptor-vm:someName[?options]
+ disruptor-vm:someId[?options]
--------------------------------
-Where **someName** can be any string that uniquely identifies the
+Where _someId_ can be any string that uniquely identifies the
endpoint within the current CamelContext.
== Options
@@ -94,7 +95,7 @@ include::partial$component-endpoint-options.adoc[]
== More Documentation
-See the disruptor component for more information
+See the xref:disruptor-component.adoc[Disruptor] component for more information.
// shared with disruptor
(camel) 08/10: CAMEL-20410: documentation fixes for camel-drill
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 14e1081292cb932dd579951f1d36f0f8cec0f712
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Mon Feb 19 13:11:42 2024 +0100
CAMEL-20410: documentation fixes for camel-drill
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
---
components/camel-drill/src/main/docs/drill-component.adoc | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/components/camel-drill/src/main/docs/drill-component.adoc b/components/camel-drill/src/main/docs/drill-component.adoc
index e40f4fb04be..a863e715d27 100644
--- a/components/camel-drill/src/main/docs/drill-component.adoc
+++ b/components/camel-drill/src/main/docs/drill-component.adoc
@@ -14,9 +14,10 @@
*{component-header}*
-The Drill component gives you the ability to querying to https://drill.apache.org/[Apache Drill Cluster]
+The Drill component gives you the ability to query the https://drill.apache.org/[Apache Drill Cluster].
-Drill is an Apache open-source SQL query engine for Big Data exploration. Drill is designed from the ground up to support high-performance analysis on the semi-structured and rapidly evolving data coming from modern Big Data applications, while still providing the familiarity and ecosystem of ANSI SQL, the industry-standard query language
+Drill is an Apache open-source SQL query engine for Big Data exploration.
+Drill is designed from the ground up to support high-performance analysis on the semi-structured and rapidly evolving data coming from modern Big Data applications, while still providing the familiarity and ecosystem of ANSI SQL, the industry-standard query language
Maven users will need to add the following dependency to their `pom.xml`
for this component:
(camel) 07/10: CAMEL-20410: documentation fixes for camel-docker
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 7309e326d4576b09d47ef85415172f7236d1ac23
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Mon Feb 19 13:10:18 2024 +0100
CAMEL-20410: documentation fixes for camel-docker
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
---
components/camel-docker/src/main/docs/docker-component.adoc | 11 +++++------
1 file changed, 5 insertions(+), 6 deletions(-)
diff --git a/components/camel-docker/src/main/docs/docker-component.adoc b/components/camel-docker/src/main/docs/docker-component.adoc
index 1c8e7396256..7c66b626966 100644
--- a/components/camel-docker/src/main/docs/docker-component.adoc
+++ b/components/camel-docker/src/main/docs/docker-component.adoc
@@ -18,8 +18,7 @@ Camel component for communicating with Docker.
The Docker Camel component leverages the
https://github.com/docker-java/docker-java[docker-java] via the
-https://docs.docker.com/reference/api/docker_remote_api[Docker Remote
-API].
+https://docs.docker.com/reference/api/docker_remote_api[Docker Remote API].
== URI format
@@ -49,7 +48,7 @@ include::partial$component-endpoint-headers.adoc[]
== Header Strategy
-All URI option can be passed as Header properties. Values found in a
+All URI options can be passed as Header properties. Values found in a
message header take precedence over URI parameters. A header property
takes the form of a URI option prefixed with *CamelDocker* as shown
below
@@ -71,7 +70,7 @@ The following example consumes events from Docker:
from("docker://events?host=192.168.59.103&port=2375").to("log:event");
----------------------------------------------------------------------
-The following example queries Docker for system wide information
+The following example queries Docker for system-wide information
[source,java]
-------------------------------------------------------------------
@@ -81,10 +80,10 @@ from("docker://info?host=192.168.59.103&port=2375").to("log:info");
== Dependencies
-To use Docker in your Camel routes you need to add a dependency on
+To use Docker in your Camel routes, you need to add a dependency on
*camel-docker*, which implements the component.
-If you use Maven you can just add the following to your pom.xml,
+If you use Maven, you can add the following to your pom.xml,
substituting the version number for the latest and greatest release (see
the download page for the latest versions).
(camel) 01/10: CAMEL-20410: documentation fixes for camel-debug
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 bea198e448838933a01d9d81b9057dc9cf88e712
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Mon Feb 19 12:41:28 2024 +0100
CAMEL-20410: documentation fixes for camel-debug
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
---
components/camel-debug/src/main/docs/debug.adoc | 12 +++++++-----
1 file changed, 7 insertions(+), 5 deletions(-)
diff --git a/components/camel-debug/src/main/docs/debug.adoc b/components/camel-debug/src/main/docs/debug.adoc
index 41a3aaa1607..7f2c1cf2487 100644
--- a/components/camel-debug/src/main/docs/debug.adoc
+++ b/components/camel-debug/src/main/docs/debug.adoc
@@ -11,10 +11,13 @@
*Since Camel {since}*
-The camel-debug enables Camel debugger for 3rd party tooling.
+The camel-debug enables Camel debugger for third party tooling.
This makes it easier to perform debugging in IDEs such as IDEA, Eclipse, VSCode
-IMPORTANT: The camel-debug is only for development purposes, it should **not** be used for production.
+[IMPORTANT]
+====
+The camel-debug is only for development purposes, it should **not** be used for production.
+====
== Auto-detection from classpath
@@ -28,9 +31,8 @@ Detected: camel-debug JAR (Enabling Camel Debugging)
== JMX remote connection
-To make it possible for 3rd party tooling to connect to the running Camel application,
-and to perform debugging actions, then Camel will expose a JMX RMI connector port,
-that the tools can use to connect via that allows JMX remote management.
+Camel will expose a JMX RMI connector port that the tools can use to connect via that allows JMX remote management.
+This is necessary to make it possible for third party tooling to connect to the running Camel application, and to perform debugging actions.
The service URL to connect is: