Bug 4105: Implement EntityOwnershipListener registration/notification

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

diff --git a/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/clustering/EntityOwnershipCandidateRegistration.java b/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/clustering/EntityOwnershipCandidateRegistration.java
index 43bf779b8906d942b90821a207ef9737f2eda793..c3c43d92ba481c963cc91a257e7b6fa259b5c778 100644 (file)
--- a/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/clustering/EntityOwnershipCandidateRegistration.java
+++ b/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/clustering/EntityOwnershipCandidateRegistration.java
@@ -8,10 +8,23 @@
 
 package org.opendaylight.controller.md.sal.common.api.clustering;
 
+import javax.annotation.Nonnull;
+import org.opendaylight.yangtools.concepts.ObjectRegistration;
+
 /**
  * An EntityOwnershipCandidateRegistration records a request to register a Candidate for a given Entity. Calling
  * close on the EntityOwnershipCandidateRegistration will remove the Candidate from any future ownership considerations
  * for that Entity and will also remove it as a Listener for ownership status changes.
  */
-public interface EntityOwnershipCandidateRegistration extends EntityOwnershipListenerRegistration {
+public interface EntityOwnershipCandidateRegistration extends ObjectRegistration<EntityOwnershipCandidate> {
+   /**
+    * Returns the entity that the listener was registered for
+    */
+    @Nonnull Entity getEntity();
+
+   /**
+    * Unregister the listener
+    */
+   @Override
+   void close();
 }