Component docs
Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/cebeb220 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/cebeb220 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/cebeb220 Branch: refs/heads/master Commit: cebeb22059dc6221305d27056924f9088883d330 Parents: a3d22b3 Author: Claus Ibsen <davscl...@apache.org> Authored: Tue Mar 8 08:26:11 2016 +0100 Committer: Claus Ibsen <davscl...@apache.org> Committed: Tue Mar 8 08:26:11 2016 +0100 ---------------------------------------------------------------------- components/camel-ahc/src/main/docs/ahc.adoc | 3 +++ components/camel-etcd/src/main/docs/etcd.adoc | 8 ++------ components/camel-ironmq/src/main/docs/ironmq.adoc | 12 +++++------- components/camel-jcache/src/main/docs/jcache.adoc | 8 ++------ components/camel-twitter/src/main/docs/twitter.adoc | 3 +++ .../camel-xmlsecurity/src/main/docs/xmlsecurity.adoc | 3 +++ components/camel-yammer/src/main/docs/yammer.adoc | 3 +++ 7 files changed, 21 insertions(+), 19 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/cebeb220/components/camel-ahc/src/main/docs/ahc.adoc ---------------------------------------------------------------------- diff --git a/components/camel-ahc/src/main/docs/ahc.adoc b/components/camel-ahc/src/main/docs/ahc.adoc index b4b87f8..79c63f3 100644 --- a/components/camel-ahc/src/main/docs/ahc.adoc +++ b/components/camel-ahc/src/main/docs/ahc.adoc @@ -82,10 +82,12 @@ AhcComponent Options + // component options: START The AHC component supports 6 options which are listed below. + [width="100%",cols="2s,1m,8",options="header"] |======================================================================= | Name | Java Type | Description @@ -103,6 +105,7 @@ The AHC component supports 6 options which are listed below. + Notice that setting any of the options on the `AhcComponent` will propagate those options to `AhcEndpoints` being created. However the `AhcEndpoint` can also http://git-wip-us.apache.org/repos/asf/camel/blob/cebeb220/components/camel-etcd/src/main/docs/etcd.adoc ---------------------------------------------------------------------- diff --git a/components/camel-etcd/src/main/docs/etcd.adoc b/components/camel-etcd/src/main/docs/etcd.adoc index 9ed8475..d19db9f 100644 --- a/components/camel-etcd/src/main/docs/etcd.adoc +++ b/components/camel-etcd/src/main/docs/etcd.adoc @@ -39,13 +39,9 @@ The etcd component supports 14 endpoint options which are listed below: + // component options: START The etcd component has no options. - - -[width="100%",cols="2s,1m,8",options="header"] -|======================================================================= -| Name | Java Type | Description -|======================================================================= // component options: END + http://git-wip-us.apache.org/repos/asf/camel/blob/cebeb220/components/camel-ironmq/src/main/docs/ironmq.adoc ---------------------------------------------------------------------- diff --git a/components/camel-ironmq/src/main/docs/ironmq.adoc b/components/camel-ironmq/src/main/docs/ironmq.adoc index 4682a34..70961bf 100644 --- a/components/camel-ironmq/src/main/docs/ironmq.adoc +++ b/components/camel-ironmq/src/main/docs/ironmq.adoc @@ -41,6 +41,7 @@ Options + // endpoint options: START The ironmq component supports 31 endpoint options which are listed below: @@ -49,7 +50,7 @@ The ironmq component supports 31 endpoint options which are listed below: | Name | Group | Default | Java Type | Description | queueName | common | | String | *Required* The name of the IronMQ queue | client | common | | Client | Reference to a io.iron.ironmq.Client in the Registry. -| ironMQCloud | common | https://mq-aws-us-east-1-1.iron.io | String | IronMq Cloud url. Urls for public clusters: mq-aws-us-east-1-1.iron.io (US), mq-aws-eu-west-1-1.iron.io (EU) +| ironMQCloud | common | https://mq-aws-us-east-1-1.iron.io | String | IronMq Cloud url. Urls for public clusters: mq-aws-us-east-1-1.iron.io (US) mq-aws-eu-west-1-1.iron.io (EU) | preserveHeaders | common | false | boolean | Should message headers be preserved when publishing messages. This will add the Camel headers to the Iron MQ message as a json payload with a header list and a message body. Useful when Camel is both consumer and producer. | projectId | common | | String | IronMQ projectId | token | common | | String | IronMQ token @@ -82,25 +83,22 @@ The ironmq component supports 31 endpoint options which are listed below: // endpoint options: END + [[IronMQ-IronMQComponentOptions]] IronMQComponent Options ^^^^^^^^^^^^^^^^^^^^^^^ + // component options: START The ironmq component has no options. - - -[width="100%",cols="2s,1m,8",options="header"] -|======================================================================= -| Name | Java Type | Description -|======================================================================= // component options: END + [[IronMQ-Messagebody]] Message Body ^^^^^^^^^^^^ http://git-wip-us.apache.org/repos/asf/camel/blob/cebeb220/components/camel-jcache/src/main/docs/jcache.adoc ---------------------------------------------------------------------- diff --git a/components/camel-jcache/src/main/docs/jcache.adoc b/components/camel-jcache/src/main/docs/jcache.adoc index 5defa57..97b5652 100644 --- a/components/camel-jcache/src/main/docs/jcache.adoc +++ b/components/camel-jcache/src/main/docs/jcache.adoc @@ -19,13 +19,9 @@ The JCache component supports 5 endpoint options which are listed below: + // component options: START The JCache component has no options. - - -[width="100%",cols="2s,1m,8",options="header"] -|======================================================================= -| Name | Java Type | Description -|======================================================================= // component options: END + http://git-wip-us.apache.org/repos/asf/camel/blob/cebeb220/components/camel-twitter/src/main/docs/twitter.adoc ---------------------------------------------------------------------- diff --git a/components/camel-twitter/src/main/docs/twitter.adoc b/components/camel-twitter/src/main/docs/twitter.adoc index 6a056e6..f192845 100644 --- a/components/camel-twitter/src/main/docs/twitter.adoc +++ b/components/camel-twitter/src/main/docs/twitter.adoc @@ -46,10 +46,12 @@ The twitter component can be configured with the Twitter account settings which is mandatory to configure before using. + // component options: START The Twitter component supports 8 options which are listed below. + [width="100%",cols="2s,1m,8",options="header"] |======================================================================= | Name | Java Type | Description @@ -65,6 +67,7 @@ The Twitter component supports 8 options which are listed below. // component options: END + You can also configure these options directly in the endpoint. [[Twitter-ConsumerEndpoints]] http://git-wip-us.apache.org/repos/asf/camel/blob/cebeb220/components/camel-xmlsecurity/src/main/docs/xmlsecurity.adoc ---------------------------------------------------------------------- diff --git a/components/camel-xmlsecurity/src/main/docs/xmlsecurity.adoc b/components/camel-xmlsecurity/src/main/docs/xmlsecurity.adoc index f50f9a0..7978402 100644 --- a/components/camel-xmlsecurity/src/main/docs/xmlsecurity.adoc +++ b/components/camel-xmlsecurity/src/main/docs/xmlsecurity.adoc @@ -230,10 +230,12 @@ Signatures as Siblings of the Signed Elements". Component Options ^^^^^^^^^^^^^^^^ + // component options: START The XML Security component supports 2 options which are listed below. + [width="100%",cols="2s,1m,8",options="header"] |======================================================================= | Name | Java Type | Description @@ -243,6 +245,7 @@ The XML Security component supports 2 options which are listed below. // component options: END + [[XMLSecuritycomponent-EndpointOptions]] Endpoint Options ^^^^^^^^^^^^^^^^ http://git-wip-us.apache.org/repos/asf/camel/blob/cebeb220/components/camel-yammer/src/main/docs/yammer.adoc ---------------------------------------------------------------------- diff --git a/components/camel-yammer/src/main/docs/yammer.adoc b/components/camel-yammer/src/main/docs/yammer.adoc index 3527666..cd5dd20 100644 --- a/components/camel-yammer/src/main/docs/yammer.adoc +++ b/components/camel-yammer/src/main/docs/yammer.adoc @@ -43,10 +43,12 @@ Component options The Yammer component can be configured with the Yammer account settings which are mandatory to configure before using. + // component options: START The Yammer component supports 4 options which are listed below. + [width="100%",cols="2s,1m,8",options="header"] |======================================================================= | Name | Java Type | Description @@ -57,6 +59,7 @@ The Yammer component supports 4 options which are listed below. |======================================================================= // component options: END + You can also configure these options directly in the endpoint. [[Yammer-EndpointOptions]]
