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 18:46:22 UTC
(camel) branch main updated (c181ac80aa8 -> 6ae7671bb35)
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 c181ac80aa8 CAMEL-20410: documentation fixes for camel-spring
new ae415c9013c CAMEL-20410: documentation fixes for camel-spring-batch
new a22c1cf3c6e CAMEL-20410: documentation fixes for camel-spring-jdbc
new 65def250a80 CAMEL-20410: documentation fixes for camel-spring-ldap
new cf41ab93fc2 CAMEL-20410: documentation fixes for camel-spring-rabbitmq
new b8d6355aed9 CAMEL-20410: documentation fixes for camel-spring-rabbitmq
new 7a8fecc79c4 CAMEL-20410: documentation fixes for camel-spring-redis
new f376c82d7c5 CAMEL-20410: documentation fixes for camel-spring-security
new 5307ace0f3a CAMEL-20410: documentation fixes for camel-spring-ws
new 6c04c0d78fe CAMEL-20410: documentation fixes for camel-ssh
new 563ac9dda25 CAMEL-20410: documentation fixes for camel-stax
new 6ae7671bb35 CAMEL-20410: documentation fixes for camel-stitch
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:
.../camel/catalog/components/spring-rabbitmq.json | 2 +-
.../src/main/docs/spring-batch-component.adoc | 15 ++---
.../src/main/docs/spring-jdbc-component.adoc | 2 +-
.../src/main/docs/spring-ldap-component.adoc | 16 ++---
.../component/springrabbit/spring-rabbitmq.json | 2 +-
.../src/main/docs/spring-rabbitmq-component.adoc | 52 ++++++++--------
.../springrabbit/SpringRabbitMQEndpoint.java | 2 +-
.../src/main/docs/spring-redis-component.adoc | 26 ++++----
.../src/main/docs/spring-security.adoc | 24 ++++----
.../src/main/docs/spring-ws-component.adoc | 72 +++++++++++-----------
.../camel-ssh/src/main/docs/ssh-component.adoc | 7 ++-
.../camel-stax/src/main/docs/stax-component.adoc | 16 ++---
.../src/main/docs/xtokenize-language.adoc | 2 +-
.../src/main/docs/stitch-component.adoc | 13 ++--
14 files changed, 129 insertions(+), 122 deletions(-)
(camel) 04/11: CAMEL-20410: documentation fixes for camel-spring-rabbitmq
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 cf41ab93fc2fe7ae7741bb3f173ee04f55e43151
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Wed Feb 21 18:59:59 2024 +0100
CAMEL-20410: documentation fixes for camel-spring-rabbitmq
- Fixed grammar and typos on the component description
---
.../resources/org/apache/camel/catalog/components/spring-rabbitmq.json | 2 +-
.../org/apache/camel/component/springrabbit/spring-rabbitmq.json | 2 +-
.../camel-spring-rabbitmq/src/main/docs/spring-rabbitmq-component.adoc | 2 +-
.../org/apache/camel/component/springrabbit/SpringRabbitMQEndpoint.java | 2 +-
4 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/spring-rabbitmq.json b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/spring-rabbitmq.json
index a039b772311..a7f5c0728a1 100644
--- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/spring-rabbitmq.json
+++ b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/spring-rabbitmq.json
@@ -3,7 +3,7 @@
"kind": "component",
"name": "spring-rabbitmq",
"title": "Spring RabbitMQ",
- "description": "Send and receive messages from RabbitMQ using Spring RabbitMQ client.",
+ "description": "Send and receive messages from RabbitMQ using the Spring RabbitMQ client.",
"deprecated": false,
"firstVersion": "3.8.0",
"label": "messaging",
diff --git a/components/camel-spring-rabbitmq/src/generated/resources/org/apache/camel/component/springrabbit/spring-rabbitmq.json b/components/camel-spring-rabbitmq/src/generated/resources/org/apache/camel/component/springrabbit/spring-rabbitmq.json
index a039b772311..a7f5c0728a1 100644
--- a/components/camel-spring-rabbitmq/src/generated/resources/org/apache/camel/component/springrabbit/spring-rabbitmq.json
+++ b/components/camel-spring-rabbitmq/src/generated/resources/org/apache/camel/component/springrabbit/spring-rabbitmq.json
@@ -3,7 +3,7 @@
"kind": "component",
"name": "spring-rabbitmq",
"title": "Spring RabbitMQ",
- "description": "Send and receive messages from RabbitMQ using Spring RabbitMQ client.",
+ "description": "Send and receive messages from RabbitMQ using the Spring RabbitMQ client.",
"deprecated": false,
"firstVersion": "3.8.0",
"label": "messaging",
diff --git a/components/camel-spring-rabbitmq/src/main/docs/spring-rabbitmq-component.adoc b/components/camel-spring-rabbitmq/src/main/docs/spring-rabbitmq-component.adoc
index 0918245454b..467c18b97f5 100644
--- a/components/camel-spring-rabbitmq/src/main/docs/spring-rabbitmq-component.adoc
+++ b/components/camel-spring-rabbitmq/src/main/docs/spring-rabbitmq-component.adoc
@@ -2,7 +2,7 @@
:doctitle: Spring RabbitMQ
:shortname: spring-rabbitmq
:artifactid: camel-spring-rabbitmq
-:description: Send and receive messages from RabbitMQ using Spring RabbitMQ client.
+:description: Send and receive messages from RabbitMQ using the Spring RabbitMQ client.
:since: 3.8
:supportlevel: Stable
:tabs-sync-option:
diff --git a/components/camel-spring-rabbitmq/src/main/java/org/apache/camel/component/springrabbit/SpringRabbitMQEndpoint.java b/components/camel-spring-rabbitmq/src/main/java/org/apache/camel/component/springrabbit/SpringRabbitMQEndpoint.java
index 3c4e91128cf..dc1e5e5f603 100644
--- a/components/camel-spring-rabbitmq/src/main/java/org/apache/camel/component/springrabbit/SpringRabbitMQEndpoint.java
+++ b/components/camel-spring-rabbitmq/src/main/java/org/apache/camel/component/springrabbit/SpringRabbitMQEndpoint.java
@@ -51,7 +51,7 @@ import org.springframework.retry.interceptor.RetryOperationsInterceptor;
import static org.apache.camel.component.springrabbit.SpringRabbitMQConstants.DIRECT_MESSAGE_LISTENER_CONTAINER;
/**
- * Send and receive messages from RabbitMQ using Spring RabbitMQ client.
+ * Send and receive messages from RabbitMQ using the Spring RabbitMQ client.
*/
@UriEndpoint(firstVersion = "3.8.0", scheme = "spring-rabbitmq", title = "Spring RabbitMQ",
syntax = "spring-rabbitmq:exchangeName",
(camel) 09/11: CAMEL-20410: documentation fixes for camel-ssh
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 6c04c0d78feb02eaa527586fbebd79a4cc7b075d
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Wed Feb 21 19:14:24 2024 +0100
CAMEL-20410: documentation fixes for camel-ssh
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
- Converted to use tabs
---
components/camel-ssh/src/main/docs/ssh-component.adoc | 7 ++++---
1 file changed, 4 insertions(+), 3 deletions(-)
diff --git a/components/camel-ssh/src/main/docs/ssh-component.adoc b/components/camel-ssh/src/main/docs/ssh-component.adoc
index 7edd39c3aea..113bd974c8a 100644
--- a/components/camel-ssh/src/main/docs/ssh-component.adoc
+++ b/components/camel-ssh/src/main/docs/ssh-component.adoc
@@ -15,7 +15,7 @@
*{component-header}*
The SSH component enables access to SSH servers such that you can send
-an SSH command, and process the response.
+an SSH command and process the response.
Maven users will need to add the following dependency to their `pom.xml`
for this component:
@@ -87,7 +87,7 @@ set, and if so, use it to locate the referenced Public Key certificate
and use that for authentication.
2. If `certResource` is not set, it will look to see if a
`keyPairProvider` has been set, and if so, it will use that for
-certificate based authentication.
+certificate-based authentication.
3. If neither `certResource` nor `keyPairProvider` are set, it will use
the `username` and `password` options for authentication. Even though the `username`
and `password` are provided in the endpoint configuration and headers set with
@@ -123,7 +123,8 @@ An example of using Public Key authentication is provided in
== Certificate Dependencies
You will need to add some additional runtime dependencies if you use
-certificate based authentication. You may need to use later versions depending what version
+certificate-based authentication.
+You may need to use later versions depending on what version
of Camel you are using.
The component uses `sshd-core` library which is based on either `bouncycastle` or `eddsa` security providers. `camel-ssh` is picking explicitly `bouncycastle` as security provider.
(camel) 08/11: CAMEL-20410: documentation fixes for camel-spring-ws
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 5307ace0f3ab7b65f91d4c75979e42df94f4bdf6
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Wed Feb 21 19:13:11 2024 +0100
CAMEL-20410: documentation fixes for camel-spring-ws
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
- Converted to use tabs
---
.../src/main/docs/spring-ws-component.adoc | 72 +++++++++++-----------
1 file changed, 36 insertions(+), 36 deletions(-)
diff --git a/components/camel-spring-ws/src/main/docs/spring-ws-component.adoc b/components/camel-spring-ws/src/main/docs/spring-ws-component.adoc
index 2e7465c4b12..7e41eba1200 100644
--- a/components/camel-spring-ws/src/main/docs/spring-ws-component.adoc
+++ b/components/camel-spring-ws/src/main/docs/spring-ws-component.adoc
@@ -34,7 +34,7 @@ for this component:
</dependency>
------------------------------------------------------------
-*Be aware* Spring WS version 4.x does not support Axiom anymore (because Axiom does not support Jakarte JEE 9)
+*Be aware* Spring WS version 4.x does not support Axiom anymore (because Axiom does not support Jakarta JEE 9)
== URI format
@@ -57,7 +57,7 @@ name of the root element contained in the message.
|`soapaction` |Used to map web service requests based on the SOAP action specified in
the header of the message.
-|`uri` |In order to map web service requests that target a specific URI.
+|`uri` |To map web service requests that target a specific URI.
|`xpathresult` |Used to map web service requests based on the evaluation of an XPath
`expression` against the incoming message. The result of the evaluation
@@ -65,15 +65,15 @@ should match the XPath result specified in the endpoint URI.
|`beanname` |Allows you to reference an
`org.apache.camel.component.spring.ws.bean.CamelEndpointDispatcher`
-object in order to integrate with existing (legacy)
+object to integrate with existing (legacy)
http://static.springsource.org/spring-ws/sites/1.5/reference/html/server.html#server-endpoint-mapping[endpoint
mappings] like `PayloadRootQNameEndpointMapping`,
-`SoapActionEndpointMapping`, etc
+`SoapActionEndpointMapping`, etc.
|=======================================================================
-As a consumer the *address* should contain a value relevant to the
+As a consumer, the *address* should contain a value relevant to the
specified mapping-type (e.g. a SOAP action, XPath expression). As a
-producer the address should be set to the URI of the web service your
+ producer, the address should be set to the URI of the web service your
calling upon.
@@ -109,13 +109,13 @@ And sent a message:
template.requestBody("direct:example", "<foobar xmlns=\"http://foo.com\"><msg>test message</msg></foobar>");
------------------------------------------------------------------------------------------------------------
-Remember if it's a SOAP service you're calling you don't have to include
+Remember if it's a SOAP service you're calling, you don't have to include
SOAP tags. Spring-WS will perform the XML-to-SOAP marshaling.
== Sending SOAP and WS-Addressing action headers
When a remote web service requires a SOAP action or use of the
-WS-Addressing standard you define your route as:
+WS-Addressing standard, you define your route as:
[source,java]
-----------------------------------------------------------------------------------------------
@@ -123,7 +123,7 @@ from("direct:example")
.to("spring-ws:http://foo.com/bar?soapAction=http://foo.com&wsAddressingAction=http://bar.com")
-----------------------------------------------------------------------------------------------
-Optionally you can override the endpoint options with header values:
+Optionally, you can override the endpoint options with header values:
[source,java]
--------------------------------------------------------------------
@@ -135,7 +135,7 @@ SpringWebserviceConstants.SPRING_WS_SOAP_ACTION, "http://baz.com");
== Using SOAP headers
You can provide the SOAP header(s) as a Camel Message header when
-sending a message to a spring-ws endpoint, for example given the
+sending a message to a spring-ws endpoint, for example, given the
following SOAP header in a String
[source,java]
@@ -158,7 +158,7 @@ Service.
Likewise, the spring-ws consumer will also enrich the Camel Message with
the SOAP header.
-For an example see this
+For example, see this
https://svn.apache.org/repos/asf/camel/trunk/components/camel-spring-ws/src/test/java/org/apache/camel/component/spring/ws/SoapHeaderTest.java[unit
test].
@@ -166,7 +166,7 @@ test].
Spring WS Camel supports propagation of the headers and attachments into
Spring-WS WebServiceMessage response. The
-endpoint will use so called "hook" the MessageFilter (default
+endpoint will use so-called "hook" the MessageFilter (default
implementation is provided by BasicMessageFilter) to propagate the
exchange headers and attachments into WebServiceMessage response. Now
you can use
@@ -181,7 +181,7 @@ exchange.getIn().addAttachment("myAttachment", new DataHandler(...))
====
If the exchange header in the pipeline contains text, it generates
Qname(key)=value attribute in the soap header. Recommended is to create
-a QName class directly and put into any key into header.
+a QName class directly and put any key into header.
====
== How to transform the soap header using a stylesheet
@@ -211,13 +211,14 @@ Use the bead defined above in the camel endpoint
If you need to provide your custom processing of either headers or
attachments, extend existing BasicMessageFilter and override the
-appropriate methods or write a brand new implementation of the
-MessageFilter interface. +
- To use your custom filter, add this into your spring context:
+appropriate methods or write a brand-new implementation of the
+MessageFilter interface.
+To use your custom filter, add this into your spring context:
You can specify either a global a or a local message filter as
-follows:
- a) the global custom filter that provides the global configuration for
+follows:
+
+- the global custom filter that provides the global configuration for
all Spring-WS endpoints
[source,xml]
@@ -225,20 +226,19 @@ all Spring-WS endpoints
<bean id="messageFilter" class="your.domain.myMessageFiler" scope="singleton" />
--------------------------------------------------------------------------------
-or
- b) the local messageFilter directly on the endpoint as follows:
+- the local messageFilter directly on the endpoint as follows:
[source,java]
-------------------------------------------------------------------------------------
to("spring-ws:http://yourdomain.com?messageFilter=#myEndpointSpecificMessageFilter");
-------------------------------------------------------------------------------------
-For more information see
+For more information, see
https://issues.apache.org/jira/browse/CAMEL-5724[CAMEL-5724]
-If you want to create your own MessageFilter, consider overriding the
-following methods in the default implementation of MessageFilter in
-class BasicMessageFilter:
+If you want to create your own `MessageFilter`, consider overriding the
+following methods in the default implementation of `MessageFilter` in
+class `BasicMessageFilter`:
[source,java]
-------------------------------------------------------------------------------
@@ -274,7 +274,7 @@ Spring configuration:
</property>
</bean>
-<!-- force use of Sun SAAJ implementation, http://static.springsource.org/spring-ws/sites/1.5/faq.html#saaj-jboss -->
+<!-- force use of Sun SAAJ implementation, https://static.springsource.org/spring-ws/sites/1.5/faq.html#saaj-jboss -->
<bean id="messageFactory" class="org.springframework.ws.soap.saaj.SaajSoapMessageFactory">
<property name="messageFactory">
<bean class="com.sun.xml.messaging.saaj.soap.ver1_1.SOAPMessageFactory1_1Impl"/>
@@ -284,14 +284,14 @@ Spring configuration:
== Exposing web services
-In order to expose a web service using this component you first need to
-set-up a
+To expose a web service using this component, you first need to
+set up a
http://static.springsource.org/spring-ws/sites/1.5/reference/html/server.html[MessageDispatcher]
to look for endpoint mappings in a Spring XML file. If you plan on
-running inside a servlet container you probably want to use a
+running inside a servlet container, you probably want to use a
`MessageDispatcherServlet` configured in `web.xml`.
-By default the `MessageDispatcherServlet` will look for a Spring XML
+By default, the `MessageDispatcherServlet` will look for a Spring XML
named `/WEB-INF/spring-ws-servlet.xml`. To use Camel with Spring-WS the
only mandatory bean in that XML file is `CamelEndpointMapping`. This
bean allows the `MessageDispatcher` to dispatch web service requests to
@@ -337,13 +337,13 @@ http://static.springsource.org/spring-ws/sites/1.5/reference/html/tutorial.html[
Contract-First Web Services]. Basically paragraph 3.6 "Implementing the
Endpoint" is handled by this component (specifically paragraph 3.6.2
"Routing the Message to the Endpoint" is where `CamelEndpointMapping`
-comes in). Also don't forget to check out the
+comes in). Also remember to check out the
Spring Web Services Example included in the
Camel distribution.
== Endpoint mapping in routes
-With the XML configuration in-place you can now use Camel's DSL to
+With the XML configuration in place, you can now use Camel's DSL to
define what web service requests are handled by your endpoint:
The following route will receive all web service requests that have a
@@ -398,10 +398,10 @@ The use of the `beanname` mapping-type is primarily meant for (legacy)
situations where you're already using Spring-WS and have endpoint
mappings defined in a Spring XML file. The `beanname` mapping-type
allows you to wire your Camel route into an existing endpoint mapping.
-When you're starting from scratch it's recommended to define your
+When you're starting from scratch, it's recommended to define your
endpoint mappings as Camel URI's (as illustrated above with
`endpointMapping`) since it requires less configuration and is more
-expressive. Alternatively you could use vanilla Spring-WS with the help
+expressive. Alternatively, you could use vanilla Spring-WS with the help
of annotations.
====
@@ -433,10 +433,10 @@ An example of a route using `beanname`:
Camel's pluggable data formats offer support for
pojo/xml marshalling using libraries such as JAXB.
-You can use these data formats in your route to sent and
+You can use these data formats in your route to send and
receive pojo's, to and from web services.
-When _accessing_ web services you can marshal the request and unmarshal
+When _accessing_ web services, you can marshal the request and unmarshal
the response message:
[source,java]
@@ -447,7 +447,7 @@ jaxb.setContextPath("com.example.model");
from("direct:example").marshal(jaxb).to("spring-ws:http://foo.com/bar").unmarshal(jaxb);
----------------------------------------------------------------------------------------
-Similarly when _providing_ web services, you can unmarshal XML requests
+Similarly, when _providing_ web services, you can unmarshal XML requests
to POJO's and marshal the response message back to XML:
[source,java]
(camel) 11/11: CAMEL-20410: documentation fixes for camel-stitch
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 6ae7671bb359884dd40c0386f0b9e537250a2156
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Wed Feb 21 19:17:09 2024 +0100
CAMEL-20410: documentation fixes for camel-stitch
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
- Converted to use tabs
---
components/camel-stitch/src/main/docs/stitch-component.adoc | 13 +++++++------
1 file changed, 7 insertions(+), 6 deletions(-)
diff --git a/components/camel-stitch/src/main/docs/stitch-component.adoc b/components/camel-stitch/src/main/docs/stitch-component.adoc
index 54a81514891..b5dc738609d 100644
--- a/components/camel-stitch/src/main/docs/stitch-component.adoc
+++ b/components/camel-stitch/src/main/docs/stitch-component.adoc
@@ -14,7 +14,7 @@
*{component-header}*
-Stitch is a cloud ETL service, developer-focused platform for rapidly moving and replicates data from more than 90
+Stitch is a cloud ETL service, a developer-focused platform for rapidly moving and replicates data from more than 90
applications and databases. It integrates various data sources into a central data warehouse. Stitch has integrations
for many enterprise software data sources, and can receive data via WebHooks and an API (Stitch Import API) which
Camel Stitch Component uses to produce the data to Stitch ETL.
@@ -70,7 +70,7 @@ This allows camel route to consume and produce events asynchronously without blo
== Usage
-For example in order to produce data to Stitch from a custom processor:
+For example, to produce data to Stitch from a custom processor:
[source,java]
--------------------------------------------------------------------------------
@@ -110,7 +110,7 @@ can be type of `StitchMessage`, `StitchRequestBody` or `Map` but this Map here i
=== Examples
-Here are list of examples of data that can be proceeded to Stitch:
+Here is list of examples of data that can be proceeded to Stitch:
==== Input body type `org.apache.camel.component.stitch.client.models.StitchRequestBody`:
[source,java]
@@ -232,16 +232,17 @@ from("direct:sendStitch")
=== Development Notes (Important)
-When developing on this component, you will need to obtain your Stitch token in order to run the integration tests. In addition to the mocked unit tests
+When developing on this component, you will need to obtain your Stitch token to run the integration tests.
+In addition to the mocked unit tests,
you *will need to run the integration tests with every change you make*
-To run the integration tests, on this component directory, run the following maven command:
+To run the integration tests, in this component directory, run the following maven command:
[source,bash]
----
mvn verify -Dtoken=stitchToken
----
-Whereby `token` is your Stitch token that is generated for Stitch Import API integration.
+Whereby `token` is your Stitch token generated for Stitch Import API integration.
(camel) 06/11: CAMEL-20410: documentation fixes for camel-spring-redis
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 7a8fecc79c45d55fa82626917ad60ffaa96b3d0e
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Wed Feb 21 19:06:53 2024 +0100
CAMEL-20410: documentation fixes for camel-spring-redis
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
- Converted to use tabs
---
.../src/main/docs/spring-redis-component.adoc | 26 +++++++++++-----------
1 file changed, 13 insertions(+), 13 deletions(-)
diff --git a/components/camel-spring-redis/src/main/docs/spring-redis-component.adoc b/components/camel-spring-redis/src/main/docs/spring-redis-component.adoc
index ee65084abb2..d4b7d79a0d5 100644
--- a/components/camel-spring-redis/src/main/docs/spring-redis-component.adoc
+++ b/components/camel-spring-redis/src/main/docs/spring-redis-component.adoc
@@ -16,9 +16,9 @@
*{component-header}*
This component allows sending and receiving messages from
-https://redis.io/[Redis]. Redis is advanced key-value store where
+https://redis.io/[Redis]. Redis is an advanced key-value store where
keys can contain strings, hashes, lists, sets and sorted sets. In
-addition it provides pub/sub functionality for inter-app
+addition, it provides pub/sub functionality for inter-app
communications.
Camel provides a producer for executing commands, consumer for
subscribing to pub/sub messages an idempotent repository for filtering
@@ -28,7 +28,7 @@ out duplicate messages.
====
*Prerequisites*
-In order to use this component, you must have a Redis server running.
+To use this component, you must have a Redis server running.
====
== URI Format
@@ -62,8 +62,8 @@ at https://github.com/apache/camel/tree/main/components/camel-spring-redis/src/t
=== Message headers evaluated by the Redis producer
-The producer issues commands to the server and each command has
-different set of parameters with specific types. The result from the
+The producer issues commands to the server, and each command has
+a different set of parameters with specific types. The result from the
command execution is returned in the message body.
[width="100%",cols="10%,40%,50%,10%",options="header",]
@@ -75,12 +75,12 @@ command execution is returned in the message body.
|`HGET` |Get the value of a hash field |`RedisConstants.KEY`/"CamelRedis.Key" (String), `RedisConstants.FIELD`/"CamelRedis.Field" (String) |String
-|`HSETNX` |Set the value of a hash field, only if the field does not exist |`RedisConstants.KEY`/"CamelRedis.Key" (String), `RedisConstants.FIELD`/"CamelRedis.Field" (String), `RedisConstants.VALUE`/"CamelRedis.Value"
+|`HSETNX` |Set the value of a hash field only if the field does not exist |`RedisConstants.KEY`/"CamelRedis.Key" (String), `RedisConstants.FIELD`/"CamelRedis.Field" (String), `RedisConstants.VALUE`/"CamelRedis.Value"
(Object) |void
|`HMSET` |Set multiple hash fields to multiple values |`RedisConstants.KEY`/"CamelRedis.Key" (String), `RedisConstants.VALUES`/"CamelRedis.Values" (Map<String, Object>) |void
-|`HMGET` |Get the values of all the given hash fields |`RedisConstants.KEY`/"CamelRedis.Key" (String), `RedisConstants.FIELDS`/"CamelRedis.Filds" (Collection<String>) |Collection<Object>
+|`HMGET` |Get the values of all the given hash fields |`RedisConstants.KEY`/"CamelRedis.Key" (String), `RedisConstants.FIELDS`/"CamelRedis.Fields" (Collection<String>) |Collection<Object>
|`HINCRBY` |Increment the integer value of a hash field by the given number |`RedisConstants.KEY`/"CamelRedis.Key" (String), `RedisConstants.FIELD`/"CamelRedis.Field" (String), `RedisConstants.VALUE`/"CamelRedis.Value"
(Long) |Long
@@ -104,7 +104,7 @@ command execution is returned in the message body.
|`RPUSH` |Append one or multiple values to a list |`RedisConstants.KEY`/"CamelRedis.Key" (String), `RedisConstants.VALUE`/"CamelRedis.Value" (Object) |Long
-|`RPUSHX` |Append a value to a list, only if the list exists |`RedisConstants.KEY`/"CamelRedis.Key" (String), `RedisConstants.VALUE`/"CamelRedis.Value" (Object) |Long
+|`RPUSHX` |Append a value to a list only if the list exists |`RedisConstants.KEY`/"CamelRedis.Key" (String), `RedisConstants.VALUE`/"CamelRedis.Value" (Object) |Long
|`LPUSH` |Prepend one or multiple values to a list |`RedisConstants.KEY`/"CamelRedis.Key" (String), `RedisConstants.VALUE`/"CamelRedis.Value" (Object) |Long
@@ -221,7 +221,7 @@ from high to low |`RedisConstants.KEY`/"CamelRedis.Key" (String), `RedisConstant
|`ZREMRANGEBYSCORE` |Remove all members in a sorted set within the given scores |`RedisConstants.KEY`/"CamelRedis.Key" (String), `RedisConstants.START`/"CamelRedis.Start"Long), `RedisConstants.END`/"CamelRedis.End" (Long) |void
-|`ZUNIONSTORE` |Add multiple sorted sets and store the resulting sorted set in a new key |`RedisConstants.KEY`/"CamelRedis.Key" (String), `RedisConstants.KEYS`/"CamelRedis.Keys" (String),
+|`ZUNIONSTORE` |Add multiple sorted sets and store the resulting-sorted set in a new key |`RedisConstants.KEY`/"CamelRedis.Key" (String), `RedisConstants.KEYS`/"CamelRedis.Keys" (String),
`RedisConstants.DESTINATION`/"CamelRedis.Destination" (String) |void
|`ZINTERSTORE` |Intersect multiple sorted sets and store the resulting sorted set in a
@@ -251,7 +251,7 @@ new key |`RedisConstants.KEY`/"CamelRedis.Key" (String), `RedisConstants.KEYS`/"
|`GETRANGE` |Get a substring of the string stored at a key |`RedisConstants.KEY`/"CamelRedis.Key" (String), `RedisConstants.START`/"CamelRedis.Start"Long), `RedisConstants.END`/"CamelRedis.End" (Long) |String
-|`SETNX` |Set the value of a key, only if the key does not exist |`RedisConstants.KEY`/"CamelRedis.Key" (String), `RedisConstants.VALUE`/"CamelRedis.Value" (Object) |Boolean
+|`SETNX` |Set the value of a key only if the key does not exist |`RedisConstants.KEY`/"CamelRedis.Key" (String), `RedisConstants.VALUE`/"CamelRedis.Value" (Object) |Boolean
|`SETEX` |Set the value and expiration of a key |`RedisConstants.KEY`/"CamelRedis.Key" (String), `RedisConstants.VALUE`/"CamelRedis.Value" (Object), `RedisConstants.TIMEOUT`/"CamelRedis.Timeout"
(Long), SECONDS |void
@@ -268,7 +268,7 @@ new key |`RedisConstants.KEY`/"CamelRedis.Key" (String), `RedisConstants.KEYS`/"
|`MSET` |Set multiple keys to multiple values |`RedisConstants.VALUES`/"CamelRedis.Values" (Map<String, Object>) |void
-|`MSETNX` |Set multiple keys to multiple values, only if none of the keys exist |`RedisConstants.KEY`/"CamelRedis.Key" (String), `RedisConstants.VALUE`/"CamelRedis.Value" (Object) |void
+|`MSETNX` |Set multiple keys to multiple values only if none of the keys exist |`RedisConstants.KEY`/"CamelRedis.Key" (String), `RedisConstants.VALUE`/"CamelRedis.Value" (Object) |void
|`GETSET` |Set the string value of a key and return its old value |`RedisConstants.KEY`/"CamelRedis.Key" (String), `RedisConstants.VALUE`/"CamelRedis.Value" (Object) |Object
|=======================================================================
@@ -316,8 +316,8 @@ milliseconds |`RedisConstants.KEY`/"CamelRedis.Key" (String), `RedisConstants.TI
|`GEOADD` |Adds the specified geospatial items (latitude, longitude, name) to the specified key |`RedisConstants.KEY`/"CamelRedis.Key" (String), `RedisConstants.LATITUDE`/"CamelRedis.Latitude" (Double), `RedisConstants.LONGITUDE`/"CamelRedis.Longitude" (Double), `RedisConstants.VALUE`/"CamelRedis.Value" (Object) |Long
|`GEODIST` |Return the distance between two members in the geospatial index for the specified key |`RedisConstants.KEY`/"CamelRedis.Key" (String), `RedisConstants.VALUES`/"CamelRedis.Values" (Object[]) |Distance
|`GEOHASH` |Return valid Geohash strings representing the position of an element in the geospatial index for the specified key |`RedisConstants.KEY`/"CamelRedis.Key" (String), `RedisConstants.VALUE`/"CamelRedis.Value" (Object) |List<String>
-|`GEOPOS` |Return the positions (longitude,latitude) of an element in the geospatial index for the specified key |`RedisConstants.KEY`/"CamelRedis.Key" (String), `RedisConstants.VALUE`/"CamelRedis.Value" (Object) |List<Point>
-|`GEORADIUS` |Return the element in the geospatial index for the specified key which are within the borders of the area specified with the center location and the maximum distance from the center (the radius) |`RedisConstants.KEY`/"CamelRedis.Key" (String), `RedisConstants.LATITUDE`/"CamelRedis.Latitude" (Double), `RedisConstants.LONGITUDE`/"CamelRedis.Longitude" (Double), `RedisConstants.RADIUS`/"CamelRedis.Radius" (Double), `RedisConstants.COUNT`/"CamelRedis.Count" (Integer) |GeoResults
+|`GEOPOS` |Return the positions (longitude, latitude) of an element in the geospatial index for the specified key |`RedisConstants.KEY`/"CamelRedis.Key" (String), `RedisConstants.VALUE`/"CamelRedis.Value" (Object) |List<Point>
+|`GEORADIUS` |Return the element in the geospatial index for the specified key which is within the borders of the area specified with the center location and the maximum distance from the center (the radius) |`RedisConstants.KEY`/"CamelRedis.Key" (String), `RedisConstants.LATITUDE`/"CamelRedis.Latitude" (Double), `RedisConstants.LONGITUDE`/"CamelRedis.Longitude" (Double), `RedisConstants.RADIUS`/"CamelRedis.Radius" (Double), `RedisConstants.COUNT`/"CamelRedis.Count" (Integer) |GeoResults
|`GEORADIUSBYMEMBER` |This command is exactly like GEORADIUS with the sole difference that instead of taking, as the center of the area to query, a longitude and latitude value, it takes the name of a member already existing inside the geospatial index for the specified key |`RedisConstants.KEY`/"CamelRedis.Key" (String), `RedisConstants.VALUE`/"CamelRedis.Value" (Object), `RedisConstants.RADIUS`/"CamelRedis.Radius" (Double), `RedisConstants.COUNT`/"CamelRedis.Count" (Integer) |GeoResults
|=======================================================================
(camel) 10/11: CAMEL-20410: documentation fixes for camel-stax
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 563ac9dda2543269f88efaa10cc1157c6736749e
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Wed Feb 21 19:15:53 2024 +0100
CAMEL-20410: documentation fixes for camel-stax
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
- Converted to use tabs
---
components/camel-stax/src/main/docs/stax-component.adoc | 16 ++++++++--------
.../camel-stax/src/main/docs/xtokenize-language.adoc | 2 +-
2 files changed, 9 insertions(+), 9 deletions(-)
diff --git a/components/camel-stax/src/main/docs/stax-component.adoc b/components/camel-stax/src/main/docs/stax-component.adoc
index 439c93efefb..45b5137b9ec 100644
--- a/components/camel-stax/src/main/docs/stax-component.adoc
+++ b/components/camel-stax/src/main/docs/stax-component.adoc
@@ -14,10 +14,10 @@
*{component-header}*
-The StAX component allows messages to be process through a SAX
+The StAX component allows messages to be processed through a SAX
http://download.oracle.com/javase/6/docs/api/org/xml/sax/ContentHandler.html[ContentHandler]. +
Another feature of this component is to allow iterating over JAXB
-records using StAX, for example using the xref:eips:split-eip.adoc[Split EIP].
+records using StAX, for example, using the xref:eips:split-eip.adoc[Split EIP].
Maven users will need to add the following dependency to their `pom.xml`
for this component:
@@ -44,7 +44,7 @@ example:
stax:org.superbiz.FooContentHandler
-----------------------------------
-You can lookup a `org.xml.sax.ContentHandler` bean from the Registry
+You can look up a `org.xml.sax.ContentHandler` bean from the Registry
using the # syntax as shown:
---------------
@@ -72,7 +72,7 @@ include::partial$component-endpoint-options.adoc[]
The message body after the handling is the handler itself.
-Here an example:
+Here is an example:
[source,java]
--------------------------------------------------------------------------------------------------------
@@ -90,9 +90,9 @@ from("file:target/in")
== Iterate over a collection using JAXB and StAX
-First we suppose you have JAXB objects.
+First, we suppose you have JAXB objects.
-For instance a list of records in a wrapper object:
+For instance, a list of records in a wrapper object:
[source,java]
-------------------------------------------------
@@ -154,7 +154,7 @@ public class Record {
}
---------------------------------------------------------
-Then you get a XML file to process:
+Then you get an XML file to process:
[source,xml]
-------------------------------------------------------
@@ -213,7 +213,7 @@ The example above could be implemented as follows in Spring XML
<!-- split the file using StAX (ref to bean above) -->
<!-- and use streaming mode in the splitter -->
<ref>staxRecord</ref>
- <!-- and send each splitted to a mock endpoint, which will be a Record POJO instance -->
+ <!-- and send each split to a mock endpoint, which will be a Record POJO instance -->
<to uri="mock:records"/>
</split>
</route>
diff --git a/components/camel-stax/src/main/docs/xtokenize-language.adoc b/components/camel-stax/src/main/docs/xtokenize-language.adoc
index 0b18c2d5f65..9281deebdd6 100644
--- a/components/camel-stax/src/main/docs/xtokenize-language.adoc
+++ b/components/camel-stax/src/main/docs/xtokenize-language.adoc
@@ -27,6 +27,6 @@ include::partial$language-options.adoc[]
== Example
-See xref:eips:split-eip.adoc[Split] EIP which has examples using the XML Tokenize language.
+See xref:eips:split-eip.adoc[Split EIP], which has examples using the XML Tokenize language.
include::spring-boot:partial$starter.adoc[]
(camel) 05/11: CAMEL-20410: documentation fixes for camel-spring-rabbitmq
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 b8d6355aed953249607d5522446a63552a5b2bac
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Wed Feb 21 19:04:17 2024 +0100
CAMEL-20410: documentation fixes for camel-spring-rabbitmq
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
- Converted to use tabs
---
.../src/main/docs/spring-rabbitmq-component.adoc | 50 +++++++++++-----------
1 file changed, 26 insertions(+), 24 deletions(-)
diff --git a/components/camel-spring-rabbitmq/src/main/docs/spring-rabbitmq-component.adoc b/components/camel-spring-rabbitmq/src/main/docs/spring-rabbitmq-component.adoc
index 467c18b97f5..b760ae63ccb 100644
--- a/components/camel-spring-rabbitmq/src/main/docs/spring-rabbitmq-component.adoc
+++ b/components/camel-spring-rabbitmq/src/main/docs/spring-rabbitmq-component.adoc
@@ -60,18 +60,18 @@ include::partial$component-endpoint-headers.adoc[]
== Using a connection factory
-To connect to RabbitMQ you need to setup a `ConnectionFactory` (same as with JMS) with the login details such as:
+To connect to RabbitMQ, you need to set up a `ConnectionFactory` (same as with JMS) with the login details such as:
TIP: It is recommended to use `CachingConnectionFactory` from spring-rabbit as it comes with connection pooling out of the box.
[source,xml]
----
<bean id="rabbitConnectionFactory" class="org.springframework.amqp.rabbit.connection.CachingConnectionFactory">
- <property name="uri" value="amqp://lolcalhost:5672"/>
+ <property name="uri" value="amqp://localhost:5672"/>
</bean>
----
-The `ConnectionFactory` is auto-detected by default, so you can just do
+The `ConnectionFactory` is auto-detected by default, so you can do:
[source,xml]
----
@@ -97,14 +97,15 @@ to("spring-rabbitmq:default?routingKey=foo")
Before you can send or receive messages from RabbitMQ, then exchanges, queues and bindings must be setup first.
-In development mode it may be desirable to let Camel automatic do this.
+In development mode, it may be desirable to let Camel automatic do this.
You can enable this by setting `autoDeclare=true` on the `SpringRabbitMQComponent`.
-Then Spring RabbitMQ will automatic necessary declare the elements and setup the binding between the exchange, queue and routing keys.
+Then Spring RabbitMQ will automatically declare the necessary elements and set up the binding between the exchange,
+queue and routing keys.
-The elements can be configured using the multi-valued `args` option.
+The elements can be configured using the multivalued `args` option.
-For example to specify the queue as durable and exclusive, you can configure the endpoint uri with `arg.queue.durable=true&arg.queue.exclusive=true`.
+For example, to specify the queue as durable and exclusive, you can configure the endpoint uri with `arg.queue.durable=true&arg.queue.exclusive=true`.
*Exchanges*
@@ -127,8 +128,8 @@ See details in the RabbitMQ documentation.
| autoDelete | boolean | True if the server should delete the exchange when it is no longer in use (if all bindings are deleted). | false
| durable | boolean | A durable queue will survive a server restart. | false
| exclusive | boolean | Whether the queue is exclusive | false
-| x-dead-letter-exchange | String | The name of the dead letter exchange. If none configured then the component configured value is used. |
-| x-dead-letter-routing-key | String | The routing key for the dead letter exchange. If none configured then the component configured value is used. |
+| x-dead-letter-exchange | String | The name of the dead letter exchange. If none configured, then the component configured value is used. |
+| x-dead-letter-routing-key | String | The routing key for the dead letter exchange. If none configured, then the component configured value is used. |
|=====================================================================
You can also configure any additional `x-` arguments, such as the message time to live, via `x-message-ttl`, and many others.
@@ -137,26 +138,27 @@ See details in the RabbitMQ documentation.
== Mapping from Camel to RabbitMQ
The message body is mapped from Camel Message body to a `byte[]` which is the type that RabbitMQ uses for message body.
-Camel wil use its type converter to convert the message body to byte array.
+Camel will use its type converter to convert the message body to a byte array.
-Spring Rabbit comes out of the box with support for mapping Java serialized objects but Camel Spring RabbitMQ
+Spring Rabbit comes out of the box with support for mapping Java serialized objects, but Camel Spring RabbitMQ
does *not* support this due to security vulnerabilities and using Java objects is a bad design as it enforces strong coupling.
-Custom message headers is mapped from Camel Message headers to RabbitMQ headers. This behaviour can be customized by configuring
+Custom message headers are mapped from Camel Message headers to RabbitMQ headers.
+This behaviour can be customized by configuring
a new implementation of `HeaderFilterStrategy` on the Camel component.
== Request / Reply
Request and reply messaging is supported using https://www.rabbitmq.com/direct-reply-to.html[RabbitMQ direct reply-to].
-The example below will do request/reply, where the message is sent via the cheese exchange name and routing key _foo.bar_,
-which is being consumed by the 2nd Camel route, that prepends the message with `Hello `, and then sends back the message.
+The example below will do request/reply, where the message is sent via the cheese exchange name and routing key `foo.bar`,
+which is being consumed by the second Camel route, that prepends the message with `Hello `, and then sends back the message.
So if we send `World` as message body to _direct:start_ then, we will se the message being logged
-- log:request => World
-- log:input => World
-- log:response => Hello World
+- `log:request -> World`
+- `log:input -> World`
+- `log:response -> Hello World`
[source,java]
----
@@ -173,7 +175,7 @@ from("spring-rabbitmq:cheese?queues=myqueue&routingKey=foo.bar")
== Reuse endpoint and send to different destinations computed at runtime
If you need to send messages to a lot of different RabbitMQ exchanges, it
-makes sense to reuse a endpoint and specify the real destination in
+makes sense to reuse an endpoint and specify the real destination in
a message header. This allows Camel to reuse the same endpoint, but send
to different exchanges. This greatly reduces the number of endpoints
created and economizes on memory and thread resources.
@@ -220,18 +222,18 @@ the message to `spring-rabbitmq:order-emea`, assuming the `region` value was `em
Keep in mind that the producer removes both `CamelSpringRabbitmqExchangeOverrideName` and `CamelSpringRabbitmqRoutingOverrideKey`
headers from the exchange and do not propagate them to the created Rabbitmq
-message in order to avoid the accidental loops
-in the routes (in scenarios when the message will be forwarded to the
+message to avoid the accidental loops
+in the routes (in scenarios when the message will be forwarded to
another RabbitMQ endpoint).
== Using toD
If you need to send messages to a lot of different exchanges, it
-makes sense to reuse a endpoint and specify the dynamic destinations
+makes sense to reuse an endpoint and specify the dynamic destinations
with simple language using xref:eips:toD-eip.adoc[toD].
-For example suppose you need to send messages to exchanges with order types,
-then using toD could for example be done as follows:
+For example, suppose you need to send messages to exchanges with order types,
+then using toD could, for example, be done as follows:
[source,java]
----
@@ -241,7 +243,7 @@ from("direct:order")
== Manual Acknowledgement
-If we need to manually acknowledge a message for some use case we can
+If we need to manually acknowledge a message for some use case, we can
do it by setting and acknowledgeMode to Manual and using the below snippet
of code to get Channel and deliveryTag to manually acknowledge the message:
(camel) 01/11: CAMEL-20410: documentation fixes for camel-spring-batch
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 ae415c9013c6a28131be8e1d0ff8d8d1d29d2545
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Wed Feb 21 18:54:56 2024 +0100
CAMEL-20410: documentation fixes for camel-spring-batch
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
- Converted to use tabs
---
.../src/main/docs/spring-batch-component.adoc | 15 ++++++++-------
1 file changed, 8 insertions(+), 7 deletions(-)
diff --git a/components/camel-spring-batch/src/main/docs/spring-batch-component.adoc b/components/camel-spring-batch/src/main/docs/spring-batch-component.adoc
index 05287af8ff5..30414325ee0 100644
--- a/components/camel-spring-batch/src/main/docs/spring-batch-component.adoc
+++ b/components/camel-spring-batch/src/main/docs/spring-batch-component.adoc
@@ -39,7 +39,8 @@ spring-batch:jobName[?options]
------------------------------
Where *jobName* represents the name of the Spring Batch job located in
-the Camel registry. Alternatively if a JobRegistry is provided it will be used
+the Camel registry.
+Alternatively, if a JobRegistry is provided, it will be used
to locate the job instead.
WARNING: This component can only be used to define producer endpoints, which
@@ -64,7 +65,7 @@ include::partial$component-endpoint-options.adoc[]
== Usage
-When Spring Batch component receives the message, it triggers the job
+When the Spring Batch component receives the message, it triggers the job
execution. The job will be executed using the
`org.springframework.batch.core.launch.JobLaucher` instance resolved
according to the following algorithm:
@@ -75,7 +76,7 @@ Registry for the `JobLauncher` with the given name.
*Deprecated and will be removed in Camel 3.0!*
* if there is `JobLauncher` registered in the Camel
Registry under *jobLauncher* name, then use it.
-* if none of the steps above allow to resolve the `JobLauncher` and
+* if none of the steps above allow resolving the `JobLauncher` and
there is exactly one `JobLauncher` instance in the Camel
Registry, then use it.
@@ -125,7 +126,7 @@ classes, which can be used to hook into Spring Batch infrastructure.
`CamelItemReader` can be used to read batch data directly from the Camel
infrastructure.
-For example the snippet below configures Spring Batch to read data from
+For example, the snippet below is configuring Spring Batch to read data from
JMS queue.
[source,xml]
@@ -149,7 +150,7 @@ JMS queue.
`CamelItemWriter` has similar purpose as `CamelItemReader`, but it is
dedicated to write chunk of the processed data.
-For example the snippet below configures Spring Batch to read data from
+For example, the snippet below is configuring Spring Batch to read data from
JMS queue.
[source,xml]
@@ -172,13 +173,13 @@ JMS queue.
`CamelItemProcessor` is the implementation of Spring Batch
`org.springframework.batch.item.ItemProcessor` interface. The latter
-implementation relays on
+implementation relays on the
http://camel.apache.org/request-reply.html[Request Reply pattern] to
delegate the processing of the batch item to the Camel infrastructure.
The item to process is sent to the Camel endpoint as the body of the
message.
-For example the snippet below performs simple processing of the batch
+For example, the snippet below performs simple processing of the batch
item using the http://camel.apache.org/direct.html[Direct endpoint] and
the http://camel.apache.org/simple.html[Simple expression language].
(camel) 02/11: CAMEL-20410: documentation fixes for camel-spring-jdbc
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 a22c1cf3c6e99ad4de0a8cdb94fce7027ad7264b
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Wed Feb 21 18:56:00 2024 +0100
CAMEL-20410: documentation fixes for camel-spring-jdbc
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
- Converted to use tabs
---
components/camel-spring-jdbc/src/main/docs/spring-jdbc-component.adoc | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/components/camel-spring-jdbc/src/main/docs/spring-jdbc-component.adoc b/components/camel-spring-jdbc/src/main/docs/spring-jdbc-component.adoc
index d202ba12cef..d7865c6b491 100644
--- a/components/camel-spring-jdbc/src/main/docs/spring-jdbc-component.adoc
+++ b/components/camel-spring-jdbc/src/main/docs/spring-jdbc-component.adoc
@@ -18,7 +18,7 @@
The Spring JDBC component is an extension of the JDBC component with one additional feature
to integrate with Spring Transaction Manager.
-For general use of this component then see the xref:jdbc-component.adoc[JDBC Component].
+NOTE: For general use of this component, see the xref:jdbc-component.adoc[JDBC Component].
Maven users will need to add the following dependency to their `pom.xml`
for this component:
(camel) 07/11: CAMEL-20410: documentation fixes for camel-spring-security
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 f376c82d7c59df4ed202b4d322d70c64b94ea43a
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Wed Feb 21 19:08:48 2024 +0100
CAMEL-20410: documentation fixes for camel-spring-security
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
- Converted to use tabs
---
.../src/main/docs/spring-security.adoc | 24 ++++++++++++----------
1 file changed, 13 insertions(+), 11 deletions(-)
diff --git a/components/camel-spring-security/src/main/docs/spring-security.adoc b/components/camel-spring-security/src/main/docs/spring-security.adoc
index e00ca08e448..edb83739f3a 100644
--- a/components/camel-spring-security/src/main/docs/spring-security.adoc
+++ b/components/camel-spring-security/src/main/docs/spring-security.adoc
@@ -15,13 +15,13 @@ The Camel Spring Security component provides role-based authorization
for Camel routes. It leverages the authentication and user services
provided by
https://spring.io/projects/spring-security[Spring
-Security] (formerly Acegi Security) and adds a declarative, role-based
+Security] (formerly Acegi Security), and adds a declarative, role-based
policy system to control whether a route can be executed by a given
principal.
If you are not familiar with the Spring Security authentication and
authorization system, please review the current reference documentation
-on the SpringSource web site linked above.
+on the SpringSource website linked above.
[[SpringSecurity-Creatingauthorizationpolicies]]
== Creating authorization policies
@@ -60,7 +60,7 @@ context
instance.
|`useThreadSecurityContext` |`true` |If a `javax.security.auth.Subject` cannot be found in the In message
-header under Exchange.AUTHENTICATION, check the Spring Security
+header under `Exchange.AUTHENTICATION`, check the Spring Security
`SecurityContextHolder` for an `Authentication` object.
|`alwaysReauthenticate` |`false` |If set to true, the `SpringSecurityAuthorizationPolicy` will always call
@@ -130,7 +130,7 @@ to a route:
<route>
<from uri="direct:start"/>
<!-- The exchange should be authenticated with the role -->
- <!-- of ADMIN before it is send to mock:endpoint -->
+ <!-- of ADMIN before it is sent to mock:endpoint -->
<policy ref="admin">
<to uri="mock:end"/>
</policy>
@@ -147,12 +147,14 @@ the _admin_ `SpringSecurityAuthorizationPolicy`.
[[SpringSecurity-Authentication]]
== Authentication
-The process of obtaining security credentials that are used for
-authorization is not specified by this component. You can write your own
-processors or components which get authentication information from the
-exchange depending on your needs. For example, you might create a
+This component does not specify the process of obtaining security credentials that are used for
+authorization.
+You can write your own processors or components which get authentication information from the
+exchange depending on your needs.
+For example, you might create a
processor that gets credentials from an HTTP request header originating
-in the xref:ROOT:jetty-component.adoc[Jetty] component. No matter how the credentials
+in the xref:ROOT:jetty-component.adoc[Jetty] component.
+No matter how the credentials
are collected, they need to be placed in the In message or the
`SecurityContextHolder` so the Camel xref:spring-security.adoc[Spring
Security] component can access them:
@@ -168,7 +170,7 @@ import org.springframework.security.authentication.*;
public class MyAuthService implements Processor {
public void process(Exchange exchange) throws Exception {
// get the username and password from the HTTP header
- // http://en.wikipedia.org/wiki/Basic_access_authentication
+ // https://en.wikipedia.org/wiki/Basic_access_authentication
String userpass = new String(Base64.decodeBase64(exchange.getIn().getHeader("Authorization", String.class)));
String[] tokens = userpass.split(":");
@@ -222,7 +224,7 @@ If authentication or authorization fails in the
will be thrown. This can be handled using Camel's standard exception
handling methods, like the Exception Clause.
The `CamelAuthorizationException` will have a reference to the ID of the
-policy which threw the exception so you can handle errors based on the
+policy which threw the exception, so you can handle errors based on the
policy as well as the type of exception:
[source,xml]
(camel) 03/11: CAMEL-20410: documentation fixes for camel-spring-ldap
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 65def250a802036f0ea2e7f31d45f4c14c4b743b
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Wed Feb 21 18:57:15 2024 +0100
CAMEL-20410: documentation fixes for camel-spring-ldap
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
- Converted to use tabs
---
.../src/main/docs/spring-ldap-component.adoc | 16 ++++++++--------
1 file changed, 8 insertions(+), 8 deletions(-)
diff --git a/components/camel-spring-ldap/src/main/docs/spring-ldap-component.adoc b/components/camel-spring-ldap/src/main/docs/spring-ldap-component.adoc
index c1e1a8c98b0..e117e6cbbab 100644
--- a/components/camel-spring-ldap/src/main/docs/spring-ldap-component.adoc
+++ b/components/camel-spring-ldap/src/main/docs/spring-ldap-component.adoc
@@ -109,16 +109,16 @@ This operation allows dynamic invocation of LdapTemplate methods that are not co
*Key definitions*
-In order to avoid spelling errors, the following constants are defined
+To avoid spelling errors, the following constants are defined
in `org.apache.camel.springldap.SpringLdapProducer`:
-* public static final String DN = "dn"
-* public static final String FILTER = "filter"
-* public static final String ATTRIBUTES = "attributes"
-* public static final String PASSWORD = "password";
-* public static final String MODIFICATION_ITEMS = "modificationItems";
-* public static final String FUNCTION = "function";
-* public static final String REQUEST = "request";
+* `public static final String DN = "dn"`
+* `public static final String FILTER = "filter"`
+* `public static final String ATTRIBUTES = "attributes"`
+* `public static final String PASSWORD = "password";`
+* `public static final String MODIFICATION_ITEMS = "modificationItems";`
+* `public static final String FUNCTION = "function";`
+* `public static final String REQUEST = "request";`
include::spring-boot:partial$starter.adoc[]