org.opendaylight.mdsal.eos.common.api

Interface GenericEntityOwnershipService<P extends org.opendaylight.yangtools.concepts.Path<P>,E extends GenericEntity<P>,L extends GenericEntityOwnershipListener<P,? extends GenericEntityOwnershipChange<P,E>>>

Type Parameters:

P - the instance identifier path type

E - the GenericEntity type

All Known Subinterfaces:

DOMEntityOwnershipService, EntityOwnershipService

All Known Implementing Classes:

BindingDOMEntityOwnershipServiceAdapter, SimpleDOMEntityOwnershipService

public interface GenericEntityOwnershipService<P extends org.opendaylight.yangtools.concepts.Path<P>,E extends GenericEntity<P>,L extends GenericEntityOwnershipListener<P,? extends GenericEntityOwnershipChange<P,E>>>

An interface that 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.

Author:

Thomas Pantelis

Method Summary

Modifier and Type	Method and Description
Optional<EntityOwnershipState>	getOwnershipState(E forEntity) Gets the current ownership state information for an entity.
boolean	isCandidateRegistered(E forEntity) Checks if a local candidate is registered for the given entity.
GenericEntityOwnershipCandidateRegistration<P,E>	registerCandidate(E entity) Registers a candidate for ownership of the given entity.
GenericEntityOwnershipListenerRegistration<P,L>	registerListener(@NonNull String entityType, L listener) Registers a listener that is interested in ownership changes for entities of the given entity type.

Method Detail

registerCandidate

GenericEntityOwnershipCandidateRegistration<P,E> registerCandidate(E entity)
                                                            throws CandidateAlreadyRegisteredException

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 entity ownership listener 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 - if the candidate was already registered

registerListener

GenericEntityOwnershipListenerRegistration<P,L> registerListener(@NonNull String entityType,
                                                                 L listener)

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

Optional<EntityOwnershipState> getOwnershipState(E forEntity)

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(E forEntity)

Checks if a local candidate is registered for the given entity.

Parameters:

forEntity - the entity to query.

Returns:

true if a candidate is registered locally, false otherwise