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