org.springframework.kafka.listener

Interface AcknowledgingConsumerAwareMessageListener<K,V>

Type Parameters:

K - the key type.

V - the value type.

All Superinterfaces:

GenericMessageListener<org.apache.kafka.clients.consumer.ConsumerRecord<K,V>>, MessageListener<K,V>

All Known Implementing Classes:

FilteringMessageListenerAdapter, RecordMessagingMessageListenerAdapter, RetryingMessageListenerAdapter

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface AcknowledgingConsumerAwareMessageListener<K,V>
extends MessageListener<K,V>

Listener for handling incoming Kafka messages, propagating an acknowledgment handle that recipients can invoke when the message has been processed. Access to the Consumer is provided.

Since:

2.0

Author:

Gary Russell

Method Summary

Modifier and Type	Method and Description
default void	onMessage(org.apache.kafka.clients.consumer.ConsumerRecord<K,V> data) Invoked with data from kafka.
void	onMessage(org.apache.kafka.clients.consumer.ConsumerRecord<K,V> data, Acknowledgment acknowledgment, org.apache.kafka.clients.consumer.Consumer<?,?> consumer) Invoked with data from kafka and provides access to the Consumer.

Methods inherited from interface org.springframework.kafka.listener.GenericMessageListener

onMessage, onMessage

Method Detail

onMessage

default void onMessage(org.apache.kafka.clients.consumer.ConsumerRecord<K,V> data)

Invoked with data from kafka. Containers should never call this since it they will detect that we are a consumer aware acknowledging listener.

Specified by:

onMessage in interface GenericMessageListener<org.apache.kafka.clients.consumer.ConsumerRecord<K,V>>

Parameters:

data - the data to be processed.

onMessage

void onMessage(org.apache.kafka.clients.consumer.ConsumerRecord<K,V> data,
               Acknowledgment acknowledgment,
               org.apache.kafka.clients.consumer.Consumer<?,?> consumer)

Description copied from interface: GenericMessageListener

Invoked with data from kafka and provides access to the Consumer. The default implementation throws UnsupportedOperationException.

Specified by:

onMessage in interface GenericMessageListener<org.apache.kafka.clients.consumer.ConsumerRecord<K,V>>

Parameters:

data - the data to be processed.

acknowledgment - the acknowledgment.

consumer - the consumer.