2 * Copyright (c) 2014, 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
9 package org.opendaylight.controller.cluster.datastore.node.utils.stream;
11 import com.google.common.base.Preconditions;
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.HashMap;
22 import java.util.HashSet;
25 import javax.xml.parsers.DocumentBuilderFactory;
26 import javax.xml.parsers.ParserConfigurationException;
27 import javax.xml.transform.dom.DOMSource;
28 import org.opendaylight.controller.cluster.datastore.node.utils.QNameFactory;
29 import org.opendaylight.yangtools.yang.common.Empty;
30 import org.opendaylight.yangtools.yang.common.QName;
31 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
32 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
33 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
34 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
35 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
36 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
37 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
38 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
39 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
40 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.ListNodeBuilder;
41 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeAttrBuilder;
42 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeContainerBuilder;
43 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
44 import org.slf4j.Logger;
45 import org.slf4j.LoggerFactory;
46 import org.w3c.dom.Element;
47 import org.xml.sax.InputSource;
48 import org.xml.sax.SAXException;
51 * NormalizedNodeInputStreamReader reads the byte stream and constructs the normalized node including its children
52 * nodes. This process goes in recursive manner, where each NodeTypes object signifies the start of the object, except
53 * END_NODE. If a node can have children, then that node's end is calculated based on appearance of END_NODE.
55 public class NormalizedNodeInputStreamReader implements NormalizedNodeDataInput {
57 private static final Logger LOG = LoggerFactory.getLogger(NormalizedNodeInputStreamReader.class);
59 private static final String REVISION_ARG = "?revision=";
61 private final DataInput input;
63 private final Map<Integer, String> codedStringMap = new HashMap<>();
65 private QName lastLeafSetQName;
67 private NormalizedNodeAttrBuilder<YangInstanceIdentifier.NodeIdentifier,
68 Object, LeafNode<Object>> leafBuilder;
70 @SuppressWarnings("rawtypes")
71 private NormalizedNodeAttrBuilder<NodeWithValue, Object, LeafSetEntryNode<Object>> leafSetEntryBuilder;
73 private final StringBuilder reusableStringBuilder = new StringBuilder(50);
75 private boolean readSignatureMarker = true;
77 NormalizedNodeInputStreamReader(final DataInput input, final boolean versionChecked) {
78 this.input = Preconditions.checkNotNull(input);
79 readSignatureMarker = !versionChecked;
83 public NormalizedNode<?, ?> readNormalizedNode() throws IOException {
84 readSignatureMarkerAndVersionIfNeeded();
85 return readNormalizedNodeInternal();
88 private void readSignatureMarkerAndVersionIfNeeded() throws IOException {
89 if (readSignatureMarker) {
90 readSignatureMarker = false;
92 final byte marker = input.readByte();
93 if (marker != TokenTypes.SIGNATURE_MARKER) {
94 throw new InvalidNormalizedNodeStreamException(String.format(
95 "Invalid signature marker: %d", marker));
98 final short version = input.readShort();
99 if (version != TokenTypes.LITHIUM_VERSION) {
100 throw new InvalidNormalizedNodeStreamException(String.format("Unhandled stream version %s", version));
105 private NormalizedNode<?, ?> readNormalizedNodeInternal() throws IOException {
106 // each node should start with a byte
107 byte nodeType = input.readByte();
109 if (nodeType == NodeTypes.END_NODE) {
110 LOG.trace("End node reached. return");
111 lastLeafSetQName = null;
116 case NodeTypes.AUGMENTATION_NODE :
117 YangInstanceIdentifier.AugmentationIdentifier augIdentifier =
118 new YangInstanceIdentifier.AugmentationIdentifier(readQNameSet());
120 LOG.trace("Reading augmentation node {} ", augIdentifier);
122 return addDataContainerChildren(Builders.augmentationBuilder()
123 .withNodeIdentifier(augIdentifier)).build();
125 case NodeTypes.LEAF_SET_ENTRY_NODE :
126 QName name = lastLeafSetQName;
131 Object value = readObject();
132 NodeWithValue<Object> leafIdentifier = new NodeWithValue<>(name, value);
134 LOG.trace("Reading leaf set entry node {}, value {}", leafIdentifier, value);
136 return leafSetEntryBuilder().withNodeIdentifier(leafIdentifier).withValue(value).build();
138 case NodeTypes.MAP_ENTRY_NODE :
139 NodeIdentifierWithPredicates entryIdentifier = new NodeIdentifierWithPredicates(
140 readQName(), readKeyValueMap());
142 LOG.trace("Reading map entry node {} ", entryIdentifier);
144 return addDataContainerChildren(Builders.mapEntryBuilder()
145 .withNodeIdentifier(entryIdentifier)).build();
148 return readNodeIdentifierDependentNode(nodeType, new NodeIdentifier(readQName()));
152 private NormalizedNodeAttrBuilder<YangInstanceIdentifier.NodeIdentifier,
153 Object, LeafNode<Object>> leafBuilder() {
154 if (leafBuilder == null) {
155 leafBuilder = Builders.leafBuilder();
161 @SuppressWarnings("rawtypes")
162 private NormalizedNodeAttrBuilder<NodeWithValue, Object,
163 LeafSetEntryNode<Object>> leafSetEntryBuilder() {
164 if (leafSetEntryBuilder == null) {
165 leafSetEntryBuilder = Builders.leafSetEntryBuilder();
168 return leafSetEntryBuilder;
171 private NormalizedNode<?, ?> readNodeIdentifierDependentNode(final byte nodeType, final NodeIdentifier identifier)
175 case NodeTypes.LEAF_NODE :
176 LOG.trace("Read leaf node {}", identifier);
177 // Read the object value
178 return leafBuilder().withNodeIdentifier(identifier).withValue(readObject()).build();
180 case NodeTypes.ANY_XML_NODE :
181 LOG.trace("Read xml node");
182 return Builders.anyXmlBuilder().withNodeIdentifier(identifier).withValue(readDOMSource()).build();
184 case NodeTypes.MAP_NODE :
185 LOG.trace("Read map node {}", identifier);
186 return addDataContainerChildren(Builders.mapBuilder().withNodeIdentifier(identifier)).build();
188 case NodeTypes.CHOICE_NODE:
189 LOG.trace("Read choice node {}", identifier);
190 return addDataContainerChildren(Builders.choiceBuilder().withNodeIdentifier(identifier)).build();
192 case NodeTypes.ORDERED_MAP_NODE:
193 LOG.trace("Reading ordered map node {}", identifier);
194 return addDataContainerChildren(Builders.orderedMapBuilder().withNodeIdentifier(identifier)).build();
196 case NodeTypes.UNKEYED_LIST:
197 LOG.trace("Read unkeyed list node {}", identifier);
198 return addDataContainerChildren(Builders.unkeyedListBuilder().withNodeIdentifier(identifier)).build();
200 case NodeTypes.UNKEYED_LIST_ITEM:
201 LOG.trace("Read unkeyed list item node {}", identifier);
202 return addDataContainerChildren(Builders.unkeyedListEntryBuilder()
203 .withNodeIdentifier(identifier)).build();
205 case NodeTypes.CONTAINER_NODE:
206 LOG.trace("Read container node {}", identifier);
207 return addDataContainerChildren(Builders.containerBuilder().withNodeIdentifier(identifier)).build();
209 case NodeTypes.LEAF_SET :
210 LOG.trace("Read leaf set node {}", identifier);
211 return addLeafSetChildren(identifier.getNodeType(),
212 Builders.leafSetBuilder().withNodeIdentifier(identifier)).build();
214 case NodeTypes.ORDERED_LEAF_SET:
215 LOG.trace("Read ordered leaf set node {}", identifier);
216 return addLeafSetChildren(identifier.getNodeType(),
217 Builders.orderedLeafSetBuilder().withNodeIdentifier(identifier)).build();
224 private DOMSource readDOMSource() throws IOException {
225 String xml = readObject().toString();
227 DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
228 factory.setNamespaceAware(true);
229 Element node = factory.newDocumentBuilder().parse(
230 new InputSource(new StringReader(xml))).getDocumentElement();
231 return new DOMSource(node);
232 } catch (SAXException | ParserConfigurationException e) {
233 throw new IOException("Error parsing XML: " + xml, e);
237 private QName readQName() throws IOException {
238 // Read in the same sequence of writing
239 String localName = readCodedString();
240 String namespace = readCodedString();
241 String revision = readCodedString();
244 if (!Strings.isNullOrEmpty(revision)) {
245 qname = reusableStringBuilder.append('(').append(namespace).append(REVISION_ARG).append(revision)
246 .append(')').append(localName).toString();
248 qname = reusableStringBuilder.append('(').append(namespace).append(')').append(localName).toString();
251 reusableStringBuilder.delete(0, reusableStringBuilder.length());
252 return QNameFactory.create(qname);
256 private String readCodedString() throws IOException {
257 byte valueType = input.readByte();
258 if (valueType == TokenTypes.IS_CODE_VALUE) {
259 return codedStringMap.get(input.readInt());
260 } else if (valueType == TokenTypes.IS_STRING_VALUE) {
261 String value = input.readUTF().intern();
262 codedStringMap.put(codedStringMap.size(), value);
269 private Set<QName> readQNameSet() throws IOException {
270 // Read the children count
271 int count = input.readInt();
272 Set<QName> children = new HashSet<>(count);
273 for (int i = 0; i < count; i++) {
274 children.add(readQName());
279 private Map<QName, Object> readKeyValueMap() throws IOException {
280 int count = input.readInt();
281 Map<QName, Object> keyValueMap = new HashMap<>(count);
283 for (int i = 0; i < count; i++) {
284 keyValueMap.put(readQName(), readObject());
290 private Object readObject() throws IOException {
291 byte objectType = input.readByte();
292 switch (objectType) {
293 case ValueTypes.BITS_TYPE:
296 case ValueTypes.BOOL_TYPE :
297 return input.readBoolean();
299 case ValueTypes.BYTE_TYPE :
300 return input.readByte();
302 case ValueTypes.INT_TYPE :
303 return input.readInt();
305 case ValueTypes.LONG_TYPE :
306 return input.readLong();
308 case ValueTypes.QNAME_TYPE :
311 case ValueTypes.SHORT_TYPE :
312 return input.readShort();
314 case ValueTypes.STRING_TYPE :
315 return input.readUTF();
317 case ValueTypes.STRING_BYTES_TYPE:
318 return readStringBytes();
320 case ValueTypes.BIG_DECIMAL_TYPE :
321 return new BigDecimal(input.readUTF());
323 case ValueTypes.BIG_INTEGER_TYPE :
324 return new BigInteger(input.readUTF());
326 case ValueTypes.BINARY_TYPE :
327 byte[] bytes = new byte[input.readInt()];
328 input.readFully(bytes);
331 case ValueTypes.YANG_IDENTIFIER_TYPE :
332 return readYangInstanceIdentifierInternal();
334 case ValueTypes.EMPTY_TYPE:
335 // Leaf nodes no longer allow null values and thus we no longer emit null values. Previously, the "empty"
336 // yang type was represented as null so we translate an incoming null value to Empty. It was possible for
337 // a BI user to set a string leaf to null and we're rolling the dice here but the chances for that are
338 // very low. We'd have to know the yang type but, even if we did, we can't let a null value pass upstream
339 // so we'd have to drop the leaf which might cause other issues.
340 case ValueTypes.NULL_TYPE:
341 return Empty.getInstance();
348 private String readStringBytes() throws IOException {
349 byte[] bytes = new byte[input.readInt()];
350 input.readFully(bytes);
351 return new String(bytes, StandardCharsets.UTF_8);
355 public SchemaPath readSchemaPath() throws IOException {
356 readSignatureMarkerAndVersionIfNeeded();
358 final boolean absolute = input.readBoolean();
359 final int size = input.readInt();
361 final Builder<QName> qnames = ImmutableList.builderWithExpectedSize(size);
362 for (int i = 0; i < size; ++i) {
363 qnames.add(readQName());
365 return SchemaPath.create(qnames.build(), absolute);
369 public YangInstanceIdentifier readYangInstanceIdentifier() throws IOException {
370 readSignatureMarkerAndVersionIfNeeded();
371 return readYangInstanceIdentifierInternal();
374 private YangInstanceIdentifier readYangInstanceIdentifierInternal() throws IOException {
375 int size = input.readInt();
376 final Builder<PathArgument> pathArguments = ImmutableList.builderWithExpectedSize(size);
377 for (int i = 0; i < size; i++) {
378 pathArguments.add(readPathArgument());
380 return YangInstanceIdentifier.create(pathArguments.build());
383 private Set<String> readObjSet() throws IOException {
384 int count = input.readInt();
385 Set<String> children = new HashSet<>(count);
386 for (int i = 0; i < count; i++) {
387 children.add(readCodedString());
393 public PathArgument readPathArgument() throws IOException {
395 int type = input.readByte();
399 case PathArgumentTypes.AUGMENTATION_IDENTIFIER :
400 return new YangInstanceIdentifier.AugmentationIdentifier(readQNameSet());
402 case PathArgumentTypes.NODE_IDENTIFIER :
403 return new NodeIdentifier(readQName());
405 case PathArgumentTypes.NODE_IDENTIFIER_WITH_PREDICATES :
406 return new NodeIdentifierWithPredicates(readQName(), readKeyValueMap());
408 case PathArgumentTypes.NODE_IDENTIFIER_WITH_VALUE :
409 return new NodeWithValue<>(readQName(), readObject());
416 @SuppressWarnings("unchecked")
417 private ListNodeBuilder<Object, LeafSetEntryNode<Object>> addLeafSetChildren(final QName nodeType,
418 final ListNodeBuilder<Object, LeafSetEntryNode<Object>> builder) throws IOException {
420 LOG.trace("Reading children of leaf set");
422 lastLeafSetQName = nodeType;
424 LeafSetEntryNode<Object> child = (LeafSetEntryNode<Object>)readNormalizedNodeInternal();
426 while (child != null) {
427 builder.withChild(child);
428 child = (LeafSetEntryNode<Object>)readNormalizedNodeInternal();
433 @SuppressWarnings({ "unchecked", "rawtypes" })
434 private NormalizedNodeContainerBuilder addDataContainerChildren(
435 final NormalizedNodeContainerBuilder builder) throws IOException {
436 LOG.trace("Reading data container (leaf nodes) nodes");
438 NormalizedNode<?, ?> child = readNormalizedNodeInternal();
440 while (child != null) {
441 builder.addChild(child);
442 child = readNormalizedNodeInternal();
448 public void readFully(final byte[] value) throws IOException {
449 readSignatureMarkerAndVersionIfNeeded();
450 input.readFully(value);
454 public void readFully(final byte[] str, final int off, final int len) throws IOException {
455 readSignatureMarkerAndVersionIfNeeded();
456 input.readFully(str, off, len);
460 public int skipBytes(final int num) throws IOException {
461 readSignatureMarkerAndVersionIfNeeded();
462 return input.skipBytes(num);
466 public boolean readBoolean() throws IOException {
467 readSignatureMarkerAndVersionIfNeeded();
468 return input.readBoolean();
472 public byte readByte() throws IOException {
473 readSignatureMarkerAndVersionIfNeeded();
474 return input.readByte();
478 public int readUnsignedByte() throws IOException {
479 readSignatureMarkerAndVersionIfNeeded();
480 return input.readUnsignedByte();
484 public short readShort() throws IOException {
485 readSignatureMarkerAndVersionIfNeeded();
486 return input.readShort();
490 public int readUnsignedShort() throws IOException {
491 readSignatureMarkerAndVersionIfNeeded();
492 return input.readUnsignedShort();
496 public char readChar() throws IOException {
497 readSignatureMarkerAndVersionIfNeeded();
498 return input.readChar();
502 public int readInt() throws IOException {
503 readSignatureMarkerAndVersionIfNeeded();
504 return input.readInt();
508 public long readLong() throws IOException {
509 readSignatureMarkerAndVersionIfNeeded();
510 return input.readLong();
514 public float readFloat() throws IOException {
515 readSignatureMarkerAndVersionIfNeeded();
516 return input.readFloat();
520 public double readDouble() throws IOException {
521 readSignatureMarkerAndVersionIfNeeded();
522 return input.readDouble();
526 public String readLine() throws IOException {
527 readSignatureMarkerAndVersionIfNeeded();
528 return input.readLine();
532 public String readUTF() throws IOException {
533 readSignatureMarkerAndVersionIfNeeded();
534 return input.readUTF();