opendaylight/md-sal/messagebus-impl/src/main/java/org/opendaylight/controller/messagebus/app/impl/NetconfEventSourceManager.java

   1 /*
   2  * Copyright (c) 2015 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
   9 package org.opendaylight.controller.messagebus.app.impl;
  10
  11 import com.google.common.base.Optional;
  12
  13 import java.util.HashMap;
  14 import java.util.List;
  15 import java.util.Map;
  16 import java.util.concurrent.ConcurrentHashMap;
  17
  18 import org.opendaylight.controller.config.yang.messagebus.app.impl.NamespaceToStream;
  19 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  20 import org.opendaylight.controller.md.sal.binding.api.DataChangeListener;
  21 import org.opendaylight.controller.md.sal.binding.api.MountPoint;
  22 import org.opendaylight.controller.md.sal.binding.api.MountPointService;
  23 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker.DataChangeScope;
  24 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataChangeEvent;
  25 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  26 import org.opendaylight.controller.md.sal.dom.api.DOMMountPoint;
  27 import org.opendaylight.controller.md.sal.dom.api.DOMMountPointService;
  28 import org.opendaylight.controller.md.sal.dom.api.DOMNotificationPublishService;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNode;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNodeFields.ConnectionStatus;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.network.topology.topology.topology.types.TopologyNetconf;
  32 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
  33 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  34 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TopologyId;
  35 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
  36 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
  37 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  38 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  39 import org.opendaylight.yangtools.yang.binding.DataObject;
  40 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  41 import org.opendaylight.yangtools.yang.common.QName;
  42 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  43 import org.slf4j.Logger;
  44 import org.slf4j.LoggerFactory;
  45
  46 public final class NetconfEventSourceManager implements DataChangeListener, AutoCloseable {
  47
  48     private static final Logger LOGGER = LoggerFactory.getLogger(NetconfEventSourceManager.class);
  49     private static final TopologyKey NETCONF_TOPOLOGY_KEY = new TopologyKey(new TopologyId(TopologyNetconf.QNAME.getLocalName()));
  50     private static final InstanceIdentifier<Node> NETCONF_DEVICE_PATH = InstanceIdentifier.create(NetworkTopology.class)
  51                 .child(Topology.class, NETCONF_TOPOLOGY_KEY)
  52                 .child(Node.class);
  53
  54     private static final YangInstanceIdentifier NETCONF_DEVICE_DOM_PATH = YangInstanceIdentifier.builder()
  55             .node(NetworkTopology.QNAME)
  56             .node(Topology.QNAME)
  57             .nodeWithKey(Topology.QNAME, QName.create(Topology.QNAME, "topology-id"),TopologyNetconf.QNAME.getLocalName())
  58             .node(Node.QNAME)
  59             .build();
  60     private static final QName NODE_ID_QNAME = QName.create(Node.QNAME,"node-id");
  61
  62
  63     private final EventSourceTopology eventSourceTopology;
  64     private final Map<String, String> streamMap;
  65
  66     private final ConcurrentHashMap<InstanceIdentifier<?>, NetconfEventSource> netconfSources = new ConcurrentHashMap<>();
  67     private final ListenerRegistration<DataChangeListener> listenerReg;
  68     private final DOMNotificationPublishService publishService;
  69     private final DOMMountPointService domMounts;
  70     private final MountPointService bindingMounts;
  71
  72     public NetconfEventSourceManager(final DataBroker dataStore,
  73                               final DOMNotificationPublishService domPublish,
  74                               final DOMMountPointService domMount,
  75                               final MountPointService bindingMount,
  76                               final EventSourceTopology eventSourceTopology,
  77                               final List<NamespaceToStream> namespaceMapping) {
  78
  79         listenerReg = dataStore.registerDataChangeListener(LogicalDatastoreType.OPERATIONAL, NETCONF_DEVICE_PATH, this, DataChangeScope.SUBTREE);
  80         this.eventSourceTopology = eventSourceTopology;
  81         this.streamMap = namespaceToStreamMapping(namespaceMapping);
  82         this.domMounts = domMount;
  83         this.bindingMounts = bindingMount;
  84         this.publishService = domPublish;
  85         LOGGER.info("EventSourceManager initialized.");
  86     }
  87
  88     private Map<String,String> namespaceToStreamMapping(final List<NamespaceToStream> namespaceMapping) {
  89         final Map<String, String> streamMap = new HashMap<>(namespaceMapping.size());
  90
  91         for (final NamespaceToStream nToS  : namespaceMapping) {
  92             streamMap.put(nToS.getUrnPrefix(), nToS.getStreamName());
  93         }
  94
  95         return streamMap;
  96     }
  97
  98     @Override
  99     public void onDataChanged(final AsyncDataChangeEvent<InstanceIdentifier<?>, DataObject> event) {
 100         //FIXME: Prevent creating new event source on subsequent changes in inventory, like disconnect.
 101         LOGGER.debug("[DataChangeEvent<InstanceIdentifier<?>, DataObject>: {}]", event);
 102         for (final Map.Entry<InstanceIdentifier<?>, DataObject> changeEntry : event.getCreatedData().entrySet()) {
 103             if (changeEntry.getValue() instanceof Node) {
 104                 nodeUpdated(changeEntry.getKey(),(Node) changeEntry.getValue());
 105             }
 106         }
 107
 108
 109         for (final Map.Entry<InstanceIdentifier<?>, DataObject> changeEntry : event.getUpdatedData().entrySet()) {
 110             if (changeEntry.getValue() instanceof Node) {
 111                 nodeUpdated(changeEntry.getKey(),(Node) changeEntry.getValue());
 112             }
 113         }
 114
 115
 116     }
 117
 118     private void nodeUpdated(final InstanceIdentifier<?> key, final Node node) {
 119
 120         // we listen on node tree, therefore we should rather throw IllegalStateException when node is null
 121         if ( node == null ) {
 122             LOGGER.debug("OnDataChanged Event. Node is null.");
 123             return;
 124         }
 125         if ( isNetconfNode(node) == false ) {
 126             LOGGER.debug("OnDataChanged Event. Not a Netconf node.");
 127             return;
 128         }
 129         if ( isEventSource(node) == false ) {
 130             LOGGER.debug("OnDataChanged Event. Node an EventSource node.");
 131             return;
 132         }
 133         if(node.getAugmentation(NetconfNode.class).getConnectionStatus() != ConnectionStatus.Connected ) {
 134             return;
 135         }
 136
 137         if(!netconfSources.containsKey(key)) {
 138             createEventSource(key,node);
 139         }
 140     }
 141
 142     private void createEventSource(final InstanceIdentifier<?> key, final Node node) {
 143         final Optional<DOMMountPoint> netconfMount = domMounts.getMountPoint(domMountPath(node.getNodeId()));
 144         final Optional<MountPoint> bindingMount = bindingMounts.getMountPoint(key);
 145
 146         if(netconfMount.isPresent() && bindingMount.isPresent()) {
 147             final String nodeId = node.getNodeId().getValue();
 148             final NetconfEventSource netconfEventSource = new NetconfEventSource(nodeId, streamMap, netconfMount.get(), publishService, bindingMount.get());
 149             eventSourceTopology.register(node,netconfEventSource);
 150             netconfSources.putIfAbsent(key, netconfEventSource);
 151         }
 152     }
 153
 154     private YangInstanceIdentifier domMountPath(final NodeId nodeId) {
 155         return YangInstanceIdentifier.builder(NETCONF_DEVICE_DOM_PATH).nodeWithKey(Node.QNAME, NODE_ID_QNAME, nodeId.getValue()).build();
 156     }
 157
 158     private boolean isNetconfNode(final Node node)  {
 159         return node.getAugmentation(NetconfNode.class) != null ;
 160     }
 161
 162     public boolean isEventSource(final Node node) {
 163         final NetconfNode netconfNode = node.getAugmentation(NetconfNode.class);
 164
 165         return isEventSource(netconfNode);
 166     }
 167
 168     private boolean isEventSource(final NetconfNode node) {
 169         for (final String capability : node.getAvailableCapabilities().getAvailableCapability()) {
 170             if(capability.startsWith("(urn:ietf:params:xml:ns:netconf:notification")) {
 171                 return true;
 172             }
 173         }
 174
 175         return false;
 176     }
 177
 178     @Override
 179     public void close() {
 180         listenerReg.close();
 181     }
 182 }