neutronvpn/impl/src/main/java/org/opendaylight/netvirt/neutronvpn/NeutronvpnUtils.java

   1 /*
   2  * Copyright (c) 2016, 2018 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.neutronvpn;
  10
  11 import static org.opendaylight.genius.infra.Datastore.OPERATIONAL;
  12
  13 import com.google.common.base.Function;
  14 import com.google.common.base.Optional;
  15 import com.google.common.collect.ImmutableBiMap;
  16 import com.google.common.collect.Sets;
  17 import com.google.common.util.concurrent.FutureCallback;
  18 import com.google.common.util.concurrent.Futures;
  19 import com.google.common.util.concurrent.MoreExecutors;
  20 import com.google.common.util.concurrent.SettableFuture;
  21 import java.math.BigInteger;
  22 import java.net.Inet4Address;
  23 import java.net.Inet6Address;
  24 import java.net.InetAddress;
  25 import java.net.UnknownHostException;
  26 import java.util.ArrayList;
  27 import java.util.Collection;
  28 import java.util.Collections;
  29 import java.util.HashSet;
  30 import java.util.Iterator;
  31 import java.util.List;
  32 import java.util.Map;
  33 import java.util.Set;
  34 import java.util.concurrent.ConcurrentHashMap;
  35 import java.util.concurrent.ConcurrentMap;
  36 import java.util.concurrent.ExecutionException;
  37 import java.util.concurrent.locks.ReentrantLock;
  38 import javax.inject.Inject;
  39 import javax.inject.Singleton;
  40 import org.apache.commons.lang3.StringUtils;
  41 import org.eclipse.jdt.annotation.NonNull;
  42 import org.eclipse.jdt.annotation.Nullable;
  43 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  44 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  45 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  46 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
  47 import org.opendaylight.genius.datastoreutils.SingleTransactionDataBroker;
  48 import org.opendaylight.genius.infra.Datastore;
  49 import org.opendaylight.genius.infra.ManagedNewTransactionRunner;
  50 import org.opendaylight.genius.infra.ManagedNewTransactionRunnerImpl;
  51 import org.opendaylight.genius.infra.TypedWriteTransaction;
  52 import org.opendaylight.genius.mdsalutil.MDSALUtil;
  53 import org.opendaylight.genius.utils.JvmGlobalLocks;
  54 import org.opendaylight.infrautils.jobcoordinator.JobCoordinator;
  55 import org.opendaylight.infrautils.utils.concurrent.ListenableFutures;
  56 import org.opendaylight.infrautils.utils.concurrent.LoggingFutures;
  57 import org.opendaylight.netvirt.neutronvpn.api.enums.IpVersionChoice;
  58 import org.opendaylight.netvirt.neutronvpn.api.utils.NeutronUtils;
  59 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnInstances;
  60 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnInterfaces;
  61 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.instances.VpnInstance;
  62 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.instances.VpnInstanceKey;
  63 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.VpnInterface;
  64 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.VpnInterfaceKey;
  65 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  66 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address;
  67 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.Interfaces;
  68 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
  69 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
  70 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress;
  71 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress;
  72 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid;
  73 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService;
  74 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdInput;
  75 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdInputBuilder;
  76 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdOutput;
  77 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.Dhcpv6Base;
  78 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.InterfaceAclBuilder;
  79 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.IpPrefixOrAddress;
  80 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.IpVersionBase;
  81 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.interfaces._interface.AllowedAddressPairs;
  82 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.interfaces._interface.AllowedAddressPairsBuilder;
  83 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.interfaces._interface.SubnetInfo;
  84 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.interfaces._interface.SubnetInfoBuilder;
  85 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.interfaces._interface.SubnetInfoKey;
  86 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeBase;
  87 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeFlat;
  88 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeGre;
  89 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeVlan;
  90 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeVxlan;
  91 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.elan._interface.StaticMacEntries;
  92 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.elan._interface.StaticMacEntriesBuilder;
  93 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.LearntVpnVipToPortData;
  94 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.NeutronRouterDpns;
  95 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnInstanceOpData;
  96 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnInstanceToVpnId;
  97 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.data.LearntVpnVipToPort;
  98 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.data.LearntVpnVipToPortKey;
  99 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.neutron.router.dpns.RouterDpnList;
 100 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.neutron.router.dpns.RouterDpnListKey;
 101 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.neutron.router.dpns.router.dpn.list.DpnVpninterfacesList;
 102 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntry;
 103 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntryBuilder;
 104 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntryKey;
 105 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ExtRouters;
 106 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ExternalSubnets;
 107 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.FloatingIpPortInfo;
 108 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ProviderTypes;
 109 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext.routers.RoutersKey;
 110 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets.SubnetsKey;
 111 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.floating.ip.port.info.FloatingIpIdToPortMapping;
 112 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.floating.ip.port.info.FloatingIpIdToPortMappingKey;
 113 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.NetworkMaps;
 114 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.NeutronVpnPortipPortData;
 115 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.Subnetmaps;
 116 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.VpnMaps;
 117 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.networkmaps.NetworkMap;
 118 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.networkmaps.NetworkMapKey;
 119 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.neutron.vpn.portip.port.data.VpnPortipToPort;
 120 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.neutron.vpn.portip.port.data.VpnPortipToPortBuilder;
 121 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.neutron.vpn.portip.port.data.VpnPortipToPortKey;
 122 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.subnetmaps.Subnetmap;
 123 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.subnetmaps.SubnetmapKey;
 124 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.vpn.instance.RouterIds;
 125 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.vpn.instance.RouterIdsBuilder;
 126 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.vpnmaps.VpnMap;
 127 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.vpnmaps.VpnMapKey;
 128 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.ext.rev150712.NetworkL3Extension;
 129 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.Routers;
 130 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.routers.Router;
 131 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.routers.RouterKey;
 132 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.routers.router.ExternalGatewayInfo;
 133 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeBase;
 134 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeFlat;
 135 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeGre;
 136 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeVlan;
 137 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeVxlan;
 138 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.Networks;
 139 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.Network;
 140 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.NetworkKey;
 141 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes.FixedIps;
 142 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.Ports;
 143 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.ports.Port;
 144 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.ports.PortKey;
 145 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.portsecurity.rev150712.PortSecurityExtension;
 146 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.provider.ext.rev150712.NetworkProviderExtension;
 147 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.rev150712.Neutron;
 148 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.Subnets;
 149 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.Subnet;
 150 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.SubnetKey;
 151 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.InterVpnLinkStates;
 152 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.InterVpnLinks;
 153 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.inter.vpn.link.states.InterVpnLinkState;
 154 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.inter.vpn.link.states.InterVpnLinkStateKey;
 155 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.inter.vpn.links.InterVpnLink;
 156 import org.opendaylight.yangtools.yang.binding.DataObject;
 157 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
 158 import org.opendaylight.yangtools.yang.common.RpcResult;
 159 import org.slf4j.Logger;
 160 import org.slf4j.LoggerFactory;
 161
 162 @Singleton
 163 public class NeutronvpnUtils {
 164
 165     private static final Logger LOG = LoggerFactory.getLogger(NeutronvpnUtils.class);
 166     private static final ImmutableBiMap<Class<? extends NetworkTypeBase>, Class<? extends SegmentTypeBase>>
 167         NETWORK_MAP =
 168         new ImmutableBiMap.Builder<Class<? extends NetworkTypeBase>, Class<? extends SegmentTypeBase>>()
 169             .put(NetworkTypeFlat.class, SegmentTypeFlat.class)
 170             .put(NetworkTypeGre.class, SegmentTypeGre.class)
 171             .put(NetworkTypeVlan.class, SegmentTypeVlan.class)
 172             .put(NetworkTypeVxlan.class, SegmentTypeVxlan.class)
 173             .build();
 174
 175     private static final Set<Class<? extends NetworkTypeBase>> SUPPORTED_NETWORK_TYPES = new HashSet<>();
 176
 177     static {
 178         SUPPORTED_NETWORK_TYPES.add(NetworkTypeFlat.class);
 179         SUPPORTED_NETWORK_TYPES.add(NetworkTypeVlan.class);
 180         SUPPORTED_NETWORK_TYPES.add(NetworkTypeVxlan.class);
 181         SUPPORTED_NETWORK_TYPES.add(NetworkTypeGre.class);
 182     }
 183
 184     private final ConcurrentMap<Uuid, Network> networkMap = new ConcurrentHashMap<>();
 185     private final ConcurrentMap<Uuid, Router> routerMap = new ConcurrentHashMap<>();
 186     private final ConcurrentMap<Uuid, Port> portMap = new ConcurrentHashMap<>();
 187     private final ConcurrentMap<Uuid, Subnet> subnetMap = new ConcurrentHashMap<>();
 188     private final Map<IpAddress, Set<Uuid>> subnetGwIpMap = new ConcurrentHashMap<>();
 189
 190     private final DataBroker dataBroker;
 191     private final ManagedNewTransactionRunner txRunner;
 192     private final IdManagerService idManager;
 193     private final JobCoordinator jobCoordinator;
 194     private final IPV6InternetDefaultRouteProgrammer ipV6InternetDefRt;
 195     private static final int JOB_MAX_RETRIES = 3;
 196
 197     @Inject
 198     public NeutronvpnUtils(final DataBroker dataBroker, final IdManagerService idManager,
 199             final JobCoordinator jobCoordinator, final IPV6InternetDefaultRouteProgrammer ipV6InternetDefRt) {
 200         this.dataBroker = dataBroker;
 201         this.txRunner = new ManagedNewTransactionRunnerImpl(dataBroker);
 202         this.idManager = idManager;
 203         this.jobCoordinator = jobCoordinator;
 204         this.ipV6InternetDefRt = ipV6InternetDefRt;
 205     }
 206
 207     @Nullable
 208     protected Subnetmap getSubnetmap(Uuid subnetId) {
 209         InstanceIdentifier<Subnetmap> id = buildSubnetMapIdentifier(subnetId);
 210         Optional<Subnetmap> sn = read(LogicalDatastoreType.CONFIGURATION, id);
 211
 212         if (sn.isPresent()) {
 213             return sn.get();
 214         }
 215         LOG.error("getSubnetmap failed, subnet {} is not present", subnetId.getValue());
 216         return null;
 217     }
 218
 219     @Nullable
 220     public VpnMap getVpnMap(Uuid id) {
 221         InstanceIdentifier<VpnMap> vpnMapIdentifier = InstanceIdentifier.builder(VpnMaps.class).child(VpnMap.class,
 222                 new VpnMapKey(id)).build();
 223         Optional<VpnMap> optionalVpnMap = read(LogicalDatastoreType.CONFIGURATION, vpnMapIdentifier);
 224         if (optionalVpnMap.isPresent()) {
 225             return optionalVpnMap.get();
 226         }
 227         LOG.error("getVpnMap failed, VPN {} not present", id.getValue());
 228         return null;
 229     }
 230
 231     @Nullable
 232     protected Uuid getVpnForNetwork(Uuid network) {
 233         InstanceIdentifier<VpnMaps> vpnMapsIdentifier = InstanceIdentifier.builder(VpnMaps.class).build();
 234         Optional<VpnMaps> optionalVpnMaps = read(LogicalDatastoreType.CONFIGURATION, vpnMapsIdentifier);
 235         if (optionalVpnMaps.isPresent() && optionalVpnMaps.get().getVpnMap() != null) {
 236             for (VpnMap vpnMap : optionalVpnMaps.get().nonnullVpnMap()) {
 237                 List<Uuid> netIds = vpnMap.getNetworkIds();
 238                 if (netIds != null && netIds.contains(network)) {
 239                     return vpnMap.getVpnId();
 240                 }
 241             }
 242         }
 243         LOG.debug("getVpnForNetwork: Failed for network {} as no VPN present in VPNMaps DS", network.getValue());
 244         return null;
 245     }
 246
 247     @Nullable
 248     protected Uuid getVpnForSubnet(Uuid subnetId) {
 249         InstanceIdentifier<Subnetmap> subnetmapIdentifier = buildSubnetMapIdentifier(subnetId);
 250         Optional<Subnetmap> optionalSubnetMap = read(LogicalDatastoreType.CONFIGURATION,
 251                 subnetmapIdentifier);
 252         if (optionalSubnetMap.isPresent()) {
 253             return optionalSubnetMap.get().getVpnId();
 254         }
 255         LOG.error("getVpnForSubnet: Failed as subnetMap DS is absent for subnet {}", subnetId.getValue());
 256         return null;
 257     }
 258
 259     @Nullable
 260     protected Uuid getNetworkForSubnet(Uuid subnetId) {
 261         InstanceIdentifier<Subnetmap> subnetmapIdentifier = buildSubnetMapIdentifier(subnetId);
 262         Optional<Subnetmap> optionalSubnetMap = read(LogicalDatastoreType.CONFIGURATION,
 263                 subnetmapIdentifier);
 264         if (optionalSubnetMap.isPresent()) {
 265             return optionalSubnetMap.get().getNetworkId();
 266         }
 267         LOG.error("getNetworkForSubnet: Failed as subnetMap DS is absent for subnet {}", subnetId.getValue());
 268         return null;
 269     }
 270
 271     // @param external vpn - true if external vpn being fetched, false for internal vpn
 272     @Nullable
 273     protected Uuid getVpnForRouter(@Nullable Uuid routerId, boolean externalVpn) {
 274         if (routerId == null) {
 275             return null;
 276         }
 277
 278         InstanceIdentifier<VpnMaps> vpnMapsIdentifier = InstanceIdentifier.builder(VpnMaps.class).build();
 279         Optional<VpnMaps> optionalVpnMaps = read(LogicalDatastoreType.CONFIGURATION, vpnMapsIdentifier);
 280         if (optionalVpnMaps.isPresent() && optionalVpnMaps.get().getVpnMap() != null) {
 281             for (VpnMap vpnMap : optionalVpnMaps.get().nonnullVpnMap()) {
 282                 List<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.vpnmaps.vpnmap
 283                     .RouterIds> routerIdsList = vpnMap.getRouterIds();
 284                 if (routerIdsList == null || routerIdsList.isEmpty()) {
 285                     continue;
 286                 }
 287                 // Skip router vpnId fetching from internet BGP-VPN
 288                 if (vpnMap.getNetworkIds() != null && !vpnMap.getNetworkIds().isEmpty()) {
 289                     // We only need to check the first network; if it’s not an external network there’s no
 290                     // need to check the rest of the VPN’s network list
 291                     if (getIsExternal(getNeutronNetwork(vpnMap.getNetworkIds().iterator().next()))) {
 292                         continue;
 293                     }
 294                 }
 295                 // FIXME: NETVIRT-1503: this check can be replaced by a ReadOnlyTransaction.exists()
 296                 if (routerIdsList.stream().anyMatch(routerIds -> routerId.equals(routerIds.getRouterId()))) {
 297                     if (externalVpn) {
 298                         if (!routerId.equals(vpnMap.getVpnId())) {
 299                             return vpnMap.getVpnId();
 300                         }
 301                     } else {
 302                         if (routerId.equals(vpnMap.getVpnId())) {
 303                             return vpnMap.getVpnId();
 304                         }
 305                     }
 306                 }
 307             }
 308         }
 309         LOG.debug("getVpnForRouter: Failed for router {} as no VPN present in VPNMaps DS", routerId.getValue());
 310         return null;
 311     }
 312
 313     @Nullable
 314     protected List<Uuid> getRouterIdListforVpn(Uuid vpnId) {
 315         InstanceIdentifier<VpnMap> vpnMapIdentifier = InstanceIdentifier.builder(VpnMaps.class).child(VpnMap.class,
 316                 new VpnMapKey(vpnId)).build();
 317         Optional<VpnMap> optionalVpnMap = read(LogicalDatastoreType.CONFIGURATION, vpnMapIdentifier);
 318         if (optionalVpnMap.isPresent()) {
 319             VpnMap vpnMap = optionalVpnMap.get();
 320             return NeutronUtils.getVpnMapRouterIdsListUuid(vpnMap.getRouterIds());
 321         }
 322         LOG.error("getRouterIdListforVpn: Failed as VPNMaps DS is absent for VPN {}", vpnId.getValue());
 323         return null;
 324     }
 325
 326     @Nullable
 327     protected List<Uuid> getNetworksForVpn(Uuid vpnId) {
 328         InstanceIdentifier<VpnMap> vpnMapIdentifier = InstanceIdentifier.builder(VpnMaps.class).child(VpnMap.class,
 329                 new VpnMapKey(vpnId)).build();
 330         Optional<VpnMap> optionalVpnMap = read(LogicalDatastoreType.CONFIGURATION, vpnMapIdentifier);
 331         if (optionalVpnMap.isPresent()) {
 332             VpnMap vpnMap = optionalVpnMap.get();
 333             return vpnMap.getNetworkIds();
 334         }
 335         LOG.error("getNetworksforVpn: Failed as VPNMaps DS is absent for VPN {}", vpnId.getValue());
 336         return null;
 337     }
 338
 339     protected List<Uuid> getSubnetsforVpn(Uuid vpnid) {
 340         List<Uuid> subnets = new ArrayList<>();
 341         // read subnetmaps
 342         InstanceIdentifier<Subnetmaps> subnetmapsid = InstanceIdentifier.builder(Subnetmaps.class).build();
 343         Optional<Subnetmaps> subnetmaps = read(LogicalDatastoreType.CONFIGURATION, subnetmapsid);
 344         if (subnetmaps.isPresent() && subnetmaps.get().getSubnetmap() != null) {
 345             List<Subnetmap> subnetMapList = subnetmaps.get().getSubnetmap();
 346             for (Subnetmap candidateSubnetMap : subnetMapList) {
 347                 if (candidateSubnetMap.getVpnId() != null && candidateSubnetMap.getVpnId().equals(vpnid)) {
 348                     subnets.add(candidateSubnetMap.getId());
 349                 }
 350             }
 351         }
 352         return subnets;
 353     }
 354
 355     @Nullable
 356     protected String getNeutronPortNameFromVpnPortFixedIp(String vpnName, String fixedIp) {
 357         InstanceIdentifier<VpnPortipToPort> id = buildVpnPortipToPortIdentifier(vpnName, fixedIp);
 358         Optional<VpnPortipToPort> vpnPortipToPortData = read(LogicalDatastoreType.CONFIGURATION, id);
 359         if (vpnPortipToPortData.isPresent()) {
 360             return vpnPortipToPortData.get().getPortName();
 361         }
 362         LOG.error("getNeutronPortNameFromVpnPortFixedIp: Failed as vpnPortipToPortData DS is absent for VPN {} and"
 363                 + " fixed IP {}", vpnName, fixedIp);
 364         return null;
 365     }
 366
 367     @Nullable
 368     protected List<Uuid> getSubnetIdsFromNetworkId(Uuid networkId) {
 369         InstanceIdentifier<NetworkMap> id = buildNetworkMapIdentifier(networkId);
 370         Optional<NetworkMap> optionalNetworkMap = read(LogicalDatastoreType.CONFIGURATION, id);
 371         if (optionalNetworkMap.isPresent()) {
 372             return optionalNetworkMap.get().getSubnetIdList();
 373         }
 374         LOG.error("getSubnetIdsFromNetworkId: Failed as networkmap DS is absent for network {}", networkId.getValue());
 375         return null;
 376     }
 377
 378     protected Router getNeutronRouter(Uuid routerId) {
 379         Router router = routerMap.get(routerId);
 380         if (router != null) {
 381             return router;
 382         }
 383         InstanceIdentifier<Router> inst = InstanceIdentifier.create(Neutron.class).child(Routers.class).child(Router
 384                 .class, new RouterKey(routerId));
 385         Optional<Router> rtr = read(LogicalDatastoreType.CONFIGURATION, inst);
 386         if (rtr.isPresent()) {
 387             router = rtr.get();
 388         }
 389         return router;
 390     }
 391
 392     public InstanceIdentifier<Router> getNeutronRouterIid(Uuid routerId) {
 393         return InstanceIdentifier.create(Neutron.class).child(Routers.class).child(Router
 394                 .class, new RouterKey(routerId));
 395
 396     }
 397
 398     protected Network getNeutronNetwork(Uuid networkId) {
 399         Network network = null;
 400         network = networkMap.get(networkId);
 401         if (network != null) {
 402             return network;
 403         }
 404         LOG.debug("getNeutronNetwork for {}", networkId.getValue());
 405         InstanceIdentifier<Network> inst = InstanceIdentifier.create(Neutron.class).child(Networks.class)
 406             .child(Network.class, new NetworkKey(networkId));
 407         Optional<Network> net = read(LogicalDatastoreType.CONFIGURATION, inst);
 408         if (net.isPresent()) {
 409             network = net.get();
 410         }
 411         return network;
 412     }
 413
 414     protected Port getNeutronPort(Uuid portId) {
 415         Port prt = portMap.get(portId);
 416         if (prt != null) {
 417             return prt;
 418         }
 419         LOG.debug("getNeutronPort for {}", portId.getValue());
 420         InstanceIdentifier<Port> inst = InstanceIdentifier.create(Neutron.class).child(Ports.class).child(Port.class,
 421                 new PortKey(portId));
 422         Optional<Port> port = read(LogicalDatastoreType.CONFIGURATION, inst);
 423         if (port.isPresent()) {
 424             prt = port.get();
 425         }
 426         return prt;
 427     }
 428
 429     /**
 430      * Returns port_security_enabled status with the port.
 431      *
 432      * @param port the port
 433      * @return port_security_enabled status
 434      */
 435     protected static boolean getPortSecurityEnabled(Port port) {
 436         String deviceOwner = port.getDeviceOwner();
 437         if (deviceOwner != null && deviceOwner.startsWith("network:")) {
 438             // port with device owner of network:xxx is created by
 439             // neutorn for its internal use. So security group doesn't apply.
 440             // router interface, dhcp port and floating ip.
 441             return false;
 442         }
 443         PortSecurityExtension portSecurity = port.augmentation(PortSecurityExtension.class);
 444         if (portSecurity != null) {
 445             return portSecurity.isPortSecurityEnabled();
 446         }
 447         return false;
 448     }
 449
 450     /**
 451      * Gets security group UUIDs delta   .
 452      *
 453      * @param port1SecurityGroups the port 1 security groups
 454      * @param port2SecurityGroups the port 2 security groups
 455      * @return the security groups delta
 456      */
 457     @Nullable
 458     protected static List<Uuid> getSecurityGroupsDelta(@Nullable List<Uuid> port1SecurityGroups,
 459             @Nullable List<Uuid> port2SecurityGroups) {
 460         if (port1SecurityGroups == null) {
 461             return null;
 462         }
 463
 464         if (port2SecurityGroups == null) {
 465             return port1SecurityGroups;
 466         }
 467
 468         List<Uuid> list1 = new ArrayList<>(port1SecurityGroups);
 469         List<Uuid> list2 = new ArrayList<>(port2SecurityGroups);
 470         for (Iterator<Uuid> iterator = list1.iterator(); iterator.hasNext();) {
 471             Uuid securityGroup1 = iterator.next();
 472             for (Uuid securityGroup2 : list2) {
 473                 if (securityGroup1.getValue().equals(securityGroup2.getValue())) {
 474                     iterator.remove();
 475                     break;
 476                 }
 477             }
 478         }
 479         return list1;
 480     }
 481
 482     /**
 483      * Gets the fixed ips delta.
 484      *
 485      * @param port1FixedIps the port 1 fixed ips
 486      * @param port2FixedIps the port 2 fixed ips
 487      * @return the fixed ips delta
 488      */
 489     protected static List<FixedIps> getFixedIpsDelta(List<FixedIps> port1FixedIps, List<FixedIps> port2FixedIps) {
 490         if (port1FixedIps == null) {
 491             return null;
 492         }
 493
 494         if (port2FixedIps == null) {
 495             return port1FixedIps;
 496         }
 497
 498         List<FixedIps> list1 = new ArrayList<>(port1FixedIps);
 499         List<FixedIps> list2 = new ArrayList<>(port2FixedIps);
 500         for (Iterator<FixedIps> iterator = list1.iterator(); iterator.hasNext();) {
 501             FixedIps fixedIps1 = iterator.next();
 502             for (FixedIps fixedIps2 : list2) {
 503                 if (fixedIps1.getIpAddress().equals(fixedIps2.getIpAddress())) {
 504                     iterator.remove();
 505                     break;
 506                 }
 507             }
 508         }
 509         return list1;
 510     }
 511
 512     /**
 513      * Gets the allowed address pairs delta.
 514      *
 515      * @param port1AllowedAddressPairs the port 1 allowed address pairs
 516      * @param port2AllowedAddressPairs the port 2 allowed address pairs
 517      * @return the allowed address pairs delta
 518      */
 519     @Nullable
 520     protected static List<AllowedAddressPairs> getAllowedAddressPairsDelta(
 521         @Nullable List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
 522             .AllowedAddressPairs> port1AllowedAddressPairs,
 523         @Nullable List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
 524             .AllowedAddressPairs> port2AllowedAddressPairs) {
 525         if (port1AllowedAddressPairs == null) {
 526             return null;
 527         }
 528
 529         if (port2AllowedAddressPairs == null) {
 530             return getAllowedAddressPairsForAclService(port1AllowedAddressPairs);
 531         }
 532
 533         List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
 534             .AllowedAddressPairs> list1 =
 535                 new ArrayList<>(port1AllowedAddressPairs);
 536         List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
 537             .AllowedAddressPairs> list2 =
 538                 new ArrayList<>(port2AllowedAddressPairs);
 539         for (Iterator<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
 540             .AllowedAddressPairs> iterator =
 541              list1.iterator(); iterator.hasNext();) {
 542             org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
 543                 .AllowedAddressPairs allowedAddressPair1 = iterator.next();
 544             for (org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
 545                      .AllowedAddressPairs allowedAddressPair2 : list2) {
 546                 if (allowedAddressPair1.key().equals(allowedAddressPair2.key())) {
 547                     iterator.remove();
 548                     break;
 549                 }
 550             }
 551         }
 552         return getAllowedAddressPairsForAclService(list1);
 553     }
 554
 555     /**
 556      * Gets the acl allowed address pairs.
 557      *
 558      * @param macAddress the mac address
 559      * @param ipAddress the ip address
 560      * @return the acl allowed address pairs
 561      */
 562     protected static AllowedAddressPairs getAclAllowedAddressPairs(MacAddress macAddress,
 563             org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.types.rev160517.IpPrefixOrAddress ipAddress) {
 564         AllowedAddressPairsBuilder aclAllowedAdressPairBuilder = new AllowedAddressPairsBuilder();
 565         aclAllowedAdressPairBuilder.setMacAddress(macAddress);
 566         if (ipAddress != null && ipAddress.stringValue() != null) {
 567             if (ipAddress.getIpPrefix() != null) {
 568                 aclAllowedAdressPairBuilder.setIpAddress(new IpPrefixOrAddress(ipAddress.getIpPrefix()));
 569             } else {
 570                 aclAllowedAdressPairBuilder.setIpAddress(new IpPrefixOrAddress(ipAddress.getIpAddress()));
 571             }
 572         }
 573         return aclAllowedAdressPairBuilder.build();
 574     }
 575
 576     /**
 577      * Gets the allowed address pairs for acl service.
 578      *
 579      * @param macAddress the mac address
 580      * @param fixedIps the fixed ips
 581      * @return the allowed address pairs for acl service
 582      */
 583     protected static List<AllowedAddressPairs> getAllowedAddressPairsForAclService(MacAddress macAddress,
 584             List<FixedIps> fixedIps) {
 585         List<AllowedAddressPairs> aclAllowedAddressPairs = new ArrayList<>();
 586         for (FixedIps fixedIp : fixedIps) {
 587             aclAllowedAddressPairs.add(getAclAllowedAddressPairs(macAddress,
 588                     org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.types.rev160517.IpPrefixOrAddressBuilder
 589                     .getDefaultInstance(fixedIp.getIpAddress().stringValue())));
 590         }
 591         return aclAllowedAddressPairs;
 592     }
 593
 594     /**
 595      * Gets the allowed address pairs for acl service.
 596      *
 597      * @param portAllowedAddressPairs the port allowed address pairs
 598      * @return the allowed address pairs for acl service
 599      */
 600     protected static List<AllowedAddressPairs> getAllowedAddressPairsForAclService(
 601         List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
 602             .AllowedAddressPairs> portAllowedAddressPairs) {
 603         List<AllowedAddressPairs> aclAllowedAddressPairs = new ArrayList<>();
 604         for (org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes.AllowedAddressPairs
 605                  portAllowedAddressPair : portAllowedAddressPairs) {
 606             aclAllowedAddressPairs.add(getAclAllowedAddressPairs(portAllowedAddressPair.getMacAddress(),
 607                 portAllowedAddressPair.getIpAddress()));
 608         }
 609         return aclAllowedAddressPairs;
 610     }
 611
 612     /**
 613      * Gets the IPv6 Link Local Address corresponding to the MAC Address.
 614      *
 615      * @param macAddress the mac address
 616      * @return the allowed address pairs for acl service which includes the MAC + IPv6LLA
 617      */
 618     protected static AllowedAddressPairs updateIPv6LinkLocalAddressForAclService(MacAddress macAddress) {
 619         IpAddress ipv6LinkLocalAddress = getIpv6LinkLocalAddressFromMac(macAddress);
 620         return getAclAllowedAddressPairs(macAddress,
 621                 org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.types.rev160517.IpPrefixOrAddressBuilder
 622                 .getDefaultInstance(
 623                         ipv6LinkLocalAddress.stringValue()));
 624     }
 625
 626     /**
 627      * Gets the updated security groups.
 628      *
 629      * @param aclInterfaceSecurityGroups the acl interface security groups
 630      * @param origSecurityGroups the orig security groups
 631      * @param newSecurityGroups the new security groups
 632      * @return the updated security groups
 633      */
 634     protected static List<Uuid> getUpdatedSecurityGroups(List<Uuid> aclInterfaceSecurityGroups,
 635             List<Uuid> origSecurityGroups, List<Uuid> newSecurityGroups) {
 636         List<Uuid> addedGroups = getSecurityGroupsDelta(newSecurityGroups, origSecurityGroups);
 637         List<Uuid> deletedGroups = getSecurityGroupsDelta(origSecurityGroups, newSecurityGroups);
 638         List<Uuid> updatedSecurityGroups =
 639                 aclInterfaceSecurityGroups != null ? new ArrayList<>(aclInterfaceSecurityGroups) : new ArrayList<>();
 640         if (addedGroups != null) {
 641             updatedSecurityGroups.addAll(addedGroups);
 642         }
 643         if (deletedGroups != null) {
 644             updatedSecurityGroups.removeAll(deletedGroups);
 645         }
 646         return updatedSecurityGroups;
 647     }
 648
 649     /**
 650      * Gets the allowed address pairs for fixed ips.
 651      *
 652      * @param aclInterfaceAllowedAddressPairs the acl interface allowed address pairs
 653      * @param portMacAddress the port mac address
 654      * @param origFixedIps the orig fixed ips
 655      * @param newFixedIps the new fixed ips
 656      * @return the allowed address pairs for fixed ips
 657      */
 658     protected static List<AllowedAddressPairs> getAllowedAddressPairsForFixedIps(
 659             List<AllowedAddressPairs> aclInterfaceAllowedAddressPairs, MacAddress portMacAddress,
 660             List<FixedIps> origFixedIps, List<FixedIps> newFixedIps) {
 661         List<FixedIps> addedFixedIps = getFixedIpsDelta(newFixedIps, origFixedIps);
 662         List<FixedIps> deletedFixedIps = getFixedIpsDelta(origFixedIps, newFixedIps);
 663         List<AllowedAddressPairs> updatedAllowedAddressPairs =
 664             aclInterfaceAllowedAddressPairs != null
 665                 ? new ArrayList<>(aclInterfaceAllowedAddressPairs) : new ArrayList<>();
 666         if (deletedFixedIps != null) {
 667             updatedAllowedAddressPairs.removeAll(getAllowedAddressPairsForAclService(portMacAddress, deletedFixedIps));
 668         }
 669         if (addedFixedIps != null) {
 670             updatedAllowedAddressPairs.addAll(getAllowedAddressPairsForAclService(portMacAddress, addedFixedIps));
 671         }
 672         return updatedAllowedAddressPairs;
 673     }
 674
 675     /**
 676      * Gets the updated allowed address pairs.
 677      *
 678      * @param aclInterfaceAllowedAddressPairs the acl interface allowed address pairs
 679      * @param origAllowedAddressPairs the orig allowed address pairs
 680      * @param newAllowedAddressPairs the new allowed address pairs
 681      * @return the updated allowed address pairs
 682      */
 683     protected static List<AllowedAddressPairs> getUpdatedAllowedAddressPairs(
 684             List<AllowedAddressPairs> aclInterfaceAllowedAddressPairs,
 685             List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
 686                 .AllowedAddressPairs> origAllowedAddressPairs,
 687             List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
 688                 .AllowedAddressPairs> newAllowedAddressPairs) {
 689         List<AllowedAddressPairs> addedAllowedAddressPairs =
 690             getAllowedAddressPairsDelta(newAllowedAddressPairs,origAllowedAddressPairs);
 691         List<AllowedAddressPairs> deletedAllowedAddressPairs =
 692             getAllowedAddressPairsDelta(origAllowedAddressPairs, newAllowedAddressPairs);
 693         List<AllowedAddressPairs> updatedAllowedAddressPairs =
 694             aclInterfaceAllowedAddressPairs != null
 695                 ? new ArrayList<>(aclInterfaceAllowedAddressPairs) : new ArrayList<>();
 696         if (addedAllowedAddressPairs != null) {
 697             updatedAllowedAddressPairs.addAll(addedAllowedAddressPairs);
 698         }
 699         if (deletedAllowedAddressPairs != null) {
 700             updatedAllowedAddressPairs.removeAll(deletedAllowedAddressPairs);
 701         }
 702         return updatedAllowedAddressPairs;
 703     }
 704
 705     /**
 706      * Populate interface acl builder.
 707      *
 708      * @param interfaceAclBuilder the interface acl builder
 709      * @param port the port
 710      */
 711     protected void populateInterfaceAclBuilder(InterfaceAclBuilder interfaceAclBuilder, Port port) {
 712         // Handle security group enabled
 713         List<Uuid> securityGroups = port.getSecurityGroups();
 714         if (securityGroups != null) {
 715             interfaceAclBuilder.setSecurityGroups(securityGroups);
 716         }
 717         List<AllowedAddressPairs> aclAllowedAddressPairs = NeutronvpnUtils.getAllowedAddressPairsForAclService(
 718                 port.getMacAddress(), port.getFixedIps());
 719         // Update the allowed address pair with the IPv6 LLA that is auto configured on the port.
 720         aclAllowedAddressPairs.add(NeutronvpnUtils.updateIPv6LinkLocalAddressForAclService(port.getMacAddress()));
 721         List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes.AllowedAddressPairs>
 722             portAllowedAddressPairs = port.getAllowedAddressPairs();
 723         if (portAllowedAddressPairs != null) {
 724             aclAllowedAddressPairs.addAll(NeutronvpnUtils.getAllowedAddressPairsForAclService(portAllowedAddressPairs));
 725         }
 726         interfaceAclBuilder.setAllowedAddressPairs(aclAllowedAddressPairs);
 727
 728         populateSubnetInfo(interfaceAclBuilder, port);
 729     }
 730
 731     protected void populateSubnetInfo(InterfaceAclBuilder interfaceAclBuilder, Port port) {
 732         List<SubnetInfo> portSubnetInfo = getSubnetInfo(port);
 733         if (portSubnetInfo != null) {
 734             interfaceAclBuilder.setSubnetInfo(portSubnetInfo);
 735         }
 736     }
 737
 738     @Nullable
 739     protected List<SubnetInfo> getSubnetInfo(Port port) {
 740         List<FixedIps> portFixedIps = port.getFixedIps();
 741         if (portFixedIps == null) {
 742             LOG.error("Failed to get Fixed IPs for the port {}", port.getName());
 743             return null;
 744         }
 745         List<SubnetInfo> subnetInfoList = new ArrayList<>();
 746         for (FixedIps portFixedIp : portFixedIps) {
 747             Uuid subnetId = portFixedIp.getSubnetId();
 748             Subnet subnet = getNeutronSubnet(subnetId);
 749             if (subnet != null) {
 750                 Class<? extends IpVersionBase> ipVersion =
 751                         NeutronSecurityRuleConstants.IP_VERSION_MAP.get(subnet.getIpVersion());
 752                 Class<? extends Dhcpv6Base> raMode = subnet.getIpv6RaMode() == null ? null
 753                         : NeutronSecurityRuleConstants.RA_MODE_MAP.get(subnet.getIpv6RaMode());
 754                 SubnetInfo subnetInfo = new SubnetInfoBuilder().withKey(new SubnetInfoKey(subnetId))
 755                         .setIpVersion(ipVersion).setIpPrefix(new IpPrefixOrAddress(subnet.getCidr()))
 756                         .setIpv6RaMode(raMode).setGatewayIp(subnet.getGatewayIp()).build();
 757                 subnetInfoList.add(subnetInfo);
 758             }
 759         }
 760         return subnetInfoList;
 761     }
 762
 763     protected Subnet getNeutronSubnet(Uuid subnetId) {
 764         Subnet subnet = subnetMap.get(subnetId);
 765         if (subnet != null) {
 766             return subnet;
 767         }
 768         InstanceIdentifier<Subnet> inst = InstanceIdentifier.create(Neutron.class).child(Subnets.class).child(Subnet
 769                 .class, new SubnetKey(subnetId));
 770         Optional<Subnet> sn = read(LogicalDatastoreType.CONFIGURATION, inst);
 771
 772         if (sn.isPresent()) {
 773             subnet = sn.get();
 774             addToSubnetCache(subnet);
 775         }
 776         return subnet;
 777     }
 778
 779     protected List<Subnetmap> getNeutronRouterSubnetMapList(Uuid routerId) {
 780         List<Subnetmap> subnetMapList = new ArrayList<>();
 781         Optional<Subnetmaps> subnetMaps = read(LogicalDatastoreType.CONFIGURATION,
 782                 InstanceIdentifier.builder(Subnetmaps.class).build());
 783         if (subnetMaps.isPresent() && subnetMaps.get().getSubnetmap() != null) {
 784             for (Subnetmap subnetmap : subnetMaps.get().getSubnetmap()) {
 785                 if (routerId.equals(subnetmap.getRouterId())) {
 786                     subnetMapList.add(subnetmap);
 787                 }
 788             }
 789         }
 790         LOG.debug("getNeutronRouterSubnetMapList returns {}", subnetMapList);
 791         return subnetMapList;
 792     }
 793
 794     @NonNull
 795     protected List<Uuid> getNeutronRouterSubnetIds(Uuid routerId) {
 796         LOG.debug("getNeutronRouterSubnetIds for {}", routerId.getValue());
 797         List<Uuid> subnetIdList = new ArrayList<>();
 798         Optional<Subnetmaps> subnetMaps = read(LogicalDatastoreType.CONFIGURATION,
 799             InstanceIdentifier.builder(Subnetmaps.class).build());
 800         if (subnetMaps.isPresent() && subnetMaps.get().getSubnetmap() != null) {
 801             for (Subnetmap subnetmap : subnetMaps.get().getSubnetmap()) {
 802                 if (routerId.equals(subnetmap.getRouterId())) {
 803                     subnetIdList.add(subnetmap.getId());
 804                 }
 805             }
 806         }
 807         LOG.debug("getNeutronRouterSubnetIds returns {}", subnetIdList);
 808         return subnetIdList;
 809     }
 810
 811     // TODO Clean up the exception handling and the console output
 812     @SuppressWarnings({"checkstyle:IllegalCatch", "checkstyle:RegexpSinglelineJava"})
 813     @Nullable
 814     protected Short getIPPrefixFromPort(Port port) {
 815         try {
 816             Uuid subnetUUID = port.getFixedIps().get(0).getSubnetId();
 817             SubnetKey subnetkey = new SubnetKey(subnetUUID);
 818             InstanceIdentifier<Subnet> subnetidentifier = InstanceIdentifier.create(Neutron.class).child(Subnets
 819                     .class).child(Subnet.class, subnetkey);
 820             Optional<Subnet> subnet = read(LogicalDatastoreType.CONFIGURATION, subnetidentifier);
 821             if (subnet.isPresent()) {
 822                 String cidr = subnet.get().getCidr().stringValue();
 823                 // Extract the prefix length from cidr
 824                 String[] parts = cidr.split("/");
 825                 if (parts.length == 2) {
 826                     return Short.valueOf(parts[1]);
 827                 } else {
 828                     LOG.trace("Could not retrieve prefix from subnet CIDR");
 829                 }
 830             } else {
 831                 LOG.trace("Unable to read on subnet datastore");
 832             }
 833         } catch (Exception e) {
 834             LOG.error("Failed to retrieve IP prefix from port for port {}", port.getUuid().getValue(), e);
 835         }
 836         LOG.error("Failed for port {}", port.getUuid().getValue());
 837         return null;
 838     }
 839
 840     // TODO Clean up the exception handling
 841     @SuppressWarnings("checkstyle:IllegalCatch")
 842     protected void createVpnPortFixedIpToPort(String vpnName, String fixedIp, String portName, String macAddress,
 843             boolean isSubnetIp, TypedWriteTransaction<Datastore.Configuration> writeConfigTxn) {
 844         InstanceIdentifier<VpnPortipToPort> id = NeutronvpnUtils.buildVpnPortipToPortIdentifier(vpnName, fixedIp);
 845         VpnPortipToPortBuilder builder = new VpnPortipToPortBuilder()
 846             .withKey(new VpnPortipToPortKey(fixedIp, vpnName))
 847             .setVpnName(vpnName).setPortFixedip(fixedIp)
 848             .setPortName(portName).setMacAddress(macAddress).setSubnetIp(isSubnetIp);
 849         try {
 850             if (writeConfigTxn != null) {
 851                 writeConfigTxn.put(id, builder.build());
 852             } else {
 853                 MDSALUtil.syncWrite(dataBroker, LogicalDatastoreType.CONFIGURATION, id, builder.build());
 854             }
 855             LOG.trace("Neutron port with fixedIp: {}, vpn {}, interface {}, mac {}, isSubnetIp {} added to "
 856                 + "VpnPortipToPort DS", fixedIp, vpnName, portName, macAddress, isSubnetIp);
 857         } catch (Exception e) {
 858             LOG.error("Failure while creating VPNPortFixedIpToPort map for vpn {} - fixedIP {}", vpnName, fixedIp,
 859                     e);
 860         }
 861     }
 862
 863     // TODO Clean up the exception handling
 864     @SuppressWarnings("checkstyle:IllegalCatch")
 865     protected void removeVpnPortFixedIpToPort(String vpnName, String fixedIp,
 866                                               TypedWriteTransaction<Datastore.Configuration> writeConfigTxn) {
 867         InstanceIdentifier<VpnPortipToPort> id = NeutronvpnUtils.buildVpnPortipToPortIdentifier(vpnName, fixedIp);
 868         try {
 869             if (writeConfigTxn != null) {
 870                 writeConfigTxn.delete(id);
 871             } else {
 872                 MDSALUtil.syncDelete(dataBroker, LogicalDatastoreType.CONFIGURATION, id);
 873             }
 874             LOG.trace("Neutron router port with fixedIp: {}, vpn {} removed from VpnPortipToPort DS", fixedIp,
 875                     vpnName);
 876         } catch (Exception e) {
 877             LOG.error("Failure while removing VPNPortFixedIpToPort map for vpn {} - fixedIP {}", vpnName, fixedIp,
 878                     e);
 879         }
 880     }
 881
 882     // TODO Clean up the exception handling
 883     @SuppressWarnings("checkstyle:IllegalCatch")
 884     protected void removeLearntVpnVipToPort(String vpnName, String fixedIp) {
 885         InstanceIdentifier<LearntVpnVipToPort> id = NeutronvpnUtils.buildLearntVpnVipToPortIdentifier(vpnName, fixedIp);
 886         // FIXME: can we use 'id' as the lock name?
 887         final ReentrantLock lock = JvmGlobalLocks.getLockForString(vpnName + fixedIp);
 888         lock.lock();
 889         try {
 890             MDSALUtil.syncDelete(dataBroker, LogicalDatastoreType.OPERATIONAL, id);
 891             LOG.trace("Neutron router port with fixedIp: {}, vpn {} removed from LearntVpnPortipToPort DS", fixedIp,
 892                     vpnName);
 893         } catch (Exception e) {
 894             LOG.error("Failure while removing LearntVpnPortFixedIpToPort map for vpn {} - fixedIP {}",
 895                 vpnName, fixedIp, e);
 896         } finally {
 897             lock.unlock();
 898         }
 899     }
 900
 901     public void addToNetworkCache(Network network) {
 902         networkMap.put(network.getUuid(), network);
 903     }
 904
 905     public void removeFromNetworkCache(Network network) {
 906         networkMap.remove(network.getUuid());
 907     }
 908
 909     public void addToRouterCache(Router router) {
 910         routerMap.put(router.getUuid(), router);
 911     }
 912
 913     public void removeFromRouterCache(Router router) {
 914         routerMap.remove(router.getUuid());
 915     }
 916
 917     public Collection<Router> getAllRouters() {
 918         return routerMap.values();
 919     }
 920
 921     public void addToPortCache(Port port) {
 922         portMap.put(port.getUuid(), port);
 923     }
 924
 925     public void removeFromPortCache(Port port) {
 926         portMap.remove(port.getUuid());
 927     }
 928
 929     public void addToSubnetCache(Subnet subnet) {
 930         subnetMap.put(subnet.getUuid(), subnet);
 931         IpAddress gatewayIp = subnet.getGatewayIp();
 932         if (gatewayIp != null) {
 933             subnetGwIpMap.computeIfAbsent(gatewayIp, k -> Sets.newConcurrentHashSet()).add(subnet.getUuid());
 934         }
 935     }
 936
 937     public void removeFromSubnetCache(Subnet subnet) {
 938         subnetMap.remove(subnet.getUuid());
 939         IpAddress gatewayIp = subnet.getGatewayIp();
 940         if (gatewayIp != null) {
 941             Set<Uuid> gwIps = subnetGwIpMap.get(gatewayIp);
 942             if (gwIps != null) {
 943                 gwIps.remove(subnet.getUuid());
 944             }
 945         }
 946     }
 947
 948     public static String getSegmentationIdFromNeutronNetwork(Network network) {
 949         String segmentationId = null;
 950         NetworkProviderExtension providerExtension = network.augmentation(NetworkProviderExtension.class);
 951         if (providerExtension != null) {
 952             Class<? extends NetworkTypeBase> networkType = providerExtension.getNetworkType();
 953             segmentationId = NeutronUtils.getSegmentationIdFromNeutronNetwork(network, networkType);
 954         }
 955
 956         return segmentationId;
 957     }
 958
 959     public static Class<? extends SegmentTypeBase> getSegmentTypeFromNeutronNetwork(Network network) {
 960         NetworkProviderExtension providerExtension = network.augmentation(NetworkProviderExtension.class);
 961         return providerExtension != null ? NETWORK_MAP.get(providerExtension.getNetworkType()) : null;
 962     }
 963
 964     public static String getPhysicalNetworkName(Network network) {
 965         NetworkProviderExtension providerExtension = network.augmentation(NetworkProviderExtension.class);
 966         return providerExtension != null ? providerExtension.getPhysicalNetwork() : null;
 967     }
 968
 969     public Collection<Uuid> getSubnetIdsForGatewayIp(IpAddress ipAddress) {
 970         return subnetGwIpMap.getOrDefault(ipAddress, Collections.emptySet());
 971     }
 972
 973     static InstanceIdentifier<VpnPortipToPort> buildVpnPortipToPortIdentifier(String vpnName, String fixedIp) {
 974         InstanceIdentifier<VpnPortipToPort> id =
 975             InstanceIdentifier.builder(NeutronVpnPortipPortData.class)
 976                 .child(VpnPortipToPort.class, new VpnPortipToPortKey(fixedIp, vpnName)).build();
 977         return id;
 978     }
 979
 980     static InstanceIdentifier<LearntVpnVipToPort> buildLearntVpnVipToPortIdentifier(String vpnName, String fixedIp) {
 981         InstanceIdentifier<LearntVpnVipToPort> id =
 982             InstanceIdentifier.builder(LearntVpnVipToPortData.class)
 983                 .child(LearntVpnVipToPort.class, new LearntVpnVipToPortKey(fixedIp, vpnName)).build();
 984         return id;
 985     }
 986
 987     static Boolean getIsExternal(Network network) {
 988         return network.augmentation(NetworkL3Extension.class) != null
 989                 && network.augmentation(NetworkL3Extension.class).isExternal();
 990     }
 991
 992     static InstanceIdentifier<NetworkMap> buildNetworkMapIdentifier(Uuid networkId) {
 993         InstanceIdentifier<NetworkMap> id = InstanceIdentifier.builder(NetworkMaps.class).child(NetworkMap.class, new
 994                 NetworkMapKey(networkId)).build();
 995         return id;
 996     }
 997
 998     static InstanceIdentifier<VpnInterface> buildVpnInterfaceIdentifier(String ifName) {
 999         InstanceIdentifier<VpnInterface> id = InstanceIdentifier.builder(VpnInterfaces.class).child(VpnInterface
1000                 .class, new VpnInterfaceKey(ifName)).build();
1001         return id;
1002     }
1003
1004     static InstanceIdentifier<Subnetmap> buildSubnetMapIdentifier(Uuid subnetId) {
1005         InstanceIdentifier<Subnetmap> id = InstanceIdentifier.builder(Subnetmaps.class).child(Subnetmap.class, new
1006                 SubnetmapKey(subnetId)).build();
1007         return id;
1008     }
1009
1010     static InstanceIdentifier<Interface> buildVlanInterfaceIdentifier(String interfaceName) {
1011         InstanceIdentifier<Interface> id = InstanceIdentifier.builder(Interfaces.class).child(Interface.class, new
1012                 InterfaceKey(interfaceName)).build();
1013         return id;
1014     }
1015
1016     static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext
1017             .routers.Routers> buildExtRoutersIdentifier(Uuid routerId) {
1018         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext.routers
1019                 .Routers> id = InstanceIdentifier.builder(ExtRouters.class).child(org.opendaylight.yang.gen.v1.urn
1020                 .opendaylight.netvirt.natservice.rev160111.ext.routers.Routers.class, new RoutersKey(routerId
1021                 .getValue())).build();
1022         return id;
1023     }
1024
1025     static InstanceIdentifier<FloatingIpIdToPortMapping> buildfloatingIpIdToPortMappingIdentifier(Uuid floatingIpId) {
1026         return InstanceIdentifier.builder(FloatingIpPortInfo.class).child(FloatingIpIdToPortMapping.class, new
1027                 FloatingIpIdToPortMappingKey(floatingIpId)).build();
1028     }
1029
1030     // TODO Remove this method entirely
1031     @SuppressWarnings("checkstyle:IllegalCatch")
1032     private <T extends DataObject> Optional<T> read(LogicalDatastoreType datastoreType, InstanceIdentifier<T> path) {
1033         try {
1034             return SingleTransactionDataBroker.syncReadOptional(dataBroker, datastoreType, path);
1035         } catch (ReadFailedException e) {
1036             throw new RuntimeException(e);
1037         }
1038     }
1039
1040     @Nullable
1041     static ProviderTypes getProviderNetworkType(Network network) {
1042         if (network == null) {
1043             LOG.error("Error in getting provider network type since network is null");
1044             return null;
1045         }
1046         NetworkProviderExtension npe = network.augmentation(NetworkProviderExtension.class);
1047         if (npe != null) {
1048             Class<? extends NetworkTypeBase> networkTypeBase = npe.getNetworkType();
1049             if (networkTypeBase != null) {
1050                 if (networkTypeBase.isAssignableFrom(NetworkTypeFlat.class)) {
1051                     return ProviderTypes.FLAT;
1052                 } else if (networkTypeBase.isAssignableFrom(NetworkTypeVlan.class)) {
1053                     return ProviderTypes.VLAN;
1054                 } else if (networkTypeBase.isAssignableFrom(NetworkTypeVxlan.class)) {
1055                     return ProviderTypes.VXLAN;
1056                 } else if (networkTypeBase.isAssignableFrom(NetworkTypeGre.class)) {
1057                     return ProviderTypes.GRE;
1058                 }
1059             }
1060         }
1061         LOG.error("Error in getting provider network type since network provider extension is null for network "
1062                 + "{}", network.getUuid().getValue());
1063         return null;
1064     }
1065
1066     static boolean isNetworkTypeSupported(Network network) {
1067         NetworkProviderExtension npe = network.augmentation(NetworkProviderExtension.class);
1068         return npe != null && npe.getNetworkType() != null && SUPPORTED_NETWORK_TYPES.contains(npe.getNetworkType());
1069     }
1070
1071     static boolean isNetworkOfType(Network network, Class<? extends NetworkTypeBase> type) {
1072         NetworkProviderExtension npe = network.augmentation(NetworkProviderExtension.class);
1073         if (npe != null && npe.getNetworkType() != null) {
1074             return type.isAssignableFrom(npe.getNetworkType());
1075         }
1076         return false;
1077     }
1078
1079     static boolean isFlatOrVlanNetwork(Network network) {
1080         return network != null
1081                 && (isNetworkOfType(network, NetworkTypeVlan.class) || isNetworkOfType(network, NetworkTypeFlat.class));
1082     }
1083
1084     static boolean isVlanOrVxlanNetwork(Class<? extends NetworkTypeBase> type) {
1085         return type.isAssignableFrom(NetworkTypeVxlan.class) || type.isAssignableFrom(NetworkTypeVlan.class);
1086     }
1087
1088     /**
1089      * Get inter-VPN link state.
1090      *
1091      * @param vpnLinkName VPN link name
1092      * @return Optional of InterVpnLinkState
1093      */
1094     public Optional<InterVpnLinkState> getInterVpnLinkState(String vpnLinkName) {
1095         InstanceIdentifier<InterVpnLinkState> vpnLinkStateIid = InstanceIdentifier.builder(InterVpnLinkStates.class)
1096                 .child(InterVpnLinkState.class, new InterVpnLinkStateKey(vpnLinkName)).build();
1097         return read(LogicalDatastoreType.CONFIGURATION, vpnLinkStateIid);
1098     }
1099
1100     /**
1101      * Returns an InterVpnLink by searching by one of its endpoint's IP.
1102      *
1103      * @param endpointIp IP to search for
1104      * @return a InterVpnLink
1105      */
1106     public Optional<InterVpnLink> getInterVpnLinkByEndpointIp(String endpointIp) {
1107         InstanceIdentifier<InterVpnLinks> interVpnLinksIid = InstanceIdentifier.builder(InterVpnLinks.class).build();
1108         Optional<InterVpnLinks> interVpnLinksOpData = MDSALUtil.read(dataBroker, LogicalDatastoreType.CONFIGURATION,
1109                 interVpnLinksIid);
1110         if (interVpnLinksOpData.isPresent()) {
1111             for (InterVpnLink interVpnLink : interVpnLinksOpData.get().nonnullInterVpnLink()) {
1112                 if (interVpnLink.getFirstEndpoint().getIpAddress().getValue().equals(endpointIp)
1113                         || interVpnLink.getSecondEndpoint().getIpAddress().getValue().equals(endpointIp)) {
1114                     return Optional.of(interVpnLink);
1115                 }
1116             }
1117         }
1118         return Optional.absent();
1119     }
1120
1121     protected void releaseRDId(String poolName, String idKey) {
1122         ReleaseIdInput idInput = new ReleaseIdInputBuilder().setPoolName(poolName).setIdKey(idKey).build();
1123         try {
1124             RpcResult<ReleaseIdOutput> rpcResult = idManager.releaseId(idInput).get();
1125             if (!rpcResult.isSuccessful()) {
1126                 LOG.error("RPC Call to Get Unique Id returned with errors for poolname {} and ID Key {}: {}",
1127                         poolName, idKey, rpcResult.getErrors());
1128             } else {
1129                 LOG.info("ID {} for RD released successfully", idKey);
1130             }
1131         } catch (InterruptedException | ExecutionException e) {
1132             LOG.error("Exception when trying to release ID for poolname {} and ID Key {}", poolName, idKey, e);
1133         }
1134     }
1135
1136     protected static IpAddress getIpv6LinkLocalAddressFromMac(MacAddress mac) {
1137         byte[] octets = bytesFromHexString(mac.getValue());
1138
1139         /* As per the RFC2373, steps involved to generate a LLA include
1140            1. Convert the 48 bit MAC address to 64 bit value by inserting 0xFFFE
1141               between OUI and NIC Specific part.
1142            2. Invert the Universal/Local flag in the OUI portion of the address.
1143            3. Use the prefix "FE80::/10" along with the above 64 bit Interface
1144               identifier to generate the IPv6 LLA. */
1145
1146         StringBuilder interfaceID = new StringBuilder();
1147         short u8byte = (short) (octets[0] & 0xff);
1148         u8byte ^= 1 << 1;
1149         interfaceID.append(Integer.toHexString(0xFF & u8byte));
1150         interfaceID.append(StringUtils.leftPad(Integer.toHexString(0xFF & octets[1]), 2, "0"));
1151         interfaceID.append(":");
1152         interfaceID.append(Integer.toHexString(0xFF & octets[2]));
1153         interfaceID.append("ff:fe");
1154         interfaceID.append(StringUtils.leftPad(Integer.toHexString(0xFF & octets[3]), 2, "0"));
1155         interfaceID.append(":");
1156         interfaceID.append(Integer.toHexString(0xFF & octets[4]));
1157         interfaceID.append(StringUtils.leftPad(Integer.toHexString(0xFF & octets[5]), 2, "0"));
1158
1159         Ipv6Address ipv6LLA = new Ipv6Address("fe80:0:0:0:" + interfaceID.toString());
1160         IpAddress ipAddress = new IpAddress(ipv6LLA);
1161         return ipAddress;
1162     }
1163
1164     protected static byte[] bytesFromHexString(String values) {
1165         String target = "";
1166         if (values != null) {
1167             target = values;
1168         }
1169         String[] octets = target.split(":");
1170
1171         byte[] ret = new byte[octets.length];
1172         for (int i = 0; i < octets.length; i++) {
1173             ret[i] = Integer.valueOf(octets[i], 16).byteValue();
1174         }
1175         return ret;
1176     }
1177
1178     public List<String> getExistingRDs() {
1179         List<String> existingRDs = new ArrayList<>();
1180         InstanceIdentifier<VpnInstances> path = InstanceIdentifier.builder(VpnInstances.class).build();
1181         Optional<VpnInstances> vpnInstancesOptional = read(LogicalDatastoreType.CONFIGURATION, path);
1182         if (vpnInstancesOptional.isPresent() && vpnInstancesOptional.get().getVpnInstance() != null) {
1183             for (VpnInstance vpnInstance : vpnInstancesOptional.get().getVpnInstance()) {
1184                 if (vpnInstance.getIpv4Family() == null) {
1185                     continue;
1186                 }
1187                 List<String> rds = vpnInstance.getIpv4Family().getRouteDistinguisher();
1188                 if (rds != null) {
1189                     existingRDs.addAll(rds);
1190                 }
1191             }
1192         }
1193         return existingRDs;
1194     }
1195
1196     protected boolean doesVpnExist(Uuid vpnId) {
1197         InstanceIdentifier<VpnMap> vpnMapIdentifier = InstanceIdentifier.builder(VpnMaps.class).child(VpnMap.class,
1198                 new VpnMapKey(vpnId)).build();
1199         return read(LogicalDatastoreType.CONFIGURATION, vpnMapIdentifier).isPresent();
1200     }
1201
1202     protected Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external
1203         .subnets.Subnets> getOptionalExternalSubnets(Uuid subnetId) {
1204         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice
1205             .rev160111.external.subnets.Subnets> subnetsIdentifier =
1206                 InstanceIdentifier.builder(ExternalSubnets.class)
1207                 .child(org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice
1208                         .rev160111.external.subnets.Subnets.class, new SubnetsKey(subnetId)).build();
1209         return read(LogicalDatastoreType.CONFIGURATION, subnetsIdentifier);
1210     }
1211
1212     public static List<StaticMacEntries> buildStaticMacEntry(Port port) {
1213         PhysAddress physAddress = new PhysAddress(port.getMacAddress().getValue());
1214         List<FixedIps> fixedIps = port.getFixedIps();
1215         IpAddress ipAddress = null;
1216         if (isNotEmpty(fixedIps)) {
1217             ipAddress = port.getFixedIps().get(0).getIpAddress();
1218         }
1219         StaticMacEntriesBuilder staticMacEntriesBuilder = new StaticMacEntriesBuilder();
1220         List<StaticMacEntries> staticMacEntries = new ArrayList<>();
1221         if (ipAddress != null) {
1222             staticMacEntries.add(staticMacEntriesBuilder.setMacAddress(physAddress).setIpPrefix(ipAddress).build());
1223         } else {
1224             staticMacEntries.add(staticMacEntriesBuilder.setMacAddress(physAddress).build());
1225         }
1226         return staticMacEntries;
1227     }
1228
1229     public static boolean isEmpty(Collection<?> collection) {
1230         return collection == null || collection.isEmpty();
1231     }
1232
1233     public static boolean isNotEmpty(Collection<?> collection) {
1234         return !isEmpty(collection);
1235     }
1236
1237     /**
1238      * Method to get an ipVersionChosen as IPV4 and/or IPV6 or undefined from the subnetmaps of the router.
1239      * @param routerUuid the Uuid for which find out the IP version associated
1240      * @return an IpVersionChoice used by the router from its attached subnetmaps. IpVersionChoice.UNDEFINED if any
1241      */
1242     public IpVersionChoice getIpVersionChoicesFromRouterUuid(Uuid routerUuid) {
1243         IpVersionChoice rep = IpVersionChoice.UNDEFINED;
1244         if (routerUuid == null) {
1245             return rep;
1246         }
1247         List<Subnetmap> subnetmapList = getNeutronRouterSubnetMaps(routerUuid);
1248         if (subnetmapList.isEmpty()) {
1249             return rep;
1250         }
1251         for (Subnetmap sn : subnetmapList) {
1252             if (sn.getSubnetIp() != null) {
1253                 IpVersionChoice ipVers = getIpVersionFromString(sn.getSubnetIp());
1254                 if (rep.choice != ipVers.choice) {
1255                     rep = rep.addVersion(ipVers);
1256                 }
1257                 if (rep.choice == IpVersionChoice.IPV4AND6.choice) {
1258                     return rep;
1259                 }
1260             }
1261         }
1262         return rep;
1263     }
1264
1265     /**This method return the list of Subnetmap associated to the router or a empty list if any.
1266      * @param routerId the Uuid of router for which subnetmap is find out
1267      * @return a list of Subnetmap associated to the router. it could be empty if any
1268      */
1269     protected List<Subnetmap> getNeutronRouterSubnetMaps(Uuid routerId) {
1270         List<Subnetmap> subnetIdList = new ArrayList<>();
1271         Optional<Subnetmaps> subnetMaps = read(LogicalDatastoreType.CONFIGURATION,
1272             InstanceIdentifier.builder(Subnetmaps.class).build());
1273         if (subnetMaps.isPresent() && subnetMaps.get().getSubnetmap() != null) {
1274             for (Subnetmap subnetmap : subnetMaps.get().getSubnetmap()) {
1275                 if (routerId.equals(subnetmap.getRouterId())) {
1276                     subnetIdList.add(subnetmap);
1277                 }
1278             }
1279         }
1280         return subnetIdList;
1281     }
1282
1283     static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
1284         .instance.to.vpn.id.VpnInstance> getVpnInstanceToVpnIdIdentifier(String vpnName) {
1285         return InstanceIdentifier.builder(VpnInstanceToVpnId.class)
1286             .child(org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
1287                     .instance.to.vpn.id.VpnInstance.class,
1288                 new org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
1289                     .instance.to.vpn.id.VpnInstanceKey(vpnName)).build();
1290     }
1291
1292     /**
1293      * Retrieves the VPN Route Distinguisher searching by its Vpn instance name.
1294      * @param vpnName Name of the VPN
1295      *
1296      * @return the route-distinguisher of the VPN
1297      */
1298     @Nullable
1299     public String getVpnRd(String vpnName) {
1300         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
1301             .instance.to.vpn.id.VpnInstance> id = getVpnInstanceToVpnIdIdentifier(vpnName);
1302         return SingleTransactionDataBroker.syncReadOptionalAndTreatReadFailedExceptionAsAbsentOptional(dataBroker,
1303                 LogicalDatastoreType.CONFIGURATION, id).toJavaUtil().map(
1304                 org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id
1305                         .VpnInstance::getVrfId).orElse(null);
1306     }
1307
1308     /**Get IpVersionChoice from String IP like x.x.x.x or an representation IPv6.
1309      * @param ipAddress String of an representation IP address V4 or V6
1310      * @return the IpVersionChoice of the version or IpVersionChoice.UNDEFINED otherwise
1311      */
1312     public static IpVersionChoice getIpVersionFromString(String ipAddress) {
1313         IpVersionChoice ipchoice = IpVersionChoice.UNDEFINED;
1314         if (ipAddress.contains("/")) {
1315             ipAddress = ipAddress.substring(0, ipAddress.indexOf("/"));
1316         }
1317         try {
1318             InetAddress address = InetAddress.getByName(ipAddress);
1319             if (address instanceof Inet4Address) {
1320                 return IpVersionChoice.IPV4;
1321             } else if (address instanceof Inet6Address) {
1322                 return IpVersionChoice.IPV6;
1323             }
1324         } catch (UnknownHostException | SecurityException e) {
1325             LOG.error("getIpVersionFromString: could not  find version for {}", ipAddress);
1326         }
1327         return ipchoice;
1328     }
1329
1330     /**Get IpVersionChoice from Uuid Subnet.
1331      * @param sm Subnetmap structure
1332      * @return the IpVersionChoice of the version or IpVersionChoice.UNDEFINED otherwise
1333      */
1334     public static IpVersionChoice getIpVersionFromSubnet(Subnetmap sm) {
1335         if (sm != null && sm.getSubnetIp() != null) {
1336             return getIpVersionFromString(sm.getSubnetIp());
1337         }
1338         return IpVersionChoice.UNDEFINED;
1339     }
1340
1341     @Nullable
1342     public VpnInstanceOpDataEntry getVpnInstanceOpDataEntryFromVpnId(String vpnName) {
1343         String primaryRd = getVpnRd(vpnName);
1344         if (primaryRd == null) {
1345             LOG.error("getVpnInstanceOpDataEntryFromVpnId: Vpn Instance {} "
1346                      + "Primary RD not found", vpnName);
1347             return null;
1348         }
1349         InstanceIdentifier<VpnInstanceOpDataEntry> id = getVpnOpDataIdentifier(primaryRd);
1350         Optional<VpnInstanceOpDataEntry> vpnInstanceOpDataEntryOptional = read(LogicalDatastoreType.OPERATIONAL, id);
1351         if (!vpnInstanceOpDataEntryOptional.isPresent()) {
1352             LOG.error("getVpnInstanceOpDataEntryFromVpnId: VpnInstance {} not found", primaryRd);
1353             return null;
1354         }
1355         return vpnInstanceOpDataEntryOptional.get();
1356     }
1357
1358     protected InstanceIdentifier<VpnInstanceOpDataEntry> getVpnOpDataIdentifier(String primaryRd) {
1359         return InstanceIdentifier.builder(VpnInstanceOpData.class)
1360                 .child(VpnInstanceOpDataEntry.class, new VpnInstanceOpDataEntryKey(primaryRd)).build();
1361     }
1362
1363     public boolean shouldVpnHandleIpVersionChoiceChange(IpVersionChoice ipVersion, Uuid routerId, boolean add) {
1364         int subnetCount = -1;
1365         if (ipVersion.isIpVersionChosen(IpVersionChoice.IPV4)) {
1366             subnetCount = getSubnetCountFromRouter(routerId, ipVersion);
1367         } else if (ipVersion.isIpVersionChosen(IpVersionChoice.IPV6)) {
1368             subnetCount = getSubnetCountFromRouter(routerId, ipVersion);
1369         } else {
1370             //Possible value of ipversion choice is either V4 or V6 only. Not accepted V4andV6 and Undefined
1371             return false;
1372         }
1373         /* ADD: Update vpnInstanceOpDataEntry with address family only on first IPv4/IPv6 subnet
1374          * for the VPN Instance.
1375          *
1376          * REMOVE: Update vpnInstanceOpDataEntry with address family only on last IPv4/IPv6 subnet
1377          * for the VPN Instance.
1378          */
1379         if (add && subnetCount == 1) {
1380             return true;
1381         } else if (!add && subnetCount == 0) {
1382             return true;
1383         } else {
1384             return false;
1385         }
1386     }
1387
1388     public boolean shouldVpnHandleIpVersionChangeToRemove(Subnetmap sm, Uuid vpnId) {
1389         if (sm == null) {
1390             return false;
1391         }
1392         InstanceIdentifier<Subnetmaps> subnetMapsId = InstanceIdentifier.builder(Subnetmaps.class).build();
1393         Optional<Subnetmaps> allSubnetMaps = read(LogicalDatastoreType.CONFIGURATION, subnetMapsId);
1394         // calculate and store in list IpVersion for each subnetMap, belonging to current VpnInstance
1395         List<IpVersionChoice> snIpVersions = new ArrayList<>();
1396         for (Subnetmap snMap : allSubnetMaps.get().nonnullSubnetmap()) {
1397             if (snMap.getId().equals(sm.getId())) {
1398                 continue;
1399             }
1400             if (snMap.getVpnId() != null && snMap.getVpnId().equals(vpnId)) {
1401                 snIpVersions.add(getIpVersionFromString(snMap.getSubnetIp()));
1402             }
1403             if (snMap.getInternetVpnId() != null && snMap.getInternetVpnId().equals(vpnId)) {
1404                 snIpVersions.add(getIpVersionFromString(snMap.getSubnetIp()));
1405             }
1406         }
1407         IpVersionChoice ipVersion = getIpVersionFromString(sm.getSubnetIp());
1408         if (!snIpVersions.contains(ipVersion)) {
1409             return true;
1410         }
1411         return false;
1412     }
1413
1414     public int getSubnetCountFromRouter(Uuid routerId, IpVersionChoice ipVer) {
1415         List<Subnetmap> subnetMapList = getNeutronRouterSubnetMapList(routerId);
1416         int subnetCount = 0;
1417         for (Subnetmap subMap : subnetMapList) {
1418             IpVersionChoice ipVersion = getIpVersionFromString(subMap.getSubnetIp());
1419             if (ipVersion.isIpVersionChosen(ipVer)) {
1420                 subnetCount++;
1421             }
1422             if (subnetCount > 1) {
1423                 break;
1424             }
1425         }
1426         return subnetCount;
1427     }
1428
1429     public void updateVpnInstanceWithIpFamily(String vpnName, IpVersionChoice ipVersion, boolean add) {
1430         jobCoordinator.enqueueJob("VPN-" + vpnName, () -> {
1431             VpnInstanceOpDataEntry vpnInstanceOpDataEntry = getVpnInstanceOpDataEntryFromVpnId(vpnName);
1432             if (vpnInstanceOpDataEntry == null) {
1433                 return Collections.emptyList();
1434             }
1435             if (vpnInstanceOpDataEntry.getType() == VpnInstanceOpDataEntry.Type.L2) {
1436                 LOG.debug("updateVpnInstanceWithIpFamily: Update VpnInstance {} with ipFamily {}."
1437                         + "VpnInstanceOpDataEntry is L2 instance. Do nothing.", vpnName, ipVersion);
1438                 return Collections.emptyList();
1439             }
1440             if (ipVersion == IpVersionChoice.UNDEFINED) {
1441                 LOG.debug("updateVpnInstanceWithIpFamily: Update VpnInstance {} with Undefined address family"
1442                         + "is not allowed. Do nothing", vpnName);
1443                 return Collections.emptyList();
1444             }
1445             VpnInstanceOpDataEntryBuilder builder = new VpnInstanceOpDataEntryBuilder(vpnInstanceOpDataEntry);
1446             boolean ipConfigured = add;
1447             if (ipVersion.isIpVersionChosen(IpVersionChoice.IPV4AND6)) {
1448                 builder.setIpv4Configured(ipConfigured);
1449                 builder.setIpv6Configured(ipConfigured);
1450             } else if (ipVersion.isIpVersionChosen(IpVersionChoice.IPV4)) {
1451                 builder.setIpv4Configured(ipConfigured);
1452             } else if (ipVersion.isIpVersionChosen(IpVersionChoice.IPV6)) {
1453                 builder.setIpv6Configured(ipConfigured);
1454             }
1455             return Collections.singletonList(txRunner.callWithNewWriteOnlyTransactionAndSubmit(
1456                     OPERATIONAL, tx -> {
1457                     InstanceIdentifier<VpnInstanceOpDataEntry> id = InstanceIdentifier
1458                             .builder(VpnInstanceOpData.class).child(VpnInstanceOpDataEntry.class,
1459                                         new VpnInstanceOpDataEntryKey(vpnInstanceOpDataEntry.getVrfId())).build();
1460                     tx.merge(id, builder.build(), false);
1461                     LOG.info("updateVpnInstanceWithIpFamily: Successfully {} {} to Vpn {}",
1462                             add == true ? "added" : "removed", ipVersion, vpnName);
1463                 }));
1464         });
1465     }
1466
1467     /**
1468      * Get the vpnInstance from its Uuid.
1469      *
1470      * @param broker to get informations from ds
1471      * @param vpnId the Uuid of the VPN
1472      * @return the VpnInstance or null if unfindable
1473      */
1474     @Nullable
1475     public VpnInstance getVpnInstance(DataBroker broker, Uuid vpnId) {
1476         if (broker == null || vpnId == null) {
1477             return null;
1478         }
1479         InstanceIdentifier<VpnInstance> id = InstanceIdentifier.builder(VpnInstances.class).child(VpnInstance.class,
1480                 new VpnInstanceKey(vpnId.getValue())).build();
1481         Optional<VpnInstance> vpnInstance = read(LogicalDatastoreType.CONFIGURATION, id);
1482         return vpnInstance.isPresent() ? vpnInstance.get() : null;
1483     }
1484
1485     /**
1486      *Get the Uuid of external network of the router (remember you that one router have only one external network).
1487      * @param routerId the Uuid of the router which you try to reach the external network
1488      * @return Uuid of externalNetwork or null if is not exist
1489      */
1490     protected Uuid getExternalNetworkUuidAttachedFromRouterUuid(@NonNull Uuid routerId) {
1491         LOG.debug("getExternalNetworkUuidAttachedFromRouterUuid for {}", routerId.getValue());
1492         Uuid externalNetworkUuid = null;
1493         Router router = getNeutronRouter(routerId);
1494         if (router != null && router.getExternalGatewayInfo() != null) {
1495             externalNetworkUuid = router.getExternalGatewayInfo().getExternalNetworkId();
1496         }
1497         return externalNetworkUuid;
1498     }
1499
1500     public Uuid getInternetvpnUuidBoundToRouterId(@NonNull Uuid routerId) {
1501         Uuid netId = getExternalNetworkUuidAttachedFromRouterUuid(routerId);
1502         if (netId == null) {
1503             return netId;
1504         }
1505         return getVpnForNetwork(netId);
1506     }
1507
1508     /**
1509      * This method get Uuid of internet vpn if existing one bound to the same router of the subnetUuid arg.
1510      * Explanation: If the subnet (of arg subnetUuid) have a router bound and this router have an
1511      * externalVpn (vpn on externalProvider network) then <b>its Uuid</b> will be returned.
1512      * @param subnetUuid Uuid of subnet where you are finding a link to an external network
1513      * @return Uuid of externalVpn or null if it is not found
1514      */
1515     @Nullable
1516     public Uuid getInternetvpnUuidBoundToSubnetRouter(@NonNull Uuid subnetUuid) {
1517         Subnetmap subnetmap = getSubnetmap(subnetUuid);
1518         Uuid routerUuid = subnetmap.getRouterId();
1519         LOG.debug("getInternetvpnUuidBoundToSubnetRouter for subnetUuid {}", subnetUuid.getValue());
1520         if (routerUuid == null) {
1521             return null;
1522         }
1523         Uuid externalNetworkUuid = getExternalNetworkUuidAttachedFromRouterUuid(routerUuid);
1524         return externalNetworkUuid != null ? getVpnForNetwork(externalNetworkUuid) : null;
1525     }
1526
1527     /**
1528      * Get a list of Private Subnetmap Ids from router to export then its prefixes in Internet VPN.
1529      * @param extNet Provider Network, which has a port attached as external network gateway to router
1530      * @return a list of Private Subnetmap Ids of the router with external network gateway
1531      */
1532     public @NonNull List<Uuid> getPrivateSubnetsToExport(@NonNull Network extNet, Uuid internetVpnId) {
1533         List<Uuid> subList = new ArrayList<>();
1534         List<Uuid> rtrList = new ArrayList<>();
1535         if (internetVpnId != null) {
1536             rtrList.addAll(getRouterIdListforVpn(internetVpnId));
1537         } else {
1538             Uuid extNwVpnId = getVpnForNetwork(extNet.getUuid());
1539             rtrList.addAll(getRouterIdListforVpn(extNwVpnId));
1540         }
1541         if (rtrList.isEmpty()) {
1542             return subList;
1543         }
1544         for (Uuid rtrId: rtrList) {
1545             Router router = getNeutronRouter(rtrId);
1546             ExternalGatewayInfo info = router.getExternalGatewayInfo();
1547             if (info == null) {
1548                 LOG.error("getPrivateSubnetsToExport: can not get info about external gateway for router {}",
1549                           router.getUuid().getValue());
1550                 continue;
1551             }
1552             // check that router really has given provider network as its external gateway port
1553             if (!extNet.getUuid().equals(info.getExternalNetworkId())) {
1554                 LOG.error("getPrivateSubnetsToExport: router {} is not attached to given provider network {}",
1555                           router.getUuid().getValue(), extNet.getUuid().getValue());
1556                 continue;
1557             }
1558             subList.addAll(getNeutronRouterSubnetIds(rtrId));
1559         }
1560         return subList;
1561     }
1562
1563     public void updateVpnInstanceWithFallback(Uuid routerId, Uuid vpnName, boolean add) {
1564         VpnInstanceOpDataEntry vpnInstanceOpDataEntry = getVpnInstanceOpDataEntryFromVpnId(vpnName.getValue());
1565         if (vpnInstanceOpDataEntry == null) {
1566             LOG.error("updateVpnInstanceWithFallback: vpnInstanceOpDataEntry not found for vpn {}", vpnName);
1567             return;
1568         }
1569         Long internetBgpVpnId = vpnInstanceOpDataEntry.getVpnId();
1570         List<Uuid> routerIds = new ArrayList<>();
1571         //Handle router specific V6 internet fallback flow else handle all V6 external routers
1572         if (routerId != null) {
1573             routerIds.add(routerId);
1574         } else {
1575             //This block will execute for ext-nw to Internet VPN association/disassociation event.
1576             routerIds = getRouterIdListforVpn(vpnName);
1577         }
1578         if (routerIds == null || routerIds.isEmpty()) {
1579             LOG.error("updateVpnInstanceWithFallback: router not found for vpn {}", vpnName);
1580             return;
1581         }
1582         for (Uuid rtrId: routerIds) {
1583             if (rtrId == null) {
1584                 continue;
1585             }
1586             List<BigInteger> dpnIds = getDpnsForRouter(rtrId.getValue());
1587             if (dpnIds.isEmpty()) {
1588                 continue;
1589             }
1590             VpnInstanceOpDataEntry vpnOpDataEntry = getVpnInstanceOpDataEntryFromVpnId(rtrId.getValue());
1591             Long routerIdAsLong = vpnOpDataEntry.getVpnId();
1592             long vpnId;
1593             Uuid rtrVpnId = getVpnForRouter(rtrId, true);
1594             if (rtrVpnId == null) {
1595                 //If external BGP-VPN is not associated with router then routerId is same as routerVpnId
1596                 vpnId = routerIdAsLong;
1597             } else {
1598                 vpnId = getVpnId(rtrVpnId.getValue());
1599             }
1600             for (BigInteger dpnId : dpnIds) {
1601                 if (add) {
1602                     LoggingFutures.addErrorLogging(
1603                         txRunner.callWithNewWriteOnlyTransactionAndSubmit(Datastore.CONFIGURATION,
1604                             tx -> ipV6InternetDefRt.installDefaultRoute(tx, dpnId, rtrId.getValue(), internetBgpVpnId,
1605                                 vpnId)), LOG, "Error adding default route");
1606                 } else {
1607                     LoggingFutures.addErrorLogging(
1608                         txRunner.callWithNewReadWriteTransactionAndSubmit(Datastore.CONFIGURATION,
1609                             tx -> ipV6InternetDefRt.removeDefaultRoute(tx, dpnId, rtrId.getValue(), internetBgpVpnId,
1610                                 vpnId)), LOG,
1611                         "Error removing default route");
1612                 }
1613             }
1614         }
1615     }
1616
1617     public void updateVpnInstanceOpWithType(VpnInstanceOpDataEntry.BgpvpnType choice, @NonNull Uuid vpn) {
1618         String primaryRd = getVpnRd(vpn.getValue());
1619         if (primaryRd == null) {
1620             LOG.debug("updateVpnInstanceOpWithType: Update BgpvpnType {} for {}."
1621                     + "Primary RD not found", choice, vpn.getValue());
1622             return;
1623         }
1624         InstanceIdentifier<VpnInstanceOpDataEntry> id = InstanceIdentifier.builder(VpnInstanceOpData.class)
1625               .child(VpnInstanceOpDataEntry.class, new VpnInstanceOpDataEntryKey(primaryRd)).build();
1626
1627         Optional<VpnInstanceOpDataEntry> vpnInstanceOpDataEntryOptional =
1628             read(LogicalDatastoreType.OPERATIONAL, id);
1629         if (!vpnInstanceOpDataEntryOptional.isPresent()) {
1630             LOG.debug("updateVpnInstanceOpWithType: Update BgpvpnType {} for {}."
1631                     + "VpnInstanceOpDataEntry not found", choice, vpn.getValue());
1632             return;
1633         }
1634         VpnInstanceOpDataEntry vpnInstanceOpDataEntry = vpnInstanceOpDataEntryOptional.get();
1635         if (vpnInstanceOpDataEntry.getBgpvpnType().equals(choice)) {
1636             LOG.debug("updateVpnInstanceOpWithType: Update BgpvpnType {} for {}."
1637                     + "VpnInstanceOpDataEntry already set", choice, vpn.getValue());
1638             return;
1639         }
1640         VpnInstanceOpDataEntryBuilder builder = new VpnInstanceOpDataEntryBuilder(vpnInstanceOpDataEntry);
1641         builder.setBgpvpnType(choice);
1642         ListenableFutures.addErrorLogging(txRunner.callWithNewWriteOnlyTransactionAndSubmit(OPERATIONAL, tx -> {
1643             tx.merge(id, builder.build(), false);
1644             LOG.debug("updateVpnInstanceOpWithType: sent merge to operDS BgpvpnType {} for {}", choice, vpn.getValue());
1645         }), LOG, "Error updating VPN instance op {} with type {}", vpn, choice);
1646     }
1647
1648     public static RouterIds getvpnInstanceRouterIds(Uuid routerId) {
1649         return new RouterIdsBuilder().setRouterId(routerId).build();
1650     }
1651
1652     public static List<RouterIds> getVpnInstanceRouterIdsList(List<Uuid> routerIds) {
1653         List<RouterIds> listRouterIds = new ArrayList<>();
1654         for (Uuid routerId : routerIds) {
1655             final RouterIds routerIdInstance = getvpnInstanceRouterIds(routerId);
1656             listRouterIds.add(routerIdInstance);
1657         }
1658         return listRouterIds;
1659     }
1660
1661     @NonNull
1662     public List<BigInteger> getDpnsForRouter(String routerUuid) {
1663         InstanceIdentifier id = InstanceIdentifier.builder(NeutronRouterDpns.class)
1664             .child(RouterDpnList.class, new RouterDpnListKey(routerUuid)).build();
1665         Optional<RouterDpnList> routerDpnListData =
1666                 SingleTransactionDataBroker.syncReadOptionalAndTreatReadFailedExceptionAsAbsentOptional(dataBroker,
1667                         LogicalDatastoreType.OPERATIONAL, id);
1668         List<BigInteger> dpns = new ArrayList<>();
1669         if (routerDpnListData.isPresent()) {
1670             for (DpnVpninterfacesList dpnVpnInterface : routerDpnListData.get().nonnullDpnVpninterfacesList()) {
1671                 dpns.add(dpnVpnInterface.getDpnId());
1672             }
1673         }
1674         return dpns;
1675     }
1676
1677     @Nullable
1678     List<Subnetmap> getSubnetmapListFromNetworkId(Uuid networkId) {
1679         List<Uuid> subnetIdList = getSubnetIdsFromNetworkId(networkId);
1680         if (subnetIdList != null) {
1681             List<Subnetmap> subnetmapList = new ArrayList<>();
1682             for (Uuid subnetId : subnetIdList) {
1683                 Subnetmap subnetmap = getSubnetmap(subnetId);
1684                 if (subnetmap != null) {
1685                     subnetmapList.add(subnetmap);
1686                 } else {
1687                     LOG.error("getSubnetmapListFromNetworkId: subnetmap is null for subnet {} belonging to network {}",
1688                             subnetId.getValue(), networkId.getValue());
1689                 }
1690             }
1691             return subnetmapList;
1692         }
1693         LOG.error("getSubnetmapListFromNetworkId: Failed as subnetIdList is null for network {}",
1694                 networkId.getValue());
1695         return null;
1696     }
1697
1698     @Nullable
1699     public long getVpnId(String vpnName) {
1700         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
1701                 .instance.to.vpn.id.VpnInstance> id = getVpnInstanceToVpnIdIdentifier(vpnName);
1702         return SingleTransactionDataBroker.syncReadOptionalAndTreatReadFailedExceptionAsAbsentOptional(dataBroker,
1703                 LogicalDatastoreType.CONFIGURATION, id).toJavaUtil().map(
1704                 org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id
1705                         .VpnInstance::getVpnId).orElse(null);
1706     }
1707
1708     protected boolean isV6SubnetPartOfRouter(Uuid routerId) {
1709         List<Subnetmap> subnetList = getNeutronRouterSubnetMapList(routerId);
1710         for (Subnetmap sm : subnetList) {
1711             if (sm == null) {
1712                 continue;
1713             }
1714             IpVersionChoice ipVers = getIpVersionFromString(sm.getSubnetIp());
1715             //skip further subnet processing once found first V6 subnet for the router
1716             if (ipVers.isIpVersionChosen(IpVersionChoice.IPV6)) {
1717                 return true;
1718             }
1719         }
1720         return false;
1721     }
1722
1723     @SuppressWarnings({ "unchecked", "rawtypes" })
1724     public <T extends DataObject> void asyncReadAndExecute(final LogicalDatastoreType datastoreType,
1725                                                            final InstanceIdentifier<T> iid, final String jobKey,
1726                                                            final Function<Optional<T>, Void> function) {
1727         jobCoordinator.enqueueJob(jobKey, () -> {
1728             SettableFuture<Optional<T>> settableFuture = SettableFuture.create();
1729             List futures = Collections.singletonList(settableFuture);
1730             try (ReadOnlyTransaction tx = dataBroker.newReadOnlyTransaction()) {
1731                 Futures.addCallback(tx.read(datastoreType, iid),
1732                         new SettableFutureCallback<Optional<T>>(settableFuture) {
1733                             @Override
1734                             public void onSuccess(Optional<T> data) {
1735                                 function.apply(data);
1736                                 super.onSuccess(data);
1737                             }
1738                         }, MoreExecutors.directExecutor());
1739
1740                 return futures;
1741             }
1742         }, JOB_MAX_RETRIES);
1743     }
1744
1745     private class SettableFutureCallback<T> implements FutureCallback<T> {
1746
1747         private final SettableFuture<T> settableFuture;
1748
1749         SettableFutureCallback(SettableFuture<T> settableFuture) {
1750             this.settableFuture = settableFuture;
1751         }
1752
1753         @Override
1754         public void onSuccess(T objT) {
1755             settableFuture.set(objT);
1756         }
1757
1758         @Override
1759         public void onFailure(Throwable throwable) {
1760             settableFuture.setException(throwable);
1761         }
1762     }
1763 }
1764