elanmanager/elanmanager-impl/src/main/java/org/opendaylight/vpnservice/elan/utils/ElanUtils.java

   1 /*
   2  * Copyright (c) 2016 Ericsson India Global Services Pvt Ltd. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.vpnservice.elan.utils;
   9
  10 import com.google.common.base.Optional;
  11 import com.google.common.util.concurrent.FutureCallback;
  12 import com.google.common.util.concurrent.Futures;
  13 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  14 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  15 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  16 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  17 import org.opendaylight.vpnservice.elan.internal.ElanInstanceManager;
  18 import com.google.common.util.concurrent.CheckedFuture;
  19 import org.opendaylight.vpnservice.elan.internal.ElanServiceProvider;
  20 import org.opendaylight.vpnservice.interfacemgr.globals.InterfaceInfo;
  21 import org.opendaylight.vpnservice.interfacemgr.globals.InterfaceServiceUtil;
  22 import org.opendaylight.vpnservice.itm.globals.ITMConstants;
  23 import org.opendaylight.vpnservice.mdsalutil.*;
  24 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  25 import org.opendaylight.vpnservice.mdsalutil.interfaces.IMdsalApiManager;
  26 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.OutputActionCase;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.PushVlanActionCase;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.SetFieldCase;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.SetFieldCaseBuilder;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.set.field._case.SetFieldBuilder;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.Action;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.ActionBuilder;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.ActionKey;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.ApplyActionsCaseBuilder;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.WriteActionsCaseBuilder;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.apply.actions._case.ApplyActionsBuilder;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.write.actions._case.WriteActionsBuilder;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.InstructionBuilder;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.InstructionKey;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.TunnelBuilder;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.*;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan._interface.forwarding.entries.ElanInterfaceMac;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan._interface.forwarding.entries.ElanInterfaceMacKey;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.dpn.interfaces.ElanDpnInterfacesList;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.dpn.interfaces.ElanDpnInterfacesListKey;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.dpn.interfaces.elan.dpn.interfaces.list.DpnInterfaces;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.dpn.interfaces.elan.dpn.interfaces.list.DpnInterfacesKey;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.forwarding.tables.MacTable;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.forwarding.tables.MacTableBuilder;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.forwarding.tables.MacTableKey;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.instances.ElanInstance;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.instances.ElanInstanceBuilder;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.instances.ElanInstanceKey;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.interfaces.ElanInterface;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.interfaces.ElanInterfaceKey;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.state.Elan;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.state.ElanBuilder;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.state.ElanKey;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.tag.name.map.ElanTagName;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.tag.name.map.ElanTagNameBuilder;
  68 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.tag.name.map.ElanTagNameKey;
  69 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.forwarding.entries.MacEntry;
  70 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.forwarding.entries.MacEntryKey;
  71 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.*;
  72 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.rpcs.rev151003.GetEgressActionsForInterfaceInput;
  73 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.rpcs.rev151003.GetEgressActionsForInterfaceInputBuilder;
  74 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.rpcs.rev151003.GetEgressActionsForInterfaceOutput;
  75 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.rpcs.rev151003.GetEgressActionsInput;
  76 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.rpcs.rev151003.GetEgressActionsInputBuilder;
  77 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.rpcs.rev151003.GetEgressActionsOutput;
  78 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.rpcs.rev151003.OdlInterfaceRpcService;
  79 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.itm.op.rev150701.TunnelList;
  80 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.itm.rpcs.rev151217.CreateTerminatingServiceActionsInput;
  81 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.itm.rpcs.rev151217.CreateTerminatingServiceActionsInputBuilder;
  82 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.itm.rpcs.rev151217.GetTunnelInterfaceNameInput;
  83 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.itm.rpcs.rev151217.GetTunnelInterfaceNameInputBuilder;
  84 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.itm.rpcs.rev151217.GetTunnelInterfaceNameOutput;
  85 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.itm.rpcs.rev151217.ItmRpcService;
  86 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.itm.rpcs.rev151217.RemoveTerminatingServiceActionsInput;
  87 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.itm.rpcs.rev151217.RemoveTerminatingServiceActionsInputBuilder;
  88 import org.opendaylight.yangtools.yang.binding.DataObject;
  89 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  90 import org.opendaylight.yangtools.yang.common.RpcResult;
  91 import org.slf4j.Logger;
  92 import org.slf4j.LoggerFactory;
  93
  94 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007.IfIndexesInterfaceMap;
  95 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007._if.indexes._interface.map.IfIndexInterface;
  96 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007._if.indexes._interface.map.IfIndexInterfaceKey;
  97 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.servicebinding.rev151015.service.bindings.ServicesInfo;
  98 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.servicebinding.rev151015.ServiceBindings;
  99 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.servicebinding.rev151015.ServiceTypeFlowBased;
 100 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.servicebinding.rev151015.StypeOpenflow;
 101 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.servicebinding.rev151015.StypeOpenflowBuilder;
 102 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.servicebinding.rev151015.service.bindings.ServicesInfoKey;
 103 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.servicebinding.rev151015.service.bindings.services.info.BoundServices;
 104 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.servicebinding.rev151015.service.bindings.services.info.BoundServicesBuilder;
 105 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.servicebinding.rev151015.service.bindings.services.info.BoundServicesKey;
 106
 107
 108 import java.math.BigInteger;
 109 import java.util.ArrayList;
 110 import java.util.List;
 111 import java.util.concurrent.ExecutionException;
 112 import java.util.concurrent.Future;
 113
 114 public class ElanUtils {
 115
 116     private static ElanServiceProvider elanServiceProvider;
 117     private static final Logger logger = LoggerFactory.getLogger(ElanUtils.class);
 118
 119     public static final FutureCallback<Void> DEFAULT_CALLBACK =
 120             new FutureCallback<Void>() {
 121                 public void onSuccess(Void result) {
 122                     logger.debug("Success in Datastore operation");
 123                 }
 124
 125                 public void onFailure(Throwable error) {
 126                     logger.error("Error in Datastore operation", error);
 127                 };
 128             };
 129
 130     public static Integer getUniqueId(IdManagerService idManager, String poolName, String idKey) {
 131         AllocateIdInput getIdInput = new AllocateIdInputBuilder()
 132                                            .setPoolName(poolName)
 133                                            .setIdKey(idKey).build();
 134
 135         try {
 136             Future<RpcResult<AllocateIdOutput>> result = idManager.allocateId(getIdInput);
 137             RpcResult<AllocateIdOutput> rpcResult = result.get();
 138             if(rpcResult.isSuccessful()) {
 139                 return rpcResult.getResult().getIdValue().intValue();
 140             } else {
 141                 logger.warn("RPC Call to Allocate Id returned with Errors {}", rpcResult.getErrors());
 142             }
 143         } catch (InterruptedException | ExecutionException e) {
 144             logger.warn("Exception when Allocating Id",e);
 145         }
 146         return 0;
 147     }
 148
 149     public static void setElanServiceProvider(ElanServiceProvider elanService) {
 150         elanServiceProvider = elanService;
 151     }
 152     public static void releaseId(IdManagerService idManager, String poolName, String idKey) {
 153         ReleaseIdInput releaseIdInput = new ReleaseIdInputBuilder().setPoolName(poolName).setIdKey(idKey).build();
 154         Future<RpcResult<Void>> result = idManager.releaseId(releaseIdInput);
 155     }
 156
 157     public static <T extends DataObject> Optional<T> read(DataBroker broker, LogicalDatastoreType datastoreType,
 158             InstanceIdentifier<T> path) {
 159
 160         ReadOnlyTransaction tx = broker.newReadOnlyTransaction();
 161
 162         Optional<T> result = Optional.absent();
 163         try {
 164             result = tx.read(datastoreType, path).get();
 165         } catch (Exception e) {
 166             throw new RuntimeException(e);
 167         }
 168
 169         return result;
 170     }
 171
 172
 173     public static <T extends DataObject> void delete(DataBroker broker, LogicalDatastoreType datastoreType, InstanceIdentifier<T> path) {
 174         WriteTransaction tx = broker.newWriteOnlyTransaction();
 175         tx.delete(datastoreType, path);
 176         Futures.addCallback(tx.submit(), DEFAULT_CALLBACK);
 177     }
 178
 179     public static InstanceIdentifier<ElanInstance> getElanInstanceIdentifier(String elanName) {
 180         return InstanceIdentifier.builder(ElanInstances.class)
 181                 .child(ElanInstance.class, new ElanInstanceKey(elanName)).build();
 182     }
 183
 184     public static InstanceIdentifier<ElanInstance> getElanInstanceIdentifier() {
 185         return InstanceIdentifier.builder(ElanInstances.class).child(ElanInstance.class).build();
 186     }
 187
 188     //elan-instances config container
 189     public static ElanInstance getElanInstanceByName(String elanInstanceName) {
 190         DataBroker broker = elanServiceProvider.getBroker();
 191         InstanceIdentifier<ElanInstance> elanIdentifierId = getElanInstanceConfigurationDataPath(elanInstanceName);
 192         Optional<ElanInstance> elanInstance = read(broker, LogicalDatastoreType.CONFIGURATION, elanIdentifierId);
 193         if(elanInstance.isPresent()) {
 194             return elanInstance.get();
 195         }
 196         return null;
 197     }
 198
 199     public static InstanceIdentifier<ElanInstance> getElanInstanceConfigurationDataPath(String elanInstanceName) {
 200         return InstanceIdentifier.builder(ElanInstances.class).child(ElanInstance.class, new ElanInstanceKey(elanInstanceName)).build();
 201     }
 202
 203     //elan-interfaces Config Container
 204     public static ElanInterface getElanInterfaceByElanInterfaceName(String elanInterfaceName) {
 205         DataBroker broker = elanServiceProvider.getBroker();
 206         InstanceIdentifier<ElanInterface> elanInterfaceId = getElanInterfaceConfigurationDataPathId(elanInterfaceName);
 207         Optional<ElanInterface> existingElanInterface = read(broker, LogicalDatastoreType.CONFIGURATION, elanInterfaceId);
 208         if(existingElanInterface.isPresent()) {
 209             return existingElanInterface.get();
 210         }
 211         return null;
 212     }
 213
 214     public static InstanceIdentifier<ElanInterface> getElanInterfaceConfigurationDataPathId(String interfaceName) {
 215         return InstanceIdentifier.builder(ElanInterfaces.class).child(ElanInterface.class,
 216                 new ElanInterfaceKey(interfaceName)).build();
 217     }
 218
 219     //elan-state Operational container
 220     public static Elan getElanByName(String elanInstanceName) {
 221         DataBroker broker = elanServiceProvider.getBroker();
 222         InstanceIdentifier<Elan> elanIdentifier = getElanInstanceOperationalDataPath(elanInstanceName);
 223         Optional<Elan> elanInstance = read(broker, LogicalDatastoreType.OPERATIONAL, elanIdentifier);
 224         if(elanInstance.isPresent()) {
 225             return elanInstance.get();
 226         }
 227         return null;
 228     }
 229
 230     public static InstanceIdentifier<Elan> getElanInstanceOperationalDataPath(String elanInstanceName) {
 231         return InstanceIdentifier.builder(ElanState.class).child(Elan.class, new ElanKey(elanInstanceName)).build();
 232     }
 233
 234     // grouping of forwarding-entries
 235     public static MacEntry getInterfaceMacEntriesOperationalDataPath(String interfaceName, PhysAddress physAddress) {
 236         DataBroker broker = elanServiceProvider.getBroker();
 237         InstanceIdentifier<MacEntry> existingMacEntryId = getInterfaceMacEntriesIdentifierOperationalDataPath(interfaceName, physAddress);
 238         Optional<MacEntry> existingInterfaceMacEntry = read(broker, LogicalDatastoreType.OPERATIONAL, existingMacEntryId);
 239         if(existingInterfaceMacEntry.isPresent()) {
 240             return existingInterfaceMacEntry.get();
 241         }
 242         return null;
 243     }
 244
 245     public static MacEntry getInterfaceMacEntriesOperationalDataPathFromId(InstanceIdentifier identifier) {
 246         DataBroker broker = elanServiceProvider.getBroker();
 247         Optional<MacEntry> existingInterfaceMacEntry = read(broker, LogicalDatastoreType.OPERATIONAL, identifier);
 248         if(existingInterfaceMacEntry.isPresent()) {
 249             return existingInterfaceMacEntry.get();
 250         }
 251         return null;
 252     }
 253
 254     public static InstanceIdentifier<MacEntry> getInterfaceMacEntriesIdentifierOperationalDataPath(String interfaceName, PhysAddress physAddress) {
 255         return InstanceIdentifier.builder(ElanInterfaceForwardingEntries.class).child(ElanInterfaceMac.class,
 256                 new ElanInterfaceMacKey(interfaceName)).child(MacEntry.class, new MacEntryKey(physAddress)).build();
 257
 258     }
 259
 260     //elan-forwarding-tables Operational container
 261     public static MacEntry getMacTableByElanName(String elanName, PhysAddress physAddress) {
 262         DataBroker broker = elanServiceProvider.getBroker();
 263         InstanceIdentifier<MacEntry> macId =  getMacEntryOperationalDataPath(elanName, physAddress);
 264         Optional<MacEntry> existingElanMacEntry = read(broker, LogicalDatastoreType.OPERATIONAL, macId);
 265         if(existingElanMacEntry.isPresent()) {
 266             return existingElanMacEntry.get();
 267         }
 268         return null;
 269     }
 270
 271
 272     public static MacEntry getMacEntryFromElanMacId(InstanceIdentifier identifier) {
 273         DataBroker broker = elanServiceProvider.getBroker();
 274         Optional<MacEntry> existingInterfaceMacEntry = read(broker, LogicalDatastoreType.OPERATIONAL, identifier);
 275         if(existingInterfaceMacEntry.isPresent()) {
 276             return existingInterfaceMacEntry.get();
 277         }
 278         return null;
 279     }
 280
 281     public static InstanceIdentifier<MacEntry> getMacEntryOperationalDataPath(String elanName, PhysAddress physAddress) {
 282         return InstanceIdentifier.builder(ElanForwardingTables.class).child(MacTable.class,
 283                 new MacTableKey(elanName)).child(MacEntry.class, new MacEntryKey(physAddress)).build();
 284     }
 285
 286     public static InstanceIdentifier<MacTable> getElanMacTableOperationalDataPath(String elanName) {
 287         return InstanceIdentifier.builder(ElanForwardingTables.class).child(MacTable.class,
 288                 new MacTableKey(elanName)).build();
 289     }
 290
 291     //elan-interface-forwarding-entries Operational container
 292     public static ElanInterfaceMac getElanInterfaceMacByInterfaceName(String interfaceName) {
 293         DataBroker broker = elanServiceProvider.getBroker();
 294         InstanceIdentifier<ElanInterfaceMac> elanInterfaceId = getElanInterfaceMacEntriesOperationalDataPath(interfaceName);
 295         Optional<ElanInterfaceMac> existingElanInterface = read(broker, LogicalDatastoreType.OPERATIONAL, elanInterfaceId);
 296         if(existingElanInterface.isPresent()) {
 297             return existingElanInterface.get();
 298         }
 299         return null;
 300     }
 301
 302     public static InstanceIdentifier<ElanInterfaceMac> getElanInterfaceMacEntriesOperationalDataPath(String interfaceName) {
 303         return InstanceIdentifier.builder(ElanInterfaceForwardingEntries.class).child(ElanInterfaceMac.class,
 304                 new ElanInterfaceMacKey(interfaceName)).build();
 305     }
 306
 307     //elan-dpn-interfaces Operational Container
 308     public static DpnInterfaces getElanInterfaceInfoByElanDpn(String elanInstanceName, BigInteger dpId) {
 309         DataBroker broker = elanServiceProvider.getBroker();
 310         InstanceIdentifier<DpnInterfaces> elanDpnInterfacesId = getElanDpnInterfaceOperationalDataPath(elanInstanceName, dpId);
 311         Optional<DpnInterfaces> elanDpnInterfaces = read(broker, LogicalDatastoreType.OPERATIONAL, elanDpnInterfacesId);
 312         if(elanDpnInterfaces.isPresent()) {
 313             return elanDpnInterfaces.get();
 314         }
 315         return null;
 316     }
 317
 318     public static InstanceIdentifier<DpnInterfaces> getElanDpnInterfaceOperationalDataPath(String elanInstanceName, BigInteger dpId) {
 319         return InstanceIdentifier.builder(ElanDpnInterfaces.class).child(ElanDpnInterfacesList.class,
 320                 new ElanDpnInterfacesListKey(elanInstanceName)).child(DpnInterfaces.class, new DpnInterfacesKey(dpId)).build();
 321     }
 322
 323     //elan-tag-name-map Operational Container
 324     public static ElanTagName getElanInfoByElanTag(long elanTag) {
 325         DataBroker broker = elanServiceProvider.getBroker();
 326         InstanceIdentifier<ElanTagName> elanId = getElanInfoEntriesOperationalDataPath(elanTag);
 327         Optional<ElanTagName> existingElanInfo = ElanUtils.read(broker, LogicalDatastoreType.OPERATIONAL, elanId);
 328         if(existingElanInfo.isPresent()) {
 329             return existingElanInfo.get();
 330         }
 331         return null;
 332     }
 333
 334     public static InstanceIdentifier<ElanTagName> getElanInfoEntriesOperationalDataPath(long elanTag) {
 335         return InstanceIdentifier.builder(ElanTagNameMap.class).child(ElanTagName.class,
 336                 new ElanTagNameKey(elanTag)).build();
 337     }
 338
 339     // interface-index-tag operational container
 340     public static IfIndexInterface getInterfaceInfoByInterfaceTag(long interfaceTag) {
 341         DataBroker broker = elanServiceProvider.getBroker();
 342         InstanceIdentifier<IfIndexInterface> interfaceId = getInterfaceInfoEntriesOperationalDataPath(interfaceTag);
 343         Optional<IfIndexInterface> existingInterfaceInfo = ElanUtils.read(broker, LogicalDatastoreType.OPERATIONAL, interfaceId);
 344         if(existingInterfaceInfo.isPresent()) {
 345             return existingInterfaceInfo.get();
 346         }
 347         return null;
 348     }
 349
 350     public static InstanceIdentifier<IfIndexInterface> getInterfaceInfoEntriesOperationalDataPath(long interfaceTag) {
 351         return InstanceIdentifier.builder(IfIndexesInterfaceMap.class).child(IfIndexInterface.class,
 352                 new IfIndexInterfaceKey((int) interfaceTag)).build();
 353     }
 354
 355
 356
 357     public static InstanceIdentifier<ElanDpnInterfacesList> getElanDpnOperationDataPath(String elanInstanceName) {
 358         return InstanceIdentifier.builder(ElanDpnInterfaces.class).child(ElanDpnInterfacesList.class, new ElanDpnInterfacesListKey(elanInstanceName)).build();
 359     }
 360
 361     public static  ElanDpnInterfacesList getElanDpnInterfacesList(String elanName) {
 362         DataBroker broker = elanServiceProvider.getBroker();
 363         InstanceIdentifier<ElanDpnInterfacesList> elanDpnInterfaceId = getElanDpnOperationDataPath(elanName);
 364         Optional<ElanDpnInterfacesList> existingElanDpnInterfaces = ElanUtils.read(broker, LogicalDatastoreType.OPERATIONAL, elanDpnInterfaceId);
 365         if(existingElanDpnInterfaces.isPresent()) {
 366             return existingElanDpnInterfaces.get();
 367         }
 368         return null;
 369     }
 370
 371     public static  ElanDpnInterfaces getElanDpnInterfacesList() {
 372         DataBroker broker = elanServiceProvider.getBroker();
 373         InstanceIdentifier<ElanDpnInterfaces> elanDpnInterfaceId = InstanceIdentifier.builder(ElanDpnInterfaces.class).build();
 374         Optional<ElanDpnInterfaces> existingElanDpnInterfaces = ElanUtils.read(broker, LogicalDatastoreType.OPERATIONAL, elanDpnInterfaceId);
 375         if(existingElanDpnInterfaces.isPresent()) {
 376             return existingElanDpnInterfaces.get();
 377         }
 378         return null;
 379     }
 380
 381     public static ElanForwardingTables getElanForwardingList() {
 382         DataBroker broker = elanServiceProvider.getBroker();
 383         InstanceIdentifier<ElanForwardingTables> elanForwardingTableId = InstanceIdentifier.builder(ElanForwardingTables.class).build();
 384         Optional<ElanForwardingTables> existingElanForwardingList = ElanUtils.read(broker, LogicalDatastoreType.OPERATIONAL, elanForwardingTableId);
 385         if(existingElanForwardingList.isPresent()) {
 386             return existingElanForwardingList.get();
 387         }
 388         return null;
 389     }
 390
 391
 392     public static long getElanLocalBCGID(long elanTag) {
 393         return ElanConstants.ELAN_GID_MIN + (((elanTag % ElanConstants.ELAN_GID_MIN) *2) - 1);
 394     }
 395
 396     public static long getElanRemoteBCGID(long elanTag) {
 397         return ElanConstants.ELAN_GID_MIN + (((elanTag % ElanConstants.ELAN_GID_MIN) *2));
 398     }
 399
 400     public static BigInteger getElanMetadataLabel(long elanTag) {
 401         return (BigInteger.valueOf(elanTag)).shiftLeft(24);
 402     }
 403
 404     public static BigInteger getElanMetadataLabel(long elanTag, int lportTag) {
 405         return getElanMetadataLabel(elanTag).or(MetaDataUtil.getLportTagMetaData(lportTag));
 406     }
 407
 408     public static BigInteger getElanMetadataMask() {
 409         return MetaDataUtil.METADATA_MASK_SERVICE.or(MetaDataUtil.METADATA_MASK_LPORT_TAG);
 410     }
 411
 412     public static void setupMacFlows(ElanInstance elanInfo, InterfaceInfo interfaceInfo, long macTimeout,
 413                                      String macAddress) {
 414         IMdsalApiManager mdsalApiManager = elanServiceProvider.getMdsalManager();
 415         DataBroker broker = elanServiceProvider.getBroker();
 416         ItmRpcService itmRpcService = elanServiceProvider.getItmRpcService();
 417         synchronized (macAddress) {
 418             logger.info("Acquired lock for mac : " + macAddress + "Proceeding with install operation.");
 419             setupKnownSmacFlow(elanInfo, interfaceInfo, macTimeout, macAddress, mdsalApiManager);
 420             setupTermDmacFlows(interfaceInfo, mdsalApiManager);
 421             setupOrigDmacFlows(elanInfo, interfaceInfo, macAddress, mdsalApiManager, broker);
 422         }
 423     }
 424
 425     public static void setupDMacFlowonRemoteDpn(ElanInstance elanInfo, InterfaceInfo interfaceInfo, BigInteger dstDpId,
 426                                      String macAddress) {
 427         synchronized (macAddress) {
 428             logger.info("Acquired lock for mac : " + macAddress + "Proceeding with install operation.");
 429             setupOrigDmacFlowsonRemoteDpn(elanInfo, interfaceInfo, dstDpId, macAddress);
 430         }
 431     }
 432
 433
 434     private static void setupKnownSmacFlow(ElanInstance elanInfo, InterfaceInfo interfaceInfo, long macTimeout,
 435                                            String macAddress, IMdsalApiManager mdsalApiManager) {
 436         FlowEntity flowEntity = getKnownSmacFlowEntity(elanInfo, interfaceInfo, macTimeout, macAddress);
 437         mdsalApiManager.installFlow(flowEntity);
 438         if (logger.isDebugEnabled()) {
 439             logger.debug("Known Smac flow entry created for elan Name:{}, logical Interface port:{} and mac address:{}", elanInfo.getElanInstanceName(), elanInfo.getDescription(), macAddress);
 440         }
 441     }
 442
 443     private static FlowEntity getKnownSmacFlowEntity(ElanInstance elanInfo, InterfaceInfo interfaceInfo, long macTimeout, String macAddress) {
 444         BigInteger dpId = interfaceInfo.getDpId();
 445         int lportTag = interfaceInfo.getInterfaceTag();
 446         long elanTag = elanInfo.getElanTag();
 447         // Matching metadata and eth_src fields
 448         List<MatchInfo> mkMatches = new ArrayList<MatchInfo>();
 449         mkMatches.add(new MatchInfo(MatchFieldType.metadata, new BigInteger[] {
 450                 ElanUtils.getElanMetadataLabel(elanInfo.getElanTag(), lportTag),
 451                 ElanUtils.getElanMetadataMask() }));
 452         mkMatches.add(new MatchInfo(MatchFieldType.eth_src, new String[] { macAddress }));
 453         List<InstructionInfo> mkInstructions = new ArrayList<InstructionInfo>();
 454         mkInstructions.add(new InstructionInfo(InstructionType.goto_table, new long[] { ElanConstants.ELAN_DMAC_TABLE }));
 455
 456         FlowEntity flowEntity = MDSALUtil.buildFlowEntity(dpId, ElanConstants.ELAN_SMAC_TABLE,
 457                 getKnownDynamicmacFlowRef(ElanConstants.ELAN_SMAC_TABLE, dpId, lportTag, macAddress, elanTag),
 458                 20, elanInfo.getDescription(), (int)macTimeout, 0, ElanConstants.COOKIE_ELAN_KNOWN_SMAC.add(BigInteger.valueOf(elanTag)),
 459                 mkMatches, mkInstructions);
 460         flowEntity.setStrictFlag(true);
 461         flowEntity.setSendFlowRemFlag(macTimeout != 0); //If Mac timeout is 0, the flow wont be deleted automatically, so no need to get notified
 462         return flowEntity;
 463     }
 464
 465     private static void setupTermDmacFlows(InterfaceInfo interfaceInfo, IMdsalApiManager mdsalApiManager) {
 466         BigInteger dpId = interfaceInfo.getDpId();
 467         int lportTag = interfaceInfo.getInterfaceTag();
 468         Flow flow = MDSALUtil.buildFlowNew(NwConstants.INTERNAL_TUNNEL_TABLE, getFlowRef(NwConstants.INTERNAL_TUNNEL_TABLE,lportTag), 5, String.format("%s:%d","ITM Flow Entry ",lportTag), 0, 0, ITMConstants.COOKIE_ITM.add(BigInteger.valueOf(lportTag)), getTunnelIdMatchForFilterEqualsLPortTag(lportTag),
 469                 getInstructionsInPortForOutGroup(interfaceInfo.getInterfaceName()));
 470         mdsalApiManager.installFlow(dpId, flow);
 471         if (logger.isDebugEnabled()) {
 472             logger.debug("Terminating service table flow entry created on dpn:{} for logical Interface port:{}", dpId, interfaceInfo.getPortName());
 473         }
 474     }
 475
 476     private static String getFlowRef(short tableId, int elanTag) {
 477         return new StringBuffer().append(tableId).append(elanTag).toString();
 478     }
 479
 480     private static List<MatchInfo> getTunnelIdMatchForFilterEqualsLPortTag(int LportTag) {
 481         List<MatchInfo> mkMatches = new ArrayList<MatchInfo>();
 482         // Matching metadata
 483         mkMatches.add(new MatchInfo(MatchFieldType.tunnel_id, new BigInteger[] {
 484                 BigInteger.valueOf(LportTag)}));
 485         return mkMatches;
 486
 487
 488     }
 489
 490     public static List<Instruction> getInstructionsInPortForOutGroup(
 491             String ifName) {
 492         List<Instruction> mkInstructions = new ArrayList<Instruction>();
 493         List <Action> actionsInfos = new ArrayList <Action> ();
 494         actionsInfos.addAll(ElanUtils.getEgressActionsForInterface(ifName));
 495         mkInstructions.add(new InstructionBuilder().setInstruction(new ApplyActionsCaseBuilder().setApplyActions(new ApplyActionsBuilder().setAction(actionsInfos).build()).build())
 496                 .setKey(new InstructionKey(0)).build());
 497              return mkInstructions;
 498     }
 499
 500     public static Instruction getWriteActionInstruction(List<Action> actions) {
 501         return new InstructionBuilder().setInstruction(new WriteActionsCaseBuilder().setWriteActions(new WriteActionsBuilder().setAction(actions).build()).build()).setKey(new InstructionKey(0)).build();
 502     }
 503
 504     public static Instruction getApplyActionInstruction(List<Action> actions) {
 505         return new InstructionBuilder().setInstruction(new ApplyActionsCaseBuilder().setApplyActions(new ApplyActionsBuilder().setAction(actions).build()).build()).setKey(new InstructionKey(0)).build();
 506     }
 507
 508
 509     public static List<Action> getEgressActionsForInterface(String ifName) {
 510         List<Action> listAction = new ArrayList<Action>();
 511         try {
 512             Future<RpcResult<GetEgressActionsForInterfaceOutput>> result =
 513                     elanServiceProvider.getInterfaceManagerRpcService().getEgressActionsForInterface(
 514                             new GetEgressActionsForInterfaceInputBuilder().setIntfName(ifName).build());
 515             RpcResult<GetEgressActionsForInterfaceOutput> rpcResult = result.get();
 516             if(!rpcResult.isSuccessful()) {
 517                 logger.warn("RPC Call to Get egress actions for interface {} returned with Errors {}", ifName, rpcResult.getErrors());
 518             } else {
 519                 List<org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.Action> actions =
 520                         rpcResult.getResult().getAction();
 521                 listAction = actions;
 522             }
 523         } catch (InterruptedException | ExecutionException e) {
 524             logger.warn("Exception when egress actions for interface {}", ifName, e);
 525         }
 526         return listAction;
 527     }
 528
 529     private static void setupOrigDmacFlows(ElanInstance elanInfo, InterfaceInfo interfaceInfo, String macAddress,
 530                                            IMdsalApiManager mdsalApiManager, DataBroker broker) {
 531         BigInteger dpId = interfaceInfo.getDpId();
 532         String ifName = interfaceInfo.getInterfaceName();
 533         long ifTag = interfaceInfo.getInterfaceTag();
 534         long groupId = interfaceInfo.getGroupId();
 535         String elanInstanceName = elanInfo.getElanInstanceName();
 536         List<DpnInterfaces> remoteFEs = getInvolvedDpnsInElan(elanInstanceName);
 537         if(remoteFEs != null) {
 538             for (DpnInterfaces remoteFE : remoteFEs) {
 539                 Long elanTag = elanInfo.getElanTag();
 540                 if (remoteFE.getDpId().equals(dpId)) {
 541                     // On the local FE set up a direct output flow
 542                     setupLocalDmacFlow(elanTag, dpId, ifName, macAddress, elanInstanceName, mdsalApiManager, ifTag);
 543                     if (logger.isDebugEnabled()) {
 544                         logger.debug("Dmac flow entry created for elan Name:{}, logical port Name:{} and mac address:{} on dpn:{}", elanInstanceName, interfaceInfo.getPortName(), macAddress, dpId);
 545                     }
 546                 } else {
 547                     if (isDpnPresent(remoteFE.getDpId())) {
 548                         // Check for the Remote DPN present in Inventory Manager
 549                         setupRemoteDmacFlow(remoteFE.getDpId(), dpId, interfaceInfo.getInterfaceTag(), elanTag, macAddress, elanInstanceName);
 550                         if (logger.isDebugEnabled()) {
 551                             logger.debug("Dmac flow entry created for elan Name:{}, logical port Name:{} and mac address:{} on dpn:{}", elanInstanceName, interfaceInfo.getPortName(), macAddress, remoteFE.getDpId());
 552                         }
 553                     }
 554                 }
 555             }
 556         }
 557     }
 558
 559     private static void setupOrigDmacFlowsonRemoteDpn(ElanInstance elanInfo, InterfaceInfo interfaceInfo, BigInteger dstDpId, String macAddress) {
 560         BigInteger dpId = interfaceInfo.getDpId();
 561         String elanInstanceName = elanInfo.getElanInstanceName();
 562         List<DpnInterfaces> remoteFEs = getInvolvedDpnsInElan(elanInstanceName);
 563         for(DpnInterfaces remoteFE: remoteFEs) {
 564             Long elanTag = elanInfo.getElanTag();
 565             if (remoteFE.getDpId().equals(dstDpId)) {
 566                 // Check for the Remote DPN present in Inventory Manager
 567                 setupRemoteDmacFlow(dstDpId, dpId, interfaceInfo.getInterfaceTag(), elanTag, macAddress, elanInstanceName);
 568                 if (logger.isDebugEnabled()) {
 569                     logger.debug("Dmac flow entry created for elan Name:{}, logical port Name:{} and mac address {} on dpn:{}", elanInstanceName, interfaceInfo.getPortName(), macAddress, remoteFE.getDpId());
 570                 }
 571                 break;
 572             }
 573         }
 574     }
 575
 576
 577     @SuppressWarnings("unchecked")
 578     public static List<DpnInterfaces> getInvolvedDpnsInElan(String elanName) {
 579         List<DpnInterfaces> dpns = ElanInstanceManager.getElanInstanceManager().getElanDPNByName(elanName);
 580         return dpns;
 581     }
 582
 583     private static void setupLocalDmacFlow(long elanTag, BigInteger dpId, String ifName, String macAddress,
 584                                            String displayName, IMdsalApiManager mdsalApiManager, long ifTag) {
 585         Flow flowEntity = getLocalDmacFlowEntry(elanTag, dpId, ifName, macAddress, displayName, ifTag);
 586         mdsalApiManager.installFlow(dpId, flowEntity);
 587
 588     }
 589
 590     public static String getKnownDynamicmacFlowRef(short tableId, BigInteger dpId, long lporTag, String macAddress, long elanTag) {
 591         return new StringBuffer().append(tableId).append(elanTag).append(dpId).append(lporTag).append(macAddress).toString();
 592     }
 593
 594     public static String getKnownDynamicmacFlowRef(short tableId, BigInteger dpId, BigInteger remoteDpId, String macAddress, long elanTag) {
 595         return new StringBuffer().append(tableId).append(elanTag).append(dpId).append(remoteDpId).append(macAddress).toString();
 596     }
 597
 598     public static Flow getLocalDmacFlowEntry(long elanTag, BigInteger dpId, String ifName, String macAddress,
 599                                                    String displayName, long ifTag) {
 600         List<MatchInfo> mkMatches = new ArrayList<MatchInfo>();
 601         mkMatches.add(new MatchInfo(MatchFieldType.metadata, new BigInteger[] {
 602                 ElanUtils.getElanMetadataLabel(elanTag),
 603                 MetaDataUtil.METADATA_MASK_SERVICE }));
 604         mkMatches.add(new MatchInfo(MatchFieldType.eth_dst, new String[] { macAddress }));
 605
 606         List<Instruction> mkInstructions = new ArrayList<Instruction>();
 607         List <Action> actionsInfos = new ArrayList <Action> ();
 608         actionsInfos.addAll(getEgressActionsForInterface(ifName));
 609         mkInstructions.add(new InstructionBuilder().setInstruction(new ApplyActionsCaseBuilder().setApplyActions(new ApplyActionsBuilder().setAction(actionsInfos).build()).build())
 610                 .setKey(new InstructionKey(0)).build());
 611         Flow flow = MDSALUtil.buildFlowNew(ElanConstants.ELAN_DMAC_TABLE, getKnownDynamicmacFlowRef(ElanConstants.ELAN_DMAC_TABLE, dpId, ifTag, macAddress, elanTag),
 612                 20, displayName, 0, 0, ElanConstants.COOKIE_ELAN_KNOWN_DMAC.add(BigInteger.valueOf(elanTag)), mkMatches, mkInstructions);
 613
 614         return flow;
 615     }
 616
 617     public static void setupRemoteDmacFlow(BigInteger srcDpId, BigInteger destDpId, int lportTag, long elanTag, String macAddress,
 618                                            String displayName) {
 619         IMdsalApiManager mdsalApiManager = elanServiceProvider.getMdsalManager();
 620         Flow flowEntity = getRemoteDmacFlowEntry(srcDpId, destDpId, lportTag, elanTag, macAddress, displayName);
 621         mdsalApiManager.installFlow(srcDpId, flowEntity);
 622     }
 623
 624     public static Flow getRemoteDmacFlowEntry(BigInteger srcDpId, BigInteger destDpId, int lportTag, long elanTag,
 625                                               String macAddress, String displayName) {
 626         ItmRpcService itmRpcService = elanServiceProvider.getItmRpcService();
 627         List<MatchInfo> mkMatches = new ArrayList<MatchInfo>();
 628         mkMatches.add(new MatchInfo(MatchFieldType.metadata, new BigInteger[]{
 629                 ElanUtils.getElanMetadataLabel(elanTag),
 630                 MetaDataUtil.METADATA_MASK_SERVICE }));
 631         mkMatches.add(new MatchInfo(MatchFieldType.eth_dst, new String[] { macAddress }));
 632
 633         List<Instruction> mkInstructions = new ArrayList<Instruction>();
 634
 635         //List of ActionInfo for the provided Source and Destination DPIDs
 636         try {
 637             List<Action> actionsInfos = getItmEgressAction(srcDpId, destDpId, lportTag);
 638             Instruction instruction = new InstructionBuilder().setInstruction(new ApplyActionsCaseBuilder().setApplyActions(new ApplyActionsBuilder().setAction(actionsInfos).build()).build())
 639                     .setKey(new InstructionKey(0)).build();
 640             mkInstructions.add(instruction);
 641         } catch (Exception e) {
 642             logger.error("Interface Not Found exception");
 643         }
 644
 645
 646         Flow flow = MDSALUtil.buildFlowNew(ElanConstants.ELAN_DMAC_TABLE, getKnownDynamicmacFlowRef(ElanConstants.ELAN_DMAC_TABLE, srcDpId, destDpId, macAddress, elanTag), 20
 647                 , displayName, 0, 0, ElanConstants.COOKIE_ELAN_KNOWN_DMAC.add(BigInteger.valueOf(elanTag)), mkMatches, mkInstructions);
 648
 649         return flow;
 650
 651     }
 652
 653     public static void deleteMacFlows(ElanInstance elanInfo, InterfaceInfo interfaceInfo, MacEntry macEntry) {
 654         if (elanInfo == null || interfaceInfo == null) {
 655             return;
 656         }
 657         String macAddress = macEntry.getMacAddress().getValue();
 658         synchronized (macAddress) {
 659             logger.info("Acquired lock for mac : " + macAddress + "Proceeding with remove operation.");
 660             deleteMacFlows(elanInfo, interfaceInfo,  macAddress, true);
 661         }
 662     }
 663
 664     public static void deleteMacFlows(ElanInstance elanInfo, InterfaceInfo interfaceInfo, String macAddress, boolean deleteSmac) {
 665         String elanInstanceName = elanInfo.getElanInstanceName();
 666         String ifName = interfaceInfo.getInterfaceName();
 667         long ifTag = interfaceInfo.getInterfaceTag();
 668         List<DpnInterfaces> remoteFEs = getInvolvedDpnsInElan(elanInstanceName);
 669         IMdsalApiManager mdsalApiManager = elanServiceProvider.getMdsalManager();
 670         ItmRpcService itmRpcService = elanServiceProvider.getItmRpcService();
 671         BigInteger srcdpId = interfaceInfo.getDpId();
 672         String displayName = elanInstanceName;
 673         long groupId = interfaceInfo.getGroupId();
 674         for (DpnInterfaces dpnInterface: remoteFEs) {
 675             Long elanTag = elanInfo.getElanTag();
 676             if (dpnInterface.getDpId().equals(srcdpId)) {
 677                 if(deleteSmac) {
 678                     mdsalApiManager.removeFlow(getKnownSmacFlowEntity(elanInfo, interfaceInfo, 0, macAddress));
 679                 }
 680                 mdsalApiManager.removeFlow(dpnInterface.getDpId(), getLocalDmacFlowEntry(elanTag, dpnInterface.getDpId(), ifName, macAddress, displayName, ifTag));
 681                 RemoveTerminatingServiceActionsInput removeTerminatingServiceActionsInput = new RemoveTerminatingServiceActionsInputBuilder().setServiceId(interfaceInfo.getInterfaceTag()).setDpnId(dpnInterface.getDpId()).build();
 682                 itmRpcService.removeTerminatingServiceActions(removeTerminatingServiceActionsInput);
 683                   if (logger.isDebugEnabled()) {
 684                     logger.debug("All the required flows deleted for elan:{}, logical Interface port:{} and mac address:{} on dpn:{}", elanInstanceName, interfaceInfo.getPortName(), macAddress, dpnInterface.getDpId());
 685                 }
 686             } else if (isDpnPresent(dpnInterface.getDpId())) {
 687                 mdsalApiManager.removeFlow(dpnInterface.getDpId(),
 688                         getRemoteDmacFlowEntry(dpnInterface.getDpId(), srcdpId, interfaceInfo.getInterfaceTag(), elanTag, macAddress,
 689                                 displayName));
 690                 if (logger.isDebugEnabled()) {
 691                     logger.debug("Dmac flow entry deleted for elan:{}, logical interface port:{} and mac address:{} on dpn:{}", elanInstanceName, interfaceInfo.getPortName(), macAddress, dpnInterface.getDpId());
 692                 }
 693             }
 694         }
 695     }
 696
 697     public static void UpdateOperationalDataStore(DataBroker broker, IdManagerService idManager, ElanInstance elanInstanceAdded) {
 698         String elanInstanceName = elanInstanceAdded.getElanInstanceName();
 699         long elanTag = ElanUtils.getUniqueId(idManager, ElanConstants.ELAN_ID_POOL_NAME, elanInstanceName);
 700         Elan elanInfo = new ElanBuilder().setName(elanInstanceName).setKey(new ElanKey(elanInstanceName)).build();
 701         //Add the ElanState in the elan-state operational data-store
 702         MDSALUtil.syncWrite(broker, LogicalDatastoreType.OPERATIONAL, ElanUtils.getElanInstanceOperationalDataPath(elanInstanceName), elanInfo);
 703         //Add the ElanMacTable in the elan-mac-table operational data-store
 704         MacTable elanMacTable = new MacTableBuilder().setKey(new MacTableKey(elanInstanceName)).build();
 705         MDSALUtil.syncWrite(broker, LogicalDatastoreType.OPERATIONAL, ElanUtils.getElanMacTableOperationalDataPath(elanInstanceName), elanMacTable);
 706         ElanTagName elanTagName = new ElanTagNameBuilder().setElanTag(elanTag).setKey(new ElanTagNameKey(elanTag)).setName(elanInstanceName).build();
 707         //Add the ElanTag to ElanName in the elan-tag-name Operational data-store
 708         MDSALUtil.syncWrite(broker, LogicalDatastoreType.OPERATIONAL, ElanUtils.getElanInfoEntriesOperationalDataPath(elanTag), elanTagName);
 709         ElanInstance elanInstanceWithTag = new ElanInstanceBuilder().setElanInstanceName(elanInstanceName).setDescription(elanInstanceAdded.getDescription()).setMacTimeout(elanInstanceAdded
 710                 .getMacTimeout() == null ? ElanConstants.DEFAULT_MAC_TIME_OUT : elanInstanceAdded.getMacTimeout()).setKey(elanInstanceAdded.getKey()).setElanTag(elanTag).build();
 711         MDSALUtil.syncUpdate(broker, LogicalDatastoreType.CONFIGURATION, getElanInstanceIdentifier(elanInstanceName), elanInstanceWithTag);
 712     }
 713
 714     public static boolean isDpnPresent(BigInteger dpnId) {
 715         DataBroker broker = elanServiceProvider.getBroker();
 716         boolean isPresent = false;
 717         String dpn = String.format("%s:%s", "openflow",dpnId);
 718         NodeId nodeId = new NodeId(dpn);
 719         InstanceIdentifier<Node> node = InstanceIdentifier.builder(Nodes.class).child(Node.class, new NodeKey(nodeId)).build();
 720         Optional<Node> nodePresent = read(broker, LogicalDatastoreType.OPERATIONAL, node);
 721         if(nodePresent.isPresent()) {
 722             isPresent = true;
 723         }
 724         return isPresent;
 725     }
 726
 727     public static ServicesInfo getServiceInfo(String elanInstanceName, long elanTag, String interfaceName) {
 728         int priority = ElanConstants.ELAN_SERVICE_PRIORITY;
 729         int instructionKey = 0;
 730         List<Instruction> instructions = new ArrayList<Instruction>();
 731         instructions.add(MDSALUtil.buildAndGetWriteMetadaInstruction(ElanUtils.getElanMetadataLabel(elanTag), MetaDataUtil.METADATA_MASK_SERVICE, ++instructionKey));
 732         instructions.add(MDSALUtil.buildAndGetGotoTableInstruction(ElanConstants.ELAN_SMAC_TABLE, ++instructionKey));
 733
 734         ServicesInfo serviceInfo = InterfaceServiceUtil.buildServiceInfo(String.format("%s.%s", elanInstanceName, interfaceName), ElanConstants.ELAN_SERVICE_INDEX,
 735                 priority, ElanConstants.COOKIE_ELAN_INGRESS_TABLE, instructions);
 736         return serviceInfo;
 737     }
 738
 739     public static <T extends DataObject> void delete(DataBroker broker, LogicalDatastoreType datastoreType,
 740                                               InstanceIdentifier<T> path, FutureCallback<Void> callback) {
 741         WriteTransaction tx = broker.newWriteOnlyTransaction();
 742         tx.delete(datastoreType, path);
 743         Futures.addCallback(tx.submit(), callback);
 744     }
 745
 746     public static <T extends DataObject> void syncWrite(DataBroker broker, LogicalDatastoreType datastoreType,
 747                                                         InstanceIdentifier<T> path, T data) {
 748         WriteTransaction tx = broker.newWriteOnlyTransaction();
 749         tx.put(datastoreType, path, data, true);
 750         CheckedFuture<Void, TransactionCommitFailedException> futures = tx.submit();
 751         try {
 752             futures.get();
 753         } catch (InterruptedException | ExecutionException e) {
 754             logger.error("Error writing to datastore (path, data) : ({}, {})", path, data);
 755             throw new RuntimeException(e.getMessage());
 756         }
 757     }
 758
 759
 760     public static BoundServices getBoundServices(String serviceName, short servicePriority, int flowPriority,
 761                                                  BigInteger cookie, List<Instruction> instructions) {
 762         StypeOpenflowBuilder augBuilder = new StypeOpenflowBuilder().setFlowCookie(cookie).setFlowPriority(flowPriority).setInstruction(instructions);
 763         return new BoundServicesBuilder().setKey(new BoundServicesKey(servicePriority))
 764                 .setServiceName(serviceName).setServicePriority(servicePriority)
 765                 .setServiceType(ServiceTypeFlowBased.class).addAugmentation(StypeOpenflow.class, augBuilder.build()).build();
 766     }
 767
 768     public static InstanceIdentifier<BoundServices> buildServiceId(String vpnInterfaceName, short serviceIndex) {
 769         return InstanceIdentifier.builder(ServiceBindings.class).child(ServicesInfo.class, new ServicesInfoKey(vpnInterfaceName))
 770                 .child(BoundServices.class, new BoundServicesKey(serviceIndex)).build();
 771     }
 772
 773
 774     public static List<Action> getItmEgressAction(BigInteger sourceDpnId,
 775                                                       BigInteger destinationDpnId, int serviceTag) {
 776         ItmRpcService itmManager = elanServiceProvider.getItmRpcService();
 777         OdlInterfaceRpcService interfaceManagerRpcService = elanServiceProvider.getInterfaceManagerRpcService();
 778         logger.debug("In getItmIngress Action source {}, destination {}, elanTag {}", sourceDpnId, destinationDpnId, serviceTag);
 779         List<Action> actions = new ArrayList<>();
 780         String tunnelInterfaceName;
 781         GetTunnelInterfaceNameInput input = new GetTunnelInterfaceNameInputBuilder().setDestinationDpid(destinationDpnId).setSourceDpid(sourceDpnId).build();
 782         Future<RpcResult<GetTunnelInterfaceNameOutput>> output = itmManager.getTunnelInterfaceName(input);
 783         try {
 784             GetTunnelInterfaceNameOutput tunnelInterfaceNameOutput = output.get().getResult();
 785             tunnelInterfaceName = tunnelInterfaceNameOutput.getInterfaceName();
 786             logger.debug("Received tunnelInterfaceName from getTunnelInterfaceName RPC {}", tunnelInterfaceName);
 787         } catch (InterruptedException | ExecutionException e) {
 788             logger.error("Error in RPC call getTunnelInterfaceName {}", e);
 789             return actions;
 790         }
 791         if (tunnelInterfaceName != null && !tunnelInterfaceName.isEmpty()) {
 792             GetEgressActionsInput getEgressActionsForInterfaceInput = new GetEgressActionsInputBuilder().setServiceTag(Long.valueOf(serviceTag)).setIntfName(tunnelInterfaceName).build();
 793             Future<RpcResult<GetEgressActionsOutput>> egressActionsOutputFuture = interfaceManagerRpcService.getEgressActions(getEgressActionsForInterfaceInput);
 794             try {
 795                 GetEgressActionsOutput egressActionsOutput = egressActionsOutputFuture.get().getResult();
 796                 List<Action> outputAction = egressActionsOutput.getAction();
 797                 return outputAction;
 798             } catch (InterruptedException | ExecutionException e) {
 799                 logger.error("Error in RPC call getEgressActionsForInterface {}", e);
 800                 return actions;
 801             }
 802         }
 803         return actions;
 804     }
 805
 806     public static List<MatchInfo> getTunnelMatchesForServiceId(int elanTag) {
 807         List<MatchInfo> mkMatches = new ArrayList<MatchInfo>();
 808         // Matching metadata
 809         mkMatches.add(new MatchInfo(MatchFieldType.tunnel_id, new BigInteger[]{
 810                 BigInteger.valueOf(elanTag)}));
 811
 812         return mkMatches;
 813     }
 814
 815     public static void removeTerminatingServiceAction(BigInteger destDpId, int serviceId) {
 816         ItmRpcService itmRpcService = elanServiceProvider.getItmRpcService();
 817         RemoveTerminatingServiceActionsInput input = new RemoveTerminatingServiceActionsInputBuilder().setDpnId(destDpId).setServiceId(serviceId).build();
 818         Future<RpcResult<Void>> futureObject = itmRpcService.removeTerminatingServiceActions(input);
 819         try {
 820             RpcResult<Void> result = futureObject.get();
 821             if (result.isSuccessful()) {
 822                 logger.debug("Successfully completed removeTerminatingServiceActions");
 823             } else {
 824                 logger.debug("Failure in removeTerminatingServiceAction RPC call");
 825             }
 826         } catch (InterruptedException | ExecutionException e) {
 827             logger.error("Error in RPC call removeTerminatingServiceActions {}", e);
 828         }
 829     }
 830
 831     public static void createTerminatingServiceActions(BigInteger destDpId, int serviceId, List<Action> actions) {
 832         ItmRpcService itmRpcService = elanServiceProvider.getItmRpcService();
 833         List<Instruction> mkInstructions = new ArrayList<Instruction>();
 834         mkInstructions.add(getApplyActionInstruction(actions));
 835         CreateTerminatingServiceActionsInput input = new CreateTerminatingServiceActionsInputBuilder().setDpnId(destDpId).setServiceId(serviceId).setInstruction(mkInstructions).build();
 836
 837         itmRpcService.createTerminatingServiceActions(input);
 838     }
 839
 840     public static TunnelList buildInternalTunnel(DataBroker dataBroker) {
 841         InstanceIdentifier<TunnelList> tunnelListInstanceIdentifier = InstanceIdentifier.builder(TunnelList.class).build();
 842         Optional<TunnelList> tunnelList = read(dataBroker, LogicalDatastoreType.CONFIGURATION, tunnelListInstanceIdentifier);
 843         if(tunnelList.isPresent()) {
 844             return tunnelList.get();
 845         }
 846         return null;
 847     }
 848 }