net.soundvibe.kafka.config

Class AbstractConfigBuilder<T extends AbstractConfigBuilder<T>>

java.lang.Object

net.soundvibe.kafka.config.AbstractConfigBuilder<T>

All Implemented Interfaces:

ConfigBuilder

Direct Known Subclasses:

AdminConfigBuilder, ConsumerConfigBuilder, ProducerConfigBuilder

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

Constructor Summary

Constructors

Constructor and Description
AbstractConfigBuilder()

Method Summary

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(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	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	withSendBufferBytes(int sendBufferBytes) The size of the TCP send buffer (SO_SNDBUF) to use when sending data.

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

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.

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