org.springframework.kafka.listener

Class KafkaMessageListenerContainer<K,V>

java.lang.Object

org.springframework.kafka.listener.AbstractMessageListenerContainer<K,V>

org.springframework.kafka.listener.KafkaMessageListenerContainer<K,V>

Type Parameters:

K - the key type.

V - the value type.

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.context.ApplicationContextAware, org.springframework.context.ApplicationEventPublisherAware, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle, GenericMessageListenerContainer<K,V>, MessageListenerContainer

public class KafkaMessageListenerContainer<K,V>
extends AbstractMessageListenerContainer<K,V>

Single-threaded Message listener container using the Java Consumer supporting auto-partition assignment or user-configured assignment.

With the latter, initial partition offsets can be provided.

Author:

Gary Russell, Murali Reddy, Marius Bogoevici, Martin Dam, Artem Bilan, Loic Talhouarne, Vladimir Tsanev, Chen Binbin, Yang Qiju, Tom van den Berge, Lukasz Kaminski

Field Summary

Fields inherited from class org.springframework.kafka.listener.AbstractMessageListenerContainer

consumerFactory, DEFAULT_PHASE, lifecycleMonitor, logger

Constructor Summary

Constructors

Constructor and Description
KafkaMessageListenerContainer(ConsumerFactory<? super K,? super V> consumerFactory, ContainerProperties containerProperties) Construct an instance with the supplied configuration properties.
KafkaMessageListenerContainer(ConsumerFactory<? super K,? super V> consumerFactory, ContainerProperties containerProperties, TopicPartitionOffset... topicPartitions) Deprecated. - the topicPartitions should be provided in the ContainerProperties.

Method Summary

Modifier and Type	Method and Description
protected void	doStart()
protected void	doStop(java.lang.Runnable callback)
java.util.Collection<org.apache.kafka.common.TopicPartition>	getAssignedPartitions() Return the TopicPartitions currently assigned to this container, either explicitly or by Kafka; may be null if not assigned yet.
boolean	isContainerPaused() Return true if MessageListenerContainer.pause() has been called; and all consumers in this container have actually paused.
java.util.Map<java.lang.String,java.util.Map<org.apache.kafka.common.MetricName,? extends org.apache.kafka.common.Metric>>	metrics() Return metrics kept by this container's consumer(s), grouped by client-id.
protected AbstractMessageListenerContainer<?,?>	parentOrThis() Return this or a parent container if this has a parent.
void	setClientIdSuffix(java.lang.String clientIdSuffix) Set a suffix to add to the client.id consumer property (if the consumer factory supports it).
void	setEmergencyStop(java.lang.Runnable emergencyStop) Set a Runnable to call whenever an Error occurs on a listener thread.
java.lang.String	toString()

Methods inherited from class org.springframework.kafka.listener.AbstractMessageListenerContainer

checkGroupId, checkTopics, createSimpleLoggingConsumerRebalanceListener, getAfterRollbackProcessor, getApplicationContext, getApplicationEventPublisher, getBeanName, getContainerProperties, getGenericErrorHandler, getGroupId, getListenerId, getPhase, getRecordInterceptor, isAutoStartup, isInterceptBeforeTx, isPaused, isPauseRequested, isRunning, pause, publishContainerStoppedEvent, resume, setAfterRollbackProcessor, setApplicationContext, setApplicationEventPublisher, setAutoStartup, setBatchErrorHandler, setBeanName, setErrorHandler, setGenericErrorHandler, setInterceptBeforeTx, setPhase, setRecordInterceptor, setRunning, setTopicCheckTimeout, setupMessageListener, start, stop, stop, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

KafkaMessageListenerContainer

public KafkaMessageListenerContainer(ConsumerFactory<? super K,? super V> consumerFactory,
                                     ContainerProperties containerProperties)

Construct an instance with the supplied configuration properties.

Parameters:

consumerFactory - the consumer factory.

containerProperties - the container properties.

KafkaMessageListenerContainer

@Deprecated
public KafkaMessageListenerContainer(ConsumerFactory<? super K,? super V> consumerFactory,
                                                 ContainerProperties containerProperties,
                                                 TopicPartitionOffset... topicPartitions)

Deprecated. - the topicPartitions should be provided in the ContainerProperties.

Construct an instance with the supplied configuration properties and specific topics/partitions/initialOffsets.

Parameters:

consumerFactory - the consumer factory.

containerProperties - the container properties.

topicPartitions - the topics/partitions; duplicates are eliminated.

Method Detail

setEmergencyStop

public void setEmergencyStop(java.lang.Runnable emergencyStop)

Set a Runnable to call whenever an Error occurs on a listener thread.

Parameters:

emergencyStop - the Runnable.

Since:

2.2.1

setClientIdSuffix

public void setClientIdSuffix(java.lang.String clientIdSuffix)

Set a suffix to add to the client.id consumer property (if the consumer factory supports it).

Parameters:

clientIdSuffix - the suffix to add.

Since:

1.0.6

getAssignedPartitions

@Nullable
public java.util.Collection<org.apache.kafka.common.TopicPartition> getAssignedPartitions()

Return the TopicPartitions currently assigned to this container, either explicitly or by Kafka; may be null if not assigned yet.

Returns:

the TopicPartitions currently assigned to this container, either explicitly or by Kafka; may be null if not assigned yet.

isContainerPaused

public boolean isContainerPaused()

Description copied from interface: MessageListenerContainer

Return true if MessageListenerContainer.pause() has been called; and all consumers in this container have actually paused.

Returns:

true if the container is paused.

metrics

public java.util.Map<java.lang.String,java.util.Map<org.apache.kafka.common.MetricName,? extends org.apache.kafka.common.Metric>> metrics()

Description copied from interface: MessageListenerContainer

Return metrics kept by this container's consumer(s), grouped by client-id.

Returns:

the consumer(s) metrics grouped by client-id

See Also:

Consumer.metrics()

doStart

protected void doStart()

Specified by:

doStart in class AbstractMessageListenerContainer<K,V>

doStop

protected void doStop(java.lang.Runnable callback)

Specified by:

doStop in class AbstractMessageListenerContainer<K,V>

parentOrThis

protected AbstractMessageListenerContainer<?,?> parentOrThis()

Description copied from class: AbstractMessageListenerContainer

Return this or a parent container if this has a parent.

Overrides:

parentOrThis in class AbstractMessageListenerContainer<K,V>

Returns:

the parent or this.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object