http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-disruptor/src/main/docs/disruptor-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-disruptor/src/main/docs/disruptor-component.adoc b/components/camel-disruptor/src/main/docs/disruptor-component.adoc index 536a844..e0ccf9d 100644 --- a/components/camel-disruptor/src/main/docs/disruptor-component.adoc +++ b/components/camel-disruptor/src/main/docs/disruptor-component.adoc @@ -1,4 +1,4 @@ -## Disruptor Component +== Disruptor Component *Available as of Camel version 2.12* @@ -99,17 +99,17 @@ The Disruptor component supports 8 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **defaultConcurrent Consumers** (consumer) | To configure the default number of concurrent consumers | 1 | int -| **defaultMultiple Consumers** (consumer) | To configure the default value for multiple consumers | false | boolean -| **defaultProducerType** (producer) | To configure the default value for DisruptorProducerType The default value is Multi. | Multi | DisruptorProducerType -| **defaultWaitStrategy** (consumer) | To configure the default value for DisruptorWaitStrategy The default value is Blocking. | Blocking | DisruptorWaitStrategy -| **defaultBlockWhenFull** (producer) | To configure the default value for block when full The default value is true. | true | boolean -| **queueSize** (common) | *Deprecated* To configure the ring buffer size | | int -| **bufferSize** (common) | To configure the ring buffer size | 1024 | 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 -|======================================================================= +| *defaultConcurrent Consumers* (consumer) | To configure the default number of concurrent consumers | 1 | int +| *defaultMultiple Consumers* (consumer) | To configure the default value for multiple consumers | false | boolean +| *defaultProducerType* (producer) | To configure the default value for DisruptorProducerType The default value is Multi. | Multi | DisruptorProducerType +| *defaultWaitStrategy* (consumer) | To configure the default value for DisruptorWaitStrategy The default value is Blocking. | Blocking | DisruptorWaitStrategy +| *defaultBlockWhenFull* (producer) | To configure the default value for block when full The default value is true. | true | boolean +| *queueSize* (common) | *Deprecated* To configure the ring buffer size | | int +| *bufferSize* (common) | To configure the ring buffer size | 1024 | 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 @@ -118,36 +118,38 @@ The Disruptor component supports 8 options which are listed below. // endpoint options: START The Disruptor endpoint is configured using URI syntax: - disruptor:name +---- +disruptor:name +---- 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 -| **name** | *Required* Name of queue | | String -|======================================================================= +| *name* | *Required* Name of queue | | String +|=== -#### Query Parameters (12 parameters): +==== Query Parameters (12 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **size** (common) | The maximum capacity of the Disruptors ringbuffer Will be effectively increased to the nearest power of two. Notice: Mind if you use this option then its the first endpoint being created with the queue name that determines the size. To make sure all endpoints use same size then configure the size option on all of them or the first endpoint being created. | 1024 | int -| **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 -| **concurrentConsumers** (consumer) | Number of concurrent threads processing exchanges. | 1 | int -| **multipleConsumers** (consumer) | Specifies whether multiple consumers are allowed. If enabled you can use Disruptor for Publish-Subscribe messaging. That is you can send a message to the queue and have each consumer receive a copy of the message. When enabled this option should be specified on every consumer endpoint. | false | boolean -| **waitStrategy** (consumer) | Defines the strategy used by consumer threads to wait on new exchanges to be published. The options allowed are:Blocking Sleeping BusySpin and Yielding. | Blocking | DisruptorWaitStrategy -| **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 -| **blockWhenFull** (producer) | Whether a thread that sends messages to a full Disruptor will block until the ringbuffer's capacity is no longer exhausted. By default the calling thread will block and wait until the message can be accepted. By disabling this option an exception will be thrown stating that the queue is full. | false | boolean -| **producerType** (producer) | Defines the producers allowed on the Disruptor. The options allowed are: Multi to allow multiple producers and Single to enable certain optimizations only allowed when one concurrent producer (on one thread or otherwise synchronized) is active. | Multi | DisruptorProducerType -| **timeout** (producer) | Timeout (in milliseconds) before a producer will stop waiting for an asynchronous task to complete. You can disable timeout by using 0 or a negative value. | 30000 | long -| **waitForTaskToComplete** (producer) | Option to specify whether the caller should wait for the async task to complete or not before continuing. The following three options are supported: Always Never or IfReplyExpected. The first two values are self-explanatory. The last value IfReplyExpected will only wait if the message is Request Reply based. | IfReplyExpected | WaitForTaskToComplete -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *size* (common) | The maximum capacity of the Disruptors ringbuffer Will be effectively increased to the nearest power of two. Notice: Mind if you use this option then its the first endpoint being created with the queue name that determines the size. To make sure all endpoints use same size then configure the size option on all of them or the first endpoint being created. | 1024 | int +| *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 +| *concurrentConsumers* (consumer) | Number of concurrent threads processing exchanges. | 1 | int +| *multipleConsumers* (consumer) | Specifies whether multiple consumers are allowed. If enabled you can use Disruptor for Publish-Subscribe messaging. That is you can send a message to the queue and have each consumer receive a copy of the message. When enabled this option should be specified on every consumer endpoint. | false | boolean +| *waitStrategy* (consumer) | Defines the strategy used by consumer threads to wait on new exchanges to be published. The options allowed are:Blocking Sleeping BusySpin and Yielding. | Blocking | DisruptorWaitStrategy +| *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 +| *blockWhenFull* (producer) | Whether a thread that sends messages to a full Disruptor will block until the ringbuffer's capacity is no longer exhausted. By default the calling thread will block and wait until the message can be accepted. By disabling this option an exception will be thrown stating that the queue is full. | false | boolean +| *producerType* (producer) | Defines the producers allowed on the Disruptor. The options allowed are: Multi to allow multiple producers and Single to enable certain optimizations only allowed when one concurrent producer (on one thread or otherwise synchronized) is active. | Multi | DisruptorProducerType +| *timeout* (producer) | Timeout (in milliseconds) before a producer will stop waiting for an asynchronous task to complete. You can disable timeout by using 0 or a negative value. | 30000 | long +| *waitForTaskToComplete* (producer) | Option to specify whether the caller should wait for the async task to complete or not before continuing. The following three options are supported: Always Never or IfReplyExpected. The first two values are self-explanatory. The last value IfReplyExpected will only wait if the message is Request Reply based. | IfReplyExpected | WaitForTaskToComplete +| *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/camel-dns/src/main/docs/dns-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-dns/src/main/docs/dns-component.adoc b/components/camel-dns/src/main/docs/dns-component.adoc index 2e25c4c..9990371 100644 --- a/components/camel-dns/src/main/docs/dns-component.adoc +++ b/components/camel-dns/src/main/docs/dns-component.adoc @@ -1,4 +1,4 @@ -## DNS Component +== DNS Component *Available as of Camel version 2.7* @@ -54,25 +54,27 @@ The DNS component has no options. // endpoint options: START The DNS endpoint is configured using URI syntax: - dns:dnsType +---- +dns:dnsType +---- 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 -| **dnsType** | *Required* The type of the lookup. | | DnsType -|======================================================================= +| *dnsType* | *Required* The type of the lookup. | | DnsType +|=== -#### Query Parameters (1 parameters): +==== Query Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *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/camel-docker/src/main/docs/docker-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-docker/src/main/docs/docker-component.adoc b/components/camel-docker/src/main/docs/docker-component.adoc index 82ae8d6..3e2e3e5 100644 --- a/components/camel-docker/src/main/docs/docker-component.adoc +++ b/components/camel-docker/src/main/docs/docker-component.adoc @@ -1,4 +1,4 @@ -## Docker Component +== Docker Component *Available as of Camel version 2.15* @@ -27,55 +27,57 @@ The Docker 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 the shared docker configuration | | DockerConfiguration -| **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 docker configuration | | DockerConfiguration +| *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 Docker endpoint is configured using URI syntax: - docker:operation +---- +docker:operation +---- 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 -| **operation** | *Required* Which operation to use | | DockerOperation -|======================================================================= +| *operation* | *Required* Which operation to use | | DockerOperation +|=== -#### Query Parameters (20 parameters): +==== Query Parameters (20 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **email** (common) | Email address associated with the user | | String -| **host** (common) | *Required* Docker host | localhost | String -| **port** (common) | *Required* Docker port | 2375 | Integer -| **requestTimeout** (common) | Request timeout for response (in seconds) | | Integer -| **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 -| **cmdExecFactory** (advanced) | The fully qualified class name of the DockerCmdExecFactory implementation to use | com.github.dockerjava.netty.NettyDockerCmdExecFactory | String -| **followRedirectFilter** (advanced) | Whether to follow redirect filter | false | boolean -| **loggingFilter** (advanced) | Whether to use logging filter | false | boolean -| **maxPerRouteConnections** (advanced) | Maximum route connections | 100 | Integer -| **maxTotalConnections** (advanced) | Maximum total connections | 100 | Integer -| **serverAddress** (advanced) | Server address for docker registry. | https://index.docker.io/v1/ | String -| **socket** (advanced) | Socket connection mode | true | boolean -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **certPath** (security) | Location containing the SSL certificate chain | | String -| **password** (security) | Password to authenticate with | | String -| **secure** (security) | Use HTTPS communication | false | boolean -| **tlsVerify** (security) | Check TLS | false | boolean -| **username** (security) | User name to authenticate with | | String -|======================================================================= +| *email* (common) | Email address associated with the user | | String +| *host* (common) | *Required* Docker host | localhost | String +| *port* (common) | *Required* Docker port | 2375 | Integer +| *requestTimeout* (common) | Request timeout for response (in seconds) | | Integer +| *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 +| *cmdExecFactory* (advanced) | The fully qualified class name of the DockerCmdExecFactory implementation to use | com.github.dockerjava.netty.NettyDockerCmdExecFactory | String +| *followRedirectFilter* (advanced) | Whether to follow redirect filter | false | boolean +| *loggingFilter* (advanced) | Whether to use logging filter | false | boolean +| *maxPerRouteConnections* (advanced) | Maximum route connections | 100 | Integer +| *maxTotalConnections* (advanced) | Maximum total connections | 100 | Integer +| *serverAddress* (advanced) | Server address for docker registry. | https://index.docker.io/v1/ | String +| *socket* (advanced) | Socket connection mode | true | boolean +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *certPath* (security) | Location containing the SSL certificate chain | | String +| *password* (security) | Password to authenticate with | | String +| *secure* (security) | Use HTTPS communication | false | boolean +| *tlsVerify* (security) | Check TLS | false | boolean +| *username* (security) | User name to authenticate with | | String +|=== // endpoint options: END ### Header Strategy http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-dozer/src/main/docs/dozer-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-dozer/src/main/docs/dozer-component.adoc b/components/camel-dozer/src/main/docs/dozer-component.adoc index 0b7f879..b2e4c3a 100644 --- a/components/camel-dozer/src/main/docs/dozer-component.adoc +++ b/components/camel-dozer/src/main/docs/dozer-component.adoc @@ -1,4 +1,4 @@ -## Dozer Component +== Dozer Component *Available as of Camel version 2.15* @@ -62,31 +62,33 @@ The Dozer component has no options. // endpoint options: START The Dozer endpoint is configured using URI syntax: - dozer:name +---- +dozer:name +---- 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 -| **name** | *Required* A human readable name of the mapping. | | String -|======================================================================= +| *name* | *Required* A human readable name of the mapping. | | String +|=== -#### Query Parameters (7 parameters): +==== Query Parameters (7 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **mappingConfiguration** (producer) | The name of a DozerBeanMapperConfiguration bean in the Camel registry which should be used for configuring the Dozer mapping. This is an alternative to the mappingFile option that can be used for fine-grained control over how Dozer is configured. Remember to use a prefix in the value to indicate that the bean is in the Camel registry (e.g. myDozerConfig). | | DozerBeanMapper Configuration -| **mappingFile** (producer) | The location of a Dozer configuration file. The file is loaded from the classpath by default but you can use file: classpath: or http: to load the configuration from a specific location. | dozerBeanMapping.xml | String -| **marshalId** (producer) | The id of a dataFormat defined within the Camel Context to use for marshalling the mapping output to a non-Java type. | | String -| **sourceModel** (producer) | Fully-qualified class name for the source type used in the mapping. If specified the input to the mapping is converted to the specified type before being mapped with Dozer. | | String -| **targetModel** (producer) | *Required* Fully-qualified class name for the target type used in the mapping. | | String -| **unmarshalId** (producer) | The id of a dataFormat defined within the Camel Context to use for unmarshalling the mapping input from a non-Java type. | | String -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *mappingConfiguration* (producer) | The name of a DozerBeanMapperConfiguration bean in the Camel registry which should be used for configuring the Dozer mapping. This is an alternative to the mappingFile option that can be used for fine-grained control over how Dozer is configured. Remember to use a prefix in the value to indicate that the bean is in the Camel registry (e.g. myDozerConfig). | | DozerBeanMapper Configuration +| *mappingFile* (producer) | The location of a Dozer configuration file. The file is loaded from the classpath by default but you can use file: classpath: or http: to load the configuration from a specific location. | dozerBeanMapping.xml | String +| *marshalId* (producer) | The id of a dataFormat defined within the Camel Context to use for marshalling the mapping output to a non-Java type. | | String +| *sourceModel* (producer) | Fully-qualified class name for the source type used in the mapping. If specified the input to the mapping is converted to the specified type before being mapped with Dozer. | | String +| *targetModel* (producer) | *Required* Fully-qualified class name for the target type used in the mapping. | | String +| *unmarshalId* (producer) | The id of a dataFormat defined within the Camel Context to use for unmarshalling the mapping input from a non-Java type. | | 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 ### Using Data Formats with Dozer http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-drill/src/main/docs/drill-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-drill/src/main/docs/drill-component.adoc b/components/camel-drill/src/main/docs/drill-component.adoc index d2e41c2..8955caa 100644 --- a/components/camel-drill/src/main/docs/drill-component.adoc +++ b/components/camel-drill/src/main/docs/drill-component.adoc @@ -1,4 +1,4 @@ -## Drill Component +== Drill Component *Available as of Camel version 2.19* @@ -44,29 +44,31 @@ The Drill component has no options. // endpoint options: START The Drill endpoint is configured using URI syntax: - drill:host +---- +drill:host +---- 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 -| **host** | *Required* ZooKeeper host name or IP address. Use local instead of a host name or IP address to connect to the local Drillbit | | String -|======================================================================= +| *host* | *Required* ZooKeeper host name or IP address. Use local instead of a host name or IP address to connect to the local Drillbit | | String +|=== -#### Query Parameters (5 parameters): +==== Query Parameters (5 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **clusterId** (producer) | Cluster ID https://drill.apache.org/docs/using-the-jdbc-driver/determining-the-cluster-id | | String -| **directory** (producer) | Drill directory in ZooKeeper | | String -| **mode** (producer) | Connection mode: zk: Zookeeper drillbit: Drillbit direct connection https://drill.apache.org/docs/using-the-jdbc-driver/ | ZK | DrillConnectionMode -| **port** (producer) | ZooKeeper port number | | Integer -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *clusterId* (producer) | Cluster ID https://drill.apache.org/docs/using-the-jdbc-driver/determining-the-cluster-id | | String +| *directory* (producer) | Drill directory in ZooKeeper | | String +| *mode* (producer) | Connection mode: zk: Zookeeper drillbit: Drillbit direct connection https://drill.apache.org/docs/using-the-jdbc-driver/ | ZK | DrillConnectionMode +| *port* (producer) | ZooKeeper port number | | Integer +| *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 ### See Also http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-dropbox/src/main/docs/dropbox-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-dropbox/src/main/docs/dropbox-component.adoc b/components/camel-dropbox/src/main/docs/dropbox-component.adoc index 21ed857..92f32de 100644 --- a/components/camel-dropbox/src/main/docs/dropbox-component.adoc +++ b/components/camel-dropbox/src/main/docs/dropbox-component.adoc @@ -1,4 +1,4 @@ -## Dropbox Component +== Dropbox Component *Available as of Camel version 2.14* @@ -71,36 +71,38 @@ The Dropbox component has no options. // endpoint options: START The Dropbox endpoint is configured using URI syntax: - dropbox:operation +---- +dropbox:operation +---- 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 -| **operation** | *Required* The specific action (typically is a CRUD action) to perform on Dropbox remote folder. | | DropboxOperation -|======================================================================= +| *operation* | *Required* The specific action (typically is a CRUD action) to perform on Dropbox remote folder. | | DropboxOperation +|=== -#### Query Parameters (12 parameters): +==== Query Parameters (12 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **accessToken** (common) | *Required* The access token to make API requests for a specific Dropbox user | | String -| **client** (common) | To use an existing DbxClient instance as DropBox client. | | DbxClient -| **clientIdentifier** (common) | *Required* Name of the app registered to make API requests | | String -| **localPath** (common) | Optional folder or file to upload on Dropbox from the local filesystem. If this option has not been configured then the message body is used as the content to upload. | | String -| **newRemotePath** (common) | Destination file or folder | | String -| **query** (common) | A space-separated list of sub-strings to search for. A file matches only if it contains all the sub-strings. If this option is not set all files will be matched. | | String -| **remotePath** (common) | Original file or folder to move | | String -| **uploadMode** (common) | Which mode to upload. in case of add the new file will be renamed if a file with the same name already exists on dropbox. in case of force if a file with the same name already exists on dropbox this will be overwritten. | | DropboxUploadMode -| **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 -|======================================================================= +| *accessToken* (common) | *Required* The access token to make API requests for a specific Dropbox user | | String +| *client* (common) | To use an existing DbxClient instance as DropBox client. | | DbxClient +| *clientIdentifier* (common) | *Required* Name of the app registered to make API requests | | String +| *localPath* (common) | Optional folder or file to upload on Dropbox from the local filesystem. If this option has not been configured then the message body is used as the content to upload. | | String +| *newRemotePath* (common) | Destination file or folder | | String +| *query* (common) | A space-separated list of sub-strings to search for. A file matches only if it contains all the sub-strings. If this option is not set all files will be matched. | | String +| *remotePath* (common) | Original file or folder to move | | String +| *uploadMode* (common) | Which mode to upload. in case of add the new file will be renamed if a file with the same name already exists on dropbox. in case of force if a file with the same name already exists on dropbox this will be overwritten. | | DropboxUploadMode +| *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 ### Del operation http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-ehcache/src/main/docs/ehcache-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-ehcache/src/main/docs/ehcache-component.adoc b/components/camel-ehcache/src/main/docs/ehcache-component.adoc index 99d970a..df137e8 100644 --- a/components/camel-ehcache/src/main/docs/ehcache-component.adoc +++ b/components/camel-ehcache/src/main/docs/ehcache-component.adoc @@ -1,4 +1,4 @@ -## Ehcache Component +== Ehcache Component *Available as of Camel version 2.18* @@ -42,16 +42,16 @@ The Ehcache component supports 7 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **configuration** (advanced) | Sets the global component configuration | | EhcacheConfiguration -| **cacheManager** (common) | The cache manager | | CacheManager -| **cacheManager Configuration** (common) | The cache manager configuration | | Configuration -| **cacheConfiguration** (common) | The default cache configuration to be used to create caches. | | CacheConfiguration<?,?> -| **cachesConfigurations** (common) | A map of caches configurations to be used to create caches. | | Map -| **cacheConfigurationUri** (common) | URI pointing to the Ehcache XML configuration file's location | | 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 -|======================================================================= +| *configuration* (advanced) | Sets the global component configuration | | EhcacheConfiguration +| *cacheManager* (common) | The cache manager | | CacheManager +| *cacheManager Configuration* (common) | The cache manager configuration | | Configuration +| *cacheConfiguration* (common) | The default cache configuration to be used to create caches. | | CacheConfiguration<?,?> +| *cachesConfigurations* (common) | A map of caches configurations to be used to create caches. | | Map +| *cacheConfigurationUri* (common) | URI pointing to the Ehcache XML configuration file's location | | 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 @@ -59,41 +59,43 @@ The Ehcache component supports 7 options which are listed below. // endpoint options: START The Ehcache endpoint is configured using URI syntax: - ehcache:cacheName +---- +ehcache: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 cache name | | String -|======================================================================= +| *cacheName* | *Required* the cache name | | String +|=== -#### Query Parameters (17 parameters): +==== Query Parameters (17 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **cacheManager** (common) | The cache manager | | CacheManager -| **cacheManagerConfiguration** (common) | The cache manager configuration | | Configuration -| **configurationUri** (common) | URI pointing to the Ehcache XML configuration file's location | | String -| **createCacheIfNotExist** (common) | Configure if a cache need to be created if it does exist or can't be pre-configured. | true | 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 -| **eventFiring** (consumer) | Set the the delivery mode (synchronous asynchronous) | ASYNCHRONOUS | EventFiring -| **eventOrdering** (consumer) | Set the the delivery mode (ordered unordered) | ORDERED | EventOrdering -| **eventTypes** (consumer) | Set the type of events to listen for | EVICTED,EXPIRED,REMOVED,CREATED,UPDATED | Set -| **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 -| **action** (producer) | To configure the default cache action. If an action is set in the message header then the operation from the header takes precedence. | | String -| **key** (producer) | To configure the default action key. If a key is set in the message header then the key from the header takes precedence. | | Object -| **configuration** (advanced) | The default cache configuration to be used to create caches. | | CacheConfiguration<?,?> -| **configurations** (advanced) | A map of cache configuration to be used to create caches. | | Map -| **keyType** (advanced) | The cache key type default java.lang.Object | java.lang.Object | String -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **valueType** (advanced) | The cache value type default java.lang.Object | java.lang.Object | String -|======================================================================= +| *cacheManager* (common) | The cache manager | | CacheManager +| *cacheManagerConfiguration* (common) | The cache manager configuration | | Configuration +| *configurationUri* (common) | URI pointing to the Ehcache XML configuration file's location | | String +| *createCacheIfNotExist* (common) | Configure if a cache need to be created if it does exist or can't be pre-configured. | true | 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 +| *eventFiring* (consumer) | Set the the delivery mode (synchronous asynchronous) | ASYNCHRONOUS | EventFiring +| *eventOrdering* (consumer) | Set the the delivery mode (ordered unordered) | ORDERED | EventOrdering +| *eventTypes* (consumer) | Set the type of events to listen for | EVICTED,EXPIRED,REMOVED,CREATED,UPDATED | Set +| *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 +| *action* (producer) | To configure the default cache action. If an action is set in the message header then the operation from the header takes precedence. | | String +| *key* (producer) | To configure the default action key. If a key is set in the message header then the key from the header takes precedence. | | Object +| *configuration* (advanced) | The default cache configuration to be used to create caches. | | CacheConfiguration<?,?> +| *configurations* (advanced) | A map of cache configuration to be used to create caches. | | Map +| *keyType* (advanced) | The cache key type default java.lang.Object | java.lang.Object | String +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *valueType* (advanced) | The cache value type default java.lang.Object | java.lang.Object | String +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-ejb/src/main/docs/ejb-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-ejb/src/main/docs/ejb-component.adoc b/components/camel-ejb/src/main/docs/ejb-component.adoc index b64d444..cd66d0b 100644 --- a/components/camel-ejb/src/main/docs/ejb-component.adoc +++ b/components/camel-ejb/src/main/docs/ejb-component.adoc @@ -1,4 +1,4 @@ -## EJB Component +== EJB Component *Available as of Camel version 2.4* @@ -37,12 +37,12 @@ The EJB component supports 3 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **context** (producer) | The Context to use for looking up the EJBs | | Context -| **properties** (producer) | Properties for creating javax.naming.Context if a context has not been configured. | | Properties -| **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 -|======================================================================= +| *context* (producer) | The Context to use for looking up the EJBs | | Context +| *properties* (producer) | Properties for creating javax.naming.Context if a context has not been configured. | | Properties +| *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 @@ -51,29 +51,31 @@ The EJB component supports 3 options which are listed below. // endpoint options: START The EJB endpoint is configured using URI syntax: - ejb:beanName +---- +ejb:beanName +---- 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 -| **beanName** | *Required* Sets the name of the bean to invoke | | String -|======================================================================= +| *beanName* | *Required* Sets the name of the bean to invoke | | String +|=== -#### Query Parameters (5 parameters): +==== Query Parameters (5 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **method** (producer) | Sets the name of the method to invoke on the bean | | String -| **cache** (advanced) | If enabled Camel will cache the result of the first Registry look-up. Cache can be enabled if the bean in the Registry is defined as a singleton scope. | false | boolean -| **multiParameterArray** (advanced) | *Deprecated* How to treat the parameters which are passed from the message body.true means the message body should be an array of parameters.. Deprecation note: This option is used internally by Camel and is not intended for end users to use. Deprecation note: This option is used internally by Camel, and is not intended for end users to use. | false | boolean -| **parameters** (advanced) | Used for configuring additional properties on the bean | | Map -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *method* (producer) | Sets the name of the method to invoke on the bean | | String +| *cache* (advanced) | If enabled Camel will cache the result of the first Registry look-up. Cache can be enabled if the bean in the Registry is defined as a singleton scope. | false | boolean +| *multiParameterArray* (advanced) | *Deprecated* How to treat the parameters which are passed from the message body.true means the message body should be an array of parameters.. Deprecation note: This option is used internally by Camel and is not intended for end users to use. Deprecation note: This option is used internally by Camel, and is not intended for end users to use. | false | boolean +| *parameters* (advanced) | Used for configuring additional properties on the bean | | Map +| *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/camel-elasticsearch/src/main/docs/elasticsearch-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-elasticsearch/src/main/docs/elasticsearch-component.adoc b/components/camel-elasticsearch/src/main/docs/elasticsearch-component.adoc index dadb762..b160c9e 100644 --- a/components/camel-elasticsearch/src/main/docs/elasticsearch-component.adoc +++ b/components/camel-elasticsearch/src/main/docs/elasticsearch-component.adoc @@ -1,4 +1,4 @@ -## Elasticsearch Component +== Elasticsearch Component *Available as of Camel version 2.11* @@ -36,11 +36,11 @@ The Elasticsearch component supports 2 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **client** (advanced) | To use an existing configured Elasticsearch client instead of creating a client per endpoint. | | Client -| **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 -|======================================================================= +| *client* (advanced) | To use an existing configured Elasticsearch client instead of creating a client per endpoint. | | Client +| *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 @@ -50,35 +50,37 @@ The Elasticsearch component supports 2 options which are listed below. // endpoint options: START The Elasticsearch endpoint is configured using URI syntax: - elasticsearch:clusterName +---- +elasticsearch:clusterName +---- 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 -| **clusterName** | *Required* Name of cluster or use local for local mode | | String -|======================================================================= +| *clusterName* | *Required* Name of cluster or use local for local mode | | String +|=== -#### Query Parameters (11 parameters): +==== Query Parameters (11 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **clientTransportSniff** (producer) | Is the client allowed to sniff the rest of the cluster or not (default true). This setting map to the client.transport.sniff setting. | true | Boolean -| **consistencyLevel** (producer) | The write consistency level to use with INDEX and BULK operations (can be any of ONE QUORUM ALL or DEFAULT) | DEFAULT | WriteConsistencyLevel -| **data** (producer) | Is the node going to be allowed to allocate data (shards) to it or not. This setting map to the node.data setting. | | Boolean -| **indexName** (producer) | The name of the index to act against | | String -| **indexType** (producer) | The type of the index to act against | | String -| **ip** (producer) | The TransportClient remote host ip to use | | String -| **operation** (producer) | What operation to perform | | String -| **pathHome** (producer) | The path.home property of ElasticSearch configuration. You need to provide a valid path otherwise the default $user.home/.elasticsearch will be used. | ${user.home}/.elasticsearch | String -| **port** (producer) | The TransportClient remote port to use (defaults to 9300) | 9300 | int -| **transportAddresses** (producer) | Comma separated list with ip:port formatted remote transport addresses to use. The ip and port options must be left blank for transportAddresses to be considered instead. | | String -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *clientTransportSniff* (producer) | Is the client allowed to sniff the rest of the cluster or not (default true). This setting map to the client.transport.sniff setting. | true | Boolean +| *consistencyLevel* (producer) | The write consistency level to use with INDEX and BULK operations (can be any of ONE QUORUM ALL or DEFAULT) | DEFAULT | WriteConsistencyLevel +| *data* (producer) | Is the node going to be allowed to allocate data (shards) to it or not. This setting map to the node.data setting. | | Boolean +| *indexName* (producer) | The name of the index to act against | | String +| *indexType* (producer) | The type of the index to act against | | String +| *ip* (producer) | The TransportClient remote host ip to use | | String +| *operation* (producer) | What operation to perform | | String +| *pathHome* (producer) | The path.home property of ElasticSearch configuration. You need to provide a valid path otherwise the default $user.home/.elasticsearch will be used. | ${user.home}/.elasticsearch | String +| *port* (producer) | The TransportClient remote port to use (defaults to 9300) | 9300 | int +| *transportAddresses* (producer) | Comma separated list with ip:port formatted remote transport addresses to use. The ip and port options must be left blank for transportAddresses to be considered instead. | | 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 ### Local testing http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-elasticsearch5/src/main/docs/elasticsearch5-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-elasticsearch5/src/main/docs/elasticsearch5-component.adoc b/components/camel-elasticsearch5/src/main/docs/elasticsearch5-component.adoc index be023f2..5ad25df 100644 --- a/components/camel-elasticsearch5/src/main/docs/elasticsearch5-component.adoc +++ b/components/camel-elasticsearch5/src/main/docs/elasticsearch5-component.adoc @@ -1,4 +1,4 @@ -## Elasticsearch5 Component +== Elasticsearch5 Component *Available as of Camel version 2.19* @@ -36,11 +36,11 @@ The Elasticsearch5 component supports 2 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **client** (advanced) | To use an existing configured Elasticsearch client instead of creating a client per endpoint. This allow to customize the client with specific settings. | | TransportClient -| **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 -|======================================================================= +| *client* (advanced) | To use an existing configured Elasticsearch client instead of creating a client per endpoint. This allow to customize the client with specific settings. | | TransportClient +| *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 @@ -50,40 +50,42 @@ The Elasticsearch5 component supports 2 options which are listed below. // endpoint options: START The Elasticsearch5 endpoint is configured using URI syntax: - elasticsearch5:clusterName +---- +elasticsearch5:clusterName +---- 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 -| **clusterName** | *Required* Name of the cluster | | String -|======================================================================= +| *clusterName* | *Required* Name of the cluster | | String +|=== -#### Query Parameters (16 parameters): +==== Query Parameters (16 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **clientTransportSniff** (producer) | Is the client allowed to sniff the rest of the cluster or not. This setting map to the client.transport.sniff setting. | false | boolean -| **indexName** (producer) | The name of the index to act against | | String -| **indexType** (producer) | The type of the index to act against | | String -| **ip** (producer) | The TransportClient remote host ip to use | | String -| **operation** (producer) | What operation to perform | | ElasticsearchOperation -| **pingSchedule** (producer) | The time(in unit) the client ping the cluster. | 5s | String -| **pingTimeout** (producer) | The time(in unit) to wait for a ping response from a node too return. | 5s | String -| **port** (producer) | The TransportClient remote port to use (defaults to 9300) | 9300 | int -| **tcpCompress** (producer) | true if compression (LZF) enable between all nodes. | false | boolean -| **tcpConnectTimeout** (producer) | The time( in unit) to wait for connection timeout. | 30s | String -| **transportAddresses** (producer) | Comma separated list with ip:port formatted remote transport addresses to use. The ip and port options must be left blank for transportAddresses to be considered instead. | | String -| **waitForActiveShards** (producer) | Index creation waits for the write consistency number of shards to be available | 1 | int -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **enableSSL** (security) | Enable SSL. Require XPack client jar on the classpath | false | boolean -| **password** (authentication) | Password for authenticate against the cluster. Require XPack client jar on the classpath | | String -| **user** (authentication) | User for authenticate against the cluster. Requires transport_client role for accessing the cluster. Require XPack client jar on the classpath | | String -|======================================================================= +| *clientTransportSniff* (producer) | Is the client allowed to sniff the rest of the cluster or not. This setting map to the client.transport.sniff setting. | false | boolean +| *indexName* (producer) | The name of the index to act against | | String +| *indexType* (producer) | The type of the index to act against | | String +| *ip* (producer) | The TransportClient remote host ip to use | | String +| *operation* (producer) | What operation to perform | | ElasticsearchOperation +| *pingSchedule* (producer) | The time(in unit) the client ping the cluster. | 5s | String +| *pingTimeout* (producer) | The time(in unit) to wait for a ping response from a node too return. | 5s | String +| *port* (producer) | The TransportClient remote port to use (defaults to 9300) | 9300 | int +| *tcpCompress* (producer) | true if compression (LZF) enable between all nodes. | false | boolean +| *tcpConnectTimeout* (producer) | The time( in unit) to wait for connection timeout. | 30s | String +| *transportAddresses* (producer) | Comma separated list with ip:port formatted remote transport addresses to use. The ip and port options must be left blank for transportAddresses to be considered instead. | | String +| *waitForActiveShards* (producer) | Index creation waits for the write consistency number of shards to be available | 1 | int +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *enableSSL* (security) | Enable SSL. Require XPack client jar on the classpath | false | boolean +| *password* (authentication) | Password for authenticate against the cluster. Require XPack client jar on the classpath | | String +| *user* (authentication) | User for authenticate against the cluster. Requires transport_client role for accessing the cluster. Require XPack client jar on the classpath | | String +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-elsql/src/main/docs/elsql-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-elsql/src/main/docs/elsql-component.adoc b/components/camel-elsql/src/main/docs/elsql-component.adoc index 5d083ce..716ea71 100644 --- a/components/camel-elsql/src/main/docs/elsql-component.adoc +++ b/components/camel-elsql/src/main/docs/elsql-component.adoc @@ -1,4 +1,4 @@ -## ElSQL Component +== ElSQL Component *Available as of Camel version 2.16* @@ -54,85 +54,87 @@ The ElSQL component supports 5 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **databaseVendor** (common) | To use a vendor specific com.opengamma.elsql.ElSqlConfig | | ElSqlDatabaseVendor -| **dataSource** (common) | Sets the DataSource to use to communicate with the database. | | DataSource -| **elSqlConfig** (advanced) | To use a specific configured ElSqlConfig. It may be better to use the databaseVendor option instead. | | ElSqlConfig -| **resourceUri** (common) | The resource file which contains the elsql SQL statements to use. You can specify multiple resources separated by comma. The resources are loaded on the classpath by default you can prefix with file: to load from file system. Notice you can set this option on the component and then you do not have to configure this on the endpoint. | | 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 -|======================================================================= +| *databaseVendor* (common) | To use a vendor specific com.opengamma.elsql.ElSqlConfig | | ElSqlDatabaseVendor +| *dataSource* (common) | Sets the DataSource to use to communicate with the database. | | DataSource +| *elSqlConfig* (advanced) | To use a specific configured ElSqlConfig. It may be better to use the databaseVendor option instead. | | ElSqlConfig +| *resourceUri* (common) | The resource file which contains the elsql SQL statements to use. You can specify multiple resources separated by comma. The resources are loaded on the classpath by default you can prefix with file: to load from file system. Notice you can set this option on the component and then you do not have to configure this on the endpoint. | | 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 ElSQL endpoint is configured using URI syntax: - elsql:elsqlName:resourceUri +---- +elsql:elsqlName:resourceUri +---- 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 -| **elsqlName** | *Required* The name of the elsql to use (is NAMED in the elsql file) | | String -| **resourceUri** | The resource file which contains the elsql SQL statements to use. You can specify multiple resources separated by comma. The resources are loaded on the classpath by default you can prefix with file: to load from file system. Notice you can set this option on the component and then you do not have to configure this on the endpoint. | | String -|======================================================================= +| *elsqlName* | *Required* The name of the elsql to use (is NAMED in the elsql file) | | String +| *resourceUri* | The resource file which contains the elsql SQL statements to use. You can specify multiple resources separated by comma. The resources are loaded on the classpath by default you can prefix with file: to load from file system. Notice you can set this option on the component and then you do not have to configure this on the endpoint. | | String +|=== -#### Query Parameters (47 parameters): +==== Query Parameters (47 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **allowNamedParameters** (common) | Whether to allow using named parameters in the queries. | true | boolean -| **databaseVendor** (common) | To use a vendor specific com.opengamma.elsql.ElSqlConfig | | ElSqlDatabaseVendor -| **dataSource** (common) | Sets the DataSource to use to communicate with the database. | | DataSource -| **dataSourceRef** (common) | *Deprecated* Sets the reference to a DataSource to lookup from the registry to use for communicating with the database. | | String -| **outputClass** (common) | Specify the full package and class name to use as conversion when outputType=SelectOne. | | String -| **outputHeader** (common) | Store the query result in a header instead of the message body. By default outputHeader == null and the query result is stored in the message body any existing content in the message body is discarded. If outputHeader is set the value is used as the name of the header to store the query result and the original message body is preserved. | | String -| **outputType** (common) | Make the output of consumer or producer to SelectList as List of Map or SelectOne as single Java object in the following way:a) If the query has only single column then that JDBC Column object is returned. (such as SELECT COUNT( ) FROM PROJECT will return a Long object.b) If the query has more than one column then it will return a Map of that result.c) If the outputClass is set then it will convert the query result into an Java bean object by calling all the setters that match the column names.It will assume your class has a default constructor to create instance with.d) If the query resulted in more than one rows it throws an non-unique result exception.StreamList streams the result of the query using an Iterator. This can be used with the Splitter EIP in streaming mode to process the ResultSet in streaming fashion. | SelectList | SqlOutputType -| **separator** (common) | The separator to use when parameter values is taken from message body (if the body is a String type) to be inserted at placeholders.Notice if you use named parameters then a Map type is used instead. The default value is comma | , | char -| **breakBatchOnConsumeFail** (consumer) | Sets whether to break batch if onConsume failed. | 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 -| **expectedUpdateCount** (consumer) | Sets an expected update count to validate when using onConsume. | -1 | int -| **maxMessagesPerPoll** (consumer) | Sets the maximum number of messages to poll | | int -| **onConsume** (consumer) | After processing each row then this query can be executed if the Exchange was processed successfully for example to mark the row as processed. The query can have parameter. | | String -| **onConsumeBatchComplete** (consumer) | After processing the entire batch this query can be executed to bulk update rows etc. The query cannot have parameters. | | String -| **onConsumeFailed** (consumer) | After processing each row then this query can be executed if the Exchange failed for example to mark the row as failed. The query can have parameter. | | String -| **routeEmptyResultSet** (consumer) | Sets whether empty resultset should be allowed to be sent to the next hop. Defaults to false. So the empty resultset will be filtered out. | false | boolean -| **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 -| **transacted** (consumer) | Enables or disables transaction. If enabled then if processing an exchange failed then the consumerbreak out processing any further exchanges to cause a rollback eager. | false | boolean -| **useIterator** (consumer) | Sets how resultset should be delivered to route. Indicates delivery as either a list or individual object. defaults to true. | 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 -| **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 -| **processingStrategy** (consumer) | Allows to plugin to use a custom org.apache.camel.component.sql.SqlProcessingStrategy to execute queries when the consumer has processed the rows/batch. | | SqlProcessingStrategy -| **batch** (producer) | Enables or disables batch mode | false | boolean -| **noop** (producer) | If set will ignore the results of the SQL query and use the existing IN message as the OUT message for the continuation of processing | false | boolean -| **useMessageBodyForSql** (producer) | Whether to use the message body as the SQL and then headers for parameters. If this option is enabled then the SQL in the uri is not used. | false | boolean -| **alwaysPopulateStatement** (producer) | If enabled then the populateStatement method from org.apache.camel.component.sql.SqlPrepareStatementStrategy is always invoked also if there is no expected parameters to be prepared. When this is false then the populateStatement is only invoked if there is 1 or more expected parameters to be set; for example this avoids reading the message body/headers for SQL queries with no parameters. | false | boolean -| **parametersCount** (producer) | If set greater than zero then Camel will use this count value of parameters to replace instead of querying via JDBC metadata API. This is useful if the JDBC vendor could not return correct parameters count then user may override instead. | | int -| **elSqlConfig** (advanced) | To use a specific configured ElSqlConfig. It may be better to use the databaseVendor option instead. | | ElSqlConfig -| **placeholder** (advanced) | Specifies a character that will be replaced to in SQL query. Notice that it is simple String.replaceAll() operation and no SQL parsing is involved (quoted strings will also change). | # | String -| **prepareStatementStrategy** (advanced) | Allows to plugin to use a custom org.apache.camel.component.sql.SqlPrepareStatementStrategy to control preparation of the query and prepared statement. | | SqlPrepareStatement Strategy -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **templateOptions** (advanced) | Configures the Spring JdbcTemplate with the key/values from the Map | | Map -| **usePlaceholder** (advanced) | Sets whether to use placeholder and replace all placeholder characters with sign in the SQL queries. | true | 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 -| **delay** (scheduler) | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 500 | long -| **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 -|======================================================================= +| *allowNamedParameters* (common) | Whether to allow using named parameters in the queries. | true | boolean +| *databaseVendor* (common) | To use a vendor specific com.opengamma.elsql.ElSqlConfig | | ElSqlDatabaseVendor +| *dataSource* (common) | Sets the DataSource to use to communicate with the database. | | DataSource +| *dataSourceRef* (common) | *Deprecated* Sets the reference to a DataSource to lookup from the registry to use for communicating with the database. | | String +| *outputClass* (common) | Specify the full package and class name to use as conversion when outputType=SelectOne. | | String +| *outputHeader* (common) | Store the query result in a header instead of the message body. By default outputHeader == null and the query result is stored in the message body any existing content in the message body is discarded. If outputHeader is set the value is used as the name of the header to store the query result and the original message body is preserved. | | String +| *outputType* (common) | Make the output of consumer or producer to SelectList as List of Map or SelectOne as single Java object in the following way:a) If the query has only single column then that JDBC Column object is returned. (such as SELECT COUNT( ) FROM PROJECT will return a Long object.b) If the query has more than one column then it will return a Map of that result.c) If the outputClass is set then it will convert the query result into an Java bean object by calling all the setters that match the column names.It will assume your class has a default constructor to create instance with.d) If the query resulted in more than one rows it throws an non-unique result exception.StreamList streams the result of the query using an Iterator. This can be used with the Splitter EIP in streaming mode to process the ResultSet in streaming fashion. | SelectList | SqlOutputType +| *separator* (common) | The separator to use when parameter values is taken from message body (if the body is a String type) to be inserted at placeholders.Notice if you use named parameters then a Map type is used instead. The default value is comma | , | char +| *breakBatchOnConsumeFail* (consumer) | Sets whether to break batch if onConsume failed. | 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 +| *expectedUpdateCount* (consumer) | Sets an expected update count to validate when using onConsume. | -1 | int +| *maxMessagesPerPoll* (consumer) | Sets the maximum number of messages to poll | | int +| *onConsume* (consumer) | After processing each row then this query can be executed if the Exchange was processed successfully for example to mark the row as processed. The query can have parameter. | | String +| *onConsumeBatchComplete* (consumer) | After processing the entire batch this query can be executed to bulk update rows etc. The query cannot have parameters. | | String +| *onConsumeFailed* (consumer) | After processing each row then this query can be executed if the Exchange failed for example to mark the row as failed. The query can have parameter. | | String +| *routeEmptyResultSet* (consumer) | Sets whether empty resultset should be allowed to be sent to the next hop. Defaults to false. So the empty resultset will be filtered out. | false | boolean +| *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 +| *transacted* (consumer) | Enables or disables transaction. If enabled then if processing an exchange failed then the consumerbreak out processing any further exchanges to cause a rollback eager. | false | boolean +| *useIterator* (consumer) | Sets how resultset should be delivered to route. Indicates delivery as either a list or individual object. defaults to true. | 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 +| *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 +| *processingStrategy* (consumer) | Allows to plugin to use a custom org.apache.camel.component.sql.SqlProcessingStrategy to execute queries when the consumer has processed the rows/batch. | | SqlProcessingStrategy +| *batch* (producer) | Enables or disables batch mode | false | boolean +| *noop* (producer) | If set will ignore the results of the SQL query and use the existing IN message as the OUT message for the continuation of processing | false | boolean +| *useMessageBodyForSql* (producer) | Whether to use the message body as the SQL and then headers for parameters. If this option is enabled then the SQL in the uri is not used. | false | boolean +| *alwaysPopulateStatement* (producer) | If enabled then the populateStatement method from org.apache.camel.component.sql.SqlPrepareStatementStrategy is always invoked also if there is no expected parameters to be prepared. When this is false then the populateStatement is only invoked if there is 1 or more expected parameters to be set; for example this avoids reading the message body/headers for SQL queries with no parameters. | false | boolean +| *parametersCount* (producer) | If set greater than zero then Camel will use this count value of parameters to replace instead of querying via JDBC metadata API. This is useful if the JDBC vendor could not return correct parameters count then user may override instead. | | int +| *elSqlConfig* (advanced) | To use a specific configured ElSqlConfig. It may be better to use the databaseVendor option instead. | | ElSqlConfig +| *placeholder* (advanced) | Specifies a character that will be replaced to in SQL query. Notice that it is simple String.replaceAll() operation and no SQL parsing is involved (quoted strings will also change). | # | String +| *prepareStatementStrategy* (advanced) | Allows to plugin to use a custom org.apache.camel.component.sql.SqlPrepareStatementStrategy to control preparation of the query and prepared statement. | | SqlPrepareStatement Strategy +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *templateOptions* (advanced) | Configures the Spring JdbcTemplate with the key/values from the Map | | Map +| *usePlaceholder* (advanced) | Sets whether to use placeholder and replace all placeholder characters with sign in the SQL queries. | true | 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 +| *delay* (scheduler) | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 500 | long +| *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 +|=== // endpoint options: END ### Result of the query
