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

Interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver, VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder, VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Enclosing interface:

VertxKafkaEndpointBuilderFactory

public static interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder
extends VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder, VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Builder for endpoint for the Vert.x Kafka component.

Method Summary

Modifier and Type	Method	Description
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	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 VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	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 VertxKafkaEndpointBuilderFactory.AdvancedVertxKafkaEndpointBuilder	advanced()
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	bootstrapServers(String bootstrapServers)	A list of host/port pairs to use for establishing the initial connection to the Kafka cluster.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	clientDnsLookup(String clientDnsLookup)	Controls how the client uses DNS lookups.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	clientId(String clientId)	An id string to pass to the server when making requests.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	connectionsMaxIdleMs(long connectionsMaxIdleMs)	Close idle connections after the number of milliseconds specified by this config.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	connectionsMaxIdleMs(String connectionsMaxIdleMs)	Close idle connections after the number of milliseconds specified by this config.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	headerFilterStrategy(String headerFilterStrategy)	To use a custom HeaderFilterStrategy to filter header to and from Camel message.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)	To use a custom HeaderFilterStrategy to filter header to and from Camel message.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	interceptorClasses(String interceptorClasses)	A list of classes to use as interceptors.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	metadataMaxAgeMs(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.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	metadataMaxAgeMs(String 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.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	metricReporters(String metricReporters)	A list of classes to use as metrics reporters.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	metricsNumSamples(int metricsNumSamples)	The number of samples maintained to compute metrics.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	metricsNumSamples(String metricsNumSamples)	The number of samples maintained to compute metrics.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	metricsRecordingLevel(String metricsRecordingLevel)	The highest recording level for metrics.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	metricsSampleWindowMs(long metricsSampleWindowMs)	The window of time a metrics sample is computed over.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	metricsSampleWindowMs(String metricsSampleWindowMs)	The window of time a metrics sample is computed over.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	partitionId(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.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	partitionId(String 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.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	receiveBufferBytes(int receiveBufferBytes)	The size of the TCP receive buffer (SO_RCVBUF) to use when reading data.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	receiveBufferBytes(String receiveBufferBytes)	The size of the TCP receive buffer (SO_RCVBUF) to use when reading data.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	reconnectBackoffMaxMs(long reconnectBackoffMaxMs)	The maximum amount of time in milliseconds to wait when reconnecting to a broker that has repeatedly failed to connect.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	reconnectBackoffMaxMs(String reconnectBackoffMaxMs)	The maximum amount of time in milliseconds to wait when reconnecting to a broker that has repeatedly failed to connect.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	reconnectBackoffMs(long reconnectBackoffMs)	The base amount of time to wait before attempting to reconnect to a given host.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	reconnectBackoffMs(String reconnectBackoffMs)	The base amount of time to wait before attempting to reconnect to a given host.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	requestTimeoutMs(int requestTimeoutMs)	The configuration controls the maximum amount of time the client will wait for the response of a request.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	requestTimeoutMs(String requestTimeoutMs)	The configuration controls the maximum amount of time the client will wait for the response of a request.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	retryBackoffMs(long retryBackoffMs)	The amount of time to wait before attempting to retry a failed request to a given topic partition.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	retryBackoffMs(String retryBackoffMs)	The amount of time to wait before attempting to retry a failed request to a given topic partition.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	saslClientCallbackHandlerClass(String saslClientCallbackHandlerClass)	The fully qualified name of a SASL client callback handler class that implements the AuthenticateCallbackHandler interface.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	saslJaasConfig(String saslJaasConfig)	JAAS login context parameters for SASL connections in the format used by JAAS configuration files.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	saslKerberosKinitCmd(String saslKerberosKinitCmd)	Kerberos kinit command path.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	saslKerberosMinTimeBeforeRelogin(long saslKerberosMinTimeBeforeRelogin)	Login thread sleep time between refresh attempts.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	saslKerberosMinTimeBeforeRelogin(String saslKerberosMinTimeBeforeRelogin)	Login thread sleep time between refresh attempts.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	saslKerberosServiceName(String saslKerberosServiceName)	The Kerberos principal name that Kafka runs as.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	saslKerberosTicketRenewJitter(double saslKerberosTicketRenewJitter)	Percentage of random jitter added to the renewal time.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	saslKerberosTicketRenewJitter(String saslKerberosTicketRenewJitter)	Percentage of random jitter added to the renewal time.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	saslKerberosTicketRenewWindowFactor(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.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	saslKerberosTicketRenewWindowFactor(String 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.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	saslLoginCallbackHandlerClass(String saslLoginCallbackHandlerClass)	The fully qualified name of a SASL login callback handler class that implements the AuthenticateCallbackHandler interface.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	saslLoginClass(String saslLoginClass)	The fully qualified name of a class that implements the Login interface.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	saslLoginRefreshBufferSeconds(short saslLoginRefreshBufferSeconds)	The amount of buffer time before credential expiration to maintain when refreshing a credential, in seconds.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	saslLoginRefreshBufferSeconds(String saslLoginRefreshBufferSeconds)	The amount of buffer time before credential expiration to maintain when refreshing a credential, in seconds.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	saslLoginRefreshMinPeriodSeconds(short saslLoginRefreshMinPeriodSeconds)	The desired minimum time for the login refresh thread to wait before refreshing a credential, in seconds.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	saslLoginRefreshMinPeriodSeconds(String saslLoginRefreshMinPeriodSeconds)	The desired minimum time for the login refresh thread to wait before refreshing a credential, in seconds.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	saslLoginRefreshWindowFactor(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.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	saslLoginRefreshWindowFactor(String 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.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	saslLoginRefreshWindowJitter(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.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	saslLoginRefreshWindowJitter(String saslLoginRefreshWindowJitter)	The maximum amount of random jitter relative to the credential's lifetime that is added to the login refresh thread's sleep time.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	saslMechanism(String saslMechanism)	SASL mechanism used for client connections.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	securityProtocol(String securityProtocol)	Protocol used to communicate with brokers.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	securityProviders(String securityProviders)	A list of configurable creator classes each returning a provider implementing security algorithms.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	sendBufferBytes(int sendBufferBytes)	The size of the TCP send buffer (SO_SNDBUF) to use when sending data.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	sendBufferBytes(String sendBufferBytes)	The size of the TCP send buffer (SO_SNDBUF) to use when sending data.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	socketConnectionSetupTimeoutMaxMs(long socketConnectionSetupTimeoutMaxMs)	The maximum amount of time the client will wait for the socket connection to be established.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	socketConnectionSetupTimeoutMaxMs(String socketConnectionSetupTimeoutMaxMs)	The maximum amount of time the client will wait for the socket connection to be established.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	socketConnectionSetupTimeoutMs(long socketConnectionSetupTimeoutMs)	The amount of time the client will wait for the socket connection to be established.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	socketConnectionSetupTimeoutMs(String socketConnectionSetupTimeoutMs)	The amount of time the client will wait for the socket connection to be established.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	sslCipherSuites(String sslCipherSuites)	A list of cipher suites.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	sslEnabledProtocols(String sslEnabledProtocols)	The list of protocols enabled for SSL connections.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	sslEndpointIdentificationAlgorithm(String sslEndpointIdentificationAlgorithm)	The endpoint identification algorithm to validate server hostname using server certificate.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	sslEngineFactoryClass(String sslEngineFactoryClass)	The class of type org.apache.kafka.common.security.auth.SslEngineFactory to provide SSLEngine objects.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	sslKeymanagerAlgorithm(String sslKeymanagerAlgorithm)	The algorithm used by key manager factory for SSL connections.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	sslKeyPassword(String sslKeyPassword)	The password of the private key in the key store file orthe PEM key specified in ssl.keystore.key'.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	sslKeystoreCertificateChain(String sslKeystoreCertificateChain)	Certificate chain in the format specified by 'ssl.keystore.type'.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	sslKeystoreKey(String sslKeystoreKey)	Private key in the format specified by 'ssl.keystore.type'.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	sslKeystoreLocation(String sslKeystoreLocation)	The location of the key store file.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	sslKeystorePassword(String sslKeystorePassword)	The store password for the key store file.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	sslKeystoreType(String sslKeystoreType)	The file format of the key store file.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	sslProtocol(String sslProtocol)	The SSL protocol used to generate the SSLContext.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	sslProvider(String sslProvider)	The name of the security provider used for SSL connections.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	sslSecureRandomImplementation(String sslSecureRandomImplementation)	The SecureRandom PRNG implementation to use for SSL cryptography operations.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	sslTrustmanagerAlgorithm(String sslTrustmanagerAlgorithm)	The algorithm used by trust manager factory for SSL connections.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	sslTruststoreCertificates(String sslTruststoreCertificates)	Trusted certificates in the format specified by 'ssl.truststore.type'.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	sslTruststoreLocation(String sslTruststoreLocation)	The location of the trust store file.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	sslTruststorePassword(String sslTruststorePassword)	The password for the trust store file.
default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder	sslTruststoreType(String sslTruststoreType)	The file format of the trust store file.

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

allowAutoCreateTopics, allowAutoCreateTopics, allowManualCommit, allowManualCommit, autoCommitIntervalMs, autoCommitIntervalMs, autoOffsetReset, checkCrcs, checkCrcs, clientRack, defaultApiTimeoutMs, defaultApiTimeoutMs, enableAutoCommit, enableAutoCommit, excludeInternalTopics, excludeInternalTopics, fetchMaxBytes, fetchMaxBytes, fetchMaxWaitMs, fetchMaxWaitMs, fetchMinBytes, fetchMinBytes, groupId, groupInstanceId, heartbeatIntervalMs, heartbeatIntervalMs, isolationLevel, keyDeserializer, maxPartitionFetchBytes, maxPartitionFetchBytes, maxPollIntervalMs, maxPollIntervalMs, maxPollRecords, maxPollRecords, partitionAssignmentStrategy, seekToOffset, seekToOffset, seekToPosition, sessionTimeoutMs, sessionTimeoutMs, valueDeserializer

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

acks, batchSize, batchSize, bufferMemory, bufferMemory, compressionType, deliveryTimeoutMs, deliveryTimeoutMs, enableIdempotence, enableIdempotence, keySerializer, lingerMs, lingerMs, maxBlockMs, maxBlockMs, maxInFlightRequestsPerConnection, maxInFlightRequestsPerConnection, maxRequestSize, maxRequestSize, metadataMaxIdleMs, metadataMaxIdleMs, partitionerClass, retries, retries, transactionalId, transactionTimeoutMs, transactionTimeoutMs, valueSerializer

Method Detail

advanced

default VertxKafkaEndpointBuilderFactory.AdvancedVertxKafkaEndpointBuilder advanced()

Specified by:

advanced in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

advanced in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

additionalProperties

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder 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 VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

additionalProperties in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

key - the option key

value - the option value

Returns:

the dsl builder

additionalProperties

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder 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 VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

additionalProperties in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

values - the values

Returns:

the dsl builder

bootstrapServers

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder bootstrapServers(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&amp;mdash;this list only impacts the initial hosts used to discover the full set of servers. This list should be in the form host1: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). The option is a: <code>java.lang.String</code> type. Group: common

Specified by:

bootstrapServers in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

bootstrapServers in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

bootstrapServers - the value to set

Returns:

the dsl builder

clientDnsLookup

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder clientDnsLookup(String clientDnsLookup)

Controls how the client uses DNS lookups. If set to use_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 to resolve_canonical_bootstrap_servers_only, resolve each bootstrap address into a list of canonical names. After the bootstrap phase, this behaves the same as use_all_dns_ips. If set to default (deprecated), attempt to connect to the first IP address returned by the lookup, even if the lookup returns multiple IP addresses. The option is a: <code>java.lang.String</code> type. Default: use_all_dns_ips Group: common

Specified by:

clientDnsLookup in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

clientDnsLookup in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

clientDnsLookup - the value to set

Returns:

the dsl builder

clientId

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder clientId(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. The option is a: <code>java.lang.String</code> type. Group: common

Specified by:

clientId in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

clientId in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

clientId - the value to set

Returns:

the dsl builder

connectionsMaxIdleMs

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder connectionsMaxIdleMs(long connectionsMaxIdleMs)

Close idle connections after the number of milliseconds specified by this config. The option is a: <code>long</code> type. Default: 9m Group: common

Specified by:

connectionsMaxIdleMs in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

connectionsMaxIdleMs in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

connectionsMaxIdleMs - the value to set

Returns:

the dsl builder

connectionsMaxIdleMs

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder connectionsMaxIdleMs(String connectionsMaxIdleMs)

Close idle connections after the number of milliseconds specified by this config. The option will be converted to a <code>long</code> type. Default: 9m Group: common

Specified by:

connectionsMaxIdleMs in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

connectionsMaxIdleMs in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

connectionsMaxIdleMs - the value to set

Returns:

the dsl builder

headerFilterStrategy

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder 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 VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

headerFilterStrategy in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

headerFilterStrategy - the value to set

Returns:

the dsl builder

headerFilterStrategy

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder 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 VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

headerFilterStrategy in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

headerFilterStrategy - the value to set

Returns:

the dsl builder

interceptorClasses

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder interceptorClasses(String interceptorClasses)

A list of classes to use as interceptors. Implementing the org.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. The option is a: <code>java.lang.String</code> type. Group: common

Specified by:

interceptorClasses in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

interceptorClasses in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

interceptorClasses - the value to set

Returns:

the dsl builder

metadataMaxAgeMs

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder metadataMaxAgeMs(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. The option is a: <code>long</code> type. Default: 5m Group: common

Specified by:

metadataMaxAgeMs in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

metadataMaxAgeMs in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

metadataMaxAgeMs - the value to set

Returns:

the dsl builder

metadataMaxAgeMs

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder metadataMaxAgeMs(String metadataMaxAgeMs)

The period of time in milliseconds after which we force a refresh of metadata even if we haven't seen any partition leadership changes to proactively discover any new brokers or partitions. The option will be converted to a <code>long</code> type. Default: 5m Group: common

Specified by:

metadataMaxAgeMs in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

metadataMaxAgeMs in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

metadataMaxAgeMs - the value to set

Returns:

the dsl builder

metricReporters

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder metricReporters(String metricReporters)

A list of classes to use as metrics reporters. Implementing the org.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. The option is a: <code>java.lang.String</code> type. Group: common

Specified by:

metricReporters in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

metricReporters in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

metricReporters - the value to set

Returns:

the dsl builder

metricsNumSamples

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder metricsNumSamples(int metricsNumSamples)

The number of samples maintained to compute metrics. The option is a: <code>int</code> type. Default: 2 Group: common

Specified by:

metricsNumSamples in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

metricsNumSamples in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

metricsNumSamples - the value to set

Returns:

the dsl builder

metricsNumSamples

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder metricsNumSamples(String metricsNumSamples)

The number of samples maintained to compute metrics. The option will be converted to a <code>int</code> type. Default: 2 Group: common

Specified by:

metricsNumSamples in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

metricsNumSamples in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

metricsNumSamples - the value to set

Returns:

the dsl builder

metricsRecordingLevel

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder metricsRecordingLevel(String metricsRecordingLevel)

The highest recording level for metrics. The option is a: <code>java.lang.String</code> type. Default: INFO Group: common

Specified by:

metricsRecordingLevel in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

metricsRecordingLevel in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

metricsRecordingLevel - the value to set

Returns:

the dsl builder

metricsSampleWindowMs

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder metricsSampleWindowMs(long metricsSampleWindowMs)

The window of time a metrics sample is computed over. The option is a: <code>long</code> type. Default: 30s Group: common

Specified by:

metricsSampleWindowMs in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

metricsSampleWindowMs in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

metricsSampleWindowMs - the value to set

Returns:

the dsl builder

metricsSampleWindowMs

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder metricsSampleWindowMs(String metricsSampleWindowMs)

The window of time a metrics sample is computed over. The option will be converted to a <code>long</code> type. Default: 30s Group: common

Specified by:

metricsSampleWindowMs in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

metricsSampleWindowMs in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

metricsSampleWindowMs - the value to set

Returns:

the dsl builder

partitionId

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder partitionId(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. Header VertxKafkaConstants#PARTITION_ID If configured, it will take precedence over this config. The option is a: <code>java.lang.Integer</code> type. Group: common

Specified by:

partitionId in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

partitionId in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

partitionId - the value to set

Returns:

the dsl builder

partitionId

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder partitionId(String 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. Header VertxKafkaConstants#PARTITION_ID If configured, it will take precedence over this config. The option will be converted to a <code>java.lang.Integer</code> type. Group: common

Specified by:

partitionId in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

partitionId in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

partitionId - the value to set

Returns:

the dsl builder

receiveBufferBytes

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder receiveBufferBytes(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. The option is a: <code>int</code> type. Default: 32768 Group: common

Specified by:

receiveBufferBytes in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

receiveBufferBytes in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

receiveBufferBytes - the value to set

Returns:

the dsl builder

receiveBufferBytes

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder receiveBufferBytes(String 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. The option will be converted to a <code>int</code> type. Default: 32768 Group: common

Specified by:

receiveBufferBytes in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

receiveBufferBytes in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

receiveBufferBytes - the value to set

Returns:

the dsl builder

reconnectBackoffMaxMs

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder reconnectBackoffMaxMs(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. The option is a: <code>long</code> type. Default: 1s Group: common

Specified by:

reconnectBackoffMaxMs in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

reconnectBackoffMaxMs in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

reconnectBackoffMaxMs - the value to set

Returns:

the dsl builder

reconnectBackoffMaxMs

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder 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>long</code> type. Default: 1s Group: common

Specified by:

reconnectBackoffMaxMs in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

reconnectBackoffMaxMs in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

reconnectBackoffMaxMs - the value to set

Returns:

the dsl builder

reconnectBackoffMs

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder reconnectBackoffMs(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. The option is a: <code>long</code> type. Default: 50ms Group: common

Specified by:

reconnectBackoffMs in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

reconnectBackoffMs in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

reconnectBackoffMs - the value to set

Returns:

the dsl builder

reconnectBackoffMs

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder reconnectBackoffMs(String 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. The option will be converted to a <code>long</code> type. Default: 50ms Group: common

Specified by:

reconnectBackoffMs in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

reconnectBackoffMs in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

reconnectBackoffMs - the value to set

Returns:

the dsl builder

requestTimeoutMs

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder requestTimeoutMs(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 than replica.lag.time.max.ms (a broker configuration) to reduce the possibility of message duplication due to unnecessary producer retries. The option is a: <code>int</code> type. Default: 30s Group: common

Specified by:

requestTimeoutMs in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

requestTimeoutMs in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

requestTimeoutMs - the value to set

Returns:

the dsl builder

requestTimeoutMs

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder requestTimeoutMs(String 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 than replica.lag.time.max.ms (a broker configuration) to reduce the possibility of message duplication due to unnecessary producer retries. The option will be converted to a <code>int</code> type. Default: 30s Group: common

Specified by:

requestTimeoutMs in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

requestTimeoutMs in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

requestTimeoutMs - the value to set

Returns:

the dsl builder

retryBackoffMs

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder retryBackoffMs(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. The option is a: <code>long</code> type. Default: 100ms Group: common

Specified by:

retryBackoffMs in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

retryBackoffMs in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

retryBackoffMs - the value to set

Returns:

the dsl builder

retryBackoffMs

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder retryBackoffMs(String 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. The option will be converted to a <code>long</code> type. Default: 100ms Group: common

Specified by:

retryBackoffMs in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

retryBackoffMs in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

retryBackoffMs - the value to set

Returns:

the dsl builder

sendBufferBytes

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder sendBufferBytes(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. The option is a: <code>int</code> type. Default: 131072 Group: common

Specified by:

sendBufferBytes in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

sendBufferBytes in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

sendBufferBytes - the value to set

Returns:

the dsl builder

sendBufferBytes

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder sendBufferBytes(String 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. The option will be converted to a <code>int</code> type. Default: 131072 Group: common

Specified by:

sendBufferBytes in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

sendBufferBytes in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

sendBufferBytes - the value to set

Returns:

the dsl builder

socketConnectionSetupTimeoutMaxMs

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder socketConnectionSetupTimeoutMaxMs(long socketConnectionSetupTimeoutMaxMs)

The maximum amount of time the client will wait for the socket connection to be established. The connection setup timeout will increase exponentially for each consecutive connection failure up to this maximum. To avoid connection storms, a randomization factor of 0.2 will be applied to the timeout resulting in a random range between 20% below and 20% above the computed value. The option is a: <code>long</code> type. Default: 30s Group: common

Specified by:

socketConnectionSetupTimeoutMaxMs in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

socketConnectionSetupTimeoutMaxMs in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

socketConnectionSetupTimeoutMaxMs - the value to set

Returns:

the dsl builder

socketConnectionSetupTimeoutMaxMs

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder socketConnectionSetupTimeoutMaxMs(String socketConnectionSetupTimeoutMaxMs)

The maximum amount of time the client will wait for the socket connection to be established. The connection setup timeout will increase exponentially for each consecutive connection failure up to this maximum. To avoid connection storms, a randomization factor of 0.2 will be applied to the timeout resulting in a random range between 20% below and 20% above the computed value. The option will be converted to a <code>long</code> type. Default: 30s Group: common

Specified by:

socketConnectionSetupTimeoutMaxMs in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

socketConnectionSetupTimeoutMaxMs in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

socketConnectionSetupTimeoutMaxMs - the value to set

Returns:

the dsl builder

socketConnectionSetupTimeoutMs

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder socketConnectionSetupTimeoutMs(long socketConnectionSetupTimeoutMs)

The amount of time the client will wait for the socket connection to be established. If the connection is not built before the timeout elapses, clients will close the socket channel. The option is a: <code>long</code> type. Default: 10s Group: common

Specified by:

socketConnectionSetupTimeoutMs in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

socketConnectionSetupTimeoutMs in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

socketConnectionSetupTimeoutMs - the value to set

Returns:

the dsl builder

socketConnectionSetupTimeoutMs

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder socketConnectionSetupTimeoutMs(String socketConnectionSetupTimeoutMs)

The amount of time the client will wait for the socket connection to be established. If the connection is not built before the timeout elapses, clients will close the socket channel. The option will be converted to a <code>long</code> type. Default: 10s Group: common

Specified by:

socketConnectionSetupTimeoutMs in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

socketConnectionSetupTimeoutMs in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

socketConnectionSetupTimeoutMs - the value to set

Returns:

the dsl builder

saslClientCallbackHandlerClass

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder saslClientCallbackHandlerClass(String saslClientCallbackHandlerClass)

The fully qualified name of a SASL client callback handler class that implements the AuthenticateCallbackHandler interface. The option is a: <code>java.lang.String</code> type. Group: security

Specified by:

saslClientCallbackHandlerClass in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

saslClientCallbackHandlerClass in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

saslClientCallbackHandlerClass - the value to set

Returns:

the dsl builder

saslJaasConfig

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder saslJaasConfig(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;. The option is a: <code>java.lang.String</code> type. Group: security

Specified by:

saslJaasConfig in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

saslJaasConfig in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

saslJaasConfig - the value to set

Returns:

the dsl builder

saslKerberosKinitCmd

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder saslKerberosKinitCmd(String saslKerberosKinitCmd)

Kerberos kinit command path. The option is a: <code>java.lang.String</code> type. Default: /usr/bin/kinit Group: security

Specified by:

saslKerberosKinitCmd in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

saslKerberosKinitCmd in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

saslKerberosKinitCmd - the value to set

Returns:

the dsl builder

saslKerberosMinTimeBeforeRelogin

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder saslKerberosMinTimeBeforeRelogin(long saslKerberosMinTimeBeforeRelogin)

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

Specified by:

saslKerberosMinTimeBeforeRelogin in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

saslKerberosMinTimeBeforeRelogin in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

saslKerberosMinTimeBeforeRelogin - the value to set

Returns:

the dsl builder

saslKerberosMinTimeBeforeRelogin

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder saslKerberosMinTimeBeforeRelogin(String saslKerberosMinTimeBeforeRelogin)

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

Specified by:

saslKerberosMinTimeBeforeRelogin in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

saslKerberosMinTimeBeforeRelogin in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

saslKerberosMinTimeBeforeRelogin - the value to set

Returns:

the dsl builder

saslKerberosServiceName

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder 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 VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

saslKerberosServiceName in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

saslKerberosServiceName - the value to set

Returns:

the dsl builder

saslKerberosTicketRenewJitter

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder saslKerberosTicketRenewJitter(double saslKerberosTicketRenewJitter)

Percentage of random jitter added to the renewal time. The option is a: <code>double</code> type. Default: 0.05 Group: security

Specified by:

saslKerberosTicketRenewJitter in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

saslKerberosTicketRenewJitter in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

saslKerberosTicketRenewJitter - the value to set

Returns:

the dsl builder

saslKerberosTicketRenewJitter

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder saslKerberosTicketRenewJitter(String saslKerberosTicketRenewJitter)

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

Specified by:

saslKerberosTicketRenewJitter in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

saslKerberosTicketRenewJitter in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

saslKerberosTicketRenewJitter - the value to set

Returns:

the dsl builder

saslKerberosTicketRenewWindowFactor

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder saslKerberosTicketRenewWindowFactor(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. The option is a: <code>double</code> type. Default: 0.8 Group: security

Specified by:

saslKerberosTicketRenewWindowFactor in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

saslKerberosTicketRenewWindowFactor in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

saslKerberosTicketRenewWindowFactor - the value to set

Returns:

the dsl builder

saslKerberosTicketRenewWindowFactor

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder saslKerberosTicketRenewWindowFactor(String 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. The option will be converted to a <code>double</code> type. Default: 0.8 Group: security

Specified by:

saslKerberosTicketRenewWindowFactor in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

saslKerberosTicketRenewWindowFactor in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

saslKerberosTicketRenewWindowFactor - the value to set

Returns:

the dsl builder

saslLoginCallbackHandlerClass

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder saslLoginCallbackHandlerClass(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. The option is a: <code>java.lang.String</code> type. Group: security

Specified by:

saslLoginCallbackHandlerClass in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

saslLoginCallbackHandlerClass in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

saslLoginCallbackHandlerClass - the value to set

Returns:

the dsl builder

saslLoginClass

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder saslLoginClass(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. The option is a: <code>java.lang.String</code> type. Group: security

Specified by:

saslLoginClass in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

saslLoginClass in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

saslLoginClass - the value to set

Returns:

the dsl builder

saslLoginRefreshBufferSeconds

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder saslLoginRefreshBufferSeconds(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. The option is a: <code>short</code> type. Default: 300 Group: security

Specified by:

saslLoginRefreshBufferSeconds in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

saslLoginRefreshBufferSeconds in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

saslLoginRefreshBufferSeconds - the value to set

Returns:

the dsl builder

saslLoginRefreshBufferSeconds

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder saslLoginRefreshBufferSeconds(String 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. The option will be converted to a <code>short</code> type. Default: 300 Group: security

Specified by:

saslLoginRefreshBufferSeconds in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

saslLoginRefreshBufferSeconds in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

saslLoginRefreshBufferSeconds - the value to set

Returns:

the dsl builder

saslLoginRefreshMinPeriodSeconds

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder saslLoginRefreshMinPeriodSeconds(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. The option is a: <code>short</code> type. Default: 60 Group: security

Specified by:

saslLoginRefreshMinPeriodSeconds in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

saslLoginRefreshMinPeriodSeconds in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

saslLoginRefreshMinPeriodSeconds - the value to set

Returns:

the dsl builder

saslLoginRefreshMinPeriodSeconds

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder saslLoginRefreshMinPeriodSeconds(String 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. The option will be converted to a <code>short</code> type. Default: 60 Group: security

Specified by:

saslLoginRefreshMinPeriodSeconds in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

saslLoginRefreshMinPeriodSeconds in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

saslLoginRefreshMinPeriodSeconds - the value to set

Returns:

the dsl builder

saslLoginRefreshWindowFactor

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder saslLoginRefreshWindowFactor(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. The option is a: <code>double</code> type. Default: 0.8 Group: security

Specified by:

saslLoginRefreshWindowFactor in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

saslLoginRefreshWindowFactor in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

saslLoginRefreshWindowFactor - the value to set

Returns:

the dsl builder

saslLoginRefreshWindowFactor

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder saslLoginRefreshWindowFactor(String 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. The option will be converted to a <code>double</code> type. Default: 0.8 Group: security

Specified by:

saslLoginRefreshWindowFactor in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

saslLoginRefreshWindowFactor in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

saslLoginRefreshWindowFactor - the value to set

Returns:

the dsl builder

saslLoginRefreshWindowJitter

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder saslLoginRefreshWindowJitter(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. The option is a: <code>double</code> type. Default: 0.05 Group: security

Specified by:

saslLoginRefreshWindowJitter in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

saslLoginRefreshWindowJitter in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

saslLoginRefreshWindowJitter - the value to set

Returns:

the dsl builder

saslLoginRefreshWindowJitter

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder saslLoginRefreshWindowJitter(String 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. The option will be converted to a <code>double</code> type. Default: 0.05 Group: security

Specified by:

saslLoginRefreshWindowJitter in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

saslLoginRefreshWindowJitter in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

saslLoginRefreshWindowJitter - the value to set

Returns:

the dsl builder

saslMechanism

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder saslMechanism(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. The option is a: <code>java.lang.String</code> type. Default: GSSAPI Group: security

Specified by:

saslMechanism in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

saslMechanism in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

saslMechanism - the value to set

Returns:

the dsl builder

securityProtocol

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder securityProtocol(String securityProtocol)

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

Specified by:

securityProtocol in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

securityProtocol in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

securityProtocol - the value to set

Returns:

the dsl builder

securityProviders

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder securityProviders(String securityProviders)

A list of configurable creator classes each returning a provider implementing security algorithms. These classes should implement the org.apache.kafka.common.security.auth.SecurityProviderCreator interface. The option is a: <code>java.lang.String</code> type. Group: security

Specified by:

securityProviders in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

securityProviders in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

securityProviders - the value to set

Returns:

the dsl builder

sslCipherSuites

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder 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 VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

sslCipherSuites in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

sslCipherSuites - the value to set

Returns:

the dsl builder

sslEnabledProtocols

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder sslEnabledProtocols(String sslEnabledProtocols)

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

Specified by:

sslEnabledProtocols in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

sslEnabledProtocols in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

sslEnabledProtocols - the value to set

Returns:

the dsl builder

sslEndpointIdentificationAlgorithm

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder sslEndpointIdentificationAlgorithm(String sslEndpointIdentificationAlgorithm)

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:

sslEndpointIdentificationAlgorithm in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

sslEndpointIdentificationAlgorithm in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

sslEndpointIdentificationAlgorithm - the value to set

Returns:

the dsl builder

sslEngineFactoryClass

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder sslEngineFactoryClass(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. The option is a: <code>java.lang.String</code> type. Group: security

Specified by:

sslEngineFactoryClass in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

sslEngineFactoryClass in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

sslEngineFactoryClass - the value to set

Returns:

the dsl builder

sslKeymanagerAlgorithm

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder 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 VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

sslKeymanagerAlgorithm in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

sslKeymanagerAlgorithm - the value to set

Returns:

the dsl builder

sslKeyPassword

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder sslKeyPassword(String sslKeyPassword)

The password of the private key in the key store file orthe PEM key specified in ssl.keystore.key'. This is required for clients only if two-way authentication is configured. The option is a: <code>java.lang.String</code> type. Group: security

Specified by:

sslKeyPassword in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

sslKeyPassword in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

sslKeyPassword - the value to set

Returns:

the dsl builder

sslKeystoreCertificateChain

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder sslKeystoreCertificateChain(String sslKeystoreCertificateChain)

Certificate chain in the format specified by 'ssl.keystore.type'. Default SSL engine factory supports only PEM format with a list of X.509 certificates. The option is a: <code>java.lang.String</code> type. Group: security

Specified by:

sslKeystoreCertificateChain in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

sslKeystoreCertificateChain in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

sslKeystoreCertificateChain - the value to set

Returns:

the dsl builder

sslKeystoreKey

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder sslKeystoreKey(String sslKeystoreKey)

Private key in the format specified by 'ssl.keystore.type'. Default SSL engine factory supports only PEM format with PKCS#8 keys. If the key is encrypted, key password must be specified using 'ssl.key.password'. The option is a: <code>java.lang.String</code> type. Group: security

Specified by:

sslKeystoreKey in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

sslKeystoreKey in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

sslKeystoreKey - the value to set

Returns:

the dsl builder

sslKeystoreLocation

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder sslKeystoreLocation(String sslKeystoreLocation)

The location of the key store file. This is optional for client and can be used for two-way authentication for client. The option is a: <code>java.lang.String</code> type. Group: security

Specified by:

sslKeystoreLocation in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

sslKeystoreLocation in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

sslKeystoreLocation - the value to set

Returns:

the dsl builder

sslKeystorePassword

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder sslKeystorePassword(String sslKeystorePassword)

The store password for the key store file. This is optional for client and only needed if 'ssl.keystore.location' is configured. Key store password is not supported for PEM format. The option is a: <code>java.lang.String</code> type. Group: security

Specified by:

sslKeystorePassword in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

sslKeystorePassword in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

sslKeystorePassword - the value to set

Returns:

the dsl builder

sslKeystoreType

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder sslKeystoreType(String sslKeystoreType)

The file format of the key store file. This is optional for client. The option is a: <code>java.lang.String</code> type. Default: JKS Group: security

Specified by:

sslKeystoreType in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

sslKeystoreType in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

sslKeystoreType - the value to set

Returns:

the dsl builder

sslProtocol

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder sslProtocol(String sslProtocol)

The SSL protocol used to generate the SSLContext. The default is 'TLSv1.3' when running with Java 11 or newer, 'TLSv1.2' otherwise. This value should be fine for most use cases. Allowed values in recent JVMs are 'TLSv1.2' and 'TLSv1.3'. 'TLS', 'TLSv1.1', 'SSL', 'SSLv2' and 'SSLv3' may be supported in older JVMs, but their usage is discouraged due to known security vulnerabilities. With the default value for this config and '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'. The option is a: <code>java.lang.String</code> type. Default: TLSv1.2 Group: security

Specified by:

sslProtocol in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

sslProtocol in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

sslProtocol - the value to set

Returns:

the dsl builder

sslProvider

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder 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 VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

sslProvider in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

sslProvider - the value to set

Returns:

the dsl builder

sslSecureRandomImplementation

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder sslSecureRandomImplementation(String sslSecureRandomImplementation)

The SecureRandom PRNG implementation to use for SSL cryptography operations. The option is a: <code>java.lang.String</code> type. Group: security

Specified by:

sslSecureRandomImplementation in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

sslSecureRandomImplementation in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

sslSecureRandomImplementation - the value to set

Returns:

the dsl builder

sslTrustmanagerAlgorithm

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder 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 VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

sslTrustmanagerAlgorithm in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

sslTrustmanagerAlgorithm - the value to set

Returns:

the dsl builder

sslTruststoreCertificates

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder sslTruststoreCertificates(String sslTruststoreCertificates)

Trusted certificates in the format specified by 'ssl.truststore.type'. Default SSL engine factory supports only PEM format with X.509 certificates. The option is a: <code>java.lang.String</code> type. Group: security

Specified by:

sslTruststoreCertificates in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

sslTruststoreCertificates in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

sslTruststoreCertificates - the value to set

Returns:

the dsl builder

sslTruststoreLocation

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder sslTruststoreLocation(String sslTruststoreLocation)

The location of the trust store file. The option is a: <code>java.lang.String</code> type. Group: security

Specified by:

sslTruststoreLocation in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

sslTruststoreLocation in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

sslTruststoreLocation - the value to set

Returns:

the dsl builder

sslTruststorePassword

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder sslTruststorePassword(String sslTruststorePassword)

The password for the trust store file. If a password is not set, trust store file configured will still be used, but integrity checking is disabled. Trust store password is not supported for PEM format. The option is a: <code>java.lang.String</code> type. Group: security

Specified by:

sslTruststorePassword in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

sslTruststorePassword in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

sslTruststorePassword - the value to set

Returns:

the dsl builder

sslTruststoreType

default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder sslTruststoreType(String sslTruststoreType)

The file format of the trust store file. The option is a: <code>java.lang.String</code> type. Default: JKS Group: security

Specified by:

sslTruststoreType in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

Specified by:

sslTruststoreType in interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointProducerBuilder

Parameters:

sslTruststoreType - the value to set

Returns:

the dsl builder