Irfan Sheriff | ed5d7d1 | 2010-10-01 16:08:28 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2010 The Android Open Source Project |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | package android.net; |
| 18 | |
| 19 | import android.os.Parcel; |
| 20 | import android.os.Parcelable; |
| 21 | |
Robert Greenwalt | b979f79 | 2011-02-11 17:01:02 -0800 | [diff] [blame] | 22 | import java.net.Inet4Address; |
Irfan Sheriff | ed5d7d1 | 2010-10-01 16:08:28 -0700 | [diff] [blame] | 23 | import java.net.InetAddress; |
| 24 | import java.net.InterfaceAddress; |
| 25 | import java.net.UnknownHostException; |
| 26 | |
| 27 | /** |
Lorenzo Colitti | e1ad184 | 2013-11-27 15:03:10 +0900 | [diff] [blame^] | 28 | * Identifies an IP address on a network link. |
Irfan Sheriff | ed5d7d1 | 2010-10-01 16:08:28 -0700 | [diff] [blame] | 29 | * @hide |
| 30 | */ |
| 31 | public class LinkAddress implements Parcelable { |
| 32 | /** |
| 33 | * IPv4 or IPv6 address. |
| 34 | */ |
Lorenzo Colitti | 6eb8a62 | 2013-08-08 19:24:09 +0900 | [diff] [blame] | 35 | private InetAddress address; |
Irfan Sheriff | ed5d7d1 | 2010-10-01 16:08:28 -0700 | [diff] [blame] | 36 | |
| 37 | /** |
Lorenzo Colitti | e1ad184 | 2013-11-27 15:03:10 +0900 | [diff] [blame^] | 38 | * Prefix length. |
Irfan Sheriff | ed5d7d1 | 2010-10-01 16:08:28 -0700 | [diff] [blame] | 39 | */ |
Lorenzo Colitti | 6eb8a62 | 2013-08-08 19:24:09 +0900 | [diff] [blame] | 40 | private int prefixLength; |
Irfan Sheriff | ed5d7d1 | 2010-10-01 16:08:28 -0700 | [diff] [blame] | 41 | |
Lorenzo Colitti | 6eb8a62 | 2013-08-08 19:24:09 +0900 | [diff] [blame] | 42 | private void init(InetAddress address, int prefixLength) { |
Robert Greenwalt | b979f79 | 2011-02-11 17:01:02 -0800 | [diff] [blame] | 43 | if (address == null || prefixLength < 0 || |
| 44 | ((address instanceof Inet4Address) && prefixLength > 32) || |
| 45 | (prefixLength > 128)) { |
| 46 | throw new IllegalArgumentException("Bad LinkAddress params " + address + |
Lorenzo Colitti | 6eb8a62 | 2013-08-08 19:24:09 +0900 | [diff] [blame] | 47 | "/" + prefixLength); |
Robert Greenwalt | b979f79 | 2011-02-11 17:01:02 -0800 | [diff] [blame] | 48 | } |
Irfan Sheriff | ed5d7d1 | 2010-10-01 16:08:28 -0700 | [diff] [blame] | 49 | this.address = address; |
Irfan Sheriff | 96ca917 | 2010-10-05 16:12:25 -0700 | [diff] [blame] | 50 | this.prefixLength = prefixLength; |
Irfan Sheriff | ed5d7d1 | 2010-10-01 16:08:28 -0700 | [diff] [blame] | 51 | } |
| 52 | |
Lorenzo Colitti | e1ad184 | 2013-11-27 15:03:10 +0900 | [diff] [blame^] | 53 | /** |
| 54 | * Constructs a new {@code LinkAddress} from an {@code InetAddress} and a prefix length. |
| 55 | * @param address The IP address. |
| 56 | * @param prefixLength The prefix length. |
| 57 | */ |
Lorenzo Colitti | 6eb8a62 | 2013-08-08 19:24:09 +0900 | [diff] [blame] | 58 | public LinkAddress(InetAddress address, int prefixLength) { |
| 59 | init(address, prefixLength); |
| 60 | } |
| 61 | |
Lorenzo Colitti | e1ad184 | 2013-11-27 15:03:10 +0900 | [diff] [blame^] | 62 | /** |
| 63 | * Constructs a new {@code LinkAddress} from an {@code InterfaceAddress}. |
| 64 | * @param interfaceAddress The interface address. |
| 65 | */ |
Irfan Sheriff | ed5d7d1 | 2010-10-01 16:08:28 -0700 | [diff] [blame] | 66 | public LinkAddress(InterfaceAddress interfaceAddress) { |
Lorenzo Colitti | 6eb8a62 | 2013-08-08 19:24:09 +0900 | [diff] [blame] | 67 | init(interfaceAddress.getAddress(), |
| 68 | interfaceAddress.getNetworkPrefixLength()); |
| 69 | } |
| 70 | |
| 71 | /** |
| 72 | * Constructs a new {@code LinkAddress} from a string such as "192.0.2.5/24" or |
| 73 | * "2001:db8::1/64". |
| 74 | * @param string The string to parse. |
| 75 | */ |
| 76 | public LinkAddress(String address) { |
| 77 | InetAddress inetAddress = null; |
| 78 | int prefixLength = -1; |
| 79 | try { |
| 80 | String [] pieces = address.split("/", 2); |
| 81 | prefixLength = Integer.parseInt(pieces[1]); |
| 82 | inetAddress = InetAddress.parseNumericAddress(pieces[0]); |
| 83 | } catch (NullPointerException e) { // Null string. |
| 84 | } catch (ArrayIndexOutOfBoundsException e) { // No prefix length. |
| 85 | } catch (NumberFormatException e) { // Non-numeric prefix. |
| 86 | } catch (IllegalArgumentException e) { // Invalid IP address. |
| 87 | } |
| 88 | |
| 89 | if (inetAddress == null || prefixLength == -1) { |
| 90 | throw new IllegalArgumentException("Bad LinkAddress params " + address); |
| 91 | } |
| 92 | |
| 93 | init(inetAddress, prefixLength); |
Irfan Sheriff | ed5d7d1 | 2010-10-01 16:08:28 -0700 | [diff] [blame] | 94 | } |
| 95 | |
Irfan Sheriff | ed5d7d1 | 2010-10-01 16:08:28 -0700 | [diff] [blame] | 96 | @Override |
| 97 | public String toString() { |
Lorenzo Colitti | e1ad184 | 2013-11-27 15:03:10 +0900 | [diff] [blame^] | 98 | return address.getHostAddress() + "/" + prefixLength; |
Irfan Sheriff | ed5d7d1 | 2010-10-01 16:08:28 -0700 | [diff] [blame] | 99 | } |
| 100 | |
| 101 | /** |
| 102 | * Compares this {@code LinkAddress} instance against the specified address |
Irfan Sheriff | 96ca917 | 2010-10-05 16:12:25 -0700 | [diff] [blame] | 103 | * in {@code obj}. Two addresses are equal if their InetAddress and prefixLength |
Lorenzo Colitti | e1ad184 | 2013-11-27 15:03:10 +0900 | [diff] [blame^] | 104 | * are equal. |
Irfan Sheriff | ed5d7d1 | 2010-10-01 16:08:28 -0700 | [diff] [blame] | 105 | * |
| 106 | * @param obj the object to be tested for equality. |
| 107 | * @return {@code true} if both objects are equal, {@code false} otherwise. |
| 108 | */ |
| 109 | @Override |
| 110 | public boolean equals(Object obj) { |
| 111 | if (!(obj instanceof LinkAddress)) { |
| 112 | return false; |
| 113 | } |
| 114 | LinkAddress linkAddress = (LinkAddress) obj; |
| 115 | return this.address.equals(linkAddress.address) && |
Irfan Sheriff | 96ca917 | 2010-10-05 16:12:25 -0700 | [diff] [blame] | 116 | this.prefixLength == linkAddress.prefixLength; |
Irfan Sheriff | ed5d7d1 | 2010-10-01 16:08:28 -0700 | [diff] [blame] | 117 | } |
| 118 | |
Lorenzo Colitti | e1ad184 | 2013-11-27 15:03:10 +0900 | [diff] [blame^] | 119 | /** |
| 120 | * Returns a hashcode for this address. |
John Wang | 4e90009 | 2011-04-04 12:35:42 -0700 | [diff] [blame] | 121 | */ |
Lorenzo Colitti | e1ad184 | 2013-11-27 15:03:10 +0900 | [diff] [blame^] | 122 | @Override |
John Wang | 4e90009 | 2011-04-04 12:35:42 -0700 | [diff] [blame] | 123 | public int hashCode() { |
Lorenzo Colitti | e1ad184 | 2013-11-27 15:03:10 +0900 | [diff] [blame^] | 124 | return address.hashCode() + 11 * prefixLength; |
John Wang | 4e90009 | 2011-04-04 12:35:42 -0700 | [diff] [blame] | 125 | } |
| 126 | |
Irfan Sheriff | ed5d7d1 | 2010-10-01 16:08:28 -0700 | [diff] [blame] | 127 | /** |
Lorenzo Colitti | e1ad184 | 2013-11-27 15:03:10 +0900 | [diff] [blame^] | 128 | * Returns the InetAddress of this address. |
Irfan Sheriff | ed5d7d1 | 2010-10-01 16:08:28 -0700 | [diff] [blame] | 129 | */ |
| 130 | public InetAddress getAddress() { |
| 131 | return address; |
| 132 | } |
| 133 | |
| 134 | /** |
Lorenzo Colitti | e1ad184 | 2013-11-27 15:03:10 +0900 | [diff] [blame^] | 135 | * Returns the prefix length of this address. |
Irfan Sheriff | ed5d7d1 | 2010-10-01 16:08:28 -0700 | [diff] [blame] | 136 | */ |
Irfan Sheriff | 96ca917 | 2010-10-05 16:12:25 -0700 | [diff] [blame] | 137 | public int getNetworkPrefixLength() { |
| 138 | return prefixLength; |
Irfan Sheriff | ed5d7d1 | 2010-10-01 16:08:28 -0700 | [diff] [blame] | 139 | } |
| 140 | |
| 141 | /** |
Lorenzo Colitti | e1ad184 | 2013-11-27 15:03:10 +0900 | [diff] [blame^] | 142 | * Implement the Parcelable interface. |
Irfan Sheriff | ed5d7d1 | 2010-10-01 16:08:28 -0700 | [diff] [blame] | 143 | * @hide |
| 144 | */ |
| 145 | public int describeContents() { |
| 146 | return 0; |
| 147 | } |
| 148 | |
| 149 | /** |
| 150 | * Implement the Parcelable interface. |
| 151 | * @hide |
| 152 | */ |
| 153 | public void writeToParcel(Parcel dest, int flags) { |
Lorenzo Colitti | e1ad184 | 2013-11-27 15:03:10 +0900 | [diff] [blame^] | 154 | dest.writeByteArray(address.getAddress()); |
| 155 | dest.writeInt(prefixLength); |
Irfan Sheriff | ed5d7d1 | 2010-10-01 16:08:28 -0700 | [diff] [blame] | 156 | } |
| 157 | |
| 158 | /** |
| 159 | * Implement the Parcelable interface. |
| 160 | * @hide |
| 161 | */ |
| 162 | public static final Creator<LinkAddress> CREATOR = |
| 163 | new Creator<LinkAddress>() { |
| 164 | public LinkAddress createFromParcel(Parcel in) { |
| 165 | InetAddress address = null; |
Lorenzo Colitti | e1ad184 | 2013-11-27 15:03:10 +0900 | [diff] [blame^] | 166 | try { |
| 167 | address = InetAddress.getByAddress(in.createByteArray()); |
| 168 | } catch (UnknownHostException e) { |
| 169 | // Nothing we can do here. When we call the constructor, we'll throw an |
| 170 | // IllegalArgumentException, because a LinkAddress can't have a null |
| 171 | // InetAddress. |
Irfan Sheriff | ed5d7d1 | 2010-10-01 16:08:28 -0700 | [diff] [blame] | 172 | } |
Lorenzo Colitti | e1ad184 | 2013-11-27 15:03:10 +0900 | [diff] [blame^] | 173 | int prefixLength = in.readInt(); |
Irfan Sheriff | 96ca917 | 2010-10-05 16:12:25 -0700 | [diff] [blame] | 174 | return new LinkAddress(address, prefixLength); |
Irfan Sheriff | ed5d7d1 | 2010-10-01 16:08:28 -0700 | [diff] [blame] | 175 | } |
| 176 | |
| 177 | public LinkAddress[] newArray(int size) { |
| 178 | return new LinkAddress[size]; |
| 179 | } |
| 180 | }; |
| 181 | } |