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;
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;
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.
+ *
+ * <p>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);
@Override
public void startLeafNode(final NodeIdentifier name) throws IOException {
- requireNonNull(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 {
- requireNonNull(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 {
- requireNonNull(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
@Override
public void startContainerNode(final NodeIdentifier name, final int childSizeHint) throws IOException {
- requireNonNull(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 {
- requireNonNull(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 {
- requireNonNull(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 {
- requireNonNull(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 {
- requireNonNull(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 {
- requireNonNull(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 {
- requireNonNull(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 {
- requireNonNull(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
@Override
public void startAnyxmlNode(final NodeIdentifier name) throws IOException {
- requireNonNull(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;
}
}
}
- private void startNode(final QName qname, final byte nodeType) throws IOException {
- requireNonNull(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) {
checkArgument(o instanceof String, "Expected value type to be String but was %s (%s)", o.getClass(), o);
writeYangInstanceIdentifierInternal(identifier);
}
- private void writeYangInstanceIdentifierInternal(final YangInstanceIdentifier identifier) throws IOException {
+ final void writeYangInstanceIdentifierInternal(final YangInstanceIdentifier identifier) throws IOException {
Collection<PathArgument> pathArguments = identifier.getPathArguments();
output.writeInt(pathArguments.size());
}
}
- 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);
}
}
Code Review / controller.git / blobdiff