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 SchemaContext schemaContext) {
  52         this(delegate, dataTree, ReusableNormalizedNodePruner.forSchemaContext(schemaContext));
  53     }
  54
  55     public PruningDataTreeModification(final DataTreeModification delegate, final DataTree dataTree,
  56             final DataSchemaContextTree dataSchemaContext) {
  57         this(delegate, dataTree, ReusableNormalizedNodePruner.forDataSchemaContext(dataSchemaContext));
  58     }
  59
  60     @Override
  61     public DataTreeModification delegate() {
  62         return delegate;
  63     }
  64
  65     @Override
  66     public SchemaContext getSchemaContext() {
  67         return delegate.getSchemaContext();
  68     }
  69
  70     @Override
  71     public void delete(final YangInstanceIdentifier yangInstanceIdentifier) {
  72         try {
  73             delegate.delete(yangInstanceIdentifier);
  74         } catch (SchemaValidationFailedException e) {
  75             LOG.warn("Node at path : {} does not exist ignoring delete", yangInstanceIdentifier);
  76         }
  77     }
  78
  79     @Override
  80     public void merge(final YangInstanceIdentifier yangInstanceIdentifier, final NormalizedNode<?, ?> normalizedNode) {
  81         try {
  82             if (YangInstanceIdentifier.empty().equals(yangInstanceIdentifier)) {
  83                 pruneAndMergeNode(yangInstanceIdentifier, normalizedNode);
  84             } else {
  85                 delegate.merge(yangInstanceIdentifier, normalizedNode);
  86             }
  87         } catch (SchemaValidationFailedException e) {
  88             LOG.warn("Node at path {} was pruned during merge due to validation error: {}",
  89                     yangInstanceIdentifier, e.getMessage());
  90
  91             pruneAndMergeNode(yangInstanceIdentifier, normalizedNode);
  92         }
  93
  94     }
  95
  96     private void pruneAndMergeNode(final YangInstanceIdentifier yangInstanceIdentifier,
  97             final NormalizedNode<?, ?> normalizedNode) {
  98         NormalizedNode<?, ?> pruned = pruneNormalizedNode(yangInstanceIdentifier, normalizedNode);
  99
 100         if (pruned != null) {
 101             delegate.merge(yangInstanceIdentifier, pruned);
 102         }
 103     }
 104
 105     @Override
 106     public void write(final YangInstanceIdentifier yangInstanceIdentifier, final NormalizedNode<?, ?> normalizedNode) {
 107         try {
 108             if (YangInstanceIdentifier.empty().equals(yangInstanceIdentifier)) {
 109                 pruneAndWriteNode(yangInstanceIdentifier, normalizedNode);
 110             } else {
 111                 delegate.write(yangInstanceIdentifier, normalizedNode);
 112             }
 113         } catch (SchemaValidationFailedException e) {
 114             LOG.warn("Node at path : {} was pruned during write due to validation error: {}",
 115                     yangInstanceIdentifier, e.getMessage());
 116
 117             pruneAndWriteNode(yangInstanceIdentifier, normalizedNode);
 118         }
 119     }
 120
 121     private void pruneAndWriteNode(final YangInstanceIdentifier yangInstanceIdentifier,
 122             final NormalizedNode<?, ?> normalizedNode) {
 123         NormalizedNode<?,?> pruned = pruneNormalizedNode(yangInstanceIdentifier, normalizedNode);
 124
 125         if (pruned != null) {
 126             delegate.write(yangInstanceIdentifier, pruned);
 127         }
 128     }
 129
 130     @Override
 131     public void ready() {
 132         try {
 133             delegate.ready();
 134         } catch (SchemaValidationFailedException e) {
 135             DataTreeModification newModification = dataTree.takeSnapshot().newModification();
 136             delegate.applyToCursor(new PruningDataTreeModificationCursor(newModification, this));
 137
 138             delegate = newModification;
 139             delegate.ready();
 140         }
 141     }
 142
 143     @Override
 144     public void applyToCursor(final DataTreeModificationCursor dataTreeModificationCursor) {
 145         delegate.applyToCursor(dataTreeModificationCursor);
 146     }
 147
 148     @Override
 149     public Optional<NormalizedNode<?, ?>> readNode(final YangInstanceIdentifier yangInstanceIdentifier) {
 150         return delegate.readNode(yangInstanceIdentifier);
 151     }
 152
 153     @Override
 154     public DataTreeModification newModification() {
 155         return new PruningDataTreeModification(delegate.newModification(), dataTree, pruner.duplicate());
 156     }
 157
 158     @VisibleForTesting
 159     NormalizedNode<?, ?> pruneNormalizedNode(final YangInstanceIdentifier path, final NormalizedNode<?, ?> input) {
 160         pruner.initializeForPath(path);
 161         try {
 162             NormalizedNodeWriter.forStreamWriter(pruner).write(input);
 163         } catch (IOException ioe) {
 164             LOG.error("Unexpected IOException when pruning normalizedNode", ioe);
 165             return null;
 166         }
 167
 168         return pruner.getResult().orElse(null);
 169     }
 170
 171     private static class PruningDataTreeModificationCursor extends AbstractDataTreeModificationCursor {
 172         private final DataTreeModification toModification;
 173         private final PruningDataTreeModification pruningModification;
 174
 175         PruningDataTreeModificationCursor(final DataTreeModification toModification,
 176                 final PruningDataTreeModification pruningModification) {
 177             this.toModification = toModification;
 178             this.pruningModification = pruningModification;
 179         }
 180
 181         @Override
 182         public void write(final PathArgument child, final NormalizedNode<?, ?> data) {
 183             YangInstanceIdentifier path = current().node(child);
 184             NormalizedNode<?, ?> prunedNode = pruningModification.pruneNormalizedNode(path, data);
 185             if (prunedNode != null) {
 186                 toModification.write(path, prunedNode);
 187             }
 188         }
 189
 190         @Override
 191         public void merge(final PathArgument child, final NormalizedNode<?, ?> data) {
 192             YangInstanceIdentifier path = current().node(child);
 193             NormalizedNode<?, ?> prunedNode = pruningModification.pruneNormalizedNode(path, data);
 194             if (prunedNode != null) {
 195                 toModification.merge(path, prunedNode);
 196             }
 197         }
 198
 199         @Override
 200         public void delete(final PathArgument child) {
 201             try {
 202                 toModification.delete(current().node(child));
 203             } catch (SchemaValidationFailedException e) {
 204                 // Ignoring since we would've already logged this in the call to the original modification.
 205             }
 206         }
 207     }
 208 }