http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/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 199329e..f619ce4 100644 --- a/components/camel-aws/src/main/docs/aws-sqs-component.adoc +++ b/components/camel-aws/src/main/docs/aws-sqs-component.adoc @@ -1,4 +1,4 @@ -## AWS Simple Queue Service Component +== AWS Simple Queue Service Component *Available as of Camel version 2.6* @@ -39,69 +39,71 @@ The AWS Simple Queue Service component has no options. // endpoint options: START The AWS Simple Queue Service endpoint is configured using URI syntax: - aws-sqs:queueNameOrArn +---- +aws-sqs:queueNameOrArn +---- 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 -| **queueNameOrArn** | *Required* Queue name or ARN | | String -|======================================================================= +| *queueNameOrArn* | *Required* Queue name or ARN | | String +|=== -#### Query Parameters (45 parameters): +==== Query Parameters (45 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **amazonAWSHost** (common) | The hostname of the Amazon AWS cloud. | amazonaws.com | String -| **amazonSQSClient** (common) | To use the AmazonSQS as client | | AmazonSQS -| **amazonSQSEndpoint** (common) | 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 | | String -| **headerFilterStrategy** (common) | To use a custom HeaderFilterStrategy to map headers to/from Camel. | | HeaderFilterStrategy -| **queueOwnerAWSAccountId** (common) | Specify the queue owner aws account id when you need to connect the queue with different account owner. | | String -| **region** (common) | Specify the queue region which could be used with queueOwnerAWSAccountId to build the service URL. | | String -| **attributeNames** (consumer) | A list of attribute names to receive when consuming. Multiple names can be separated by comma. | | 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 -| **concurrentConsumers** (consumer) | Allows you to use multiple threads to poll the sqs queue to increase throughput | 1 | int -| **defaultVisibilityTimeout** (consumer) | The default visibility timeout (in seconds) | | Integer -| **deleteAfterRead** (consumer) | Delete message from SQS after it has been read | true | boolean -| **deleteIfFiltered** (consumer) | 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. | true | boolean -| **extendMessageVisibility** (consumer) | 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. | false | boolean -| **maxMessagesPerPoll** (consumer) | 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. | | int -| **messageAttributeNames** (consumer) | A list of message attribute names to receive when consuming. Multiple names can be separated by comma. | | 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 -| **visibilityTimeout** (consumer) | 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. | | Integer -| **waitTimeSeconds** (consumer) | 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. | | Integer -| **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 -| **delaySeconds** (producer) | Delay sending messages for a number of seconds. | | Integer -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int -| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int -| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int -| **delay** (scheduler) | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 500 | long -| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean -| **initialDelay** (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long -| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel -| **scheduledExecutorService** (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service -| **scheduler** (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler -| **schedulerProperties** (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map -| **startScheduler** (scheduler) | Whether the scheduler should be auto started. | true | boolean -| **timeUnit** (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit -| **useFixedDelay** (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean -| **proxyHost** (proxy) | To define a proxy host when instantiating the SQS client | | String -| **proxyPort** (proxy) | To define a proxy port when instantiating the SQS client | | Integer -| **maximumMessageSize** (queue) | The maximumMessageSize (in bytes) an SQS message can contain for this queue. | | Integer -| **messageRetentionPeriod** (queue) | The messageRetentionPeriod (in seconds) a message will be retained by SQS for this queue. | | Integer -| **policy** (queue) | The policy for this queue | | String -| **receiveMessageWaitTime Seconds** (queue) | If you do not specify WaitTimeSeconds in the request the queue attribute ReceiveMessageWaitTimeSeconds is used to determine how long to wait. | | Integer -| **redrivePolicy** (queue) | Specify the policy that send message to DeadLetter queue. See detail at Amazon docs. | | String -| **accessKey** (security) | Amazon AWS Access Key | | String -| **secretKey** (security) | Amazon AWS Secret Key | | String -|======================================================================= +| *amazonAWSHost* (common) | The hostname of the Amazon AWS cloud. | amazonaws.com | String +| *amazonSQSClient* (common) | To use the AmazonSQS as client | | AmazonSQS +| *amazonSQSEndpoint* (common) | 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 | | String +| *headerFilterStrategy* (common) | To use a custom HeaderFilterStrategy to map headers to/from Camel. | | HeaderFilterStrategy +| *queueOwnerAWSAccountId* (common) | Specify the queue owner aws account id when you need to connect the queue with different account owner. | | String +| *region* (common) | Specify the queue region which could be used with queueOwnerAWSAccountId to build the service URL. | | String +| *attributeNames* (consumer) | A list of attribute names to receive when consuming. Multiple names can be separated by comma. | | 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 +| *concurrentConsumers* (consumer) | Allows you to use multiple threads to poll the sqs queue to increase throughput | 1 | int +| *defaultVisibilityTimeout* (consumer) | The default visibility timeout (in seconds) | | Integer +| *deleteAfterRead* (consumer) | Delete message from SQS after it has been read | true | boolean +| *deleteIfFiltered* (consumer) | 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. | true | boolean +| *extendMessageVisibility* (consumer) | 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. | false | boolean +| *maxMessagesPerPoll* (consumer) | 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. | | int +| *messageAttributeNames* (consumer) | A list of message attribute names to receive when consuming. Multiple names can be separated by comma. | | 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 +| *visibilityTimeout* (consumer) | 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. | | Integer +| *waitTimeSeconds* (consumer) | 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. | | Integer +| *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 +| *delaySeconds* (producer) | Delay sending messages for a number of seconds. | | Integer +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *backoffErrorThreshold* (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int +| *backoffIdleThreshold* (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int +| *backoffMultiplier* (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int +| *delay* (scheduler) | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 500 | long +| *greedy* (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean +| *initialDelay* (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long +| *runLoggingLevel* (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel +| *scheduledExecutorService* (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service +| *scheduler* (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler +| *schedulerProperties* (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map +| *startScheduler* (scheduler) | Whether the scheduler should be auto started. | true | boolean +| *timeUnit* (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit +| *useFixedDelay* (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean +| *proxyHost* (proxy) | To define a proxy host when instantiating the SQS client | | String +| *proxyPort* (proxy) | To define a proxy port when instantiating the SQS client | | Integer +| *maximumMessageSize* (queue) | The maximumMessageSize (in bytes) an SQS message can contain for this queue. | | Integer +| *messageRetentionPeriod* (queue) | The messageRetentionPeriod (in seconds) a message will be retained by SQS for this queue. | | Integer +| *policy* (queue) | The policy for this queue | | String +| *receiveMessageWaitTime Seconds* (queue) | If you do not specify WaitTimeSeconds in the request the queue attribute ReceiveMessageWaitTimeSeconds is used to determine how long to wait. | | Integer +| *redrivePolicy* (queue) | Specify the policy that send message to DeadLetter queue. See detail at Amazon docs. | | String +| *accessKey* (security) | Amazon AWS Access Key | | String +| *secretKey* (security) | Amazon AWS Secret Key | | String +|=== // endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/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 7caac89..2f81671 100644 --- a/components/camel-aws/src/main/docs/aws-swf-component.adoc +++ b/components/camel-aws/src/main/docs/aws-swf-component.adoc @@ -1,4 +1,4 @@ -## AWS Simple Workflow Component +== AWS Simple Workflow Component *Available as of Camel version 2.13* @@ -34,53 +34,55 @@ The AWS Simple Workflow component has no options. // endpoint options: START The AWS Simple Workflow endpoint is configured using URI syntax: - aws-swf:type +---- +aws-swf:type +---- 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 -| **type** | *Required* Activity or workflow | | String -|======================================================================= +| *type* | *Required* Activity or workflow | | String +|=== -#### Query Parameters (29 parameters): +==== Query Parameters (29 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **accessKey** (common) | Amazon AWS Access Key. | | String -| **amazonSWClient** (common) | To use the given AmazonSimpleWorkflowClient as client | | AmazonSimpleWorkflow Client -| **dataConverter** (common) | An instance of com.amazonaws.services.simpleworkflow.flow.DataConverter to use for serializing/deserializing the data. | | DataConverter -| **domainName** (common) | The workflow domain to use. | | String -| **eventName** (common) | The workflow or activity event name to use. | | String -| **secretKey** (common) | Amazon AWS Secret Key. | | String -| **version** (common) | The workflow or activity event version 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 -| **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 -| **clientConfiguration Parameters** (advanced) | To configure the ClientConfiguration using the key/values from the Map. | | Map -| **startWorkflowOptions Parameters** (advanced) | To configure the StartWorkflowOptions using the key/values from the Map. | | Map -| **sWClientParameters** (advanced) | To configure the AmazonSimpleWorkflowClient using the key/values from the Map. | | Map -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **activityList** (activity) | The list name to consume activities from. | | String -| **activitySchedulingOptions** (activity) | Activity scheduling options | | ActivityScheduling Options -| **activityThreadPoolSize** (activity) | Maximum number of threads in work pool for activity. | 100 | int -| **activityTypeExecution Options** (activity) | Activity execution options | | ActivityTypeExecution Options -| **activityTypeRegistration Options** (activity) | Activity registration options | | ActivityType RegistrationOptions -| **childPolicy** (workflow) | The policy to use on child workflows when terminating a workflow. | | String -| **executionStartToClose Timeout** (workflow) | Set the execution start to close timeout. | 3600 | String -| **operation** (workflow) | Workflow operation | START | String -| **signalName** (workflow) | The name of the signal to send to the workflow. | | String -| **stateResultType** (workflow) | The type of the result when a workflow state is queried. | | String -| **taskStartToCloseTimeout** (workflow) | Set the task start to close timeout. | 600 | String -| **terminationDetails** (workflow) | Details for terminating a workflow. | | String -| **terminationReason** (workflow) | The reason for terminating a workflow. | | String -| **workflowList** (workflow) | The list name to consume workflows from. | | String -| **workflowTypeRegistration Options** (workflow) | Workflow registration options | | WorkflowType RegistrationOptions -|======================================================================= +| *accessKey* (common) | Amazon AWS Access Key. | | String +| *amazonSWClient* (common) | To use the given AmazonSimpleWorkflowClient as client | | AmazonSimpleWorkflow Client +| *dataConverter* (common) | An instance of com.amazonaws.services.simpleworkflow.flow.DataConverter to use for serializing/deserializing the data. | | DataConverter +| *domainName* (common) | The workflow domain to use. | | String +| *eventName* (common) | The workflow or activity event name to use. | | String +| *secretKey* (common) | Amazon AWS Secret Key. | | String +| *version* (common) | The workflow or activity event version 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 +| *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 +| *clientConfiguration Parameters* (advanced) | To configure the ClientConfiguration using the key/values from the Map. | | Map +| *startWorkflowOptions Parameters* (advanced) | To configure the StartWorkflowOptions using the key/values from the Map. | | Map +| *sWClientParameters* (advanced) | To configure the AmazonSimpleWorkflowClient using the key/values from the Map. | | Map +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *activityList* (activity) | The list name to consume activities from. | | String +| *activitySchedulingOptions* (activity) | Activity scheduling options | | ActivityScheduling Options +| *activityThreadPoolSize* (activity) | Maximum number of threads in work pool for activity. | 100 | int +| *activityTypeExecution Options* (activity) | Activity execution options | | ActivityTypeExecution Options +| *activityTypeRegistration Options* (activity) | Activity registration options | | ActivityType RegistrationOptions +| *childPolicy* (workflow) | The policy to use on child workflows when terminating a workflow. | | String +| *executionStartToClose Timeout* (workflow) | Set the execution start to close timeout. | 3600 | String +| *operation* (workflow) | Workflow operation | START | String +| *signalName* (workflow) | The name of the signal to send to the workflow. | | String +| *stateResultType* (workflow) | The type of the result when a workflow state is queried. | | String +| *taskStartToCloseTimeout* (workflow) | Set the task start to close timeout. | 600 | String +| *terminationDetails* (workflow) | Details for terminating a workflow. | | String +| *terminationReason* (workflow) | The reason for terminating a workflow. | | String +| *workflowList* (workflow) | The list name to consume workflows from. | | String +| *workflowTypeRegistration Options* (workflow) | Workflow registration options | | WorkflowType RegistrationOptions +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/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 34aed4b..745b2c1 100644 --- a/components/camel-azure/src/main/docs/azure-blob-component.adoc +++ b/components/camel-azure/src/main/docs/azure-blob-component.adoc @@ -1,4 +1,4 @@ -## Azure Storage Blob Service Component +== Azure Storage Blob Service Component *Available as of Camel version 2.19* @@ -50,43 +50,45 @@ The Azure Storage Blob Service component has no options. // endpoint options: START The Azure Storage Blob Service endpoint is configured using URI syntax: - azure-blob:containerOrBlobUri +---- +azure-blob:containerOrBlobUri +---- 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 -| **containerOrBlobUri** | *Required* Container or Blob compact Uri | | String -|======================================================================= +| *containerOrBlobUri* | *Required* Container or Blob compact Uri | | String +|=== -#### Query Parameters (19 parameters): +==== Query Parameters (19 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **azureBlobClient** (common) | The blob service client | | CloudBlob -| **blobOffset** (common) | Set the blob offset for the upload or download operations default is 0 | 0 | Long -| **blobType** (common) | Set a blob type 'blockblob' is default | blockblob | BlobType -| **closeStreamAfterRead** (common) | Close the stream after read or keep it open default is true | true | boolean -| **credentials** (common) | Set the storage credentials required in most cases | | StorageCredentials -| **dataLength** (common) | Set the data length for the download or page blob upload operations | | Long -| **fileDir** (common) | Set the file directory where the downloaded blobs will be saved to | | String -| **publicForRead** (common) | Storage resources can be public for reading their content if this property is enabled then the credentials do not have to be set | false | boolean -| **streamReadSize** (common) | Set the minimum read size in bytes when reading the blob content | | int -| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean -| **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 -| **blobMetadata** (producer) | Set the blob meta-data | | Map -| **blobPrefix** (producer) | Set a prefix which can be used for listing the blobs | | String -| **closeStreamAfterWrite** (producer) | Close the stream after write or keep it open default is true | true | boolean -| **operation** (producer) | Blob service operation hint to the producer | listBlobs | BlobServiceOperations -| **streamWriteSize** (producer) | Set the size of the buffer for writing block and page blocks | | int -| **useFlatListing** (producer) | Specify if the flat or hierarchical blob listing should be used | true | boolean -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *azureBlobClient* (common) | The blob service client | | CloudBlob +| *blobOffset* (common) | Set the blob offset for the upload or download operations default is 0 | 0 | Long +| *blobType* (common) | Set a blob type 'blockblob' is default | blockblob | BlobType +| *closeStreamAfterRead* (common) | Close the stream after read or keep it open default is true | true | boolean +| *credentials* (common) | Set the storage credentials required in most cases | | StorageCredentials +| *dataLength* (common) | Set the data length for the download or page blob upload operations | | Long +| *fileDir* (common) | Set the file directory where the downloaded blobs will be saved to | | String +| *publicForRead* (common) | Storage resources can be public for reading their content if this property is enabled then the credentials do not have to be set | false | boolean +| *streamReadSize* (common) | Set the minimum read size in bytes when reading the blob content | | int +| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean +| *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 +| *blobMetadata* (producer) | Set the blob meta-data | | Map +| *blobPrefix* (producer) | Set a prefix which can be used for listing the blobs | | String +| *closeStreamAfterWrite* (producer) | Close the stream after write or keep it open default is true | true | boolean +| *operation* (producer) | Blob service operation hint to the producer | listBlobs | BlobServiceOperations +| *streamWriteSize* (producer) | Set the size of the buffer for writing block and page blocks | | int +| *useFlatListing* (producer) | Specify if the flat or hierarchical blob listing should be used | true | 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-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 6390541..ce249a0 100644 --- a/components/camel-azure/src/main/docs/azure-queue-component.adoc +++ b/components/camel-azure/src/main/docs/azure-queue-component.adoc @@ -1,4 +1,4 @@ -## Azure Storage Queue Service Component +== Azure Storage Queue Service Component *Available as of Camel version 2.19* @@ -50,34 +50,36 @@ The Azure Storage Queue Service component has no options. // endpoint options: START The Azure Storage Queue Service endpoint is configured using URI syntax: - azure-queue:containerAndQueueUri +---- +azure-queue:containerAndQueueUri +---- 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 -| **containerAndQueueUri** | *Required* Container Queue compact Uri | | String -|======================================================================= +| *containerAndQueueUri* | *Required* Container Queue compact Uri | | String +|=== -#### Query Parameters (10 parameters): +==== Query Parameters (10 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **azureQueueClient** (common) | The queue service client | | CloudQueue -| **credentials** (common) | Set the storage credentials required in most cases | | StorageCredentials -| **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 -| **messageTimeToLive** (producer) | Message Time To Live in seconds | | int -| **messageVisibilityDelay** (producer) | Message Visibility Delay in seconds | | int -| **operation** (producer) | Queue service operation hint to the producer | listQueues | QueueServiceOperations -| **queuePrefix** (producer) | Set a prefix which can be used for listing the queues | | String -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *azureQueueClient* (common) | The queue service client | | CloudQueue +| *credentials* (common) | Set the storage credentials required in most cases | | StorageCredentials +| *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 +| *messageTimeToLive* (producer) | Message Time To Live in seconds | | int +| *messageVisibilityDelay* (producer) | Message Visibility Delay in seconds | | int +| *operation* (producer) | Queue service operation hint to the producer | listQueues | QueueServiceOperations +| *queuePrefix* (producer) | Set a prefix which can be used for listing the queues | | String +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-barcode/src/main/docs/barcode-dataformat.adoc ---------------------------------------------------------------------- diff --git a/components/camel-barcode/src/main/docs/barcode-dataformat.adoc b/components/camel-barcode/src/main/docs/barcode-dataformat.adoc index a5c8d7a..7aad72d 100644 --- a/components/camel-barcode/src/main/docs/barcode-dataformat.adoc +++ b/components/camel-barcode/src/main/docs/barcode-dataformat.adoc @@ -1,4 +1,4 @@ -## Barcode DataFormat +== Barcode DataFormat *Available as of Camel version 2.14* @@ -34,14 +34,14 @@ The Barcode dataformat supports 5 options which are listed below. [width="100%",cols="2s,1m,1m,6",options="header"] -|======================================================================= +|=== | Name | Default | Java Type | Description | width | | Integer | Width of the barcode | height | | Integer | Height of the barcode | imageType | | String | Image type of the barcode such as png | barcodeFormat | | String | Barcode format such as QR-Code | contentTypeHeader | false | Boolean | Whether the data format should set the Content-Type header with the type from the data format if the data format is capable of doing so. For example application/xml for data formats marshalling to XML or application/json for data formats marshalling to JSon etc. -|======================================================================= +|=== // dataformat options: END ### Using the Java DSL http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-base64/src/main/docs/base64-dataformat.adoc ---------------------------------------------------------------------- diff --git a/components/camel-base64/src/main/docs/base64-dataformat.adoc b/components/camel-base64/src/main/docs/base64-dataformat.adoc index be1cf62..0940da2 100644 --- a/components/camel-base64/src/main/docs/base64-dataformat.adoc +++ b/components/camel-base64/src/main/docs/base64-dataformat.adoc @@ -1,4 +1,4 @@ -## Base64 DataFormat +== Base64 DataFormat *Available as of Camel version 2.11* @@ -13,13 +13,13 @@ The Base64 dataformat supports 4 options which are listed below. [width="100%",cols="2s,1m,1m,6",options="header"] -|======================================================================= +|=== | Name | Default | Java Type | Description | lineLength | 76 | Integer | To specific a maximum line length for the encoded data. By default 76 is used. | lineSeparator | \r\n | String | The line separators to use. By default \r\n is used. | urlSafe | false | Boolean | Instead of emitting '' and '/' we emit '-' and '_' respectively. urlSafe is only applied to encode operations. Decoding seamlessly handles both modes. 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 In Spring DSL, you configure the data format using this tag: http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/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 1e02812..0a2eabc 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 @@ -1,4 +1,4 @@ -## Bean Validator Component +== Bean Validator Component *Available as of Camel version 2.3* @@ -52,30 +52,32 @@ The Bean Validator component has no options. // endpoint options: START The Bean Validator endpoint is configured using URI syntax: - bean-validator:label +---- +bean-validator:label +---- 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 -| **label** | *Required* Where label is an arbitrary text value describing the endpoint | | String -|======================================================================= +| *label* | *Required* Where label is an arbitrary text value describing the endpoint | | String +|=== -#### Query Parameters (6 parameters): +==== Query Parameters (6 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **constraintValidatorFactory** (producer) | To use a custom ConstraintValidatorFactory | | ConstraintValidator Factory -| **group** (producer) | To use a custom validation group | javax.validation.groups.Default | String -| **messageInterpolator** (producer) | To use a custom MessageInterpolator | | MessageInterpolator -| **traversableResolver** (producer) | To use a custom TraversableResolver | | TraversableResolver -| **validationProviderResolver** (producer) | To use a a custom ValidationProviderResolver | | ValidationProvider Resolver -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *constraintValidatorFactory* (producer) | To use a custom ConstraintValidatorFactory | | ConstraintValidator Factory +| *group* (producer) | To use a custom validation group | javax.validation.groups.Default | String +| *messageInterpolator* (producer) | To use a custom MessageInterpolator | | MessageInterpolator +| *traversableResolver* (producer) | To use a custom TraversableResolver | | TraversableResolver +| *validationProviderResolver* (producer) | To use a a custom ValidationProviderResolver | | ValidationProvider Resolver +| *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-beanio/src/main/docs/beanio-dataformat.adoc ---------------------------------------------------------------------- diff --git a/components/camel-beanio/src/main/docs/beanio-dataformat.adoc b/components/camel-beanio/src/main/docs/beanio-dataformat.adoc index fbdcbd0..23320ad 100644 --- a/components/camel-beanio/src/main/docs/beanio-dataformat.adoc +++ b/components/camel-beanio/src/main/docs/beanio-dataformat.adoc @@ -1,4 +1,4 @@ -## BeanIO DataFormat +== BeanIO DataFormat *Available as of Camel version 2.10* @@ -19,7 +19,7 @@ The BeanIO dataformat supports 8 options which are listed below. [width="100%",cols="2s,1m,1m,6",options="header"] -|======================================================================= +|=== | Name | Default | Java Type | Description | mapping | | String | The BeanIO mapping file. Is by default loaded from the classpath. You can prefix with file: http: or classpath: to denote from where to load the mapping file. | streamName | | String | The name of the stream to use. @@ -29,7 +29,7 @@ The BeanIO dataformat supports 8 options which are listed below. | encoding | | String | The charset to use. Is by default the JVM platform default charset. | beanReaderErrorHandlerType | | String | To use a custom org.apache.camel.dataformat.beanio.BeanIOErrorHandler as error handler while parsing. Configure the fully qualified class name of the error handler. Notice the options ignoreUnidentifiedRecords ignoreUnexpectedRecords and ignoreInvalidRecords may not be in use when you use a custom error handler. | 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 ### Usage http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/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 1236823..3b62aae 100644 --- a/components/camel-beanstalk/src/main/docs/beanstalk-component.adoc +++ b/components/camel-beanstalk/src/main/docs/beanstalk-component.adoc @@ -1,4 +1,4 @@ -## Beanstalk Component +== Beanstalk Component *Available as of Camel version 2.15* @@ -62,11 +62,11 @@ The Beanstalk component supports 2 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **connectionSettings Factory** (common) | Custom ConnectionSettingsFactory. Specify which ConnectionSettingsFactory to use to make connections to Beanstalkd. Especially useful for unit testing without beanstalkd daemon (you can mock ConnectionSettings) | | ConnectionSettings Factory -| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean -|======================================================================= +| *connectionSettings Factory* (common) | Custom ConnectionSettingsFactory. Specify which ConnectionSettingsFactory to use to make connections to Beanstalkd. Especially useful for unit testing without beanstalkd daemon (you can mock ConnectionSettings) | | ConnectionSettings Factory +| *resolveProperty Placeholders* (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean +|=== // component options: END @@ -75,50 +75,52 @@ The Beanstalk component supports 2 options which are listed below. // endpoint options: START The Beanstalk endpoint is configured using URI syntax: - beanstalk:connectionSettings +---- +beanstalk:connectionSettings +---- 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 -| **connectionSettings** | Connection settings host:port/tube | | String -|======================================================================= +| *connectionSettings* | Connection settings host:port/tube | | String +|=== -#### Query Parameters (26 parameters): +==== Query Parameters (26 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **command** (common) | 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. | | BeanstalkCommand -| **jobDelay** (common) | Job delay in seconds. | 0 | int -| **jobPriority** (common) | Job priority. (0 is the highest see Beanstalk protocol) | 1000 | long -| **jobTimeToRun** (common) | Job time to run in seconds. (when 0 the beanstalkd daemon raises it to 1 automatically see Beanstalk protocol) | 60 | int -| **awaitJob** (consumer) | Whether to wait for job to complete before ack the job from beanstalk | true | boolean -| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean -| **onFailure** (consumer) | Command to use when processing failed. | | BeanstalkCommand -| **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 -| **useBlockIO** (consumer) | Whether to use blockIO. | 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 -| **pollStrategy** (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int -| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int -| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int -| **delay** (scheduler) | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 500 | long -| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean -| **initialDelay** (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long -| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel -| **scheduledExecutorService** (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service -| **scheduler** (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler -| **schedulerProperties** (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map -| **startScheduler** (scheduler) | Whether the scheduler should be auto started. | true | boolean -| **timeUnit** (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit -| **useFixedDelay** (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean -|======================================================================= +| *command* (common) | 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. | | BeanstalkCommand +| *jobDelay* (common) | Job delay in seconds. | 0 | int +| *jobPriority* (common) | Job priority. (0 is the highest see Beanstalk protocol) | 1000 | long +| *jobTimeToRun* (common) | Job time to run in seconds. (when 0 the beanstalkd daemon raises it to 1 automatically see Beanstalk protocol) | 60 | int +| *awaitJob* (consumer) | Whether to wait for job to complete before ack the job from beanstalk | true | boolean +| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean +| *onFailure* (consumer) | Command to use when processing failed. | | BeanstalkCommand +| *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 +| *useBlockIO* (consumer) | Whether to use blockIO. | 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 +| *pollStrategy* (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *backoffErrorThreshold* (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int +| *backoffIdleThreshold* (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int +| *backoffMultiplier* (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int +| *delay* (scheduler) | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 500 | long +| *greedy* (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean +| *initialDelay* (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long +| *runLoggingLevel* (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel +| *scheduledExecutorService* (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service +| *scheduler* (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler +| *schedulerProperties* (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map +| *startScheduler* (scheduler) | Whether the scheduler should be auto started. | true | boolean +| *timeUnit* (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit +| *useFixedDelay* (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-bindy/src/main/docs/bindy-dataformat.adoc ---------------------------------------------------------------------- diff --git a/components/camel-bindy/src/main/docs/bindy-dataformat.adoc b/components/camel-bindy/src/main/docs/bindy-dataformat.adoc index 1d59e8d..27476ec 100644 --- a/components/camel-bindy/src/main/docs/bindy-dataformat.adoc +++ b/components/camel-bindy/src/main/docs/bindy-dataformat.adoc @@ -1,4 +1,4 @@ -## Bindy DataFormat +== Bindy DataFormat *Available as of Camel version 2.0* @@ -60,13 +60,13 @@ The Bindy dataformat supports 4 options which are listed below. [width="100%",cols="2s,1m,1m,6",options="header"] -|======================================================================= +|=== | Name | Default | Java Type | Description | type | | BindyType | Whether to use csv fixed or key value pairs mode. The default value is either Csv or KeyValue depending on chosen dataformat. | classType | | String | Name of model class to use. | locale | | String | To configure a default locale to use such as us for united states. To use the JVM platform default locale then use the name default | 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-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 65bddca..7d49884 100644 --- a/components/camel-bonita/src/main/docs/bonita-component.adoc +++ b/components/camel-bonita/src/main/docs/bonita-component.adoc @@ -1,4 +1,4 @@ -## Bonita Component +== Bonita Component *Available as of Camel version 2.19* @@ -23,33 +23,35 @@ The Bonita component has no options. // endpoint options: START The Bonita endpoint is configured using URI syntax: - bonita:operation +---- +bonita: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** | *Required* Operation to use | | BonitaOperation -|======================================================================= +| *operation* | *Required* Operation to use | | BonitaOperation +|=== -#### Query Parameters (9 parameters): +==== Query Parameters (9 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean -| **hostname** (consumer) | Hostname where Bonita engine runs | localhost | String -| **port** (consumer) | Port of the server hosting Bonita engine | 8080 | String -| **processName** (consumer) | Name of the process involved in the operation | | String -| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler -| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **password** (security) | Password to authenticate to Bonita engine. | | String -| **username** (security) | Username to authenticate to Bonita engine. | | 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 +| *hostname* (consumer) | Hostname where Bonita engine runs | localhost | String +| *port* (consumer) | Port of the server hosting Bonita engine | 8080 | String +| *processName* (consumer) | Name of the process involved in the operation | | String +| *exceptionHandler* (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler +| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *password* (security) | Password to authenticate to Bonita engine. | | String +| *username* (security) | Username to authenticate to Bonita engine. | | String +|=== // endpoint options: END ### Body content http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-boon/src/main/docs/boon-dataformat.adoc ---------------------------------------------------------------------- diff --git a/components/camel-boon/src/main/docs/boon-dataformat.adoc b/components/camel-boon/src/main/docs/boon-dataformat.adoc index 10fb49a..03a7e81 100644 --- a/components/camel-boon/src/main/docs/boon-dataformat.adoc +++ b/components/camel-boon/src/main/docs/boon-dataformat.adoc @@ -1,4 +1,4 @@ -## Boon DataFormat +== Boon DataFormat *Available as of Camel version 2.16* @@ -21,12 +21,12 @@ The Boon dataformat supports 3 options which are listed below. [width="100%",cols="2s,1m,1m,6",options="header"] -|======================================================================= +|=== | Name | Default | Java Type | Description | unmarshalTypeName | | String | Class name of the java type to use when unarmshalling | useList | false | Boolean | To unarmshal to a List of Map or a List of Pojo. | 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-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 e2a52dc..6df3765 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 @@ -1,4 +1,4 @@ -## Box Component +== Box Component *Available as of Camel version 2.14* @@ -52,55 +52,57 @@ The Box component supports 2 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **configuration** (common) | To use the shared configuration | | BoxConfiguration -| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean -|======================================================================= +| *configuration* (common) | To use the shared configuration | | BoxConfiguration +| *resolveProperty Placeholders* (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean +|=== // component options: END // endpoint options: START The Box endpoint is configured using URI syntax: - box:apiName/methodName +---- +box:apiName/methodName +---- 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 -| **apiName** | *Required* What kind of operation to perform | | BoxApiName -| **methodName** | *Required* What sub operation to use for the selected operation | | String -|======================================================================= +| *apiName* | *Required* What kind of operation to perform | | BoxApiName +| *methodName* | *Required* What sub operation to use for the selected operation | | String +|=== -#### Query Parameters (20 parameters): +==== Query Parameters (20 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **clientId** (common) | Box application client ID | | String -| **enterpriseId** (common) | The enterprise ID to use for an App Enterprise. | | String -| **inBody** (common) | Sets the name of a parameter to be passed in the exchange In Body | | String -| **userId** (common) | The user ID to use for an App User. | | String -| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean -| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler -| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern -| **httpParams** (advanced) | Custom HTTP params for settings like proxy host | | Map -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **accessTokenCache** (security) | Custom Access Token Cache for storing and retrieving access tokens. | | IAccessTokenCache -| **clientSecret** (security) | Box application client secret | | String -| **encryptionAlgorithm** (security) | The type of encryption algorithm for JWT. Supported Algorithms: RSA_SHA_256 RSA_SHA_384 RSA_SHA_512 | RSA_SHA_256 | EncryptionAlgorithm -| **maxCacheEntries** (security) | The maximum number of access tokens in cache. | 100 | int -| **authenticationType** (authentication) | The type of authentication for connection. Types of Authentication: STANDARD_AUTHENTICATION - OAuth 2.0 (3-legged) SERVER_AUTHENTICATION - OAuth 2.0 with JSON Web Tokens | APP_USER_AUTHENTICATION | String -| **privateKeyFile** (security) | The private key for generating the JWT signature. | | String -| **privateKeyPassword** (security) | The password for the private key. | | String -| **publicKeyId** (security) | The ID for public key for validating the JWT signature. | | String -| **sslContextParameters** (security) | To configure security using SSLContextParameters. | | SSLContextParameters -| **userName** (security) | Box user name MUST be provided | | String -| **userPassword** (security) | Box user password MUST be provided if authSecureStorage is not set or returns null on first call | | String -|======================================================================= +| *clientId* (common) | Box application client ID | | String +| *enterpriseId* (common) | The enterprise ID to use for an App Enterprise. | | String +| *inBody* (common) | Sets the name of a parameter to be passed in the exchange In Body | | String +| *userId* (common) | The user ID to use for an App User. | | String +| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean +| *exceptionHandler* (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler +| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| *httpParams* (advanced) | Custom HTTP params for settings like proxy host | | Map +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *accessTokenCache* (security) | Custom Access Token Cache for storing and retrieving access tokens. | | IAccessTokenCache +| *clientSecret* (security) | Box application client secret | | String +| *encryptionAlgorithm* (security) | The type of encryption algorithm for JWT. Supported Algorithms: RSA_SHA_256 RSA_SHA_384 RSA_SHA_512 | RSA_SHA_256 | EncryptionAlgorithm +| *maxCacheEntries* (security) | The maximum number of access tokens in cache. | 100 | int +| *authenticationType* (authentication) | The type of authentication for connection. Types of Authentication: STANDARD_AUTHENTICATION - OAuth 2.0 (3-legged) SERVER_AUTHENTICATION - OAuth 2.0 with JSON Web Tokens | APP_USER_AUTHENTICATION | String +| *privateKeyFile* (security) | The private key for generating the JWT signature. | | String +| *privateKeyPassword* (security) | The password for the private key. | | String +| *publicKeyId* (security) | The ID for public key for validating the JWT signature. | | String +| *sslContextParameters* (security) | To configure security using SSLContextParameters. | | SSLContextParameters +| *userName* (security) | Box user name MUST be provided | | String +| *userPassword* (security) | Box user password MUST be provided if authSecureStorage is not set or returns null on first call | | String +|=== // endpoint options: END ### URI format http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-braintree/src/main/docs/braintree-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-braintree/src/main/docs/braintree-component.adoc b/components/camel-braintree/src/main/docs/braintree-component.adoc index 223c9a2..ab55a9d 100644 --- a/components/camel-braintree/src/main/docs/braintree-component.adoc +++ b/components/camel-braintree/src/main/docs/braintree-component.adoc @@ -1,4 +1,4 @@ -## Braintree Component +== Braintree Component *Available as of Camel version 2.17* @@ -40,11 +40,11 @@ The Braintree component supports 2 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **configuration** (common) | To use the shared configuration | | BraintreeConfiguration -| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean -|======================================================================= +| *configuration* (common) | To use the shared configuration | | BraintreeConfiguration +| *resolveProperty Placeholders* (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean +|=== // component options: END @@ -54,38 +54,40 @@ The Braintree component supports 2 options which are listed below. // endpoint options: START The Braintree endpoint is configured using URI syntax: - braintree:apiName/methodName +---- +braintree:apiName/methodName +---- 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 -| **apiName** | *Required* What kind of operation to perform | | BraintreeApiName -| **methodName** | What sub operation to use for the selected operation | | String -|======================================================================= +| *apiName* | *Required* What kind of operation to perform | | BraintreeApiName +| *methodName* | What sub operation to use for the selected operation | | String +|=== -#### Query Parameters (13 parameters): +==== Query Parameters (13 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **environment** (common) | *Required* The environment Either SANDBOX or PRODUCTION | | String -| **inBody** (common) | Sets the name of a parameter to be passed in the exchange In Body | | String -| **merchantId** (common) | *Required* The merchant id provided by Braintree. | | String -| **privateKey** (common) | *Required* The private key provided by Braintree. | | String -| **publicKey** (common) | *Required* The public key provided by Braintree. | | String -| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean -| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler -| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern -| **httpReadTimeout** (advanced) | Set read timeout for http calls. | | Integer -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **httpLogLevel** (logging) | Set logging level for http calls see java.util.logging.Level | | String -| **proxyHost** (proxy) | The proxy host | | String -| **proxyPort** (proxy) | The proxy port | | Integer -|======================================================================= +| *environment* (common) | *Required* The environment Either SANDBOX or PRODUCTION | | String +| *inBody* (common) | Sets the name of a parameter to be passed in the exchange In Body | | String +| *merchantId* (common) | *Required* The merchant id provided by Braintree. | | String +| *privateKey* (common) | *Required* The private key provided by Braintree. | | String +| *publicKey* (common) | *Required* The public key provided by Braintree. | | String +| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean +| *exceptionHandler* (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler +| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| *httpReadTimeout* (advanced) | Set read timeout for http calls. | | Integer +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *httpLogLevel* (logging) | Set logging level for http calls see java.util.logging.Level | | String +| *proxyHost* (proxy) | The proxy host | | String +| *proxyPort* (proxy) | The proxy port | | Integer +|=== // endpoint options: END
