org.apache.pulsar.broker

Class PulsarService

java.lang.Object

org.apache.pulsar.broker.PulsarService

All Implemented Interfaces:

AutoCloseable, ShutdownService

public class PulsarService
extends Object
implements AutoCloseable, ShutdownService

Main class for Pulsar broker service.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PulsarService.State

Field Summary

Fields

Modifier and Type	Field and Description
protected io.netty.channel.EventLoopGroup	ioEventLoopGroup

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	acquireSLANamespace()
void	addPrometheusRawMetricsProvider(PrometheusRawMetricsProvider metricsProvider)
static String	bookieMetadataServiceUri(ServiceConfiguration config) Get bookkeeper metadata service uri.
protected String	brokerUrl(ServiceConfiguration config) Gets the broker service URL (non-TLS) associated with the internal listener.
static String	brokerUrl(String host, int port)
String	brokerUrlTls(ServiceConfiguration config) Gets the broker service URL (TLS) associated with the internal listener.
static String	brokerUrlTls(String host, int port)
void	close()
CompletableFuture<Void>	closeAsync() Close the current pulsar service.
void	closeMetadataServiceSession() Close the session to the metadata service.
org.apache.pulsar.metadata.api.MetadataStore	createConfigurationMetadataStore()
org.apache.pulsar.metadata.api.extended.MetadataStoreExtended	createLocalMetadataStore()
LedgerOffloader	createManagedLedgerOffloader(org.apache.pulsar.common.policies.data.OffloadPoliciesImpl offloadPolicies)
PulsarAdmin	getAdminClient()
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.
org.apache.pulsar.metadata.api.coordination.CoordinationService	getCoordinationService()
ScheduledExecutorService	getExecutor()
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()
org.apache.pulsar.metadata.api.extended.MetadataStoreExtended	getLocalMetadataStore()
ManagedLedgerStorage	getManagedLedgerClientFactory()
ManagedLedgerFactory	getManagedLedgerFactory()
LedgerOffloader	getManagedLedgerOffloader(org.apache.pulsar.common.naming.NamespaceName namespaceName, org.apache.pulsar.common.policies.data.OffloadPoliciesImpl 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()
Compactor	getNullableCompactor()
protected org.apache.bookkeeper.common.util.OrderedScheduler	getOffloaderScheduler(org.apache.pulsar.common.policies.data.OffloadPoliciesImpl offloadPolicies)
org.apache.bookkeeper.common.util.OrderedExecutor	getOrderedExecutor()
Map<String,String>	getProtocolDataToAdvertise()
ResourceUsageTransportManager	getResourceUsageTransportManager()
String	getSafeBrokerServiceUrl() Deprecated.
String	getSafeWebServiceAddress()
PulsarService.State	getState() Get the current pulsar state.
String	getStatusFilePath()
TopicPoliciesService	getTopicPoliciesService()
org.apache.pulsar.client.api.transaction.TransactionBufferClient	getTransactionBufferClient()
TransactionBufferProvider	getTransactionBufferProvider()
ExecutorProvider	getTransactionExecutorProvider()
TransactionMetadataStoreService	getTransactionMetadataStoreService()
Optional<WorkerConfig>	getWorkerConfig() Get the current function worker service configuration.
WorkerService	getWorkerService()
Optional<WorkerService>	getWorkerServiceOpt()
ZooKeeperClientFactory	getZooKeeperClientFactory()
static WorkerConfig	initializeWorkerConfigFromBrokerConfig(ServiceConfiguration brokerConfig, String workerConfigFile)
static boolean	isTransactionInternalName(org.apache.pulsar.common.naming.TopicName topicName)
static boolean	isTransactionSystemTopic(org.apache.pulsar.common.naming.TopicName topicName)
void	loadNamespaceTopics(NamespaceBundle bundle) Load all the topics contained in a namespace.
BookKeeperClientFactory	newBookKeeperClientFactory()
protected BrokerService	newBrokerService(PulsarService pulsar)
Compactor	newCompactor()
void	shutdownNow() Shutdown the broker immediately, without waiting for all resources to be released.
void	start() Start the pulsar service instance.
protected void	startLeaderElectionService()
protected void	startLoadManagementService()
protected void	startNamespaceService()
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

Field Detail

ioEventLoopGroup

protected final io.netty.channel.EventLoopGroup ioEventLoopGroup

Constructor Detail

PulsarService

public PulsarService(ServiceConfiguration config)

PulsarService

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

PulsarService

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

Method Detail

createConfigurationMetadataStore

public org.apache.pulsar.metadata.api.MetadataStore createConfigurationMetadataStore()
                                                                              throws org.apache.pulsar.metadata.api.MetadataStoreException

Throws:

org.apache.pulsar.metadata.api.MetadataStoreException

closeMetadataServiceSession

public void closeMetadataServiceSession()
                                 throws Exception

Close the session to the metadata service. This will immediately release all the resource locks held by this broker on the coordination service.

Throws:

Exception - if the close operation fails

close

public void close()
           throws PulsarServerException

Specified by:

close in interface AutoCloseable

Throws:

PulsarServerException

closeAsync

public CompletableFuture<Void> closeAsync()

Close the current pulsar service. All resources are released.

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

createLocalMetadataStore

public org.apache.pulsar.metadata.api.extended.MetadataStoreExtended createLocalMetadataStore()
                                                                                       throws org.apache.pulsar.metadata.api.MetadataStoreException

Throws:

org.apache.pulsar.metadata.api.MetadataStoreException

startLeaderElectionService

protected void startLeaderElectionService()

acquireSLANamespace

protected void acquireSLANamespace()

waitUntilClosed

public void waitUntilClosed()
                     throws InterruptedException

Block until the service is finally closed.

Throws:

InterruptedException

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()

getMetadataServiceUri

public String getMetadataServiceUri()

Get default bookkeeper metadata service uri.

getInternalConfigurationData

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

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.

getWorkerServiceOpt

public Optional<WorkerService> getWorkerServiceOpt()

getWorkerService

public WorkerService getWorkerService()
                               throws UnsupportedOperationException

Throws:

UnsupportedOperationException

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 ManagedLedgerStorage getManagedLedgerClientFactory()

getManagedLedgerOffloader

public LedgerOffloader getManagedLedgerOffloader(org.apache.pulsar.common.naming.NamespaceName namespaceName,
                                                 org.apache.pulsar.common.policies.data.OffloadPoliciesImpl 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.OffloadPoliciesImpl offloadPolicies)
                                             throws PulsarServerException

Throws:

PulsarServerException

getExecutor

public ScheduledExecutorService getExecutor()

getCacheExecutor

public ScheduledExecutorService getCacheExecutor()

getTransactionExecutorProvider

public ExecutorProvider getTransactionExecutorProvider()

getLoadManagerExecutor

public ScheduledExecutorService getLoadManagerExecutor()

getOrderedExecutor

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

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

getNullableCompactor

public Compactor getNullableCompactor()

getOffloaderScheduler

protected org.apache.bookkeeper.common.util.OrderedScheduler getOffloaderScheduler(org.apache.pulsar.common.policies.data.OffloadPoliciesImpl 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()

brokerUrl

protected String brokerUrl(ServiceConfiguration config)

Gets the broker service URL (non-TLS) associated with the internal listener.

brokerUrl

public static String brokerUrl(String host,
                               int port)

brokerUrlTls

public String brokerUrlTls(ServiceConfiguration config)

Gets the broker service URL (TLS) associated with the internal listener.

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

@Deprecated
public String getSafeBrokerServiceUrl()

Deprecated.

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()

getResourceUsageTransportManager

public ResourceUsageTransportManager getResourceUsageTransportManager()

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()

getLocalMetadataStore

public org.apache.pulsar.metadata.api.extended.MetadataStoreExtended getLocalMetadataStore()

getCoordinationService

public org.apache.pulsar.metadata.api.coordination.CoordinationService getCoordinationService()

initializeWorkerConfigFromBrokerConfig

public static WorkerConfig initializeWorkerConfigFromBrokerConfig(ServiceConfiguration brokerConfig,
                                                                  String workerConfigFile)
                                                           throws IOException

Throws:

IOException

shutdownNow

public void shutdownNow()

Shutdown the broker immediately, without waiting for all resources to be released. This possibly is causing the JVM process to exit, depending on how th PulsarService was constructed.

Specified by:

shutdownNow in interface ShutdownService

isTransactionSystemTopic

public static boolean isTransactionSystemTopic(org.apache.pulsar.common.naming.TopicName topicName)

isTransactionInternalName

public static boolean isTransactionInternalName(org.apache.pulsar.common.naming.TopicName topicName)

newBrokerService

protected BrokerService newBrokerService(PulsarService pulsar)
                                  throws Exception

Throws:

Exception