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 JavaConsumersupporting auto-partition assignment or user-configured assignment.With the latter, initial partition offsets can be provided.
-
-
Field Summary
-
Fields inherited from class org.springframework.kafka.listener.AbstractMessageListenerContainer
consumerFactory, DEFAULT_PHASE, lifecycleMonitor, logger
-
-
Constructor Summary
Constructors Constructor Description KafkaMessageListenerContainer(ConsumerFactory<? super K,? super V> consumerFactory, ContainerProperties containerProperties)Construct an instance with the supplied configuration properties.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected voiddoStart()protected voiddoStop(java.lang.Runnable callback, boolean normal)Stop the container normally or abnormally.java.util.Collection<org.apache.kafka.common.TopicPartition>getAssignedPartitions()Return theTopicPartitions currently assigned to this container, either explicitly or by Kafka; may be null if not assigned yet.java.util.Map<java.lang.String,java.util.Collection<org.apache.kafka.common.TopicPartition>>getAssignmentsByClientId()Return the assigned topics/partitions for this container, by client.id.booleanisContainerPaused()Return true ifMessageListenerContainer.pause()has been called; and all consumers in this container have actually paused.booleanisInExpectedState()Return true if the container is running, has never been started, or has been stopped.booleanisPartitionPaused(org.apache.kafka.common.TopicPartition topicPartition)Whether or not this topic's partition is currently 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 byclient-id.protected AbstractMessageListenerContainer<?,?>parentOrThis()Return this or a parent container if this has a parent.voidpause()Pause this container before the next poll().voidresume()Resume this container, if paused, after the next poll().voidsetClientIdSuffix(java.lang.String clientIdSuffix)Set a suffix to add to theclient.idconsumer property (if the consumer factory supports it).voidsetEmergencyStop(java.lang.Runnable emergencyStop)Set aRunnableto call whenever anErroroccurs on a listener thread.java.lang.StringtoString()-
Methods inherited from class org.springframework.kafka.listener.AbstractMessageListenerContainer
checkGroupId, checkTopics, createSimpleLoggingConsumerRebalanceListener, doStop, getAfterRollbackProcessor, getApplicationContext, getApplicationEventPublisher, getBatchInterceptor, getBeanName, getCommonErrorHandler, getContainerProperties, getGenericErrorHandler, getGroupId, getListenerId, getPhase, getRecordInterceptor, isAutoStartup, isInterceptBeforeTx, isPartitionPauseRequested, isPaused, isPauseRequested, isRunning, isStoppedNormally, pausePartition, publishContainerStoppedEvent, resumePartition, setAfterRollbackProcessor, setApplicationContext, setApplicationEventPublisher, setAutoStartup, setBatchErrorHandler, setBatchInterceptor, setBeanName, setCommonErrorHandler, setErrorHandler, setGenericErrorHandler, setInterceptBeforeTx, setPhase, setRecordInterceptor, setRunning, setStoppedNormally, setTopicCheckTimeout, setupMessageListener, start, stop, stop, stop, stopAbnormally
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.springframework.kafka.listener.MessageListenerContainer
isChildRunning
-
-
-
-
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.
-
-
Method Detail
-
setEmergencyStop
public void setEmergencyStop(java.lang.Runnable emergencyStop)
Set aRunnableto call whenever anErroroccurs 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 theclient.idconsumer 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 theTopicPartitions 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.
-
getAssignmentsByClientId
@Nullable public java.util.Map<java.lang.String,java.util.Collection<org.apache.kafka.common.TopicPartition>> getAssignmentsByClientId()
Description copied from interface:MessageListenerContainerReturn the assigned topics/partitions for this container, by client.id.- Returns:
- the topics/partitions.
-
isContainerPaused
public boolean isContainerPaused()
Description copied from interface:MessageListenerContainerReturn true ifMessageListenerContainer.pause()has been called; and all consumers in this container have actually paused.- Returns:
- true if the container is paused.
-
isPartitionPaused
public boolean isPartitionPaused(org.apache.kafka.common.TopicPartition topicPartition)
Description copied from interface:MessageListenerContainerWhether or not this topic's partition is currently paused.- Parameters:
topicPartition- the topic partition to check- Returns:
- true if this partition has been paused.
-
isInExpectedState
public boolean isInExpectedState()
Description copied from interface:MessageListenerContainerReturn true if the container is running, has never been started, or has been stopped.- Returns:
- true if the state is as expected.
- See Also:
MessageListenerContainer.stopAbnormally(Runnable)
-
pause
public void pause()
Description copied from interface:MessageListenerContainerPause this container before the next poll(). This is a thread-safe operation, the actual pause is processed by the consumer thread.- Specified by:
pausein interfaceMessageListenerContainer- Overrides:
pausein classAbstractMessageListenerContainer<K,V>- See Also:
KafkaConsumer.pause(Collection)
-
resume
public void resume()
Description copied from interface:MessageListenerContainerResume this container, if paused, after the next poll(). This is a thread-safe operation, the actual resume is processed by the consumer thread.- Specified by:
resumein interfaceMessageListenerContainer- Overrides:
resumein classAbstractMessageListenerContainer<K,V>- See Also:
KafkaConsumer.resume(Collection)
-
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:MessageListenerContainerReturn metrics kept by this container's consumer(s), grouped byclient-id.- Returns:
- the consumer(s) metrics grouped by
client-id - See Also:
Consumer.metrics()
-
doStart
protected void doStart()
- Specified by:
doStartin classAbstractMessageListenerContainer<K,V>
-
doStop
protected void doStop(java.lang.Runnable callback, boolean normal)Description copied from class:AbstractMessageListenerContainerStop the container normally or abnormally.- Specified by:
doStopin classAbstractMessageListenerContainer<K,V>- Parameters:
callback- the callback.normal- true for an expected stop.
-
parentOrThis
protected AbstractMessageListenerContainer<?,?> parentOrThis()
Description copied from class:AbstractMessageListenerContainerReturn this or a parent container if this has a parent.- Overrides:
parentOrThisin classAbstractMessageListenerContainer<K,V>- Returns:
- the parent or this.
-
toString
public java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object
-
-