org.springframework.kafka.support

Interface ProducerListener<K,V>

Type Parameters:

K - the key type.

V - the value type.

All Known Implementing Classes:

LoggingProducerListener, ProducerListenerAdapter

public interface ProducerListener<K,V>

Listener for handling outbound Kafka messages. Exactly one of its methods will be invoked, depending on whether the write has been acknowledged or not. Its main goal is to provide a stateless singleton delegate for Callbacks, which, in all but the most trivial cases, requires creating a separate instance per message.

Author:

Marius Bogoevici, Gary Russell

See Also:

Callback

Method Summary

Modifier and Type	Method and Description
boolean	isInterestedInSuccess() Return true if this listener is interested in success as well as failure.
void	onError(java.lang.String topic, java.lang.Integer partition, K key, V value, java.lang.Exception exception) Invoked after an attempt to send a message has failed.
void	onSuccess(java.lang.String topic, java.lang.Integer partition, K key, V value, org.apache.kafka.clients.producer.RecordMetadata recordMetadata) Invoked after the successful send of a message (that is, after it has been acknowledged by the broker).

Method Detail

onSuccess

void onSuccess(java.lang.String topic,
               java.lang.Integer partition,
               K key,
               V value,
               org.apache.kafka.clients.producer.RecordMetadata recordMetadata)

Invoked after the successful send of a message (that is, after it has been acknowledged by the broker).

Parameters:

topic - the destination topic

partition - the destination partition (could be null)

key - the key of the outbound message

value - the payload of the outbound message

recordMetadata - the result of the successful send operation

onError

void onError(java.lang.String topic,
             java.lang.Integer partition,
             K key,
             V value,
             java.lang.Exception exception)

Invoked after an attempt to send a message has failed.

Parameters:

topic - the destination topic

partition - the destination partition (could be null)

key - the key of the outbound message

value - the payload of the outbound message

exception - the exception thrown

isInterestedInSuccess

boolean isInterestedInSuccess()

Return true if this listener is interested in success as well as failure.

Returns:

true to express interest in successful sends.