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 com.google.common.base.Preconditions;
11 import java.io.IOException;
12 import java.util.Collection;
14 import javax.annotation.Nonnull;
15 import javax.xml.stream.XMLStreamException;
16 import javax.xml.transform.dom.DOMResult;
18 import org.opendaylight.controller.md.sal.dom.api.ClusteredDOMDataTreeChangeListener;
19 import org.opendaylight.netconf.sal.restconf.impl.ControllerContext;
20 import org.opendaylight.yang.gen.v1.urn.sal.restconf.event.subscription.rev140708.NotificationOutputTypeGrouping.NotificationOutputType;
21 import org.opendaylight.yangtools.yang.common.QName;
22 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
23 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
24 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
25 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
26 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
27 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
28 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
29 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListEntryNode;
30 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
31 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidateNode;
32 import org.opendaylight.yangtools.yang.data.util.DataSchemaContextTree;
33 import org.opendaylight.yangtools.yang.model.api.Module;
34 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
35 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
36 import org.slf4j.Logger;
37 import org.slf4j.LoggerFactory;
38 import org.w3c.dom.Document;
39 import org.w3c.dom.Element;
40 import org.w3c.dom.Node;
43 * {@link ListenerAdapter} is responsible to track events, which occurred by
44 * changing data in data source.
46 public class ListenerAdapter extends AbstractCommonSubscriber implements ClusteredDOMDataTreeChangeListener {
48 private static final Logger LOG = LoggerFactory.getLogger(ListenerAdapter.class);
50 private final YangInstanceIdentifier path;
51 private final String streamName;
52 private final NotificationOutputType outputType;
54 private Collection<DataTreeCandidate> candidates;
57 * Creates new {@link ListenerAdapter} listener specified by path and stream
58 * name and register for subscribing.
61 * Path to data in data store.
63 * The name of the stream.
65 * Type of output on notification (JSON, XML)
67 ListenerAdapter(final YangInstanceIdentifier path, final String streamName,
68 final NotificationOutputType outputType) {
70 this.outputType = Preconditions.checkNotNull(outputType);
71 this.path = Preconditions.checkNotNull(path);
72 Preconditions.checkArgument(streamName != null && !streamName.isEmpty());
73 this.streamName = streamName;
77 public void onDataTreeChanged(@Nonnull final Collection<DataTreeCandidate> dataTreeCandidates) {
78 this.candidates = dataTreeCandidates;
79 final String xml = prepareXml();
80 if (checkQueryParams(xml, this)) {
81 prepareAndPostData(xml);
86 * Gets the name of the stream.
88 * @return The name of the stream.
91 public String getStreamName() {
92 return this.streamName;
96 public String getOutputType() {
97 return this.outputType.getName();
101 * Get path pointed to data in data store.
103 * @return Path pointed to data in data store.
105 public YangInstanceIdentifier getPath() {
110 * Prepare data of notification and data to client.
114 private void prepareAndPostData(final String xml) {
115 final Event event = new Event(EventType.NOTIFY);
116 if (this.outputType.equals(NotificationOutputType.JSON)) {
117 event.setData(XML.toJSONObject(xml).toString());
125 * Tracks events of data change by customer.
129 * Prepare data in printable form and transform it to String.
131 * @return Data in printable form.
133 private String prepareXml() {
134 final SchemaContext schemaContext = ControllerContext.getInstance().getGlobalSchema();
135 final DataSchemaContextTree dataContextTree = DataSchemaContextTree.from(schemaContext);
136 final Document doc = createDocument();
137 final Element notificationElement = basePartDoc(doc);
139 final Element dataChangedNotificationEventElement = doc.createElementNS(
140 "urn:opendaylight:params:xml:ns:yang:controller:md:sal:remote", "data-changed-notification");
142 addValuesToDataChangedNotificationEventElement(doc, dataChangedNotificationEventElement,
143 this.candidates, schemaContext, dataContextTree);
144 notificationElement.appendChild(dataChangedNotificationEventElement);
145 return transformDoc(doc);
149 * Adds values to data changed notification event element.
153 * @param dataChangedNotificationEventElement
155 * @param dataTreeCandidates
156 * {@link DataTreeCandidate}
158 private void addValuesToDataChangedNotificationEventElement(final Document doc,
159 final Element dataChangedNotificationEventElement,
160 final Collection<DataTreeCandidate> dataTreeCandidates,
161 final SchemaContext schemaContext, final DataSchemaContextTree dataSchemaContextTree) {
163 for (DataTreeCandidate dataTreeCandidate : dataTreeCandidates) {
164 DataTreeCandidateNode candidateNode = dataTreeCandidate.getRootNode();
165 if (candidateNode == null) {
168 YangInstanceIdentifier yiid = dataTreeCandidate.getRootPath();
169 addNodeToDataChangeNotificationEventElement(doc, dataChangedNotificationEventElement, candidateNode,
170 yiid.getParent(), schemaContext, dataSchemaContextTree);
174 private void addNodeToDataChangeNotificationEventElement(final Document doc,
175 final Element dataChangedNotificationEventElement, final DataTreeCandidateNode candidateNode,
176 final YangInstanceIdentifier parentYiid, final SchemaContext schemaContext,
177 final DataSchemaContextTree dataSchemaContextTree) {
179 java.util.Optional<NormalizedNode<?,?>> optionalNormalizedNode = java.util.Optional.empty();
180 switch (candidateNode.getModificationType()) {
182 case SUBTREE_MODIFIED:
184 optionalNormalizedNode = candidateNode.getDataAfter();
188 optionalNormalizedNode = candidateNode.getDataBefore();
195 if (!optionalNormalizedNode.isPresent()) {
196 LOG.error("No node present in notification for {}", candidateNode);
200 NormalizedNode<?,?> normalizedNode = optionalNormalizedNode.get();
201 YangInstanceIdentifier yiid = YangInstanceIdentifier.builder(parentYiid)
202 .append(normalizedNode.getIdentifier()).build();
204 boolean isNodeMixin = ControllerContext.getInstance().isNodeMixin(yiid);
205 boolean isSkippedNonLeaf = getLeafNodesOnly() && !(normalizedNode instanceof LeafNode);
206 if (!isNodeMixin && !isSkippedNonLeaf) {
208 switch (candidateNode.getModificationType()) {
210 case SUBTREE_MODIFIED:
212 Operation op = candidateNode.getDataBefore().isPresent() ? Operation.UPDATED : Operation.CREATED;
213 node = createCreatedChangedDataChangeEventElement(doc, yiid, normalizedNode, op,
214 schemaContext, dataSchemaContextTree);
218 node = createDataChangeEventElement(doc, yiid, Operation.DELETED);
225 dataChangedNotificationEventElement.appendChild(node);
229 for (DataTreeCandidateNode childNode : candidateNode.getChildNodes()) {
230 addNodeToDataChangeNotificationEventElement(doc, dataChangedNotificationEventElement, childNode,
231 yiid, schemaContext, dataSchemaContextTree);
236 * Creates changed event element from data.
241 * Path to data in data store.
244 * @return {@link Node} node represented by changed event element.
246 private static Node createDataChangeEventElement(final Document doc, final YangInstanceIdentifier path,
247 final Operation operation) {
248 final Element dataChangeEventElement = doc.createElement("data-change-event");
249 final Element pathElement = doc.createElement("path");
250 addPathAsValueToElement(path, pathElement);
251 dataChangeEventElement.appendChild(pathElement);
253 final Element operationElement = doc.createElement("operation");
254 operationElement.setTextContent(operation.value);
255 dataChangeEventElement.appendChild(operationElement);
257 return dataChangeEventElement;
260 private Node createCreatedChangedDataChangeEventElement(final Document doc,
261 final YangInstanceIdentifier eventPath, final NormalizedNode normalized, final Operation operation,
262 final SchemaContext schemaContext, final DataSchemaContextTree dataSchemaContextTree) {
263 final Element dataChangeEventElement = doc.createElement("data-change-event");
264 final Element pathElement = doc.createElement("path");
265 addPathAsValueToElement(eventPath, pathElement);
266 dataChangeEventElement.appendChild(pathElement);
268 final Element operationElement = doc.createElement("operation");
269 operationElement.setTextContent(operation.value);
270 dataChangeEventElement.appendChild(operationElement);
274 if (normalized instanceof MapEntryNode || normalized instanceof UnkeyedListEntryNode) {
275 nodePath = dataSchemaContextTree.getChild(eventPath).getDataSchemaNode().getPath();
277 nodePath = dataSchemaContextTree.getChild(eventPath).getDataSchemaNode().getPath().getParent();
279 final DOMResult domResult = writeNormalizedNode(normalized, schemaContext, nodePath);
280 final Node result = doc.importNode(domResult.getNode().getFirstChild(), true);
281 final Element dataElement = doc.createElement("data");
282 dataElement.appendChild(result);
283 dataChangeEventElement.appendChild(dataElement);
284 } catch (final IOException e) {
285 LOG.error("Error in writer ", e);
286 } catch (final XMLStreamException e) {
287 LOG.error("Error processing stream", e);
290 return dataChangeEventElement;
294 * Adds path as value to element.
297 * Path to data in data store.
301 @SuppressWarnings("rawtypes")
302 private static void addPathAsValueToElement(final YangInstanceIdentifier path, final Element element) {
303 final YangInstanceIdentifier normalizedPath = ControllerContext.getInstance().toXpathRepresentation(path);
304 final StringBuilder textContent = new StringBuilder();
306 for (final PathArgument pathArgument : normalizedPath.getPathArguments()) {
307 if (pathArgument instanceof YangInstanceIdentifier.AugmentationIdentifier) {
310 textContent.append("/");
311 writeIdentifierWithNamespacePrefix(element, textContent, pathArgument.getNodeType());
312 if (pathArgument instanceof NodeIdentifierWithPredicates) {
313 final Map<QName, Object> predicates = ((NodeIdentifierWithPredicates) pathArgument).getKeyValues();
314 for (final QName keyValue : predicates.keySet()) {
315 final String predicateValue = String.valueOf(predicates.get(keyValue));
316 textContent.append("[");
317 writeIdentifierWithNamespacePrefix(element, textContent, keyValue);
318 textContent.append("='");
319 textContent.append(predicateValue);
320 textContent.append("'");
321 textContent.append("]");
323 } else if (pathArgument instanceof NodeWithValue) {
324 textContent.append("[.='");
325 textContent.append(((NodeWithValue) pathArgument).getValue());
326 textContent.append("'");
327 textContent.append("]");
330 element.setTextContent(textContent.toString());
334 * Writes identifier that consists of prefix and QName.
340 * @param qualifiedName
343 private static void writeIdentifierWithNamespacePrefix(final Element element, final StringBuilder textContent,
344 final QName qualifiedName) {
345 final Module module = ControllerContext.getInstance().getGlobalSchema().findModule(qualifiedName.getModule())
348 textContent.append(module.getName());
349 textContent.append(":");
350 textContent.append(qualifiedName.getLocalName());
354 * Consists of three types {@link Operation#CREATED},
355 * {@link Operation#UPDATED} and {@link Operation#DELETED}.
357 private enum Operation {
358 CREATED("created"), UPDATED("updated"), DELETED("deleted");
360 private final String value;
362 Operation(final String value) {