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 Optional<IfIndexInterface> getInterfaceInfoByInterfaceTag(long interfaceTag) {
 341         DataBroker broker = elanServiceProvider.getBroker();
 342         InstanceIdentifier<IfIndexInterface> interfaceId = getInterfaceInfoEntriesOperationalDataPath(interfaceTag);
 343         return ElanUtils.read(broker, LogicalDatastoreType.OPERATIONAL, interfaceId);
 344     }
 345
 346     public static InstanceIdentifier<IfIndexInterface> getInterfaceInfoEntriesOperationalDataPath(long interfaceTag) {
 347         return InstanceIdentifier.builder(IfIndexesInterfaceMap.class).child(IfIndexInterface.class,
 348                 new IfIndexInterfaceKey((int) interfaceTag)).build();
 349     }
 350
 351
 352
 353     public static InstanceIdentifier<ElanDpnInterfacesList> getElanDpnOperationDataPath(String elanInstanceName) {
 354         return InstanceIdentifier.builder(ElanDpnInterfaces.class).child(ElanDpnInterfacesList.class, new ElanDpnInterfacesListKey(elanInstanceName)).build();
 355     }
 356
 357     public static  ElanDpnInterfacesList getElanDpnInterfacesList(String elanName) {
 358         DataBroker broker = elanServiceProvider.getBroker();
 359         InstanceIdentifier<ElanDpnInterfacesList> elanDpnInterfaceId = getElanDpnOperationDataPath(elanName);
 360         Optional<ElanDpnInterfacesList> existingElanDpnInterfaces = ElanUtils.read(broker, LogicalDatastoreType.OPERATIONAL, elanDpnInterfaceId);
 361         if(existingElanDpnInterfaces.isPresent()) {
 362             return existingElanDpnInterfaces.get();
 363         }
 364         return null;
 365     }
 366
 367     public static  ElanDpnInterfaces getElanDpnInterfacesList() {
 368         DataBroker broker = elanServiceProvider.getBroker();
 369         InstanceIdentifier<ElanDpnInterfaces> elanDpnInterfaceId = InstanceIdentifier.builder(ElanDpnInterfaces.class).build();
 370         Optional<ElanDpnInterfaces> existingElanDpnInterfaces = ElanUtils.read(broker, LogicalDatastoreType.OPERATIONAL, elanDpnInterfaceId);
 371         if(existingElanDpnInterfaces.isPresent()) {
 372             return existingElanDpnInterfaces.get();
 373         }
 374         return null;
 375     }
 376
 377     public static ElanForwardingTables getElanForwardingList() {
 378         DataBroker broker = elanServiceProvider.getBroker();
 379         InstanceIdentifier<ElanForwardingTables> elanForwardingTableId = InstanceIdentifier.builder(ElanForwardingTables.class).build();
 380         Optional<ElanForwardingTables> existingElanForwardingList = ElanUtils.read(broker, LogicalDatastoreType.OPERATIONAL, elanForwardingTableId);
 381         if(existingElanForwardingList.isPresent()) {
 382             return existingElanForwardingList.get();
 383         }
 384         return null;
 385     }
 386
 387
 388     public static long getElanLocalBCGID(long elanTag) {
 389         return ElanConstants.ELAN_GID_MIN + (((elanTag % ElanConstants.ELAN_GID_MIN) *2) - 1);
 390     }
 391
 392     public static long getElanRemoteBCGID(long elanTag) {
 393         return ElanConstants.ELAN_GID_MIN + (((elanTag % ElanConstants.ELAN_GID_MIN) *2));
 394     }
 395
 396     public static BigInteger getElanMetadataLabel(long elanTag) {
 397         return (BigInteger.valueOf(elanTag)).shiftLeft(24);
 398     }
 399
 400     public static BigInteger getElanMetadataLabel(long elanTag, int lportTag) {
 401         return getElanMetadataLabel(elanTag).or(MetaDataUtil.getLportTagMetaData(lportTag));
 402     }
 403
 404     public static BigInteger getElanMetadataMask() {
 405         return MetaDataUtil.METADATA_MASK_SERVICE.or(MetaDataUtil.METADATA_MASK_LPORT_TAG);
 406     }
 407
 408     public static void setupMacFlows(ElanInstance elanInfo, InterfaceInfo interfaceInfo, long macTimeout,
 409                                      String macAddress) {
 410         IMdsalApiManager mdsalApiManager = elanServiceProvider.getMdsalManager();
 411         DataBroker broker = elanServiceProvider.getBroker();
 412         ItmRpcService itmRpcService = elanServiceProvider.getItmRpcService();
 413         synchronized (macAddress) {
 414             logger.info("Acquired lock for mac : " + macAddress + "Proceeding with install operation.");
 415             setupKnownSmacFlow(elanInfo, interfaceInfo, macTimeout, macAddress, mdsalApiManager);
 416             setupTermDmacFlows(interfaceInfo, mdsalApiManager);
 417             setupOrigDmacFlows(elanInfo, interfaceInfo, macAddress, mdsalApiManager, broker);
 418         }
 419     }
 420
 421     public static void setupDMacFlowonRemoteDpn(ElanInstance elanInfo, InterfaceInfo interfaceInfo, BigInteger dstDpId,
 422                                      String macAddress) {
 423         synchronized (macAddress) {
 424             logger.info("Acquired lock for mac : " + macAddress + "Proceeding with install operation.");
 425             setupOrigDmacFlowsonRemoteDpn(elanInfo, interfaceInfo, dstDpId, macAddress);
 426         }
 427     }
 428
 429
 430     private static void setupKnownSmacFlow(ElanInstance elanInfo, InterfaceInfo interfaceInfo, long macTimeout,
 431                                            String macAddress, IMdsalApiManager mdsalApiManager) {
 432         FlowEntity flowEntity = getKnownSmacFlowEntity(elanInfo, interfaceInfo, macTimeout, macAddress);
 433         mdsalApiManager.installFlow(flowEntity);
 434         if (logger.isDebugEnabled()) {
 435             logger.debug("Known Smac flow entry created for elan Name:{}, logical Interface port:{} and mac address:{}", elanInfo.getElanInstanceName(), elanInfo.getDescription(), macAddress);
 436         }
 437     }
 438
 439     private static FlowEntity getKnownSmacFlowEntity(ElanInstance elanInfo, InterfaceInfo interfaceInfo, long macTimeout, String macAddress) {
 440         BigInteger dpId = interfaceInfo.getDpId();
 441         int lportTag = interfaceInfo.getInterfaceTag();
 442         long elanTag = elanInfo.getElanTag();
 443         // Matching metadata and eth_src fields
 444         List<MatchInfo> mkMatches = new ArrayList<MatchInfo>();
 445         mkMatches.add(new MatchInfo(MatchFieldType.metadata, new BigInteger[] {
 446                 ElanUtils.getElanMetadataLabel(elanInfo.getElanTag(), lportTag),
 447                 ElanUtils.getElanMetadataMask() }));
 448         mkMatches.add(new MatchInfo(MatchFieldType.eth_src, new String[] { macAddress }));
 449         List<InstructionInfo> mkInstructions = new ArrayList<InstructionInfo>();
 450         mkInstructions.add(new InstructionInfo(InstructionType.goto_table, new long[] { ElanConstants.ELAN_DMAC_TABLE }));
 451
 452         FlowEntity flowEntity = MDSALUtil.buildFlowEntity(dpId, ElanConstants.ELAN_SMAC_TABLE,
 453                 getKnownDynamicmacFlowRef(ElanConstants.ELAN_SMAC_TABLE, dpId, lportTag, macAddress, elanTag),
 454                 20, elanInfo.getDescription(), (int)macTimeout, 0, ElanConstants.COOKIE_ELAN_KNOWN_SMAC.add(BigInteger.valueOf(elanTag)),
 455                 mkMatches, mkInstructions);
 456         flowEntity.setStrictFlag(true);
 457         flowEntity.setSendFlowRemFlag(macTimeout != 0); //If Mac timeout is 0, the flow wont be deleted automatically, so no need to get notified
 458         return flowEntity;
 459     }
 460
 461     private static void setupTermDmacFlows(InterfaceInfo interfaceInfo, IMdsalApiManager mdsalApiManager) {
 462         BigInteger dpId = interfaceInfo.getDpId();
 463         int lportTag = interfaceInfo.getInterfaceTag();
 464         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),
 465                 getInstructionsInPortForOutGroup(interfaceInfo.getInterfaceName()));
 466         mdsalApiManager.installFlow(dpId, flow);
 467         if (logger.isDebugEnabled()) {
 468             logger.debug("Terminating service table flow entry created on dpn:{} for logical Interface port:{}", dpId, interfaceInfo.getPortName());
 469         }
 470     }
 471
 472     private static String getFlowRef(short tableId, int elanTag) {
 473         return new StringBuffer().append(tableId).append(elanTag).toString();
 474     }
 475
 476     private static List<MatchInfo> getTunnelIdMatchForFilterEqualsLPortTag(int LportTag) {
 477         List<MatchInfo> mkMatches = new ArrayList<MatchInfo>();
 478         // Matching metadata
 479         mkMatches.add(new MatchInfo(MatchFieldType.tunnel_id, new BigInteger[] {
 480                 BigInteger.valueOf(LportTag)}));
 481         return mkMatches;
 482
 483
 484     }
 485
 486     public static List<Instruction> getInstructionsInPortForOutGroup(
 487             String ifName) {
 488         List<Instruction> mkInstructions = new ArrayList<Instruction>();
 489         List <Action> actionsInfos = new ArrayList <Action> ();
 490         actionsInfos.addAll(ElanUtils.getEgressActionsForInterface(ifName));
 491         mkInstructions.add(new InstructionBuilder().setInstruction(new ApplyActionsCaseBuilder().setApplyActions(new ApplyActionsBuilder().setAction(actionsInfos).build()).build())
 492                 .setKey(new InstructionKey(0)).build());
 493              return mkInstructions;
 494     }
 495
 496     public static Instruction getWriteActionInstruction(List<Action> actions) {
 497         return new InstructionBuilder().setInstruction(new WriteActionsCaseBuilder().setWriteActions(new WriteActionsBuilder().setAction(actions).build()).build()).setKey(new InstructionKey(0)).build();
 498     }
 499
 500     public static Instruction getApplyActionInstruction(List<Action> actions) {
 501         return new InstructionBuilder().setInstruction(new ApplyActionsCaseBuilder().setApplyActions(new ApplyActionsBuilder().setAction(actions).build()).build()).setKey(new InstructionKey(0)).build();
 502     }
 503
 504
 505     public static List<Action> getEgressActionsForInterface(String ifName) {
 506         List<Action> listAction = new ArrayList<Action>();
 507         try {
 508             Future<RpcResult<GetEgressActionsForInterfaceOutput>> result =
 509                     elanServiceProvider.getInterfaceManagerRpcService().getEgressActionsForInterface(
 510                             new GetEgressActionsForInterfaceInputBuilder().setIntfName(ifName).build());
 511             RpcResult<GetEgressActionsForInterfaceOutput> rpcResult = result.get();
 512             if(!rpcResult.isSuccessful()) {
 513                 logger.warn("RPC Call to Get egress actions for interface {} returned with Errors {}", ifName, rpcResult.getErrors());
 514             } else {
 515                 List<org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.Action> actions =
 516                         rpcResult.getResult().getAction();
 517                 listAction = actions;
 518             }
 519         } catch (InterruptedException | ExecutionException e) {
 520             logger.warn("Exception when egress actions for interface {}", ifName, e);
 521         }
 522         return listAction;
 523     }
 524
 525     private static void setupOrigDmacFlows(ElanInstance elanInfo, InterfaceInfo interfaceInfo, String macAddress,
 526                                            IMdsalApiManager mdsalApiManager, DataBroker broker) {
 527         BigInteger dpId = interfaceInfo.getDpId();
 528         String ifName = interfaceInfo.getInterfaceName();
 529         long ifTag = interfaceInfo.getInterfaceTag();
 530         long groupId = interfaceInfo.getGroupId();
 531         String elanInstanceName = elanInfo.getElanInstanceName();
 532         List<DpnInterfaces> remoteFEs = getInvolvedDpnsInElan(elanInstanceName);
 533         if(remoteFEs != null) {
 534             for (DpnInterfaces remoteFE : remoteFEs) {
 535                 Long elanTag = elanInfo.getElanTag();
 536                 if (remoteFE.getDpId().equals(dpId)) {
 537                     // On the local FE set up a direct output flow
 538                     setupLocalDmacFlow(elanTag, dpId, ifName, macAddress, elanInstanceName, mdsalApiManager, ifTag);
 539                     if (logger.isDebugEnabled()) {
 540                         logger.debug("Dmac flow entry created for elan Name:{}, logical port Name:{} and mac address:{} on dpn:{}", elanInstanceName, interfaceInfo.getPortName(), macAddress, dpId);
 541                     }
 542                 } else {
 543                     if (isDpnPresent(remoteFE.getDpId())) {
 544                         // Check for the Remote DPN present in Inventory Manager
 545                         setupRemoteDmacFlow(remoteFE.getDpId(), dpId, interfaceInfo.getInterfaceTag(), elanTag, macAddress, elanInstanceName);
 546                         if (logger.isDebugEnabled()) {
 547                             logger.debug("Dmac flow entry created for elan Name:{}, logical port Name:{} and mac address:{} on dpn:{}", elanInstanceName, interfaceInfo.getPortName(), macAddress, remoteFE.getDpId());
 548                         }
 549                     }
 550                 }
 551             }
 552         }
 553     }
 554
 555     private static void setupOrigDmacFlowsonRemoteDpn(ElanInstance elanInfo, InterfaceInfo interfaceInfo, BigInteger dstDpId, String macAddress) {
 556         BigInteger dpId = interfaceInfo.getDpId();
 557         String elanInstanceName = elanInfo.getElanInstanceName();
 558         List<DpnInterfaces> remoteFEs = getInvolvedDpnsInElan(elanInstanceName);
 559         for(DpnInterfaces remoteFE: remoteFEs) {
 560             Long elanTag = elanInfo.getElanTag();
 561             if (remoteFE.getDpId().equals(dstDpId)) {
 562                 // Check for the Remote DPN present in Inventory Manager
 563                 setupRemoteDmacFlow(dstDpId, dpId, interfaceInfo.getInterfaceTag(), elanTag, macAddress, elanInstanceName);
 564                 if (logger.isDebugEnabled()) {
 565                     logger.debug("Dmac flow entry created for elan Name:{}, logical port Name:{} and mac address {} on dpn:{}", elanInstanceName, interfaceInfo.getPortName(), macAddress, remoteFE.getDpId());
 566                 }
 567                 break;
 568             }
 569         }
 570     }
 571
 572
 573     @SuppressWarnings("unchecked")
 574     public static List<DpnInterfaces> getInvolvedDpnsInElan(String elanName) {
 575         List<DpnInterfaces> dpns = ElanInstanceManager.getElanInstanceManager().getElanDPNByName(elanName);
 576         return dpns;
 577     }
 578
 579     private static void setupLocalDmacFlow(long elanTag, BigInteger dpId, String ifName, String macAddress,
 580                                            String displayName, IMdsalApiManager mdsalApiManager, long ifTag) {
 581         Flow flowEntity = getLocalDmacFlowEntry(elanTag, dpId, ifName, macAddress, displayName, ifTag);
 582         mdsalApiManager.installFlow(dpId, flowEntity);
 583
 584     }
 585
 586     public static String getKnownDynamicmacFlowRef(short tableId, BigInteger dpId, long lporTag, String macAddress, long elanTag) {
 587         return new StringBuffer().append(tableId).append(elanTag).append(dpId).append(lporTag).append(macAddress).toString();
 588     }
 589
 590     public static String getKnownDynamicmacFlowRef(short tableId, BigInteger dpId, BigInteger remoteDpId, String macAddress, long elanTag) {
 591         return new StringBuffer().append(tableId).append(elanTag).append(dpId).append(remoteDpId).append(macAddress).toString();
 592     }
 593
 594     public static Flow getLocalDmacFlowEntry(long elanTag, BigInteger dpId, String ifName, String macAddress,
 595                                                    String displayName, long ifTag) {
 596         List<MatchInfo> mkMatches = new ArrayList<MatchInfo>();
 597         mkMatches.add(new MatchInfo(MatchFieldType.metadata, new BigInteger[] {
 598                 ElanUtils.getElanMetadataLabel(elanTag),
 599                 MetaDataUtil.METADATA_MASK_SERVICE }));
 600         mkMatches.add(new MatchInfo(MatchFieldType.eth_dst, new String[] { macAddress }));
 601
 602         List<Instruction> mkInstructions = new ArrayList<Instruction>();
 603         List <Action> actionsInfos = new ArrayList <Action> ();
 604         actionsInfos.addAll(getEgressActionsForInterface(ifName));
 605         mkInstructions.add(new InstructionBuilder().setInstruction(new ApplyActionsCaseBuilder().setApplyActions(new ApplyActionsBuilder().setAction(actionsInfos).build()).build())
 606                 .setKey(new InstructionKey(0)).build());
 607         Flow flow = MDSALUtil.buildFlowNew(ElanConstants.ELAN_DMAC_TABLE, getKnownDynamicmacFlowRef(ElanConstants.ELAN_DMAC_TABLE, dpId, ifTag, macAddress, elanTag),
 608                 20, displayName, 0, 0, ElanConstants.COOKIE_ELAN_KNOWN_DMAC.add(BigInteger.valueOf(elanTag)), mkMatches, mkInstructions);
 609
 610         return flow;
 611     }
 612
 613     public static void setupRemoteDmacFlow(BigInteger srcDpId, BigInteger destDpId, int lportTag, long elanTag, String macAddress,
 614                                            String displayName) {
 615         IMdsalApiManager mdsalApiManager = elanServiceProvider.getMdsalManager();
 616         Flow flowEntity = getRemoteDmacFlowEntry(srcDpId, destDpId, lportTag, elanTag, macAddress, displayName);
 617         mdsalApiManager.installFlow(srcDpId, flowEntity);
 618     }
 619
 620     public static Flow getRemoteDmacFlowEntry(BigInteger srcDpId, BigInteger destDpId, int lportTag, long elanTag,
 621                                               String macAddress, String displayName) {
 622         ItmRpcService itmRpcService = elanServiceProvider.getItmRpcService();
 623         List<MatchInfo> mkMatches = new ArrayList<MatchInfo>();
 624         mkMatches.add(new MatchInfo(MatchFieldType.metadata, new BigInteger[]{
 625                 ElanUtils.getElanMetadataLabel(elanTag),
 626                 MetaDataUtil.METADATA_MASK_SERVICE }));
 627         mkMatches.add(new MatchInfo(MatchFieldType.eth_dst, new String[] { macAddress }));
 628
 629         List<Instruction> mkInstructions = new ArrayList<Instruction>();
 630
 631         //List of ActionInfo for the provided Source and Destination DPIDs
 632         try {
 633             List<Action> actionsInfos = getItmEgressAction(srcDpId, destDpId, lportTag);
 634             Instruction instruction = new InstructionBuilder().setInstruction(new ApplyActionsCaseBuilder().setApplyActions(new ApplyActionsBuilder().setAction(actionsInfos).build()).build())
 635                     .setKey(new InstructionKey(0)).build();
 636             mkInstructions.add(instruction);
 637         } catch (Exception e) {
 638             logger.error("Interface Not Found exception");
 639         }
 640
 641
 642         Flow flow = MDSALUtil.buildFlowNew(ElanConstants.ELAN_DMAC_TABLE, getKnownDynamicmacFlowRef(ElanConstants.ELAN_DMAC_TABLE, srcDpId, destDpId, macAddress, elanTag), 20
 643                 , displayName, 0, 0, ElanConstants.COOKIE_ELAN_KNOWN_DMAC.add(BigInteger.valueOf(elanTag)), mkMatches, mkInstructions);
 644
 645         return flow;
 646
 647     }
 648
 649     public static void deleteMacFlows(ElanInstance elanInfo, InterfaceInfo interfaceInfo, MacEntry macEntry) {
 650         if (elanInfo == null || interfaceInfo == null) {
 651             return;
 652         }
 653         String macAddress = macEntry.getMacAddress().getValue();
 654         synchronized (macAddress) {
 655             logger.info("Acquired lock for mac : " + macAddress + "Proceeding with remove operation.");
 656             deleteMacFlows(elanInfo, interfaceInfo,  macAddress, true);
 657         }
 658     }
 659
 660     public static void deleteMacFlows(ElanInstance elanInfo, InterfaceInfo interfaceInfo, String macAddress, boolean deleteSmac) {
 661         String elanInstanceName = elanInfo.getElanInstanceName();
 662         long ifTag = interfaceInfo.getInterfaceTag();
 663         List<DpnInterfaces> remoteFEs = getInvolvedDpnsInElan(elanInstanceName);
 664         IMdsalApiManager mdsalApiManager = elanServiceProvider.getMdsalManager();
 665         ItmRpcService itmRpcService = elanServiceProvider.getItmRpcService();
 666         BigInteger srcdpId = interfaceInfo.getDpId();
 667         for (DpnInterfaces dpnInterface: remoteFEs) {
 668             Long elanTag = elanInfo.getElanTag();
 669             BigInteger dstDpId = dpnInterface.getDpId();
 670             if (dstDpId.equals(srcdpId)) {
 671                 if(deleteSmac) {
 672                     mdsalApiManager.removeFlow(srcdpId, MDSALUtil.buildFlow(ElanConstants.ELAN_SMAC_TABLE,
 673                             getKnownDynamicmacFlowRef(ElanConstants.ELAN_SMAC_TABLE, srcdpId, ifTag, macAddress, elanTag)));
 674                 }
 675                 mdsalApiManager.removeFlow(srcdpId, MDSALUtil.buildFlow(ElanConstants.ELAN_DMAC_TABLE,
 676                         getKnownDynamicmacFlowRef(ElanConstants.ELAN_DMAC_TABLE, srcdpId, ifTag, macAddress, elanTag)));
 677                 RemoveTerminatingServiceActionsInput removeTerminatingServiceActionsInput = new RemoveTerminatingServiceActionsInputBuilder().setServiceId(interfaceInfo.getInterfaceTag()).setDpnId(srcdpId).build();
 678                 itmRpcService.removeTerminatingServiceActions(removeTerminatingServiceActionsInput);
 679                   if (logger.isDebugEnabled()) {
 680                     logger.debug("All the required flows deleted for elan:{}, logical Interface port:{} and mac address:{} on dpn:{}", elanInstanceName, interfaceInfo.getPortName(), macAddress, srcdpId);
 681                 }
 682             } else if (isDpnPresent(dstDpId)) {
 683                 mdsalApiManager.removeFlow(dstDpId, MDSALUtil.buildFlow(ElanConstants.ELAN_DMAC_TABLE,
 684                         getKnownDynamicmacFlowRef(ElanConstants.ELAN_DMAC_TABLE, srcdpId, dstDpId, macAddress, elanTag)));
 685                 if (logger.isDebugEnabled()) {
 686                     logger.debug("Dmac flow entry deleted for elan:{}, logical interface port:{} and mac address:{} on dpn:{}", elanInstanceName, interfaceInfo.getPortName(), macAddress, dstDpId);
 687                 }
 688             }
 689         }
 690     }
 691
 692     public static void UpdateOperationalDataStore(DataBroker broker, IdManagerService idManager, ElanInstance elanInstanceAdded) {
 693         String elanInstanceName = elanInstanceAdded.getElanInstanceName();
 694         long elanTag = ElanUtils.getUniqueId(idManager, ElanConstants.ELAN_ID_POOL_NAME, elanInstanceName);
 695         Elan elanInfo = new ElanBuilder().setName(elanInstanceName).setKey(new ElanKey(elanInstanceName)).build();
 696         //Add the ElanState in the elan-state operational data-store
 697         MDSALUtil.syncWrite(broker, LogicalDatastoreType.OPERATIONAL, ElanUtils.getElanInstanceOperationalDataPath(elanInstanceName), elanInfo);
 698         //Add the ElanMacTable in the elan-mac-table operational data-store
 699         MacTable elanMacTable = new MacTableBuilder().setKey(new MacTableKey(elanInstanceName)).build();
 700         MDSALUtil.syncWrite(broker, LogicalDatastoreType.OPERATIONAL, ElanUtils.getElanMacTableOperationalDataPath(elanInstanceName), elanMacTable);
 701         ElanTagName elanTagName = new ElanTagNameBuilder().setElanTag(elanTag).setKey(new ElanTagNameKey(elanTag)).setName(elanInstanceName).build();
 702         //Add the ElanTag to ElanName in the elan-tag-name Operational data-store
 703         MDSALUtil.syncWrite(broker, LogicalDatastoreType.OPERATIONAL, ElanUtils.getElanInfoEntriesOperationalDataPath(elanTag), elanTagName);
 704         ElanInstance elanInstanceWithTag = new ElanInstanceBuilder().setElanInstanceName(elanInstanceName).setDescription(elanInstanceAdded.getDescription()).setMacTimeout(elanInstanceAdded
 705                 .getMacTimeout() == null ? ElanConstants.DEFAULT_MAC_TIME_OUT : elanInstanceAdded.getMacTimeout()).setKey(elanInstanceAdded.getKey()).setElanTag(elanTag).build();
 706         MDSALUtil.syncUpdate(broker, LogicalDatastoreType.CONFIGURATION, getElanInstanceIdentifier(elanInstanceName), elanInstanceWithTag);
 707     }
 708
 709     public static boolean isDpnPresent(BigInteger dpnId) {
 710         DataBroker broker = elanServiceProvider.getBroker();
 711         boolean isPresent = false;
 712         String dpn = String.format("%s:%s", "openflow",dpnId);
 713         NodeId nodeId = new NodeId(dpn);
 714         InstanceIdentifier<Node> node = InstanceIdentifier.builder(Nodes.class).child(Node.class, new NodeKey(nodeId)).build();
 715         Optional<Node> nodePresent = read(broker, LogicalDatastoreType.OPERATIONAL, node);
 716         if(nodePresent.isPresent()) {
 717             isPresent = true;
 718         }
 719         return isPresent;
 720     }
 721
 722     public static ServicesInfo getServiceInfo(String elanInstanceName, long elanTag, String interfaceName) {
 723         int priority = ElanConstants.ELAN_SERVICE_PRIORITY;
 724         int instructionKey = 0;
 725         List<Instruction> instructions = new ArrayList<Instruction>();
 726         instructions.add(MDSALUtil.buildAndGetWriteMetadaInstruction(ElanUtils.getElanMetadataLabel(elanTag), MetaDataUtil.METADATA_MASK_SERVICE, ++instructionKey));
 727         instructions.add(MDSALUtil.buildAndGetGotoTableInstruction(ElanConstants.ELAN_SMAC_TABLE, ++instructionKey));
 728
 729         ServicesInfo serviceInfo = InterfaceServiceUtil.buildServiceInfo(String.format("%s.%s", elanInstanceName, interfaceName), ElanConstants.ELAN_SERVICE_INDEX,
 730                 priority, ElanConstants.COOKIE_ELAN_INGRESS_TABLE, instructions);
 731         return serviceInfo;
 732     }
 733
 734     public static <T extends DataObject> void delete(DataBroker broker, LogicalDatastoreType datastoreType,
 735                                               InstanceIdentifier<T> path, FutureCallback<Void> callback) {
 736         WriteTransaction tx = broker.newWriteOnlyTransaction();
 737         tx.delete(datastoreType, path);
 738         Futures.addCallback(tx.submit(), callback);
 739     }
 740
 741     public static <T extends DataObject> void syncWrite(DataBroker broker, LogicalDatastoreType datastoreType,
 742                                                         InstanceIdentifier<T> path, T data) {
 743         WriteTransaction tx = broker.newWriteOnlyTransaction();
 744         tx.put(datastoreType, path, data, true);
 745         CheckedFuture<Void, TransactionCommitFailedException> futures = tx.submit();
 746         try {
 747             futures.get();
 748         } catch (InterruptedException | ExecutionException e) {
 749             logger.error("Error writing to datastore (path, data) : ({}, {})", path, data);
 750             throw new RuntimeException(e.getMessage());
 751         }
 752     }
 753
 754
 755     public static BoundServices getBoundServices(String serviceName, short servicePriority, int flowPriority,
 756                                                  BigInteger cookie, List<Instruction> instructions) {
 757         StypeOpenflowBuilder augBuilder = new StypeOpenflowBuilder().setFlowCookie(cookie).setFlowPriority(flowPriority).setInstruction(instructions);
 758         return new BoundServicesBuilder().setKey(new BoundServicesKey(servicePriority))
 759                 .setServiceName(serviceName).setServicePriority(servicePriority)
 760                 .setServiceType(ServiceTypeFlowBased.class).addAugmentation(StypeOpenflow.class, augBuilder.build()).build();
 761     }
 762
 763     public static InstanceIdentifier<BoundServices> buildServiceId(String vpnInterfaceName, short serviceIndex) {
 764         return InstanceIdentifier.builder(ServiceBindings.class).child(ServicesInfo.class, new ServicesInfoKey(vpnInterfaceName))
 765                 .child(BoundServices.class, new BoundServicesKey(serviceIndex)).build();
 766     }
 767
 768
 769     public static List<Action> getItmEgressAction(BigInteger sourceDpnId,
 770                                                       BigInteger destinationDpnId, int serviceTag) {
 771         ItmRpcService itmManager = elanServiceProvider.getItmRpcService();
 772         OdlInterfaceRpcService interfaceManagerRpcService = elanServiceProvider.getInterfaceManagerRpcService();
 773         logger.debug("In getItmIngress Action source {}, destination {}, elanTag {}", sourceDpnId, destinationDpnId, serviceTag);
 774         List<Action> actions = new ArrayList<>();
 775         String tunnelInterfaceName;
 776         GetTunnelInterfaceNameInput input = new GetTunnelInterfaceNameInputBuilder().setDestinationDpid(destinationDpnId).setSourceDpid(sourceDpnId).build();
 777         Future<RpcResult<GetTunnelInterfaceNameOutput>> output = itmManager.getTunnelInterfaceName(input);
 778         try {
 779             GetTunnelInterfaceNameOutput tunnelInterfaceNameOutput = output.get().getResult();
 780             tunnelInterfaceName = tunnelInterfaceNameOutput.getInterfaceName();
 781             logger.debug("Received tunnelInterfaceName from getTunnelInterfaceName RPC {}", tunnelInterfaceName);
 782         } catch (InterruptedException | ExecutionException e) {
 783             logger.error("Error in RPC call getTunnelInterfaceName {}", e);
 784             return actions;
 785         }
 786         if (tunnelInterfaceName != null && !tunnelInterfaceName.isEmpty()) {
 787             GetEgressActionsInput getEgressActionsForInterfaceInput = new GetEgressActionsInputBuilder().setServiceTag(Long.valueOf(serviceTag)).setIntfName(tunnelInterfaceName).build();
 788             Future<RpcResult<GetEgressActionsOutput>> egressActionsOutputFuture = interfaceManagerRpcService.getEgressActions(getEgressActionsForInterfaceInput);
 789             try {
 790                 GetEgressActionsOutput egressActionsOutput = egressActionsOutputFuture.get().getResult();
 791                 List<Action> outputAction = egressActionsOutput.getAction();
 792                 return outputAction;
 793             } catch (InterruptedException | ExecutionException e) {
 794                 logger.error("Error in RPC call getEgressActionsForInterface {}", e);
 795                 return actions;
 796             }
 797         }
 798         return actions;
 799     }
 800
 801     public static List<MatchInfo> getTunnelMatchesForServiceId(int elanTag) {
 802         List<MatchInfo> mkMatches = new ArrayList<MatchInfo>();
 803         // Matching metadata
 804         mkMatches.add(new MatchInfo(MatchFieldType.tunnel_id, new BigInteger[]{
 805                 BigInteger.valueOf(elanTag)}));
 806
 807         return mkMatches;
 808     }
 809
 810     public static void removeTerminatingServiceAction(BigInteger destDpId, int serviceId) {
 811         ItmRpcService itmRpcService = elanServiceProvider.getItmRpcService();
 812         RemoveTerminatingServiceActionsInput input = new RemoveTerminatingServiceActionsInputBuilder().setDpnId(destDpId).setServiceId(serviceId).build();
 813         Future<RpcResult<Void>> futureObject = itmRpcService.removeTerminatingServiceActions(input);
 814         try {
 815             RpcResult<Void> result = futureObject.get();
 816             if (result.isSuccessful()) {
 817                 logger.debug("Successfully completed removeTerminatingServiceActions");
 818             } else {
 819                 logger.debug("Failure in removeTerminatingServiceAction RPC call");
 820             }
 821         } catch (InterruptedException | ExecutionException e) {
 822             logger.error("Error in RPC call removeTerminatingServiceActions {}", e);
 823         }
 824     }
 825
 826     public static void createTerminatingServiceActions(BigInteger destDpId, int serviceId, List<Action> actions) {
 827         ItmRpcService itmRpcService = elanServiceProvider.getItmRpcService();
 828         List<Instruction> mkInstructions = new ArrayList<Instruction>();
 829         mkInstructions.add(getApplyActionInstruction(actions));
 830         CreateTerminatingServiceActionsInput input = new CreateTerminatingServiceActionsInputBuilder().setDpnId(destDpId).setServiceId(serviceId).setInstruction(mkInstructions).build();
 831
 832         itmRpcService.createTerminatingServiceActions(input);
 833     }
 834
 835     public static TunnelList buildInternalTunnel(DataBroker dataBroker) {
 836         InstanceIdentifier<TunnelList> tunnelListInstanceIdentifier = InstanceIdentifier.builder(TunnelList.class).build();
 837         Optional<TunnelList> tunnelList = read(dataBroker, LogicalDatastoreType.CONFIGURATION, tunnelListInstanceIdentifier);
 838         if(tunnelList.isPresent()) {
 839             return tunnelList.get();
 840         }
 841         return null;
 842     }
 843 }