Package 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	Description
static final 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	Description
BrokersBase()

Method Summary

Modifier and Type	Method	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)
void	getActiveBrokers(javax.ws.rs.container.AsyncResponse asyncResponse, String cluster)
void	getAllDynamicConfigurations(javax.ws.rs.container.AsyncResponse asyncResponse)
void	getDynamicConfigurationName(javax.ws.rs.container.AsyncResponse asyncResponse)
static String	getHeartbeatTopicName(String brokerId, ServiceConfiguration configuration, boolean isV2)
void	getInternalConfigurationData(javax.ws.rs.container.AsyncResponse asyncResponse)
void	getLeaderBroker(javax.ws.rs.container.AsyncResponse asyncResponse)
void	getOwnedNamespaces(javax.ws.rs.container.AsyncResponse asyncResponse, String cluster, String brokerId)
void	getRuntimeConfiguration(javax.ws.rs.container.AsyncResponse asyncResponse)
void	healthCheck(javax.ws.rs.container.AsyncResponse asyncResponse, org.apache.pulsar.common.naming.TopicVersion topicVersion, String brokerId)
static CompletableFuture<Void>	internalRunHealthCheck(org.apache.pulsar.common.naming.TopicVersion topicVersion, PulsarService pulsar, String clientAppId)
void	isReady(javax.ws.rs.container.AsyncResponse asyncResponse)
void	shutDownBrokerGracefully(int maxConcurrentUnloadPerSec, boolean forcedTerminateTopic, javax.ws.rs.container.AsyncResponse asyncResponse)
void	updateDynamicConfiguration(javax.ws.rs.container.AsyncResponse asyncResponse, String configName, String configValue)
String	version()

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

autoSubscriptionCreationOverride, bookKeeper, checkArgument, checkBacklogQuota, checkNotNull, checkNotNull, checkTopicExistsAsync, clusters, clustersAsync, dispatchRate, domain, filterSystemTopic, getAuthorizationService, getNamespacePolicies, getNamespacePolicies, getNamespacePoliciesAsync, getNamespaceReplicatedClustersAsync, getPartitionedTopicList, getPartitionedTopicListAsync, getPartitionedTopicMetadata, getPartitionedTopicMetadataAsync, getPartitionedTopicNotFoundErrorMessage, getSchemaCompatibilityStrategyAsync, getSchemaCompatibilityStrategyAsyncWithoutAuth, getSubNotFoundErrorMessage, getTopicNotFoundErrorMessage, getTopicPartitionList, getTopicPoliciesAsyncWithRetry, getTopicPoliciesAsyncWithRetry, internalCheckTopicExists, internalCreatePartitionedTopic, internalCreatePartitionedTopic, internalCreatePartitionedTopicToReplicatedClustersInBackground, isLeaderBroker, isManagedLedgerNotFoundException, isNot307And404Exception, isNotFoundException, isRedirectException, namespaceBacklogQuota, objectReader, objectWriter, replicatorDispatchRate, setServletContext, subscribeRate, subscriptionDispatchRate, tryCreatePartitionsAsync, validateAdminAccessForTenant, validateAndGetWorkerService, validateBundleOwnership, validateClusterExists, validateEntryFilters, validateGlobalNamespaceOwnership, validateNamespaceName, validateNamespaceName, validateOffloadPolicies, validatePartitionedTopicMetadataAsync, validatePartitionedTopicName, validatePersistencePolicies, validatePersistentTopicName, validatePersistentTopicName, validatePoliciesReadOnlyAccess, validatePoliciesReadOnlyAccessAsync, validateSuperUserAccess, validateTopicName, validateTopicName

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

authParams, bookieResources, canUpdateCluster, checkAuthorizationAsync, checkLocalOrGetPeerReplicationCluster, checkLocalOrGetPeerReplicationCluster, clientAppId, clientAuthData, clusterResources, config, dynamicConfigurationResources, getClusterDataIfDifferentCluster, getLocalPolicies, getPulsarResources, hasActiveNamespace, hasSuperUserAccess, isBundleOwnedByAnyBroker, isClientAuthenticated, isLeaderBroker, isRequestHttps, loadBalanceResources, maybeRedirectToBroker, namespaceIsolationPolicies, namespaceResources, originalPrincipal, pulsar, resourceGroupResources, resumeAsyncResponseExceptionally, setPulsar, splitPath, sync, tenantResources, topicResources, validateAdminAccessForTenant, validateAdminAccessForTenantAsync, validateAdminAccessForTenantAsync, validateBundleOwnership, validateBundleOwnershipAsync, validateClusterForTenant, validateClusterForTenantAsync, validateClusterOwnership, validateClusterOwnershipAsync, validateGlobalNamespaceOwnership, validateGlobalNamespaceOwnershipAsync, validateNamespaceBundleOwnership, validateNamespaceBundleOwnershipAsync, validateNamespaceBundleRange, validateNamespaceOperation, validateNamespaceOperationAsync, validateNamespacePolicyOperation, validateNamespacePolicyOperationAsync, validatePeerClusterConflict, validatePeerClusterConflictAsync, validateSuperUserAccessAsync, validateTenantOperation, validateTenantOperationAsync, 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 Details

HEALTH_CHECK_TOPIC_SUFFIX

public static final String HEALTH_CHECK_TOPIC_SUFFIX

See Also:

• Constant Field Values

Constructor Details

BrokersBase

public BrokersBase()

Method Details

getActiveBrokers

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

getActiveBrokers

@GET
public void getActiveBrokers(@Suspended
 javax.ws.rs.container.AsyncResponse asyncResponse)
                      throws Exception

Throws:

Exception

getLeaderBroker

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

getOwnedNamespaces

@GET
@Path("/{clusterName}/{brokerId}/ownedNamespaces")
public void getOwnedNamespaces(@Suspended
 javax.ws.rs.container.AsyncResponse asyncResponse,
 @PathParam("clusterName")
 String cluster,
 @PathParam("brokerId")
 String brokerId)

updateDynamicConfiguration

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

deleteDynamicConfiguration

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

getAllDynamicConfigurations

@GET
@Path("/configuration/values")
public void getAllDynamicConfigurations(@Suspended
 javax.ws.rs.container.AsyncResponse asyncResponse)

getDynamicConfigurationName

@GET
@Path("/configuration")
public void getDynamicConfigurationName(@Suspended
 javax.ws.rs.container.AsyncResponse asyncResponse)

getRuntimeConfiguration

@GET
@Path("/configuration/runtime")
public void getRuntimeConfiguration(@Suspended
 javax.ws.rs.container.AsyncResponse asyncResponse)

getInternalConfigurationData

@GET
@Path("/internal-configuration")
public void getInternalConfigurationData(@Suspended
 javax.ws.rs.container.AsyncResponse asyncResponse)

backlogQuotaCheck

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

isReady

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

healthCheck

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

getHeartbeatTopicName

public static String getHeartbeatTopicName(String brokerId,
 ServiceConfiguration configuration,
 boolean isV2)

internalRunHealthCheck

public static CompletableFuture<Void> internalRunHealthCheck(org.apache.pulsar.common.naming.TopicVersion topicVersion,
 PulsarService pulsar,
 String clientAppId)

version

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

Throws:

Exception

shutDownBrokerGracefully

@POST
@Path("/shutdown")
public void shutDownBrokerGracefully(@QueryParam("maxConcurrentUnloadPerSec")
 int maxConcurrentUnloadPerSec,
 @QueryParam("forcedTerminateTopic") @DefaultValue("true")
 boolean forcedTerminateTopic,
 @Suspended
 javax.ws.rs.container.AsyncResponse asyncResponse)