Package org.apache.pulsar.client.api

Interface ReaderInterceptor<T>

Type Parameters:

T -

@Public
@Stable
public interface ReaderInterceptor<T>

Reader interceptor.

Method Summary

Modifier and Type	Method	Description
Message<T>	beforeRead(Reader<T> reader, Message<T> message)	This is called just before the message is returned by Reader.readNext(), ReaderListener.received(Reader, Message) or the CompletableFuture returned by Reader.readNextAsync() completes.
void	close()	Close the interceptor.
default void	onPartitionsChange(String topicName, int partitions)	This method is called when partitions of the topic (partitioned-topic) changes.

Method Details

close

void close()

Close the interceptor.

beforeRead

Message<T> beforeRead(Reader<T> reader,
 Message<T> message)

This is called just before the message is returned by Reader.readNext(), ReaderListener.received(Reader, Message) or the CompletableFuture returned by Reader.readNextAsync() completes. This method is based on ConsumerInterceptor.beforeConsume(Consumer, Message), so it has the same features.

Parameters:

reader - the reader which contains the interceptor

message - the message to be read by the client.

Returns:

message that is either modified by the interceptor or same message passed into the method.

onPartitionsChange

default void onPartitionsChange(String topicName,
 int partitions)

This method is called when partitions of the topic (partitioned-topic) changes.

Parameters:

topicName - topic name

partitions - new updated number of partitions