Chapter 5. Camel Kafka Connector configuration reference

camel.sink.path.streamName

Name of the stream

null

HIGH

camel.sink.endpoint.amazonKinesisClient

Amazon Kinesis client to use for all requests for this endpoint

null

MEDIUM

camel.sink.endpoint.autoDiscoverClient

Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking

true

MEDIUM

camel.sink.endpoint.proxyHost

To define a proxy host when instantiating the Kinesis client

null

MEDIUM

camel.sink.endpoint.proxyPort

To define a proxy port when instantiating the Kinesis client

null

MEDIUM

camel.sink.endpoint.proxyProtocol

To define a proxy protocol when instantiating the Kinesis client One of: [HTTP] [HTTPS]

"HTTPS"

MEDIUM

camel.sink.endpoint.region

The region in which Kinesis Firehose client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You’ll need to use the name Region.EU_WEST_1.id()

null

MEDIUM

camel.sink.endpoint.trustAllCertificates

If we want to trust all certificates in case of overriding the endpoint

false

MEDIUM

camel.sink.endpoint.lazyStartProducer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

MEDIUM

camel.sink.endpoint.basicPropertyBinding

Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

MEDIUM

camel.sink.endpoint.synchronous

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

false

MEDIUM

camel.sink.endpoint.accessKey

Amazon AWS Access Key

null

MEDIUM

camel.sink.endpoint.secretKey

Amazon AWS Secret Key

null

MEDIUM

camel.component.aws2-kinesis.amazonKinesisClient

Amazon Kinesis client to use for all requests for this endpoint

null

MEDIUM

camel.component.aws2-kinesis.autoDiscoverClient

Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking

true

MEDIUM

camel.component.aws2-kinesis.configuration

Component configuration

null

MEDIUM

camel.component.aws2-kinesis.proxyHost

To define a proxy host when instantiating the Kinesis client

null

MEDIUM

camel.component.aws2-kinesis.proxyPort

To define a proxy port when instantiating the Kinesis client

null

MEDIUM

camel.component.aws2-kinesis.proxyProtocol

To define a proxy protocol when instantiating the Kinesis client One of: [HTTP] [HTTPS]

"HTTPS"

MEDIUM

camel.component.aws2-kinesis.region

The region in which Kinesis Firehose client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You’ll need to use the name Region.EU_WEST_1.id()

null

MEDIUM

camel.component.aws2-kinesis.trustAllCertificates

If we want to trust all certificates in case of overriding the endpoint

false

MEDIUM

camel.component.aws2-kinesis.lazyStartProducer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

MEDIUM

camel.component.aws2-kinesis.basicPropertyBinding

Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

MEDIUM

camel.component.aws2-kinesis.accessKey

Amazon AWS Access Key

null

MEDIUM

camel.component.aws2-kinesis.secretKey

Amazon AWS Secret Key

null

MEDIUM

camel.source.path.streamName

Name of the stream

null

HIGH

camel.source.endpoint.amazonKinesisClient

Amazon Kinesis client to use for all requests for this endpoint

null

MEDIUM

camel.source.endpoint.autoDiscoverClient

Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking

true

MEDIUM

camel.source.endpoint.proxyHost

To define a proxy host when instantiating the Kinesis client

null

MEDIUM

camel.source.endpoint.proxyPort

To define a proxy port when instantiating the Kinesis client

null

MEDIUM

camel.source.endpoint.proxyProtocol

To define a proxy protocol when instantiating the Kinesis client One of: [HTTP] [HTTPS]

"HTTPS"

MEDIUM

camel.source.endpoint.region

The region in which Kinesis Firehose client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You’ll need to use the name Region.EU_WEST_1.id()

null

MEDIUM

camel.source.endpoint.trustAllCertificates

If we want to trust all certificates in case of overriding the endpoint

false

MEDIUM

camel.source.endpoint.bridgeErrorHandler

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

MEDIUM

camel.source.endpoint.iteratorType

Defines where in the Kinesis stream to start getting records One of: [AT_SEQUENCE_NUMBER] [AFTER_SEQUENCE_NUMBER] [TRIM_HORIZON] [LATEST] [AT_TIMESTAMP] [null]

"TRIM_HORIZON"

MEDIUM

camel.source.endpoint.maxResultsPerRequest

Maximum number of records that will be fetched in each poll

1

MEDIUM

camel.source.endpoint.sendEmptyMessageWhenIdle

If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.

false

MEDIUM

camel.source.endpoint.sequenceNumber

The sequence number to start polling from. Required if iteratorType is set to AFTER_SEQUENCE_NUMBER or AT_SEQUENCE_NUMBER

null

MEDIUM

camel.source.endpoint.shardClosed

Define what will be the behavior in case of shard closed. Possible value are ignore, silent and fail. In case of ignore a message will be logged and the consumer will restart from the beginning,in case of silent there will be no logging and the consumer will start from the beginning,in case of fail a ReachedClosedStateException will be raised One of: [ignore] [fail] [silent]

"ignore"

MEDIUM

camel.source.endpoint.shardId

Defines which shardId in the Kinesis stream to get records from

null

MEDIUM

camel.source.endpoint.exceptionHandler

To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored.

null

MEDIUM

camel.source.endpoint.exchangePattern

Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut]

null

MEDIUM

camel.source.endpoint.pollStrategy

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.

null

MEDIUM

camel.source.endpoint.basicPropertyBinding

Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

MEDIUM

camel.source.endpoint.synchronous

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

false

MEDIUM

camel.source.endpoint.backoffErrorThreshold

The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.

null

MEDIUM

camel.source.endpoint.backoffIdleThreshold

The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.

null

MEDIUM

camel.source.endpoint.backoffMultiplier

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.

null

MEDIUM

camel.source.endpoint.delay

Milliseconds before the next poll.

500L

MEDIUM

camel.source.endpoint.greedy

If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.

false

MEDIUM

camel.source.endpoint.initialDelay

Milliseconds before the first poll starts.

1000L

MEDIUM

camel.source.endpoint.repeatCount

Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever.

0L

MEDIUM

camel.source.endpoint.runLoggingLevel

The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. One of: [TRACE] [DEBUG] [INFO] [WARN] [ERROR] [OFF]

"TRACE"

MEDIUM

camel.source.endpoint.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.

null

MEDIUM

camel.source.endpoint.scheduler

To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler

"none"

MEDIUM

camel.source.endpoint.schedulerProperties

To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.

null

MEDIUM

camel.source.endpoint.startScheduler

Whether the scheduler should be auto started.

true

MEDIUM

camel.source.endpoint.timeUnit

Time unit for initialDelay and delay options. One of: [NANOSECONDS] [MICROSECONDS] [MILLISECONDS] [SECONDS] [MINUTES] [HOURS] [DAYS]

"MILLISECONDS"

MEDIUM

camel.source.endpoint.useFixedDelay

Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.

true

MEDIUM

camel.source.endpoint.accessKey

Amazon AWS Access Key

null

MEDIUM

camel.source.endpoint.secretKey

Amazon AWS Secret Key

null

MEDIUM

camel.component.aws2-kinesis.amazonKinesisClient

Amazon Kinesis client to use for all requests for this endpoint

null

MEDIUM

camel.component.aws2-kinesis.autoDiscoverClient

Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking

true

MEDIUM

camel.component.aws2-kinesis.configuration

Component configuration

null

MEDIUM

camel.component.aws2-kinesis.proxyHost

To define a proxy host when instantiating the Kinesis client

null

MEDIUM

camel.component.aws2-kinesis.proxyPort

To define a proxy port when instantiating the Kinesis client

null

MEDIUM

camel.component.aws2-kinesis.proxyProtocol

To define a proxy protocol when instantiating the Kinesis client One of: [HTTP] [HTTPS]

"HTTPS"

MEDIUM

camel.component.aws2-kinesis.region

The region in which Kinesis Firehose client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You’ll need to use the name Region.EU_WEST_1.id()

null

MEDIUM

camel.component.aws2-kinesis.trustAllCertificates

If we want to trust all certificates in case of overriding the endpoint

false

MEDIUM

camel.component.aws2-kinesis.bridgeErrorHandler

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

MEDIUM

camel.component.aws2-kinesis.iteratorType

Defines where in the Kinesis stream to start getting records One of: [AT_SEQUENCE_NUMBER] [AFTER_SEQUENCE_NUMBER] [TRIM_HORIZON] [LATEST] [AT_TIMESTAMP] [null]

"TRIM_HORIZON"

MEDIUM

camel.component.aws2-kinesis.maxResultsPerRequest

Maximum number of records that will be fetched in each poll

1

MEDIUM

camel.component.aws2-kinesis.sequenceNumber

The sequence number to start polling from. Required if iteratorType is set to AFTER_SEQUENCE_NUMBER or AT_SEQUENCE_NUMBER

null

MEDIUM

camel.component.aws2-kinesis.shardClosed

Define what will be the behavior in case of shard closed. Possible value are ignore, silent and fail. In case of ignore a message will be logged and the consumer will restart from the beginning,in case of silent there will be no logging and the consumer will start from the beginning,in case of fail a ReachedClosedStateException will be raised One of: [ignore] [fail] [silent]

"ignore"

MEDIUM

camel.component.aws2-kinesis.shardId

Defines which shardId in the Kinesis stream to get records from

null

MEDIUM

camel.component.aws2-kinesis.basicPropertyBinding

Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

MEDIUM

camel.component.aws2-kinesis.accessKey

Amazon AWS Access Key

null

MEDIUM

camel.component.aws2-kinesis.secretKey

Amazon AWS Secret Key

null

MEDIUM

camel.sink.path.bucketNameOrArn

Bucket name or ARN

null

HIGH

camel.sink.endpoint.amazonS3Client

Reference to a com.amazonaws.services.s3.AmazonS3 in the registry.

null

MEDIUM

camel.sink.endpoint.autoCreateBucket

Setting the autocreation of the S3 bucket bucketName. This will apply also in case of moveAfterRead option enabled and it will create the destinationBucket if it doesn’t exist already.

true

MEDIUM

camel.sink.endpoint.autoDiscoverClient

Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking.

true

MEDIUM

camel.sink.endpoint.overrideEndpoint

Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option

false

MEDIUM

camel.sink.endpoint.pojoRequest

If we want to use a POJO request as body or not

false

MEDIUM

camel.sink.endpoint.policy

The policy for this queue to set in the com.amazonaws.services.s3.AmazonS3#setBucketPolicy() method.

null

MEDIUM

camel.sink.endpoint.proxyHost

To define a proxy host when instantiating the SQS client

null

MEDIUM

camel.sink.endpoint.proxyPort

Specify a proxy port to be used inside the client definition.

null

MEDIUM

camel.sink.endpoint.proxyProtocol

To define a proxy protocol when instantiating the S3 client One of: [HTTP] [HTTPS]

"HTTPS"

MEDIUM

camel.sink.endpoint.region

The region in which S3 client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You’ll need to use the name Region.EU_WEST_1.id()

null

MEDIUM

camel.sink.endpoint.trustAllCertificates

If we want to trust all certificates in case of overriding the endpoint

false

MEDIUM

camel.sink.endpoint.uriEndpointOverride

Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option

null

MEDIUM

camel.sink.endpoint.useIAMCredentials

Set whether the S3 client should expect to load credentials on an EC2 instance or to expect static credentials to be passed in.

false

MEDIUM

camel.sink.endpoint.customerAlgorithm

Define the customer algorithm to use in case CustomerKey is enabled

null

MEDIUM

camel.sink.endpoint.customerKeyId

Define the id of Customer key to use in case CustomerKey is enabled

null

MEDIUM

camel.sink.endpoint.customerKeyMD5

Define the MD5 of Customer key to use in case CustomerKey is enabled

null

MEDIUM

camel.sink.endpoint.deleteAfterWrite

Delete file object after the S3 file has been uploaded

false

MEDIUM

camel.sink.endpoint.keyName

Setting the key name for an element in the bucket through endpoint parameter

null

MEDIUM

camel.sink.endpoint.lazyStartProducer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

MEDIUM

camel.sink.endpoint.multiPartUpload

If it is true, camel will upload the file with multi part format, the part size is decided by the option of partSize

false

MEDIUM

camel.sink.endpoint.operation

The operation to do in case the user don’t want to do only an upload One of: [copyObject] [listObjects] [deleteObject] [deleteBucket] [listBuckets] [getObject] [getObjectRange]

null

MEDIUM

camel.sink.endpoint.partSize

Setup the partSize which is used in multi part upload, the default size is 25M.

26214400L

MEDIUM

camel.sink.endpoint.storageClass

The storage class to set in the com.amazonaws.services.s3.model.PutObjectRequest request.

null

MEDIUM

camel.sink.endpoint.awsKMSKeyId

Define the id of KMS key to use in case KMS is enabled

null

MEDIUM

camel.sink.endpoint.useAwsKMS

Define if KMS must be used or not

false

MEDIUM

camel.sink.endpoint.useCustomerKey

Define if Customer Key must be used or not

false

MEDIUM

camel.sink.endpoint.basicPropertyBinding

Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

MEDIUM

camel.sink.endpoint.synchronous

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

false

MEDIUM

camel.sink.endpoint.accessKey

Amazon AWS Access Key

null

MEDIUM

camel.sink.endpoint.secretKey

Amazon AWS Secret Key

null

MEDIUM

camel.component.aws2-s3.amazonS3Client

Reference to a com.amazonaws.services.s3.AmazonS3 in the registry.

null

MEDIUM

camel.component.aws2-s3.autoCreateBucket

Setting the autocreation of the S3 bucket bucketName. This will apply also in case of moveAfterRead option enabled and it will create the destinationBucket if it doesn’t exist already.

true

MEDIUM

camel.component.aws2-s3.autoDiscoverClient

Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking.

true

MEDIUM

camel.component.aws2-s3.configuration

The component configuration

null

MEDIUM

camel.component.aws2-s3.overrideEndpoint

Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option

false

MEDIUM

camel.component.aws2-s3.pojoRequest

If we want to use a POJO request as body or not

false

MEDIUM

camel.component.aws2-s3.policy

The policy for this queue to set in the com.amazonaws.services.s3.AmazonS3#setBucketPolicy() method.

null

MEDIUM

camel.component.aws2-s3.proxyHost

To define a proxy host when instantiating the SQS client

null

MEDIUM

camel.component.aws2-s3.proxyPort

Specify a proxy port to be used inside the client definition.

null

MEDIUM

camel.component.aws2-s3.proxyProtocol

To define a proxy protocol when instantiating the S3 client One of: [HTTP] [HTTPS]

"HTTPS"

MEDIUM

camel.component.aws2-s3.region

The region in which S3 client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You’ll need to use the name Region.EU_WEST_1.id()

null

MEDIUM

camel.component.aws2-s3.trustAllCertificates

If we want to trust all certificates in case of overriding the endpoint

false

MEDIUM

camel.component.aws2-s3.uriEndpointOverride

Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option

null

MEDIUM

camel.component.aws2-s3.useIAMCredentials

Set whether the S3 client should expect to load credentials on an EC2 instance or to expect static credentials to be passed in.

false

MEDIUM

camel.component.aws2-s3.customerAlgorithm

Define the customer algorithm to use in case CustomerKey is enabled

null

MEDIUM

camel.component.aws2-s3.customerKeyId

Define the id of Customer key to use in case CustomerKey is enabled

null

MEDIUM

camel.component.aws2-s3.customerKeyMD5

Define the MD5 of Customer key to use in case CustomerKey is enabled

null

MEDIUM

camel.component.aws2-s3.deleteAfterWrite

Delete file object after the S3 file has been uploaded

false

MEDIUM

camel.component.aws2-s3.keyName

Setting the key name for an element in the bucket through endpoint parameter

null

MEDIUM

camel.component.aws2-s3.lazyStartProducer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

MEDIUM

camel.component.aws2-s3.multiPartUpload

If it is true, camel will upload the file with multi part format, the part size is decided by the option of partSize

false

MEDIUM

camel.component.aws2-s3.operation

The operation to do in case the user don’t want to do only an upload One of: [copyObject] [listObjects] [deleteObject] [deleteBucket] [listBuckets] [getObject] [getObjectRange]

null

MEDIUM

camel.component.aws2-s3.partSize

Setup the partSize which is used in multi part upload, the default size is 25M.

26214400L

MEDIUM

camel.component.aws2-s3.storageClass

The storage class to set in the com.amazonaws.services.s3.model.PutObjectRequest request.

null

MEDIUM

camel.component.aws2-s3.awsKMSKeyId

Define the id of KMS key to use in case KMS is enabled

null

MEDIUM

camel.component.aws2-s3.useAwsKMS

Define if KMS must be used or not

false

MEDIUM

camel.component.aws2-s3.useCustomerKey

Define if Customer Key must be used or not

false

MEDIUM

camel.component.aws2-s3.basicPropertyBinding

Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

MEDIUM

camel.component.aws2-s3.accessKey

Amazon AWS Access Key

null

MEDIUM

camel.component.aws2-s3.secretKey

Amazon AWS Secret Key

null

MEDIUM

camel.source.path.bucketNameOrArn

Bucket name or ARN

null

HIGH

camel.source.endpoint.amazonS3Client

Reference to a com.amazonaws.services.s3.AmazonS3 in the registry.

null

MEDIUM

camel.source.endpoint.autoCreateBucket

Setting the autocreation of the S3 bucket bucketName. This will apply also in case of moveAfterRead option enabled and it will create the destinationBucket if it doesn’t exist already.

true

MEDIUM

camel.source.endpoint.autoDiscoverClient

Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking.

true

MEDIUM

camel.source.endpoint.overrideEndpoint

Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option

false

MEDIUM

camel.source.endpoint.pojoRequest

If we want to use a POJO request as body or not

false

MEDIUM

camel.source.endpoint.policy

The policy for this queue to set in the com.amazonaws.services.s3.AmazonS3#setBucketPolicy() method.

null

MEDIUM

camel.source.endpoint.proxyHost

To define a proxy host when instantiating the SQS client

null

MEDIUM

camel.source.endpoint.proxyPort

Specify a proxy port to be used inside the client definition.

null

MEDIUM

camel.source.endpoint.proxyProtocol

To define a proxy protocol when instantiating the S3 client One of: [HTTP] [HTTPS]

"HTTPS"

MEDIUM

camel.source.endpoint.region

The region in which S3 client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You’ll need to use the name Region.EU_WEST_1.id()

null

MEDIUM

camel.source.endpoint.trustAllCertificates

If we want to trust all certificates in case of overriding the endpoint

false

MEDIUM

camel.source.endpoint.uriEndpointOverride

Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option

null

MEDIUM

camel.source.endpoint.useIAMCredentials

Set whether the S3 client should expect to load credentials on an EC2 instance or to expect static credentials to be passed in.

false

MEDIUM

camel.source.endpoint.customerAlgorithm

Define the customer algorithm to use in case CustomerKey is enabled

null

MEDIUM

camel.source.endpoint.customerKeyId

Define the id of Customer key to use in case CustomerKey is enabled

null

MEDIUM

camel.source.endpoint.customerKeyMD5

Define the MD5 of Customer key to use in case CustomerKey is enabled

null

MEDIUM

camel.source.endpoint.bridgeErrorHandler

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

MEDIUM

camel.source.endpoint.deleteAfterRead

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 AWS2S3Constants#BUCKET_NAME and AWS2S3Constants#KEY headers, or only the AWS2S3Constants#KEY header.

true

MEDIUM

camel.source.endpoint.delimiter

The delimiter which is used in the com.amazonaws.services.s3.model.ListObjectsRequest to only consume objects we are interested in.

null

MEDIUM

camel.source.endpoint.destinationBucket

Define the destination bucket where an object must be moved when moveAfterRead is set to true.

null

MEDIUM

camel.source.endpoint.destinationBucketPrefix

Define the destination bucket prefix to use when an object must be moved and moveAfterRead is set to true.

null

MEDIUM

camel.source.endpoint.destinationBucketSuffix

Define the destination bucket suffix to use when an object must be moved and moveAfterRead is set to true.

null

MEDIUM

camel.source.endpoint.fileName

To get the object from the bucket with the given file name

null

MEDIUM

camel.source.endpoint.includeBody

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.

true

MEDIUM

camel.source.endpoint.includeFolders

If it is true, the folders/directories will be consumed. If it is false, they will be ignored, and Exchanges will not be created for those

true

MEDIUM

camel.source.endpoint.maxConnections

Set the maxConnections parameter in the S3 client configuration

60

MEDIUM

camel.source.endpoint.maxMessagesPerPoll

Gets the maximum number of messages as a limit to poll at each polling. Gets the maximum number of messages as a limit to poll at each polling. The default value is 10. Use 0 or a negative number to set it as unlimited.

10

MEDIUM

camel.source.endpoint.moveAfterRead

Move objects from S3 bucket to a different bucket after they have been retrieved. To accomplish the operation the destinationBucket option must be set. The copy bucket operation is only performed if the Exchange is committed. If a rollback occurs, the object is not moved.

false

MEDIUM

camel.source.endpoint.prefix

The prefix which is used in the com.amazonaws.services.s3.model.ListObjectsRequest to only consume objects we are interested in.

null

MEDIUM

camel.source.endpoint.sendEmptyMessageWhenIdle

If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.

false

MEDIUM

camel.source.endpoint.autocloseBody

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.

true

MEDIUM

camel.source.endpoint.exceptionHandler

To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored.

null

MEDIUM

camel.source.endpoint.exchangePattern

Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut]

null

MEDIUM

camel.source.endpoint.pollStrategy

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.

null

MEDIUM

camel.source.endpoint.basicPropertyBinding

Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

MEDIUM

camel.source.endpoint.synchronous

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

false

MEDIUM

camel.source.endpoint.backoffErrorThreshold

The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.

null

MEDIUM

camel.source.endpoint.backoffIdleThreshold

The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.

null

MEDIUM

camel.source.endpoint.backoffMultiplier

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.

null

MEDIUM

camel.source.endpoint.delay

Milliseconds before the next poll.

500L

MEDIUM

camel.source.endpoint.greedy

If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.

false

MEDIUM

camel.source.endpoint.initialDelay

Milliseconds before the first poll starts.

1000L

MEDIUM

camel.source.endpoint.repeatCount

Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever.

0L

MEDIUM

camel.source.endpoint.runLoggingLevel

The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. One of: [TRACE] [DEBUG] [INFO] [WARN] [ERROR] [OFF]

"TRACE"

MEDIUM

camel.source.endpoint.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.

null

MEDIUM

camel.source.endpoint.scheduler

To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler

"none"

MEDIUM

camel.source.endpoint.schedulerProperties

To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.

null

MEDIUM

camel.source.endpoint.startScheduler

Whether the scheduler should be auto started.

true

MEDIUM

camel.source.endpoint.timeUnit

Time unit for initialDelay and delay options. One of: [NANOSECONDS] [MICROSECONDS] [MILLISECONDS] [SECONDS] [MINUTES] [HOURS] [DAYS]

"MILLISECONDS"

MEDIUM

camel.source.endpoint.useFixedDelay

Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.

true

MEDIUM

camel.source.endpoint.accessKey

Amazon AWS Access Key

null

MEDIUM

camel.source.endpoint.secretKey

Amazon AWS Secret Key

null

MEDIUM

camel.component.aws2-s3.amazonS3Client

Reference to a com.amazonaws.services.s3.AmazonS3 in the registry.

null

MEDIUM

camel.component.aws2-s3.autoCreateBucket

Setting the autocreation of the S3 bucket bucketName. This will apply also in case of moveAfterRead option enabled and it will create the destinationBucket if it doesn’t exist already.

true

MEDIUM

camel.component.aws2-s3.autoDiscoverClient

Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking.

true

MEDIUM

camel.component.aws2-s3.configuration

The component configuration

null

MEDIUM

camel.component.aws2-s3.overrideEndpoint

Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option

false

MEDIUM

camel.component.aws2-s3.pojoRequest

If we want to use a POJO request as body or not

false

MEDIUM

camel.component.aws2-s3.policy

The policy for this queue to set in the com.amazonaws.services.s3.AmazonS3#setBucketPolicy() method.

null

MEDIUM

camel.component.aws2-s3.proxyHost

To define a proxy host when instantiating the SQS client

null

MEDIUM

camel.component.aws2-s3.proxyPort

Specify a proxy port to be used inside the client definition.

null

MEDIUM

camel.component.aws2-s3.proxyProtocol

To define a proxy protocol when instantiating the S3 client One of: [HTTP] [HTTPS]

"HTTPS"

MEDIUM

camel.component.aws2-s3.region

The region in which S3 client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You’ll need to use the name Region.EU_WEST_1.id()

null

MEDIUM

camel.component.aws2-s3.trustAllCertificates

If we want to trust all certificates in case of overriding the endpoint

false

MEDIUM

camel.component.aws2-s3.uriEndpointOverride

Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option

null

MEDIUM

camel.component.aws2-s3.useIAMCredentials

Set whether the S3 client should expect to load credentials on an EC2 instance or to expect static credentials to be passed in.

false

MEDIUM

camel.component.aws2-s3.customerAlgorithm

Define the customer algorithm to use in case CustomerKey is enabled

null

MEDIUM

camel.component.aws2-s3.customerKeyId

Define the id of Customer key to use in case CustomerKey is enabled

null

MEDIUM

camel.component.aws2-s3.customerKeyMD5

Define the MD5 of Customer key to use in case CustomerKey is enabled

null

MEDIUM

camel.component.aws2-s3.bridgeErrorHandler

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

MEDIUM

camel.component.aws2-s3.deleteAfterRead

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 AWS2S3Constants#BUCKET_NAME and AWS2S3Constants#KEY headers, or only the AWS2S3Constants#KEY header.

true

MEDIUM

camel.component.aws2-s3.delimiter

The delimiter which is used in the com.amazonaws.services.s3.model.ListObjectsRequest to only consume objects we are interested in.

null

MEDIUM

camel.component.aws2-s3.destinationBucket

Define the destination bucket where an object must be moved when moveAfterRead is set to true.

null

MEDIUM

camel.component.aws2-s3.destinationBucketPrefix

Define the destination bucket prefix to use when an object must be moved and moveAfterRead is set to true.

null

MEDIUM

camel.component.aws2-s3.destinationBucketSuffix

Define the destination bucket suffix to use when an object must be moved and moveAfterRead is set to true.

null

MEDIUM

camel.component.aws2-s3.fileName

To get the object from the bucket with the given file name

null

MEDIUM

camel.component.aws2-s3.includeBody

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.

true

MEDIUM

camel.component.aws2-s3.includeFolders

If it is true, the folders/directories will be consumed. If it is false, they will be ignored, and Exchanges will not be created for those

true

MEDIUM

camel.component.aws2-s3.moveAfterRead

Move objects from S3 bucket to a different bucket after they have been retrieved. To accomplish the operation the destinationBucket option must be set. The copy bucket operation is only performed if the Exchange is committed. If a rollback occurs, the object is not moved.

false

MEDIUM

camel.component.aws2-s3.prefix

The prefix which is used in the com.amazonaws.services.s3.model.ListObjectsRequest to only consume objects we are interested in.

null

MEDIUM

camel.component.aws2-s3.autocloseBody

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.

true

MEDIUM

camel.component.aws2-s3.basicPropertyBinding

Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

MEDIUM

camel.component.aws2-s3.accessKey

Amazon AWS Access Key

null

MEDIUM

camel.component.aws2-s3.secretKey

Amazon AWS Secret Key

null

MEDIUM

camel.sink.path.topicNameOrArn

Topic name or ARN

null

HIGH

camel.sink.endpoint.amazonSNSClient

To use the AmazonSNS as the client

null

MEDIUM

camel.sink.endpoint.autoCreateTopic

Setting the autocreation of the topic

true

MEDIUM

camel.sink.endpoint.autoDiscoverClient

Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking.

true

MEDIUM

camel.sink.endpoint.headerFilterStrategy

To use a custom HeaderFilterStrategy to map headers to/from Camel.

null

MEDIUM

camel.sink.endpoint.kmsMasterKeyId

The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK.

null

MEDIUM

camel.sink.endpoint.lazyStartProducer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

MEDIUM

camel.sink.endpoint.messageStructure

The message structure to use such as json

null

MEDIUM

camel.sink.endpoint.policy

The policy for this queue

null

MEDIUM

camel.sink.endpoint.proxyHost

To define a proxy host when instantiating the SNS client

null

MEDIUM

camel.sink.endpoint.proxyPort

To define a proxy port when instantiating the SNS client

null

MEDIUM

camel.sink.endpoint.proxyProtocol

To define a proxy protocol when instantiating the SNS client One of: [HTTP] [HTTPS]

"HTTPS"

MEDIUM

camel.sink.endpoint.queueUrl

The queueUrl to subscribe to

null

MEDIUM

camel.sink.endpoint.region

The region in which SNS client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You’ll need to use the name Region.EU_WEST_1.id()

null

MEDIUM

camel.sink.endpoint.serverSideEncryptionEnabled

Define if Server Side Encryption is enabled or not on the topic

false

MEDIUM

camel.sink.endpoint.subject

The subject which is used if the message header 'CamelAwsSnsSubject' is not present.

null

MEDIUM

camel.sink.endpoint.subscribeSNStoSQS

Define if the subscription between SNS Topic and SQS must be done or not

false

MEDIUM

camel.sink.endpoint.trustAllCertificates

If we want to trust all certificates in case of overriding the endpoint

false

MEDIUM

camel.sink.endpoint.basicPropertyBinding

Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

MEDIUM

camel.sink.endpoint.synchronous

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

false

MEDIUM

camel.sink.endpoint.accessKey

Amazon AWS Access Key

null

MEDIUM

camel.sink.endpoint.secretKey

Amazon AWS Secret Key

null

MEDIUM

camel.component.aws2-sns.amazonSNSClient

To use the AmazonSNS as the client

null

MEDIUM

camel.component.aws2-sns.autoCreateTopic

Setting the autocreation of the topic

true

MEDIUM

camel.component.aws2-sns.autoDiscoverClient

Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking.

true

MEDIUM

camel.component.aws2-sns.configuration

Component configuration

null

MEDIUM

camel.component.aws2-sns.kmsMasterKeyId

The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK.

null

MEDIUM

camel.component.aws2-sns.lazyStartProducer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

MEDIUM

camel.component.aws2-sns.messageStructure

The message structure to use such as json

null

MEDIUM

camel.component.aws2-sns.policy

The policy for this queue

null

MEDIUM

camel.component.aws2-sns.proxyHost

To define a proxy host when instantiating the SNS client

null

MEDIUM

camel.component.aws2-sns.proxyPort

To define a proxy port when instantiating the SNS client

null

MEDIUM

camel.component.aws2-sns.proxyProtocol

To define a proxy protocol when instantiating the SNS client One of: [HTTP] [HTTPS]

"HTTPS"

MEDIUM

camel.component.aws2-sns.queueUrl

The queueUrl to subscribe to

null

MEDIUM

camel.component.aws2-sns.region

The region in which SNS client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You’ll need to use the name Region.EU_WEST_1.id()

null

MEDIUM

camel.component.aws2-sns.serverSideEncryption Enabled

Define if Server Side Encryption is enabled or not on the topic

false

MEDIUM

camel.component.aws2-sns.subject

The subject which is used if the message header 'CamelAwsSnsSubject' is not present.

null

MEDIUM

camel.component.aws2-sns.subscribeSNStoSQS

Define if the subscription between SNS Topic and SQS must be done or not

false

MEDIUM

camel.component.aws2-sns.trustAllCertificates

If we want to trust all certificates in case of overriding the endpoint

false

MEDIUM

camel.component.aws2-sns.basicPropertyBinding

Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

MEDIUM

camel.component.aws2-sns.accessKey

Amazon AWS Access Key

null

MEDIUM

camel.component.aws2-sns.secretKey

Amazon AWS Secret Key

null

MEDIUM

camel.sink.path.queueNameOrArn

Queue name or ARN

null

HIGH

camel.sink.endpoint.amazonAWSHost

The hostname of the Amazon AWS cloud.

"amazonaws.com"

MEDIUM

camel.sink.endpoint.amazonSQSClient

To use the AmazonSQS as client

null

MEDIUM

camel.sink.endpoint.autoCreateQueue

Setting the autocreation of the queue

true

MEDIUM

camel.sink.endpoint.autoDiscoverClient

Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking.

true

MEDIUM

camel.sink.endpoint.headerFilterStrategy

To use a custom HeaderFilterStrategy to map headers to/from Camel.

null

MEDIUM

camel.sink.endpoint.protocol

The underlying protocol used to communicate with SQS

"https"

MEDIUM

camel.sink.endpoint.proxyProtocol

To define a proxy protocol when instantiating the SQS client One of: [HTTP] [HTTPS]

"HTTPS"

MEDIUM

camel.sink.endpoint.queueOwnerAWSAccountId

Specify the queue owner aws account id when you need to connect the queue with different account owner.

null

MEDIUM

camel.sink.endpoint.region

The region in which SQS client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You’ll need to use the name Region.EU_WEST_1.id()

null

MEDIUM

camel.sink.endpoint.trustAllCertificates

If we want to trust all certificates in case of overriding the endpoint

false

MEDIUM

camel.sink.endpoint.delaySeconds

Delay sending messages for a number of seconds.

null

MEDIUM

camel.sink.endpoint.lazyStartProducer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

MEDIUM

camel.sink.endpoint.messageDeduplicationIdStrategy

Only for FIFO queues. Strategy for setting the messageDeduplicationId on the message. Can be one of the following options: useExchangeId, useContentBasedDeduplication. For the useContentBasedDeduplication option, no messageDeduplicationId will be set on the message. One of: [useExchangeId] [useContentBasedDeduplication]

"useExchangeId"

MEDIUM

camel.sink.endpoint.messageGroupIdStrategy

Only for FIFO queues. Strategy for setting the messageGroupId on the message. Can be one of the following options: useConstant, useExchangeId, usePropertyValue. For the usePropertyValue option, the value of property CamelAwsMessageGroupId will be used. One of: [useConstant] [useExchangeId] [usePropertyValue]

null

MEDIUM

camel.sink.endpoint.operation

The operation to do in case the user don’t want to send only a message One of: [sendBatchMessage] [deleteMessage] [listQueues] [purgeQueue]

null

MEDIUM

camel.sink.endpoint.basicPropertyBinding

Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

MEDIUM

camel.sink.endpoint.delayQueue

Define if you want to apply delaySeconds option to the queue or on single messages

false

MEDIUM

camel.sink.endpoint.queueUrl

To define the queueUrl explicitly. All other parameters, which would influence the queueUrl, are ignored. This parameter is intended to be used, to connect to a mock implementation of SQS, for testing purposes.

null

MEDIUM

camel.sink.endpoint.synchronous

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

false

MEDIUM

camel.sink.endpoint.proxyHost

To define a proxy host when instantiating the SQS client

null

MEDIUM

camel.sink.endpoint.proxyPort

To define a proxy port when instantiating the SQS client

null

MEDIUM

camel.sink.endpoint.maximumMessageSize

The maximumMessageSize (in bytes) an SQS message can contain for this queue.

null

MEDIUM

camel.sink.endpoint.messageRetentionPeriod

The messageRetentionPeriod (in seconds) a message will be retained by SQS for this queue.

null

MEDIUM

camel.sink.endpoint.policy

The policy for this queue

null

MEDIUM

camel.sink.endpoint.receiveMessageWaitTimeSeconds

If you do not specify WaitTimeSeconds in the request, the queue attribute ReceiveMessageWaitTimeSeconds is used to determine how long to wait.

null

MEDIUM

camel.sink.endpoint.redrivePolicy

Specify the policy that send message to DeadLetter queue. See detail at Amazon docs.

null

MEDIUM

camel.sink.endpoint.accessKey

Amazon AWS Access Key

null

MEDIUM

camel.sink.endpoint.secretKey

Amazon AWS Secret Key

null

MEDIUM

camel.component.aws2-sqs.amazonAWSHost

The hostname of the Amazon AWS cloud.

"amazonaws.com"

MEDIUM

camel.component.aws2-sqs.amazonSQSClient

To use the AmazonSQS as client

null

MEDIUM

camel.component.aws2-sqs.autoCreateQueue

Setting the autocreation of the queue

true

MEDIUM

camel.component.aws2-sqs.autoDiscoverClient

Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking.

true

MEDIUM

camel.component.aws2-sqs.configuration

The AWS SQS default configuration

null

MEDIUM

camel.component.aws2-sqs.protocol

The underlying protocol used to communicate with SQS

"https"

MEDIUM

camel.component.aws2-sqs.proxyProtocol

To define a proxy protocol when instantiating the SQS client One of: [HTTP] [HTTPS]

"HTTPS"

MEDIUM

camel.component.aws2-sqs.queueOwnerAWSAccountId

Specify the queue owner aws account id when you need to connect the queue with different account owner.

null

MEDIUM

camel.component.aws2-sqs.region

The region in which SQS client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You’ll need to use the name Region.EU_WEST_1.id()

null

MEDIUM

camel.component.aws2-sqs.trustAllCertificates

If we want to trust all certificates in case of overriding the endpoint

false

MEDIUM

camel.component.aws2-sqs.delaySeconds

Delay sending messages for a number of seconds.

null

MEDIUM

camel.component.aws2-sqs.lazyStartProducer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

MEDIUM

camel.component.aws2-sqs.messageDeduplicationId Strategy

Only for FIFO queues. Strategy for setting the messageDeduplicationId on the message. Can be one of the following options: useExchangeId, useContentBasedDeduplication. For the useContentBasedDeduplication option, no messageDeduplicationId will be set on the message. One of: [useExchangeId] [useContentBasedDeduplication]

"useExchangeId"

MEDIUM

camel.component.aws2-sqs.messageGroupIdStrategy

Only for FIFO queues. Strategy for setting the messageGroupId on the message. Can be one of the following options: useConstant, useExchangeId, usePropertyValue. For the usePropertyValue option, the value of property CamelAwsMessageGroupId will be used. One of: [useConstant] [useExchangeId] [usePropertyValue]

null

MEDIUM

camel.component.aws2-sqs.operation

The operation to do in case the user don’t want to send only a message One of: [sendBatchMessage] [deleteMessage] [listQueues] [purgeQueue]

null

MEDIUM

camel.component.aws2-sqs.basicPropertyBinding

Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

MEDIUM

camel.component.aws2-sqs.delayQueue

Define if you want to apply delaySeconds option to the queue or on single messages

false

MEDIUM

camel.component.aws2-sqs.queueUrl

To define the queueUrl explicitly. All other parameters, which would influence the queueUrl, are ignored. This parameter is intended to be used, to connect to a mock implementation of SQS, for testing purposes.

null

MEDIUM

camel.component.aws2-sqs.proxyHost

To define a proxy host when instantiating the SQS client

null

MEDIUM

camel.component.aws2-sqs.proxyPort

To define a proxy port when instantiating the SQS client

null

MEDIUM

camel.component.aws2-sqs.maximumMessageSize

The maximumMessageSize (in bytes) an SQS message can contain for this queue.

null

MEDIUM

camel.component.aws2-sqs.messageRetentionPeriod

The messageRetentionPeriod (in seconds) a message will be retained by SQS for this queue.

null

MEDIUM

camel.component.aws2-sqs.policy

The policy for this queue

null

MEDIUM

camel.component.aws2-sqs.receiveMessageWaitTime Seconds

If you do not specify WaitTimeSeconds in the request, the queue attribute ReceiveMessageWaitTimeSeconds is used to determine how long to wait.

null

MEDIUM

camel.component.aws2-sqs.redrivePolicy

Specify the policy that send message to DeadLetter queue. See detail at Amazon docs.

null

MEDIUM

camel.component.aws2-sqs.accessKey

Amazon AWS Access Key

null

MEDIUM

camel.component.aws2-sqs.secretKey

Amazon AWS Secret Key

null

MEDIUM

camel.source.path.queueNameOrArn

Queue name or ARN

null

HIGH

camel.source.endpoint.amazonAWSHost

The hostname of the Amazon AWS cloud.

"amazonaws.com"

MEDIUM

camel.source.endpoint.amazonSQSClient

To use the AmazonSQS as client

null

MEDIUM

camel.source.endpoint.autoCreateQueue

Setting the autocreation of the queue

true

MEDIUM

camel.source.endpoint.autoDiscoverClient

Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking.

true

MEDIUM

camel.source.endpoint.headerFilterStrategy

To use a custom HeaderFilterStrategy to map headers to/from Camel.

null

MEDIUM

camel.source.endpoint.protocol

The underlying protocol used to communicate with SQS

"https"

MEDIUM

camel.source.endpoint.proxyProtocol

To define a proxy protocol when instantiating the SQS client One of: [HTTP] [HTTPS]

"HTTPS"

MEDIUM

camel.source.endpoint.queueOwnerAWSAccountId

Specify the queue owner aws account id when you need to connect the queue with different account owner.

null

MEDIUM

camel.source.endpoint.region

The region in which SQS client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You’ll need to use the name Region.EU_WEST_1.id()

null

MEDIUM

camel.source.endpoint.trustAllCertificates

If we want to trust all certificates in case of overriding the endpoint

false

MEDIUM

camel.source.endpoint.attributeNames

A list of attribute names to receive when consuming. Multiple names can be separated by comma.

null

MEDIUM

camel.source.endpoint.bridgeErrorHandler

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

MEDIUM

camel.source.endpoint.concurrentConsumers

Allows you to use multiple threads to poll the sqs queue to increase throughput

1

MEDIUM

camel.source.endpoint.defaultVisibilityTimeout

The default visibility timeout (in seconds)

null

MEDIUM

camel.source.endpoint.deleteAfterRead

Delete message from SQS after it has been read

true

MEDIUM

camel.source.endpoint.deleteIfFiltered

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

MEDIUM

camel.source.endpoint.extendMessageVisibility

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

MEDIUM

camel.source.endpoint.kmsDataKeyReusePeriodSeconds

The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes).

null

MEDIUM

camel.source.endpoint.kmsMasterKeyId

The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK.

null

MEDIUM

camel.source.endpoint.maxMessagesPerPoll

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.

null

MEDIUM

camel.source.endpoint.messageAttributeNames

A list of message attribute names to receive when consuming. Multiple names can be separated by comma.

null

MEDIUM

camel.source.endpoint.sendEmptyMessageWhenIdle

If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.

false

MEDIUM

camel.source.endpoint.serverSideEncryptionEnabled

Define if Server Side Encryption is enabled or not on the queue

false

MEDIUM

camel.source.endpoint.visibilityTimeout

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.

null

MEDIUM

camel.source.endpoint.waitTimeSeconds

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.

null

MEDIUM

camel.source.endpoint.exceptionHandler

To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored.

null

MEDIUM

camel.source.endpoint.exchangePattern

Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut]

null

MEDIUM

camel.source.endpoint.pollStrategy

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.

null

MEDIUM

camel.source.endpoint.basicPropertyBinding

Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

MEDIUM

camel.source.endpoint.delayQueue

Define if you want to apply delaySeconds option to the queue or on single messages

false

MEDIUM

camel.source.endpoint.queueUrl

To define the queueUrl explicitly. All other parameters, which would influence the queueUrl, are ignored. This parameter is intended to be used, to connect to a mock implementation of SQS, for testing purposes.

null

MEDIUM

camel.source.endpoint.synchronous

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

false

MEDIUM

camel.source.endpoint.proxyHost

To define a proxy host when instantiating the SQS client

null

MEDIUM

camel.source.endpoint.proxyPort

To define a proxy port when instantiating the SQS client

null

MEDIUM

camel.source.endpoint.maximumMessageSize

The maximumMessageSize (in bytes) an SQS message can contain for this queue.

null

MEDIUM

camel.source.endpoint.messageRetentionPeriod

The messageRetentionPeriod (in seconds) a message will be retained by SQS for this queue.

null

MEDIUM

camel.source.endpoint.policy

The policy for this queue

null

MEDIUM

camel.source.endpoint.receiveMessageWaitTime Seconds

If you do not specify WaitTimeSeconds in the request, the queue attribute ReceiveMessageWaitTimeSeconds is used to determine how long to wait.

null

MEDIUM

camel.source.endpoint.redrivePolicy

Specify the policy that send message to DeadLetter queue. See detail at Amazon docs.

null

MEDIUM

camel.source.endpoint.backoffErrorThreshold

The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.

null

MEDIUM

camel.source.endpoint.backoffIdleThreshold

The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.

null

MEDIUM

camel.source.endpoint.backoffMultiplier

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.

null

MEDIUM

camel.source.endpoint.delay

Milliseconds before the next poll.

500L

MEDIUM

camel.source.endpoint.greedy

If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.

false

MEDIUM

camel.source.endpoint.initialDelay

Milliseconds before the first poll starts.

1000L

MEDIUM

camel.source.endpoint.repeatCount

Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever.

0L

MEDIUM

camel.source.endpoint.runLoggingLevel

The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. One of: [TRACE] [DEBUG] [INFO] [WARN] [ERROR] [OFF]

"TRACE"

MEDIUM

camel.source.endpoint.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.

null

MEDIUM

camel.source.endpoint.scheduler

To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler

"none"

MEDIUM

camel.source.endpoint.schedulerProperties

To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.

null

MEDIUM

camel.source.endpoint.startScheduler

Whether the scheduler should be auto started.

true

MEDIUM

camel.source.endpoint.timeUnit

Time unit for initialDelay and delay options. One of: [NANOSECONDS] [MICROSECONDS] [MILLISECONDS] [SECONDS] [MINUTES] [HOURS] [DAYS]

"MILLISECONDS"

MEDIUM

camel.source.endpoint.useFixedDelay

Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.

true

MEDIUM

camel.source.endpoint.accessKey

Amazon AWS Access Key

null

MEDIUM

camel.source.endpoint.secretKey

Amazon AWS Secret Key

null

MEDIUM

camel.component.aws2-sqs.amazonAWSHost

The hostname of the Amazon AWS cloud.

"amazonaws.com"

MEDIUM

camel.component.aws2-sqs.amazonSQSClient

To use the AmazonSQS as client

null

MEDIUM

camel.component.aws2-sqs.autoCreateQueue

Setting the autocreation of the queue

true

MEDIUM

camel.component.aws2-sqs.autoDiscoverClient

Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking.

true

MEDIUM

camel.component.aws2-sqs.configuration

The AWS SQS default configuration

null

MEDIUM

camel.component.aws2-sqs.protocol

The underlying protocol used to communicate with SQS

"https"

MEDIUM

camel.component.aws2-sqs.proxyProtocol

To define a proxy protocol when instantiating the SQS client One of: [HTTP] [HTTPS]

"HTTPS"

MEDIUM

camel.component.aws2-sqs.queueOwnerAWSAccountId

Specify the queue owner aws account id when you need to connect the queue with different account owner.

null

MEDIUM

camel.component.aws2-sqs.region

The region in which SQS client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You’ll need to use the name Region.EU_WEST_1.id()

null

MEDIUM

camel.component.aws2-sqs.trustAllCertificates

If we want to trust all certificates in case of overriding the endpoint

false

MEDIUM

camel.component.aws2-sqs.attributeNames

A list of attribute names to receive when consuming. Multiple names can be separated by comma.

null

MEDIUM

camel.component.aws2-sqs.bridgeErrorHandler

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

MEDIUM

camel.component.aws2-sqs.concurrentConsumers

Allows you to use multiple threads to poll the sqs queue to increase throughput

1

MEDIUM

camel.component.aws2-sqs.defaultVisibilityTimeout

The default visibility timeout (in seconds)

null

MEDIUM

camel.component.aws2-sqs.deleteAfterRead

Delete message from SQS after it has been read

true

MEDIUM

camel.component.aws2-sqs.deleteIfFiltered

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

MEDIUM

camel.component.aws2-sqs.extendMessageVisibility

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

MEDIUM

camel.component.aws2-sqs.kmsDataKeyReusePeriod Seconds

The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes).

null

MEDIUM

camel.component.aws2-sqs.kmsMasterKeyId

The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK.

null

MEDIUM

camel.component.aws2-sqs.messageAttributeNames

A list of message attribute names to receive when consuming. Multiple names can be separated by comma.

null

MEDIUM

camel.component.aws2-sqs.serverSideEncryption Enabled

Define if Server Side Encryption is enabled or not on the queue

false

MEDIUM

camel.component.aws2-sqs.visibilityTimeout

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.

null

MEDIUM

camel.component.aws2-sqs.waitTimeSeconds

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.

null

MEDIUM

camel.component.aws2-sqs.basicPropertyBinding

Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

MEDIUM

camel.component.aws2-sqs.delayQueue

Define if you want to apply delaySeconds option to the queue or on single messages

false

MEDIUM

camel.component.aws2-sqs.queueUrl

To define the queueUrl explicitly. All other parameters, which would influence the queueUrl, are ignored. This parameter is intended to be used, to connect to a mock implementation of SQS, for testing purposes.

null

MEDIUM

camel.component.aws2-sqs.proxyHost

To define a proxy host when instantiating the SQS client

null

MEDIUM

camel.component.aws2-sqs.proxyPort

To define a proxy port when instantiating the SQS client

null

MEDIUM

camel.component.aws2-sqs.maximumMessageSize

The maximumMessageSize (in bytes) an SQS message can contain for this queue.

null

MEDIUM

camel.component.aws2-sqs.messageRetentionPeriod

The messageRetentionPeriod (in seconds) a message will be retained by SQS for this queue.

null

MEDIUM

camel.component.aws2-sqs.policy

The policy for this queue

null

MEDIUM

camel.component.aws2-sqs.receiveMessageWaitTime Seconds

If you do not specify WaitTimeSeconds in the request, the queue attribute ReceiveMessageWaitTimeSeconds is used to determine how long to wait.

null

MEDIUM

camel.component.aws2-sqs.redrivePolicy

Specify the policy that send message to DeadLetter queue. See detail at Amazon docs.

null

MEDIUM

camel.component.aws2-sqs.accessKey

Amazon AWS Access Key

null

MEDIUM

camel.component.aws2-sqs.secretKey

Amazon AWS Secret Key

null

MEDIUM

camel.sink.path.beanRef

beanRef is defined using bean:id

null

MEDIUM

camel.sink.path.hosts

Hostname(s) cassansdra server(s). Multiple hosts can be separated by comma.

null

MEDIUM

camel.sink.path.port

Port number of cassansdra server(s)

null

MEDIUM

camel.sink.path.keyspace

Keyspace to use

null

MEDIUM

camel.sink.endpoint.clusterName

Cluster name

null

MEDIUM

camel.sink.endpoint.consistencyLevel

Consistency level to use One of: [ANY] [ONE] [TWO] [THREE] [QUORUM] [ALL] [LOCAL_ONE] [LOCAL_QUORUM] [EACH_QUORUM] [SERIAL] [LOCAL_SERIAL]

null

MEDIUM

camel.sink.endpoint.cql

CQL query to perform. Can be overridden with the message header with key CamelCqlQuery.

null

MEDIUM

camel.sink.endpoint.datacenter

Datacenter to use

"datacenter1"

MEDIUM

camel.sink.endpoint.loadBalancingPolicyClass

To use a specific LoadBalancingPolicyClass

null

MEDIUM

camel.sink.endpoint.password

Password for session authentication

null

MEDIUM

camel.sink.endpoint.prepareStatements

Whether to use PreparedStatements or regular Statements

true

MEDIUM

camel.sink.endpoint.resultSetConversionStrategy

To use a custom class that implements logic for converting ResultSet into message body ALL, ONE, LIMIT_10, LIMIT_100…​

null

MEDIUM

camel.sink.endpoint.session

To use the Session instance (you would normally not use this option)

null

MEDIUM

camel.sink.endpoint.username

Username for session authentication

null

MEDIUM

camel.sink.endpoint.lazyStartProducer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

MEDIUM

camel.sink.endpoint.basicPropertyBinding

Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

MEDIUM

camel.sink.endpoint.synchronous

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

false

MEDIUM

camel.component.cql.lazyStartProducer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

MEDIUM

camel.component.cql.basicPropertyBinding

Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

MEDIUM

camel.source.path.beanRef

beanRef is defined using bean:id

null

MEDIUM

camel.source.path.hosts

Hostname(s) cassansdra server(s). Multiple hosts can be separated by comma.

null

MEDIUM

camel.source.path.port

Port number of cassansdra server(s)

null

MEDIUM

camel.source.path.keyspace

Keyspace to use

null

MEDIUM

camel.source.endpoint.clusterName

Cluster name

null

MEDIUM

camel.source.endpoint.consistencyLevel

Consistency level to use One of: [ANY] [ONE] [TWO] [THREE] [QUORUM] [ALL] [LOCAL_ONE] [LOCAL_QUORUM] [EACH_QUORUM] [SERIAL] [LOCAL_SERIAL]

null

MEDIUM

camel.source.endpoint.cql

CQL query to perform. Can be overridden with the message header with key CamelCqlQuery.

null

MEDIUM

camel.source.endpoint.datacenter

Datacenter to use

"datacenter1"

MEDIUM

camel.source.endpoint.loadBalancingPolicyClass

To use a specific LoadBalancingPolicyClass

null

MEDIUM

camel.source.endpoint.password

Password for session authentication

null

MEDIUM

camel.source.endpoint.prepareStatements

Whether to use PreparedStatements or regular Statements

true

MEDIUM

camel.source.endpoint.resultSetConversionStrategy

To use a custom class that implements logic for converting ResultSet into message body ALL, ONE, LIMIT_10, LIMIT_100…​

null

MEDIUM

camel.source.endpoint.session

To use the Session instance (you would normally not use this option)

null

MEDIUM

camel.source.endpoint.username

Username for session authentication

null

MEDIUM

camel.source.endpoint.bridgeErrorHandler

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

MEDIUM

camel.source.endpoint.sendEmptyMessageWhenIdle

If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.

false

MEDIUM

camel.source.endpoint.exceptionHandler

To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored.

null

MEDIUM

camel.source.endpoint.exchangePattern

Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut]

null

MEDIUM

camel.source.endpoint.pollStrategy

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.

null

MEDIUM

camel.source.endpoint.basicPropertyBinding

Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

MEDIUM

camel.source.endpoint.synchronous

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

false

MEDIUM

camel.source.endpoint.backoffErrorThreshold

The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.

null

MEDIUM

camel.source.endpoint.backoffIdleThreshold

The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.

null

MEDIUM

camel.source.endpoint.backoffMultiplier

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.

null

MEDIUM

camel.source.endpoint.delay

Milliseconds before the next poll.

500L

MEDIUM

camel.source.endpoint.greedy

If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.

false

MEDIUM

camel.source.endpoint.initialDelay

Milliseconds before the first poll starts.

1000L

MEDIUM

camel.source.endpoint.repeatCount

Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever.

0L

MEDIUM

camel.source.endpoint.runLoggingLevel

The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. One of: [TRACE] [DEBUG] [INFO] [WARN] [ERROR] [OFF]

"TRACE"

MEDIUM

camel.source.endpoint.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.

null

MEDIUM

camel.source.endpoint.scheduler

To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler

"none"

MEDIUM

camel.source.endpoint.schedulerProperties

To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.

null

MEDIUM

camel.source.endpoint.startScheduler

Whether the scheduler should be auto started.

true

MEDIUM

camel.source.endpoint.timeUnit

Time unit for initialDelay and delay options. One of: [NANOSECONDS] [MICROSECONDS] [MILLISECONDS] [SECONDS] [MINUTES] [HOURS] [DAYS]

"MILLISECONDS"

MEDIUM

camel.source.endpoint.useFixedDelay

Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.

true

MEDIUM

camel.component.cql.bridgeErrorHandler

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

MEDIUM

camel.component.cql.basicPropertyBinding

Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

MEDIUM

camel.sink.path.clusterName

Name of the cluster

null

HIGH

camel.sink.endpoint.connectionTimeout

The time in ms to wait before connection will timeout.

30000

MEDIUM

camel.sink.endpoint.disconnect

Disconnect after it finish calling the producer

false

MEDIUM

camel.sink.endpoint.enableSniffer

Enable automatically discover nodes from a running Elasticsearch cluster

false

MEDIUM

camel.sink.endpoint.enableSSL

Enable SSL

false

MEDIUM

camel.sink.endpoint.from

Starting index of the response.

null

MEDIUM

camel.sink.endpoint.hostAddresses

Comma separated list with ip:port formatted remote transport addresses to use.

null

HIGH

camel.sink.endpoint.indexName

The name of the index to act against

null

MEDIUM

camel.sink.endpoint.lazyStartProducer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

MEDIUM

camel.sink.endpoint.maxRetryTimeout

The time in ms before retry

30000

MEDIUM

camel.sink.endpoint.operation

What operation to perform One of: [Index] [Update] [Bulk] [BulkIndex] [GetById] [MultiGet] [MultiSearch] [Delete] [DeleteIndex] [Search] [Exists] [Ping]

null

MEDIUM

camel.sink.endpoint.scrollKeepAliveMs

Time in ms during which elasticsearch will keep search context alive

60000

MEDIUM

camel.sink.endpoint.size

Size of the response.

null

MEDIUM

camel.sink.endpoint.sniffAfterFailureDelay

The delay of a sniff execution scheduled after a failure (in milliseconds)

60000

MEDIUM

camel.sink.endpoint.snifferInterval

The interval between consecutive ordinary sniff executions in milliseconds. Will be honoured when sniffOnFailure is disabled or when there are no failures between consecutive sniff executions

300000

MEDIUM

camel.sink.endpoint.socketTimeout

The timeout in ms to wait before the socket will timeout.

30000

MEDIUM

camel.sink.endpoint.useScroll

Enable scroll usage

false

MEDIUM

camel.sink.endpoint.waitForActiveShards

Index creation waits for the write consistency number of shards to be available

1

MEDIUM

camel.sink.endpoint.basicPropertyBinding

Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

MEDIUM

camel.sink.endpoint.synchronous

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

false

MEDIUM

camel.component.elasticsearch-rest.lazyStart Producer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

MEDIUM

camel.component.elasticsearch-rest.basicProperty Binding

Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

MEDIUM

camel.component.elasticsearch-rest.client

To use an existing configured Elasticsearch client, instead of creating a client per endpoint. This allow to customize the client with specific settings.

null

MEDIUM

camel.component.elasticsearch-rest.connection Timeout

The time in ms to wait before connection will timeout.

30000

MEDIUM

camel.component.elasticsearch-rest.enableSniffer

Enable automatically discover nodes from a running Elasticsearch cluster

"false"

MEDIUM

camel.component.elasticsearch-rest.hostAddresses

Comma separated list with ip:port formatted remote transport addresses to use. The ip and port options must be left blank for hostAddresses to be considered instead.

null

MEDIUM

camel.component.elasticsearch-rest.maxRetryTimeout

The time in ms before retry

30000

MEDIUM

camel.component.elasticsearch-rest.sniffAfter FailureDelay

The delay of a sniff execution scheduled after a failure (in milliseconds)

60000

MEDIUM

camel.component.elasticsearch-rest.snifferInterval

The interval between consecutive ordinary sniff executions in milliseconds. Will be honoured when sniffOnFailure is disabled or when there are no failures between consecutive sniff executions

300000

MEDIUM

camel.component.elasticsearch-rest.socketTimeout

The timeout in ms to wait before the socket will timeout.

30000

MEDIUM

camel.component.elasticsearch-rest.enableSSL

Enable SSL

"false"

MEDIUM

camel.component.elasticsearch-rest.password

Password for authenticate

null

MEDIUM

camel.component.elasticsearch-rest.user

Basic authenticate user

null

MEDIUM

camel.sink.path.directoryName

The starting directory

null

HIGH

camel.sink.endpoint.charset

This option is used to specify the encoding of the file. You can use this on the consumer, to specify the encodings of the files, which allow Camel to know the charset it should load the file content in case the file content is being accessed. Likewise when writing a file, you can use this option to specify which charset to write the file as well. Do mind that when writing the file Camel may have to read the message content into memory to be able to convert the data into the configured charset, so do not use this if you have big messages.

null

MEDIUM

camel.sink.endpoint.doneFileName

Producer: If provided, then Camel will write a 2nd done file when the original file has been written. The done file will be empty. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders. The done file will always be written in the same folder as the original file. Consumer: If provided, Camel will only consume files if a done file exists. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders.The done file is always expected in the same folder as the original file. Only \${file.name} and \${file.name.next} is supported as dynamic placeholders.

null

MEDIUM

camel.sink.endpoint.fileName

Use Expression such as File Language to dynamically set the filename. For consumers, it’s used as a filename filter. For producers, it’s used to evaluate the filename to write. If an expression is set, it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type, it is always evaluated using the File Language. If the expression is an Expression type, the specified Expression type is used - this allows you, for instance, to use OGNL expressions. For the consumer, you can use it to filter filenames, so you can for instance consume today’s file using the File Language syntax: mydata-\${date:now:yyyyMMdd}.txt. The producers support the CamelOverruleFileName header which takes precedence over any existing CamelFileName header; the CamelOverruleFileName is a header that is used only once, and makes it easier as this avoids to temporary store CamelFileName and have to restore it afterwards.

null

MEDIUM

camel.sink.endpoint.appendChars

Used to append characters (text) after writing files. This can for example be used to add new lines or other separators when writing and appending to existing files. To specify new-line (slash-n or slash-r) or tab (slash-t) characters then escape with an extra slash, eg slash-slash-n.

null

MEDIUM

camel.sink.endpoint.fileExist

What to do if a file already exists with the same name. Override, which is the default, replaces the existing file. - Append - adds content to the existing file. - Fail - throws a GenericFileOperationException, indicating that there is already an existing file. - Ignore - silently ignores the problem and does not override the existing file, but assumes everything is okay. - Move - option requires to use the moveExisting option to be configured as well. The option eagerDeleteTargetFile can be used to control what to do if an moving the file, and there exists already an existing file, otherwise causing the move operation to fail. The Move option will move any existing files, before writing the target file. - TryRename is only applicable if tempFileName option is in use. This allows to try renaming the file from the temporary name to the actual name, without doing any exists check. This check may be faster on some file systems and especially FTP servers. One of: [Override] [Append] [Fail] [Ignore] [Move] [TryRename]

"Override"

MEDIUM

camel.sink.endpoint.flatten

Flatten is used to flatten the file name path to strip any leading paths, so it’s just the file name. This allows you to consume recursively into sub-directories, but when you eg write the files to another directory they will be written in a single directory. Setting this to true on the producer enforces that any file name in CamelFileName header will be stripped for any leading paths.

false

MEDIUM

camel.sink.endpoint.jailStartingDirectory

Used for jailing (restricting) writing files to the starting directory (and sub) only. This is enabled by default to not allow Camel to write files to outside directories (to be more secured out of the box). You can turn this off to allow writing files to directories outside the starting directory, such as parent or root folders.

true

MEDIUM

camel.sink.endpoint.lazyStartProducer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

MEDIUM

camel.sink.endpoint.moveExisting

Expression (such as File Language) used to compute file name to use when fileExist=Move is configured. To move files into a backup subdirectory just enter backup. This option only supports the following File Language tokens: file:name, file:name.ext, file:name.noext, file:onlyname, file:onlyname.noext, file:ext, and file:parent. Notice the file:parent is not supported by the FTP component, as the FTP component can only move any existing files to a relative directory based on current dir as base.

null

MEDIUM

camel.sink.endpoint.tempFileName

The same as tempPrefix option but offering a more fine grained control on the naming of the temporary filename as it uses the File Language. The location for tempFilename is relative to the final file location in the option 'fileName', not the target directory in the base uri. For example if option fileName includes a directory prefix: dir/finalFilename then tempFileName is relative to that subdirectory dir.

null

MEDIUM

camel.sink.endpoint.tempPrefix

This option is used to write the file using a temporary name and then, after the write is complete, rename it to the real name. Can be used to identify files being written and also avoid consumers (not using exclusive read locks) reading in progress files. Is often used by FTP when uploading big files.

null

MEDIUM

camel.sink.endpoint.allowNullBody

Used to specify if a null body is allowed during file writing. If set to true then an empty file will be created, when set to false, and attempting to send a null body to the file component, a GenericFileWriteException of 'Cannot write null body to file.' will be thrown. If the fileExist option is set to 'Override', then the file will be truncated, and if set to append the file will remain unchanged.

false

MEDIUM

camel.sink.endpoint.chmod

Specify the file permissions which is sent by the producer, the chmod value must be between 000 and 777; If there is a leading digit like in 0755 we will ignore it.

null

MEDIUM

camel.sink.endpoint.chmodDirectory

Specify the directory permissions used when the producer creates missing directories, the chmod value must be between 000 and 777; If there is a leading digit like in 0755 we will ignore it.

null

MEDIUM

camel.sink.endpoint.eagerDeleteTargetFile

Whether or not to eagerly delete any existing target file. This option only applies when you use fileExists=Override and the tempFileName option as well. You can use this to disable (set it to false) deleting the target file before the temp file is written. For example you may write big files and want the target file to exists during the temp file is being written. This ensure the target file is only deleted until the very last moment, just before the temp file is being renamed to the target filename. This option is also used to control whether to delete any existing files when fileExist=Move is enabled, and an existing file exists. If this option copyAndDeleteOnRenameFails false, then an exception will be thrown if an existing file existed, if its true, then the existing file is deleted before the move operation.

true

MEDIUM

camel.sink.endpoint.forceWrites

Whether to force syncing writes to the file system. You can turn this off if you do not want this level of guarantee, for example if writing to logs / audit logs etc; this would yield better performance.

true

MEDIUM

camel.sink.endpoint.keepLastModified

Will keep the last modified timestamp from the source file (if any). Will use the Exchange.FILE_LAST_MODIFIED header to located the timestamp. This header can contain either a java.util.Date or long with the timestamp. If the timestamp exists and the option is enabled it will set this timestamp on the written file. Note: This option only applies to the file producer. You cannot use this option with any of the \ftp producers.

false

MEDIUM

camel.sink.endpoint.moveExistingFileStrategy

Strategy (Custom Strategy) used to move file with special naming token to use when fileExist=Move is configured. By default, there is an implementation used if no custom strategy is provided

null

MEDIUM

camel.sink.endpoint.autoCreate

Automatically create missing directories in the file’s pathname. For the file consumer, that means creating the starting directory. For the file producer, it means the directory the files should be written to.

true

MEDIUM

camel.sink.endpoint.basicPropertyBinding

Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

MEDIUM

camel.sink.endpoint.bufferSize

Buffer size in bytes used for writing files (or in case of FTP for downloading and uploading files).

131072

MEDIUM

camel.sink.endpoint.copyAndDeleteOnRenameFail

Whether to fallback and do a copy and delete file, in case the file could not be renamed directly. This option is not available for the FTP component.

true

MEDIUM

camel.sink.endpoint.renameUsingCopy

Perform rename operations using a copy and delete strategy. This is primarily used in environments where the regular rename operation is unreliable (e.g. across different file systems or networks). This option takes precedence over the copyAndDeleteOnRenameFail parameter that will automatically fall back to the copy and delete strategy, but only after additional delays.

false

MEDIUM

camel.sink.endpoint.synchronous

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

false

MEDIUM

camel.component.file.lazyStartProducer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

MEDIUM

camel.component.file.basicPropertyBinding

Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

MEDIUM

camel.sink.path.hostName

HDFS host to use

null

HIGH

camel.sink.path.port

HDFS port to use

8020

MEDIUM

camel.sink.path.path

The directory path to use

null

HIGH

camel.sink.endpoint.connectOnStartup

Whether to connect to the HDFS file system on starting the producer/consumer. If false then the connection is created on-demand. Notice that HDFS may take up till 15 minutes to establish a connection, as it has hardcoded 45 x 20 sec redelivery. By setting this option to false allows your application to startup, and not block for up till 15 minutes.

true

MEDIUM

camel.sink.endpoint.fileSystemType

Set to LOCAL to not use HDFS but local java.io.File instead. One of: [LOCAL] [HDFS]

"HDFS"

MEDIUM

camel.sink.endpoint.fileType

The file type to use. For more details see Hadoop HDFS documentation about the various files types. One of: [NORMAL_FILE] [SEQUENCE_FILE] [MAP_FILE] [BLOOMMAP_FILE] [ARRAY_FILE]

"NORMAL_FILE"

MEDIUM

camel.sink.endpoint.keyType

The type for the key in case of sequence or map files. One of: [NULL] [BOOLEAN] [BYTE] [INT] [FLOAT] [LONG] [DOUBLE] [TEXT] [BYTES]

"NULL"

MEDIUM

camel.sink.endpoint.namedNodes

A comma separated list of named nodes (e.g. srv11.example.com:8020,srv12.example.com:8020)

null

MEDIUM

camel.sink.endpoint.owner

The file owner must match this owner for the consumer to pickup the file. Otherwise the file is skipped.

null

MEDIUM

camel.sink.endpoint.valueType

The type for the key in case of sequence or map files One of: [NULL] [BOOLEAN] [BYTE] [INT] [FLOAT] [LONG] [DOUBLE] [TEXT] [BYTES]

"BYTES"

MEDIUM

camel.sink.endpoint.append

Append to existing file. Notice that not all HDFS file systems support the append option.

false

MEDIUM

camel.sink.endpoint.lazyStartProducer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

MEDIUM

camel.sink.endpoint.overwrite

Whether to overwrite existing files with the same name

true

MEDIUM

camel.sink.endpoint.basicPropertyBinding

Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

MEDIUM

camel.sink.endpoint.blockSize

The size of the HDFS blocks

67108864L

MEDIUM

camel.sink.endpoint.bufferSize

The buffer size used by HDFS

4096

MEDIUM

camel.sink.endpoint.checkIdleInterval

How often (time in millis) in to run the idle checker background task. This option is only in use if the splitter strategy is IDLE.

500

MEDIUM

camel.sink.endpoint.chunkSize

When reading a normal file, this is split into chunks producing a message per chunk.

4096

MEDIUM

camel.sink.endpoint.compressionCodec

The compression codec to use One of: [DEFAULT] [GZIP] [BZIP2]

"DEFAULT"

MEDIUM

camel.sink.endpoint.compressionType

The compression type to use (is default not in use) One of: [NONE] [RECORD] [BLOCK]

"NONE"

MEDIUM

camel.sink.endpoint.openedSuffix

When a file is opened for reading/writing the file is renamed with this suffix to avoid to read it during the writing phase.

"opened"

MEDIUM

camel.sink.endpoint.readSuffix

Once the file has been read is renamed with this suffix to avoid to read it again.

"read"

MEDIUM

camel.sink.endpoint.replication

The HDFS replication factor

3

MEDIUM

camel.sink.endpoint.splitStrategy

In the current version of Hadoop opening a file in append mode is disabled since it’s not very reliable. So, for the moment, it’s only possible to create new files. The Camel HDFS endpoint tries to solve this problem in this way: If the split strategy option has been defined, the hdfs path will be used as a directory and files will be created using the configured UuidGenerator. Every time a splitting condition is met, a new file is created. The splitStrategy option is defined as a string with the following syntax: splitStrategy=ST:value,ST:value,…​ where ST can be: BYTES a new file is created, and the old is closed when the number of written bytes is more than value MESSAGES a new file is created, and the old is closed when the number of written messages is more than value IDLE a new file is created, and the old is closed when no writing happened in the last value milliseconds

null

MEDIUM

camel.sink.endpoint.synchronous

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

false

MEDIUM

camel.sink.endpoint.kerberosConfigFileLocation

The location of the kerb5.conf file (https://web.mit.edu/kerberos/krb5-1.12/doc/admin/conf_files/krb5_conf.html)

null

MEDIUM

camel.sink.endpoint.kerberosKeytabLocation

The location of the keytab file used to authenticate with the kerberos nodes (contains pairs of kerberos principals and encrypted keys (which are derived from the Kerberos password))

null

MEDIUM

camel.sink.endpoint.kerberosUsername

The username used to authenticate with the kerberos nodes

null

MEDIUM

camel.component.hdfs.lazyStartProducer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

MEDIUM

camel.component.hdfs.basicPropertyBinding

Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

MEDIUM

camel.component.hdfs.jAASConfiguration

To use the given configuration for security with JAAS.

null

MEDIUM

camel.component.hdfs.kerberosConfigFile

To use kerberos authentication, set the value of the 'java.security.krb5.conf' environment variable to an existing file. If the environment variable is already set, warn if different than the specified parameter

null

MEDIUM

camel.sink.path.httpUri

The url of the HTTP endpoint to call.

null

HIGH

camel.sink.endpoint.disableStreamCache

Determines whether or not the raw input stream from Servlet is cached or not (Camel will read the stream into a in memory/overflow to file, Stream caching) cache. By default Camel will cache the Servlet input stream to support reading it multiple times to ensure it Camel can retrieve all data from the stream. However you can set this option to true when you for example need to access the raw stream, such as streaming it directly to a file or other persistent store. DefaultHttpBinding will copy the request input stream into a stream cache and put it into message body if this option is false to support reading the stream multiple times. If you use Servlet to bridge/proxy an endpoint then consider enabling this option to improve performance, in case you do not need to read the message payload multiple times. The http producer will by default cache the response body stream. If setting this option to true, then the producers will not cache the response body stream but use the response stream as-is as the message body.

false

MEDIUM

camel.sink.endpoint.headerFilterStrategy

To use a custom HeaderFilterStrategy to filter header to and from Camel message.

null

MEDIUM

camel.sink.endpoint.httpBinding

To use a custom HttpBinding to control the mapping between Camel message and HttpClient.

null

MEDIUM

camel.sink.endpoint.bridgeEndpoint

If the option is true, HttpProducer will ignore the Exchange.HTTP_URI header, and use the endpoint’s URI for request. You may also set the option throwExceptionOnFailure to be false to let the HttpProducer send all the fault response back.

false

MEDIUM

camel.sink.endpoint.chunked

If this option is false the Servlet will disable the HTTP streaming and set the content-length header on the response

true

MEDIUM

camel.sink.endpoint.clearExpiredCookies

Whether to clear expired cookies before sending the HTTP request. This ensures the cookies store does not keep growing by adding new cookies which is newer removed when they are expired.

true

MEDIUM

camel.sink.endpoint.connectionClose

Specifies whether a Connection Close header must be added to HTTP Request. By default connectionClose is false.

false

MEDIUM

camel.sink.endpoint.copyHeaders

If this option is true then IN exchange headers will be copied to OUT exchange headers according to copy strategy. Setting this to false, allows to only include the headers from the HTTP response (not propagating IN headers).

true

MEDIUM

camel.sink.endpoint.customHostHeader

To use custom host header for producer. When not set in query will be ignored. When set will override host header derived from url.

null

MEDIUM

camel.sink.endpoint.httpMethod

Configure the HTTP method to use. The HttpMethod header cannot override this option if set. One of: [GET] [POST] [PUT] [DELETE] [HEAD] [OPTIONS] [TRACE] [PATCH]

null

MEDIUM

camel.sink.endpoint.ignoreResponseBody

If this option is true, The http producer won’t read response body and cache the input stream

false

MEDIUM

camel.sink.endpoint.lazyStartProducer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

MEDIUM

camel.sink.endpoint.preserveHostHeader

If the option is true, HttpProducer will set the Host header to the value contained in the current exchange Host header, useful in reverse proxy applications where you want the Host header received by the downstream server to reflect the URL called by the upstream client, this allows applications which use the Host header to generate accurate URL’s for a proxied service

false

MEDIUM

camel.sink.endpoint.throwExceptionOnFailure

Option to disable throwing the HttpOperationFailedException in case of failed responses from the remote server. This allows you to get all responses regardless of the HTTP status code.

true

MEDIUM

camel.sink.endpoint.transferException

If enabled and an Exchange failed processing on the consumer side, and if the caused Exception was send back serialized in the response as a application/x-java-serialized-object content type. On the producer side the exception will be deserialized and thrown as is, instead of the HttpOperationFailedException. The caused exception is required to be serialized. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk.

false

MEDIUM

camel.sink.endpoint.cookieHandler

Configure a cookie handler to maintain a HTTP session

null

MEDIUM

camel.sink.endpoint.cookieStore

To use a custom CookieStore. By default the BasicCookieStore is used which is an in-memory only cookie store. Notice if bridgeEndpoint=true then the cookie store is forced to be a noop cookie store as cookie shouldn’t be stored as we are just bridging (eg acting as a proxy). If a cookieHandler is set then the cookie store is also forced to be a noop cookie store as cookie handling is then performed by the cookieHandler.

null

MEDIUM

camel.sink.endpoint.deleteWithBody

Whether the HTTP DELETE should include the message body or not. By default HTTP DELETE do not include any HTTP body. However in some rare cases users may need to be able to include the message body.

false

MEDIUM

camel.sink.endpoint.getWithBody

Whether the HTTP GET should include the message body or not. By default HTTP GET do not include any HTTP body. However in some rare cases users may need to be able to include the message body.

false

MEDIUM

camel.sink.endpoint.okStatusCodeRange

The status codes which are considered a success response. The values are inclusive. Multiple ranges can be defined, separated by comma, e.g. 200-204,209,301-304. Each range must be a single number or from-to with the dash included.

"200-299"

MEDIUM

camel.sink.endpoint.basicPropertyBinding

Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

MEDIUM

camel.sink.endpoint.clientBuilder

Provide access to the http client request parameters used on new RequestConfig instances used by producers or consumers of this endpoint.

null

MEDIUM

camel.sink.endpoint.clientConnectionManager

To use a custom HttpClientConnectionManager to manage connections

null

MEDIUM

camel.sink.endpoint.connectionsPerRoute

The maximum number of connections per route.

20

MEDIUM

camel.sink.endpoint.httpClient

Sets a custom HttpClient to be used by the producer

null

MEDIUM

camel.sink.endpoint.httpClientConfigurer

Register a custom configuration strategy for new HttpClient instances created by producers or consumers such as to configure authentication mechanisms etc.

null

MEDIUM

camel.sink.endpoint.httpClientOptions

To configure the HttpClient using the key/values from the Map.

null

MEDIUM

camel.sink.endpoint.httpContext

To use a custom HttpContext instance

null

MEDIUM

camel.sink.endpoint.mapHttpMessageBody

If this option is true then IN exchange Body of the exchange will be mapped to HTTP body. Setting this to false will avoid the HTTP mapping.

true

MEDIUM

camel.sink.endpoint.mapHttpMessageFormUrlEncoded Body

If this option is true then IN exchange Form Encoded body of the exchange will be mapped to HTTP. Setting this to false will avoid the HTTP Form Encoded body mapping.

true

MEDIUM

camel.sink.endpoint.mapHttpMessageHeaders

If this option is true then IN exchange Headers of the exchange will be mapped to HTTP headers. Setting this to false will avoid the HTTP Headers mapping.

true

MEDIUM

camel.sink.endpoint.maxTotalConnections

The maximum number of connections.

200

MEDIUM

camel.sink.endpoint.synchronous

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

false

MEDIUM

camel.sink.endpoint.useSystemProperties

To use System Properties as fallback for configuration

false

MEDIUM

camel.sink.endpoint.proxyAuthDomain

Proxy authentication domain to use with NTML

null

MEDIUM

camel.sink.endpoint.proxyAuthHost