org.apache.pulsar.broker.namespace

Class NamespaceService

java.lang.Object

org.apache.pulsar.broker.namespace.NamespaceService

public class NamespaceService
extends Object

The NamespaceService provides resource ownership lookup as well as resource ownership claiming services for the PulsarService.

The PulsarService relies on this service for resource ownership operations.

The focus of this phase is to bring up the system and be able to iterate and improve the services effectively.

See Also:

PulsarService

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NamespaceService.AddressType

Field Summary

Fields

Modifier and Type	Field and Description
static String	HEARTBEAT_NAMESPACE_FMT
static Pattern	HEARTBEAT_NAMESPACE_PATTERN
static String	NAMESPACE_ISOLATION_POLICIES
static String	SLA_NAMESPACE_FMT
static Pattern	SLA_NAMESPACE_PATTERN
static String	SLA_NAMESPACE_PROPERTY

Constructor Summary

Constructors

Constructor and Description
NamespaceService(PulsarService pulsar) Default constructor.

Method Summary

Modifier and Type	Method and Description
void	addNamespaceBundleOwnershipListener(NamespaceBundleOwnershipListener... listeners)
static String	checkHeartbeatNamespace(org.apache.pulsar.common.naming.ServiceUnitId ns)
CompletableFuture<Boolean>	checkTopicExists(org.apache.pulsar.common.naming.TopicName topic)
CompletableFuture<Boolean>	checkTopicOwnership(org.apache.pulsar.common.naming.TopicName topicName)
protected CompletableFuture<LookupResult>	createLookupResult(String candidateBroker, boolean authoritativeRedirect, String advertisedListenerName)
CompletableFuture<List<String>>	getAllPartitions(org.apache.pulsar.common.naming.NamespaceName namespaceName)
CompletableFuture<Optional<LookupResult>>	getBrokerServiceUrlAsync(org.apache.pulsar.common.naming.TopicName topic, LookupOptions options)
NamespaceBundle	getBundle(org.apache.pulsar.common.naming.TopicName topicName)
CompletableFuture<NamespaceBundle>	getBundleAsync(org.apache.pulsar.common.naming.TopicName topic)
int	getBundleCount(org.apache.pulsar.common.naming.NamespaceName namespace)
Optional<NamespaceBundle>	getBundleIfPresent(org.apache.pulsar.common.naming.TopicName topicName)
CompletableFuture<List<String>>	getFullListOfTopics(org.apache.pulsar.common.naming.NamespaceName namespaceName)
static String	getHeartbeatNamespace(String host, ServiceConfiguration config)
CompletableFuture<List<String>>	getListOfNonPersistentTopics(org.apache.pulsar.common.naming.NamespaceName namespaceName)
CompletableFuture<List<String>>	getListOfPersistentTopics(org.apache.pulsar.common.naming.NamespaceName namespaceName)
CompletableFuture<List<String>>	getListOfTopics(org.apache.pulsar.common.naming.NamespaceName namespaceName, org.apache.pulsar.common.api.proto.PulsarApi.CommandGetTopicsOfNamespace.Mode mode)
NamespaceBundleFactory	getNamespaceBundleFactory()
PulsarClientImpl	getNamespaceClient(org.apache.pulsar.common.policies.data.ClusterData cluster)
Map<String,org.apache.pulsar.common.policies.data.NamespaceOwnershipStatus>	getOwnedNameSpacesStatus()
Set<NamespaceBundle>	getOwnedServiceUnits()
CompletableFuture<List<String>>	getOwnedTopicListForNamespaceBundle(NamespaceBundle bundle)
Optional<NamespaceEphemeralData>	getOwner(NamespaceBundle bundle)
CompletableFuture<Optional<NamespaceEphemeralData>>	getOwnerAsync(NamespaceBundle bundle)
OwnershipCache	getOwnershipCache()
CompletableFuture<List<String>>	getPartitions(org.apache.pulsar.common.naming.NamespaceName namespaceName, org.apache.pulsar.common.naming.TopicDomain topicDomain)
org.apache.pulsar.common.naming.ServiceUnitId	getServiceUnitId(org.apache.pulsar.common.naming.TopicName topicName)
static String	getSLAMonitorBrokerName(org.apache.pulsar.common.naming.ServiceUnitId ns)
static String	getSLAMonitorNamespace(String host, ServiceConfiguration config)
int	getTotalServiceUnitsLoaded()
Optional<URL>	getWebServiceUrl(org.apache.pulsar.common.naming.ServiceUnitId suName, LookupOptions options) Return the URL of the broker who's owning a particular service unit.
CompletableFuture<Optional<URL>>	getWebServiceUrlAsync(org.apache.pulsar.common.naming.ServiceUnitId suName, LookupOptions options) Return the URL of the broker who's owning a particular service unit in asynchronous way If the service unit is not owned, return a CompletableFuture with empty optional.
void	initialize()
boolean	isNamespaceBundleDisabled(NamespaceBundle bundle)
CompletableFuture<Boolean>	isNamespaceBundleOwned(NamespaceBundle bundle)
boolean	isServiceUnitActive(org.apache.pulsar.common.naming.TopicName topicName)
boolean	isServiceUnitOwned(org.apache.pulsar.common.naming.ServiceUnitId suName)
protected void	onNamespaceBundleOwned(NamespaceBundle bundle)
protected void	onNamespaceBundleUnload(NamespaceBundle bundle)
void	registerBootstrapNamespaces() Register all the bootstrap name spaces including the heartbeat namespace
boolean	registerNamespace(String namespace, boolean ensureOwned) Tried to registers a namespace to this instance
void	registerOwnedBundles()
boolean	registerSLANamespace()
void	removeOwnedServiceUnit(NamespaceBundle nsBundle)
void	removeOwnedServiceUnit(org.apache.pulsar.common.naming.NamespaceName nsName)
void	removeOwnedServiceUnits(org.apache.pulsar.common.naming.NamespaceName nsName, org.apache.pulsar.common.policies.data.BundlesData bundleData)
CompletableFuture<Void>	splitAndOwnBundle(NamespaceBundle bundle, boolean unload, NamespaceBundleSplitAlgorithm splitAlgorithm) 1.
CompletableFuture<Void>	unloadNamespaceBundle(NamespaceBundle bundle)
CompletableFuture<Void>	unloadNamespaceBundle(NamespaceBundle bundle, long timeout, TimeUnit timeoutUnit)
void	unloadSLANamespace()

Methods inherited from class java.lang.Object

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

Field Detail

SLA_NAMESPACE_PROPERTY

public static final String SLA_NAMESPACE_PROPERTY

See Also:

Constant Field Values

HEARTBEAT_NAMESPACE_PATTERN

public static final Pattern HEARTBEAT_NAMESPACE_PATTERN

SLA_NAMESPACE_PATTERN

public static final Pattern SLA_NAMESPACE_PATTERN

HEARTBEAT_NAMESPACE_FMT

public static final String HEARTBEAT_NAMESPACE_FMT

See Also:

Constant Field Values

SLA_NAMESPACE_FMT

public static final String SLA_NAMESPACE_FMT

See Also:

Constant Field Values

NAMESPACE_ISOLATION_POLICIES

public static final String NAMESPACE_ISOLATION_POLICIES

See Also:

Constant Field Values

Constructor Detail

NamespaceService

public NamespaceService(PulsarService pulsar)

Default constructor.

Throws:

PulsarServerException

Method Detail

initialize

public void initialize()

getBrokerServiceUrlAsync

public CompletableFuture<Optional<LookupResult>> getBrokerServiceUrlAsync(org.apache.pulsar.common.naming.TopicName topic,
                                                                          LookupOptions options)

getBundleAsync

public CompletableFuture<NamespaceBundle> getBundleAsync(org.apache.pulsar.common.naming.TopicName topic)

getBundleIfPresent

public Optional<NamespaceBundle> getBundleIfPresent(org.apache.pulsar.common.naming.TopicName topicName)
                                             throws Exception

Throws:

Exception

getBundle

public NamespaceBundle getBundle(org.apache.pulsar.common.naming.TopicName topicName)
                          throws Exception

Throws:

Exception

getBundleCount

public int getBundleCount(org.apache.pulsar.common.naming.NamespaceName namespace)
                   throws Exception

Throws:

Exception

getWebServiceUrlAsync

public CompletableFuture<Optional<URL>> getWebServiceUrlAsync(org.apache.pulsar.common.naming.ServiceUnitId suName,
                                                              LookupOptions options)
                                                       throws Exception

Return the URL of the broker who's owning a particular service unit in asynchronous way If the service unit is not owned, return a CompletableFuture with empty optional.

Throws:

Exception

getWebServiceUrl

public Optional<URL> getWebServiceUrl(org.apache.pulsar.common.naming.ServiceUnitId suName,
                                      LookupOptions options)
                               throws Exception

Return the URL of the broker who's owning a particular service unit. If the service unit is not owned, return an empty optional

Throws:

Exception

registerBootstrapNamespaces

public void registerBootstrapNamespaces()
                                 throws PulsarServerException

Register all the bootstrap name spaces including the heartbeat namespace

Throws:

PulsarServerException

registerNamespace

public boolean registerNamespace(String namespace,
                                 boolean ensureOwned)
                          throws PulsarServerException

Tried to registers a namespace to this instance

Parameters:

namespace -

ensureOwned -

Returns:

Throws:

PulsarServerException

Exception

createLookupResult

protected CompletableFuture<LookupResult> createLookupResult(String candidateBroker,
                                                             boolean authoritativeRedirect,
                                                             String advertisedListenerName)
                                                      throws Exception

Throws:

Exception

unloadNamespaceBundle

public CompletableFuture<Void> unloadNamespaceBundle(NamespaceBundle bundle)

unloadNamespaceBundle

public CompletableFuture<Void> unloadNamespaceBundle(NamespaceBundle bundle,
                                                     long timeout,
                                                     TimeUnit timeoutUnit)

isNamespaceBundleOwned

public CompletableFuture<Boolean> isNamespaceBundleOwned(NamespaceBundle bundle)

getOwnedNameSpacesStatus

public Map<String,org.apache.pulsar.common.policies.data.NamespaceOwnershipStatus> getOwnedNameSpacesStatus()
                                                                                                     throws Exception

Throws:

Exception

isNamespaceBundleDisabled

public boolean isNamespaceBundleDisabled(NamespaceBundle bundle)
                                  throws Exception

Throws:

Exception

splitAndOwnBundle

public CompletableFuture<Void> splitAndOwnBundle(NamespaceBundle bundle,
                                                 boolean unload,
                                                 NamespaceBundleSplitAlgorithm splitAlgorithm)
                                          throws Exception

1. split the given bundle into two bundles 2. assign ownership of both the bundles to current broker 3. update policies with newly created bundles into LocalZK 4. disable original bundle and refresh the cache. It will call splitAndOwnBundleOnceAndRetry to do the real retry work, which will retry "retryTimes".

Parameters:

bundle -

Returns:

Throws:

Exception

getOwnershipCache

public OwnershipCache getOwnershipCache()

getTotalServiceUnitsLoaded

public int getTotalServiceUnitsLoaded()

getOwnedServiceUnits

public Set<NamespaceBundle> getOwnedServiceUnits()

isServiceUnitOwned

public boolean isServiceUnitOwned(org.apache.pulsar.common.naming.ServiceUnitId suName)
                           throws Exception

Throws:

Exception

isServiceUnitActive

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

checkTopicOwnership

public CompletableFuture<Boolean> checkTopicOwnership(org.apache.pulsar.common.naming.TopicName topicName)

removeOwnedServiceUnit

public void removeOwnedServiceUnit(org.apache.pulsar.common.naming.NamespaceName nsName)
                            throws Exception

Throws:

Exception

removeOwnedServiceUnit

public void removeOwnedServiceUnit(NamespaceBundle nsBundle)
                            throws Exception

Throws:

Exception

removeOwnedServiceUnits

public void removeOwnedServiceUnits(org.apache.pulsar.common.naming.NamespaceName nsName,
                                    org.apache.pulsar.common.policies.data.BundlesData bundleData)
                             throws Exception

Throws:

Exception

onNamespaceBundleOwned

protected void onNamespaceBundleOwned(NamespaceBundle bundle)

onNamespaceBundleUnload

protected void onNamespaceBundleUnload(NamespaceBundle bundle)

addNamespaceBundleOwnershipListener

public void addNamespaceBundleOwnershipListener(NamespaceBundleOwnershipListener... listeners)

getNamespaceBundleFactory

public NamespaceBundleFactory getNamespaceBundleFactory()

getServiceUnitId

public org.apache.pulsar.common.naming.ServiceUnitId getServiceUnitId(org.apache.pulsar.common.naming.TopicName topicName)
                                                               throws Exception

Throws:

Exception

getFullListOfTopics

public CompletableFuture<List<String>> getFullListOfTopics(org.apache.pulsar.common.naming.NamespaceName namespaceName)

getOwnedTopicListForNamespaceBundle

public CompletableFuture<List<String>> getOwnedTopicListForNamespaceBundle(NamespaceBundle bundle)

checkTopicExists

public CompletableFuture<Boolean> checkTopicExists(org.apache.pulsar.common.naming.TopicName topic)

getListOfTopics

public CompletableFuture<List<String>> getListOfTopics(org.apache.pulsar.common.naming.NamespaceName namespaceName,
                                                       org.apache.pulsar.common.api.proto.PulsarApi.CommandGetTopicsOfNamespace.Mode mode)

getAllPartitions

public CompletableFuture<List<String>> getAllPartitions(org.apache.pulsar.common.naming.NamespaceName namespaceName)

getPartitions

public CompletableFuture<List<String>> getPartitions(org.apache.pulsar.common.naming.NamespaceName namespaceName,
                                                     org.apache.pulsar.common.naming.TopicDomain topicDomain)

getListOfPersistentTopics

public CompletableFuture<List<String>> getListOfPersistentTopics(org.apache.pulsar.common.naming.NamespaceName namespaceName)

getListOfNonPersistentTopics

public CompletableFuture<List<String>> getListOfNonPersistentTopics(org.apache.pulsar.common.naming.NamespaceName namespaceName)

getNamespaceClient

public PulsarClientImpl getNamespaceClient(org.apache.pulsar.common.policies.data.ClusterData cluster)

getOwner

public Optional<NamespaceEphemeralData> getOwner(NamespaceBundle bundle)
                                          throws Exception

Throws:

Exception

getOwnerAsync

public CompletableFuture<Optional<NamespaceEphemeralData>> getOwnerAsync(NamespaceBundle bundle)

unloadSLANamespace

public void unloadSLANamespace()
                        throws Exception

Throws:

Exception

getHeartbeatNamespace

public static String getHeartbeatNamespace(String host,
                                           ServiceConfiguration config)

getSLAMonitorNamespace

public static String getSLAMonitorNamespace(String host,
                                            ServiceConfiguration config)

checkHeartbeatNamespace

public static String checkHeartbeatNamespace(org.apache.pulsar.common.naming.ServiceUnitId ns)

getSLAMonitorBrokerName

public static String getSLAMonitorBrokerName(org.apache.pulsar.common.naming.ServiceUnitId ns)

registerSLANamespace

public boolean registerSLANamespace()
                             throws PulsarServerException

Throws:

PulsarServerException

registerOwnedBundles

public void registerOwnedBundles()