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 java.lang.annotation.Annotation;
13 import java.lang.reflect.Type;
14 import java.nio.charset.StandardCharsets;
15 import java.util.List;
17 import javanet.staxutils.IndentingXMLStreamWriter;
18 import javax.ws.rs.Produces;
19 import javax.ws.rs.WebApplicationException;
20 import javax.ws.rs.core.MediaType;
21 import javax.ws.rs.core.MultivaluedMap;
22 import javax.ws.rs.ext.Provider;
23 import javax.xml.XMLConstants;
24 import javax.xml.stream.FactoryConfigurationError;
25 import javax.xml.stream.XMLOutputFactory;
26 import javax.xml.stream.XMLStreamException;
27 import javax.xml.stream.XMLStreamWriter;
28 import org.opendaylight.restconf.api.query.DepthParam;
29 import org.opendaylight.restconf.nb.rfc8040.MediaTypes;
30 import org.opendaylight.restconf.nb.rfc8040.jersey.providers.api.RestconfNormalizedNodeWriter;
31 import org.opendaylight.restconf.nb.rfc8040.legacy.InstanceIdentifierContext;
32 import org.opendaylight.restconf.nb.rfc8040.legacy.NormalizedNodePayload;
33 import org.opendaylight.yangtools.yang.common.QName;
34 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
35 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
36 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
37 import org.opendaylight.yangtools.yang.data.codec.xml.XMLStreamNormalizedNodeStreamWriter;
38 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
39 import org.opendaylight.yangtools.yang.model.api.ActionDefinition;
40 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
41 import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack;
42 import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack.Inference;
45 @Produces({ MediaTypes.APPLICATION_YANG_DATA_XML, MediaType.APPLICATION_XML, MediaType.TEXT_XML })
46 public class XmlNormalizedNodeBodyWriter extends AbstractNormalizedNodeBodyWriter {
47 private static final XMLOutputFactory XML_FACTORY;
50 XML_FACTORY = XMLOutputFactory.newFactory();
51 XML_FACTORY.setProperty(XMLOutputFactory.IS_REPAIRING_NAMESPACES, true);
55 public void writeTo(final NormalizedNodePayload context,
57 final Type genericType,
58 final Annotation[] annotations,
59 final MediaType mediaType,
60 final MultivaluedMap<String, Object> httpHeaders,
61 final OutputStream entityStream) throws IOException, WebApplicationException {
62 if (context.getData() == null) {
65 if (httpHeaders != null) {
66 for (var entry : context.getNewHeaders().entrySet()) {
67 httpHeaders.add(entry.getKey(), entry.getValue());
71 XMLStreamWriter xmlWriter;
73 xmlWriter = XML_FACTORY.createXMLStreamWriter(entityStream, StandardCharsets.UTF_8.name());
75 final var prettyPrint = context.getWriterParameters().prettyPrint();
76 if (prettyPrint != null && prettyPrint.value()) {
77 xmlWriter = new IndentingXMLStreamWriter(xmlWriter);
79 } catch (XMLStreamException | FactoryConfigurationError e) {
80 throw new IllegalStateException(e);
83 writeNormalizedNode(xmlWriter, context.getInstanceIdentifierContext(), context.getData(),
84 context.getWriterParameters().depth(), context.getWriterParameters().fields());
87 private static void writeNormalizedNode(final XMLStreamWriter xmlWriter,
88 final InstanceIdentifierContext pathContext, final NormalizedNode data, final DepthParam depth,
89 final List<Set<QName>> fields) throws IOException {
90 final var schemaNode = pathContext.getSchemaNode();
91 if (schemaNode instanceof RpcDefinition rpc) {
92 // RpcDefinition is not supported as initial codec in XMLStreamWriter, so we need to emit initial output
94 final var stack = SchemaInferenceStack.of(pathContext.getSchemaContext());
95 stack.enterSchemaTree(rpc.getQName());
96 stack.enterSchemaTree(rpc.getOutput().getQName());
98 final var nnWriter = createNormalizedNodeWriter(xmlWriter, stack.toInference(), depth, fields);
99 writeElements(xmlWriter, nnWriter, (ContainerNode) data);
101 } else if (schemaNode instanceof ActionDefinition action) {
102 // ActionDefinition is not supported as initial codec in XMLStreamWriter, so we need to emit initial output
104 final var stack = pathContext.inference().toSchemaInferenceStack();
105 stack.enterSchemaTree(action.getOutput().getQName());
107 final var nnWriter = createNormalizedNodeWriter(xmlWriter, stack.toInference(), depth, fields);
108 writeElements(xmlWriter, nnWriter, (ContainerNode) data);
111 final var stack = pathContext.inference().toSchemaInferenceStack();
112 final boolean isRoot;
113 if (!stack.isEmpty()) {
120 final var nnWriter = createNormalizedNodeWriter(xmlWriter, stack.toInference(), depth, fields);
121 if (data instanceof MapEntryNode mapEntry) {
122 // Restconf allows returning one list item. We need to wrap it
123 // in map node in order to serialize it properly
124 nnWriter.write(ImmutableNodes.mapNodeBuilder(data.name().getNodeType()).addChild(mapEntry).build());
126 if (data instanceof ContainerNode container && container.isEmpty()) {
127 writeEmptyDataNode(xmlWriter, container);
129 writeAndWrapInDataNode(xmlWriter, nnWriter, data);
132 nnWriter.write(data);
138 private static RestconfNormalizedNodeWriter createNormalizedNodeWriter(final XMLStreamWriter xmlWriter,
139 final Inference inference, final DepthParam depth,
140 final List<Set<QName>> fields) {
141 return ParameterAwareNormalizedNodeWriter.forStreamWriter(
142 XMLStreamNormalizedNodeStreamWriter.create(xmlWriter, inference), depth, fields);
145 private static void writeAndWrapInDataNode(final XMLStreamWriter xmlWriter,
146 final RestconfNormalizedNodeWriter nnWriter, final NormalizedNode data) throws IOException {
147 final QName nodeType = data.name().getNodeType();
148 final String namespace = nodeType.getNamespace().toString();
150 xmlWriter.writeStartElement(XMLConstants.DEFAULT_NS_PREFIX, nodeType.getLocalName(), namespace);
151 xmlWriter.writeDefaultNamespace(namespace);
152 nnWriter.write(data);
153 xmlWriter.writeEndElement();
155 } catch (XMLStreamException e) {
156 throw new IOException("Failed to write elements", e);
160 private static void writeEmptyDataNode(final XMLStreamWriter xmlWriter, final ContainerNode data)
162 final QName nodeType = data.name().getNodeType();
163 final String namespace = nodeType.getNamespace().toString();
165 xmlWriter.writeStartElement(XMLConstants.DEFAULT_NS_PREFIX, nodeType.getLocalName(), namespace);
166 xmlWriter.writeDefaultNamespace(namespace);
167 xmlWriter.writeEndElement();
169 } catch (XMLStreamException e) {
170 throw new IOException("Failed to write elements", e);
174 private static void writeElements(final XMLStreamWriter xmlWriter, final RestconfNormalizedNodeWriter nnWriter,
175 final ContainerNode data) throws IOException {
176 final QName nodeType = data.name().getNodeType();
177 final String namespace = nodeType.getNamespace().toString();
179 xmlWriter.writeStartElement(XMLConstants.DEFAULT_NS_PREFIX, nodeType.getLocalName(), namespace);
180 xmlWriter.writeDefaultNamespace(namespace);
181 for (var child : data.body()) {
182 nnWriter.write(child);
185 xmlWriter.writeEndElement();
187 } catch (final XMLStreamException e) {
188 throw new IOException("Failed to write elements", e);