X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-clustering-commons%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fcluster%2Fdatastore%2Fnode%2Futils%2Fstream%2FAbstractNormalizedNodeDataOutput.java;h=4c170d7fbacb23695fc2678e922130f85fdaf9fd;hb=da733a0fd42643fb5e9f5885241c128058944547;hp=8eeef9f215efe471fd06872b1b4b1e00590f91d0;hpb=0c7f9afacaac35df8398d9e3ec808d7ede97007f;p=controller.git 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 8eeef9f215..4c170d7fba 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,66 +7,42 @@ */ 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 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; /** - * 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. + * 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. * - *
Based on the each node, the node type is also written to the stream, that helps in reconstructing the object, - * while reading. + *
+ * 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);
@@ -75,10 +51,6 @@ abstract class AbstractNormalizedNodeDataOutput implements NormalizedNodeDataOut
}
}
- protected abstract short streamVersion();
-
- abstract void writeString(@NonNull String string) throws IOException;
-
@Override
public final void write(final int value) throws IOException {
ensureHeaderWritten();
@@ -163,152 +135,47 @@ abstract class AbstractNormalizedNodeDataOutput implements NormalizedNodeDataOut
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);
- }
-
- @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();
+ writeQNameInternal(qname);
}
@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 {
- 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;
+ 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