http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-yammer/src/main/docs/yammer-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-yammer/src/main/docs/yammer-component.adoc b/components/camel-yammer/src/main/docs/yammer-component.adoc index 1ee132c..ad2e754 100644 --- a/components/camel-yammer/src/main/docs/yammer-component.adoc +++ b/components/camel-yammer/src/main/docs/yammer-component.adoc @@ -1,4 +1,4 @@ -## Yammer Component +== Yammer Component *Available as of Camel version 2.12* @@ -46,14 +46,14 @@ The Yammer component supports 5 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **consumerKey** (security) | The consumer key | | String -| **consumerSecret** (security) | The consumer secret | | String -| **accessToken** (security) | The access token | | String -| **config** (advanced) | To use a shared yammer configuration | | YammerConfiguration -| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean -|======================================================================= +| *consumerKey* (security) | The consumer key | | String +| *consumerSecret* (security) | The consumer secret | | String +| *accessToken* (security) | The access token | | String +| *config* (advanced) | To use a shared yammer configuration | | YammerConfiguration +| *resolveProperty Placeholders* (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean +|=== // component options: END @@ -68,52 +68,54 @@ You can also configure these options directly in the endpoint. // endpoint options: START The Yammer endpoint is configured using URI syntax: - yammer:function +---- +yammer:function +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **function** | *Required* The function to use | | YammerFunctionType -|======================================================================= +| *function* | *Required* The function to use | | YammerFunctionType +|=== -#### Query Parameters (28 parameters): +==== Query Parameters (28 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **useJson** (common) | Set to true if you want to use raw JSON rather than converting to POJOs. | false | boolean -| **bridgeErrorHandler** (consumer) | 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 or ERROR level and ignored. | false | boolean -| **delay** (consumer) | Delay between polling in millis | 5000 | long -| **limit** (consumer) | Return only the specified number of messages. Works for threaded=true and threaded=extended. | -1 | int -| **newerThan** (consumer) | Returns messages newer than the message ID specified as a numeric string. This should be used when polling for new messages. If you're looking at messages and the most recent message returned is 3516 you can make a request with the parameter newerThan=3516 to ensure that you do not get duplicate copies of messages already on your page. | -1 | int -| **olderThan** (consumer) | Returns messages older than the message ID specified as a numeric string. This is useful for paginating messages. For example if you're currently viewing 20 messages and the oldest is number 2912 you could append olderThan=2912 to your request to get the 20 messages prior to those you're seeing. | -1 | int -| **sendEmptyMessageWhenIdle** (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean -| **threaded** (consumer) | threaded=true will only return the first message in each thread. This parameter is intended for apps which display message threads collapsed. threaded=extended will return the thread starter messages in order of most recently active as well as the two most recent messages as they are viewed in the default view on the Yammer web interface. | | String -| **userId** (consumer) | The user id | | String -| **exceptionHandler** (consumer) | 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 or ERROR level and ignored. | | ExceptionHandler -| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern -| **pollStrategy** (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int -| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int -| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int -| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean -| **initialDelay** (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long -| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel -| **scheduledExecutorService** (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service -| **scheduler** (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler -| **schedulerProperties** (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map -| **startScheduler** (scheduler) | Whether the scheduler should be auto started. | true | boolean -| **timeUnit** (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit -| **useFixedDelay** (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean -| **accessToken** (security) | *Required* The access token | | String -| **consumerKey** (security) | *Required* The consumer key | | String -| **consumerSecret** (security) | *Required* The consumer secret | | String -|======================================================================= +| *useJson* (common) | Set to true if you want to use raw JSON rather than converting to POJOs. | false | boolean +| *bridgeErrorHandler* (consumer) | 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 or ERROR level and ignored. | false | boolean +| *delay* (consumer) | Delay between polling in millis | 5000 | long +| *limit* (consumer) | Return only the specified number of messages. Works for threaded=true and threaded=extended. | -1 | int +| *newerThan* (consumer) | Returns messages newer than the message ID specified as a numeric string. This should be used when polling for new messages. If you're looking at messages and the most recent message returned is 3516 you can make a request with the parameter newerThan=3516 to ensure that you do not get duplicate copies of messages already on your page. | -1 | int +| *olderThan* (consumer) | Returns messages older than the message ID specified as a numeric string. This is useful for paginating messages. For example if you're currently viewing 20 messages and the oldest is number 2912 you could append olderThan=2912 to your request to get the 20 messages prior to those you're seeing. | -1 | int +| *sendEmptyMessageWhenIdle* (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean +| *threaded* (consumer) | threaded=true will only return the first message in each thread. This parameter is intended for apps which display message threads collapsed. threaded=extended will return the thread starter messages in order of most recently active as well as the two most recent messages as they are viewed in the default view on the Yammer web interface. | | String +| *userId* (consumer) | The user id | | String +| *exceptionHandler* (consumer) | 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 or ERROR level and ignored. | | ExceptionHandler +| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| *pollStrategy* (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *backoffErrorThreshold* (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int +| *backoffIdleThreshold* (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int +| *backoffMultiplier* (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int +| *greedy* (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean +| *initialDelay* (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long +| *runLoggingLevel* (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel +| *scheduledExecutorService* (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service +| *scheduler* (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler +| *schedulerProperties* (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map +| *startScheduler* (scheduler) | Whether the scheduler should be auto started. | true | boolean +| *timeUnit* (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit +| *useFixedDelay* (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean +| *accessToken* (security) | *Required* The access token | | String +| *consumerKey* (security) | *Required* The consumer key | | String +| *consumerSecret* (security) | *Required* The consumer secret | | String +|=== // endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-zendesk/src/main/docs/zendesk-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-zendesk/src/main/docs/zendesk-component.adoc b/components/camel-zendesk/src/main/docs/zendesk-component.adoc index 6c135bc..4406621 100644 --- a/components/camel-zendesk/src/main/docs/zendesk-component.adoc +++ b/components/camel-zendesk/src/main/docs/zendesk-component.adoc @@ -1,4 +1,4 @@ -## Zendesk Component +== Zendesk Component *Available as of Camel version 2.19* @@ -26,45 +26,47 @@ The Zendesk component supports 3 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **configuration** (common) | To use the shared configuration | | ZendeskConfiguration -| **zendesk** (advanced) | To use a shared Zendesk instance. | | Zendesk -| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean -|======================================================================= +| *configuration* (common) | To use the shared configuration | | ZendeskConfiguration +| *zendesk* (advanced) | To use a shared Zendesk instance. | | Zendesk +| *resolveProperty Placeholders* (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean +|=== // component options: END // endpoint options: START The Zendesk endpoint is configured using URI syntax: - zendesk:methodName +---- +zendesk:methodName +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **methodName** | *Required* What operation to use | | String -|======================================================================= +| *methodName* | *Required* What operation to use | | String +|=== -#### Query Parameters (10 parameters): +==== Query Parameters (10 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **inBody** (common) | Sets the name of a parameter to be passed in the exchange In Body | | String -| **serverUrl** (common) | The server URL to connect. | | String -| **bridgeErrorHandler** (consumer) | 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 or ERROR level and ignored. | false | boolean -| **exceptionHandler** (consumer) | 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 or ERROR level and ignored. | | ExceptionHandler -| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **oauthToken** (security) | The OAuth token. | | String -| **password** (security) | The password. | | String -| **token** (security) | The security token. | | String -| **username** (security) | The user name. | | String -|======================================================================= +| *inBody* (common) | Sets the name of a parameter to be passed in the exchange In Body | | String +| *serverUrl* (common) | The server URL to connect. | | String +| *bridgeErrorHandler* (consumer) | 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 or ERROR level and ignored. | false | boolean +| *exceptionHandler* (consumer) | 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 or ERROR level and ignored. | | ExceptionHandler +| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *oauthToken* (security) | The OAuth token. | | String +| *password* (security) | The password. | | String +| *token* (security) | The security token. | | String +| *username* (security) | The user name. | | String +|=== // endpoint options: END ### URI format @@ -105,4 +107,3 @@ the arugument name of each API methods on the original `org.zendesk.client.v2.Ze All result message bodies utilize objects provided by the Zendesk Java Client. Producer endpoints can specify the option name for incoming message body in the *inBody* endpoint parameter. - http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-zipfile/src/main/docs/zipfile-dataformat.adoc ---------------------------------------------------------------------- diff --git a/components/camel-zipfile/src/main/docs/zipfile-dataformat.adoc b/components/camel-zipfile/src/main/docs/zipfile-dataformat.adoc index 96806e6..d40512f 100644 --- a/components/camel-zipfile/src/main/docs/zipfile-dataformat.adoc +++ b/components/camel-zipfile/src/main/docs/zipfile-dataformat.adoc @@ -1,4 +1,4 @@ -## Zip File DataFormat +== Zip File DataFormat *Available as of Camel version 2.11* @@ -22,12 +22,12 @@ The Zip File dataformat supports 3 options which are listed below. [width="100%",cols="2s,1m,1m,6",options="header"] -|======================================================================= +|=== | Name | Default | Java Type | Description | usingIterator | false | Boolean | If the zip file has more then one entry the setting this option to true allows to work with the splitter EIP to split the data using an iterator in a streaming mode. | allowEmptyDirectory | false | Boolean | If the zip file has more then one entry setting this option to true allows to get the iterator even if the directory is empty | contentTypeHeader | false | Boolean | Whether the data format should set the Content-Type header with the type from the data format if the data format is capable of doing so. For example application/xml for data formats marshalling to XML or application/json for data formats marshalling to JSon etc. -|======================================================================= +|=== // dataformat options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-zookeeper-master/src/main/docs/zookeeper-master-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-zookeeper-master/src/main/docs/zookeeper-master-component.adoc b/components/camel-zookeeper-master/src/main/docs/zookeeper-master-component.adoc index b2f1fbe..c0696a6 100644 --- a/components/camel-zookeeper-master/src/main/docs/zookeeper-master-component.adoc +++ b/components/camel-zookeeper-master/src/main/docs/zookeeper-master-component.adoc @@ -1,4 +1,4 @@ -## ZooKeeper Master Component +== ZooKeeper Master Component *Available as of Camel version 2.19* @@ -38,44 +38,46 @@ The ZooKeeper Master component supports 7 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **containerIdFactory** (consumer) | To use a custom ContainerIdFactory for creating container ids. | | ContainerIdFactory -| **zkRoot** (consumer) | The root path to use in zookeeper where information is stored which nodes are master/slave etc. Will by default use: /camel/zookeepermaster/clusters/master | /camel/zookeepermaster/clusters/master | String -| **curator** (advanced) | To use a custom configured CuratorFramework as connection to zookeeper ensemble. | | CuratorFramework -| **maximumConnection Timeout** (consumer) | Timeout in millis to use when connecting to the zookeeper ensemble | 10000 | int -| **zooKeeperUrl** (consumer) | The url for the zookeeper ensemble | localhost:2181 | String -| **zooKeeperPassword** (security) | The password to use when connecting to the zookeeper ensemble | | String -| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean -|======================================================================= +| *containerIdFactory* (consumer) | To use a custom ContainerIdFactory for creating container ids. | | ContainerIdFactory +| *zkRoot* (consumer) | The root path to use in zookeeper where information is stored which nodes are master/slave etc. Will by default use: /camel/zookeepermaster/clusters/master | /camel/zookeepermaster/clusters/master | String +| *curator* (advanced) | To use a custom configured CuratorFramework as connection to zookeeper ensemble. | | CuratorFramework +| *maximumConnection Timeout* (consumer) | Timeout in millis to use when connecting to the zookeeper ensemble | 10000 | int +| *zooKeeperUrl* (consumer) | The url for the zookeeper ensemble | localhost:2181 | String +| *zooKeeperPassword* (security) | The password to use when connecting to the zookeeper ensemble | | String +| *resolveProperty Placeholders* (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean +|=== // component options: END // endpoint options: START The ZooKeeper Master endpoint is configured using URI syntax: - zookeeper-master:groupName:consumerEndpointUri +---- +zookeeper-master:groupName:consumerEndpointUri +---- with the following path and query parameters: -#### Path Parameters (2 parameters): +==== Path Parameters (2 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **groupName** | *Required* The name of the cluster group to use | | String -| **consumerEndpointUri** | *Required* The consumer endpoint to use in master/slave mode | | String -|======================================================================= +| *groupName* | *Required* The name of the cluster group to use | | String +| *consumerEndpointUri* | *Required* The consumer endpoint to use in master/slave mode | | String +|=== -#### Query Parameters (4 parameters): +==== Query Parameters (4 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **bridgeErrorHandler** (consumer) | 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 or ERROR level and ignored. | false | boolean -| **exceptionHandler** (consumer) | 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 or ERROR level and ignored. | | ExceptionHandler -| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *bridgeErrorHandler* (consumer) | 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 or ERROR level and ignored. | false | boolean +| *exceptionHandler* (consumer) | 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 or ERROR level and ignored. | | ExceptionHandler +| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +|=== // endpoint options: END ### Example http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-zookeeper/src/main/docs/zookeeper-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-zookeeper/src/main/docs/zookeeper-component.adoc b/components/camel-zookeeper/src/main/docs/zookeeper-component.adoc index c0bd6f1..d338524 100644 --- a/components/camel-zookeeper/src/main/docs/zookeeper-component.adoc +++ b/components/camel-zookeeper/src/main/docs/zookeeper-component.adoc @@ -1,4 +1,4 @@ -## ZooKeeper Component +== ZooKeeper Component *Available as of Camel version 2.9* @@ -46,47 +46,49 @@ The ZooKeeper component supports 2 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **configuration** (advanced) | To use a shared ZooKeeperConfiguration | | ZooKeeperConfiguration -| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean -|======================================================================= +| *configuration* (advanced) | To use a shared ZooKeeperConfiguration | | ZooKeeperConfiguration +| *resolveProperty Placeholders* (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean +|=== // component options: END // endpoint options: START The ZooKeeper endpoint is configured using URI syntax: - zookeeper:serverUrls/path +---- +zookeeper:serverUrls/path +---- with the following path and query parameters: -#### Path Parameters (2 parameters): +==== Path Parameters (2 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **serverUrls** | *Required* The zookeeper server hosts (multiple servers can be separated by comma) | | String -| **path** | *Required* The node in the ZooKeeper server (aka znode) | | String -|======================================================================= +| *serverUrls* | *Required* The zookeeper server hosts (multiple servers can be separated by comma) | | String +| *path* | *Required* The node in the ZooKeeper server (aka znode) | | String +|=== -#### Query Parameters (12 parameters): +==== Query Parameters (12 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **awaitExistence** (common) | *Deprecated* Not in use | true | boolean -| **listChildren** (common) | Whether the children of the node should be listed | false | boolean -| **timeout** (common) | The time interval to wait on connection before timing out. | 5000 | int -| **backoff** (consumer) | The time interval to backoff for after an error before retrying. | 5000 | long -| **bridgeErrorHandler** (consumer) | 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 or ERROR level and ignored. | false | boolean -| **repeat** (consumer) | Should changes to the znode be 'watched' and repeatedly processed. | false | boolean -| **sendEmptyMessageOnDelete** (consumer) | Upon the delete of a znode should an empty message be send to the consumer | true | boolean -| **exceptionHandler** (consumer) | 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 or ERROR level and ignored. | | ExceptionHandler -| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern -| **create** (producer) | Should the endpoint create the node if it does not currently exist. | false | boolean -| **createMode** (producer) | The create mode that should be used for the newly created node | EPHEMERAL | String -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *awaitExistence* (common) | *Deprecated* Not in use | true | boolean +| *listChildren* (common) | Whether the children of the node should be listed | false | boolean +| *timeout* (common) | The time interval to wait on connection before timing out. | 5000 | int +| *backoff* (consumer) | The time interval to backoff for after an error before retrying. | 5000 | long +| *bridgeErrorHandler* (consumer) | 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 or ERROR level and ignored. | false | boolean +| *repeat* (consumer) | Should changes to the znode be 'watched' and repeatedly processed. | false | boolean +| *sendEmptyMessageOnDelete* (consumer) | Upon the delete of a znode should an empty message be send to the consumer | true | boolean +| *exceptionHandler* (consumer) | 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 or ERROR level and ignored. | | ExceptionHandler +| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| *create* (producer) | Should the endpoint create the node if it does not currently exist. | false | boolean +| *createMode* (producer) | The create mode that should be used for the newly created node | EPHEMERAL | String +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/readme.adoc ---------------------------------------------------------------------- diff --git a/components/readme.adoc b/components/readme.adoc index e897a8e..1bfc5eb 100644 --- a/components/readme.adoc +++ b/components/readme.adoc @@ -5,7 +5,7 @@ Components Number of Components: 280 in 192 JAR artifacts (17 deprecated) [width="100%",cols="4,1,5",options="header"] -|======================================================================= +|=== | Component | Available From | Description | link:camel-ahc/src/main/docs/ahc-component.adoc[AHC] (camel-ahc) + @@ -848,7 +848,7 @@ Number of Components: 280 in 192 JAR artifacts (17 deprecated) | link:camel-zookeeper-master/src/main/docs/zookeeper-master-component.adoc[ZooKeeper Master] (camel-zookeeper-master) + `zookeeper-master:groupName:consumerEndpointUri` | 2.19 | Represents an endpoint which only becomes active when it obtains the master lock -|======================================================================= +|=== // components: END @@ -859,7 +859,7 @@ Data Formats Number of Data Formats: 48 in 39 JAR artifacts (0 deprecated) [width="100%",cols="4,1,5",options="header"] -|======================================================================= +|=== | Data Format | Available From | Description | link:camel-asn1/src/main/docs/asn1-dataformat.adoc[ASN.1 File] (camel-asn1) | 2.20 | Camel ASN.1 support @@ -957,7 +957,7 @@ Number of Data Formats: 48 in 39 JAR artifacts (0 deprecated) | link:../camel-core/src/main/docs/zip-dataformat.adoc[Zip Deflate Compression] (camel-core) | 2.12 | Zip compression data format (not for zip files) | link:camel-zipfile/src/main/docs/zipfile-dataformat.adoc[Zip File] (camel-zipfile) | 2.11 | Camel Zip file support -|======================================================================= +|=== // dataformats: END @@ -968,7 +968,7 @@ Expression Languages Number of Languages: 24 in 12 JAR artifacts (6 deprecated) [width="100%",cols="4,1,5",options="header"] -|======================================================================= +|=== | Language | Available From | Description | link:../camel-core/src/main/docs/bean-language.adoc[Bean method] (camel-core) | 1.3 | For expressions and predicates using a java bean (aka method call) @@ -1018,7 +1018,7 @@ Number of Languages: 24 in 12 JAR artifacts (6 deprecated) | link:../camel-core/src/main/docs/xpath-language.adoc[XPath] (camel-core) | 1.1 | For XPath expressions and predicates | link:camel-saxon/src/main/docs/xquery-language.adoc[XQuery] (camel-saxon) | 1.0 | For XQuery expressions and predicates -|======================================================================= +|=== // languages: END @@ -1029,7 +1029,7 @@ Miscellaneous Components Number of Miscellaneous Components: 37 in 37 JAR artifacts (13 deprecated) [width="100%",cols="4,1,5",options="header"] -|======================================================================= +|=== | Component | Available From | Description | link:camel-bam/src/main/docs/bam.adoc[BAM] (camel-bam) | 1.0 | *deprecated* Business Activity Monitoring @@ -1105,6 +1105,6 @@ Number of Miscellaneous Components: 37 in 37 JAR artifacts (13 deprecated) | link:camel-urlrewrite/src/main/docs/urlrewrite.adoc[URLRewrite] (camel-urlrewrite) | 2.11 | *deprecated* URL rewrite support for HTTP components | link:camel-zipkin/src/main/docs/zipkin.adoc[Zipkin] (camel-zipkin) | 2.18 | Distributed message tracing using Zipkin -|======================================================================= +|=== // others: END
