Package org.opendaylight.controller.cluster.entityownership

Class DistributedEntityOwnershipService

java.lang.Object

org.opendaylight.controller.cluster.entityownership.DistributedEntityOwnershipService

All Implemented Interfaces:

AutoCloseable, org.opendaylight.mdsal.eos.common.api.GenericEntityOwnershipService<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.mdsal.eos.dom.api.DOMEntity,org.opendaylight.mdsal.eos.dom.api.DOMEntityOwnershipListener>, org.opendaylight.mdsal.eos.dom.api.DOMEntityOwnershipService

public class DistributedEntityOwnershipService
extends Object
implements org.opendaylight.mdsal.eos.dom.api.DOMEntityOwnershipService, AutoCloseable

The distributed implementation of the EntityOwnershipService.

Author:

Thomas Pantelis

Method Summary

Modifier and Type	Method	Description
void	close()
Optional<org.opendaylight.mdsal.eos.common.api.EntityOwnershipState>	getOwnershipState(org.opendaylight.mdsal.eos.dom.api.DOMEntity forEntity)
boolean	isCandidateRegistered(org.opendaylight.mdsal.eos.dom.api.DOMEntity entity)
org.opendaylight.mdsal.eos.dom.api.DOMEntityOwnershipCandidateRegistration	registerCandidate(org.opendaylight.mdsal.eos.dom.api.DOMEntity entity)
org.opendaylight.mdsal.eos.dom.api.DOMEntityOwnershipListenerRegistration	registerListener(String entityType, org.opendaylight.mdsal.eos.dom.api.DOMEntityOwnershipListener listener)
static DistributedEntityOwnershipService	start(org.opendaylight.controller.cluster.datastore.utils.ActorUtils context, EntityOwnerSelectionStrategyConfig strategyConfig)

Methods inherited from class java.lang.Object

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

Method Detail

start

public static DistributedEntityOwnershipService start(org.opendaylight.controller.cluster.datastore.utils.ActorUtils context,
                                                      EntityOwnerSelectionStrategyConfig strategyConfig)

registerCandidate

public org.opendaylight.mdsal.eos.dom.api.DOMEntityOwnershipCandidateRegistration registerCandidate(org.opendaylight.mdsal.eos.dom.api.DOMEntity entity)
                                                                                             throws org.opendaylight.mdsal.eos.common.api.CandidateAlreadyRegisteredException

Specified by:

registerCandidate in interface org.opendaylight.mdsal.eos.dom.api.DOMEntityOwnershipService

Specified by:

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

Throws:

org.opendaylight.mdsal.eos.common.api.CandidateAlreadyRegisteredException

registerListener

public org.opendaylight.mdsal.eos.dom.api.DOMEntityOwnershipListenerRegistration registerListener(String entityType,
                                                                                                  org.opendaylight.mdsal.eos.dom.api.DOMEntityOwnershipListener listener)

Specified by:

registerListener in interface org.opendaylight.mdsal.eos.dom.api.DOMEntityOwnershipService

Specified by:

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

getOwnershipState

public Optional<org.opendaylight.mdsal.eos.common.api.EntityOwnershipState> getOwnershipState(org.opendaylight.mdsal.eos.dom.api.DOMEntity forEntity)

Specified by:

getOwnershipState in interface org.opendaylight.mdsal.eos.dom.api.DOMEntityOwnershipService

Specified by:

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

isCandidateRegistered

public boolean isCandidateRegistered(org.opendaylight.mdsal.eos.dom.api.DOMEntity entity)

Specified by:

isCandidateRegistered in interface org.opendaylight.mdsal.eos.dom.api.DOMEntityOwnershipService

Specified by:

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

close

public void close()

Specified by:

close in interface AutoCloseable