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 com.google.common.base.Preconditions;
12 import java.util.HashMap;
13 import java.util.List;
15 import java.util.concurrent.ConcurrentHashMap;
16 import org.opendaylight.controller.config.yang.messagebus.netconf.NamespaceToStream;
17 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
18 import org.opendaylight.controller.md.sal.binding.api.DataChangeListener;
19 import org.opendaylight.controller.md.sal.binding.api.MountPointService;
20 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker.DataChangeScope;
21 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataChangeEvent;
22 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
23 import org.opendaylight.controller.md.sal.dom.api.DOMMountPointService;
24 import org.opendaylight.controller.md.sal.dom.api.DOMNotificationPublishService;
25 import org.opendaylight.controller.messagebus.spi.EventSourceRegistry;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNode;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.network.topology.topology.topology.types.TopologyNetconf;
28 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
29 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TopologyId;
30 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
31 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
32 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
33 import org.opendaylight.yangtools.concepts.ListenerRegistration;
34 import org.opendaylight.yangtools.yang.binding.DataObject;
35 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
36 import org.slf4j.Logger;
37 import org.slf4j.LoggerFactory;
40 * NetconfEventSourceManager implements DataChangeListener. On topology changes, it manages creation,
41 * updating and removing registrations of event sources.
43 public final class NetconfEventSourceManager implements DataChangeListener, AutoCloseable {
45 private static final Logger LOG = LoggerFactory.getLogger(NetconfEventSourceManager.class);
46 private static final TopologyKey NETCONF_TOPOLOGY_KEY = new TopologyKey(
47 new TopologyId(TopologyNetconf.QNAME.getLocalName()));
48 private static final InstanceIdentifier<Node> NETCONF_DEVICE_PATH = InstanceIdentifier.create(NetworkTopology.class)
49 .child(Topology.class, NETCONF_TOPOLOGY_KEY).child(Node.class);
51 private final Map<String, String> streamMap;
52 private final ConcurrentHashMap<InstanceIdentifier<?>, NetconfEventSourceRegistration> registrationMap = new ConcurrentHashMap<>();
53 private final DOMNotificationPublishService publishService;
54 private final DOMMountPointService domMounts;
55 private ListenerRegistration<DataChangeListener> listenerRegistration;
56 private final EventSourceRegistry eventSourceRegistry;
58 public static NetconfEventSourceManager create(final DataBroker dataBroker,
59 final DOMNotificationPublishService domPublish, final DOMMountPointService domMount,
60 final MountPointService bindingMount, final EventSourceRegistry eventSourceRegistry,
61 final List<NamespaceToStream> namespaceMapping) {
63 final NetconfEventSourceManager eventSourceManager = new NetconfEventSourceManager(domPublish, domMount,
64 bindingMount, eventSourceRegistry, namespaceMapping);
66 eventSourceManager.initialize(dataBroker);
68 return eventSourceManager;
72 private NetconfEventSourceManager(final DOMNotificationPublishService domPublish,
73 final DOMMountPointService domMount, final MountPointService bindingMount,
74 final EventSourceRegistry eventSourceRegistry, final List<NamespaceToStream> namespaceMapping) {
76 Preconditions.checkNotNull(domPublish);
77 Preconditions.checkNotNull(domMount);
78 Preconditions.checkNotNull(eventSourceRegistry);
79 Preconditions.checkNotNull(namespaceMapping);
80 this.streamMap = namespaceToStreamMapping(namespaceMapping);
81 this.domMounts = domMount;
82 this.publishService = domPublish;
83 this.eventSourceRegistry = eventSourceRegistry;
86 private void initialize(final DataBroker dataBroker) {
87 Preconditions.checkNotNull(dataBroker);
88 listenerRegistration = dataBroker
89 .registerDataChangeListener(LogicalDatastoreType.OPERATIONAL, NETCONF_DEVICE_PATH, this,
90 DataChangeScope.SUBTREE);
91 LOG.info("NetconfEventSourceManager initialized.");
94 private Map<String, String> namespaceToStreamMapping(final List<NamespaceToStream> namespaceMapping) {
95 final Map<String, String> streamMap = new HashMap<>(namespaceMapping.size());
97 for (final NamespaceToStream nToS : namespaceMapping) {
98 streamMap.put(nToS.getUrnPrefix(), nToS.getStreamName());
104 @Override public void onDataChanged(final AsyncDataChangeEvent<InstanceIdentifier<?>, DataObject> event) {
106 LOG.debug("[DataChangeEvent<InstanceIdentifier<?>, DataObject>: {}]", event);
107 for (final Map.Entry<InstanceIdentifier<?>, DataObject> changeEntry : event.getCreatedData().entrySet()) {
108 if (changeEntry.getValue() instanceof Node) {
109 nodeCreated(changeEntry.getKey(), (Node) changeEntry.getValue());
113 for (final Map.Entry<InstanceIdentifier<?>, DataObject> changeEntry : event.getUpdatedData().entrySet()) {
114 if (changeEntry.getValue() instanceof Node) {
115 nodeUpdated(changeEntry.getKey(), (Node) changeEntry.getValue());
119 for (InstanceIdentifier<?> removePath : event.getRemovedPaths()) {
120 DataObject removeObject = event.getOriginalData().get(removePath);
121 if (removeObject instanceof Node) {
122 nodeRemoved(removePath);
128 private void nodeCreated(final InstanceIdentifier<?> key, final Node node) {
129 Preconditions.checkNotNull(key);
130 if (!validateNode(node)) {
131 LOG.warn("NodeCreated event : Node [{}] is null or not valid.", key.toString());
134 LOG.info("Netconf event source [{}] is creating...", key.toString());
135 NetconfEventSourceRegistration nesr = NetconfEventSourceRegistration.create(key, node, this);
137 NetconfEventSourceRegistration nesrOld = registrationMap.put(key, nesr);
138 if (nesrOld != null) {
144 private void nodeUpdated(final InstanceIdentifier<?> key, final Node node) {
145 Preconditions.checkNotNull(key);
146 if (!validateNode(node)) {
147 LOG.warn("NodeUpdated event : Node [{}] is null or not valid.", key.toString());
151 LOG.info("Netconf event source [{}] is updating...", key.toString());
152 NetconfEventSourceRegistration nesr = registrationMap.get(key);
156 nodeCreated(key, node);
160 private void nodeRemoved(final InstanceIdentifier<?> key) {
161 Preconditions.checkNotNull(key);
162 LOG.info("Netconf event source [{}] is removing...", key.toString());
163 NetconfEventSourceRegistration nesr = registrationMap.remove(key);
169 private boolean validateNode(final Node node) {
173 return isNetconfNode(node);
176 Map<String, String> getStreamMap() {
180 DOMNotificationPublishService getPublishService() {
181 return publishService;
184 DOMMountPointService getDomMounts() {
188 EventSourceRegistry getEventSourceRegistry() {
189 return eventSourceRegistry;
192 private boolean isNetconfNode(final Node node) {
193 return node.getAugmentation(NetconfNode.class) != null;
196 @Override public void close() {
197 listenerRegistration.close();
198 for (final NetconfEventSourceRegistration reg : registrationMap.values()) {
201 registrationMap.clear();