org.apache.pulsar.broker.service

Interface TopicPoliciesService

All Known Implementing Classes:

SystemTopicBasedTopicPoliciesService, TopicPoliciesService.TopicPoliciesServiceDisabled

public interface TopicPoliciesService

Topic policies service

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	TopicPoliciesService.TopicPoliciesServiceDisabled

Field Summary

Fields

Modifier and Type	Field and Description
static TopicPoliciesService	DISABLED

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Void>	addOwnedNamespaceBundleAsync(NamespaceBundle namespaceBundle) Add owned namespace bundle async.
boolean	cacheIsInitialized(org.apache.pulsar.common.naming.TopicName topicName) whether the cache has been initialized
org.apache.pulsar.common.policies.data.TopicPolicies	getTopicPolicies(org.apache.pulsar.common.naming.TopicName topicName) Get 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
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

Field Detail

DISABLED

static final TopicPoliciesService DISABLED

Method Detail

updateTopicPoliciesAsync

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

Update policies for a topic async

Parameters:

topicName - topic name

policies - policies for the topic name

getTopicPolicies

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

Get policies for a topic async

Parameters:

topicName - topic name

Returns:

future of the topic policies

Throws:

BrokerServiceException.TopicPoliciesCacheNotInitException

getTopicPoliciesBypassCacheAsync

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

Get policies for a topic without cache async

Parameters:

topicName - topic name

Returns:

future of the topic policies

addOwnedNamespaceBundleAsync

CompletableFuture<Void> addOwnedNamespaceBundleAsync(NamespaceBundle namespaceBundle)

Add owned namespace bundle async.

Parameters:

namespaceBundle - namespace bundle

removeOwnedNamespaceBundleAsync

CompletableFuture<Void> removeOwnedNamespaceBundleAsync(NamespaceBundle namespaceBundle)

Remove owned namespace bundle async.

Parameters:

namespaceBundle - namespace bundle

start

void start()

Start the topic policy service.

cacheIsInitialized

boolean cacheIsInitialized(org.apache.pulsar.common.naming.TopicName topicName)

whether the cache has been initialized

Parameters:

topicName -

Returns:

registerListener

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

unregisterListener

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