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

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