opendaylight/md-sal/messagebus-impl/src/main/java/org/opendaylight/controller/messagebus/eventsources/netconf/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.eventsources.netconf;
  10
  11
  12 import com.google.common.base.Optional;
  13 import com.google.common.base.Preconditions;
  14 import java.util.HashMap;
  15 import java.util.List;
  16 import java.util.Map;
  17 import java.util.concurrent.ConcurrentHashMap;
  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.controller.messagebus.spi.EventSourceRegistration;
  30 import org.opendaylight.controller.messagebus.spi.EventSourceRegistry;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNode;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNodeFields.ConnectionStatus;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.network.topology.topology.topology.types.TopologyNetconf;
  34 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
  35 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  36 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TopologyId;
  37 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
  38 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
  39 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  40 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  41 import org.opendaylight.yangtools.yang.binding.DataObject;
  42 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  43 import org.opendaylight.yangtools.yang.common.QName;
  44 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  45 import org.slf4j.Logger;
  46 import org.slf4j.LoggerFactory;
  47
  48 public final class NetconfEventSourceManager implements DataChangeListener, AutoCloseable {
  49
  50     private static final Logger LOGGER = LoggerFactory.getLogger(NetconfEventSourceManager.class);
  51     private static final TopologyKey NETCONF_TOPOLOGY_KEY = new TopologyKey(new TopologyId(TopologyNetconf.QNAME.getLocalName()));
  52     private static final InstanceIdentifier<Node> NETCONF_DEVICE_PATH = InstanceIdentifier.create(NetworkTopology.class)
  53                 .child(Topology.class, NETCONF_TOPOLOGY_KEY)
  54                 .child(Node.class);
  55
  56     private static final YangInstanceIdentifier NETCONF_DEVICE_DOM_PATH = YangInstanceIdentifier.builder()
  57             .node(NetworkTopology.QNAME)
  58             .node(Topology.QNAME)
  59             .nodeWithKey(Topology.QNAME, QName.create(Topology.QNAME, "topology-id"),TopologyNetconf.QNAME.getLocalName())
  60             .node(Node.QNAME)
  61             .build();
  62     private static final QName NODE_ID_QNAME = QName.create(Node.QNAME,"node-id");
  63
  64     private final Map<String, String> streamMap;
  65     private final ConcurrentHashMap<InstanceIdentifier<?>, EventSourceRegistration<NetconfEventSource>> eventSourceRegistration = new ConcurrentHashMap<>();
  66     private final DOMNotificationPublishService publishService;
  67     private final DOMMountPointService domMounts;
  68     private final MountPointService bindingMounts;
  69     private ListenerRegistration<DataChangeListener> listenerRegistration;
  70     private final EventSourceRegistry eventSourceRegistry;
  71
  72     public static NetconfEventSourceManager create(final DataBroker dataBroker,
  73             final DOMNotificationPublishService domPublish,
  74             final DOMMountPointService domMount,
  75             final MountPointService bindingMount,
  76             final EventSourceRegistry eventSourceRegistry,
  77             final List<NamespaceToStream> namespaceMapping){
  78
  79         final NetconfEventSourceManager eventSourceManager =
  80                 new NetconfEventSourceManager(domPublish, domMount, bindingMount, eventSourceRegistry, namespaceMapping);
  81
  82         eventSourceManager.initialize(dataBroker);
  83
  84         return eventSourceManager;
  85
  86     }
  87
  88     private NetconfEventSourceManager(final DOMNotificationPublishService domPublish,
  89                               final DOMMountPointService domMount,
  90                               final MountPointService bindingMount,
  91                               final EventSourceRegistry eventSourceRegistry,
  92                               final List<NamespaceToStream> namespaceMapping) {
  93
  94         Preconditions.checkNotNull(domPublish);
  95         Preconditions.checkNotNull(domMount);
  96         Preconditions.checkNotNull(bindingMount);
  97         Preconditions.checkNotNull(eventSourceRegistry);
  98         Preconditions.checkNotNull(namespaceMapping);
  99         this.streamMap = namespaceToStreamMapping(namespaceMapping);
 100         this.domMounts = domMount;
 101         this.bindingMounts = bindingMount;
 102         this.publishService = domPublish;
 103         this.eventSourceRegistry = eventSourceRegistry;
 104     }
 105
 106     private void initialize(final DataBroker dataBroker){
 107         Preconditions.checkNotNull(dataBroker);
 108         listenerRegistration = dataBroker.registerDataChangeListener(LogicalDatastoreType.OPERATIONAL, NETCONF_DEVICE_PATH, this, DataChangeScope.SUBTREE);
 109         LOGGER.info("NetconfEventSourceManager initialized.");
 110     }
 111
 112     private Map<String,String> namespaceToStreamMapping(final List<NamespaceToStream> namespaceMapping) {
 113         final Map<String, String> streamMap = new HashMap<>(namespaceMapping.size());
 114
 115         for (final NamespaceToStream nToS  : namespaceMapping) {
 116             streamMap.put(nToS.getUrnPrefix(), nToS.getStreamName());
 117         }
 118
 119         return streamMap;
 120     }
 121
 122     @Override
 123     public void onDataChanged(final AsyncDataChangeEvent<InstanceIdentifier<?>, DataObject> event) {
 124
 125         LOGGER.debug("[DataChangeEvent<InstanceIdentifier<?>, DataObject>: {}]", event);
 126         for (final Map.Entry<InstanceIdentifier<?>, DataObject> changeEntry : event.getCreatedData().entrySet()) {
 127             if (changeEntry.getValue() instanceof Node) {
 128                 nodeUpdated(changeEntry.getKey(),(Node) changeEntry.getValue());
 129             }
 130         }
 131
 132         for (final Map.Entry<InstanceIdentifier<?>, DataObject> changeEntry : event.getUpdatedData().entrySet()) {
 133             if (changeEntry.getValue() instanceof Node) {
 134                 nodeUpdated(changeEntry.getKey(),(Node) changeEntry.getValue());
 135             }
 136         }
 137
 138     }
 139
 140     private void nodeUpdated(final InstanceIdentifier<?> key, final Node node) {
 141
 142         // we listen on node tree, therefore we should rather throw IllegalStateException when node is null
 143         if ( node == null ) {
 144             throw new IllegalStateException("Node is null");
 145         }
 146         if ( isNetconfNode(node) == false ) {
 147             LOGGER.debug("OnDataChanged Event. Not a Netconf node.");
 148             return;
 149         }
 150         if ( isEventSource(node) == false ) {
 151             LOGGER.debug("OnDataChanged Event. Node an EventSource node.");
 152             return;
 153         }
 154         if(node.getAugmentation(NetconfNode.class).getConnectionStatus() != ConnectionStatus.Connected ) {
 155             return;
 156         }
 157
 158         if(!eventSourceRegistration.containsKey(key)) {
 159             createEventSource(key,node);
 160         }
 161     }
 162
 163     private void createEventSource(final InstanceIdentifier<?> key, final Node node) {
 164         final Optional<DOMMountPoint> netconfMount = domMounts.getMountPoint(domMountPath(node.getNodeId()));
 165         final Optional<MountPoint> bindingMount = bindingMounts.getMountPoint(key);
 166
 167         if(netconfMount.isPresent() && bindingMount.isPresent()) {
 168
 169             final NetconfEventSource netconfEventSource =
 170                     new NetconfEventSource(node, streamMap, netconfMount.get(), publishService, bindingMount.get());
 171             final EventSourceRegistration<NetconfEventSource> registration = eventSourceRegistry.registerEventSource(netconfEventSource);
 172             eventSourceRegistration.putIfAbsent(key, registration);
 173
 174         }
 175     }
 176
 177     private YangInstanceIdentifier domMountPath(final NodeId nodeId) {
 178         return YangInstanceIdentifier.builder(NETCONF_DEVICE_DOM_PATH).nodeWithKey(Node.QNAME, NODE_ID_QNAME, nodeId.getValue()).build();
 179     }
 180
 181     private boolean isNetconfNode(final Node node)  {
 182         return node.getAugmentation(NetconfNode.class) != null ;
 183     }
 184
 185     private boolean isEventSource(final Node node) {
 186
 187         final NetconfNode netconfNode = node.getAugmentation(NetconfNode.class);
 188         return isEventSource(netconfNode);
 189
 190     }
 191
 192     private boolean isEventSource(final NetconfNode node) {
 193         if (node.getAvailableCapabilities() == null) {
 194             return false;
 195         }
 196         final List<String> capabilities = node.getAvailableCapabilities().getAvailableCapability();
 197         if(capabilities == null) {
 198              return false;
 199         }
 200         for (final String capability : node.getAvailableCapabilities().getAvailableCapability()) {
 201             if(capability.startsWith("(urn:ietf:params:xml:ns:netconf:notification")) {
 202                 return true;
 203             }
 204         }
 205
 206         return false;
 207     }
 208
 209     @Override
 210     public void close() {
 211         for(final EventSourceRegistration<NetconfEventSource> reg : eventSourceRegistration.values()){
 212             reg.close();
 213         }
 214         listenerRegistration.close();
 215     }
 216
 217 }