* terms of the Eclipse Public License v1.0 which accompanies this distribution,
* and is available at http://www.eclipse.org/legal/epl-v10.html
*/
-
package org.opendaylight.controller.cluster.datastore.utils;
+import static java.util.Objects.requireNonNull;
+
import com.google.common.annotations.VisibleForTesting;
-import com.google.common.base.Optional;
-import com.google.common.base.Preconditions;
+import com.google.common.collect.ForwardingObject;
import java.io.IOException;
-import java.util.ArrayDeque;
-import java.util.Deque;
-import javax.annotation.Nonnull;
-import org.opendaylight.controller.cluster.datastore.node.utils.transformer.NormalizedNodePruner;
+import java.util.Optional;
+import org.opendaylight.controller.cluster.datastore.node.utils.transformer.ReusableNormalizedNodePruner;
+import org.opendaylight.controller.cluster.datastore.util.AbstractDataTreeModificationCursor;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
/**
* The PruningDataTreeModification first removes all entries from the data which do not belong in the schemaContext
- * before delegating it to the actual DataTreeModification
+ * before delegating it to the actual DataTreeModification.
*/
-public class PruningDataTreeModification implements DataTreeModification {
+public abstract class PruningDataTreeModification extends ForwardingObject implements DataTreeModification {
+ /**
+ * A PruningDataTreeModification which always performs pruning before attempting an operation. This sacrifices
+ * performance to ensure all data has passed through the pruner -- such that data adaptations are performed.
+ */
+ public static final class Proactive extends PruningDataTreeModification {
+ public Proactive(final DataTreeModification delegate, final DataTree dataTree,
+ final ReusableNormalizedNodePruner pruner) {
+ super(delegate, dataTree, pruner);
+ }
- private static final Logger LOG = LoggerFactory.getLogger(PruningDataTreeModification.class);
- private DataTreeModification delegate;
- private final SchemaContext schemaContext;
- private final DataTree dataTree;
+ @Override
+ public void merge(final YangInstanceIdentifier path, final NormalizedNode<?, ?> data) {
+ pruneAndMergeNode(path, data);
+ }
- public PruningDataTreeModification(DataTreeModification delegate, DataTree dataTree, SchemaContext schemaContext) {
- this.delegate = delegate;
- this.dataTree = dataTree;
- this.schemaContext = schemaContext;
- }
+ @Override
+ public void write(final YangInstanceIdentifier path, final NormalizedNode<?, ?> data) {
+ pruneAndWriteNode(path, data);
+ }
- @Override
- public void delete(YangInstanceIdentifier yangInstanceIdentifier) {
- try {
- delegate.delete(yangInstanceIdentifier);
- } catch(SchemaValidationFailedException e){
- LOG.warn("Node at path : {} does not exist ignoring delete", yangInstanceIdentifier);
+ @Override
+ PruningDataTreeModification createNew(final DataTreeModification delegate, final DataTree dataTree,
+ final ReusableNormalizedNodePruner pruner) {
+ return new Proactive(delegate, dataTree, pruner);
}
}
- @Override
- public void merge(YangInstanceIdentifier yangInstanceIdentifier, NormalizedNode<?, ?> normalizedNode) {
- try {
- if(YangInstanceIdentifier.EMPTY.equals(yangInstanceIdentifier)){
- pruneAndMergeNode(yangInstanceIdentifier, normalizedNode);
- } else {
- delegate.merge(yangInstanceIdentifier, normalizedNode);
+ /**
+ * A PruningDataTreeModification which performs pruning only when an operation results in an
+ * {@link SchemaValidationFailedException}. This offers superior performance in the normal case of not needing
+ * pruning.
+ */
+ public static final class Reactive extends PruningDataTreeModification {
+ public Reactive(final DataTreeModification delegate, final DataTree dataTree,
+ final ReusableNormalizedNodePruner pruner) {
+ super(delegate, dataTree, pruner);
+ }
+
+ @Override
+ public void merge(final YangInstanceIdentifier path, final NormalizedNode<?, ?> data) {
+ if (path.isEmpty()) {
+ pruneAndMergeNode(path, data);
+ return;
}
- } catch (SchemaValidationFailedException e){
- LOG.warn("Node at path {} was pruned during merge due to validation error: {}",
- yangInstanceIdentifier, e.getMessage());
- pruneAndMergeNode(yangInstanceIdentifier, normalizedNode);
+ try {
+ delegate().merge(path, data);
+ } catch (SchemaValidationFailedException e) {
+ LOG.warn("Node at path {} was pruned during merge due to validation error: {}", path, e.getMessage());
+ pruneAndMergeNode(path, data);
+ }
}
- }
+ @Override
+ public void write(final YangInstanceIdentifier path, final NormalizedNode<?, ?> data) {
+ if (path.isEmpty()) {
+ pruneAndWriteNode(path, data);
+ return;
+ }
- private void pruneAndMergeNode(YangInstanceIdentifier yangInstanceIdentifier, NormalizedNode<?, ?> normalizedNode) {
- NormalizedNode<?,?> pruned = pruneNormalizedNode(yangInstanceIdentifier, normalizedNode);
+ try {
+ delegate().write(path, data);
+ } catch (SchemaValidationFailedException e) {
+ LOG.warn("Node at path : {} was pruned during write due to validation error: {}", path, e.getMessage());
+ pruneAndWriteNode(path, data);
+ }
+ }
- if(pruned != null) {
- delegate.merge(yangInstanceIdentifier, pruned);
+ @Override
+ PruningDataTreeModification createNew(final DataTreeModification delegate, final DataTree dataTree,
+ final ReusableNormalizedNodePruner pruner) {
+ return new Reactive(delegate, dataTree, pruner);
}
}
+ private static final Logger LOG = LoggerFactory.getLogger(PruningDataTreeModification.class);
+
+ private final ReusableNormalizedNodePruner pruner;
+ private final DataTree dataTree;
+
+ private DataTreeModification delegate;
+
+ PruningDataTreeModification(final DataTreeModification delegate, final DataTree dataTree,
+ final ReusableNormalizedNodePruner pruner) {
+ this.delegate = requireNonNull(delegate);
+ this.dataTree = requireNonNull(dataTree);
+ this.pruner = requireNonNull(pruner);
+ }
+
@Override
- public void write(YangInstanceIdentifier yangInstanceIdentifier, NormalizedNode<?, ?> normalizedNode) {
- try {
- if(YangInstanceIdentifier.EMPTY.equals(yangInstanceIdentifier)){
- pruneAndWriteNode(yangInstanceIdentifier, normalizedNode);
- } else {
- delegate.write(yangInstanceIdentifier, normalizedNode);
- }
- } catch (SchemaValidationFailedException e){
- LOG.warn("Node at path : {} was pruned during write due to validation error: {}",
- yangInstanceIdentifier, e.getMessage());
+ protected final DataTreeModification delegate() {
+ return delegate;
+ }
+
+ @Override
+ public final SchemaContext getSchemaContext() {
+ return delegate.getSchemaContext();
+ }
- pruneAndWriteNode(yangInstanceIdentifier, normalizedNode);
+ @Override
+ public final void delete(final YangInstanceIdentifier path) {
+ try {
+ delegate.delete(path);
+ } catch (SchemaValidationFailedException e) {
+ LOG.warn("Node at path : {} does not exist ignoring delete", path);
}
}
- private void pruneAndWriteNode(YangInstanceIdentifier yangInstanceIdentifier, NormalizedNode<?, ?> normalizedNode) {
- NormalizedNode<?,?> pruned = pruneNormalizedNode(yangInstanceIdentifier, normalizedNode);
+ final void pruneAndMergeNode(final YangInstanceIdentifier path, final NormalizedNode<?, ?> data) {
+ final NormalizedNode<?, ?> pruned = pruneNormalizedNode(path, data);
+ if (pruned != null) {
+ delegate.merge(path, pruned);
+ }
+ }
- if(pruned != null) {
- delegate.write(yangInstanceIdentifier, pruned);
+ final void pruneAndWriteNode(final YangInstanceIdentifier path, final NormalizedNode<?, ?> data) {
+ final NormalizedNode<?, ?> pruned = pruneNormalizedNode(path, data);
+ if (pruned != null) {
+ delegate.write(path, pruned);
}
}
@Override
- public void ready() {
+ public final void ready() {
try {
delegate.ready();
} catch (SchemaValidationFailedException e) {
}
@Override
- public void applyToCursor(DataTreeModificationCursor dataTreeModificationCursor) {
+ public final void applyToCursor(final DataTreeModificationCursor dataTreeModificationCursor) {
delegate.applyToCursor(dataTreeModificationCursor);
}
@Override
- public Optional<NormalizedNode<?, ?>> readNode(YangInstanceIdentifier yangInstanceIdentifier) {
+ public final Optional<NormalizedNode<?, ?>> readNode(final YangInstanceIdentifier yangInstanceIdentifier) {
return delegate.readNode(yangInstanceIdentifier);
}
@Override
- public DataTreeModification newModification() {
- return new PruningDataTreeModification(delegate.newModification(), dataTree, schemaContext);
+ public final DataTreeModification newModification() {
+ return createNew(delegate.newModification(), dataTree, pruner.duplicate());
}
@VisibleForTesting
- NormalizedNode<?, ?> pruneNormalizedNode(YangInstanceIdentifier path, NormalizedNode<?,?> input) {
- NormalizedNodePruner pruner = new NormalizedNodePruner(path, schemaContext);
+ final NormalizedNode<?, ?> pruneNormalizedNode(final YangInstanceIdentifier path,
+ final NormalizedNode<?, ?> input) {
+ pruner.initializeForPath(path);
try {
NormalizedNodeWriter.forStreamWriter(pruner).write(input);
} catch (IOException ioe) {
LOG.error("Unexpected IOException when pruning normalizedNode", ioe);
+ return null;
}
- return pruner.normalizedNode();
+ return pruner.getResult().orElse(null);
}
- public DataTreeModification getResultingModification(){
- return delegate;
- }
+ abstract PruningDataTreeModification createNew(DataTreeModification delegate, DataTree dataTree,
+ ReusableNormalizedNodePruner pruner);
- private static class PruningDataTreeModificationCursor implements DataTreeModificationCursor {
- private final Deque<YangInstanceIdentifier> stack = new ArrayDeque<>();
+ private static final class PruningDataTreeModificationCursor extends AbstractDataTreeModificationCursor {
private final DataTreeModification toModification;
private final PruningDataTreeModification pruningModification;
- PruningDataTreeModificationCursor(DataTreeModification toModification,
- PruningDataTreeModification pruningModification) {
+ PruningDataTreeModificationCursor(final DataTreeModification toModification,
+ final PruningDataTreeModification pruningModification) {
this.toModification = toModification;
this.pruningModification = pruningModification;
- stack.push(YangInstanceIdentifier.EMPTY);
}
@Override
- public void write(PathArgument child, NormalizedNode<?, ?> data) {
- YangInstanceIdentifier path = stack.peek().node(child);
- NormalizedNode<?, ?> prunedNode = pruningModification.pruneNormalizedNode(path, data);
- if(prunedNode != null) {
+ public void write(final PathArgument child, final NormalizedNode<?, ?> data) {
+ final YangInstanceIdentifier path = current().node(child);
+ final NormalizedNode<?, ?> prunedNode = pruningModification.pruneNormalizedNode(path, data);
+ if (prunedNode != null) {
toModification.write(path, prunedNode);
}
}
@Override
- public void merge(PathArgument child, NormalizedNode<?, ?> data) {
- YangInstanceIdentifier path = stack.peek().node(child);
- NormalizedNode<?, ?> prunedNode = pruningModification.pruneNormalizedNode(path, data);
- if(prunedNode != null) {
+ public void merge(final PathArgument child, final NormalizedNode<?, ?> data) {
+ final YangInstanceIdentifier path = current().node(child);
+ final NormalizedNode<?, ?> prunedNode = pruningModification.pruneNormalizedNode(path, data);
+ if (prunedNode != null) {
toModification.merge(path, prunedNode);
}
}
@Override
- public void delete(PathArgument child) {
+ public void delete(final PathArgument child) {
try {
- toModification.delete(stack.peek().node(child));
- } catch(SchemaValidationFailedException e) {
+ toModification.delete(current().node(child));
+ } catch (SchemaValidationFailedException e) {
// Ignoring since we would've already logged this in the call to the original modification.
}
}
-
- @Override
- public void enter(@Nonnull final PathArgument child) {
- stack.push(stack.peek().node(child));
- }
-
- @Override
- public void enter(@Nonnull final PathArgument... path) {
- for (PathArgument arg : path) {
- enter(arg);
- }
- }
-
- @Override
- public void enter(@Nonnull final Iterable<PathArgument> path) {
- for (PathArgument arg : path) {
- enter(arg);
- }
- }
-
- @Override
- public void exit() {
- stack.pop();
- }
-
- @Override
- public void exit(final int depth) {
- Preconditions.checkArgument(depth < stack.size(), "Stack holds only %s elements, cannot exit %s levels", stack.size(), depth);
- for (int i = 0; i < depth; ++i) {
- stack.pop();
- }
- }
-
- @Override
- public Optional<NormalizedNode<?, ?>> readNode(@Nonnull final PathArgument child) {
- throw new UnsupportedOperationException("Not implemented");
- }
-
- @Override
- public void close() {
- }
}
}
Code Review / controller.git / blobdiff