http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/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 7f3b4b0..cb0630d 100644 --- a/components/camel-couchbase/src/main/docs/couchbase-component.adoc +++ b/components/camel-couchbase/src/main/docs/couchbase-component.adoc @@ -1,4 +1,4 @@ -## Couchbase Component +== Couchbase Component *Available as of Camel version 2.19* @@ -35,71 +35,73 @@ The Couchbase component has no options. // endpoint options: START The Couchbase endpoint is configured using URI syntax: - couchbase:protocol:hostname:port +---- +couchbase:protocol:hostname:port +---- 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 -| **protocol** | *Required* The protocol to use | | String -| **hostname** | *Required* The hostname to use | | String -| **port** | The port number to use | 8091 | int -|======================================================================= +| *protocol* | *Required* The protocol to use | | String +| *hostname* | *Required* The hostname to use | | String +| *port* | The port number to use | 8091 | int +|=== -#### Query Parameters (47 parameters): +==== Query Parameters (47 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **bucket** (common) | The bucket to use | | String -| **key** (common) | The key to use | | 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 -| **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 -|======================================================================= +| *bucket* (common) | The bucket to use | | String +| *key* (common) | The key to use | | 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 +| *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
http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-couchdb/src/main/docs/couchdb-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-couchdb/src/main/docs/couchdb-component.adoc b/components/camel-couchdb/src/main/docs/couchdb-component.adoc index c118b76..76823ab 100644 --- a/components/camel-couchdb/src/main/docs/couchdb-component.adoc +++ b/components/camel-couchdb/src/main/docs/couchdb-component.adoc @@ -1,4 +1,4 @@ -## CouchDB Component +== CouchDB Component *Available as of Camel version 2.11* @@ -50,39 +50,41 @@ The CouchDB component has no options. // endpoint options: START The CouchDB endpoint is configured using URI syntax: - couchdb:protocol:hostname:port/database +---- +couchdb:protocol:hostname:port/database +---- 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 -| **protocol** | *Required* The protocol to use for communicating with the database. | | String -| **hostname** | *Required* Hostname of the running couchdb instance | | String -| **port** | Port number for the running couchdb instance | 5984 | int -| **database** | *Required* Name of the database to use | | String -|======================================================================= +| *protocol* | *Required* The protocol to use for communicating with the database. | | String +| *hostname* | *Required* Hostname of the running couchdb instance | | String +| *port* | Port number for the running couchdb instance | 5984 | int +| *database* | *Required* Name of the database to use | | String +|=== -#### Query Parameters (12 parameters): +==== Query Parameters (12 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **createDatabase** (common) | Creates the database if it does not already exist | 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 -| **deletes** (consumer) | Document deletes are published as events | true | boolean -| **heartbeat** (consumer) | How often to send an empty message to keep socket alive in millis | 30000 | long -| **since** (consumer) | Start tracking changes immediately after the given update sequence. The default null will start monitoring from the latest sequence. | | String -| **style** (consumer) | Specifies how many revisions are returned in the changes array. The default main_only will only return the current winning revision; all_docs will return all leaf revisions (including conflicts and deleted former conflicts.) | main_only | String -| **updates** (consumer) | Document inserts/updates are published as events | true | boolean -| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler -| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern -| **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 authenticated databases | | String -| **username** (security) | Username in case of authenticated databases | | String -|======================================================================= +| *createDatabase* (common) | Creates the database if it does not already exist | 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 +| *deletes* (consumer) | Document deletes are published as events | true | boolean +| *heartbeat* (consumer) | How often to send an empty message to keep socket alive in millis | 30000 | long +| *since* (consumer) | Start tracking changes immediately after the given update sequence. The default null will start monitoring from the latest sequence. | | String +| *style* (consumer) | Specifies how many revisions are returned in the changes array. The default main_only will only return the current winning revision; all_docs will return all leaf revisions (including conflicts and deleted former conflicts.) | main_only | String +| *updates* (consumer) | Document inserts/updates are published as events | true | boolean +| *exceptionHandler* (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler +| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| *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 authenticated databases | | String +| *username* (security) | Username in case of authenticated databases | | String +|=== // endpoint options: END ### Headers http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-crypto-cms/src/main/docs/crypto-cms-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-crypto-cms/src/main/docs/crypto-cms-component.adoc b/components/camel-crypto-cms/src/main/docs/crypto-cms-component.adoc index 550dddb..682eeca 100644 --- a/components/camel-crypto-cms/src/main/docs/crypto-cms-component.adoc +++ b/components/camel-crypto-cms/src/main/docs/crypto-cms-component.adoc @@ -1,4 +1,4 @@ -## Crypto CMS Component +== Crypto CMS Component *Available as of Camel version 2.20* @@ -38,51 +38,53 @@ The Crypto CMS component supports 3 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **signedDataVerifier Configuration** (advanced) | To configure the shared SignedDataVerifierConfiguration which determines the uri parameters for the verify operation. | | SignedDataVerifier Configuration -| **envelopedDataDecryptor Configuration** (advanced) | To configure the shared EnvelopedDataDecryptorConfiguration which determines the uri parameters for the decrypt operation. | | EnvelopedDataDecryptor Configuration -| **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 -|======================================================================= +| *signedDataVerifier Configuration* (advanced) | To configure the shared SignedDataVerifierConfiguration which determines the uri parameters for the verify operation. | | SignedDataVerifier Configuration +| *envelopedDataDecryptor Configuration* (advanced) | To configure the shared EnvelopedDataDecryptorConfiguration which determines the uri parameters for the decrypt operation. | | EnvelopedDataDecryptor Configuration +| *resolveProperty Placeholders* (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean +|=== // component options: END // endpoint options: START The Crypto CMS endpoint is configured using URI syntax: - crypto-cms:cryptoOperation:name +---- +crypto-cms:cryptoOperation:name +---- 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 -| **cryptoOperation** | *Required* Set the Crypto operation from that supplied after the crypto scheme in the endpoint uri e.g. crypto-cms:sign sets sign as the operation. Possible values: sign verify encrypt or decrypt. | | CryptoOperation -| **name** | *Required* The name part in the URI can be chosen by the user to distinguish between different signer/verifier/encryptor/decryptor endpoints within the camel context. | | String -|======================================================================= +| *cryptoOperation* | *Required* Set the Crypto operation from that supplied after the crypto scheme in the endpoint uri e.g. crypto-cms:sign sets sign as the operation. Possible values: sign verify encrypt or decrypt. | | CryptoOperation +| *name* | *Required* The name part in the URI can be chosen by the user to distinguish between different signer/verifier/encryptor/decryptor endpoints within the camel context. | | String +|=== -#### Query Parameters (15 parameters): +==== Query Parameters (15 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **keyStore** (common) | Keystore which contains signer private keys verifier public keys encryptor public keys decryptor private keys depending on the operation. Use either this parameter or the parameter 'keyStoreParameters'. | | KeyStore -| **keyStoreParameters** (common) | Keystore containing signer private keys verifier public keys encryptor public keys decryptor private keys depending on the operation. Use either this parameter or the parameter 'keystore'. | | KeyStoreParameters -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **password** (decrypt) | Sets the password of the private keys. It is assumed that all private keys in the keystore have the same password. If not set then it is assumed that the password of the private keys is given by the keystore password given in the KeyStoreParameters. | | Char[] -| **fromBase64** (decrypt_verify) | If true then the CMS message is base 64 encoded and must be decoded during the processing. Default value is false. | false | Boolean -| **contentEncryptionAlgorithm** (encrypt) | Encryption algorithm for example DESede/CBC/PKCS5Padding. Further possible values: DESede/CBC/PKCS5Padding AES/CBC/PKCS5Padding Camellia/CBC/PKCS5Padding CAST5/CBC/PKCS5Padding. | | String -| **originatorInformation Provider** (encrypt) | Provider for the originator info. See https://tools.ietf.org/html/rfc5652section-6.1. The default value is null. | | OriginatorInformation Provider -| **recipient** (encrypt) | Recipient Info: reference to a bean which implements the interface org.apache.camel.component.crypto.cms.api.TransRecipientInfo | | List -| **secretKeyLength** (encrypt) | Key length for the secret symmetric key used for the content encryption. Only used if the specified content-encryption algorithm allows keys of different sizes. If contentEncryptionAlgorithm=AES/CBC/PKCS5Padding or Camellia/CBC/PKCS5Padding then 128; if contentEncryptionAlgorithm=DESede/CBC/PKCS5Padding then 192 128; if strong encryption is enabled then for AES/CBC/PKCS5Padding and Camellia/CBC/PKCS5Padding also the key lengths 192 and 256 are possible. | | int -| **unprotectedAttributes GeneratorProvider** (encrypt) | Provider of the generator for the unprotected attributes. The default value is null which means no unprotected attribute is added to the Enveloped Data object. See https://tools.ietf.org/html/rfc5652section-6.1. | | AttributesGenerator Provider -| **toBase64** (encrypt_sign) | Indicates whether the Signed Data or Enveloped Data instance shall be base 64 encoded. Default value is false. | false | Boolean -| **includeContent** (sign) | Indicates whether the signed content should be included into the Signed Data instance. If false then a detached Signed Data instance is created in the header CamelCryptoCmsSignedData. | true | Boolean -| **signer** (sign) | Signer information: reference to a bean which implements org.apache.camel.component.crypto.cms.api.SignerInfo | | List -| **signedDataHeaderBase64** (verify) | Indicates whether the value in the header CamelCryptoCmsSignedData is base64 encoded. Default value is false. Only relevant for detached signatures. In the detached signature case the header contains the Signed Data object. | false | Boolean -| **verifySignaturesOfAll Signers** (verify) | If true then the signatures of all signers contained in the Signed Data object are verified. If false then only one signature whose signer info matches with one of the specified certificates is verified. Default value is true. | true | Boolean -|======================================================================= +| *keyStore* (common) | Keystore which contains signer private keys verifier public keys encryptor public keys decryptor private keys depending on the operation. Use either this parameter or the parameter 'keyStoreParameters'. | | KeyStore +| *keyStoreParameters* (common) | Keystore containing signer private keys verifier public keys encryptor public keys decryptor private keys depending on the operation. Use either this parameter or the parameter 'keystore'. | | KeyStoreParameters +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *password* (decrypt) | Sets the password of the private keys. It is assumed that all private keys in the keystore have the same password. If not set then it is assumed that the password of the private keys is given by the keystore password given in the KeyStoreParameters. | | Char[] +| *fromBase64* (decrypt_verify) | If true then the CMS message is base 64 encoded and must be decoded during the processing. Default value is false. | false | Boolean +| *contentEncryptionAlgorithm* (encrypt) | Encryption algorithm for example DESede/CBC/PKCS5Padding. Further possible values: DESede/CBC/PKCS5Padding AES/CBC/PKCS5Padding Camellia/CBC/PKCS5Padding CAST5/CBC/PKCS5Padding. | | String +| *originatorInformation Provider* (encrypt) | Provider for the originator info. See https://tools.ietf.org/html/rfc5652section-6.1. The default value is null. | | OriginatorInformation Provider +| *recipient* (encrypt) | Recipient Info: reference to a bean which implements the interface org.apache.camel.component.crypto.cms.api.TransRecipientInfo | | List +| *secretKeyLength* (encrypt) | Key length for the secret symmetric key used for the content encryption. Only used if the specified content-encryption algorithm allows keys of different sizes. If contentEncryptionAlgorithm=AES/CBC/PKCS5Padding or Camellia/CBC/PKCS5Padding then 128; if contentEncryptionAlgorithm=DESede/CBC/PKCS5Padding then 192 128; if strong encryption is enabled then for AES/CBC/PKCS5Padding and Camellia/CBC/PKCS5Padding also the key lengths 192 and 256 are possible. | | int +| *unprotectedAttributes GeneratorProvider* (encrypt) | Provider of the generator for the unprotected attributes. The default value is null which means no unprotected attribute is added to the Enveloped Data object. See https://tools.ietf.org/html/rfc5652section-6.1. | | AttributesGenerator Provider +| *toBase64* (encrypt_sign) | Indicates whether the Signed Data or Enveloped Data instance shall be base 64 encoded. Default value is false. | false | Boolean +| *includeContent* (sign) | Indicates whether the signed content should be included into the Signed Data instance. If false then a detached Signed Data instance is created in the header CamelCryptoCmsSignedData. | true | Boolean +| *signer* (sign) | Signer information: reference to a bean which implements org.apache.camel.component.crypto.cms.api.SignerInfo | | List +| *signedDataHeaderBase64* (verify) | Indicates whether the value in the header CamelCryptoCmsSignedData is base64 encoded. Default value is false. Only relevant for detached signatures. In the detached signature case the header contains the Signed Data object. | false | Boolean +| *verifySignaturesOfAll Signers* (verify) | If true then the signatures of all signers contained in the Signed Data object are verified. If false then only one signature whose signer info matches with one of the specified certificates is verified. Default value is true. | true | Boolean +|=== // endpoint options: END ### Enveloped Data http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-crypto/src/main/docs/crypto-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-crypto/src/main/docs/crypto-component.adoc b/components/camel-crypto/src/main/docs/crypto-component.adoc index 140b685..acb6591 100644 --- a/components/camel-crypto/src/main/docs/crypto-component.adoc +++ b/components/camel-crypto/src/main/docs/crypto-component.adoc @@ -1,4 +1,4 @@ -## Crypto (JCE) Component +== Crypto (JCE) Component *Available as of Camel version 2.3* @@ -85,54 +85,56 @@ The Crypto (JCE) component supports 2 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **configuration** (advanced) | To use the shared DigitalSignatureConfiguration as configuration | | DigitalSignature Configuration -| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean -|======================================================================= +| *configuration* (advanced) | To use the shared DigitalSignatureConfiguration as configuration | | DigitalSignature Configuration +| *resolveProperty Placeholders* (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean +|=== // component options: END // endpoint options: START The Crypto (JCE) endpoint is configured using URI syntax: - crypto:cryptoOperation:name +---- +crypto:cryptoOperation:name +---- 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 -| **cryptoOperation** | *Required* Set the Crypto operation from that supplied after the crypto scheme in the endpoint uri e.g. crypto:sign sets sign as the operation. | | CryptoOperation -| **name** | *Required* The logical name of this operation. | | String -|======================================================================= +| *cryptoOperation* | *Required* Set the Crypto operation from that supplied after the crypto scheme in the endpoint uri e.g. crypto:sign sets sign as the operation. | | CryptoOperation +| *name* | *Required* The logical name of this operation. | | String +|=== -#### Query Parameters (19 parameters): +==== Query Parameters (19 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **algorithm** (producer) | Sets the JCE name of the Algorithm that should be used for the signer. | SHA1WithDSA | String -| **alias** (producer) | Sets the alias used to query the KeyStore for keys and link java.security.cert.Certificate Certificates to be used in signing and verifying exchanges. This value can be provided at runtime via the message header link org.apache.camel.component.crypto.DigitalSignatureConstantsKEYSTORE_ALIAS | | String -| **certificateName** (producer) | Sets the reference name for a PrivateKey that can be fond in the registry. | | String -| **keystore** (producer) | Sets the KeyStore that can contain keys and Certficates for use in signing and verifying exchanges. A KeyStore is typically used with an alias either one supplied in the Route definition or dynamically via the message header CamelSignatureKeyStoreAlias. If no alias is supplied and there is only a single entry in the Keystore then this single entry will be used. | | KeyStore -| **keystoreName** (producer) | Sets the reference name for a Keystore that can be fond in the registry. | | String -| **privateKey** (producer) | Set the PrivateKey that should be used to sign the exchange | | PrivateKey -| **privateKeyName** (producer) | Sets the reference name for a PrivateKey that can be fond in the registry. | | String -| **provider** (producer) | Set the id of the security provider that provides the configured Signature algorithm. | | String -| **publicKeyName** (producer) | references that should be resolved when the context changes | | String -| **secureRandomName** (producer) | Sets the reference name for a SecureRandom that can be fond in the registry. | | String -| **signatureHeaderName** (producer) | Set the name of the message header that should be used to store the base64 encoded signature. This defaults to 'CamelDigitalSignature' | | String -| **bufferSize** (advanced) | Set the size of the buffer used to read in the Exchange payload data. | 2048 | Integer -| **certificate** (advanced) | Set the Certificate that should be used to verify the signature in the exchange based on its payload. | | Certificate -| **clearHeaders** (advanced) | Determines if the Signature specific headers be cleared after signing and verification. Defaults to true and should only be made otherwise at your extreme peril as vital private information such as Keys and passwords may escape if unset. | true | boolean -| **keyStoreParameters** (advanced) | Sets the KeyStore that can contain keys and Certficates for use in signing and verifying exchanges based on the given KeyStoreParameters. A KeyStore is typically used with an alias either one supplied in the Route definition or dynamically via the message header CamelSignatureKeyStoreAlias. If no alias is supplied and there is only a single entry in the Keystore then this single entry will be used. | | KeyStoreParameters -| **publicKey** (advanced) | Set the PublicKey that should be used to verify the signature in the exchange. | | PublicKey -| **secureRandom** (advanced) | Set the SecureRandom used to initialize the Signature service | | SecureRandom -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **password** (security) | Sets the password used to access an aliased PrivateKey in the KeyStore. | | String -|======================================================================= +| *algorithm* (producer) | Sets the JCE name of the Algorithm that should be used for the signer. | SHA1WithDSA | String +| *alias* (producer) | Sets the alias used to query the KeyStore for keys and link java.security.cert.Certificate Certificates to be used in signing and verifying exchanges. This value can be provided at runtime via the message header link org.apache.camel.component.crypto.DigitalSignatureConstantsKEYSTORE_ALIAS | | String +| *certificateName* (producer) | Sets the reference name for a PrivateKey that can be fond in the registry. | | String +| *keystore* (producer) | Sets the KeyStore that can contain keys and Certficates for use in signing and verifying exchanges. A KeyStore is typically used with an alias either one supplied in the Route definition or dynamically via the message header CamelSignatureKeyStoreAlias. If no alias is supplied and there is only a single entry in the Keystore then this single entry will be used. | | KeyStore +| *keystoreName* (producer) | Sets the reference name for a Keystore that can be fond in the registry. | | String +| *privateKey* (producer) | Set the PrivateKey that should be used to sign the exchange | | PrivateKey +| *privateKeyName* (producer) | Sets the reference name for a PrivateKey that can be fond in the registry. | | String +| *provider* (producer) | Set the id of the security provider that provides the configured Signature algorithm. | | String +| *publicKeyName* (producer) | references that should be resolved when the context changes | | String +| *secureRandomName* (producer) | Sets the reference name for a SecureRandom that can be fond in the registry. | | String +| *signatureHeaderName* (producer) | Set the name of the message header that should be used to store the base64 encoded signature. This defaults to 'CamelDigitalSignature' | | String +| *bufferSize* (advanced) | Set the size of the buffer used to read in the Exchange payload data. | 2048 | Integer +| *certificate* (advanced) | Set the Certificate that should be used to verify the signature in the exchange based on its payload. | | Certificate +| *clearHeaders* (advanced) | Determines if the Signature specific headers be cleared after signing and verification. Defaults to true and should only be made otherwise at your extreme peril as vital private information such as Keys and passwords may escape if unset. | true | boolean +| *keyStoreParameters* (advanced) | Sets the KeyStore that can contain keys and Certficates for use in signing and verifying exchanges based on the given KeyStoreParameters. A KeyStore is typically used with an alias either one supplied in the Route definition or dynamically via the message header CamelSignatureKeyStoreAlias. If no alias is supplied and there is only a single entry in the Keystore then this single entry will be used. | | KeyStoreParameters +| *publicKey* (advanced) | Set the PublicKey that should be used to verify the signature in the exchange. | | PublicKey +| *secureRandom* (advanced) | Set the SecureRandom used to initialize the Signature service | | SecureRandom +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *password* (security) | Sets the password used to access an aliased PrivateKey in the KeyStore. | | String +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-crypto/src/main/docs/crypto-dataformat.adoc ---------------------------------------------------------------------- diff --git a/components/camel-crypto/src/main/docs/crypto-dataformat.adoc b/components/camel-crypto/src/main/docs/crypto-dataformat.adoc index 9abbbd1..a9027d0 100644 --- a/components/camel-crypto/src/main/docs/crypto-dataformat.adoc +++ b/components/camel-crypto/src/main/docs/crypto-dataformat.adoc @@ -1,4 +1,4 @@ -## Crypto (Java Cryptographic Extension) DataFormat +== Crypto (Java Cryptographic Extension) DataFormat *Available as of Camel version 2.3* @@ -18,7 +18,7 @@ The Crypto (Java Cryptographic Extension) dataformat supports 10 options which a [width="100%",cols="2s,1m,1m,6",options="header"] -|======================================================================= +|=== | Name | Default | Java Type | Description | algorithm | DES/CBC/PKCS5Padding | String | The JCE algorithm name indicating the cryptographic algorithm that will be used. Is by default DES/CBC/PKCS5Padding. | cryptoProvider | | String | The name of the JCE Security Provider that should be used. @@ -30,7 +30,7 @@ The Crypto (Java Cryptographic Extension) dataformat supports 10 options which a | shouldAppendHMAC | false | Boolean | Flag indicating that a Message Authentication Code should be calculated and appended to the encrypted data. | inline | false | Boolean | Flag indicating that the configured IV should be inlined into the encrypted data stream. Is by default false. | contentTypeHeader | false | Boolean | Whether the data format should set the Content-Type header with the type from the data format if the data format is capable of doing so. For example application/xml for data formats marshalling to XML or application/json for data formats marshalling to JSon etc. -|======================================================================= +|=== // dataformat options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-crypto/src/main/docs/pgp-dataformat.adoc ---------------------------------------------------------------------- diff --git a/components/camel-crypto/src/main/docs/pgp-dataformat.adoc b/components/camel-crypto/src/main/docs/pgp-dataformat.adoc index 70614ab..06e6e3a 100644 --- a/components/camel-crypto/src/main/docs/pgp-dataformat.adoc +++ b/components/camel-crypto/src/main/docs/pgp-dataformat.adoc @@ -1,4 +1,4 @@ -## PGP DataFormat +== PGP DataFormat *Available as of Camel version 2.9* @@ -18,7 +18,7 @@ The PGP dataformat supports 15 options which are listed below. [width="100%",cols="2s,1m,1m,6",options="header"] -|======================================================================= +|=== | Name | Default | Java Type | Description | keyUserid | | String | The user ID of the key in the PGP keyring used during encryption. Can also be only a part of a user ID. For example if the user ID is Test User then you can use the part Test User or to address the user ID. | signatureKeyUserid | | String | User ID of the key in the PGP keyring used for signing (during encryption) or signature verification (during decryption). During the signature verification process the specified User ID restricts the public keys from the public keyring which can be used for the verification. If no User ID is specified for the signature verficiation then any public key in the public keyring can be used for the verification. Can also be only a part of a user ID. For example if the user ID is Test User then you can use the part Test User or to address the User ID. @@ -35,7 +35,7 @@ The PGP dataformat supports 15 options which are listed below. | hashAlgorithm | | Integer | Signature hash algorithm; possible values are defined in org.bouncycastle.bcpg.HashAlgorithmTags; for example 2 (= SHA1) 8 (= SHA256) 9 (= SHA384) 10 (= SHA512) 11 (=SHA224). Only relevant for signing. | signatureVerificationOption | | String | Controls the behavior for verifying the signature during unmarshaling. There are 4 values possible: optional: The PGP message may or may not contain signatures; if it does contain signatures then a signature verification is executed. required: The PGP message must contain at least one signature; if this is not the case an exception (PGPException) is thrown. A signature verification is executed. ignore: Contained signatures in the PGP message are ignored; no signature verification is executed. no_signature_allowed: The PGP message must not contain a signature; otherwise an exception (PGPException) is thrown. | 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 ### PGPDataFormat Message Headers http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-csv/src/main/docs/csv-dataformat.adoc ---------------------------------------------------------------------- diff --git a/components/camel-csv/src/main/docs/csv-dataformat.adoc b/components/camel-csv/src/main/docs/csv-dataformat.adoc index fe18174..cc0fd28 100644 --- a/components/camel-csv/src/main/docs/csv-dataformat.adoc +++ b/components/camel-csv/src/main/docs/csv-dataformat.adoc @@ -1,4 +1,4 @@ -## CSV DataFormat +== CSV DataFormat *Available as of Camel version 1.3* @@ -16,7 +16,7 @@ The CSV dataformat supports 27 options which are listed below. [width="100%",cols="2s,1m,1m,6",options="header"] -|======================================================================= +|=== | Name | Default | Java Type | Description | formatRef | | String | The reference format to use it will be updated with the other format options the default value is CSVFormat.DEFAULT | formatName | | String | The name of the format to use the default value is CSVFormat.DEFAULT @@ -45,7 +45,7 @@ The CSV dataformat supports 27 options which are listed below. | useMaps | false | Boolean | Whether the unmarshalling should produce maps for the lines values instead of lists. It requires to have header (either defined or collected). | recordConverterRef | | String | Refers to a custom CsvRecordConverter to lookup from the registry to use. | contentTypeHeader | false | Boolean | Whether the data format should set the Content-Type header with the type from the data format if the data format is capable of doing so. For example application/xml for data formats marshalling to XML or application/json for data formats marshalling to JSon etc. -|======================================================================= +|=== // dataformat options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-cxf/src/main/docs/cxf-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-cxf/src/main/docs/cxf-component.adoc b/components/camel-cxf/src/main/docs/cxf-component.adoc index c8d56a7..68ee9b4 100644 --- a/components/camel-cxf/src/main/docs/cxf-component.adoc +++ b/components/camel-cxf/src/main/docs/cxf-component.adoc @@ -1,4 +1,4 @@ -## CXF Component +== CXF Component *Available as of Camel version 1.0* @@ -117,13 +117,13 @@ The CXF component supports 4 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **allowStreaming** (advanced) | This option controls whether the CXF component when running in PAYLOAD mode will DOM parse the incoming messages into DOM Elements or keep the payload as a javax.xml.transform.Source object that would allow streaming in some cases. | | Boolean -| **useGlobalSslContext Parameters** (security) | Enable usage of global SSL context parameters. | false | boolean -| **headerFilterStrategy** (filter) | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy -| **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 -|======================================================================= +| *allowStreaming* (advanced) | This option controls whether the CXF component when running in PAYLOAD mode will DOM parse the incoming messages into DOM Elements or keep the payload as a javax.xml.transform.Source object that would allow streaming in some cases. | | Boolean +| *useGlobalSslContext Parameters* (security) | Enable usage of global SSL context parameters. | false | boolean +| *headerFilterStrategy* (filter) | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy +| *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 @@ -133,59 +133,61 @@ The CXF component supports 4 options which are listed below. // endpoint options: START The CXF endpoint is configured using URI syntax: - cxf:beanId:address +---- +cxf:beanId:address +---- 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 -| **beanId** | To lookup an existing configured CxfEndpoint. Must used bean: as prefix. | | String -| **address** | The service publish address. | | String -|======================================================================= +| *beanId* | To lookup an existing configured CxfEndpoint. Must used bean: as prefix. | | String +| *address* | The service publish address. | | String +|=== -#### Query Parameters (34 parameters): +==== Query Parameters (34 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **dataFormat** (common) | The data type messages supported by the CXF endpoint. | POJO | DataFormat -| **wrappedStyle** (common) | The WSDL style that describes how parameters are represented in the SOAP body. If the value is false CXF will chose the document-literal unwrapped style If the value is true CXF will chose the document-literal wrapped style | | 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 -| **cookieHandler** (producer) | Configure a cookie handler to maintain a HTTP session | | CookieHandler -| **defaultOperationName** (producer) | This option will set the default operationName that will be used by the CxfProducer which invokes the remote service. | | String -| **defaultOperationNamespace** (producer) | This option will set the default operationNamespace that will be used by the CxfProducer which invokes the remote service. | | String -| **hostnameVerifier** (producer) | The hostname verifier to be used. Use the notation to reference a HostnameVerifier from the registry. | | HostnameVerifier -| **sslContextParameters** (producer) | The Camel SSL setting reference. Use the notation to reference the SSL Context. | | SSLContextParameters -| **wrapped** (producer) | Which kind of operation that CXF endpoint producer will invoke | false | boolean -| **allowStreaming** (advanced) | This option controls whether the CXF component when running in PAYLOAD mode will DOM parse the incoming messages into DOM Elements or keep the payload as a javax.xml.transform.Source object that would allow streaming in some cases. | | Boolean -| **bus** (advanced) | To use a custom configured CXF Bus. | | Bus -| **continuationTimeout** (advanced) | This option is used to set the CXF continuation timeout which could be used in CxfConsumer by default when the CXF server is using Jetty or Servlet transport. | 30000 | long -| **cxfBinding** (advanced) | To use a custom CxfBinding to control the binding between Camel Message and CXF Message. | | CxfBinding -| **cxfEndpointConfigurer** (advanced) | This option could apply the implementation of org.apache.camel.component.cxf.CxfEndpointConfigurer which supports to configure the CXF endpoint in programmatic way. User can configure the CXF server and client by implementing configureServerClient method of CxfEndpointConfigurer. | | CxfEndpointConfigurer -| **defaultBus** (advanced) | Will set the default bus when CXF endpoint create a bus by itself | false | boolean -| **headerFilterStrategy** (advanced) | To use a custom HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy -| **mergeProtocolHeaders** (advanced) | Whether to merge protocol headers. If enabled then propagating headers between Camel and CXF becomes more consistent and similar. For more details see CAMEL-6393. | false | boolean -| **mtomEnabled** (advanced) | To enable MTOM (attachments). This requires to use POJO or PAYLOAD data format mode. | false | boolean -| **properties** (advanced) | To set additional CXF options using the key/value pairs from the Map. For example to turn on stacktraces in SOAP faults properties.faultStackTraceEnabled=true | | Map -| **skipPayloadMessagePart Check** (advanced) | Sets whether SOAP message validation should be disabled. | false | boolean -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **loggingFeatureEnabled** (logging) | This option enables CXF Logging Feature which writes inbound and outbound SOAP messages to log. | false | boolean -| **loggingSizeLimit** (logging) | To limit the total size of number of bytes the logger will output when logging feature has been enabled and -1 for no limit. | 49152 | int -| **skipFaultLogging** (logging) | This option controls whether the PhaseInterceptorChain skips logging the Fault that it catches. | false | boolean -| **password** (security) | This option is used to set the basic authentication information of password for the CXF client. | | String -| **username** (security) | This option is used to set the basic authentication information of username for the CXF client. | | String -| **bindingId** (service) | The bindingId for the service model to use. | | String -| **portName** (service) | The endpoint name this service is implementing it maps to the wsdl:portname. In the format of ns:PORT_NAME where ns is a namespace prefix valid at this scope. | | String -| **publishedEndpointUrl** (service) | This option can override the endpointUrl that published from the WSDL which can be accessed with service address url plus wsd | | String -| **serviceClass** (service) | The class name of the SEI (Service Endpoint Interface) class which could have JSR181 annotation or not. | | Class<?> -| **serviceName** (service) | The service name this service is implementing it maps to the wsdl:servicename. | | String -| **wsdlURL** (service) | The location of the WSDL. Can be on the classpath file system or be hosted remotely. | | String -|======================================================================= +| *dataFormat* (common) | The data type messages supported by the CXF endpoint. | POJO | DataFormat +| *wrappedStyle* (common) | The WSDL style that describes how parameters are represented in the SOAP body. If the value is false CXF will chose the document-literal unwrapped style If the value is true CXF will chose the document-literal wrapped style | | 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 +| *cookieHandler* (producer) | Configure a cookie handler to maintain a HTTP session | | CookieHandler +| *defaultOperationName* (producer) | This option will set the default operationName that will be used by the CxfProducer which invokes the remote service. | | String +| *defaultOperationNamespace* (producer) | This option will set the default operationNamespace that will be used by the CxfProducer which invokes the remote service. | | String +| *hostnameVerifier* (producer) | The hostname verifier to be used. Use the notation to reference a HostnameVerifier from the registry. | | HostnameVerifier +| *sslContextParameters* (producer) | The Camel SSL setting reference. Use the notation to reference the SSL Context. | | SSLContextParameters +| *wrapped* (producer) | Which kind of operation that CXF endpoint producer will invoke | false | boolean +| *allowStreaming* (advanced) | This option controls whether the CXF component when running in PAYLOAD mode will DOM parse the incoming messages into DOM Elements or keep the payload as a javax.xml.transform.Source object that would allow streaming in some cases. | | Boolean +| *bus* (advanced) | To use a custom configured CXF Bus. | | Bus +| *continuationTimeout* (advanced) | This option is used to set the CXF continuation timeout which could be used in CxfConsumer by default when the CXF server is using Jetty or Servlet transport. | 30000 | long +| *cxfBinding* (advanced) | To use a custom CxfBinding to control the binding between Camel Message and CXF Message. | | CxfBinding +| *cxfEndpointConfigurer* (advanced) | This option could apply the implementation of org.apache.camel.component.cxf.CxfEndpointConfigurer which supports to configure the CXF endpoint in programmatic way. User can configure the CXF server and client by implementing configureServerClient method of CxfEndpointConfigurer. | | CxfEndpointConfigurer +| *defaultBus* (advanced) | Will set the default bus when CXF endpoint create a bus by itself | false | boolean +| *headerFilterStrategy* (advanced) | To use a custom HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy +| *mergeProtocolHeaders* (advanced) | Whether to merge protocol headers. If enabled then propagating headers between Camel and CXF becomes more consistent and similar. For more details see CAMEL-6393. | false | boolean +| *mtomEnabled* (advanced) | To enable MTOM (attachments). This requires to use POJO or PAYLOAD data format mode. | false | boolean +| *properties* (advanced) | To set additional CXF options using the key/value pairs from the Map. For example to turn on stacktraces in SOAP faults properties.faultStackTraceEnabled=true | | Map +| *skipPayloadMessagePart Check* (advanced) | Sets whether SOAP message validation should be disabled. | false | boolean +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *loggingFeatureEnabled* (logging) | This option enables CXF Logging Feature which writes inbound and outbound SOAP messages to log. | false | boolean +| *loggingSizeLimit* (logging) | To limit the total size of number of bytes the logger will output when logging feature has been enabled and -1 for no limit. | 49152 | int +| *skipFaultLogging* (logging) | This option controls whether the PhaseInterceptorChain skips logging the Fault that it catches. | false | boolean +| *password* (security) | This option is used to set the basic authentication information of password for the CXF client. | | String +| *username* (security) | This option is used to set the basic authentication information of username for the CXF client. | | String +| *bindingId* (service) | The bindingId for the service model to use. | | String +| *portName* (service) | The endpoint name this service is implementing it maps to the wsdl:portname. In the format of ns:PORT_NAME where ns is a namespace prefix valid at this scope. | | String +| *publishedEndpointUrl* (service) | This option can override the endpointUrl that published from the WSDL which can be accessed with service address url plus wsd | | String +| *serviceClass* (service) | The class name of the SEI (Service Endpoint Interface) class which could have JSR181 annotation or not. | | Class<?> +| *serviceName* (service) | The service name this service is implementing it maps to the wsdl:servicename. | | String +| *wsdlURL* (service) | The location of the WSDL. Can be on the classpath file system or be hosted remotely. | | String +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-cxf/src/main/docs/cxfrs-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-cxf/src/main/docs/cxfrs-component.adoc b/components/camel-cxf/src/main/docs/cxfrs-component.adoc index 6c594f4..150aa1a 100644 --- a/components/camel-cxf/src/main/docs/cxfrs-component.adoc +++ b/components/camel-cxf/src/main/docs/cxfrs-component.adoc @@ -1,4 +1,4 @@ -## CXF-RS Component +== CXF-RS Component *Available as of Camel version 2.0* @@ -59,12 +59,12 @@ The CXF-RS component supports 3 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **useGlobalSslContext Parameters** (security) | Enable usage of global SSL context parameters. | false | boolean -| **headerFilterStrategy** (filter) | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy -| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean -|======================================================================= +| *useGlobalSslContext Parameters* (security) | Enable usage of global SSL context parameters. | false | boolean +| *headerFilterStrategy* (filter) | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy +| *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 @@ -73,54 +73,56 @@ The CXF-RS component supports 3 options which are listed below. // endpoint options: START The CXF-RS endpoint is configured using URI syntax: - cxfrs:beanId:address +---- +cxfrs:beanId:address +---- 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 -| **beanId** | To lookup an existing configured CxfRsEndpoint. Must used bean: as prefix. | | String -| **address** | The service publish address. | | String -|======================================================================= +| *beanId* | To lookup an existing configured CxfRsEndpoint. Must used bean: as prefix. | | String +| *address* | The service publish address. | | String +|=== -#### Query Parameters (29 parameters): +==== Query Parameters (29 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **features** (common) | Set the feature list to the CxfRs endpoint. | | List -| **loggingFeatureEnabled** (common) | This option enables CXF Logging Feature which writes inbound and outbound REST messages to log. | false | boolean -| **loggingSizeLimit** (common) | To limit the total size of number of bytes the logger will output when logging feature has been enabled. | | int -| **modelRef** (common) | This option is used to specify the model file which is useful for the resource class without annotation. When using this option then the service class can be omitted to emulate document-only endpoints | | String -| **providers** (common) | Set custom JAX-RS provider(s) list to the CxfRs endpoint. You can specify a string with a list of providers to lookup in the registy separated by comma. | | String -| **resourceClasses** (common) | The resource classes which you want to export as REST service. Multiple classes can be separated by comma. | | List -| **schemaLocations** (common) | Sets the locations of the schema(s) which can be used to validate the incoming XML or JAXB-driven JSON. | | List -| **skipFaultLogging** (common) | This option controls whether the PhaseInterceptorChain skips logging the Fault that it catches. | false | boolean -| **bindingStyle** (consumer) | Sets how requests and responses will be mapped to/from Camel. Two values are possible: SimpleConsumer: This binding style processes request parameters multiparts etc. and maps them to IN headers IN attachments and to the message body. It aims to eliminate low-level processing of org.apache.cxf.message.MessageContentsList. It also also adds more flexibility and simplicity to the response mapping. Only available for consumers. Default: The default style. For consumers this passes on a MessageContentsList to the route requiring low-level processing in the route. This is the traditional binding style which simply dumps the org.apache.cxf.message.MessageContentsList coming in from the CXF stack onto the IN message body. The user is then responsible for processing it according to the contract defined by the JAX-RS method signature. Custom: allows you to specify a custom binding through the binding option. | Default | BindingStyle -| **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 -| **publishedEndpointUrl** (consumer) | This option can override the endpointUrl that published from the WADL which can be accessed with resource address url plus _wadl | | 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 -| **cookieHandler** (producer) | Configure a cookie handler to maintain a HTTP session | | CookieHandler -| **hostnameVerifier** (producer) | The hostname verifier to be used. Use the notation to reference a HostnameVerifier from the registry. | | HostnameVerifier -| **sslContextParameters** (producer) | The Camel SSL setting reference. Use the notation to reference the SSL Context. | | SSLContextParameters -| **throwExceptionOnFailure** (producer) | This option tells the CxfRsProducer to inspect return codes and will generate an Exception if the return code is larger than 207. | true | boolean -| **httpClientAPI** (producer) | If it is true the CxfRsProducer will use the HttpClientAPI to invoke the service. If it is false the CxfRsProducer will use the ProxyClientAPI to invoke the service | true | boolean -| **ignoreDeleteMethodMessage Body** (producer) | This option is used to tell CxfRsProducer to ignore the message body of the DELETE method when using HTTP API. | false | boolean -| **maxClientCacheSize** (producer) | This option allows you to configure the maximum size of the cache. The implementation caches CXF clients or ClientFactoryBean in CxfProvider and CxfRsProvider. | 10 | int -| **binding** (advanced) | To use a custom CxfBinding to control the binding between Camel Message and CXF Message. | | CxfRsBinding -| **bus** (advanced) | To use a custom configured CXF Bus. | | Bus -| **continuationTimeout** (advanced) | This option is used to set the CXF continuation timeout which could be used in CxfConsumer by default when the CXF server is using Jetty or Servlet transport. | 30000 | long -| **cxfRsEndpointConfigurer** (advanced) | This option could apply the implementation of org.apache.camel.component.cxf.jaxrs.CxfRsEndpointConfigurer which supports to configure the CXF endpoint in programmatic way. User can configure the CXF server and client by implementing configureServer/Client method of CxfEndpointConfigurer. | | CxfRsEndpoint Configurer -| **defaultBus** (advanced) | Will set the default bus when CXF endpoint create a bus by itself | false | boolean -| **headerFilterStrategy** (advanced) | To use a custom HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy -| **performInvocation** (advanced) | When the option is true Camel will perform the invocation of the resource class instance and put the response object into the exchange for further processing. | false | boolean -| **propagateContexts** (advanced) | When the option is true JAXRS UriInfo HttpHeaders Request and SecurityContext contexts will be available to custom CXFRS processors as typed Camel exchange properties. These contexts can be used to analyze the current requests using JAX-RS API. | false | boolean -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *features* (common) | Set the feature list to the CxfRs endpoint. | | List +| *loggingFeatureEnabled* (common) | This option enables CXF Logging Feature which writes inbound and outbound REST messages to log. | false | boolean +| *loggingSizeLimit* (common) | To limit the total size of number of bytes the logger will output when logging feature has been enabled. | | int +| *modelRef* (common) | This option is used to specify the model file which is useful for the resource class without annotation. When using this option then the service class can be omitted to emulate document-only endpoints | | String +| *providers* (common) | Set custom JAX-RS provider(s) list to the CxfRs endpoint. You can specify a string with a list of providers to lookup in the registy separated by comma. | | String +| *resourceClasses* (common) | The resource classes which you want to export as REST service. Multiple classes can be separated by comma. | | List +| *schemaLocations* (common) | Sets the locations of the schema(s) which can be used to validate the incoming XML or JAXB-driven JSON. | | List +| *skipFaultLogging* (common) | This option controls whether the PhaseInterceptorChain skips logging the Fault that it catches. | false | boolean +| *bindingStyle* (consumer) | Sets how requests and responses will be mapped to/from Camel. Two values are possible: SimpleConsumer: This binding style processes request parameters multiparts etc. and maps them to IN headers IN attachments and to the message body. It aims to eliminate low-level processing of org.apache.cxf.message.MessageContentsList. It also also adds more flexibility and simplicity to the response mapping. Only available for consumers. Default: The default style. For consumers this passes on a MessageContentsList to the route requiring low-level processing in the route. This is the traditional binding style which simply dumps the org.apache.cxf.message.MessageContentsList coming in from the CXF stack onto the IN message body. The user is then responsible for processing it according to the contract defined by the JAX-RS method signature. Custom: allows you to specify a custom binding through the binding option. | Default | BindingStyle +| *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 +| *publishedEndpointUrl* (consumer) | This option can override the endpointUrl that published from the WADL which can be accessed with resource address url plus _wadl | | 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 +| *cookieHandler* (producer) | Configure a cookie handler to maintain a HTTP session | | CookieHandler +| *hostnameVerifier* (producer) | The hostname verifier to be used. Use the notation to reference a HostnameVerifier from the registry. | | HostnameVerifier +| *sslContextParameters* (producer) | The Camel SSL setting reference. Use the notation to reference the SSL Context. | | SSLContextParameters +| *throwExceptionOnFailure* (producer) | This option tells the CxfRsProducer to inspect return codes and will generate an Exception if the return code is larger than 207. | true | boolean +| *httpClientAPI* (producer) | If it is true the CxfRsProducer will use the HttpClientAPI to invoke the service. If it is false the CxfRsProducer will use the ProxyClientAPI to invoke the service | true | boolean +| *ignoreDeleteMethodMessage Body* (producer) | This option is used to tell CxfRsProducer to ignore the message body of the DELETE method when using HTTP API. | false | boolean +| *maxClientCacheSize* (producer) | This option allows you to configure the maximum size of the cache. The implementation caches CXF clients or ClientFactoryBean in CxfProvider and CxfRsProvider. | 10 | int +| *binding* (advanced) | To use a custom CxfBinding to control the binding between Camel Message and CXF Message. | | CxfRsBinding +| *bus* (advanced) | To use a custom configured CXF Bus. | | Bus +| *continuationTimeout* (advanced) | This option is used to set the CXF continuation timeout which could be used in CxfConsumer by default when the CXF server is using Jetty or Servlet transport. | 30000 | long +| *cxfRsEndpointConfigurer* (advanced) | This option could apply the implementation of org.apache.camel.component.cxf.jaxrs.CxfRsEndpointConfigurer which supports to configure the CXF endpoint in programmatic way. User can configure the CXF server and client by implementing configureServer/Client method of CxfEndpointConfigurer. | | CxfRsEndpoint Configurer +| *defaultBus* (advanced) | Will set the default bus when CXF endpoint create a bus by itself | false | boolean +| *headerFilterStrategy* (advanced) | To use a custom HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy +| *performInvocation* (advanced) | When the option is true Camel will perform the invocation of the resource class instance and put the response object into the exchange for further processing. | false | boolean +| *propagateContexts* (advanced) | When the option is true JAXRS UriInfo HttpHeaders Request and SecurityContext contexts will be available to custom CXFRS processors as typed Camel exchange properties. These contexts can be used to analyze the current requests using JAX-RS API. | 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-digitalocean/src/main/docs/digitalocean-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-digitalocean/src/main/docs/digitalocean-component.adoc b/components/camel-digitalocean/src/main/docs/digitalocean-component.adoc index 9256362..be4da70 100644 --- a/components/camel-digitalocean/src/main/docs/digitalocean-component.adoc +++ b/components/camel-digitalocean/src/main/docs/digitalocean-component.adoc @@ -1,4 +1,4 @@ -## DigitalOcean Component +== DigitalOcean Component *Available as of Camel version 2.19* @@ -36,34 +36,36 @@ The DigitalOcean component has no options. // endpoint options: START The DigitalOcean endpoint is configured using URI syntax: - digitalocean:operation +---- +digitalocean:operation +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **operation** | The operation to perform to the given resource. | | DigitalOceanOperations -|======================================================================= +| *operation* | The operation to perform to the given resource. | | DigitalOceanOperations +|=== -#### Query Parameters (10 parameters): +==== Query Parameters (10 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **page** (producer) | Use for pagination. Force the page number. | 1 | Integer -| **perPage** (producer) | Use for pagination. Set the number of item per request. The maximum number of results per page is 200. | 25 | Integer -| **resource** (producer) | *Required* The DigitalOcean resource type on which perform the operation. | | DigitalOceanResources -| **digitalOceanClient** (advanced) | To use a existing configured DigitalOceanClient as client | | DigitalOceanClient -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **httpProxyHost** (proxy) | Set a proxy host if needed | | String -| **httpProxyPassword** (proxy) | Set a proxy password if needed | | String -| **httpProxyPort** (proxy) | Set a proxy port if needed | | Integer -| **httpProxyUser** (proxy) | Set a proxy host if needed | | String -| **oAuthToken** (security) | DigitalOcean OAuth Token | | String -|======================================================================= +| *page* (producer) | Use for pagination. Force the page number. | 1 | Integer +| *perPage* (producer) | Use for pagination. Set the number of item per request. The maximum number of results per page is 200. | 25 | Integer +| *resource* (producer) | *Required* The DigitalOcean resource type on which perform the operation. | | DigitalOceanResources +| *digitalOceanClient* (advanced) | To use a existing configured DigitalOceanClient as client | | DigitalOceanClient +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *httpProxyHost* (proxy) | Set a proxy host if needed | | String +| *httpProxyPassword* (proxy) | Set a proxy password if needed | | String +| *httpProxyPort* (proxy) | Set a proxy port if needed | | Integer +| *httpProxyUser* (proxy) | Set a proxy host if needed | | String +| *oAuthToken* (security) | DigitalOcean OAuth Token | | String +|=== // endpoint options: END @@ -260,4 +262,4 @@ Shutdown information for the Droplet (dropletId = 34772987) from("direct:shutdown") .setHeader(DigitalOceanConstants.ID, 34772987) .to("digitalocean:droplet?operation=shutdown&oAuthToken=XXXXXX") -``` \ No newline at end of file +```
