Package org.apache.pulsar.metadata.impl

Class ZKMetadataStore

java.lang.Object

org.apache.pulsar.metadata.impl.AbstractMetadataStore

org.apache.pulsar.metadata.impl.batching.AbstractBatchedMetadataStore

org.apache.pulsar.metadata.impl.ZKMetadataStore

All Implemented Interfaces:

AutoCloseable, Consumer<Notification>, MetadataStoreExtended, MetadataStore, MetadataStoreLifecycle

public class ZKMetadataStore
extends AbstractBatchedMetadataStore
implements MetadataStoreExtended, MetadataStoreLifecycle

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ZK_SCHEME
static final String	ZK_SCHEME_IDENTIFIER

Fields inherited from class org.apache.pulsar.metadata.impl.AbstractMetadataStore

executor, isClosed, metadataStoreName

Fields inherited from interface org.apache.pulsar.metadata.api.MetadataStore

LOGGER

Constructor Summary

Constructors

Constructor	Description
ZKMetadataStore(String metadataURL, MetadataStoreConfig metadataStoreConfig, boolean enableSessionWatcher)
ZKMetadataStore(ZooKeeper zkc)
ZKMetadataStore(ZooKeeper zkc, MetadataStoreConfig config)

Method Summary

Modifier and Type	Method	Description
protected void	batchOperation(List<MetadataOp> ops)
void	close()
CompletableFuture<Boolean>	existsFromStore(String path)
String	getRootPath()
ZooKeeper	getZkClient()
long	getZkSessionId()
CompletableFuture<Void>	initializeCluster()	Initialize the metadata store cluster if needed.
protected void	receivedSessionEvent(SessionEvent event)
CompletableFuture<Void>	sync(String path)	Ensure that the next value read from the local client will be up-to-date with the latest version of the value as it can be seen by all the other clients.

Methods inherited from class org.apache.pulsar.metadata.impl.batching.AbstractBatchedMetadataStore

getChildrenFromStore, getMetadataEventSynchronizer, storeDelete, storeGet, storePut, updateMetadataEventSynchronizer

Methods inherited from class org.apache.pulsar.metadata.impl.AbstractMetadataStore

accept, alreadyClosedFailedFuture, delete, deleteRecursive, execute, execute, exists, get, getChildren, getMetadataCache, getMetadataCache, getMetadataCache, handleMetadataEvent, invalidateAll, invalidateCaches, isClosed, notifyParentChildrenChanged, parent, put, put, putInternal, receivedNotification, registerListener, registerSessionListener, registerSyncListener, shouldIgnoreEvent

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Consumer

andThen

Methods inherited from interface org.apache.pulsar.metadata.api.MetadataStore

delete, deleteIfExists, deleteRecursive, exists, get, getChildren, getDefaultMetadataCacheConfig, getMetadataCache, getMetadataCache, getMetadataCache, getMetadataCache, getMetadataCache, getMetadataCache, put, registerListener

Methods inherited from interface org.apache.pulsar.metadata.api.extended.MetadataStoreExtended

getMetadataEventSynchronizer, handleMetadataEvent, put, registerSessionListener, updateMetadataEventSynchronizer

Field Details

ZK_SCHEME

public static final String ZK_SCHEME

See Also:

• Constant Field Values

ZK_SCHEME_IDENTIFIER

public static final String ZK_SCHEME_IDENTIFIER

See Also:

• Constant Field Values

Constructor Details

ZKMetadataStore

public ZKMetadataStore(String metadataURL,
 MetadataStoreConfig metadataStoreConfig,
 boolean enableSessionWatcher)
                throws MetadataStoreException

Throws:

MetadataStoreException

ZKMetadataStore

public ZKMetadataStore(ZooKeeper zkc)

ZKMetadataStore

public ZKMetadataStore(ZooKeeper zkc,
 MetadataStoreConfig config)

Method Details

receivedSessionEvent

protected void receivedSessionEvent(SessionEvent event)

Overrides:

receivedSessionEvent in class AbstractMetadataStore

sync

public CompletableFuture<Void> sync(String path)

Description copied from interface: MetadataStore

Ensure that the next value read from the local client will be up-to-date with the latest version of the value as it can be seen by all the other clients.

Specified by:

sync in interface MetadataStore

Returns:

a handle to the operation

batchOperation

protected void batchOperation(List<MetadataOp> ops)

Specified by:

batchOperation in class AbstractBatchedMetadataStore

existsFromStore

public CompletableFuture<Boolean> existsFromStore(String path)

Specified by:

existsFromStore in class AbstractMetadataStore

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Overrides:

close in class AbstractBatchedMetadataStore

Throws:

Exception

getZkSessionId

public long getZkSessionId()

getZkClient

public ZooKeeper getZkClient()

initializeCluster

public CompletableFuture<Void> initializeCluster()

Description copied from interface: MetadataStoreLifecycle

Initialize the metadata store cluster if needed. For example, if the backend metadata store is a zookeeper cluster and the pulsar cluster is configured to access the zookeeper cluster in the chroot mode, then this method could be used to initialize the root node during pulsar cluster metadata setup.

Specified by:

initializeCluster in interface MetadataStoreLifecycle

Returns:

a future to track the async request.

getRootPath

public String getRootPath()