org.apache.pulsar.client.admin.Tenants Maven / Gradle / Ivy
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.pulsar.client.admin;
import java.util.List;
import java.util.concurrent.CompletableFuture;
import org.apache.pulsar.client.admin.PulsarAdminException.ConflictException;
import org.apache.pulsar.client.admin.PulsarAdminException.NotAuthorizedException;
import org.apache.pulsar.client.admin.PulsarAdminException.NotFoundException;
import org.apache.pulsar.client.admin.PulsarAdminException.PreconditionFailedException;
import org.apache.pulsar.common.policies.data.TenantInfo;
/**
* Admin interface for tenants management.
*/
public interface Tenants {
/**
* Get the list of tenants.
*
* Response Example:
*
*
* ["my-tenant", "other-tenant", "third-tenant"]
*
*
* @return the list of Pulsar tenants
* @throws NotAuthorizedException
* Don't have admin permission
* @throws PulsarAdminException
* Unexpected error
*/
List getTenants() throws PulsarAdminException;
/**
* Get the list of tenants asynchronously.
*
* Response Example:
*
*
* ["my-tenant", "other-tenant", "third-tenant"]
*
*
* @return the list of Pulsar tenants
*/
CompletableFuture> getTenantsAsync();
/**
* Get the config of the tenant.
*
* Get the admin configuration for a given tenant.
*
* @param tenant
* Tenant name
* @return the tenant configuration
*
* @throws NotAuthorizedException
* Don't have admin permission
* @throws NotFoundException
* Tenant does not exist
* @throws PulsarAdminException
* Unexpected error
*/
TenantInfo getTenantInfo(String tenant) throws PulsarAdminException;
/**
* Get the config of the tenant asynchronously.
*
* Get the admin configuration for a given tenant.
*
* @param tenant
* Tenant name
* @return the tenant configuration
*/
CompletableFuture getTenantInfoAsync(String tenant);
/**
* Create a new tenant.
*
* Provisions a new tenant. This operation requires Pulsar super-user privileges.
*
* @param tenant
* Tenant name
* @param config
* Config data
*
* @throws NotAuthorizedException
* Don't have admin permission
* @throws ConflictException
* Tenant already exists
* @throws PreconditionFailedException
* Tenant name is not valid
* @throws PulsarAdminException
* Unexpected error
*/
void createTenant(String tenant, TenantInfo config) throws PulsarAdminException;
/**
* Create a new tenant asynchronously.
*
* Provisions a new tenant. This operation requires Pulsar super-user privileges.
*
* @param tenant
* Tenant name
* @param config
* Config data
*/
CompletableFuture createTenantAsync(String tenant, TenantInfo config);
/**
* Update the admins for a tenant.
*
* This operation requires Pulsar super-user privileges.
*
* @param tenant
* Tenant name
* @param config
* Config data
*
* @throws NotAuthorizedException
* Don't have admin permission
* @throws NotFoundException
* Tenant does not exist
* @throws PulsarAdminException
* Unexpected error
*/
void updateTenant(String tenant, TenantInfo config) throws PulsarAdminException;
/**
* Update the admins for a tenant asynchronously.
*
* This operation requires Pulsar super-user privileges.
*
* @param tenant
* Tenant name
* @param config
* Config data
*/
CompletableFuture updateTenantAsync(String tenant, TenantInfo config);
/**
* Delete an existing tenant.
*
* Delete a tenant and all namespaces and topics under it.
*
* @param tenant
* Tenant name
*
* @throws NotAuthorizedException
* Don't have admin permission
* @throws NotFoundException
* The tenant does not exist
* @throws ConflictException
* The tenant still has active namespaces
* @throws PulsarAdminException
* Unexpected error
*/
void deleteTenant(String tenant) throws PulsarAdminException;
/**
* Delete an existing tenant.
*
* Force flag delete a tenant forcefully and all namespaces and topics under it.
*
* @param tenant
* Tenant name
* @param force
* Delete tenant forcefully
*
* @throws NotAuthorizedException
* Don't have admin permission
* @throws NotFoundException
* The tenant does not exist
* @throws ConflictException
* The tenant still has active namespaces
* @throws PulsarAdminException
* Unexpected error
*/
void deleteTenant(String tenant, boolean force) throws PulsarAdminException;
/**
* Delete an existing tenant asynchronously.
*
* Delete a tenant and all namespaces and topics under it.
*
* @param tenant
* Tenant name
*/
CompletableFuture deleteTenantAsync(String tenant);
/**
* Delete an existing tenant asynchronously.
*
* Force flag delete a tenant forcefully and all namespaces and topics under it.
*
* @param tenant
* Tenant name
* @param force
* Delete tenant forcefully
*/
CompletableFuture deleteTenantAsync(String tenant, boolean force);
}