restconf/restconf-nb-bierman02/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.XML;
  18 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataChangeEvent;
  19 import org.opendaylight.controller.md.sal.dom.api.DOMDataChangeListener;
  20 import org.opendaylight.netconf.sal.restconf.impl.ControllerContext;
  21 import org.opendaylight.yang.gen.v1.urn.sal.restconf.event.subscription.rev140708.NotificationOutputTypeGrouping.NotificationOutputType;
  22 import org.opendaylight.yangtools.yang.common.QName;
  23 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  24 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  25 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
  26 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  27 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
  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   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             event.setData(XML.toJSONObject(xml).toString());
 120         } else {
 121             event.setData(xml);
 122         }
 123         post(event);
 124     }
 125
 126     /**
 127      * Tracks events of data change by customer.
 128      */
 129
 130     /**
 131      * Prepare data in printable form and transform it to String.
 132      *
 133      * @return Data in printable form.
 134      */
 135     private String prepareXml() {
 136         final SchemaContext schemaContext = ControllerContext.getInstance().getGlobalSchema();
 137         final DataSchemaContextTree dataContextTree = DataSchemaContextTree.from(schemaContext);
 138         final Document doc = createDocument();
 139         final Element notificationElement = basePartDoc(doc);
 140
 141         final Element dataChangedNotificationEventElement = doc.createElementNS(
 142                 "urn:opendaylight:params:xml:ns:yang:controller:md:sal:remote", "data-changed-notification");
 143
 144         addValuesToDataChangedNotificationEventElement(doc, dataChangedNotificationEventElement, this.change,
 145                 schemaContext, dataContextTree);
 146         notificationElement.appendChild(dataChangedNotificationEventElement);
 147         return transformDoc(doc);
 148     }
 149
 150     /**
 151      * Adds values to data changed notification event element.
 152      *
 153      * @param doc
 154      *            {@link Document}
 155      * @param dataChangedNotificationEventElement
 156      *            {@link Element}
 157      * @param change
 158      *            {@link AsyncDataChangeEvent}
 159      */
 160     private void addValuesToDataChangedNotificationEventElement(final Document doc,
 161             final Element dataChangedNotificationEventElement,
 162             final AsyncDataChangeEvent<YangInstanceIdentifier, NormalizedNode<?, ?>> change,
 163             final SchemaContext schemaContext, final DataSchemaContextTree dataSchemaContextTree) {
 164
 165         addCreatedChangedValuesFromDataToElement(doc, change.getCreatedData().entrySet(),
 166                 dataChangedNotificationEventElement, Operation.CREATED, schemaContext, dataSchemaContextTree);
 167
 168         addCreatedChangedValuesFromDataToElement(doc, change.getUpdatedData().entrySet(),
 169                 dataChangedNotificationEventElement, Operation.UPDATED, schemaContext, dataSchemaContextTree);
 170
 171         addValuesFromDataToElement(doc, change.getRemovedPaths(), dataChangedNotificationEventElement,
 172                 Operation.DELETED);
 173     }
 174
 175     /**
 176      * Adds values from data to element.
 177      *
 178      * @param doc
 179      *            {@link Document}
 180      * @param data
 181      *            Set of {@link YangInstanceIdentifier}.
 182      * @param element
 183      *            {@link Element}
 184      * @param operation
 185      *            {@link Operation}
 186      */
 187     private void addValuesFromDataToElement(final Document doc, final Set<YangInstanceIdentifier> data,
 188             final Element element, final Operation operation) {
 189         if ((data == null) || data.isEmpty()) {
 190             return;
 191         }
 192         for (final YangInstanceIdentifier path : data) {
 193             if (!ControllerContext.getInstance().isNodeMixin(path)) {
 194                 final Node node = createDataChangeEventElement(doc, path, operation);
 195                 element.appendChild(node);
 196             }
 197         }
 198     }
 199
 200     private void addCreatedChangedValuesFromDataToElement(final Document doc,
 201             final Set<Entry<YangInstanceIdentifier, NormalizedNode<?, ?>>> data, final Element element,
 202             final Operation operation, final SchemaContext schemaContext,
 203             final DataSchemaContextTree dataSchemaContextTree) {
 204         if ((data == null) || data.isEmpty()) {
 205             return;
 206         }
 207         for (final Entry<YangInstanceIdentifier, NormalizedNode<?, ?>> entry : data) {
 208             if (!ControllerContext.getInstance().isNodeMixin(entry.getKey())
 209                     && (!getLeafNodesOnly() || entry.getValue() instanceof LeafNode)) {
 210                 final Node node = createCreatedChangedDataChangeEventElement(doc, entry, operation, schemaContext,
 211                         dataSchemaContextTree);
 212                 element.appendChild(node);
 213             }
 214         }
 215     }
 216
 217     /**
 218      * Creates changed event element from data.
 219      *
 220      * @param doc
 221      *            {@link Document}
 222      * @param path
 223      *            Path to data in data store.
 224      * @param operation
 225      *            {@link Operation}
 226      * @return {@link Node} node represented by changed event element.
 227      */
 228     private Node createDataChangeEventElement(final Document doc, final YangInstanceIdentifier path,
 229             final Operation operation) {
 230         final Element dataChangeEventElement = doc.createElement("data-change-event");
 231         final Element pathElement = doc.createElement("path");
 232         addPathAsValueToElement(path, pathElement);
 233         dataChangeEventElement.appendChild(pathElement);
 234
 235         final Element operationElement = doc.createElement("operation");
 236         operationElement.setTextContent(operation.value);
 237         dataChangeEventElement.appendChild(operationElement);
 238
 239         return dataChangeEventElement;
 240     }
 241
 242     private Node createCreatedChangedDataChangeEventElement(final Document doc,
 243             final Entry<YangInstanceIdentifier, NormalizedNode<?, ?>> entry, final Operation operation,
 244             final SchemaContext schemaContext, final DataSchemaContextTree dataSchemaContextTree) {
 245         final Element dataChangeEventElement = doc.createElement("data-change-event");
 246         final Element pathElement = doc.createElement("path");
 247         final YangInstanceIdentifier path = entry.getKey();
 248         addPathAsValueToElement(path, pathElement);
 249         dataChangeEventElement.appendChild(pathElement);
 250
 251         final Element operationElement = doc.createElement("operation");
 252         operationElement.setTextContent(operation.value);
 253         dataChangeEventElement.appendChild(operationElement);
 254
 255         try {
 256             SchemaPath nodePath;
 257             final NormalizedNode<?, ?> normalized = entry.getValue();
 258             if ((normalized instanceof MapEntryNode) || (normalized instanceof UnkeyedListEntryNode)) {
 259                 nodePath = dataSchemaContextTree.getChild(path).getDataSchemaNode().getPath();
 260             } else {
 261                 nodePath = dataSchemaContextTree.getChild(path).getDataSchemaNode().getPath().getParent();
 262             }
 263             final DOMResult domResult = writeNormalizedNode(normalized, schemaContext, nodePath);
 264             final Node result = doc.importNode(domResult.getNode().getFirstChild(), true);
 265             final Element dataElement = doc.createElement("data");
 266             dataElement.appendChild(result);
 267             dataChangeEventElement.appendChild(dataElement);
 268         } catch (final IOException e) {
 269             LOG.error("Error in writer ", e);
 270         } catch (final XMLStreamException e) {
 271             LOG.error("Error processing stream", e);
 272         }
 273
 274         return dataChangeEventElement;
 275     }
 276
 277     /**
 278      * Adds path as value to element.
 279      *
 280      * @param path
 281      *            Path to data in data store.
 282      * @param element
 283      *            {@link Element}
 284      */
 285     @SuppressWarnings("rawtypes")
 286     private void addPathAsValueToElement(final YangInstanceIdentifier path, final Element element) {
 287         final YangInstanceIdentifier normalizedPath = ControllerContext.getInstance().toXpathRepresentation(path);
 288         final StringBuilder textContent = new StringBuilder();
 289
 290         for (final PathArgument pathArgument : normalizedPath.getPathArguments()) {
 291             if (pathArgument instanceof YangInstanceIdentifier.AugmentationIdentifier) {
 292                 continue;
 293             }
 294             textContent.append("/");
 295             writeIdentifierWithNamespacePrefix(element, textContent, pathArgument.getNodeType());
 296             if (pathArgument instanceof NodeIdentifierWithPredicates) {
 297                 final Map<QName, Object> predicates = ((NodeIdentifierWithPredicates) pathArgument).getKeyValues();
 298                 for (final QName keyValue : predicates.keySet()) {
 299                     final String predicateValue = String.valueOf(predicates.get(keyValue));
 300                     textContent.append("[");
 301                     writeIdentifierWithNamespacePrefix(element, textContent, keyValue);
 302                     textContent.append("='");
 303                     textContent.append(predicateValue);
 304                     textContent.append("'");
 305                     textContent.append("]");
 306                 }
 307             } else if (pathArgument instanceof NodeWithValue) {
 308                 textContent.append("[.='");
 309                 textContent.append(((NodeWithValue) pathArgument).getValue());
 310                 textContent.append("'");
 311                 textContent.append("]");
 312             }
 313         }
 314         element.setTextContent(textContent.toString());
 315     }
 316
 317     /**
 318      * Writes identifier that consists of prefix and QName.
 319      *
 320      * @param element
 321      *            {@link Element}
 322      * @param textContent
 323      *            StringBuilder
 324      * @param qualifiedName
 325      *            QName
 326      */
 327     private static void writeIdentifierWithNamespacePrefix(final Element element, final StringBuilder textContent,
 328             final QName qualifiedName) {
 329         final Module module = ControllerContext.getInstance().getGlobalSchema()
 330                 .findModuleByNamespaceAndRevision(qualifiedName.getNamespace(), qualifiedName.getRevision());
 331
 332         textContent.append(module.getName());
 333         textContent.append(":");
 334         textContent.append(qualifiedName.getLocalName());
 335     }
 336
 337     /**
 338      * Consists of three types {@link Operation#CREATED},
 339      * {@link Operation#UPDATED} and {@link Operation#DELETED}.
 340      */
 341     private enum Operation {
 342         CREATED("created"), UPDATED("updated"), DELETED("deleted");
 343
 344         private final String value;
 345
 346         Operation(final String value) {
 347             this.value = value;
 348         }
 349     }
 350 }