Package org.apache.pulsar.client.api.interceptor

Class ProducerInterceptorWrapper

java.lang.Object

org.apache.pulsar.client.api.interceptor.ProducerInterceptorWrapper

All Implemented Interfaces:

java.lang.AutoCloseable, ProducerInterceptor

@Private
@Stable
public class ProducerInterceptorWrapper
extends java.lang.Object
implements ProducerInterceptor

A wrapper for old style producer interceptor.

Constructor Summary

Constructors

Constructor	Description
ProducerInterceptorWrapper(ProducerInterceptor<?> innerInterceptor)

Method Summary

Modifier and Type	Method	Description
Message	beforeSend(Producer producer, Message message)	This is called from Producer.send(Object) and Producer.sendAsync(Object) methods, before send the message to the brokers.
void	close()	Close the interceptor.
boolean	eligible(Message message)	Check whether the interceptor is eligible for this message.
void	onSendAcknowledgement(Producer producer, Message message, MessageId msgId, java.lang.Throwable exception)	This method is called when the message sent to the broker has been acknowledged, or when sending the message fails.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProducerInterceptorWrapper

public ProducerInterceptorWrapper(ProducerInterceptor<?> innerInterceptor)

Method Detail

close

public void close()

Description copied from interface: ProducerInterceptor

Close the interceptor.

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface ProducerInterceptor

eligible

public boolean eligible(Message message)

Description copied from interface: ProducerInterceptor

Check whether the interceptor is eligible for this message.

Specified by:

eligible in interface ProducerInterceptor

Parameters:

message - message to send

Returns:

whether the interceptor can be applied to this particular message.

beforeSend

public Message beforeSend(Producer producer,
                          Message message)

Description copied from interface: ProducerInterceptor

This is called from Producer.send(Object) and 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.

Specified by:

beforeSend in interface ProducerInterceptor

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,
                                  java.lang.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 interface ProducerInterceptor

Parameters:

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.