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