Package org.kiwiproject.consul.cache

Class ConsulCache<K,V>

java.lang.Object

org.kiwiproject.consul.cache.ConsulCache<K,V>

Type Parameters:

K - the type of keys this cache contains

V - the type of values this cache contains

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

HealthCheckCache, KVCache, NodesCatalogCache, ServiceCatalogCache, ServiceHealthCache

public class ConsulCache<K,V>
extends Object
implements AutoCloseable

A cache structure that can provide an up-to-date read-only map backed by consul data

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static interface	ConsulCache.CallbackConsumer<V>	passed in by creators to vary the content of the cached values
static interface	ConsulCache.Listener<K,V>	Implementers can register a listener to receive a new map when it changes
protected static class	ConsulCache.Scheduler
static enum	ConsulCache.State	Represents the possible states of a ConsulCache.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ConsulCache(Function<V,K> keyConversion, ConsulCache.CallbackConsumer<V> callbackConsumer, CacheConfig cacheConfig, ClientEventHandler eventHandler, CacheDescriptor cacheDescriptor)
protected	ConsulCache(Function<V,K> keyConversion, ConsulCache.CallbackConsumer<V> callbackConsumer, CacheConfig cacheConfig, ClientEventHandler eventHandler, CacheDescriptor cacheDescriptor, ScheduledExecutorService callbackScheduleExecutorService)
protected	ConsulCache(Function<V,K> keyConversion, ConsulCache.CallbackConsumer<V> callbackConsumer, CacheConfig cacheConfig, ClientEventHandler eventHandler, CacheDescriptor cacheDescriptor, ConsulCache.Scheduler callbackScheduler)

Method Summary

Modifier and Type	Method	Description
boolean	addListener(ConsulCache.Listener<K,V> listener)	Add a new listener.
boolean	awaitInitialized(long timeout, TimeUnit unit)
protected static void	checkWatch(int networkReadMillis, int cacheWatchSeconds)
void	close()
protected static ConsulCache.Scheduler	createDefault()
protected static ConsulCache.Scheduler	createExternal(ScheduledExecutorService executor)
List<ConsulCache.Listener<K,V>>	getListeners()
com.google.common.collect.ImmutableMap<K,V>	getMap()
ConsulResponse<com.google.common.collect.ImmutableMap<K,V>>	getMapWithMetadata()
ConsulCache.State	getState()
boolean	removeListener(ConsulCache.Listener<K,V> listener)
void	start()
void	stop()
protected static QueryOptions	watchParams(BigInteger index, int blockSeconds, QueryOptions queryOptions)

Methods inherited from class java.lang.Object

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

Constructor Details

ConsulCache

protected ConsulCache(Function<V,K> keyConversion,
 ConsulCache.CallbackConsumer<V> callbackConsumer,
 CacheConfig cacheConfig,
 ClientEventHandler eventHandler,
 CacheDescriptor cacheDescriptor)

ConsulCache

protected ConsulCache(Function<V,K> keyConversion,
 ConsulCache.CallbackConsumer<V> callbackConsumer,
 CacheConfig cacheConfig,
 ClientEventHandler eventHandler,
 CacheDescriptor cacheDescriptor,
 ScheduledExecutorService callbackScheduleExecutorService)

ConsulCache

protected ConsulCache(Function<V,K> keyConversion,
 ConsulCache.CallbackConsumer<V> callbackConsumer,
 CacheConfig cacheConfig,
 ClientEventHandler eventHandler,
 CacheDescriptor cacheDescriptor,
 ConsulCache.Scheduler callbackScheduler)

Method Details

start

public void start()

stop

public void stop()

close

public void close()

Specified by:

close in interface AutoCloseable

awaitInitialized

public boolean awaitInitialized(long timeout,
 TimeUnit unit)
                         throws InterruptedException

Throws:

InterruptedException

getMap

public com.google.common.collect.ImmutableMap<K,V> getMap()

getMapWithMetadata

public ConsulResponse<com.google.common.collect.ImmutableMap<K,V>> getMapWithMetadata()

watchParams

protected static QueryOptions watchParams(BigInteger index,
 int blockSeconds,
 QueryOptions queryOptions)

createDefault

protected static ConsulCache.Scheduler createDefault()

createExternal

protected static ConsulCache.Scheduler createExternal(ScheduledExecutorService executor)

addListener

public boolean addListener(ConsulCache.Listener<K,V> listener)

Add a new listener.

Parameters:

listener - the listener to add

Returns:

true to indicate the listener was added

Implementation Note:

This always returns true because CopyOnWriteArrayList is used to store the listeners, and its CopyOnWriteArrayList.add(Object) method always returns true

getListeners

public List<ConsulCache.Listener<K,V>> getListeners()

removeListener

public boolean removeListener(ConsulCache.Listener<K,V> listener)

getState

public ConsulCache.State getState()

checkWatch

protected static void checkWatch(int networkReadMillis,
 int cacheWatchSeconds)