Fix warnings/javadocs in sal-distributed-datastore

[controller.git] / opendaylight / md-sal / sal-distributed-datastore / src / main / java / org / opendaylight / controller / cluster / datastore / DataTreeChangeListenerSupport.java

diff --git a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/DataTreeChangeListenerSupport.java b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/DataTreeChangeListenerSupport.java
index afce4df546febce2dd122b1eb431896855503ca8..f039ab707ba76fa4749c7895469d2c5af40b12ba 100644 (file)
--- a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/DataTreeChangeListenerSupport.java
+++ b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/DataTreeChangeListenerSupport.java
@@ -9,86 +9,69 @@ package org.opendaylight.controller.cluster.datastore;
 
 import akka.actor.ActorRef;
 import akka.actor.ActorSelection;
-import com.google.common.base.Preconditions;
-import java.util.ArrayList;
-import java.util.Collection;
+import com.google.common.base.Optional;
+import java.util.Map.Entry;
 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.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
-final class DataTreeChangeListenerSupport extends LeaderLocalDelegateFactory<RegisterDataTreeChangeListener, ListenerRegistration<DOMDataTreeChangeListener>> {
-    private static final Logger LOG = LoggerFactory.getLogger(DataTreeChangeListenerSupport.class);
-    private final ArrayList<DelayedDataTreeListenerRegistration> delayedRegistrations = new ArrayList<>();
-    private final Collection<ActorSelection> actors = new ArrayList<>();
-    private final Shard shard;
+import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
 
+final class DataTreeChangeListenerSupport extends AbstractDataListenerSupport<DOMDataTreeChangeListener,
+        RegisterDataTreeChangeListener, DelayedDataTreeListenerRegistration,
+        ListenerRegistration<DOMDataTreeChangeListener>> {
     DataTreeChangeListenerSupport(final Shard shard) {
-        this.shard = Preconditions.checkNotNull(shard);
+        super(shard);
     }
 
     @Override
-    void onLeadershipChange(final boolean isLeader) {
-        if (isLeader) {
-            for (DelayedDataTreeListenerRegistration reg : delayedRegistrations) {
-                reg.createDelegate(this);
-            }
-            delayedRegistrations.clear();
-            delayedRegistrations.trimToSize();
-        }
+    Entry<ListenerRegistration<DOMDataTreeChangeListener>, Optional<DataTreeCandidate>> createDelegate(
+            final RegisterDataTreeChangeListener message) {
+        ActorSelection dataChangeListenerPath = selectActor(message.getDataTreeChangeListenerPath());
 
-        final EnableNotification msg = new EnableNotification(isLeader);
-        for (ActorSelection dataChangeListener : actors) {
-            dataChangeListener.tell(msg, shard.getSelf());
-        }
-    }
+        // 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());
 
-    @Override
-    void onMessage(final RegisterDataTreeChangeListener registerTreeChangeListener, final boolean isLeader) {
-        LOG.debug("{}: registerTreeChangeListener for {}, leader: {}", shard.persistenceId(), registerTreeChangeListener.getPath(), isLeader);
+        // 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 ListenerRegistration<DOMDataTreeChangeListener> registration;
-        if (!isLeader) {
-            LOG.debug("{}: Shard is not the leader - delaying registration", shard.persistenceId());
+        DOMDataTreeChangeListener listener = new ForwardingDataTreeChangeListener(dataChangeListenerPath);
 
-            DelayedDataTreeListenerRegistration delayedReg =
-                    new DelayedDataTreeListenerRegistration(registerTreeChangeListener);
-            delayedRegistrations.add(delayedReg);
-            registration = delayedReg;
-        } else {
-            registration = createDelegate(registerTreeChangeListener);
-        }
+        log().debug("{}: Registering for path {}", persistenceId(), message.getPath());
 
-        ActorRef listenerRegistration = shard.getContext().actorOf(
-                DataTreeChangeListenerRegistrationActor.props(registration));
+        Entry<ListenerRegistration<DOMDataTreeChangeListener>, Optional<DataTreeCandidate>> regEntry =
+                getShard().getDataStore().registerTreeChangeListener(message.getPath(), listener);
 
-        LOG.debug("{}: registerDataChangeListener sending reply, listenerRegistrationPath = {} ",
-            shard.persistenceId(), listenerRegistration.path());
+        getShard().getDataStore().notifyOfInitialData(message.getPath(),
+                regEntry.getKey().getInstance(), regEntry.getValue());
 
-        shard.getSender().tell(new RegisterDataTreeChangeListenerReply(listenerRegistration), shard.getSelf());
+        return regEntry;
     }
 
     @Override
-    ListenerRegistration<DOMDataTreeChangeListener> createDelegate(final RegisterDataTreeChangeListener message) {
-        ActorSelection dataChangeListenerPath = shard.getContext().system().actorSelection(
-            message.getDataTreeChangeListenerPath().path());
-
-        // 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), shard.getSelf());
-
-        // 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
-        actors.add(dataChangeListenerPath);
+    protected DelayedDataTreeListenerRegistration newDelayedListenerRegistration(
+            RegisterDataTreeChangeListener message) {
+        return new DelayedDataTreeListenerRegistration(message);
+    }
 
-        DOMDataTreeChangeListener listener = new ForwardingDataTreeChangeListener(dataChangeListenerPath);
+    @Override
+    protected ActorRef newRegistrationActor(ListenerRegistration<DOMDataTreeChangeListener> registration) {
+        return createActor(DataTreeChangeListenerRegistrationActor.props(registration));
+    }
 
-        LOG.debug("{}: Registering for path {}", shard.persistenceId(), message.getPath());
+    @Override
+    protected Object newRegistrationReplyMessage(ActorRef registrationActor) {
+        return new RegisterDataTreeChangeListenerReply(registrationActor);
+    }
 
-        return shard.getDataStore().registerTreeChangeListener(message.getPath(), listener);
+    @Override
+    protected String logName() {
+        return "registerTreeChangeListener";
     }
 }