Package org.kiwiproject.consul.cache

Class ServiceHealthCache

java.lang.Object

org.kiwiproject.consul.cache.ConsulCache<ServiceHealthKey,ServiceHealth>

org.kiwiproject.consul.cache.ServiceHealthCache

All Implemented Interfaces:

AutoCloseable

public class ServiceHealthCache
extends ConsulCache<ServiceHealthKey,ServiceHealth>

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 ServiceHealthCache	newCache(HealthClient healthClient, String serviceName)
static ServiceHealthCache	newCache(HealthClient healthClient, String serviceName, boolean passing, int watchSeconds, QueryOptions queryOptions)
static ServiceHealthCache	newCache(HealthClient healthClient, String serviceName, boolean passing, int watchSeconds, QueryOptions queryOptions, Function<ServiceHealth,ServiceHealthKey> keyExtractor)
static ServiceHealthCache	newCache(HealthClient healthClient, String serviceName, boolean passing, int watchSeconds, QueryOptions queryOptions, Function<ServiceHealth,ServiceHealthKey> keyExtractor, ScheduledExecutorService callbackExecutorService)	Factory method to construct a string/ServiceHealth map for a particular service.
static ServiceHealthCache	newCache(HealthClient healthClient, String serviceName, boolean passing, QueryOptions queryOptions, int watchSeconds)

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 ServiceHealthCache newCache(HealthClient healthClient,
 String serviceName,
 boolean passing,
 int watchSeconds,
 QueryOptions queryOptions,
 Function<ServiceHealth,ServiceHealthKey> keyExtractor,
 ScheduledExecutorService callbackExecutorService)

Factory method to construct a string/ServiceHealth map for a particular service.

Keys will be a HostAndPort object made up of the service's address/port combo

Parameters:

healthClient - the HealthClient

serviceName - the name of the service

passing - include only passing services?

watchSeconds - the seconds to block

queryOptions - the query options to use

keyExtractor - a function to convert values to keys

callbackExecutorService - the ScheduledExecutorService to use for asynchronous callbacks

Returns:

a cache object

newCache

public static ServiceHealthCache newCache(HealthClient healthClient,
 String serviceName,
 boolean passing,
 int watchSeconds,
 QueryOptions queryOptions,
 Function<ServiceHealth,ServiceHealthKey> keyExtractor)

newCache

public static ServiceHealthCache newCache(HealthClient healthClient,
 String serviceName,
 boolean passing,
 int watchSeconds,
 QueryOptions queryOptions)

newCache

public static ServiceHealthCache newCache(HealthClient healthClient,
 String serviceName,
 boolean passing,
 QueryOptions queryOptions,
 int watchSeconds)

newCache

public static ServiceHealthCache newCache(HealthClient healthClient,
 String serviceName)