Bug 4651: Implement handling of ClusteredDOMDataTreeChangeListener in CDS

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

diff --git a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/AbstractDataListenerSupport.java b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/AbstractDataListenerSupport.java
new file mode 100644 (file)
index 0000000..a253b79
--- /dev/null
+++ b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/AbstractDataListenerSupport.java
@@ -0,0 +1,109 @@
+/*
+ * Copyright (c) 2015 Brocade Communications Systems, Inc. and others.  All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+package org.opendaylight.controller.cluster.datastore;
+
+import akka.actor.ActorRef;
+import akka.actor.ActorSelection;
+import com.google.common.base.Optional;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.EventListener;
+import java.util.Map.Entry;
+import org.opendaylight.controller.cluster.datastore.messages.EnableNotification;
+import org.opendaylight.controller.cluster.datastore.messages.ListenerRegistrationMessage;
+import org.opendaylight.yangtools.concepts.ListenerRegistration;
+import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+abstract class AbstractDataListenerSupport<L extends EventListener, R extends ListenerRegistrationMessage,
+        D extends DelayedListenerRegistration<L, R>, LR extends ListenerRegistration<L>>
+                extends LeaderLocalDelegateFactory<R, LR, Optional<DataTreeCandidate>> {
+    private final Logger log = LoggerFactory.getLogger(getClass());
+
+    private final ArrayList<D> delayedListenerRegistrations = new ArrayList<>();
+    private final ArrayList<D> delayedListenerOnAllRegistrations = new ArrayList<>();
+    private final Collection<ActorSelection> actors = new ArrayList<>();
+
+    protected AbstractDataListenerSupport(Shard shard) {
+        super(shard);
+    }
+
+    @Override
+    void onLeadershipChange(boolean isLeader, boolean hasLeader) {
+        log.debug("{}: onLeadershipChange, isLeader: {}, hasLeader : {}", persistenceId(), isLeader, hasLeader);
+
+        final EnableNotification msg = new EnableNotification(isLeader);
+        for(ActorSelection dataChangeListener : actors) {
+            dataChangeListener.tell(msg, getSelf());
+        }
+
+        if(hasLeader) {
+            for(D reg : delayedListenerOnAllRegistrations) {
+                reg.createDelegate(this);
+            }
+
+            delayedListenerOnAllRegistrations.clear();
+            delayedListenerOnAllRegistrations.trimToSize();
+        }
+
+        if(isLeader) {
+            for(D reg : delayedListenerRegistrations) {
+                reg.createDelegate(this);
+            }
+
+            delayedListenerRegistrations.clear();
+            delayedListenerRegistrations.trimToSize();
+        }
+    }
+
+    @Override
+    void onMessage(R message, boolean isLeader, boolean hasLeader) {
+        log.debug("{}: {} for {}, leader: {}", persistenceId(), logName(), message.getPath(), isLeader);
+
+        final ListenerRegistration<L> registration;
+        if((hasLeader && message.isRegisterOnAllInstances()) || isLeader) {
+            final Entry<LR, Optional<DataTreeCandidate>> res = createDelegate(message);
+            registration = res.getKey();
+        } else {
+            log.debug("{}: Shard is not the leader - delaying registration", persistenceId());
+
+            D delayedReg = newDelayedListenerRegistration(message);
+            if(message.isRegisterOnAllInstances()) {
+                delayedListenerOnAllRegistrations.add(delayedReg);
+            } else {
+                delayedListenerRegistrations.add(delayedReg);
+            }
+
+            registration = delayedReg;
+        }
+
+        ActorRef registrationActor = newRegistrationActor(registration);
+
+        log.debug("{}: {} sending reply, listenerRegistrationPath = {} ", persistenceId(), logName(),
+                registrationActor.path());
+
+        tellSender(newRegistrationReplyMessage(registrationActor));
+    }
+
+    protected Logger log() {
+        return log;
+    }
+
+    protected void addListenerActor(ActorSelection actor) {
+        actors.add(actor);
+    }
+
+    protected abstract D newDelayedListenerRegistration(R message);
+
+    protected abstract ActorRef newRegistrationActor(ListenerRegistration<L> registration);
+
+    protected abstract Object newRegistrationReplyMessage(ActorRef registrationActor);
+
+    protected abstract String logName();
+}