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/21 16:02:55 UTC
(camel) branch main updated (bee957f67bc -> 6994830e967)
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 bee957f67bc CAMEL-20440: camel-jbang - Fix running jbang on windows.
new 7b35b3b1982 CAMEL-20410: documentation fixes for camel-quartz
new 3d96eb1658d CAMEL-20410: documentation fixes for camel-quickfix
new 971bdd64989 CAMEL-20410: documentation fixes for camel-reactive-executor-tomcat
new 4621d12fc3f CAMEL-20410: documentation fixes for camel-reactive-executor-vertx
new c6418d0a1fb CAMEL-20410: documentation fixes for camel-reactive-streams
new ab88a6022b7 CAMEL-20410: documentation fixes for camel-resilience4j
new 6994830e967 CAMEL-20410: documentation fixes for camel-resourceresolver-github
The 7 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
.../src/main/docs/quartz-component.adoc | 86 +++++++++++-----------
.../src/main/docs/quickfix-component.adoc | 22 +++---
.../src/main/docs/reactive-executor-tomcat.adoc | 4 +-
.../src/main/docs/reactive-executor-vertx.adoc | 14 ++--
.../src/main/docs/reactive-streams-component.adoc | 25 ++++---
.../src/main/docs/resilience4j.adoc | 4 +-
.../src/main/docs/resourceresolver-github.adoc | 6 +-
7 files changed, 82 insertions(+), 79 deletions(-)
(camel) 03/07: CAMEL-20410: documentation fixes for camel-reactive-executor-tomcat
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 971bdd64989106fb9311cdd0ad85d5bfe2a5bf6a
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Wed Feb 21 16:17:20 2024 +0100
CAMEL-20410: documentation fixes for camel-reactive-executor-tomcat
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
- Converted to use tabs
---
.../src/main/docs/reactive-executor-tomcat.adoc | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/components/camel-reactive-executor-tomcat/src/main/docs/reactive-executor-tomcat.adoc b/components/camel-reactive-executor-tomcat/src/main/docs/reactive-executor-tomcat.adoc
index 3248d01b906..12a55d20dea 100644
--- a/components/camel-reactive-executor-tomcat/src/main/docs/reactive-executor-tomcat.adoc
+++ b/components/camel-reactive-executor-tomcat/src/main/docs/reactive-executor-tomcat.adoc
@@ -10,9 +10,9 @@
*Since Camel {since}*
The `camel-reactive-executor-tomcat` is intended for users of Apache Tomcat,
-to let Camel applications shutdown cleanly when being undeployed in Apache Tomcat.
+to let Camel applications shutdown cleanly when being un-deployed in Apache Tomcat.
-== Auto detection from classpath
+== Auto-detection from classpath
To use this implementation all you need to do is to add the `camel-reactive-executor-tomcat` dependency to the classpath,
and Camel should auto-detect this on startup and log as follows:
(camel) 01/07: CAMEL-20410: documentation fixes for camel-quartz
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 7b35b3b1982ca7489059068d03dbef13c85ddb1a
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Wed Feb 21 16:14:24 2024 +0100
CAMEL-20410: documentation fixes for camel-quartz
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
- Converted to use tabs
---
.../src/main/docs/quartz-component.adoc | 86 +++++++++++-----------
1 file changed, 44 insertions(+), 42 deletions(-)
diff --git a/components/camel-quartz/src/main/docs/quartz-component.adoc b/components/camel-quartz/src/main/docs/quartz-component.adoc
index f97c3b52539..1adc0d6f233 100644
--- a/components/camel-quartz/src/main/docs/quartz-component.adoc
+++ b/components/camel-quartz/src/main/docs/quartz-component.adoc
@@ -63,12 +63,12 @@ include::partial$component-endpoint-options.adoc[]
== Configuring quartz.properties file
-By default Quartz will look for a `quartz.properties` file in the
+By default, Quartz will look for a `quartz.properties` file in the
`org/quartz` directory of the classpath. If you are using WAR
-deployments this means just drop the quartz.properties in
+deployments, this means just drop the quartz.properties in
`WEB-INF/classes/org/quartz`.
-However the Camel xref:quartz-component.adoc[Quartz] component also allows you
+However, the Camel xref:quartz-component.adoc[Quartz] component also allows you
to configure properties:
[width="100%",cols="10%,10%,10%,70%",options="header",]
@@ -80,7 +80,7 @@ to configure properties:
|`propertiesFile` |`null` |`String` |File name of the properties to load from the classpath
|===
-To do this you can configure this in Spring XML as follows
+To do this, you can configure this in Spring XML as follows
[source,xml]
----
@@ -100,12 +100,12 @@ This option is set to true by default, unless explicitly disabled.
== Clustering
-If you use Quartz in clustered mode, e.g. the `JobStore` is clustered.
+If you use Quartz in clustered mode, e.g., the `JobStore` is clustered.
Then the xref:quartz-component.adoc[Quartz] component will *not* pause/remove
triggers when a node is being stopped/shutdown. This allows the trigger
to keep running on the other nodes in the cluster.
-*Note*: When running in clustered node no checking is done to ensure
+NOTE: When running in clustered node, no checking is done to ensure
unique job name/group for endpoints.
== Message Headers
@@ -125,8 +125,8 @@ was fired.
Quartz supports
http://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html[Cron-like
expressions] for specifying timers in a handy format. You can use these
-expressions in the `cron` URI parameter; though to preserve valid URI
-encoding we allow + to be used instead of spaces.
+expressions in the `cron` URI parameter; though, to preserve valid URI
+encoding, we allow `+` to be used instead of spaces.
For example, the following will fire a message every five minutes
starting at 12pm (noon) to 6pm on weekdays:
@@ -156,7 +156,7 @@ valid URI syntax:
== Specifying time zone
The Quartz Scheduler allows you to configure time zone per trigger. For
-example to use a timezone of your country, then you can do as follows:
+example, to use a time zone of your country, then you can do as follows:
----
quartz://groupName/timerName?cron=0+0/5+12-18+?+*+MON-FRI&trigger.timeZone=Europe/Stockholm
@@ -183,7 +183,8 @@ quartz://groupName/timerName?cron=0+0/5+12-18+?+*+MON-FRI&trigger.endAt=2023-11-
----
Note: Start and end dates may be affected by time drifts and unpredictable behavior during
-daylight saving time changes. Exercise caution, especially in environments where precise timing is critical.
+daylight-saving time changes.
+Exercise caution, especially in environments where precise timing is critical.
== Configuring misfire instructions
@@ -192,18 +193,18 @@ to handle misfire situations for the trigger.
The concrete trigger type that you are using will have defined a set of additional `MISFIRE_INSTRUCTION_XXX`
constants that may be set as this property's value.
-For example to configure the simple trigger to use misfire instruction 4:
+For example, to configure the simple trigger to use misfire instruction 4:
----
quartz://myGroup/myTimerName?trigger.repeatInterval=2000&trigger.misfireInstruction=4
----
-And likewise you can configure the cron trigger with one of its misfire instructions as well:
+And likewise, you can configure the cron trigger with one of its misfire instructions as well:
----
quartz://myGroup/myTimerName?cron=0/2+*+*+*+*+?&trigger.misfireInstruction=2
----
-The simple and cron triggers has the following misfire instructions representative:
+The simple and cron triggers have the following misfire instructions representative:
=== SimpleTrigger.MISFIRE_INSTRUCTION_FIRE_NOW = 1 (default)
@@ -212,48 +213,49 @@ situation, the SimpleTrigger wants to be fired now by Scheduler.
This instruction should typically only be used for
'one-shot' (non-repeating) Triggers. If it is used on a trigger with a
-repeat count > 0 then it is equivalent to the instruction MISFIRE_INSTRUCTION_RESCHEDULE_NOW_WITH_REMAINING_REPEAT_COUNT.
+repeat count > 0, then it is equivalent to the instruction `MISFIRE_INSTRUCTION_RESCHEDULE_NOW_WITH_REMAINING_REPEAT_COUNT`.
=== SimpleTrigger.MISFIRE_INSTRUCTION_RESCHEDULE_NOW_WITH_EXISTING_REPEAT_COUNT = 2
Instructs the Scheduler that upon a mis-fire
situation, the SimpleTrigger wants to be
-re-scheduled to 'now' (even if the associated Calendar excludes 'now')
+re-scheduled to `now` (even if the associated Calendar excludes `now`)
with the repeat count left as-is. This does obey the
-Trigger end-time however, so if 'now' is after the
+Trigger end-time, however, so if `now` is after the
end-time the Trigger will not fire again.
Use of this instruction causes the trigger to 'forget'
-the start-time and repeat-count that it was originally setup with (this
-is only an issue if you for some reason wanted to be able to tell what
-the original values were at some later time).
+the start-time and repeat-count that it was originally setup with.
+This is only an issue if you for some reason wanted to be able to tell what
+the original values were at some later time.
=== SimpleTrigger.MISFIRE_INSTRUCTION_RESCHEDULE_NOW_WITH_REMAINING_REPEAT_COUNT = 3
Instructs the Scheduler that upon a mis-fire
situation, the SimpleTrigger wants to be
-re-scheduled to 'now' (even if the associated Calendar
-excludes 'now') with the repeat count set to what it would be, if it had
-not missed any firings. This does obey the Trigger end-time
-however, so if 'now' is after the end-time the Trigger will
+re-scheduled to `now` (even if the associated Calendar
+excludes `now`) with the repeat count set to what it would be, if it had
+not missed any firings.
+This does obey the Trigger end-time,
+however, so if `now` is after the end-time the Trigger will
not fire again.
Use of this instruction causes the trigger to 'forget'
the start-time and repeat-count that it was originally setup with.
Instead, the repeat count on the trigger will be changed to whatever
-the remaining repeat count is (this is only an issue if you for some
-reason wanted to be able to tell what the original values were at some
-later time).
+the remaining repeat count is.
+This is only an issue if you for some reason wanted to be able to
+tell what the original values were at some later time.
This instruction could cause the Trigger
-to go to the 'COMPLETE' state after firing 'now', if all the
+to go to the 'COMPLETE' state after firing `now`, if all the
repeat-fire-times where missed.
=== SimpleTrigger.MISFIRE_INSTRUCTION_RESCHEDULE_NEXT_WITH_REMAINING_COUNT = 4
Instructs the Scheduler that upon a mis-fire
situation, the SimpleTrigger wants to be
-re-scheduled to the next scheduled time after 'now' - taking into
+re-scheduled to the next scheduled time after `now` - taking into
account any associated Calendar and with the
repeat count set to what it would be, if it had not missed any firings.
@@ -264,7 +266,7 @@ to go directly to the 'COMPLETE' state if all fire-times where missed.
Instructs the Scheduler that upon a mis-fire
situation, the SimpleTrigger wants to be
-re-scheduled to the next scheduled time after 'now' - taking into
+re-scheduled to the next scheduled time after `now` - taking into
account any associated Calendar, and with the repeat count left unchanged.
WARNING: This instruction could cause the Trigger
@@ -279,10 +281,10 @@ situation, the CronTrigger wants to be fired now by Scheduler.
=== CronTrigger.MISFIRE_INSTRUCTION_DO_NOTHING = 2
Instructs the Scheduler that upon a mis-fire
-situation, the CronTrigger wants to have it's
+situation, the CronTrigger wants to have its
next-fire-time updated to the next time in the schedule after the
-current time (taking into account any associated Calendar
-but it does not want to be fired now.
+current time (taking into account any associated Calendar.
+However, it does not want to be fired now.
== Using QuartzScheduledPollConsumerScheduler
@@ -290,11 +292,11 @@ but it does not want to be fired now.
The xref:quartz-component.adoc[Quartz] component provides a
Polling Consumer scheduler which allows to
use cron based scheduling for xref:eips:polling-consumer.adoc[Polling
-Consumer] such as the File and FTP
+Consumers] such as the File and FTP
consumers.
-For example to use a cron based expression to poll for files every 2nd
-second, then a Camel route can be define simply as:
+For example, to use a cron based expression to poll for files every second
+second, then a Camel route can be defined simply as:
[source,java]
----
@@ -303,22 +305,22 @@ second, then a Camel route can be define simply as:
----
Notice we define the `scheduler=quartz` to instruct Camel to use the
-xref:quartz-component.adoc[Quartz] based scheduler. Then we use `scheduler.xxx`
-options to configure the scheduler. The xref:quartz-component.adoc[Quartz]
-scheduler requires the cron option to be set.
+xref:quartz-component.adoc[Quartz-based] scheduler.
+Then we use `scheduler.xxx` options to configure the scheduler.
+The xref:quartz-component.adoc[Quartz] scheduler requires the cron option to be set.
-The following options is supported:
+The following options are supported:
[width="100%",cols="10%,10%,10%,70%",options="header",]
|===
|Parameter |Default |Type |Description
-|`quartzScheduler` |`null` |`org.quartz.Scheduler` |To use a custom Quartz scheduler. If none configure then the shared
+|`quartzScheduler` |`null` |`org.quartz.Scheduler` |To use a custom Quartz scheduler. If none is configured, then the shared
scheduler from the xref:quartz-component.adoc[Quartz] component is used.
|`cron` |`null` |`String` |*Mandatory*: To define the cron expression for triggering the polls.
-|`triggerId` |`null` |`String` |To specify the trigger id. If none provided then an UUID is generated
+|`triggerId` |`null` |`String` |To specify the trigger id. If none is provided, then a UUID is generated
and used.
|`triggerGroup` |`QuartzScheduledPollConsumerScheduler` |`String` |To specify the trigger group.
@@ -328,7 +330,7 @@ and used.
*Important:* Remember configuring these options from the endpoint
URIs must be prefixed with `scheduler.`.
-For example to configure the trigger id and group:
+For example, to configure the trigger id and group:
[source,java]
----
(camel) 06/07: CAMEL-20410: documentation fixes for camel-resilience4j
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 ab88a6022b7ef58e4318730dff4ae75bf5ea3988
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Wed Feb 21 16:27:39 2024 +0100
CAMEL-20410: documentation fixes for camel-resilience4j
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
- Converted to use tabs
---
components/camel-resilience4j/src/main/docs/resilience4j.adoc | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/components/camel-resilience4j/src/main/docs/resilience4j.adoc b/components/camel-resilience4j/src/main/docs/resilience4j.adoc
index 7917704f610..194d5fde36f 100644
--- a/components/camel-resilience4j/src/main/docs/resilience4j.adoc
+++ b/components/camel-resilience4j/src/main/docs/resilience4j.adoc
@@ -11,9 +11,9 @@
*Since Camel {since}*
-This component supports the Circuit Breaker EIP with the Resilience4j library.
+This component supports the Circuit Breaker EIP with the https://resilience4j.readme.io/[Resilience4j] library.
-For more details see the Circuit Breaker EIP documentation.
+For more details, see the xref:eips:circuitBreaker-eip.adoc[Circuit Breaker EIP] documentation.
Maven users will need to add the following dependency to their `pom.xml`
for this component:
(camel) 05/07: CAMEL-20410: documentation fixes for camel-reactive-streams
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 c6418d0a1fbc0a6aea20be164e362f1752ad70d6
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Wed Feb 21 16:25:00 2024 +0100
CAMEL-20410: documentation fixes for camel-reactive-streams
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
- Converted to use tabs
---
.../src/main/docs/reactive-streams-component.adoc | 25 +++++++++++-----------
1 file changed, 13 insertions(+), 12 deletions(-)
diff --git a/components/camel-reactive-streams/src/main/docs/reactive-streams-component.adoc b/components/camel-reactive-streams/src/main/docs/reactive-streams-component.adoc
index a23571c9c54..49f032bbced 100644
--- a/components/camel-reactive-streams/src/main/docs/reactive-streams-component.adoc
+++ b/components/camel-reactive-streams/src/main/docs/reactive-streams-component.adoc
@@ -77,7 +77,7 @@ The library is aimed to support all the communication modes needed by an applica
* *Process* data flowing from a Camel route using a reactive processing step (In-Out from Camel)
== Getting data from Camel
-In order to subscribe to data flowing from a Camel route, exchanges should be redirected to
+To subscribe to data flowing from a Camel route, exchanges should be redirected to
a named stream, like in the following snippet:
[source,java]
@@ -166,7 +166,7 @@ Flowable.interval(1, TimeUnit.SECONDS)
.subscribe(elements);
---------------------------------------------------------
-String items are generated every second by RxJava in the example and they are pushed into the Camel route defined above.
+String items are generated every second by RxJava in the example, and they are pushed into the Camel route defined above.
=== Sending data to Camel using the direct API
@@ -184,7 +184,8 @@ Flowable.just("hello", "world")
== Request a transformation to Camel
Routes defined in some Camel DSL can be used within a reactive stream framework to perform a
-specific transformation (the same mechanism can be also used to eg. just send data to a _http_ endpoint and continue).
+specific transformation.
+The same mechanism can be also used to e.g., send data to an _http_ endpoint and continue.
The following snippet shows how RxJava functional code can request the task of loading and marshalling files to Camel.
@@ -210,7 +211,7 @@ from("reactive-streams:readAndMarshal")
=== Request a transformation to Camel using the direct API
-An alternative approach consists in using the URI endpoints directly in the reactive flow:
+An alternative approach consists of using the URI endpoints directly in the reactive flow:
[source,java]
---------------------------------------------------------
@@ -224,8 +225,8 @@ Flowable.just(new File("file1.txt"), new File("file2.txt"))
.subscribe();
---------------------------------------------------------
-When using the _to()_ method instead of the _toStream_, there is no need to define the
-route using "reactive-streams:" endpoints (although they are used under the hood).
+When using the `to()` method instead of the `toStream`, there is no need to define the
+route using `reactive-streams:` endpoints (although they are used under the hood).
In this case, the Camel transformation can be just:
@@ -239,7 +240,7 @@ from("direct:process")
== Process Camel data into the reactive framework
While a reactive streams _Publisher_ allows exchanging data in a unidirectional way,
-Camel routes often use a in-out exchange pattern (eg. to define REST endpoints and, in general,
+Camel routes often use an in-out exchange pattern (e.g., to define REST endpoints and, in general,
where a reply is needed for each request).
In these circumstances, users can add a reactive processing step to the flow, to enhance a Camel route or to
@@ -255,7 +256,7 @@ from("timer:clock")
.log("Continue with Camel route... n=${body}");
---------------------------------------------------------
-A reactive processing step can be associated to the "direct:reactive" endpoint:
+A reactive processing step can be associated with the "direct:reactive" endpoint:
[source,java]
---------------------------------------------------------
@@ -289,7 +290,7 @@ See Camel examples (*camel-example-reactive-streams*) for details.
When routing Camel exchanges to an external subscriber, backpressure is handled by an internal buffer that caches exchanges
before delivering them.
-If the subscriber is slower than the exchange rate, the buffer may become too big. In many circumstances this must be avoided.
+If the subscriber is slower than the exchange rate, the buffer may become too big. In many circumstances, this must be avoided.
Considering the following route:
@@ -320,9 +321,9 @@ When more than `10` messages are in flight, the route is suspended, waiting for
With this mechanism, the subscriber controls the route suspension/resume automatically, through backpressure.
When multiple subscribers are consuming items from the same stream, the slowest one controls the route status automatically.
-In other circumstances, eg. when using a `http` consumer, the route suspension makes the http service unavailable, so
+In other circumstances, e.g., when using a `http` consumer, the route suspension makes the http service unavailable, so
using the default configuration (no policy, unbounded buffer) should be preferable. Users should try to avoid memory issues
-by limiting the number of requests to the http service (eg. scaling out).
+by limiting the number of requests to the http service (e.g., scaling out).
In contexts where a certain amount of data loss is acceptable, setting a backpressure strategy other than `BUFFER` can
be a solution for dealing with fast sources.
@@ -333,7 +334,7 @@ from("direct:thermostat")
.to("reactive-streams:flow?backpressureStrategy=LATEST");
---------------------------------------------------------
-When the `LATEST` backpressure strategy is used, only the last exchange received from the route is kept by the publisher, while older data is discarded (other options are available).
+When the `LATEST` backpressure strategy is used, the publisher keeps only the last exchange received from the route, while older data is discarded (other options are available).
=== Controlling Backpressure (consumer side)
(camel) 04/07: CAMEL-20410: documentation fixes for camel-reactive-executor-vertx
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 4621d12fc3fbd45db80b4749e312261933540640
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Wed Feb 21 16:18:57 2024 +0100
CAMEL-20410: documentation fixes for camel-reactive-executor-vertx
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
- Converted to use tabs
---
.../src/main/docs/reactive-executor-vertx.adoc | 14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)
diff --git a/components/camel-reactive-executor-vertx/src/main/docs/reactive-executor-vertx.adoc b/components/camel-reactive-executor-vertx/src/main/docs/reactive-executor-vertx.adoc
index 732d2d90681..86cb58bef39 100644
--- a/components/camel-reactive-executor-vertx/src/main/docs/reactive-executor-vertx.adoc
+++ b/components/camel-reactive-executor-vertx/src/main/docs/reactive-executor-vertx.adoc
@@ -11,21 +11,21 @@
The camel-reactive-executor-vertx is a VertX based implementation of the `ReactiveExecutor` SPI.
-By default Camel uses its own reactive engine for routing messages, but you can plugin
-different engines via a SPI interface. This is a VertX based plugin that uses the VertX event loop
-for processing message during routing.
+By default, Camel uses its own reactive engine for routing messages, but you can plug in
+different engines via an SPI interface.
+This is a VertX based plugin that uses the VertX event loop for processing messages during routing.
[NOTE]
====
-At this time this component is an experiment so use it with care.
+At this time, this component is an experiment so use it with care.
====
== VertX instance
-This implementation will first lookup in the registry for an existing `io.vertx.core.Vertx` to be used.
-However you can configure an existing instance using the getter/setter on the `VertXReactiveExecutor` class.
+This implementation will first look up in the registry for an existing `io.vertx.core.Vertx` to be used.
+However, you can configure an existing instance using the getter/setter on the `VertXReactiveExecutor` class.
-== Auto detection from classpath
+== Auto-detection from classpath
To use this implementation all you need to do is to add the `camel-reactive-executor-vertx` dependency to the classpath,
and Camel should auto-detect this on startup and log as follows:
(camel) 07/07: CAMEL-20410: documentation fixes for camel-resourceresolver-github
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 6994830e967c16d7333fb40240fa71ddc425fec3
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Wed Feb 21 16:28:55 2024 +0100
CAMEL-20410: documentation fixes for camel-resourceresolver-github
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
- Converted to use tabs
---
.../src/main/docs/resourceresolver-github.adoc | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/components/camel-resourceresolver-github/src/main/docs/resourceresolver-github.adoc b/components/camel-resourceresolver-github/src/main/docs/resourceresolver-github.adoc
index fbb6bc0eb3c..cac836d07db 100644
--- a/components/camel-resourceresolver-github/src/main/docs/resourceresolver-github.adoc
+++ b/components/camel-resourceresolver-github/src/main/docs/resourceresolver-github.adoc
@@ -9,7 +9,7 @@
*Since Camel {since}*
-A pluggable resource resolver that allows to load files from github over the internet via `https` protocol.
+A pluggable resource resolver that allows to load files from GitHub over the internet via `https` protocol.
The syntax is
@@ -18,7 +18,7 @@ The syntax is
github:organization:repository:branch:filename
----
-The default branch is `main` so if you want to load from this branch you can use a shorter syntax
+The default branch is `main` so if you want to load from this branch, you can use a shorter syntax
[source,text]
----
@@ -32,7 +32,7 @@ For example to load: `https://github.com/apache/camel-kamelets/blob/main/kamelet
github:apache:camel-kamelets:main:kamelets/aws-ddb-streams-source.kamelet.yaml
----
-Because the file is in the main branch we can omit this:
+Because the file is in the main branch, we can omit this:
[source,text]
----
(camel) 02/07: CAMEL-20410: documentation fixes for camel-quickfix
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 3d96eb1658d7789e6b6978fba24d290a55ed4a28
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Wed Feb 21 16:16:24 2024 +0100
CAMEL-20410: documentation fixes for camel-quickfix
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
- Converted to use tabs
---
.../src/main/docs/quickfix-component.adoc | 22 +++++++++++-----------
1 file changed, 11 insertions(+), 11 deletions(-)
diff --git a/components/camel-quickfix/src/main/docs/quickfix-component.adoc b/components/camel-quickfix/src/main/docs/quickfix-component.adoc
index e9ed1d633db..5a5df798493 100644
--- a/components/camel-quickfix/src/main/docs/quickfix-component.adoc
+++ b/components/camel-quickfix/src/main/docs/quickfix-component.adoc
@@ -15,7 +15,7 @@
*{component-header}*
The Quickfix component adapts the
-http://www.quickfixj.org/[QuickFIX/J] FIX engine for using in Camel .
+http://www.quickfixj.org/[QuickFIX/J] FIX engine for using in Camel.
This component uses the standard http://www.fixprotocol.org/[Financial
Interchange (FIX) protocol] for message transport.
@@ -48,9 +48,9 @@ the sessionID is:
(BeginString):(SenderCompID)[/(SenderSubID)[/(SenderLocationID)]]->(TargetCompID)[/(TargetSubID)[/(TargetLocationID)]]
----
-The optional *lazyCreateEngine* parameter allows to
-create QuickFIX/J engine on demand. Value *true* means the engine is
-started when first message is send or there's consumer configured in
+The optional *lazyCreateEngine* parameter allows
+creating QuickFIX/J engine on demand. Value *true* means the engine is
+started when the first message is sent or there's consumer configured in
route definition. When **false** value is used, the engine is started at
the endpoint creation. When this parameter is missing, the value of
component's property *lazyCreateEngines* is being used.
@@ -69,16 +69,16 @@ quickfix:config.cfg?sessionID=FIX.4.2:MyTradingCompany->SomeExchange&lazyCreateE
FIX sessions are endpoints for the *quickfix* component. An endpoint URI
may specify a single session or all sessions managed by a specific
-QuickFIX/J engine. Typical applications will use only one FIX engine but
+QuickFIX/J engine. Typical applications will use only one FIX engine, but
advanced users may create multiple FIX engines by referencing different
configuration files in *quickfix* component endpoint URIs.
When a consumer does not include a session ID in the endpoint URI, it
will receive exchanges for all sessions managed by the FIX engine
associated with the configuration file specified in the URI. If a
-producer does not specify a session in the endpoint URI then it must
+producer does not specify a session in the endpoint URI, then it must
include the session-related fields in the FIX message being sent. If a
-session is specified in the URI then the component will automatically
+session is specified in the URI, then the component will automatically
inject the session-related fields into the FIX message.
// component-configure options: START
@@ -107,10 +107,10 @@ receiving a message string, the FIX engine can properly parse the data.
== QuickFIX/J Configuration Extensions
When using QuickFIX/J directly, one typically writes code to create
-instances of logging adapters, message stores and communication
+instances of logging adapters, message stores, and communication
connectors. The *quickfix* component will automatically create instances
of these classes based on information in the configuration file. It also
-provides defaults for many of the common required settings and adds
+provides defaults for many of the commonly required settings and adds
additional capabilities (like the ability to activate JMX support).
The following sections describe how the *quickfix* component processes
@@ -122,7 +122,7 @@ user manual].
=== Communication Connectors
When the component detects an initiator or acceptor session setting in
-the QuickFIX/J configuration file it will automatically create the
+the QuickFIX/J configuration file, it will automatically create the
corresponding initiator and/or acceptor connector. These settings can be
in the default or in a specific session section of the configuration
file.
@@ -389,7 +389,7 @@ body is modified when sending a logon message
the counterparty. It is important that the outgoing logon message is
being processed __synchronously__. If it is processed asynchronously (on
another thread), the FIX engine will immediately send the unmodified
-outgoing message when it's callback method returns.
+outgoing message when its callback method returns.
== FIX Sequence Number Management