Package org.apache.pulsar.broker.intercept

Class BrokerInterceptorUtils

java.lang.Object

org.apache.pulsar.broker.intercept.BrokerInterceptorUtils

public class BrokerInterceptorUtils
extends java.lang.Object

Util class to search and load BrokerInterceptors.

Constructor Summary

Constructors

Constructor	Description
BrokerInterceptorUtils()

Method Summary

Modifier and Type	Method	Description
BrokerInterceptorDefinition	getBrokerInterceptorDefinition(java.lang.String narPath, java.lang.String narExtractionDirectory)	Retrieve the broker interceptor definition from the provided handler nar package.
BrokerInterceptorDefinitions	searchForInterceptors(java.lang.String interceptorsDirectory, java.lang.String narExtractionDirectory)	Search and load the available broker interceptors.

Methods inherited from class java.lang.Object

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

Constructor Detail

BrokerInterceptorUtils

public BrokerInterceptorUtils()

Method Detail

getBrokerInterceptorDefinition

public BrokerInterceptorDefinition getBrokerInterceptorDefinition(java.lang.String narPath,
                                                                  java.lang.String narExtractionDirectory)
                                                           throws java.io.IOException

Retrieve the broker interceptor definition from the provided handler nar package.

Parameters:

narPath - the path to the broker interceptor NAR package

Returns:

the broker interceptor definition

Throws:

java.io.IOException - when fail to load the broker interceptor or get the definition

searchForInterceptors

public BrokerInterceptorDefinitions searchForInterceptors(java.lang.String interceptorsDirectory,
                                                          java.lang.String narExtractionDirectory)
                                                   throws java.io.IOException

Search and load the available broker interceptors.

Parameters:

interceptorsDirectory - the directory where all the broker interceptors are stored

Returns:

a collection of broker interceptors

Throws:

java.io.IOException - when fail to load the available broker interceptors from the provided directory.