/* * Copyright (c) 2015 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 */ package org.opendaylight.controller.cluster.datastore.node.utils.stream; 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.util.Collection; 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; 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; /** * 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);
private final DataOutput output;
private NormalizedNodeWriter normalizedNodeWriter;
private boolean headerWritten;
private QName lastLeafSetQName;
private boolean inSimple;
AbstractNormalizedNodeDataOutput(final DataOutput output) {
this.output = requireNonNull(output);
}
private void ensureHeaderWritten() throws IOException {
if (!headerWritten) {
output.writeByte(TokenTypes.SIGNATURE_MARKER);
output.writeShort(streamVersion());
headerWritten = true;
}
}
protected abstract short streamVersion();
abstract void writeString(@NonNull String string) throws IOException;
@Override
public final void write(final int value) throws IOException {
ensureHeaderWritten();
output.write(value);
}
@Override
public final void write(final byte[] bytes) throws IOException {
ensureHeaderWritten();
output.write(bytes);
}
@Override
public final void write(final byte[] bytes, final int off, final int len) throws IOException {
ensureHeaderWritten();
output.write(bytes, off, len);
}
@Override
public final void writeBoolean(final boolean value) throws IOException {
ensureHeaderWritten();
output.writeBoolean(value);
}
@Override
public final void writeByte(final int value) throws IOException {
ensureHeaderWritten();
output.writeByte(value);
}
@Override
public final void writeShort(final int value) throws IOException {
ensureHeaderWritten();
output.writeShort(value);
}
@Override
public final void writeChar(final int value) throws IOException {
ensureHeaderWritten();
output.writeChar(value);
}
@Override
public final void writeInt(final int value) throws IOException {
ensureHeaderWritten();
output.writeInt(value);
}
@Override
public final void writeLong(final long value) throws IOException {
ensureHeaderWritten();
output.writeLong(value);
}
@Override
public final void writeFloat(final float value) throws IOException {
ensureHeaderWritten();
output.writeFloat(value);
}
@Override
public final void writeDouble(final double value) throws IOException {
ensureHeaderWritten();
output.writeDouble(value);
}
@Override
public final void writeBytes(final String str) throws IOException {
ensureHeaderWritten();
output.writeBytes(str);
}
@Override
public final void writeChars(final String str) throws IOException {
ensureHeaderWritten();
output.writeChars(str);
}
@Override
public final void writeUTF(final String str) throws IOException {
ensureHeaderWritten();
output.writeUTF(str);
}
private NormalizedNodeWriter normalizedNodeWriter() {
if (normalizedNodeWriter == null) {
normalizedNodeWriter = NormalizedNodeWriter.forStreamWriter(this);
}
return normalizedNodeWriter;
}
@Override
public void writeNormalizedNode(final NormalizedNode, ?> node) throws IOException {
ensureHeaderWritten();
normalizedNodeWriter().write(node);
}
@Override
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 {
LOG.trace("Starting a new leaf set");
commonStartLeafSet(name, NodeTypes.LEAF_SET);
}
@Override
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();
}
@Override
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.getNodeType());
}
inSimple = true;
}
@Override
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 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 startUnkeyedList(final NodeIdentifier name, final int childSizeHint) throws IOException {
LOG.trace("Starting a new unkeyed list");
startNode(name, NodeTypes.UNKEYED_LIST);
}
@Override
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 startMapNode(final NodeIdentifier name, final int childSizeHint) throws IOException {
LOG.trace("Starting a new map node");
startNode(name, NodeTypes.MAP_NODE);
}
@Override
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 startOrderedMapNode(final NodeIdentifier name, final int childSizeHint) throws IOException {
LOG.trace("Starting a new ordered map node");
startNode(name, NodeTypes.ORDERED_MAP_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 AugmentationIdentifier identifier) throws IOException {
requireNonNull(identifier, "Node identifier should not be null");
LOG.trace("Starting a new augmentation node");
output.writeByte(NodeTypes.AUGMENTATION_NODE);
writeAugmentationIdentifier(identifier);
}
@Override
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 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);
}
}
@Override
public void endNode() throws IOException {
LOG.trace("Ending the node");
if (!inSimple) {
lastLeafSetQName = null;
output.writeByte(NodeTypes.END_NODE);
}
inSimple = false;
}
@Override
public void close() throws IOException {
flush();
}
@Override
public void flush() throws IOException {
if (output instanceof OutputStream) {
((OutputStream)output).flush();
}
}
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(arg.getNodeType());
}
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);
writeString((String) o);
}
}
@Override
public void writeSchemaPath(final SchemaPath path) throws IOException {
ensureHeaderWritten();
output.writeBoolean(path.isAbsolute());
final Collection