io.axual.client.config

Class BaseProducerConfig.Builder<K,V,T extends BaseProducerConfig.Builder<K,V,T>>

java.lang.Object

io.axual.client.config.BaseProducerConfig.Builder<K,V,T>

Type Parameters:

K - the type of the key that will be produced. A compatible key serializer must be provided to serialize the objects

V - the type of the value that will be produced. A compatible value serializer must be provided to serialize the objects

T - the type of the Builder that is to be used.

Direct Known Subclasses:

BaseAvroProducerConfig.Builder, ProducerConfig.Builder

Enclosing class:

BaseProducerConfig<K,V>

public static class BaseProducerConfig.Builder<K,V,T extends BaseProducerConfig.Builder<K,V,T>>
extends java.lang.Object

The Builder is used to set the configuration options.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	batchSize
protected java.lang.Boolean	blocking
protected DeliveryStrategy	deliveryStrategy
protected java.lang.Object	keySerializer
protected long	lingerMs
protected java.lang.Integer	messageBufferSize
protected int	messageBufferWaitTimeout
protected OrderingStrategy	orderingStrategy
protected ProxyChain	proxyChain
protected java.lang.Object	valueSerializer

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
BaseProducerConfig<K,V>	build() Builds the BaseProducerConfig object which is used by the AxualClient to configure a producer
T	setBatchSize(int batchSize) Sets the maximum size in bytes of the batch of messages to produce before sending.
T	setBlocking(boolean blocking) Indicate if the produce will block when the messageBuffer is full.
T	setDeliveryStrategy(DeliveryStrategy deliveryStrategy) Sets the delivery strategy to be used by the producer.
T	setKeySerializer(org.apache.kafka.common.serialization.Serializer<K> keySerializer) The configured class or instance implementing Serializer which will accept the key objects as input
T	setKeySerializer(java.lang.String keySerializerClassName) The full name of the class implementing Serializer which will accept the key objects as input
T	setLingerMs(long lingerMs) Sets the time to wait in milliseconds before sending a created batch.
T	setMessageBufferSize(int messageBufferSize) The size of the message buffer.
T	setMessageBufferWaitTimeout(int messageBufferWaitTimeout) Set the amount of time to wait for the message buffer before dropping the message
T	setOrderingStrategy(OrderingStrategy orderingStrategy) Sets the ordering strategy to be used by the producer.
T	setProxyChain(ProxyChain proxyChain) Configures the proxy chain to initialize for this producer.
T	setValueSerializer(org.apache.kafka.common.serialization.Serializer<V> valueSerializer) The configured class or instance implementing Serializer which will accept the value objects as input
T	setValueSerializer(java.lang.String valueSerializerClassName) The full name of the class implementing Serializer which will accept the value objects as input
void	validate() Validate the variables set in the config object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

deliveryStrategy

protected DeliveryStrategy deliveryStrategy

orderingStrategy

protected OrderingStrategy orderingStrategy

blocking

protected java.lang.Boolean blocking

messageBufferSize

protected java.lang.Integer messageBufferSize

messageBufferWaitTimeout

protected int messageBufferWaitTimeout

keySerializer

protected java.lang.Object keySerializer

valueSerializer

protected java.lang.Object valueSerializer

batchSize

protected int batchSize

lingerMs

protected long lingerMs

proxyChain

protected ProxyChain proxyChain

Constructor Detail

Builder

public Builder()

Method Detail

setDeliveryStrategy

public T setDeliveryStrategy(DeliveryStrategy deliveryStrategy)

Sets the delivery strategy to be used by the producer. See DeliveryStrategy for the available strategies.

Parameters:

deliveryStrategy - the strategy to use for the producer

Returns:

the BaseProducerConfig.Builder object to be used for further configuration

setOrderingStrategy

public T setOrderingStrategy(OrderingStrategy orderingStrategy)

Sets the ordering strategy to be used by the producer. See OrderingStrategy for the available strategies.

Parameters:

orderingStrategy - the strategy to use for the producer

Returns:

the BaseProducerConfig.Builder object to be used for further configuration

setBlocking

public T setBlocking(boolean blocking)

Indicate if the produce will block when the messageBuffer is full. If set to true, the produce will wait until a spot in the buffer becomes available.

Parameters:

blocking - the blocking

Returns:

the BaseProducerConfig.Builder object to be used for further configuration

setMessageBufferSize

public T setMessageBufferSize(int messageBufferSize)

The size of the message buffer. This indicates how many messages can be in-flight simultaneously

Parameters:

messageBufferSize - the message buffer size

Returns:

the BaseProducerConfig.Builder object to be used for further configuration

setMessageBufferWaitTimeout

public T setMessageBufferWaitTimeout(int messageBufferWaitTimeout)

Set the amount of time to wait for the message buffer before dropping the message

Parameters:

messageBufferWaitTimeout - amount of time to wait in milliseconds

Returns:

the BaseProducerConfig.Builder object to be used for further configuration

setKeySerializer

public T setKeySerializer(java.lang.String keySerializerClassName)

The full name of the class implementing Serializer which will accept the key objects as input

Parameters:

keySerializerClassName - The configured key serializer the producer should use

Returns:

the BaseProducerConfig.Builder object to be used for further configuration

setKeySerializer

public T setKeySerializer(org.apache.kafka.common.serialization.Serializer<K> keySerializer)

The configured class or instance implementing Serializer which will accept the key objects as input

Parameters:

keySerializer - The configured key serializer the producer should use

Returns:

the BaseProducerConfig.Builder object to be used for further configuration

setValueSerializer

public T setValueSerializer(java.lang.String valueSerializerClassName)

The full name of the class implementing Serializer which will accept the value objects as input

Parameters:

valueSerializerClassName - The configured value serializer the producer should use

Returns:

the BaseProducerConfig.Builder object to be used for further configuration

setValueSerializer

public T setValueSerializer(org.apache.kafka.common.serialization.Serializer<V> valueSerializer)

The configured class or instance implementing Serializer which will accept the value objects as input

Parameters:

valueSerializer - The configured value serializer the producer should use

Returns:

the BaseProducerConfig.Builder object to be used for further configuration

setBatchSize

public T setBatchSize(int batchSize)

Sets the maximum size in bytes of the batch of messages to produce before sending. When the batch size has been reached, or when the linger time has been exceeded, the messages will be send. The linger time setLingerMs(long) also plays a role in the batching of messages

Parameters:

batchSize - The batch size in bytes

Returns:

the BaseProducerConfig.Builder object to be used for further configuration

setLingerMs

public T setLingerMs(long lingerMs)

Sets the time to wait in milliseconds before sending a created batch. When the batch size has been reached, or when the linger time has been exceeded, the messages will be send. The linger time also plays a role in the batching of messages.

Parameters:

lingerMs - The amount of milliseconds to wait to send a batch

Returns:

the BaseProducerConfig.Builder object to be used for further configuration

setProxyChain

public T setProxyChain(ProxyChain proxyChain)

Configures the proxy chain to initialize for this producer.

Parameters:

proxyChain - The chain of producer proxies to set up.

Returns:

the BaseProducerConfig.Builder object to be used for further configuration

validate

public void validate()

Validate the variables set in the config object.

Throws:

java.lang.IllegalStateException - when one of more variables are not set (correctly)

build

public BaseProducerConfig<K,V> build()

Builds the BaseProducerConfig object which is used by the AxualClient to configure a producer

Returns:

a BaseProducerConfig object