Simplify DTCL registration support classes
[controller.git] / opendaylight / md-sal / sal-distributed-datastore / src / main / java / org / opendaylight / controller / cluster / datastore / DataTreeChangeListenerSupport.java
index 5b8e5f8abfb871f4bd2c503ce7de1853b4c5aac5..348b2aa939efc10617a8f9544a5a738acfdd5345 100644 (file)
@@ -9,93 +9,127 @@ package org.opendaylight.controller.cluster.datastore;
 
 import akka.actor.ActorRef;
 import akka.actor.ActorSelection;
-import com.google.common.base.Optional;
-import com.google.common.collect.Sets;
+import java.util.ArrayList;
 import java.util.Collection;
-import java.util.Collections;
-import java.util.Map.Entry;
-import java.util.Set;
+import java.util.concurrent.ConcurrentHashMap;
+import org.opendaylight.controller.cluster.datastore.actors.DataTreeNotificationListenerRegistrationActor;
 import org.opendaylight.controller.cluster.datastore.messages.EnableNotification;
 import org.opendaylight.controller.cluster.datastore.messages.RegisterDataTreeChangeListener;
-import org.opendaylight.controller.cluster.datastore.messages.RegisterDataTreeChangeListenerReply;
-import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeChangeListener;
-import org.opendaylight.yangtools.concepts.ListenerRegistration;
-import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
+import org.opendaylight.controller.cluster.datastore.messages.RegisterDataTreeNotificationListenerReply;
+import org.opendaylight.mdsal.dom.api.DOMDataTreeChangeListener;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
-final class DataTreeChangeListenerSupport extends AbstractDataListenerSupport<DOMDataTreeChangeListener,
-        RegisterDataTreeChangeListener, DelayedDataTreeListenerRegistration,
-        ListenerRegistration<DOMDataTreeChangeListener>> {
+final class DataTreeChangeListenerSupport extends LeaderLocalDelegateFactory<RegisterDataTreeChangeListener> {
+    private static final Logger LOG = LoggerFactory.getLogger(DataTreeChangeListenerSupport.class);
 
-    private final Set<ActorSelection> listenerActors = Sets.newConcurrentHashSet();
+    private final Collection<DelayedDataTreeChangeListenerRegistration<DOMDataTreeChangeListener>>
+            delayedDataTreeChangeListenerRegistrations = ConcurrentHashMap.newKeySet();
+    private final Collection<DelayedDataTreeChangeListenerRegistration<DOMDataTreeChangeListener>>
+            delayedListenerOnAllRegistrations = ConcurrentHashMap.newKeySet();
+    private final Collection<ActorSelection> leaderOnlyListenerActors = ConcurrentHashMap.newKeySet();
+    private final Collection<ActorSelection> allListenerActors = ConcurrentHashMap.newKeySet();
 
     DataTreeChangeListenerSupport(final Shard shard) {
         super(shard);
     }
 
+    void doRegistration(final RegisterDataTreeChangeListener message, final ActorRef registrationActor) {
+        final ActorSelection listenerActor = processListenerRegistrationMessage(message);
+
+        final DOMDataTreeChangeListener listener = new ForwardingDataTreeChangeListener(listenerActor);
+
+        LOG.debug("{}: Registering listenerActor {} for path {}", persistenceId(), listenerActor, message.getPath());
+
+        final ShardDataTree shardDataTree = getShard().getDataStore();
+        shardDataTree.registerTreeChangeListener(message.getPath(),
+                listener, shardDataTree.readCurrentData(), registration -> registrationActor.tell(
+                        new DataTreeNotificationListenerRegistrationActor.SetRegistration(registration, () ->
+                            removeListenerActor(listenerActor)), ActorRef.noSender()));
+    }
+
     Collection<ActorSelection> getListenerActors() {
-        return Collections.unmodifiableCollection(listenerActors);
+        return new ArrayList<>(allListenerActors);
     }
 
     @Override
-    ListenerRegistration<DOMDataTreeChangeListener> createDelegate(
-            final RegisterDataTreeChangeListener message) {
-        final ActorSelection dataChangeListenerPath = selectActor(message.getDataTreeChangeListenerPath());
-
-        // Notify the listener if notifications should be enabled or not
-        // If this shard is the leader then it will enable notifications else
-        // it will not
-        dataChangeListenerPath.tell(new EnableNotification(true), getSelf());
+    void onLeadershipChange(final boolean isLeader, final boolean hasLeader) {
+        LOG.debug("{}: onLeadershipChange, isLeader: {}, hasLeader : {}", persistenceId(), isLeader, hasLeader);
 
-        // Now store a reference to the data change listener so it can be notified
-        // at a later point if notifications should be enabled or disabled
-        if (!message.isRegisterOnAllInstances()) {
-            addListenerActor(dataChangeListenerPath);
+        final EnableNotification msg = new EnableNotification(isLeader, persistenceId());
+        for (ActorSelection dataChangeListener : leaderOnlyListenerActors) {
+            dataChangeListener.tell(msg, getSelf());
         }
 
-        DOMDataTreeChangeListener listener = new ForwardingDataTreeChangeListener(dataChangeListenerPath);
-
-        log().debug("{}: Registering for path {}", persistenceId(), message.getPath());
-
-        Entry<ListenerRegistration<DOMDataTreeChangeListener>, Optional<DataTreeCandidate>> regEntry =
-                getShard().getDataStore().registerTreeChangeListener(message.getPath(), listener);
+        if (hasLeader) {
+            for (DelayedDataTreeChangeListenerRegistration<DOMDataTreeChangeListener> reg :
+                    delayedListenerOnAllRegistrations) {
+                reg.doRegistration(this);
+            }
 
-        getShard().getDataStore().notifyOfInitialData(message.getPath(),
-                regEntry.getKey().getInstance(), regEntry.getValue());
+            delayedListenerOnAllRegistrations.clear();
+        }
 
-        listenerActors.add(dataChangeListenerPath);
-        final ListenerRegistration<DOMDataTreeChangeListener> delegate = regEntry.getKey();
-        return new ListenerRegistration<DOMDataTreeChangeListener>() {
-            @Override
-            public DOMDataTreeChangeListener getInstance() {
-                return delegate.getInstance();
+        if (isLeader) {
+            for (DelayedDataTreeChangeListenerRegistration<DOMDataTreeChangeListener> reg :
+                    delayedDataTreeChangeListenerRegistrations) {
+                reg.doRegistration(this);
             }
 
-            @Override
-            public void close() {
-                listenerActors.remove(dataChangeListenerPath);
-                delegate.close();
-            }
-        };
+            delayedDataTreeChangeListenerRegistrations.clear();
+        }
     }
 
     @Override
-    protected DelayedDataTreeListenerRegistration newDelayedListenerRegistration(
-            RegisterDataTreeChangeListener message) {
-        return new DelayedDataTreeListenerRegistration(message);
-    }
+    void onMessage(final RegisterDataTreeChangeListener message, final boolean isLeader, final boolean hasLeader) {
+        LOG.debug("{}: onMessage {}, isLeader: {}, hasLeader: {}", persistenceId(), message, isLeader, hasLeader);
+
+        final ActorRef registrationActor = createActor(DataTreeNotificationListenerRegistrationActor.props());
+
+        if (hasLeader && message.isRegisterOnAllInstances() || isLeader) {
+            doRegistration(message, registrationActor);
+        } else {
+            LOG.debug("{}: Shard does not have a leader - delaying registration", persistenceId());
+
+            final DelayedDataTreeChangeListenerRegistration<DOMDataTreeChangeListener> delayedReg =
+                    new DelayedDataTreeChangeListenerRegistration<>(message, registrationActor);
+            final Collection<DelayedDataTreeChangeListenerRegistration<DOMDataTreeChangeListener>> delayedRegList;
+            if (message.isRegisterOnAllInstances()) {
+                delayedRegList = delayedListenerOnAllRegistrations;
+            } else {
+                delayedRegList = delayedDataTreeChangeListenerRegistrations;
+            }
 
-    @Override
-    protected ActorRef newRegistrationActor(ListenerRegistration<DOMDataTreeChangeListener> registration) {
-        return createActor(DataTreeChangeListenerRegistrationActor.props(registration));
+            delayedRegList.add(delayedReg);
+            registrationActor.tell(new DataTreeNotificationListenerRegistrationActor.SetRegistration(
+                    delayedReg, () -> delayedRegList.remove(delayedReg)), ActorRef.noSender());
+        }
+
+        LOG.debug("{}: sending RegisterDataTreeNotificationListenerReply, listenerRegistrationPath = {} ",
+                persistenceId(), registrationActor.path());
+
+        tellSender(new RegisterDataTreeNotificationListenerReply(registrationActor));
     }
 
-    @Override
-    protected Object newRegistrationReplyMessage(ActorRef registrationActor) {
-        return new RegisterDataTreeChangeListenerReply(registrationActor);
+    private ActorSelection processListenerRegistrationMessage(final RegisterDataTreeChangeListener message) {
+        final ActorSelection listenerActor = selectActor(message.getListenerActorPath());
+
+        // We have a leader so enable the listener.
+        listenerActor.tell(new EnableNotification(true, persistenceId()), getSelf());
+
+        if (!message.isRegisterOnAllInstances()) {
+            // This is a leader-only registration so store a reference to the listener actor so it can be notified
+            // at a later point if notifications should be enabled or disabled.
+            leaderOnlyListenerActors.add(listenerActor);
+        }
+
+        allListenerActors.add(listenerActor);
+
+        return listenerActor;
     }
 
-    @Override
-    protected String logName() {
-        return "registerTreeChangeListener";
+    private void removeListenerActor(final ActorSelection listenerActor) {
+        allListenerActors.remove(listenerActor);
+        leaderOnlyListenerActors.remove(listenerActor);
     }
 }