Package org.apache.camel.builder.endpoint.dsl

Interface KafkaEndpointBuilderFactory.KafkaEndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver, KafkaEndpointBuilderFactory.KafkaEndpointConsumerBuilder, KafkaEndpointBuilderFactory.KafkaEndpointProducerBuilder

Enclosing interface:

KafkaEndpointBuilderFactory

public static interface KafkaEndpointBuilderFactory.KafkaEndpointBuilder
extends KafkaEndpointBuilderFactory.KafkaEndpointConsumerBuilder, KafkaEndpointBuilderFactory.KafkaEndpointProducerBuilder

Builder for endpoint for the Kafka component.

Method Summary

Modifier and Type	Method	Description
default KafkaEndpointBuilderFactory.KafkaEndpointBuilder	additionalProperties(String key, Object value)	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..
default KafkaEndpointBuilderFactory.KafkaEndpointBuilder	additionalProperties(Map values)	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..
default KafkaEndpointBuilderFactory.AdvancedKafkaEndpointBuilder	advanced()
default KafkaEndpointBuilderFactory.KafkaEndpointBuilder	brokers(String brokers)	URL of the Kafka brokers to use.
default KafkaEndpointBuilderFactory.KafkaEndpointBuilder	clientId(String clientId)	The client id is a user-specified string sent in each request to help trace calls.
default KafkaEndpointBuilderFactory.KafkaEndpointBuilder	headerFilterStrategy(String headerFilterStrategy)	To use a custom HeaderFilterStrategy to filter header to and from Camel message.
default KafkaEndpointBuilderFactory.KafkaEndpointBuilder	headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)	To use a custom HeaderFilterStrategy to filter header to and from Camel message.
default KafkaEndpointBuilderFactory.KafkaEndpointBuilder	interceptorClasses(String interceptorClasses)	Sets interceptors for producer or consumers.
default KafkaEndpointBuilderFactory.KafkaEndpointBuilder	kerberosBeforeReloginMinTime(Integer kerberosBeforeReloginMinTime)	Login thread sleep time between refresh attempts.
default KafkaEndpointBuilderFactory.KafkaEndpointBuilder	kerberosBeforeReloginMinTime(String kerberosBeforeReloginMinTime)	Login thread sleep time between refresh attempts.
default KafkaEndpointBuilderFactory.KafkaEndpointBuilder	kerberosInitCmd(String kerberosInitCmd)	Kerberos kinit command path.
default KafkaEndpointBuilderFactory.KafkaEndpointBuilder	kerberosPrincipalToLocalRules(String kerberosPrincipalToLocalRules)	A list of rules for mapping from principal names to short names (typically operating system usernames).
default KafkaEndpointBuilderFactory.KafkaEndpointBuilder	kerberosRenewJitter(Double kerberosRenewJitter)	Percentage of random jitter added to the renewal time.
default KafkaEndpointBuilderFactory.KafkaEndpointBuilder	kerberosRenewJitter(String kerberosRenewJitter)	Percentage of random jitter added to the renewal time.
default KafkaEndpointBuilderFactory.KafkaEndpointBuilder	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.
default KafkaEndpointBuilderFactory.KafkaEndpointBuilder	kerberosRenewWindowFactor(String 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.
default KafkaEndpointBuilderFactory.KafkaEndpointBuilder	reconnectBackoffMaxMs(Integer reconnectBackoffMaxMs)	The maximum amount of time in milliseconds to wait when reconnecting to a broker that has repeatedly failed to connect.
default KafkaEndpointBuilderFactory.KafkaEndpointBuilder	reconnectBackoffMaxMs(String reconnectBackoffMaxMs)	The maximum amount of time in milliseconds to wait when reconnecting to a broker that has repeatedly failed to connect.
default KafkaEndpointBuilderFactory.KafkaEndpointBuilder	saslJaasConfig(String saslJaasConfig)	Expose the kafka sasl.jaas.config parameter Example: org.apache.kafka.common.security.plain.PlainLoginModule required username=USERNAME password=PASSWORD;.
default KafkaEndpointBuilderFactory.KafkaEndpointBuilder	saslKerberosServiceName(String saslKerberosServiceName)	The Kerberos principal name that Kafka runs as.
default KafkaEndpointBuilderFactory.KafkaEndpointBuilder	saslMechanism(String saslMechanism)	The Simple Authentication and Security Layer (SASL) Mechanism used.
default KafkaEndpointBuilderFactory.KafkaEndpointBuilder	schemaRegistryURL(String schemaRegistryURL)	URL of the Confluent Platform schema registry servers to use.
default KafkaEndpointBuilderFactory.KafkaEndpointBuilder	securityProtocol(String securityProtocol)	Protocol used to communicate with brokers.
default KafkaEndpointBuilderFactory.KafkaEndpointBuilder	shutdownTimeout(int shutdownTimeout)	Timeout in milliseconds to wait gracefully for the consumer or producer to shutdown and terminate its worker threads.
default KafkaEndpointBuilderFactory.KafkaEndpointBuilder	shutdownTimeout(String shutdownTimeout)	Timeout in milliseconds to wait gracefully for the consumer or producer to shutdown and terminate its worker threads.
default KafkaEndpointBuilderFactory.KafkaEndpointBuilder	sslCipherSuites(String sslCipherSuites)	A list of cipher suites.
default KafkaEndpointBuilderFactory.KafkaEndpointBuilder	sslContextParameters(Object sslContextParameters)	SSL configuration using a Camel SSLContextParameters object.
default KafkaEndpointBuilderFactory.KafkaEndpointBuilder	sslContextParameters(String sslContextParameters)	SSL configuration using a Camel SSLContextParameters object.
default KafkaEndpointBuilderFactory.KafkaEndpointBuilder	sslEnabledProtocols(String sslEnabledProtocols)	The list of protocols enabled for SSL connections.
default KafkaEndpointBuilderFactory.KafkaEndpointBuilder	sslEndpointAlgorithm(String sslEndpointAlgorithm)	The endpoint identification algorithm to validate server hostname using server certificate.
default KafkaEndpointBuilderFactory.KafkaEndpointBuilder	sslKeymanagerAlgorithm(String sslKeymanagerAlgorithm)	The algorithm used by key manager factory for SSL connections.
default KafkaEndpointBuilderFactory.KafkaEndpointBuilder	sslKeystoreType(String sslKeystoreType)	The file format of the key store file.
default KafkaEndpointBuilderFactory.KafkaEndpointBuilder	sslProtocol(String sslProtocol)	The SSL protocol used to generate the SSLContext.
default KafkaEndpointBuilderFactory.KafkaEndpointBuilder	sslProvider(String sslProvider)	The name of the security provider used for SSL connections.
default KafkaEndpointBuilderFactory.KafkaEndpointBuilder	sslTrustmanagerAlgorithm(String sslTrustmanagerAlgorithm)	The algorithm used by trust manager factory for SSL connections.
default KafkaEndpointBuilderFactory.KafkaEndpointBuilder	sslTruststoreType(String sslTruststoreType)	The file format of the trust store file.

Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.KafkaEndpointBuilderFactory.KafkaEndpointConsumerBuilder

allowManualCommit, allowManualCommit, autoCommitEnable, autoCommitEnable, autoCommitIntervalMs, autoCommitIntervalMs, autoCommitOnStop, autoOffsetReset, breakOnFirstError, breakOnFirstError, bridgeErrorHandler, bridgeErrorHandler, checkCrcs, checkCrcs, commitTimeoutMs, commitTimeoutMs, consumerRequestTimeoutMs, consumerRequestTimeoutMs, consumersCount, consumersCount, fetchMaxBytes, fetchMaxBytes, fetchMinBytes, fetchMinBytes, fetchWaitMaxMs, fetchWaitMaxMs, groupId, groupInstanceId, headerDeserializer, headerDeserializer, heartbeatIntervalMs, heartbeatIntervalMs, keyDeserializer, maxPartitionFetchBytes, maxPartitionFetchBytes, maxPollIntervalMs, maxPollIntervalMs, maxPollRecords, maxPollRecords, offsetRepository, offsetRepository, partitionAssignor, pollOnError, pollOnError, pollTimeoutMs, pollTimeoutMs, resumeStrategy, resumeStrategy, seekTo, sessionTimeoutMs, sessionTimeoutMs, specificAvroReader, specificAvroReader, topicIsPattern, topicIsPattern, valueDeserializer

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.KafkaEndpointBuilderFactory.KafkaEndpointProducerBuilder

bufferMemorySize, bufferMemorySize, compressionCodec, connectionMaxIdleMs, connectionMaxIdleMs, deliveryTimeoutMs, deliveryTimeoutMs, enableIdempotence, enableIdempotence, headerSerializer, headerSerializer, key, keySerializer, lazyStartProducer, lazyStartProducer, lingerMs, lingerMs, maxBlockMs, maxBlockMs, maxInFlightRequest, maxInFlightRequest, maxRequestSize, maxRequestSize, metadataMaxAgeMs, metadataMaxAgeMs, metricReporters, metricsSampleWindowMs, metricsSampleWindowMs, noOfMetricsSample, noOfMetricsSample, partitioner, partitionKey, partitionKey, producerBatchSize, producerBatchSize, queueBufferingMaxMessages, queueBufferingMaxMessages, receiveBufferBytes, receiveBufferBytes, reconnectBackoffMs, reconnectBackoffMs, recordMetadata, recordMetadata, requestRequiredAcks, requestTimeoutMs, requestTimeoutMs, retries, retries, retryBackoffMs, retryBackoffMs, sendBufferBytes, sendBufferBytes, sslKeyPassword, sslKeystoreLocation, sslKeystorePassword, sslTruststoreLocation, sslTruststorePassword, valueSerializer, workerPool, workerPool, workerPoolCoreSize, workerPoolCoreSize, workerPoolMaxSize, workerPoolMaxSize

Method Detail

advanced

default KafkaEndpointBuilderFactory.AdvancedKafkaEndpointBuilder advanced()

Specified by:

advanced in interface KafkaEndpointBuilderFactory.KafkaEndpointConsumerBuilder

Specified by:

advanced in interface KafkaEndpointBuilderFactory.KafkaEndpointProducerBuilder

additionalProperties

default KafkaEndpointBuilderFactory.KafkaEndpointBuilder additionalProperties(String key,
                                                                              Object value)

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. The option is multivalued, and you can use the additionalProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: common

Specified by:

additionalProperties in interface KafkaEndpointBuilderFactory.KafkaEndpointConsumerBuilder

Specified by:

additionalProperties in interface KafkaEndpointBuilderFactory.KafkaEndpointProducerBuilder

Parameters:

key - the option key

value - the option value

Returns:

the dsl builder

additionalProperties

default KafkaEndpointBuilderFactory.KafkaEndpointBuilder additionalProperties(Map values)

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. The option is multivalued, and you can use the additionalProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: common

Specified by:

additionalProperties in interface KafkaEndpointBuilderFactory.KafkaEndpointConsumerBuilder

Specified by:

additionalProperties in interface KafkaEndpointBuilderFactory.KafkaEndpointProducerBuilder

Parameters:

values - the values

Returns:

the dsl builder

brokers

default KafkaEndpointBuilderFactory.KafkaEndpointBuilder 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

Specified by:

brokers in interface KafkaEndpointBuilderFactory.KafkaEndpointConsumerBuilder

Specified by:

brokers in interface KafkaEndpointBuilderFactory.KafkaEndpointProducerBuilder

Parameters:

brokers - the value to set

Returns:

the dsl builder

clientId

default KafkaEndpointBuilderFactory.KafkaEndpointBuilder 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

Specified by:

clientId in interface KafkaEndpointBuilderFactory.KafkaEndpointConsumerBuilder

Specified by:

clientId in interface KafkaEndpointBuilderFactory.KafkaEndpointProducerBuilder

Parameters:

clientId - the value to set

Returns:

the dsl builder

headerFilterStrategy

default KafkaEndpointBuilderFactory.KafkaEndpointBuilder 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

Specified by:

headerFilterStrategy in interface KafkaEndpointBuilderFactory.KafkaEndpointConsumerBuilder

Specified by:

headerFilterStrategy in interface KafkaEndpointBuilderFactory.KafkaEndpointProducerBuilder

Parameters:

headerFilterStrategy - the value to set

Returns:

the dsl builder

headerFilterStrategy

default KafkaEndpointBuilderFactory.KafkaEndpointBuilder headerFilterStrategy(String headerFilterStrategy)

To use a custom HeaderFilterStrategy to filter header to and from Camel message. The option will be converted to a <code>org.apache.camel.spi.HeaderFilterStrategy</code> type. Group: common

Specified by:

headerFilterStrategy in interface KafkaEndpointBuilderFactory.KafkaEndpointConsumerBuilder

Specified by:

headerFilterStrategy in interface KafkaEndpointBuilderFactory.KafkaEndpointProducerBuilder

Parameters:

headerFilterStrategy - the value to set

Returns:

the dsl builder

reconnectBackoffMaxMs

default KafkaEndpointBuilderFactory.KafkaEndpointBuilder 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

Specified by:

reconnectBackoffMaxMs in interface KafkaEndpointBuilderFactory.KafkaEndpointConsumerBuilder

Specified by:

reconnectBackoffMaxMs in interface KafkaEndpointBuilderFactory.KafkaEndpointProducerBuilder

Parameters:

reconnectBackoffMaxMs - the value to set

Returns:

the dsl builder

reconnectBackoffMaxMs

default KafkaEndpointBuilderFactory.KafkaEndpointBuilder reconnectBackoffMaxMs(String 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 will be converted to a <code>java.lang.Integer</code> type. Default: 1000 Group: common

Specified by:

reconnectBackoffMaxMs in interface KafkaEndpointBuilderFactory.KafkaEndpointConsumerBuilder

Specified by:

reconnectBackoffMaxMs in interface KafkaEndpointBuilderFactory.KafkaEndpointProducerBuilder

Parameters:

reconnectBackoffMaxMs - the value to set

Returns:

the dsl builder

shutdownTimeout

default KafkaEndpointBuilderFactory.KafkaEndpointBuilder 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

Specified by:

shutdownTimeout in interface KafkaEndpointBuilderFactory.KafkaEndpointConsumerBuilder

Specified by:

shutdownTimeout in interface KafkaEndpointBuilderFactory.KafkaEndpointProducerBuilder

Parameters:

shutdownTimeout - the value to set

Returns:

the dsl builder

shutdownTimeout

default KafkaEndpointBuilderFactory.KafkaEndpointBuilder shutdownTimeout(String shutdownTimeout)

Timeout in milliseconds to wait gracefully for the consumer or producer to shutdown and terminate its worker threads. The option will be converted to a <code>int</code> type. Default: 30000 Group: common

Specified by:

shutdownTimeout in interface KafkaEndpointBuilderFactory.KafkaEndpointConsumerBuilder

Specified by:

shutdownTimeout in interface KafkaEndpointBuilderFactory.KafkaEndpointProducerBuilder

Parameters:

shutdownTimeout - the value to set

Returns:

the dsl builder

schemaRegistryURL

default KafkaEndpointBuilderFactory.KafkaEndpointBuilder schemaRegistryURL(String schemaRegistryURL)

URL of the Confluent Platform schema registry servers to use. The format is host1:port1,host2:port2. This is known as schema.registry.url in the Confluent Platform documentation. This option is only available in the Confluent Platform (not standard Apache Kafka). The option is a: <code>java.lang.String</code> type. Group: confluent

Specified by:

schemaRegistryURL in interface KafkaEndpointBuilderFactory.KafkaEndpointConsumerBuilder

Specified by:

schemaRegistryURL in interface KafkaEndpointBuilderFactory.KafkaEndpointProducerBuilder

Parameters:

schemaRegistryURL - the value to set

Returns:

the dsl builder

interceptorClasses

default KafkaEndpointBuilderFactory.KafkaEndpointBuilder 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

Specified by:

interceptorClasses in interface KafkaEndpointBuilderFactory.KafkaEndpointConsumerBuilder

Specified by:

interceptorClasses in interface KafkaEndpointBuilderFactory.KafkaEndpointProducerBuilder

Parameters:

interceptorClasses - the value to set

Returns:

the dsl builder

kerberosBeforeReloginMinTime

default KafkaEndpointBuilderFactory.KafkaEndpointBuilder kerberosBeforeReloginMinTime(Integer kerberosBeforeReloginMinTime)

Login thread sleep time between refresh attempts. The option is a: <code>java.lang.Integer</code> type. Default: 60000 Group: security

Specified by:

kerberosBeforeReloginMinTime in interface KafkaEndpointBuilderFactory.KafkaEndpointConsumerBuilder

Specified by:

kerberosBeforeReloginMinTime in interface KafkaEndpointBuilderFactory.KafkaEndpointProducerBuilder

Parameters:

kerberosBeforeReloginMinTime - the value to set

Returns:

the dsl builder

kerberosBeforeReloginMinTime

default KafkaEndpointBuilderFactory.KafkaEndpointBuilder kerberosBeforeReloginMinTime(String kerberosBeforeReloginMinTime)

Login thread sleep time between refresh attempts. The option will be converted to a <code>java.lang.Integer</code> type. Default: 60000 Group: security

Specified by:

kerberosBeforeReloginMinTime in interface KafkaEndpointBuilderFactory.KafkaEndpointConsumerBuilder

Specified by:

kerberosBeforeReloginMinTime in interface KafkaEndpointBuilderFactory.KafkaEndpointProducerBuilder

Parameters:

kerberosBeforeReloginMinTime - the value to set

Returns:

the dsl builder

kerberosInitCmd

default KafkaEndpointBuilderFactory.KafkaEndpointBuilder 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

Specified by:

kerberosInitCmd in interface KafkaEndpointBuilderFactory.KafkaEndpointConsumerBuilder

Specified by:

kerberosInitCmd in interface KafkaEndpointBuilderFactory.KafkaEndpointProducerBuilder

Parameters:

kerberosInitCmd - the value to set

Returns:

the dsl builder

kerberosPrincipalToLocalRules

default KafkaEndpointBuilderFactory.KafkaEndpointBuilder 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.. Multiple values can be separated by comma. The option is a: <code>java.lang.String</code> type. Default: DEFAULT Group: security

Specified by:

kerberosPrincipalToLocalRules in interface KafkaEndpointBuilderFactory.KafkaEndpointConsumerBuilder

Specified by:

kerberosPrincipalToLocalRules in interface KafkaEndpointBuilderFactory.KafkaEndpointProducerBuilder

Parameters:

kerberosPrincipalToLocalRules - the value to set

Returns:

the dsl builder

kerberosRenewJitter

default KafkaEndpointBuilderFactory.KafkaEndpointBuilder 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

Specified by:

kerberosRenewJitter in interface KafkaEndpointBuilderFactory.KafkaEndpointConsumerBuilder

Specified by:

kerberosRenewJitter in interface KafkaEndpointBuilderFactory.KafkaEndpointProducerBuilder

Parameters:

kerberosRenewJitter - the value to set

Returns:

the dsl builder

kerberosRenewJitter

default KafkaEndpointBuilderFactory.KafkaEndpointBuilder kerberosRenewJitter(String kerberosRenewJitter)

Percentage of random jitter added to the renewal time. The option will be converted to a <code>java.lang.Double</code> type. Default: 0.05 Group: security

Specified by:

kerberosRenewJitter in interface KafkaEndpointBuilderFactory.KafkaEndpointConsumerBuilder

Specified by:

kerberosRenewJitter in interface KafkaEndpointBuilderFactory.KafkaEndpointProducerBuilder

Parameters:

kerberosRenewJitter - the value to set

Returns:

the dsl builder

kerberosRenewWindowFactor

default KafkaEndpointBuilderFactory.KafkaEndpointBuilder 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

Specified by:

kerberosRenewWindowFactor in interface KafkaEndpointBuilderFactory.KafkaEndpointConsumerBuilder

Specified by:

kerberosRenewWindowFactor in interface KafkaEndpointBuilderFactory.KafkaEndpointProducerBuilder

Parameters:

kerberosRenewWindowFactor - the value to set

Returns:

the dsl builder

kerberosRenewWindowFactor

default KafkaEndpointBuilderFactory.KafkaEndpointBuilder kerberosRenewWindowFactor(String 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 will be converted to a <code>java.lang.Double</code> type. Default: 0.8 Group: security

Specified by:

kerberosRenewWindowFactor in interface KafkaEndpointBuilderFactory.KafkaEndpointConsumerBuilder

Specified by:

kerberosRenewWindowFactor in interface KafkaEndpointBuilderFactory.KafkaEndpointProducerBuilder

Parameters:

kerberosRenewWindowFactor - the value to set

Returns:

the dsl builder

saslJaasConfig

default KafkaEndpointBuilderFactory.KafkaEndpointBuilder 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

Specified by:

saslJaasConfig in interface KafkaEndpointBuilderFactory.KafkaEndpointConsumerBuilder

Specified by:

saslJaasConfig in interface KafkaEndpointBuilderFactory.KafkaEndpointProducerBuilder

Parameters:

saslJaasConfig - the value to set

Returns:

the dsl builder

saslKerberosServiceName

default KafkaEndpointBuilderFactory.KafkaEndpointBuilder 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

Specified by:

saslKerberosServiceName in interface KafkaEndpointBuilderFactory.KafkaEndpointConsumerBuilder

Specified by:

saslKerberosServiceName in interface KafkaEndpointBuilderFactory.KafkaEndpointProducerBuilder

Parameters:

saslKerberosServiceName - the value to set

Returns:

the dsl builder

saslMechanism

default KafkaEndpointBuilderFactory.KafkaEndpointBuilder 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

Specified by:

saslMechanism in interface KafkaEndpointBuilderFactory.KafkaEndpointConsumerBuilder

Specified by:

saslMechanism in interface KafkaEndpointBuilderFactory.KafkaEndpointProducerBuilder

Parameters:

saslMechanism - the value to set

Returns:

the dsl builder

securityProtocol

default KafkaEndpointBuilderFactory.KafkaEndpointBuilder securityProtocol(String securityProtocol)

Protocol used to communicate with brokers. SASL_PLAINTEXT, PLAINTEXT and SSL are supported. The option is a: <code>java.lang.String</code> type. Default: PLAINTEXT Group: security

Specified by:

securityProtocol in interface KafkaEndpointBuilderFactory.KafkaEndpointConsumerBuilder

Specified by:

securityProtocol in interface KafkaEndpointBuilderFactory.KafkaEndpointProducerBuilder

Parameters:

securityProtocol - the value to set

Returns:

the dsl builder

sslCipherSuites

default KafkaEndpointBuilderFactory.KafkaEndpointBuilder 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

Specified by:

sslCipherSuites in interface KafkaEndpointBuilderFactory.KafkaEndpointConsumerBuilder

Specified by:

sslCipherSuites in interface KafkaEndpointBuilderFactory.KafkaEndpointProducerBuilder

Parameters:

sslCipherSuites - the value to set

Returns:

the dsl builder

sslContextParameters

default KafkaEndpointBuilderFactory.KafkaEndpointBuilder sslContextParameters(Object 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

Specified by:

sslContextParameters in interface KafkaEndpointBuilderFactory.KafkaEndpointConsumerBuilder

Specified by:

sslContextParameters in interface KafkaEndpointBuilderFactory.KafkaEndpointProducerBuilder

Parameters:

sslContextParameters - the value to set

Returns:

the dsl builder

sslContextParameters

default KafkaEndpointBuilderFactory.KafkaEndpointBuilder sslContextParameters(String 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 will be converted to a <code>org.apache.camel.support.jsse.SSLContextParameters</code> type. Group: security

Specified by:

sslContextParameters in interface KafkaEndpointBuilderFactory.KafkaEndpointConsumerBuilder

Specified by:

sslContextParameters in interface KafkaEndpointBuilderFactory.KafkaEndpointProducerBuilder

Parameters:

sslContextParameters - the value to set

Returns:

the dsl builder

sslEnabledProtocols

default KafkaEndpointBuilderFactory.KafkaEndpointBuilder sslEnabledProtocols(String sslEnabledProtocols)

The list of protocols enabled for SSL connections. TLSv1.2, TLSv1.1 and TLSv1 are enabled by default. The option is a: <code>java.lang.String</code> type. Group: security

Specified by:

sslEnabledProtocols in interface KafkaEndpointBuilderFactory.KafkaEndpointConsumerBuilder

Specified by:

sslEnabledProtocols in interface KafkaEndpointBuilderFactory.KafkaEndpointProducerBuilder

Parameters:

sslEnabledProtocols - the value to set

Returns:

the dsl builder

sslEndpointAlgorithm

default KafkaEndpointBuilderFactory.KafkaEndpointBuilder sslEndpointAlgorithm(String sslEndpointAlgorithm)

The endpoint identification algorithm to validate server hostname using server certificate. The option is a: <code>java.lang.String</code> type. Default: https Group: security

Specified by:

sslEndpointAlgorithm in interface KafkaEndpointBuilderFactory.KafkaEndpointConsumerBuilder

Specified by:

sslEndpointAlgorithm in interface KafkaEndpointBuilderFactory.KafkaEndpointProducerBuilder

Parameters:

sslEndpointAlgorithm - the value to set

Returns:

the dsl builder

sslKeymanagerAlgorithm

default KafkaEndpointBuilderFactory.KafkaEndpointBuilder 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

Specified by:

sslKeymanagerAlgorithm in interface KafkaEndpointBuilderFactory.KafkaEndpointConsumerBuilder

Specified by:

sslKeymanagerAlgorithm in interface KafkaEndpointBuilderFactory.KafkaEndpointProducerBuilder

Parameters:

sslKeymanagerAlgorithm - the value to set

Returns:

the dsl builder

sslKeystoreType

default KafkaEndpointBuilderFactory.KafkaEndpointBuilder 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

Specified by:

sslKeystoreType in interface KafkaEndpointBuilderFactory.KafkaEndpointConsumerBuilder

Specified by:

sslKeystoreType in interface KafkaEndpointBuilderFactory.KafkaEndpointProducerBuilder

Parameters:

sslKeystoreType - the value to set

Returns:

the dsl builder

sslProtocol

default KafkaEndpointBuilderFactory.KafkaEndpointBuilder sslProtocol(String sslProtocol)

The SSL protocol used to generate the SSLContext. Default setting is TLS, which is fine for most cases. Allowed values in recent JVMs are TLS, TLSv1.1 and TLSv1.2. SSL, SSLv2 and SSLv3 may be supported in older JVMs, but their usage is discouraged due to known security vulnerabilities. The option is a: <code>java.lang.String</code> type. Group: security

Specified by:

sslProtocol in interface KafkaEndpointBuilderFactory.KafkaEndpointConsumerBuilder

Specified by:

sslProtocol in interface KafkaEndpointBuilderFactory.KafkaEndpointProducerBuilder

Parameters:

sslProtocol - the value to set

Returns:

the dsl builder

sslProvider

default KafkaEndpointBuilderFactory.KafkaEndpointBuilder 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

Specified by:

sslProvider in interface KafkaEndpointBuilderFactory.KafkaEndpointConsumerBuilder

Specified by:

sslProvider in interface KafkaEndpointBuilderFactory.KafkaEndpointProducerBuilder

Parameters:

sslProvider - the value to set

Returns:

the dsl builder

sslTrustmanagerAlgorithm

default KafkaEndpointBuilderFactory.KafkaEndpointBuilder 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

Specified by:

sslTrustmanagerAlgorithm in interface KafkaEndpointBuilderFactory.KafkaEndpointConsumerBuilder

Specified by:

sslTrustmanagerAlgorithm in interface KafkaEndpointBuilderFactory.KafkaEndpointProducerBuilder

Parameters:

sslTrustmanagerAlgorithm - the value to set

Returns:

the dsl builder

sslTruststoreType

default KafkaEndpointBuilderFactory.KafkaEndpointBuilder 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

Specified by:

sslTruststoreType in interface KafkaEndpointBuilderFactory.KafkaEndpointConsumerBuilder

Specified by:

sslTruststoreType in interface KafkaEndpointBuilderFactory.KafkaEndpointProducerBuilder

Parameters:

sslTruststoreType - the value to set

Returns:

the dsl builder