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
The following commit(s) were added to refs/heads/main by this push:
new 6cea97a9a82 CAMEL-21040: more documentation fixes
6cea97a9a82 is described below
commit 6cea97a9a822ba531716f08663781ed98ae05853
Author: Otavio Rodolfo Piske <[email protected]>
AuthorDate: Fri Aug 2 14:59:24 2024 +0200
CAMEL-21040: more documentation fixes
- grammar
- typos
---
.../main/camel-main-configuration-metadata.json | 2 +-
.../org/apache/camel/catalog/schemas/camel-spring.xsd | 10 +++++-----
.../src/main/docs/camel-report-maven-plugin.adoc | 2 +-
components/camel-jms/src/main/docs/jms-component.adoc | 6 +++---
.../camel-mongodb/src/main/docs/mongodb-component.adoc | 2 +-
.../camel-saxon/src/main/docs/xquery-component.adoc | 2 +-
.../camel-saxon/src/main/docs/xquery-language.adoc | 4 ++--
components/camel-sql/src/main/docs/sql-component.adoc | 2 +-
.../camel-xpath/src/main/docs/xpath-language.adoc | 2 +-
.../src/main/docs/xslt-saxon-component.adoc | 2 +-
.../camel-xslt/src/main/docs/xslt-component.adoc | 2 +-
.../src/main/docs/modules/eips/pages/choice-eip.adoc | 2 +-
.../docs/modules/eips/pages/dead-letter-channel.adoc | 2 +-
.../org/apache/camel/core/xml/routeController.json | 2 +-
.../camel/core/xml/CamelRouteControllerDefinition.java | 8 ++++----
.../META-INF/camel-main-configuration-metadata.json | 2 +-
core/camel-main/src/main/docs/main.adoc | 2 +-
.../main/RouteControllerConfigurationProperties.java | 18 +++++++++---------
.../user-manual/modules/ROOT/pages/backlog-tracer.adoc | 2 +-
.../modules/ROOT/pages/camel-3x-upgrade-guide-3_5.adoc | 2 +-
.../modules/ROOT/pages/camel-3x-upgrade-guide-3_9.adoc | 2 +-
.../modules/ROOT/pages/camel-report-maven-plugin.adoc | 2 +-
docs/user-manual/modules/ROOT/pages/error-handler.adoc | 8 ++++----
docs/user-manual/modules/ROOT/pages/jmx.adoc | 2 +-
docs/user-manual/modules/ROOT/pages/oncompletion.adoc | 2 +-
.../modules/ROOT/pages/release-guide-website.adoc | 2 +-
.../modules/ROOT/pages/threading-model.adoc | 2 +-
.../modules/ROOT/pages/using-propertyplaceholder.adoc | 2 +-
.../faq/pages/how-do-i-restart-camelcontext.adoc | 2 +-
...thrown-exception-during-processing-an-exchange.adoc | 4 ++--
.../pages/how-do-i-retry-failed-messages-forever.adoc | 2 +-
.../src/main/docs/java-xml-io-dsl.adoc | 2 +-
.../src/main/docs/java-xml-jaxb-dsl.adoc | 2 +-
33 files changed, 55 insertions(+), 55 deletions(-)
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/main/camel-main-configuration-metadata.json
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/main/camel-main-configuration-metadata.json
index 70262ec7595..a9ec26761cf 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/main/camel-main-configuration-metadata.json
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/main/camel-main-configuration-metadata.json
@@ -249,7 +249,7 @@
{ "name": "camel.routecontroller.backOffMaxDelay", "description": "Backoff
maximum delay in millis when restarting a route that failed to startup.",
"sourceType": "org.apache.camel.main.RouteControllerConfigurationProperties",
"type": "integer", "javaType": "long" },
{ "name": "camel.routecontroller.backOffMaxElapsedTime", "description":
"Backoff maximum elapsed time in millis, after which the backoff should be
considered exhausted and no more attempts should be made.", "sourceType":
"org.apache.camel.main.RouteControllerConfigurationProperties", "type":
"integer", "javaType": "long" },
{ "name": "camel.routecontroller.backOffMultiplier", "description":
"Backoff multiplier to use for exponential backoff. This is used to extend the
delay between restart attempts.", "sourceType":
"org.apache.camel.main.RouteControllerConfigurationProperties", "type":
"number", "javaType": "double" },
- { "name": "camel.routecontroller.enabled", "description": "To enable using
supervising route controller which allows Camel to startup and then the
controller takes care of starting the routes in a safe manner. This can be used
when you want to startup Camel despite a route may otherwise fail fast during
startup and cause Camel to fail to startup as well. By delegating the route
startup to the supervising route controller then its manages the startup using
a background thread. The con [...]
+ { "name": "camel.routecontroller.enabled", "description": "To enable using
supervising route controller which allows Camel to start up and then, the
controller takes care of starting the routes in a safe manner. This can be used
when you want to start up Camel despite a route may otherwise fail fast during
startup and cause Camel to fail to start up as well. By delegating the route
startup to the supervising route controller, then it manages the startup using
a background thread. The [...]
{ "name": "camel.routecontroller.excludeRoutes", "description": "Pattern
for filtering routes to be excluded as supervised. The pattern is matching on
route id, and endpoint uri for the route. Multiple patterns can be separated by
comma. For example to exclude all JMS routes, you can say jms:. And to exclude
routes with specific route ids mySpecialRoute,myOtherSpecialRoute. The pattern
supports wildcards and uses the matcher from
org.apache.camel.support.PatternHelper#matchPattern.", [...]
{ "name": "camel.routecontroller.includeRoutes", "description": "Pattern
for filtering routes to be included as supervised. The pattern is matching on
route id, and endpoint uri for the route. Multiple patterns can be separated by
comma. For example to include all kafka routes, you can say kafka:. And to
include routes with specific route ids myRoute,myOtherRoute. The pattern
supports wildcards and uses the matcher from
org.apache.camel.support.PatternHelper#matchPattern.", "sourceTy [...]
{ "name": "camel.routecontroller.initialDelay", "description": "Initial
delay in milli seconds before the route controller starts, after CamelContext
has been started.", "sourceType":
"org.apache.camel.main.RouteControllerConfigurationProperties", "type":
"integer", "javaType": "long" },
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/schemas/camel-spring.xsd
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/schemas/camel-spring.xsd
index c9069365302..a870e8b3dc7 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/schemas/camel-spring.xsd
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/schemas/camel-spring.xsd
@@ -3042,11 +3042,11 @@ If the location is optional. Default value: false
<xs:annotation>
<xs:documentation xml:lang="en">
<![CDATA[
-To enable using supervising route controller which allows Camel to startup and
then the controller takes care of
-starting the routes in a safe manner. This can be used when you want to
startup Camel despite a route may otherwise fail
-fast during startup and cause Camel to fail to startup as well. By delegating
the route startup to the supervising route
-controller then its manages the startup using a background thread. The
controller allows to be configured with various
-settings to attempt to restart failing routes. Default value: false
+To enable using supervising route controller which allows Camel to start up
and then, the controller takes care of
+starting the routes in a safe manner. This can be used when you want to start
up Camel despite a route may otherwise
+fail fast during startup and cause Camel to fail to start up as well. By
delegating the route startup to the supervising
+route controller then its manages the startup using a background thread. The
controller allows to be configured with
+various settings to attempt to restart failing routes. Default value: false
]]>
</xs:documentation>
</xs:annotation>
diff --git
a/catalog/camel-report-maven-plugin/src/main/docs/camel-report-maven-plugin.adoc
b/catalog/camel-report-maven-plugin/src/main/docs/camel-report-maven-plugin.adoc
index c0cf076b7c2..5449d947d3d 100644
---
a/catalog/camel-report-maven-plugin/src/main/docs/camel-report-maven-plugin.adoc
+++
b/catalog/camel-report-maven-plugin/src/main/docs/camel-report-maven-plugin.adoc
@@ -358,7 +358,7 @@ The maven plugin *coverage* goal supports the following
options which can be con
| excludes | | To filter the names of java and xml files to exclude files
matching any of the given list of
patterns (wildcard and regular expression). Multiple values can be separated
by comma.
| anonymousRoutes | false | Whether to allow anonymous routes (routes without
any route id assigned).
- By using route id's then its safer to match the route cover data with the
route source code.
+ By using route id's then it is safer to match the route cover data with the
route source code.
Anonymous routes are less safe to use for route coverage as its harder to
know exactly which route
that was tested corresponds to which of the routes from the source code.
| generateJacocoXmlReport | false | Whether to generate a coverage-report in
Jacoco XML format. When enabled it will generate the file:
`target/site/jacoco/xmlJacoco.xml`
diff --git a/components/camel-jms/src/main/docs/jms-component.adoc
b/components/camel-jms/src/main/docs/jms-component.adoc
index 6f042d9f2f7..48232ba3095 100644
--- a/components/camel-jms/src/main/docs/jms-component.adoc
+++ b/components/camel-jms/src/main/docs/jms-component.adoc
@@ -1062,12 +1062,12 @@ we wait for a return reply:
== Sending an InOnly message and keeping the JMSReplyTo header
When sending to a xref:jms-component.adoc[JMS] destination using *camel-jms*,
the
-producer will use the MEP to detect if its _InOnly_ or _InOut_ messaging.
-However, there can be times when you want to send an _InOnly_ message but
+producer will use the MEP to detect if it is `InOnly` or `InOut` messaging.
+However, there can be times when you want to send an `InOnly` message but
keeping the `JMSReplyTo` header. To do so, you have to instruct Camel to
keep it, otherwise the `JMSReplyTo` header will be dropped.
-For example, to send an _InOnly_ message to the foo queue, but with a
+For example, to send an `InOnly` message to the foo queue, but with a
`JMSReplyTo` with bar queue you can do as follows:
[source,java]
diff --git a/components/camel-mongodb/src/main/docs/mongodb-component.adoc
b/components/camel-mongodb/src/main/docs/mongodb-component.adoc
index f9df1a90c84..f993836f74e 100644
--- a/components/camel-mongodb/src/main/docs/mongodb-component.adoc
+++ b/components/camel-mongodb/src/main/docs/mongodb-component.adoc
@@ -145,7 +145,7 @@ from("direct:findById")
.to("mock:resultFindById");
------------------------------------------------------------------------------
-Please, note that the default _id is treated by Mongo as and `ObjectId` type,
so you may need to convert it properly.
+Please note that the default _id is treated by Mongo as and `ObjectId` type,
so you may need to convert it properly.
[source,java]
------------------------------------------------------------------------------
diff --git a/components/camel-saxon/src/main/docs/xquery-component.adoc
b/components/camel-saxon/src/main/docs/xquery-component.adoc
index e2ff2c7d3c0..56d1691fdd5 100644
--- a/components/camel-saxon/src/main/docs/xquery-component.adoc
+++ b/components/camel-saxon/src/main/docs/xquery-component.adoc
@@ -74,7 +74,7 @@ the variable which name is out.headers.foo variable
|*key name* |Object |Any exchange.properties and exchange.in.headers and any
additional
parameters set using `setParameters(Map)`. These parameters are added
with their own key name, for instance, if there is an IN header with the
-key name *foo* then its added as *foo*.
+key name *foo* then it is added as *foo*.
|=======================================================================
== Using XML configuration
diff --git a/components/camel-saxon/src/main/docs/xquery-language.adoc
b/components/camel-saxon/src/main/docs/xquery-language.adoc
index 4a34bf41b92..207f6a860fb 100644
--- a/components/camel-saxon/src/main/docs/xquery-language.adoc
+++ b/components/camel-saxon/src/main/docs/xquery-language.adoc
@@ -43,7 +43,7 @@ the variable which name is `out.headers.foo` variable
|*key name* |Object |Any `exchange.properties` and `exchange.in.headers` and
any additional
parameters set using `setParameters(Map)`. These parameters are added
with their own key name, for instance, if there is an IN header with the
-key name *foo* then its added as *foo*.
+key name *foo* then it is added as *foo*.
|=======================================================================
== Example
@@ -113,7 +113,7 @@ Namespaces ns = new Namespaces("c",
"http://acme.com/cheese";)
.add("b", "http://acme.com/beer";);
----
-When using namespaces in XML DSL then its different, as you set up the
namespaces
+When using namespaces in XML DSL then it is different, as you set up the
namespaces
in the XML root tag (or one of the `camelContext`, `routes`, `route` tags).
In the XML example below we use Spring XML where the namespace is declared in
the root tag `beans`,
diff --git a/components/camel-sql/src/main/docs/sql-component.adoc
b/components/camel-sql/src/main/docs/sql-component.adoc
index f9bb3b9c37b..f99fff1ac8e 100644
--- a/components/camel-sql/src/main/docs/sql-component.adoc
+++ b/components/camel-sql/src/main/docs/sql-component.adoc
@@ -63,7 +63,7 @@ sql:select * from table where id=:#myId order by
name[?options]
When using named parameters, Camel will look up the names in the given
precedence:
1. from a xref:languages:simple-language.adoc[Simple] expressions
-2. from message body if its a `java.util.Map`
+2. from message body if it is a `java.util.Map`
3. from message headers
4. from exchange variables
diff --git a/components/camel-xpath/src/main/docs/xpath-language.adoc
b/components/camel-xpath/src/main/docs/xpath-language.adoc
index 0ce3a283819..9fe3011c1ba 100644
--- a/components/camel-xpath/src/main/docs/xpath-language.adoc
+++ b/components/camel-xpath/src/main/docs/xpath-language.adoc
@@ -255,7 +255,7 @@ Namespaces ns = new Namespaces("c",
"http://acme.com/cheese";)
.add("b", "http://acme.com/beer";);
----
-When using namespaces in XML DSL then its different, as you set up the
namespaces
+When using namespaces in XML DSL then it is different, as you set up the
namespaces
in the XML root tag (or one of the `camelContext`, `routes`, `route` tags).
In the XML example below we use Spring XML where the namespace is declared in
the root tag `beans`,
diff --git
a/components/camel-xslt-saxon/src/main/docs/xslt-saxon-component.adoc
b/components/camel-xslt-saxon/src/main/docs/xslt-saxon-component.adoc
index bcc2ceb2752..07067719d2b 100644
--- a/components/camel-xslt-saxon/src/main/docs/xslt-saxon-component.adoc
+++ b/components/camel-xslt-saxon/src/main/docs/xslt-saxon-component.adoc
@@ -221,7 +221,7 @@ to use, instead of referring to a file as the example from
above.
TIP: You can set `contentCache=false` and refer to a non-existing template,
such as `"xslt-saxon:dummy.xsl?contentCache=false&allowTemplateFromHeader=true"`
as this will tell Camel to not load `dummy.xsl` on startup but to load the
stylesheet on demand. And because you
-provide the stylesheet via headers, then its fully dynamic.
+provide the stylesheet via headers, then it is fully dynamic.
== Accessing warnings, errors and fatalErrors from XSLT ErrorListener
diff --git a/components/camel-xslt/src/main/docs/xslt-component.adoc
b/components/camel-xslt/src/main/docs/xslt-component.adoc
index e2407f380dc..d1f2bb0f5ad 100644
--- a/components/camel-xslt/src/main/docs/xslt-component.adoc
+++ b/components/camel-xslt/src/main/docs/xslt-component.adoc
@@ -185,7 +185,7 @@ to use, instead of referring to a file as the example from
above.
TIP: You can set `contentCache=false` and refer to a non-existing template,
such as `"xslt:dummy.xsl?contentCache=false&allowTemplateFromHeader=true"`
as this will tell Camel to not load `dummy.xsl` on startup but to load the
stylesheet on demand. And because you
-provide the stylesheet via headers, then its fully dynamic.
+provide the stylesheet via headers, then it is fully dynamic.
== Accessing warnings, errors and fatalErrors from XSLT ErrorListener
diff --git
a/core/camel-core-engine/src/main/docs/modules/eips/pages/choice-eip.adoc
b/core/camel-core-engine/src/main/docs/modules/eips/pages/choice-eip.adoc
index c869dfb0274..07293db41c2 100644
--- a/core/camel-core-engine/src/main/docs/modules/eips/pages/choice-eip.adoc
+++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/choice-eip.adoc
@@ -206,7 +206,7 @@ is great to use with the Choice EIP in precondition mode to
select a specific br
on xref:manual:ROOT:using-propertyplaceholder.adoc[property placeholders].
Here we select from the Switch the first predicate that matches. So if there is
-a property placeholder with the key `foo` then its select, and so on.
+a property placeholder with the key `foo` then it is selected, and so on.
Notice how we can use `{{?foo}}` to mark the property placeholder as optional.
[tabs]
diff --git
a/core/camel-core-engine/src/main/docs/modules/eips/pages/dead-letter-channel.adoc
b/core/camel-core-engine/src/main/docs/modules/eips/pages/dead-letter-channel.adoc
index 3bcf96669cb..53937691179 100644
---
a/core/camel-core-engine/src/main/docs/modules/eips/pages/dead-letter-channel.adoc
+++
b/core/camel-core-engine/src/main/docs/modules/eips/pages/dead-letter-channel.adoc
@@ -77,7 +77,7 @@ When fully implemented, then configuring error handler in
Java and XML DSL would
=== Redelivery
-It is common for a temporary outage or database deadlock to cause a message to
fail to process; but the chances are if its tried a few more times with some
time delay then it will complete fine.
+It is common for a temporary outage or database deadlock to cause a message to
fail to process; but the chances are if it is tried a few more times with some
time delay then it will complete fine.
So we typically wish to use some kind of redelivery policy to decide how many
times to try to redeliver a message and how long to wait before redelivery
attempts.
The
diff --git
a/core/camel-core-xml/src/generated/resources/META-INF/org/apache/camel/core/xml/routeController.json
b/core/camel-core-xml/src/generated/resources/META-INF/org/apache/camel/core/xml/routeController.json
index 93222417a77..942498c2e0d 100644
---
a/core/camel-core-xml/src/generated/resources/META-INF/org/apache/camel/core/xml/routeController.json
+++
b/core/camel-core-xml/src/generated/resources/META-INF/org/apache/camel/core/xml/routeController.json
@@ -13,7 +13,7 @@
},
"properties": {
"id": { "index": 0, "kind": "attribute", "displayName": "Id", "group":
"common", "required": false, "type": "string", "javaType": "java.lang.String",
"deprecated": false, "autowired": false, "secret": false, "description": "The
id of this node" },
- "supervising": { "index": 1, "kind": "attribute", "displayName":
"Supervising", "group": "common", "required": false, "type": "boolean",
"javaType": "java.lang.Boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": false, "description": "To enable using
supervising route controller which allows Camel to startup and then the
controller takes care of starting the routes in a safe manner. This can be used
when you want to startup Camel despite a route may ot [...]
+ "supervising": { "index": 1, "kind": "attribute", "displayName":
"Supervising", "group": "common", "required": false, "type": "boolean",
"javaType": "java.lang.Boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": false, "description": "To enable using
supervising route controller which allows Camel to start up and then, the
controller takes care of starting the routes in a safe manner. This can be used
when you want to start up Camel despite a route may [...]
"includeRoutes": { "index": 2, "kind": "attribute", "displayName":
"Include Routes", "group": "common", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "Pattern for filtering routes to be included as
supervised. The pattern is matching on route id, and endpoint uri for the
route. Multiple patterns can be separated by comma. For example to include all
kafka routes, you can say kafka:. And to [...]
"excludeRoutes": { "index": 3, "kind": "attribute", "displayName":
"Exclude Routes", "group": "common", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "Pattern for filtering routes to be excluded as
supervised. The pattern is matching on route id, and endpoint uri for the
route. Multiple patterns can be separated by comma. For example to exclude all
JMS routes, you can say jms:. And to excl [...]
"threadPoolSize": { "index": 4, "kind": "attribute", "displayName":
"Thread Pool Size", "group": "common", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": "1", "description": "The number of threads
used by the scheduled thread pool that are used for restarting routes. The pool
uses 1 thread by default, but you can increase this to allow the controller to
concurrently attempt to restart mult [...]
diff --git
a/core/camel-core-xml/src/main/java/org/apache/camel/core/xml/CamelRouteControllerDefinition.java
b/core/camel-core-xml/src/main/java/org/apache/camel/core/xml/CamelRouteControllerDefinition.java
index fa09fc2ccbf..29b331391c6 100644
---
a/core/camel-core-xml/src/main/java/org/apache/camel/core/xml/CamelRouteControllerDefinition.java
+++
b/core/camel-core-xml/src/main/java/org/apache/camel/core/xml/CamelRouteControllerDefinition.java
@@ -71,11 +71,11 @@ public class CamelRouteControllerDefinition extends
IdentifiedType {
}
/**
- * To enable using supervising route controller which allows Camel to
startup and then the controller takes care of
- * starting the routes in a safe manner.
+ * To enable using supervising route controller which allows Camel to
start up and then, the controller takes care
+ * of starting the routes in a safe manner.
*
- * This can be used when you want to startup Camel despite a route may
otherwise fail fast during startup and cause
- * Camel to fail to startup as well. By delegating the route startup to
the supervising route controller then its
+ * This can be used when you want to start up Camel despite a route may
otherwise fail fast during startup and cause
+ * Camel to fail to start up as well. By delegating the route startup to
the supervising route controller then its
* manages the startup using a background thread. The controller allows to
be configured with various settings to
* attempt to restart failing routes.
*/
diff --git
a/core/camel-main/src/generated/resources/META-INF/camel-main-configuration-metadata.json
b/core/camel-main/src/generated/resources/META-INF/camel-main-configuration-metadata.json
index 70262ec7595..a9ec26761cf 100644
---
a/core/camel-main/src/generated/resources/META-INF/camel-main-configuration-metadata.json
+++
b/core/camel-main/src/generated/resources/META-INF/camel-main-configuration-metadata.json
@@ -249,7 +249,7 @@
{ "name": "camel.routecontroller.backOffMaxDelay", "description": "Backoff
maximum delay in millis when restarting a route that failed to startup.",
"sourceType": "org.apache.camel.main.RouteControllerConfigurationProperties",
"type": "integer", "javaType": "long" },
{ "name": "camel.routecontroller.backOffMaxElapsedTime", "description":
"Backoff maximum elapsed time in millis, after which the backoff should be
considered exhausted and no more attempts should be made.", "sourceType":
"org.apache.camel.main.RouteControllerConfigurationProperties", "type":
"integer", "javaType": "long" },
{ "name": "camel.routecontroller.backOffMultiplier", "description":
"Backoff multiplier to use for exponential backoff. This is used to extend the
delay between restart attempts.", "sourceType":
"org.apache.camel.main.RouteControllerConfigurationProperties", "type":
"number", "javaType": "double" },
- { "name": "camel.routecontroller.enabled", "description": "To enable using
supervising route controller which allows Camel to startup and then the
controller takes care of starting the routes in a safe manner. This can be used
when you want to startup Camel despite a route may otherwise fail fast during
startup and cause Camel to fail to startup as well. By delegating the route
startup to the supervising route controller then its manages the startup using
a background thread. The con [...]
+ { "name": "camel.routecontroller.enabled", "description": "To enable using
supervising route controller which allows Camel to start up and then, the
controller takes care of starting the routes in a safe manner. This can be used
when you want to start up Camel despite a route may otherwise fail fast during
startup and cause Camel to fail to start up as well. By delegating the route
startup to the supervising route controller, then it manages the startup using
a background thread. The [...]
{ "name": "camel.routecontroller.excludeRoutes", "description": "Pattern
for filtering routes to be excluded as supervised. The pattern is matching on
route id, and endpoint uri for the route. Multiple patterns can be separated by
comma. For example to exclude all JMS routes, you can say jms:. And to exclude
routes with specific route ids mySpecialRoute,myOtherSpecialRoute. The pattern
supports wildcards and uses the matcher from
org.apache.camel.support.PatternHelper#matchPattern.", [...]
{ "name": "camel.routecontroller.includeRoutes", "description": "Pattern
for filtering routes to be included as supervised. The pattern is matching on
route id, and endpoint uri for the route. Multiple patterns can be separated by
comma. For example to include all kafka routes, you can say kafka:. And to
include routes with specific route ids myRoute,myOtherRoute. The pattern
supports wildcards and uses the matcher from
org.apache.camel.support.PatternHelper#matchPattern.", "sourceTy [...]
{ "name": "camel.routecontroller.initialDelay", "description": "Initial
delay in milli seconds before the route controller starts, after CamelContext
has been started.", "sourceType":
"org.apache.camel.main.RouteControllerConfigurationProperties", "type":
"integer", "javaType": "long" },
diff --git a/core/camel-main/src/main/docs/main.adoc
b/core/camel-main/src/main/docs/main.adoc
index 7a6d6ae1b19..7eaa1c65a3a 100644
--- a/core/camel-main/src/main/docs/main.adoc
+++ b/core/camel-main/src/main/docs/main.adoc
@@ -158,7 +158,7 @@ The camel.routecontroller supports 12 options, which are
listed below.
| *camel.routecontroller.backOff{zwsp}MaxDelay* | Backoff maximum delay in
millis when restarting a route that failed to startup. | | long
| *camel.routecontroller.backOff{zwsp}MaxElapsedTime* | Backoff maximum
elapsed time in millis, after which the backoff should be considered exhausted
and no more attempts should be made. | | long
| *camel.routecontroller.backOff{zwsp}Multiplier* | Backoff multiplier to use
for exponential backoff. This is used to extend the delay between restart
attempts. | | double
-| *camel.routecontroller.enabled* | To enable using supervising route
controller which allows Camel to startup and then the controller takes care of
starting the routes in a safe manner. This can be used when you want to startup
Camel despite a route may otherwise fail fast during startup and cause Camel to
fail to startup as well. By delegating the route startup to the supervising
route controller then its manages the startup using a background thread. The
controller allows to be config [...]
+| *camel.routecontroller.enabled* | To enable using supervising route
controller which allows Camel to start up and then, the controller takes care
of starting the routes in a safe manner. This can be used when you want to
start up Camel despite a route may otherwise fail fast during startup and cause
Camel to fail to start up as well. By delegating the route startup to the
supervising route controller, then it manages the startup using a background
thread. The controller allows to be co [...]
| *camel.routecontroller.exclude{zwsp}Routes* | Pattern for filtering routes
to be excluded as supervised. The pattern is matching on route id, and endpoint
uri for the route. Multiple patterns can be separated by comma. For example to
exclude all JMS routes, you can say jms:. And to exclude routes with specific
route ids mySpecialRoute,myOtherSpecialRoute. The pattern supports wildcards
and uses the matcher from org.apache.camel.support.PatternHelper#matchPattern.
| | String
| *camel.routecontroller.include{zwsp}Routes* | Pattern for filtering routes
to be included as supervised. The pattern is matching on route id, and endpoint
uri for the route. Multiple patterns can be separated by comma. For example to
include all kafka routes, you can say kafka:. And to include routes with
specific route ids myRoute,myOtherRoute. The pattern supports wildcards and
uses the matcher from org.apache.camel.support.PatternHelper#matchPattern. | |
String
| *camel.routecontroller.initial{zwsp}Delay* | Initial delay in milli seconds
before the route controller starts, after CamelContext has been started. | |
long
diff --git
a/core/camel-main/src/main/java/org/apache/camel/main/RouteControllerConfigurationProperties.java
b/core/camel-main/src/main/java/org/apache/camel/main/RouteControllerConfigurationProperties.java
index 904b009e47b..d19a0576f81 100644
---
a/core/camel-main/src/main/java/org/apache/camel/main/RouteControllerConfigurationProperties.java
+++
b/core/camel-main/src/main/java/org/apache/camel/main/RouteControllerConfigurationProperties.java
@@ -71,11 +71,11 @@ public class RouteControllerConfigurationProperties
implements BootstrapCloseabl
}
/**
- * To enable using supervising route controller which allows Camel to
startup and then the controller takes care of
- * starting the routes in a safe manner.
+ * To enable using supervising route controller which allows Camel to
start up and then, the controller takes care
+ * of starting the routes in a safe manner.
*
- * This can be used when you want to startup Camel despite a route may
otherwise fail fast during startup and cause
- * Camel to fail to startup as well. By delegating the route startup to
the supervising route controller then its
+ * This can be used when you want to start up Camel despite a route may
otherwise fail fast during startup and cause
+ * Camel to fail to start up as well. By delegating the route startup to
the supervising route controller, then it
* manages the startup using a background thread. The controller allows to
be configured with various settings to
* attempt to restart failing routes.
*/
@@ -229,11 +229,11 @@ public class RouteControllerConfigurationProperties
implements BootstrapCloseabl
}
/**
- * To enable using supervising route controller which allows Camel to
startup and then the controller takes care of
- * starting the routes in a safe manner.
+ * To enable using supervising route controller which allows Camel to
start up and then, the controller takes care
+ * of starting the routes in a safe manner.
*
- * This can be used when you want to startup Camel despite a route may
otherwise fail fast during startup and cause
- * Camel to fail to startup as well. By delegating the route startup to
the supervising route controller then its
+ * This can be used when you want to start up Camel despite a route may
otherwise fail fast during startup and cause
+ * Camel to fail to start up as well. By delegating the route startup to
the supervising route controller, then it
* manages the startup using a background thread. The controller allows to
be configured with various settings to
* attempt to restart failing routes.
*/
@@ -243,7 +243,7 @@ public class RouteControllerConfigurationProperties
implements BootstrapCloseabl
}
/**
- * Initial delay in milli seconds before the route controller starts,
after CamelContext has been started.
+ * Initial delay in milliseconds before the route controller starts, after
CamelContext has been started.
*/
public RouteControllerConfigurationProperties withInitialDelay(long
initialDelay) {
this.initialDelay = initialDelay;
diff --git a/docs/user-manual/modules/ROOT/pages/backlog-tracer.adoc
b/docs/user-manual/modules/ROOT/pages/backlog-tracer.adoc
index 03710e385d7..e33c636fee6 100644
--- a/docs/user-manual/modules/ROOT/pages/backlog-tracer.adoc
+++ b/docs/user-manual/modules/ROOT/pages/backlog-tracer.adoc
@@ -144,6 +144,6 @@ When working with `InputStream` types then Camel has
xref:stream-caching.adoc[]
make such types _safe_ to use as they are cached and able to be _re-read_. See
more details at xref:stream-caching.adoc[].
However, Camel's stream caching is **ONLY** for message body. Having message
headers of type `InputStream` is discouraged
-and not common use. If you add custom message headers, then its recommended to
**NOT** use streaming types, but
+and not common use. If you add custom message headers, then it is recommended
to **NOT** use streaming types, but
convert these headers into `String` or `byte[]` or other standard Java types
that are in-memory and _safe_ to re-read.
diff --git
a/docs/user-manual/modules/ROOT/pages/camel-3x-upgrade-guide-3_5.adoc
b/docs/user-manual/modules/ROOT/pages/camel-3x-upgrade-guide-3_5.adoc
index 1182d3b8a55..c3e16e9b958 100644
--- a/docs/user-manual/modules/ROOT/pages/camel-3x-upgrade-guide-3_5.adoc
+++ b/docs/user-manual/modules/ROOT/pages/camel-3x-upgrade-guide-3_5.adoc
@@ -8,7 +8,7 @@ from both 3.0 to 3.1 and 3.1 to 3.2.
=== FluentProducerTemplate
-The template will now automatic clear its state send sending the message, this
avoids end users having to call `clearAll` after usage,
+The template will now automatic clear its state when sending the message, this
avoids end users having to call `clearAll` after usage,
in case the template should be reused to send other messages.
After the template has been started / used the first time, then its general
configuration cannot be altered later,
diff --git
a/docs/user-manual/modules/ROOT/pages/camel-3x-upgrade-guide-3_9.adoc
b/docs/user-manual/modules/ROOT/pages/camel-3x-upgrade-guide-3_9.adoc
index 93b614c685d..d601321f834 100644
--- a/docs/user-manual/modules/ROOT/pages/camel-3x-upgrade-guide-3_9.adoc
+++ b/docs/user-manual/modules/ROOT/pages/camel-3x-upgrade-guide-3_9.adoc
@@ -38,7 +38,7 @@ The method `getProperties()` now only returns user
properties. To include intern
then use `getAllProperties()`.
The other APIs such as `getProperty(String)` works the same way as before,
being able to lookup a property
-regardless if its internal or custom.
+regardless if it is internal or custom.
The internal properties is a fixed set of known keys defined in the
`ExchangePropertyKey` enum class.
These keys are used in camel-core such as the routing engine, EIPs and others
that needs to store internal
diff --git a/docs/user-manual/modules/ROOT/pages/camel-report-maven-plugin.adoc
b/docs/user-manual/modules/ROOT/pages/camel-report-maven-plugin.adoc
index 56eac9211fd..86b02221433 100644
--- a/docs/user-manual/modules/ROOT/pages/camel-report-maven-plugin.adoc
+++ b/docs/user-manual/modules/ROOT/pages/camel-report-maven-plugin.adoc
@@ -360,7 +360,7 @@ The maven plugin *coverage* goal supports the following
options which can be con
| excludes | | To filter the names of java and xml files to exclude files
matching any of the given list of
patterns (wildcard and regular expression). Multiple values can be separated
by comma.
| anonymousRoutes | false | Whether to allow anonymous routes (routes without
any route id assigned).
- By using route id's then its safer to match the route cover data with the
route source code.
+ By using route id's then it is safer to match the route cover data with the
route source code.
Anonymous routes are less safe to use for route coverage as its harder to
know exactly which route
that was tested corresponds to which of the routes from the source code.
| generateJacocoXmlReport | false | Whether to generate a coverage-report in
Jacoco XML format. When enabled it will generate the file:
`target/site/jacoco/xmlJacoco.xml`
diff --git a/docs/user-manual/modules/ROOT/pages/error-handler.adoc
b/docs/user-manual/modules/ROOT/pages/error-handler.adoc
index 37920f7630e..6e4f9b3cb24 100644
--- a/docs/user-manual/modules/ROOT/pages/error-handler.adoc
+++ b/docs/user-manual/modules/ROOT/pages/error-handler.adoc
@@ -232,13 +232,13 @@ The error handler can be configured as a spring bean and
scoped in:
The error handler is configured with the `errorHandlerRef` attribute.
TIP: *Error Handler Hierarchy* +
-The error handlers is inherited, so if you only have set a global error
-handler then its use everywhere. But you can override this in a route
+The error handlers are inherited, so if you only have set a global error
+handler, then it is used everywhere. But you can override this in a route
and use another error handler.
-=== Spring based configuration sample
+=== Spring-based configuration sample
-In this sample we configure a
xref:components:eips:dead-letter-channel.adoc[Dead Letter
+In this sample, we configure a
xref:components:eips:dead-letter-channel.adoc[Dead Letter
Channel] on the route that should redeliver at most 3 times and use a
little delay before retrying. First we configure the reference to
*myDeadLetterErrorHandler* using
the `errorHandlerRef` attribute on the `route` tag.
diff --git a/docs/user-manual/modules/ROOT/pages/jmx.adoc
b/docs/user-manual/modules/ROOT/pages/jmx.adoc
index 705566d71b0..5a057b622f2 100644
--- a/docs/user-manual/modules/ROOT/pages/jmx.adoc
+++ b/docs/user-manual/modules/ROOT/pages/jmx.adoc
@@ -124,7 +124,7 @@ from MBean names and attributes.
=== Registering MBeans for specific resources only
Camel automatically registers MBeans for the context, routes, and processors
-when it starts up. However, you can specify a level to control whether or not
+when it starts up. However, you can specify a level to control whether
MBeans are registered at startup. The levels are:
* `Default` - Camel will register MBeans for the context, all the routes and
the processors.
diff --git a/docs/user-manual/modules/ROOT/pages/oncompletion.adoc
b/docs/user-manual/modules/ROOT/pages/oncompletion.adoc
index bc52a7c0f2b..148f297fe65 100644
--- a/docs/user-manual/modules/ROOT/pages/oncompletion.adoc
+++ b/docs/user-manual/modules/ROOT/pages/oncompletion.adoc
@@ -21,7 +21,7 @@ The OnCompletion EIP supports the following features:
* triggered either always, only if completed with success, or only if failed
* `onWhen` predicate to only trigger if matched
* `mode` to define whether to run either before or after
-route consumer writes response back to callee (if its InOut) (default
AfterConsumer)
+route consumer writes response back to callee (if it is InOut) (default
AfterConsumer)
* `parallelProcessing` whether to run async or sync (use a thread pool or not)
(default false)
The onCompletion supports running the completion task in either synchronous or
asynchronous mode
diff --git a/docs/user-manual/modules/ROOT/pages/release-guide-website.adoc
b/docs/user-manual/modules/ROOT/pages/release-guide-website.adoc
index 3ec722eb4d7..1f214dc0de7 100644
--- a/docs/user-manual/modules/ROOT/pages/release-guide-website.adoc
+++ b/docs/user-manual/modules/ROOT/pages/release-guide-website.adoc
@@ -14,7 +14,7 @@ For instance, `camel:docs/components/antora.yml` for the
`docs/components/antora
//== Notes on versions
//
-//Within an Antora component, xrefs to content in the same component, whether
or not they are in the same source tree or repository, should never include the
`version` or `component` segment of the page id.
+//Within an Antora component, xrefs to content in the same component, whether
they are in the same source tree or repository, should never include the
`version` or `component` segment of the page id.
//Including the version will make the page non-relocatable to another version:
for instance specifying `next` in the main branch will break the link when main
is branched for a release.
//Including the `component` segment will redirect to the (Antora) latest
version, which will typically be the last released version.
//
diff --git a/docs/user-manual/modules/ROOT/pages/threading-model.adoc
b/docs/user-manual/modules/ROOT/pages/threading-model.adoc
index a8782e808f3..c79de2d6581 100644
--- a/docs/user-manual/modules/ROOT/pages/threading-model.adoc
+++ b/docs/user-manual/modules/ROOT/pages/threading-model.adoc
@@ -225,7 +225,7 @@ NOTE: This requires to enabled JMX by including
`camel-management` JAR in the cl
== Component developers
If you develop your own Camel component and are in need of a thread
-pool, then its advised to use the
+pool, then it is advised to use the
`ExecutorServiceStrategy`/`ExecutorServiceManager` to create the thread
pool you need.
diff --git a/docs/user-manual/modules/ROOT/pages/using-propertyplaceholder.adoc
b/docs/user-manual/modules/ROOT/pages/using-propertyplaceholder.adoc
index 000d8b86451..02e36d7202d 100644
--- a/docs/user-manual/modules/ROOT/pages/using-propertyplaceholder.adoc
+++ b/docs/user-manual/modules/ROOT/pages/using-propertyplaceholder.adoc
@@ -608,7 +608,7 @@ camel.kubernetes-config.client.oauthToken =
eyJhbGciOiJSUzI1NiIsImtpZCI...
The `KubernetesClient` has many options, see the
https://github.com/fabric8io/kubernetes-client documentation.
-If you only use _mount paths_ then its good practice to disable
`KubernetesClient` which can be done by setting enabled to false as show:
+If you only use _mount paths_, then it is good practice to disable
`KubernetesClient` which can be done by setting enabled to false as show:
[source,properties]
----
diff --git
a/docs/user-manual/modules/faq/pages/how-do-i-restart-camelcontext.adoc
b/docs/user-manual/modules/faq/pages/how-do-i-restart-camelcontext.adoc
index 43c3f865d4c..bb425bcbab6 100644
--- a/docs/user-manual/modules/faq/pages/how-do-i-restart-camelcontext.adoc
+++ b/docs/user-manual/modules/faq/pages/how-do-i-restart-camelcontext.adoc
@@ -5,7 +5,7 @@ its lifecycle, see more at
xref:ROOT:camelcontext.adoc[CamelContext].
[NOTE]
====
-Obviously you can also restart a Camel application if its been
+Obviously you can also restart a Camel application if it has been
deployed in a server. For example a WAR application can be restarted
using the usual means for managing web applications.
====
diff --git
a/docs/user-manual/modules/faq/pages/how-do-i-retrieve-the-thrown-exception-during-processing-an-exchange.adoc
b/docs/user-manual/modules/faq/pages/how-do-i-retrieve-the-thrown-exception-during-processing-an-exchange.adoc
index fa344db20ab..a24c3b0699c 100644
---
a/docs/user-manual/modules/faq/pages/how-do-i-retrieve-the-thrown-exception-during-processing-an-exchange.adoc
+++
b/docs/user-manual/modules/faq/pages/how-do-i-retrieve-the-thrown-exception-during-processing-an-exchange.adoc
@@ -3,14 +3,14 @@
You have send an Exchange to Camel but it fails during processing caused
by a thrown Exception. How do I retrieve this Exception?
-If you are using CamelTemplate (or CamelProducer), then its common to
+If you are using CamelTemplate (or CamelProducer), then it is common to
use the sendBody/requestBody methods that returns the exchange body
response *only*. So if there was a thrown exception during processing
Camel is not rethrowing this Exception. To remedy this you can use the
plain send/request methods that accepts an Exchange object and returns
an Exchange object.
-From the returned Exchange you can test if its failed and get the caused
+From the returned Exchange you can test if it has failed and get the caused
exception. This is illustrated in the code sample:
[source,java]
diff --git
a/docs/user-manual/modules/faq/pages/how-do-i-retry-failed-messages-forever.adoc
b/docs/user-manual/modules/faq/pages/how-do-i-retry-failed-messages-forever.adoc
index 740dd979c6a..8f90a362da1 100644
---
a/docs/user-manual/modules/faq/pages/how-do-i-retry-failed-messages-forever.adoc
+++
b/docs/user-manual/modules/faq/pages/how-do-i-retry-failed-messages-forever.adoc
@@ -15,4 +15,4 @@ When you consume a message you can check the in message header
has been redlivered.
Or `org.apache.camel.Redelivered` that contains a boolean if its
-redelivered or if its the first time the message is processed.
+redelivered or if it is the first time the message is processed.
diff --git a/dsl/camel-xml-io-dsl/src/main/docs/java-xml-io-dsl.adoc
b/dsl/camel-xml-io-dsl/src/main/docs/java-xml-io-dsl.adoc
index 289c0c92ae5..257ac5b0e01 100644
--- a/dsl/camel-xml-io-dsl/src/main/docs/java-xml-io-dsl.adoc
+++ b/dsl/camel-xml-io-dsl/src/main/docs/java-xml-io-dsl.adoc
@@ -18,7 +18,7 @@ The JAXB parser is generic and can be used for parsing any
XML.
However, the `xml-io-dsl` is a source code generated parser that is Camel
specific and can only parse Camel `.xml`
route files (not classic Spring `<beans>` XML files).
-If you are using Camel XML DSL then its recommended using `xml-io-dsl` instead
of `xml-jaxb-dsl`.
+If you are using Camel XML DSL then it is recommended using `xml-io-dsl`
instead of `xml-jaxb-dsl`.
You can use this in all of Camel's runtime such as Spring Boot, Quarkus, Camel
Main, and Camel K etc.
== Example
diff --git a/dsl/camel-xml-jaxb-dsl/src/main/docs/java-xml-jaxb-dsl.adoc
b/dsl/camel-xml-jaxb-dsl/src/main/docs/java-xml-jaxb-dsl.adoc
index 4b92dd18428..350f23c24ca 100644
--- a/dsl/camel-xml-jaxb-dsl/src/main/docs/java-xml-jaxb-dsl.adoc
+++ b/dsl/camel-xml-jaxb-dsl/src/main/docs/java-xml-jaxb-dsl.adoc
@@ -17,7 +17,7 @@ The JAXB parser is generic and can be used for parsing any
XML.
However, the `xml-io-dsl` is a source code generated parser that is Camel
specific and can only parse Camel `.xml`
route files (not classic Spring `<beans>` XML files).
-If you are using Camel XML DSL then its recommended using `xml-io-dsl` instead
of `xml-jaxb-dsl`.
+If you are using Camel XML DSL then it is recommended using `xml-io-dsl`
instead of `xml-jaxb-dsl`.
You can use this in all of Camel's runtime such as Spring Boot, Quarkus, Camel
Main, and Camel K etc.
If you use classic Spring `<beans>` XML files, or OSGi `<blueprint>` then you
must use the `camel-jaxb-dsl`,
