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

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