interfacemanager/interfacemanager-impl/src/main/java/org/opendaylight/genius/interfacemanager/listeners/TerminationPointStateListener.java

   1 /*
   2  * Copyright (c) 2016, 2017 Ericsson India Global Services Pvt Ltd. 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 package org.opendaylight.genius.interfacemanager.listeners;
   9
  10 import com.google.common.util.concurrent.ListenableFuture;
  11 import java.util.List;
  12 import java.util.concurrent.Callable;
  13 import javax.inject.Inject;
  14 import javax.inject.Singleton;
  15 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  16 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  17 import org.opendaylight.genius.datastoreutils.AsyncClusteredDataTreeChangeListenerBase;
  18 import org.opendaylight.genius.datastoreutils.DataStoreJobCoordinator;
  19 import org.opendaylight.genius.interfacemanager.IfmConstants;
  20 import org.opendaylight.genius.interfacemanager.InterfacemgrProvider;
  21 import org.opendaylight.genius.interfacemanager.commons.InterfaceManagerCommonUtils;
  22 import org.opendaylight.genius.interfacemanager.renderer.ovs.statehelpers.OvsInterfaceTopologyStateUpdateHelper;
  23 import org.opendaylight.genius.interfacemanager.renderer.ovs.utilities.IfmClusterUtils;
  24 import org.opendaylight.ovsdb.utils.southbound.utils.SouthboundUtils;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbTerminationPointAugmentation;
  26 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
  27 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
  28 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  29 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPoint;
  30 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  31 import org.slf4j.Logger;
  32 import org.slf4j.LoggerFactory;
  33
  34 @Singleton
  35 public class TerminationPointStateListener extends
  36         AsyncClusteredDataTreeChangeListenerBase<OvsdbTerminationPointAugmentation, TerminationPointStateListener> {
  37     private static final Logger LOG = LoggerFactory.getLogger(TerminationPointStateListener.class);
  38     private final DataBroker dataBroker;
  39     private final InterfacemgrProvider interfaceMgrProvider;
  40
  41     @Inject
  42
  43     public TerminationPointStateListener(DataBroker dataBroker,
  44                                          final InterfacemgrProvider interfaceMgrProvider) {
  45         this.dataBroker = dataBroker;
  46         this.interfaceMgrProvider = interfaceMgrProvider;
  47         this.registerListener(LogicalDatastoreType.OPERATIONAL, this.dataBroker);
  48     }
  49
  50     @Override
  51     protected InstanceIdentifier<OvsdbTerminationPointAugmentation> getWildCardPath() {
  52         return InstanceIdentifier.builder(NetworkTopology.class).child(Topology.class).child(Node.class)
  53                 .child(TerminationPoint.class).augmentation(OvsdbTerminationPointAugmentation.class).build();
  54     }
  55
  56     @Override
  57     protected TerminationPointStateListener getDataTreeChangeListener() {
  58         return TerminationPointStateListener.this;
  59     }
  60
  61     @Override
  62     protected void remove(InstanceIdentifier<OvsdbTerminationPointAugmentation> identifier,
  63             OvsdbTerminationPointAugmentation tpOld) {
  64         LOG.debug("Received remove DataChange Notification for ovsdb termination point {}", tpOld.getName());
  65
  66         String oldInterfaceName = SouthboundUtils.getExternalInterfaceIdValue(tpOld);
  67         interfaceMgrProvider.removeTerminationPointForInterface(oldInterfaceName);
  68         if (tpOld.getInterfaceBfdStatus() != null) {
  69             LOG.debug("Received termination point removed notification with bfd status values {}", tpOld.getName());
  70             DataStoreJobCoordinator jobCoordinator = DataStoreJobCoordinator.getInstance();
  71             RendererStateRemoveWorker rendererStateRemoveWorker = new RendererStateRemoveWorker(tpOld);
  72             jobCoordinator.enqueueJob(tpOld.getName(), rendererStateRemoveWorker);
  73         }
  74     }
  75
  76     @Override
  77     protected void update(InstanceIdentifier<OvsdbTerminationPointAugmentation> identifier,
  78             OvsdbTerminationPointAugmentation tpOld, OvsdbTerminationPointAugmentation tpNew) {
  79         LOG.debug("Received Update DataChange Notification for ovsdb termination point {}", tpNew.getName());
  80         if (tpNew.getInterfaceBfdStatus() != null
  81                 && (tpOld == null || !tpNew.getInterfaceBfdStatus().equals(tpOld.getInterfaceBfdStatus()))) {
  82             LOG.trace("Bfd Status changed for ovsdb termination point identifier: {},  old: {}, new: {}.", identifier,
  83                     tpOld, tpNew);
  84             DataStoreJobCoordinator jobCoordinator = DataStoreJobCoordinator.getInstance();
  85             RendererStateUpdateWorker rendererStateAddWorker = new RendererStateUpdateWorker(identifier, tpNew);
  86             jobCoordinator.enqueueJob(tpNew.getName(), rendererStateAddWorker, IfmConstants.JOB_MAX_RETRIES);
  87         }
  88         String newInterfaceName = SouthboundUtils.getExternalInterfaceIdValue(tpNew);
  89         String oldInterfaceName = SouthboundUtils.getExternalInterfaceIdValue(tpOld);
  90         interfaceMgrProvider.addTerminationPointForInterface(newInterfaceName, tpNew);
  91
  92         if (!IfmClusterUtils.isEntityOwner(IfmClusterUtils.INTERFACE_CONFIG_ENTITY)) {
  93             return;
  94         }
  95         String dpnId = interfaceMgrProvider.getDpidForInterface(newInterfaceName,
  96                         identifier.firstIdentifierOf(Node.class));
  97         if (dpnId != null && newInterfaceName != null &&
  98             (oldInterfaceName == null || !oldInterfaceName.equals(newInterfaceName))) {
  99             String parentRefName = InterfaceManagerCommonUtils.getPortNameForInterface(dpnId, tpNew.getName());
 100             LOG.debug(
 101                 "Detected update to termination point {} with external ID {}, updating parent ref "
 102                     + "of that interface ID to this termination point's interface-state name {}",
 103                 tpNew.getName(), newInterfaceName, parentRefName);
 104             interfaceMgrProvider.updateInterfaceParentRef(newInterfaceName, parentRefName);
 105         }
 106     }
 107
 108     @Override
 109     protected void add(InstanceIdentifier<OvsdbTerminationPointAugmentation> identifier,
 110             OvsdbTerminationPointAugmentation tpNew) {
 111         update(identifier, null, tpNew);
 112     }
 113
 114     private class RendererStateUpdateWorker implements Callable<List<ListenableFuture<Void>>> {
 115         InstanceIdentifier<OvsdbTerminationPointAugmentation> instanceIdentifier;
 116         OvsdbTerminationPointAugmentation terminationPointNew;
 117
 118         RendererStateUpdateWorker(InstanceIdentifier<OvsdbTerminationPointAugmentation> instanceIdentifier,
 119                 OvsdbTerminationPointAugmentation tpNew) {
 120             this.instanceIdentifier = instanceIdentifier;
 121             this.terminationPointNew = tpNew;
 122         }
 123
 124         @Override
 125         public List<ListenableFuture<Void>> call() {
 126             // If another renderer(for eg : CSS) needs to be supported, check
 127             // can be performed here
 128             // to call the respective helpers.
 129             return OvsInterfaceTopologyStateUpdateHelper.updateTunnelState(dataBroker, terminationPointNew);
 130         }
 131     }
 132
 133     private class RendererStateRemoveWorker implements Callable<List<ListenableFuture<Void>>> {
 134         OvsdbTerminationPointAugmentation terminationPointOld;
 135
 136         RendererStateRemoveWorker(OvsdbTerminationPointAugmentation tpNew) {
 137             this.terminationPointOld = tpNew;
 138         }
 139
 140         @Override
 141         public List<ListenableFuture<Void>> call() {
 142             LOG.debug("Removing bfd state from cache, if any, for {}", terminationPointOld.getName());
 143             InterfaceManagerCommonUtils.removeBfdStateFromCache(terminationPointOld.getName());
 144             return null;
 145         }
 146     }
 147 }