Package org.opendaylight.mdsal.eos.binding.dom.adapter

Class BindingDOMEntityOwnershipServiceAdapter

java.lang.Object

org.opendaylight.mdsal.eos.binding.dom.adapter.BindingDOMEntityOwnershipServiceAdapter

All Implemented Interfaces:

AutoCloseable, EntityOwnershipService, GenericEntityOwnershipService<InstanceIdentifier<?>,Entity,EntityOwnershipListener>

@Singleton
public class BindingDOMEntityOwnershipServiceAdapter
extends Object
implements EntityOwnershipService, AutoCloseable

Adapter that bridges between the binding and DOM EntityOwnershipService interfaces.

Author:

Thomas Pantelis

Constructor Summary

Constructors

Constructor	Description
BindingDOMEntityOwnershipServiceAdapter(@NonNull DOMEntityOwnershipService domService, @NonNull AdapterContext adapterContext)

Method Summary

Modifier and Type	Method	Description
void	close()
Optional<EntityOwnershipState>	getOwnershipState(Entity forEntity)	Gets the current ownership state information for an entity.
boolean	isCandidateRegistered(Entity forEntity)	Checks if a local candidate is registered for the given entity.
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

BindingDOMEntityOwnershipServiceAdapter

@Inject
public BindingDOMEntityOwnershipServiceAdapter(@NonNull DOMEntityOwnershipService domService,
                                               @NonNull AdapterContext adapterContext)

Method Detail

registerCandidate

public EntityOwnershipCandidateRegistration registerCandidate(Entity 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 EntityOwnershipService

Specified by:

registerCandidate in interface GenericEntityOwnershipService<InstanceIdentifier<?>,Entity,EntityOwnershipListener>

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

public EntityOwnershipListenerRegistration registerListener(String entityType,
                                                            EntityOwnershipListener 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 EntityOwnershipService

Specified by:

registerListener in interface GenericEntityOwnershipService<InstanceIdentifier<?>,Entity,EntityOwnershipListener>

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 Optional<EntityOwnershipState> getOwnershipState(Entity forEntity)

Description copied from interface: GenericEntityOwnershipService

Gets the current ownership state information for an entity.

Specified by:

getOwnershipState in interface EntityOwnershipService

Specified by:

getOwnershipState in interface GenericEntityOwnershipService<InstanceIdentifier<?>,Entity,EntityOwnershipListener>

Parameters:

forEntity - the entity to query.

Returns:

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

isCandidateRegistered

public boolean isCandidateRegistered(Entity forEntity)

Description copied from interface: GenericEntityOwnershipService

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

Specified by:

isCandidateRegistered in interface EntityOwnershipService

Specified by:

isCandidateRegistered in interface GenericEntityOwnershipService<InstanceIdentifier<?>,Entity,EntityOwnershipListener>

Parameters:

forEntity - the entity to query.

Returns:

true if a candidate is registered locally, false otherwise

close

public void close()

Specified by:

close in interface AutoCloseable