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