org.opendaylight.controller.md.sal.common.api.clustering

Interface EntityOwnershipService

All Known Implementing Classes:

LegacyEntityOwnershipServiceAdapter, TestEntityOwnershipService

Deprecated.

Use org.opendaylight.mdsal.binding.api.clustering.EntityOwnershipService or org.opendaylight.mdsal.dom.api.clustering.DOMEntityOwnershipService instead

@Deprecated
public interface EntityOwnershipService

The EntityOwnershipService provides the means for a component/application to request ownership for a given Entity on the current cluster member. Entity ownership is always tied to a process and two components on the same process cannot register a candidate for a given Entity.

A component/application may also register interest in the ownership status of an Entity. The listener would be notified whenever the ownership status changes.

Method Summary

Modifier and Type	Method and Description
com.google.common.base.Optional<EntityOwnershipState>	getOwnershipState(Entity forEntity) Deprecated. Gets the current ownership state information for an entity.
boolean	isCandidateRegistered(Entity entity) Deprecated. Check if a local candidate is registered for the given entity
EntityOwnershipCandidateRegistration	registerCandidate(Entity entity) Deprecated. Registers a candidate for ownership of the given entity.
EntityOwnershipListenerRegistration	registerListener(String entityType, EntityOwnershipListener listener) Deprecated. Registers a listener that is interested in ownership changes for entities of the given entity type.

Method Detail

registerCandidate

EntityOwnershipCandidateRegistration registerCandidate(@Nonnull
                                                       Entity entity)
                                                throws CandidateAlreadyRegisteredException

Deprecated.

Registers a candidate for ownership of the given entity. Only one such request can be made per entity per process. If multiple requests for registering a candidate for a given entity are received in the current process a CandidateAlreadyRegisteredException will be thrown.

The registration is performed asynchronously and any registered EntityOwnershipListener is notified of ownership status changes for the entity.

Parameters:

entity - the entity which the Candidate wants to own

Returns:

a registration object that can be used to unregister the Candidate

Throws:

CandidateAlreadyRegisteredException

registerListener

EntityOwnershipListenerRegistration registerListener(@Nonnull
                                                     String entityType,
                                                     @Nonnull
                                                     EntityOwnershipListener listener)

Deprecated.

Registers a listener that is interested in ownership changes for entities of the given entity type. The listener is notified whenever its process instance is granted ownership of the entity and also whenever it loses ownership. On registration the listener will be notified of all entities its process instance currently owns at the time of registration.

Parameters:

entityType - the type of entities whose ownership status the Listener is interested in

listener - the listener that is interested in the entities

Returns:

a registration object that can be used to unregister the Listener

getOwnershipState

com.google.common.base.Optional<EntityOwnershipState> getOwnershipState(@Nonnull
                                                                        Entity forEntity)

Deprecated.

Gets the current ownership state information for an entity.

Parameters:

forEntity - the entity to query.

Returns:

an Optional EntityOwnershipState whose instance is present if the entity is found

isCandidateRegistered

boolean isCandidateRegistered(@Nonnull
                              Entity entity)

Deprecated.

Check if a local candidate is registered for the given entity

Parameters:

entity -

Returns:

true if a candidate was registered locally, false otherwise