org.apache.pulsar.metadata.impl.zookeeper

Class ZKMetadataStore

java.lang.Object

org.apache.pulsar.metadata.impl.zookeeper.ZKMetadataStore

All Implemented Interfaces:

AutoCloseable, MetadataStore

public class ZKMetadataStore
extends Object
implements MetadataStore

Constructor Summary

Constructors

Constructor and Description
ZKMetadataStore(String metadataURL, MetadataStoreConfig metadataStoreConfig)
ZKMetadataStore(org.apache.zookeeper.ZooKeeper zkc)

Method Summary

Modifier and Type	Method and Description
void	close()
CompletableFuture<Void>	delete(String path, Optional<Long> optExpectedVersion)
CompletableFuture<Boolean>	exists(String path) Read whether a specific path exists.
CompletableFuture<Optional<GetResult>>	get(String path) Read the value of one key, identified by the path The async call will return a future that yields a GetResult that will contain the value and the associated Stat object.
CompletableFuture<List<String>>	getChildren(String path) Return all the nodes (lexicographically sorted) that are children to the specific path.
CompletableFuture<Stat>	put(String path, byte[] value, Optional<Long> optExpectedVersion) Put a new value for a given key.

Methods inherited from class java.lang.Object

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

Constructor Detail

ZKMetadataStore

public ZKMetadataStore(String metadataURL,
                       MetadataStoreConfig metadataStoreConfig)
                throws IOException

Throws:

IOException

ZKMetadataStore

public ZKMetadataStore(org.apache.zookeeper.ZooKeeper zkc)

Method Detail

get

public CompletableFuture<Optional<GetResult>> get(String path)

Description copied from interface: MetadataStore

Read the value of one key, identified by the path The async call will return a future that yields a GetResult that will contain the value and the associated Stat object. If the value is not found, the future will yield an empty Optional.

Specified by:

get in interface MetadataStore

Parameters:

path - the path of the key to get from the store

Returns:

a future to track the async request

getChildren

public CompletableFuture<List<String>> getChildren(String path)

Description copied from interface: MetadataStore

Return all the nodes (lexicographically sorted) that are children to the specific path. If the path itself does not exist, it will return an empty list.

Specified by:

getChildren in interface MetadataStore

Parameters:

path - webSocketProxyEnabled

Returns:

a future to track the async request

exists

public CompletableFuture<Boolean> exists(String path)

Description copied from interface: MetadataStore

Read whether a specific path exists. Note: In case of keys with multiple levels (eg: '/a/b/c'), checking the existence of a parent (eg. '/a') might not necessarily return true, unless the key had been explicitly created.

Specified by:

exists in interface MetadataStore

Parameters:

path - the path of the key to check on the store

Returns:

a future to track the async request

put

public CompletableFuture<Stat> put(String path,
                                   byte[] value,
                                   Optional<Long> optExpectedVersion)

Description copied from interface: MetadataStore

Put a new value for a given key. The caller can specify an expected version to be atomically checked against the current version of the stored data. The future will return the Stat object associated with the newly inserted value.

Specified by:

put in interface MetadataStore

Parameters:

path - the path of the key to delete from the store

value - the value to

optExpectedVersion - if present, the version will have to match with the currently stored value for the operation to succeed. Use -1 to enforce a non-existing value.

Returns:

a future to track the async request

delete

public CompletableFuture<Void> delete(String path,
                                      Optional<Long> optExpectedVersion)

Specified by:

delete in interface MetadataStore

Parameters:

path - the path of the key to delete from the store

optExpectedVersion - if present, the version will have to match with the currently stored value for the operation to succeed

Returns:

a future to track the async request

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception