2 * Copyright (c) 2014, 2016 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.restconf.nb.rfc8040.streams.listeners;
10 import static java.util.Objects.requireNonNull;
12 import com.google.common.annotations.VisibleForTesting;
13 import com.google.common.base.MoreObjects.ToStringHelper;
14 import java.time.Instant;
15 import java.util.Collection;
16 import java.util.List;
17 import java.util.Optional;
18 import java.util.stream.Collectors;
19 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
20 import org.opendaylight.mdsal.dom.api.ClusteredDOMDataTreeChangeListener;
21 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
22 import org.opendaylight.mdsal.dom.api.DOMDataTreeChangeService;
23 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
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;
32 * {@link ListenerAdapter} is responsible to track events, which occurred by changing data in data source.
34 public class ListenerAdapter extends AbstractCommonSubscriber<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);
40 private final YangInstanceIdentifier path;
43 * Creates new {@link ListenerAdapter} listener specified by path and stream name and register for subscribing.
45 * @param path Path to data in data store.
46 * @param streamName The name of the stream.
47 * @param outputType Type of output on notification (JSON, XML).
50 public ListenerAdapter(final YangInstanceIdentifier path, final String streamName,
51 final NotificationOutputType outputType) {
52 super(streamName, outputType, getFormatterFactory(outputType));
53 this.path = requireNonNull(path);
56 private static DataTreeCandidateFormatterFactory getFormatterFactory(final NotificationOutputType outputType) {
57 return switch (outputType) {
58 case JSON -> JSON_FORMATTER_FACTORY;
59 case XML -> XMLDataTreeCandidateFormatter.FACTORY;
64 public void onInitialData() {
69 @SuppressWarnings("checkstyle:IllegalCatch")
70 public void onDataTreeChanged(final List<DataTreeCandidate> dataTreeCandidates) {
71 final Instant now = Instant.now();
72 if (!checkStartStop(now)) {
76 final Optional<String> maybeData;
78 maybeData = formatter().eventData(databindProvider.currentContext().modelContext(), dataTreeCandidates, now,
79 getLeafNodesOnly(), isSkipNotificationData(), getChangedLeafNodesOnly(), getChildNodesOnly());
80 } catch (final Exception e) {
81 LOG.error("Failed to process notification {}",
82 dataTreeCandidates.stream().map(Object::toString).collect(Collectors.joining(",")), e);
86 maybeData.ifPresent(this::post);
90 * Get path pointed to data in data store.
92 * @return Path pointed to data in data store.
94 public YangInstanceIdentifier getPath() {
99 * Register data change listener in DOM data broker and set it to listener on stream.
101 * @param domDataBroker data broker for register data change listener
102 * @param datastore {@link LogicalDatastoreType}
104 public final synchronized void listen(final DOMDataBroker domDataBroker, final LogicalDatastoreType datastore) {
105 if (!isListening()) {
106 final DOMDataTreeChangeService changeService = domDataBroker.getExtensions()
107 .getInstance(DOMDataTreeChangeService.class);
108 if (changeService == null) {
109 throw new UnsupportedOperationException("DOMDataBroker does not support the DOMDataTreeChangeService");
112 setRegistration(changeService.registerDataTreeChangeListener(
113 new DOMDataTreeIdentifier(datastore, getPath()), this));
118 ToStringHelper addToStringAttributes(final ToStringHelper helper) {
119 return super.addToStringAttributes(helper.add("path", path));