Robert Greenwalt | 47f69fe | 2010-06-15 15:43:39 -0700 | [diff] [blame] | 1 | /* |
Wink Saville | 6e80997 | 2010-09-21 09:15:35 -0700 | [diff] [blame] | 2 | * Copyright (C) 2010 The Android Open Source Project |
Robert Greenwalt | 47f69fe | 2010-06-15 15:43:39 -0700 | [diff] [blame] | 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 | |
Robert Greenwalt | 37e65eb | 2010-08-30 10:56:47 -0700 | [diff] [blame] | 19 | import android.net.ProxyProperties; |
Robert Greenwalt | 47f69fe | 2010-06-15 15:43:39 -0700 | [diff] [blame] | 20 | import android.os.Parcelable; |
| 21 | import android.os.Parcel; |
John Wang | 4e90009 | 2011-04-04 12:35:42 -0700 | [diff] [blame] | 22 | import android.text.TextUtils; |
Robert Greenwalt | 47f69fe | 2010-06-15 15:43:39 -0700 | [diff] [blame] | 23 | |
| 24 | import java.net.InetAddress; |
Robert Greenwalt | 47f69fe | 2010-06-15 15:43:39 -0700 | [diff] [blame] | 25 | import java.net.UnknownHostException; |
| 26 | import java.util.ArrayList; |
| 27 | import java.util.Collection; |
Robert Greenwalt | 37e65eb | 2010-08-30 10:56:47 -0700 | [diff] [blame] | 28 | import java.util.Collections; |
Robert Greenwalt | 47f69fe | 2010-06-15 15:43:39 -0700 | [diff] [blame] | 29 | |
| 30 | /** |
Robert Greenwalt | 37e65eb | 2010-08-30 10:56:47 -0700 | [diff] [blame] | 31 | * Describes the properties of a network link. |
Robert Greenwalt | 992564e | 2011-02-09 13:56:06 -0800 | [diff] [blame] | 32 | * |
| 33 | * A link represents a connection to a network. |
| 34 | * It may have multiple addresses and multiple gateways, |
| 35 | * multiple dns servers but only one http proxy. |
| 36 | * |
| 37 | * Because it's a single network, the dns's |
| 38 | * are interchangeable and don't need associating with |
| 39 | * particular addresses. The gateways similarly don't |
| 40 | * need associating with particular addresses. |
| 41 | * |
| 42 | * A dual stack interface works fine in this model: |
| 43 | * each address has it's own prefix length to describe |
| 44 | * the local network. The dns servers all return |
| 45 | * both v4 addresses and v6 addresses regardless of the |
| 46 | * address family of the server itself (rfc4213) and we |
| 47 | * don't care which is used. The gateways will be |
| 48 | * selected based on the destination address and the |
| 49 | * source address has no relavence. |
Robert Greenwalt | 47f69fe | 2010-06-15 15:43:39 -0700 | [diff] [blame] | 50 | * @hide |
| 51 | */ |
Robert Greenwalt | 37e65eb | 2010-08-30 10:56:47 -0700 | [diff] [blame] | 52 | public class LinkProperties implements Parcelable { |
Robert Greenwalt | 47f69fe | 2010-06-15 15:43:39 -0700 | [diff] [blame] | 53 | |
Irfan Sheriff | ed5d7d1 | 2010-10-01 16:08:28 -0700 | [diff] [blame] | 54 | String mIfaceName; |
| 55 | private Collection<LinkAddress> mLinkAddresses; |
Robert Greenwalt | 47f69fe | 2010-06-15 15:43:39 -0700 | [diff] [blame] | 56 | private Collection<InetAddress> mDnses; |
Robert Greenwalt | aa70f10 | 2011-04-28 14:28:50 -0700 | [diff] [blame^] | 57 | private Collection<RouteInfo> mRoutes; |
Robert Greenwalt | 47f69fe | 2010-06-15 15:43:39 -0700 | [diff] [blame] | 58 | private ProxyProperties mHttpProxy; |
| 59 | |
Robert Greenwalt | 37e65eb | 2010-08-30 10:56:47 -0700 | [diff] [blame] | 60 | public LinkProperties() { |
Robert Greenwalt | 47f69fe | 2010-06-15 15:43:39 -0700 | [diff] [blame] | 61 | clear(); |
| 62 | } |
| 63 | |
Robert Greenwalt | 37e65eb | 2010-08-30 10:56:47 -0700 | [diff] [blame] | 64 | // copy constructor instead of clone |
| 65 | public LinkProperties(LinkProperties source) { |
Irfan Sheriff | ef6c143 | 2010-08-30 20:37:17 -0700 | [diff] [blame] | 66 | if (source != null) { |
Irfan Sheriff | ed5d7d1 | 2010-10-01 16:08:28 -0700 | [diff] [blame] | 67 | mIfaceName = source.getInterfaceName(); |
| 68 | mLinkAddresses = source.getLinkAddresses(); |
Irfan Sheriff | ef6c143 | 2010-08-30 20:37:17 -0700 | [diff] [blame] | 69 | mDnses = source.getDnses(); |
Robert Greenwalt | aa70f10 | 2011-04-28 14:28:50 -0700 | [diff] [blame^] | 70 | mRoutes = source.getRoutes(); |
Irfan Sheriff | ef6c143 | 2010-08-30 20:37:17 -0700 | [diff] [blame] | 71 | mHttpProxy = new ProxyProperties(source.getHttpProxy()); |
| 72 | } |
Robert Greenwalt | 37e65eb | 2010-08-30 10:56:47 -0700 | [diff] [blame] | 73 | } |
| 74 | |
Irfan Sheriff | ed5d7d1 | 2010-10-01 16:08:28 -0700 | [diff] [blame] | 75 | public void setInterfaceName(String iface) { |
| 76 | mIfaceName = iface; |
Robert Greenwalt | 47f69fe | 2010-06-15 15:43:39 -0700 | [diff] [blame] | 77 | } |
| 78 | |
Irfan Sheriff | ed5d7d1 | 2010-10-01 16:08:28 -0700 | [diff] [blame] | 79 | public String getInterfaceName() { |
| 80 | return mIfaceName; |
Robert Greenwalt | 47f69fe | 2010-06-15 15:43:39 -0700 | [diff] [blame] | 81 | } |
Irfan Sheriff | ed5d7d1 | 2010-10-01 16:08:28 -0700 | [diff] [blame] | 82 | |
Robert Greenwalt | 37e65eb | 2010-08-30 10:56:47 -0700 | [diff] [blame] | 83 | public Collection<InetAddress> getAddresses() { |
Irfan Sheriff | ed5d7d1 | 2010-10-01 16:08:28 -0700 | [diff] [blame] | 84 | Collection<InetAddress> addresses = new ArrayList<InetAddress>(); |
| 85 | for (LinkAddress linkAddress : mLinkAddresses) { |
| 86 | addresses.add(linkAddress.getAddress()); |
| 87 | } |
| 88 | return Collections.unmodifiableCollection(addresses); |
| 89 | } |
| 90 | |
| 91 | public void addLinkAddress(LinkAddress address) { |
Robert Greenwalt | 04cac40 | 2011-03-02 17:03:37 -0800 | [diff] [blame] | 92 | if (address != null) mLinkAddresses.add(address); |
Irfan Sheriff | ed5d7d1 | 2010-10-01 16:08:28 -0700 | [diff] [blame] | 93 | } |
| 94 | |
| 95 | public Collection<LinkAddress> getLinkAddresses() { |
| 96 | return Collections.unmodifiableCollection(mLinkAddresses); |
Robert Greenwalt | 47f69fe | 2010-06-15 15:43:39 -0700 | [diff] [blame] | 97 | } |
| 98 | |
Robert Greenwalt | 37e65eb | 2010-08-30 10:56:47 -0700 | [diff] [blame] | 99 | public void addDns(InetAddress dns) { |
Robert Greenwalt | 04cac40 | 2011-03-02 17:03:37 -0800 | [diff] [blame] | 100 | if (dns != null) mDnses.add(dns); |
Robert Greenwalt | 47f69fe | 2010-06-15 15:43:39 -0700 | [diff] [blame] | 101 | } |
Irfan Sheriff | ed5d7d1 | 2010-10-01 16:08:28 -0700 | [diff] [blame] | 102 | |
Robert Greenwalt | 37e65eb | 2010-08-30 10:56:47 -0700 | [diff] [blame] | 103 | public Collection<InetAddress> getDnses() { |
| 104 | return Collections.unmodifiableCollection(mDnses); |
Robert Greenwalt | 47f69fe | 2010-06-15 15:43:39 -0700 | [diff] [blame] | 105 | } |
| 106 | |
Robert Greenwalt | aa70f10 | 2011-04-28 14:28:50 -0700 | [diff] [blame^] | 107 | public void addRoute(RouteInfo route) { |
| 108 | if (route != null) mRoutes.add(route); |
Robert Greenwalt | 47f69fe | 2010-06-15 15:43:39 -0700 | [diff] [blame] | 109 | } |
Robert Greenwalt | aa70f10 | 2011-04-28 14:28:50 -0700 | [diff] [blame^] | 110 | public Collection<RouteInfo> getRoutes() { |
| 111 | return Collections.unmodifiableCollection(mRoutes); |
Robert Greenwalt | 47f69fe | 2010-06-15 15:43:39 -0700 | [diff] [blame] | 112 | } |
| 113 | |
Robert Greenwalt | 37e65eb | 2010-08-30 10:56:47 -0700 | [diff] [blame] | 114 | public void setHttpProxy(ProxyProperties proxy) { |
Robert Greenwalt | 47f69fe | 2010-06-15 15:43:39 -0700 | [diff] [blame] | 115 | mHttpProxy = proxy; |
| 116 | } |
Robert Greenwalt | 37e65eb | 2010-08-30 10:56:47 -0700 | [diff] [blame] | 117 | public ProxyProperties getHttpProxy() { |
Robert Greenwalt | 47f69fe | 2010-06-15 15:43:39 -0700 | [diff] [blame] | 118 | return mHttpProxy; |
| 119 | } |
| 120 | |
Robert Greenwalt | 37e65eb | 2010-08-30 10:56:47 -0700 | [diff] [blame] | 121 | public void clear() { |
Irfan Sheriff | ed5d7d1 | 2010-10-01 16:08:28 -0700 | [diff] [blame] | 122 | mIfaceName = null; |
| 123 | mLinkAddresses = new ArrayList<LinkAddress>(); |
Robert Greenwalt | 47f69fe | 2010-06-15 15:43:39 -0700 | [diff] [blame] | 124 | mDnses = new ArrayList<InetAddress>(); |
Robert Greenwalt | aa70f10 | 2011-04-28 14:28:50 -0700 | [diff] [blame^] | 125 | mRoutes = new ArrayList<RouteInfo>(); |
Robert Greenwalt | 47f69fe | 2010-06-15 15:43:39 -0700 | [diff] [blame] | 126 | mHttpProxy = null; |
| 127 | } |
| 128 | |
| 129 | /** |
| 130 | * Implement the Parcelable interface |
| 131 | * @hide |
| 132 | */ |
| 133 | public int describeContents() { |
| 134 | return 0; |
| 135 | } |
| 136 | |
Wink Saville | 1f6408a | 2010-08-27 11:15:18 -0700 | [diff] [blame] | 137 | @Override |
Robert Greenwalt | 37e65eb | 2010-08-30 10:56:47 -0700 | [diff] [blame] | 138 | public String toString() { |
Irfan Sheriff | ed5d7d1 | 2010-10-01 16:08:28 -0700 | [diff] [blame] | 139 | String ifaceName = (mIfaceName == null ? "" : "InterfaceName: " + mIfaceName + " "); |
Robert Greenwalt | 47f69fe | 2010-06-15 15:43:39 -0700 | [diff] [blame] | 140 | |
Irfan Sheriff | ed5d7d1 | 2010-10-01 16:08:28 -0700 | [diff] [blame] | 141 | String linkAddresses = "LinkAddresses: ["; |
John Wang | 4e90009 | 2011-04-04 12:35:42 -0700 | [diff] [blame] | 142 | for (LinkAddress addr : mLinkAddresses) linkAddresses += addr.toString() + ","; |
Irfan Sheriff | ed5d7d1 | 2010-10-01 16:08:28 -0700 | [diff] [blame] | 143 | linkAddresses += "] "; |
Robert Greenwalt | 47f69fe | 2010-06-15 15:43:39 -0700 | [diff] [blame] | 144 | |
| 145 | String dns = "DnsAddresses: ["; |
Wink Saville | 1f6408a | 2010-08-27 11:15:18 -0700 | [diff] [blame] | 146 | for (InetAddress addr : mDnses) dns += addr.getHostAddress() + ","; |
Robert Greenwalt | 47f69fe | 2010-06-15 15:43:39 -0700 | [diff] [blame] | 147 | dns += "] "; |
| 148 | |
Robert Greenwalt | aa70f10 | 2011-04-28 14:28:50 -0700 | [diff] [blame^] | 149 | String routes = "Routes: ["; |
| 150 | for (RouteInfo route : mRoutes) routes += route.toString() + ","; |
| 151 | routes += "] "; |
Robert Greenwalt | 47f69fe | 2010-06-15 15:43:39 -0700 | [diff] [blame] | 152 | String proxy = (mHttpProxy == null ? "" : "HttpProxy: " + mHttpProxy.toString() + " "); |
Robert Greenwalt | 47f69fe | 2010-06-15 15:43:39 -0700 | [diff] [blame] | 153 | |
Robert Greenwalt | aa70f10 | 2011-04-28 14:28:50 -0700 | [diff] [blame^] | 154 | return ifaceName + linkAddresses + routes + dns + proxy; |
Robert Greenwalt | 47f69fe | 2010-06-15 15:43:39 -0700 | [diff] [blame] | 155 | } |
| 156 | |
John Wang | 4e90009 | 2011-04-04 12:35:42 -0700 | [diff] [blame] | 157 | |
| 158 | @Override |
| 159 | /** |
| 160 | * Compares this {@code LinkProperties} instance against the target |
| 161 | * LinkProperties in {@code obj}. Two LinkPropertieses are equal if |
| 162 | * all their fields are equal in values. |
| 163 | * |
| 164 | * For collection fields, such as mDnses, containsAll() is used to check |
| 165 | * if two collections contains the same elements, independent of order. |
| 166 | * There are two thoughts regarding containsAll() |
| 167 | * 1. Duplicated elements. eg, (A, B, B) and (A, A, B) are equal. |
| 168 | * 2. Worst case performance is O(n^2). |
| 169 | * |
| 170 | * @param obj the object to be tested for equality. |
| 171 | * @return {@code true} if both objects are equal, {@code false} otherwise. |
| 172 | */ |
| 173 | public boolean equals(Object obj) { |
| 174 | if (this == obj) return true; |
| 175 | |
| 176 | if (!(obj instanceof LinkProperties)) return false; |
| 177 | |
| 178 | boolean sameAddresses; |
| 179 | boolean sameDnses; |
Robert Greenwalt | aa70f10 | 2011-04-28 14:28:50 -0700 | [diff] [blame^] | 180 | boolean sameRoutes; |
John Wang | 4e90009 | 2011-04-04 12:35:42 -0700 | [diff] [blame] | 181 | |
| 182 | LinkProperties target = (LinkProperties) obj; |
| 183 | |
| 184 | Collection<InetAddress> targetAddresses = target.getAddresses(); |
| 185 | Collection<InetAddress> sourceAddresses = getAddresses(); |
| 186 | sameAddresses = (sourceAddresses.size() == targetAddresses.size()) ? |
| 187 | sourceAddresses.containsAll(targetAddresses) : false; |
| 188 | |
| 189 | Collection<InetAddress> targetDnses = target.getDnses(); |
| 190 | sameDnses = (mDnses.size() == targetDnses.size()) ? |
| 191 | mDnses.containsAll(targetDnses) : false; |
| 192 | |
Robert Greenwalt | aa70f10 | 2011-04-28 14:28:50 -0700 | [diff] [blame^] | 193 | Collection<RouteInfo> targetRoutes = target.getRoutes(); |
| 194 | sameRoutes = (mRoutes.size() == targetRoutes.size()) ? |
| 195 | mRoutes.containsAll(targetRoutes) : false; |
John Wang | 4e90009 | 2011-04-04 12:35:42 -0700 | [diff] [blame] | 196 | |
| 197 | return |
Robert Greenwalt | aa70f10 | 2011-04-28 14:28:50 -0700 | [diff] [blame^] | 198 | sameAddresses && sameDnses && sameRoutes |
John Wang | 4e90009 | 2011-04-04 12:35:42 -0700 | [diff] [blame] | 199 | && TextUtils.equals(getInterfaceName(), target.getInterfaceName()) |
| 200 | && (getHttpProxy() == null ? target.getHttpProxy() == null : |
| 201 | getHttpProxy().equals(target.getHttpProxy())); |
| 202 | } |
| 203 | |
| 204 | @Override |
| 205 | /** |
| 206 | * generate hashcode based on significant fields |
| 207 | * Equal objects must produce the same hash code, while unequal objects |
| 208 | * may have the same hash codes. |
| 209 | */ |
| 210 | public int hashCode() { |
| 211 | return ((null == mIfaceName) ? 0 : mIfaceName.hashCode() |
| 212 | + mLinkAddresses.size() * 31 |
| 213 | + mDnses.size() * 37 |
Robert Greenwalt | aa70f10 | 2011-04-28 14:28:50 -0700 | [diff] [blame^] | 214 | + mRoutes.size() * 41 |
John Wang | 4e90009 | 2011-04-04 12:35:42 -0700 | [diff] [blame] | 215 | + ((null == mHttpProxy) ? 0 : mHttpProxy.hashCode())); |
| 216 | } |
| 217 | |
Robert Greenwalt | 47f69fe | 2010-06-15 15:43:39 -0700 | [diff] [blame] | 218 | /** |
| 219 | * Implement the Parcelable interface. |
| 220 | * @hide |
| 221 | */ |
Robert Greenwalt | 37e65eb | 2010-08-30 10:56:47 -0700 | [diff] [blame] | 222 | public void writeToParcel(Parcel dest, int flags) { |
Robert Greenwalt | 47f69fe | 2010-06-15 15:43:39 -0700 | [diff] [blame] | 223 | dest.writeString(getInterfaceName()); |
Irfan Sheriff | ed5d7d1 | 2010-10-01 16:08:28 -0700 | [diff] [blame] | 224 | dest.writeInt(mLinkAddresses.size()); |
| 225 | for(LinkAddress linkAddress : mLinkAddresses) { |
| 226 | dest.writeParcelable(linkAddress, flags); |
Robert Greenwalt | 47f69fe | 2010-06-15 15:43:39 -0700 | [diff] [blame] | 227 | } |
Irfan Sheriff | ed5d7d1 | 2010-10-01 16:08:28 -0700 | [diff] [blame] | 228 | |
Robert Greenwalt | 47f69fe | 2010-06-15 15:43:39 -0700 | [diff] [blame] | 229 | dest.writeInt(mDnses.size()); |
| 230 | for(InetAddress d : mDnses) { |
Robert Greenwalt | 47f69fe | 2010-06-15 15:43:39 -0700 | [diff] [blame] | 231 | dest.writeByteArray(d.getAddress()); |
| 232 | } |
Robert Greenwalt | 992564e | 2011-02-09 13:56:06 -0800 | [diff] [blame] | 233 | |
Robert Greenwalt | aa70f10 | 2011-04-28 14:28:50 -0700 | [diff] [blame^] | 234 | dest.writeInt(mRoutes.size()); |
| 235 | for(RouteInfo route : mRoutes) { |
| 236 | dest.writeParcelable(route, flags); |
Robert Greenwalt | 47f69fe | 2010-06-15 15:43:39 -0700 | [diff] [blame] | 237 | } |
Robert Greenwalt | 992564e | 2011-02-09 13:56:06 -0800 | [diff] [blame] | 238 | |
Robert Greenwalt | 47f69fe | 2010-06-15 15:43:39 -0700 | [diff] [blame] | 239 | if (mHttpProxy != null) { |
| 240 | dest.writeByte((byte)1); |
| 241 | dest.writeParcelable(mHttpProxy, flags); |
| 242 | } else { |
| 243 | dest.writeByte((byte)0); |
| 244 | } |
| 245 | } |
| 246 | |
| 247 | /** |
| 248 | * Implement the Parcelable interface. |
| 249 | * @hide |
| 250 | */ |
Robert Greenwalt | 37e65eb | 2010-08-30 10:56:47 -0700 | [diff] [blame] | 251 | public static final Creator<LinkProperties> CREATOR = |
| 252 | new Creator<LinkProperties>() { |
| 253 | public LinkProperties createFromParcel(Parcel in) { |
| 254 | LinkProperties netProp = new LinkProperties(); |
Robert Greenwalt | 47f69fe | 2010-06-15 15:43:39 -0700 | [diff] [blame] | 255 | String iface = in.readString(); |
| 256 | if (iface != null) { |
| 257 | try { |
Irfan Sheriff | ed5d7d1 | 2010-10-01 16:08:28 -0700 | [diff] [blame] | 258 | netProp.setInterfaceName(iface); |
Robert Greenwalt | 47f69fe | 2010-06-15 15:43:39 -0700 | [diff] [blame] | 259 | } catch (Exception e) { |
| 260 | return null; |
| 261 | } |
| 262 | } |
| 263 | int addressCount = in.readInt(); |
| 264 | for (int i=0; i<addressCount; i++) { |
Irfan Sheriff | ed5d7d1 | 2010-10-01 16:08:28 -0700 | [diff] [blame] | 265 | netProp.addLinkAddress((LinkAddress)in.readParcelable(null)); |
Robert Greenwalt | 47f69fe | 2010-06-15 15:43:39 -0700 | [diff] [blame] | 266 | } |
| 267 | addressCount = in.readInt(); |
| 268 | for (int i=0; i<addressCount; i++) { |
| 269 | try { |
Irfan Sheriff | 1cf56ab | 2010-08-04 15:15:49 -0700 | [diff] [blame] | 270 | netProp.addDns(InetAddress.getByAddress(in.createByteArray())); |
Robert Greenwalt | 47f69fe | 2010-06-15 15:43:39 -0700 | [diff] [blame] | 271 | } catch (UnknownHostException e) { } |
| 272 | } |
Robert Greenwalt | 992564e | 2011-02-09 13:56:06 -0800 | [diff] [blame] | 273 | addressCount = in.readInt(); |
| 274 | for (int i=0; i<addressCount; i++) { |
Robert Greenwalt | aa70f10 | 2011-04-28 14:28:50 -0700 | [diff] [blame^] | 275 | netProp.addRoute((RouteInfo)in.readParcelable(null)); |
Robert Greenwalt | 47f69fe | 2010-06-15 15:43:39 -0700 | [diff] [blame] | 276 | } |
| 277 | if (in.readByte() == 1) { |
| 278 | netProp.setHttpProxy((ProxyProperties)in.readParcelable(null)); |
| 279 | } |
| 280 | return netProp; |
| 281 | } |
| 282 | |
Robert Greenwalt | 37e65eb | 2010-08-30 10:56:47 -0700 | [diff] [blame] | 283 | public LinkProperties[] newArray(int size) { |
| 284 | return new LinkProperties[size]; |
Robert Greenwalt | 47f69fe | 2010-06-15 15:43:39 -0700 | [diff] [blame] | 285 | } |
| 286 | }; |
| 287 | } |