org.springframework.kafka.core

Class DefaultKafkaConsumerFactory<K,V>

java.lang.Object

org.springframework.kafka.core.DefaultKafkaConsumerFactory<K,V>

Type Parameters:

K - the key type.

V - the value type.

All Implemented Interfaces:

ConsumerFactory<K,V>

public class DefaultKafkaConsumerFactory<K,V>
extends java.lang.Object
implements ConsumerFactory<K,V>

The ConsumerFactory implementation to produce a new Consumer instance for provided Map configs and optional Deserializer keyDeserializer, valueDeserializer implementations on each createConsumer() invocation.

Author:

Gary Russell, Murali Reddy

Constructor Summary

Constructors

Constructor and Description
DefaultKafkaConsumerFactory(java.util.Map<java.lang.String,java.lang.Object> configs)
DefaultKafkaConsumerFactory(java.util.Map<java.lang.String,java.lang.Object> configs, org.apache.kafka.common.serialization.Deserializer<K> keyDeserializer, org.apache.kafka.common.serialization.Deserializer<V> valueDeserializer)

Method Summary

Modifier and Type	Method and Description
org.apache.kafka.clients.consumer.Consumer<K,V>	createConsumer() Create a consumer with the group id and client id as configured in the properties.
org.apache.kafka.clients.consumer.Consumer<K,V>	createConsumer(java.lang.String clientIdSuffix) Create a consumer, appending the suffix to the client.id property, if present.
org.apache.kafka.clients.consumer.Consumer<K,V>	createConsumer(java.lang.String groupId, java.lang.String clientIdSuffix) Create a consumer with an explicit group id; in addition, the client id suffix is appended to the client.id property, if both are present.
org.apache.kafka.clients.consumer.Consumer<K,V>	createConsumer(java.lang.String groupId, java.lang.String clientIdPrefix, java.lang.String clientIdSuffix) Create a consumer with an explicit group id; in addition, the client id suffix is appended to the clientIdPrefix which overrides the client.id property, if present.
protected org.apache.kafka.clients.consumer.KafkaConsumer<K,V>	createKafkaConsumer()
protected org.apache.kafka.clients.consumer.KafkaConsumer<K,V>	createKafkaConsumer(java.util.Map<java.lang.String,java.lang.Object> configs)
protected org.apache.kafka.clients.consumer.KafkaConsumer<K,V>	createKafkaConsumer(java.lang.String groupId, java.lang.String clientIdSuffix)
protected org.apache.kafka.clients.consumer.KafkaConsumer<K,V>	createKafkaConsumer(java.lang.String groupId, java.lang.String clientIdPrefix, java.lang.String clientIdSuffix)
java.util.Map<java.lang.String,java.lang.Object>	getConfigurationProperties() Return an unmodifiable reference to the configuration map for this factory.
org.apache.kafka.common.serialization.Deserializer<K>	getKeyDeserializer() Return the configured key deserializer (if provided as an object instead of a class name in the properties).
org.apache.kafka.common.serialization.Deserializer<V>	getValueDeserializer() Return the configured value deserializer (if provided as an object instead of a class name in the properties).
boolean	isAutoCommit() Return true if consumers created by this factory use auto commit.
void	setKeyDeserializer(org.apache.kafka.common.serialization.Deserializer<K> keyDeserializer)
void	setValueDeserializer(org.apache.kafka.common.serialization.Deserializer<V> valueDeserializer)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultKafkaConsumerFactory

public DefaultKafkaConsumerFactory(java.util.Map<java.lang.String,java.lang.Object> configs)

DefaultKafkaConsumerFactory

public DefaultKafkaConsumerFactory(java.util.Map<java.lang.String,java.lang.Object> configs,
                                   org.apache.kafka.common.serialization.Deserializer<K> keyDeserializer,
                                   org.apache.kafka.common.serialization.Deserializer<V> valueDeserializer)

Method Detail

setKeyDeserializer

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

setValueDeserializer

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

getConfigurationProperties

public java.util.Map<java.lang.String,java.lang.Object> getConfigurationProperties()

Description copied from interface: ConsumerFactory

Return an unmodifiable reference to the configuration map for this factory. Useful for cloning to make a similar factory.

Specified by:

getConfigurationProperties in interface ConsumerFactory<K,V>

Returns:

the configs.

getKeyDeserializer

public org.apache.kafka.common.serialization.Deserializer<K> getKeyDeserializer()

Description copied from interface: ConsumerFactory

Return the configured key deserializer (if provided as an object instead of a class name in the properties).

Specified by:

getKeyDeserializer in interface ConsumerFactory<K,V>

Returns:

the deserializer.

getValueDeserializer

public org.apache.kafka.common.serialization.Deserializer<V> getValueDeserializer()

Description copied from interface: ConsumerFactory

Return the configured value deserializer (if provided as an object instead of a class name in the properties).

Specified by:

getValueDeserializer in interface ConsumerFactory<K,V>

Returns:

the deserializer.

createConsumer

public org.apache.kafka.clients.consumer.Consumer<K,V> createConsumer()

Description copied from interface: ConsumerFactory

Create a consumer with the group id and client id as configured in the properties.

Specified by:

createConsumer in interface ConsumerFactory<K,V>

Returns:

the consumer.

createConsumer

public org.apache.kafka.clients.consumer.Consumer<K,V> createConsumer(java.lang.String clientIdSuffix)

Description copied from interface: ConsumerFactory

Create a consumer, appending the suffix to the client.id property, if present.

Specified by:

createConsumer in interface ConsumerFactory<K,V>

Parameters:

clientIdSuffix - the suffix.

Returns:

the consumer.

createConsumer

public org.apache.kafka.clients.consumer.Consumer<K,V> createConsumer(java.lang.String groupId,
                                                                      java.lang.String clientIdSuffix)

Description copied from interface: ConsumerFactory

Create a consumer with an explicit group id; in addition, the client id suffix is appended to the client.id property, if both are present.

Specified by:

createConsumer in interface ConsumerFactory<K,V>

Parameters:

groupId - the group id.

clientIdSuffix - the suffix.

Returns:

the consumer.

createConsumer

public org.apache.kafka.clients.consumer.Consumer<K,V> createConsumer(java.lang.String groupId,
                                                                      java.lang.String clientIdPrefix,
                                                                      java.lang.String clientIdSuffix)

Description copied from interface: ConsumerFactory

Create a consumer with an explicit group id; in addition, the client id suffix is appended to the clientIdPrefix which overrides the client.id property, if present. If a factory does not implement this method, ConsumerFactory.createConsumer(String, String) is invoked, ignoring the prefix. TODO: remove default in 2.2

Specified by:

createConsumer in interface ConsumerFactory<K,V>

Parameters:

groupId - the group id.

clientIdPrefix - the prefix.

clientIdSuffix - the suffix.

Returns:

the consumer.

createKafkaConsumer

protected org.apache.kafka.clients.consumer.KafkaConsumer<K,V> createKafkaConsumer()

createKafkaConsumer

protected org.apache.kafka.clients.consumer.KafkaConsumer<K,V> createKafkaConsumer(java.lang.String groupId,
                                                                                   java.lang.String clientIdSuffix)

createKafkaConsumer

protected org.apache.kafka.clients.consumer.KafkaConsumer<K,V> createKafkaConsumer(java.lang.String groupId,
                                                                                   java.lang.String clientIdPrefix,
                                                                                   java.lang.String clientIdSuffix)

createKafkaConsumer

protected org.apache.kafka.clients.consumer.KafkaConsumer<K,V> createKafkaConsumer(java.util.Map<java.lang.String,java.lang.Object> configs)

isAutoCommit

public boolean isAutoCommit()

Description copied from interface: ConsumerFactory

Return true if consumers created by this factory use auto commit.

Specified by:

isAutoCommit in interface ConsumerFactory<K,V>

Returns:

true if auto commit.