Package org.apache.camel.builder.component.dsl

Interface KafkaComponentBuilderFactory.KafkaComponentBuilder

All Superinterfaces:
ComponentBuilder<org.apache.camel.component.kafka.KafkaComponent>
All Known Implementing Classes:
KafkaComponentBuilderFactory.KafkaComponentBuilderImpl
Enclosing interface:
KafkaComponentBuilderFactory
public static interface KafkaComponentBuilderFactory.KafkaComponentBuilder extends ComponentBuilder<org.apache.camel.component.kafka.KafkaComponent>
Builder for the Kafka component.

  • Method Details

    • additionalProperties

      default KafkaComponentBuilderFactory.KafkaComponentBuilder additionalProperties(Map<String,Object> additionalProperties)
      Sets additional properties for either kafka consumer or kafka producer in case they can't be set directly on the camel configurations (e.g: new Kafka properties that are not reflected yet in Camel configurations), the properties have to be prefixed with additionalProperties.. E.g: additionalProperties.transactional.id=12345&amp;additionalProperties.schema.registry.url=http://localhost:8811/avro. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. Group: common
      Parameters:
      additionalProperties - the value to set
      Returns:
      the dsl builder

    • brokers

      default KafkaComponentBuilderFactory.KafkaComponentBuilder brokers(String brokers)
      URL of the Kafka brokers to use. The format is host1:port1,host2:port2, and the list can be a subset of brokers or a VIP pointing to a subset of brokers. This option is known as bootstrap.servers in the Kafka documentation. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      brokers - the value to set
      Returns:
      the dsl builder

    • clientId

      default KafkaComponentBuilderFactory.KafkaComponentBuilder clientId(String clientId)
      The client id is a user-specified string sent in each request to help trace calls. It should logically identify the application making the request. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      clientId - the value to set
      Returns:
      the dsl builder

    • configuration

      default KafkaComponentBuilderFactory.KafkaComponentBuilder configuration(org.apache.camel.component.kafka.KafkaConfiguration configuration)
      Allows to pre-configure the Kafka component with common options that the endpoints will reuse. The option is a: <code>org.apache.camel.component.kafka.KafkaConfiguration</code> type. Group: common
      Parameters:
      configuration - the value to set
      Returns:
      the dsl builder

    • headerFilterStrategy

      default KafkaComponentBuilderFactory.KafkaComponentBuilder headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)
      To use a custom HeaderFilterStrategy to filter header to and from Camel message. The option is a: <code>org.apache.camel.spi.HeaderFilterStrategy</code> type. Group: common
      Parameters:
      headerFilterStrategy - the value to set
      Returns:
      the dsl builder

    • reconnectBackoffMaxMs

      default KafkaComponentBuilderFactory.KafkaComponentBuilder reconnectBackoffMaxMs(Integer reconnectBackoffMaxMs)
      The maximum amount of time in milliseconds to wait when reconnecting to a broker that has repeatedly failed to connect. If provided, the backoff per host will increase exponentially for each consecutive connection failure, up to this maximum. After calculating the backoff increase, 20% random jitter is added to avoid connection storms. The option is a: <code>java.lang.Integer</code> type. Default: 1000 Group: common
      Parameters:
      reconnectBackoffMaxMs - the value to set
      Returns:
      the dsl builder

    • shutdownTimeout

      default KafkaComponentBuilderFactory.KafkaComponentBuilder shutdownTimeout(int shutdownTimeout)
      Timeout in milliseconds to wait gracefully for the consumer or producer to shutdown and terminate its worker threads. The option is a: <code>int</code> type. Default: 30000 Group: common
      Parameters:
      shutdownTimeout - the value to set
      Returns:
      the dsl builder

    • allowManualCommit

      default KafkaComponentBuilderFactory.KafkaComponentBuilder allowManualCommit(boolean allowManualCommit)
      Whether to allow doing manual commits via KafkaManualCommit. If this option is enabled then an instance of KafkaManualCommit is stored on the Exchange message header, which allows end users to access this API and perform manual offset commits via the Kafka consumer. The option is a: <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      allowManualCommit - the value to set
      Returns:
      the dsl builder

    • autoCommitEnable

      default KafkaComponentBuilderFactory.KafkaComponentBuilder autoCommitEnable(boolean autoCommitEnable)
      If true, periodically commit to ZooKeeper the offset of messages already fetched by the consumer. This committed offset will be used when the process fails as the position from which the new consumer will begin. The option is a: <code>boolean</code> type. Default: true Group: consumer
      Parameters:
      autoCommitEnable - the value to set
      Returns:
      the dsl builder

    • autoCommitIntervalMs

      default KafkaComponentBuilderFactory.KafkaComponentBuilder autoCommitIntervalMs(Integer autoCommitIntervalMs)
      The frequency in ms that the consumer offsets are committed to zookeeper. The option is a: <code>java.lang.Integer</code> type. Default: 5000 Group: consumer
      Parameters:
      autoCommitIntervalMs - the value to set
      Returns:
      the dsl builder

    • autoOffsetReset

      default KafkaComponentBuilderFactory.KafkaComponentBuilder autoOffsetReset(String autoOffsetReset)
      What to do when there is no initial offset in ZooKeeper or if an offset is out of range: earliest : automatically reset the offset to the earliest offset latest : automatically reset the offset to the latest offset fail: throw exception to the consumer. The option is a: <code>java.lang.String</code> type. Default: latest Group: consumer
      Parameters:
      autoOffsetReset - the value to set
      Returns:
      the dsl builder

    • breakOnFirstError

      default KafkaComponentBuilderFactory.KafkaComponentBuilder breakOnFirstError(boolean breakOnFirstError)
      This options controls what happens when a consumer is processing an exchange and it fails. If the option is false then the consumer continues to the next message and processes it. If the option is true then the consumer breaks out, and will seek back to offset of the message that caused a failure, and then re-attempt to process this message. However this can lead to endless processing of the same message if its bound to fail every time, eg a poison message. Therefore it is recommended to deal with that for example by using Camel's error handler. The option is a: <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      breakOnFirstError - the value to set
      Returns:
      the dsl builder

    • bridgeErrorHandler

      default KafkaComponentBuilderFactory.KafkaComponentBuilder bridgeErrorHandler(boolean 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. The option is a: <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      bridgeErrorHandler - the value to set
      Returns:
      the dsl builder

    • checkCrcs

      default KafkaComponentBuilderFactory.KafkaComponentBuilder checkCrcs(Boolean checkCrcs)
      Automatically check the CRC32 of the records consumed. This ensures no on-the-wire or on-disk corruption to the messages occurred. This check adds some overhead, so it may be disabled in cases seeking extreme performance. The option is a: <code>java.lang.Boolean</code> type. Default: true Group: consumer
      Parameters:
      checkCrcs - the value to set
      Returns:
      the dsl builder

    • commitTimeoutMs

      default KafkaComponentBuilderFactory.KafkaComponentBuilder commitTimeoutMs(Long commitTimeoutMs)
      The maximum time, in milliseconds, that the code will wait for a synchronous commit to complete. The option is a: <code>java.lang.Long</code> type. Default: 5000 Group: consumer
      Parameters:
      commitTimeoutMs - the value to set
      Returns:
      the dsl builder

    • consumerRequestTimeoutMs

      default KafkaComponentBuilderFactory.KafkaComponentBuilder consumerRequestTimeoutMs(Integer consumerRequestTimeoutMs)
      The configuration controls the maximum amount of time the client will wait for the response of a request. If the response is not received before the timeout elapses the client will resend the request if necessary or fail the request if retries are exhausted. The option is a: <code>java.lang.Integer</code> type. Default: 30000 Group: consumer
      Parameters:
      consumerRequestTimeoutMs - the value to set
      Returns:
      the dsl builder

    • consumersCount

      default KafkaComponentBuilderFactory.KafkaComponentBuilder consumersCount(int consumersCount)
      The number of consumers that connect to kafka server. Each consumer is run on a separate thread, that retrieves and process the incoming data. The option is a: <code>int</code> type. Default: 1 Group: consumer
      Parameters:
      consumersCount - the value to set
      Returns:
      the dsl builder

    • fetchMaxBytes

      default KafkaComponentBuilderFactory.KafkaComponentBuilder fetchMaxBytes(Integer fetchMaxBytes)
      The maximum amount of data the server should return for a fetch request This is not an absolute maximum, if the first message in the first non-empty partition of the fetch is larger than this value, the message will still be returned to ensure that the consumer can make progress. The maximum message size accepted by the broker is defined via message.max.bytes (broker config) or max.message.bytes (topic config). Note that the consumer performs multiple fetches in parallel. The option is a: <code>java.lang.Integer</code> type. Default: 52428800 Group: consumer
      Parameters:
      fetchMaxBytes - the value to set
      Returns:
      the dsl builder

    • fetchMinBytes

      default KafkaComponentBuilderFactory.KafkaComponentBuilder fetchMinBytes(Integer fetchMinBytes)
      The minimum amount of data the server should return for a fetch request. If insufficient data is available the request will wait for that much data to accumulate before answering the request. The option is a: <code>java.lang.Integer</code> type. Default: 1 Group: consumer
      Parameters:
      fetchMinBytes - the value to set
      Returns:
      the dsl builder

    • fetchWaitMaxMs

      default KafkaComponentBuilderFactory.KafkaComponentBuilder fetchWaitMaxMs(Integer fetchWaitMaxMs)
      The maximum amount of time the server will block before answering the fetch request if there isn't sufficient data to immediately satisfy fetch.min.bytes. The option is a: <code>java.lang.Integer</code> type. Default: 500 Group: consumer
      Parameters:
      fetchWaitMaxMs - the value to set
      Returns:
      the dsl builder

    • groupId

      default KafkaComponentBuilderFactory.KafkaComponentBuilder groupId(String groupId)
      A string that uniquely identifies the group of consumer processes to which this consumer belongs. By setting the same group id multiple processes indicate that they are all part of the same consumer group. This option is required for consumers. The option is a: <code>java.lang.String</code> type. Group: consumer
      Parameters:
      groupId - the value to set
      Returns:
      the dsl builder

    • groupInstanceId

      default KafkaComponentBuilderFactory.KafkaComponentBuilder groupInstanceId(String groupInstanceId)
      A unique identifier of the consumer instance provided by the end user. Only non-empty strings are permitted. If set, the consumer is treated as a static member, which means that only one instance with this ID is allowed in the consumer group at any time. This can be used in combination with a larger session timeout to avoid group rebalances caused by transient unavailability (e.g. process restarts). If not set, the consumer will join the group as a dynamic member, which is the traditional behavior. The option is a: <code>java.lang.String</code> type. Group: consumer
      Parameters:
      groupInstanceId - the value to set
      Returns:
      the dsl builder

    • headerDeserializer

      default KafkaComponentBuilderFactory.KafkaComponentBuilder headerDeserializer(org.apache.camel.component.kafka.serde.KafkaHeaderDeserializer headerDeserializer)
      To use a custom KafkaHeaderDeserializer to deserialize kafka headers values. The option is a: <code>org.apache.camel.component.kafka.serde.KafkaHeaderDeserializer</code> type. Group: consumer
      Parameters:
      headerDeserializer - the value to set
      Returns:
      the dsl builder

    • heartbeatIntervalMs

      default KafkaComponentBuilderFactory.KafkaComponentBuilder heartbeatIntervalMs(Integer heartbeatIntervalMs)
      The expected time between heartbeats to the consumer coordinator when using Kafka's group management facilities. Heartbeats are used to ensure that the consumer's session stays active and to facilitate rebalancing when new consumers join or leave the group. The value must be set lower than session.timeout.ms, but typically should be set no higher than 1/3 of that value. It can be adjusted even lower to control the expected time for normal rebalances. The option is a: <code>java.lang.Integer</code> type. Default: 3000 Group: consumer
      Parameters:
      heartbeatIntervalMs - the value to set
      Returns:
      the dsl builder

    • keyDeserializer

      default KafkaComponentBuilderFactory.KafkaComponentBuilder keyDeserializer(String keyDeserializer)
      Deserializer class for the key that implements the Deserializer interface. The option is a: <code>java.lang.String</code> type. Default: org.apache.kafka.common.serialization.StringDeserializer Group: consumer
      Parameters:
      keyDeserializer - the value to set
      Returns:
      the dsl builder

    • maxPartitionFetchBytes

      default KafkaComponentBuilderFactory.KafkaComponentBuilder maxPartitionFetchBytes(Integer maxPartitionFetchBytes)
      The maximum amount of data per-partition the server will return. The maximum total memory used for a request will be #partitions max.partition.fetch.bytes. This size must be at least as large as the maximum message size the server allows or else it is possible for the producer to send messages larger than the consumer can fetch. If that happens, the consumer can get stuck trying to fetch a large message on a certain partition. The option is a: <code>java.lang.Integer</code> type. Default: 1048576 Group: consumer
      Parameters:
      maxPartitionFetchBytes - the value to set
      Returns:
      the dsl builder

    • maxPollIntervalMs

      default KafkaComponentBuilderFactory.KafkaComponentBuilder maxPollIntervalMs(Integer maxPollIntervalMs)
      The maximum delay between invocations of poll() when using consumer group management. This places an upper bound on the amount of time that the consumer can be idle before fetching more records. If poll() is not called before expiration of this timeout, then the consumer is considered failed and the group will rebalance in order to reassign the partitions to another member. The option is a: <code>java.lang.Integer</code> type. Group: consumer
      Parameters:
      maxPollIntervalMs - the value to set
      Returns:
      the dsl builder

    • maxPollRecords

      default KafkaComponentBuilderFactory.KafkaComponentBuilder maxPollRecords(Integer maxPollRecords)
      The maximum number of records returned in a single call to poll(). The option is a: <code>java.lang.Integer</code> type. Default: 500 Group: consumer
      Parameters:
      maxPollRecords - the value to set
      Returns:
      the dsl builder

    • offsetRepository

      default KafkaComponentBuilderFactory.KafkaComponentBuilder offsetRepository(org.apache.camel.spi.StateRepository<String,String> offsetRepository)
      The offset repository to use in order to locally store the offset of each partition of the topic. Defining one will disable the autocommit. The option is a: <code>org.apache.camel.spi.StateRepository&lt;java.lang.String, java.lang.String&gt;</code> type. Group: consumer
      Parameters:
      offsetRepository - the value to set
      Returns:
      the dsl builder

    • partitionAssignor

      default KafkaComponentBuilderFactory.KafkaComponentBuilder partitionAssignor(String partitionAssignor)
      The class name of the partition assignment strategy that the client will use to distribute partition ownership amongst consumer instances when group management is used. The option is a: <code>java.lang.String</code> type. Default: org.apache.kafka.clients.consumer.RangeAssignor Group: consumer
      Parameters:
      partitionAssignor - the value to set
      Returns:
      the dsl builder

    • pollOnError

      default KafkaComponentBuilderFactory.KafkaComponentBuilder pollOnError(org.apache.camel.component.kafka.PollOnError pollOnError)
      What to do if kafka threw an exception while polling for new messages. Will by default use the value from the component configuration unless an explicit value has been configured on the endpoint level. DISCARD will discard the message and continue to poll next message. ERROR_HANDLER will use Camel's error handler to process the exception, and afterwards continue to poll next message. RECONNECT will re-connect the consumer and try poll the message again RETRY will let the consumer retry polling the same message again STOP will stop the consumer (have to be manually started/restarted if the consumer should be able to consume messages again). The option is a: <code>org.apache.camel.component.kafka.PollOnError</code> type. Default: ERROR_HANDLER Group: consumer
      Parameters:
      pollOnError - the value to set
      Returns:
      the dsl builder

    • pollTimeoutMs

      default KafkaComponentBuilderFactory.KafkaComponentBuilder pollTimeoutMs(Long pollTimeoutMs)
      The timeout used when polling the KafkaConsumer. The option is a: <code>java.lang.Long</code> type. Default: 5000 Group: consumer
      Parameters:
      pollTimeoutMs - the value to set
      Returns:
      the dsl builder

    • seekTo

      default KafkaComponentBuilderFactory.KafkaComponentBuilder seekTo(org.apache.camel.component.kafka.SeekPolicy seekTo)
      Set if KafkaConsumer will read from the beginning or the end on startup: SeekPolicy.BEGINNING: read from the beginning. SeekPolicy.END: read from the end. The option is a: <code>org.apache.camel.component.kafka.SeekPolicy</code> type. Group: consumer
      Parameters:
      seekTo - the value to set
      Returns:
      the dsl builder

    • sessionTimeoutMs

      default KafkaComponentBuilderFactory.KafkaComponentBuilder sessionTimeoutMs(Integer sessionTimeoutMs)
      The timeout used to detect failures when using Kafka's group management facilities. The option is a: <code>java.lang.Integer</code> type. Default: 45000 Group: consumer
      Parameters:
      sessionTimeoutMs - the value to set
      Returns:
      the dsl builder

    • specificAvroReader

      default KafkaComponentBuilderFactory.KafkaComponentBuilder specificAvroReader(boolean specificAvroReader)
      This enables the use of a specific Avro reader for use with the in multiple Schema registries documentation with Avro Deserializers implementation. This option is only available externally (not standard Apache Kafka). The option is a: <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      specificAvroReader - the value to set
      Returns:
      the dsl builder

    • topicIsPattern

      default KafkaComponentBuilderFactory.KafkaComponentBuilder topicIsPattern(boolean topicIsPattern)
      Whether the topic is a pattern (regular expression). This can be used to subscribe to dynamic number of topics matching the pattern. The option is a: <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      topicIsPattern - the value to set
      Returns:
      the dsl builder

    • valueDeserializer

      default KafkaComponentBuilderFactory.KafkaComponentBuilder valueDeserializer(String valueDeserializer)
      Deserializer class for value that implements the Deserializer interface. The option is a: <code>java.lang.String</code> type. Default: org.apache.kafka.common.serialization.StringDeserializer Group: consumer
      Parameters:
      valueDeserializer - the value to set
      Returns:
      the dsl builder

    • createConsumerBackoffInterval

      default KafkaComponentBuilderFactory.KafkaComponentBuilder createConsumerBackoffInterval(long createConsumerBackoffInterval)
      The delay in millis seconds to wait before trying again to create the kafka consumer (kafka-client). The option is a: <code>long</code> type. Default: 5000 Group: consumer (advanced)
      Parameters:
      createConsumerBackoffInterval - the value to set
      Returns:
      the dsl builder

    • createConsumerBackoffMaxAttempts

      default KafkaComponentBuilderFactory.KafkaComponentBuilder createConsumerBackoffMaxAttempts(int createConsumerBackoffMaxAttempts)
      Maximum attempts to create the kafka consumer (kafka-client), before eventually giving up and failing. Error during creating the consumer may be fatal due to invalid configuration and as such recovery is not possible. However, one part of the validation is DNS resolution of the bootstrap broker hostnames. This may be a temporary networking problem, and could potentially be recoverable. While other errors are fatal, such as some invalid kafka configurations. Unfortunately, kafka-client does not separate this kind of errors. Camel will by default retry forever, and therefore never give up. If you want to give up after many attempts then set this option and Camel will then when giving up terminate the consumer. To try again, you can manually restart the consumer by stopping, and starting the route. The option is a: <code>int</code> type. Group: consumer (advanced)
      Parameters:
      createConsumerBackoffMaxAttempts - the value to set
      Returns:
      the dsl builder

    • isolationLevel

      default KafkaComponentBuilderFactory.KafkaComponentBuilder isolationLevel(String isolationLevel)
      Controls how to read messages written transactionally. If set to read_committed, consumer.poll() will only return transactional messages which have been committed. If set to read_uncommitted (the default), consumer.poll() will return all messages, even transactional messages which have been aborted. Non-transactional messages will be returned unconditionally in either mode. Messages will always be returned in offset order. Hence, in read_committed mode, consumer.poll() will only return messages up to the last stable offset (LSO), which is the one less than the offset of the first open transaction. In particular any messages appearing after messages belonging to ongoing transactions will be withheld until the relevant transaction has been completed. As a result, read_committed consumers will not be able to read up to the high watermark when there are in flight transactions. Further, when in read_committed the seekToEnd method will return the LSO. The option is a: <code>java.lang.String</code> type. Default: read_uncommitted Group: consumer (advanced)
      Parameters:
      isolationLevel - the value to set
      Returns:
      the dsl builder

    • kafkaManualCommitFactory

      default KafkaComponentBuilderFactory.KafkaComponentBuilder kafkaManualCommitFactory(org.apache.camel.component.kafka.consumer.KafkaManualCommitFactory kafkaManualCommitFactory)
      Factory to use for creating KafkaManualCommit instances. This allows to plugin a custom factory to create custom KafkaManualCommit instances in case special logic is needed when doing manual commits that deviates from the default implementation that comes out of the box. The option is a: <code>org.apache.camel.component.kafka.consumer.KafkaManualCommitFactory</code> type. Group: consumer (advanced)
      Parameters:
      kafkaManualCommitFactory - the value to set
      Returns:
      the dsl builder

    • pollExceptionStrategy

      default KafkaComponentBuilderFactory.KafkaComponentBuilder pollExceptionStrategy(org.apache.camel.component.kafka.PollExceptionStrategy pollExceptionStrategy)
      To use a custom strategy with the consumer to control how to handle exceptions thrown from the Kafka broker while pooling messages. The option is a: <code>org.apache.camel.component.kafka.PollExceptionStrategy</code> type. Group: consumer (advanced)
      Parameters:
      pollExceptionStrategy - the value to set
      Returns:
      the dsl builder

    • subscribeConsumerBackoffInterval

      default KafkaComponentBuilderFactory.KafkaComponentBuilder subscribeConsumerBackoffInterval(long subscribeConsumerBackoffInterval)
      The delay in millis seconds to wait before trying again to subscribe to the kafka broker. The option is a: <code>long</code> type. Default: 5000 Group: consumer (advanced)
      Parameters:
      subscribeConsumerBackoffInterval - the value to set
      Returns:
      the dsl builder

    • subscribeConsumerBackoffMaxAttempts

      default KafkaComponentBuilderFactory.KafkaComponentBuilder subscribeConsumerBackoffMaxAttempts(int subscribeConsumerBackoffMaxAttempts)
      Maximum number the kafka consumer will attempt to subscribe to the kafka broker, before eventually giving up and failing. Error during subscribing the consumer to the kafka topic could be temporary errors due to network issues, and could potentially be recoverable. Camel will by default retry forever, and therefore never give up. If you want to give up after many attempts, then set this option and Camel will then when giving up terminate the consumer. You can manually restart the consumer by stopping and starting the route, to try again. The option is a: <code>int</code> type. Group: consumer (advanced)
      Parameters:
      subscribeConsumerBackoffMaxAttempts - the value to set
      Returns:
      the dsl builder

    • batchWithIndividualHeaders

      default KafkaComponentBuilderFactory.KafkaComponentBuilder batchWithIndividualHeaders(boolean batchWithIndividualHeaders)
      If this feature is enabled and a single element of a batch is an Exchange or Message, the producer will generate individual kafka header values for it by using the batch Message to determine the values. Normal behaviour consists in always using the same header values (which are determined by the parent Exchange which contains the Iterable or Iterator). The option is a: <code>boolean</code> type. Default: false Group: producer
      Parameters:
      batchWithIndividualHeaders - the value to set
      Returns:
      the dsl builder

    • bufferMemorySize

      default KafkaComponentBuilderFactory.KafkaComponentBuilder bufferMemorySize(Integer bufferMemorySize)
      The total bytes of memory the producer can use to buffer records waiting to be sent to the server. If records are sent faster than they can be delivered to the server the producer will either block or throw an exception based on the preference specified by block.on.buffer.full.This setting should correspond roughly to the total memory the producer will use, but is not a hard bound since not all memory the producer uses is used for buffering. Some additional memory will be used for compression (if compression is enabled) as well as for maintaining in-flight requests. The option is a: <code>java.lang.Integer</code> type. Default: 33554432 Group: producer
      Parameters:
      bufferMemorySize - the value to set
      Returns:
      the dsl builder

    • compressionCodec

      default KafkaComponentBuilderFactory.KafkaComponentBuilder compressionCodec(String compressionCodec)
      This parameter allows you to specify the compression codec for all data generated by this producer. Valid values are none, gzip, snappy, lz4 and zstd. The option is a: <code>java.lang.String</code> type. Default: none Group: producer
      Parameters:
      compressionCodec - the value to set
      Returns:
      the dsl builder

    • connectionMaxIdleMs

      default KafkaComponentBuilderFactory.KafkaComponentBuilder connectionMaxIdleMs(Integer connectionMaxIdleMs)
      Close idle connections after the number of milliseconds specified by this config. The option is a: <code>java.lang.Integer</code> type. Default: 540000 Group: producer
      Parameters:
      connectionMaxIdleMs - the value to set
      Returns:
      the dsl builder

    • deliveryTimeoutMs

      default KafkaComponentBuilderFactory.KafkaComponentBuilder deliveryTimeoutMs(Integer deliveryTimeoutMs)
      An upper bound on the time to report success or failure after a call to send() returns. This limits the total time that a record will be delayed prior to sending, the time to await acknowledgement from the broker (if expected), and the time allowed for retriable send failures. The option is a: <code>java.lang.Integer</code> type. Default: 120000 Group: producer
      Parameters:
      deliveryTimeoutMs - the value to set
      Returns:
      the dsl builder

    • enableIdempotence

      default KafkaComponentBuilderFactory.KafkaComponentBuilder enableIdempotence(boolean enableIdempotence)
      When set to 'true', the producer will ensure that exactly one copy of each message is written in the stream. If 'false', producer retries due to broker failures, etc., may write duplicates of the retried message in the stream. Note that enabling idempotence requires max.in.flight.requests.per.connection to be less than or equal to 5 (with message ordering preserved for any allowable value), retries to be greater than 0, and acks must be 'all'. Idempotence is enabled by default if no conflicting configurations are set. If conflicting configurations are set and idempotence is not explicitly enabled, idempotence is disabled. If idempotence is explicitly enabled and conflicting configurations are set, a ConfigException is thrown. The option is a: <code>boolean</code> type. Default: true Group: producer
      Parameters:
      enableIdempotence - the value to set
      Returns:
      the dsl builder

    • headerSerializer

      default KafkaComponentBuilderFactory.KafkaComponentBuilder headerSerializer(org.apache.camel.component.kafka.serde.KafkaHeaderSerializer headerSerializer)
      To use a custom KafkaHeaderSerializer to serialize kafka headers values. The option is a: <code>org.apache.camel.component.kafka.serde.KafkaHeaderSerializer</code> type. Group: producer
      Parameters:
      headerSerializer - the value to set
      Returns:
      the dsl builder

    • key

      default KafkaComponentBuilderFactory.KafkaComponentBuilder key(String key)
      The record key (or null if no key is specified). If this option has been configured then it take precedence over header KafkaConstants#KEY. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      key - the value to set
      Returns:
      the dsl builder

    • keySerializer

      default KafkaComponentBuilderFactory.KafkaComponentBuilder keySerializer(String keySerializer)
      The serializer class for keys (defaults to the same as for messages if nothing is given). The option is a: <code>java.lang.String</code> type. Default: org.apache.kafka.common.serialization.StringSerializer Group: producer
      Parameters:
      keySerializer - the value to set
      Returns:
      the dsl builder

    • lazyStartProducer

      default KafkaComponentBuilderFactory.KafkaComponentBuilder lazyStartProducer(boolean 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. The option is a: <code>boolean</code> type. Default: false Group: producer
      Parameters:
      lazyStartProducer - the value to set
      Returns:
      the dsl builder

    • lingerMs

      default KafkaComponentBuilderFactory.KafkaComponentBuilder lingerMs(Integer lingerMs)
      The producer groups together any records that arrive in between request transmissions into a single batched request. Normally this occurs only under load when records arrive faster than they can be sent out. However in some circumstances the client may want to reduce the number of requests even under moderate load. This setting accomplishes this by adding a small amount of artificial delay that is, rather than immediately sending out a record the producer will wait for up to the given delay to allow other records to be sent so that they can be batched together. This can be thought of as analogous to Nagle's algorithm in TCP. This setting gives the upper bound on the delay for batching: once we get batch.size worth of records for a partition it will be sent immediately regardless of this setting, however if we have fewer than this many bytes accumulated for this partition we will 'linger' for the specified time waiting for more records to show up. This setting defaults to 0 (i.e. no delay). Setting linger.ms=5, for example, would have the effect of reducing the number of requests sent but would add up to 5ms of latency to records sent in the absense of load. The option is a: <code>java.lang.Integer</code> type. Default: 0 Group: producer
      Parameters:
      lingerMs - the value to set
      Returns:
      the dsl builder

    • maxBlockMs

      default KafkaComponentBuilderFactory.KafkaComponentBuilder maxBlockMs(Integer maxBlockMs)
      The configuration controls how long the KafkaProducer's send(), partitionsFor(), initTransactions(), sendOffsetsToTransaction(), commitTransaction() and abortTransaction() methods will block. For send() this timeout bounds the total time waiting for both metadata fetch and buffer allocation (blocking in the user-supplied serializers or partitioner is not counted against this timeout). For partitionsFor() this timeout bounds the time spent waiting for metadata if it is unavailable. The transaction-related methods always block, but may time out if the transaction coordinator could not be discovered or did not respond within the timeout. The option is a: <code>java.lang.Integer</code> type. Default: 60000 Group: producer
      Parameters:
      maxBlockMs - the value to set
      Returns:
      the dsl builder

    • maxInFlightRequest

      default KafkaComponentBuilderFactory.KafkaComponentBuilder maxInFlightRequest(Integer maxInFlightRequest)
      The maximum number of unacknowledged requests the client will send on a single connection before blocking. Note that if this setting is set to be greater than 1 and there are failed sends, there is a risk of message re-ordering due to retries (i.e., if retries are enabled). The option is a: <code>java.lang.Integer</code> type. Default: 5 Group: producer
      Parameters:
      maxInFlightRequest - the value to set
      Returns:
      the dsl builder

    • maxRequestSize

      default KafkaComponentBuilderFactory.KafkaComponentBuilder maxRequestSize(Integer maxRequestSize)
      The maximum size of a request. This is also effectively a cap on the maximum record size. Note that the server has its own cap on record size which may be different from this. This setting will limit the number of record batches the producer will send in a single request to avoid sending huge requests. The option is a: <code>java.lang.Integer</code> type. Default: 1048576 Group: producer
      Parameters:
      maxRequestSize - the value to set
      Returns:
      the dsl builder

    • metadataMaxAgeMs

      default KafkaComponentBuilderFactory.KafkaComponentBuilder metadataMaxAgeMs(Integer metadataMaxAgeMs)
      The period of time in milliseconds after which we force a refresh of metadata even if we haven't seen any partition leadership changes to proactively discover any new brokers or partitions. The option is a: <code>java.lang.Integer</code> type. Default: 300000 Group: producer
      Parameters:
      metadataMaxAgeMs - the value to set
      Returns:
      the dsl builder

    • metricReporters

      default KafkaComponentBuilderFactory.KafkaComponentBuilder metricReporters(String metricReporters)
      A list of classes to use as metrics reporters. Implementing the MetricReporter interface allows plugging in classes that will be notified of new metric creation. The JmxReporter is always included to register JMX statistics. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      metricReporters - the value to set
      Returns:
      the dsl builder

    • metricsSampleWindowMs

      default KafkaComponentBuilderFactory.KafkaComponentBuilder metricsSampleWindowMs(Integer metricsSampleWindowMs)
      The window of time a metrics sample is computed over. The option is a: <code>java.lang.Integer</code> type. Default: 30000 Group: producer
      Parameters:
      metricsSampleWindowMs - the value to set
      Returns:
      the dsl builder

    • noOfMetricsSample

      default KafkaComponentBuilderFactory.KafkaComponentBuilder noOfMetricsSample(Integer noOfMetricsSample)
      The number of samples maintained to compute metrics. The option is a: <code>java.lang.Integer</code> type. Default: 2 Group: producer
      Parameters:
      noOfMetricsSample - the value to set
      Returns:
      the dsl builder

    • partitioner

      default KafkaComponentBuilderFactory.KafkaComponentBuilder partitioner(String partitioner)
      The partitioner class for partitioning messages amongst sub-topics. The default partitioner is based on the hash of the key. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      partitioner - the value to set
      Returns:
      the dsl builder

    • partitionerIgnoreKeys

      default KafkaComponentBuilderFactory.KafkaComponentBuilder partitionerIgnoreKeys(boolean partitionerIgnoreKeys)
      Whether the message keys should be ignored when computing partition. This setting has effect only when partitioner is not set. The option is a: <code>boolean</code> type. Default: false Group: producer
      Parameters:
      partitionerIgnoreKeys - the value to set
      Returns:
      the dsl builder

    • partitionKey

      default KafkaComponentBuilderFactory.KafkaComponentBuilder partitionKey(Integer partitionKey)
      The partition to which the record will be sent (or null if no partition was specified). If this option has been configured then it take precedence over header KafkaConstants#PARTITION_KEY. The option is a: <code>java.lang.Integer</code> type. Group: producer
      Parameters:
      partitionKey - the value to set
      Returns:
      the dsl builder

    • producerBatchSize

      default KafkaComponentBuilderFactory.KafkaComponentBuilder producerBatchSize(Integer producerBatchSize)
      The producer will attempt to batch records together into fewer requests whenever multiple records are being sent to the same partition. This helps performance on both the client and the server. This configuration controls the default batch size in bytes. No attempt will be made to batch records larger than this size. Requests sent to brokers will contain multiple batches, one for each partition with data available to be sent. A small batch size will make batching less common and may reduce throughput (a batch size of zero will disable batching entirely). A very large batch size may use memory a bit more wastefully as we will always allocate a buffer of the specified batch size in anticipation of additional records. The option is a: <code>java.lang.Integer</code> type. Default: 16384 Group: producer
      Parameters:
      producerBatchSize - the value to set
      Returns:
      the dsl builder

    • queueBufferingMaxMessages

      default KafkaComponentBuilderFactory.KafkaComponentBuilder queueBufferingMaxMessages(Integer queueBufferingMaxMessages)
      The maximum number of unsent messages that can be queued up the producer when using async mode before either the producer must be blocked or data must be dropped. The option is a: <code>java.lang.Integer</code> type. Default: 10000 Group: producer
      Parameters:
      queueBufferingMaxMessages - the value to set
      Returns:
      the dsl builder

    • receiveBufferBytes

      default KafkaComponentBuilderFactory.KafkaComponentBuilder receiveBufferBytes(Integer receiveBufferBytes)
      The size of the TCP receive buffer (SO_RCVBUF) to use when reading data. The option is a: <code>java.lang.Integer</code> type. Default: 65536 Group: producer
      Parameters:
      receiveBufferBytes - the value to set
      Returns:
      the dsl builder

    • reconnectBackoffMs

      default KafkaComponentBuilderFactory.KafkaComponentBuilder reconnectBackoffMs(Integer reconnectBackoffMs)
      The amount of time to wait before attempting to reconnect to a given host. This avoids repeatedly connecting to a host in a tight loop. This backoff applies to all requests sent by the consumer to the broker. The option is a: <code>java.lang.Integer</code> type. Default: 50 Group: producer
      Parameters:
      reconnectBackoffMs - the value to set
      Returns:
      the dsl builder

    • recordMetadata

      default KafkaComponentBuilderFactory.KafkaComponentBuilder recordMetadata(boolean recordMetadata)
      Whether the producer should store the RecordMetadata results from sending to Kafka. The results are stored in a List containing the RecordMetadata metadata's. The list is stored on a header with the key KafkaConstants#KAFKA_RECORDMETA. The option is a: <code>boolean</code> type. Default: true Group: producer
      Parameters:
      recordMetadata - the value to set
      Returns:
      the dsl builder

    • requestRequiredAcks

      default KafkaComponentBuilderFactory.KafkaComponentBuilder requestRequiredAcks(String requestRequiredAcks)
      The number of acknowledgments the producer requires the leader to have received before considering a request complete. This controls the durability of records that are sent. The following settings are allowed: acks=0 If set to zero then the producer will not wait for any acknowledgment from the server at all. The record will be immediately added to the socket buffer and considered sent. No guarantee can be made that the server has received the record in this case, and the retries configuration will not take effect (as the client won't generally know of any failures). The offset given back for each record will always be set to -1. acks=1 This will mean the leader will write the record to its local log but will respond without awaiting full acknowledgement from all followers. In this case should the leader fail immediately after acknowledging the record but before the followers have replicated it then the record will be lost. acks=all This means the leader will wait for the full set of in-sync replicas to acknowledge the record. This guarantees that the record will not be lost as long as at least one in-sync replica remains alive. This is the strongest available guarantee. This is equivalent to the acks=-1 setting. Note that enabling idempotence requires this config value to be 'all'. If conflicting configurations are set and idempotence is not explicitly enabled, idempotence is disabled. The option is a: <code>java.lang.String</code> type. Default: all Group: producer
      Parameters:
      requestRequiredAcks - the value to set
      Returns:
      the dsl builder

    • requestTimeoutMs

      default KafkaComponentBuilderFactory.KafkaComponentBuilder requestTimeoutMs(Integer requestTimeoutMs)
      The amount of time the broker will wait trying to meet the request.required.acks requirement before sending back an error to the client. The option is a: <code>java.lang.Integer</code> type. Default: 30000 Group: producer
      Parameters:
      requestTimeoutMs - the value to set
      Returns:
      the dsl builder

    • retries

      default KafkaComponentBuilderFactory.KafkaComponentBuilder retries(Integer retries)
      Setting a value greater than zero will cause the client to resend any record whose send fails with a potentially transient error. Note that this retry is no different than if the client resent the record upon receiving the error. Produce requests will be failed before the number of retries has been exhausted if the timeout configured by delivery.timeout.ms expires first before successful acknowledgement. Users should generally prefer to leave this config unset and instead use delivery.timeout.ms to control retry behavior. Enabling idempotence requires this config value to be greater than 0. If conflicting configurations are set and idempotence is not explicitly enabled, idempotence is disabled. Allowing retries while setting enable.idempotence to false and max.in.flight.requests.per.connection to 1 will potentially change the ordering of records because if two batches are sent to a single partition, and the first fails and is retried but the second succeeds, then the records in the second batch may appear first. The option is a: <code>java.lang.Integer</code> type. Group: producer
      Parameters:
      retries - the value to set
      Returns:
      the dsl builder

    • retryBackoffMs

      default KafkaComponentBuilderFactory.KafkaComponentBuilder retryBackoffMs(Integer retryBackoffMs)
      Before each retry, the producer refreshes the metadata of relevant topics to see if a new leader has been elected. Since the leader election takes a bit of time, this property specifies the amount of time that the producer waits before refreshing the metadata. The option is a: <code>java.lang.Integer</code> type. Default: 100 Group: producer
      Parameters:
      retryBackoffMs - the value to set
      Returns:
      the dsl builder

    • sendBufferBytes

      default KafkaComponentBuilderFactory.KafkaComponentBuilder sendBufferBytes(Integer sendBufferBytes)
      Socket write buffer size. The option is a: <code>java.lang.Integer</code> type. Default: 131072 Group: producer
      Parameters:
      sendBufferBytes - the value to set
      Returns:
      the dsl builder

    • valueSerializer

      default KafkaComponentBuilderFactory.KafkaComponentBuilder valueSerializer(String valueSerializer)
      The serializer class for messages. The option is a: <code>java.lang.String</code> type. Default: org.apache.kafka.common.serialization.StringSerializer Group: producer
      Parameters:
      valueSerializer - the value to set
      Returns:
      the dsl builder

    • workerPool

      default KafkaComponentBuilderFactory.KafkaComponentBuilder workerPool(ExecutorService workerPool)
      To use a custom worker pool for continue routing Exchange after kafka server has acknowledge the message that was sent to it from KafkaProducer using asynchronous non-blocking processing. If using this option then you must handle the lifecycle of the thread pool to shut the pool down when no longer needed. The option is a: <code>java.util.concurrent.ExecutorService</code> type. Group: producer
      Parameters:
      workerPool - the value to set
      Returns:
      the dsl builder

    • workerPoolCoreSize

      default KafkaComponentBuilderFactory.KafkaComponentBuilder workerPoolCoreSize(Integer workerPoolCoreSize)
      Number of core threads for the worker pool for continue routing Exchange after kafka server has acknowledge the message that was sent to it from KafkaProducer using asynchronous non-blocking processing. The option is a: <code>java.lang.Integer</code> type. Default: 10 Group: producer
      Parameters:
      workerPoolCoreSize - the value to set
      Returns:
      the dsl builder

    • workerPoolMaxSize

      default KafkaComponentBuilderFactory.KafkaComponentBuilder workerPoolMaxSize(Integer workerPoolMaxSize)
      Maximum number of threads for the worker pool for continue routing Exchange after kafka server has acknowledge the message that was sent to it from KafkaProducer using asynchronous non-blocking processing. The option is a: <code>java.lang.Integer</code> type. Default: 20 Group: producer
      Parameters:
      workerPoolMaxSize - the value to set
      Returns:
      the dsl builder

    • autowiredEnabled

      default KafkaComponentBuilderFactory.KafkaComponentBuilder autowiredEnabled(boolean autowiredEnabled)
      Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. The option is a: <code>boolean</code> type. Default: true Group: advanced
      Parameters:
      autowiredEnabled - the value to set
      Returns:
      the dsl builder

    • kafkaClientFactory

      default KafkaComponentBuilderFactory.KafkaComponentBuilder kafkaClientFactory(org.apache.camel.component.kafka.KafkaClientFactory kafkaClientFactory)
      Factory to use for creating org.apache.kafka.clients.consumer.KafkaConsumer and org.apache.kafka.clients.producer.KafkaProducer instances. This allows configuring a custom factory to create instances with logic that extends the vanilla Kafka clients. The option is a: <code>org.apache.camel.component.kafka.KafkaClientFactory</code> type. Group: advanced
      Parameters:
      kafkaClientFactory - the value to set
      Returns:
      the dsl builder

    • synchronous

      default KafkaComponentBuilderFactory.KafkaComponentBuilder synchronous(boolean synchronous)
      Sets whether synchronous processing should be strictly used. The option is a: <code>boolean</code> type. Default: false Group: advanced
      Parameters:
      synchronous - the value to set
      Returns:
      the dsl builder

    • healthCheckConsumerEnabled

      default KafkaComponentBuilderFactory.KafkaComponentBuilder healthCheckConsumerEnabled(boolean healthCheckConsumerEnabled)
      Used for enabling or disabling all consumer based health checks from this component. The option is a: <code>boolean</code> type. Default: true Group: health
      Parameters:
      healthCheckConsumerEnabled - the value to set
      Returns:
      the dsl builder

    • healthCheckProducerEnabled

      default KafkaComponentBuilderFactory.KafkaComponentBuilder healthCheckProducerEnabled(boolean healthCheckProducerEnabled)
      Used for enabling or disabling all producer based health checks from this component. Notice: Camel has by default disabled all producer based health-checks. You can turn on producer checks globally by setting camel.health.producersEnabled=true. The option is a: <code>boolean</code> type. Default: true Group: health
      Parameters:
      healthCheckProducerEnabled - the value to set
      Returns:
      the dsl builder

    • interceptorClasses

      default KafkaComponentBuilderFactory.KafkaComponentBuilder interceptorClasses(String interceptorClasses)
      Sets interceptors for producer or consumers. Producer interceptors have to be classes implementing org.apache.kafka.clients.producer.ProducerInterceptor Consumer interceptors have to be classes implementing org.apache.kafka.clients.consumer.ConsumerInterceptor Note that if you use Producer interceptor on a consumer it will throw a class cast exception in runtime. The option is a: <code>java.lang.String</code> type. Group: monitoring
      Parameters:
      interceptorClasses - the value to set
      Returns:
      the dsl builder

    • schemaRegistryURL

      default KafkaComponentBuilderFactory.KafkaComponentBuilder schemaRegistryURL(String schemaRegistryURL)
      URL of the schema registry servers to use. The format is host1:port1,host2:port2. This is known as schema.registry.url in multiple Schema registries documentation. This option is only available externally (not standard Apache Kafka). The option is a: <code>java.lang.String</code> type. Group: schema
      Parameters:
      schemaRegistryURL - the value to set
      Returns:
      the dsl builder

    • kerberosBeforeReloginMinTime

      default KafkaComponentBuilderFactory.KafkaComponentBuilder kerberosBeforeReloginMinTime(Integer kerberosBeforeReloginMinTime)
      Login thread sleep time between refresh attempts. The option is a: <code>java.lang.Integer</code> type. Default: 60000 Group: security
      Parameters:
      kerberosBeforeReloginMinTime - the value to set
      Returns:
      the dsl builder

    • kerberosConfigLocation

      default KafkaComponentBuilderFactory.KafkaComponentBuilder kerberosConfigLocation(String kerberosConfigLocation)
      Location of the kerberos config file. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      kerberosConfigLocation - the value to set
      Returns:
      the dsl builder

    • kerberosInitCmd

      default KafkaComponentBuilderFactory.KafkaComponentBuilder kerberosInitCmd(String kerberosInitCmd)
      Kerberos kinit command path. Default is /usr/bin/kinit. The option is a: <code>java.lang.String</code> type. Default: /usr/bin/kinit Group: security
      Parameters:
      kerberosInitCmd - the value to set
      Returns:
      the dsl builder

    • kerberosPrincipalToLocalRules

      default KafkaComponentBuilderFactory.KafkaComponentBuilder kerberosPrincipalToLocalRules(String kerberosPrincipalToLocalRules)
      A list of rules for mapping from principal names to short names (typically operating system usernames). The rules are evaluated in order and the first rule that matches a principal name is used to map it to a short name. Any later rules in the list are ignored. By default, principal names of the form {username}/{hostname}{REALM} are mapped to {username}. For more details on the format please see the security authorization and acls documentation (at the Apache Kafka project). Multiple values can be separated by comma. The option is a: <code>java.lang.String</code> type. Default: DEFAULT Group: security
      Parameters:
      kerberosPrincipalToLocalRules - the value to set
      Returns:
      the dsl builder

    • kerberosRenewJitter

      default KafkaComponentBuilderFactory.KafkaComponentBuilder kerberosRenewJitter(Double kerberosRenewJitter)
      Percentage of random jitter added to the renewal time. The option is a: <code>java.lang.Double</code> type. Default: 0.05 Group: security
      Parameters:
      kerberosRenewJitter - the value to set
      Returns:
      the dsl builder

    • kerberosRenewWindowFactor

      default KafkaComponentBuilderFactory.KafkaComponentBuilder kerberosRenewWindowFactor(Double kerberosRenewWindowFactor)
      Login thread will sleep until the specified window factor of time from last refresh to ticket's expiry has been reached, at which time it will try to renew the ticket. The option is a: <code>java.lang.Double</code> type. Default: 0.8 Group: security
      Parameters:
      kerberosRenewWindowFactor - the value to set
      Returns:
      the dsl builder

    • saslJaasConfig

      default KafkaComponentBuilderFactory.KafkaComponentBuilder saslJaasConfig(String saslJaasConfig)
      Expose the kafka sasl.jaas.config parameter Example: org.apache.kafka.common.security.plain.PlainLoginModule required username=USERNAME password=PASSWORD;. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      saslJaasConfig - the value to set
      Returns:
      the dsl builder

    • saslKerberosServiceName

      default KafkaComponentBuilderFactory.KafkaComponentBuilder saslKerberosServiceName(String saslKerberosServiceName)
      The Kerberos principal name that Kafka runs as. This can be defined either in Kafka's JAAS config or in Kafka's config. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      saslKerberosServiceName - the value to set
      Returns:
      the dsl builder

    • saslMechanism

      default KafkaComponentBuilderFactory.KafkaComponentBuilder saslMechanism(String saslMechanism)
      The Simple Authentication and Security Layer (SASL) Mechanism used. For the valid values see http://www.iana.org/assignments/sasl-mechanisms/sasl-mechanisms.xhtml. The option is a: <code>java.lang.String</code> type. Default: GSSAPI Group: security
      Parameters:
      saslMechanism - the value to set
      Returns:
      the dsl builder

    • securityProtocol

      default KafkaComponentBuilderFactory.KafkaComponentBuilder securityProtocol(String securityProtocol)
      Protocol used to communicate with brokers. SASL_PLAINTEXT, PLAINTEXT, SASL_SSL and SSL are supported. The option is a: <code>java.lang.String</code> type. Default: PLAINTEXT Group: security
      Parameters:
      securityProtocol - the value to set
      Returns:
      the dsl builder

    • sslCipherSuites

      default KafkaComponentBuilderFactory.KafkaComponentBuilder sslCipherSuites(String sslCipherSuites)
      A list of cipher suites. This is a named combination of authentication, encryption, MAC and key exchange algorithm used to negotiate the security settings for a network connection using TLS or SSL network protocol. By default all the available cipher suites are supported. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      sslCipherSuites - the value to set
      Returns:
      the dsl builder

    • sslContextParameters

      default KafkaComponentBuilderFactory.KafkaComponentBuilder sslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters)
      SSL configuration using a Camel SSLContextParameters object. If configured it's applied before the other SSL endpoint parameters. NOTE: Kafka only supports loading keystore from file locations, so prefix the location with file: in the KeyStoreParameters.resource option. The option is a: <code>org.apache.camel.support.jsse.SSLContextParameters</code> type. Group: security
      Parameters:
      sslContextParameters - the value to set
      Returns:
      the dsl builder

    • sslEnabledProtocols

      default KafkaComponentBuilderFactory.KafkaComponentBuilder sslEnabledProtocols(String sslEnabledProtocols)
      The list of protocols enabled for SSL connections. The default is TLSv1.2,TLSv1.3 when running with Java 11 or newer, TLSv1.2 otherwise. With the default value for Java 11, clients and servers will prefer TLSv1.3 if both support it and fallback to TLSv1.2 otherwise (assuming both support at least TLSv1.2). This default should be fine for most cases. Also see the config documentation for SslProtocol. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      sslEnabledProtocols - the value to set
      Returns:
      the dsl builder

    • sslEndpointAlgorithm

      default KafkaComponentBuilderFactory.KafkaComponentBuilder sslEndpointAlgorithm(String sslEndpointAlgorithm)
      The endpoint identification algorithm to validate server hostname using server certificate. Use none or false to disable server hostname verification. The option is a: <code>java.lang.String</code> type. Default: https Group: security
      Parameters:
      sslEndpointAlgorithm - the value to set
      Returns:
      the dsl builder

    • sslKeymanagerAlgorithm

      default KafkaComponentBuilderFactory.KafkaComponentBuilder sslKeymanagerAlgorithm(String sslKeymanagerAlgorithm)
      The algorithm used by key manager factory for SSL connections. Default value is the key manager factory algorithm configured for the Java Virtual Machine. The option is a: <code>java.lang.String</code> type. Default: SunX509 Group: security
      Parameters:
      sslKeymanagerAlgorithm - the value to set
      Returns:
      the dsl builder

    • sslKeyPassword

      default KafkaComponentBuilderFactory.KafkaComponentBuilder sslKeyPassword(String sslKeyPassword)
      The password of the private key in the key store file or the PEM key specified in sslKeystoreKey. This is required for clients only if two-way authentication is configured. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      sslKeyPassword - the value to set
      Returns:
      the dsl builder

    • sslKeystoreLocation

      default KafkaComponentBuilderFactory.KafkaComponentBuilder sslKeystoreLocation(String sslKeystoreLocation)
      The location of the key store file. This is optional for the client and can be used for two-way authentication for the client. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      sslKeystoreLocation - the value to set
      Returns:
      the dsl builder

    • sslKeystorePassword

      default KafkaComponentBuilderFactory.KafkaComponentBuilder sslKeystorePassword(String sslKeystorePassword)
      The store password for the key store file. This is optional for the client and only needed if sslKeystoreLocation' is configured. Key store password is not supported for PEM format. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      sslKeystorePassword - the value to set
      Returns:
      the dsl builder

    • sslKeystoreType

      default KafkaComponentBuilderFactory.KafkaComponentBuilder sslKeystoreType(String sslKeystoreType)
      The file format of the key store file. This is optional for client. Default value is JKS. The option is a: <code>java.lang.String</code> type. Default: JKS Group: security
      Parameters:
      sslKeystoreType - the value to set
      Returns:
      the dsl builder

    • sslProtocol

      default KafkaComponentBuilderFactory.KafkaComponentBuilder sslProtocol(String sslProtocol)
      The SSL protocol used to generate the SSLContext. The default is TLSv1.3 when running with Java 11 or newer, TLSv1.2 otherwise. This value should be fine for most use cases. Allowed values in recent JVMs are TLSv1.2 and TLSv1.3. TLS, TLSv1.1, SSL, SSLv2 and SSLv3 may be supported in older JVMs, but their usage is discouraged due to known security vulnerabilities. With the default value for this config and sslEnabledProtocols, clients will downgrade to TLSv1.2 if the server does not support TLSv1.3. If this config is set to TLSv1.2, clients will not use TLSv1.3 even if it is one of the values in sslEnabledProtocols and the server only supports TLSv1.3. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      sslProtocol - the value to set
      Returns:
      the dsl builder

    • sslProvider

      default KafkaComponentBuilderFactory.KafkaComponentBuilder sslProvider(String sslProvider)
      The name of the security provider used for SSL connections. Default value is the default security provider of the JVM. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      sslProvider - the value to set
      Returns:
      the dsl builder

    • sslTrustmanagerAlgorithm

      default KafkaComponentBuilderFactory.KafkaComponentBuilder sslTrustmanagerAlgorithm(String sslTrustmanagerAlgorithm)
      The algorithm used by trust manager factory for SSL connections. Default value is the trust manager factory algorithm configured for the Java Virtual Machine. The option is a: <code>java.lang.String</code> type. Default: PKIX Group: security
      Parameters:
      sslTrustmanagerAlgorithm - the value to set
      Returns:
      the dsl builder

    • sslTruststoreLocation

      default KafkaComponentBuilderFactory.KafkaComponentBuilder sslTruststoreLocation(String sslTruststoreLocation)
      The location of the trust store file. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      sslTruststoreLocation - the value to set
      Returns:
      the dsl builder

    • sslTruststorePassword

      default KafkaComponentBuilderFactory.KafkaComponentBuilder sslTruststorePassword(String sslTruststorePassword)
      The password for the trust store file. If a password is not set, trust store file configured will still be used, but integrity checking is disabled. Trust store password is not supported for PEM format. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      sslTruststorePassword - the value to set
      Returns:
      the dsl builder

    • sslTruststoreType

      default KafkaComponentBuilderFactory.KafkaComponentBuilder sslTruststoreType(String sslTruststoreType)
      The file format of the trust store file. Default value is JKS. The option is a: <code>java.lang.String</code> type. Default: JKS Group: security
      Parameters:
      sslTruststoreType - the value to set
      Returns:
      the dsl builder

    • useGlobalSslContextParameters

      default KafkaComponentBuilderFactory.KafkaComponentBuilder useGlobalSslContextParameters(boolean useGlobalSslContextParameters)
      Enable usage of global SSL context parameters. The option is a: <code>boolean</code> type. Default: false Group: security
      Parameters:
      useGlobalSslContextParameters - the value to set
      Returns:
      the dsl builder