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
   9 package org.opendaylight.controller.cluster.datastore.utils;
  10
  11 import com.google.common.annotations.VisibleForTesting;
  12 import com.google.common.base.Optional;
  13 import java.io.IOException;
  14 import java.net.URI;
  15 import java.util.Set;
  16 import org.opendaylight.controller.cluster.datastore.node.utils.transformer.NormalizedNodePruner;
  17 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  18 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  19 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeWriter;
  20 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification;
  21 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModificationCursor;
  22 import org.opendaylight.yangtools.yang.data.impl.schema.tree.SchemaValidationFailedException;
  23 import org.slf4j.Logger;
  24 import org.slf4j.LoggerFactory;
  25
  26 /**
  27  * The PruningDataTreeModification first removes all entries from the data which do not belong in the schemaContext
  28  * before delegating it to the actual DataTreeModification
  29  */
  30 public class PruningDataTreeModification implements DataTreeModification {
  31
  32     private static final Logger LOG = LoggerFactory.getLogger(PruningDataTreeModification.class);
  33     private final DataTreeModification delegate;
  34     private final Set<URI> validNamespaces;
  35
  36     public PruningDataTreeModification(DataTreeModification delegate, Set<URI> validNamespaces) {
  37         this.delegate = delegate;
  38         this.validNamespaces = validNamespaces;
  39     }
  40
  41     @Override
  42     public void delete(YangInstanceIdentifier yangInstanceIdentifier) {
  43         try {
  44             delegate.delete(yangInstanceIdentifier);
  45         } catch(SchemaValidationFailedException e){
  46             LOG.warn("Node at path : {} does not exist ignoring delete", yangInstanceIdentifier);
  47         }
  48     }
  49
  50     @Override
  51     public void merge(YangInstanceIdentifier yangInstanceIdentifier, NormalizedNode<?, ?> normalizedNode) {
  52         try {
  53             delegate.merge(yangInstanceIdentifier, normalizedNode);
  54         } catch (SchemaValidationFailedException e){
  55             if(!isValidYangInstanceIdentifier(yangInstanceIdentifier)){
  56                 LOG.warn("Invalid node identifier {} ignoring merge", yangInstanceIdentifier);
  57                 return;
  58             }
  59
  60             LOG.warn("Node at path : {} was pruned during merge", yangInstanceIdentifier);
  61
  62             NormalizedNode<?,?> pruned = pruneNormalizedNode(normalizedNode);
  63
  64             if(pruned != null) {
  65                 delegate.merge(yangInstanceIdentifier, pruned);
  66             }
  67         }
  68
  69     }
  70
  71     @Override
  72     public void write(YangInstanceIdentifier yangInstanceIdentifier, NormalizedNode<?, ?> normalizedNode) {
  73         try {
  74             delegate.write(yangInstanceIdentifier, normalizedNode);
  75         } catch (SchemaValidationFailedException e){
  76             if(!isValidYangInstanceIdentifier(yangInstanceIdentifier)){
  77                 LOG.warn("Invalid node identifier {} ignoring write", yangInstanceIdentifier);
  78                 return;
  79             }
  80
  81             LOG.warn("Node at path : {} was pruned during write", yangInstanceIdentifier);
  82
  83             NormalizedNode<?,?> pruned = pruneNormalizedNode(normalizedNode);
  84
  85             if(pruned != null) {
  86                 delegate.write(yangInstanceIdentifier, pruned);
  87             }
  88         }
  89     }
  90
  91     @Override
  92     public void ready() {
  93         delegate.ready();
  94     }
  95
  96     @Override
  97     public void applyToCursor(DataTreeModificationCursor dataTreeModificationCursor) {
  98         delegate.applyToCursor(dataTreeModificationCursor);
  99     }
 100
 101     @Override
 102     public Optional<NormalizedNode<?, ?>> readNode(YangInstanceIdentifier yangInstanceIdentifier) {
 103         return delegate.readNode(yangInstanceIdentifier);
 104     }
 105
 106     @Override
 107     public DataTreeModification newModification() {
 108         return new PruningDataTreeModification(delegate.newModification(), validNamespaces);
 109     }
 110
 111     @VisibleForTesting
 112     NormalizedNode<?, ?> pruneNormalizedNode(NormalizedNode<?,?> input){
 113         NormalizedNodePruner pruner = new NormalizedNodePruner(validNamespaces);
 114         try {
 115             NormalizedNodeWriter.forStreamWriter(pruner).write(input);
 116         } catch (IOException ioe) {
 117             LOG.error("Unexpected IOException when pruning normalizedNode", ioe);
 118         }
 119
 120         return pruner.normalizedNode();
 121     }
 122
 123     public DataTreeModification getDelegate(){
 124         return delegate;
 125     }
 126
 127     private boolean isValidYangInstanceIdentifier(YangInstanceIdentifier instanceIdentifier){
 128         for(YangInstanceIdentifier.PathArgument pathArgument : instanceIdentifier.getPathArguments()){
 129             if(!validNamespaces.contains(pathArgument.getNodeType().getNamespace())){
 130                 return false;
 131             }
 132         }
 133
 134         return true;
 135     }
 136
 137 }