Usage of Collections.unmodifiableCollection is unsafe
[controller.git] / opendaylight / md-sal / sal-distributed-datastore / src / main / java / org / opendaylight / controller / cluster / datastore / DataChangeListenerSupport.java
index e6f63d7154ba6d5f301ed7fd4b77f111d0ea8034..2e26e6ee36d170d4bb0d3da3ae3d276d8f62305c 100644 (file)
@@ -9,89 +9,42 @@ 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.List;
+import java.util.Collection;
 import java.util.Map.Entry;
+import java.util.Set;
 import org.opendaylight.controller.cluster.datastore.messages.EnableNotification;
 import org.opendaylight.controller.cluster.datastore.messages.RegisterChangeListener;
 import org.opendaylight.controller.cluster.datastore.messages.RegisterChangeListenerReply;
-import org.opendaylight.controller.md.sal.common.api.data.AsyncDataChangeEvent;
+import org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker.DataChangeScope;
 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataChangeListener;
-import org.opendaylight.controller.md.sal.dom.store.impl.DOMImmutableDataChangeEvent;
+import org.opendaylight.controller.md.sal.dom.store.impl.DataChangeListenerRegistration;
 import org.opendaylight.yangtools.concepts.ListenerRegistration;
 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
+import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
 
-final class DataChangeListenerSupport extends LeaderLocalDelegateFactory<RegisterChangeListener, ListenerRegistration<AsyncDataChangeListener<YangInstanceIdentifier, NormalizedNode<?, ?>>>, DOMImmutableDataChangeEvent> {
-    private static final Logger LOG = LoggerFactory.getLogger(DataChangeListenerSupport.class);
-    private final List<DelayedListenerRegistration> delayedListenerRegistrations = new ArrayList<>();
-    private final List<ActorSelection> dataChangeListeners =  new ArrayList<>();
+final class DataChangeListenerSupport extends AbstractDataListenerSupport<
+        AsyncDataChangeListener<YangInstanceIdentifier, NormalizedNode<?, ?>>, RegisterChangeListener,
+            DelayedDataChangeListenerRegistration, DataChangeListenerRegistration<
+                    AsyncDataChangeListener<YangInstanceIdentifier, NormalizedNode<?, ?>>>> {
+
+    private final Set<ActorSelection> listenerActors = Sets.newConcurrentHashSet();
 
     DataChangeListenerSupport(final Shard shard) {
         super(shard);
     }
 
-    @Override
-    void onLeadershipChange(final boolean isLeader) {
-        for (ActorSelection dataChangeListener : dataChangeListeners) {
-            dataChangeListener.tell(new EnableNotification(isLeader), getSelf());
-        }
-
-        if (isLeader) {
-            for (DelayedListenerRegistration reg: delayedListenerRegistrations) {
-                if(!reg.isClosed()) {
-                    final Entry<ListenerRegistration<AsyncDataChangeListener<YangInstanceIdentifier, NormalizedNode<?, ?>>>, DOMImmutableDataChangeEvent> res =
-                            createDelegate(reg.getRegisterChangeListener());
-                    reg.setDelegate(res.getKey());
-                    if (res.getValue() != null) {
-                        reg.getInstance().onDataChanged(res.getValue());
-                    }
-                }
-            }
-
-            delayedListenerRegistrations.clear();
-        }
+    Collection<ActorSelection> getListenerActors() {
+        return new ArrayList<>(listenerActors);
     }
 
     @Override
-    void onMessage(final RegisterChangeListener message, final boolean isLeader) {
-
-        LOG.debug("{}: registerDataChangeListener for {}, leader: {}", persistenceId(), message.getPath(), isLeader);
-
-        final ListenerRegistration<AsyncDataChangeListener<YangInstanceIdentifier,
-                                                     NormalizedNode<?, ?>>> registration;
-        final AsyncDataChangeEvent<YangInstanceIdentifier, NormalizedNode<?, ?>> event;
-        if (isLeader) {
-            final Entry<ListenerRegistration<AsyncDataChangeListener<YangInstanceIdentifier, NormalizedNode<?, ?>>>, DOMImmutableDataChangeEvent> res =
-                    createDelegate(message);
-            registration = res.getKey();
-            event = res.getValue();
-        } else {
-            LOG.debug("{}: Shard is not the leader - delaying registration", persistenceId());
-
-            DelayedListenerRegistration delayedReg = new DelayedListenerRegistration(message);
-            delayedListenerRegistrations.add(delayedReg);
-            registration = delayedReg;
-            event = null;
-        }
-
-        ActorRef listenerRegistration = createActor(DataChangeListenerRegistration.props(registration));
-
-        LOG.debug("{}: registerDataChangeListener sending reply, listenerRegistrationPath = {} ",
-                persistenceId(), listenerRegistration.path());
-
-        tellSender(new RegisterChangeListenerReply(listenerRegistration));
-        if (event != null) {
-            registration.getInstance().onDataChanged(event);
-        }
-    }
-
-    @Override
-    Entry<ListenerRegistration<AsyncDataChangeListener<YangInstanceIdentifier, NormalizedNode<?, ?>>>, DOMImmutableDataChangeEvent> createDelegate(
-            final RegisterChangeListener message) {
-        ActorSelection dataChangeListenerPath = selectActor(message.getDataChangeListenerPath());
+    DataChangeListenerRegistration<AsyncDataChangeListener<YangInstanceIdentifier, NormalizedNode<?, ?>>>
+            createDelegate(final RegisterChangeListener message) {
+        final ActorSelection dataChangeListenerPath = selectActor(message.getDataChangeListenerPath());
 
         // Notify the listener if notifications should be enabled or not
         // If this shard is the leader then it will enable notifications else
@@ -100,14 +53,67 @@ final class DataChangeListenerSupport extends LeaderLocalDelegateFactory<Registe
 
         // 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
-        dataChangeListeners.add(dataChangeListenerPath);
+        if (!message.isRegisterOnAllInstances()) {
+            addListenerActor(dataChangeListenerPath);
+        }
 
         AsyncDataChangeListener<YangInstanceIdentifier, NormalizedNode<?, ?>> listener =
                 new DataChangeListenerProxy(dataChangeListenerPath);
 
-        LOG.debug("{}: Registering for path {}", persistenceId(), message.getPath());
+        log().debug("{}: Registering for path {}", persistenceId(), message.getPath());
+
+        Entry<DataChangeListenerRegistration<AsyncDataChangeListener<YangInstanceIdentifier, NormalizedNode<?, ?>>>,
+                Optional<DataTreeCandidate>> regEntry = getShard().getDataStore().registerChangeListener(
+                        message.getPath(), listener, message.getScope());
 
-        return getShard().getDataStore().registerChangeListener(message.getPath(), listener,
-                message.getScope());
+        getShard().getDataStore().notifyOfInitialData(regEntry.getKey(), regEntry.getValue());
+
+        listenerActors.add(dataChangeListenerPath);
+        final DataChangeListenerRegistration<AsyncDataChangeListener<YangInstanceIdentifier, NormalizedNode<?, ?>>>
+            delegate = regEntry.getKey();
+        return new DataChangeListenerRegistration<AsyncDataChangeListener<YangInstanceIdentifier,
+                NormalizedNode<?,?>>>() {
+            @Override
+            public void close() {
+                listenerActors.remove(dataChangeListenerPath);
+                delegate.close();
+            }
+
+            @Override
+            public AsyncDataChangeListener<YangInstanceIdentifier, NormalizedNode<?, ?>> getInstance() {
+                return delegate.getInstance();
+            }
+
+            @Override
+            public YangInstanceIdentifier getPath() {
+                return delegate.getPath();
+            }
+
+            @Override
+            public DataChangeScope getScope() {
+                return delegate.getScope();
+            }
+        };
+    }
+
+    @Override
+    protected DelayedDataChangeListenerRegistration newDelayedListenerRegistration(RegisterChangeListener message) {
+        return new DelayedDataChangeListenerRegistration(message);
+    }
+
+    @Override
+    protected ActorRef newRegistrationActor(
+            ListenerRegistration<AsyncDataChangeListener<YangInstanceIdentifier, NormalizedNode<?, ?>>> registration) {
+        return createActor(DataChangeListenerRegistrationActor.props(registration));
+    }
+
+    @Override
+    protected Object newRegistrationReplyMessage(ActorRef registrationActor) {
+        return new RegisterChangeListenerReply(registrationActor);
+    }
+
+    @Override
+    protected String logName() {
+        return "registerDataChangeListener";
     }
 }