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
8 package org.opendaylight.controller.cluster.datastore.node.utils.stream;
10 import static java.util.Objects.requireNonNull;
12 import com.google.common.base.Strings;
13 import com.google.common.collect.ImmutableList;
14 import com.google.common.collect.ImmutableList.Builder;
15 import com.google.common.collect.Sets;
16 import java.io.DataInput;
17 import java.io.IOException;
18 import java.io.StringReader;
19 import java.math.BigDecimal;
20 import java.math.BigInteger;
21 import java.nio.charset.StandardCharsets;
22 import java.util.ArrayList;
23 import java.util.HashSet;
24 import java.util.List;
26 import javax.xml.parsers.DocumentBuilderFactory;
27 import javax.xml.parsers.ParserConfigurationException;
28 import javax.xml.transform.dom.DOMSource;
29 import org.eclipse.jdt.annotation.NonNull;
30 import org.opendaylight.controller.cluster.datastore.node.utils.QNameFactory;
31 import org.opendaylight.yangtools.util.ImmutableOffsetMapTemplate;
32 import org.opendaylight.yangtools.yang.common.Empty;
33 import org.opendaylight.yangtools.yang.common.QName;
34 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
35 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
36 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
37 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
38 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
39 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
40 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
41 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
42 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
43 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
44 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.ListNodeBuilder;
45 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeBuilder;
46 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeContainerBuilder;
47 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
48 import org.slf4j.Logger;
49 import org.slf4j.LoggerFactory;
50 import org.w3c.dom.Element;
51 import org.xml.sax.InputSource;
52 import org.xml.sax.SAXException;
55 * NormalizedNodeInputStreamReader reads the byte stream and constructs the normalized node including its children
56 * nodes. This process goes in recursive manner, where each NodeTypes object signifies the start of the object, except
57 * END_NODE. If a node can have children, then that node's end is calculated based on appearance of END_NODE.
59 class LithiumNormalizedNodeInputStreamReader extends ForwardingDataInput implements NormalizedNodeDataInput {
61 private static final Logger LOG = LoggerFactory.getLogger(LithiumNormalizedNodeInputStreamReader.class);
63 private final @NonNull DataInput input;
65 private final List<String> codedStringMap = new ArrayList<>();
67 private QName lastLeafSetQName;
69 private NormalizedNodeBuilder<NodeIdentifier, Object, LeafNode<Object>> leafBuilder;
71 @SuppressWarnings("rawtypes")
72 private NormalizedNodeBuilder<NodeWithValue, Object, LeafSetEntryNode<Object>> leafSetEntryBuilder;
74 LithiumNormalizedNodeInputStreamReader(final DataInput input) {
75 this.input = requireNonNull(input);
79 final DataInput delegate() {
84 public NormalizedNodeStreamVersion getVersion() throws IOException {
85 return NormalizedNodeStreamVersion.LITHIUM;
89 public NormalizedNode<?, ?> readNormalizedNode() throws IOException {
90 return readNormalizedNodeInternal();
93 private NormalizedNode<?, ?> readNormalizedNodeInternal() throws IOException {
94 // each node should start with a byte
95 byte nodeType = input.readByte();
97 if (nodeType == NodeTypes.END_NODE) {
98 LOG.trace("End node reached. return");
99 lastLeafSetQName = null;
104 case NodeTypes.AUGMENTATION_NODE:
105 AugmentationIdentifier augIdentifier = readAugmentationIdentifier();
106 LOG.trace("Reading augmentation node {} ", augIdentifier);
107 return addDataContainerChildren(Builders.augmentationBuilder().withNodeIdentifier(augIdentifier))
110 case NodeTypes.LEAF_SET_ENTRY_NODE:
111 final QName name = lastLeafSetQName != null ? lastLeafSetQName : readQName();
112 final Object value = readObject();
113 final NodeWithValue<Object> leafIdentifier = new NodeWithValue<>(name, value);
114 LOG.trace("Reading leaf set entry node {}, value {}", leafIdentifier, value);
115 return leafSetEntryBuilder().withNodeIdentifier(leafIdentifier).withValue(value).build();
117 case NodeTypes.MAP_ENTRY_NODE:
118 final NodeIdentifierWithPredicates entryIdentifier = readNormalizedNodeWithPredicates();
119 LOG.trace("Reading map entry node {} ", entryIdentifier);
120 return addDataContainerChildren(Builders.mapEntryBuilder().withNodeIdentifier(entryIdentifier))
124 return readNodeIdentifierDependentNode(nodeType, readNodeIdentifier());
128 private NormalizedNodeBuilder<NodeIdentifier, Object, LeafNode<Object>> leafBuilder() {
129 if (leafBuilder == null) {
130 leafBuilder = Builders.leafBuilder();
136 @SuppressWarnings("rawtypes")
137 private NormalizedNodeBuilder<NodeWithValue, Object, LeafSetEntryNode<Object>> leafSetEntryBuilder() {
138 if (leafSetEntryBuilder == null) {
139 leafSetEntryBuilder = Builders.leafSetEntryBuilder();
142 return leafSetEntryBuilder;
145 private NormalizedNode<?, ?> readNodeIdentifierDependentNode(final byte nodeType, final NodeIdentifier identifier)
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();
154 case NodeTypes.ANY_XML_NODE:
155 LOG.trace("Read xml node");
156 return Builders.anyXmlBuilder().withNodeIdentifier(identifier).withValue(readDOMSource()).build();
158 case NodeTypes.MAP_NODE:
159 LOG.trace("Read map node {}", identifier);
160 return addDataContainerChildren(Builders.mapBuilder().withNodeIdentifier(identifier)).build();
162 case NodeTypes.CHOICE_NODE:
163 LOG.trace("Read choice node {}", identifier);
164 return addDataContainerChildren(Builders.choiceBuilder().withNodeIdentifier(identifier)).build();
166 case NodeTypes.ORDERED_MAP_NODE:
167 LOG.trace("Reading ordered map node {}", identifier);
168 return addDataContainerChildren(Builders.orderedMapBuilder().withNodeIdentifier(identifier)).build();
170 case NodeTypes.UNKEYED_LIST:
171 LOG.trace("Read unkeyed list node {}", identifier);
172 return addDataContainerChildren(Builders.unkeyedListBuilder().withNodeIdentifier(identifier)).build();
174 case NodeTypes.UNKEYED_LIST_ITEM:
175 LOG.trace("Read unkeyed list item node {}", identifier);
176 return addDataContainerChildren(Builders.unkeyedListEntryBuilder()
177 .withNodeIdentifier(identifier)).build();
179 case NodeTypes.CONTAINER_NODE:
180 LOG.trace("Read container node {}", identifier);
181 return addDataContainerChildren(Builders.containerBuilder().withNodeIdentifier(identifier)).build();
183 case NodeTypes.LEAF_SET:
184 LOG.trace("Read leaf set node {}", identifier);
185 return addLeafSetChildren(identifier.getNodeType(),
186 Builders.leafSetBuilder().withNodeIdentifier(identifier)).build();
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();
198 private DOMSource readDOMSource() throws IOException {
199 String xml = readObject().toString();
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);
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());
217 return QNameFactory.create(new QNameFactory.Key(localName, namespace, revision));
221 private String readCodedString() throws IOException {
222 final byte valueType = input.readByte();
224 case TokenTypes.IS_NULL_VALUE:
226 case TokenTypes.IS_CODE_VALUE:
227 final int code = input.readInt();
229 return codedStringMap.get(code);
230 } catch (IndexOutOfBoundsException e) {
231 throw new IOException("String code " + code + " was not found", e);
233 case TokenTypes.IS_STRING_VALUE:
234 final String value = input.readUTF().intern();
235 codedStringMap.add(value);
238 throw new IOException("Unhandled string value type " + valueType);
242 private Set<QName> readQNameSet() throws IOException {
243 // Read the children count
244 final int count = input.readInt();
245 final Set<QName> children = Sets.newHashSetWithExpectedSize(count);
246 for (int i = 0; i < count; i++) {
247 children.add(readQName());
252 AugmentationIdentifier readAugmentationIdentifier() throws IOException {
253 return AugmentationIdentifier.create(readQNameSet());
256 NodeIdentifier readNodeIdentifier() throws IOException {
257 return new NodeIdentifier(readQName());
260 private NodeIdentifierWithPredicates readNormalizedNodeWithPredicates() throws IOException {
261 final QName qname = readQName();
262 final int count = input.readInt();
265 return NodeIdentifierWithPredicates.of(qname);
267 return NodeIdentifierWithPredicates.of(qname, readQName(), readObject());
269 // ImmutableList is used by ImmutableOffsetMapTemplate for lookups, hence we use that.
270 final Builder<QName> keys = ImmutableList.builderWithExpectedSize(count);
271 final Object[] values = new Object[count];
272 for (int i = 0; i < count; i++) {
273 keys.add(readQName());
274 values[i] = readObject();
277 return NodeIdentifierWithPredicates.of(qname, ImmutableOffsetMapTemplate.ordered(keys.build())
278 .instantiateWithValues(values));
282 private Object readObject() throws IOException {
283 byte objectType = input.readByte();
284 switch (objectType) {
285 case ValueTypes.BITS_TYPE:
288 case ValueTypes.BOOL_TYPE:
289 return input.readBoolean();
291 case ValueTypes.BYTE_TYPE:
292 return input.readByte();
294 case ValueTypes.INT_TYPE:
295 return input.readInt();
297 case ValueTypes.LONG_TYPE:
298 return input.readLong();
300 case ValueTypes.QNAME_TYPE:
303 case ValueTypes.SHORT_TYPE:
304 return input.readShort();
306 case ValueTypes.STRING_TYPE:
307 return input.readUTF();
309 case ValueTypes.STRING_BYTES_TYPE:
310 return readStringBytes();
312 case ValueTypes.BIG_DECIMAL_TYPE:
313 return new BigDecimal(input.readUTF());
315 case ValueTypes.BIG_INTEGER_TYPE:
316 return new BigInteger(input.readUTF());
318 case ValueTypes.BINARY_TYPE:
319 byte[] bytes = new byte[input.readInt()];
320 input.readFully(bytes);
323 case ValueTypes.YANG_IDENTIFIER_TYPE:
324 return readYangInstanceIdentifierInternal();
326 case ValueTypes.EMPTY_TYPE:
327 // Leaf nodes no longer allow null values and thus we no longer emit null values. Previously, the "empty"
328 // yang type was represented as null so we translate an incoming null value to Empty. It was possible for
329 // a BI user to set a string leaf to null and we're rolling the dice here but the chances for that are
330 // very low. We'd have to know the yang type but, even if we did, we can't let a null value pass upstream
331 // so we'd have to drop the leaf which might cause other issues.
332 case ValueTypes.NULL_TYPE:
333 return Empty.getInstance();
340 private String readStringBytes() throws IOException {
341 byte[] bytes = new byte[input.readInt()];
342 input.readFully(bytes);
343 return new String(bytes, StandardCharsets.UTF_8);
347 public SchemaPath readSchemaPath() throws IOException {
348 final boolean absolute = input.readBoolean();
349 final int size = input.readInt();
351 final Builder<QName> qnames = ImmutableList.builderWithExpectedSize(size);
352 for (int i = 0; i < size; ++i) {
353 qnames.add(readQName());
355 return SchemaPath.create(qnames.build(), absolute);
359 public YangInstanceIdentifier readYangInstanceIdentifier() throws IOException {
360 return readYangInstanceIdentifierInternal();
363 private YangInstanceIdentifier readYangInstanceIdentifierInternal() throws IOException {
364 int size = input.readInt();
365 final Builder<PathArgument> pathArguments = ImmutableList.builderWithExpectedSize(size);
366 for (int i = 0; i < size; i++) {
367 pathArguments.add(readPathArgument());
369 return YangInstanceIdentifier.create(pathArguments.build());
372 private Set<String> readObjSet() throws IOException {
373 int count = input.readInt();
374 Set<String> children = new HashSet<>(count);
375 for (int i = 0; i < count; i++) {
376 children.add(readCodedString());
382 public PathArgument readPathArgument() throws IOException {
384 int type = input.readByte();
387 case PathArgumentTypes.AUGMENTATION_IDENTIFIER:
388 return readAugmentationIdentifier();
389 case PathArgumentTypes.NODE_IDENTIFIER:
390 return readNodeIdentifier();
391 case PathArgumentTypes.NODE_IDENTIFIER_WITH_PREDICATES:
392 return readNormalizedNodeWithPredicates();
393 case PathArgumentTypes.NODE_IDENTIFIER_WITH_VALUE:
394 return new NodeWithValue<>(readQName(), readObject());
396 // FIXME: throw hard error
401 @SuppressWarnings("unchecked")
402 private ListNodeBuilder<Object, LeafSetEntryNode<Object>> addLeafSetChildren(final QName nodeType,
403 final ListNodeBuilder<Object, LeafSetEntryNode<Object>> builder) throws IOException {
405 LOG.trace("Reading children of leaf set");
407 lastLeafSetQName = nodeType;
409 LeafSetEntryNode<Object> child = (LeafSetEntryNode<Object>)readNormalizedNodeInternal();
411 while (child != null) {
412 builder.withChild(child);
413 child = (LeafSetEntryNode<Object>)readNormalizedNodeInternal();
418 @SuppressWarnings({ "unchecked", "rawtypes" })
419 private NormalizedNodeContainerBuilder addDataContainerChildren(
420 final NormalizedNodeContainerBuilder builder) throws IOException {
421 LOG.trace("Reading data container (leaf nodes) nodes");
423 NormalizedNode<?, ?> child = readNormalizedNodeInternal();
425 while (child != null) {
426 builder.addChild(child);
427 child = readNormalizedNodeInternal();