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/17 12:08:37 UTC
(camel) branch main updated (ef11dd0a0e0 -> 94194a7b0ac)
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 ef11dd0a0e0 CAMEL-20410: documentation fixes for camel-platform-http-vertx
new 3127af83ed1 CAMEL-20410: documentation fixes for camel-bonita
new e4bdc3a1625 CAMEL-20410: documentation fixes for camel-box
new d3c868a4c93 CAMEL-20410: documentation fixes for camel-braintree
new 03fa3a84d5b CAMEL-20410: documentation fixes for camel-browse
new cd86ea613c6 CAMEL-20410: documentation fixes for camel-caffeine
new 335a1873f61 CAMEL-20410: documentation fixes for camel-cbor
new 8d756a576c0 CAMEL-20410: documentation fixes for camel-chatscript
new 139e42750b0 CAMEL-20410: documentation fixes for camel-chunk
new 6b5c630989f CAMEL-20410: documentation fixes for camel-cloudevents
new 1533a469c37 CAMEL-20410: documentation fixes for camel-cm-sms
new b515c463d7a CAMEL-20410: documentation fixes for camel-coap
new 94194a7b0ac CAMEL-20410: documentation fixes for camel-cometd
The 12 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/bonita-component.adoc | 6 +--
.../src/main/docs/box-component.adoc | 8 ++--
.../src/main/docs/braintree-component.adoc | 31 ++++++++++-----
.../src/main/docs/browse-component.adoc | 10 ++---
.../src/main/docs/caffeine-cache-component.adoc | 17 +++-----
.../main/docs/caffeine-loadcache-component.adoc | 5 +--
.../camel-cbor/src/main/docs/cbor-dataformat.adoc | 14 +++----
.../src/main/docs/chatscript-component.adoc | 11 +++---
.../camel-chunk/src/main/docs/chunk-component.adoc | 19 +++++----
.../src/main/docs/cloudevents.adoc | 2 +-
.../src/main/docs/cm-sms-component.adoc | 4 +-
.../camel-coap/src/main/docs/coap-component.adoc | 4 +-
.../src/main/docs/cometd-component.adoc | 45 +++++++++++-----------
13 files changed, 91 insertions(+), 85 deletions(-)
(camel) 11/12: CAMEL-20410: documentation fixes for camel-coap
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 b515c463d7ad1a2b1c509917ccf217d529a4dc3a
Author: Otavio R. Piske <an...@gmail.com>
AuthorDate: Sat Feb 17 12:28:41 2024 +0100
CAMEL-20410: documentation fixes for camel-coap
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
Signed-off-by: Otavio R. Piske <an...@gmail.com>
---
components/camel-coap/src/main/docs/coap-component.adoc | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/components/camel-coap/src/main/docs/coap-component.adoc b/components/camel-coap/src/main/docs/coap-component.adoc
index e0f421aa20e..00a386750f0 100644
--- a/components/camel-coap/src/main/docs/coap-component.adoc
+++ b/components/camel-coap/src/main/docs/coap-component.adoc
@@ -17,7 +17,7 @@
Camel-CoAP is an http://camel.apache.org/[Apache Camel] component that
allows you to work with CoAP, a lightweight REST-type protocol for machine-to-machine operation.
http://coap.technology/[CoAP], Constrained Application Protocol is a specialized web transfer protocol
-for use with constrained nodes and constrained networks and it is based on RFC 7252.
+for use with constrained nodes and constrained networks, and it is based on RFC 7252.
Camel supports the DTLS, TCP and TLS protocols via the following URI schemes:
@@ -32,7 +32,7 @@ Camel supports the DTLS, TCP and TLS protocols via the following URI schemes:
There are a number of different configuration options to configure TLS. For both DTLS (the "coaps" uri scheme)
and TCP + TLS (the "coaps+tcp" uri scheme), it is possible to use a "sslContextParameters" parameter, from
-which the camel-coap component will extract the required truststore / keystores etc to set up TLS. In addition,
+which the camel-coap component will extract the required truststore / keystores etc. to set up TLS. In addition,
the DTLS protocol supports two alternative configuration mechanisms. To use a pre-shared key, configure a
pskStore, and to work with raw public keys, configure privateKey + publicKey objects.
(camel) 04/12: CAMEL-20410: documentation fixes for camel-browse
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 03fa3a84d5bd9df02a194fa1f8cd369b377eb2c9
Author: Otavio R. Piske <an...@gmail.com>
AuthorDate: Sat Feb 17 12:11:30 2024 +0100
CAMEL-20410: documentation fixes for camel-browse
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
Signed-off-by: Otavio R. Piske <an...@gmail.com>
---
components/camel-browse/src/main/docs/browse-component.adoc | 10 ++++------
1 file changed, 4 insertions(+), 6 deletions(-)
diff --git a/components/camel-browse/src/main/docs/browse-component.adoc b/components/camel-browse/src/main/docs/browse-component.adoc
index 74375a20f77..6ad6502c6ec 100644
--- a/components/camel-browse/src/main/docs/browse-component.adoc
+++ b/components/camel-browse/src/main/docs/browse-component.adoc
@@ -15,18 +15,16 @@
*{component-header}*
-The Browse component provides a simple
-BrowsableEndpoint which can be useful for
-testing, visualisation tools or debugging. The exchanges sent to the
-endpoint are all available to be browsed.
+The Browse component provides a simple BrowsableEndpoint which can be useful for testing, visualization tools or debugging.
+The exchanges sent to the endpoint are all available to be browsed.
== URI format
-------------------------
-browse:someName[?options]
+browse:someId[?options]
-------------------------
-Where *someName* can be any string to uniquely identify the endpoint.
+Where _someId_ can be any string to uniquely identify the endpoint.
// component-configure options: START
(camel) 06/12: CAMEL-20410: documentation fixes for camel-cbor
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 335a1873f616c9154f4e4cecd6b2872325869cc7
Author: Otavio R. Piske <an...@gmail.com>
AuthorDate: Sat Feb 17 12:16:11 2024 +0100
CAMEL-20410: documentation fixes for camel-cbor
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
Signed-off-by: Otavio R. Piske <an...@gmail.com>
---
components/camel-cbor/src/main/docs/cbor-dataformat.adoc | 14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)
diff --git a/components/camel-cbor/src/main/docs/cbor-dataformat.adoc b/components/camel-cbor/src/main/docs/cbor-dataformat.adoc
index ae52d9139b2..dabad671a4d 100644
--- a/components/camel-cbor/src/main/docs/cbor-dataformat.adoc
+++ b/components/camel-cbor/src/main/docs/cbor-dataformat.adoc
@@ -11,7 +11,7 @@
*Since Camel {since}*
-CBOR is a Data Format which uses the
+CBOR is a Data Format that uses the
https://github.com/FasterXML/jackson/[Jackson library] with the
https://github.com/FasterXML/jackson-dataformats-binary/tree/master/cbor[CBOR extension]
to unmarshal a CBOR payload into Java objects or to marshal Java objects
@@ -19,9 +19,9 @@ into a CBOR payload.
[source,java]
-------------------------------
-from("activemq:My.Queue").
- unmarshal().cbor().
- to("mqseries:Another.Queue");
+from("activemq:My.Queue")
+ .unmarshal().cbor()
+ .to("mqseries:Another.Queue");
-------------------------------
== CBOR Options
@@ -32,14 +32,14 @@ include::partial$dataformat-options.adoc[]
=== Using CBOR in Spring DSL
-When using Data Format in Spring DSL you need to
+When using Data Format in Spring DSL, you need to
declare the data formats first. This is done in the *DataFormats* XML
tag.
[source,xml]
-----------------------------------------------------------------------------------------------------------------------------
<dataFormats>
- <!-- here we define a CBOR data format with the id test and that it should use the TestPojo as the class type when
+ <!-- here we define a CBOR data format with the id test, and that it should use the TestPojo as the class type when
doing unmarshal. -->
<cbor id="test" unmarshalType="org.apache.camel.component.cbor.TestPojo"/>
</dataFormats>
@@ -58,7 +58,7 @@ And then you can refer to this id in the route:
== Dependencies
-[source,java]
+[source,xml]
-------------------------------------
<dependency>
<groupId>org.apache.camel</groupId>
(camel) 10/12: CAMEL-20410: documentation fixes for camel-cm-sms
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 1533a469c371218c29064864b8cb272b4e9e762c
Author: Otavio R. Piske <an...@gmail.com>
AuthorDate: Sat Feb 17 12:27:30 2024 +0100
CAMEL-20410: documentation fixes for camel-cm-sms
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
Signed-off-by: Otavio R. Piske <an...@gmail.com>
---
components/camel-cm-sms/src/main/docs/cm-sms-component.adoc | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/components/camel-cm-sms/src/main/docs/cm-sms-component.adoc b/components/camel-cm-sms/src/main/docs/cm-sms-component.adoc
index d2c37d9cd97..273cefdfec5 100644
--- a/components/camel-cm-sms/src/main/docs/cm-sms-component.adoc
+++ b/components/camel-cm-sms/src/main/docs/cm-sms-component.adoc
@@ -17,9 +17,9 @@
*Camel-Cm-Sms* is an http://camel.apache.org/[Apache Camel] component
for the https://www.cmtelecom.com[CM SMS Gateway]
-It allows to integrate https://dashboard.onlinesmsgateway.com/docs[CM SMS API] in an application as a camel component.
+It allows integrating https://dashboard.onlinesmsgateway.com/docs[CM SMS API] in an application as a camel component.
-You must have a valid account. More information is available at https://www.cmtelecom.com/support[CM Telecom].
+You must have a valid account. More information is available at https://www.cmtelecom.com/support[CM Telecom].
// component-configure options: START
(camel) 05/12: CAMEL-20410: documentation fixes for camel-caffeine
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 cd86ea613c6b3b79a067fed2ed9eae0fb4d5dbfb
Author: Otavio R. Piske <an...@gmail.com>
AuthorDate: Sat Feb 17 12:14:32 2024 +0100
CAMEL-20410: documentation fixes for camel-caffeine
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
Signed-off-by: Otavio R. Piske <an...@gmail.com>
---
.../src/main/docs/caffeine-cache-component.adoc | 17 ++++++-----------
.../src/main/docs/caffeine-loadcache-component.adoc | 5 ++---
2 files changed, 8 insertions(+), 14 deletions(-)
diff --git a/components/camel-caffeine/src/main/docs/caffeine-cache-component.adoc b/components/camel-caffeine/src/main/docs/caffeine-cache-component.adoc
index 7f5d55a7c6f..98a3476ed6c 100644
--- a/components/camel-caffeine/src/main/docs/caffeine-cache-component.adoc
+++ b/components/camel-caffeine/src/main/docs/caffeine-cache-component.adoc
@@ -34,8 +34,7 @@ their `pom.xml` for this component:
caffeine-cache://cacheName[?options]
-----------------------------
-You can append query options to the URI in the following
-format, `?option=value&option=#beanRef&...`
+You can append query options to the URI in the following format: `?option=value&option=#beanRef&...`.
// component-configure options: START
@@ -78,17 +77,13 @@ protected RouteBuilder createRouteBuilder() throws Exception {
}
------------------------------------------------------------
-In this way you'll work always on the same cache in the registry.
+In this way, you'll work always on the same cache in the registry.
-== Check operation result
+== Checking the operation result
-Each time you'll use an operation on the cache you'll have two different headers to check for status:
-
-[source,java]
-------------------------------------------------------------
-CaffeineConstants.ACTION_HAS_RESULT
-CaffeineConstants.ACTION_SUCCEEDED
-------------------------------------------------------------
+Each time you'll use an operation on the cache, you'll have two different headers to check for status:
+* `CaffeineConstants.ACTION_HAS_RESULT`
+* `CaffeineConstants.ACTION_SUCCEEDED`
include::spring-boot:partial$starter.adoc[]
diff --git a/components/camel-caffeine/src/main/docs/caffeine-loadcache-component.adoc b/components/camel-caffeine/src/main/docs/caffeine-loadcache-component.adoc
index 5107a083789..896b31ca7ba 100644
--- a/components/camel-caffeine/src/main/docs/caffeine-loadcache-component.adoc
+++ b/components/camel-caffeine/src/main/docs/caffeine-loadcache-component.adoc
@@ -14,7 +14,7 @@
*{component-header}*
-The Caffeine Loadcache component enables you to perform caching operations using
+The Caffeine LoadCache component enables you to perform caching operations using
the LoadingCache from Caffeine.
Maven users will need to add the following dependency to
@@ -36,8 +36,7 @@ their `pom.xml` for this component:
caffeine-loadcache://cacheName[?options]
-----------------------------
-You can append query options to the URI in the following
-format, `?option=value&option=#beanRef&...`
+You can append query options to the URI in the following format: `?option=value&option=#beanRef&...`
// component-configure options: START
(camel) 08/12: CAMEL-20410: documentation fixes for camel-chunk
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 139e42750b0cf24d4f60b8af539870a002dd19db
Author: Otavio R. Piske <an...@gmail.com>
AuthorDate: Sat Feb 17 12:23:49 2024 +0100
CAMEL-20410: documentation fixes for camel-chunk
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
Signed-off-by: Otavio R. Piske <an...@gmail.com>
---
.../camel-chunk/src/main/docs/chunk-component.adoc | 19 +++++++++----------
1 file changed, 9 insertions(+), 10 deletions(-)
diff --git a/components/camel-chunk/src/main/docs/chunk-component.adoc b/components/camel-chunk/src/main/docs/chunk-component.adoc
index 56a056fdeec..62da250d401 100644
--- a/components/camel-chunk/src/main/docs/chunk-component.adoc
+++ b/components/camel-chunk/src/main/docs/chunk-component.adoc
@@ -29,8 +29,7 @@ chunk:templateName[?options]
Where *templateName* is the classpath-local URI of the template to
invoke.
-You can append query options to the URI in the following
-format, `?option=value&option=value&...`
+You can append query options to the URI in the following format: `?option=value&option=value&...`
// component-configure options: START
@@ -47,7 +46,7 @@ include::partial$component-endpoint-options.adoc[]
// endpoint options: END
-Chunk component will look for a specific template in _themes_ folder
+Chunk component will look for a specific template in the _themes_ folder
with extensions _.chtml_ or _.cxml. _If you need to specify a different
folder or extensions, you will need to use the specific options listed
above.
@@ -83,7 +82,7 @@ a `Map`). The `Exchange` is transferred as:
Camel provides two headers by which you can define a different resource
location for a template or the template content itself. If any of these
-headers is set then Camel uses this over the endpoint configured
+headers is set, then Camel uses this over the endpoint configured
resource. This allows you to provide a dynamic template at runtime.
// component headers: START
@@ -92,7 +91,7 @@ include::partial$component-endpoint-headers.adoc[]
== Samples
-For example you could use something like:
+For example, you could use something like:
[source,java]
--------------------------
@@ -104,7 +103,7 @@ To use a Chunk template to formulate a response for a message for InOut
message exchanges (where there is a `JMSReplyTo` header).
If you want to use InOnly and consume the message and send it to another
-destination you could use:
+destination, you could use:
[source,java]
-----------------------------
@@ -131,13 +130,13 @@ from("direct:in").
to("chunk:file_example?themeFolder=template&themeSubfolder=subfolder&extension=chunk");
---------------------------------------------------------------------------------------
-In this example Chunk component will look for the file
-_file_example.chunk_ in the folder _template/subfolder._
+In this example, the Chunk component will look for the file
+`file_example.chunk` in the folder `template/subfolder`.
== The Email Sample
-In this sample we want to use Chunk templating for an order confirmation
-email. The email template is laid out in Chunk as:
+In this sample, we want to use Chunk templating for an order confirmation email.
+The email template is laid out in Chunk as:
[source,text]
----------------------------------------------
(camel) 02/12: CAMEL-20410: documentation fixes for camel-box
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 e4bdc3a1625240dccd25f3bf8ba6858cc7a5065d
Author: Otavio R. Piske <an...@gmail.com>
AuthorDate: Sat Feb 17 11:52:23 2024 +0100
CAMEL-20410: documentation fixes for camel-box
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
Signed-off-by: Otavio R. Piske <an...@gmail.com>
---
.../camel-box-component/src/main/docs/box-component.adoc | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/components/camel-box/camel-box-component/src/main/docs/box-component.adoc b/components/camel-box/camel-box-component/src/main/docs/box-component.adoc
index 33138c4aab7..a940181c2f7 100644
--- a/components/camel-box/camel-box-component/src/main/docs/box-component.adoc
+++ b/components/camel-box/camel-box-component/src/main/docs/box-component.adoc
@@ -14,14 +14,14 @@
*{component-header}*
-The Box component provides access to all of the Box.com APIs accessible
-using https://github.com/box/box-java-sdk/[https://github.com/box/box-java-sdk]. It
-allows producing messages to upload and download files, create, edit,
+The Box component provides access to all the Box.com APIs accessible
+using https://github.com/box/box-java-sdk/[Box Java SDK].
+It allows producing messages to upload and download files, create, edit,
and manage folders, etc. It also supports APIs that allow polling for
updates to user accounts and even changes to enterprise accounts, etc.
Box.com requires the use of OAuth2.0 for all client application
-authentication. In order to use camel-box with your account, you'll need
+authentications. To use camel-box with your account, you'll need
to create a new application within Box.com at
https://developer.box.com/[https://developer.box.com].
The Box application's client id and secret will allow access to Box APIs
(camel) 07/12: CAMEL-20410: documentation fixes for camel-chatscript
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 8d756a576c01de0b45603fe5d1b019fe131c77a6
Author: Otavio R. Piske <an...@gmail.com>
AuthorDate: Sat Feb 17 12:21:08 2024 +0100
CAMEL-20410: documentation fixes for camel-chatscript
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
Signed-off-by: Otavio R. Piske <an...@gmail.com>
---
.../camel-chatscript/src/main/docs/chatscript-component.adoc | 11 ++++++-----
1 file changed, 6 insertions(+), 5 deletions(-)
diff --git a/components/camel-chatscript/src/main/docs/chatscript-component.adoc b/components/camel-chatscript/src/main/docs/chatscript-component.adoc
index bdb5b946f2e..1606364050c 100644
--- a/components/camel-chatscript/src/main/docs/chatscript-component.adoc
+++ b/components/camel-chatscript/src/main/docs/chatscript-component.adoc
@@ -14,11 +14,10 @@
*{component-header}*
-The ChatScript component allows you to interact with ChatScript Server and have conversations. This component is stateless and relies on ChatScript to maintain chat history.
+The ChatScript component allows you to interact with https://github.com/ChatScript/ChatScript[ChatScript Server] and have conversations. This component is stateless and relies on ChatScript to maintain chat history.
-Original ChatScript is available here : https://github.com/bwilcox-1234/ChatScript
+This component expects a JSON with the following fields:
-This component expects a JSON having the following fields:
[source,json]
----
{
@@ -28,8 +27,10 @@ This component expects a JSON having the following fields:
}
----
-Refer `ChatScriptMessage.java` and samples
-
+[NOTE]
+====
+Refer to the file https://github.com/apache/camel/blob/main/components/camel-chatscript/src/main/java/org/apache/camel/component/chatscript/ChatScriptMessage.java[`ChatScriptMessage.java`] for details and samples.
+====
// component-configure options: START
(camel) 03/12: CAMEL-20410: documentation fixes for camel-braintree
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 d3c868a4c930e7465548284826a42c9150b7685d
Author: Otavio R. Piske <an...@gmail.com>
AuthorDate: Sat Feb 17 12:09:09 2024 +0100
CAMEL-20410: documentation fixes for camel-braintree
- Fixed samples
- Converted to use tabs
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
Signed-off-by: Otavio R. Piske <an...@gmail.com>
---
.../src/main/docs/braintree-component.adoc | 31 +++++++++++++++-------
1 file changed, 22 insertions(+), 9 deletions(-)
diff --git a/components/camel-braintree/src/main/docs/braintree-component.adoc b/components/camel-braintree/src/main/docs/braintree-component.adoc
index c0f0329a022..aa92e45fbd0 100644
--- a/components/camel-braintree/src/main/docs/braintree-component.adoc
+++ b/components/camel-braintree/src/main/docs/braintree-component.adoc
@@ -15,14 +15,10 @@
*{component-header}*
The Braintree component provides access to
-https://www.braintreepayments.com/[Braintree Payments] trough through
-theirs https://developers.braintreepayments.com/start/hello-server/java[Java
-SDK].
-
-All client applications need API credential in order to process
-payments. In order to use camel-braintree with your account, you'll need
-to create a new
-https://www.braintreepayments.com/get-started[Sandbox] or https://www.braintreepayments.com/signup[Production]
+https://www.braintreepayments.com/[Braintree Payments] through their https://developers.braintreepayments.com/start/hello-server/java[Java SDK].
+
+All client applications need API credential to process payments.
+To use camel-braintree with your account, you'll need to create a new https://www.braintreepayments.com/get-started[Sandbox] or https://www.braintreepayments.com/signup[Production]
account.
@@ -54,8 +50,18 @@ include::partial$component-endpoint-options.adoc[]
== Examples
-*OSGi Blueprint*
+[tabs]
+====
+Java::
++
+[source,java]
+----
+from("direct://GENERATE")
+ .to("braintree://sclientToken/generate");
+----
+OSGi Blueprint::
++
[source,xml]
----
<?xml version="1.0"?>
@@ -91,6 +97,13 @@ include::partial$component-endpoint-options.adoc[]
</blueprint>
----
++
+[NOTE]
+=====
+Starting from Camel 4, OSGI Blueprint is considered a *legacy* DSL. Users are strongly advised to migrate to the modern XML IO DSL.
+=====
+
+====
== More Information
(camel) 01/12: CAMEL-20410: documentation fixes for camel-bonita
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 3127af83ed163f621a0908ff6f7363a0fbd3a1cc
Author: Otavio R. Piske <an...@gmail.com>
AuthorDate: Sat Feb 17 11:48:11 2024 +0100
CAMEL-20410: documentation fixes for camel-bonita
- Fixed samples
- Converted to use tabs
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
Signed-off-by: Otavio R. Piske <an...@gmail.com>
---
components/camel-bonita/src/main/docs/bonita-component.adoc | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/components/camel-bonita/src/main/docs/bonita-component.adoc b/components/camel-bonita/src/main/docs/bonita-component.adoc
index b79c71618f1..1d79e45b222 100644
--- a/components/camel-bonita/src/main/docs/bonita-component.adoc
+++ b/components/camel-bonita/src/main/docs/bonita-component.adoc
@@ -50,7 +50,7 @@ The following example starts a new case in Bonita:
[source,java]
----------------------------------------------------------------------
-from("direct:start").to("bonita:startCase?hostname=localhost&port=8080&processName=TestProcess&username=install&password=install")
+from("direct:start").to("bonita:startCase?hostname=localhost&port=8080&processName=TestProcess&username=install&password=install");
----------------------------------------------------------------------
== Dependencies
@@ -58,11 +58,11 @@ from("direct:start").to("bonita:startCase?hostname=localhost&port=8080&p
To use Bonita in your Camel routes, you need to add a dependency on
*camel-bonita*, which implements the component.
-If you use Maven, you can just add the following to your pom.xml,
+If you use Maven, you can add the following to your pom.xml,
substituting the version number for the latest and greatest release (see
the download page for the latest versions).
-[source,java]
+[source,xml]
-------------------------------------
<dependency>
<groupId>org.apache.camel</groupId>
(camel) 09/12: CAMEL-20410: documentation fixes for camel-cloudevents
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 6b5c630989f82c211491269b5097c9f5386f3c88
Author: Otavio R. Piske <an...@gmail.com>
AuthorDate: Sat Feb 17 12:26:01 2024 +0100
CAMEL-20410: documentation fixes for camel-cloudevents
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
Signed-off-by: Otavio R. Piske <an...@gmail.com>
---
components/camel-cloudevents/src/main/docs/cloudevents.adoc | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/components/camel-cloudevents/src/main/docs/cloudevents.adoc b/components/camel-cloudevents/src/main/docs/cloudevents.adoc
index 296fb93bac3..b6f58ac547f 100644
--- a/components/camel-cloudevents/src/main/docs/cloudevents.adoc
+++ b/components/camel-cloudevents/src/main/docs/cloudevents.adoc
@@ -13,5 +13,5 @@
Camel support for the CloudEvents specification.
-At the moment the camel-cloudevents component is very limited in functionality
+At the moment, the CloudEvents component is very limited in functionality
with mapping between Camel Message headers and the specification.
(camel) 12/12: CAMEL-20410: documentation fixes for camel-cometd
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 94194a7b0ac24a2a7ec0cd1c0c6093c4c340502f
Author: Otavio R. Piske <an...@gmail.com>
AuthorDate: Sat Feb 17 12:36:04 2024 +0100
CAMEL-20410: documentation fixes for camel-cometd
- Fixed samples
- Converted to use tabs
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
Signed-off-by: Otavio R. Piske <an...@gmail.com>
---
.../src/main/docs/cometd-component.adoc | 45 +++++++++++-----------
1 file changed, 23 insertions(+), 22 deletions(-)
diff --git a/components/camel-cometd/src/main/docs/cometd-component.adoc b/components/camel-cometd/src/main/docs/cometd-component.adoc
index 5d30bda0066..88e3167234f 100644
--- a/components/camel-cometd/src/main/docs/cometd-component.adoc
+++ b/components/camel-cometd/src/main/docs/cometd-component.adoc
@@ -14,13 +14,12 @@
*{component-header}*
-The Cometd component is a transport for working with the
+The Cometd component is a transport mechanism for working with the
http://www.mortbay.org/jetty[jetty] implementation of the
http://docs.codehaus.org/display/JETTY/Cometd+%28aka+Bayeux%29[cometd/bayeux
protocol]. +
- Using this component in combination with the dojo toolkit library it's
-possible to push Camel messages directly into the browser using an AJAX
-based mechanism.
+ Using this component in combination with the dojo toolkit library, it's
+possible to push Camel messages directly into the browser using an AJAX-based mechanism.
Maven users will need to add the following dependency to their `pom.xml`
for this component:
@@ -70,15 +69,13 @@ include::partial$component-endpoint-options.adoc[]
include::partial$component-endpoint-headers.adoc[]
// component headers: END
-== Sample
+== Samples
-Here is some examples on How to pass the parameters
+Below, you can find some examples of how to pass the parameters.
-For file (for webapp resources located in the Web Application directory
---> cometd://localhost:8080?resourceBase=file./webapp +
- For classpath (when by example the web resources are packaged inside
-the webapp folder -->
-cometd://localhost:8080?resourceBase=classpath:webapp
+For file, for webapp resources located in the Web Application directory --> `cometd://localhost:8080?resourceBase=file./webapp`.
+
+For classpath, when, for example, the web resources are packaged inside the webapp folder --> `cometd://localhost:8080?resourceBase=classpath:webapp`
== Authentication
@@ -93,16 +90,20 @@ http://cometd.org/documentation/howtos/authentication[documented here]
The Cometd component supports SSL/TLS configuration
through the xref:manual::camel-configuration-utilities.adoc[Camel JSSE
Configuration Utility]. This utility greatly decreases the amount of
-component specific code you need to write and is configurable at the
+component-specific code you need to write and is configurable at the
endpoint and component levels. The following examples demonstrate how
to use the utility with the Cometd component. You need to configure SSL
-on the CometdComponent.
+on the CometdComponent.x
-[[Cometd-Programmaticconfigurationofthecomponent]]
-Programmatic configuration of the component
+[tabs]
+====
+Java::
++
+Programmatic configuration of the component:
++
[source,java]
------------------------------------------------------------------------------------------------
+----
KeyStoreParameters ksp = new KeyStoreParameters();
ksp.setResource("/users/home/server/keystore.jks");
ksp.setPassword("keystorePassword");
@@ -120,13 +121,12 @@ scp.setTrustManagers(tmp);
CometdComponent commetdComponent = getContext().getComponent("cometds", CometdComponent.class);
commetdComponent.setSslContextParameters(scp);
------------------------------------------------------------------------------------------------
-
-[[Cometd-SpringDSLbasedconfigurationofendpoint]]
-Spring DSL based configuration of endpoint
+----
+Spring XML::
++
[source,xml]
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+----
<camel:sslContextParameters
id="sslContextParameters">
<camel:keyManagers
@@ -147,8 +147,9 @@ Spring DSL based configuration of endpoint
</bean>
<to uri="cometds://127.0.0.1:443/service/test?baseResource=file:./target/test-classes/webapp&timeout=240000&interval=0&maxInterval=30000&multiFrameInterval=1500&jsonCommented=true&logLevel=2"/>...
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+----
+====
include::spring-boot:partial$starter.adoc[]