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

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