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.google.common.annotations.VisibleForTesting;
  11 import java.time.Instant;
  12 import java.util.Collection;
  13 import java.util.List;
  14 import java.util.Optional;
  15 import java.util.stream.Collectors;
  16 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  17 import org.opendaylight.mdsal.dom.api.ClusteredDOMDataTreeChangeListener;
  18 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
  19 import org.opendaylight.mdsal.dom.api.DOMDataTreeChangeService;
  20 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
  21 import org.opendaylight.restconf.common.formatters.DataTreeCandidateFormatterFactory;
  22 import org.opendaylight.restconf.common.formatters.JSONDataTreeCandidateFormatter;
  23 import org.opendaylight.restconf.common.formatters.XMLDataTreeCandidateFormatter;
  24 import org.opendaylight.yang.gen.v1.urn.sal.restconf.event.subscription.rev140708.NotificationOutputTypeGrouping.NotificationOutputType;
  25 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  26 import org.opendaylight.yangtools.yang.data.codec.gson.JSONCodecFactorySupplier;
  27 import org.opendaylight.yangtools.yang.data.tree.api.DataTreeCandidate;
  28 import org.slf4j.Logger;
  29 import org.slf4j.LoggerFactory;
  30
  31 /**
  32  * {@link ListenerAdapter} is responsible to track events, which occurred by changing data in data source.
  33  */
  34 public class ListenerAdapter extends AbstractCommonSubscriber<YangInstanceIdentifier, Collection<DataTreeCandidate>>
  35         implements ClusteredDOMDataTreeChangeListener {
  36     private static final Logger LOG = LoggerFactory.getLogger(ListenerAdapter.class);
  37     private static final DataTreeCandidateFormatterFactory JSON_FORMATTER_FACTORY =
  38             JSONDataTreeCandidateFormatter.createFactory(JSONCodecFactorySupplier.RFC7951);
  39
  40     /**
  41      * Creates new {@link ListenerAdapter} listener specified by path and stream name and register for subscribing.
  42      *
  43      * @param path       Path to data in data store.
  44      * @param streamName The name of the stream.
  45      * @param outputType Type of output on notification (JSON, XML).
  46      */
  47     @VisibleForTesting
  48     public ListenerAdapter(final YangInstanceIdentifier path, final String streamName,
  49             final NotificationOutputType outputType) {
  50         super(path.getLastPathArgument().getNodeType(), streamName, path, outputType, getFormatterFactory(outputType));
  51     }
  52
  53     private static DataTreeCandidateFormatterFactory getFormatterFactory(final NotificationOutputType outputType) {
  54         switch (outputType) {
  55             case JSON:
  56                 return JSON_FORMATTER_FACTORY;
  57             case XML:
  58                 return XMLDataTreeCandidateFormatter.FACTORY;
  59             default:
  60                 throw new IllegalArgumentException("Unsupported outputType" + outputType);
  61         }
  62     }
  63
  64     @Override
  65     public void onInitialData() {
  66         // No-op
  67     }
  68
  69     @Override
  70     @SuppressWarnings("checkstyle:IllegalCatch")
  71     public void onDataTreeChanged(final List<DataTreeCandidate> dataTreeCandidates) {
  72         final Instant now = Instant.now();
  73         if (!checkStartStop(now)) {
  74             return;
  75         }
  76
  77         final Optional<String> maybeData;
  78         try {
  79             maybeData = formatter().eventData(schemaHandler.get(), dataTreeCandidates, now, getLeafNodesOnly(),
  80                     isSkipNotificationData());
  81         } catch (final Exception e) {
  82             LOG.error("Failed to process notification {}",
  83                     dataTreeCandidates.stream().map(Object::toString).collect(Collectors.joining(",")), e);
  84             return;
  85         }
  86
  87         if (maybeData.isPresent()) {
  88             post(maybeData.get());
  89         }
  90     }
  91
  92     /**
  93      * Get path pointed to data in data store.
  94      *
  95      * @return Path pointed to data in data store.
  96      */
  97     public YangInstanceIdentifier getPath() {
  98         return path();
  99     }
 100
 101     /**
 102      * Register data change listener in DOM data broker and set it to listener on stream.
 103      *
 104      * @param domDataBroker data broker for register data change listener
 105      * @param datastore     {@link LogicalDatastoreType}
 106      */
 107     public final synchronized void listen(final DOMDataBroker domDataBroker, final LogicalDatastoreType datastore) {
 108         if (!isListening()) {
 109             final DOMDataTreeChangeService changeService = domDataBroker.getExtensions()
 110                 .getInstance(DOMDataTreeChangeService.class);
 111             if (changeService == null) {
 112                 throw new UnsupportedOperationException("DOMDataBroker does not support the DOMDataTreeChangeService");
 113             }
 114
 115             setRegistration(changeService.registerDataTreeChangeListener(
 116                 new DOMDataTreeIdentifier(datastore, getPath()), this));
 117         }
 118     }
 119 }