restconf/sal-rest-connector/src/main/java/org/opendaylight/netconf/sal/rest/impl/PATCHXmlBodyWriter.java

   1 /*
   2  * Copyright (c) 2015 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.netconf.sal.rest.impl;
  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 javax.ws.rs.Produces;
  18 import javax.ws.rs.WebApplicationException;
  19 import javax.ws.rs.core.MediaType;
  20 import javax.ws.rs.core.MultivaluedMap;
  21 import javax.ws.rs.ext.MessageBodyWriter;
  22 import javax.ws.rs.ext.Provider;
  23 import javax.xml.stream.FactoryConfigurationError;
  24 import javax.xml.stream.XMLOutputFactory;
  25 import javax.xml.stream.XMLStreamException;
  26 import javax.xml.stream.XMLStreamWriter;
  27 import org.opendaylight.netconf.sal.rest.api.Draft02;
  28 import org.opendaylight.netconf.sal.rest.api.RestconfService;
  29 import org.opendaylight.netconf.sal.restconf.impl.PATCHStatusContext;
  30 import org.opendaylight.netconf.sal.restconf.impl.PATCHStatusEntity;
  31 import org.opendaylight.netconf.sal.restconf.impl.RestconfError;
  32 import org.opendaylight.restconf.Draft18;
  33 import org.opendaylight.restconf.utils.RestconfConstants;
  34
  35 @Provider
  36 @Produces({Draft02.MediaTypes.PATCH_STATUS + RestconfService.XML,
  37         Draft18.MediaTypes.PATCH_STATUS + RestconfConstants.XML})
  38 public class PATCHXmlBodyWriter implements MessageBodyWriter<PATCHStatusContext> {
  39
  40     private static final XMLOutputFactory XML_FACTORY;
  41
  42     static {
  43         XML_FACTORY = XMLOutputFactory.newFactory();
  44         XML_FACTORY.setProperty(XMLOutputFactory.IS_REPAIRING_NAMESPACES, true);
  45     }
  46
  47     @Override
  48     public boolean isWriteable(final Class<?> type, final Type genericType,
  49                                final Annotation[] annotations, final MediaType mediaType) {
  50         return type.equals(PATCHStatusContext.class);
  51     }
  52
  53     @Override
  54     public long getSize(final PATCHStatusContext patchStatusContext, Class<?> type, final Type genericType,
  55                         final Annotation[] annotations, final MediaType mediaType) {
  56         return -1;
  57     }
  58
  59     @Override
  60     public void writeTo(final PATCHStatusContext patchStatusContext, final Class<?> type, final Type genericType,
  61                         final Annotation[] annotations, final MediaType mediaType,
  62                         final MultivaluedMap<String, Object> httpHeaders, final OutputStream entityStream)
  63             throws IOException, WebApplicationException {
  64
  65         try {
  66             final XMLStreamWriter xmlWriter = XML_FACTORY.createXMLStreamWriter(entityStream, StandardCharsets.UTF_8.name());
  67             writeDocument(xmlWriter, patchStatusContext);
  68         } catch (final XMLStreamException e) {
  69             throw new IllegalStateException(e);
  70         } catch (final FactoryConfigurationError e) {
  71             throw new IllegalStateException(e);
  72         }
  73     }
  74
  75     private static void writeDocument(final XMLStreamWriter writer, final PATCHStatusContext context)
  76             throws XMLStreamException, IOException {
  77         writer.writeStartElement("", "yang-patch-status", "urn:ietf:params:xml:ns:yang:ietf-yang-patch");
  78         writer.writeStartElement("patch-id");
  79         writer.writeCharacters(context.getPatchId());
  80         writer.writeEndElement();
  81
  82         if (context.isOk()) {
  83             writer.writeEmptyElement("ok");
  84         } else {
  85             if (context.getGlobalErrors() != null) {
  86                 reportErrors(context.getGlobalErrors(), writer);
  87             }
  88             writer.writeStartElement("edit-status");
  89             for (final PATCHStatusEntity patchStatusEntity : context.getEditCollection()) {
  90                 writer.writeStartElement("edit");
  91                 writer.writeStartElement("edit-id");
  92                 writer.writeCharacters(patchStatusEntity.getEditId());
  93                 writer.writeEndElement();
  94                 if (patchStatusEntity.getEditErrors() != null) {
  95                     reportErrors(patchStatusEntity.getEditErrors(), writer);
  96                 } else {
  97                     if (patchStatusEntity.isOk()) {
  98                         writer.writeEmptyElement("ok");
  99                     }
 100                 }
 101                 writer.writeEndElement();
 102             }
 103             writer.writeEndElement();
 104
 105         }
 106         writer.writeEndElement();
 107
 108         writer.flush();
 109     }
 110
 111     private static void reportErrors(final List<RestconfError> errors, final XMLStreamWriter writer)
 112             throws IOException, XMLStreamException {
 113         writer.writeStartElement("errors");
 114
 115         for (final RestconfError restconfError : errors) {
 116             writer.writeStartElement("error-type");
 117             writer.writeCharacters(restconfError.getErrorType().getErrorTypeTag());
 118             writer.writeEndElement();
 119
 120             writer.writeStartElement("error-tag");
 121             writer.writeCharacters(restconfError.getErrorTag().getTagValue());
 122             writer.writeEndElement();
 123
 124             // optional node
 125             if (restconfError.getErrorPath() != null) {
 126                 writer.writeStartElement("error-path");
 127                 writer.writeCharacters(restconfError.getErrorPath().toString());
 128                 writer.writeEndElement();
 129             }
 130
 131             // optional node
 132             if (restconfError.getErrorMessage() != null) {
 133                 writer.writeStartElement("error-message");
 134                 writer.writeCharacters(restconfError.getErrorMessage());
 135                 writer.writeEndElement();
 136             }
 137         }
 138
 139         writer.writeEndElement();
 140     }
 141 }