Package org.apache.pulsar.broker.resources

Class BaseResources<T>

java.lang.Object

org.apache.pulsar.broker.resources.BaseResources<T>

Type Parameters:

T - type of configuration-resources.

Direct Known Subclasses:

BookieResources, BrokerResources, ClusterResources, ClusterResources.ClusterPoliciesResources, ClusterResources.FailureDomainResources, DynamicConfigurationResources, LoadBalanceResources.BrokerTimeAverageDataResources, LoadBalanceResources.BundleDataResources, LoadBalanceResources.QuotaResources, LoadManagerReportResources, LocalPoliciesResources, NamespaceResources, NamespaceResources.IsolationPolicyResources, NamespaceResources.PartitionedTopicResources, ResourceGroupResources, TenantResources

public class BaseResources<T>
extends Object

Base class for all configuration resources to access configurations from metadata-store.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	BASE_CLUSTERS_PATH
protected static final String	BASE_POLICIES_PATH
protected static final String	LOCAL_POLICIES_ROOT

Constructor Summary

Constructors

Constructor	Description
BaseResources(MetadataStore store, com.fasterxml.jackson.core.type.TypeReference<T> typeRef, int operationTimeoutSec)
BaseResources(MetadataStore store, Class<T> clazz, int operationTimeoutSec)

Method Summary

Modifier and Type	Method	Description
protected void	create(String path, T data)
protected CompletableFuture<Void>	createAsync(String path, T data)
protected void	delete(String path)
protected CompletableFuture<Void>	deleteAsync(String path)
protected CompletableFuture<Void>	deleteIfExistsAsync(String path)
protected boolean	exists(String path)
protected CompletableFuture<Boolean>	existsAsync(String path)
protected Optional<T>	get(String path)
protected CompletableFuture<Optional<T>>	getAsync(String path)
protected List<String>	getChildren(String path)
protected CompletableFuture<List<String>>	getChildrenAsync(String path)
protected CompletableFuture<List<String>>	getChildrenRecursiveAsync(String path)
int	getOperationTimeoutSec()
protected static String	joinPath(String... parts)
protected CompletableFuture<Optional<T>>	refreshAndGetAsync(String path)
protected void	set(String path, Function<T,T> modifyFunction)
protected CompletableFuture<Void>	setAsync(String path, Function<T,T> modifyFunction)
protected void	setWithCreate(String path, Function<Optional<T>,T> createFunction)
protected CompletableFuture<Void>	setWithCreateAsync(String path, Function<Optional<T>,T> createFunction)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

BASE_POLICIES_PATH

protected static final String BASE_POLICIES_PATH

See Also:

• Constant Field Values

BASE_CLUSTERS_PATH

protected static final String BASE_CLUSTERS_PATH

See Also:

• Constant Field Values

LOCAL_POLICIES_ROOT

protected static final String LOCAL_POLICIES_ROOT

See Also:

• Constant Field Values

Constructor Details

BaseResources

public BaseResources(MetadataStore store,
 Class<T> clazz,
 int operationTimeoutSec)

BaseResources

public BaseResources(MetadataStore store,
 com.fasterxml.jackson.core.type.TypeReference<T> typeRef,
 int operationTimeoutSec)

Method Details

getChildren

protected List<String> getChildren(String path)
                            throws MetadataStoreException

Throws:

MetadataStoreException

getChildrenAsync

protected CompletableFuture<List<String>> getChildrenAsync(String path)

getChildrenRecursiveAsync

protected CompletableFuture<List<String>> getChildrenRecursiveAsync(String path)

get

protected Optional<T> get(String path)
                   throws MetadataStoreException

Throws:

MetadataStoreException

getAsync

protected CompletableFuture<Optional<T>> getAsync(String path)

refreshAndGetAsync

protected CompletableFuture<Optional<T>> refreshAndGetAsync(String path)

set

protected void set(String path,
 Function<T,T> modifyFunction)
            throws MetadataStoreException

Throws:

MetadataStoreException

setAsync

protected CompletableFuture<Void> setAsync(String path,
 Function<T,T> modifyFunction)

setWithCreate

protected void setWithCreate(String path,
 Function<Optional<T>,T> createFunction)
                      throws MetadataStoreException

Throws:

MetadataStoreException

setWithCreateAsync

protected CompletableFuture<Void> setWithCreateAsync(String path,
 Function<Optional<T>,T> createFunction)

create

protected void create(String path,
 T data)
               throws MetadataStoreException

Throws:

MetadataStoreException

createAsync

protected CompletableFuture<Void> createAsync(String path,
 T data)

delete

protected void delete(String path)
               throws MetadataStoreException

Throws:

MetadataStoreException

deleteAsync

protected CompletableFuture<Void> deleteAsync(String path)

deleteIfExistsAsync

protected CompletableFuture<Void> deleteIfExistsAsync(String path)

exists

protected boolean exists(String path)
                  throws MetadataStoreException

Throws:

MetadataStoreException

existsAsync

protected CompletableFuture<Boolean> existsAsync(String path)

getOperationTimeoutSec

public int getOperationTimeoutSec()

joinPath

protected static String joinPath(String... parts)