BUG 2970 : Create a PruningDataTreeModification

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

diff --git a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/utils/PruningDataTreeModification.java b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/utils/PruningDataTreeModification.java
new file mode 100644 (file)
index 0000000..2427223
--- /dev/null
+++ b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/utils/PruningDataTreeModification.java
@@ -0,0 +1,136 @@
+/*
+ * 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.cluster.datastore.utils;
+
+import com.google.common.annotations.VisibleForTesting;
+import com.google.common.base.Optional;
+import java.io.IOException;
+import java.net.URI;
+import java.util.Set;
+import org.opendaylight.controller.cluster.datastore.node.utils.transformer.NormalizedNodePruner;
+import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
+import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
+import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeWriter;
+import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification;
+import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModificationCursor;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * The PruningDataTreeModification first removes all entries from the data which do not belong in the schemaContext
+ * before delegating it to the actual DataTreeModification
+ */
+public class PruningDataTreeModification implements DataTreeModification {
+
+    private static final Logger LOG = LoggerFactory.getLogger(PruningDataTreeModification.class);
+    private final DataTreeModification delegate;
+    private final Set<URI> validNamespaces;
+
+    public PruningDataTreeModification(DataTreeModification delegate, Set<URI> validNamespaces) {
+        this.delegate = delegate;
+        this.validNamespaces = validNamespaces;
+    }
+
+    @Override
+    public void delete(YangInstanceIdentifier yangInstanceIdentifier) {
+        try {
+            delegate.delete(yangInstanceIdentifier);
+        } catch(IllegalArgumentException e){
+            LOG.warn("Node at path : {} does not exist ignoring delete", yangInstanceIdentifier);
+        }
+    }
+
+    @Override
+    public void merge(YangInstanceIdentifier yangInstanceIdentifier, NormalizedNode<?, ?> normalizedNode) {
+        try {
+            delegate.merge(yangInstanceIdentifier, normalizedNode);
+        } catch (IllegalArgumentException e){
+            if(!isValidYangInstanceIdentifier(yangInstanceIdentifier)){
+                LOG.warn("Invalid node identifier {} ignoring merge", yangInstanceIdentifier);
+                return;
+            }
+
+            LOG.warn("Node at path : {} was pruned during merge", yangInstanceIdentifier);
+
+            NormalizedNode<?,?> pruned = pruneNormalizedNode(normalizedNode);
+
+            if(pruned != null) {
+                delegate.merge(yangInstanceIdentifier, pruned);
+            }
+        }
+
+    }
+
+    @Override
+    public void write(YangInstanceIdentifier yangInstanceIdentifier, NormalizedNode<?, ?> normalizedNode) {
+        try {
+            delegate.write(yangInstanceIdentifier, normalizedNode);
+        } catch (IllegalArgumentException e){
+            if(!isValidYangInstanceIdentifier(yangInstanceIdentifier)){
+                LOG.warn("Invalid node identifier {} ignoring write", yangInstanceIdentifier);
+                return;
+            }
+
+            LOG.warn("Node at path : {} was pruned during write", yangInstanceIdentifier);
+
+            NormalizedNode<?,?> pruned = pruneNormalizedNode(normalizedNode);
+
+            if(pruned != null) {
+                delegate.write(yangInstanceIdentifier, pruned);
+            }
+        }
+    }
+
+    @Override
+    public void ready() {
+        delegate.ready();
+    }
+
+    @Override
+    public void applyToCursor(DataTreeModificationCursor dataTreeModificationCursor) {
+        delegate.applyToCursor(dataTreeModificationCursor);
+    }
+
+    @Override
+    public Optional<NormalizedNode<?, ?>> readNode(YangInstanceIdentifier yangInstanceIdentifier) {
+        return delegate.readNode(yangInstanceIdentifier);
+    }
+
+    @Override
+    public DataTreeModification newModification() {
+        return new PruningDataTreeModification(delegate.newModification(), validNamespaces);
+    }
+
+    @VisibleForTesting
+    NormalizedNode<?, ?> pruneNormalizedNode(NormalizedNode<?,?> input){
+        NormalizedNodePruner pruner = new NormalizedNodePruner(validNamespaces);
+        try {
+            NormalizedNodeWriter.forStreamWriter(pruner).write(input);
+        } catch (IOException ioe) {
+            LOG.error("Unexpected IOException when pruning normalizedNode", ioe);
+        }
+
+        return pruner.normalizedNode();
+    }
+
+    public DataTreeModification getDelegate(){
+        return delegate;
+    }
+
+    private boolean isValidYangInstanceIdentifier(YangInstanceIdentifier instanceIdentifier){
+        for(YangInstanceIdentifier.PathArgument pathArgument : instanceIdentifier.getPathArguments()){
+            if(!validNamespaces.contains(pathArgument.getNodeType().getNamespace())){
+                return false;
+            }
+        }
+
+        return true;
+    }
+
+}