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