http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-hazelcast/src/main/docs/hazelcast-map-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-hazelcast/src/main/docs/hazelcast-map-component.adoc b/components/camel-hazelcast/src/main/docs/hazelcast-map-component.adoc index b0744a2..3e35036 100644 --- a/components/camel-hazelcast/src/main/docs/hazelcast-map-component.adoc +++ b/components/camel-hazelcast/src/main/docs/hazelcast-map-component.adoc @@ -1,4 +1,4 @@ -## Hazelcast Map Component +== Hazelcast Map Component *Available as of Camel version 2.7* @@ -13,50 +13,52 @@ The Hazelcast Map component supports 3 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **hazelcastInstance** (advanced) | The hazelcast instance reference which can be used for hazelcast endpoint. If you don't specify the instance reference camel use the default hazelcast instance from the camel-hazelcast instance. | | HazelcastInstance -| **hazelcastMode** (advanced) | The hazelcast mode reference which kind of instance should be used. If you don't specify the mode then the node mode will be the default. | node | 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 -|======================================================================= +| *hazelcastInstance* (advanced) | The hazelcast instance reference which can be used for hazelcast endpoint. If you don't specify the instance reference camel use the default hazelcast instance from the camel-hazelcast instance. | | HazelcastInstance +| *hazelcastMode* (advanced) | The hazelcast mode reference which kind of instance should be used. If you don't specify the mode then the node mode will be the default. | node | 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 Hazelcast Map endpoint is configured using URI syntax: - hazelcast-map:cacheName +---- +hazelcast-map:cacheName +---- 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 -| **cacheName** | *Required* The name of the cache | | String -|======================================================================= +| *cacheName* | *Required* The name of the cache | | String +|=== -#### Query Parameters (16 parameters): +==== Query Parameters (16 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **defaultOperation** (common) | To specify a default operation to use if no operation header has been provided. | | HazelcastOperation -| **hazelcastInstance** (common) | The hazelcast instance reference which can be used for hazelcast endpoint. | | HazelcastInstance -| **hazelcastInstanceName** (common) | The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference camel use the default hazelcast instance from the camel-hazelcast instance. | | String -| **reliable** (common) | Define if the endpoint will use a reliable Topic struct or not. | 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 -| **pollingTimeout** (consumer) | Define the polling timeout of the Queue consumer in Poll mode | 10000 | long -| **poolSize** (consumer) | Define the Pool size for Queue Consumer Executor | 1 | int -| **queueConsumerMode** (consumer) | Define the Queue Consumer mode: Listen or Poll | Listen | HazelcastQueueConsumer Mode -| **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 -| **concurrentConsumers** (seda) | To use concurrent consumers polling from the SEDA queue. | 1 | int -| **onErrorDelay** (seda) | Milliseconds before consumer continues polling after an error has occurred. | 1000 | int -| **pollTimeout** (seda) | The timeout used when consuming from the SEDA queue. When a timeout occurs the consumer can check whether it is allowed to continue running. Setting a lower value allows the consumer to react more quickly upon shutdown. | 1000 | int -| **transacted** (seda) | If set to true then the consumer runs in transaction mode where the messages in the seda queue will only be removed if the transaction commits which happens when the processing is complete. | false | boolean -| **transferExchange** (seda) | If set to true the whole Exchange will be transfered. If header or body contains not serializable objects they will be skipped. | false | boolean -|======================================================================= +| *defaultOperation* (common) | To specify a default operation to use if no operation header has been provided. | | HazelcastOperation +| *hazelcastInstance* (common) | The hazelcast instance reference which can be used for hazelcast endpoint. | | HazelcastInstance +| *hazelcastInstanceName* (common) | The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference camel use the default hazelcast instance from the camel-hazelcast instance. | | String +| *reliable* (common) | Define if the endpoint will use a reliable Topic struct or not. | 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 +| *pollingTimeout* (consumer) | Define the polling timeout of the Queue consumer in Poll mode | 10000 | long +| *poolSize* (consumer) | Define the Pool size for Queue Consumer Executor | 1 | int +| *queueConsumerMode* (consumer) | Define the Queue Consumer mode: Listen or Poll | Listen | HazelcastQueueConsumer Mode +| *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 +| *concurrentConsumers* (seda) | To use concurrent consumers polling from the SEDA queue. | 1 | int +| *onErrorDelay* (seda) | Milliseconds before consumer continues polling after an error has occurred. | 1000 | int +| *pollTimeout* (seda) | The timeout used when consuming from the SEDA queue. When a timeout occurs the consumer can check whether it is allowed to continue running. Setting a lower value allows the consumer to react more quickly upon shutdown. | 1000 | int +| *transacted* (seda) | If set to true then the consumer runs in transaction mode where the messages in the seda queue will only be removed if the transaction commits which happens when the processing is complete. | false | boolean +| *transferExchange* (seda) | If set to true the whole Exchange will be transfered. If header or body contains not serializable objects they will be skipped. | false | boolean +|=== // endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-hazelcast/src/main/docs/hazelcast-multimap-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-hazelcast/src/main/docs/hazelcast-multimap-component.adoc b/components/camel-hazelcast/src/main/docs/hazelcast-multimap-component.adoc index f151ccf..891c87e 100644 --- a/components/camel-hazelcast/src/main/docs/hazelcast-multimap-component.adoc +++ b/components/camel-hazelcast/src/main/docs/hazelcast-multimap-component.adoc @@ -1,4 +1,4 @@ -## Hazelcast Multimap Component +== Hazelcast Multimap Component *Available as of Camel version 2.7* @@ -13,51 +13,53 @@ The Hazelcast Multimap component supports 3 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **hazelcastInstance** (advanced) | The hazelcast instance reference which can be used for hazelcast endpoint. If you don't specify the instance reference camel use the default hazelcast instance from the camel-hazelcast instance. | | HazelcastInstance -| **hazelcastMode** (advanced) | The hazelcast mode reference which kind of instance should be used. If you don't specify the mode then the node mode will be the default. | node | 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 -|======================================================================= +| *hazelcastInstance* (advanced) | The hazelcast instance reference which can be used for hazelcast endpoint. If you don't specify the instance reference camel use the default hazelcast instance from the camel-hazelcast instance. | | HazelcastInstance +| *hazelcastMode* (advanced) | The hazelcast mode reference which kind of instance should be used. If you don't specify the mode then the node mode will be the default. | node | 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 Hazelcast Multimap endpoint is configured using URI syntax: - hazelcast-multimap:cacheName +---- +hazelcast-multimap:cacheName +---- 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 -| **cacheName** | *Required* The name of the cache | | String -|======================================================================= +| *cacheName* | *Required* The name of the cache | | String +|=== -#### Query Parameters (16 parameters): +==== Query Parameters (16 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **defaultOperation** (common) | To specify a default operation to use if no operation header has been provided. | | HazelcastOperation -| **hazelcastInstance** (common) | The hazelcast instance reference which can be used for hazelcast endpoint. | | HazelcastInstance -| **hazelcastInstanceName** (common) | The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference camel use the default hazelcast instance from the camel-hazelcast instance. | | String -| **reliable** (common) | Define if the endpoint will use a reliable Topic struct or not. | 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 -| **pollingTimeout** (consumer) | Define the polling timeout of the Queue consumer in Poll mode | 10000 | long -| **poolSize** (consumer) | Define the Pool size for Queue Consumer Executor | 1 | int -| **queueConsumerMode** (consumer) | Define the Queue Consumer mode: Listen or Poll | Listen | HazelcastQueueConsumer Mode -| **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 -| **concurrentConsumers** (seda) | To use concurrent consumers polling from the SEDA queue. | 1 | int -| **onErrorDelay** (seda) | Milliseconds before consumer continues polling after an error has occurred. | 1000 | int -| **pollTimeout** (seda) | The timeout used when consuming from the SEDA queue. When a timeout occurs the consumer can check whether it is allowed to continue running. Setting a lower value allows the consumer to react more quickly upon shutdown. | 1000 | int -| **transacted** (seda) | If set to true then the consumer runs in transaction mode where the messages in the seda queue will only be removed if the transaction commits which happens when the processing is complete. | false | boolean -| **transferExchange** (seda) | If set to true the whole Exchange will be transfered. If header or body contains not serializable objects they will be skipped. | false | boolean -|======================================================================= +| *defaultOperation* (common) | To specify a default operation to use if no operation header has been provided. | | HazelcastOperation +| *hazelcastInstance* (common) | The hazelcast instance reference which can be used for hazelcast endpoint. | | HazelcastInstance +| *hazelcastInstanceName* (common) | The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference camel use the default hazelcast instance from the camel-hazelcast instance. | | String +| *reliable* (common) | Define if the endpoint will use a reliable Topic struct or not. | 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 +| *pollingTimeout* (consumer) | Define the polling timeout of the Queue consumer in Poll mode | 10000 | long +| *poolSize* (consumer) | Define the Pool size for Queue Consumer Executor | 1 | int +| *queueConsumerMode* (consumer) | Define the Queue Consumer mode: Listen or Poll | Listen | HazelcastQueueConsumer Mode +| *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 +| *concurrentConsumers* (seda) | To use concurrent consumers polling from the SEDA queue. | 1 | int +| *onErrorDelay* (seda) | Milliseconds before consumer continues polling after an error has occurred. | 1000 | int +| *pollTimeout* (seda) | The timeout used when consuming from the SEDA queue. When a timeout occurs the consumer can check whether it is allowed to continue running. Setting a lower value allows the consumer to react more quickly upon shutdown. | 1000 | int +| *transacted* (seda) | If set to true then the consumer runs in transaction mode where the messages in the seda queue will only be removed if the transaction commits which happens when the processing is complete. | false | boolean +| *transferExchange* (seda) | If set to true the whole Exchange will be transfered. If header or body contains not serializable objects they will be skipped. | false | boolean +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-hazelcast/src/main/docs/hazelcast-queue-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-hazelcast/src/main/docs/hazelcast-queue-component.adoc b/components/camel-hazelcast/src/main/docs/hazelcast-queue-component.adoc index f2bc0ec..02669b0 100644 --- a/components/camel-hazelcast/src/main/docs/hazelcast-queue-component.adoc +++ b/components/camel-hazelcast/src/main/docs/hazelcast-queue-component.adoc @@ -1,4 +1,4 @@ -## Hazelcast Queue Component +== Hazelcast Queue Component *Available as of Camel version 2.7* @@ -13,50 +13,52 @@ The Hazelcast Queue component supports 3 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **hazelcastInstance** (advanced) | The hazelcast instance reference which can be used for hazelcast endpoint. If you don't specify the instance reference camel use the default hazelcast instance from the camel-hazelcast instance. | | HazelcastInstance -| **hazelcastMode** (advanced) | The hazelcast mode reference which kind of instance should be used. If you don't specify the mode then the node mode will be the default. | node | 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 -|======================================================================= +| *hazelcastInstance* (advanced) | The hazelcast instance reference which can be used for hazelcast endpoint. If you don't specify the instance reference camel use the default hazelcast instance from the camel-hazelcast instance. | | HazelcastInstance +| *hazelcastMode* (advanced) | The hazelcast mode reference which kind of instance should be used. If you don't specify the mode then the node mode will be the default. | node | 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 Hazelcast Queue endpoint is configured using URI syntax: - hazelcast-queue:cacheName +---- +hazelcast-queue:cacheName +---- 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 -| **cacheName** | *Required* The name of the cache | | String -|======================================================================= +| *cacheName* | *Required* The name of the cache | | String +|=== -#### Query Parameters (16 parameters): +==== Query Parameters (16 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **defaultOperation** (common) | To specify a default operation to use if no operation header has been provided. | | HazelcastOperation -| **hazelcastInstance** (common) | The hazelcast instance reference which can be used for hazelcast endpoint. | | HazelcastInstance -| **hazelcastInstanceName** (common) | The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference camel use the default hazelcast instance from the camel-hazelcast instance. | | String -| **reliable** (common) | Define if the endpoint will use a reliable Topic struct or not. | 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 -| **pollingTimeout** (consumer) | Define the polling timeout of the Queue consumer in Poll mode | 10000 | long -| **poolSize** (consumer) | Define the Pool size for Queue Consumer Executor | 1 | int -| **queueConsumerMode** (consumer) | Define the Queue Consumer mode: Listen or Poll | Listen | HazelcastQueueConsumer Mode -| **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 -| **concurrentConsumers** (seda) | To use concurrent consumers polling from the SEDA queue. | 1 | int -| **onErrorDelay** (seda) | Milliseconds before consumer continues polling after an error has occurred. | 1000 | int -| **pollTimeout** (seda) | The timeout used when consuming from the SEDA queue. When a timeout occurs the consumer can check whether it is allowed to continue running. Setting a lower value allows the consumer to react more quickly upon shutdown. | 1000 | int -| **transacted** (seda) | If set to true then the consumer runs in transaction mode where the messages in the seda queue will only be removed if the transaction commits which happens when the processing is complete. | false | boolean -| **transferExchange** (seda) | If set to true the whole Exchange will be transfered. If header or body contains not serializable objects they will be skipped. | false | boolean -|======================================================================= +| *defaultOperation* (common) | To specify a default operation to use if no operation header has been provided. | | HazelcastOperation +| *hazelcastInstance* (common) | The hazelcast instance reference which can be used for hazelcast endpoint. | | HazelcastInstance +| *hazelcastInstanceName* (common) | The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference camel use the default hazelcast instance from the camel-hazelcast instance. | | String +| *reliable* (common) | Define if the endpoint will use a reliable Topic struct or not. | 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 +| *pollingTimeout* (consumer) | Define the polling timeout of the Queue consumer in Poll mode | 10000 | long +| *poolSize* (consumer) | Define the Pool size for Queue Consumer Executor | 1 | int +| *queueConsumerMode* (consumer) | Define the Queue Consumer mode: Listen or Poll | Listen | HazelcastQueueConsumer Mode +| *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 +| *concurrentConsumers* (seda) | To use concurrent consumers polling from the SEDA queue. | 1 | int +| *onErrorDelay* (seda) | Milliseconds before consumer continues polling after an error has occurred. | 1000 | int +| *pollTimeout* (seda) | The timeout used when consuming from the SEDA queue. When a timeout occurs the consumer can check whether it is allowed to continue running. Setting a lower value allows the consumer to react more quickly upon shutdown. | 1000 | int +| *transacted* (seda) | If set to true then the consumer runs in transaction mode where the messages in the seda queue will only be removed if the transaction commits which happens when the processing is complete. | false | boolean +| *transferExchange* (seda) | If set to true the whole Exchange will be transfered. If header or body contains not serializable objects they will be skipped. | false | boolean +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-hazelcast/src/main/docs/hazelcast-replicatedmap-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-hazelcast/src/main/docs/hazelcast-replicatedmap-component.adoc b/components/camel-hazelcast/src/main/docs/hazelcast-replicatedmap-component.adoc index fa545c8..048891e 100644 --- a/components/camel-hazelcast/src/main/docs/hazelcast-replicatedmap-component.adoc +++ b/components/camel-hazelcast/src/main/docs/hazelcast-replicatedmap-component.adoc @@ -1,4 +1,4 @@ -## Hazelcast Replicated Map Component +== Hazelcast Replicated Map Component *Available as of Camel version 2.16* @@ -14,50 +14,52 @@ The Hazelcast Replicated Map component supports 3 options which are listed below [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **hazelcastInstance** (advanced) | The hazelcast instance reference which can be used for hazelcast endpoint. If you don't specify the instance reference camel use the default hazelcast instance from the camel-hazelcast instance. | | HazelcastInstance -| **hazelcastMode** (advanced) | The hazelcast mode reference which kind of instance should be used. If you don't specify the mode then the node mode will be the default. | node | 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 -|======================================================================= +| *hazelcastInstance* (advanced) | The hazelcast instance reference which can be used for hazelcast endpoint. If you don't specify the instance reference camel use the default hazelcast instance from the camel-hazelcast instance. | | HazelcastInstance +| *hazelcastMode* (advanced) | The hazelcast mode reference which kind of instance should be used. If you don't specify the mode then the node mode will be the default. | node | 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 Hazelcast Replicated Map endpoint is configured using URI syntax: - hazelcast-replicatedmap:cacheName +---- +hazelcast-replicatedmap:cacheName +---- 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 -| **cacheName** | *Required* The name of the cache | | String -|======================================================================= +| *cacheName* | *Required* The name of the cache | | String +|=== -#### Query Parameters (16 parameters): +==== Query Parameters (16 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **defaultOperation** (common) | To specify a default operation to use if no operation header has been provided. | | HazelcastOperation -| **hazelcastInstance** (common) | The hazelcast instance reference which can be used for hazelcast endpoint. | | HazelcastInstance -| **hazelcastInstanceName** (common) | The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference camel use the default hazelcast instance from the camel-hazelcast instance. | | String -| **reliable** (common) | Define if the endpoint will use a reliable Topic struct or not. | 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 -| **pollingTimeout** (consumer) | Define the polling timeout of the Queue consumer in Poll mode | 10000 | long -| **poolSize** (consumer) | Define the Pool size for Queue Consumer Executor | 1 | int -| **queueConsumerMode** (consumer) | Define the Queue Consumer mode: Listen or Poll | Listen | HazelcastQueueConsumer Mode -| **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 -| **concurrentConsumers** (seda) | To use concurrent consumers polling from the SEDA queue. | 1 | int -| **onErrorDelay** (seda) | Milliseconds before consumer continues polling after an error has occurred. | 1000 | int -| **pollTimeout** (seda) | The timeout used when consuming from the SEDA queue. When a timeout occurs the consumer can check whether it is allowed to continue running. Setting a lower value allows the consumer to react more quickly upon shutdown. | 1000 | int -| **transacted** (seda) | If set to true then the consumer runs in transaction mode where the messages in the seda queue will only be removed if the transaction commits which happens when the processing is complete. | false | boolean -| **transferExchange** (seda) | If set to true the whole Exchange will be transfered. If header or body contains not serializable objects they will be skipped. | false | boolean -|======================================================================= +| *defaultOperation* (common) | To specify a default operation to use if no operation header has been provided. | | HazelcastOperation +| *hazelcastInstance* (common) | The hazelcast instance reference which can be used for hazelcast endpoint. | | HazelcastInstance +| *hazelcastInstanceName* (common) | The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference camel use the default hazelcast instance from the camel-hazelcast instance. | | String +| *reliable* (common) | Define if the endpoint will use a reliable Topic struct or not. | 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 +| *pollingTimeout* (consumer) | Define the polling timeout of the Queue consumer in Poll mode | 10000 | long +| *poolSize* (consumer) | Define the Pool size for Queue Consumer Executor | 1 | int +| *queueConsumerMode* (consumer) | Define the Queue Consumer mode: Listen or Poll | Listen | HazelcastQueueConsumer Mode +| *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 +| *concurrentConsumers* (seda) | To use concurrent consumers polling from the SEDA queue. | 1 | int +| *onErrorDelay* (seda) | Milliseconds before consumer continues polling after an error has occurred. | 1000 | int +| *pollTimeout* (seda) | The timeout used when consuming from the SEDA queue. When a timeout occurs the consumer can check whether it is allowed to continue running. Setting a lower value allows the consumer to react more quickly upon shutdown. | 1000 | int +| *transacted* (seda) | If set to true then the consumer runs in transaction mode where the messages in the seda queue will only be removed if the transaction commits which happens when the processing is complete. | false | boolean +| *transferExchange* (seda) | If set to true the whole Exchange will be transfered. If header or body contains not serializable objects they will be skipped. | false | boolean +|=== // endpoint options: END @@ -211,4 +213,3 @@ Header Variables inside the response message: |`CamelHazelcastCacheType` |`String` |the type of the cache - here replicatedmap |======================================================================= - http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-hazelcast/src/main/docs/hazelcast-ringbuffer-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-hazelcast/src/main/docs/hazelcast-ringbuffer-component.adoc b/components/camel-hazelcast/src/main/docs/hazelcast-ringbuffer-component.adoc index 4a567ee..f985867 100644 --- a/components/camel-hazelcast/src/main/docs/hazelcast-ringbuffer-component.adoc +++ b/components/camel-hazelcast/src/main/docs/hazelcast-ringbuffer-component.adoc @@ -1,4 +1,4 @@ -## Hazelcast Ringbuffer Component +== Hazelcast Ringbuffer Component *Available as of Camel version 2.16* @@ -15,45 +15,47 @@ The Hazelcast Ringbuffer component supports 3 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **hazelcastInstance** (advanced) | The hazelcast instance reference which can be used for hazelcast endpoint. If you don't specify the instance reference camel use the default hazelcast instance from the camel-hazelcast instance. | | HazelcastInstance -| **hazelcastMode** (advanced) | The hazelcast mode reference which kind of instance should be used. If you don't specify the mode then the node mode will be the default. | node | 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 -|======================================================================= +| *hazelcastInstance* (advanced) | The hazelcast instance reference which can be used for hazelcast endpoint. If you don't specify the instance reference camel use the default hazelcast instance from the camel-hazelcast instance. | | HazelcastInstance +| *hazelcastMode* (advanced) | The hazelcast mode reference which kind of instance should be used. If you don't specify the mode then the node mode will be the default. | node | 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 Hazelcast Ringbuffer endpoint is configured using URI syntax: - hazelcast-ringbuffer:cacheName +---- +hazelcast-ringbuffer:cacheName +---- 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 -| **cacheName** | *Required* The name of the cache | | String -|======================================================================= +| *cacheName* | *Required* The name of the cache | | String +|=== -#### Query Parameters (10 parameters): +==== Query Parameters (10 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **reliable** (common) | Define if the endpoint will use a reliable Topic struct or not. | false | boolean -| **defaultOperation** (producer) | To specify a default operation to use if no operation header has been provided. | | HazelcastOperation -| **hazelcastInstance** (producer) | The hazelcast instance reference which can be used for hazelcast endpoint. | | HazelcastInstance -| **hazelcastInstanceName** (producer) | The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference camel use the default hazelcast instance from the camel-hazelcast instance. | | String -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **concurrentConsumers** (seda) | To use concurrent consumers polling from the SEDA queue. | 1 | int -| **onErrorDelay** (seda) | Milliseconds before consumer continues polling after an error has occurred. | 1000 | int -| **pollTimeout** (seda) | The timeout used when consuming from the SEDA queue. When a timeout occurs the consumer can check whether it is allowed to continue running. Setting a lower value allows the consumer to react more quickly upon shutdown. | 1000 | int -| **transacted** (seda) | If set to true then the consumer runs in transaction mode where the messages in the seda queue will only be removed if the transaction commits which happens when the processing is complete. | false | boolean -| **transferExchange** (seda) | If set to true the whole Exchange will be transfered. If header or body contains not serializable objects they will be skipped. | false | boolean -|======================================================================= +| *reliable* (common) | Define if the endpoint will use a reliable Topic struct or not. | false | boolean +| *defaultOperation* (producer) | To specify a default operation to use if no operation header has been provided. | | HazelcastOperation +| *hazelcastInstance* (producer) | The hazelcast instance reference which can be used for hazelcast endpoint. | | HazelcastInstance +| *hazelcastInstanceName* (producer) | The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference camel use the default hazelcast instance from the camel-hazelcast instance. | | String +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *concurrentConsumers* (seda) | To use concurrent consumers polling from the SEDA queue. | 1 | int +| *onErrorDelay* (seda) | Milliseconds before consumer continues polling after an error has occurred. | 1000 | int +| *pollTimeout* (seda) | The timeout used when consuming from the SEDA queue. When a timeout occurs the consumer can check whether it is allowed to continue running. Setting a lower value allows the consumer to react more quickly upon shutdown. | 1000 | int +| *transacted* (seda) | If set to true then the consumer runs in transaction mode where the messages in the seda queue will only be removed if the transaction commits which happens when the processing is complete. | false | boolean +| *transferExchange* (seda) | If set to true the whole Exchange will be transfered. If header or body contains not serializable objects they will be skipped. | false | boolean +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-hazelcast/src/main/docs/hazelcast-seda-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-hazelcast/src/main/docs/hazelcast-seda-component.adoc b/components/camel-hazelcast/src/main/docs/hazelcast-seda-component.adoc index 282190a..305b65d 100644 --- a/components/camel-hazelcast/src/main/docs/hazelcast-seda-component.adoc +++ b/components/camel-hazelcast/src/main/docs/hazelcast-seda-component.adoc @@ -1,4 +1,4 @@ -## Hazelcast SEDA Component +== Hazelcast SEDA Component *Available as of Camel version 2.7* @@ -14,50 +14,52 @@ The Hazelcast SEDA component supports 3 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **hazelcastInstance** (advanced) | The hazelcast instance reference which can be used for hazelcast endpoint. If you don't specify the instance reference camel use the default hazelcast instance from the camel-hazelcast instance. | | HazelcastInstance -| **hazelcastMode** (advanced) | The hazelcast mode reference which kind of instance should be used. If you don't specify the mode then the node mode will be the default. | node | 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 -|======================================================================= +| *hazelcastInstance* (advanced) | The hazelcast instance reference which can be used for hazelcast endpoint. If you don't specify the instance reference camel use the default hazelcast instance from the camel-hazelcast instance. | | HazelcastInstance +| *hazelcastMode* (advanced) | The hazelcast mode reference which kind of instance should be used. If you don't specify the mode then the node mode will be the default. | node | 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 Hazelcast SEDA endpoint is configured using URI syntax: - hazelcast-seda:cacheName +---- +hazelcast-seda:cacheName +---- 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 -| **cacheName** | *Required* The name of the cache | | String -|======================================================================= +| *cacheName* | *Required* The name of the cache | | String +|=== -#### Query Parameters (16 parameters): +==== Query Parameters (16 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **defaultOperation** (common) | To specify a default operation to use if no operation header has been provided. | | HazelcastOperation -| **hazelcastInstance** (common) | The hazelcast instance reference which can be used for hazelcast endpoint. | | HazelcastInstance -| **hazelcastInstanceName** (common) | The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference camel use the default hazelcast instance from the camel-hazelcast instance. | | String -| **reliable** (common) | Define if the endpoint will use a reliable Topic struct or not. | 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 -| **pollingTimeout** (consumer) | Define the polling timeout of the Queue consumer in Poll mode | 10000 | long -| **poolSize** (consumer) | Define the Pool size for Queue Consumer Executor | 1 | int -| **queueConsumerMode** (consumer) | Define the Queue Consumer mode: Listen or Poll | Listen | HazelcastQueueConsumer Mode -| **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 -| **concurrentConsumers** (seda) | To use concurrent consumers polling from the SEDA queue. | 1 | int -| **onErrorDelay** (seda) | Milliseconds before consumer continues polling after an error has occurred. | 1000 | int -| **pollTimeout** (seda) | The timeout used when consuming from the SEDA queue. When a timeout occurs the consumer can check whether it is allowed to continue running. Setting a lower value allows the consumer to react more quickly upon shutdown. | 1000 | int -| **transacted** (seda) | If set to true then the consumer runs in transaction mode where the messages in the seda queue will only be removed if the transaction commits which happens when the processing is complete. | false | boolean -| **transferExchange** (seda) | If set to true the whole Exchange will be transfered. If header or body contains not serializable objects they will be skipped. | false | boolean -|======================================================================= +| *defaultOperation* (common) | To specify a default operation to use if no operation header has been provided. | | HazelcastOperation +| *hazelcastInstance* (common) | The hazelcast instance reference which can be used for hazelcast endpoint. | | HazelcastInstance +| *hazelcastInstanceName* (common) | The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference camel use the default hazelcast instance from the camel-hazelcast instance. | | String +| *reliable* (common) | Define if the endpoint will use a reliable Topic struct or not. | 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 +| *pollingTimeout* (consumer) | Define the polling timeout of the Queue consumer in Poll mode | 10000 | long +| *poolSize* (consumer) | Define the Pool size for Queue Consumer Executor | 1 | int +| *queueConsumerMode* (consumer) | Define the Queue Consumer mode: Listen or Poll | Listen | HazelcastQueueConsumer Mode +| *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 +| *concurrentConsumers* (seda) | To use concurrent consumers polling from the SEDA queue. | 1 | int +| *onErrorDelay* (seda) | Milliseconds before consumer continues polling after an error has occurred. | 1000 | int +| *pollTimeout* (seda) | The timeout used when consuming from the SEDA queue. When a timeout occurs the consumer can check whether it is allowed to continue running. Setting a lower value allows the consumer to react more quickly upon shutdown. | 1000 | int +| *transacted* (seda) | If set to true then the consumer runs in transaction mode where the messages in the seda queue will only be removed if the transaction commits which happens when the processing is complete. | false | boolean +| *transferExchange* (seda) | If set to true the whole Exchange will be transfered. If header or body contains not serializable objects they will be skipped. | false | boolean +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-hazelcast/src/main/docs/hazelcast-set-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-hazelcast/src/main/docs/hazelcast-set-component.adoc b/components/camel-hazelcast/src/main/docs/hazelcast-set-component.adoc index b39bf67..56cf234 100644 --- a/components/camel-hazelcast/src/main/docs/hazelcast-set-component.adoc +++ b/components/camel-hazelcast/src/main/docs/hazelcast-set-component.adoc @@ -1,4 +1,4 @@ -## Hazelcast Set Component +== Hazelcast Set Component *Available as of Camel version 2.7* @@ -13,48 +13,50 @@ The Hazelcast Set component supports 3 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **hazelcastInstance** (advanced) | The hazelcast instance reference which can be used for hazelcast endpoint. If you don't specify the instance reference camel use the default hazelcast instance from the camel-hazelcast instance. | | HazelcastInstance -| **hazelcastMode** (advanced) | The hazelcast mode reference which kind of instance should be used. If you don't specify the mode then the node mode will be the default. | node | 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 -|======================================================================= +| *hazelcastInstance* (advanced) | The hazelcast instance reference which can be used for hazelcast endpoint. If you don't specify the instance reference camel use the default hazelcast instance from the camel-hazelcast instance. | | HazelcastInstance +| *hazelcastMode* (advanced) | The hazelcast mode reference which kind of instance should be used. If you don't specify the mode then the node mode will be the default. | node | 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 Hazelcast Set endpoint is configured using URI syntax: - hazelcast-set:cacheName +---- +hazelcast-set:cacheName +---- 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 -| **cacheName** | *Required* The name of the cache | | String -|======================================================================= +| *cacheName* | *Required* The name of the cache | | String +|=== -#### Query Parameters (16 parameters): +==== Query Parameters (16 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **defaultOperation** (common) | To specify a default operation to use if no operation header has been provided. | | HazelcastOperation -| **hazelcastInstance** (common) | The hazelcast instance reference which can be used for hazelcast endpoint. | | HazelcastInstance -| **hazelcastInstanceName** (common) | The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference camel use the default hazelcast instance from the camel-hazelcast instance. | | String -| **reliable** (common) | Define if the endpoint will use a reliable Topic struct or not. | 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 -| **pollingTimeout** (consumer) | Define the polling timeout of the Queue consumer in Poll mode | 10000 | long -| **poolSize** (consumer) | Define the Pool size for Queue Consumer Executor | 1 | int -| **queueConsumerMode** (consumer) | Define the Queue Consumer mode: Listen or Poll | Listen | HazelcastQueueConsumer Mode -| **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 -| **concurrentConsumers** (seda) | To use concurrent consumers polling from the SEDA queue. | 1 | int -| **onErrorDelay** (seda) | Milliseconds before consumer continues polling after an error has occurred. | 1000 | int -| **pollTimeout** (seda) | The timeout used when consuming from the SEDA queue. When a timeout occurs the consumer can check whether it is allowed to continue running. Setting a lower value allows the consumer to react more quickly upon shutdown. | 1000 | int -| **transacted** (seda) | If set to true then the consumer runs in transaction mode where the messages in the seda queue will only be removed if the transaction commits which happens when the processing is complete. | false | boolean -| **transferExchange** (seda) | If set to true the whole Exchange will be transfered. If header or body contains not serializable objects they will be skipped. | false | boolean -|======================================================================= +| *defaultOperation* (common) | To specify a default operation to use if no operation header has been provided. | | HazelcastOperation +| *hazelcastInstance* (common) | The hazelcast instance reference which can be used for hazelcast endpoint. | | HazelcastInstance +| *hazelcastInstanceName* (common) | The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference camel use the default hazelcast instance from the camel-hazelcast instance. | | String +| *reliable* (common) | Define if the endpoint will use a reliable Topic struct or not. | 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 +| *pollingTimeout* (consumer) | Define the polling timeout of the Queue consumer in Poll mode | 10000 | long +| *poolSize* (consumer) | Define the Pool size for Queue Consumer Executor | 1 | int +| *queueConsumerMode* (consumer) | Define the Queue Consumer mode: Listen or Poll | Listen | HazelcastQueueConsumer Mode +| *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 +| *concurrentConsumers* (seda) | To use concurrent consumers polling from the SEDA queue. | 1 | int +| *onErrorDelay* (seda) | Milliseconds before consumer continues polling after an error has occurred. | 1000 | int +| *pollTimeout* (seda) | The timeout used when consuming from the SEDA queue. When a timeout occurs the consumer can check whether it is allowed to continue running. Setting a lower value allows the consumer to react more quickly upon shutdown. | 1000 | int +| *transacted* (seda) | If set to true then the consumer runs in transaction mode where the messages in the seda queue will only be removed if the transaction commits which happens when the processing is complete. | false | boolean +| *transferExchange* (seda) | If set to true the whole Exchange will be transfered. If header or body contains not serializable objects they will be skipped. | false | boolean +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-hazelcast/src/main/docs/hazelcast-topic-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-hazelcast/src/main/docs/hazelcast-topic-component.adoc b/components/camel-hazelcast/src/main/docs/hazelcast-topic-component.adoc index dcb03bc..9a54526 100644 --- a/components/camel-hazelcast/src/main/docs/hazelcast-topic-component.adoc +++ b/components/camel-hazelcast/src/main/docs/hazelcast-topic-component.adoc @@ -1,4 +1,4 @@ -## Hazelcast Topic Component +== Hazelcast Topic Component *Available as of Camel version 2.15* @@ -13,50 +13,52 @@ The Hazelcast Topic component supports 3 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **hazelcastInstance** (advanced) | The hazelcast instance reference which can be used for hazelcast endpoint. If you don't specify the instance reference camel use the default hazelcast instance from the camel-hazelcast instance. | | HazelcastInstance -| **hazelcastMode** (advanced) | The hazelcast mode reference which kind of instance should be used. If you don't specify the mode then the node mode will be the default. | node | 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 -|======================================================================= +| *hazelcastInstance* (advanced) | The hazelcast instance reference which can be used for hazelcast endpoint. If you don't specify the instance reference camel use the default hazelcast instance from the camel-hazelcast instance. | | HazelcastInstance +| *hazelcastMode* (advanced) | The hazelcast mode reference which kind of instance should be used. If you don't specify the mode then the node mode will be the default. | node | 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 Hazelcast Topic endpoint is configured using URI syntax: - hazelcast-topic:cacheName +---- +hazelcast-topic:cacheName +---- 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 -| **cacheName** | *Required* The name of the cache | | String -|======================================================================= +| *cacheName* | *Required* The name of the cache | | String +|=== -#### Query Parameters (16 parameters): +==== Query Parameters (16 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **defaultOperation** (common) | To specify a default operation to use if no operation header has been provided. | | HazelcastOperation -| **hazelcastInstance** (common) | The hazelcast instance reference which can be used for hazelcast endpoint. | | HazelcastInstance -| **hazelcastInstanceName** (common) | The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference camel use the default hazelcast instance from the camel-hazelcast instance. | | String -| **reliable** (common) | Define if the endpoint will use a reliable Topic struct or not. | 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 -| **pollingTimeout** (consumer) | Define the polling timeout of the Queue consumer in Poll mode | 10000 | long -| **poolSize** (consumer) | Define the Pool size for Queue Consumer Executor | 1 | int -| **queueConsumerMode** (consumer) | Define the Queue Consumer mode: Listen or Poll | Listen | HazelcastQueueConsumer Mode -| **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 -| **concurrentConsumers** (seda) | To use concurrent consumers polling from the SEDA queue. | 1 | int -| **onErrorDelay** (seda) | Milliseconds before consumer continues polling after an error has occurred. | 1000 | int -| **pollTimeout** (seda) | The timeout used when consuming from the SEDA queue. When a timeout occurs the consumer can check whether it is allowed to continue running. Setting a lower value allows the consumer to react more quickly upon shutdown. | 1000 | int -| **transacted** (seda) | If set to true then the consumer runs in transaction mode where the messages in the seda queue will only be removed if the transaction commits which happens when the processing is complete. | false | boolean -| **transferExchange** (seda) | If set to true the whole Exchange will be transfered. If header or body contains not serializable objects they will be skipped. | false | boolean -|======================================================================= +| *defaultOperation* (common) | To specify a default operation to use if no operation header has been provided. | | HazelcastOperation +| *hazelcastInstance* (common) | The hazelcast instance reference which can be used for hazelcast endpoint. | | HazelcastInstance +| *hazelcastInstanceName* (common) | The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference camel use the default hazelcast instance from the camel-hazelcast instance. | | String +| *reliable* (common) | Define if the endpoint will use a reliable Topic struct or not. | 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 +| *pollingTimeout* (consumer) | Define the polling timeout of the Queue consumer in Poll mode | 10000 | long +| *poolSize* (consumer) | Define the Pool size for Queue Consumer Executor | 1 | int +| *queueConsumerMode* (consumer) | Define the Queue Consumer mode: Listen or Poll | Listen | HazelcastQueueConsumer Mode +| *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 +| *concurrentConsumers* (seda) | To use concurrent consumers polling from the SEDA queue. | 1 | int +| *onErrorDelay* (seda) | Milliseconds before consumer continues polling after an error has occurred. | 1000 | int +| *pollTimeout* (seda) | The timeout used when consuming from the SEDA queue. When a timeout occurs the consumer can check whether it is allowed to continue running. Setting a lower value allows the consumer to react more quickly upon shutdown. | 1000 | int +| *transacted* (seda) | If set to true then the consumer runs in transaction mode where the messages in the seda queue will only be removed if the transaction commits which happens when the processing is complete. | false | boolean +| *transferExchange* (seda) | If set to true the whole Exchange will be transfered. If header or body contains not serializable objects they will be skipped. | false | boolean +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-hbase/src/main/docs/hbase-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-hbase/src/main/docs/hbase-component.adoc b/components/camel-hbase/src/main/docs/hbase-component.adoc index 032c6f7..be987b4 100644 --- a/components/camel-hbase/src/main/docs/hbase-component.adoc +++ b/components/camel-hbase/src/main/docs/hbase-component.adoc @@ -1,4 +1,4 @@ -## HBase Component +== HBase Component *Available as of Camel version 2.10* @@ -106,12 +106,12 @@ The HBase component supports 3 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **configuration** (advanced) | To use the shared configuration | | Configuration -| **poolMaxSize** (common) | Maximum number of references to keep for each table in the HTable pool. The default value is 10. | 10 | int -| **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 the shared configuration | | Configuration +| *poolMaxSize* (common) | Maximum number of references to keep for each table in the HTable pool. The default value is 10. | 10 | int +| *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 @@ -122,40 +122,42 @@ The HBase component supports 3 options which are listed below. // endpoint options: START The HBase endpoint is configured using URI syntax: - hbase:tableName +---- +hbase:tableName +---- 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 -| **tableName** | *Required* The name of the table | | String -|======================================================================= +| *tableName* | *Required* The name of the table | | String +|=== -#### Query Parameters (16 parameters): +==== Query Parameters (16 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **cellMappingStrategyFactory** (common) | To use a custom CellMappingStrategyFactory that is responsible for mapping cells. | | CellMappingStrategy Factory -| **filters** (common) | A list of filters to use. | | List -| **mappingStrategyClassName** (common) | The class name of a custom mapping strategy implementation. | | String -| **mappingStrategyName** (common) | The strategy to use for mapping Camel messages to HBase columns. Supported values: header or body. | | String -| **rowMapping** (common) | To map the key/values from the Map to a HBaseRow. The following keys is supported: rowId - The id of the row. This has limited use as the row usually changes per Exchange. rowType - The type to covert row id to. Supported operations: CamelHBaseScan. family - The column family. Supports a number suffix for referring to more than one columns. qualifier - The column qualifier. Supports a number suffix for referring to more than one columns. value - The value. Supports a number suffix for referring to more than one columns valueType - The value type. Supports a number suffix for referring to more than one columns. Supported operations: CamelHBaseGet and CamelHBaseScan. | | Map -| **rowModel** (common) | An instance of org.apache.camel.component.hbase.model.HBaseRow which describes how each row should be modeled | | HBaseRow -| **userGroupInformation** (common) | Defines privileges to communicate with HBase such as using kerberos. | | UserGroupInformation -| **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 -| **maxMessagesPerPoll** (consumer) | Gets the maximum number of messages as a limit to poll at each polling. Is default unlimited but use 0 or negative number to disable it as unlimited. | | int -| **operation** (consumer) | The HBase operation to perform | | String -| **remove** (consumer) | If the option is true Camel HBase Consumer will remove the rows which it processes. | true | boolean -| **removeHandler** (consumer) | To use a custom HBaseRemoveHandler that is executed when a row is to be removed. | | HBaseRemoveHandler -| **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 -| **maxResults** (producer) | The maximum number of rows to scan. | 100 | int -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *cellMappingStrategyFactory* (common) | To use a custom CellMappingStrategyFactory that is responsible for mapping cells. | | CellMappingStrategy Factory +| *filters* (common) | A list of filters to use. | | List +| *mappingStrategyClassName* (common) | The class name of a custom mapping strategy implementation. | | String +| *mappingStrategyName* (common) | The strategy to use for mapping Camel messages to HBase columns. Supported values: header or body. | | String +| *rowMapping* (common) | To map the key/values from the Map to a HBaseRow. The following keys is supported: rowId - The id of the row. This has limited use as the row usually changes per Exchange. rowType - The type to covert row id to. Supported operations: CamelHBaseScan. family - The column family. Supports a number suffix for referring to more than one columns. qualifier - The column qualifier. Supports a number suffix for referring to more than one columns. value - The value. Supports a number suffix for referring to more than one columns valueType - The value type. Supports a number suffix for referring to more than one columns. Supported operations: CamelHBaseGet and CamelHBaseScan. | | Map +| *rowModel* (common) | An instance of org.apache.camel.component.hbase.model.HBaseRow which describes how each row should be modeled | | HBaseRow +| *userGroupInformation* (common) | Defines privileges to communicate with HBase such as using kerberos. | | UserGroupInformation +| *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 +| *maxMessagesPerPoll* (consumer) | Gets the maximum number of messages as a limit to poll at each polling. Is default unlimited but use 0 or negative number to disable it as unlimited. | | int +| *operation* (consumer) | The HBase operation to perform | | String +| *remove* (consumer) | If the option is true Camel HBase Consumer will remove the rows which it processes. | true | boolean +| *removeHandler* (consumer) | To use a custom HBaseRemoveHandler that is executed when a row is to be removed. | | HBaseRemoveHandler +| *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 +| *maxResults* (producer) | The maximum number of rows to scan. | 100 | int +| *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
