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

Class TestEntityOwnershipService

java.lang.Object

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

All Implemented Interfaces:

EntityOwnershipService

public abstract class TestEntityOwnershipService
extends Object
implements EntityOwnershipService

Fake EntityOwnershipService suitable for non-clustered component tests.

Author:

Michael Vorburger

Constructor Summary

Constructors

Constructor and Description
TestEntityOwnershipService()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

TestEntityOwnershipService

public TestEntityOwnershipService()

Method Detail

newInstance

public static EntityOwnershipService newInstance()

registerCandidate

public EntityOwnershipCandidateRegistration registerCandidate(Entity entity)

Description copied from interface: EntityOwnershipService

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.

Specified by:

registerCandidate in interface EntityOwnershipService

Parameters:

entity - the entity which the Candidate wants to own

Returns:

a registration object that can be used to unregister the Candidate

registerListener

public EntityOwnershipListenerRegistration registerListener(String entityType,
                                                            EntityOwnershipListener listener)

Description copied from interface: EntityOwnershipService

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 EntityOwnershipService

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

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

Description copied from interface: EntityOwnershipService

Gets the current ownership state information for an entity.

Specified by:

getOwnershipState in interface EntityOwnershipService

Parameters:

forEntity - the entity to query.

Returns:

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

isCandidateRegistered

public boolean isCandidateRegistered(Entity entity)

Description copied from interface: EntityOwnershipService

Check if a local candidate is registered for the given entity

Specified by:

isCandidateRegistered in interface EntityOwnershipService

Returns:

true if a candidate was registered locally, false otherwise