--- /dev/null
+/*
+ * Copyright (c) 2016 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.mdsal.dom.store.inmemory;
+
+import com.google.common.base.Preconditions;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Map;
+import java.util.stream.Collectors;
+import javax.annotation.Nonnull;
+import org.opendaylight.mdsal.dom.api.DOMDataTreeChangeListener;
+import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
+import org.opendaylight.mdsal.dom.api.DOMDataTreeListener;
+import org.opendaylight.mdsal.dom.spi.AbstractDOMDataTreeChangeListenerRegistration;
+import org.opendaylight.mdsal.dom.spi.RegistrationTreeNode;
+import org.opendaylight.mdsal.dom.spi.store.AbstractDOMStoreTreeChangePublisher;
+import org.opendaylight.mdsal.dom.spi.store.DOMStoreTreeChangePublisher;
+import org.opendaylight.yangtools.concepts.ListenerRegistration;
+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.DataTree;
+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.DataTreeCandidates;
+import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification;
+import org.opendaylight.yangtools.yang.data.api.schema.tree.DataValidationFailedException;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+abstract class AbstractDOMShardTreeChangePublisher extends AbstractDOMStoreTreeChangePublisher implements DOMStoreTreeChangePublisher {
+
+ private static final Logger LOG = LoggerFactory.getLogger(AbstractDOMShardTreeChangePublisher.class);
+
+ private YangInstanceIdentifier shardPath;
+ private final Map<DOMDataTreeIdentifier, ChildShardContext> childShards;
+ private final DataTree dataTree;
+
+ protected AbstractDOMShardTreeChangePublisher(final DataTree dataTree,
+ final YangInstanceIdentifier shardPath,
+ final Map<DOMDataTreeIdentifier, ChildShardContext> childShards) {
+ this.dataTree = Preconditions.checkNotNull(dataTree);
+ this.shardPath = Preconditions.checkNotNull(shardPath);
+ this.childShards = Preconditions.checkNotNull(childShards);
+ }
+
+ @Override
+ public <L extends DOMDataTreeChangeListener> AbstractDOMDataTreeChangeListenerRegistration<L> registerTreeChangeListener(final YangInstanceIdentifier path, final L listener) {
+ takeLock();
+ try {
+ return setupListenerContext(path, listener);
+ } finally {
+ releaseLock();
+ }
+ }
+
+ private <L extends DOMDataTreeChangeListener> AbstractDOMDataTreeChangeListenerRegistration<L> setupListenerContext(final YangInstanceIdentifier listenerPath, final L listener) {
+ // we need to register the listener registration path based on the shards root
+ // we have to strip the shard path from the listener path and then register
+ YangInstanceIdentifier strippedIdentifier = listenerPath;
+ if (!shardPath.isEmpty()) {
+ strippedIdentifier = YangInstanceIdentifier.create(stripShardPath(listenerPath));
+ }
+
+ final DOMDataTreeListenerWithSubshards subshardListener = new DOMDataTreeListenerWithSubshards(dataTree, strippedIdentifier, listener);
+ final AbstractDOMDataTreeChangeListenerRegistration<L> reg = setupContextWithoutSubshards(strippedIdentifier, subshardListener);
+
+ for (final ChildShardContext maybeAffected : childShards.values()) {
+ if (listenerPath.contains(maybeAffected.getPrefix().getRootIdentifier())) {
+ // consumer has a subshard somewhere on lower level
+ // register to the notification manager with snapshot and forward child notifications to parent
+ LOG.debug("Adding new subshard{{}} to listener at {}", maybeAffected.getPrefix(), listenerPath);
+ subshardListener.addSubshard(maybeAffected);
+ } else if (maybeAffected.getPrefix().getRootIdentifier().contains(listenerPath)) {
+ // bind path is inside subshard
+ // TODO can this happen? seems like in ShardedDOMDataTree we are already registering to the lowest shard possible
+ throw new UnsupportedOperationException("Listener should be registered directly into a subshard");
+ }
+ }
+ return reg;
+ }
+
+ private <L extends DOMDataTreeChangeListener> AbstractDOMDataTreeChangeListenerRegistration<L> setupContextWithoutSubshards(final YangInstanceIdentifier listenerPath, final DOMDataTreeListenerWithSubshards listener) {
+ LOG.debug("Registering root listener at {}", listenerPath);
+ final RegistrationTreeNode<AbstractDOMDataTreeChangeListenerRegistration<?>> node = findNodeFor(listenerPath.getPathArguments());
+ final AbstractDOMDataTreeChangeListenerRegistration<L> registration = new AbstractDOMDataTreeChangeListenerRegistration<L>((L) listener) {
+ @Override
+ protected void removeRegistration() {
+ listener.close();
+ AbstractDOMShardTreeChangePublisher.this.removeRegistration(node, this);
+ registrationRemoved(this);
+ }
+ };
+ addRegistration(node, registration);
+ return registration;
+ }
+
+ private Iterable<PathArgument> stripShardPath(final YangInstanceIdentifier listenerPath) {
+ if (shardPath.isEmpty()) {
+ return listenerPath.getPathArguments();
+ }
+
+ final List<PathArgument> listenerPathArgs = new ArrayList<>(listenerPath.getPathArguments());
+ final Iterator<PathArgument> shardIter = shardPath.getPathArguments().iterator();
+ final Iterator<PathArgument> listenerIter = listenerPathArgs.iterator();
+
+ while (shardIter.hasNext()) {
+ if (shardIter.next().equals(listenerIter.next())) {
+ listenerIter.remove();
+ } else {
+ break;
+ }
+ }
+
+ return listenerPathArgs;
+ }
+
+ private static final class DOMDataTreeListenerWithSubshards implements DOMDataTreeChangeListener {
+
+ // TODO should we synchronize the access to the dataTree snapshots?
+ private final DataTree dataTree;
+ private final YangInstanceIdentifier listenerPath;
+ private final DOMDataTreeChangeListener delegate;
+
+ private final Map<YangInstanceIdentifier, ListenerRegistration<DOMDataTreeChangeListener>> registrations =
+ new HashMap<>();
+
+ DOMDataTreeListenerWithSubshards(final DataTree dataTree,
+ final YangInstanceIdentifier listenerPath,
+ final DOMDataTreeChangeListener delegate) {
+ this.dataTree = Preconditions.checkNotNull(dataTree);
+ this.listenerPath = Preconditions.checkNotNull(listenerPath);
+ this.delegate = Preconditions.checkNotNull(delegate);
+ }
+
+ @Override
+ public void onDataTreeChanged(@Nonnull final Collection<DataTreeCandidate> changes) {
+ LOG.debug("Received data changed {}", changes.iterator().next());
+ final DataTreeCandidate newCandidate = applyChanges(changes);
+ delegate.onDataTreeChanged(Collections.singleton(newCandidate));
+ }
+
+ void onDataTreeChanged(final YangInstanceIdentifier rootPath, final Collection<DataTreeCandidate> changes) {
+ onDataTreeChanged(changes.stream()
+ .map(candidate -> DataTreeCandidates.newDataTreeCandidate(rootPath, candidate.getRootNode()))
+ .collect(Collectors.toList()));
+ }
+
+ void addSubshard(final ChildShardContext context) {
+ Preconditions.checkState(context.getShard() instanceof DOMStoreTreeChangePublisher,
+ "All subshards that are a part of ListenerContext need to be listenable");
+
+ final DOMStoreTreeChangePublisher listenableShard = (DOMStoreTreeChangePublisher) context.getShard();
+ // since this is going into subshard we want to listen for ALL changes in the subshard
+ registrations.put(context.getPrefix().getRootIdentifier(),
+ listenableShard.registerTreeChangeListener(context.getPrefix().getRootIdentifier(),
+ changes -> onDataTreeChanged(context.getPrefix().getRootIdentifier(), changes)));
+ }
+
+ void close() {
+ for (ListenerRegistration<DOMDataTreeChangeListener> registration : registrations.values()) {
+ registration.close();
+ }
+ registrations.clear();
+ }
+
+ private DataTreeCandidate applyChanges(final Collection<DataTreeCandidate> changes) {
+ final DataTreeModification modification = dataTree.takeSnapshot().newModification();
+ for (final DataTreeCandidate change : changes) {
+ DataTreeCandidates.applyToModification(modification, change);
+ }
+
+ modification.ready();
+ try {
+ dataTree.validate(modification);
+ } catch (DataValidationFailedException e) {
+ LOG.error("Validation failed for built modification", e);
+ throw new RuntimeException("Notification validation failed", e);
+ }
+
+ // strip nodes we dont need since this listener doesn't have to be registered at the root of the DataTree
+ DataTreeCandidateNode modifiedChild = dataTree.prepare(modification).getRootNode();
+ for (final PathArgument pathArgument : listenerPath.getPathArguments()) {
+ // there should be no null pointers since we wouldn't get a notification change
+ // if there was no node modified at the listener's location
+ modifiedChild = modifiedChild.getModifiedChild(pathArgument);
+ }
+
+ return DataTreeCandidates.newDataTreeCandidate(listenerPath, modifiedChild);
+ }
+ }
+}
\ No newline at end of file