org.apache.curator.x.discovery

Interface ServiceProvider<T>

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

ServiceProviderImpl

public interface ServiceProvider<T>
extends Closeable

The main API for Discovery. This class is essentially a facade over a ProviderStrategy paired with an InstanceProvider

Method Summary

Modifier and Type	Method and Description
Collection<ServiceInstance<T>>	getAllInstances() Return the current available set of instances IMPORTANT: users should not hold on to the instance returned.
ServiceInstance<T>	getInstance() Return an instance for a single use.
void	noteError(ServiceInstance<T> instance) Take note of an error connecting to the given instance.
void	start() The provider must be started before use

Methods inherited from interface java.io.Closeable

close

Method Detail

start

void start()
    throws Exception

The provider must be started before use

Throws:

Exception - any errors

getInstance

ServiceInstance<T> getInstance()
                        throws Exception

Return an instance for a single use. IMPORTANT: users should not hold on to the instance returned. They should always get a fresh instance.

Returns:

the instance to use

Throws:

Exception - any errors

getAllInstances

Collection<ServiceInstance<T>> getAllInstances()
                                        throws Exception

Return the current available set of instances IMPORTANT: users should not hold on to the instance returned. They should always get a fresh list.

Returns:

all known instances

Throws:

Exception - any errors

noteError

void noteError(ServiceInstance<T> instance)

Take note of an error connecting to the given instance. The instance will potentially be marked as "down" depending on the DownInstancePolicy.

Parameters:

instance - instance that had an error