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
9 package org.opendaylight.restconf.nb.rfc8040.jersey.providers;
11 import java.io.IOException;
12 import java.io.OutputStream;
13 import java.lang.annotation.Annotation;
14 import java.lang.reflect.Type;
15 import java.nio.charset.StandardCharsets;
16 import java.util.List;
18 import javanet.staxutils.IndentingXMLStreamWriter;
19 import javax.ws.rs.Produces;
20 import javax.ws.rs.WebApplicationException;
21 import javax.ws.rs.core.MediaType;
22 import javax.ws.rs.core.MultivaluedMap;
23 import javax.ws.rs.ext.MessageBodyWriter;
24 import javax.ws.rs.ext.Provider;
25 import javax.xml.XMLConstants;
26 import javax.xml.stream.FactoryConfigurationError;
27 import javax.xml.stream.XMLOutputFactory;
28 import javax.xml.stream.XMLStreamException;
29 import javax.xml.stream.XMLStreamWriter;
30 import org.opendaylight.restconf.common.context.InstanceIdentifierContext;
31 import org.opendaylight.restconf.common.context.NormalizedNodeContext;
32 import org.opendaylight.restconf.nb.rfc8040.Rfc8040;
33 import org.opendaylight.restconf.nb.rfc8040.jersey.providers.api.RestconfNormalizedNodeWriter;
34 import org.opendaylight.restconf.nb.rfc8040.utils.RestconfConstants;
35 import org.opendaylight.yangtools.yang.common.QName;
36 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
37 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
38 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
39 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
40 import org.opendaylight.yangtools.yang.data.codec.xml.XMLStreamNormalizedNodeStreamWriter;
41 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
42 import org.opendaylight.yangtools.yang.model.api.ActionDefinition;
43 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
44 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
45 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
48 @Produces({ Rfc8040.MediaTypes.DATA + RestconfConstants.XML, MediaType.APPLICATION_XML, MediaType.TEXT_XML })
49 public class NormalizedNodeXmlBodyWriter implements MessageBodyWriter<NormalizedNodeContext> {
51 private static final XMLOutputFactory XML_FACTORY;
54 XML_FACTORY = XMLOutputFactory.newFactory();
55 XML_FACTORY.setProperty(XMLOutputFactory.IS_REPAIRING_NAMESPACES, true);
59 public boolean isWriteable(final Class<?> type,
60 final Type genericType,
61 final Annotation[] annotations,
62 final MediaType mediaType) {
63 return type.equals(NormalizedNodeContext.class);
67 public long getSize(final NormalizedNodeContext context,
69 final Type genericType,
70 final Annotation[] annotations,
71 final MediaType mediaType) {
76 public void writeTo(final NormalizedNodeContext context,
78 final Type genericType,
79 final Annotation[] annotations,
80 final MediaType mediaType,
81 final MultivaluedMap<String, Object> httpHeaders,
82 final OutputStream entityStream) throws IOException, WebApplicationException {
83 final InstanceIdentifierContext<?> pathContext = context.getInstanceIdentifierContext();
84 if (context.getData() == null) {
88 XMLStreamWriter xmlWriter;
90 xmlWriter = XML_FACTORY.createXMLStreamWriter(entityStream, StandardCharsets.UTF_8.name());
91 if (context.getWriterParameters().isPrettyPrint()) {
92 xmlWriter = new IndentingXMLStreamWriter(xmlWriter);
94 } catch (final XMLStreamException | FactoryConfigurationError e) {
95 throw new IllegalStateException(e);
97 final NormalizedNode<?, ?> data = context.getData();
98 final SchemaPath schemaPath = pathContext.getSchemaNode().getPath();
100 writeNormalizedNode(xmlWriter, schemaPath, pathContext, data, context.getWriterParameters().getDepth(),
101 context.getWriterParameters().getFields());
104 private static void writeNormalizedNode(final XMLStreamWriter xmlWriter,
105 final SchemaPath path, final InstanceIdentifierContext<?> pathContext, final NormalizedNode<?, ?> data,
106 final Integer depth, final List<Set<QName>> fields) throws IOException {
107 final RestconfNormalizedNodeWriter nnWriter;
108 final SchemaContext schemaCtx = pathContext.getSchemaContext();
110 if (pathContext.getSchemaNode() instanceof RpcDefinition) {
112 * RpcDefinition is not supported as initial codec in XMLStreamWriter,
113 * so we need to emit initial output declaration..
115 nnWriter = createNormalizedNodeWriter(
118 ((RpcDefinition) pathContext.getSchemaNode()).getOutput().getPath(),
121 writeElements(xmlWriter, nnWriter, (ContainerNode) data);
122 } else if (pathContext.getSchemaNode() instanceof ActionDefinition) {
124 * ActionDefinition is not supported as initial codec in XMLStreamWriter,
125 * so we need to emit initial output declaration..
127 nnWriter = createNormalizedNodeWriter(xmlWriter, schemaCtx,
128 ((ActionDefinition) pathContext.getSchemaNode()).getOutput().getPath(), depth, fields);
129 writeElements(xmlWriter, nnWriter, (ContainerNode) data);
131 if (SchemaPath.ROOT.equals(path)) {
132 nnWriter = createNormalizedNodeWriter(xmlWriter, schemaCtx, path, depth, fields);
134 nnWriter = createNormalizedNodeWriter(xmlWriter, schemaCtx, path.getParent(), depth, fields);
137 if (data instanceof MapEntryNode) {
138 // Restconf allows returning one list item. We need to wrap it
139 // in map node in order to serialize it properly
140 nnWriter.write(ImmutableNodes.mapNodeBuilder(data.getNodeType()).addChild((MapEntryNode) data).build());
142 nnWriter.write(data);
149 private static RestconfNormalizedNodeWriter createNormalizedNodeWriter(final XMLStreamWriter xmlWriter,
150 final SchemaContext schemaContext, final SchemaPath schemaPath, final Integer depth,
151 final List<Set<QName>> fields) {
152 final NormalizedNodeStreamWriter xmlStreamWriter = XMLStreamNormalizedNodeStreamWriter
153 .create(xmlWriter, schemaContext, schemaPath);
154 return ParameterAwareNormalizedNodeWriter.forStreamWriter(xmlStreamWriter, depth, fields);
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,
162 name.getLocalName(), 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);