restconf/restconf-nb/src/main/java/org/opendaylight/restconf/nb/rfc8040/streams/listeners/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.nb.rfc8040.streams.listeners;
   9
  10 import static org.opendaylight.restconf.nb.rfc8040.streams.listeners.NotificationFormatter.XML_OUTPUT_FACTORY;
  11 import static org.opendaylight.restconf.nb.rfc8040.streams.listeners.XMLNotificationFormatter.DATA_CHANGE_EVENT_ELEMENT;
  12
  13 import java.io.IOException;
  14 import java.time.Instant;
  15 import java.util.Collection;
  16 import java.util.stream.Collectors;
  17 import javax.xml.stream.XMLStreamException;
  18 import javax.xml.stream.XMLStreamWriter;
  19 import javax.xml.transform.dom.DOMResult;
  20 import javax.xml.xpath.XPathExpressionException;
  21 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  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.data.tree.api.DataTreeCandidate;
  26 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  27 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  28 import org.w3c.dom.Document;
  29 import org.w3c.dom.Element;
  30
  31 /**
  32  * Base formatter for DataTreeCandidates which only handles exporting to a document for filter checking purpose.
  33  */
  34 abstract class DataTreeCandidateFormatter extends EventFormatter<Collection<DataTreeCandidate>> {
  35     DataTreeCandidateFormatter() {
  36
  37     }
  38
  39     DataTreeCandidateFormatter(final String xpathFilter) throws XPathExpressionException {
  40         super(xpathFilter);
  41     }
  42
  43     @Override
  44     final void fillDocument(final Document doc, final EffectiveModelContext schemaContext,
  45             final Collection<DataTreeCandidate> input) throws IOException {
  46         final Element notificationElement = doc.createElementNS("urn:ietf:params:xml:ns:netconf:notification:1.0",
  47                 "notification");
  48         final Element eventTimeElement = doc.createElement("eventTime");
  49         eventTimeElement.setTextContent(toRFC3339(Instant.now()));
  50         notificationElement.appendChild(eventTimeElement);
  51
  52         final Element notificationEventElement = doc.createElementNS(
  53                 "urn:opendaylight:params:xml:ns:yang:controller:md:sal:remote", "data-changed-notification");
  54
  55         for (DataTreeCandidate candidate : input) {
  56             final Element dataChangedElement = doc.createElement(DATA_CHANGE_EVENT_ELEMENT);
  57             try {
  58                 final Element dataElement = doc.createElement("data");
  59                 final DOMResult domResult = new DOMResult(dataElement);
  60                 final XMLStreamWriter writer = XML_OUTPUT_FACTORY.createXMLStreamWriter(domResult);
  61
  62                 final SchemaPath path = SchemaPath.create(candidate.getRootPath().getPathArguments().stream()
  63                         .filter(p -> !(p instanceof YangInstanceIdentifier.NodeIdentifierWithPredicates))
  64                         .map(YangInstanceIdentifier.PathArgument::getNodeType).collect(Collectors.toList()), true);
  65
  66                 writeCandidate(XMLStreamNormalizedNodeStreamWriter.create(writer, schemaContext,
  67                         path), candidate);
  68
  69                 dataChangedElement.appendChild(dataElement);
  70             } catch (final XMLStreamException e) {
  71                 throw new IOException("Failed to write notification content", e);
  72             }
  73             notificationElement.appendChild(notificationEventElement);
  74         }
  75         doc.appendChild(notificationElement);
  76     }
  77
  78     static void writeCandidate(final NormalizedNodeStreamWriter writer, final DataTreeCandidate candidate)
  79             throws IOException {
  80         if (candidate.getRootNode().getDataAfter().isPresent()) {
  81             try (NormalizedNodeWriter nodeWriter = NormalizedNodeWriter.forStreamWriter(writer)) {
  82                 nodeWriter.write(candidate.getRootNode().getDataAfter().get());
  83             }
  84         }
  85     }
  86 }