restconf/sal-rest-connector/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.netconf.sal.restconf.impl.InstanceIdentifierContext;
  33 import org.opendaylight.netconf.sal.restconf.impl.NormalizedNodeContext;
  34 import org.opendaylight.restconf.Rfc8040;
  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.impl.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 @Provider
  48 @Produces({ Rfc8040.MediaTypes.DATA + RestconfConstants.XML, MediaType.APPLICATION_XML, MediaType.TEXT_XML })
  49 public class NormalizedNodeXmlBodyWriter implements MessageBodyWriter<NormalizedNodeContext> {
  50
  51     private static final XMLOutputFactory XML_FACTORY;
  52
  53     static {
  54         XML_FACTORY = XMLOutputFactory.newFactory();
  55         XML_FACTORY.setProperty(XMLOutputFactory.IS_REPAIRING_NAMESPACES, true);
  56     }
  57
  58     @Override
  59     public boolean isWriteable(final Class<?> type,
  60                                final Type genericType,
  61                                final Annotation[] annotations,
  62                                final MediaType mediaType) {
  63         return type.equals(NormalizedNodeContext.class);
  64     }
  65
  66     @Override
  67     public long getSize(final NormalizedNodeContext t,
  68                         final Class<?> type,
  69                         final Type genericType,
  70                         final Annotation[] annotations,
  71                         final MediaType mediaType) {
  72         return -1;
  73     }
  74
  75     @Override
  76     public void writeTo(final NormalizedNodeContext t,
  77                         final Class<?> type,
  78                         final Type genericType,
  79                         final Annotation[] annotations,
  80                         final MediaType mediaType,
  81                         final MultivaluedMap<String, Object> httpHeaders,
  82                         final OutputStream entityStream) throws IOException, WebApplicationException {
  83         final InstanceIdentifierContext<?> pathContext = t.getInstanceIdentifierContext();
  84         if (t.getData() == null) {
  85             return;
  86         }
  87
  88         XMLStreamWriter xmlWriter;
  89         try {
  90             xmlWriter = XML_FACTORY.createXMLStreamWriter(entityStream, StandardCharsets.UTF_8.name());
  91             if (t.getWriterParameters().isPrettyPrint()) {
  92                 xmlWriter = new IndentingXMLStreamWriter(xmlWriter);
  93             }
  94         } catch (final XMLStreamException | FactoryConfigurationError e) {
  95             throw new IllegalStateException(e);
  96         }
  97         final NormalizedNode<?, ?> data = t.getData();
  98         final SchemaPath schemaPath = pathContext.getSchemaNode().getPath();
  99
 100         writeNormalizedNode(xmlWriter, schemaPath, pathContext, data, t.getWriterParameters().getDepth(),
 101                 t.getWriterParameters().getFields());
 102     }
 103
 104     private void writeNormalizedNode(final XMLStreamWriter xmlWriter,
 105                                      final SchemaPath path,
 106                                      final InstanceIdentifierContext<?> pathContext,
 107                                      final NormalizedNode<?, ?> data,
 108                                      final Integer depth,
 109                                      final List<Set<QName>> fields) throws IOException {
 110         final RestconfNormalizedNodeWriter nnWriter;
 111         final SchemaContext schemaCtx = pathContext.getSchemaContext();
 112
 113         if (pathContext.getSchemaNode() instanceof RpcDefinition) {
 114             /*
 115              *  RpcDefinition is not supported as initial codec in XMLStreamWriter,
 116              *  so we need to emit initial output declaration..
 117              */
 118             nnWriter = createNormalizedNodeWriter(
 119                     xmlWriter,
 120                     schemaCtx,
 121                     ((RpcDefinition) pathContext.getSchemaNode()).getOutput().getPath(),
 122                     depth,
 123                     fields);
 124             writeElements(xmlWriter, nnWriter, (ContainerNode) data);
 125         } else {
 126             if (SchemaPath.ROOT.equals(path)) {
 127                 nnWriter = createNormalizedNodeWriter(xmlWriter, schemaCtx, path, depth, fields);
 128             } else {
 129                 nnWriter = createNormalizedNodeWriter(xmlWriter, schemaCtx, path.getParent(), depth, fields);
 130             }
 131
 132             if (data instanceof MapEntryNode) {
 133                 // Restconf allows returning one list item. We need to wrap it
 134                 // in map node in order to serialize it properly
 135                 nnWriter.write(ImmutableNodes.mapNodeBuilder(data.getNodeType()).addChild((MapEntryNode) data).build());
 136             } else {
 137                 nnWriter.write(data);
 138             }
 139         }
 140
 141         nnWriter.flush();
 142     }
 143
 144     private RestconfNormalizedNodeWriter createNormalizedNodeWriter(final XMLStreamWriter xmlWriter,
 145                                                                     final SchemaContext schemaContext,
 146                                                                     final SchemaPath schemaPath,
 147                                                                     final Integer depth,
 148                                                                     final List<Set<QName>> fields) {
 149         final NormalizedNodeStreamWriter xmlStreamWriter = XMLStreamNormalizedNodeStreamWriter
 150                 .create(xmlWriter, schemaContext, schemaPath);
 151         return ParameterAwareNormalizedNodeWriter.forStreamWriter(xmlStreamWriter, depth, fields);
 152     }
 153
 154     private void writeElements(final XMLStreamWriter xmlWriter,
 155                                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 }