org.apache.pulsar.broker

Class PulsarService

java.lang.Object

org.apache.pulsar.broker.PulsarService

All Implemented Interfaces:

AutoCloseable

public class PulsarService
extends Object
implements AutoCloseable

Main class for Pulsar broker service

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PulsarService.State

Constructor Summary

Constructors

Constructor and Description
PulsarService(ServiceConfiguration config)
PulsarService(ServiceConfiguration config, Optional<WorkerService> functionWorkerService, Consumer<Integer> processTerminator)

Method Summary

Modifier and Type	Method and Description
protected void	acquireSLANamespace()
void	addPrometheusRawMetricsProvider(PrometheusRawMetricsProvider metricsProvider)
static String	advertisedAddress(ServiceConfiguration config) Advertised service address.
static String	bookieMetadataServiceUri(ServiceConfiguration config) Get bookkeeper metadata service uri.
static String	brokerUrl(String host, int port)
String	brokerUrlTls(ServiceConfiguration config)
static String	brokerUrlTls(String host, int port)
void	close() Close the current pulsar service.
LedgerOffloader	createManagedLedgerOffloader(org.apache.pulsar.common.policies.data.OffloadPolicies offloadPolicies)
PulsarAdmin	getAdminClient()
CompletableFuture<Set<String>>	getAvailableBookiesAsync()
BookKeeper	getBookKeeperClient()
BookKeeperClientFactory	getBookKeeperClientFactory()
Optional<Integer>	getBrokerListenPort()
Optional<Integer>	getBrokerListenPortTls()
BrokerService	getBrokerService() Get a reference of the current BrokerService instance associated with the current PulsarService instance.
ScheduledExecutorService	getCacheExecutor()
org.apache.pulsar.client.api.PulsarClient	getClient()
Compactor	getCompactor()
protected ScheduledExecutorService	getCompactorExecutor()
ServiceConfiguration	getConfiguration() Get the current service configuration.
ConfigurationCacheService	getConfigurationCache()
ScheduledExecutorService	getExecutor()
ZooKeeperCache	getGlobalZkCache()
org.apache.pulsar.common.conf.InternalConfigurationData	getInternalConfigurationData()
LeaderElectionService	getLeaderElectionService() Get a reference of the current LeaderElectionService instance associated with the current PulsarService instance.
Optional<Integer>	getListenPortHTTP()
Optional<Integer>	getListenPortHTTPS()
ScheduledExecutorService	getLoadManagerExecutor()
ZooKeeperCache	getLocalZkCache()
LocalZooKeeperCacheService	getLocalZkCacheService()
ManagedLedgerClientFactory	getManagedLedgerClientFactory()
ManagedLedgerFactory	getManagedLedgerFactory()
LedgerOffloader	getManagedLedgerOffloader(org.apache.pulsar.common.naming.NamespaceName namespaceName, org.apache.pulsar.common.policies.data.OffloadPolicies offloadPolicies) First, get LedgerOffloader from local map cache, create new LedgerOffloader if not in cache or the OffloadPolicies changed, return the LedgerOffloader directly if exist in cache and the OffloadPolicies not changed.
String	getMetadataServiceUri() Get default bookkeeper metadata service uri.
MetricsGenerator	getMetricsGenerator()
NamespaceService	getNamespaceService() Get a reference of the current namespace service instance.
Supplier<NamespaceService>	getNamespaceServiceProvider()
protected org.apache.bookkeeper.common.util.OrderedScheduler	getOffloaderScheduler(org.apache.pulsar.common.policies.data.OffloadPolicies offloadPolicies)
org.apache.bookkeeper.common.util.OrderedExecutor	getOrderedExecutor()
Map<String,String>	getProtocolDataToAdvertise()
String	getSafeBrokerServiceUrl()
String	getSafeWebServiceAddress()
ZooKeeperSessionWatcher.ShutdownService	getShutdownService()
PulsarService.State	getState() Get the current pulsar state.
String	getStatusFilePath()
TopicPoliciesService	getTopicPoliciesService()
org.apache.pulsar.client.api.transaction.TransactionBufferClient	getTransactionBufferClient()
TransactionBufferProvider	getTransactionBufferProvider()
TransactionMetadataStoreService	getTransactionMetadataStoreService()
Optional<WorkerConfig>	getWorkerConfig() Get the current function worker service configuration.
WorkerService	getWorkerService()
ZooKeeper	getZkClient()
ZooKeeperClientFactory	getZooKeeperClientFactory()
void	loadNamespaceTopics(NamespaceBundle bundle) Load all the topics contained in a namespace
BookKeeperClientFactory	newBookKeeperClientFactory()
Compactor	newCompactor()
void	start() Start the pulsar service instance.
protected void	startLeaderElectionService()
protected void	startLoadManagementService()
protected void	startNamespaceService()
protected void	startZkCacheService()
void	waitUntilClosed() Block until the service is finally closed
String	webAddress(ServiceConfiguration config)
static String	webAddress(String host, int port)
String	webAddressTls(ServiceConfiguration config)
static String	webAddressTls(String host, int port)

Methods inherited from class java.lang.Object

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

Constructor Detail

PulsarService

public PulsarService(ServiceConfiguration config)

PulsarService

public PulsarService(ServiceConfiguration config,
                     Optional<WorkerService> functionWorkerService,
                     Consumer<Integer> processTerminator)

Method Detail

close

public void close()
           throws PulsarServerException

Close the current pulsar service. All resources are released.

Specified by:

close in interface AutoCloseable

Throws:

PulsarServerException

getConfiguration

public ServiceConfiguration getConfiguration()

Get the current service configuration.

Returns:

the current service configuration

getWorkerConfig

public Optional<WorkerConfig> getWorkerConfig()

Get the current function worker service configuration.

Returns:

the current function worker service configuration.

getProtocolDataToAdvertise

public Map<String,String> getProtocolDataToAdvertise()

start

public void start()
           throws PulsarServerException

Start the pulsar service instance.

Throws:

PulsarServerException

startLeaderElectionService

protected void startLeaderElectionService()

acquireSLANamespace

protected void acquireSLANamespace()

waitUntilClosed

public void waitUntilClosed()
                     throws InterruptedException

Block until the service is finally closed

Throws:

InterruptedException

startZkCacheService

protected void startZkCacheService()
                            throws PulsarServerException

Throws:

PulsarServerException

startNamespaceService

protected void startNamespaceService()
                              throws PulsarServerException

Throws:

PulsarServerException

getNamespaceServiceProvider

public Supplier<NamespaceService> getNamespaceServiceProvider()
                                                       throws PulsarServerException

Throws:

PulsarServerException

startLoadManagementService

protected void startLoadManagementService()
                                   throws PulsarServerException

Throws:

PulsarServerException

loadNamespaceTopics

public void loadNamespaceTopics(NamespaceBundle bundle)

Load all the topics contained in a namespace

Parameters:

bundle - NamespaceBundle to identify the service unit

Throws:

Exception

getStatusFilePath

public String getStatusFilePath()

getZkClient

public ZooKeeper getZkClient()

getMetadataServiceUri

public String getMetadataServiceUri()

Get default bookkeeper metadata service uri.

getInternalConfigurationData

public org.apache.pulsar.common.conf.InternalConfigurationData getInternalConfigurationData()

getConfigurationCache

public ConfigurationCacheService getConfigurationCache()

getState

public PulsarService.State getState()

Get the current pulsar state.

getLeaderElectionService

public LeaderElectionService getLeaderElectionService()

Get a reference of the current LeaderElectionService instance associated with the current PulsarService instance.

Returns:

a reference of the current LeaderElectionService instance.

getNamespaceService

public NamespaceService getNamespaceService()

Get a reference of the current namespace service instance.

Returns:

a reference of the current namespace service instance.

getWorkerService

public WorkerService getWorkerService()

getBrokerService

public BrokerService getBrokerService()

Get a reference of the current BrokerService instance associated with the current PulsarService instance.

Returns:

a reference of the current BrokerService instance.

getBookKeeperClient

public BookKeeper getBookKeeperClient()

getManagedLedgerFactory

public ManagedLedgerFactory getManagedLedgerFactory()

getManagedLedgerClientFactory

public ManagedLedgerClientFactory getManagedLedgerClientFactory()

getManagedLedgerOffloader

public LedgerOffloader getManagedLedgerOffloader(org.apache.pulsar.common.naming.NamespaceName namespaceName,
                                                 org.apache.pulsar.common.policies.data.OffloadPolicies offloadPolicies)

First, get LedgerOffloader from local map cache, create new LedgerOffloader if not in cache or the OffloadPolicies changed, return the LedgerOffloader directly if exist in cache and the OffloadPolicies not changed.

Parameters:

namespaceName - NamespaceName

offloadPolicies - the OffloadPolicies

Returns:

LedgerOffloader

createManagedLedgerOffloader

public LedgerOffloader createManagedLedgerOffloader(org.apache.pulsar.common.policies.data.OffloadPolicies offloadPolicies)
                                             throws PulsarServerException

Throws:

PulsarServerException

getLocalZkCache

public ZooKeeperCache getLocalZkCache()

getGlobalZkCache

public ZooKeeperCache getGlobalZkCache()

getExecutor

public ScheduledExecutorService getExecutor()

getCacheExecutor

public ScheduledExecutorService getCacheExecutor()

getLoadManagerExecutor

public ScheduledExecutorService getLoadManagerExecutor()

getOrderedExecutor

public org.apache.bookkeeper.common.util.OrderedExecutor getOrderedExecutor()

getLocalZkCacheService

public LocalZooKeeperCacheService getLocalZkCacheService()

getZooKeeperClientFactory

public ZooKeeperClientFactory getZooKeeperClientFactory()

newBookKeeperClientFactory

public BookKeeperClientFactory newBookKeeperClientFactory()

getBookKeeperClientFactory

public BookKeeperClientFactory getBookKeeperClientFactory()

getCompactorExecutor

protected ScheduledExecutorService getCompactorExecutor()

newCompactor

public Compactor newCompactor()
                       throws PulsarServerException

Throws:

PulsarServerException

getCompactor

public Compactor getCompactor()
                       throws PulsarServerException

Throws:

PulsarServerException

getOffloaderScheduler

protected org.apache.bookkeeper.common.util.OrderedScheduler getOffloaderScheduler(org.apache.pulsar.common.policies.data.OffloadPolicies offloadPolicies)

getClient

public org.apache.pulsar.client.api.PulsarClient getClient()
                                                    throws PulsarServerException

Throws:

PulsarServerException

getAdminClient

public PulsarAdmin getAdminClient()
                           throws PulsarServerException

Throws:

PulsarServerException

getMetricsGenerator

public MetricsGenerator getMetricsGenerator()

getTransactionMetadataStoreService

public TransactionMetadataStoreService getTransactionMetadataStoreService()

getTransactionBufferProvider

public TransactionBufferProvider getTransactionBufferProvider()

getTransactionBufferClient

public org.apache.pulsar.client.api.transaction.TransactionBufferClient getTransactionBufferClient()

getShutdownService

public ZooKeeperSessionWatcher.ShutdownService getShutdownService()

advertisedAddress

public static String advertisedAddress(ServiceConfiguration config)

Advertised service address.

Returns:

Hostname or IP address the service advertises to the outside world.

brokerUrl

public static String brokerUrl(String host,
                               int port)

brokerUrlTls

public String brokerUrlTls(ServiceConfiguration config)

brokerUrlTls

public static String brokerUrlTls(String host,
                                  int port)

webAddress

public String webAddress(ServiceConfiguration config)

webAddress

public static String webAddress(String host,
                                int port)

webAddressTls

public String webAddressTls(ServiceConfiguration config)

webAddressTls

public static String webAddressTls(String host,
                                   int port)

getSafeWebServiceAddress

public String getSafeWebServiceAddress()

getSafeBrokerServiceUrl

public String getSafeBrokerServiceUrl()

bookieMetadataServiceUri

public static String bookieMetadataServiceUri(ServiceConfiguration config)

Get bookkeeper metadata service uri.

Parameters:

config - broker configuration

Returns:

the metadata service uri that bookkeeper is used

getTopicPoliciesService

public TopicPoliciesService getTopicPoliciesService()

addPrometheusRawMetricsProvider

public void addPrometheusRawMetricsProvider(PrometheusRawMetricsProvider metricsProvider)

getListenPortHTTP

public Optional<Integer> getListenPortHTTP()

getListenPortHTTPS

public Optional<Integer> getListenPortHTTPS()

getBrokerListenPort

public Optional<Integer> getBrokerListenPort()

getBrokerListenPortTls

public Optional<Integer> getBrokerListenPortTls()

getAvailableBookiesAsync

public CompletableFuture<Set<String>> getAvailableBookiesAsync()