http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-cache/src/main/docs/cache-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-cache/src/main/docs/cache-component.adoc b/components/camel-cache/src/main/docs/cache-component.adoc index 289892a..0906aba 100644 --- a/components/camel-cache/src/main/docs/cache-component.adoc +++ b/components/camel-cache/src/main/docs/cache-component.adoc @@ -1,4 +1,4 @@ -## EHCache Component (deprecated) +== EHCache Component (deprecated) *Available as of Camel version 2.1* @@ -49,13 +49,13 @@ The EHCache component supports 4 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **cacheManagerFactory** (advanced) | To use the given CacheManagerFactory for creating the CacheManager. By default the DefaultCacheManagerFactory is used. | | CacheManagerFactory -| **configuration** (common) | Sets the Cache configuration | | CacheConfiguration -| **configurationFile** (common) | Sets the location of the ehcache.xml file to load from classpath or file system. By default the file is loaded from classpath:ehcache.xml | classpath:ehcache.xml | 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 -|======================================================================= +| *cacheManagerFactory* (advanced) | To use the given CacheManagerFactory for creating the CacheManager. By default the DefaultCacheManagerFactory is used. | | CacheManagerFactory +| *configuration* (common) | Sets the Cache configuration | | CacheConfiguration +| *configurationFile* (common) | Sets the location of the ehcache.xml file to load from classpath or file system. By default the file is loaded from classpath:ehcache.xml | classpath:ehcache.xml | 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 @@ -66,43 +66,45 @@ The EHCache component supports 4 options which are listed below. // endpoint options: START The EHCache endpoint is configured using URI syntax: - cache:cacheName +---- +cache: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* Name of the cache | | String -|======================================================================= +| *cacheName* | *Required* Name of the cache | | String +|=== -#### Query Parameters (19 parameters): +==== Query Parameters (19 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **diskExpiryThreadInterval Seconds** (common) | The number of seconds between runs of the disk expiry thread. | | long -| **diskPersistent** (common) | Whether the disk store persists between restarts of the application. | false | boolean -| **diskStorePath** (common) | *Deprecated* This parameter is ignored. CacheManager sets it using setter injection. | | String -| **eternal** (common) | Sets whether elements are eternal. If eternal timeouts are ignored and the element never expires. | false | boolean -| **key** (common) | The default key to use. If a key is provided in the message header then the key from the header takes precedence. | | String -| **maxElementsInMemory** (common) | The number of elements that may be stored in the defined cache in memory. | 1000 | int -| **memoryStoreEvictionPolicy** (common) | Which eviction strategy to use when maximum number of elements in memory is reached. The strategy defines which elements to be removed. LRU - Lest Recently Used LFU - Lest Frequently Used FIFO - First In First Out | LFU | MemoryStoreEviction Policy -| **objectCache** (common) | Whether to turn on allowing to store non serializable objects in the cache. If this option is enabled then overflow to disk cannot be enabled as well. | false | boolean -| **operation** (common) | The default cache operation to use. If an operation in the message header then the operation from the header takes precedence. | | String -| **overflowToDisk** (common) | Specifies whether cache may overflow to disk | true | boolean -| **timeToIdleSeconds** (common) | The maximum amount of time between accesses before an element expires | 300 | long -| **timeToLiveSeconds** (common) | The maximum time between creation time and when an element expires. Is used only if the element is not eternal | 300 | 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 -| **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 -| **cacheLoaderRegistry** (advanced) | To configure cache loader using the CacheLoaderRegistry | | CacheLoaderRegistry -| **cacheManagerFactory** (advanced) | To use a custom CacheManagerFactory for creating the CacheManager to be used by this endpoint. By default the CacheManagerFactory configured on the component is used. | | CacheManagerFactory -| **eventListenerRegistry** (advanced) | To configure event listeners using the CacheEventListenerRegistry | | CacheEventListener Registry -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *diskExpiryThreadInterval Seconds* (common) | The number of seconds between runs of the disk expiry thread. | | long +| *diskPersistent* (common) | Whether the disk store persists between restarts of the application. | false | boolean +| *diskStorePath* (common) | *Deprecated* This parameter is ignored. CacheManager sets it using setter injection. | | String +| *eternal* (common) | Sets whether elements are eternal. If eternal timeouts are ignored and the element never expires. | false | boolean +| *key* (common) | The default key to use. If a key is provided in the message header then the key from the header takes precedence. | | String +| *maxElementsInMemory* (common) | The number of elements that may be stored in the defined cache in memory. | 1000 | int +| *memoryStoreEvictionPolicy* (common) | Which eviction strategy to use when maximum number of elements in memory is reached. The strategy defines which elements to be removed. LRU - Lest Recently Used LFU - Lest Frequently Used FIFO - First In First Out | LFU | MemoryStoreEviction Policy +| *objectCache* (common) | Whether to turn on allowing to store non serializable objects in the cache. If this option is enabled then overflow to disk cannot be enabled as well. | false | boolean +| *operation* (common) | The default cache operation to use. If an operation in the message header then the operation from the header takes precedence. | | String +| *overflowToDisk* (common) | Specifies whether cache may overflow to disk | true | boolean +| *timeToIdleSeconds* (common) | The maximum amount of time between accesses before an element expires | 300 | long +| *timeToLiveSeconds* (common) | The maximum time between creation time and when an element expires. Is used only if the element is not eternal | 300 | 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 +| *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 +| *cacheLoaderRegistry* (advanced) | To configure cache loader using the CacheLoaderRegistry | | CacheLoaderRegistry +| *cacheManagerFactory* (advanced) | To use a custom CacheManagerFactory for creating the CacheManager to be used by this endpoint. By default the CacheManagerFactory configured on the component is used. | | CacheManagerFactory +| *eventListenerRegistry* (advanced) | To configure event listeners using the CacheEventListenerRegistry | | CacheEventListener Registry +| *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-caffeine/src/main/docs/caffeine-cache-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-caffeine/src/main/docs/caffeine-cache-component.adoc b/components/camel-caffeine/src/main/docs/caffeine-cache-component.adoc index 4bc5f5f..1fc403c 100644 --- a/components/camel-caffeine/src/main/docs/caffeine-cache-component.adoc +++ b/components/camel-caffeine/src/main/docs/caffeine-cache-component.adoc @@ -1,4 +1,4 @@ -## Caffeine Cache Component +== Caffeine Cache Component *Available as of Camel version 2.20* @@ -37,11 +37,11 @@ The Caffeine Cache component supports 2 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 | | CaffeineConfiguration -| **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 | | CaffeineConfiguration +| *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 @@ -49,41 +49,43 @@ The Caffeine Cache component supports 2 options which are listed below. // endpoint options: START The Caffeine Cache endpoint is configured using URI syntax: - caffeine-cache:cacheName +---- +caffeine-cache: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 (19 parameters): +==== Query Parameters (19 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **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 -| **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 -| **cache** (producer) | To configure the default an already instantianted cache to be used | | Cache -| **cacheLoader** (producer) | To configure a CacheLoader in case of a LoadCache use | | CacheLoader -| **evictionType** (producer) | Set the eviction Type for this cache | SIZE_BASED | EvictionType -| **expireAfterAccessTime** (producer) | Set the expire After Access Time in case of time based Eviction (in seconds) | 300 | int -| **expireAfterWriteTime** (producer) | Set the expire After Access Write in case of time based Eviction (in seconds) | 300 | int -| **initialCapacity** (producer) | Set the initial Capacity for the cache | 10000 | int -| **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 -| **maximumSize** (producer) | Set the maximum size for the cache | 10000 | int -| **removalListener** (producer) | Set a specific removal Listener for the cache | | RemovalListener -| **statsCounter** (producer) | Set a specific Stats Counter for the cache stats | | StatsCounter -| **statsEnabled** (producer) | To enable stats on the cache | false | boolean -| **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 -|======================================================================= +| *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 +| *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 +| *cache* (producer) | To configure the default an already instantianted cache to be used | | Cache +| *cacheLoader* (producer) | To configure a CacheLoader in case of a LoadCache use | | CacheLoader +| *evictionType* (producer) | Set the eviction Type for this cache | SIZE_BASED | EvictionType +| *expireAfterAccessTime* (producer) | Set the expire After Access Time in case of time based Eviction (in seconds) | 300 | int +| *expireAfterWriteTime* (producer) | Set the expire After Access Write in case of time based Eviction (in seconds) | 300 | int +| *initialCapacity* (producer) | Set the initial Capacity for the cache | 10000 | int +| *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 +| *maximumSize* (producer) | Set the maximum size for the cache | 10000 | int +| *removalListener* (producer) | Set a specific removal Listener for the cache | | RemovalListener +| *statsCounter* (producer) | Set a specific Stats Counter for the cache stats | | StatsCounter +| *statsEnabled* (producer) | To enable stats on the cache | false | boolean +| *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-caffeine/src/main/docs/caffeine-loadcache-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-caffeine/src/main/docs/caffeine-loadcache-component.adoc b/components/camel-caffeine/src/main/docs/caffeine-loadcache-component.adoc index 0dbd830..b90822d 100644 --- a/components/camel-caffeine/src/main/docs/caffeine-loadcache-component.adoc +++ b/components/camel-caffeine/src/main/docs/caffeine-loadcache-component.adoc @@ -1,4 +1,4 @@ -## Caffeine LoadCache Component +== Caffeine LoadCache Component *Available as of Camel version 2.20* @@ -37,11 +37,11 @@ The Caffeine LoadCache component supports 2 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 | | CaffeineConfiguration -| **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 | | CaffeineConfiguration +| *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 @@ -49,41 +49,43 @@ The Caffeine LoadCache component supports 2 options which are listed below. // endpoint options: START The Caffeine LoadCache endpoint is configured using URI syntax: - caffeine-loadcache:cacheName +---- +caffeine-loadcache: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 (19 parameters): +==== Query Parameters (19 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **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 -| **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 -| **cache** (producer) | To configure the default an already instantianted cache to be used | | Cache -| **cacheLoader** (producer) | To configure a CacheLoader in case of a LoadCache use | | CacheLoader -| **evictionType** (producer) | Set the eviction Type for this cache | SIZE_BASED | EvictionType -| **expireAfterAccessTime** (producer) | Set the expire After Access Time in case of time based Eviction (in seconds) | 300 | int -| **expireAfterWriteTime** (producer) | Set the expire After Access Write in case of time based Eviction (in seconds) | 300 | int -| **initialCapacity** (producer) | Set the initial Capacity for the cache | 10000 | int -| **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 -| **maximumSize** (producer) | Set the maximum size for the cache | 10000 | int -| **removalListener** (producer) | Set a specific removal Listener for the cache | | RemovalListener -| **statsCounter** (producer) | Set a specific Stats Counter for the cache stats | | StatsCounter -| **statsEnabled** (producer) | To enable stats on the cache | false | boolean -| **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 -|======================================================================= +| *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 +| *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 +| *cache* (producer) | To configure the default an already instantianted cache to be used | | Cache +| *cacheLoader* (producer) | To configure a CacheLoader in case of a LoadCache use | | CacheLoader +| *evictionType* (producer) | Set the eviction Type for this cache | SIZE_BASED | EvictionType +| *expireAfterAccessTime* (producer) | Set the expire After Access Time in case of time based Eviction (in seconds) | 300 | int +| *expireAfterWriteTime* (producer) | Set the expire After Access Write in case of time based Eviction (in seconds) | 300 | int +| *initialCapacity* (producer) | Set the initial Capacity for the cache | 10000 | int +| *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 +| *maximumSize* (producer) | Set the maximum size for the cache | 10000 | int +| *removalListener* (producer) | Set a specific removal Listener for the cache | | RemovalListener +| *statsCounter* (producer) | Set a specific Stats Counter for the cache stats | | StatsCounter +| *statsEnabled* (producer) | To enable stats on the cache | false | boolean +| *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-cassandraql/src/main/docs/cql-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-cassandraql/src/main/docs/cql-component.adoc b/components/camel-cassandraql/src/main/docs/cql-component.adoc index f01d33e..2075e93 100644 --- a/components/camel-cassandraql/src/main/docs/cql-component.adoc +++ b/components/camel-cassandraql/src/main/docs/cql-component.adoc @@ -1,4 +1,4 @@ -## Cassandra CQL Component +== Cassandra CQL Component *Available as of Camel version 2.15* @@ -62,56 +62,58 @@ The Cassandra CQL component has no options. // endpoint options: START The Cassandra CQL endpoint is configured using URI syntax: - cql:beanRef:hosts:port/keyspace +---- +cql:beanRef:hosts:port/keyspace +---- with the following path and query parameters: -#### Path Parameters (4 parameters): +==== Path Parameters (4 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **beanRef** | beanRef is defined using bean:id | | String -| **hosts** | Hostname(s) cassansdra server(s). Multiple hosts can be separated by comma. | | String -| **port** | Port number of cassansdra server(s) | | Integer -| **keyspace** | Keyspace to use | | String -|======================================================================= +| *beanRef* | beanRef is defined using bean:id | | String +| *hosts* | Hostname(s) cassansdra server(s). Multiple hosts can be separated by comma. | | String +| *port* | Port number of cassansdra server(s) | | Integer +| *keyspace* | Keyspace to use | | String +|=== -#### Query Parameters (29 parameters): +==== Query Parameters (29 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **cluster** (common) | To use the Cluster instance (you would normally not use this option) | | Cluster -| **clusterName** (common) | Cluster name | | String -| **consistencyLevel** (common) | Consistency level to use | | ConsistencyLevel -| **cql** (common) | CQL query to perform. Can be overridden with the message header with key CamelCqlQuery. | | String -| **loadBalancingPolicy** (common) | To use a specific LoadBalancingPolicy | | String -| **password** (common) | Password for session authentication | | String -| **prepareStatements** (common) | Whether to use PreparedStatements or regular Statements | true | boolean -| **resultSetConversionStrategy** (common) | To use a custom class that implements logic for converting ResultSet into message body ALL ONE LIMIT_10 LIMIT_100... | | String -| **session** (common) | To use the Session instance (you would normally not use this option) | | Session -| **username** (common) | Username for session authentication | | 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 -| **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 -| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler -| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern -| **pollStrategy** (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int -| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int -| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int -| **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 -|======================================================================= +| *cluster* (common) | To use the Cluster instance (you would normally not use this option) | | Cluster +| *clusterName* (common) | Cluster name | | String +| *consistencyLevel* (common) | Consistency level to use | | ConsistencyLevel +| *cql* (common) | CQL query to perform. Can be overridden with the message header with key CamelCqlQuery. | | String +| *loadBalancingPolicy* (common) | To use a specific LoadBalancingPolicy | | String +| *password* (common) | Password for session authentication | | String +| *prepareStatements* (common) | Whether to use PreparedStatements or regular Statements | true | boolean +| *resultSetConversionStrategy* (common) | To use a custom class that implements logic for converting ResultSet into message body ALL ONE LIMIT_10 LIMIT_100... | | String +| *session* (common) | To use the Session instance (you would normally not use this option) | | Session +| *username* (common) | Username for session authentication | | 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 +| *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 +| *exceptionHandler* (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler +| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| *pollStrategy* (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *backoffErrorThreshold* (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int +| *backoffIdleThreshold* (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int +| *backoffMultiplier* (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int +| *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-castor/src/main/docs/castor-dataformat.adoc ---------------------------------------------------------------------- diff --git a/components/camel-castor/src/main/docs/castor-dataformat.adoc b/components/camel-castor/src/main/docs/castor-dataformat.adoc index add4839..4558452 100644 --- a/components/camel-castor/src/main/docs/castor-dataformat.adoc +++ b/components/camel-castor/src/main/docs/castor-dataformat.adoc @@ -1,4 +1,4 @@ -## Castor DataFormat +== Castor DataFormat *Available as of Camel version 2.1* @@ -110,7 +110,7 @@ The Castor dataformat supports 6 options which are listed below. [width="100%",cols="2s,1m,1m,6",options="header"] -|======================================================================= +|=== | Name | Default | Java Type | Description | mappingFile | | String | Path to a Castor mapping file to load from the classpath. | validation | true | Boolean | Whether validation is turned on or off. Is by default true. @@ -118,7 +118,7 @@ The Castor dataformat supports 6 options which are listed below. | packages | | String[] | Add additional packages to Castor XmlContext | classes | | String[] | Add additional class names to Castor XmlContext | 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 ### Dependencies http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-chronicle/src/main/docs/chronicle-engine-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-chronicle/src/main/docs/chronicle-engine-component.adoc b/components/camel-chronicle/src/main/docs/chronicle-engine-component.adoc index dc212d2..bb3fda1 100644 --- a/components/camel-chronicle/src/main/docs/chronicle-engine-component.adoc +++ b/components/camel-chronicle/src/main/docs/chronicle-engine-component.adoc @@ -1,4 +1,4 @@ -## Chronicle Engine Component +== Chronicle Engine Component *Available as of Camel version 2.18* @@ -24,35 +24,37 @@ The Chronicle Engine component has no options. // endpoint options: START The Chronicle Engine endpoint is configured using URI syntax: - chronicle-engine:addresses/path +---- +chronicle-engine:addresses/path +---- with the following path and query parameters: -#### Path Parameters (2 parameters): +==== Path Parameters (2 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **addresses** | *Required* Engine addresses. Multiple addresses can be separated by comma. | | String -| **path** | *Required* Engine path | | String -|======================================================================= +| *addresses* | *Required* Engine addresses. Multiple addresses can be separated by comma. | | String +| *path* | *Required* Engine path | | String +|=== -#### Query Parameters (12 parameters): +==== Query Parameters (12 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **action** (common) | The default action to perform valid values are: - PUBLISH - PPUBLISH_AND_INDEX - PPUT - PGET_AND_PUT - PPUT_ALL - PPUT_IF_ABSENT - PGET - PGET_AND_REMOVE - PREMOVE - PIS_EMPTY - PSIZE | | String -| **clusterName** (common) | Cluster name for queue | | String -| **filteredMapEvents** (common) | A comma separated list of Map event type to filer valid values are: INSERT UPDATE REMOVE. | | String -| **persistent** (common) | Enable/disable data persistence | true | boolean -| **subscribeMapEvents** (common) | Set if consumer should subscribe to Map events default true. | true | boolean -| **subscribeTopicEvents** (common) | Set if consumer should subscribe to TopicEventsd efault false. | false | boolean -| **subscribeTopologicalEvents** (common) | Set if consumer should subscribe to TopologicalEventsd efault false. | false | boolean -| **wireType** (common) | The Wire type to use default to binary wire. | BINARY | 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 -|======================================================================= +| *action* (common) | The default action to perform valid values are: - PUBLISH - PPUBLISH_AND_INDEX - PPUT - PGET_AND_PUT - PPUT_ALL - PPUT_IF_ABSENT - PGET - PGET_AND_REMOVE - PREMOVE - PIS_EMPTY - PSIZE | | String +| *clusterName* (common) | Cluster name for queue | | String +| *filteredMapEvents* (common) | A comma separated list of Map event type to filer valid values are: INSERT UPDATE REMOVE. | | String +| *persistent* (common) | Enable/disable data persistence | true | boolean +| *subscribeMapEvents* (common) | Set if consumer should subscribe to Map events default true. | true | boolean +| *subscribeTopicEvents* (common) | Set if consumer should subscribe to TopicEventsd efault false. | false | boolean +| *subscribeTopologicalEvents* (common) | Set if consumer should subscribe to TopologicalEventsd efault false. | false | boolean +| *wireType* (common) | The Wire type to use default to binary wire. | BINARY | 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 http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-chunk/src/main/docs/chunk-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-chunk/src/main/docs/chunk-component.adoc b/components/camel-chunk/src/main/docs/chunk-component.adoc index 887f70b..c306b6a 100644 --- a/components/camel-chunk/src/main/docs/chunk-component.adoc +++ b/components/camel-chunk/src/main/docs/chunk-component.adoc @@ -1,4 +1,4 @@ -## Chunk Component +== Chunk Component *Available as of Camel version 2.15* @@ -44,31 +44,33 @@ The Chunk component has no options. // endpoint options: START The Chunk endpoint is configured using URI syntax: - chunk:resourceUri +---- +chunk:resourceUri +---- 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 -| **resourceUri** | *Required* Path to the resource. You can prefix with: classpath file http ref or bean. classpath file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot eg bean:myBean.myMethod. | | String -|======================================================================= +| *resourceUri* | *Required* Path to the resource. You can prefix with: classpath file http ref or bean. classpath file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot eg bean:myBean.myMethod. | | String +|=== -#### Query Parameters (7 parameters): +==== Query Parameters (7 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **contentCache** (producer) | Sets whether to use resource content cache or not | false | boolean -| **encoding** (producer) | Define the encoding of the body | | String -| **extension** (producer) | Define the file extension of the template | | String -| **themeFolder** (producer) | Define the themes folder to scan | | String -| **themeLayer** (producer) | Define the theme layer to elaborate | | String -| **themeSubfolder** (producer) | Define the themes subfolder to scan | | String -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *contentCache* (producer) | Sets whether to use resource content cache or not | false | boolean +| *encoding* (producer) | Define the encoding of the body | | String +| *extension* (producer) | Define the file extension of the template | | String +| *themeFolder* (producer) | Define the themes folder to scan | | String +| *themeLayer* (producer) | Define the theme layer to elaborate | | String +| *themeSubfolder* (producer) | Define the themes subfolder to scan | | 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-cm-sms/src/main/docs/cm-sms-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-cm-sms/src/main/docs/cm-sms-component.adoc b/components/camel-cm-sms/src/main/docs/cm-sms-component.adoc index 592c731..5ccbeee 100644 --- a/components/camel-cm-sms/src/main/docs/cm-sms-component.adoc +++ b/components/camel-cm-sms/src/main/docs/cm-sms-component.adoc @@ -1,4 +1,4 @@ -## CM SMS Gateway Component +== CM SMS Gateway Component *Available as of Camel version 2.18* @@ -39,29 +39,31 @@ The CM SMS Gateway component has no options. // endpoint options: START The CM SMS Gateway endpoint is configured using URI syntax: - cm-sms:host +---- +cm-sms: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* SMS Provider HOST with scheme | | String -|======================================================================= +| *host* | *Required* SMS Provider HOST with scheme | | String +|=== -#### Query Parameters (5 parameters): +==== Query Parameters (5 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **defaultFrom** (producer) | This is the sender name. The maximum length is 11 characters. | | String -| **defaultMaxNumberOfParts** (producer) | If it is a multipart message forces the max number. Message can be truncated. Technically the gateway will first check if a message is larger than 160 characters if so the message will be cut into multiple 153 characters parts limited by these parameters. | 8 | int -| **productToken** (producer) | *Required* The unique token to use | | String -| **testConnectionOnStartup** (producer) | Whether to test the connection to the SMS Gateway on startup | false | boolean -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *defaultFrom* (producer) | This is the sender name. The maximum length is 11 characters. | | String +| *defaultMaxNumberOfParts* (producer) | If it is a multipart message forces the max number. Message can be truncated. Technically the gateway will first check if a message is larger than 160 characters if so the message will be cut into multiple 153 characters parts limited by these parameters. | 8 | int +| *productToken* (producer) | *Required* The unique token to use | | String +| *testConnectionOnStartup* (producer) | Whether to test the connection to the SMS Gateway on startup | 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-cmis/src/main/docs/cmis-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-cmis/src/main/docs/cmis-component.adoc b/components/camel-cmis/src/main/docs/cmis-component.adoc index 8687c8d..7a77e07 100644 --- a/components/camel-cmis/src/main/docs/cmis-component.adoc +++ b/components/camel-cmis/src/main/docs/cmis-component.adoc @@ -1,4 +1,4 @@ -## CMIS Component +== CMIS Component *Available as of Camel version 2.11* @@ -26,11 +26,11 @@ The CMIS component supports 2 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **sessionFacadeFactory** (common) | To use a custom CMISSessionFacadeFactory to create the CMISSessionFacade instances | | CMISSessionFacade Factory -| **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 -|======================================================================= +| *sessionFacadeFactory* (common) | To use a custom CMISSessionFacadeFactory to create the CMISSessionFacade instances | | CMISSessionFacade Factory +| *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 @@ -38,37 +38,39 @@ The CMIS component supports 2 options which are listed below. // endpoint options: START The CMIS endpoint is configured using URI syntax: - cmis:cmsUrl +---- +cmis:cmsUrl +---- 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 -| **cmsUrl** | *Required* URL to the cmis repository | | String -|======================================================================= +| *cmsUrl* | *Required* URL to the cmis repository | | String +|=== -#### Query Parameters (13 parameters): +==== Query Parameters (13 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **pageSize** (common) | Number of nodes to retrieve per page | 100 | int -| **readContent** (common) | If set to true the content of document node will be retrieved in addition to the properties | false | boolean -| **readCount** (common) | Max number of nodes to read | | int -| **repositoryId** (common) | The Id of the repository to use. If not specified the first available repository is 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 -| **query** (consumer) | The cmis query to execute against the repository. If not specified the consumer will retrieve every node from the content repository by iterating the content tree recursively | | 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 -| **queryMode** (producer) | If true will execute the cmis query from the message body and return result otherwise will create a node in the cmis repository | false | boolean -| **sessionFacadeFactory** (advanced) | To use a custom CMISSessionFacadeFactory to create the CMISSessionFacade instances | | CMISSessionFacade Factory -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **password** (security) | Password for the cmis repository | | String -| **username** (security) | Username for the cmis repository | | String -|======================================================================= +| *pageSize* (common) | Number of nodes to retrieve per page | 100 | int +| *readContent* (common) | If set to true the content of document node will be retrieved in addition to the properties | false | boolean +| *readCount* (common) | Max number of nodes to read | | int +| *repositoryId* (common) | The Id of the repository to use. If not specified the first available repository is 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 +| *query* (consumer) | The cmis query to execute against the repository. If not specified the consumer will retrieve every node from the content repository by iterating the content tree recursively | | 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 +| *queryMode* (producer) | If true will execute the cmis query from the message body and return result otherwise will create a node in the cmis repository | false | boolean +| *sessionFacadeFactory* (advanced) | To use a custom CMISSessionFacadeFactory to create the CMISSessionFacade instances | | CMISSessionFacade Factory +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *password* (security) | Password for the cmis repository | | String +| *username* (security) | Username for the cmis repository | | String +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-coap/src/main/docs/coap-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-coap/src/main/docs/coap-component.adoc b/components/camel-coap/src/main/docs/coap-component.adoc index e367018..1b1ba80 100644 --- a/components/camel-coap/src/main/docs/coap-component.adoc +++ b/components/camel-coap/src/main/docs/coap-component.adoc @@ -1,4 +1,4 @@ -## CoAP Component +== CoAP Component *Available as of Camel version 2.16* @@ -33,27 +33,29 @@ The CoAP component has no options. // endpoint options: START The CoAP endpoint is configured using URI syntax: - coap:uri +---- +coap:uri +---- 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 -| **uri** | The URI for the CoAP endpoint | | URI -|======================================================================= +| *uri* | The URI for the CoAP endpoint | | URI +|=== -#### Query Parameters (5 parameters): +==== Query Parameters (5 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **coapMethod** (common) | The CoAP method this endpoint binds to. Default is to bind to all () but can be restricted to GET POST PUT DELETE PING | * | 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 -|======================================================================= +| *coapMethod* (common) | The CoAP method this endpoint binds to. Default is to bind to all () but can be restricted to GET POST PUT DELETE PING | * | 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 http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-cometd/src/main/docs/cometd-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-cometd/src/main/docs/cometd-component.adoc b/components/camel-cometd/src/main/docs/cometd-component.adoc index c101e07..35b7d03 100644 --- a/components/camel-cometd/src/main/docs/cometd-component.adoc +++ b/components/camel-cometd/src/main/docs/cometd-component.adoc @@ -1,4 +1,4 @@ -## CometD Component +== CometD Component *Available as of Camel version 2.0* @@ -53,17 +53,17 @@ The CometD component supports 8 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **sslKeyPassword** (security) | The password for the keystore when using SSL. | | String -| **sslPassword** (security) | The password when using SSL. | | String -| **sslKeystore** (security) | The path to the keystore. | | String -| **securityPolicy** (security) | To use a custom configured SecurityPolicy to control authorization | | SecurityPolicy -| **extensions** (common) | To use a list of custom BayeuxServer.Extension that allows modifying incoming and outgoing requests. | | List -| **sslContextParameters** (security) | To configure security using SSLContextParameters | | SSLContextParameters -| **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 -|======================================================================= +| *sslKeyPassword* (security) | The password for the keystore when using SSL. | | String +| *sslPassword* (security) | The password when using SSL. | | String +| *sslKeystore* (security) | The path to the keystore. | | String +| *securityPolicy* (security) | To use a custom configured SecurityPolicy to control authorization | | SecurityPolicy +| *extensions* (common) | To use a list of custom BayeuxServer.Extension that allows modifying incoming and outgoing requests. | | List +| *sslContextParameters* (security) | To configure security using SSLContextParameters | | SSLContextParameters +| *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 @@ -74,42 +74,44 @@ The CometD component supports 8 options which are listed below. // endpoint options: START The CometD endpoint is configured using URI syntax: - cometd:host:port/channelName +---- +cometd:host:port/channelName +---- with the following path and query parameters: -#### Path Parameters (3 parameters): +==== Path Parameters (3 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **host** | *Required* Hostname | | String -| **port** | *Required* Host port number | | int -| **channelName** | *Required* The channelName represents a topic that can be subscribed to by the Camel endpoints. | | String -|======================================================================= +| *host* | *Required* Hostname | | String +| *port* | *Required* Host port number | | int +| *channelName* | *Required* The channelName represents a topic that can be subscribed to by the Camel endpoints. | | String +|=== -#### Query Parameters (16 parameters): +==== Query Parameters (16 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **allowedOrigins** (common) | The origins domain that support to cross if the crosssOriginFilterOn is true | * | String -| **baseResource** (common) | The root directory for the web resources or classpath. Use the protocol file: or classpath: depending if you want that the component loads the resource from file system or classpath. Classpath is required for OSGI deployment where the resources are packaged in the jar | | String -| **crossOriginFilterOn** (common) | If true the server will support for cross-domain filtering | false | boolean -| **filterPath** (common) | The filterPath will be used by the CrossOriginFilter if the crosssOriginFilterOn is true | | String -| **interval** (common) | The client side poll timeout in milliseconds. How long a client will wait between reconnects | | int -| **jsonCommented** (common) | If true the server will accept JSON wrapped in a comment and will generate JSON wrapped in a comment. This is a defence against Ajax Hijacking. | true | boolean -| **logLevel** (common) | Logging level. 0=none 1=info 2=debug. | 1 | int -| **maxInterval** (common) | The max client side poll timeout in milliseconds. A client will be removed if a connection is not received in this time. | 30000 | int -| **multiFrameInterval** (common) | The client side poll timeout if multiple connections are detected from the same browser. | 1500 | int -| **timeout** (common) | The server side poll timeout in milliseconds. This is how long the server will hold a reconnect request before responding. | 240000 | 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 -| **sessionHeadersEnabled** (consumer) | Whether to include the server session headers in the Camel message when creating a Camel Message for incoming requests. | 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 -| **disconnectLocalSession** (producer) | Whether to disconnect local sessions after publishing a message to its channel. Disconnecting local session is needed as they are not swept by default by CometD and therefore you can run out of memory. | false | boolean -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *allowedOrigins* (common) | The origins domain that support to cross if the crosssOriginFilterOn is true | * | String +| *baseResource* (common) | The root directory for the web resources or classpath. Use the protocol file: or classpath: depending if you want that the component loads the resource from file system or classpath. Classpath is required for OSGI deployment where the resources are packaged in the jar | | String +| *crossOriginFilterOn* (common) | If true the server will support for cross-domain filtering | false | boolean +| *filterPath* (common) | The filterPath will be used by the CrossOriginFilter if the crosssOriginFilterOn is true | | String +| *interval* (common) | The client side poll timeout in milliseconds. How long a client will wait between reconnects | | int +| *jsonCommented* (common) | If true the server will accept JSON wrapped in a comment and will generate JSON wrapped in a comment. This is a defence against Ajax Hijacking. | true | boolean +| *logLevel* (common) | Logging level. 0=none 1=info 2=debug. | 1 | int +| *maxInterval* (common) | The max client side poll timeout in milliseconds. A client will be removed if a connection is not received in this time. | 30000 | int +| *multiFrameInterval* (common) | The client side poll timeout if multiple connections are detected from the same browser. | 1500 | int +| *timeout* (common) | The server side poll timeout in milliseconds. This is how long the server will hold a reconnect request before responding. | 240000 | 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 +| *sessionHeadersEnabled* (consumer) | Whether to include the server session headers in the Camel message when creating a Camel Message for incoming requests. | 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 +| *disconnectLocalSession* (producer) | Whether to disconnect local sessions after publishing a message to its channel. Disconnecting local session is needed as they are not swept by default by CometD and therefore you can run out of memory. | 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-consul/src/main/docs/consul-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-consul/src/main/docs/consul-component.adoc b/components/camel-consul/src/main/docs/consul-component.adoc index bcf7da0..4cbc9d7 100644 --- a/components/camel-consul/src/main/docs/consul-component.adoc +++ b/components/camel-consul/src/main/docs/consul-component.adoc @@ -1,4 +1,4 @@ -## Consul Component +== Consul Component *Available as of Camel version 2.18* @@ -40,18 +40,18 @@ The Consul component supports 9 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **url** (common) | The Consul agent URL | | String -| **datacenter** (common) | The data center | | String -| **sslContextParameters** (common) | SSL configuration using an org.apache.camel.util.jsse.SSLContextParameters instance. | | SSLContextParameters -| **useGlobalSslContext Parameters** (security) | Enable usage of global SSL context parameters. | false | boolean -| **aclToken** (common) | Sets the ACL token to be used with Consul | | String -| **userName** (common) | Sets the username to be used for basic authentication | | String -| **password** (common) | Sets the password to be used for basic authentication | | String -| **configuration** (advanced) | Sets the common configuration shared among endpoints | | ConsulConfiguration -| **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 -|======================================================================= +| *url* (common) | The Consul agent URL | | String +| *datacenter* (common) | The data center | | String +| *sslContextParameters* (common) | SSL configuration using an org.apache.camel.util.jsse.SSLContextParameters instance. | | SSLContextParameters +| *useGlobalSslContext Parameters* (security) | Enable usage of global SSL context parameters. | false | boolean +| *aclToken* (common) | Sets the ACL token to be used with Consul | | String +| *userName* (common) | Sets the username to be used for basic authentication | | String +| *password* (common) | Sets the password to be used for basic authentication | | String +| *configuration* (advanced) | Sets the common configuration shared among endpoints | | ConsulConfiguration +| *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 @@ -62,28 +62,30 @@ The Consul component supports 9 options which are listed below. // endpoint options: START The Consul endpoint is configured using URI syntax: - consul:apiEndpoint +---- +consul:apiEndpoint +---- 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 -| **apiEndpoint** | *Required* The API endpoint | | String -|======================================================================= +| *apiEndpoint* | *Required* The API endpoint | | String +|=== -#### Query Parameters (4 parameters): +==== Query Parameters (4 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean -| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler -| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean +| *exceptionHandler* (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler +| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-context/src/main/docs/context-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-context/src/main/docs/context-component.adoc b/components/camel-context/src/main/docs/context-component.adoc index 3e5c9a7..a71fc90 100644 --- a/components/camel-context/src/main/docs/context-component.adoc +++ b/components/camel-context/src/main/docs/context-component.adoc @@ -1,4 +1,4 @@ -## Camel Context Component (deprecated) +== Camel Context Component (deprecated) *Available as of Camel version 2.7* @@ -50,29 +50,31 @@ The Camel Context component has no options. // endpoint options: START The Camel Context endpoint is configured using URI syntax: - context:contextId:localEndpointUrl +---- +context:contextId:localEndpointUrl +---- 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 -| **contextId** | *Required* Is the ID you used to register the CamelContext into the Registry. | | String -| **localEndpointUrl** | *Required* Can be a valid Camel URI evaluated within the black box CamelContext. Or it can be a logical name which is mapped to any local endpoints. For example if you locally have endpoints like direct:invoices and seda:purchaseOrders inside a CamelContext of id supplyChain then you can just use the URIs supplyChain:invoices or supplyChain:purchaseOrders to omit the physical endpoint kind and use pure logical URIs. | | String -|======================================================================= +| *contextId* | *Required* Is the ID you used to register the CamelContext into the Registry. | | String +| *localEndpointUrl* | *Required* Can be a valid Camel URI evaluated within the black box CamelContext. Or it can be a logical name which is mapped to any local endpoints. For example if you locally have endpoints like direct:invoices and seda:purchaseOrders inside a CamelContext of id supplyChain then you can just use the URIs supplyChain:invoices or supplyChain:purchaseOrders to omit the physical endpoint kind and use pure logical URIs. | | String +|=== -#### Query Parameters (4 parameters): +==== Query Parameters (4 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean -| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler -| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean +| *exceptionHandler* (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler +| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +|=== // endpoint options: END
