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.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.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         super();
  70         register(this);
  71         setLocalNameOfPath(path.getLastPathArgument().getNodeType().getLocalName());
  72
  73         this.outputType = Preconditions.checkNotNull(outputType);
  74         this.path = Preconditions.checkNotNull(path);
  75         Preconditions.checkArgument((streamName != null) && !streamName.isEmpty());
  76         this.streamName = streamName;
  77     }
  78
  79     @Override
  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             final JSONObject jsonObject = XML.toJSONObject(xml);
 121             event.setData(jsonObject.toString());
 122         } else {
 123             event.setData(xml);
 124         }
 125         post(event);
 126     }
 127
 128     /**
 129      * Tracks events of data change by customer.
 130      */
 131
 132     /**
 133      * Prepare data in printable form and transform it to String.
 134      *
 135      * @return Data in printable form.
 136      */
 137     private String prepareXml() {
 138         final SchemaContext schemaContext = ControllerContext.getInstance().getGlobalSchema();
 139         final DataSchemaContextTree dataContextTree = DataSchemaContextTree.from(schemaContext);
 140         final Document doc = createDocument();
 141         final Element notificationElement = basePartDoc(doc);
 142
 143         final Element dataChangedNotificationEventElement = doc.createElementNS(
 144                 "urn:opendaylight:params:xml:ns:yang:controller:md:sal:remote", "data-changed-notification");
 145
 146         addValuesToDataChangedNotificationEventElement(doc, dataChangedNotificationEventElement, this.change,
 147                 schemaContext, dataContextTree);
 148         notificationElement.appendChild(dataChangedNotificationEventElement);
 149         return transformDoc(doc);
 150     }
 151
 152     /**
 153      * Adds values to data changed notification event element.
 154      *
 155      * @param doc
 156      *            {@link Document}
 157      * @param dataChangedNotificationEventElement
 158      *            {@link Element}
 159      * @param change
 160      *            {@link AsyncDataChangeEvent}
 161      */
 162     private void addValuesToDataChangedNotificationEventElement(final Document doc,
 163             final Element dataChangedNotificationEventElement,
 164             final AsyncDataChangeEvent<YangInstanceIdentifier, NormalizedNode<?, ?>> change,
 165             final SchemaContext schemaContext, final DataSchemaContextTree dataSchemaContextTree) {
 166
 167         addCreatedChangedValuesFromDataToElement(doc, change.getCreatedData().entrySet(),
 168                 dataChangedNotificationEventElement, Operation.CREATED, schemaContext, dataSchemaContextTree);
 169
 170         addCreatedChangedValuesFromDataToElement(doc, change.getUpdatedData().entrySet(),
 171                 dataChangedNotificationEventElement, Operation.UPDATED, schemaContext, dataSchemaContextTree);
 172
 173         addValuesFromDataToElement(doc, change.getRemovedPaths(), dataChangedNotificationEventElement,
 174                 Operation.DELETED);
 175     }
 176
 177     /**
 178      * Adds values from data to element.
 179      *
 180      * @param doc
 181      *            {@link Document}
 182      * @param data
 183      *            Set of {@link YangInstanceIdentifier}.
 184      * @param element
 185      *            {@link Element}
 186      * @param operation
 187      *            {@link Operation}
 188      */
 189     private void addValuesFromDataToElement(final Document doc, final Set<YangInstanceIdentifier> data,
 190             final Element element, final Operation operation) {
 191         if ((data == null) || data.isEmpty()) {
 192             return;
 193         }
 194         for (final YangInstanceIdentifier path : data) {
 195             if (!ControllerContext.getInstance().isNodeMixin(path)) {
 196                 final Node node = createDataChangeEventElement(doc, path, operation);
 197                 element.appendChild(node);
 198             }
 199         }
 200     }
 201
 202     private void addCreatedChangedValuesFromDataToElement(final Document doc,
 203             final Set<Entry<YangInstanceIdentifier, NormalizedNode<?, ?>>> data, final Element element,
 204             final Operation operation, final SchemaContext schemaContext,
 205             final DataSchemaContextTree dataSchemaContextTree) {
 206         if ((data == null) || data.isEmpty()) {
 207             return;
 208         }
 209         for (final Entry<YangInstanceIdentifier, NormalizedNode<?, ?>> entry : data) {
 210             if (!ControllerContext.getInstance().isNodeMixin(entry.getKey())
 211                     && (!getLeafNodesOnly() || entry.getValue() instanceof LeafNode)) {
 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 qualifiedName
 327      *            QName
 328      */
 329     private static void writeIdentifierWithNamespacePrefix(final Element element, final StringBuilder textContent,
 330             final QName qualifiedName) {
 331         final Module module = ControllerContext.getInstance().getGlobalSchema()
 332                 .findModuleByNamespaceAndRevision(qualifiedName.getNamespace(), qualifiedName.getRevision());
 333
 334         textContent.append(module.getName());
 335         textContent.append(":");
 336         textContent.append(qualifiedName.getLocalName());
 337     }
 338
 339     /**
 340      * Consists of three types {@link Operation#CREATED},
 341      * {@link Operation#UPDATED} and {@link Operation#DELETED}.
 342      */
 343     private enum Operation {
 344         CREATED("created"), UPDATED("updated"), DELETED("deleted");
 345
 346         private final String value;
 347
 348         Operation(final String value) {
 349             this.value = value;
 350         }
 351     }
 352 }