org.opendaylight.mdsal.eos.dom.api

Interface DOMEntityOwnershipService

All Superinterfaces:

GenericEntityOwnershipService<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,DOMEntity,DOMEntityOwnershipListener>

All Known Implementing Classes:

SimpleDOMEntityOwnershipService

@Beta
public interface DOMEntityOwnershipService
extends GenericEntityOwnershipService<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,DOMEntity,DOMEntityOwnershipListener>

DOM version of GenericEntityOwnershipService.

Author:

Thomas Pantelis

Method Summary

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

Method Detail

registerCandidate

DOMEntityOwnershipCandidateRegistration registerCandidate(@Nonnull
                                                          DOMEntity entity)
                                                   throws CandidateAlreadyRegisteredException

Description copied from interface: GenericEntityOwnershipService

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.

Specified by:

registerCandidate in interface GenericEntityOwnershipService<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,DOMEntity,DOMEntityOwnershipListener>

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

DOMEntityOwnershipListenerRegistration registerListener(@Nonnull
                                                        String entityType,
                                                        @Nonnull
                                                        DOMEntityOwnershipListener listener)

Description copied from interface: GenericEntityOwnershipService

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.

Specified by:

registerListener in interface GenericEntityOwnershipService<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,DOMEntity,DOMEntityOwnershipListener>

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
                                                                        DOMEntity forEntity)

Description copied from interface: GenericEntityOwnershipService

Gets the current ownership state information for an entity.

Specified by:

getOwnershipState in interface GenericEntityOwnershipService<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,DOMEntity,DOMEntityOwnershipListener>

Parameters:

forEntity - the entity to query.

Returns:

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

isCandidateRegistered

boolean isCandidateRegistered(@Nonnull
                              DOMEntity forEntity)

Description copied from interface: GenericEntityOwnershipService

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

Specified by:

isCandidateRegistered in interface GenericEntityOwnershipService<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,DOMEntity,DOMEntityOwnershipListener>

Parameters:

forEntity - the entity to query.

Returns:

true if a candidate is registered locally, false otherwise