Yotam Harchol | f3f1115 | 2013-09-05 16:47:16 -0700 | [diff] [blame] | 1 | package org.projectfloodlight.openflow.types; |
| 2 | |
Ronald Li | af8d3e7 | 2014-07-05 01:26:28 -0700 | [diff] [blame] | 3 | import javax.annotation.Nonnull; |
| 4 | |
Sovietaced | 9dfc1ef | 2014-06-27 11:13:57 -0700 | [diff] [blame] | 5 | import com.google.common.base.Preconditions; |
| 6 | |
Yotam Harchol | 4d63468 | 2013-09-26 13:21:06 -0700 | [diff] [blame] | 7 | |
| 8 | public class IPv4AddressWithMask extends IPAddressWithMask<IPv4Address> { |
Andreas Wundsam | b75c4ad | 2013-09-23 14:45:35 -0700 | [diff] [blame] | 9 | public final static IPv4AddressWithMask NONE = of(IPv4Address.NONE, IPv4Address.NONE); |
Yotam Harchol | f3f1115 | 2013-09-05 16:47:16 -0700 | [diff] [blame] | 10 | |
Yotam Harchol | 9a617aa | 2013-09-16 14:10:17 -0700 | [diff] [blame] | 11 | private IPv4AddressWithMask(int rawValue, int rawMask) { |
Yotam Harchol | a289d55 | 2013-09-16 10:10:40 -0700 | [diff] [blame] | 12 | super(IPv4Address.of(rawValue), IPv4Address.of(rawMask)); |
Yotam Harchol | f3f1115 | 2013-09-05 16:47:16 -0700 | [diff] [blame] | 13 | } |
Yotam Harchol | 9a617aa | 2013-09-16 14:10:17 -0700 | [diff] [blame] | 14 | |
| 15 | private IPv4AddressWithMask(IPv4Address value, IPv4Address mask) { |
Yotam Harchol | f3f1115 | 2013-09-05 16:47:16 -0700 | [diff] [blame] | 16 | super(value, mask); |
| 17 | } |
Yotam Harchol | 9a617aa | 2013-09-16 14:10:17 -0700 | [diff] [blame] | 18 | |
Yotam Harchol | 4d63468 | 2013-09-26 13:21:06 -0700 | [diff] [blame] | 19 | @Override |
Yotam Harchol | eb023dc | 2013-09-26 15:45:44 -0700 | [diff] [blame] | 20 | public IPVersion getIpVersion() { |
| 21 | return IPVersion.IPv4; |
Yotam Harchol | 4d63468 | 2013-09-26 13:21:06 -0700 | [diff] [blame] | 22 | } |
| 23 | |
Ronald Li | af8d3e7 | 2014-07-05 01:26:28 -0700 | [diff] [blame] | 24 | /** |
| 25 | * Returns an {@code IPv4AddressWithMask} object that represents the given |
Ronald Li | 382589f | 2014-07-06 23:58:08 -0700 | [diff] [blame] | 26 | * raw IP address masked by the given raw IP address mask. |
Ronald Li | af8d3e7 | 2014-07-05 01:26:28 -0700 | [diff] [blame] | 27 | * |
| 28 | * @param rawValue the raw IP address to be masked |
| 29 | * @param rawMask the raw IP address mask |
| 30 | * @return an {@code IPv4AddressWithMask} object that represents |
| 31 | * the given raw IP address masked by the given raw IP |
| 32 | * address mask |
Ronald Li | bbf0194 | 2014-07-07 17:00:13 -0700 | [diff] [blame] | 33 | * @deprecated replaced by {@link IPv4Address#of(int)} and |
| 34 | * {@link IPv4Address#withMask(IPv4Address), e.g. <code> |
| 35 | * IPv4Address.of(int).withMask(IPv4Address.of(int)) |
| 36 | * </code> |
Ronald Li | af8d3e7 | 2014-07-05 01:26:28 -0700 | [diff] [blame] | 37 | */ |
| 38 | @Nonnull |
Ronald Li | 8a0b53c | 2014-07-05 02:33:43 -0700 | [diff] [blame] | 39 | @Deprecated |
Ronald Li | af8d3e7 | 2014-07-05 01:26:28 -0700 | [diff] [blame] | 40 | public static IPv4AddressWithMask of(final int rawValue, final int rawMask) { |
Yotam Harchol | 9a617aa | 2013-09-16 14:10:17 -0700 | [diff] [blame] | 41 | return new IPv4AddressWithMask(rawValue, rawMask); |
Yotam Harchol | f3f1115 | 2013-09-05 16:47:16 -0700 | [diff] [blame] | 42 | } |
Yotam Harchol | 9a617aa | 2013-09-16 14:10:17 -0700 | [diff] [blame] | 43 | |
Ronald Li | af8d3e7 | 2014-07-05 01:26:28 -0700 | [diff] [blame] | 44 | /** |
| 45 | * Returns an {@code IPv4AddressWithMask} object that represents the given |
Ronald Li | 382589f | 2014-07-06 23:58:08 -0700 | [diff] [blame] | 46 | * IP address masked by the given IP address mask. Both arguments are given |
Ronald Li | af8d3e7 | 2014-07-05 01:26:28 -0700 | [diff] [blame] | 47 | * as {@code IPv4Address} objects. |
| 48 | * |
| 49 | * @param value the IP address to be masked |
| 50 | * @param mask the IP address mask |
| 51 | * @return an {@code IPv4AddressWithMask} object that represents |
| 52 | * the given IP address masked by the given IP address mask |
| 53 | * @throws NullPointerException if any of the given {@code IPv4Address} |
| 54 | * objects were {@code null} |
| 55 | */ |
| 56 | @Nonnull |
| 57 | public static IPv4AddressWithMask of( |
| 58 | @Nonnull final IPv4Address value, |
| 59 | @Nonnull final IPv4Address mask) { |
Sovietaced | 9dfc1ef | 2014-06-27 11:13:57 -0700 | [diff] [blame] | 60 | Preconditions.checkNotNull(value, "value must not be null"); |
| 61 | Preconditions.checkNotNull(mask, "mask must not be null"); |
| 62 | |
Yotam Harchol | 9a617aa | 2013-09-16 14:10:17 -0700 | [diff] [blame] | 63 | return new IPv4AddressWithMask(value, mask); |
Yotam Harchol | f3f1115 | 2013-09-05 16:47:16 -0700 | [diff] [blame] | 64 | } |
Yotam Harchol | 9a617aa | 2013-09-16 14:10:17 -0700 | [diff] [blame] | 65 | |
Ronald Li | af8d3e7 | 2014-07-05 01:26:28 -0700 | [diff] [blame] | 66 | /** |
| 67 | * Returns an {@code IPv4AddressWithMask} object that corresponds to |
Ronald Li | 382589f | 2014-07-06 23:58:08 -0700 | [diff] [blame] | 68 | * the given string in CIDR notation or other acceptable notations. |
Ronald Li | af8d3e7 | 2014-07-05 01:26:28 -0700 | [diff] [blame] | 69 | * <p> |
| 70 | * The following notations are accepted. |
| 71 | * <table><tr> |
| 72 | * <th>Notation</th><th>Example</th><th>Notes</th> |
| 73 | * </tr><tr> |
| 74 | * <td>IPv4 address only</td><td>{@code 1.2.3.4}</td><td>The subnet mask of |
| 75 | * prefix length 32 (i.e. {@code 255.255.255.255}) is assumed.</td> |
| 76 | * </tr><tr> |
| 77 | * <td>IPv4 address/mask</td><td>{@code 1.2.3.4/255.255.255.0}</td> |
| 78 | * </tr><tr> |
| 79 | * <td>CIDR notation</td><td>{@code 1.2.3.4/24}</td> |
| 80 | * </tr></table> |
| 81 | * |
| 82 | * @param string the string in acceptable notations |
| 83 | * @return an {@code IPv4AddressWithMask} object that corresponds to |
| 84 | * the given string in acceptable notations |
| 85 | * @throws NullPointerException if the given string was {@code null} |
| 86 | * @throws IllegalArgumentException if the given string was malformed |
| 87 | */ |
| 88 | @Nonnull |
| 89 | public static IPv4AddressWithMask of(@Nonnull final String string) { |
Sovietaced | 9dfc1ef | 2014-06-27 11:13:57 -0700 | [diff] [blame] | 90 | Preconditions.checkNotNull(string, "string must not be null"); |
| 91 | |
Yotam Harchol | f3f1115 | 2013-09-05 16:47:16 -0700 | [diff] [blame] | 92 | int slashPos; |
| 93 | String ip = string; |
Ronald Li | a780c37 | 2014-07-03 17:34:50 -0700 | [diff] [blame] | 94 | int cidrMaskLength = 32; |
Yotam Harchol | a289d55 | 2013-09-16 10:10:40 -0700 | [diff] [blame] | 95 | IPv4Address maskAddress = null; |
Yotam Harchol | f3f1115 | 2013-09-05 16:47:16 -0700 | [diff] [blame] | 96 | |
| 97 | // Read mask suffix |
| 98 | if ((slashPos = string.indexOf('/')) != -1) { |
| 99 | ip = string.substring(0, slashPos); |
| 100 | try { |
| 101 | String suffix = string.substring(slashPos + 1); |
| 102 | if (suffix.length() == 0) |
| 103 | throw new IllegalArgumentException("IP Address not well formed: " + string); |
| 104 | if (suffix.indexOf('.') != -1) { |
| 105 | // Full mask |
Yotam Harchol | a289d55 | 2013-09-16 10:10:40 -0700 | [diff] [blame] | 106 | maskAddress = IPv4Address.of(suffix); |
Yotam Harchol | f3f1115 | 2013-09-05 16:47:16 -0700 | [diff] [blame] | 107 | } else { |
| 108 | // CIDR Suffix |
Ronald Li | a780c37 | 2014-07-03 17:34:50 -0700 | [diff] [blame] | 109 | cidrMaskLength = Integer.parseInt(suffix); |
Yotam Harchol | f3f1115 | 2013-09-05 16:47:16 -0700 | [diff] [blame] | 110 | } |
| 111 | } catch (NumberFormatException e) { |
| 112 | throw new IllegalArgumentException("IP Address not well formed: " + string); |
| 113 | } |
Yotam Harchol | f3f1115 | 2013-09-05 16:47:16 -0700 | [diff] [blame] | 114 | } |
Yotam Harchol | 9a617aa | 2013-09-16 14:10:17 -0700 | [diff] [blame] | 115 | |
Yotam Harchol | f3f1115 | 2013-09-05 16:47:16 -0700 | [diff] [blame] | 116 | // Read IP |
Yotam Harchol | a289d55 | 2013-09-16 10:10:40 -0700 | [diff] [blame] | 117 | IPv4Address ipv4 = IPv4Address.of(ip); |
Yotam Harchol | 9a617aa | 2013-09-16 14:10:17 -0700 | [diff] [blame] | 118 | |
Yotam Harchol | f3f1115 | 2013-09-05 16:47:16 -0700 | [diff] [blame] | 119 | if (maskAddress != null) { |
| 120 | // Full address mask |
Yotam Harchol | 9a617aa | 2013-09-16 14:10:17 -0700 | [diff] [blame] | 121 | return IPv4AddressWithMask.of(ipv4, maskAddress); |
Yotam Harchol | f3f1115 | 2013-09-05 16:47:16 -0700 | [diff] [blame] | 122 | } else { |
Ronald Li | a780c37 | 2014-07-03 17:34:50 -0700 | [diff] [blame] | 123 | return IPv4AddressWithMask.of( |
| 124 | ipv4, IPv4Address.ofCidrMaskLength(cidrMaskLength)); |
Yotam Harchol | f3f1115 | 2013-09-05 16:47:16 -0700 | [diff] [blame] | 125 | } |
| 126 | } |
Sovietaced | 77d9949 | 2014-06-24 12:58:47 -0700 | [diff] [blame] | 127 | |
Sovietaced | 07cc8eb | 2014-06-24 11:55:26 -0700 | [diff] [blame] | 128 | @Override |
| 129 | public boolean contains(IPAddress<?> ip) { |
Sovietaced | 9dfc1ef | 2014-06-27 11:13:57 -0700 | [diff] [blame] | 130 | Preconditions.checkNotNull(ip, "ip must not be null"); |
Sovietaced | 77d9949 | 2014-06-24 12:58:47 -0700 | [diff] [blame] | 131 | |
| 132 | if(ip.getIpVersion() == IPVersion.IPv4) { |
| 133 | IPv4Address ipv4 = (IPv4Address) ip; |
| 134 | return this.matches(ipv4); |
| 135 | } |
| 136 | |
| 137 | return false; |
Sovietaced | 07cc8eb | 2014-06-24 11:55:26 -0700 | [diff] [blame] | 138 | } |
Yotam Harchol | f3f1115 | 2013-09-05 16:47:16 -0700 | [diff] [blame] | 139 | } |