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

   1 /*
   2  * Copyright (c) 2015 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.cluster.datastore.utils;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.annotations.VisibleForTesting;
  13 import com.google.common.collect.ForwardingObject;
  14 import java.io.IOException;
  15 import java.util.Optional;
  16 import org.opendaylight.controller.cluster.datastore.node.utils.transformer.ReusableNormalizedNodePruner;
  17 import org.opendaylight.controller.cluster.datastore.util.AbstractDataTreeModificationCursor;
  18 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  19 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  20 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  21 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeWriter;
  22 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTree;
  23 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification;
  24 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModificationCursor;
  25 import org.opendaylight.yangtools.yang.data.impl.schema.tree.SchemaValidationFailedException;
  26 import org.opendaylight.yangtools.yang.data.util.DataSchemaContextTree;
  27 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  28 import org.slf4j.Logger;
  29 import org.slf4j.LoggerFactory;
  30
  31 /**
  32  * The PruningDataTreeModification first removes all entries from the data which do not belong in the schemaContext
  33  * before delegating it to the actual DataTreeModification.
  34  */
  35 public class PruningDataTreeModification extends ForwardingObject implements DataTreeModification {
  36     private static final Logger LOG = LoggerFactory.getLogger(PruningDataTreeModification.class);
  37
  38     private final ReusableNormalizedNodePruner pruner;
  39     private final DataTree dataTree;
  40
  41     private DataTreeModification delegate;
  42
  43     private PruningDataTreeModification(final DataTreeModification delegate, final DataTree dataTree,
  44             final ReusableNormalizedNodePruner pruner) {
  45         this.delegate = requireNonNull(delegate);
  46         this.dataTree = requireNonNull(dataTree);
  47         this.pruner = requireNonNull(pruner);
  48     }
  49
  50     public PruningDataTreeModification(final DataTreeModification delegate, final DataTree dataTree,
  51             final DataSchemaContextTree dataSchemaContext) {
  52         this(delegate, dataTree, ReusableNormalizedNodePruner.forDataSchemaContext(dataSchemaContext));
  53     }
  54
  55     @Override
  56     public DataTreeModification delegate() {
  57         return delegate;
  58     }
  59
  60     @Override
  61     public SchemaContext getSchemaContext() {
  62         return delegate.getSchemaContext();
  63     }
  64
  65     @Override
  66     public void delete(final YangInstanceIdentifier yangInstanceIdentifier) {
  67         try {
  68             delegate.delete(yangInstanceIdentifier);
  69         } catch (SchemaValidationFailedException e) {
  70             LOG.warn("Node at path : {} does not exist ignoring delete", yangInstanceIdentifier);
  71         }
  72     }
  73
  74     @Override
  75     public void merge(final YangInstanceIdentifier yangInstanceIdentifier, final NormalizedNode<?, ?> normalizedNode) {
  76         try {
  77             if (YangInstanceIdentifier.empty().equals(yangInstanceIdentifier)) {
  78                 pruneAndMergeNode(yangInstanceIdentifier, normalizedNode);
  79             } else {
  80                 delegate.merge(yangInstanceIdentifier, normalizedNode);
  81             }
  82         } catch (SchemaValidationFailedException e) {
  83             LOG.warn("Node at path {} was pruned during merge due to validation error: {}",
  84                     yangInstanceIdentifier, e.getMessage());
  85
  86             pruneAndMergeNode(yangInstanceIdentifier, normalizedNode);
  87         }
  88
  89     }
  90
  91     private void pruneAndMergeNode(final YangInstanceIdentifier yangInstanceIdentifier,
  92             final NormalizedNode<?, ?> normalizedNode) {
  93         NormalizedNode<?, ?> pruned = pruneNormalizedNode(yangInstanceIdentifier, normalizedNode);
  94
  95         if (pruned != null) {
  96             delegate.merge(yangInstanceIdentifier, pruned);
  97         }
  98     }
  99
 100     @Override
 101     public void write(final YangInstanceIdentifier yangInstanceIdentifier, final NormalizedNode<?, ?> normalizedNode) {
 102         try {
 103             if (YangInstanceIdentifier.empty().equals(yangInstanceIdentifier)) {
 104                 pruneAndWriteNode(yangInstanceIdentifier, normalizedNode);
 105             } else {
 106                 delegate.write(yangInstanceIdentifier, normalizedNode);
 107             }
 108         } catch (SchemaValidationFailedException e) {
 109             LOG.warn("Node at path : {} was pruned during write due to validation error: {}",
 110                     yangInstanceIdentifier, e.getMessage());
 111
 112             pruneAndWriteNode(yangInstanceIdentifier, normalizedNode);
 113         }
 114     }
 115
 116     private void pruneAndWriteNode(final YangInstanceIdentifier yangInstanceIdentifier,
 117             final NormalizedNode<?, ?> normalizedNode) {
 118         NormalizedNode<?,?> pruned = pruneNormalizedNode(yangInstanceIdentifier, normalizedNode);
 119
 120         if (pruned != null) {
 121             delegate.write(yangInstanceIdentifier, pruned);
 122         }
 123     }
 124
 125     @Override
 126     public void ready() {
 127         try {
 128             delegate.ready();
 129         } catch (SchemaValidationFailedException e) {
 130             DataTreeModification newModification = dataTree.takeSnapshot().newModification();
 131             delegate.applyToCursor(new PruningDataTreeModificationCursor(newModification, this));
 132
 133             delegate = newModification;
 134             delegate.ready();
 135         }
 136     }
 137
 138     @Override
 139     public void applyToCursor(final DataTreeModificationCursor dataTreeModificationCursor) {
 140         delegate.applyToCursor(dataTreeModificationCursor);
 141     }
 142
 143     @Override
 144     public Optional<NormalizedNode<?, ?>> readNode(final YangInstanceIdentifier yangInstanceIdentifier) {
 145         return delegate.readNode(yangInstanceIdentifier);
 146     }
 147
 148     @Override
 149     public DataTreeModification newModification() {
 150         return new PruningDataTreeModification(delegate.newModification(), dataTree, pruner.duplicate());
 151     }
 152
 153     @VisibleForTesting
 154     NormalizedNode<?, ?> pruneNormalizedNode(final YangInstanceIdentifier path, final NormalizedNode<?, ?> input) {
 155         pruner.initializeForPath(path);
 156         try {
 157             NormalizedNodeWriter.forStreamWriter(pruner).write(input);
 158         } catch (IOException ioe) {
 159             LOG.error("Unexpected IOException when pruning normalizedNode", ioe);
 160             return null;
 161         }
 162
 163         return pruner.getResult().orElse(null);
 164     }
 165
 166     private static class PruningDataTreeModificationCursor extends AbstractDataTreeModificationCursor {
 167         private final DataTreeModification toModification;
 168         private final PruningDataTreeModification pruningModification;
 169
 170         PruningDataTreeModificationCursor(final DataTreeModification toModification,
 171                 final PruningDataTreeModification pruningModification) {
 172             this.toModification = toModification;
 173             this.pruningModification = pruningModification;
 174         }
 175
 176         @Override
 177         public void write(final PathArgument child, final NormalizedNode<?, ?> data) {
 178             YangInstanceIdentifier path = current().node(child);
 179             NormalizedNode<?, ?> prunedNode = pruningModification.pruneNormalizedNode(path, data);
 180             if (prunedNode != null) {
 181                 toModification.write(path, prunedNode);
 182             }
 183         }
 184
 185         @Override
 186         public void merge(final PathArgument child, final NormalizedNode<?, ?> data) {
 187             YangInstanceIdentifier path = current().node(child);
 188             NormalizedNode<?, ?> prunedNode = pruningModification.pruneNormalizedNode(path, data);
 189             if (prunedNode != null) {
 190                 toModification.merge(path, prunedNode);
 191             }
 192         }
 193
 194         @Override
 195         public void delete(final PathArgument child) {
 196             try {
 197                 toModification.delete(current().node(child));
 198             } catch (SchemaValidationFailedException e) {
 199                 // Ignoring since we would've already logged this in the call to the original modification.
 200             }
 201         }
 202     }
 203 }