io.axual.client.config

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

java.lang.Object

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

Type Parameters:

K - the type of the key that will be consumed. A compatible key deserializer must be provided to deserialize the objects

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

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

Direct Known Subclasses:

BaseAvroConsumerConfig.Builder, ConsumerConfig.Builder

Enclosing class:

BaseConsumerConfig<K,V>

protected static class BaseConsumerConfig.Builder<K,V,T extends BaseConsumerConfig.Builder<K,V,T>>
extends java.lang.Object

The Builder is used to set the configuration options.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Builder()

Method Summary

Modifier and Type	Method and Description
BaseConsumerConfig<K,V>	build() Builds the BaseConsumerConfig object which is used by the AxualClient to configure a consumer
T	setDeliveryStrategy(DeliveryStrategy deliveryStrategy) Sets the strategy ot be used by the the consumer.
T	setKeyDeserializer(org.apache.kafka.common.serialization.Deserializer<K> keyDeserializer) The configured class or instance implementing Deserializer which will return the key objects from deserialization
T	setKeyDeserializer(java.lang.String keyDeserializerClassName) The full name of the class implementing Deserializer which will return the key objects from deserialization
T	setMaximumPollSize(int maximumPollSize) Sets the number of messages to be retrieved by a single poll command.
T	setProxyChain(ProxyChain proxyChain) Configures the proxy chain to initialize for this consumer.
T	setStream(java.lang.String stream) Sets the name of the stream to consume from.
T	setValueDeserializer(org.apache.kafka.common.serialization.Deserializer<V> valueDeserializer) The configured class or instance implementing Deserializer which will return the value objects from deserialization
T	setValueDeserializer(java.lang.String valueDeserializerClassName) The full name of the class implementing Deserializer which will return the value objects from deserialization
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

Constructor Detail

Builder

protected Builder()

Method Detail

setDeliveryStrategy

public T setDeliveryStrategy(DeliveryStrategy deliveryStrategy)

Sets the strategy ot be used by the the consumer. See DeliveryStrategy for the available strategies

Parameters:

deliveryStrategy - the strategy to use for the consumer

Returns:

the BaseConsumerConfig.Builder object to be used for further configuration

setStream

public T setStream(java.lang.String stream)

Sets the name of the stream to consume from.

Parameters:

stream - The stream name

Returns:

the BaseConsumerConfig.Builder object to be used for further configuration

setKeyDeserializer

public T setKeyDeserializer(java.lang.String keyDeserializerClassName)

The full name of the class implementing Deserializer which will return the key objects from deserialization

Parameters:

keyDeserializerClassName - The key deserializer class name

Returns:

the BaseConsumerConfig.Builder object to be used for further configuration

setKeyDeserializer

public T setKeyDeserializer(org.apache.kafka.common.serialization.Deserializer<K> keyDeserializer)

The configured class or instance implementing Deserializer which will return the key objects from deserialization

Parameters:

keyDeserializer - The configured key deserializer

Returns:

the BaseConsumerConfig.Builder object to be used for further configuration

setValueDeserializer

public T setValueDeserializer(java.lang.String valueDeserializerClassName)

The full name of the class implementing Deserializer which will return the value objects from deserialization

Parameters:

valueDeserializerClassName - The configured value deserializer

Returns:

the BaseConsumerConfig.Builder object to be used for further configuration

setValueDeserializer

public T setValueDeserializer(org.apache.kafka.common.serialization.Deserializer<V> valueDeserializer)

The configured class or instance implementing Deserializer which will return the value objects from deserialization

Parameters:

valueDeserializer - The configured value deserializer

Returns:

the BaseConsumerConfig.Builder object to be used for further configuration

setMaximumPollSize

public T setMaximumPollSize(int maximumPollSize)

Sets the number of messages to be retrieved by a single poll command.

Parameters:

maximumPollSize - The number of message to be read, value must be between 1 and 500

Returns:

the BaseConsumerConfig.Builder object to be used for further configuration

setProxyChain

public T setProxyChain(ProxyChain proxyChain)

Configures the proxy chain to initialize for this consumer.

Parameters:

proxyChain - The chain of consumer proxies to set up.

Returns:

the BaseConsumerConfig.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 BaseConsumerConfig<K,V> build()

Builds the BaseConsumerConfig object which is used by the AxualClient to configure a consumer

Returns:

a BaseConsumerConfig object