This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
commit 5c0d97ba5ba9464d490ce47a0ceff63fba588e50
Author: Claus Ibsen <claus.ib...@gmail.com>
AuthorDate: Sat Oct 30 11:37:39 2021 +0200
CAMEL-16861: Cleanup docs
---
.../modules/ROOT/pages/batch-consumer.adoc | 29 +++++++++++-----------
.../modules/ROOT/pages/bean-binding.adoc | 21 +++++-----------
.../modules/ROOT/pages/bean-injection.adoc | 1 -
.../modules/ROOT/pages/bean-integration.adoc | 8 +++---
.../modules/ROOT/pages/browsable-endpoint.adoc | 4 +--
docs/user-manual/modules/ROOT/pages/building.adoc | 14 ++---------
6 files changed, 29 insertions(+), 48 deletions(-)
diff --git a/docs/user-manual/modules/ROOT/pages/batch-consumer.adoc
b/docs/user-manual/modules/ROOT/pages/batch-consumer.adoc
index 0d98102..c373887 100644
--- a/docs/user-manual/modules/ROOT/pages/batch-consumer.adoc
+++ b/docs/user-manual/modules/ROOT/pages/batch-consumer.adoc
@@ -8,34 +8,39 @@ To support batching the consumer must implement the
`org.apache.camel.BatchConsu
A range of Camel components support batching such as:
+* xref:components::aws2-ddb-component.adoc[AWS2 DDB]
+* xref:components::aws2-kinesis-component.adoc[AWS2 Kinesis]
+* xref:components::aws2-s3-component.adoc[AWS2 S3]
+* xref:components::aws2-sqs-component.adoc[AWS2 SQS]
* xref:components::file-component.adoc[File]
* xref:components::ftp-component.adoc[FTP]
+* xref:components::ironmq-component.adoc[IronMQ]
+* xref:components::jooq-component.adoc[Jooq]
* xref:components::jpa-component.adoc[JPA]
* xref:components::mail-component.adoc[Mail]
+* xref:components::minio-component.adoc[Minio]
* xref:components::mybatis-component.adoc[MyBatis]
-* xref:components::snmp-component.adoc[SNMP]
+* xref:components::slack-component.adoc[Slack]
+* xref:components::splunk-component.adoc[Splunk]
* xref:components::sql-component.adoc[SQL]
-[[BatchConsumer-ConsumerOptions]]
-== Consumer Options
+== Options
The `BatchConsumer` supports the following options:
[width="100%",cols="20%,80%",options="header",]
|=======================================================================
|Option |Description
-
-|maxMessagesPerPoll |An integer to define a maximum messages to gather per
poll. By default
+|`maxMessagesPerPoll` |An integer to define a maximum messages to gather per
poll. By default,
no maximum is set. Can be used to set a limit of e.g. 1000 to avoid when
starting up the server that there are thousands of files. Set a value of
-0 or negative to disabled it.
+0 or negative to disabled it as unlimited.
|=======================================================================
Very often a `BatchConsumer` is scheduled and is based of the
`ScheduledBatchPollingConsumer`
that has many options for configuring the scheduling. These options are listed
with _(scheduler)_
as label in the endpoints options in the
xref:components::index.adoc[Components] documentation.
-[[BatchConsumer-ExchangeProperties]]
== Exchange Properties
The following properties is set on the Exchange for
@@ -44,13 +49,9 @@ each Exchange polled in the same batch.
[width="100%",cols="20%,80%",options="header",]
|=======================================================================
|Property |Description
-
-|CamelBatchSize |The total number of Exchanges that was polled in
-this batch.
-
-|CamelBatchIndex |The current index of the batch. Starts from 0.
-
-|CamelBatchComplete |A boolean indicating the last Exchange in the batch.
+|`CamelBatchSize` |The total number of Exchanges that was polled in this batch.
+|`CamelBatchIndex` |The current index of the batch. Starts from 0.
+|`CamelBatchComplete` |A boolean indicating the last Exchange in the batch.
Is only `true` for the last entry.
|=======================================================================
diff --git a/docs/user-manual/modules/ROOT/pages/bean-binding.adoc
b/docs/user-manual/modules/ROOT/pages/bean-binding.adoc
index 6c1d022..4d2b08f 100644
--- a/docs/user-manual/modules/ROOT/pages/bean-binding.adoc
+++ b/docs/user-manual/modules/ROOT/pages/bean-binding.adoc
@@ -6,7 +6,6 @@ the method when it is invoked.
NOTE: This requires to include `camel-bean` as dependency on the classpath.
-[[BeanBinding-Choosingthemethodtoinvoke]]
== Choosing the method to invoke
The binding of a Camel xref:components:eips:message.adoc[Message] to a bean
method call
@@ -42,9 +41,8 @@ will be preferred since Camel can't invoke class methods on
such beans
In cases where Camel cannot choose a method to invoke, an
`AmbiguousMethodCallException` is thrown.
-By default the return value is set on the outbound message body.
+By default, the return value is set on the outbound message body.
-[[BeanBinding-Asynchronousprocessing]]
== Asynchronous processing
You can return a `CompletionStage` implementation (e.g. a `CompletableFuture`)
@@ -80,7 +78,6 @@ Composite processor that do not modify exchange
}
----
-[[BeanBinding-Parameterbinding]]
== Parameter binding
When a method has been chosen for invocation, Camel will bind to the
@@ -157,14 +154,12 @@ method name option.
See the following sections for more detail.
-[[BeanBinding-BindingAnnotations]]
== Binding Annotations
You can use the xref:parameter-binding-annotations.adoc[Parameter
Binding Annotations] to customize how parameter values are created from
the xref:components:eips:message.adoc[Message]
-[[BeanBinding-Examples]]
=== Examples
For example, a xref:components:eips:bean-eip.adoc[Bean] such as:
@@ -191,12 +186,12 @@ there is only a single parameter of the type
}
----
-[[BeanBinding-Handler]]
-=== @Handler
+=== Using @Handler
You can mark a method in your bean with the `@Handler` annotation to
indicate that this method should be used for xref:bean-binding.adoc[Bean
Binding].
+
This has an advantage as you need not specify a method name in the Camel
route, and therefore do not run into problems after renaming the method
in an IDE that can't find all its references.
@@ -212,7 +207,6 @@ public class Bar {
}
----
-[[BeanBinding-Parameterbindingusingmethodoption]]
== Parameter binding using method option
Camel uses the following rules to determine if it's a parameter value in
@@ -223,9 +217,9 @@ the method option
* The value is a String enclosed with either single or double quotes
* The value is null which denotes a `null` value
* It can be evaluated using the
xref:components:languages:simple-language.adoc[Simple] language, which
-means you can use, e.g., body, header.foo and other
+means you can use, e.g., `${body}`, `${header.foo}` and others
xref:components:languages:simple-language.adoc[Simple] tokens. Notice the
tokens must be enclosed with
-${ }.
+`${ }`.
Any other value is considered to be a type declaration instead - see the
next section about specifying types for overloaded methods.
@@ -328,8 +322,7 @@ use `.to` instead as shown:
.to("bean:orderService?method=doSomething(${body.asXml}, ${header.high})")
----
-[[BeanBinding-Usingtypequalifierstoselectamongoverloadedmethods]]
-== Using type qualifiers to select among overloaded methods
+=== Using type qualifiers to select among overloaded methods
If you have a xref:components:eips:bean-eip.adoc[Bean] with overloaded
methods, you can now
specify parameter types in the method name so Camel can match the method
@@ -384,5 +377,3 @@ at the same time, such as
----
doSomething(com.foo.MyOrder ${body}, boolean ${header.high})
----
-
-This may change in the future.
diff --git a/docs/user-manual/modules/ROOT/pages/bean-injection.adoc
b/docs/user-manual/modules/ROOT/pages/bean-injection.adoc
index 490bc50..5d95394 100644
--- a/docs/user-manual/modules/ROOT/pages/bean-injection.adoc
+++ b/docs/user-manual/modules/ROOT/pages/bean-injection.adoc
@@ -10,7 +10,6 @@ xref:testing.adoc[Testing] for an example.
xref:pojo-producing.adoc[POJO Producing]
* client side proxies for xref:pojo-producing.adoc[POJO Producing]
-[[BeanInjection-Using-BeanInject]]
== Using @BeanInject
You can inject beans (obtained from the
diff --git a/docs/user-manual/modules/ROOT/pages/bean-integration.adoc
b/docs/user-manual/modules/ROOT/pages/bean-integration.adoc
index 61fe874..8a41e4a 100644
--- a/docs/user-manual/modules/ROOT/pages/bean-integration.adoc
+++ b/docs/user-manual/modules/ROOT/pages/bean-integration.adoc
@@ -43,14 +43,14 @@ See more details at:
*Example*
-See the
https://github.com/apache/camel-examples/tree/master/examples/camel-example-pojo-messaging[POJO
Messaging Example]
+See the
https://github.com/apache/camel-examples/tree/main/examples/pojo-messaging[POJO
Messaging Example]
for how to use the annotations for routing and messaging.
== Using @PropertyInject
-Camel allows to inject property placeholders in POJOs using
+Camel allows injecting property placeholders in POJOs using
the `@PropertyInject` annotation which can be set on fields and setter
-methods. For example you can use that with `RouteBuilder` classes,
+methods. For example, you can use that with `RouteBuilder` classes,
such as shown below:
[source,java]
@@ -84,7 +84,7 @@ private String greeting;
This will lookup the placeholder with they key `name`.
-You can also add a default value if the key does not exists, such as:
+You can also add a default value if the key does not exist, such as:
[source,java]
----
diff --git a/docs/user-manual/modules/ROOT/pages/browsable-endpoint.adoc
b/docs/user-manual/modules/ROOT/pages/browsable-endpoint.adoc
index 1212e76..c66ab05 100644
--- a/docs/user-manual/modules/ROOT/pages/browsable-endpoint.adoc
+++ b/docs/user-manual/modules/ROOT/pages/browsable-endpoint.adoc
@@ -1,10 +1,10 @@
= BrowsableEndpoint
The `BrowseableEndpoint` is an extension interface an `Endpoint` may implement
-to support the browsing of the Message exchanges
+to support the browsing of the Message xref:exchange.adoc[Exchanges]
which are pending or have been sent on it.
-Some example implementations include:
+Some implementations include:
* xref:components::jms-component.adoc[JMS] for queues only
* xref:components::mock-component.adoc[Mock]
diff --git a/docs/user-manual/modules/ROOT/pages/building.adoc
b/docs/user-manual/modules/ROOT/pages/building.adoc
index 009f5ff..bc34804 100644
--- a/docs/user-manual/modules/ROOT/pages/building.adoc
+++ b/docs/user-manual/modules/ROOT/pages/building.adoc
@@ -4,7 +4,6 @@ Camel uses http://maven.apache.org/[Maven] as its build and
management
tool. If you don't fancy using Maven you can use your IDE directly or
Download a distribution or JAR.
-[[Building-Prequisites]]
== Prequisites
*Required:*
@@ -15,16 +14,14 @@ Download a distribution or JAR.
* https://github.com/takari/maven-wrapper[Maven Wrapper] can be used and
bundled.
* Otherwise, http://maven.apache.org/download.html[download and install Maven]
-** Maven 3.6.x or newer is required to build Camel 3 onwards
+** Maven 3.8.x or newer is required to build Camel 3 onwards
* Get the latest source from https://github.com/apache/camel/[Github]
-[[Building-Mavenoptions]]
== Maven options
To build camel maven has to be configured to use more memory
-[[Building-UnixLinuxMac]]
Unix/Linux/Mac
[source,bash]
@@ -32,8 +29,6 @@ Unix/Linux/Mac
export MAVEN_OPTS="-Xms2048m -Xmx3584m"
------------------------------------------------------------
-
-[[Building-Windows]]
Windows
[source,bash]
@@ -41,7 +36,6 @@ Windows
set MAVEN_OPTS="-Xms2048m -Xmx3584m"
-------------------------------------------------------
-[[Building-Anormalbuild]]
== A normal build
Beware this runs all the unit tests which takes many hours.
@@ -51,7 +45,6 @@ Beware this runs all the unit tests which takes many hours.
mvn clean install
-----------------
-[[Building-Anormalbuildwithoutrunningtests]]
== A quick build without running tests
The following skips building the manual, the distro and does not execute
@@ -62,7 +55,6 @@ the unit tests, which can complete in less than 10 minutes.
mvn clean install -Pfastinstall
-------------------------------
-[[Building-Anormalbuildwithoutrunningtestsbutcheckstyleverificationenabled]]
== A normal build without running tests but checkstyle verification enabled
[source,bash]
@@ -70,7 +62,6 @@ mvn clean install -Pfastinstall
mvn clean install -Pfastinstall,sourcecheck
-------------------------------------------
-[[Building-Buildingwithcheckstyle]]
== Building with checkstyle
To enable source style checking with checkstyle, build Camel with the
@@ -81,11 +72,10 @@ To enable source style checking with checkstyle, build
Camel with the
mvn clean install -Psourcecheck
-------------------------------
-[[Building-Buildingsourcejars]]
== Building source jars
If you want to build jar files with the source code, that for instance
-Eclipse can important so you can debug the Camel code as well. Then you
+Eclipse can important, so you can debug the Camel code as well. Then you
can run this command from the camel root folder:
[source,bash]
