Package org.apache.pulsar.broker.resources

Class NamespaceResources

java.lang.Object

org.apache.pulsar.broker.resources.BaseResources<org.apache.pulsar.common.policies.data.Policies>

org.apache.pulsar.broker.resources.NamespaceResources

public class NamespaceResources
extends BaseResources<org.apache.pulsar.common.policies.data.Policies>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NamespaceResources.IsolationPolicyResources
static class	NamespaceResources.PartitionedTopicResources

Field Summary

Fields

Modifier and Type	Field	Description
static final String	POLICIES_READONLY_FLAG_PATH

Fields inherited from class org.apache.pulsar.broker.resources.BaseResources

BASE_CLUSTERS_PATH, BASE_POLICIES_PATH, LOCAL_POLICIES_ROOT

Constructor Summary

Constructors

Constructor	Description
NamespaceResources(MetadataStore configurationStore, int operationTimeoutSec)
NamespaceResources(MetadataStore configurationStore, int operationTimeoutSec, Executor executor)

Method Summary

Modifier and Type	Method	Description
void	createPolicies(org.apache.pulsar.common.naming.NamespaceName ns, org.apache.pulsar.common.policies.data.Policies policies)
CompletableFuture<Void>	createPoliciesAsync(org.apache.pulsar.common.naming.NamespaceName ns, org.apache.pulsar.common.policies.data.Policies policies)
CompletableFuture<Void>	deleteNamespaceAsync(org.apache.pulsar.common.naming.NamespaceName ns)	Clear resource of `/namespace/{namespaceName}` for zk-node.
void	deletePolicies(org.apache.pulsar.common.naming.NamespaceName ns)
CompletableFuture<Void>	deletePoliciesAsync(org.apache.pulsar.common.naming.NamespaceName ns)
CompletableFuture<Void>	deleteTenantAsync(String tenant)
Optional<org.apache.pulsar.common.policies.data.Policies>	getPolicies(org.apache.pulsar.common.naming.NamespaceName ns)
CompletableFuture<Optional<org.apache.pulsar.common.policies.data.Policies>>	getPoliciesAsync(org.apache.pulsar.common.naming.NamespaceName ns)
Optional<org.apache.pulsar.common.policies.data.Policies>	getPoliciesIfCached(org.apache.pulsar.common.naming.NamespaceName ns)	Deprecated. Since this method may introduce inconsistent namespace policies.
boolean	getPoliciesReadOnly()
CompletableFuture<Boolean>	getPoliciesReadOnlyAsync()
CompletableFuture<List<String>>	listNamespacesAsync(String tenant)
boolean	namespaceExists(org.apache.pulsar.common.naming.NamespaceName ns)
CompletableFuture<Boolean>	namespaceExistsAsync(org.apache.pulsar.common.naming.NamespaceName ns)
static org.apache.pulsar.common.naming.NamespaceName	namespaceFromLocalPoliciesPath(String path)
static org.apache.pulsar.common.naming.NamespaceName	namespaceFromPath(String path)
static boolean	pathIsFromNamespace(String path)
static boolean	pathIsNamespaceLocalPolicies(String path)
void	setPolicies(org.apache.pulsar.common.naming.NamespaceName ns, Function<org.apache.pulsar.common.policies.data.Policies,org.apache.pulsar.common.policies.data.Policies> function)
CompletableFuture<Void>	setPoliciesAsync(org.apache.pulsar.common.naming.NamespaceName ns, Function<org.apache.pulsar.common.policies.data.Policies,org.apache.pulsar.common.policies.data.Policies> function)

Methods inherited from class org.apache.pulsar.broker.resources.BaseResources

create, createAsync, delete, deleteAsync, deleteIfExistsAsync, exists, existsAsync, get, getAsync, getChildren, getChildrenAsync, getChildrenRecursiveAsync, getOperationTimeoutSec, joinPath, refreshAndGetAsync, set, setAsync, setWithCreate, setWithCreateAsync

Methods inherited from class java.lang.Object

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

Field Details

POLICIES_READONLY_FLAG_PATH

public static final String POLICIES_READONLY_FLAG_PATH

See Also:

• Constant Field Values

Constructor Details

NamespaceResources

public NamespaceResources(MetadataStore configurationStore,
 int operationTimeoutSec)

NamespaceResources

public NamespaceResources(MetadataStore configurationStore,
 int operationTimeoutSec,
 Executor executor)

Method Details

listNamespacesAsync

public CompletableFuture<List<String>> listNamespacesAsync(String tenant)

getPoliciesReadOnlyAsync

public CompletableFuture<Boolean> getPoliciesReadOnlyAsync()

getPoliciesReadOnly

public boolean getPoliciesReadOnly()
                            throws MetadataStoreException

Throws:

MetadataStoreException

createPolicies

public void createPolicies(org.apache.pulsar.common.naming.NamespaceName ns,
 org.apache.pulsar.common.policies.data.Policies policies)
                    throws MetadataStoreException

Throws:

MetadataStoreException

createPoliciesAsync

public CompletableFuture<Void> createPoliciesAsync(org.apache.pulsar.common.naming.NamespaceName ns,
 org.apache.pulsar.common.policies.data.Policies policies)

namespaceExists

public boolean namespaceExists(org.apache.pulsar.common.naming.NamespaceName ns)
                        throws MetadataStoreException

Throws:

MetadataStoreException

namespaceExistsAsync

public CompletableFuture<Boolean> namespaceExistsAsync(org.apache.pulsar.common.naming.NamespaceName ns)

deletePolicies

public void deletePolicies(org.apache.pulsar.common.naming.NamespaceName ns)
                    throws MetadataStoreException

Throws:

MetadataStoreException

deletePoliciesAsync

public CompletableFuture<Void> deletePoliciesAsync(org.apache.pulsar.common.naming.NamespaceName ns)

getPolicies

public Optional<org.apache.pulsar.common.policies.data.Policies> getPolicies(org.apache.pulsar.common.naming.NamespaceName ns)
                                                                      throws MetadataStoreException

Throws:

MetadataStoreException

getPoliciesIfCached

@Deprecated
public Optional<org.apache.pulsar.common.policies.data.Policies> getPoliciesIfCached(org.apache.pulsar.common.naming.NamespaceName ns)

Deprecated.

Since this method may introduce inconsistent namespace policies. we should use #getPoliciesAsync(org.apache.pulsar.common.naming.NamespaceName)

Get the namespace policy from the metadata cache. This method will not trigger the load of metadata cache.

getPoliciesAsync

public CompletableFuture<Optional<org.apache.pulsar.common.policies.data.Policies>> getPoliciesAsync(org.apache.pulsar.common.naming.NamespaceName ns)

setPolicies

public void setPolicies(org.apache.pulsar.common.naming.NamespaceName ns,
 Function<org.apache.pulsar.common.policies.data.Policies,org.apache.pulsar.common.policies.data.Policies> function)
                 throws MetadataStoreException

Throws:

MetadataStoreException

setPoliciesAsync

public CompletableFuture<Void> setPoliciesAsync(org.apache.pulsar.common.naming.NamespaceName ns,
 Function<org.apache.pulsar.common.policies.data.Policies,org.apache.pulsar.common.policies.data.Policies> function)

pathIsFromNamespace

public static boolean pathIsFromNamespace(String path)

pathIsNamespaceLocalPolicies

public static boolean pathIsNamespaceLocalPolicies(String path)

deleteNamespaceAsync

public CompletableFuture<Void> deleteNamespaceAsync(org.apache.pulsar.common.naming.NamespaceName ns)

Clear resource of `/namespace/{namespaceName}` for zk-node.

Parameters:

ns - the namespace name

Returns:

a handle to the results of the operation

deleteTenantAsync

public CompletableFuture<Void> deleteTenantAsync(String tenant)

namespaceFromPath

public static org.apache.pulsar.common.naming.NamespaceName namespaceFromPath(String path)

namespaceFromLocalPoliciesPath

public static org.apache.pulsar.common.naming.NamespaceName namespaceFromLocalPoliciesPath(String path)