Package org.kiwiproject.consul.cache

Class KVCache

java.lang.Object

org.kiwiproject.consul.cache.ConsulCache<String,Value>

org.kiwiproject.consul.cache.KVCache

All Implemented Interfaces:

AutoCloseable

public class KVCache
extends ConsulCache<String,Value>

Nested Class Summary

Nested classes/interfaces inherited from class org.kiwiproject.consul.cache.ConsulCache

ConsulCache.CallbackConsumer<V>, ConsulCache.Listener<K,V>, ConsulCache.Scheduler, ConsulCache.State

Method Summary

Modifier and Type	Method	Description
static KVCache	newCache(KeyValueClient kvClient, String rootPath)	Factory method to construct a String/Value map with a 10-second block interval
static KVCache	newCache(KeyValueClient kvClient, String rootPath, int watchSeconds)	Factory method to construct a String/Value map.
static KVCache	newCache(KeyValueClient kvClient, String rootPath, int watchSeconds, QueryOptions queryOptions)
static KVCache	newCache(KeyValueClient kvClient, String rootPath, int watchSeconds, QueryOptions queryOptions, ScheduledExecutorService callbackExecutorService)

Methods inherited from class org.kiwiproject.consul.cache.ConsulCache

addListener, awaitInitialized, checkWatch, close, createDefault, createExternal, getListeners, getMap, getMapWithMetadata, getState, removeListener, start, stop, watchParams

Methods inherited from class java.lang.Object

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

Method Details

newCache

public static KVCache newCache(KeyValueClient kvClient,
 String rootPath,
 int watchSeconds,
 QueryOptions queryOptions,
 ScheduledExecutorService callbackExecutorService)

newCache

public static KVCache newCache(KeyValueClient kvClient,
 String rootPath,
 int watchSeconds,
 QueryOptions queryOptions)

newCache

public static KVCache newCache(KeyValueClient kvClient,
 String rootPath,
 int watchSeconds)

Factory method to construct a String/Value map.

Parameters:

kvClient - the KeyValueClient to use

rootPath - the root path (will be stripped from keys in the cache)

watchSeconds - how long to tell the Consul server to wait for new values (note that if this is 60 seconds or more, the client's read timeout will need to be increased as well)

Returns:

the cache object

newCache

public static KVCache newCache(KeyValueClient kvClient,
 String rootPath)

Factory method to construct a String/Value map with a 10-second block interval

Parameters:

kvClient - the KeyValueClient to use

rootPath - the root path

Returns:

the cache object