2 * Copyright (c) 2016 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.restconf.nb.rfc8040.jersey.providers;
10 import java.io.IOException;
11 import java.io.OutputStream;
12 import javax.ws.rs.Produces;
13 import javax.ws.rs.core.MediaType;
14 import javax.ws.rs.ext.Provider;
15 import javax.xml.XMLConstants;
16 import javax.xml.stream.XMLStreamException;
17 import javax.xml.stream.XMLStreamWriter;
18 import org.opendaylight.restconf.api.MediaTypes;
19 import org.opendaylight.restconf.nb.rfc8040.jersey.providers.api.RestconfNormalizedNodeWriter;
20 import org.opendaylight.restconf.nb.rfc8040.legacy.QueryParameters;
21 import org.opendaylight.restconf.server.api.FormattableBody;
22 import org.opendaylight.yangtools.yang.common.QName;
23 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
24 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
25 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
26 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
27 import org.opendaylight.yangtools.yang.data.codec.xml.XMLStreamNormalizedNodeStreamWriter;
28 import org.opendaylight.yangtools.yang.data.spi.node.ImmutableNodes;
29 import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack;
30 import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack.Inference;
33 @Produces({ MediaTypes.APPLICATION_YANG_DATA_XML, MediaType.APPLICATION_XML, MediaType.TEXT_XML })
34 public final class XmlNormalizedNodeBodyWriter extends AbstractNormalizedNodeBodyWriter {
36 void writeData(final SchemaInferenceStack stack, final QueryParameters writerParameters, final NormalizedNode data,
37 final OutputStream entityStream) throws IOException {
39 if (!stack.isEmpty()) {
46 final var xmlWriter = FormattableBody.createXmlWriter(entityStream, writerParameters);
47 final var nnWriter = createNormalizedNodeWriter(xmlWriter, stack.toInference(), writerParameters);
48 if (data instanceof MapEntryNode mapEntry) {
49 // Restconf allows returning one list item. We need to wrap it
50 // in map node in order to serialize it properly
51 nnWriter.write(ImmutableNodes.newSystemMapBuilder()
52 .withNodeIdentifier(new NodeIdentifier(data.name().getNodeType()))
56 if (data instanceof ContainerNode container && container.isEmpty()) {
57 writeEmptyDataNode(xmlWriter, container);
59 writeAndWrapInDataNode(xmlWriter, nnWriter, data);
67 private static RestconfNormalizedNodeWriter createNormalizedNodeWriter(final XMLStreamWriter xmlWriter,
68 final Inference inference, final QueryParameters writerParameters) {
69 return ParameterAwareNormalizedNodeWriter.forStreamWriter(
70 XMLStreamNormalizedNodeStreamWriter.create(xmlWriter, inference),
71 writerParameters.depth(), writerParameters.fields());
74 private static void writeAndWrapInDataNode(final XMLStreamWriter xmlWriter,
75 final RestconfNormalizedNodeWriter nnWriter, final NormalizedNode data) throws IOException {
76 final QName nodeType = data.name().getNodeType();
77 final String namespace = nodeType.getNamespace().toString();
79 xmlWriter.writeStartElement(XMLConstants.DEFAULT_NS_PREFIX, nodeType.getLocalName(), namespace);
80 xmlWriter.writeDefaultNamespace(namespace);
82 xmlWriter.writeEndElement();
84 } catch (XMLStreamException e) {
85 throw new IOException("Failed to write elements", e);
89 private static void writeEmptyDataNode(final XMLStreamWriter xmlWriter, final ContainerNode data)
91 final QName nodeType = data.name().getNodeType();
92 final String namespace = nodeType.getNamespace().toString();
94 xmlWriter.writeStartElement(XMLConstants.DEFAULT_NS_PREFIX, nodeType.getLocalName(), namespace);
95 xmlWriter.writeDefaultNamespace(namespace);
96 xmlWriter.writeEndElement();
98 } catch (XMLStreamException e) {
99 throw new IOException("Failed to write elements", e);