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