restconf/restconf-nb-bierman02/src/main/java/org/opendaylight/netconf/sal/rest/impl/NormalizedNodeXmlBodyWriter.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.netconf.sal.rest.impl;
   9
  10 import com.google.common.base.Optional;
  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.net.URISyntaxException;
  16 import java.nio.charset.StandardCharsets;
  17 import java.util.Map.Entry;
  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.parsers.ParserConfigurationException;
  27 import javax.xml.stream.FactoryConfigurationError;
  28 import javax.xml.stream.XMLOutputFactory;
  29 import javax.xml.stream.XMLStreamException;
  30 import javax.xml.stream.XMLStreamWriter;
  31 import org.opendaylight.netconf.sal.rest.api.Draft02;
  32 import org.opendaylight.netconf.sal.rest.api.RestconfNormalizedNodeWriter;
  33 import org.opendaylight.netconf.sal.rest.api.RestconfService;
  34 import org.opendaylight.netconf.util.NetconfUtil;
  35 import org.opendaylight.restconf.common.context.InstanceIdentifierContext;
  36 import org.opendaylight.restconf.common.context.NormalizedNodeContext;
  37 import org.opendaylight.yangtools.yang.common.QName;
  38 import org.opendaylight.yangtools.yang.data.api.schema.AnyXmlNode;
  39 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  40 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  41 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  42 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  43 import org.opendaylight.yangtools.yang.data.codec.xml.XMLStreamNormalizedNodeStreamWriter;
  44 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  45 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  46 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  47 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  48 import org.xml.sax.SAXException;
  49
  50 /**
  51  * Normalized node writer for XML.
  52  *
  53  * @deprecated This class will be replaced by NormalizedNodeXmlBodyWriter from restconf-nb-rfc8040
  54  */
  55 @Deprecated
  56 @Provider
  57 @Produces({ Draft02.MediaTypes.API + RestconfService.XML, Draft02.MediaTypes.DATA + RestconfService.XML,
  58         Draft02.MediaTypes.OPERATION + RestconfService.XML, MediaType.APPLICATION_XML, MediaType.TEXT_XML })
  59 public class NormalizedNodeXmlBodyWriter implements MessageBodyWriter<NormalizedNodeContext> {
  60
  61     private static final XMLOutputFactory XML_FACTORY;
  62
  63     static {
  64         XML_FACTORY = XMLOutputFactory.newFactory();
  65         XML_FACTORY.setProperty(XMLOutputFactory.IS_REPAIRING_NAMESPACES, true);
  66     }
  67
  68     @Override
  69     public boolean isWriteable(final Class<?> type, final Type genericType, final Annotation[] annotations,
  70             final MediaType mediaType) {
  71         return type.equals(NormalizedNodeContext.class);
  72     }
  73
  74     @Override
  75     public long getSize(final NormalizedNodeContext context, final Class<?> type, final Type genericType,
  76             final Annotation[] annotations, final MediaType mediaType) {
  77         return -1;
  78     }
  79
  80     @Override
  81     public void writeTo(final NormalizedNodeContext context, final Class<?> type, final Type genericType,
  82             final Annotation[] annotations, final MediaType mediaType,
  83             final MultivaluedMap<String, Object> httpHeaders, final OutputStream entityStream) throws IOException,
  84             WebApplicationException {
  85         for (final Entry<String, Object> entry : context.getNewHeaders().entrySet()) {
  86             httpHeaders.add(entry.getKey(), entry.getValue());
  87         }
  88         final InstanceIdentifierContext<?> pathContext = context.getInstanceIdentifierContext();
  89         if (context.getData() == null) {
  90             return;
  91         }
  92
  93         XMLStreamWriter xmlWriter;
  94         try {
  95             xmlWriter = XML_FACTORY.createXMLStreamWriter(entityStream, StandardCharsets.UTF_8.name());
  96             if (context.getWriterParameters().isPrettyPrint()) {
  97                 xmlWriter = new IndentingXMLStreamWriter(xmlWriter);
  98             }
  99         } catch (final XMLStreamException | FactoryConfigurationError e) {
 100             throw new IllegalStateException(e);
 101         }
 102         final NormalizedNode<?, ?> data = context.getData();
 103         final SchemaPath schemaPath = pathContext.getSchemaNode().getPath();
 104
 105         writeNormalizedNode(xmlWriter, schemaPath, pathContext, data,
 106                 Optional.fromNullable(context.getWriterParameters().getDepth()));
 107     }
 108
 109     private static void writeNormalizedNode(final XMLStreamWriter xmlWriter, final SchemaPath schemaPath,
 110             final InstanceIdentifierContext<?> pathContext, NormalizedNode<?, ?> data, final Optional<Integer> depth)
 111             throws IOException {
 112         final RestconfNormalizedNodeWriter nnWriter;
 113         final SchemaContext schemaCtx = pathContext.getSchemaContext();
 114         if (SchemaPath.ROOT.equals(schemaPath)) {
 115             nnWriter = createNormalizedNodeWriter(xmlWriter, schemaCtx, schemaPath, depth);
 116             if (data instanceof AnyXmlNode) {
 117                 try {
 118                     writeElements(xmlWriter, nnWriter,
 119                             (ContainerNode) NetconfUtil.transformDOMSourceToNormalizedNode(schemaCtx,
 120                                     ((AnyXmlNode)data).getValue()).getResult());
 121                 } catch (XMLStreamException | URISyntaxException | SAXException | ParserConfigurationException e) {
 122                     throw new IOException("Cannot write anyxml", e);
 123                 }
 124             } else {
 125                 writeElements(xmlWriter, nnWriter, (ContainerNode) data);
 126             }
 127         }  else if (pathContext.getSchemaNode() instanceof RpcDefinition) {
 128             nnWriter = createNormalizedNodeWriter(xmlWriter, schemaCtx,
 129                     ((RpcDefinition) pathContext.getSchemaNode()).getOutput().getPath(), depth);
 130             writeElements(xmlWriter, nnWriter, (ContainerNode) data);
 131         } else {
 132             nnWriter = createNormalizedNodeWriter(xmlWriter, schemaCtx, schemaPath.getParent(), depth);
 133             if (data instanceof MapEntryNode) {
 134                 // Restconf allows returning one list item. We need to wrap it
 135                 // in map node in order to serialize it properly
 136                 data = ImmutableNodes.mapNodeBuilder(data.getNodeType()).addChild((MapEntryNode) data).build();
 137             }
 138             nnWriter.write(data);
 139         }
 140         nnWriter.flush();
 141     }
 142
 143     private static RestconfNormalizedNodeWriter createNormalizedNodeWriter(final XMLStreamWriter xmlWriter,
 144             final SchemaContext schemaContext, final SchemaPath schemaPath, final Optional<Integer> depth) {
 145         final NormalizedNodeStreamWriter xmlStreamWriter =
 146                 XMLStreamNormalizedNodeStreamWriter.create(xmlWriter, schemaContext, schemaPath);
 147         if (depth.isPresent()) {
 148             return DepthAwareNormalizedNodeWriter.forStreamWriter(xmlStreamWriter, depth.get());
 149         }
 150
 151         return RestconfDelegatingNormalizedNodeWriter.forStreamWriter(xmlStreamWriter);
 152     }
 153
 154     private static void writeElements(final XMLStreamWriter xmlWriter, final RestconfNormalizedNodeWriter nnWriter,
 155             final ContainerNode data) throws IOException {
 156         final QName name = data.getNodeType();
 157         try {
 158             xmlWriter.writeStartElement(XMLConstants.DEFAULT_NS_PREFIX, name.getLocalName(),
 159                     name.getNamespace().toString());
 160             xmlWriter.writeDefaultNamespace(name.getNamespace().toString());
 161             for (final NormalizedNode<?,?> child : data.getValue()) {
 162                 nnWriter.write(child);
 163             }
 164             nnWriter.flush();
 165             xmlWriter.writeEndElement();
 166             xmlWriter.flush();
 167         } catch (final XMLStreamException e) {
 168             throw new IOException("Failed to write elements", e);
 169         }
 170     }
 171 }