co.cask.cdap.security.zookeeper

Class SharedResourceCache<T>

java.lang.Object

com.google.common.cache.AbstractCache<K,V>

com.google.common.cache.AbstractLoadingCache<String,T>

co.cask.cdap.security.zookeeper.SharedResourceCache<T>

Type Parameters:

T - The type of resource that is distributed to all participants in the cache.

All Implemented Interfaces:

com.google.common.base.Function<String,T>, com.google.common.cache.Cache<String,T>, com.google.common.cache.LoadingCache<String,T>

public class SharedResourceCache<T>
extends com.google.common.cache.AbstractLoadingCache<String,T>

ZooKeeper recipe to propagate changes to a shared cache across a number of listeners. The cache entries are materialized as child znodes under a common parent.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.common.cache.AbstractCache

com.google.common.cache.AbstractCache.SimpleStatsCounter, com.google.common.cache.AbstractCache.StatsCounter

Constructor Summary

Constructors

Constructor and Description
SharedResourceCache(ZKClient zookeeper, Codec<T> codec, String parentZnode, List<org.apache.zookeeper.data.ACL> znodeACL)

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(ResourceListener<T> listener) Adds a ResourceListener to be notified of cache updates.
boolean	equals(Object object)
T	get(String key)
T	getIfPresent(Object key)
Iterable<T>	getResources() Returns a view of all currently set resources.
void	init()
void	put(String name, T instance)
void	putAll(Map<? extends String,? extends T> map)
void	remove(Object key) Removes a resource from the shared cache.
boolean	removeListener(ResourceListener<T> listener) Removes a previously registered listener from further notifications.
long	size()

Methods inherited from class com.google.common.cache.AbstractLoadingCache

apply, getAll, getUnchecked, refresh

Methods inherited from class com.google.common.cache.AbstractCache

asMap, cleanUp, get, getAllPresent, invalidate, invalidateAll, invalidateAll, stats

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.common.cache.LoadingCache

asMap

Methods inherited from interface com.google.common.cache.Cache

cleanUp, get, getAllPresent, invalidate, invalidateAll, invalidateAll, stats

Constructor Detail

SharedResourceCache

public SharedResourceCache(ZKClient zookeeper,
                   Codec<T> codec,
                   String parentZnode,
                   List<org.apache.zookeeper.data.ACL> znodeACL)

Method Detail

init

public void init()
          throws InterruptedException

Throws:

InterruptedException

addListener

public void addListener(ResourceListener<T> listener)

Adds a ResourceListener to be notified of cache updates.

Parameters:

listener - the listener to be invoked

removeListener

public boolean removeListener(ResourceListener<T> listener)

Removes a previously registered listener from further notifications.

Parameters:

listener - the listener to remove

Returns:

whether or not the listener was found and removed

get

public T get(String key)

getIfPresent

public T getIfPresent(Object key)

put

public void put(String name,
       T instance)

Specified by:

put in interface com.google.common.cache.Cache<String,T>

Overrides:

put in class com.google.common.cache.AbstractCache<String,T>

remove

public void remove(Object key)

Removes a resource from the shared cache.

Parameters:

key - the name of the resource to remove

getResources

public Iterable<T> getResources()

Returns a view of all currently set resources.

size

public long size()

Specified by:

size in interface com.google.common.cache.Cache<String,T>

Overrides:

size in class com.google.common.cache.AbstractCache<String,T>

putAll

public void putAll(Map<? extends String,? extends T> map)

Specified by:

putAll in interface com.google.common.cache.Cache<String,T>

Overrides:

putAll in class com.google.common.cache.AbstractCache<String,T>

equals

public boolean equals(Object object)

Specified by:

equals in interface com.google.common.base.Function<String,T>

Overrides:

equals in class Object