restconf/restconf-nb/src/main/java/org/opendaylight/restconf/nb/rfc8040/streams/listeners/NotificationFormatter.java

   1 /*
   2  * Copyright (c) 2020 PANTHEON.tech, s.r.o. 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.restconf.nb.rfc8040.streams.listeners;
   9
  10 import java.io.IOException;
  11 import java.time.Instant;
  12 import javax.xml.stream.XMLOutputFactory;
  13 import javax.xml.stream.XMLStreamException;
  14 import javax.xml.stream.XMLStreamWriter;
  15 import javax.xml.transform.dom.DOMResult;
  16 import javax.xml.xpath.XPathExpressionException;
  17 import org.opendaylight.mdsal.dom.api.DOMEvent;
  18 import org.opendaylight.mdsal.dom.api.DOMNotification;
  19 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.remote.rev140114.DataChangedNotification;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.remote.rev140114.data.changed.notification.DataChangeEvent;
  21 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  22 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  23 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeWriter;
  24 import org.opendaylight.yangtools.yang.data.codec.xml.XMLStreamNormalizedNodeStreamWriter;
  25 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  26 import org.w3c.dom.Document;
  27 import org.w3c.dom.Element;
  28
  29 abstract class NotificationFormatter extends EventFormatter<DOMNotification> {
  30     static final String NOTIFICATION_NAMESPACE = "urn:ietf:params:xml:ns:netconf:notification:1.0";
  31     static final String NOTIFICATION_ELEMENT = "notification";
  32
  33     static final String SAL_REMOTE_NAMESPACE = DataChangedNotification.QNAME.getNamespace().toString();
  34     static final String DATA_CHANGED_NOTIFICATION_ELEMENT = DataChangedNotification.QNAME.getLocalName();
  35     static final String DATA_CHANGE_EVENT_ELEMENT = DataChangeEvent.QNAME.getLocalName();
  36
  37     static final XMLOutputFactory XML_OUTPUT_FACTORY;
  38
  39     static {
  40         XML_OUTPUT_FACTORY = XMLOutputFactory.newFactory();
  41         XML_OUTPUT_FACTORY.setProperty(XMLOutputFactory.IS_REPAIRING_NAMESPACES, true);
  42     }
  43
  44     NotificationFormatter() {
  45
  46     }
  47
  48     NotificationFormatter(final String xpathFilter) throws XPathExpressionException {
  49         super(xpathFilter);
  50     }
  51
  52     @Override
  53     final void fillDocument(final Document doc, final EffectiveModelContext schemaContext, final DOMNotification input)
  54             throws IOException {
  55         final Element notificationElement = doc.createElementNS(NOTIFICATION_NAMESPACE, NOTIFICATION_ELEMENT);
  56         final Element eventTimeElement = doc.createElement("eventTime");
  57         final Instant now = input instanceof DOMEvent domEvent ? domEvent.getEventInstant() : Instant.now();
  58         eventTimeElement.setTextContent(toRFC3339(now));
  59         notificationElement.appendChild(eventTimeElement);
  60
  61         final Element notificationEventElement = doc.createElementNS(SAL_REMOTE_NAMESPACE,
  62             "create-notification-stream");
  63         final Element dataElement = doc.createElement("notification");
  64         final DOMResult result = new DOMResult(dataElement);
  65         try {
  66             final XMLStreamWriter writer = XML_OUTPUT_FACTORY.createXMLStreamWriter(result);
  67             try {
  68                 writeNotificationBody(XMLStreamNormalizedNodeStreamWriter.create(writer, schemaContext,
  69                         input.getType()), input.getBody());
  70             } finally {
  71                 writer.close();
  72             }
  73         } catch (final XMLStreamException e) {
  74             throw new IOException("Failed to write notification content", e);
  75         }
  76         notificationElement.appendChild(notificationEventElement);
  77         doc.appendChild(notificationElement);
  78     }
  79
  80     static void writeNotificationBody(final NormalizedNodeStreamWriter writer, final ContainerNode body)
  81             throws IOException {
  82         try (NormalizedNodeWriter nodeWriter = NormalizedNodeWriter.forStreamWriter(writer)) {
  83             nodeWriter.write(body);
  84         }
  85     }
  86 }