Package 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.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	beforeSendMessage(Subscription subscription, Entry entry, long[] ackSet, org.apache.pulsar.common.api.proto.MessageMetadata msgMetadata)	Intercept messages before sending them to the consumers.
void	beforeSendMessage(Subscription subscription, Entry entry, long[] ackSet, org.apache.pulsar.common.api.proto.MessageMetadata msgMetadata, Consumer consumer)	Intercept messages before sending them to the consumers.
void	close()	Close this broker interceptor.
void	consumerClosed(ServerCnx cnx, Consumer consumer, Map<String,String> metadata)	Called by the broker when a consumer is closed.
void	consumerCreated(ServerCnx cnx, Consumer consumer, Map<String,String> metadata)	Intercept after a consumer is created.
Map<String,BrokerInterceptorWithClassLoader>	getInterceptors()
void	initialize(PulsarService pulsarService)	Initialize the broker interceptor.
static BrokerInterceptor	load(ServiceConfiguration conf)	Load the broker event interceptor for the given interceptor list.
void	messageAcked(ServerCnx cnx, Consumer consumer, org.apache.pulsar.common.api.proto.CommandAck ackCmd)	Intercept after a message ack is processed.
void	messageDispatched(ServerCnx cnx, Consumer consumer, long ledgerId, long entryId, io.netty.buffer.ByteBuf headersAndPayload)	Intercept after a message is dispatched to consumer.
void	messageProduced(ServerCnx cnx, Producer producer, long startTimeNs, long ledgerId, long entryId, Topic.PublishContext publishContext)	Intercept after a message is produced.
void	onConnectionClosed(ServerCnx cnx)	Called by the broker while connection closed.
void	onConnectionCreated(ServerCnx cnx)	Called by the broker when a new connection is created.
void	onMessagePublish(Producer producer, io.netty.buffer.ByteBuf headersAndPayload, Topic.PublishContext publishContext)	Intercept message when broker receive a send request.
void	onPulsarCommand(org.apache.pulsar.common.api.proto.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.
void	producerClosed(ServerCnx cnx, Producer producer, Map<String,String> metadata)	Called by the broker when a producer is closed.
void	producerCreated(ServerCnx cnx, Producer producer, Map<String,String> metadata)	Called by the broker when a new connection is created.
void	txnEnded(String txnID, long txnAction)	Intercept when a transaction ends.
void	txnOpened(long tcId, String txnID)	Intercept when a transaction begins.

Methods inherited from class java.lang.Object

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

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

onFilter

Constructor Details

BrokerInterceptors

public BrokerInterceptors(Map<String,BrokerInterceptorWithClassLoader> interceptors)

Method Details

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

onMessagePublish

public void onMessagePublish(Producer producer,
 io.netty.buffer.ByteBuf headersAndPayload,
 Topic.PublishContext publishContext)

Description copied from interface: BrokerInterceptor

Intercept message when broker receive a send request.

Specified by:

onMessagePublish in interface BrokerInterceptor

headersAndPayload - entry's header and payload

publishContext - Publish Context

beforeSendMessage

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

Description copied from interface: BrokerInterceptor

Intercept messages before sending them to the consumers. Deprecated, use BrokerInterceptor.beforeSendMessage(Subscription, Entry, long[], MessageMetadata, Consumer) instead.

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.

beforeSendMessage

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

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.

consumer - consumer. Consumer which entry are sent to.

consumerCreated

public void consumerCreated(ServerCnx cnx,
 Consumer consumer,
 Map<String,String> metadata)

Description copied from interface: BrokerInterceptor

Intercept after a consumer is created.

Specified by:

consumerCreated in interface BrokerInterceptor

Parameters:

cnx - client Connection

consumer - Consumer object

metadata - A map of metadata

consumerClosed

public void consumerClosed(ServerCnx cnx,
 Consumer consumer,
 Map<String,String> metadata)

Description copied from interface: BrokerInterceptor

Called by the broker when a consumer is closed.

Specified by:

consumerClosed in interface BrokerInterceptor

Parameters:

cnx - client Connection

consumer - Consumer object

metadata - A map of metadata

producerCreated

public void producerCreated(ServerCnx cnx,
 Producer producer,
 Map<String,String> metadata)

Description copied from interface: BrokerInterceptor

Called by the broker when a new connection is created.

Specified by:

producerCreated in interface BrokerInterceptor

producerClosed

public void producerClosed(ServerCnx cnx,
 Producer producer,
 Map<String,String> metadata)

Description copied from interface: BrokerInterceptor

Called by the broker when a producer is closed.

Specified by:

producerClosed in interface BrokerInterceptor

Parameters:

cnx - client Connection

producer - Producer object

metadata - A map of metadata

messageProduced

public void messageProduced(ServerCnx cnx,
 Producer producer,
 long startTimeNs,
 long ledgerId,
 long entryId,
 Topic.PublishContext publishContext)

Description copied from interface: BrokerInterceptor

Intercept after a message is produced.

Specified by:

messageProduced in interface BrokerInterceptor

Parameters:

cnx - client Connection

producer - Producer object

publishContext - Publish Context

messageDispatched

public void messageDispatched(ServerCnx cnx,
 Consumer consumer,
 long ledgerId,
 long entryId,
 io.netty.buffer.ByteBuf headersAndPayload)

Description copied from interface: BrokerInterceptor

Intercept after a message is dispatched to consumer.

Specified by:

messageDispatched in interface BrokerInterceptor

Parameters:

cnx - client Connection

consumer - Consumer object

ledgerId - Ledger ID

entryId - Entry ID

headersAndPayload - Data

messageAcked

public void messageAcked(ServerCnx cnx,
 Consumer consumer,
 org.apache.pulsar.common.api.proto.CommandAck ackCmd)

Description copied from interface: BrokerInterceptor

Intercept after a message ack is processed.

Specified by:

messageAcked in interface BrokerInterceptor

Parameters:

cnx - client Connection

ackCmd - Command object

txnOpened

public void txnOpened(long tcId,
 String txnID)

Description copied from interface: BrokerInterceptor

Intercept when a transaction begins.

Specified by:

txnOpened in interface BrokerInterceptor

Parameters:

tcId - Transaction Coordinator Id

txnID - Transaction ID

txnEnded

public void txnEnded(String txnID,
 long txnAction)

Description copied from interface: BrokerInterceptor

Intercept when a transaction ends.

Specified by:

txnEnded in interface BrokerInterceptor

Parameters:

txnID - Transaction ID

txnAction - Transaction Action

onConnectionCreated

public void onConnectionCreated(ServerCnx cnx)

Description copied from interface: BrokerInterceptor

Called by the broker when a new connection is created.

Specified by:

onConnectionCreated in interface BrokerInterceptor

onPulsarCommand

public void onPulsarCommand(org.apache.pulsar.common.api.proto.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

getInterceptors

public Map<String,BrokerInterceptorWithClassLoader> getInterceptors()