X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-clustering-commons%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fcluster%2Fdatastore%2Fnode%2Futils%2Fstream%2FAbstractNormalizedNodeDataOutput.java;h=cf4ec56ced5b0882e191069bca1b5b70786b493b;hb=b08cec09b7113965fbda5ef1757ca23d7588e5cc;hp=f8ea298458db5ecc1f01f7936f0c322e36b48e37;hpb=09419e51e2e0b771b1ae013bb4c8bdf7a4f984eb;p=controller.git diff --git a/opendaylight/md-sal/sal-clustering-commons/src/main/java/org/opendaylight/controller/cluster/datastore/node/utils/stream/AbstractNormalizedNodeDataOutput.java b/opendaylight/md-sal/sal-clustering-commons/src/main/java/org/opendaylight/controller/cluster/datastore/node/utils/stream/AbstractNormalizedNodeDataOutput.java old mode 100644 new mode 100755 index f8ea298458..cf4ec56ced --- a/opendaylight/md-sal/sal-clustering-commons/src/main/java/org/opendaylight/controller/cluster/datastore/node/utils/stream/AbstractNormalizedNodeDataOutput.java +++ b/opendaylight/md-sal/sal-clustering-commons/src/main/java/org/opendaylight/controller/cluster/datastore/node/utils/stream/AbstractNormalizedNodeDataOutput.java @@ -7,19 +7,35 @@ */ package org.opendaylight.controller.cluster.datastore.node.utils.stream; -import com.google.common.base.Preconditions; +import static com.google.common.base.Preconditions.checkArgument; +import static com.google.common.base.Preconditions.checkState; +import static java.util.Objects.requireNonNull; + +import edu.umd.cs.findbugs.annotations.SuppressFBWarnings; import java.io.DataOutput; import java.io.IOException; import java.io.OutputStream; +import java.io.StringWriter; import java.nio.charset.StandardCharsets; import java.util.Collection; -import java.util.Map; +import java.util.Map.Entry; import java.util.Set; +import javax.xml.transform.TransformerException; +import javax.xml.transform.TransformerFactory; +import javax.xml.transform.TransformerFactoryConfigurationError; +import javax.xml.transform.dom.DOMSource; +import javax.xml.transform.stream.StreamResult; import org.opendaylight.yangtools.yang.common.QName; import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier; +import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier; +import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier; +import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates; +import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue; +import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument; import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode; import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter; import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeWriter; +import org.opendaylight.yangtools.yang.model.api.SchemaPath; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -30,9 +46,11 @@ abstract class AbstractNormalizedNodeDataOutput implements NormalizedNodeDataOut private NormalizedNodeWriter normalizedNodeWriter; private boolean headerWritten; + private QName lastLeafSetQName; + private boolean inSimple; AbstractNormalizedNodeDataOutput(final DataOutput output) { - this.output = Preconditions.checkNotNull(output); + this.output = requireNonNull(output); } private void ensureHeaderWritten() throws IOException { @@ -44,95 +62,95 @@ abstract class AbstractNormalizedNodeDataOutput implements NormalizedNodeDataOut } protected abstract short streamVersion(); - protected abstract void writeQName(QName qname) throws IOException; + protected abstract void writeString(String string) throws IOException; @Override - public final void write(final int b) throws IOException { + public final void write(final int value) throws IOException { ensureHeaderWritten(); - output.write(b); + output.write(value); } @Override - public final void write(final byte[] b) throws IOException { + public final void write(final byte[] bytes) throws IOException { ensureHeaderWritten(); - output.write(b); + output.write(bytes); } @Override - public final void write(final byte[] b, final int off, final int len) throws IOException { + public final void write(final byte[] bytes, final int off, final int len) throws IOException { ensureHeaderWritten(); - output.write(b, off, len); + output.write(bytes, off, len); } @Override - public final void writeBoolean(final boolean v) throws IOException { + public final void writeBoolean(final boolean value) throws IOException { ensureHeaderWritten(); - output.writeBoolean(v); + output.writeBoolean(value); } @Override - public final void writeByte(final int v) throws IOException { + public final void writeByte(final int value) throws IOException { ensureHeaderWritten(); - output.writeByte(v); + output.writeByte(value); } @Override - public final void writeShort(final int v) throws IOException { + public final void writeShort(final int value) throws IOException { ensureHeaderWritten(); - output.writeShort(v); + output.writeShort(value); } @Override - public final void writeChar(final int v) throws IOException { + public final void writeChar(final int value) throws IOException { ensureHeaderWritten(); - output.writeChar(v); + output.writeChar(value); } @Override - public final void writeInt(final int v) throws IOException { + public final void writeInt(final int value) throws IOException { ensureHeaderWritten(); - output.writeInt(v); + output.writeInt(value); } @Override - public final void writeLong(final long v) throws IOException { + public final void writeLong(final long value) throws IOException { ensureHeaderWritten(); - output.writeLong(v); + output.writeLong(value); } @Override - public final void writeFloat(final float v) throws IOException { + public final void writeFloat(final float value) throws IOException { ensureHeaderWritten(); - output.writeFloat(v); + output.writeFloat(value); } @Override - public final void writeDouble(final double v) throws IOException { + public final void writeDouble(final double value) throws IOException { ensureHeaderWritten(); - output.writeDouble(v); + output.writeDouble(value); } @Override - public final void writeBytes(final String s) throws IOException { + public final void writeBytes(final String str) throws IOException { ensureHeaderWritten(); - output.writeBytes(s); + output.writeBytes(str); } @Override - public final void writeChars(final String s) throws IOException { + public final void writeChars(final String str) throws IOException { ensureHeaderWritten(); - output.writeChars(s); + output.writeChars(str); } @Override - public final void writeUTF(final String s) throws IOException { + public final void writeUTF(final String str) throws IOException { ensureHeaderWritten(); - output.writeUTF(s); + output.writeUTF(str); } private NormalizedNodeWriter normalizedNodeWriter() { - if(normalizedNodeWriter == null) { + if (normalizedNodeWriter == null) { normalizedNodeWriter = NormalizedNodeWriter.forStreamWriter(this); } @@ -146,122 +164,133 @@ abstract class AbstractNormalizedNodeDataOutput implements NormalizedNodeDataOut } @Override - public void leafNode(final YangInstanceIdentifier.NodeIdentifier name, final Object value) throws IOException, IllegalArgumentException { - Preconditions.checkNotNull(name, "Node identifier should not be null"); - LOG.debug("Writing a new leaf node"); - startNode(name.getNodeType(), NodeTypes.LEAF_NODE); - - writeObject(value); + public void startLeafNode(final NodeIdentifier name) throws IOException { + LOG.trace("Starting a new leaf node"); + startNode(name, NodeTypes.LEAF_NODE); + inSimple = true; } @Override - public void startLeafSet(final YangInstanceIdentifier.NodeIdentifier name, final int childSizeHint) throws IOException, IllegalArgumentException { - Preconditions.checkNotNull(name, "Node identifier should not be null"); - LOG.debug("Starting a new leaf set"); - - startNode(name.getNodeType(), NodeTypes.LEAF_SET); + public void startLeafSet(final NodeIdentifier name, final int childSizeHint) throws IOException { + LOG.trace("Starting a new leaf set"); + commonStartLeafSet(name, NodeTypes.LEAF_SET); } @Override - public void leafSetEntryNode(final Object value) throws IOException, IllegalArgumentException { - LOG.debug("Writing a new leaf set entry node"); + public void startOrderedLeafSet(final NodeIdentifier name, final int childSizeHint) throws IOException { + LOG.trace("Starting a new ordered leaf set"); + commonStartLeafSet(name, NodeTypes.ORDERED_LEAF_SET); + } - output.writeByte(NodeTypes.LEAF_SET_ENTRY_NODE); - writeObject(value); + private void commonStartLeafSet(final NodeIdentifier name, final byte nodeType) throws IOException { + startNode(name, nodeType); + lastLeafSetQName = name.getNodeType(); } @Override - public void startContainerNode(final YangInstanceIdentifier.NodeIdentifier name, final int childSizeHint) throws IOException, IllegalArgumentException { - Preconditions.checkNotNull(name, "Node identifier should not be null"); + public void startLeafSetEntryNode(final NodeWithValue name) throws IOException { + LOG.trace("Starting a new leaf set entry node"); - LOG.debug("Starting a new container node"); + output.writeByte(NodeTypes.LEAF_SET_ENTRY_NODE); - startNode(name.getNodeType(), NodeTypes.CONTAINER_NODE); + // lastLeafSetQName is set if the parent LeafSetNode was previously written. Otherwise this is a + // stand alone LeafSetEntryNode so write out it's name here. + if (lastLeafSetQName == null) { + writeQName(name.getNodeType()); + } + inSimple = true; } @Override - public void startYangModeledAnyXmlNode(final YangInstanceIdentifier.NodeIdentifier name, final int childSizeHint) throws IOException, IllegalArgumentException { - Preconditions.checkNotNull(name, "Node identifier should not be null"); - - LOG.debug("Starting a new yang modeled anyXml node"); - - startNode(name.getNodeType(), NodeTypes.YANG_MODELED_ANY_XML_NODE); + public void startContainerNode(final NodeIdentifier name, final int childSizeHint) throws IOException { + LOG.trace("Starting a new container node"); + startNode(name, NodeTypes.CONTAINER_NODE); } @Override - public void startUnkeyedList(final YangInstanceIdentifier.NodeIdentifier name, final int childSizeHint) throws IOException, IllegalArgumentException { - Preconditions.checkNotNull(name, "Node identifier should not be null"); - LOG.debug("Starting a new unkeyed list"); - - startNode(name.getNodeType(), NodeTypes.UNKEYED_LIST); + public void startYangModeledAnyXmlNode(final NodeIdentifier name, final int childSizeHint) throws IOException { + LOG.trace("Starting a new yang modeled anyXml node"); + startNode(name, NodeTypes.YANG_MODELED_ANY_XML_NODE); } @Override - public void startUnkeyedListItem(final YangInstanceIdentifier.NodeIdentifier name, final int childSizeHint) throws IOException, IllegalStateException { - Preconditions.checkNotNull(name, "Node identifier should not be null"); - LOG.debug("Starting a new unkeyed list item"); - - startNode(name.getNodeType(), NodeTypes.UNKEYED_LIST_ITEM); + public void startUnkeyedList(final NodeIdentifier name, final int childSizeHint) throws IOException { + LOG.trace("Starting a new unkeyed list"); + startNode(name, NodeTypes.UNKEYED_LIST); } @Override - public void startMapNode(final YangInstanceIdentifier.NodeIdentifier name, final int childSizeHint) throws IOException, IllegalArgumentException { - Preconditions.checkNotNull(name, "Node identifier should not be null"); - LOG.debug("Starting a new map node"); - - startNode(name.getNodeType(), NodeTypes.MAP_NODE); + public void startUnkeyedListItem(final NodeIdentifier name, final int childSizeHint) throws IOException { + LOG.trace("Starting a new unkeyed list item"); + startNode(name, NodeTypes.UNKEYED_LIST_ITEM); } @Override - public void startMapEntryNode(final YangInstanceIdentifier.NodeIdentifierWithPredicates identifier, final int childSizeHint) throws IOException, IllegalArgumentException { - Preconditions.checkNotNull(identifier, "Node identifier should not be null"); - LOG.debug("Starting a new map entry node"); - startNode(identifier.getNodeType(), NodeTypes.MAP_ENTRY_NODE); - - writeKeyValueMap(identifier.getKeyValues()); - + public void startMapNode(final NodeIdentifier name, final int childSizeHint) throws IOException { + LOG.trace("Starting a new map node"); + startNode(name, NodeTypes.MAP_NODE); } @Override - public void startOrderedMapNode(final YangInstanceIdentifier.NodeIdentifier name, final int childSizeHint) throws IOException, IllegalArgumentException { - Preconditions.checkNotNull(name, "Node identifier should not be null"); - LOG.debug("Starting a new ordered map node"); - - startNode(name.getNodeType(), NodeTypes.ORDERED_MAP_NODE); + public void startMapEntryNode(final NodeIdentifierWithPredicates identifier, final int childSizeHint) + throws IOException { + LOG.trace("Starting a new map entry node"); + startNode(identifier, NodeTypes.MAP_ENTRY_NODE); + writeKeyValueMap(identifier.entrySet()); } @Override - public void startChoiceNode(final YangInstanceIdentifier.NodeIdentifier name, final int childSizeHint) throws IOException, IllegalArgumentException { - Preconditions.checkNotNull(name, "Node identifier should not be null"); - LOG.debug("Starting a new choice node"); + public void startOrderedMapNode(final NodeIdentifier name, final int childSizeHint) throws IOException { + LOG.trace("Starting a new ordered map node"); + startNode(name, NodeTypes.ORDERED_MAP_NODE); + } - startNode(name.getNodeType(), NodeTypes.CHOICE_NODE); + @Override + public void startChoiceNode(final NodeIdentifier name, final int childSizeHint) throws IOException { + LOG.trace("Starting a new choice node"); + startNode(name, NodeTypes.CHOICE_NODE); } @Override - public void startAugmentationNode(final YangInstanceIdentifier.AugmentationIdentifier identifier) throws IOException, IllegalArgumentException { - Preconditions.checkNotNull(identifier, "Node identifier should not be null"); - LOG.debug("Starting a new augmentation node"); + public void startAugmentationNode(final AugmentationIdentifier identifier) throws IOException { + requireNonNull(identifier, "Node identifier should not be null"); + LOG.trace("Starting a new augmentation node"); output.writeByte(NodeTypes.AUGMENTATION_NODE); - writeQNameSet(identifier.getPossibleChildNames()); + writeAugmentationIdentifier(identifier); } @Override - public void anyxmlNode(final YangInstanceIdentifier.NodeIdentifier name, final Object value) throws IOException, IllegalArgumentException { - Preconditions.checkNotNull(name, "Node identifier should not be null"); - LOG.debug("Writing a new xml node"); - - startNode(name.getNodeType(), NodeTypes.ANY_XML_NODE); + public void startAnyxmlNode(final NodeIdentifier name) throws IOException { + LOG.trace("Starting any xml node"); + startNode(name, NodeTypes.ANY_XML_NODE); + inSimple = true; + } + @Override + public void scalarValue(final Object value) throws IOException { writeObject(value); } @Override - public void endNode() throws IOException, IllegalStateException { - LOG.debug("Ending the node"); + public void domSourceValue(final DOMSource value) throws IOException { + try { + StreamResult xmlOutput = new StreamResult(new StringWriter()); + TransformerFactory.newInstance().newTransformer().transform(value, xmlOutput); + writeObject(xmlOutput.getWriter().toString()); + } catch (TransformerException | TransformerFactoryConfigurationError e) { + throw new IOException("Error writing anyXml", e); + } + } - output.writeByte(NodeTypes.END_NODE); + @Override + public void endNode() throws IOException { + LOG.trace("Ending the node"); + if (!inSimple) { + lastLeafSetQName = null; + output.writeByte(NodeTypes.END_NODE); + } + inSimple = false; } @Override @@ -276,28 +305,38 @@ abstract class AbstractNormalizedNodeDataOutput implements NormalizedNodeDataOut } } - private void startNode(final QName qName, final byte nodeType) throws IOException { - - Preconditions.checkNotNull(qName, "QName of node identifier should not be null."); + private void startNode(final PathArgument arg, final byte nodeType) throws IOException { + requireNonNull(arg, "Node identifier should not be null"); + checkState(!inSimple, "Attempted to start a child in a simple node"); ensureHeaderWritten(); // First write the type of node output.writeByte(nodeType); // Write Start Tag - writeQName(qName); + writeQName(arg.getNodeType()); } private void writeObjSet(final Set set) throws IOException { output.writeInt(set.size()); for (Object o : set) { - Preconditions.checkArgument(o instanceof String, "Expected value type to be String but was %s (%s)", - o.getClass(), o); - + checkArgument(o instanceof String, "Expected value type to be String but was %s (%s)", o.getClass(), o); writeString((String) o); } } + @Override + public void writeSchemaPath(final SchemaPath path) throws IOException { + ensureHeaderWritten(); + output.writeBoolean(path.isAbsolute()); + + final Collection qnames = path.getPath(); + output.writeInt(qnames.size()); + for (QName qname : qnames) { + writeQName(qname); + } + } + @Override public void writeYangInstanceIdentifier(final YangInstanceIdentifier identifier) throws IOException { ensureHeaderWritten(); @@ -305,43 +344,43 @@ abstract class AbstractNormalizedNodeDataOutput implements NormalizedNodeDataOut } private void writeYangInstanceIdentifierInternal(final YangInstanceIdentifier identifier) throws IOException { - Collection pathArguments = identifier.getPathArguments(); + Collection pathArguments = identifier.getPathArguments(); output.writeInt(pathArguments.size()); - for(YangInstanceIdentifier.PathArgument pathArgument : pathArguments) { + for (PathArgument pathArgument : pathArguments) { writePathArgument(pathArgument); } } + @SuppressFBWarnings(value = "BC_UNCONFIRMED_CAST", + justification = "The casts in the switch clauses are indirectly confirmed via the determination of 'type'.") @Override - public void writePathArgument(final YangInstanceIdentifier.PathArgument pathArgument) throws IOException { + public void writePathArgument(final PathArgument pathArgument) throws IOException { byte type = PathArgumentTypes.getSerializablePathArgumentType(pathArgument); output.writeByte(type); - switch(type) { + switch (type) { case PathArgumentTypes.NODE_IDENTIFIER: - YangInstanceIdentifier.NodeIdentifier nodeIdentifier = - (YangInstanceIdentifier.NodeIdentifier) pathArgument; + NodeIdentifier nodeIdentifier = (NodeIdentifier) pathArgument; writeQName(nodeIdentifier.getNodeType()); break; case PathArgumentTypes.NODE_IDENTIFIER_WITH_PREDICATES: - YangInstanceIdentifier.NodeIdentifierWithPredicates nodeIdentifierWithPredicates = - (YangInstanceIdentifier.NodeIdentifierWithPredicates) pathArgument; + NodeIdentifierWithPredicates nodeIdentifierWithPredicates = + (NodeIdentifierWithPredicates) pathArgument; writeQName(nodeIdentifierWithPredicates.getNodeType()); - writeKeyValueMap(nodeIdentifierWithPredicates.getKeyValues()); + writeKeyValueMap(nodeIdentifierWithPredicates.entrySet()); break; case PathArgumentTypes.NODE_IDENTIFIER_WITH_VALUE : - YangInstanceIdentifier.NodeWithValue nodeWithValue = - (YangInstanceIdentifier.NodeWithValue) pathArgument; + NodeWithValue nodeWithValue = (NodeWithValue) pathArgument; writeQName(nodeWithValue.getNodeType()); writeObject(nodeWithValue.getValue()); @@ -349,36 +388,34 @@ abstract class AbstractNormalizedNodeDataOutput implements NormalizedNodeDataOut case PathArgumentTypes.AUGMENTATION_IDENTIFIER : - YangInstanceIdentifier.AugmentationIdentifier augmentationIdentifier = - (YangInstanceIdentifier.AugmentationIdentifier) pathArgument; - // No Qname in augmentation identifier - writeQNameSet(augmentationIdentifier.getPossibleChildNames()); + writeAugmentationIdentifier((AugmentationIdentifier) pathArgument); break; default : - throw new IllegalStateException("Unknown node identifier type is found : " + pathArgument.getClass().toString() ); + throw new IllegalStateException("Unknown node identifier type is found : " + + pathArgument.getClass().toString()); } } - private void writeKeyValueMap(final Map keyValueMap) throws IOException { - if (keyValueMap != null && !keyValueMap.isEmpty()) { - output.writeInt(keyValueMap.size()); - - for (QName qName : keyValueMap.keySet()) { - writeQName(qName); - writeObject(keyValueMap.get(qName)); + private void writeKeyValueMap(final Set> entrySet) throws IOException { + if (!entrySet.isEmpty()) { + output.writeInt(entrySet.size()); + for (Entry entry : entrySet) { + writeQName(entry.getKey()); + writeObject(entry.getValue()); } } else { output.writeInt(0); } } - private void writeQNameSet(final Set children) throws IOException { + void writeAugmentationIdentifier(final AugmentationIdentifier aid) throws IOException { + final Set qnames = aid.getPossibleChildNames(); // Write each child's qname separately, if list is empty send count as 0 - if (children != null && !children.isEmpty()) { - output.writeInt(children.size()); - for (QName qName : children) { - writeQName(qName); + if (!qnames.isEmpty()) { + output.writeInt(qnames.size()); + for (QName qname : qnames) { + writeQName(qname); } } else { LOG.debug("augmentation node does not have any child"); @@ -422,7 +459,7 @@ abstract class AbstractNormalizedNodeDataOutput implements NormalizedNodeDataOut case ValueTypes.YANG_IDENTIFIER_TYPE: writeYangInstanceIdentifierInternal((YangInstanceIdentifier) value); break; - case ValueTypes.NULL_TYPE : + case ValueTypes.EMPTY_TYPE: break; case ValueTypes.STRING_BYTES_TYPE: final byte[] valueBytes = value.toString().getBytes(StandardCharsets.UTF_8);