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.restconf.Draft16;
34 import org.opendaylight.yangtools.yang.common.QName;
35 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
36 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
37 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
38 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
39 import org.opendaylight.yangtools.yang.data.impl.codec.xml.XMLStreamNormalizedNodeStreamWriter;
40 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
41 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
42 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
43 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
46 @Produces({ Draft02.MediaTypes.API + RestconfService.XML, Draft02.MediaTypes.DATA + RestconfService.XML,
47 Draft02.MediaTypes.OPERATION + RestconfService.XML, Draft16.MediaTypes.DATA, MediaType.APPLICATION_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, final Type genericType, final Annotation[] annotations,
60 final MediaType mediaType) {
61 return type.equals(NormalizedNodeContext.class);
65 public long getSize(final NormalizedNodeContext t, final Class<?> type, final Type genericType,
66 final Annotation[] annotations, final MediaType mediaType) {
71 public void writeTo(final NormalizedNodeContext t, final Class<?> type, final Type genericType,
72 final Annotation[] annotations, final MediaType mediaType,
73 final MultivaluedMap<String, Object> httpHeaders, final OutputStream entityStream) throws IOException,
74 WebApplicationException {
75 final InstanceIdentifierContext<?> pathContext = t.getInstanceIdentifierContext();
76 if (t.getData() == null) {
80 XMLStreamWriter xmlWriter;
82 xmlWriter = XML_FACTORY.createXMLStreamWriter(entityStream);
83 if (t.getWriterParameters().isPrettyPrint()) {
84 xmlWriter = new IndentingXMLStreamWriter(xmlWriter);
86 } catch (final XMLStreamException e) {
87 throw new IllegalStateException(e);
88 } catch (final FactoryConfigurationError e) {
89 throw new IllegalStateException(e);
91 final NormalizedNode<?, ?> data = t.getData();
92 final SchemaPath schemaPath = pathContext.getSchemaNode().getPath();
96 writeNormalizedNode(xmlWriter, schemaPath, pathContext, data, t.getWriterParameters().getDepth());
100 private void writeNormalizedNode(final XMLStreamWriter xmlWriter, final SchemaPath schemaPath, final InstanceIdentifierContext<?>
101 pathContext, NormalizedNode<?, ?> data, final Optional<Integer> depth) throws IOException {
102 final RestconfNormalizedNodeWriter nnWriter;
103 final SchemaContext schemaCtx = pathContext.getSchemaContext();
104 if (SchemaPath.ROOT.equals(schemaPath)) {
105 nnWriter = createNormalizedNodeWriter(xmlWriter, schemaCtx, schemaPath, depth);
106 writeElements(xmlWriter, nnWriter, (ContainerNode) data);
107 } else if (pathContext.getSchemaNode() instanceof RpcDefinition) {
108 nnWriter = createNormalizedNodeWriter(xmlWriter, schemaCtx,
109 ((RpcDefinition) pathContext.getSchemaNode()).getOutput().getPath(), depth);
110 writeElements(xmlWriter, nnWriter, (ContainerNode) data);
112 nnWriter = createNormalizedNodeWriter(xmlWriter, schemaCtx, schemaPath.getParent(), depth);
113 if (data instanceof MapEntryNode) {
114 // Restconf allows returning one list item. We need to wrap it
115 // in map node in order to serialize it properly
116 data = ImmutableNodes.mapNodeBuilder(data.getNodeType()).addChild((MapEntryNode) data).build();
118 nnWriter.write(data);
123 private RestconfNormalizedNodeWriter createNormalizedNodeWriter(final XMLStreamWriter xmlWriter,
124 final SchemaContext schemaContext, final SchemaPath schemaPath, final Optional<Integer> depth) {
125 final NormalizedNodeStreamWriter xmlStreamWriter = XMLStreamNormalizedNodeStreamWriter.create(xmlWriter, schemaContext, schemaPath);
126 if (depth.isPresent()) {
127 return DepthAwareNormalizedNodeWriter.forStreamWriter(xmlStreamWriter, depth.get());
129 return RestconfDelegatingNormalizedNodeWriter.forStreamWriter(xmlStreamWriter);
133 private void writeElements(final XMLStreamWriter xmlWriter, final RestconfNormalizedNodeWriter nnWriter,
134 final ContainerNode data)
137 final QName name = data.getNodeType();
138 xmlWriter.writeStartElement(XMLConstants.DEFAULT_NS_PREFIX, name.getLocalName(), name.getNamespace().toString());
139 xmlWriter.writeDefaultNamespace(name.getNamespace().toString());
140 for(final NormalizedNode<?,?> child : data.getValue()) {
141 nnWriter.write(child);
144 xmlWriter.writeEndElement();
146 } catch (final XMLStreamException e) {
147 Throwables.propagate(e);