CAMEL-9987: Add Asciidoc documentation
Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/78d46fd8 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/78d46fd8 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/78d46fd8 Branch: refs/heads/master Commit: 78d46fd8ff027c03f4663ae8a42bf621cf740bfd Parents: cc1b73c Author: lburgazzoli <lburgazz...@gmail.com> Authored: Tue May 24 11:47:36 2016 +0200 Committer: lburgazzoli <lburgazz...@gmail.com> Committed: Tue May 24 11:49:43 2016 +0200 ---------------------------------------------------------------------- .../camel-consul/src/main/docs/consul.adoc | 104 +++++++++++++++++++ 1 file changed, 104 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/78d46fd8/components/camel-consul/src/main/docs/consul.adoc ---------------------------------------------------------------------- diff --git a/components/camel-consul/src/main/docs/consul.adoc b/components/camel-consul/src/main/docs/consul.adoc new file mode 100644 index 0000000..776c26a --- /dev/null +++ b/components/camel-consul/src/main/docs/consul.adoc @@ -0,0 +1,104 @@ +[[Consul-ConsulComponent]] +Consul Component +~~~~~~~~~~~~~~~~~~~~ + +*Available as of Camel 2.18* + +The *Consul* component is a component for integrating your application with Consul. + +Maven users will need to add the following dependency to their pom.xml +for this component: + +[source,java] +------------------------------------------------- + <dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-consul</artifactId> + <version>${camel-version}</version> + </dependency> +------------------------------------------------- + +[[Consul-URIformat]] +URI format +^^^^^^^^^^ + +[source,java] +--------------------------------------- + consul://domain?[options] +--------------------------------------- + +You can append query options to the URI in the following format: + +--------------------------------------- + ?option=value&option=value&... +--------------------------------------- + +[[Consul-Options]] +Options +^^^^^^^ + + + + +// component options: START +The Consul component has no options. +// component options: END + + + +// endpoint options: START +The Consul component supports 20 endpoint options which are listed below: + +{% raw %} +[width="100%",cols="2s,1,1m,1m,5",options="header"] +|======================================================================= +| Name | Group | Default | Java Type | Description +| apiEndpoint | common | | String | *Required* The API endpoint +| connectTimeoutMillis | common | | Long | Connect timeout for OkHttpClient +| key | common | | String | The default action. Can be overridden by CamelConsulKey +| pingInstance | common | true | boolean | Configure if the AgentClient should attempt a ping before returning the Consul instance +| readTimeoutMillis | common | | Long | Read timeout for OkHttpClient +| url | common | | String | The Consul agent URL +| writeTimeoutMillis | common | | Long | Write timeout for OkHttpClient +| bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored. +| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. +| action | producer | | String | The default action. Can be overridden by CamelConsulAction +| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange +| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| blockSeconds | watch | 10 | Integer | The second to wait for a watch event default 10 seconds +| firstIndex | watch | 0 | long | The first index for watch for default 0 +| recursive | watch | false | boolean | Recursively watch default false +| valueAsString | kv | false | boolean | Default to transform values retrieved from Consul i.e. on KV endpoint to string. +| aclToken | security | | String | Sets the ACL token to be used with Consul +| password | security | | String | Sets the password to be used for basic authentication +| sslContextParameters | security | | SSLContextParameters | SSL configuration using an org.apache.camel.util.jsse.SSLContextParameters instance. +| userName | security | | String | Sets the username to be used for basic authentication +|======================================================================= +{% endraw %} +// endpoint options: END + +[[Consul-Headers]] +Headers +^^^^^^^ + +[width="100%",cols="10%,10%,80%",options="header",] +|======================================================================= +|Name |Type |Description +CamelConsulAction|String|The Producer action +CamelConsulKey|String|The Key on which the action should applied +CamelConsulEventId|String|The event id (consumer only) +CamelConsulEventName|String|The event name (consumer only) +CamelConsulEventLTime|Long|The event LTime +CamelConsulNodeFilter|String|The Node filter +CamelConsulTagFilter|String|The tag filter +CamelConsulSessionFilter|String|The session filter +CamelConsulVersion|int|The data version +CamelConsulFlags|Long|Flags associated with a value +CamelConsulCreateIndex|Long|The internal index value that represents when the entry was created +CamelConsulLockIndex|Long|The number of times this key has successfully been acquired in a lock +CamelConsulModifyIndex|Long|The last index that modified this key +CamelConsulOptions|Object|Options associated to the request +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. +|=======================================================================
