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