restconf/restconf-nb-rfc8040/src/main/java/org/opendaylight/restconf/nb/rfc8040/jersey/providers/XmlNormalizedNodeBodyWriter.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 package org.opendaylight.restconf.nb.rfc8040.jersey.providers;
   9
  10 import java.io.IOException;
  11 import java.io.OutputStream;
  12 import java.lang.annotation.Annotation;
  13 import java.lang.reflect.Type;
  14 import java.nio.charset.StandardCharsets;
  15 import java.util.List;
  16 import java.util.Map;
  17 import java.util.Set;
  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.Provider;
  24 import javax.xml.XMLConstants;
  25 import javax.xml.stream.FactoryConfigurationError;
  26 import javax.xml.stream.XMLOutputFactory;
  27 import javax.xml.stream.XMLStreamException;
  28 import javax.xml.stream.XMLStreamWriter;
  29 import org.opendaylight.restconf.common.context.InstanceIdentifierContext;
  30 import org.opendaylight.restconf.nb.rfc8040.DepthParam;
  31 import org.opendaylight.restconf.nb.rfc8040.MediaTypes;
  32 import org.opendaylight.restconf.nb.rfc8040.jersey.providers.api.RestconfNormalizedNodeWriter;
  33 import org.opendaylight.restconf.nb.rfc8040.legacy.NormalizedNodePayload;
  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.codec.xml.XMLStreamNormalizedNodeStreamWriter;
  40 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  41 import org.opendaylight.yangtools.yang.model.api.ActionDefinition;
  42 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  43 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  44 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  45
  46 @Provider
  47 @Produces({ MediaTypes.APPLICATION_YANG_DATA_XML, MediaType.APPLICATION_XML, MediaType.TEXT_XML })
  48 public class XmlNormalizedNodeBodyWriter extends AbstractNormalizedNodeBodyWriter {
  49     private static final XMLOutputFactory XML_FACTORY;
  50
  51     static {
  52         XML_FACTORY = XMLOutputFactory.newFactory();
  53         XML_FACTORY.setProperty(XMLOutputFactory.IS_REPAIRING_NAMESPACES, true);
  54     }
  55
  56     @Override
  57     public void writeTo(final NormalizedNodePayload context,
  58                         final Class<?> type,
  59                         final Type genericType,
  60                         final Annotation[] annotations,
  61                         final MediaType mediaType,
  62                         final MultivaluedMap<String, Object> httpHeaders,
  63                         final OutputStream entityStream) throws IOException, WebApplicationException {
  64         final InstanceIdentifierContext<?> pathContext = context.getInstanceIdentifierContext();
  65         if (context.getData() == null) {
  66             return;
  67         }
  68         if (httpHeaders != null) {
  69             for (final Map.Entry<String, Object> entry : context.getNewHeaders().entrySet()) {
  70                 httpHeaders.add(entry.getKey(), entry.getValue());
  71             }
  72         }
  73
  74         XMLStreamWriter xmlWriter;
  75         try {
  76             xmlWriter = XML_FACTORY.createXMLStreamWriter(entityStream, StandardCharsets.UTF_8.name());
  77
  78             final var prettyPrint = context.getWriterParameters().prettyPrint();
  79             if (prettyPrint != null && prettyPrint.value()) {
  80                 xmlWriter = new IndentingXMLStreamWriter(xmlWriter);
  81             }
  82         } catch (final XMLStreamException | FactoryConfigurationError e) {
  83             throw new IllegalStateException(e);
  84         }
  85         final NormalizedNode data = context.getData();
  86         final SchemaPath schemaPath = pathContext.getSchemaNode().getPath();
  87
  88         writeNormalizedNode(xmlWriter, schemaPath, pathContext, data, context.getWriterParameters().depth(),
  89                 context.getWriterParameters().fields());
  90     }
  91
  92     private static void writeNormalizedNode(final XMLStreamWriter xmlWriter, final SchemaPath path,
  93             final InstanceIdentifierContext<?> pathContext, final NormalizedNode data, final DepthParam depth,
  94             final List<Set<QName>> fields) throws IOException {
  95         final RestconfNormalizedNodeWriter nnWriter;
  96         final EffectiveModelContext schemaCtx = pathContext.getSchemaContext();
  97
  98         if (pathContext.getSchemaNode() instanceof RpcDefinition) {
  99             /*
 100              *  RpcDefinition is not supported as initial codec in XMLStreamWriter,
 101              *  so we need to emit initial output declaration..
 102              */
 103             nnWriter = createNormalizedNodeWriter(
 104                     xmlWriter,
 105                     schemaCtx,
 106                     ((RpcDefinition) pathContext.getSchemaNode()).getOutput().getPath(),
 107                     depth,
 108                     fields);
 109             writeElements(xmlWriter, nnWriter, (ContainerNode) data);
 110         } else if (pathContext.getSchemaNode() instanceof ActionDefinition) {
 111             /*
 112              *  ActionDefinition is not supported as initial codec in XMLStreamWriter,
 113              *  so we need to emit initial output declaration..
 114              */
 115             nnWriter = createNormalizedNodeWriter(xmlWriter, schemaCtx,
 116                 ((ActionDefinition) pathContext.getSchemaNode()).getOutput().getPath(), depth, fields);
 117             writeElements(xmlWriter, nnWriter, (ContainerNode) data);
 118         } else {
 119             final boolean isRoot = SchemaPath.ROOT.equals(path);
 120             if (isRoot) {
 121                 nnWriter = createNormalizedNodeWriter(xmlWriter, schemaCtx, path, depth, fields);
 122             } else {
 123                 nnWriter = createNormalizedNodeWriter(xmlWriter, schemaCtx, path.getParent(), depth, fields);
 124             }
 125
 126             if (data instanceof MapEntryNode) {
 127                 // Restconf allows returning one list item. We need to wrap it
 128                 // in map node in order to serialize it properly
 129                 nnWriter.write(ImmutableNodes.mapNodeBuilder(data.getIdentifier().getNodeType())
 130                     .addChild((MapEntryNode) data)
 131                     .build());
 132             } else {
 133                 if (isRoot && data instanceof ContainerNode && ((ContainerNode) data).isEmpty()) {
 134                     writeEmptyDataNode(xmlWriter, data);
 135                 } else {
 136                     nnWriter.write(data);
 137                 }
 138             }
 139         }
 140
 141         nnWriter.flush();
 142     }
 143
 144     private static void writeEmptyDataNode(final XMLStreamWriter xmlWriter, final NormalizedNode data)
 145             throws IOException {
 146         final QName nodeType = data.getIdentifier().getNodeType();
 147         final String namespace = nodeType.getNamespace().toString();
 148         try {
 149             xmlWriter.writeStartElement(XMLConstants.DEFAULT_NS_PREFIX, nodeType.getLocalName(), namespace);
 150             xmlWriter.writeDefaultNamespace(namespace);
 151             xmlWriter.writeEndElement();
 152             xmlWriter.flush();
 153         } catch (XMLStreamException e) {
 154             throw new IOException("Failed to write elements", e);
 155         }
 156     }
 157
 158     private static RestconfNormalizedNodeWriter createNormalizedNodeWriter(final XMLStreamWriter xmlWriter,
 159             final EffectiveModelContext schemaContext, final SchemaPath schemaPath, final DepthParam depth,
 160             final List<Set<QName>> fields) {
 161         final NormalizedNodeStreamWriter xmlStreamWriter = XMLStreamNormalizedNodeStreamWriter
 162                 .create(xmlWriter, schemaContext, schemaPath);
 163         return ParameterAwareNormalizedNodeWriter.forStreamWriter(xmlStreamWriter, depth, fields);
 164     }
 165
 166     private static void writeElements(final XMLStreamWriter xmlWriter, final RestconfNormalizedNodeWriter nnWriter,
 167             final ContainerNode data) throws IOException {
 168         final QName name = data.getIdentifier().getNodeType();
 169         try {
 170             xmlWriter.writeStartElement(XMLConstants.DEFAULT_NS_PREFIX,
 171                     name.getLocalName(), name.getNamespace().toString());
 172             xmlWriter.writeDefaultNamespace(name.getNamespace().toString());
 173             for (final NormalizedNode child : data.body()) {
 174                 nnWriter.write(child);
 175             }
 176             nnWriter.flush();
 177             xmlWriter.writeEndElement();
 178             xmlWriter.flush();
 179         } catch (final XMLStreamException e) {
 180             throw new IOException("Failed to write elements", e);
 181         }
 182     }
 183 }