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.controller.sal.rest.impl;
10 import com.google.common.base.Throwables;
11 import java.io.IOException;
12 import java.io.OutputStream;
13 import java.lang.annotation.Annotation;
14 import java.lang.reflect.Type;
15 import javanet.staxutils.IndentingXMLStreamWriter;
16 import javax.ws.rs.Produces;
17 import javax.ws.rs.WebApplicationException;
18 import javax.ws.rs.core.MediaType;
19 import javax.ws.rs.core.MultivaluedMap;
20 import javax.ws.rs.ext.MessageBodyWriter;
21 import javax.ws.rs.ext.Provider;
22 import javax.xml.XMLConstants;
23 import javax.xml.stream.FactoryConfigurationError;
24 import javax.xml.stream.XMLOutputFactory;
25 import javax.xml.stream.XMLStreamException;
26 import javax.xml.stream.XMLStreamWriter;
27 import org.opendaylight.controller.sal.rest.api.Draft02;
28 import org.opendaylight.controller.sal.rest.api.RestconfService;
29 import org.opendaylight.controller.sal.restconf.impl.InstanceIdentifierContext;
30 import org.opendaylight.controller.sal.restconf.impl.NormalizedNodeContext;
31 import org.opendaylight.yangtools.yang.common.QName;
32 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
33 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
34 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
35 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
36 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeWriter;
37 import org.opendaylight.yangtools.yang.data.impl.codec.xml.XMLStreamNormalizedNodeStreamWriter;
38 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
39 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
40 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
41 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
44 @Produces({ Draft02.MediaTypes.API + RestconfService.XML, Draft02.MediaTypes.DATA + RestconfService.XML,
45 Draft02.MediaTypes.OPERATION + RestconfService.XML, MediaType.APPLICATION_XML, MediaType.TEXT_XML })
46 public class NormalizedNodeXmlBodyWriter implements MessageBodyWriter<NormalizedNodeContext> {
48 private static final XMLOutputFactory XML_FACTORY;
51 XML_FACTORY = XMLOutputFactory.newFactory();
52 XML_FACTORY.setProperty(XMLOutputFactory.IS_REPAIRING_NAMESPACES, true);
56 public boolean isWriteable(final Class<?> type, final Type genericType, final Annotation[] annotations,
57 final MediaType mediaType) {
58 return type.equals(NormalizedNodeContext.class);
62 public long getSize(final NormalizedNodeContext t, final Class<?> type, final Type genericType,
63 final Annotation[] annotations, final MediaType mediaType) {
68 public void writeTo(final NormalizedNodeContext t, final Class<?> type, final Type genericType,
69 final Annotation[] annotations, final MediaType mediaType,
70 final MultivaluedMap<String, Object> httpHeaders, final OutputStream entityStream) throws IOException,
71 WebApplicationException {
72 final InstanceIdentifierContext<?> pathContext = t.getInstanceIdentifierContext();
73 if (t.getData() == null) {
77 XMLStreamWriter xmlWriter;
79 xmlWriter = XML_FACTORY.createXMLStreamWriter(entityStream);
80 if (t.getWriterParameters().isPrettyPrint()) {
81 xmlWriter = new IndentingXMLStreamWriter(xmlWriter);
83 } catch (final XMLStreamException e) {
84 throw new IllegalStateException(e);
85 } catch (final FactoryConfigurationError e) {
86 throw new IllegalStateException(e);
88 NormalizedNode<?, ?> data = t.getData();
89 SchemaPath schemaPath = pathContext.getSchemaNode().getPath();
93 writeNormalizedNode(xmlWriter,schemaPath,pathContext,data);
96 private void writeNormalizedNode(XMLStreamWriter xmlWriter, SchemaPath schemaPath,InstanceIdentifierContext<?> pathContext, NormalizedNode<?, ?> data) throws IOException {
97 final NormalizedNodeWriter nnWriter;
98 final SchemaContext schemaCtx = pathContext.getSchemaContext();
99 if (SchemaPath.ROOT.equals(schemaPath)) {
100 nnWriter = createNormalizedNodeWriter(xmlWriter, schemaCtx, schemaPath);
101 writeElements(xmlWriter, nnWriter, (ContainerNode) data);
102 } else if (pathContext.getSchemaNode() instanceof RpcDefinition) {
103 nnWriter = createNormalizedNodeWriter(xmlWriter, schemaCtx, ((RpcDefinition) pathContext.getSchemaNode()).getOutput().getPath());
104 writeElements(xmlWriter, nnWriter, (ContainerNode) data);
106 nnWriter = createNormalizedNodeWriter(xmlWriter, schemaCtx, schemaPath.getParent());
107 if (data instanceof MapEntryNode) {
108 // Restconf allows returning one list item. We need to wrap it
109 // in map node in order to serialize it properly
110 data = ImmutableNodes.mapNodeBuilder(data.getNodeType()).addChild((MapEntryNode) data).build();
112 nnWriter.write(data);
117 private NormalizedNodeWriter createNormalizedNodeWriter(XMLStreamWriter xmlWriter,
118 SchemaContext schemaContext, SchemaPath schemaPath) {
119 NormalizedNodeStreamWriter xmlStreamWriter = XMLStreamNormalizedNodeStreamWriter.create(xmlWriter, schemaContext, schemaPath);
120 return NormalizedNodeWriter.forStreamWriter(xmlStreamWriter);
123 private void writeElements(final XMLStreamWriter xmlWriter, final NormalizedNodeWriter nnWriter, final ContainerNode data)
126 final QName name = data.getNodeType();
127 xmlWriter.writeStartElement(XMLConstants.DEFAULT_NS_PREFIX, name.getLocalName(), name.getNamespace().toString());
128 xmlWriter.writeDefaultNamespace(name.getNamespace().toString());
129 for(NormalizedNode<?,?> child : data.getValue()) {
130 nnWriter.write(child);
133 xmlWriter.writeEndElement();
135 } catch (final XMLStreamException e) {
136 Throwables.propagate(e);