org.apache.pulsar.zookeeper

Class ZooKeeperCache

java.lang.Object

org.apache.pulsar.zookeeper.ZooKeeperCache

All Implemented Interfaces:

Watcher

Direct Known Subclasses:

GlobalZooKeeperCache, LocalZooKeeperCache

public abstract class ZooKeeperCache
extends Object
implements Watcher

Per ZK client ZooKeeper cache supporting ZNode data and children list caches. A cache entry is identified, accessed and invalidated by the ZNode path. For the data cache, ZNode data parsing is done at request time with the given ZooKeeperCache.Deserializer argument.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ZooKeeperCache.CacheUpdater<T>
static interface	ZooKeeperCache.Deserializer<T>

Nested classes/interfaces inherited from interface org.apache.zookeeper.Watcher

Watcher.Event, Watcher.WatcherType

Field Summary

Fields

Modifier and Type	Field and Description
protected com.github.benmanes.caffeine.cache.AsyncLoadingCache<String,Set<String>>	childrenCache
protected com.github.benmanes.caffeine.cache.AsyncLoadingCache<String,org.apache.commons.lang3.tuple.Pair<Map.Entry<Object,org.apache.zookeeper.data.Stat>,Long>>	dataCache
protected com.github.benmanes.caffeine.cache.AsyncLoadingCache<String,Boolean>	existsCache
static String	ZK_CACHE_INSTANCE
protected AtomicReference<ZooKeeper>	zkSession

Constructor Summary

Constructors

Constructor and Description
ZooKeeperCache(String cacheName, ZooKeeper zkSession, int zkOperationTimeoutSeconds)
ZooKeeperCache(String cacheName, ZooKeeper zkSession, int zkOperationTimeoutSeconds, org.apache.bookkeeper.common.util.OrderedExecutor executor)
ZooKeeperCache(String cacheName, ZooKeeper zkSession, int zkOperationTimeoutSeconds, org.apache.bookkeeper.common.util.OrderedExecutor executor, int cacheExpirySeconds)

Method Summary

Modifier and Type	Method and Description
void	asyncInvalidate(String path)
boolean	checkRegNodeAndWaitExpired(String regPath)
boolean	exists(String path) Returns if the node at the given path exists in the cache
CompletableFuture<Boolean>	existsAsync(String path, Watcher watcher)
Set<String>	getChildren(String path) Simple ZooKeeperChildrenCache use this method to invalidate cache entry on watch event w/o automatic re-loading
CompletableFuture<Set<String>>	getChildrenAsync(String path, Watcher watcher) ZooKeeperChildrenCache implementing automatic re-loading on update use this method by passing in a different Watcher object to reload cache entry
Set<String>	getChildrenIfPresent(String path)
<T> Optional<Map.Entry<T,org.apache.zookeeper.data.Stat>>	getData(String path, Watcher watcher, ZooKeeperCache.Deserializer<T> deserializer) Cache that implements automatic reloading on update will pass a different Watcher object to reload cache entry automatically
<T> Optional<T>	getData(String path, ZooKeeperCache.Deserializer<T> deserializer) Simple ZooKeeperCache use this method to invalidate the cache entry on watch event w/o automatic reloading the cache
<T> CompletableFuture<Optional<Map.Entry<T,org.apache.zookeeper.data.Stat>>>	getDataAsync(String path, Watcher watcher, ZooKeeperCache.Deserializer<T> deserializer)
<T> CompletableFuture<Optional<T>>	getDataAsync(String path, ZooKeeperCache.Deserializer<T> deserializer)
<T> T	getDataIfPresent(String path)
<T> Optional<Map.Entry<T,org.apache.zookeeper.data.Stat>>	getEntry(String path, ZooKeeperCache.Deserializer<T> deserializer)
<T> CompletableFuture<Optional<Map.Entry<T,org.apache.zookeeper.data.Stat>>>	getEntryAsync(String path, ZooKeeperCache.Deserializer<T> deserializer)
int	getZkOperationTimeoutSeconds()
ZooKeeper	getZooKeeper()
void	invalidate(String path)
void	invalidateAll()
void	invalidateAllChildren()
void	invalidateAllData()
void	invalidateChildren(String path)
void	invalidateData(String path)
void	invalidateRoot(String root)
void	process(WatchedEvent event)
<T> void	process(WatchedEvent event, ZooKeeperCache.CacheUpdater<T> updater)
void	stop()

Methods inherited from class java.lang.Object

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

Field Detail

ZK_CACHE_INSTANCE

public static final String ZK_CACHE_INSTANCE

See Also:

Constant Field Values

dataCache

protected final com.github.benmanes.caffeine.cache.AsyncLoadingCache<String,org.apache.commons.lang3.tuple.Pair<Map.Entry<Object,org.apache.zookeeper.data.Stat>,Long>> dataCache

childrenCache

protected final com.github.benmanes.caffeine.cache.AsyncLoadingCache<String,Set<String>> childrenCache

existsCache

protected final com.github.benmanes.caffeine.cache.AsyncLoadingCache<String,Boolean> existsCache

zkSession

protected AtomicReference<ZooKeeper> zkSession

Constructor Detail

ZooKeeperCache

public ZooKeeperCache(String cacheName,
                      ZooKeeper zkSession,
                      int zkOperationTimeoutSeconds,
                      org.apache.bookkeeper.common.util.OrderedExecutor executor)

ZooKeeperCache

public ZooKeeperCache(String cacheName,
                      ZooKeeper zkSession,
                      int zkOperationTimeoutSeconds,
                      org.apache.bookkeeper.common.util.OrderedExecutor executor,
                      int cacheExpirySeconds)

ZooKeeperCache

public ZooKeeperCache(String cacheName,
                      ZooKeeper zkSession,
                      int zkOperationTimeoutSeconds)

Method Detail

getZooKeeper

public ZooKeeper getZooKeeper()

process

public <T> void process(WatchedEvent event,
                        ZooKeeperCache.CacheUpdater<T> updater)

invalidateAll

public void invalidateAll()

invalidateAllData

public void invalidateAllData()

invalidateAllChildren

public void invalidateAllChildren()

invalidateData

public void invalidateData(String path)

invalidateChildren

public void invalidateChildren(String path)

asyncInvalidate

public void asyncInvalidate(String path)

getZkOperationTimeoutSeconds

public int getZkOperationTimeoutSeconds()

invalidate

public void invalidate(String path)

exists

public boolean exists(String path)
               throws KeeperException,
                      InterruptedException

Returns if the node at the given path exists in the cache

Parameters:

path - path of the node

Returns:

true if node exists, false if it does not

Throws:

KeeperException

InterruptedException

existsAsync

public CompletableFuture<Boolean> existsAsync(String path,
                                              Watcher watcher)

getData

public <T> Optional<T> getData(String path,
                               ZooKeeperCache.Deserializer<T> deserializer)
                        throws Exception

Simple ZooKeeperCache use this method to invalidate the cache entry on watch event w/o automatic reloading the cache

Parameters:

path -

deserializer -

Returns:

Throws:

Exception

getEntry

public <T> Optional<Map.Entry<T,org.apache.zookeeper.data.Stat>> getEntry(String path,
                                                                          ZooKeeperCache.Deserializer<T> deserializer)
                                                                   throws Exception

Throws:

Exception

getEntryAsync

public <T> CompletableFuture<Optional<Map.Entry<T,org.apache.zookeeper.data.Stat>>> getEntryAsync(String path,
                                                                                                  ZooKeeperCache.Deserializer<T> deserializer)

getDataAsync

public <T> CompletableFuture<Optional<T>> getDataAsync(String path,
                                                       ZooKeeperCache.Deserializer<T> deserializer)

getData

public <T> Optional<Map.Entry<T,org.apache.zookeeper.data.Stat>> getData(String path,
                                                                         Watcher watcher,
                                                                         ZooKeeperCache.Deserializer<T> deserializer)
                                                                  throws Exception

Cache that implements automatic reloading on update will pass a different Watcher object to reload cache entry automatically

Parameters:

path -

watcher -

deserializer -

Returns:

Throws:

Exception

getDataAsync

public <T> CompletableFuture<Optional<Map.Entry<T,org.apache.zookeeper.data.Stat>>> getDataAsync(String path,
                                                                                                 Watcher watcher,
                                                                                                 ZooKeeperCache.Deserializer<T> deserializer)

getChildren

public Set<String> getChildren(String path)
                        throws KeeperException,
                               InterruptedException

Simple ZooKeeperChildrenCache use this method to invalidate cache entry on watch event w/o automatic re-loading

Parameters:

path -

Returns:

Throws:

KeeperException

InterruptedException

getChildrenAsync

public CompletableFuture<Set<String>> getChildrenAsync(String path,
                                                       Watcher watcher)

ZooKeeperChildrenCache implementing automatic re-loading on update use this method by passing in a different Watcher object to reload cache entry

Parameters:

path -

watcher -

Returns:

getDataIfPresent

public <T> T getDataIfPresent(String path)

getChildrenIfPresent

public Set<String> getChildrenIfPresent(String path)

process

public void process(WatchedEvent event)

Specified by:

process in interface Watcher

invalidateRoot

public void invalidateRoot(String root)

stop

public void stop()

checkRegNodeAndWaitExpired

public boolean checkRegNodeAndWaitExpired(String regPath)
                                   throws IOException

Throws:

IOException