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=161a450ddc6b7993f49f4f6ff97ecad2ee0b0df2;hb=68f179dcd8483dd7f681e134268a1eee29d09d55;hpb=69584f4fa7b55eb89d28b3b1d8003b7c4918b5b6 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 161a450ddc..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,13 +7,15 @@ */ 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.Entry; import java.util.Set; @@ -22,6 +24,7 @@ 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); @@ -47,7 +64,7 @@ abstract class AbstractNormalizedNodeDataOutput implements NormalizedNodeDataOut private boolean inSimple; AbstractNormalizedNodeDataOutput(final DataOutput output) { - this.output = Preconditions.checkNotNull(output); + this.output = requireNonNull(output); } private void ensureHeaderWritten() throws IOException { @@ -162,28 +179,26 @@ abstract class AbstractNormalizedNodeDataOutput implements NormalizedNodeDataOut @Override public void startLeafNode(final NodeIdentifier name) throws IOException { - Preconditions.checkNotNull(name, "Node identifier should not be null"); LOG.trace("Starting a new leaf node"); - startNode(name.getNodeType(), NodeTypes.LEAF_NODE); + startNode(name, NodeTypes.LEAF_NODE); inSimple = true; } @Override public void startLeafSet(final NodeIdentifier name, final int childSizeHint) throws IOException { - Preconditions.checkNotNull(name, "Node identifier should not be null"); 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 { - Preconditions.checkNotNull(name, "Node identifier should not be null"); 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 @@ -202,75 +217,57 @@ abstract class AbstractNormalizedNodeDataOutput implements NormalizedNodeDataOut @Override public void startContainerNode(final NodeIdentifier name, final int childSizeHint) throws IOException { - Preconditions.checkNotNull(name, "Node identifier should not be null"); - 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 { - Preconditions.checkNotNull(name, "Node identifier should not be null"); - 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 { - Preconditions.checkNotNull(name, "Node identifier should not be null"); 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 { - Preconditions.checkNotNull(name, "Node identifier should not be null"); 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 { - Preconditions.checkNotNull(name, "Node identifier should not be null"); 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 { - Preconditions.checkNotNull(identifier, "Node identifier should not be null"); LOG.trace("Starting a new map entry node"); - startNode(identifier.getNodeType(), NodeTypes.MAP_ENTRY_NODE); - + startNode(identifier, NodeTypes.MAP_ENTRY_NODE); writeKeyValueMap(identifier.entrySet()); } @Override public void startOrderedMapNode(final NodeIdentifier name, final int childSizeHint) throws IOException { - Preconditions.checkNotNull(name, "Node identifier should not be null"); 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 { - Preconditions.checkNotNull(name, "Node identifier should not be null"); 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 { - Preconditions.checkNotNull(identifier, "Node identifier should not be null"); + requireNonNull(identifier, "Node identifier should not be null"); LOG.trace("Starting a new augmentation node"); output.writeByte(NodeTypes.AUGMENTATION_NODE); @@ -279,9 +276,8 @@ abstract class AbstractNormalizedNodeDataOutput implements NormalizedNodeDataOut @Override public void startAnyxmlNode(final NodeIdentifier name) throws IOException { - Preconditions.checkNotNull(name, "Node identifier should not be null"); LOG.trace("Starting any xml node"); - startNode(name.getNodeType(), NodeTypes.ANY_XML_NODE); + startNode(name, NodeTypes.ANY_XML_NODE); inSimple = true; } @@ -323,24 +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."); - Preconditions.checkState(!inSimple, "Attempted to start a child in a simple node"); + 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); } } @@ -363,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()); @@ -443,52 +437,9 @@ abstract class AbstractNormalizedNodeDataOutput implements NormalizedNodeDataOut } } - private void writeObject(final Object value) throws IOException { + abstract void writeObject(@NonNull DataOutput output, @NonNull Object value) throws IOException; - byte type = ValueTypes.getSerializableType(value); - // Write object type first - output.writeByte(type); - - 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); } }