Uses of Interface
org.springframework.kafka.listener.MessageListenerContainer
Package
Description
Package for kafka configuration
Package for kafka listeners
-
Uses of MessageListenerContainer in org.springframework.kafka.config
Modifier and TypeMethodDescriptionprotected MessageListenerContainer
KafkaListenerEndpointRegistry.createListenerContainer
(KafkaListenerEndpoint endpoint, KafkaListenerContainerFactory<?> factory) Create and start a newMessageListenerContainer
using the specified factory.KafkaListenerEndpointRegistry.getListenerContainer
(String id) Return theMessageListenerContainer
with the specified id ornull
if no such container exists.KafkaListenerEndpointRegistry.getUnregisteredListenerContainer
(String id) KafkaListenerEndpointRegistry.unregisterListenerContainer
(String id) Unregister the listener container with the provided id.Modifier and TypeMethodDescriptionKafkaListenerEndpointRegistry.getAllListenerContainers()
Return allMessageListenerContainer
instances including those managed by this registry and those declared as beans in the application context.KafkaListenerEndpointRegistry.getListenerContainers()
Return the managedMessageListenerContainer
instance(s).Modifier and TypeMethodDescriptionprotected abstract MessagingMessageListenerAdapter<K,
V> AbstractKafkaListenerEndpoint.createMessageListener
(MessageListenerContainer container, MessageConverter messageConverter) Create aMessageListener
that is able to serve this endpoint for the specified container.protected MessagingMessageListenerAdapter<K,
V> MethodKafkaListenerEndpoint.createMessageListener
(MessageListenerContainer container, MessageConverter messageConverter) void
AbstractKafkaListenerEndpoint.setupListenerContainer
(MessageListenerContainer listenerContainer, MessageConverter messageConverter) void
KafkaListenerEndpoint.setupListenerContainer
(MessageListenerContainer listenerContainer, MessageConverter messageConverter) Setup the specified message listener container with the model defined by this endpoint.Modifier and TypeMethodDescriptionvoid
AbstractKafkaListenerContainerFactory.setThreadNameSupplier
(Function<MessageListenerContainer, String> threadNameSupplier) Set a function used to change the consumer thread name. -
Uses of MessageListenerContainer in org.springframework.kafka.listener
Modifier and TypeInterfaceDescriptioninterface
Generic message listener container; adds parameters.Modifier and TypeClassDescriptionclass
The base implementation for theMessageListenerContainer
.class
Creates 1 or moreKafkaMessageListenerContainer
s based onconcurrency
.class
Single-threaded Message listener container using the JavaConsumer
supporting auto-partition assignment or user-configured assignment.Modifier and TypeMethodDescriptionConcurrentMessageListenerContainer.getContainerFor
(String topic, int partition) default MessageListenerContainer
MessageListenerContainer.getContainerFor
(String topic, int partition) If this container has child containers, return the child container that is assigned the topic/partition.ListenerContainerRegistry.getListenerContainer
(String id) Return theMessageListenerContainer
with the specified id ornull
if no such container exists.ListenerContainerRegistry.getUnregisteredListenerContainer
(String id) Return theMessageListenerContainer
with the specified id ornull
if no such container exists.Modifier and TypeMethodDescriptionListenerContainerRegistry.getAllListenerContainers()
Return allMessageListenerContainer
instances including those managed by this registry and those declared as beans in the application context.ListenerContainerRegistry.getListenerContainers()
Return the managedMessageListenerContainer
instance(s).AbstractMessageListenerContainer.getThreadNameSupplier()
Return the function used to change the consumer thread name.Modifier and TypeMethodDescriptionvoid
ContainerGroup.addContainers
(MessageListenerContainer... theContainers) Add one or more containers to the group.void
ConcurrentMessageListenerContainer.childStopped
(MessageListenerContainer child, ConsumerStoppedEvent.Reason reason) void
KafkaMessageListenerContainer.childStopped
(MessageListenerContainer child, ConsumerStoppedEvent.Reason reason) default void
MessageListenerContainer.childStopped
(MessageListenerContainer child, ConsumerStoppedEvent.Reason reason) Notify a parent container that a child container has stopped.boolean
ContainerGroup.contains
(MessageListenerContainer container) Return true if the provided container is in this group.static org.apache.kafka.clients.consumer.OffsetAndMetadata
ListenerUtils.createOffsetAndMetadata
(MessageListenerContainer container, long offset) Create a newOffsetAndMetadata
using the given container and offset.protected void
FailedBatchProcessor.doHandle
(Exception thrownException, org.apache.kafka.clients.consumer.ConsumerRecords<?, ?> data, org.apache.kafka.clients.consumer.Consumer<?, ?> consumer, MessageListenerContainer container, Runnable invokeListener) static boolean
SeekUtils.doSeeks
(List<org.apache.kafka.clients.consumer.ConsumerRecord<?, ?>> records, org.apache.kafka.clients.consumer.Consumer<?, ?> consumer, Exception exception, boolean recoverable, RecoveryStrategy recovery, MessageListenerContainer container, LogAccessor logger) Seek records to earliest position, optionally skipping the first.default void
BatchErrorHandler.handle
(Exception thrownException, org.apache.kafka.clients.consumer.ConsumerRecords<?, ?> data, org.apache.kafka.clients.consumer.Consumer<?, ?> consumer, MessageListenerContainer container) Deprecated, for removal: This API element is subject to removal in a future version.Handle the exception.default void
BatchErrorHandler.handle
(Exception thrownException, org.apache.kafka.clients.consumer.ConsumerRecords<?, ?> data, org.apache.kafka.clients.consumer.Consumer<?, ?> consumer, MessageListenerContainer container, Runnable invokeListener) Deprecated, for removal: This API element is subject to removal in a future version.Handle the exception.default void
ConsumerAwareBatchErrorHandler.handle
(Exception thrownException, org.apache.kafka.clients.consumer.ConsumerRecords<?, ?> data, org.apache.kafka.clients.consumer.Consumer<?, ?> consumer, MessageListenerContainer container) Deprecated, for removal: This API element is subject to removal in a future version.default void
ConsumerAwareErrorHandler.handle
(Exception thrownException, List<org.apache.kafka.clients.consumer.ConsumerRecord<?, ?>> data, org.apache.kafka.clients.consumer.Consumer<?, ?> consumer, MessageListenerContainer container) Deprecated, for removal: This API element is subject to removal in a future version.void
ContainerAwareBatchErrorHandler.handle
(Exception thrownException, org.apache.kafka.clients.consumer.ConsumerRecords<?, ?> data, org.apache.kafka.clients.consumer.Consumer<?, ?> consumer, MessageListenerContainer container) Deprecated, for removal: This API element is subject to removal in a future version.default void
ContainerAwareBatchErrorHandler.handle
(Exception thrownException, org.apache.kafka.clients.consumer.ConsumerRecords<?, ?> data, org.apache.kafka.clients.consumer.Consumer<?, ?> consumer, MessageListenerContainer container, Runnable invokeListener) Deprecated, for removal: This API element is subject to removal in a future version.Handle the exception.void
ContainerAwareErrorHandler.handle
(Exception thrownException, List<org.apache.kafka.clients.consumer.ConsumerRecord<?, ?>> records, org.apache.kafka.clients.consumer.Consumer<?, ?> consumer, MessageListenerContainer container) Deprecated, for removal: This API element is subject to removal in a future version.default void
ErrorHandler.handle
(Exception thrownException, List<org.apache.kafka.clients.consumer.ConsumerRecord<?, ?>> records, org.apache.kafka.clients.consumer.Consumer<?, ?> consumer, MessageListenerContainer container) Deprecated, for removal: This API element is subject to removal in a future version.Handle the exception.protected <K,
V> org.apache.kafka.clients.consumer.ConsumerRecords<K, V> FailedBatchProcessor.handle
(Exception thrownException, org.apache.kafka.clients.consumer.ConsumerRecords<?, ?> data, org.apache.kafka.clients.consumer.Consumer<?, ?> consumer, MessageListenerContainer container, Runnable invokeListener) default void
ListenerInvokingBatchErrorHandler.handle
(Exception thrownException, org.apache.kafka.clients.consumer.ConsumerRecords<?, ?> data, org.apache.kafka.clients.consumer.Consumer<?, ?> consumer, MessageListenerContainer container) Deprecated, for removal: This API element is subject to removal in a future version.void
ListenerInvokingBatchErrorHandler.handle
(Exception thrownException, org.apache.kafka.clients.consumer.ConsumerRecords<?, ?> records, org.apache.kafka.clients.consumer.Consumer<?, ?> consumer, MessageListenerContainer container, Runnable invokeListener) Deprecated, for removal: This API element is subject to removal in a future version.default void
RemainingRecordsErrorHandler.handle
(Exception thrownException, List<org.apache.kafka.clients.consumer.ConsumerRecord<?, ?>> records, org.apache.kafka.clients.consumer.Consumer<?, ?> consumer, MessageListenerContainer container) Deprecated, for removal: This API element is subject to removal in a future version.void
CommonContainerStoppingErrorHandler.handleBatch
(Exception thrownException, org.apache.kafka.clients.consumer.ConsumerRecords<?, ?> data, org.apache.kafka.clients.consumer.Consumer<?, ?> consumer, MessageListenerContainer container, Runnable invokeListener) void
CommonDelegatingErrorHandler.handleBatch
(Exception thrownException, org.apache.kafka.clients.consumer.ConsumerRecords<?, ?> data, org.apache.kafka.clients.consumer.Consumer<?, ?> consumer, MessageListenerContainer container, Runnable invokeListener) default void
CommonErrorHandler.handleBatch
(Exception thrownException, org.apache.kafka.clients.consumer.ConsumerRecords<?, ?> data, org.apache.kafka.clients.consumer.Consumer<?, ?> consumer, MessageListenerContainer container, Runnable invokeListener) Handle the exception for a batch listener.void
CommonLoggingErrorHandler.handleBatch
(Exception thrownException, org.apache.kafka.clients.consumer.ConsumerRecords<?, ?> data, org.apache.kafka.clients.consumer.Consumer<?, ?> consumer, MessageListenerContainer container, Runnable invokeListener) void
CommonMixedErrorHandler.handleBatch
(Exception thrownException, org.apache.kafka.clients.consumer.ConsumerRecords<?, ?> data, org.apache.kafka.clients.consumer.Consumer<?, ?> consumer, MessageListenerContainer container, Runnable invokeListener) void
DefaultErrorHandler.handleBatch
(Exception thrownException, org.apache.kafka.clients.consumer.ConsumerRecords<?, ?> data, org.apache.kafka.clients.consumer.Consumer<?, ?> consumer, MessageListenerContainer container, Runnable invokeListener) default <K,
V> org.apache.kafka.clients.consumer.ConsumerRecords<K, V> CommonErrorHandler.handleBatchAndReturnRemaining
(Exception thrownException, org.apache.kafka.clients.consumer.ConsumerRecords<?, ?> data, org.apache.kafka.clients.consumer.Consumer<?, ?> consumer, MessageListenerContainer container, Runnable invokeListener) Handle the exception for a batch listener.<K,
V> org.apache.kafka.clients.consumer.ConsumerRecords<K, V> DefaultErrorHandler.handleBatchAndReturnRemaining
(Exception thrownException, org.apache.kafka.clients.consumer.ConsumerRecords<?, ?> data, org.apache.kafka.clients.consumer.Consumer<?, ?> consumer, MessageListenerContainer container, Runnable invokeListener) boolean
CommonDelegatingErrorHandler.handleOne
(Exception thrownException, org.apache.kafka.clients.consumer.ConsumerRecord<?, ?> record, org.apache.kafka.clients.consumer.Consumer<?, ?> consumer, MessageListenerContainer container) default boolean
CommonErrorHandler.handleOne
(Exception thrownException, org.apache.kafka.clients.consumer.ConsumerRecord<?, ?> record, org.apache.kafka.clients.consumer.Consumer<?, ?> consumer, MessageListenerContainer container) Handle the exception for a record listener whenCommonErrorHandler.remainingRecords()
returns false.boolean
CommonLoggingErrorHandler.handleOne
(Exception thrownException, org.apache.kafka.clients.consumer.ConsumerRecord<?, ?> record, org.apache.kafka.clients.consumer.Consumer<?, ?> consumer, MessageListenerContainer container) boolean
CommonMixedErrorHandler.handleOne
(Exception thrownException, org.apache.kafka.clients.consumer.ConsumerRecord<?, ?> record, org.apache.kafka.clients.consumer.Consumer<?, ?> consumer, MessageListenerContainer container) boolean
DefaultErrorHandler.handleOne
(Exception thrownException, org.apache.kafka.clients.consumer.ConsumerRecord<?, ?> record, org.apache.kafka.clients.consumer.Consumer<?, ?> consumer, MessageListenerContainer container) void
CommonContainerStoppingErrorHandler.handleOtherException
(Exception thrownException, org.apache.kafka.clients.consumer.Consumer<?, ?> consumer, MessageListenerContainer container, boolean batchListener) void
CommonDelegatingErrorHandler.handleOtherException
(Exception thrownException, org.apache.kafka.clients.consumer.Consumer<?, ?> consumer, MessageListenerContainer container, boolean batchListener) default void
CommonErrorHandler.handleOtherException
(Exception thrownException, org.apache.kafka.clients.consumer.Consumer<?, ?> consumer, MessageListenerContainer container, boolean batchListener) Called when an exception is thrown with no records available, e.g.void
CommonLoggingErrorHandler.handleOtherException
(Exception thrownException, org.apache.kafka.clients.consumer.Consumer<?, ?> consumer, MessageListenerContainer container, boolean batchListener) void
CommonMixedErrorHandler.handleOtherException
(Exception thrownException, org.apache.kafka.clients.consumer.Consumer<?, ?> consumer, MessageListenerContainer container, boolean batchListener) void
DefaultErrorHandler.handleOtherException
(Exception thrownException, org.apache.kafka.clients.consumer.Consumer<?, ?> consumer, MessageListenerContainer container, boolean batchListener) default void
CommonErrorHandler.handleRecord
(Exception thrownException, org.apache.kafka.clients.consumer.ConsumerRecord<?, ?> record, org.apache.kafka.clients.consumer.Consumer<?, ?> consumer, MessageListenerContainer container) Deprecated, for removal: This API element is subject to removal in a future version.void
CommonContainerStoppingErrorHandler.handleRemaining
(Exception thrownException, List<org.apache.kafka.clients.consumer.ConsumerRecord<?, ?>> records, org.apache.kafka.clients.consumer.Consumer<?, ?> consumer, MessageListenerContainer container) void
CommonDelegatingErrorHandler.handleRemaining
(Exception thrownException, List<org.apache.kafka.clients.consumer.ConsumerRecord<?, ?>> records, org.apache.kafka.clients.consumer.Consumer<?, ?> consumer, MessageListenerContainer container) default void
CommonErrorHandler.handleRemaining
(Exception thrownException, List<org.apache.kafka.clients.consumer.ConsumerRecord<?, ?>> records, org.apache.kafka.clients.consumer.Consumer<?, ?> consumer, MessageListenerContainer container) Handle the exception for a record listener whenCommonErrorHandler.remainingRecords()
returns true.void
CommonMixedErrorHandler.handleRemaining
(Exception thrownException, List<org.apache.kafka.clients.consumer.ConsumerRecord<?, ?>> records, org.apache.kafka.clients.consumer.Consumer<?, ?> consumer, MessageListenerContainer container) void
DefaultErrorHandler.handleRemaining
(Exception thrownException, List<org.apache.kafka.clients.consumer.ConsumerRecord<?, ?>> records, org.apache.kafka.clients.consumer.Consumer<?, ?> consumer, MessageListenerContainer container) default void
BackOffHandler.onNextBackOff
(MessageListenerContainer container, Exception exception, long nextBackOff) Perform the next back off.default void
BackOffHandler.onNextBackOff
(MessageListenerContainer container, org.apache.kafka.common.TopicPartition partition, long nextBackOff) Perform the next back off for a partition.void
ContainerPausingBackOffHandler.onNextBackOff
(MessageListenerContainer container, Exception exception, long nextBackOff) void
ContainerPausingBackOffHandler.onNextBackOff
(MessageListenerContainer container, org.apache.kafka.common.TopicPartition partition, long nextBackOff) void
DefaultBackOffHandler.onNextBackOff
(MessageListenerContainer container, Exception exception, long nextBackOff) void
ListenerContainerPauseService.pause
(MessageListenerContainer messageListenerContainer, Duration pauseDuration) Pause the listener by given container instance.void
ListenerContainerPauseService.pausePartition
(MessageListenerContainer messageListenerContainer, org.apache.kafka.common.TopicPartition partition, Duration pauseDuration) Pause consumption from a given partition for the duration.void
AfterRollbackProcessor.process
(List<org.apache.kafka.clients.consumer.ConsumerRecord<K, V>> records, org.apache.kafka.clients.consumer.Consumer<K, V> consumer, MessageListenerContainer container, Exception exception, boolean recoverable, ContainerProperties.EOSMode eosMode) Process the remaining records.void
DefaultAfterRollbackProcessor.process
(List<org.apache.kafka.clients.consumer.ConsumerRecord<K, V>> records, org.apache.kafka.clients.consumer.Consumer<K, V> consumer, MessageListenerContainer container, Exception exception, boolean recoverable, ContainerProperties.EOSMode eosMode) boolean
RecoveryStrategy.recovered
(org.apache.kafka.clients.consumer.ConsumerRecord<?, ?> record, Exception ex, MessageListenerContainer container, org.apache.kafka.clients.consumer.Consumer<?, ?> consumer) Return true if the record should be skipped because it was successfully recovered.boolean
ContainerGroup.removeContainer
(MessageListenerContainer container) Remove a container from the group.void
ListenerContainerPauseService.resume
(MessageListenerContainer messageListenerContainer) Resume the listener container.static void
ErrorHandlingUtils.retryBatch
(Exception thrownException, org.apache.kafka.clients.consumer.ConsumerRecords<?, ?> records, org.apache.kafka.clients.consumer.Consumer<?, ?> consumer, MessageListenerContainer container, Runnable invokeListener, BackOff backOff, CommonErrorHandler seeker, BiConsumer<org.apache.kafka.clients.consumer.ConsumerRecords<?, ?>, Exception> recoverer, LogAccessor logger, KafkaException.Level logLevel, List<RetryListener> retryListeners, org.springframework.classify.BinaryExceptionClassifier classifier) static void
ErrorHandlingUtils.retryBatch
(Exception thrownException, org.apache.kafka.clients.consumer.ConsumerRecords<?, ?> records, org.apache.kafka.clients.consumer.Consumer<?, ?> consumer, MessageListenerContainer container, Runnable invokeListener, BackOff backOff, CommonErrorHandler seeker, BiConsumer<org.apache.kafka.clients.consumer.ConsumerRecords<?, ?>, Exception> recoverer, LogAccessor logger, KafkaException.Level logLevel, List<RetryListener> retryListeners, org.springframework.classify.BinaryExceptionClassifier classifier, boolean reClassifyOnExceptionChange) Retry a complete batch by pausing the consumer and then, in a loop, poll the consumer, wait for the next back off, then call the listener.static void
SeekUtils.seekOrRecover
(Exception thrownException, List<org.apache.kafka.clients.consumer.ConsumerRecord<?, ?>> records, org.apache.kafka.clients.consumer.Consumer<?, ?> consumer, MessageListenerContainer container, boolean commitRecovered, BiPredicate<org.apache.kafka.clients.consumer.ConsumerRecord<?, ?>, Exception> skipPredicate, LogAccessor logger, KafkaException.Level level) Seek the remaining records, optionally recovering the first.static void
SeekUtils.seekOrRecover
(Exception thrownException, List<org.apache.kafka.clients.consumer.ConsumerRecord<?, ?>> records, org.apache.kafka.clients.consumer.Consumer<?, ?> consumer, MessageListenerContainer container, boolean commitRecovered, RecoveryStrategy recovery, LogAccessor logger, KafkaException.Level level) Seek the remaining records, optionally recovering the first.static void
ListenerUtils.stoppableSleep
(MessageListenerContainer container, long interval) Sleep for the desired timeout, as long as the container continues to run.static void
ListenerUtils.unrecoverableBackOff
(BackOff backOff, ThreadLocal<BackOffExecution> executions, ThreadLocal<Long> lastIntervals, MessageListenerContainer container) Sleep according to theBackOff
; when theBackOffExecution
returnsBackOffExecution.STOP
sleep for the previous backOff.Modifier and TypeMethodDescriptionvoid
AbstractMessageListenerContainer.setThreadNameSupplier
(Function<MessageListenerContainer, String> threadNameSupplier) Set a function used to change the consumer thread name.ModifierConstructorDescriptionContainerGroup
(String name, MessageListenerContainer... containers) Construct an instance with the provided name and containers.ModifierConstructorDescriptionContainerGroup
(String name, List<MessageListenerContainer> containers) Construct an instance with the provided name and containers.
CommonErrorHandler.handleOne(Exception, ConsumerRecord, Consumer, MessageListenerContainer)
.