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.netconf.sal.rest.impl;
10 import static org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter.UNKNOWN_SIZE;
12 import com.google.common.base.Optional;
13 import com.google.common.base.Preconditions;
14 import com.google.common.base.Predicate;
15 import com.google.common.collect.Iterables;
16 import java.io.IOException;
17 import java.util.Collection;
20 import org.opendaylight.netconf.sal.rest.api.RestconfNormalizedNodeWriter;
21 import org.opendaylight.yangtools.yang.common.QName;
22 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
23 import org.opendaylight.yangtools.yang.data.api.schema.AnyXmlNode;
24 import org.opendaylight.yangtools.yang.data.api.schema.AugmentationNode;
25 import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
26 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
27 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
28 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
29 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetNode;
30 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
31 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
32 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
33 import org.opendaylight.yangtools.yang.data.api.schema.OrderedLeafSetNode;
34 import org.opendaylight.yangtools.yang.data.api.schema.OrderedMapNode;
35 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListEntryNode;
36 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode;
37 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamAttributeWriter;
38 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
39 import org.slf4j.Logger;
40 import org.slf4j.LoggerFactory;
43 * This is an experimental iterator over a {@link NormalizedNode}. This is essentially
44 * the opposite of a {@link javax.xml.stream.XMLStreamReader} -- unlike instantiating an iterator over
45 * the backing data, this encapsulates a {@link NormalizedNodeStreamWriter} and allows
46 * us to write multiple nodes.
48 * @deprecated This class will be replaced by
49 * {@link org.opendaylight.restconf.jersey.providers.ParameterAwareNormalizedNodeWriter}
52 public class DepthAwareNormalizedNodeWriter implements RestconfNormalizedNodeWriter {
53 private final NormalizedNodeStreamWriter writer;
54 protected int currentDepth = 0;
55 protected final int maxDepth;
57 private DepthAwareNormalizedNodeWriter(final NormalizedNodeStreamWriter writer, final int maxDepth) {
58 this.writer = Preconditions.checkNotNull(writer);
59 this.maxDepth = maxDepth;
62 protected final NormalizedNodeStreamWriter getWriter() {
67 * Create a new writer backed by a {@link NormalizedNodeStreamWriter}.
69 * @param writer Back-end writer
70 * @return A new instance.
72 public static DepthAwareNormalizedNodeWriter forStreamWriter(final NormalizedNodeStreamWriter writer, final int maxDepth) {
73 return forStreamWriter(writer, true, maxDepth);
77 * Create a new writer backed by a {@link NormalizedNodeStreamWriter}. Unlike the simple {@link #forStreamWriter(NormalizedNodeStreamWriter, int)}
78 * method, this allows the caller to switch off RFC6020 XML compliance, providing better
79 * throughput. The reason is that the XML mapping rules in RFC6020 require the encoding
80 * to emit leaf nodes which participate in a list's key first and in the order in which
81 * they are defined in the key. For JSON, this requirement is completely relaxed and leaves
82 * can be ordered in any way we see fit. The former requires a bit of work: first a lookup
83 * for each key and then for each emitted node we need to check whether it was already
86 * @param writer Back-end writer
87 * @param orderKeyLeaves whether the returned instance should be RFC6020 XML compliant.
88 * @return A new instance.
90 public static DepthAwareNormalizedNodeWriter forStreamWriter(final NormalizedNodeStreamWriter writer, final boolean
91 orderKeyLeaves, final int maxDepth) {
93 return new OrderedDepthAwareNormalizedNodeWriter(writer, maxDepth);
95 return new DepthAwareNormalizedNodeWriter(writer, maxDepth);
100 * Iterate over the provided {@link NormalizedNode} and emit write
101 * events to the encapsulated {@link NormalizedNodeStreamWriter}.
105 * @throws IOException when thrown from the backing writer.
107 public final DepthAwareNormalizedNodeWriter write(final NormalizedNode<?, ?> node) throws IOException {
108 if (wasProcessedAsCompositeNode(node)) {
112 if (wasProcessAsSimpleNode(node)) {
116 throw new IllegalStateException("It wasn't possible to serialize node " + node);
120 public void flush() throws IOException {
125 public void close() throws IOException {
131 * Emit a best guess of a hint for a particular set of children. It evaluates the
132 * iterable to see if the size can be easily gotten to. If it is, we hint at the
133 * real number of child nodes. Otherwise we emit UNKNOWN_SIZE.
135 * @param children Child nodes
136 * @return Best estimate of the collection size required to hold all the children.
138 static final int childSizeHint(final Iterable<?> children) {
139 return (children instanceof Collection) ? ((Collection<?>) children).size() : UNKNOWN_SIZE;
142 private boolean wasProcessAsSimpleNode(final NormalizedNode<?, ?> node) throws IOException {
143 if (node instanceof LeafSetEntryNode) {
144 if (currentDepth < maxDepth) {
145 final LeafSetEntryNode<?> nodeAsLeafList = (LeafSetEntryNode<?>) node;
146 if (writer instanceof NormalizedNodeStreamAttributeWriter) {
147 ((NormalizedNodeStreamAttributeWriter) writer).leafSetEntryNode(nodeAsLeafList.getNodeType(),
148 nodeAsLeafList.getValue(), nodeAsLeafList.getAttributes());
150 writer.leafSetEntryNode(nodeAsLeafList.getNodeType(), nodeAsLeafList.getValue());
154 } else if (node instanceof LeafNode) {
155 final LeafNode<?> nodeAsLeaf = (LeafNode<?>)node;
156 if(writer instanceof NormalizedNodeStreamAttributeWriter) {
157 ((NormalizedNodeStreamAttributeWriter) writer).leafNode(nodeAsLeaf.getIdentifier(), nodeAsLeaf.getValue(), nodeAsLeaf.getAttributes());
159 writer.leafNode(nodeAsLeaf.getIdentifier(), nodeAsLeaf.getValue());
162 } else if (node instanceof AnyXmlNode) {
163 final AnyXmlNode anyXmlNode = (AnyXmlNode)node;
164 writer.anyxmlNode(anyXmlNode.getIdentifier(), anyXmlNode.getValue());
172 * Emit events for all children and then emit an endNode() event.
174 * @param children Child iterable
176 * @throws IOException when the writer reports it
178 protected final boolean writeChildren(final Iterable<? extends NormalizedNode<?, ?>> children) throws IOException {
179 if (currentDepth < maxDepth) {
180 for (NormalizedNode<?, ?> child : children) {
188 protected boolean writeMapEntryChildren(final MapEntryNode mapEntryNode) throws IOException {
189 if (currentDepth < maxDepth) {
190 writeChildren(mapEntryNode.getValue());
191 } else if (currentDepth == maxDepth) {
192 writeOnlyKeys(mapEntryNode.getIdentifier().getKeyValues());
197 private void writeOnlyKeys(Map<QName, Object> keyValues) throws IllegalArgumentException, IOException {
198 for (Map.Entry<QName, Object> entry : keyValues.entrySet()) {
199 writer.leafNode(new NodeIdentifier(entry.getKey()), entry.getValue());
205 protected boolean writeMapEntryNode(final MapEntryNode node) throws IOException {
206 if(writer instanceof NormalizedNodeStreamAttributeWriter) {
207 ((NormalizedNodeStreamAttributeWriter) writer)
208 .startMapEntryNode(node.getIdentifier(), childSizeHint(node.getValue()), node.getAttributes());
210 writer.startMapEntryNode(node.getIdentifier(), childSizeHint(node.getValue()));
213 writeMapEntryChildren(node);
218 private boolean wasProcessedAsCompositeNode(final NormalizedNode<?, ?> node) throws IOException {
219 boolean processedAsCompositeNode = false;
220 if (node instanceof ContainerNode) {
221 final ContainerNode n = (ContainerNode) node;
222 if(writer instanceof NormalizedNodeStreamAttributeWriter) {
223 ((NormalizedNodeStreamAttributeWriter) writer).startContainerNode(n.getIdentifier(), childSizeHint(n.getValue()), n.getAttributes());
225 writer.startContainerNode(n.getIdentifier(), childSizeHint(n.getValue()));
228 processedAsCompositeNode = writeChildren(n.getValue());
231 else if (node instanceof MapEntryNode) {
232 processedAsCompositeNode = writeMapEntryNode((MapEntryNode) node);
234 else if (node instanceof UnkeyedListEntryNode) {
235 final UnkeyedListEntryNode n = (UnkeyedListEntryNode) node;
236 writer.startUnkeyedListItem(n.getIdentifier(), childSizeHint(n.getValue()));
238 processedAsCompositeNode = writeChildren(n.getValue());
241 else if (node instanceof ChoiceNode) {
242 final ChoiceNode n = (ChoiceNode) node;
243 writer.startChoiceNode(n.getIdentifier(), childSizeHint(n.getValue()));
244 processedAsCompositeNode = writeChildren(n.getValue());
246 else if (node instanceof AugmentationNode) {
247 final AugmentationNode n = (AugmentationNode) node;
248 writer.startAugmentationNode(n.getIdentifier());
249 processedAsCompositeNode = writeChildren(n.getValue());
251 else if (node instanceof UnkeyedListNode) {
252 final UnkeyedListNode n = (UnkeyedListNode) node;
253 writer.startUnkeyedList(n.getIdentifier(), childSizeHint(n.getValue()));
254 processedAsCompositeNode = writeChildren(n.getValue());
256 else if (node instanceof OrderedMapNode) {
257 final OrderedMapNode n = (OrderedMapNode) node;
258 writer.startOrderedMapNode(n.getIdentifier(), childSizeHint(n.getValue()));
259 processedAsCompositeNode = writeChildren(n.getValue());
261 else if (node instanceof MapNode) {
262 final MapNode n = (MapNode) node;
263 writer.startMapNode(n.getIdentifier(), childSizeHint(n.getValue()));
264 processedAsCompositeNode = writeChildren(n.getValue());
266 else if (node instanceof LeafSetNode) {
267 final LeafSetNode<?> n = (LeafSetNode<?>) node;
268 if (node instanceof OrderedLeafSetNode) {
269 writer.startOrderedLeafSet(n.getIdentifier(), childSizeHint(n.getValue()));
271 writer.startLeafSet(n.getIdentifier(), childSizeHint(n.getValue()));
274 processedAsCompositeNode = writeChildren(n.getValue());
278 return processedAsCompositeNode;
281 private static final class OrderedDepthAwareNormalizedNodeWriter extends DepthAwareNormalizedNodeWriter {
282 private static final Logger LOG = LoggerFactory.getLogger(OrderedDepthAwareNormalizedNodeWriter.class);
284 OrderedDepthAwareNormalizedNodeWriter(final NormalizedNodeStreamWriter writer, final int maxDepth) {
285 super(writer, maxDepth);
289 protected boolean writeMapEntryNode(final MapEntryNode node) throws IOException {
290 final NormalizedNodeStreamWriter writer = getWriter();
291 if(writer instanceof NormalizedNodeStreamAttributeWriter) {
292 ((NormalizedNodeStreamAttributeWriter) writer).startMapEntryNode(node.getIdentifier(), childSizeHint(node.getValue()), node.getAttributes());
294 writer.startMapEntryNode(node.getIdentifier(), childSizeHint(node.getValue()));
297 final Set<QName> qnames = node.getIdentifier().getKeyValues().keySet();
298 // Write out all the key children
299 for (QName qname : qnames) {
300 final Optional<? extends NormalizedNode<?, ?>> child = node.getChild(new NodeIdentifier(qname));
301 if (child.isPresent()) {
304 LOG.info("No child for key element {} found", qname);
308 // Write all the rest
310 boolean result = writeChildren(Iterables.filter(node.getValue(), new Predicate<NormalizedNode<?, ?>>() {
312 public boolean apply(final NormalizedNode<?, ?> input) {
313 if (input instanceof AugmentationNode) {
316 if (!qnames.contains(input.getNodeType())) {
320 LOG.debug("Skipping key child {}", input);