model/ietf/ietf-type-util/src/main/java/org/opendaylight/mdsal/model/ietf/util/AbstractIetfInetUtil.java

   1 /*
   2  * Copyright (c) 2016 Pantheon Technologies s.r.o. 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.mdsal.model.ietf.util;
   9
  10 import com.google.common.annotations.Beta;
  11 import com.google.common.base.Preconditions;
  12 import com.google.common.net.InetAddresses;
  13 import com.google.common.primitives.UnsignedBytes;
  14 import java.net.Inet4Address;
  15 import java.net.Inet6Address;
  16 import java.net.InetAddress;
  17 import java.net.UnknownHostException;
  18 import java.util.AbstractMap.SimpleImmutableEntry;
  19 import java.util.Map.Entry;
  20 import javax.annotation.Nonnull;
  21 import org.opendaylight.yangtools.yang.binding.util.StringValueObjectFactory;
  22
  23 /**
  24  * A set of utility methods to efficiently instantiate various ietf-inet-types DTOs.
  25  */
  26 @Beta
  27 public abstract class AbstractIetfInetUtil<A4, P4, A6, P6, A> {
  28     private final StringValueObjectFactory<A4> address4Factory;
  29     private final StringValueObjectFactory<P4> prefix4Factory;
  30     private final StringValueObjectFactory<A6> address6Factory;
  31     private final StringValueObjectFactory<P6> prefix6Factory;
  32
  33     protected AbstractIetfInetUtil(final Class<A4> addr4Class, final Class<P4> prefix4Class,
  34             final Class<A6> addr6Class, final Class<P6> prefix6Class) {
  35         this.address4Factory = StringValueObjectFactory.create(addr4Class, "0.0.0.0");
  36         this.prefix4Factory = StringValueObjectFactory.create(prefix4Class, "0.0.0.0/0");
  37         this.address6Factory = StringValueObjectFactory.create(addr6Class, "::0");
  38         this.prefix6Factory = StringValueObjectFactory.create(prefix6Class, "::0/0");
  39     }
  40
  41     protected abstract A ipv4Address(A4 addr);
  42     protected abstract A ipv6Address(A6 addr);
  43     protected abstract String ipv4AddressString(A4 addr);
  44     protected abstract String ipv6AddressString(A6 addr);
  45     protected abstract String ipv4PrefixString(P4 prefix);
  46     protected abstract String ipv6PrefixString(P6 prefix);
  47
  48     @Nonnull public final A ipAddressFor(@Nonnull final byte[] bytes) {
  49         switch (bytes.length) {
  50             case 4:
  51                 return ipv4Address(ipv4AddressFor(bytes));
  52             case 16:
  53                 return ipv6Address(ipv6AddressFor(bytes));
  54             default:
  55                 throw new IllegalArgumentException("Invalid array length " + bytes.length);
  56         }
  57     }
  58
  59     @Nonnull public final A ipAddressFor(@Nonnull final InetAddress addr) {
  60         Preconditions.checkNotNull(addr, "Address must not be null");
  61         if (addr instanceof Inet4Address) {
  62             return ipv4Address(ipv4AddressFor(addr));
  63         } else if (addr instanceof Inet6Address) {
  64             return ipv6Address(ipv6AddressFor(addr));
  65         } else {
  66             throw new IllegalArgumentException("Unhandled address " + addr);
  67         }
  68     }
  69
  70     /**
  71      * Create an Ipv4Address by interpreting input bytes as an IPv4 address.
  72      *
  73      * @param bytes 4-byte array
  74      * @return An Ipv4Address object
  75      * @throws IllegalArgumentException if bytes has length different from 4
  76      * @throws NullPointerException if bytes is null
  77      */
  78     @Nonnull public final A4 ipv4AddressFor(@Nonnull final byte[] bytes) {
  79         return address4Factory.newInstance(addressStringV4(bytes));
  80     }
  81
  82     /**
  83      * Create an Ipv4Address by interpreting an {@link Inet4Address}.
  84      *
  85      * @param addr An {@link Inet4Address}
  86      * @return An Ipv4Address object
  87      * @throws IllegalArgumentException if addr is not an {@link Inet4Address}
  88      * @throws NullPointerException if addr is null
  89      */
  90     @Nonnull public final A4 ipv4AddressFor(@Nonnull final InetAddress addr) {
  91         Preconditions.checkNotNull(addr, "Address must not be null");
  92         Preconditions.checkArgument(addr instanceof Inet4Address, "Address has to be an Inet4Address");
  93         return address4Factory.newInstance(addr.getHostAddress());
  94     }
  95
  96     @Nonnull public final A4 ipv4AddressFrom(@Nonnull final P4 prefix) {
  97         return prefixToAddress(address4Factory, ipv4PrefixString(prefix));
  98     }
  99
 100     /**
 101      * Create a /32 Ipv4Prefix by interpreting input bytes as an IPv4 address.
 102      *
 103      * @param bytes four-byte array
 104      * @return An Ipv4Prefix object
 105      * @throws IllegalArgumentException if bytes has length different from 4
 106      * @throws NullPointerException if bytes is null
 107      */
 108     @Nonnull public final P4 ipv4PrefixFor(@Nonnull final byte[] bytes) {
 109         return prefix4Factory.newInstance(prefixStringV4(bytes));
 110     }
 111
 112     /**
 113      * Create a Ipv4Prefix by combining the address with a mask. The address
 114      * bytes are interpreted as an address and the specified mask is concatenated to
 115      * it. The address bytes are not masked, hence input <code>address = { 1, 2, 3, 4 }</code>
 116      * and <code>mask=24</code> will result in <code>1.2.3.4/24</code>.
 117      *
 118      * @param address Input address as a 4-byte array
 119      * @param mask Prefix mask
 120      * @return An Ipv4Prefix object
 121      * @throws IllegalArgumentException if bytes has length different from 4 or if mask is not in range 0-32
 122      * @throws NullPointerException if bytes is null
 123      */
 124     @Nonnull public final P4 ipv4PrefixFor(@Nonnull final byte[] address, final int mask) {
 125         return prefix4Factory.newInstance(prefixStringV4(address, mask));
 126     }
 127
 128     /**
 129      * Create a /32 Ipv4Prefix for an {@link Inet4Address}
 130      *
 131      * @param addr An {@link Inet4Address}
 132      * @return An Ipv4Prefix object
 133      * @throws IllegalArgumentException if addr is not an Inet4Address
 134      * @throws NullPointerException if adds is null
 135      */
 136     @Nonnull public final P4 ipv4PrefixFor(@Nonnull final InetAddress addr) {
 137         Preconditions.checkNotNull(addr, "Address must not be null");
 138         Preconditions.checkArgument(addr instanceof Inet4Address, "Address has to be an Inet4Address");
 139         return prefix4Factory.newInstance(addr.getHostAddress() + "/32");
 140     }
 141
 142     /**
 143      * Create a Ipv4Prefix by combining the address with a mask. The address bytes are not masked.
 144      *
 145      * @param addr An {@link Inet4Address}
 146      * @param mask Prefix mask
 147      * @return An Ipv4Prefix object
 148      * @throws IllegalArgumentException if addr is not an Inet4Address or if mask is not in range 0-32
 149      * @throws NullPointerException if addr is null
 150      */
 151     @Nonnull public final P4 ipv4PrefixFor(@Nonnull final InetAddress addr, final int mask) {
 152         Preconditions.checkNotNull(addr, "Address must not be null");
 153         Preconditions.checkArgument(addr instanceof Inet4Address, "Address has to be an Inet4Address");
 154         Preconditions.checkArgument(mask >= 0 && mask <= 32, "Invalid mask %s", mask);
 155         return prefix4Factory.newInstance(addr.getHostAddress() + '/' + mask);
 156     }
 157
 158     @Nonnull public final P4 ipv4PrefixFor(@Nonnull final A4 addr) {
 159         Preconditions.checkNotNull(addr, "Address must not be null");
 160         return prefix4Factory.newInstance(ipv4AddressString(addr) + "/32");
 161     }
 162
 163     @Nonnull public final P4 ipv4PrefixFor(@Nonnull final A4 addr, final int mask) {
 164         Preconditions.checkNotNull(addr, "Address must not be null");
 165         Preconditions.checkArgument(mask >= 0 && mask <= 32, "Invalid mask %s", mask);
 166         return prefix4Factory.newInstance(ipv4AddressString(addr) + '/' + mask);
 167     }
 168
 169     @Nonnull public final Entry<A4, Integer> splitIpv4Prefix(@Nonnull final P4 prefix) {
 170         return splitPrefix(address4Factory, ipv4PrefixString(prefix));
 171     }
 172
 173     /**
 174      * Create an Ipv6Address by interpreting input bytes as an IPv6 address.
 175      *
 176      * @param bytes 16-byte array
 177      * @return An Ipv6Address object
 178      * @throws IllegalArgumentException if bytes has length different from 16
 179      * @throws NullPointerException if bytes is null
 180      */
 181     @Nonnull public final A6 ipv6AddressFor(@Nonnull final byte[] bytes) {
 182         return address6Factory.newInstance(addressStringV6(bytes));
 183     }
 184
 185     /**
 186      * Create an Ipv6Address by interpreting an {@link Inet6Address}.
 187      *
 188      * @param addr An {@link Inet6Address}
 189      * @return An Ipv6Address object
 190      * @throws IllegalArgumentException if addr is not an {@link Inet6Address}
 191      * @throws NullPointerException if addr is null
 192      */
 193     @Nonnull public final A6 ipv6AddressFor(@Nonnull final InetAddress addr) {
 194         Preconditions.checkNotNull(addr, "Address must not be null");
 195         Preconditions.checkArgument(addr instanceof Inet6Address, "Address has to be an Inet6Address");
 196         return address6Factory.newInstance(addressStringV6(addr));
 197     }
 198
 199     @Nonnull public final A6 ipv6AddressFrom(@Nonnull final P6 prefix) {
 200         return prefixToAddress(address6Factory, ipv6PrefixString(prefix));
 201     }
 202
 203     /**
 204      * Create a /128 Ipv6Prefix by interpreting input bytes as an IPv6 address.
 205      *
 206      * @param bytes four-byte array
 207      * @return An Ipv6Prefix object
 208      * @throws IllegalArgumentException if bytes has length different from 16
 209      * @throws NullPointerException if bytes is null
 210      */
 211     @Nonnull public final P6 ipv6PrefixFor(@Nonnull final byte[] bytes) {
 212         return prefix6Factory.newInstance(addressStringV6(bytes) + "/128");
 213     }
 214
 215     /**
 216      * Create a Ipv6Prefix by combining the address with a mask. The address
 217      * bytes are interpreted as an address and the specified mask is concatenated to
 218      * it. The address bytes are not masked.
 219      *
 220      * @param address Input address as a 4-byte array
 221      * @param mask Prefix mask
 222      * @return An Ipv6Prefix object
 223      * @throws IllegalArgumentException if bytes has length different from 16 or if mask is not in range 0-128
 224      * @throws NullPointerException if bytes is null
 225      */
 226     @Nonnull public final P6 ipv6PrefixFor(@Nonnull final byte[] address, final int mask) {
 227         Preconditions.checkArgument(mask >= 0 && mask <= 128, "Invalid mask %s", mask);
 228         return prefix6Factory.newInstance(addressStringV6(address) + '/' + mask);
 229     }
 230
 231     /**
 232      * Create a /128 Ipv6Prefix by interpreting input bytes as an IPv4 address.
 233      *
 234      * @param addr an {@link Inet6Address}
 235      * @return An Ipv6Prefix object
 236      * @throws IllegalArgumentException if addr is not an Inet6Address or if mask is not in range 0-128
 237      * @throws NullPointerException if addr is null
 238      */
 239     @Nonnull public final P6 ipv6PrefixFor(@Nonnull final InetAddress addr) {
 240         return prefix6Factory.newInstance(addressStringV6(addr) + "/128");
 241     }
 242
 243     /**
 244      * Create a Ipv6Prefix by combining the address with a mask. The address
 245      * bytes are interpreted as an address and the specified mask is concatenated to
 246      * it. The address bytes are not masked.
 247      *
 248      * @param addr Input address
 249      * @param mask Prefix mask
 250      * @return An Ipv6Prefix object
 251      * @throws IllegalArgumentException if addr is not an Inet6Address or if mask is not in range 0-128
 252      * @throws NullPointerException if addr is null
 253      */
 254     @Nonnull public final P6 ipv6PrefixFor(@Nonnull final InetAddress addr, final int mask) {
 255         Preconditions.checkNotNull(addr, "Address must not be null");
 256         Preconditions.checkArgument(addr instanceof Inet6Address, "Address has to be an Inet6Address");
 257         Preconditions.checkArgument(mask >= 0 && mask <= 128, "Invalid mask %s", mask);
 258         return prefix6Factory.newInstance(addressStringV6(addr) + '/' + mask);
 259     }
 260
 261     @Nonnull public final P6 ipv6PrefixFor(@Nonnull final A6 addr) {
 262         Preconditions.checkNotNull(addr, "Address must not be null");
 263         return prefix6Factory.newInstance(ipv6AddressString(addr) + "/128");
 264     }
 265
 266     @Nonnull public final P6 ipv6PrefixFor(@Nonnull final A6 addr, final int mask) {
 267         Preconditions.checkNotNull(addr, "Address must not be null");
 268         Preconditions.checkArgument(mask >= 0 && mask <= 128, "Invalid mask %s", mask);
 269         return prefix6Factory.newInstance(ipv6AddressString(addr) + '/' + mask);
 270     }
 271
 272     @Nonnull public final Entry<A6, Integer> splitIpv6Prefix(@Nonnull final P6 prefix) {
 273         return splitPrefix(address6Factory, ipv6PrefixString(prefix));
 274     }
 275
 276     private static <T> T prefixToAddress(final StringValueObjectFactory<T> factory, final String str) {
 277         return factory.newInstance(str.substring(0, str.lastIndexOf('/')));
 278     }
 279
 280     private static <T> Entry<T, Integer> splitPrefix(final StringValueObjectFactory<T> factory, final String str) {
 281         final int slash = str.lastIndexOf('/');
 282         return new SimpleImmutableEntry<>(factory.newInstance(str.substring(0, slash)),
 283                 Integer.valueOf(str.substring(slash + 1)));
 284     }
 285
 286     private static void appendIpv4String(final StringBuilder sb, final byte[] bytes) {
 287         Preconditions.checkArgument(bytes.length == 4, "IPv4 address length is 4 bytes");
 288
 289         sb.append(UnsignedBytes.toInt(bytes[0]));
 290         for (int i = 1; i < 4; ++i) {
 291             sb.append('.');
 292             sb.append(UnsignedBytes.toInt(bytes[i]));
 293         }
 294     }
 295
 296     private static String addressStringV4(final byte[] bytes) {
 297         final StringBuilder sb = new StringBuilder(15);
 298         appendIpv4String(sb, bytes);
 299         return sb.toString();
 300     }
 301
 302     private static String addressStringV6(final byte[] bytes) {
 303         Preconditions.checkArgument(bytes.length == 16, "IPv6 address length is 16 bytes");
 304
 305         try {
 306             return addressStringV6(Inet6Address.getByAddress(bytes));
 307         } catch (UnknownHostException e) {
 308             throw new IllegalArgumentException(String.format("Invalid input %s", bytes), e);
 309         }
 310     }
 311
 312     private static String addressStringV6(final InetAddress addr) {
 313         return InetAddresses.toAddrString(addr);
 314     }
 315
 316     private static String prefixStringV4(final byte[] bytes) {
 317         final StringBuilder sb = new StringBuilder(18);
 318         appendIpv4String(sb, bytes);
 319         sb.append("/32");
 320         return sb.toString();
 321     }
 322
 323     private static String prefixStringV4(final byte[] bytes, final int mask) {
 324         Preconditions.checkArgument(mask >= 0 && mask <= 32, "Invalid mask %s", mask);
 325
 326         final StringBuilder sb = new StringBuilder(18);
 327         appendIpv4String(sb, bytes);
 328         sb.append('/');
 329         sb.append(mask);
 330         return sb.toString();
 331     }
 332 }