opendaylight/md-sal/sal-clustering-commons/src/main/java/org/opendaylight/controller/cluster/datastore/node/utils/stream/LithiumNormalizedNodeInputStreamReader.java

   1 /*
   2  * Copyright (c) 2014, 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.stream;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.base.Strings;
  13 import com.google.common.collect.ImmutableList;
  14 import com.google.common.collect.ImmutableList.Builder;
  15 import java.io.DataInput;
  16 import java.io.IOException;
  17 import java.io.StringReader;
  18 import java.math.BigDecimal;
  19 import java.math.BigInteger;
  20 import java.nio.charset.StandardCharsets;
  21 import java.util.ArrayList;
  22 import java.util.HashSet;
  23 import java.util.List;
  24 import java.util.Set;
  25 import javax.xml.parsers.DocumentBuilderFactory;
  26 import javax.xml.parsers.ParserConfigurationException;
  27 import javax.xml.transform.dom.DOMSource;
  28 import org.eclipse.jdt.annotation.NonNull;
  29 import org.opendaylight.controller.cluster.datastore.node.utils.QNameFactory;
  30 import org.opendaylight.yangtools.util.ImmutableOffsetMapTemplate;
  31 import org.opendaylight.yangtools.yang.common.Empty;
  32 import org.opendaylight.yangtools.yang.common.QName;
  33 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  34 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
  35 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  36 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  37 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
  38 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  39 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
  40 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
  41 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  42 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  43 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.ListNodeBuilder;
  44 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeAttrBuilder;
  45 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeContainerBuilder;
  46 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  47 import org.slf4j.Logger;
  48 import org.slf4j.LoggerFactory;
  49 import org.w3c.dom.Element;
  50 import org.xml.sax.InputSource;
  51 import org.xml.sax.SAXException;
  52
  53 /**
  54  * NormalizedNodeInputStreamReader reads the byte stream and constructs the normalized node including its children
  55  * nodes. This process goes in recursive manner, where each NodeTypes object signifies the start of the object, except
  56  * END_NODE. If a node can have children, then that node's end is calculated based on appearance of END_NODE.
  57  */
  58 class LithiumNormalizedNodeInputStreamReader extends ForwardingDataInput implements NormalizedNodeDataInput {
  59
  60     private static final Logger LOG = LoggerFactory.getLogger(LithiumNormalizedNodeInputStreamReader.class);
  61
  62     private final @NonNull DataInput input;
  63
  64     private final List<String> codedStringMap = new ArrayList<>();
  65
  66     private QName lastLeafSetQName;
  67
  68     private NormalizedNodeAttrBuilder<NodeIdentifier, Object, LeafNode<Object>> leafBuilder;
  69
  70     @SuppressWarnings("rawtypes")
  71     private NormalizedNodeAttrBuilder<NodeWithValue, Object, LeafSetEntryNode<Object>> leafSetEntryBuilder;
  72
  73     LithiumNormalizedNodeInputStreamReader(final DataInput input) {
  74         this.input = requireNonNull(input);
  75     }
  76
  77     @Override
  78     final DataInput delegate() {
  79         return input;
  80     }
  81
  82     @Override
  83     public NormalizedNodeStreamVersion getVersion() throws IOException {
  84         return NormalizedNodeStreamVersion.LITHIUM;
  85     }
  86
  87     @Override
  88     public NormalizedNode<?, ?> readNormalizedNode() throws IOException {
  89         return readNormalizedNodeInternal();
  90     }
  91
  92     private NormalizedNode<?, ?> readNormalizedNodeInternal() throws IOException {
  93         // each node should start with a byte
  94         byte nodeType = input.readByte();
  95
  96         if (nodeType == NodeTypes.END_NODE) {
  97             LOG.trace("End node reached. return");
  98             lastLeafSetQName = null;
  99             return null;
 100         }
 101
 102         switch (nodeType) {
 103             case NodeTypes.AUGMENTATION_NODE:
 104                 AugmentationIdentifier augIdentifier = readAugmentationIdentifier();
 105                 LOG.trace("Reading augmentation node {} ", augIdentifier);
 106                 return addDataContainerChildren(Builders.augmentationBuilder().withNodeIdentifier(augIdentifier))
 107                         .build();
 108
 109             case NodeTypes.LEAF_SET_ENTRY_NODE:
 110                 final QName name = lastLeafSetQName != null ? lastLeafSetQName : readQName();
 111                 final Object value = readObject();
 112                 final NodeWithValue<Object> leafIdentifier = new NodeWithValue<>(name, value);
 113                 LOG.trace("Reading leaf set entry node {}, value {}", leafIdentifier, value);
 114                 return leafSetEntryBuilder().withNodeIdentifier(leafIdentifier).withValue(value).build();
 115
 116             case NodeTypes.MAP_ENTRY_NODE:
 117                 final NodeIdentifierWithPredicates entryIdentifier = readNormalizedNodeWithPredicates();
 118                 LOG.trace("Reading map entry node {} ", entryIdentifier);
 119                 return addDataContainerChildren(Builders.mapEntryBuilder().withNodeIdentifier(entryIdentifier))
 120                         .build();
 121
 122             default:
 123                 return readNodeIdentifierDependentNode(nodeType, readNodeIdentifier());
 124         }
 125     }
 126
 127     private NormalizedNodeAttrBuilder<NodeIdentifier, Object, LeafNode<Object>> leafBuilder() {
 128         if (leafBuilder == null) {
 129             leafBuilder = Builders.leafBuilder();
 130         }
 131
 132         return leafBuilder;
 133     }
 134
 135     @SuppressWarnings("rawtypes")
 136     private NormalizedNodeAttrBuilder<NodeWithValue, Object,
 137                                       LeafSetEntryNode<Object>> leafSetEntryBuilder() {
 138         if (leafSetEntryBuilder == null) {
 139             leafSetEntryBuilder = Builders.leafSetEntryBuilder();
 140         }
 141
 142         return leafSetEntryBuilder;
 143     }
 144
 145     private NormalizedNode<?, ?> readNodeIdentifierDependentNode(final byte nodeType, final NodeIdentifier identifier)
 146         throws IOException {
 147
 148         switch (nodeType) {
 149             case NodeTypes.LEAF_NODE:
 150                 LOG.trace("Read leaf node {}", identifier);
 151                 // Read the object value
 152                 return leafBuilder().withNodeIdentifier(identifier).withValue(readObject()).build();
 153
 154             case NodeTypes.ANY_XML_NODE:
 155                 LOG.trace("Read xml node");
 156                 return Builders.anyXmlBuilder().withNodeIdentifier(identifier).withValue(readDOMSource()).build();
 157
 158             case NodeTypes.MAP_NODE:
 159                 LOG.trace("Read map node {}", identifier);
 160                 return addDataContainerChildren(Builders.mapBuilder().withNodeIdentifier(identifier)).build();
 161
 162             case NodeTypes.CHOICE_NODE:
 163                 LOG.trace("Read choice node {}", identifier);
 164                 return addDataContainerChildren(Builders.choiceBuilder().withNodeIdentifier(identifier)).build();
 165
 166             case NodeTypes.ORDERED_MAP_NODE:
 167                 LOG.trace("Reading ordered map node {}", identifier);
 168                 return addDataContainerChildren(Builders.orderedMapBuilder().withNodeIdentifier(identifier)).build();
 169
 170             case NodeTypes.UNKEYED_LIST:
 171                 LOG.trace("Read unkeyed list node {}", identifier);
 172                 return addDataContainerChildren(Builders.unkeyedListBuilder().withNodeIdentifier(identifier)).build();
 173
 174             case NodeTypes.UNKEYED_LIST_ITEM:
 175                 LOG.trace("Read unkeyed list item node {}", identifier);
 176                 return addDataContainerChildren(Builders.unkeyedListEntryBuilder()
 177                         .withNodeIdentifier(identifier)).build();
 178
 179             case NodeTypes.CONTAINER_NODE:
 180                 LOG.trace("Read container node {}", identifier);
 181                 return addDataContainerChildren(Builders.containerBuilder().withNodeIdentifier(identifier)).build();
 182
 183             case NodeTypes.LEAF_SET:
 184                 LOG.trace("Read leaf set node {}", identifier);
 185                 return addLeafSetChildren(identifier.getNodeType(),
 186                         Builders.leafSetBuilder().withNodeIdentifier(identifier)).build();
 187
 188             case NodeTypes.ORDERED_LEAF_SET:
 189                 LOG.trace("Read ordered leaf set node {}", identifier);
 190                 return addLeafSetChildren(identifier.getNodeType(),
 191                         Builders.orderedLeafSetBuilder().withNodeIdentifier(identifier)).build();
 192
 193             default:
 194                 return null;
 195         }
 196     }
 197
 198     private DOMSource readDOMSource() throws IOException {
 199         String xml = readObject().toString();
 200         try {
 201             DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
 202             factory.setNamespaceAware(true);
 203             Element node = factory.newDocumentBuilder().parse(
 204                     new InputSource(new StringReader(xml))).getDocumentElement();
 205             return new DOMSource(node);
 206         } catch (SAXException | ParserConfigurationException e) {
 207             throw new IOException("Error parsing XML: " + xml, e);
 208         }
 209     }
 210
 211     QName readQName() throws IOException {
 212         // Read in the same sequence of writing
 213         String localName = readCodedString();
 214         String namespace = readCodedString();
 215         String revision = Strings.emptyToNull(readCodedString());
 216
 217         return QNameFactory.create(new QNameFactory.Key(localName, namespace, revision));
 218     }
 219
 220
 221     private String readCodedString() throws IOException {
 222         final byte valueType = input.readByte();
 223         switch (valueType) {
 224             case TokenTypes.IS_NULL_VALUE:
 225                 return null;
 226             case TokenTypes.IS_CODE_VALUE:
 227                 final int code = input.readInt();
 228                 try {
 229                     return codedStringMap.get(code);
 230                 } catch (IndexOutOfBoundsException e) {
 231                     throw new IOException("String code " + code + " was not found", e);
 232                 }
 233             case TokenTypes.IS_STRING_VALUE:
 234                 final String value = input.readUTF().intern();
 235                 codedStringMap.add(value);
 236                 return value;
 237             default:
 238                 throw new IOException("Unhandled string value type " + valueType);
 239         }
 240     }
 241
 242     private Set<QName> readQNameSet() throws IOException {
 243         // Read the children count
 244         int count = input.readInt();
 245         Set<QName> children = new HashSet<>(count);
 246         for (int i = 0; i < count; i++) {
 247             children.add(readQName());
 248         }
 249         return children;
 250     }
 251
 252     AugmentationIdentifier readAugmentationIdentifier() throws IOException {
 253         return new AugmentationIdentifier(readQNameSet());
 254     }
 255
 256     private NodeIdentifier readNodeIdentifier() throws IOException {
 257         // FIXME: we should have a cache for these, too
 258         return new NodeIdentifier(readQName());
 259     }
 260
 261     private NodeIdentifierWithPredicates readNormalizedNodeWithPredicates() throws IOException {
 262         final QName qname = readQName();
 263         final int count = input.readInt();
 264         switch (count) {
 265             case 0:
 266                 return new NodeIdentifierWithPredicates(qname);
 267             case 1:
 268                 return new NodeIdentifierWithPredicates(qname, readQName(), readObject());
 269             default:
 270                 // ImmutableList is used by ImmutableOffsetMapTemplate for lookups, hence we use that.
 271                 final Builder<QName> keys = ImmutableList.builderWithExpectedSize(count);
 272                 final Object[] values = new Object[count];
 273                 for (int i = 0; i < count; i++) {
 274                     keys.add(readQName());
 275                     values[i] = readObject();
 276                 }
 277
 278                 return new NodeIdentifierWithPredicates(qname, ImmutableOffsetMapTemplate.ordered(keys.build())
 279                     .instantiateWithValues(values));
 280         }
 281     }
 282
 283     private Object readObject() throws IOException {
 284         byte objectType = input.readByte();
 285         switch (objectType) {
 286             case ValueTypes.BITS_TYPE:
 287                 return readObjSet();
 288
 289             case ValueTypes.BOOL_TYPE:
 290                 return input.readBoolean();
 291
 292             case ValueTypes.BYTE_TYPE:
 293                 return input.readByte();
 294
 295             case ValueTypes.INT_TYPE:
 296                 return input.readInt();
 297
 298             case ValueTypes.LONG_TYPE:
 299                 return input.readLong();
 300
 301             case ValueTypes.QNAME_TYPE:
 302                 return readQName();
 303
 304             case ValueTypes.SHORT_TYPE:
 305                 return input.readShort();
 306
 307             case ValueTypes.STRING_TYPE:
 308                 return input.readUTF();
 309
 310             case ValueTypes.STRING_BYTES_TYPE:
 311                 return readStringBytes();
 312
 313             case ValueTypes.BIG_DECIMAL_TYPE:
 314                 return new BigDecimal(input.readUTF());
 315
 316             case ValueTypes.BIG_INTEGER_TYPE:
 317                 return new BigInteger(input.readUTF());
 318
 319             case ValueTypes.BINARY_TYPE:
 320                 byte[] bytes = new byte[input.readInt()];
 321                 input.readFully(bytes);
 322                 return bytes;
 323
 324             case ValueTypes.YANG_IDENTIFIER_TYPE:
 325                 return readYangInstanceIdentifierInternal();
 326
 327             case ValueTypes.EMPTY_TYPE:
 328             // Leaf nodes no longer allow null values and thus we no longer emit null values. Previously, the "empty"
 329             // yang type was represented as null so we translate an incoming null value to Empty. It was possible for
 330             // a BI user to set a string leaf to null and we're rolling the dice here but the chances for that are
 331             // very low. We'd have to know the yang type but, even if we did, we can't let a null value pass upstream
 332             // so we'd have to drop the leaf which might cause other issues.
 333             case ValueTypes.NULL_TYPE:
 334                 return Empty.getInstance();
 335
 336             default:
 337                 return null;
 338         }
 339     }
 340
 341     private String readStringBytes() throws IOException {
 342         byte[] bytes = new byte[input.readInt()];
 343         input.readFully(bytes);
 344         return new String(bytes, StandardCharsets.UTF_8);
 345     }
 346
 347     @Override
 348     public SchemaPath readSchemaPath() throws IOException {
 349         final boolean absolute = input.readBoolean();
 350         final int size = input.readInt();
 351
 352         final Builder<QName> qnames = ImmutableList.builderWithExpectedSize(size);
 353         for (int i = 0; i < size; ++i) {
 354             qnames.add(readQName());
 355         }
 356         return SchemaPath.create(qnames.build(), absolute);
 357     }
 358
 359     @Override
 360     public YangInstanceIdentifier readYangInstanceIdentifier() throws IOException {
 361         return readYangInstanceIdentifierInternal();
 362     }
 363
 364     private YangInstanceIdentifier readYangInstanceIdentifierInternal() throws IOException {
 365         int size = input.readInt();
 366         final Builder<PathArgument> pathArguments = ImmutableList.builderWithExpectedSize(size);
 367         for (int i = 0; i < size; i++) {
 368             pathArguments.add(readPathArgument());
 369         }
 370         return YangInstanceIdentifier.create(pathArguments.build());
 371     }
 372
 373     private Set<String> readObjSet() throws IOException {
 374         int count = input.readInt();
 375         Set<String> children = new HashSet<>(count);
 376         for (int i = 0; i < count; i++) {
 377             children.add(readCodedString());
 378         }
 379         return children;
 380     }
 381
 382     @Override
 383     public PathArgument readPathArgument() throws IOException {
 384         // read Type
 385         int type = input.readByte();
 386
 387         switch (type) {
 388             case PathArgumentTypes.AUGMENTATION_IDENTIFIER:
 389                 return readAugmentationIdentifier();
 390             case PathArgumentTypes.NODE_IDENTIFIER:
 391                 return readNodeIdentifier();
 392             case PathArgumentTypes.NODE_IDENTIFIER_WITH_PREDICATES:
 393                 return readNormalizedNodeWithPredicates();
 394             case PathArgumentTypes.NODE_IDENTIFIER_WITH_VALUE:
 395                 return new NodeWithValue<>(readQName(), readObject());
 396             default:
 397                 // FIXME: throw hard error
 398                 return null;
 399         }
 400     }
 401
 402     @SuppressWarnings("unchecked")
 403     private ListNodeBuilder<Object, LeafSetEntryNode<Object>> addLeafSetChildren(final QName nodeType,
 404             final ListNodeBuilder<Object, LeafSetEntryNode<Object>> builder) throws IOException {
 405
 406         LOG.trace("Reading children of leaf set");
 407
 408         lastLeafSetQName = nodeType;
 409
 410         LeafSetEntryNode<Object> child = (LeafSetEntryNode<Object>)readNormalizedNodeInternal();
 411
 412         while (child != null) {
 413             builder.withChild(child);
 414             child = (LeafSetEntryNode<Object>)readNormalizedNodeInternal();
 415         }
 416         return builder;
 417     }
 418
 419     @SuppressWarnings({ "unchecked", "rawtypes" })
 420     private NormalizedNodeContainerBuilder addDataContainerChildren(
 421             final NormalizedNodeContainerBuilder builder) throws IOException {
 422         LOG.trace("Reading data container (leaf nodes) nodes");
 423
 424         NormalizedNode<?, ?> child = readNormalizedNodeInternal();
 425
 426         while (child != null) {
 427             builder.addChild(child);
 428             child = readNormalizedNodeInternal();
 429         }
 430         return builder;
 431     }
 432 }