camel-kafka-batch-source-kafka-connector source configuration

Connector Description: Receive data from Kafka topics in batch and commit them manually through KafkaManualCommit. This provides complete control over when messages are committed, allowing for custom processing logic before acknowledgment.

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

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

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

connector.class=org.apache.camel.kafkaconnector.kafkabatchsource.CamelKafkabatchsourceSourceConnector

The camel-kafka-batch-source source connector supports 25 options, which are listed below.

Name Description Default Priority

camel.kamelet.kafka-batch-source.topic

Required Comma separated list of Kafka topic names.

HIGH

camel.kamelet.kafka-batch-source.bootstrapServers

Required Comma separated list of Kafka Broker URLs.

HIGH

camel.kamelet.kafka-batch-source.saslAuthType

Authentication type to use. Use NONE for no authentication, PLAIN or SCRAM_SHA_256/SCRAM_SHA_512 for username/password, SSL for certificate-based, OAUTH for OAuth 2.0, AWS_MSK_IAM for MSK, or KERBEROS for Kerberos.

"NONE"

MEDIUM

camel.kamelet.kafka-batch-source.saslUsername

Username for SASL authentication. Required when saslAuthType is PLAIN, SCRAM_SHA_256, or SCRAM_SHA_512.

MEDIUM

camel.kamelet.kafka-batch-source.saslPassword

Password for SASL authentication. Required when saslAuthType is PLAIN, SCRAM_SHA_256, or SCRAM_SHA_512.

MEDIUM

camel.kamelet.kafka-batch-source.oauthClientId

OAuth client ID. Required when saslAuthType is OAUTH.

MEDIUM

camel.kamelet.kafka-batch-source.oauthClientSecret

OAuth client secret. Required when saslAuthType is OAUTH.

MEDIUM

camel.kamelet.kafka-batch-source.oauthTokenEndpointUri

OAuth token endpoint URI. Required when saslAuthType is OAUTH.

MEDIUM

camel.kamelet.kafka-batch-source.oauthScope

OAuth scope. Optional when saslAuthType is OAUTH.

MEDIUM

camel.kamelet.kafka-batch-source.sslTruststoreLocation

The location of the trust store file.

MEDIUM

camel.kamelet.kafka-batch-source.sslTruststorePassword

The password for the trust store file.

MEDIUM

camel.kamelet.kafka-batch-source.sslKeystoreLocation

The location of the key store file. Used for mTLS authentication.

MEDIUM

camel.kamelet.kafka-batch-source.sslKeystorePassword

The password for the key store file.

MEDIUM

camel.kamelet.kafka-batch-source.sslKeyPassword

The password of the private key in the key store file.

MEDIUM

camel.kamelet.kafka-batch-source.autoCommitEnable

If true, periodically commit to ZooKeeper the offset of messages already fetched by the consumer.

true

MEDIUM

camel.kamelet.kafka-batch-source.allowManualCommit

Whether to allow doing manual commits.

false

MEDIUM

camel.kamelet.kafka-batch-source.pollOnError

What to do if kafka threw an exception while polling for new messages. There are 5 enums and the value can be one of DISCARD, ERROR_HANDLER, RECONNECT, RETRY, STOP.

"ERROR_HANDLER"

MEDIUM

camel.kamelet.kafka-batch-source.autoOffsetReset

What to do when there is no initial offset. There are 3 enums and the value can be one of latest, earliest, none.

"latest"

MEDIUM

camel.kamelet.kafka-batch-source.consumerGroup

A string that uniquely identifies the group of consumers to which this source belongs Example: my-group-id.

MEDIUM

camel.kamelet.kafka-batch-source.deserializeHeaders

When enabled the Kamelet source will deserialize all message headers to String representation.

true

MEDIUM

camel.kamelet.kafka-batch-source.batchSize

The maximum number of records returned in a single call to poll().

500

MEDIUM

camel.kamelet.kafka-batch-source.pollTimeout

The timeout used when polling the KafkaConsumer.

5000

MEDIUM

camel.kamelet.kafka-batch-source.maxPollIntervalMs

The maximum delay between invocations of poll() when using consumer group management.

MEDIUM

camel.kamelet.kafka-batch-source.batchingIntervalMs

In consumer batching mode, then this option is specifying a time in millis, to trigger batch completion eager when the current batch size has not reached the maximum size defined by maxPollRecords. Notice the trigger is not exact at the given interval, as this can only happen between kafka polls (see pollTimeoutMs option).

MEDIUM

camel.kamelet.kafka-batch-source.topicIsPattern

Whether the topic is a pattern (regular expression). This can be used to subscribe to dynamic number of topics matching the pattern.

false

MEDIUM

The camel-kafka-batch-source source connector has no converters out of the box.

The camel-kafka-batch-source source connector has no transforms out of the box.

The camel-kafka-batch-source source connector has no aggregation strategies out of the box.