opendaylight/md-sal/sal-inmemory-datastore/src/main/java/org/opendaylight/controller/md/sal/dom/store/impl/InMemoryDOMStoreTreeChangePublisher.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.controller.md.sal.dom.store.impl;
   9
  10 import java.util.Collection;
  11 import java.util.Collections;
  12 import java.util.Optional;
  13 import java.util.concurrent.ExecutorService;
  14 import javax.annotation.Nonnull;
  15 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeChangeListener;
  16 import org.opendaylight.controller.md.sal.dom.spi.AbstractDOMDataTreeChangeListenerRegistration;
  17 import org.opendaylight.controller.sal.core.spi.data.AbstractDOMStoreTreeChangePublisher;
  18 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  19 import org.opendaylight.yangtools.util.concurrent.QueuedNotificationManager;
  20 import org.opendaylight.yangtools.util.concurrent.QueuedNotificationManager.Invoker;
  21 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  22 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  23 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
  24 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidateNode;
  25 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidates;
  26 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeSnapshot;
  27 import org.slf4j.Logger;
  28 import org.slf4j.LoggerFactory;
  29
  30 final class InMemoryDOMStoreTreeChangePublisher extends AbstractDOMStoreTreeChangePublisher {
  31     private static final Invoker<AbstractDOMDataTreeChangeListenerRegistration<?>, DataTreeCandidate> MANAGER_INVOKER =
  32         (listener, notification) -> {
  33             // FIXME: this is inefficient, as we could grab the entire queue for the listener and post it
  34             final DOMDataTreeChangeListener inst = listener.getInstance();
  35             if (inst != null) {
  36                 inst.onDataTreeChanged(Collections.singletonList(notification));
  37             }
  38         };
  39
  40     private static final Logger LOG = LoggerFactory.getLogger(InMemoryDOMStoreTreeChangePublisher.class);
  41     private final QueuedNotificationManager<AbstractDOMDataTreeChangeListenerRegistration<?>, DataTreeCandidate>
  42             notificationManager;
  43
  44     InMemoryDOMStoreTreeChangePublisher(final ExecutorService listenerExecutor, final int maxQueueSize) {
  45         notificationManager = new QueuedNotificationManager<>(listenerExecutor, MANAGER_INVOKER, maxQueueSize,
  46                 "DataTreeChangeListenerQueueMgr");
  47     }
  48
  49     private InMemoryDOMStoreTreeChangePublisher(QueuedNotificationManager<
  50             AbstractDOMDataTreeChangeListenerRegistration<?>, DataTreeCandidate> notificationManager) {
  51         this.notificationManager = notificationManager;
  52     }
  53
  54     @Override
  55     protected void notifyListeners(final Collection<AbstractDOMDataTreeChangeListenerRegistration<?>> registrations,
  56             final YangInstanceIdentifier path, final DataTreeCandidateNode node) {
  57         final DataTreeCandidate candidate = DataTreeCandidates.newDataTreeCandidate(path, node);
  58
  59         for (AbstractDOMDataTreeChangeListenerRegistration<?> reg : registrations) {
  60             LOG.debug("Enqueueing candidate {} to registration {}", candidate, registrations);
  61             notificationManager.submitNotification(reg, candidate);
  62         }
  63     }
  64
  65     @Override
  66     protected synchronized void registrationRemoved(
  67             final AbstractDOMDataTreeChangeListenerRegistration<?> registration) {
  68         LOG.debug("Closing registration {}", registration);
  69
  70         // FIXME: remove the queue for this registration and make sure we clear it
  71     }
  72
  73     <L extends DOMDataTreeChangeListener> ListenerRegistration<L> registerTreeChangeListener(
  74             final YangInstanceIdentifier treeId, final L listener, final DataTreeSnapshot snapshot) {
  75         final AbstractDOMDataTreeChangeListenerRegistration<L> reg = registerTreeChangeListener(treeId, listener);
  76
  77         final Optional<NormalizedNode<?, ?>> node = snapshot.readNode(YangInstanceIdentifier.EMPTY);
  78         if (node.isPresent()) {
  79             final DataTreeCandidate candidate = DataTreeCandidates.fromNormalizedNode(
  80                     YangInstanceIdentifier.EMPTY, node.get());
  81
  82             InMemoryDOMStoreTreeChangePublisher publisher =
  83                     new InMemoryDOMStoreTreeChangePublisher(notificationManager);
  84             publisher.registerTreeChangeListener(treeId, listener);
  85             publisher.publishChange(candidate);
  86         }
  87
  88         return reg;
  89     }
  90
  91     synchronized void publishChange(@Nonnull final DataTreeCandidate candidate) {
  92         // Runs synchronized with registrationRemoved()
  93         processCandidateTree(candidate);
  94     }
  95 }