org.apache.pulsar.broker.namespace

Class OwnershipCache

java.lang.Object

org.apache.pulsar.broker.namespace.OwnershipCache

public class OwnershipCache
extends Object

This class provides a cache service for all the service unit ownership among the brokers. It provide a cache service as well as ZooKeeper read/write functions for a) lookup of a service unit ownership to a broker; b) take ownership of a service unit by the local broker

Constructor Summary

Constructors

Constructor and Description
OwnershipCache(PulsarService pulsar, NamespaceBundleFactory bundleFactory, NamespaceService namespaceService) Constructor of OwnershipCache

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Boolean>	checkOwnership(NamespaceBundle bundle) Check whether this broker owns given namespace bundle.
CompletableFuture<Void>	disableOwnership(NamespaceBundle bundle) Disable bundle in local cache and on zk
OwnedBundle	getOwnedBundle(NamespaceBundle bundle) Return the OwnedBundle instance from the local cache.
Map<String,OwnedBundle>	getOwnedBundles() Method to access the map of all ServiceUnit objects owned by the local broker
CompletableFuture<Optional<NamespaceEphemeralData>>	getOwnerAsync(NamespaceBundle suName) Method to get the current owner of the ServiceUnit
NamespaceEphemeralData	getSelfOwnerInfo()
void	invalidateLocalOwnerCache()
boolean	isNamespaceBundleOwned(NamespaceBundle bundle) Checked whether a particular bundle is currently owned by this broker
boolean	refreshSelfOwnerInfo()
CompletableFuture<Void>	removeOwnership(NamespaceBundle bundle) Method to remove the ownership of local broker on the NamespaceBundle, if owned
CompletableFuture<Void>	removeOwnership(NamespaceBundles bundles) Method to remove ownership of all owned bundles
CompletableFuture<NamespaceEphemeralData>	tryAcquiringOwnership(NamespaceBundle bundle) Method to get the current owner of the ServiceUnit or set the local broker as the owner if absent
CompletableFuture<Void>	updateBundleState(NamespaceBundle bundle, boolean isActive) Update bundle state in a local cache

Methods inherited from class java.lang.Object

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

Constructor Detail

OwnershipCache

public OwnershipCache(PulsarService pulsar,
                      NamespaceBundleFactory bundleFactory,
                      NamespaceService namespaceService)

Constructor of OwnershipCache

Parameters:

ownerUrl - the local broker URL that will be set as owner for the ServiceUnit

Method Detail

checkOwnership

public CompletableFuture<Boolean> checkOwnership(NamespaceBundle bundle)

Check whether this broker owns given namespace bundle.

Parameters:

bundle - namespace bundle

Returns:

future that will complete with check result

getOwnerAsync

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

Method to get the current owner of the ServiceUnit

Parameters:

suName - name of the ServiceUnit

Returns:

The ephemeral node data showing the current ownership info in ZooKeeper

Throws:

Exception - throws exception if no ownership info is found

tryAcquiringOwnership

public CompletableFuture<NamespaceEphemeralData> tryAcquiringOwnership(NamespaceBundle bundle)
                                                                throws Exception

Method to get the current owner of the ServiceUnit or set the local broker as the owner if absent

Parameters:

bundle - the NamespaceBundle

Returns:

The ephemeral node data showing the current ownership info in ZooKeeper

Throws:

Exception

removeOwnership

public CompletableFuture<Void> removeOwnership(NamespaceBundle bundle)

Method to remove the ownership of local broker on the NamespaceBundle, if owned

removeOwnership

public CompletableFuture<Void> removeOwnership(NamespaceBundles bundles)

Method to remove ownership of all owned bundles

Parameters:

bundles - NamespaceBundles to remove from ownership cache

getOwnedBundles

public Map<String,OwnedBundle> getOwnedBundles()

Method to access the map of all ServiceUnit objects owned by the local broker

Returns:

a map of owned ServiceUnit objects

isNamespaceBundleOwned

public boolean isNamespaceBundleOwned(NamespaceBundle bundle)

Checked whether a particular bundle is currently owned by this broker

Parameters:

bundle -

Returns:

getOwnedBundle

public OwnedBundle getOwnedBundle(NamespaceBundle bundle)

Return the OwnedBundle instance from the local cache. Does not block.

Parameters:

bundle -

Returns:

disableOwnership

public CompletableFuture<Void> disableOwnership(NamespaceBundle bundle)

Disable bundle in local cache and on zk

Parameters:

bundle -

Throws:

Exception

updateBundleState

public CompletableFuture<Void> updateBundleState(NamespaceBundle bundle,
                                                 boolean isActive)

Update bundle state in a local cache

Parameters:

bundle -

Throws:

Exception

invalidateLocalOwnerCache

public void invalidateLocalOwnerCache()

getSelfOwnerInfo

public NamespaceEphemeralData getSelfOwnerInfo()

refreshSelfOwnerInfo

public boolean refreshSelfOwnerInfo()