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                         .withKey(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)
 190                     .withKey(new ElanInstanceKey(elanInstanceName)).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                         .withKey(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)
 221                     .withKey(new ElanInstanceKey(elanInstanceName))
 222                     .addAugmentation(EtreeInstance.class, etreeInstance).build();
 223             MDSALUtil.syncWrite(broker, LogicalDatastoreType.CONFIGURATION,
 224                     ElanHelper.getElanInstanceConfigurationDataPath(elanInstanceName), elanInstance);
 225             LOG.debug("Creating the new Etree Instance {}", elanInstance);
 226         }
 227         return isSuccess;
 228     }
 229
 230     @Override
 231     public EtreeInterface getEtreeInterfaceByElanInterfaceName(String elanInterface) {
 232         return elanInterfaceCache.getEtreeInterface(elanInterface).orNull();
 233     }
 234
 235     public static boolean compareWithExistingElanInstance(ElanInstance existingElanInstance, long macTimeOut,
 236             String description) {
 237         boolean isEqual = false;
 238         if (existingElanInstance.getMacTimeout() == macTimeOut
 239                 && existingElanInstance.getDescription().equals(description)) {
 240             isEqual = true;
 241         }
 242         return isEqual;
 243     }
 244
 245     @Override
 246     public void updateElanInstance(String elanInstanceName, long newMacTimout, String newDescription) {
 247         createElanInstance(elanInstanceName, newMacTimout, newDescription);
 248     }
 249
 250     @Override
 251     public boolean deleteEtreeInstance(String etreeInstanceName) {
 252         return deleteElanInstance(etreeInstanceName);
 253     }
 254
 255     @Override
 256     public boolean deleteElanInstance(String elanInstanceName) {
 257         boolean isSuccess = false;
 258         Optional<ElanInstance> existingElanInstance = elanInstanceCache.get(elanInstanceName);
 259         if (!existingElanInstance.isPresent()) {
 260             LOG.debug("Elan Instance is not present for {}", elanInstanceName);
 261             return isSuccess;
 262         }
 263         LOG.debug("Deletion of the existing Elan Instance {}", existingElanInstance);
 264         ElanUtils.delete(broker, LogicalDatastoreType.CONFIGURATION,
 265                 ElanHelper.getElanInstanceConfigurationDataPath(elanInstanceName));
 266         isSuccess = true;
 267         return isSuccess;
 268     }
 269
 270     @Override
 271     public void addEtreeInterface(String etreeInstanceName, String interfaceName, EtreeInterfaceType interfaceType,
 272             List<String> staticMacAddresses, String description) {
 273         Optional<ElanInstance> existingElanInstance = elanInstanceCache.get(etreeInstanceName);
 274         if (existingElanInstance.isPresent()
 275                 && existingElanInstance.get().augmentation(EtreeInstance.class) != null) {
 276             EtreeInterface etreeInterface = new EtreeInterfaceBuilder().setEtreeInterfaceType(interfaceType).build();
 277             ElanInterface elanInterface;
 278             if (staticMacAddresses == null) {
 279                 elanInterface = new ElanInterfaceBuilder().setElanInstanceName(etreeInstanceName)
 280                         .setDescription(description).setName(interfaceName).withKey(new ElanInterfaceKey(interfaceName))
 281                         .addAugmentation(EtreeInterface.class, etreeInterface).build();
 282             } else {
 283                 List<StaticMacEntries> staticMacEntries = ElanUtils.getStaticMacEntries(staticMacAddresses);
 284                 elanInterface = new ElanInterfaceBuilder().setElanInstanceName(etreeInstanceName)
 285                         .setDescription(description).setName(interfaceName)
 286                         .setStaticMacEntries(staticMacEntries)
 287                         .withKey(new ElanInterfaceKey(interfaceName))
 288                         .addAugmentation(EtreeInterface.class, etreeInterface).build();
 289             }
 290             MDSALUtil.syncWrite(broker, LogicalDatastoreType.CONFIGURATION,
 291                     ElanUtils.getElanInterfaceConfigurationDataPathId(interfaceName), elanInterface);
 292             LOG.debug("Creating the new Etree Interface {}", elanInterface);
 293         }
 294     }
 295
 296     @Override
 297     public void addElanInterface(String elanInstanceName, String interfaceName, List<String> staticMacAddresses,
 298             String description) {
 299         Optional<ElanInstance> existingElanInstance = elanInstanceCache.get(elanInstanceName);
 300         if (existingElanInstance.isPresent()) {
 301             ElanInterfaceBuilder elanInterfaceBuilder = new ElanInterfaceBuilder()
 302                     .setElanInstanceName(elanInstanceName)
 303                     .setDescription(description).setName(interfaceName)
 304                     .withKey(new ElanInterfaceKey(interfaceName));
 305             if (staticMacAddresses != null) {
 306                 List<StaticMacEntries> staticMacEntries = ElanUtils.getStaticMacEntries(staticMacAddresses);
 307                 elanInterfaceBuilder.setStaticMacEntries(staticMacEntries);
 308             }
 309             ElanInterface elanInterface = elanInterfaceBuilder.build();
 310             MDSALUtil.syncWrite(broker, LogicalDatastoreType.CONFIGURATION,
 311                     ElanUtils.getElanInterfaceConfigurationDataPathId(interfaceName), elanInterface);
 312             LOG.debug("Created the new ELan Interface {}", elanInterface);
 313         }
 314     }
 315
 316     @Override
 317     public void updateElanInterface(String elanInstanceName, String interfaceName,
 318             List<String> updatedStaticMacAddresses, String newDescription) {
 319         Optional<ElanInterface> existingElanInterface = elanInterfaceCache.get(interfaceName);
 320         if (!existingElanInterface.isPresent()) {
 321             return;
 322         }
 323
 324         List<StaticMacEntries> updatedStaticMacEntries = ElanUtils.getStaticMacEntries(updatedStaticMacAddresses);
 325         LOG.debug("updating the ElanInterface with new Mac Entries {}", updatedStaticMacAddresses);
 326         ElanInterface elanInterface = new ElanInterfaceBuilder().setElanInstanceName(elanInstanceName)
 327                 .setName(interfaceName).setDescription(newDescription).setStaticMacEntries(updatedStaticMacEntries)
 328                 .withKey(new ElanInterfaceKey(interfaceName)).build();
 329         MDSALUtil.syncWrite(broker, LogicalDatastoreType.CONFIGURATION,
 330                 ElanUtils.getElanInterfaceConfigurationDataPathId(interfaceName), elanInterface);
 331     }
 332
 333     @Override
 334     public void deleteEtreeInterface(String interfaceName) {
 335         deleteElanInterface(interfaceName);
 336         LOG.debug("deleting the Etree Interface {}", interfaceName);
 337     }
 338
 339     @Override
 340     public void deleteElanInterface(String interfaceName) {
 341         Optional<ElanInterface> existingElanInterface = elanInterfaceCache.get(interfaceName);
 342         if (existingElanInterface.isPresent()) {
 343             ElanUtils.delete(broker, LogicalDatastoreType.CONFIGURATION,
 344                     ElanUtils.getElanInterfaceConfigurationDataPathId(interfaceName));
 345             LOG.debug("deleting the Elan Interface {}", existingElanInterface);
 346         }
 347     }
 348
 349     @Override
 350     public void addStaticMacAddress(String interfaceName, String macAddress) {
 351         Optional<ElanInterface> existingElanInterface = elanInterfaceCache.get(interfaceName);
 352         if (existingElanInterface.isPresent()) {
 353             StaticMacEntriesBuilder staticMacEntriesBuilder = new StaticMacEntriesBuilder();
 354             StaticMacEntries staticMacEntry = staticMacEntriesBuilder.setMacAddress(
 355                     new PhysAddress(macAddress)).build();
 356             InstanceIdentifier<StaticMacEntries> staticMacEntriesIdentifier =
 357                     ElanUtils.getStaticMacEntriesCfgDataPathIdentifier(interfaceName, macAddress);
 358             MDSALUtil.syncWrite(broker, LogicalDatastoreType.CONFIGURATION, staticMacEntriesIdentifier, staticMacEntry);
 359         }
 360     }
 361
 362     @Override
 363     public void deleteStaticMacAddress(String interfaceName, String macAddress) {
 364         Optional<ElanInterface> existingElanInterface = elanInterfaceCache.get(interfaceName);
 365         if (existingElanInterface.isPresent()) {
 366             InstanceIdentifier<StaticMacEntries> staticMacEntriesIdentifier =
 367                     ElanUtils.getStaticMacEntriesCfgDataPathIdentifier(interfaceName,
 368                     macAddress);
 369             MDSALUtil.syncDelete(broker, LogicalDatastoreType.CONFIGURATION, staticMacEntriesIdentifier);
 370         }
 371     }
 372
 373     @Override
 374     public Collection<MacEntry> getElanMacTable(String elanInstanceName) {
 375         Elan elanInfo = ElanUtils.getElanByName(broker, elanInstanceName);
 376         List<MacEntry> macAddress = new ArrayList<>();
 377         if (elanInfo == null) {
 378             return macAddress;
 379         }
 380         List<String> elanInterfaces = elanInfo.getElanInterfaces();
 381         if (elanInterfaces != null && elanInterfaces.size() > 0) {
 382             for (String elanInterface : elanInterfaces) {
 383                 ElanInterfaceMac elanInterfaceMac = elanUtils.getElanInterfaceMacByInterfaceName(elanInterface);
 384                 if (elanInterfaceMac != null && elanInterfaceMac.getMacEntry() != null
 385                         && elanInterfaceMac.getMacEntry().size() > 0) {
 386                     macAddress.addAll(elanInterfaceMac.getMacEntry());
 387                 }
 388             }
 389         }
 390         return macAddress;
 391     }
 392
 393     @Override
 394     public void flushMACTable(String elanInstanceName) {
 395         Elan elanInfo = ElanUtils.getElanByName(broker, elanInstanceName);
 396         if (elanInfo == null) {
 397             return;
 398         }
 399         List<String> elanInterfaces = elanInfo.getElanInterfaces();
 400         if (elanInterfaces == null || elanInterfaces.isEmpty()) {
 401             return;
 402         }
 403         for (String elanInterface : elanInterfaces) {
 404             ElanInterfaceMac elanInterfaceMac = elanUtils.getElanInterfaceMacByInterfaceName(elanInterface);
 405             if (elanInterfaceMac.getMacEntry() != null && elanInterfaceMac.getMacEntry().size() > 0) {
 406                 List<MacEntry> macEntries = elanInterfaceMac.getMacEntry();
 407                 for (MacEntry macEntry : macEntries) {
 408                     deleteStaticMacAddress(elanInterface, macEntry.getMacAddress().getValue());
 409                 }
 410             }
 411         }
 412
 413     }
 414
 415     @Override
 416     public ElanInstance getElanInstance(String elanName) {
 417         return elanInstanceCache.get(elanName).orNull();
 418     }
 419
 420     @Override
 421     public List<ElanInstance> getElanInstances() {
 422         InstanceIdentifier<ElanInstances> elanInstancesIdentifier = InstanceIdentifier.builder(ElanInstances.class)
 423                 .build();
 424         return ElanUtils.read(broker, LogicalDatastoreType.CONFIGURATION, elanInstancesIdentifier).toJavaUtil().map(
 425                 ElanInstances::getElanInstance).orElse(Collections.emptyList());
 426     }
 427
 428     @Override
 429     @Nonnull
 430     public List<String> getElanInterfaces(String elanInstanceName) {
 431         List<String> elanInterfaces = new ArrayList<>();
 432         InstanceIdentifier<ElanInterfaces> elanInterfacesIdentifier = InstanceIdentifier.builder(ElanInterfaces.class)
 433                 .build();
 434         Optional<ElanInterfaces> elanInterfacesOptional = ElanUtils.read(broker, LogicalDatastoreType.CONFIGURATION,
 435                 elanInterfacesIdentifier);
 436         if (!elanInterfacesOptional.isPresent()) {
 437             return elanInterfaces;
 438         }
 439         List<ElanInterface> elanInterfaceList = elanInterfacesOptional.get().getElanInterface();
 440         for (ElanInterface elanInterface : elanInterfaceList) {
 441             if (elanInterface.getElanInstanceName().equals(elanInstanceName)) {
 442                 elanInterfaces.add(elanInterface.getName());
 443             }
 444         }
 445         return elanInterfaces;
 446     }
 447
 448     @Override
 449     public void createExternalElanNetworks(Node node) {
 450         handleExternalElanNetworks(node, true, (elanInstance, interfaceName) -> {
 451             createExternalElanNetwork(elanInstance, interfaceName);
 452             return null;
 453         });
 454     }
 455
 456     @Override
 457     public void createExternalElanNetwork(ElanInstance elanInstance) {
 458         handleExternalElanNetwork(elanInstance, false, (elanInstance1, interfaceName) -> {
 459             createExternalElanNetwork(elanInstance1, interfaceName);
 460             return null;
 461         });
 462     }
 463
 464     protected void createExternalElanNetwork(ElanInstance elanInstance, BigInteger dpId) {
 465         String providerIntfName = bridgeMgr.getProviderInterfaceName(dpId, elanInstance.getPhysicalNetworkName());
 466         String intfName = providerIntfName + IfmConstants.OF_URI_SEPARATOR + elanInstance.getSegmentationId();
 467         Interface memberIntf = interfaceManager.getInterfaceInfoFromConfigDataStore(intfName);
 468         if (memberIntf == null) {
 469             LOG.debug("creating vlan prv intf in elan {}, dpn {}", elanInstance.getElanInstanceName(),
 470                     dpId);
 471             createExternalElanNetwork(elanInstance, providerIntfName);
 472         }
 473     }
 474
 475     private void createExternalElanNetwork(ElanInstance elanInstance, String interfaceName) {
 476         if (interfaceName == null) {
 477             LOG.trace("No physical interface is attached to {}", elanInstance.getPhysicalNetworkName());
 478             return;
 479         }
 480
 481         String elanInterfaceName = createIetfInterfaces(elanInstance, interfaceName);
 482         addElanInterface(elanInstance.getElanInstanceName(), elanInterfaceName, null, null);
 483     }
 484
 485     @Override
 486     public void updateExternalElanNetwork(ElanInstance elanInstance) {
 487         handleExternalElanNetwork(elanInstance, true, (elanInstance1, interfaceName) -> {
 488             createExternalElanNetwork(elanInstance1, interfaceName);
 489             return null;
 490         });
 491     }
 492
 493     @Override
 494     public void deleteExternalElanNetworks(Node node) {
 495         handleExternalElanNetworks(node, false, (elanInstance, interfaceName) -> {
 496             deleteExternalElanNetwork(elanInstance, interfaceName);
 497             return null;
 498         });
 499     }
 500
 501     @Override
 502     public void deleteExternalElanNetwork(ElanInstance elanInstance) {
 503         handleExternalElanNetwork(elanInstance, false, (elanInstance1, interfaceName) -> {
 504             deleteExternalElanNetwork(elanInstance1, interfaceName);
 505             return null;
 506         });
 507     }
 508
 509     protected void deleteExternalElanNetwork(ElanInstance elanInstance, BigInteger dpnId) {
 510         String providerIntfName = bridgeMgr.getProviderInterfaceName(dpnId, elanInstance.getPhysicalNetworkName());
 511         String intfName = providerIntfName + IfmConstants.OF_URI_SEPARATOR + elanInstance.getSegmentationId();
 512         Interface memberIntf = interfaceManager.getInterfaceInfoFromConfigDataStore(intfName);
 513         if (memberIntf != null) {
 514             deleteElanInterface(intfName);
 515             deleteIetfInterface(intfName);
 516             LOG.debug("delete vlan prv intf {} in elan {}, dpID {}", intfName,
 517                     elanInstance.getElanInstanceName(), dpnId);
 518         } else {
 519             LOG.debug("vlan prv intf {} not found in interfacemgr config DS", intfName);
 520         }
 521     }
 522
 523     private void deleteExternalElanNetwork(ElanInstance elanInstance, String interfaceName) {
 524         if (interfaceName == null) {
 525             LOG.trace("No physial interface is attached to {}", elanInstance.getPhysicalNetworkName());
 526             return;
 527         }
 528
 529         String elanInstanceName = elanInstance.getElanInstanceName();
 530         for (String elanInterface : getExternalElanInterfaces(elanInstanceName)) {
 531             if (elanInterface.startsWith(interfaceName)) {
 532                 if (ElanUtils.isVlan(elanInstance)) {
 533                     deleteIetfInterface(elanInterface);
 534                 }
 535                 String trunkInterfaceName = getTrunkInterfaceName(interfaceName);
 536                 if (shouldDeleteTrunk(trunkInterfaceName, elanInterface)) {
 537                     deleteIetfInterface(trunkInterfaceName);
 538                 }
 539                 deleteElanInterface(elanInterface);
 540             }
 541         }
 542     }
 543
 544     private boolean shouldDeleteTrunk(String trunkInterfaceName, String elanInterfaceName) {
 545         List<Interface> childInterfaces = interfaceManager.getChildInterfaces(trunkInterfaceName);
 546         if (childInterfaces == null || childInterfaces.isEmpty()
 547                 || childInterfaces.size() == 1 && elanInterfaceName.equals(childInterfaces.get(0).getName())) {
 548             LOG.debug("No more VLAN member interfaces left for trunk {}", trunkInterfaceName);
 549             return true;
 550         }
 551
 552         LOG.debug("Trunk interface {} has {} VLAN member interfaces left", trunkInterfaceName, childInterfaces.size());
 553         return false;
 554     }
 555
 556     @Override
 557     public void updateExternalElanNetworks(Node origNode, Node updatedNode) {
 558         if (!bridgeMgr.isIntegrationBridge(updatedNode)) {
 559             return;
 560         }
 561
 562         List<ElanInstance> elanInstances = getElanInstances();
 563         if (elanInstances == null || elanInstances.isEmpty()) {
 564             LOG.trace("No ELAN instances found");
 565             return;
 566         }
 567
 568         LOG.debug("updateExternalElanNetworks, orig bridge {} . updated bridge {}", origNode, updatedNode);
 569
 570         Map<String, String> origProviderMappping = getMapFromOtherConfig(origNode,
 571                 ElanBridgeManager.PROVIDER_MAPPINGS_KEY);
 572         Map<String, String> updatedProviderMappping = getMapFromOtherConfig(updatedNode,
 573                 ElanBridgeManager.PROVIDER_MAPPINGS_KEY);
 574
 575         boolean hasDatapathIdOnOrigNode = bridgeMgr.hasDatapathID(origNode);
 576         boolean hasDatapathIdOnUpdatedNode = bridgeMgr.hasDatapathID(updatedNode);
 577         BigInteger origDpnID = bridgeMgr.getDatapathId(origNode);
 578
 579         for (ElanInstance elanInstance : elanInstances) {
 580             String physicalNetworkName = elanInstance.getPhysicalNetworkName();
 581             boolean createExternalElanNw = true;
 582             if (physicalNetworkName != null) {
 583                 String origPortName = origProviderMappping.get(physicalNetworkName);
 584                 String updatedPortName = updatedProviderMappping.get(physicalNetworkName);
 585                 /**
 586                  * for internal vlan network, vlan provider interface creation should be
 587                  * triggered only if there is existing vlan provider intf indicating presence
 588                  * of VM ports on the DPN
 589                  */
 590                 if (hasDatapathIdOnOrigNode && !elanInstance.isExternal()
 591                         && ElanUtils.isVlan(elanInstance)) {
 592                     String externalIntf = getExternalElanInterface(elanInstance.getElanInstanceName(),
 593                             origDpnID);
 594                     if (externalIntf == null) {
 595                         createExternalElanNw = false;
 596                     }
 597                 }
 598                 if (hasPortNameRemoved(origPortName, updatedPortName)) {
 599                     deleteExternalElanNetwork(elanInstance,
 600                             bridgeMgr.getProviderInterfaceName(origNode, physicalNetworkName));
 601                 }
 602
 603                 if (createExternalElanNw && (hasPortNameUpdated(origPortName, updatedPortName)
 604                         || hasDatapathIdAdded(hasDatapathIdOnOrigNode, hasDatapathIdOnUpdatedNode))) {
 605                     createExternalElanNetwork(elanInstance,
 606                             bridgeMgr.getProviderInterfaceName(updatedNode, physicalNetworkName));
 607                 }
 608             }
 609         }
 610     }
 611
 612     private boolean hasDatapathIdAdded(boolean hasDatapathIdOnOrigNode, boolean hasDatapathIdOnUpdatedNode) {
 613         return !hasDatapathIdOnOrigNode && hasDatapathIdOnUpdatedNode;
 614     }
 615
 616     private boolean hasPortNameUpdated(String origPortName, String updatedPortName) {
 617         return updatedPortName != null && !updatedPortName.equals(origPortName);
 618     }
 619
 620     private boolean hasPortNameRemoved(String origPortName, String updatedPortName) {
 621         return origPortName != null && !origPortName.equals(updatedPortName);
 622     }
 623
 624     private Map<String, String> getMapFromOtherConfig(Node node, String otherConfigColumn) {
 625         return bridgeMgr.getOpenvswitchOtherConfigMap(node, otherConfigColumn);
 626     }
 627
 628     @Override
 629     public Collection<String> getExternalElanInterfaces(String elanInstanceName) {
 630         List<String> elanInterfaces = getElanInterfaces(elanInstanceName);
 631         if (elanInterfaces.isEmpty()) {
 632             LOG.trace("No ELAN interfaces defined for {}", elanInstanceName);
 633             return Collections.emptySet();
 634         }
 635
 636         Set<String> externalElanInterfaces = new HashSet<>();
 637         for (String elanInterface : elanInterfaces) {
 638             if (interfaceManager.isExternalInterface(elanInterface)) {
 639                 externalElanInterfaces.add(elanInterface);
 640             }
 641         }
 642
 643         return externalElanInterfaces;
 644     }
 645
 646     @Override
 647     public String getExternalElanInterface(String elanInstanceName, BigInteger dpnId) {
 648         return elanUtils.getExternalElanInterface(elanInstanceName, dpnId);
 649     }
 650
 651     @Override
 652     public boolean isExternalInterface(String interfaceName) {
 653         return interfaceManager.isExternalInterface(interfaceName);
 654     }
 655
 656     @Override
 657     public ElanInterface getElanInterfaceByElanInterfaceName(String interfaceName) {
 658         return elanInterfaceCache.get(interfaceName).orNull();
 659     }
 660
 661     @Override
 662     public void handleKnownL3DmacAddress(String macAddress, String elanInstanceName, int addOrRemove) {
 663         if (addOrRemove == NwConstants.ADD_FLOW) {
 664             addKnownL3DmacAddress(macAddress, elanInstanceName);
 665         } else {
 666             removeKnownL3DmacAddress(macAddress, elanInstanceName);
 667         }
 668     }
 669
 670     @Override
 671     public void addKnownL3DmacAddress(String macAddress, String elanInstanceName) {
 672         if (!isL2BeforeL3) {
 673             LOG.trace("ELAN service is after L3VPN in the Netvirt pipeline skip known L3DMAC flows installation");
 674             return;
 675         }
 676         ElanInstance elanInstance = elanInstanceCache.get(elanInstanceName).orNull();
 677         if (elanInstance == null) {
 678             LOG.warn("Null elan instance {}", elanInstanceName);
 679             return;
 680         }
 681
 682         List<BigInteger> dpnsIdsForElanInstance = elanUtils.getParticipatingDpnsInElanInstance(elanInstanceName);
 683         if (dpnsIdsForElanInstance.isEmpty()) {
 684             LOG.warn("No DPNs for elan instance {}", elanInstance);
 685             return;
 686         }
 687
 688         elanUtils.addDmacRedirectToDispatcherFlows(elanInstance.getElanTag(), elanInstanceName, macAddress,
 689                 dpnsIdsForElanInstance);
 690     }
 691
 692     @Override
 693     public void removeKnownL3DmacAddress(String macAddress, String elanInstanceName) {
 694         if (!isL2BeforeL3) {
 695             LOG.trace("ELAN service is after L3VPN in the Netvirt pipeline skip known L3DMAC flows installation");
 696             return;
 697         }
 698         ElanInstance elanInstance = elanInstanceCache.get(elanInstanceName).orNull();
 699         if (elanInstance == null) {
 700             LOG.warn("Null elan instance {}", elanInstanceName);
 701             return;
 702         }
 703
 704         List<BigInteger> dpnsIdsForElanInstance = elanUtils.getParticipatingDpnsInElanInstance(elanInstanceName);
 705         if (dpnsIdsForElanInstance.isEmpty()) {
 706             LOG.warn("No DPNs for elan instance {}", elanInstance);
 707             return;
 708         }
 709
 710         elanUtils.removeDmacRedirectToDispatcherFlows(elanInstance.getElanTag(), macAddress, dpnsIdsForElanInstance);
 711     }
 712
 713     @Override
 714     public List<MatchInfoBase> getEgressMatchesForElanInstance(String elanInstanceName) {
 715         ElanInstance elanInstance = getElanInstance(elanInstanceName);
 716         if (elanInstance == null) {
 717             LOG.debug("No ELAN instance found for {}", elanInstanceName);
 718             return Collections.emptyList();
 719         }
 720
 721         Long elanTag = elanInstance.getElanTag();
 722         if (elanTag == null) {
 723             LOG.debug("No ELAN tag found for {}", elanInstanceName);
 724             return Collections.emptyList();
 725         }
 726         return Collections.singletonList(
 727                 new NxMatchRegister(ElanConstants.ELAN_REG_ID, elanTag, MetaDataUtil.getElanMaskForReg()));
 728     }
 729
 730     /**
 731      * Create ietf-interfaces based on the ELAN segment type.<br>
 732      * For segment type flat - create transparent interface pointing to the
 733      * patch-port attached to the physnet port.<br>
 734      * For segment type vlan - create trunk interface pointing to the patch-port
 735      * attached to the physnet port + trunk-member interface pointing to the
 736      * trunk interface.
 737      *
 738      * @param elanInstance
 739      *            ELAN instance
 740      * @param parentRef
 741      *            parent interface name
 742      * @return the name of the interface to be added to the ELAN instance i.e.
 743      *         trunk-member name for vlan network and transparent for flat
 744      *         network or null otherwise
 745      */
 746     private String createIetfInterfaces(ElanInstance elanInstance, String parentRef) {
 747         String interfaceName = null;
 748
 749         try {
 750             String trunkName = getTrunkInterfaceName(parentRef);
 751             // trunk interface may have been created by other vlan network
 752             Interface trunkInterface = interfaceManager.getInterfaceInfoFromConfigDataStore(trunkName);
 753             if (trunkInterface == null) {
 754                 interfaceManager.createVLANInterface(trunkName, parentRef, null, null,
 755                         IfL2vlan.L2vlanMode.Trunk, true);
 756             }
 757             if (ElanUtils.isFlat(elanInstance)) {
 758                 interfaceName = trunkName;
 759             } else if (ElanUtils.isVlan(elanInstance)) {
 760                 Long segmentationId = elanInstance.getSegmentationId();
 761                 interfaceName = parentRef + IfmConstants.OF_URI_SEPARATOR + segmentationId;
 762                 interfaceManager.createVLANInterface(interfaceName, trunkName, segmentationId.intValue(), null,
 763                         IfL2vlan.L2vlanMode.TrunkMember, true);
 764             }
 765         } catch (InterfaceAlreadyExistsException e) {
 766             LOG.trace("Interface {} was already created", interfaceName);
 767         }
 768
 769         return interfaceName;
 770     }
 771
 772     private void deleteIetfInterface(String interfaceName) {
 773         InterfaceKey interfaceKey = new InterfaceKey(interfaceName);
 774         InstanceIdentifier<Interface> interfaceInstanceIdentifier = InstanceIdentifier.builder(Interfaces.class)
 775                 .child(Interface.class, interfaceKey).build();
 776         MDSALUtil.syncDelete(broker, LogicalDatastoreType.CONFIGURATION, interfaceInstanceIdentifier);
 777         LOG.debug("Deleting IETF interface {}", interfaceName);
 778     }
 779
 780     private void handleExternalElanNetworks(Node node, boolean skipIntVlanNw,
 781                                             BiFunction<ElanInstance, String, Void> function) {
 782         if (!bridgeMgr.isIntegrationBridge(node)) {
 783             return;
 784         }
 785
 786         List<ElanInstance> elanInstances = getElanInstances();
 787         if (elanInstances == null || elanInstances.isEmpty()) {
 788             LOG.trace("No ELAN instances found");
 789             return;
 790         }
 791
 792         for (ElanInstance elanInstance : elanInstances) {
 793             if (skipIntVlanNw && !elanInstance.isExternal() && ElanUtils.isVlan(elanInstance)) {
 794                 continue;
 795             }
 796             String interfaceName = bridgeMgr.getProviderInterfaceName(node, elanInstance.getPhysicalNetworkName());
 797             if (interfaceName != null) {
 798                 function.apply(elanInstance, interfaceName);
 799             }
 800         }
 801     }
 802
 803     private void handleExternalElanNetwork(ElanInstance elanInstance, boolean update,
 804                                            BiFunction<ElanInstance, String, Void> function) {
 805         String elanInstanceName = elanInstance.getElanInstanceName();
 806         if (elanInstance.getPhysicalNetworkName() == null) {
 807             LOG.trace("No physical network attached to {}", elanInstanceName);
 808             return;
 809         }
 810
 811         List<Node> nodes = southboundUtils.getOvsdbNodes();
 812         if (nodes == null || nodes.isEmpty()) {
 813             LOG.trace("No OVS nodes found while creating external network for ELAN {}",
 814                     elanInstance.getElanInstanceName());
 815             return;
 816         }
 817
 818         for (Node node : nodes) {
 819             if (bridgeMgr.isIntegrationBridge(node)) {
 820                 if (update && !elanInstance.isExternal()) {
 821                     DpnInterfaces dpnInterfaces = elanUtils.getElanInterfaceInfoByElanDpn(elanInstanceName,
 822                             bridgeMgr.getDatapathId(node));
 823                     if (dpnInterfaces == null || dpnInterfaces.getInterfaces().isEmpty()) {
 824                         continue;
 825                     }
 826                 }
 827                 String interfaceName = bridgeMgr.getProviderInterfaceName(node, elanInstance.getPhysicalNetworkName());
 828                 function.apply(elanInstance, interfaceName);
 829             }
 830         }
 831     }
 832
 833     private String getTrunkInterfaceName(String parentRef) {
 834         return parentRef + IfmConstants.OF_URI_SEPARATOR + "trunk";
 835     }
 836
 837     private void setIsL2BeforeL3() {
 838         short elanServiceRealIndex = ServiceIndex.getIndex(NwConstants.ELAN_SERVICE_NAME,
 839                 NwConstants.ELAN_SERVICE_INDEX);
 840         short l3vpnServiceRealIndex = ServiceIndex.getIndex(NwConstants.L3VPN_SERVICE_NAME,
 841                 NwConstants.L3VPN_SERVICE_INDEX);
 842         if (elanServiceRealIndex < l3vpnServiceRealIndex) {
 843             LOG.info("ELAN service is set before L3VPN service in the Netvirt pipeline");
 844             isL2BeforeL3 = true;
 845         } else {
 846             LOG.info("ELAN service is set after L3VPN service in the Netvirt pipeline");
 847             isL2BeforeL3 = false;
 848         }
 849     }
 850
 851     @Override
 852     public void addArpResponderFlow(ArpResponderInput arpResponderInput) {
 853         String ingressInterfaceName = arpResponderInput.getInterfaceName();
 854         String macAddress = arpResponderInput.getSha();
 855         String ipAddress = arpResponderInput.getSpa();
 856         int lportTag = arpResponderInput.getLportTag();
 857         BigInteger dpnId = arpResponderInput.getDpId();
 858
 859         LOG.info("Installing the ARP responder flow on DPN {} for Interface {} with MAC {} & IP {}", dpnId,
 860                 ingressInterfaceName, macAddress, ipAddress);
 861         Optional<ElanInterface> elanIface = elanInterfaceCache.get(ingressInterfaceName);
 862         ElanInstance elanInstance = elanIface.isPresent()
 863                 ? elanInstanceCache.get(elanIface.get().getElanInstanceName()).orNull() : null;
 864         if (elanInstance == null) {
 865             LOG.debug("addArpResponderFlow: elanInstance is null, Failed to install arp responder flow for dpnId {}"
 866                     + "for Interface {} with MAC {} & IP {}", dpnId, ingressInterfaceName, macAddress, ipAddress);
 867             return;
 868         }
 869         String flowId = ArpResponderUtil.getFlowId(lportTag, ipAddress);
 870         ArpResponderUtil.installFlow(mdsalManager, dpnId, flowId, flowId, NwConstants.DEFAULT_ARP_FLOW_PRIORITY,
 871                 ArpResponderUtil.generateCookie(lportTag, ipAddress),
 872                 ArpResponderUtil.getMatchCriteria(lportTag, elanInstance, ipAddress),
 873                 arpResponderInput.getInstructions());
 874         LOG.info("Installed the ARP Responder flow for Interface {}", ingressInterfaceName);
 875     }
 876
 877     @Override
 878     public void addExternalTunnelArpResponderFlow(ArpResponderInput arpResponderInput, String elanInstanceName) {
 879         BigInteger dpnId = arpResponderInput.getDpId();
 880         String ipAddress = arpResponderInput.getSpa();
 881         String macAddress = arpResponderInput.getSha();
 882
 883         LOG.trace("Installing the ExternalTunnel ARP responder flow on DPN {} for ElanInstance {} with MAC {} & IP {}",
 884                 dpnId, elanInstanceName, macAddress, ipAddress);
 885
 886         ElanInstance elanInstance = elanInstanceCache.get(elanInstanceName).orNull();
 887         if (elanInstance == null) {
 888             LOG.warn("Null elan instance {}", elanInstanceName);
 889             return;
 890         }
 891
 892         int lportTag = arpResponderInput.getLportTag();
 893         String flowId = ArpResponderUtil.getFlowId(lportTag, ipAddress);
 894         ArpResponderUtil.installFlow(mdsalManager, dpnId, flowId, flowId, NwConstants.DEFAULT_ARP_FLOW_PRIORITY,
 895                 ArpResponderUtil.generateCookie(lportTag, ipAddress), ArpResponderUtil.getMatchCriteria(lportTag,
 896                         elanInstance, ipAddress), arpResponderInput.getInstructions());
 897         LOG.trace("Installed the ExternalTunnel ARP Responder flow for ElanInstance {}", elanInstanceName);
 898     }
 899
 900     @Override
 901     public void removeArpResponderFlow(ArpResponderInput arpResponderInput) {
 902         elanUtils.removeArpResponderFlow(arpResponderInput.getDpId(), arpResponderInput.getInterfaceName(),
 903                 arpResponderInput.getSpa(), arpResponderInput.getLportTag());
 904     }
 905
 906     /**
 907      * Uses the IdManager to retrieve a brand new ElanTag.
 908      *
 909      * @param idKey
 910      *            the id key
 911      * @return the integer
 912      */
 913     @Override
 914     public Long retrieveNewElanTag(String idKey) {
 915         return elanUtils.retrieveNewElanTag(idManager, idKey);
 916     }
 917
 918     @Override
 919     public InstanceIdentifier<DpnInterfaces> getElanDpnInterfaceOperationalDataPath(
 920                                                                 String elanInstanceName, BigInteger dpnId) {
 921         return ElanUtils.getElanDpnInterfaceOperationalDataPath(elanInstanceName, dpnId);
 922     }
 923
 924     @Override
 925     public DpnInterfaces getElanInterfaceInfoByElanDpn(String elanInstanceName, BigInteger dpId) {
 926         return elanUtils.getElanInterfaceInfoByElanDpn(elanInstanceName, dpId);
 927     }
 928
 929 }