org.apache.curator.x.discovery.details

Class ServiceCacheImpl<T>

java.lang.Object

org.apache.curator.x.discovery.details.ServiceCacheImpl<T>

All Implemented Interfaces:

Closeable, AutoCloseable, Listenable<ServiceCacheListener>, PathChildrenCacheListener, InstanceProvider<T>, ServiceCache<T>

public class ServiceCacheImpl<T>
extends Object
implements ServiceCache<T>, PathChildrenCacheListener

Method Summary

Modifier and Type	Method and Description
void	addListener(ServiceCacheListener listener) Add the given listener.
void	addListener(ServiceCacheListener listener, Executor executor) Add the given listener.
void	childEvent(CuratorFramework client, PathChildrenCacheEvent event) Called when a change has occurred
void	close()
List<ServiceInstance<T>>	getInstances() Return the current list of instances.
void	removeListener(ServiceCacheListener listener) Remove the given listener
void	start() The cache must be started before use

Methods inherited from class java.lang.Object

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

Method Detail

getInstances

public List<ServiceInstance<T>> getInstances()

Description copied from interface: ServiceCache

Return the current list of instances. NOTE: there is no guarantee of freshness. This is merely the last known list of instances. However, the list is updated via a ZooKeeper watcher so it should be fresh within a window of a second or two.

Specified by:

getInstances in interface InstanceProvider<T>

Specified by:

getInstances in interface ServiceCache<T>

Returns:

the list

start

public void start()
           throws Exception

Description copied from interface: ServiceCache

The cache must be started before use

Specified by:

start in interface ServiceCache<T>

Throws:

Exception - errors

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

addListener

public void addListener(ServiceCacheListener listener)

Description copied from interface: Listenable

Add the given listener. The listener will be executed in the containing instance's thread.

Specified by:

addListener in interface Listenable<ServiceCacheListener>

Parameters:

listener - listener to add

addListener

public void addListener(ServiceCacheListener listener,
                        Executor executor)

Description copied from interface: Listenable

Add the given listener. The listener will be executed using the given executor

Specified by:

addListener in interface Listenable<ServiceCacheListener>

Parameters:

listener - listener to add

executor - executor to run listener in

removeListener

public void removeListener(ServiceCacheListener listener)

Description copied from interface: Listenable

Remove the given listener

Specified by:

removeListener in interface Listenable<ServiceCacheListener>

Parameters:

listener - listener to remove

childEvent

public void childEvent(CuratorFramework client,
                       PathChildrenCacheEvent event)
                throws Exception

Description copied from interface: PathChildrenCacheListener

Called when a change has occurred

Specified by:

childEvent in interface PathChildrenCacheListener

Parameters:

client - the client

event - describes the change

Throws:

Exception - errors