http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-box/camel-box-component/src/main/docs/box-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-box/camel-box-component/src/main/docs/box-component.adoc b/components/camel-box/camel-box-component/src/main/docs/box-component.adoc index 0cfa410..2f2aff4 100644 --- a/components/camel-box/camel-box-component/src/main/docs/box-component.adoc +++ b/components/camel-box/camel-box-component/src/main/docs/box-component.adoc @@ -51,13 +51,11 @@ The Box component supports 2 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 4+^s| common -| configuration | | BoxConfiguration | To use the shared configuration - 4+^s| advanced -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **configuration** (common) | To use the shared configuration | | BoxConfiguration +| **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 @@ -70,58 +68,38 @@ with the following path and query parameters: #### Path Parameters (2 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| apiName | | BoxApiName | *Required* What kind of operation to perform -| methodName | | String | *Required* What sub operation to use for the selected operation +| Name | Description | Default | Type +| **apiName** | *Required* What kind of operation to perform | | BoxApiName +| **methodName** | *Required* What sub operation to use for the selected operation | | String |======================================================================= #### Query Parameters (20 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] -|======================================================================= -| Name | Default | Java Type | Description - -| clientId | | String | Box application client ID - -| enterpriseId | | String | The enterprise ID to use for an App Enterprise. - -| inBody | | String | Sets the name of a parameter to be passed in the exchange In Body - -| userId | | String | The user ID to use for an App User. - 4+^s| consumer -| bridgeErrorHandler | false | boolean | 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. - 4+^s| consumer (advanced) -| exceptionHandler | | ExceptionHandler | 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. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - 4+^s| advanced -| httpParams | | Map | Custom HTTP params for settings like proxy host - -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). - 4+^s| security -| accessTokenCache | | IAccessTokenCache | Custom Access Token Cache for storing and retrieving access tokens. - -| clientSecret | | String | Box application client secret - -| encryptionAlgorithm | RSA_SHA_256 | EncryptionAlgorithm | The type of encryption algorithm for JWT. Supported Algorithms: RSA_SHA_256 RSA_SHA_384 RSA_SHA_512 - -| maxCacheEntries | 100 | int | The maximum number of access tokens in cache. - 4+^s| authentication -| authenticationType | APP_USER_AUTHENTICATION | String | The type of authentication for connection. Types of Authentication: STANDARD_AUTHENTICATION - OAuth 2.0 (3-legged) SERVER_AUTHENTICATION - OAuth 2.0 with JSON Web Tokens - 4+^s| security -| privateKeyFile | | String | The private key for generating the JWT signature. - -| privateKeyPassword | | String | The password for the private key. - -| publicKeyId | | String | The ID for public key for validating the JWT signature. - -| sslContextParameters | | SSLContextParameters | To configure security using SSLContextParameters. - -| userName | | String | Box user name MUST be provided - -| userPassword | | String | Box user password MUST be provided if authSecureStorage is not set or returns null on first call +[width="100%",cols="2,5,^1,2",options="header"] +|======================================================================= +| Name | Description | Default | Type +| **clientId** (common) | Box application client ID | | String +| **enterpriseId** (common) | The enterprise ID to use for an App Enterprise. | | String +| **inBody** (common) | Sets the name of a parameter to be passed in the exchange In Body | | String +| **userId** (common) | The user ID to use for an App User. | | 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 +| **httpParams** (advanced) | Custom HTTP params for settings like proxy host | | Map +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| **accessTokenCache** (security) | Custom Access Token Cache for storing and retrieving access tokens. | | IAccessTokenCache +| **clientSecret** (security) | Box application client secret | | String +| **encryptionAlgorithm** (security) | The type of encryption algorithm for JWT. Supported Algorithms: RSA_SHA_256 RSA_SHA_384 RSA_SHA_512 | RSA_SHA_256 | EncryptionAlgorithm +| **maxCacheEntries** (security) | The maximum number of access tokens in cache. | 100 | int +| **authenticationType** (authentication) | The type of authentication for connection. Types of Authentication: STANDARD_AUTHENTICATION - OAuth 2.0 (3-legged) SERVER_AUTHENTICATION - OAuth 2.0 with JSON Web Tokens | APP_USER_AUTHENTICATION | String +| **privateKeyFile** (security) | The private key for generating the JWT signature. | | String +| **privateKeyPassword** (security) | The password for the private key. | | String +| **publicKeyId** (security) | The ID for public key for validating the JWT signature. | | String +| **sslContextParameters** (security) | To configure security using SSLContextParameters. | | SSLContextParameters +| **userName** (security) | Box user name MUST be provided | | String +| **userPassword** (security) | Box user password MUST be provided if authSecureStorage is not set or returns null on first call | | String |======================================================================= // endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-braintree/src/main/docs/braintree-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-braintree/src/main/docs/braintree-component.adoc b/components/camel-braintree/src/main/docs/braintree-component.adoc index dfbf10e..223c9a2 100644 --- a/components/camel-braintree/src/main/docs/braintree-component.adoc +++ b/components/camel-braintree/src/main/docs/braintree-component.adoc @@ -39,13 +39,11 @@ The Braintree component supports 2 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 4+^s| common -| configuration | | BraintreeConfiguration | To use the shared configuration - 4+^s| advanced -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **configuration** (common) | To use the shared configuration | | BraintreeConfiguration +| **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,44 +60,31 @@ with the following path and query parameters: #### Path Parameters (2 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| apiName | | BraintreeApiName | *Required* What kind of operation to perform -| methodName | | String | What sub operation to use for the selected operation +| Name | Description | Default | Type +| **apiName** | *Required* What kind of operation to perform | | BraintreeApiName +| **methodName** | What sub operation to use for the selected operation | | String |======================================================================= #### Query Parameters (13 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| environment | | String | *Required* The environment Either SANDBOX or PRODUCTION - -| inBody | | String | Sets the name of a parameter to be passed in the exchange In Body - -| merchantId | | String | *Required* The merchant id provided by Braintree. - -| privateKey | | String | *Required* The private key provided by Braintree. - -| publicKey | | String | *Required* The public key provided by Braintree. - 4+^s| consumer -| bridgeErrorHandler | false | boolean | 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. - 4+^s| consumer (advanced) -| exceptionHandler | | ExceptionHandler | 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. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - 4+^s| advanced -| httpReadTimeout | | Integer | Set read timeout for http calls. - -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). - 4+^s| logging -| httpLogLevel | | String | Set logging level for http calls see java.util.logging.Level - 4+^s| proxy -| proxyHost | | String | The proxy host - -| proxyPort | | Integer | The proxy port +| Name | Description | Default | Type +| **environment** (common) | *Required* The environment Either SANDBOX or PRODUCTION | | String +| **inBody** (common) | Sets the name of a parameter to be passed in the exchange In Body | | String +| **merchantId** (common) | *Required* The merchant id provided by Braintree. | | String +| **privateKey** (common) | *Required* The private key provided by Braintree. | | String +| **publicKey** (common) | *Required* The public key provided by Braintree. | | 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 +| **httpReadTimeout** (advanced) | Set read timeout for http calls. | | Integer +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| **httpLogLevel** (logging) | Set logging level for http calls see java.util.logging.Level | | String +| **proxyHost** (proxy) | The proxy host | | String +| **proxyPort** (proxy) | The proxy port | | Integer |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/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 0bec379..52f3c87 100644 --- a/components/camel-cache/src/main/docs/cache-component.adoc +++ b/components/camel-cache/src/main/docs/cache-component.adoc @@ -48,17 +48,13 @@ The EHCache component supports 4 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 4+^s| advanced -| cacheManagerFactory | | CacheManagerFactory | To use the given CacheManagerFactory for creating the CacheManager. By default the DefaultCacheManagerFactory is used. - 4+^s| common -| configuration | | CacheConfiguration | Sets the Cache configuration - -| configurationFile | classpath:ehcache.xml | String | 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 - 4+^s| advanced -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| 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 |======================================================================= // component options: END @@ -76,55 +72,36 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| cacheName | | String | *Required* Name of the cache +| Name | Description | Default | Type +| **cacheName** | *Required* Name of the cache | | String |======================================================================= #### Query Parameters (19 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| diskExpiryThreadIntervalSeconds | | long | The number of seconds between runs of the disk expiry thread. - -| diskPersistent | false | boolean | Whether the disk store persists between restarts of the application. - -| diskStorePath | | String | This parameter is ignored. CacheManager sets it using setter injection. - -| eternal | false | boolean | Sets whether elements are eternal. If eternal timeouts are ignored and the element never expires. - -| key | | String | The default key to use. If a key is provided in the message header then the key from the header takes precedence. - -| maxElementsInMemory | 1000 | int | The number of elements that may be stored in the defined cache in memory. - -| memoryStoreEvictionPolicy | LFU | MemoryStoreEvictionPolicy | 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 - -| objectCache | false | boolean | 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. - -| operation | | String | The default cache operation to use. If an operation in the message header then the operation from the header takes precedence. - -| overflowToDisk | true | boolean | Specifies whether cache may overflow to disk - -| timeToIdleSeconds | 300 | long | The maximum amount of time between accesses before an element expires - -| timeToLiveSeconds | 300 | long | The maximum time between creation time and when an element expires. Is used only if the element is not eternal - 4+^s| consumer -| bridgeErrorHandler | false | boolean | 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. - 4+^s| consumer (advanced) -| exceptionHandler | | ExceptionHandler | 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. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - 4+^s| advanced -| cacheLoaderRegistry | | CacheLoaderRegistry | To configure cache loader using the CacheLoaderRegistry - -| cacheManagerFactory | | CacheManagerFactory | 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. - -| eventListenerRegistry | | CacheEventListenerRegistry | To configure event listeners using the CacheEventListenerRegistry - -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| 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) | 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/db81a114/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 77065e0..18ab579 100644 --- a/components/camel-cassandraql/src/main/docs/cql-component.adoc +++ b/components/camel-cassandraql/src/main/docs/cql-component.adoc @@ -68,48 +68,34 @@ with the following path and query parameters: #### Path Parameters (4 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| beanRef | | String | beanRef is defined using bean:id -| hosts | | String | Hostname(s) cassansdra server(s). Multiple hosts can be separated by comma. -| port | | Integer | Port number of cassansdra server(s) -| keyspace | | String | Keyspace to use +| 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 |======================================================================= #### Query Parameters (14 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| cluster | | Cluster | To use the Cluster instance (you would normally not use this option) - -| clusterName | | String | Cluster name - -| consistencyLevel | | ConsistencyLevel | Consistency level to use - -| cql | | String | CQL query to perform. Can be overridden with the message header with key CamelCqlQuery. - -| loadBalancingPolicy | | String | To use a specific LoadBalancingPolicy - -| password | | String | Password for session authentication - -| prepareStatements | true | boolean | Whether to use PreparedStatements or regular Statements - -| resultSetConversionStrategy | | String | To use a custom class that implements logic for converting ResultSet into message body ALL ONE LIMIT_10 LIMIT_100... - -| session | | Session | To use the Session instance (you would normally not use this option) - -| username | | String | Username for session authentication - 4+^s| consumer -| bridgeErrorHandler | false | boolean | 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. - 4+^s| consumer (advanced) -| exceptionHandler | | ExceptionHandler | 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. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| 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 +| **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/db81a114/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 770002b..dc212d2 100644 --- a/components/camel-chronicle/src/main/docs/chronicle-engine-component.adoc +++ b/components/camel-chronicle/src/main/docs/chronicle-engine-component.adoc @@ -30,41 +30,29 @@ with the following path and query parameters: #### Path Parameters (2 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| addresses | | String | *Required* Engine addresses. Multiple addresses can be separated by comma. -| path | | String | *Required* Engine path +| Name | Description | Default | Type +| **addresses** | *Required* Engine addresses. Multiple addresses can be separated by comma. | | String +| **path** | *Required* Engine path | | String |======================================================================= #### Query Parameters (12 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| action | | String | 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 - -| clusterName | | String | Cluster name for queue - -| filteredMapEvents | | String | A comma separated list of Map event type to filer valid values are: INSERT UPDATE REMOVE. - -| persistent | true | boolean | Enable/disable data persistence - -| subscribeMapEvents | true | boolean | Set if consumer should subscribe to Map events default true. - -| subscribeTopicEvents | false | boolean | Set if consumer should subscribe to TopicEventsd efault false. - -| subscribeTopologicalEvents | false | boolean | Set if consumer should subscribe to TopologicalEventsd efault false. - -| wireType | BINARY | String | The Wire type to use default to binary wire. - 4+^s| consumer -| bridgeErrorHandler | false | boolean | 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. - 4+^s| consumer (advanced) -| exceptionHandler | | ExceptionHandler | 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. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| 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 |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/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 05e58d1..887f70b 100644 --- a/components/camel-chunk/src/main/docs/chunk-component.adoc +++ b/components/camel-chunk/src/main/docs/chunk-component.adoc @@ -50,31 +50,24 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| resourceUri | | String | *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. +| 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 |======================================================================= #### Query Parameters (7 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| contentCache | false | boolean | Sets whether to use resource content cache or not - -| encoding | | String | Define the encoding of the body - -| extension | | String | Define the file extension of the template - -| themeFolder | | String | Define the themes folder to scan - -| themeLayer | | String | Define the theme layer to elaborate - -| themeSubfolder | | String | Define the themes subfolder to scan - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| 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 |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/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 77a262b..592c731 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 @@ -45,27 +45,22 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| host | | String | *Required* SMS Provider HOST with scheme +| Name | Description | Default | Type +| **host** | *Required* SMS Provider HOST with scheme | | String |======================================================================= #### Query Parameters (5 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| defaultFrom | | String | This is the sender name. The maximum length is 11 characters. - -| defaultMaxNumberOfParts | 8 | int | 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. - -| productToken | | String | *Required* The unique token to use - -| testConnectionOnStartup | false | boolean | Whether to test the connection to the SMS Gateway on startup - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| 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 |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/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 677242c..8687c8d 100644 --- a/components/camel-cmis/src/main/docs/cmis-component.adoc +++ b/components/camel-cmis/src/main/docs/cmis-component.adoc @@ -25,13 +25,11 @@ The CMIS component supports 2 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 4+^s| common -| sessionFacadeFactory | | CMISSessionFacadeFactory | To use a custom CMISSessionFacadeFactory to create the CMISSessionFacade instances - 4+^s| advanced -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| 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 |======================================================================= // component options: END @@ -46,43 +44,30 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| cmsUrl | | String | *Required* URL to the cmis repository +| Name | Description | Default | Type +| **cmsUrl** | *Required* URL to the cmis repository | | String |======================================================================= #### Query Parameters (13 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| pageSize | 100 | int | Number of nodes to retrieve per page - -| readContent | false | boolean | If set to true the content of document node will be retrieved in addition to the properties - -| readCount | | int | Max number of nodes to read - -| repositoryId | | String | The Id of the repository to use. If not specified the first available repository is used - 4+^s| consumer -| bridgeErrorHandler | false | boolean | 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. - -| query | | String | 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 - 4+^s| consumer (advanced) -| exceptionHandler | | ExceptionHandler | 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. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - 4+^s| producer -| queryMode | false | boolean | If true will execute the cmis query from the message body and return result otherwise will create a node in the cmis repository - 4+^s| advanced -| sessionFacadeFactory | | CMISSessionFacadeFactory | To use a custom CMISSessionFacadeFactory to create the CMISSessionFacade instances - -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). - 4+^s| security -| password | | String | Password for the cmis repository - -| username | | String | Username for the cmis repository +| 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 |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/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 451c18d..e367018 100644 --- a/components/camel-coap/src/main/docs/coap-component.adoc +++ b/components/camel-coap/src/main/docs/coap-component.adoc @@ -39,26 +39,21 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| uri | | URI | The URI for the CoAP endpoint +| Name | Description | Default | Type +| **uri** | The URI for the CoAP endpoint | | URI |======================================================================= #### Query Parameters (5 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| coapMethod | * | String | The CoAP method this endpoint binds to. Default is to bind to all () but can be restricted to GET POST PUT DELETE PING - 4+^s| consumer -| bridgeErrorHandler | false | boolean | 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. - 4+^s| consumer (advanced) -| exceptionHandler | | ExceptionHandler | 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. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| 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 |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/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 cb275fa..1b2d637 100644 --- a/components/camel-cometd/src/main/docs/cometd-component.adoc +++ b/components/camel-cometd/src/main/docs/cometd-component.adoc @@ -52,23 +52,16 @@ The CometD component supports 7 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 4+^s| security -| sslKeyPassword | | String | The password for the keystore when using SSL. - -| sslPassword | | String | The password when using SSL. - -| sslKeystore | | String | The path to the keystore. - -| securityPolicy | | SecurityPolicy | To use a custom configured SecurityPolicy to control authorization - 4+^s| common -| extensions | | List | To use a list of custom BayeuxServer.Extension that allows modifying incoming and outgoing requests. - 4+^s| security -| sslContextParameters | | SSLContextParameters | To configure security using SSLContextParameters - 4+^s| advanced -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| 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 +| **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 @@ -86,51 +79,35 @@ with the following path and query parameters: #### Path Parameters (3 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| host | | String | *Required* Hostname -| port | | int | *Required* Host port number -| channelName | | String | *Required* The channelName represents a topic that can be subscribed to by the Camel endpoints. +| 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 |======================================================================= #### Query Parameters (16 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| allowedOrigins | * | String | The origins domain that support to cross if the crosssOriginFilterOn is true - -| baseResource | | String | 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 - -| crossOriginFilterOn | false | boolean | If true the server will support for cross-domain filtering - -| filterPath | | String | The filterPath will be used by the CrossOriginFilter if the crosssOriginFilterOn is true - -| interval | | int | The client side poll timeout in milliseconds. How long a client will wait between reconnects - -| jsonCommented | true | boolean | 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. - -| logLevel | 1 | int | Logging level. 0=none 1=info 2=debug. - -| maxInterval | 30000 | int | The max client side poll timeout in milliseconds. A client will be removed if a connection is not received in this time. - -| multiFrameInterval | 1500 | int | The client side poll timeout if multiple connections are detected from the same browser. - -| timeout | 240000 | int | The server side poll timeout in milliseconds. This is how long the server will hold a reconnect request before responding. - 4+^s| consumer -| bridgeErrorHandler | false | boolean | 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. - -| sessionHeadersEnabled | false | boolean | Whether to include the server session headers in the Camel message when creating a Camel Message for incoming requests. - 4+^s| consumer (advanced) -| exceptionHandler | | ExceptionHandler | 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. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - 4+^s| producer -| disconnectLocalSession | false | boolean | 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. - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| 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 |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/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 85996d0..8c8823f 100644 --- a/components/camel-consul/src/main/docs/consul-component.adoc +++ b/components/camel-consul/src/main/docs/consul-component.adoc @@ -52,59 +52,38 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| apiEndpoint | | String | *Required* The API endpoint +| Name | Description | Default | Type +| **apiEndpoint** | *Required* The API endpoint | | String |======================================================================= #### Query Parameters (21 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| connectTimeoutMillis | | Long | Connect timeout for OkHttpClient - -| dc | | String | The data center - -| key | | String | The default key. Can be overridden by CamelConsulKey - -| pingInstance | true | boolean | Configure if the AgentClient should attempt a ping before returning the Consul instance - -| readTimeoutMillis | | Long | Read timeout for OkHttpClient - -| tags | | String | Set tags. You can separate multiple tags by comma. - -| url | | String | The Consul agent URL - -| writeTimeoutMillis | | Long | Write timeout for OkHttpClient - 4+^s| consumer -| bridgeErrorHandler | false | boolean | 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. - 4+^s| consumer (advanced) -| exceptionHandler | | ExceptionHandler | 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. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - 4+^s| producer -| action | | String | The default action. Can be overridden by CamelConsulAction - -| valueAsString | false | boolean | Default to transform values retrieved from Consul i.e. on KV endpoint to string. - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). - 4+^s| watch -| blockSeconds | 10 | Integer | The second to wait for a watch event default 10 seconds - -| firstIndex | 0 | long | The first index for watch for default 0 - -| recursive | false | boolean | Recursively watch default false - 4+^s| security -| aclToken | | String | Sets the ACL token to be used with Consul - -| password | | String | Sets the password to be used for basic authentication - -| sslContextParameters | | SSLContextParameters | SSL configuration using an org.apache.camel.util.jsse.SSLContextParameters instance. - -| userName | | String | Sets the username to be used for basic authentication +| Name | Description | Default | Type +| **connectTimeoutMillis** (common) | Connect timeout for OkHttpClient | | Long +| **dc** (common) | The data center | | String +| **key** (common) | The default key. Can be overridden by CamelConsulKey | | String +| **pingInstance** (common) | Configure if the AgentClient should attempt a ping before returning the Consul instance | true | boolean +| **readTimeoutMillis** (common) | Read timeout for OkHttpClient | | Long +| **tags** (common) | Set tags. You can separate multiple tags by comma. | | String +| **url** (common) | The Consul agent URL | | String +| **writeTimeoutMillis** (common) | Write timeout for OkHttpClient | | 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 +| **action** (producer) | The default action. Can be overridden by CamelConsulAction | | String +| **valueAsString** (producer) | Default to transform values retrieved from Consul i.e. on KV endpoint to string. | false | boolean +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| **blockSeconds** (watch) | The second to wait for a watch event default 10 seconds | 10 | Integer +| **firstIndex** (watch) | The first index for watch for default 0 | 0 | long +| **recursive** (watch) | Recursively watch default false | false | boolean +| **aclToken** (security) | Sets the ACL token to be used with Consul | | String +| **password** (security) | Sets the password to be used for basic authentication | | String +| **sslContextParameters** (security) | SSL configuration using an org.apache.camel.util.jsse.SSLContextParameters instance. | | SSLContextParameters +| **userName** (security) | Sets the username to be used for basic authentication | | String |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/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 0db41fa..3e5c9a7 100644 --- a/components/camel-context/src/main/docs/context-component.adoc +++ b/components/camel-context/src/main/docs/context-component.adoc @@ -56,26 +56,22 @@ with the following path and query parameters: #### Path Parameters (2 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| contextId | | String | *Required* Is the ID you used to register the CamelContext into the Registry. -| localEndpointUrl | | String | *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. +| 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 |======================================================================= #### Query Parameters (4 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 4+^s| consumer -| bridgeErrorHandler | false | boolean | 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. - 4+^s| consumer (advanced) -| exceptionHandler | | ExceptionHandler | 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. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| 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 |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-couchbase/src/main/docs/couchbase-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-couchbase/src/main/docs/couchbase-component.adoc b/components/camel-couchbase/src/main/docs/couchbase-component.adoc index f6b2696..01d9825 100644 --- a/components/camel-couchbase/src/main/docs/couchbase-component.adoc +++ b/components/camel-couchbase/src/main/docs/couchbase-component.adoc @@ -41,113 +41,65 @@ with the following path and query parameters: #### Path Parameters (2 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| protocol | | String | *Required* The protocol to use -| hostname | | String | *Required* The hostname to use +| Name | Description | Default | Type +| **protocol** | *Required* The protocol to use | | String +| **hostname** | *Required* The hostname to use | | String |======================================================================= #### Query Parameters (48 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| bucket | | String | The bucket to use - -| key | | String | The key to use - -| port | 8091 | int | The port number to use - 4+^s| consumer -| bridgeErrorHandler | false | boolean | 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. - -| consumerProcessedStrategy | none | String | Define the consumer Processed strategy to use - -| descending | false | boolean | Define if this operation is descending or not - -| designDocumentName | beer | String | The design document name to use - -| limit | -1 | int | The output limit to use - -| rangeEndKey | | String | Define a range for the end key - -| rangeStartKey | | String | Define a range for the start key - -| sendEmptyMessageWhenIdle | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. - -| skip | -1 | int | Define the skip to use - -| viewName | brewery_beers | String | The view name to use - 4+^s| consumer (advanced) -| exceptionHandler | | ExceptionHandler | 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. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - -| pollStrategy | | PollingConsumerPollStrategy | 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. - 4+^s| producer -| autoStartIdForInserts | false | boolean | Define if we want an autostart Id when we are doing an insert operation - -| operation | CCB_PUT | String | The operation to do - -| persistTo | 0 | int | Where to persist the data - -| producerRetryAttempts | 2 | int | Define the number of retry attempts - -| producerRetryPause | 5000 | int | Define the retry pause between different attempts - -| replicateTo | 0 | int | Where to replicate the data - -| startingIdForInsertsFrom | | long | Define the starting Id where we are doing an insert operation - 4+^s| advanced -| additionalHosts | | String | The additional hosts - -| maxReconnectDelay | 30000 | long | Define the max delay during a reconnection - -| obsPollInterval | 400 | long | Define the observation polling interval - -| obsTimeout | -1 | long | Define the observation timeout - -| opQueueMaxBlockTime | 10000 | long | Define the max time an operation can be in queue blocked - -| opTimeOut | 2500 | long | Define the operation timeout - -| readBufferSize | 16384 | int | Define the buffer size - -| shouldOptimize | false | boolean | Define if we want to use optimization or not where possible - -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). - -| timeoutExceptionThreshold | 998 | int | Define the threshold for throwing a timeout Exception - 4+^s| scheduler -| backoffErrorThreshold | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. - -| backoffIdleThreshold | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. - -| backoffMultiplier | | int | 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. - -| delay | 500 | long | 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). - -| greedy | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. - -| initialDelay | 1000 | long | 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). - -| runLoggingLevel | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. - -| scheduledExecutorService | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. - -| scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component - -| schedulerProperties | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. - -| startScheduler | true | boolean | Whether the scheduler should be auto started. - -| timeUnit | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options. - -| useFixedDelay | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. - 4+^s| security -| password | | String | The password to use - -| username | | String | The username to use +| Name | Description | Default | Type +| **bucket** (common) | The bucket to use | | String +| **key** (common) | The key to use | | String +| **port** (common) | The port number to use | 8091 | 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 +| **consumerProcessedStrategy** (consumer) | Define the consumer Processed strategy to use | none | String +| **descending** (consumer) | Define if this operation is descending or not | false | boolean +| **designDocumentName** (consumer) | The design document name to use | beer | String +| **limit** (consumer) | The output limit to use | -1 | int +| **rangeEndKey** (consumer) | Define a range for the end key | | String +| **rangeStartKey** (consumer) | Define a range for the start key | | String +| **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 +| **skip** (consumer) | Define the skip to use | -1 | int +| **viewName** (consumer) | The view name to use | brewery_beers | String +| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler +| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| **pollStrategy** (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy +| **autoStartIdForInserts** (producer) | Define if we want an autostart Id when we are doing an insert operation | false | boolean +| **operation** (producer) | The operation to do | CCB_PUT | String +| **persistTo** (producer) | Where to persist the data | 0 | int +| **producerRetryAttempts** (producer) | Define the number of retry attempts | 2 | int +| **producerRetryPause** (producer) | Define the retry pause between different attempts | 5000 | int +| **replicateTo** (producer) | Where to replicate the data | 0 | int +| **startingIdForInsertsFrom** (producer) | Define the starting Id where we are doing an insert operation | | long +| **additionalHosts** (advanced) | The additional hosts | | String +| **maxReconnectDelay** (advanced) | Define the max delay during a reconnection | 30000 | long +| **obsPollInterval** (advanced) | Define the observation polling interval | 400 | long +| **obsTimeout** (advanced) | Define the observation timeout | -1 | long +| **opQueueMaxBlockTime** (advanced) | Define the max time an operation can be in queue blocked | 10000 | long +| **opTimeOut** (advanced) | Define the operation timeout | 2500 | long +| **readBufferSize** (advanced) | Define the buffer size | 16384 | int +| **shouldOptimize** (advanced) | Define if we want to use optimization or not where possible | false | boolean +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| **timeoutExceptionThreshold** (advanced) | Define the threshold for throwing a timeout Exception | 998 | int +| **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 +| **password** (security) | The password to use | | String +| **username** (security) | The username to use | | String |======================================================================= // endpoint options: END
