X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=model%2Fietf%2Fietf-type-util%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fmdsal%2Fmodel%2Fietf%2Futil%2FAbstractIetfInetUtil.java;h=24e35c3d8aa5960a89edfb049f2b241630c49323;hb=6c02ae5ce070dfeeeaae878dc5436c601d305886;hp=7321274ec4eba3dc6a00b40af81c6c4f896fcd22;hpb=e3233ae5c3fb026f17f7d4fcb44326b7c0233cff;p=mdsal.git

diff --git a/model/ietf/ietf-type-util/src/main/java/org/opendaylight/mdsal/model/ietf/util/AbstractIetfInetUtil.java b/model/ietf/ietf-type-util/src/main/java/org/opendaylight/mdsal/model/ietf/util/AbstractIetfInetUtil.java
index 7321274ec4..24e35c3d8a 100644
--- a/model/ietf/ietf-type-util/src/main/java/org/opendaylight/mdsal/model/ietf/util/AbstractIetfInetUtil.java
+++ b/model/ietf/ietf-type-util/src/main/java/org/opendaylight/mdsal/model/ietf/util/AbstractIetfInetUtil.java
@@ -26,19 +26,25 @@ import org.opendaylight.mdsal.binding.spec.reflect.StringValueObjectFactory;
  * A set of utility methods to efficiently instantiate various ietf-inet-types DTOs.
  */
 @Beta
+@SuppressWarnings("checkstyle:classTypeParameterName")
 public abstract class AbstractIetfInetUtil<A4, A4NZ extends A4, P4, A6, A6NZ extends A6, P6, A, ANZ, P> {
     private static final int INET4_LENGTH = 4;
     private static final int INET6_LENGTH = 16;
+
     private final StringValueObjectFactory<A4> address4Factory;
     private final StringValueObjectFactory<A4NZ> address4NoZoneFactory;
     private final StringValueObjectFactory<P4> prefix4Factory;
     private final StringValueObjectFactory<A6> address6Factory;
     private final StringValueObjectFactory<A6NZ> address6NoZoneFactory;
     private final StringValueObjectFactory<P6> prefix6Factory;
+    private final Class<A4NZ> addr4nzClass;
+    private final Class<A6NZ> addr6nzClass;
 
     protected AbstractIetfInetUtil(final Class<A4> addr4Class, final Class<A4NZ> addr4nzClass,
             final Class<P4> prefix4Class, final Class<A6> addr6Class, final Class<A6NZ> addr6nzClass,
             final Class<P6> prefix6Class) {
+        this.addr4nzClass = requireNonNull(addr4nzClass);
+        this.addr6nzClass = requireNonNull(addr6nzClass);
         this.address4Factory = StringValueObjectFactory.create(addr4Class, "0.0.0.0");
         this.address4NoZoneFactory = StringValueObjectFactory.create(addr4nzClass, "0.0.0.0");
         this.prefix4Factory = StringValueObjectFactory.create(prefix4Class, "0.0.0.0/0");
@@ -48,20 +54,31 @@ public abstract class AbstractIetfInetUtil<A4, A4NZ extends A4, P4, A6, A6NZ ext
     }
 
     protected abstract @NonNull A ipv4Address(@NonNull A4 addr);
+
     protected abstract @NonNull ANZ ipv4AddressNoZone(@NonNull A4NZ addr);
+
     protected abstract @NonNull A ipv6Address(@NonNull A6 addr);
+
     protected abstract @NonNull ANZ ipv6AddressNoZone(@NonNull A6NZ addr);
 
     protected abstract @Nullable A4 maybeIpv4Address(@NonNull A addr);
+
     protected abstract @Nullable A4NZ maybeIpv4AddressNoZone(@NonNull ANZ addr);
+
     protected abstract @Nullable A6 maybeIpv6Address(@NonNull A addr);
+
     protected abstract @Nullable A6NZ maybeIpv6AddressNoZone(@NonNull ANZ addr);
 
     protected abstract @NonNull P ipv4Prefix(@NonNull P4 addr);
+
     protected abstract @NonNull P ipv6Prefix(@NonNull P6 addr);
+
     protected abstract @NonNull String ipv4AddressString(@NonNull A4 addr);
+
     protected abstract @NonNull String ipv6AddressString(@NonNull A6 addr);
+
     protected abstract @NonNull String ipv4PrefixString(@NonNull P4 prefix);
+
     protected abstract @NonNull String ipv6PrefixString(@NonNull P6 prefix);
 
     /**
@@ -232,9 +249,17 @@ public abstract class AbstractIetfInetUtil<A4, A4NZ extends A4, P4, A6, A6NZ ext
      * @throws NullPointerException if addr is null
      */
     public final @NonNull A4 ipv4AddressFor(final @NonNull InetAddress addr) {
-        requireNonNull(addr, "Address must not be null");
-        checkArgument(addr instanceof Inet4Address, "Address has to be an Inet4Address");
-        return address4Factory.newInstance(addr.getHostAddress());
+        return address4Factory.newInstance(addressStringV4(addr));
+    }
+
+    /**
+     * Create an Ipv4Address by interpreting input 32 bits as an IPv4 address in big-endian format.
+     *
+     * @param bits 32 bits, big endian
+     * @return An Ipv4Address object
+     */
+    public final @NonNull A4 ipv4AddressFor(final int bits) {
+        return address4Factory.newInstance(Ipv4Utils.addressString(bits));
     }
 
     /**
@@ -258,9 +283,30 @@ public abstract class AbstractIetfInetUtil<A4, A4NZ extends A4, P4, A6, A6NZ ext
      * @throws NullPointerException if addr is null
      */
     public final @NonNull A4NZ ipv4AddressNoZoneFor(final @NonNull InetAddress addr) {
+        return address4NoZoneFactory.newInstance(addressStringV4(addr));
+    }
+
+    /**
+     * Create an Ipv4AddressNoZone by interpreting input 32 bits as an IPv4 address in big-endian format.
+     *
+     * @param bits 32 bits, big endian
+     * @return An Ipv4AddressNoZone object
+     */
+    public final @NonNull A4NZ ipv4AddressNoZoneFor(final int bits) {
+        return address4NoZoneFactory.newInstance(Ipv4Utils.addressString(bits));
+    }
+
+    /**
+     * Create an Ipv4AddressNoZone by interpreting an Ipv4Address.
+     *
+     * @param addr An Ipv4Address
+     * @return An Ipv4AddressNoZone object
+     * @throws NullPointerException if addr is null
+     */
+    public final @NonNull A4NZ ipv4AddressNoZoneFor(final @NonNull A4 addr) {
         requireNonNull(addr, "Address must not be null");
-        checkArgument(addr instanceof Inet4Address, "Address has to be an Inet4Address");
-        return address4NoZoneFactory.newInstance(addr.getHostAddress());
+        return addr4nzClass.isInstance(addr) ? addr4nzClass.cast(addr)
+                : address4NoZoneFactory.newInstance(stripZone(ipv4AddressString(addr)));
     }
 
     public final @NonNull A4 ipv4AddressFrom(final @NonNull P4 prefix) {
@@ -278,7 +324,13 @@ public abstract class AbstractIetfInetUtil<A4, A4NZ extends A4, P4, A6, A6NZ ext
          */
         final String str = ipv4AddressString(addr);
         final int percent = str.indexOf('%');
-        return ipv4StringBytes(str, percent == -1 ? str.length() : percent);
+        return Ipv4Utils.addressBytes(str, percent == -1 ? str.length() : percent);
+    }
+
+    public final int ipv4AddressBits(final @NonNull A4 addr) {
+        final String str = ipv4AddressString(addr);
+        final int percent = str.indexOf('%');
+        return Ipv4Utils.addressBits(str, percent == -1 ? str.length() : percent);
     }
 
     public final byte @NonNull[] ipv4AddressNoZoneBytes(final @NonNull A4NZ addr) {
@@ -287,13 +339,12 @@ public abstract class AbstractIetfInetUtil<A4, A4NZ extends A4, P4, A6, A6NZ ext
          * the Ipv4AddressNoZone pattern, which must not include a zone index.
          */
         final String str = ipv4AddressString(addr);
-        return ipv4StringBytes(str, str.length());
+        return Ipv4Utils.addressBytes(str, str.length());
     }
 
-    private static byte @NonNull[] ipv4StringBytes(final String str, final int limit) {
-        final byte[] bytes = new byte[INET4_LENGTH];
-        Ipv4Utils.fillIpv4Bytes(bytes, 0, str, 0, limit);
-        return bytes;
+    public final int ipv4AddressNoZoneBits(final @NonNull A4NZ addr) {
+        final String str = ipv4AddressString(addr);
+        return Ipv4Utils.addressBits(str, str.length());
     }
 
     /**
@@ -324,26 +375,8 @@ public abstract class AbstractIetfInetUtil<A4, A4NZ extends A4, P4, A6, A6NZ ext
         return prefix4Factory.newInstance(prefixStringV4(address, mask));
     }
 
-    public final @NonNull P4 ipv4PrefixForShort(final byte @NonNull[] address, final int mask) {
-        if (mask == 0) {
-            // Easy case, reuse the template
-            return prefix4Factory.getTemplate();
-        }
-
-        return v4PrefixForShort(address, 0, mask / Byte.SIZE + (mask % Byte.SIZE == 0 ? 0 : 1), mask);
-    }
-
-    public final @NonNull P4 ipv4PrefixForShort(final byte @NonNull[] array, final int startOffset, final int mask) {
-        if (mask == 0) {
-            // Easy case, reuse the template
-            return prefix4Factory.getTemplate();
-        }
-
-        return v4PrefixForShort(array, startOffset, mask / Byte.SIZE + (mask % Byte.SIZE == 0 ? 0 : 1), mask);
-    }
-
     /**
-     * Create a /32 Ipv4Prefix for an {@link Inet4Address}
+     * Create a /32 Ipv4Prefix for an {@link Inet4Address}.
      *
      * @param addr An {@link Inet4Address}
      * @return An Ipv4Prefix object
@@ -351,9 +384,7 @@ public abstract class AbstractIetfInetUtil<A4, A4NZ extends A4, P4, A6, A6NZ ext
      * @throws NullPointerException if addr is null
      */
     public final @NonNull P4 ipv4PrefixFor(final @NonNull InetAddress addr) {
-        requireNonNull(addr, "Address must not be null");
-        checkArgument(addr instanceof Inet4Address, "Address has to be an Inet4Address");
-        return prefix4Factory.newInstance(addr.getHostAddress() + "/32");
+        return prefix4Factory.newInstance(addressStringV4(addr) + "/32");
     }
 
     /**
@@ -366,9 +397,7 @@ public abstract class AbstractIetfInetUtil<A4, A4NZ extends A4, P4, A6, A6NZ ext
      * @throws NullPointerException if addr is null
      */
     public final @NonNull P4 ipv4PrefixFor(final @NonNull InetAddress addr, final int mask) {
-        requireNonNull(addr, "Address must not be null");
-        checkArgument(addr instanceof Inet4Address, "Address has to be an Inet4Address");
-        return newIpv4Prefix(addr.getHostAddress(), mask);
+        return newIpv4Prefix(addressStringV4(addr), mask);
     }
 
     public final @NonNull P4 ipv4PrefixFor(final @NonNull A4 addr) {
@@ -391,6 +420,24 @@ public abstract class AbstractIetfInetUtil<A4, A4NZ extends A4, P4, A6, A6NZ ext
         return newIpv4Prefix(ipv4AddressString(addr), mask);
     }
 
+    public final @NonNull P4 ipv4PrefixForShort(final byte @NonNull[] address, final int mask) {
+        if (mask == 0) {
+            // Easy case, reuse the template
+            return prefix4Factory.getTemplate();
+        }
+
+        return v4PrefixForShort(address, 0, mask / Byte.SIZE + (mask % Byte.SIZE == 0 ? 0 : 1), mask);
+    }
+
+    public final @NonNull P4 ipv4PrefixForShort(final byte @NonNull[] array, final int startOffset, final int mask) {
+        if (mask == 0) {
+            // Easy case, reuse the template
+            return prefix4Factory.getTemplate();
+        }
+
+        return v4PrefixForShort(array, startOffset, mask / Byte.SIZE + (mask % Byte.SIZE == 0 ? 0 : 1), mask);
+    }
+
     private static String stripZone(final String str) {
         final int percent = str.indexOf('%');
         return percent == -1 ? str : str.substring(0, percent);
@@ -440,8 +487,6 @@ public abstract class AbstractIetfInetUtil<A4, A4NZ extends A4, P4, A6, A6NZ ext
      * @throws NullPointerException if addr is null
      */
     public final @NonNull A6 ipv6AddressFor(final @NonNull InetAddress addr) {
-        requireNonNull(addr, "Address must not be null");
-        checkArgument(addr instanceof Inet6Address, "Address has to be an Inet6Address");
         return address6Factory.newInstance(addressStringV6(addr));
     }
 
@@ -466,11 +511,22 @@ public abstract class AbstractIetfInetUtil<A4, A4NZ extends A4, P4, A6, A6NZ ext
      * @throws NullPointerException if addr is null
      */
     public final @NonNull A6NZ ipv6AddressNoZoneFor(final @NonNull InetAddress addr) {
-        requireNonNull(addr, "Address must not be null");
-        checkArgument(addr instanceof Inet6Address, "Address has to be an Inet6Address");
         return address6NoZoneFactory.newInstance(addressStringV6(addr));
     }
 
+    /**
+     * Create an Ipv6AddressNoZone by interpreting an Ipv6Address.
+     *
+     * @param addr An Ipv6Address
+     * @return An Ipv6AddressNoZone object
+     * @throws NullPointerException if addr is null
+     */
+    public final @NonNull A6NZ ipv6AddressNoZoneFor(final @NonNull A6 addr) {
+        requireNonNull(addr, "Address must not be null");
+        return addr6nzClass.isInstance(addr) ? addr6nzClass.cast(addr)
+                : address6NoZoneFactory.newInstance(stripZone(ipv6AddressString(addr)));
+    }
+
     public final @NonNull A6 ipv6AddressFrom(final @NonNull P6 prefix) {
         return prefixToAddress(address6Factory, ipv6PrefixString(prefix));
     }
@@ -524,31 +580,12 @@ public abstract class AbstractIetfInetUtil<A4, A4NZ extends A4, P4, A6, A6NZ ext
         return prefix6Factory.newInstance(addressStringV6(address) + '/' + mask);
     }
 
-    public final @NonNull P6 ipv6PrefixForShort(final byte @NonNull[] address, final int mask) {
-        return ipv6PrefixForShort(address, 0, mask);
-    }
-
-    public final @NonNull P6 ipv6PrefixForShort(final byte @NonNull[] array, final int startOffset, final int mask) {
-        if (mask == 0) {
-            // Easy case, reuse the template
-            return prefix6Factory.getTemplate();
-        }
-
-        checkArgument(mask > 0 && mask <= 128, "Invalid mask %s", mask);
-        final int size = mask / Byte.SIZE + (mask % Byte.SIZE == 0 ? 0 : 1);
-
-        // Until we can instantiate an IPv6 address for a partial array, use a temporary buffer
-        byte[] tmp = new byte[INET6_LENGTH];
-        System.arraycopy(array, startOffset, tmp, 0, size);
-        return ipv6PrefixFor(tmp, mask);
-    }
-
     /**
-     * Create a /128 Ipv6Prefix by interpreting input bytes as an IPv4 address.
+     * Create a /128 Ipv6Prefix by interpreting input bytes as an IPv6 address.
      *
      * @param addr an {@link Inet6Address}
      * @return An Ipv6Prefix object
-     * @throws IllegalArgumentException if addr is not an Inet6Address or if mask is not in range 0-128
+     * @throws IllegalArgumentException if addr is not an Inet6Address
      * @throws NullPointerException if addr is null
      */
     public final @NonNull P6 ipv6PrefixFor(final @NonNull InetAddress addr) {
@@ -567,8 +604,6 @@ public abstract class AbstractIetfInetUtil<A4, A4NZ extends A4, P4, A6, A6NZ ext
      * @throws NullPointerException if addr is null
      */
     public final @NonNull P6 ipv6PrefixFor(final @NonNull InetAddress addr, final int mask) {
-        requireNonNull(addr, "Address must not be null");
-        checkArgument(addr instanceof Inet6Address, "Address has to be an Inet6Address");
         checkArgument(mask >= 0 && mask <= 128, "Invalid mask %s", mask);
         return prefix6Factory.newInstance(addressStringV6(addr) + '/' + mask);
     }
@@ -593,6 +628,25 @@ public abstract class AbstractIetfInetUtil<A4, A4NZ extends A4, P4, A6, A6NZ ext
         return newIpv6Prefix(ipv6AddressString(addr), mask);
     }
 
+    public final @NonNull P6 ipv6PrefixForShort(final byte @NonNull[] address, final int mask) {
+        return ipv6PrefixForShort(address, 0, mask);
+    }
+
+    public final @NonNull P6 ipv6PrefixForShort(final byte @NonNull[] array, final int startOffset, final int mask) {
+        if (mask == 0) {
+            // Easy case, reuse the template
+            return prefix6Factory.getTemplate();
+        }
+
+        checkArgument(mask > 0 && mask <= 128, "Invalid mask %s", mask);
+        final int size = mask / Byte.SIZE + (mask % Byte.SIZE == 0 ? 0 : 1);
+
+        // Until we can instantiate an IPv6 address for a partial array, use a temporary buffer
+        byte[] tmp = new byte[INET6_LENGTH];
+        System.arraycopy(array, startOffset, tmp, 0, size);
+        return ipv6PrefixFor(tmp, mask);
+    }
+
     private P6 newIpv6Prefix(final String addr, final int mask) {
         checkArgument(mask >= 0 && mask <= 128, "Invalid mask %s", mask);
         return prefix6Factory.newInstance(addr + '/' + mask);
@@ -635,23 +689,35 @@ public abstract class AbstractIetfInetUtil<A4, A4NZ extends A4, P4, A6, A6NZ ext
         }
     }
 
-    private static String addressStringV4(final byte @NonNull[] bytes) {
+    static String addressStringV4(final byte @NonNull[] bytes) {
         final StringBuilder sb = new StringBuilder(15);
         appendIpv4String(sb, bytes);
         return sb.toString();
     }
 
+    private static @NonNull String addressStringV4(final InetAddress addr) {
+        requireNonNull(addr, "Address must not be null");
+        checkArgument(addr instanceof Inet4Address, "Address has to be an Inet4Address");
+        return addr.getHostAddress();
+    }
+
     private static String addressStringV6(final byte @NonNull[] bytes) {
         checkArgument(bytes.length == INET6_LENGTH, "IPv6 address length is 16 bytes");
 
         try {
-            return addressStringV6(Inet6Address.getByAddress(bytes));
+            return addressStringV6(Inet6Address.getByAddress(null, bytes, null));
         } catch (UnknownHostException e) {
             throw new IllegalArgumentException(String.format("Invalid input %s", bytes), e);
         }
     }
 
     private static String addressStringV6(final InetAddress addr) {
+        requireNonNull(addr, "Address must not be null");
+        checkArgument(addr instanceof Inet6Address, "Address has to be an Inet6Address");
+        return addressStringV6((Inet6Address) addr);
+    }
+
+    private static String addressStringV6(final Inet6Address addr) {
         return InetAddresses.toAddrString(addr);
     }