restconf/restconf-nb-bierman02/src/main/java/org/opendaylight/restconf/jersey/providers/NormalizedNodeXmlBodyWriter.java

   1 /*
   2  * Copyright (c) 2016 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
   9 package org.opendaylight.restconf.jersey.providers;
  10
  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 java.nio.charset.StandardCharsets;
  17 import java.util.List;
  18 import java.util.Set;
  19 import javanet.staxutils.IndentingXMLStreamWriter;
  20 import javax.ws.rs.Produces;
  21 import javax.ws.rs.WebApplicationException;
  22 import javax.ws.rs.core.MediaType;
  23 import javax.ws.rs.core.MultivaluedMap;
  24 import javax.ws.rs.ext.MessageBodyWriter;
  25 import javax.ws.rs.ext.Provider;
  26 import javax.xml.XMLConstants;
  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.RestconfNormalizedNodeWriter;
  32 import org.opendaylight.restconf.Rfc8040;
  33 import org.opendaylight.restconf.common.context.InstanceIdentifierContext;
  34 import org.opendaylight.restconf.common.context.NormalizedNodeContext;
  35 import org.opendaylight.restconf.utils.RestconfConstants;
  36 import org.opendaylight.yangtools.yang.common.QName;
  37 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  38 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  39 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  40 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  41 import org.opendaylight.yangtools.yang.data.codec.xml.XMLStreamNormalizedNodeStreamWriter;
  42 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  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;
  46
  47 /**
  48  * Writer of NormalizedNode to XML.
  49  *
  50  * @deprecated move to splitted module restconf-nb-rfc8040
  51  */
  52 @Deprecated
  53 @Provider
  54 @Produces({ Rfc8040.MediaTypes.DATA + RestconfConstants.XML, MediaType.APPLICATION_XML, MediaType.TEXT_XML })
  55 public class NormalizedNodeXmlBodyWriter implements MessageBodyWriter<NormalizedNodeContext> {
  56
  57     private static final XMLOutputFactory XML_FACTORY;
  58
  59     static {
  60         XML_FACTORY = XMLOutputFactory.newFactory();
  61         XML_FACTORY.setProperty(XMLOutputFactory.IS_REPAIRING_NAMESPACES, true);
  62     }
  63
  64     @Override
  65     public boolean isWriteable(final Class<?> type,
  66                                final Type genericType,
  67                                final Annotation[] annotations,
  68                                final MediaType mediaType) {
  69         return type.equals(NormalizedNodeContext.class);
  70     }
  71
  72     @Override
  73     public long getSize(final NormalizedNodeContext context,
  74                         final Class<?> type,
  75                         final Type genericType,
  76                         final Annotation[] annotations,
  77                         final MediaType mediaType) {
  78         return -1;
  79     }
  80
  81     @Override
  82     public void writeTo(final NormalizedNodeContext context,
  83                         final Class<?> type,
  84                         final Type genericType,
  85                         final Annotation[] annotations,
  86                         final MediaType mediaType,
  87                         final MultivaluedMap<String, Object> httpHeaders,
  88                         final OutputStream entityStream) throws IOException, WebApplicationException {
  89         final InstanceIdentifierContext<?> pathContext = context.getInstanceIdentifierContext();
  90         if (context.getData() == null) {
  91             return;
  92         }
  93
  94         XMLStreamWriter xmlWriter;
  95         try {
  96             xmlWriter = XML_FACTORY.createXMLStreamWriter(entityStream, StandardCharsets.UTF_8.name());
  97             if (context.getWriterParameters().isPrettyPrint()) {
  98                 xmlWriter = new IndentingXMLStreamWriter(xmlWriter);
  99             }
 100         } catch (final XMLStreamException | FactoryConfigurationError e) {
 101             throw new IllegalStateException(e);
 102         }
 103         final NormalizedNode<?, ?> data = context.getData();
 104         final SchemaPath schemaPath = pathContext.getSchemaNode().getPath();
 105
 106         writeNormalizedNode(xmlWriter, schemaPath, pathContext, data, context.getWriterParameters().getDepth(),
 107                 context.getWriterParameters().getFields());
 108     }
 109
 110     private static void writeNormalizedNode(final XMLStreamWriter xmlWriter,
 111             final SchemaPath path, final InstanceIdentifierContext<?> pathContext, final NormalizedNode<?, ?> data,
 112             final Integer depth, final List<Set<QName>> fields) throws IOException {
 113         final RestconfNormalizedNodeWriter nnWriter;
 114         final SchemaContext schemaCtx = pathContext.getSchemaContext();
 115
 116         if (pathContext.getSchemaNode() instanceof RpcDefinition) {
 117             /*
 118              *  RpcDefinition is not supported as initial codec in XMLStreamWriter,
 119              *  so we need to emit initial output declaration..
 120              */
 121             nnWriter = createNormalizedNodeWriter(
 122                     xmlWriter,
 123                     schemaCtx,
 124                     ((RpcDefinition) pathContext.getSchemaNode()).getOutput().getPath(),
 125                     depth,
 126                     fields);
 127             writeElements(xmlWriter, nnWriter, (ContainerNode) data);
 128         } else {
 129             if (SchemaPath.ROOT.equals(path)) {
 130                 nnWriter = createNormalizedNodeWriter(xmlWriter, schemaCtx, path, depth, fields);
 131             } else {
 132                 nnWriter = createNormalizedNodeWriter(xmlWriter, schemaCtx, path.getParent(), depth, fields);
 133             }
 134
 135             if (data instanceof MapEntryNode) {
 136                 // Restconf allows returning one list item. We need to wrap it
 137                 // in map node in order to serialize it properly
 138                 nnWriter.write(ImmutableNodes.mapNodeBuilder(data.getNodeType()).addChild((MapEntryNode) data).build());
 139             } else {
 140                 nnWriter.write(data);
 141             }
 142         }
 143
 144         nnWriter.flush();
 145     }
 146
 147     private static RestconfNormalizedNodeWriter createNormalizedNodeWriter(final XMLStreamWriter xmlWriter,
 148             final SchemaContext schemaContext, final SchemaPath schemaPath, final Integer depth,
 149             final List<Set<QName>> fields) {
 150         final NormalizedNodeStreamWriter xmlStreamWriter = XMLStreamNormalizedNodeStreamWriter
 151                 .create(xmlWriter, schemaContext, schemaPath);
 152         return ParameterAwareNormalizedNodeWriter.forStreamWriter(xmlStreamWriter, depth, fields);
 153     }
 154
 155     private static void writeElements(final XMLStreamWriter xmlWriter, final RestconfNormalizedNodeWriter nnWriter,
 156             final ContainerNode data) throws IOException {
 157         try {
 158             final QName name = data.getNodeType();
 159             xmlWriter.writeStartElement(XMLConstants.DEFAULT_NS_PREFIX,
 160                     name.getLocalName(), name.getNamespace().toString());
 161             xmlWriter.writeDefaultNamespace(name.getNamespace().toString());
 162             for (final NormalizedNode<?,?> child : data.getValue()) {
 163                 nnWriter.write(child);
 164             }
 165             nnWriter.flush();
 166             xmlWriter.writeEndElement();
 167             xmlWriter.flush();
 168         } catch (final XMLStreamException e) {
 169             Throwables.propagate(e);
 170         }
 171     }
 172 }