Bump MRI upstreams
[openflowplugin.git] / applications / topology-lldp-discovery / src / main / java / org / opendaylight / openflowplugin / applications / topology / lldp / LLDPLinkAger.java
index 499d05e4102b37a682c25fc8f2413cf9626e6f58..2c2a181bbe54604986539cdb269b884216072b62 100644 (file)
  */
 package org.opendaylight.openflowplugin.applications.topology.lldp;
 
+import com.google.common.annotations.VisibleForTesting;
+import java.util.Collection;
 import java.util.Date;
-import java.util.Map;
-import java.util.Timer;
 import java.util.Map.Entry;
+import java.util.Timer;
 import java.util.TimerTask;
 import java.util.concurrent.ConcurrentHashMap;
-
+import java.util.concurrent.ConcurrentMap;
+import javax.annotation.PreDestroy;
+import javax.inject.Inject;
+import javax.inject.Singleton;
+import org.eclipse.jdt.annotation.NonNull;
+import org.opendaylight.mdsal.binding.api.ClusteredDataTreeChangeListener;
+import org.opendaylight.mdsal.binding.api.DataBroker;
+import org.opendaylight.mdsal.binding.api.DataObjectModification;
+import org.opendaylight.mdsal.binding.api.DataTreeIdentifier;
+import org.opendaylight.mdsal.binding.api.DataTreeModification;
+import org.opendaylight.mdsal.binding.api.NotificationPublishService;
+import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
+import org.opendaylight.mdsal.eos.binding.api.EntityOwnershipService;
+import org.opendaylight.openflowplugin.api.openflow.configuration.ConfigurationListener;
+import org.opendaylight.openflowplugin.api.openflow.configuration.ConfigurationService;
 import org.opendaylight.openflowplugin.applications.topology.lldp.utils.LLDPDiscoveryUtils;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.topology.discovery.rev130819.LinkDiscovered;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.topology.discovery.rev130819.LinkRemoved;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.topology.discovery.rev130819.LinkRemovedBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.lldp.discovery.config.rev160511.TopologyLldpDiscoveryConfig;
+import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
+import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TopologyId;
+import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
+import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
+import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Link;
+import org.opendaylight.yangtools.concepts.ListenerRegistration;
+import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
+@Singleton
+public final class LLDPLinkAger implements ConfigurationListener, ClusteredDataTreeChangeListener<Link>, AutoCloseable {
+    private static final Logger LOG = LoggerFactory.getLogger(LLDPLinkAger.class);
+    static final String TOPOLOGY_ID = "flow:1";
+    static final InstanceIdentifier<Link> II_TO_LINK = InstanceIdentifier.create(NetworkTopology.class)
+            .child(Topology.class, new TopologyKey(new TopologyId(TOPOLOGY_ID))).child(Link.class);
 
-public class LLDPLinkAger {
-    private static final LLDPLinkAger instance = new LLDPLinkAger();
-    private Map<LinkDiscovered,Date> linkToDate = new ConcurrentHashMap<LinkDiscovered,Date>();
-    private LLDPDiscoveryProvider manager;
-    private Timer timer = new Timer();
+    private final long linkExpirationTime;
+    // FIXME: use Instant instead of Date
+    private final ConcurrentMap<LinkDiscovered, Date> linkToDate = new ConcurrentHashMap<>();
+    private final Timer timer = new Timer();
+    private final NotificationPublishService notificationService;
+    private final AutoCloseable configurationServiceRegistration;
+    private final EntityOwnershipService eos;
+    private ListenerRegistration<?> listenerRegistration;
 
-    public LLDPDiscoveryProvider getManager() {
-        return manager;
-    }
-    public void setManager(LLDPDiscoveryProvider manager) {
-        this.manager = manager;
-    }
-    private LLDPLinkAger() {
-        timer.schedule(new LLDPAgingTask(), 0,LLDPDiscoveryUtils.LLDP_INTERVAL);
-    }
-    public static LLDPLinkAger getInstance() {
-        return instance;
+    /**
+     * default ctor - start timer.
+     */
+    @Inject
+    @SuppressWarnings("checkstyle:IllegalCatch")
+    public LLDPLinkAger(final TopologyLldpDiscoveryConfig topologyLldpDiscoveryConfig,
+                        final NotificationPublishService notificationService,
+                        final ConfigurationService configurationService,
+                        final EntityOwnershipService entityOwnershipService,
+                        final DataBroker dataBroker) {
+        linkExpirationTime = topologyLldpDiscoveryConfig.getTopologyLldpExpirationInterval().getValue().toJava();
+        this.notificationService = notificationService;
+        configurationServiceRegistration = configurationService.registerListener(this);
+        eos = entityOwnershipService;
+        final DataTreeIdentifier<Link> dtiToNodeConnector = DataTreeIdentifier.create(LogicalDatastoreType.OPERATIONAL,
+                II_TO_LINK);
+        try {
+            listenerRegistration = dataBroker.registerDataTreeChangeListener(dtiToNodeConnector, LLDPLinkAger.this);
+        } catch (Exception e) {
+            LOG.error("DataTreeChangeListeners registration failed:", e);
+            throw new IllegalStateException("LLDPLinkAger startup failed!", e);
+        }
+        timer.schedule(new LLDPAgingTask(), 0,
+            topologyLldpDiscoveryConfig.getTopologyLldpInterval().getValue().toJava());
     }
 
     public void put(LinkDiscovered link) {
         Date expires = new Date();
-        expires.setTime(expires.getTime() + LLDPDiscoveryUtils.LLDP_EXPIRATION_TIME);
+        expires.setTime(expires.getTime() + linkExpirationTime);
         linkToDate.put(link, expires);
     }
 
-    public void close() {
+    @Override
+    @PreDestroy
+    public void close() throws Exception {
+        if (listenerRegistration != null) {
+            listenerRegistration.close();
+            listenerRegistration = null;
+        }
         timer.cancel();
+        linkToDate.clear();
+        configurationServiceRegistration.close();
     }
 
-    private class LLDPAgingTask extends TimerTask {
+    @Override
+    public void onDataTreeChanged(@NonNull Collection<DataTreeModification<Link>> changes) {
+        for (DataTreeModification<Link> modification : changes) {
+            switch (modification.getRootNode().getModificationType()) {
+                case WRITE:
+                    break;
+                case SUBTREE_MODIFIED:
+                    // NOOP
+                    break;
+                case DELETE:
+                    processLinkDeleted(modification.getRootNode());
+                    break;
+                default:
+                    LOG.error("Unhandled modification type: {}", modification.getRootNode().getModificationType());
+            }
+        }
+    }
+
+    @VisibleForTesting
+    public boolean isLinkToDateEmpty() {
+        return linkToDate.isEmpty();
+    }
+
+    @Override
+    public void onPropertyChanged(@NonNull final String propertyName, @NonNull final String propertyValue) {
+        final TopologyLLDPDiscoveryProperty lldpDiscoveryProperty = TopologyLLDPDiscoveryProperty.forValue(
+                propertyName);
+        if (lldpDiscoveryProperty != null) {
+            switch (lldpDiscoveryProperty) {
+                case LLDP_SECURE_KEY:
+                case TOPOLOGY_LLDP_INTERVAL:
+                case TOPOLOGY_LLDP_EXPIRATION_INTERVAL:
+                    LOG.warn("Runtime update not supported for property {}", lldpDiscoveryProperty);
+                    break;
+                default:
+                    LOG.warn("No topology lldp discovery property found.");
+                    break;
+            }
+        }
+    }
+
+    protected boolean isLinkPresent(final LinkDiscovered linkDiscovered) {
+        return linkToDate.containsKey(linkDiscovered);
+    }
 
+    private void processLinkDeleted(DataObjectModification<Link> rootNode) {
+        Link link = rootNode.getDataBefore();
+        LOG.trace("Removing link {} from linkToDate cache", link);
+        LinkDiscovered linkDiscovered = LLDPDiscoveryUtils.toLLDPLinkDiscovered(link);
+        linkToDate.remove(linkDiscovered);
+    }
+
+    private class LLDPAgingTask extends TimerTask {
         @Override
         public void run() {
-            for (Entry<LinkDiscovered,Date> entry : linkToDate.entrySet()) {
+            for (Entry<LinkDiscovered, Date> entry : linkToDate.entrySet()) {
                 LinkDiscovered link = entry.getKey();
                 Date expires = entry.getValue();
                 Date now = new Date();
-                if(now.after(expires)) {
-                    if(getInstance().getManager() != null) {
+                if (now.after(expires)) {
+                    if (notificationService != null) {
                         LinkRemovedBuilder lrb = new LinkRemovedBuilder(link);
-                        getInstance().getManager().getNotificationService().publish(lrb.build());
+                        NodeKey nodeKey = link.getDestination().getValue().firstKeyOf(Node.class);
+                        LOG.info("No update received for link {} from last {} milliseconds. Removing link from cache.",
+                                link, linkExpirationTime);
                         linkToDate.remove(link);
+                        if (nodeKey != null && LLDPDiscoveryUtils.isEntityOwned(eos, nodeKey.getId().getValue())) {
+                            LOG.info("Publish Link Remove event for the link {}", link);
+                            final LinkRemoved lr = lrb.build();
+                            try {
+                                notificationService.putNotification(lr);
+                            } catch (InterruptedException e) {
+                                LOG.warn("Interrupted while publishing notification {}", lr, e);
+                            }
+                        } else {
+                            LOG.trace("Skip publishing Link Remove event for the link {} because link destination "
+                                    + "node is not owned by the controller", link);
+                        }
                     }
                 }
             }
-
         }
-
     }
 }
-