opendaylight/md-sal/sal-clustering-commons/src/main/java/org/opendaylight/controller/cluster/datastore/node/utils/transformer/AbstractNormalizedNodePruner.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.node.utils.transformer;
   9
  10 import static com.google.common.base.Preconditions.checkState;
  11 import static com.google.common.base.Verify.verify;
  12 import static java.util.Objects.requireNonNull;
  13
  14 import java.io.IOException;
  15 import java.util.ArrayDeque;
  16 import java.util.Deque;
  17 import java.util.NoSuchElementException;
  18 import java.util.Optional;
  19 import javax.xml.transform.dom.DOMSource;
  20 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  21 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
  22 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  23 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  24 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
  25 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  26 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  27 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  28 import org.opendaylight.yangtools.yang.data.impl.schema.ReusableImmutableNormalizedNodeStreamWriter;
  29 import org.opendaylight.yangtools.yang.data.util.DataSchemaContextNode;
  30 import org.opendaylight.yangtools.yang.data.util.DataSchemaContextTree;
  31 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  32 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  33 import org.slf4j.Logger;
  34 import org.slf4j.LoggerFactory;
  35
  36 /**
  37  * The NormalizedNodePruner removes all nodes from the input NormalizedNode that do not have a corresponding
  38  * schema element in the passed in SchemaContext.
  39  */
  40 abstract class AbstractNormalizedNodePruner implements NormalizedNodeStreamWriter {
  41     enum State {
  42         UNITIALIZED,
  43         OPEN,
  44         CLOSED;
  45     }
  46
  47     @FunctionalInterface
  48     interface WriterMethod<T extends PathArgument> {
  49
  50         void apply(ReusableImmutableNormalizedNodeStreamWriter writer, T name) throws IOException;
  51     }
  52
  53     @FunctionalInterface
  54     interface SizedWriterMethod<T extends PathArgument> {
  55
  56         void apply(ReusableImmutableNormalizedNodeStreamWriter writer, T name, int childSizeHint) throws IOException;
  57     }
  58
  59     private static final Logger LOG = LoggerFactory.getLogger(AbstractNormalizedNodePruner.class);
  60
  61     private final Deque<DataSchemaContextNode<?>> stack = new ArrayDeque<>();
  62     private final ReusableImmutableNormalizedNodeStreamWriter delegate =
  63             ReusableImmutableNormalizedNodeStreamWriter.create();
  64     private final DataSchemaContextTree tree;
  65
  66     private DataSchemaContextNode<?> nodePathSchemaNode;
  67     private NormalizedNode normalizedNode;
  68     private State state = State.UNITIALIZED;
  69     private int unknown;
  70
  71     AbstractNormalizedNodePruner(final DataSchemaContextTree tree) {
  72         this.tree = requireNonNull(tree);
  73     }
  74
  75     AbstractNormalizedNodePruner(final EffectiveModelContext schemaContext) {
  76         this(DataSchemaContextTree.from(schemaContext));
  77     }
  78
  79     final DataSchemaContextTree getTree() {
  80         return tree;
  81     }
  82
  83     final void initialize(final YangInstanceIdentifier nodePath) {
  84         nodePathSchemaNode = tree.findChild(nodePath).orElse(null);
  85         unknown = 0;
  86         normalizedNode = null;
  87         stack.clear();
  88         delegate.reset();
  89         state = State.OPEN;
  90     }
  91
  92     @Override
  93     public final void startLeafNode(final NodeIdentifier name) throws IOException {
  94         enter(ReusableImmutableNormalizedNodeStreamWriter::startLeafNode, name);
  95     }
  96
  97     @Override
  98     public final void startLeafSet(final NodeIdentifier name, final int childSizeHint) throws IOException {
  99         enter(ReusableImmutableNormalizedNodeStreamWriter::startLeafSet, name, childSizeHint);
 100     }
 101
 102     @Override
 103     public final void startOrderedLeafSet(final NodeIdentifier name, final int childSizeHint) throws IOException {
 104         enter(ReusableImmutableNormalizedNodeStreamWriter::startOrderedLeafSet, name, childSizeHint);
 105     }
 106
 107     @Override
 108     public void startLeafSetEntryNode(final NodeWithValue<?> name) throws IOException {
 109         enter(ReusableImmutableNormalizedNodeStreamWriter::startLeafSetEntryNode, name);
 110     }
 111
 112     @Override
 113     public final void startContainerNode(final NodeIdentifier name, final int childSizeHint) throws IOException {
 114         enter(ReusableImmutableNormalizedNodeStreamWriter::startContainerNode, name, childSizeHint);
 115     }
 116
 117     @Override
 118     public final void startUnkeyedList(final NodeIdentifier name, final int childSizeHint) throws IOException {
 119         enter(ReusableImmutableNormalizedNodeStreamWriter::startUnkeyedList, name, childSizeHint);
 120     }
 121
 122     @Override
 123     public final void startUnkeyedListItem(final NodeIdentifier name, final int childSizeHint) throws IOException {
 124         enter(ReusableImmutableNormalizedNodeStreamWriter::startUnkeyedListItem, name, childSizeHint);
 125     }
 126
 127     @Override
 128     public final void startMapNode(final NodeIdentifier name, final int childSizeHint) throws IOException {
 129         enter(ReusableImmutableNormalizedNodeStreamWriter::startMapNode, name, childSizeHint);
 130     }
 131
 132     @Override
 133     public void startMapEntryNode(final NodeIdentifierWithPredicates identifier, final int childSizeHint)
 134             throws IOException {
 135         enter(ReusableImmutableNormalizedNodeStreamWriter::startMapEntryNode, identifier, childSizeHint);
 136     }
 137
 138     @Override
 139     public final void startOrderedMapNode(final NodeIdentifier name, final int childSizeHint) throws IOException {
 140         enter(ReusableImmutableNormalizedNodeStreamWriter::startOrderedMapNode, name, childSizeHint);
 141     }
 142
 143     @Override
 144     public final void startChoiceNode(final NodeIdentifier name, final int childSizeHint) throws IOException {
 145         enter(ReusableImmutableNormalizedNodeStreamWriter::startChoiceNode, name, childSizeHint);
 146     }
 147
 148     @Override
 149     public final void startAugmentationNode(final AugmentationIdentifier identifier) throws IOException {
 150         enter(ReusableImmutableNormalizedNodeStreamWriter::startAugmentationNode, identifier);
 151     }
 152
 153     @Override
 154     public final  boolean startAnyxmlNode(final NodeIdentifier name, final Class<?> objectModel) throws IOException {
 155         if (enter(name)) {
 156             verify(delegate.startAnyxmlNode(name, objectModel),
 157                 "Unexpected failure to stream DOMSource node %s model %s", name, objectModel);
 158         }
 159         return true;
 160     }
 161
 162     @Override
 163     public final boolean startAnydataNode(final NodeIdentifier name, final Class<?> objectModel) throws IOException {
 164         // FIXME: we do not support anydata nodes yet
 165         return false;
 166     }
 167
 168     @Override
 169     public final  void domSourceValue(final DOMSource value) throws IOException {
 170         checkNotSealed();
 171         if (unknown == 0) {
 172             delegate.domSourceValue(value);
 173         }
 174     }
 175
 176     @Override
 177     public final void scalarValue(final Object value) throws IOException {
 178         checkNotSealed();
 179         if (unknown == 0) {
 180             delegate.scalarValue(translateScalar(currentSchema(), value));
 181         }
 182     }
 183
 184     Object translateScalar(final DataSchemaContextNode<?> context, final Object value) throws IOException {
 185         // Default is pass-through
 186         return value;
 187     }
 188
 189     @Override
 190     public final void endNode() throws IOException {
 191         checkNotSealed();
 192
 193         if (unknown == 0) {
 194             try {
 195                 stack.pop();
 196             } catch (NoSuchElementException e) {
 197                 throw new IllegalStateException("endNode called on an empty stack", e);
 198             }
 199             delegate.endNode();
 200         } else {
 201             unknown--;
 202             if (unknown != 0) {
 203                 // Still at unknown, do not attempt to create result
 204                 return;
 205             }
 206         }
 207
 208         if (stack.isEmpty()) {
 209             normalizedNode = delegate.getResult();
 210             state = State.CLOSED;
 211         }
 212     }
 213
 214     @Override
 215     public final void close() throws IOException {
 216         state = State.CLOSED;
 217         stack.clear();
 218         delegate.close();
 219     }
 220
 221     @Override
 222     public final void flush() throws IOException {
 223         delegate.flush();
 224     }
 225
 226     /**
 227      * Return the resulting normalized node.
 228      *
 229      * @return Resulting node for the path, if it was not pruned
 230      * @throws IllegalStateException if this pruner has not been closed
 231      */
 232     public final Optional<NormalizedNode> getResult() {
 233         checkState(state == State.CLOSED, "Cannot get result in state %s", state);
 234         return Optional.ofNullable(normalizedNode);
 235     }
 236
 237     private void checkNotSealed() {
 238         checkState(state == State.OPEN, "Illegal operation in state %s", state);
 239     }
 240
 241     private boolean enter(final PathArgument name) {
 242         checkNotSealed();
 243
 244         if (unknown != 0) {
 245             LOG.debug("Skipping child {} in unknown subtree", name);
 246             unknown++;
 247             return false;
 248         }
 249
 250         final DataSchemaContextNode<?> schema;
 251         final DataSchemaContextNode<?> parent = currentSchema();
 252         if (parent != null) {
 253             schema = parent.getChild(name);
 254         } else {
 255             schema = nodePathSchemaNode;
 256         }
 257
 258         if (schema == null) {
 259             LOG.debug("Schema not found for {}", name);
 260             unknown = 1;
 261             return false;
 262         }
 263
 264         stack.push(schema);
 265         final DataSchemaNode dataSchema = schema.getDataSchemaNode();
 266         if (dataSchema != null) {
 267             delegate.nextDataSchemaNode(dataSchema);
 268         }
 269         return true;
 270     }
 271
 272     final <A extends PathArgument> void enter(final WriterMethod<A> method, final A name) throws IOException {
 273         if (enter(name)) {
 274             method.apply(delegate, name);
 275         }
 276     }
 277
 278     final <A extends PathArgument> void enter(final SizedWriterMethod<A> method, final A name, final int size)
 279             throws IOException {
 280         if (enter(name)) {
 281             method.apply(delegate, name, size);
 282         }
 283     }
 284
 285     final DataSchemaContextNode<?> currentSchema() {
 286         return stack.peek();
 287     }
 288 }