2 * Copyright (c) 2014 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 java.io.IOException;
11 import java.io.OutputStream;
12 import java.lang.annotation.Annotation;
13 import java.lang.reflect.Type;
14 import java.net.URISyntaxException;
15 import java.nio.charset.StandardCharsets;
16 import java.util.Map.Entry;
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.MessageBodyWriter;
23 import javax.ws.rs.ext.Provider;
24 import javax.xml.XMLConstants;
25 import javax.xml.stream.FactoryConfigurationError;
26 import javax.xml.stream.XMLOutputFactory;
27 import javax.xml.stream.XMLStreamException;
28 import javax.xml.stream.XMLStreamWriter;
29 import org.eclipse.jdt.annotation.Nullable;
30 import org.opendaylight.netconf.sal.rest.api.Draft02;
31 import org.opendaylight.netconf.sal.rest.api.RestconfNormalizedNodeWriter;
32 import org.opendaylight.netconf.sal.rest.api.RestconfService;
33 import org.opendaylight.netconf.util.NetconfUtil;
34 import org.opendaylight.restconf.common.context.InstanceIdentifierContext;
35 import org.opendaylight.restconf.common.context.NormalizedNodeContext;
36 import org.opendaylight.yangtools.yang.common.QName;
37 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
38 import org.opendaylight.yangtools.yang.data.api.schema.DOMSourceAnyxmlNode;
39 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
40 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
41 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
42 import org.opendaylight.yangtools.yang.data.codec.xml.XMLStreamNormalizedNodeStreamWriter;
43 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
44 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
45 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
46 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
47 import org.xml.sax.SAXException;
50 * Normalized node writer for XML.
52 * @deprecated This class will be replaced by NormalizedNodeXmlBodyWriter from restconf-nb-rfc8040
57 Draft02.MediaTypes.API + RestconfService.XML,
58 Draft02.MediaTypes.DATA + RestconfService.XML,
59 Draft02.MediaTypes.OPERATION + RestconfService.XML,
60 MediaType.APPLICATION_XML,
63 public class NormalizedNodeXmlBodyWriter implements MessageBodyWriter<NormalizedNodeContext> {
65 private static final XMLOutputFactory XML_FACTORY;
68 XML_FACTORY = XMLOutputFactory.newFactory();
69 XML_FACTORY.setProperty(XMLOutputFactory.IS_REPAIRING_NAMESPACES, true);
73 public boolean isWriteable(final Class<?> type, final Type genericType, final Annotation[] annotations,
74 final MediaType mediaType) {
75 return type.equals(NormalizedNodeContext.class);
79 public long getSize(final NormalizedNodeContext context, final Class<?> type, final Type genericType,
80 final Annotation[] annotations, final MediaType mediaType) {
85 public void writeTo(final NormalizedNodeContext context, final Class<?> type, final Type genericType,
86 final Annotation[] annotations, final MediaType mediaType,
87 final MultivaluedMap<String, Object> httpHeaders, final OutputStream entityStream) throws IOException,
88 WebApplicationException {
89 for (final Entry<String, Object> entry : context.getNewHeaders().entrySet()) {
90 httpHeaders.add(entry.getKey(), entry.getValue());
92 final InstanceIdentifierContext<?> pathContext = context.getInstanceIdentifierContext();
93 if (context.getData() == null) {
97 XMLStreamWriter xmlWriter;
99 xmlWriter = XML_FACTORY.createXMLStreamWriter(entityStream, StandardCharsets.UTF_8.name());
100 if (context.getWriterParameters().isPrettyPrint()) {
101 xmlWriter = new IndentingXMLStreamWriter(xmlWriter);
103 } catch (final XMLStreamException | FactoryConfigurationError e) {
104 throw new IllegalStateException(e);
106 final NormalizedNode<?, ?> data = context.getData();
107 final SchemaPath schemaPath = pathContext.getSchemaNode().getPath();
109 writeNormalizedNode(xmlWriter, schemaPath, pathContext, data, context.getWriterParameters().getDepth());
112 private static void writeNormalizedNode(final XMLStreamWriter xmlWriter, final SchemaPath schemaPath,
113 final InstanceIdentifierContext<?> pathContext, NormalizedNode<?, ?> data, final @Nullable Integer depth)
115 final RestconfNormalizedNodeWriter nnWriter;
116 final EffectiveModelContext schemaCtx = pathContext.getSchemaContext();
117 if (SchemaPath.ROOT.equals(schemaPath)) {
118 nnWriter = createNormalizedNodeWriter(xmlWriter, schemaCtx, schemaPath, depth);
119 if (data instanceof DOMSourceAnyxmlNode) {
121 writeElements(xmlWriter, nnWriter,
122 (ContainerNode) NetconfUtil.transformDOMSourceToNormalizedNode(schemaCtx,
123 ((DOMSourceAnyxmlNode)data).getValue()).getResult());
124 } catch (XMLStreamException | URISyntaxException | SAXException e) {
125 throw new IOException("Cannot write anyxml", e);
128 writeElements(xmlWriter, nnWriter, (ContainerNode) data);
130 } else if (pathContext.getSchemaNode() instanceof RpcDefinition) {
131 nnWriter = createNormalizedNodeWriter(xmlWriter, schemaCtx,
132 ((RpcDefinition) pathContext.getSchemaNode()).getOutput().getPath(), depth);
133 writeElements(xmlWriter, nnWriter, (ContainerNode) data);
135 nnWriter = createNormalizedNodeWriter(xmlWriter, schemaCtx, schemaPath.getParent(), depth);
136 if (data instanceof MapEntryNode) {
137 // Restconf allows returning one list item. We need to wrap it
138 // in map node in order to serialize it properly
139 data = ImmutableNodes.mapNodeBuilder(data.getNodeType()).addChild((MapEntryNode) data).build();
141 nnWriter.write(data);
146 private static RestconfNormalizedNodeWriter createNormalizedNodeWriter(final XMLStreamWriter xmlWriter,
147 final EffectiveModelContext schemaContext, final SchemaPath schemaPath, final @Nullable Integer depth) {
148 final NormalizedNodeStreamWriter xmlStreamWriter =
149 XMLStreamNormalizedNodeStreamWriter.create(xmlWriter, schemaContext, schemaPath);
151 return DepthAwareNormalizedNodeWriter.forStreamWriter(xmlStreamWriter, depth);
154 return RestconfDelegatingNormalizedNodeWriter.forStreamWriter(xmlStreamWriter);
157 private static void writeElements(final XMLStreamWriter xmlWriter, final RestconfNormalizedNodeWriter nnWriter,
158 final ContainerNode data) throws IOException {
159 final QName name = data.getNodeType();
161 xmlWriter.writeStartElement(XMLConstants.DEFAULT_NS_PREFIX, name.getLocalName(),
162 name.getNamespace().toString());
163 xmlWriter.writeDefaultNamespace(name.getNamespace().toString());
164 for (final NormalizedNode<?,?> child : data.getValue()) {
165 nnWriter.write(child);
168 xmlWriter.writeEndElement();
170 } catch (final XMLStreamException e) {
171 throw new IOException("Failed to write elements", e);