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