Add getOwnershipState method to EntityOwnershipService

[controller.git] / opendaylight / md-sal / sal-common-api / src / main / java / org / opendaylight / controller / md / sal / common / api / clustering / EntityOwnershipService.java

diff --git a/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/clustering/EntityOwnershipService.java b/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/clustering/EntityOwnershipService.java
index 52009a2374b564da79ca277945a2fa72a5da9c0e..311d1b8595565eb2390b9aef15db10644d041514 100644 (file)
--- a/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/clustering/EntityOwnershipService.java
+++ b/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/clustering/EntityOwnershipService.java
@@ -8,6 +8,7 @@
 
 package org.opendaylight.controller.md.sal.common.api.clustering;
 
+import com.google.common.base.Optional;
 import javax.annotation.Nonnull;
 
 /**
@@ -28,17 +29,14 @@ public interface EntityOwnershipService {
      * per process. If multiple requests for registering a candidate for a given entity are received in the
      * current process a CandidateAlreadyRegisteredException will be thrown.
      * <p>
-     * The registration is performed asynchronously and the {@link EntityOwnershipCandidate} instance is
-     * notified whenever its process instance is granted ownership of the entity and also whenever it loses
-     * ownership. Note that the {@link EntityOwnershipCandidate} is not notified when another process instance
-     * is granted ownership.
+     * The registration is performed asynchronously and any registered {@link EntityOwnershipListener} is
+     * notified of ownership status changes for the entity.
      *
      * @param entity the entity which the Candidate wants to own
-     * @param candidate the Candidate that wants to own the entity
      * @return a registration object that can be used to unregister the Candidate
      * @throws org.opendaylight.controller.md.sal.common.api.clustering.CandidateAlreadyRegisteredException
      */
-    EntityOwnershipCandidateRegistration registerCandidate(@Nonnull Entity entity, @Nonnull EntityOwnershipCandidate candidate)
+    EntityOwnershipCandidateRegistration registerCandidate(@Nonnull Entity entity)
             throws CandidateAlreadyRegisteredException;
 
     /**
@@ -53,4 +51,11 @@ public interface EntityOwnershipService {
      */
     EntityOwnershipListenerRegistration registerListener(@Nonnull String entityType, @Nonnull EntityOwnershipListener listener);
 
+    /**
+     * Gets the current ownership state information for an entity.
+     *
+     * @param forEntity the entity to query.
+     * @return an Optional EntityOwnershipState whose instance is present if the entity is found
+     */
+    Optional<EntityOwnershipState> getOwnershipState(@Nonnull Entity forEntity);
 }