2 * Copyright (c) 2020 PANTHEON.tech, s.r.o. and others. All rights reserved.
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
8 package org.opendaylight.restconf.common.formatters;
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;
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.api.schema.tree.DataTreeCandidate;
26 import org.opendaylight.yangtools.yang.data.codec.xml.XMLStreamNormalizedNodeStreamWriter;
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;
33 * Base formatter for DataTreeCandidates which only handles exporting to a document for filter checking purpose.
36 public abstract class DataTreeCandidateFormatter extends EventFormatter<Collection<DataTreeCandidate>> {
38 protected DataTreeCandidateFormatter() {
41 public DataTreeCandidateFormatter(String xpathFilter) throws XPathExpressionException {
46 final void fillDocument(Document doc, EffectiveModelContext schemaContext, Collection<DataTreeCandidate> input)
48 final Element notificationElement = doc.createElementNS("urn:ietf:params:xml:ns:netconf:notification:1.0",
50 final Element eventTimeElement = doc.createElement("eventTime");
51 eventTimeElement.setTextContent(toRFC3339(Instant.now()));
52 notificationElement.appendChild(eventTimeElement);
54 final Element notificationEventElement = doc.createElementNS(
55 "urn:opendaylight:params:xml:ns:yang:controller:md:sal:remote", "data-changed-notification");
57 for (DataTreeCandidate candidate : input) {
58 final Element dataChangedElement = doc.createElement(DATA_CHANGE_EVENT_ELEMENT);
60 final Element dataElement = doc.createElement("data");
61 final DOMResult domResult = new DOMResult(dataElement);
62 final XMLStreamWriter writer = XML_OUTPUT_FACTORY.createXMLStreamWriter(domResult);
64 final SchemaPath path = SchemaPath.create(candidate.getRootPath().getPathArguments().stream()
65 .filter(p -> !(p instanceof YangInstanceIdentifier.NodeIdentifierWithPredicates))
66 .map(YangInstanceIdentifier.PathArgument::getNodeType).collect(Collectors.toList()), true);
68 writeCandidate(XMLStreamNormalizedNodeStreamWriter.create(writer, schemaContext,
71 dataChangedElement.appendChild(dataElement);
72 } catch (final XMLStreamException e) {
73 throw new IOException("Failed to write notification content", e);
75 notificationElement.appendChild(notificationEventElement);
77 doc.appendChild(notificationElement);
80 static void writeCandidate(final NormalizedNodeStreamWriter writer, final DataTreeCandidate candidate)
82 if (candidate.getRootNode().getDataAfter().isPresent()) {
83 try (NormalizedNodeWriter nodeWriter = NormalizedNodeWriter.forStreamWriter(writer)) {
84 nodeWriter.write(candidate.getRootNode().getDataAfter().get());