restconf/sal-rest-connector/src/main/java/org/opendaylight/netconf/sal/streams/listeners/ListenerAdapter.java

   1 /*
   2  * Copyright (c) 2014, 2016 Cisco Systems, Inc. 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.netconf.sal.streams.listeners;
   9
  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;
  15 import java.util.Map;
  16 import java.util.Map.Entry;
  17 import java.util.Set;
  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.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.util.DataSchemaContextTree;
  34 import org.opendaylight.yangtools.yang.model.api.Module;
  35 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  36 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  37 import org.slf4j.Logger;
  38 import org.slf4j.LoggerFactory;
  39 import org.w3c.dom.Document;
  40 import org.w3c.dom.Element;
  41 import org.w3c.dom.Node;
  42
  43 /**
  44  * {@link ListenerAdapter} is responsible to track events, which occurred by
  45  * changing data in data source.
  46  */
  47 public class ListenerAdapter extends AbstractCommonSubscriber implements DOMDataChangeListener {
  48
  49     private static final Logger LOG = LoggerFactory.getLogger(ListenerAdapter.class);
  50
  51     private final YangInstanceIdentifier path;
  52     private final String streamName;
  53     private final NotificationOutputType outputType;
  54
  55     private AsyncDataChangeEvent<YangInstanceIdentifier, NormalizedNode<?, ?>> change;
  56
  57     /**
  58      * Creates new {@link ListenerAdapter} listener specified by path and stream
  59      * name and register for subscribing.
  60      *
  61      * @param path
  62      *            Path to data in data store.
  63      * @param streamName
  64      *            The name of the stream.
  65      * @param outputType
  66      *            Type of output on notification (JSON, XML)
  67      */
  68     ListenerAdapter(final YangInstanceIdentifier path, final String streamName,
  69             final NotificationOutputType outputType) {
  70         super();
  71         register(this);
  72         setLocalNameOfPath(path.getLastPathArgument().getNodeType().getLocalName());
  73
  74         this.outputType = Preconditions.checkNotNull(outputType);
  75         this.path = Preconditions.checkNotNull(path);
  76         Preconditions.checkArgument((streamName != null) && !streamName.isEmpty());
  77         this.streamName = streamName;
  78     }
  79
  80     @Override
  81     public void onDataChanged(final AsyncDataChangeEvent<YangInstanceIdentifier, NormalizedNode<?, ?>> change) {
  82         this.change = change;
  83         final String xml = prepareXml();
  84         if (checkQueryParams(xml, this)) {
  85             prepareAndPostData(xml);
  86         }
  87     }
  88
  89     /**
  90      * Gets the name of the stream.
  91      *
  92      * @return The name of the stream.
  93      */
  94     @Override
  95     public String getStreamName() {
  96         return this.streamName;
  97     }
  98
  99     @Override
 100     public String getOutputType() {
 101         return this.outputType.getName();
 102     }
 103
 104     /**
 105      * Get path pointed to data in data store.
 106      *
 107      * @return Path pointed to data in data store.
 108      */
 109     public YangInstanceIdentifier getPath() {
 110         return this.path;
 111     }
 112
 113     /**
 114      * Prepare data of notification and data to client.
 115      *
 116      * @param xml   data
 117      */
 118     private void prepareAndPostData(final String xml) {
 119         final Event event = new Event(EventType.NOTIFY);
 120         if (this.outputType.equals(NotificationOutputType.JSON)) {
 121             try {
 122                 JsonNode node = new XmlMapper().readTree(xml.getBytes());
 123                 event.setData(node.toString());
 124             } catch (IOException e) {
 125                 LOG.error("Error parsing XML {}", xml, e);
 126                 Throwables.propagate(e);
 127             }
 128         } else {
 129             event.setData(xml);
 130         }
 131         post(event);
 132     }
 133
 134     /**
 135      * Tracks events of data change by customer.
 136      */
 137
 138     /**
 139      * Prepare data in printable form and transform it to String.
 140      *
 141      * @return Data in printable form.
 142      */
 143     private String prepareXml() {
 144         final SchemaContext schemaContext = ControllerContext.getInstance().getGlobalSchema();
 145         final DataSchemaContextTree dataContextTree = DataSchemaContextTree.from(schemaContext);
 146         final Document doc = createDocument();
 147         final Element notificationElement = basePartDoc(doc);
 148
 149         final Element dataChangedNotificationEventElement = doc.createElementNS(
 150                 "urn:opendaylight:params:xml:ns:yang:controller:md:sal:remote", "data-changed-notification");
 151
 152         addValuesToDataChangedNotificationEventElement(doc, dataChangedNotificationEventElement, this.change,
 153                 schemaContext, dataContextTree);
 154         notificationElement.appendChild(dataChangedNotificationEventElement);
 155         return transformDoc(doc);
 156     }
 157
 158     /**
 159      * Adds values to data changed notification event element.
 160      *
 161      * @param doc
 162      *            {@link Document}
 163      * @param dataChangedNotificationEventElement
 164      *            {@link Element}
 165      * @param change
 166      *            {@link AsyncDataChangeEvent}
 167      */
 168     private void addValuesToDataChangedNotificationEventElement(final Document doc,
 169             final Element dataChangedNotificationEventElement,
 170             final AsyncDataChangeEvent<YangInstanceIdentifier, NormalizedNode<?, ?>> change,
 171             final SchemaContext schemaContext, final DataSchemaContextTree dataSchemaContextTree) {
 172
 173         addCreatedChangedValuesFromDataToElement(doc, change.getCreatedData().entrySet(),
 174                 dataChangedNotificationEventElement, Operation.CREATED, schemaContext, dataSchemaContextTree);
 175
 176         addCreatedChangedValuesFromDataToElement(doc, change.getUpdatedData().entrySet(),
 177                 dataChangedNotificationEventElement, Operation.UPDATED, schemaContext, dataSchemaContextTree);
 178
 179         addValuesFromDataToElement(doc, change.getRemovedPaths(), dataChangedNotificationEventElement,
 180                 Operation.DELETED);
 181     }
 182
 183     /**
 184      * Adds values from data to element.
 185      *
 186      * @param doc
 187      *            {@link Document}
 188      * @param data
 189      *            Set of {@link YangInstanceIdentifier}.
 190      * @param element
 191      *            {@link Element}
 192      * @param operation
 193      *            {@link Operation}
 194      */
 195     private void addValuesFromDataToElement(final Document doc, final Set<YangInstanceIdentifier> data,
 196             final Element element, final Operation operation) {
 197         if ((data == null) || data.isEmpty()) {
 198             return;
 199         }
 200         for (final YangInstanceIdentifier path : data) {
 201             if (!ControllerContext.getInstance().isNodeMixin(path)) {
 202                 final Node node = createDataChangeEventElement(doc, path, operation);
 203                 element.appendChild(node);
 204             }
 205         }
 206     }
 207
 208     private void addCreatedChangedValuesFromDataToElement(final Document doc,
 209             final Set<Entry<YangInstanceIdentifier, NormalizedNode<?, ?>>> data, final Element element,
 210             final Operation operation, final SchemaContext schemaContext,
 211             final DataSchemaContextTree dataSchemaContextTree) {
 212         if ((data == null) || data.isEmpty()) {
 213             return;
 214         }
 215         for (final Entry<YangInstanceIdentifier, NormalizedNode<?, ?>> entry : data) {
 216             if (!ControllerContext.getInstance().isNodeMixin(entry.getKey())
 217                     && (!getLeafNodesOnly() || entry.getValue() instanceof LeafNode)) {
 218                 final Node node = createCreatedChangedDataChangeEventElement(doc, entry, operation, schemaContext,
 219                         dataSchemaContextTree);
 220                 element.appendChild(node);
 221             }
 222         }
 223     }
 224
 225     /**
 226      * Creates changed event element from data.
 227      *
 228      * @param doc
 229      *            {@link Document}
 230      * @param path
 231      *            Path to data in data store.
 232      * @param operation
 233      *            {@link Operation}
 234      * @return {@link Node} node represented by changed event element.
 235      */
 236     private Node createDataChangeEventElement(final Document doc, final YangInstanceIdentifier path,
 237             final Operation operation) {
 238         final Element dataChangeEventElement = doc.createElement("data-change-event");
 239         final Element pathElement = doc.createElement("path");
 240         addPathAsValueToElement(path, pathElement);
 241         dataChangeEventElement.appendChild(pathElement);
 242
 243         final Element operationElement = doc.createElement("operation");
 244         operationElement.setTextContent(operation.value);
 245         dataChangeEventElement.appendChild(operationElement);
 246
 247         return dataChangeEventElement;
 248     }
 249
 250     private Node createCreatedChangedDataChangeEventElement(final Document doc,
 251             final Entry<YangInstanceIdentifier, NormalizedNode<?, ?>> entry, final Operation operation,
 252             final SchemaContext schemaContext, final DataSchemaContextTree dataSchemaContextTree) {
 253         final Element dataChangeEventElement = doc.createElement("data-change-event");
 254         final Element pathElement = doc.createElement("path");
 255         final YangInstanceIdentifier path = entry.getKey();
 256         addPathAsValueToElement(path, pathElement);
 257         dataChangeEventElement.appendChild(pathElement);
 258
 259         final Element operationElement = doc.createElement("operation");
 260         operationElement.setTextContent(operation.value);
 261         dataChangeEventElement.appendChild(operationElement);
 262
 263         try {
 264             SchemaPath nodePath;
 265             final NormalizedNode<?, ?> normalized = entry.getValue();
 266             if ((normalized instanceof MapEntryNode) || (normalized instanceof UnkeyedListEntryNode)) {
 267                 nodePath = dataSchemaContextTree.getChild(path).getDataSchemaNode().getPath();
 268             } else {
 269                 nodePath = dataSchemaContextTree.getChild(path).getDataSchemaNode().getPath().getParent();
 270             }
 271             final DOMResult domResult = writeNormalizedNode(normalized, schemaContext, nodePath);
 272             final Node result = doc.importNode(domResult.getNode().getFirstChild(), true);
 273             final Element dataElement = doc.createElement("data");
 274             dataElement.appendChild(result);
 275             dataChangeEventElement.appendChild(dataElement);
 276         } catch (final IOException e) {
 277             LOG.error("Error in writer ", e);
 278         } catch (final XMLStreamException e) {
 279             LOG.error("Error processing stream", e);
 280         }
 281
 282         return dataChangeEventElement;
 283     }
 284
 285     /**
 286      * Adds path as value to element.
 287      *
 288      * @param path
 289      *            Path to data in data store.
 290      * @param element
 291      *            {@link Element}
 292      */
 293     @SuppressWarnings("rawtypes")
 294     private void addPathAsValueToElement(final YangInstanceIdentifier path, final Element element) {
 295         final YangInstanceIdentifier normalizedPath = ControllerContext.getInstance().toXpathRepresentation(path);
 296         final StringBuilder textContent = new StringBuilder();
 297
 298         for (final PathArgument pathArgument : normalizedPath.getPathArguments()) {
 299             if (pathArgument instanceof YangInstanceIdentifier.AugmentationIdentifier) {
 300                 continue;
 301             }
 302             textContent.append("/");
 303             writeIdentifierWithNamespacePrefix(element, textContent, pathArgument.getNodeType());
 304             if (pathArgument instanceof NodeIdentifierWithPredicates) {
 305                 final Map<QName, Object> predicates = ((NodeIdentifierWithPredicates) pathArgument).getKeyValues();
 306                 for (final QName keyValue : predicates.keySet()) {
 307                     final String predicateValue = String.valueOf(predicates.get(keyValue));
 308                     textContent.append("[");
 309                     writeIdentifierWithNamespacePrefix(element, textContent, keyValue);
 310                     textContent.append("='");
 311                     textContent.append(predicateValue);
 312                     textContent.append("'");
 313                     textContent.append("]");
 314                 }
 315             } else if (pathArgument instanceof NodeWithValue) {
 316                 textContent.append("[.='");
 317                 textContent.append(((NodeWithValue) pathArgument).getValue());
 318                 textContent.append("'");
 319                 textContent.append("]");
 320             }
 321         }
 322         element.setTextContent(textContent.toString());
 323     }
 324
 325     /**
 326      * Writes identifier that consists of prefix and QName.
 327      *
 328      * @param element
 329      *            {@link Element}
 330      * @param textContent
 331      *            StringBuilder
 332      * @param qualifiedName
 333      *            QName
 334      */
 335     private static void writeIdentifierWithNamespacePrefix(final Element element, final StringBuilder textContent,
 336             final QName qualifiedName) {
 337         final Module module = ControllerContext.getInstance().getGlobalSchema()
 338                 .findModuleByNamespaceAndRevision(qualifiedName.getNamespace(), qualifiedName.getRevision());
 339
 340         textContent.append(module.getName());
 341         textContent.append(":");
 342         textContent.append(qualifiedName.getLocalName());
 343     }
 344
 345     /**
 346      * Consists of three types {@link Operation#CREATED},
 347      * {@link Operation#UPDATED} and {@link Operation#DELETED}.
 348      */
 349     private enum Operation {
 350         CREATED("created"), UPDATED("updated"), DELETED("deleted");
 351
 352         private final String value;
 353
 354         Operation(final String value) {
 355             this.value = value;
 356         }
 357     }
 358 }