http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-ignite/src/main/docs/ignite-queue-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-ignite/src/main/docs/ignite-queue-component.adoc b/components/camel-ignite/src/main/docs/ignite-queue-component.adoc index 6518f0b..98cd937 100644 --- a/components/camel-ignite/src/main/docs/ignite-queue-component.adoc +++ b/components/camel-ignite/src/main/docs/ignite-queue-component.adoc @@ -1,4 +1,4 @@ -## Ignite Queues Component +== Ignite Queues Component *Available as of Camel version 2.17* @@ -14,43 +14,45 @@ The Ignite Queues component supports 4 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **ignite** (producer) | Sets the Ignite instance. | | Ignite -| **configurationResource** (producer) | Sets the resource from where to load the configuration. It can be a: URI String (URI) or an InputStream. | | Object -| **igniteConfiguration** (producer) | Allows the user to set a programmatic IgniteConfiguration. | | IgniteConfiguration -| **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 -|======================================================================= +| *ignite* (producer) | Sets the Ignite instance. | | Ignite +| *configurationResource* (producer) | Sets the resource from where to load the configuration. It can be a: URI String (URI) or an InputStream. | | Object +| *igniteConfiguration* (producer) | Allows the user to set a programmatic IgniteConfiguration. | | IgniteConfiguration +| *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 Ignite Queues endpoint is configured using URI syntax: - ignite-queue:name +---- +ignite-queue: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* The queue name. | | String -|======================================================================= +| *name* | *Required* The queue name. | | String +|=== -#### Query Parameters (7 parameters): +==== Query Parameters (7 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **capacity** (producer) | The queue capacity. Default: non-bounded. | | int -| **configuration** (producer) | The collection configuration. Default: empty configuration. You can also conveniently set inner properties by using configuration.xyz=123 options. | | CollectionConfiguration -| **operation** (producer) | The operation to invoke on the Ignite Queue. Superseded by the IgniteConstants.IGNITE_QUEUE_OPERATION header in the IN message. Possible values: CONTAINS ADD SIZE REMOVE ITERATOR CLEAR RETAIN_ALL ARRAY DRAIN ELEMENT PEEK OFFER POLL TAKE PUT. | | IgniteQueueOperation -| **propagateIncomingBodyIfNo ReturnValue** (producer) | Sets whether to propagate the incoming body if the return type of the underlying Ignite operation is void. | true | boolean -| **timeoutMillis** (producer) | The queue timeout in milliseconds. Default: no timeout. | | Long -| **treatCollectionsAsCache Objects** (producer) | Sets whether to treat Collections as cache objects or as Collections of items to insert/update/compute etc. | false | boolean -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *capacity* (producer) | The queue capacity. Default: non-bounded. | | int +| *configuration* (producer) | The collection configuration. Default: empty configuration. You can also conveniently set inner properties by using configuration.xyz=123 options. | | CollectionConfiguration +| *operation* (producer) | The operation to invoke on the Ignite Queue. Superseded by the IgniteConstants.IGNITE_QUEUE_OPERATION header in the IN message. Possible values: CONTAINS ADD SIZE REMOVE ITERATOR CLEAR RETAIN_ALL ARRAY DRAIN ELEMENT PEEK OFFER POLL TAKE PUT. | | IgniteQueueOperation +| *propagateIncomingBodyIfNo ReturnValue* (producer) | Sets whether to propagate the incoming body if the return type of the underlying Ignite operation is void. | true | boolean +| *timeoutMillis* (producer) | The queue timeout in milliseconds. Default: no timeout. | | Long +| *treatCollectionsAsCache Objects* (producer) | Sets whether to treat Collections as cache objects or as Collections of items to insert/update/compute etc. | 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 @@ -73,4 +75,3 @@ The amount of items transferred as the result of the DRAIN operation. | CamelIgniteQueueTimeoutMillis | IgniteConstants.IGNITE_QUEUE_TIMEOUT_MILLIS | Long or long | Dynamically sets the timeout in milliseconds to use when invoking the OFFER or POLL operations. |======================================================================= -
http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-ignite/src/main/docs/ignite-set-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-ignite/src/main/docs/ignite-set-component.adoc b/components/camel-ignite/src/main/docs/ignite-set-component.adoc index 6d2b7a6..f705688 100644 --- a/components/camel-ignite/src/main/docs/ignite-set-component.adoc +++ b/components/camel-ignite/src/main/docs/ignite-set-component.adoc @@ -1,4 +1,4 @@ -## Ignite Sets Component +== Ignite Sets Component *Available as of Camel version 2.17* @@ -14,41 +14,43 @@ The Ignite Sets component supports 4 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **ignite** (producer) | Sets the Ignite instance. | | Ignite -| **configurationResource** (producer) | Sets the resource from where to load the configuration. It can be a: URI String (URI) or an InputStream. | | Object -| **igniteConfiguration** (producer) | Allows the user to set a programmatic IgniteConfiguration. | | IgniteConfiguration -| **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 -|======================================================================= +| *ignite* (producer) | Sets the Ignite instance. | | Ignite +| *configurationResource* (producer) | Sets the resource from where to load the configuration. It can be a: URI String (URI) or an InputStream. | | Object +| *igniteConfiguration* (producer) | Allows the user to set a programmatic IgniteConfiguration. | | IgniteConfiguration +| *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 Ignite Sets endpoint is configured using URI syntax: - ignite-set:name +---- +ignite-set: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* The set name. | | String -|======================================================================= +| *name* | *Required* The set name. | | String +|=== -#### Query Parameters (5 parameters): +==== Query Parameters (5 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **configuration** (producer) | The collection configuration. Default: empty configuration. You can also conveniently set inner properties by using configuration.xyz=123 options. | | CollectionConfiguration -| **operation** (producer) | The operation to invoke on the Ignite Set. Superseded by the IgniteConstants.IGNITE_SETS_OPERATION header in the IN message. Possible values: CONTAINS ADD SIZE REMOVE ITERATOR CLEAR RETAIN_ALL ARRAY.The set operation to perform. | | IgniteSetOperation -| **propagateIncomingBodyIfNo ReturnValue** (producer) | Sets whether to propagate the incoming body if the return type of the underlying Ignite operation is void. | true | boolean -| **treatCollectionsAsCache Objects** (producer) | Sets whether to treat Collections as cache objects or as Collections of items to insert/update/compute etc. | false | boolean -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *configuration* (producer) | The collection configuration. Default: empty configuration. You can also conveniently set inner properties by using configuration.xyz=123 options. | | CollectionConfiguration +| *operation* (producer) | The operation to invoke on the Ignite Set. Superseded by the IgniteConstants.IGNITE_SETS_OPERATION header in the IN message. Possible values: CONTAINS ADD SIZE REMOVE ITERATOR CLEAR RETAIN_ALL ARRAY.The set operation to perform. | | IgniteSetOperation +| *propagateIncomingBodyIfNo ReturnValue* (producer) | Sets whether to propagate the incoming body if the return type of the underlying Ignite operation is void. | true | boolean +| *treatCollectionsAsCache Objects* (producer) | Sets whether to treat Collections as cache objects or as Collections of items to insert/update/compute etc. | 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 @@ -62,4 +64,3 @@ This endpoint uses the following headers: | CamelIgniteSetsOperation | IgniteConstants.IGNITE_SETS_OPERATION | IgniteSetOperation enum | Allows you to dynamically change the set operation. |======================================================================= - http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-infinispan/src/main/docs/infinispan-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-infinispan/src/main/docs/infinispan-component.adoc b/components/camel-infinispan/src/main/docs/infinispan-component.adoc index 4cdcb70..d1df3e3 100644 --- a/components/camel-infinispan/src/main/docs/infinispan-component.adoc +++ b/components/camel-infinispan/src/main/docs/infinispan-component.adoc @@ -1,4 +1,4 @@ -## Infinispan Component +== Infinispan Component *Available as of Camel version 2.13* @@ -43,12 +43,12 @@ The Infinispan component supports 3 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **configuration** (common) | The default configuration shared among endpoints. | | InfinispanConfiguration -| **cacheContainer** (common) | The default cache container. | | BasicCacheContainer -| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean -|======================================================================= +| *configuration* (common) | The default configuration shared among endpoints. | | InfinispanConfiguration +| *cacheContainer* (common) | The default cache container. | | BasicCacheContainer +| *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 @@ -57,42 +57,44 @@ The Infinispan component supports 3 options which are listed below. // endpoint options: START The Infinispan endpoint is configured using URI syntax: - infinispan:cacheName +---- +infinispan: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 to use | | String -|======================================================================= +| *cacheName* | *Required* The cache to use | | String +|=== -#### Query Parameters (18 parameters): +==== Query Parameters (18 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **hosts** (common) | Specifies the host of the cache on Infinispan instance | | String -| **queryBuilder** (common) | Specifies the query builder. | | InfinispanQueryBuilder -| **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 -| **clusteredListener** (consumer) | If true the listener will be installed for the entire cluster | false | boolean -| **command** (consumer) | *Deprecated* The operation to perform. | PUT | String -| **customListener** (consumer) | Returns the custom listener in use if provided | | InfinispanCustom Listener -| **eventTypes** (consumer) | Specifies the set of event types to register by the consumer. Multiple event can be separated by comma. The possible event types are: CACHE_ENTRY_ACTIVATED CACHE_ENTRY_PASSIVATED CACHE_ENTRY_VISITED CACHE_ENTRY_LOADED CACHE_ENTRY_EVICTED CACHE_ENTRY_CREATED CACHE_ENTRY_REMOVED CACHE_ENTRY_MODIFIED TRANSACTION_COMPLETED TRANSACTION_REGISTERED CACHE_ENTRY_INVALIDATED DATA_REHASHED TOPOLOGY_CHANGED PARTITION_STATUS_CHANGED | | String -| **sync** (consumer) | If true the consumer will receive notifications synchronously | 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 -| **operation** (producer) | The operation to perform. | PUT | InfinispanOperation -| **cacheContainer** (advanced) | Specifies the cache Container to connect | | BasicCacheContainer -| **cacheContainerConfiguration** (advanced) | The CacheContainer configuration | | Object -| **configurationProperties** (advanced) | Implementation specific properties for the CacheManager | | Map -| **configurationUri** (advanced) | An implementation specific URI for the CacheManager | | String -| **flags** (advanced) | A comma separated list of Flag to be applied by default on each cache invocation not applicable to remote caches. | | String -| **resultHeader** (advanced) | Store the operation result in a header instead of the message body. By default resultHeader == null and the query result is stored in the message body any existing content in the message body is discarded. If resultHeader is set the value is used as the name of the header to store the query result and the original message body is preserved. This value can be overridden by an in message header named: CamelInfinispanOperationResultHeader | | Object -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *hosts* (common) | Specifies the host of the cache on Infinispan instance | | String +| *queryBuilder* (common) | Specifies the query builder. | | InfinispanQueryBuilder +| *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 +| *clusteredListener* (consumer) | If true the listener will be installed for the entire cluster | false | boolean +| *command* (consumer) | *Deprecated* The operation to perform. | PUT | String +| *customListener* (consumer) | Returns the custom listener in use if provided | | InfinispanCustom Listener +| *eventTypes* (consumer) | Specifies the set of event types to register by the consumer. Multiple event can be separated by comma. The possible event types are: CACHE_ENTRY_ACTIVATED CACHE_ENTRY_PASSIVATED CACHE_ENTRY_VISITED CACHE_ENTRY_LOADED CACHE_ENTRY_EVICTED CACHE_ENTRY_CREATED CACHE_ENTRY_REMOVED CACHE_ENTRY_MODIFIED TRANSACTION_COMPLETED TRANSACTION_REGISTERED CACHE_ENTRY_INVALIDATED DATA_REHASHED TOPOLOGY_CHANGED PARTITION_STATUS_CHANGED | | String +| *sync* (consumer) | If true the consumer will receive notifications synchronously | 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 +| *operation* (producer) | The operation to perform. | PUT | InfinispanOperation +| *cacheContainer* (advanced) | Specifies the cache Container to connect | | BasicCacheContainer +| *cacheContainerConfiguration* (advanced) | The CacheContainer configuration | | Object +| *configurationProperties* (advanced) | Implementation specific properties for the CacheManager | | Map +| *configurationUri* (advanced) | An implementation specific URI for the CacheManager | | String +| *flags* (advanced) | A comma separated list of Flag to be applied by default on each cache invocation not applicable to remote caches. | | String +| *resultHeader* (advanced) | Store the operation result in a header instead of the message body. By default resultHeader == null and the query result is stored in the message body any existing content in the message body is discarded. If resultHeader is set the value is used as the name of the header to store the query result and the original message body is preserved. This value can be overridden by an in message header named: CamelInfinispanOperationResultHeader | | Object +| *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-influxdb/src/main/docs/influxdb-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-influxdb/src/main/docs/influxdb-component.adoc b/components/camel-influxdb/src/main/docs/influxdb-component.adoc index dff543d..6f0161e 100644 --- a/components/camel-influxdb/src/main/docs/influxdb-component.adoc +++ b/components/camel-influxdb/src/main/docs/influxdb-component.adoc @@ -1,4 +1,4 @@ -## InfluxDB Component +== InfluxDB Component *Available as of Camel version 2.18* @@ -50,30 +50,32 @@ The InfluxDB component has no options. // endpoint options: START The InfluxDB endpoint is configured using URI syntax: - influxdb:connectionBean +---- +influxdb:connectionBean +---- 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 -| **connectionBean** | *Required* Connection to the influx database of class InfluxDB.class | | String -|======================================================================= +| *connectionBean* | *Required* Connection to the influx database of class InfluxDB.class | | String +|=== -#### Query Parameters (6 parameters): +==== Query Parameters (6 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **batch** (producer) | Define if this operation is a batch operation or not | false | boolean -| **databaseName** (producer) | The name of the database where the time series will be stored | | String -| **operation** (producer) | Define if this operation is an insert or a query | insert | String -| **query** (producer) | Define the query in case of operation query | | String -| **retentionPolicy** (producer) | The string that defines the retention policy to the data created by the endpoint | default | String -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *batch* (producer) | Define if this operation is a batch operation or not | false | boolean +| *databaseName* (producer) | The name of the database where the time series will be stored | | String +| *operation* (producer) | Define if this operation is an insert or a query | insert | String +| *query* (producer) | Define the query in case of operation query | | String +| *retentionPolicy* (producer) | The string that defines the retention policy to the data created by the endpoint | default | String +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-irc/src/main/docs/irc-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-irc/src/main/docs/irc-component.adoc b/components/camel-irc/src/main/docs/irc-component.adoc index 6f68e41..a6eb8cd 100644 --- a/components/camel-irc/src/main/docs/irc-component.adoc +++ b/components/camel-irc/src/main/docs/irc-component.adoc @@ -1,4 +1,4 @@ -## IRC Component +== IRC Component *Available as of Camel version 1.1* @@ -39,11 +39,11 @@ The IRC component supports 2 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **useGlobalSslContext Parameters** (security) | Enable usage of global SSL context parameters. | false | boolean -| **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 -|======================================================================= +| *useGlobalSslContext Parameters* (security) | Enable usage of global SSL context parameters. | false | boolean +| *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 @@ -55,49 +55,51 @@ The IRC component supports 2 options which are listed below. // endpoint options: START The IRC endpoint is configured using URI syntax: - irc:hostname:port +---- +irc:hostname:port +---- 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 -| **hostname** | *Required* Hostname for the IRC chat server | | String -| **port** | Port number for the IRC chat server. If no port is configured then a default port of either 6667 6668 or 6669 is used. | | int -|======================================================================= +| *hostname* | *Required* Hostname for the IRC chat server | | String +| *port* | Port number for the IRC chat server. If no port is configured then a default port of either 6667 6668 or 6669 is used. | | int +|=== -#### Query Parameters (24 parameters): +==== Query Parameters (24 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **autoRejoin** (common) | Whether to auto re-join when being kicked | true | boolean -| **namesOnJoin** (common) | Sends NAMES command to channel after joining it. link onReply has to be true in order to process the result which will have the header value irc.num = '353'. | false | boolean -| **nickname** (common) | The nickname used in chat. | | String -| **persistent** (common) | *Deprecated* Use persistent messages. | true | boolean -| **realname** (common) | The IRC user's actual name. | | String -| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean -| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler -| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern -| **colors** (advanced) | Whether or not the server supports color codes. | true | boolean -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **onJoin** (filter) | Handle user join events. | true | boolean -| **onKick** (filter) | Handle kick events. | true | boolean -| **onMode** (filter) | Handle mode change events. | true | boolean -| **onNick** (filter) | Handle nickname change events. | true | boolean -| **onPart** (filter) | Handle user part events. | true | boolean -| **onPrivmsg** (filter) | Handle private message events. | true | boolean -| **onQuit** (filter) | Handle user quit events. | true | boolean -| **onReply** (filter) | Whether or not to handle general responses to commands or informational messages. | false | boolean -| **onTopic** (filter) | Handle topic change events. | true | boolean -| **nickPassword** (security) | Your IRC server nickname password. | | String -| **password** (security) | The IRC server password. | | String -| **sslContextParameters** (security) | Used for configuring security using SSL. Reference to a org.apache.camel.util.jsse.SSLContextParameters in the Registry. This reference overrides any configured SSLContextParameters at the component level. Note that this setting overrides the trustManager option. | | SSLContextParameters -| **trustManager** (security) | The trust manager used to verify the SSL server's certificate. | | SSLTrustManager -| **username** (security) | The IRC server user name. | | String -|======================================================================= +| *autoRejoin* (common) | Whether to auto re-join when being kicked | true | boolean +| *namesOnJoin* (common) | Sends NAMES command to channel after joining it. link onReply has to be true in order to process the result which will have the header value irc.num = '353'. | false | boolean +| *nickname* (common) | The nickname used in chat. | | String +| *persistent* (common) | *Deprecated* Use persistent messages. | true | boolean +| *realname* (common) | The IRC user's actual name. | | String +| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean +| *exceptionHandler* (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler +| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| *colors* (advanced) | Whether or not the server supports color codes. | true | boolean +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *onJoin* (filter) | Handle user join events. | true | boolean +| *onKick* (filter) | Handle kick events. | true | boolean +| *onMode* (filter) | Handle mode change events. | true | boolean +| *onNick* (filter) | Handle nickname change events. | true | boolean +| *onPart* (filter) | Handle user part events. | true | boolean +| *onPrivmsg* (filter) | Handle private message events. | true | boolean +| *onQuit* (filter) | Handle user quit events. | true | boolean +| *onReply* (filter) | Whether or not to handle general responses to commands or informational messages. | false | boolean +| *onTopic* (filter) | Handle topic change events. | true | boolean +| *nickPassword* (security) | Your IRC server nickname password. | | String +| *password* (security) | The IRC server password. | | String +| *sslContextParameters* (security) | Used for configuring security using SSL. Reference to a org.apache.camel.util.jsse.SSLContextParameters in the Registry. This reference overrides any configured SSLContextParameters at the component level. Note that this setting overrides the trustManager option. | | SSLContextParameters +| *trustManager* (security) | The trust manager used to verify the SSL server's certificate. | | SSLTrustManager +| *username* (security) | The IRC server user name. | | String +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-ironmq/src/main/docs/ironmq-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-ironmq/src/main/docs/ironmq-component.adoc b/components/camel-ironmq/src/main/docs/ironmq-component.adoc index 0a3c6a7..87f39d3 100644 --- a/components/camel-ironmq/src/main/docs/ironmq-component.adoc +++ b/components/camel-ironmq/src/main/docs/ironmq-component.adoc @@ -1,4 +1,4 @@ -## IronMQ Component +== IronMQ Component *Available as of Camel version 2.17* @@ -42,54 +42,56 @@ Where **queueName** identifies the IronMQ queue you want to publish or consume m // endpoint options: START The IronMQ endpoint is configured using URI syntax: - ironmq:queueName +---- +ironmq:queueName +---- 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 -| **queueName** | *Required* The name of the IronMQ queue | | String -|======================================================================= +| *queueName* | *Required* The name of the IronMQ queue | | String +|=== -#### Query Parameters (30 parameters): +==== Query Parameters (30 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **client** (common) | Reference to a io.iron.ironmq.Client in the Registry. | | Client -| **ironMQCloud** (common) | IronMq Cloud url. Urls for public clusters: https://mq-aws-us-east-1-1.iron.io (US) and https://mq-aws-eu-west-1-1.iron.io (EU) | https://mq-aws-us-east-1-1.iron.io | String -| **preserveHeaders** (common) | Should message headers be preserved when publishing messages. This will add the Camel headers to the Iron MQ message as a json payload with a header list and a message body. Useful when Camel is both consumer and producer. | false | boolean -| **projectId** (common) | IronMQ projectId | | String -| **token** (common) | IronMQ token | | String -| **batchDelete** (consumer) | Should messages be deleted in one batch. This will limit the number of api requests since messages are deleted in one request instead of one pr. exchange. If enabled care should be taken that the consumer is idempotent when processing exchanges. | 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 -| **concurrentConsumers** (consumer) | The number of concurrent consumers. | 1 | int -| **maxMessagesPerPoll** (consumer) | Number of messages to poll pr. call. Maximum is 100. | 1 | int -| **sendEmptyMessageWhenIdle** (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean -| **timeout** (consumer) | After timeout (in seconds) item will be placed back onto the queue. | 60 | int -| **wait** (consumer) | Time in seconds to wait for a message to become available. This enables long polling. Default is 0 (does not wait) maximum is 30. | | int -| **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 -| **visibilityDelay** (producer) | The item will not be available on the queue until this many seconds have passed. Default is 0 seconds. | | int -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int -| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int -| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int -| **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 -|======================================================================= +| *client* (common) | Reference to a io.iron.ironmq.Client in the Registry. | | Client +| *ironMQCloud* (common) | IronMq Cloud url. Urls for public clusters: https://mq-aws-us-east-1-1.iron.io (US) and https://mq-aws-eu-west-1-1.iron.io (EU) | https://mq-aws-us-east-1-1.iron.io | String +| *preserveHeaders* (common) | Should message headers be preserved when publishing messages. This will add the Camel headers to the Iron MQ message as a json payload with a header list and a message body. Useful when Camel is both consumer and producer. | false | boolean +| *projectId* (common) | IronMQ projectId | | String +| *token* (common) | IronMQ token | | String +| *batchDelete* (consumer) | Should messages be deleted in one batch. This will limit the number of api requests since messages are deleted in one request instead of one pr. exchange. If enabled care should be taken that the consumer is idempotent when processing exchanges. | 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 +| *concurrentConsumers* (consumer) | The number of concurrent consumers. | 1 | int +| *maxMessagesPerPoll* (consumer) | Number of messages to poll pr. call. Maximum is 100. | 1 | int +| *sendEmptyMessageWhenIdle* (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean +| *timeout* (consumer) | After timeout (in seconds) item will be placed back onto the queue. | 60 | int +| *wait* (consumer) | Time in seconds to wait for a message to become available. This enables long polling. Default is 0 (does not wait) maximum is 30. | | int +| *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 +| *visibilityDelay* (producer) | The item will not be available on the queue until this many seconds have passed. Default is 0 seconds. | | int +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *backoffErrorThreshold* (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int +| *backoffIdleThreshold* (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int +| *backoffMultiplier* (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int +| *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 http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-jackson/src/main/docs/json-jackson-dataformat.adoc ---------------------------------------------------------------------- diff --git a/components/camel-jackson/src/main/docs/json-jackson-dataformat.adoc b/components/camel-jackson/src/main/docs/json-jackson-dataformat.adoc index d4ea5e3..12d32d4 100644 --- a/components/camel-jackson/src/main/docs/json-jackson-dataformat.adoc +++ b/components/camel-jackson/src/main/docs/json-jackson-dataformat.adoc @@ -1,4 +1,4 @@ -## JSon Jackson DataFormat +== JSon Jackson DataFormat *Available as of Camel version 2.0* @@ -22,7 +22,7 @@ The JSon Jackson dataformat supports 17 options which are listed below. [width="100%",cols="2s,1m,1m,6",options="header"] -|======================================================================= +|=== | Name | Default | Java Type | Description | objectMapper | | String | Lookup and use the existing ObjectMapper with the given id when using Jackson. | prettyPrint | false | Boolean | To enable pretty printing output nicely formatted. Is by default false. @@ -41,7 +41,7 @@ The JSon Jackson dataformat supports 17 options which are listed below. | permissions | | String | Adds permissions that controls which Java packages and classes XStream is allowed to use during unmarshal from xml/json to Java beans. A permission must be configured either here or globally using a JVM system property. The permission can be specified in a syntax where a plus sign is allow and minus sign is deny. Wildcards is supported by using . as prefix. For example to allow com.foo and all subpackages then specfy com.foo.. Multiple permissions can be configured separated by comma such as com.foo.-com.foo.bar.MySecretBean. The following default permission is always included: -java.lang.java.util. unless its overridden by specifying a JVM system property with they key org.apache.camel.xstream.permissions. | allowUnmarshallType | false | Boolean | If enabled then Jackson is allowed to attempt to use the CamelJacksonUnmarshalType header during the unmarshalling. This should only be enabled when desired to be used. | contentTypeHeader | false | Boolean | Whether the data format should set the Content-Type header with the type from the data format if the data format is capable of doing so. For example application/xml for data formats marshalling to XML or application/json for data formats marshalling to JSon etc. -|======================================================================= +|=== // dataformat options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-jacksonxml/src/main/docs/jacksonxml-dataformat.adoc ---------------------------------------------------------------------- diff --git a/components/camel-jacksonxml/src/main/docs/jacksonxml-dataformat.adoc b/components/camel-jacksonxml/src/main/docs/jacksonxml-dataformat.adoc index 027252a..cea42cc 100644 --- a/components/camel-jacksonxml/src/main/docs/jacksonxml-dataformat.adoc +++ b/components/camel-jacksonxml/src/main/docs/jacksonxml-dataformat.adoc @@ -1,4 +1,4 @@ -## JacksonXML DataFormat +== JacksonXML DataFormat *Available as of Camel version 2.16* @@ -37,7 +37,7 @@ The JacksonXML dataformat supports 15 options which are listed below. [width="100%",cols="2s,1m,1m,6",options="header"] -|======================================================================= +|=== | Name | Default | Java Type | Description | xmlMapper | | String | Lookup and use the existing XmlMapper with the given id. | prettyPrint | false | Boolean | To enable pretty printing output nicely formatted. Is by default false. @@ -54,7 +54,7 @@ The JacksonXML dataformat supports 15 options which are listed below. | disableFeatures | | String | Set of features to disable on the Jackson com.fasterxml.jackson.databind.ObjectMapper. The features should be a name that matches a enum from com.fasterxml.jackson.databind.SerializationFeature com.fasterxml.jackson.databind.DeserializationFeature or com.fasterxml.jackson.databind.MapperFeature Multiple features can be separated by comma | allowUnmarshallType | false | Boolean | If enabled then Jackson is allowed to attempt to use the CamelJacksonUnmarshalType header during the unmarshalling. This should only be enabled when desired to be used. | contentTypeHeader | false | Boolean | Whether the data format should set the Content-Type header with the type from the data format if the data format is capable of doing so. For example application/xml for data formats marshalling to XML or application/json for data formats marshalling to JSon etc. -|======================================================================= +|=== // dataformat options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-javaspace/src/main/docs/javaspace-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-javaspace/src/main/docs/javaspace-component.adoc b/components/camel-javaspace/src/main/docs/javaspace-component.adoc index b9e8faf..7f1b44a 100644 --- a/components/camel-javaspace/src/main/docs/javaspace-component.adoc +++ b/components/camel-javaspace/src/main/docs/javaspace-component.adoc @@ -1,4 +1,4 @@ -## JavaSpace Component (deprecated) +== JavaSpace Component (deprecated) *Available as of Camel version 2.1* @@ -57,34 +57,36 @@ The JavaSpace component has no options. // endpoint options: START The JavaSpace endpoint is configured using URI syntax: - javaspace:url +---- +javaspace:url +---- 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 -| **url** | *Required* The URL to the JavaSpace server | | String -|======================================================================= +| *url* | *Required* The URL to the JavaSpace server | | String +|=== -#### Query Parameters (10 parameters): +==== Query Parameters (10 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **spaceName** (common) | *Required* Specifies the JavaSpace name. | | String -| **transactional** (common) | If true sending and receiving entries is performed within a transaction. | false | boolean -| **transactionTimeout** (common) | Specifies the transaction timeout in millis. By default there is no timeout. | | long -| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean -| **concurrentConsumers** (consumer) | Specifies the number of concurrent consumers getting entries from the JavaSpace. | 1 | int -| **templateId** (consumer) | If present this option specifies the Spring bean ID of the template to use for reading/taking entries. | | String -| **verb** (consumer) | Specifies the verb for getting JavaSpace entries. | take | String -| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler -| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *spaceName* (common) | *Required* Specifies the JavaSpace name. | | String +| *transactional* (common) | If true sending and receiving entries is performed within a transaction. | false | boolean +| *transactionTimeout* (common) | Specifies the transaction timeout in millis. By default there is no timeout. | | long +| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean +| *concurrentConsumers* (consumer) | Specifies the number of concurrent consumers getting entries from the JavaSpace. | 1 | int +| *templateId* (consumer) | If present this option specifies the Spring bean ID of the template to use for reading/taking entries. | | String +| *verb* (consumer) | Specifies the verb for getting JavaSpace entries. | take | String +| *exceptionHandler* (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler +| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| *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-jaxb/src/main/docs/jaxb-dataformat.adoc ---------------------------------------------------------------------- diff --git a/components/camel-jaxb/src/main/docs/jaxb-dataformat.adoc b/components/camel-jaxb/src/main/docs/jaxb-dataformat.adoc index 84b8584..aa0c254 100644 --- a/components/camel-jaxb/src/main/docs/jaxb-dataformat.adoc +++ b/components/camel-jaxb/src/main/docs/jaxb-dataformat.adoc @@ -1,4 +1,4 @@ -## JAXB DataFormat +== JAXB DataFormat *Available as of Camel version 1.0* @@ -15,7 +15,7 @@ The JAXB dataformat supports 17 options which are listed below. [width="100%",cols="2s,1m,1m,6",options="header"] -|======================================================================= +|=== | Name | Default | Java Type | Description | contextPath | | String | Package name where your JAXB classes are located. | schema | | String | To validate against an existing schema. Your can use the prefix classpath: file: or http: to specify how the resource should by resolved. You can separate multiple schema files by using the '' character. @@ -34,7 +34,7 @@ The JAXB dataformat supports 17 options which are listed below. | noNamespaceSchemaLocation | | String | To define the location of the namespaceless schema | jaxbProviderProperties | | String | Refers to a custom java.util.Map to lookup in the registry containing custom JAXB provider properties to be used with the JAXB marshaller. | contentTypeHeader | false | Boolean | Whether the data format should set the Content-Type header with the type from the data format if the data format is capable of doing so. For example application/xml for data formats marshalling to XML or application/json for data formats marshalling to JSon etc. -|======================================================================= +|=== // dataformat options: END ### Using the Java DSL http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-jbpm/src/main/docs/jbpm-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-jbpm/src/main/docs/jbpm-component.adoc b/components/camel-jbpm/src/main/docs/jbpm-component.adoc index 0e723a9..edb3a0b 100644 --- a/components/camel-jbpm/src/main/docs/jbpm-component.adoc +++ b/components/camel-jbpm/src/main/docs/jbpm-component.adoc @@ -1,4 +1,4 @@ -## JBPM Component +== JBPM Component *Available as of Camel version 2.6* @@ -40,49 +40,51 @@ The JBPM component has no options. // endpoint options: START The JBPM endpoint is configured using URI syntax: - jbpm:connectionURL +---- +jbpm:connectionURL +---- 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 -| **connectionURL** | *Required* The URL to the jBPM server. | | URL -|======================================================================= +| *connectionURL* | *Required* The URL to the jBPM server. | | URL +|=== -#### Query Parameters (25 parameters): +==== Query Parameters (25 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **attachmentId** (producer) | attachId to use when retrieving attachments | | Long -| **contentId** (producer) | contentId to use when retrieving attachments | | Long -| **deploymentId** (producer) | *Required* The id of the deployment | | String -| **event** (producer) | the data associated with this event when signalEvent operation is performed | | Object -| **eventType** (producer) | the type of event to use when signalEvent operation is performed | | String -| **identifier** (producer) | identifier the global identifier | | String -| **language** (producer) | The language to use when filtering user tasks | | String -| **maxNumber** (producer) | the maximum number of rules that should be fired | | Integer -| **operation** (producer) | The operation to perform | startProcess | String -| **processId** (producer) | the id of the process that should be acted upon | | String -| **processInstanceId** (producer) | the id of the process instance | | Long -| **targetUserId** (producer) | The targetUserId used when delegating a task | | String -| **task** (producer) | The task instance to use with task operations | | Task -| **taskId** (producer) | the id of the task | | Long -| **timeout** (producer) | A timeout value | | Integer -| **userId** (producer) | userId to use with task operations | | String -| **value** (producer) | the value to assign to the global identifier | | Object -| **workItemId** (producer) | the id of the work item | | Long -| **entities** (advanced) | The potentialOwners when nominateTask operation is performed | | List -| **extraJaxbClasses** (advanced) | To load additional classes when working with XML | | Class[] -| **parameters** (advanced) | the variables that should be set for various operations | | Map -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **statuses** (filter) | The list of status to use when filtering tasks | | List -| **password** (security) | Password for authentication | | String -| **userName** (security) | Username for authentication | | String -|======================================================================= +| *attachmentId* (producer) | attachId to use when retrieving attachments | | Long +| *contentId* (producer) | contentId to use when retrieving attachments | | Long +| *deploymentId* (producer) | *Required* The id of the deployment | | String +| *event* (producer) | the data associated with this event when signalEvent operation is performed | | Object +| *eventType* (producer) | the type of event to use when signalEvent operation is performed | | String +| *identifier* (producer) | identifier the global identifier | | String +| *language* (producer) | The language to use when filtering user tasks | | String +| *maxNumber* (producer) | the maximum number of rules that should be fired | | Integer +| *operation* (producer) | The operation to perform | startProcess | String +| *processId* (producer) | the id of the process that should be acted upon | | String +| *processInstanceId* (producer) | the id of the process instance | | Long +| *targetUserId* (producer) | The targetUserId used when delegating a task | | String +| *task* (producer) | The task instance to use with task operations | | Task +| *taskId* (producer) | the id of the task | | Long +| *timeout* (producer) | A timeout value | | Integer +| *userId* (producer) | userId to use with task operations | | String +| *value* (producer) | the value to assign to the global identifier | | Object +| *workItemId* (producer) | the id of the work item | | Long +| *entities* (advanced) | The potentialOwners when nominateTask operation is performed | | List +| *extraJaxbClasses* (advanced) | To load additional classes when working with XML | | Class[] +| *parameters* (advanced) | the variables that should be set for various operations | | Map +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *statuses* (filter) | The list of status to use when filtering tasks | | List +| *password* (security) | Password for authentication | | String +| *userName* (security) | Username for authentication | | String +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-jcache/src/main/docs/jcache-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-jcache/src/main/docs/jcache-component.adoc b/components/camel-jcache/src/main/docs/jcache-component.adoc index 750c7ec..e9f0189 100644 --- a/components/camel-jcache/src/main/docs/jcache-component.adoc +++ b/components/camel-jcache/src/main/docs/jcache-component.adoc @@ -1,4 +1,4 @@ -## JCache Component +== JCache Component *Available as of Camel version 2.17* @@ -16,46 +16,48 @@ jcache:cacheName[?options] // endpoint options: START The JCache endpoint is configured using URI syntax: - jcache:cacheName +---- +jcache: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 (22 parameters): +==== Query Parameters (22 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **cacheConfiguration** (common) | A Configuration for the Cache | | Configuration -| **cacheConfigurationProperties** (common) | The Properties for the javax.cache.spi.CachingProvider to create the CacheManager | | Properties -| **cachingProvider** (common) | The fully qualified class name of the javax.cache.spi.CachingProvider | | String -| **configurationUri** (common) | An implementation specific URI for the CacheManager | | String -| **managementEnabled** (common) | Whether management gathering is enabled | false | boolean -| **readThrough** (common) | If read-through caching should be used | false | boolean -| **statisticsEnabled** (common) | Whether statistics gathering is enabled | false | boolean -| **storeByValue** (common) | If cache should use store-by-value or store-by-reference semantics | true | boolean -| **writeThrough** (common) | If write-through caching should be used | 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 -| **filteredEvents** (consumer) | Events a consumer should filter. If using filteredEvents option then eventFilters one will be ignored | | List -| **oldValueRequired** (consumer) | if the old value is required for events | false | boolean -| **synchronous** (consumer) | if the the event listener should block the thread causing the event | false | boolean -| **eventFilters** (consumer) | The CacheEntryEventFilter. If using eventFilters option then filteredEvents one will be ignored | | List -| **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 using a cache operation by default. If an operation in the message header then the operation from the header takes precedence. | | String -| **cacheLoaderFactory** (advanced) | The CacheLoader factory | | CacheLoader> -| **cacheWriterFactory** (advanced) | The CacheWriter factory | | CacheWriter> -| **createCacheIfNotExists** (advanced) | Configure if a cache need to be created if it does exist or can't be pre-configured. | true | boolean -| **expiryPolicyFactory** (advanced) | The ExpiryPolicy factory | | ExpiryPolicy> -| **lookupProviders** (advanced) | Configure if a camel-cache should try to find implementations of jcache api in runtimes like OSGi. | false | boolean -|======================================================================= +| *cacheConfiguration* (common) | A Configuration for the Cache | | Configuration +| *cacheConfigurationProperties* (common) | The Properties for the javax.cache.spi.CachingProvider to create the CacheManager | | Properties +| *cachingProvider* (common) | The fully qualified class name of the javax.cache.spi.CachingProvider | | String +| *configurationUri* (common) | An implementation specific URI for the CacheManager | | String +| *managementEnabled* (common) | Whether management gathering is enabled | false | boolean +| *readThrough* (common) | If read-through caching should be used | false | boolean +| *statisticsEnabled* (common) | Whether statistics gathering is enabled | false | boolean +| *storeByValue* (common) | If cache should use store-by-value or store-by-reference semantics | true | boolean +| *writeThrough* (common) | If write-through caching should be used | 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 +| *filteredEvents* (consumer) | Events a consumer should filter. If using filteredEvents option then eventFilters one will be ignored | | List +| *oldValueRequired* (consumer) | if the old value is required for events | false | boolean +| *synchronous* (consumer) | if the the event listener should block the thread causing the event | false | boolean +| *eventFilters* (consumer) | The CacheEntryEventFilter. If using eventFilters option then filteredEvents one will be ignored | | List +| *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 using a cache operation by default. If an operation in the message header then the operation from the header takes precedence. | | String +| *cacheLoaderFactory* (advanced) | The CacheLoader factory | | CacheLoader> +| *cacheWriterFactory* (advanced) | The CacheWriter factory | | CacheWriter> +| *createCacheIfNotExists* (advanced) | Configure if a cache need to be created if it does exist or can't be pre-configured. | true | boolean +| *expiryPolicyFactory* (advanced) | The ExpiryPolicy factory | | ExpiryPolicy> +| *lookupProviders* (advanced) | Configure if a camel-cache should try to find implementations of jcache api in runtimes like OSGi. | false | boolean +|=== // endpoint options: END @@ -71,12 +73,12 @@ The JCache component supports 5 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **cachingProvider** (common) | The fully qualified class name of the javax.cache.spi.CachingProvider | | String -| **cacheConfiguration** (common) | A Configuration for the Cache | | Configuration -| **cacheConfiguration Properties** (common) | The Properties for the javax.cache.spi.CachingProvider to create the CacheManager | | Properties -| **configurationUri** (common) | An implementation specific URI for the CacheManager | | 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 -|======================================================================= +| *cachingProvider* (common) | The fully qualified class name of the javax.cache.spi.CachingProvider | | String +| *cacheConfiguration* (common) | A Configuration for the Cache | | Configuration +| *cacheConfiguration Properties* (common) | The Properties for the javax.cache.spi.CachingProvider to create the CacheManager | | Properties +| *configurationUri* (common) | An implementation specific URI for the CacheManager | | 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 http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-jclouds/src/main/docs/jclouds-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-jclouds/src/main/docs/jclouds-component.adoc b/components/camel-jclouds/src/main/docs/jclouds-component.adoc index a2d3304..748f5de 100644 --- a/components/camel-jclouds/src/main/docs/jclouds-component.adoc +++ b/components/camel-jclouds/src/main/docs/jclouds-component.adoc @@ -1,4 +1,4 @@ -## JClouds Component +== JClouds Component *Available as of Camel version 2.9* @@ -107,12 +107,12 @@ The JClouds component supports 3 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **blobStores** (common) | To use the given BlobStore which must be configured when using blobstore. | | List -| **computeServices** (common) | To use the given ComputeService which must be configured when use compute. | | List -| **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 -|======================================================================= +| *blobStores* (common) | To use the given BlobStore which must be configured when using blobstore. | | List +| *computeServices* (common) | To use the given ComputeService which must be configured when use compute. | | List +| *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 @@ -123,40 +123,42 @@ The JClouds component supports 3 options which are listed below. // endpoint options: START The JClouds endpoint is configured using URI syntax: - jclouds:command:providerId +---- +jclouds:command:providerId +---- 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 -| **command** | *Required* What command to execute such as blobstore or compute. | | JcloudsCommand -| **providerId** | *Required* The name of the cloud provider that provides the target service (e.g. aws-s3 or aws_ec2). | | String -|======================================================================= +| *command* | *Required* What command to execute such as blobstore or compute. | | JcloudsCommand +| *providerId* | *Required* The name of the cloud provider that provides the target service (e.g. aws-s3 or aws_ec2). | | String +|=== -#### Query Parameters (15 parameters): +==== Query Parameters (15 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean -| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler -| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **blobName** (blobstore) | The name of the blob. | | String -| **container** (blobstore) | The name of the blob container. | | String -| **directory** (blobstore) | An optional directory name to use | | String -| **group** (compute) | The group that will be assigned to the newly created node. Values depend on the actual cloud provider. | | String -| **hardwareId** (compute) | The hardware that will be used for creating a node. Values depend on the actual cloud provider. | | String -| **imageId** (compute) | The imageId that will be used for creating a node. Values depend on the actual cloud provider. | | String -| **locationId** (compute) | The location that will be used for creating a node. Values depend on the actual cloud provider. | | String -| **nodeId** (compute) | The id of the node that will run the script or destroyed. | | String -| **nodeState** (compute) | To filter by node status to only select running nodes etc. | | String -| **operation** (compute) | Specifies the type of operation that will be performed to the blobstore. | | String -| **user** (compute) | The user on the target node that will run the script. | | String -|======================================================================= +| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean +| *exceptionHandler* (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler +| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *blobName* (blobstore) | The name of the blob. | | String +| *container* (blobstore) | The name of the blob container. | | String +| *directory* (blobstore) | An optional directory name to use | | String +| *group* (compute) | The group that will be assigned to the newly created node. Values depend on the actual cloud provider. | | String +| *hardwareId* (compute) | The hardware that will be used for creating a node. Values depend on the actual cloud provider. | | String +| *imageId* (compute) | The imageId that will be used for creating a node. Values depend on the actual cloud provider. | | String +| *locationId* (compute) | The location that will be used for creating a node. Values depend on the actual cloud provider. | | String +| *nodeId* (compute) | The id of the node that will run the script or destroyed. | | String +| *nodeState* (compute) | To filter by node status to only select running nodes etc. | | String +| *operation* (compute) | Specifies the type of operation that will be performed to the blobstore. | | String +| *user* (compute) | The user on the target node that will run the script. | | String +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-jcr/src/main/docs/jcr-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-jcr/src/main/docs/jcr-component.adoc b/components/camel-jcr/src/main/docs/jcr-component.adoc index 81c33b2..6a6c688 100644 --- a/components/camel-jcr/src/main/docs/jcr-component.adoc +++ b/components/camel-jcr/src/main/docs/jcr-component.adoc @@ -1,4 +1,4 @@ -## JCR Component +== JCR Component *Available as of Camel version 1.3* @@ -50,39 +50,41 @@ The JCR component has no options. // endpoint options: START The JCR endpoint is configured using URI syntax: - jcr:host/base +---- +jcr:host/base +---- 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 -| **host** | *Required* Name of the javax.jcr.Repository to lookup from the Camel registry to be used. | | String -| **base** | Get the base node when accessing the repository | | String -|======================================================================= +| *host* | *Required* Name of the javax.jcr.Repository to lookup from the Camel registry to be used. | | String +| *base* | Get the base node when accessing the repository | | String +|=== -#### Query Parameters (14 parameters): +==== Query Parameters (14 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **deep** (common) | When isDeep is true events whose associated parent node is at absPath or within its subgraph are received. | false | boolean -| **eventTypes** (common) | eventTypes (a combination of one or more event types encoded as a bit mask value such as javax.jcr.observation.Event.NODE_ADDED javax.jcr.observation.Event.NODE_REMOVED etc.). | | int -| **nodeTypeNames** (common) | When a comma separated nodeTypeName list string is set only events whose associated parent node has one of the node types (or a subtype of one of the node types) in this list will be received. | | String -| **noLocal** (common) | If noLocal is true then events generated by the session through which the listener was registered are ignored. Otherwise they are not ignored. | false | boolean -| **password** (common) | Password for login | | String -| **sessionLiveCheckInterval** (common) | Interval in milliseconds to wait before each session live checking The default value is 60000 ms. | 60000 | long -| **sessionLiveCheckIntervalOn Start** (common) | Interval in milliseconds to wait before the first session live checking. The default value is 3000 ms. | 3000 | long -| **username** (common) | Username for login | | String -| **uuids** (common) | When a comma separated uuid list string is set only events whose associated parent node has one of the identifiers in the comma separated uuid list will be received. | | String -| **workspaceName** (common) | The workspace to access. If it's not specified then the default one will be used | | String -| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean -| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler -| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *deep* (common) | When isDeep is true events whose associated parent node is at absPath or within its subgraph are received. | false | boolean +| *eventTypes* (common) | eventTypes (a combination of one or more event types encoded as a bit mask value such as javax.jcr.observation.Event.NODE_ADDED javax.jcr.observation.Event.NODE_REMOVED etc.). | | int +| *nodeTypeNames* (common) | When a comma separated nodeTypeName list string is set only events whose associated parent node has one of the node types (or a subtype of one of the node types) in this list will be received. | | String +| *noLocal* (common) | If noLocal is true then events generated by the session through which the listener was registered are ignored. Otherwise they are not ignored. | false | boolean +| *password* (common) | Password for login | | String +| *sessionLiveCheckInterval* (common) | Interval in milliseconds to wait before each session live checking The default value is 60000 ms. | 60000 | long +| *sessionLiveCheckIntervalOn Start* (common) | Interval in milliseconds to wait before the first session live checking. The default value is 3000 ms. | 3000 | long +| *username* (common) | Username for login | | String +| *uuids* (common) | When a comma separated uuid list string is set only events whose associated parent node has one of the identifiers in the comma separated uuid list will be received. | | String +| *workspaceName* (common) | The workspace to access. If it's not specified then the default one will be used | | String +| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean +| *exceptionHandler* (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler +| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +|=== // endpoint options: END
