org.apache.pulsar.client.admin.internal

Class TenantsImpl

java.lang.Object

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

org.apache.pulsar.client.admin.internal.TenantsImpl

All Implemented Interfaces:

Properties, Tenants

public class TenantsImpl
extends BaseResource
implements Tenants, Properties

Field Summary

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

auth, readTimeoutMs

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	createProperty(String tenant, org.apache.pulsar.common.policies.data.TenantInfo config) Create a new property.
void	createTenant(String tenant, org.apache.pulsar.common.policies.data.TenantInfo config) Create a new tenant.
CompletableFuture<Void>	createTenantAsync(String tenant, org.apache.pulsar.common.policies.data.TenantInfo config) Create a new tenant asynchronously.
void	deleteProperty(String tenant) Delete an existing property.
void	deleteTenant(String tenant) Delete an existing tenant.
CompletableFuture<Void>	deleteTenantAsync(String tenant) Delete an existing tenant asynchronously.
List<String>	getProperties() Get the list of properties.
org.apache.pulsar.common.policies.data.TenantInfo	getPropertyAdmin(String tenant) Get the config of the property.
org.apache.pulsar.common.policies.data.TenantInfo	getTenantInfo(String tenant) Get the config of the tenant.
CompletableFuture<org.apache.pulsar.common.policies.data.TenantInfo>	getTenantInfoAsync(String tenant) Get the config of the tenant asynchronously.
List<String>	getTenants() Get the list of tenants.
CompletableFuture<List<String>>	getTenantsAsync() Get the list of tenants asynchronously.
javax.ws.rs.client.WebTarget	getWebTarget()
void	updateProperty(String tenant, org.apache.pulsar.common.policies.data.TenantInfo config) Update the admins for a property.
void	updateTenant(String tenant, org.apache.pulsar.common.policies.data.TenantInfo config) Update the admins for a tenant.
CompletableFuture<Void>	updateTenantAsync(String tenant, org.apache.pulsar.common.policies.data.TenantInfo config) Update the admins for a tenant 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

TenantsImpl

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

Method Detail

getTenants

public List<String> getTenants()
                        throws PulsarAdminException

Description copied from interface: Tenants

Get the list of tenants.

Response Example:

 ["my-tenant", "other-tenant", "third-tenant"]
 

Specified by:

getTenants in interface Tenants

Returns:

the list of Pulsar tenants

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException - Unexpected error

getTenantsAsync

public CompletableFuture<List<String>> getTenantsAsync()

Description copied from interface: Tenants

Get the list of tenants asynchronously.

Response Example:

 ["my-tenant", "other-tenant", "third-tenant"]
 

Specified by:

getTenantsAsync in interface Tenants

Returns:

the list of Pulsar tenants

getTenantInfo

public org.apache.pulsar.common.policies.data.TenantInfo getTenantInfo(String tenant)
                                                                throws PulsarAdminException

Description copied from interface: Tenants

Get the config of the tenant.

Get the admin configuration for a given tenant.

Specified by:

getTenantInfo in interface Tenants

Parameters:

tenant - Tenant name

Returns:

the tenant configuration

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException.NotFoundException - Tenant does not exist

PulsarAdminException - Unexpected error

getTenantInfoAsync

public CompletableFuture<org.apache.pulsar.common.policies.data.TenantInfo> getTenantInfoAsync(String tenant)

Description copied from interface: Tenants

Get the config of the tenant asynchronously.

Get the admin configuration for a given tenant.

Specified by:

getTenantInfoAsync in interface Tenants

Parameters:

tenant - Tenant name

Returns:

the tenant configuration

createTenant

public void createTenant(String tenant,
                         org.apache.pulsar.common.policies.data.TenantInfo config)
                  throws PulsarAdminException

Description copied from interface: Tenants

Create a new tenant.

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

Specified by:

createTenant in interface Tenants

Parameters:

tenant - Tenant name

config - Config data

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException.ConflictException - Tenant already exists

PulsarAdminException.PreconditionFailedException - Tenant name is not valid

PulsarAdminException - Unexpected error

createTenantAsync

public CompletableFuture<Void> createTenantAsync(String tenant,
                                                 org.apache.pulsar.common.policies.data.TenantInfo config)

Description copied from interface: Tenants

Create a new tenant asynchronously.

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

Specified by:

createTenantAsync in interface Tenants

Parameters:

tenant - Tenant name

config - Config data

updateTenant

public void updateTenant(String tenant,
                         org.apache.pulsar.common.policies.data.TenantInfo config)
                  throws PulsarAdminException

Description copied from interface: Tenants

Update the admins for a tenant.

This operation requires Pulsar super-user privileges.

Specified by:

updateTenant in interface Tenants

Parameters:

tenant - Tenant name

config - Config data

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException.NotFoundException - Tenant does not exist

PulsarAdminException - Unexpected error

updateTenantAsync

public CompletableFuture<Void> updateTenantAsync(String tenant,
                                                 org.apache.pulsar.common.policies.data.TenantInfo config)

Description copied from interface: Tenants

Update the admins for a tenant asynchronously.

This operation requires Pulsar super-user privileges.

Specified by:

updateTenantAsync in interface Tenants

Parameters:

tenant - Tenant name

config - Config data

deleteTenant

public void deleteTenant(String tenant)
                  throws PulsarAdminException

Description copied from interface: Tenants

Delete an existing tenant.

Delete a tenant and all namespaces and topics under it.

Specified by:

deleteTenant in interface Tenants

Parameters:

tenant - Tenant name

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException.NotFoundException - The tenant does not exist

PulsarAdminException.ConflictException - The tenant still has active namespaces

PulsarAdminException - Unexpected error

deleteTenantAsync

public CompletableFuture<Void> deleteTenantAsync(String tenant)

Description copied from interface: Tenants

Delete an existing tenant asynchronously.

Delete a tenant and all namespaces and topics under it.

Specified by:

deleteTenantAsync in interface Tenants

Parameters:

tenant - Tenant name

createProperty

public void createProperty(String tenant,
                           org.apache.pulsar.common.policies.data.TenantInfo config)
                    throws PulsarAdminException

Description copied from interface: Properties

Create a new property.

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

Specified by:

createProperty in interface Properties

Parameters:

tenant - Property name

config - Config data

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException.ConflictException - Property already exists

PulsarAdminException.PreconditionFailedException - Property name is not valid

PulsarAdminException - Unexpected error

updateProperty

public void updateProperty(String tenant,
                           org.apache.pulsar.common.policies.data.TenantInfo config)
                    throws PulsarAdminException

Description copied from interface: Properties

Update the admins for a property.

This operation requires Pulsar super-user privileges.

Specified by:

updateProperty in interface Properties

Parameters:

tenant - Property name

config - Config data

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException.NotFoundException - Property does not exist

PulsarAdminException - Unexpected error

deleteProperty

public void deleteProperty(String tenant)
                    throws PulsarAdminException

Description copied from interface: Properties

Delete an existing property.

Delete a property and all namespaces and topics under it.

Specified by:

deleteProperty in interface Properties

Parameters:

tenant - Property name

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException.NotFoundException - The property does not exist

PulsarAdminException.ConflictException - The property still has active namespaces

PulsarAdminException - Unexpected error

getProperties

public List<String> getProperties()
                           throws PulsarAdminException

Description copied from interface: Properties

Get the list of properties.

Get the list of all the properties.

Response Example:

 ["my-property", "other-property", "third-property"]
 

Specified by:

getProperties in interface Properties

Returns:

the list of Pulsar tenants properties

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException - Unexpected error

getPropertyAdmin

public org.apache.pulsar.common.policies.data.TenantInfo getPropertyAdmin(String tenant)
                                                                   throws PulsarAdminException

Description copied from interface: Properties

Get the config of the property.

Get the admin configuration for a given property.

Specified by:

getPropertyAdmin in interface Properties

Parameters:

tenant - Property name

Returns:

the property configuration

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException.NotFoundException - Property does not exist

PulsarAdminException - Unexpected error

getWebTarget

public javax.ws.rs.client.WebTarget getWebTarget()