Package org.apache.pulsar.broker.service

Class SystemTopicBasedTopicPoliciesService

java.lang.Object

org.apache.pulsar.broker.service.SystemTopicBasedTopicPoliciesService

All Implemented Interfaces:

TopicPoliciesService

public class SystemTopicBasedTopicPoliciesService
extends Object
implements TopicPoliciesService

Cached topic policies service will cache the system topic reader and the topic policies While reader cache for the namespace was removed, the topic policies will remove automatically.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.pulsar.broker.service.TopicPoliciesService

TopicPoliciesService.TopicPoliciesServiceDisabled

Field Summary

Fields inherited from interface org.apache.pulsar.broker.service.TopicPoliciesService

DEFAULT_GET_TOPIC_POLICY_TIMEOUT, DISABLED

Constructor Summary

Constructors

Constructor	Description
SystemTopicBasedTopicPoliciesService(PulsarService pulsarService)

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Void>	addOwnedNamespaceBundleAsync(NamespaceBundle namespaceBundle)	Add owned namespace bundle async.
protected CompletableFuture<SystemTopicClient.Reader<org.apache.pulsar.common.events.PulsarEvent>>	createSystemTopicClientWithRetry(org.apache.pulsar.common.naming.NamespaceName namespace)
CompletableFuture<Void>	deleteTopicPoliciesAsync(org.apache.pulsar.common.naming.TopicName topicName)	Delete policies for a topic async.
protected Map<org.apache.pulsar.common.naming.TopicName,List<TopicPolicyListener<org.apache.pulsar.common.policies.data.TopicPolicies>>>	getListeners()
protected Map<org.apache.pulsar.common.naming.TopicName,org.apache.pulsar.common.policies.data.TopicPolicies>	getPoliciesCache()
Boolean	getPoliciesCacheInit(org.apache.pulsar.common.naming.NamespaceName namespaceName)
org.apache.pulsar.common.policies.data.TopicPolicies	getTopicPolicies(org.apache.pulsar.common.naming.TopicName topicName)	Get policies for a topic async.
org.apache.pulsar.common.policies.data.TopicPolicies	getTopicPolicies(org.apache.pulsar.common.naming.TopicName topicName, boolean isGlobal)	Get global policies for a topic async.
CompletableFuture<org.apache.pulsar.common.policies.data.TopicPolicies>	getTopicPoliciesBypassCacheAsync(org.apache.pulsar.common.naming.TopicName topicName)	Get policies for a topic without cache async.
org.apache.pulsar.common.policies.data.TopicPolicies	getTopicPoliciesIfExists(org.apache.pulsar.common.naming.TopicName topicName)	Get policies from current cache.
void	registerListener(org.apache.pulsar.common.naming.TopicName topicName, TopicPolicyListener<org.apache.pulsar.common.policies.data.TopicPolicies> listener)
CompletableFuture<Void>	removeOwnedNamespaceBundleAsync(NamespaceBundle namespaceBundle)	Remove owned namespace bundle async.
void	start()	Start the topic policy service.
void	unregisterListener(org.apache.pulsar.common.naming.TopicName topicName, TopicPolicyListener<org.apache.pulsar.common.policies.data.TopicPolicies> listener)
CompletableFuture<Void>	updateTopicPoliciesAsync(org.apache.pulsar.common.naming.TopicName topicName, org.apache.pulsar.common.policies.data.TopicPolicies policies)	Update policies for a topic async.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.pulsar.broker.service.TopicPoliciesService

getTopicPoliciesAsyncWithRetry

Constructor Details

SystemTopicBasedTopicPoliciesService

public SystemTopicBasedTopicPoliciesService(PulsarService pulsarService)

Method Details

deleteTopicPoliciesAsync

public CompletableFuture<Void> deleteTopicPoliciesAsync(org.apache.pulsar.common.naming.TopicName topicName)

Description copied from interface: TopicPoliciesService

Delete policies for a topic async.

Specified by:

deleteTopicPoliciesAsync in interface TopicPoliciesService

Parameters:

topicName - topic name

updateTopicPoliciesAsync

public CompletableFuture<Void> updateTopicPoliciesAsync(org.apache.pulsar.common.naming.TopicName topicName,
 org.apache.pulsar.common.policies.data.TopicPolicies policies)

Description copied from interface: TopicPoliciesService

Update policies for a topic async.

Specified by:

updateTopicPoliciesAsync in interface TopicPoliciesService

Parameters:

topicName - topic name

policies - policies for the topic name

getTopicPolicies

public org.apache.pulsar.common.policies.data.TopicPolicies getTopicPolicies(org.apache.pulsar.common.naming.TopicName topicName)
                                                                      throws BrokerServiceException.TopicPoliciesCacheNotInitException

Description copied from interface: TopicPoliciesService

Get policies for a topic async.

Specified by:

getTopicPolicies in interface TopicPoliciesService

Parameters:

topicName - topic name

Returns:

future of the topic policies

Throws:

BrokerServiceException.TopicPoliciesCacheNotInitException

getTopicPolicies

public org.apache.pulsar.common.policies.data.TopicPolicies getTopicPolicies(org.apache.pulsar.common.naming.TopicName topicName,
 boolean isGlobal)
                                                                      throws BrokerServiceException.TopicPoliciesCacheNotInitException

Description copied from interface: TopicPoliciesService

Get global policies for a topic async.

Specified by:

getTopicPolicies in interface TopicPoliciesService

Parameters:

topicName - topic name

Returns:

future of the topic policies

Throws:

BrokerServiceException.TopicPoliciesCacheNotInitException

getTopicPoliciesIfExists

public org.apache.pulsar.common.policies.data.TopicPolicies getTopicPoliciesIfExists(org.apache.pulsar.common.naming.TopicName topicName)

Description copied from interface: TopicPoliciesService

Get policies from current cache.

Specified by:

getTopicPoliciesIfExists in interface TopicPoliciesService

Parameters:

topicName - topic name

Returns:

the topic policies

getTopicPoliciesBypassCacheAsync

public CompletableFuture<org.apache.pulsar.common.policies.data.TopicPolicies> getTopicPoliciesBypassCacheAsync(org.apache.pulsar.common.naming.TopicName topicName)

Description copied from interface: TopicPoliciesService

Get policies for a topic without cache async.

Specified by:

getTopicPoliciesBypassCacheAsync in interface TopicPoliciesService

Parameters:

topicName - topic name

Returns:

future of the topic policies

addOwnedNamespaceBundleAsync

public CompletableFuture<Void> addOwnedNamespaceBundleAsync(NamespaceBundle namespaceBundle)

Description copied from interface: TopicPoliciesService

Add owned namespace bundle async.

Specified by:

addOwnedNamespaceBundleAsync in interface TopicPoliciesService

Parameters:

namespaceBundle - namespace bundle

createSystemTopicClientWithRetry

protected CompletableFuture<SystemTopicClient.Reader<org.apache.pulsar.common.events.PulsarEvent>> createSystemTopicClientWithRetry(org.apache.pulsar.common.naming.NamespaceName namespace)

removeOwnedNamespaceBundleAsync

public CompletableFuture<Void> removeOwnedNamespaceBundleAsync(NamespaceBundle namespaceBundle)

Description copied from interface: TopicPoliciesService

Remove owned namespace bundle async.

Specified by:

removeOwnedNamespaceBundleAsync in interface TopicPoliciesService

Parameters:

namespaceBundle - namespace bundle

start

public void start()

Description copied from interface: TopicPoliciesService

Start the topic policy service.

Specified by:

start in interface TopicPoliciesService

getPoliciesCacheInit

public Boolean getPoliciesCacheInit(org.apache.pulsar.common.naming.NamespaceName namespaceName)

registerListener

public void registerListener(org.apache.pulsar.common.naming.TopicName topicName,
 TopicPolicyListener<org.apache.pulsar.common.policies.data.TopicPolicies> listener)

Specified by:

registerListener in interface TopicPoliciesService

unregisterListener

public void unregisterListener(org.apache.pulsar.common.naming.TopicName topicName,
 TopicPolicyListener<org.apache.pulsar.common.policies.data.TopicPolicies> listener)

Specified by:

unregisterListener in interface TopicPoliciesService

getPoliciesCache

protected Map<org.apache.pulsar.common.naming.TopicName,org.apache.pulsar.common.policies.data.TopicPolicies> getPoliciesCache()

getListeners

protected Map<org.apache.pulsar.common.naming.TopicName,List<TopicPolicyListener<org.apache.pulsar.common.policies.data.TopicPolicies>>> getListeners()