Bug 6540: EOS - Prune pending owner change commits on leader change
[controller.git] / opendaylight / md-sal / sal-distributed-datastore / src / main / java / org / opendaylight / controller / cluster / datastore / entityownership / EntityOwnershipListenerSupport.java
index 5220ea29e28e8e74d22d0e45f2727646a896349e..26e6ab75675b810f5666613566ff78a614f84e38 100644 (file)
@@ -13,11 +13,15 @@ import akka.actor.PoisonPill;
 import com.google.common.collect.HashMultimap;
 import com.google.common.collect.Multimap;
 import java.util.Collection;
+import java.util.Collections;
+import java.util.HashSet;
 import java.util.IdentityHashMap;
 import java.util.Map;
-import org.opendaylight.controller.cluster.datastore.entityownership.messages.EntityOwnershipChanged;
-import org.opendaylight.controller.md.sal.common.api.clustering.Entity;
-import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipListener;
+import java.util.Set;
+import org.opendaylight.mdsal.eos.common.api.EntityOwnershipChangeState;
+import org.opendaylight.mdsal.eos.dom.api.DOMEntity;
+import org.opendaylight.mdsal.eos.dom.api.DOMEntityOwnershipChange;
+import org.opendaylight.mdsal.eos.dom.api.DOMEntityOwnershipListener;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -29,18 +33,89 @@ import org.slf4j.LoggerFactory;
 class EntityOwnershipListenerSupport {
     private static final Logger LOG = LoggerFactory.getLogger(EntityOwnershipListenerSupport.class);
 
+    private final String logId;
     private final ActorContext actorContext;
-    private final Map<EntityOwnershipListener, ListenerActorRefEntry> listenerActorMap = new IdentityHashMap<>();
-    private final Multimap<Entity, EntityOwnershipListener> entityListenerMap = HashMultimap.create();
+    private final Map<DOMEntityOwnershipListener, ListenerActorRefEntry> listenerActorMap = new IdentityHashMap<>();
+    private final Set<DOMEntity> entitiesWithCandidateSet = new HashSet<>();
+    private final Multimap<String, DOMEntityOwnershipListener> entityTypeListenerMap = HashMultimap.create();
+    private volatile boolean inJeopardy = false;
 
-    EntityOwnershipListenerSupport(ActorContext actorContext) {
+    EntityOwnershipListenerSupport(ActorContext actorContext, String logId) {
         this.actorContext = actorContext;
+        this.logId = logId;
     }
 
-    void addEntityOwnershipListener(Entity entity, EntityOwnershipListener listener) {
-        LOG.debug("Adding EntityOwnershipListener {} for {}", listener, entity);
+    String getLogId() {
+        return logId;
+    }
+
+    /**
+     * Set the in-jeopardy flag and indicate its previous state.
+     *
+     * @param inJeopardy new value of the in-jeopardy flag
+     * @return Previous value of the flag.
+     */
+    boolean setInJeopardy(final boolean inJeopardy) {
+        final boolean wasInJeopardy = this.inJeopardy;
+        this.inJeopardy = inJeopardy;
+        return wasInJeopardy;
+    }
+
+    boolean hasCandidateForEntity(DOMEntity entity) {
+        return entitiesWithCandidateSet.contains(entity);
+    }
+
+    void setHasCandidateForEntity(DOMEntity entity) {
+        entitiesWithCandidateSet.add(entity);
+    }
+
+    void unsetHasCandidateForEntity(DOMEntity entity) {
+        entitiesWithCandidateSet.remove(entity);
+    }
+
+    void addEntityOwnershipListener(String entityType, DOMEntityOwnershipListener listener) {
+        LOG.debug("{}: Adding EntityOwnershipListener {} for entity type {}", logId, listener, entityType);
 
-        if(entityListenerMap.put(entity, listener)) {
+        addListener(listener, entityType);
+    }
+
+    void removeEntityOwnershipListener(String entityType, DOMEntityOwnershipListener listener) {
+        LOG.debug("{}: Removing EntityOwnershipListener {} for entity type {}", logId, listener, entityType);
+
+        removeListener(listener, entityType);
+    }
+
+    void notifyEntityOwnershipListeners(DOMEntity entity, boolean wasOwner, boolean isOwner, boolean hasOwner) {
+        notifyListeners(entity, entity.getType(), wasOwner, isOwner, hasOwner);
+    }
+
+    void notifyEntityOwnershipListener(DOMEntity entity, boolean wasOwner, boolean isOwner, boolean hasOwner,
+            DOMEntityOwnershipListener listener) {
+        notifyListeners(entity, wasOwner, isOwner, hasOwner, Collections.singleton(listener));
+    }
+
+    private void notifyListeners(DOMEntity entity, String mapKey, boolean wasOwner, boolean isOwner, boolean hasOwner) {
+        Collection<DOMEntityOwnershipListener> listeners = entityTypeListenerMap.get(mapKey);
+        if(!listeners.isEmpty()) {
+            notifyListeners(entity, wasOwner, isOwner, hasOwner, listeners);
+        }
+    }
+
+    private void notifyListeners(DOMEntity entity, boolean wasOwner, boolean isOwner, boolean hasOwner,
+            Collection<DOMEntityOwnershipListener> listeners) {
+        DOMEntityOwnershipChange changed = new DOMEntityOwnershipChange(entity,
+                EntityOwnershipChangeState.from(wasOwner, isOwner, hasOwner), inJeopardy);
+        for(DOMEntityOwnershipListener listener: listeners) {
+            ActorRef listenerActor = listenerActorFor(listener);
+
+            LOG.debug("{}: Notifying EntityOwnershipListenerActor {} with {}", logId, listenerActor, changed);
+
+            listenerActor.tell(changed, ActorRef.noSender());
+        }
+    }
+
+    private void addListener(DOMEntityOwnershipListener listener, String mapKey) {
+        if (entityTypeListenerMap.put(mapKey, listener)) {
             ListenerActorRefEntry listenerEntry = listenerActorMap.get(listener);
             if(listenerEntry == null) {
                 listenerActorMap.put(listener, new ListenerActorRefEntry());
@@ -50,13 +125,11 @@ class EntityOwnershipListenerSupport {
         }
     }
 
-    void removeEntityOwnershipListener(Entity entity, EntityOwnershipListener listener) {
-        LOG.debug("Removing EntityOwnershipListener {} for {}", listener, entity);
-
-        if(entityListenerMap.remove(entity, listener)) {
+    private void removeListener(DOMEntityOwnershipListener listener, String mapKey) {
+        if (entityTypeListenerMap.remove(mapKey, listener)) {
             ListenerActorRefEntry listenerEntry = listenerActorMap.get(listener);
 
-            LOG.debug("Found {}", listenerEntry);
+            LOG.debug("{}: Found {}", logId, listenerEntry);
 
             listenerEntry.referenceCount--;
             if(listenerEntry.referenceCount <= 0) {
@@ -70,23 +143,7 @@ class EntityOwnershipListenerSupport {
         }
     }
 
-    void notifyEntityOwnershipListeners(Entity entity, boolean wasOwner, boolean isOwner) {
-        Collection<EntityOwnershipListener> listeners = entityListenerMap.get(entity);
-        if(listeners.isEmpty()) {
-            return;
-        }
-
-        EntityOwnershipChanged changed = new EntityOwnershipChanged(entity, wasOwner, isOwner);
-        for(EntityOwnershipListener listener: listeners) {
-            ActorRef listenerActor = listenerActorFor(listener);
-
-            LOG.debug("Notifying EntityOwnershipListenerActor {} with {}", listenerActor,changed);
-
-            listenerActor.tell(changed, ActorRef.noSender());
-        }
-    }
-
-    private ActorRef listenerActorFor(EntityOwnershipListener listener) {
+    private ActorRef listenerActorFor(DOMEntityOwnershipListener listener) {
         return listenerActorMap.get(listener).actorFor(listener);
     }
 
@@ -94,11 +151,11 @@ class EntityOwnershipListenerSupport {
         ActorRef actorRef;
         int referenceCount = 1;
 
-        ActorRef actorFor(EntityOwnershipListener listener) {
+        ActorRef actorFor(DOMEntityOwnershipListener listener) {
             if(actorRef == null) {
                 actorRef = actorContext.actorOf(EntityOwnershipListenerActor.props(listener));
 
-                LOG.debug("Created EntityOwnershipListenerActor {} for listener {}", actorRef, listener);
+                LOG.debug("{}: Created EntityOwnershipListenerActor {} for listener {}", logId, actorRef, listener);
             }
 
             return actorRef;