org.apache.pulsar.broker.admin

Class AdminResource

java.lang.Object

org.apache.pulsar.broker.web.PulsarWebResource

org.apache.pulsar.broker.admin.AdminResource

Direct Known Subclasses:

Bookies, BrokersBase, BrokerStatsBase, ClustersBase, Functions, FunctionsBase, NamespacesBase, PersistentTopicsBase, SchemasResource, SinksBase, SourcesBase, TenantsBase, Worker, WorkerStats

public abstract class AdminResource
extends PulsarWebResource

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.pulsar.common.naming.NamespaceName	namespaceName
static String	PARTITIONED_TOPIC_PATH_ZNODE
protected org.apache.pulsar.common.naming.TopicName	topicName

Fields inherited from class org.apache.pulsar.broker.web.PulsarWebResource

httpRequest, NOT_IMPLEMENTED, servletContext, uri

Constructor Summary

Constructors

Constructor and Description
AdminResource()

Method Summary

Modifier and Type	Method and Description
protected void	checkArgument(boolean b, String errorMessage)
protected boolean	checkBacklogQuota(org.apache.pulsar.common.policies.data.BacklogQuota quota, org.apache.pulsar.common.policies.data.RetentionPolicies retention)
protected void	checkNotNull(Object o, String errorMessage)
static <T> T	checkNotNull(T reference)
protected CompletableFuture<Boolean>	checkTopicExistsAsync(org.apache.pulsar.common.naming.TopicName topicName) Check the exists topics contains the given topic.
protected void	checkTopicLevelPolicyEnable()
protected Set<String>	clusters()
protected ZooKeeperDataCache<org.apache.pulsar.common.policies.data.ClusterData>	clustersCache()
protected ZooKeeperChildrenCache	clustersListCache()
protected org.apache.pulsar.common.policies.data.DispatchRate	dispatchRate()
protected String	domain() Get the domain of the topic (whether it's persistent or non-persistent)
protected ZooKeeperDataCache<org.apache.pulsar.common.policies.data.FailureDomain>	failureDomainCache()
protected ZooKeeperChildrenCache	failureDomainListCache()
protected static org.apache.pulsar.common.partition.PartitionedTopicMetadata	fetchPartitionedTopicMetadata(PulsarService pulsar, org.apache.pulsar.common.naming.TopicName topicName)
protected static org.apache.pulsar.common.partition.PartitionedTopicMetadata	fetchPartitionedTopicMetadataCheckAllowAutoCreation(PulsarService pulsar, org.apache.pulsar.common.naming.TopicName topicName)
protected List<String>	getListOfNamespaces(String property) Get the list of namespaces (on every cluster) for a given property
protected org.apache.pulsar.common.policies.data.Policies	getNamespacePolicies(org.apache.pulsar.common.naming.NamespaceName namespaceName)
protected org.apache.pulsar.common.policies.data.Policies	getNamespacePolicies(String property, String cluster, String namespace)
protected CompletableFuture<org.apache.pulsar.common.policies.data.Policies>	getNamespacePoliciesAsync(org.apache.pulsar.common.naming.NamespaceName namespaceName)
protected Set<String>	getNamespaceReplicatedClusters(org.apache.pulsar.common.naming.NamespaceName namespaceName)
protected List<String>	getPartitionedTopicList(org.apache.pulsar.common.naming.TopicDomain topicDomain)
protected org.apache.pulsar.common.partition.PartitionedTopicMetadata	getPartitionedTopicMetadata(org.apache.pulsar.common.naming.TopicName topicName, boolean authoritative, boolean checkAllowAutoCreation)
protected CompletableFuture<org.apache.pulsar.common.partition.PartitionedTopicMetadata>	getPartitionedTopicMetadataAsync(org.apache.pulsar.common.naming.TopicName topicName, boolean authoritative, boolean checkAllowAutoCreation)
protected Optional<org.apache.pulsar.common.policies.data.TopicPolicies>	getTopicPolicies(org.apache.pulsar.common.naming.TopicName topicName)
protected ZooKeeper	globalZk()
protected ZooKeeperCache	globalZkCache()
protected void	internalCreatePartitionedTopic(javax.ws.rs.container.AsyncResponse asyncResponse, int numPartitions)
protected boolean	isLeaderBroker()
protected boolean	isNamespaceReplicated(org.apache.pulsar.common.naming.NamespaceName namespaceName)
static com.fasterxml.jackson.databind.ObjectMapper	jsonMapper()
protected LocalZooKeeperCacheService	localCacheService()
protected ZooKeeperDataCache<org.apache.pulsar.common.policies.data.LocalPolicies>	localPoliciesCache()
protected ZooKeeper	localZk()
protected ZooKeeperCache	localZkCache()
protected ZooKeeperManagedLedgerCache	managedLedgerListCache()
protected void	mergeNamespaceWithDefaults(org.apache.pulsar.common.policies.data.Policies policies, String namespace, String namespacePath)
protected org.apache.pulsar.common.policies.data.BacklogQuota	namespaceBacklogQuota(String namespace, String namespacePath)
protected ZooKeeperDataCache<org.apache.pulsar.common.policies.impl.NamespaceIsolationPolicies>	namespaceIsolationPoliciesCache()
protected ZooKeeperDataCache<org.apache.pulsar.common.policies.data.Policies>	policiesCache()
protected void	resumeAsyncResponseExceptionally(javax.ws.rs.container.AsyncResponse asyncResponse, Throwable throwable)
protected void	setServletContext(javax.servlet.ServletContext servletContext)
protected org.apache.pulsar.common.policies.data.SubscribeRate	subscribeRate()
protected org.apache.pulsar.common.policies.data.DispatchRate	subscriptionDispatchRate()
ZooKeeperDataCache<org.apache.pulsar.common.policies.data.TenantInfo>	tenantsCache()
protected CompletableFuture<Void>	tryCreatePartitionsAsync(int numPartitions)
protected void	validateAdminAccessForTenant(String property) Checks that the http client role has admin access to the specified tenant.
protected void	validateBrokerName(String broker) Redirect the call to the specified broker
protected void	validateBundleOwnership(String property, String cluster, String namespace, boolean authoritative, boolean readOnly, NamespaceBundle bundle)
protected void	validateClusterExists(String cluster)
protected void	validateGlobalNamespaceOwnership(String property, String namespace)
protected void	validateNamespaceName(String property, String namespace)
protected void	validateNamespaceName(String property, String cluster, String namespace) Deprecated.
protected void	validateNamespaceOwnershipWithBundles(String property, String cluster, String namespace, boolean authoritative, boolean readOnly, org.apache.pulsar.common.policies.data.BundlesData bundleData) Checks whether the broker is the owner of all the namespace bundles.
protected void	validatePartitionedTopicMetadata(String tenant, String namespace, String encodedTopic)
protected void	validatePartitionedTopicName(String tenant, String namespace, String encodedTopic)
protected void	validatePersistencePolicies(org.apache.pulsar.common.policies.data.PersistencePolicies persistence)
void	validatePoliciesReadOnlyAccess() Checks whether the broker is allowed to do read-write operations based on the existence of a node in global zookeeper.
protected void	validateSuperUserAccess() Checks whether the user has Pulsar Super-User access to the system.
protected void	validateTopicExistedAndCheckAllowAutoCreation(String tenant, String namespace, String encodedTopic, boolean checkAllowAutoCreation)
protected void	validateTopicName(String property, String namespace, String encodedTopic)
protected void	validateTopicName(String property, String cluster, String namespace, String encodedTopic) Deprecated.
protected void	zkCreate(String path, byte[] content)
protected void	zkCreateOptimistic(String path, byte[] content)
protected void	zkCreateOptimisticAsync(ZooKeeper zk, String path, byte[] content, AsyncCallback.StringCallback callback)
protected boolean	zkPathExists(String path)
protected void	zkSync(String path)

Methods inherited from class org.apache.pulsar.broker.web.PulsarWebResource

checkAuthorization, checkConnect, checkLocalOrGetPeerReplicationCluster, clientAppId, clientAuthData, config, getClusterDataIfDifferentCluster, hasSuperUserAccess, isBundleOwnedByAnyBroker, isClientAuthenticated, isLeaderBroker, isRequestHttps, joinPath, originalPrincipal, path, pulsar, setPulsar, splitPath, validateAdminAccessForTenant, validateBundleOwnership, validateClusterForTenant, validateClusterOwnership, validateGlobalNamespaceOwnership, validateNamespaceBundleOwnership, validateNamespaceBundleRange, validateNamespaceOperation, validateNamespacePolicyOperation, validateTenantOperation, validateTopicOwnership

Methods inherited from class java.lang.Object

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

Field Detail

PARTITIONED_TOPIC_PATH_ZNODE

public static final String PARTITIONED_TOPIC_PATH_ZNODE

See Also:

Constant Field Values

namespaceName

protected org.apache.pulsar.common.naming.NamespaceName namespaceName

topicName

protected org.apache.pulsar.common.naming.TopicName topicName

Constructor Detail

AdminResource

public AdminResource()

Method Detail

globalZk

protected ZooKeeper globalZk()

globalZkCache

protected ZooKeeperCache globalZkCache()

localZk

protected ZooKeeper localZk()

localZkCache

protected ZooKeeperCache localZkCache()

localCacheService

protected LocalZooKeeperCacheService localCacheService()

zkCreate

protected void zkCreate(String path,
                        byte[] content)
                 throws Exception

Throws:

Exception

zkCreateOptimistic

protected void zkCreateOptimistic(String path,
                                  byte[] content)
                           throws Exception

Throws:

Exception

zkCreateOptimisticAsync

protected void zkCreateOptimisticAsync(ZooKeeper zk,
                                       String path,
                                       byte[] content,
                                       AsyncCallback.StringCallback callback)

zkPathExists

protected boolean zkPathExists(String path)
                        throws KeeperException,
                               InterruptedException

Throws:

KeeperException

InterruptedException

zkSync

protected void zkSync(String path)
               throws Exception

Throws:

Exception

domain

protected String domain()

Get the domain of the topic (whether it's persistent or non-persistent)

validateSuperUserAccess

protected void validateSuperUserAccess()

Description copied from class: PulsarWebResource

Checks whether the user has Pulsar Super-User access to the system.

Overrides:

validateSuperUserAccess in class PulsarWebResource

validateAdminAccessForTenant

protected void validateAdminAccessForTenant(String property)

Description copied from class: PulsarWebResource

Checks that the http client role has admin access to the specified tenant.

Overrides:

validateAdminAccessForTenant in class PulsarWebResource

Parameters:

property - the tenant id

validateNamespaceOwnershipWithBundles

protected void validateNamespaceOwnershipWithBundles(String property,
                                                     String cluster,
                                                     String namespace,
                                                     boolean authoritative,
                                                     boolean readOnly,
                                                     org.apache.pulsar.common.policies.data.BundlesData bundleData)

Description copied from class: PulsarWebResource

Checks whether the broker is the owner of all the namespace bundles. Otherwise, if authoritative is false, it will throw an exception to redirect to assigned owner or leader; if authoritative is true then it will try to acquire all the namespace bundles.

Overrides:

validateNamespaceOwnershipWithBundles in class PulsarWebResource

Parameters:

property - tenant name

cluster - cluster name

namespace - namespace name

authoritative - if it is an authoritative request

readOnly - if the request is read-only

bundleData - bundle data

validateBundleOwnership

protected void validateBundleOwnership(String property,
                                       String cluster,
                                       String namespace,
                                       boolean authoritative,
                                       boolean readOnly,
                                       NamespaceBundle bundle)

Overrides:

validateBundleOwnership in class PulsarWebResource

isLeaderBroker

protected boolean isLeaderBroker()

Overrides:

isLeaderBroker in class PulsarWebResource

validatePoliciesReadOnlyAccess

public void validatePoliciesReadOnlyAccess()

Checks whether the broker is allowed to do read-write operations based on the existence of a node in global zookeeper.

Throws:

javax.ws.rs.WebApplicationException - if broker has a read only access if broker is not connected to the global zookeeper

getListOfNamespaces

protected List<String> getListOfNamespaces(String property)
                                    throws Exception

Get the list of namespaces (on every cluster) for a given property

Parameters:

property - the property name

Returns:

the list of namespaces

Throws:

Exception

tryCreatePartitionsAsync

protected CompletableFuture<Void> tryCreatePartitionsAsync(int numPartitions)

validateNamespaceName

protected void validateNamespaceName(String property,
                                     String namespace)

validateGlobalNamespaceOwnership

protected void validateGlobalNamespaceOwnership(String property,
                                                String namespace)

validateNamespaceName

@Deprecated
protected void validateNamespaceName(String property,
                                                 String cluster,
                                                 String namespace)

Deprecated.

validateTopicName

protected void validateTopicName(String property,
                                 String namespace,
                                 String encodedTopic)

validatePartitionedTopicName

protected void validatePartitionedTopicName(String tenant,
                                            String namespace,
                                            String encodedTopic)

validatePartitionedTopicMetadata

protected void validatePartitionedTopicMetadata(String tenant,
                                                String namespace,
                                                String encodedTopic)

validateTopicExistedAndCheckAllowAutoCreation

protected void validateTopicExistedAndCheckAllowAutoCreation(String tenant,
                                                             String namespace,
                                                             String encodedTopic,
                                                             boolean checkAllowAutoCreation)

validateTopicName

@Deprecated
protected void validateTopicName(String property,
                                             String cluster,
                                             String namespace,
                                             String encodedTopic)

Deprecated.

validateBrokerName

protected void validateBrokerName(String broker)
                           throws MalformedURLException

Redirect the call to the specified broker

Parameters:

broker - Broker name

Throws:

MalformedURLException - In case the redirect happens

getNamespacePolicies

protected org.apache.pulsar.common.policies.data.Policies getNamespacePolicies(org.apache.pulsar.common.naming.NamespaceName namespaceName)

getNamespacePoliciesAsync

protected CompletableFuture<org.apache.pulsar.common.policies.data.Policies> getNamespacePoliciesAsync(org.apache.pulsar.common.naming.NamespaceName namespaceName)

mergeNamespaceWithDefaults

protected void mergeNamespaceWithDefaults(org.apache.pulsar.common.policies.data.Policies policies,
                                          String namespace,
                                          String namespacePath)

namespaceBacklogQuota

protected org.apache.pulsar.common.policies.data.BacklogQuota namespaceBacklogQuota(String namespace,
                                                                                    String namespacePath)

getTopicPolicies

protected Optional<org.apache.pulsar.common.policies.data.TopicPolicies> getTopicPolicies(org.apache.pulsar.common.naming.TopicName topicName)

checkBacklogQuota

protected boolean checkBacklogQuota(org.apache.pulsar.common.policies.data.BacklogQuota quota,
                                    org.apache.pulsar.common.policies.data.RetentionPolicies retention)

checkTopicLevelPolicyEnable

protected void checkTopicLevelPolicyEnable()

dispatchRate

protected org.apache.pulsar.common.policies.data.DispatchRate dispatchRate()

subscriptionDispatchRate

protected org.apache.pulsar.common.policies.data.DispatchRate subscriptionDispatchRate()

subscribeRate

protected org.apache.pulsar.common.policies.data.SubscribeRate subscribeRate()

jsonMapper

public static com.fasterxml.jackson.databind.ObjectMapper jsonMapper()

tenantsCache

public ZooKeeperDataCache<org.apache.pulsar.common.policies.data.TenantInfo> tenantsCache()

policiesCache

protected ZooKeeperDataCache<org.apache.pulsar.common.policies.data.Policies> policiesCache()

localPoliciesCache

protected ZooKeeperDataCache<org.apache.pulsar.common.policies.data.LocalPolicies> localPoliciesCache()

clustersCache

protected ZooKeeperDataCache<org.apache.pulsar.common.policies.data.ClusterData> clustersCache()

managedLedgerListCache

protected ZooKeeperManagedLedgerCache managedLedgerListCache()

clusters

protected Set<String> clusters()

clustersListCache

protected ZooKeeperChildrenCache clustersListCache()

setServletContext

protected void setServletContext(javax.servlet.ServletContext servletContext)

namespaceIsolationPoliciesCache

protected ZooKeeperDataCache<org.apache.pulsar.common.policies.impl.NamespaceIsolationPolicies> namespaceIsolationPoliciesCache()

failureDomainCache

protected ZooKeeperDataCache<org.apache.pulsar.common.policies.data.FailureDomain> failureDomainCache()

failureDomainListCache

protected ZooKeeperChildrenCache failureDomainListCache()

getPartitionedTopicMetadataAsync

protected CompletableFuture<org.apache.pulsar.common.partition.PartitionedTopicMetadata> getPartitionedTopicMetadataAsync(org.apache.pulsar.common.naming.TopicName topicName,
                                                                                                                          boolean authoritative,
                                                                                                                          boolean checkAllowAutoCreation)

getPartitionedTopicMetadata

protected org.apache.pulsar.common.partition.PartitionedTopicMetadata getPartitionedTopicMetadata(org.apache.pulsar.common.naming.TopicName topicName,
                                                                                                  boolean authoritative,
                                                                                                  boolean checkAllowAutoCreation)

fetchPartitionedTopicMetadata

protected static org.apache.pulsar.common.partition.PartitionedTopicMetadata fetchPartitionedTopicMetadata(PulsarService pulsar,
                                                                                                           org.apache.pulsar.common.naming.TopicName topicName)

fetchPartitionedTopicMetadataCheckAllowAutoCreation

protected static org.apache.pulsar.common.partition.PartitionedTopicMetadata fetchPartitionedTopicMetadataCheckAllowAutoCreation(PulsarService pulsar,
                                                                                                                                 org.apache.pulsar.common.naming.TopicName topicName)

validateClusterExists

protected void validateClusterExists(String cluster)

getNamespacePolicies

protected org.apache.pulsar.common.policies.data.Policies getNamespacePolicies(String property,
                                                                               String cluster,
                                                                               String namespace)

isNamespaceReplicated

protected boolean isNamespaceReplicated(org.apache.pulsar.common.naming.NamespaceName namespaceName)

getNamespaceReplicatedClusters

protected Set<String> getNamespaceReplicatedClusters(org.apache.pulsar.common.naming.NamespaceName namespaceName)

getPartitionedTopicList

protected List<String> getPartitionedTopicList(org.apache.pulsar.common.naming.TopicDomain topicDomain)

internalCreatePartitionedTopic

protected void internalCreatePartitionedTopic(javax.ws.rs.container.AsyncResponse asyncResponse,
                                              int numPartitions)

checkTopicExistsAsync

protected CompletableFuture<Boolean> checkTopicExistsAsync(org.apache.pulsar.common.naming.TopicName topicName)

Check the exists topics contains the given topic. Since there are topic partitions and non-partitioned topics in Pulsar, must ensure both partitions and non-partitioned topics are not duplicated. So, if compare with a partition name, we should compare to the partitioned name of this partition.

Parameters:

topicName - given topic name

resumeAsyncResponseExceptionally

protected void resumeAsyncResponseExceptionally(javax.ws.rs.container.AsyncResponse asyncResponse,
                                                Throwable throwable)

checkNotNull

@CanIgnoreReturnValue
public static <T> T checkNotNull(T reference)

checkNotNull

protected void checkNotNull(Object o,
                            String errorMessage)

checkArgument

protected void checkArgument(boolean b,
                             String errorMessage)

validatePersistencePolicies

protected void validatePersistencePolicies(org.apache.pulsar.common.policies.data.PersistencePolicies persistence)