vpnmanager/impl/src/main/java/org/opendaylight/netvirt/vpnmanager/VpnUtil.java

   1 /*
   2  * Copyright © 2016, 2017 Ericsson India Global Services Pvt Ltd. and others. All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8
   9 package org.opendaylight.netvirt.vpnmanager;
  10
  11 import com.google.common.base.Optional;
  12 import com.google.common.collect.Iterators;
  13 import com.google.common.util.concurrent.FutureCallback;
  14 import com.google.common.util.concurrent.Futures;
  15 import com.google.common.util.concurrent.ListenableFuture;
  16 import com.google.common.util.concurrent.MoreExecutors;
  17 import java.math.BigInteger;
  18 import java.net.Inet4Address;
  19 import java.net.Inet6Address;
  20 import java.net.InetAddress;
  21 import java.net.UnknownHostException;
  22 import java.text.SimpleDateFormat;
  23 import java.util.ArrayList;
  24 import java.util.Collection;
  25 import java.util.Collections;
  26 import java.util.Date;
  27 import java.util.HashMap;
  28 import java.util.HashSet;
  29 import java.util.List;
  30 import java.util.Locale;
  31 import java.util.Map;
  32 import java.util.Map.Entry;
  33 import java.util.Set;
  34 import java.util.concurrent.ExecutionException;
  35 import java.util.concurrent.Future;
  36 import java.util.function.Predicate;
  37 import java.util.stream.Collectors;
  38 import javax.annotation.Nonnull;
  39 import javax.annotation.Nullable;
  40 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  41 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  42 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  43 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  44 import org.opendaylight.genius.infra.ManagedNewTransactionRunner;
  45 import org.opendaylight.genius.interfacemanager.interfaces.IInterfaceManager;
  46 import org.opendaylight.genius.mdsalutil.FlowEntity;
  47 import org.opendaylight.genius.mdsalutil.FlowEntityBuilder;
  48 import org.opendaylight.genius.mdsalutil.InstructionInfo;
  49 import org.opendaylight.genius.mdsalutil.MDSALUtil;
  50 import org.opendaylight.genius.mdsalutil.MatchInfo;
  51 import org.opendaylight.genius.mdsalutil.MetaDataUtil;
  52 import org.opendaylight.genius.mdsalutil.NWUtil;
  53 import org.opendaylight.genius.mdsalutil.NwConstants;
  54 import org.opendaylight.genius.mdsalutil.actions.ActionRegLoad;
  55 import org.opendaylight.genius.mdsalutil.instructions.InstructionGotoTable;
  56 import org.opendaylight.genius.mdsalutil.instructions.InstructionWriteMetadata;
  57 import org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager;
  58 import org.opendaylight.genius.mdsalutil.matches.MatchEthernetDestination;
  59 import org.opendaylight.genius.mdsalutil.matches.MatchMetadata;
  60 import org.opendaylight.genius.utils.ServiceIndex;
  61 import org.opendaylight.genius.utils.SystemPropertyReader;
  62 import org.opendaylight.infrautils.jobcoordinator.JobCoordinator;
  63 import org.opendaylight.netvirt.bgpmanager.api.IBgpManager;
  64 import org.opendaylight.netvirt.elanmanager.api.ElanHelper;
  65 import org.opendaylight.netvirt.fibmanager.api.FibHelper;
  66 import org.opendaylight.netvirt.fibmanager.api.RouteOrigin;
  67 import org.opendaylight.netvirt.neutronvpn.api.enums.IpVersionChoice;
  68 import org.opendaylight.netvirt.neutronvpn.interfaces.INeutronVpnManager;
  69 import org.opendaylight.netvirt.vpnmanager.api.InterfaceUtils;
  70 import org.opendaylight.netvirt.vpnmanager.api.VpnExtraRouteHelper;
  71 import org.opendaylight.netvirt.vpnmanager.api.VpnHelper;
  72 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnAfConfig;
  73 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnInstances;
  74 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnInterfaces;
  75 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.instances.VpnInstance;
  76 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.instances.VpnInstanceKey;
  77 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.VpnInterface;
  78 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.VpnInterfaceBuilder;
  79 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.VpnInterfaceKey;
  80 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.vpn._interface.VpnInstanceNames;
  81 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.vpn._interface.VpnInstanceNames.AssociatedSubnetType;
  82 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.vpn._interface.VpnInstanceNamesBuilder;
  83 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  84 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.Interfaces;
  85 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
  86 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
  87 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress;
  88 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid;
  89 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.Action;
  90 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction;
  91 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdInput;
  92 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdInputBuilder;
  93 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdOutput;
  94 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService;
  95 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdPools;
  96 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdInput;
  97 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdInputBuilder;
  98 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.id.pools.IdPool;
  99 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.id.pools.IdPoolKey;
 100 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406.IfIndexesInterfaceMap;
 101 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406._if.indexes._interface.map.IfIndexInterface;
 102 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406._if.indexes._interface.map.IfIndexInterfaceKey;
 103 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.GetInterfaceFromIfIndexInput;
 104 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.GetInterfaceFromIfIndexInputBuilder;
 105 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.GetInterfaceFromIfIndexOutput;
 106 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.OdlInterfaceRpcService;
 107 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.services.info.BoundServices;
 108 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.LockManagerService;
 109 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.TimeUnits;
 110 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.TryLockInput;
 111 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.TryLockInputBuilder;
 112 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.UnlockInput;
 113 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.UnlockInputBuilder;
 114 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.ElanDpnInterfaces;
 115 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.ElanInterfaces;
 116 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.ElanTagNameMap;
 117 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeVlan;
 118 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.dpn.interfaces.ElanDpnInterfacesList;
 119 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.dpn.interfaces.ElanDpnInterfacesListKey;
 120 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.dpn.interfaces.elan.dpn.interfaces.list.DpnInterfaces;
 121 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.dpn.interfaces.elan.dpn.interfaces.list.DpnInterfacesBuilder;
 122 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.dpn.interfaces.elan.dpn.interfaces.list.DpnInterfacesKey;
 123 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.instances.ElanInstance;
 124 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.ElanInterface;
 125 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.ElanInterfaceKey;
 126 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.tag.name.map.ElanTagName;
 127 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.tag.name.map.ElanTagNameKey;
 128 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.FibEntries;
 129 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.VrfEntryBase;
 130 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.extraroute.rds.map.extraroute.rds.dest.prefixes.AllocatedRdsBuilder;
 131 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.extraroute.rds.map.extraroute.rds.dest.prefixes.AllocatedRdsKey;
 132 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.fibentries.VrfTables;
 133 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.fibentries.VrfTablesKey;
 134 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.vrfentries.VrfEntry;
 135 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.vrfentries.VrfEntryKey;
 136 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3nexthop.rev150409.L3nexthop;
 137 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3nexthop.rev150409.l3nexthop.VpnNexthops;
 138 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3nexthop.rev150409.l3nexthop.VpnNexthopsKey;
 139 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.Adjacencies;
 140 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.AdjacenciesBuilder;
 141 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.AdjacenciesOp;
 142 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.AdjacenciesOpBuilder;
 143 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.LearntVpnVipToPortData;
 144 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.LearntVpnVipToPortEventAction;
 145 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.LearntVpnVipToPortEventData;
 146 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.PrefixToInterface;
 147 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.RouterInterfaces;
 148 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.SubnetOpData;
 149 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnIdToVpnInstance;
 150 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnInstanceOpData;
 151 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnInstanceToVpnId;
 152 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnInterfaceOpData;
 153 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnToExtraroutes;
 154 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.adjacency.list.Adjacency;
 155 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.adjacency.list.Adjacency.AdjacencyType;
 156 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.adjacency.list.AdjacencyKey;
 157 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.data.LearntVpnVipToPort;
 158 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.data.LearntVpnVipToPortBuilder;
 159 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.data.LearntVpnVipToPortKey;
 160 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.event.data.LearntVpnVipToPortEvent;
 161 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.event.data.LearntVpnVipToPortEventBuilder;
 162 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.event.data.LearntVpnVipToPortEventKey;
 163 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.prefix.to._interface.VpnIds;
 164 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.prefix.to._interface.VpnIdsBuilder;
 165 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.prefix.to._interface.VpnIdsKey;
 166 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.prefix.to._interface.vpn.ids.Prefixes;
 167 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.prefix.to._interface.vpn.ids.PrefixesBuilder;
 168 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.prefix.to._interface.vpn.ids.PrefixesKey;
 169 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.router.interfaces.RouterInterface;
 170 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.router.interfaces.RouterInterfaceBuilder;
 171 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.router.interfaces.RouterInterfaceKey;
 172 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.subnet.op.data.SubnetOpDataEntry;
 173 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.subnet.op.data.SubnetOpDataEntryKey;
 174 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn._interface.op.data.VpnInterfaceOpDataEntry;
 175 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn._interface.op.data.VpnInterfaceOpDataEntryBuilder;
 176 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn._interface.op.data.VpnInterfaceOpDataEntryKey;
 177 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntry;
 178 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntryKey;
 179 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.VpnTargets;
 180 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.VpnToDpnList;
 181 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.VpnToDpnListKey;
 182 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.vpntargets.VpnTarget;
 183 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstanceBuilder;
 184 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.to.extraroutes.Vpn;
 185 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.to.extraroutes.VpnKey;
 186 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.to.extraroutes.vpn.extra.routes.Routes;
 187 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.to.extraroutes.vpn.extra.routes.RoutesBuilder;
 188 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ExtRouters;
 189 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ExternalNetworks;
 190 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ExternalSubnets;
 191 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.NaptSwitches;
 192 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext.routers.Routers;
 193 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext.routers.RoutersKey;
 194 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext.routers.routers.ExternalIps;
 195 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.networks.Networks;
 196 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.networks.NetworksKey;
 197 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets.SubnetsKey;
 198 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.napt.switches.RouterToNaptSwitch;
 199 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.napt.switches.RouterToNaptSwitchKey;
 200 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.NetworkAttributes.NetworkType;
 201 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.NetworkMaps;
 202 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.NeutronVpnPortipPortData;
 203 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.RouterInterfacesMap;
 204 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.Subnetmaps;
 205 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.networkmaps.NetworkMap;
 206 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.networkmaps.NetworkMapKey;
 207 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.neutron.vpn.portip.port.data.VpnPortipToPort;
 208 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.neutron.vpn.portip.port.data.VpnPortipToPortKey;
 209 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.subnetmaps.Subnetmap;
 210 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.subnetmaps.SubnetmapKey;
 211 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.constants.rev150712.IpVersionBase;
 212 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.constants.rev150712.IpVersionV4;
 213 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.ext.rev150712.NetworkL3Extension;
 214 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.Network;
 215 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.NetworkKey;
 216 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes.FixedIps;
 217 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.ports.Port;
 218 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.rev150712.Neutron;
 219 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.Subnets;
 220 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.Subnet;
 221 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.SubnetKey;
 222 import org.opendaylight.yangtools.yang.binding.DataObject;
 223 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
 224 import org.opendaylight.yangtools.yang.common.RpcResult;
 225 import org.opendaylight.yangtools.yang.data.impl.schema.tree.SchemaValidationFailedException;
 226 import org.slf4j.Logger;
 227 import org.slf4j.LoggerFactory;
 228
 229 public final class VpnUtil {
 230     private static final Logger LOG = LoggerFactory.getLogger(VpnUtil.class);
 231     private static final int DEFAULT_PREFIX_LENGTH = 32;
 232     private static final String PREFIX_SEPARATOR = "/";
 233
 234     /**
 235      * Class to generate timestamps with microsecond precision.
 236      * For example: MicroTimestamp.INSTANCE.get() = "2012-10-21 19:13:45.267128"
 237      */
 238     public enum MicroTimestamp {
 239         INSTANCE ;
 240
 241         private long              startDate ;
 242         private long              startNanoseconds ;
 243         private SimpleDateFormat  dateFormat ;
 244
 245         MicroTimestamp() {
 246             this.startDate = System.currentTimeMillis() ;
 247             this.startNanoseconds = System.nanoTime() ;
 248             this.dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss.SSS") ;
 249         }
 250
 251         public String get() {
 252             long microSeconds = (System.nanoTime() - this.startNanoseconds) / 1000 ;
 253             long date = this.startDate + (microSeconds / 1000) ;
 254             return this.dateFormat.format(date) + String.format("%03d", microSeconds % 1000) ;
 255         }
 256     }
 257
 258     private VpnUtil() {
 259     }
 260
 261     static InstanceIdentifier<VpnInterface> getVpnInterfaceIdentifier(String vpnInterfaceName) {
 262         return InstanceIdentifier.builder(VpnInterfaces.class)
 263             .child(VpnInterface.class, new VpnInterfaceKey(vpnInterfaceName)).build();
 264     }
 265
 266     static InstanceIdentifier<VpnInterfaceOpDataEntry> getVpnInterfaceOpDataEntryIdentifier(
 267                                                              String vpnInterfaceName, String vpnName) {
 268         return InstanceIdentifier.builder(VpnInterfaceOpData.class)
 269             .child(VpnInterfaceOpDataEntry.class,
 270             new VpnInterfaceOpDataEntryKey(vpnInterfaceName, vpnName)).build();
 271     }
 272
 273     static InstanceIdentifier<VpnInstance> getVpnInstanceIdentifier(String vpnName) {
 274         return InstanceIdentifier.builder(VpnInstances.class)
 275             .child(VpnInstance.class, new VpnInstanceKey(vpnName)).build();
 276     }
 277
 278     static VpnInterface getVpnInterface(DataBroker broker, String vpnInterfaceName) {
 279         InstanceIdentifier<VpnInterface> id = getVpnInterfaceIdentifier(vpnInterfaceName);
 280         Optional<VpnInterface> vpnInterface = read(broker, LogicalDatastoreType.CONFIGURATION, id);
 281         return vpnInterface.isPresent() ? vpnInterface.get() : null;
 282     }
 283
 284     static VpnInterfaceOpDataEntry getVpnInterfaceOpDataEntry(String intfName, String vpnName,
 285                                         AdjacenciesOp aug, BigInteger dpnId,
 286                                         Boolean isSheduledForRemove, long lportTag, String gwMac) {
 287         return new VpnInterfaceOpDataEntryBuilder().setKey(new VpnInterfaceOpDataEntryKey(intfName, vpnName))
 288             .setDpnId(dpnId).setScheduledForRemove(isSheduledForRemove).addAugmentation(AdjacenciesOp.class, aug)
 289                 .setLportTag(lportTag).setGatewayMacAddress(gwMac).build();
 290     }
 291
 292     static Optional<VpnInterfaceOpDataEntry> getVpnInterfaceOpDataEntry(DataBroker broker,
 293                                                     String vpnInterfaceName, String vpnName) {
 294         InstanceIdentifier<VpnInterfaceOpDataEntry> id = getVpnInterfaceOpDataEntryIdentifier(vpnInterfaceName,
 295                                                                                               vpnName);
 296         Optional<VpnInterfaceOpDataEntry> vpnInterfaceOpDataEntry = read(broker,
 297                                                       LogicalDatastoreType.OPERATIONAL, id);
 298         return vpnInterfaceOpDataEntry;
 299     }
 300
 301     static VpnInstanceNames getVpnInterfaceVpnInstanceNames(String vpnName, AssociatedSubnetType subnetType) {
 302         return new VpnInstanceNamesBuilder().setVpnName(vpnName).setAssociatedSubnetType(subnetType).build();
 303     }
 304
 305     static InstanceIdentifier<Prefixes> getPrefixToInterfaceIdentifier(long vpnId, String ipPrefix) {
 306         return InstanceIdentifier.builder(PrefixToInterface.class)
 307             .child(VpnIds.class, new VpnIdsKey(vpnId)).child(Prefixes.class,
 308                 new PrefixesKey(ipPrefix)).build();
 309     }
 310
 311     public static InstanceIdentifier<VpnIds> getPrefixToInterfaceIdentifier(long vpnId) {
 312         return InstanceIdentifier.builder(PrefixToInterface.class)
 313             .child(VpnIds.class, new VpnIdsKey(vpnId)).build();
 314     }
 315
 316     static VpnIds getPrefixToInterface(long vpnId) {
 317         return new VpnIdsBuilder().setKey(new VpnIdsKey(vpnId)).setVpnId(vpnId).build();
 318     }
 319
 320     static Prefixes getPrefixToInterface(BigInteger dpId, String vpnInterfaceName, String ipPrefix, Uuid subnetId,
 321             Prefixes.PrefixCue prefixCue) {
 322         return new PrefixesBuilder().setDpnId(dpId).setVpnInterfaceName(
 323             vpnInterfaceName).setIpAddress(ipPrefix).setSubnetId(subnetId).setPrefixCue(prefixCue).build();
 324     }
 325
 326     static Optional<Prefixes> getPrefixToInterface(DataBroker broker, long vpnId, String ipPrefix) {
 327         return read(broker, LogicalDatastoreType.OPERATIONAL,
 328                 getPrefixToInterfaceIdentifier(vpnId, getIpPrefix(ipPrefix)));
 329     }
 330
 331     /**
 332      * Get VRF table given a Route Distinguisher.
 333      *
 334      * @param broker dataBroker service reference
 335      * @param rd Route-Distinguisher
 336      * @return VrfTables that holds the list of VrfEntries of the specified rd
 337      */
 338     public static VrfTables getVrfTable(DataBroker broker, String rd) {
 339         InstanceIdentifier<VrfTables> id =
 340             InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class, new VrfTablesKey(rd)).build();
 341         Optional<VrfTables> vrfTable = read(broker, LogicalDatastoreType.CONFIGURATION, id);
 342         return vrfTable.isPresent() ? vrfTable.get() : null;
 343     }
 344
 345     /**
 346      * Retrieves the VrfEntries that belong to a given VPN filtered out by
 347      * Origin, searching by its Route-Distinguisher.
 348      *
 349      * @param broker dataBroker service reference
 350      * @param rd Route-distinguisher of the VPN
 351      * @param originsToConsider Only entries whose origin is included in this list will be considered
 352      * @return the list of VrfEntries
 353      */
 354     public static List<VrfEntry> getVrfEntriesByOrigin(DataBroker broker, String rd,
 355         List<RouteOrigin> originsToConsider) {
 356         List<VrfEntry> result = new ArrayList<>();
 357         List<VrfEntry> allVpnVrfEntries = getAllVrfEntries(broker, rd);
 358         for (VrfEntry vrfEntry : allVpnVrfEntries) {
 359             if (originsToConsider.contains(RouteOrigin.value(vrfEntry.getOrigin()))) {
 360                 result.add(vrfEntry);
 361             }
 362         }
 363         return result;
 364     }
 365
 366     static List<Prefixes> getAllPrefixesToInterface(DataBroker broker, long vpnId) {
 367         Optional<VpnIds> vpnIds = read(broker, LogicalDatastoreType.OPERATIONAL, getPrefixToInterfaceIdentifier(vpnId));
 368         if (vpnIds.isPresent()) {
 369             return vpnIds.get().getPrefixes();
 370         }
 371         return new ArrayList<>();
 372     }
 373
 374     /**
 375      * Retrieves all the VrfEntries that belong to a given VPN searching by its
 376      * Route-Distinguisher.
 377      *
 378      * @param broker dataBroker service reference
 379      * @param rd Route-distinguisher of the VPN
 380      * @return the list of VrfEntries
 381      */
 382     public static List<VrfEntry> getAllVrfEntries(DataBroker broker, String rd) {
 383         VrfTables vrfTables = VpnUtil.getVrfTable(broker, rd);
 384         return vrfTables != null ? vrfTables.getVrfEntry() : new ArrayList<>();
 385     }
 386
 387     //FIXME: Implement caches for DS reads
 388     public static VpnInstance getVpnInstance(DataBroker broker, String vpnInstanceName) {
 389         InstanceIdentifier<VpnInstance> id = InstanceIdentifier.builder(VpnInstances.class).child(VpnInstance.class,
 390             new VpnInstanceKey(vpnInstanceName)).build();
 391         Optional<VpnInstance> vpnInstance = read(broker, LogicalDatastoreType.CONFIGURATION, id);
 392         return vpnInstance.isPresent() ? vpnInstance.get() : null;
 393     }
 394
 395     public static List<VpnInstanceOpDataEntry> getAllVpnInstanceOpData(DataBroker broker) {
 396         InstanceIdentifier<VpnInstanceOpData> id = InstanceIdentifier.builder(VpnInstanceOpData.class).build();
 397         Optional<VpnInstanceOpData> vpnInstanceOpDataOptional =
 398             VpnUtil.read(broker, LogicalDatastoreType.OPERATIONAL, id);
 399         if (vpnInstanceOpDataOptional.isPresent()) {
 400             return vpnInstanceOpDataOptional.get().getVpnInstanceOpDataEntry();
 401         } else {
 402             return new ArrayList<>();
 403         }
 404     }
 405
 406     public static List<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn
 407         .instance.op.data.entry.vpn.to.dpn.list.VpnInterfaces> getDpnVpnInterfaces(DataBroker broker,
 408         VpnInstance vpnInstance, BigInteger dpnId) {
 409         String primaryRd = getPrimaryRd(vpnInstance);
 410         InstanceIdentifier<VpnToDpnList> dpnToVpnId = VpnHelper.getVpnToDpnListIdentifier(primaryRd, dpnId);
 411         Optional<VpnToDpnList> dpnInVpn = VpnUtil.read(broker, LogicalDatastoreType.OPERATIONAL, dpnToVpnId);
 412         return dpnInVpn.isPresent() ? dpnInVpn.get().getVpnInterfaces() : Collections.emptyList();
 413     }
 414
 415     public static List<String> getListOfRdsFromVpnInstance(VpnInstance vpnInstance) {
 416         VpnAfConfig vpnConfig = vpnInstance.getIpv4Family();
 417         LOG.trace("vpnConfig {}", vpnConfig);
 418         return vpnConfig.getRouteDistinguisher() != null ? new ArrayList<>(
 419                 vpnConfig.getRouteDistinguisher()) : new ArrayList<>();
 420     }
 421
 422     static VrfEntry getVrfEntry(DataBroker broker, String rd, String ipPrefix) {
 423
 424         VrfTables vrfTable = getVrfTable(broker, rd);
 425         // TODO: why check VrfTables if we later go for the specific VrfEntry?
 426         if (vrfTable != null) {
 427             InstanceIdentifier<VrfEntry> vrfEntryId =
 428                 InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class, new VrfTablesKey(rd)).child(
 429                     VrfEntry.class, new VrfEntryKey(ipPrefix)).build();
 430             Optional<VrfEntry> vrfEntry = read(broker, LogicalDatastoreType.CONFIGURATION, vrfEntryId);
 431             if (vrfEntry.isPresent()) {
 432                 return vrfEntry.get();
 433             }
 434         }
 435         return null;
 436     }
 437
 438     static List<Adjacency> getAdjacenciesForVpnInterfaceFromConfig(DataBroker broker, String intfName) {
 439         final InstanceIdentifier<VpnInterface> identifier = getVpnInterfaceIdentifier(intfName);
 440         InstanceIdentifier<Adjacencies> path = identifier.augmentation(Adjacencies.class);
 441         Optional<Adjacencies> adjacencies = VpnUtil.read(broker, LogicalDatastoreType.CONFIGURATION, path);
 442
 443         if (adjacencies.isPresent()) {
 444             List<Adjacency> nextHops = adjacencies.get().getAdjacency();
 445             return nextHops;
 446         }
 447         return null;
 448     }
 449
 450     static  Routes getVpnToExtraroute(String ipPrefix, List<String> nextHopList) {
 451         return new RoutesBuilder().setPrefix(ipPrefix).setNexthopIpList(nextHopList).build();
 452     }
 453
 454     static String getVpnInterfaceName(OdlInterfaceRpcService odlInterfaceRpcService, BigInteger metadata)
 455             throws InterruptedException, ExecutionException {
 456         GetInterfaceFromIfIndexInputBuilder ifIndexInputBuilder = new GetInterfaceFromIfIndexInputBuilder();
 457         BigInteger lportTag = MetaDataUtil.getLportFromMetadata(metadata);
 458         ifIndexInputBuilder.setIfIndex(lportTag.intValue());
 459         GetInterfaceFromIfIndexInput input = ifIndexInputBuilder.build();
 460         Future<RpcResult<GetInterfaceFromIfIndexOutput>> interfaceFromIfIndex =
 461                 odlInterfaceRpcService.getInterfaceFromIfIndex(input);
 462         GetInterfaceFromIfIndexOutput interfaceFromIfIndexOutput;
 463         RpcResult<GetInterfaceFromIfIndexOutput> rpcResult = interfaceFromIfIndex.get();
 464         if (rpcResult == null) {
 465             return null;
 466         }
 467         interfaceFromIfIndexOutput = rpcResult.getResult();
 468         return interfaceFromIfIndexOutput.getInterfaceName();
 469     }
 470
 471     static AllocatedRdsBuilder getRdsBuilder(String nexthop, String rd) {
 472         return new AllocatedRdsBuilder().setKey(new AllocatedRdsKey(nexthop)).setNexthop(nexthop).setRd(rd);
 473     }
 474
 475     static Adjacencies getVpnInterfaceAugmentation(List<Adjacency> nextHopList) {
 476         return new AdjacenciesBuilder().setAdjacency(nextHopList).build();
 477     }
 478
 479     static AdjacenciesOp getVpnInterfaceOpDataEntryAugmentation(List<Adjacency> nextHopList) {
 480         return new AdjacenciesOpBuilder().setAdjacency(nextHopList).build();
 481     }
 482
 483     public static InstanceIdentifier<IdPool> getPoolId(String poolName) {
 484         InstanceIdentifier.InstanceIdentifierBuilder<IdPool> idBuilder =
 485             InstanceIdentifier.builder(IdPools.class).child(IdPool.class, new IdPoolKey(poolName));
 486         return idBuilder.build();
 487     }
 488
 489     static InstanceIdentifier<VpnInterfaces> getVpnInterfacesIdentifier() {
 490         return InstanceIdentifier.builder(VpnInterfaces.class).build();
 491     }
 492
 493     static InstanceIdentifier<Interface> getInterfaceIdentifier(String interfaceName) {
 494         return InstanceIdentifier.builder(Interfaces.class)
 495             .child(Interface.class, new InterfaceKey(interfaceName)).build();
 496     }
 497
 498     public static BigInteger getCookieArpFlow(int interfaceTag) {
 499         return VpnConstants.COOKIE_L3_BASE.add(new BigInteger("0110000", 16)).add(
 500             BigInteger.valueOf(interfaceTag));
 501     }
 502
 503     public static BigInteger getCookieL3(int vpnId) {
 504         return VpnConstants.COOKIE_L3_BASE.add(new BigInteger("0610000", 16)).add(BigInteger.valueOf(vpnId));
 505     }
 506
 507     public static String getFlowRef(BigInteger dpnId, short tableId, int ethType, int lportTag, int arpType) {
 508         return new StringBuffer().append(VpnConstants.FLOWID_PREFIX).append(dpnId).append(NwConstants.FLOWID_SEPARATOR)
 509             .append(tableId).append(NwConstants.FLOWID_SEPARATOR).append(ethType).append(lportTag)
 510             .append(NwConstants.FLOWID_SEPARATOR).append(arpType).toString();
 511     }
 512
 513     public static int getUniqueId(IdManagerService idManager, String poolName, String idKey) {
 514         AllocateIdInput getIdInput = new AllocateIdInputBuilder().setPoolName(poolName).setIdKey(idKey).build();
 515
 516         try {
 517             Future<RpcResult<AllocateIdOutput>> result = idManager.allocateId(getIdInput);
 518             RpcResult<AllocateIdOutput> rpcResult = result.get();
 519             if (rpcResult.isSuccessful()) {
 520                 return rpcResult.getResult().getIdValue().intValue();
 521             } else {
 522                 LOG.error("getUniqueId: RPC Call to Get Unique Id from pool {} with key {} returned with Errors {}",
 523                         poolName, idKey, rpcResult.getErrors());
 524             }
 525         } catch (InterruptedException | ExecutionException e) {
 526             LOG.error("getUniqueId: Exception when getting Unique Id from pool {} for key {}", poolName, idKey, e);
 527         }
 528         return 0;
 529     }
 530
 531     public static void releaseId(IdManagerService idManager, String poolName, String idKey) {
 532         ReleaseIdInput idInput = new ReleaseIdInputBuilder().setPoolName(poolName).setIdKey(idKey).build();
 533         try {
 534             Future<RpcResult<Void>> result = idManager.releaseId(idInput);
 535             RpcResult<Void> rpcResult = result.get();
 536             if (!rpcResult.isSuccessful()) {
 537                 LOG.error("releaseId: RPC Call to release Id for key {} from pool {} returned with Errors {}",
 538                         idKey, poolName, rpcResult.getErrors());
 539             }
 540         } catch (InterruptedException | ExecutionException e) {
 541             LOG.error("releaseId: Exception when releasing Id for key {} from pool {}", idKey, poolName, e);
 542         }
 543     }
 544
 545     public static String getNextHopLabelKey(String rd, String prefix) {
 546         return rd + VpnConstants.SEPARATOR + prefix;
 547     }
 548
 549     /**
 550      * Retrieves the VpnInstance name (typically the VPN Uuid) out from the
 551      * route-distinguisher.
 552      *
 553      * @param broker dataBroker service reference
 554      * @param rd Route-Distinguisher
 555      * @return the VpnInstance name
 556      */
 557     public static String getVpnNameFromRd(DataBroker broker, String rd) {
 558         VpnInstanceOpDataEntry vpnInstanceOpData = getVpnInstanceOpData(broker, rd);
 559         return vpnInstanceOpData != null ? vpnInstanceOpData.getVpnInstanceName() : null;
 560     }
 561
 562     /**
 563      * Retrieves the dataplane identifier of a specific VPN, searching by its
 564      * VpnInstance name.
 565      *
 566      * @param broker dataBroker service reference
 567      * @param vpnName Name of the VPN
 568      * @return the dataplane identifier of the VPN, the VrfTag.
 569      */
 570     public static long getVpnId(DataBroker broker, String vpnName) {
 571         if (vpnName == null) {
 572             return VpnConstants.INVALID_ID;
 573         }
 574
 575         return read(broker, LogicalDatastoreType.CONFIGURATION,
 576                 VpnOperDsUtils.getVpnInstanceToVpnIdIdentifier(vpnName)).toJavaUtil().map(
 577                 org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id
 578                         .VpnInstance::getVpnId).orElse(VpnConstants.INVALID_ID);
 579     }
 580
 581     public static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance
 582                         .to.vpn.id.VpnInstance> getVpnInstanceToVpnIdIdentifier(
 583             String vpnName) {
 584         return InstanceIdentifier.builder(VpnInstanceToVpnId.class)
 585                 .child(org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id
 586                           .VpnInstance.class,
 587                         new org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn
 588                                .id.VpnInstanceKey(
 589                                 vpnName))
 590                 .build();
 591     }
 592
 593     /**
 594      * Retrieves the VPN Route Distinguisher searching by its Vpn instance name.
 595      *
 596      * @param broker dataBroker service reference
 597      * @param vpnName Name of the VPN
 598      * @return the route-distinguisher of the VPN
 599      */
 600     public static String getVpnRd(DataBroker broker, String vpnName) {
 601         Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id
 602             .VpnInstance>
 603             vpnInstance
 604             = read(broker, LogicalDatastoreType.CONFIGURATION, VpnOperDsUtils.getVpnInstanceToVpnIdIdentifier(vpnName));
 605
 606         String rd = null;
 607         if (vpnInstance.isPresent()) {
 608             rd = vpnInstance.get().getVrfId();
 609         }
 610         return rd;
 611     }
 612
 613     private static List<String> getVpnRdsFromVpnInstanceConfig(DataBroker broker, String vpnName) {
 614         InstanceIdentifier<VpnInstance> id = InstanceIdentifier.builder(VpnInstances.class)
 615             .child(VpnInstance.class, new VpnInstanceKey(vpnName)).build();
 616         Optional<VpnInstance> vpnInstance = VpnUtil.read(broker, LogicalDatastoreType.CONFIGURATION, id);
 617         return vpnInstance.isPresent() ? getListOfRdsFromVpnInstance(vpnInstance.get()) : new ArrayList<>();
 618     }
 619
 620     /**
 621      * Remove from MDSAL all those VrfEntries in a VPN that have an specific RouteOrigin.
 622      *
 623      * @param broker dataBroker service reference
 624      * @param rd Route Distinguisher
 625      * @param origin Origin of the Routes to be removed (see {@link RouteOrigin})
 626      */
 627     public static void removeVrfEntriesByOrigin(DataBroker broker, String rd, RouteOrigin origin) {
 628         InstanceIdentifier<VrfTables> vpnVrfTableIid =
 629             InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class, new VrfTablesKey(rd)).build();
 630         Optional<VrfTables> vrfTablesOpc = read(broker, LogicalDatastoreType.CONFIGURATION, vpnVrfTableIid);
 631         if (vrfTablesOpc.isPresent()) {
 632             VrfTables vrfTables = vrfTablesOpc.get();
 633             WriteTransaction tx = broker.newWriteOnlyTransaction();
 634             for (VrfEntry vrfEntry : vrfTables.getVrfEntry()) {
 635                 if (origin == RouteOrigin.value(vrfEntry.getOrigin())) {
 636                     tx.delete(LogicalDatastoreType.CONFIGURATION,
 637                             vpnVrfTableIid.child(VrfEntry.class, vrfEntry.getKey()));
 638                 }
 639             }
 640             tx.submit();
 641         }
 642     }
 643
 644     public static List<VrfEntry> findVrfEntriesByNexthop(DataBroker broker, String rd, String nexthop) {
 645         InstanceIdentifier<VrfTables> vpnVrfTableIid =
 646             InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class, new VrfTablesKey(rd)).build();
 647         Optional<VrfTables> vrfTablesOpc = read(broker, LogicalDatastoreType.CONFIGURATION, vpnVrfTableIid);
 648         List<VrfEntry> matches = new ArrayList<>();
 649
 650         if (vrfTablesOpc.isPresent()) {
 651             VrfTables vrfTables = vrfTablesOpc.get();
 652             for (VrfEntry vrfEntry : vrfTables.getVrfEntry()) {
 653                 vrfEntry.getRoutePaths().stream()
 654                         .filter(routePath -> routePath.getNexthopAddress() != null
 655                                 && routePath.getNexthopAddress().equals(nexthop))
 656                         .findFirst().ifPresent(routePath -> matches.add(vrfEntry));
 657             }
 658         }
 659         return matches;
 660     }
 661
 662     public static void removeVrfEntries(DataBroker broker, String rd, List<VrfEntry> vrfEntries) {
 663         InstanceIdentifier<VrfTables> vpnVrfTableIid =
 664             InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class, new VrfTablesKey(rd)).build();
 665         WriteTransaction tx = broker.newWriteOnlyTransaction();
 666         for (VrfEntry vrfEntry : vrfEntries) {
 667             tx.delete(LogicalDatastoreType.CONFIGURATION, vpnVrfTableIid.child(VrfEntry.class, vrfEntry.getKey()));
 668         }
 669         tx.submit();
 670     }
 671
 672     // TODO Clean up the exception handling
 673     @SuppressWarnings("checkstyle:IllegalCatch")
 674     public static void withdrawRoutes(IBgpManager bgpManager, String rd, List<VrfEntry> vrfEntries) {
 675         vrfEntries.forEach(vrfEntry -> {
 676             try {
 677                 bgpManager.withdrawPrefix(rd, vrfEntry.getDestPrefix());
 678             } catch (Exception e) {
 679                 LOG.error("withdrawRoutes: Could not withdraw route to {} with route-paths {} in VpnRd {}",
 680                           vrfEntry.getDestPrefix(), vrfEntry.getRoutePaths(), rd);
 681             }
 682         });
 683     }
 684
 685     static org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstance
 686         getVpnInstanceToVpnId(String vpnName, long vpnId, String rd) {
 687         return new VpnInstanceBuilder().setVpnId(vpnId).setVpnInstanceName(vpnName).setVrfId(rd).build();
 688
 689     }
 690
 691     static RouterInterface getConfiguredRouterInterface(DataBroker broker, String interfaceName) {
 692         Optional<RouterInterface> optRouterInterface =
 693             read(broker, LogicalDatastoreType.CONFIGURATION, VpnUtil.getRouterInterfaceId(interfaceName));
 694         if (optRouterInterface.isPresent()) {
 695             return optRouterInterface.get();
 696         }
 697         return null;
 698     }
 699
 700     static org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance.VpnIds
 701         getVpnIdToVpnInstance(long vpnId, String vpnName, String rd, boolean isExternalVpn) {
 702         return new org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance
 703             .VpnIdsBuilder()
 704             .setVpnId(vpnId).setVpnInstanceName(vpnName).setVrfId(rd).setExternalVpn(isExternalVpn).build();
 705
 706     }
 707
 708     public static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to
 709         .vpn.instance.VpnIds>
 710         getVpnIdToVpnInstanceIdentifier(long vpnId) {
 711         return InstanceIdentifier.builder(VpnIdToVpnInstance.class)
 712             .child(
 713                 org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance.VpnIds
 714                     .class,
 715                 new org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance
 716                     .VpnIdsKey(vpnId)).build();
 717     }
 718
 719     /**
 720      * Retrieves the Vpn Name searching by its VPN Tag.
 721      *
 722      * @param broker dataBroker service reference
 723      * @param vpnId Dataplane identifier of the VPN
 724      * @return the Vpn instance name
 725      */
 726     public static String getVpnName(DataBroker broker, long vpnId) {
 727
 728         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn
 729             .instance.VpnIds>
 730             id
 731             = getVpnIdToVpnInstanceIdentifier(vpnId);
 732         Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance.VpnIds>
 733             vpnInstance
 734             = read(broker, LogicalDatastoreType.CONFIGURATION, id);
 735
 736         String vpnName = null;
 737         if (vpnInstance.isPresent()) {
 738             vpnName = vpnInstance.get().getVpnInstanceName();
 739         }
 740         return vpnName;
 741     }
 742
 743     public static InstanceIdentifier<VpnInstanceOpDataEntry> getVpnInstanceOpDataIdentifier(String rd) {
 744         return InstanceIdentifier.builder(VpnInstanceOpData.class)
 745             .child(VpnInstanceOpDataEntry.class, new VpnInstanceOpDataEntryKey(rd)).build();
 746     }
 747
 748     static InstanceIdentifier<RouterInterface> getRouterInterfaceId(String interfaceName) {
 749         return InstanceIdentifier.builder(RouterInterfaces.class)
 750             .child(RouterInterface.class, new RouterInterfaceKey(interfaceName)).build();
 751     }
 752
 753     static RouterInterface getRouterInterface(String interfaceName, String routerName) {
 754         return new RouterInterfaceBuilder().setKey(new RouterInterfaceKey(interfaceName))
 755             .setInterfaceName(interfaceName).setRouterName(routerName).build();
 756     }
 757
 758     public static VpnInstanceOpDataEntry getVpnInstanceOpData(DataBroker broker, String rd) {
 759         InstanceIdentifier<VpnInstanceOpDataEntry> id = VpnUtil.getVpnInstanceOpDataIdentifier(rd);
 760         return read(broker, LogicalDatastoreType.OPERATIONAL, id).orNull();
 761     }
 762
 763     static VpnInterface getConfiguredVpnInterface(DataBroker broker, String interfaceName) {
 764         InstanceIdentifier<VpnInterface> interfaceId = getVpnInterfaceIdentifier(interfaceName);
 765         Optional<VpnInterface> configuredVpnInterface = read(broker, LogicalDatastoreType.CONFIGURATION, interfaceId);
 766
 767         if (configuredVpnInterface.isPresent()) {
 768             return configuredVpnInterface.get();
 769         }
 770         return null;
 771     }
 772
 773     static String getNeutronRouterFromInterface(DataBroker broker, String interfaceName) {
 774         InstanceIdentifier.InstanceIdentifierBuilder<RouterInterfacesMap> idBuilder =
 775             InstanceIdentifier.builder(RouterInterfacesMap.class);
 776         InstanceIdentifier<RouterInterfacesMap> id = idBuilder.build();
 777         Optional<RouterInterfacesMap> routerInterfacesMap =
 778             MDSALUtil.read(broker, LogicalDatastoreType.CONFIGURATION, id);
 779         if (routerInterfacesMap.isPresent()) {
 780             List<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.router.interfaces.map
 781                 .RouterInterfaces>
 782                 rtrInterfaces = routerInterfacesMap.get().getRouterInterfaces();
 783             for (org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.router.interfaces.map
 784                      .RouterInterfaces rtrInterface : rtrInterfaces) {
 785                 List<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.router.interfaces.map
 786                     .router.interfaces.Interfaces>
 787                     rtrIfc = rtrInterface.getInterfaces();
 788                 for (org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.router.interfaces.map
 789                          .router.interfaces.Interfaces ifc : rtrIfc) {
 790                     if (ifc.getInterfaceId().equals(interfaceName)) {
 791                         return rtrInterface.getRouterId().getValue();
 792                     }
 793                 }
 794             }
 795         }
 796         return null;
 797     }
 798
 799     static boolean isVpnInterfaceConfigured(DataBroker broker, String interfaceName) {
 800         InstanceIdentifier<VpnInterface> interfaceId = getVpnInterfaceIdentifier(interfaceName);
 801         return read(broker, LogicalDatastoreType.CONFIGURATION, interfaceId).isPresent();
 802     }
 803
 804     static Optional<List<String>> getVpnHandlingIpv4AssociatedWithInterface(DataBroker broker, String interfaceName) {
 805         InstanceIdentifier<VpnInterface> interfaceId = getVpnInterfaceIdentifier(interfaceName);
 806         Optional<List<String>> vpnOptional = Optional.absent();
 807         Optional<VpnInterface> optConfiguredVpnInterface = read(broker, LogicalDatastoreType.CONFIGURATION,
 808                 interfaceId);
 809         if (optConfiguredVpnInterface.isPresent()) {
 810             VpnInterface cfgVpnInterface = optConfiguredVpnInterface.get();
 811             java.util.Optional<List<VpnInstanceNames>> optVpnInstanceList =
 812                  java.util.Optional.ofNullable(cfgVpnInterface.getVpnInstanceNames());
 813             if (optVpnInstanceList.isPresent()) {
 814                 List<String> vpnList = new ArrayList<>();
 815                 for (VpnInstanceNames vpnInstance : optVpnInstanceList.get()) {
 816                     if (vpnInstance.getAssociatedSubnetType().equals(AssociatedSubnetType.V6Subnet)) {
 817                         continue;
 818                     }
 819                     vpnList.add(vpnInstance.getVpnName());
 820                 }
 821                 vpnOptional = Optional.of(vpnList);
 822             }
 823         }
 824         return vpnOptional;
 825     }
 826
 827     public static String getIpPrefix(String prefix) {
 828         String[] prefixValues = prefix.split("/");
 829         if (prefixValues.length == 1) {
 830             prefix = prefix + PREFIX_SEPARATOR + DEFAULT_PREFIX_LENGTH;
 831         }
 832         return prefix;
 833     }
 834
 835     static final FutureCallback<Void> DEFAULT_CALLBACK =
 836         new FutureCallback<Void>() {
 837             @Override
 838             public void onSuccess(Void result) {
 839                 LOG.debug("Success in Datastore operation");
 840             }
 841
 842             @Override
 843             public void onFailure(Throwable error) {
 844                 LOG.error("Error in Datastore operation", error);
 845             }
 846
 847         };
 848
 849     public static <T extends DataObject> Optional<T> read(DataBroker broker, LogicalDatastoreType datastoreType,
 850                                                           InstanceIdentifier<T> path) {
 851         try (ReadOnlyTransaction tx = broker.newReadOnlyTransaction()) {
 852             return tx.read(datastoreType, path).get();
 853         } catch (InterruptedException | ExecutionException e) {
 854             throw new RuntimeException(e);
 855         }
 856     }
 857
 858     public static <T extends DataObject> void asyncUpdate(DataBroker broker, LogicalDatastoreType datastoreType,
 859         InstanceIdentifier<T> path, T data) {
 860         asyncUpdate(broker, datastoreType, path, data, DEFAULT_CALLBACK);
 861     }
 862
 863     public static <T extends DataObject> void asyncUpdate(DataBroker broker, LogicalDatastoreType datastoreType,
 864         InstanceIdentifier<T> path, T data, FutureCallback<Void> callback) {
 865         WriteTransaction tx = broker.newWriteOnlyTransaction();
 866         tx.merge(datastoreType, path, data, true);
 867         Futures.addCallback(tx.submit(), callback, MoreExecutors.directExecutor());
 868     }
 869
 870     public static <T extends DataObject> void asyncWrite(DataBroker broker, LogicalDatastoreType datastoreType,
 871         InstanceIdentifier<T> path, T data) {
 872         asyncWrite(broker, datastoreType, path, data, DEFAULT_CALLBACK);
 873     }
 874
 875     public static <T extends DataObject> void asyncWrite(DataBroker broker, LogicalDatastoreType datastoreType,
 876         InstanceIdentifier<T> path, T data, FutureCallback<Void> callback) {
 877         WriteTransaction tx = broker.newWriteOnlyTransaction();
 878         tx.put(datastoreType, path, data, WriteTransaction.CREATE_MISSING_PARENTS);
 879         Futures.addCallback(tx.submit(), callback, MoreExecutors.directExecutor());
 880     }
 881
 882     // TODO Clean up the exception handling
 883     @SuppressWarnings("checkstyle:IllegalCatch")
 884     public static <T extends DataObject> void tryDelete(DataBroker broker, LogicalDatastoreType datastoreType,
 885         InstanceIdentifier<T> path) {
 886         try {
 887             delete(broker, datastoreType, path, DEFAULT_CALLBACK);
 888         } catch (SchemaValidationFailedException sve) {
 889             LOG.info("tryDelete: Could not delete {}. SchemaValidationFailedException: {}", path, sve.getMessage());
 890         } catch (Exception e) {
 891             LOG.info("tryDelete: Could not delete {}. Unhandled error: {}", path, e.getMessage());
 892         }
 893     }
 894
 895     public static <T extends DataObject> void delete(DataBroker broker, LogicalDatastoreType datastoreType,
 896         InstanceIdentifier<T> path) {
 897         delete(broker, datastoreType, path, DEFAULT_CALLBACK);
 898     }
 899
 900
 901     public static <T extends DataObject> void delete(DataBroker broker, LogicalDatastoreType datastoreType,
 902         InstanceIdentifier<T> path, FutureCallback<Void> callback) {
 903         WriteTransaction tx = broker.newWriteOnlyTransaction();
 904         tx.delete(datastoreType, path);
 905         Futures.addCallback(tx.submit(), callback, MoreExecutors.directExecutor());
 906     }
 907
 908     public static <T extends DataObject> void syncWrite(DataBroker broker, LogicalDatastoreType datastoreType,
 909         InstanceIdentifier<T> path, T data) {
 910         WriteTransaction tx = broker.newWriteOnlyTransaction();
 911         tx.put(datastoreType, path, data, WriteTransaction.CREATE_MISSING_PARENTS);
 912
 913         try {
 914             tx.submit().get();
 915         } catch (InterruptedException | ExecutionException e) {
 916             LOG.error("syncWrite: Error writing to datastore (path, data) : ({}, {})", path, data);
 917             throw new RuntimeException(e.getMessage(), e);
 918         }
 919     }
 920
 921     public static <T extends DataObject> void syncUpdate(DataBroker broker, LogicalDatastoreType datastoreType,
 922         InstanceIdentifier<T> path, T data) {
 923         WriteTransaction tx = broker.newWriteOnlyTransaction();
 924         tx.merge(datastoreType, path, data, true);
 925
 926         try {
 927             tx.submit().get();
 928         } catch (InterruptedException | ExecutionException e) {
 929             LOG.error("syncUpdate: Error writing to datastore (path, data) : ({}, {})", path, data);
 930             throw new RuntimeException(e.getMessage(), e);
 931         }
 932     }
 933
 934     public static long getRemoteBCGroup(long elanTag) {
 935         return VpnConstants.ELAN_GID_MIN + elanTag % VpnConstants.ELAN_GID_MIN * 2;
 936     }
 937
 938     // interface-index-tag operational container
 939     public static IfIndexInterface getInterfaceInfoByInterfaceTag(DataBroker broker, long interfaceTag) {
 940         InstanceIdentifier<IfIndexInterface> interfaceId = getInterfaceInfoEntriesOperationalDataPath(interfaceTag);
 941         Optional<IfIndexInterface> existingInterfaceInfo =
 942             VpnUtil.read(broker, LogicalDatastoreType.OPERATIONAL, interfaceId);
 943         if (existingInterfaceInfo.isPresent()) {
 944             return existingInterfaceInfo.get();
 945         }
 946         return null;
 947     }
 948
 949     private static InstanceIdentifier<IfIndexInterface> getInterfaceInfoEntriesOperationalDataPath(long interfaceTag) {
 950         return InstanceIdentifier.builder(IfIndexesInterfaceMap.class).child(IfIndexInterface.class,
 951             new IfIndexInterfaceKey((int) interfaceTag)).build();
 952     }
 953
 954     public static ElanTagName getElanInfoByElanTag(DataBroker broker, long elanTag) {
 955         InstanceIdentifier<ElanTagName> elanId = getElanInfoEntriesOperationalDataPath(elanTag);
 956         Optional<ElanTagName> existingElanInfo = VpnUtil.read(broker, LogicalDatastoreType.OPERATIONAL, elanId);
 957         if (existingElanInfo.isPresent()) {
 958             return existingElanInfo.get();
 959         }
 960         return null;
 961     }
 962
 963     private static InstanceIdentifier<ElanTagName> getElanInfoEntriesOperationalDataPath(long elanTag) {
 964         return InstanceIdentifier.builder(ElanTagNameMap.class).child(ElanTagName.class,
 965             new ElanTagNameKey(elanTag)).build();
 966     }
 967
 968     /**
 969      * Returns the Path identifier to reach a specific interface in a specific DPN in a given VpnInstance.
 970      *
 971      * @param vpnRd Route-Distinguisher of the VpnInstance
 972      * @param dpnId Id of the DPN where the interface is
 973      * @param ifaceName Interface name
 974      * @return the Instance Identifier
 975      */
 976     public static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
 977         .instance.op.data.vpn.instance.op.data.entry.vpn.to.dpn.list.VpnInterfaces>
 978         getVpnToDpnInterfacePath(String vpnRd, BigInteger dpnId, String ifaceName) {
 979
 980         return
 981             InstanceIdentifier.builder(VpnInstanceOpData.class)
 982                 .child(VpnInstanceOpDataEntry.class, new VpnInstanceOpDataEntryKey(vpnRd))
 983                 .child(VpnToDpnList.class, new VpnToDpnListKey(dpnId))
 984                 .child(org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
 985                         .instance.op.data.vpn.instance.op.data.entry.vpn.to.dpn.list.VpnInterfaces.class,
 986                     new org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
 987                         .instance.op.data.vpn.instance.op.data.entry.vpn.to.dpn.list.VpnInterfacesKey(ifaceName))
 988                 .build();
 989     }
 990
 991     // TODO Clean up the exception handling
 992     @SuppressWarnings("checkstyle:IllegalCatch")
 993     public static void removePrefixToInterfaceForVpnId(DataBroker broker, long vpnId, WriteTransaction writeTxn) {
 994         try {
 995             // Clean up PrefixToInterface Operational DS
 996             if (writeTxn != null) {
 997                 writeTxn.delete(LogicalDatastoreType.OPERATIONAL,
 998                     InstanceIdentifier.builder(PrefixToInterface.class).child(
 999                         VpnIds.class, new VpnIdsKey(vpnId)).build());
1000             } else {
1001                 delete(broker, LogicalDatastoreType.OPERATIONAL,
1002                     InstanceIdentifier.builder(PrefixToInterface.class).child(VpnIds.class,
1003                         new VpnIdsKey(vpnId)).build(),
1004                     DEFAULT_CALLBACK);
1005             }
1006         } catch (Exception e) {
1007             LOG.error("removePrefixToInterfaceForVpnId: Exception during cleanup of PrefixToInterface for VPN ID {}",
1008                     vpnId, e);
1009         }
1010     }
1011
1012     // TODO Clean up the exception handling
1013     @SuppressWarnings("checkstyle:IllegalCatch")
1014     public static void removeVpnExtraRouteForVpn(DataBroker broker, String vpnName, WriteTransaction writeTxn) {
1015         try {
1016             // Clean up VPNExtraRoutes Operational DS
1017             if (writeTxn != null) {
1018                 writeTxn.delete(LogicalDatastoreType.OPERATIONAL,
1019                         InstanceIdentifier.builder(VpnToExtraroutes.class)
1020                                 .child(Vpn.class, new VpnKey(vpnName)).build());
1021             } else {
1022                 delete(broker, LogicalDatastoreType.OPERATIONAL,
1023                         InstanceIdentifier.builder(VpnToExtraroutes.class)
1024                                 .child(Vpn.class, new VpnKey(vpnName)).build(),
1025                         DEFAULT_CALLBACK);
1026             }
1027         } catch (Exception e) {
1028             LOG.error("removeVpnExtraRouteForVpna: Exception during cleanup of VPNToExtraRoute for VPN {}",
1029                     vpnName, e);
1030         }
1031     }
1032
1033     // TODO Clean up the exception handling
1034     @SuppressWarnings("checkstyle:IllegalCatch")
1035     public static void removeVpnOpInstance(DataBroker broker, String vpnName, WriteTransaction writeTxn) {
1036         try {
1037             // Clean up VPNInstanceOpDataEntry
1038             if (writeTxn != null) {
1039                 writeTxn.delete(LogicalDatastoreType.OPERATIONAL, getVpnInstanceOpDataIdentifier(vpnName));
1040             } else {
1041                 delete(broker, LogicalDatastoreType.OPERATIONAL, getVpnInstanceOpDataIdentifier(vpnName),
1042                     DEFAULT_CALLBACK);
1043             }
1044         } catch (Exception e) {
1045             LOG.error("removeVpnOpInstance: Exception during cleanup of VPNInstanceOpDataEntry for VPN {}",
1046                     vpnName, e);
1047         }
1048     }
1049
1050     // TODO Clean up the exception handling
1051     @SuppressWarnings("checkstyle:IllegalCatch")
1052     public static void removeVpnInstanceToVpnId(DataBroker broker, String vpnName, WriteTransaction writeTxn) {
1053         try {
1054             if (writeTxn != null) {
1055                 writeTxn.delete(LogicalDatastoreType.CONFIGURATION,
1056                                 VpnOperDsUtils.getVpnInstanceToVpnIdIdentifier(vpnName));
1057             } else {
1058                 delete(broker, LogicalDatastoreType.CONFIGURATION,
1059                        VpnOperDsUtils.getVpnInstanceToVpnIdIdentifier(vpnName),
1060                     DEFAULT_CALLBACK);
1061             }
1062         } catch (Exception e) {
1063             LOG.error("removeVpnInstanceToVpnId: Exception during clean up of VpnInstanceToVpnId for VPN {}",
1064                     vpnName, e);
1065         }
1066     }
1067
1068     // TODO Clean up the exception handling
1069     @SuppressWarnings("checkstyle:IllegalCatch")
1070     public static void removeVpnIdToVpnInstance(DataBroker broker, long vpnId, WriteTransaction writeTxn) {
1071         try {
1072             if (writeTxn != null) {
1073                 writeTxn.delete(LogicalDatastoreType.CONFIGURATION, getVpnIdToVpnInstanceIdentifier(vpnId));
1074             } else {
1075                 delete(broker, LogicalDatastoreType.CONFIGURATION, getVpnIdToVpnInstanceIdentifier(vpnId),
1076                     DEFAULT_CALLBACK);
1077             }
1078         } catch (Exception e) {
1079             LOG.error("removeVpnIdToVpnInstance: Exception during clean up of VpnIdToVpnInstance for VPNID {}",
1080                     vpnId, e);
1081         }
1082     }
1083
1084     // TODO Clean up the exception handling
1085     @SuppressWarnings("checkstyle:IllegalCatch")
1086     public static void removeVrfTableForVpn(DataBroker broker, String vpnName, WriteTransaction writeTxn) {
1087         // Clean up FIB Entries Config DS
1088         try {
1089             if (writeTxn != null) {
1090                 writeTxn.delete(LogicalDatastoreType.CONFIGURATION,
1091                     InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class,
1092                         new VrfTablesKey(vpnName)).build());
1093             } else {
1094                 delete(broker, LogicalDatastoreType.CONFIGURATION,
1095                     InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class,
1096                         new VrfTablesKey(vpnName)).build(),
1097                     DEFAULT_CALLBACK);
1098             }
1099         } catch (Exception e) {
1100             LOG.error("removeVrfTableForVpn: Exception during clean up of VrfTable from FIB for VPN {}",
1101                     vpnName, e);
1102         }
1103     }
1104
1105     // TODO Clean up the exception handling
1106     @SuppressWarnings("checkstyle:IllegalCatch")
1107     public static void removeL3nexthopForVpnId(DataBroker broker, long vpnId, WriteTransaction writeTxn) {
1108         try {
1109             // Clean up L3NextHop Operational DS
1110             if (writeTxn != null) {
1111                 writeTxn.delete(LogicalDatastoreType.OPERATIONAL,
1112                     InstanceIdentifier.builder(L3nexthop.class).child(VpnNexthops.class,
1113                         new VpnNexthopsKey(vpnId)).build());
1114             } else {
1115                 delete(broker, LogicalDatastoreType.OPERATIONAL,
1116                     InstanceIdentifier.builder(L3nexthop.class).child(VpnNexthops.class,
1117                         new VpnNexthopsKey(vpnId)).build(),
1118                     DEFAULT_CALLBACK);
1119             }
1120         } catch (Exception e) {
1121             LOG.error("removeL3nexthopForVpnId: Exception during cleanup of L3NextHop for VPN ID {}", vpnId, e);
1122         }
1123     }
1124
1125     public static void scheduleVpnInterfaceForRemoval(DataBroker broker,String interfaceName, BigInteger dpnId,
1126                                                       String vpnInstanceName, Boolean isScheduledToRemove,
1127                                                       WriteTransaction writeOperTxn) {
1128         InstanceIdentifier<VpnInterfaceOpDataEntry> interfaceId =
1129             VpnUtil.getVpnInterfaceOpDataEntryIdentifier(interfaceName, vpnInstanceName);
1130         VpnInterfaceOpDataEntry interfaceToUpdate =
1131             new VpnInterfaceOpDataEntryBuilder().setKey(new VpnInterfaceOpDataEntryKey(interfaceName,
1132             vpnInstanceName)).setName(interfaceName).setDpnId(dpnId).setVpnInstanceName(vpnInstanceName)
1133             .setScheduledForRemove(isScheduledToRemove).build();
1134         if (writeOperTxn != null) {
1135             writeOperTxn.merge(LogicalDatastoreType.OPERATIONAL, interfaceId, interfaceToUpdate, true);
1136         } else {
1137             VpnUtil.syncUpdate(broker, LogicalDatastoreType.OPERATIONAL, interfaceId, interfaceToUpdate);
1138         }
1139     }
1140
1141     protected static void createLearntVpnVipToPort(DataBroker broker, String vpnName, String fixedIp, String
1142             portName, String macAddress, WriteTransaction writeOperTxn) {
1143         synchronized ((vpnName + fixedIp).intern()) {
1144             InstanceIdentifier<LearntVpnVipToPort> id = buildLearntVpnVipToPortIdentifier(vpnName, fixedIp);
1145             LearntVpnVipToPortBuilder builder =
1146                     new LearntVpnVipToPortBuilder().setKey(new LearntVpnVipToPortKey(fixedIp, vpnName)).setVpnName(
1147                             vpnName).setPortFixedip(fixedIp).setPortName(portName)
1148                             .setMacAddress(macAddress.toLowerCase(Locale.getDefault()))
1149                             .setCreationTime(new SimpleDateFormat("MM/dd/yyyy h:mm:ss a").format(new Date()));
1150             if (writeOperTxn != null) {
1151                 writeOperTxn.put(LogicalDatastoreType.OPERATIONAL, id, builder.build(), true);
1152             } else {
1153                 MDSALUtil.syncWrite(broker, LogicalDatastoreType.OPERATIONAL, id, builder.build());
1154             }
1155             LOG.debug("createLearntVpnVipToPort: ARP learned for fixedIp: {}, vpn {}, interface {}, mac {},"
1156                     + " added to VpnPortipToPort DS", fixedIp, vpnName, portName, macAddress);
1157         }
1158     }
1159
1160     private static InstanceIdentifier<LearntVpnVipToPort> buildLearntVpnVipToPortIdentifier(String vpnName,
1161             String fixedIp) {
1162         return InstanceIdentifier.builder(LearntVpnVipToPortData.class).child(LearntVpnVipToPort.class,
1163                 new LearntVpnVipToPortKey(fixedIp, vpnName)).build();
1164     }
1165
1166     protected static void removeLearntVpnVipToPort(DataBroker broker, String vpnName, String fixedIp,
1167                                                    WriteTransaction writeOperTxn) {
1168         synchronized ((vpnName + fixedIp).intern()) {
1169             InstanceIdentifier<LearntVpnVipToPort> id = buildLearntVpnVipToPortIdentifier(vpnName, fixedIp);
1170             if (writeOperTxn != null) {
1171                 writeOperTxn.delete(LogicalDatastoreType.OPERATIONAL, id);
1172             } else {
1173                 MDSALUtil.syncDelete(broker, LogicalDatastoreType.OPERATIONAL, id);
1174             }
1175             LOG.debug("removeLearntVpnVipToPort: Delete learned ARP for fixedIp: {}, vpn {} removed from"
1176                     + " VpnPortipToPort DS", fixedIp, vpnName);
1177         }
1178     }
1179
1180     protected static void createLearntVpnVipToPortEvent(DataBroker broker, String vpnName, String srcIp, String destIP,
1181                                                         String portName, String macAddress,
1182                                                         LearntVpnVipToPortEventAction action,
1183                                                         WriteTransaction writeOperTxn) {
1184         String eventId = MicroTimestamp.INSTANCE.get();
1185
1186         InstanceIdentifier<LearntVpnVipToPortEvent> id = buildLearntVpnVipToPortEventIdentifier(eventId);
1187         LearntVpnVipToPortEventBuilder builder = new LearntVpnVipToPortEventBuilder().setKey(
1188                 new LearntVpnVipToPortEventKey(eventId)).setVpnName(vpnName).setSrcFixedip(srcIp)
1189                 .setDestFixedip(destIP).setPortName(portName)
1190                 .setMacAddress(macAddress.toLowerCase(Locale.getDefault())).setEventAction(action);
1191         if (writeOperTxn != null) {
1192             writeOperTxn.delete(LogicalDatastoreType.OPERATIONAL, id);
1193         } else {
1194             MDSALUtil.syncWrite(broker, LogicalDatastoreType.OPERATIONAL, id, builder.build());
1195         }
1196         LOG.info("createLearntVpnVipToPortEvent: ARP learn event created for fixedIp: {}, vpn {}, interface {},"
1197                 + " mac {} action {} eventId {}", srcIp, vpnName, portName, macAddress, action, eventId);
1198     }
1199
1200     private static InstanceIdentifier<LearntVpnVipToPortEvent> buildLearntVpnVipToPortEventIdentifier(String eventId) {
1201         InstanceIdentifier<LearntVpnVipToPortEvent> id = InstanceIdentifier.builder(LearntVpnVipToPortEventData.class)
1202                 .child(LearntVpnVipToPortEvent.class, new LearntVpnVipToPortEventKey(eventId)).build();
1203         return id;
1204     }
1205
1206     protected static void removeLearntVpnVipToPortEvent(DataBroker broker, String eventId,
1207                                                         WriteTransaction writeOperTxn) {
1208         InstanceIdentifier<LearntVpnVipToPortEvent> id = buildLearntVpnVipToPortEventIdentifier(eventId);
1209         if (writeOperTxn != null) {
1210             writeOperTxn.delete(LogicalDatastoreType.OPERATIONAL, id);
1211         } else {
1212             MDSALUtil.syncDelete(broker, LogicalDatastoreType.OPERATIONAL, id);
1213         }
1214         LOG.info("removeLearntVpnVipToPortEvent: Deleted Event {}", eventId);
1215
1216     }
1217
1218     public static void removeMipAdjacency(DataBroker dataBroker, String vpnName, String vpnInterface, String prefix,
1219                                           WriteTransaction writeConfigTxn) {
1220         String ip = VpnUtil.getIpPrefix(prefix);
1221         LOG.trace("Removing {} adjacency from Old VPN Interface {} ", ip, vpnInterface);
1222         InstanceIdentifier<VpnInterface> vpnIfId = VpnUtil.getVpnInterfaceIdentifier(vpnInterface);
1223         InstanceIdentifier<Adjacencies> path = vpnIfId.augmentation(Adjacencies.class);
1224         //TODO: Remove synchronized?
1225
1226         Optional<Adjacencies> adjacencies = VpnUtil.read(dataBroker, LogicalDatastoreType.OPERATIONAL, path);
1227         if (adjacencies.isPresent()) {
1228             InstanceIdentifier<Adjacency> adjacencyIdentifier = InstanceIdentifier.builder(VpnInterfaces.class)
1229                     .child(VpnInterface.class, new VpnInterfaceKey(vpnInterface)).augmentation(Adjacencies.class)
1230                     .child(Adjacency.class, new AdjacencyKey(ip)).build();
1231             writeConfigTxn.delete(LogicalDatastoreType.CONFIGURATION, adjacencyIdentifier);
1232             LOG.error("removeMipAdjacency: Successfully Deleted Adjacency {} from interface {} vpn {}", ip,
1233                     vpnInterface, vpnName);
1234         }
1235     }
1236
1237     public static void removeMipAdjAndLearntIp(DataBroker dataBroker, String vpnName,
1238                                                String vpnInterface, String prefix) {
1239         synchronized ((vpnName + prefix).intern()) {
1240             InstanceIdentifier<LearntVpnVipToPort> id = buildLearntVpnVipToPortIdentifier(vpnName, prefix);
1241             MDSALUtil.syncDelete(dataBroker, LogicalDatastoreType.OPERATIONAL, id);
1242             LOG.info("removeMipAdjAndLearntIp: Delete learned ARP for fixedIp: {}, vpn {} removed from"
1243                             + "VpnPortipToPort DS", prefix, vpnName);
1244             String ip = VpnUtil.getIpPrefix(prefix);
1245             InstanceIdentifier<VpnInterfaceOpDataEntry> vpnInterfaceOpId = VpnUtil
1246                     .getVpnInterfaceOpDataEntryIdentifier(vpnInterface, vpnName);
1247             InstanceIdentifier<AdjacenciesOp> path = vpnInterfaceOpId.augmentation(AdjacenciesOp.class);
1248             Optional<AdjacenciesOp> adjacenciesOp = VpnUtil.read(dataBroker, LogicalDatastoreType.OPERATIONAL, path);
1249             if (adjacenciesOp.isPresent()) {
1250                 InstanceIdentifier<Adjacency> adjacencyIdentifier = InstanceIdentifier.builder(VpnInterfaces.class)
1251                         .child(VpnInterface.class, new VpnInterfaceKey(vpnInterface)).augmentation(Adjacencies.class)
1252                         .child(Adjacency.class, new AdjacencyKey(ip)).build();
1253                 MDSALUtil.syncDelete(dataBroker, LogicalDatastoreType.CONFIGURATION, adjacencyIdentifier);
1254                 LOG.info("removeMipAdjAndLearntIp: Successfully Deleted Adjacency {} from interface {} vpn {}", ip,
1255                         vpnInterface, vpnName);
1256             }
1257         }
1258     }
1259
1260     static InstanceIdentifier<NetworkMap> buildNetworkMapIdentifier(Uuid networkId) {
1261         return InstanceIdentifier.builder(NetworkMaps.class).child(NetworkMap.class, new
1262                 NetworkMapKey(networkId)).build();
1263     }
1264
1265     static InstanceIdentifier<SubnetOpDataEntry> buildSubnetOpDataEntryInstanceIdentifier(Uuid subnetId) {
1266         return InstanceIdentifier.builder(SubnetOpData.class)
1267                 .child(SubnetOpDataEntry.class, new SubnetOpDataEntryKey(subnetId)).build();
1268     }
1269
1270     static InstanceIdentifier<VpnPortipToPort> buildVpnPortipToPortIdentifier(String vpnName, String fixedIp) {
1271         return InstanceIdentifier.builder(NeutronVpnPortipPortData.class).child(VpnPortipToPort.class,
1272                 new VpnPortipToPortKey(fixedIp, vpnName)).build();
1273     }
1274
1275     public static VpnPortipToPort getNeutronPortFromVpnPortFixedIp(DataBroker broker, String vpnName, String fixedIp) {
1276         InstanceIdentifier<VpnPortipToPort> id = buildVpnPortipToPortIdentifier(vpnName, fixedIp);
1277         Optional<VpnPortipToPort> vpnPortipToPortData = read(broker, LogicalDatastoreType.CONFIGURATION, id);
1278         if (vpnPortipToPortData.isPresent()) {
1279             return vpnPortipToPortData.get();
1280         }
1281         return null;
1282     }
1283
1284     static LearntVpnVipToPort getLearntVpnVipToPort(DataBroker broker, String vpnName, String fixedIp) {
1285         InstanceIdentifier<LearntVpnVipToPort> id = buildLearntVpnVipToPortIdentifier(vpnName, fixedIp);
1286         Optional<LearntVpnVipToPort> learntVpnVipToPort = read(broker, LogicalDatastoreType.OPERATIONAL, id);
1287         if (learntVpnVipToPort.isPresent()) {
1288             return learntVpnVipToPort.get();
1289         }
1290         return null;
1291     }
1292
1293     @Nonnull
1294     public static List<BigInteger> getDpnsOnVpn(DataBroker dataBroker, String vpnInstanceName) {
1295         List<BigInteger> result = new ArrayList<>();
1296         String rd = getVpnRd(dataBroker, vpnInstanceName);
1297         if (rd == null) {
1298             LOG.debug("getDpnsOnVpn: Could not find Route-Distinguisher for VpnName={}", vpnInstanceName);
1299             return result;
1300         }
1301
1302         VpnInstanceOpDataEntry vpnInstanceOpData = getVpnInstanceOpData(dataBroker, rd);
1303         if (vpnInstanceOpData == null) {
1304             LOG.debug("getDpnsOnVpn: Could not find OpState for VpnName={}", vpnInstanceName);
1305             return result;
1306         }
1307
1308         List<VpnToDpnList> vpnToDpnList = vpnInstanceOpData.getVpnToDpnList();
1309         if (vpnToDpnList == null) {
1310             LOG.debug("getDpnsOnVpn: Could not find DPN footprint for VpnName={}", vpnInstanceName);
1311             return result;
1312         }
1313         for (VpnToDpnList vpnToDpn : vpnToDpnList) {
1314             result.add(vpnToDpn.getDpnId());
1315         }
1316         return result;
1317     }
1318
1319     static String getAssociatedExternalNetwork(DataBroker dataBroker, String routerId) {
1320         InstanceIdentifier<Routers> id = buildRouterIdentifier(routerId);
1321         Optional<Routers> routerData = read(dataBroker, LogicalDatastoreType.CONFIGURATION, id);
1322         if (routerData.isPresent()) {
1323             Uuid networkId = routerData.get().getNetworkId();
1324             if (networkId != null) {
1325                 return networkId.getValue();
1326             }
1327         }
1328         return null;
1329     }
1330
1331     public static String getAssociatedExternalRouter(DataBroker dataBroker, String extIp) {
1332         InstanceIdentifier<ExtRouters> extRouterInstanceIndentifier =
1333                 InstanceIdentifier.builder(ExtRouters.class).build();
1334         Optional<ExtRouters> extRouterData = read(dataBroker, LogicalDatastoreType.CONFIGURATION,
1335                 extRouterInstanceIndentifier);
1336         if (extRouterData.isPresent()) {
1337             for (Routers routerData : extRouterData.get().getRouters()) {
1338                 List<ExternalIps> externalIps = routerData.getExternalIps();
1339                 for (ExternalIps externalIp : externalIps) {
1340                     if (externalIp.getIpAddress().equals(extIp)) {
1341                         return routerData.getRouterName();
1342                     }
1343                 }
1344             }
1345         }
1346         return null;
1347     }
1348
1349     static InstanceIdentifier<Routers> buildRouterIdentifier(String routerId) {
1350         return InstanceIdentifier.builder(ExtRouters.class).child(Routers.class, new RoutersKey(routerId)).build();
1351     }
1352
1353     static Networks getExternalNetwork(DataBroker dataBroker, Uuid networkId) {
1354         InstanceIdentifier<Networks> netsIdentifier = InstanceIdentifier.builder(ExternalNetworks.class)
1355             .child(Networks.class, new NetworksKey(networkId)).build();
1356         Optional<Networks> optionalNets = VpnUtil.read(dataBroker, LogicalDatastoreType.CONFIGURATION, netsIdentifier);
1357         return optionalNets.isPresent() ? optionalNets.get() : null;
1358     }
1359
1360     static Uuid getExternalNetworkVpnId(DataBroker dataBroker, Uuid networkId) {
1361         Networks extNetwork = getExternalNetwork(dataBroker, networkId);
1362         return extNetwork != null ? extNetwork.getVpnid() : null;
1363     }
1364
1365     static List<Uuid> getExternalNetworkRouterIds(DataBroker dataBroker, Uuid networkId) {
1366         Networks extNetwork = getExternalNetwork(dataBroker, networkId);
1367         return extNetwork != null ? extNetwork.getRouterIds() : Collections.emptyList();
1368     }
1369
1370     static Routers getExternalRouter(DataBroker dataBroker, String routerId) {
1371         InstanceIdentifier<Routers> id = InstanceIdentifier.builder(ExtRouters.class)
1372                 .child(Routers.class, new RoutersKey(routerId)).build();
1373         Optional<Routers> routerData = read(dataBroker, LogicalDatastoreType.CONFIGURATION, id);
1374         return routerData.isPresent() ? routerData.get() : null;
1375     }
1376
1377     static List<String> getAllSubnetGatewayMacAddressesforVpn(DataBroker broker, String vpnName) {
1378         List<String> macAddresses = new ArrayList<>();
1379         Optional<Subnetmaps> subnetMapsData =
1380             read(broker, LogicalDatastoreType.CONFIGURATION, buildSubnetMapsWildCardPath());
1381         if (subnetMapsData.isPresent()) {
1382             List<Subnetmap> subnetMapList = subnetMapsData.get().getSubnetmap();
1383             if (subnetMapList != null && !subnetMapList.isEmpty()) {
1384                 for (Subnetmap subnet : subnetMapList) {
1385                     if (subnet.getVpnId() != null && subnet.getVpnId().equals(Uuid.getDefaultInstance(vpnName))) {
1386                         String routerIntfMacAddress = subnet.getRouterIntfMacAddress();
1387                         if (routerIntfMacAddress != null && !routerIntfMacAddress.isEmpty()) {
1388                             macAddresses.add(subnet.getRouterIntfMacAddress());
1389                         }
1390                     }
1391                 }
1392             }
1393         }
1394         return macAddresses;
1395     }
1396
1397     static InstanceIdentifier<Subnetmaps> buildSubnetMapsWildCardPath() {
1398         return InstanceIdentifier.create(Subnetmaps.class);
1399     }
1400
1401     public static FlowEntity buildL3vpnGatewayFlow(BigInteger dpId, String gwMacAddress, long vpnId,
1402             long subnetVpnId) {
1403         List<MatchInfo> mkMatches = new ArrayList<>();
1404         mkMatches.add(new MatchMetadata(MetaDataUtil.getVpnIdMetadata(vpnId), MetaDataUtil.METADATA_MASK_VRFID));
1405         mkMatches.add(new MatchEthernetDestination(new MacAddress(gwMacAddress)));
1406         List<InstructionInfo> mkInstructions = new ArrayList<>();
1407         mkInstructions.add(new InstructionGotoTable(NwConstants.L3_FIB_TABLE));
1408         if (subnetVpnId != VpnConstants.INVALID_ID) {
1409             BigInteger subnetIdMetaData = MetaDataUtil.getVpnIdMetadata(subnetVpnId);
1410             mkInstructions.add(new InstructionWriteMetadata(subnetIdMetaData, MetaDataUtil.METADATA_MASK_VRFID));
1411         }
1412
1413         String flowId = getL3VpnGatewayFlowRef(NwConstants.L3_GW_MAC_TABLE, dpId, vpnId, gwMacAddress);
1414
1415         return MDSALUtil.buildFlowEntity(dpId, NwConstants.L3_GW_MAC_TABLE,
1416                 flowId, 20, flowId, 0, 0, NwConstants.COOKIE_L3_GW_MAC_TABLE, mkMatches, mkInstructions);
1417     }
1418
1419     private static String getL3VpnGatewayFlowRef(short l3GwMacTable, BigInteger dpId, long vpnId, String gwMacAddress) {
1420         return gwMacAddress + NwConstants.FLOWID_SEPARATOR + vpnId + NwConstants.FLOWID_SEPARATOR + dpId
1421             + NwConstants.FLOWID_SEPARATOR + l3GwMacTable;
1422     }
1423
1424     public static void lockSubnet(LockManagerService lockManager, String subnetId) {
1425         TryLockInput input =
1426             new TryLockInputBuilder().setLockName(subnetId).setTime(3000L).setTimeUnit(TimeUnits.Milliseconds).build();
1427         Future<RpcResult<Void>> result = lockManager.tryLock(input);
1428         try {
1429             if (result != null && result.get().isSuccessful()) {
1430                 LOG.debug("lockSubnet: Acquired lock for {}", subnetId);
1431             } else {
1432                 LOG.error("Unable to get lock for subnet {}", subnetId);
1433                 throw new RuntimeException("Unable to get lock for subnet " + subnetId);
1434             }
1435         } catch (InterruptedException | ExecutionException e) {
1436             LOG.error("Unable to get lock for subnet {}", subnetId, e);
1437             throw new RuntimeException("Unable to get lock for subnet " + subnetId, e);
1438         }
1439     }
1440
1441     // We store the cause, which is what we really care about
1442     @SuppressWarnings("checkstyle:AvoidHidingCauseException")
1443     public static void unlockSubnet(LockManagerService lockManager, String subnetId) {
1444         UnlockInput input = new UnlockInputBuilder().setLockName(subnetId).build();
1445         Future<RpcResult<Void>> result = lockManager.unlock(input);
1446         try {
1447             if (result != null && result.get().isSuccessful()) {
1448                 LOG.debug("unlockSubnet: Unlocked {}", subnetId);
1449             } else {
1450                 LOG.debug("unlockSubnet: Unable to unlock subnet {}", subnetId);
1451             }
1452         } catch (InterruptedException | ExecutionException e) {
1453             LOG.error("unlockSubnet: Unable to unlock subnet {}", subnetId);
1454             throw new RuntimeException(String.format("Unable to unlock subnetId %s", subnetId), e.getCause());
1455         }
1456     }
1457
1458     static Optional<IpAddress> getIpv4GatewayAddressFromInterface(String srcInterface,
1459             INeutronVpnManager neutronVpnService) {
1460         Optional<IpAddress> gatewayIp = Optional.absent();
1461         if (neutronVpnService != null) {
1462             //TODO(Gobinath): Need to fix this as assuming port will belong to only one Subnet would be incorrect"
1463             Port port = neutronVpnService.getNeutronPort(srcInterface);
1464             if (port != null && port.getFixedIps() != null) {
1465                 for (FixedIps portIp: port.getFixedIps()) {
1466                     if (portIp.getIpAddress().getIpv6Address() != null) {
1467                         // Skip IPv6 address
1468                         continue;
1469                     }
1470                     gatewayIp = Optional.of(
1471                             neutronVpnService.getNeutronSubnet(portIp.getSubnetId()).getGatewayIp());
1472                 }
1473             }
1474         } else {
1475             LOG.error("getGatewayIpAddressFromInterface: neutron vpn service is not configured."
1476                     + " Failed for interface {}.", srcInterface);
1477         }
1478         return gatewayIp;
1479     }
1480
1481     static Optional<String> getGWMacAddressFromInterface(MacEntry macEntry, IpAddress gatewayIp,
1482             DataBroker dataBroker) {
1483         Optional<String> gatewayMac = Optional.absent();
1484         long vpnId = getVpnId(dataBroker, macEntry.getVpnName());
1485         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn
1486             .instance.VpnIds>
1487             vpnIdsInstanceIdentifier = VpnUtil.getVpnIdToVpnInstanceIdentifier(vpnId);
1488         Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance.VpnIds>
1489             vpnIdsOptional
1490             = VpnUtil.read(dataBroker, LogicalDatastoreType.CONFIGURATION, vpnIdsInstanceIdentifier);
1491         if (!vpnIdsOptional.isPresent()) {
1492             LOG.error("getGWMacAddressFromInterface: VPN {} not configured", vpnId);
1493             return gatewayMac;
1494         }
1495         VpnPortipToPort vpnTargetIpToPort = VpnUtil.getNeutronPortFromVpnPortFixedIp(dataBroker,
1496             macEntry.getVpnName(), gatewayIp.getIpv4Address().getValue());
1497         if (vpnTargetIpToPort != null && vpnTargetIpToPort.isSubnetIp()) {
1498             gatewayMac = Optional.of(vpnTargetIpToPort.getMacAddress());
1499         } else {
1500             org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance.VpnIds vpnIds =
1501                 vpnIdsOptional.get();
1502             if (vpnIds.isExternalVpn()) {
1503                 gatewayMac = InterfaceUtils.getMacAddressForInterface(dataBroker, macEntry.getInterfaceName());
1504             }
1505         }
1506         return gatewayMac;
1507     }
1508
1509     public static void setupGwMacIfExternalVpn(DataBroker dataBroker, IMdsalApiManager mdsalManager, BigInteger dpnId,
1510             String interfaceName, long vpnId, WriteTransaction writeInvTxn, int addOrRemove, String gwMac) {
1511         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance
1512             .VpnIds> vpnIdsInstanceIdentifier = getVpnIdToVpnInstanceIdentifier(vpnId);
1513         Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance
1514             .VpnIds> vpnIdsOptional = read(
1515                 dataBroker, LogicalDatastoreType.CONFIGURATION, vpnIdsInstanceIdentifier);
1516         if (vpnIdsOptional.isPresent() && vpnIdsOptional.get().isExternalVpn()) {
1517             if (gwMac == null) {
1518                 LOG.error("setupGwMacIfExternalVpn: Failed to get gwMacAddress for interface {} on dpn {} vpn {}",
1519                         interfaceName, dpnId.toString(), vpnIdsOptional.get().getVpnInstanceName());
1520                 return;
1521             }
1522             FlowEntity flowEntity = VpnUtil.buildL3vpnGatewayFlow(dpnId, gwMac, vpnId, VpnConstants.INVALID_ID);
1523             if (addOrRemove == NwConstants.ADD_FLOW) {
1524                 mdsalManager.addFlowToTx(flowEntity, writeInvTxn);
1525             } else if (addOrRemove == NwConstants.DEL_FLOW) {
1526                 mdsalManager.removeFlowToTx(flowEntity, writeInvTxn);
1527             }
1528         }
1529     }
1530
1531     public static Optional<VpnPortipToPort> getRouterInterfaceForVpnInterface(DataBroker dataBroker,
1532                                                                               String vpnName,
1533                                                                               Uuid subnetUuid) {
1534         Optional<VpnPortipToPort> gwPortOptional = Optional.absent();
1535         if (subnetUuid != null) {
1536             final Optional<String> gatewayIp = getVpnSubnetGatewayIp(dataBroker, subnetUuid);
1537             if (gatewayIp.isPresent()) {
1538                 String gwIp = gatewayIp.get();
1539                 gwPortOptional = Optional.fromNullable(getNeutronPortFromVpnPortFixedIp(dataBroker, vpnName, gwIp));
1540             }
1541         }
1542         return gwPortOptional;
1543     }
1544
1545     public static Optional<String> getVpnSubnetGatewayIp(DataBroker dataBroker, final Uuid subnetUuid) {
1546         Optional<String> gwIpAddress = Optional.absent();
1547         final SubnetKey subnetkey = new SubnetKey(subnetUuid);
1548         final InstanceIdentifier<Subnet> subnetidentifier = InstanceIdentifier.create(Neutron.class)
1549                 .child(Subnets.class)
1550                 .child(Subnet.class, subnetkey);
1551         final Optional<Subnet> subnet = read(dataBroker, LogicalDatastoreType.CONFIGURATION, subnetidentifier);
1552         if (subnet.isPresent()) {
1553             Class<? extends IpVersionBase> ipVersionBase = subnet.get().getIpVersion();
1554             if (ipVersionBase.equals(IpVersionV4.class)) {
1555                 LOG.trace("getVpnSubnetGatewayIp: Obtained subnet {} for vpn interface",
1556                         subnet.get().getUuid().getValue());
1557                 IpAddress gwIp = subnet.get().getGatewayIp();
1558                 if (gwIp != null && gwIp.getIpv4Address() != null) {
1559                     gwIpAddress = Optional.of(gwIp.getIpv4Address().getValue());
1560                 }
1561             }
1562         }
1563         return gwIpAddress;
1564     }
1565
1566     public static RouterToNaptSwitch getRouterToNaptSwitch(DataBroker dataBroker, String routerName) {
1567         InstanceIdentifier<RouterToNaptSwitch> id = InstanceIdentifier.builder(NaptSwitches.class)
1568                 .child(RouterToNaptSwitch.class, new RouterToNaptSwitchKey(routerName)).build();
1569         Optional<RouterToNaptSwitch> routerToNaptSwitchData = read(dataBroker, LogicalDatastoreType.CONFIGURATION, id);
1570         return routerToNaptSwitchData.isPresent() ? routerToNaptSwitchData.get() : null;
1571     }
1572
1573     static InstanceIdentifier<Subnetmap> buildSubnetmapIdentifier(Uuid subnetId) {
1574         return InstanceIdentifier.builder(Subnetmaps.class)
1575         .child(Subnetmap.class, new SubnetmapKey(subnetId)).build();
1576
1577     }
1578
1579     public static BigInteger getPrimarySwitchForRouter(DataBroker dataBroker, String routerName) {
1580         RouterToNaptSwitch routerToNaptSwitch = getRouterToNaptSwitch(dataBroker, routerName);
1581         return routerToNaptSwitch != null ? routerToNaptSwitch.getPrimarySwitchId() : null;
1582     }
1583
1584     static boolean isL3VpnOverVxLan(Long l3Vni) {
1585         return l3Vni != null && l3Vni != 0;
1586     }
1587
1588     static boolean isEvpnOverVxLan(Long l2Vni) { //To be used by RT2
1589         return l2Vni != null && l2Vni != 0;
1590     }
1591
1592     /**
1593      * Retrieves the primary rd of a vpn instance
1594      * Primary rd will be the first rd in the list of rds configured for a vpn instance
1595      * If rd list is empty, primary rd will be vpn instance name
1596      * Use this function only during create operation cycles. For other operations, use getVpnRd() method.
1597      *
1598      * @param dataBroker dataBroker service reference
1599      * @param vpnName Name of the VPN
1600      * @return the primary rd of the VPN
1601      */
1602     public static String getPrimaryRd(DataBroker dataBroker, String vpnName) {
1603         // Retrieves the VPN Route Distinguisher by its Vpn instance name
1604         String rd = getVpnRd(dataBroker, vpnName);
1605         if (rd != null) {
1606             return rd;
1607         }
1608         InstanceIdentifier<VpnInstance> id  = getVpnInstanceIdentifier(vpnName);
1609         Optional<VpnInstance> vpnInstance = VpnUtil.read(dataBroker, LogicalDatastoreType.CONFIGURATION, id);
1610         if (vpnInstance.isPresent()) {
1611             return getPrimaryRd(vpnInstance.get());
1612         }
1613         return vpnName;
1614     }
1615
1616     /**
1617      * Retrieves the primary rd of a vpn instance
1618      * Primary rd will be the first rd in the list of rds configured for a vpn instance
1619      * If rd list is empty, primary rd will be vpn instance name
1620      * Use this function only during create operation cycles. For other operations, use getVpnRd() method.
1621      *
1622      * @param vpnInstance Config Vpn Instance Object
1623      * @return the primary rd of the VPN
1624      */
1625     public static String getPrimaryRd(VpnInstance vpnInstance) {
1626         List<String> rds = null;
1627         if (vpnInstance != null) {
1628             rds = getListOfRdsFromVpnInstance(vpnInstance);
1629         }
1630         return rds == null || rds.isEmpty() ? vpnInstance.getVpnInstanceName() : rds.get(0);
1631     }
1632
1633     public static boolean isBgpVpn(String vpnName, String primaryRd) {
1634         return !vpnName.equals(primaryRd);
1635     }
1636
1637     static java.util.Optional<String> allocateRdForExtraRouteAndUpdateUsedRdsMap(
1638             DataBroker dataBroker, long vpnId, @Nullable Long parentVpnId, String prefix, String vpnName,
1639             String nextHop, BigInteger dpnId) {
1640         //Check if rd is already allocated for this extraroute behind the same VM. If yes, reuse it.
1641         //This is particularly useful during reboot scenarios.
1642         java.util.Optional<String> allocatedRd = VpnExtraRouteHelper
1643                 .getRdAllocatedForExtraRoute(dataBroker, vpnId, prefix, nextHop);
1644         if (allocatedRd.isPresent()) {
1645             return allocatedRd;
1646         }
1647
1648         //Check if rd is already allocated for this extraroute behind the same CSS. If yes, reuse it
1649         List<String> usedRds = VpnExtraRouteHelper.getUsedRds(dataBroker, vpnId, prefix);
1650         for (String usedRd : usedRds) {
1651             Optional<Routes> vpnExtraRoutes = VpnExtraRouteHelper.getVpnExtraroutes(dataBroker,
1652                     vpnName, usedRd, prefix);
1653             if (vpnExtraRoutes.isPresent()) {
1654                 String nextHopIp = vpnExtraRoutes.get().getNexthopIpList().get(0);
1655                 // In case of VPN importing the routes, the interface is not present in the VPN
1656                 // and has to be fetched from the VPN from which it imports
1657                 Optional<Prefixes> prefixToInterface =
1658                         getPrefixToInterface(dataBroker, parentVpnId != null ? parentVpnId : vpnId, nextHopIp);
1659                 if (prefixToInterface.isPresent() && dpnId.equals(prefixToInterface.get().getDpnId())) {
1660                     syncUpdate(dataBroker, LogicalDatastoreType.CONFIGURATION,
1661                             VpnExtraRouteHelper.getUsedRdsIdentifier(vpnId, prefix, nextHop),
1662                             getRdsBuilder(nextHop, usedRd).build());
1663                     return java.util.Optional.of(usedRd);
1664                 }
1665             }
1666         }
1667         List<String> availableRds = getVpnRdsFromVpnInstanceConfig(dataBroker, vpnName);
1668         String rd;
1669         if (availableRds.isEmpty()) {
1670             rd = dpnId.toString();
1671             LOG.debug("Internal vpn {} Returning DpnId {} as rd", vpnName, rd);
1672         } else {
1673             LOG.trace("Removing used rds {} from available rds {} vpnid {} . prefix is {} , vpname- {}, dpnId- {}",
1674                     usedRds, availableRds, vpnId, prefix, vpnName, dpnId);
1675             availableRds.removeAll(usedRds);
1676             if (availableRds.isEmpty()) {
1677                 LOG.error("No rd available from VpnInstance to allocate for prefix {}", prefix);
1678                 return java.util.Optional.empty();
1679             }
1680             // If rd is not allocated for this prefix or if extra route is behind different OVS, select a new rd.
1681             rd = availableRds.get(0);
1682         }
1683         syncUpdate(dataBroker, LogicalDatastoreType.CONFIGURATION,
1684                 VpnExtraRouteHelper.getUsedRdsIdentifier(vpnId, prefix, nextHop),
1685                 getRdsBuilder(nextHop, rd).build());
1686         return java.util.Optional.ofNullable(rd);
1687     }
1688
1689     static String getVpnNamePrefixKey(String vpnName, String prefix) {
1690         return vpnName + VpnConstants.SEPARATOR + prefix;
1691     }
1692
1693     static InstanceIdentifier<Adjacency> getAdjacencyIdentifier(String vpnInterfaceName, String ipAddress) {
1694         return InstanceIdentifier.builder(VpnInterfaces.class)
1695                 .child(VpnInterface.class, new VpnInterfaceKey(vpnInterfaceName))
1696                 .augmentation(Adjacencies.class).child(Adjacency.class, new AdjacencyKey(ipAddress)).build();
1697     }
1698
1699     public static List<String> getIpsListFromExternalIps(List<ExternalIps> externalIps) {
1700         if (externalIps == null) {
1701             return Collections.emptyList();
1702         }
1703
1704         return externalIps.stream().map(ExternalIps::getIpAddress).collect(Collectors.toList());
1705     }
1706
1707     static void bindService(final String vpnInstanceName, final String interfaceName, DataBroker dataBroker,
1708                             boolean isTunnelInterface, JobCoordinator jobCoordinator) {
1709         jobCoordinator.enqueueJob(interfaceName,
1710             () -> {
1711                 WriteTransaction writeTxn = dataBroker.newWriteOnlyTransaction();
1712                 BoundServices serviceInfo = isTunnelInterface
1713                         ? VpnUtil.getBoundServicesForTunnelInterface(vpnInstanceName, interfaceName)
1714                         : getBoundServicesForVpnInterface(dataBroker, vpnInstanceName, interfaceName);
1715                 writeTxn.put(LogicalDatastoreType.CONFIGURATION, InterfaceUtils.buildServiceId(interfaceName,
1716                         ServiceIndex.getIndex(NwConstants.L3VPN_SERVICE_NAME, NwConstants.L3VPN_SERVICE_INDEX)),
1717                         serviceInfo, WriteTransaction.CREATE_MISSING_PARENTS);
1718                 return Collections.singletonList(writeTxn.submit());
1719             }, SystemPropertyReader.getDataStoreJobCoordinatorMaxRetries());
1720     }
1721
1722     static BoundServices getBoundServicesForVpnInterface(DataBroker broker, String vpnName, String interfaceName) {
1723         List<Instruction> instructions = new ArrayList<>();
1724         int instructionKey = 0;
1725         final long vpnId = VpnUtil.getVpnId(broker, vpnName);
1726         List<Action> actions = Collections.singletonList(
1727                 new ActionRegLoad(0, VpnConstants.VPN_REG_ID, 0, VpnConstants.VPN_ID_LENGTH, vpnId).buildAction());
1728         instructions.add(MDSALUtil.buildApplyActionsInstruction(actions, ++instructionKey));
1729         instructions.add(
1730                 MDSALUtil.buildAndGetWriteMetadaInstruction(MetaDataUtil.getVpnIdMetadata(vpnId),
1731                         MetaDataUtil.METADATA_MASK_VRFID, ++instructionKey));
1732         instructions.add(MDSALUtil.buildAndGetGotoTableInstruction(NwConstants.L3_GW_MAC_TABLE,
1733                 ++instructionKey));
1734         BoundServices serviceInfo = InterfaceUtils.getBoundServices(
1735                 String.format("%s.%s.%s", "vpn", vpnName, interfaceName),
1736                 ServiceIndex.getIndex(NwConstants.L3VPN_SERVICE_NAME, NwConstants.L3VPN_SERVICE_INDEX),
1737                 VpnConstants.DEFAULT_FLOW_PRIORITY, NwConstants.COOKIE_VM_INGRESS_TABLE, instructions);
1738         return serviceInfo;
1739     }
1740
1741     static BoundServices getBoundServicesForTunnelInterface(String vpnName, String interfaceName) {
1742         int instructionKey = 0;
1743         List<Instruction> instructions = new ArrayList<>();
1744         instructions.add(MDSALUtil.buildAndGetGotoTableInstruction(
1745                 NwConstants.L3VNI_EXTERNAL_TUNNEL_DEMUX_TABLE, ++instructionKey));
1746         BoundServices serviceInfo = InterfaceUtils.getBoundServices(String.format("%s.%s.%s", "vpn",
1747                 vpnName, interfaceName),
1748                 ServiceIndex.getIndex(NwConstants.L3VPN_SERVICE_NAME,
1749                         NwConstants.L3VNI_EXTERNAL_TUNNEL_DEMUX_TABLE), VpnConstants.DEFAULT_FLOW_PRIORITY,
1750                 NwConstants.COOKIE_VM_INGRESS_TABLE, instructions);
1751         return serviceInfo;
1752     }
1753
1754     static void unbindService(DataBroker dataBroker, final String vpnInterfaceName, boolean isInterfaceStateDown,
1755             JobCoordinator jobCoordinator) {
1756         if (!isInterfaceStateDown) {
1757             jobCoordinator.enqueueJob(vpnInterfaceName,
1758                 () -> {
1759                     WriteTransaction writeTxn = dataBroker.newWriteOnlyTransaction();
1760                     writeTxn.delete(LogicalDatastoreType.CONFIGURATION,
1761                             InterfaceUtils.buildServiceId(vpnInterfaceName,
1762                                     ServiceIndex.getIndex(NwConstants.L3VPN_SERVICE_NAME,
1763                                             NwConstants.L3VPN_SERVICE_INDEX)));
1764
1765                     List<ListenableFuture<Void>> futures = new ArrayList<>();
1766                     futures.add(writeTxn.submit());
1767                     return futures;
1768                 }, SystemPropertyReader.getDataStoreJobCoordinatorMaxRetries());
1769         }
1770     }
1771
1772     static FlowEntity buildFlowEntity(BigInteger dpnId, short tableId, String flowId) {
1773         return new FlowEntityBuilder()
1774             .setDpnId(dpnId)
1775             .setTableId(tableId)
1776             .setFlowId(flowId)
1777             .build();
1778     }
1779
1780     static VrfEntryBase.EncapType getEncapType(boolean isVxLan) {
1781         return isVxLan ? VrfEntryBase.EncapType.Vxlan : VrfEntryBase.EncapType.Mplsgre;
1782     }
1783
1784     static org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets
1785         .Subnets getExternalSubnet(DataBroker dataBroker, Uuid subnetId) {
1786         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets
1787             .Subnets> subnetsIdentifier = InstanceIdentifier.builder(ExternalSubnets.class)
1788                 .child(org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets
1789                         .Subnets.class, new SubnetsKey(subnetId)).build();
1790         Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets.Subnets>
1791             optionalSubnets = VpnUtil.read(dataBroker, LogicalDatastoreType.CONFIGURATION, subnetsIdentifier);
1792         return optionalSubnets.isPresent() ? optionalSubnets.get() : null;
1793     }
1794
1795     static Uuid getSubnetFromExternalRouterByIp(DataBroker dataBroker, Uuid routerId, String ip) {
1796         Routers externalRouter = VpnUtil.getExternalRouter(dataBroker, routerId.getValue());
1797         if (externalRouter != null && externalRouter.getExternalIps() != null) {
1798             for (ExternalIps externalIp : externalRouter.getExternalIps()) {
1799                 if (externalIp.getIpAddress().equals(ip)) {
1800                     return externalIp.getSubnetId();
1801                 }
1802             }
1803         }
1804         return null;
1805     }
1806
1807     static boolean isExternalSubnetVpn(String vpnName, String subnetId) {
1808         return vpnName.equals(subnetId);
1809     }
1810
1811     static Boolean getIsExternal(Network network) {
1812         return network.getAugmentation(NetworkL3Extension.class) != null
1813                 && network.getAugmentation(NetworkL3Extension.class).isExternal();
1814     }
1815
1816     @SuppressWarnings("checkstyle:linelength")
1817     static Network getNeutronNetwork(DataBroker broker, Uuid networkId) {
1818         Network network = null;
1819         LOG.debug("getNeutronNetwork for {}", networkId.getValue());
1820         InstanceIdentifier<Network> inst = InstanceIdentifier.create(Neutron.class).child(
1821                 org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.Networks.class).child(
1822                 Network.class, new NetworkKey(networkId));
1823         Optional<Network> net = read(broker, LogicalDatastoreType.CONFIGURATION, inst);
1824         if (net.isPresent()) {
1825             network = net.get();
1826         }
1827         return network;
1828     }
1829
1830     public static boolean isEligibleForBgp(String rd, String vpnName, BigInteger dpnId, String networkName) {
1831         if (rd != null) {
1832             if (vpnName != null && rd.equals(vpnName)) {
1833                 return false;
1834             }
1835             if (dpnId != null && rd.equals(dpnId.toString())) {
1836                 return false;
1837             }
1838             if (networkName != null && rd.equals(networkName)) {
1839                 return false;
1840             }
1841             return true;
1842         }
1843         return false;
1844     }
1845
1846     static String getFibFlowRef(BigInteger dpnId, short tableId, String vpnName, int priority) {
1847         return VpnConstants.FLOWID_PREFIX + dpnId + NwConstants.FLOWID_SEPARATOR + tableId
1848                 + NwConstants.FLOWID_SEPARATOR + vpnName + NwConstants.FLOWID_SEPARATOR + priority;
1849     }
1850
1851     static void removeExternalTunnelDemuxFlows(String vpnName, DataBroker broker, IMdsalApiManager mdsalManager) {
1852         LOG.info("Removing external tunnel flows for vpn {}", vpnName);
1853         for (BigInteger dpnId: NWUtil.getOperativeDPNs(broker)) {
1854             LOG.debug("Removing external tunnel flows for vpn {} from dpn {}", vpnName, dpnId);
1855             String flowRef = getFibFlowRef(dpnId, NwConstants.L3VNI_EXTERNAL_TUNNEL_DEMUX_TABLE,
1856                     vpnName, VpnConstants.DEFAULT_FLOW_PRIORITY);
1857             FlowEntity flowEntity = VpnUtil.buildFlowEntity(dpnId,
1858                     NwConstants.L3VNI_EXTERNAL_TUNNEL_DEMUX_TABLE, flowRef);
1859             mdsalManager.removeFlow(flowEntity);
1860         }
1861     }
1862
1863     public static boolean isVpnPendingDelete(DataBroker broker, String rd) {
1864         VpnInstanceOpDataEntry vpnInstanceOpData = getVpnInstanceOpData(broker, rd);
1865         boolean isVpnPendingDelete = false;
1866         if (vpnInstanceOpData == null
1867                 || vpnInstanceOpData.getVpnState() == VpnInstanceOpDataEntry.VpnState.PendingDelete) {
1868             isVpnPendingDelete = true;
1869         }
1870         return isVpnPendingDelete;
1871     }
1872
1873     public static List<VpnInstanceOpDataEntry> getVpnsImportingMyRoute(final DataBroker broker, final String vpnName) {
1874         List<VpnInstanceOpDataEntry> vpnsToImportRoute = new ArrayList<>();
1875
1876         final String vpnRd = getVpnRd(broker, vpnName);
1877         if (vpnRd == null) {
1878             LOG.error("getVpnsImportingMyRoute: vpn {} not present in config DS.", vpnName);
1879             return vpnsToImportRoute;
1880         }
1881         final VpnInstanceOpDataEntry vpnInstanceOpDataEntry = VpnUtil.getVpnInstanceOpData(broker, vpnRd);
1882         if (vpnInstanceOpDataEntry == null) {
1883             LOG.error("getVpnsImportingMyRoute: Could not retrieve vpn instance op data for {}"
1884                     + " to check for vpns importing the routes", vpnName);
1885             return vpnsToImportRoute;
1886         }
1887
1888         Predicate<VpnInstanceOpDataEntry> excludeVpn = input -> {
1889             if (input.getVpnInstanceName() == null) {
1890                 LOG.error("getVpnsImportingMyRoute.excludeVpn: Received vpn instance with rd {} without a name.",
1891                         input.getVrfId());
1892                 return false;
1893             }
1894             return !input.getVpnInstanceName().equals(vpnName);
1895         };
1896
1897         Predicate<VpnInstanceOpDataEntry> matchRTs = input -> {
1898             Iterable<String> commonRTs =
1899                 intersection(getRts(vpnInstanceOpDataEntry, VpnTarget.VrfRTType.ExportExtcommunity),
1900                     getRts(input, VpnTarget.VrfRTType.ImportExtcommunity));
1901             return Iterators.size(commonRTs.iterator()) > 0;
1902         };
1903
1904         vpnsToImportRoute = getAllVpnInstanceOpData(broker)
1905                 .stream()
1906                 .filter(excludeVpn)
1907                 .filter(matchRTs)
1908                 .collect(Collectors.toList());
1909         return vpnsToImportRoute;
1910     }
1911
1912     public static List<String> getRts(VpnInstanceOpDataEntry vpnInstance, VpnTarget.VrfRTType rtType) {
1913         String name = vpnInstance.getVpnInstanceName();
1914         List<String> rts = new ArrayList<>();
1915         VpnTargets targets = vpnInstance.getVpnTargets();
1916         if (targets == null) {
1917             LOG.info("getRts: vpn targets not available for {}", name);
1918             return rts;
1919         }
1920         List<VpnTarget> vpnTargets = targets.getVpnTarget();
1921         if (vpnTargets == null) {
1922             LOG.info("getRts: vpnTarget values not available for {}", name);
1923             return rts;
1924         }
1925         for (VpnTarget target : vpnTargets) {
1926             //TODO: Check for RT type is Both
1927             if (target.getVrfRTType().equals(rtType) || target.getVrfRTType().equals(VpnTarget.VrfRTType.Both)) {
1928                 String rtValue = target.getVrfRTValue();
1929                 rts.add(rtValue);
1930             }
1931         }
1932         return rts;
1933     }
1934
1935     public static <T> Iterable<T> intersection(final Collection<T> collection1, final Collection<T> collection2) {
1936         Set<T> intersection = new HashSet<>(collection1);
1937         intersection.retainAll(collection2);
1938         return intersection;
1939     }
1940
1941     /** Get Subnetmap from its Uuid.
1942      * @param broker the data broker for look for data
1943      * @param subnetUuid the subnet's Uuid
1944      * @return the Subnetmap of Uuid or null if it is not found
1945      */
1946     public static Subnetmap getSubnetmapFromItsUuid(DataBroker broker, Uuid subnetUuid) {
1947         Subnetmap sn = null;
1948         InstanceIdentifier<Subnetmap> id = buildSubnetmapIdentifier(subnetUuid);
1949         Optional<Subnetmap> optionalSn = read(broker, LogicalDatastoreType.CONFIGURATION, id);
1950         if (optionalSn.isPresent()) {
1951             sn = optionalSn.get();
1952         }
1953         return sn;
1954     }
1955
1956     public static boolean isSubnetPartOfVpn(Subnetmap sn, String vpnName) {
1957         if (vpnName == null || sn == null || sn.getVpnId() == null) {
1958             return false;
1959         }
1960         if (sn.getVpnId().getValue().equals(vpnName)) {
1961             return true;
1962         } else if (sn.getInternetVpnId() != null
1963                 && sn.getInternetVpnId().getValue().equals(vpnName)) {
1964             return true;
1965         }
1966         return false;
1967     }
1968
1969     public static boolean isAdjacencyEligibleToVpnInternet(DataBroker dataBroker, Adjacency adjacency) {
1970         // returns true if BGPVPN Internet and adjacency is IPv6, false otherwise
1971         boolean adjacencyEligible = true;
1972         if (adjacency.getAdjacencyType() == AdjacencyType.ExtraRoute) {
1973             if (FibHelper.isIpv6Prefix(adjacency.getIpAddress())) {
1974                 return adjacencyEligible;
1975             }
1976             return false;
1977         } else if (adjacency.getSubnetId() == null) {
1978             return adjacencyEligible;
1979         }
1980         Subnetmap sn = VpnUtil.getSubnetmapFromItsUuid(
1981                    dataBroker, adjacency.getSubnetId());
1982         if (sn != null && sn.getInternetVpnId() != null) {
1983             adjacencyEligible = false;
1984         }
1985         return adjacencyEligible;
1986     }
1987
1988     public static boolean isAdjacencyEligibleToVpn(DataBroker dataBroker, Adjacency adjacency,
1989             String vpnName) {
1990         // returns true if BGPVPN Internet and adjacency is IPv6, false otherwise
1991         boolean adjacencyEligible = true;
1992         // if BGPVPN internet, return false if subnetmap has not internetVpnId() filled in
1993         if (isBgpVpnInternet(dataBroker, vpnName)) {
1994             return isAdjacencyEligibleToVpnInternet(dataBroker, adjacency);
1995         }
1996         return adjacencyEligible;
1997     }
1998
1999     public static String getInternetVpnFromVpnInstanceList(DataBroker dataBroker,
2000                                         List<VpnInstanceNames> vpnInstanceList) {
2001         for (VpnInstanceNames vpnInstance : vpnInstanceList) {
2002             String vpnName = vpnInstance.getVpnName();
2003             if (isBgpVpnInternet(dataBroker, vpnName)) {
2004                 return vpnName;
2005             }
2006         }
2007         return null;
2008     }
2009
2010     /** Get boolean true if vpn is bgpvpn internet, false otherwise.
2011      * @param dataBroker databroker for transaction
2012      * @param vpnName name of the input VPN
2013      * @return true or false
2014      */
2015     public static boolean isBgpVpnInternet(DataBroker dataBroker, String vpnName) {
2016         String primaryRd = getVpnRd(dataBroker, vpnName);
2017         if (primaryRd == null) {
2018             LOG.error("isBgpVpnInternet VPN {}."
2019                       + "Primary RD not found", vpnName);
2020             return false;
2021         }
2022         InstanceIdentifier<VpnInstanceOpDataEntry> id = InstanceIdentifier.builder(VpnInstanceOpData.class)
2023               .child(VpnInstanceOpDataEntry.class, new VpnInstanceOpDataEntryKey(primaryRd)).build();
2024
2025         Optional<VpnInstanceOpDataEntry> vpnInstanceOpDataEntryOptional =
2026             read(dataBroker, LogicalDatastoreType.OPERATIONAL, id);
2027         if (!vpnInstanceOpDataEntryOptional.isPresent()) {
2028             LOG.error("isBgpVpnInternet VPN {}."
2029                      + "VpnInstanceOpDataEntry not found", vpnName);
2030             return false;
2031         }
2032         LOG.debug("isBgpVpnInternet VPN {}."
2033              + "Successfully VpnInstanceOpDataEntry.getBgpvpnType {}",
2034              vpnName, vpnInstanceOpDataEntryOptional.get().getBgpvpnType());
2035         if (vpnInstanceOpDataEntryOptional.get().getBgpvpnType() == VpnInstanceOpDataEntry
2036                .BgpvpnType.BGPVPNInternet) {
2037             return true;
2038         }
2039         return false;
2040     }
2041
2042     /**Get IpVersionChoice from String IP like x.x.x.x or an representation IPv6.
2043      * @param ipAddress String of an representation IP address V4 or V6
2044      * @return the IpVersionChoice of the version or IpVersionChoice.UNDEFINED otherwise
2045      */
2046     public static IpVersionChoice getIpVersionFromString(String ipAddress) {
2047         IpVersionChoice ipchoice = IpVersionChoice.UNDEFINED;
2048         int indexIpAddress = ipAddress.indexOf('/');
2049         if (indexIpAddress >= 0) {
2050             ipAddress = ipAddress.substring(0, indexIpAddress);
2051         }
2052         try {
2053             InetAddress address = InetAddress.getByName(ipAddress);
2054             if (address instanceof Inet4Address) {
2055                 return IpVersionChoice.IPV4;
2056             } else if (address instanceof Inet6Address) {
2057                 return IpVersionChoice.IPV6;
2058             }
2059         } catch (UnknownHostException | SecurityException e) {
2060             ipchoice = IpVersionChoice.UNDEFINED;
2061         }
2062         return ipchoice;
2063     }
2064
2065     public static ListenableFuture<Void> unsetScheduledToRemoveForVpnInterface(ManagedNewTransactionRunner txRunner,
2066             String interfaceName) {
2067         VpnInterfaceBuilder builder = new VpnInterfaceBuilder().setKey(new VpnInterfaceKey(interfaceName))
2068                 .setScheduledForRemove(false);
2069         return txRunner.callWithNewWriteOnlyTransactionAndSubmit(tx -> tx.merge(LogicalDatastoreType.OPERATIONAL,
2070                 VpnUtil.getVpnInterfaceIdentifier(interfaceName), builder.build(),
2071                 WriteTransaction.CREATE_MISSING_PARENTS));
2072     }
2073
2074     /**
2075      * Adds router port for all elan network of type VLAN which is a part of vpnName in the DPN with dpnId.
2076      * This will create the vlan footprint in the DPN's which are member of the VPN.
2077      *
2078      * @param vpnName the vpnName
2079      * @param dpnId  the DPN id
2080      * @param dataBroker the data Broker
2081      */
2082     public static void addRouterPortToElanForVlanInDpn(String vpnName, BigInteger dpnId , DataBroker dataBroker) {
2083         Map<String,String> elanInstanceRouterPortMap = VpnUtil.getElanInstanceRouterPortMap(dataBroker, vpnName);
2084         for (Entry<String, String> elanInstanceRouterEntry : elanInstanceRouterPortMap.entrySet()) {
2085             addRouterPortToElanDpn(elanInstanceRouterEntry.getKey(), elanInstanceRouterEntry.getValue(),
2086                     vpnName, dpnId, dataBroker);
2087         }
2088     }
2089
2090     /**
2091      * Removes router port for all elan network of type VLAN which is a part of vpnName in the DPN with dpnId.
2092      * This will remove the  vlan footprint in all the DPN's which are member of the VPN.
2093      *
2094      * @param vpnName the vpn name
2095      * @param dpnId  the DPN id
2096      * @param dataBroker the data Broker
2097      */
2098     public static void removeRouterPortFromElanForVlanInDpn(String vpnName, BigInteger dpnId , DataBroker dataBroker) {
2099         Map<String,String> elanInstanceRouterPortMap = VpnUtil.getElanInstanceRouterPortMap(dataBroker, vpnName);
2100         for (Entry<String, String> elanInstanceRouterEntry : elanInstanceRouterPortMap.entrySet()) {
2101             removeRouterPortFromElanDpn(elanInstanceRouterEntry.getKey(), elanInstanceRouterEntry.getValue(),
2102                     vpnName, dpnId, dataBroker);
2103         }
2104     }
2105
2106     /**
2107      * Adds router port for all elan network of type VLAN which is a part of vpnName in all the DPN which has a port
2108      * This will create the vlan footprint in all the DPN's which are member of the VPN.
2109      *
2110      * @param vpnName the vpn name
2111      * @param dataBroker the data broker
2112      */
2113     public static void addRouterPortToElanDpnListForVlaninAllDpn(String vpnName, DataBroker dataBroker) {
2114         Map<String,String> elanInstanceRouterPortMap = getElanInstanceRouterPortMap(dataBroker, vpnName);
2115         Set<BigInteger> dpnList = getDpnInElan(dataBroker, elanInstanceRouterPortMap);
2116         for (BigInteger dpnId : dpnList) {
2117             for (Entry<String, String> elanInstanceRouterEntry : elanInstanceRouterPortMap.entrySet()) {
2118                 addRouterPortToElanDpn(elanInstanceRouterEntry.getKey(), elanInstanceRouterEntry.getValue(),
2119                         vpnName, dpnId, dataBroker);
2120             }
2121         }
2122     }
2123
2124     /**Removes router port for all elan network of type VLAN which is a part of vpnName in all the DPN which has a port
2125      * This will remove the vlan footprint in all the DPN's which are member of the VPN.
2126      *
2127      * @param routerInterfacePortId this will add the current subnet router port id to the map for removal
2128      * @param elanInstanceName the current elanstance being removed this will be added to map for removal
2129      * @param vpnName the vpn name
2130      * @param dataBroker the databroker
2131      */
2132     public static void removeRouterPortFromElanDpnListForVlanInAllDpn(String elanInstanceName,
2133             String routerInterfacePortId, String vpnName, DataBroker dataBroker) {
2134         Map<String,String> elanInstanceRouterPortMap = getElanInstanceRouterPortMap(dataBroker, vpnName);
2135         elanInstanceRouterPortMap.put(elanInstanceName, routerInterfacePortId);
2136         Set<BigInteger> dpnList = getDpnInElan(dataBroker, elanInstanceRouterPortMap);
2137         for (BigInteger dpnId : dpnList) {
2138             for (Entry<String, String> elanInstanceRouterEntry : elanInstanceRouterPortMap.entrySet()) {
2139                 removeRouterPortFromElanDpn(elanInstanceRouterEntry.getKey(), elanInstanceRouterEntry.getValue(),
2140                         vpnName, dpnId, dataBroker);
2141             }
2142         }
2143
2144     }
2145
2146     public static Set<BigInteger> getDpnInElan(DataBroker dataBroker,  Map<String,String> elanInstanceRouterPortMap) {
2147         Set<BigInteger> dpnIdSet = new HashSet<BigInteger>();
2148         for (String elanInstanceName : elanInstanceRouterPortMap.keySet()) {
2149             InstanceIdentifier<ElanDpnInterfacesList> elanDpnInterfaceId = getElanDpnOperationalDataPath(
2150                     elanInstanceName);
2151             Optional<ElanDpnInterfacesList> dpnInElanInterfaces = VpnUtil.read(dataBroker,
2152                     LogicalDatastoreType.OPERATIONAL, elanDpnInterfaceId);
2153             if (dpnInElanInterfaces.isPresent()) {
2154                 List<DpnInterfaces> dpnInterfaces = dpnInElanInterfaces.get().getDpnInterfaces();
2155                 for (DpnInterfaces dpnInterface : dpnInterfaces) {
2156                     dpnIdSet.add(dpnInterface.getDpId());
2157                 }
2158             }
2159         }
2160         return dpnIdSet;
2161     }
2162
2163     public static void addRouterPortToElanDpn(String elanInstanceName, String routerInterfacePortId, String vpnName,
2164             BigInteger dpnId, DataBroker dataBroker) {
2165         InstanceIdentifier<DpnInterfaces> elanDpnInterfaceId = getElanDpnInterfaceOperationalDataPath(
2166                 elanInstanceName,dpnId);
2167         Optional<DpnInterfaces> dpnInElanInterfaces = VpnUtil.read(dataBroker, LogicalDatastoreType.OPERATIONAL,
2168                 elanDpnInterfaceId);
2169         List<String> elanInterfaceList;
2170         DpnInterfaces dpnInterface;
2171         if (!dpnInElanInterfaces.isPresent()) {
2172             elanInterfaceList = new ArrayList<>();
2173         } else {
2174             dpnInterface = dpnInElanInterfaces.get();
2175             elanInterfaceList = dpnInterface.getInterfaces();
2176         }
2177         if (!elanInterfaceList.contains(routerInterfacePortId)) {
2178             elanInterfaceList.add(routerInterfacePortId);
2179             dpnInterface = new DpnInterfacesBuilder().setDpId(dpnId).setInterfaces(elanInterfaceList)
2180                     .setKey(new DpnInterfacesKey(dpnId)).build();
2181             VpnUtil.syncWrite(dataBroker, LogicalDatastoreType.OPERATIONAL,
2182                     elanDpnInterfaceId, dpnInterface);
2183         }
2184
2185     }
2186
2187     public static void removeRouterPortFromElanDpn(String elanInstanceName, String routerInterfacePortId,
2188             String vpnName, BigInteger dpnId, DataBroker dataBroker) {
2189         InstanceIdentifier<DpnInterfaces> elanDpnInterfaceId = getElanDpnInterfaceOperationalDataPath(
2190                 elanInstanceName,dpnId);
2191         Optional<DpnInterfaces> dpnInElanInterfaces = VpnUtil.read(dataBroker, LogicalDatastoreType.OPERATIONAL,
2192                 elanDpnInterfaceId);
2193         List<String> elanInterfaceList;
2194         DpnInterfaces dpnInterface;
2195         if (!dpnInElanInterfaces.isPresent()) {
2196             LOG.info("No interface in any dpn for {}", vpnName);
2197             return;
2198         } else {
2199             dpnInterface = dpnInElanInterfaces.get();
2200             elanInterfaceList = dpnInterface.getInterfaces();
2201         }
2202         if (!elanInterfaceList.contains(routerInterfacePortId)) {
2203             LOG.info("Router port not present in DPN {} for VPN {}", dpnId, vpnName);
2204             return;
2205         }
2206         elanInterfaceList.remove(routerInterfacePortId);
2207         dpnInterface = new DpnInterfacesBuilder().setDpId(dpnId).setInterfaces(elanInterfaceList)
2208                 .setKey(new DpnInterfacesKey(dpnId)).build();
2209         VpnUtil.syncWrite(dataBroker, LogicalDatastoreType.OPERATIONAL,
2210                 elanDpnInterfaceId, dpnInterface);
2211
2212     }
2213
2214     public static ElanInterface getElanInterfaceByElanInterfaceName(DataBroker broker, String elanInterfaceName) {
2215         InstanceIdentifier<ElanInterface> elanInterfaceId = getElanInterfaceConfigurationDataPathId(elanInterfaceName);
2216         return read(broker, LogicalDatastoreType.CONFIGURATION, elanInterfaceId).orNull();
2217     }
2218
2219     public static InstanceIdentifier<ElanInterface> getElanInterfaceConfigurationDataPathId(String interfaceName) {
2220         return InstanceIdentifier.builder(ElanInterfaces.class)
2221                 .child(ElanInterface.class, new ElanInterfaceKey(interfaceName)).build();
2222     }
2223
2224     public static Optional<Interface> getInterface(DataBroker broker, String interfaceName) {
2225         return read(broker, LogicalDatastoreType.CONFIGURATION, getInterfaceIdentifier(interfaceName));
2226     }
2227
2228     public static DpnInterfaces getElanInterfaceInfoByElanDpn(DataBroker broker, String elanInstanceName,
2229             BigInteger dpId) {
2230         InstanceIdentifier<DpnInterfaces> elanDpnInterfacesId = getElanDpnInterfaceOperationalDataPath(elanInstanceName,
2231                 dpId);
2232         return read(broker, LogicalDatastoreType.OPERATIONAL, elanDpnInterfacesId).orNull();
2233     }
2234
2235     public static String getExternalElanInterface(DataBroker broker, String elanInstanceName, BigInteger dpnId,
2236             IInterfaceManager interfaceManager) {
2237         DpnInterfaces dpnInterfaces = getElanInterfaceInfoByElanDpn(broker, elanInstanceName, dpnId);
2238         if (dpnInterfaces == null || dpnInterfaces.getInterfaces() == null) {
2239             LOG.info("Elan {} does not have interfaces in DPN {}", elanInstanceName, dpnId);
2240             return null;
2241         }
2242
2243         for (String dpnInterface : dpnInterfaces.getInterfaces()) {
2244             if (interfaceManager.isExternalInterface(dpnInterface)) {
2245                 return dpnInterface;
2246             }
2247         }
2248         return null;
2249     }
2250
2251     public static boolean isVlan(ElanInstance elanInstance) {
2252         return elanInstance != null && elanInstance.getSegmentType() != null
2253                 && elanInstance.getSegmentType().isAssignableFrom(SegmentTypeVlan.class)
2254                 && elanInstance.getSegmentationId() != null && elanInstance.getSegmentationId() != 0;
2255     }
2256
2257     public static boolean isVlan(DataBroker databroker , String interfaceName) {
2258         ElanInterface elanInterface = getElanInterfaceByElanInterfaceName(databroker, interfaceName);
2259         if (elanInterface == null) {
2260             return false;
2261         }
2262         ElanInstance  elanInstance = getElanInstanceByName(databroker, elanInterface.getElanInstanceName());
2263         return isVlan(elanInstance);
2264     }
2265
2266     public static ElanInstance getElanInstanceByName(DataBroker broker, String elanInstanceName) {
2267         InstanceIdentifier<ElanInstance> elanIdentifierId =
2268                 ElanHelper.getElanInstanceConfigurationDataPath(elanInstanceName);
2269         return read(broker, LogicalDatastoreType.CONFIGURATION, elanIdentifierId).orNull();
2270     }
2271
2272     public static String getVpnNameFromElanIntanceName(DataBroker dataBroker, String elanInstanceName) {
2273         Optional<Subnetmaps> subnetMapsData =
2274                 read(dataBroker, LogicalDatastoreType.CONFIGURATION, buildSubnetMapsWildCardPath());
2275         if (subnetMapsData.isPresent()) {
2276             List<Subnetmap> subnetMapList = subnetMapsData.get().getSubnetmap();
2277             if (subnetMapList != null && !subnetMapList.isEmpty()) {
2278                 for (Subnetmap subnet : subnetMapList) {
2279                     if (subnet.getNetworkId().getValue().equals(elanInstanceName)) {
2280                         if (subnet.getVpnId() != null) {
2281                             return subnet.getVpnId().getValue();
2282                         }
2283                     }
2284                 }
2285             }
2286         }
2287         return null;
2288     }
2289
2290     public static Map<String, String> getElanInstanceRouterPortMap(DataBroker dataBroker, String vpnName) {
2291         Map<String, String> elanInstanceRouterPortMap = new HashMap<String, String>();
2292         Optional<Subnetmaps> subnetMapsData =
2293                 read(dataBroker, LogicalDatastoreType.CONFIGURATION, buildSubnetMapsWildCardPath());
2294         if (subnetMapsData.isPresent()) {
2295             List<Subnetmap> subnetMapList = subnetMapsData.get().getSubnetmap();
2296             if (subnetMapList != null && !subnetMapList.isEmpty()) {
2297                 for (Subnetmap subnet : subnetMapList) {
2298                     if (subnet.getVpnId() != null && subnet.getVpnId().getValue().equals(vpnName)
2299                             && subnet.getNetworkType().equals(NetworkType.VLAN)) {
2300                         if (subnet.getRouterInterfacePortId() == null || subnet.getNetworkId() == null) {
2301                             LOG.warn("The RouterInterfacePortId or NetworkId is null");
2302                             continue;
2303                         }
2304                         String routerInterfacePortUuid = subnet.getRouterInterfacePortId().getValue();
2305                         if (routerInterfacePortUuid != null && !routerInterfacePortUuid.isEmpty()) {
2306                             elanInstanceRouterPortMap.put(subnet.getNetworkId().getValue(),routerInterfacePortUuid);
2307                         }
2308                     }
2309                 }
2310             }
2311         }
2312         return elanInstanceRouterPortMap;
2313     }
2314
2315     public static String getRouterPordIdFromElanInstance(DataBroker dataBroker, String elanInstanceName) {
2316         Optional<Subnetmaps> subnetMapsData =
2317                 read(dataBroker, LogicalDatastoreType.CONFIGURATION, buildSubnetMapsWildCardPath());
2318         if (subnetMapsData.isPresent()) {
2319             List<Subnetmap> subnetMapList = subnetMapsData.get().getSubnetmap();
2320             if (subnetMapList != null && !subnetMapList.isEmpty()) {
2321                 for (Subnetmap subnet : subnetMapList) {
2322                     if (subnet.getNetworkId().getValue().equals(elanInstanceName)) {
2323                         if (subnet.getRouterInterfacePortId() != null) {
2324                             return subnet.getRouterInterfacePortId().getValue();
2325                         }
2326                     }
2327                 }
2328             }
2329         }
2330         return null;
2331     }
2332
2333     public static boolean shouldPopulateFibForVlan(DataBroker dataBroker, String vpnName, String elanInstanceName,
2334             BigInteger dpnId, IInterfaceManager interfaceManager) {
2335         Map<String,String> elanInstanceRouterPortMap = VpnUtil
2336                 .getElanInstanceRouterPortMap(dataBroker, vpnName);
2337         boolean shouldPopulateFibForVlan = false;
2338         if (!elanInstanceRouterPortMap.isEmpty()) {
2339             shouldPopulateFibForVlan = true;
2340         }
2341         for (Entry<String, String> elanInstanceRouterEntry : elanInstanceRouterPortMap
2342                 .entrySet()) {
2343             String currentElanInstance = elanInstanceRouterEntry.getKey();
2344             if (elanInstanceName != null && elanInstanceName.equals(currentElanInstance)) {
2345                 continue;
2346             }
2347             String externalinterface = VpnUtil.getExternalElanInterface(dataBroker,
2348                     currentElanInstance ,dpnId,
2349                     interfaceManager);
2350             if (externalinterface == null) {
2351                 shouldPopulateFibForVlan = false;
2352                 break;
2353             }
2354         }
2355         return shouldPopulateFibForVlan;
2356     }
2357
2358     public static InstanceIdentifier<DpnInterfaces> getElanDpnInterfaceOperationalDataPath(String elanInstanceName,
2359             BigInteger dpId) {
2360         return InstanceIdentifier.builder(ElanDpnInterfaces.class)
2361                 .child(ElanDpnInterfacesList.class, new ElanDpnInterfacesListKey(elanInstanceName))
2362                 .child(DpnInterfaces.class, new DpnInterfacesKey(dpId)).build();
2363     }
2364
2365     public static InstanceIdentifier<ElanDpnInterfacesList> getElanDpnOperationalDataPath(String elanInstanceName) {
2366         return InstanceIdentifier.builder(ElanDpnInterfaces.class)
2367                 .child(ElanDpnInterfacesList.class, new ElanDpnInterfacesListKey(elanInstanceName))
2368                 .build();
2369     }
2370
2371     public static boolean isMatchedPrefixToInterface(Prefixes prefix, VpnInterfaceOpDataEntry vpnInterface) {
2372         if (prefix != null && vpnInterface != null) {
2373             if (prefix.getDpnId() != null && vpnInterface.getDpnId() != null) {
2374                 if (prefix.getVpnInterfaceName() != null && vpnInterface.getName() != null) {
2375                     return prefix.getDpnId().equals(vpnInterface.getDpnId())
2376                             && prefix.getVpnInterfaceName().equalsIgnoreCase(vpnInterface.getName());
2377                 }
2378             }
2379         }
2380         return false;
2381     }
2382
2383     public static void removePrefixToInterfaceAdj(DataBroker dataBroker, Adjacency adj, long vpnId,
2384                                                   VpnInterfaceOpDataEntry vpnInterfaceOpDataEntry,
2385                                                   WriteTransaction writeOperTxn) {
2386         Optional<Prefixes> prefix = VpnUtil.read(dataBroker, LogicalDatastoreType.OPERATIONAL,
2387                 VpnUtil.getPrefixToInterfaceIdentifier(vpnId,
2388                         VpnUtil.getIpPrefix(adj.getIpAddress())));
2389         List<Prefixes> prefixToInterface = new ArrayList<>();
2390         List<Prefixes> prefixToInterfaceLocal = new ArrayList<>();
2391         if (prefix.isPresent()) {
2392             prefixToInterfaceLocal.add(prefix.get());
2393         }
2394         if (prefixToInterfaceLocal.isEmpty()) {
2395             for (String nh : adj.getNextHopIpList()) {
2396                 prefix = VpnUtil.read(dataBroker, LogicalDatastoreType.OPERATIONAL,
2397                         VpnUtil.getPrefixToInterfaceIdentifier(vpnId,
2398                                 VpnUtil.getIpPrefix(nh)));
2399                 if (prefix.isPresent()) {
2400                     prefixToInterfaceLocal.add(prefix.get());
2401                 }
2402             }
2403         }
2404         if (!prefixToInterfaceLocal.isEmpty()) {
2405             prefixToInterface.addAll(prefixToInterfaceLocal);
2406         }
2407         for (Prefixes pref : prefixToInterface) {
2408             if (VpnUtil.isMatchedPrefixToInterface(pref, vpnInterfaceOpDataEntry)) {
2409                 if (writeOperTxn != null) {
2410                     writeOperTxn.delete(LogicalDatastoreType.OPERATIONAL,
2411                             VpnUtil.getPrefixToInterfaceIdentifier(vpnId, pref.getIpAddress()));
2412                 } else {
2413                     VpnUtil.delete(dataBroker, LogicalDatastoreType.OPERATIONAL,
2414                             VpnUtil.getPrefixToInterfaceIdentifier(vpnId, pref.getIpAddress()),
2415                             VpnUtil.DEFAULT_CALLBACK);
2416                 }
2417             }
2418         }
2419     }
2420 }