camel-soroush-kafka-connector sink configuration

When using camel-soroush-kafka-connector as sink make sure to use the following Maven dependency to have support for the connector:

<dependency>
  <groupId>org.apache.camel.kafkaconnector</groupId>
  <artifactId>camel-soroush-kafka-connector</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel Kafka connector version -->
</dependency>

To use this Sink connector in Kafka connect you’ll need to set the following connector.class

connector.class=org.apache.camel.kafkaconnector.soroush.CamelSoroushSinkConnector

The camel-soroush sink connector supports 21 options, which are listed below.

Name	Description	Default	Required	Priority
camel.sink.path.action	The action to do. One of: [sendMessage] [getMessage] [uploadFile] [downloadFile]	null	true	HIGH
camel.sink.endpoint.connectionTimeout	Connection timeout in ms when connecting to soroush API	30000	false	MEDIUM
camel.sink.endpoint.maxConnectionRetry	Maximum connection retry when fail to connect to soroush API, if the quota is reached, MaximumConnectionRetryReachedException is thrown for that message.	4	false	MEDIUM
camel.sink.endpoint.autoDownload	Automatically download SoroushMessage.fileUrl and SoroushMessage.thumbnailUrl if exists for the message and store them in SoroushMessage.file and SoroushMessage.thumbnail field	false	false	MEDIUM
camel.sink.endpoint.autoUploadFile	Automatically upload attachments when a message goes to the sendMessage endpoint and the SoroushMessage.file (SoroushMessage.thumbnail) has been set and SoroushMessage.fileUrl(SoroushMessage.thumbnailUrl) is null	true	false	MEDIUM
camel.sink.endpoint.downloadThumbnail	If true, when downloading an attached file, thumbnail will be downloaded if provided in the message. Otherwise, only the file will be downloaded	true	false	MEDIUM
camel.sink.endpoint.forceDownload	Force to download SoroushMessage.fileUrl(SoroushMessage.thumbnailUrl) if exists, even if the SoroushMessage.file(SoroushMessage.thumbnail) was not null in that message	false	false	MEDIUM
camel.sink.endpoint.forceUpload	Force to upload SoroushMessage.file(SoroushMessage.thumbnail) if exists, even if the SoroushMessage.fileUrl(SoroushMessage.thumbnailUrl) is not null in the message	false	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	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	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	false	MEDIUM
camel.sink.endpoint.backOffStrategy	The strategy to backoff in case of connection failure. Currently 3 strategies are supported: 1. Exponential (default): It multiply retryWaitingTime by retryExponentialCoefficient after each connection failure. 2. Linear: It increase retryWaitingTime by retryLinearIncrement after each connection failure. 3. Fixed: Always use retryWaitingTime as the time between retries.	"Exponential"	false	MEDIUM
camel.sink.endpoint.maxRetryWaitingTime	Maximum amount of time (in millisecond) a thread wait before retrying failed request.	3600000L	false	MEDIUM
camel.sink.endpoint.reconnectIdleConnectionTimeout	The timeout in millisecond to reconnect the existing getMessage connection to ensure that the connection is always live and does not dead without notifying the bot. this value should not be changed.	300000L	false	MEDIUM
camel.sink.endpoint.retryExponentialCoefficient	Coefficient to compute back off time when using Exponential Back Off strategy	2L	false	MEDIUM
camel.sink.endpoint.retryLinearIncrement	The amount of time (in millisecond) which adds to waiting time when using Linear back off strategy	10000L	false	MEDIUM
camel.sink.endpoint.retryWaitingTime	Waiting time before retry failed request (Millisecond). If backOffStrategy is not Fixed this is the based value for computing back off waiting time. the first retry is always happen immediately after failure and retryWaitingTime do not apply to the first retry.	1000L	false	MEDIUM
camel.sink.endpoint.authorizationToken	The authorization token for using the bot. if uri path does not contain authorization token, this token will be used.	null	false	MEDIUM
camel.component.soroush.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	false	MEDIUM
camel.component.soroush.basicPropertyBinding	Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities	false	false	LOW
camel.component.soroush.authorizationToken	The default Soroush authorization token to be used when the information is not provided in the endpoints.	null	false	MEDIUM

Name

Description

Default

Required

Priority

camel.sink.path.action

The action to do. One of: [sendMessage] [getMessage] [uploadFile] [downloadFile]

null

true

HIGH

camel.sink.endpoint.connectionTimeout

Connection timeout in ms when connecting to soroush API

30000

false

MEDIUM

camel.sink.endpoint.maxConnectionRetry

Maximum connection retry when fail to connect to soroush API, if the quota is reached, MaximumConnectionRetryReachedException is thrown for that message.

false

MEDIUM

camel.sink.endpoint.autoDownload

Automatically download SoroushMessage.fileUrl and SoroushMessage.thumbnailUrl if exists for the message and store them in SoroushMessage.file and SoroushMessage.thumbnail field

false

MEDIUM

camel.sink.endpoint.autoUploadFile

Automatically upload attachments when a message goes to the sendMessage endpoint and the SoroushMessage.file (SoroushMessage.thumbnail) has been set and SoroushMessage.fileUrl(SoroushMessage.thumbnailUrl) is null

true

false

MEDIUM

camel.sink.endpoint.downloadThumbnail

If true, when downloading an attached file, thumbnail will be downloaded if provided in the message. Otherwise, only the file will be downloaded

true

false

MEDIUM

camel.sink.endpoint.forceDownload

Force to download SoroushMessage.fileUrl(SoroushMessage.thumbnailUrl) if exists, even if the SoroushMessage.file(SoroushMessage.thumbnail) was not null in that message

false

MEDIUM

camel.sink.endpoint.forceUpload

Force to upload SoroushMessage.file(SoroushMessage.thumbnail) if exists, even if the SoroushMessage.fileUrl(SoroushMessage.thumbnailUrl) is not null in the message

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.backOffStrategy

The strategy to backoff in case of connection failure. Currently 3 strategies are supported: 1. Exponential (default): It multiply retryWaitingTime by retryExponentialCoefficient after each connection failure. 2. Linear: It increase retryWaitingTime by retryLinearIncrement after each connection failure. 3. Fixed: Always use retryWaitingTime as the time between retries.

"Exponential"

false

MEDIUM

camel.sink.endpoint.maxRetryWaitingTime

Maximum amount of time (in millisecond) a thread wait before retrying failed request.

3600000L

false

MEDIUM

camel.sink.endpoint.reconnectIdleConnectionTimeout

The timeout in millisecond to reconnect the existing getMessage connection to ensure that the connection is always live and does not dead without notifying the bot. this value should not be changed.

300000L

false

MEDIUM

camel.sink.endpoint.retryExponentialCoefficient

Coefficient to compute back off time when using Exponential Back Off strategy

false

MEDIUM

camel.sink.endpoint.retryLinearIncrement

The amount of time (in millisecond) which adds to waiting time when using Linear back off strategy

10000L

false

MEDIUM

camel.sink.endpoint.retryWaitingTime

Waiting time before retry failed request (Millisecond). If backOffStrategy is not Fixed this is the based value for computing back off waiting time. the first retry is always happen immediately after failure and retryWaitingTime do not apply to the first retry.

1000L

false

MEDIUM

camel.sink.endpoint.authorizationToken

The authorization token for using the bot. if uri path does not contain authorization token, this token will be used.

null

false

MEDIUM

camel.component.soroush.lazyStartProducer

false

MEDIUM

camel.component.soroush.basicPropertyBinding

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

false

LOW

camel.component.soroush.authorizationToken

The default Soroush authorization token to be used when the information is not provided in the endpoints.

null

false

MEDIUM

The camel-soroush sink connector has no converters out of the box.

The camel-soroush sink connector has no transforms out of the box.

The camel-soroush sink connector has no aggregation strategies out of the box.