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.SAL_REMOTE_NAMESPACE;
  13 import static org.opendaylight.restconf.nb.rfc8040.streams.listeners.NotificationFormatter.XML_OUTPUT_FACTORY;
  14
  15 import java.io.IOException;
  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 abstract class DataTreeCandidateFormatter extends EventFormatter<Collection<DataTreeCandidate>> {
  36     DataTreeCandidateFormatter() {
  37
  38     }
  39
  40     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 = NotificationFormatter.createNotificationElement(doc);
  48         final Element notificationEventElement = doc.createElementNS(
  49             SAL_REMOTE_NAMESPACE, DATA_CHANGED_NOTIFICATION_ELEMENT);
  50
  51         for (DataTreeCandidate candidate : input) {
  52             final Element dataChangedElement = doc.createElement(DATA_CHANGE_EVENT_ELEMENT);
  53             try {
  54                 final Element dataElement = doc.createElement("data");
  55                 final DOMResult domResult = new DOMResult(dataElement);
  56                 final XMLStreamWriter writer = XML_OUTPUT_FACTORY.createXMLStreamWriter(domResult);
  57
  58                 final SchemaPath path = SchemaPath.create(candidate.getRootPath().getPathArguments().stream()
  59                         .filter(p -> !(p instanceof YangInstanceIdentifier.NodeIdentifierWithPredicates))
  60                         .map(YangInstanceIdentifier.PathArgument::getNodeType).collect(Collectors.toList()), true);
  61
  62                 writeCandidate(XMLStreamNormalizedNodeStreamWriter.create(writer, schemaContext,
  63                         path), candidate);
  64
  65                 dataChangedElement.appendChild(dataElement);
  66             } catch (final XMLStreamException e) {
  67                 throw new IOException("Failed to write notification content", e);
  68             }
  69             notificationElement.appendChild(notificationEventElement);
  70         }
  71         doc.appendChild(notificationElement);
  72     }
  73
  74     static void writeCandidate(final NormalizedNodeStreamWriter writer, final DataTreeCandidate candidate)
  75             throws IOException {
  76         if (candidate.getRootNode().getDataAfter().isPresent()) {
  77             try (NormalizedNodeWriter nodeWriter = NormalizedNodeWriter.forStreamWriter(writer)) {
  78                 nodeWriter.write(candidate.getRootNode().getDataAfter().get());
  79             }
  80         }
  81     }
  82 }