org.apache.pulsar.broker.intercept

Interface BrokerInterceptor

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

BrokerInterceptor.BrokerInterceptorDisabled, BrokerInterceptors, BrokerInterceptorWithClassLoader

@InterfaceAudience.LimitedPrivate
 @InterfaceStability.Evolving
public interface BrokerInterceptor
extends AutoCloseable

A plugin interface that allows you to intercept the client requests to the Pulsar brokers.

BrokerInterceptor callbacks may be called from multiple threads. Interceptor implementation must ensure thread-safety, if needed.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	BrokerInterceptor.BrokerInterceptorDisabled Broker interceptor disabled implementation.

Field Summary

Fields

Modifier and Type	Field and Description
static BrokerInterceptor	DISABLED

Method Summary

Modifier and Type	Method and Description
default void	beforeSendMessage(Subscription subscription, Entry entry, long[] ackSet, org.apache.pulsar.common.api.proto.PulsarApi.MessageMetadata msgMetadata) Intercept messages before sending them to the consumers.
void	close() Close this broker interceptor.
void	initialize(PulsarService pulsarService) Initialize the broker interceptor.
void	onConnectionClosed(ServerCnx cnx) Called by the broker while connection closed.
void	onPulsarCommand(org.apache.pulsar.common.api.proto.PulsarApi.BaseCommand command, ServerCnx cnx) Called by the broker while new command incoming.
void	onWebserviceRequest(javax.servlet.ServletRequest request) Called by the web service while new request incoming.
void	onWebserviceResponse(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response) Intercept the webservice response before send to client.

Field Detail

DISABLED

static final BrokerInterceptor DISABLED

Method Detail

beforeSendMessage

default void beforeSendMessage(Subscription subscription,
                               Entry entry,
                               long[] ackSet,
                               org.apache.pulsar.common.api.proto.PulsarApi.MessageMetadata msgMetadata)

Intercept messages before sending them to the consumers.

Parameters:

subscription - pulsar subscription

entry - entry

ackSet - entry ack bitset. it is either null or an array of long-based bitsets.

msgMetadata - message metadata. The message metadata will be recycled after this call.

onPulsarCommand

void onPulsarCommand(org.apache.pulsar.common.api.proto.PulsarApi.BaseCommand command,
                     ServerCnx cnx)
              throws org.apache.pulsar.common.intercept.InterceptException

Called by the broker while new command incoming.

Throws:

org.apache.pulsar.common.intercept.InterceptException

onConnectionClosed

void onConnectionClosed(ServerCnx cnx)

Called by the broker while connection closed.

onWebserviceRequest

void onWebserviceRequest(javax.servlet.ServletRequest request)
                  throws IOException,
                         javax.servlet.ServletException,
                         org.apache.pulsar.common.intercept.InterceptException

Called by the web service while new request incoming.

Throws:

IOException

javax.servlet.ServletException

org.apache.pulsar.common.intercept.InterceptException

onWebserviceResponse

void onWebserviceResponse(javax.servlet.ServletRequest request,
                          javax.servlet.ServletResponse response)
                   throws IOException,
                          javax.servlet.ServletException

Intercept the webservice response before send to client.

Throws:

IOException

javax.servlet.ServletException

initialize

void initialize(PulsarService pulsarService)
         throws Exception

Initialize the broker interceptor.

Throws:

Exception - when fail to initialize the broker interceptor.

close

void close()

Close this broker interceptor.

Specified by:

close in interface AutoCloseable