Method SummaryModifier and TypeMethodDescription
close()Close the interceptor.
booleanCheck whether the interceptor is eligible for this message.
voidThis method is called when partitions of the topic (partitioned-topic) changes.
voidThis method is called when the message sent to the broker has been acknowledged, or when sending the message fails.
closepublic void close()Close the interceptor.
eligiblepublic boolean eligible
(Message message)Check whether the interceptor is eligible for this message.
beforeSendThis is called from
Producer.sendAsync(Object)methods, before send the message to the brokers. This method is allowed to modify the record, in which case, the new record will be returned.
Any exception thrown by this method will be caught by the caller and logged, but not propagated further.
Each interceptor will be passed the message returned by the last successful executed interceptor or the original message if it is the first one. Since interceptors are allowed to modify messages, interceptors may potentially get the message already modified by other interceptors. However, building a pipeline of mutable interceptors that depend on the output of the previous interceptor is discouraged, because of potential side-effects caused by interceptors potentially failing to modify the message and throwing an exception.
onSendAcknowledgementpublic void onSendAcknowledgement
(Producer producer, Message message, MessageId msgId, Throwable exception)This method is called when the message sent to the broker has been acknowledged, or when sending the message fails. This method is generally called just before the user callback is called, and in additional cases when an exception on the producer side.
Any exception thrown by this method will be ignored by the caller.
This method will generally execute in the background I/O thread, so the implementation should be reasonably fast. Otherwise, sending of messages from other threads could be delayed.
- Specified by:
producer- the producer which contains the interceptor.
message- the message that application sends
msgId- the message id that assigned by the broker; null if send failed.
exception- the exception on sending messages, null indicates send has succeed.
onPartitionsChangepublic void onPartitionsChange
(String topicName, int partitions)This method is called when partitions of the topic (partitioned-topic) changes.