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