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 2024/02/21 16:50:32 UTC
(camel) branch main updated (6994830e967 -> 740cb59daae)
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 6994830e967 CAMEL-20410: documentation fixes for camel-resourceresolver-github
new 4ec58e98f85 CAMEL-20410: documentation fixes for camel-rest
new b5fed2e6674 CAMEL-20410: documentation fixes for camel-rest-openapi
new e4adfbb18d3 CAMEL-20410: documentation fixes for camel-robotframework
new 20af02584d5 CAMEL-20410: documentation fixes for camel-rss
new 6f75273f52b CAMEL-20410: documentation fixes for camel-salesforce
new 61bd5e2d7f8 CAMEL-20410: documentation fixes for camel-sap-netweaver
new be065af2d5b CAMEL-20410: documentation fixes for camel-xquery
new 7a4fb7485fa CAMEL-20410: documentation fixes for camel-scheduler
new 323c0d01032 CAMEL-20410: documentation fixes for camel-schematron
new fad856f8c55 CAMEL-20410: documentation fixes for camel-servicenow
new 740cb59daae CAMEL-20410: documentation fixes for camel-servlet
The 11 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/rest-openapi-component.adoc | 28 ++++++++-------
.../camel-rest/src/main/docs/rest-component.adoc | 42 +++++++++++-----------
.../src/main/docs/robotframework-component.adoc | 11 +++---
.../camel-rss/src/main/docs/rss-component.adoc | 8 ++---
.../src/main/docs/salesforce-component.adoc | 40 ++++++++++-----------
.../src/main/docs/sap-netweaver-component.adoc | 8 ++---
.../src/main/docs/xquery-component.adoc | 33 ++++++++---------
.../camel-saxon/src/main/docs/xquery-language.adoc | 35 +++++++++---------
.../src/main/docs/scheduler-component.adoc | 6 ++--
.../src/main/docs/schematron-component.adoc | 12 +++----
.../src/main/docs/servicenow-component.adoc | 4 +--
.../src/main/docs/servlet-component.adoc | 28 +++++++--------
12 files changed, 129 insertions(+), 126 deletions(-)
(camel) 09/11: CAMEL-20410: documentation fixes for camel-schematron
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 323c0d01032eda2dcac444d70db41551bda8b186
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Wed Feb 21 17:04:38 2024 +0100
CAMEL-20410: documentation fixes for camel-schematron
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
- Converted to use tabs
---
.../camel-schematron/src/main/docs/schematron-component.adoc | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/components/camel-schematron/src/main/docs/schematron-component.adoc b/components/camel-schematron/src/main/docs/schematron-component.adoc
index 9043d87717c..3fb838b84bb 100644
--- a/components/camel-schematron/src/main/docs/schematron-component.adoc
+++ b/components/camel-schematron/src/main/docs/schematron-component.adoc
@@ -16,17 +16,17 @@
http://www.schematron.com/index.html[Schematron] is an XML-based
language for validating XML instance documents. It is used to make
-assertions about data in an XML document and it is also used to express
+assertions about data in an XML document, and it is also used to express
operational and business rules. Schematron is
an http://standards.iso.org/ittf/PubliclyAvailableStandards/index.html[ISO
Standard]. The schematron component uses the leading
http://www.schematron.com/implementation.html[implementation] of ISO
-schematron. It is an XSLT based implementation. The schematron rules is
+schematron. It is an XSLT based implementation. The schematron rules are
run through http://www.schematron.com/implementation.html[four XSLT
pipelines], which generates a final XSLT which will be used as the basis
for running the assertion against the XML document. The component is
written in a way that Schematron rules are loaded at the start of the
-endpoint (only once) this is to minimise the overhead of instantiating a
+endpoint (only once) this is to minimize the overhead of instantiating a
Java Templates object representing the rules.
== URI format
@@ -101,11 +101,11 @@ XML DSL. The schematrion rules file is sourced from the file system:
*Where to store schematron rules?*
Schematron rules can change with business requirement, as such it is
-recommended to store these rules somewhere in file system. When the
+recommended to store these rules somewhere in a file system. When the
schematron component endpoint is started, the rules are compiled into
-XSLT as a Java Templates Object. This is done only once to minimise the
+XSLT as a Java Templates Object. This is done only once to minimize the
overhead of instantiating Java Templates object, which can be an
-expensive operation for large set of rules and given that the process
+expensive operation for a large set of rules and given that the process
goes through four pipelines
of http://www.schematron.com/implementation.html[XSLT transformations].
So if you happen to store the rules in the file system, in the event of
(camel) 08/11: CAMEL-20410: documentation fixes for camel-scheduler
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 7a4fb7485fa6f80d097652ebe84647a7f25f891e
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Wed Feb 21 17:03:45 2024 +0100
CAMEL-20410: documentation fixes for camel-scheduler
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
- Converted to use tabs
---
components/camel-scheduler/src/main/docs/scheduler-component.adoc | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/components/camel-scheduler/src/main/docs/scheduler-component.adoc b/components/camel-scheduler/src/main/docs/scheduler-component.adoc
index 96421ece739..507b2f85190 100644
--- a/components/camel-scheduler/src/main/docs/scheduler-component.adoc
+++ b/components/camel-scheduler/src/main/docs/scheduler-component.adoc
@@ -109,11 +109,11 @@ keep firing all the time. So use this with caution.
== Forcing the scheduler to be idle
There can be use cases where you want the scheduler to trigger and be
-greedy. But sometimes you want "tell the scheduler" that there was no
+greedy. But sometimes you want to "tell the scheduler" that there was no
task to poll, so the scheduler can change into idle mode using the
-backoff options. To do this you would need to set a property on the
+backoff options. To do this, you would need to set a property on the
exchange with the key `Exchange.SCHEDULER_POLLED_MESSAGES` to a boolean
-value of false. This will cause the consumer to indicate that there was
+value of false. This will cause the consumer to indicate that there were
no messages polled.
The consumer will otherwise as by default return 1 message polled to the
(camel) 10/11: CAMEL-20410: documentation fixes for camel-servicenow
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 fad856f8c55baccf2b06632b9f608c38dc54b236
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Wed Feb 21 17:05:57 2024 +0100
CAMEL-20410: documentation fixes for camel-servicenow
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
- Converted to use tabs
---
.../src/main/docs/servicenow-component.adoc | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/components/camel-servicenow/camel-servicenow-component/src/main/docs/servicenow-component.adoc b/components/camel-servicenow/camel-servicenow-component/src/main/docs/servicenow-component.adoc
index 081f443b442..29b281a9027 100644
--- a/components/camel-servicenow/camel-servicenow-component/src/main/docs/servicenow-component.adoc
+++ b/components/camel-servicenow/camel-servicenow-component/src/main/docs/servicenow-component.adoc
@@ -16,9 +16,9 @@
The ServiceNow component provides access to ServiceNow platform through their REST API.
-The component supports multiple version of ServiceNow platform with default to Helsinki.
+The component supports multiple versions of ServiceNow platform with default to Helsinki.
-Maven users will need to add the following dependency to their pom.xml
+Maven users will need to add the following dependency to their `pom.xml`
for this component:
[source,xml]
(camel) 07/11: CAMEL-20410: documentation fixes for camel-xquery
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 be065af2d5b3cd95f0877bd5558f647fca8f5ab7
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Wed Feb 21 17:02:24 2024 +0100
CAMEL-20410: documentation fixes for camel-xquery
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
- Converted to use tabs
---
.../src/main/docs/xquery-component.adoc | 33 ++++++++++----------
.../camel-saxon/src/main/docs/xquery-language.adoc | 35 +++++++++++-----------
2 files changed, 34 insertions(+), 34 deletions(-)
diff --git a/components/camel-saxon/src/main/docs/xquery-component.adoc b/components/camel-saxon/src/main/docs/xquery-component.adoc
index 10e2cd27b43..e2ff2c7d3c0 100644
--- a/components/camel-saxon/src/main/docs/xquery-component.adoc
+++ b/components/camel-saxon/src/main/docs/xquery-component.adoc
@@ -40,8 +40,8 @@ from("queue:foo")
---------------------------
You can also use functions inside your query, in which case you need an
-explicit type conversion (or you will get a org.w3c.dom.DOMException:
-HIERARCHY_REQUEST_ERR) by passing the Class as a second argument to the
+explicit type conversion (otherwise you will get a `org.w3c.dom.DOMException:
+HIERARCHY_REQUEST_ERR`), by passing the Class as a second argument to the
*xquery()* method.
[source,java]
@@ -52,8 +52,8 @@ from("direct:start")
== Variables
-The IN message body will be set as the `contextItem`. Besides this these
-Variables is also added as parameters:
+The IN message body will be set as the `contextItem`. Besides this, these
+Variables are also added as parameters:
[width="100%",cols="10%,10%,80%",options="header",]
|=======================================================================
@@ -72,15 +72,15 @@ the variable which name is in.headers.foo
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 is added
-with they own key name, for instance if there is an IN header with the
+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*.
|=======================================================================
== Using XML configuration
If you prefer to configure your routes in your Spring
-XML file then you can use XPath expressions as follows
+XML file, then you can use XPath expressions as follows
[source,xml]
---------------------------------------------------------------------------------------------------------------
@@ -104,9 +104,9 @@ XML file then you can use XPath expressions as follows
---------------------------------------------------------------------------------------------------------------
Notice how we can reuse the namespace prefixes, *foo* in this case, in
-the XPath expression for easier namespace based XQuery expressions!
+the XPath expression for easier namespace-based XQuery expressions!
-When you use functions in your XQuery expression you need an explicit
+When you use functions in your XQuery expression, you need an explicit
type conversion which is done in the xml configuration via the *@type*
attribute:
@@ -120,7 +120,7 @@ attribute:
Sometimes an XQuery expression can be quite large; it can essentally be
used for Templating. So you may want to use an
-XQuery Endpoint so you can route using XQuery
+XQuery Endpoint, so you can route using XQuery
templates.
The following example shows how to take a message of an ActiveMQ queue
@@ -139,10 +139,10 @@ The following example shows how to take a message of an ActiveMQ queue
== Loading script from external resource
-You can externalize the script and have Camel load it from a resource
+You can externalize the script and have Apache Camel load it from a resource
such as `"classpath:"`, `"file:"`, or `"http:"`.
This is done using the following syntax: `"resource:scheme:location"`,
-e.g. to refer to a file on the classpath you can do:
+e.g., to refer to a file on the classpath you can do:
[source,java]
------------------------------------------------------------------------------
@@ -152,17 +152,18 @@ e.g. to refer to a file on the classpath you can do:
== Learning XQuery
XQuery is a very powerful language for querying, searching, sorting and
-returning XML. For help learning XQuery try these tutorials
+returning XML.
+For help learning XQuery, try these tutorials
* Mike Kay's http://www.stylusstudio.com/xquery_primer.html[XQuery Primer]
* The W3Schools https://www.w3schools.com/xml/xquery_intro.asp[XQuery Tutorial]
== Dependencies
-To use XQuery in your camel routes you need to add the dependency on
-*camel-saxon* which implements the XQuery language.
+To use XQuery in your Camel routes, you need to add the dependency on
+*camel-saxon*, which implements the XQuery language.
-If you use maven you could just add the following to your pom.xml,
+If you use Maven, you could add the following to your `pom.xml`,
substituting the version number for the latest & greatest release.
[source,xml]
diff --git a/components/camel-saxon/src/main/docs/xquery-language.adoc b/components/camel-saxon/src/main/docs/xquery-language.adoc
index 36f87c9a5e3..4a34bf41b92 100644
--- a/components/camel-saxon/src/main/docs/xquery-language.adoc
+++ b/components/camel-saxon/src/main/docs/xquery-language.adoc
@@ -38,11 +38,11 @@ And the following variables are available as well:
|out.body |Object |*deprecated* The OUT message body (if any)
|in.headers.* |Object |You can access the value of exchange.in.headers with key *foo* by using
the variable which name is in.headers.foo
-|out.headers.* |Object |*deprecated* You can access the value of exchange.out.headers with key *foo* by using
-the variable which name is out.headers.foo variable
-|*key name* |Object |Any exchange.properties and exchange.in.headers and any additional
+|out.headers.* |Object |*deprecated* You can access the value of `exchange.out.headers` with key *foo* by using
+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 they own key name, for instance if there is an IN header with the
+with their own key name, for instance, if there is an IN header with the
key name *foo* then its added as *foo*.
|=======================================================================
@@ -58,7 +58,7 @@ from("queue:foo")
You can also use functions inside your query, in which case you need an
explicit type conversion, or you will get an `org.w3c.dom.DOMException:
HIERARCHY_REQUEST_ERR`). You need to pass in the expected output type of the function.
-For example the concat function returns a `String` which is done as shown:
+For example, the concat function returns a `String` which is done as shown:
[source,java]
-----------------------------------------------------------------------------
@@ -81,7 +81,7 @@ And in XML DSL:
=== Using namespaces
If you have a standard set of namespaces you wish to work with and wish
-to share them across many XQuery expressions you can use the
+to share them across many XQuery expressions, you can use the
`org.apache.camel.support.builder.Namespaces` when using Java DSL as shown:
[source,java]
@@ -94,10 +94,10 @@ from("direct:start")
----
Notice how the namespaces are provided to `xquery` with the `ns` variable
-that are passed in as the 2nd parameter.
+that are passed in as the second parameter.
Each namespace is a key=value pair, where the prefix is the key.
-In the XQuery expression then the namespace is used by its prefix, eg:
+In the XQuery expression then the namespace is used by its prefix, e.g.:
[source,text]
----
@@ -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 setup the namespaces
+When using namespaces in XML DSL then its 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`,
@@ -155,7 +155,7 @@ from("direct:start").
Notice that xquery will use DOMResult by default, so if we want to grab
the value of the person node, using `text()` we need to tell XQuery to use
-String as result type, as shown:
+String as the result type, as shown:
[source,java]
-------------------------------------------------------------
@@ -178,10 +178,10 @@ declare them in the XQuery expression.
== Loading script from external resource
-You can externalize the script and have Camel load it from a resource
+You can externalize the script and have Apache Camel load it from a resource
such as `"classpath:"`, `"file:"`, or `"http:"`.
This is done using the following syntax: `"resource:scheme:location"`,
-e.g. to refer to a file on the classpath you can do:
+e.g., to refer to a file on the classpath you can do:
[source,java]
------------------------------------------------------------------------------
@@ -191,19 +191,18 @@ e.g. to refer to a file on the classpath you can do:
== Learning XQuery
XQuery is a very powerful language for querying, searching, sorting and
-returning XML. For help learning XQuery try these tutorials
+returning XML. For help learning XQuery, try these tutorials
* Mike Kay's http://www.stylusstudio.com/xquery_primer.html[XQuery Primer]
* The W3Schools http://www.w3schools.com/xml/xquery_intro.asp[XQuery Tutorial]
== Dependencies
-To use XQuery in your camel routes you need to add the a dependency on
-*camel-saxon* which implements the XQuery language.
+To use XQuery in your Camel routes, you need to add the dependency on
+*camel-saxon*, which implements the XQuery 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).
+If you use Maven you could add the following to your `pom.xml`,
+substituting the version number for the latest & greatest release.
[source,xml]
--------------------------------------
(camel) 06/11: CAMEL-20410: documentation fixes for camel-sap-netweaver
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 61bd5e2d7f8910b14c076f57beaacb35b2f8c8c6
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Wed Feb 21 16:57:00 2024 +0100
CAMEL-20410: documentation fixes for camel-sap-netweaver
- Fixed grammar and typos
---
.../src/main/docs/sap-netweaver-component.adoc | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/components/camel-sap-netweaver/src/main/docs/sap-netweaver-component.adoc b/components/camel-sap-netweaver/src/main/docs/sap-netweaver-component.adoc
index d76e93ef6c1..264f14fd9c3 100644
--- a/components/camel-sap-netweaver/src/main/docs/sap-netweaver-component.adoc
+++ b/components/camel-sap-netweaver/src/main/docs/sap-netweaver-component.adoc
@@ -43,10 +43,10 @@ sap-netweaver:https://host:8080/path?username=foo&password=secret
== Prerequisites
-You would need to have an account to the SAP NetWeaver system to be able
+You would need to have an account on the SAP NetWeaver system to be able
to leverage this component. SAP provides a
http://scn.sap.com/docs/DOC-31221#section6[demo setup] where you can
-requires for an account.
+request an account.
This component uses the basic authentication scheme for logging into SAP
NetWeaver.
@@ -103,7 +103,7 @@ from("direct:start")
.to("velocity:flight-info.vm")
-----------------------------------------------------------------------------
-Where url, username, password and command is defined as:
+Where `url`, `username`, `password` and `command` are defined as:
[source,java]
---------------------------------------------------------------------------------------------------------------------------------------
@@ -137,7 +137,7 @@ HTML page
</html>
------------------------------------------------------------------------
-When running the application you get sample output:
+When running the application, you get sample output:
-------------------------------
Flight information:
(camel) 04/11: CAMEL-20410: documentation fixes for camel-rss
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 20af02584d5b364e2dfd8c76eae942604f3f0ee9
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Wed Feb 21 16:47:52 2024 +0100
CAMEL-20410: documentation fixes for camel-rss
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
- Converted to use tabs
---
components/camel-rss/src/main/docs/rss-component.adoc | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/components/camel-rss/src/main/docs/rss-component.adoc b/components/camel-rss/src/main/docs/rss-component.adoc
index f92670067e7..95c4dc4ed55 100644
--- a/components/camel-rss/src/main/docs/rss-component.adoc
+++ b/components/camel-rss/src/main/docs/rss-component.adoc
@@ -14,8 +14,8 @@
*{component-header}*
-The RSS component is used for polling RSS feeds. Camel will default
-poll the feed every 60th seconds.
+The RSS component is used for polling RSS feeds. By default, Camel will
+poll the feed every 60th second.
Maven users will need to add the following dependency to their `pom.xml`
for this component:
@@ -30,7 +30,7 @@ for this component:
</dependency>
------------------------------------------------------------
-*Note:* The component currently only supports polling (consuming) feeds.
+NOTE: The component currently only supports consuming feeds.
== URI format
@@ -74,7 +74,7 @@ a `SyndFeed` with one `SyndEntry` or a `java.util.List` of `SyndEntrys`.
== Example
If the URL for the RSS feed uses query parameters, this component will
-resolve them. For example if the feed uses `alt=rss`, then the following example will be resolved:
+resolve them. For example, if the feed uses `alt=rss`, then the following example will be resolved:
[source,java]
----
(camel) 05/11: CAMEL-20410: documentation fixes for camel-salesforce
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 6f75273f52b19a40ed267ca5d9b0e66bc4cca0ec
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Wed Feb 21 16:55:15 2024 +0100
CAMEL-20410: documentation fixes for camel-salesforce
- Fixed grammar and typos
---
.../src/main/docs/salesforce-component.adoc | 40 +++++++++++-----------
1 file changed, 20 insertions(+), 20 deletions(-)
diff --git a/components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce-component.adoc b/components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce-component.adoc
index 9ad13e05c4e..d72db1e6040 100644
--- a/components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce-component.adoc
+++ b/components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce-component.adoc
@@ -22,7 +22,7 @@ generates these DTOs.
====
Developers wishing to contribute to the component are instructed
to look at the https://github.com/apache/camel/tree/main/components/camel-salesforce/camel-salesforce-component/README.md[README.md] file on instructions on how to get started and
-setup your environment for running integration tests.
+set up your environment for running integration tests.
====
== Getting Started
@@ -52,7 +52,7 @@ Spring Boot users should use the starter instead.
----
. *Generate DTOs*. Optionally, generate Java DTOs to represent your salesforce objects. This step isn't a hard requirement per se, but most use cases will benefit from the type safety and auto-completion. Use the <<MavenPlugin,maven plugin>> to generate DTOs for the salesforce objects you'll be working with.
-. *Configure authentication*. Using the OAuth key and secret you generated previously, configure salesforce <<AuthenticatingToSalesforce,authentication>>.
+. *Configure authentication*. Using the OAuth key and secret, you generated previously, configure salesforce <<AuthenticatingToSalesforce,authentication>>.
. *Create routes*. Starting creating routes that interact with salesforce!
@@ -80,7 +80,7 @@ The component supports three OAuth authentication flows:
* https://help.salesforce.com/articleView?id=remoteaccess_oauth_refresh_token_flow.htm[OAuth 2.0 Refresh Token Flow]
* https://help.salesforce.com/articleView?id=remoteaccess_oauth_jwt_flow.htm[OAuth 2.0 JWT Bearer Token Flow]
-For each of the flows, different sets of properties needs to be set:
+For each of the flows, different sets of properties need to be set:
.Properties to set for each authentication flow
|===
@@ -106,7 +106,7 @@ Using Username-Password Flow in production is not encouraged.
====
The certificate used in JWT Bearer Token Flow can be a self-signed
certificate. The KeyStore holding the certificate and the private key
-must contain only single certificate-private key entry.
+must contain only a single certificate-private key entry.
====
== General Usage
@@ -143,7 +143,7 @@ via inbound message headers, header names that start with `Sforce` or
response headers that start with `Sforce` will be present in the outbound
message headers.
-For example to fetch API limits you can specify:
+For example, to fetch API limits, you can specify:
[source,java]
----
@@ -209,8 +209,8 @@ The following operations are supported:
* <<upsertSObject,upsertSObject>> - Inserts or updates an SObject using an External Id.
* <<deleteSObjectWithId,deleteSObjectWithId>> - Deletes an SObject using an External Id.
* <<query,query>> - Runs a Salesforce SOQL query.
-* <<queryMore,queryMore>> - Retrieves more results (in case of large number of
-results) using result link returned from the 'query' API.
+* <<queryMore,queryMore>> - Retrieves more results (in case of a large number of
+results) using the result link returned from the 'query' API.
* <<queryAll,queryAll>> - Runs a SOQL query. Unlike the query operation, queryAll returns records that are deleted because of a merge or delete. queryAll also returns information about archived task and event records.
* <<sosl_search,search>> - Runs a Salesforce SOSL query.
* <<apexCall,apexCall>> - Executes a user defined APEX REST API call.
@@ -425,7 +425,7 @@ Retrieves the specified blob field from an individual record.
| Parameter | Type | Description | Default | Required
| `sObjectBlobFieldName` | `String` | SOSL query | |x
-| `sObjectName` | `String` | Name of SObject, e.g. Account | | Required if SObject not supplied in body
+| `sObjectName` | `String` | Name of SObject, e.g., Account | | Required if SObject not supplied in body
| `sObjectId` | `String` | Id of SObject | | Required if SObject not supplied in body
| Body | `AbstractSObjectBase` | SObject to determine type and Id from. If not supplied, `sObjectId`
and `sObjectName` parameters will be used. | | Required if `sObjectId`
@@ -639,7 +639,7 @@ The important thing to remember is the priority of the values specified in these
. value in message header takes precedence before template value
. value in template is set if no other value in header or body was given
-For example to send one record for approval using values in headers use:
+For example, to send one record for approval using values in headers use:
Given a route:
@@ -709,11 +709,11 @@ Composite API supports only JSON payloads.
====
As with the batch API, the results can vary from API to API so the body of each `SObjectCompositeResult` instance is given as a
`java.lang.Object`. In most cases the result will be a `java.util.Map` with string keys and values or other
-`java.util.Map` as value. Requests are made in JSON format hold some type information (i.e. it is known what values are
+`java.util.Map` as value. Requests are made in JSON format hold some type information (i.e., it is known what values are
strings and what values are numbers).
====
-Lets look at an example:
+Let's look at an example:
[source,java]
----
@@ -803,11 +803,11 @@ the identifier values (`Id` property) or their corresponding
Note that for some records operation can succeed and for some it can fail -- so you need to manually check for errors.
-Easiest way to use this functionality is to use the DTOs generated by the `camel-salesforce-maven-plugin`, but you
-also have the option of customizing the references that identify the each object in the tree, for instance primary keys
+The easiest way to use this functionality is to use the DTOs generated by the `camel-salesforce-maven-plugin`, but you
+also have the option of customizing the references that identify each object in the tree, for instance primary keys
from your database.
-Lets look at an example:
+Let's look at an example:
[source,java]
----
@@ -858,10 +858,10 @@ list of responses with the order preserved, so that the n-th requests response i
[NOTE]
====
The results can vary from API to API so the result of each sub-request (`SObjectBatchResult.result`) is given as a `java.lang.Object`. In most cases
-the result will be a `java.util.Map` with string keys and values or other `java.util.Map` as value. Requests are made in JSON format and hold some type information (i.e. it is known what values are strings and what values are numbers).
+the result will be a `java.util.Map` with string keys and values or other `java.util.Map` as value. Requests are made in JSON format and hold some type information (i.e., it is known what values are strings and what values are numbers).
====
-Lets look at an example:
+Let's look at an example:
[source,java]
----
@@ -918,7 +918,7 @@ Retrieve one or more records of the same object type.
| sObjectIds | List of String or comma-separated string | A list of one or more IDs of the objects to return. All IDs must belong to the same object type. | | x
| sObjectFields | List of String or comma-separated string | A list of fields to include in the response. The field names you specify must be valid, and you must have read-level permissions to each field. | | x
| sObjectName | String | Type of SObject, e.g. `Account` | | x
-| sObjectClass | String | Fully-qualified class name of DTO class to use for deserializing the response. | | Required if `sObjectName` parameter does not resolve to a class that exists in the package specified by the `package` option.
+| sObjectClass | String | Fully qualified class name of DTO class to use for deserializing the response. | | Required if `sObjectName` parameter does not resolve to a class that exists in the package specified by the `package` option.
|===
*Output*
@@ -1617,7 +1617,7 @@ Gets results for a Result Id
| `batchId` | `String` | Id of Batch | | Required if body not supplied
| `resultId` | `String` | Id of Result | | If not passed in body
| Body | `BatchInfo` or `String` | `JobInfo` instance from which `jobId` and `batchId` will be used.
-Otherwise can be a `String` containing the `resultId` | | `BatchInfo` Required if `jobId` and `BatchId` not supplied
+Otherwise, can be a `String` containing the `resultId` | | `BatchInfo` Required if `jobId` and `BatchId` not supplied
|===
*Output*
@@ -1683,7 +1683,7 @@ to Avro based on the Schema associated with the topic you're publishing to. The
field names must match event field names exactly, including case.
* `byte[]`. Camel will not perform any serialization. Value must be the Avro-encoded event payload.
* `com.salesforce.eventbus.protobuf.ProducerEvent`. Providing a `ProducerEvent` allows full control,
-e.g. setting the `id` property, which can be tied back to the `PublishResult.CorrelationKey`.
+e.g., setting the `id` property, which can be tied back to the `PublishResult.CorrelationKey`.
*Output*
@@ -1805,7 +1805,7 @@ Type: `PlatformEvent` or `org.cometd.bayeux.Message`
==== Change Data Capture Events
-Change Data Capture (CDC) allows you to receive near-real-time changes of Salesforce records, and synchronize corresponding records in an external data store. Change Data Capture publishes change events, which represent changes to Salesforce records. Changes include creation of a new record, updates to an existing record, deletion of a record, and undeletion of a record.
+Change Data Capture (CDC) allows you to receive near-real-time changes of Salesforce records, and synchronize corresponding records in an external data store. Change Data Capture publishes change events, which represent changes to Salesforce records. Changes include the creation of a new record, updates to an existing record, deletion of a record, and undeletion of a record.
The URI format to consume CDC events is as follows:
(camel) 02/11: CAMEL-20410: documentation fixes for camel-rest-openapi
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 b5fed2e667491f34ecbd91eeb85d183aea0257bc
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Wed Feb 21 16:43:02 2024 +0100
CAMEL-20410: documentation fixes for camel-rest-openapi
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
- Converted to use tabs
---
.../src/main/docs/rest-openapi-component.adoc | 28 ++++++++++++----------
1 file changed, 15 insertions(+), 13 deletions(-)
diff --git a/components/camel-rest-openapi/src/main/docs/rest-openapi-component.adoc b/components/camel-rest-openapi/src/main/docs/rest-openapi-component.adoc
index 3279b49bb05..8bb91aa9547 100644
--- a/components/camel-rest-openapi/src/main/docs/rest-openapi-component.adoc
+++ b/components/camel-rest-openapi/src/main/docs/rest-openapi-component.adoc
@@ -15,10 +15,10 @@
*{component-header}*
-The REST OpenApi* configures rest producers from
+The REST OpenApi configures rest producers from
https://www.openapis.org/[OpenApi] (Open API) specification document and
delegates to a component implementing the _RestProducerFactory_
-interface. Currently known working components are:
+interface. Currently, known working components are:
* xref:http-component.adoc[http]
* xref:netty-http-component.adoc[netty-http]
@@ -57,16 +57,18 @@ load the resource, which means that you can use CLASSPATH resources
(`bean:nameOfBean.methodName`) to get the specification resource,
failing that OpenApi's own resource loading support.
-This component does not act as a HTTP client, it delegates that to
-another component mentioned above. The lookup mechanism searches for a
-single component that implements the _RestProducerFactory_ interface and
-uses that. If the CLASSPATH contains more than one, then the property
+This component does not act as an HTTP client.
+It delegates that to another component mentioned above.
+The lookup mechanism searches for a single component that
+implements the _RestProducerFactory_ interface and
+uses that.
+If the CLASSPATH contains more than one, then the property
`componentName` should be set to indicate which component to delegate
to.
-Most of the configuration is taken from the OpenApi specification but
+Most of the configuration is taken from the OpenApi specification, but
the option exists to override those by specifying them on the component
-or on the endpoint. Typically you would just need to override the
+or on the endpoint. Typically, you would need to override the
`host` or `basePath` if those differ from the specification.
[NOTE]
@@ -89,7 +91,7 @@ the _RestProducerFactory_ interface for this to work.
This component's endpoint URI is lenient which means that in addition
to message headers you can specify REST operation's parameters as
endpoint parameters, these will be constant for all subsequent
-invocations so it makes sense to use this feature only for parameters
+invocations, so it makes sense to use this feature only for parameters
that are indeed constant for all invocations -- for example API version
in path such as `/api/\{version}/users/\{id}`.
@@ -112,7 +114,7 @@ include::partial$component-endpoint-options.adoc[]
Checkout the `rest-openapi-simple` example project in
the https://github.com/apache/camel-spring-boot-examples repository.
-For example if you wanted to use the
+For example, if you wanted to use the
https://petstore3.swagger.io/api/v3/[_PetStore_] provided REST API simply
reference the specification URI and desired operation id from the
OpenApi specification or download the specification and store it as
@@ -155,7 +157,7 @@ Support in Camel for Spring Boot will auto create the
`HttpComponent` Spring bean, and you can configure it using
`application.properties` (or `application.yml`) using prefix
`camel.component.http.`. We are defining the `petstore`
-component here in order to have a named component in the Camel context
+component here to have a named component in the Camel context
that we can use to interact with the PetStore REST API, if this is the
only `rest-openapi` component used we might configure it in the same
manner (using `application.properties`).
@@ -203,11 +205,11 @@ The value is taken from the `Content-Type` Camel message exchange header.
|Validates whether the resolved request path is valid for the API operation.
|validation.request.parameter.header.missing
-|Validates whether a HTTP header required by the API operation is present. The header is
+|Validates whether an HTTP header required by the API operation is present. The header is
expected to be present among the Camel message exchange headers.
|validation.request.parameter.query.missing
-|Validates whether a HTTP query parameter required by the API operation is present. The query parameter is
+|Validates whether an HTTP query parameter required by the API operation is present. The query parameter is
expected to be present among the Camel message exchange headers.
|===
(camel) 03/11: CAMEL-20410: documentation fixes for camel-robotframework
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 e4adfbb18d3fb7e65c5d1f7d4d9fe794e367fb54
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Wed Feb 21 16:46:01 2024 +0100
CAMEL-20410: documentation fixes for camel-robotframework
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
- Converted to use tabs
---
.../src/main/docs/robotframework-component.adoc | 11 ++++++-----
1 file changed, 6 insertions(+), 5 deletions(-)
diff --git a/components/camel-robotframework/src/main/docs/robotframework-component.adoc b/components/camel-robotframework/src/main/docs/robotframework-component.adoc
index 8ffa91731de..508aa039da8 100644
--- a/components/camel-robotframework/src/main/docs/robotframework-component.adoc
+++ b/components/camel-robotframework/src/main/docs/robotframework-component.adoc
@@ -16,13 +16,14 @@
The *robotframework:* component allows for processing camel exchanges
in acceptance test suites which are already implemented with its own DSL.
-The depending keyword libraries that can be used inside test suites
+The depending keyword libraries that can be used inside test suites
implemented in Robot DSL, could have been implemented either via
Java or Pyhton.
This component will let you execute business logic of acceptance test cases
in Robot language on which you can pass parameters to feed data via power
-of Camel Routes, however there is no reverse binding of parameters back where
+of Camel Routes.
+However, there is no reverse binding of parameters back where
you can pass values back into Camel exchange. Therefore, for that reason,
it actually acts like a template language passing camel exchanges by binding
data into the test cases implemented.
@@ -74,7 +75,7 @@ from("direct:setVariableCamelBody")
----
To use a robot test case to execute and collect the results
-and pass them to generate custom report if such need happens
+and pass them to generate a custom report if such need happens
It's possible to specify what template the component
should use dynamically via a header, so for example:
@@ -88,8 +89,8 @@ from("direct:in")
Robotframework component helps you pass values into robot test cases
with the similar approach how you would be able to pass values using
-Camel Simple Language. Components supports passing values in three
-different ways. Exchange body, headers and properties.
+Camel Simple Language. Components support passing values in three
+different ways. Exchange body, headers, and properties.
[source,java]
----
(camel) 11/11: CAMEL-20410: documentation fixes for camel-servlet
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 740cb59daae8d1b535c9ba5e27b97b97f0dd6a38
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Wed Feb 21 17:07:54 2024 +0100
CAMEL-20410: documentation fixes for camel-servlet
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
- Converted to use tabs
---
.../src/main/docs/servlet-component.adoc | 28 +++++++++++-----------
1 file changed, 14 insertions(+), 14 deletions(-)
diff --git a/components/camel-servlet/src/main/docs/servlet-component.adoc b/components/camel-servlet/src/main/docs/servlet-component.adoc
index e4437e55711..7bf03d341b4 100644
--- a/components/camel-servlet/src/main/docs/servlet-component.adoc
+++ b/components/camel-servlet/src/main/docs/servlet-component.adoc
@@ -14,9 +14,9 @@
*{component-header}*
-The Servlet component provides HTTP based
+The Servlet component provides HTTP-based
endpoints for consuming HTTP requests that arrive at
-a HTTP endpoint that is bound to a published Servlet.
+an HTTP endpoint that is bound to a published Servlet.
Maven users will need to add the following dependency to their `pom.xml`
for this component:
@@ -36,11 +36,11 @@ for this component:
====
*Stream*
-Servlet is stream based, which means the input it receives is submitted
+Servlet is stream-based, which means the input it receives is submitted
to Camel as a stream. That means you will only be able to read the
content of the stream *once*. If you find a situation where the message
-body appears to be empty or you need to access the data multiple times
-(eg: doing multicasting, or redelivery error handling) you should use
+body appears to be empty, or you need to access the data multiple times
+(eg: doing multicasting, or redelivery error handling), you should use
Stream caching or convert the message body to
a `String` which is safe to be read multiple times.
====
@@ -75,7 +75,7 @@ component.
Camel will also populate *all* `request.parameter` and
`request.headers`. For example, if a client request has the URL,
http://myserver/myserver?orderid=123, the exchange will contain a
-header named `orderid` with the value 123.
+header named `orderid` with the value `123`.
== Usage
@@ -87,7 +87,7 @@ xref:http-component.adoc[HTTP Component].
== Putting Camel JARs in the app server boot classpath
If you put the Camel JARs such as `camel-core`, `camel-servlet`, etc. in
-the boot classpath of your application server (eg usually in its lib
+the boot classpath of your application server (e.g., usually in its lib
directory), then mind that the servlet mapping list is now shared
between multiple deployed Camel application in the app server.
@@ -95,7 +95,7 @@ Mind that putting Camel JARs in the boot classpath of the application
server is generally not best practice!
So in those situations you *must* define a custom and unique servlet
-name in each of your Camel application, eg in the `web.xml` define:
+name in each of your Camel applications, e.g., in the `web.xml` define:
[source,xml]
---------------------------------------------------------------------------------------------
@@ -121,7 +121,7 @@ And in your Camel endpoints then include the servlet name as well
</route>
---------------------------------------------------
-Camel detects this duplicate and fail to
+Camel detects this duplicate and fails to
start the application. You can control to ignore this duplicate by
setting the servlet init-parameter ignoreDuplicateServletName to true as
follows:
@@ -141,14 +141,14 @@ follows:
But it is *strongly advised* to use unique `servlet-name` for each Camel
application to avoid this duplication clash, as well any unforeseen
-side-effects.
+side effects.
== Servlet >= 3.0 and AsyncContext
-To enable Camel to benefit from Servlet asynchronous support you must:
+To enable Camel to benefit from Servlet asynchronous support, you must:
. Enable `async` boolean init parameter by setting it to `true`
-. Without more configuration it will reuse servlet thread pool to handle the processing but you can set `executorRef` to an executor service reference to let another pool handle the processing of the exchange.
+. Without more configuration it will reuse servlet thread pool to handle the processing, but you can set `executorRef` to an executor service reference to let another pool handle the processing of the exchange.
It will use camel context registry by default and potentially fallback on an executor policy or default executor service if no bean matches this name.
Note that to force camel to get back pre-3.7.0 behavior which was to wait in another container background thread, you can set `forceAwait` boolean init parameter to `true`.
@@ -176,7 +176,7 @@ Sample async configuration:
== Sample
Use xref:servlet-component.adoc[Servlet] in Spring web applications for simplicity's sake.
-In this sample, we define a route that exposes a HTTP service at
+In this sample, we define a route that exposes an HTTP service at
http://localhost:8080/camel/services/hello.
First, you need to publish the
@@ -240,7 +240,7 @@ address: `("http://localhost:8080/camel/services") + RELATIVE_PATH("/hello")`
=== Sample when using Spring
-When using the Servlet component in a Camel/Spring application it's
+When using the Servlet component in a Camel/Spring application, it's
often required to load the Spring ApplicationContext _after_ the Servlet
component has started. This can be accomplished by using Spring's
`ContextLoaderServlet` instead of `ContextLoaderListener`. In that case
(camel) 01/11: CAMEL-20410: documentation fixes for camel-rest
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 4ec58e98f858bdb78dc94d3ffcf9f781bd74bb73
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Wed Feb 21 16:40:39 2024 +0100
CAMEL-20410: documentation fixes for camel-rest
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
- Converted to use tabs
---
.../camel-rest/src/main/docs/rest-component.adoc | 42 +++++++++++-----------
1 file changed, 21 insertions(+), 21 deletions(-)
diff --git a/components/camel-rest/src/main/docs/rest-component.adoc b/components/camel-rest/src/main/docs/rest-component.adoc
index 8abbc7aef45..1f532936151 100644
--- a/components/camel-rest/src/main/docs/rest-component.adoc
+++ b/components/camel-rest/src/main/docs/rest-component.adoc
@@ -15,11 +15,10 @@
*{component-header}*
-The REST component allows to define REST endpoints (consumer) using the
-Rest DSL and plugin to other Camel components as the
-REST transport.
+The REST component allows defining REST endpoints (consumer) using the
+Rest DSL and plugin to other Camel components as the REST transport.
-The rest component can also be used as a client (producer) to call REST services.
+The REST component can also be used as a client (producer) to call REST services.
== URI format
@@ -43,9 +42,9 @@ include::partial$component-endpoint-options.adoc[]
include::partial$component-endpoint-headers.adoc[]
// component headers: END
-== Supported rest components
+== Supported REST components
-The following components support rest consumer (Rest DSL):
+The following components support the REST consumer (Rest DSL):
* camel-netty-http
* camel-jetty
@@ -53,7 +52,7 @@ The following components support rest consumer (Rest DSL):
* camel-undertow
* camel-platform-http
-The following components support rest producer:
+The following components support the REST producer:
* camel-http
* camel-netty-http
@@ -67,8 +66,9 @@ define the REST context path using support for parameters.
[TIP]
====
-If no uriTemplate is configured then path option works the same way. It
-does not matter if you configure only path or if you configure both
+If no uriTemplate is configured then `path` option works the same way.
+
+It does not matter if you configure only `path` or if you configure both
options. Though configuring both a path and uriTemplate is a more common
practice with REST.
====
@@ -105,9 +105,9 @@ from("rest:get:hello:/french/{me}")
== Rest producer examples
-You can use the rest component to call REST services like any other Camel component.
+You can use the REST component to call REST services like any other Camel component.
-For example to call a REST service on using `hello/\{me}` you can do
+For example, to call a REST service on using `hello/\{me}` you can do
[source,java]
----
@@ -115,8 +115,8 @@ from("direct:start")
.to("rest:get:hello/{me}");
----
-And then the dynamic value `\{me}` is mapped to Camel message with the same name.
-So to call this REST service you can send an empty message body and a header as shown:
+And then the dynamic value `\{me}` is mapped to a Camel message with the same name.
+So to call this REST service, you can send an empty message body and a header as shown:
[source,java]
----
@@ -143,7 +143,7 @@ from("direct:start")
----
You can use the `producerComponent` to select which Camel component to use as the HTTP client, for example
-to use http you can do:
+to use http, you can do:
[source,java]
----
@@ -158,7 +158,7 @@ from("direct:start")
The REST producer supports binding using JSON or XML like the rest-dsl does.
-For example to use jetty with JSON binding mode turned on you can configure this in the rest configuration:
+For example, to use jetty with JSON binding mode turned on, you can configure this in the REST configuration:
[source,java]
----
@@ -168,7 +168,7 @@ from("direct:start")
.to("rest:post:user");
----
-Then when calling the REST service using REST producer it will automatic bind any POJOs to JSON before calling the REST service:
+Then when calling the REST service using the REST producer, it will automatically bind any POJOs to JSON before calling the REST service:
[source,java]
----
@@ -180,12 +180,12 @@ Then when calling the REST service using REST producer it will automatic bind an
----
In the example above we send a POJO instance `UserPojo` as the message body. And because we have turned on JSON binding
-in the rest configuration, then the POJO will be marshalled from POJO to JSON before calling the REST service.
+in the REST configuration, then the POJO will be marshalled from POJO to JSON before calling the REST service.
-However if you want to also perform binding for the response message (e.g. what the REST service sends back as response) you
+However, if you want to also perform binding for the response message (e.g., what the REST service sends back, as response) you
would need to configure the `outType` option to specify what is the class name of the POJO to unmarshal from JSON to POJO.
-For example if the REST service returns a JSON payload that binds to `com.foo.MyResponsePojo` you can configure this as shown:
+For example, if the REST service returns a JSON payload that binds to `com.foo.MyResponsePojo` you can configure this as shown:
[source,java]
----
@@ -200,8 +200,8 @@ IMPORTANT: You must configure `outType` option if you want POJO binding to happe
== More examples
-See Rest DSL which offers more examples and how you
-can use the Rest DSL to define those in a nicer RESTful way.
+See Rest DSL, which offers more examples and how you
+can use the Rest DSL to define those in a nicer, restful way.
There is a *camel-example-servlet-rest-tomcat* example in the Apache
Camel distribution, that demonstrates how to use the