2 * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
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
9 package org.opendaylight.netconf.sal.rest.impl;
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.util.List;
16 import javax.ws.rs.Produces;
17 import javax.ws.rs.WebApplicationException;
18 import javax.ws.rs.core.MediaType;
19 import javax.ws.rs.core.MultivaluedMap;
20 import javax.ws.rs.ext.MessageBodyWriter;
21 import javax.ws.rs.ext.Provider;
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.netconf.sal.rest.api.Draft02;
27 import org.opendaylight.netconf.sal.rest.api.RestconfService;
28 import org.opendaylight.netconf.sal.restconf.impl.PATCHStatusContext;
29 import org.opendaylight.netconf.sal.restconf.impl.PATCHStatusEntity;
30 import org.opendaylight.netconf.sal.restconf.impl.RestconfError;
31 import org.opendaylight.restconf.Draft17;
32 import org.opendaylight.restconf.utils.RestconfConstants;
35 @Produces({Draft02.MediaTypes.PATCH_STATUS + RestconfService.XML,
36 Draft17.MediaTypes.PATCH_STATUS + RestconfConstants.XML})
37 public class PATCHXmlBodyWriter implements MessageBodyWriter<PATCHStatusContext> {
39 private static final XMLOutputFactory XML_FACTORY;
42 XML_FACTORY = XMLOutputFactory.newFactory();
43 XML_FACTORY.setProperty(XMLOutputFactory.IS_REPAIRING_NAMESPACES, true);
47 public boolean isWriteable(final Class<?> type, final Type genericType,
48 final Annotation[] annotations, final MediaType mediaType) {
49 return type.equals(PATCHStatusContext.class);
53 public long getSize(final PATCHStatusContext patchStatusContext, Class<?> type, final Type genericType,
54 final Annotation[] annotations, final MediaType mediaType) {
59 public void writeTo(final PATCHStatusContext patchStatusContext, final Class<?> type, final Type genericType,
60 final Annotation[] annotations, final MediaType mediaType,
61 final MultivaluedMap<String, Object> httpHeaders, final OutputStream entityStream)
62 throws IOException, WebApplicationException {
65 final XMLStreamWriter xmlWriter = XML_FACTORY.createXMLStreamWriter(entityStream);
66 writeDocument(xmlWriter, patchStatusContext);
67 } catch (final XMLStreamException e) {
68 throw new IllegalStateException(e);
69 } catch (final FactoryConfigurationError e) {
70 throw new IllegalStateException(e);
74 private static void writeDocument(final XMLStreamWriter writer, final PATCHStatusContext context)
75 throws XMLStreamException, IOException {
76 writer.writeStartElement("", "yang-patch-status", "urn:ietf:params:xml:ns:yang:ietf-yang-patch");
77 writer.writeStartElement("patch-id");
78 writer.writeCharacters(context.getPatchId());
79 writer.writeEndElement();
82 writer.writeEmptyElement("ok");
84 if (context.getGlobalErrors() != null) {
85 reportErrors(context.getGlobalErrors(), writer);
87 writer.writeStartElement("edit-status");
88 for (final PATCHStatusEntity patchStatusEntity : context.getEditCollection()) {
89 writer.writeStartElement("edit");
90 writer.writeStartElement("edit-id");
91 writer.writeCharacters(patchStatusEntity.getEditId());
92 writer.writeEndElement();
93 if (patchStatusEntity.getEditErrors() != null) {
94 reportErrors(patchStatusEntity.getEditErrors(), writer);
96 if (patchStatusEntity.isOk()) {
97 writer.writeEmptyElement("ok");
100 writer.writeEndElement();
102 writer.writeEndElement();
105 writer.writeEndElement();
110 private static void reportErrors(final List<RestconfError> errors, final XMLStreamWriter writer)
111 throws IOException, XMLStreamException {
112 writer.writeStartElement("errors");
114 for (final RestconfError restconfError : errors) {
115 writer.writeStartElement("error-type");
116 writer.writeCharacters(restconfError.getErrorType().getErrorTypeTag());
117 writer.writeEndElement();
119 writer.writeStartElement("error-tag");
120 writer.writeCharacters(restconfError.getErrorTag().getTagValue());
121 writer.writeEndElement();
124 if (restconfError.getErrorPath() != null) {
125 writer.writeStartElement("error-path");
126 writer.writeCharacters(restconfError.getErrorPath().toString());
127 writer.writeEndElement();
131 if (restconfError.getErrorMessage() != null) {
132 writer.writeStartElement("error-message");
133 writer.writeCharacters(restconfError.getErrorMessage());
134 writer.writeEndElement();
138 writer.writeEndElement();