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 com.google.common.base.Optional;
11 import com.google.common.base.Throwables;
12 import java.io.IOException;
13 import java.io.OutputStream;
14 import java.lang.annotation.Annotation;
15 import java.lang.reflect.Type;
16 import javanet.staxutils.IndentingXMLStreamWriter;
17 import javax.ws.rs.Produces;
18 import javax.ws.rs.WebApplicationException;
19 import javax.ws.rs.core.MediaType;
20 import javax.ws.rs.core.MultivaluedMap;
21 import javax.ws.rs.ext.MessageBodyWriter;
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.netconf.sal.rest.api.Draft02;
29 import org.opendaylight.netconf.sal.rest.api.RestconfNormalizedNodeWriter;
30 import org.opendaylight.netconf.sal.rest.api.RestconfService;
31 import org.opendaylight.netconf.sal.restconf.impl.InstanceIdentifierContext;
32 import org.opendaylight.netconf.sal.restconf.impl.NormalizedNodeContext;
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.api.schema.stream.NormalizedNodeStreamWriter;
38 import org.opendaylight.yangtools.yang.data.impl.codec.xml.XMLStreamNormalizedNodeStreamWriter;
39 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
40 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
41 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
42 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
45 @Produces({ Draft02.MediaTypes.API + RestconfService.XML, Draft02.MediaTypes.DATA + RestconfService.XML,
46 Draft02.MediaTypes.OPERATION + RestconfService.XML, MediaType.APPLICATION_XML, MediaType.TEXT_XML })
47 public class NormalizedNodeXmlBodyWriter implements MessageBodyWriter<NormalizedNodeContext> {
49 private static final XMLOutputFactory XML_FACTORY;
52 XML_FACTORY = XMLOutputFactory.newFactory();
53 XML_FACTORY.setProperty(XMLOutputFactory.IS_REPAIRING_NAMESPACES, true);
57 public boolean isWriteable(final Class<?> type, final Type genericType, final Annotation[] annotations,
58 final MediaType mediaType) {
59 return type.equals(NormalizedNodeContext.class);
63 public long getSize(final NormalizedNodeContext t, final Class<?> type, final Type genericType,
64 final Annotation[] annotations, final MediaType mediaType) {
69 public void writeTo(final NormalizedNodeContext t, final Class<?> type, final Type genericType,
70 final Annotation[] annotations, final MediaType mediaType,
71 final MultivaluedMap<String, Object> httpHeaders, final OutputStream entityStream) throws IOException,
72 WebApplicationException {
73 final InstanceIdentifierContext<?> pathContext = t.getInstanceIdentifierContext();
74 if (t.getData() == null) {
78 XMLStreamWriter xmlWriter;
80 xmlWriter = XML_FACTORY.createXMLStreamWriter(entityStream);
81 if (t.getWriterParameters().isPrettyPrint()) {
82 xmlWriter = new IndentingXMLStreamWriter(xmlWriter);
84 } catch (final XMLStreamException e) {
85 throw new IllegalStateException(e);
86 } catch (final FactoryConfigurationError e) {
87 throw new IllegalStateException(e);
89 NormalizedNode<?, ?> data = t.getData();
90 SchemaPath schemaPath = pathContext.getSchemaNode().getPath();
94 writeNormalizedNode(xmlWriter, schemaPath, pathContext, data, t.getWriterParameters().getDepth());
98 private void writeNormalizedNode(XMLStreamWriter xmlWriter, SchemaPath schemaPath, InstanceIdentifierContext<?>
99 pathContext, NormalizedNode<?, ?> data, Optional<Integer> depth) throws IOException {
100 final RestconfNormalizedNodeWriter nnWriter;
101 final SchemaContext schemaCtx = pathContext.getSchemaContext();
102 if (SchemaPath.ROOT.equals(schemaPath)) {
103 nnWriter = createNormalizedNodeWriter(xmlWriter, schemaCtx, schemaPath, depth);
104 writeElements(xmlWriter, nnWriter, (ContainerNode) data);
105 } else if (pathContext.getSchemaNode() instanceof RpcDefinition) {
106 nnWriter = createNormalizedNodeWriter(xmlWriter, schemaCtx,
107 ((RpcDefinition) pathContext.getSchemaNode()).getOutput().getPath(), depth);
108 writeElements(xmlWriter, nnWriter, (ContainerNode) data);
110 nnWriter = createNormalizedNodeWriter(xmlWriter, schemaCtx, schemaPath.getParent(), depth);
111 if (data instanceof MapEntryNode) {
112 // Restconf allows returning one list item. We need to wrap it
113 // in map node in order to serialize it properly
114 data = ImmutableNodes.mapNodeBuilder(data.getNodeType()).addChild((MapEntryNode) data).build();
116 nnWriter.write(data);
121 private RestconfNormalizedNodeWriter createNormalizedNodeWriter(XMLStreamWriter xmlWriter,
122 SchemaContext schemaContext, SchemaPath schemaPath, Optional<Integer> depth) {
123 NormalizedNodeStreamWriter xmlStreamWriter = XMLStreamNormalizedNodeStreamWriter.create(xmlWriter, schemaContext, schemaPath);
124 if (depth.isPresent()) {
125 return DepthAwareNormalizedNodeWriter.forStreamWriter(xmlStreamWriter, depth.get());
127 return RestconfDelegatingNormalizedNodeWriter.forStreamWriter(xmlStreamWriter);
131 private void writeElements(final XMLStreamWriter xmlWriter, final RestconfNormalizedNodeWriter nnWriter,
132 final ContainerNode data)
135 final QName name = data.getNodeType();
136 xmlWriter.writeStartElement(XMLConstants.DEFAULT_NS_PREFIX, name.getLocalName(), name.getNamespace().toString());
137 xmlWriter.writeDefaultNamespace(name.getNamespace().toString());
138 for(NormalizedNode<?,?> child : data.getValue()) {
139 nnWriter.write(child);
142 xmlWriter.writeEndElement();
144 } catch (final XMLStreamException e) {
145 Throwables.propagate(e);