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/06 16:04:15 UTC
[camel] branch main updated (cde02241ef1 -> 2ffb1e96c5c)
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 cde02241ef1 Sync deps
new a5b8a8c5caf (chores) documentation: more cleanups to the component guides
new eddc37bfb0c (chores) documentation: reorganize the categories for some of the guides
new 2ffb1e96c5c (chores) documentation: more cleanup in the documentation about routes
The 3 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:
docs/main/modules/getting-started/pages/index.adoc | 2 ++
.../working-with-camel-core/pages/index.adoc | 42 +++++++++++-----------
docs/user-manual/modules/ROOT/pages/component.adoc | 16 ++++++---
docs/user-manual/modules/ROOT/pages/java-dsl.adoc | 19 ++++++++--
docs/user-manual/modules/ROOT/pages/routes.adoc | 34 ++++++------------
docs/user-manual/modules/ROOT/pages/uris.adoc | 20 +++++------
6 files changed, 71 insertions(+), 62 deletions(-)
[camel] 01/03: (chores) documentation: more cleanups to the component guides
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 a5b8a8c5caf410239bd0e96cbf4a0e1c0afcd4c5
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Fri Jan 6 11:16:59 2023 +0100
(chores) documentation: more cleanups to the component guides
---
.../modules/working-with-camel-core/pages/index.adoc | 3 +--
docs/user-manual/modules/ROOT/pages/component.adoc | 17 +++++++++++++----
2 files changed, 14 insertions(+), 6 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 864fef197a6..961f7d0e1dd 100644
--- a/docs/main/modules/working-with-camel-core/pages/index.adoc
+++ b/docs/main/modules/working-with-camel-core/pages/index.adoc
@@ -42,8 +42,7 @@ If you have basic knowledge about _routes_, you can use the following guides to
Components are a fundamental building block of Apache Camel and are used to connect routes to a wide variety of external systems and services.
-* Components
-** xref:manual::component.adoc[Component]: the comprehensive guide about components.
+* xref:manual::component.adoc[Component]: the comprehensive guide about components.
== Other Guides
diff --git a/docs/user-manual/modules/ROOT/pages/component.adoc b/docs/user-manual/modules/ROOT/pages/component.adoc
index 36fa599e49c..8df1da5c963 100644
--- a/docs/user-manual/modules/ROOT/pages/component.adoc
+++ b/docs/user-manual/modules/ROOT/pages/component.adoc
@@ -1,5 +1,6 @@
= Components
+// suppress inspection "GrazieInspection"
Components are a fundamental building block of Apache Camel and are used to connect routes to a wide variety of external systems and services. Camel comes with a large number of built-in components that provide connectivity to a wide range of technologies and protocols, such as HTTP, JMS, file, and many others. You can also create a custom components if the built-in components do not meet your needs.
== Components: the basics
@@ -16,8 +17,10 @@ For the URI given in the above example, the `CamelContext` object would map the
The parameter to `getEndpoint()` is a URI. The URI _scheme_ (that is,
the part before `:`) specifies the name of a component. Internally, the `CamelContext` object maintains a mapping from the names of components to `Component` objects.
-*Note*: our documentation contains an in-depth overview of the xref:manual::component.adoc[Component] if you want to learn more about it, including important details necessary to write your own.
-
+[NOTE]
+====
+Our documentation contains an in-depth overview of the xref:manual::component.adoc[Component] if you want to learn more about it, including important details necessary to write your own.
+====
== Configuring Component Options
@@ -53,7 +56,10 @@ In other words, with placeholders you can externalize the configuration from you
In the getting started guide, we explained that Camel maintains a map of names to components. This raises the question of how Camel populates this map with named `Component` objects.
-*Note*: normally application developers don't need to worry about this. However, this information is fundamental if you are writing a custom component.
+[NOTE]
+====
+Normally, application developers don't need to worry about this. However, this information is fundamental if you are writing a custom component.
+====
There are two ways of populating the map.
@@ -100,7 +106,10 @@ myCamelContext.getEndpoint("pop3://john.smith@mailserv.example.com?password=myPa
We originally referred to the parameter as a URI because the online Camel documentation and the Camel source code both claim the parameter is a URI. In reality, the parameter is restricted to being a URL. This is because when Camel extracts the component name from the parameter, it looks for the first ":", which is a simplistic algorithm.
-*Note*: to understand, why recall from the Getting Started that a URI can be a URL or a URN.
+[NOTE]
+====
+Remember that in the xref:camel-core:getting-started:index.adoc[Getting Started With Camel] we explained that a URI could be a URL or a URN.
+====
Now consider the following calls to `getEndpoint`:
[camel] 03/03: (chores) documentation: more cleanup in the documentation about routes
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 2ffb1e96c5cf69e2efecbd43270c08dc7cd5b888
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Fri Jan 6 12:15:51 2023 +0100
(chores) documentation: more cleanup in the documentation about routes
---
docs/main/modules/getting-started/pages/index.adoc | 2 ++
.../working-with-camel-core/pages/index.adoc | 5 ++--
docs/user-manual/modules/ROOT/pages/component.adoc | 1 -
docs/user-manual/modules/ROOT/pages/java-dsl.adoc | 19 ++++++++++--
docs/user-manual/modules/ROOT/pages/routes.adoc | 34 +++++++---------------
docs/user-manual/modules/ROOT/pages/uris.adoc | 20 +++++--------
6 files changed, 40 insertions(+), 41 deletions(-)
diff --git a/docs/main/modules/getting-started/pages/index.adoc b/docs/main/modules/getting-started/pages/index.adoc
index 6557c72bf1d..2fbfc92d2d9 100644
--- a/docs/main/modules/getting-started/pages/index.adoc
+++ b/docs/main/modules/getting-started/pages/index.adoc
@@ -234,6 +234,8 @@ In Camel, Uniform Resource Identifiers (URIs) represent the addresses of the end
* A _resource identifier_.
* The options for the component.
+Camel makes extensive use of xref:manual::uris.adoc[URIs] to allow you to refer to xref:manual::endpoint.adoc[Endpoints].
+
[[BookGettingStarted-TheMeaningofURL-URI-URN]]
===== The Meaning of URL, URI and URN
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 71101cb8309..d46ad7a50d1 100644
--- a/docs/main/modules/working-with-camel-core/pages/index.adoc
+++ b/docs/main/modules/working-with-camel-core/pages/index.adoc
@@ -11,16 +11,16 @@ We have prepared these two guides to explain in greater detail a few of the conc
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:
+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 guide provides 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.
If you have basic knowledge about _routes_, you can use the following guides to learn how to write them in different languages, handle errors, and customize them.
* Routes (Basic + DSL)
** xref:manual::java-dsl.adoc[Java DSL]: the default language to write _routes_.
** xref:manual::dsl.adoc[DSL overview]: writing routes in other languages (XML, YAML, etc).
+** xref:manual::uris.adoc[URIs]
* Routes (Writing)
** xref:manual::expression.adoc[Expression]
@@ -92,7 +92,6 @@ Learn about additional ways to customize your integrations. Explore alternatives
** xref:manual::service-registry.adoc[Service Registry]
** xref:manual::spring.adoc[Spring]
** xref:manual::spring-xml-extensions.adoc[Spring XML Extensions]
-** xref:manual::uris.adoc[URIs]
** xref:manual::validator.adoc[Validator]
** xref:manual::what-are-the-dependencies.adoc[Camel Requirements]
** xref:manual::testing.adoc[Testing]
diff --git a/docs/user-manual/modules/ROOT/pages/component.adoc b/docs/user-manual/modules/ROOT/pages/component.adoc
index 8df1da5c963..a29642e31df 100644
--- a/docs/user-manual/modules/ROOT/pages/component.adoc
+++ b/docs/user-manual/modules/ROOT/pages/component.adoc
@@ -1,6 +1,5 @@
= Components
-// suppress inspection "GrazieInspection"
Components are a fundamental building block of Apache Camel and are used to connect routes to a wide variety of external systems and services. Camel comes with a large number of built-in components that provide connectivity to a wide range of technologies and protocols, such as HTTP, JMS, file, and many others. You can also create a custom components if the built-in components do not meet your needs.
== Components: the basics
diff --git a/docs/user-manual/modules/ROOT/pages/java-dsl.adoc b/docs/user-manual/modules/ROOT/pages/java-dsl.adoc
index 7518917ad80..7e732f1d52c 100644
--- a/docs/user-manual/modules/ROOT/pages/java-dsl.adoc
+++ b/docs/user-manual/modules/ROOT/pages/java-dsl.adoc
@@ -2,8 +2,7 @@
Apache Camel offers a Java based DSL.
-The Java DSL is available by extending the `RouteBuilder` class,
-and implement the `configure` method.
+In the Java DSL you create a route by extending the xref:manual::route-builder.adoc[`RouteBuilder` class], and implementing the `configure` method.
== Java DSL example
@@ -62,6 +61,22 @@ Then we use the xref:components:eips:choice-eip.adoc[Content Based Router] EIP
.to("file:target/messages/others");
-------------------------------------------------------
+=== Routes using Java lambda style
+
+Camel now supports to define Camel routes in Java DSL using Lambda style. This can be beneficial for microservices or serverless where
+you may want to quickly define a few routes.
+
+For example using lambda style you can define a Camel route that takes messages from Kafka and send to JMS in a single line of code:
+
+[source,java]
+----
+rb -> rb.from("kafka:cheese").to("jms:queue:foo");
+----
+
+There is a bit more to this as the lambda route must be coded in a Java method that returns an instance of `LambdaRouteBuilder`.
+See more at the xref:lambda-route-builder.adoc[LambdaRouteBuilder] documentation.
+
+
== More Details
For more details see xref:dsl.adoc[DSL], xref:routes.adoc[Routes], and xref:processor.adoc[Processor].
diff --git a/docs/user-manual/modules/ROOT/pages/routes.adoc b/docs/user-manual/modules/ROOT/pages/routes.adoc
index e47c0f7f8b2..faa12aba92d 100644
--- a/docs/user-manual/modules/ROOT/pages/routes.adoc
+++ b/docs/user-manual/modules/ROOT/pages/routes.adoc
@@ -25,10 +25,11 @@ Camel _routes_ can be defined using a variety of xref:dsl.adoc[domain-specific l
----
-== RouteBuilder with Java DSL
+== Writing Routes in Java using the 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
-you code the route in the `configure` method as shown:
+You can create a route using the Java language by extending the xref:manual::route-builder.adoc[`RouteBuilder` class], and implementing the `configure` method.
+
+Here's an example:
[source,java]
------------------------------------------------------
@@ -39,28 +40,15 @@ RouteBuilder builder = new RouteBuilder() {
};
------------------------------------------------------
-As you can see from the above Camel uses URIs to wire endpoints together.
-
-=== Routes using Java lambda style
-
-Camel now supports to define Camel routes in Java DSL using Lambda style. This can be beneficial for microservices or serverless where
-you may want to quickly define a few routes.
-
-For example using lambda style you can define a Camel route that takes messages from Kafka and send to JMS in a single line of code:
-
-[source,java]
-----
-rb -> rb.from("kafka:cheese").to("jms:queue:foo");
-----
+As you can see from the code snippet above, Camel uses xref:manual::uris.adoc[URIs] to wire endpoints together.
-There is a bit more to this as the lambda route must be coded in a Java method that returns an instance of `LambdaRouteBuilder`.
-See more at the xref:lambda-route-builder.adoc[LambdaRouteBuilder] documentation.
+We refer to this way of writing route as using the xref:manual::java-dsl.adoc[Java DSL].
== Route Precondition
-The routes can be included or not according to the result of a test expressed in simple language that is evaluated only once during the initialization phase.
+The routes can be included or not according to the result of a test. You can express the condition for the tests using the simple language. Camel evaluates this condition only once during the initialization phase.
-In the next example, the route is only included if the parameter `format` has been set to `xml`.
+Here's an example that includes the route only if the parameter `format` has been set to `xml`:
[source,java]
----
@@ -69,7 +57,7 @@ from("direct:in").precondition("'{{format}}' == 'xml'")
.to("direct:out");
----
-And the same example using XML DSL:
+You can write the same route described above using the xref:components:others:java-xml-io-dsl.adoc[XML DSL]:
[source,xml]
----
@@ -80,7 +68,7 @@ And the same example using XML DSL:
</route>
----
-And in YAML DSL:
+You can also write the same route described above using the xref:components:others:yaml-dsl.adoc[YAML DSL]:
[source,yaml]
----
@@ -96,4 +84,4 @@ And in YAML DSL:
== More Information
-See xref:route-builder.adoc[RouteBuilder] and xref:dsl.adoc[DSL] for a list of supported languages you can use for coding Camel routes.
+Check the xref:dsl.adoc[list of supported languages] that you can use for writing Camel routes.
diff --git a/docs/user-manual/modules/ROOT/pages/uris.adoc b/docs/user-manual/modules/ROOT/pages/uris.adoc
index 759066541f2..58df63d9349 100644
--- a/docs/user-manual/modules/ROOT/pages/uris.adoc
+++ b/docs/user-manual/modules/ROOT/pages/uris.adoc
@@ -1,8 +1,8 @@
= URIs
-Camel makes extensive use of URIs to allow you to refer to xref:endpoint.adoc[Endpoint]s.
+Camel makes extensive use of URIs to allow you to refer to xref:endpoint.adoc[Endpoints].
-For example the following URI:
+For example, consider the following URI:
[source,text]
----
@@ -11,17 +11,13 @@ kafka:cheese?brokers=mykafka:1234&clientId=foo
This endpoint is created by the xref:components::kafka-component.adoc[Kafka] component.
The URI contains endpoint configurations as context-path and query parameters.
-In this example the context-path is `cheese` which is the kafka topic to use.
+In this example, the context-path is `cheese` which is the kafka topic to use.
The query parameters have two parameters:
-- `brokers=mykafka:1234` which is the remote Kafka broker to connect to.
-- `clientId=foo` is the client id
+1. `brokers=mykafka:1234`: the remote Kafka broker to connect to.
+2. `clientId=foo`: the client id, which is a configuration of the Kafka component
-Make sure to read
-xref:faq:how-do-i-configure-endpoints.adoc[How do I configure endpoints]
-to learn more about configuring endpoints. For
-example how to refer to beans in the xref:registry.adoc[registry] or how
-to use raw values for password options, and using
-xref:using-propertyplaceholder.adoc[property placeholders], or how to use
-the type safe xref:Endpoint-dsl.adoc[Endpoint DSL] and xref:dataformat-dsl.adoc[DataFormat DSL].
+== More Information
+
+You can read the guide xref:faq:how-do-i-configure-endpoints.adoc[How do I configure endpoints] to learn more about configuring _endpoints_. Among other things, this guide explains how to refer to beans in the xref:registry.adoc[registry], how to use raw values for password options, how to use xref:using-propertyplaceholder.adoc[property placeholders], or how to use the type safe xref:Endpoint-dsl.adoc[Endpoint DSL] and xref:dataformat-dsl.adoc[DataFormat DSL].
[camel] 02/03: (chores) documentation: reorganize the categories for some of the guides
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 eddc37bfb0c42b2dcca405fa8c7bfb450dfe0f54
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Fri Jan 6 11:31:00 2023 +0100
(chores) documentation: reorganize the categories for some of the guides
---
.../working-with-camel-core/pages/index.adoc | 34 ++++++++++++----------
1 file changed, 18 insertions(+), 16 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 961f7d0e1dd..71101cb8309 100644
--- a/docs/main/modules/working-with-camel-core/pages/index.adoc
+++ b/docs/main/modules/working-with-camel-core/pages/index.adoc
@@ -44,53 +44,55 @@ Components are a fundamental building block of Apache Camel and are used to conn
* xref:manual::component.adoc[Component]: the comprehensive guide about components.
-
== Other Guides
Learn about additional ways to customize your integrations. Explore alternatives to consume and produce data as well as writing and defining routes.
* Data Processing
** xref:manual::dataformat-dsl.adoc[Data Format DSL]
-* Other
-** xref:manual::language-dsl.adoc[Language DSL]
-** xref:manual::camel-maven-archetypes.adoc[Camel Maven Archetypes]
-** xref:manual::lifecycle.adoc[Camel Lifecycle]
-** xref:manual::stream-caching.adoc[Stream caching]
** xref:manual::bean-binding.adoc[Bean Binding]
** xref:manual::bean-injection.adoc[Bean Injection]
** xref:manual::bean-integration.adoc[Bean Integration]
-** xref:manual::advice-with.adoc[Advice With]
-** xref:manual::camel-console.adoc[Camel Console]
+** xref:manual::consumertemplate.adoc[Consumer Template]
+** xref:manual::producertemplate.adoc[Producer Template]
+** xref:manual::processor.adoc[Processor]
+* Exchange
+** xref:manual::exchange.adoc[Exchange]
+** xref:manual::exchange-pattern.adoc[Exchange Pattern]
+** xref:manual::exchange-pooling.adoc[Exchange Pooling]
+** xref:manual::using-exchange-pattern-annotations.adoc[Using Exchange Pattern Annotations]
+* Context
** xref:manual::camelcontext.adoc[Camel Context]
** xref:manual::camelcontext-autoconfigure.adoc[Camel Context Auto Configuration]
** xref:manual::advanced-configuration-of-camelcontext-using-spring.adoc[Advanced Configuration of Camel Context]
+* Running Camel Applications and Other Runtime Guides
+** xref:manual::lifecycle.adoc[Camel Lifecycle]
+** xref:manual::camel-console.adoc[Camel Console]
** xref:manual::camel-maven-plugin.adoc[Camel Maven Plugin]
** xref:manual::camel-report-maven-plugin.adoc[Camel Report Maven Plugin]
-** xref:manual::consumertemplate.adoc[Consumer Template]
-** xref:manual::producertemplate.adoc[Producer Template]
+** xref:manual::security.adoc[Security]
+* Other
+** xref:manual::language-dsl.adoc[Language DSL]
+** xref:manual::camel-maven-archetypes.adoc[Camel Maven Archetypes]
+** xref:manual::stream-caching.adoc[Stream caching]
+** xref:manual::advice-with.adoc[Advice With]
** xref:manual::pojo-consuming.adoc[POJO Consuming]
** xref:manual::pojo-producing.adoc[POJO Producing]
** xref:manual::delay-interceptor.adoc[Delayer]
** xref:manual::configuring-route-startup-ordering-and-autostartup.adoc[Configuring Route Startup Ordering]
** xref:manual::endpoint.adoc[Endpoint]
** xref:manual::examples.adoc[Examples]
-** xref:manual::exchange.adoc[Exchange]
-** xref:manual::exchange-pattern.adoc[Exchange Pattern]
-** xref:manual::exchange-pooling.adoc[Exchange Pooling]
** xref:manual::json.adoc[JSON Data Format]
** xref:manual::languages.adoc[Languages]
** xref:manual::parameter-binding-annotations.adoc[Parameter-Binding Annotations]
-** xref:manual::processor.adoc[Processor]
** xref:manual::property-binding.adoc[Property Binding]
** xref:manual::registry.adoc[Registry]
** xref:manual::rest-dsl.adoc[Rest DSL]
** xref:manual::route-configuration.adoc[Route Configuration]
-** xref:manual::security.adoc[Security]
** xref:manual::service-registry.adoc[Service Registry]
** xref:manual::spring.adoc[Spring]
** xref:manual::spring-xml-extensions.adoc[Spring XML Extensions]
** xref:manual::uris.adoc[URIs]
-** xref:manual::using-exchange-pattern-annotations.adoc[Using Exchange Pattern Annotations]
** xref:manual::validator.adoc[Validator]
** xref:manual::what-are-the-dependencies.adoc[Camel Requirements]
** xref:manual::testing.adoc[Testing]