2 * Copyright (c) 2014, 2016 Cisco Systems, Inc. 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.netconf.sal.streams.listeners;
10 import static com.google.common.base.Preconditions.checkArgument;
11 import static java.util.Objects.requireNonNull;
13 import java.io.IOException;
14 import java.time.Instant;
15 import java.util.Collection;
16 import java.util.Map.Entry;
17 import java.util.Optional;
18 import javax.xml.stream.XMLStreamException;
19 import javax.xml.transform.dom.DOMResult;
21 import org.opendaylight.mdsal.dom.api.ClusteredDOMDataTreeChangeListener;
22 import org.opendaylight.netconf.sal.restconf.impl.ControllerContext;
23 import org.opendaylight.yang.gen.v1.urn.sal.restconf.event.subscription.rev140708.NotificationOutputTypeGrouping.NotificationOutputType;
24 import org.opendaylight.yangtools.yang.common.QName;
25 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
26 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
27 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
28 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
29 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
30 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
31 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
32 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListEntryNode;
33 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
34 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidateNode;
35 import org.opendaylight.yangtools.yang.data.util.DataSchemaContextTree;
36 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
37 import org.opendaylight.yangtools.yang.model.api.Module;
38 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
39 import org.slf4j.Logger;
40 import org.slf4j.LoggerFactory;
41 import org.w3c.dom.Document;
42 import org.w3c.dom.Element;
43 import org.w3c.dom.Node;
46 * {@link ListenerAdapter} is responsible to track events, which occurred by
47 * changing data in data source.
49 public class ListenerAdapter extends AbstractCommonSubscriber implements ClusteredDOMDataTreeChangeListener {
51 private static final Logger LOG = LoggerFactory.getLogger(ListenerAdapter.class);
52 private static final String DATA_CHANGE_EVENT = "data-change-event";
53 private static final String PATH = "path";
54 private static final String OPERATION = "operation";
56 private final ControllerContext controllerContext;
57 private final YangInstanceIdentifier path;
58 private final String streamName;
59 private final NotificationOutputType outputType;
62 * Creates new {@link ListenerAdapter} listener specified by path and stream
63 * name and register for subscribing.
66 * Path to data in data store.
68 * The name of the stream.
70 * Type of output on notification (JSON, XML)
72 ListenerAdapter(final YangInstanceIdentifier path, final String streamName,
73 final NotificationOutputType outputType, final ControllerContext controllerContext) {
75 this.outputType = requireNonNull(outputType);
76 this.path = requireNonNull(path);
77 checkArgument(streamName != null && !streamName.isEmpty());
78 this.streamName = streamName;
79 this.controllerContext = controllerContext;
83 public void onDataTreeChanged(final Collection<DataTreeCandidate> dataTreeCandidates) {
84 final Instant now = Instant.now();
85 if (!checkStartStop(now, this)) {
89 final String xml = prepareXml(dataTreeCandidates);
90 if (checkFilter(xml)) {
91 prepareAndPostData(xml);
96 * Gets the name of the stream.
98 * @return The name of the stream.
101 public String getStreamName() {
102 return this.streamName;
106 public String getOutputType() {
107 return this.outputType.getName();
111 * Get path pointed to data in data store.
113 * @return Path pointed to data in data store.
115 public YangInstanceIdentifier getPath() {
120 * Prepare data of notification and data to client.
124 private void prepareAndPostData(final String xml) {
125 final Event event = new Event(EventType.NOTIFY);
126 if (this.outputType.equals(NotificationOutputType.JSON)) {
127 event.setData(XML.toJSONObject(xml).toString());
135 * Tracks events of data change by customer.
139 * Prepare data in printable form and transform it to String.
141 * @return Data in printable form.
143 private String prepareXml(final Collection<DataTreeCandidate> candidates) {
144 final EffectiveModelContext schemaContext = controllerContext.getGlobalSchema();
145 final DataSchemaContextTree dataContextTree = DataSchemaContextTree.from(schemaContext);
146 final Document doc = createDocument();
147 final Element notificationElement = basePartDoc(doc);
149 final Element dataChangedNotificationEventElement = doc.createElementNS(
150 "urn:opendaylight:params:xml:ns:yang:controller:md:sal:remote", "data-changed-notification");
152 addValuesToDataChangedNotificationEventElement(doc, dataChangedNotificationEventElement, candidates,
153 schemaContext, dataContextTree);
154 notificationElement.appendChild(dataChangedNotificationEventElement);
155 return transformDoc(doc);
159 * Adds values to data changed notification event element.
163 * @param dataChangedNotificationEventElement
165 * @param dataTreeCandidates
166 * {@link DataTreeCandidate}
168 private void addValuesToDataChangedNotificationEventElement(final Document doc,
169 final Element dataChangedNotificationEventElement,
170 final Collection<DataTreeCandidate> dataTreeCandidates,
171 final EffectiveModelContext schemaContext, final DataSchemaContextTree dataSchemaContextTree) {
173 for (DataTreeCandidate dataTreeCandidate : dataTreeCandidates) {
174 DataTreeCandidateNode candidateNode = dataTreeCandidate.getRootNode();
175 if (candidateNode == null) {
178 YangInstanceIdentifier yiid = dataTreeCandidate.getRootPath();
180 boolean isSkipNotificationData = this.isSkipNotificationData();
181 if (isSkipNotificationData) {
182 createCreatedChangedDataChangeEventElementWithoutData(doc,
183 dataChangedNotificationEventElement, dataTreeCandidate.getRootNode());
185 addNodeToDataChangeNotificationEventElement(doc, dataChangedNotificationEventElement, candidateNode,
186 yiid.getParent(), schemaContext, dataSchemaContextTree);
191 private void addNodeToDataChangeNotificationEventElement(final Document doc,
192 final Element dataChangedNotificationEventElement, final DataTreeCandidateNode candidateNode,
193 final YangInstanceIdentifier parentYiid, final EffectiveModelContext schemaContext,
194 final DataSchemaContextTree dataSchemaContextTree) {
196 Optional<NormalizedNode<?,?>> optionalNormalizedNode = Optional.empty();
197 switch (candidateNode.getModificationType()) {
199 case SUBTREE_MODIFIED:
201 optionalNormalizedNode = candidateNode.getDataAfter();
205 optionalNormalizedNode = candidateNode.getDataBefore();
212 if (optionalNormalizedNode.isEmpty()) {
213 LOG.error("No node present in notification for {}", candidateNode);
217 NormalizedNode<?,?> normalizedNode = optionalNormalizedNode.get();
218 YangInstanceIdentifier yiid = YangInstanceIdentifier.builder(parentYiid)
219 .append(normalizedNode.getIdentifier()).build();
221 boolean isNodeMixin = controllerContext.isNodeMixin(yiid);
222 boolean isSkippedNonLeaf = getLeafNodesOnly() && !(normalizedNode instanceof LeafNode);
223 if (!isNodeMixin && !isSkippedNonLeaf) {
225 switch (candidateNode.getModificationType()) {
227 case SUBTREE_MODIFIED:
229 Operation op = candidateNode.getDataBefore().isPresent() ? Operation.UPDATED : Operation.CREATED;
230 node = createCreatedChangedDataChangeEventElement(doc, yiid, normalizedNode, op,
231 schemaContext, dataSchemaContextTree);
235 node = createDataChangeEventElement(doc, yiid, Operation.DELETED);
242 dataChangedNotificationEventElement.appendChild(node);
246 for (DataTreeCandidateNode childNode : candidateNode.getChildNodes()) {
247 addNodeToDataChangeNotificationEventElement(doc, dataChangedNotificationEventElement, childNode,
248 yiid, schemaContext, dataSchemaContextTree);
253 * Creates changed event element from data.
258 * Path to data in data store.
261 * @return {@link Node} node represented by changed event element.
263 private Node createDataChangeEventElement(final Document doc, final YangInstanceIdentifier dataPath,
264 final Operation operation) {
265 final Element dataChangeEventElement = doc.createElement(DATA_CHANGE_EVENT);
266 final Element pathElement = doc.createElement(PATH);
267 addPathAsValueToElement(dataPath, pathElement);
268 dataChangeEventElement.appendChild(pathElement);
270 final Element operationElement = doc.createElement(OPERATION);
271 operationElement.setTextContent(operation.value);
272 dataChangeEventElement.appendChild(operationElement);
274 return dataChangeEventElement;
278 * Creates data change notification element without data element.
282 * @param dataChangedNotificationEventElement
284 * @param candidateNode
285 * {@link DataTreeCandidateNode}
287 private void createCreatedChangedDataChangeEventElementWithoutData(final Document doc,
288 final Element dataChangedNotificationEventElement, final DataTreeCandidateNode candidateNode) {
289 final Operation operation;
290 switch (candidateNode.getModificationType()) {
292 case SUBTREE_MODIFIED:
294 operation = candidateNode.getDataBefore().isPresent() ? Operation.UPDATED : Operation.CREATED;
298 operation = Operation.DELETED;
304 Node dataChangeEventElement = createDataChangeEventElement(doc, getPath(), operation);
305 dataChangedNotificationEventElement.appendChild(dataChangeEventElement);
309 private Node createCreatedChangedDataChangeEventElement(final Document doc,
310 final YangInstanceIdentifier eventPath, final NormalizedNode normalized, final Operation operation,
311 final EffectiveModelContext schemaContext, final DataSchemaContextTree dataSchemaContextTree) {
312 final Element dataChangeEventElement = doc.createElement(DATA_CHANGE_EVENT);
313 final Element pathElement = doc.createElement(PATH);
314 addPathAsValueToElement(eventPath, pathElement);
315 dataChangeEventElement.appendChild(pathElement);
317 final Element operationElement = doc.createElement(OPERATION);
318 operationElement.setTextContent(operation.value);
319 dataChangeEventElement.appendChild(operationElement);
323 if (normalized instanceof MapEntryNode || normalized instanceof UnkeyedListEntryNode) {
324 nodePath = dataSchemaContextTree.findChild(eventPath).orElseThrow().getDataSchemaNode().getPath();
326 nodePath = dataSchemaContextTree.findChild(eventPath).orElseThrow().getDataSchemaNode().getPath()
329 final DOMResult domResult = writeNormalizedNode(normalized, schemaContext, nodePath);
330 final Node result = doc.importNode(domResult.getNode().getFirstChild(), true);
331 final Element dataElement = doc.createElement("data");
332 dataElement.appendChild(result);
333 dataChangeEventElement.appendChild(dataElement);
334 } catch (final IOException e) {
335 LOG.error("Error in writer ", e);
336 } catch (final XMLStreamException e) {
337 LOG.error("Error processing stream", e);
340 return dataChangeEventElement;
344 * Adds path as value to element.
347 * Path to data in data store.
351 @SuppressWarnings("rawtypes")
352 private void addPathAsValueToElement(final YangInstanceIdentifier dataPath, final Element element) {
353 final YangInstanceIdentifier normalizedPath = controllerContext.toXpathRepresentation(dataPath);
354 final StringBuilder textContent = new StringBuilder();
356 for (final PathArgument pathArgument : normalizedPath.getPathArguments()) {
357 if (pathArgument instanceof YangInstanceIdentifier.AugmentationIdentifier) {
360 textContent.append("/");
361 writeIdentifierWithNamespacePrefix(element, textContent, pathArgument.getNodeType());
362 if (pathArgument instanceof NodeIdentifierWithPredicates) {
363 for (final Entry<QName, Object> entry : ((NodeIdentifierWithPredicates) pathArgument).entrySet()) {
364 final QName keyValue = entry.getKey();
365 final String predicateValue = String.valueOf(entry.getValue());
366 textContent.append("[");
367 writeIdentifierWithNamespacePrefix(element, textContent, keyValue);
368 textContent.append("='");
369 textContent.append(predicateValue);
370 textContent.append("'");
371 textContent.append("]");
373 } else if (pathArgument instanceof NodeWithValue) {
374 textContent.append("[.='");
375 textContent.append(((NodeWithValue) pathArgument).getValue());
376 textContent.append("'");
377 textContent.append("]");
380 element.setTextContent(textContent.toString());
384 * Writes identifier that consists of prefix and QName.
390 * @param qualifiedName
393 private void writeIdentifierWithNamespacePrefix(final Element element, final StringBuilder textContent,
394 final QName qualifiedName) {
395 final Module module = controllerContext.getGlobalSchema().findModule(qualifiedName.getModule())
398 textContent.append(module.getName());
399 textContent.append(":");
400 textContent.append(qualifiedName.getLocalName());
404 * Consists of three types {@link Operation#CREATED},
405 * {@link Operation#UPDATED} and {@link Operation#DELETED}.
407 private enum Operation {
408 CREATED("created"), UPDATED("updated"), DELETED("deleted");
410 private final String value;
412 Operation(final String value) {