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%2FAbstractNormalizedNodeDataOutput.java;h=2224357d42d96b3c5c9e1bdcdfd0c618b3631233;hp=02bebebd2949d397d9234a27215f1e84de0ce299;hb=68f179dcd8483dd7f681e134268a1eee29d09d55;hpb=77f491931ec07f6972869b8cbfa2207857990cec 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 index 02bebebd29..2224357d42 100755 --- 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,21 +7,24 @@ */ 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.eclipse.jdt.annotation.NonNull; import org.opendaylight.yangtools.yang.common.QName; import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier; import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier; @@ -36,6 +39,20 @@ import org.opendaylight.yangtools.yang.model.api.SchemaPath; import org.slf4j.Logger; import org.slf4j.LoggerFactory; +/** + * NormalizedNodeOutputStreamWriter will be used by distributed datastore to send normalized node in + * a stream. + * A stream writer wrapper around this class will write node objects to stream in recursive manner. + * for example - If you have a ContainerNode which has a two LeafNode as children, then + * you will first call + * {@link #startContainerNode(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier, int)}, + * then will call + * {@link #leafNode(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier, Object)} twice + * and then, {@link #endNode()} to end container node. + * + *

Based on the each node, the node type is also written to the stream, that helps in reconstructing the object, + * while reading. + */ abstract class AbstractNormalizedNodeDataOutput implements NormalizedNodeDataOutput, NormalizedNodeStreamWriter { private static final Logger LOG = LoggerFactory.getLogger(AbstractNormalizedNodeDataOutput.class); @@ -44,9 +61,10 @@ 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 { @@ -59,8 +77,6 @@ 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 @@ -162,146 +178,119 @@ abstract class AbstractNormalizedNodeDataOutput implements NormalizedNodeDataOut } @Override - public void leafNode(final NodeIdentifier name, final Object value) throws IOException, IllegalArgumentException { - Preconditions.checkNotNull(name, "Node identifier should not be null"); - LOG.trace("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 NodeIdentifier name, final int childSizeHint) - - throws IOException, IllegalArgumentException { - Preconditions.checkNotNull(name, "Node identifier should not be null"); + public void startLeafSet(final NodeIdentifier name, final int childSizeHint) throws IOException { LOG.trace("Starting a new leaf set"); - - lastLeafSetQName = name.getNodeType(); - startNode(name.getNodeType(), NodeTypes.LEAF_SET); + commonStartLeafSet(name, NodeTypes.LEAF_SET); } @Override - public void startOrderedLeafSet(final NodeIdentifier name, final int childSizeHint) - throws IOException, IllegalArgumentException { - Preconditions.checkNotNull(name, "Node identifier should not be null"); + 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); + } + private void commonStartLeafSet(final NodeIdentifier name, final byte nodeType) throws IOException { + startNode(name, nodeType); lastLeafSetQName = name.getNodeType(); - startNode(name.getNodeType(), NodeTypes.ORDERED_LEAF_SET); } @Override - public void leafSetEntryNode(final QName name, final Object value) throws IOException, IllegalArgumentException { - LOG.trace("Writing a new leaf set entry node"); + public void startLeafSetEntryNode(final NodeWithValue name) throws IOException { + LOG.trace("Starting a new leaf set entry node"); output.writeByte(NodeTypes.LEAF_SET_ENTRY_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); + writeQName(name.getNodeType()); } - - writeObject(value); + inSimple = true; } @Override - public void startContainerNode(final NodeIdentifier name, final int childSizeHint) - throws IOException, IllegalArgumentException { - Preconditions.checkNotNull(name, "Node identifier should not be null"); - + public void startContainerNode(final NodeIdentifier name, final int childSizeHint) throws IOException { LOG.trace("Starting a new container node"); - - startNode(name.getNodeType(), NodeTypes.CONTAINER_NODE); + startNode(name, NodeTypes.CONTAINER_NODE); } @Override - public void startYangModeledAnyXmlNode(final NodeIdentifier name, final int childSizeHint) - throws IOException, IllegalArgumentException { - Preconditions.checkNotNull(name, "Node identifier should not be null"); - + public void startYangModeledAnyXmlNode(final NodeIdentifier name, final int childSizeHint) throws IOException { LOG.trace("Starting a new yang modeled anyXml node"); - - startNode(name.getNodeType(), NodeTypes.YANG_MODELED_ANY_XML_NODE); + startNode(name, NodeTypes.YANG_MODELED_ANY_XML_NODE); } @Override - public void startUnkeyedList(final NodeIdentifier name, final int childSizeHint) - throws IOException, IllegalArgumentException { - Preconditions.checkNotNull(name, "Node identifier should not be null"); + public void startUnkeyedList(final NodeIdentifier name, final int childSizeHint) throws IOException { LOG.trace("Starting a new unkeyed list"); - - startNode(name.getNodeType(), NodeTypes.UNKEYED_LIST); + startNode(name, NodeTypes.UNKEYED_LIST); } @Override - public void startUnkeyedListItem(final NodeIdentifier name, final int childSizeHint) - throws IOException, IllegalStateException { - Preconditions.checkNotNull(name, "Node identifier should not be null"); + public void startUnkeyedListItem(final NodeIdentifier name, final int childSizeHint) throws IOException { LOG.trace("Starting a new unkeyed list item"); - - startNode(name.getNodeType(), NodeTypes.UNKEYED_LIST_ITEM); + startNode(name, NodeTypes.UNKEYED_LIST_ITEM); } @Override - public void startMapNode(final NodeIdentifier name, final int childSizeHint) - throws IOException, IllegalArgumentException { - Preconditions.checkNotNull(name, "Node identifier should not be null"); + public void startMapNode(final NodeIdentifier name, final int childSizeHint) throws IOException { LOG.trace("Starting a new map node"); - - startNode(name.getNodeType(), NodeTypes.MAP_NODE); + startNode(name, NodeTypes.MAP_NODE); } @Override public void startMapEntryNode(final NodeIdentifierWithPredicates identifier, final int childSizeHint) - throws IOException, IllegalArgumentException { - Preconditions.checkNotNull(identifier, "Node identifier should not be null"); + throws IOException { LOG.trace("Starting a new map entry node"); - startNode(identifier.getNodeType(), NodeTypes.MAP_ENTRY_NODE); - - writeKeyValueMap(identifier.getKeyValues()); - + startNode(identifier, NodeTypes.MAP_ENTRY_NODE); + writeKeyValueMap(identifier.entrySet()); } @Override - public void startOrderedMapNode(final NodeIdentifier name, final int childSizeHint) - throws IOException, IllegalArgumentException { - Preconditions.checkNotNull(name, "Node identifier should not be null"); + public void startOrderedMapNode(final NodeIdentifier name, final int childSizeHint) throws IOException { LOG.trace("Starting a new ordered map node"); - - startNode(name.getNodeType(), NodeTypes.ORDERED_MAP_NODE); + startNode(name, NodeTypes.ORDERED_MAP_NODE); } @Override - public void startChoiceNode(final NodeIdentifier name, final int childSizeHint) - throws IOException, IllegalArgumentException { - Preconditions.checkNotNull(name, "Node identifier should not be null"); + public void startChoiceNode(final NodeIdentifier name, final int childSizeHint) throws IOException { LOG.trace("Starting a new choice node"); - - startNode(name.getNodeType(), NodeTypes.CHOICE_NODE); + startNode(name, NodeTypes.CHOICE_NODE); } @Override - public void startAugmentationNode(final AugmentationIdentifier identifier) - throws IOException, IllegalArgumentException { - Preconditions.checkNotNull(identifier, "Node identifier should not be null"); + 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 NodeIdentifier name, final Object value) throws IOException, IllegalArgumentException { - Preconditions.checkNotNull(name, "Node identifier should not be null"); - LOG.trace("Writing 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; + } - startNode(name.getNodeType(), NodeTypes.ANY_XML_NODE); + @Override + public void scalarValue(final Object value) throws IOException { + writeObject(value); + } + @Override + public void domSourceValue(final DOMSource value) throws IOException { try { StreamResult xmlOutput = new StreamResult(new StringWriter()); - TransformerFactory.newInstance().newTransformer().transform((DOMSource)value, xmlOutput); + TransformerFactory.newInstance().newTransformer().transform(value, xmlOutput); writeObject(xmlOutput.getWriter().toString()); } catch (TransformerException | TransformerFactoryConfigurationError e) { throw new IOException("Error writing anyXml", e); @@ -309,10 +298,13 @@ abstract class AbstractNormalizedNodeDataOutput implements NormalizedNodeDataOut } @Override - public void endNode() throws IOException, IllegalStateException { + public void endNode() throws IOException { LOG.trace("Ending the node"); - lastLeafSetQName = null; - output.writeByte(NodeTypes.END_NODE); + if (!inSimple) { + lastLeafSetQName = null; + output.writeByte(NodeTypes.END_NODE); + } + inSimple = false; } @Override @@ -327,23 +319,22 @@ 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 { + final 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); } } @@ -366,7 +357,7 @@ abstract class AbstractNormalizedNodeDataOutput implements NormalizedNodeDataOut writeYangInstanceIdentifierInternal(identifier); } - private void writeYangInstanceIdentifierInternal(final YangInstanceIdentifier identifier) throws IOException { + final void writeYangInstanceIdentifierInternal(final YangInstanceIdentifier identifier) throws IOException { Collection pathArguments = identifier.getPathArguments(); output.writeInt(pathArguments.size()); @@ -398,7 +389,7 @@ abstract class AbstractNormalizedNodeDataOutput implements NormalizedNodeDataOut (NodeIdentifierWithPredicates) pathArgument; writeQName(nodeIdentifierWithPredicates.getNodeType()); - writeKeyValueMap(nodeIdentifierWithPredicates.getKeyValues()); + writeKeyValueMap(nodeIdentifierWithPredicates.entrySet()); break; case PathArgumentTypes.NODE_IDENTIFIER_WITH_VALUE : @@ -411,10 +402,8 @@ abstract class AbstractNormalizedNodeDataOutput implements NormalizedNodeDataOut case PathArgumentTypes.AUGMENTATION_IDENTIFIER : - AugmentationIdentifier augmentationIdentifier = (AugmentationIdentifier) pathArgument; - // No Qname in augmentation identifier - writeQNameSet(augmentationIdentifier.getPossibleChildNames()); + writeAugmentationIdentifier((AugmentationIdentifier) pathArgument); break; default : throw new IllegalStateException("Unknown node identifier type is found : " @@ -422,11 +411,10 @@ abstract class AbstractNormalizedNodeDataOutput implements NormalizedNodeDataOut } } - private void writeKeyValueMap(final Map keyValueMap) throws IOException { - if (keyValueMap != null && !keyValueMap.isEmpty()) { - output.writeInt(keyValueMap.size()); - - for (Map.Entry entry : keyValueMap.entrySet()) { + 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()); } @@ -435,11 +423,12 @@ abstract class AbstractNormalizedNodeDataOutput implements NormalizedNodeDataOut } } - 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) { + if (!qnames.isEmpty()) { + output.writeInt(qnames.size()); + for (QName qname : qnames) { writeQName(qname); } } else { @@ -448,52 +437,9 @@ abstract class AbstractNormalizedNodeDataOutput implements NormalizedNodeDataOut } } - private void writeObject(final Object value) throws IOException { - - byte type = ValueTypes.getSerializableType(value); - // Write object type first - output.writeByte(type); + abstract void writeObject(@NonNull DataOutput output, @NonNull Object value) throws IOException; - switch (type) { - case ValueTypes.BOOL_TYPE: - output.writeBoolean((Boolean) value); - break; - case ValueTypes.QNAME_TYPE: - writeQName((QName) value); - break; - case ValueTypes.INT_TYPE: - output.writeInt((Integer) value); - break; - case ValueTypes.BYTE_TYPE: - output.writeByte((Byte) value); - break; - case ValueTypes.LONG_TYPE: - output.writeLong((Long) value); - break; - case ValueTypes.SHORT_TYPE: - output.writeShort((Short) value); - break; - case ValueTypes.BITS_TYPE: - writeObjSet((Set) value); - break; - case ValueTypes.BINARY_TYPE: - byte[] bytes = (byte[]) value; - output.writeInt(bytes.length); - output.write(bytes); - break; - case ValueTypes.YANG_IDENTIFIER_TYPE: - writeYangInstanceIdentifierInternal((YangInstanceIdentifier) value); - break; - case ValueTypes.EMPTY_TYPE: - break; - case ValueTypes.STRING_BYTES_TYPE: - final byte[] valueBytes = value.toString().getBytes(StandardCharsets.UTF_8); - output.writeInt(valueBytes.length); - output.write(valueBytes); - break; - default: - output.writeUTF(value.toString()); - break; - } + private void writeObject(final Object value) throws IOException { + writeObject(output, value); } }