mappingservice/lisp-proto/src/main/java/org/opendaylight/lispflowmapping/lisp/util/LispAddressUtil.java

   1 /*
   2  * Copyright (c) 2014 Contextream, Inc. 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.lispflowmapping.lisp.util;
   9
  10 import com.google.common.base.Preconditions;
  11 import com.google.common.net.InetAddresses;
  12 import java.net.Inet4Address;
  13 import java.net.Inet6Address;
  14 import java.net.InetAddress;
  15 import java.util.ArrayList;
  16 import java.util.List;
  17 import java.util.regex.Pattern;
  18 import org.apache.commons.lang3.tuple.ImmutablePair;
  19 import org.apache.commons.lang3.tuple.Pair;
  20 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber;
  21 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IetfInetUtil;
  22 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  23 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix;
  24 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
  25 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix;
  26 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address;
  27 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Prefix;
  28 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.AsNumberAfi;
  29 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.DistinguishedNameAfi;
  30 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.DistinguishedNameType;
  31 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.ExplicitLocatorPathLcaf;
  32 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.InstanceIdType;
  33 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.Ipv4Afi;
  34 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.Ipv4PrefixAfi;
  35 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.Ipv6Afi;
  36 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.Ipv6PrefixAfi;
  37 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.KeyValueAddressLcaf;
  38 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.LispAddressFamily;
  39 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.MacAfi;
  40 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.NoAddressAfi;
  41 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.ServicePathIdType;
  42 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.ServicePathLcaf;
  43 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.SimpleAddress;
  44 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.SourceDestKeyLcaf;
  45 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.Address;
  46 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.address.AsNumberBuilder;
  47 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.address.DistinguishedNameBuilder;
  48 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.address.Ipv4;
  49 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.address.Ipv4Builder;
  50 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.address.Ipv4PrefixBuilder;
  51 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.address.Ipv6;
  52 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.address.Ipv6Builder;
  53 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.address.Ipv6PrefixBuilder;
  54 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.address.KeyValueAddress;
  55 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.address.MacBuilder;
  56 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.address.NoAddressBuilder;
  57 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.address.ServicePathBuilder;
  58 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.address.explicit.locator.path.ExplicitLocatorPathBuilder;
  59 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.address.explicit.locator.path.explicit.locator.path.Hop;
  60 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.address.explicit.locator.path.explicit.locator.path.Hop.LrsBits;
  61 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.address.explicit.locator.path.explicit.locator.path.HopBuilder;
  62 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.address.key.value.address.KeyValueAddressBuilder;
  63 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.address.service.path.ServicePath;
  64 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.address.source.dest.key.SourceDestKey;
  65 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.address.source.dest.key.SourceDestKeyBuilder;
  66 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.inet.binary.types.rev160303.IpAddressBinary;
  68 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.inet.binary.types.rev160303.Ipv4AddressBinary;
  69 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.inet.binary.types.rev160303.Ipv6AddressBinary;
  70 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.binary.address.types.rev160504.Ipv4BinaryAfi;
  71 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.binary.address.types.rev160504.Ipv4PrefixBinaryAfi;
  72 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.binary.address.types.rev160504.Ipv6BinaryAfi;
  73 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.binary.address.types.rev160504.Ipv6PrefixBinaryAfi;
  74 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.binary.address.types.rev160504.augmented.lisp.address.address.Ipv4Binary;
  75 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.binary.address.types.rev160504.augmented.lisp.address.address.Ipv4BinaryBuilder;
  76 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.binary.address.types.rev160504.augmented.lisp.address.address.Ipv4PrefixBinary;
  77 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.binary.address.types.rev160504.augmented.lisp.address.address.Ipv4PrefixBinaryBuilder;
  78 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.binary.address.types.rev160504.augmented.lisp.address.address.Ipv6Binary;
  79 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.binary.address.types.rev160504.augmented.lisp.address.address.Ipv6BinaryBuilder;
  80 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.binary.address.types.rev160504.augmented.lisp.address.address.Ipv6PrefixBinary;
  81 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.binary.address.types.rev160504.augmented.lisp.address.address.Ipv6PrefixBinaryBuilder;
  82 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.container.Eid;
  83 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.container.EidBuilder;
  84 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.locatorrecords.LocatorRecord;
  85 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.locatorrecords.LocatorRecordBuilder;
  86 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.rloc.container.Rloc;
  87 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.rloc.container.RlocBuilder;
  88 import org.slf4j.Logger;
  89 import org.slf4j.LoggerFactory;
  90
  91 public final class LispAddressUtil {
  92     protected static final Logger LOG = LoggerFactory.getLogger(LispAddressUtil.class);
  93
  94     public static final short STARTING_SERVICE_INDEX = 255;
  95     private static final Pattern IP4_PATTERN =
  96             Pattern.compile("(([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.){3}([01]?\\d\\d?|2[0-4]\\d|25[0-5])",
  97             Pattern.CASE_INSENSITIVE);
  98     private static final Pattern IP6_PATTERN =
  99             Pattern.compile("([0-9a-f]{1,4}:){7}([0-9a-f]){1,4}", Pattern.CASE_INSENSITIVE);
 100
 101     // Utility class, should not be instantiated
 102     private LispAddressUtil() {
 103     }
 104
 105     public static Class<? extends LispAddressFamily> addressTypeFromSimpleAddress(SimpleAddress address) {
 106         if (address.getIpAddress() != null) {
 107             return binaryAddressTypeFromIpAddress(address.getIpAddress());
 108         } else if (address.getIpPrefix() != null) {
 109             return addressTypeFromIpPrefix(address.getIpPrefix());
 110         } else if (address.getMacAddress() != null) {
 111             return MacAfi.class;
 112         } else if (address.getDistinguishedNameType() != null) {
 113             return DistinguishedNameAfi.class;
 114         } else if (address.getAsNumber() != null) {
 115             return AsNumberAfi.class;
 116         }
 117         return null;
 118     }
 119
 120     public static Address addressFromSimpleAddress(SimpleAddress address) {
 121         if (address.getIpAddress() != null) {
 122             return binaryAddressFromIpAddress(address.getIpAddress());
 123         } else if (address.getIpPrefix() != null) {
 124             return addressFromIpPrefix(address.getIpPrefix());
 125         } else if (address.getMacAddress() != null) {
 126             return addressFromMacAddress(address.getMacAddress());
 127         } else if (address.getDistinguishedNameType() != null) {
 128             return addressFromDistinguishedName(address.getDistinguishedNameType());
 129         } else if (address.getAsNumber() != null) {
 130             return addressFromAsNumber(address.getAsNumber());
 131         }
 132         return null;
 133     }
 134
 135     public static Class<? extends LispAddressFamily> addressTypeFromInet(InetAddress address) {
 136         if (address instanceof Inet4Address) {
 137             return Ipv4Afi.class;
 138         } else if (address instanceof Inet6Address) {
 139             return Ipv6Afi.class;
 140         }
 141         return null;
 142     }
 143
 144     public static Address addressFromInet(InetAddress address) {
 145         if (address instanceof Inet4Address) {
 146             return (Address) new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types
 147                     .rev151105.lisp.address.address.Ipv4Builder()
 148                     .setIpv4(IetfInetUtil.INSTANCE.ipv4AddressFor(address)).build();
 149         } else if (address instanceof Inet6Address) {
 150             return (Address) new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types
 151                     .rev151105.lisp.address.address.Ipv6Builder()
 152                     .setIpv6(IetfInetUtil.INSTANCE.ipv6AddressFor(address)).build();
 153         }
 154         return null;
 155     }
 156
 157     public static Class<? extends LispAddressFamily> binaryAddressTypeFromInet(InetAddress address) {
 158         if (address instanceof Inet4Address) {
 159             return Ipv4BinaryAfi.class;
 160         } else if (address instanceof Inet6Address) {
 161             return Ipv6BinaryAfi.class;
 162         }
 163         return null;
 164     }
 165
 166     public static Address binaryAddressFromInet(InetAddress address) {
 167         if (address instanceof Inet4Address) {
 168             return (Address) new Ipv4BinaryBuilder().setIpv4Binary(new Ipv4AddressBinary(address.getAddress())).build();
 169         } else if (address instanceof Inet6Address) {
 170             return (Address) new Ipv6BinaryBuilder().setIpv6Binary(new Ipv6AddressBinary(address.getAddress())).build();
 171         }
 172         return null;
 173     }
 174
 175     public static Class<? extends LispAddressFamily> addressTypeFromIpAddress(IpAddress address) {
 176         if (address == null) {
 177             return null;
 178         } else if (address.getIpv4Address() != null) {
 179             return Ipv4Afi.class;
 180         } else if (address.getIpv6Address() != null) {
 181             return Ipv6Afi.class;
 182         }
 183         return null;
 184     }
 185
 186     public static Class<? extends LispAddressFamily> binaryAddressTypeFromIpAddress(IpAddress address) {
 187         if (address == null) {
 188             return null;
 189         } else if (address.getIpv4Address() != null) {
 190             return Ipv4BinaryAfi.class;
 191         } else if (address.getIpv6Address() != null) {
 192             return Ipv6BinaryAfi.class;
 193         }
 194         return null;
 195     }
 196
 197     public static Address addressFromIpAddress(IpAddress address) {
 198         if (address == null) {
 199             return null;
 200         } else if (address.getIpv4Address() != null) {
 201             return (Address) new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types
 202                     .rev151105.lisp.address.address.Ipv4Builder().setIpv4(address.getIpv4Address()).build();
 203         } else if (address.getIpv6Address() != null) {
 204             return (Address) new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types
 205                     .rev151105.lisp.address.address.Ipv6Builder().setIpv6(address.getIpv6Address()).build();
 206         }
 207         return null;
 208     }
 209
 210
 211     public static Address binaryAddressFromIpAddress(IpAddress address) {
 212         if (address == null) {
 213             return null;
 214         } else if (address.getIpv4Address() != null) {
 215             return (Address) new Ipv4BinaryBuilder().setIpv4Binary(new Ipv4AddressBinary(
 216                     InetAddresses.forString(address.getIpv4Address().getValue()).getAddress())).build();
 217         } else if (address.getIpv6Address() != null) {
 218             return (Address) new Ipv6BinaryBuilder().setIpv6Binary(new Ipv6AddressBinary(
 219                     InetAddresses.forString(address.getIpv6Address().getValue()).getAddress())).build();
 220         }
 221         return null;
 222     }
 223
 224     public static Class<? extends LispAddressFamily> addressTypeFromIpPrefix(IpPrefix address) {
 225         if (address == null) {
 226             return null;
 227         } else if (address.getIpv4Prefix() != null) {
 228             return Ipv4PrefixAfi.class;
 229         } else if (address.getIpv6Prefix() != null) {
 230             return Ipv6PrefixAfi.class;
 231         }
 232         return null;
 233     }
 234
 235     public static Address addressFromIpPrefix(IpPrefix address) {
 236         if (address == null) {
 237             return null;
 238         } else if (address.getIpv4Prefix() != null) {
 239             return (Address) new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types
 240                     .rev151105.lisp.address.address.Ipv4PrefixBuilder().setIpv4Prefix(address.getIpv4Prefix()).build();
 241         } else if (address.getIpv6Prefix() != null) {
 242             return (Address) new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types
 243                     .rev151105.lisp.address.address.Ipv6PrefixBuilder().setIpv6Prefix(address.getIpv6Prefix()).build();
 244         }
 245         return null;
 246     }
 247
 248     public static Address addressFromMacAddress(MacAddress address) {
 249         if (address == null) {
 250             return null;
 251         } else {
 252             return (Address) new MacBuilder().setMac(address).build();
 253         }
 254     }
 255
 256     public static Address addressFromServicePath(ServicePath address) {
 257         if (address == null) {
 258             return null;
 259         } else {
 260             return (Address) new ServicePathBuilder().setServicePath(address).build();
 261         }
 262     }
 263
 264     public static Address addressFromDistinguishedName(DistinguishedNameType address) {
 265         if (address == null) {
 266             return null;
 267         } else {
 268             return (Address) new DistinguishedNameBuilder().setDistinguishedName(address).build();
 269         }
 270     }
 271
 272     public static Address addressFromAsNumber(AsNumber address) {
 273         if (address == null) {
 274             return null;
 275         } else {
 276             return (Address) new AsNumberBuilder().setAsNumber(address).build();
 277         }
 278     }
 279
 280     public static Rloc toRloc(SimpleAddress address) {
 281         RlocBuilder builder = new RlocBuilder();
 282         builder.setAddressType(addressTypeFromSimpleAddress(address));
 283         builder.setVirtualNetworkId(null);
 284         builder.setAddress(addressFromSimpleAddress(address));
 285         return builder.build();
 286     }
 287
 288     public static Rloc toRloc(InetAddress address) {
 289         RlocBuilder builder = new RlocBuilder();
 290         builder.setAddressType(binaryAddressTypeFromInet(address));
 291         builder.setVirtualNetworkId(null);
 292         builder.setAddress(binaryAddressFromInet(address));
 293         return builder.build();
 294     }
 295
 296     public static Rloc toRloc(Ipv4Address address) {
 297         RlocBuilder builder = new RlocBuilder();
 298         builder.setAddressType(Ipv4Afi.class);
 299         builder.setVirtualNetworkId(null);
 300         builder.setAddress((Address) new Ipv4Builder().setIpv4(address).build());
 301         return builder.build();
 302     }
 303
 304     public static Rloc toRloc(Ipv4AddressBinary address) {
 305         RlocBuilder builder = new RlocBuilder();
 306         builder.setAddressType(Ipv4BinaryAfi.class);
 307         builder.setVirtualNetworkId(null);
 308         builder.setAddress((Address) new Ipv4BinaryBuilder().setIpv4Binary(address).build());
 309         return builder.build();
 310     }
 311
 312     public static Rloc toRloc(Ipv6Address address) {
 313         RlocBuilder builder = new RlocBuilder();
 314         builder.setAddressType(Ipv6Afi.class);
 315         builder.setVirtualNetworkId(null);
 316         builder.setAddress((Address) new Ipv6Builder().setIpv6(address).build());
 317         return builder.build();
 318     }
 319
 320     public static Rloc toRloc(Ipv6AddressBinary address) {
 321         RlocBuilder builder = new RlocBuilder();
 322         builder.setAddressType(Ipv6BinaryAfi.class);
 323         builder.setVirtualNetworkId(null);
 324         builder.setAddress((Address) new Ipv6BinaryBuilder().setIpv6Binary(address).build());
 325         return builder.build();
 326     }
 327
 328     public static Rloc asIpv4Rloc(String address) {
 329         return toRloc(new Ipv4AddressBinary(InetAddresses.forString(address).getAddress()));
 330     }
 331
 332     public static Rloc asIpv6Rloc(String address) {
 333         return toRloc(new Ipv6AddressBinary(InetAddresses.forString(address).getAddress()));
 334     }
 335
 336     public static Eid toEid(Ipv4Prefix prefix, InstanceIdType vni) {
 337         EidBuilder builder = new EidBuilder();
 338         builder.setAddressType(Ipv4PrefixAfi.class);
 339         builder.setVirtualNetworkId(vni);
 340         builder.setAddress((Address) new Ipv4PrefixBuilder().setIpv4Prefix(prefix).build());
 341         return builder.build();
 342     }
 343
 344     public static Eid toEid(Ipv4PrefixBinary prefix, InstanceIdType vni) {
 345         EidBuilder builder = new EidBuilder();
 346         builder.setAddressType(Ipv4PrefixBinaryAfi.class);
 347         builder.setVirtualNetworkId(vni);
 348         builder.setAddress((Address) prefix);
 349         return builder.build();
 350     }
 351
 352     public static Eid toEid(Ipv6PrefixBinary prefix, InstanceIdType vni) {
 353         EidBuilder builder = new EidBuilder();
 354         builder.setAddressType(Ipv6PrefixBinaryAfi.class);
 355         builder.setVirtualNetworkId(vni);
 356         builder.setAddress((Address) prefix);
 357         return builder.build();
 358     }
 359
 360     public static Eid toEid(Ipv4Address address, InstanceIdType vni) {
 361         EidBuilder builder = new EidBuilder();
 362         builder.setAddressType(Ipv4Afi.class);
 363         builder.setVirtualNetworkId(vni);
 364         builder.setAddress((Address) new Ipv4Builder().setIpv4(address).build());
 365         return builder.build();
 366     }
 367
 368     public static Eid toEid(Ipv4AddressBinary address, InstanceIdType vni) {
 369         EidBuilder builder = new EidBuilder();
 370         builder.setAddressType(Ipv4BinaryAfi.class);
 371         builder.setVirtualNetworkId(vni);
 372         builder.setAddress((Address) new Ipv4BinaryBuilder().setIpv4Binary(address).build());
 373         return builder.build();
 374     }
 375
 376     public static Eid toEid(IpPrefix prefix, InstanceIdType vni) {
 377         EidBuilder builder = new EidBuilder();
 378         builder.setAddress(addressFromIpPrefix(prefix));
 379         builder.setAddressType(addressTypeFromIpPrefix(prefix));
 380         builder.setVirtualNetworkId(vni);
 381         return builder.build();
 382     }
 383
 384     public static Eid toEid(Ipv6Address address, InstanceIdType vni) {
 385         EidBuilder builder = new EidBuilder();
 386         builder.setAddressType(Ipv6Afi.class);
 387         builder.setVirtualNetworkId(vni);
 388         builder.setAddress((Address) new Ipv6Builder().setIpv6(address).build());
 389         return builder.build();
 390     }
 391
 392     public static Eid toEid(Ipv6AddressBinary address, InstanceIdType vni) {
 393         EidBuilder builder = new EidBuilder();
 394         builder.setAddressType(Ipv6BinaryAfi.class);
 395         builder.setVirtualNetworkId(vni);
 396         builder.setAddress((Address) new Ipv6BinaryBuilder().setIpv6Binary(address).build());
 397         return builder.build();
 398     }
 399
 400     public static Eid toEid(DistinguishedNameType dn, InstanceIdType vni) {
 401         EidBuilder builder = new EidBuilder();
 402         builder.setAddressType(DistinguishedNameAfi.class);
 403         builder.setVirtualNetworkId(vni);
 404         builder.setAddress((Address) new DistinguishedNameBuilder().setDistinguishedName(dn).build());
 405         return builder.build();
 406     }
 407
 408     public static Eid toEid(MacAddress mac, InstanceIdType vni) {
 409         EidBuilder builder = new EidBuilder();
 410         builder.setAddressType(MacAfi.class);
 411         builder.setVirtualNetworkId(vni);
 412         builder.setAddress((Address) new MacBuilder().setMac(mac).build());
 413         return builder.build();
 414     }
 415
 416     public static Eid toEid(Ipv6Prefix prefix, InstanceIdType vni) {
 417         EidBuilder builder = new EidBuilder();
 418         builder.setAddressType(Ipv6PrefixAfi.class);
 419         builder.setVirtualNetworkId(vni);
 420         builder.setAddress((Address) new Ipv6PrefixBuilder().setIpv6Prefix(prefix).build());
 421         return builder.build();
 422     }
 423
 424     // XXX getMapping rcp fails if VNI set to 0
 425     public static Eid toEidNoVni(IpPrefix prefix) {
 426         EidBuilder builder = new EidBuilder();
 427         builder.setAddress(addressFromIpPrefix(prefix));
 428         builder.setAddressType(addressTypeFromIpPrefix(prefix));
 429         return builder.build();
 430     }
 431
 432     public static Eid toIpPrefixEid(IpAddress addr, int vni) {
 433         // If you touch this, be sure that sfclisp compiles!
 434         int mask = addressTypeFromIpAddress(addr) == Ipv4Afi.class ? 32 : 128;
 435         IpPrefix prefix = asIpPrefix(String.valueOf(addr.getValue()), mask);
 436         // XXX getMapping rcp fails if VNI set to 0
 437         return toEidNoVni(prefix);
 438     }
 439
 440     public static Eid asEid(SimpleAddress address, InstanceIdType vni) {
 441         EidBuilder builder = new EidBuilder();
 442         builder.setAddressType(addressTypeFromSimpleAddress(address));
 443         builder.setVirtualNetworkId(vni);
 444         // XXX Not sure if the below actually works as expected... also, what happens to AFI?
 445         builder.setAddress(addressFromSimpleAddress(address));
 446         return builder.build();
 447     }
 448
 449     public static Eid asIpv4PrefixEid(String prefix) {
 450         return asIpv4PrefixEid(prefix, null);
 451     }
 452
 453     public static Eid asIpv4PrefixEid(Ipv4Address addr, InstanceIdType vni) {
 454         return toEid(new IpPrefix(IetfInetUtil.INSTANCE.ipv4PrefixFor(addr)), vni);
 455     }
 456
 457     public static Eid asIpv4PrefixEid(final String prefix, final InstanceIdType iiType) {
 458         return toEid(new Ipv4Prefix(prefix), iiType);
 459     }
 460
 461     public static Eid asIpv4PrefixEid(Eid eid, Inet4Address address, short mask) {
 462         EidBuilder builder = new EidBuilder();
 463         builder.setAddressType(Ipv4PrefixAfi.class);
 464         builder.setVirtualNetworkId(eid.getVirtualNetworkId());
 465         builder.setAddress(new Ipv4PrefixBuilder().setIpv4Prefix(
 466                 IetfInetUtil.INSTANCE.ipv4PrefixFor(address, mask)).build());
 467         return builder.build();
 468     }
 469
 470     public static Eid asIpv4PrefixBinaryEid(final String prefix) {
 471         return asIpv4PrefixBinaryEid(prefix, null);
 472     }
 473
 474     public static Eid asIpv4PrefixBinaryEid(final String prefix, final InstanceIdType iiType) {
 475         String address = MaskUtil.getPrefixAddress(prefix);
 476         short mask = Short.valueOf(MaskUtil.getPrefixMask(prefix));
 477         byte[] ipv4 = InetAddresses.forString(address).getAddress();
 478         return toEid(new Ipv4PrefixBinaryBuilder().setIpv4AddressBinary(new Ipv4AddressBinary(ipv4))
 479                 .setIpv4MaskLength(mask).build(), iiType);
 480     }
 481
 482     public static Eid asIpv4PrefixBinaryEid(Eid eid, byte[] address, short mask) {
 483         Preconditions.checkArgument(address.length == 4,
 484                 "asIpv4PrefixBinaryEid called with incorrect length byte array ({})", address.length);
 485         EidBuilder builder = new EidBuilder();
 486         builder.setAddressType(Ipv4PrefixBinaryAfi.class);
 487         builder.setVirtualNetworkId(eid.getVirtualNetworkId());
 488         builder.setAddress(new Ipv4PrefixBinaryBuilder().setIpv4AddressBinary(new Ipv4AddressBinary(address))
 489                 .setIpv4MaskLength(mask).build());
 490         return builder.build();
 491     }
 492
 493     public static Eid asIpv4Eid(String address) {
 494         return toEid(new Ipv4AddressBinary(InetAddresses.forString(address).getAddress()), null);
 495     }
 496
 497     public static Eid asIpv4Eid(String address, long vni) {
 498         return toEid(new Ipv4AddressBinary(InetAddresses.forString(address).getAddress()), new InstanceIdType(vni));
 499     }
 500
 501     public static Eid asIpv6Eid(String address) {
 502         return toEid(new Ipv6AddressBinary(InetAddresses.forString(address).getAddress()), null);
 503     }
 504
 505     public static Eid asIpv6Eid(String address, long vni) {
 506         return toEid(new Ipv6AddressBinary(InetAddresses.forString(address).getAddress()), new InstanceIdType(vni));
 507     }
 508
 509     public static Eid asIpv6PrefixEid(String prefix) {
 510         return toEid(new Ipv6Prefix(prefix), null);
 511     }
 512
 513     public static Eid asIpv6PrefixEid(Ipv6Address addr, InstanceIdType vni) {
 514         return toEid(new IpPrefix(IetfInetUtil.INSTANCE.ipv6PrefixFor(addr)), vni);
 515     }
 516
 517     public static Eid asIpv6PrefixEid(Eid eid, Inet6Address address, short mask) {
 518         EidBuilder builder = new EidBuilder();
 519         builder.setAddressType(Ipv6PrefixAfi.class);
 520         builder.setVirtualNetworkId(eid.getVirtualNetworkId());
 521         builder.setAddress(new Ipv6PrefixBuilder().setIpv6Prefix(
 522                 IetfInetUtil.INSTANCE.ipv6PrefixFor(address, mask)).build());
 523         return builder.build();
 524     }
 525
 526     public static Eid asIpv6PrefixBinaryEid(final String prefix) {
 527         return asIpv6PrefixBinaryEid(prefix, null);
 528     }
 529
 530     public static Eid asIpv6PrefixBinaryEid(final String prefix, final InstanceIdType iiType) {
 531         String address = MaskUtil.getPrefixAddress(prefix);
 532         short mask = Short.valueOf(MaskUtil.getPrefixMask(prefix));
 533         byte[] ipv6 = InetAddresses.forString(address).getAddress();
 534         return toEid(new Ipv6PrefixBinaryBuilder().setIpv6AddressBinary(new Ipv6AddressBinary(ipv6))
 535                 .setIpv6MaskLength(mask).build(), iiType);
 536     }
 537
 538     public static Eid asIpv6PrefixBinaryEid(Eid eid, byte[] address, short mask) {
 539         Preconditions.checkArgument(address.length == 16,
 540                 "asIpv6PrefixBinaryEid called with incorrect length byte array ({})", address.length);
 541         EidBuilder builder = new EidBuilder();
 542         builder.setAddressType(Ipv6PrefixBinaryAfi.class);
 543         builder.setVirtualNetworkId(eid.getVirtualNetworkId());
 544         builder.setAddress(new Ipv6PrefixBinaryBuilder().setIpv6AddressBinary(new Ipv6AddressBinary(address))
 545                 .setIpv6MaskLength(mask).build());
 546         return builder.build();
 547     }
 548
 549     public static Eid asBinaryEid(SimpleAddress address, InstanceIdType iid) {
 550         if (address.getIpPrefix() != null) {
 551             if (address.getIpPrefix().getIpv4Prefix() != null) {
 552                 return LispAddressUtil.asIpv4PrefixBinaryEid(address.getIpPrefix().getIpv4Prefix().getValue(), iid);
 553             } else if (address.getIpPrefix().getIpv6Prefix() != null) {
 554                 return LispAddressUtil.asIpv6PrefixBinaryEid(address.getIpPrefix().getIpv6Prefix().getValue(), iid);
 555             }
 556         } else if (address.getIpAddress() != null) {
 557             if (address.getIpAddress().getIpv4Address() != null) {
 558                 LispAddressUtil.toEid(new Ipv4AddressBinary(InetAddresses.forString(
 559                         address.getIpAddress().getIpv4Address().getValue()).getAddress()), iid);
 560             } else if (address.getIpAddress().getIpv6Address() != null) {
 561                 LispAddressUtil.toEid(new Ipv6AddressBinary(InetAddresses.forString(
 562                         address.getIpAddress().getIpv6Address().getValue()).getAddress()), iid);
 563             }
 564         }
 565         return LispAddressUtil.asEid(address, iid);
 566     }
 567
 568     public static int ipVersionFromString(String ip) {
 569         if (IP4_PATTERN.matcher(ip).matches()) {
 570             return 4;
 571         } else if (IP6_PATTERN.matcher(ip).matches()) {
 572             return 6;
 573         } else {
 574             return 0;
 575         }
 576     }
 577
 578     public static IpPrefix asIpPrefix(String addr, int mask) {
 579         int version = ipVersionFromString(addr);
 580         if (version == 4 && (mask >= 0 && mask <= 32)) {
 581             return new IpPrefix(new Ipv4Prefix(addr + "/" + mask));
 582         } else if (version == 6 && (mask >= 0 && mask <= 128)) {
 583             return new IpPrefix(new Ipv6Prefix(addr + "/" + mask));
 584         } else {
 585             return null;
 586         }
 587     }
 588
 589     public static Eid asServicePathEid(long vni, long servicePathId, short serviceIndex) {
 590         EidBuilder eb = new EidBuilder();
 591         eb.setAddressType(ServicePathLcaf.class);
 592         if (vni >= 0) {
 593             eb.setVirtualNetworkId(new InstanceIdType(vni));
 594         }
 595         org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105
 596                 .lisp.address.address.service.path.ServicePathBuilder spb =
 597                 new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105
 598                 .lisp.address.address.service.path.ServicePathBuilder();
 599         spb.setServicePathId(new ServicePathIdType(servicePathId));
 600         spb.setServiceIndex(serviceIndex);
 601         return eb.setAddress(addressFromServicePath(spb.build())).build();
 602     }
 603
 604     public static Eid asMacEid(String address, long vni) {
 605         return toEid(new MacAddress(address), new InstanceIdType(vni));
 606     }
 607
 608     public static Eid asMacEid(String address) {
 609         return toEid(new MacAddress(address), null);
 610     }
 611
 612     public static Eid asDistinguishedNameEid(String address, long vni) {
 613         return toEid(new MacAddress(address), new InstanceIdType(vni));
 614     }
 615
 616     public static Eid asDistinguishedNameEid(String address) {
 617         return toEid(new DistinguishedNameType(address), null);
 618     }
 619
 620     public static Eid asKeyValueAddressEid(SimpleAddress key, SimpleAddress value) {
 621         KeyValueAddressBuilder kvab = new KeyValueAddressBuilder();
 622         kvab.setKey(key);
 623         kvab.setValue(value);
 624         KeyValueAddress address = new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types
 625                 .rev151105.lisp.address.address.KeyValueAddressBuilder()
 626                 .setKeyValueAddress(kvab.build()).build();
 627         EidBuilder builder = new EidBuilder();
 628         builder.setAddressType(KeyValueAddressLcaf.class);
 629         builder.setVirtualNetworkId(null);
 630         builder.setAddress((Address) address);
 631         return builder.build();
 632     }
 633
 634     public static Rloc asKeyValueAddressRloc(SimpleAddress key, SimpleAddress value) {
 635         KeyValueAddressBuilder kvab = new KeyValueAddressBuilder();
 636         kvab.setKey(key);
 637         kvab.setValue(value);
 638         KeyValueAddress address = new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types
 639                 .rev151105.lisp.address.address.KeyValueAddressBuilder()
 640                 .setKeyValueAddress(kvab.build()).build();
 641         RlocBuilder builder = new RlocBuilder();
 642         builder.setAddressType(KeyValueAddressLcaf.class);
 643         builder.setVirtualNetworkId(null);
 644         builder.setAddress((Address) address);
 645         return builder.build();
 646     }
 647
 648     public static Rloc asKeyValueAddress(String key, SimpleAddress value) {
 649         return asKeyValueAddressRloc(new SimpleAddress(new DistinguishedNameType(key)), value);
 650     }
 651
 652     public static SourceDestKey asSrcDst(String src, String dst, int smask, int dmask) {
 653         SourceDestKeyBuilder builder = new SourceDestKeyBuilder();
 654         builder.setSource(new SimpleAddress(asIpPrefix(src, smask)));
 655         builder.setDest(new SimpleAddress(asIpPrefix(dst, dmask)));
 656         return builder.build();
 657     }
 658
 659     public static Eid asSrcDstEid(String src, String dst, int smask, int dmask, int vni) {
 660         EidBuilder builder = new EidBuilder();
 661         builder.setAddressType(SourceDestKeyLcaf.class);
 662         builder.setVirtualNetworkId(new InstanceIdType(Long.valueOf(vni)));
 663         builder.setAddress(
 664                 new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105
 665                         .lisp.address.address.SourceDestKeyBuilder()
 666                         .setSourceDestKey(asSrcDst(src, dst, smask, dmask)).build());
 667
 668         return builder.build();
 669     }
 670
 671     public static Eid asSrcDstEid(SourceDestKey sd, InstanceIdType vni) {
 672         EidBuilder builder = new EidBuilder();
 673         builder.setAddressType(SourceDestKeyLcaf.class);
 674         builder.setVirtualNetworkId(vni);
 675         builder.setAddress(new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types
 676                 .rev151105.lisp.address.address.SourceDestKeyBuilder().setSourceDestKey(sd).build());
 677         return builder.build();
 678     }
 679
 680     public static Rloc asTeLcafRloc(List<IpAddress> hopList) {
 681         ExplicitLocatorPathBuilder teAddrBuilder = new ExplicitLocatorPathBuilder();
 682         teAddrBuilder.setHop(new ArrayList<Hop>());
 683         for (IpAddress hop : hopList) {
 684             HopBuilder hopBuilder = new HopBuilder();
 685             hopBuilder.setAddress(new SimpleAddress(hop));
 686             hopBuilder.setHopId("Hop " + teAddrBuilder.getHop().size());
 687             hopBuilder.setLrsBits(new LrsBits(false, false, false));
 688             teAddrBuilder.getHop().add(hopBuilder.build());
 689         }
 690
 691         org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105
 692             .lisp.address.address.ExplicitLocatorPathBuilder elpBuilder =
 693             new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105
 694             .lisp.address.address.ExplicitLocatorPathBuilder();
 695         elpBuilder.setExplicitLocatorPath(teAddrBuilder.build());
 696
 697         RlocBuilder teBuilder = new RlocBuilder();
 698         teBuilder.setAddress(elpBuilder.build());
 699         teBuilder.setAddressType(ExplicitLocatorPathLcaf.class);
 700         return teBuilder.build();
 701     }
 702
 703     public static List<LocatorRecord> asLocatorRecords(List<Rloc> locators) {
 704         List<LocatorRecord> locatorRecords = new ArrayList<LocatorRecord>();
 705         for (Rloc locator : locators) {
 706             LocatorRecordBuilder locatorBuilder = new LocatorRecordBuilder();
 707             locatorBuilder.setLocalLocator(false).setRlocProbed(false).setWeight((short) 1).setPriority((short) 1)
 708                     .setMulticastWeight((short) 1).setMulticastPriority((short) 1).setRouted(true)
 709                     .setRloc(locator).setLocatorId("SFC_LISP").build();
 710             locatorRecords.add(locatorBuilder.build());
 711         }
 712         return locatorRecords;
 713     }
 714
 715     public static Eid getNoAddressEid() {
 716         EidBuilder builder = new EidBuilder();
 717         builder.setAddressType(NoAddressAfi.class);
 718         builder.setVirtualNetworkId(null);
 719         builder.setAddress(new NoAddressBuilder().setNoAddress(true).build());
 720         return builder.build();
 721     }
 722
 723     public static byte[] ipAddressToByteArray(Address addr) {
 724         if (addr instanceof Ipv4) {
 725             return InetAddresses.forString(((Ipv4) addr).getIpv4().getValue()).getAddress();
 726         } else if (addr instanceof Ipv6) {
 727             return InetAddresses.forString(((Ipv6) addr).getIpv6().getValue()).getAddress();
 728         } else if (addr instanceof Ipv4Binary) {
 729             return ((Ipv4Binary) addr).getIpv4Binary().getValue();
 730         } else if (addr instanceof Ipv6Binary) {
 731             return ((Ipv6Binary) addr).getIpv6Binary().getValue();
 732         } else {
 733             return null;
 734         }
 735     }
 736
 737     private static Ipv4PrefixBinary convertToBinary(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf
 738             .lisp.address.types.rev151105.lisp.address.address.Ipv4Prefix prefix) {
 739         Ipv4PrefixBinaryBuilder pb = new Ipv4PrefixBinaryBuilder();
 740         byte[] address = InetAddresses.forString(MaskUtil.getAddressStringForIpv4Prefix(prefix)).getAddress();
 741         pb.setIpv4AddressBinary(new Ipv4AddressBinary(address));
 742         pb.setIpv4MaskLength(MaskUtil.getMaskForAddress(prefix));
 743         return pb.build();
 744     }
 745
 746     private static Ipv6PrefixBinary convertToBinary(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf
 747             .lisp.address.types.rev151105.lisp.address.address.Ipv6Prefix prefix) {
 748         Ipv6PrefixBinaryBuilder pb = new Ipv6PrefixBinaryBuilder();
 749         byte[] address = InetAddresses.forString(MaskUtil.getAddressStringForIpv6Prefix(prefix)).getAddress();
 750         pb.setIpv6AddressBinary(new Ipv6AddressBinary(address));
 751         pb.setIpv6MaskLength(MaskUtil.getMaskForAddress(prefix));
 752         return pb.build();
 753     }
 754
 755     private static Ipv4Binary convertToBinary(Ipv4 address) {
 756         byte[] addr = InetAddresses.forString(address.getIpv4().getValue()).getAddress();
 757         return new Ipv4BinaryBuilder().setIpv4Binary(new Ipv4AddressBinary(addr)).build();
 758     }
 759
 760     private static Ipv6Binary convertToBinary(Ipv6 address) {
 761         byte[] addr = InetAddresses.forString(address.getIpv6().getValue()).getAddress();
 762         return new Ipv6BinaryBuilder().setIpv6Binary(new Ipv6AddressBinary(addr)).build();
 763     }
 764
 765     private static Pair<Class<? extends LispAddressFamily>, Address> convertToBinary(Address addr) {
 766         Address convAddr = null;
 767         Class<? extends LispAddressFamily> convType = null;
 768         if (addr instanceof org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf
 769                 .lisp.address.types.rev151105.lisp.address.address.Ipv4Prefix) {
 770             convAddr = convertToBinary((org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf
 771                     .lisp.address.types.rev151105.lisp.address.address.Ipv4Prefix) addr);
 772             convType = Ipv4PrefixBinaryAfi.class;
 773         } else if (addr instanceof org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf
 774                 .lisp.address.types.rev151105.lisp.address.address.Ipv6Prefix) {
 775             convAddr = convertToBinary((org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf
 776                     .lisp.address.types.rev151105.lisp.address.address.Ipv6Prefix) addr);
 777             convType = Ipv6PrefixBinaryAfi.class;
 778         } else if (addr instanceof Ipv4) {
 779             convAddr = convertToBinary((Ipv4) addr);
 780             convType = Ipv4BinaryAfi.class;
 781         } else if (addr instanceof Ipv6) {
 782             convAddr = convertToBinary((Ipv6) addr);
 783             convType = Ipv6BinaryAfi.class;
 784         }
 785         return new ImmutablePair<Class<? extends LispAddressFamily>, Address>(convType, convAddr);
 786     }
 787
 788     public static Eid convertToBinary(Eid eid) {
 789         Pair<Class<? extends LispAddressFamily>, Address> converted = convertToBinary(eid.getAddress());
 790         if (converted.getRight() == null) {
 791             return eid;
 792         }
 793         EidBuilder eb = new EidBuilder(eid);
 794         eb.setAddressType(converted.getLeft());
 795         eb.setAddress(converted.getRight());
 796         return eb.build();
 797     }
 798
 799     public static Rloc convertToBinary(Rloc rloc) {
 800         Pair<Class<? extends LispAddressFamily>, Address> converted = convertToBinary(rloc.getAddress());
 801         if (converted.getRight() == null) {
 802             return rloc;
 803         }
 804         RlocBuilder rb = new RlocBuilder(rloc);
 805         rb.setAddressType(converted.getLeft());
 806         rb.setAddress(converted.getRight());
 807         return rb.build();
 808     }
 809
 810     /**
 811      * Converts the {@link InetAddress} into Ipv4 or Ipv6 {@link IpAddressBinary}. If null parameter is passed, method
 812      * returns the Ipv4 loopback address (127.0.0.1).
 813      *
 814      * @param inetAddress Any Ipv4 or Ipv6 InetAddress.
 815      * @return The converted Ipv4 or Ipv6 IpAddressBinary, or Ipv4 loopback address (127.0.0.1) if null is passed.
 816      */
 817     public static IpAddressBinary addressBinaryFromInet(InetAddress inetAddress) {
 818         if (inetAddress == null) {
 819             inetAddress = Inet4Address.getLoopbackAddress();
 820         }
 821
 822         if (inetAddress instanceof Inet4Address) {
 823             return new IpAddressBinary(new Ipv4AddressBinary(inetAddress.getAddress()));
 824         } else if (inetAddress instanceof Inet6Address) {
 825             return new IpAddressBinary(new Ipv6AddressBinary(inetAddress.getAddress()));
 826         }
 827         return null;
 828     }
 829
 830     private static org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105
 831             .lisp.address.address.Ipv4Prefix convertFromBinary(Ipv4PrefixBinary prefix) {
 832         return new Ipv4PrefixBuilder().setIpv4Prefix(IetfInetUtil.INSTANCE.ipv4PrefixFor(
 833                 prefix.getIpv4AddressBinary().getValue(),
 834                 prefix.getIpv4MaskLength())).build();
 835     }
 836
 837     private static org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105
 838             .lisp.address.address.Ipv6Prefix convertFromBinary(Ipv6PrefixBinary prefix) {
 839         return new Ipv6PrefixBuilder().setIpv6Prefix(IetfInetUtil.INSTANCE.ipv6PrefixFor(
 840                 prefix.getIpv6AddressBinary().getValue(),
 841                 prefix.getIpv6MaskLength())).build();
 842     }
 843
 844     private static Ipv4 convertFromBinary(Ipv4Binary address) {
 845         return new Ipv4Builder().setIpv4(IetfInetUtil.INSTANCE.ipv4AddressFor(address.getIpv4Binary().getValue()))
 846                 .build();
 847     }
 848
 849     private static Ipv6 convertFromBinary(Ipv6Binary address) {
 850         return new Ipv6Builder().setIpv6(IetfInetUtil.INSTANCE.ipv6AddressFor(address.getIpv6Binary().getValue()))
 851                 .build();
 852     }
 853
 854     private static Pair<Class<? extends LispAddressFamily>, Address> convertFromBinary(Address addr) {
 855         Address convAddr = null;
 856         Class<? extends LispAddressFamily> convType = null;
 857         if (addr instanceof Ipv4PrefixBinary) {
 858             convAddr = convertFromBinary((Ipv4PrefixBinary) addr);
 859             convType = Ipv4PrefixAfi.class;
 860         } else if (addr instanceof Ipv6PrefixBinary) {
 861             convAddr = convertFromBinary((Ipv6PrefixBinary) addr);
 862             convType = Ipv6PrefixAfi.class;
 863         } else if (addr instanceof Ipv4Binary) {
 864             convAddr = convertFromBinary((Ipv4Binary) addr);
 865             convType = Ipv4Afi.class;
 866         } else if (addr instanceof Ipv6Binary) {
 867             convAddr = convertFromBinary((Ipv6Binary) addr);
 868             convType = Ipv6Afi.class;
 869         }
 870         return new ImmutablePair<Class<? extends LispAddressFamily>, Address>(convType, convAddr);
 871     }
 872
 873     public static Eid convertFromBinary(Eid eid) {
 874         Pair<Class<? extends LispAddressFamily>, Address> converted = convertFromBinary(eid.getAddress());
 875         if (converted.getRight() == null) {
 876             return eid;
 877         }
 878         EidBuilder eb = new EidBuilder(eid);
 879         eb.setAddressType(converted.getLeft());
 880         eb.setAddress(converted.getRight());
 881         return eb.build();
 882     }
 883
 884     public static Rloc convertFromBinary(Rloc rloc) {
 885         Pair<Class<? extends LispAddressFamily>, Address> converted = convertFromBinary(rloc.getAddress());
 886         if (converted.getRight() == null) {
 887             return rloc;
 888         }
 889         RlocBuilder rb = new RlocBuilder(rloc);
 890         rb.setAddressType(converted.getLeft());
 891         rb.setAddress(converted.getRight());
 892         return rb.build();
 893     }
 894
 895     public static boolean addressNeedsConversionToBinary(Address address) {
 896         if (address instanceof Ipv4 || address instanceof Ipv6
 897                 || address instanceof org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf
 898                         .lisp.address.types.rev151105.lisp.address.address.Ipv4Prefix
 899                 || address instanceof org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf
 900                         .lisp.address.types.rev151105.lisp.address.address.Ipv6Prefix) {
 901             return true;
 902         }
 903         return false;
 904     }
 905
 906     public static boolean addressNeedsConversionFromBinary(Address address) {
 907         if (address instanceof Ipv4Binary || address instanceof Ipv6Binary
 908                 || address instanceof Ipv4PrefixBinary || address instanceof Ipv6PrefixBinary) {
 909             return true;
 910         }
 911         return false;
 912     }
 913
 914     public static int compareIpAddressByteArrays(byte[] one, byte[] two) {
 915         if (one.length < two.length) {
 916             return -1;
 917         } else if (one.length > two.length) {
 918             return 1;
 919         } else if (one.length == 4 && two.length == 4) {
 920             for (int i = 0; i < 4; i++) {
 921                 if (one[i] < two[i]) {
 922                     return -1;
 923                 } else if (one[i] > two[i]) {
 924                     return 1;
 925                 }
 926             }
 927             return 0;
 928         } else if (one.length == 16 && two.length == 16) {
 929             for (int i = 0; i < 16; i++) {
 930                 if (one[i] < two[i]) {
 931                     return -1;
 932                 } else if (one[i] > two[i]) {
 933                     return 1;
 934                 }
 935             }
 936             return 0;
 937         }
 938         return 0;
 939     }
 940
 941     public static short getIpPrefixMask(Eid eid) {
 942         Address addr = eid.getAddress();
 943         if (addr instanceof Ipv4PrefixBinary) {
 944             return ((Ipv4PrefixBinary) addr).getIpv4MaskLength();
 945         } else if (addr instanceof Ipv6PrefixBinary) {
 946             return ((Ipv6PrefixBinary) addr).getIpv6MaskLength();
 947         }
 948         return 0;
 949     }
 950 }