+++ /dev/null
-/*
- * Copyright (c) 2015 Cisco 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.sal.core.spi.data;
-
-import java.util.Collection;
-import java.util.List;
-import org.eclipse.jdt.annotation.NonNull;
-import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeChangeListener;
-import org.opendaylight.controller.md.sal.dom.spi.AbstractDOMDataTreeChangeListenerRegistration;
-import org.opendaylight.mdsal.dom.spi.AbstractRegistrationTree;
-import org.opendaylight.mdsal.dom.spi.RegistrationTreeNode;
-import org.opendaylight.mdsal.dom.spi.RegistrationTreeSnapshot;
-import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
-import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
-import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
-import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidateNode;
-import org.opendaylight.yangtools.yang.data.api.schema.tree.ModificationType;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
-/**
- * Abstract base class for {@link DOMStoreTreeChangePublisher} implementations.
- *
- * @deprecated Use {@link org.opendaylight.mdsal.dom.spi.store.AbstractDOMStoreTreeChangePublisher} instead.
- */
-@Deprecated(forRemoval = true)
-public abstract class AbstractDOMStoreTreeChangePublisher
- extends AbstractRegistrationTree<AbstractDOMDataTreeChangeListenerRegistration<?>>
- implements DOMStoreTreeChangePublisher {
- private static final Logger LOG = LoggerFactory.getLogger(AbstractDOMStoreTreeChangePublisher.class);
-
- /**
- * Callback for subclass to notify specified registrations of a candidate at a specified path. This method is
- * guaranteed to be only called from within {@link #processCandidateTree(DataTreeCandidate)}.
- *
- * @param registrations Registrations which are affected by the candidate node
- * @param path Path of changed candidate node. Guaranteed to match the path specified by the registration
- * @param node Candidate node
- */
- protected abstract void notifyListeners(@NonNull Collection<AbstractDOMDataTreeChangeListenerRegistration<?>>
- registrations, @NonNull YangInstanceIdentifier path, @NonNull DataTreeCandidateNode node);
-
- /**
- * Callback notifying the subclass that the specified registration is being closed and it's user no longer
- * wishes to receive notifications. This notification is invoked while the
- * {@link org.opendaylight.yangtools.concepts.ListenerRegistration#close()}
- * method is executing. Subclasses can use this callback to properly remove any delayed notifications pending
- * towards the registration.
- *
- * @param registration Registration which is being closed
- */
- protected abstract void registrationRemoved(@NonNull AbstractDOMDataTreeChangeListenerRegistration<?> registration);
-
- /**
- * Process a candidate tree with respect to registered listeners.
- *
- * @param candidate candidate three which needs to be processed
- */
- protected final void processCandidateTree(final @NonNull DataTreeCandidate candidate) {
- final DataTreeCandidateNode node = candidate.getRootNode();
- if (node.getModificationType() == ModificationType.UNMODIFIED) {
- LOG.debug("Skipping unmodified candidate {}", candidate);
- return;
- }
-
- try (RegistrationTreeSnapshot<AbstractDOMDataTreeChangeListenerRegistration<?>> snapshot = takeSnapshot()) {
- lookupAndNotify(candidate.getRootPath().getPathArguments(), 0, snapshot.getRootNode(), candidate);
- }
- }
-
- @Override
- public final <L extends DOMDataTreeChangeListener> AbstractDOMDataTreeChangeListenerRegistration<L>
- registerTreeChangeListener(final YangInstanceIdentifier treeId, final L listener) {
- // Take the write lock
- takeLock();
- try {
- final RegistrationTreeNode<AbstractDOMDataTreeChangeListenerRegistration<?>> node =
- findNodeFor(treeId.getPathArguments());
- final AbstractDOMDataTreeChangeListenerRegistration<L> reg =
- new AbstractDOMDataTreeChangeListenerRegistration<L>(listener) {
- @Override
- protected void removeRegistration() {
- AbstractDOMStoreTreeChangePublisher.this.removeRegistration(node, this);
- registrationRemoved(this);
- }
- };
-
- addRegistration(node, reg);
- return reg;
- } finally {
- // Always release the lock
- releaseLock();
- }
- }
-
- private void lookupAndNotify(final List<PathArgument> args, final int offset,
- final RegistrationTreeNode<AbstractDOMDataTreeChangeListenerRegistration<?>> node,
- final DataTreeCandidate candidate) {
- if (args.size() != offset) {
- final PathArgument arg = args.get(offset);
-
- final RegistrationTreeNode<AbstractDOMDataTreeChangeListenerRegistration<?>> exactChild =
- node.getExactChild(arg);
- if (exactChild != null) {
- lookupAndNotify(args, offset + 1, exactChild, candidate);
- }
-
- for (RegistrationTreeNode<AbstractDOMDataTreeChangeListenerRegistration<?>> c :
- node.getInexactChildren(arg)) {
- lookupAndNotify(args, offset + 1, c, candidate);
- }
- } else {
- notifyNode(candidate.getRootPath(), node, candidate.getRootNode());
- }
- }
-
- private void notifyNode(final YangInstanceIdentifier path,
- final RegistrationTreeNode<AbstractDOMDataTreeChangeListenerRegistration<?>> regNode,
- final DataTreeCandidateNode candNode) {
- if (candNode.getModificationType() == ModificationType.UNMODIFIED) {
- LOG.debug("Skipping unmodified candidate {}", path);
- return;
- }
-
- final Collection<AbstractDOMDataTreeChangeListenerRegistration<?>> regs = regNode.getRegistrations();
- if (!regs.isEmpty()) {
- notifyListeners(regs, path, candNode);
- }
-
- for (DataTreeCandidateNode candChild : candNode.getChildNodes()) {
- if (candChild.getModificationType() != ModificationType.UNMODIFIED) {
- final RegistrationTreeNode<AbstractDOMDataTreeChangeListenerRegistration<?>> regChild =
- regNode.getExactChild(candChild.getIdentifier());
- if (regChild != null) {
- notifyNode(path.node(candChild.getIdentifier()), regChild, candChild);
- }
-
- for (RegistrationTreeNode<AbstractDOMDataTreeChangeListenerRegistration<?>> rc :
- regNode.getInexactChildren(candChild.getIdentifier())) {
- notifyNode(path.node(candChild.getIdentifier()), rc, candChild);
- }
- }
- }
- }
-}