http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-aws/src/main/docs/aws-s3-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-aws/src/main/docs/aws-s3-component.adoc b/components/camel-aws/src/main/docs/aws-s3-component.adoc index 8c51b37..7c68df7 100644 --- a/components/camel-aws/src/main/docs/aws-s3-component.adoc +++ b/components/camel-aws/src/main/docs/aws-s3-component.adoc @@ -65,49 +65,89 @@ with the following path and query parameters: #### Query Parameters (40 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| accessKey | common | | String | Amazon AWS Access Key -| amazonS3Client | common | | AmazonS3 | Reference to a com.amazonaws.services.sqs.AmazonS3 in the link:registry.htmlRegistry. -| amazonS3Endpoint | common | | String | The region with which the AWS-S3 client wants to work with. -| pathStyleAccess | common | false | boolean | Whether or not the S3 client should use path style access -| policy | common | | String | Camel 2.8.4: The policy for this queue to set in the com.amazonaws.services.s3.AmazonS3setBucketPolicy() method. -| proxyHost | common | | String | Camel 2.16: To define a proxy host when instantiating the SQS client -| proxyPort | common | | Integer | Camel 2.16: Specify a proxy port to be used inside the client definition. -| secretKey | common | | String | Amazon AWS Secret Key -| autocloseBody | consumer | true | boolean | If this option is true and includeBody is true then the S3Object.close() method will be called on exchange completion This option is strongly related to includeBody option. In case of setting includeBody to true and autocloseBody to false it will be up to the caller to close the S3Object stream. Setting autocloseBody to true will close the S3Object stream automatically. -| bridgeErrorHandler | consumer | 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. -| deleteAfterRead | consumer | true | boolean | Delete objects from S3 after they have been retrieved. The delete is only performed if the Exchange is committed. If a rollback occurs the object is not deleted. If this option is false then the same objects will be retrieve over and over again on the polls. Therefore you need to use the Idempotent Consumer EIP in the route to filter out duplicates. You can filter using the link S3ConstantsBUCKET_NAME and link S3ConstantsKEY headers or only the link S3ConstantsKEY header. -| fileName | consumer | | String | To get the object from the bucket with the given file name -| includeBody | consumer | true | boolean | If it is true the exchange body will be set to a stream to the contents of the file. If false the headers will be set with the S3 object metadata but the body will be null. This option is strongly related to autocloseBody option. In case of setting includeBody to true and autocloseBody to false it will be up to the caller to close the S3Object stream. Setting autocloseBody to true will close the S3Object stream automatically. -| maxMessagesPerPoll | consumer | 10 | int | Gets the maximum number of messages as a limit to poll at each polling. Is default unlimited but use 0 or negative number to disable it as unlimited. -| prefix | consumer | | String | Camel 2.10.1: The prefix which is used in the com.amazonaws.services.s3.model.ListObjectsRequest to only consume objects we are interested in. -| sendEmptyMessageWhenIdle | consumer | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. -| exceptionHandler | consumer (advanced) | | 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 | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. -| pollStrategy | consumer (advanced) | | 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. -| deleteAfterWrite | producer | false | boolean | Camel 2.11.0: Delete file object after the S3 file has been uploaded -| multiPartUpload | producer | false | boolean | Camel 2.15.0: If it is true camel will upload the file with multi part format the part size is decided by the option of partSize -| operation | producer | | S3Operations | Camel 2.18: The operation to do in case the user don't want to do only an upload -| partSize | producer | 26214400 | long | Camel 2.15.0: Setup the partSize which is used in multi part upload the default size is 25M. -| region | producer | | String | The region where the bucket is located. This option is used in the com.amazonaws.services.s3.model.CreateBucketRequest. -| serverSideEncryption | producer | | String | Camel 2.16: Sets the server-side encryption algorithm when encrypting the object using AWS-managed keys. For example use AES256. -| storageClass | producer | | String | Camel 2.8.4: The storage class to set in the com.amazonaws.services.s3.model.PutObjectRequest request. -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). -| backoffErrorThreshold | scheduler | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. -| backoffIdleThreshold | scheduler | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. -| backoffMultiplier | scheduler | | 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 | scheduler | 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 | scheduler | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. -| initialDelay | scheduler | 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 | scheduler | 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 | scheduler | | 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 | scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component -| schedulerProperties | scheduler | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. -| startScheduler | scheduler | true | boolean | Whether the scheduler should be auto started. -| timeUnit | scheduler | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options. -| useFixedDelay | scheduler | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. +| Name | Default | Java Type | Description + +| accessKey | | String | Amazon AWS Access Key + +| amazonS3Client | | AmazonS3 | Reference to a com.amazonaws.services.sqs.AmazonS3 in the link:registry.htmlRegistry. + +| amazonS3Endpoint | | String | The region with which the AWS-S3 client wants to work with. + +| pathStyleAccess | false | boolean | Whether or not the S3 client should use path style access + +| policy | | String | Camel 2.8.4: The policy for this queue to set in the com.amazonaws.services.s3.AmazonS3setBucketPolicy() method. + +| proxyHost | | String | Camel 2.16: To define a proxy host when instantiating the SQS client + +| proxyPort | | Integer | Camel 2.16: Specify a proxy port to be used inside the client definition. + +| secretKey | | String | Amazon AWS Secret Key + 4+^s| consumer +| autocloseBody | true | boolean | If this option is true and includeBody is true then the S3Object.close() method will be called on exchange completion This option is strongly related to includeBody option. In case of setting includeBody to true and autocloseBody to false it will be up to the caller to close the S3Object stream. Setting autocloseBody to true will close the S3Object stream automatically. + +| 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. + +| deleteAfterRead | true | boolean | Delete objects from S3 after they have been retrieved. The delete is only performed if the Exchange is committed. If a rollback occurs the object is not deleted. If this option is false then the same objects will be retrieve over and over again on the polls. Therefore you need to use the Idempotent Consumer EIP in the route to filter out duplicates. You can filter using the link S3ConstantsBUCKET_NAME and link S3ConstantsKEY headers or only the link S3ConstantsKEY header. + +| fileName | | String | To get the object from the bucket with the given file name + +| includeBody | true | boolean | If it is true the exchange body will be set to a stream to the contents of the file. If false the headers will be set with the S3 object metadata but the body will be null. This option is strongly related to autocloseBody option. In case of setting includeBody to true and autocloseBody to false it will be up to the caller to close the S3Object stream. Setting autocloseBody to true will close the S3Object stream automatically. + +| maxMessagesPerPoll | 10 | int | Gets the maximum number of messages as a limit to poll at each polling. Is default unlimited but use 0 or negative number to disable it as unlimited. + +| prefix | | String | Camel 2.10.1: The prefix which is used in the com.amazonaws.services.s3.model.ListObjectsRequest to only consume objects we are interested in. + +| 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. + 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 +| deleteAfterWrite | false | boolean | Camel 2.11.0: Delete file object after the S3 file has been uploaded + +| multiPartUpload | false | boolean | Camel 2.15.0: If it is true camel will upload the file with multi part format the part size is decided by the option of partSize + +| operation | | S3Operations | Camel 2.18: The operation to do in case the user don't want to do only an upload + +| partSize | 26214400 | long | Camel 2.15.0: Setup the partSize which is used in multi part upload the default size is 25M. + +| region | | String | The region where the bucket is located. This option is used in the com.amazonaws.services.s3.model.CreateBucketRequest. + +| serverSideEncryption | | String | Camel 2.16: Sets the server-side encryption algorithm when encrypting the object using AWS-managed keys. For example use AES256. + +| storageClass | | String | Camel 2.8.4: The storage class to set in the com.amazonaws.services.s3.model.PutObjectRequest request. + 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| 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. |======================================================================= // endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-aws/src/main/docs/aws-sdb-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-aws/src/main/docs/aws-sdb-component.adoc b/components/camel-aws/src/main/docs/aws-sdb-component.adoc index d9da4ee..66205ca 100644 --- a/components/camel-aws/src/main/docs/aws-sdb-component.adoc +++ b/components/camel-aws/src/main/docs/aws-sdb-component.adoc @@ -48,19 +48,29 @@ with the following path and query parameters: #### Query Parameters (10 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| accessKey | producer | | String | Amazon AWS Access Key -| amazonSDBClient | producer | | AmazonSimpleDB | To use the AmazonSimpleDB as the client -| amazonSdbEndpoint | producer | | String | The region with which the AWS-SDB client wants to work with. -| consistentRead | producer | false | boolean | Determines whether or not strong consistency should be enforced when data is read. -| maxNumberOfDomains | producer | | Integer | The maximum number of domain names you want returned. The range is 1 to 100. -| operation | producer | PutAttributes | SdbOperations | Operation to perform -| proxyHost | producer | | String | To define a proxy host when instantiating the SQS client -| proxyPort | producer | | Integer | To define a proxy port when instantiating the SQS client -| secretKey | producer | | String | Amazon AWS Secret Key -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Default | Java Type | Description + +| accessKey | | String | Amazon AWS Access Key + +| amazonSDBClient | | AmazonSimpleDB | To use the AmazonSimpleDB as the client + +| amazonSdbEndpoint | | String | The region with which the AWS-SDB client wants to work with. + +| consistentRead | false | boolean | Determines whether or not strong consistency should be enforced when data is read. + +| maxNumberOfDomains | | Integer | The maximum number of domain names you want returned. The range is 1 to 100. + +| operation | PutAttributes | SdbOperations | Operation to perform + +| proxyHost | | String | To define a proxy host when instantiating the SQS client + +| proxyPort | | Integer | To define a proxy port when instantiating the SQS client + +| secretKey | | String | Amazon AWS Secret Key + 4+^s| advanced +| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-aws/src/main/docs/aws-ses-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-aws/src/main/docs/aws-ses-component.adoc b/components/camel-aws/src/main/docs/aws-ses-component.adoc index 9a56808..d7f3ed0 100644 --- a/components/camel-aws/src/main/docs/aws-ses-component.adoc +++ b/components/camel-aws/src/main/docs/aws-ses-component.adoc @@ -48,20 +48,31 @@ with the following path and query parameters: #### Query Parameters (11 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| accessKey | producer | | String | Amazon AWS Access Key -| amazonSESClient | producer | | AmazonSimpleEmailService | To use the AmazonSimpleEmailService as the client -| amazonSESEndpoint | producer | | String | The region with which the AWS-SES client wants to work with. -| proxyHost | producer | | String | To define a proxy host when instantiating the SQS client -| proxyPort | producer | | Integer | To define a proxy port when instantiating the SQS client -| replyToAddresses | producer | | List | List of reply-to email address(es) for the message override it using 'CamelAwsSesReplyToAddresses' header. -| returnPath | producer | | String | The email address to which bounce notifications are to be forwarded override it using 'CamelAwsSesReturnPath' header. -| secretKey | producer | | String | Amazon AWS Secret Key -| subject | producer | | String | The subject which is used if the message header 'CamelAwsSesSubject' is not present. -| to | producer | | List | List of destination email address. Can be overriden with 'CamelAwsSesTo' header. -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Default | Java Type | Description + +| accessKey | | String | Amazon AWS Access Key + +| amazonSESClient | | AmazonSimpleEmailService | To use the AmazonSimpleEmailService as the client + +| amazonSESEndpoint | | String | The region with which the AWS-SES client wants to work with. + +| proxyHost | | String | To define a proxy host when instantiating the SQS client + +| proxyPort | | Integer | To define a proxy port when instantiating the SQS client + +| replyToAddresses | | List | List of reply-to email address(es) for the message override it using 'CamelAwsSesReplyToAddresses' header. + +| returnPath | | String | The email address to which bounce notifications are to be forwarded override it using 'CamelAwsSesReturnPath' header. + +| secretKey | | String | Amazon AWS Secret Key + +| subject | | String | The subject which is used if the message header 'CamelAwsSesSubject' is not present. + +| to | | List | List of destination email address. Can be overriden with 'CamelAwsSesTo' header. + 4+^s| advanced +| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-aws/src/main/docs/aws-sns-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-aws/src/main/docs/aws-sns-component.adoc b/components/camel-aws/src/main/docs/aws-sns-component.adoc index 6e77473..7b92571 100644 --- a/components/camel-aws/src/main/docs/aws-sns-component.adoc +++ b/components/camel-aws/src/main/docs/aws-sns-component.adoc @@ -52,20 +52,31 @@ with the following path and query parameters: #### Query Parameters (11 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| accessKey | producer | | String | Amazon AWS Access Key -| amazonSNSClient | producer | | AmazonSNS | To use the AmazonSNS as the client -| amazonSNSEndpoint | producer | | String | The region with which the AWS-SNS client wants to work with. -| headerFilterStrategy | producer | | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to map headers to/from Camel. -| messageStructure | producer | | String | The message structure to use such as json -| policy | producer | | String | The policy for this queue -| proxyHost | producer | | String | To define a proxy host when instantiating the SQS client -| proxyPort | producer | | Integer | To define a proxy port when instantiating the SQS client -| secretKey | producer | | String | Amazon AWS Secret Key -| subject | producer | | String | The subject which is used if the message header 'CamelAwsSnsSubject' is not present. -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Default | Java Type | Description + +| accessKey | | String | Amazon AWS Access Key + +| amazonSNSClient | | AmazonSNS | To use the AmazonSNS as the client + +| amazonSNSEndpoint | | String | The region with which the AWS-SNS client wants to work with. + +| headerFilterStrategy | | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to map headers to/from Camel. + +| messageStructure | | String | The message structure to use such as json + +| policy | | String | The policy for this queue + +| proxyHost | | String | To define a proxy host when instantiating the SQS client + +| proxyPort | | Integer | To define a proxy port when instantiating the SQS client + +| secretKey | | String | Amazon AWS Secret Key + +| subject | | String | The subject which is used if the message header 'CamelAwsSnsSubject' is not present. + 4+^s| advanced +| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-aws/src/main/docs/aws-sqs-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-aws/src/main/docs/aws-sqs-component.adoc b/components/camel-aws/src/main/docs/aws-sqs-component.adoc index 8943048..6c9b0a5 100644 --- a/components/camel-aws/src/main/docs/aws-sqs-component.adoc +++ b/components/camel-aws/src/main/docs/aws-sqs-component.adoc @@ -53,53 +53,97 @@ with the following path and query parameters: #### Query Parameters (44 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| accessKey | common | | String | Amazon AWS Access Key -| amazonSQSClient | common | | AmazonSQS | To use the AmazonSQS as client -| amazonSQSEndpoint | common | | String | The region with which the AWS-SQS client wants to work with. Only works if Camel creates the AWS-SQS client i.e. if you explicitly set amazonSQSClient then this setting will have no effect. You would have to set it on the client you create directly -| headerFilterStrategy | common | | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to map headers to/from Camel. -| queueOwnerAWSAccountId | common | | String | Specify the queue owner aws account id when you need to connect the queue with different account owner. -| region | common | | String | Specify the queue region which could be used with queueOwnerAWSAccountId to build the service URL. -| secretKey | common | | String | Amazon AWS Secret Key -| attributeNames | consumer | | String | A list of attribute names to receive when consuming. Multiple names can be separated by comma. -| bridgeErrorHandler | consumer | 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. -| concurrentConsumers | consumer | 1 | int | Allows you to use multiple threads to poll the sqs queue to increase throughput -| defaultVisibilityTimeout | consumer | | Integer | The default visibility timeout (in seconds) -| deleteAfterRead | consumer | true | boolean | Delete message from SQS after it has been read -| deleteIfFiltered | consumer | true | boolean | Whether or not to send the DeleteMessage to the SQS queue if an exchange fails to get through a filter. If 'false' and exchange does not make it through a Camel filter upstream in the route then don't send DeleteMessage. -| extendMessageVisibility | consumer | false | boolean | If enabled then a scheduled background task will keep extending the message visibility on SQS. This is needed if it takes a long time to process the message. If set to true defaultVisibilityTimeout must be set. See details at Amazon docs. -| maxMessagesPerPoll | consumer | | int | Gets the maximum number of messages as a limit to poll at each polling. Is default unlimited but use 0 or negative number to disable it as unlimited. -| messageAttributeNames | consumer | | String | A list of message attribute names to receive when consuming. Multiple names can be separated by comma. -| sendEmptyMessageWhenIdle | consumer | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. -| visibilityTimeout | consumer | | Integer | The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request to set in the com.amazonaws.services.sqs.model.SetQueueAttributesRequest. This only make sense if its different from defaultVisibilityTimeout. It changes the queue visibility timeout attribute permanently. -| waitTimeSeconds | consumer | | Integer | Duration in seconds (0 to 20) that the ReceiveMessage action call will wait until a message is in the queue to include in the response. -| exceptionHandler | consumer (advanced) | | 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 | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. -| pollStrategy | consumer (advanced) | | 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. -| delaySeconds | producer | | Integer | Delay sending messages for a number of seconds. -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). -| backoffErrorThreshold | scheduler | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. -| backoffIdleThreshold | scheduler | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. -| backoffMultiplier | scheduler | | 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 | scheduler | 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 | scheduler | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. -| initialDelay | scheduler | 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 | scheduler | 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 | scheduler | | 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 | scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component -| schedulerProperties | scheduler | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. -| startScheduler | scheduler | true | boolean | Whether the scheduler should be auto started. -| timeUnit | scheduler | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options. -| useFixedDelay | scheduler | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. -| proxyHost | proxy | | String | To define a proxy host when instantiating the SQS client -| proxyPort | proxy | | Integer | To define a proxy port when instantiating the SQS client -| maximumMessageSize | queue | | Integer | The maximumMessageSize (in bytes) an SQS message can contain for this queue. -| messageRetentionPeriod | queue | | Integer | The messageRetentionPeriod (in seconds) a message will be retained by SQS for this queue. -| policy | queue | | String | The policy for this queue -| receiveMessageWaitTimeSeconds | queue | | Integer | If you do not specify WaitTimeSeconds in the request the queue attribute ReceiveMessageWaitTimeSeconds is used to determine how long to wait. -| redrivePolicy | queue | | String | Specify the policy that send message to DeadLetter queue. See detail at Amazon docs. +| Name | Default | Java Type | Description + +| accessKey | | String | Amazon AWS Access Key + +| amazonSQSClient | | AmazonSQS | To use the AmazonSQS as client + +| amazonSQSEndpoint | | String | The region with which the AWS-SQS client wants to work with. Only works if Camel creates the AWS-SQS client i.e. if you explicitly set amazonSQSClient then this setting will have no effect. You would have to set it on the client you create directly + +| headerFilterStrategy | | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to map headers to/from Camel. + +| queueOwnerAWSAccountId | | String | Specify the queue owner aws account id when you need to connect the queue with different account owner. + +| region | | String | Specify the queue region which could be used with queueOwnerAWSAccountId to build the service URL. + +| secretKey | | String | Amazon AWS Secret Key + 4+^s| consumer +| attributeNames | | String | A list of attribute names to receive when consuming. Multiple names can be separated by comma. + +| 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. + +| concurrentConsumers | 1 | int | Allows you to use multiple threads to poll the sqs queue to increase throughput + +| defaultVisibilityTimeout | | Integer | The default visibility timeout (in seconds) + +| deleteAfterRead | true | boolean | Delete message from SQS after it has been read + +| deleteIfFiltered | true | boolean | Whether or not to send the DeleteMessage to the SQS queue if an exchange fails to get through a filter. If 'false' and exchange does not make it through a Camel filter upstream in the route then don't send DeleteMessage. + +| extendMessageVisibility | false | boolean | If enabled then a scheduled background task will keep extending the message visibility on SQS. This is needed if it takes a long time to process the message. If set to true defaultVisibilityTimeout must be set. See details at Amazon docs. + +| maxMessagesPerPoll | | int | Gets the maximum number of messages as a limit to poll at each polling. Is default unlimited but use 0 or negative number to disable it as unlimited. + +| messageAttributeNames | | String | A list of message attribute names to receive when consuming. Multiple names can be separated by comma. + +| 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. + +| visibilityTimeout | | Integer | The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request to set in the com.amazonaws.services.sqs.model.SetQueueAttributesRequest. This only make sense if its different from defaultVisibilityTimeout. It changes the queue visibility timeout attribute permanently. + +| waitTimeSeconds | | Integer | Duration in seconds (0 to 20) that the ReceiveMessage action call will wait until a message is in the queue to include in the response. + 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 +| delaySeconds | | Integer | Delay sending messages for a number of seconds. + 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| 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| proxy +| proxyHost | | String | To define a proxy host when instantiating the SQS client + +| proxyPort | | Integer | To define a proxy port when instantiating the SQS client + 4+^s| queue +| maximumMessageSize | | Integer | The maximumMessageSize (in bytes) an SQS message can contain for this queue. + +| messageRetentionPeriod | | Integer | The messageRetentionPeriod (in seconds) a message will be retained by SQS for this queue. + +| policy | | String | The policy for this queue + +| receiveMessageWaitTimeSeconds | | Integer | If you do not specify WaitTimeSeconds in the request the queue attribute ReceiveMessageWaitTimeSeconds is used to determine how long to wait. + +| redrivePolicy | | String | Specify the policy that send message to DeadLetter queue. See detail at Amazon docs. |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-aws/src/main/docs/aws-swf-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-aws/src/main/docs/aws-swf-component.adoc b/components/camel-aws/src/main/docs/aws-swf-component.adoc index 39f17c5..a741189 100644 --- a/components/camel-aws/src/main/docs/aws-swf-component.adoc +++ b/components/camel-aws/src/main/docs/aws-swf-component.adoc @@ -48,38 +48,67 @@ with the following path and query parameters: #### Query Parameters (29 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| accessKey | common | | String | Amazon AWS Access Key. -| amazonSWClient | common | | AmazonSimpleWorkflowClient | To use the given AmazonSimpleWorkflowClient as client -| dataConverter | common | | DataConverter | An instance of com.amazonaws.services.simpleworkflow.flow.DataConverter to use for serializing/deserializing the data. -| domainName | common | | String | The workflow domain to use. -| eventName | common | | String | The workflow or activity event name to use. -| secretKey | common | | String | Amazon AWS Secret Key. -| version | common | | String | The workflow or activity event version to use. -| bridgeErrorHandler | consumer | 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. -| exceptionHandler | consumer (advanced) | | 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 | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. -| clientConfigurationParameters | advanced | | Map | To configure the ClientConfiguration using the key/values from the Map. -| startWorkflowOptionsParameters | advanced | | Map | To configure the StartWorkflowOptions using the key/values from the Map. -| sWClientParameters | advanced | | Map | To configure the AmazonSimpleWorkflowClient using the key/values from the Map. -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). -| activityList | activity | | String | The list name to consume activities from. -| activitySchedulingOptions | activity | | ActivitySchedulingOptions | Activity scheduling options -| activityThreadPoolSize | activity | 100 | int | Maximum number of threads in work pool for activity. -| activityTypeExecutionOptions | activity | | ActivityTypeExecutionOptions | Activity execution options -| activityTypeRegistrationOptions | activity | | ActivityTypeRegistrationOptions | Activity registration options -| childPolicy | workflow | | String | The policy to use on child workflows when terminating a workflow. -| executionStartToCloseTimeout | workflow | 3600 | String | Set the execution start to close timeout. -| operation | workflow | START | String | Workflow operation -| signalName | workflow | | String | The name of the signal to send to the workflow. -| stateResultType | workflow | | String | The type of the result when a workflow state is queried. -| taskStartToCloseTimeout | workflow | 600 | String | Set the task start to close timeout. -| terminationDetails | workflow | | String | Details for terminating a workflow. -| terminationReason | workflow | | String | The reason for terminating a workflow. -| workflowList | workflow | | String | The list name to consume workflows from. -| workflowTypeRegistrationOptions | workflow | | WorkflowTypeRegistrationOptions | Workflow registration options +| Name | Default | Java Type | Description + +| accessKey | | String | Amazon AWS Access Key. + +| amazonSWClient | | AmazonSimpleWorkflowClient | To use the given AmazonSimpleWorkflowClient as client + +| dataConverter | | DataConverter | An instance of com.amazonaws.services.simpleworkflow.flow.DataConverter to use for serializing/deserializing the data. + +| domainName | | String | The workflow domain to use. + +| eventName | | String | The workflow or activity event name to use. + +| secretKey | | String | Amazon AWS Secret Key. + +| version | | String | The workflow or activity event version 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. + 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 +| clientConfigurationParameters | | Map | To configure the ClientConfiguration using the key/values from the Map. + +| startWorkflowOptionsParameters | | Map | To configure the StartWorkflowOptions using the key/values from the Map. + +| sWClientParameters | | Map | To configure the AmazonSimpleWorkflowClient using the key/values from the Map. + +| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). + 4+^s| activity +| activityList | | String | The list name to consume activities from. + +| activitySchedulingOptions | | ActivitySchedulingOptions | Activity scheduling options + +| activityThreadPoolSize | 100 | int | Maximum number of threads in work pool for activity. + +| activityTypeExecutionOptions | | ActivityTypeExecutionOptions | Activity execution options + +| activityTypeRegistrationOptions | | ActivityTypeRegistrationOptions | Activity registration options + 4+^s| workflow +| childPolicy | | String | The policy to use on child workflows when terminating a workflow. + +| executionStartToCloseTimeout | 3600 | String | Set the execution start to close timeout. + +| operation | START | String | Workflow operation + +| signalName | | String | The name of the signal to send to the workflow. + +| stateResultType | | String | The type of the result when a workflow state is queried. + +| taskStartToCloseTimeout | 600 | String | Set the task start to close timeout. + +| terminationDetails | | String | Details for terminating a workflow. + +| terminationReason | | String | The reason for terminating a workflow. + +| workflowList | | String | The list name to consume workflows from. + +| workflowTypeRegistrationOptions | | WorkflowTypeRegistrationOptions | Workflow registration options |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-azure/src/main/docs/azure-blob-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-azure/src/main/docs/azure-blob-component.adoc b/components/camel-azure/src/main/docs/azure-blob-component.adoc index 21c2557..4514db4 100644 --- a/components/camel-azure/src/main/docs/azure-blob-component.adoc +++ b/components/camel-azure/src/main/docs/azure-blob-component.adoc @@ -64,28 +64,47 @@ with the following path and query parameters: #### Query Parameters (19 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| azureBlobClient | common | | CloudBlob | The blob service client -| blobOffset | common | 0 | Long | Set the blob offset for the upload or download operations default is 0 -| blobType | common | blockblob | BlobType | Set a blob type 'blockblob' is default -| closeStreamAfterRead | common | true | boolean | Close the stream after read or keep it open default is true -| credentials | common | | StorageCredentials | Set the storage credentials required in most cases -| dataLength | common | | Long | Set the data length for the download or page blob upload operations -| fileDir | common | | String | Set the file directory where the downloaded blobs will be saved to -| publicForRead | common | false | boolean | Storage resources can be public for reading their content if this property is enabled then the credentials do not have to be set -| streamReadSize | common | | int | Set the minimum read size in bytes when reading the blob content -| bridgeErrorHandler | consumer | 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. -| exceptionHandler | consumer (advanced) | | 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 | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. -| blobMetadata | producer | | Map | Set the blob meta-data -| blobPrefix | producer | | String | Set a prefix which can be used for listing the blobs -| closeStreamAfterWrite | producer | true | boolean | Close the stream after write or keep it open default is true -| operation | producer | listBlobs | BlobServiceOperations | Blob service operation hint to the producer -| streamWriteSize | producer | | int | Set the size of the buffer for writing block and page blocks -| useFlatListing | producer | true | boolean | Specify if the flat or hierarchical blob listing should be used -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Default | Java Type | Description + +| azureBlobClient | | CloudBlob | The blob service client + +| blobOffset | 0 | Long | Set the blob offset for the upload or download operations default is 0 + +| blobType | blockblob | BlobType | Set a blob type 'blockblob' is default + +| closeStreamAfterRead | true | boolean | Close the stream after read or keep it open default is true + +| credentials | | StorageCredentials | Set the storage credentials required in most cases + +| dataLength | | Long | Set the data length for the download or page blob upload operations + +| fileDir | | String | Set the file directory where the downloaded blobs will be saved to + +| publicForRead | false | boolean | Storage resources can be public for reading their content if this property is enabled then the credentials do not have to be set + +| streamReadSize | | int | Set the minimum read size in bytes when reading the blob content + 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 +| blobMetadata | | Map | Set the blob meta-data + +| blobPrefix | | String | Set a prefix which can be used for listing the blobs + +| closeStreamAfterWrite | true | boolean | Close the stream after write or keep it open default is true + +| operation | listBlobs | BlobServiceOperations | Blob service operation hint to the producer + +| streamWriteSize | | int | Set the size of the buffer for writing block and page blocks + +| useFlatListing | true | boolean | Specify if the flat or hierarchical blob listing should be used + 4+^s| advanced +| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-azure/src/main/docs/azure-queue-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-azure/src/main/docs/azure-queue-component.adoc b/components/camel-azure/src/main/docs/azure-queue-component.adoc index 341b078..55e273b 100644 --- a/components/camel-azure/src/main/docs/azure-queue-component.adoc +++ b/components/camel-azure/src/main/docs/azure-queue-component.adoc @@ -64,19 +64,29 @@ with the following path and query parameters: #### Query Parameters (10 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| azureQueueClient | common | | CloudQueue | The queue service client -| credentials | common | | StorageCredentials | Set the storage credentials required in most cases -| bridgeErrorHandler | consumer | 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. -| exceptionHandler | consumer (advanced) | | 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 | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. -| messageTimeToLive | producer | | int | Message Time To Live in seconds -| messageVisibilityDelay | producer | | int | Message Visibility Delay in seconds -| operation | producer | listQueues | QueueServiceOperations | Queue service operation hint to the producer -| queuePrefix | producer | | String | Set a prefix which can be used for listing the queues -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Default | Java Type | Description + +| azureQueueClient | | CloudQueue | The queue service client + +| credentials | | StorageCredentials | Set the storage credentials required in most cases + 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 +| messageTimeToLive | | int | Message Time To Live in seconds + +| messageVisibilityDelay | | int | Message Visibility Delay in seconds + +| operation | listQueues | QueueServiceOperations | Queue service operation hint to the producer + +| queuePrefix | | String | Set a prefix which can be used for listing the queues + 4+^s| advanced +| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-bean-validator/src/main/docs/bean-validator-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-bean-validator/src/main/docs/bean-validator-component.adoc b/components/camel-bean-validator/src/main/docs/bean-validator-component.adoc index 68612cf..aa94cca 100644 --- a/components/camel-bean-validator/src/main/docs/bean-validator-component.adoc +++ b/components/camel-bean-validator/src/main/docs/bean-validator-component.adoc @@ -66,15 +66,21 @@ with the following path and query parameters: #### Query Parameters (6 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| constraintValidatorFactory | producer | | ConstraintValidatorFactory | To use a custom ConstraintValidatorFactory -| group | producer | javax.validation.groups.Default | String | To use a custom validation group -| messageInterpolator | producer | | MessageInterpolator | To use a custom MessageInterpolator -| traversableResolver | producer | | TraversableResolver | To use a custom TraversableResolver -| validationProviderResolver | producer | | ValidationProviderResolver | To use a a custom ValidationProviderResolver -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Default | Java Type | Description + +| constraintValidatorFactory | | ConstraintValidatorFactory | To use a custom ConstraintValidatorFactory + +| group | javax.validation.groups.Default | String | To use a custom validation group + +| messageInterpolator | | MessageInterpolator | To use a custom MessageInterpolator + +| traversableResolver | | TraversableResolver | To use a custom TraversableResolver + +| validationProviderResolver | | ValidationProviderResolver | To use a a custom ValidationProviderResolver + 4+^s| advanced +| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-beanstalk/src/main/docs/beanstalk-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-beanstalk/src/main/docs/beanstalk-component.adoc b/components/camel-beanstalk/src/main/docs/beanstalk-component.adoc index 04ebbf2..e252045 100644 --- a/components/camel-beanstalk/src/main/docs/beanstalk-component.adoc +++ b/components/camel-beanstalk/src/main/docs/beanstalk-component.adoc @@ -61,11 +61,13 @@ The Beanstalk component supports 2 options which are listed below. -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| connectionSettingsFactory | common | | ConnectionSettingsFactory | Custom ConnectionSettingsFactory. Specify which ConnectionSettingsFactory to use to make connections to Beanstalkd. Especially useful for unit testing without beanstalkd daemon (you can mock ConnectionSettings) -| resolvePropertyPlaceholders | advanced | 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 | Default | Java Type | Description + 4+^s| common +| connectionSettingsFactory | | ConnectionSettingsFactory | Custom ConnectionSettingsFactory. Specify which ConnectionSettingsFactory to use to make connections to Beanstalkd. Especially useful for unit testing without beanstalkd daemon (you can mock ConnectionSettings) + 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. |======================================================================= // component options: END @@ -89,35 +91,61 @@ with the following path and query parameters: #### Query Parameters (26 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| command | common | | BeanstalkCommand | put means to put the job into Beanstalk. Job body is specified in the Camel message body. Job ID will be returned in beanstalk.jobId message header. delete release touch or bury expect Job ID in the message header beanstalk.jobId. Result of the operation is returned in beanstalk.result message header kick expects the number of jobs to kick in the message body and returns the number of jobs actually kicked out in the message header beanstalk.result. -| jobDelay | common | 0 | int | Job delay in seconds. -| jobPriority | common | 1000 | long | Job priority. (0 is the highest see Beanstalk protocol) -| jobTimeToRun | common | 60 | int | Job time to run in seconds. (when 0 the beanstalkd daemon raises it to 1 automatically see Beanstalk protocol) -| awaitJob | consumer | true | boolean | Whether to wait for job to complete before ack the job from beanstalk -| bridgeErrorHandler | consumer | 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. -| onFailure | consumer | | BeanstalkCommand | Command to use when processing failed. -| sendEmptyMessageWhenIdle | consumer | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. -| useBlockIO | consumer | true | boolean | Whether to use blockIO. -| exceptionHandler | consumer (advanced) | | 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 | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. -| pollStrategy | consumer (advanced) | | 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. -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). -| backoffErrorThreshold | scheduler | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. -| backoffIdleThreshold | scheduler | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. -| backoffMultiplier | scheduler | | 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 | scheduler | 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 | scheduler | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. -| initialDelay | scheduler | 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 | scheduler | 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 | scheduler | | 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 | scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component -| schedulerProperties | scheduler | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. -| startScheduler | scheduler | true | boolean | Whether the scheduler should be auto started. -| timeUnit | scheduler | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options. -| useFixedDelay | scheduler | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. +| Name | Default | Java Type | Description + +| command | | BeanstalkCommand | put means to put the job into Beanstalk. Job body is specified in the Camel message body. Job ID will be returned in beanstalk.jobId message header. delete release touch or bury expect Job ID in the message header beanstalk.jobId. Result of the operation is returned in beanstalk.result message header kick expects the number of jobs to kick in the message body and returns the number of jobs actually kicked out in the message header beanstalk.result. + +| jobDelay | 0 | int | Job delay in seconds. + +| jobPriority | 1000 | long | Job priority. (0 is the highest see Beanstalk protocol) + +| jobTimeToRun | 60 | int | Job time to run in seconds. (when 0 the beanstalkd daemon raises it to 1 automatically see Beanstalk protocol) + 4+^s| consumer +| awaitJob | true | boolean | Whether to wait for job to complete before ack the job from beanstalk + +| 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. + +| onFailure | | BeanstalkCommand | Command to use when processing failed. + +| 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. + +| useBlockIO | true | boolean | Whether to use blockIO. + 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| advanced +| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). + 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. |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-bonita/src/main/docs/bonita-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-bonita/src/main/docs/bonita-component.adoc b/components/camel-bonita/src/main/docs/bonita-component.adoc index bebbca4..8eac646 100644 --- a/components/camel-bonita/src/main/docs/bonita-component.adoc +++ b/components/camel-bonita/src/main/docs/bonita-component.adoc @@ -37,18 +37,27 @@ with the following path and query parameters: #### Query Parameters (9 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| bridgeErrorHandler | consumer | 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. -| hostname | consumer | localhost | String | Hostname where Bonita engine runs -| port | consumer | 8080 | String | Port of the server hosting Bonita engine -| processName | consumer | | String | Name of the process involved in the operation -| exceptionHandler | consumer (advanced) | | 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 | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). -| password | security | | String | Password to authenticate to Bonita engine. -| username | security | | String | Username to authenticate to Bonita engine. +| Name | Default | Java Type | Description + +| 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. + +| hostname | localhost | String | Hostname where Bonita engine runs + +| port | 8080 | String | Port of the server hosting Bonita engine + +| processName | | String | Name of the process involved in the operation + 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). + 4+^s| security +| password | | String | Password to authenticate to Bonita engine. + +| username | | String | Username to authenticate to Bonita engine. |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/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 9b7448d..0cfa410 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,11 +51,13 @@ The Box component supports 2 options which are listed below. -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| configuration | common | | BoxConfiguration | To use the shared configuration -| resolvePropertyPlaceholders | advanced | 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 | 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. |======================================================================= // component options: END @@ -77,29 +79,49 @@ with the following path and query parameters: #### Query Parameters (20 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] -|======================================================================= -| Name | Group | Default | Java Type | Description -| clientId | common | | String | Box application client ID -| enterpriseId | common | | String | The enterprise ID to use for an App Enterprise. -| inBody | common | | String | Sets the name of a parameter to be passed in the exchange In Body -| userId | common | | String | The user ID to use for an App User. -| bridgeErrorHandler | consumer | 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. -| exceptionHandler | consumer (advanced) | | 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 | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. -| httpParams | advanced | | Map | Custom HTTP params for settings like proxy host -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). -| accessTokenCache | security | | IAccessTokenCache | Custom Access Token Cache for storing and retrieving access tokens. -| clientSecret | security | | String | Box application client secret -| encryptionAlgorithm | security | RSA_SHA_256 | EncryptionAlgorithm | The type of encryption algorithm for JWT. Supported Algorithms: RSA_SHA_256 RSA_SHA_384 RSA_SHA_512 -| maxCacheEntries | security | 100 | int | The maximum number of access tokens in cache. -| authenticationType | authentication | 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 -| privateKeyFile | security | | String | The private key for generating the JWT signature. -| privateKeyPassword | security | | String | The password for the private key. -| publicKeyId | security | | String | The ID for public key for validating the JWT signature. -| sslContextParameters | security | | SSLContextParameters | To configure security using SSLContextParameters. -| userName | security | | String | Box user name MUST be provided -| userPassword | security | | String | Box user password MUST be provided if authSecureStorage is not set or returns null on first call +[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 |======================================================================= // endpoint options: END
