restconf/restconf-nb/src/main/java/org/opendaylight/restconf/server/mdsal/streams/dtcl/DataTreeCandidateFormatter.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.server.mdsal.streams.dtcl;
   9
  10 import java.io.IOException;
  11 import java.time.Instant;
  12 import java.util.List;
  13 import javax.xml.stream.XMLStreamException;
  14 import javax.xml.transform.dom.DOMResult;
  15 import javax.xml.xpath.XPathExpressionException;
  16 import org.opendaylight.restconf.server.spi.EventFormatter;
  17 import org.opendaylight.restconf.server.spi.TextParameters;
  18 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.remote.rev140114.DataChangedNotification;
  19 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.remote.rev140114.data.changed.notification.DataChangeEvent;
  20 import org.opendaylight.yangtools.yang.data.codec.xml.XMLStreamNormalizedNodeStreamWriter;
  21 import org.opendaylight.yangtools.yang.data.tree.api.DataTreeCandidate;
  22 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  23 import org.w3c.dom.Document;
  24
  25 /**
  26  * Base formatter for DataTreeCandidates which only handles exporting to a document for filter checking purpose.
  27  */
  28 abstract class DataTreeCandidateFormatter extends EventFormatter<List<DataTreeCandidate>> {
  29     private static final String DATA_CHANGE_EVENT_ELEMENT = DataChangeEvent.QNAME.getLocalName();
  30     static final String DATA_CHANGED_NOTIFICATION_ELEMENT = DataChangedNotification.QNAME.getLocalName();
  31     static final String DATA_CHANGED_NOTIFICATION_NS = DataChangedNotification.QNAME.getNamespace().toString();
  32
  33     DataTreeCandidateFormatter(final TextParameters textParams) {
  34         super(textParams);
  35     }
  36
  37     DataTreeCandidateFormatter(final TextParameters textParams, final String xpathFilter)
  38             throws XPathExpressionException {
  39         super(textParams, xpathFilter);
  40     }
  41
  42     @Override
  43     protected final void fillDocument(final Document doc, final EffectiveModelContext schemaContext,
  44             final List<DataTreeCandidate> input) throws IOException {
  45         final var notificationElement = createNotificationElement(doc, Instant.now());
  46         final var notificationEventElement = doc.createElementNS(DATA_CHANGED_NOTIFICATION_NS,
  47             DATA_CHANGED_NOTIFICATION_ELEMENT);
  48
  49         for (var candidate : input) {
  50             final var dataChangedElement = doc.createElement(DATA_CHANGE_EVENT_ELEMENT);
  51             try {
  52                 final var dataElement = doc.createElement("data");
  53                 final var dataAfter = candidate.getRootNode().dataAfter();
  54                 if (dataAfter != null) {
  55                     try (var writer = XMLStreamNormalizedNodeStreamWriter.create(
  56                         XML_OUTPUT_FACTORY.createXMLStreamWriter(new DOMResult(dataElement)), schemaContext,
  57                         candidate.getRootPath())) {
  58                         writeBody(writer, dataAfter);
  59                     }
  60                 }
  61                 dataChangedElement.appendChild(dataElement);
  62             } catch (XMLStreamException e) {
  63                 throw new IOException("Failed to write notification content", e);
  64             }
  65             notificationElement.appendChild(notificationEventElement);
  66         }
  67         doc.appendChild(notificationElement);
  68     }
  69 }