org.apache.pulsar.client.admin.internal

Class BrokersImpl

java.lang.Object

org.apache.pulsar.client.admin.internal.BaseResource

org.apache.pulsar.client.admin.internal.BrokersImpl

All Implemented Interfaces:

Brokers

public class BrokersImpl
extends BaseResource
implements Brokers

Field Summary

Fields inherited from class org.apache.pulsar.client.admin.internal.BaseResource

auth, readTimeoutMs

Constructor Summary

Constructors

Constructor and Description
BrokersImpl(javax.ws.rs.client.WebTarget web, org.apache.pulsar.client.api.Authentication auth, long readTimeoutMs)

Method Summary

Modifier and Type	Method and Description
void	backlogQuotaCheck() Manually trigger backlogQuotaCheck.
CompletableFuture<Void>	backlogQuotaCheckAsync() Manually trigger backlogQuotaCheck asynchronously.
void	deleteDynamicConfiguration(String configName) It deletes dynamic configuration value into ZooKeeper.
CompletableFuture<Void>	deleteDynamicConfigurationAsync(String configName) It deletes dynamic configuration value into ZooKeeper asynchronously.
List<String>	getActiveBrokers(String cluster) Get the list of active brokers in the cluster.
CompletableFuture<List<String>>	getActiveBrokersAsync(String cluster) Get the list of active brokers in the cluster asynchronously.
Map<String,String>	getAllDynamicConfigurations() Get values of all overridden dynamic-configs.
CompletableFuture<Map<String,String>>	getAllDynamicConfigurationsAsync() Get values of all overridden dynamic-configs asynchronously.
List<String>	getDynamicConfigurationNames() Get list of updatable configuration name.
CompletableFuture<List<String>>	getDynamicConfigurationNamesAsync() Get list of updatable configuration name asynchronously.
org.apache.pulsar.common.conf.InternalConfigurationData	getInternalConfigurationData() Get the internal configuration data.
CompletableFuture<org.apache.pulsar.common.conf.InternalConfigurationData>	getInternalConfigurationDataAsync() Get the internal configuration data asynchronously.
Map<String,org.apache.pulsar.common.policies.data.NamespaceOwnershipStatus>	getOwnedNamespaces(String cluster, String brokerUrl) Get the map of owned namespaces and their status from a single broker in the cluster.
CompletableFuture<Map<String,org.apache.pulsar.common.policies.data.NamespaceOwnershipStatus>>	getOwnedNamespacesAsync(String cluster, String brokerUrl) Get the map of owned namespaces and their status from a single broker in the cluster asynchronously.
Map<String,String>	getRuntimeConfigurations() Get values of runtime configuration.
CompletableFuture<Map<String,String>>	getRuntimeConfigurationsAsync() Get values of runtime configuration asynchronously.
String	getVersion() Get version of broker.
void	healthcheck() Run a healthcheck on the broker.
CompletableFuture<Void>	healthcheckAsync() Run a healthcheck on the broker asynchronously.
void	updateDynamicConfiguration(String configName, String configValue) Update a dynamic configuration value into ZooKeeper.
CompletableFuture<Void>	updateDynamicConfigurationAsync(String configName, String configValue) Update a dynamic configuration value into ZooKeeper asynchronously.

Methods inherited from class org.apache.pulsar.client.admin.internal.BaseResource

asyncDeleteRequest, asyncGetRequest, asyncPostRequest, asyncPutRequest, getApiException, getApiException, request, requestAsync

Methods inherited from class java.lang.Object

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

Constructor Detail

BrokersImpl

public BrokersImpl(javax.ws.rs.client.WebTarget web,
                   org.apache.pulsar.client.api.Authentication auth,
                   long readTimeoutMs)

Method Detail

getActiveBrokers

public List<String> getActiveBrokers(String cluster)
                              throws PulsarAdminException

Description copied from interface: Brokers

Get the list of active brokers in the cluster.

Get the list of active brokers (web service addresses) in the cluster.

Response Example:

 ["prod1-broker1.messaging.use.example.com:8080", "prod1-broker2.messaging.use.example.com:8080"
 * * "prod1-broker3.messaging.use.example.com:8080"]
 

Specified by:

getActiveBrokers in interface Brokers

Parameters:

cluster - Cluster name

Returns:

a list of (host:port)

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission to get the list of active brokers in the cluster

PulsarAdminException.NotFoundException - Cluster doesn't exist

PulsarAdminException - Unexpected error

getActiveBrokersAsync

public CompletableFuture<List<String>> getActiveBrokersAsync(String cluster)

Description copied from interface: Brokers

Get the list of active brokers in the cluster asynchronously.

Get the list of active brokers (web service addresses) in the cluster.

Response Example:

 ["prod1-broker1.messaging.use.example.com:8080", "prod1-broker2.messaging.use.example.com:8080",
 "prod1-broker3.messaging.use.example.com:8080"]
 

Specified by:

getActiveBrokersAsync in interface Brokers

Parameters:

cluster - Cluster name

Returns:

a list of (host:port)

getOwnedNamespaces

public Map<String,org.apache.pulsar.common.policies.data.NamespaceOwnershipStatus> getOwnedNamespaces(String cluster,
                                                                                                      String brokerUrl)
                                                                                               throws PulsarAdminException

Description copied from interface: Brokers

Get the map of owned namespaces and their status from a single broker in the cluster.

The map is returned in a JSON object format below

Response Example:

 {"ns-1":{"broker_assignment":"shared","is_active":"true","is_controlled":"false"},
 "ns-2":{"broker_assignment":"primary","is_active":"true","is_controlled":"true"}}
 

Specified by:

getOwnedNamespaces in interface Brokers

Returns:

Throws:

PulsarAdminException

getOwnedNamespacesAsync

public CompletableFuture<Map<String,org.apache.pulsar.common.policies.data.NamespaceOwnershipStatus>> getOwnedNamespacesAsync(String cluster,
                                                                                                                              String brokerUrl)

Description copied from interface: Brokers

Get the map of owned namespaces and their status from a single broker in the cluster asynchronously.

The map is returned in a JSON object format below

Response Example:

 {"ns-1":{"broker_assignment":"shared","is_active":"true","is_controlled":"false"},
 "ns-2":{"broker_assignment":"primary","is_active":"true","is_controlled":"true"}}
 

Specified by:

getOwnedNamespacesAsync in interface Brokers

Returns:

updateDynamicConfiguration

public void updateDynamicConfiguration(String configName,
                                       String configValue)
                                throws PulsarAdminException

Description copied from interface: Brokers

Update a dynamic configuration value into ZooKeeper.

It updates dynamic configuration value in to Zk that triggers watch on brokers and all brokers can update ServiceConfiguration value locally

Specified by:

updateDynamicConfiguration in interface Brokers

Throws:

PulsarAdminException

updateDynamicConfigurationAsync

public CompletableFuture<Void> updateDynamicConfigurationAsync(String configName,
                                                               String configValue)

Description copied from interface: Brokers

Update a dynamic configuration value into ZooKeeper asynchronously.

It updates dynamic configuration value in to Zk that triggers watch on brokers and all brokers can update ServiceConfiguration value locally

Specified by:

updateDynamicConfigurationAsync in interface Brokers

deleteDynamicConfiguration

public void deleteDynamicConfiguration(String configName)
                                throws PulsarAdminException

Description copied from interface: Brokers

It deletes dynamic configuration value into ZooKeeper.

It will not impact current value in broker but next time when broker restarts, it applies value from configuration file only.

Specified by:

deleteDynamicConfiguration in interface Brokers

Throws:

PulsarAdminException

deleteDynamicConfigurationAsync

public CompletableFuture<Void> deleteDynamicConfigurationAsync(String configName)

Description copied from interface: Brokers

It deletes dynamic configuration value into ZooKeeper asynchronously.

It will not impact current value in broker but next time when broker restarts, it applies value from configuration file only.

Specified by:

deleteDynamicConfigurationAsync in interface Brokers

getAllDynamicConfigurations

public Map<String,String> getAllDynamicConfigurations()
                                               throws PulsarAdminException

Description copied from interface: Brokers

Get values of all overridden dynamic-configs.

Specified by:

getAllDynamicConfigurations in interface Brokers

Returns:

Throws:

PulsarAdminException

getAllDynamicConfigurationsAsync

public CompletableFuture<Map<String,String>> getAllDynamicConfigurationsAsync()

Description copied from interface: Brokers

Get values of all overridden dynamic-configs asynchronously.

Specified by:

getAllDynamicConfigurationsAsync in interface Brokers

Returns:

getDynamicConfigurationNames

public List<String> getDynamicConfigurationNames()
                                          throws PulsarAdminException

Description copied from interface: Brokers

Get list of updatable configuration name.

Specified by:

getDynamicConfigurationNames in interface Brokers

Returns:

Throws:

PulsarAdminException

getDynamicConfigurationNamesAsync

public CompletableFuture<List<String>> getDynamicConfigurationNamesAsync()

Description copied from interface: Brokers

Get list of updatable configuration name asynchronously.

Specified by:

getDynamicConfigurationNamesAsync in interface Brokers

Returns:

getRuntimeConfigurations

public Map<String,String> getRuntimeConfigurations()
                                            throws PulsarAdminException

Description copied from interface: Brokers

Get values of runtime configuration.

Specified by:

getRuntimeConfigurations in interface Brokers

Returns:

Throws:

PulsarAdminException

getRuntimeConfigurationsAsync

public CompletableFuture<Map<String,String>> getRuntimeConfigurationsAsync()

Description copied from interface: Brokers

Get values of runtime configuration asynchronously.

Specified by:

getRuntimeConfigurationsAsync in interface Brokers

Returns:

getInternalConfigurationData

public org.apache.pulsar.common.conf.InternalConfigurationData getInternalConfigurationData()
                                                                                     throws PulsarAdminException

Description copied from interface: Brokers

Get the internal configuration data.

Specified by:

getInternalConfigurationData in interface Brokers

Returns:

internal configuration data.

Throws:

PulsarAdminException

getInternalConfigurationDataAsync

public CompletableFuture<org.apache.pulsar.common.conf.InternalConfigurationData> getInternalConfigurationDataAsync()

Description copied from interface: Brokers

Get the internal configuration data asynchronously.

Specified by:

getInternalConfigurationDataAsync in interface Brokers

Returns:

internal configuration data.

backlogQuotaCheck

public void backlogQuotaCheck()
                       throws PulsarAdminException

Description copied from interface: Brokers

Manually trigger backlogQuotaCheck.

Specified by:

backlogQuotaCheck in interface Brokers

Throws:

PulsarAdminException

backlogQuotaCheckAsync

public CompletableFuture<Void> backlogQuotaCheckAsync()

Description copied from interface: Brokers

Manually trigger backlogQuotaCheck asynchronously.

Specified by:

backlogQuotaCheckAsync in interface Brokers

Returns:

healthcheck

public void healthcheck()
                 throws PulsarAdminException

Description copied from interface: Brokers

Run a healthcheck on the broker.

Specified by:

healthcheck in interface Brokers

Throws:

PulsarAdminException - if the healthcheck fails.

healthcheckAsync

public CompletableFuture<Void> healthcheckAsync()

Description copied from interface: Brokers

Run a healthcheck on the broker asynchronously.

Specified by:

healthcheckAsync in interface Brokers

getVersion

public String getVersion()
                  throws PulsarAdminException

Description copied from interface: Brokers

Get version of broker.

Specified by:

getVersion in interface Brokers

Returns:

version of broker.

Throws:

PulsarAdminException