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