Package org.swisspush.kobuka.client

Class CommonClientConfigBuilder

java.lang.Object
org.swisspush.kobuka.client.base.BaseCommonClientConfigBuilder<CommonClientConfigBuilder>
org.swisspush.kobuka.client.CommonClientConfigBuilder
All Implemented Interfaces:
CommonClientConfigFields<CommonClientConfigBuilder>
public class CommonClientConfigBuilder extends BaseCommonClientConfigBuilder<CommonClientConfigBuilder>

  • Constructor Details

    • CommonClientConfigBuilder

      public CommonClientConfigBuilder()

  • Method Details

    • build

      default <R> R build(Function<Map<String,Object>,R> fn)

    • property

      default CommonClientConfigBuilder property(String key, Object value)

    • asSupplier

      default Supplier<Map<String,Object>> asSupplier()

    • bootstrapServers

      public CommonClientConfigBuilder bootstrapServers(List<String> value)
      Description copied from interface: CommonClientConfigFields

      bootstrap.servers

      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 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).

      Default:

      Valid Values:

      Importance: high

      Specified by:
      bootstrapServers in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • bootstrapServers

      public CommonClientConfigBuilder bootstrapServers(String value)
      Description copied from interface: CommonClientConfigFields

      bootstrap.servers

      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 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).

      Default:

      Valid Values:

      Importance: high

      Specified by:
      bootstrapServers in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • clientId

      public CommonClientConfigBuilder clientId(String value)
      Description copied from interface: CommonClientConfigFields

      client.id

      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.

      Default: ""

      Valid Values:

      Importance: medium

      Specified by:
      clientId in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • metadataMaxAgeMs

      public CommonClientConfigBuilder metadataMaxAgeMs(Long value)
      Description copied from interface: CommonClientConfigFields

      metadata.max.age.ms

      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: 300000 (5 minutes)

      Valid Values: [0,...]

      Importance: low

      Specified by:
      metadataMaxAgeMs in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • sendBufferBytes

      public CommonClientConfigBuilder sendBufferBytes(Integer value)
      Description copied from interface: CommonClientConfigFields

      send.buffer.bytes

      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.

      Default: 131072 (128 kibibytes)

      Valid Values: [-1,...]

      Importance: medium

      Specified by:
      sendBufferBytes in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • receiveBufferBytes

      public CommonClientConfigBuilder receiveBufferBytes(Integer value)
      Description copied from interface: CommonClientConfigFields

      receive.buffer.bytes

      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.

      Default: 65536 (64 kibibytes)

      Valid Values: [-1,...]

      Importance: medium

      Specified by:
      receiveBufferBytes in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • reconnectBackoffMs

      public CommonClientConfigBuilder reconnectBackoffMs(Long value)
      Description copied from interface: CommonClientConfigFields

      reconnect.backoff.ms

      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.

      Default: 50

      Valid Values: [0,...]

      Importance: low

      Specified by:
      reconnectBackoffMs in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • reconnectBackoffMaxMs

      public CommonClientConfigBuilder reconnectBackoffMaxMs(Long value)
      Description copied from interface: CommonClientConfigFields

      reconnect.backoff.max.ms

      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.

      Default: 1000 (1 second)

      Valid Values: [0,...]

      Importance: low

      Specified by:
      reconnectBackoffMaxMs in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • retryBackoffMs

      public CommonClientConfigBuilder retryBackoffMs(Long value)
      Description copied from interface: CommonClientConfigFields

      retry.backoff.ms

      The amount of time to wait before attempting to retry a failed request.
      This avoids repeatedly sending requests in a tight loop under some failure scenarios.

      Default: 100

      Valid Values: [0,...]

      Importance: low

      Specified by:
      retryBackoffMs in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • requestTimeoutMs

      public CommonClientConfigBuilder requestTimeoutMs(Integer value)
      Description copied from interface: CommonClientConfigFields

      request.timeout.ms

      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.

      Default: 30000 (30 seconds)

      Valid Values: [0,...]

      Importance: medium

      Specified by:
      requestTimeoutMs in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • connectionsMaxIdleMs

      public CommonClientConfigBuilder connectionsMaxIdleMs(Long value)
      Description copied from interface: CommonClientConfigFields

      connections.max.idle.ms

      Close idle connections after the number of milliseconds specified by this config.

      Default: 300000 (5 minutes)

      Valid Values:

      Importance: medium

      Specified by:
      connectionsMaxIdleMs in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • metricsSampleWindowMs

      public CommonClientConfigBuilder metricsSampleWindowMs(Long value)
      Description copied from interface: CommonClientConfigFields

      metrics.sample.window.ms

      The window of time a metrics sample is computed over.

      Default: 30000 (30 seconds)

      Valid Values: [0,...]

      Importance: low

      Specified by:
      metricsSampleWindowMs in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • metricsNumSamples

      public CommonClientConfigBuilder metricsNumSamples(Integer value)
      Description copied from interface: CommonClientConfigFields

      metrics.num.samples

      The number of samples maintained to compute metrics.

      Default: 2

      Valid Values: [1,...]

      Importance: low

      Specified by:
      metricsNumSamples in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • metricReporters

      public CommonClientConfigBuilder metricReporters(List<String> value)
      Description copied from interface: CommonClientConfigFields

      metric.reporters

      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.

      Default: ""

      Valid Values:

      Importance: low

      Specified by:
      metricReporters in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • metricReporters

      public CommonClientConfigBuilder metricReporters(String value)
      Description copied from interface: CommonClientConfigFields

      metric.reporters

      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.

      Default: ""

      Valid Values:

      Importance: low

      Specified by:
      metricReporters in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • metricsRecordingLevel

      public CommonClientConfigBuilder metricsRecordingLevel(String value)
      Description copied from interface: CommonClientConfigFields

      metrics.recording.level

      The highest recording level for metrics.

      Default: INFO

      Valid Values: [INFO, DEBUG, TRACE]

      Importance: low

      Specified by:
      metricsRecordingLevel in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • securityProtocol

      public CommonClientConfigBuilder securityProtocol(String value)
      Description copied from interface: CommonClientConfigFields

      security.protocol

      Protocol used to communicate with brokers.
      Valid values are: PLAINTEXT, SSL, SASL_PLAINTEXT, SASL_SSL.

      Default: PLAINTEXT

      Valid Values: [PLAINTEXT, SSL, SASL_PLAINTEXT, SASL_SSL]

      Importance: medium

      Specified by:
      securityProtocol in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • sslProtocol

      public CommonClientConfigBuilder sslProtocol(String value)
      Description copied from interface: CommonClientConfigFields

      ssl.protocol

      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'.

      Default: TLSv1.3

      Valid Values:

      Importance: medium

      Specified by:
      sslProtocol in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • sslProvider

      public CommonClientConfigBuilder sslProvider(String value)
      Description copied from interface: CommonClientConfigFields

      ssl.provider

      The name of the security provider used for SSL connections.
      Default value is the default security provider of the JVM.

      Default: null

      Valid Values:

      Importance: medium

      Specified by:
      sslProvider in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • sslCipherSuites

      public CommonClientConfigBuilder sslCipherSuites(List<String> value)
      Description copied from interface: CommonClientConfigFields

      ssl.cipher.suites

      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.

      Default: null

      Valid Values:

      Importance: low

      Specified by:
      sslCipherSuites in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • sslCipherSuites

      public CommonClientConfigBuilder sslCipherSuites(String value)
      Description copied from interface: CommonClientConfigFields

      ssl.cipher.suites

      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.

      Default: null

      Valid Values:

      Importance: low

      Specified by:
      sslCipherSuites in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • sslEnabledProtocols

      public CommonClientConfigBuilder sslEnabledProtocols(List<String> value)
      Description copied from interface: CommonClientConfigFields

      ssl.enabled.protocols

      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`.

      Default: TLSv1.2,TLSv1.3

      Valid Values:

      Importance: medium

      Specified by:
      sslEnabledProtocols in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • sslEnabledProtocols

      public CommonClientConfigBuilder sslEnabledProtocols(String value)
      Description copied from interface: CommonClientConfigFields

      ssl.enabled.protocols

      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`.

      Default: TLSv1.2,TLSv1.3

      Valid Values:

      Importance: medium

      Specified by:
      sslEnabledProtocols in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • sslKeystoreType

      public CommonClientConfigBuilder sslKeystoreType(String value)
      Description copied from interface: CommonClientConfigFields

      ssl.keystore.type

      The file format of the key store file.
      This is optional for client.
      The values currently supported by the default `ssl.engine.factory.class` are [JKS, PKCS12, PEM].

      Default: JKS

      Valid Values:

      Importance: medium

      Specified by:
      sslKeystoreType in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • sslKeystoreLocation

      public CommonClientConfigBuilder sslKeystoreLocation(String value)
      Description copied from interface: CommonClientConfigFields

      ssl.keystore.location

      The location of the key store file.
      This is optional for client and can be used for two-way authentication for client.

      Default: null

      Valid Values:

      Importance: high

      Specified by:
      sslKeystoreLocation in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • sslKeystorePassword

      public CommonClientConfigBuilder sslKeystorePassword(org.apache.kafka.common.config.types.Password value)
      Description copied from interface: CommonClientConfigFields

      ssl.keystore.password

      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.

      Default: null

      Valid Values:

      Importance: high

      Specified by:
      sslKeystorePassword in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • sslKeystorePassword

      public CommonClientConfigBuilder sslKeystorePassword(String value)
      Description copied from interface: CommonClientConfigFields

      ssl.keystore.password

      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.

      Default: null

      Valid Values:

      Importance: high

      Specified by:
      sslKeystorePassword in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • sslKeyPassword

      public CommonClientConfigBuilder sslKeyPassword(org.apache.kafka.common.config.types.Password value)
      Description copied from interface: CommonClientConfigFields

      ssl.key.password

      The password of the private key in the key store file or the PEM key specified in `ssl.keystore.key'.

      Default: null

      Valid Values:

      Importance: high

      Specified by:
      sslKeyPassword in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • sslKeyPassword

      public CommonClientConfigBuilder sslKeyPassword(String value)
      Description copied from interface: CommonClientConfigFields

      ssl.key.password

      The password of the private key in the key store file or the PEM key specified in `ssl.keystore.key'.

      Default: null

      Valid Values:

      Importance: high

      Specified by:
      sslKeyPassword in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • sslKeystoreKey

      public CommonClientConfigBuilder sslKeystoreKey(org.apache.kafka.common.config.types.Password value)
      Description copied from interface: CommonClientConfigFields

      ssl.keystore.key

      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'

      Default: null

      Valid Values:

      Importance: high

      Specified by:
      sslKeystoreKey in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • sslKeystoreKey

      public CommonClientConfigBuilder sslKeystoreKey(String value)
      Description copied from interface: CommonClientConfigFields

      ssl.keystore.key

      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'

      Default: null

      Valid Values:

      Importance: high

      Specified by:
      sslKeystoreKey in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • sslKeystoreCertificateChain

      public CommonClientConfigBuilder sslKeystoreCertificateChain(org.apache.kafka.common.config.types.Password value)
      Description copied from interface: CommonClientConfigFields

      ssl.keystore.certificate.chain

      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

      Default: null

      Valid Values:

      Importance: high

      Specified by:
      sslKeystoreCertificateChain in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • sslKeystoreCertificateChain

      public CommonClientConfigBuilder sslKeystoreCertificateChain(String value)
      Description copied from interface: CommonClientConfigFields

      ssl.keystore.certificate.chain

      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

      Default: null

      Valid Values:

      Importance: high

      Specified by:
      sslKeystoreCertificateChain in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • sslTruststoreCertificates

      public CommonClientConfigBuilder sslTruststoreCertificates(org.apache.kafka.common.config.types.Password value)
      Description copied from interface: CommonClientConfigFields

      ssl.truststore.certificates

      Trusted certificates in the format specified by 'ssl.truststore.type'.
      Default SSL engine factory supports only PEM format with X.509 certificates.

      Default: null

      Valid Values:

      Importance: high

      Specified by:
      sslTruststoreCertificates in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • sslTruststoreCertificates

      public CommonClientConfigBuilder sslTruststoreCertificates(String value)
      Description copied from interface: CommonClientConfigFields

      ssl.truststore.certificates

      Trusted certificates in the format specified by 'ssl.truststore.type'.
      Default SSL engine factory supports only PEM format with X.509 certificates.

      Default: null

      Valid Values:

      Importance: high

      Specified by:
      sslTruststoreCertificates in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • sslTruststoreType

      public CommonClientConfigBuilder sslTruststoreType(String value)
      Description copied from interface: CommonClientConfigFields

      ssl.truststore.type

      The file format of the trust store file.
      The values currently supported by the default `ssl.engine.factory.class` are [JKS, PKCS12, PEM].

      Default: JKS

      Valid Values:

      Importance: medium

      Specified by:
      sslTruststoreType in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • sslTruststoreLocation

      public CommonClientConfigBuilder sslTruststoreLocation(String value)
      Description copied from interface: CommonClientConfigFields

      ssl.truststore.location

      The location of the trust store file.

      Default: null

      Valid Values:

      Importance: high

      Specified by:
      sslTruststoreLocation in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • sslTruststorePassword

      public CommonClientConfigBuilder sslTruststorePassword(org.apache.kafka.common.config.types.Password value)
      Description copied from interface: CommonClientConfigFields

      ssl.truststore.password

      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.

      Default: null

      Valid Values:

      Importance: high

      Specified by:
      sslTruststorePassword in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • sslTruststorePassword

      public CommonClientConfigBuilder sslTruststorePassword(String value)
      Description copied from interface: CommonClientConfigFields

      ssl.truststore.password

      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.

      Default: null

      Valid Values:

      Importance: high

      Specified by:
      sslTruststorePassword in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • sslKeymanagerAlgorithm

      public CommonClientConfigBuilder sslKeymanagerAlgorithm(String value)
      Description copied from interface: CommonClientConfigFields

      ssl.keymanager.algorithm

      The algorithm used by key manager factory for SSL connections.
      Default value is the key manager factory algorithm configured for the Java Virtual Machine.

      Default: SunX509

      Valid Values:

      Importance: low

      Specified by:
      sslKeymanagerAlgorithm in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • sslTrustmanagerAlgorithm

      public CommonClientConfigBuilder sslTrustmanagerAlgorithm(String value)
      Description copied from interface: CommonClientConfigFields

      ssl.trustmanager.algorithm

      The algorithm used by trust manager factory for SSL connections.
      Default value is the trust manager factory algorithm configured for the Java Virtual Machine.

      Default: PKIX

      Valid Values:

      Importance: low

      Specified by:
      sslTrustmanagerAlgorithm in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • sslEndpointIdentificationAlgorithm

      public CommonClientConfigBuilder sslEndpointIdentificationAlgorithm(String value)
      Description copied from interface: CommonClientConfigFields

      ssl.endpoint.identification.algorithm

      The endpoint identification algorithm to validate server hostname using server certificate.

      Default: https

      Valid Values:

      Importance: low

      Specified by:
      sslEndpointIdentificationAlgorithm in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • sslSecureRandomImplementation

      public CommonClientConfigBuilder sslSecureRandomImplementation(String value)
      Description copied from interface: CommonClientConfigFields

      ssl.secure.random.implementation

      The SecureRandom PRNG implementation to use for SSL cryptography operations.

      Default: null

      Valid Values:

      Importance: low

      Specified by:
      sslSecureRandomImplementation in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • sslEngineFactoryClass

      public CommonClientConfigBuilder sslEngineFactoryClass(Class value)
      Description copied from interface: CommonClientConfigFields

      ssl.engine.factory.class

      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

      Default: null

      Valid Values:

      Importance: low

      Specified by:
      sslEngineFactoryClass in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • saslKerberosServiceName

      public CommonClientConfigBuilder saslKerberosServiceName(String value)
      Description copied from interface: CommonClientConfigFields

      sasl.kerberos.service.name

      The Kerberos principal name that Kafka runs as.
      This can be defined either in Kafka's JAAS config or in Kafka's config.

      Default: null

      Valid Values:

      Importance: medium

      Specified by:
      saslKerberosServiceName in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • saslKerberosKinitCmd

      public CommonClientConfigBuilder saslKerberosKinitCmd(String value)
      Description copied from interface: CommonClientConfigFields

      sasl.kerberos.kinit.cmd

      Kerberos kinit command path.

      Default: /usr/bin/kinit

      Valid Values:

      Importance: low

      Specified by:
      saslKerberosKinitCmd in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • saslKerberosTicketRenewWindowFactor

      public CommonClientConfigBuilder saslKerberosTicketRenewWindowFactor(Double value)
      Description copied from interface: CommonClientConfigFields

      sasl.kerberos.ticket.renew.window.factor

      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: 0.8

      Valid Values:

      Importance: low

      Specified by:
      saslKerberosTicketRenewWindowFactor in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • saslKerberosTicketRenewJitter

      public CommonClientConfigBuilder saslKerberosTicketRenewJitter(Double value)
      Description copied from interface: CommonClientConfigFields

      sasl.kerberos.ticket.renew.jitter

      Percentage of random jitter added to the renewal time.

      Default: 0.05

      Valid Values:

      Importance: low

      Specified by:
      saslKerberosTicketRenewJitter in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • saslKerberosMinTimeBeforeRelogin

      public CommonClientConfigBuilder saslKerberosMinTimeBeforeRelogin(Long value)
      Description copied from interface: CommonClientConfigFields

      sasl.kerberos.min.time.before.relogin

      Login thread sleep time between refresh attempts.

      Default: 60000

      Valid Values:

      Importance: low

      Specified by:
      saslKerberosMinTimeBeforeRelogin in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • saslLoginRefreshWindowFactor

      public CommonClientConfigBuilder saslLoginRefreshWindowFactor(Double value)
      Description copied from interface: CommonClientConfigFields

      sasl.login.refresh.window.factor

      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.

      Default: 0.8

      Valid Values: [0.5,...,1.0]

      Importance: low

      Specified by:
      saslLoginRefreshWindowFactor in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • saslLoginRefreshWindowJitter

      public CommonClientConfigBuilder saslLoginRefreshWindowJitter(Double value)
      Description copied from interface: CommonClientConfigFields

      sasl.login.refresh.window.jitter

      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.

      Default: 0.05

      Valid Values: [0.0,...,0.25]

      Importance: low

      Specified by:
      saslLoginRefreshWindowJitter in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • saslLoginRefreshMinPeriodSeconds

      public CommonClientConfigBuilder saslLoginRefreshMinPeriodSeconds(Short value)
      Description copied from interface: CommonClientConfigFields

      sasl.login.refresh.min.period.seconds

      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.

      Default: 60

      Valid Values: [0,...,900]

      Importance: low

      Specified by:
      saslLoginRefreshMinPeriodSeconds in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • saslLoginRefreshBufferSeconds

      public CommonClientConfigBuilder saslLoginRefreshBufferSeconds(Short value)
      Description copied from interface: CommonClientConfigFields

      sasl.login.refresh.buffer.seconds

      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.

      Default: 300

      Valid Values: [0,...,3600]

      Importance: low

      Specified by:
      saslLoginRefreshBufferSeconds in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • saslMechanism

      public CommonClientConfigBuilder saslMechanism(String value)
      Description copied from interface: CommonClientConfigFields

      sasl.mechanism

      SASL mechanism used for client connections.
      This may be any mechanism for which a security provider is available.
      GSSAPI is the default mechanism.

      Default: GSSAPI

      Valid Values:

      Importance: medium

      Specified by:
      saslMechanism in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • saslJaasConfig

      public CommonClientConfigBuilder saslJaasConfig(org.apache.kafka.common.config.types.Password value)
      Description copied from interface: CommonClientConfigFields

      sasl.jaas.config

      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;

      Default: null

      Valid Values:

      Importance: medium

      Specified by:
      saslJaasConfig in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • saslJaasConfig

      public CommonClientConfigBuilder saslJaasConfig(String value)
      Description copied from interface: CommonClientConfigFields

      sasl.jaas.config

      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;

      Default: null

      Valid Values:

      Importance: medium

      Specified by:
      saslJaasConfig in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • saslClientCallbackHandlerClass

      public CommonClientConfigBuilder saslClientCallbackHandlerClass(Class value)
      Description copied from interface: CommonClientConfigFields

      sasl.client.callback.handler.class

      The fully qualified name of a SASL client callback handler class that implements the AuthenticateCallbackHandler interface.

      Default: null

      Valid Values:

      Importance: medium

      Specified by:
      saslClientCallbackHandlerClass in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • saslLoginCallbackHandlerClass

      public CommonClientConfigBuilder saslLoginCallbackHandlerClass(Class value)
      Description copied from interface: CommonClientConfigFields

      sasl.login.callback.handler.class

      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

      Default: null

      Valid Values:

      Importance: medium

      Specified by:
      saslLoginCallbackHandlerClass in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • saslLoginClass

      public CommonClientConfigBuilder saslLoginClass(Class value)
      Description copied from interface: CommonClientConfigFields

      sasl.login.class

      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

      Default: null

      Valid Values:

      Importance: medium

      Specified by:
      saslLoginClass in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • saslLoginConnectTimeoutMs

      public CommonClientConfigBuilder saslLoginConnectTimeoutMs(Integer value)
      Description copied from interface: CommonClientConfigFields

      sasl.login.connect.timeout.ms

      The (optional) value in milliseconds for the external authentication provider connection timeout.
      Currently applies only to OAUTHBEARER.

      Default: null

      Valid Values:

      Importance: low

      Specified by:
      saslLoginConnectTimeoutMs in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • saslLoginReadTimeoutMs

      public CommonClientConfigBuilder saslLoginReadTimeoutMs(Integer value)
      Description copied from interface: CommonClientConfigFields

      sasl.login.read.timeout.ms

      The (optional) value in milliseconds for the external authentication provider read timeout.
      Currently applies only to OAUTHBEARER.

      Default: null

      Valid Values:

      Importance: low

      Specified by:
      saslLoginReadTimeoutMs in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • saslLoginRetryBackoffMaxMs

      public CommonClientConfigBuilder saslLoginRetryBackoffMaxMs(Long value)
      Description copied from interface: CommonClientConfigFields

      sasl.login.retry.backoff.max.ms

      The (optional) value in milliseconds for the maximum wait between login attempts to the external authentication provider.
      Login uses an exponential backoff algorithm with an initial wait based on the sasl.login.retry.backoff.ms setting and will double in wait length between attempts up to a maximum wait length specified by the sasl.login.retry.backoff.max.ms setting.
      Currently applies only to OAUTHBEARER.

      Default: 10000 (10 seconds)

      Valid Values:

      Importance: low

      Specified by:
      saslLoginRetryBackoffMaxMs in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • saslLoginRetryBackoffMs

      public CommonClientConfigBuilder saslLoginRetryBackoffMs(Long value)
      Description copied from interface: CommonClientConfigFields

      sasl.login.retry.backoff.ms

      The (optional) value in milliseconds for the initial wait between login attempts to the external authentication provider.
      Login uses an exponential backoff algorithm with an initial wait based on the sasl.login.retry.backoff.ms setting and will double in wait length between attempts up to a maximum wait length specified by the sasl.login.retry.backoff.max.ms setting.
      Currently applies only to OAUTHBEARER.

      Default: 100

      Valid Values:

      Importance: low

      Specified by:
      saslLoginRetryBackoffMs in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • saslOauthbearerScopeClaimName

      public CommonClientConfigBuilder saslOauthbearerScopeClaimName(String value)
      Description copied from interface: CommonClientConfigFields

      sasl.oauthbearer.scope.claim.name

      The OAuth claim for the scope is often named "scope", but this (optional) setting can provide a different name to use for the scope included in the JWT payload's claims if the OAuth/OIDC provider uses a different name for that claim.

      Default: scope

      Valid Values:

      Importance: low

      Specified by:
      saslOauthbearerScopeClaimName in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • saslOauthbearerSubClaimName

      public CommonClientConfigBuilder saslOauthbearerSubClaimName(String value)
      Description copied from interface: CommonClientConfigFields

      sasl.oauthbearer.sub.claim.name

      The OAuth claim for the subject is often named "sub", but this (optional) setting can provide a different name to use for the subject included in the JWT payload's claims if the OAuth/OIDC provider uses a different name for that claim.

      Default: sub

      Valid Values:

      Importance: low

      Specified by:
      saslOauthbearerSubClaimName in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • saslOauthbearerTokenEndpointUrl

      public CommonClientConfigBuilder saslOauthbearerTokenEndpointUrl(String value)
      Description copied from interface: CommonClientConfigFields

      sasl.oauthbearer.token.endpoint.url

      The URL for the OAuth/OIDC identity provider.
      If the URL is HTTP(S)-based, it is the issuer's token endpoint URL to which requests will be made to login based on the configuration in sasl.jaas.config.
      If the URL is file-based, it specifies a file containing an access token (in JWT serialized form) issued by the OAuth/OIDC identity provider to use for authorization.

      Default: null

      Valid Values:

      Importance: medium

      Specified by:
      saslOauthbearerTokenEndpointUrl in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • saslOauthbearerJwksEndpointUrl

      public CommonClientConfigBuilder saslOauthbearerJwksEndpointUrl(String value)
      Description copied from interface: CommonClientConfigFields

      sasl.oauthbearer.jwks.endpoint.url

      The OAuth/OIDC provider URL from which the provider's JWKS (JSON Web Key Set) can be retrieved.
      The URL can be HTTP(S)-based or file-based.
      If the URL is HTTP(S)-based, the JWKS data will be retrieved from the OAuth/OIDC provider via the configured URL on broker startup.
      All then-current keys will be cached on the broker for incoming requests.
      If an authentication request is received for a JWT that includes a "kid" header claim value that isn't yet in the cache, the JWKS endpoint will be queried again on demand.
      However, the broker polls the URL every sasl.oauthbearer.jwks.endpoint.refresh.ms milliseconds to refresh the cache with any forthcoming keys before any JWT requests that include them are received.
      If the URL is file-based, the broker will load the JWKS file from a configured location on startup.
      In the event that the JWT includes a "kid" header value that isn't in the JWKS file, the broker will reject the JWT and authentication will fail.

      Default: null

      Valid Values:

      Importance: medium

      Specified by:
      saslOauthbearerJwksEndpointUrl in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • saslOauthbearerJwksEndpointRefreshMs

      public CommonClientConfigBuilder saslOauthbearerJwksEndpointRefreshMs(Long value)
      Description copied from interface: CommonClientConfigFields

      sasl.oauthbearer.jwks.endpoint.refresh.ms

      The (optional) value in milliseconds for the broker to wait between refreshing its JWKS (JSON Web Key Set) cache that contains the keys to verify the signature of the JWT.

      Default: 3600000 (1 hour)

      Valid Values:

      Importance: low

      Specified by:
      saslOauthbearerJwksEndpointRefreshMs in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • saslOauthbearerJwksEndpointRetryBackoffMaxMs

      public CommonClientConfigBuilder saslOauthbearerJwksEndpointRetryBackoffMaxMs(Long value)
      Description copied from interface: CommonClientConfigFields

      sasl.oauthbearer.jwks.endpoint.retry.backoff.max.ms

      The (optional) value in milliseconds for the maximum wait between attempts to retrieve the JWKS (JSON Web Key Set) from the external authentication provider.
      JWKS retrieval uses an exponential backoff algorithm with an initial wait based on the sasl.oauthbearer.jwks.endpoint.retry.backoff.ms setting and will double in wait length between attempts up to a maximum wait length specified by the sasl.oauthbearer.jwks.endpoint.retry.backoff.max.ms setting.

      Default: 10000 (10 seconds)

      Valid Values:

      Importance: low

      Specified by:
      saslOauthbearerJwksEndpointRetryBackoffMaxMs in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • saslOauthbearerJwksEndpointRetryBackoffMs

      public CommonClientConfigBuilder saslOauthbearerJwksEndpointRetryBackoffMs(Long value)
      Description copied from interface: CommonClientConfigFields

      sasl.oauthbearer.jwks.endpoint.retry.backoff.ms

      The (optional) value in milliseconds for the initial wait between JWKS (JSON Web Key Set) retrieval attempts from the external authentication provider.
      JWKS retrieval uses an exponential backoff algorithm with an initial wait based on the sasl.oauthbearer.jwks.endpoint.retry.backoff.ms setting and will double in wait length between attempts up to a maximum wait length specified by the sasl.oauthbearer.jwks.endpoint.retry.backoff.max.ms setting.

      Default: 100

      Valid Values:

      Importance: low

      Specified by:
      saslOauthbearerJwksEndpointRetryBackoffMs in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • saslOauthbearerClockSkewSeconds

      public CommonClientConfigBuilder saslOauthbearerClockSkewSeconds(Integer value)
      Description copied from interface: CommonClientConfigFields

      sasl.oauthbearer.clock.skew.seconds

      The (optional) value in seconds to allow for differences between the time of the OAuth/OIDC identity provider and the broker.

      Default: 30

      Valid Values:

      Importance: low

      Specified by:
      saslOauthbearerClockSkewSeconds in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • saslOauthbearerExpectedAudience

      public CommonClientConfigBuilder saslOauthbearerExpectedAudience(List<String> value)
      Description copied from interface: CommonClientConfigFields

      sasl.oauthbearer.expected.audience

      The (optional) comma-delimited setting for the broker to use to verify that the JWT was issued for one of the expected audiences.
      The JWT will be inspected for the standard OAuth "aud" claim and if this value is set, the broker will match the value from JWT's "aud" claim to see if there is an exact match.
      If there is no match, the broker will reject the JWT and authentication will fail.

      Default: null

      Valid Values:

      Importance: low

      Specified by:
      saslOauthbearerExpectedAudience in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • saslOauthbearerExpectedAudience

      public CommonClientConfigBuilder saslOauthbearerExpectedAudience(String value)
      Description copied from interface: CommonClientConfigFields

      sasl.oauthbearer.expected.audience

      The (optional) comma-delimited setting for the broker to use to verify that the JWT was issued for one of the expected audiences.
      The JWT will be inspected for the standard OAuth "aud" claim and if this value is set, the broker will match the value from JWT's "aud" claim to see if there is an exact match.
      If there is no match, the broker will reject the JWT and authentication will fail.

      Default: null

      Valid Values:

      Importance: low

      Specified by:
      saslOauthbearerExpectedAudience in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>

    • saslOauthbearerExpectedIssuer

      public CommonClientConfigBuilder saslOauthbearerExpectedIssuer(String value)
      Description copied from interface: CommonClientConfigFields

      sasl.oauthbearer.expected.issuer

      The (optional) setting for the broker to use to verify that the JWT was created by the expected issuer.
      The JWT will be inspected for the standard OAuth "iss" claim and if this value is set, the broker will match it exactly against what is in the JWT's "iss" claim.
      If there is no match, the broker will reject the JWT and authentication will fail.

      Default: null

      Valid Values:

      Importance: low

      Specified by:
      saslOauthbearerExpectedIssuer in interface CommonClientConfigFields<T extends org.swisspush.kobuka.client.base.AbstractCommonClientConfigBuilder<T>>