2 * Copyright (c) 2015 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.netconf.messagebus.eventsources.netconf;
10 import static com.google.common.util.concurrent.Futures.immediateFuture;
11 import static java.util.Objects.requireNonNull;
13 import com.google.common.collect.ArrayListMultimap;
14 import com.google.common.collect.ImmutableMap;
15 import com.google.common.collect.Maps;
16 import com.google.common.collect.Multimap;
17 import com.google.common.collect.Multimaps;
18 import com.google.common.util.concurrent.ListenableFuture;
19 import java.io.IOException;
20 import java.time.Instant;
21 import java.util.ArrayList;
22 import java.util.Collection;
23 import java.util.List;
25 import java.util.Map.Entry;
26 import java.util.Optional;
27 import java.util.concurrent.ExecutionException;
28 import java.util.regex.Pattern;
29 import javax.xml.stream.XMLStreamException;
30 import javax.xml.transform.dom.DOMResult;
31 import javax.xml.transform.dom.DOMSource;
32 import org.opendaylight.controller.messagebus.app.util.TopicDOMNotification;
33 import org.opendaylight.controller.messagebus.app.util.Util;
34 import org.opendaylight.controller.messagebus.spi.EventSource;
35 import org.opendaylight.mdsal.dom.api.DOMEvent;
36 import org.opendaylight.mdsal.dom.api.DOMNotification;
37 import org.opendaylight.mdsal.dom.api.DOMNotificationListener;
38 import org.opendaylight.mdsal.dom.api.DOMNotificationPublishService;
39 import org.opendaylight.netconf.api.xml.XmlUtil;
40 import org.opendaylight.netconf.util.NetconfUtil;
41 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.messagebus.eventaggregator.rev141202.NotificationPattern;
42 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.messagebus.eventaggregator.rev141202.TopicId;
43 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.messagebus.eventaggregator.rev141202.TopicNotification;
44 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.messagebus.eventsource.rev141202.DisJoinTopicInput;
45 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.messagebus.eventsource.rev141202.DisJoinTopicOutput;
46 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.messagebus.eventsource.rev141202.DisJoinTopicOutputBuilder;
47 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.messagebus.eventsource.rev141202.JoinTopicInput;
48 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.messagebus.eventsource.rev141202.JoinTopicOutput;
49 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.messagebus.eventsource.rev141202.JoinTopicOutputBuilder;
50 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.messagebus.eventsource.rev141202.JoinTopicStatus;
51 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netmod.notification.rev080714.netconf.streams.Stream;
52 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
53 import org.opendaylight.yangtools.yang.common.QName;
54 import org.opendaylight.yangtools.yang.common.RpcResult;
55 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
56 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
57 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
58 import org.opendaylight.yangtools.yang.data.api.schema.DOMSourceAnyxmlNode;
59 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
60 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
61 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
62 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
63 import org.slf4j.Logger;
64 import org.slf4j.LoggerFactory;
65 import org.w3c.dom.Document;
66 import org.w3c.dom.Element;
69 * NetconfEventSource serves as proxy between nodes and messagebus. Subscribers can join topic stream from this source.
70 * Then they will receive notifications from device that matches pattern specified by topic.
72 @Deprecated(forRemoval = true)
73 public class NetconfEventSource implements EventSource, DOMNotificationListener {
75 private static final Logger LOG = LoggerFactory.getLogger(NetconfEventSource.class);
77 private static final NodeIdentifier TOPIC_NOTIFICATION_ARG = NodeIdentifier.create(TopicNotification.QNAME);
78 private static final NodeIdentifier EVENT_SOURCE_ARG = NodeIdentifier.create(
79 QName.create(TopicNotification.QNAME, "node-id"));
80 private static final NodeIdentifier TOPIC_ID_ARG = NodeIdentifier.create(
81 QName.create(TopicNotification.QNAME, "topic-id"));
82 private static final NodeIdentifier PAYLOAD_ARG = NodeIdentifier.create(
83 QName.create(TopicNotification.QNAME, "payload"));
84 private static final String CONNECTION_NOTIFICATION_SOURCE_NAME = "ConnectionNotificationSource";
86 private final DOMNotificationPublishService domPublish;
88 private final Map<String, String> urnPrefixToStreamMap; // key = urnPrefix, value = StreamName
91 * Map notification uri -> registrations.
93 private final Multimap<String, NotificationTopicRegistration>
94 notificationTopicRegistrations = Multimaps.synchronizedListMultimap(ArrayListMultimap.create());
95 private final NetconfEventSourceMount mount;
98 * Creates new NetconfEventSource for node. Topic notifications will be published via provided
99 * {@link DOMNotificationPublishService}
101 * @param streamMap netconf streams from device
102 * @param publishService publish service
104 public NetconfEventSource(final Map<String, String> streamMap,
105 final NetconfEventSourceMount mount,
106 final DOMNotificationPublishService publishService) {
108 this.urnPrefixToStreamMap = requireNonNull(streamMap);
109 this.domPublish = requireNonNull(publishService);
110 this.initializeNotificationTopicRegistrationList();
112 LOG.info("NetconfEventSource [{}] created.", mount.getNodeId());
116 * Creates {@link ConnectionNotificationTopicRegistration} for connection. Also creates
117 * {@link StreamNotificationTopicRegistration} for every prefix and available stream as defined in config file.
119 private void initializeNotificationTopicRegistrationList() {
120 final ConnectionNotificationTopicRegistration cntr =
121 new ConnectionNotificationTopicRegistration(CONNECTION_NOTIFICATION_SOURCE_NAME, this);
122 notificationTopicRegistrations
123 .put(cntr.getNotificationUrnPrefix(), cntr);
124 Map<String, Stream> availableStreams = getAvailableStreams();
125 LOG.debug("Stream configuration compare...");
126 for (Entry<String, String> entry : this.urnPrefixToStreamMap.entrySet()) {
127 String urnPrefix = entry.getKey();
128 final String streamName = entry.getValue();
129 LOG.debug("urnPrefix: {} streamName: {}", urnPrefix, streamName);
130 if (availableStreams.containsKey(streamName)) {
131 LOG.debug("Stream containig on device");
132 notificationTopicRegistrations
133 .put(urnPrefix, new StreamNotificationTopicRegistration(availableStreams.get(streamName),
139 private Map<String, Stream> getAvailableStreams() {
140 final Collection<Stream> availableStreams;
142 availableStreams = mount.getAvailableStreams();
143 } catch (InterruptedException | ExecutionException e) {
144 LOG.warn("Can not read streams for node {}", mount.getNodeId(), e);
145 return ImmutableMap.of();
148 return Maps.uniqueIndex(availableStreams, input -> input.getName().getValue());
152 public ListenableFuture<RpcResult<JoinTopicOutput>> joinTopic(final JoinTopicInput input) {
153 LOG.debug("Join topic {} on {}", input.getTopicId().getValue(), mount.getNodeId());
154 final NotificationPattern notificationPattern = input.getNotificationPattern();
155 final List<SchemaPath> matchingNotifications = getMatchingNotifications(notificationPattern);
156 return registerTopic(input.getTopicId(), matchingNotifications);
161 public ListenableFuture<RpcResult<DisJoinTopicOutput>> disJoinTopic(final DisJoinTopicInput input) {
162 for (NotificationTopicRegistration reg : notificationTopicRegistrations.values()) {
163 reg.unRegisterNotificationTopic(input.getTopicId());
165 return Util.resultRpcSuccessFor(new DisJoinTopicOutputBuilder().build());
168 private synchronized ListenableFuture<RpcResult<JoinTopicOutput>> registerTopic(
169 final TopicId topicId,
170 final List<SchemaPath> notificationsToSubscribe) {
171 requireNonNull(notificationsToSubscribe);
172 LOG.debug("Join topic {} - register", topicId);
173 JoinTopicStatus joinTopicStatus = JoinTopicStatus.Down;
175 LOG.debug("Notifications to subscribe has found - count {}", notificationsToSubscribe.size());
176 int registeredNotificationCount = 0;
177 for (SchemaPath schemaPath : notificationsToSubscribe) {
178 final Collection<NotificationTopicRegistration> topicRegistrations =
179 notificationTopicRegistrations.get(schemaPath.getLastComponent().getNamespace().toString());
180 for (NotificationTopicRegistration reg : topicRegistrations) {
181 LOG.info("Source of notification {} is activating, TopicId {}", reg.getSourceName(),
183 boolean regSuccess = reg.registerNotificationTopic(schemaPath, topicId);
185 registeredNotificationCount = registeredNotificationCount + 1;
189 if (registeredNotificationCount > 0) {
190 joinTopicStatus = JoinTopicStatus.Up;
192 final JoinTopicOutput output = new JoinTopicOutputBuilder().setStatus(joinTopicStatus).build();
193 return immediateFuture(RpcResultBuilder.success(output).build());
197 public void reActivateStreams() {
198 for (NotificationTopicRegistration reg : notificationTopicRegistrations.values()) {
199 LOG.info("Source of notification {} is reactivating on node {}", reg.getSourceName(), mount.getNodeId());
200 reg.reActivateNotificationSource();
204 public void deActivateStreams() {
205 for (NotificationTopicRegistration reg : notificationTopicRegistrations.values()) {
206 LOG.info("Source of notification {} is deactivating on node {}", reg.getSourceName(), mount.getNodeId());
207 reg.deActivateNotificationSource();
212 public void onNotification(final DOMNotification notification) {
213 Instant notificationEventTime = null;
214 if (notification instanceof DOMEvent) {
215 notificationEventTime = ((DOMEvent) notification).getEventInstant();
217 final String namespace = notification.getType().lastNodeIdentifier().getNamespace().toString();
218 for (NotificationTopicRegistration notifReg : notificationTopicRegistrations.get(namespace)) {
219 notifReg.setLastEventTime(notificationEventTime);
220 for (TopicId topicId : notifReg.getTopicsForNotification(notification.getType().asSchemaPath())) {
221 publishNotification(notification, topicId);
222 LOG.debug("Notification {} has been published for TopicId {}", notification.getType(),
228 private void publishNotification(final DOMNotification notification, final TopicId topicId) {
229 final ContainerNode topicNotification = Builders.containerBuilder().withNodeIdentifier(TOPIC_NOTIFICATION_ARG)
230 .withChild(ImmutableNodes.leafNode(TOPIC_ID_ARG, topicId))
231 .withChild(ImmutableNodes.leafNode(EVENT_SOURCE_ARG, mount.getNodeId()))
232 .withChild(encapsulate(notification))
235 domPublish.putNotification(new TopicDOMNotification(topicNotification));
236 } catch (final InterruptedException e) {
237 throw new RuntimeException(e);
241 private DOMSourceAnyxmlNode encapsulate(final DOMNotification body) {
242 // FIXME: Introduce something like YangModeledAnyXmlNode in Yangtools
243 final Document doc = XmlUtil.newDocument();
244 final Optional<String> namespace = Optional.of(PAYLOAD_ARG.getNodeType().getNamespace().toString());
245 final Element element = XmlUtil.createElement(doc, "payload", namespace);
247 final DOMResult result = new DOMResult(element);
250 NetconfUtil.writeNormalizedNode(body.getBody(), result, body.getType().asSchemaPath(),
251 mount.getSchemaContext());
252 return Builders.anyXmlBuilder().withNodeIdentifier(PAYLOAD_ARG).withValue(new DOMSource(element)).build();
253 } catch (IOException | XMLStreamException e) {
254 LOG.error("Unable to encapsulate notification.", e);
255 throw new RuntimeException(e);
260 * Returns all available notification paths that matches given pattern.
262 * @param notificationPattern pattern
263 * @return notification paths
265 private List<SchemaPath> getMatchingNotifications(final NotificationPattern notificationPattern) {
266 final String regex = notificationPattern.getValue();
268 final Pattern pattern = Pattern.compile(regex);
269 List<SchemaPath> availableNotifications = getAvailableNotifications();
270 return Util.expandQname(availableNotifications, pattern);
274 public void close() throws Exception {
275 for (NotificationTopicRegistration streamReg : notificationTopicRegistrations.values()) {
281 public NodeKey getSourceNodeKey() {
282 return mount.getNode().key();
286 public List<SchemaPath> getAvailableNotifications() {
288 final List<SchemaPath> availNotifList = new ArrayList<>();
289 // add Event Source Connection status notification
290 availNotifList.add(ConnectionNotificationTopicRegistration.EVENT_SOURCE_STATUS_PATH.asSchemaPath());
292 // add all known notifications from netconf device
293 for (final NotificationDefinition nd : mount.getSchemaContext().getNotifications()) {
294 availNotifList.add(nd.getPath());
296 return availNotifList;
299 NetconfEventSourceMount getMount() {