com.netflix.curator.x.discovery.details

Class ServiceDiscoveryImpl<T>

java.lang.Object

com.netflix.curator.x.discovery.details.ServiceDiscoveryImpl<T>

All Implemented Interfaces:

ServiceDiscovery<T>, java.io.Closeable, java.lang.AutoCloseable

public class ServiceDiscoveryImpl<T>
extends java.lang.Object
implements ServiceDiscovery<T>

A mechanism to register and query service instances using ZooKeeper

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_REFRESH_PADDING

Constructor Summary

Constructors

Constructor and Description
ServiceDiscoveryImpl(CuratorFramework client, java.lang.String basePath, InstanceSerializer<T> serializer, ServiceInstance<T> thisInstance)

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
ServiceInstance<T>	queryForInstance(java.lang.String name, java.lang.String id) Return a service instance POJO
java.util.Collection<ServiceInstance<T>>	queryForInstances(java.lang.String name) Return all known instances for the given service
java.util.Collection<java.lang.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

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_REFRESH_PADDING

public static final int DEFAULT_REFRESH_PADDING

Constructor Detail

ServiceDiscoveryImpl

public ServiceDiscoveryImpl(CuratorFramework client,
                    java.lang.String basePath,
                    InstanceSerializer<T> serializer,
                    ServiceInstance<T> thisInstance)

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

Method Detail

start

public void start()
           throws java.lang.Exception

The discovery must be started before use

Specified by:

start in interface ServiceDiscovery<T>

Throws:

java.lang.Exception - errors

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

registerService

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

Register/re-register/update a service instance

Specified by:

registerService in interface ServiceDiscovery<T>

Parameters:

service - service to add

Throws:

java.lang.Exception - errors

unregisterService

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

Unregister/remove a service instance

Specified by:

unregisterService in interface ServiceDiscovery<T>

Parameters:

service - the service

Throws:

java.lang.Exception - errors

serviceProviderBuilder

public ServiceProviderBuilder<T> serviceProviderBuilder()

Allocate a new builder. ServiceProviderBuilder.providerStrategy(com.netflix.curator.x.discovery.ProviderStrategy<T>) is set to RoundRobinStrategy and ServiceProviderBuilder.refreshPaddingMs(int) is set to 1 second.

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 java.util.Collection<java.lang.String> queryForNames()
                                                     throws java.lang.Exception

Return the names of all known services

Specified by:

queryForNames in interface ServiceDiscovery<T>

Returns:

list of service names

Throws:

java.lang.Exception - errors

queryForInstances

public java.util.Collection<ServiceInstance<T>> queryForInstances(java.lang.String name)
                                                           throws java.lang.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:

java.lang.Exception - errors

queryForInstance

public ServiceInstance<T> queryForInstance(java.lang.String name,
                                  java.lang.String id)
                                    throws java.lang.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:

java.lang.Exception - errors