opendaylight/md-sal/sal-rest-connector/src/main/java/org/opendaylight/controller/sal/rest/impl/NormalizedNodeXmlBodyWriter.java

   1 /*
   2  * Copyright (c) 2014 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.controller.sal.rest.impl;
   9
  10 import com.google.common.base.Throwables;
  11 import java.io.IOException;
  12 import java.io.OutputStream;
  13 import java.lang.annotation.Annotation;
  14 import java.lang.reflect.Type;
  15 import javax.ws.rs.Produces;
  16 import javax.ws.rs.WebApplicationException;
  17 import javax.ws.rs.core.MediaType;
  18 import javax.ws.rs.core.MultivaluedMap;
  19 import javax.ws.rs.ext.MessageBodyWriter;
  20 import javax.ws.rs.ext.Provider;
  21 import javax.xml.XMLConstants;
  22 import javax.xml.stream.FactoryConfigurationError;
  23 import javax.xml.stream.XMLOutputFactory;
  24 import javax.xml.stream.XMLStreamException;
  25 import javax.xml.stream.XMLStreamWriter;
  26 import org.opendaylight.controller.sal.rest.api.Draft02;
  27 import org.opendaylight.controller.sal.rest.api.RestconfService;
  28 import org.opendaylight.controller.sal.restconf.impl.InstanceIdentifierContext;
  29 import org.opendaylight.controller.sal.restconf.impl.NormalizedNodeContext;
  30 import org.opendaylight.yangtools.yang.common.QName;
  31 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  32 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  33 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  34 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  35 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeWriter;
  36 import org.opendaylight.yangtools.yang.data.impl.codec.xml.XMLStreamNormalizedNodeStreamWriter;
  37 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  38 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  39 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  40 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  41
  42 @Provider
  43 @Produces({ Draft02.MediaTypes.API + RestconfService.XML, Draft02.MediaTypes.DATA + RestconfService.XML,
  44         Draft02.MediaTypes.OPERATION + RestconfService.XML, MediaType.APPLICATION_XML, MediaType.TEXT_XML })
  45 public class NormalizedNodeXmlBodyWriter implements MessageBodyWriter<NormalizedNodeContext> {
  46
  47     private static final XMLOutputFactory XML_FACTORY;
  48
  49     static {
  50         XML_FACTORY = XMLOutputFactory.newFactory();
  51         XML_FACTORY.setProperty(XMLOutputFactory.IS_REPAIRING_NAMESPACES, true);
  52     }
  53
  54     @Override
  55     public boolean isWriteable(final Class<?> type, final Type genericType, final Annotation[] annotations,
  56             final MediaType mediaType) {
  57         return type.equals(NormalizedNodeContext.class);
  58     }
  59
  60     @Override
  61     public long getSize(final NormalizedNodeContext t, final Class<?> type, final Type genericType,
  62             final Annotation[] annotations, final MediaType mediaType) {
  63         return -1;
  64     }
  65
  66     @Override
  67     public void writeTo(final NormalizedNodeContext t, final Class<?> type, final Type genericType,
  68             final Annotation[] annotations, final MediaType mediaType,
  69             final MultivaluedMap<String, Object> httpHeaders, final OutputStream entityStream) throws IOException,
  70             WebApplicationException {
  71         final InstanceIdentifierContext<?> pathContext = t.getInstanceIdentifierContext();
  72         if (t.getData() == null) {
  73             return;
  74         }
  75
  76         XMLStreamWriter xmlWriter;
  77         try {
  78             xmlWriter = XML_FACTORY.createXMLStreamWriter(entityStream);
  79         } catch (final XMLStreamException e) {
  80             throw new IllegalStateException(e);
  81         } catch (final FactoryConfigurationError e) {
  82             throw new IllegalStateException(e);
  83         }
  84         NormalizedNode<?, ?> data = t.getData();
  85         SchemaPath schemaPath = pathContext.getSchemaNode().getPath();
  86
  87
  88
  89         writeNormalizedNode(xmlWriter,schemaPath,pathContext,data);
  90     }
  91
  92     private void writeNormalizedNode(XMLStreamWriter xmlWriter, SchemaPath schemaPath,InstanceIdentifierContext<?> pathContext, NormalizedNode<?, ?> data) throws IOException {
  93         final NormalizedNodeWriter nnWriter;
  94         final SchemaContext schemaCtx = pathContext.getSchemaContext();
  95         if (SchemaPath.ROOT.equals(schemaPath)) {
  96             nnWriter = createNormalizedNodeWriter(xmlWriter, schemaCtx, schemaPath);
  97             writeElements(xmlWriter, nnWriter, (ContainerNode) data);
  98         }  else if (pathContext.getSchemaNode() instanceof RpcDefinition) {
  99             nnWriter = createNormalizedNodeWriter(xmlWriter, schemaCtx, ((RpcDefinition) pathContext.getSchemaNode()).getOutput().getPath());
 100             writeElements(xmlWriter, nnWriter, (ContainerNode) data);
 101         } else {
 102             nnWriter = createNormalizedNodeWriter(xmlWriter, schemaCtx, schemaPath.getParent());
 103             if (data instanceof MapEntryNode) {
 104                 // Restconf allows returning one list item. We need to wrap it
 105                 // in map node in order to serialize it properly
 106                 data = ImmutableNodes.mapNodeBuilder(data.getNodeType()).addChild((MapEntryNode) data).build();
 107             }
 108             nnWriter.write(data);
 109         }
 110         nnWriter.flush();
 111     }
 112
 113     private NormalizedNodeWriter createNormalizedNodeWriter(XMLStreamWriter xmlWriter,
 114             SchemaContext schemaContext, SchemaPath schemaPath) {
 115         NormalizedNodeStreamWriter xmlStreamWriter = XMLStreamNormalizedNodeStreamWriter.create(xmlWriter, schemaContext, schemaPath);
 116         return NormalizedNodeWriter.forStreamWriter(xmlStreamWriter);
 117     }
 118
 119     private void writeElements(final XMLStreamWriter xmlWriter, final NormalizedNodeWriter nnWriter, final ContainerNode data)
 120             throws IOException {
 121         try {
 122             final QName name = data.getNodeType();
 123             xmlWriter.writeStartElement(XMLConstants.DEFAULT_NS_PREFIX, name.getLocalName(), name.getNamespace().toString());
 124             xmlWriter.writeDefaultNamespace(name.getNamespace().toString());
 125             for(NormalizedNode<?,?> child : data.getValue()) {
 126                 nnWriter.write(child);
 127             }
 128             nnWriter.flush();
 129             xmlWriter.writeEndElement();
 130             xmlWriter.flush();
 131         } catch (final XMLStreamException e) {
 132             Throwables.propagate(e);
 133         }
 134     }
 135 }