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