org.apache.pulsar.client.admin.internal

Class ClustersImpl

java.lang.Object

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

org.apache.pulsar.client.admin.internal.ClustersImpl

All Implemented Interfaces:

Clusters

public class ClustersImpl
extends BaseResource
implements Clusters

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	createCluster(String cluster, ClusterData clusterData) Create a new cluster.
void	createFailureDomain(String cluster, String domainName, FailureDomain domain) Create a domain into cluster
void	createNamespaceIsolationPolicy(String cluster, String policyName, NamespaceIsolationData namespaceIsolationData) Create a namespace isolation policy for a cluster
void	deleteCluster(String cluster) Delete an existing cluster
void	deleteFailureDomain(String cluster, String domainName) Delete a domain in cluster
void	deleteNamespaceIsolationPolicy(String cluster, String policyName) Delete a namespace isolation policy for a cluster
List<BrokerNamespaceIsolationData>	getBrokersWithNamespaceIsolationPolicy(String cluster) Returns list of active brokers with namespace-isolation policies attached to it.
BrokerNamespaceIsolationData	getBrokerWithNamespaceIsolationPolicy(String cluster, String broker) Returns active broker with namespace-isolation policies attached to it.
ClusterData	getCluster(String cluster) Get the configuration data for the specified cluster.
List<String>	getClusters() Get the list of clusters.
FailureDomain	getFailureDomain(String cluster, String domainName) Get the domain registered into a cluster
Map<String,FailureDomain>	getFailureDomains(String cluster) Get all registered domains in cluster
Map<String,NamespaceIsolationData>	getNamespaceIsolationPolicies(String cluster) Get the namespace isolation policies of a cluster
NamespaceIsolationData	getNamespaceIsolationPolicy(String cluster, String policyName) Get a single namespace isolation policy for a cluster
Set<String>	getPeerClusterNames(String cluster) Get peer-cluster names
void	updateCluster(String cluster, ClusterData clusterData) Update the configuration for a cluster.
void	updateFailureDomain(String cluster, String domainName, FailureDomain domain) Update a domain into cluster
void	updateNamespaceIsolationPolicy(String cluster, String policyName, NamespaceIsolationData namespaceIsolationData) Update a namespace isolation policy for a cluster
void	updatePeerClusterNames(String cluster, LinkedHashSet<String> peerClusterNames) Update peer cluster names.

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

ClustersImpl

public ClustersImpl(javax.ws.rs.client.WebTarget web,
                    Authentication auth)

Method Detail

getClusters

public List<String> getClusters()
                         throws PulsarAdminException

Description copied from interface: Clusters

Get the list of clusters.

Get the list of all the Pulsar clusters.

Response Example:

 ["c1", "c2", "c3"]
 

Specified by:

getClusters in interface Clusters

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException - Unexpected error

getCluster

public ClusterData getCluster(String cluster)
                       throws PulsarAdminException

Description copied from interface: Clusters

Get the configuration data for the specified cluster.

Response Example:

 { serviceUrl : "http://my-broker.example.com:8080/" }
 

Specified by:

getCluster in interface Clusters

Parameters:

cluster - Cluster name

Returns:

the cluster configuration

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission to get the configuration of the cluster

PulsarAdminException.NotFoundException - Cluster doesn't exist

PulsarAdminException - Unexpected error

createCluster

public void createCluster(String cluster,
                          ClusterData clusterData)
                   throws PulsarAdminException

Description copied from interface: Clusters

Create a new cluster.

Provisions a new cluster. This operation requires Pulsar super-user privileges.

The name cannot contain '/' characters.

Specified by:

createCluster in interface Clusters

Parameters:

cluster - Cluster name

clusterData - the cluster configuration object

Throws:

PulsarAdminException.ConflictException - Cluster already exists

PulsarAdminException - Unexpected error

updateCluster

public void updateCluster(String cluster,
                          ClusterData clusterData)
                   throws PulsarAdminException

Description copied from interface: Clusters

Update the configuration for a cluster.

This operation requires Pulsar super-user privileges.

Specified by:

updateCluster in interface Clusters

Parameters:

cluster - Cluster name

clusterData - the cluster configuration object

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission to create the cluster

PulsarAdminException.NotFoundException - Cluster doesn't exist

PulsarAdminException - Unexpected error

updatePeerClusterNames

public void updatePeerClusterNames(String cluster,
                                   LinkedHashSet<String> peerClusterNames)
                            throws PulsarAdminException

Description copied from interface: Clusters

Update peer cluster names.

This operation requires Pulsar super-user privileges.

Specified by:

updatePeerClusterNames in interface Clusters

Parameters:

cluster - Cluster name

peerClusterNames - list of peer cluster names

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission to create the cluster

PulsarAdminException.NotFoundException - Cluster doesn't exist

PulsarAdminException - Unexpected error

getPeerClusterNames

public Set<String> getPeerClusterNames(String cluster)
                                throws PulsarAdminException

Description copied from interface: Clusters

Get peer-cluster names

Specified by:

getPeerClusterNames in interface Clusters

Parameters:

cluster - Cluster name

Returns:

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission to create the cluster

PulsarAdminException.NotFoundException - Domain doesn't exist

PulsarAdminException.PreconditionFailedException - Cluster doesn't exist

PulsarAdminException - Unexpected error

deleteCluster

public void deleteCluster(String cluster)
                   throws PulsarAdminException

Description copied from interface: Clusters

Delete an existing cluster

Delete a cluster

Specified by:

deleteCluster in interface Clusters

Parameters:

cluster - Cluster name

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission

PulsarAdminException.NotFoundException - Cluster does not exist

PulsarAdminException.PreconditionFailedException - Cluster is not empty

PulsarAdminException - Unexpected error

getNamespaceIsolationPolicies

public Map<String,NamespaceIsolationData> getNamespaceIsolationPolicies(String cluster)
                                                                 throws PulsarAdminException

Description copied from interface: Clusters

Get the namespace isolation policies of a cluster

Specified by:

getNamespaceIsolationPolicies in interface Clusters

Parameters:

cluster - Cluster name

Returns:

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission to create the cluster

PulsarAdminException.NotFoundException - Policies don't exist

PulsarAdminException.PreconditionFailedException - Cluster doesn't exist

PulsarAdminException - Unexpected error

getBrokersWithNamespaceIsolationPolicy

public List<BrokerNamespaceIsolationData> getBrokersWithNamespaceIsolationPolicy(String cluster)
                                                                          throws PulsarAdminException

Description copied from interface: Clusters

Returns list of active brokers with namespace-isolation policies attached to it.

Specified by:

getBrokersWithNamespaceIsolationPolicy in interface Clusters

Returns:

Throws:

PulsarAdminException

getBrokerWithNamespaceIsolationPolicy

public BrokerNamespaceIsolationData getBrokerWithNamespaceIsolationPolicy(String cluster,
                                                                          String broker)
                                                                   throws PulsarAdminException

Description copied from interface: Clusters

Returns active broker with namespace-isolation policies attached to it.

Specified by:

getBrokerWithNamespaceIsolationPolicy in interface Clusters

Returns:

Throws:

PulsarAdminException

createNamespaceIsolationPolicy

public void createNamespaceIsolationPolicy(String cluster,
                                           String policyName,
                                           NamespaceIsolationData namespaceIsolationData)
                                    throws PulsarAdminException

Description copied from interface: Clusters

Create a namespace isolation policy for a cluster

Specified by:

createNamespaceIsolationPolicy in interface Clusters

Parameters:

cluster - Cluster name

policyName - Policy name

namespaceIsolationData - Namespace isolation policy configuration

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission to create the cluster

PulsarAdminException.NotFoundException - Cluster doesn't exist

PulsarAdminException.PreconditionFailedException - Cluster doesn't exist

PulsarAdminException - Unexpected error

updateNamespaceIsolationPolicy

public void updateNamespaceIsolationPolicy(String cluster,
                                           String policyName,
                                           NamespaceIsolationData namespaceIsolationData)
                                    throws PulsarAdminException

Description copied from interface: Clusters

Update a namespace isolation policy for a cluster

Specified by:

updateNamespaceIsolationPolicy in interface Clusters

Parameters:

cluster - Cluster name

policyName - Policy name

namespaceIsolationData - Namespace isolation policy configuration

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission to create the cluster

PulsarAdminException.NotFoundException - Cluster doesn't exist

PulsarAdminException.PreconditionFailedException - Cluster doesn't exist

PulsarAdminException - Unexpected error

deleteNamespaceIsolationPolicy

public void deleteNamespaceIsolationPolicy(String cluster,
                                           String policyName)
                                    throws PulsarAdminException

Description copied from interface: Clusters

Delete a namespace isolation policy for a cluster

Specified by:

deleteNamespaceIsolationPolicy in interface Clusters

Parameters:

cluster - Cluster name

policyName - Policy name

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission to create the cluster

PulsarAdminException.NotFoundException - Cluster doesn't exist

PulsarAdminException.PreconditionFailedException - Cluster doesn't exist

PulsarAdminException - Unexpected error

getNamespaceIsolationPolicy

public NamespaceIsolationData getNamespaceIsolationPolicy(String cluster,
                                                          String policyName)
                                                   throws PulsarAdminException

Description copied from interface: Clusters

Get a single namespace isolation policy for a cluster

Specified by:

getNamespaceIsolationPolicy in interface Clusters

Parameters:

cluster - Cluster name

policyName - Policy name

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission to create the cluster

PulsarAdminException.NotFoundException - Policy doesn't exist

PulsarAdminException.PreconditionFailedException - Cluster doesn't exist

PulsarAdminException - Unexpected error

createFailureDomain

public void createFailureDomain(String cluster,
                                String domainName,
                                FailureDomain domain)
                         throws PulsarAdminException

Description copied from interface: Clusters

Create a domain into cluster

Specified by:

createFailureDomain in interface Clusters

Parameters:

cluster - Cluster name

domainName - domain name

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission to create the cluster

PulsarAdminException.ConflictException - Broker already exist into other domain

PulsarAdminException.NotFoundException - Cluster doesn't exist

PulsarAdminException.PreconditionFailedException - Cluster doesn't exist

PulsarAdminException - Unexpected error

updateFailureDomain

public void updateFailureDomain(String cluster,
                                String domainName,
                                FailureDomain domain)
                         throws PulsarAdminException

Description copied from interface: Clusters

Update a domain into cluster

Specified by:

updateFailureDomain in interface Clusters

Parameters:

cluster - Cluster name

domainName - domain name

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission to create the cluster

PulsarAdminException.ConflictException - Broker already exist into other domain

PulsarAdminException.NotFoundException - Cluster doesn't exist

PulsarAdminException.PreconditionFailedException - Cluster doesn't exist

PulsarAdminException - Unexpected error

deleteFailureDomain

public void deleteFailureDomain(String cluster,
                                String domainName)
                         throws PulsarAdminException

Description copied from interface: Clusters

Delete a domain in cluster

Specified by:

deleteFailureDomain in interface Clusters

Parameters:

cluster - Cluster name

domainName - Domain name

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission to create the cluster

PulsarAdminException.NotFoundException - Cluster doesn't exist

PulsarAdminException.PreconditionFailedException - Cluster doesn't exist

PulsarAdminException - Unexpected error

getFailureDomains

public Map<String,FailureDomain> getFailureDomains(String cluster)
                                            throws PulsarAdminException

Description copied from interface: Clusters

Get all registered domains in cluster

Specified by:

getFailureDomains in interface Clusters

Parameters:

cluster - Cluster name

Returns:

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission to create the cluster

PulsarAdminException.NotFoundException - Cluster don't exist

PulsarAdminException - Unexpected error

getFailureDomain

public FailureDomain getFailureDomain(String cluster,
                                      String domainName)
                               throws PulsarAdminException

Description copied from interface: Clusters

Get the domain registered into a cluster

Specified by:

getFailureDomain in interface Clusters

Parameters:

cluster - Cluster name

Returns:

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission to create the cluster

PulsarAdminException.NotFoundException - Domain doesn't exist

PulsarAdminException.PreconditionFailedException - Cluster doesn't exist

PulsarAdminException - Unexpected error