2 * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.controller.cluster.datastore.node.utils.stream;
10 import static com.google.common.base.Preconditions.checkArgument;
11 import static com.google.common.base.Preconditions.checkState;
12 import static java.util.Objects.requireNonNull;
14 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
15 import java.io.DataOutput;
16 import java.io.IOException;
17 import java.io.OutputStream;
18 import java.io.StringWriter;
19 import java.util.Collection;
20 import java.util.Map.Entry;
22 import javax.xml.transform.TransformerException;
23 import javax.xml.transform.TransformerFactory;
24 import javax.xml.transform.TransformerFactoryConfigurationError;
25 import javax.xml.transform.dom.DOMSource;
26 import javax.xml.transform.stream.StreamResult;
27 import org.eclipse.jdt.annotation.NonNull;
28 import org.opendaylight.yangtools.yang.common.QName;
29 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
30 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
31 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
32 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
33 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
34 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
35 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
36 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
37 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeWriter;
38 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
39 import org.slf4j.Logger;
40 import org.slf4j.LoggerFactory;
43 * NormalizedNodeOutputStreamWriter will be used by distributed datastore to send normalized node in
45 * A stream writer wrapper around this class will write node objects to stream in recursive manner.
46 * for example - If you have a ContainerNode which has a two LeafNode as children, then
48 * {@link #startContainerNode(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier, int)},
50 * {@link #leafNode(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier, Object)} twice
51 * and then, {@link #endNode()} to end container node.
53 * <p>Based on the each node, the node type is also written to the stream, that helps in reconstructing the object,
56 abstract class AbstractNormalizedNodeDataOutput implements NormalizedNodeDataOutput, NormalizedNodeStreamWriter {
57 private static final Logger LOG = LoggerFactory.getLogger(AbstractNormalizedNodeDataOutput.class);
59 private final DataOutput output;
61 private NormalizedNodeWriter normalizedNodeWriter;
62 private boolean headerWritten;
63 private QName lastLeafSetQName;
64 private boolean inSimple;
66 AbstractNormalizedNodeDataOutput(final DataOutput output) {
67 this.output = requireNonNull(output);
70 private void ensureHeaderWritten() throws IOException {
72 output.writeByte(TokenTypes.SIGNATURE_MARKER);
73 output.writeShort(streamVersion());
78 protected abstract short streamVersion();
80 abstract void writeString(@NonNull String string) throws IOException;
83 public final void write(final int value) throws IOException {
84 ensureHeaderWritten();
89 public final void write(final byte[] bytes) throws IOException {
90 ensureHeaderWritten();
95 public final void write(final byte[] bytes, final int off, final int len) throws IOException {
96 ensureHeaderWritten();
97 output.write(bytes, off, len);
101 public final void writeBoolean(final boolean value) throws IOException {
102 ensureHeaderWritten();
103 output.writeBoolean(value);
107 public final void writeByte(final int value) throws IOException {
108 ensureHeaderWritten();
109 output.writeByte(value);
113 public final void writeShort(final int value) throws IOException {
114 ensureHeaderWritten();
115 output.writeShort(value);
119 public final void writeChar(final int value) throws IOException {
120 ensureHeaderWritten();
121 output.writeChar(value);
125 public final void writeInt(final int value) throws IOException {
126 ensureHeaderWritten();
127 output.writeInt(value);
131 public final void writeLong(final long value) throws IOException {
132 ensureHeaderWritten();
133 output.writeLong(value);
137 public final void writeFloat(final float value) throws IOException {
138 ensureHeaderWritten();
139 output.writeFloat(value);
143 public final void writeDouble(final double value) throws IOException {
144 ensureHeaderWritten();
145 output.writeDouble(value);
149 public final void writeBytes(final String str) throws IOException {
150 ensureHeaderWritten();
151 output.writeBytes(str);
155 public final void writeChars(final String str) throws IOException {
156 ensureHeaderWritten();
157 output.writeChars(str);
161 public final void writeUTF(final String str) throws IOException {
162 ensureHeaderWritten();
163 output.writeUTF(str);
166 private NormalizedNodeWriter normalizedNodeWriter() {
167 if (normalizedNodeWriter == null) {
168 normalizedNodeWriter = NormalizedNodeWriter.forStreamWriter(this);
171 return normalizedNodeWriter;
175 public void writeNormalizedNode(final NormalizedNode<?, ?> node) throws IOException {
176 ensureHeaderWritten();
177 normalizedNodeWriter().write(node);
181 public void startLeafNode(final NodeIdentifier name) throws IOException {
182 LOG.trace("Starting a new leaf node");
183 startNode(name, NodeTypes.LEAF_NODE);
188 public void startLeafSet(final NodeIdentifier name, final int childSizeHint) throws IOException {
189 LOG.trace("Starting a new leaf set");
190 commonStartLeafSet(name, NodeTypes.LEAF_SET);
194 public void startOrderedLeafSet(final NodeIdentifier name, final int childSizeHint) throws IOException {
195 LOG.trace("Starting a new ordered leaf set");
196 commonStartLeafSet(name, NodeTypes.ORDERED_LEAF_SET);
199 private void commonStartLeafSet(final NodeIdentifier name, final byte nodeType) throws IOException {
200 startNode(name, nodeType);
201 lastLeafSetQName = name.getNodeType();
205 public void startLeafSetEntryNode(final NodeWithValue<?> name) throws IOException {
206 LOG.trace("Starting a new leaf set entry node");
208 output.writeByte(NodeTypes.LEAF_SET_ENTRY_NODE);
210 // lastLeafSetQName is set if the parent LeafSetNode was previously written. Otherwise this is a
211 // stand alone LeafSetEntryNode so write out it's name here.
212 if (lastLeafSetQName == null) {
213 writeQName(name.getNodeType());
219 public void startContainerNode(final NodeIdentifier name, final int childSizeHint) throws IOException {
220 LOG.trace("Starting a new container node");
221 startNode(name, NodeTypes.CONTAINER_NODE);
225 public void startYangModeledAnyXmlNode(final NodeIdentifier name, final int childSizeHint) throws IOException {
226 LOG.trace("Starting a new yang modeled anyXml node");
227 startNode(name, NodeTypes.YANG_MODELED_ANY_XML_NODE);
231 public void startUnkeyedList(final NodeIdentifier name, final int childSizeHint) throws IOException {
232 LOG.trace("Starting a new unkeyed list");
233 startNode(name, NodeTypes.UNKEYED_LIST);
237 public void startUnkeyedListItem(final NodeIdentifier name, final int childSizeHint) throws IOException {
238 LOG.trace("Starting a new unkeyed list item");
239 startNode(name, NodeTypes.UNKEYED_LIST_ITEM);
243 public void startMapNode(final NodeIdentifier name, final int childSizeHint) throws IOException {
244 LOG.trace("Starting a new map node");
245 startNode(name, NodeTypes.MAP_NODE);
249 public void startMapEntryNode(final NodeIdentifierWithPredicates identifier, final int childSizeHint)
251 LOG.trace("Starting a new map entry node");
252 startNode(identifier, NodeTypes.MAP_ENTRY_NODE);
253 writeKeyValueMap(identifier.entrySet());
257 public void startOrderedMapNode(final NodeIdentifier name, final int childSizeHint) throws IOException {
258 LOG.trace("Starting a new ordered map node");
259 startNode(name, NodeTypes.ORDERED_MAP_NODE);
263 public void startChoiceNode(final NodeIdentifier name, final int childSizeHint) throws IOException {
264 LOG.trace("Starting a new choice node");
265 startNode(name, NodeTypes.CHOICE_NODE);
269 public void startAugmentationNode(final AugmentationIdentifier identifier) throws IOException {
270 requireNonNull(identifier, "Node identifier should not be null");
271 LOG.trace("Starting a new augmentation node");
273 output.writeByte(NodeTypes.AUGMENTATION_NODE);
274 writeAugmentationIdentifier(identifier);
278 public void startAnyxmlNode(final NodeIdentifier name) throws IOException {
279 LOG.trace("Starting any xml node");
280 startNode(name, NodeTypes.ANY_XML_NODE);
285 public void scalarValue(final Object value) throws IOException {
290 public void domSourceValue(final DOMSource value) throws IOException {
292 StreamResult xmlOutput = new StreamResult(new StringWriter());
293 TransformerFactory.newInstance().newTransformer().transform(value, xmlOutput);
294 writeObject(xmlOutput.getWriter().toString());
295 } catch (TransformerException | TransformerFactoryConfigurationError e) {
296 throw new IOException("Error writing anyXml", e);
301 public void endNode() throws IOException {
302 LOG.trace("Ending the node");
304 lastLeafSetQName = null;
305 output.writeByte(NodeTypes.END_NODE);
311 public void close() throws IOException {
316 public void flush() throws IOException {
317 if (output instanceof OutputStream) {
318 ((OutputStream)output).flush();
322 private void startNode(final PathArgument arg, final byte nodeType) throws IOException {
323 requireNonNull(arg, "Node identifier should not be null");
324 checkState(!inSimple, "Attempted to start a child in a simple node");
326 ensureHeaderWritten();
328 // First write the type of node
329 output.writeByte(nodeType);
331 writeQName(arg.getNodeType());
334 final void writeObjSet(final Set<?> set) throws IOException {
335 output.writeInt(set.size());
336 for (Object o : set) {
337 checkArgument(o instanceof String, "Expected value type to be String but was %s (%s)", o.getClass(), o);
338 writeString((String) o);
343 public void writeSchemaPath(final SchemaPath path) throws IOException {
344 ensureHeaderWritten();
345 output.writeBoolean(path.isAbsolute());
347 final Collection<QName> qnames = path.getPath();
348 output.writeInt(qnames.size());
349 for (QName qname : qnames) {
355 public void writeYangInstanceIdentifier(final YangInstanceIdentifier identifier) throws IOException {
356 ensureHeaderWritten();
357 writeYangInstanceIdentifierInternal(identifier);
360 final void writeYangInstanceIdentifierInternal(final YangInstanceIdentifier identifier) throws IOException {
361 Collection<PathArgument> pathArguments = identifier.getPathArguments();
362 output.writeInt(pathArguments.size());
364 for (PathArgument pathArgument : pathArguments) {
365 writePathArgument(pathArgument);
369 @SuppressFBWarnings(value = "BC_UNCONFIRMED_CAST",
370 justification = "The casts in the switch clauses are indirectly confirmed via the determination of 'type'.")
372 public void writePathArgument(final PathArgument pathArgument) throws IOException {
374 byte type = PathArgumentTypes.getSerializablePathArgumentType(pathArgument);
376 output.writeByte(type);
379 case PathArgumentTypes.NODE_IDENTIFIER:
381 NodeIdentifier nodeIdentifier = (NodeIdentifier) pathArgument;
383 writeQName(nodeIdentifier.getNodeType());
386 case PathArgumentTypes.NODE_IDENTIFIER_WITH_PREDICATES:
388 NodeIdentifierWithPredicates nodeIdentifierWithPredicates =
389 (NodeIdentifierWithPredicates) pathArgument;
390 writeQName(nodeIdentifierWithPredicates.getNodeType());
392 writeKeyValueMap(nodeIdentifierWithPredicates.entrySet());
395 case PathArgumentTypes.NODE_IDENTIFIER_WITH_VALUE :
397 NodeWithValue<?> nodeWithValue = (NodeWithValue<?>) pathArgument;
399 writeQName(nodeWithValue.getNodeType());
400 writeObject(nodeWithValue.getValue());
403 case PathArgumentTypes.AUGMENTATION_IDENTIFIER :
405 // No Qname in augmentation identifier
406 writeAugmentationIdentifier((AugmentationIdentifier) pathArgument);
409 throw new IllegalStateException("Unknown node identifier type is found : "
410 + pathArgument.getClass().toString());
414 private void writeKeyValueMap(final Set<Entry<QName, Object>> entrySet) throws IOException {
415 if (!entrySet.isEmpty()) {
416 output.writeInt(entrySet.size());
417 for (Entry<QName, Object> entry : entrySet) {
418 writeQName(entry.getKey());
419 writeObject(entry.getValue());
426 void writeAugmentationIdentifier(final AugmentationIdentifier aid) throws IOException {
427 final Set<QName> qnames = aid.getPossibleChildNames();
428 // Write each child's qname separately, if list is empty send count as 0
429 if (!qnames.isEmpty()) {
430 output.writeInt(qnames.size());
431 for (QName qname : qnames) {
435 LOG.debug("augmentation node does not have any child");
440 abstract void writeObject(@NonNull DataOutput output, @NonNull Object value) throws IOException;
442 private void writeObject(final Object value) throws IOException {
443 writeObject(output, value);