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

Constructor Summary

Constructors

Constructor and Description
BrokersImpl(javax.ws.rs.client.WebTarget web, Authentication auth)

Method Summary

Modifier and Type	Method and Description
List<String>	getActiveBrokers(String cluster) Get the list of active brokers in the cluster.
Map<String,String>	getAllDynamicConfigurations() Get values of all overridden dynamic-configs
List<String>	getDynamicConfigurationNames() Get list of updatable configuration name
InternalConfigurationData	getInternalConfigurationData() Get the internal configuration data.
Map<String,NamespaceOwnershipStatus>	getOwnedNamespaces(String cluster, String brokerUrl) Get the map of owned namespaces and their status from a single broker in the cluster
void	updateDynamicConfiguration(String configName, String configValue) It updates dynamic configuration value in to Zk that triggers watch on brokers and all brokers can update ServiceConfiguration value locally

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

asyncDeleteRequest, asyncGetRequest, asyncPostRequest, asyncPutRequest, getApiException, request

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,
                   Authentication auth)

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

getOwnedNamespaces

public Map<String,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

updateDynamicConfiguration

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

Description copied from interface: Brokers

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

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

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

getInternalConfigurationData

public 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