You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by da...@apache.org on 2021/08/17 08:55:20 UTC
[camel] branch camel-3.4.x updated (628488e -> 7a30000)
This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a change to branch camel-3.4.x
in repository https://gitbox.apache.org/repos/asf/camel.git.
from 628488e Polish and cleanup documentation
new 8760a35 Polish and cleanup documentation
new a0479ae Polish and cleanup documentation
new 7a30000 Polish and cleanup documentation
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:
.../src/main/docs/groovy-language.adoc | 15 ++++++-----
.../src/main/docs/xquery-component.adoc | 7 +-----
.../camel-saxon/src/main/docs/xquery-language.adoc | 13 +++++-----
.../camel-spring/src/main/docs/spring-summary.adoc | 3 +--
.../camel-sql/src/main/docs/sql-component.adoc | 4 +--
.../camel-xpath/src/main/docs/xpath-language.adoc | 29 ++++++++++++++++------
.../docs/modules/eips/pages/content-enricher.adoc | 2 +-
.../modules/eips/pages/message-translator.adoc | 2 +-
.../docs/modules/eips/pages/polling-consumer.adoc | 2 --
.../eips/pages/publish-subscribe-channel.adoc | 2 +-
.../main/docs/modules/eips/pages/rollback-eip.adoc | 10 --------
.../modules/eips/pages/transactional-client.adoc | 11 +++-----
.../docs/modules/eips/pages/unmarshal-eip.adoc | 3 ++-
.../main/docs/modules/eips/pages/wireTap-eip.adoc | 2 --
14 files changed, 51 insertions(+), 54 deletions(-)
[camel] 01/03: Polish and cleanup documentation
Posted by da...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch camel-3.4.x
in repository https://gitbox.apache.org/repos/asf/camel.git
commit 8760a3550630f1fbb12a379e431844956c4a4721
Author: Claus Ibsen <cl...@gmail.com>
AuthorDate: Tue Aug 17 10:44:45 2021 +0200
Polish and cleanup documentation
---
.../src/main/docs/modules/eips/pages/content-enricher.adoc | 2 +-
.../src/main/docs/modules/eips/pages/message-translator.adoc | 2 +-
.../src/main/docs/modules/eips/pages/polling-consumer.adoc | 2 --
.../docs/modules/eips/pages/publish-subscribe-channel.adoc | 2 +-
.../src/main/docs/modules/eips/pages/rollback-eip.adoc | 10 ----------
.../main/docs/modules/eips/pages/transactional-client.adoc | 11 ++++-------
.../src/main/docs/modules/eips/pages/unmarshal-eip.adoc | 3 ++-
.../src/main/docs/modules/eips/pages/wireTap-eip.adoc | 2 --
8 files changed, 9 insertions(+), 25 deletions(-)
diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/content-enricher.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/content-enricher.adoc
index 5a32621..a3ce956 100644
--- a/core/camel-core-engine/src/main/docs/modules/eips/pages/content-enricher.adoc
+++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/content-enricher.adoc
@@ -14,7 +14,7 @@ image::eip/DataEnricher.gif[image]
[[ContentEnricher-ContentenrichmentusingaMessageTranslatororaProcessor]]
== Content enrichment using a Message Translator or a Processor
-You can use xref:latest@manual:ROOT:templating.adoc[Templating] to consume a message from
+You can consume a message from
one destination, transform it with something like
xref:components::velocity-component.adoc[Velocity] or xref:components::xquery-component.adoc[XQuery], and then send
it on to another destination. For example using InOnly (one way
diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/message-translator.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/message-translator.adoc
index 4974569..aef4c99 100644
--- a/core/camel-core-engine/src/main/docs/modules/eips/pages/message-translator.adoc
+++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/message-translator.adoc
@@ -52,7 +52,7 @@ invoke a bean
</route>
----
-You can also use xref:latest@manual:ROOT:templating.adoc[Templating] to consume a message
+You can consume a message
from one destination, transform it with something like
xref:components::velocity-component.adoc[Velocity] or xref:components::xquery-component.adoc[XQuery] and then send
it on to another destination. For example using InOnly (one way
diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/polling-consumer.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/polling-consumer.adoc
index 628bd34..7763604 100644
--- a/core/camel-core-engine/src/main/docs/modules/eips/pages/polling-consumer.adoc
+++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/polling-consumer.adoc
@@ -421,5 +421,3 @@ defined in the xref:latest@manual:ROOT:registry.adoc[Registry] with the bean id
from("file://inbox/?pollStrategy=#myPoll").to("activemq:queue:inbox")
----
-xref:latest@manual:ROOT:using-this-pattern.adoc[Using This Pattern]
-
diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/publish-subscribe-channel.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/publish-subscribe-channel.adoc
index c9b7c5e..55f2fe4 100644
--- a/core/camel-core-engine/src/main/docs/modules/eips/pages/publish-subscribe-channel.adoc
+++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/publish-subscribe-channel.adoc
@@ -23,7 +23,7 @@ image::eip/PublishSubscribeSolution.gif[image]
Another option is to explicitly list the publish-subscribe relationship
in your routing logic; this keeps the producer and consumer decoupled
but lets you control the fine grained routing configuration using the
-xref:latest@manual:ROOT:dsl.adoc[DSL] or xref:latest@manual:ROOT:xml-configuration.adoc[Xml Configuration].
+xref:latest@manual:ROOT:dsl.adoc[DSL].
In Java code:
diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/rollback-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/rollback-eip.adoc
index 28fa95d..3bfff96 100644
--- a/core/camel-core-engine/src/main/docs/modules/eips/pages/rollback-eip.adoc
+++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/rollback-eip.adoc
@@ -186,16 +186,6 @@ then we configure our routes. Notice that all we have to do is mark the
route as transacted using the *transacted*
tag.https://github.com/apache/camel/blob/master/components/camel-jms/src/test/resources/org/apache/camel/component/jms/tx/TransactionMinimalConfigurationTest.xml[TransactionMinimalConfigurationTest.xml]
-Transaction error handler
-
-When a route is marked as transacted using *transacted* Camel will
-automatic use the
-xref:latest@manual:ROOT:transactionerrorhandler.adoc[TransactionErrorHandler] as
-xref:latest@manual:ROOT:error-handler.adoc[Error Handler]. It supports basically the same
-feature set as the xref:latest@manual:ROOT:defaulterrorhandler.adoc[DefaultErrorHandler],
-so you can for instance use xref:latest@manual:ROOT:exception-clause.adoc[Exception Clause]
-as well.
-
== Integration Testing with Spring
An Integration Test here means a test runner class annotated
diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/transactional-client.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/transactional-client.adoc
index 4da29f4..65c6a9c 100644
--- a/core/camel-core-engine/src/main/docs/modules/eips/pages/transactional-client.adoc
+++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/transactional-client.adoc
@@ -288,13 +288,10 @@ route as transacted using the *transacted* tag.
=== Transaction error handler
When a route is marked as transacted using *transacted* Camel will
-automatic use the
-xref:latest@manual:ROOT:transactionerrorhandler.adoc[TransactionErrorHandler]
-as xref:latest@manual:ROOT:error-handler.adoc[Error Handler].
-It supports basically the same feature set as the
-xref:latest@manual:ROOT:defaulterrorhandler.adoc[DefaultErrorHandler],
-so you can for instance use
-xref:latest@manual:ROOT:exception-clause.adoc[Exception Clause]
+automatic use `TransactionErrorHandler` as the
+xref:latest@manual:ROOT:error-handler.adoc[Error Handler]. This error handler supports basically the same
+feature set as the xref:latest@manual:ROOT:defaulterrorhandler.adoc[DefaultErrorHandler],
+so you can for instance use xref:latest@manual:ROOT:exception-clause.adoc[Exception Clause]
as well.
[[TransactionalClient-IntegrationTestingwithSpring]]
diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/unmarshal-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/unmarshal-eip.adoc
index c9f15be..d998681 100644
--- a/core/camel-core-engine/src/main/docs/modules/eips/pages/unmarshal-eip.adoc
+++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/unmarshal-eip.adoc
@@ -1,7 +1,8 @@
[[unmarshal-eip]]
= Unmarshal EIP
-If you receive a message from one of the Camel xref:components::index.adoc[Components] such as xref:components::file-component.adoc[File], xref:components::http-component.adoc[HTTP] or xref:components::jms-component.adoc[JMS] you often want to unmarshal the payload into some bean so that you can process it using some xref:latest@manual:ROOT:bean-integration.adoc[Bean Integration] or perform xref:latest@manual:ROOT:predicate.adoc[Predicate] evaluation and so forth. To do this use the *unm [...]
+If you receive a message from one of the Camel xref:components::index.adoc[Components] such as xref:components::file-component.adoc[File], xref:components::http-component.adoc[HTTP] or xref:components::jms-component.adoc[JMS] you often want to unmarshal the payload into some bean so that you can process it using some xref:latest@manual:ROOT:bean-integration.adoc[Bean Integration] or perform xref:latest@manual:ROOT:predicate.adoc[Predicate] evaluation and so forth.
+
== Options
diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/wireTap-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/wireTap-eip.adoc
index 2ffc610..7316edf 100644
--- a/core/camel-core-engine/src/main/docs/modules/eips/pages/wireTap-eip.adoc
+++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/wireTap-eip.adoc
@@ -204,5 +204,3 @@ The following example sends a new message which has
== Using `onPrepare` to Execute Custom Logic when Preparing Messages
See details at xref:multicast-eip.adoc[Multicast]
-
-xref:latest@manual:ROOT:using-this-pattern.adoc[Using This Pattern]
[camel] 02/03: Polish and cleanup documentation
Posted by da...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch camel-3.4.x
in repository https://gitbox.apache.org/repos/asf/camel.git
commit a0479aef013dd6c1ac76510c809ee83197cc8577
Author: Claus Ibsen <cl...@gmail.com>
AuthorDate: Tue Aug 17 10:47:33 2021 +0200
Polish and cleanup documentation
---
.../src/main/docs/groovy-language.adoc | 15 ++++++-----
.../src/main/docs/xquery-component.adoc | 7 +-----
.../camel-saxon/src/main/docs/xquery-language.adoc | 13 +++++-----
.../camel-xpath/src/main/docs/xpath-language.adoc | 29 ++++++++++++++++------
4 files changed, 39 insertions(+), 25 deletions(-)
diff --git a/components/camel-groovy/src/main/docs/groovy-language.adoc b/components/camel-groovy/src/main/docs/groovy-language.adoc
index d4fedfe..09e86c4 100644
--- a/components/camel-groovy/src/main/docs/groovy-language.adoc
+++ b/components/camel-groovy/src/main/docs/groovy-language.adoc
@@ -8,17 +8,20 @@
*Since Camel {since}*
-Camel supports http://groovy.codehaus.org/[Groovy] among other
-Scripting Languages to allow an
-Expression or Predicate to be
-used in the DSL or xref:manual::xml-configuration.adoc[Xml
-Configuration].
+Camel supports http://www.groovy-lang.org/[Groovy] to allow an
+xref:manual::expression.adoc[Expression] or xref:manual::predicate.adoc[Predicate] to be
+used in the xref:manual::dsl.adoc[DSL].
+
+For example you could use Groovy to create an
+Predicate in a xref:{eip-vc}:eips:filter-eip.adoc[Message
+Filter] or as an Expression for a
+xref:{eip-vc}:eips:recipientList-eip.adoc[Recipient List].
To use a Groovy expression use the following Java code
[source,java]
---------------------------------------
-... groovy("someGroovyExpression") ...
+groovy("someGroovyExpression")
---------------------------------------
For example you could use the *groovy* function to create an
diff --git a/components/camel-saxon/src/main/docs/xquery-component.adoc b/components/camel-saxon/src/main/docs/xquery-component.adoc
index 2493d3b..6746fe6 100644
--- a/components/camel-saxon/src/main/docs/xquery-component.adoc
+++ b/components/camel-saxon/src/main/docs/xquery-component.adoc
@@ -11,12 +11,7 @@
*{component-header}*
-Camel supports http://www.w3.org/TR/xquery/[XQuery] to allow an
-Expression or Predicate to be
-used in the DSL or xref:manual::xml-configuration.adoc[Xml
-Configuration]. For example you could use XQuery to create an
-Predicate in a xref:{eip-vc}:eips:filter-eip.adoc[Message
-Filter] or as an Expression for a Recipient List.
+Camel supports http://www.w3.org/TR/xquery/[XQuery] component for message transformation
== Options
diff --git a/components/camel-saxon/src/main/docs/xquery-language.adoc b/components/camel-saxon/src/main/docs/xquery-language.adoc
index 891f6db..57d48e9 100644
--- a/components/camel-saxon/src/main/docs/xquery-language.adoc
+++ b/components/camel-saxon/src/main/docs/xquery-language.adoc
@@ -9,12 +9,13 @@
*Since Camel {since}*
Camel supports http://www.w3.org/TR/xquery/[XQuery] to allow an
-Expression or Predicate to be
-used in the DSL or xref:manual::xml-configuration.adoc[Xml
-Configuration]. For example you could use XQuery to create an
+xref:manual::expression.adoc[Expression] or xref:manual::predicate.adoc[Predicate] to be
+used in the xref:manual::dsl.adoc[DSL].
+
+For example you could use XQuery to create an
Predicate in a xref:{eip-vc}:eips:filter-eip.adoc[Message
Filter] or as an Expression for a
-Recipient List.
+xref:{eip-vc}:eips:recipientList-eip.adoc[Recipient List].
== XQuery Language options
@@ -114,7 +115,7 @@ attribute:
[source,xml]
-------------------------------------------------------------------------------
- <xquery type="java.lang.String">concat('mock:foo.', /person/@city)</xquery>
+<xquery type="java.lang.String">concat('mock:foo.', /person/@city)</xquery>
-------------------------------------------------------------------------------
== Learning XQuery
@@ -151,7 +152,7 @@ If you use maven you could just add the following to your pom.xml,
substituting the version number for the latest & greatest release (see
the download page for the latest versions).
-[source,java]
+[source,xml]
--------------------------------------
<dependency>
<groupId>org.apache.camel</groupId>
diff --git a/components/camel-xpath/src/main/docs/xpath-language.adoc b/components/camel-xpath/src/main/docs/xpath-language.adoc
index d56e713..fdc516e 100644
--- a/components/camel-xpath/src/main/docs/xpath-language.adoc
+++ b/components/camel-xpath/src/main/docs/xpath-language.adoc
@@ -9,12 +9,13 @@
*Since Camel {since}*
Camel supports http://www.w3.org/TR/xpath[XPath] to allow an
-Expression or Predicate to be
-used in the DSL or xref:manual::xml-configuration.adoc[Xml
-Configuration]. For example you could use XPath to create an
+xref:manual::expression.adoc[Expression] or xref:manual::predicate.adoc[Predicate] to be
+used in the xref:manual::dsl.adoc[DSL].
+
+For example you could use XPath to create an
Predicate in a xref:{eip-vc}:eips:filter-eip.adoc[Message
Filter] or as an Expression for a
-Recipient List.
+xref:{eip-vc}:eips:recipientList-eip.adoc[Recipient List].
*Streams*
@@ -226,14 +227,14 @@ shown:
== Examples
Here is a simple
-https://github.com/apache/camel/blob/master/camel-core/src/test/java/org/apache/camel/processor/XPathFilterTest.java[example]
+https://github.com/apache/camel/blob/main/core/camel-core/src/test/java/org/apache/camel/processor/XPathFilterTest.java[example]
using an XPath expression as a predicate in a
Message Filter
If you have a standard set of namespaces you wish to work with and wish
to share them across many different XPath expressions you can use the
NamespaceBuilder as shown
-https://github.com/apache/camel/blob/master/camel-core/src/test/java/org/apache/camel/processor/XPathWithNamespaceBuilderFilterTest.java[in
+https://github.com/apache/camel/blob/main/core/camel-core/src/test/java/org/apache/camel/processor/XPathWithNamespaceBuilderFilterTest.java[in
this example]
In this sample we have a choice construct. The first choice evaulates if
@@ -495,6 +496,20 @@ eg to refer to a file on the classpath you can do:
== Dependencies
-The XPath language is part of camel-core.
+To use XPath in your camel routes you need to add the a dependency on
+*camel-xpath* which implements the XPath language.
+
+If you use maven you could just add the following to your pom.xml,
+substituting the version number for the latest & greatest release (see
+the download page for the latest versions).
+
+[source,xml]
+--------------------------------------
+<dependency>
+ <groupId>org.apache.camel</groupId>
+ <artifactId>camel-xpath</artifactId>
+ <version>x.x.x</version>
+</dependency>
+--------------------------------------
include::{page-component-version}@camel-spring-boot::page$xpath-starter.adoc[]
[camel] 03/03: Polish and cleanup documentation
Posted by da...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch camel-3.4.x
in repository https://gitbox.apache.org/repos/asf/camel.git
commit 7a30000d2cd3ed8b5aa3b549f040b23c9156a143
Author: Claus Ibsen <cl...@gmail.com>
AuthorDate: Tue Aug 17 10:48:57 2021 +0200
Polish and cleanup documentation
---
components/camel-spring/src/main/docs/spring-summary.adoc | 3 +--
components/camel-sql/src/main/docs/sql-component.adoc | 4 ++--
2 files changed, 3 insertions(+), 4 deletions(-)
diff --git a/components/camel-spring/src/main/docs/spring-summary.adoc b/components/camel-spring/src/main/docs/spring-summary.adoc
index 08a7611..41a3200 100644
--- a/components/camel-spring/src/main/docs/spring-summary.adoc
+++ b/components/camel-spring/src/main/docs/spring-summary.adoc
@@ -209,8 +209,7 @@ above in the `<packageScan>` documentation.
== How do I import routes from other XML files
-When defining routes in Camel using xref:manual::xml-configuration.adoc[Xml
-Configuration] you may want to define some routes in other XML files.
+When defining routes in Camel using Spring XML you may want to define some routes in other XML files.
For example you may have many routes and it may help to maintain the
application if some of the routes are in separate XML files. You may
also want to store common and reusable routes in other XML files, which
diff --git a/components/camel-sql/src/main/docs/sql-component.adoc b/components/camel-sql/src/main/docs/sql-component.adoc
index 59b415d..661d720 100644
--- a/components/camel-sql/src/main/docs/sql-component.adoc
+++ b/components/camel-sql/src/main/docs/sql-component.adoc
@@ -235,8 +235,8 @@ You can use the option `useMessageBodyForSql` that
allows to use the message body as the SQL statement, and then the SQL
parameters must be provided in a header with the
key `SqlConstants.SQL_PARAMETERS`. This allows the SQL component to work
-more dynamically as the SQL query is from the message body. Use
-xref:manual::templating.adoc[Camel templating]
+more dynamically as the SQL query is from the message body. Use templating
+(such as xref:components::velocity-component.adoc[Velocity], xref:components::freemarker-component.adoc[Freemarker])
for conditional processing, e.g. to include or exclude `where` clauses
depending on the presence of query parameters.