Package org.apache.curator.x.discovery.details

Class ServiceDiscoveryImpl<T>

java.lang.Object

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

All Implemented Interfaces:

Closeable, AutoCloseable, ServiceDiscovery<T>

public class ServiceDiscoveryImpl<T>
extends Object
implements ServiceDiscovery<T>

A mechanism to register and query service instances using ZooKeeper

Constructor Summary

Constructors

Constructor	Description
ServiceDiscoveryImpl(CuratorFramework client, String basePath, InstanceSerializer<T> serializer, ServiceInstance<T> thisInstance, boolean watchInstances)
ServiceDiscoveryImpl(CuratorFramework client, DiscoveryPathConstructor pathConstructor, InstanceSerializer<T> serializer, ServiceInstance<T> thisInstance, boolean watchInstances)

Method Summary

Modifier and Type	Method	Description
void	close()
protected void	internalRegisterService(ServiceInstance<T> service)
ServiceInstance<T>	queryForInstance(String name, String id)	Return a service instance POJO
Collection<ServiceInstance<T>>	queryForInstances(String name)	Return all known instances for the given service
Collection<String>	queryForNames()	Return the names of all known services
void	registerService(ServiceInstance<T> service)	Register/re-register/update a service instance
ServiceCacheBuilder<T>	serviceCacheBuilder()	Allocate a new service cache builder.
ServiceProviderBuilder<T>	serviceProviderBuilder()	Allocate a new builder.
void	start()	The discovery must be started before use
void	unregisterService(ServiceInstance<T> service)	Unregister/remove a service instance
void	updateService(ServiceInstance<T> service)	Update a service

Methods inherited from class java.lang.Object

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

Constructor Details

ServiceDiscoveryImpl

public ServiceDiscoveryImpl(CuratorFramework client,
 String basePath,
 InstanceSerializer<T> serializer,
 ServiceInstance<T> thisInstance,
 boolean watchInstances)

Parameters:

client - the client

basePath - base path to store data

serializer - serializer for instances (e.g. JsonInstanceSerializer)

thisInstance - instance that represents the service that is running. The instance will get auto-registered

watchInstances - if true, watches for changes to locally registered instances

ServiceDiscoveryImpl

public ServiceDiscoveryImpl(CuratorFramework client,
 DiscoveryPathConstructor pathConstructor,
 InstanceSerializer<T> serializer,
 ServiceInstance<T> thisInstance,
 boolean watchInstances)

Parameters:

client - the client

pathConstructor - constructor for instance paths

serializer - serializer for instances (e.g. JsonInstanceSerializer)

thisInstance - instance that represents the service that is running. The instance will get auto-registered

watchInstances - if true, watches for changes to locally registered instances

Method Details

start

public void start()
           throws Exception

The discovery must be started before use

Specified by:

start in interface ServiceDiscovery<T>

Throws:

Exception - errors

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

registerService

public void registerService(ServiceInstance<T> service)
                     throws Exception

Register/re-register/update a service instance

Specified by:

registerService in interface ServiceDiscovery<T>

Parameters:

service - service to add

Throws:

Exception - errors

updateService

public void updateService(ServiceInstance<T> service)
                   throws Exception

Description copied from interface: ServiceDiscovery

Update a service

Specified by:

updateService in interface ServiceDiscovery<T>

Parameters:

service - service to update

Throws:

Exception - errors

internalRegisterService

protected void internalRegisterService(ServiceInstance<T> service)
                                throws Exception

Throws:

Exception

unregisterService

public void unregisterService(ServiceInstance<T> service)
                       throws Exception

Unregister/remove a service instance

Specified by:

unregisterService in interface ServiceDiscovery<T>

Parameters:

service - the service

Throws:

Exception - errors

serviceProviderBuilder

public ServiceProviderBuilder<T> serviceProviderBuilder()

Allocate a new builder. ServiceProviderBuilder.providerStrategy(org.apache.curator.x.discovery.ProviderStrategy<T>) is set to RoundRobinStrategy

Specified by:

serviceProviderBuilder in interface ServiceDiscovery<T>

Returns:

the builder

serviceCacheBuilder

public ServiceCacheBuilder<T> serviceCacheBuilder()

Allocate a new service cache builder. The refresh padding is defaulted to 1 second.

Specified by:

serviceCacheBuilder in interface ServiceDiscovery<T>

Returns:

new cache builder

queryForNames

public Collection<String> queryForNames()
                                 throws Exception

Return the names of all known services

Specified by:

queryForNames in interface ServiceDiscovery<T>

Returns:

list of service names

Throws:

Exception - errors

queryForInstances

public Collection<ServiceInstance<T>> queryForInstances(String name)
                                                 throws Exception

Return all known instances for the given service

Specified by:

queryForInstances in interface ServiceDiscovery<T>

Parameters:

name - name of the service

Returns:

list of instances (or an empty list)

Throws:

Exception - errors

queryForInstance

public ServiceInstance<T> queryForInstance(String name,
 String id)
                                    throws Exception

Return a service instance POJO

Specified by:

queryForInstance in interface ServiceDiscovery<T>

Parameters:

name - name of the service

id - ID of the instance

Returns:

the instance or null if not found

Throws:

Exception - errors