Class VertxKafkaConfiguration
- java.lang.Object
-
- org.apache.camel.component.vertx.kafka.configuration.BaseVertxKafkaConfiguration
-
- org.apache.camel.component.vertx.kafka.configuration.VertxKafkaConfiguration
-
- All Implemented Interfaces:
Cloneable
,org.apache.camel.spi.HeaderFilterStrategyAware
@UriParams public class VertxKafkaConfiguration extends BaseVertxKafkaConfiguration implements Cloneable
-
-
Constructor Summary
Constructors Constructor Description VertxKafkaConfiguration()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description VertxKafkaConfiguration
copy()
Properties
createConsumerConfiguration()
Properties
createProducerConfiguration()
String
getAcks()
Map<String,Object>
getAdditionalProperties()
int
getAutoCommitIntervalMs()
String
getAutoOffsetReset()
int
getBatchSize()
String
getBootstrapServers()
long
getBufferMemory()
String
getClientDnsLookup()
String
getClientId()
String
getClientRack()
String
getCompressionType()
long
getConnectionsMaxIdleMs()
int
getDefaultApiTimeoutMs()
int
getDeliveryTimeoutMs()
int
getFetchMaxBytes()
int
getFetchMaxWaitMs()
int
getFetchMinBytes()
String
getGroupId()
String
getGroupInstanceId()
int
getHeartbeatIntervalMs()
String
getInterceptorClasses()
String
getIsolationLevel()
String
getKeyDeserializer()
String
getKeySerializer()
long
getLingerMs()
long
getMaxBlockMs()
int
getMaxInFlightRequestsPerConnection()
int
getMaxPartitionFetchBytes()
int
getMaxPollIntervalMs()
int
getMaxPollRecords()
int
getMaxRequestSize()
long
getMetadataMaxAgeMs()
long
getMetadataMaxIdleMs()
String
getMetricReporters()
int
getMetricsNumSamples()
String
getMetricsRecordingLevel()
long
getMetricsSampleWindowMs()
String
getPartitionAssignmentStrategy()
String
getPartitionerClass()
Integer
getPartitionId()
int
getReceiveBufferBytes()
long
getReconnectBackoffMaxMs()
long
getReconnectBackoffMs()
int
getRequestTimeoutMs()
int
getRetries()
long
getRetryBackoffMs()
String
getSaslClientCallbackHandlerClass()
String
getSaslJaasConfig()
String
getSaslKerberosKinitCmd()
long
getSaslKerberosMinTimeBeforeRelogin()
String
getSaslKerberosServiceName()
double
getSaslKerberosTicketRenewJitter()
double
getSaslKerberosTicketRenewWindowFactor()
String
getSaslLoginCallbackHandlerClass()
String
getSaslLoginClass()
short
getSaslLoginRefreshBufferSeconds()
short
getSaslLoginRefreshMinPeriodSeconds()
double
getSaslLoginRefreshWindowFactor()
double
getSaslLoginRefreshWindowJitter()
String
getSaslMechanism()
String
getSecurityProtocol()
String
getSecurityProviders()
Long
getSeekToOffset()
String
getSeekToPosition()
int
getSendBufferBytes()
int
getSessionTimeoutMs()
String
getSslCipherSuites()
String
getSslEnabledProtocols()
String
getSslEndpointIdentificationAlgorithm()
String
getSslEngineFactoryClass()
String
getSslKeymanagerAlgorithm()
String
getSslKeyPassword()
String
getSslKeystoreLocation()
String
getSslKeystorePassword()
String
getSslKeystoreType()
String
getSslProtocol()
String
getSslProvider()
String
getSslSecureRandomImplementation()
String
getSslTrustmanagerAlgorithm()
String
getSslTruststoreLocation()
String
getSslTruststorePassword()
String
getSslTruststoreType()
String
getTopic()
String
getTransactionalId()
int
getTransactionTimeoutMs()
String
getValueDeserializer()
String
getValueSerializer()
boolean
isAllowAutoCreateTopics()
boolean
isCheckCrcs()
boolean
isEnableAutoCommit()
boolean
isEnableIdempotence()
boolean
isExcludeInternalTopics()
void
setAcks(String acks)
The number of acknowledgments the producer requires the leader to have received before considering a request complete.void
setAdditionalProperties(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.`.void
setAllowAutoCreateTopics(boolean allowAutoCreateTopics)
Allow automatic topic creation on the broker when subscribing to or assigning a topic.void
setAutoCommitIntervalMs(int autoCommitIntervalMs)
The frequency in milliseconds that the consumer offsets are auto-committed to Kafka ifenable.auto.commit
is set totrue
.void
setAutoOffsetReset(String autoOffsetReset)
What to do when there is no initial offset in Kafka or if the current offset does not exist any more on the server (e.g.void
setBatchSize(int batchSize)
The producer will attempt to batch records together into fewer requests whenever multiple records are being sent to the same partition.void
setBootstrapServers(String bootstrapServers)
A list of host/port pairs to use for establishing the initial connection to the Kafka cluster.void
setBufferMemory(long bufferMemory)
The total bytes of memory the producer can use to buffer records waiting to be sent to the server.void
setCheckCrcs(boolean checkCrcs)
Automatically check the CRC32 of the records consumed.void
setClientDnsLookup(String clientDnsLookup)
Controls how the client uses DNS lookups.void
setClientId(String clientId)
An id string to pass to the server when making requests.void
setClientRack(String clientRack)
A rack identifier for this client.void
setCompressionType(String compressionType)
The compression type for all data generated by the producer.void
setConnectionsMaxIdleMs(long connectionsMaxIdleMs)
Close idle connections after the number of milliseconds specified by this config.void
setDefaultApiTimeoutMs(int defaultApiTimeoutMs)
Specifies the timeout (in milliseconds) for client APIs.void
setDeliveryTimeoutMs(int deliveryTimeoutMs)
An upper bound on the time to report success or failure after a call tosend()
returns.void
setEnableAutoCommit(boolean enableAutoCommit)
If true the consumer's offset will be periodically committed in the background.void
setEnableIdempotence(boolean enableIdempotence)
When set to 'true', the producer will ensure that exactly one copy of each message is written in the stream.void
setExcludeInternalTopics(boolean excludeInternalTopics)
Whether internal topics matching a subscribed pattern should be excluded from the subscription.void
setFetchMaxBytes(int fetchMaxBytes)
The maximum amount of data the server should return for a fetch request.void
setFetchMaxWaitMs(int fetchMaxWaitMs)
The maximum amount of time the server will block before answering the fetch request if there isn't sufficient data to immediately satisfy the requirement given by fetch.min.bytes.void
setFetchMinBytes(int fetchMinBytes)
The minimum amount of data the server should return for a fetch request.void
setGroupId(String groupId)
A unique string that identifies the consumer group this consumer belongs to.void
setGroupInstanceId(String groupInstanceId)
A unique identifier of the consumer instance provided by the end user.void
setHeartbeatIntervalMs(int heartbeatIntervalMs)
The expected time between heartbeats to the consumer coordinator when using Kafka's group management facilities.void
setInterceptorClasses(String interceptorClasses)
A list of classes to use as interceptors.void
setIsolationLevel(String isolationLevel)
Controls how to read messages written transactionally.void
setKeyDeserializer(String keyDeserializer)
Deserializer class for key that implements theorg.apache.kafka.common.serialization.Deserializer
interface.void
setKeySerializer(String keySerializer)
Serializer class for key that implements theorg.apache.kafka.common.serialization.Serializer
interface.void
setLingerMs(long lingerMs)
The producer groups together any records that arrive in between request transmissions into a single batched request.void
setMaxBlockMs(long maxBlockMs)
The configuration controls how longKafkaProducer.send()
andKafkaProducer.partitionsFor()
will block.These methods can be blocked either because the buffer is full or metadata unavailable.Blocking in the user-supplied serializers or partitioner will not be counted against this timeout.void
setMaxInFlightRequestsPerConnection(int maxInFlightRequestsPerConnection)
The maximum number of unacknowledged requests the client will send on a single connection before blocking.void
setMaxPartitionFetchBytes(int maxPartitionFetchBytes)
The maximum amount of data per-partition the server will return.void
setMaxPollIntervalMs(int maxPollIntervalMs)
The maximum delay between invocations of poll() when using consumer group management.void
setMaxPollRecords(int maxPollRecords)
The maximum number of records returned in a single call to poll().void
setMaxRequestSize(int maxRequestSize)
The maximum size of a request in bytes.void
setMetadataMaxAgeMs(long 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.void
setMetadataMaxIdleMs(long metadataMaxIdleMs)
Controls how long the producer will cache metadata for a topic that's idle.void
setMetricReporters(String metricReporters)
A list of classes to use as metrics reporters.void
setMetricsNumSamples(int metricsNumSamples)
The number of samples maintained to compute metrics.void
setMetricsRecordingLevel(String metricsRecordingLevel)
The highest recording level for metrics.void
setMetricsSampleWindowMs(long metricsSampleWindowMs)
The window of time a metrics sample is computed over.void
setPartitionAssignmentStrategy(String partitionAssignmentStrategy)
A list of class names or class types, ordered by preference, of supported partition assignment strategies that the client will use to distribute partition ownership amongst consumer instances when group management is used.void
setPartitionerClass(String partitionerClass)
Partitioner class that implements theorg.apache.kafka.clients.producer.Partitioner
interface.void
setPartitionId(Integer partitionId)
The partition to which the record will be sent (or null if no partition was specified) or read from a particular partition if set.void
setReceiveBufferBytes(int receiveBufferBytes)
The size of the TCP receive buffer (SO_RCVBUF) to use when reading data.void
setReconnectBackoffMaxMs(long reconnectBackoffMaxMs)
The maximum amount of time in milliseconds to wait when reconnecting to a broker that has repeatedly failed to connect.void
setReconnectBackoffMs(long reconnectBackoffMs)
The base amount of time to wait before attempting to reconnect to a given host.void
setRequestTimeoutMs(int requestTimeoutMs)
The configuration controls the maximum amount of time the client will wait for the response of a request.void
setRetries(int retries)
Setting a value greater than zero will cause the client to resend any record whose send fails with a potentially transient error.void
setRetryBackoffMs(long retryBackoffMs)
The amount of time to wait before attempting to retry a failed request to a given topic partition.void
setSaslClientCallbackHandlerClass(String saslClientCallbackHandlerClass)
The fully qualified name of a SASL client callback handler class that implements the AuthenticateCallbackHandler interface.void
setSaslJaasConfig(String saslJaasConfig)
JAAS login context parameters for SASL connections in the format used by JAAS configuration files.void
setSaslKerberosKinitCmd(String saslKerberosKinitCmd)
Kerberos kinit command path.void
setSaslKerberosMinTimeBeforeRelogin(long saslKerberosMinTimeBeforeRelogin)
Login thread sleep time between refresh attempts.void
setSaslKerberosServiceName(String saslKerberosServiceName)
The Kerberos principal name that Kafka runs as.void
setSaslKerberosTicketRenewJitter(double saslKerberosTicketRenewJitter)
Percentage of random jitter added to the renewal time.void
setSaslKerberosTicketRenewWindowFactor(double saslKerberosTicketRenewWindowFactor)
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.void
setSaslLoginCallbackHandlerClass(String saslLoginCallbackHandlerClass)
The fully qualified name of a SASL login callback handler class that implements the AuthenticateCallbackHandler interface.void
setSaslLoginClass(String saslLoginClass)
The fully qualified name of a class that implements the Login interface.void
setSaslLoginRefreshBufferSeconds(short saslLoginRefreshBufferSeconds)
The amount of buffer time before credential expiration to maintain when refreshing a credential, in seconds.void
setSaslLoginRefreshMinPeriodSeconds(short saslLoginRefreshMinPeriodSeconds)
The desired minimum time for the login refresh thread to wait before refreshing a credential, in seconds.void
setSaslLoginRefreshWindowFactor(double saslLoginRefreshWindowFactor)
Login refresh thread will sleep until the specified window factor relative to the credential's lifetime has been reached, at which time it will try to refresh the credential.void
setSaslLoginRefreshWindowJitter(double saslLoginRefreshWindowJitter)
The maximum amount of random jitter relative to the credential's lifetime that is added to the login refresh thread's sleep time.void
setSaslMechanism(String saslMechanism)
SASL mechanism used for client connections.void
setSecurityProtocol(String securityProtocol)
Protocol used to communicate with brokers.void
setSecurityProviders(String securityProviders)
A list of configurable creator classes each returning a provider implementing security algorithms.void
setSeekToOffset(Long seekToOffset)
Set if KafkaConsumer will read from a particular offset on startup.void
setSeekToPosition(String seekToPosition)
Set if KafkaConsumer will read from beginning or end on startup: beginning : read from beginning end : read from end.void
setSendBufferBytes(int sendBufferBytes)
The size of the TCP send buffer (SO_SNDBUF) to use when sending data.void
setSessionTimeoutMs(int sessionTimeoutMs)
The timeout used to detect client failures when using Kafka's group management facility.void
setSslCipherSuites(String sslCipherSuites)
A list of cipher suites.void
setSslEnabledProtocols(String sslEnabledProtocols)
The list of protocols enabled for SSL connections.void
setSslEndpointIdentificationAlgorithm(String sslEndpointIdentificationAlgorithm)
The endpoint identification algorithm to validate server hostname using server certificate.void
setSslEngineFactoryClass(String sslEngineFactoryClass)
The class of type org.apache.kafka.common.security.auth.SslEngineFactory to provide SSLEngine objects.void
setSslKeymanagerAlgorithm(String sslKeymanagerAlgorithm)
The algorithm used by key manager factory for SSL connections.void
setSslKeyPassword(String sslKeyPassword)
The password of the private key in the key store file.void
setSslKeystoreLocation(String sslKeystoreLocation)
The location of the key store file.void
setSslKeystorePassword(String sslKeystorePassword)
The store password for the key store file.void
setSslKeystoreType(String sslKeystoreType)
The file format of the key store file.void
setSslProtocol(String sslProtocol)
The SSL protocol used to generate the SSLContext.void
setSslProvider(String sslProvider)
The name of the security provider used for SSL connections.void
setSslSecureRandomImplementation(String sslSecureRandomImplementation)
The SecureRandom PRNG implementation to use for SSL cryptography operations.void
setSslTrustmanagerAlgorithm(String sslTrustmanagerAlgorithm)
The algorithm used by trust manager factory for SSL connections.void
setSslTruststoreLocation(String sslTruststoreLocation)
The location of the trust store file.void
setSslTruststorePassword(String sslTruststorePassword)
The password for the trust store file.void
setSslTruststoreType(String sslTruststoreType)
The file format of the trust store file.void
setTopic(String topic)
Name of the topic to use.void
setTransactionalId(String transactionalId)
The TransactionalId to use for transactional delivery.void
setTransactionTimeoutMs(int transactionTimeoutMs)
The maximum amount of time in ms that the transaction coordinator will wait for a transaction status update from the producer before proactively aborting the ongoing transaction.If this value is larger than the transaction.max.timeout.ms setting in the broker, the request will fail with aInvalidTransactionTimeout
error.void
setValueDeserializer(String valueDeserializer)
Deserializer class for value that implements theorg.apache.kafka.common.serialization.Deserializer
interface.void
setValueSerializer(String valueSerializer)
Serializer class for value that implements theorg.apache.kafka.common.serialization.Serializer
interface.-
Methods inherited from class org.apache.camel.component.vertx.kafka.configuration.BaseVertxKafkaConfiguration
getHeaderFilterStrategy, setHeaderFilterStrategy
-
-
-
-
Method Detail
-
setPartitionId
public void setPartitionId(Integer partitionId)
The partition to which the record will be sent (or null if no partition was specified) or read from a particular partition if set. HeaderVertxKafkaConstants#PARTITION_ID
If configured, it will take precedence over this config
-
getPartitionId
public Integer getPartitionId()
-
setTopic
public void setTopic(String topic)
Name of the topic to use. On the consumer you can use comma to separate multiple topics. A producer can only send a message to a single topic.
-
getTopic
public String getTopic()
-
setBootstrapServers
public void setBootstrapServers(String bootstrapServers)
A list of host/port pairs to use for establishing the initial connection to the Kafka cluster. The client will make use of all servers irrespective of which servers are specified here for bootstrapping—this list only impacts the initial hosts used to discover the full set of servers. This list should be in the formhost1:port1,host2:port2,...
. Since these servers are just used for the initial connection to discover the full cluster membership (which may change dynamically), this list need not contain the full set of servers (you may want more than one, though, in case a server is down).
-
getBootstrapServers
public String getBootstrapServers()
-
setClientDnsLookup
public void setClientDnsLookup(String clientDnsLookup)
Controls how the client uses DNS lookups. If set touse_all_dns_ips
, connect to each returned IP address in sequence until a successful connection is established. After a disconnection, the next IP is used. Once all IPs have been used once, the client resolves the IP(s) from the hostname again (both the JVM and the OS cache DNS name lookups, however). If set toresolve_canonical_bootstrap_servers_only
, resolve each bootstrap address into a list of canonical names. After the bootstrap phase, this behaves the same asuse_all_dns_ips
. If set todefault
(deprecated), attempt to connect to the first IP address returned by the lookup, even if the lookup returns multiple IP addresses.
-
getClientDnsLookup
public String getClientDnsLookup()
-
setMetadataMaxAgeMs
public void setMetadataMaxAgeMs(long 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.
-
getMetadataMaxAgeMs
public long getMetadataMaxAgeMs()
-
setClientId
public void setClientId(String clientId)
An id string to pass to the server when making requests. The purpose of this is to be able to track the source of requests beyond just ip/port by allowing a logical application name to be included in server-side request logging.
-
getClientId
public String getClientId()
-
setSendBufferBytes
public void setSendBufferBytes(int sendBufferBytes)
The size of the TCP send buffer (SO_SNDBUF) to use when sending data. If the value is -1, the OS default will be used.
-
getSendBufferBytes
public int getSendBufferBytes()
-
setReceiveBufferBytes
public void setReceiveBufferBytes(int receiveBufferBytes)
The size of the TCP receive buffer (SO_RCVBUF) to use when reading data. If the value is -1, the OS default will be used.
-
getReceiveBufferBytes
public int getReceiveBufferBytes()
-
setReconnectBackoffMs
public void setReconnectBackoffMs(long reconnectBackoffMs)
The base 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 connection attempts by the client to a broker.
-
getReconnectBackoffMs
public long getReconnectBackoffMs()
-
setReconnectBackoffMaxMs
public void setReconnectBackoffMaxMs(long 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.
-
getReconnectBackoffMaxMs
public long getReconnectBackoffMaxMs()
-
setRetryBackoffMs
public void setRetryBackoffMs(long retryBackoffMs)
The amount of time to wait before attempting to retry a failed request to a given topic partition. This avoids repeatedly sending requests in a tight loop under some failure scenarios.
-
getRetryBackoffMs
public long getRetryBackoffMs()
-
setMetricsSampleWindowMs
public void setMetricsSampleWindowMs(long metricsSampleWindowMs)
The window of time a metrics sample is computed over.
-
getMetricsSampleWindowMs
public long getMetricsSampleWindowMs()
-
setMetricsNumSamples
public void setMetricsNumSamples(int metricsNumSamples)
The number of samples maintained to compute metrics.
-
getMetricsNumSamples
public int getMetricsNumSamples()
-
setMetricsRecordingLevel
public void setMetricsRecordingLevel(String metricsRecordingLevel)
The highest recording level for metrics.
-
getMetricsRecordingLevel
public String getMetricsRecordingLevel()
-
setMetricReporters
public void setMetricReporters(String metricReporters)
A list of classes to use as metrics reporters. Implementing theorg.apache.kafka.common.metrics.MetricsReporter
interface allows plugging in classes that will be notified of new metric creation. The JmxReporter is always included to register JMX statistics.
-
getMetricReporters
public String getMetricReporters()
-
setRequestTimeoutMs
public void setRequestTimeoutMs(int requestTimeoutMs)
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. This should be larger thanreplica.lag.time.max.ms
(a broker configuration) to reduce the possibility of message duplication due to unnecessary producer retries.
-
getRequestTimeoutMs
public int getRequestTimeoutMs()
-
setConnectionsMaxIdleMs
public void setConnectionsMaxIdleMs(long connectionsMaxIdleMs)
Close idle connections after the number of milliseconds specified by this config.
-
getConnectionsMaxIdleMs
public long getConnectionsMaxIdleMs()
-
setInterceptorClasses
public void setInterceptorClasses(String interceptorClasses)
A list of classes to use as interceptors. Implementing theorg.apache.kafka.clients.producer.ProducerInterceptor
interface allows you to intercept (and possibly mutate) the records received by the producer before they are published to the Kafka cluster. By default, there are no interceptors.
-
getInterceptorClasses
public String getInterceptorClasses()
-
setSecurityProviders
public void setSecurityProviders(String securityProviders)
A list of configurable creator classes each returning a provider implementing security algorithms. These classes should implement theorg.apache.kafka.common.security.auth.SecurityProviderCreator
interface.
-
getSecurityProviders
public String getSecurityProviders()
-
setSecurityProtocol
public void setSecurityProtocol(String securityProtocol)
Protocol used to communicate with brokers. Valid values are: PLAINTEXT, SSL, SASL_PLAINTEXT, SASL_SSL.
-
getSecurityProtocol
public String getSecurityProtocol()
-
setSslProtocol
public void setSslProtocol(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 'ssl.enabled.protocols', 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 ssl.enabled.protocols and the server only supports 'TLSv1.3'.
-
getSslProtocol
public String getSslProtocol()
-
setSslProvider
public void setSslProvider(String sslProvider)
The name of the security provider used for SSL connections. Default value is the default security provider of the JVM.
-
getSslProvider
public String getSslProvider()
-
setSslCipherSuites
public void setSslCipherSuites(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.
-
getSslCipherSuites
public String getSslCipherSuites()
-
setSslEnabledProtocols
public void setSslEnabledProtocols(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 `ssl.protocol`.
-
getSslEnabledProtocols
public String getSslEnabledProtocols()
-
setSslKeystoreType
public void setSslKeystoreType(String sslKeystoreType)
The file format of the key store file. This is optional for client.
-
getSslKeystoreType
public String getSslKeystoreType()
-
setSslKeystoreLocation
public void setSslKeystoreLocation(String sslKeystoreLocation)
The location of the key store file. This is optional for client and can be used for two-way authentication for client.
-
getSslKeystoreLocation
public String getSslKeystoreLocation()
-
setSslKeystorePassword
public void setSslKeystorePassword(String sslKeystorePassword)
The store password for the key store file. This is optional for client and only needed if ssl.keystore.location is configured.
-
getSslKeystorePassword
public String getSslKeystorePassword()
-
setSslKeyPassword
public void setSslKeyPassword(String sslKeyPassword)
The password of the private key in the key store file. This is optional for client.
-
getSslKeyPassword
public String getSslKeyPassword()
-
setSslTruststoreType
public void setSslTruststoreType(String sslTruststoreType)
The file format of the trust store file.
-
getSslTruststoreType
public String getSslTruststoreType()
-
setSslTruststoreLocation
public void setSslTruststoreLocation(String sslTruststoreLocation)
The location of the trust store file.
-
getSslTruststoreLocation
public String getSslTruststoreLocation()
-
setSslTruststorePassword
public void setSslTruststorePassword(String sslTruststorePassword)
The password for the trust store file. If a password is not set access to the truststore is still available, but integrity checking is disabled.
-
getSslTruststorePassword
public String getSslTruststorePassword()
-
setSslKeymanagerAlgorithm
public void setSslKeymanagerAlgorithm(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.
-
getSslKeymanagerAlgorithm
public String getSslKeymanagerAlgorithm()
-
setSslTrustmanagerAlgorithm
public void setSslTrustmanagerAlgorithm(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.
-
getSslTrustmanagerAlgorithm
public String getSslTrustmanagerAlgorithm()
-
setSslEndpointIdentificationAlgorithm
public void setSslEndpointIdentificationAlgorithm(String sslEndpointIdentificationAlgorithm)
The endpoint identification algorithm to validate server hostname using server certificate.
-
getSslEndpointIdentificationAlgorithm
public String getSslEndpointIdentificationAlgorithm()
-
setSslSecureRandomImplementation
public void setSslSecureRandomImplementation(String sslSecureRandomImplementation)
The SecureRandom PRNG implementation to use for SSL cryptography operations.
-
getSslSecureRandomImplementation
public String getSslSecureRandomImplementation()
-
setSslEngineFactoryClass
public void setSslEngineFactoryClass(String sslEngineFactoryClass)
The class of type org.apache.kafka.common.security.auth.SslEngineFactory to provide SSLEngine objects. Default value is org.apache.kafka.common.security.ssl.DefaultSslEngineFactory
-
getSslEngineFactoryClass
public String getSslEngineFactoryClass()
-
setSaslKerberosServiceName
public void setSaslKerberosServiceName(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.
-
getSaslKerberosServiceName
public String getSaslKerberosServiceName()
-
setSaslKerberosKinitCmd
public void setSaslKerberosKinitCmd(String saslKerberosKinitCmd)
Kerberos kinit command path.
-
getSaslKerberosKinitCmd
public String getSaslKerberosKinitCmd()
-
setSaslKerberosTicketRenewWindowFactor
public void setSaslKerberosTicketRenewWindowFactor(double saslKerberosTicketRenewWindowFactor)
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.
-
getSaslKerberosTicketRenewWindowFactor
public double getSaslKerberosTicketRenewWindowFactor()
-
setSaslKerberosTicketRenewJitter
public void setSaslKerberosTicketRenewJitter(double saslKerberosTicketRenewJitter)
Percentage of random jitter added to the renewal time.
-
getSaslKerberosTicketRenewJitter
public double getSaslKerberosTicketRenewJitter()
-
setSaslKerberosMinTimeBeforeRelogin
public void setSaslKerberosMinTimeBeforeRelogin(long saslKerberosMinTimeBeforeRelogin)
Login thread sleep time between refresh attempts.
-
getSaslKerberosMinTimeBeforeRelogin
public long getSaslKerberosMinTimeBeforeRelogin()
-
setSaslLoginRefreshWindowFactor
public void setSaslLoginRefreshWindowFactor(double saslLoginRefreshWindowFactor)
Login refresh thread will sleep until the specified window factor relative to the credential's lifetime has been reached, at which time it will try to refresh the credential. Legal values are between 0.5 (50%) and 1.0 (100%) inclusive; a default value of 0.8 (80%) is used if no value is specified. Currently applies only to OAUTHBEARER.
-
getSaslLoginRefreshWindowFactor
public double getSaslLoginRefreshWindowFactor()
-
setSaslLoginRefreshWindowJitter
public void setSaslLoginRefreshWindowJitter(double saslLoginRefreshWindowJitter)
The maximum amount of random jitter relative to the credential's lifetime that is added to the login refresh thread's sleep time. Legal values are between 0 and 0.25 (25%) inclusive; a default value of 0.05 (5%) is used if no value is specified. Currently applies only to OAUTHBEARER.
-
getSaslLoginRefreshWindowJitter
public double getSaslLoginRefreshWindowJitter()
-
setSaslLoginRefreshMinPeriodSeconds
public void setSaslLoginRefreshMinPeriodSeconds(short saslLoginRefreshMinPeriodSeconds)
The desired minimum time for the login refresh thread to wait before refreshing a credential, in seconds. Legal values are between 0 and 900 (15 minutes); a default value of 60 (1 minute) is used if no value is specified. This value and sasl.login.refresh.buffer.seconds are both ignored if their sum exceeds the remaining lifetime of a credential. Currently applies only to OAUTHBEARER.
-
getSaslLoginRefreshMinPeriodSeconds
public short getSaslLoginRefreshMinPeriodSeconds()
-
setSaslLoginRefreshBufferSeconds
public void setSaslLoginRefreshBufferSeconds(short saslLoginRefreshBufferSeconds)
The amount of buffer time before credential expiration to maintain when refreshing a credential, in seconds. If a refresh would otherwise occur closer to expiration than the number of buffer seconds then the refresh will be moved up to maintain as much of the buffer time as possible. Legal values are between 0 and 3600 (1 hour); a default value of 300 (5 minutes) is used if no value is specified. This value and sasl.login.refresh.min.period.seconds are both ignored if their sum exceeds the remaining lifetime of a credential. Currently applies only to OAUTHBEARER.
-
getSaslLoginRefreshBufferSeconds
public short getSaslLoginRefreshBufferSeconds()
-
setSaslMechanism
public void setSaslMechanism(String saslMechanism)
SASL mechanism used for client connections. This may be any mechanism for which a security provider is available. GSSAPI is the default mechanism.
-
getSaslMechanism
public String getSaslMechanism()
-
setSaslJaasConfig
public void setSaslJaasConfig(String saslJaasConfig)
JAAS login context parameters for SASL connections in the format used by JAAS configuration files. JAAS configuration file format is described here. The format for the value is: 'loginModuleClass controlFlag (optionName=optionValue)*;
'. For brokers, the config must be prefixed with listener prefix and SASL mechanism name in lower-case. For example, listener.name.sasl_ssl.scram-sha-256.sasl.jaas.config=com.example.ScramLoginModule required;
-
getSaslJaasConfig
public String getSaslJaasConfig()
-
setSaslClientCallbackHandlerClass
public void setSaslClientCallbackHandlerClass(String saslClientCallbackHandlerClass)
The fully qualified name of a SASL client callback handler class that implements the AuthenticateCallbackHandler interface.
-
getSaslClientCallbackHandlerClass
public String getSaslClientCallbackHandlerClass()
-
setSaslLoginCallbackHandlerClass
public void setSaslLoginCallbackHandlerClass(String saslLoginCallbackHandlerClass)
The fully qualified name of a SASL login callback handler class that implements the AuthenticateCallbackHandler interface. For brokers, login callback handler config must be prefixed with listener prefix and SASL mechanism name in lower-case. For example, listener.name.sasl_ssl.scram-sha-256.sasl.login.callback.handler.class=com.example.CustomScramLoginCallbackHandler
-
getSaslLoginCallbackHandlerClass
public String getSaslLoginCallbackHandlerClass()
-
setSaslLoginClass
public void setSaslLoginClass(String saslLoginClass)
The fully qualified name of a class that implements the Login interface. For brokers, login config must be prefixed with listener prefix and SASL mechanism name in lower-case. For example, listener.name.sasl_ssl.scram-sha-256.sasl.login.class=com.example.CustomScramLogin
-
getSaslLoginClass
public String getSaslLoginClass()
-
setAdditionalProperties
public void setAdditionalProperties(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&additionalProperties.schema.registry.url=http://localhost:8811/avro`
-
setSeekToOffset
public void setSeekToOffset(Long seekToOffset)
Set if KafkaConsumer will read from a particular offset on startup. This config will take precedence over seekTo config
-
getSeekToOffset
public Long getSeekToOffset()
-
setSeekToPosition
public void setSeekToPosition(String seekToPosition)
Set if KafkaConsumer will read from beginning or end on startup: beginning : read from beginning end : read from end.
-
getSeekToPosition
public String getSeekToPosition()
-
setGroupId
public void setGroupId(String groupId)
A unique string that identifies the consumer group this consumer belongs to. This property is required if the consumer uses either the group management functionality by usingsubscribe(topic)
or the Kafka-based offset management strategy.
-
getGroupId
public String getGroupId()
-
setGroupInstanceId
public void setGroupInstanceId(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.
-
getGroupInstanceId
public String getGroupInstanceId()
-
setSessionTimeoutMs
public void setSessionTimeoutMs(int sessionTimeoutMs)
The timeout used to detect client failures when using Kafka's group management facility. The client sends periodic heartbeats to indicate its liveness to the broker. If no heartbeats are received by the broker before the expiration of this session timeout, then the broker will remove this client from the group and initiate a rebalance. Note that the value must be in the allowable range as configured in the broker configuration bygroup.min.session.timeout.ms
andgroup.max.session.timeout.ms
.
-
getSessionTimeoutMs
public int getSessionTimeoutMs()
-
setHeartbeatIntervalMs
public void setHeartbeatIntervalMs(int 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 thansession.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.
-
getHeartbeatIntervalMs
public int getHeartbeatIntervalMs()
-
setPartitionAssignmentStrategy
public void setPartitionAssignmentStrategy(String partitionAssignmentStrategy)
A list of class names or class types, ordered by preference, of supported partition assignment strategies that the client will use to distribute partition ownership amongst consumer instances when group management is used.In addition to the default class specified below, you can use the
org.apache.kafka.clients.consumer.RoundRobinAssignor
class for round robin assignments of partitions to consumers.Implementing the
org.apache.kafka.clients.consumer.ConsumerPartitionAssignor
interface allows you to plug in a custom assignmentstrategy.
-
getPartitionAssignmentStrategy
public String getPartitionAssignmentStrategy()
-
setEnableAutoCommit
public void setEnableAutoCommit(boolean enableAutoCommit)
If true the consumer's offset will be periodically committed in the background.
-
isEnableAutoCommit
public boolean isEnableAutoCommit()
-
setAutoCommitIntervalMs
public void setAutoCommitIntervalMs(int autoCommitIntervalMs)
The frequency in milliseconds that the consumer offsets are auto-committed to Kafka ifenable.auto.commit
is set totrue
.
-
getAutoCommitIntervalMs
public int getAutoCommitIntervalMs()
-
setClientRack
public void setClientRack(String clientRack)
A rack identifier for this client. This can be any string value which indicates where this client is physically located. It corresponds with the broker config 'broker.rack'
-
getClientRack
public String getClientRack()
-
setMaxPartitionFetchBytes
public void setMaxPartitionFetchBytes(int maxPartitionFetchBytes)
The maximum amount of data per-partition the server will return. Records are fetched in batches by the consumer. If the first record batch in the first non-empty partition of the fetch is larger than this limit, the batch will still be returned to ensure that the consumer can make progress. The maximum record batch size accepted by the broker is defined viamessage.max.bytes
(broker config) ormax.message.bytes
(topic config). See fetch.max.bytes for limiting the consumer request size.
-
getMaxPartitionFetchBytes
public int getMaxPartitionFetchBytes()
-
setFetchMinBytes
public void setFetchMinBytes(int 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 default setting of 1 byte means that fetch requests are answered as soon as a single byte of data is available or the fetch request times out waiting for data to arrive. Setting this to something greater than 1 will cause the server to wait for larger amounts of data to accumulate which can improve server throughput a bit at the cost of some additional latency.
-
getFetchMinBytes
public int getFetchMinBytes()
-
setFetchMaxBytes
public void setFetchMaxBytes(int fetchMaxBytes)
The maximum amount of data the server should return for a fetch request. Records are fetched in batches by the consumer, and if the first record batch in the first non-empty partition of the fetch is larger than this value, the record batch will still be returned to ensure that the consumer can make progress. As such, this is not a absolute maximum. The maximum record batch size accepted by the broker is defined viamessage.max.bytes
(broker config) ormax.message.bytes
(topic config). Note that the consumer performs multiple fetches in parallel.
-
getFetchMaxBytes
public int getFetchMaxBytes()
-
setFetchMaxWaitMs
public void setFetchMaxWaitMs(int fetchMaxWaitMs)
The maximum amount of time the server will block before answering the fetch request if there isn't sufficient data to immediately satisfy the requirement given by fetch.min.bytes.
-
getFetchMaxWaitMs
public int getFetchMaxWaitMs()
-
setAutoOffsetReset
public void setAutoOffsetReset(String autoOffsetReset)
What to do when there is no initial offset in Kafka or if the current offset does not exist any more on the server (e.g. because that data has been deleted):- earliest: automatically reset the offset to the earliest offset
- latest: automatically reset the offset to the latest offset
- none: throw exception to the consumer if no previous offset is found for the consumer's group
- anything else: throw exception to the consumer.
-
getAutoOffsetReset
public String getAutoOffsetReset()
-
setCheckCrcs
public void setCheckCrcs(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.
-
isCheckCrcs
public boolean isCheckCrcs()
-
setKeyDeserializer
public void setKeyDeserializer(String keyDeserializer)
Deserializer class for key that implements theorg.apache.kafka.common.serialization.Deserializer
interface.
-
getKeyDeserializer
public String getKeyDeserializer()
-
setValueDeserializer
public void setValueDeserializer(String valueDeserializer)
Deserializer class for value that implements theorg.apache.kafka.common.serialization.Deserializer
interface.
-
getValueDeserializer
public String getValueDeserializer()
-
setDefaultApiTimeoutMs
public void setDefaultApiTimeoutMs(int defaultApiTimeoutMs)
Specifies the timeout (in milliseconds) for client APIs. This configuration is used as the default timeout for all client operations that do not specify atimeout
parameter.
-
getDefaultApiTimeoutMs
public int getDefaultApiTimeoutMs()
-
setMaxPollRecords
public void setMaxPollRecords(int maxPollRecords)
The maximum number of records returned in a single call to poll().
-
getMaxPollRecords
public int getMaxPollRecords()
-
setMaxPollIntervalMs
public void setMaxPollIntervalMs(int 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. For consumers using a non-nullgroup.instance.id
which reach this timeout, partitions will not be immediately reassigned. Instead, the consumer will stop sending heartbeats and partitions will be reassigned after expiration ofsession.timeout.ms
. This mirrors the behavior of a static consumer which has shutdown.
-
getMaxPollIntervalMs
public int getMaxPollIntervalMs()
-
setExcludeInternalTopics
public void setExcludeInternalTopics(boolean excludeInternalTopics)
Whether internal topics matching a subscribed pattern should be excluded from the subscription. It is always possible to explicitly subscribe to an internal topic.
-
isExcludeInternalTopics
public boolean isExcludeInternalTopics()
-
setIsolationLevel
public void setIsolationLevel(String isolationLevel)
Controls how to read messages written transactionally. If set toread_committed
, consumer.poll() will only return transactional messages which have been committed. If set toread_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
-
getIsolationLevel
public String getIsolationLevel()
-
setAllowAutoCreateTopics
public void setAllowAutoCreateTopics(boolean allowAutoCreateTopics)
Allow automatic topic creation on the broker when subscribing to or assigning a topic. A topic being subscribed to will be automatically created only if the broker allows for it using `auto.create.topics.enable` broker configuration. This configuration must be set to `false` when using brokers older than 0.11.0
-
isAllowAutoCreateTopics
public boolean isAllowAutoCreateTopics()
-
setBufferMemory
public void setBufferMemory(long bufferMemory)
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 block formax.block.ms
after which it will throw an exception.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.
-
getBufferMemory
public long getBufferMemory()
-
setRetries
public void setRetries(int 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. Allowing retries without settingmax.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. Note additionally that produce requests will be failed before the number of retries has been exhausted if the timeout configured bydelivery.timeout.ms
expires first before successful acknowledgement. Users should generally prefer to leave this config unset and instead usedelivery.timeout.ms
to control retry behavior.
-
getRetries
public int getRetries()
-
setAcks
public void setAcks(String acks)
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 theretries
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.
-
getAcks
public String getAcks()
-
setCompressionType
public void setCompressionType(String compressionType)
The compression type for all data generated by the producer. The default is none (i.e. no compression). Valid values arenone
,gzip
,snappy
,lz4
, orzstd
. Compression is of full batches of data, so the efficacy of batching will also impact the compression ratio (more batching means better compression).
-
getCompressionType
public String getCompressionType()
-
setBatchSize
public void setBatchSize(int batchSize)
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.
-
getBatchSize
public int getBatchSize()
-
setLingerMs
public void setLingerMs(long 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 the sends 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 getbatch.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). Settinglinger.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 absence of load.
-
getLingerMs
public long getLingerMs()
-
setDeliveryTimeoutMs
public void setDeliveryTimeoutMs(int deliveryTimeoutMs)
An upper bound on the time to report success or failure after a call tosend()
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 producer may report failure to send a record earlier than this config if either an unrecoverable error is encountered, the retries have been exhausted, or the record is added to a batch which reached an earlier delivery expiration deadline. The value of this config should be greater than or equal to the sum ofrequest.timeout.ms
andlinger.ms
.
-
getDeliveryTimeoutMs
public int getDeliveryTimeoutMs()
-
setMaxRequestSize
public void setMaxRequestSize(int maxRequestSize)
The maximum size of a request in bytes. This setting will limit the number of record batches the producer will send in a single request to avoid sending huge requests. This is also effectively a cap on the maximum uncompressed record batch size. Note that the server has its own cap on the record batch size (after compression if compression is enabled) which may be different from this.
-
getMaxRequestSize
public int getMaxRequestSize()
-
setMaxBlockMs
public void setMaxBlockMs(long maxBlockMs)
The configuration controls how longKafkaProducer.send()
andKafkaProducer.partitionsFor()
will block.These methods can be blocked either because the buffer is full or metadata unavailable.Blocking in the user-supplied serializers or partitioner will not be counted against this timeout.
-
getMaxBlockMs
public long getMaxBlockMs()
-
setMetadataMaxIdleMs
public void setMetadataMaxIdleMs(long metadataMaxIdleMs)
Controls how long the producer will cache metadata for a topic that's idle. If the elapsed time since a topic was last produced to exceeds the metadata idle duration, then the topic's metadata is forgotten and the next access to it will force a metadata fetch request.
-
getMetadataMaxIdleMs
public long getMetadataMaxIdleMs()
-
setMaxInFlightRequestsPerConnection
public void setMaxInFlightRequestsPerConnection(int maxInFlightRequestsPerConnection)
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).
-
getMaxInFlightRequestsPerConnection
public int getMaxInFlightRequestsPerConnection()
-
setKeySerializer
public void setKeySerializer(String keySerializer)
Serializer class for key that implements theorg.apache.kafka.common.serialization.Serializer
interface.
-
getKeySerializer
public String getKeySerializer()
-
setValueSerializer
public void setValueSerializer(String valueSerializer)
Serializer class for value that implements theorg.apache.kafka.common.serialization.Serializer
interface.
-
getValueSerializer
public String getValueSerializer()
-
setPartitionerClass
public void setPartitionerClass(String partitionerClass)
Partitioner class that implements theorg.apache.kafka.clients.producer.Partitioner
interface.
-
getPartitionerClass
public String getPartitionerClass()
-
setEnableIdempotence
public void setEnableIdempotence(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 requiresmax.in.flight.requests.per.connection
to be less than or equal to 5,retries
to be greater than 0 andacks
must be 'all'. If these values are not explicitly set by the user, suitable values will be chosen. If incompatible values are set, aConfigException
will be thrown.
-
isEnableIdempotence
public boolean isEnableIdempotence()
-
setTransactionTimeoutMs
public void setTransactionTimeoutMs(int transactionTimeoutMs)
The maximum amount of time in ms that the transaction coordinator will wait for a transaction status update from the producer before proactively aborting the ongoing transaction.If this value is larger than the transaction.max.timeout.ms setting in the broker, the request will fail with aInvalidTransactionTimeout
error.
-
getTransactionTimeoutMs
public int getTransactionTimeoutMs()
-
setTransactionalId
public void setTransactionalId(String transactionalId)
The TransactionalId to use for transactional delivery. This enables reliability semantics which span multiple producer sessions since it allows the client to guarantee that transactions using the same TransactionalId have been completed prior to starting any new transactions. If no TransactionalId is provided, then the producer is limited to idempotent delivery. If a TransactionalId is configured,enable.idempotence
is implied. By default the TransactionId is not configured, which means transactions cannot be used. Note that, by default, transactions require a cluster of at least three brokers which is the recommended setting for production; for development you can change this, by adjusting broker settingtransaction.state.log.replication.factor
.
-
getTransactionalId
public String getTransactionalId()
-
createConsumerConfiguration
public Properties createConsumerConfiguration()
-
createProducerConfiguration
public Properties createProducerConfiguration()
-
copy
public VertxKafkaConfiguration copy()
-
-