*/
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.nio.charset.StandardCharsets;
-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 java.util.List;
+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;
+/**
+ * Abstract base class for implementing {@link NormalizedNodeDataOutput} contract. This class uses
+ * {@link NormalizedNodeStreamWriter} as an internal interface for performing the actual NormalizedNode writeout,
+ * i.e. it will defer to a {@link NormalizedNodeWriter} instance.
+ *
+ * <p>
+ * As such, this is an implementation detail not exposed from this package, hence implementations can rely on the
+ * stream being initialized with a header and version.
+ */
abstract class AbstractNormalizedNodeDataOutput implements NormalizedNodeDataOutput, NormalizedNodeStreamWriter {
- private static final Logger LOG = LoggerFactory.getLogger(AbstractNormalizedNodeDataOutput.class);
-
- private final DataOutput output;
+ // Visible for subclasses
+ 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);
}
}
- protected abstract short streamVersion();
-
- protected abstract void writeString(String string) throws IOException;
-
@Override
public final void write(final int value) 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 {
+ public final void writeQName(final QName qname) throws IOException {
ensureHeaderWritten();
- normalizedNodeWriter().write(node);
+ writeQNameInternal(qname);
}
@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);
- 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);
- }
-
- @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");
-
- lastLeafSetQName = name.getNodeType();
- startNode(name.getNodeType(), NodeTypes.ORDERED_LEAF_SET);
- }
-
- @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());
+ public final void writeNormalizedNode(final NormalizedNode<?, ?> node) throws IOException {
+ ensureHeaderWritten();
+ if (normalizedNodeWriter == null) {
+ normalizedNodeWriter = NormalizedNodeWriter.forStreamWriter(this);
}
- inSimple = true;
+ normalizedNodeWriter.write(node);
}
@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);
- }
-
- @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);
- }
-
- @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);
- }
-
- @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);
- }
-
- @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);
- }
-
- @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);
-
- 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);
- }
-
- @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);
- }
-
- @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 {
- requireNonNull(name, "Node identifier should not be null");
- LOG.trace("Starting any xml node");
- startNode(name.getNodeType(), NodeTypes.ANY_XML_NODE);
- inSimple = true;
+ public final void writePathArgument(final PathArgument pathArgument) throws IOException {
+ ensureHeaderWritten();
+ writePathArgumentInternal(pathArgument);
}
@Override
- public void scalarValue(final Object value) throws IOException {
- writeObject(value);
+ public final void writeYangInstanceIdentifier(final YangInstanceIdentifier identifier) throws IOException {
+ ensureHeaderWritten();
+ writeYangInstanceIdentifierInternal(identifier);
}
@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);
- }
- }
+ public final void writeSchemaPath(final SchemaPath path) throws IOException {
+ ensureHeaderWritten();
- @Override
- public void endNode() throws IOException {
- LOG.trace("Ending the node");
- if (!inSimple) {
- lastLeafSetQName = null;
- output.writeByte(NodeTypes.END_NODE);
+ output.writeBoolean(path.isAbsolute());
+ final List<QName> qnames = path.getPath();
+ output.writeInt(qnames.size());
+ for (QName qname : qnames) {
+ writeQNameInternal(qname);
}
- inSimple = false;
}
@Override
- public void close() throws IOException {
+ public final void close() throws IOException {
flush();
}
}
}
- private void startNode(final QName qname, final byte nodeType) throws IOException {
- requireNonNull(qname, "QName of 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);
- }
-
- private 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<QName> qnames = path.getPath();
- output.writeInt(qnames.size());
- for (QName qname : qnames) {
- writeQName(qname);
- }
- }
-
@Override
- public void writeYangInstanceIdentifier(final YangInstanceIdentifier identifier) throws IOException {
- ensureHeaderWritten();
- writeYangInstanceIdentifierInternal(identifier);
- }
-
- private void writeYangInstanceIdentifierInternal(final YangInstanceIdentifier identifier) throws IOException {
- Collection<PathArgument> pathArguments = identifier.getPathArguments();
- output.writeInt(pathArguments.size());
-
- for (PathArgument pathArgument : pathArguments) {
- writePathArgument(pathArgument);
- }
+ public final boolean startAnydataNode(final NodeIdentifier name, final Class<?> objectModel) throws IOException {
+ // FIXME: We do not support anydata nodes of any kind, yet
+ return false;
}
- @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 PathArgument pathArgument) throws IOException {
-
- byte type = PathArgumentTypes.getSerializablePathArgumentType(pathArgument);
-
- output.writeByte(type);
-
- switch (type) {
- case PathArgumentTypes.NODE_IDENTIFIER:
-
- NodeIdentifier nodeIdentifier = (NodeIdentifier) pathArgument;
-
- writeQName(nodeIdentifier.getNodeType());
- break;
-
- case PathArgumentTypes.NODE_IDENTIFIER_WITH_PREDICATES:
+ abstract short streamVersion();
- NodeIdentifierWithPredicates nodeIdentifierWithPredicates =
- (NodeIdentifierWithPredicates) pathArgument;
- writeQName(nodeIdentifierWithPredicates.getNodeType());
+ abstract void writeQNameInternal(@NonNull QName qname) throws IOException;
- writeKeyValueMap(nodeIdentifierWithPredicates.entrySet());
- break;
+ abstract void writePathArgumentInternal(PathArgument pathArgument) throws IOException;
- case PathArgumentTypes.NODE_IDENTIFIER_WITH_VALUE :
-
- NodeWithValue<?> nodeWithValue = (NodeWithValue<?>) pathArgument;
-
- writeQName(nodeWithValue.getNodeType());
- writeObject(nodeWithValue.getValue());
- break;
-
- case PathArgumentTypes.AUGMENTATION_IDENTIFIER :
-
- // No Qname in augmentation identifier
- writeAugmentationIdentifier((AugmentationIdentifier) pathArgument);
- break;
- default :
- throw new IllegalStateException("Unknown node identifier type is found : "
- + pathArgument.getClass().toString());
- }
- }
-
- private void writeKeyValueMap(final Set<Entry<QName, Object>> entrySet) throws IOException {
- if (!entrySet.isEmpty()) {
- output.writeInt(entrySet.size());
- for (Entry<QName, Object> entry : entrySet) {
- writeQName(entry.getKey());
- writeObject(entry.getValue());
- }
- } else {
- output.writeInt(0);
- }
- }
-
- void writeAugmentationIdentifier(final AugmentationIdentifier aid) throws IOException {
- final Set<QName> qnames = aid.getPossibleChildNames();
- // Write each child's qname separately, if list is empty send count as 0
- if (!qnames.isEmpty()) {
- output.writeInt(qnames.size());
- for (QName qname : qnames) {
- writeQName(qname);
- }
- } else {
- LOG.debug("augmentation node does not have any child");
- output.writeInt(0);
- }
- }
-
- private void writeObject(final 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;
- }
- }
+ abstract void writeYangInstanceIdentifierInternal(YangInstanceIdentifier identifier) throws IOException;
}
Code Review / controller.git / blobdiff