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.restconf.nb.rfc8040.streams.listeners;
10 import com.fasterxml.jackson.databind.JsonNode;
11 import com.fasterxml.jackson.dataformat.xml.XmlMapper;
12 import com.google.common.base.Preconditions;
13 import com.google.common.base.Throwables;
14 import java.io.IOException;
16 import java.util.Map.Entry;
18 import javax.xml.stream.XMLStreamException;
19 import javax.xml.transform.dom.DOMResult;
20 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataChangeEvent;
21 import org.opendaylight.controller.md.sal.dom.api.DOMDataChangeListener;
22 import org.opendaylight.yang.gen.v1.urn.sal.restconf.event.subscription.rev140708.NotificationOutputTypeGrouping.NotificationOutputType;
23 import org.opendaylight.yangtools.yang.common.QName;
24 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
25 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
26 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
27 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
28 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
29 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
30 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
31 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListEntryNode;
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 DOMDataChangeListener {
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 AsyncDataChangeEvent<YangInstanceIdentifier, NormalizedNode<?, ?>> change;
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) {
71 setLocalNameOfPath(path.getLastPathArgument().getNodeType().getLocalName());
73 this.outputType = Preconditions.checkNotNull(outputType);
74 this.path = Preconditions.checkNotNull(path);
75 Preconditions.checkArgument((streamName != null) && !streamName.isEmpty());
76 this.streamName = streamName;
80 public void onDataChanged(final AsyncDataChangeEvent<YangInstanceIdentifier, NormalizedNode<?, ?>> change) {
82 final String xml = prepareXml();
83 if (checkQueryParams(xml, this)) {
84 prepareAndPostData(xml);
89 * Gets the name of the stream.
91 * @return The name of the stream.
94 public String getStreamName() {
95 return this.streamName;
99 public String getOutputType() {
100 return this.outputType.getName();
104 * Get path pointed to data in data store.
106 * @return Path pointed to data in data store.
108 public YangInstanceIdentifier getPath() {
113 * Prepare data of notification and data to client.
117 private void prepareAndPostData(final String xml) {
118 final Event event = new Event(EventType.NOTIFY);
119 if (this.outputType.equals(NotificationOutputType.JSON)) {
121 final JsonNode node = new XmlMapper().readTree(xml.getBytes());
122 event.setData(node.toString());
123 } catch (final IOException e) {
124 LOG.error("Error parsing XML {}", xml, e);
125 Throwables.propagate(e);
134 * Tracks events of data change by customer.
138 * Prepare data in printable form and transform it to String.
140 * @return Data in printable form.
142 private String prepareXml() {
143 final SchemaContext schemaContext = schemaHandler.get();
144 final DataSchemaContextTree dataContextTree = DataSchemaContextTree.from(schemaContext);
145 final Document doc = createDocument();
146 final Element notificationElement = basePartDoc(doc);
148 final Element dataChangedNotificationEventElement = doc.createElementNS(
149 "urn:opendaylight:params:xml:ns:yang:controller:md:sal:remote", "data-changed-notification");
151 addValuesToDataChangedNotificationEventElement(doc, dataChangedNotificationEventElement, this.change,
152 schemaContext, dataContextTree);
153 notificationElement.appendChild(dataChangedNotificationEventElement);
154 return transformDoc(doc);
158 * Adds values to data changed notification event element.
162 * @param dataChangedNotificationEventElement
165 * {@link AsyncDataChangeEvent}
167 private void addValuesToDataChangedNotificationEventElement(final Document doc,
168 final Element dataChangedNotificationEventElement,
169 final AsyncDataChangeEvent<YangInstanceIdentifier, NormalizedNode<?, ?>> change,
170 final SchemaContext schemaContext, final DataSchemaContextTree dataSchemaContextTree) {
172 addCreatedChangedValuesFromDataToElement(doc, change.getCreatedData().entrySet(),
173 dataChangedNotificationEventElement, Operation.CREATED, schemaContext, dataSchemaContextTree);
175 addCreatedChangedValuesFromDataToElement(doc, change.getUpdatedData().entrySet(),
176 dataChangedNotificationEventElement, Operation.UPDATED, schemaContext, dataSchemaContextTree);
178 addValuesFromDataToElement(doc, change.getRemovedPaths(), dataChangedNotificationEventElement,
179 Operation.DELETED, schemaContext, dataSchemaContextTree);
183 * Adds values from data to element.
188 * Set of {@link YangInstanceIdentifier}.
193 * @param schemaContext
194 * @param dataSchemaContextTree
196 private void addValuesFromDataToElement(final Document doc, final Set<YangInstanceIdentifier> data,
197 final Element element, final Operation operation, final SchemaContext schemaContext,
198 final DataSchemaContextTree dataSchemaContextTree) {
199 if ((data == null) || data.isEmpty()) {
202 for (final YangInstanceIdentifier path : data) {
203 if (!dataSchemaContextTree.getChild(path).isMixin()) {
204 final Node node = createDataChangeEventElement(doc, path, operation, schemaContext);
205 element.appendChild(node);
210 private void addCreatedChangedValuesFromDataToElement(final Document doc,
211 final Set<Entry<YangInstanceIdentifier, NormalizedNode<?, ?>>> data, final Element element,
212 final Operation operation, final SchemaContext schemaContext,
213 final DataSchemaContextTree dataSchemaContextTree) {
214 if ((data == null) || data.isEmpty()) {
217 for (final Entry<YangInstanceIdentifier, NormalizedNode<?, ?>> entry : data) {
218 if (!dataSchemaContextTree.getChild(entry.getKey()).isMixin()
219 && (!getLeafNodesOnly() || entry.getValue() instanceof LeafNode)) {
220 final Node node = createCreatedChangedDataChangeEventElement(doc, entry, operation, schemaContext,
221 dataSchemaContextTree);
222 element.appendChild(node);
228 * Creates changed event element from data.
233 * Path to data in data store.
236 * @param schemaContext
237 * @return {@link Node} node represented by changed event element.
239 private Node createDataChangeEventElement(final Document doc, final YangInstanceIdentifier path,
240 final Operation operation, final SchemaContext schemaContext) {
241 final Element dataChangeEventElement = doc.createElement("data-change-event");
242 final Element pathElement = doc.createElement("path");
243 addPathAsValueToElement(path, pathElement, schemaContext);
244 dataChangeEventElement.appendChild(pathElement);
246 final Element operationElement = doc.createElement("operation");
247 operationElement.setTextContent(operation.value);
248 dataChangeEventElement.appendChild(operationElement);
250 return dataChangeEventElement;
253 private Node createCreatedChangedDataChangeEventElement(final Document doc,
254 final Entry<YangInstanceIdentifier, NormalizedNode<?, ?>> entry, final Operation operation,
255 final SchemaContext schemaContext, final DataSchemaContextTree dataSchemaContextTree) {
256 final Element dataChangeEventElement = doc.createElement("data-change-event");
257 final Element pathElement = doc.createElement("path");
258 final YangInstanceIdentifier path = entry.getKey();
259 addPathAsValueToElement(path, pathElement, schemaContext);
260 dataChangeEventElement.appendChild(pathElement);
262 final Element operationElement = doc.createElement("operation");
263 operationElement.setTextContent(operation.value);
264 dataChangeEventElement.appendChild(operationElement);
268 final NormalizedNode<?, ?> normalized = entry.getValue();
269 if ((normalized instanceof MapEntryNode) || (normalized instanceof UnkeyedListEntryNode)) {
270 nodePath = dataSchemaContextTree.getChild(path).getDataSchemaNode().getPath();
272 nodePath = dataSchemaContextTree.getChild(path).getDataSchemaNode().getPath().getParent();
274 final DOMResult domResult = writeNormalizedNode(normalized, schemaContext, nodePath);
275 final Node result = doc.importNode(domResult.getNode().getFirstChild(), true);
276 final Element dataElement = doc.createElement("data");
277 dataElement.appendChild(result);
278 dataChangeEventElement.appendChild(dataElement);
279 } catch (final IOException e) {
280 LOG.error("Error in writer ", e);
281 } catch (final XMLStreamException e) {
282 LOG.error("Error processing stream", e);
285 return dataChangeEventElement;
289 * Adds path as value to element.
292 * Path to data in data store.
295 * @param schemaContext
297 @SuppressWarnings("rawtypes")
298 private void addPathAsValueToElement(final YangInstanceIdentifier path, final Element element,
299 final SchemaContext schemaContext) {
300 final StringBuilder textContent = new StringBuilder();
302 for (final PathArgument pathArgument : path.getPathArguments()) {
303 if (pathArgument instanceof YangInstanceIdentifier.AugmentationIdentifier) {
306 textContent.append("/");
307 writeIdentifierWithNamespacePrefix(element, textContent, pathArgument.getNodeType(), schemaContext);
308 if (pathArgument instanceof NodeIdentifierWithPredicates) {
309 final Map<QName, Object> predicates = ((NodeIdentifierWithPredicates) pathArgument).getKeyValues();
310 for (final QName keyValue : predicates.keySet()) {
311 final String predicateValue = String.valueOf(predicates.get(keyValue));
312 textContent.append("[");
313 writeIdentifierWithNamespacePrefix(element, textContent, keyValue, schemaContext);
314 textContent.append("='");
315 textContent.append(predicateValue);
316 textContent.append("'");
317 textContent.append("]");
319 } else if (pathArgument instanceof NodeWithValue) {
320 textContent.append("[.='");
321 textContent.append(((NodeWithValue) pathArgument).getValue());
322 textContent.append("'");
323 textContent.append("]");
326 element.setTextContent(textContent.toString());
330 * Writes identifier that consists of prefix and QName.
336 * @param qualifiedName
338 * @param schemaContext
340 private static void writeIdentifierWithNamespacePrefix(final Element element, final StringBuilder textContent,
341 final QName qualifiedName, final SchemaContext schemaContext) {
342 final Module module = schemaContext.findModuleByNamespaceAndRevision(qualifiedName.getNamespace(),
343 qualifiedName.getRevision());
345 textContent.append(module.getName());
346 textContent.append(":");
347 textContent.append(qualifiedName.getLocalName());
351 * Consists of three types {@link Operation#CREATED},
352 * {@link Operation#UPDATED} and {@link Operation#DELETED}.
354 private enum Operation {
355 CREATED("created"), UPDATED("updated"), DELETED("deleted");
357 private final String value;
359 Operation(final String value) {