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
9 package org.opendaylight.netconf.messagebus.eventsources.netconf;
11 import static com.google.common.util.concurrent.Futures.immediateFuture;
13 import com.google.common.base.Optional;
14 import com.google.common.base.Preconditions;
15 import com.google.common.base.Throwables;
16 import com.google.common.collect.ArrayListMultimap;
17 import com.google.common.collect.Maps;
18 import com.google.common.collect.Multimap;
19 import com.google.common.collect.Multimaps;
20 import java.io.IOException;
21 import java.util.ArrayList;
22 import java.util.Collection;
23 import java.util.Date;
24 import java.util.HashMap;
25 import java.util.List;
28 import java.util.concurrent.Future;
29 import java.util.regex.Pattern;
30 import javax.xml.stream.XMLStreamException;
31 import javax.xml.transform.dom.DOMResult;
32 import javax.xml.transform.dom.DOMSource;
33 import org.opendaylight.controller.config.util.xml.XmlUtil;
34 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
35 import org.opendaylight.controller.md.sal.dom.api.DOMEvent;
36 import org.opendaylight.controller.md.sal.dom.api.DOMNotification;
37 import org.opendaylight.controller.md.sal.dom.api.DOMNotificationListener;
38 import org.opendaylight.controller.md.sal.dom.api.DOMNotificationPublishService;
39 import org.opendaylight.controller.messagebus.app.util.TopicDOMNotification;
40 import org.opendaylight.controller.messagebus.app.util.Util;
41 import org.opendaylight.controller.messagebus.spi.EventSource;
42 import org.opendaylight.netconf.util.NetconfUtil;
43 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.messagebus.eventaggregator.rev141202.NotificationPattern;
44 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.messagebus.eventaggregator.rev141202.TopicId;
45 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.messagebus.eventaggregator.rev141202.TopicNotification;
46 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.messagebus.eventsource.rev141202.DisJoinTopicInput;
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.AnyXmlNode;
58 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
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.SchemaContext;
63 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
64 import org.slf4j.Logger;
65 import org.slf4j.LoggerFactory;
66 import org.w3c.dom.Document;
67 import org.w3c.dom.Element;
70 * NetconfEventSource serves as proxy between nodes and messagebus. Subscribers can join topic stream from this source.
71 * Then they will receive notifications from device that matches pattern specified by topic.
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 = Preconditions.checkNotNull(streamMap);
109 this.domPublish = Preconditions.checkNotNull(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 (String urnPrefix : this.urnPrefixToStreamMap.keySet()) {
127 final String streamName = this.urnPrefixToStreamMap.get(urnPrefix);
128 LOG.debug("urnPrefix: {} streamName: {}", urnPrefix, streamName);
129 if (availableStreams.containsKey(streamName)) {
130 LOG.debug("Stream containig on device");
131 notificationTopicRegistrations
132 .put(urnPrefix, new StreamNotificationTopicRegistration(availableStreams.get(streamName),
138 private Map<String, Stream> getAvailableStreams() {
139 Map<String, Stream> streamMap = new HashMap<>();
140 final List<Stream> availableStreams;
142 availableStreams = mount.getAvailableStreams();
143 streamMap = Maps.uniqueIndex(availableStreams, input -> input.getName().getValue());
144 } catch (ReadFailedException e) {
145 LOG.warn("Can not read streams for node {}", mount.getNodeId());
151 public Future<RpcResult<JoinTopicOutput>> joinTopic(final JoinTopicInput input) {
152 LOG.debug("Join topic {} on {}", input.getTopicId().getValue(), mount.getNodeId());
153 final NotificationPattern notificationPattern = input.getNotificationPattern();
154 final List<SchemaPath> matchingNotifications = getMatchingNotifications(notificationPattern);
155 return registerTopic(input.getTopicId(), matchingNotifications);
160 public Future<RpcResult<Void>> disJoinTopic(final DisJoinTopicInput input) {
161 for (NotificationTopicRegistration reg : notificationTopicRegistrations.values()) {
162 reg.unRegisterNotificationTopic(input.getTopicId());
164 return Util.resultRpcSuccessFor((Void) null);
167 private synchronized Future<RpcResult<JoinTopicOutput>> registerTopic(
168 final TopicId topicId,
169 final List<SchemaPath> notificationsToSubscribe) {
170 Preconditions.checkNotNull(notificationsToSubscribe);
171 LOG.debug("Join topic {} - register", topicId);
172 JoinTopicStatus joinTopicStatus = JoinTopicStatus.Down;
174 LOG.debug("Notifications to subscribe has found - count {}", notificationsToSubscribe.size());
175 int registeredNotificationCount = 0;
176 for (SchemaPath schemaPath : notificationsToSubscribe) {
177 final Collection<NotificationTopicRegistration> topicRegistrations =
178 notificationTopicRegistrations.get(schemaPath.getLastComponent().getNamespace().toString());
179 for (NotificationTopicRegistration reg : topicRegistrations) {
180 LOG.info("Source of notification {} is activating, TopicId {}", reg.getSourceName(),
182 boolean regSuccess = reg.registerNotificationTopic(schemaPath, topicId);
184 registeredNotificationCount = registeredNotificationCount + 1;
188 if (registeredNotificationCount > 0) {
189 joinTopicStatus = JoinTopicStatus.Up;
191 final JoinTopicOutput output = new JoinTopicOutputBuilder().setStatus(joinTopicStatus).build();
192 return immediateFuture(RpcResultBuilder.success(output).build());
196 public void reActivateStreams() {
197 for (NotificationTopicRegistration reg : notificationTopicRegistrations.values()) {
198 LOG.info("Source of notification {} is reactivating on node {}", reg.getSourceName(), mount.getNodeId());
199 reg.reActivateNotificationSource();
203 public void deActivateStreams() {
204 for (NotificationTopicRegistration reg : notificationTopicRegistrations.values()) {
205 LOG.info("Source of notification {} is deactivating on node {}", reg.getSourceName(), mount.getNodeId());
206 reg.deActivateNotificationSource();
211 public void onNotification(final DOMNotification notification) {
212 SchemaPath notificationPath = notification.getType();
213 Date notificationEventTime = null;
214 if (notification instanceof DOMEvent) {
215 notificationEventTime = ((DOMEvent) notification).getEventTime();
217 final String namespace = notification.getType().getLastComponent().getNamespace().toString();
218 for (NotificationTopicRegistration notifReg : notificationTopicRegistrations.get(namespace)) {
219 notifReg.setLastEventTime(notificationEventTime);
220 Set<TopicId> topicIdsForNotification = notifReg.getTopicsForNotification(notificationPath);
221 for (TopicId topicId : topicIdsForNotification) {
222 publishNotification(notification, topicId);
223 LOG.debug("Notification {} has been published for TopicId {}", notification.getType(),
229 private void publishNotification(final DOMNotification notification, final TopicId topicId) {
230 final ContainerNode topicNotification = Builders.containerBuilder().withNodeIdentifier(TOPIC_NOTIFICATION_ARG)
231 .withChild(ImmutableNodes.leafNode(TOPIC_ID_ARG, topicId))
232 .withChild(ImmutableNodes.leafNode(EVENT_SOURCE_ARG, mount.getNodeId()))
233 .withChild(encapsulate(notification))
236 domPublish.putNotification(new TopicDOMNotification(topicNotification));
237 } catch (final InterruptedException e) {
238 throw Throwables.propagate(e);
242 private AnyXmlNode encapsulate(final DOMNotification body) {
243 // FIXME: Introduce something like YangModeledAnyXmlNode in Yangtools
244 final Document doc = XmlUtil.newDocument();
245 final Optional<String> namespace = Optional.of(PAYLOAD_ARG.getNodeType().getNamespace().toString());
246 final Element element = XmlUtil.createElement(doc, "payload", namespace);
248 final DOMResult result = new DOMResult(element);
250 final SchemaContext context = mount.getSchemaContext();
251 final SchemaPath schemaPath = body.getType();
253 NetconfUtil.writeNormalizedNode(body.getBody(), result, schemaPath, context);
254 return Builders.anyXmlBuilder().withNodeIdentifier(PAYLOAD_ARG).withValue(new DOMSource(element)).build();
255 } catch (IOException | XMLStreamException e) {
256 LOG.error("Unable to encapsulate notification.", e);
257 throw Throwables.propagate(e);
262 * Returns all available notification paths that matches given pattern.
264 * @param notificationPattern pattern
265 * @return notification paths
267 private List<SchemaPath> getMatchingNotifications(final NotificationPattern notificationPattern) {
268 final String regex = notificationPattern.getValue();
270 final Pattern pattern = Pattern.compile(regex);
271 List<SchemaPath> availableNotifications = getAvailableNotifications();
272 return Util.expandQname(availableNotifications, pattern);
276 public void close() throws Exception {
277 for (NotificationTopicRegistration streamReg : notificationTopicRegistrations.values()) {
283 public NodeKey getSourceNodeKey() {
284 return mount.getNode().getKey();
288 public List<SchemaPath> getAvailableNotifications() {
290 final List<SchemaPath> availNotifList = new ArrayList<>();
291 // add Event Source Connection status notification
292 availNotifList.add(ConnectionNotificationTopicRegistration.EVENT_SOURCE_STATUS_PATH);
294 final Set<NotificationDefinition> availableNotifications = mount.getSchemaContext()
296 // add all known notifications from netconf device
297 for (final NotificationDefinition nd : availableNotifications) {
298 availNotifList.add(nd.getPath());
300 return availNotifList;
303 NetconfEventSourceMount getMount() {