org.apache.pulsar.broker.admin.impl

Class BrokersBase

java.lang.Object

org.apache.pulsar.broker.web.PulsarWebResource

org.apache.pulsar.broker.admin.AdminResource

org.apache.pulsar.broker.admin.impl.BrokersBase

Direct Known Subclasses:

Brokers, Brokers

public class BrokersBase
extends AdminResource

Broker admin base.

Field Summary

Fields

Modifier and Type	Field and Description
static String	HEALTH_CHECK_TOPIC_SUFFIX

Fields inherited from class org.apache.pulsar.broker.admin.AdminResource

namespaceName, topicName

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

httpRequest, servletContext, uri

Constructor Summary

Constructors

Constructor and Description
BrokersBase()

Method Summary

Modifier and Type	Method and Description
void	backlogQuotaCheck(javax.ws.rs.container.AsyncResponse asyncResponse)
void	deleteDynamicConfiguration(javax.ws.rs.container.AsyncResponse asyncResponse, String configName)
void	getActiveBrokers(javax.ws.rs.container.AsyncResponse asyncResponse, String cluster)
Map<String,String>	getAllDynamicConfigurations()
List<String>	getDynamicConfigurationName()
org.apache.pulsar.common.conf.InternalConfigurationData	getInternalConfigurationData()
void	getLeaderBroker(javax.ws.rs.container.AsyncResponse asyncResponse)
Map<String,org.apache.pulsar.common.policies.data.NamespaceOwnershipStatus>	getOwnedNamespaces(String cluster, String broker)
Map<String,String>	getRuntimeConfiguration()
void	healthCheck(javax.ws.rs.container.AsyncResponse asyncResponse, org.apache.pulsar.common.naming.TopicVersion topicVersion)
void	isReady(javax.ws.rs.container.AsyncResponse asyncResponse)
void	shutDownBrokerGracefully(int maxConcurrentUnloadPerSec, boolean forcedTerminateTopic)
void	updateDynamicConfiguration(javax.ws.rs.container.AsyncResponse asyncResponse, String configName, String configValue)
String	version()

Methods inherited from class org.apache.pulsar.broker.admin.AdminResource

bookKeeper, checkArgument, checkBacklogQuota, checkNotNull, checkNotNull, checkTopicExistsAsync, checkTopicLevelPolicyEnable, clusters, dispatchRate, domain, fetchPartitionedTopicMetadata, fetchPartitionedTopicMetadataCheckAllowAutoCreation, getNamespacePolicies, getNamespacePolicies, getNamespacePoliciesAsync, getNamespaceReplicatedClusters, getPartitionedTopicList, getPartitionedTopicMetadata, getPartitionedTopicMetadataAsync, getSchemaCompatibilityStrategyAsync, getTopicNotFoundErrorMessage, getTopicPartitionList, getTopicPoliciesAsyncWithRetry, getTopicPoliciesAsyncWithRetry, internalCreatePartitionedTopic, internalCreatePartitionedTopic, isLeaderBroker, isManagedLedgerNotFoundException, isNamespaceReplicated, isRedirectException, jsonMapper, namespaceBacklogQuota, replicatorDispatchRate, resumeAsyncResponseExceptionally, setServletContext, subscribeRate, subscriptionDispatchRate, tryCreatePartitionsAsync, validateAdminAccessForTenant, validateBundleOwnership, validateClusterExists, validateGlobalNamespaceOwnership, validateNamespaceName, validateNamespaceName, validatePartitionedTopicMetadata, validatePartitionedTopicName, validatePersistencePolicies, validatePersistentTopicName, validatePersistentTopicName, validatePoliciesReadOnlyAccess, validatePoliciesReadOnlyAccessAsync, validateSuperUserAccess, validateTopicName, validateTopicName

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

bookieResources, canUpdateCluster, checkAuthorizationAsync, checkLocalOrGetPeerReplicationCluster, clientAppId, clientAuthData, clusterResources, config, dynamicConfigurationResources, getClusterDataIfDifferentCluster, getLocalPolicies, getPulsarResources, handleCommonRestAsyncException, hasActiveNamespace, hasSuperUserAccess, isBundleOwnedByAnyBroker, isClientAuthenticated, isLeaderBroker, isRequestHttps, namespaceIsolationPolicies, namespaceResources, originalPrincipal, pulsar, resourceGroupResources, setPulsar, splitPath, tenantResources, topicResources, validateAdminAccessForTenant, validateAdminAccessForTenantAsync, validateAdminAccessForTenantAsync, validateBrokerName, validateBundleOwnership, validateClusterForTenant, validateClusterOwnership, validateClusterOwnershipAsync, validateGlobalNamespaceOwnership, validateGlobalNamespaceOwnershipAsync, validateNamespaceBundleOwnership, validateNamespaceBundleRange, validateNamespaceOperation, validateNamespaceOperationAsync, validateNamespacePolicyOperation, validateNamespacePolicyOperationAsync, validatePeerClusterConflict, validateSuperUserAccessAsync, validateTenantOperation, validateTenantOperationAsync, validateTopicOperation, validateTopicOperation, validateTopicOperationAsync, validateTopicOperationAsync, validateTopicOwnership, validateTopicOwnershipAsync, validateTopicPolicyOperation, validateTopicPolicyOperationAsync

Methods inherited from class java.lang.Object

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

Field Detail

HEALTH_CHECK_TOPIC_SUFFIX

public static final String HEALTH_CHECK_TOPIC_SUFFIX

See Also:

Constant Field Values

Constructor Detail

BrokersBase

public BrokersBase()

Method Detail

getActiveBrokers

@GET
 @Path(value="/{cluster}")
public void getActiveBrokers(@Suspended
                                                             javax.ws.rs.container.AsyncResponse asyncResponse,
                                                             @PathParam(value="cluster")
                                                             String cluster)

getLeaderBroker

@GET
 @Path(value="/leaderBroker")
public void getLeaderBroker(@Suspended
                                                               javax.ws.rs.container.AsyncResponse asyncResponse)

getOwnedNamespaces

@GET
 @Path(value="/{clusterName}/{broker-webserviceurl}/ownedNamespaces")
public Map<String,org.apache.pulsar.common.policies.data.NamespaceOwnershipStatus> getOwnedNamespaces(@PathParam(value="clusterName")
                                                                                                                                                                                 String cluster,
                                                                                                                                                                                 @PathParam(value="broker-webserviceurl")
                                                                                                                                                                                 String broker)
                                                                                                                                                                          throws Exception

Throws:

Exception

updateDynamicConfiguration

@POST
 @Path(value="/configuration/{configName}/{configValue}")
public void updateDynamicConfiguration(@Suspended
                                                                                                       javax.ws.rs.container.AsyncResponse asyncResponse,
                                                                                                       @PathParam(value="configName")
                                                                                                       String configName,
                                                                                                       @PathParam(value="configValue")
                                                                                                       String configValue)

deleteDynamicConfiguration

@DELETE
 @Path(value="/configuration/{configName}")
public void deleteDynamicConfiguration(@Suspended
                                                                                           javax.ws.rs.container.AsyncResponse asyncResponse,
                                                                                           @PathParam(value="configName")
                                                                                           String configName)

getAllDynamicConfigurations

@GET
 @Path(value="/configuration/values")
public Map<String,String> getAllDynamicConfigurations()
                                                                                          throws Exception

Throws:

Exception

getDynamicConfigurationName

@GET
 @Path(value="/configuration")
public List<String> getDynamicConfigurationName()

getRuntimeConfiguration

@GET
 @Path(value="/configuration/runtime")
public Map<String,String> getRuntimeConfiguration()

getInternalConfigurationData

@GET
 @Path(value="/internal-configuration")
public org.apache.pulsar.common.conf.InternalConfigurationData getInternalConfigurationData()

backlogQuotaCheck

@GET
 @Path(value="/backlog-quota-check")
public void backlogQuotaCheck(@Suspended
                                                                        javax.ws.rs.container.AsyncResponse asyncResponse)

isReady

@GET
 @Path(value="/ready")
public void isReady(@Suspended
                                                javax.ws.rs.container.AsyncResponse asyncResponse)

healthCheck

@GET
 @Path(value="/health")
public void healthCheck(@Suspended
                                                     javax.ws.rs.container.AsyncResponse asyncResponse,
                                                     @QueryParam(value="topicVersion")
                                                     org.apache.pulsar.common.naming.TopicVersion topicVersion)

version

@GET
 @Path(value="/version")
public String version()
                                             throws Exception

Throws:

Exception

shutDownBrokerGracefully

@POST
 @Path(value="/shutdown")
public void shutDownBrokerGracefully(@QueryParam(value="maxConcurrentUnloadPerSec")
                                                                     int maxConcurrentUnloadPerSec,
                                                                     @QueryParam(value="forcedTerminateTopic") @DefaultValue(value="true")
                                                                     boolean forcedTerminateTopic)