You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by da...@apache.org on 2017/01/11 18:27:16 UTC
[11/14] camel git commit: Use single line header for adoc files
http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-box/src/main/docs/box-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-box/src/main/docs/box-component.adoc b/components/camel-box/src/main/docs/box-component.adoc
index aaa4c04..ce82195 100644
--- a/components/camel-box/src/main/docs/box-component.adoc
+++ b/components/camel-box/src/main/docs/box-component.adoc
@@ -1,4 +1,4 @@
-# Box Component
+## Box Component
*Available as of Camel 2.14*
@@ -31,9 +31,7 @@ for this component:
</dependency>
-------------------------------------------
-[[Box-Options]]
-Box Options
-^^^^^^^^^^^
+### Box Options
@@ -93,9 +91,7 @@ The Box component supports 21 endpoint options which are listed below:
-[[Box-URIformat]]
-URI format
-^^^^^^^^^^
+### URI format
[source,java]
--------------------------------------------
@@ -118,9 +114,7 @@ Endpoint prefix can be one of:
* shared-items
* users
-[[Box-BoxComponent.1]]
-BoxComponent
-^^^^^^^^^^^^
+### BoxComponent
The Box Component can be configured with the options below. These
options can be provided using the component's bean
@@ -172,9 +166,7 @@ sharedLink
returns null on first call
|=======================================================================
-[[Box-ProducerEndpoints:]]
-Producer Endpoints:
-^^^^^^^^^^^^^^^^^^^
+### Producer Endpoints:
Producer endpoints can use endpoint prefixes followed by endpoint names
and associated options described next. A shorthand alias can be used for
@@ -202,9 +194,7 @@ RuntimeCamelException with a
*com.box.restclientv2.exceptions.BoxSDKException*�derived exception
cause.
-[[Box-EndpointPrefixcollaborations]]
-Endpoint Prefix�_collaborations_
-++++++++++++++++++++++++++++++++
+#### Endpoint Prefix�_collaborations_
For more information on Box collaborations see
https://developers.box.com/docs/#collaborations[https://developers.box.com/docs/#collaborations].�The
@@ -250,9 +240,7 @@ URI Options for�_collaborations_
|getAllCollabsRequest |com.box.boxjavalibv2.requests.requestobjects.BoxGetAllCollabsRequestObject
|=======================================================================
-[[Box-EndpointPrefixevents]]
-Endpoint Prefix�_events_
-++++++++++++++++++++++++
+#### Endpoint Prefix�_events_
For more information on Box events see
https://developers.box.com/docs/#events[https://developers.box.com/docs/#events].
@@ -287,9 +275,7 @@ URI Options for�_events_
|eventRequest |com.box.boxjavalibv2.requests.requestobjects.BoxEventRequestObject
|=======================================================================
-[[Box-EndpointPrefixgroups]]
-Endpoint Prefix�_groups_
-++++++++++++++++++++++++
+#### Endpoint Prefix�_groups_
For more information on Box groups see
https://developers.box.com/docs/#groups[https://developers.box.com/docs/#groups].
@@ -351,9 +337,7 @@ URI Options for�_groups_
|=======================================================================
-[[Box-EndpointPrefixsearch]]
-Endpoint Prefix�_search_
-++++++++++++++++++++++++
+#### Endpoint Prefix�_search_
For more information on Box search API see
https://developers.box.com/docs/#search[https://developers.box.com/docs/#search].�The
@@ -384,9 +368,7 @@ URI Options for�_search_
|searchQuery |String
|=======================================================================
-[[Box-EndpointPrefixcommentsandshared-comments]]
-Endpoint Prefix _comments_ and�_shared-comments_
-++++++++++++++++++++++++++++++++++++++++++++++++
+#### Endpoint Prefix _comments_ and�_shared-comments_
For more information on Box comments see
https://developers.box.com/docs/#comments[https://developers.box.com/docs/#comments].
@@ -433,9 +415,7 @@ URI Options for _comments_ and�_shared-comments_
|message |String
|=======================================================================
-[[Box-EndpointPrefixfilesandshared-files]]
-Endpoint Prefix�_files_ and�_shared-files_
-++++++++++++++++++++++++++++++++++++++++++
+#### Endpoint Prefix�_files_ and�_shared-files_
For more information on Box files see
https://developers.box.com/docs/#files[https://developers.box.com/docs/#files].
@@ -512,9 +492,7 @@ URI Options for _files_ and�_shared-files_
|sharedLinkRequest |com.box.boxjavalibv2.requests.requestobjects.BoxSharedLinkRequestObject
|=======================================================================
-[[Box-EndpointPrefixfoldersandshared-folders]]
-Endpoint Prefix _folders_ and�_shared-folders_
-++++++++++++++++++++++++++++++++++++++++++++++
+#### Endpoint Prefix _folders_ and�_shared-folders_
For more information on Box folders see
https://developers.box.com/docs/#folders[https://developers.box.com/docs/#folders].
@@ -571,9 +549,7 @@ URI Options for _folders_ or�_shared-folders_
|sharedLinkRequest |com.box.boxjavalibv2.requests.requestobjects.BoxSharedLinkRequestObject
|=======================================================================
-[[Box-EndpointPrefixshared-items]]
-Endpoint Prefix�_shared-items_
-++++++++++++++++++++++++++++++
+#### Endpoint Prefix�_shared-items_
For more information on Box shared items see
https://developers.box.com/docs/#shared-items[https://developers.box.com/docs/#shared-items].
@@ -602,9 +578,7 @@ URI Options for�_shared-items_
|defaultRequest |com.box.restclientv2.requestsbase.BoxDefaultRequestObject
|=======================================================================
-[[Box-EndpointPrefixusers]]
-Endpoint Prefix�_users_
-+++++++++++++++++++++++
+#### Endpoint Prefix�_users_
For information on Box users see
https://developers.box.com/docs/#users[https://developers.box.com/docs/#users].
@@ -669,9 +643,7 @@ URI Options for�_users_
|userUpdateLoginRequest |com.box.boxjavalibv2.requests.requestobjects.BoxUserUpdateLoginRequestObject
|=======================================================================
-[[Box-ConsumerEndpoints:]]
-Consumer Endpoints:
-^^^^^^^^^^^^^^^^^^^
+### Consumer Endpoints:
For more information on Box events see
https://developers.box.com/docs/#events[https://developers.box.com/docs/#events]�and
@@ -714,24 +686,18 @@ URI Options for�_poll-events_
|splitResult |boolean
|=======================================================================
-[[Box-Messageheader]]
-Message header
-^^^^^^^^^^^^^^
+### Message header
Any of the options�can be provided in a message header for producer
endpoints with *CamelBox.* prefix.
-[[Box-Messagebody]]
-Message body
-^^^^^^^^^^^^
+### Message body
All result message bodies utilize objects provided by the Box Java SDK.
Producer endpoints can specify the option name for incoming message body
in the *inBody* endpoint parameter.
-[[Box-TypeConverter]]
-Type Converter
-^^^^^^^^^^^^^^
+### Type Converter
The Box component also provides a Camel type converter to convert
http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/component/file/GenericFile.html[GenericFile]
@@ -742,9 +708,7 @@ specified in the exchange property�*CamelBox.folderId*. If the exchange
property is not specified the value defaults to *"**0"* for the root
folder ID.�
-[[Box-Usecases]]
-Use cases
-^^^^^^^^^
+### Use cases
The following route uploads new files to the user's root folder:
@@ -772,4 +736,4 @@ The following route uses a producer with dynamic header options.�The
.setHeader("CamelBox.fileId", header("fileId"))
.to("box://files/download")
.to("file://...");
--------------------------------------------------------
+-------------------------------------------------------
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-braintree/src/main/docs/braintree-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-braintree/src/main/docs/braintree-component.adoc b/components/camel-braintree/src/main/docs/braintree-component.adoc
index 0abfc9a..3e5b994 100644
--- a/components/camel-braintree/src/main/docs/braintree-component.adoc
+++ b/components/camel-braintree/src/main/docs/braintree-component.adoc
@@ -1,4 +1,4 @@
-# Braintree Component
+## Braintree Component
*Available as of Camel 2.17*
@@ -29,9 +29,7 @@ for this component:
�
-[[Braintree-Options]]
-Braintree Options
-^^^^^^^^^^^^^^^^^
+### Braintree Options
@@ -81,9 +79,7 @@ The Braintree component supports 15 endpoint options which are listed below:
// endpoint options: END
-[[Braintree-URIformat]]
-URI format
-^^^^^^^^^^
+### URI format
�
@@ -113,9 +109,7 @@ Endpoint prefix can be one of:
�
-[[Braintree-BraintreeComponent.1]]
-BraintreeComponent
-^^^^^^^^^^^^^^^^^^
+### BraintreeComponent
The Braintree Component can be configured with the options below. These
options can be provided using the component's bean
@@ -139,9 +133,7 @@ shared \u2013 even with us!
All the options above are provided by Braintree Payments
-[[Braintree-ProducerEndpoints:]]
-Producer Endpoints:
-^^^^^^^^^^^^^^^^^^^
+### Producer Endpoints:
Producer endpoints can use endpoint prefixes followed by endpoint names
and associated options described next. A shorthand alias can be used for
@@ -165,9 +157,7 @@ at�https://developers.braintreepayments.com/reference/overview[https://develope
�
-[[Braintree-EndpointprefixaddOn]]
-Endpoint prefix�_addOn_
-+++++++++++++++++++++++
+#### Endpoint prefix�_addOn_
The following endpoints can be invoked with the prefix�*addOn*�as
follows:
@@ -185,9 +175,7 @@ braintree://addOn/endpoint
|all |� |� |List<com.braintreegateway.Addon>
|====================================================
-[[Braintree-Endpointprefixaddress]]
-Endpoint prefix�_address_
-+++++++++++++++++++++++++
+#### Endpoint prefix�_address_
The following endpoints can be invoked with the prefix�*address*�as
follows:
@@ -225,9 +213,7 @@ URI Options for�_address_
|id |String
|============================================
-[[Braintree-EndpointprefixclientToken]]
-Endpoint prefix�_clientToken_
-+++++++++++++++++++++++++++++
+#### Endpoint prefix�_clientToken_
The following endpoints can be invoked with the prefix�*clientToken*�as
follows:
@@ -254,9 +240,7 @@ URI Options for�_clientToken_
|request |com.braintreegateway.ClientTokenrequest
|================================================
-[[Braintree-EndpointprefixcreditCardVerification]]
-Endpoint prefix�_creditCardVerification_
-++++++++++++++++++++++++++++++++++++++++
+#### Endpoint prefix�_creditCardVerification_
The following endpoints can be invoked with the
prefix�*creditCardverification*�as follows:
@@ -287,9 +271,7 @@ URI Options for�_creditCardVerification_
|query |com.braintreegateway.CreditCardVerificationSearchRequest
|===============================================================
-[[Braintree-Endpointprefixcustomer]]
-Endpoint prefix�_customer_
-++++++++++++++++++++++++++
+#### Endpoint prefix�_customer_
The following endpoints can be invoked with the prefix�*customer*�as
follows:
@@ -332,9 +314,7 @@ URI Options for�_customer_
|query |com.braintreegateway.CustomerSearchRequest
|=================================================
-[[Braintree-Endpointprefixdiscount]]
-Endpoint prefix�_discount_
-++++++++++++++++++++++++++
+#### Endpoint prefix�_discount_
The following endpoints can be invoked with the prefix�*discount*�as
follows:
@@ -356,9 +336,7 @@ braintree://discount/endpoint
+
-[[Braintree-EndpointprefixmerchantAccount]]
-Endpoint prefix�_merchantAccount_
-+++++++++++++++++++++++++++++++++
+#### Endpoint prefix�_merchantAccount_
The following endpoints can be invoked with the
prefix�*merchantAccount*�as follows:
@@ -392,9 +370,7 @@ URI Options for�_merchantAccount_
|request |com.braintreegateway.MerchantAccountRequest
|====================================================
-[[Braintree-EndpointprefixpaymentMethod]]
-Endpoint prefix�_paymentMethod_
-+++++++++++++++++++++++++++++++
+#### Endpoint prefix�_paymentMethod_
The following endpoints can be invoked with the
prefix�*paymentMethod*�as follows:
@@ -431,9 +407,7 @@ URI Options for�_paymentMethod_
|request |com.braintreegateway.PaymentMethodRequest
|==================================================
-[[Braintree-EndpointprefixpaymentMethodNonce]]
-Endpoint prefix�_paymentMethodNonce_
-++++++++++++++++++++++++++++++++++++
+#### Endpoint prefix�_paymentMethodNonce_
The following endpoints can be invoked with the
prefix�*paymentMethodNonce*�as follows:
@@ -464,9 +438,7 @@ URI Options for�_paymentMethodNonce_
|paymentMethodNonce |String
|==========================
-[[Braintree-Endpointprefixplan]]
-Endpoint prefix�_plan_
-++++++++++++++++++++++
+#### Endpoint prefix�_plan_
The following endpoints can be invoked with the prefix�*plan*�as
follows:
@@ -486,9 +458,7 @@ braintree://plan/endpoint
�
-[[Braintree-EndpointprefixsettlementBatchSummary]]
-Endpoint prefix�_settlementBatchSummary_
-++++++++++++++++++++++++++++++++++++++++
+#### Endpoint prefix�_settlementBatchSummary_
The following endpoints can be invoked with the
prefix�*settlementBatchSummary*�as follows:
@@ -517,9 +487,7 @@ URI Options for�_settlementBatchSummary_
|groupByCustomField |String
|==========================
-[[Braintree-Endpointprefixsubscription]]
-Endpoint prefix�_subscription_
-++++++++++++++++++++++++++++++
+#### Endpoint prefix�_subscription_
The following endpoints can be invoked with the prefix�*subscription*�as
follows:
@@ -571,9 +539,7 @@ URI Options for�_subscription_
�
-[[Braintree-Endpointprefixtransaction]]
-Endpoint prefix�_transaction_
-+++++++++++++++++++++++++++++
+#### Endpoint prefix�_transaction_
The following endpoints can be invoked with the prefix�*transaction*�as
follows:
@@ -637,9 +603,7 @@ URI Options for�_transaction_
|query |com.braintreegateway.TransactionSearchRequest
|==========================================================
-[[Braintree-EndpointprefixwebhookNotification]]
-Endpoint prefix�_webhookNotification_
-+++++++++++++++++++++++++++++++++++++
+#### Endpoint prefix�_webhookNotification_
The following endpoints can be invoked with the
prefix�*webhookNotification*�as follows:
@@ -671,9 +635,7 @@ URI Options for�_webhookNotification_
�
-[[Braintree-ConsumerEndpoints]]
-Consumer Endpoints
-^^^^^^^^^^^^^^^^^^
+### Consumer Endpoints
Any of the producer endpoints can be used as a consumer endpoint.
Consumer endpoints can
@@ -685,16 +647,12 @@ be executed once for each exchange. To change this behavior use the
property�*consumer.splitResults=true*�to return a single exchange for
the entire list or array.�
-[[Braintree-MessageHeaders]]
-Message Headers
-^^^^^^^^^^^^^^^
+### Message Headers
Any URI option can be provided in a message header for producer
endpoints with a�*CamelBraintree.*�prefix.
-[[Braintree-Messagebody]]
-Message body
-^^^^^^^^^^^^
+### Message body
All result message bodies utilize objects provided by the Braintree Java
SDK. Producer endpoints can specify the option name for incoming message
@@ -704,9 +662,7 @@ body in the�*inBody*�endpoint parameter.
�
-[[Braintree-Examples]]
-Examples
-^^^^^^^^
+### Examples
*Blueprint*
@@ -746,9 +702,7 @@ Examples
</blueprint>
--------------------------------------------------------------------------------------------------------------------------------------------
-[[Braintree-SeeAlso]]
-See Also
-^^^^^^^^
+### See Also
*
https://cwiki.apache.org/confluence/display/CAMEL/Configuring+Camel[Configuring
@@ -761,4 +715,4 @@ Started]
�
-https://cwiki.apache.org/confluence/display/CAMEL/AMQP[�]
+https://cwiki.apache.org/confluence/display/CAMEL/AMQP[�]
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-cache/src/main/docs/cache-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-cache/src/main/docs/cache-component.adoc b/components/camel-cache/src/main/docs/cache-component.adoc
index 379c0a8..b5ef8a2 100644
--- a/components/camel-cache/src/main/docs/cache-component.adoc
+++ b/components/camel-cache/src/main/docs/cache-component.adoc
@@ -1,4 +1,4 @@
-# EHCache Component
+## EHCache Component
*Available as of Camel 2.1*
@@ -27,9 +27,7 @@ for this component:
</dependency>
------------------------------------------------------------
-[[Cache-URIformat]]
-URI format
-^^^^^^^^^^
+### URI format
[source,java]
---------------------------
@@ -39,9 +37,7 @@ cache://cacheName[?options]
You can append query options to the URI in the following format,
`?option=value&option=#beanRef&...`
-[[Cache-Options]]
-Options
-^^^^^^^
+### Options
@@ -100,13 +96,9 @@ The EHCache component supports 20 endpoint options which are listed below:
// endpoint options: END
-[[Cache-SendingReceivingMessagestofromthecache]]
-Sending/Receiving Messages to/from the cache
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Sending/Receiving Messages to/from the cache
-[[Cache-MessageHeadersuptoCamel2.7]]
-Message Headers up to Camel 2.7
-+++++++++++++++++++++++++++++++
+#### Message Headers up to Camel 2.7
[width="100%",cols="20%,80%",options="header",]
|=======================================================================
@@ -125,9 +117,7 @@ Message Headers up to Camel 2.7
|`CACHE_KEY` |The cache key used to store the Message in the cache. The cache key is
optional if the CACHE_OPERATION is DELETEALL
|=======================================================================
-[[Cache-MessageHeadersCamel2.8]]
-Message Headers Camel 2.8+
-++++++++++++++++++++++++++
+#### Message Headers Camel 2.8+
[Info]
====
@@ -173,9 +163,7 @@ headers:
|`CamelCacheEternal` |`Boolean` |*Camel 2.11:* Whether the content is eternal.
|=======================================================================
-[[Cache-CacheProducer]]
-Cache Producer
-++++++++++++++
+#### Cache Producer
Sending data to the cache involves the ability to direct payloads in
exchanges to be stored in a pre-existing or created-on-demand cache. The
@@ -185,9 +173,7 @@ mechanics of doing this involve
* ensuring that the Message Exchange Body contains the message directed
to the cache
-[[Cache-CacheConsumer]]
-Cache Consumer
-++++++++++++++
+#### Cache Consumer
Receiving data from the cache involves the ability of the CacheConsumer
to listen on a pre-existing or created-on-demand Cache using an event
@@ -201,9 +187,7 @@ Body containing the just added/updated payload is placed and sent.
* in case of a CamelCacheDeleteAll operation, the Message Exchange
Header CamelCacheKey and the Message Exchange Body are not populated.
-[[Cache-CacheProcessors]]
-Cache Processors
-++++++++++++++++
+#### Cache Processors
There are a set of nice processors with the ability to perform cache
lookups and selectively replace payload content at the
@@ -212,13 +196,9 @@ lookups and selectively replace payload content at the
* token
* xpath level
-[[Cache-CacheUsageSamples]]
-Cache Usage Samples
-^^^^^^^^^^^^^^^^^^^
+### Cache Usage Samples
-[[Cache-Example1:Configuringthecache]]
-Example 1: Configuring the cache
-++++++++++++++++++++++++++++++++
+#### Example 1: Configuring the cache
[source,java]
-------------------------------------------------
@@ -234,9 +214,7 @@ from("cache://MyApplicationCache" +
"&diskExpiryThreadIntervalSeconds=300")
-------------------------------------------------
-[[Cache-Example2:Addingkeystothecache]]
-Example 2: Adding keys to the cache
-+++++++++++++++++++++++++++++++++++
+#### Example 2: Adding keys to the cache
[source,java]
---------------------------------------------------------------------------------------------
@@ -250,9 +228,7 @@ RouteBuilder builder = new RouteBuilder() {
};
---------------------------------------------------------------------------------------------
-[[Cache-Example2:Updatingexistingkeysinacache]]
-Example 2: Updating existing keys in a cache
-++++++++++++++++++++++++++++++++++++++++++++
+#### Example 2: Updating existing keys in a cache
[source,java]
------------------------------------------------------------------------------------------------
@@ -266,9 +242,7 @@ RouteBuilder builder = new RouteBuilder() {
};
------------------------------------------------------------------------------------------------
-[[Cache-Example3:Deletingexistingkeysinacache]]
-Example 3: Deleting existing keys in a cache
-++++++++++++++++++++++++++++++++++++++++++++
+#### Example 3: Deleting existing keys in a cache
[source,java]
--------------------------------------------------------------------------------------
@@ -282,9 +256,7 @@ RouteBuilder builder = new RouteBuilder() {
};
--------------------------------------------------------------------------------------
-[[Cache-Example4:Deletingallexistingkeysinacache]]
-Example 4: Deleting all existing keys in a cache
-++++++++++++++++++++++++++++++++++++++++++++++++
+#### Example 4: Deleting all existing keys in a cache
[source,java]
-----------------------------------------------------------------------------------------
@@ -297,9 +269,7 @@ RouteBuilder builder = new RouteBuilder() {
};
-----------------------------------------------------------------------------------------
-[[Cache-Example5:NotifyinganychangesregisteringinaCachetoProcessorsandotherProducers]]
-Example 5: Notifying any changes registering in a Cache to Processors and other Producers
-+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+#### Example 5: Notifying any changes registering in a Cache to Processors and other Producers
[source,java]
--------------------------------------------------------------------------------------------------
@@ -319,9 +289,7 @@ RouteBuilder builder = new RouteBuilder() {
};
--------------------------------------------------------------------------------------------------
-[[Cache-Example6:UsingProcessorstoselectivelyreplacepayloadwithcachevalues]]
-Example 6: Using Processors to selectively replace payload with cache values
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+#### Example 6: Using Processors to selectively replace payload with cache values
[source,java]
---------------------------------------------------------------------------------------
@@ -351,9 +319,7 @@ RouteBuilder builder = new RouteBuilder() {
};
---------------------------------------------------------------------------------------
-[[Cache-Example7:GettinganentryfromtheCache]]
-Example 7: Getting an entry from the Cache
-++++++++++++++++++++++++++++++++++++++++++
+#### Example 7: Getting an entry from the Cache
[source,java]
------------------------------------------------------------------------------------------------
@@ -373,9 +339,7 @@ from("direct:start")
.to("direct:nextPhase");
------------------------------------------------------------------------------------------------
-[[Cache-Example8:CheckingforanentryintheCache]]
-Example 8: Checking for an entry in the Cache
-+++++++++++++++++++++++++++++++++++++++++++++
+#### Example 8: Checking for an entry in the Cache
Note: The CHECK command tests existence of an entry in the cache but
doesn't place a message in the body.
@@ -397,9 +361,7 @@ from("direct:start")
.end();
------------------------------------------------------------------------------------------------
-[[Cache-ManagementofEHCache]]
-Management of EHCache
-^^^^^^^^^^^^^^^^^^^^^
+### Management of EHCache
http://ehcache.org/[EHCache] has its own statistics and management from
link:camel-jmx.html[JMX].
@@ -433,9 +395,7 @@ ManagementService.registerMBeans(CacheManager.getInstance(), mbeanServer, true,
You can get cache hits, misses, in-memory hits, disk hits, size stats
this way. You can also change CacheConfiguration parameters on the fly.
-[[Cache-CachereplicationCamel2.8]]
-Cache replication Camel 2.8
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Cache replication Camel 2.8
The Camel Cache component is able to distribute a cache across server
nodes using several different replication mechanisms including: RMI,
@@ -474,12 +434,9 @@ mechanism.
====
-[[Cache-Example:JMScachereplication]]
-Example: JMS cache replication
-++++++++++++++++++++++++++++++
+#### Example: JMS cache replication
JMS replication is the most powerful and secured replication method.
Used together with Camel Cache replication makes it also rather
simple. An example is available on link:cachereplicationjmsexample.html[a
-separate page].
-
+separate page].
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-cassandraql/src/main/docs/cql-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-cassandraql/src/main/docs/cql-component.adoc b/components/camel-cassandraql/src/main/docs/cql-component.adoc
index 7339d21..3241c79 100644
--- a/components/camel-cassandraql/src/main/docs/cql-component.adoc
+++ b/components/camel-cassandraql/src/main/docs/cql-component.adoc
@@ -1,4 +1,4 @@
-# Cassandra CQL Component
+## Cassandra CQL Component
[[Cassandra-CamelCassandraComponent]]
Camel Cassandra Component
-------------------------
@@ -33,9 +33,7 @@ Maven users will need to add the following dependency to their
</dependency>
------------------------------------------------------------
-[[Cassandra-URIformat]]
-URI format
-~~~~~~~~~~
+### URI format
The endpoint can initiate the Cassandra connection or use an existing
one.
@@ -55,9 +53,7 @@ To fine tune the Cassandra connection (SSL options, pooling options,
load balancing policy, retry policy, reconnection policy...), create
your own Cluster instance and give it to the Camel endpoint.
-[[Cassandra-Options]]
-Cassandra Options
-~~~~~~~~~~~~~~~~~
+### Cassandra Options
// component options: START
@@ -96,13 +92,9 @@ The Cassandra CQL component supports 18 endpoint options which are listed below:
// endpoint options: END
-[[Cassandra-Messages]]
-Messages
-~~~~~~~~
+### Messages
-[[Cassandra-IncomingMessage]]
-Incoming Message
-^^^^^^^^^^^^^^^^
+### Incoming Message
The Camel Cassandra endpoint expects a bunch of simple objects (`Object`
or `Object[]` or `Collection<Object>`) which will be bound to the CQL
@@ -114,9 +106,7 @@ Headers:
* `CamelCqlQuery` (optional, `String` or `RegularStatement`): CQL query
either as a plain String or built using the `QueryBuilder`.
-[[Cassandra-OutgoingMessage]]
-Outgoing Message
-^^^^^^^^^^^^^^^^
+### Outgoing Message
The Camel Cassandra endpoint produces one or many a Cassandra Row
objects depending on the�`resultSetConversionStrategy`:
@@ -129,9 +119,7 @@ objects depending on the�`resultSetConversionStrategy`:
* Anything else, if `resultSetConversionStrategy` is a custom
implementation of the `ResultSetConversionStrategy`
-[[Cassandra-Repositories]]
-Repositories
-~~~~~~~~~~~~
+### Repositories
Cassandra can be used to store message keys or messages for the
idempotent and aggregation EIP.
@@ -142,9 +130,7 @@ anti-patterns queues and queue like datasets]. It's advised to use
LeveledCompaction and a small GC grace setting for these tables to allow
tombstoned rows to be removed quickly.
-[[Cassandra-Idempotentrepository]]
-Idempotent repository
-^^^^^^^^^^^^^^^^^^^^^
+### Idempotent repository
The `NamedCassandraIdempotentRepository` stores messages keys in a
Cassandra table like this:
@@ -186,9 +172,7 @@ Alternatively, the `CassandraIdempotentRepository` does not have a
`LOCAL_QUORUM`\u2026
|=======================================================================
-[[Cassandra-Aggregationrepository]]
-Aggregation repository
-^^^^^^^^^^^^^^^^^^^^^^
+### Aggregation repository
The `NamedCassandraAggregationRepository` stores exchanges by
correlation key in a Cassandra table like this:
@@ -231,4 +215,4 @@ Alternatively, the `CassandraAggregationRepository` does not have a
|`readConsistencyLevel` | | Consistency level used to read/check exchange: `ONE`, `TWO`, `QUORUM`,
`LOCAL_QUORUM`\u2026
-|=======================================================================
+|=======================================================================
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-castor/src/main/docs/castor-dataformat.adoc
----------------------------------------------------------------------
diff --git a/components/camel-castor/src/main/docs/castor-dataformat.adoc b/components/camel-castor/src/main/docs/castor-dataformat.adoc
index bbf4b00..abf7192 100644
--- a/components/camel-castor/src/main/docs/castor-dataformat.adoc
+++ b/components/camel-castor/src/main/docs/castor-dataformat.adoc
@@ -1,4 +1,4 @@
-# Castor DataFormat
+## Castor DataFormat
*Available as of Camel 2.1*
@@ -9,9 +9,7 @@ into Java objects or to marshal Java objects into an XML payload.
As usually you can use either Java DSL or Spring XML to work with Castor
Data Format.
-[[Castor-UsingtheJavaDSL]]
-Using the Java DSL
-^^^^^^^^^^^^^^^^^^
+### Using the Java DSL
[source,java]
-----------------------------
@@ -60,9 +58,7 @@ castor.getMarshaller();
castor.getUnmarshaller();
-------------------------
-[[Castor-UsingSpringXML]]
-Using Spring XML
-^^^^^^^^^^^^^^^^
+### Using Spring XML
The following example shows how to use Castor to unmarshal using Spring
configuring the castor data type
@@ -106,9 +102,7 @@ on multiple routes. You have to set the <castor> element directly in
</camelContext>
-----------------------------------------------------------------------
-[[Castor-Options]]
-Options
-^^^^^^^
+### Options
// dataformat options: START
The Castor dataformat supports 6 options which are listed below.
@@ -129,9 +123,7 @@ The Castor dataformat supports 6 options which are listed below.
{% endraw %}
// dataformat options: END
-[[Castor-Dependencies]]
-Dependencies
-^^^^^^^^^^^^
+### Dependencies
To use Castor in your camel routes you need to add the a dependency on
*camel-castor* which implements this data format.
@@ -147,4 +139,4 @@ link:download.html[the download page for the latest versions]).
<artifactId>camel-castor</artifactId>
<version>x.x.x</version>
</dependency>
----------------------------------------
+---------------------------------------
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-chronicle/src/main/docs/chronicle-engine-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-chronicle/src/main/docs/chronicle-engine-component.adoc b/components/camel-chronicle/src/main/docs/chronicle-engine-component.adoc
index 39520e7..ffbb797 100644
--- a/components/camel-chronicle/src/main/docs/chronicle-engine-component.adoc
+++ b/components/camel-chronicle/src/main/docs/chronicle-engine-component.adoc
@@ -1,4 +1,4 @@
-# Chronicle Engine Component
+## Chronicle Engine Component
// component options: START
The Chronicle Engine component has no options.
@@ -28,5 +28,4 @@ The Chronicle Engine component supports 13 endpoint options which are listed bel
| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
|=======================================================================
{% endraw %}
-// endpoint options: END
-
+// endpoint options: END
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-chunk/src/main/docs/chunk-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-chunk/src/main/docs/chunk-component.adoc b/components/camel-chunk/src/main/docs/chunk-component.adoc
index 2d6e261..71b6750 100644
--- a/components/camel-chunk/src/main/docs/chunk-component.adoc
+++ b/components/camel-chunk/src/main/docs/chunk-component.adoc
@@ -1,4 +1,4 @@
-# Chunk Component
+## Chunk Component
*Available as of Camel 2.15*
@@ -19,9 +19,7 @@ their�`pom.xml`�for this component:
</dependency>
---------------------------------------------------------------------------------
-[[Chunk-URIformat]]
-URI format
-^^^^^^^^^^
+### URI format
[source,java]
----------------------------
@@ -34,9 +32,7 @@ invoke.
You can append query options to the URI in the following
format,�`?option=value&option=value&...`
-[[Chunk-Options]]
-Options
-^^^^^^^
+### Options
// component options: START
@@ -70,9 +66,7 @@ with extensions _.chtml_ or _.cxml.�_If you need to specify a different
folder or extensions, you will need to use the specific options listed
above.
-[[Chunk-ChunkContext]]
-Chunk Context
-^^^^^^^^^^^^^
+### Chunk Context
Camel will provide exchange information in the Chunk context (just
a�`Map`). The�`Exchange`�is transferred as:
@@ -97,9 +91,7 @@ a�`Map`). The�`Exchange`�is transferred as:
|`response` |The Out message (only for InOut message exchange pattern).
|=======================================================================
-[[Chunk-Dynamictemplates]]
-Dynamic templates
-^^^^^^^^^^^^^^^^^
+### Dynamic templates
Camel provides two headers by which you can define a different resource
location for a template or the template content itself. If any of these
@@ -116,9 +108,7 @@ configured. |
|ChunkConstants.CHUNK_TEMPLATE |String |The template to use instead of the endpoint configured. |
|=======================================================================
-[[Chunk-Samples]]
-Samples
-^^^^^^^
+### Samples
For example you could use something like:
@@ -162,9 +152,7 @@ to("chunk:file_example?themeFolder=template&themeSubfolder=subfolder&extension=c
In this example Chunk component will look for the file
_file_example.chunk_ in the folder _template/subfolder._
-[[Chunk-TheEmailSample]]
-The Email Sample
-^^^^^^^^^^^^^^^^
+### The Email Sample
In this sample we want to use Chunk templating for an order confirmation
email. The email template is laid out in Chunk as:
@@ -180,12 +168,9 @@ Regards Camel Riders Bookstore
{$body}
----------------------------------------------
-[[Chunk-SeeAlso]]
-See Also
-^^^^^^^^
+### See Also
* link:configuring-camel.html[Configuring Camel]
* link:component.html[Component]
* link:endpoint.html[Endpoint]
-* link:getting-started.html[Getting Started]
-
+* link:getting-started.html[Getting Started]
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-cm-sms/src/main/docs/cm-sms-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-cm-sms/src/main/docs/cm-sms-component.adoc b/components/camel-cm-sms/src/main/docs/cm-sms-component.adoc
index 3597945..7d60904 100644
--- a/components/camel-cm-sms/src/main/docs/cm-sms-component.adoc
+++ b/components/camel-cm-sms/src/main/docs/cm-sms-component.adoc
@@ -1,4 +1,4 @@
-# CM SMS Gateway Component
+## CM SMS Gateway Component
*Available as of Camel 2.18*
@@ -27,9 +27,7 @@ for this component:
</dependency>
---------------------------------------------------------
-[[CM-SMS-Options]]
-Options
-~~~~~~~
+### Options
// component options: START
@@ -56,8 +54,6 @@ The CM SMS Gateway component supports 6 endpoint options which are listed below:
// endpoint options: END
-[[CM-SMS-Sample]]
-Sample
-~~~~~~
+### Sample
-You can try https://github.com/oalles/camel-cm-sample[this project] to see how camel-cm-sms can be integrated in a camel route.
+You can try https://github.com/oalles/camel-cm-sample[this project] to see how camel-cm-sms can be integrated in a camel route.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-cmis/src/main/docs/cmis-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-cmis/src/main/docs/cmis-component.adoc b/components/camel-cmis/src/main/docs/cmis-component.adoc
index a57e5d1..1abc87e 100644
--- a/components/camel-cmis/src/main/docs/cmis-component.adoc
+++ b/components/camel-cmis/src/main/docs/cmis-component.adoc
@@ -1,4 +1,4 @@
-# CMIS Component
+## CMIS Component
*Available as of Camel 2.11* +
The cmis component uses the
@@ -6,9 +6,7 @@ http://chemistry.apache.org/java/opencmis.html[Apache Chemistry] client
API and allows you to add/read nodes to/from a CMIS compliant content
repositories.
-[[CMIS-URIFormat]]
-URI Format
-^^^^^^^^^^
+### URI Format
[source,java]
------------------------------
@@ -18,9 +16,7 @@ cmis://cmisServerUrl[?options]
You can append query options to the URI in the following format,
?options=value&option2=value&...
-[[CMIS-URIOptions]]
-CMIS Options
-^^^^^^^^^^^^
+### CMIS Options
// component options: START
@@ -65,13 +61,9 @@ The CMIS component supports 14 endpoint options which are listed below:
// endpoint options: END
-[[CMIS-Usage]]
-Usage
-^^^^^
+### Usage
-[[CMIS-Messageheadersevaluatedbytheproducer]]
-Message headers evaluated by the producer
-+++++++++++++++++++++++++++++++++++++++++
+#### Message headers evaluated by the producer
[width="100%",cols="10%,10%,80%",options="header",]
|=======================================================================
@@ -96,9 +88,7 @@ the node from this cmis property and it is path
|`cmis:contentStreamMimeType` |`null` |The mimetype to set for a document
|=======================================================================
-[[CMIS-MessageheaderssetduringqueryingProduceroperation]]
-Message headers set during querying Producer operation
-++++++++++++++++++++++++++++++++++++++++++++++++++++++
+#### Message headers set during querying Producer operation
[width="100%",cols="10%,10%,80%",options="header",]
|=======================================================================
@@ -112,9 +102,7 @@ map is cmis property and its value. If `CamelCMISRetrieveContent` header is set
entry in the map with key `CamelCMISContent` will contain `InputStream`
of the document type of nodes.
-[[CMIS-Dependencies]]
-Dependencies
-^^^^^^^^^^^^
+### Dependencies
Maven users will need to add the following dependency to their pom.xml.
@@ -132,12 +120,9 @@ Maven users will need to add the following dependency to their pom.xml.
where `${camel-version`} must be replaced by the actual version of Camel
(2.11 or higher).
-[[CMIS-SeeAlso]]
-See Also
-^^^^^^^^
+### See Also
* link:configuring-camel.html[Configuring Camel]
* link:component.html[Component]
* link:endpoint.html[Endpoint]
-* link:getting-started.html[Getting Started]
-
+* link:getting-started.html[Getting Started]
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-coap/src/main/docs/coap-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-coap/src/main/docs/coap-component.adoc b/components/camel-coap/src/main/docs/coap-component.adoc
index 111cc7c..e7719c4 100644
--- a/components/camel-coap/src/main/docs/coap-component.adoc
+++ b/components/camel-coap/src/main/docs/coap-component.adoc
@@ -1,4 +1,4 @@
-# CoAP Component
+## CoAP Component
*Camel-CoAP* is an http://camel.apache.org/[Apache Camel] component that
allows you to work with CoAP, a lightweight REST-type protocol for machine-to-machine operation.
@@ -20,9 +20,7 @@ for this component:
</dependency>
---------------------------------------------------------
-[[CoAP-Options]]
-Options
-~~~~~~~
+### Options
// component options: START
@@ -47,6 +45,4 @@ The CoAP component supports 6 endpoint options which are listed below:
| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
|=======================================================================
{% endraw %}
-// endpoint options: END
-
-
+// endpoint options: END
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-cometd/src/main/docs/cometd-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-cometd/src/main/docs/cometd-component.adoc b/components/camel-cometd/src/main/docs/cometd-component.adoc
index 0e651fb..1ab0cf7 100644
--- a/components/camel-cometd/src/main/docs/cometd-component.adoc
+++ b/components/camel-cometd/src/main/docs/cometd-component.adoc
@@ -1,4 +1,4 @@
-# CometD Component
+## CometD Component
The *cometd:* component is a transport for working with the
http://www.mortbay.org/jetty[jetty] implementation of the
@@ -21,9 +21,7 @@ for this component:
</dependency>
------------------------------------------------------------
-[[Cometd-URIformat]]
-URI format
-^^^^^^^^^^
+### URI format
[source,java]
----------------------------------------
@@ -33,9 +31,7 @@ cometd://host:port/channelName[?options]
The *channelName* represents a topic that can be subscribed to by the
Camel endpoints.
-[[Cometd-Examples]]
-Examples
-^^^^^^^^
+### Examples
------------------------------------------
cometd://localhost:8080/service/mychannel
@@ -44,9 +40,7 @@ cometds://localhost:8443/service/mychannel
where `cometds:` represents an SSL configured endpoint.
-[[Cometd-Options]]
-Options
-^^^^^^^
+### Options
@@ -118,9 +112,7 @@ For file (for webapp resources located in the Web Application directory
the webapp folder -->
cometd://localhost:8080?resourceBase=classpath:webapp
-[[Cometd-Authentication]]
-Authentication
-^^^^^^^^^^^^^^
+### Authentication
*Available as of Camel 2.8*
@@ -128,13 +120,9 @@ You can configure custom `SecurityPolicy` and `Extension`'s to the
`CometdComponent` which allows you to use authentication as
http://cometd.org/documentation/howtos/authentication[documented here]
-[[Cometd-SettingupSSLforCometdComponent]]
-Setting up SSL for Cometd Component
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Setting up SSL for Cometd Component
-[[Cometd-UsingtheJSSEConfigurationUtility]]
-Using the JSSE Configuration Utility
-++++++++++++++++++++++++++++++++++++
+#### Using the JSSE Configuration Utility
As of Camel 2.9, the Cometd component supports SSL/TLS configuration
through the link:camel-configuration-utilities.html[Camel JSSE
@@ -196,12 +184,9 @@ Spring DSL based configuration of endpoint
<to uri="cometds://127.0.0.1:443/service/test?baseResource=file:./target/test-classes/webapp&timeout=240000&interval=0&maxInterval=30000&multiFrameInterval=1500&jsonCommented=true&logLevel=2"/>...
------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-[[Cometd-SeeAlso]]
-See Also
-^^^^^^^^
+### See Also
* link:configuring-camel.html[Configuring Camel]
* link:component.html[Component]
* link:endpoint.html[Endpoint]
-* link:getting-started.html[Getting Started]
-
+* link:getting-started.html[Getting Started]
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-consul/src/main/docs/consul-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-consul/src/main/docs/consul-component.adoc b/components/camel-consul/src/main/docs/consul-component.adoc
index 5f8b92d..6cb0fe0 100644
--- a/components/camel-consul/src/main/docs/consul-component.adoc
+++ b/components/camel-consul/src/main/docs/consul-component.adoc
@@ -1,4 +1,4 @@
-# Consul Component
+## Consul Component
*Available as of Camel 2.18*
@@ -16,9 +16,7 @@ for this component:
</dependency>
-------------------------------------------------
-[[Consul-URIformat]]
-URI format
-^^^^^^^^^^
+### URI format
[source,java]
---------------------------------------
@@ -31,9 +29,7 @@ You can append query options to the URI in the following format:
?option=value&option=value&...
---------------------------------------
-[[Consul-Options]]
-Options
-^^^^^^^
+### Options
@@ -83,9 +79,7 @@ The Consul component supports 22 endpoint options which are listed below:
-[[Consul-Headers]]
-Headers
-^^^^^^^
+### Headers
[width="100%",cols="10%,10%,80%",options="header",]
|=======================================================================
@@ -107,4 +101,4 @@ Headers
|CamelConsulResult|boolean|true if the response has a result
|CamelConsulSession|String|The session id
|CamelConsulValueAsString|boolean|To transform values retrieved from Consul i.e. on KV endpoint to string.
-|=======================================================================
+|=======================================================================
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-context/src/main/docs/context-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-context/src/main/docs/context-component.adoc b/components/camel-context/src/main/docs/context-component.adoc
index ec848d7..c903519 100644
--- a/components/camel-context/src/main/docs/context-component.adoc
+++ b/components/camel-context/src/main/docs/context-component.adoc
@@ -1,4 +1,4 @@
-# Camel Context Component
+## Camel Context Component
*Available as of Camel 2.7*
@@ -25,9 +25,7 @@ for this component:
</dependency>
------------------------------------------------------------
-[[Context-URIformat]]
-URI format
-^^^^^^^^^^
+### URI format
[source,java]
--------------------------------------------------
@@ -70,16 +68,12 @@ The Camel Context component supports 6 endpoint options which are listed below:
You can append query options to the URI in the following format,
`?option=value&option=value&...`
-[[Context-Example]]
-Example
-^^^^^^^
+### Example
In this example we'll create a black box context, then we'll use it from
another CamelContext.
-[[Context-Definingthecontextcomponent]]
-Defining the context component
-++++++++++++++++++++++++++++++
+#### Defining the context component
First you need to create a CamelContext, add some routes in it, start it
and then register the CamelContext into the link:registry.html[Registry]
@@ -125,9 +119,7 @@ ID. We can do the same thing in Spring via
</camelContext>
--------------------------------------------------------------------------
-[[Context-Usingthecontextcomponent]]
-Using the context component
-+++++++++++++++++++++++++++
+#### Using the context component
Then in another CamelContext we can then refer to this "accounts black
box" by just sending to *accounts:purchaseOrder* and consuming from
@@ -158,9 +150,7 @@ middleware (outside of the black box) we can do things like...
</camelContext>
--------------------------------------------------------------------------------
-[[Context-Namingendpoints]]
-Naming endpoints
-++++++++++++++++
+#### Naming endpoints
A context component instance can have many public input and output
endpoints that can be accessed from outside it's CamelContext. When
@@ -169,4 +159,4 @@ hide the middleware as shown above.
However when there is only one input, output or error/dead letter
endpoint in a component we recommend using the common posix shell names
-*in*, *out* and *err*
+*in*, *out* and *err*
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-couchdb/src/main/docs/couchdb-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-couchdb/src/main/docs/couchdb-component.adoc b/components/camel-couchdb/src/main/docs/couchdb-component.adoc
index 07d8827..14ada92 100644
--- a/components/camel-couchdb/src/main/docs/couchdb-component.adoc
+++ b/components/camel-couchdb/src/main/docs/couchdb-component.adoc
@@ -1,4 +1,4 @@
-# CouchDB Component
+## CouchDB Component
*Available as of Camel 2.11*
@@ -31,9 +31,7 @@ for this component:
</dependency>
------------------------------------------------------------
-[[CouchDB-URIformat]]
-URI format
-^^^^^^^^^^
+### URI format
[source,java]
-------------------------------------------------
@@ -43,9 +41,7 @@ couchdb:http://hostname[:port]/database?[options]
Where *hostname* is the hostname of the running couchdb instance. Port
is optional and if not specified then defaults to 5984.
-[[CouchDB-Options]]
-Options
-^^^^^^^
+### Options
// component options: START
The CouchDB component has no options.
@@ -77,9 +73,7 @@ The CouchDB component supports 15 endpoint options which are listed below:
{% endraw %}
// endpoint options: END
-[[CouchDB-Headers]]
-Headers
-^^^^^^^
+### Headers
The following headers are set on exchanges during message transport.
@@ -105,9 +99,7 @@ ignored. That means for example, if you set CouchDbId as a header, it
will not be used as the id for insertion, the id of the document will
still be used.
-[[CouchDB-MessageBody]]
-Message Body
-^^^^^^^^^^^^
+### Message Body
The component will use the message body as the document to be inserted.
If the body is an instance of String, then it will be marshalled into a
@@ -116,9 +108,7 @@ or the insert / update will fail. If the body is an instance of a
com.google.gson.JsonElement then it will be inserted as is. Otherwise
the producer will throw an exception of unsupported body type.
-[[CouchDB-Samples]]
-Samples
-^^^^^^^
+### Samples
For example if you wish to consume all inserts, updates and deletes from
a CouchDB instance running locally, on port 9999 then you could use the
@@ -142,4 +132,4 @@ exchange is used
[source,java]
----------------------------------------------------------------------------------------
from("someProducingEndpoint").process(someProcessor).to("couchdb:http://localhost:9999")
-----------------------------------------------------------------------------------------
+----------------------------------------------------------------------------------------
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-crypto/src/main/docs/crypto-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-crypto/src/main/docs/crypto-component.adoc b/components/camel-crypto/src/main/docs/crypto-component.adoc
index d9ed64f..1550211 100644
--- a/components/camel-crypto/src/main/docs/crypto-component.adoc
+++ b/components/camel-crypto/src/main/docs/crypto-component.adoc
@@ -1,4 +1,4 @@
-# Crypto (JCE) Component
+## Crypto (JCE) Component
*Available as of Camel 2.3*
*PGP Available as of Camel 2.9*
@@ -11,9 +11,7 @@ encryption to cyphertext and unmarshalling to mean decryption back to
the original plaintext. This data format implements only symmetric
(shared-key) encryption and decyption.
-[[Crypto-Options]]
-Options
-^^^^^^^
+### Options
// component options: START
The Crypto (JCE) component supports 1 options which are listed below.
@@ -61,9 +59,7 @@ The Crypto (JCE) component supports 21 endpoint options which are listed below:
{% endraw %}
// endpoint options: END
-[[Crypto-BasicUsage]]
-Basic Usage
-^^^^^^^^^^^
+### Basic Usage
At its most basic all that is required to encrypt/decrypt an exchange is
a shared secret key. If one or more instances of the Crypto data format
@@ -90,9 +86,7 @@ In Spring the dataformat is configured first and then used in routes
</camelContext>
-----------------------------------------------------------------------
-[[Crypto-SpecifyingtheEncryptionAlgorithm]]
-Specifying the Encryption Algorithm
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Specifying the Encryption Algorithm
Changing the algorithm is a matter of supplying the JCE algorithm name.
If you change the algorithm you will need to use a compatible key.
@@ -101,9 +95,7 @@ A list of the available algorithms in Java 7 is available via the
http://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html[Java
Cryptography Architecture Standard Algorithm Name Documentation].
-[[Crypto-SpecifyinganInitializationVector]]
-Specifying an Initialization Vector
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Specifying an Initialization Vector
Some crypto algorithms, particularly block algorithms, require
configuration with an initial block of data known as an Initialization
@@ -130,9 +122,7 @@ http://www.herongyang.com/Cryptography/[http://www.herongyang.com/Cryptography/]
*
http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation[http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation]
-[[Crypto-HashedMessageAuthenticationCodes(HMAC)]]
-Hashed Message Authentication Codes (HMAC)
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Hashed Message Authentication Codes (HMAC)
To avoid attacks against the encrypted data while it is in transit the
CryptoDataFormat can also calculate a Message Authentication Code for
@@ -155,9 +145,7 @@ security providers
or with spring.
-[[Crypto-SupplyingKeysDynamically]]
-Supplying Keys Dynamically
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Supplying Keys Dynamically
When using a Recipient list or similar EIP the recipient of an exchange
can vary dynamically. Using the same key across all recipients may
@@ -171,9 +159,7 @@ allow for keys to be supplied dynamically via the message headers below
or with spring.
-[[Crypto-PGPMessage]]
-PGP Message
-^^^^^^^^^^^
+### PGP Message
The PGP Data Formater can create and decrypt/verify PGP Messages of the
following PGP packet structure (entries in brackets are optional and
@@ -189,9 +175,7 @@ was mandatory.
�
-[[Crypto-PGPDataFormatOptions]]
-PGPDataFormat Options
-^^^^^^^^^^^^^^^^^^^^^
+### PGPDataFormat Options
[width="70%",cols="10%,10%,10%,70%",options="header",]
|=======================================================================
|Name |Type |Default |Description
@@ -320,9 +304,7 @@ then no Compressed Data packet is added and the compressionAlgorithm
value is ignored. Only used for marshaling.
|=======================================================================
-[[Crypto-PGPDataFormatMessageHeaders]]
-PGPDataFormat Message Headers
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### PGPDataFormat Message Headers
You can override the PGPDataFormat options by applying below headers
into message dynamically.
@@ -377,9 +359,7 @@ symmectric key, set by PGPDataFormat during encryptiion process
signatures, set by PGPDataFormat during signing process
|=======================================================================
-[[Crypto-EncryptingwithPGPDataFormat]]
-Encrypting with PGPDataFormat
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Encrypting with PGPDataFormat
The following sample uses the popular PGP format for
encrypting/decrypting files using the
@@ -391,9 +371,7 @@ encryption, but you can obviously use different keys:
Or using Spring:
-[[Crypto-Toworkwiththepreviousexampleyouneedthefollowing]]
-To work with the previous example you need the following
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+#### To work with the previous example you need the following
* A public keyring file which contains the public keys used to encrypt
the data
@@ -401,9 +379,7 @@ the data
data
* The keyring password
-[[Crypto-Managingyourkeyring]]
-Managing your keyring
-+++++++++++++++++++++
+#### Managing your keyring
To manage the keyring, I use the command line tools, I find this to be
the simplest approach in managing the keys. There are also Java
@@ -440,8 +416,7 @@ ls -l ~/.gnupg/pubring.gpg ~/.gnupg/secring.gpg
[[Crypto-PGPDecrypting/VerifyingofMessagesEncrypted/SignedbyDifferentPrivate/PublicKeys]]
PGP Decrypting/Verifying of Messages Encrypted/Signed by Different
-Private/Public Keys
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Private/Public Keys
Since *Camel 2.12.2*.
@@ -486,9 +461,7 @@ same mechanism is also used to locate the public key for verifying a
signature. Therefore you no longer must specify User IDs for the
unmarshaling.
-[[Crypto-RestrictingtheSignerIdentitiesduringPGPSignatureVerification]]
-Restricting the Signer Identities during PGP Signature Verification
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Restricting the Signer Identities during PGP Signature Verification
Since�*Camel 2.12.3.*
@@ -525,9 +498,7 @@ successful as soon as one signature can be verified.
then do not specify the signature key User IDs. In this case all public
keys in the public keyring are taken into account.
-[[Crypto-SeveralSignaturesinOnePGPDataFormat]]
-Several Signatures in One PGP Data Format
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Several Signatures in One PGP Data Format
Since�*Camel 2.12.3.*
@@ -557,9 +528,7 @@ from("direct:start")
...
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-[[Crypto-SupportofSub-KeysandKeyFlagsinPGPDataFormatMarshaler]]
-Support of Sub-Keys and Key Flags in PGP Data Format Marshaler
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Support of Sub-Keys and Key Flags in PGP Data Format Marshaler
Since�*Camel 2.12.3. +
*An https://tools.ietf.org/html/rfc4880#section-12.1[OpenPGP V4 key] can
@@ -574,9 +543,7 @@ these Key Flags of the primary key and sub-keys in order to determine
the right key for signing and encryption. This is necessary because the
primary key and its sub-keys have the same User IDs.
-[[Crypto-SupportofCustomKeyAccessors]]
-Support of Custom Key Accessors
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Support of Custom Key Accessors
Since *Camel 2.13.0. +
*You can implement custom key accessors for encryption/signing. The
@@ -600,9 +567,7 @@ PGPKeyAccessDataFormat has the same options as PGPDataFormat except
password, keyFileName, encryptionKeyRing, signaturePassword,
signatureKeyFileName, and signatureKeyRing.
-[[Crypto-Dependencies]]
-Dependencies
-^^^^^^^^^^^^
+### Dependencies
To use the link:crypto.html[Crypto] dataformat in your camel routes you
need to add the following dependency to your pom.
@@ -617,11 +582,8 @@ need to add the following dependency to your pom.
</dependency>
----------------------------------------------------------
-[[Crypto-SeeAlso]]
-See Also
-^^^^^^^^
+### See Also
* link:data-format.html[Data Format]
* link:crypto-digital-signatures.html[Crypto (Digital Signatures)]
-* http://www.bouncycastle.org/java.html[http://www.bouncycastle.org/java.html]
-
+* http://www.bouncycastle.org/java.html[http://www.bouncycastle.org/java.html]
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-crypto/src/main/docs/crypto-dataformat.adoc
----------------------------------------------------------------------
diff --git a/components/camel-crypto/src/main/docs/crypto-dataformat.adoc b/components/camel-crypto/src/main/docs/crypto-dataformat.adoc
index 3217a2b..11aab01 100644
--- a/components/camel-crypto/src/main/docs/crypto-dataformat.adoc
+++ b/components/camel-crypto/src/main/docs/crypto-dataformat.adoc
@@ -1,4 +1,4 @@
-# Crypto (Java Cryptographic Extension) DataFormat
+## Crypto (Java Cryptographic Extension) DataFormat
The Crypto link:data-format.html[Data Format] integrates the Java
Cryptographic Extension into Camel, allowing simple and flexible
@@ -8,9 +8,7 @@ encryption to cyphertext and unmarshalling to mean decryption back to
the original plaintext. This data format implements only symmetric
(shared-key) encryption and decyption.
-[[Crypto-PGPDataFormatOptions]]
-CryptoDataFormat Options
-^^^^^^^^^^^^^^^^^^^^^^^^
+### CryptoDataFormat Options
// dataformat options: START
The Crypto (Java Cryptographic Extension) dataformat supports 10 options which are listed below.
@@ -36,9 +34,7 @@ The Crypto (Java Cryptographic Extension) dataformat supports 10 options which a
// dataformat options: END
-[[Basic Usage]]
-Basic Usage
-^^^^^^^^^^^
+### Basic Usage
At its most basic all that is required to encrypt/decrypt an exchange is a shared secret key.
If one or more instances of the Crypto data format are configured with this key the format can
@@ -79,8 +75,7 @@ In Spring the dataformat is configured first and then used in routes
----------------------------------------------------------
-Specifying the Encryption Algorithm
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Specifying the Encryption Algorithm
Changing the algorithm is a matter of supplying the JCE algorithm name. If you change the algorithm you will need to use a compatible key.
@@ -102,8 +97,7 @@ from("direct:hmac-algorithm")
A list of the available algorithms in Java 7 is available via the Java Cryptography Architecture Standard Algorithm Name Documentation.
-Specifying an Initialization Vector
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Specifying an Initialization Vector
Some crypto algorithms, particularly block algorithms, require configuration with an initial block of data known as an Initialization Vector.
In the JCE this is passed as an AlgorithmParameterSpec when the Cipher is initialized.
@@ -171,8 +165,7 @@ For more information of the use of Initialization Vectors, consult
* http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation
-Hashed Message Authentication Codes (HMAC)
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Hashed Message Authentication Codes (HMAC)
To avoid attacks against the encrypted data while it is in transit the CryptoDataFormat can also calculate a Message Authentication
Code for the encrypted exchange contents based on a configurable MAC algorithm. The calculated HMAC is appended to the stream after encryption.
It is separated from the stream in the decryption phase. The MAC is recalculated and verified against the transmitted version to insure nothing
@@ -225,8 +218,7 @@ or with spring.
----------------------------------------------------------
-Supplying Keys Dynamically
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Supplying Keys Dynamically
When using a Recipient list or similar EIP the recipient of an exchange can vary dynamically.
Using the same key across all recipients may neither be feasible or desirable. It would be useful to be able to specify
@@ -267,9 +259,7 @@ or with spring.
----------------------------------------------------------
-[[Crypto-Dependencies]]
-Dependencies
-^^^^^^^^^^^^
+### Dependencies
To use the link:crypto.html[Crypto] dataformat in your camel routes you
need to add the following dependency to your pom.
@@ -284,11 +274,8 @@ need to add the following dependency to your pom.
</dependency>
----------------------------------------------------------
-[[Crypto-SeeAlso]]
-See Also
-^^^^^^^^
+### See Also
* link:data-format.html[Data Format]
* link:crypto-digital-signatures.html[Crypto (Digital Signatures)]
-* http://www.bouncycastle.org/java.html[http://www.bouncycastle.org/java.html]
-
+* http://www.bouncycastle.org/java.html[http://www.bouncycastle.org/java.html]
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-crypto/src/main/docs/pgp-dataformat.adoc
----------------------------------------------------------------------
diff --git a/components/camel-crypto/src/main/docs/pgp-dataformat.adoc b/components/camel-crypto/src/main/docs/pgp-dataformat.adoc
index 8706510..71a2596 100644
--- a/components/camel-crypto/src/main/docs/pgp-dataformat.adoc
+++ b/components/camel-crypto/src/main/docs/pgp-dataformat.adoc
@@ -1,4 +1,4 @@
-# PGP DataFormat
+## PGP DataFormat
The PGP link:data-format.html[Data Format] integrates the Java
Cryptographic Extension into Camel, allowing simple and flexible
@@ -8,9 +8,7 @@ encryption to cyphertext and unmarshalling to mean decryption back to
the original plaintext. This data format implements only symmetric
(shared-key) encryption and decyption.
-[[Crypto-PGPDataFormatOptions]]
-PGPDataFormat Options
-^^^^^^^^^^^^^^^^^^^^^
+### PGPDataFormat Options
// dataformat options: START
The PGP dataformat supports 15 options which are listed below.
@@ -40,9 +38,7 @@ The PGP dataformat supports 15 options which are listed below.
{% endraw %}
// dataformat options: END
-[[Crypto-PGPDataFormatMessageHeaders]]
-PGPDataFormat Message Headers
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### PGPDataFormat Message Headers
You can override the PGPDataFormat options by applying below headers
into message dynamically.
@@ -97,9 +93,7 @@ symmectric key, set by PGPDataFormat during encryptiion process
signatures, set by PGPDataFormat during signing process
|=======================================================================
-[[Crypto-EncryptingwithPGPDataFormat]]
-Encrypting with PGPDataFormat
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Encrypting with PGPDataFormat
The following sample uses the popular PGP format for
encrypting/decrypting files using the
@@ -111,9 +105,7 @@ encryption, but you can obviously use different keys:
Or using Spring:
-[[Crypto-Toworkwiththepreviousexampleyouneedthefollowing]]
-To work with the previous example you need the following
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+#### To work with the previous example you need the following
* A public keyring file which contains the public keys used to encrypt
the data
@@ -121,9 +113,7 @@ the data
data
* The keyring password
-[[Crypto-Managingyourkeyring]]
-Managing your keyring
-+++++++++++++++++++++
+#### Managing your keyring
To manage the keyring, I use the command line tools, I find this to be
the simplest approach in managing the keys. There are also Java
@@ -160,8 +150,7 @@ ls -l ~/.gnupg/pubring.gpg ~/.gnupg/secring.gpg
[[Crypto-PGPDecrypting/VerifyingofMessagesEncrypted/SignedbyDifferentPrivate/PublicKeys]]
PGP Decrypting/Verifying of Messages Encrypted/Signed by Different
-Private/Public Keys
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Private/Public Keys
Since *Camel 2.12.2*.
@@ -206,9 +195,7 @@ same mechanism is also used to locate the public key for verifying a
signature. Therefore you no longer must specify User IDs for the
unmarshaling.
-[[Crypto-RestrictingtheSignerIdentitiesduringPGPSignatureVerification]]
-Restricting the Signer Identities during PGP Signature Verification
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Restricting the Signer Identities during PGP Signature Verification
Since�*Camel 2.12.3.*
@@ -245,9 +232,7 @@ successful as soon as one signature can be verified.
then do not specify the signature key User IDs. In this case all public
keys in the public keyring are taken into account.
-[[Crypto-SeveralSignaturesinOnePGPDataFormat]]
-Several Signatures in One PGP Data Format
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Several Signatures in One PGP Data Format
Since�*Camel 2.12.3.*
@@ -277,9 +262,7 @@ from("direct:start")
...
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-[[Crypto-SupportofSub-KeysandKeyFlagsinPGPDataFormatMarshaler]]
-Support of Sub-Keys and Key Flags in PGP Data Format Marshaler
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Support of Sub-Keys and Key Flags in PGP Data Format Marshaler
Since�*Camel 2.12.3. +
*An https://tools.ietf.org/html/rfc4880#section-12.1[OpenPGP V4 key] can
@@ -294,9 +277,7 @@ these Key Flags of the primary key and sub-keys in order to determine
the right key for signing and encryption. This is necessary because the
primary key and its sub-keys have the same User IDs.
-[[Crypto-SupportofCustomKeyAccessors]]
-Support of Custom Key Accessors
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Support of Custom Key Accessors
Since *Camel 2.13.0. +
*You can implement custom key accessors for encryption/signing. The
@@ -320,9 +301,7 @@ PGPKeyAccessDataFormat has the same options as PGPDataFormat except
password, keyFileName, encryptionKeyRing, signaturePassword,
signatureKeyFileName, and signatureKeyRing.
-[[Crypto-Dependencies]]
-Dependencies
-^^^^^^^^^^^^
+### Dependencies
To use the PGP dataformat in your camel routes you
need to add the following dependency to your pom.
@@ -337,11 +316,8 @@ need to add the following dependency to your pom.
</dependency>
----------------------------------------------------------
-[[Crypto-SeeAlso]]
-See Also
-^^^^^^^^
+### See Also
* link:data-format.html[Data Format]
* link:crypto-digital-signatures.html[Crypto (Digital Signatures)]
-* http://www.bouncycastle.org/java.html[http://www.bouncycastle.org/java.html]
-
+* http://www.bouncycastle.org/java.html[http://www.bouncycastle.org/java.html]
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-csv/src/main/docs/csv-dataformat.adoc
----------------------------------------------------------------------
diff --git a/components/camel-csv/src/main/docs/csv-dataformat.adoc b/components/camel-csv/src/main/docs/csv-dataformat.adoc
index 34b71d3..c909525 100644
--- a/components/camel-csv/src/main/docs/csv-dataformat.adoc
+++ b/components/camel-csv/src/main/docs/csv-dataformat.adoc
@@ -1,4 +1,4 @@
-# CSV DataFormat
+## CSV DataFormat
The CSV link:data-format.html[Data Format] uses
http://commons.apache.org/proper/commons-csv/[Apache Commons CSV] to
@@ -6,9 +6,7 @@ handle CSV payloads (Comma Separated Values) such as those
exported/imported by Excel.
-[[CSV-Options]]
-Options
-^^^^^^^
+### Options
// dataformat options: START
The CSV dataformat supports 24 options which are listed below.
@@ -49,9 +47,7 @@ The CSV dataformat supports 24 options which are listed below.
-[[CSV-MarshallingaMaptoCSV]]
-Marshalling a Map to CSV
-^^^^^^^^^^^^^^^^^^^^^^^^
+### Marshalling a Map to CSV
The component allows you to marshal a Java Map (or any other message
type that can be link:type-converter.html[converted] in a Map) into a
@@ -95,9 +91,7 @@ then it will produce
abc,123
-------------------------------------------------------
-[[CSV-UnmarshallingaCSVmessageintoaJavaList]]
-Unmarshalling a CSV message into a Java List
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Unmarshalling a CSV message into a Java List
Unmarshalling will transform a CSV messsage into a Java List with CSV
file lines (containing another List with all the field values).
@@ -133,9 +127,7 @@ for (List<String> line : data) {
}
--------------------------------------------------------------------------------------------------------------
-[[CSV-MarshallingaList<Map>toCSV]]
-Marshalling a List<Map> to CSV
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Marshalling a List<Map> to CSV
*Available as of Camel 2.1*
@@ -144,9 +136,7 @@ format you can now store the message payload as a
`List<Map<String, Object>>` object where the list contains a Map for
each row.
-[[CSV-FilePollerofCSV,thenunmarshaling]]
-File Poller of CSV, then unmarshaling
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### File Poller of CSV, then unmarshaling
Given a bean which can handle the incoming data...
@@ -173,9 +163,7 @@ public void doHandleCsvData(List<List<String>> csvData)
</route>
------------------------------------------------------------------------------------------------
-[[CSV-Marshalingwithapipeasdelimiter]]
-Marshaling with a pipe as delimiter
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Marshaling with a pipe as delimiter
Considering the following body
[source,java]
@@ -224,8 +212,7 @@ abc|123
[[CSV-UsingautogenColumns,configRefandstrategyRefattributesinsideXMLDSL]]
Using autogenColumns, configRef and strategyRef attributes inside XML
-DSL
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### DSL
*Available as of Camel 2.9.2 / 2.10 and deleted for Camel 2.15*
@@ -264,9 +251,7 @@ should illustrate this customization.
</bean>
-----------------------------------------------------------------------------------------------------------------------------
-[[CSV-UsingskipFirstLineoptionwhileunmarshaling]]
-Using skipFirstLine option while unmarshaling
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Using skipFirstLine option while unmarshaling
*Available as of Camel 2.10 and deleted for Camel 2.15*
@@ -296,9 +281,7 @@ from("direct:start")
.to("bean:myCsvHandler?method=doHandleCsv");
--------------------------------------------
-[[CSV-Unmarshalingwithapipeasdelimiter]]
-Unmarshaling with a pipe as delimiter
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Unmarshaling with a pipe as delimiter
Using the Spring/XML DSL:
@@ -361,9 +344,7 @@ csvConfig.setDelimiter(';');
doesn't work. You have to set the delimiter as a String!
-[[CSV-Dependencies]]
-Dependencies
-^^^^^^^^^^^^
+### Dependencies
To use CSV in your Camel routes you need to add a dependency on
*camel-csv*, which implements this data format.
@@ -379,4 +360,4 @@ link:download.html[the download page for the latest versions]).
<artifactId>camel-csv</artifactId>
<version>x.x.x</version>
</dependency>
--------------------------------------
+-------------------------------------
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-cxf/src/main/docs/cxf-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-cxf/src/main/docs/cxf-component.adoc b/components/camel-cxf/src/main/docs/cxf-component.adoc
index ce2f27e..fc32eb8 100644
--- a/components/camel-cxf/src/main/docs/cxf-component.adoc
+++ b/components/camel-cxf/src/main/docs/cxf-component.adoc
@@ -1,4 +1,4 @@
-# CXF Component
+## CXF Component
NOTE:When using CXF as a consumer, the link:cxf-bean-component.html[CXF Bean
Component] allows you to factor out how message payloads are received
@@ -87,9 +87,7 @@ If you want to learn about CXF dependencies you can checkout the
====
-[[CXF-URIformat]]
-URI format
-^^^^^^^^^^
+### URI format
[source,java]
------------------------------
@@ -115,9 +113,7 @@ For either style above, you can append options to the URI as follows:
cxf:bean:cxfEndpoint?wsdlURL=wsdl/hello_world.wsdl&dataFormat=PAYLOAD
---------------------------------------------------------------------
-[[CXF-Options]]
-Options
-^^^^^^^
+### Options
@@ -193,9 +189,7 @@ http://en.wikipedia.org/wiki/QName[QNames], so if you provide them be
sure to prefix them with their \{namespace} as shown in the examples
above.
-[[CXF-Thedescriptionsofthedataformats]]
-The descriptions of the dataformats
-+++++++++++++++++++++++++++++++++++
+#### The descriptions of the dataformats
[width="100%",cols="50%,50%",options="header",]
|=======================================================================
@@ -253,9 +247,7 @@ following is an example.
</cxf:cxfEndpoint>
-------------------------------------------------------------------------------------------------------
-[[CXF-DescriptionofrelayHeadersoption]]
-Description of relayHeaders option
-++++++++++++++++++++++++++++++++++
+#### Description of relayHeaders option
There are _in-band_ and _out-of-band_ on-the-wire headers from the
perspective of a JAXWS WSDL-first developer.
@@ -398,9 +390,7 @@ value is `false`, it will throw an exception
_Default_: `false`
|=======================================================================
-[[CXF-ConfiguretheCXFendpointswithSpring]]
-Configure the CXF endpoints with Spring
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Configure the CXF endpoints with Spring
You can configure the CXF endpoint with the Spring configuration file
shown below, and you can also embed the endpoint into the `camelContext`
@@ -531,9 +521,7 @@ and setDefaultBus properties from spring configuration file.
</cxf:cxfEndpoint>
-------------------------------------------------------------------------
-[[CXF-ConfiguringtheCXFEndpointswithApacheAriesBlueprint.]]
-Configuring the CXF Endpoints with Apache Aries Blueprint.
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Configuring the CXF Endpoints with Apache Aries Blueprint.
Since camel 2.8 there is support for utilizing aries blueprint
dependency injection for your CXF endpoints.
@@ -609,9 +597,7 @@ You can also use the bean references just as in spring
</blueprint>
----------------------------------------------------------------------------------------------------------------
-[[CXF-Howtomakethecamel-cxfcomponentuselog4jinsteadofjava.util.logging]]
-How to make the camel-cxf component use log4j instead of java.util.logging
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### How to make the camel-cxf component use log4j instead of java.util.logging
CXF's default logger is `java.util.logging`. If you want to change it to
log4j, proceed as follows. Create a file, in the classpath, named
@@ -620,9 +606,7 @@ fully-qualified name of the class,
`org.apache.cxf.common.logging.Log4jLogger`, with no comments, on a
single line.
-[[CXF-Howtoletcamel-cxfresponsemessagewithxmlstartdocument]]
-How to let camel-cxf response message with xml start document
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### How to let camel-cxf response message with xml start document
If you are using some SOAP client such as PHP, you will get this kind of
error, because CXF doesn't add the XML start document "<?xml
@@ -650,9 +634,7 @@ Or adding a message header for it like this if you are using *Camel
exchange.getOut().setHeader(Client.RESPONSE_CONTEXT, map);
-------------------------------------------------------------------
-[[CXF-HowtooverridetheCXFproduceraddressfrommessageheader]]
-How to override the CXF producer address from message header
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### How to override the CXF producer address from message header
The�`camel-cxf`�producer supports to override the services address by
setting the message with the key of "CamelDestinationOverrideUrl".
@@ -663,9 +645,7 @@ setting the message with the key of "CamelDestinationOverrideUrl".
exchange.getIn().setHeader(Exchange.DESTINATION_OVERRIDE_URL, constant(getServiceAddress()));
----------------------------------------------------------------------------------------------
-[[CXF-Howtoconsumeamessagefromacamel-cxfendpointinPOJOdataformat]]
-How to consume a message from a camel-cxf endpoint in POJO data format
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### How to consume a message from a camel-cxf endpoint in POJO data format
The `camel-cxf` endpoint consumer POJO data format is based on the
http://cwiki.apache.org/CXF20DOC/invokers.html[cxf invoker], so the
@@ -673,9 +653,7 @@ message header has a property with the name of
`CxfConstants.OPERATION_NAME` and the message body is a list of the SEI
method parameters.
-[[CXF-Howtopreparethemessageforthecamel-cxfendpointinPOJOdataformat]]
-How to prepare the message for the camel-cxf endpoint in POJO data format
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### How to prepare the message for the camel-cxf endpoint in POJO data format
The `camel-cxf` endpoint producer is based on the
https://svn.apache.org/repos/asf/cxf/trunk/api/src/main/java/org/apache/cxf/endpoint/Client.java[cxf
@@ -693,9 +671,7 @@ list.
If you want to get the object array from the message body, you can get
the body using `message.getbody(Object[].class)`, as follows:
-[[CXF-Howtodealwiththemessageforacamel-cxfendpointinPAYLOADdataformat]]
-How to deal with the message for a camel-cxf endpoint in PAYLOAD data format
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### How to deal with the message for a camel-cxf endpoint in PAYLOAD data format
`PAYLOAD` means that you process the payload message from the SOAP
envelope. You can use the `Header.HEADER_LIST` as the key to set or get
@@ -706,9 +682,7 @@ elements.
for SOAP message headers and Body elements. This change enables
decoupling the native CXF message from the Camel message.
-[[CXF-HowtogetandsetSOAPheadersinPOJOmode]]
-How to get and set SOAP headers in POJO mode
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### How to get and set SOAP headers in POJO mode
`POJO` means that the data format is a "list of Java objects" when the
Camel-cxf endpoint produces or consumes Camel exchanges. Even though
@@ -737,9 +711,7 @@ InsertResponseOutHeaderProcessor and InsertRequestOutHeaderProcessor are
actually the same. The only difference between the two processors is
setting the direction of the inserted SOAP header.
-[[CXF-HowtogetandsetSOAPheadersinPAYLOADmode]]
-How to get and set SOAP headers in PAYLOAD mode
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### How to get and set SOAP headers in PAYLOAD mode
We've already shown how to access SOAP message (CxfPayload object) in
PAYLOAD mode (See "How to deal with the message for a camel-cxf endpoint
@@ -760,16 +732,12 @@ forwarded to the CXF service. If you do not want that these headers are
forwarded you have to remove them in the Camel header
"org.apache.cxf.headers.Header.list".
-[[CXF-SOAPheadersarenotavailableinMESSAGEmode]]
-SOAP headers are not available in MESSAGE mode
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### SOAP headers are not available in MESSAGE mode
SOAP headers are not available in MESSAGE mode as SOAP processing is
skipped.
-[[CXF-HowtothrowaSOAPFaultfromCamel]]
-How to throw a SOAP Fault from Camel
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### How to throw a SOAP Fault from Camel
If you are using a `camel-cxf` endpoint to consume the SOAP request, you
may need to throw the SOAP Fault from the camel context. +
@@ -786,9 +754,7 @@ code in the message header.
Same for using POJO data format. You can set the SOAPFault on the out
body and also indicate it's a fault by calling Message.setFault(true):
-[[CXF-Howtopropagateacamel-cxfendpointrequestandresponsecontext]]
-How to propagate a camel-cxf endpoint's request and response context
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### How to propagate a camel-cxf endpoint's request and response context
https://svn.apache.org/repos/asf/cxf/trunk/api/src/main/java/org/apache/cxf/endpoint/Client.java[cxf
client API] provides a way to invoke the operation with request and
@@ -821,9 +787,7 @@ response context with the following code:
responseContext.get("javax.xml.ws.wsdl.operation").toString());
-------------------------------------------------------------------------------------------------------------
-[[CXF-AttachmentSupport]]
-Attachment Support
-^^^^^^^^^^^^^^^^^^
+### Attachment Support
*POJO Mode:* Both SOAP with Attachment and MTOM are supported (see
example in Payload Mode for enabling MTOM).� However, SOAP with
@@ -864,9 +828,7 @@ you require just the SOAP XML as a String, you can set the message body
with message.getSOAPPart(), and Camel convert can do the rest of work
for you.
-[[CXF-StreamingSupportinPAYLOADmode]]
-Streaming Support in PAYLOAD mode
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Streaming Support in PAYLOAD mode
In 2.8.2, the camel-cxf component now supports streaming of incoming
messages when using PAYLOAD mode. Previously, the incoming messages
@@ -898,9 +860,7 @@ Global system property: you can add a system property of
That sets the global default, but setting the endpoint property above
will override this value for that endpoint.
-[[CXF-UsingthegenericCXFDispatchmode]]
-Using the generic CXF Dispatch mode
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Using the generic CXF Dispatch mode
From 2.8.0, the camel-cxf component supports the generic
https://cxf.apache.org/docs/jax-ws-dispatch-api.html[CXF dispatch
@@ -924,12 +884,9 @@ the key SOAPAction (case-insensitive).
�
-[[CXF-SeeAlso]]
-See Also
-^^^^^^^^
+### See Also
* link:configuring-camel.html[Configuring Camel]
* link:component.html[Component]
* link:endpoint.html[Endpoint]
-* link:getting-started.html[Getting Started]
-
+* link:getting-started.html[Getting Started]
\ No newline at end of file