org.apache.pulsar.client.admin.Properties 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 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 properties management.
*
* @deprecated see {@link Tenants} from {@link PulsarAdmin#tenants()}
*/
@Deprecated
public interface Properties {
/**
* Get the list of properties.
*
* Get the list of all the properties.
*
* Response Example:
*
*
* ["my-property", "other-property", "third-property"]
*
*
* @return the list of Pulsar tenants properties
* @throws NotAuthorizedException
* Don't have admin permission
* @throws PulsarAdminException
* Unexpected error
*/
List getProperties() throws PulsarAdminException;
/**
* Get the config of the property.
*
* Get the admin configuration for a given property.
*
* @param property
* Property name
* @return the property configuration
*
* @throws NotAuthorizedException
* Don't have admin permission
* @throws NotFoundException
* Property does not exist
* @throws PulsarAdminException
* Unexpected error
*/
TenantInfo getPropertyAdmin(String property) throws PulsarAdminException;
/**
* Create a new property.
*
* Provisions a new property. This operation requires Pulsar super-user privileges.
*
* @param property
* Property name
* @param config
* Config data
*
* @throws NotAuthorizedException
* Don't have admin permission
* @throws ConflictException
* Property already exists
* @throws PreconditionFailedException
* Property name is not valid
* @throws PulsarAdminException
* Unexpected error
*/
void createProperty(String property, TenantInfo config) throws PulsarAdminException;
/**
* Update the admins for a property.
*
* This operation requires Pulsar super-user privileges.
*
* @param property
* Property name
* @param config
* Config data
*
* @throws NotAuthorizedException
* Don't have admin permission
* @throws NotFoundException
* Property does not exist
* @throws PulsarAdminException
* Unexpected error
*/
void updateProperty(String property, TenantInfo config) throws PulsarAdminException;
/**
* Delete an existing property.
*
* Delete a property and all namespaces and topics under it.
*
* @param property
* Property name
*
* @throws NotAuthorizedException
* Don't have admin permission
* @throws NotFoundException
* The property does not exist
* @throws ConflictException
* The property still has active namespaces
* @throws PulsarAdminException
* Unexpected error
*/
void deleteProperty(String property) throws PulsarAdminException;
}