2 * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.controller.cluster.datastore.utils;
10 import static java.util.Objects.requireNonNull;
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;
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.
35 public class PruningDataTreeModification extends ForwardingObject implements DataTreeModification {
36 private static final Logger LOG = LoggerFactory.getLogger(PruningDataTreeModification.class);
38 private final ReusableNormalizedNodePruner pruner;
39 private final DataTree dataTree;
41 private DataTreeModification delegate;
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);
50 public PruningDataTreeModification(final DataTreeModification delegate, final DataTree dataTree,
51 final SchemaContext schemaContext) {
52 this(delegate, dataTree, ReusableNormalizedNodePruner.forSchemaContext(schemaContext));
55 public PruningDataTreeModification(final DataTreeModification delegate, final DataTree dataTree,
56 final DataSchemaContextTree dataSchemaContext) {
57 this(delegate, dataTree, ReusableNormalizedNodePruner.forDataSchemaContext(dataSchemaContext));
61 public DataTreeModification delegate() {
66 public void delete(final YangInstanceIdentifier yangInstanceIdentifier) {
68 delegate.delete(yangInstanceIdentifier);
69 } catch (SchemaValidationFailedException e) {
70 LOG.warn("Node at path : {} does not exist ignoring delete", yangInstanceIdentifier);
75 public void merge(final YangInstanceIdentifier yangInstanceIdentifier, final NormalizedNode<?, ?> normalizedNode) {
77 if (YangInstanceIdentifier.EMPTY.equals(yangInstanceIdentifier)) {
78 pruneAndMergeNode(yangInstanceIdentifier, normalizedNode);
80 delegate.merge(yangInstanceIdentifier, normalizedNode);
82 } catch (SchemaValidationFailedException e) {
83 LOG.warn("Node at path {} was pruned during merge due to validation error: {}",
84 yangInstanceIdentifier, e.getMessage());
86 pruneAndMergeNode(yangInstanceIdentifier, normalizedNode);
91 private void pruneAndMergeNode(final YangInstanceIdentifier yangInstanceIdentifier,
92 final NormalizedNode<?, ?> normalizedNode) {
93 NormalizedNode<?, ?> pruned = pruneNormalizedNode(yangInstanceIdentifier, normalizedNode);
96 delegate.merge(yangInstanceIdentifier, pruned);
101 public void write(final YangInstanceIdentifier yangInstanceIdentifier, final NormalizedNode<?, ?> normalizedNode) {
103 if (YangInstanceIdentifier.EMPTY.equals(yangInstanceIdentifier)) {
104 pruneAndWriteNode(yangInstanceIdentifier, normalizedNode);
106 delegate.write(yangInstanceIdentifier, normalizedNode);
108 } catch (SchemaValidationFailedException e) {
109 LOG.warn("Node at path : {} was pruned during write due to validation error: {}",
110 yangInstanceIdentifier, e.getMessage());
112 pruneAndWriteNode(yangInstanceIdentifier, normalizedNode);
116 private void pruneAndWriteNode(final YangInstanceIdentifier yangInstanceIdentifier,
117 final NormalizedNode<?, ?> normalizedNode) {
118 NormalizedNode<?,?> pruned = pruneNormalizedNode(yangInstanceIdentifier, normalizedNode);
120 if (pruned != null) {
121 delegate.write(yangInstanceIdentifier, pruned);
126 public void ready() {
129 } catch (SchemaValidationFailedException e) {
130 DataTreeModification newModification = dataTree.takeSnapshot().newModification();
131 delegate.applyToCursor(new PruningDataTreeModificationCursor(newModification, this));
133 delegate = newModification;
139 public void applyToCursor(final DataTreeModificationCursor dataTreeModificationCursor) {
140 delegate.applyToCursor(dataTreeModificationCursor);
144 public Optional<NormalizedNode<?, ?>> readNode(final YangInstanceIdentifier yangInstanceIdentifier) {
145 return delegate.readNode(yangInstanceIdentifier);
149 public DataTreeModification newModification() {
150 return new PruningDataTreeModification(delegate.newModification(), dataTree, pruner.duplicate());
154 NormalizedNode<?, ?> pruneNormalizedNode(final YangInstanceIdentifier path, final NormalizedNode<?, ?> input) {
155 pruner.initializeForPath(path);
157 NormalizedNodeWriter.forStreamWriter(pruner).write(input);
158 } catch (IOException ioe) {
159 LOG.error("Unexpected IOException when pruning normalizedNode", ioe);
163 return pruner.getResult().orElse(null);
166 private static class PruningDataTreeModificationCursor extends AbstractDataTreeModificationCursor {
167 private final DataTreeModification toModification;
168 private final PruningDataTreeModification pruningModification;
170 PruningDataTreeModificationCursor(final DataTreeModification toModification,
171 final PruningDataTreeModification pruningModification) {
172 this.toModification = toModification;
173 this.pruningModification = pruningModification;
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);
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);
195 public void delete(final PathArgument child) {
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.