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