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.MediaTypes;
  31 import org.opendaylight.restconf.nb.rfc8040.jersey.providers.api.RestconfNormalizedNodeWriter;
  32 import org.opendaylight.restconf.nb.rfc8040.legacy.NormalizedNodePayload;
  33 import org.opendaylight.yangtools.yang.common.QName;
  34 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  35 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  36 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  37 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  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             if (context.getWriterParameters().isPrettyPrint()) {
  77                 xmlWriter = new IndentingXMLStreamWriter(xmlWriter);
  78             }
  79         } catch (final XMLStreamException | FactoryConfigurationError e) {
  80             throw new IllegalStateException(e);
  81         }
  82         final NormalizedNode data = context.getData();
  83         final SchemaPath schemaPath = pathContext.getSchemaNode().getPath();
  84
  85         writeNormalizedNode(xmlWriter, schemaPath, pathContext, data, context.getWriterParameters().getDepth(),
  86                 context.getWriterParameters().getFields());
  87     }
  88
  89     private static void writeNormalizedNode(final XMLStreamWriter xmlWriter, final SchemaPath path,
  90             final InstanceIdentifierContext<?> pathContext, final NormalizedNode data, final Integer depth,
  91             final List<Set<QName>> fields) throws IOException {
  92         final RestconfNormalizedNodeWriter nnWriter;
  93         final EffectiveModelContext schemaCtx = pathContext.getSchemaContext();
  94
  95         if (pathContext.getSchemaNode() instanceof RpcDefinition) {
  96             /*
  97              *  RpcDefinition is not supported as initial codec in XMLStreamWriter,
  98              *  so we need to emit initial output declaration..
  99              */
 100             nnWriter = createNormalizedNodeWriter(
 101                     xmlWriter,
 102                     schemaCtx,
 103                     ((RpcDefinition) pathContext.getSchemaNode()).getOutput().getPath(),
 104                     depth,
 105                     fields);
 106             writeElements(xmlWriter, nnWriter, (ContainerNode) data);
 107         } else if (pathContext.getSchemaNode() instanceof ActionDefinition) {
 108             /*
 109              *  ActionDefinition is not supported as initial codec in XMLStreamWriter,
 110              *  so we need to emit initial output declaration..
 111              */
 112             nnWriter = createNormalizedNodeWriter(xmlWriter, schemaCtx,
 113                 ((ActionDefinition) pathContext.getSchemaNode()).getOutput().getPath(), depth, fields);
 114             writeElements(xmlWriter, nnWriter, (ContainerNode) data);
 115         } else {
 116             if (SchemaPath.ROOT.equals(path)) {
 117                 nnWriter = createNormalizedNodeWriter(xmlWriter, schemaCtx, path, depth, fields);
 118             } else {
 119                 nnWriter = createNormalizedNodeWriter(xmlWriter, schemaCtx, path.getParent(), depth, fields);
 120             }
 121
 122             if (data instanceof MapEntryNode) {
 123                 // Restconf allows returning one list item. We need to wrap it
 124                 // in map node in order to serialize it properly
 125                 nnWriter.write(ImmutableNodes.mapNodeBuilder(data.getIdentifier().getNodeType())
 126                     .addChild((MapEntryNode) data)
 127                     .build());
 128             } else {
 129                 nnWriter.write(data);
 130             }
 131         }
 132
 133         nnWriter.flush();
 134     }
 135
 136     private static RestconfNormalizedNodeWriter createNormalizedNodeWriter(final XMLStreamWriter xmlWriter,
 137             final EffectiveModelContext schemaContext, final SchemaPath schemaPath, final Integer depth,
 138             final List<Set<QName>> fields) {
 139         final NormalizedNodeStreamWriter xmlStreamWriter = XMLStreamNormalizedNodeStreamWriter
 140                 .create(xmlWriter, schemaContext, schemaPath);
 141         return ParameterAwareNormalizedNodeWriter.forStreamWriter(xmlStreamWriter, depth, fields);
 142     }
 143
 144     private static void writeElements(final XMLStreamWriter xmlWriter, final RestconfNormalizedNodeWriter nnWriter,
 145             final ContainerNode data) throws IOException {
 146         final QName name = data.getIdentifier().getNodeType();
 147         try {
 148             xmlWriter.writeStartElement(XMLConstants.DEFAULT_NS_PREFIX,
 149                     name.getLocalName(), name.getNamespace().toString());
 150             xmlWriter.writeDefaultNamespace(name.getNamespace().toString());
 151             for (final NormalizedNode child : data.body()) {
 152                 nnWriter.write(child);
 153             }
 154             nnWriter.flush();
 155             xmlWriter.writeEndElement();
 156             xmlWriter.flush();
 157         } catch (final XMLStreamException e) {
 158             throw new IOException("Failed to write elements", e);
 159         }
 160     }
 161 }