vpnservice/vpnmanager/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.util.concurrent.FutureCallback;
  13 import com.google.common.util.concurrent.Futures;
  14 import com.google.common.util.concurrent.ListenableFuture;
  15
  16 import java.math.BigInteger;
  17 import java.text.SimpleDateFormat;
  18 import java.util.ArrayList;
  19 import java.util.Collections;
  20 import java.util.Date;
  21 import java.util.List;
  22 import java.util.concurrent.ExecutionException;
  23 import java.util.concurrent.Future;
  24 import java.util.stream.Collectors;
  25
  26 import javax.annotation.Nullable;
  27 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  28 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  29 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  30 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipService;
  31 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  32 import org.opendaylight.genius.datastoreutils.DataStoreJobCoordinator;
  33 import org.opendaylight.genius.mdsalutil.FlowEntity;
  34 import org.opendaylight.genius.mdsalutil.FlowEntityBuilder;
  35 import org.opendaylight.genius.mdsalutil.InstructionInfo;
  36 import org.opendaylight.genius.mdsalutil.MDSALUtil;
  37 import org.opendaylight.genius.mdsalutil.MatchInfo;
  38 import org.opendaylight.genius.mdsalutil.MetaDataUtil;
  39 import org.opendaylight.genius.mdsalutil.NWUtil;
  40 import org.opendaylight.genius.mdsalutil.NwConstants;
  41 import org.opendaylight.genius.mdsalutil.actions.ActionRegLoad;
  42 import org.opendaylight.genius.mdsalutil.instructions.InstructionGotoTable;
  43 import org.opendaylight.genius.mdsalutil.instructions.InstructionWriteMetadata;
  44 import org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager;
  45 import org.opendaylight.genius.mdsalutil.matches.MatchEthernetDestination;
  46 import org.opendaylight.genius.mdsalutil.matches.MatchMetadata;
  47 import org.opendaylight.genius.utils.ServiceIndex;
  48 import org.opendaylight.genius.utils.cache.DataStoreCache;
  49 import org.opendaylight.genius.utils.clustering.ClusteringUtils;
  50 import org.opendaylight.netvirt.bgpmanager.api.IBgpManager;
  51 import org.opendaylight.netvirt.fibmanager.api.RouteOrigin;
  52 import org.opendaylight.netvirt.neutronvpn.interfaces.INeutronVpnManager;
  53 import org.opendaylight.netvirt.vpnmanager.api.VpnExtraRouteHelper;
  54 import org.opendaylight.netvirt.vpnmanager.utilities.InterfaceUtils;
  55 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnAfConfig;
  56 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnInstances;
  57 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnInterfaces;
  58 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.instances.VpnInstance;
  59 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.instances.VpnInstanceKey;
  60 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.VpnInterface;
  61 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.VpnInterfaceBuilder;
  62 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.VpnInterfaceKey;
  63 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  64 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.Interfaces;
  65 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
  66 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
  67 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress;
  68 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress;
  69 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid;
  70 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.Action;
  71 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction;
  72 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdInput;
  73 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdInputBuilder;
  74 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdOutput;
  75 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService;
  76 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdPools;
  77 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdInput;
  78 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdInputBuilder;
  79 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.id.pools.IdPool;
  80 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.id.pools.IdPoolKey;
  81 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406.IfIndexesInterfaceMap;
  82 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406._if.indexes._interface.map.IfIndexInterface;
  83 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406._if.indexes._interface.map.IfIndexInterfaceKey;
  84 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.GetInterfaceFromIfIndexInput;
  85 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.GetInterfaceFromIfIndexInputBuilder;
  86 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.GetInterfaceFromIfIndexOutput;
  87 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.OdlInterfaceRpcService;
  88 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.services.info.BoundServices;
  89 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.LockManagerService;
  90 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.TimeUnits;
  91 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.TryLockInput;
  92 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.TryLockInputBuilder;
  93 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.UnlockInput;
  94 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.UnlockInputBuilder;
  95 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.ElanTagNameMap;
  96 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.tag.name.map.ElanTagName;
  97 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.tag.name.map.ElanTagNameKey;
  98 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.FibEntries;
  99 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.VrfEntryBase;
 100 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.extraroute.rds.map.extraroute.rds.dest.prefixes.AllocatedRdsBuilder;
 101 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.extraroute.rds.map.extraroute.rds.dest.prefixes.AllocatedRdsKey;
 102 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.fibentries.VrfTables;
 103 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.fibentries.VrfTablesKey;
 104 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.vrfentries.VrfEntry;
 105 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.vrfentries.VrfEntryKey;
 106 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3nexthop.rev150409.L3nexthop;
 107 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3nexthop.rev150409.l3nexthop.VpnNexthops;
 108 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3nexthop.rev150409.l3nexthop.VpnNexthopsKey;
 109 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.Adjacencies;
 110 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.AdjacenciesBuilder;
 111 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.LearntVpnVipToPortData;
 112 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.PrefixToInterface;
 113 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.RouterInterfaces;
 114 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.SubnetOpData;
 115 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnIdToVpnInstance;
 116 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnInstanceOpData;
 117 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnInstanceToVpnId;
 118 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnToExtraroutes;
 119 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.adjacency.list.Adjacency;
 120 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.adjacency.list.AdjacencyKey;
 121 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.data.LearntVpnVipToPort;
 122 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.data.LearntVpnVipToPortBuilder;
 123 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.data.LearntVpnVipToPortKey;
 124 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.prefix.to._interface.VpnIds;
 125 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.prefix.to._interface.VpnIdsBuilder;
 126 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.prefix.to._interface.VpnIdsKey;
 127 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.prefix.to._interface.vpn.ids.Prefixes;
 128 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.prefix.to._interface.vpn.ids.PrefixesBuilder;
 129 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.prefix.to._interface.vpn.ids.PrefixesKey;
 130 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.router.interfaces.RouterInterface;
 131 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.router.interfaces.RouterInterfaceBuilder;
 132 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.router.interfaces.RouterInterfaceKey;
 133 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.subnet.op.data.SubnetOpDataEntry;
 134 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.subnet.op.data.SubnetOpDataEntryKey;
 135 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntry;
 136 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntryKey;
 137 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.VpnToDpnList;
 138 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.VpnToDpnListKey;
 139 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstanceBuilder;
 140 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.to.extraroutes.Vpn;
 141 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.to.extraroutes.VpnKey;
 142 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.to.extraroutes.vpn.extra.routes.Routes;
 143 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.to.extraroutes.vpn.extra.routes.RoutesBuilder;
 144 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ExtRouters;
 145 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ExternalNetworks;
 146 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ExternalSubnets;
 147 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.NaptSwitches;
 148 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext.routers.Routers;
 149 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext.routers.RoutersKey;
 150 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext.routers.routers.ExternalIps;
 151 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.networks.Networks;
 152 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.networks.NetworksKey;
 153 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets.SubnetsKey;
 154 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.napt.switches.RouterToNaptSwitch;
 155 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.napt.switches.RouterToNaptSwitchKey;
 156 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.NetworkMaps;
 157 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.NeutronVpnPortipPortData;
 158 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.RouterInterfacesMap;
 159 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.Subnetmaps;
 160 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.networkmaps.NetworkMap;
 161 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.networkmaps.NetworkMapKey;
 162 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.neutron.vpn.portip.port.data.VpnPortipToPort;
 163 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.neutron.vpn.portip.port.data.VpnPortipToPortKey;
 164 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.subnetmaps.Subnetmap;
 165 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.subnetmaps.SubnetmapKey;
 166 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.constants.rev150712.IpVersionBase;
 167 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.constants.rev150712.IpVersionV4;
 168 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.ext.rev150712.NetworkL3Extension;
 169 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.Network;
 170 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.NetworkKey;
 171 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.ports.Port;
 172 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.rev150712.Neutron;
 173 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.Subnets;
 174 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.Subnet;
 175 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.SubnetKey;
 176 import org.opendaylight.yangtools.yang.binding.DataObject;
 177 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
 178 import org.opendaylight.yangtools.yang.common.RpcResult;
 179 import org.opendaylight.yangtools.yang.data.impl.schema.tree.SchemaValidationFailedException;
 180 import org.slf4j.Logger;
 181 import org.slf4j.LoggerFactory;
 182
 183 public final class VpnUtil {
 184     private static final Logger LOG = LoggerFactory.getLogger(VpnUtil.class);
 185     private static final int DEFAULT_PREFIX_LENGTH = 32;
 186     private static final String PREFIX_SEPARATOR = "/";
 187
 188     private VpnUtil() {
 189     }
 190
 191     static InstanceIdentifier<VpnInterface> getVpnInterfaceIdentifier(String vpnInterfaceName) {
 192         return InstanceIdentifier.builder(VpnInterfaces.class)
 193             .child(VpnInterface.class, new VpnInterfaceKey(vpnInterfaceName)).build();
 194     }
 195
 196     static InstanceIdentifier<VpnInstance> getVpnInstanceIdentifier(String vpnName) {
 197         return InstanceIdentifier.builder(VpnInstances.class)
 198             .child(VpnInstance.class, new VpnInstanceKey(vpnName)).build();
 199     }
 200
 201     static VpnInterface getVpnInterface(DataBroker broker, String vpnInterfaceName) {
 202         InstanceIdentifier<VpnInterface> id = getVpnInterfaceIdentifier(vpnInterfaceName);
 203         Optional<VpnInterface> vpnInterface = read(broker, LogicalDatastoreType.CONFIGURATION, id);
 204         return vpnInterface.isPresent() ? vpnInterface.get() : null;
 205     }
 206
 207     static VpnInterface getVpnInterface(String intfName, String vpnName, Adjacencies aug, BigInteger dpnId,
 208         Boolean isSheduledForRemove) {
 209         return new VpnInterfaceBuilder().setKey(new VpnInterfaceKey(intfName)).setVpnInstanceName(vpnName).setDpnId(
 210             dpnId)
 211             .setScheduledForRemove(isSheduledForRemove).addAugmentation(Adjacencies.class, aug)
 212             .build();
 213     }
 214
 215     static InstanceIdentifier<Prefixes> getPrefixToInterfaceIdentifier(long vpnId, String ipPrefix) {
 216         return InstanceIdentifier.builder(PrefixToInterface.class)
 217             .child(VpnIds.class, new VpnIdsKey(vpnId)).child(Prefixes.class,
 218                 new PrefixesKey(ipPrefix)).build();
 219     }
 220
 221     public static InstanceIdentifier<VpnIds> getPrefixToInterfaceIdentifier(long vpnId) {
 222         return InstanceIdentifier.builder(PrefixToInterface.class)
 223             .child(VpnIds.class, new VpnIdsKey(vpnId)).build();
 224     }
 225
 226     static VpnIds getPrefixToInterface(long vpnId) {
 227         return new VpnIdsBuilder().setKey(new VpnIdsKey(vpnId)).setVpnId(vpnId).build();
 228     }
 229
 230     static Prefixes getPrefixToInterface(BigInteger dpId, String vpnInterfaceName, String ipPrefix, Uuid subnetId,
 231             Prefixes.PrefixCue prefixCue) {
 232         return new PrefixesBuilder().setDpnId(dpId).setVpnInterfaceName(
 233             vpnInterfaceName).setIpAddress(ipPrefix).setSubnetId(subnetId).setPrefixCue(prefixCue).build();
 234     }
 235
 236     static Optional<Prefixes> getPrefixToInterface(DataBroker broker, long vpnId, String ipPrefix) {
 237         return read(broker, LogicalDatastoreType.OPERATIONAL,
 238                 getPrefixToInterfaceIdentifier(vpnId, getIpPrefix(ipPrefix)));
 239     }
 240
 241     /**
 242      * Get VRF table given a Route Distinguisher.
 243      *
 244      * @param broker dataBroker service reference
 245      * @param rd Route-Distinguisher
 246      * @return VrfTables that holds the list of VrfEntries of the specified rd
 247      */
 248     public static VrfTables getVrfTable(DataBroker broker, String rd) {
 249         InstanceIdentifier<VrfTables> id =
 250             InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class, new VrfTablesKey(rd)).build();
 251         Optional<VrfTables> vrfTable = read(broker, LogicalDatastoreType.CONFIGURATION, id);
 252         return vrfTable.isPresent() ? vrfTable.get() : null;
 253     }
 254
 255     /**
 256      * Retrieves the VrfEntries that belong to a given VPN filtered out by
 257      * Origin, searching by its Route-Distinguisher.
 258      *
 259      * @param broker dataBroker service reference
 260      * @param rd Route-distinguisher of the VPN
 261      * @param originsToConsider Only entries whose origin is included in this list will be considered
 262      * @return the list of VrfEntries
 263      */
 264     public static List<VrfEntry> getVrfEntriesByOrigin(DataBroker broker, String rd,
 265         List<RouteOrigin> originsToConsider) {
 266         List<VrfEntry> result = new ArrayList<>();
 267         List<VrfEntry> allVpnVrfEntries = getAllVrfEntries(broker, rd);
 268         for (VrfEntry vrfEntry : allVpnVrfEntries) {
 269             if (originsToConsider.contains(RouteOrigin.value(vrfEntry.getOrigin()))) {
 270                 result.add(vrfEntry);
 271             }
 272         }
 273         return result;
 274     }
 275
 276     static List<Prefixes> getAllPrefixesToInterface(DataBroker broker, long vpnId) {
 277         Optional<VpnIds> vpnIds = read(broker, LogicalDatastoreType.OPERATIONAL, getPrefixToInterfaceIdentifier(vpnId));
 278         if (vpnIds.isPresent()) {
 279             return vpnIds.get().getPrefixes();
 280         }
 281         return new ArrayList<>();
 282     }
 283
 284     /**
 285      * Retrieves all the VrfEntries that belong to a given VPN searching by its
 286      * Route-Distinguisher.
 287      *
 288      * @param broker dataBroker service reference
 289      * @param rd Route-distinguisher of the VPN
 290      * @return the list of VrfEntries
 291      */
 292     public static List<VrfEntry> getAllVrfEntries(DataBroker broker, String rd) {
 293         VrfTables vrfTables = VpnUtil.getVrfTable(broker, rd);
 294         return vrfTables != null ? vrfTables.getVrfEntry() : new ArrayList<>();
 295     }
 296
 297     //FIXME: Implement caches for DS reads
 298     public static VpnInstance getVpnInstance(DataBroker broker, String vpnInstanceName) {
 299         InstanceIdentifier<VpnInstance> id = InstanceIdentifier.builder(VpnInstances.class).child(VpnInstance.class,
 300             new VpnInstanceKey(vpnInstanceName)).build();
 301         Optional<VpnInstance> vpnInstance = read(broker, LogicalDatastoreType.CONFIGURATION, id);
 302         return vpnInstance.isPresent() ? vpnInstance.get() : null;
 303     }
 304
 305     static List<VpnInstanceOpDataEntry> getAllVpnInstanceOpData(DataBroker broker) {
 306         InstanceIdentifier<VpnInstanceOpData> id = InstanceIdentifier.builder(VpnInstanceOpData.class).build();
 307         Optional<VpnInstanceOpData> vpnInstanceOpDataOptional =
 308             VpnUtil.read(broker, LogicalDatastoreType.OPERATIONAL, id);
 309         if (vpnInstanceOpDataOptional.isPresent()) {
 310             return vpnInstanceOpDataOptional.get().getVpnInstanceOpDataEntry();
 311         } else {
 312             return new ArrayList<>();
 313         }
 314     }
 315
 316     public static List<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn
 317         .instance.op.data.entry.vpn.to.dpn.list.VpnInterfaces> getDpnVpnInterfaces(DataBroker broker,
 318         VpnInstance vpnInstance, BigInteger dpnId) {
 319         String primaryRd = getPrimaryRd(vpnInstance);
 320         InstanceIdentifier<VpnToDpnList> dpnToVpnId = getVpnToDpnListIdentifier(primaryRd, dpnId);
 321         Optional<VpnToDpnList> dpnInVpn = VpnUtil.read(broker, LogicalDatastoreType.OPERATIONAL, dpnToVpnId);
 322         return dpnInVpn.isPresent() ? dpnInVpn.get().getVpnInterfaces() : Collections.emptyList();
 323     }
 324
 325     public static List<String> getListOfRdsFromVpnInstance(VpnInstance vpnInstance) {
 326         VpnAfConfig vpnConfig = vpnInstance.getIpv4Family();
 327         LOG.trace("vpnConfig {}", vpnConfig);
 328         return vpnConfig.getRouteDistinguisher() != null ? new ArrayList<>(
 329                 vpnConfig.getRouteDistinguisher()) : new ArrayList<>();
 330     }
 331
 332     static VrfEntry getVrfEntry(DataBroker broker, String rd, String ipPrefix) {
 333
 334         VrfTables vrfTable = getVrfTable(broker, rd);
 335         // TODO: why check VrfTables if we later go for the specific VrfEntry?
 336         if (vrfTable != null) {
 337             InstanceIdentifier<VrfEntry> vrfEntryId =
 338                 InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class, new VrfTablesKey(rd)).child(
 339                     VrfEntry.class, new VrfEntryKey(ipPrefix)).build();
 340             Optional<VrfEntry> vrfEntry = read(broker, LogicalDatastoreType.CONFIGURATION, vrfEntryId);
 341             if (vrfEntry.isPresent()) {
 342                 return vrfEntry.get();
 343             }
 344         }
 345         return null;
 346     }
 347
 348     static List<Adjacency> getAdjacenciesForVpnInterfaceFromConfig(DataBroker broker, String intfName) {
 349         final InstanceIdentifier<VpnInterface> identifier = getVpnInterfaceIdentifier(intfName);
 350         InstanceIdentifier<Adjacencies> path = identifier.augmentation(Adjacencies.class);
 351         Optional<Adjacencies> adjacencies = VpnUtil.read(broker, LogicalDatastoreType.CONFIGURATION, path);
 352
 353         if (adjacencies.isPresent()) {
 354             List<Adjacency> nextHops = adjacencies.get().getAdjacency();
 355             return nextHops;
 356         }
 357         return null;
 358     }
 359
 360     static  Routes getVpnToExtraroute(String ipPrefix, List<String> nextHopList) {
 361         return new RoutesBuilder().setPrefix(ipPrefix).setNexthopIpList(nextHopList).build();
 362     }
 363
 364     static String getVpnInterfaceName(OdlInterfaceRpcService odlInterfaceRpcService, BigInteger metadata)
 365             throws InterruptedException, ExecutionException {
 366         GetInterfaceFromIfIndexInputBuilder ifIndexInputBuilder = new GetInterfaceFromIfIndexInputBuilder();
 367         BigInteger lportTag = MetaDataUtil.getLportFromMetadata(metadata);
 368         ifIndexInputBuilder.setIfIndex(lportTag.intValue());
 369         GetInterfaceFromIfIndexInput input = ifIndexInputBuilder.build();
 370         Future<RpcResult<GetInterfaceFromIfIndexOutput>> interfaceFromIfIndex =
 371                 odlInterfaceRpcService.getInterfaceFromIfIndex(input);
 372         GetInterfaceFromIfIndexOutput interfaceFromIfIndexOutput;
 373         RpcResult<GetInterfaceFromIfIndexOutput> rpcResult = interfaceFromIfIndex.get();
 374         if (rpcResult == null) {
 375             return null;
 376         }
 377         interfaceFromIfIndexOutput = rpcResult.getResult();
 378         return interfaceFromIfIndexOutput.getInterfaceName();
 379     }
 380
 381     static AllocatedRdsBuilder getRdsBuilder(String nexthop, String rd) {
 382         return new AllocatedRdsBuilder().setKey(new AllocatedRdsKey(nexthop)).setNexthop(nexthop).setRd(rd);
 383     }
 384
 385     static Adjacencies getVpnInterfaceAugmentation(List<Adjacency> nextHopList) {
 386         return new AdjacenciesBuilder().setAdjacency(nextHopList).build();
 387     }
 388
 389     public static InstanceIdentifier<IdPool> getPoolId(String poolName) {
 390         InstanceIdentifier.InstanceIdentifierBuilder<IdPool> idBuilder =
 391             InstanceIdentifier.builder(IdPools.class).child(IdPool.class, new IdPoolKey(poolName));
 392         return idBuilder.build();
 393     }
 394
 395     static InstanceIdentifier<VpnInterfaces> getVpnInterfacesIdentifier() {
 396         return InstanceIdentifier.builder(VpnInterfaces.class).build();
 397     }
 398
 399     static InstanceIdentifier<Interface> getInterfaceIdentifier(String interfaceName) {
 400         return InstanceIdentifier.builder(Interfaces.class)
 401             .child(Interface.class, new InterfaceKey(interfaceName)).build();
 402     }
 403
 404     static InstanceIdentifier<VpnToDpnList> getVpnToDpnListIdentifier(String rd, BigInteger dpnId) {
 405         return InstanceIdentifier.builder(VpnInstanceOpData.class)
 406             .child(VpnInstanceOpDataEntry.class, new VpnInstanceOpDataEntryKey(rd))
 407             .child(VpnToDpnList.class, new VpnToDpnListKey(dpnId)).build();
 408     }
 409
 410     public static BigInteger getCookieArpFlow(int interfaceTag) {
 411         return VpnConstants.COOKIE_L3_BASE.add(new BigInteger("0110000", 16)).add(
 412             BigInteger.valueOf(interfaceTag));
 413     }
 414
 415     public static BigInteger getCookieL3(int vpnId) {
 416         return VpnConstants.COOKIE_L3_BASE.add(new BigInteger("0610000", 16)).add(BigInteger.valueOf(vpnId));
 417     }
 418
 419     public static String getFlowRef(BigInteger dpnId, short tableId, int ethType, int lportTag, int arpType) {
 420         return new StringBuffer().append(VpnConstants.FLOWID_PREFIX).append(dpnId).append(NwConstants.FLOWID_SEPARATOR)
 421             .append(tableId).append(NwConstants.FLOWID_SEPARATOR).append(ethType).append(lportTag)
 422             .append(NwConstants.FLOWID_SEPARATOR).append(arpType).toString();
 423     }
 424
 425     public static int getUniqueId(IdManagerService idManager, String poolName, String idKey) {
 426         AllocateIdInput getIdInput = new AllocateIdInputBuilder().setPoolName(poolName).setIdKey(idKey).build();
 427
 428         try {
 429             Future<RpcResult<AllocateIdOutput>> result = idManager.allocateId(getIdInput);
 430             RpcResult<AllocateIdOutput> rpcResult = result.get();
 431             if (rpcResult.isSuccessful()) {
 432                 return rpcResult.getResult().getIdValue().intValue();
 433             } else {
 434                 LOG.error("getUniqueId: RPC Call to Get Unique Id from pool {} with key {} returned with Errors {}",
 435                         poolName, idKey, rpcResult.getErrors());
 436             }
 437         } catch (InterruptedException | ExecutionException e) {
 438             LOG.error("getUniqueId: Exception when getting Unique Id from pool {} for key {}", poolName, idKey, e);
 439         }
 440         return 0;
 441     }
 442
 443     public static void releaseId(IdManagerService idManager, String poolName, String idKey) {
 444         ReleaseIdInput idInput = new ReleaseIdInputBuilder().setPoolName(poolName).setIdKey(idKey).build();
 445         try {
 446             Future<RpcResult<Void>> result = idManager.releaseId(idInput);
 447             RpcResult<Void> rpcResult = result.get();
 448             if (!rpcResult.isSuccessful()) {
 449                 LOG.error("releaseId: RPC Call to release Id for key {} from pool {} returned with Errors {}",
 450                         idKey, poolName, rpcResult.getErrors());
 451             }
 452         } catch (InterruptedException | ExecutionException e) {
 453             LOG.error("releaseId: Exception when releasing Id for key {} from pool {}", idKey, poolName, e);
 454         }
 455     }
 456
 457     public static String getNextHopLabelKey(String rd, String prefix) {
 458         return rd + VpnConstants.SEPARATOR + prefix;
 459     }
 460
 461     /**
 462      * Retrieves the VpnInstance name (typically the VPN Uuid) out from the
 463      * route-distinguisher.
 464      *
 465      * @param broker dataBroker service reference
 466      * @param rd Route-Distinguisher
 467      * @return the VpnInstance name
 468      */
 469     public static String getVpnNameFromRd(DataBroker broker, String rd) {
 470         VpnInstanceOpDataEntry vpnInstanceOpData = getVpnInstanceOpData(broker, rd);
 471         return vpnInstanceOpData != null ? vpnInstanceOpData.getVpnInstanceName() : null;
 472     }
 473
 474     /**
 475      * Retrieves the dataplane identifier of a specific VPN, searching by its
 476      * VpnInstance name.
 477      *
 478      * @param broker dataBroker service reference
 479      * @param vpnName Name of the VPN
 480      * @return the dataplane identifier of the VPN, the VrfTag.
 481      */
 482     public static long getVpnId(DataBroker broker, String vpnName) {
 483
 484         Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id
 485                     .VpnInstance> vpnInstance =
 486             read(broker, LogicalDatastoreType.CONFIGURATION, VpnOperDsUtils.getVpnInstanceToVpnIdIdentifier(vpnName));
 487
 488         long vpnId = VpnConstants.INVALID_ID;
 489         if (vpnInstance.isPresent()) {
 490             vpnId = vpnInstance.get().getVpnId();
 491         }
 492         return vpnId;
 493     }
 494
 495     public static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance
 496                         .to.vpn.id.VpnInstance> getVpnInstanceToVpnIdIdentifier(
 497             String vpnName) {
 498         return InstanceIdentifier.builder(VpnInstanceToVpnId.class)
 499                 .child(org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id
 500                           .VpnInstance.class,
 501                         new org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn
 502                                .id.VpnInstanceKey(
 503                                 vpnName))
 504                 .build();
 505     }
 506
 507     /**
 508      * Retrieves the VPN Route Distinguisher searching by its Vpn instance name.
 509      *
 510      * @param broker dataBroker service reference
 511      * @param vpnName Name of the VPN
 512      * @return the route-distinguisher of the VPN
 513      */
 514     public static String getVpnRd(DataBroker broker, String vpnName) {
 515         Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id
 516             .VpnInstance>
 517             vpnInstance
 518             = read(broker, LogicalDatastoreType.CONFIGURATION, VpnOperDsUtils.getVpnInstanceToVpnIdIdentifier(vpnName));
 519
 520         String rd = null;
 521         if (vpnInstance.isPresent()) {
 522             rd = vpnInstance.get().getVrfId();
 523         }
 524         return rd;
 525     }
 526
 527     private static List<String> getVpnRdsFromVpnInstanceConfig(DataBroker broker, String vpnName) {
 528         InstanceIdentifier<VpnInstance> id = InstanceIdentifier.builder(VpnInstances.class)
 529             .child(VpnInstance.class, new VpnInstanceKey(vpnName)).build();
 530         Optional<VpnInstance> vpnInstance = VpnUtil.read(broker, LogicalDatastoreType.CONFIGURATION, id);
 531         return vpnInstance.isPresent() ? getListOfRdsFromVpnInstance(vpnInstance.get()) : new ArrayList<>();
 532     }
 533
 534     /**
 535      * Remove from MDSAL all those VrfEntries in a VPN that have an specific RouteOrigin.
 536      *
 537      * @param broker dataBroker service reference
 538      * @param rd Route Distinguisher
 539      * @param origin Origin of the Routes to be removed (see {@link RouteOrigin})
 540      */
 541     public static void removeVrfEntriesByOrigin(DataBroker broker, String rd, RouteOrigin origin) {
 542         InstanceIdentifier<VrfTables> vpnVrfTableIid =
 543             InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class, new VrfTablesKey(rd)).build();
 544         Optional<VrfTables> vrfTablesOpc = read(broker, LogicalDatastoreType.CONFIGURATION, vpnVrfTableIid);
 545         if (vrfTablesOpc.isPresent()) {
 546             VrfTables vrfTables = vrfTablesOpc.get();
 547             WriteTransaction tx = broker.newWriteOnlyTransaction();
 548             for (VrfEntry vrfEntry : vrfTables.getVrfEntry()) {
 549                 if (origin == RouteOrigin.value(vrfEntry.getOrigin())) {
 550                     tx.delete(LogicalDatastoreType.CONFIGURATION,
 551                             vpnVrfTableIid.child(VrfEntry.class, vrfEntry.getKey()));
 552                 }
 553             }
 554             tx.submit();
 555         }
 556     }
 557
 558     public static List<VrfEntry> findVrfEntriesByNexthop(DataBroker broker, String rd, String nexthop) {
 559         InstanceIdentifier<VrfTables> vpnVrfTableIid =
 560             InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class, new VrfTablesKey(rd)).build();
 561         Optional<VrfTables> vrfTablesOpc = read(broker, LogicalDatastoreType.CONFIGURATION, vpnVrfTableIid);
 562         List<VrfEntry> matches = new ArrayList<>();
 563
 564         if (vrfTablesOpc.isPresent()) {
 565             VrfTables vrfTables = vrfTablesOpc.get();
 566             for (VrfEntry vrfEntry : vrfTables.getVrfEntry()) {
 567                 vrfEntry.getRoutePaths().stream()
 568                         .filter(routePath -> routePath.getNexthopAddress() != null
 569                                 && routePath.getNexthopAddress().equals(nexthop))
 570                         .findFirst().ifPresent(routePath -> matches.add(vrfEntry));
 571             }
 572         }
 573         return matches;
 574     }
 575
 576     public static void removeVrfEntries(DataBroker broker, String rd, List<VrfEntry> vrfEntries) {
 577         InstanceIdentifier<VrfTables> vpnVrfTableIid =
 578             InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class, new VrfTablesKey(rd)).build();
 579         WriteTransaction tx = broker.newWriteOnlyTransaction();
 580         for (VrfEntry vrfEntry : vrfEntries) {
 581             tx.delete(LogicalDatastoreType.CONFIGURATION, vpnVrfTableIid.child(VrfEntry.class, vrfEntry.getKey()));
 582         }
 583         tx.submit();
 584     }
 585
 586     // TODO Clean up the exception handling
 587     @SuppressWarnings("checkstyle:IllegalCatch")
 588     public static void withdrawRoutes(IBgpManager bgpManager, String rd, List<VrfEntry> vrfEntries) {
 589         vrfEntries.forEach(vrfEntry -> {
 590             try {
 591                 bgpManager.withdrawPrefix(rd, vrfEntry.getDestPrefix());
 592             } catch (Exception e) {
 593                 LOG.error("withdrawRoutes: Could not withdraw route to {} with route-paths {} in VpnRd {}",
 594                           vrfEntry.getDestPrefix(), vrfEntry.getRoutePaths(), rd);
 595             }
 596         });
 597     }
 598
 599     static org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstance
 600         getVpnInstanceToVpnId(String vpnName, long vpnId, String rd) {
 601         return new VpnInstanceBuilder().setVpnId(vpnId).setVpnInstanceName(vpnName).setVrfId(rd).build();
 602
 603     }
 604
 605     static RouterInterface getConfiguredRouterInterface(DataBroker broker, String interfaceName) {
 606         Optional<RouterInterface> optRouterInterface =
 607             read(broker, LogicalDatastoreType.CONFIGURATION, VpnUtil.getRouterInterfaceId(interfaceName));
 608         if (optRouterInterface.isPresent()) {
 609             return optRouterInterface.get();
 610         }
 611         return null;
 612     }
 613
 614     static org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance.VpnIds
 615         getVpnIdToVpnInstance(long vpnId, String vpnName, String rd, boolean isExternalVpn) {
 616         return new org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance
 617             .VpnIdsBuilder()
 618             .setVpnId(vpnId).setVpnInstanceName(vpnName).setVrfId(rd).setExternalVpn(isExternalVpn).build();
 619
 620     }
 621
 622     public static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to
 623         .vpn.instance.VpnIds>
 624         getVpnIdToVpnInstanceIdentifier(long vpnId) {
 625         return InstanceIdentifier.builder(VpnIdToVpnInstance.class)
 626             .child(
 627                 org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance.VpnIds
 628                     .class,
 629                 new org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance
 630                     .VpnIdsKey(vpnId)).build();
 631     }
 632
 633     /**
 634      * Retrieves the Vpn Name searching by its VPN Tag.
 635      *
 636      * @param broker dataBroker service reference
 637      * @param vpnId Dataplane identifier of the VPN
 638      * @return the Vpn instance name
 639      */
 640     public static String getVpnName(DataBroker broker, long vpnId) {
 641
 642         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn
 643             .instance.VpnIds>
 644             id
 645             = getVpnIdToVpnInstanceIdentifier(vpnId);
 646         Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance.VpnIds>
 647             vpnInstance
 648             = read(broker, LogicalDatastoreType.CONFIGURATION, id);
 649
 650         String vpnName = null;
 651         if (vpnInstance.isPresent()) {
 652             vpnName = vpnInstance.get().getVpnInstanceName();
 653         }
 654         return vpnName;
 655     }
 656
 657     public static InstanceIdentifier<VpnInstanceOpDataEntry> getVpnInstanceOpDataIdentifier(String rd) {
 658         return InstanceIdentifier.builder(VpnInstanceOpData.class)
 659             .child(VpnInstanceOpDataEntry.class, new VpnInstanceOpDataEntryKey(rd)).build();
 660     }
 661
 662     static InstanceIdentifier<RouterInterface> getRouterInterfaceId(String interfaceName) {
 663         return InstanceIdentifier.builder(RouterInterfaces.class)
 664             .child(RouterInterface.class, new RouterInterfaceKey(interfaceName)).build();
 665     }
 666
 667     static RouterInterface getRouterInterface(String interfaceName, String routerName) {
 668         return new RouterInterfaceBuilder().setKey(new RouterInterfaceKey(interfaceName))
 669             .setInterfaceName(interfaceName).setRouterName(routerName).build();
 670     }
 671
 672     public static VpnInstanceOpDataEntry getVpnInstanceOpData(DataBroker broker, String rd) {
 673         InstanceIdentifier<VpnInstanceOpDataEntry> id = VpnUtil.getVpnInstanceOpDataIdentifier(rd);
 674         return read(broker, LogicalDatastoreType.OPERATIONAL, id).orNull();
 675     }
 676
 677     static VpnInstanceOpDataEntry getVpnInstanceOpDataFromCache(DataBroker broker, String rd) {
 678         InstanceIdentifier<VpnInstanceOpDataEntry> id = VpnUtil.getVpnInstanceOpDataIdentifier(rd);
 679         return (VpnInstanceOpDataEntry) DataStoreCache.get(VpnConstants.VPN_OP_INSTANCE_CACHE_NAME, id, rd, broker,
 680             false);
 681     }
 682
 683     static VpnInterface getConfiguredVpnInterface(DataBroker broker, String interfaceName) {
 684         InstanceIdentifier<VpnInterface> interfaceId = getVpnInterfaceIdentifier(interfaceName);
 685         Optional<VpnInterface> configuredVpnInterface = read(broker, LogicalDatastoreType.CONFIGURATION, interfaceId);
 686
 687         if (configuredVpnInterface.isPresent()) {
 688             return configuredVpnInterface.get();
 689         }
 690         return null;
 691     }
 692
 693     static String getNeutronRouterFromInterface(DataBroker broker, String interfaceName) {
 694         InstanceIdentifier.InstanceIdentifierBuilder<RouterInterfacesMap> idBuilder =
 695             InstanceIdentifier.builder(RouterInterfacesMap.class);
 696         InstanceIdentifier<RouterInterfacesMap> id = idBuilder.build();
 697         Optional<RouterInterfacesMap> routerInterfacesMap =
 698             MDSALUtil.read(broker, LogicalDatastoreType.CONFIGURATION, id);
 699         if (routerInterfacesMap.isPresent()) {
 700             List<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.router.interfaces.map
 701                 .RouterInterfaces>
 702                 rtrInterfaces = routerInterfacesMap.get().getRouterInterfaces();
 703             for (org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.router.interfaces.map
 704                      .RouterInterfaces rtrInterface : rtrInterfaces) {
 705                 List<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.router.interfaces.map
 706                     .router.interfaces.Interfaces>
 707                     rtrIfc = rtrInterface.getInterfaces();
 708                 for (org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.router.interfaces.map
 709                          .router.interfaces.Interfaces ifc : rtrIfc) {
 710                     if (ifc.getInterfaceId().equals(interfaceName)) {
 711                         return rtrInterface.getRouterId().getValue();
 712                     }
 713                 }
 714             }
 715         }
 716         return null;
 717     }
 718
 719     static VpnInterface getOperationalVpnInterface(DataBroker broker, String interfaceName) {
 720         InstanceIdentifier<VpnInterface> interfaceId = getVpnInterfaceIdentifier(interfaceName);
 721         Optional<VpnInterface> operationalVpnInterface = read(broker, LogicalDatastoreType.OPERATIONAL, interfaceId);
 722
 723         if (operationalVpnInterface.isPresent()) {
 724             return operationalVpnInterface.get();
 725         }
 726         return null;
 727     }
 728
 729     static boolean isVpnInterfaceConfigured(DataBroker broker, String interfaceName) {
 730         InstanceIdentifier<VpnInterface> interfaceId = getVpnInterfaceIdentifier(interfaceName);
 731         return read(broker, LogicalDatastoreType.CONFIGURATION, interfaceId).isPresent();
 732     }
 733
 734     static Optional<String> getVpnAssociatedWithInterface(DataBroker broker, String interfaceName) {
 735         InstanceIdentifier<VpnInterface> interfaceId = getVpnInterfaceIdentifier(interfaceName);
 736         Optional<String> vpnOptional = Optional.absent();
 737         Optional<VpnInterface> optConfiguredVpnInterface = read(broker, LogicalDatastoreType.CONFIGURATION,
 738                 interfaceId);
 739         if (optConfiguredVpnInterface.isPresent()) {
 740             vpnOptional = Optional.of(optConfiguredVpnInterface.get().getVpnInstanceName());
 741         }
 742         return vpnOptional;
 743     }
 744
 745     public static String getIpPrefix(String prefix) {
 746         String[] prefixValues = prefix.split("/");
 747         if (prefixValues.length == 1) {
 748             prefix = prefix + PREFIX_SEPARATOR + DEFAULT_PREFIX_LENGTH;
 749         }
 750         return prefix;
 751     }
 752
 753     static final FutureCallback<Void> DEFAULT_CALLBACK =
 754         new FutureCallback<Void>() {
 755             @Override
 756             public void onSuccess(Void result) {
 757                 LOG.debug("Success in Datastore operation");
 758             }
 759
 760             @Override
 761             public void onFailure(Throwable error) {
 762                 LOG.error("Error in Datastore operation", error);
 763             }
 764
 765         };
 766
 767     public static <T extends DataObject> Optional<T> read(DataBroker broker, LogicalDatastoreType datastoreType,
 768                                                           InstanceIdentifier<T> path) {
 769         try (ReadOnlyTransaction tx = broker.newReadOnlyTransaction()) {
 770             return tx.read(datastoreType, path).get();
 771         } catch (InterruptedException | ExecutionException e) {
 772             throw new RuntimeException(e);
 773         }
 774     }
 775
 776     public static <T extends DataObject> void asyncUpdate(DataBroker broker, LogicalDatastoreType datastoreType,
 777         InstanceIdentifier<T> path, T data) {
 778         asyncUpdate(broker, datastoreType, path, data, DEFAULT_CALLBACK);
 779     }
 780
 781     public static <T extends DataObject> void asyncUpdate(DataBroker broker, LogicalDatastoreType datastoreType,
 782         InstanceIdentifier<T> path, T data, FutureCallback<Void> callback) {
 783         WriteTransaction tx = broker.newWriteOnlyTransaction();
 784         tx.merge(datastoreType, path, data, true);
 785         Futures.addCallback(tx.submit(), callback);
 786     }
 787
 788     public static <T extends DataObject> void asyncWrite(DataBroker broker, LogicalDatastoreType datastoreType,
 789         InstanceIdentifier<T> path, T data) {
 790         asyncWrite(broker, datastoreType, path, data, DEFAULT_CALLBACK);
 791     }
 792
 793     public static <T extends DataObject> void asyncWrite(DataBroker broker, LogicalDatastoreType datastoreType,
 794         InstanceIdentifier<T> path, T data, FutureCallback<Void> callback) {
 795         WriteTransaction tx = broker.newWriteOnlyTransaction();
 796         tx.put(datastoreType, path, data, WriteTransaction.CREATE_MISSING_PARENTS);
 797         Futures.addCallback(tx.submit(), callback);
 798     }
 799
 800     // TODO Clean up the exception handling
 801     @SuppressWarnings("checkstyle:IllegalCatch")
 802     public static <T extends DataObject> void tryDelete(DataBroker broker, LogicalDatastoreType datastoreType,
 803         InstanceIdentifier<T> path) {
 804         try {
 805             delete(broker, datastoreType, path, DEFAULT_CALLBACK);
 806         } catch (SchemaValidationFailedException sve) {
 807             LOG.info("tryDelete: Could not delete {}. SchemaValidationFailedException: {}", path, sve.getMessage());
 808         } catch (Exception e) {
 809             LOG.info("tryDelete: Could not delete {}. Unhandled error: {}", path, e.getMessage());
 810         }
 811     }
 812
 813     public static <T extends DataObject> void delete(DataBroker broker, LogicalDatastoreType datastoreType,
 814         InstanceIdentifier<T> path) {
 815         delete(broker, datastoreType, path, DEFAULT_CALLBACK);
 816     }
 817
 818
 819     public static <T extends DataObject> void delete(DataBroker broker, LogicalDatastoreType datastoreType,
 820         InstanceIdentifier<T> path, FutureCallback<Void> callback) {
 821         WriteTransaction tx = broker.newWriteOnlyTransaction();
 822         tx.delete(datastoreType, path);
 823         Futures.addCallback(tx.submit(), callback);
 824     }
 825
 826     public static <T extends DataObject> void syncWrite(DataBroker broker, LogicalDatastoreType datastoreType,
 827         InstanceIdentifier<T> path, T data) {
 828         WriteTransaction tx = broker.newWriteOnlyTransaction();
 829         tx.put(datastoreType, path, data, WriteTransaction.CREATE_MISSING_PARENTS);
 830
 831         try {
 832             tx.submit().get();
 833         } catch (InterruptedException | ExecutionException e) {
 834             LOG.error("syncWrite: Error writing to datastore (path, data) : ({}, {})", path, data);
 835             throw new RuntimeException(e.getMessage());
 836         }
 837     }
 838
 839     public static <T extends DataObject> void syncUpdate(DataBroker broker, LogicalDatastoreType datastoreType,
 840         InstanceIdentifier<T> path, T data) {
 841         WriteTransaction tx = broker.newWriteOnlyTransaction();
 842         tx.merge(datastoreType, path, data, true);
 843
 844         try {
 845             tx.submit().get();
 846         } catch (InterruptedException | ExecutionException e) {
 847             LOG.error("syncUpdate: Error writing to datastore (path, data) : ({}, {})", path, data);
 848             throw new RuntimeException(e.getMessage());
 849         }
 850     }
 851
 852     public static long getRemoteBCGroup(long elanTag) {
 853         return VpnConstants.ELAN_GID_MIN + elanTag % VpnConstants.ELAN_GID_MIN * 2;
 854     }
 855
 856     // interface-index-tag operational container
 857     public static IfIndexInterface getInterfaceInfoByInterfaceTag(DataBroker broker, long interfaceTag) {
 858         InstanceIdentifier<IfIndexInterface> interfaceId = getInterfaceInfoEntriesOperationalDataPath(interfaceTag);
 859         Optional<IfIndexInterface> existingInterfaceInfo =
 860             VpnUtil.read(broker, LogicalDatastoreType.OPERATIONAL, interfaceId);
 861         if (existingInterfaceInfo.isPresent()) {
 862             return existingInterfaceInfo.get();
 863         }
 864         return null;
 865     }
 866
 867     private static InstanceIdentifier<IfIndexInterface> getInterfaceInfoEntriesOperationalDataPath(long interfaceTag) {
 868         return InstanceIdentifier.builder(IfIndexesInterfaceMap.class).child(IfIndexInterface.class,
 869             new IfIndexInterfaceKey((int) interfaceTag)).build();
 870     }
 871
 872     public static ElanTagName getElanInfoByElanTag(DataBroker broker, long elanTag) {
 873         InstanceIdentifier<ElanTagName> elanId = getElanInfoEntriesOperationalDataPath(elanTag);
 874         Optional<ElanTagName> existingElanInfo = VpnUtil.read(broker, LogicalDatastoreType.OPERATIONAL, elanId);
 875         if (existingElanInfo.isPresent()) {
 876             return existingElanInfo.get();
 877         }
 878         return null;
 879     }
 880
 881     private static InstanceIdentifier<ElanTagName> getElanInfoEntriesOperationalDataPath(long elanTag) {
 882         return InstanceIdentifier.builder(ElanTagNameMap.class).child(ElanTagName.class,
 883             new ElanTagNameKey(elanTag)).build();
 884     }
 885
 886     /**
 887      * Returns the Path identifier to reach a specific interface in a specific DPN in a given VpnInstance.
 888      *
 889      * @param vpnRd Route-Distinguisher of the VpnInstance
 890      * @param dpnId Id of the DPN where the interface is
 891      * @param ifaceName Interface name
 892      * @return the Instance Identifier
 893      */
 894     public static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
 895         .instance.op.data.vpn.instance.op.data.entry.vpn.to.dpn.list.VpnInterfaces>
 896         getVpnToDpnInterfacePath(String vpnRd, BigInteger dpnId, String ifaceName) {
 897
 898         return
 899             InstanceIdentifier.builder(VpnInstanceOpData.class)
 900                 .child(VpnInstanceOpDataEntry.class, new VpnInstanceOpDataEntryKey(vpnRd))
 901                 .child(VpnToDpnList.class, new VpnToDpnListKey(dpnId))
 902                 .child(org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
 903                         .instance.op.data.vpn.instance.op.data.entry.vpn.to.dpn.list.VpnInterfaces.class,
 904                     new org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
 905                         .instance.op.data.vpn.instance.op.data.entry.vpn.to.dpn.list.VpnInterfacesKey(ifaceName))
 906                 .build();
 907     }
 908
 909     // TODO Clean up the exception handling
 910     @SuppressWarnings("checkstyle:IllegalCatch")
 911     public static void removePrefixToInterfaceForVpnId(DataBroker broker, long vpnId, WriteTransaction writeTxn) {
 912         try {
 913             // Clean up PrefixToInterface Operational DS
 914             if (writeTxn != null) {
 915                 writeTxn.delete(LogicalDatastoreType.OPERATIONAL,
 916                     InstanceIdentifier.builder(PrefixToInterface.class).child(
 917                         VpnIds.class, new VpnIdsKey(vpnId)).build());
 918             } else {
 919                 delete(broker, LogicalDatastoreType.OPERATIONAL,
 920                     InstanceIdentifier.builder(PrefixToInterface.class).child(VpnIds.class,
 921                         new VpnIdsKey(vpnId)).build(),
 922                     DEFAULT_CALLBACK);
 923             }
 924         } catch (Exception e) {
 925             LOG.error("removePrefixToInterfaceForVpnId: Exception during cleanup of PrefixToInterface for VPN ID {}",
 926                     vpnId, e);
 927         }
 928     }
 929
 930     // TODO Clean up the exception handling
 931     @SuppressWarnings("checkstyle:IllegalCatch")
 932     public static void removeVpnExtraRouteForVpn(DataBroker broker, String vpnName, WriteTransaction writeTxn) {
 933         try {
 934             // Clean up VPNExtraRoutes Operational DS
 935             if (writeTxn != null) {
 936                 writeTxn.delete(LogicalDatastoreType.OPERATIONAL,
 937                         InstanceIdentifier.builder(VpnToExtraroutes.class)
 938                                 .child(Vpn.class, new VpnKey(vpnName)).build());
 939             } else {
 940                 delete(broker, LogicalDatastoreType.OPERATIONAL,
 941                         InstanceIdentifier.builder(VpnToExtraroutes.class)
 942                                 .child(Vpn.class, new VpnKey(vpnName)).build(),
 943                         DEFAULT_CALLBACK);
 944             }
 945         } catch (Exception e) {
 946             LOG.error("removeVpnExtraRouteForVpna: Exception during cleanup of VPNToExtraRoute for VPN {}",
 947                     vpnName, e);
 948         }
 949     }
 950
 951     // TODO Clean up the exception handling
 952     @SuppressWarnings("checkstyle:IllegalCatch")
 953     public static void removeVpnOpInstance(DataBroker broker, String vpnName, WriteTransaction writeTxn) {
 954         try {
 955             // Clean up VPNInstanceOpDataEntry
 956             if (writeTxn != null) {
 957                 writeTxn.delete(LogicalDatastoreType.OPERATIONAL, getVpnInstanceOpDataIdentifier(vpnName));
 958             } else {
 959                 delete(broker, LogicalDatastoreType.OPERATIONAL, getVpnInstanceOpDataIdentifier(vpnName),
 960                     DEFAULT_CALLBACK);
 961             }
 962         } catch (Exception e) {
 963             LOG.error("removeVpnOpInstance: Exception during cleanup of VPNInstanceOpDataEntry for VPN {}",
 964                     vpnName, e);
 965         }
 966     }
 967
 968     // TODO Clean up the exception handling
 969     @SuppressWarnings("checkstyle:IllegalCatch")
 970     public static void removeVpnInstanceToVpnId(DataBroker broker, String vpnName, WriteTransaction writeTxn) {
 971         try {
 972             if (writeTxn != null) {
 973                 writeTxn.delete(LogicalDatastoreType.CONFIGURATION,
 974                                 VpnOperDsUtils.getVpnInstanceToVpnIdIdentifier(vpnName));
 975             } else {
 976                 delete(broker, LogicalDatastoreType.CONFIGURATION,
 977                        VpnOperDsUtils.getVpnInstanceToVpnIdIdentifier(vpnName),
 978                     DEFAULT_CALLBACK);
 979             }
 980         } catch (Exception e) {
 981             LOG.error("removeVpnInstanceToVpnId: Exception during clean up of VpnInstanceToVpnId for VPN {}",
 982                     vpnName, e);
 983         }
 984     }
 985
 986     // TODO Clean up the exception handling
 987     @SuppressWarnings("checkstyle:IllegalCatch")
 988     public static void removeVpnIdToVpnInstance(DataBroker broker, long vpnId, WriteTransaction writeTxn) {
 989         try {
 990             if (writeTxn != null) {
 991                 writeTxn.delete(LogicalDatastoreType.CONFIGURATION, getVpnIdToVpnInstanceIdentifier(vpnId));
 992             } else {
 993                 delete(broker, LogicalDatastoreType.CONFIGURATION, getVpnIdToVpnInstanceIdentifier(vpnId),
 994                     DEFAULT_CALLBACK);
 995             }
 996         } catch (Exception e) {
 997             LOG.error("removeVpnIdToVpnInstance: Exception during clean up of VpnIdToVpnInstance for VPNID {}",
 998                     vpnId, e);
 999         }
1000     }
1001
1002     // TODO Clean up the exception handling
1003     @SuppressWarnings("checkstyle:IllegalCatch")
1004     public static void removeVrfTableForVpn(DataBroker broker, String vpnName, WriteTransaction writeTxn) {
1005         // Clean up FIB Entries Config DS
1006         try {
1007             if (writeTxn != null) {
1008                 writeTxn.delete(LogicalDatastoreType.CONFIGURATION,
1009                     InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class,
1010                         new VrfTablesKey(vpnName)).build());
1011             } else {
1012                 delete(broker, LogicalDatastoreType.CONFIGURATION,
1013                     InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class,
1014                         new VrfTablesKey(vpnName)).build(),
1015                     DEFAULT_CALLBACK);
1016             }
1017         } catch (Exception e) {
1018             LOG.error("removeVrfTableForVpn: Exception during clean up of VrfTable from FIB for VPN {}",
1019                     vpnName, e);
1020         }
1021     }
1022
1023     // TODO Clean up the exception handling
1024     @SuppressWarnings("checkstyle:IllegalCatch")
1025     public static void removeL3nexthopForVpnId(DataBroker broker, long vpnId, WriteTransaction writeTxn) {
1026         try {
1027             // Clean up L3NextHop Operational DS
1028             if (writeTxn != null) {
1029                 writeTxn.delete(LogicalDatastoreType.OPERATIONAL,
1030                     InstanceIdentifier.builder(L3nexthop.class).child(VpnNexthops.class,
1031                         new VpnNexthopsKey(vpnId)).build());
1032             } else {
1033                 delete(broker, LogicalDatastoreType.OPERATIONAL,
1034                     InstanceIdentifier.builder(L3nexthop.class).child(VpnNexthops.class,
1035                         new VpnNexthopsKey(vpnId)).build(),
1036                     DEFAULT_CALLBACK);
1037             }
1038         } catch (Exception e) {
1039             LOG.error("removeL3nexthopForVpnId: Exception during cleanup of L3NextHop for VPN ID {}", vpnId, e);
1040         }
1041     }
1042
1043     public static void scheduleVpnInterfaceForRemoval(DataBroker broker,String interfaceName, BigInteger dpnId,
1044                                                       String vpnInstanceName, Boolean isScheduledToRemove,
1045                                                       WriteTransaction writeOperTxn) {
1046         InstanceIdentifier<VpnInterface> interfaceId = VpnUtil.getVpnInterfaceIdentifier(interfaceName);
1047         VpnInterface interfaceToUpdate =
1048             new VpnInterfaceBuilder().setKey(new VpnInterfaceKey(interfaceName)).setName(interfaceName)
1049                 .setDpnId(dpnId).setVpnInstanceName(vpnInstanceName).setScheduledForRemove(isScheduledToRemove).build();
1050         if (writeOperTxn != null) {
1051             writeOperTxn.merge(LogicalDatastoreType.OPERATIONAL, interfaceId, interfaceToUpdate, true);
1052         } else {
1053             VpnUtil.syncUpdate(broker, LogicalDatastoreType.OPERATIONAL, interfaceId, interfaceToUpdate);
1054         }
1055     }
1056
1057     protected static void createLearntVpnVipToPort(DataBroker broker, String vpnName, String fixedIp, String
1058             portName, String macAddress) {
1059         synchronized ((vpnName + fixedIp).intern()) {
1060             InstanceIdentifier<LearntVpnVipToPort> id = buildLearntVpnVipToPortIdentifier(vpnName, fixedIp);
1061             LearntVpnVipToPortBuilder builder =
1062                     new LearntVpnVipToPortBuilder().setKey(new LearntVpnVipToPortKey(fixedIp, vpnName)).setVpnName(
1063                             vpnName).setPortFixedip(fixedIp).setPortName(portName)
1064                             .setMacAddress(macAddress.toLowerCase())
1065                             .setCreationTime(new SimpleDateFormat("MM/dd/yyyy h:mm:ss a").format(new Date()));
1066             MDSALUtil.syncWrite(broker, LogicalDatastoreType.OPERATIONAL, id, builder.build());
1067             LOG.debug("createLearntVpnVipToPort: ARP learned for fixedIp: {}, vpn {}, interface {}, mac {},"
1068                     + " isSubnetIp {} added to VpnPortipToPort DS", fixedIp, vpnName, portName, macAddress);
1069         }
1070     }
1071
1072     private static InstanceIdentifier<LearntVpnVipToPort> buildLearntVpnVipToPortIdentifier(String vpnName,
1073             String fixedIp) {
1074         InstanceIdentifier<LearntVpnVipToPort> id =
1075                 InstanceIdentifier.builder(LearntVpnVipToPortData.class).child(LearntVpnVipToPort.class,
1076                         new LearntVpnVipToPortKey(fixedIp, vpnName)).build();
1077         return id;
1078     }
1079
1080     protected static void removeLearntVpnVipToPort(DataBroker broker, String vpnName, String fixedIp) {
1081         synchronized ((vpnName + fixedIp).intern()) {
1082             InstanceIdentifier<LearntVpnVipToPort> id = buildLearntVpnVipToPortIdentifier(vpnName, fixedIp);
1083             MDSALUtil.syncDelete(broker, LogicalDatastoreType.OPERATIONAL, id);
1084             LOG.debug("removeLearntVpnVipToPort: Delete learned ARP for fixedIp: {}, vpn {} removed from"
1085                     + " VpnPortipToPort DS", fixedIp, vpnName);
1086         }
1087     }
1088
1089     static InstanceIdentifier<NetworkMap> buildNetworkMapIdentifier(Uuid networkId) {
1090         return InstanceIdentifier.builder(NetworkMaps.class).child(NetworkMap.class, new
1091                 NetworkMapKey(networkId)).build();
1092     }
1093
1094     static InstanceIdentifier<SubnetOpDataEntry> buildSubnetOpDataEntryInstanceIdentifier(Uuid subnetId) {
1095         return InstanceIdentifier.builder(SubnetOpData.class)
1096                 .child(SubnetOpDataEntry.class, new SubnetOpDataEntryKey(subnetId)).build();
1097     }
1098
1099     static InstanceIdentifier<VpnPortipToPort> buildVpnPortipToPortIdentifier(String vpnName, String fixedIp) {
1100         return InstanceIdentifier.builder(NeutronVpnPortipPortData.class).child(VpnPortipToPort.class,
1101                 new VpnPortipToPortKey(fixedIp, vpnName)).build();
1102     }
1103
1104     public static VpnPortipToPort getNeutronPortFromVpnPortFixedIp(DataBroker broker, String vpnName, String fixedIp) {
1105         InstanceIdentifier id = buildVpnPortipToPortIdentifier(vpnName, fixedIp);
1106         Optional<VpnPortipToPort> vpnPortipToPortData = read(broker, LogicalDatastoreType.CONFIGURATION, id);
1107         if (vpnPortipToPortData.isPresent()) {
1108             return vpnPortipToPortData.get();
1109         }
1110         return null;
1111     }
1112
1113     static LearntVpnVipToPort getLearntVpnVipToPort(DataBroker broker, String vpnName, String fixedIp) {
1114         InstanceIdentifier id = buildLearntVpnVipToPortIdentifier(vpnName, fixedIp);
1115         Optional<LearntVpnVipToPort> learntVpnVipToPort = read(broker, LogicalDatastoreType.OPERATIONAL, id);
1116         if (learntVpnVipToPort.isPresent()) {
1117             return learntVpnVipToPort.get();
1118         }
1119         return null;
1120     }
1121
1122     public static List<BigInteger> getDpnsOnVpn(DataBroker dataBroker, String vpnInstanceName) {
1123         List<BigInteger> result = new ArrayList<>();
1124         String rd = getVpnRd(dataBroker, vpnInstanceName);
1125         if (rd == null) {
1126             LOG.debug("getDpnsOnVpn: Could not find Route-Distinguisher for VpnName={}", vpnInstanceName);
1127             return result;
1128         }
1129
1130         VpnInstanceOpDataEntry vpnInstanceOpData = getVpnInstanceOpData(dataBroker, rd);
1131         if (vpnInstanceOpData == null) {
1132             LOG.debug("getDpnsOnVpn: Could not find OpState for VpnName={}", vpnInstanceName);
1133             return result;
1134         }
1135
1136         List<VpnToDpnList> vpnToDpnList = vpnInstanceOpData.getVpnToDpnList();
1137         if (vpnToDpnList == null) {
1138             LOG.debug("getDpnsOnVpn: Could not find DPN footprint for VpnName={}", vpnInstanceName);
1139             return result;
1140         }
1141         for (VpnToDpnList vpnToDpn : vpnToDpnList) {
1142             result.add(vpnToDpn.getDpnId());
1143         }
1144         return result;
1145     }
1146
1147     static String getAssociatedExternalNetwork(DataBroker dataBroker, String routerId) {
1148         InstanceIdentifier<Routers> id = buildRouterIdentifier(routerId);
1149         Optional<Routers> routerData = read(dataBroker, LogicalDatastoreType.CONFIGURATION, id);
1150         if (routerData.isPresent()) {
1151             Uuid networkId = routerData.get().getNetworkId();
1152             if (networkId != null) {
1153                 return networkId.getValue();
1154             }
1155         }
1156         return null;
1157     }
1158
1159     public static String getAssociatedExternalRouter(DataBroker dataBroker, String extIp) {
1160         InstanceIdentifier<ExtRouters> extRouterInstanceIndentifier =
1161                 InstanceIdentifier.builder(ExtRouters.class).build();
1162         Optional<ExtRouters> extRouterData = read(dataBroker, LogicalDatastoreType.CONFIGURATION,
1163                 extRouterInstanceIndentifier);
1164         if (extRouterData.isPresent()) {
1165             for (Routers routerData : extRouterData.get().getRouters()) {
1166                 List<ExternalIps> externalIps = routerData.getExternalIps();
1167                 for (ExternalIps externalIp : externalIps) {
1168                     if (externalIp.getIpAddress().equals(extIp)) {
1169                         return routerData.getRouterName();
1170                     }
1171                 }
1172             }
1173         }
1174         return null;
1175     }
1176
1177     static InstanceIdentifier<Routers> buildRouterIdentifier(String routerId) {
1178         return InstanceIdentifier.builder(ExtRouters.class).child(Routers.class, new RoutersKey(routerId)).build();
1179     }
1180
1181     static Networks getExternalNetwork(DataBroker dataBroker, Uuid networkId) {
1182         InstanceIdentifier<Networks> netsIdentifier = InstanceIdentifier.builder(ExternalNetworks.class)
1183             .child(Networks.class, new NetworksKey(networkId)).build();
1184         Optional<Networks> optionalNets = VpnUtil.read(dataBroker, LogicalDatastoreType.CONFIGURATION, netsIdentifier);
1185         return optionalNets.isPresent() ? optionalNets.get() : null;
1186     }
1187
1188     static Uuid getExternalNetworkVpnId(DataBroker dataBroker, Uuid networkId) {
1189         Networks extNetwork = getExternalNetwork(dataBroker, networkId);
1190         return extNetwork != null ? extNetwork.getVpnid() : null;
1191     }
1192
1193     static List<Uuid> getExternalNetworkRouterIds(DataBroker dataBroker, Uuid networkId) {
1194         Networks extNetwork = getExternalNetwork(dataBroker, networkId);
1195         return extNetwork != null ? extNetwork.getRouterIds() : Collections.emptyList();
1196     }
1197
1198     static Routers getExternalRouter(DataBroker dataBroker, String routerId) {
1199         InstanceIdentifier<Routers> id = InstanceIdentifier.builder(ExtRouters.class)
1200                 .child(Routers.class, new RoutersKey(routerId)).build();
1201         Optional<Routers> routerData = read(dataBroker, LogicalDatastoreType.CONFIGURATION, id);
1202         return routerData.isPresent() ? routerData.get() : null;
1203     }
1204
1205     static List<String> getAllSubnetGatewayMacAddressesforVpn(DataBroker broker, String vpnName) {
1206         List<String> macAddresses = new ArrayList<>();
1207         Optional<Subnetmaps> subnetMapsData =
1208             read(broker, LogicalDatastoreType.CONFIGURATION, buildSubnetMapsWildCardPath());
1209         if (subnetMapsData.isPresent()) {
1210             List<Subnetmap> subnetMapList = subnetMapsData.get().getSubnetmap();
1211             if (subnetMapList != null && !subnetMapList.isEmpty()) {
1212                 for (Subnetmap subnet : subnetMapList) {
1213                     if (subnet.getVpnId() != null && subnet.getVpnId().equals(Uuid.getDefaultInstance(vpnName))) {
1214                         String routerIntfMacAddress = subnet.getRouterIntfMacAddress();
1215                         if (routerIntfMacAddress != null && !routerIntfMacAddress.isEmpty()) {
1216                             macAddresses.add(subnet.getRouterIntfMacAddress());
1217                         }
1218                     }
1219                 }
1220             }
1221         }
1222         return macAddresses;
1223     }
1224
1225     static InstanceIdentifier<Subnetmaps> buildSubnetMapsWildCardPath() {
1226         return InstanceIdentifier.create(Subnetmaps.class);
1227     }
1228
1229     static void setupSubnetMacIntoVpnInstance(DataBroker dataBroker, IMdsalApiManager mdsalManager, String vpnName,
1230             String subnetVpnName, String srcMacAddress, BigInteger dpnId, WriteTransaction writeTx, int addOrRemove) {
1231         long vpnId = getVpnId(dataBroker, vpnName);
1232         long subnetVpnId = VpnConstants.INVALID_ID;
1233         if (subnetVpnName != null) {
1234             subnetVpnId = getVpnId(dataBroker,subnetVpnName);
1235         }
1236
1237         if (dpnId.equals(BigInteger.ZERO)) {
1238             /* Apply the MAC on all DPNs in a VPN */
1239             List<BigInteger> dpIds = getDpnsOnVpn(dataBroker, vpnName);
1240             if (dpIds == null || dpIds.isEmpty()) {
1241                 return;
1242             }
1243             for (BigInteger dpId : dpIds) {
1244                 addGwMacIntoTx(mdsalManager, srcMacAddress, writeTx, addOrRemove, vpnId, dpId, subnetVpnId);
1245             }
1246         } else {
1247             addGwMacIntoTx(mdsalManager, srcMacAddress, writeTx, addOrRemove, vpnId, dpnId, subnetVpnId);
1248         }
1249     }
1250
1251     static void addGwMacIntoTx(IMdsalApiManager mdsalManager, String srcMacAddress, WriteTransaction writeTx,
1252         int addOrRemove, long vpnId, BigInteger dpId, long subnetVpnId) {
1253         FlowEntity flowEntity = buildL3vpnGatewayFlow(dpId, srcMacAddress, vpnId, subnetVpnId);
1254         if (addOrRemove == NwConstants.ADD_FLOW) {
1255             mdsalManager.addFlowToTx(flowEntity, writeTx);
1256         } else {
1257             mdsalManager.removeFlowToTx(flowEntity, writeTx);
1258         }
1259     }
1260
1261     public static FlowEntity buildL3vpnGatewayFlow(BigInteger dpId, String gwMacAddress, long vpnId,
1262             long subnetVpnId) {
1263         List<MatchInfo> mkMatches = new ArrayList<>();
1264         mkMatches.add(new MatchMetadata(MetaDataUtil.getVpnIdMetadata(vpnId), MetaDataUtil.METADATA_MASK_VRFID));
1265         mkMatches.add(new MatchEthernetDestination(new MacAddress(gwMacAddress)));
1266         List<InstructionInfo> mkInstructions = new ArrayList<>();
1267         mkInstructions.add(new InstructionGotoTable(NwConstants.L3_FIB_TABLE));
1268         if (subnetVpnId != VpnConstants.INVALID_ID) {
1269             BigInteger subnetIdMetaData = MetaDataUtil.getVpnIdMetadata(subnetVpnId);
1270             mkInstructions.add(new InstructionWriteMetadata(subnetIdMetaData, MetaDataUtil.METADATA_MASK_VRFID));
1271         }
1272
1273         String flowId = getL3VpnGatewayFlowRef(NwConstants.L3_GW_MAC_TABLE, dpId, vpnId, gwMacAddress);
1274
1275         return MDSALUtil.buildFlowEntity(dpId, NwConstants.L3_GW_MAC_TABLE,
1276                 flowId, 20, flowId, 0, 0, NwConstants.COOKIE_L3_GW_MAC_TABLE, mkMatches, mkInstructions);
1277     }
1278
1279     private static String getL3VpnGatewayFlowRef(short l3GwMacTable, BigInteger dpId, long vpnId, String gwMacAddress) {
1280         return gwMacAddress + NwConstants.FLOWID_SEPARATOR + vpnId + NwConstants.FLOWID_SEPARATOR + dpId
1281             + NwConstants.FLOWID_SEPARATOR + l3GwMacTable;
1282     }
1283
1284     public static void lockSubnet(LockManagerService lockManager, String subnetId) {
1285         TryLockInput input =
1286             new TryLockInputBuilder().setLockName(subnetId).setTime(3000L).setTimeUnit(TimeUnits.Milliseconds).build();
1287         Future<RpcResult<Void>> result = lockManager.tryLock(input);
1288         String errMsg = "Unable to getLock for subnet " + subnetId;
1289         try {
1290             if (result != null && result.get().isSuccessful()) {
1291                 LOG.debug("lockSubnet: Acquired lock for {}", subnetId);
1292             } else {
1293                 throw new RuntimeException(errMsg);
1294             }
1295         } catch (InterruptedException | ExecutionException e) {
1296             LOG.error(errMsg);
1297             throw new RuntimeException(errMsg, e.getCause());
1298         }
1299     }
1300
1301     public static void unlockSubnet(LockManagerService lockManager, String subnetId) {
1302         UnlockInput input = new UnlockInputBuilder().setLockName(subnetId).build();
1303         Future<RpcResult<Void>> result = lockManager.unlock(input);
1304         try {
1305             if (result != null && result.get().isSuccessful()) {
1306                 LOG.debug("unlockSubnet: Unlocked {}", subnetId);
1307             } else {
1308                 LOG.debug("unlockSubnet: Unable to unlock subnet {}", subnetId);
1309             }
1310         } catch (InterruptedException | ExecutionException e) {
1311             LOG.error("unlockSubnet: Unable to unlock subnet {}", subnetId);
1312             throw new RuntimeException(String.format("Unable to unlock subnetId %s", subnetId), e.getCause());
1313         }
1314     }
1315
1316     static Optional<IpAddress> getGatewayIpAddressFromInterface(String srcInterface,
1317             INeutronVpnManager neutronVpnService, DataBroker dataBroker) {
1318         Optional<IpAddress> gatewayIp = Optional.absent();
1319         if (neutronVpnService != null) {
1320             //TODO(Gobinath): Need to fix this as assuming port will belong to only one Subnet would be incorrect"
1321             Port port = neutronVpnService.getNeutronPort(srcInterface);
1322             if (port != null && port.getFixedIps() != null && port.getFixedIps().get(0) != null
1323                 && port.getFixedIps().get(0).getSubnetId() != null) {
1324                 gatewayIp = Optional.of(
1325                     neutronVpnService.getNeutronSubnet(port.getFixedIps().get(0).getSubnetId()).getGatewayIp());
1326             }
1327         } else {
1328             LOG.error("getGatewayIpAddressFromInterface: neutron vpn service is not configured."
1329                     + " Failed for interface {}.", srcInterface);
1330         }
1331         return gatewayIp;
1332     }
1333
1334     static Optional<String> getGWMacAddressFromInterface(MacEntry macEntry, IpAddress gatewayIp,
1335         DataBroker dataBroker, OdlInterfaceRpcService interfaceRpc) {
1336         Optional<String> gatewayMac = Optional.absent();
1337         long vpnId = getVpnId(dataBroker, macEntry.getVpnName());
1338         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn
1339             .instance.VpnIds>
1340             vpnIdsInstanceIdentifier = VpnUtil.getVpnIdToVpnInstanceIdentifier(vpnId);
1341         Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance.VpnIds>
1342             vpnIdsOptional
1343             = VpnUtil.read(dataBroker, LogicalDatastoreType.CONFIGURATION, vpnIdsInstanceIdentifier);
1344         if (!vpnIdsOptional.isPresent()) {
1345             LOG.error("getGWMacAddressFromInterface: VPN {} not configured", vpnId);
1346             return gatewayMac;
1347         }
1348         VpnPortipToPort vpnTargetIpToPort = VpnUtil.getNeutronPortFromVpnPortFixedIp(dataBroker,
1349             macEntry.getVpnName(), gatewayIp.getIpv4Address().getValue());
1350         if (vpnTargetIpToPort != null && vpnTargetIpToPort.isSubnetIp()) {
1351             gatewayMac = Optional.of(vpnTargetIpToPort.getMacAddress());
1352         } else {
1353             org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance.VpnIds vpnIds =
1354                 vpnIdsOptional.get();
1355             if (vpnIds.isExternalVpn()) {
1356                 gatewayMac = InterfaceUtils.getMacAddressForInterface(dataBroker, macEntry.getInterfaceName());
1357             }
1358         }
1359         return gatewayMac;
1360     }
1361
1362     public static void runOnlyInLeaderNode(EntityOwnershipService entityOwnershipService, Runnable job) {
1363         runOnlyInLeaderNode(entityOwnershipService, job, "");
1364     }
1365
1366     public static void runOnlyInLeaderNode(EntityOwnershipService entityOwnershipService, final Runnable job,
1367             final String jobDescription) {
1368         ListenableFuture<Boolean> checkEntityOwnerFuture = ClusteringUtils.checkNodeEntityOwner(
1369                 entityOwnershipService, VpnConstants.ARP_MONITORING_ENTITY,
1370                 VpnConstants.ARP_MONITORING_ENTITY);
1371         Futures.addCallback(checkEntityOwnerFuture, new FutureCallback<Boolean>() {
1372             @Override
1373             public void onSuccess(Boolean isOwner) {
1374                 if (isOwner) {
1375                     job.run();
1376                 } else {
1377                     LOG.trace("runOnlyInLeaderNode: job is not run as i m not cluster owner desc :{} ",
1378                             jobDescription);
1379                 }
1380             }
1381
1382             @Override
1383             public void onFailure(Throwable error) {
1384                 LOG.error("runOnlyInLeaderNode: Failed to identity cluster owner ", error);
1385             }
1386         });
1387     }
1388
1389     public static boolean isVpnIntfPresentInVpnToDpnList(DataBroker broker, VpnInterface vpnInterface) {
1390         BigInteger dpnId = vpnInterface.getDpnId();
1391         String rd = VpnUtil.getVpnRd(broker, vpnInterface.getVpnInstanceName());
1392         LOG.trace("isVpnIntfPresentInVpnToDpnList: GOT rd {} for VpnInterface {}  VpnInstance {} ", rd ,
1393                 vpnInterface.getName(), vpnInterface.getVpnInstanceName());
1394         VpnInstanceOpDataEntry vpnInstanceOpData = VpnUtil.getVpnInstanceOpDataFromCache(broker, rd);
1395         if (vpnInstanceOpData != null) {
1396             LOG.trace("isVpnIntfPresentInVpnToDpnList: GOT VpnInstanceOp {} for rd {} ", vpnInstanceOpData, rd);
1397             List<VpnToDpnList> dpnToVpns = vpnInstanceOpData.getVpnToDpnList();
1398             if (dpnToVpns != null) {
1399                 for (VpnToDpnList dpn : dpnToVpns) {
1400                     if (dpn.getDpnId().equals(dpnId)) {
1401                         return dpn.getVpnInterfaces().contains(vpnInterface.getName());
1402                     }
1403                     LOG.info("isVpnIntfPresentInVpnToDpnList: VpnInterface {} not present in DpnId {} vpn {}",
1404                             vpnInterface.getName(), dpn.getDpnId(), vpnInterface.getVpnInstanceName());
1405                 }
1406             }
1407         }
1408         return false;
1409     }
1410
1411     public static void setupGwMacIfExternalVpn(DataBroker dataBroker, IMdsalApiManager mdsalManager, BigInteger dpnId,
1412             String interfaceName, long vpnId, WriteTransaction writeInvTxn, int addOrRemove, org.opendaylight.yang.gen
1413             .v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface interfaceState) {
1414         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance
1415             .VpnIds> vpnIdsInstanceIdentifier = getVpnIdToVpnInstanceIdentifier(vpnId);
1416         Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance
1417             .VpnIds> vpnIdsOptional = read(
1418                 dataBroker, LogicalDatastoreType.CONFIGURATION, vpnIdsInstanceIdentifier);
1419         if (vpnIdsOptional.isPresent() && vpnIdsOptional.get().isExternalVpn()) {
1420             PhysAddress gwMacAddress = interfaceState.getPhysAddress();
1421             if (gwMacAddress == null) {
1422                 LOG.error("setupGwMacIfExternalVpn: Failed to get gwMacAddress for interface {} on dpn {} vpn {}",
1423                         interfaceName, dpnId.toString(), vpnIdsOptional.get().getVpnInstanceName());
1424                 return;
1425             }
1426
1427             String gwMac = gwMacAddress.getValue();
1428             FlowEntity flowEntity = VpnUtil.buildL3vpnGatewayFlow(dpnId, gwMac, vpnId, VpnConstants.INVALID_ID);
1429             if (addOrRemove == NwConstants.ADD_FLOW) {
1430                 mdsalManager.addFlowToTx(flowEntity, writeInvTxn);
1431             } else if (addOrRemove == NwConstants.DEL_FLOW) {
1432                 mdsalManager.removeFlowToTx(flowEntity, writeInvTxn);
1433             }
1434         }
1435     }
1436
1437     public static Optional<VpnPortipToPort> getRouterInterfaceForVpnInterface(DataBroker dataBroker,
1438                                                                               String interfaceName,
1439                                                                               String vpnName,
1440                                                                               Uuid subnetUuid) {
1441         Optional<VpnPortipToPort> gwPortOptional = Optional.absent();
1442         if (subnetUuid != null) {
1443             final Optional<String> gatewayIp = getVpnSubnetGatewayIp(dataBroker, subnetUuid);
1444             if (gatewayIp.isPresent()) {
1445                 String gwIp = gatewayIp.get();
1446                 gwPortOptional = Optional.fromNullable(getNeutronPortFromVpnPortFixedIp(dataBroker, vpnName, gwIp));
1447             }
1448         }
1449         return gwPortOptional;
1450     }
1451
1452     public static Optional<String> getVpnSubnetGatewayIp(DataBroker dataBroker, final Uuid subnetUuid) {
1453         Optional<String> gwIpAddress = Optional.absent();
1454         final SubnetKey subnetkey = new SubnetKey(subnetUuid);
1455         final InstanceIdentifier<Subnet> subnetidentifier = InstanceIdentifier.create(Neutron.class)
1456                 .child(Subnets.class)
1457                 .child(Subnet.class, subnetkey);
1458         final Optional<Subnet> subnet = read(dataBroker, LogicalDatastoreType.CONFIGURATION, subnetidentifier);
1459         if (subnet.isPresent()) {
1460             Class<? extends IpVersionBase> ipVersionBase = subnet.get().getIpVersion();
1461             if (ipVersionBase.equals(IpVersionV4.class)) {
1462                 LOG.trace("getVpnSubnetGatewayIp: Obtained subnet {} for vpn interface",
1463                         subnet.get().getUuid().getValue());
1464                 gwIpAddress = Optional.of(subnet.get().getGatewayIp().getIpv4Address().getValue());
1465                 return gwIpAddress;
1466             }
1467         }
1468         return gwIpAddress;
1469     }
1470
1471     public static RouterToNaptSwitch getRouterToNaptSwitch(DataBroker dataBroker, String routerName) {
1472         InstanceIdentifier<RouterToNaptSwitch> id = InstanceIdentifier.builder(NaptSwitches.class)
1473                 .child(RouterToNaptSwitch.class, new RouterToNaptSwitchKey(routerName)).build();
1474         Optional<RouterToNaptSwitch> routerToNaptSwitchData = read(dataBroker, LogicalDatastoreType.CONFIGURATION, id);
1475         return routerToNaptSwitchData.isPresent() ? routerToNaptSwitchData.get() : null;
1476     }
1477
1478     static InstanceIdentifier<Subnetmap> buildSubnetmapIdentifier(Uuid subnetId) {
1479         return InstanceIdentifier.builder(Subnetmaps.class)
1480         .child(Subnetmap.class, new SubnetmapKey(subnetId)).build();
1481
1482     }
1483
1484     public static BigInteger getPrimarySwitchForRouter(DataBroker dataBroker, String routerName) {
1485         RouterToNaptSwitch routerToNaptSwitch = getRouterToNaptSwitch(dataBroker, routerName);
1486         return routerToNaptSwitch != null ? routerToNaptSwitch.getPrimarySwitchId() : null;
1487     }
1488
1489     static boolean isL3VpnOverVxLan(Long l3Vni) {
1490         return l3Vni != null && l3Vni != 0;
1491     }
1492
1493     static boolean isEvpnOverVxLan(Long l2Vni) { //To be used by RT2
1494         return l2Vni != null && l2Vni != 0;
1495     }
1496
1497     /**
1498      * Retrieves the primary rd of a vpn instance
1499      * Primary rd will be the first rd in the list of rds configured for a vpn instance
1500      * If rd list is empty, primary rd will be vpn instance name
1501      * Use this function only during create operation cycles. For other operations, use getVpnRd() method.
1502      *
1503      * @param dataBroker dataBroker service reference
1504      * @param vpnName Name of the VPN
1505      * @return the primary rd of the VPN
1506      */
1507     public static String getPrimaryRd(DataBroker dataBroker, String vpnName) {
1508         // Retrieves the VPN Route Distinguisher by its Vpn instance name
1509         String rd = getVpnRd(dataBroker, vpnName);
1510         if (rd != null) {
1511             return rd;
1512         }
1513         InstanceIdentifier<VpnInstance> id  = getVpnInstanceIdentifier(vpnName);
1514         Optional<VpnInstance> vpnInstance = VpnUtil.read(dataBroker, LogicalDatastoreType.CONFIGURATION, id);
1515         if (vpnInstance.isPresent()) {
1516             return getPrimaryRd(vpnInstance.get());
1517         }
1518         return vpnName;
1519     }
1520
1521     /**
1522      * Retrieves the primary rd of a vpn instance
1523      * Primary rd will be the first rd in the list of rds configured for a vpn instance
1524      * If rd list is empty, primary rd will be vpn instance name
1525      * Use this function only during create operation cycles. For other operations, use getVpnRd() method.
1526      *
1527      * @param vpnInstance Config Vpn Instance Object
1528      * @return the primary rd of the VPN
1529      */
1530     public static String getPrimaryRd(VpnInstance vpnInstance) {
1531         List<String> rds = null;
1532         if (vpnInstance != null) {
1533             rds = getListOfRdsFromVpnInstance(vpnInstance);
1534         }
1535         return rds == null || rds.isEmpty() ? vpnInstance.getVpnInstanceName() : rds.get(0);
1536     }
1537
1538     public static boolean isBgpVpn(String vpnName, String primaryRd) {
1539         return !vpnName.equals(primaryRd);
1540     }
1541
1542     static java.util.Optional<String> allocateRdForExtraRouteAndUpdateUsedRdsMap(
1543             DataBroker dataBroker, long vpnId, @Nullable Long parentVpnId, String prefix, String vpnName,
1544             String nextHop, BigInteger dpnId, WriteTransaction writeOperTxn) {
1545         //Check if rd is already allocated for this extraroute behind the same VM. If yes, reuse it.
1546         //This is particularly useful during reboot scenarios.
1547         java.util.Optional<String> allocatedRd = VpnExtraRouteHelper
1548                 .getRdAllocatedForExtraRoute(dataBroker, vpnId, prefix, nextHop);
1549         if (allocatedRd.isPresent()) {
1550             return java.util.Optional.of(allocatedRd.get());
1551         }
1552
1553         //Check if rd is already allocated for this extraroute behind the same CSS. If yes, reuse it
1554         List<String> usedRds = VpnExtraRouteHelper.getUsedRds(dataBroker, vpnId, prefix);
1555         for (String usedRd : usedRds) {
1556             Optional<Routes> vpnExtraRoutes = VpnExtraRouteHelper.getVpnExtraroutes(dataBroker,
1557                     vpnName, usedRd, prefix);
1558             if (vpnExtraRoutes.isPresent()) {
1559                 String nextHopIp = vpnExtraRoutes.get().getNexthopIpList().get(0);
1560                 // In case of VPN importing the routes, the interface is not present in the VPN
1561                 // and has to be fetched from the VPN from which it imports
1562                 Optional<Prefixes> prefixToInterface =
1563                         getPrefixToInterface(dataBroker, parentVpnId != null ? parentVpnId : vpnId, nextHopIp);
1564                 if (prefixToInterface.isPresent() && dpnId.equals(prefixToInterface.get().getDpnId())) {
1565                     syncUpdate(dataBroker, LogicalDatastoreType.CONFIGURATION,
1566                             VpnExtraRouteHelper.getUsedRdsIdentifier(vpnId, prefix, nextHop),
1567                             getRdsBuilder(nextHop, usedRd).build());
1568                     return java.util.Optional.of(usedRd);
1569                 }
1570             }
1571         }
1572         List<String> availableRds = getVpnRdsFromVpnInstanceConfig(dataBroker, vpnName);
1573         String rd;
1574         if (availableRds.isEmpty()) {
1575             rd = dpnId.toString();
1576             LOG.debug("Internal vpn {} Returning DpnId {} as rd", vpnName, rd);
1577         } else {
1578             LOG.trace(
1579                     "Removing used rds {} from available rds {} vpnid {} . prefix is {} , vpname- {}, dpnId- {},"
1580                     + " adj - {}", usedRds, availableRds, vpnId, prefix, vpnName, dpnId);
1581             availableRds.removeAll(usedRds);
1582             if (availableRds.isEmpty()) {
1583                 LOG.error("No rd available from VpnInstance to allocate for prefix {}", prefix);
1584                 return java.util.Optional.empty();
1585             }
1586             // If rd is not allocated for this prefix or if extra route is behind different OVS, select a new rd.
1587             rd = availableRds.get(0);
1588         }
1589         syncUpdate(dataBroker, LogicalDatastoreType.CONFIGURATION,
1590                 VpnExtraRouteHelper.getUsedRdsIdentifier(vpnId, prefix, nextHop),
1591                 getRdsBuilder(nextHop, rd).build());
1592         return java.util.Optional.ofNullable(rd);
1593     }
1594
1595     static String getVpnNamePrefixKey(String vpnName, String prefix) {
1596         return vpnName + VpnConstants.SEPARATOR + prefix;
1597     }
1598
1599     static InstanceIdentifier<Adjacency> getAdjacencyIdentifier(String vpnInterfaceName, String ipAddress) {
1600         return InstanceIdentifier.builder(VpnInterfaces.class)
1601                 .child(VpnInterface.class, new VpnInterfaceKey(vpnInterfaceName))
1602                 .augmentation(Adjacencies.class).child(Adjacency.class, new AdjacencyKey(ipAddress)).build();
1603     }
1604
1605     public static List<String> getIpsListFromExternalIps(List<ExternalIps> externalIps) {
1606         if (externalIps == null) {
1607             return Collections.emptyList();
1608         }
1609
1610         return externalIps.stream().map(ExternalIps::getIpAddress).collect(Collectors.toList());
1611     }
1612
1613     static void bindService(final String vpnInstanceName, final String interfaceName, DataBroker dataBroker,
1614                             boolean isTunnelInterface) {
1615         DataStoreJobCoordinator dataStoreCoordinator = DataStoreJobCoordinator.getInstance();
1616         dataStoreCoordinator.enqueueJob(interfaceName,
1617             () -> {
1618                 WriteTransaction writeTxn = dataBroker.newWriteOnlyTransaction();
1619                 BoundServices serviceInfo = isTunnelInterface
1620                         ? VpnUtil.getBoundServicesForTunnelInterface(vpnInstanceName, interfaceName)
1621                         : getBoundServicesForVpnInterface(dataBroker, vpnInstanceName, interfaceName);
1622                 writeTxn.put(LogicalDatastoreType.CONFIGURATION, InterfaceUtils.buildServiceId(interfaceName,
1623                         ServiceIndex.getIndex(NwConstants.L3VPN_SERVICE_NAME, NwConstants.L3VPN_SERVICE_INDEX)),
1624                         serviceInfo, WriteTransaction.CREATE_MISSING_PARENTS);
1625                 return Collections.singletonList(writeTxn.submit());
1626             });
1627     }
1628
1629     static BoundServices getBoundServicesForVpnInterface(DataBroker broker, String vpnName, String interfaceName) {
1630         List<Instruction> instructions = new ArrayList<>();
1631         int instructionKey = 0;
1632         final long vpnId = VpnUtil.getVpnId(broker, vpnName);
1633         List<Action> actions = Collections.singletonList(
1634                 new ActionRegLoad(0, VpnConstants.VPN_REG_ID, 0, VpnConstants.VPN_ID_LENGTH, vpnId).buildAction());
1635         instructions.add(MDSALUtil.buildApplyActionsInstruction(actions, ++instructionKey));
1636         instructions.add(
1637                 MDSALUtil.buildAndGetWriteMetadaInstruction(MetaDataUtil.getVpnIdMetadata(vpnId),
1638                         MetaDataUtil.METADATA_MASK_VRFID, ++instructionKey));
1639         instructions.add(MDSALUtil.buildAndGetGotoTableInstruction(NwConstants.L3_GW_MAC_TABLE,
1640                 ++instructionKey));
1641         BoundServices serviceInfo = InterfaceUtils.getBoundServices(
1642                 String.format("%s.%s.%s", "vpn", vpnName, interfaceName),
1643                 ServiceIndex.getIndex(NwConstants.L3VPN_SERVICE_NAME, NwConstants.L3VPN_SERVICE_INDEX),
1644                 VpnConstants.DEFAULT_FLOW_PRIORITY, NwConstants.COOKIE_VM_INGRESS_TABLE, instructions);
1645         return serviceInfo;
1646     }
1647
1648     static BoundServices getBoundServicesForTunnelInterface(String vpnName, String interfaceName) {
1649         int instructionKey = 0;
1650         List<Instruction> instructions = new ArrayList<>();
1651         instructions.add(MDSALUtil.buildAndGetGotoTableInstruction(
1652                 NwConstants.L3VNI_EXTERNAL_TUNNEL_DEMUX_TABLE, ++instructionKey));
1653         BoundServices serviceInfo = InterfaceUtils.getBoundServices(String.format("%s.%s.%s", "vpn",
1654                 vpnName, interfaceName),
1655                 ServiceIndex.getIndex(NwConstants.L3VPN_SERVICE_NAME,
1656                         NwConstants.L3VNI_EXTERNAL_TUNNEL_DEMUX_TABLE), VpnConstants.DEFAULT_FLOW_PRIORITY,
1657                 NwConstants.COOKIE_VM_INGRESS_TABLE, instructions);
1658         return serviceInfo;
1659     }
1660
1661     static void unbindService(DataBroker dataBroker, final String vpnInterfaceName, boolean isInterfaceStateDown) {
1662         if (!isInterfaceStateDown) {
1663             DataStoreJobCoordinator dataStoreCoordinator = DataStoreJobCoordinator.getInstance();
1664             dataStoreCoordinator.enqueueJob(vpnInterfaceName,
1665                 () -> {
1666                     WriteTransaction writeTxn = dataBroker.newWriteOnlyTransaction();
1667                     writeTxn.delete(LogicalDatastoreType.CONFIGURATION,
1668                             InterfaceUtils.buildServiceId(vpnInterfaceName,
1669                                     ServiceIndex.getIndex(NwConstants.L3VPN_SERVICE_NAME,
1670                                             NwConstants.L3VPN_SERVICE_INDEX)));
1671
1672                     List<ListenableFuture<Void>> futures = new ArrayList<>();
1673                     futures.add(writeTxn.submit());
1674                     return futures;
1675                 });
1676         }
1677     }
1678
1679     static FlowEntity buildFlowEntity(BigInteger dpnId, short tableId, String flowId) {
1680         return new FlowEntityBuilder()
1681             .setDpnId(dpnId)
1682             .setTableId(tableId)
1683             .setFlowId(flowId)
1684             .build();
1685     }
1686
1687     static VrfEntryBase.EncapType getEncapType(boolean isVxLan) {
1688         return isVxLan ? VrfEntryBase.EncapType.Vxlan : VrfEntryBase.EncapType.Mplsgre;
1689     }
1690
1691     static org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets
1692         .Subnets getExternalSubnet(DataBroker dataBroker, Uuid subnetId) {
1693         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets
1694             .Subnets> subnetsIdentifier = InstanceIdentifier.builder(ExternalSubnets.class)
1695                 .child(org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets
1696                         .Subnets.class, new SubnetsKey(subnetId)).build();
1697         Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets.Subnets>
1698             optionalSubnets = VpnUtil.read(dataBroker, LogicalDatastoreType.CONFIGURATION, subnetsIdentifier);
1699         return optionalSubnets.isPresent() ? optionalSubnets.get() : null;
1700     }
1701
1702     static Uuid getSubnetFromExternalRouterByIp(DataBroker dataBroker, Uuid routerId, String ip) {
1703         Routers externalRouter = VpnUtil.getExternalRouter(dataBroker, routerId.getValue());
1704         if (externalRouter != null && externalRouter.getExternalIps() != null) {
1705             for (ExternalIps externalIp : externalRouter.getExternalIps()) {
1706                 if (externalIp.getIpAddress().equals(ip)) {
1707                     return externalIp.getSubnetId();
1708                 }
1709             }
1710         }
1711         return null;
1712     }
1713
1714     static boolean isExternalSubnetVpn(String vpnName, String subnetId) {
1715         return vpnName.equals(subnetId);
1716     }
1717
1718     static Boolean getIsExternal(Network network) {
1719         return network.getAugmentation(NetworkL3Extension.class) != null
1720                 && network.getAugmentation(NetworkL3Extension.class).isExternal();
1721     }
1722
1723     @SuppressWarnings("checkstyle:linelength")
1724     static Network getNeutronNetwork(DataBroker broker, Uuid networkId) {
1725         Network network = null;
1726         LOG.debug("getNeutronNetwork for {}", networkId.getValue());
1727         InstanceIdentifier<Network> inst = InstanceIdentifier.create(Neutron.class).child(
1728                 org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.Networks.class).child(
1729                 Network.class, new NetworkKey(networkId));
1730         Optional<Network> net = read(broker, LogicalDatastoreType.CONFIGURATION, inst);
1731         if (net.isPresent()) {
1732             network = net.get();
1733         }
1734         return network;
1735     }
1736
1737     public static boolean isEligibleForBgp(String rd, String vpnName, BigInteger dpnId, String networkName) {
1738         if (rd != null) {
1739             if (vpnName != null && rd.equals(vpnName)) {
1740                 return false;
1741             }
1742             if (dpnId != null && rd.equals(dpnId.toString())) {
1743                 return false;
1744             }
1745             if (networkName != null && rd.equals(networkName)) {
1746                 return false;
1747             }
1748             return true;
1749         }
1750         return false;
1751     }
1752
1753     static String getFibFlowRef(BigInteger dpnId, short tableId, String vpnName, int priority) {
1754         return VpnConstants.FLOWID_PREFIX + dpnId + NwConstants.FLOWID_SEPARATOR + tableId
1755                 + NwConstants.FLOWID_SEPARATOR + vpnName + NwConstants.FLOWID_SEPARATOR + priority;
1756     }
1757
1758     static void removeExternalTunnelDemuxFlows(String vpnName, DataBroker broker, IMdsalApiManager mdsalManager) {
1759         LOG.info("Removing external tunnel flows for vpn {}", vpnName);
1760         for (BigInteger dpnId: NWUtil.getOperativeDPNs(broker)) {
1761             LOG.debug("Removing external tunnel flows for vpn {} from dpn {}", vpnName, dpnId);
1762             String flowRef = getFibFlowRef(dpnId, NwConstants.L3VNI_EXTERNAL_TUNNEL_DEMUX_TABLE,
1763                     vpnName, VpnConstants.DEFAULT_FLOW_PRIORITY);
1764             FlowEntity flowEntity = VpnUtil.buildFlowEntity(dpnId,
1765                     NwConstants.L3VNI_EXTERNAL_TUNNEL_DEMUX_TABLE, flowRef);
1766             mdsalManager.removeFlow(flowEntity);
1767         }
1768     }
1769
1770     public static boolean isVpnPendingDelete(DataBroker broker, String rd) {
1771         VpnInstanceOpDataEntry vpnInstanceOpData = getVpnInstanceOpData(broker, rd);
1772         boolean isVpnPendingDelete = false;
1773         if (vpnInstanceOpData == null
1774                 || vpnInstanceOpData.getVpnState() == VpnInstanceOpDataEntry.VpnState.PendingDelete) {
1775             isVpnPendingDelete = true;
1776         }
1777         return isVpnPendingDelete;
1778     }
1779 }