Fix logging messages
[controller.git] / opendaylight / md-sal / sal-distributed-datastore / src / main / java / org / opendaylight / controller / cluster / datastore / entityownership / EntityOwnershipListenerSupport.java
index 5220ea29e28e8e74d22d0e45f2727646a896349e..ee786e7fc0fda3a7800078225a0f390b29288d33 100644 (file)
@@ -11,13 +11,20 @@ import akka.actor.ActorContext;
 import akka.actor.ActorRef;
 import akka.actor.PoisonPill;
 import com.google.common.collect.HashMultimap;
+import com.google.common.collect.ImmutableList;
 import com.google.common.collect.Multimap;
 import java.util.Collection;
 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.concurrent.locks.ReadWriteLock;
+import java.util.concurrent.locks.ReentrantReadWriteLock;
+import java.util.stream.Collectors;
+import javax.annotation.concurrent.GuardedBy;
+import javax.annotation.concurrent.ThreadSafe;
+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;
 
@@ -26,79 +33,145 @@ import org.slf4j.LoggerFactory;
  *
  * @author Thomas Pantelis
  */
-class EntityOwnershipListenerSupport {
+@ThreadSafe
+class EntityOwnershipListenerSupport extends EntityOwnershipChangePublisher {
     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 ReadWriteLock listenerLock = new ReentrantReadWriteLock();
 
-    EntityOwnershipListenerSupport(ActorContext actorContext) {
+    @GuardedBy("listenerLock")
+    private final Map<DOMEntityOwnershipListener, ListenerActorRefEntry> listenerActorMap = new IdentityHashMap<>();
+
+    @GuardedBy("listenerLock")
+    private final Multimap<String, DOMEntityOwnershipListener> entityTypeListenerMap = HashMultimap.create();
+
+    private volatile boolean inJeopardy = false;
+
+    EntityOwnershipListenerSupport(final ActorContext actorContext, final String logId) {
         this.actorContext = actorContext;
+        this.logId = logId;
     }
 
-    void addEntityOwnershipListener(Entity entity, EntityOwnershipListener listener) {
-        LOG.debug("Adding EntityOwnershipListener {} for {}", listener, entity);
+    @Override
+    String getLogId() {
+        return logId;
+    }
 
-        if(entityListenerMap.put(entity, listener)) {
-            ListenerActorRefEntry listenerEntry = listenerActorMap.get(listener);
-            if(listenerEntry == null) {
-                listenerActorMap.put(listener, new ListenerActorRefEntry());
-            } else {
-                listenerEntry.referenceCount++;
+    /**
+     * 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.
+     */
+    @SuppressWarnings("checkstyle:hiddenField")
+    boolean setInJeopardy(final boolean inJeopardy) {
+        final boolean wasInJeopardy = this.inJeopardy;
+        this.inJeopardy = inJeopardy;
+        return wasInJeopardy;
+    }
+
+    void addEntityOwnershipListener(final String entityType, final DOMEntityOwnershipListener listener) {
+        LOG.debug("{}: Adding EntityOwnershipListener {} for entity type {}", logId, listener, entityType);
+
+        listenerLock.writeLock().lock();
+        try {
+            if (entityTypeListenerMap.put(entityType, listener)) {
+                ListenerActorRefEntry listenerEntry = listenerActorMap.get(listener);
+                if (listenerEntry == null) {
+                    listenerActorMap.put(listener, new ListenerActorRefEntry(listener));
+                } else {
+                    listenerEntry.referenceCount++;
+                }
             }
+        } finally {
+            listenerLock.writeLock().unlock();
         }
     }
 
-    void removeEntityOwnershipListener(Entity entity, EntityOwnershipListener listener) {
-        LOG.debug("Removing EntityOwnershipListener {} for {}", listener, entity);
+    void removeEntityOwnershipListener(final String entityType, final DOMEntityOwnershipListener listener) {
+        LOG.debug("{}: Removing EntityOwnershipListener {} for entity type {}", logId, listener, entityType);
 
-        if(entityListenerMap.remove(entity, listener)) {
-            ListenerActorRefEntry listenerEntry = listenerActorMap.get(listener);
+        listenerLock.writeLock().lock();
+        try {
+            if (entityTypeListenerMap.remove(entityType, listener)) {
+                ListenerActorRefEntry listenerEntry = listenerActorMap.get(listener);
 
-            LOG.debug("Found {}", listenerEntry);
+                LOG.debug("{}: Found {}", logId, listenerEntry);
 
-            listenerEntry.referenceCount--;
-            if(listenerEntry.referenceCount <= 0) {
-                listenerActorMap.remove(listener);
+                listenerEntry.referenceCount--;
+                if (listenerEntry.referenceCount <= 0) {
+                    listenerActorMap.remove(listener);
 
-                if(listenerEntry.actorRef != null) {
-                    LOG.debug("Killing EntityOwnershipListenerActor {}", listenerEntry.actorRef);
-                    listenerEntry.actorRef.tell(PoisonPill.getInstance(), ActorRef.noSender());
+                    if (listenerEntry.actorRef != null) {
+                        LOG.debug("Killing EntityOwnershipListenerActor {}", listenerEntry.actorRef);
+                        listenerEntry.actorRef.tell(PoisonPill.getInstance(), ActorRef.noSender());
+                    }
                 }
             }
+        } finally {
+            listenerLock.writeLock().unlock();
+        }
+    }
+
+    @Override
+    void notifyEntityOwnershipListeners(final DOMEntity entity, final boolean wasOwner, final boolean isOwner,
+            final boolean hasOwner) {
+        listenerLock.readLock().lock();
+        try {
+            Collection<DOMEntityOwnershipListener> listeners = entityTypeListenerMap.get(entity.getType());
+            if (!listeners.isEmpty()) {
+                notifyListeners(entity, wasOwner, isOwner, hasOwner,
+                        listeners.stream().map(listenerActorMap::get).collect(Collectors.toList()));
+            }
+        } finally {
+            listenerLock.readLock().unlock();
         }
     }
 
-    void notifyEntityOwnershipListeners(Entity entity, boolean wasOwner, boolean isOwner) {
-        Collection<EntityOwnershipListener> listeners = entityListenerMap.get(entity);
-        if(listeners.isEmpty()) {
-            return;
+    void notifyEntityOwnershipListener(final DOMEntity entity, final boolean wasOwner, final boolean isOwner,
+            final boolean hasOwner, final DOMEntityOwnershipListener listener) {
+        listenerLock.readLock().lock();
+        try {
+            notifyListeners(entity, wasOwner, isOwner, hasOwner, ImmutableList.of(listenerActorMap.get(listener)));
+        } finally {
+            listenerLock.readLock().unlock();
         }
+    }
 
-        EntityOwnershipChanged changed = new EntityOwnershipChanged(entity, wasOwner, isOwner);
-        for(EntityOwnershipListener listener: listeners) {
-            ActorRef listenerActor = listenerActorFor(listener);
+    @GuardedBy("listenerLock")
+    private void notifyListeners(final DOMEntity entity, final boolean wasOwner, final boolean isOwner,
+            final boolean hasOwner, final Collection<ListenerActorRefEntry> listenerEntries) {
+        DOMEntityOwnershipChange changed = new DOMEntityOwnershipChange(entity,
+                EntityOwnershipChangeState.from(wasOwner, isOwner, hasOwner), inJeopardy);
+        for (ListenerActorRefEntry entry: listenerEntries) {
+            ActorRef listenerActor = entry.actorFor();
 
-            LOG.debug("Notifying EntityOwnershipListenerActor {} with {}", listenerActor,changed);
+            LOG.debug("{}: Notifying EntityOwnershipListenerActor {} with {}", logId, listenerActor, changed);
 
             listenerActor.tell(changed, ActorRef.noSender());
         }
     }
 
-    private ActorRef listenerActorFor(EntityOwnershipListener listener) {
-        return listenerActorMap.get(listener).actorFor(listener);
-    }
-
     private class ListenerActorRefEntry {
+        final DOMEntityOwnershipListener listener;
+
+        @GuardedBy("listenerLock")
         ActorRef actorRef;
+
+        @GuardedBy("listenerLock")
         int referenceCount = 1;
 
-        ActorRef actorFor(EntityOwnershipListener listener) {
-            if(actorRef == null) {
+        ListenerActorRefEntry(final DOMEntityOwnershipListener listener) {
+            this.listener = listener;
+        }
+
+        ActorRef actorFor() {
+            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;