com.hp.util.dcord

Interface CoordinationService

All Known Implementing Classes:

CoordinationServiceAdapter, HazelcastCoordinationService, SuspendibleCoordinationService

public interface CoordinationService

Distributed system's coordination service.

Note: Sharable objects must be Serializable or a Serializer must be registered via registerSerializer(Serializer, Class).

Author:

Mark Mozolewski, Vamsi Devaki, Nachiket Abhyankar, Fabiel Zuniga

Method Summary

Methods

Modifier and Type	Method and Description
void	configureMap(Namespace namespace, MapConfiguration configuration) Sets a particular configuration for a distributed map.
ClusterService	getClusterService() Gets the service to deal with the cluster.
DistributedLock	getLock(Namespace namespace) Creates a distributed lock.
<K,V> DistributedMap<K,V>	getMap(Namespace namespace) Gets a distributed map.
PublishSubscribeService	getPublishSubscribeService() Gets the service to deal with the publish-subscribe.
<T> void	registerSerializer(Serializer<T> serializer, Class<T> subject) Registers a serializer.
<T> void	unregisterSerializer(Class<T> subject) Unregisters a previously registered serializer via registerSerializer(Serializer, Class).

Method Detail

registerSerializer

<T> void registerSerializer(Serializer<T> serializer,
                          Class<T> subject)

Registers a serializer.

Registering serializers allows non serializable objects to be shared.

Registering serializers may be useful if the coordination service is used in component-based applications (Like OSGi where each bundle has a class loader associated) where multiple class loaders are used, making deserialization not possible for the class loader the coordination service is associated to.

Parameters:

serializer - serializer

subject - subject the serializer is associated to

Throws:

UnsupportedOperationException - if this operation is not supported by the implementation

unregisterSerializer

<T> void unregisterSerializer(Class<T> subject)

Unregisters a previously registered serializer via registerSerializer(Serializer, Class).

Parameters:

subject - subject the serializer is associated to

Throws:

UnsupportedOperationException - if this operation is not supported by the implementation

getClusterService

ClusterService getClusterService()

Gets the service to deal with the cluster.

Returns:

the cluster service

getPublishSubscribeService

PublishSubscribeService getPublishSubscribeService()

Gets the service to deal with the publish-subscribe.

Returns:

the publish-subscribe service

getLock

DistributedLock getLock(Namespace namespace)

Creates a distributed lock.

See LockCriticalSectionExecutor for a higher level synchronization abstraction.

Parameters:

namespace - lock's namespace

Returns:

a distributed lock

getMap

<K,V> DistributedMap<K,V> getMap(Namespace namespace)

Gets a distributed map.

Type Parameters:

K - the type of keys maintained by this map. This type should be immutable: The state of the distributed data structure is synchronized but not the state if its elements. It is critical this type implements equals() and hashCode() correctly.

V - the type of mapped values. This type should be immutable: The state of the distributed data structure is synchronized but not the state if its elements.

Parameters:

namespace - map's namespace

Returns:

a distributed map

configureMap

void configureMap(Namespace namespace,
                MapConfiguration configuration)

Sets a particular configuration for a distributed map.

A map must be configured before it is used for the first time. Changing the configuration after the map has been used is not defined and thus it depends on the implementation (It may lead to unexpected behaviors).

Parameters:

namespace - map's namespace

configuration - configuration

Throws:

UnsupportedOperationException - if this operation is not supported by the implementation