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/20 17:40:46 UTC
(camel) branch main updated (c1f1f7c9374 -> 9d834c22ce6)
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 c1f1f7c9374 CAMEL-20410: documentation fixes for camel-google-storage
new 851c4cb0b27 CAMEL-20410: documentation fixes for camel-grape
new ed27d7a4936 CAMEL-20410: documentation fixes for camel-graphql
new 20702ccd862 CAMEL-20410: documentation fixes for camel-grok
new 45bd00cd868 CAMEL-20410: documentation fixes for camel-groovy
new fca2a800127 CAMEL-20410: documentation fixes for camel-grpc
new 72f677f768d CAMEL-20410: documentation fixes for camel-gson
new 27723c30de6 CAMEL-20410: documentation fixes for camel-guava
new 14387c9eb16 CAMEL-20410: documentation fixes for camel-hashicorp-vault
new 4372baf92a0 CAMEL-20410: documentation fixes for camel-hazelcast
new 54c36e7c2cd CAMEL-20410: documentation fixes for camel-headersmap
new c90be5b3837 CAMEL-20410: documentation fixes for camel-hl7
new 3b99ff3277a CAMEL-20410: documentation fixes for camel-http
new 9d834c22ce6 CAMEL-20410: documentation fixes for camel-huaweicloud-smn
The 13 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:
.../camel-grape/src/main/docs/grape-component.adoc | 22 +++---
.../src/main/docs/graphql-component.adoc | 6 +-
.../camel-grok/src/main/docs/grok-dataformat.adoc | 50 +++++++------
.../src/main/docs/groovy-language.adoc | 30 ++++----
.../camel-grpc/src/main/docs/grpc-component.adoc | 26 +++----
.../camel-gson/src/main/docs/gson-dataformat.adoc | 10 ++-
.../src/main/docs/guava-eventbus-component.adoc | 8 +--
.../src/main/docs/hashicorp-vault-component.adoc | 12 ++--
.../main/docs/hazelcast-atomicvalue-component.adoc | 57 +++++++++++----
.../main/docs/hazelcast-instance-component.adoc | 4 +-
.../src/main/docs/hazelcast-list-component.adoc | 6 +-
.../src/main/docs/hazelcast-map-component.adoc | 83 ++++++++++++++-------
.../main/docs/hazelcast-multimap-component.adoc | 53 +++++++++-----
.../src/main/docs/hazelcast-queue-component.adoc | 4 +-
.../docs/hazelcast-replicatedmap-component.adoc | 40 +++++++----
.../main/docs/hazelcast-ringbuffer-component.adoc | 11 ++-
.../src/main/docs/hazelcast-seda-component.adoc | 21 ++++--
.../src/main/docs/hazelcast-set-component.adoc | 4 +-
.../src/main/docs/hazelcast-summary.adoc | 20 +++---
.../src/main/docs/hazelcast-topic-component.adoc | 2 +-
.../camel-headersmap/src/main/docs/headersmap.adoc | 2 +-
.../camel-hl7/src/main/docs/hl7-dataformat.adoc | 24 +++----
.../src/main/docs/hl7terser-language.adoc | 15 ++--
.../camel-http/src/main/docs/http-component.adoc | 84 +++++++++++-----------
.../src/main/docs/hwcloud-smn-component.adoc | 2 +-
25 files changed, 360 insertions(+), 236 deletions(-)
(camel) 03/13: CAMEL-20410: documentation fixes for camel-grok
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 20702ccd862ebc3d39161e7b0c21b138e7bfb750
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Tue Feb 20 17:38:08 2024 +0100
CAMEL-20410: documentation fixes for camel-grok
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
---
.../camel-grok/src/main/docs/grok-dataformat.adoc | 50 ++++++++++++----------
1 file changed, 28 insertions(+), 22 deletions(-)
diff --git a/components/camel-grok/src/main/docs/grok-dataformat.adoc b/components/camel-grok/src/main/docs/grok-dataformat.adoc
index a36282ca3eb..69ebc74750e 100644
--- a/components/camel-grok/src/main/docs/grok-dataformat.adoc
+++ b/components/camel-grok/src/main/docs/grok-dataformat.adoc
@@ -14,7 +14,7 @@
This component provides dataformat for processing inputs with grok patterns.
Grok patterns are used to process unstructured data into structured objects - `List<Map<String, Object>>`.
-This component is based on https://github.com/thekrakken/java-grok[Java Grok library]
+This component is based on the https://github.com/thekrakken/java-grok[Java Grok library]
Maven users will need to add the following dependency to their `pom.xml`
for this component:
@@ -31,7 +31,7 @@ for this component:
== Basic usage
-Extract all IP adresses from input
+.Extract all IP addresses from input
[source,java]
--------------------------------------------------------------------------------
from("direct:in")
@@ -39,7 +39,7 @@ from("direct:in")
.to("log:out");
--------------------------------------------------------------------------------
-Parse Apache logs and process only 4xx responses
+.Parse Apache logs and process only 4xx responses
[source,java]
--------------------------------------------------------------------------------
from("file://apacheLogs")
@@ -56,9 +56,30 @@ All https://github.com/thekrakken/java-grok/tree/master/src/main/resources/patte
== Custom patterns
Camel Grok DataFormat supports plugable patterns, which are auto loaded from Camel Registry.
-You can register patterns with Java DSL and Spring DSL
+You can register patterns with Java DSL and Spring DSL:
-Spring DSL:
+[tabs]
+====
+
+Java DSL::
++
+[source,java]
+--------------------------------------------------------------------------------
+public class MyRouteBuilder extends RouteBuilder {
+
+ @Override
+ public void configure() throws Exception {
+ bindToRegistry("myCustomPatternBean", new GrokPattern("FOOBAR", "foo|bar"));
+
+ from("direct:in")
+ .unmarshal().grok("%{FOOBAR:fooBar}")
+ .to("log:out");
+ }
+}
+--------------------------------------------------------------------------------
+
+Spring XML::
++
[source,xml]
--------------------------------------------------------------------------------
<beans>
@@ -78,24 +99,9 @@ Spring DSL:
</camelContext>
--------------------------------------------------------------------------------
-Java DSL:
-[source,java]
---------------------------------------------------------------------------------
-public class MyRouteBuilder extends RouteBuilder {
-
- @Override
- public void configure() throws Exception {
- bindToRegistry("myCustomPatternBean", new GrokPattern("FOOBAR", "foo|bar"));
-
- from("direct:in")
- .unmarshal().grok("%{FOOBAR:fooBar}")
- .to("log:out");
- }
-}
---------------------------------------------------------------------------------
-
+====
-== Grok Dataformat Options
+== Grok Data format Options
// dataformat options: START
include::partial$dataformat-options.adoc[]
(camel) 13/13: CAMEL-20410: documentation fixes for camel-huaweicloud-smn
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 9d834c22ce6e7686e208bda8a87884d2b86135dd
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Tue Feb 20 18:26:45 2024 +0100
CAMEL-20410: documentation fixes for camel-huaweicloud-smn
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
- Converted to use tabs
---
.../camel-huaweicloud-smn/src/main/docs/hwcloud-smn-component.adoc | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/components/camel-huawei/camel-huaweicloud-smn/src/main/docs/hwcloud-smn-component.adoc b/components/camel-huawei/camel-huaweicloud-smn/src/main/docs/hwcloud-smn-component.adoc
index c17de45bff0..5ad90d8b271 100644
--- a/components/camel-huawei/camel-huaweicloud-smn/src/main/docs/hwcloud-smn-component.adoc
+++ b/components/camel-huawei/camel-huaweicloud-smn/src/main/docs/hwcloud-smn-component.adoc
@@ -67,7 +67,7 @@ include::partial$component-endpoint-options.adoc[]
|`CamelHwCloudSmnMessageTtl` |`Integer` | Validity of the posted notification message
-|`CamelHwCloudSmnTemplateTags` |`Map<String, String>` | Contains K,V pairs of tags and values when using operation `publishAsTemplatedMessage`
+|`CamelHwCloudSmnTemplateTags` |`Map<String, String>` | Contains `K,V` pairs of tags and values when using operation `publishAsTemplatedMessage`
|`CamelHwCloudSmnTemplateName` |`String` |Name of the template to use while using operation `publishAsTemplatedMessage`
(camel) 11/13: CAMEL-20410: documentation fixes for camel-hl7
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 c90be5b383748de91d4431bcc67283632ed2b1c9
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Tue Feb 20 18:15:40 2024 +0100
CAMEL-20410: documentation fixes for camel-hl7
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
- Converted to use tabs
---
.../camel-hl7/src/main/docs/hl7-dataformat.adoc | 24 +++++++++++-----------
.../src/main/docs/hl7terser-language.adoc | 15 +++++++-------
2 files changed, 20 insertions(+), 19 deletions(-)
diff --git a/components/camel-hl7/src/main/docs/hl7-dataformat.adoc b/components/camel-hl7/src/main/docs/hl7-dataformat.adoc
index e737d1e4658..c7b951c938d 100644
--- a/components/camel-hl7/src/main/docs/hl7-dataformat.adoc
+++ b/components/camel-hl7/src/main/docs/hl7-dataformat.adoc
@@ -37,9 +37,9 @@ for this component:
== HL7 MLLP protocol
-HL7 is often used with the HL7 MLLP protocol, which is a text based TCP
+HL7 is often used with the HL7 MLLP protocol, which is a text-based TCP
socket based protocol. This component ships with a Mina and Netty Codec
-that conforms to the MLLP protocol so you can easily expose an HL7
+that conforms to the MLLP protocol, so you can easily expose an HL7
listener accepting HL7 requests over the TCP transport layer. To expose
a HL7 listener service, the xref:ROOT:mina-component.adoc[camel-mina] or
xref:ROOT:netty-component.adoc[camel-netty] component is used with the
@@ -84,7 +84,7 @@ requests using TCP on port `8888`:
----
*sync=true* indicates that this listener is synchronous and therefore
-will return a HL7 response to the caller. The HL7 codec is setup with
+will return a HL7 response to the caller. The HL7 codec is set up with
*codec=#hl7codec*. Note that `hl7codec` is just a Spring bean ID, so it
could be named `mygreatcodecforhl7` or whatever. The codec is also set
up in the Spring XML file:
@@ -105,7 +105,7 @@ from("hl7MinaListener")
.bean("patientLookupService");
----
-This is a very simple route that will listen for HL7 and route it to a
+This is a basic route that will listen for HL7 and route it to a
service named *patientLookupService*. This is also Spring bean ID,
configured in the Spring XML as:
@@ -145,7 +145,7 @@ requests using TCP on port `8888`:
----
*sync=true* indicates that this listener is synchronous and therefore
-will return a HL7 response to the caller. The HL7 codec is setup with
+will return a HL7 response to the caller. The HL7 codec is set up with
*encoders=#hl7encoder*and*decoders=#hl7decoder*. Note that `hl7encoder`
and `hl7decoder` are just bean IDs, so they could be named differently.
The beans can be set in the Spring XML file:
@@ -170,7 +170,7 @@ from("hl7NettyListener")
The HL7 MLLP codec uses plain String as its data format. Camel uses its
Type Converter to convert to/from strings to
the HAPI HL7 model objects, but you can use the plain String objects if
-you prefer, for instance if you wish to parse the data yourself.
+you prefer, for instance, if you wish to parse the data yourself.
You can also let both the Mina and Netty codecs use a
plain `byte[]` as its data format by setting the `produceString`
@@ -183,7 +183,7 @@ The HL7v2 model uses Java objects from the HAPI library. Using this
library, you can encode and decode from the EDI format (ER7) that is
mostly used with HL7v2.
-The sample below is a request to lookup a patient with the patient ID
+The sample below is a request to look up a patient with the patient ID
`0101701234`.
[source,text]
@@ -192,8 +192,8 @@ MSH|^~\\&|MYSENDER|MYRECEIVER|MYAPPLICATION||200612211200||QRY^A19|1234|P|2.4
QRD|200612211200|R|I|GetPatient|||1^RD|0101701234|DEM||
----
-Using the HL7 model you can work with a `ca.uhn.hl7v2.model.Message`
-object, e.g. to retrieve a patient ID:
+Using the HL7 model, you can work with a `ca.uhn.hl7v2.model.Message`
+object, e.g., to retrieve a patient ID:
[source,java]
----
@@ -268,7 +268,7 @@ separators anymore by converting `\n` to `\r`. If you +
=== Charset
Both `marshal and unmarshal` evaluate the charset
-provided in the field `MSH-18`. If this field is empty, by default the
+provided in the field `MSH-18`. If this field is empty, by default, the
charset contained in the corresponding Camel charset property/header is
assumed. You can even change this default behavior by overriding the
`guessCharsetName` method when inheriting from the `HL7DataFormat`
@@ -334,7 +334,7 @@ value is missing, its value is `null`.
== Dependencies
-To use HL7 in your Camel routes you'll need to add a dependency on
+To use HL7 in your Camel routes, you'll need to add a dependency on
*camel-hl7* listed above, which implements this data format.
The HAPI library is split into a
@@ -362,7 +362,7 @@ By default `camel-hl7` only references the HAPI
https://repo1.maven.org/maven2/ca/uhn/hapi/hapi-base[base library].
Applications are responsible for including structure libraries
themselves. For example, if an application works with HL7v2 message
-versions 2.4 and 2.5 then the following dependencies must be added:
+versions 2.4 and 2.5, then the following dependencies must be added:
[source,xml]
----
diff --git a/components/camel-hl7/src/main/docs/hl7terser-language.adoc b/components/camel-hl7/src/main/docs/hl7terser-language.adoc
index 2d8639cc54c..c835d2456f6 100644
--- a/components/camel-hl7/src/main/docs/hl7terser-language.adoc
+++ b/components/camel-hl7/src/main/docs/hl7terser-language.adoc
@@ -14,9 +14,10 @@
https://hapifhir.github.io/hapi-hl7v2/[HAPI] provides a
https://hapifhir.github.io/hapi-hl7v2/base/apidocs/ca/uhn/hl7v2/util/Terser.html[Terser]
class that provides access to fields using a commonly used terse
-location specification syntax. The HL7 Terser language allows to use this
+location specification syntax.
+The HL7 Terser language allows using this
syntax to extract values from HL7 messages and to use them as expressions
-and predicates for filtering, content-based routing etc.
+and predicates for filtering, content-based routing, etc.
== HL7 Terser Language options
@@ -27,7 +28,7 @@ include::partial$language-options.adoc[]
== Example
-In the example below we want to set a header with the patent id
+In the example below, we want to set a header with the patent id
from field QRD-8 in the QRY_A19 message:
[source,java]
@@ -62,7 +63,7 @@ import ca.uhn.hl7v2.validation.impl.DefaultValidation;
// Use standard or define your own validation rules
ValidationContext defaultContext = new DefaultValidation();
-// Throws PredicateValidationException if message does not validate
+// Throws PredicateValidationException if a message does not validate
from("direct:test1")
.validate(messageConformsTo(defaultContext))
.to("mock:test1");
@@ -87,7 +88,7 @@ import static org.apache.camel.component.hl7.HL7.messageConforms;
HapiContext hapiContext = new DefaultHapiContext();
hapiContext.getParserConfiguration().setValidating(false); // don't validate during parsing
-// customize HapiContext some more ... e.g. enforce that PID-8 in ADT_A01 messages of version 2.4 is not empty
+// customize HapiContext some more ... e.g., enforce that PID-8 in ADT_A01 messages of version 2.4 is not empty
ValidationRuleBuilder builder = new ValidationRuleBuilder() {
@Override
protected void configure() {
@@ -111,7 +112,7 @@ from("direct:test1")
== HL7 Acknowledgement expression
A common task in HL7v2 processing is to generate an acknowledgement
-message as response to an incoming HL7v2 message, e.g. based on a
+message as a response to an incoming HL7v2 message, e.g., based on a
validation result. The `ack` expression lets us accomplish this very
elegantly:
@@ -138,7 +139,7 @@ from("direct:test1")
=== Custom Acknowledgement for MLLP
-In special situations you may want to set a custom acknowledgement without using Exceptions.
+In special situations, you may want to set a custom acknowledgement without using Exceptions.
This can be achieved using the `ack` expression:
[source,java]
(camel) 09/13: CAMEL-20410: documentation fixes for camel-hazelcast
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 4372baf92a06be3385ce947b79bdb69a4e923711
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Tue Feb 20 18:11:28 2024 +0100
CAMEL-20410: documentation fixes for camel-hazelcast
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
- Converted to use tabs
---
.../main/docs/hazelcast-atomicvalue-component.adoc | 57 +++++++++++----
.../main/docs/hazelcast-instance-component.adoc | 4 +-
.../src/main/docs/hazelcast-list-component.adoc | 6 +-
.../src/main/docs/hazelcast-map-component.adoc | 83 +++++++++++++++-------
.../main/docs/hazelcast-multimap-component.adoc | 53 +++++++++-----
.../src/main/docs/hazelcast-queue-component.adoc | 4 +-
.../docs/hazelcast-replicatedmap-component.adoc | 40 +++++++----
.../main/docs/hazelcast-ringbuffer-component.adoc | 11 ++-
.../src/main/docs/hazelcast-seda-component.adoc | 21 ++++--
.../src/main/docs/hazelcast-set-component.adoc | 4 +-
.../src/main/docs/hazelcast-summary.adoc | 20 +++---
.../src/main/docs/hazelcast-topic-component.adoc | 2 +-
12 files changed, 206 insertions(+), 99 deletions(-)
diff --git a/components/camel-hazelcast/src/main/docs/hazelcast-atomicvalue-component.adoc b/components/camel-hazelcast/src/main/docs/hazelcast-atomicvalue-component.adoc
index 99aad377a26..4fa4e49e432 100644
--- a/components/camel-hazelcast/src/main/docs/hazelcast-atomicvalue-component.adoc
+++ b/components/camel-hazelcast/src/main/docs/hazelcast-atomicvalue-component.adoc
@@ -51,8 +51,11 @@ include::partial$component-endpoint-headers.adoc[]
=== Sample for *set*:
-Java DSL:
+[tabs]
+====
+Java DSL::
++
[source,java]
-----------------------------------------------------------------------------------------
from("direct:set")
@@ -60,8 +63,8 @@ from("direct:set")
.toF("hazelcast-%sfoo", HazelcastConstants.ATOMICNUMBER_PREFIX);
-----------------------------------------------------------------------------------------
-Spring DSL:
-
+Spring XML::
++
[source,xml]
-----------------------------------------------------------------------------------------------
<route>
@@ -73,13 +76,18 @@ Spring DSL:
</route>
-----------------------------------------------------------------------------------------------
+====
+
Provide the value to set inside the message body (here the value is 10):
`template.sendBody("direct:set", 10);`
=== Sample for *get*:
-Java DSL:
+[tabs]
+====
+Java DSL::
++
[source,java]
------------------------------------------------------------------------------------
from("direct:get")
@@ -87,8 +95,8 @@ from("direct:get")
.toF("hazelcast-%sfoo", HazelcastConstants.ATOMICNUMBER_PREFIX);
------------------------------------------------------------------------------------
-Spring DSL:
-
+Spring XML::
++
[source,xml]
-----------------------------------------------------------------------------------------------
<route>
@@ -100,12 +108,18 @@ Spring DSL:
</route>
-----------------------------------------------------------------------------------------------
+====
+
You can get the number with
`long body = template.requestBody("direct:get", null, Long.class);`.
=== Sample for *increment*:
-Java DSL:
+[tabs]
+====
+
+Java DSL::
++
[source,java]
------------------------------------------------------------------------------------------
@@ -114,8 +128,8 @@ from("direct:increment")
.toF("hazelcast-%sfoo", HazelcastConstants.ATOMICNUMBER_PREFIX);
------------------------------------------------------------------------------------------
-Spring DSL:
-
+Spring XML::
++
[source,xml]
-----------------------------------------------------------------------------------------------
<route>
@@ -127,12 +141,18 @@ Spring DSL:
</route>
-----------------------------------------------------------------------------------------------
+====
+
The actual value (after increment) will be provided inside the message
body.
=== Sample for *decrement*:
-Java DSL:
+[tabs]
+====
+
+Java DSL::
++
[source,java]
------------------------------------------------------------------------------------------
@@ -141,8 +161,8 @@ from("direct:decrement")
.toF("hazelcast-%sfoo", HazelcastConstants.ATOMICNUMBER_PREFIX);
------------------------------------------------------------------------------------------
-Spring DSL:
-
+Spring XML::
++
[source,xml]
-----------------------------------------------------------------------------------------------
<route>
@@ -154,12 +174,18 @@ Spring DSL:
</route>
-----------------------------------------------------------------------------------------------
+====
+
The actual value (after decrement) will be provided inside the message
body.
=== Sample for *destroy*
-Java DSL:
+[tabs]
+====
+
+Java DSL::
++
[source,java]
----------------------------------------------------------------------------------------
@@ -168,8 +194,8 @@ from("direct:destroy")
.toF("hazelcast-%sfoo", HazelcastConstants.ATOMICNUMBER_PREFIX);
----------------------------------------------------------------------------------------
-Spring DSL:
-
+Spring XML::
++
[source,xml]
-----------------------------------------------------------------------------------------------
<route>
@@ -181,5 +207,6 @@ Spring DSL:
</route>
-----------------------------------------------------------------------------------------------
+====
include::spring-boot:partial$starter.adoc[]
diff --git a/components/camel-hazelcast/src/main/docs/hazelcast-instance-component.adoc b/components/camel-hazelcast/src/main/docs/hazelcast-instance-component.adoc
index 45ed47ea30b..28c3d082365 100644
--- a/components/camel-hazelcast/src/main/docs/hazelcast-instance-component.adoc
+++ b/components/camel-hazelcast/src/main/docs/hazelcast-instance-component.adoc
@@ -16,7 +16,7 @@
*{component-header}*
The http://www.hazelcast.com/[Hazelcast] instance component is one of Camel Hazelcast Components which allows you to consume join/leave events of the cache instance in the cluster.
-Hazelcast makes sense in one single "server node", but it's extremly powerful in a clustered environment.
+Hazelcast makes sense in one single "server node", but it's extremely powerful in a clustered environment.
// component-configure options: START
@@ -34,7 +34,7 @@ include::partial$component-endpoint-options.adoc[]
== instance consumer - from("hazelcast-instance:foo")
-The instance consumer fires if a new cache instance will join or leave the cluster.
+The instance consumer fires if a new cache instance joins or leaves the cluster.
Here's a sample:
diff --git a/components/camel-hazelcast/src/main/docs/hazelcast-list-component.adoc b/components/camel-hazelcast/src/main/docs/hazelcast-list-component.adoc
index fd97c4cf39c..67fffbe245c 100644
--- a/components/camel-hazelcast/src/main/docs/hazelcast-list-component.adoc
+++ b/components/camel-hazelcast/src/main/docs/hazelcast-list-component.adoc
@@ -15,7 +15,7 @@
*{component-header}*
-The http://www.hazelcast.com/[Hazelcast] List component is one of Camel Hazelcast Components which allows you to access Hazelcast distributed list.
+The http://www.hazelcast.com/[Hazelcast] List component is one of Camel Hazelcast Components which allows you to access a Hazelcast distributed list.
== Options
@@ -35,7 +35,7 @@ include::partial$component-endpoint-options.adoc[]
== List producer – to(“hazelcast-list:foo”)
-The list producer provides 8 operations:
+The list producer provides eight operations:
* add
* addAll
@@ -93,7 +93,7 @@ purpose.
== List consumer – from(“hazelcast-list:foo”)
-The list consumer provides 2 operations:
+The list consumer provides two operations:
* add
* remove
diff --git a/components/camel-hazelcast/src/main/docs/hazelcast-map-component.adoc b/components/camel-hazelcast/src/main/docs/hazelcast-map-component.adoc
index de08673a920..287604bfa97 100644
--- a/components/camel-hazelcast/src/main/docs/hazelcast-map-component.adoc
+++ b/components/camel-hazelcast/src/main/docs/hazelcast-map-component.adoc
@@ -15,7 +15,7 @@
*{component-header}*
-The http://www.hazelcast.com/[Hazelcast] Map component is one of Camel Hazelcast Components which allows you to access Hazelcast distributed map.
+The http://www.hazelcast.com/[Hazelcast] Map component is one of Camel Hazelcast Components which allows you to access a Hazelcast distributed map.
== Options
@@ -36,7 +36,7 @@ include::partial$component-endpoint-options.adoc[]
== Map cache producer - to("hazelcast-map:foo")
-If you want to store a value in a map you can use the map cache
+If you want to store a value in a map, you can use the map cache
producer.
The map cache producer provides follow operations specified by *CamelHazelcastOperationType* header:
@@ -68,8 +68,11 @@ template.sendBodyAndHeader("direct:[put|get|update|delete|query|evict]", "my-foo
=== Sample for *put*:
-Java DSL:
+[tabs]
+====
+Java DSL::
++
[source,java]
------------------------------------------------------------------------------------
from("direct:put")
@@ -77,8 +80,8 @@ from("direct:put")
.toF("hazelcast-%sfoo", HazelcastConstants.MAP_PREFIX);
------------------------------------------------------------------------------------
-Spring DSL:
-
+Spring XML::
++
[source,xml]
-----------------------------------------------------------------------------------------------
<route>
@@ -90,9 +93,15 @@ Spring DSL:
</route>
-----------------------------------------------------------------------------------------------
+====
+
Sample for *put* with eviction:
-Java DSL:
+[tabs]
+====
+
+Java DSL::
++
[source,java]
------------------------------------------------------------------------------------
@@ -103,8 +112,8 @@ from("direct:put")
.toF("hazelcast-%sfoo", HazelcastConstants.MAP_PREFIX);
------------------------------------------------------------------------------------
-Spring DSL:
-
+Spring XML::
++
[source,xml]
-----------------------------------------------------------------------------------------------
<route>
@@ -122,11 +131,15 @@ Spring DSL:
</route>
-----------------------------------------------------------------------------------------------
+====
=== Sample for *get*:
-Java DSL:
+[tabs]
+====
+Java DSL::
++
[source,java]
------------------------------------------------------------------------------------
from("direct:get")
@@ -135,8 +148,8 @@ from("direct:get")
.to("seda:out");
------------------------------------------------------------------------------------
-Spring DSL:
-
+Spring XML::
++
[source,xml]
-----------------------------------------------------------------------------------------------
<route>
@@ -149,10 +162,15 @@ Spring DSL:
</route>
-----------------------------------------------------------------------------------------------
+====
+
=== Sample for *update*:
-Java DSL:
+[tabs]
+====
+Java DSL::
++
[source,java]
---------------------------------------------------------------------------------------
from("direct:update")
@@ -160,8 +178,8 @@ from("direct:update")
.toF("hazelcast-%sfoo", HazelcastConstants.MAP_PREFIX);
---------------------------------------------------------------------------------------
-Spring DSL:
-
+Spring XML::
++
[source,xml]
-----------------------------------------------------------------------------------------------
<route>
@@ -173,9 +191,15 @@ Spring DSL:
</route>
-----------------------------------------------------------------------------------------------
+====
+
=== Sample for *delete*:
-Java DSL:
+[tabs]
+====
+
+Java DSL::
++
[source,java]
---------------------------------------------------------------------------------------
@@ -184,8 +208,8 @@ from("direct:delete")
.toF("hazelcast-%sfoo", HazelcastConstants.MAP_PREFIX);
---------------------------------------------------------------------------------------
-Spring DSL:
-
+Spring XML::
++
[source,xml]
-----------------------------------------------------------------------------------------------
<route>
@@ -197,10 +221,15 @@ Spring DSL:
</route>
-----------------------------------------------------------------------------------------------
+====
+
=== Sample for *query*
-Java DSL:
+[tabs]
+====
+Java DSL::
++
[source,java]
--------------------------------------------------------------------------------------
from("direct:query")
@@ -209,8 +238,8 @@ from("direct:query")
.to("seda:out");
--------------------------------------------------------------------------------------
-Spring DSL:
-
+Spring XML::
++
[source,xml]
-----------------------------------------------------------------------------------------------
<route>
@@ -223,7 +252,9 @@ Spring DSL:
</route>
-----------------------------------------------------------------------------------------------
-For the query operation Hazelcast offers a SQL like syntax to query your
+====
+
+For the query operation Hazelcast offers an SQL like syntax to query your
distributed map.
[source,java]
@@ -236,8 +267,8 @@ template.sendBodyAndHeader("direct:query", null, HazelcastConstants.QUERY, q1);
== Map cache consumer - from("hazelcast-map:foo")
Hazelcast provides event listeners on their data grid. If you want to be
-notified if a cache will be manipulated, you can use the map consumer.
-There're 4 events: *put*, *update*, *delete* and *envict*. The event
+notified if a cache is manipulated, you can use the map consumer.
+There are four events: *put*, *update*, *delete* and *envict*. The event
type will be stored in the "*hazelcast.listener.action*" header
variable. The map consumer provides some additional information inside
these variables:
@@ -252,13 +283,13 @@ Header Variables inside the response message:
|`CamelHazelcastListenerType` |`String` |the map consumer sets here "cachelistener"
-|`CamelHazelcastListenerAction` |`String` |type of event - here *added*, *updated*, *envicted* and *removed*.
+|`CamelHazelcastListenerAction` |`String` |type of event (*added*, *updated*, *envicted* and *removed*).
|`CamelHazelcastObjectId` |`String` |the oid of the object
-|`CamelHazelcastCacheName` |`String` |the name of the cache - e.g. "foo"
+|`CamelHazelcastCacheName` |`String` |the name of the cache (e.g., "foo")
-|`CamelHazelcastCacheType` |`String` |the type of the cache - here map
+|`CamelHazelcastCacheType` |`String` |the type of the cache (e.g., map)
|=======================================================================
The object value will be stored within *put* and *update* actions inside
diff --git a/components/camel-hazelcast/src/main/docs/hazelcast-multimap-component.adoc b/components/camel-hazelcast/src/main/docs/hazelcast-multimap-component.adoc
index d133a8b33f3..7f294f6543c 100644
--- a/components/camel-hazelcast/src/main/docs/hazelcast-multimap-component.adoc
+++ b/components/camel-hazelcast/src/main/docs/hazelcast-multimap-component.adoc
@@ -38,7 +38,7 @@ include::partial$component-endpoint-options.adoc[]
A multimap is a cache where you can store n values to one key.
-The multimap producer provides 8 operations:
+The multimap producer provides eight operations:
* put
* get
@@ -55,8 +55,11 @@ include::partial$component-endpoint-headers.adoc[]
=== Sample for *put*:
-Java DSL:
+[tabs]
+====
+Java DSL::
++
[source,java]
------------------------------------------------------------------------------------
from("direct:put")
@@ -64,8 +67,8 @@ from("direct:put")
.to(String.format("hazelcast-%sbar", HazelcastConstants.MULTIMAP_PREFIX));
------------------------------------------------------------------------------------
-Spring DSL:
-
+Spring XML::
++
[source,xml]
-----------------------------------------------------------------------------------------------
<route>
@@ -78,9 +81,15 @@ Spring DSL:
</route>
-----------------------------------------------------------------------------------------------
+====
+
=== Sample for *removevalue*:
-Java DSL:
+[tabs]
+====
+
+Java DSL::
++
[source,java]
--------------------------------------------------------------------------------------------
@@ -89,8 +98,8 @@ from("direct:removevalue")
.toF("hazelcast-%sbar", HazelcastConstants.MULTIMAP_PREFIX);
--------------------------------------------------------------------------------------------
-Spring DSL:
-
+Spring XML::
++
[source,xml]
-----------------------------------------------------------------------------------------------
<route>
@@ -103,15 +112,20 @@ Spring DSL:
</route>
-----------------------------------------------------------------------------------------------
+====
+
To remove a value you have to provide the value you want to remove
inside the message body. If you have a multimap object
-\{`key: "4711" values: { "my-foo", "my-bar"`}} you have to put "my-foo"
-inside the message body to remove the "my-foo" value.
+`\{`key: "4711" values: { "my-foo", "my-bar"`}}` you have to put `my-foo`
+inside the message body to remove the `my-foo` value.
=== Sample for *get*:
-Java DSL:
+[tabs]
+====
+Java DSL::
++
[source,java]
------------------------------------------------------------------------------------
from("direct:get")
@@ -120,8 +134,8 @@ from("direct:get")
.to("seda:out");
------------------------------------------------------------------------------------
-Spring DSL:
-
+Spring XML::
++
[source,xml]
-----------------------------------------------------------------------------------------------
<route>
@@ -135,10 +149,15 @@ Spring DSL:
</route>
-----------------------------------------------------------------------------------------------
+====
+
=== Sample for *delete*:
-Java DSL:
+[tabs]
+====
+Java DSL::
++
[source,java]
---------------------------------------------------------------------------------------
from("direct:delete")
@@ -146,8 +165,8 @@ from("direct:delete")
.toF("hazelcast-%sbar", HazelcastConstants.MULTIMAP_PREFIX);
---------------------------------------------------------------------------------------
-Spring DSL:
-
+Spring XML::
++
[source,xml]
-----------------------------------------------------------------------------------------------
<route>
@@ -160,7 +179,9 @@ Spring DSL:
</route>
-----------------------------------------------------------------------------------------------
-you can call them in your test class with:
+====
+
+You can call them in your test class with:
[source,java]
------------------------------------------------------------------------------------------------------------------
diff --git a/components/camel-hazelcast/src/main/docs/hazelcast-queue-component.adoc b/components/camel-hazelcast/src/main/docs/hazelcast-queue-component.adoc
index c2191782e5d..78ce518d615 100644
--- a/components/camel-hazelcast/src/main/docs/hazelcast-queue-component.adoc
+++ b/components/camel-hazelcast/src/main/docs/hazelcast-queue-component.adoc
@@ -170,10 +170,10 @@ Sample for *Poll* mode
fromF("hazelcast-%sfoo?queueConsumerMode=Poll", HazelcastConstants.QUEUE_PREFIX)).to("mock:result");
-------------------------------------------------------------------------------------------
-In this way the consumer will poll the queue and return the head of the queue or null after a timeout.
+In this way, the consumer will poll the queue and return the head of the queue or null after a timeout.
-In Listen mode instead the consumer will listen for events on queue.
+In Listen mode instead, the consumer will listen for events on queue.
The queue consumer in Listen mode provides 2 operations:
* add
diff --git a/components/camel-hazelcast/src/main/docs/hazelcast-replicatedmap-component.adoc b/components/camel-hazelcast/src/main/docs/hazelcast-replicatedmap-component.adoc
index 6b68621d564..b7413e842db 100644
--- a/components/camel-hazelcast/src/main/docs/hazelcast-replicatedmap-component.adoc
+++ b/components/camel-hazelcast/src/main/docs/hazelcast-replicatedmap-component.adoc
@@ -50,8 +50,11 @@ include::partial$component-endpoint-headers.adoc[]
=== Sample for *put*:
-Java DSL:
+[tabs]
+====
+Java DSL::
++
[source,java]
------------------------------------------------------------------------------------
from("direct:put")
@@ -59,8 +62,8 @@ from("direct:put")
.to(String.format("hazelcast-%sbar", HazelcastConstants.REPLICATEDMAP_PREFIX));
------------------------------------------------------------------------------------
-Spring DSL:
-
+Spring XML::
++
[source,xml]
-----------------------------------------------------------------------------------------------
<route>
@@ -73,10 +76,15 @@ Spring DSL:
</route>
-----------------------------------------------------------------------------------------------
+====
+
=== Sample for *get*:
-Java DSL:
+[tabs]
+====
+Java DSL::
++
[source,java]
------------------------------------------------------------------------------------
from("direct:get")
@@ -85,8 +93,8 @@ from("direct:get")
.to("seda:out");
------------------------------------------------------------------------------------
-Spring DSL:
-
+Spring XML::
++
[source,xml]
-----------------------------------------------------------------------------------------------
<route>
@@ -100,10 +108,15 @@ Spring DSL:
</route>
-----------------------------------------------------------------------------------------------
+====
+
=== Sample for *delete*:
-Java DSL:
+[tabs]
+====
+Java DSL::
++
[source,java]
---------------------------------------------------------------------------------------
from("direct:delete")
@@ -111,8 +124,8 @@ from("direct:delete")
.toF("hazelcast-%sbar", HazelcastConstants.REPLICATEDMAP_PREFIX);
---------------------------------------------------------------------------------------
-Spring DSL:
-
+Spring XML::
++
[source,xml]
-----------------------------------------------------------------------------------------------
<route>
@@ -124,8 +137,9 @@ Spring DSL:
<to uri="hazelcast-replicatedmap:foo" />
</route>
-----------------------------------------------------------------------------------------------
+====
-you can call them in your test class with:
+You can call them in your test class with:
[source,java]
------------------------------------------------------------------------------------------------------------
@@ -134,7 +148,7 @@ template.sendBodyAndHeader("direct:[put|get|delete|clear]", "my-foo", HazelcastC
== replicatedmap cache consumer
-For the multimap cache this component provides the same listeners /
+For the multimap cache, this component provides the same listeners /
variables as for the map cache consumer (except the update and enviction
listener). The only difference is the *multimap* prefix inside the URI.
Here is a sample:
@@ -171,9 +185,9 @@ Header Variables inside the response message:
|`CamelHazelcastObjectId` |`String` | the oid of the object
-|`CamelHazelcastCacheName` |`String` |the name of the cache - e.g. "foo"
+|`CamelHazelcastCacheName` |`String` |the name of the cache (e.g., "foo")
-|`CamelHazelcastCacheType` |`String` |the type of the cache - here replicatedmap
+|`CamelHazelcastCacheType` |`String` |the type of the cache (e.g., replicatedmap)
|=======================================================================
diff --git a/components/camel-hazelcast/src/main/docs/hazelcast-ringbuffer-component.adoc b/components/camel-hazelcast/src/main/docs/hazelcast-ringbuffer-component.adoc
index c2313bc5a48..a940136c970 100644
--- a/components/camel-hazelcast/src/main/docs/hazelcast-ringbuffer-component.adoc
+++ b/components/camel-hazelcast/src/main/docs/hazelcast-ringbuffer-component.adoc
@@ -49,8 +49,11 @@ include::partial$component-endpoint-headers.adoc[]
=== Sample for *put*:
-Java DSL:
+[tabs]
+====
+Java DSL::
++
[source,java]
------------------------------------------------------------------------------------
from("direct:put")
@@ -58,8 +61,8 @@ from("direct:put")
.to(String.format("hazelcast-%sbar", HazelcastConstants.RINGBUFFER_PREFIX));
------------------------------------------------------------------------------------
-Spring DSL:
-
+Spring XML::
++
[source,xml]
-----------------------------------------------------------------------------------------------
<route>
@@ -72,6 +75,8 @@ Spring DSL:
</route>
-----------------------------------------------------------------------------------------------
+====
+
=== Sample for *readonce from head*:
Java DSL:
diff --git a/components/camel-hazelcast/src/main/docs/hazelcast-seda-component.adoc b/components/camel-hazelcast/src/main/docs/hazelcast-seda-component.adoc
index 190387b80ba..e3d476bd1ac 100644
--- a/components/camel-hazelcast/src/main/docs/hazelcast-seda-component.adoc
+++ b/components/camel-hazelcast/src/main/docs/hazelcast-seda-component.adoc
@@ -42,16 +42,19 @@ specified queue.
include::partial$component-endpoint-headers.adoc[]
// component headers: END
-Java DSL :
+[tabs]
+====
+Java DSL::
++
[source,java]
--------------------------
from("direct:foo")
.to("hazelcast-seda:foo");
--------------------------
-Spring DSL :
-
+Spring XML::
++
[source,xml]
----------------------------------
<route>
@@ -60,21 +63,26 @@ Spring DSL :
</route>
----------------------------------
+====
+
== SEDA consumer – from(“hazelcast-seda:foo”)
The SEDA consumer provides no operations. You only retrieve data from
the specified queue.
-Java DSL :
+[tabs]
+====
+Java DSL::
++
[source,java]
--------------------------
from("hazelcast-seda:foo")
.to("mock:result");
--------------------------
-Spring DSL:
-
+Spring XML::
++
[source,xml]
-----------------------------------
<route>
@@ -83,5 +91,6 @@ Spring DSL:
</route>
-----------------------------------
+====
include::spring-boot:partial$starter.adoc[]
diff --git a/components/camel-hazelcast/src/main/docs/hazelcast-set-component.adoc b/components/camel-hazelcast/src/main/docs/hazelcast-set-component.adoc
index 7710831a2a6..402c6b63141 100644
--- a/components/camel-hazelcast/src/main/docs/hazelcast-set-component.adoc
+++ b/components/camel-hazelcast/src/main/docs/hazelcast-set-component.adoc
@@ -15,7 +15,7 @@
*{component-header}*
-The http://www.hazelcast.com/[Hazelcast] Set component is one of Camel Hazelcast Components which allows you to access Hazelcast distributed set.
+The http://www.hazelcast.com/[Hazelcast] Set component is one of Camel Hazelcast Components which allows you to access a Hazelcast distributed set.
// component-configure options: START
@@ -33,7 +33,7 @@ include::partial$component-endpoint-options.adoc[]
== set cache producer
-The set producer provides 7 operations:
+The set producer provides seven operations:
* add
* removeAll
diff --git a/components/camel-hazelcast/src/main/docs/hazelcast-summary.adoc b/components/camel-hazelcast/src/main/docs/hazelcast-summary.adoc
index d326a2a77c2..df2f4aafac8 100644
--- a/components/camel-hazelcast/src/main/docs/hazelcast-summary.adoc
+++ b/components/camel-hazelcast/src/main/docs/hazelcast-summary.adoc
@@ -9,15 +9,15 @@
The *hazelcast-* component allows you to work with the
http://www.hazelcast.com[Hazelcast] distributed data grid / cache.
-Hazelcast is a in memory data grid, entirely written in Java (single
-jar). It offers a great palette of different data stores like map, multi
-map (same key, n values), queue, list and atomic number. The main reason
+Hazelcast is an in-memory data grid, entirely written in Java (single
+jar). It offers a great palette of different data stores like map,
+multimap (same key, n values), queue, list and atomic number. The main reason
to use Hazelcast is its simple cluster support. If you have enabled
-multicast on your network you can run a cluster with hundred nodes with
-no extra configuration. Hazelcast can simply configured to add
+multicast on your network, you can run a cluster with a hundred nodes with
+no extra configuration. Hazelcast can simply configure to add
additional features like n copies between nodes (default is 1), cache
-persistence, network configuration (if needed), near cache, eviction
-and so on. For more information consult the Hazelcast documentation on
+persistence, network configuration (if needed), near cache, eviction,
+and so on. For more information, consult the Hazelcast documentation on
http://www.hazelcast.com/docs.jsp[http://www.hazelcast.com/docs.jsp].
== {doctitle} components
@@ -112,7 +112,7 @@ for this component:
=== Configuring HazelcastInstance on component
You can also configure the hazelcast instance on the component which will then be used by all hazelcast endpoints.
-In the example above we setup this for the hazelcast map component and setup hazelcast via verbose `<bean>` configurations.
+In the example above we set up this for the hazelcast map component and setup hazelcast via verbose `<bean>` configurations.
[source,xml]
------------------------------------------------------------------------------
@@ -136,12 +136,12 @@ In the example above we setup this for the hazelcast map component and setup haz
== Publishing hazelcast instance as an OSGI service
-If operating in an OSGI container and you would want to use one instance
+If operating in an OSGI container, and you would want to use one instance
of hazelcast across all bundles in the same container. You can publish
the instance as an OSGI service and bundles using the cache al need is
to reference the service in the hazelcast endpoint.
-=== Bundle A create an instance and publishes it as an OSGI service
+=== Bundle A create an instance and publish it as an OSGI service
[source,xml]
--------------------------------------------------------------------------------------------------------
diff --git a/components/camel-hazelcast/src/main/docs/hazelcast-topic-component.adoc b/components/camel-hazelcast/src/main/docs/hazelcast-topic-component.adoc
index 71bcedb705e..5189582fda9 100644
--- a/components/camel-hazelcast/src/main/docs/hazelcast-topic-component.adoc
+++ b/components/camel-hazelcast/src/main/docs/hazelcast-topic-component.adoc
@@ -55,7 +55,7 @@ from("direct:add")
The topic consumer provides only one operation (received). This
component is supposed to support multiple consumption as it's expected
-when it comes to topics so you are free to have as much consumers as you
+when it comes to topics, so you are free to have as many consumers as you
need on the same hazelcast topic.
[source,java]
(camel) 08/13: CAMEL-20410: documentation fixes for camel-hashicorp-vault
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 14387c9eb160fc059f4d50767152c69b0542ff98
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Tue Feb 20 17:51:03 2024 +0100
CAMEL-20410: documentation fixes for camel-hashicorp-vault
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
---
.../src/main/docs/hashicorp-vault-component.adoc | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/components/camel-hashicorp-vault/src/main/docs/hashicorp-vault-component.adoc b/components/camel-hashicorp-vault/src/main/docs/hashicorp-vault-component.adoc
index 55cafda3fa5..102faa24b5f 100644
--- a/components/camel-hashicorp-vault/src/main/docs/hashicorp-vault-component.adoc
+++ b/components/camel-hashicorp-vault/src/main/docs/hashicorp-vault-component.adoc
@@ -45,7 +45,7 @@ include::partial$component-endpoint-options.adoc[]
=== Using Hashicorp Vault Property Function
-To use this function you'll need to provide credentials for Hashicorp vault as environment variables:
+To use this function, you'll need to provide credentials for Hashicorp vault as environment variables:
[source,bash]
----
@@ -67,7 +67,7 @@ camel.vault.hashicorp.port = port
camel.vault.hashicorp.scheme = scheme
----
-At this point you'll be able to reference a property in the following way:
+At this point, you'll be able to reference a property in the following way:
[source,xml]
----
@@ -93,9 +93,9 @@ You could specify a default value in case the secret is not present on Hashicorp
</camelContext>
----
-In this case if the secret doesn't exist, the property will fallback to "default" as value.
+In this case, if the secret doesn't exist, the property will fall back to "default" as value.
-Also you are able to get particular field of the secret, if you have for example a secret named database of this form:
+Also, you are able to get a particular field of the secret, if you have, for example, a secret named database of this form:
[source,bash]
----
@@ -135,7 +135,7 @@ You could specify a default value in case the particular field of secret is not
</camelContext>
----
-In this case if the secret doesn't exist or the secret exists, but the username field is not part of the secret, the property will fallback to "admin" as value.
+In this case, if the secret doesn't exist or the secret exists, but the username field is not part of the secret, the property will fall back to "admin" as value.
There is also the syntax to get a particular version of the secret for both the approach, with field/default value specified or only with secret:
@@ -175,6 +175,6 @@ This approach will return the route secret value with version '2' or default val
This approach will return the username field of the database secret with version '2' or admin in case the secret doesn't exist or the version doesn't exist.
-For the moment we are not considering the rotation function, if any will be applied, but it is in the work to be done.
+For the moment we are not considering the rotation function if any are applied, but it is in the work to be done.
The only requirement is adding the camel-hashicorp-vault jar to your Camel application.
(camel) 06/13: CAMEL-20410: documentation fixes for camel-gson
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 72f677f768d61829365731985d0972318ec52117
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Tue Feb 20 17:47:50 2024 +0100
CAMEL-20410: documentation fixes for camel-gson
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
---
components/camel-gson/src/main/docs/gson-dataformat.adoc | 10 ++++------
1 file changed, 4 insertions(+), 6 deletions(-)
diff --git a/components/camel-gson/src/main/docs/gson-dataformat.adoc b/components/camel-gson/src/main/docs/gson-dataformat.adoc
index a9f672e9cc6..09a62e74895 100644
--- a/components/camel-gson/src/main/docs/gson-dataformat.adoc
+++ b/components/camel-gson/src/main/docs/gson-dataformat.adoc
@@ -11,7 +11,7 @@
*Since Camel {since}*
-Gson is a Data Format which uses the
+Gson is a Data Format that uses the
https://github.com/google/gson[Gson Library]
[source,java]
@@ -29,15 +29,13 @@ include::partial$dataformat-options.adoc[]
// dataformat options: END
-
== Dependencies
-To use Gson in your camel routes you need to add the dependency
+To use Gson in your camel routes, you need to add the dependency
on *camel-gson* which implements this data format.
-If you use maven you could just add the following to your pom.xml,
-substituting the version number for the latest & greatest release (see
-the download page for the latest versions).
+If you use maven, you could add the following to your `pom.xml`,
+substituting the version number for the latest & greatest release.
[source,xml]
----------------------------------------------------------
(camel) 07/13: CAMEL-20410: documentation fixes for camel-guava
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 27723c30de66b5b6d35fad4cb6d08694121aa5b8
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Tue Feb 20 17:49:09 2024 +0100
CAMEL-20410: documentation fixes for camel-guava
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
---
.../src/main/docs/guava-eventbus-component.adoc | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/components/camel-guava-eventbus/src/main/docs/guava-eventbus-component.adoc b/components/camel-guava-eventbus/src/main/docs/guava-eventbus-component.adoc
index 909efee34af..3ecc590b546 100644
--- a/components/camel-guava-eventbus/src/main/docs/guava-eventbus-component.adoc
+++ b/components/camel-guava-eventbus/src/main/docs/guava-eventbus-component.adoc
@@ -23,7 +23,7 @@ component provides integration bridge between Camel and
https://google.github.io/guava/releases/19.0/api/docs/com/google/common/eventbus/EventBus.html[Google
Guava EventBus] infrastructure. With the latter component, messages
exchanged with the Guava `EventBus` can be transparently forwarded to
-the Camel routes. EventBus component allows also to route body of Camel
+the Camel routes. EventBus component allows also routing the body of Camel
exchanges to the Guava `EventBus`.
Maven users will need to add the following dependency to their `pom.xml`
@@ -129,7 +129,7 @@ This drawback of this approach is that `EventBus` instance used by Camel
will never generate `com.google.common.eventbus.DeadEvent`
notifications. If you want Camel to listen only to the precisely
specified event (and therefore enable `DeadEvent` support), use
-`listenerInterface` endpoint option. Camel will create dynamic proxy
+`listenerInterface` endpoint option. Camel will create a dynamic proxy
over the interface you specify with the latter option and listen only to
messages specified by the interface handler methods. The example of the
listener interface with single method handling only `SpecificEvent`
@@ -155,9 +155,9 @@ follows.
from("guava-eventbus:busName?listenerInterface=com.example.CustomListener").to("seda:queue");
---------------------------------------------------------------------------------------------
-== Consuming multiple type of events
+== Consuming multiple types of events
-In order to define multiple type of events to be consumed by Guava
+To define multiple types of events to be consumed by Guava
EventBus consumer use `listenerInterface` endpoint option, as listener
interface could provide multiple methods marked with the `@Subscribe`
annotation.
(camel) 10/13: CAMEL-20410: documentation fixes for camel-headersmap
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 54c36e7c2cd1baf3ca5e1e0a84f3990180811753
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Tue Feb 20 18:12:57 2024 +0100
CAMEL-20410: documentation fixes for camel-headersmap
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
- Converted to use tabs
---
components/camel-headersmap/src/main/docs/headersmap.adoc | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/components/camel-headersmap/src/main/docs/headersmap.adoc b/components/camel-headersmap/src/main/docs/headersmap.adoc
index df7d08aebc5..307ceee0a69 100644
--- a/components/camel-headersmap/src/main/docs/headersmap.adoc
+++ b/components/camel-headersmap/src/main/docs/headersmap.adoc
@@ -9,7 +9,7 @@
*Since Camel {since}*
-The camel-headersmap is a faster implementation of a case-insenstive map which can be plugged in
+The Headersmap component is a faster implementation of a case-insensitive map which can be plugged in
and used by Camel at runtime to have slight faster performance in the Camel Message headers.
== Auto-detection from classpath
(camel) 12/13: CAMEL-20410: documentation fixes for camel-http
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 3b99ff3277a9e5e807d618e8393c2222f5dbf03e
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Tue Feb 20 18:23:50 2024 +0100
CAMEL-20410: documentation fixes for camel-http
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
- Converted to use tabs
---
.../camel-http/src/main/docs/http-component.adoc | 84 +++++++++++-----------
1 file changed, 43 insertions(+), 41 deletions(-)
diff --git a/components/camel-http/src/main/docs/http-component.adoc b/components/camel-http/src/main/docs/http-component.adoc
index ae341e8bd93..db3d43fe018 100644
--- a/components/camel-http/src/main/docs/http-component.adoc
+++ b/components/camel-http/src/main/docs/http-component.adoc
@@ -14,7 +14,7 @@
*{component-header}*
-The HTTP component provides HTTP based endpoints
+The HTTP component provides HTTP-based endpoints
for calling external HTTP resources (as a client to call external
servers using HTTP).
@@ -59,36 +59,36 @@ include::partial$component-endpoint-headers.adoc[]
== Message Body
-Camel will store the HTTP response from the external server on the OUT
-body. All headers from the IN message will be copied to the OUT message,
+Camel will store the HTTP response from the external server on the _OUT_ body.
+All headers from the _IN_ message will be copied to the _OUT_ message,
so headers are preserved during routing. Additionally, Camel will add the
-HTTP response headers as well to the OUT message headers.
+HTTP response headers as well to the _OUT_ message headers.
== Using System Properties
When setting useSystemProperties to true, the HTTP Client will look for
the following System Properties, and it will use it:
-* ssl.TrustManagerFactory.algorithm
-* http://javax.net/[javax.net].ssl.trustStoreType
-* http://javax.net/[javax.net].ssl.trustStore
-* http://javax.net/[javax.net].ssl.trustStoreProvider
-* http://javax.net/[javax.net].ssl.trustStorePassword
-* java.home
-* ssl.KeyManagerFactory.algorithm
-* http://javax.net/[javax.net].ssl.keyStoreType
-* http://javax.net/[javax.net].ssl.keyStore
-* http://javax.net/[javax.net].ssl.keyStoreProvider
-* http://javax.net/[javax.net].ssl.keyStorePassword
-* http.proxyHost
-* http.proxyPort
-* http.nonProxyHosts
-* http.keepAlive
-* http.maxConnections
+* `ssl.TrustManagerFactory.algorithm`
+* `javax.net.ssl.trustStoreType`
+* `javax.net.ssl.trustStore`
+* `javax.net.ssl.trustStoreProvider`
+* `javax.net.ssl.trustStorePassword`
+* `java.home`
+* `ssl.KeyManagerFactory.algorithm`
+* `javax.net.ssl.keyStoreType`
+* `javax.net.ssl.keyStore`
+* `javax.net.ssl.keyStoreProvider`
+* `javax.net.ssl.keyStorePassword`
+* `http.proxyHost`
+* `http.proxyPort`
+* `http.nonProxyHosts`
+* `http.keepAlive`
+* `http.maxConnections`
== Response code
-Camel will handle according to the HTTP response code:
+Camel will handle, according to the HTTP response code:
* Response code is in the range 100..299, Camel regards it as a success
response.
@@ -110,7 +110,7 @@ codes. This allows you to get any response from the remote server.
* The HTTP status code
* The HTTP status line (text of the status code)
-* Redirect location, if server returned a redirect
+* Redirect location if server returned a redirect
* Response body as a `java.lang.String`, if server provided a body as
response
@@ -156,7 +156,7 @@ from("direct:start")
.to("http://oldhost");
-----------------------------------------------------------
-In the sample above Camel will call the http://newhost despite the
+In the sample above, Camel will call the http://newhost despite the
endpoint is configured with http://oldhost. +
If the http endpoint is working in bridge mode, it will ignore the
message header of `Exchange.HTTP_URI`.
@@ -264,7 +264,7 @@ Properties and then the endpoint proxy options if provided.
So you can override the system properties with the endpoint options.
There is also a `http.proxyScheme` property you
-can set to explicit configure the scheme to use.
+can set to explicitly configure the scheme to use.
== Configuring charset
@@ -291,7 +291,7 @@ from("timer://foo?fixedRate=true&delay=0&period=10000")
=== URI Parameters from the endpoint URI
-In this sample we have the complete URI endpoint that is just what you
+In this sample, we have the complete URI endpoint that is just what you
would have typed in a web browser. Multiple URI parameters can of course
be set using the `&` character as separator, just as you would in the
web browser. Camel does no tricks here.
@@ -334,19 +334,19 @@ int responseCode = out.getHeader(Exchange.HTTP_RESPONSE_CODE, Integer.class);
== Disabling Cookies
-To disable cookies in the CookieStore you can set the HTTP Client to ignore cookies by
+To disable cookies in the CookieStore, you can set the HTTP Client to ignore cookies by
adding this URI option: `httpClient.cookieSpec=ignore`. This doesn't affect cookies manually set in the `Cookie` header
== Basic auth with the streaming message body
-In order to avoid the `NonRepeatableRequestException`, you need to do the
+To avoid the `NonRepeatableRequestException`, you need to do the
Preemptive Basic Authentication by adding the option: `authenticationPreemptive=true`
== OAuth2 Support
-In order to get a access token from a Authorization Server and fill that in Authorization header to do requests to protected services, you will need to use `oauth2ClientId`, `oauth2ClientSecret` and `oauth2TokenEndpoint` properties, and those should be defined as specified at RFC 6749 and provided by your Authorization Server.
+To get an access token from an Authorization Server and fill that in Authorization header to do requests to protected services, you will need to use `oauth2ClientId`, `oauth2ClientSecret` and `oauth2TokenEndpoint` properties, and those should be defined as specified at RFC 6749 and provided by your Authorization Server.
-In below example camel will do a underlying request to `https://localhost:8080/realms/master/protocol/openid-connect/token` using provided credentials (client id and client secret), then will get `access_token` from response and lastly will fill it at `Authorization` header of request which will be done to `https://localhost:9090`.
+In below example camel will do an underlying request to `https://localhost:8080/realms/master/protocol/openid-connect/token` using provided credentials (client id and client secret), then will get `access_token` from response and lastly will fill it at `Authorization` header of request which will be done to `https://localhost:9090`.
[source,java]
------------------------------------------------------------------------------------
@@ -358,13 +358,15 @@ from("direct:start")
.to("https://localhost:9090/?oauth2ClientId=" + clientId + "&oauth2ClientSecret=" + clientSecret + "&oauth2TokenEndpoint=" + tokenEndpoint);
------------------------------------------------------------------------------------
-NOTE: Camel only provide support for OAuth2 client credentials flow
+[NOTE]
+Camel only provides support for OAuth2 client credentials flow
-Important: Camel does not perform any validation in access token. It's up to the underlying service to validate it.
+[IMPORTANT]
+Camel does not perform any validation in access token. It's up to the underlying service to validate it.
== Advanced Usage
-If you need more control over the HTTP producer you should use the
+If you need more control over the HTTP producer, you should use the
`HttpComponent` where you can set various classes to give you custom
behavior.
@@ -376,7 +378,7 @@ Using the JSSE Configuration Utility
The HTTP component supports SSL/TLS configuration
through the xref:manual::camel-configuration-utilities.adoc[Camel JSSE
Configuration Utility]. This utility greatly decreases the amount of
-component specific code you need to write and is configurable at the
+component-specific code you need to write and is configurable at the
endpoint and component levels. The following examples demonstrate how
to use the utility with the HTTP component.
@@ -422,7 +424,7 @@ Spring DSL based configuration of endpoint
[[HTTP-ConfiguringApacheHTTPClientDirectly]]
Configuring Apache HTTP Client Directly
-Basically camel-http component is built on the top of
+Basically, a camel-http component is built on the top of
https://hc.apache.org/httpcomponents-client-5.1.x/[Apache HttpClient].
Please refer to
https://hc.apache.org/httpcomponents-client-4.5.x/current/tutorial/html/connmgmt.html[SSL/TLS
@@ -433,7 +435,7 @@ class. +
`org.apache.camel.component.http.HttpClientConfigurer` to do some
configuration on the http client if you need full control of it.
-However, if you _just_ want to specify the keystore and truststore you
+However, if you _just_ want to specify the keystore and truststore, you
can do this with Apache HTTP `HttpClientConfigurer`, for example:
[source,java]
@@ -447,8 +449,8 @@ registry.register(new Scheme("https", 443, new SSLSocketFactory(keystore, "mypas
And then you need to create a class that implements
`HttpClientConfigurer`, and registers https protocol providing a
-keystore or truststore per example above. Then, from your camel route
-builder class you can hook it up like so:
+keystore or truststore per the example above. Then, from your camel route
+builder class, you can hook it up like so:
[source,java]
--------------------------------------------------------------------------------------
@@ -474,7 +476,7 @@ keystore and truststore as described above, it will work fine.
[[HTTP-UsingHTTPStoauthenticategotchas]]
Using HTTPS to authenticate gotchas
-An end user reported that he had problem with authenticating with HTTPS.
+An end user reported that he had a problem with authenticating with HTTPS.
The problem was eventually resolved by providing a custom configured
`org.apache.hc.core5.http.protocol.HttpContext`:
@@ -528,11 +530,11 @@ public class HttpContextFactory {
[[HTTP-UsingdifferentSSLContextParameters]]
Using different SSLContextParameters
-The xref:http-component.adoc[HTTP] component only support one instance of
+The xref:http-component.adoc[HTTP] component only supports one instance of
`org.apache.camel.support.jsse.SSLContextParameters` per component. If you
-need to use 2 or more different instances, then you need to setup
+need to use two or more different instances, then you need to set up
multiple xref:http-component.adoc[HTTP] components as shown below. Where we have
-2 components, each using their own instance of `sslContextParameters`
+two components, each using their own instance of `sslContextParameters`
property.
[source,xml]
(camel) 05/13: CAMEL-20410: documentation fixes for camel-grpc
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 fca2a8001274a58d7a1fd71e3c9be065a6cbd177
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Tue Feb 20 17:46:37 2024 +0100
CAMEL-20410: documentation fixes for camel-grpc
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
---
.../camel-grpc/src/main/docs/grpc-component.adoc | 26 ++++++++++++----------
1 file changed, 14 insertions(+), 12 deletions(-)
diff --git a/components/camel-grpc/src/main/docs/grpc-component.adoc b/components/camel-grpc/src/main/docs/grpc-component.adoc
index 0492b5ce5de..be612887bd9 100644
--- a/components/camel-grpc/src/main/docs/grpc-component.adoc
+++ b/components/camel-grpc/src/main/docs/grpc-component.adoc
@@ -59,9 +59,9 @@ include::partial$component-endpoint-headers.adoc[]
The following https://grpc.io/docs/guides/auth.html[authentication] mechanisms are built-in to gRPC and available in this component:
* *SSL/TLS:* gRPC has SSL/TLS integration and promotes the use of SSL/TLS to authenticate the server, and to encrypt all the data exchanged between the client and the server. Optional mechanisms are available for clients to provide certificates for mutual authentication.
-* *Token-based authentication with Google:* gRPC provides a generic mechanism to attach metadata based credentials to requests and responses. Additional support for acquiring access tokens while accessing Google APIs through gRPC is provided. In general this mechanism must be used as well as SSL/TLS on the channel.
+* *Token-based authentication with Google:* gRPC provides a generic mechanism to attach metadata-based credentials to requests and responses. Additional support for acquiring access tokens while accessing Google APIs through gRPC is provided. In general, this mechanism must be used as well as SSL/TLS on the channel.
-To enable these features the following component properties combinations must be configured:
+To enable these features, the following component properties combinations must be configured:
[width="100%",cols="10%,20%,25%,15%,30%",options="header",]
|=======================================================================
@@ -84,7 +84,7 @@ To enable these features the following component properties combinations must be
== gRPC producer resource type mapping
-The table below shows the types of objects in the message body, depending on the types (simple or stream) of incoming and outgoing parameters, as well as the invocation style (synchronous or asynchronous). Please note, that invocation of the procedures with incoming stream parameter in asynchronous style are not allowed.
+The table below shows the types of objects in the message body, depending on the types (simple or stream) of incoming and outgoing parameters, as well as the invocation style (synchronous or asynchronous). Please note that invocation of the procedures with incoming stream parameter in asynchronous style is not allowed.
[width="100%",cols="15%,15%,15%,25%,25%",options="header",]
|=======================================================================
@@ -104,11 +104,11 @@ The table below shows the types of objects in the message body, depending on the
== gRPC Proxy
-It is not possible to create universal proxy-route for all methods, so you need to divide your gRPC service into several services by method's type: unary, server streaming, client streaming and bidirectional streaming.
+It is not possible to create a universal proxy-route for all methods, so you need to divide your gRPC service into several services by method's type: unary, server streaming, client streaming and bidirectional streaming.
=== Unary
-For unary requests it is enough to write the following code:
+For unary requests, it is enough to write the following code:
[source,java]
----
@@ -123,7 +123,8 @@ from("grpc://localhost:1101" +
=== Server streaming
-Server streaming may be done by the same approach as unary, but in that configuration Camel route will wait stream for completion and will aggregate all responses to list before sending that data as response stream. If this behavior is unacceptable, you need to apply a number of options:
+Server streaming may be done by the same approach as unary, but in that configuration Camel route will wait stream for completion and will aggregate all responses to a list before sending that data as response stream.
+If this behavior is unacceptable, you need to apply a number of options:
1. Set `routeControlledStreamObserver=true` for consumer. Later it will be used to publish responses;
2. Set `streamRepliesTo` option for producer to handle streaming nature of responses;
@@ -154,11 +155,12 @@ from("direct:next")
=== Client streaming and bidirectional streaming
-Both client streaming and bidirectional streaming gRPC methods exposes StreamObserver as responses handler, so you need the same technic as described in server streaming section -- all 5 steps.
+Both client streaming and bidirectional streaming gRPC methods expose `StreamObserver` as responses' handler.
+Therefore, you need the same technique as described in the server streaming section (all 5 steps).
-But there another thing -- requests also comes in streaming mode. So you need the following:
+But there is another thing: requests also come in streaming mode. So you need the following:
-1. Set consumer strategy to DELEGATION -- that differs from default PROPAGATION option in the fact that consumer will not produce responses at all. If you set PROPAGATION, then you will receive more responses than you expected;
+1. Set consumer strategy to DELEGATION -- that differs from the default PROPAGATION option in the fact that consumer will not produce responses at all. If you set PROPAGATION, then you will receive more responses than you expected;
2. Forward `onError` and `onCompletion` on consumer;
3. Set producer strategy to STREAMING.
@@ -250,11 +252,11 @@ from("direct:grpc-jwt")
== Configuration
-It is recommended to use the `protobuf-maven-plugin`, which calls the Protocol Buffer Compiler (protoc) to generate Java source files from .proto (protocol buffer definition) files. This plugin will generate procedures request and response classes, their builders and gRPC procedures stubs classes as well.
+It is recommended to use the `protobuf-maven-plugin`, which calls the Protocol Buffer Compiler (protoc) to generate Java source files from .proto (protocol buffer definition) files. This plugin will generate procedure request and response classes, their builders and gRPC procedures stubs classes as well.
-Following steps are required:
+The following steps are required:
-Insert operating system and CPU architecture detection extension inside **<build>** tag of the project pom.xml or set ${os.detected.classifier} parameter manually
+Insert operating system and CPU architecture detection extension inside **<build>** tag of the project `pom.xml` or set `${os.detected.classifier}` parameter manually
[source,xml]
-------------------------------------------------------------------------
<extensions>
(camel) 01/13: CAMEL-20410: documentation fixes for camel-grape
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 851c4cb0b279a55459b6d7bd899b9c7860590fdd
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Tue Feb 20 17:33:33 2024 +0100
CAMEL-20410: documentation fixes for camel-grape
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
---
.../camel-grape/src/main/docs/grape-component.adoc | 22 +++++++++++-----------
1 file changed, 11 insertions(+), 11 deletions(-)
diff --git a/components/camel-grape/src/main/docs/grape-component.adoc b/components/camel-grape/src/main/docs/grape-component.adoc
index f93b4a77e21..dd8126e729c 100644
--- a/components/camel-grape/src/main/docs/grape-component.adoc
+++ b/components/camel-grape/src/main/docs/grape-component.adoc
@@ -17,7 +17,7 @@
http://docs.groovy-lang.org/latest/html/documentation/grape.html[Grape]
component allows you to fetch, load and manage additional jars when
-`CamelContext` is running. In practice with Camel Grape component you
+`CamelContext` is running. In practice with the Camel Grape component you
can add new components, data formats and beans to your `CamelContext`
without the restart of the router.
@@ -53,7 +53,7 @@ import static org.apache.camel.component.grape.GrapeComponent.grapeCamelContext;
CamelContext camelContext = grapeCamelContext(new DefaultCamelContext());
--------------------------------------------------------------------------------
-You can also set up the Groovy class loader used be Camel context by
+You can also set up the Groovy class loader used by the Camel context by
yourself:
[source,java]
@@ -61,7 +61,7 @@ yourself:
camelContext.setApplicationContextClassLoader(new GroovyClassLoader(myClassLoader));
------------------------------------------------------------------------------------
-For example the following snippet loads Camel FTP component:
+For example, the following snippet loads Camel FTP component:
[source,java]
------------------------------------------------
@@ -96,16 +96,16 @@ for this component:
== Default payload type
-By default Camel Grape component operates on the String payloads:
+By default, the Camel Grape component operates on the String payloads:
[source,java]
------------------------------------------------------------------------------------------------
producerTemplate.sendBody("grape:defaultMavenCoordinates", "org.apache.camel/camel-ftp/2.15.2");
------------------------------------------------------------------------------------------------
-But of course Camel build-in xref:manual::type-converter.adoc[type conversion
+Of course, Camel build-in xref:manual::type-converter.adoc[type conversion
API] can perform the automatic data type transformations for you. In the
-example below Camel automatically converts binary payload into the
+example below, Camel automatically converts binary payload into the
String:
[source,java]
@@ -115,7 +115,7 @@ producerTemplate.sendBody("grape:defaultMavenCoordinates", "org.apache.camel/cam
== Loading components at runtime
-In order to load the new component at the router runtime, just grab the
+To load the new component at the router runtime, just grab the
jar containing the given component:
[source,java]
@@ -127,7 +127,7 @@ template.sendBody("stream:out", "msg");
== Loading processors bean at runtime
-In order to load the new processor bean with your custom business login
+To load the new processor bean with your custom business login
at the router runtime, just grab the jar containing the required bean:
[source,java]
@@ -145,7 +145,7 @@ int price = template.requestBody("bean:com.example.PricingBean?method=currentPro
After you download new jar, you usually would like to have it loaded by
the Camel again after the restart of the `CamelContext`. It is certainly
possible, as Grape component keeps track of the jar files you have
-installed. In order to load again the installed jars on the context
+installed. To load again the installed jars on the context
startup, use the `GrapeEndpoint.loadPatches()` method in your route:
@@ -170,7 +170,7 @@ camelContext.addRoutes(
== Managing the installed jars
If you would like to check what jars have been installed into the given
-`CamelContext`, send message to the grape endpoint with
+`CamelContext`, send a message to the grape endpoint with
the `CamelGrapeCommand` header set to `GrapeCommand.listPatches`:
[source,java]
@@ -180,7 +180,7 @@ from("netty-http:http://0.0.0.0:80/patches").
to("grape:list");
----------------------------------------------------------------------------------------
-Connecting the to the route defined above using the HTTP client returns
+Connecting to the route defined above using the HTTP client returns
the list of the jars installed by Grape component:
[source,bash]
(camel) 04/13: CAMEL-20410: documentation fixes for camel-groovy
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 45bd00cd868d7ffa5dbd792f1915f7a8d9f44b02
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Tue Feb 20 17:41:16 2024 +0100
CAMEL-20410: documentation fixes for camel-groovy
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
---
.../src/main/docs/groovy-language.adoc | 30 +++++++++++++---------
1 file changed, 18 insertions(+), 12 deletions(-)
diff --git a/components/camel-groovy/src/main/docs/groovy-language.adoc b/components/camel-groovy/src/main/docs/groovy-language.adoc
index 82250fd595d..26bfbc82f7b 100644
--- a/components/camel-groovy/src/main/docs/groovy-language.adoc
+++ b/components/camel-groovy/src/main/docs/groovy-language.adoc
@@ -30,19 +30,23 @@ include::partial$language-options.adoc[]
== Examples
-In the example below we use a groovy script as predicate in the message filter,
-to determine if any line items is over $100:
+In the example below, we use a groovy script as predicate in the message filter,
+to determine if any line items are over $100:
+[tabs]
+====
+
+Java::
++
[source,java]
------------------------------------------------------------------------------------------------
-// lets route if a line item is over $100
from("queue:foo")
.filter(groovy("request.lineItems.any { i -> i.value > 100 }"))
.to("queue:bar")
------------------------------------------------------------------------------------------------
-And in XML DSL:
-
+XML DSL::
++
[source,xml]
----
<route>
@@ -54,6 +58,8 @@ And in XML DSL:
</route>
----
+====
+
== Groovy Context
Camel will provide exchange information in the Groovy context (just
@@ -84,9 +90,9 @@ a `Map`). The `Exchange` is transferred as:
== How to get the result from multiple statements script
As the Groovy script engine evaluate method just return a `Null` if it runs a
-multiple statements script. Camel now look up the value of script result
-by using the key of "result" from the value set. If you have multiple
-statements script, you need to make sure you set the value of result
+multiple statements script. Camel now looks up the value of script result
+by using the key of `result` from the value set. If you have multiple
+statements scripts, you need to make sure you set the value of result
variable as the script return value.
[source,text]
@@ -125,9 +131,9 @@ custom static imports), instead of the default one.
== Loading script from external resource
You can externalize the script and have Camel load it from a resource
-such as `"classpath:"`, `"file:"`, or `"http:"`. +
- This is done using the following syntax: `"resource:scheme:location"`,
-eg to refer to a file on the classpath you can do:
+such as `"classpath:"`, `"file:"`, or `"http:"`.
+This is done using the following syntax: `"resource:scheme:location"`,
+e.g., to refer to a file on the classpath you can do:
[source,java]
-------------------------------------------------------------------
@@ -136,7 +142,7 @@ eg to refer to a file on the classpath you can do:
== Dependencies
-To use scripting languages in your camel routes you need to add a
+To use scripting languages in your camel routes, you need to add a
dependency on *camel-groovy*.
If you use Maven you could just add the following to your `pom.xml`,
(camel) 02/13: CAMEL-20410: documentation fixes for camel-graphql
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 ed27d7a49365771f10b2ccc752cce7583e3e339e
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Tue Feb 20 17:35:40 2024 +0100
CAMEL-20410: documentation fixes for camel-graphql
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
---
components/camel-graphql/src/main/docs/graphql-component.adoc | 6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)
diff --git a/components/camel-graphql/src/main/docs/graphql-component.adoc b/components/camel-graphql/src/main/docs/graphql-component.adoc
index 802be988e1e..a86aa45f431 100644
--- a/components/camel-graphql/src/main/docs/graphql-component.adoc
+++ b/components/camel-graphql/src/main/docs/graphql-component.adoc
@@ -46,7 +46,9 @@ include::partial$component-endpoint-options.adoc[]
== Message Body
-If the `variables` and `variablesHeader` parameters are not set and the IN body is a JsonObject instance, Camel will use it for the operation's variables. If the `query` and `queryFile` parameters are not set and the IN body is a String, Camel will use it as the query. Camel will store the GraphQL response from the external server on the OUT message body. All headers from the IN message will be copied to the OUT message, so headers are preserved during routing. Additionally Camel will ad [...]
+If the `variables` and `variablesHeader` parameters are not set and the IN body is a JsonObject instance, Camel will use it for the operation's variables. If the `query` and `queryFile` parameters are not set and the IN body is a String, Camel will use it as the query. Camel will store the GraphQL response from the external server on the OUT message body.
+All headers from the IN message will be copied to the OUT message, so headers are preserved during routing.
+Additionally, Camel will add the HTTP response headers as well to the OUT message headers.
== Examples
@@ -134,7 +136,7 @@ from("direct:start")
=== Mutations
-Mutations are like queries with variables. They specify a query and a reference to a variables bean:
+Mutations are like queries with variables. They specify a query and a reference to a variables' bean:
addBookMutation.graphql file: