Class ProducerInterceptorWrapper
- All Implemented Interfaces:
AutoCloseable
,ProducerInterceptor
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbeforeSend
(Producer producer, Message message) This is called fromProducer.send(Object)
andProducer.sendAsync(Object)
methods, before send the message to the brokers.void
close()
Close the interceptor.boolean
Check whether the interceptor is eligible for this message.void
onPartitionsChange
(String topicName, int partitions) This method is called when partitions of the topic (partitioned-topic) changes.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.
-
Constructor Details
-
ProducerInterceptorWrapper
-
-
Method Details
-
close
public void close()Description copied from interface:ProducerInterceptor
Close the interceptor.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceProducerInterceptor
-
eligible
Description copied from interface:ProducerInterceptor
Check whether the interceptor is eligible for this message.- Specified by:
eligible
in interfaceProducerInterceptor
- Parameters:
message
- message to send- Returns:
- whether the interceptor can be applied to this particular message.
-
beforeSend
Description copied from interface:ProducerInterceptor
This is called fromProducer.send(Object)
andProducer.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.
- Specified by:
beforeSend
in interfaceProducerInterceptor
- Parameters:
producer
- the producer which contains the interceptor.message
- message to send- Returns:
- the intercepted message
-
onSendAcknowledgement
public void onSendAcknowledgement(Producer producer, Message message, MessageId msgId, Throwable exception) Description copied from interface:ProducerInterceptor
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:
onSendAcknowledgement
in interfaceProducerInterceptor
- Parameters:
producer
- the producer which contains the interceptor.message
- the message that application sendsmsgId
- the message id that assigned by the broker; null if send failed.exception
- the exception on sending messages, null indicates send has succeed.
-
onPartitionsChange
Description copied from interface:ProducerInterceptor
This method is called when partitions of the topic (partitioned-topic) changes.- Specified by:
onPartitionsChange
in interfaceProducerInterceptor
- Parameters:
topicName
- topic namepartitions
- new updated partitions
-