org.apache.pulsar.broker.intercept

Class BrokerInterceptors

java.lang.Object

org.apache.pulsar.broker.intercept.BrokerInterceptors

All Implemented Interfaces:

AutoCloseable, BrokerInterceptor

public class BrokerInterceptors
extends Object
implements BrokerInterceptor

A collection of broker interceptor.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.pulsar.broker.intercept.BrokerInterceptor

BrokerInterceptor.BrokerInterceptorDisabled

Field Summary

Fields inherited from interface org.apache.pulsar.broker.intercept.BrokerInterceptor

DISABLED

Constructor Summary

Constructors

Constructor and Description
BrokerInterceptors(Map<String,BrokerInterceptorWithClassLoader> interceptors)

Method Summary

Modifier and Type	Method and Description
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.
static BrokerInterceptor	load(ServiceConfiguration conf) Load the broker event interceptor for the given interceptor list.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

BrokerInterceptors

public BrokerInterceptors(Map<String,BrokerInterceptorWithClassLoader> interceptors)

Method Detail

load

public static BrokerInterceptor load(ServiceConfiguration conf)
                              throws IOException

Load the broker event interceptor for the given interceptor list.

Parameters:

conf - the pulsar broker service configuration

Returns:

the collection of broker event interceptor

Throws:

IOException

beforeSendMessage

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

Description copied from interface: BrokerInterceptor

Intercept messages before sending them to the consumers.

Specified by:

beforeSendMessage in interface BrokerInterceptor

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

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

Description copied from interface: BrokerInterceptor

Called by the broker while new command incoming.

Specified by:

onPulsarCommand in interface BrokerInterceptor

Throws:

org.apache.pulsar.common.intercept.InterceptException

onConnectionClosed

public void onConnectionClosed(ServerCnx cnx)

Description copied from interface: BrokerInterceptor

Called by the broker while connection closed.

Specified by:

onConnectionClosed in interface BrokerInterceptor

onWebserviceRequest

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

Description copied from interface: BrokerInterceptor

Called by the web service while new request incoming.

Specified by:

onWebserviceRequest in interface BrokerInterceptor

Throws:

IOException

javax.servlet.ServletException

org.apache.pulsar.common.intercept.InterceptException

onWebserviceResponse

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

Description copied from interface: BrokerInterceptor

Intercept the webservice response before send to client.

Specified by:

onWebserviceResponse in interface BrokerInterceptor

Throws:

IOException

javax.servlet.ServletException

initialize

public void initialize(PulsarService pulsarService)
                throws Exception

Description copied from interface: BrokerInterceptor

Initialize the broker interceptor.

Specified by:

initialize in interface BrokerInterceptor

Throws:

Exception - when fail to initialize the broker interceptor.

close

public void close()

Description copied from interface: BrokerInterceptor

Close this broker interceptor.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface BrokerInterceptor