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

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