org.apache.curator.x.discovery

Interface ServiceDiscovery<T>

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

ServiceDiscoveryImpl

public interface ServiceDiscovery<T>
extends Closeable

Method Summary

Modifier and Type	Method and Description
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 a service
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 interface java.io.Closeable

close

Method Detail

start

void start()
    throws Exception

The discovery must be started before use

Throws:

Exception - errors

registerService

void registerService(ServiceInstance<T> service)
              throws Exception

Register/re-register a service

Parameters:

service - service to add

Throws:

Exception - errors

updateService

void updateService(ServiceInstance<T> service)
            throws Exception

Update a service

Parameters:

service - service to update

Throws:

Exception - errors

unregisterService

void unregisterService(ServiceInstance<T> service)
                throws Exception

Unregister/remove a service instance

Parameters:

service - the service

Throws:

Exception - errors

serviceCacheBuilder

ServiceCacheBuilder<T> serviceCacheBuilder()

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

Returns:

new cache builder

queryForNames

Collection<String> queryForNames()
                          throws Exception

Return the names of all known services

Returns:

list of service names

Throws:

Exception - errors

queryForInstances

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

Return all known instances for the given service

Parameters:

name - name of the service

Returns:

list of instances (or an empty list)

Throws:

Exception - errors

queryForInstance

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

Return a service instance POJO

Parameters:

name - name of the service

id - ID of the instance

Returns:

the instance or null if not found

Throws:

Exception - errors

serviceProviderBuilder

ServiceProviderBuilder<T> serviceProviderBuilder()

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

Returns:

the builder