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