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