com.orbitz.consul.cache

Class ConsulCache<K,V>

java.lang.Object

com.orbitz.consul.cache.ConsulCache<K,V>

Type Parameters:

V -

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 and 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

Constructor Summary

Constructors

Modifier	Constructor and 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, ConsulCache.Scheduler callbackScheduler)
protected	ConsulCache(Function<V,K> keyConversion, ConsulCache.CallbackConsumer<V> callbackConsumer, CacheConfig cacheConfig, ClientEventHandler eventHandler, CacheDescriptor cacheDescriptor, ScheduledExecutorService callbackScheduleExecutorService)

Method Summary

Modifier and Type	Method and Description
boolean	addListener(ConsulCache.Listener<K,V> listener)
boolean	awaitInitialized(long timeout, TimeUnit unit)
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()
protected com.orbitz.consul.cache.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 Detail

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 Detail

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)

getListeners

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

removeListener

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

getState

protected com.orbitz.consul.cache.ConsulCache.State getState()