AbstractConfigBuilder (kafka-config 2.7.0 API)

java.lang.Object
- net.soundvibe.kafka.config.AbstractConfigBuilder<T>

All Implemented Interfaces:

ConfigBuilder

Direct Known Subclasses:

AdminConfigBuilder, ConsumerConfigBuilder, ProducerConfigBuilder, StreamsConfigBuilder
```
public class AbstractConfigBuilder<T extends AbstractConfigBuilder<T>>
extends Object
implements ConfigBuilder
```

Field Summary

Fields
Modifier and Type Field and Description

protected Map<String,Object> props

Fields
Modifier and Type	Field and Description
`protected Map<String,Object>`	`props`

Constructor Summary

Constructors
Constructor and Description

AbstractConfigBuilder()

Constructors
Constructor and Description
`AbstractConfigBuilder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Map<String,Object>`	`buildMap()`
`Properties`	`buildProperties()` Builds config into java.util.Properties class to use with Kafka consumers, producers or admin clients
`T`	`withBootstrapServers(List<String> bootstrapServers)` A list of host/port pairs to use for establishing the initial connection to the Kafka cluster.
`T`	`withBootstrapServers(String bootstrapServers)` A list of host/port pairs to use for establishing the initial connection to the Kafka cluster.
`T`	`withClientDNSLookup(org.apache.kafka.clients.ClientDnsLookup clientDNSLookup)` Controls how the client uses DNS lookups.
`T`	`withClientId(String clientId)` An id string to pass to the server when making requests.
`T`	`withClientRack(String clientRack)` A rack identifier for this client.
`T`	`withConnectionsMaxIdle(Duration connectionsMaxIdle)` Close idle connections after the duration specified by this config.
`T`	`withCustom(String name, Object value)` Use custom configuration property
`T`	`withCustomMap(Map<String,Object> propertyMap)` Use custom configuration property map
`T`	`withMetadataMaxAge(Duration metadataMaxAge)` The period of time 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.
`T`	`withMetricReporterClasses(Class<?>... metricReporterClasses)` A list of classes to use as metrics reporters.
`T`	`withMetricsNumSamples(int metricsNumSamples)` The number of samples maintained to compute metrics.
`T`	`withMetricsRecordingLevel(org.apache.kafka.common.metrics.Sensor.RecordingLevel metricsRecordingLevel)` The highest recording level for metrics.
`T`	`withMetricsSampleWindow(Duration metricsSampleWindow)` The window of time a metrics sample is computed over.
`T`	`withReceiveBufferBytes(int receiveBufferBytes)` The size of the TCP receive buffer (SO_RCVBUF) to use when reading data.
`T`	`withReconnectBackoff(Duration reconnectBackoff)` The base amount of time to wait before attempting to reconnect to a given host.
`T`	`withReconnectBackoffMax(Duration reconnectBackoffMax)` The maximum amount of time in milliseconds to wait when reconnecting to a broker that has repeatedly failed to connect.
`T`	`withRequestTimeout(Duration requestTimeout)` The configuration controls the maximum amount of time the client will wait for the response of a request.
`T`	`withRetryBackoff(Duration retryBackoff)` The amount of time to wait before attempting to retry a failed request to a given topic partition.
`T`	`withSaslMechanism(String saslMechanism)` SASL mechanism used for client connections.
`T`	`withSecurityProtocol(org.apache.kafka.common.security.auth.SecurityProtocol securityProtocol)` Protocol used to communicate with brokers.
`T`	`withSecurityProviders(Class<? extends org.apache.kafka.common.security.auth.SecurityProviderCreator>... securityProviders)` A list of configurable creator classes each returning a provider implementing security algorithms.
`T`	`withSendBufferBytes(int sendBufferBytes)` The size of the TCP send buffer (SO_SNDBUF) to use when sending data.
`T`	`withSocketConnectionSetupTimeout(Duration socketConnectionSetupTimeout)` The amount of time the client will wait for the socket connection to be established.
`T`	`withSocketConnectionSetupTimeoutMax(Duration socketConnectionSetupTimeoutMax)` The maximum amount of time the client will wait for the socket connection to be established.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - props
```
protected final Map<String,Object> props
```
- Constructor Detail
  - AbstractConfigBuilder
```
public AbstractConfigBuilder()
```
- Method Detail
  - withBootstrapServers
```
public T withBootstrapServers(String bootstrapServers)
```
    A list of host/port pairs to use for establishing the initial connection to the Kafka cluster. The client will make use of all servers irrespective of which servers are specified here for bootstrapping—this list only impacts the initial hosts used to discover the full set of servers. This list should be in the 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).
  - withBootstrapServers
```
public T withBootstrapServers(List<String> bootstrapServers)
```
    A list of host/port pairs to use for establishing the initial connection to the Kafka cluster. The client will make use of all servers irrespective of which servers are specified here for bootstrapping—this list only impacts the initial hosts used to discover the full set of servers. This list should be in the 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).
  - withClientId
```
public T withClientId(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.
  - withClientRack
```
public T withClientRack(String clientRack)
```
    A rack identifier for this client. This can be any string value which indicates where this client is physically located. It corresponds with the broker config 'broker.rack'
  - withClientDNSLookup
```
public T withClientDNSLookup(org.apache.kafka.clients.ClientDnsLookup clientDNSLookup)
```
    Controls how the client uses DNS lookups.
    If set to use_all_dns_ips then, when the lookup returns multiple IP addresses for a hostname, they will all be attempted to connect to before failing the connection. Applies to both bootstrap and advertised servers.
    
    If the value is resolve_canonical_bootstrap_servers_only each entry will be resolved and expanded into a list of canonical names.
  - withMetadataMaxAge
```
public T withMetadataMaxAge(Duration metadataMaxAge)
```
    The period of time 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.
  - withSendBufferBytes
```
public T withSendBufferBytes(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.
  - withReceiveBufferBytes
```
public T withReceiveBufferBytes(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.
  - withReconnectBackoff
```
public T withReconnectBackoff(Duration reconnectBackoff)
```
    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.
  - withReconnectBackoffMax
```
public T withReconnectBackoffMax(Duration reconnectBackoffMax)
```
    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.
  - withRetryBackoff
```
public T withRetryBackoff(Duration retryBackoff)
```
    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.
  - withMetricsSampleWindow
```
public T withMetricsSampleWindow(Duration metricsSampleWindow)
```
    The window of time a metrics sample is computed over.
  - withMetricsNumSamples
```
public T withMetricsNumSamples(int metricsNumSamples)
```
    The number of samples maintained to compute metrics.
  - withMetricsRecordingLevel
```
public T withMetricsRecordingLevel(org.apache.kafka.common.metrics.Sensor.RecordingLevel metricsRecordingLevel)
```
    The highest recording level for metrics.
  - withMetricReporterClasses
```
public T withMetricReporterClasses(Class<?>... metricReporterClasses)
```
    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.
  - withConnectionsMaxIdle
```
public T withConnectionsMaxIdle(Duration connectionsMaxIdle)
```
    Close idle connections after the duration specified by this config.
  - withRequestTimeout
```
public T withRequestTimeout(Duration requestTimeout)
```
    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.
  - withSecurityProtocol
```
public T withSecurityProtocol(org.apache.kafka.common.security.auth.SecurityProtocol securityProtocol)
```
    Protocol used to communicate with brokers.
  - withSaslMechanism
```
public T withSaslMechanism(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.
  - withSecurityProviders
```
@SafeVarargs
public final T withSecurityProviders(Class<? extends org.apache.kafka.common.security.auth.SecurityProviderCreator>... 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.
  - withSocketConnectionSetupTimeout
```
public T withSocketConnectionSetupTimeout(Duration socketConnectionSetupTimeout)
```
    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. Default: 10s.
  - withSocketConnectionSetupTimeoutMax
```
public T withSocketConnectionSetupTimeoutMax(Duration socketConnectionSetupTimeoutMax)
```
    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. Default: 127s.
  - withCustom
```
public T withCustom(String name,
                    Object value)
```
    Use custom configuration property
    
    Parameters:
    
    name - property name
    
    value - property value
    
    Returns:
    
    this
  - withCustomMap
```
public T withCustomMap(Map<String,Object> propertyMap)
```
    Use custom configuration property map
    
    Parameters:
    
    propertyMap - name-value map pairs
    
    Returns:
    
    this
  - buildProperties
```
public Properties buildProperties()
```
    Builds config into java.util.Properties class to use with Kafka consumers, producers or admin clients
    
    Specified by:
    
    buildProperties in interface ConfigBuilder
    
    Returns:
    
    properties
  - buildMap
```
public Map<String,Object> buildMap()
```
    Specified by:
    
    buildMap in interface ConfigBuilder

Class AbstractConfigBuilder<T extends AbstractConfigBuilder<T>>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

props

Constructor Detail

AbstractConfigBuilder

Method Detail

withBootstrapServers

withBootstrapServers

withClientId

withClientRack

withClientDNSLookup

withMetadataMaxAge

withSendBufferBytes

withReceiveBufferBytes

withReconnectBackoff

withReconnectBackoffMax

withRetryBackoff

withMetricsSampleWindow

withMetricsNumSamples

withMetricsRecordingLevel

withMetricReporterClasses

withConnectionsMaxIdle

withRequestTimeout

withSecurityProtocol

withSaslMechanism

withSecurityProviders

withSocketConnectionSetupTimeout

withSocketConnectionSetupTimeoutMax

withCustom

withCustomMap

buildProperties

buildMap