elanmanager/impl/src/main/java/org/opendaylight/netvirt/elan/internal/ElanServiceProvider.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
   9 package org.opendaylight.netvirt.elan.internal;
  10
  11 import com.google.common.base.Optional;
  12 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  13 import java.math.BigInteger;
  14 import java.util.ArrayList;
  15 import java.util.Collection;
  16 import java.util.Collections;
  17 import java.util.HashSet;
  18 import java.util.List;
  19 import java.util.Map;
  20 import java.util.Set;
  21 import java.util.concurrent.Future;
  22 import java.util.function.BiFunction;
  23 import javax.annotation.Nonnull;
  24 import javax.inject.Inject;
  25 import javax.inject.Singleton;
  26 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  27 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  28 import org.opendaylight.genius.interfacemanager.exceptions.InterfaceAlreadyExistsException;
  29 import org.opendaylight.genius.interfacemanager.globals.IfmConstants;
  30 import org.opendaylight.genius.interfacemanager.interfaces.IInterfaceManager;
  31 import org.opendaylight.genius.mdsalutil.MDSALUtil;
  32 import org.opendaylight.genius.mdsalutil.MatchInfoBase;
  33 import org.opendaylight.genius.mdsalutil.MetaDataUtil;
  34 import org.opendaylight.genius.mdsalutil.NwConstants;
  35 import org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager;
  36 import org.opendaylight.genius.mdsalutil.nxmatches.NxMatchRegister;
  37 import org.opendaylight.genius.utils.ServiceIndex;
  38 import org.opendaylight.genius.utils.hwvtep.HwvtepSouthboundConstants;
  39 import org.opendaylight.infrautils.inject.AbstractLifecycle;
  40 import org.opendaylight.mdsal.eos.binding.api.Entity;
  41 import org.opendaylight.mdsal.eos.binding.api.EntityOwnershipCandidateRegistration;
  42 import org.opendaylight.mdsal.eos.binding.api.EntityOwnershipService;
  43 import org.opendaylight.mdsal.eos.common.api.CandidateAlreadyRegisteredException;
  44 import org.opendaylight.netvirt.elan.arp.responder.ArpResponderInput;
  45 import org.opendaylight.netvirt.elan.arp.responder.ArpResponderUtil;
  46 import org.opendaylight.netvirt.elan.cache.ElanInstanceCache;
  47 import org.opendaylight.netvirt.elan.cache.ElanInterfaceCache;
  48 import org.opendaylight.netvirt.elan.utils.ElanConstants;
  49 import org.opendaylight.netvirt.elan.utils.ElanUtils;
  50 import org.opendaylight.netvirt.elanmanager.api.ElanHelper;
  51 import org.opendaylight.netvirt.elanmanager.api.IElanService;
  52 import org.opendaylight.ovsdb.utils.southbound.utils.SouthboundUtils;
  53 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.Interfaces;
  54 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
  55 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
  56 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.CreateIdPoolInput;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.CreateIdPoolInputBuilder;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.CreateIdPoolOutput;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.IfL2vlan;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.etree.rev160614.EtreeInstance;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.etree.rev160614.EtreeInstanceBuilder;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.etree.rev160614.EtreeInterface;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.etree.rev160614.EtreeInterface.EtreeInterfaceType;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.etree.rev160614.EtreeInterfaceBuilder;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.ElanInstances;
  68 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.ElanInterfaces;
  69 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan._interface.forwarding.entries.ElanInterfaceMac;
  70 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.dpn.interfaces.elan.dpn.interfaces.list.DpnInterfaces;
  71 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.instances.ElanInstance;
  72 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.instances.ElanInstanceBuilder;
  73 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.instances.ElanInstanceKey;
  74 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.ElanInterface;
  75 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.ElanInterfaceBuilder;
  76 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.ElanInterfaceKey;
  77 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.elan._interface.StaticMacEntries;
  78 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.elan._interface.StaticMacEntriesBuilder;
  79 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.state.Elan;
  80 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.forwarding.entries.MacEntry;
  81 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  82 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  83 import org.opendaylight.yangtools.yang.common.RpcResult;
  84 import org.slf4j.Logger;
  85 import org.slf4j.LoggerFactory;
  86
  87 @Singleton
  88 public class ElanServiceProvider extends AbstractLifecycle implements IElanService {
  89
  90     private static final Logger LOG = LoggerFactory.getLogger(ElanServiceProvider.class);
  91
  92     private final IdManagerService idManager;
  93     private final IInterfaceManager interfaceManager;
  94     private final ElanBridgeManager bridgeMgr;
  95     private final DataBroker broker;
  96     private final ElanUtils elanUtils;
  97     private final SouthboundUtils southboundUtils;
  98     private final IMdsalApiManager mdsalManager;
  99     private final ElanInstanceCache elanInstanceCache;
 100     private final ElanInterfaceCache elanInterfaceCache;
 101     private boolean isL2BeforeL3;
 102
 103     private final EntityOwnershipCandidateRegistration candidateRegistration;
 104
 105     @Inject
 106     public ElanServiceProvider(IdManagerService idManager, IInterfaceManager interfaceManager,
 107                                ElanBridgeManager bridgeMgr,
 108                                DataBroker dataBroker,
 109                                ElanUtils elanUtils,
 110                                EntityOwnershipService entityOwnershipService,
 111                                SouthboundUtils southboundUtils, ElanInstanceCache elanInstanceCache,
 112                                ElanInterfaceCache elanInterfaceCache, IMdsalApiManager mdsalManager) {
 113         this.idManager = idManager;
 114         this.interfaceManager = interfaceManager;
 115         this.bridgeMgr = bridgeMgr;
 116         this.broker = dataBroker;
 117         this.elanUtils = elanUtils;
 118         this.southboundUtils = southboundUtils;
 119         this.elanInstanceCache = elanInstanceCache;
 120         this.elanInterfaceCache = elanInterfaceCache;
 121         this.mdsalManager = mdsalManager;
 122
 123         candidateRegistration = registerCandidate(entityOwnershipService);
 124     }
 125
 126     private static EntityOwnershipCandidateRegistration registerCandidate(
 127             EntityOwnershipService entityOwnershipService) {
 128         try {
 129             return entityOwnershipService.registerCandidate(
 130                     new Entity(HwvtepSouthboundConstants.ELAN_ENTITY_TYPE, HwvtepSouthboundConstants.ELAN_ENTITY_TYPE));
 131         } catch (CandidateAlreadyRegisteredException e) {
 132             LOG.error("failed to register the entity");
 133             return null;
 134         }
 135     }
 136
 137     @Override
 138     @SuppressWarnings("checkstyle:IllegalCatch")
 139     protected void start() throws Exception {
 140         LOG.info("Starting ElanServiceProvider");
 141         setIsL2BeforeL3();
 142         createIdPool();
 143     }
 144
 145     @Override
 146     protected void stop() {
 147         if (candidateRegistration != null) {
 148             candidateRegistration.close();
 149         }
 150
 151         LOG.info("ElanServiceProvider stopped");
 152     }
 153
 154     @Override
 155     // Confusing with isOpenstackVniSemanticsEnforced but this is an interface method so can't change it.
 156     @SuppressFBWarnings("NM_CONFUSING")
 157     public Boolean isOpenStackVniSemanticsEnforced() {
 158         return elanUtils.isOpenstackVniSemanticsEnforced();
 159     }
 160
 161     private void createIdPool() throws Exception {
 162         CreateIdPoolInput createPool = new CreateIdPoolInputBuilder().setPoolName(ElanConstants.ELAN_ID_POOL_NAME)
 163                 .setLow(ElanConstants.ELAN_ID_LOW_VALUE).setHigh(ElanConstants.ELAN_ID_HIGH_VALUE).build();
 164         Future<RpcResult<CreateIdPoolOutput>> result = idManager.createIdPool(createPool);
 165         if (result != null && result.get().isSuccessful()) {
 166             LOG.debug("ELAN Id Pool is created successfully");
 167         }
 168     }
 169
 170     @Override
 171     public boolean createElanInstance(String elanInstanceName, long macTimeout, String description) {
 172         Optional<ElanInstance> existingElanInstance = elanInstanceCache.get(elanInstanceName);
 173         boolean isSuccess = true;
 174         if (existingElanInstance.isPresent()) {
 175             if (compareWithExistingElanInstance(existingElanInstance.get(), macTimeout, description)) {
 176                 LOG.debug("Elan Instance is already present in the Operational DS {}", existingElanInstance);
 177                 return true;
 178             } else {
 179                 ElanInstance updateElanInstance = new ElanInstanceBuilder().setElanInstanceName(elanInstanceName)
 180                         .setDescription(description).setMacTimeout(macTimeout)
 181                         .setKey(new ElanInstanceKey(elanInstanceName)).build();
 182                 MDSALUtil.syncWrite(broker, LogicalDatastoreType.CONFIGURATION,
 183                         ElanHelper.getElanInstanceConfigurationDataPath(elanInstanceName), updateElanInstance);
 184                 LOG.debug("Updating the Elan Instance {} with MAC TIME-OUT {} and Description {}",
 185                         updateElanInstance, macTimeout, description);
 186             }
 187         } else {
 188             ElanInstance elanInstance = new ElanInstanceBuilder().setElanInstanceName(elanInstanceName)
 189                     .setMacTimeout(macTimeout).setDescription(description).setKey(new ElanInstanceKey(elanInstanceName))
 190                     .build();
 191             MDSALUtil.syncWrite(broker, LogicalDatastoreType.CONFIGURATION,
 192                     ElanHelper.getElanInstanceConfigurationDataPath(elanInstanceName), elanInstance);
 193             LOG.debug("Creating the new Elan Instance {}", elanInstance);
 194         }
 195         return isSuccess;
 196     }
 197
 198     @Override
 199     public boolean createEtreeInstance(String elanInstanceName, long macTimeout, String description) {
 200         Optional<ElanInstance> existingElanInstance = elanInstanceCache.get(elanInstanceName);
 201         boolean isSuccess = true;
 202         if (existingElanInstance.isPresent()) {
 203             if (compareWithExistingElanInstance(existingElanInstance.get(), macTimeout, description)) {
 204                 LOG.warn("Etree Instance is already present in the Operational DS {}", existingElanInstance);
 205                 return true;
 206             } else {
 207                 EtreeInstance etreeInstance = new EtreeInstanceBuilder().build();
 208                 ElanInstance updateElanInstance = new ElanInstanceBuilder().setElanInstanceName(elanInstanceName)
 209                         .setDescription(description).setMacTimeout(macTimeout)
 210                         .setKey(new ElanInstanceKey(elanInstanceName))
 211                         .addAugmentation(EtreeInstance.class, etreeInstance).build();
 212                 MDSALUtil.syncWrite(broker, LogicalDatastoreType.CONFIGURATION,
 213                         ElanHelper.getElanInstanceConfigurationDataPath(elanInstanceName), updateElanInstance);
 214                 LOG.debug("Updating the Etree Instance {} with MAC TIME-OUT {} and Description {} ",
 215                         updateElanInstance, macTimeout, description);
 216             }
 217         } else {
 218             EtreeInstance etreeInstance = new EtreeInstanceBuilder().build();
 219             ElanInstance elanInstance = new ElanInstanceBuilder().setElanInstanceName(elanInstanceName)
 220                     .setMacTimeout(macTimeout).setDescription(description).setKey(new ElanInstanceKey(elanInstanceName))
 221                     .addAugmentation(EtreeInstance.class, etreeInstance).build();
 222             MDSALUtil.syncWrite(broker, LogicalDatastoreType.CONFIGURATION,
 223                     ElanHelper.getElanInstanceConfigurationDataPath(elanInstanceName), elanInstance);
 224             LOG.debug("Creating the new Etree Instance {}", elanInstance);
 225         }
 226         return isSuccess;
 227     }
 228
 229     @Override
 230     public EtreeInterface getEtreeInterfaceByElanInterfaceName(String elanInterface) {
 231         return elanInterfaceCache.getEtreeInterface(elanInterface).orNull();
 232     }
 233
 234     public static boolean compareWithExistingElanInstance(ElanInstance existingElanInstance, long macTimeOut,
 235             String description) {
 236         boolean isEqual = false;
 237         if (existingElanInstance.getMacTimeout() == macTimeOut
 238                 && existingElanInstance.getDescription().equals(description)) {
 239             isEqual = true;
 240         }
 241         return isEqual;
 242     }
 243
 244     @Override
 245     public void updateElanInstance(String elanInstanceName, long newMacTimout, String newDescription) {
 246         createElanInstance(elanInstanceName, newMacTimout, newDescription);
 247     }
 248
 249     @Override
 250     public boolean deleteEtreeInstance(String etreeInstanceName) {
 251         return deleteElanInstance(etreeInstanceName);
 252     }
 253
 254     @Override
 255     public boolean deleteElanInstance(String elanInstanceName) {
 256         boolean isSuccess = false;
 257         Optional<ElanInstance> existingElanInstance = elanInstanceCache.get(elanInstanceName);
 258         if (!existingElanInstance.isPresent()) {
 259             LOG.debug("Elan Instance is not present for {}", elanInstanceName);
 260             return isSuccess;
 261         }
 262         LOG.debug("Deletion of the existing Elan Instance {}", existingElanInstance);
 263         ElanUtils.delete(broker, LogicalDatastoreType.CONFIGURATION,
 264                 ElanHelper.getElanInstanceConfigurationDataPath(elanInstanceName));
 265         isSuccess = true;
 266         return isSuccess;
 267     }
 268
 269     @Override
 270     public void addEtreeInterface(String etreeInstanceName, String interfaceName, EtreeInterfaceType interfaceType,
 271             List<String> staticMacAddresses, String description) {
 272         Optional<ElanInstance> existingElanInstance = elanInstanceCache.get(etreeInstanceName);
 273         if (existingElanInstance.isPresent()
 274                 && existingElanInstance.get().getAugmentation(EtreeInstance.class) != null) {
 275             EtreeInterface etreeInterface = new EtreeInterfaceBuilder().setEtreeInterfaceType(interfaceType).build();
 276             ElanInterface elanInterface;
 277             if (staticMacAddresses == null) {
 278                 elanInterface = new ElanInterfaceBuilder().setElanInstanceName(etreeInstanceName)
 279                         .setDescription(description).setName(interfaceName).setKey(new ElanInterfaceKey(interfaceName))
 280                         .addAugmentation(EtreeInterface.class, etreeInterface).build();
 281             } else {
 282                 List<StaticMacEntries> staticMacEntries = ElanUtils.getStaticMacEntries(staticMacAddresses);
 283                 elanInterface = new ElanInterfaceBuilder().setElanInstanceName(etreeInstanceName)
 284                         .setDescription(description).setName(interfaceName)
 285                         .setStaticMacEntries(staticMacEntries)
 286                         .setKey(new ElanInterfaceKey(interfaceName))
 287                         .addAugmentation(EtreeInterface.class, etreeInterface).build();
 288             }
 289             MDSALUtil.syncWrite(broker, LogicalDatastoreType.CONFIGURATION,
 290                     ElanUtils.getElanInterfaceConfigurationDataPathId(interfaceName), elanInterface);
 291             LOG.debug("Creating the new Etree Interface {}", elanInterface);
 292         }
 293     }
 294
 295     @Override
 296     public void addElanInterface(String elanInstanceName, String interfaceName, List<String> staticMacAddresses,
 297             String description) {
 298         Optional<ElanInstance> existingElanInstance = elanInstanceCache.get(elanInstanceName);
 299         if (existingElanInstance.isPresent()) {
 300             ElanInterfaceBuilder elanInterfaceBuilder = new ElanInterfaceBuilder()
 301                     .setElanInstanceName(elanInstanceName)
 302                     .setDescription(description).setName(interfaceName)
 303                     .setKey(new ElanInterfaceKey(interfaceName));
 304             if (staticMacAddresses != null) {
 305                 List<StaticMacEntries> staticMacEntries = ElanUtils.getStaticMacEntries(staticMacAddresses);
 306                 elanInterfaceBuilder.setStaticMacEntries(staticMacEntries);
 307             }
 308             ElanInterface elanInterface = elanInterfaceBuilder.build();
 309             MDSALUtil.syncWrite(broker, LogicalDatastoreType.CONFIGURATION,
 310                     ElanUtils.getElanInterfaceConfigurationDataPathId(interfaceName), elanInterface);
 311             LOG.debug("Created the new ELan Interface {}", elanInterface);
 312         }
 313     }
 314
 315     @Override
 316     public void updateElanInterface(String elanInstanceName, String interfaceName,
 317             List<String> updatedStaticMacAddresses, String newDescription) {
 318         Optional<ElanInterface> existingElanInterface = elanInterfaceCache.get(interfaceName);
 319         if (!existingElanInterface.isPresent()) {
 320             return;
 321         }
 322
 323         List<StaticMacEntries> updatedStaticMacEntries = ElanUtils.getStaticMacEntries(updatedStaticMacAddresses);
 324         LOG.debug("updating the ElanInterface with new Mac Entries {}", updatedStaticMacAddresses);
 325         ElanInterface elanInterface = new ElanInterfaceBuilder().setElanInstanceName(elanInstanceName)
 326                 .setName(interfaceName).setDescription(newDescription).setStaticMacEntries(updatedStaticMacEntries)
 327                 .setKey(new ElanInterfaceKey(interfaceName)).build();
 328         MDSALUtil.syncWrite(broker, LogicalDatastoreType.CONFIGURATION,
 329                 ElanUtils.getElanInterfaceConfigurationDataPathId(interfaceName), elanInterface);
 330     }
 331
 332     @Override
 333     public void deleteEtreeInterface(String interfaceName) {
 334         deleteElanInterface(interfaceName);
 335         LOG.debug("deleting the Etree Interface {}", interfaceName);
 336     }
 337
 338     @Override
 339     public void deleteElanInterface(String interfaceName) {
 340         Optional<ElanInterface> existingElanInterface = elanInterfaceCache.get(interfaceName);
 341         if (existingElanInterface.isPresent()) {
 342             ElanUtils.delete(broker, LogicalDatastoreType.CONFIGURATION,
 343                     ElanUtils.getElanInterfaceConfigurationDataPathId(interfaceName));
 344             LOG.debug("deleting the Elan Interface {}", existingElanInterface);
 345         }
 346     }
 347
 348     @Override
 349     public void addStaticMacAddress(String interfaceName, String macAddress) {
 350         Optional<ElanInterface> existingElanInterface = elanInterfaceCache.get(interfaceName);
 351         if (existingElanInterface.isPresent()) {
 352             StaticMacEntriesBuilder staticMacEntriesBuilder = new StaticMacEntriesBuilder();
 353             StaticMacEntries staticMacEntry = staticMacEntriesBuilder.setMacAddress(
 354                     new PhysAddress(macAddress)).build();
 355             InstanceIdentifier<StaticMacEntries> staticMacEntriesIdentifier =
 356                     ElanUtils.getStaticMacEntriesCfgDataPathIdentifier(interfaceName, macAddress);
 357             MDSALUtil.syncWrite(broker, LogicalDatastoreType.CONFIGURATION, staticMacEntriesIdentifier, staticMacEntry);
 358         }
 359     }
 360
 361     @Override
 362     public void deleteStaticMacAddress(String interfaceName, String macAddress) {
 363         Optional<ElanInterface> existingElanInterface = elanInterfaceCache.get(interfaceName);
 364         if (existingElanInterface.isPresent()) {
 365             InstanceIdentifier<StaticMacEntries> staticMacEntriesIdentifier =
 366                     ElanUtils.getStaticMacEntriesCfgDataPathIdentifier(interfaceName,
 367                     macAddress);
 368             MDSALUtil.syncDelete(broker, LogicalDatastoreType.CONFIGURATION, staticMacEntriesIdentifier);
 369         }
 370     }
 371
 372     @Override
 373     public Collection<MacEntry> getElanMacTable(String elanInstanceName) {
 374         Elan elanInfo = ElanUtils.getElanByName(broker, elanInstanceName);
 375         List<MacEntry> macAddress = new ArrayList<>();
 376         if (elanInfo == null) {
 377             return macAddress;
 378         }
 379         List<String> elanInterfaces = elanInfo.getElanInterfaces();
 380         if (elanInterfaces != null && elanInterfaces.size() > 0) {
 381             for (String elanInterface : elanInterfaces) {
 382                 ElanInterfaceMac elanInterfaceMac = elanUtils.getElanInterfaceMacByInterfaceName(elanInterface);
 383                 if (elanInterfaceMac != null && elanInterfaceMac.getMacEntry() != null
 384                         && elanInterfaceMac.getMacEntry().size() > 0) {
 385                     macAddress.addAll(elanInterfaceMac.getMacEntry());
 386                 }
 387             }
 388         }
 389         return macAddress;
 390     }
 391
 392     @Override
 393     public void flushMACTable(String elanInstanceName) {
 394         Elan elanInfo = ElanUtils.getElanByName(broker, elanInstanceName);
 395         if (elanInfo == null) {
 396             return;
 397         }
 398         List<String> elanInterfaces = elanInfo.getElanInterfaces();
 399         if (elanInterfaces == null || elanInterfaces.isEmpty()) {
 400             return;
 401         }
 402         for (String elanInterface : elanInterfaces) {
 403             ElanInterfaceMac elanInterfaceMac = elanUtils.getElanInterfaceMacByInterfaceName(elanInterface);
 404             if (elanInterfaceMac.getMacEntry() != null && elanInterfaceMac.getMacEntry().size() > 0) {
 405                 List<MacEntry> macEntries = elanInterfaceMac.getMacEntry();
 406                 for (MacEntry macEntry : macEntries) {
 407                     deleteStaticMacAddress(elanInterface, macEntry.getMacAddress().getValue());
 408                 }
 409             }
 410         }
 411
 412     }
 413
 414     @Override
 415     public ElanInstance getElanInstance(String elanName) {
 416         return elanInstanceCache.get(elanName).orNull();
 417     }
 418
 419     @Override
 420     public List<ElanInstance> getElanInstances() {
 421         InstanceIdentifier<ElanInstances> elanInstancesIdentifier = InstanceIdentifier.builder(ElanInstances.class)
 422                 .build();
 423         return ElanUtils.read(broker, LogicalDatastoreType.CONFIGURATION, elanInstancesIdentifier).toJavaUtil().map(
 424                 ElanInstances::getElanInstance).orElse(Collections.emptyList());
 425     }
 426
 427     @Override
 428     @Nonnull
 429     public List<String> getElanInterfaces(String elanInstanceName) {
 430         List<String> elanInterfaces = new ArrayList<>();
 431         InstanceIdentifier<ElanInterfaces> elanInterfacesIdentifier = InstanceIdentifier.builder(ElanInterfaces.class)
 432                 .build();
 433         Optional<ElanInterfaces> elanInterfacesOptional = ElanUtils.read(broker, LogicalDatastoreType.CONFIGURATION,
 434                 elanInterfacesIdentifier);
 435         if (!elanInterfacesOptional.isPresent()) {
 436             return elanInterfaces;
 437         }
 438         List<ElanInterface> elanInterfaceList = elanInterfacesOptional.get().getElanInterface();
 439         for (ElanInterface elanInterface : elanInterfaceList) {
 440             if (elanInterface.getElanInstanceName().equals(elanInstanceName)) {
 441                 elanInterfaces.add(elanInterface.getName());
 442             }
 443         }
 444         return elanInterfaces;
 445     }
 446
 447     @Override
 448     public void createExternalElanNetworks(Node node) {
 449         handleExternalElanNetworks(node, true, (elanInstance, interfaceName) -> {
 450             createExternalElanNetwork(elanInstance, interfaceName);
 451             return null;
 452         });
 453     }
 454
 455     @Override
 456     public void createExternalElanNetwork(ElanInstance elanInstance) {
 457         handleExternalElanNetwork(elanInstance, false, (elanInstance1, interfaceName) -> {
 458             createExternalElanNetwork(elanInstance1, interfaceName);
 459             return null;
 460         });
 461     }
 462
 463     protected void createExternalElanNetwork(ElanInstance elanInstance, BigInteger dpId) {
 464         String providerIntfName = bridgeMgr.getProviderInterfaceName(dpId, elanInstance.getPhysicalNetworkName());
 465         String intfName = providerIntfName + IfmConstants.OF_URI_SEPARATOR + elanInstance.getSegmentationId();
 466         Interface memberIntf = interfaceManager.getInterfaceInfoFromConfigDataStore(intfName);
 467         if (memberIntf == null) {
 468             LOG.debug("creating vlan prv intf in elan {}, dpn {}", elanInstance.getElanInstanceName(),
 469                     dpId);
 470             createExternalElanNetwork(elanInstance, providerIntfName);
 471         }
 472     }
 473
 474     private void createExternalElanNetwork(ElanInstance elanInstance, String interfaceName) {
 475         if (interfaceName == null) {
 476             LOG.trace("No physical interface is attached to {}", elanInstance.getPhysicalNetworkName());
 477             return;
 478         }
 479
 480         String elanInterfaceName = createIetfInterfaces(elanInstance, interfaceName);
 481         addElanInterface(elanInstance.getElanInstanceName(), elanInterfaceName, null, null);
 482     }
 483
 484     @Override
 485     public void updateExternalElanNetwork(ElanInstance elanInstance) {
 486         handleExternalElanNetwork(elanInstance, true, (elanInstance1, interfaceName) -> {
 487             createExternalElanNetwork(elanInstance1, interfaceName);
 488             return null;
 489         });
 490     }
 491
 492     @Override
 493     public void deleteExternalElanNetworks(Node node) {
 494         handleExternalElanNetworks(node, false, (elanInstance, interfaceName) -> {
 495             deleteExternalElanNetwork(elanInstance, interfaceName);
 496             return null;
 497         });
 498     }
 499
 500     @Override
 501     public void deleteExternalElanNetwork(ElanInstance elanInstance) {
 502         handleExternalElanNetwork(elanInstance, false, (elanInstance1, interfaceName) -> {
 503             deleteExternalElanNetwork(elanInstance1, interfaceName);
 504             return null;
 505         });
 506     }
 507
 508     protected void deleteExternalElanNetwork(ElanInstance elanInstance, BigInteger dpnId) {
 509         String providerIntfName = bridgeMgr.getProviderInterfaceName(dpnId, elanInstance.getPhysicalNetworkName());
 510         String intfName = providerIntfName + IfmConstants.OF_URI_SEPARATOR + elanInstance.getSegmentationId();
 511         Interface memberIntf = interfaceManager.getInterfaceInfoFromConfigDataStore(intfName);
 512         if (memberIntf != null) {
 513             deleteElanInterface(intfName);
 514             deleteIetfInterface(intfName);
 515             LOG.debug("delete vlan prv intf {} in elan {}, dpID {}", intfName,
 516                     elanInstance.getElanInstanceName(), dpnId);
 517         } else {
 518             LOG.debug("vlan prv intf {} not found in interfacemgr config DS", intfName);
 519         }
 520     }
 521
 522     private void deleteExternalElanNetwork(ElanInstance elanInstance, String interfaceName) {
 523         if (interfaceName == null) {
 524             LOG.trace("No physial interface is attached to {}", elanInstance.getPhysicalNetworkName());
 525             return;
 526         }
 527
 528         String elanInstanceName = elanInstance.getElanInstanceName();
 529         for (String elanInterface : getExternalElanInterfaces(elanInstanceName)) {
 530             if (elanInterface.startsWith(interfaceName)) {
 531                 if (ElanUtils.isVlan(elanInstance)) {
 532                     deleteIetfInterface(elanInterface);
 533                 }
 534                 String trunkInterfaceName = getTrunkInterfaceName(interfaceName);
 535                 if (shouldDeleteTrunk(trunkInterfaceName, elanInterface)) {
 536                     deleteIetfInterface(trunkInterfaceName);
 537                 }
 538                 deleteElanInterface(elanInterface);
 539             }
 540         }
 541     }
 542
 543     private boolean shouldDeleteTrunk(String trunkInterfaceName, String elanInterfaceName) {
 544         List<Interface> childInterfaces = interfaceManager.getChildInterfaces(trunkInterfaceName);
 545         if (childInterfaces == null || childInterfaces.isEmpty()
 546                 || childInterfaces.size() == 1 && elanInterfaceName.equals(childInterfaces.get(0).getName())) {
 547             LOG.debug("No more VLAN member interfaces left for trunk {}", trunkInterfaceName);
 548             return true;
 549         }
 550
 551         LOG.debug("Trunk interface {} has {} VLAN member interfaces left", trunkInterfaceName, childInterfaces.size());
 552         return false;
 553     }
 554
 555     @Override
 556     public void updateExternalElanNetworks(Node origNode, Node updatedNode) {
 557         if (!bridgeMgr.isIntegrationBridge(updatedNode)) {
 558             return;
 559         }
 560
 561         List<ElanInstance> elanInstances = getElanInstances();
 562         if (elanInstances == null || elanInstances.isEmpty()) {
 563             LOG.trace("No ELAN instances found");
 564             return;
 565         }
 566
 567         LOG.debug("updateExternalElanNetworks, orig bridge {} . updated bridge {}", origNode, updatedNode);
 568
 569         Map<String, String> origProviderMappping = getMapFromOtherConfig(origNode,
 570                 ElanBridgeManager.PROVIDER_MAPPINGS_KEY);
 571         Map<String, String> updatedProviderMappping = getMapFromOtherConfig(updatedNode,
 572                 ElanBridgeManager.PROVIDER_MAPPINGS_KEY);
 573
 574         boolean hasDatapathIdOnOrigNode = bridgeMgr.hasDatapathID(origNode);
 575         boolean hasDatapathIdOnUpdatedNode = bridgeMgr.hasDatapathID(updatedNode);
 576         BigInteger origDpnID = bridgeMgr.getDatapathId(origNode);
 577
 578         for (ElanInstance elanInstance : elanInstances) {
 579             String physicalNetworkName = elanInstance.getPhysicalNetworkName();
 580             boolean createExternalElanNw = true;
 581             if (physicalNetworkName != null) {
 582                 String origPortName = origProviderMappping.get(physicalNetworkName);
 583                 String updatedPortName = updatedProviderMappping.get(physicalNetworkName);
 584                 /**
 585                  * for internal vlan network, vlan provider interface creation should be
 586                  * triggered only if there is existing vlan provider intf indicating presence
 587                  * of VM ports on the DPN
 588                  */
 589                 if (hasDatapathIdOnOrigNode && !elanInstance.isExternal()
 590                         && ElanUtils.isVlan(elanInstance)) {
 591                     String externalIntf = getExternalElanInterface(elanInstance.getElanInstanceName(),
 592                             origDpnID);
 593                     if (externalIntf == null) {
 594                         createExternalElanNw = false;
 595                     }
 596                 }
 597                 if (hasPortNameRemoved(origPortName, updatedPortName)) {
 598                     deleteExternalElanNetwork(elanInstance,
 599                             bridgeMgr.getProviderInterfaceName(origNode, physicalNetworkName));
 600                 }
 601
 602                 if (createExternalElanNw && (hasPortNameUpdated(origPortName, updatedPortName)
 603                         || hasDatapathIdAdded(hasDatapathIdOnOrigNode, hasDatapathIdOnUpdatedNode))) {
 604                     createExternalElanNetwork(elanInstance,
 605                             bridgeMgr.getProviderInterfaceName(updatedNode, physicalNetworkName));
 606                 }
 607             }
 608         }
 609     }
 610
 611     private boolean hasDatapathIdAdded(boolean hasDatapathIdOnOrigNode, boolean hasDatapathIdOnUpdatedNode) {
 612         return !hasDatapathIdOnOrigNode && hasDatapathIdOnUpdatedNode;
 613     }
 614
 615     private boolean hasPortNameUpdated(String origPortName, String updatedPortName) {
 616         return updatedPortName != null && !updatedPortName.equals(origPortName);
 617     }
 618
 619     private boolean hasPortNameRemoved(String origPortName, String updatedPortName) {
 620         return origPortName != null && !origPortName.equals(updatedPortName);
 621     }
 622
 623     private Map<String, String> getMapFromOtherConfig(Node node, String otherConfigColumn) {
 624         return bridgeMgr.getOpenvswitchOtherConfigMap(node, otherConfigColumn);
 625     }
 626
 627     @Override
 628     public Collection<String> getExternalElanInterfaces(String elanInstanceName) {
 629         List<String> elanInterfaces = getElanInterfaces(elanInstanceName);
 630         if (elanInterfaces.isEmpty()) {
 631             LOG.trace("No ELAN interfaces defined for {}", elanInstanceName);
 632             return Collections.emptySet();
 633         }
 634
 635         Set<String> externalElanInterfaces = new HashSet<>();
 636         for (String elanInterface : elanInterfaces) {
 637             if (interfaceManager.isExternalInterface(elanInterface)) {
 638                 externalElanInterfaces.add(elanInterface);
 639             }
 640         }
 641
 642         return externalElanInterfaces;
 643     }
 644
 645     @Override
 646     public String getExternalElanInterface(String elanInstanceName, BigInteger dpnId) {
 647         return elanUtils.getExternalElanInterface(elanInstanceName, dpnId);
 648     }
 649
 650     @Override
 651     public boolean isExternalInterface(String interfaceName) {
 652         return interfaceManager.isExternalInterface(interfaceName);
 653     }
 654
 655     @Override
 656     public ElanInterface getElanInterfaceByElanInterfaceName(String interfaceName) {
 657         return elanInterfaceCache.get(interfaceName).orNull();
 658     }
 659
 660     @Override
 661     public void handleKnownL3DmacAddress(String macAddress, String elanInstanceName, int addOrRemove) {
 662         if (addOrRemove == NwConstants.ADD_FLOW) {
 663             addKnownL3DmacAddress(macAddress, elanInstanceName);
 664         } else {
 665             removeKnownL3DmacAddress(macAddress, elanInstanceName);
 666         }
 667     }
 668
 669     @Override
 670     public void addKnownL3DmacAddress(String macAddress, String elanInstanceName) {
 671         if (!isL2BeforeL3) {
 672             LOG.trace("ELAN service is after L3VPN in the Netvirt pipeline skip known L3DMAC flows installation");
 673             return;
 674         }
 675         ElanInstance elanInstance = elanInstanceCache.get(elanInstanceName).orNull();
 676         if (elanInstance == null) {
 677             LOG.warn("Null elan instance {}", elanInstanceName);
 678             return;
 679         }
 680
 681         List<BigInteger> dpnsIdsForElanInstance = elanUtils.getParticipatingDpnsInElanInstance(elanInstanceName);
 682         if (dpnsIdsForElanInstance.isEmpty()) {
 683             LOG.warn("No DPNs for elan instance {}", elanInstance);
 684             return;
 685         }
 686
 687         elanUtils.addDmacRedirectToDispatcherFlows(elanInstance.getElanTag(), elanInstanceName, macAddress,
 688                 dpnsIdsForElanInstance);
 689     }
 690
 691     @Override
 692     public void removeKnownL3DmacAddress(String macAddress, String elanInstanceName) {
 693         if (!isL2BeforeL3) {
 694             LOG.trace("ELAN service is after L3VPN in the Netvirt pipeline skip known L3DMAC flows installation");
 695             return;
 696         }
 697         ElanInstance elanInstance = elanInstanceCache.get(elanInstanceName).orNull();
 698         if (elanInstance == null) {
 699             LOG.warn("Null elan instance {}", elanInstanceName);
 700             return;
 701         }
 702
 703         List<BigInteger> dpnsIdsForElanInstance = elanUtils.getParticipatingDpnsInElanInstance(elanInstanceName);
 704         if (dpnsIdsForElanInstance.isEmpty()) {
 705             LOG.warn("No DPNs for elan instance {}", elanInstance);
 706             return;
 707         }
 708
 709         elanUtils.removeDmacRedirectToDispatcherFlows(elanInstance.getElanTag(), macAddress, dpnsIdsForElanInstance);
 710     }
 711
 712     @Override
 713     public List<MatchInfoBase> getEgressMatchesForElanInstance(String elanInstanceName) {
 714         ElanInstance elanInstance = getElanInstance(elanInstanceName);
 715         if (elanInstance == null) {
 716             LOG.debug("No ELAN instance found for {}", elanInstanceName);
 717             return Collections.emptyList();
 718         }
 719
 720         Long elanTag = elanInstance.getElanTag();
 721         if (elanTag == null) {
 722             LOG.debug("No ELAN tag found for {}", elanInstanceName);
 723             return Collections.emptyList();
 724         }
 725         return Collections.singletonList(
 726                 new NxMatchRegister(ElanConstants.ELAN_REG_ID, elanTag, MetaDataUtil.getElanMaskForReg()));
 727     }
 728
 729     /**
 730      * Create ietf-interfaces based on the ELAN segment type.<br>
 731      * For segment type flat - create transparent interface pointing to the
 732      * patch-port attached to the physnet port.<br>
 733      * For segment type vlan - create trunk interface pointing to the patch-port
 734      * attached to the physnet port + trunk-member interface pointing to the
 735      * trunk interface.
 736      *
 737      * @param elanInstance
 738      *            ELAN instance
 739      * @param parentRef
 740      *            parent interface name
 741      * @return the name of the interface to be added to the ELAN instance i.e.
 742      *         trunk-member name for vlan network and transparent for flat
 743      *         network or null otherwise
 744      */
 745     private String createIetfInterfaces(ElanInstance elanInstance, String parentRef) {
 746         String interfaceName = null;
 747
 748         try {
 749             String trunkName = getTrunkInterfaceName(parentRef);
 750             // trunk interface may have been created by other vlan network
 751             Interface trunkInterface = interfaceManager.getInterfaceInfoFromConfigDataStore(trunkName);
 752             if (trunkInterface == null) {
 753                 interfaceManager.createVLANInterface(trunkName, parentRef, null, null,
 754                         IfL2vlan.L2vlanMode.Trunk, true);
 755             }
 756             if (ElanUtils.isFlat(elanInstance)) {
 757                 interfaceName = trunkName;
 758             } else if (ElanUtils.isVlan(elanInstance)) {
 759                 Long segmentationId = elanInstance.getSegmentationId();
 760                 interfaceName = parentRef + IfmConstants.OF_URI_SEPARATOR + segmentationId;
 761                 interfaceManager.createVLANInterface(interfaceName, trunkName, segmentationId.intValue(), null,
 762                         IfL2vlan.L2vlanMode.TrunkMember, true);
 763             }
 764         } catch (InterfaceAlreadyExistsException e) {
 765             LOG.trace("Interface {} was already created", interfaceName);
 766         }
 767
 768         return interfaceName;
 769     }
 770
 771     private void deleteIetfInterface(String interfaceName) {
 772         InterfaceKey interfaceKey = new InterfaceKey(interfaceName);
 773         InstanceIdentifier<Interface> interfaceInstanceIdentifier = InstanceIdentifier.builder(Interfaces.class)
 774                 .child(Interface.class, interfaceKey).build();
 775         MDSALUtil.syncDelete(broker, LogicalDatastoreType.CONFIGURATION, interfaceInstanceIdentifier);
 776         LOG.debug("Deleting IETF interface {}", interfaceName);
 777     }
 778
 779     private void handleExternalElanNetworks(Node node, boolean skipIntVlanNw,
 780                                             BiFunction<ElanInstance, String, Void> function) {
 781         if (!bridgeMgr.isIntegrationBridge(node)) {
 782             return;
 783         }
 784
 785         List<ElanInstance> elanInstances = getElanInstances();
 786         if (elanInstances == null || elanInstances.isEmpty()) {
 787             LOG.trace("No ELAN instances found");
 788             return;
 789         }
 790
 791         for (ElanInstance elanInstance : elanInstances) {
 792             if (skipIntVlanNw && !elanInstance.isExternal() && ElanUtils.isVlan(elanInstance)) {
 793                 continue;
 794             }
 795             String interfaceName = bridgeMgr.getProviderInterfaceName(node, elanInstance.getPhysicalNetworkName());
 796             if (interfaceName != null) {
 797                 function.apply(elanInstance, interfaceName);
 798             }
 799         }
 800     }
 801
 802     private void handleExternalElanNetwork(ElanInstance elanInstance, boolean update,
 803                                            BiFunction<ElanInstance, String, Void> function) {
 804         String elanInstanceName = elanInstance.getElanInstanceName();
 805         if (elanInstance.getPhysicalNetworkName() == null) {
 806             LOG.trace("No physical network attached to {}", elanInstanceName);
 807             return;
 808         }
 809
 810         List<Node> nodes = southboundUtils.getOvsdbNodes();
 811         if (nodes == null || nodes.isEmpty()) {
 812             LOG.trace("No OVS nodes found while creating external network for ELAN {}",
 813                     elanInstance.getElanInstanceName());
 814             return;
 815         }
 816
 817         for (Node node : nodes) {
 818             if (bridgeMgr.isIntegrationBridge(node)) {
 819                 if (update && !elanInstance.isExternal()) {
 820                     DpnInterfaces dpnInterfaces = elanUtils.getElanInterfaceInfoByElanDpn(elanInstanceName,
 821                             bridgeMgr.getDatapathId(node));
 822                     if (dpnInterfaces == null || dpnInterfaces.getInterfaces().isEmpty()) {
 823                         continue;
 824                     }
 825                 }
 826                 String interfaceName = bridgeMgr.getProviderInterfaceName(node, elanInstance.getPhysicalNetworkName());
 827                 function.apply(elanInstance, interfaceName);
 828             }
 829         }
 830     }
 831
 832     private String getTrunkInterfaceName(String parentRef) {
 833         return parentRef + IfmConstants.OF_URI_SEPARATOR + "trunk";
 834     }
 835
 836     private void setIsL2BeforeL3() {
 837         short elanServiceRealIndex = ServiceIndex.getIndex(NwConstants.ELAN_SERVICE_NAME,
 838                 NwConstants.ELAN_SERVICE_INDEX);
 839         short l3vpnServiceRealIndex = ServiceIndex.getIndex(NwConstants.L3VPN_SERVICE_NAME,
 840                 NwConstants.L3VPN_SERVICE_INDEX);
 841         if (elanServiceRealIndex < l3vpnServiceRealIndex) {
 842             LOG.info("ELAN service is set before L3VPN service in the Netvirt pipeline");
 843             isL2BeforeL3 = true;
 844         } else {
 845             LOG.info("ELAN service is set after L3VPN service in the Netvirt pipeline");
 846             isL2BeforeL3 = false;
 847         }
 848     }
 849
 850     @Override
 851     public void addArpResponderFlow(ArpResponderInput arpResponderInput) {
 852         String ingressInterfaceName = arpResponderInput.getInterfaceName();
 853         String macAddress = arpResponderInput.getSha();
 854         String ipAddress = arpResponderInput.getSpa();
 855         int lportTag = arpResponderInput.getLportTag();
 856         BigInteger dpnId = arpResponderInput.getDpId();
 857
 858         LOG.info("Installing the ARP responder flow on DPN {} for Interface {} with MAC {} & IP {}", dpnId,
 859                 ingressInterfaceName, macAddress, ipAddress);
 860         Optional<ElanInterface> elanIface = elanInterfaceCache.get(ingressInterfaceName);
 861         ElanInstance elanInstance = elanIface.isPresent()
 862                 ? elanInstanceCache.get(elanIface.get().getElanInstanceName()).orNull() : null;
 863         if (elanInstance == null) {
 864             LOG.debug("addArpResponderFlow: elanInstance is null, Failed to install arp responder flow for dpnId {}"
 865                     + "for Interface {} with MAC {} & IP {}", dpnId, ingressInterfaceName, macAddress, ipAddress);
 866             return;
 867         }
 868         String flowId = ArpResponderUtil.getFlowId(lportTag, ipAddress);
 869         ArpResponderUtil.installFlow(mdsalManager, dpnId, flowId, flowId, NwConstants.DEFAULT_ARP_FLOW_PRIORITY,
 870                 ArpResponderUtil.generateCookie(lportTag, ipAddress),
 871                 ArpResponderUtil.getMatchCriteria(lportTag, elanInstance, ipAddress),
 872                 arpResponderInput.getInstructions());
 873         LOG.info("Installed the ARP Responder flow for Interface {}", ingressInterfaceName);
 874     }
 875
 876     @Override
 877     public void addExternalTunnelArpResponderFlow(ArpResponderInput arpResponderInput, String elanInstanceName) {
 878         BigInteger dpnId = arpResponderInput.getDpId();
 879         String ipAddress = arpResponderInput.getSpa();
 880         String macAddress = arpResponderInput.getSha();
 881
 882         LOG.trace("Installing the ExternalTunnel ARP responder flow on DPN {} for ElanInstance {} with MAC {} & IP {}",
 883                 dpnId, elanInstanceName, macAddress, ipAddress);
 884
 885         ElanInstance elanInstance = elanInstanceCache.get(elanInstanceName).orNull();
 886         if (elanInstance == null) {
 887             LOG.warn("Null elan instance {}", elanInstanceName);
 888             return;
 889         }
 890
 891         int lportTag = arpResponderInput.getLportTag();
 892         String flowId = ArpResponderUtil.getFlowId(lportTag, ipAddress);
 893         ArpResponderUtil.installFlow(mdsalManager, dpnId, flowId, flowId, NwConstants.DEFAULT_ARP_FLOW_PRIORITY,
 894                 ArpResponderUtil.generateCookie(lportTag, ipAddress), ArpResponderUtil.getMatchCriteria(lportTag,
 895                         elanInstance, ipAddress), arpResponderInput.getInstructions());
 896         LOG.trace("Installed the ExternalTunnel ARP Responder flow for ElanInstance {}", elanInstanceName);
 897     }
 898
 899     @Override
 900     public void removeArpResponderFlow(ArpResponderInput arpResponderInput) {
 901         elanUtils.removeArpResponderFlow(arpResponderInput.getDpId(), arpResponderInput.getInterfaceName(),
 902                 arpResponderInput.getSpa(), arpResponderInput.getLportTag());
 903     }
 904
 905     /**
 906      * Uses the IdManager to retrieve a brand new ElanTag.
 907      *
 908      * @param idKey
 909      *            the id key
 910      * @return the integer
 911      */
 912     @Override
 913     public Long retrieveNewElanTag(String idKey) {
 914         return elanUtils.retrieveNewElanTag(idManager, idKey);
 915     }
 916
 917     @Override
 918     public InstanceIdentifier<DpnInterfaces> getElanDpnInterfaceOperationalDataPath(
 919                                                                 String elanInstanceName, BigInteger dpnId) {
 920         return ElanUtils.getElanDpnInterfaceOperationalDataPath(elanInstanceName, dpnId);
 921     }
 922
 923     @Override
 924     public DpnInterfaces getElanInterfaceInfoByElanDpn(String elanInstanceName, BigInteger dpId) {
 925         return elanUtils.getElanInterfaceInfoByElanDpn(elanInstanceName, dpId);
 926     }
 927
 928 }