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
The following commit(s) were added to refs/heads/main by this push:
new cfd737d7adf CAMEL-21040: ensure more consistency in the document
sections
cfd737d7adf is described below
commit cfd737d7adf44763d64daeb178e245392db929fe
Author: Otavio Rodolfo Piske <angusyo...@gmail.com>
AuthorDate: Wed Aug 7 11:57:16 2024 +0200
CAMEL-21040: ensure more consistency in the document sections
---
.../main/docs/langchain4j-tokenizer-component.adoc | 8 ++--
.../camel-http/src/main/docs/http-component.adoc | 44 +++++++++++-----------
.../src/main/docs/hwcloud-dms-component.adoc | 4 +-
.../src/main/docs/hwcloud-frs-component.adoc | 6 +--
.../main/docs/hwcloud-functiongraph-component.adoc | 5 +--
.../src/main/docs/hwcloud-iam-component.adoc | 5 ++-
.../docs/hwcloud-imagerecognition-component.adoc | 6 +--
.../src/main/docs/hwcloud-obs-component.adoc | 4 +-
.../src/main/docs/hwcloud-smn-component.adoc | 8 ++--
.../main/docs/infinispan-embedded-component.adoc | 7 ++--
.../src/main/docs/infinispan-component.adoc | 9 +++--
.../camel-irc/src/main/docs/irc-component.adoc | 14 ++++---
.../src/main/docs/ironmq-component.adoc | 11 ++++--
.../src/main/docs/avroJackson-dataformat.adoc | 19 +++++-----
.../src/main/docs/protobufJackson-dataformat.adoc | 19 +++++-----
.../src/main/docs/jackson-dataformat.adoc | 10 +++--
.../src/main/docs/jacksonXml-dataformat.adoc | 19 +++++-----
.../camel-jaxb/src/main/docs/jaxb-dataformat.adoc | 25 ++++++------
.../src/main/docs/jcache-component.adoc | 30 ++++++++-------
.../camel-jetty/src/main/docs/jetty-component.adoc | 30 +++++++--------
20 files changed, 154 insertions(+), 129 deletions(-)
diff --git
a/components/camel-ai/camel-langchain4j-tokenizer/src/main/docs/langchain4j-tokenizer-component.adoc
b/components/camel-ai/camel-langchain4j-tokenizer/src/main/docs/langchain4j-tokenizer-component.adoc
index 9962d14aec7..cd47368d22e 100644
---
a/components/camel-ai/camel-langchain4j-tokenizer/src/main/docs/langchain4j-tokenizer-component.adoc
+++
b/components/camel-ai/camel-langchain4j-tokenizer/src/main/docs/langchain4j-tokenizer-component.adoc
@@ -35,7 +35,9 @@ for this component:
</dependency>
----
-== Chunking DSL
+== Usage
+
+=== Chunking DSL
The tokenization process is done in route, using a DSL that handles the
parameters of the tokenization:
@@ -62,7 +64,7 @@ The tokenization creates a composite message (i.e.: an array
of Strings). This c
using the xref:eips:split-eip.adoc[Split EIP] so that each text segment is
separately to an endpoint. Alternatively, the
contents of the composite message may be passed through a processor so that
invalid data is filtered.
-== Supported Splitters
+=== Supported Splitters
The following type of splitters is supported:
@@ -72,7 +74,7 @@ The following type of splitters is supported:
* By line: using the DSL `tokenizer().byLine()`
* By character: using the DSL `tokenizer().byCharacter()`
-== Supported Tokenizers
+=== Supported Tokenizers
The following tokenizers are supported:
diff --git a/components/camel-http/src/main/docs/http-component.adoc
b/components/camel-http/src/main/docs/http-component.adoc
index 0527caf5b5d..b2f8d16fa92 100644
--- a/components/camel-http/src/main/docs/http-component.adoc
+++ b/components/camel-http/src/main/docs/http-component.adoc
@@ -57,14 +57,16 @@ include::partial$component-endpoint-options.adoc[]
include::partial$component-endpoint-headers.adoc[]
// component headers: END
-== Message Body
+== Usage
+
+=== Message Body
Camel will store the HTTP response from the external server on the _OUT_ body.
All headers from the _IN_ message will be copied to the _OUT_ message,
so headers are preserved during routing. Additionally, Camel will add the
HTTP response headers as well to the _OUT_ message headers.
-== Using System Properties
+=== Using System Properties
When setting useSystemProperties to true, the HTTP Client will look for
the following System Properties, and it will use it:
@@ -86,7 +88,7 @@ the following System Properties, and it will use it:
* `http.keepAlive`
* `http.maxConnections`
-== Response code
+=== Response code
Camel will handle, according to the HTTP response code:
@@ -104,7 +106,7 @@ The option, `throwExceptionOnFailure`, can be set to
`false` to prevent
the `HttpOperationFailedException` from being thrown for failed response
codes. This allows you to get any response from the remote server.
-== Exceptions
+=== Exceptions
`HttpOperationFailedException` exception contains the following information:
@@ -114,7 +116,7 @@ codes. This allows you to get any response from the remote
server.
* Response body as a `java.lang.String`, if server provided a body as
response
-== Which HTTP method will be used
+=== Which HTTP method will be used
The following algorithm is used to determine what HTTP method should be used: +
1. Use method provided as endpoint configuration (`httpMethod`). +
@@ -124,7 +126,7 @@ The following algorithm is used to determine what HTTP
method should be used: +
5. `POST` if there is data to send (body is not `null`). +
6. `GET` otherwise.
-== Configuring URI to call
+=== Configuring URI to call
You can set the HTTP producer's URI directly from the endpoint URI. In
the route below, Camel will call out to the external server, `oldhost`,
@@ -161,7 +163,7 @@ endpoint is configured with http://oldhost. +
If the http endpoint is working in bridge mode, it will ignore the
message header of `Exchange.HTTP_URI`.
-== Configuring URI Parameters
+=== Configuring URI Parameters
The *http* producer supports URI parameters to be sent to the HTTP
server. The URI parameters can either be set directly on the endpoint
@@ -182,7 +184,7 @@ from("direct:start")
.to("http://oldhost";);
---------------------------------------------------------------------
-== How to set the http method (GET/PATCH/POST/PUT/DELETE/HEAD/OPTIONS/TRACE)
to the HTTP producer
+=== How to set the http method (GET/PATCH/POST/PUT/DELETE/HEAD/OPTIONS/TRACE)
to the HTTP producer
The HTTP component provides a way to set the HTTP request method by
setting the message header. Here is an example:
@@ -216,13 +218,13 @@ And the equivalent XML DSL:
</route>
---------------------------------------------------------------------
-== Using client timeout - SO_TIMEOUT
+=== Using client timeout - SO_TIMEOUT
See the
https://github.com/apache/camel/blob/main/components/camel-http/src/test/java/org/apache/camel/component/http/HttpSOTimeoutTest.java[HttpSOTimeoutTest]
unit test.
-== Configuring a Proxy
+=== Configuring a Proxy
The HTTP component provides a way to configure a proxy.
@@ -235,7 +237,7 @@ from("direct:start")
There is also support for proxy authentication via the
`proxyAuthUsername` and `proxyAuthPassword` options.
-=== Using proxy settings outside of URI
+==== Using proxy settings outside of URI
To avoid System properties conflicts, you can set proxy configuration
only from the CamelContext or URI. +
@@ -266,7 +268,7 @@ So you can override the system properties with the endpoint
options.
There is also a `http.proxyScheme` property you
can set to explicitly configure the scheme to use.
-== Configuring charset
+=== Configuring charset
If you are using `POST` to send data you can configure the `charset`
using the `Exchange` property:
@@ -276,7 +278,7 @@ using the `Exchange` property:
exchange.setProperty(Exchange.CHARSET_NAME, "ISO-8859-1");
----------------------------------------------------------
-=== Example with scheduled poll
+==== Example with scheduled poll
This sample polls the Google homepage every 10 seconds and write the
page to the file `message.html`:
@@ -289,7 +291,7 @@ from("timer://foo?fixedRate=true&delay=0&period=10000")
.to("file:target/google");
------------------------------------------------------------
-=== URI Parameters from the endpoint URI
+==== URI Parameters from the endpoint URI
In this sample, we have the complete URI endpoint that is just what you
would have typed in a web browser. Multiple URI parameters can of course
@@ -302,7 +304,7 @@ web browser. Camel does no tricks here.
template.sendBody("http://www.google.com/search?q=Camel";, null);
-----------------------------------------------------------------
-=== URI Parameters from the Message
+==== URI Parameters from the Message
[source,java]
------------------------------------------------------------------
@@ -315,7 +317,7 @@ template.sendBody("http://www.google.com/search";, null,
headers);
In the header value above notice that it should *not* be prefixed with
`?` and you can separate parameters as usual with the `&` char.
-=== Getting the Response Code
+==== Getting the Response Code
You can get the HTTP response code from the HTTP component by getting
the value from the Out message header with
@@ -332,17 +334,17 @@ Message out = exchange.getOut();
int responseCode = out.getHeader(Exchange.HTTP_RESPONSE_CODE, Integer.class);
------------------------------------------------------------------------------------
-== Disabling Cookies
+=== Disabling Cookies
To disable cookies in the CookieStore, you can set the HTTP Client to ignore
cookies by
adding this URI option: `httpClient.cookieSpec=ignore`. This doesn't affect
cookies manually set in the `Cookie` header
-== Basic auth with the streaming message body
+=== Basic auth with the streaming message body
To avoid the `NonRepeatableRequestException`, you need to do the
Preemptive Basic Authentication by adding the option:
`authenticationPreemptive=true`
-== OAuth2 Support
+=== OAuth2 Support
To get an access token from an Authorization Server and fill that in
Authorization header to do requests to protected services, you will need to use
`oauth2ClientId`, `oauth2ClientSecret` and `oauth2TokenEndpoint` properties,
and those should be defined as specified at RFC 6749 and provided by your
Authorization Server.
@@ -365,13 +367,13 @@ Camel only provides support for OAuth2 client credentials
flow
[IMPORTANT]
Camel does not perform any validation in access token. It's up to the
underlying service to validate it.
-== Advanced Usage
+=== Advanced Usage
If you need more control over the HTTP producer, you should use the
`HttpComponent` where you can set various classes to give you custom
behavior.
-=== Setting up SSL for HTTP Client
+==== Setting up SSL for HTTP Client
[[HTTP-UsingtheJSSEConfigurationUtility]]
Using the JSSE Configuration Utility
diff --git
a/components/camel-huawei/camel-huaweicloud-dms/src/main/docs/hwcloud-dms-component.adoc
b/components/camel-huawei/camel-huaweicloud-dms/src/main/docs/hwcloud-dms-component.adoc
index 03237cdbd73..3f070e3e854 100644
---
a/components/camel-huawei/camel-huaweicloud-dms/src/main/docs/hwcloud-dms-component.adoc
+++
b/components/camel-huawei/camel-huaweicloud-dms/src/main/docs/hwcloud-dms-component.adoc
@@ -111,7 +111,7 @@ If any of the above properties are set, they will override
their corresponding q
|=======================================================================
-== List of Supported DMS Operations
+=== List of Supported DMS Operations
- createInstance
- deleteInstance
@@ -153,7 +153,7 @@ from("direct:triggerRoute")
.to("hwcloud-dms:updateInstance?instanceId=******®ion=cn-north-4&accessKey=********&secretKey=********&projectId=*******")
----
-== Using ServiceKey Configuration Bean
+=== Using ServiceKey Configuration Bean
Access key and secret keys are required to authenticate against cloud DMS
service. You can avoid having them being exposed
and scattered over in your endpoint uri by wrapping them inside a bean of
class `org.apache.camel.component.huaweicloud.common.models.ServiceKeys`.
diff --git
a/components/camel-huawei/camel-huaweicloud-frs/src/main/docs/hwcloud-frs-component.adoc
b/components/camel-huawei/camel-huaweicloud-frs/src/main/docs/hwcloud-frs-component.adoc
index 7654a27b81e..307c82a5361 100644
---
a/components/camel-huawei/camel-huaweicloud-frs/src/main/docs/hwcloud-frs-component.adoc
+++
b/components/camel-huawei/camel-huaweicloud-frs/src/main/docs/hwcloud-frs-component.adoc
@@ -87,15 +87,15 @@ When using imageBase64 or videoBase64 option, we suggest
you use RAW(base64_valu
|=======================================================================
-== List of Supported Operations
+=== List of Supported Operations
- faceDetection - detect, locate, and analyze the face in an input image, and
output the key facial points and attributes.
- faceVerification - compare two faces to verify whether they belong to the
same person and return the confidence level
- faceLiveDetection - determine whether a person in a video is alive by
checking whether the person's actions in the video are consistent with those in
the input action list
-== Inline Configuration of route
+=== Inline Configuration of route
-=== faceDetection
+==== faceDetection
Java DSL
diff --git
a/components/camel-huawei/camel-huaweicloud-functiongraph/src/main/docs/hwcloud-functiongraph-component.adoc
b/components/camel-huawei/camel-huaweicloud-functiongraph/src/main/docs/hwcloud-functiongraph-component.adoc
index 92cb08afeae..fe7b940f433 100644
---
a/components/camel-huawei/camel-huaweicloud-functiongraph/src/main/docs/hwcloud-functiongraph-component.adoc
+++
b/components/camel-huawei/camel-huaweicloud-functiongraph/src/main/docs/hwcloud-functiongraph-component.adoc
@@ -80,12 +80,11 @@ If the operation, function name, or function package are
set, they will override
|=======================================================================
-
-== List of Supported FunctionGraph Operations
+=== List of Supported FunctionGraph Operations
- invokeFunction - to invoke a serverless function
-== Using ServiceKey Configuration Bean
+=== Using ServiceKey Configuration Bean
Access key and secret keys are required to authenticate against cloud
FunctionGraph service. You can avoid having them being exposed
and scattered over in your endpoint uri by wrapping them inside a bean of
class `org.apache.camel.component.huaweicloud.functiongraph.models.ServiceKeys`.
diff --git
a/components/camel-huawei/camel-huaweicloud-iam/src/main/docs/hwcloud-iam-component.adoc
b/components/camel-huawei/camel-huaweicloud-iam/src/main/docs/hwcloud-iam-component.adoc
index 288291eec77..6627781287d 100644
---
a/components/camel-huawei/camel-huaweicloud-iam/src/main/docs/hwcloud-iam-component.adoc
+++
b/components/camel-huawei/camel-huaweicloud-iam/src/main/docs/hwcloud-iam-component.adoc
@@ -67,7 +67,7 @@ include::partial$component-endpoint-options.adoc[]
If any of the above properties are set, they will override their corresponding
query parameter.
-== List of Supported IAM Operations
+=== List of Supported IAM Operations
- listUsers
- getUser - `userId` parameter is *required*
@@ -111,7 +111,7 @@ from("direct:triggerRoute")
.to("hwcloud-iam:updateUser?groupId=********®ion=cn-north-4&accessKey=********&secretKey=********")
----
-== Using ServiceKey Configuration Bean
+=== Using ServiceKey Configuration Bean
Access key and secret keys are required to authenticate against cloud IAM
service. You can avoid having them being exposed
and scattered over in your endpoint uri by wrapping them inside a bean of
class `org.apache.camel.component.huaweicloud.iam.models.ServiceKeys`.
@@ -126,6 +126,7 @@ Check the following code snippets:
<property name="secretKey" value="your_secret_key" />
</bean>
----
+
[source,java]
----
from("direct:triggerRoute")
diff --git
a/components/camel-huawei/camel-huaweicloud-imagerecognition/src/main/docs/hwcloud-imagerecognition-component.adoc
b/components/camel-huawei/camel-huaweicloud-imagerecognition/src/main/docs/hwcloud-imagerecognition-component.adoc
index 9ec99947ee3..ddc022c5249 100644
---
a/components/camel-huawei/camel-huaweicloud-imagerecognition/src/main/docs/hwcloud-imagerecognition-component.adoc
+++
b/components/camel-huawei/camel-huaweicloud-imagerecognition/src/main/docs/hwcloud-imagerecognition-component.adoc
@@ -75,14 +75,14 @@ When using imageContent option, we suggest you use
RAW(image_base64_value) to av
|=======================================================================
-== List of Supported Image Recognition Operations
+=== List of Supported Image Recognition Operations
- celebrityRecognition - to analyze and identify the political figures, stars
and online celebrities contained in the picture, and return the person
information and face coordinates
- tagRecognition - to recognize hundreds of scenes and thousands of objects
and their properties in natural images
-== Inline Configuration of route
+=== Inline Configuration of route
-=== celebrityRecognition
+==== celebrityRecognition
Java DSL
diff --git
a/components/camel-huawei/camel-huaweicloud-obs/src/main/docs/hwcloud-obs-component.adoc
b/components/camel-huawei/camel-huaweicloud-obs/src/main/docs/hwcloud-obs-component.adoc
index f0ed5d351eb..12822d39e19 100644
---
a/components/camel-huawei/camel-huaweicloud-obs/src/main/docs/hwcloud-obs-component.adoc
+++
b/components/camel-huawei/camel-huaweicloud-obs/src/main/docs/hwcloud-obs-component.adoc
@@ -84,7 +84,7 @@ If any of the above properties are set, they will override
their corresponding q
include::partial$component-endpoint-headers.adoc[]
// component headers: END
-== List of Supported OBS Operations
+=== List of Supported OBS Operations
- listBuckets
- createBucket - `bucketName` parameter is *required*, `bucketLocation`
parameter is optional
@@ -131,7 +131,7 @@ from("direct:triggerRoute")
----
-== Using ServiceKey Configuration Bean
+=== Using ServiceKey Configuration Bean
Access key and secret keys are required to authenticate against the OBS cloud.
You can avoid having them being exposed
and scattered over in your endpoint uri by wrapping them inside a bean of
class `org.apache.camel.component.huaweicloud.obs.models.ServiceKeys`.
diff --git
a/components/camel-huawei/camel-huaweicloud-smn/src/main/docs/hwcloud-smn-component.adoc
b/components/camel-huawei/camel-huaweicloud-smn/src/main/docs/hwcloud-smn-component.adoc
index 5ad90d8b271..da9c749c9ec 100644
---
a/components/camel-huawei/camel-huaweicloud-smn/src/main/docs/hwcloud-smn-component.adoc
+++
b/components/camel-huawei/camel-huaweicloud-smn/src/main/docs/hwcloud-smn-component.adoc
@@ -87,7 +87,7 @@ include::partial$component-endpoint-options.adoc[]
|=======================================================================
-== Supported list of smn services and corresponding operations
+=== Supported list of smn services and corresponding operations
[width="100%",cols="50%,50%",options="header",]
|=======================================================================
@@ -97,9 +97,9 @@ include::partial$component-endpoint-options.adoc[]
|=======================================================================
-== Inline Configuration of route
+=== Inline Configuration of route
-=== publishAsTextMessage
+==== publishAsTextMessage
Java DSL
[source,java]
--------------------------------------------------------------------------------
@@ -143,7 +143,7 @@ from("direct:triggerRoute")
.to("hwcloud-smn:publishMessageService?operation=publishAsTemplatedMessage&accessKey=*********&secretKey=********&projectId=9071a38e7f6a4ba7b7bcbeb7d4ea6efc®ion=cn-north-4")
--------------------------------------------------------------------------------
-== Using ServiceKey configuration Bean
+=== Using ServiceKey configuration Bean
Access key and secret keys are required to authenticate against cloud smn
service. You can avoid having them being exposed
and scattered over in your endpoint uri by wrapping them inside a bean of
class ```org.apache.camel.component.huaweicloud.smn.models.ServiceKeys```.
diff --git
a/components/camel-infinispan/camel-infinispan-embedded/src/main/docs/infinispan-embedded-component.adoc
b/components/camel-infinispan/camel-infinispan-embedded/src/main/docs/infinispan-embedded-component.adoc
index 9c158f2b086..a64ede7f9d6 100644
---
a/components/camel-infinispan/camel-infinispan-embedded/src/main/docs/infinispan-embedded-component.adoc
+++
b/components/camel-infinispan/camel-infinispan-embedded/src/main/docs/infinispan-embedded-component.adoc
@@ -69,8 +69,9 @@ include::partial$component-endpoint-options.adoc[]
include::partial$component-endpoint-headers.adoc[]
// component headers: END
+== Usage
-== Camel Operations
+=== Camel Operations
This section lists all available operations, along with their header
information.
.Put Operations
@@ -281,7 +282,7 @@ The instance of `myCustomListener` must exist and Camel
should be able to look i
Users are encouraged to extend the
`org.apache.camel.component.infinispan.embedded.InfinispanEmbeddedCustomListener`
class and annotate the resulting class with `@Listener` which can be found in
the package `org.infinispan.notifications`.
-== Using the Infinispan based idempotent repository
+=== Using the Infinispan based idempotent repository
In this section, we will use the Infinispan based idempotent repository.
@@ -342,7 +343,7 @@ XML::
====
-== Using the Infinispan based aggregation repository
+=== Using the Infinispan based aggregation repository
In this section, we will use the Infinispan based aggregation repository.
diff --git
a/components/camel-infinispan/camel-infinispan/src/main/docs/infinispan-component.adoc
b/components/camel-infinispan/camel-infinispan/src/main/docs/infinispan-component.adoc
index 49bb65098ad..4f9f7d009e7 100644
---
a/components/camel-infinispan/camel-infinispan/src/main/docs/infinispan-component.adoc
+++
b/components/camel-infinispan/camel-infinispan/src/main/docs/infinispan-component.adoc
@@ -55,7 +55,10 @@ include::partial$component-endpoint-options.adoc[]
include::partial$component-endpoint-headers.adoc[]
// component headers: END
-== Camel Operations
+== Usage
+
+=== Camel Operations
+
This section lists all available operations, along with their header
information.
.Put Operations
@@ -272,7 +275,7 @@ The instance of `myCustomListener` must exist and Camel
should be able to look i
Users are encouraged to extend the
`org.apache.camel.component.infinispan.remote.InfinispanRemoteCustomListener`
class and annotate the resulting class with `@ClientListener` which can be
found in the package `org.infinispan.client.hotrod.annotation`.
-== Using the Infinispan based idempotent repository
+=== Using the Infinispan based idempotent repository
In this section, we will use the Infinispan based idempotent repository.
@@ -333,7 +336,7 @@ XML::
====
-== Using the Infinispan based aggregation repository
+=== Using the Infinispan based aggregation repository
In this section, we will use the Infinispan based aggregation repository.
diff --git a/components/camel-irc/src/main/docs/irc-component.adoc
b/components/camel-irc/src/main/docs/irc-component.adoc
index 2a14a08908c..5460af85144 100644
--- a/components/camel-irc/src/main/docs/irc-component.adoc
+++ b/components/camel-irc/src/main/docs/irc-component.adoc
@@ -47,9 +47,11 @@ include::partial$component-endpoint-options.adoc[]
include::partial$component-endpoint-headers.adoc[]
// component headers: END
-== SSL Support
+== Usage
-=== Using the JSSE Configuration Utility
+=== SSL Support
+
+==== Using the JSSE Configuration Utility
The IRC component supports SSL/TLS configuration
through the xref:manual::camel-configuration-utilities.adoc[Camel JSSE
@@ -120,7 +122,9 @@ If you need to provide your own custom trust manager, use
the
ircs:host[:port]/#room?username=user&password=pass&trustManager=#referenceToMyTrustManagerBean
----------------------------------------------------------------------------------------------
-== Using keys
+== Examples
+
+=== Using keys
Some IRC rooms require you to provide a key to be able to join that
channel. The key is just a secret word.
@@ -132,7 +136,7 @@ For example, we join three channels whereas only channel 1
and 3 use a key.
irc:n...@irc.server.org?channels=#chan1,#chan2,#chan3&keys=chan1Key,,chan3key
-----------------------------------------------------------------------------
-== Getting a list of channel users
+=== Getting a list of channel users
Using the `namesOnJoin` option one can invoke the IRC-`NAMES` command after
the component has joined a channel.
The server will reply with `irc.num = 353`. So to process the result the
property `onReply` has to be `true`.
@@ -149,7 +153,7 @@
from("ircs:nick@myserver:1234/#mychannelname?namesOnJoin=true&onReply=true")
.to("mock:result").stop();
-----------------------------------------------------------------------------
-== Sending to a different channel or a person
+=== Sending to a different channel or a person
If you need to send messages to a different channel (or a person) which is not
defined on IRC endpoint, you can specify a different destination in a message
header.
diff --git a/components/camel-ironmq/src/main/docs/ironmq-component.adoc
b/components/camel-ironmq/src/main/docs/ironmq-component.adoc
index 78775896f4a..18c73352e20 100644
--- a/components/camel-ironmq/src/main/docs/ironmq-component.adoc
+++ b/components/camel-ironmq/src/main/docs/ironmq-component.adoc
@@ -59,12 +59,16 @@ include::partial$component-endpoint-options.adoc[]
include::partial$component-endpoint-headers.adoc[]
// component headers: END
-== Message Body
+== Usage
+
+=== Message Body
It should be either a String or an array of Strings.
In the latter case, the batch of strings will be sent to IronMQ as one
request, creating one message per element in the array.
-== Consumer example
+== Examples
+
+=== Consumer example
Consume 50 messages per poll from the queue `testqueue` on aws eu, and save
the messages to files.
@@ -74,7 +78,8 @@
from("ironmq:testqueue?ironMQCloud=https://mq-aws-eu-west-1-1.iron.io&projectId=
.to("file:somefolder");
--------------------------------------------------
-== Producer example
+=== Producer example
+
Dequeue from activemq jms and enqueue the messages on IronMQ.
[source,java]
diff --git
a/components/camel-jackson-avro/src/main/docs/avroJackson-dataformat.adoc
b/components/camel-jackson-avro/src/main/docs/avroJackson-dataformat.adoc
index 28eea1c57f5..8934ea86ed2 100644
--- a/components/camel-jackson-avro/src/main/docs/avroJackson-dataformat.adoc
+++ b/components/camel-jackson-avro/src/main/docs/avroJackson-dataformat.adoc
@@ -30,22 +30,23 @@ from("kafka:topic").
to("log:info");
-------------------------------
-== Configuring the `SchemaResolver`
-
-Since Avro serialization is schema-based, this data format requires that you
provide a SchemaResolver object
-that is able to look up the schema for each exchange that is going to be
marshalled/unmarshalled.
-
-You can add a single SchemaResolver to the registry, and it will be looked up
automatically.
-Or you can explicitly specify the reference to a custom SchemaResolver.
-
== Avro Jackson Options
// dataformat options: START
include::partial$dataformat-options.adoc[]
// dataformat options: END
+== Usage
+
+=== Configuring the `SchemaResolver`
+
+Since Avro serialization is schema-based, this data format requires that you
provide a SchemaResolver object
+that is able to look up the schema for each exchange that is going to be
marshalled/unmarshalled.
+
+You can add a single SchemaResolver to the registry, and it will be looked up
automatically.
+Or you can explicitly specify the reference to a custom SchemaResolver.
-== Using custom AvroMapper
+=== Using custom AvroMapper
You can configure `JacksonAvroDataFormat` to use a custom `AvroMapper` in case
you need more control of the mapping configuration.
diff --git
a/components/camel-jackson-protobuf/src/main/docs/protobufJackson-dataformat.adoc
b/components/camel-jackson-protobuf/src/main/docs/protobufJackson-dataformat.adoc
index 4ccce5e5a20..c6e1ff5969f 100644
---
a/components/camel-jackson-protobuf/src/main/docs/protobufJackson-dataformat.adoc
+++
b/components/camel-jackson-protobuf/src/main/docs/protobufJackson-dataformat.adoc
@@ -30,22 +30,23 @@ from("kafka:topic").
to("log:info");
-------------------------------
-== Configuring the `SchemaResolver`
-
-Since Protobuf serialization is schema-based, this data format requires that
you provide a SchemaResolver object
-that is able to look up the schema for each exchange that is going to be
marshalled/unmarshalled.
-
-You can add a single SchemaResolver to the registry, and it will be looked up
automatically.
-Or you can explicitly specify the reference to a custom SchemaResolver.
-
== Protobuf Jackson Options
// dataformat options: START
include::partial$dataformat-options.adoc[]
// dataformat options: END
+== Usage
+
+=== Configuring the `SchemaResolver`
+
+Since Protobuf serialization is schema-based, this data format requires that
you provide a SchemaResolver object
+that is able to look up the schema for each exchange that is going to be
marshalled/unmarshalled.
+
+You can add a single SchemaResolver to the registry, and it will be looked up
automatically.
+Or you can explicitly specify the reference to a custom SchemaResolver.
-== Using custom ProtobufMapper
+=== Using custom ProtobufMapper
You can configure `JacksonProtobufDataFormat` to use a custom `ProtobufMapper`
in case you need more control of the mapping configuration.
diff --git a/components/camel-jackson/src/main/docs/jackson-dataformat.adoc
b/components/camel-jackson/src/main/docs/jackson-dataformat.adoc
index 90609aa5020..e8815fe4d6e 100644
--- a/components/camel-jackson/src/main/docs/jackson-dataformat.adoc
+++ b/components/camel-jackson/src/main/docs/jackson-dataformat.adoc
@@ -29,7 +29,9 @@ from("activemq:My.Queue").
include::partial$dataformat-options.adoc[]
// dataformat options: END
-== Using custom ObjectMapper
+== Usage
+
+=== Using custom ObjectMapper
You can configure `JacksonDataFormat` to use a custom `ObjectMapper` in case
you need more control of the mapping configuration.
@@ -38,14 +40,14 @@ For example, if you use Spring Boot, then Spring Boot can
provide a default `Obj
And this would allow Camel to detect that there is one bean of `ObjectMapper`
class type in the Spring Boot bean registry
and then use it. When this happens you should set a `INFO` logging from Camel.
-== Using Jackson for automatic type conversion
+=== Using Jackson for automatic type conversion
The `camel-jackson` module allows integrating Jackson as a
xref:manual::type-converter.adoc[Type Converter].
-This gives a set of out of the box converters to/from the Jackson type
`JSonNode`, such as converting
+This gives a set of out-of-the-box converters to/from the Jackson type
`JSonNode`, such as converting
from `JSonNode` to `String` or vice versa.
-=== Enabling more type converters and support for POJOs
+==== Enabling more type converters and support for POJOs
To enable POJO conversion support for `camel-jackson` then this must be
enabled,
which is done by setting the following options on the `CamelContext` global
options, as shown:
diff --git
a/components/camel-jacksonxml/src/main/docs/jacksonXml-dataformat.adoc
b/components/camel-jacksonxml/src/main/docs/jacksonXml-dataformat.adoc
index 2a8c1894d86..0c753ed98b1 100644
--- a/components/camel-jacksonxml/src/main/docs/jacksonXml-dataformat.adoc
+++ b/components/camel-jacksonxml/src/main/docs/jacksonXml-dataformat.adoc
@@ -47,6 +47,7 @@ from("activemq:My.Queue").
include::partial$dataformat-options.adoc[]
// dataformat options: END
+== Usage
=== Using Jackson XML in Spring DSL
@@ -73,7 +74,7 @@ And then you can refer to this id in the route:
</route>
-------------------------------------
-== Excluding POJO fields from marshalling
+=== Excluding POJO fields from marshalling
When marshalling a POJO to XML, you might want to exclude certain fields
from the XML output. With Jackson, you can
@@ -93,7 +94,7 @@ Note that the weight field is missing in the resulting XML:
<pojo age="30" weight="70"/>
----------------------------
-== Include/Exclude fields using the `jsonView` attribute with
``JacksonXML``DataFormat
+=== Include/Exclude fields using the `jsonView` attribute with
``JacksonXML``DataFormat
As an example of using this attribute, you can instead of:
@@ -126,7 +127,7 @@ And the same in XML DSL:
</route>
---------------------------------------------------------------------------------------------------------------------------------------------------
-== Setting serialization include option
+=== Setting serialization include option
If you want to marshal a POJO to XML, and the POJO has some fields with
null values. And you want to skip these null values, then you need to
@@ -159,7 +160,7 @@ Or from XML DSL you configure this as
</dataFormats>
------------------------------------------------------
-== Unmarshalling from XML to POJO with dynamic class name
+=== Unmarshalling from XML to POJO with dynamic class name
If you use Jackson to unmarshal XML to POJO, then you can now specify a
header in the message that indicates which class name to unmarshal to.
@@ -186,7 +187,7 @@ Or from XML DSL you configure this as:
</dataFormats>
-------------------------------------------------------
-== Unmarshalling from XML to `List<Map>` or `List<POJO>`
+=== Unmarshalling from XML to `List<Map>` or `List<POJO>`
If you are using Jackson to unmarshal XML to a list of map/POJO, you can
now specify this by setting `useList="true"` or use
@@ -222,7 +223,7 @@ And you can specify the POJO type also
</dataFormats>
-------------------------------------------------------------------------------
-== Using custom Jackson modules
+=== Using custom Jackson modules
You can use custom Jackson modules by specifying the class names of
those using the moduleClassNames option as shown below.
@@ -253,7 +254,7 @@ to the module as shown below:
Multiple modules can be specified separated by comma, such as
`moduleRefs="myJacksonModule,myOtherModule"`.
-== Enabling or disable features using Jackson
+=== Enabling or disable features using Jackson
Jackson XML has a number of features you can enable or disable, which its
XmlMapper uses.
@@ -288,7 +289,7 @@
df.disableFeature(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES);
df.disableFeature(DeserializationFeature.FAIL_ON_NULL_FOR_PRIMITIVES);
----------------------------------------------------------------------
-== Converting Maps to POJO using Jackson
+=== Converting Maps to POJO using Jackson
Jackson `XmlMapper` can be used to convert maps to POJO objects.
Jackson component comes with the data converter that can be used to
@@ -309,7 +310,7 @@ If there is a single `XmlMapper` instance available in the
Camel
registry, it will be used by the converter to perform the conversion.
Otherwise, the default mapper will be used.
-== Formatted XML marshalling (pretty-printing)
+=== Formatted XML marshalling (pretty-printing)
Using the `prettyPrint` option one can output a well-formatted XML while
marshalling:
diff --git a/components/camel-jaxb/src/main/docs/jaxb-dataformat.adoc
b/components/camel-jaxb/src/main/docs/jaxb-dataformat.adoc
index 19d36c6f17d..aed39ed82b6 100644
--- a/components/camel-jaxb/src/main/docs/jaxb-dataformat.adoc
+++ b/components/camel-jaxb/src/main/docs/jaxb-dataformat.adoc
@@ -20,8 +20,9 @@ payload into Java objects or to marshal Java objects into an
XML payload.
include::partial$dataformat-options.adoc[]
// dataformat options: END
+== Usage
-== Using the Java DSL
+=== Using the Java DSL
The following example uses a named DataFormat of `jaxb` which is
configured with a Java package name to initialize the
@@ -47,7 +48,7 @@ from("activemq:My.Queue").
to("mqseries:Another.Queue");
-------------------------------
-== Using Spring XML
+=== Using Spring XML
The following example shows how to configure the `JaxbDataFormat` and use it
in multiple routes.
@@ -78,13 +79,13 @@ The following example shows how to configure the
`JaxbDataFormat` and use it in
</beans>
-------------------------------
-== Multiple context paths
+=== Multiple context paths
It is possible to use this data format with more than one context path.
You can specify multiple context paths using `:` as a separator, for example
`com.mycompany:com.mycompany2`.
-== Partial marshalling / unmarshalling
+=== Partial marshalling / unmarshalling
JAXB 2 supports marshalling and unmarshalling XML tree fragments. By
default, JAXB looks for the `@XmlRootElement` annotation on a given class to
@@ -113,13 +114,13 @@ note that you need to specify its value in the format
`\{namespaceUri\}localPart
.setHeader(JaxbConstants.JAXB_PART_NAMESPACE,
constant("{http://www.camel.apache.org/jaxb/example/address/1}address";));
--------------------------------------------------------------------------------------
-== Fragment
+=== Fragment
`JaxbDataFormat` has a property named `fragment` which can set the
`Marshaller.JAXB_FRAGMENT`
property on the JAXB Marshaller. If you don't want the JAXB Marshaller to
generate
the XML declaration, you can set this option to be `true`. The default value
of this property is `false`.
-== Ignoring Non-XML Characters
+=== Ignoring Non-XML Characters
`JaxbDataFormat` supports ignoring
https://www.w3.org/TR/xml/#NT-Char[Non-XML Characters],
@@ -159,7 +160,7 @@ Camel's non-XML filtering:
<jaxb filterNonXmlChars="true" contextPath="org.apache.camel.foo.bar"
xmlStreamWriterWrapper="#testXmlStreamWriterWrapper" />
------------------------------------------------------------------------------------------------------------------------------
-== Working with the `ObjectFactory`
+=== Working with the `ObjectFactory`
If you use XJC to create the java class from the schema, you will get an
`ObjectFactory` for your JAXB context. Since the `ObjectFactory` uses
@@ -173,7 +174,7 @@ If you want to get the `JAXBElement` object form the
unmarshaled message
body, you need to set the `JaxbDataFormat` `ignoreJAXBElement`
property to be `false`.
-== Setting the encoding
+=== Setting the encoding
You can set the `encoding` option on the `JaxbDataFormat` to configure the
`Marshaller.JAXB_ENCODING` encoding property on the JAXB Marshaller.
@@ -181,7 +182,7 @@ You can set the `encoding` option on the `JaxbDataFormat`
to configure the
You can set up which encoding to use when you declare the `JaxbDataFormat`.
You can also provide the encoding in the
Exchange property `Exchange.CHARSET_NAME`. This property will override the
encoding set on the `JaxbDataFormat`.
-== Controlling namespace prefix mapping
+=== Controlling namespace prefix mapping
When marshalling using xref:jaxb-dataformat.adoc[JAXB] or
xref:jaxb-dataformat.adoc[SOAP] then
the JAXB implementation will automatically assign namespace prefixes, such
@@ -213,7 +214,7 @@ with the id `myMap`, which was what we defined above.
</marshal>
----------------------------------------------------------------------------------------
-== Schema validation
+=== Schema validation
The `JaxbDataFormat` supports validation by
marshalling and unmarshalling from / to XML. You can use the prefix
@@ -243,7 +244,7 @@ You can do the same using the XML DSL:
</marshal>
-------------------------------------------------------------------------
-== Schema Location
+=== Schema Location
The `JaxbDataFormat` supports to specify the `SchemaLocation` when marshalling
the XML.
@@ -265,7 +266,7 @@ You can do the same using the XML DSL:
</marshal>
--------------------------------------------------------
-== Marshal data that is already XML
+=== Marshal data that is already XML
The JAXB marshaller requires that the message body is JAXB compatible,
e.g., it is a `JAXBElement`, a java instance that has JAXB annotations, or
diff --git a/components/camel-jcache/src/main/docs/jcache-component.adoc
b/components/camel-jcache/src/main/docs/jcache-component.adoc
index 659287e93c5..000b740d872 100644
--- a/components/camel-jcache/src/main/docs/jcache-component.adoc
+++ b/components/camel-jcache/src/main/docs/jcache-component.adoc
@@ -38,7 +38,9 @@ include::partial$component-endpoint-options.adoc[]
include::partial$component-endpoint-headers.adoc[]
// component headers: END
-== JCache Policy
+== Usage
+
+=== JCache Policy
The JCachePolicy is an interceptor around a route that caches the "result of
the route" (the message body) after the route is completed.
If the next time the route is called with a "similar" Exchange, the cached
value is used on the Exchange instead of executing the route.
@@ -60,7 +62,7 @@ based on the other parameters set.
Similar caching solution is available, for example, in Spring using the
@Cacheable annotation.
-== JCachePolicy Fields
+=== JCachePolicy Fields
[width="100%",cols="2,5,3,2",options="header"]
|===
@@ -73,9 +75,9 @@ Similar caching solution is available, for example, in Spring
using the @Cacheab
| *enabled* | If the policy is not enabled, no wrapper processor is added to
the route. It has impact only during startup, not during runtime. For example,
it can be used to disable caching from properties. | true | boolean
|===
-== How to determine cache to use?
+=== How to determine cache to use?
-== Set cache
+=== Set cache
The cache used by the policy can be set directly. This means you have to
configure the cache yourself and get a JCache Cache object,
but this gives the most flexibility. For example, it can be setup in the
config xml of the cache provider (Hazelcast, EhCache, ...)
@@ -98,7 +100,7 @@ from("direct:get-orders")
.bean(OrderService.class,"findOrderById(${body})");
----------------------------
-== Set cacheManager
+=== Set cacheManager
If the `cache` is not set, the policy will try to look up or create the cache
automatically.
If the `cacheManager` is set on the policy, it will try to get cache with the
set `cacheName` (routeId by default) from the CacheManager.
@@ -117,7 +119,7 @@ jcachePolicy.setCacheManager(cacheManager);
jcachePolicy.setCacheName("items")
----------------------------
-== Find cacheManager
+=== Find cacheManager
If `cacheManager` (and the `cache`) is not set, the policy will try to find a
JCache CacheManager object:
@@ -133,7 +135,7 @@ from("direct:get-orders").routeId("getorders")
.bean(OrderService.class,"findOrderById(${body})");
----------------------------
-== Partially wrapped route
+=== Partially wrapped route
In the examples above, the whole route was executed or skipped.
A policy can be used to wrap only a segment of the route instead of all
processors.
@@ -151,7 +153,7 @@ from("direct:get-orders")
The `.log()` at the beginning and at the end of the route is always called,
but the section inside `.policy()` and `.end()` is executed based on the cache.
-== KeyExpression
+=== KeyExpression
By default, the policy uses the received Exchange body as the _key_, so the
default expression is like `simple("$\{body\}")`.
We can set a different Camel Expression as `keyExpression` which will be
evaluated to determine the key.
@@ -179,15 +181,15 @@ from("direct:get-orders")
.bean(OrderService.class,"findOrderById(${header.orderId})");
----------------------------
-== BypassExpression
+=== BypassExpression
The `JCachePolicy` can be configured with an `Expression` that can per
`Exchange` determine whether
to look up the value from the cache or bypass. If the expression is evaluated
to `false` then the route
is executed as normal, and the returned value is inserted into the cache for
future lookup.
-== Camel XML DSL examples
+=== Camel XML DSL examples
-== Use JCachePolicy in an XML route
+=== Use JCachePolicy in an XML route
In Camel XML DSL, we need a named reference to the JCachePolicy instance
(registered in CamelContext or simply in Spring).
We have to wrap the route between `<policy>...</policy>` tags after `<from>`.
@@ -226,7 +228,7 @@ See this example when only a part of the route is wrapped:
----------------------------
-== Define CachePolicy in Spring
+=== Define CachePolicy in Spring
It's more convenient to create a JCachePolicy in Java, especially within a
RouteBuilder using the Camel DSL expressions,
but see this example to define it in a Spring XML:
@@ -243,7 +245,7 @@ but see this example to define it in a Spring XML:
</bean>
----------------------------
-== Create Cache from XML
+=== Create Cache from XML
It's not strictly speaking related to Camel XML DSL, but JCache providers
usually have a way to configure the cache in an XML file.
For example with Hazelcast, you can add a `hazelcast.xml` to classpath to
configure the cache "spring" used in the example above.
@@ -265,7 +267,7 @@ For example with Hazelcast, you can add a `hazelcast.xml`
to classpath to config
</hazelcast>
----------------------------
-== Special scenarios and error handling
+=== Special scenarios and error handling
If the Cache used by the policy is closed (can be done dynamically), the whole
caching functionality is skipped,
the route will be executed every time.
diff --git a/components/camel-jetty/src/main/docs/jetty-component.adoc
b/components/camel-jetty/src/main/docs/jetty-component.adoc
index c106e385f9e..d34a8b87965 100644
--- a/components/camel-jetty/src/main/docs/jetty-component.adoc
+++ b/components/camel-jetty/src/main/docs/jetty-component.adoc
@@ -85,7 +85,7 @@ include::partial$component-endpoint-headers.adoc[]
The Jetty component supports consumer endpoints.
-== Consumer Example
+=== Consumer
In this sample we define a route that exposes an HTTP service at
`\http://localhost:8080/myapp/myservice`:
@@ -107,13 +107,13 @@ To listen across an entire URI prefix, see
xref:manual:faq:how-do-i-let-jetty-match-wildcards.adoc[How do I let Jetty
match wildcards].
====
-== Servlets
+=== Servlets
If you actually want to expose routes by HTTP and already have a
Servlet, you should instead refer to the
xref:servlet-component.adoc[Servlet Transport].
-== HTTP Request Parameters
+=== HTTP Request Parameters
So if a client sends the HTTP request, `\http://serverUri?one=hello`, the
Jetty component will copy the HTTP request parameter, `one` to the
@@ -124,7 +124,7 @@ xref:languages:simple-language.adoc[Simple] (such as
xref:languages:ognl-languag
we could also test for the parameter value and do routing based on the
header value as well.
-== Session Support
+=== Session Support
The session support option, `sessionSupport`, can be used to enable a
`HttpSession` object and access the session object while processing the
@@ -157,7 +157,7 @@ public void process(Exchange exchange) throws Exception {
}
----
-== SSL Support (HTTPS)
+=== SSL Support (HTTPS)
[[Jetty-UsingtheJSSEConfigurationUtility]]
Using the JSSE Configuration Utility
@@ -300,7 +300,7 @@ client doesn't need a certificate but can have one.
The value you use as keys in the above map is the port you configure
Jetty to listen to.
-=== Configuring general SSL properties
+==== Configuring general SSL properties
Instead of a per-port number specific SSL socket connector (as shown
above), you can now configure general properties that apply for all
@@ -322,7 +322,7 @@ the port number as entry).
</bean>
----
-=== How to obtain reference to the X509Certificate
+==== How to obtain reference to the X509Certificate
Jetty stores a reference to the certificate in the HttpServletRequest
which you can access from code as follows:
@@ -333,7 +333,7 @@ HttpServletRequest req =
exchange.getIn().getBody(HttpServletRequest.class);
X509Certificate cert = (X509Certificate)
req.getAttribute("javax.servlet.request.X509Certificate")
----
-=== Configuring general HTTP properties
+==== Configuring general HTTP properties
Instead of a per-port number specific HTTP socket connector (as shown
above), you can now configure general properties that apply for all
@@ -352,7 +352,7 @@ the port number as entry).
</bean>
----
-=== Obtaining X-Forwarded-For header with HttpServletRequest.getRemoteAddr()
+==== Obtaining X-Forwarded-For header with HttpServletRequest.getRemoteAddr()
If the HTTP requests are handled by an Apache server and forwarded to
jetty with mod_proxy, the original client IP address is in the
@@ -384,7 +384,7 @@ This is particularly useful when an existing Apache server
handles TLS
connections for a domain and proxies them to application servers
internally.
-== Default behavior for returning HTTP status codes
+=== Default behavior for returning HTTP status codes
The default behavior of HTTP status codes is defined by the
`org.apache.camel.component.http.DefaultHttpBinding` class, which
@@ -397,7 +397,7 @@ returned, and the stacktrace is returned in the body. If
you want to
specify which HTTP status code to return, set the code in the
`Exchange.HTTP_RESPONSE_CODE` header of the OUT message.
-== Customizing HttpBinding
+=== Customizing HttpBinding
By default, Camel uses the
`org.apache.camel.component.http.DefaultHttpBinding` to handle how a
@@ -426,7 +426,7 @@ And then we can reference this binding when we define the
route:
</route>
----
-== Jetty handlers and security configuration
+=== Jetty handlers and security configuration
You can configure a list of Jetty handlers on the endpoint, which can be
useful for enabling advanced Jetty security features. These handlers are
@@ -556,7 +556,7 @@ http://0.0.0.0/path
It is now secured with basic authentication. Only `username1` with `password1`
and `username2` with `password2` are able to access the endpoint.
-== How to return a custom HTTP 500 reply message
+=== How to return a custom HTTP 500 reply message
You may want to return a custom reply message when something goes wrong,
instead of the default reply message Camel xref:jetty-component.adoc[Jetty]
@@ -567,7 +567,7 @@ Exception Clause to construct the custom
reply message. For example, as show here, where we return
`Dude something went wrong` with HTTP error code 500:
-== Multipart Form support
+=== Multipart Form support
The camel-jetty component supports multipart form post out of the box.
The submitted form-data are mapped into the message header. Camel Jetty
@@ -575,7 +575,7 @@ creates an attachment for each uploaded file. The file name
is mapped to
the name of the attachment. The content type is set as the content type
of the attachment file name. You can find the example here.
-== Jetty JMX support
+=== Jetty JMX support
The camel-jetty component supports the enabling of Jetty's JMX
capabilities at the component and endpoint level with the endpoint
