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 c7b55414e6d8b8146cf8f00812860716baebf158..2e26e6ee36d170d4bb0d3da3ae3d276d8f62305c 100644 (file)
@@ -9,126 +9,111 @@ 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<>();
-    private final List<DelayedListenerRegistration> delayedRegisterOnAllListeners = 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);
     }
 
+    Collection<ActorSelection> getListenerActors() {
+        return new ArrayList<>(listenerActors);
+    }
+
     @Override
-    void onLeadershipChange(final boolean isLeader, boolean hasLeader) {
-        LOG.debug("onLeadershipChange, isLeader: {}, hasLeader : {}", isLeader, hasLeader);
+    DataChangeListenerRegistration<AsyncDataChangeListener<YangInstanceIdentifier, NormalizedNode<?, ?>>>
+            createDelegate(final RegisterChangeListener message) {
+        final ActorSelection dataChangeListenerPath = selectActor(message.getDataChangeListenerPath());
 
-        for (ActorSelection dataChangeListener : dataChangeListeners) {
-            dataChangeListener.tell(new EnableNotification(isLeader), 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());
 
-        if(hasLeader) {
-            for (DelayedListenerRegistration reg : delayedRegisterOnAllListeners) {
-                registerDelayedListeners(reg);
-            }
-            delayedRegisterOnAllListeners.clear();
+        // 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);
         }
 
-        if (isLeader) {
-            for (DelayedListenerRegistration reg: delayedListenerRegistrations) {
-                registerDelayedListeners(reg);
-            }
+        AsyncDataChangeListener<YangInstanceIdentifier, NormalizedNode<?, ?>> listener =
+                new DataChangeListenerProxy(dataChangeListenerPath);
 
-            delayedListenerRegistrations.clear();
-        }
-    }
+        log().debug("{}: Registering for path {}", persistenceId(), message.getPath());
 
-    private void registerDelayedListeners(DelayedListenerRegistration reg) {
-        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());
-            }
-        }
-    }
+        Entry<DataChangeListenerRegistration<AsyncDataChangeListener<YangInstanceIdentifier, NormalizedNode<?, ?>>>,
+                Optional<DataTreeCandidate>> regEntry = getShard().getDataStore().registerChangeListener(
+                        message.getPath(), listener, message.getScope());
 
-    @Override
-    void onMessage(final RegisterChangeListener message, final boolean isLeader, boolean hasLeader) {
-
-        LOG.debug("{}: registerDataChangeListener for {}, isLeader: {}, hasLeader : {}",
-            persistenceId(), message.getPath(), isLeader, hasLeader);
-
-        final ListenerRegistration<AsyncDataChangeListener<YangInstanceIdentifier,
-                                                     NormalizedNode<?, ?>>> registration;
-        final AsyncDataChangeEvent<YangInstanceIdentifier, NormalizedNode<?, ?>> event;
-        if ((hasLeader && message.isRegisterOnAllInstances()) || 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);
-            if(message.isRegisterOnAllInstances()) {
-                delayedRegisterOnAllListeners.add(delayedReg);
-            } else {
-                delayedListenerRegistrations.add(delayedReg);
+        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();
             }
-            registration = delayedReg;
-            event = null;
-        }
 
-        ActorRef listenerRegistration = createActor(DataChangeListenerRegistration.props(registration));
+            @Override
+            public AsyncDataChangeListener<YangInstanceIdentifier, NormalizedNode<?, ?>> getInstance() {
+                return delegate.getInstance();
+            }
 
-        LOG.debug("{}: registerDataChangeListener sending reply, listenerRegistrationPath = {} ",
-                persistenceId(), listenerRegistration.path());
+            @Override
+            public YangInstanceIdentifier getPath() {
+                return delegate.getPath();
+            }
 
-        tellSender(new RegisterChangeListenerReply(listenerRegistration));
-        if (event != null) {
-            registration.getInstance().onDataChanged(event);
-        }
+            @Override
+            public DataChangeScope getScope() {
+                return delegate.getScope();
+            }
+        };
     }
 
     @Override
-    Entry<ListenerRegistration<AsyncDataChangeListener<YangInstanceIdentifier, NormalizedNode<?, ?>>>, DOMImmutableDataChangeEvent> createDelegate(
-            final RegisterChangeListener message) {
-        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
-        // it will not
-        dataChangeListenerPath.tell(new EnableNotification(true), 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
-        if(!message.isRegisterOnAllInstances()) {
-            dataChangeListeners.add(dataChangeListenerPath);
-        }
+    protected DelayedDataChangeListenerRegistration newDelayedListenerRegistration(RegisterChangeListener message) {
+        return new DelayedDataChangeListenerRegistration(message);
+    }
 
-        AsyncDataChangeListener<YangInstanceIdentifier, NormalizedNode<?, ?>> listener =
-                new DataChangeListenerProxy(dataChangeListenerPath);
+    @Override
+    protected ActorRef newRegistrationActor(
+            ListenerRegistration<AsyncDataChangeListener<YangInstanceIdentifier, NormalizedNode<?, ?>>> registration) {
+        return createActor(DataChangeListenerRegistrationActor.props(registration));
+    }
 
-        LOG.debug("{}: Registering for path {}", persistenceId(), message.getPath());
+    @Override
+    protected Object newRegistrationReplyMessage(ActorRef registrationActor) {
+        return new RegisterChangeListenerReply(registrationActor);
+    }
 
-        return getShard().getDataStore().registerChangeListener(message.getPath(), listener,
-                message.getScope());
+    @Override
+    protected String logName() {
+        return "registerDataChangeListener";
     }
 }