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, BrokerStatsBase, Functions, FunctionsBase, NamespacesBase, PackagesBase, PersistentTopicsBase, ResourceGroupsBase, SchemasResourceBase, SinksBase, SourcesBase, TransactionsBase, 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
static String	POLICIES_READONLY_FLAG_PATH
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 BookKeeper	bookKeeper()
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 org.apache.pulsar.common.policies.data.impl.DispatchRateImpl	dispatchRate()
protected String	domain() Get the domain of the topic (whether it's persistent or non-persistent).
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 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 List<String>	getTopicPartitionList(org.apache.pulsar.common.naming.TopicDomain topicDomain)
protected CompletableFuture<Optional<org.apache.pulsar.common.policies.data.TopicPolicies>>	getTopicPoliciesAsyncWithRetry(org.apache.pulsar.common.naming.TopicName topicName)
protected void	internalCreatePartitionedTopic(javax.ws.rs.container.AsyncResponse asyncResponse, int numPartitions, boolean createLocalTopicOnly)
protected boolean	isLeaderBroker()
protected boolean	isNamespaceReplicated(org.apache.pulsar.common.naming.NamespaceName namespaceName)
static com.fasterxml.jackson.databind.ObjectMapper	jsonMapper()
protected LocalZooKeeperCacheService	localCacheService()
protected ZooKeeper	localZk()
protected ZooKeeperCache	localZkCache()
protected void	localZKCreate(String path, byte[] content)
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, org.apache.pulsar.common.policies.data.BacklogQuota.BacklogQuotaType backlogQuotaType)
protected org.apache.pulsar.common.policies.data.impl.DispatchRateImpl	replicatorDispatchRate()
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.impl.DispatchRateImpl	subscriptionDispatchRate()
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	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	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 configuration metadata-store.
void	validateSuperUserAccess() Checks whether the user has Pulsar Super-User access to the system.
protected void	validateTopicName(String property, String namespace, String encodedTopic)
protected void	validateTopicName(String property, String cluster, String namespace, String encodedTopic) Deprecated.

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

canUpdateCluster, checkAuthorization, checkLocalOrGetPeerReplicationCluster, clientAppId, clientAuthData, clusterResources, config, deleteRecursive, dynamicConfigurationResources, getClusterDataIfDifferentCluster, getListOfNamespaces, getListOfResourcegroups, getLocalPolicies, getPulsarResources, hasActiveNamespace, hasSuperUserAccess, isBundleOwnedByAnyBroker, isClientAuthenticated, isLeaderBroker, isRequestHttps, joinPath, listSubTreeBFS, namespaceIsolationPolicies, namespaceResources, originalPrincipal, path, pulsar, resourceGroupResources, setPulsar, splitPath, tenantResources, validateAdminAccessForTenant, validateBrokerName, validateBundleOwnership, validateClusterForTenant, validateClusterOwnership, validateGlobalNamespaceOwnership, validateGlobalNamespaceOwnershipAsync, validateNamespaceBundleOwnership, validateNamespaceBundleRange, validateNamespaceOperation, validateNamespacePolicyOperation, validateTenantOperation, validateTopicOperation, validateTopicOperation, validateTopicOwnership, validateTopicOwnershipAsync, validateTopicPolicyOperation

Methods inherited from class java.lang.Object

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

Field Detail

POLICIES_READONLY_FLAG_PATH

public static final String POLICIES_READONLY_FLAG_PATH

See Also:

Constant Field Values

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

bookKeeper

protected BookKeeper bookKeeper()

localZk

protected ZooKeeper localZk()

localZkCache

protected ZooKeeperCache localZkCache()

localCacheService

protected LocalZooKeeperCacheService localCacheService()

localZKCreate

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

Throws:

Exception

domain

protected String domain()

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

validateSuperUserAccess

public 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

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 configuration metadata-store.

Overrides:

validatePoliciesReadOnlyAccess in class PulsarWebResource

Throws:

javax.ws.rs.WebApplicationException - if broker has a read only access if broker is not connected to the configuration metadata-store

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)

validateTopicName

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

Deprecated.

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,
                                                                                    org.apache.pulsar.common.policies.data.BacklogQuota.BacklogQuotaType backlogQuotaType)

getTopicPoliciesAsyncWithRetry

protected CompletableFuture<Optional<org.apache.pulsar.common.policies.data.TopicPolicies>> getTopicPoliciesAsyncWithRetry(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.impl.DispatchRateImpl dispatchRate()

subscriptionDispatchRate

protected org.apache.pulsar.common.policies.data.impl.DispatchRateImpl subscriptionDispatchRate()

replicatorDispatchRate

protected org.apache.pulsar.common.policies.data.impl.DispatchRateImpl replicatorDispatchRate()

subscribeRate

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

jsonMapper

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

clusters

protected Set<String> clusters()

setServletContext

protected void setServletContext(javax.servlet.ServletContext servletContext)

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)

Overrides:

validateClusterExists in class PulsarWebResource

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)

getTopicPartitionList

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

internalCreatePartitionedTopic

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

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)