vpnservice/vpnmanager/vpnmanager-impl/src/main/java/org/opendaylight/netvirt/vpnmanager/VpnUtil.java

   1 /*
   2  * Copyright © 2016, 2017 Ericsson India Global Services Pvt Ltd. and others. All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8
   9 package org.opendaylight.netvirt.vpnmanager;
  10
  11 import com.google.common.base.Optional;
  12 import com.google.common.util.concurrent.CheckedFuture;
  13 import com.google.common.util.concurrent.FutureCallback;
  14 import com.google.common.util.concurrent.Futures;
  15 import com.google.common.util.concurrent.ListenableFuture;
  16
  17 import java.math.BigInteger;
  18 import java.util.ArrayList;
  19 import java.util.Collections;
  20 import java.util.List;
  21 import java.util.concurrent.ExecutionException;
  22 import java.util.concurrent.Future;
  23 import java.util.stream.Collectors;
  24
  25 import org.apache.commons.lang3.tuple.ImmutablePair;
  26 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  27 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  28 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  29 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipService;
  30 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  31 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  32 import org.opendaylight.genius.mdsalutil.FlowEntity;
  33 import org.opendaylight.genius.mdsalutil.InstructionInfo;
  34 import org.opendaylight.genius.mdsalutil.MDSALUtil;
  35 import org.opendaylight.genius.mdsalutil.MatchInfo;
  36 import org.opendaylight.genius.mdsalutil.MetaDataUtil;
  37 import org.opendaylight.genius.mdsalutil.NwConstants;
  38 import org.opendaylight.genius.mdsalutil.instructions.InstructionGotoTable;
  39 import org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager;
  40 import org.opendaylight.genius.mdsalutil.matches.MatchEthernetDestination;
  41 import org.opendaylight.genius.mdsalutil.matches.MatchMetadata;
  42 import org.opendaylight.genius.utils.cache.DataStoreCache;
  43 import org.opendaylight.genius.utils.clustering.ClusteringUtils;
  44 import org.opendaylight.netvirt.bgpmanager.api.IBgpManager;
  45 import org.opendaylight.netvirt.fibmanager.api.RouteOrigin;
  46 import org.opendaylight.netvirt.neutronvpn.interfaces.INeutronVpnManager;
  47 import org.opendaylight.netvirt.vpnmanager.utilities.InterfaceUtils;
  48 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnAfConfig;
  49 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnInstances;
  50 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnInterfaces;
  51 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.instances.VpnInstance;
  52 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.instances.VpnInstanceKey;
  53 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.VpnInterface;
  54 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.VpnInterfaceBuilder;
  55 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.VpnInterfaceKey;
  56 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  57 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.Interfaces;
  58 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
  59 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
  60 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress;
  61 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress;
  62 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdInput;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdInputBuilder;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdOutput;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdPools;
  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.id.pools.IdPool;
  71 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.id.pools.IdPoolKey;
  72 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406.IfIndexesInterfaceMap;
  73 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406._if.indexes._interface.map.IfIndexInterface;
  74 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406._if.indexes._interface.map.IfIndexInterfaceKey;
  75 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.OdlInterfaceRpcService;
  76 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.LockManagerService;
  77 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.TimeUnits;
  78 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.TryLockInput;
  79 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.TryLockInputBuilder;
  80 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.UnlockInput;
  81 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.UnlockInputBuilder;
  82 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.ElanTagNameMap;
  83 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.tag.name.map.ElanTagName;
  84 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.tag.name.map.ElanTagNameKey;
  85 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.ExtrarouteRdsMap;
  86 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.FibEntries;
  87 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.extraroute.rds.map.ExtrarouteRds;
  88 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.extraroute.rds.map.ExtrarouteRdsKey;
  89 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.extraroute.rds.map.extraroute.rds.DestPrefixes;
  90 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.extraroute.rds.map.extraroute.rds.DestPrefixesBuilder;
  91 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.extraroute.rds.map.extraroute.rds.DestPrefixesKey;
  92 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.fibentries.VrfTables;
  93 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.fibentries.VrfTablesKey;
  94 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.vrfentries.VrfEntry;
  95 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.vrfentries.VrfEntryKey;
  96 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3nexthop.rev150409.L3nexthop;
  97 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3nexthop.rev150409.l3nexthop.VpnNexthops;
  98 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3nexthop.rev150409.l3nexthop.VpnNexthopsKey;
  99 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.Adjacencies;
 100 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.AdjacenciesBuilder;
 101 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.LearntVpnVipToPortData;
 102 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.PrefixToInterface;
 103 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.RouterInterfaces;
 104 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnIdToVpnInstance;
 105 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnInstanceOpData;
 106 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnInstanceToVpnId;
 107 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnToExtraroutes;
 108 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.adjacency.list.Adjacency;
 109 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.data.LearntVpnVipToPort;
 110 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.data.LearntVpnVipToPortBuilder;
 111 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.data.LearntVpnVipToPortKey;
 112 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.prefix.to._interface.VpnIds;
 113 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.prefix.to._interface.VpnIdsBuilder;
 114 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.prefix.to._interface.VpnIdsKey;
 115 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.prefix.to._interface.vpn.ids.Prefixes;
 116 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.prefix.to._interface.vpn.ids.PrefixesBuilder;
 117 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.prefix.to._interface.vpn.ids.PrefixesKey;
 118 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.router.interfaces.RouterInterface;
 119 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.router.interfaces.RouterInterfaceBuilder;
 120 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.router.interfaces.RouterInterfaceKey;
 121 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntry;
 122 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntryKey;
 123 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.VpnToDpnList;
 124 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.VpnToDpnListKey;
 125 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstanceBuilder;
 126 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.to.extraroutes.Vpn;
 127 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.to.extraroutes.VpnKey;
 128 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.to.extraroutes.vpn.ExtraRoutes;
 129 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.to.extraroutes.vpn.ExtraRoutesKey;
 130 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.to.extraroutes.vpn.extra.routes.Routes;
 131 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.to.extraroutes.vpn.extra.routes.RoutesBuilder;
 132 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.to.extraroutes.vpn.extra.routes.RoutesKey;
 133 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ExtRouters;
 134 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ExternalNetworks;
 135 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.NaptSwitches;
 136 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext.routers.Routers;
 137 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext.routers.RoutersKey;
 138 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext.routers.routers.ExternalIps;
 139 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.networks.Networks;
 140 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.networks.NetworksKey;
 141 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.napt.switches.RouterToNaptSwitch;
 142 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.napt.switches.RouterToNaptSwitchKey;
 143 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.NeutronVpnPortipPortData;
 144 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.RouterInterfacesMap;
 145 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.Subnetmaps;
 146 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.neutron.vpn.portip.port.data.VpnPortipToPort;
 147 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.neutron.vpn.portip.port.data.VpnPortipToPortKey;
 148 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.subnetmaps.Subnetmap;
 149 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.constants.rev150712.IpVersionBase;
 150 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.constants.rev150712.IpVersionV4;
 151 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.ports.Port;
 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.yangtools.yang.binding.DataObject;
 157 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
 158 import org.opendaylight.yangtools.yang.common.RpcResult;
 159 import org.opendaylight.yangtools.yang.data.impl.schema.tree.SchemaValidationFailedException;
 160 import org.slf4j.Logger;
 161 import org.slf4j.LoggerFactory;
 162
 163 public class VpnUtil {
 164     private static final Logger LOG = LoggerFactory.getLogger(VpnUtil.class);
 165     private static final int DEFAULT_PREFIX_LENGTH = 32;
 166     private static final String PREFIX_SEPARATOR = "/";
 167
 168     static InstanceIdentifier<VpnInterface> getVpnInterfaceIdentifier(String vpnInterfaceName) {
 169         return InstanceIdentifier.builder(VpnInterfaces.class)
 170             .child(VpnInterface.class, new VpnInterfaceKey(vpnInterfaceName)).build();
 171     }
 172
 173     static InstanceIdentifier<VpnInstance> getVpnInstanceIdentifier(String vpnName) {
 174         return InstanceIdentifier.builder(VpnInstances.class)
 175             .child(VpnInstance.class, new VpnInstanceKey(vpnName)).build();
 176     }
 177
 178     static VpnInterface getVpnInterface(String intfName, String vpnName, Adjacencies aug, BigInteger dpnId,
 179         Boolean isSheduledForRemove) {
 180         return new VpnInterfaceBuilder().setKey(new VpnInterfaceKey(intfName)).setVpnInstanceName(vpnName).setDpnId(
 181             dpnId)
 182             .setScheduledForRemove(isSheduledForRemove).addAugmentation(Adjacencies.class, aug)
 183             .build();
 184     }
 185
 186     static InstanceIdentifier<Prefixes> getPrefixToInterfaceIdentifier(long vpnId, String ipPrefix) {
 187         return InstanceIdentifier.builder(PrefixToInterface.class)
 188             .child(VpnIds.class, new VpnIdsKey(vpnId)).child(Prefixes.class,
 189                 new PrefixesKey(ipPrefix)).build();
 190     }
 191
 192     static InstanceIdentifier<VpnIds> getPrefixToInterfaceIdentifier(long vpnId) {
 193         return InstanceIdentifier.builder(PrefixToInterface.class)
 194             .child(VpnIds.class, new VpnIdsKey(vpnId)).build();
 195     }
 196
 197     static VpnIds getPrefixToInterface(long vpnId) {
 198         return new VpnIdsBuilder().setKey(new VpnIdsKey(vpnId)).setVpnId(vpnId).build();
 199     }
 200
 201     static Prefixes getPrefixToInterface(BigInteger dpId, String vpnInterfaceName, String ipPrefix) {
 202         return new PrefixesBuilder().setDpnId(dpId).setVpnInterfaceName(
 203             vpnInterfaceName).setIpAddress(ipPrefix).build();
 204     }
 205
 206     static Optional<Prefixes> getPrefixToInterface(DataBroker broker, long vpnId, String ipPrefix) {
 207         return read(broker, LogicalDatastoreType.OPERATIONAL,
 208                 getPrefixToInterfaceIdentifier(vpnId, getIpPrefix(ipPrefix)));
 209     }
 210
 211     static  InstanceIdentifier<Routes> getVpnToExtrarouteIdentifier(String vpnName, String vrfId, String ipPrefix) {
 212         return InstanceIdentifier.builder(VpnToExtraroutes.class)
 213                 .child(Vpn.class, new VpnKey(vpnName)).child(ExtraRoutes.class,
 214                         new ExtraRoutesKey(vrfId)).child(Routes.class, new RoutesKey(ipPrefix)).build();
 215     }
 216
 217     static  InstanceIdentifier<ExtraRoutes> getVpnToExtrarouteIdentifier(String vpnName, String vrfId) {
 218         return InstanceIdentifier.builder(VpnToExtraroutes.class)
 219                 .child(Vpn.class, new VpnKey(vpnName)).child(ExtraRoutes.class,
 220                         new ExtraRoutesKey(vrfId)).build();
 221     }
 222
 223     static  InstanceIdentifier<Vpn> getVpnToExtrarouteIdentifier(String vpnName) {
 224         return InstanceIdentifier.builder(VpnToExtraroutes.class)
 225                 .child(Vpn.class, new VpnKey(vpnName)).build();
 226     }
 227
 228     /**
 229      * Get VRF table given a Route Distinguisher.
 230      *
 231      * @param broker dataBroker service reference
 232      * @param rd Route-Distinguisher
 233      * @return VrfTables that holds the list of VrfEntries of the specified rd
 234      */
 235     public static VrfTables getVrfTable(DataBroker broker, String rd) {
 236         InstanceIdentifier<VrfTables> id =
 237             InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class, new VrfTablesKey(rd)).build();
 238         Optional<VrfTables> vrfTable = read(broker, LogicalDatastoreType.CONFIGURATION, id);
 239         return vrfTable.isPresent() ? vrfTable.get() : null;
 240     }
 241
 242     /**
 243      * Retrieves the VrfEntries that belong to a given VPN filtered out by
 244      * Origin, searching by its Route-Distinguisher.
 245      *
 246      * @param broker dataBroker service reference
 247      * @param rd Route-distinguisher of the VPN
 248      * @param originsToConsider Only entries whose origin is included in this list will be considered
 249      * @return the list of VrfEntries
 250      */
 251     public static List<VrfEntry> getVrfEntriesByOrigin(DataBroker broker, String rd,
 252         List<RouteOrigin> originsToConsider) {
 253         List<VrfEntry> result = new ArrayList<>();
 254         List<VrfEntry> allVpnVrfEntries = getAllVrfEntries(broker, rd);
 255         for (VrfEntry vrfEntry : allVpnVrfEntries) {
 256             if (originsToConsider.contains(RouteOrigin.value(vrfEntry.getOrigin()))) {
 257                 result.add(vrfEntry);
 258             }
 259         }
 260         return result;
 261     }
 262
 263     static List<Prefixes> getAllPrefixesToInterface(DataBroker broker, long vpnId) {
 264         Optional<VpnIds> vpnIds = read(broker, LogicalDatastoreType.OPERATIONAL, getPrefixToInterfaceIdentifier(vpnId));
 265         if (vpnIds.isPresent()) {
 266             return vpnIds.get().getPrefixes();
 267         }
 268         return new ArrayList<>();
 269     }
 270
 271     static List<Routes> getAllExtraRoutes(DataBroker broker, String vpnName, String vrfId) {
 272         Optional<ExtraRoutes> extraRoutes = read(broker,LogicalDatastoreType.OPERATIONAL,
 273                 getVpnToExtrarouteIdentifier(vpnName, vrfId));
 274         List<Routes> extraRoutesList = new ArrayList<>();
 275         if (extraRoutes.isPresent()) {
 276             extraRoutesList = extraRoutes.get().getRoutes();
 277         }
 278         return extraRoutesList;
 279     }
 280
 281     /**
 282      * Retrieves all the VrfEntries that belong to a given VPN searching by its
 283      * Route-Distinguisher.
 284      *
 285      * @param broker dataBroker service reference
 286      * @param rd Route-distinguisher of the VPN
 287      * @return the list of VrfEntries
 288      */
 289     public static List<VrfEntry> getAllVrfEntries(DataBroker broker, String rd) {
 290         VrfTables vrfTables = VpnUtil.getVrfTable(broker, rd);
 291         return (vrfTables != null) ? vrfTables.getVrfEntry() : new ArrayList<>();
 292     }
 293
 294     //FIXME: Implement caches for DS reads
 295     public static VpnInstance getVpnInstance(DataBroker broker, String vpnInstanceName) {
 296         InstanceIdentifier<VpnInstance> id = InstanceIdentifier.builder(VpnInstances.class).child(VpnInstance.class,
 297             new VpnInstanceKey(vpnInstanceName)).build();
 298         Optional<VpnInstance> vpnInstance = read(broker, LogicalDatastoreType.CONFIGURATION, id);
 299         return (vpnInstance.isPresent()) ? vpnInstance.get() : null;
 300     }
 301
 302     static List<VpnInstance> getAllVpnInstances(DataBroker broker) {
 303         InstanceIdentifier<VpnInstances> id = InstanceIdentifier.builder(VpnInstances.class).build();
 304         Optional<VpnInstances> optVpnInstances = VpnUtil.read(broker, LogicalDatastoreType.CONFIGURATION, id);
 305         if (optVpnInstances.isPresent()) {
 306             return optVpnInstances.get().getVpnInstance();
 307         } else {
 308             return Collections.emptyList();
 309         }
 310     }
 311
 312     static List<VpnInstanceOpDataEntry> getAllVpnInstanceOpData(DataBroker broker) {
 313         InstanceIdentifier<VpnInstanceOpData> id = InstanceIdentifier.builder(VpnInstanceOpData.class).build();
 314         Optional<VpnInstanceOpData> vpnInstanceOpDataOptional =
 315             VpnUtil.read(broker, LogicalDatastoreType.OPERATIONAL, id);
 316         if (vpnInstanceOpDataOptional.isPresent()) {
 317             return vpnInstanceOpDataOptional.get().getVpnInstanceOpDataEntry();
 318         } else {
 319             return new ArrayList<>();
 320         }
 321     }
 322
 323     public static List<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn
 324         .instance.op.data.entry.vpn.to.dpn.list.VpnInterfaces> getDpnVpnInterfaces(DataBroker broker,
 325         VpnInstance vpnInstance, BigInteger dpnId) {
 326         String primaryRd = getPrimaryRd(vpnInstance);
 327         InstanceIdentifier<VpnToDpnList> dpnToVpnId = getVpnToDpnListIdentifier(primaryRd, dpnId);
 328         Optional<VpnToDpnList> dpnInVpn = VpnUtil.read(broker, LogicalDatastoreType.OPERATIONAL, dpnToVpnId);
 329         return dpnInVpn.isPresent() ? dpnInVpn.get().getVpnInterfaces() : Collections.emptyList();
 330     }
 331
 332     public static List<String> getListOfRdsFromVpnInstance(VpnInstance vpnInstance) {
 333         VpnAfConfig vpnConfig = vpnInstance.getIpv4Family();
 334         LOG.trace("vpnConfig {}", vpnConfig);
 335         return vpnConfig.getRouteDistinguisher() != null ? new ArrayList<>(
 336                 vpnConfig.getRouteDistinguisher()) : new ArrayList<>();
 337     }
 338
 339     static VrfEntry getVrfEntry(DataBroker broker, String rd, String ipPrefix) {
 340
 341         VrfTables vrfTable = getVrfTable(broker, rd);
 342         // TODO: why check VrfTables if we later go for the specific VrfEntry?
 343         if (vrfTable != null) {
 344             InstanceIdentifier<VrfEntry> vrfEntryId =
 345                 InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class, new VrfTablesKey(rd)).child(
 346                     VrfEntry.class, new VrfEntryKey(ipPrefix)).build();
 347             Optional<VrfEntry> vrfEntry = read(broker, LogicalDatastoreType.CONFIGURATION, vrfEntryId);
 348             if (vrfEntry.isPresent()) {
 349                 return vrfEntry.get();
 350             }
 351         }
 352         return null;
 353     }
 354
 355     static List<Adjacency> getAdjacenciesForVpnInterfaceFromConfig(DataBroker broker, String intfName) {
 356         final InstanceIdentifier<VpnInterface> identifier = getVpnInterfaceIdentifier(intfName);
 357         InstanceIdentifier<Adjacencies> path = identifier.augmentation(Adjacencies.class);
 358         Optional<Adjacencies> adjacencies = VpnUtil.read(broker, LogicalDatastoreType.CONFIGURATION, path);
 359
 360         if (adjacencies.isPresent()) {
 361             List<Adjacency> nextHops = adjacencies.get().getAdjacency();
 362             return nextHops;
 363         }
 364         return null;
 365     }
 366
 367     static  Routes getVpnToExtraroute(String ipPrefix, List<String> nextHopList) {
 368         return new RoutesBuilder().setPrefix(ipPrefix).setNexthopIpList(nextHopList).build();
 369     }
 370
 371     public static  List<Routes> getExtraRoutes(DataBroker broker, String vpnName, String vpnRd) {
 372         InstanceIdentifier<ExtraRoutes> vpnExtraRoutesId = getVpnToExtrarouteIdentifier(vpnName, vpnRd);
 373         Optional<ExtraRoutes> extraRoutes = read(broker, LogicalDatastoreType.OPERATIONAL, vpnExtraRoutesId);
 374         return extraRoutes.isPresent() ? extraRoutes.get().getRoutes() : new ArrayList<Routes>();
 375     }
 376
 377     public static Optional<Routes> getExtraRoutes(DataBroker broker, String vpnName,
 378                                                      String vpnRd, String destPrefix) {
 379         InstanceIdentifier<Routes> vpnExtraRoutesId = getVpnToExtrarouteIdentifier(vpnName, vpnRd, destPrefix);
 380         return read(broker, LogicalDatastoreType.OPERATIONAL, vpnExtraRoutesId);
 381     }
 382
 383     static  List<String> getUsedRds(DataBroker broker, long vpnId, String destPrefix) {
 384         InstanceIdentifier<DestPrefixes> usedRdsId = getUsedRdsIdentifier(vpnId, destPrefix);
 385         Optional<DestPrefixes> usedRds = read(broker, LogicalDatastoreType.OPERATIONAL, usedRdsId);
 386         return usedRds.isPresent() ? usedRds.get().getRds() : new ArrayList<String>();
 387     }
 388
 389     static  InstanceIdentifier<DestPrefixes> getUsedRdsIdentifier(long vpnId, String destPrefix) {
 390         return InstanceIdentifier.builder(ExtrarouteRdsMap.class)
 391                 .child(ExtrarouteRds.class, new ExtrarouteRdsKey(vpnId))
 392                 .child(DestPrefixes.class, new DestPrefixesKey(destPrefix)).build();
 393     }
 394
 395     static DestPrefixesBuilder getDestPrefixesBuilder(String destPrefix, List<String> rd) {
 396         return new DestPrefixesBuilder().setKey(new DestPrefixesKey(destPrefix))
 397                 .setDestPrefix(destPrefix).setRds(rd);
 398     }
 399
 400     static Adjacencies getVpnInterfaceAugmentation(List<Adjacency> nextHopList) {
 401         return new AdjacenciesBuilder().setAdjacency(nextHopList).build();
 402     }
 403
 404     public static InstanceIdentifier<IdPool> getPoolId(String poolName) {
 405         InstanceIdentifier.InstanceIdentifierBuilder<IdPool> idBuilder =
 406             InstanceIdentifier.builder(IdPools.class).child(IdPool.class, new IdPoolKey(poolName));
 407         InstanceIdentifier<IdPool> id = idBuilder.build();
 408         return id;
 409     }
 410
 411     static InstanceIdentifier<VpnInterfaces> getVpnInterfacesIdentifier() {
 412         return InstanceIdentifier.builder(VpnInterfaces.class).build();
 413     }
 414
 415     static InstanceIdentifier<Interface> getInterfaceIdentifier(String interfaceName) {
 416         return InstanceIdentifier.builder(Interfaces.class)
 417             .child(Interface.class, new InterfaceKey(interfaceName)).build();
 418     }
 419
 420     static InstanceIdentifier<VpnToDpnList> getVpnToDpnListIdentifier(String rd, BigInteger dpnId) {
 421         return InstanceIdentifier.builder(VpnInstanceOpData.class)
 422             .child(VpnInstanceOpDataEntry.class, new VpnInstanceOpDataEntryKey(rd))
 423             .child(VpnToDpnList.class, new VpnToDpnListKey(dpnId)).build();
 424     }
 425
 426     public static BigInteger getCookieArpFlow(int interfaceTag) {
 427         return VpnConstants.COOKIE_L3_BASE.add(new BigInteger("0110000", 16)).add(
 428             BigInteger.valueOf(interfaceTag));
 429     }
 430
 431     public static BigInteger getCookieL3(int vpnId) {
 432         return VpnConstants.COOKIE_L3_BASE.add(new BigInteger("0610000", 16)).add(BigInteger.valueOf(vpnId));
 433     }
 434
 435     public static String getFlowRef(BigInteger dpnId, short tableId, int ethType, int lportTag, int arpType) {
 436         return new StringBuffer().append(VpnConstants.FLOWID_PREFIX).append(dpnId).append(NwConstants.FLOWID_SEPARATOR)
 437             .append(tableId).append(NwConstants.FLOWID_SEPARATOR).append(ethType).append(lportTag)
 438             .append(NwConstants.FLOWID_SEPARATOR).append(arpType).toString();
 439     }
 440
 441     public static int getUniqueId(IdManagerService idManager, String poolName, String idKey) {
 442         AllocateIdInput getIdInput = new AllocateIdInputBuilder().setPoolName(poolName).setIdKey(idKey).build();
 443
 444         try {
 445             Future<RpcResult<AllocateIdOutput>> result = idManager.allocateId(getIdInput);
 446             RpcResult<AllocateIdOutput> rpcResult = result.get();
 447             if (rpcResult.isSuccessful()) {
 448                 return rpcResult.getResult().getIdValue().intValue();
 449             } else {
 450                 LOG.warn("RPC Call to Get Unique Id returned with Errors {}", rpcResult.getErrors());
 451             }
 452         } catch (InterruptedException | ExecutionException e) {
 453             LOG.warn("Exception when getting Unique Id", e);
 454         }
 455         return 0;
 456     }
 457
 458     public static void releaseId(IdManagerService idManager, String poolName, String idKey) {
 459         ReleaseIdInput idInput = new ReleaseIdInputBuilder().setPoolName(poolName).setIdKey(idKey).build();
 460         try {
 461             Future<RpcResult<Void>> result = idManager.releaseId(idInput);
 462             RpcResult<Void> rpcResult = result.get();
 463             if (!rpcResult.isSuccessful()) {
 464                 LOG.warn("RPC Call to Get Unique Id returned with Errors {}", rpcResult.getErrors());
 465             }
 466         } catch (InterruptedException | ExecutionException e) {
 467             LOG.warn("Exception when getting Unique Id for key {}", idKey, e);
 468         }
 469     }
 470
 471     public static String getNextHopLabelKey(String rd, String prefix) {
 472         return rd + VpnConstants.SEPARATOR + prefix;
 473     }
 474
 475     /**
 476      * Retrieves the VpnInstance name (typically the VPN Uuid) out from the
 477      * route-distinguisher.
 478      *
 479      * @param broker dataBroker service reference
 480      * @param rd Route-Distinguisher
 481      * @return the VpnInstance name
 482      */
 483     public static String getVpnNameFromRd(DataBroker broker, String rd) {
 484         VpnInstanceOpDataEntry vpnInstanceOpData = getVpnInstanceOpData(broker, rd);
 485         return (vpnInstanceOpData != null) ? vpnInstanceOpData.getVpnInstanceName() : null;
 486     }
 487
 488     /**
 489      * Retrieves the dataplane identifier of a specific VPN, searching by its
 490      * VpnInstance name.
 491      *
 492      * @param broker dataBroker service reference
 493      * @param vpnName Name of the VPN
 494      * @return the dataplane identifier of the VPN, the VrfTag.
 495      */
 496     public static long getVpnId(DataBroker broker, String vpnName) {
 497
 498         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn
 499             .id.VpnInstance>
 500             id
 501             = getVpnInstanceToVpnIdIdentifier(vpnName);
 502         Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id
 503             .VpnInstance>
 504             vpnInstance
 505             = read(broker, LogicalDatastoreType.CONFIGURATION, id);
 506
 507         long vpnId = VpnConstants.INVALID_ID;
 508         if (vpnInstance.isPresent()) {
 509             vpnId = vpnInstance.get().getVpnId();
 510         }
 511         return vpnId;
 512     }
 513
 514     /**
 515      * Retrieves the VPN Route Distinguisher searching by its Vpn instance name.
 516      *
 517      * @param broker dataBroker service reference
 518      * @param vpnName Name of the VPN
 519      * @return the route-distinguisher of the VPN
 520      */
 521     public static String getVpnRd(DataBroker broker, String vpnName) {
 522         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn
 523             .id.VpnInstance>
 524             id
 525             = getVpnInstanceToVpnIdIdentifier(vpnName);
 526         Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id
 527             .VpnInstance>
 528             vpnInstance
 529             = read(broker, LogicalDatastoreType.CONFIGURATION, id);
 530
 531         String rd = null;
 532         if (vpnInstance.isPresent()) {
 533             rd = vpnInstance.get().getVrfId();
 534         }
 535         return rd;
 536     }
 537
 538     private static List<String> getVpnRdsFromVpnInstanceConfig(DataBroker broker, String vpnName) {
 539         InstanceIdentifier<VpnInstance> id = InstanceIdentifier.builder(VpnInstances.class)
 540             .child(VpnInstance.class, new VpnInstanceKey(vpnName)).build();
 541         Optional<VpnInstance> vpnInstance = VpnUtil.read(broker, LogicalDatastoreType.CONFIGURATION, id);
 542         return vpnInstance.isPresent() ? getListOfRdsFromVpnInstance(vpnInstance.get()) : new ArrayList<String>();
 543     }
 544
 545     /**
 546      * Remove from MDSAL all those VrfEntries in a VPN that have an specific RouteOrigin.
 547      *
 548      * @param broker dataBroker service reference
 549      * @param rd Route Distinguisher
 550      * @param origin Origin of the Routes to be removed (see {@link RouteOrigin})
 551      */
 552     public static void removeVrfEntriesByOrigin(DataBroker broker, String rd, RouteOrigin origin) {
 553         InstanceIdentifier<VrfTables> vpnVrfTableIid =
 554             InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class, new VrfTablesKey(rd)).build();
 555         Optional<VrfTables> vrfTablesOpc = read(broker, LogicalDatastoreType.CONFIGURATION, vpnVrfTableIid);
 556         if (vrfTablesOpc.isPresent()) {
 557             VrfTables vrfTables = vrfTablesOpc.get();
 558             WriteTransaction tx = broker.newWriteOnlyTransaction();
 559             for (VrfEntry vrfEntry : vrfTables.getVrfEntry()) {
 560                 if (origin == RouteOrigin.value(vrfEntry.getOrigin())) {
 561                     tx.delete(LogicalDatastoreType.CONFIGURATION,
 562                             vpnVrfTableIid.child(VrfEntry.class, vrfEntry.getKey()));
 563                 }
 564             }
 565             tx.submit();
 566         }
 567     }
 568
 569     public static List<VrfEntry> findVrfEntriesByNexthop(DataBroker broker, String rd, String nexthop) {
 570         InstanceIdentifier<VrfTables> vpnVrfTableIid =
 571             InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class, new VrfTablesKey(rd)).build();
 572         Optional<VrfTables> vrfTablesOpc = read(broker, LogicalDatastoreType.CONFIGURATION, vpnVrfTableIid);
 573         List<VrfEntry> matches = new ArrayList<>();
 574
 575         if (vrfTablesOpc.isPresent()) {
 576             VrfTables vrfTables = vrfTablesOpc.get();
 577             for (VrfEntry vrfEntry : vrfTables.getVrfEntry()) {
 578                 vrfEntry.getRoutePaths().stream()
 579                         .filter(routePath -> routePath.getNexthopAddress() != null
 580                                 && routePath.getNexthopAddress().equals(nexthop))
 581                         .findFirst().ifPresent(routePath -> matches.add(vrfEntry));
 582             }
 583         }
 584         return matches;
 585     }
 586
 587     public static void removeVrfEntries(DataBroker broker, String rd, List<VrfEntry> vrfEntries) {
 588         InstanceIdentifier<VrfTables> vpnVrfTableIid =
 589             InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class, new VrfTablesKey(rd)).build();
 590         WriteTransaction tx = broker.newWriteOnlyTransaction();
 591         for (VrfEntry vrfEntry : vrfEntries) {
 592             tx.delete(LogicalDatastoreType.CONFIGURATION, vpnVrfTableIid.child(VrfEntry.class, vrfEntry.getKey()));
 593         }
 594         tx.submit();
 595     }
 596
 597     // TODO Clean up the exception handling
 598     @SuppressWarnings("checkstyle:IllegalCatch")
 599     public static void withdrawRoutes(IBgpManager bgpManager, String rd, List<VrfEntry> vrfEntries) {
 600         vrfEntries.forEach(vrfEntry -> {
 601             try {
 602                 bgpManager.withdrawPrefix(rd, vrfEntry.getDestPrefix());
 603             } catch (Exception e) {
 604                 LOG.error("Could not withdraw route to {} with route-paths {} in VpnRd {}",
 605                           vrfEntry.getDestPrefix(), vrfEntry.getRoutePaths(), rd);
 606             }
 607         });
 608     }
 609
 610     static org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstance
 611         getVpnInstanceToVpnId(String vpnName, long vpnId, String rd) {
 612         return new VpnInstanceBuilder().setVpnId(vpnId).setVpnInstanceName(vpnName).setVrfId(rd).build();
 613
 614     }
 615
 616     static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to
 617         .vpn.id.VpnInstance>
 618         getVpnInstanceToVpnIdIdentifier(String vpnName) {
 619         return InstanceIdentifier.builder(VpnInstanceToVpnId.class)
 620             .child(
 621                 org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id
 622                     .VpnInstance.class,
 623                 new org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id
 624                     .VpnInstanceKey(
 625                     vpnName)).build();
 626     }
 627
 628     static RouterInterface getConfiguredRouterInterface(DataBroker broker, String interfaceName) {
 629         Optional<RouterInterface> optRouterInterface =
 630             read(broker, LogicalDatastoreType.CONFIGURATION, VpnUtil.getRouterInterfaceId(interfaceName));
 631         if (optRouterInterface.isPresent()) {
 632             return optRouterInterface.get();
 633         }
 634         return null;
 635     }
 636
 637     static org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance.VpnIds
 638         getVpnIdToVpnInstance(long vpnId, String vpnName, String rd, boolean isExternalVpn) {
 639         return new org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance
 640             .VpnIdsBuilder()
 641             .setVpnId(vpnId).setVpnInstanceName(vpnName).setVrfId(rd).setExternalVpn(isExternalVpn).build();
 642
 643     }
 644
 645     public static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to
 646         .vpn.instance.VpnIds>
 647         getVpnIdToVpnInstanceIdentifier(long vpnId) {
 648         return InstanceIdentifier.builder(VpnIdToVpnInstance.class)
 649             .child(
 650                 org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance.VpnIds
 651                     .class,
 652                 new org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance
 653                     .VpnIdsKey(vpnId)).build();
 654     }
 655
 656     /**
 657      * Retrieves the Vpn Name searching by its VPN Tag.
 658      *
 659      * @param broker dataBroker service reference
 660      * @param vpnId Dataplane identifier of the VPN
 661      * @return the Vpn instance name
 662      */
 663     public static String getVpnName(DataBroker broker, long vpnId) {
 664
 665         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn
 666             .instance.VpnIds>
 667             id
 668             = getVpnIdToVpnInstanceIdentifier(vpnId);
 669         Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance.VpnIds>
 670             vpnInstance
 671             = read(broker, LogicalDatastoreType.CONFIGURATION, id);
 672
 673         String vpnName = null;
 674         if (vpnInstance.isPresent()) {
 675             vpnName = vpnInstance.get().getVpnInstanceName();
 676         }
 677         return vpnName;
 678     }
 679
 680     public static InstanceIdentifier<VpnInstanceOpDataEntry> getVpnInstanceOpDataIdentifier(String rd) {
 681         return InstanceIdentifier.builder(VpnInstanceOpData.class)
 682             .child(VpnInstanceOpDataEntry.class, new VpnInstanceOpDataEntryKey(rd)).build();
 683     }
 684
 685     static InstanceIdentifier<RouterInterface> getRouterInterfaceId(String interfaceName) {
 686         return InstanceIdentifier.builder(RouterInterfaces.class)
 687             .child(RouterInterface.class, new RouterInterfaceKey(interfaceName)).build();
 688     }
 689
 690     static RouterInterface getRouterInterface(String interfaceName, String routerName) {
 691         return new RouterInterfaceBuilder().setKey(new RouterInterfaceKey(interfaceName))
 692             .setInterfaceName(interfaceName).setRouterName(routerName).build();
 693     }
 694
 695     public static VpnInstanceOpDataEntry getVpnInstanceOpData(DataBroker broker, String rd) {
 696         InstanceIdentifier<VpnInstanceOpDataEntry> id = VpnUtil.getVpnInstanceOpDataIdentifier(rd);
 697         return read(broker, LogicalDatastoreType.OPERATIONAL, id).orNull();
 698     }
 699
 700     static VpnInstanceOpDataEntry getVpnInstanceOpDataFromCache(DataBroker broker, String rd) {
 701         InstanceIdentifier<VpnInstanceOpDataEntry> id = VpnUtil.getVpnInstanceOpDataIdentifier(rd);
 702         return (VpnInstanceOpDataEntry) DataStoreCache.get(VpnConstants.VPN_OP_INSTANCE_CACHE_NAME, id, rd, broker,
 703             false);
 704     }
 705
 706     static VpnInterface getConfiguredVpnInterface(DataBroker broker, String interfaceName) {
 707         InstanceIdentifier<VpnInterface> interfaceId = getVpnInterfaceIdentifier(interfaceName);
 708         Optional<VpnInterface> configuredVpnInterface = read(broker, LogicalDatastoreType.CONFIGURATION, interfaceId);
 709
 710         if (configuredVpnInterface.isPresent()) {
 711             return configuredVpnInterface.get();
 712         }
 713         return null;
 714     }
 715
 716     static String getNeutronRouterFromInterface(DataBroker broker, String interfaceName) {
 717         InstanceIdentifier.InstanceIdentifierBuilder<RouterInterfacesMap> idBuilder =
 718             InstanceIdentifier.builder(RouterInterfacesMap.class);
 719         InstanceIdentifier<RouterInterfacesMap> id = idBuilder.build();
 720         Optional<RouterInterfacesMap> routerInterfacesMap =
 721             MDSALUtil.read(broker, LogicalDatastoreType.CONFIGURATION, id);
 722         if (routerInterfacesMap.isPresent()) {
 723             List<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.router.interfaces.map
 724                 .RouterInterfaces>
 725                 rtrInterfaces = routerInterfacesMap.get().getRouterInterfaces();
 726             for (org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.router.interfaces.map
 727                      .RouterInterfaces rtrInterface : rtrInterfaces) {
 728                 List<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.router.interfaces.map
 729                     .router.interfaces.Interfaces>
 730                     rtrIfc = rtrInterface.getInterfaces();
 731                 for (org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.router.interfaces.map
 732                          .router.interfaces.Interfaces ifc : rtrIfc) {
 733                     if (ifc.getInterfaceId().equals(interfaceName)) {
 734                         return rtrInterface.getRouterId().getValue();
 735                     }
 736                 }
 737             }
 738         }
 739         return null;
 740     }
 741
 742     static VpnInterface getOperationalVpnInterface(DataBroker broker, String interfaceName) {
 743         InstanceIdentifier<VpnInterface> interfaceId = getVpnInterfaceIdentifier(interfaceName);
 744         Optional<VpnInterface> operationalVpnInterface = read(broker, LogicalDatastoreType.OPERATIONAL, interfaceId);
 745
 746         if (operationalVpnInterface.isPresent()) {
 747             return operationalVpnInterface.get();
 748         }
 749         return null;
 750     }
 751
 752     static boolean isVpnInterfaceConfigured(DataBroker broker, String interfaceName) {
 753         InstanceIdentifier<VpnInterface> interfaceId = getVpnInterfaceIdentifier(interfaceName);
 754         return read(broker, LogicalDatastoreType.CONFIGURATION, interfaceId).isPresent();
 755     }
 756
 757     static boolean isInterfaceAssociatedWithVpn(DataBroker broker, String vpnName, String interfaceName) {
 758         InstanceIdentifier<VpnInterface> interfaceId = getVpnInterfaceIdentifier(interfaceName);
 759         Optional<VpnInterface> optConfiguredVpnInterface =
 760             read(broker, LogicalDatastoreType.CONFIGURATION, interfaceId);
 761
 762         if (optConfiguredVpnInterface.isPresent()) {
 763             String configuredVpnName = optConfiguredVpnInterface.get().getVpnInstanceName();
 764             if ((configuredVpnName != null) && (configuredVpnName.equalsIgnoreCase(vpnName))) {
 765                 return true;
 766             }
 767         }
 768         return false;
 769     }
 770
 771     public static String getIpPrefix(String prefix) {
 772         String[] prefixValues = prefix.split("/");
 773         if (prefixValues.length == 1) {
 774             prefix = prefix + PREFIX_SEPARATOR + DEFAULT_PREFIX_LENGTH;
 775         }
 776         return prefix;
 777     }
 778
 779     static final FutureCallback<Void> DEFAULT_CALLBACK =
 780         new FutureCallback<Void>() {
 781             @Override
 782             public void onSuccess(Void result) {
 783                 LOG.debug("Success in Datastore operation");
 784             }
 785
 786             @Override
 787             public void onFailure(Throwable error) {
 788                 LOG.error("Error in Datastore operation", error);
 789             }
 790
 791             ;
 792         };
 793
 794     public static <T extends DataObject> Optional<T> read(DataBroker broker, LogicalDatastoreType datastoreType,
 795                                                           InstanceIdentifier<T> path) {
 796         try (ReadOnlyTransaction tx = broker.newReadOnlyTransaction()) {
 797             return tx.read(datastoreType, path).get();
 798         } catch (InterruptedException | ExecutionException e) {
 799             throw new RuntimeException(e);
 800         }
 801     }
 802
 803     public static <T extends DataObject> void asyncUpdate(DataBroker broker, LogicalDatastoreType datastoreType,
 804         InstanceIdentifier<T> path, T data) {
 805         asyncUpdate(broker, datastoreType, path, data, DEFAULT_CALLBACK);
 806     }
 807
 808     public static <T extends DataObject> void asyncUpdate(DataBroker broker, LogicalDatastoreType datastoreType,
 809         InstanceIdentifier<T> path, T data, FutureCallback<Void> callback) {
 810         WriteTransaction tx = broker.newWriteOnlyTransaction();
 811         tx.merge(datastoreType, path, data, true);
 812         Futures.addCallback(tx.submit(), callback);
 813     }
 814
 815     public static <T extends DataObject> void asyncWrite(DataBroker broker, LogicalDatastoreType datastoreType,
 816         InstanceIdentifier<T> path, T data) {
 817         asyncWrite(broker, datastoreType, path, data, DEFAULT_CALLBACK);
 818     }
 819
 820     public static <T extends DataObject> void asyncWrite(DataBroker broker, LogicalDatastoreType datastoreType,
 821         InstanceIdentifier<T> path, T data, FutureCallback<Void> callback) {
 822         WriteTransaction tx = broker.newWriteOnlyTransaction();
 823         tx.put(datastoreType, path, data, true);
 824         Futures.addCallback(tx.submit(), callback);
 825     }
 826
 827     // TODO Clean up the exception handling
 828     @SuppressWarnings("checkstyle:IllegalCatch")
 829     public static <T extends DataObject> void tryDelete(DataBroker broker, LogicalDatastoreType datastoreType,
 830         InstanceIdentifier<T> path) {
 831         try {
 832             delete(broker, datastoreType, path, DEFAULT_CALLBACK);
 833         } catch (SchemaValidationFailedException sve) {
 834             LOG.info("Could not delete {}. SchemaValidationFailedException: {}", path, sve.getMessage());
 835         } catch (Exception e) {
 836             LOG.info("Could not delete {}. Unhandled error: {}", path, e.getMessage());
 837         }
 838     }
 839
 840     public static <T extends DataObject> void delete(DataBroker broker, LogicalDatastoreType datastoreType,
 841         InstanceIdentifier<T> path) {
 842         delete(broker, datastoreType, path, DEFAULT_CALLBACK);
 843     }
 844
 845
 846     public static <T extends DataObject> void delete(DataBroker broker, LogicalDatastoreType datastoreType,
 847         InstanceIdentifier<T> path, FutureCallback<Void> callback) {
 848         WriteTransaction tx = broker.newWriteOnlyTransaction();
 849         tx.delete(datastoreType, path);
 850         Futures.addCallback(tx.submit(), callback);
 851     }
 852
 853     public static <T extends DataObject> void syncWrite(DataBroker broker, LogicalDatastoreType datastoreType,
 854         InstanceIdentifier<T> path, T data) {
 855         WriteTransaction tx = broker.newWriteOnlyTransaction();
 856         tx.put(datastoreType, path, data, true);
 857         CheckedFuture<Void, TransactionCommitFailedException> futures = tx.submit();
 858         try {
 859             futures.get();
 860         } catch (InterruptedException | ExecutionException e) {
 861             LOG.error("Error writing to datastore (path, data) : ({}, {})", path, data);
 862             throw new RuntimeException(e.getMessage());
 863         }
 864     }
 865
 866     public static <T extends DataObject> void syncUpdate(DataBroker broker, LogicalDatastoreType datastoreType,
 867         InstanceIdentifier<T> path, T data) {
 868         WriteTransaction tx = broker.newWriteOnlyTransaction();
 869         tx.merge(datastoreType, path, data, true);
 870         CheckedFuture<Void, TransactionCommitFailedException> futures = tx.submit();
 871         try {
 872             futures.get();
 873         } catch (InterruptedException | ExecutionException e) {
 874             LOG.error("Error writing to datastore (path, data) : ({}, {})", path, data);
 875             throw new RuntimeException(e.getMessage());
 876         }
 877     }
 878
 879     public static long getRemoteBCGroup(long elanTag) {
 880         return VpnConstants.ELAN_GID_MIN + ((elanTag % VpnConstants.ELAN_GID_MIN) * 2);
 881     }
 882
 883     // interface-index-tag operational container
 884     public static IfIndexInterface getInterfaceInfoByInterfaceTag(DataBroker broker, long interfaceTag) {
 885         InstanceIdentifier<IfIndexInterface> interfaceId = getInterfaceInfoEntriesOperationalDataPath(interfaceTag);
 886         Optional<IfIndexInterface> existingInterfaceInfo =
 887             VpnUtil.read(broker, LogicalDatastoreType.OPERATIONAL, interfaceId);
 888         if (existingInterfaceInfo.isPresent()) {
 889             return existingInterfaceInfo.get();
 890         }
 891         return null;
 892     }
 893
 894     private static InstanceIdentifier<IfIndexInterface> getInterfaceInfoEntriesOperationalDataPath(long interfaceTag) {
 895         return InstanceIdentifier.builder(IfIndexesInterfaceMap.class).child(IfIndexInterface.class,
 896             new IfIndexInterfaceKey((int) interfaceTag)).build();
 897     }
 898
 899     public static ElanTagName getElanInfoByElanTag(DataBroker broker, long elanTag) {
 900         InstanceIdentifier<ElanTagName> elanId = getElanInfoEntriesOperationalDataPath(elanTag);
 901         Optional<ElanTagName> existingElanInfo = VpnUtil.read(broker, LogicalDatastoreType.OPERATIONAL, elanId);
 902         if (existingElanInfo.isPresent()) {
 903             return existingElanInfo.get();
 904         }
 905         return null;
 906     }
 907
 908     private static InstanceIdentifier<ElanTagName> getElanInfoEntriesOperationalDataPath(long elanTag) {
 909         return InstanceIdentifier.builder(ElanTagNameMap.class).child(ElanTagName.class,
 910             new ElanTagNameKey(elanTag)).build();
 911     }
 912
 913     /**
 914      * Returns the Path identifier to reach a specific interface in a specific DPN in a given VpnInstance.
 915      *
 916      * @param vpnRd Route-Distinguisher of the VpnInstance
 917      * @param dpnId Id of the DPN where the interface is
 918      * @param ifaceName Interface name
 919      * @return the Instance Identifier
 920      */
 921     public static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
 922         .instance.op.data.vpn.instance.op.data.entry.vpn.to.dpn.list.VpnInterfaces>
 923         getVpnToDpnInterfacePath(String vpnRd, BigInteger dpnId, String ifaceName) {
 924
 925         return
 926             InstanceIdentifier.builder(VpnInstanceOpData.class)
 927                 .child(VpnInstanceOpDataEntry.class, new VpnInstanceOpDataEntryKey(vpnRd))
 928                 .child(VpnToDpnList.class, new VpnToDpnListKey(dpnId))
 929                 .child(org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
 930                         .instance.op.data.vpn.instance.op.data.entry.vpn.to.dpn.list.VpnInterfaces.class,
 931                     new org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
 932                         .instance.op.data.vpn.instance.op.data.entry.vpn.to.dpn.list.VpnInterfacesKey(ifaceName))
 933                 .build();
 934     }
 935
 936     // TODO Clean up the exception handling
 937     @SuppressWarnings("checkstyle:IllegalCatch")
 938     public static void removePrefixToInterfaceForVpnId(DataBroker broker, long vpnId, WriteTransaction writeTxn) {
 939         try {
 940             // Clean up PrefixToInterface Operational DS
 941             if (writeTxn != null) {
 942                 writeTxn.delete(LogicalDatastoreType.OPERATIONAL,
 943                     InstanceIdentifier.builder(PrefixToInterface.class).child(
 944                         VpnIds.class, new VpnIdsKey(vpnId)).build());
 945             } else {
 946                 delete(broker, LogicalDatastoreType.OPERATIONAL,
 947                     InstanceIdentifier.builder(PrefixToInterface.class).child(VpnIds.class,
 948                         new VpnIdsKey(vpnId)).build(),
 949                     DEFAULT_CALLBACK);
 950             }
 951         } catch (Exception e) {
 952             LOG.error("Exception during cleanup of PrefixToInterface for VPN ID {}", vpnId, e);
 953         }
 954     }
 955
 956     // TODO Clean up the exception handling
 957     @SuppressWarnings("checkstyle:IllegalCatch")
 958     public static void removeVpnExtraRouteForVpn(DataBroker broker, String vpnName, WriteTransaction writeTxn) {
 959         try {
 960             // Clean up VPNExtraRoutes Operational DS
 961             if (writeTxn != null) {
 962                 writeTxn.delete(LogicalDatastoreType.OPERATIONAL,
 963                         InstanceIdentifier.builder(VpnToExtraroutes.class)
 964                                 .child(Vpn.class, new VpnKey(vpnName)).build());
 965             } else {
 966                 delete(broker, LogicalDatastoreType.OPERATIONAL,
 967                         InstanceIdentifier.builder(VpnToExtraroutes.class)
 968                                 .child(Vpn.class, new VpnKey(vpnName)).build(),
 969                         DEFAULT_CALLBACK);
 970             }
 971         } catch (Exception e) {
 972             LOG.error("Exception during cleanup of VPNToExtraRoute for VPN {}", vpnName, e);
 973         }
 974     }
 975
 976     // TODO Clean up the exception handling
 977     @SuppressWarnings("checkstyle:IllegalCatch")
 978     public static void removeVpnOpInstance(DataBroker broker, String vpnName, WriteTransaction writeTxn) {
 979         try {
 980             // Clean up VPNInstanceOpDataEntry
 981             if (writeTxn != null) {
 982                 writeTxn.delete(LogicalDatastoreType.OPERATIONAL, getVpnInstanceOpDataIdentifier(vpnName));
 983             } else {
 984                 delete(broker, LogicalDatastoreType.OPERATIONAL, getVpnInstanceOpDataIdentifier(vpnName),
 985                     DEFAULT_CALLBACK);
 986             }
 987         } catch (Exception e) {
 988             LOG.error("Exception during cleanup of VPNInstanceOpDataEntry for VPN {}", vpnName, e);
 989         }
 990     }
 991
 992     // TODO Clean up the exception handling
 993     @SuppressWarnings("checkstyle:IllegalCatch")
 994     public static void removeVpnInstanceToVpnId(DataBroker broker, String vpnName, WriteTransaction writeTxn) {
 995         try {
 996             if (writeTxn != null) {
 997                 writeTxn.delete(LogicalDatastoreType.CONFIGURATION, getVpnInstanceToVpnIdIdentifier(vpnName));
 998             } else {
 999                 delete(broker, LogicalDatastoreType.CONFIGURATION, getVpnInstanceToVpnIdIdentifier(vpnName),
1000                     DEFAULT_CALLBACK);
1001             }
1002         } catch (Exception e) {
1003             LOG.error("Exception during clean up of VpnInstanceToVpnId for VPN {}", vpnName, e);
1004         }
1005     }
1006
1007     // TODO Clean up the exception handling
1008     @SuppressWarnings("checkstyle:IllegalCatch")
1009     public static void removeVpnIdToVpnInstance(DataBroker broker, long vpnId, WriteTransaction writeTxn) {
1010         try {
1011             if (writeTxn != null) {
1012                 writeTxn.delete(LogicalDatastoreType.CONFIGURATION, getVpnIdToVpnInstanceIdentifier(vpnId));
1013             } else {
1014                 delete(broker, LogicalDatastoreType.CONFIGURATION, getVpnIdToVpnInstanceIdentifier(vpnId),
1015                     DEFAULT_CALLBACK);
1016             }
1017         } catch (Exception e) {
1018             LOG.error("Exception during clean up of VpnIdToVpnInstance for VPNID {}", vpnId, e);
1019         }
1020     }
1021
1022     // TODO Clean up the exception handling
1023     @SuppressWarnings("checkstyle:IllegalCatch")
1024     public static void removeVrfTableForVpn(DataBroker broker, String vpnName, WriteTransaction writeTxn) {
1025         // Clean up FIB Entries Config DS
1026         try {
1027             if (writeTxn != null) {
1028                 writeTxn.delete(LogicalDatastoreType.CONFIGURATION,
1029                     InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class,
1030                         new VrfTablesKey(vpnName)).build());
1031             } else {
1032                 delete(broker, LogicalDatastoreType.CONFIGURATION,
1033                     InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class,
1034                         new VrfTablesKey(vpnName)).build(),
1035                     DEFAULT_CALLBACK);
1036             }
1037         } catch (Exception e) {
1038             LOG.error("Exception during clean up of VrfTable from FIB for VPN {}", vpnName, e);
1039         }
1040     }
1041
1042     // TODO Clean up the exception handling
1043     @SuppressWarnings("checkstyle:IllegalCatch")
1044     public static void removeL3nexthopForVpnId(DataBroker broker, long vpnId, WriteTransaction writeTxn) {
1045         try {
1046             // Clean up L3NextHop Operational DS
1047             if (writeTxn != null) {
1048                 writeTxn.delete(LogicalDatastoreType.OPERATIONAL,
1049                     InstanceIdentifier.builder(L3nexthop.class).child(VpnNexthops.class,
1050                         new VpnNexthopsKey(vpnId)).build());
1051             } else {
1052                 delete(broker, LogicalDatastoreType.OPERATIONAL,
1053                     InstanceIdentifier.builder(L3nexthop.class).child(VpnNexthops.class,
1054                         new VpnNexthopsKey(vpnId)).build(),
1055                     DEFAULT_CALLBACK);
1056             }
1057         } catch (Exception e) {
1058             LOG.error("Exception during cleanup of L3NextHop for VPN ID {}", vpnId, e);
1059         }
1060     }
1061
1062     public static void scheduleVpnInterfaceForRemoval(DataBroker broker,String interfaceName, BigInteger dpnId,
1063                                                       String vpnInstanceName, Boolean isScheduledToRemove,
1064                                                       WriteTransaction writeOperTxn) {
1065         InstanceIdentifier<VpnInterface> interfaceId = VpnUtil.getVpnInterfaceIdentifier(interfaceName);
1066         VpnInterface interfaceToUpdate =
1067             new VpnInterfaceBuilder().setKey(new VpnInterfaceKey(interfaceName)).setName(interfaceName)
1068                 .setDpnId(dpnId).setVpnInstanceName(vpnInstanceName).setScheduledForRemove(isScheduledToRemove).build();
1069         if (writeOperTxn != null) {
1070             writeOperTxn.merge(LogicalDatastoreType.OPERATIONAL, interfaceId, interfaceToUpdate, true);
1071         } else {
1072             VpnUtil.syncUpdate(broker, LogicalDatastoreType.OPERATIONAL, interfaceId, interfaceToUpdate);
1073         }
1074     }
1075
1076     protected static void createLearntVpnVipToPort(DataBroker broker, String vpnName, String fixedIp, String
1077             portName, String macAddress) {
1078         synchronized ((vpnName + fixedIp).intern()) {
1079             InstanceIdentifier<LearntVpnVipToPort> id = buildLearntVpnVipToPortIdentifier(vpnName, fixedIp);
1080             LearntVpnVipToPortBuilder builder =
1081                     new LearntVpnVipToPortBuilder().setKey(new LearntVpnVipToPortKey(fixedIp, vpnName)).setVpnName(
1082                             vpnName).setPortFixedip(fixedIp).setPortName(portName).setMacAddress(
1083                             macAddress.toLowerCase());
1084             MDSALUtil.syncWrite(broker, LogicalDatastoreType.OPERATIONAL, id, builder.build());
1085             LOG.debug("ARP learned for fixedIp: {}, vpn {}, interface {}, mac {}, isSubnetIp {} added to "
1086                     + "VpnPortipToPort DS", fixedIp, vpnName, portName, macAddress);
1087         }
1088     }
1089
1090     private static InstanceIdentifier<LearntVpnVipToPort> buildLearntVpnVipToPortIdentifier(String vpnName,
1091             String fixedIp) {
1092         InstanceIdentifier<LearntVpnVipToPort> id =
1093                 InstanceIdentifier.builder(LearntVpnVipToPortData.class).child(LearntVpnVipToPort.class,
1094                         new LearntVpnVipToPortKey(fixedIp, vpnName)).build();
1095         return id;
1096     }
1097
1098     protected static void removeLearntVpnVipToPort(DataBroker broker, String vpnName, String fixedIp) {
1099         synchronized ((vpnName + fixedIp).intern()) {
1100             InstanceIdentifier<LearntVpnVipToPort> id = buildLearntVpnVipToPortIdentifier(vpnName, fixedIp);
1101             MDSALUtil.syncDelete(broker, LogicalDatastoreType.OPERATIONAL, id);
1102             LOG.debug("Delete learned ARP for fixedIp: {}, vpn {} removed from VpnPortipToPort DS", fixedIp, vpnName);
1103         }
1104     }
1105
1106     static InstanceIdentifier<VpnPortipToPort> buildVpnPortipToPortIdentifier(String vpnName, String fixedIp) {
1107         InstanceIdentifier<VpnPortipToPort> id =
1108             InstanceIdentifier.builder(NeutronVpnPortipPortData.class).child(VpnPortipToPort.class,
1109                 new VpnPortipToPortKey(fixedIp, vpnName)).build();
1110         return id;
1111     }
1112
1113     static VpnPortipToPort getNeutronPortFromVpnPortFixedIp(DataBroker broker, String vpnName, String fixedIp) {
1114         InstanceIdentifier id = buildVpnPortipToPortIdentifier(vpnName, fixedIp);
1115         Optional<VpnPortipToPort> vpnPortipToPortData = read(broker, LogicalDatastoreType.CONFIGURATION, id);
1116         if (vpnPortipToPortData.isPresent()) {
1117             return (vpnPortipToPortData.get());
1118         }
1119         return null;
1120     }
1121
1122     static LearntVpnVipToPort getLearntVpnVipToPort(DataBroker broker, String vpnName, String fixedIp) {
1123         InstanceIdentifier id = buildLearntVpnVipToPortIdentifier(vpnName, fixedIp);
1124         Optional<LearntVpnVipToPort> learntVpnVipToPort = read(broker, LogicalDatastoreType.OPERATIONAL, id);
1125         if (learntVpnVipToPort.isPresent()) {
1126             return (learntVpnVipToPort.get());
1127         }
1128         return null;
1129     }
1130
1131     public static List<BigInteger> getDpnsOnVpn(DataBroker dataBroker, String vpnInstanceName) {
1132         List<BigInteger> result = new ArrayList<>();
1133         String rd = getVpnRd(dataBroker, vpnInstanceName);
1134         if (rd == null) {
1135             LOG.debug("Could not find Route-Distinguisher for VpnName={}", vpnInstanceName);
1136             return result;
1137         }
1138
1139         VpnInstanceOpDataEntry vpnInstanceOpData = getVpnInstanceOpData(dataBroker, rd);
1140         if (vpnInstanceOpData == null) {
1141             LOG.debug("Could not find OpState for VpnName={}", vpnInstanceName);
1142             return result;
1143         }
1144
1145         List<VpnToDpnList> vpnToDpnList = vpnInstanceOpData.getVpnToDpnList();
1146         if (vpnToDpnList == null) {
1147             LOG.debug("Could not find DPN footprint for VpnName={}", vpnInstanceName);
1148             return result;
1149         }
1150         for (VpnToDpnList vpnToDpn : vpnToDpnList) {
1151             result.add(vpnToDpn.getDpnId());
1152         }
1153         return result;
1154     }
1155
1156     static String getAssociatedExternalNetwork(DataBroker dataBroker, String routerId) {
1157         InstanceIdentifier<Routers> id = buildRouterIdentifier(routerId);
1158         Optional<Routers> routerData = read(dataBroker, LogicalDatastoreType.CONFIGURATION, id);
1159         if (routerData.isPresent()) {
1160             Uuid networkId = routerData.get().getNetworkId();
1161             if (networkId != null) {
1162                 return networkId.getValue();
1163             }
1164         }
1165         return null;
1166     }
1167
1168     static InstanceIdentifier<Routers> buildRouterIdentifier(String routerId) {
1169         InstanceIdentifier<Routers> routerInstanceIndentifier =
1170             InstanceIdentifier.builder(ExtRouters.class).child(Routers.class, new RoutersKey(routerId)).build();
1171         return routerInstanceIndentifier;
1172     }
1173
1174     static Networks getExternalNetwork(DataBroker dataBroker, Uuid networkId) {
1175         InstanceIdentifier<Networks> netsIdentifier = InstanceIdentifier.builder(ExternalNetworks.class)
1176             .child(Networks.class, new NetworksKey(networkId)).build();
1177         Optional<Networks> optionalNets = VpnUtil.read(dataBroker, LogicalDatastoreType.CONFIGURATION, netsIdentifier);
1178         return optionalNets.isPresent() ? optionalNets.get() : null;
1179     }
1180
1181     static Uuid getExternalNetworkVpnId(DataBroker dataBroker, Uuid networkId) {
1182         Networks extNetwork = getExternalNetwork(dataBroker, networkId);
1183         return extNetwork != null ? extNetwork.getVpnid() : null;
1184     }
1185
1186     static List<Uuid> getExternalNetworkRouterIds(DataBroker dataBroker, Uuid networkId) {
1187         Networks extNetwork = getExternalNetwork(dataBroker, networkId);
1188         return extNetwork != null ? extNetwork.getRouterIds() : null;
1189     }
1190
1191     static Routers getExternalRouter(DataBroker dataBroker, String routerId) {
1192         InstanceIdentifier<Routers> id = InstanceIdentifier.builder(ExtRouters.class)
1193                 .child(Routers.class, new RoutersKey(routerId)).build();
1194         Optional<Routers> routerData = read(dataBroker, LogicalDatastoreType.CONFIGURATION, id);
1195         return routerData.isPresent() ? routerData.get() : null;
1196     }
1197
1198     static List<String> getAllSubnetGatewayMacAddressesforVpn(DataBroker broker, String vpnName) {
1199         List<String> macAddresses = new ArrayList<>();
1200         Optional<Subnetmaps> subnetMapsData =
1201             read(broker, LogicalDatastoreType.CONFIGURATION, buildSubnetMapsWildCardPath());
1202         if (subnetMapsData.isPresent()) {
1203             List<Subnetmap> subnetMapList = subnetMapsData.get().getSubnetmap();
1204             if (subnetMapList != null && !subnetMapList.isEmpty()) {
1205                 for (Subnetmap subnet : subnetMapList) {
1206                     if (subnet.getVpnId() != null && subnet.getVpnId().equals(Uuid.getDefaultInstance(vpnName))) {
1207                         String routerIntfMacAddress = subnet.getRouterIntfMacAddress();
1208                         if (routerIntfMacAddress != null && !routerIntfMacAddress.isEmpty()) {
1209                             macAddresses.add(subnet.getRouterIntfMacAddress());
1210                         }
1211                     }
1212                 }
1213             }
1214         }
1215         return macAddresses;
1216     }
1217
1218     static InstanceIdentifier<Subnetmaps> buildSubnetMapsWildCardPath() {
1219         return InstanceIdentifier.create(Subnetmaps.class);
1220     }
1221
1222     static void setupSubnetMacIntoVpnInstance(DataBroker dataBroker, IMdsalApiManager mdsalManager,
1223         String vpnName, String srcMacAddress, BigInteger dpnId, WriteTransaction writeTx, int addOrRemove) {
1224         long vpnId = getVpnId(dataBroker, vpnName);
1225         if (dpnId.equals(BigInteger.ZERO)) {
1226             /* Apply the MAC on all DPNs in a VPN */
1227             List<BigInteger> dpIds = getDpnsOnVpn(dataBroker, vpnName);
1228             if (dpIds == null || dpIds.isEmpty()) {
1229                 return;
1230             }
1231             for (BigInteger dpId : dpIds) {
1232                 addGwMacIntoTx(mdsalManager, srcMacAddress, writeTx, addOrRemove, vpnId, dpId);
1233             }
1234         } else {
1235             addGwMacIntoTx(mdsalManager, srcMacAddress, writeTx, addOrRemove, vpnId, dpnId);
1236         }
1237     }
1238
1239     static void addGwMacIntoTx(IMdsalApiManager mdsalManager, String srcMacAddress, WriteTransaction writeTx,
1240         int addOrRemove, long vpnId, BigInteger dpId) {
1241         FlowEntity flowEntity = buildL3vpnGatewayFlow(dpId, srcMacAddress, vpnId);
1242         if (addOrRemove == NwConstants.ADD_FLOW) {
1243             mdsalManager.addFlowToTx(flowEntity, writeTx);
1244         } else {
1245             mdsalManager.removeFlowToTx(flowEntity, writeTx);
1246         }
1247     }
1248
1249     public static FlowEntity buildL3vpnGatewayFlow(BigInteger dpId, String gwMacAddress, long vpnId) {
1250         List<MatchInfo> mkMatches = new ArrayList<>();
1251         mkMatches.add(new MatchMetadata(MetaDataUtil.getVpnIdMetadata(vpnId), MetaDataUtil.METADATA_MASK_VRFID));
1252         mkMatches.add(new MatchEthernetDestination(new MacAddress(gwMacAddress)));
1253         List<InstructionInfo> mkInstructions = new ArrayList<>();
1254         mkInstructions.add(new InstructionGotoTable(NwConstants.L3_FIB_TABLE));
1255         String flowId = getL3VpnGatewayFlowRef(NwConstants.L3_GW_MAC_TABLE, dpId, vpnId, gwMacAddress);
1256         FlowEntity flowEntity = MDSALUtil.buildFlowEntity(dpId, NwConstants.L3_GW_MAC_TABLE,
1257             flowId, 20, flowId, 0, 0, NwConstants.COOKIE_L3_GW_MAC_TABLE, mkMatches, mkInstructions);
1258         return flowEntity;
1259     }
1260
1261     private static String getL3VpnGatewayFlowRef(short l3GwMacTable, BigInteger dpId, long vpnId, String gwMacAddress) {
1262         return gwMacAddress + NwConstants.FLOWID_SEPARATOR + vpnId + NwConstants.FLOWID_SEPARATOR + dpId
1263             + NwConstants.FLOWID_SEPARATOR + l3GwMacTable;
1264     }
1265
1266     public static void lockSubnet(LockManagerService lockManager, String subnetId) {
1267         TryLockInput input =
1268             new TryLockInputBuilder().setLockName(subnetId).setTime(3000L).setTimeUnit(TimeUnits.Milliseconds).build();
1269         Future<RpcResult<Void>> result = lockManager.tryLock(input);
1270         String errMsg = "Unable to getLock for subnet " + subnetId;
1271         try {
1272             if ((result != null) && (result.get().isSuccessful())) {
1273                 LOG.debug("Acquired lock for {}", subnetId);
1274             } else {
1275                 throw new RuntimeException(errMsg);
1276             }
1277         } catch (InterruptedException | ExecutionException e) {
1278             LOG.error(errMsg);
1279             throw new RuntimeException(errMsg, e.getCause());
1280         }
1281     }
1282
1283     public static void unlockSubnet(LockManagerService lockManager, String subnetId) {
1284         UnlockInput input = new UnlockInputBuilder().setLockName(subnetId).build();
1285         Future<RpcResult<Void>> result = lockManager.unlock(input);
1286         try {
1287             if ((result != null) && (result.get().isSuccessful())) {
1288                 LOG.debug("Unlocked {}", subnetId);
1289             } else {
1290                 LOG.debug("Unable to unlock subnet {}", subnetId);
1291             }
1292         } catch (InterruptedException | ExecutionException e) {
1293             LOG.error("Unable to unlock subnet {}", subnetId);
1294             throw new RuntimeException(String.format("Unable to unlock subnetId %s", subnetId), e.getCause());
1295         }
1296     }
1297
1298     static Optional<IpAddress> getGatewayIpAddressFromInterface(String srcInterface,
1299             INeutronVpnManager neutronVpnService, DataBroker dataBroker) {
1300         Optional<IpAddress> gatewayIp = Optional.absent();
1301         if (neutronVpnService != null) {
1302             //TODO(Gobinath): Need to fix this as assuming port will belong to only one Subnet would be incorrect"
1303             Port port = neutronVpnService.getNeutronPort(srcInterface);
1304             if (port != null && port.getFixedIps() != null && port.getFixedIps().get(0) != null
1305                 && port.getFixedIps().get(0).getSubnetId() != null) {
1306                 gatewayIp = Optional.of(
1307                     neutronVpnService.getNeutronSubnet(port.getFixedIps().get(0).getSubnetId()).getGatewayIp());
1308             }
1309         } else {
1310             LOG.debug("neutron vpn service is not configured");
1311         }
1312         return gatewayIp;
1313     }
1314
1315     static Optional<String> getGWMacAddressFromInterface(MacEntry macEntry, IpAddress gatewayIp,
1316         DataBroker dataBroker, OdlInterfaceRpcService interfaceRpc) {
1317         Optional<String> gatewayMac = Optional.absent();
1318         long vpnId = getVpnId(dataBroker, macEntry.getVpnName());
1319         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn
1320             .instance.VpnIds>
1321             vpnIdsInstanceIdentifier = VpnUtil.getVpnIdToVpnInstanceIdentifier(vpnId);
1322         Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance.VpnIds>
1323             vpnIdsOptional
1324             = VpnUtil.read(dataBroker, LogicalDatastoreType.CONFIGURATION, vpnIdsInstanceIdentifier);
1325         if (!vpnIdsOptional.isPresent()) {
1326             LOG.trace("VPN {} not configured", vpnId);
1327             return gatewayMac;
1328         }
1329         VpnPortipToPort vpnTargetIpToPort = VpnUtil.getNeutronPortFromVpnPortFixedIp(dataBroker,
1330             macEntry.getVpnName(), gatewayIp.getIpv4Address().getValue());
1331         if (vpnTargetIpToPort != null && vpnTargetIpToPort.isSubnetIp()) {
1332             gatewayMac = Optional.of(vpnTargetIpToPort.getMacAddress());
1333         } else {
1334             org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance.VpnIds vpnIds =
1335                 vpnIdsOptional.get();
1336             if (vpnIds.isExternalVpn()) {
1337                 gatewayMac = InterfaceUtils.getMacAddressForInterface(dataBroker, macEntry.getInterfaceName());
1338             }
1339         }
1340         return gatewayMac;
1341     }
1342
1343     public static void runOnlyInLeaderNode(EntityOwnershipService entityOwnershipService, Runnable job) {
1344         runOnlyInLeaderNode(entityOwnershipService, job, "");
1345     }
1346
1347     public static void runOnlyInLeaderNode(EntityOwnershipService entityOwnershipService, final Runnable job,
1348             final String jobDescription) {
1349         ListenableFuture<Boolean> checkEntityOwnerFuture = ClusteringUtils.checkNodeEntityOwner(
1350                 entityOwnershipService, VpnConstants.ARP_MONITORING_ENTITY,
1351                 VpnConstants.ARP_MONITORING_ENTITY);
1352         Futures.addCallback(checkEntityOwnerFuture, new FutureCallback<Boolean>() {
1353             @Override
1354             public void onSuccess(Boolean isOwner) {
1355                 if (isOwner) {
1356                     job.run();
1357                 } else {
1358                     LOG.trace("job is not run as i m not cluster owner desc :{} ", jobDescription);
1359                 }
1360             }
1361
1362             @Override
1363             public void onFailure(Throwable error) {
1364                 LOG.error("Failed to identity cluster owner ", error);
1365             }
1366         });
1367     }
1368
1369     public static boolean isVpnIntfPresentInVpnToDpnList(DataBroker broker, VpnInterface vpnInterface) {
1370         BigInteger dpnId = vpnInterface.getDpnId();
1371         String rd = VpnUtil.getVpnRd(broker, vpnInterface.getVpnInstanceName());
1372         VpnInstanceOpDataEntry vpnInstanceOpData = VpnUtil.getVpnInstanceOpDataFromCache(broker, rd);
1373         if (vpnInstanceOpData != null) {
1374             List<VpnToDpnList> dpnToVpns = vpnInstanceOpData.getVpnToDpnList();
1375             if (dpnToVpns != null) {
1376                 for (VpnToDpnList dpn : dpnToVpns) {
1377                     if (dpn.getDpnId().equals(dpnId)) {
1378                         return dpn.getVpnInterfaces().contains(vpnInterface.getName());
1379                     }
1380                 }
1381             }
1382         }
1383         return false;
1384     }
1385
1386     public static void setupGwMacIfExternalVpn(DataBroker dataBroker, IMdsalApiManager mdsalManager, BigInteger dpnId,
1387             String interfaceName, long vpnId, WriteTransaction writeInvTxn, int addOrRemove, org.opendaylight.yang.gen
1388             .v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface interfaceState) {
1389         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance
1390             .VpnIds> vpnIdsInstanceIdentifier = getVpnIdToVpnInstanceIdentifier(vpnId);
1391         Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance
1392             .VpnIds> vpnIdsOptional = read(
1393                 dataBroker, LogicalDatastoreType.CONFIGURATION, vpnIdsInstanceIdentifier);
1394         if (vpnIdsOptional.isPresent() && vpnIdsOptional.get().isExternalVpn()) {
1395             PhysAddress gwMacAddress = interfaceState.getPhysAddress();
1396             if (gwMacAddress == null) {
1397                 LOG.error("Failed to get gwMacAddress for interface {}", interfaceName);
1398                 return;
1399             }
1400             String gwMac = gwMacAddress.getValue();
1401             FlowEntity flowEntity = VpnUtil.buildL3vpnGatewayFlow(dpnId, gwMac, vpnId);
1402             if (addOrRemove == NwConstants.ADD_FLOW) {
1403                 mdsalManager.addFlowToTx(flowEntity, writeInvTxn);
1404             } else if (addOrRemove == NwConstants.DEL_FLOW) {
1405                 mdsalManager.removeFlowToTx(flowEntity, writeInvTxn);
1406             }
1407         }
1408     }
1409
1410
1411     public static Optional<VpnPortipToPort> getRouterInterfaceForVpnInterface(DataBroker dataBroker,
1412                                                                               String interfaceName,
1413                                                                               String vpnName,
1414                                                                               Uuid subnetUuid) {
1415         Optional<VpnPortipToPort> gwPortOptional = Optional.absent();
1416         if (subnetUuid != null) {
1417             final Optional<String> gatewayIp = getVpnSubnetGatewayIp(dataBroker, subnetUuid);
1418             if (gatewayIp.isPresent()) {
1419                 String gwIp = gatewayIp.get();
1420                 gwPortOptional = Optional.fromNullable(getNeutronPortFromVpnPortFixedIp(dataBroker, vpnName, gwIp));
1421             }
1422         }
1423         return gwPortOptional;
1424     }
1425
1426     public static Optional<String> getVpnSubnetGatewayIp(DataBroker dataBroker, final Uuid subnetUuid) {
1427         Optional<String> gwIpAddress = Optional.absent();
1428         final SubnetKey subnetkey = new SubnetKey(subnetUuid);
1429         final InstanceIdentifier<Subnet> subnetidentifier = InstanceIdentifier.create(Neutron.class)
1430                 .child(Subnets.class)
1431                 .child(Subnet.class, subnetkey);
1432         final Optional<Subnet> subnet = read(dataBroker, LogicalDatastoreType.CONFIGURATION, subnetidentifier);
1433         if (subnet.isPresent()) {
1434             Class<? extends IpVersionBase> ipVersionBase = subnet.get().getIpVersion();
1435             if (ipVersionBase.equals(IpVersionV4.class)) {
1436                 LOG.trace("Obtained subnet {} for vpn interface", subnet.get().getUuid().getValue());
1437                 gwIpAddress = Optional.of(subnet.get().getGatewayIp().getIpv4Address().getValue());
1438                 return gwIpAddress;
1439             }
1440         }
1441         return gwIpAddress;
1442     }
1443
1444     public static RouterToNaptSwitch getRouterToNaptSwitch(DataBroker dataBroker, String routerName) {
1445         InstanceIdentifier<RouterToNaptSwitch> id = InstanceIdentifier.builder(NaptSwitches.class)
1446                 .child(RouterToNaptSwitch.class, new RouterToNaptSwitchKey(routerName)).build();
1447         Optional<RouterToNaptSwitch> routerToNaptSwitchData = read(dataBroker, LogicalDatastoreType.CONFIGURATION, id);
1448         return routerToNaptSwitchData.isPresent() ? routerToNaptSwitchData.get() : null;
1449     }
1450
1451     public static BigInteger getPrimarySwitchForRouter(DataBroker dataBroker, String routerName) {
1452         RouterToNaptSwitch routerToNaptSwitch = getRouterToNaptSwitch(dataBroker, routerName);
1453         return routerToNaptSwitch != null ? routerToNaptSwitch.getPrimarySwitchId() : null;
1454     }
1455
1456     static boolean isL3VpnOverVxLan(Long l3Vni) {
1457         return (l3Vni != null && l3Vni != 0);
1458     }
1459
1460     static boolean isEvpnOverVxLan(Long l2Vni) { //To be used by RT2
1461         return (l2Vni != null && l2Vni != 0);
1462     }
1463
1464     static   String getGatewayMac(String interfaceName) {
1465         //OUI based MAC creation and use
1466         return VpnConstants.DEFAULT_GATEWAY_MAC_ADDRESS;
1467     }
1468
1469     /**
1470      * Retrieves the primary rd of a vpn instance
1471      * Primary rd will be the first rd in the list of rds configured for a vpn instance
1472      * If rd list is empty, primary rd will be vpn instance name
1473      * Use this function only during create operation cycles. For other operations, use getVpnRd() method.
1474      *
1475      * @param dataBroker dataBroker service reference
1476      * @param vpnName Name of the VPN
1477      * @return the primary rd of the VPN
1478      */
1479     public static String getPrimaryRd(DataBroker dataBroker, String vpnName) {
1480         InstanceIdentifier<VpnInstance> id  = getVpnInstanceIdentifier(vpnName);
1481         Optional<VpnInstance> vpnInstance = VpnUtil.read(dataBroker, LogicalDatastoreType.CONFIGURATION, id);
1482         if (vpnInstance.isPresent()) {
1483             return getPrimaryRd(vpnInstance.get());
1484         }
1485         return vpnName;
1486     }
1487
1488     /**
1489      * Retrieves the primary rd of a vpn instance
1490      * Primary rd will be the first rd in the list of rds configured for a vpn instance
1491      * If rd list is empty, primary rd will be vpn instance name
1492      * Use this function only during create operation cycles. For other operations, use getVpnRd() method.
1493      *
1494      * @param vpnInstance Config Vpn Instance Object
1495      * @return the primary rd of the VPN
1496      */
1497     public static String getPrimaryRd(VpnInstance vpnInstance) {
1498         List<String> rds = null;
1499         if (vpnInstance != null) {
1500             rds = getListOfRdsFromVpnInstance(vpnInstance);
1501         }
1502         return rds == null || rds.isEmpty() ? vpnInstance.getVpnInstanceName() : rds.get(0);
1503     }
1504
1505     public static boolean isBgpVpn(String vpnName, String primaryRd) {
1506         return !vpnName.equals(primaryRd);
1507     }
1508
1509     static java.util.Optional<String> allocateRdForExtraRouteAndUpdateUsedRdsMap(
1510             DataBroker dataBroker, long vpnId, String prefix, String vpnName,
1511             BigInteger dpnId, Adjacency adjacency, WriteTransaction writeOperTxn) {
1512         List<String> usedRds = getUsedRds(dataBroker, vpnId, prefix);
1513         //Check if rd is already allocated for the same prefix. Use same rd if extra route is behind same CSS.
1514         java.util.Optional<String> rdToAllocate = usedRds.stream()
1515                 .map(usedRd -> {
1516                     Optional<Routes> vpnExtraRoutes = getExtraRoutes(dataBroker, vpnName, usedRd, prefix);
1517                     return vpnExtraRoutes.isPresent() ? new ImmutablePair<String, String>(
1518                             vpnExtraRoutes.get().getNexthopIpList().get(0),
1519                             usedRd) : new ImmutablePair<String, String>("", "");
1520                 })
1521                 .filter(pair -> {
1522                     if (pair.getLeft().isEmpty()) {
1523                         return false;
1524                     }
1525                     Optional<Prefixes> prefixToInterface = getPrefixToInterface(dataBroker, vpnId, pair.getLeft());
1526                     return prefixToInterface.isPresent() ? dpnId.equals(prefixToInterface.get().getDpnId()) : false;
1527                 }).map(pair -> pair.getRight()).findFirst();
1528         if (rdToAllocate.isPresent()) {
1529             return rdToAllocate;
1530         }
1531         List<String> availableRds = getVpnRdsFromVpnInstanceConfig(dataBroker, vpnName);
1532         if (availableRds.isEmpty()) {
1533             LOG.debug("Internal vpn. Returning vpn name {} as rd", vpnName);
1534             return java.util.Optional.ofNullable(vpnName);
1535         }
1536         LOG.trace(
1537                 "Removing used rds {} from available rds {} vpnid {} . prefix is {} , vpname- {}, dpnId- {}, adj - {}",
1538                 usedRds, availableRds, vpnId, prefix, vpnName, dpnId, adjacency);
1539         availableRds.removeAll(usedRds);
1540         if (availableRds.isEmpty()) {
1541             LOG.error("No rd available from VpnInstance to allocate for new adjacency{}", adjacency);
1542             return java.util.Optional.empty();
1543         }
1544         // If rd is not allocated for this prefix or if extra route is behind different CSS, select a new rd.
1545         String rd = availableRds.get(0);
1546         usedRds.add(rd);
1547         syncUpdate(dataBroker, LogicalDatastoreType.OPERATIONAL, getUsedRdsIdentifier(vpnId, prefix),
1548                 getDestPrefixesBuilder(prefix, usedRds).build());
1549         return java.util.Optional.ofNullable(rd);
1550     }
1551
1552     static String getVpnNamePrefixKey(String vpnName, String prefix) {
1553         return vpnName + VpnConstants.SEPARATOR + prefix;
1554     }
1555
1556     public static List<String> getIpsListFromExternalIps(List<ExternalIps> externalIps) {
1557         if (externalIps == null) {
1558             return Collections.emptyList();
1559         }
1560
1561         return externalIps.stream().map(externalIp -> externalIp.getIpAddress()).collect(Collectors.toList());
1562     }
1563 }