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

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