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