alluxio.membership

Class ServiceDiscoveryRecipe

java.lang.Object

alluxio.membership.ServiceDiscoveryRecipe

All Implemented Interfaces:

AutoCloseable

public class ServiceDiscoveryRecipe
extends Object
implements AutoCloseable

ServiceDiscoveryRecipe for etcd, to track health status of all registered services.

Constructor Summary

Constructors

Constructor and Description
ServiceDiscoveryRecipe(AlluxioEtcdClient client, String pathPrefix) CTOR for ServiceDiscoveryRecipe.

Method Summary

Modifier and Type	Method and Description
void	close()
Map<String,ByteBuffer>	getAllLiveServices() Get all healthy service list.
ByteBuffer	getRegisteredServiceDetail(String DefaultServiceEntityName) Get the registered service value as ByteBuffer.
void	registerAndStartSync(DefaultServiceEntity service) Register service and start keeping-alive.
void	unregisterAll() Unregister all services registered from this ServiceDiscoveryRecipe instance.
void	unregisterService(String serviceIdentifier) Unregister service and close corresponding keepalive client if any.
void	updateService(DefaultServiceEntity service) Update the service value with new value.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceDiscoveryRecipe

public ServiceDiscoveryRecipe(AlluxioEtcdClient client,
                              String pathPrefix)

CTOR for ServiceDiscoveryRecipe.

Parameters:

client -

pathPrefix -

Method Detail

registerAndStartSync

public void registerAndStartSync(DefaultServiceEntity service)
                          throws IOException

Register service and start keeping-alive. Atomicity: So the same-named DefaultServiceEntity registration atomicity on etcd is guaranteed in newLeaseInternal(DefaultServiceEntity), by etcd transaction semantics. We ensure that if #newLeaseInternal succeeded, it's safe to track in mRegisteredServices map. Other threads within same process or other processes trying to register same named service will fail in #newLeaseInternal already.

Parameters:

service -

Throws:

IOException

unregisterService

public void unregisterService(String serviceIdentifier)
                       throws IOException

Unregister service and close corresponding keepalive client if any.

Parameters:

serviceIdentifier -

Throws:

IOException

unregisterAll

public void unregisterAll()

Unregister all services registered from this ServiceDiscoveryRecipe instance. [It won't register services registered through other instances(other processes)]

getRegisteredServiceDetail

public ByteBuffer getRegisteredServiceDetail(String DefaultServiceEntityName)
                                      throws IOException

Get the registered service value as ByteBuffer.

Parameters:

DefaultServiceEntityName -

Returns:

ByteBuffer container serialized content

Throws:

IOException

updateService

public void updateService(DefaultServiceEntity service)
                   throws IOException

Update the service value with new value. TODO(lucy) we need to handle the cases where txn failed bcos of lease expiration. Atomicity: update of given DefaultServiceEntity on etcd is handled by etcd transaction on comparing the revision number for a CAS semantic update. update of the DefaultServiceEntity fields is guarded by update lock within DefaultServiceEntity instance.

Parameters:

service -

Throws:

IOException

getAllLiveServices

public Map<String,ByteBuffer> getAllLiveServices()
                                          throws IOException

Get all healthy service list.

Returns:

return service name to service entity serialized value

Throws:

IOException

close

public void close()

Specified by:

close in interface AutoCloseable