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 2023/01/05 14:47:27 UTC
[camel] 02/06: (chores) documentation: clarify what routes are and how they can be used
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 90ae97682dfc69fdb8973635e0a6732dc8d01913
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Thu Jan 5 14:04:12 2023 +0100
(chores) documentation: clarify what routes are and how they can be used
---
docs/main/modules/working-with-camel-core/pages/index.adoc | 4 +++-
docs/user-manual/modules/ROOT/pages/routes.adoc | 10 ++++++----
2 files changed, 9 insertions(+), 5 deletions(-)
diff --git a/docs/main/modules/working-with-camel-core/pages/index.adoc b/docs/main/modules/working-with-camel-core/pages/index.adoc
index be2496a7fc5..93e7e292473 100644
--- a/docs/main/modules/working-with-camel-core/pages/index.adoc
+++ b/docs/main/modules/working-with-camel-core/pages/index.adoc
@@ -9,7 +9,9 @@ We have prepared these two guides to explain in greater detail a few of the conc
== Routes
-A Camel route is where the integration flow is defined. For example, you can write a Camel route to specify how two systems can be integrated. The following 2 guides provide the fundamental knowledge of Camel routes:
+In Apache Camel, a _route_ is a set of processing steps that are applied to a message as it travels from a source to a destination. A route typically consists of a series of processing steps that are connected in a linear sequence.
+
+In other words, a Camel _route_ is where the integration flow is defined. For example, you can write a Camel route to specify how two systems can be integrated. The following 2 guides provide the fundamental knowledge of Camel routes:
* xref:manual::routes.adoc[Routes]: the basic guide about Camel Routes.
* xref:manual::route-builder.adoc[Route Builder]: describes the base class from which you can create Routes.
diff --git a/docs/user-manual/modules/ROOT/pages/routes.adoc b/docs/user-manual/modules/ROOT/pages/routes.adoc
index f78d902e839..e47c0f7f8b2 100644
--- a/docs/user-manual/modules/ROOT/pages/routes.adoc
+++ b/docs/user-manual/modules/ROOT/pages/routes.adoc
@@ -1,11 +1,12 @@
= Routes
-A Camel _route_ is where the integration flow is defined. For example, you can write a Camel route to specify how two systems can be integrated.
+In Apache Camel, a _route_ is a set of processing steps that are applied to a message as it travels from a source to a destination. A route typically consists of a series of processing steps that are connected in a linear sequence.
+A Camel _route_ is where the integration flow is defined. For example, you can write a Camel route to specify how two systems can be integrated. You can also specify how the data can be manipulated, routed, or mediated between the systems.
-An example could be to take files from a FTP server and send to a ActiveMQ messaging system.
+The routes are typically defined using a simple, declarative syntax that is easy to read and understand.
-This can be coded in a route using Java with the xref:java-dsl.adoc[Java DSL]
+For instance, you could write a _route_ to consume files from an FTP server and send them to an http://activemq.apache.org[ActiveMQ] messaging system. A _route_ to do so, using xref:java-dsl.adoc[Java DSL], would look like this:
[source,java]
----
@@ -13,7 +14,7 @@ from("ftp:myserver/folder")
.to("activemq:queue:cheese");
----
-Camel support coding in other languages such as XML:
+Camel _routes_ can be defined using a variety of xref:dsl.adoc[domain-specific languages (DSLs)], such as Java, Spring XML, or YAML. For example, you could write the _route_ described above using XML:
[source,xml]
----
@@ -23,6 +24,7 @@ Camel support coding in other languages such as XML:
</route>
----
+
== RouteBuilder with Java DSL
When coding routes with the xref:java-dsl.adoc[Java DSL] then you would use a xref:route-builder.adoc[`RouteBuilder`] classes where