X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-clustering-commons%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fcluster%2Fdatastore%2Fnode%2Futils%2Fstream%2FNormalizedNodeInputStreamReader.java;h=cc744438ff627b64594847323623b72cae6772c7;hp=2246b51a3e1428ddca70220c1608a368f9174956;hb=77f491931ec07f6972869b8cbfa2207857990cec;hpb=412db94945c5db5d2da918f5e23bd3abcecc4d10 diff --git a/opendaylight/md-sal/sal-clustering-commons/src/main/java/org/opendaylight/controller/cluster/datastore/node/utils/stream/NormalizedNodeInputStreamReader.java b/opendaylight/md-sal/sal-clustering-commons/src/main/java/org/opendaylight/controller/cluster/datastore/node/utils/stream/NormalizedNodeInputStreamReader.java old mode 100644 new mode 100755 index 2246b51a3e..cc744438ff --- a/opendaylight/md-sal/sal-clustering-commons/src/main/java/org/opendaylight/controller/cluster/datastore/node/utils/stream/NormalizedNodeInputStreamReader.java +++ b/opendaylight/md-sal/sal-clustering-commons/src/main/java/org/opendaylight/controller/cluster/datastore/node/utils/stream/NormalizedNodeInputStreamReader.java @@ -1,11 +1,9 @@ /* + * Copyright (c) 2014, 2015 Cisco Systems, Inc. and others. All rights reserved. * - * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved. - * - * This program and the accompanying materials are made available under the - * terms of the Eclipse Public License v1.0 which accompanies this distribution, - * and is available at http://www.eclipse.org/legal/epl-v10.html - * + * This program and the accompanying materials are made available under the + * 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.node.utils.stream; @@ -13,19 +11,23 @@ package org.opendaylight.controller.cluster.datastore.node.utils.stream; import com.google.common.base.Preconditions; import com.google.common.base.Strings; import java.io.DataInput; -import java.io.DataInputStream; import java.io.IOException; -import java.io.InputStream; +import java.io.StringReader; import java.math.BigDecimal; import java.math.BigInteger; +import java.nio.charset.StandardCharsets; import java.util.ArrayList; +import java.util.Collection; import java.util.HashMap; import java.util.HashSet; import java.util.List; import java.util.Map; import java.util.Set; +import javax.xml.parsers.DocumentBuilderFactory; +import javax.xml.parsers.ParserConfigurationException; import javax.xml.transform.dom.DOMSource; import org.opendaylight.controller.cluster.datastore.node.utils.QNameFactory; +import org.opendaylight.yangtools.yang.common.Empty; import org.opendaylight.yangtools.yang.common.QName; import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier; import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier; @@ -39,17 +41,19 @@ import org.opendaylight.yangtools.yang.data.impl.schema.Builders; import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.ListNodeBuilder; import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeAttrBuilder; import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeContainerBuilder; +import org.opendaylight.yangtools.yang.model.api.SchemaPath; import org.slf4j.Logger; import org.slf4j.LoggerFactory; +import org.w3c.dom.Element; +import org.xml.sax.InputSource; +import org.xml.sax.SAXException; /** - * NormalizedNodeInputStreamReader reads the byte stream and constructs the normalized node including its children nodes. - * This process goes in recursive manner, where each NodeTypes object signifies the start of the object, except END_NODE. - * If a node can have children, then that node's end is calculated based on appearance of END_NODE. - * + * NormalizedNodeInputStreamReader reads the byte stream and constructs the normalized node including its children + * nodes. This process goes in recursive manner, where each NodeTypes object signifies the start of the object, except + * END_NODE. If a node can have children, then that node's end is calculated based on appearance of END_NODE. */ - -public class NormalizedNodeInputStreamReader implements NormalizedNodeStreamReader { +public class NormalizedNodeInputStreamReader implements NormalizedNodeDataInput { private static final Logger LOG = LoggerFactory.getLogger(NormalizedNodeInputStreamReader.class); @@ -64,20 +68,16 @@ public class NormalizedNodeInputStreamReader implements NormalizedNodeStreamRead private NormalizedNodeAttrBuilder> leafBuilder; - private NormalizedNodeAttrBuilder> leafSetEntryBuilder; + @SuppressWarnings("rawtypes") + private NormalizedNodeAttrBuilder> leafSetEntryBuilder; private final StringBuilder reusableStringBuilder = new StringBuilder(50); private boolean readSignatureMarker = true; - public NormalizedNodeInputStreamReader(InputStream stream) throws IOException { - Preconditions.checkNotNull(stream); - input = new DataInputStream(stream); - } - - public NormalizedNodeInputStreamReader(DataInput input) { + NormalizedNodeInputStreamReader(final DataInput input, final boolean versionChecked) { this.input = Preconditions.checkNotNull(input); + readSignatureMarker = !versionChecked; } @Override @@ -87,16 +87,19 @@ public class NormalizedNodeInputStreamReader implements NormalizedNodeStreamRead } private void readSignatureMarkerAndVersionIfNeeded() throws IOException { - if(readSignatureMarker) { + if (readSignatureMarker) { readSignatureMarker = false; - byte marker = input.readByte(); - if(marker != NormalizedNodeOutputStreamWriter.SIGNATURE_MARKER) { + final byte marker = input.readByte(); + if (marker != TokenTypes.SIGNATURE_MARKER) { throw new InvalidNormalizedNodeStreamException(String.format( "Invalid signature marker: %d", marker)); } - input.readShort(); // read the version - not currently used/needed. + final short version = input.readShort(); + if (version != TokenTypes.LITHIUM_VERSION) { + throw new InvalidNormalizedNodeStreamException(String.format("Unhandled stream version %s", version)); + } } } @@ -104,26 +107,32 @@ public class NormalizedNodeInputStreamReader implements NormalizedNodeStreamRead // each node should start with a byte byte nodeType = input.readByte(); - if(nodeType == NodeTypes.END_NODE) { - LOG.debug("End node reached. return"); + if (nodeType == NodeTypes.END_NODE) { + LOG.trace("End node reached. return"); + lastLeafSetQName = null; return null; } - switch(nodeType) { + switch (nodeType) { case NodeTypes.AUGMENTATION_NODE : YangInstanceIdentifier.AugmentationIdentifier augIdentifier = new YangInstanceIdentifier.AugmentationIdentifier(readQNameSet()); - LOG.debug("Reading augmentation node {} ", augIdentifier); + LOG.trace("Reading augmentation node {} ", augIdentifier); - return addDataContainerChildren(Builders.augmentationBuilder(). - withNodeIdentifier(augIdentifier)).build(); + return addDataContainerChildren(Builders.augmentationBuilder() + .withNodeIdentifier(augIdentifier)).build(); case NodeTypes.LEAF_SET_ENTRY_NODE : + QName name = lastLeafSetQName; + if (name == null) { + name = readQName(); + } + Object value = readObject(); - NodeWithValue leafIdentifier = new NodeWithValue(lastLeafSetQName, value); + NodeWithValue leafIdentifier = new NodeWithValue<>(name, value); - LOG.debug("Reading leaf set entry node {}, value {}", leafIdentifier, value); + LOG.trace("Reading leaf set entry node {}, value {}", leafIdentifier, value); return leafSetEntryBuilder().withNodeIdentifier(leafIdentifier).withValue(value).build(); @@ -131,10 +140,10 @@ public class NormalizedNodeInputStreamReader implements NormalizedNodeStreamRead NodeIdentifierWithPredicates entryIdentifier = new NodeIdentifierWithPredicates( readQName(), readKeyValueMap()); - LOG.debug("Reading map entry node {} ", entryIdentifier); + LOG.trace("Reading map entry node {} ", entryIdentifier); - return addDataContainerChildren(Builders.mapEntryBuilder(). - withNodeIdentifier(entryIdentifier)).build(); + return addDataContainerChildren(Builders.mapEntryBuilder() + .withNodeIdentifier(entryIdentifier)).build(); default : return readNodeIdentifierDependentNode(nodeType, new NodeIdentifier(readQName())); @@ -143,113 +152,128 @@ public class NormalizedNodeInputStreamReader implements NormalizedNodeStreamRead private NormalizedNodeAttrBuilder> leafBuilder() { - if(leafBuilder == null) { + if (leafBuilder == null) { leafBuilder = Builders.leafBuilder(); } return leafBuilder; } + @SuppressWarnings("rawtypes") private NormalizedNodeAttrBuilder> leafSetEntryBuilder() { - if(leafSetEntryBuilder == null) { + if (leafSetEntryBuilder == null) { leafSetEntryBuilder = Builders.leafSetEntryBuilder(); } return leafSetEntryBuilder; } - private NormalizedNode readNodeIdentifierDependentNode(byte nodeType, NodeIdentifier identifier) + private NormalizedNode readNodeIdentifierDependentNode(final byte nodeType, final NodeIdentifier identifier) throws IOException { - switch(nodeType) { + switch (nodeType) { case NodeTypes.LEAF_NODE : - LOG.debug("Read leaf node {}", identifier); + LOG.trace("Read leaf node {}", identifier); // Read the object value return leafBuilder().withNodeIdentifier(identifier).withValue(readObject()).build(); case NodeTypes.ANY_XML_NODE : - LOG.debug("Read xml node"); - return Builders.anyXmlBuilder().withValue((DOMSource) readObject()).build(); + LOG.trace("Read xml node"); + return Builders.anyXmlBuilder().withNodeIdentifier(identifier).withValue(readDOMSource()).build(); case NodeTypes.MAP_NODE : - LOG.debug("Read map node {}", identifier); - return addDataContainerChildren(Builders.mapBuilder(). - withNodeIdentifier(identifier)).build(); - - case NodeTypes.CHOICE_NODE : - LOG.debug("Read choice node {}", identifier); - return addDataContainerChildren(Builders.choiceBuilder(). - withNodeIdentifier(identifier)).build(); - - case NodeTypes.ORDERED_MAP_NODE : - LOG.debug("Reading ordered map node {}", identifier); - return addDataContainerChildren(Builders.orderedMapBuilder(). - withNodeIdentifier(identifier)).build(); - - case NodeTypes.UNKEYED_LIST : - LOG.debug("Read unkeyed list node {}", identifier); - return addDataContainerChildren(Builders.unkeyedListBuilder(). - withNodeIdentifier(identifier)).build(); - - case NodeTypes.UNKEYED_LIST_ITEM : - LOG.debug("Read unkeyed list item node {}", identifier); - return addDataContainerChildren(Builders.unkeyedListEntryBuilder(). - withNodeIdentifier(identifier)).build(); - - case NodeTypes.CONTAINER_NODE : - LOG.debug("Read container node {}", identifier); - return addDataContainerChildren(Builders.containerBuilder(). - withNodeIdentifier(identifier)).build(); + LOG.trace("Read map node {}", identifier); + return addDataContainerChildren(Builders.mapBuilder().withNodeIdentifier(identifier)).build(); + + case NodeTypes.CHOICE_NODE: + LOG.trace("Read choice node {}", identifier); + return addDataContainerChildren(Builders.choiceBuilder().withNodeIdentifier(identifier)).build(); + + case NodeTypes.ORDERED_MAP_NODE: + LOG.trace("Reading ordered map node {}", identifier); + return addDataContainerChildren(Builders.orderedMapBuilder().withNodeIdentifier(identifier)).build(); + + case NodeTypes.UNKEYED_LIST: + LOG.trace("Read unkeyed list node {}", identifier); + return addDataContainerChildren(Builders.unkeyedListBuilder().withNodeIdentifier(identifier)).build(); + + case NodeTypes.UNKEYED_LIST_ITEM: + LOG.trace("Read unkeyed list item node {}", identifier); + return addDataContainerChildren(Builders.unkeyedListEntryBuilder() + .withNodeIdentifier(identifier)).build(); + + case NodeTypes.CONTAINER_NODE: + LOG.trace("Read container node {}", identifier); + return addDataContainerChildren(Builders.containerBuilder().withNodeIdentifier(identifier)).build(); case NodeTypes.LEAF_SET : - LOG.debug("Read leaf set node {}", identifier); + LOG.trace("Read leaf set node {}", identifier); return addLeafSetChildren(identifier.getNodeType(), Builders.leafSetBuilder().withNodeIdentifier(identifier)).build(); + case NodeTypes.ORDERED_LEAF_SET: + LOG.trace("Read ordered leaf set node {}", identifier); + ListNodeBuilder> orderedLeafSetBuilder = + Builders.orderedLeafSetBuilder().withNodeIdentifier(identifier); + orderedLeafSetBuilder = addLeafSetChildren(identifier.getNodeType(), orderedLeafSetBuilder); + return orderedLeafSetBuilder.build(); + default : return null; } } + private DOMSource readDOMSource() throws IOException { + String xml = readObject().toString(); + try { + DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance(); + factory.setNamespaceAware(true); + Element node = factory.newDocumentBuilder().parse( + new InputSource(new StringReader(xml))).getDocumentElement(); + return new DOMSource(node); + } catch (SAXException | ParserConfigurationException e) { + throw new IOException("Error parsing XML: " + xml, e); + } + } + private QName readQName() throws IOException { // Read in the same sequence of writing String localName = readCodedString(); String namespace = readCodedString(); String revision = readCodedString(); - String qName; - if(!Strings.isNullOrEmpty(revision)) { - qName = reusableStringBuilder.append('(').append(namespace).append(REVISION_ARG). - append(revision).append(')').append(localName).toString(); + String qname; + if (!Strings.isNullOrEmpty(revision)) { + qname = reusableStringBuilder.append('(').append(namespace).append(REVISION_ARG).append(revision) + .append(')').append(localName).toString(); } else { - qName = reusableStringBuilder.append('(').append(namespace).append(')'). - append(localName).toString(); + qname = reusableStringBuilder.append('(').append(namespace).append(')').append(localName).toString(); } reusableStringBuilder.delete(0, reusableStringBuilder.length()); - return QNameFactory.create(qName); + return QNameFactory.create(qname); } private String readCodedString() throws IOException { byte valueType = input.readByte(); - if(valueType == NormalizedNodeOutputStreamWriter.IS_CODE_VALUE) { + if (valueType == TokenTypes.IS_CODE_VALUE) { return codedStringMap.get(input.readInt()); - } else if(valueType == NormalizedNodeOutputStreamWriter.IS_STRING_VALUE) { + } else if (valueType == TokenTypes.IS_STRING_VALUE) { String value = input.readUTF().intern(); - codedStringMap.put(Integer.valueOf(codedStringMap.size()), value); + codedStringMap.put(codedStringMap.size(), value); return value; } return null; } - private Set readQNameSet() throws IOException{ + private Set readQNameSet() throws IOException { // Read the children count int count = input.readInt(); Set children = new HashSet<>(count); - for(int i = 0; i < count; i++) { + for (int i = 0; i < count; i++) { children.add(readQName()); } return children; @@ -259,7 +283,7 @@ public class NormalizedNodeInputStreamReader implements NormalizedNodeStreamRead int count = input.readInt(); Map keyValueMap = new HashMap<>(count); - for(int i = 0; i < count; i++) { + for (int i = 0; i < count; i++) { keyValueMap.put(readQName(), readObject()); } @@ -268,31 +292,34 @@ public class NormalizedNodeInputStreamReader implements NormalizedNodeStreamRead private Object readObject() throws IOException { byte objectType = input.readByte(); - switch(objectType) { + switch (objectType) { case ValueTypes.BITS_TYPE: return readObjSet(); case ValueTypes.BOOL_TYPE : - return Boolean.valueOf(input.readBoolean()); + return input.readBoolean(); case ValueTypes.BYTE_TYPE : - return Byte.valueOf(input.readByte()); + return input.readByte(); case ValueTypes.INT_TYPE : - return Integer.valueOf(input.readInt()); + return input.readInt(); case ValueTypes.LONG_TYPE : - return Long.valueOf(input.readLong()); + return input.readLong(); case ValueTypes.QNAME_TYPE : return readQName(); case ValueTypes.SHORT_TYPE : - return Short.valueOf(input.readShort()); + return input.readShort(); case ValueTypes.STRING_TYPE : return input.readUTF(); + case ValueTypes.STRING_BYTES_TYPE: + return readStringBytes(); + case ValueTypes.BIG_DECIMAL_TYPE : return new BigDecimal(input.readUTF()); @@ -307,11 +334,41 @@ public class NormalizedNodeInputStreamReader implements NormalizedNodeStreamRead case ValueTypes.YANG_IDENTIFIER_TYPE : return readYangInstanceIdentifierInternal(); + case ValueTypes.EMPTY_TYPE: + // Leaf nodes no longer allow null values and thus we no longer emit null values. Previously, the "empty" + // yang type was represented as null so we translate an incoming null value to Empty. It was possible for + // a BI user to set a string leaf to null and we're rolling the dice here but the chances for that are + // very low. We'd have to know the yang type but, even if we did, we can't let a null value pass upstream + // so we'd have to drop the leaf which might cause other issues. + case ValueTypes.NULL_TYPE: + return Empty.getInstance(); + default : return null; } } + private String readStringBytes() throws IOException { + byte[] bytes = new byte[input.readInt()]; + input.readFully(bytes); + return new String(bytes, StandardCharsets.UTF_8); + } + + @Override + public SchemaPath readSchemaPath() throws IOException { + readSignatureMarkerAndVersionIfNeeded(); + + final boolean absolute = input.readBoolean(); + final int size = input.readInt(); + final Collection qnames = new ArrayList<>(size); + for (int i = 0; i < size; ++i) { + qnames.add(readQName()); + } + + return SchemaPath.create(qnames, absolute); + } + + @Override public YangInstanceIdentifier readYangInstanceIdentifier() throws IOException { readSignatureMarkerAndVersionIfNeeded(); return readYangInstanceIdentifierInternal(); @@ -322,7 +379,7 @@ public class NormalizedNodeInputStreamReader implements NormalizedNodeStreamRead List pathArguments = new ArrayList<>(size); - for(int i = 0; i < size; i++) { + for (int i = 0; i < size; i++) { pathArguments.add(readPathArgument()); } return YangInstanceIdentifier.create(pathArguments); @@ -331,17 +388,18 @@ public class NormalizedNodeInputStreamReader implements NormalizedNodeStreamRead private Set readObjSet() throws IOException { int count = input.readInt(); Set children = new HashSet<>(count); - for(int i = 0; i < count; i++) { + for (int i = 0; i < count; i++) { children.add(readCodedString()); } return children; } + @Override public PathArgument readPathArgument() throws IOException { // read Type int type = input.readByte(); - switch(type) { + switch (type) { case PathArgumentTypes.AUGMENTATION_IDENTIFIER : return new YangInstanceIdentifier.AugmentationIdentifier(readQNameSet()); @@ -353,7 +411,7 @@ public class NormalizedNodeInputStreamReader implements NormalizedNodeStreamRead return new NodeIdentifierWithPredicates(readQName(), readKeyValueMap()); case PathArgumentTypes.NODE_IDENTIFIER_WITH_VALUE : - return new NodeWithValue(readQName(), readObject()); + return new NodeWithValue<>(readQName(), readObject()); default : return null; @@ -361,16 +419,16 @@ public class NormalizedNodeInputStreamReader implements NormalizedNodeStreamRead } @SuppressWarnings("unchecked") - private ListNodeBuilder> addLeafSetChildren(QName nodeType, - ListNodeBuilder> builder) throws IOException { + private ListNodeBuilder> addLeafSetChildren(final QName nodeType, + final ListNodeBuilder> builder) throws IOException { - LOG.debug("Reading children of leaf set"); + LOG.trace("Reading children of leaf set"); lastLeafSetQName = nodeType; LeafSetEntryNode child = (LeafSetEntryNode)readNormalizedNodeInternal(); - while(child != null) { + while (child != null) { builder.withChild(child); child = (LeafSetEntryNode)readNormalizedNodeInternal(); } @@ -379,15 +437,105 @@ public class NormalizedNodeInputStreamReader implements NormalizedNodeStreamRead @SuppressWarnings({ "unchecked", "rawtypes" }) private NormalizedNodeContainerBuilder addDataContainerChildren( - NormalizedNodeContainerBuilder builder) throws IOException { - LOG.debug("Reading data container (leaf nodes) nodes"); + final NormalizedNodeContainerBuilder builder) throws IOException { + LOG.trace("Reading data container (leaf nodes) nodes"); NormalizedNode child = readNormalizedNodeInternal(); - while(child != null) { + while (child != null) { builder.addChild(child); child = readNormalizedNodeInternal(); } return builder; } + + @Override + public void readFully(final byte[] value) throws IOException { + readSignatureMarkerAndVersionIfNeeded(); + input.readFully(value); + } + + @Override + public void readFully(final byte[] str, final int off, final int len) throws IOException { + readSignatureMarkerAndVersionIfNeeded(); + input.readFully(str, off, len); + } + + @Override + public int skipBytes(final int num) throws IOException { + readSignatureMarkerAndVersionIfNeeded(); + return input.skipBytes(num); + } + + @Override + public boolean readBoolean() throws IOException { + readSignatureMarkerAndVersionIfNeeded(); + return input.readBoolean(); + } + + @Override + public byte readByte() throws IOException { + readSignatureMarkerAndVersionIfNeeded(); + return input.readByte(); + } + + @Override + public int readUnsignedByte() throws IOException { + readSignatureMarkerAndVersionIfNeeded(); + return input.readUnsignedByte(); + } + + @Override + public short readShort() throws IOException { + readSignatureMarkerAndVersionIfNeeded(); + return input.readShort(); + } + + @Override + public int readUnsignedShort() throws IOException { + readSignatureMarkerAndVersionIfNeeded(); + return input.readUnsignedShort(); + } + + @Override + public char readChar() throws IOException { + readSignatureMarkerAndVersionIfNeeded(); + return input.readChar(); + } + + @Override + public int readInt() throws IOException { + readSignatureMarkerAndVersionIfNeeded(); + return input.readInt(); + } + + @Override + public long readLong() throws IOException { + readSignatureMarkerAndVersionIfNeeded(); + return input.readLong(); + } + + @Override + public float readFloat() throws IOException { + readSignatureMarkerAndVersionIfNeeded(); + return input.readFloat(); + } + + @Override + public double readDouble() throws IOException { + readSignatureMarkerAndVersionIfNeeded(); + return input.readDouble(); + } + + @Override + public String readLine() throws IOException { + readSignatureMarkerAndVersionIfNeeded(); + return input.readLine(); + } + + @Override + public String readUTF() throws IOException { + readSignatureMarkerAndVersionIfNeeded(); + return input.readUTF(); + } }