Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2008 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 | package android.net; |
| 17 | |
| 18 | import static android.annotation.SystemApi.Client.MODULE_LIBRARIES; |
Sooraj Sasindran | f4a58dc | 2022-01-21 13:37:08 -0800 | [diff] [blame] | 19 | import static android.net.NetworkCapabilities.NET_ENTERPRISE_ID_1; |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 20 | import static android.net.NetworkRequest.Type.BACKGROUND_REQUEST; |
| 21 | import static android.net.NetworkRequest.Type.LISTEN; |
junyulai | 7664f62 | 2021-03-12 20:05:08 +0800 | [diff] [blame] | 22 | import static android.net.NetworkRequest.Type.LISTEN_FOR_BEST; |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 23 | import static android.net.NetworkRequest.Type.REQUEST; |
| 24 | import static android.net.NetworkRequest.Type.TRACK_DEFAULT; |
Lorenzo Colitti | a77d05e | 2021-01-29 20:14:04 +0900 | [diff] [blame] | 25 | import static android.net.NetworkRequest.Type.TRACK_SYSTEM_DEFAULT; |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 26 | import static android.net.QosCallback.QosCallbackRegistrationException; |
| 27 | |
| 28 | import android.annotation.CallbackExecutor; |
| 29 | import android.annotation.IntDef; |
| 30 | import android.annotation.NonNull; |
| 31 | import android.annotation.Nullable; |
| 32 | import android.annotation.RequiresPermission; |
| 33 | import android.annotation.SdkConstant; |
| 34 | import android.annotation.SdkConstant.SdkConstantType; |
| 35 | import android.annotation.SuppressLint; |
| 36 | import android.annotation.SystemApi; |
| 37 | import android.annotation.SystemService; |
| 38 | import android.app.PendingIntent; |
Lorenzo Colitti | 8ad5812 | 2021-03-18 00:54:57 +0900 | [diff] [blame] | 39 | import android.app.admin.DevicePolicyManager; |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 40 | import android.compat.annotation.UnsupportedAppUsage; |
Lorenzo Colitti | 8ad5812 | 2021-03-18 00:54:57 +0900 | [diff] [blame] | 41 | import android.content.ComponentName; |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 42 | import android.content.Context; |
| 43 | import android.content.Intent; |
Remi NGUYEN VAN | 564f7f8 | 2021-04-08 16:26:20 +0900 | [diff] [blame] | 44 | import android.net.ConnectivityDiagnosticsManager.DataStallReport.DetectionMethod; |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 45 | import android.net.IpSecManager.UdpEncapsulationSocket; |
| 46 | import android.net.SocketKeepalive.Callback; |
| 47 | import android.net.TetheringManager.StartTetheringCallback; |
| 48 | import android.net.TetheringManager.TetheringEventCallback; |
| 49 | import android.net.TetheringManager.TetheringRequest; |
| 50 | import android.os.Binder; |
| 51 | import android.os.Build; |
| 52 | import android.os.Build.VERSION_CODES; |
| 53 | import android.os.Bundle; |
| 54 | import android.os.Handler; |
| 55 | import android.os.IBinder; |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 56 | import android.os.Looper; |
| 57 | import android.os.Message; |
| 58 | import android.os.Messenger; |
| 59 | import android.os.ParcelFileDescriptor; |
| 60 | import android.os.PersistableBundle; |
| 61 | import android.os.Process; |
| 62 | import android.os.RemoteException; |
| 63 | import android.os.ResultReceiver; |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 64 | import android.os.ServiceSpecificException; |
Chalard Jean | ad565e2 | 2021-02-25 17:23:40 +0900 | [diff] [blame] | 65 | import android.os.UserHandle; |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 66 | import android.provider.Settings; |
| 67 | import android.telephony.SubscriptionManager; |
| 68 | import android.telephony.TelephonyManager; |
| 69 | import android.util.ArrayMap; |
| 70 | import android.util.Log; |
| 71 | import android.util.Range; |
| 72 | import android.util.SparseIntArray; |
| 73 | |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 74 | import com.android.internal.annotations.GuardedBy; |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 75 | |
| 76 | import libcore.net.event.NetworkEventDispatcher; |
| 77 | |
| 78 | import java.io.IOException; |
| 79 | import java.io.UncheckedIOException; |
| 80 | import java.lang.annotation.Retention; |
| 81 | import java.lang.annotation.RetentionPolicy; |
| 82 | import java.net.DatagramSocket; |
| 83 | import java.net.InetAddress; |
| 84 | import java.net.InetSocketAddress; |
| 85 | import java.net.Socket; |
| 86 | import java.util.ArrayList; |
| 87 | import java.util.Collection; |
| 88 | import java.util.HashMap; |
| 89 | import java.util.List; |
| 90 | import java.util.Map; |
| 91 | import java.util.Objects; |
| 92 | import java.util.concurrent.Executor; |
| 93 | import java.util.concurrent.ExecutorService; |
| 94 | import java.util.concurrent.Executors; |
| 95 | import java.util.concurrent.RejectedExecutionException; |
| 96 | |
| 97 | /** |
| 98 | * Class that answers queries about the state of network connectivity. It also |
| 99 | * notifies applications when network connectivity changes. |
| 100 | * <p> |
| 101 | * The primary responsibilities of this class are to: |
| 102 | * <ol> |
| 103 | * <li>Monitor network connections (Wi-Fi, GPRS, UMTS, etc.)</li> |
| 104 | * <li>Send broadcast intents when network connectivity changes</li> |
| 105 | * <li>Attempt to "fail over" to another network when connectivity to a network |
| 106 | * is lost</li> |
| 107 | * <li>Provide an API that allows applications to query the coarse-grained or fine-grained |
| 108 | * state of the available networks</li> |
| 109 | * <li>Provide an API that allows applications to request and select networks for their data |
| 110 | * traffic</li> |
| 111 | * </ol> |
| 112 | */ |
| 113 | @SystemService(Context.CONNECTIVITY_SERVICE) |
| 114 | public class ConnectivityManager { |
| 115 | private static final String TAG = "ConnectivityManager"; |
| 116 | private static final boolean DEBUG = Log.isLoggable(TAG, Log.DEBUG); |
| 117 | |
| 118 | /** |
| 119 | * A change in network connectivity has occurred. A default connection has either |
| 120 | * been established or lost. The NetworkInfo for the affected network is |
| 121 | * sent as an extra; it should be consulted to see what kind of |
| 122 | * connectivity event occurred. |
| 123 | * <p/> |
| 124 | * Apps targeting Android 7.0 (API level 24) and higher do not receive this |
| 125 | * broadcast if they declare the broadcast receiver in their manifest. Apps |
| 126 | * will still receive broadcasts if they register their |
| 127 | * {@link android.content.BroadcastReceiver} with |
| 128 | * {@link android.content.Context#registerReceiver Context.registerReceiver()} |
| 129 | * and that context is still valid. |
| 130 | * <p/> |
| 131 | * If this is a connection that was the result of failing over from a |
| 132 | * disconnected network, then the FAILOVER_CONNECTION boolean extra is |
| 133 | * set to true. |
| 134 | * <p/> |
| 135 | * For a loss of connectivity, if the connectivity manager is attempting |
| 136 | * to connect (or has already connected) to another network, the |
| 137 | * NetworkInfo for the new network is also passed as an extra. This lets |
| 138 | * any receivers of the broadcast know that they should not necessarily |
| 139 | * tell the user that no data traffic will be possible. Instead, the |
| 140 | * receiver should expect another broadcast soon, indicating either that |
| 141 | * the failover attempt succeeded (and so there is still overall data |
| 142 | * connectivity), or that the failover attempt failed, meaning that all |
| 143 | * connectivity has been lost. |
| 144 | * <p/> |
| 145 | * For a disconnect event, the boolean extra EXTRA_NO_CONNECTIVITY |
| 146 | * is set to {@code true} if there are no connected networks at all. |
Chalard Jean | 025f40b | 2021-10-04 18:33:36 +0900 | [diff] [blame] | 147 | * <p /> |
| 148 | * Note that this broadcast is deprecated and generally tries to implement backwards |
| 149 | * compatibility with older versions of Android. As such, it may not reflect new |
| 150 | * capabilities of the system, like multiple networks being connected at the same |
| 151 | * time, the details of newer technology, or changes in tethering state. |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 152 | * |
| 153 | * @deprecated apps should use the more versatile {@link #requestNetwork}, |
| 154 | * {@link #registerNetworkCallback} or {@link #registerDefaultNetworkCallback} |
| 155 | * functions instead for faster and more detailed updates about the network |
| 156 | * changes they care about. |
| 157 | */ |
| 158 | @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION) |
| 159 | @Deprecated |
| 160 | public static final String CONNECTIVITY_ACTION = "android.net.conn.CONNECTIVITY_CHANGE"; |
| 161 | |
| 162 | /** |
| 163 | * The device has connected to a network that has presented a captive |
| 164 | * portal, which is blocking Internet connectivity. The user was presented |
| 165 | * with a notification that network sign in is required, |
| 166 | * and the user invoked the notification's action indicating they |
| 167 | * desire to sign in to the network. Apps handling this activity should |
| 168 | * facilitate signing in to the network. This action includes a |
| 169 | * {@link Network} typed extra called {@link #EXTRA_NETWORK} that represents |
| 170 | * the network presenting the captive portal; all communication with the |
| 171 | * captive portal must be done using this {@code Network} object. |
| 172 | * <p/> |
| 173 | * This activity includes a {@link CaptivePortal} extra named |
| 174 | * {@link #EXTRA_CAPTIVE_PORTAL} that can be used to indicate different |
| 175 | * outcomes of the captive portal sign in to the system: |
| 176 | * <ul> |
| 177 | * <li> When the app handling this action believes the user has signed in to |
| 178 | * the network and the captive portal has been dismissed, the app should |
| 179 | * call {@link CaptivePortal#reportCaptivePortalDismissed} so the system can |
| 180 | * reevaluate the network. If reevaluation finds the network no longer |
| 181 | * subject to a captive portal, the network may become the default active |
| 182 | * data network.</li> |
| 183 | * <li> When the app handling this action believes the user explicitly wants |
| 184 | * to ignore the captive portal and the network, the app should call |
| 185 | * {@link CaptivePortal#ignoreNetwork}. </li> |
| 186 | * </ul> |
| 187 | */ |
| 188 | @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION) |
| 189 | public static final String ACTION_CAPTIVE_PORTAL_SIGN_IN = "android.net.conn.CAPTIVE_PORTAL"; |
| 190 | |
| 191 | /** |
| 192 | * The lookup key for a {@link NetworkInfo} object. Retrieve with |
| 193 | * {@link android.content.Intent#getParcelableExtra(String)}. |
| 194 | * |
| 195 | * @deprecated The {@link NetworkInfo} object is deprecated, as many of its properties |
| 196 | * can't accurately represent modern network characteristics. |
| 197 | * Please obtain information about networks from the {@link NetworkCapabilities} |
| 198 | * or {@link LinkProperties} objects instead. |
| 199 | */ |
| 200 | @Deprecated |
| 201 | public static final String EXTRA_NETWORK_INFO = "networkInfo"; |
| 202 | |
| 203 | /** |
| 204 | * Network type which triggered a {@link #CONNECTIVITY_ACTION} broadcast. |
| 205 | * |
| 206 | * @see android.content.Intent#getIntExtra(String, int) |
| 207 | * @deprecated The network type is not rich enough to represent the characteristics |
| 208 | * of modern networks. Please use {@link NetworkCapabilities} instead, |
| 209 | * in particular the transports. |
| 210 | */ |
| 211 | @Deprecated |
| 212 | public static final String EXTRA_NETWORK_TYPE = "networkType"; |
| 213 | |
| 214 | /** |
| 215 | * The lookup key for a boolean that indicates whether a connect event |
| 216 | * is for a network to which the connectivity manager was failing over |
| 217 | * following a disconnect on another network. |
| 218 | * Retrieve it with {@link android.content.Intent#getBooleanExtra(String,boolean)}. |
| 219 | * |
| 220 | * @deprecated See {@link NetworkInfo}. |
| 221 | */ |
| 222 | @Deprecated |
| 223 | public static final String EXTRA_IS_FAILOVER = "isFailover"; |
| 224 | /** |
| 225 | * The lookup key for a {@link NetworkInfo} object. This is supplied when |
| 226 | * there is another network that it may be possible to connect to. Retrieve with |
| 227 | * {@link android.content.Intent#getParcelableExtra(String)}. |
| 228 | * |
| 229 | * @deprecated See {@link NetworkInfo}. |
| 230 | */ |
| 231 | @Deprecated |
| 232 | public static final String EXTRA_OTHER_NETWORK_INFO = "otherNetwork"; |
| 233 | /** |
| 234 | * The lookup key for a boolean that indicates whether there is a |
| 235 | * complete lack of connectivity, i.e., no network is available. |
| 236 | * Retrieve it with {@link android.content.Intent#getBooleanExtra(String,boolean)}. |
| 237 | */ |
| 238 | public static final String EXTRA_NO_CONNECTIVITY = "noConnectivity"; |
| 239 | /** |
| 240 | * The lookup key for a string that indicates why an attempt to connect |
| 241 | * to a network failed. The string has no particular structure. It is |
| 242 | * intended to be used in notifications presented to users. Retrieve |
| 243 | * it with {@link android.content.Intent#getStringExtra(String)}. |
| 244 | */ |
| 245 | public static final String EXTRA_REASON = "reason"; |
| 246 | /** |
| 247 | * The lookup key for a string that provides optionally supplied |
| 248 | * extra information about the network state. The information |
| 249 | * may be passed up from the lower networking layers, and its |
| 250 | * meaning may be specific to a particular network type. Retrieve |
| 251 | * it with {@link android.content.Intent#getStringExtra(String)}. |
| 252 | * |
| 253 | * @deprecated See {@link NetworkInfo#getExtraInfo()}. |
| 254 | */ |
| 255 | @Deprecated |
| 256 | public static final String EXTRA_EXTRA_INFO = "extraInfo"; |
| 257 | /** |
| 258 | * The lookup key for an int that provides information about |
| 259 | * our connection to the internet at large. 0 indicates no connection, |
| 260 | * 100 indicates a great connection. Retrieve it with |
| 261 | * {@link android.content.Intent#getIntExtra(String, int)}. |
| 262 | * {@hide} |
| 263 | */ |
| 264 | public static final String EXTRA_INET_CONDITION = "inetCondition"; |
| 265 | /** |
| 266 | * The lookup key for a {@link CaptivePortal} object included with the |
| 267 | * {@link #ACTION_CAPTIVE_PORTAL_SIGN_IN} intent. The {@code CaptivePortal} |
| 268 | * object can be used to either indicate to the system that the captive |
| 269 | * portal has been dismissed or that the user does not want to pursue |
| 270 | * signing in to captive portal. Retrieve it with |
| 271 | * {@link android.content.Intent#getParcelableExtra(String)}. |
| 272 | */ |
| 273 | public static final String EXTRA_CAPTIVE_PORTAL = "android.net.extra.CAPTIVE_PORTAL"; |
| 274 | |
| 275 | /** |
| 276 | * Key for passing a URL to the captive portal login activity. |
| 277 | */ |
| 278 | public static final String EXTRA_CAPTIVE_PORTAL_URL = "android.net.extra.CAPTIVE_PORTAL_URL"; |
| 279 | |
| 280 | /** |
| 281 | * Key for passing a {@link android.net.captiveportal.CaptivePortalProbeSpec} to the captive |
| 282 | * portal login activity. |
| 283 | * {@hide} |
| 284 | */ |
| 285 | @SystemApi |
| 286 | public static final String EXTRA_CAPTIVE_PORTAL_PROBE_SPEC = |
| 287 | "android.net.extra.CAPTIVE_PORTAL_PROBE_SPEC"; |
| 288 | |
| 289 | /** |
| 290 | * Key for passing a user agent string to the captive portal login activity. |
| 291 | * {@hide} |
| 292 | */ |
| 293 | @SystemApi |
| 294 | public static final String EXTRA_CAPTIVE_PORTAL_USER_AGENT = |
| 295 | "android.net.extra.CAPTIVE_PORTAL_USER_AGENT"; |
| 296 | |
| 297 | /** |
| 298 | * Broadcast action to indicate the change of data activity status |
| 299 | * (idle or active) on a network in a recent period. |
| 300 | * The network becomes active when data transmission is started, or |
| 301 | * idle if there is no data transmission for a period of time. |
| 302 | * {@hide} |
| 303 | */ |
| 304 | @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION) |
| 305 | public static final String ACTION_DATA_ACTIVITY_CHANGE = |
| 306 | "android.net.conn.DATA_ACTIVITY_CHANGE"; |
| 307 | /** |
| 308 | * The lookup key for an enum that indicates the network device type on which this data activity |
| 309 | * change happens. |
| 310 | * {@hide} |
| 311 | */ |
| 312 | public static final String EXTRA_DEVICE_TYPE = "deviceType"; |
| 313 | /** |
| 314 | * The lookup key for a boolean that indicates the device is active or not. {@code true} means |
| 315 | * it is actively sending or receiving data and {@code false} means it is idle. |
| 316 | * {@hide} |
| 317 | */ |
| 318 | public static final String EXTRA_IS_ACTIVE = "isActive"; |
| 319 | /** |
| 320 | * The lookup key for a long that contains the timestamp (nanos) of the radio state change. |
| 321 | * {@hide} |
| 322 | */ |
| 323 | public static final String EXTRA_REALTIME_NS = "tsNanos"; |
| 324 | |
| 325 | /** |
| 326 | * Broadcast Action: The setting for background data usage has changed |
| 327 | * values. Use {@link #getBackgroundDataSetting()} to get the current value. |
| 328 | * <p> |
| 329 | * If an application uses the network in the background, it should listen |
| 330 | * for this broadcast and stop using the background data if the value is |
| 331 | * {@code false}. |
| 332 | * <p> |
| 333 | * |
| 334 | * @deprecated As of {@link VERSION_CODES#ICE_CREAM_SANDWICH}, availability |
| 335 | * of background data depends on several combined factors, and |
| 336 | * this broadcast is no longer sent. Instead, when background |
| 337 | * data is unavailable, {@link #getActiveNetworkInfo()} will now |
| 338 | * appear disconnected. During first boot after a platform |
| 339 | * upgrade, this broadcast will be sent once if |
| 340 | * {@link #getBackgroundDataSetting()} was {@code false} before |
| 341 | * the upgrade. |
| 342 | */ |
| 343 | @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION) |
| 344 | @Deprecated |
| 345 | public static final String ACTION_BACKGROUND_DATA_SETTING_CHANGED = |
| 346 | "android.net.conn.BACKGROUND_DATA_SETTING_CHANGED"; |
| 347 | |
| 348 | /** |
| 349 | * Broadcast Action: The network connection may not be good |
| 350 | * uses {@code ConnectivityManager.EXTRA_INET_CONDITION} and |
| 351 | * {@code ConnectivityManager.EXTRA_NETWORK_INFO} to specify |
| 352 | * the network and it's condition. |
| 353 | * @hide |
| 354 | */ |
| 355 | @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION) |
| 356 | @UnsupportedAppUsage |
| 357 | public static final String INET_CONDITION_ACTION = |
| 358 | "android.net.conn.INET_CONDITION_ACTION"; |
| 359 | |
| 360 | /** |
| 361 | * Broadcast Action: A tetherable connection has come or gone. |
| 362 | * Uses {@code ConnectivityManager.EXTRA_AVAILABLE_TETHER}, |
| 363 | * {@code ConnectivityManager.EXTRA_ACTIVE_LOCAL_ONLY}, |
| 364 | * {@code ConnectivityManager.EXTRA_ACTIVE_TETHER}, and |
| 365 | * {@code ConnectivityManager.EXTRA_ERRORED_TETHER} to indicate |
| 366 | * the current state of tethering. Each include a list of |
| 367 | * interface names in that state (may be empty). |
| 368 | * @hide |
| 369 | */ |
| 370 | @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION) |
| 371 | @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553) |
| 372 | public static final String ACTION_TETHER_STATE_CHANGED = |
| 373 | TetheringManager.ACTION_TETHER_STATE_CHANGED; |
| 374 | |
| 375 | /** |
| 376 | * @hide |
| 377 | * gives a String[] listing all the interfaces configured for |
| 378 | * tethering and currently available for tethering. |
| 379 | */ |
| 380 | @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553) |
| 381 | public static final String EXTRA_AVAILABLE_TETHER = TetheringManager.EXTRA_AVAILABLE_TETHER; |
| 382 | |
| 383 | /** |
| 384 | * @hide |
| 385 | * gives a String[] listing all the interfaces currently in local-only |
| 386 | * mode (ie, has DHCPv4+IPv6-ULA support and no packet forwarding) |
| 387 | */ |
| 388 | public static final String EXTRA_ACTIVE_LOCAL_ONLY = TetheringManager.EXTRA_ACTIVE_LOCAL_ONLY; |
| 389 | |
| 390 | /** |
| 391 | * @hide |
| 392 | * gives a String[] listing all the interfaces currently tethered |
| 393 | * (ie, has DHCPv4 support and packets potentially forwarded/NATed) |
| 394 | */ |
| 395 | @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553) |
| 396 | public static final String EXTRA_ACTIVE_TETHER = TetheringManager.EXTRA_ACTIVE_TETHER; |
| 397 | |
| 398 | /** |
| 399 | * @hide |
| 400 | * gives a String[] listing all the interfaces we tried to tether and |
| 401 | * failed. Use {@link #getLastTetherError} to find the error code |
| 402 | * for any interfaces listed here. |
| 403 | */ |
| 404 | @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553) |
| 405 | public static final String EXTRA_ERRORED_TETHER = TetheringManager.EXTRA_ERRORED_TETHER; |
| 406 | |
| 407 | /** |
| 408 | * Broadcast Action: The captive portal tracker has finished its test. |
| 409 | * Sent only while running Setup Wizard, in lieu of showing a user |
| 410 | * notification. |
| 411 | * @hide |
| 412 | */ |
| 413 | @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION) |
| 414 | public static final String ACTION_CAPTIVE_PORTAL_TEST_COMPLETED = |
| 415 | "android.net.conn.CAPTIVE_PORTAL_TEST_COMPLETED"; |
| 416 | /** |
| 417 | * The lookup key for a boolean that indicates whether a captive portal was detected. |
| 418 | * Retrieve it with {@link android.content.Intent#getBooleanExtra(String,boolean)}. |
| 419 | * @hide |
| 420 | */ |
| 421 | public static final String EXTRA_IS_CAPTIVE_PORTAL = "captivePortal"; |
| 422 | |
| 423 | /** |
| 424 | * Action used to display a dialog that asks the user whether to connect to a network that is |
| 425 | * not validated. This intent is used to start the dialog in settings via startActivity. |
| 426 | * |
lucaslin | 8bee2fd | 2021-04-21 10:43:15 +0800 | [diff] [blame] | 427 | * This action includes a {@link Network} typed extra which is called |
| 428 | * {@link ConnectivityManager#EXTRA_NETWORK} that represents the network which is unvalidated. |
| 429 | * |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 430 | * @hide |
| 431 | */ |
lucaslin | cf6d450 | 2021-03-04 17:09:51 +0800 | [diff] [blame] | 432 | @SystemApi(client = MODULE_LIBRARIES) |
| 433 | public static final String ACTION_PROMPT_UNVALIDATED = "android.net.action.PROMPT_UNVALIDATED"; |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 434 | |
| 435 | /** |
| 436 | * Action used to display a dialog that asks the user whether to avoid a network that is no |
| 437 | * longer validated. This intent is used to start the dialog in settings via startActivity. |
| 438 | * |
lucaslin | 8bee2fd | 2021-04-21 10:43:15 +0800 | [diff] [blame] | 439 | * This action includes a {@link Network} typed extra which is called |
| 440 | * {@link ConnectivityManager#EXTRA_NETWORK} that represents the network which is no longer |
| 441 | * validated. |
| 442 | * |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 443 | * @hide |
| 444 | */ |
lucaslin | cf6d450 | 2021-03-04 17:09:51 +0800 | [diff] [blame] | 445 | @SystemApi(client = MODULE_LIBRARIES) |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 446 | public static final String ACTION_PROMPT_LOST_VALIDATION = |
lucaslin | cf6d450 | 2021-03-04 17:09:51 +0800 | [diff] [blame] | 447 | "android.net.action.PROMPT_LOST_VALIDATION"; |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 448 | |
| 449 | /** |
| 450 | * Action used to display a dialog that asks the user whether to stay connected to a network |
| 451 | * that has not validated. This intent is used to start the dialog in settings via |
| 452 | * startActivity. |
| 453 | * |
lucaslin | 8bee2fd | 2021-04-21 10:43:15 +0800 | [diff] [blame] | 454 | * This action includes a {@link Network} typed extra which is called |
| 455 | * {@link ConnectivityManager#EXTRA_NETWORK} that represents the network which has partial |
| 456 | * connectivity. |
| 457 | * |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 458 | * @hide |
| 459 | */ |
lucaslin | cf6d450 | 2021-03-04 17:09:51 +0800 | [diff] [blame] | 460 | @SystemApi(client = MODULE_LIBRARIES) |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 461 | public static final String ACTION_PROMPT_PARTIAL_CONNECTIVITY = |
lucaslin | cf6d450 | 2021-03-04 17:09:51 +0800 | [diff] [blame] | 462 | "android.net.action.PROMPT_PARTIAL_CONNECTIVITY"; |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 463 | |
| 464 | /** |
paulhu | b49c842 | 2021-04-07 16:18:13 +0800 | [diff] [blame] | 465 | * Clear DNS Cache Action: This is broadcast when networks have changed and old |
| 466 | * DNS entries should be cleared. |
| 467 | * @hide |
| 468 | */ |
| 469 | @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION) |
| 470 | @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES) |
| 471 | public static final String ACTION_CLEAR_DNS_CACHE = "android.net.action.CLEAR_DNS_CACHE"; |
| 472 | |
| 473 | /** |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 474 | * Invalid tethering type. |
| 475 | * @see #startTethering(int, boolean, OnStartTetheringCallback) |
| 476 | * @hide |
| 477 | */ |
| 478 | public static final int TETHERING_INVALID = TetheringManager.TETHERING_INVALID; |
| 479 | |
| 480 | /** |
| 481 | * Wifi tethering type. |
| 482 | * @see #startTethering(int, boolean, OnStartTetheringCallback) |
| 483 | * @hide |
| 484 | */ |
| 485 | @SystemApi |
Remi NGUYEN VAN | 71ced8e | 2021-02-15 18:52:06 +0900 | [diff] [blame] | 486 | public static final int TETHERING_WIFI = 0; |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 487 | |
| 488 | /** |
| 489 | * USB tethering type. |
| 490 | * @see #startTethering(int, boolean, OnStartTetheringCallback) |
| 491 | * @hide |
| 492 | */ |
| 493 | @SystemApi |
Remi NGUYEN VAN | 71ced8e | 2021-02-15 18:52:06 +0900 | [diff] [blame] | 494 | public static final int TETHERING_USB = 1; |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 495 | |
| 496 | /** |
| 497 | * Bluetooth tethering type. |
| 498 | * @see #startTethering(int, boolean, OnStartTetheringCallback) |
| 499 | * @hide |
| 500 | */ |
| 501 | @SystemApi |
Remi NGUYEN VAN | 71ced8e | 2021-02-15 18:52:06 +0900 | [diff] [blame] | 502 | public static final int TETHERING_BLUETOOTH = 2; |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 503 | |
| 504 | /** |
| 505 | * Wifi P2p tethering type. |
| 506 | * Wifi P2p tethering is set through events automatically, and don't |
| 507 | * need to start from #startTethering(int, boolean, OnStartTetheringCallback). |
| 508 | * @hide |
| 509 | */ |
| 510 | public static final int TETHERING_WIFI_P2P = TetheringManager.TETHERING_WIFI_P2P; |
| 511 | |
| 512 | /** |
| 513 | * Extra used for communicating with the TetherService. Includes the type of tethering to |
| 514 | * enable if any. |
| 515 | * @hide |
| 516 | */ |
| 517 | public static final String EXTRA_ADD_TETHER_TYPE = TetheringConstants.EXTRA_ADD_TETHER_TYPE; |
| 518 | |
| 519 | /** |
| 520 | * Extra used for communicating with the TetherService. Includes the type of tethering for |
| 521 | * which to cancel provisioning. |
| 522 | * @hide |
| 523 | */ |
| 524 | public static final String EXTRA_REM_TETHER_TYPE = TetheringConstants.EXTRA_REM_TETHER_TYPE; |
| 525 | |
| 526 | /** |
| 527 | * Extra used for communicating with the TetherService. True to schedule a recheck of tether |
| 528 | * provisioning. |
| 529 | * @hide |
| 530 | */ |
| 531 | public static final String EXTRA_SET_ALARM = TetheringConstants.EXTRA_SET_ALARM; |
| 532 | |
| 533 | /** |
| 534 | * Tells the TetherService to run a provision check now. |
| 535 | * @hide |
| 536 | */ |
| 537 | public static final String EXTRA_RUN_PROVISION = TetheringConstants.EXTRA_RUN_PROVISION; |
| 538 | |
| 539 | /** |
| 540 | * Extra used for communicating with the TetherService. Contains the {@link ResultReceiver} |
| 541 | * which will receive provisioning results. Can be left empty. |
| 542 | * @hide |
| 543 | */ |
| 544 | public static final String EXTRA_PROVISION_CALLBACK = |
| 545 | TetheringConstants.EXTRA_PROVISION_CALLBACK; |
| 546 | |
| 547 | /** |
| 548 | * The absence of a connection type. |
| 549 | * @hide |
| 550 | */ |
| 551 | @SystemApi |
| 552 | public static final int TYPE_NONE = -1; |
| 553 | |
| 554 | /** |
| 555 | * A Mobile data connection. Devices may support more than one. |
| 556 | * |
| 557 | * @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or |
| 558 | * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an |
| 559 | * appropriate network. {@see NetworkCapabilities} for supported transports. |
| 560 | */ |
| 561 | @Deprecated |
| 562 | public static final int TYPE_MOBILE = 0; |
| 563 | |
| 564 | /** |
| 565 | * A WIFI data connection. Devices may support more than one. |
| 566 | * |
| 567 | * @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or |
| 568 | * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an |
| 569 | * appropriate network. {@see NetworkCapabilities} for supported transports. |
| 570 | */ |
| 571 | @Deprecated |
| 572 | public static final int TYPE_WIFI = 1; |
| 573 | |
| 574 | /** |
| 575 | * An MMS-specific Mobile data connection. This network type may use the |
| 576 | * same network interface as {@link #TYPE_MOBILE} or it may use a different |
| 577 | * one. This is used by applications needing to talk to the carrier's |
| 578 | * Multimedia Messaging Service servers. |
| 579 | * |
| 580 | * @deprecated Applications should instead use {@link NetworkCapabilities#hasCapability} or |
| 581 | * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request a network that |
| 582 | * provides the {@link NetworkCapabilities#NET_CAPABILITY_MMS} capability. |
| 583 | */ |
| 584 | @Deprecated |
| 585 | public static final int TYPE_MOBILE_MMS = 2; |
| 586 | |
| 587 | /** |
| 588 | * A SUPL-specific Mobile data connection. This network type may use the |
| 589 | * same network interface as {@link #TYPE_MOBILE} or it may use a different |
| 590 | * one. This is used by applications needing to talk to the carrier's |
| 591 | * Secure User Plane Location servers for help locating the device. |
| 592 | * |
| 593 | * @deprecated Applications should instead use {@link NetworkCapabilities#hasCapability} or |
| 594 | * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request a network that |
| 595 | * provides the {@link NetworkCapabilities#NET_CAPABILITY_SUPL} capability. |
| 596 | */ |
| 597 | @Deprecated |
| 598 | public static final int TYPE_MOBILE_SUPL = 3; |
| 599 | |
| 600 | /** |
| 601 | * A DUN-specific Mobile data connection. This network type may use the |
| 602 | * same network interface as {@link #TYPE_MOBILE} or it may use a different |
| 603 | * one. This is sometimes by the system when setting up an upstream connection |
| 604 | * for tethering so that the carrier is aware of DUN traffic. |
| 605 | * |
| 606 | * @deprecated Applications should instead use {@link NetworkCapabilities#hasCapability} or |
| 607 | * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request a network that |
| 608 | * provides the {@link NetworkCapabilities#NET_CAPABILITY_DUN} capability. |
| 609 | */ |
| 610 | @Deprecated |
| 611 | public static final int TYPE_MOBILE_DUN = 4; |
| 612 | |
| 613 | /** |
| 614 | * A High Priority Mobile data connection. This network type uses the |
| 615 | * same network interface as {@link #TYPE_MOBILE} but the routing setup |
| 616 | * is different. |
| 617 | * |
| 618 | * @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or |
| 619 | * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an |
| 620 | * appropriate network. {@see NetworkCapabilities} for supported transports. |
| 621 | */ |
| 622 | @Deprecated |
| 623 | public static final int TYPE_MOBILE_HIPRI = 5; |
| 624 | |
| 625 | /** |
| 626 | * A WiMAX data connection. |
| 627 | * |
| 628 | * @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or |
| 629 | * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an |
| 630 | * appropriate network. {@see NetworkCapabilities} for supported transports. |
| 631 | */ |
| 632 | @Deprecated |
| 633 | public static final int TYPE_WIMAX = 6; |
| 634 | |
| 635 | /** |
| 636 | * A Bluetooth data connection. |
| 637 | * |
| 638 | * @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or |
| 639 | * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an |
| 640 | * appropriate network. {@see NetworkCapabilities} for supported transports. |
| 641 | */ |
| 642 | @Deprecated |
| 643 | public static final int TYPE_BLUETOOTH = 7; |
| 644 | |
| 645 | /** |
| 646 | * Fake data connection. This should not be used on shipping devices. |
| 647 | * @deprecated This is not used any more. |
| 648 | */ |
| 649 | @Deprecated |
| 650 | public static final int TYPE_DUMMY = 8; |
| 651 | |
| 652 | /** |
| 653 | * An Ethernet data connection. |
| 654 | * |
| 655 | * @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or |
| 656 | * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an |
| 657 | * appropriate network. {@see NetworkCapabilities} for supported transports. |
| 658 | */ |
| 659 | @Deprecated |
| 660 | public static final int TYPE_ETHERNET = 9; |
| 661 | |
| 662 | /** |
| 663 | * Over the air Administration. |
| 664 | * @deprecated Use {@link NetworkCapabilities} instead. |
| 665 | * {@hide} |
| 666 | */ |
| 667 | @Deprecated |
| 668 | @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 130143562) |
| 669 | public static final int TYPE_MOBILE_FOTA = 10; |
| 670 | |
| 671 | /** |
| 672 | * IP Multimedia Subsystem. |
| 673 | * @deprecated Use {@link NetworkCapabilities#NET_CAPABILITY_IMS} instead. |
| 674 | * {@hide} |
| 675 | */ |
| 676 | @Deprecated |
| 677 | @UnsupportedAppUsage |
| 678 | public static final int TYPE_MOBILE_IMS = 11; |
| 679 | |
| 680 | /** |
| 681 | * Carrier Branded Services. |
| 682 | * @deprecated Use {@link NetworkCapabilities#NET_CAPABILITY_CBS} instead. |
| 683 | * {@hide} |
| 684 | */ |
| 685 | @Deprecated |
| 686 | @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 130143562) |
| 687 | public static final int TYPE_MOBILE_CBS = 12; |
| 688 | |
| 689 | /** |
| 690 | * A Wi-Fi p2p connection. Only requesting processes will have access to |
| 691 | * the peers connected. |
| 692 | * @deprecated Use {@link NetworkCapabilities#NET_CAPABILITY_WIFI_P2P} instead. |
| 693 | * {@hide} |
| 694 | */ |
| 695 | @Deprecated |
| 696 | @SystemApi |
| 697 | public static final int TYPE_WIFI_P2P = 13; |
| 698 | |
| 699 | /** |
| 700 | * The network to use for initially attaching to the network |
| 701 | * @deprecated Use {@link NetworkCapabilities#NET_CAPABILITY_IA} instead. |
| 702 | * {@hide} |
| 703 | */ |
| 704 | @Deprecated |
| 705 | @UnsupportedAppUsage |
| 706 | public static final int TYPE_MOBILE_IA = 14; |
| 707 | |
| 708 | /** |
| 709 | * Emergency PDN connection for emergency services. This |
| 710 | * may include IMS and MMS in emergency situations. |
| 711 | * @deprecated Use {@link NetworkCapabilities#NET_CAPABILITY_EIMS} instead. |
| 712 | * {@hide} |
| 713 | */ |
| 714 | @Deprecated |
| 715 | @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 130143562) |
| 716 | public static final int TYPE_MOBILE_EMERGENCY = 15; |
| 717 | |
| 718 | /** |
| 719 | * The network that uses proxy to achieve connectivity. |
| 720 | * @deprecated Use {@link NetworkCapabilities} instead. |
| 721 | * {@hide} |
| 722 | */ |
| 723 | @Deprecated |
| 724 | @SystemApi |
| 725 | public static final int TYPE_PROXY = 16; |
| 726 | |
| 727 | /** |
| 728 | * A virtual network using one or more native bearers. |
| 729 | * It may or may not be providing security services. |
| 730 | * @deprecated Applications should use {@link NetworkCapabilities#TRANSPORT_VPN} instead. |
| 731 | */ |
| 732 | @Deprecated |
| 733 | public static final int TYPE_VPN = 17; |
| 734 | |
| 735 | /** |
| 736 | * A network that is exclusively meant to be used for testing |
| 737 | * |
| 738 | * @deprecated Use {@link NetworkCapabilities} instead. |
| 739 | * @hide |
| 740 | */ |
| 741 | @Deprecated |
| 742 | public static final int TYPE_TEST = 18; // TODO: Remove this once NetworkTypes are unused. |
| 743 | |
| 744 | /** |
| 745 | * @deprecated Use {@link NetworkCapabilities} instead. |
| 746 | * @hide |
| 747 | */ |
| 748 | @Deprecated |
| 749 | @Retention(RetentionPolicy.SOURCE) |
| 750 | @IntDef(prefix = { "TYPE_" }, value = { |
| 751 | TYPE_NONE, |
| 752 | TYPE_MOBILE, |
| 753 | TYPE_WIFI, |
| 754 | TYPE_MOBILE_MMS, |
| 755 | TYPE_MOBILE_SUPL, |
| 756 | TYPE_MOBILE_DUN, |
| 757 | TYPE_MOBILE_HIPRI, |
| 758 | TYPE_WIMAX, |
| 759 | TYPE_BLUETOOTH, |
| 760 | TYPE_DUMMY, |
| 761 | TYPE_ETHERNET, |
| 762 | TYPE_MOBILE_FOTA, |
| 763 | TYPE_MOBILE_IMS, |
| 764 | TYPE_MOBILE_CBS, |
| 765 | TYPE_WIFI_P2P, |
| 766 | TYPE_MOBILE_IA, |
| 767 | TYPE_MOBILE_EMERGENCY, |
| 768 | TYPE_PROXY, |
| 769 | TYPE_VPN, |
| 770 | TYPE_TEST |
| 771 | }) |
| 772 | public @interface LegacyNetworkType {} |
| 773 | |
| 774 | // Deprecated constants for return values of startUsingNetworkFeature. They used to live |
| 775 | // in com.android.internal.telephony.PhoneConstants until they were made inaccessible. |
| 776 | private static final int DEPRECATED_PHONE_CONSTANT_APN_ALREADY_ACTIVE = 0; |
| 777 | private static final int DEPRECATED_PHONE_CONSTANT_APN_REQUEST_STARTED = 1; |
| 778 | private static final int DEPRECATED_PHONE_CONSTANT_APN_REQUEST_FAILED = 3; |
| 779 | |
| 780 | /** {@hide} */ |
| 781 | public static final int MAX_RADIO_TYPE = TYPE_TEST; |
| 782 | |
| 783 | /** {@hide} */ |
| 784 | public static final int MAX_NETWORK_TYPE = TYPE_TEST; |
| 785 | |
| 786 | private static final int MIN_NETWORK_TYPE = TYPE_MOBILE; |
| 787 | |
| 788 | /** |
| 789 | * If you want to set the default network preference,you can directly |
| 790 | * change the networkAttributes array in framework's config.xml. |
| 791 | * |
| 792 | * @deprecated Since we support so many more networks now, the single |
| 793 | * network default network preference can't really express |
| 794 | * the hierarchy. Instead, the default is defined by the |
| 795 | * networkAttributes in config.xml. You can determine |
| 796 | * the current value by calling {@link #getNetworkPreference()} |
| 797 | * from an App. |
| 798 | */ |
| 799 | @Deprecated |
| 800 | public static final int DEFAULT_NETWORK_PREFERENCE = TYPE_WIFI; |
| 801 | |
| 802 | /** |
| 803 | * @hide |
| 804 | */ |
| 805 | public static final int REQUEST_ID_UNSET = 0; |
| 806 | |
| 807 | /** |
| 808 | * Static unique request used as a tombstone for NetworkCallbacks that have been unregistered. |
| 809 | * This allows to distinguish when unregistering NetworkCallbacks those that were never |
| 810 | * registered from those that were already unregistered. |
| 811 | * @hide |
| 812 | */ |
| 813 | private static final NetworkRequest ALREADY_UNREGISTERED = |
| 814 | new NetworkRequest.Builder().clearCapabilities().build(); |
| 815 | |
| 816 | /** |
| 817 | * A NetID indicating no Network is selected. |
| 818 | * Keep in sync with bionic/libc/dns/include/resolv_netid.h |
| 819 | * @hide |
| 820 | */ |
| 821 | public static final int NETID_UNSET = 0; |
| 822 | |
| 823 | /** |
Sudheer Shanka | 1d0d9b4 | 2021-03-23 08:12:28 +0000 | [diff] [blame] | 824 | * Flag to indicate that an app is not subject to any restrictions that could result in its |
| 825 | * network access blocked. |
| 826 | * |
| 827 | * @hide |
| 828 | */ |
| 829 | @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES) |
| 830 | public static final int BLOCKED_REASON_NONE = 0; |
| 831 | |
| 832 | /** |
| 833 | * Flag to indicate that an app is subject to Battery saver restrictions that would |
| 834 | * result in its network access being blocked. |
| 835 | * |
| 836 | * @hide |
| 837 | */ |
| 838 | @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES) |
| 839 | public static final int BLOCKED_REASON_BATTERY_SAVER = 1 << 0; |
| 840 | |
| 841 | /** |
| 842 | * Flag to indicate that an app is subject to Doze restrictions that would |
| 843 | * result in its network access being blocked. |
| 844 | * |
| 845 | * @hide |
| 846 | */ |
| 847 | @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES) |
| 848 | public static final int BLOCKED_REASON_DOZE = 1 << 1; |
| 849 | |
| 850 | /** |
| 851 | * Flag to indicate that an app is subject to App Standby restrictions that would |
| 852 | * result in its network access being blocked. |
| 853 | * |
| 854 | * @hide |
| 855 | */ |
| 856 | @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES) |
| 857 | public static final int BLOCKED_REASON_APP_STANDBY = 1 << 2; |
| 858 | |
| 859 | /** |
| 860 | * Flag to indicate that an app is subject to Restricted mode restrictions that would |
| 861 | * result in its network access being blocked. |
| 862 | * |
| 863 | * @hide |
| 864 | */ |
| 865 | @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES) |
| 866 | public static final int BLOCKED_REASON_RESTRICTED_MODE = 1 << 3; |
| 867 | |
| 868 | /** |
Lorenzo Colitti | 8ad5812 | 2021-03-18 00:54:57 +0900 | [diff] [blame] | 869 | * Flag to indicate that an app is blocked because it is subject to an always-on VPN but the VPN |
| 870 | * is not currently connected. |
| 871 | * |
| 872 | * @see DevicePolicyManager#setAlwaysOnVpnPackage(ComponentName, String, boolean) |
| 873 | * |
| 874 | * @hide |
| 875 | */ |
| 876 | @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES) |
| 877 | public static final int BLOCKED_REASON_LOCKDOWN_VPN = 1 << 4; |
| 878 | |
| 879 | /** |
Robert Horvath | 2dac948 | 2021-11-15 15:49:37 +0100 | [diff] [blame] | 880 | * Flag to indicate that an app is subject to Low Power Standby restrictions that would |
| 881 | * result in its network access being blocked. |
| 882 | * |
| 883 | * @hide |
| 884 | */ |
| 885 | @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES) |
| 886 | public static final int BLOCKED_REASON_LOW_POWER_STANDBY = 1 << 5; |
| 887 | |
| 888 | /** |
Sudheer Shanka | 1d0d9b4 | 2021-03-23 08:12:28 +0000 | [diff] [blame] | 889 | * Flag to indicate that an app is subject to Data saver restrictions that would |
| 890 | * result in its metered network access being blocked. |
| 891 | * |
| 892 | * @hide |
| 893 | */ |
| 894 | @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES) |
| 895 | public static final int BLOCKED_METERED_REASON_DATA_SAVER = 1 << 16; |
| 896 | |
| 897 | /** |
| 898 | * Flag to indicate that an app is subject to user restrictions that would |
| 899 | * result in its metered network access being blocked. |
| 900 | * |
| 901 | * @hide |
| 902 | */ |
| 903 | @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES) |
| 904 | public static final int BLOCKED_METERED_REASON_USER_RESTRICTED = 1 << 17; |
| 905 | |
| 906 | /** |
| 907 | * Flag to indicate that an app is subject to Device admin restrictions that would |
| 908 | * result in its metered network access being blocked. |
| 909 | * |
| 910 | * @hide |
| 911 | */ |
| 912 | @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES) |
| 913 | public static final int BLOCKED_METERED_REASON_ADMIN_DISABLED = 1 << 18; |
| 914 | |
| 915 | /** |
| 916 | * @hide |
| 917 | */ |
| 918 | @Retention(RetentionPolicy.SOURCE) |
| 919 | @IntDef(flag = true, prefix = {"BLOCKED_"}, value = { |
| 920 | BLOCKED_REASON_NONE, |
| 921 | BLOCKED_REASON_BATTERY_SAVER, |
| 922 | BLOCKED_REASON_DOZE, |
| 923 | BLOCKED_REASON_APP_STANDBY, |
| 924 | BLOCKED_REASON_RESTRICTED_MODE, |
Lorenzo Colitti | a1bd6f6 | 2021-03-25 23:17:36 +0900 | [diff] [blame] | 925 | BLOCKED_REASON_LOCKDOWN_VPN, |
Robert Horvath | 2dac948 | 2021-11-15 15:49:37 +0100 | [diff] [blame] | 926 | BLOCKED_REASON_LOW_POWER_STANDBY, |
Sudheer Shanka | 1d0d9b4 | 2021-03-23 08:12:28 +0000 | [diff] [blame] | 927 | BLOCKED_METERED_REASON_DATA_SAVER, |
| 928 | BLOCKED_METERED_REASON_USER_RESTRICTED, |
| 929 | BLOCKED_METERED_REASON_ADMIN_DISABLED, |
| 930 | }) |
| 931 | public @interface BlockedReason {} |
| 932 | |
Lorenzo Colitti | 8ad5812 | 2021-03-18 00:54:57 +0900 | [diff] [blame] | 933 | /** |
| 934 | * Set of blocked reasons that are only applicable on metered networks. |
| 935 | * |
| 936 | * @hide |
| 937 | */ |
| 938 | @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES) |
| 939 | public static final int BLOCKED_METERED_REASON_MASK = 0xffff0000; |
| 940 | |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 941 | @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 130143562) |
| 942 | private final IConnectivityManager mService; |
Lorenzo Colitti | 842075e | 2021-02-04 17:32:07 +0900 | [diff] [blame] | 943 | |
Robert Horvath | d945bf0 | 2022-01-27 19:55:16 +0100 | [diff] [blame] | 944 | // LINT.IfChange(firewall_chain) |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 945 | /** |
markchien | e1561fa | 2021-12-09 22:00:56 +0800 | [diff] [blame] | 946 | * Firewall chain for device idle (doze mode). |
| 947 | * Allowlist of apps that have network access in device idle. |
| 948 | * @hide |
| 949 | */ |
| 950 | @SystemApi(client = MODULE_LIBRARIES) |
| 951 | public static final int FIREWALL_CHAIN_DOZABLE = 1; |
| 952 | |
| 953 | /** |
| 954 | * Firewall chain used for app standby. |
| 955 | * Denylist of apps that do not have network access. |
| 956 | * @hide |
| 957 | */ |
| 958 | @SystemApi(client = MODULE_LIBRARIES) |
| 959 | public static final int FIREWALL_CHAIN_STANDBY = 2; |
| 960 | |
| 961 | /** |
| 962 | * Firewall chain used for battery saver. |
| 963 | * Allowlist of apps that have network access when battery saver is on. |
| 964 | * @hide |
| 965 | */ |
| 966 | @SystemApi(client = MODULE_LIBRARIES) |
| 967 | public static final int FIREWALL_CHAIN_POWERSAVE = 3; |
| 968 | |
| 969 | /** |
| 970 | * Firewall chain used for restricted networking mode. |
| 971 | * Allowlist of apps that have access in restricted networking mode. |
| 972 | * @hide |
| 973 | */ |
| 974 | @SystemApi(client = MODULE_LIBRARIES) |
| 975 | public static final int FIREWALL_CHAIN_RESTRICTED = 4; |
| 976 | |
Robert Horvath | 34cba14 | 2022-01-27 19:52:43 +0100 | [diff] [blame] | 977 | /** |
| 978 | * Firewall chain used for low power standby. |
| 979 | * Allowlist of apps that have access in low power standby. |
| 980 | * @hide |
| 981 | */ |
| 982 | @SystemApi(client = MODULE_LIBRARIES) |
| 983 | public static final int FIREWALL_CHAIN_LOW_POWER_STANDBY = 5; |
| 984 | |
Motomu Utsumi | 966ff7f | 2022-05-11 05:56:26 +0000 | [diff] [blame] | 985 | /** |
| 986 | * Firewall chain used for lockdown VPN. |
| 987 | * Denylist of apps that cannot receive incoming packets except on loopback because they are |
| 988 | * subject to an always-on VPN which is not currently connected. |
| 989 | * |
| 990 | * @see #BLOCKED_REASON_LOCKDOWN_VPN |
| 991 | * @hide |
| 992 | */ |
| 993 | public static final int FIREWALL_CHAIN_LOCKDOWN_VPN = 6; |
| 994 | |
Motomu Utsumi | 9cd4726 | 2022-06-01 13:57:27 +0000 | [diff] [blame] | 995 | /** |
| 996 | * Firewall chain used for OEM-specific application restrictions. |
| 997 | * Denylist of apps that will not have network access due to OEM-specific restrictions. |
| 998 | * @hide |
| 999 | */ |
| 1000 | public static final int FIREWALL_CHAIN_OEM_DENY_1 = 7; |
| 1001 | |
| 1002 | /** |
| 1003 | * Firewall chain used for OEM-specific application restrictions. |
| 1004 | * Denylist of apps that will not have network access due to OEM-specific restrictions. |
| 1005 | * @hide |
| 1006 | */ |
| 1007 | public static final int FIREWALL_CHAIN_OEM_DENY_2 = 8; |
| 1008 | |
Motomu Utsumi | 608015f | 2022-06-06 07:44:05 +0000 | [diff] [blame] | 1009 | /** |
| 1010 | * Firewall chain used for OEM-specific application restrictions. |
| 1011 | * Denylist of apps that will not have network access due to OEM-specific restrictions. |
| 1012 | * @hide |
| 1013 | */ |
| 1014 | public static final int FIREWALL_CHAIN_OEM_DENY_3 = 9; |
| 1015 | |
markchien | e1561fa | 2021-12-09 22:00:56 +0800 | [diff] [blame] | 1016 | /** @hide */ |
| 1017 | @Retention(RetentionPolicy.SOURCE) |
| 1018 | @IntDef(flag = false, prefix = "FIREWALL_CHAIN_", value = { |
| 1019 | FIREWALL_CHAIN_DOZABLE, |
| 1020 | FIREWALL_CHAIN_STANDBY, |
| 1021 | FIREWALL_CHAIN_POWERSAVE, |
Robert Horvath | 34cba14 | 2022-01-27 19:52:43 +0100 | [diff] [blame] | 1022 | FIREWALL_CHAIN_RESTRICTED, |
Motomu Utsumi | 966ff7f | 2022-05-11 05:56:26 +0000 | [diff] [blame] | 1023 | FIREWALL_CHAIN_LOW_POWER_STANDBY, |
Motomu Utsumi | 9cd4726 | 2022-06-01 13:57:27 +0000 | [diff] [blame] | 1024 | FIREWALL_CHAIN_LOCKDOWN_VPN, |
| 1025 | FIREWALL_CHAIN_OEM_DENY_1, |
Motomu Utsumi | 608015f | 2022-06-06 07:44:05 +0000 | [diff] [blame] | 1026 | FIREWALL_CHAIN_OEM_DENY_2, |
| 1027 | FIREWALL_CHAIN_OEM_DENY_3 |
markchien | e1561fa | 2021-12-09 22:00:56 +0800 | [diff] [blame] | 1028 | }) |
| 1029 | public @interface FirewallChain {} |
Robert Horvath | d945bf0 | 2022-01-27 19:55:16 +0100 | [diff] [blame] | 1030 | // LINT.ThenChange(packages/modules/Connectivity/service/native/include/Common.h) |
markchien | e1561fa | 2021-12-09 22:00:56 +0800 | [diff] [blame] | 1031 | |
| 1032 | /** |
markchien | 011a7f5 | 2022-03-29 01:07:22 +0800 | [diff] [blame] | 1033 | * A firewall rule which allows or drops packets depending on existing policy. |
| 1034 | * Used by {@link #setUidFirewallRule(int, int, int)} to follow existing policy to handle |
| 1035 | * specific uid's packets in specific firewall chain. |
markchien | 3c04e66 | 2022-03-22 16:29:56 +0800 | [diff] [blame] | 1036 | * @hide |
| 1037 | */ |
| 1038 | @SystemApi(client = MODULE_LIBRARIES) |
| 1039 | public static final int FIREWALL_RULE_DEFAULT = 0; |
| 1040 | |
| 1041 | /** |
markchien | 011a7f5 | 2022-03-29 01:07:22 +0800 | [diff] [blame] | 1042 | * A firewall rule which allows packets. Used by {@link #setUidFirewallRule(int, int, int)} to |
| 1043 | * allow specific uid's packets in specific firewall chain. |
markchien | 3c04e66 | 2022-03-22 16:29:56 +0800 | [diff] [blame] | 1044 | * @hide |
| 1045 | */ |
| 1046 | @SystemApi(client = MODULE_LIBRARIES) |
| 1047 | public static final int FIREWALL_RULE_ALLOW = 1; |
| 1048 | |
| 1049 | /** |
markchien | 011a7f5 | 2022-03-29 01:07:22 +0800 | [diff] [blame] | 1050 | * A firewall rule which drops packets. Used by {@link #setUidFirewallRule(int, int, int)} to |
| 1051 | * drop specific uid's packets in specific firewall chain. |
markchien | 3c04e66 | 2022-03-22 16:29:56 +0800 | [diff] [blame] | 1052 | * @hide |
| 1053 | */ |
| 1054 | @SystemApi(client = MODULE_LIBRARIES) |
| 1055 | public static final int FIREWALL_RULE_DENY = 2; |
| 1056 | |
| 1057 | /** @hide */ |
| 1058 | @Retention(RetentionPolicy.SOURCE) |
| 1059 | @IntDef(flag = false, prefix = "FIREWALL_RULE_", value = { |
| 1060 | FIREWALL_RULE_DEFAULT, |
| 1061 | FIREWALL_RULE_ALLOW, |
| 1062 | FIREWALL_RULE_DENY |
| 1063 | }) |
| 1064 | public @interface FirewallRule {} |
| 1065 | |
| 1066 | /** |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 1067 | * A kludge to facilitate static access where a Context pointer isn't available, like in the |
| 1068 | * case of the static set/getProcessDefaultNetwork methods and from the Network class. |
| 1069 | * TODO: Remove this after deprecating the static methods in favor of non-static methods or |
| 1070 | * methods that take a Context argument. |
| 1071 | */ |
| 1072 | private static ConnectivityManager sInstance; |
| 1073 | |
| 1074 | private final Context mContext; |
| 1075 | |
Remi NGUYEN VAN | e4d1cd9 | 2021-06-17 16:27:31 +0900 | [diff] [blame] | 1076 | @GuardedBy("mTetheringEventCallbacks") |
| 1077 | private TetheringManager mTetheringManager; |
| 1078 | |
| 1079 | private TetheringManager getTetheringManager() { |
| 1080 | synchronized (mTetheringEventCallbacks) { |
| 1081 | if (mTetheringManager == null) { |
| 1082 | mTetheringManager = mContext.getSystemService(TetheringManager.class); |
| 1083 | } |
| 1084 | return mTetheringManager; |
| 1085 | } |
| 1086 | } |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 1087 | |
| 1088 | /** |
| 1089 | * Tests if a given integer represents a valid network type. |
| 1090 | * @param networkType the type to be tested |
| 1091 | * @return a boolean. {@code true} if the type is valid, else {@code false} |
| 1092 | * @deprecated All APIs accepting a network type are deprecated. There should be no need to |
| 1093 | * validate a network type. |
| 1094 | */ |
| 1095 | @Deprecated |
| 1096 | public static boolean isNetworkTypeValid(int networkType) { |
| 1097 | return MIN_NETWORK_TYPE <= networkType && networkType <= MAX_NETWORK_TYPE; |
| 1098 | } |
| 1099 | |
| 1100 | /** |
| 1101 | * Returns a non-localized string representing a given network type. |
| 1102 | * ONLY used for debugging output. |
| 1103 | * @param type the type needing naming |
| 1104 | * @return a String for the given type, or a string version of the type ("87") |
| 1105 | * if no name is known. |
| 1106 | * @deprecated Types are deprecated. Use {@link NetworkCapabilities} instead. |
| 1107 | * {@hide} |
| 1108 | */ |
| 1109 | @Deprecated |
| 1110 | @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553) |
| 1111 | public static String getNetworkTypeName(int type) { |
| 1112 | switch (type) { |
| 1113 | case TYPE_NONE: |
| 1114 | return "NONE"; |
| 1115 | case TYPE_MOBILE: |
| 1116 | return "MOBILE"; |
| 1117 | case TYPE_WIFI: |
| 1118 | return "WIFI"; |
| 1119 | case TYPE_MOBILE_MMS: |
| 1120 | return "MOBILE_MMS"; |
| 1121 | case TYPE_MOBILE_SUPL: |
| 1122 | return "MOBILE_SUPL"; |
| 1123 | case TYPE_MOBILE_DUN: |
| 1124 | return "MOBILE_DUN"; |
| 1125 | case TYPE_MOBILE_HIPRI: |
| 1126 | return "MOBILE_HIPRI"; |
| 1127 | case TYPE_WIMAX: |
| 1128 | return "WIMAX"; |
| 1129 | case TYPE_BLUETOOTH: |
| 1130 | return "BLUETOOTH"; |
| 1131 | case TYPE_DUMMY: |
| 1132 | return "DUMMY"; |
| 1133 | case TYPE_ETHERNET: |
| 1134 | return "ETHERNET"; |
| 1135 | case TYPE_MOBILE_FOTA: |
| 1136 | return "MOBILE_FOTA"; |
| 1137 | case TYPE_MOBILE_IMS: |
| 1138 | return "MOBILE_IMS"; |
| 1139 | case TYPE_MOBILE_CBS: |
| 1140 | return "MOBILE_CBS"; |
| 1141 | case TYPE_WIFI_P2P: |
| 1142 | return "WIFI_P2P"; |
| 1143 | case TYPE_MOBILE_IA: |
| 1144 | return "MOBILE_IA"; |
| 1145 | case TYPE_MOBILE_EMERGENCY: |
| 1146 | return "MOBILE_EMERGENCY"; |
| 1147 | case TYPE_PROXY: |
| 1148 | return "PROXY"; |
| 1149 | case TYPE_VPN: |
| 1150 | return "VPN"; |
| 1151 | default: |
| 1152 | return Integer.toString(type); |
| 1153 | } |
| 1154 | } |
| 1155 | |
| 1156 | /** |
| 1157 | * @hide |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 1158 | */ |
lucaslin | 10774b7 | 2021-03-17 14:16:01 +0800 | [diff] [blame] | 1159 | @SystemApi(client = MODULE_LIBRARIES) |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 1160 | public void systemReady() { |
| 1161 | try { |
| 1162 | mService.systemReady(); |
| 1163 | } catch (RemoteException e) { |
| 1164 | throw e.rethrowFromSystemServer(); |
| 1165 | } |
| 1166 | } |
| 1167 | |
| 1168 | /** |
| 1169 | * Checks if a given type uses the cellular data connection. |
| 1170 | * This should be replaced in the future by a network property. |
| 1171 | * @param networkType the type to check |
| 1172 | * @return a boolean - {@code true} if uses cellular network, else {@code false} |
| 1173 | * @deprecated Types are deprecated. Use {@link NetworkCapabilities} instead. |
| 1174 | * {@hide} |
| 1175 | */ |
| 1176 | @Deprecated |
| 1177 | @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 130143562) |
| 1178 | public static boolean isNetworkTypeMobile(int networkType) { |
| 1179 | switch (networkType) { |
| 1180 | case TYPE_MOBILE: |
| 1181 | case TYPE_MOBILE_MMS: |
| 1182 | case TYPE_MOBILE_SUPL: |
| 1183 | case TYPE_MOBILE_DUN: |
| 1184 | case TYPE_MOBILE_HIPRI: |
| 1185 | case TYPE_MOBILE_FOTA: |
| 1186 | case TYPE_MOBILE_IMS: |
| 1187 | case TYPE_MOBILE_CBS: |
| 1188 | case TYPE_MOBILE_IA: |
| 1189 | case TYPE_MOBILE_EMERGENCY: |
| 1190 | return true; |
| 1191 | default: |
| 1192 | return false; |
| 1193 | } |
| 1194 | } |
| 1195 | |
| 1196 | /** |
| 1197 | * Checks if the given network type is backed by a Wi-Fi radio. |
| 1198 | * |
| 1199 | * @deprecated Types are deprecated. Use {@link NetworkCapabilities} instead. |
| 1200 | * @hide |
| 1201 | */ |
| 1202 | @Deprecated |
| 1203 | public static boolean isNetworkTypeWifi(int networkType) { |
| 1204 | switch (networkType) { |
| 1205 | case TYPE_WIFI: |
| 1206 | case TYPE_WIFI_P2P: |
| 1207 | return true; |
| 1208 | default: |
| 1209 | return false; |
| 1210 | } |
| 1211 | } |
| 1212 | |
| 1213 | /** |
Sooraj Sasindran | 06baf4c | 2021-11-29 12:21:09 -0800 | [diff] [blame] | 1214 | * Preference for {@link ProfileNetworkPreference#setPreference(int)}. |
| 1215 | * {@see #setProfileNetworkPreferences(UserHandle, List, Executor, Runnable)} |
Chalard Jean | ad565e2 | 2021-02-25 17:23:40 +0900 | [diff] [blame] | 1216 | * Specify that the traffic for this user should by follow the default rules. |
| 1217 | * @hide |
| 1218 | */ |
Chalard Jean | bef6b09 | 2021-03-17 14:33:24 +0900 | [diff] [blame] | 1219 | @SystemApi(client = MODULE_LIBRARIES) |
Chalard Jean | ad565e2 | 2021-02-25 17:23:40 +0900 | [diff] [blame] | 1220 | public static final int PROFILE_NETWORK_PREFERENCE_DEFAULT = 0; |
| 1221 | |
| 1222 | /** |
Sooraj Sasindran | 06baf4c | 2021-11-29 12:21:09 -0800 | [diff] [blame] | 1223 | * Preference for {@link ProfileNetworkPreference#setPreference(int)}. |
| 1224 | * {@see #setProfileNetworkPreferences(UserHandle, List, Executor, Runnable)} |
Chalard Jean | ad565e2 | 2021-02-25 17:23:40 +0900 | [diff] [blame] | 1225 | * Specify that the traffic for this user should by default go on a network with |
| 1226 | * {@link NetworkCapabilities#NET_CAPABILITY_ENTERPRISE}, and on the system default network |
| 1227 | * if no such network is available. |
| 1228 | * @hide |
| 1229 | */ |
Chalard Jean | bef6b09 | 2021-03-17 14:33:24 +0900 | [diff] [blame] | 1230 | @SystemApi(client = MODULE_LIBRARIES) |
Chalard Jean | ad565e2 | 2021-02-25 17:23:40 +0900 | [diff] [blame] | 1231 | public static final int PROFILE_NETWORK_PREFERENCE_ENTERPRISE = 1; |
| 1232 | |
Sooraj Sasindran | 06baf4c | 2021-11-29 12:21:09 -0800 | [diff] [blame] | 1233 | /** |
| 1234 | * Preference for {@link ProfileNetworkPreference#setPreference(int)}. |
| 1235 | * {@see #setProfileNetworkPreferences(UserHandle, List, Executor, Runnable)} |
| 1236 | * Specify that the traffic for this user should by default go on a network with |
| 1237 | * {@link NetworkCapabilities#NET_CAPABILITY_ENTERPRISE} and if no such network is available |
| 1238 | * should not go on the system default network |
| 1239 | * @hide |
| 1240 | */ |
| 1241 | @SystemApi(client = MODULE_LIBRARIES) |
| 1242 | public static final int PROFILE_NETWORK_PREFERENCE_ENTERPRISE_NO_FALLBACK = 2; |
| 1243 | |
Chalard Jean | ad565e2 | 2021-02-25 17:23:40 +0900 | [diff] [blame] | 1244 | /** @hide */ |
| 1245 | @Retention(RetentionPolicy.SOURCE) |
| 1246 | @IntDef(value = { |
| 1247 | PROFILE_NETWORK_PREFERENCE_DEFAULT, |
Sooraj Sasindran | 06baf4c | 2021-11-29 12:21:09 -0800 | [diff] [blame] | 1248 | PROFILE_NETWORK_PREFERENCE_ENTERPRISE, |
| 1249 | PROFILE_NETWORK_PREFERENCE_ENTERPRISE_NO_FALLBACK |
Chalard Jean | ad565e2 | 2021-02-25 17:23:40 +0900 | [diff] [blame] | 1250 | }) |
Sooraj Sasindran | e7aee27 | 2021-11-24 20:26:55 -0800 | [diff] [blame] | 1251 | public @interface ProfileNetworkPreferencePolicy { |
Chalard Jean | ad565e2 | 2021-02-25 17:23:40 +0900 | [diff] [blame] | 1252 | } |
| 1253 | |
| 1254 | /** |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 1255 | * Specifies the preferred network type. When the device has more |
| 1256 | * than one type available the preferred network type will be used. |
| 1257 | * |
| 1258 | * @param preference the network type to prefer over all others. It is |
| 1259 | * unspecified what happens to the old preferred network in the |
| 1260 | * overall ordering. |
| 1261 | * @deprecated Functionality has been removed as it no longer makes sense, |
| 1262 | * with many more than two networks - we'd need an array to express |
| 1263 | * preference. Instead we use dynamic network properties of |
| 1264 | * the networks to describe their precedence. |
| 1265 | */ |
| 1266 | @Deprecated |
| 1267 | public void setNetworkPreference(int preference) { |
| 1268 | } |
| 1269 | |
| 1270 | /** |
| 1271 | * Retrieves the current preferred network type. |
| 1272 | * |
| 1273 | * @return an integer representing the preferred network type |
| 1274 | * |
| 1275 | * @deprecated Functionality has been removed as it no longer makes sense, |
| 1276 | * with many more than two networks - we'd need an array to express |
| 1277 | * preference. Instead we use dynamic network properties of |
| 1278 | * the networks to describe their precedence. |
| 1279 | */ |
| 1280 | @Deprecated |
| 1281 | @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE) |
| 1282 | public int getNetworkPreference() { |
| 1283 | return TYPE_NONE; |
| 1284 | } |
| 1285 | |
| 1286 | /** |
| 1287 | * Returns details about the currently active default data network. When |
| 1288 | * connected, this network is the default route for outgoing connections. |
| 1289 | * You should always check {@link NetworkInfo#isConnected()} before initiating |
| 1290 | * network traffic. This may return {@code null} when there is no default |
| 1291 | * network. |
| 1292 | * Note that if the default network is a VPN, this method will return the |
| 1293 | * NetworkInfo for one of its underlying networks instead, or null if the |
| 1294 | * VPN agent did not specify any. Apps interested in learning about VPNs |
| 1295 | * should use {@link #getNetworkInfo(android.net.Network)} instead. |
| 1296 | * |
| 1297 | * @return a {@link NetworkInfo} object for the current default network |
| 1298 | * or {@code null} if no default network is currently active |
| 1299 | * @deprecated See {@link NetworkInfo}. |
| 1300 | */ |
| 1301 | @Deprecated |
| 1302 | @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE) |
| 1303 | @Nullable |
| 1304 | public NetworkInfo getActiveNetworkInfo() { |
| 1305 | try { |
| 1306 | return mService.getActiveNetworkInfo(); |
| 1307 | } catch (RemoteException e) { |
| 1308 | throw e.rethrowFromSystemServer(); |
| 1309 | } |
| 1310 | } |
| 1311 | |
| 1312 | /** |
| 1313 | * Returns a {@link Network} object corresponding to the currently active |
| 1314 | * default data network. In the event that the current active default data |
| 1315 | * network disconnects, the returned {@code Network} object will no longer |
| 1316 | * be usable. This will return {@code null} when there is no default |
Chalard Jean | 0d05151 | 2021-09-28 15:31:15 +0900 | [diff] [blame] | 1317 | * network, or when the default network is blocked. |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 1318 | * |
| 1319 | * @return a {@link Network} object for the current default network or |
Chalard Jean | 0d05151 | 2021-09-28 15:31:15 +0900 | [diff] [blame] | 1320 | * {@code null} if no default network is currently active or if |
| 1321 | * the default network is blocked for the caller |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 1322 | */ |
| 1323 | @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE) |
| 1324 | @Nullable |
| 1325 | public Network getActiveNetwork() { |
| 1326 | try { |
| 1327 | return mService.getActiveNetwork(); |
| 1328 | } catch (RemoteException e) { |
| 1329 | throw e.rethrowFromSystemServer(); |
| 1330 | } |
| 1331 | } |
| 1332 | |
| 1333 | /** |
| 1334 | * Returns a {@link Network} object corresponding to the currently active |
| 1335 | * default data network for a specific UID. In the event that the default data |
| 1336 | * network disconnects, the returned {@code Network} object will no longer |
| 1337 | * be usable. This will return {@code null} when there is no default |
| 1338 | * network for the UID. |
| 1339 | * |
| 1340 | * @return a {@link Network} object for the current default network for the |
| 1341 | * given UID or {@code null} if no default network is currently active |
lifr | db7d676 | 2021-03-30 21:04:53 +0800 | [diff] [blame] | 1342 | * |
| 1343 | * @hide |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 1344 | */ |
| 1345 | @RequiresPermission(android.Manifest.permission.NETWORK_STACK) |
| 1346 | @Nullable |
| 1347 | public Network getActiveNetworkForUid(int uid) { |
| 1348 | return getActiveNetworkForUid(uid, false); |
| 1349 | } |
| 1350 | |
| 1351 | /** {@hide} */ |
| 1352 | public Network getActiveNetworkForUid(int uid, boolean ignoreBlocked) { |
| 1353 | try { |
| 1354 | return mService.getActiveNetworkForUid(uid, ignoreBlocked); |
| 1355 | } catch (RemoteException e) { |
| 1356 | throw e.rethrowFromSystemServer(); |
| 1357 | } |
| 1358 | } |
| 1359 | |
| 1360 | /** |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 1361 | * Adds or removes a requirement for given UID ranges to use the VPN. |
| 1362 | * |
| 1363 | * If set to {@code true}, informs the system that the UIDs in the specified ranges must not |
| 1364 | * have any connectivity except if a VPN is connected and applies to the UIDs, or if the UIDs |
| 1365 | * otherwise have permission to bypass the VPN (e.g., because they have the |
| 1366 | * {@link android.Manifest.permission.CONNECTIVITY_USE_RESTRICTED_NETWORKS} permission, or when |
| 1367 | * using a socket protected by a method such as {@link VpnService#protect(DatagramSocket)}. If |
| 1368 | * set to {@code false}, a previously-added restriction is removed. |
| 1369 | * <p> |
| 1370 | * Each of the UID ranges specified by this method is added and removed as is, and no processing |
| 1371 | * is performed on the ranges to de-duplicate, merge, split, or intersect them. In order to |
| 1372 | * remove a previously-added range, the exact range must be removed as is. |
| 1373 | * <p> |
| 1374 | * The changes are applied asynchronously and may not have been applied by the time the method |
| 1375 | * returns. Apps will be notified about any changes that apply to them via |
| 1376 | * {@link NetworkCallback#onBlockedStatusChanged} callbacks called after the changes take |
| 1377 | * effect. |
| 1378 | * <p> |
| 1379 | * This method should be called only by the VPN code. |
| 1380 | * |
| 1381 | * @param ranges the UID ranges to restrict |
| 1382 | * @param requireVpn whether the specified UID ranges must use a VPN |
| 1383 | * |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 1384 | * @hide |
| 1385 | */ |
| 1386 | @RequiresPermission(anyOf = { |
| 1387 | NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK, |
lucaslin | 97fb10a | 2021-03-22 11:51:27 +0800 | [diff] [blame] | 1388 | android.Manifest.permission.NETWORK_STACK, |
| 1389 | android.Manifest.permission.NETWORK_SETTINGS}) |
| 1390 | @SystemApi(client = MODULE_LIBRARIES) |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 1391 | public void setRequireVpnForUids(boolean requireVpn, |
| 1392 | @NonNull Collection<Range<Integer>> ranges) { |
| 1393 | Objects.requireNonNull(ranges); |
| 1394 | // The Range class is not parcelable. Convert to UidRange, which is what is used internally. |
| 1395 | // This method is not necessarily expected to be used outside the system server, so |
| 1396 | // parceling may not be necessary, but it could be used out-of-process, e.g., by the network |
| 1397 | // stack process, or by tests. |
| 1398 | UidRange[] rangesArray = new UidRange[ranges.size()]; |
| 1399 | int index = 0; |
| 1400 | for (Range<Integer> range : ranges) { |
| 1401 | rangesArray[index++] = new UidRange(range.getLower(), range.getUpper()); |
| 1402 | } |
| 1403 | try { |
| 1404 | mService.setRequireVpnForUids(requireVpn, rangesArray); |
| 1405 | } catch (RemoteException e) { |
| 1406 | throw e.rethrowFromSystemServer(); |
| 1407 | } |
| 1408 | } |
| 1409 | |
| 1410 | /** |
Tommy Webb | 07c4656 | 2023-02-20 14:10:55 -0500 | [diff] [blame^] | 1411 | * Update ConnectivityService's map of UIDs to the transports they are allowed to use. |
| 1412 | * If a network has a transport type that is not an allowed type for the UID, the UID will |
| 1413 | * not be allowed to access that network. |
| 1414 | * |
| 1415 | * @param uids UIDs to update. |
| 1416 | * @param allowedTransportsPacked Corresponding bit-packed allowed transports to update. |
| 1417 | * |
| 1418 | * @hide |
| 1419 | */ |
| 1420 | @RequiresPermission(anyOf = { |
| 1421 | NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK, |
| 1422 | android.Manifest.permission.NETWORK_STACK, |
| 1423 | android.Manifest.permission.NETWORK_SETTINGS}) |
| 1424 | @SystemApi(client = MODULE_LIBRARIES) |
| 1425 | public void setUidsAllowedTransports(@NonNull final int[] uids, |
| 1426 | @NonNull final long[] allowedTransportsPacked) { |
| 1427 | Objects.requireNonNull(uids); |
| 1428 | Objects.requireNonNull(allowedTransportsPacked); |
| 1429 | if (uids.length != allowedTransportsPacked.length) { |
| 1430 | throw new IllegalArgumentException( |
| 1431 | "uids and allowedTransportsPacked must be equal length"); |
| 1432 | } |
| 1433 | try { |
| 1434 | mService.setUidsAllowedTransports(uids, allowedTransportsPacked); |
| 1435 | } catch (RemoteException e) { |
| 1436 | throw e.rethrowFromSystemServer(); |
| 1437 | } |
| 1438 | } |
| 1439 | |
| 1440 | /** |
Lorenzo Colitti | c71cff8 | 2021-01-15 01:29:01 +0900 | [diff] [blame] | 1441 | * Informs ConnectivityService of whether the legacy lockdown VPN, as implemented by |
| 1442 | * LockdownVpnTracker, is in use. This is deprecated for new devices starting from Android 12 |
| 1443 | * but is still supported for backwards compatibility. |
| 1444 | * <p> |
| 1445 | * This type of VPN is assumed always to use the system default network, and must always declare |
| 1446 | * exactly one underlying network, which is the network that was the default when the VPN |
| 1447 | * connected. |
| 1448 | * <p> |
| 1449 | * Calling this method with {@code true} enables legacy behaviour, specifically: |
| 1450 | * <ul> |
| 1451 | * <li>Any VPN that applies to userId 0 behaves specially with respect to deprecated |
| 1452 | * {@link #CONNECTIVITY_ACTION} broadcasts. Any such broadcasts will have the state in the |
| 1453 | * {@link #EXTRA_NETWORK_INFO} replaced by state of the VPN network. Also, any time the VPN |
| 1454 | * connects, a {@link #CONNECTIVITY_ACTION} broadcast will be sent for the network |
| 1455 | * underlying the VPN.</li> |
| 1456 | * <li>Deprecated APIs that return {@link NetworkInfo} objects will have their state |
| 1457 | * similarly replaced by the VPN network state.</li> |
| 1458 | * <li>Information on current network interfaces passed to NetworkStatsService will not |
| 1459 | * include any VPN interfaces.</li> |
| 1460 | * </ul> |
| 1461 | * |
| 1462 | * @param enabled whether legacy lockdown VPN is enabled or disabled |
| 1463 | * |
Lorenzo Colitti | c71cff8 | 2021-01-15 01:29:01 +0900 | [diff] [blame] | 1464 | * @hide |
| 1465 | */ |
| 1466 | @RequiresPermission(anyOf = { |
| 1467 | NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK, |
lucaslin | 97fb10a | 2021-03-22 11:51:27 +0800 | [diff] [blame] | 1468 | android.Manifest.permission.NETWORK_STACK, |
Lorenzo Colitti | c71cff8 | 2021-01-15 01:29:01 +0900 | [diff] [blame] | 1469 | android.Manifest.permission.NETWORK_SETTINGS}) |
lucaslin | 97fb10a | 2021-03-22 11:51:27 +0800 | [diff] [blame] | 1470 | @SystemApi(client = MODULE_LIBRARIES) |
Lorenzo Colitti | c71cff8 | 2021-01-15 01:29:01 +0900 | [diff] [blame] | 1471 | public void setLegacyLockdownVpnEnabled(boolean enabled) { |
| 1472 | try { |
| 1473 | mService.setLegacyLockdownVpnEnabled(enabled); |
| 1474 | } catch (RemoteException e) { |
| 1475 | throw e.rethrowFromSystemServer(); |
| 1476 | } |
| 1477 | } |
| 1478 | |
| 1479 | /** |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 1480 | * Returns details about the currently active default data network |
| 1481 | * for a given uid. This is for internal use only to avoid spying |
| 1482 | * other apps. |
| 1483 | * |
| 1484 | * @return a {@link NetworkInfo} object for the current default network |
| 1485 | * for the given uid or {@code null} if no default network is |
| 1486 | * available for the specified uid. |
| 1487 | * |
| 1488 | * {@hide} |
| 1489 | */ |
| 1490 | @RequiresPermission(android.Manifest.permission.NETWORK_STACK) |
| 1491 | @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553) |
| 1492 | public NetworkInfo getActiveNetworkInfoForUid(int uid) { |
| 1493 | return getActiveNetworkInfoForUid(uid, false); |
| 1494 | } |
| 1495 | |
| 1496 | /** {@hide} */ |
| 1497 | public NetworkInfo getActiveNetworkInfoForUid(int uid, boolean ignoreBlocked) { |
| 1498 | try { |
| 1499 | return mService.getActiveNetworkInfoForUid(uid, ignoreBlocked); |
| 1500 | } catch (RemoteException e) { |
| 1501 | throw e.rethrowFromSystemServer(); |
| 1502 | } |
| 1503 | } |
| 1504 | |
| 1505 | /** |
| 1506 | * Returns connection status information about a particular |
| 1507 | * network type. |
| 1508 | * |
| 1509 | * @param networkType integer specifying which networkType in |
| 1510 | * which you're interested. |
| 1511 | * @return a {@link NetworkInfo} object for the requested |
| 1512 | * network type or {@code null} if the type is not |
| 1513 | * supported by the device. If {@code networkType} is |
| 1514 | * TYPE_VPN and a VPN is active for the calling app, |
| 1515 | * then this method will try to return one of the |
| 1516 | * underlying networks for the VPN or null if the |
| 1517 | * VPN agent didn't specify any. |
| 1518 | * |
| 1519 | * @deprecated This method does not support multiple connected networks |
| 1520 | * of the same type. Use {@link #getAllNetworks} and |
| 1521 | * {@link #getNetworkInfo(android.net.Network)} instead. |
| 1522 | */ |
| 1523 | @Deprecated |
| 1524 | @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE) |
| 1525 | @Nullable |
| 1526 | public NetworkInfo getNetworkInfo(int networkType) { |
| 1527 | try { |
| 1528 | return mService.getNetworkInfo(networkType); |
| 1529 | } catch (RemoteException e) { |
| 1530 | throw e.rethrowFromSystemServer(); |
| 1531 | } |
| 1532 | } |
| 1533 | |
| 1534 | /** |
| 1535 | * Returns connection status information about a particular |
| 1536 | * Network. |
| 1537 | * |
| 1538 | * @param network {@link Network} specifying which network |
| 1539 | * in which you're interested. |
| 1540 | * @return a {@link NetworkInfo} object for the requested |
| 1541 | * network or {@code null} if the {@code Network} |
| 1542 | * is not valid. |
| 1543 | * @deprecated See {@link NetworkInfo}. |
| 1544 | */ |
| 1545 | @Deprecated |
| 1546 | @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE) |
| 1547 | @Nullable |
| 1548 | public NetworkInfo getNetworkInfo(@Nullable Network network) { |
| 1549 | return getNetworkInfoForUid(network, Process.myUid(), false); |
| 1550 | } |
| 1551 | |
| 1552 | /** {@hide} */ |
| 1553 | public NetworkInfo getNetworkInfoForUid(Network network, int uid, boolean ignoreBlocked) { |
| 1554 | try { |
| 1555 | return mService.getNetworkInfoForUid(network, uid, ignoreBlocked); |
| 1556 | } catch (RemoteException e) { |
| 1557 | throw e.rethrowFromSystemServer(); |
| 1558 | } |
| 1559 | } |
| 1560 | |
| 1561 | /** |
| 1562 | * Returns connection status information about all network |
| 1563 | * types supported by the device. |
| 1564 | * |
| 1565 | * @return an array of {@link NetworkInfo} objects. Check each |
| 1566 | * {@link NetworkInfo#getType} for which type each applies. |
| 1567 | * |
| 1568 | * @deprecated This method does not support multiple connected networks |
| 1569 | * of the same type. Use {@link #getAllNetworks} and |
| 1570 | * {@link #getNetworkInfo(android.net.Network)} instead. |
| 1571 | */ |
| 1572 | @Deprecated |
| 1573 | @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE) |
| 1574 | @NonNull |
| 1575 | public NetworkInfo[] getAllNetworkInfo() { |
| 1576 | try { |
| 1577 | return mService.getAllNetworkInfo(); |
| 1578 | } catch (RemoteException e) { |
| 1579 | throw e.rethrowFromSystemServer(); |
| 1580 | } |
| 1581 | } |
| 1582 | |
| 1583 | /** |
junyulai | b121137 | 2021-03-03 12:09:05 +0800 | [diff] [blame] | 1584 | * Return a list of {@link NetworkStateSnapshot}s, one for each network that is currently |
| 1585 | * connected. |
| 1586 | * @hide |
| 1587 | */ |
| 1588 | @SystemApi(client = MODULE_LIBRARIES) |
| 1589 | @RequiresPermission(anyOf = { |
| 1590 | NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK, |
| 1591 | android.Manifest.permission.NETWORK_STACK, |
| 1592 | android.Manifest.permission.NETWORK_SETTINGS}) |
| 1593 | @NonNull |
Aaron Huang | ab615e5 | 2021-04-17 13:46:25 +0800 | [diff] [blame] | 1594 | public List<NetworkStateSnapshot> getAllNetworkStateSnapshots() { |
junyulai | b121137 | 2021-03-03 12:09:05 +0800 | [diff] [blame] | 1595 | try { |
Aaron Huang | ab615e5 | 2021-04-17 13:46:25 +0800 | [diff] [blame] | 1596 | return mService.getAllNetworkStateSnapshots(); |
junyulai | b121137 | 2021-03-03 12:09:05 +0800 | [diff] [blame] | 1597 | } catch (RemoteException e) { |
| 1598 | throw e.rethrowFromSystemServer(); |
| 1599 | } |
| 1600 | } |
| 1601 | |
| 1602 | /** |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 1603 | * Returns the {@link Network} object currently serving a given type, or |
| 1604 | * null if the given type is not connected. |
| 1605 | * |
| 1606 | * @hide |
| 1607 | * @deprecated This method does not support multiple connected networks |
| 1608 | * of the same type. Use {@link #getAllNetworks} and |
| 1609 | * {@link #getNetworkInfo(android.net.Network)} instead. |
| 1610 | */ |
| 1611 | @Deprecated |
| 1612 | @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE) |
| 1613 | @UnsupportedAppUsage |
| 1614 | public Network getNetworkForType(int networkType) { |
| 1615 | try { |
| 1616 | return mService.getNetworkForType(networkType); |
| 1617 | } catch (RemoteException e) { |
| 1618 | throw e.rethrowFromSystemServer(); |
| 1619 | } |
| 1620 | } |
| 1621 | |
| 1622 | /** |
| 1623 | * Returns an array of all {@link Network} currently tracked by the |
| 1624 | * framework. |
| 1625 | * |
Lorenzo Colitti | 86714b1 | 2021-05-17 20:31:21 +0900 | [diff] [blame] | 1626 | * @deprecated This method does not provide any notification of network state changes, forcing |
| 1627 | * apps to call it repeatedly. This is inefficient and prone to race conditions. |
| 1628 | * Apps should use methods such as |
| 1629 | * {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)} instead. |
| 1630 | * Apps that desire to obtain information about networks that do not apply to them |
| 1631 | * can use {@link NetworkRequest.Builder#setIncludeOtherUidNetworks}. |
| 1632 | * |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 1633 | * @return an array of {@link Network} objects. |
| 1634 | */ |
| 1635 | @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE) |
| 1636 | @NonNull |
Lorenzo Colitti | 86714b1 | 2021-05-17 20:31:21 +0900 | [diff] [blame] | 1637 | @Deprecated |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 1638 | public Network[] getAllNetworks() { |
| 1639 | try { |
| 1640 | return mService.getAllNetworks(); |
| 1641 | } catch (RemoteException e) { |
| 1642 | throw e.rethrowFromSystemServer(); |
| 1643 | } |
| 1644 | } |
| 1645 | |
| 1646 | /** |
Roshan Pius | e08bc18 | 2020-12-22 15:10:42 -0800 | [diff] [blame] | 1647 | * Returns an array of {@link NetworkCapabilities} objects, representing |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 1648 | * the Networks that applications run by the given user will use by default. |
| 1649 | * @hide |
| 1650 | */ |
| 1651 | @UnsupportedAppUsage |
| 1652 | public NetworkCapabilities[] getDefaultNetworkCapabilitiesForUser(int userId) { |
| 1653 | try { |
| 1654 | return mService.getDefaultNetworkCapabilitiesForUser( |
Roshan Pius | a8a477b | 2020-12-17 14:53:09 -0800 | [diff] [blame] | 1655 | userId, mContext.getOpPackageName(), getAttributionTag()); |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 1656 | } catch (RemoteException e) { |
| 1657 | throw e.rethrowFromSystemServer(); |
| 1658 | } |
| 1659 | } |
| 1660 | |
| 1661 | /** |
| 1662 | * Returns the IP information for the current default network. |
| 1663 | * |
| 1664 | * @return a {@link LinkProperties} object describing the IP info |
| 1665 | * for the current default network, or {@code null} if there |
| 1666 | * is no current default network. |
| 1667 | * |
| 1668 | * {@hide} |
| 1669 | * @deprecated please use {@link #getLinkProperties(Network)} on the return |
| 1670 | * value of {@link #getActiveNetwork()} instead. In particular, |
| 1671 | * this method will return non-null LinkProperties even if the |
| 1672 | * app is blocked by policy from using this network. |
| 1673 | */ |
| 1674 | @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE) |
| 1675 | @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 109783091) |
| 1676 | public LinkProperties getActiveLinkProperties() { |
| 1677 | try { |
| 1678 | return mService.getActiveLinkProperties(); |
| 1679 | } catch (RemoteException e) { |
| 1680 | throw e.rethrowFromSystemServer(); |
| 1681 | } |
| 1682 | } |
| 1683 | |
| 1684 | /** |
| 1685 | * Returns the IP information for a given network type. |
| 1686 | * |
| 1687 | * @param networkType the network type of interest. |
| 1688 | * @return a {@link LinkProperties} object describing the IP info |
| 1689 | * for the given networkType, or {@code null} if there is |
| 1690 | * no current default network. |
| 1691 | * |
| 1692 | * {@hide} |
| 1693 | * @deprecated This method does not support multiple connected networks |
| 1694 | * of the same type. Use {@link #getAllNetworks}, |
| 1695 | * {@link #getNetworkInfo(android.net.Network)}, and |
| 1696 | * {@link #getLinkProperties(android.net.Network)} instead. |
| 1697 | */ |
| 1698 | @Deprecated |
| 1699 | @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE) |
| 1700 | @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 130143562) |
| 1701 | public LinkProperties getLinkProperties(int networkType) { |
| 1702 | try { |
| 1703 | return mService.getLinkPropertiesForType(networkType); |
| 1704 | } catch (RemoteException e) { |
| 1705 | throw e.rethrowFromSystemServer(); |
| 1706 | } |
| 1707 | } |
| 1708 | |
| 1709 | /** |
| 1710 | * Get the {@link LinkProperties} for the given {@link Network}. This |
| 1711 | * will return {@code null} if the network is unknown. |
| 1712 | * |
| 1713 | * @param network The {@link Network} object identifying the network in question. |
| 1714 | * @return The {@link LinkProperties} for the network, or {@code null}. |
| 1715 | */ |
| 1716 | @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE) |
| 1717 | @Nullable |
| 1718 | public LinkProperties getLinkProperties(@Nullable Network network) { |
| 1719 | try { |
| 1720 | return mService.getLinkProperties(network); |
| 1721 | } catch (RemoteException e) { |
| 1722 | throw e.rethrowFromSystemServer(); |
| 1723 | } |
| 1724 | } |
| 1725 | |
| 1726 | /** |
lucaslin | c582d50 | 2022-01-27 09:07:00 +0800 | [diff] [blame] | 1727 | * Redact {@link LinkProperties} for a given package |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 1728 | * |
lucaslin | c582d50 | 2022-01-27 09:07:00 +0800 | [diff] [blame] | 1729 | * Returns an instance of the given {@link LinkProperties} appropriately redacted to send to the |
| 1730 | * given package, considering its permissions. |
| 1731 | * |
| 1732 | * @param lp A {@link LinkProperties} which will be redacted. |
| 1733 | * @param uid The target uid. |
| 1734 | * @param packageName The name of the package, for appops logging. |
| 1735 | * @return A redacted {@link LinkProperties} which is appropriate to send to the given uid, |
| 1736 | * or null if the uid lacks the ACCESS_NETWORK_STATE permission. |
| 1737 | * @hide |
| 1738 | */ |
| 1739 | @RequiresPermission(anyOf = { |
| 1740 | NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK, |
| 1741 | android.Manifest.permission.NETWORK_STACK, |
| 1742 | android.Manifest.permission.NETWORK_SETTINGS}) |
| 1743 | @SystemApi(client = MODULE_LIBRARIES) |
| 1744 | @Nullable |
lucaslin | d2b0613 | 2022-03-02 10:56:57 +0800 | [diff] [blame] | 1745 | public LinkProperties getRedactedLinkPropertiesForPackage(@NonNull LinkProperties lp, int uid, |
lucaslin | c582d50 | 2022-01-27 09:07:00 +0800 | [diff] [blame] | 1746 | @NonNull String packageName) { |
| 1747 | try { |
lucaslin | d2b0613 | 2022-03-02 10:56:57 +0800 | [diff] [blame] | 1748 | return mService.getRedactedLinkPropertiesForPackage( |
lucaslin | c582d50 | 2022-01-27 09:07:00 +0800 | [diff] [blame] | 1749 | lp, uid, packageName, getAttributionTag()); |
| 1750 | } catch (RemoteException e) { |
| 1751 | throw e.rethrowFromSystemServer(); |
| 1752 | } |
| 1753 | } |
| 1754 | |
| 1755 | /** |
| 1756 | * Get the {@link NetworkCapabilities} for the given {@link Network}, or null. |
| 1757 | * |
| 1758 | * This will remove any location sensitive data in the returned {@link NetworkCapabilities}. |
| 1759 | * Some {@link TransportInfo} instances like {@link android.net.wifi.WifiInfo} contain location |
| 1760 | * sensitive information. To retrieve this location sensitive information (subject to |
| 1761 | * the caller's location permissions), use a {@link NetworkCallback} with the |
| 1762 | * {@link NetworkCallback#FLAG_INCLUDE_LOCATION_INFO} flag instead. |
| 1763 | * |
| 1764 | * This method returns {@code null} if the network is unknown or if the |network| argument |
| 1765 | * is null. |
Roshan Pius | e08bc18 | 2020-12-22 15:10:42 -0800 | [diff] [blame] | 1766 | * |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 1767 | * @param network The {@link Network} object identifying the network in question. |
Roshan Pius | e08bc18 | 2020-12-22 15:10:42 -0800 | [diff] [blame] | 1768 | * @return The {@link NetworkCapabilities} for the network, or {@code null}. |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 1769 | */ |
| 1770 | @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE) |
| 1771 | @Nullable |
| 1772 | public NetworkCapabilities getNetworkCapabilities(@Nullable Network network) { |
| 1773 | try { |
Roshan Pius | a8a477b | 2020-12-17 14:53:09 -0800 | [diff] [blame] | 1774 | return mService.getNetworkCapabilities( |
| 1775 | network, mContext.getOpPackageName(), getAttributionTag()); |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 1776 | } catch (RemoteException e) { |
| 1777 | throw e.rethrowFromSystemServer(); |
| 1778 | } |
| 1779 | } |
| 1780 | |
| 1781 | /** |
lucaslin | c582d50 | 2022-01-27 09:07:00 +0800 | [diff] [blame] | 1782 | * Redact {@link NetworkCapabilities} for a given package. |
| 1783 | * |
| 1784 | * Returns an instance of {@link NetworkCapabilities} that is appropriately redacted to send |
lucaslin | d2b0613 | 2022-03-02 10:56:57 +0800 | [diff] [blame] | 1785 | * to the given package, considering its permissions. If the passed capabilities contain |
| 1786 | * location-sensitive information, they will be redacted to the correct degree for the location |
| 1787 | * permissions of the app (COARSE or FINE), and will blame the UID accordingly for retrieving |
| 1788 | * that level of location. If the UID holds no location permission, the returned object will |
| 1789 | * contain no location-sensitive information and the UID is not blamed. |
lucaslin | c582d50 | 2022-01-27 09:07:00 +0800 | [diff] [blame] | 1790 | * |
| 1791 | * @param nc A {@link NetworkCapabilities} instance which will be redacted. |
| 1792 | * @param uid The target uid. |
| 1793 | * @param packageName The name of the package, for appops logging. |
| 1794 | * @return A redacted {@link NetworkCapabilities} which is appropriate to send to the given uid, |
| 1795 | * or null if the uid lacks the ACCESS_NETWORK_STATE permission. |
| 1796 | * @hide |
| 1797 | */ |
| 1798 | @RequiresPermission(anyOf = { |
| 1799 | NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK, |
| 1800 | android.Manifest.permission.NETWORK_STACK, |
| 1801 | android.Manifest.permission.NETWORK_SETTINGS}) |
| 1802 | @SystemApi(client = MODULE_LIBRARIES) |
| 1803 | @Nullable |
lucaslin | d2b0613 | 2022-03-02 10:56:57 +0800 | [diff] [blame] | 1804 | public NetworkCapabilities getRedactedNetworkCapabilitiesForPackage( |
lucaslin | c582d50 | 2022-01-27 09:07:00 +0800 | [diff] [blame] | 1805 | @NonNull NetworkCapabilities nc, |
| 1806 | int uid, @NonNull String packageName) { |
| 1807 | try { |
lucaslin | d2b0613 | 2022-03-02 10:56:57 +0800 | [diff] [blame] | 1808 | return mService.getRedactedNetworkCapabilitiesForPackage(nc, uid, packageName, |
lucaslin | c582d50 | 2022-01-27 09:07:00 +0800 | [diff] [blame] | 1809 | getAttributionTag()); |
| 1810 | } catch (RemoteException e) { |
| 1811 | throw e.rethrowFromSystemServer(); |
| 1812 | } |
| 1813 | } |
| 1814 | |
| 1815 | /** |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 1816 | * Gets a URL that can be used for resolving whether a captive portal is present. |
| 1817 | * 1. This URL should respond with a 204 response to a GET request to indicate no captive |
| 1818 | * portal is present. |
| 1819 | * 2. This URL must be HTTP as redirect responses are used to find captive portal |
| 1820 | * sign-in pages. Captive portals cannot respond to HTTPS requests with redirects. |
| 1821 | * |
| 1822 | * The system network validation may be using different strategies to detect captive portals, |
| 1823 | * so this method does not necessarily return a URL used by the system. It only returns a URL |
| 1824 | * that may be relevant for other components trying to detect captive portals. |
| 1825 | * |
| 1826 | * @hide |
| 1827 | * @deprecated This API returns URL which is not guaranteed to be one of the URLs used by the |
| 1828 | * system. |
| 1829 | */ |
| 1830 | @Deprecated |
| 1831 | @SystemApi |
| 1832 | @RequiresPermission(android.Manifest.permission.NETWORK_SETTINGS) |
| 1833 | public String getCaptivePortalServerUrl() { |
| 1834 | try { |
| 1835 | return mService.getCaptivePortalServerUrl(); |
| 1836 | } catch (RemoteException e) { |
| 1837 | throw e.rethrowFromSystemServer(); |
| 1838 | } |
| 1839 | } |
| 1840 | |
| 1841 | /** |
| 1842 | * Tells the underlying networking system that the caller wants to |
| 1843 | * begin using the named feature. The interpretation of {@code feature} |
| 1844 | * is completely up to each networking implementation. |
| 1845 | * |
| 1846 | * <p>This method requires the caller to hold either the |
| 1847 | * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission |
| 1848 | * or the ability to modify system settings as determined by |
| 1849 | * {@link android.provider.Settings.System#canWrite}.</p> |
| 1850 | * |
| 1851 | * @param networkType specifies which network the request pertains to |
| 1852 | * @param feature the name of the feature to be used |
| 1853 | * @return an integer value representing the outcome of the request. |
| 1854 | * The interpretation of this value is specific to each networking |
| 1855 | * implementation+feature combination, except that the value {@code -1} |
| 1856 | * always indicates failure. |
| 1857 | * |
| 1858 | * @deprecated Deprecated in favor of the cleaner |
| 1859 | * {@link #requestNetwork(NetworkRequest, NetworkCallback)} API. |
| 1860 | * In {@link VERSION_CODES#M}, and above, this method is unsupported and will |
| 1861 | * throw {@code UnsupportedOperationException} if called. |
| 1862 | * @removed |
| 1863 | */ |
| 1864 | @Deprecated |
| 1865 | public int startUsingNetworkFeature(int networkType, String feature) { |
| 1866 | checkLegacyRoutingApiAccess(); |
| 1867 | NetworkCapabilities netCap = networkCapabilitiesForFeature(networkType, feature); |
| 1868 | if (netCap == null) { |
| 1869 | Log.d(TAG, "Can't satisfy startUsingNetworkFeature for " + networkType + ", " + |
| 1870 | feature); |
| 1871 | return DEPRECATED_PHONE_CONSTANT_APN_REQUEST_FAILED; |
| 1872 | } |
| 1873 | |
| 1874 | NetworkRequest request = null; |
| 1875 | synchronized (sLegacyRequests) { |
| 1876 | LegacyRequest l = sLegacyRequests.get(netCap); |
| 1877 | if (l != null) { |
| 1878 | Log.d(TAG, "renewing startUsingNetworkFeature request " + l.networkRequest); |
| 1879 | renewRequestLocked(l); |
| 1880 | if (l.currentNetwork != null) { |
| 1881 | return DEPRECATED_PHONE_CONSTANT_APN_ALREADY_ACTIVE; |
| 1882 | } else { |
| 1883 | return DEPRECATED_PHONE_CONSTANT_APN_REQUEST_STARTED; |
| 1884 | } |
| 1885 | } |
| 1886 | |
| 1887 | request = requestNetworkForFeatureLocked(netCap); |
| 1888 | } |
| 1889 | if (request != null) { |
| 1890 | Log.d(TAG, "starting startUsingNetworkFeature for request " + request); |
| 1891 | return DEPRECATED_PHONE_CONSTANT_APN_REQUEST_STARTED; |
| 1892 | } else { |
| 1893 | Log.d(TAG, " request Failed"); |
| 1894 | return DEPRECATED_PHONE_CONSTANT_APN_REQUEST_FAILED; |
| 1895 | } |
| 1896 | } |
| 1897 | |
| 1898 | /** |
| 1899 | * Tells the underlying networking system that the caller is finished |
| 1900 | * using the named feature. The interpretation of {@code feature} |
| 1901 | * is completely up to each networking implementation. |
| 1902 | * |
| 1903 | * <p>This method requires the caller to hold either the |
| 1904 | * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission |
| 1905 | * or the ability to modify system settings as determined by |
| 1906 | * {@link android.provider.Settings.System#canWrite}.</p> |
| 1907 | * |
| 1908 | * @param networkType specifies which network the request pertains to |
| 1909 | * @param feature the name of the feature that is no longer needed |
| 1910 | * @return an integer value representing the outcome of the request. |
| 1911 | * The interpretation of this value is specific to each networking |
| 1912 | * implementation+feature combination, except that the value {@code -1} |
| 1913 | * always indicates failure. |
| 1914 | * |
| 1915 | * @deprecated Deprecated in favor of the cleaner |
| 1916 | * {@link #unregisterNetworkCallback(NetworkCallback)} API. |
| 1917 | * In {@link VERSION_CODES#M}, and above, this method is unsupported and will |
| 1918 | * throw {@code UnsupportedOperationException} if called. |
| 1919 | * @removed |
| 1920 | */ |
| 1921 | @Deprecated |
| 1922 | public int stopUsingNetworkFeature(int networkType, String feature) { |
| 1923 | checkLegacyRoutingApiAccess(); |
| 1924 | NetworkCapabilities netCap = networkCapabilitiesForFeature(networkType, feature); |
| 1925 | if (netCap == null) { |
| 1926 | Log.d(TAG, "Can't satisfy stopUsingNetworkFeature for " + networkType + ", " + |
| 1927 | feature); |
| 1928 | return -1; |
| 1929 | } |
| 1930 | |
| 1931 | if (removeRequestForFeature(netCap)) { |
| 1932 | Log.d(TAG, "stopUsingNetworkFeature for " + networkType + ", " + feature); |
| 1933 | } |
| 1934 | return 1; |
| 1935 | } |
| 1936 | |
| 1937 | @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553) |
| 1938 | private NetworkCapabilities networkCapabilitiesForFeature(int networkType, String feature) { |
| 1939 | if (networkType == TYPE_MOBILE) { |
| 1940 | switch (feature) { |
| 1941 | case "enableCBS": |
| 1942 | return networkCapabilitiesForType(TYPE_MOBILE_CBS); |
| 1943 | case "enableDUN": |
| 1944 | case "enableDUNAlways": |
| 1945 | return networkCapabilitiesForType(TYPE_MOBILE_DUN); |
| 1946 | case "enableFOTA": |
| 1947 | return networkCapabilitiesForType(TYPE_MOBILE_FOTA); |
| 1948 | case "enableHIPRI": |
| 1949 | return networkCapabilitiesForType(TYPE_MOBILE_HIPRI); |
| 1950 | case "enableIMS": |
| 1951 | return networkCapabilitiesForType(TYPE_MOBILE_IMS); |
| 1952 | case "enableMMS": |
| 1953 | return networkCapabilitiesForType(TYPE_MOBILE_MMS); |
| 1954 | case "enableSUPL": |
| 1955 | return networkCapabilitiesForType(TYPE_MOBILE_SUPL); |
| 1956 | default: |
| 1957 | return null; |
| 1958 | } |
| 1959 | } else if (networkType == TYPE_WIFI && "p2p".equals(feature)) { |
| 1960 | return networkCapabilitiesForType(TYPE_WIFI_P2P); |
| 1961 | } |
| 1962 | return null; |
| 1963 | } |
| 1964 | |
| 1965 | private int legacyTypeForNetworkCapabilities(NetworkCapabilities netCap) { |
| 1966 | if (netCap == null) return TYPE_NONE; |
| 1967 | if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_CBS)) { |
| 1968 | return TYPE_MOBILE_CBS; |
| 1969 | } |
| 1970 | if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_IMS)) { |
| 1971 | return TYPE_MOBILE_IMS; |
| 1972 | } |
| 1973 | if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_FOTA)) { |
| 1974 | return TYPE_MOBILE_FOTA; |
| 1975 | } |
| 1976 | if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_DUN)) { |
| 1977 | return TYPE_MOBILE_DUN; |
| 1978 | } |
| 1979 | if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_SUPL)) { |
| 1980 | return TYPE_MOBILE_SUPL; |
| 1981 | } |
| 1982 | if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_MMS)) { |
| 1983 | return TYPE_MOBILE_MMS; |
| 1984 | } |
| 1985 | if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_INTERNET)) { |
| 1986 | return TYPE_MOBILE_HIPRI; |
| 1987 | } |
| 1988 | if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_WIFI_P2P)) { |
| 1989 | return TYPE_WIFI_P2P; |
| 1990 | } |
| 1991 | return TYPE_NONE; |
| 1992 | } |
| 1993 | |
| 1994 | private static class LegacyRequest { |
| 1995 | NetworkCapabilities networkCapabilities; |
| 1996 | NetworkRequest networkRequest; |
| 1997 | int expireSequenceNumber; |
| 1998 | Network currentNetwork; |
| 1999 | int delay = -1; |
| 2000 | |
| 2001 | private void clearDnsBinding() { |
| 2002 | if (currentNetwork != null) { |
| 2003 | currentNetwork = null; |
| 2004 | setProcessDefaultNetworkForHostResolution(null); |
| 2005 | } |
| 2006 | } |
| 2007 | |
| 2008 | NetworkCallback networkCallback = new NetworkCallback() { |
| 2009 | @Override |
| 2010 | public void onAvailable(Network network) { |
| 2011 | currentNetwork = network; |
| 2012 | Log.d(TAG, "startUsingNetworkFeature got Network:" + network); |
| 2013 | setProcessDefaultNetworkForHostResolution(network); |
| 2014 | } |
| 2015 | @Override |
| 2016 | public void onLost(Network network) { |
| 2017 | if (network.equals(currentNetwork)) clearDnsBinding(); |
| 2018 | Log.d(TAG, "startUsingNetworkFeature lost Network:" + network); |
| 2019 | } |
| 2020 | }; |
| 2021 | } |
| 2022 | |
| 2023 | @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553) |
| 2024 | private static final HashMap<NetworkCapabilities, LegacyRequest> sLegacyRequests = |
| 2025 | new HashMap<>(); |
| 2026 | |
| 2027 | private NetworkRequest findRequestForFeature(NetworkCapabilities netCap) { |
| 2028 | synchronized (sLegacyRequests) { |
| 2029 | LegacyRequest l = sLegacyRequests.get(netCap); |
| 2030 | if (l != null) return l.networkRequest; |
| 2031 | } |
| 2032 | return null; |
| 2033 | } |
| 2034 | |
| 2035 | private void renewRequestLocked(LegacyRequest l) { |
| 2036 | l.expireSequenceNumber++; |
| 2037 | Log.d(TAG, "renewing request to seqNum " + l.expireSequenceNumber); |
| 2038 | sendExpireMsgForFeature(l.networkCapabilities, l.expireSequenceNumber, l.delay); |
| 2039 | } |
| 2040 | |
| 2041 | private void expireRequest(NetworkCapabilities netCap, int sequenceNum) { |
| 2042 | int ourSeqNum = -1; |
| 2043 | synchronized (sLegacyRequests) { |
| 2044 | LegacyRequest l = sLegacyRequests.get(netCap); |
| 2045 | if (l == null) return; |
| 2046 | ourSeqNum = l.expireSequenceNumber; |
| 2047 | if (l.expireSequenceNumber == sequenceNum) removeRequestForFeature(netCap); |
| 2048 | } |
| 2049 | Log.d(TAG, "expireRequest with " + ourSeqNum + ", " + sequenceNum); |
| 2050 | } |
| 2051 | |
| 2052 | @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553) |
| 2053 | private NetworkRequest requestNetworkForFeatureLocked(NetworkCapabilities netCap) { |
| 2054 | int delay = -1; |
| 2055 | int type = legacyTypeForNetworkCapabilities(netCap); |
| 2056 | try { |
| 2057 | delay = mService.getRestoreDefaultNetworkDelay(type); |
| 2058 | } catch (RemoteException e) { |
| 2059 | throw e.rethrowFromSystemServer(); |
| 2060 | } |
| 2061 | LegacyRequest l = new LegacyRequest(); |
| 2062 | l.networkCapabilities = netCap; |
| 2063 | l.delay = delay; |
| 2064 | l.expireSequenceNumber = 0; |
| 2065 | l.networkRequest = sendRequestForNetwork( |
| 2066 | netCap, l.networkCallback, 0, REQUEST, type, getDefaultHandler()); |
| 2067 | if (l.networkRequest == null) return null; |
| 2068 | sLegacyRequests.put(netCap, l); |
| 2069 | sendExpireMsgForFeature(netCap, l.expireSequenceNumber, delay); |
| 2070 | return l.networkRequest; |
| 2071 | } |
| 2072 | |
| 2073 | private void sendExpireMsgForFeature(NetworkCapabilities netCap, int seqNum, int delay) { |
| 2074 | if (delay >= 0) { |
| 2075 | Log.d(TAG, "sending expire msg with seqNum " + seqNum + " and delay " + delay); |
| 2076 | CallbackHandler handler = getDefaultHandler(); |
| 2077 | Message msg = handler.obtainMessage(EXPIRE_LEGACY_REQUEST, seqNum, 0, netCap); |
| 2078 | handler.sendMessageDelayed(msg, delay); |
| 2079 | } |
| 2080 | } |
| 2081 | |
| 2082 | @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553) |
| 2083 | private boolean removeRequestForFeature(NetworkCapabilities netCap) { |
| 2084 | final LegacyRequest l; |
| 2085 | synchronized (sLegacyRequests) { |
| 2086 | l = sLegacyRequests.remove(netCap); |
| 2087 | } |
| 2088 | if (l == null) return false; |
| 2089 | unregisterNetworkCallback(l.networkCallback); |
| 2090 | l.clearDnsBinding(); |
| 2091 | return true; |
| 2092 | } |
| 2093 | |
| 2094 | private static final SparseIntArray sLegacyTypeToTransport = new SparseIntArray(); |
| 2095 | static { |
| 2096 | sLegacyTypeToTransport.put(TYPE_MOBILE, NetworkCapabilities.TRANSPORT_CELLULAR); |
| 2097 | sLegacyTypeToTransport.put(TYPE_MOBILE_CBS, NetworkCapabilities.TRANSPORT_CELLULAR); |
| 2098 | sLegacyTypeToTransport.put(TYPE_MOBILE_DUN, NetworkCapabilities.TRANSPORT_CELLULAR); |
| 2099 | sLegacyTypeToTransport.put(TYPE_MOBILE_FOTA, NetworkCapabilities.TRANSPORT_CELLULAR); |
| 2100 | sLegacyTypeToTransport.put(TYPE_MOBILE_HIPRI, NetworkCapabilities.TRANSPORT_CELLULAR); |
| 2101 | sLegacyTypeToTransport.put(TYPE_MOBILE_IMS, NetworkCapabilities.TRANSPORT_CELLULAR); |
| 2102 | sLegacyTypeToTransport.put(TYPE_MOBILE_MMS, NetworkCapabilities.TRANSPORT_CELLULAR); |
| 2103 | sLegacyTypeToTransport.put(TYPE_MOBILE_SUPL, NetworkCapabilities.TRANSPORT_CELLULAR); |
| 2104 | sLegacyTypeToTransport.put(TYPE_WIFI, NetworkCapabilities.TRANSPORT_WIFI); |
| 2105 | sLegacyTypeToTransport.put(TYPE_WIFI_P2P, NetworkCapabilities.TRANSPORT_WIFI); |
| 2106 | sLegacyTypeToTransport.put(TYPE_BLUETOOTH, NetworkCapabilities.TRANSPORT_BLUETOOTH); |
| 2107 | sLegacyTypeToTransport.put(TYPE_ETHERNET, NetworkCapabilities.TRANSPORT_ETHERNET); |
| 2108 | } |
| 2109 | |
| 2110 | private static final SparseIntArray sLegacyTypeToCapability = new SparseIntArray(); |
| 2111 | static { |
| 2112 | sLegacyTypeToCapability.put(TYPE_MOBILE_CBS, NetworkCapabilities.NET_CAPABILITY_CBS); |
| 2113 | sLegacyTypeToCapability.put(TYPE_MOBILE_DUN, NetworkCapabilities.NET_CAPABILITY_DUN); |
| 2114 | sLegacyTypeToCapability.put(TYPE_MOBILE_FOTA, NetworkCapabilities.NET_CAPABILITY_FOTA); |
| 2115 | sLegacyTypeToCapability.put(TYPE_MOBILE_IMS, NetworkCapabilities.NET_CAPABILITY_IMS); |
| 2116 | sLegacyTypeToCapability.put(TYPE_MOBILE_MMS, NetworkCapabilities.NET_CAPABILITY_MMS); |
| 2117 | sLegacyTypeToCapability.put(TYPE_MOBILE_SUPL, NetworkCapabilities.NET_CAPABILITY_SUPL); |
| 2118 | sLegacyTypeToCapability.put(TYPE_WIFI_P2P, NetworkCapabilities.NET_CAPABILITY_WIFI_P2P); |
| 2119 | } |
| 2120 | |
| 2121 | /** |
| 2122 | * Given a legacy type (TYPE_WIFI, ...) returns a NetworkCapabilities |
| 2123 | * instance suitable for registering a request or callback. Throws an |
| 2124 | * IllegalArgumentException if no mapping from the legacy type to |
| 2125 | * NetworkCapabilities is known. |
| 2126 | * |
| 2127 | * @deprecated Types are deprecated. Use {@link NetworkCallback} or {@link NetworkRequest} |
| 2128 | * to find the network instead. |
| 2129 | * @hide |
| 2130 | */ |
| 2131 | public static NetworkCapabilities networkCapabilitiesForType(int type) { |
| 2132 | final NetworkCapabilities nc = new NetworkCapabilities(); |
| 2133 | |
| 2134 | // Map from type to transports. |
| 2135 | final int NOT_FOUND = -1; |
| 2136 | final int transport = sLegacyTypeToTransport.get(type, NOT_FOUND); |
Remi NGUYEN VAN | 1818dbb | 2021-03-15 07:31:54 +0000 | [diff] [blame] | 2137 | if (transport == NOT_FOUND) { |
| 2138 | throw new IllegalArgumentException("unknown legacy type: " + type); |
| 2139 | } |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 2140 | nc.addTransportType(transport); |
| 2141 | |
| 2142 | // Map from type to capabilities. |
| 2143 | nc.addCapability(sLegacyTypeToCapability.get( |
| 2144 | type, NetworkCapabilities.NET_CAPABILITY_INTERNET)); |
| 2145 | nc.maybeMarkCapabilitiesRestricted(); |
| 2146 | return nc; |
| 2147 | } |
| 2148 | |
| 2149 | /** @hide */ |
| 2150 | public static class PacketKeepaliveCallback { |
| 2151 | @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553) |
| 2152 | public PacketKeepaliveCallback() { |
| 2153 | } |
| 2154 | /** The requested keepalive was successfully started. */ |
| 2155 | @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553) |
| 2156 | public void onStarted() {} |
| 2157 | /** The keepalive was successfully stopped. */ |
| 2158 | @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553) |
| 2159 | public void onStopped() {} |
| 2160 | /** An error occurred. */ |
| 2161 | @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553) |
| 2162 | public void onError(int error) {} |
| 2163 | } |
| 2164 | |
| 2165 | /** |
| 2166 | * Allows applications to request that the system periodically send specific packets on their |
| 2167 | * behalf, using hardware offload to save battery power. |
| 2168 | * |
| 2169 | * To request that the system send keepalives, call one of the methods that return a |
| 2170 | * {@link ConnectivityManager.PacketKeepalive} object, such as {@link #startNattKeepalive}, |
| 2171 | * passing in a non-null callback. If the callback is successfully started, the callback's |
| 2172 | * {@code onStarted} method will be called. If an error occurs, {@code onError} will be called, |
| 2173 | * specifying one of the {@code ERROR_*} constants in this class. |
| 2174 | * |
| 2175 | * To stop an existing keepalive, call {@link PacketKeepalive#stop}. The system will call |
| 2176 | * {@link PacketKeepaliveCallback#onStopped} if the operation was successful or |
| 2177 | * {@link PacketKeepaliveCallback#onError} if an error occurred. |
| 2178 | * |
| 2179 | * @deprecated Use {@link SocketKeepalive} instead. |
| 2180 | * |
| 2181 | * @hide |
| 2182 | */ |
| 2183 | public class PacketKeepalive { |
| 2184 | |
| 2185 | private static final String TAG = "PacketKeepalive"; |
| 2186 | |
| 2187 | /** @hide */ |
| 2188 | public static final int SUCCESS = 0; |
| 2189 | |
| 2190 | /** @hide */ |
| 2191 | public static final int NO_KEEPALIVE = -1; |
| 2192 | |
| 2193 | /** @hide */ |
| 2194 | public static final int BINDER_DIED = -10; |
| 2195 | |
| 2196 | /** The specified {@code Network} is not connected. */ |
| 2197 | public static final int ERROR_INVALID_NETWORK = -20; |
| 2198 | /** The specified IP addresses are invalid. For example, the specified source IP address is |
| 2199 | * not configured on the specified {@code Network}. */ |
| 2200 | public static final int ERROR_INVALID_IP_ADDRESS = -21; |
| 2201 | /** The requested port is invalid. */ |
| 2202 | public static final int ERROR_INVALID_PORT = -22; |
| 2203 | /** The packet length is invalid (e.g., too long). */ |
| 2204 | public static final int ERROR_INVALID_LENGTH = -23; |
| 2205 | /** The packet transmission interval is invalid (e.g., too short). */ |
| 2206 | public static final int ERROR_INVALID_INTERVAL = -24; |
| 2207 | |
| 2208 | /** The hardware does not support this request. */ |
| 2209 | public static final int ERROR_HARDWARE_UNSUPPORTED = -30; |
| 2210 | /** The hardware returned an error. */ |
| 2211 | public static final int ERROR_HARDWARE_ERROR = -31; |
| 2212 | |
| 2213 | /** The NAT-T destination port for IPsec */ |
| 2214 | public static final int NATT_PORT = 4500; |
| 2215 | |
| 2216 | /** The minimum interval in seconds between keepalive packet transmissions */ |
| 2217 | public static final int MIN_INTERVAL = 10; |
| 2218 | |
| 2219 | private final Network mNetwork; |
| 2220 | private final ISocketKeepaliveCallback mCallback; |
| 2221 | private final ExecutorService mExecutor; |
| 2222 | |
| 2223 | private volatile Integer mSlot; |
| 2224 | |
| 2225 | @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553) |
| 2226 | public void stop() { |
| 2227 | try { |
| 2228 | mExecutor.execute(() -> { |
| 2229 | try { |
| 2230 | if (mSlot != null) { |
| 2231 | mService.stopKeepalive(mNetwork, mSlot); |
| 2232 | } |
| 2233 | } catch (RemoteException e) { |
| 2234 | Log.e(TAG, "Error stopping packet keepalive: ", e); |
| 2235 | throw e.rethrowFromSystemServer(); |
| 2236 | } |
| 2237 | }); |
| 2238 | } catch (RejectedExecutionException e) { |
| 2239 | // The internal executor has already stopped due to previous event. |
| 2240 | } |
| 2241 | } |
| 2242 | |
| 2243 | private PacketKeepalive(Network network, PacketKeepaliveCallback callback) { |
Remi NGUYEN VAN | 1818dbb | 2021-03-15 07:31:54 +0000 | [diff] [blame] | 2244 | Objects.requireNonNull(network, "network cannot be null"); |
| 2245 | Objects.requireNonNull(callback, "callback cannot be null"); |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 2246 | mNetwork = network; |
| 2247 | mExecutor = Executors.newSingleThreadExecutor(); |
| 2248 | mCallback = new ISocketKeepaliveCallback.Stub() { |
| 2249 | @Override |
| 2250 | public void onStarted(int slot) { |
| 2251 | final long token = Binder.clearCallingIdentity(); |
| 2252 | try { |
| 2253 | mExecutor.execute(() -> { |
| 2254 | mSlot = slot; |
| 2255 | callback.onStarted(); |
| 2256 | }); |
| 2257 | } finally { |
| 2258 | Binder.restoreCallingIdentity(token); |
| 2259 | } |
| 2260 | } |
| 2261 | |
| 2262 | @Override |
| 2263 | public void onStopped() { |
| 2264 | final long token = Binder.clearCallingIdentity(); |
| 2265 | try { |
| 2266 | mExecutor.execute(() -> { |
| 2267 | mSlot = null; |
| 2268 | callback.onStopped(); |
| 2269 | }); |
| 2270 | } finally { |
| 2271 | Binder.restoreCallingIdentity(token); |
| 2272 | } |
| 2273 | mExecutor.shutdown(); |
| 2274 | } |
| 2275 | |
| 2276 | @Override |
| 2277 | public void onError(int error) { |
| 2278 | final long token = Binder.clearCallingIdentity(); |
| 2279 | try { |
| 2280 | mExecutor.execute(() -> { |
| 2281 | mSlot = null; |
| 2282 | callback.onError(error); |
| 2283 | }); |
| 2284 | } finally { |
| 2285 | Binder.restoreCallingIdentity(token); |
| 2286 | } |
| 2287 | mExecutor.shutdown(); |
| 2288 | } |
| 2289 | |
| 2290 | @Override |
| 2291 | public void onDataReceived() { |
| 2292 | // PacketKeepalive is only used for Nat-T keepalive and as such does not invoke |
| 2293 | // this callback when data is received. |
| 2294 | } |
| 2295 | }; |
| 2296 | } |
| 2297 | } |
| 2298 | |
| 2299 | /** |
| 2300 | * Starts an IPsec NAT-T keepalive packet with the specified parameters. |
| 2301 | * |
| 2302 | * @deprecated Use {@link #createSocketKeepalive} instead. |
| 2303 | * |
| 2304 | * @hide |
| 2305 | */ |
| 2306 | @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553) |
| 2307 | public PacketKeepalive startNattKeepalive( |
| 2308 | Network network, int intervalSeconds, PacketKeepaliveCallback callback, |
| 2309 | InetAddress srcAddr, int srcPort, InetAddress dstAddr) { |
| 2310 | final PacketKeepalive k = new PacketKeepalive(network, callback); |
| 2311 | try { |
| 2312 | mService.startNattKeepalive(network, intervalSeconds, k.mCallback, |
| 2313 | srcAddr.getHostAddress(), srcPort, dstAddr.getHostAddress()); |
| 2314 | } catch (RemoteException e) { |
| 2315 | Log.e(TAG, "Error starting packet keepalive: ", e); |
| 2316 | throw e.rethrowFromSystemServer(); |
| 2317 | } |
| 2318 | return k; |
| 2319 | } |
| 2320 | |
| 2321 | // Construct an invalid fd. |
| 2322 | private ParcelFileDescriptor createInvalidFd() { |
| 2323 | final int invalidFd = -1; |
| 2324 | return ParcelFileDescriptor.adoptFd(invalidFd); |
| 2325 | } |
| 2326 | |
| 2327 | /** |
| 2328 | * Request that keepalives be started on a IPsec NAT-T socket. |
| 2329 | * |
| 2330 | * @param network The {@link Network} the socket is on. |
| 2331 | * @param socket The socket that needs to be kept alive. |
| 2332 | * @param source The source address of the {@link UdpEncapsulationSocket}. |
| 2333 | * @param destination The destination address of the {@link UdpEncapsulationSocket}. |
| 2334 | * @param executor The executor on which callback will be invoked. The provided {@link Executor} |
| 2335 | * must run callback sequentially, otherwise the order of callbacks cannot be |
| 2336 | * guaranteed. |
| 2337 | * @param callback A {@link SocketKeepalive.Callback}. Used for notifications about keepalive |
| 2338 | * changes. Must be extended by applications that use this API. |
| 2339 | * |
| 2340 | * @return A {@link SocketKeepalive} object that can be used to control the keepalive on the |
| 2341 | * given socket. |
| 2342 | **/ |
| 2343 | public @NonNull SocketKeepalive createSocketKeepalive(@NonNull Network network, |
| 2344 | @NonNull UdpEncapsulationSocket socket, |
| 2345 | @NonNull InetAddress source, |
| 2346 | @NonNull InetAddress destination, |
| 2347 | @NonNull @CallbackExecutor Executor executor, |
| 2348 | @NonNull Callback callback) { |
| 2349 | ParcelFileDescriptor dup; |
| 2350 | try { |
| 2351 | // Dup is needed here as the pfd inside the socket is owned by the IpSecService, |
| 2352 | // which cannot be obtained by the app process. |
| 2353 | dup = ParcelFileDescriptor.dup(socket.getFileDescriptor()); |
| 2354 | } catch (IOException ignored) { |
| 2355 | // Construct an invalid fd, so that if the user later calls start(), it will fail with |
| 2356 | // ERROR_INVALID_SOCKET. |
| 2357 | dup = createInvalidFd(); |
| 2358 | } |
| 2359 | return new NattSocketKeepalive(mService, network, dup, socket.getResourceId(), source, |
| 2360 | destination, executor, callback); |
| 2361 | } |
| 2362 | |
| 2363 | /** |
| 2364 | * Request that keepalives be started on a IPsec NAT-T socket file descriptor. Directly called |
| 2365 | * by system apps which don't use IpSecService to create {@link UdpEncapsulationSocket}. |
| 2366 | * |
| 2367 | * @param network The {@link Network} the socket is on. |
| 2368 | * @param pfd The {@link ParcelFileDescriptor} that needs to be kept alive. The provided |
| 2369 | * {@link ParcelFileDescriptor} must be bound to a port and the keepalives will be sent |
| 2370 | * from that port. |
| 2371 | * @param source The source address of the {@link UdpEncapsulationSocket}. |
| 2372 | * @param destination The destination address of the {@link UdpEncapsulationSocket}. The |
| 2373 | * keepalive packets will always be sent to port 4500 of the given {@code destination}. |
| 2374 | * @param executor The executor on which callback will be invoked. The provided {@link Executor} |
| 2375 | * must run callback sequentially, otherwise the order of callbacks cannot be |
| 2376 | * guaranteed. |
| 2377 | * @param callback A {@link SocketKeepalive.Callback}. Used for notifications about keepalive |
| 2378 | * changes. Must be extended by applications that use this API. |
| 2379 | * |
| 2380 | * @return A {@link SocketKeepalive} object that can be used to control the keepalive on the |
| 2381 | * given socket. |
| 2382 | * @hide |
| 2383 | */ |
| 2384 | @SystemApi |
| 2385 | @RequiresPermission(android.Manifest.permission.PACKET_KEEPALIVE_OFFLOAD) |
| 2386 | public @NonNull SocketKeepalive createNattKeepalive(@NonNull Network network, |
| 2387 | @NonNull ParcelFileDescriptor pfd, |
| 2388 | @NonNull InetAddress source, |
| 2389 | @NonNull InetAddress destination, |
| 2390 | @NonNull @CallbackExecutor Executor executor, |
| 2391 | @NonNull Callback callback) { |
| 2392 | ParcelFileDescriptor dup; |
| 2393 | try { |
| 2394 | // TODO: Consider remove unnecessary dup. |
| 2395 | dup = pfd.dup(); |
| 2396 | } catch (IOException ignored) { |
| 2397 | // Construct an invalid fd, so that if the user later calls start(), it will fail with |
| 2398 | // ERROR_INVALID_SOCKET. |
| 2399 | dup = createInvalidFd(); |
| 2400 | } |
| 2401 | return new NattSocketKeepalive(mService, network, dup, |
Remi NGUYEN VAN | a29be5c | 2021-03-11 10:56:49 +0000 | [diff] [blame] | 2402 | -1 /* Unused */, source, destination, executor, callback); |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 2403 | } |
| 2404 | |
| 2405 | /** |
| 2406 | * Request that keepalives be started on a TCP socket. |
| 2407 | * The socket must be established. |
| 2408 | * |
| 2409 | * @param network The {@link Network} the socket is on. |
| 2410 | * @param socket The socket that needs to be kept alive. |
| 2411 | * @param executor The executor on which callback will be invoked. This implementation assumes |
| 2412 | * the provided {@link Executor} runs the callbacks in sequence with no |
| 2413 | * concurrency. Failing this, no guarantee of correctness can be made. It is |
| 2414 | * the responsibility of the caller to ensure the executor provides this |
| 2415 | * guarantee. A simple way of creating such an executor is with the standard |
| 2416 | * tool {@code Executors.newSingleThreadExecutor}. |
| 2417 | * @param callback A {@link SocketKeepalive.Callback}. Used for notifications about keepalive |
| 2418 | * changes. Must be extended by applications that use this API. |
| 2419 | * |
| 2420 | * @return A {@link SocketKeepalive} object that can be used to control the keepalive on the |
| 2421 | * given socket. |
| 2422 | * @hide |
| 2423 | */ |
| 2424 | @SystemApi |
| 2425 | @RequiresPermission(android.Manifest.permission.PACKET_KEEPALIVE_OFFLOAD) |
| 2426 | public @NonNull SocketKeepalive createSocketKeepalive(@NonNull Network network, |
| 2427 | @NonNull Socket socket, |
| 2428 | @NonNull Executor executor, |
| 2429 | @NonNull Callback callback) { |
| 2430 | ParcelFileDescriptor dup; |
| 2431 | try { |
| 2432 | dup = ParcelFileDescriptor.fromSocket(socket); |
| 2433 | } catch (UncheckedIOException ignored) { |
| 2434 | // Construct an invalid fd, so that if the user later calls start(), it will fail with |
| 2435 | // ERROR_INVALID_SOCKET. |
| 2436 | dup = createInvalidFd(); |
| 2437 | } |
| 2438 | return new TcpSocketKeepalive(mService, network, dup, executor, callback); |
| 2439 | } |
| 2440 | |
| 2441 | /** |
| 2442 | * Ensure that a network route exists to deliver traffic to the specified |
| 2443 | * host via the specified network interface. An attempt to add a route that |
| 2444 | * already exists is ignored, but treated as successful. |
| 2445 | * |
| 2446 | * <p>This method requires the caller to hold either the |
| 2447 | * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission |
| 2448 | * or the ability to modify system settings as determined by |
| 2449 | * {@link android.provider.Settings.System#canWrite}.</p> |
| 2450 | * |
| 2451 | * @param networkType the type of the network over which traffic to the specified |
| 2452 | * host is to be routed |
| 2453 | * @param hostAddress the IP address of the host to which the route is desired |
| 2454 | * @return {@code true} on success, {@code false} on failure |
| 2455 | * |
| 2456 | * @deprecated Deprecated in favor of the |
| 2457 | * {@link #requestNetwork(NetworkRequest, NetworkCallback)}, |
| 2458 | * {@link #bindProcessToNetwork} and {@link Network#getSocketFactory} API. |
| 2459 | * In {@link VERSION_CODES#M}, and above, this method is unsupported and will |
| 2460 | * throw {@code UnsupportedOperationException} if called. |
| 2461 | * @removed |
| 2462 | */ |
| 2463 | @Deprecated |
| 2464 | public boolean requestRouteToHost(int networkType, int hostAddress) { |
| 2465 | return requestRouteToHostAddress(networkType, NetworkUtils.intToInetAddress(hostAddress)); |
| 2466 | } |
| 2467 | |
| 2468 | /** |
| 2469 | * Ensure that a network route exists to deliver traffic to the specified |
| 2470 | * host via the specified network interface. An attempt to add a route that |
| 2471 | * already exists is ignored, but treated as successful. |
| 2472 | * |
| 2473 | * <p>This method requires the caller to hold either the |
| 2474 | * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission |
| 2475 | * or the ability to modify system settings as determined by |
| 2476 | * {@link android.provider.Settings.System#canWrite}.</p> |
| 2477 | * |
| 2478 | * @param networkType the type of the network over which traffic to the specified |
| 2479 | * host is to be routed |
| 2480 | * @param hostAddress the IP address of the host to which the route is desired |
| 2481 | * @return {@code true} on success, {@code false} on failure |
| 2482 | * @hide |
| 2483 | * @deprecated Deprecated in favor of the {@link #requestNetwork} and |
| 2484 | * {@link #bindProcessToNetwork} API. |
| 2485 | */ |
| 2486 | @Deprecated |
| 2487 | @UnsupportedAppUsage |
lucaslin | 97fb10a | 2021-03-22 11:51:27 +0800 | [diff] [blame] | 2488 | @SystemApi(client = MODULE_LIBRARIES) |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 2489 | public boolean requestRouteToHostAddress(int networkType, InetAddress hostAddress) { |
| 2490 | checkLegacyRoutingApiAccess(); |
| 2491 | try { |
| 2492 | return mService.requestRouteToHostAddress(networkType, hostAddress.getAddress(), |
| 2493 | mContext.getOpPackageName(), getAttributionTag()); |
| 2494 | } catch (RemoteException e) { |
| 2495 | throw e.rethrowFromSystemServer(); |
| 2496 | } |
| 2497 | } |
| 2498 | |
| 2499 | /** |
| 2500 | * @return the context's attribution tag |
| 2501 | */ |
| 2502 | // TODO: Remove method and replace with direct call once R code is pushed to AOSP |
| 2503 | private @Nullable String getAttributionTag() { |
Remi NGUYEN VAN | a522fc2 | 2021-02-01 10:25:24 +0000 | [diff] [blame] | 2504 | return mContext.getAttributionTag(); |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 2505 | } |
| 2506 | |
| 2507 | /** |
| 2508 | * Returns the value of the setting for background data usage. If false, |
| 2509 | * applications should not use the network if the application is not in the |
| 2510 | * foreground. Developers should respect this setting, and check the value |
| 2511 | * of this before performing any background data operations. |
| 2512 | * <p> |
| 2513 | * All applications that have background services that use the network |
| 2514 | * should listen to {@link #ACTION_BACKGROUND_DATA_SETTING_CHANGED}. |
| 2515 | * <p> |
| 2516 | * @deprecated As of {@link VERSION_CODES#ICE_CREAM_SANDWICH}, availability of |
| 2517 | * background data depends on several combined factors, and this method will |
| 2518 | * always return {@code true}. Instead, when background data is unavailable, |
| 2519 | * {@link #getActiveNetworkInfo()} will now appear disconnected. |
| 2520 | * |
| 2521 | * @return Whether background data usage is allowed. |
| 2522 | */ |
| 2523 | @Deprecated |
| 2524 | public boolean getBackgroundDataSetting() { |
| 2525 | // assume that background data is allowed; final authority is |
| 2526 | // NetworkInfo which may be blocked. |
| 2527 | return true; |
| 2528 | } |
| 2529 | |
| 2530 | /** |
| 2531 | * Sets the value of the setting for background data usage. |
| 2532 | * |
| 2533 | * @param allowBackgroundData Whether an application should use data while |
| 2534 | * it is in the background. |
| 2535 | * |
| 2536 | * @attr ref android.Manifest.permission#CHANGE_BACKGROUND_DATA_SETTING |
| 2537 | * @see #getBackgroundDataSetting() |
| 2538 | * @hide |
| 2539 | */ |
| 2540 | @Deprecated |
| 2541 | @UnsupportedAppUsage |
| 2542 | public void setBackgroundDataSetting(boolean allowBackgroundData) { |
| 2543 | // ignored |
| 2544 | } |
| 2545 | |
| 2546 | /** |
| 2547 | * @hide |
| 2548 | * @deprecated Talk to TelephonyManager directly |
| 2549 | */ |
| 2550 | @Deprecated |
| 2551 | @UnsupportedAppUsage |
| 2552 | public boolean getMobileDataEnabled() { |
| 2553 | TelephonyManager tm = mContext.getSystemService(TelephonyManager.class); |
| 2554 | if (tm != null) { |
| 2555 | int subId = SubscriptionManager.getDefaultDataSubscriptionId(); |
| 2556 | Log.d("ConnectivityManager", "getMobileDataEnabled()+ subId=" + subId); |
| 2557 | boolean retVal = tm.createForSubscriptionId(subId).isDataEnabled(); |
| 2558 | Log.d("ConnectivityManager", "getMobileDataEnabled()- subId=" + subId |
| 2559 | + " retVal=" + retVal); |
| 2560 | return retVal; |
| 2561 | } |
| 2562 | Log.d("ConnectivityManager", "getMobileDataEnabled()- remote exception retVal=false"); |
| 2563 | return false; |
| 2564 | } |
| 2565 | |
| 2566 | /** |
| 2567 | * Callback for use with {@link ConnectivityManager#addDefaultNetworkActiveListener} |
| 2568 | * to find out when the system default network has gone in to a high power state. |
| 2569 | */ |
| 2570 | public interface OnNetworkActiveListener { |
| 2571 | /** |
| 2572 | * Called on the main thread of the process to report that the current data network |
| 2573 | * has become active, and it is now a good time to perform any pending network |
| 2574 | * operations. Note that this listener only tells you when the network becomes |
| 2575 | * active; if at any other time you want to know whether it is active (and thus okay |
| 2576 | * to initiate network traffic), you can retrieve its instantaneous state with |
| 2577 | * {@link ConnectivityManager#isDefaultNetworkActive}. |
| 2578 | */ |
| 2579 | void onNetworkActive(); |
| 2580 | } |
| 2581 | |
Chiachang Wang | 2de4168 | 2021-09-23 10:46:03 +0800 | [diff] [blame] | 2582 | @GuardedBy("mNetworkActivityListeners") |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 2583 | private final ArrayMap<OnNetworkActiveListener, INetworkActivityListener> |
| 2584 | mNetworkActivityListeners = new ArrayMap<>(); |
| 2585 | |
| 2586 | /** |
| 2587 | * Start listening to reports when the system's default data network is active, meaning it is |
| 2588 | * a good time to perform network traffic. Use {@link #isDefaultNetworkActive()} |
| 2589 | * to determine the current state of the system's default network after registering the |
| 2590 | * listener. |
| 2591 | * <p> |
| 2592 | * If the process default network has been set with |
| 2593 | * {@link ConnectivityManager#bindProcessToNetwork} this function will not |
| 2594 | * reflect the process's default, but the system default. |
| 2595 | * |
| 2596 | * @param l The listener to be told when the network is active. |
| 2597 | */ |
| 2598 | public void addDefaultNetworkActiveListener(final OnNetworkActiveListener l) { |
Chiachang Wang | 2de4168 | 2021-09-23 10:46:03 +0800 | [diff] [blame] | 2599 | final INetworkActivityListener rl = new INetworkActivityListener.Stub() { |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 2600 | @Override |
| 2601 | public void onNetworkActive() throws RemoteException { |
| 2602 | l.onNetworkActive(); |
| 2603 | } |
| 2604 | }; |
| 2605 | |
Chiachang Wang | 2de4168 | 2021-09-23 10:46:03 +0800 | [diff] [blame] | 2606 | synchronized (mNetworkActivityListeners) { |
| 2607 | try { |
| 2608 | mService.registerNetworkActivityListener(rl); |
| 2609 | mNetworkActivityListeners.put(l, rl); |
| 2610 | } catch (RemoteException e) { |
| 2611 | throw e.rethrowFromSystemServer(); |
| 2612 | } |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 2613 | } |
| 2614 | } |
| 2615 | |
| 2616 | /** |
| 2617 | * Remove network active listener previously registered with |
| 2618 | * {@link #addDefaultNetworkActiveListener}. |
| 2619 | * |
| 2620 | * @param l Previously registered listener. |
| 2621 | */ |
| 2622 | public void removeDefaultNetworkActiveListener(@NonNull OnNetworkActiveListener l) { |
Chiachang Wang | 2de4168 | 2021-09-23 10:46:03 +0800 | [diff] [blame] | 2623 | synchronized (mNetworkActivityListeners) { |
| 2624 | final INetworkActivityListener rl = mNetworkActivityListeners.get(l); |
| 2625 | if (rl == null) { |
| 2626 | throw new IllegalArgumentException("Listener was not registered."); |
| 2627 | } |
| 2628 | try { |
| 2629 | mService.unregisterNetworkActivityListener(rl); |
| 2630 | mNetworkActivityListeners.remove(l); |
| 2631 | } catch (RemoteException e) { |
| 2632 | throw e.rethrowFromSystemServer(); |
| 2633 | } |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 2634 | } |
| 2635 | } |
| 2636 | |
| 2637 | /** |
| 2638 | * Return whether the data network is currently active. An active network means that |
| 2639 | * it is currently in a high power state for performing data transmission. On some |
| 2640 | * types of networks, it may be expensive to move and stay in such a state, so it is |
| 2641 | * more power efficient to batch network traffic together when the radio is already in |
| 2642 | * this state. This method tells you whether right now is currently a good time to |
| 2643 | * initiate network traffic, as the network is already active. |
| 2644 | */ |
| 2645 | public boolean isDefaultNetworkActive() { |
| 2646 | try { |
lucaslin | 709eb84 | 2021-01-21 02:04:15 +0800 | [diff] [blame] | 2647 | return mService.isDefaultNetworkActive(); |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 2648 | } catch (RemoteException e) { |
| 2649 | throw e.rethrowFromSystemServer(); |
| 2650 | } |
| 2651 | } |
| 2652 | |
| 2653 | /** |
| 2654 | * {@hide} |
| 2655 | */ |
| 2656 | public ConnectivityManager(Context context, IConnectivityManager service) { |
Remi NGUYEN VAN | 1818dbb | 2021-03-15 07:31:54 +0000 | [diff] [blame] | 2657 | mContext = Objects.requireNonNull(context, "missing context"); |
| 2658 | mService = Objects.requireNonNull(service, "missing IConnectivityManager"); |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 2659 | sInstance = this; |
| 2660 | } |
| 2661 | |
| 2662 | /** {@hide} */ |
| 2663 | @UnsupportedAppUsage |
| 2664 | public static ConnectivityManager from(Context context) { |
| 2665 | return (ConnectivityManager) context.getSystemService(Context.CONNECTIVITY_SERVICE); |
| 2666 | } |
| 2667 | |
| 2668 | /** @hide */ |
| 2669 | public NetworkRequest getDefaultRequest() { |
| 2670 | try { |
| 2671 | // This is not racy as the default request is final in ConnectivityService. |
| 2672 | return mService.getDefaultRequest(); |
| 2673 | } catch (RemoteException e) { |
| 2674 | throw e.rethrowFromSystemServer(); |
| 2675 | } |
| 2676 | } |
| 2677 | |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 2678 | /** |
| 2679 | * Check if the package is a allowed to write settings. This also accounts that such an access |
| 2680 | * happened. |
| 2681 | * |
| 2682 | * @return {@code true} iff the package is allowed to write settings. |
| 2683 | */ |
| 2684 | // TODO: Remove method and replace with direct call once R code is pushed to AOSP |
| 2685 | private static boolean checkAndNoteWriteSettingsOperation(@NonNull Context context, int uid, |
| 2686 | @NonNull String callingPackage, @Nullable String callingAttributionTag, |
| 2687 | boolean throwException) { |
| 2688 | return Settings.checkAndNoteWriteSettingsOperation(context, uid, callingPackage, |
Remi NGUYEN VAN | a522fc2 | 2021-02-01 10:25:24 +0000 | [diff] [blame] | 2689 | callingAttributionTag, throwException); |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 2690 | } |
| 2691 | |
| 2692 | /** |
| 2693 | * @deprecated - use getSystemService. This is a kludge to support static access in certain |
| 2694 | * situations where a Context pointer is unavailable. |
| 2695 | * @hide |
| 2696 | */ |
| 2697 | @Deprecated |
| 2698 | static ConnectivityManager getInstanceOrNull() { |
| 2699 | return sInstance; |
| 2700 | } |
| 2701 | |
| 2702 | /** |
| 2703 | * @deprecated - use getSystemService. This is a kludge to support static access in certain |
| 2704 | * situations where a Context pointer is unavailable. |
| 2705 | * @hide |
| 2706 | */ |
| 2707 | @Deprecated |
| 2708 | @UnsupportedAppUsage |
| 2709 | private static ConnectivityManager getInstance() { |
| 2710 | if (getInstanceOrNull() == null) { |
| 2711 | throw new IllegalStateException("No ConnectivityManager yet constructed"); |
| 2712 | } |
| 2713 | return getInstanceOrNull(); |
| 2714 | } |
| 2715 | |
| 2716 | /** |
| 2717 | * Get the set of tetherable, available interfaces. This list is limited by |
| 2718 | * device configuration and current interface existence. |
| 2719 | * |
| 2720 | * @return an array of 0 or more Strings of tetherable interface names. |
| 2721 | * |
| 2722 | * @deprecated Use {@link TetheringEventCallback#onTetherableInterfacesChanged(List)} instead. |
| 2723 | * {@hide} |
| 2724 | */ |
| 2725 | @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE) |
| 2726 | @UnsupportedAppUsage |
| 2727 | @Deprecated |
| 2728 | public String[] getTetherableIfaces() { |
Remi NGUYEN VAN | e4d1cd9 | 2021-06-17 16:27:31 +0900 | [diff] [blame] | 2729 | return getTetheringManager().getTetherableIfaces(); |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 2730 | } |
| 2731 | |
| 2732 | /** |
| 2733 | * Get the set of tethered interfaces. |
| 2734 | * |
| 2735 | * @return an array of 0 or more String of currently tethered interface names. |
| 2736 | * |
| 2737 | * @deprecated Use {@link TetheringEventCallback#onTetherableInterfacesChanged(List)} instead. |
| 2738 | * {@hide} |
| 2739 | */ |
| 2740 | @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE) |
| 2741 | @UnsupportedAppUsage |
| 2742 | @Deprecated |
| 2743 | public String[] getTetheredIfaces() { |
Remi NGUYEN VAN | e4d1cd9 | 2021-06-17 16:27:31 +0900 | [diff] [blame] | 2744 | return getTetheringManager().getTetheredIfaces(); |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 2745 | } |
| 2746 | |
| 2747 | /** |
| 2748 | * Get the set of interface names which attempted to tether but |
| 2749 | * failed. Re-attempting to tether may cause them to reset to the Tethered |
| 2750 | * state. Alternatively, causing the interface to be destroyed and recreated |
| 2751 | * may cause them to reset to the available state. |
| 2752 | * {@link ConnectivityManager#getLastTetherError} can be used to get more |
| 2753 | * information on the cause of the errors. |
| 2754 | * |
| 2755 | * @return an array of 0 or more String indicating the interface names |
| 2756 | * which failed to tether. |
| 2757 | * |
| 2758 | * @deprecated Use {@link TetheringEventCallback#onError(String, int)} instead. |
| 2759 | * {@hide} |
| 2760 | */ |
| 2761 | @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE) |
| 2762 | @UnsupportedAppUsage |
| 2763 | @Deprecated |
| 2764 | public String[] getTetheringErroredIfaces() { |
Remi NGUYEN VAN | e4d1cd9 | 2021-06-17 16:27:31 +0900 | [diff] [blame] | 2765 | return getTetheringManager().getTetheringErroredIfaces(); |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 2766 | } |
| 2767 | |
| 2768 | /** |
| 2769 | * Get the set of tethered dhcp ranges. |
| 2770 | * |
| 2771 | * @deprecated This method is not supported. |
| 2772 | * TODO: remove this function when all of clients are removed. |
| 2773 | * {@hide} |
| 2774 | */ |
| 2775 | @RequiresPermission(android.Manifest.permission.NETWORK_SETTINGS) |
| 2776 | @Deprecated |
| 2777 | public String[] getTetheredDhcpRanges() { |
| 2778 | throw new UnsupportedOperationException("getTetheredDhcpRanges is not supported"); |
| 2779 | } |
| 2780 | |
| 2781 | /** |
| 2782 | * Attempt to tether the named interface. This will setup a dhcp server |
| 2783 | * on the interface, forward and NAT IP packets and forward DNS requests |
| 2784 | * to the best active upstream network interface. Note that if no upstream |
| 2785 | * IP network interface is available, dhcp will still run and traffic will be |
| 2786 | * allowed between the tethered devices and this device, though upstream net |
| 2787 | * access will of course fail until an upstream network interface becomes |
| 2788 | * active. |
| 2789 | * |
| 2790 | * <p>This method requires the caller to hold either the |
| 2791 | * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission |
| 2792 | * or the ability to modify system settings as determined by |
| 2793 | * {@link android.provider.Settings.System#canWrite}.</p> |
| 2794 | * |
| 2795 | * <p>WARNING: New clients should not use this function. The only usages should be in PanService |
| 2796 | * and WifiStateMachine which need direct access. All other clients should use |
| 2797 | * {@link #startTethering} and {@link #stopTethering} which encapsulate proper provisioning |
| 2798 | * logic.</p> |
| 2799 | * |
| 2800 | * @param iface the interface name to tether. |
| 2801 | * @return error a {@code TETHER_ERROR} value indicating success or failure type |
| 2802 | * @deprecated Use {@link TetheringManager#startTethering} instead |
| 2803 | * |
| 2804 | * {@hide} |
| 2805 | */ |
| 2806 | @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553) |
| 2807 | @Deprecated |
| 2808 | public int tether(String iface) { |
Remi NGUYEN VAN | e4d1cd9 | 2021-06-17 16:27:31 +0900 | [diff] [blame] | 2809 | return getTetheringManager().tether(iface); |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 2810 | } |
| 2811 | |
| 2812 | /** |
| 2813 | * Stop tethering the named interface. |
| 2814 | * |
| 2815 | * <p>This method requires the caller to hold either the |
| 2816 | * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission |
| 2817 | * or the ability to modify system settings as determined by |
| 2818 | * {@link android.provider.Settings.System#canWrite}.</p> |
| 2819 | * |
| 2820 | * <p>WARNING: New clients should not use this function. The only usages should be in PanService |
| 2821 | * and WifiStateMachine which need direct access. All other clients should use |
| 2822 | * {@link #startTethering} and {@link #stopTethering} which encapsulate proper provisioning |
| 2823 | * logic.</p> |
| 2824 | * |
| 2825 | * @param iface the interface name to untether. |
| 2826 | * @return error a {@code TETHER_ERROR} value indicating success or failure type |
| 2827 | * |
| 2828 | * {@hide} |
| 2829 | */ |
| 2830 | @UnsupportedAppUsage |
| 2831 | @Deprecated |
| 2832 | public int untether(String iface) { |
Remi NGUYEN VAN | e4d1cd9 | 2021-06-17 16:27:31 +0900 | [diff] [blame] | 2833 | return getTetheringManager().untether(iface); |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 2834 | } |
| 2835 | |
| 2836 | /** |
| 2837 | * Check if the device allows for tethering. It may be disabled via |
| 2838 | * {@code ro.tether.denied} system property, Settings.TETHER_SUPPORTED or |
| 2839 | * due to device configuration. |
| 2840 | * |
| 2841 | * <p>If this app does not have permission to use this API, it will always |
| 2842 | * return false rather than throw an exception.</p> |
| 2843 | * |
| 2844 | * <p>If the device has a hotspot provisioning app, the caller is required to hold the |
| 2845 | * {@link android.Manifest.permission.TETHER_PRIVILEGED} permission.</p> |
| 2846 | * |
| 2847 | * <p>Otherwise, this method requires the caller to hold the ability to modify system |
| 2848 | * settings as determined by {@link android.provider.Settings.System#canWrite}.</p> |
| 2849 | * |
| 2850 | * @return a boolean - {@code true} indicating Tethering is supported. |
| 2851 | * |
| 2852 | * @deprecated Use {@link TetheringEventCallback#onTetheringSupported(boolean)} instead. |
| 2853 | * {@hide} |
| 2854 | */ |
| 2855 | @SystemApi |
| 2856 | @RequiresPermission(anyOf = {android.Manifest.permission.TETHER_PRIVILEGED, |
| 2857 | android.Manifest.permission.WRITE_SETTINGS}) |
| 2858 | public boolean isTetheringSupported() { |
Remi NGUYEN VAN | e4d1cd9 | 2021-06-17 16:27:31 +0900 | [diff] [blame] | 2859 | return getTetheringManager().isTetheringSupported(); |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 2860 | } |
| 2861 | |
| 2862 | /** |
| 2863 | * Callback for use with {@link #startTethering} to find out whether tethering succeeded. |
| 2864 | * |
| 2865 | * @deprecated Use {@link TetheringManager.StartTetheringCallback} instead. |
| 2866 | * @hide |
| 2867 | */ |
| 2868 | @SystemApi |
| 2869 | @Deprecated |
| 2870 | public static abstract class OnStartTetheringCallback { |
| 2871 | /** |
| 2872 | * Called when tethering has been successfully started. |
| 2873 | */ |
| 2874 | public void onTetheringStarted() {} |
| 2875 | |
| 2876 | /** |
| 2877 | * Called when starting tethering failed. |
| 2878 | */ |
| 2879 | public void onTetheringFailed() {} |
| 2880 | } |
| 2881 | |
| 2882 | /** |
| 2883 | * Convenient overload for |
| 2884 | * {@link #startTethering(int, boolean, OnStartTetheringCallback, Handler)} which passes a null |
| 2885 | * handler to run on the current thread's {@link Looper}. |
| 2886 | * |
| 2887 | * @deprecated Use {@link TetheringManager#startTethering} instead. |
| 2888 | * @hide |
| 2889 | */ |
| 2890 | @SystemApi |
| 2891 | @Deprecated |
| 2892 | @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED) |
| 2893 | public void startTethering(int type, boolean showProvisioningUi, |
| 2894 | final OnStartTetheringCallback callback) { |
| 2895 | startTethering(type, showProvisioningUi, callback, null); |
| 2896 | } |
| 2897 | |
| 2898 | /** |
| 2899 | * Runs tether provisioning for the given type if needed and then starts tethering if |
| 2900 | * the check succeeds. If no carrier provisioning is required for tethering, tethering is |
| 2901 | * enabled immediately. If provisioning fails, tethering will not be enabled. It also |
| 2902 | * schedules tether provisioning re-checks if appropriate. |
| 2903 | * |
| 2904 | * @param type The type of tethering to start. Must be one of |
| 2905 | * {@link ConnectivityManager.TETHERING_WIFI}, |
| 2906 | * {@link ConnectivityManager.TETHERING_USB}, or |
| 2907 | * {@link ConnectivityManager.TETHERING_BLUETOOTH}. |
| 2908 | * @param showProvisioningUi a boolean indicating to show the provisioning app UI if there |
| 2909 | * is one. This should be true the first time this function is called and also any time |
| 2910 | * the user can see this UI. It gives users information from their carrier about the |
| 2911 | * check failing and how they can sign up for tethering if possible. |
| 2912 | * @param callback an {@link OnStartTetheringCallback} which will be called to notify the caller |
| 2913 | * of the result of trying to tether. |
| 2914 | * @param handler {@link Handler} to specify the thread upon which the callback will be invoked. |
| 2915 | * |
| 2916 | * @deprecated Use {@link TetheringManager#startTethering} instead. |
| 2917 | * @hide |
| 2918 | */ |
| 2919 | @SystemApi |
| 2920 | @Deprecated |
| 2921 | @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED) |
| 2922 | public void startTethering(int type, boolean showProvisioningUi, |
| 2923 | final OnStartTetheringCallback callback, Handler handler) { |
Remi NGUYEN VAN | 1818dbb | 2021-03-15 07:31:54 +0000 | [diff] [blame] | 2924 | Objects.requireNonNull(callback, "OnStartTetheringCallback cannot be null."); |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 2925 | |
| 2926 | final Executor executor = new Executor() { |
| 2927 | @Override |
| 2928 | public void execute(Runnable command) { |
| 2929 | if (handler == null) { |
| 2930 | command.run(); |
| 2931 | } else { |
| 2932 | handler.post(command); |
| 2933 | } |
| 2934 | } |
| 2935 | }; |
| 2936 | |
| 2937 | final StartTetheringCallback tetheringCallback = new StartTetheringCallback() { |
| 2938 | @Override |
| 2939 | public void onTetheringStarted() { |
| 2940 | callback.onTetheringStarted(); |
| 2941 | } |
| 2942 | |
| 2943 | @Override |
| 2944 | public void onTetheringFailed(final int error) { |
| 2945 | callback.onTetheringFailed(); |
| 2946 | } |
| 2947 | }; |
| 2948 | |
| 2949 | final TetheringRequest request = new TetheringRequest.Builder(type) |
| 2950 | .setShouldShowEntitlementUi(showProvisioningUi).build(); |
| 2951 | |
Remi NGUYEN VAN | e4d1cd9 | 2021-06-17 16:27:31 +0900 | [diff] [blame] | 2952 | getTetheringManager().startTethering(request, executor, tetheringCallback); |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 2953 | } |
| 2954 | |
| 2955 | /** |
| 2956 | * Stops tethering for the given type. Also cancels any provisioning rechecks for that type if |
| 2957 | * applicable. |
| 2958 | * |
| 2959 | * @param type The type of tethering to stop. Must be one of |
| 2960 | * {@link ConnectivityManager.TETHERING_WIFI}, |
| 2961 | * {@link ConnectivityManager.TETHERING_USB}, or |
| 2962 | * {@link ConnectivityManager.TETHERING_BLUETOOTH}. |
| 2963 | * |
| 2964 | * @deprecated Use {@link TetheringManager#stopTethering} instead. |
| 2965 | * @hide |
| 2966 | */ |
| 2967 | @SystemApi |
| 2968 | @Deprecated |
| 2969 | @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED) |
| 2970 | public void stopTethering(int type) { |
Remi NGUYEN VAN | e4d1cd9 | 2021-06-17 16:27:31 +0900 | [diff] [blame] | 2971 | getTetheringManager().stopTethering(type); |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 2972 | } |
| 2973 | |
| 2974 | /** |
| 2975 | * Callback for use with {@link registerTetheringEventCallback} to find out tethering |
| 2976 | * upstream status. |
| 2977 | * |
| 2978 | * @deprecated Use {@link TetheringManager#OnTetheringEventCallback} instead. |
| 2979 | * @hide |
| 2980 | */ |
| 2981 | @SystemApi |
| 2982 | @Deprecated |
| 2983 | public abstract static class OnTetheringEventCallback { |
| 2984 | |
| 2985 | /** |
| 2986 | * Called when tethering upstream changed. This can be called multiple times and can be |
| 2987 | * called any time. |
| 2988 | * |
| 2989 | * @param network the {@link Network} of tethering upstream. Null means tethering doesn't |
| 2990 | * have any upstream. |
| 2991 | */ |
| 2992 | public void onUpstreamChanged(@Nullable Network network) {} |
| 2993 | } |
| 2994 | |
| 2995 | @GuardedBy("mTetheringEventCallbacks") |
| 2996 | private final ArrayMap<OnTetheringEventCallback, TetheringEventCallback> |
| 2997 | mTetheringEventCallbacks = new ArrayMap<>(); |
| 2998 | |
| 2999 | /** |
| 3000 | * Start listening to tethering change events. Any new added callback will receive the last |
| 3001 | * tethering status right away. If callback is registered when tethering has no upstream or |
| 3002 | * disabled, {@link OnTetheringEventCallback#onUpstreamChanged} will immediately be called |
| 3003 | * with a null argument. The same callback object cannot be registered twice. |
| 3004 | * |
| 3005 | * @param executor the executor on which callback will be invoked. |
| 3006 | * @param callback the callback to be called when tethering has change events. |
| 3007 | * |
| 3008 | * @deprecated Use {@link TetheringManager#registerTetheringEventCallback} instead. |
| 3009 | * @hide |
| 3010 | */ |
| 3011 | @SystemApi |
| 3012 | @Deprecated |
| 3013 | @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED) |
| 3014 | public void registerTetheringEventCallback( |
| 3015 | @NonNull @CallbackExecutor Executor executor, |
| 3016 | @NonNull final OnTetheringEventCallback callback) { |
Remi NGUYEN VAN | 1818dbb | 2021-03-15 07:31:54 +0000 | [diff] [blame] | 3017 | Objects.requireNonNull(callback, "OnTetheringEventCallback cannot be null."); |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 3018 | |
| 3019 | final TetheringEventCallback tetherCallback = |
| 3020 | new TetheringEventCallback() { |
| 3021 | @Override |
| 3022 | public void onUpstreamChanged(@Nullable Network network) { |
| 3023 | callback.onUpstreamChanged(network); |
| 3024 | } |
| 3025 | }; |
| 3026 | |
| 3027 | synchronized (mTetheringEventCallbacks) { |
| 3028 | mTetheringEventCallbacks.put(callback, tetherCallback); |
Remi NGUYEN VAN | e4d1cd9 | 2021-06-17 16:27:31 +0900 | [diff] [blame] | 3029 | getTetheringManager().registerTetheringEventCallback(executor, tetherCallback); |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 3030 | } |
| 3031 | } |
| 3032 | |
| 3033 | /** |
| 3034 | * Remove tethering event callback previously registered with |
| 3035 | * {@link #registerTetheringEventCallback}. |
| 3036 | * |
| 3037 | * @param callback previously registered callback. |
| 3038 | * |
| 3039 | * @deprecated Use {@link TetheringManager#unregisterTetheringEventCallback} instead. |
| 3040 | * @hide |
| 3041 | */ |
| 3042 | @SystemApi |
| 3043 | @Deprecated |
| 3044 | @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED) |
| 3045 | public void unregisterTetheringEventCallback( |
| 3046 | @NonNull final OnTetheringEventCallback callback) { |
| 3047 | Objects.requireNonNull(callback, "The callback must be non-null"); |
| 3048 | synchronized (mTetheringEventCallbacks) { |
| 3049 | final TetheringEventCallback tetherCallback = |
| 3050 | mTetheringEventCallbacks.remove(callback); |
Remi NGUYEN VAN | e4d1cd9 | 2021-06-17 16:27:31 +0900 | [diff] [blame] | 3051 | getTetheringManager().unregisterTetheringEventCallback(tetherCallback); |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 3052 | } |
| 3053 | } |
| 3054 | |
| 3055 | |
| 3056 | /** |
| 3057 | * Get the list of regular expressions that define any tetherable |
| 3058 | * USB network interfaces. If USB tethering is not supported by the |
| 3059 | * device, this list should be empty. |
| 3060 | * |
| 3061 | * @return an array of 0 or more regular expression Strings defining |
| 3062 | * what interfaces are considered tetherable usb interfaces. |
| 3063 | * |
| 3064 | * @deprecated Use {@link TetheringEventCallback#onTetherableInterfaceRegexpsChanged} instead. |
| 3065 | * {@hide} |
| 3066 | */ |
| 3067 | @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE) |
| 3068 | @UnsupportedAppUsage |
| 3069 | @Deprecated |
| 3070 | public String[] getTetherableUsbRegexs() { |
Remi NGUYEN VAN | e4d1cd9 | 2021-06-17 16:27:31 +0900 | [diff] [blame] | 3071 | return getTetheringManager().getTetherableUsbRegexs(); |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 3072 | } |
| 3073 | |
| 3074 | /** |
| 3075 | * Get the list of regular expressions that define any tetherable |
| 3076 | * Wifi network interfaces. If Wifi tethering is not supported by the |
| 3077 | * device, this list should be empty. |
| 3078 | * |
| 3079 | * @return an array of 0 or more regular expression Strings defining |
| 3080 | * what interfaces are considered tetherable wifi interfaces. |
| 3081 | * |
| 3082 | * @deprecated Use {@link TetheringEventCallback#onTetherableInterfaceRegexpsChanged} instead. |
| 3083 | * {@hide} |
| 3084 | */ |
| 3085 | @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE) |
| 3086 | @UnsupportedAppUsage |
| 3087 | @Deprecated |
| 3088 | public String[] getTetherableWifiRegexs() { |
Remi NGUYEN VAN | e4d1cd9 | 2021-06-17 16:27:31 +0900 | [diff] [blame] | 3089 | return getTetheringManager().getTetherableWifiRegexs(); |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 3090 | } |
| 3091 | |
| 3092 | /** |
| 3093 | * Get the list of regular expressions that define any tetherable |
| 3094 | * Bluetooth network interfaces. If Bluetooth tethering is not supported by the |
| 3095 | * device, this list should be empty. |
| 3096 | * |
| 3097 | * @return an array of 0 or more regular expression Strings defining |
| 3098 | * what interfaces are considered tetherable bluetooth interfaces. |
| 3099 | * |
| 3100 | * @deprecated Use {@link TetheringEventCallback#onTetherableInterfaceRegexpsChanged( |
| 3101 | *TetheringManager.TetheringInterfaceRegexps)} instead. |
| 3102 | * {@hide} |
| 3103 | */ |
| 3104 | @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE) |
| 3105 | @UnsupportedAppUsage |
| 3106 | @Deprecated |
| 3107 | public String[] getTetherableBluetoothRegexs() { |
Remi NGUYEN VAN | e4d1cd9 | 2021-06-17 16:27:31 +0900 | [diff] [blame] | 3108 | return getTetheringManager().getTetherableBluetoothRegexs(); |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 3109 | } |
| 3110 | |
| 3111 | /** |
| 3112 | * Attempt to both alter the mode of USB and Tethering of USB. A |
| 3113 | * utility method to deal with some of the complexity of USB - will |
| 3114 | * attempt to switch to Rndis and subsequently tether the resulting |
| 3115 | * interface on {@code true} or turn off tethering and switch off |
| 3116 | * Rndis on {@code false}. |
| 3117 | * |
| 3118 | * <p>This method requires the caller to hold either the |
| 3119 | * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission |
| 3120 | * or the ability to modify system settings as determined by |
| 3121 | * {@link android.provider.Settings.System#canWrite}.</p> |
| 3122 | * |
| 3123 | * @param enable a boolean - {@code true} to enable tethering |
| 3124 | * @return error a {@code TETHER_ERROR} value indicating success or failure type |
| 3125 | * @deprecated Use {@link TetheringManager#startTethering} instead |
| 3126 | * |
| 3127 | * {@hide} |
| 3128 | */ |
| 3129 | @UnsupportedAppUsage |
| 3130 | @Deprecated |
| 3131 | public int setUsbTethering(boolean enable) { |
Remi NGUYEN VAN | e4d1cd9 | 2021-06-17 16:27:31 +0900 | [diff] [blame] | 3132 | return getTetheringManager().setUsbTethering(enable); |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 3133 | } |
| 3134 | |
| 3135 | /** |
| 3136 | * @deprecated Use {@link TetheringManager#TETHER_ERROR_NO_ERROR}. |
| 3137 | * {@hide} |
| 3138 | */ |
| 3139 | @SystemApi |
| 3140 | @Deprecated |
Remi NGUYEN VAN | 71ced8e | 2021-02-15 18:52:06 +0900 | [diff] [blame] | 3141 | public static final int TETHER_ERROR_NO_ERROR = 0; |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 3142 | /** |
| 3143 | * @deprecated Use {@link TetheringManager#TETHER_ERROR_UNKNOWN_IFACE}. |
| 3144 | * {@hide} |
| 3145 | */ |
| 3146 | @Deprecated |
| 3147 | public static final int TETHER_ERROR_UNKNOWN_IFACE = |
| 3148 | TetheringManager.TETHER_ERROR_UNKNOWN_IFACE; |
| 3149 | /** |
| 3150 | * @deprecated Use {@link TetheringManager#TETHER_ERROR_SERVICE_UNAVAIL}. |
| 3151 | * {@hide} |
| 3152 | */ |
| 3153 | @Deprecated |
| 3154 | public static final int TETHER_ERROR_SERVICE_UNAVAIL = |
| 3155 | TetheringManager.TETHER_ERROR_SERVICE_UNAVAIL; |
| 3156 | /** |
| 3157 | * @deprecated Use {@link TetheringManager#TETHER_ERROR_UNSUPPORTED}. |
| 3158 | * {@hide} |
| 3159 | */ |
| 3160 | @Deprecated |
| 3161 | public static final int TETHER_ERROR_UNSUPPORTED = TetheringManager.TETHER_ERROR_UNSUPPORTED; |
| 3162 | /** |
| 3163 | * @deprecated Use {@link TetheringManager#TETHER_ERROR_UNAVAIL_IFACE}. |
| 3164 | * {@hide} |
| 3165 | */ |
| 3166 | @Deprecated |
| 3167 | public static final int TETHER_ERROR_UNAVAIL_IFACE = |
| 3168 | TetheringManager.TETHER_ERROR_UNAVAIL_IFACE; |
| 3169 | /** |
| 3170 | * @deprecated Use {@link TetheringManager#TETHER_ERROR_INTERNAL_ERROR}. |
| 3171 | * {@hide} |
| 3172 | */ |
| 3173 | @Deprecated |
| 3174 | public static final int TETHER_ERROR_MASTER_ERROR = |
| 3175 | TetheringManager.TETHER_ERROR_INTERNAL_ERROR; |
| 3176 | /** |
| 3177 | * @deprecated Use {@link TetheringManager#TETHER_ERROR_TETHER_IFACE_ERROR}. |
| 3178 | * {@hide} |
| 3179 | */ |
| 3180 | @Deprecated |
| 3181 | public static final int TETHER_ERROR_TETHER_IFACE_ERROR = |
| 3182 | TetheringManager.TETHER_ERROR_TETHER_IFACE_ERROR; |
| 3183 | /** |
| 3184 | * @deprecated Use {@link TetheringManager#TETHER_ERROR_UNTETHER_IFACE_ERROR}. |
| 3185 | * {@hide} |
| 3186 | */ |
| 3187 | @Deprecated |
| 3188 | public static final int TETHER_ERROR_UNTETHER_IFACE_ERROR = |
| 3189 | TetheringManager.TETHER_ERROR_UNTETHER_IFACE_ERROR; |
| 3190 | /** |
| 3191 | * @deprecated Use {@link TetheringManager#TETHER_ERROR_ENABLE_FORWARDING_ERROR}. |
| 3192 | * {@hide} |
| 3193 | */ |
| 3194 | @Deprecated |
| 3195 | public static final int TETHER_ERROR_ENABLE_NAT_ERROR = |
| 3196 | TetheringManager.TETHER_ERROR_ENABLE_FORWARDING_ERROR; |
| 3197 | /** |
| 3198 | * @deprecated Use {@link TetheringManager#TETHER_ERROR_DISABLE_FORWARDING_ERROR}. |
| 3199 | * {@hide} |
| 3200 | */ |
| 3201 | @Deprecated |
| 3202 | public static final int TETHER_ERROR_DISABLE_NAT_ERROR = |
| 3203 | TetheringManager.TETHER_ERROR_DISABLE_FORWARDING_ERROR; |
| 3204 | /** |
| 3205 | * @deprecated Use {@link TetheringManager#TETHER_ERROR_IFACE_CFG_ERROR}. |
| 3206 | * {@hide} |
| 3207 | */ |
| 3208 | @Deprecated |
| 3209 | public static final int TETHER_ERROR_IFACE_CFG_ERROR = |
| 3210 | TetheringManager.TETHER_ERROR_IFACE_CFG_ERROR; |
| 3211 | /** |
| 3212 | * @deprecated Use {@link TetheringManager#TETHER_ERROR_PROVISIONING_FAILED}. |
| 3213 | * {@hide} |
| 3214 | */ |
| 3215 | @SystemApi |
| 3216 | @Deprecated |
Remi NGUYEN VAN | 71ced8e | 2021-02-15 18:52:06 +0900 | [diff] [blame] | 3217 | public static final int TETHER_ERROR_PROVISION_FAILED = 11; |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 3218 | /** |
| 3219 | * @deprecated Use {@link TetheringManager#TETHER_ERROR_DHCPSERVER_ERROR}. |
| 3220 | * {@hide} |
| 3221 | */ |
| 3222 | @Deprecated |
| 3223 | public static final int TETHER_ERROR_DHCPSERVER_ERROR = |
| 3224 | TetheringManager.TETHER_ERROR_DHCPSERVER_ERROR; |
| 3225 | /** |
| 3226 | * @deprecated Use {@link TetheringManager#TETHER_ERROR_ENTITLEMENT_UNKNOWN}. |
| 3227 | * {@hide} |
| 3228 | */ |
| 3229 | @SystemApi |
| 3230 | @Deprecated |
Remi NGUYEN VAN | 71ced8e | 2021-02-15 18:52:06 +0900 | [diff] [blame] | 3231 | public static final int TETHER_ERROR_ENTITLEMENT_UNKONWN = 13; |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 3232 | |
| 3233 | /** |
| 3234 | * Get a more detailed error code after a Tethering or Untethering |
| 3235 | * request asynchronously failed. |
| 3236 | * |
| 3237 | * @param iface The name of the interface of interest |
| 3238 | * @return error The error code of the last error tethering or untethering the named |
| 3239 | * interface |
| 3240 | * |
| 3241 | * @deprecated Use {@link TetheringEventCallback#onError(String, int)} instead. |
| 3242 | * {@hide} |
| 3243 | */ |
| 3244 | @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE) |
| 3245 | @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553) |
| 3246 | @Deprecated |
| 3247 | public int getLastTetherError(String iface) { |
Remi NGUYEN VAN | e4d1cd9 | 2021-06-17 16:27:31 +0900 | [diff] [blame] | 3248 | int error = getTetheringManager().getLastTetherError(iface); |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 3249 | if (error == TetheringManager.TETHER_ERROR_UNKNOWN_TYPE) { |
| 3250 | // TETHER_ERROR_UNKNOWN_TYPE was introduced with TetheringManager and has never been |
| 3251 | // returned by ConnectivityManager. Convert it to the legacy TETHER_ERROR_UNKNOWN_IFACE |
| 3252 | // instead. |
| 3253 | error = TetheringManager.TETHER_ERROR_UNKNOWN_IFACE; |
| 3254 | } |
| 3255 | return error; |
| 3256 | } |
| 3257 | |
| 3258 | /** @hide */ |
| 3259 | @Retention(RetentionPolicy.SOURCE) |
| 3260 | @IntDef(value = { |
| 3261 | TETHER_ERROR_NO_ERROR, |
| 3262 | TETHER_ERROR_PROVISION_FAILED, |
| 3263 | TETHER_ERROR_ENTITLEMENT_UNKONWN, |
| 3264 | }) |
| 3265 | public @interface EntitlementResultCode { |
| 3266 | } |
| 3267 | |
| 3268 | /** |
| 3269 | * Callback for use with {@link #getLatestTetheringEntitlementResult} to find out whether |
| 3270 | * entitlement succeeded. |
| 3271 | * |
| 3272 | * @deprecated Use {@link TetheringManager#OnTetheringEntitlementResultListener} instead. |
| 3273 | * @hide |
| 3274 | */ |
| 3275 | @SystemApi |
| 3276 | @Deprecated |
| 3277 | public interface OnTetheringEntitlementResultListener { |
| 3278 | /** |
| 3279 | * Called to notify entitlement result. |
| 3280 | * |
| 3281 | * @param resultCode an int value of entitlement result. It may be one of |
| 3282 | * {@link #TETHER_ERROR_NO_ERROR}, |
| 3283 | * {@link #TETHER_ERROR_PROVISION_FAILED}, or |
| 3284 | * {@link #TETHER_ERROR_ENTITLEMENT_UNKONWN}. |
| 3285 | */ |
| 3286 | void onTetheringEntitlementResult(@EntitlementResultCode int resultCode); |
| 3287 | } |
| 3288 | |
| 3289 | /** |
| 3290 | * Get the last value of the entitlement check on this downstream. If the cached value is |
| 3291 | * {@link #TETHER_ERROR_NO_ERROR} or showEntitlementUi argument is false, it just return the |
| 3292 | * cached value. Otherwise, a UI-based entitlement check would be performed. It is not |
| 3293 | * guaranteed that the UI-based entitlement check will complete in any specific time period |
| 3294 | * and may in fact never complete. Any successful entitlement check the platform performs for |
| 3295 | * any reason will update the cached value. |
| 3296 | * |
| 3297 | * @param type the downstream type of tethering. Must be one of |
| 3298 | * {@link #TETHERING_WIFI}, |
| 3299 | * {@link #TETHERING_USB}, or |
| 3300 | * {@link #TETHERING_BLUETOOTH}. |
| 3301 | * @param showEntitlementUi a boolean indicating whether to run UI-based entitlement check. |
| 3302 | * @param executor the executor on which callback will be invoked. |
| 3303 | * @param listener an {@link OnTetheringEntitlementResultListener} which will be called to |
| 3304 | * notify the caller of the result of entitlement check. The listener may be called zero |
| 3305 | * or one time. |
| 3306 | * @deprecated Use {@link TetheringManager#requestLatestTetheringEntitlementResult} instead. |
| 3307 | * {@hide} |
| 3308 | */ |
| 3309 | @SystemApi |
| 3310 | @Deprecated |
| 3311 | @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED) |
| 3312 | public void getLatestTetheringEntitlementResult(int type, boolean showEntitlementUi, |
| 3313 | @NonNull @CallbackExecutor Executor executor, |
| 3314 | @NonNull final OnTetheringEntitlementResultListener listener) { |
Remi NGUYEN VAN | 1818dbb | 2021-03-15 07:31:54 +0000 | [diff] [blame] | 3315 | Objects.requireNonNull(listener, "TetheringEntitlementResultListener cannot be null."); |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 3316 | ResultReceiver wrappedListener = new ResultReceiver(null) { |
| 3317 | @Override |
| 3318 | protected void onReceiveResult(int resultCode, Bundle resultData) { |
lucaslin | eaff72d | 2021-03-04 09:38:21 +0800 | [diff] [blame] | 3319 | final long token = Binder.clearCallingIdentity(); |
| 3320 | try { |
| 3321 | executor.execute(() -> { |
| 3322 | listener.onTetheringEntitlementResult(resultCode); |
| 3323 | }); |
| 3324 | } finally { |
| 3325 | Binder.restoreCallingIdentity(token); |
| 3326 | } |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 3327 | } |
| 3328 | }; |
| 3329 | |
Remi NGUYEN VAN | e4d1cd9 | 2021-06-17 16:27:31 +0900 | [diff] [blame] | 3330 | getTetheringManager().requestLatestTetheringEntitlementResult(type, wrappedListener, |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 3331 | showEntitlementUi); |
| 3332 | } |
| 3333 | |
| 3334 | /** |
| 3335 | * Report network connectivity status. This is currently used only |
| 3336 | * to alter status bar UI. |
| 3337 | * <p>This method requires the caller to hold the permission |
| 3338 | * {@link android.Manifest.permission#STATUS_BAR}. |
| 3339 | * |
| 3340 | * @param networkType The type of network you want to report on |
| 3341 | * @param percentage The quality of the connection 0 is bad, 100 is good |
| 3342 | * @deprecated Types are deprecated. Use {@link #reportNetworkConnectivity} instead. |
| 3343 | * {@hide} |
| 3344 | */ |
| 3345 | public void reportInetCondition(int networkType, int percentage) { |
| 3346 | printStackTrace(); |
| 3347 | try { |
| 3348 | mService.reportInetCondition(networkType, percentage); |
| 3349 | } catch (RemoteException e) { |
| 3350 | throw e.rethrowFromSystemServer(); |
| 3351 | } |
| 3352 | } |
| 3353 | |
| 3354 | /** |
| 3355 | * Report a problem network to the framework. This provides a hint to the system |
| 3356 | * that there might be connectivity problems on this network and may cause |
| 3357 | * the framework to re-evaluate network connectivity and/or switch to another |
| 3358 | * network. |
| 3359 | * |
| 3360 | * @param network The {@link Network} the application was attempting to use |
| 3361 | * or {@code null} to indicate the current default network. |
| 3362 | * @deprecated Use {@link #reportNetworkConnectivity} which allows reporting both |
| 3363 | * working and non-working connectivity. |
| 3364 | */ |
| 3365 | @Deprecated |
| 3366 | public void reportBadNetwork(@Nullable Network network) { |
| 3367 | printStackTrace(); |
| 3368 | try { |
| 3369 | // One of these will be ignored because it matches system's current state. |
| 3370 | // The other will trigger the necessary reevaluation. |
| 3371 | mService.reportNetworkConnectivity(network, true); |
| 3372 | mService.reportNetworkConnectivity(network, false); |
| 3373 | } catch (RemoteException e) { |
| 3374 | throw e.rethrowFromSystemServer(); |
| 3375 | } |
| 3376 | } |
| 3377 | |
| 3378 | /** |
| 3379 | * Report to the framework whether a network has working connectivity. |
| 3380 | * This provides a hint to the system that a particular network is providing |
| 3381 | * working connectivity or not. In response the framework may re-evaluate |
| 3382 | * the network's connectivity and might take further action thereafter. |
| 3383 | * |
| 3384 | * @param network The {@link Network} the application was attempting to use |
| 3385 | * or {@code null} to indicate the current default network. |
| 3386 | * @param hasConnectivity {@code true} if the application was able to successfully access the |
| 3387 | * Internet using {@code network} or {@code false} if not. |
| 3388 | */ |
| 3389 | public void reportNetworkConnectivity(@Nullable Network network, boolean hasConnectivity) { |
| 3390 | printStackTrace(); |
| 3391 | try { |
| 3392 | mService.reportNetworkConnectivity(network, hasConnectivity); |
| 3393 | } catch (RemoteException e) { |
| 3394 | throw e.rethrowFromSystemServer(); |
| 3395 | } |
| 3396 | } |
| 3397 | |
| 3398 | /** |
Chalard Jean | e1ce6ae | 2021-03-17 17:03:34 +0900 | [diff] [blame] | 3399 | * Set a network-independent global HTTP proxy. |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 3400 | * |
Chalard Jean | e1ce6ae | 2021-03-17 17:03:34 +0900 | [diff] [blame] | 3401 | * This sets an HTTP proxy that applies to all networks and overrides any network-specific |
| 3402 | * proxy. If set, HTTP libraries that are proxy-aware will use this global proxy when |
| 3403 | * accessing any network, regardless of what the settings for that network are. |
| 3404 | * |
| 3405 | * Note that HTTP proxies are by nature typically network-dependent, and setting a global |
| 3406 | * proxy is likely to break networking on multiple networks. This method is only meant |
| 3407 | * for device policy clients looking to do general internal filtering or similar use cases. |
| 3408 | * |
| 3409 | * {@see #getGlobalProxy} |
| 3410 | * {@see LinkProperties#getHttpProxy} |
| 3411 | * |
| 3412 | * @param p A {@link ProxyInfo} object defining the new global HTTP proxy. Calling this |
| 3413 | * method with a {@code null} value will clear the global HTTP proxy. |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 3414 | * @hide |
| 3415 | */ |
Chalard Jean | e1ce6ae | 2021-03-17 17:03:34 +0900 | [diff] [blame] | 3416 | // Used by Device Policy Manager to set the global proxy. |
Chiachang Wang | f9294e7 | 2021-03-18 09:44:34 +0800 | [diff] [blame] | 3417 | @SystemApi(client = MODULE_LIBRARIES) |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 3418 | @RequiresPermission(android.Manifest.permission.NETWORK_STACK) |
Chalard Jean | e1ce6ae | 2021-03-17 17:03:34 +0900 | [diff] [blame] | 3419 | public void setGlobalProxy(@Nullable final ProxyInfo p) { |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 3420 | try { |
| 3421 | mService.setGlobalProxy(p); |
| 3422 | } catch (RemoteException e) { |
| 3423 | throw e.rethrowFromSystemServer(); |
| 3424 | } |
| 3425 | } |
| 3426 | |
| 3427 | /** |
| 3428 | * Retrieve any network-independent global HTTP proxy. |
| 3429 | * |
| 3430 | * @return {@link ProxyInfo} for the current global HTTP proxy or {@code null} |
| 3431 | * if no global HTTP proxy is set. |
| 3432 | * @hide |
| 3433 | */ |
Chiachang Wang | f9294e7 | 2021-03-18 09:44:34 +0800 | [diff] [blame] | 3434 | @SystemApi(client = MODULE_LIBRARIES) |
| 3435 | @Nullable |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 3436 | public ProxyInfo getGlobalProxy() { |
| 3437 | try { |
| 3438 | return mService.getGlobalProxy(); |
| 3439 | } catch (RemoteException e) { |
| 3440 | throw e.rethrowFromSystemServer(); |
| 3441 | } |
| 3442 | } |
| 3443 | |
| 3444 | /** |
| 3445 | * Retrieve the global HTTP proxy, or if no global HTTP proxy is set, a |
| 3446 | * network-specific HTTP proxy. If {@code network} is null, the |
| 3447 | * network-specific proxy returned is the proxy of the default active |
| 3448 | * network. |
| 3449 | * |
| 3450 | * @return {@link ProxyInfo} for the current global HTTP proxy, or if no |
| 3451 | * global HTTP proxy is set, {@code ProxyInfo} for {@code network}, |
| 3452 | * or when {@code network} is {@code null}, |
| 3453 | * the {@code ProxyInfo} for the default active network. Returns |
| 3454 | * {@code null} when no proxy applies or the caller doesn't have |
| 3455 | * permission to use {@code network}. |
| 3456 | * @hide |
| 3457 | */ |
| 3458 | public ProxyInfo getProxyForNetwork(Network network) { |
| 3459 | try { |
| 3460 | return mService.getProxyForNetwork(network); |
| 3461 | } catch (RemoteException e) { |
| 3462 | throw e.rethrowFromSystemServer(); |
| 3463 | } |
| 3464 | } |
| 3465 | |
| 3466 | /** |
| 3467 | * Get the current default HTTP proxy settings. If a global proxy is set it will be returned, |
| 3468 | * otherwise if this process is bound to a {@link Network} using |
| 3469 | * {@link #bindProcessToNetwork} then that {@code Network}'s proxy is returned, otherwise |
| 3470 | * the default network's proxy is returned. |
| 3471 | * |
| 3472 | * @return the {@link ProxyInfo} for the current HTTP proxy, or {@code null} if no |
| 3473 | * HTTP proxy is active. |
| 3474 | */ |
| 3475 | @Nullable |
| 3476 | public ProxyInfo getDefaultProxy() { |
| 3477 | return getProxyForNetwork(getBoundNetworkForProcess()); |
| 3478 | } |
| 3479 | |
| 3480 | /** |
| 3481 | * Returns true if the hardware supports the given network type |
| 3482 | * else it returns false. This doesn't indicate we have coverage |
| 3483 | * or are authorized onto a network, just whether or not the |
| 3484 | * hardware supports it. For example a GSM phone without a SIM |
| 3485 | * should still return {@code true} for mobile data, but a wifi only |
| 3486 | * tablet would return {@code false}. |
| 3487 | * |
| 3488 | * @param networkType The network type we'd like to check |
| 3489 | * @return {@code true} if supported, else {@code false} |
| 3490 | * @deprecated Types are deprecated. Use {@link NetworkCapabilities} instead. |
| 3491 | * @hide |
| 3492 | */ |
| 3493 | @Deprecated |
| 3494 | @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE) |
| 3495 | @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 130143562) |
| 3496 | public boolean isNetworkSupported(int networkType) { |
| 3497 | try { |
| 3498 | return mService.isNetworkSupported(networkType); |
| 3499 | } catch (RemoteException e) { |
| 3500 | throw e.rethrowFromSystemServer(); |
| 3501 | } |
| 3502 | } |
| 3503 | |
| 3504 | /** |
| 3505 | * Returns if the currently active data network is metered. A network is |
| 3506 | * classified as metered when the user is sensitive to heavy data usage on |
| 3507 | * that connection due to monetary costs, data limitations or |
| 3508 | * battery/performance issues. You should check this before doing large |
| 3509 | * data transfers, and warn the user or delay the operation until another |
| 3510 | * network is available. |
| 3511 | * |
| 3512 | * @return {@code true} if large transfers should be avoided, otherwise |
| 3513 | * {@code false}. |
| 3514 | */ |
| 3515 | @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE) |
| 3516 | public boolean isActiveNetworkMetered() { |
| 3517 | try { |
| 3518 | return mService.isActiveNetworkMetered(); |
| 3519 | } catch (RemoteException e) { |
| 3520 | throw e.rethrowFromSystemServer(); |
| 3521 | } |
| 3522 | } |
| 3523 | |
| 3524 | /** |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 3525 | * Set sign in error notification to visible or invisible |
| 3526 | * |
| 3527 | * @hide |
| 3528 | * @deprecated Doesn't properly deal with multiple connected networks of the same type. |
| 3529 | */ |
| 3530 | @Deprecated |
| 3531 | public void setProvisioningNotificationVisible(boolean visible, int networkType, |
| 3532 | String action) { |
| 3533 | try { |
| 3534 | mService.setProvisioningNotificationVisible(visible, networkType, action); |
| 3535 | } catch (RemoteException e) { |
| 3536 | throw e.rethrowFromSystemServer(); |
| 3537 | } |
| 3538 | } |
| 3539 | |
| 3540 | /** |
| 3541 | * Set the value for enabling/disabling airplane mode |
| 3542 | * |
| 3543 | * @param enable whether to enable airplane mode or not |
| 3544 | * |
| 3545 | * @hide |
| 3546 | */ |
| 3547 | @RequiresPermission(anyOf = { |
| 3548 | android.Manifest.permission.NETWORK_AIRPLANE_MODE, |
| 3549 | android.Manifest.permission.NETWORK_SETTINGS, |
| 3550 | android.Manifest.permission.NETWORK_SETUP_WIZARD, |
| 3551 | android.Manifest.permission.NETWORK_STACK}) |
| 3552 | @SystemApi |
| 3553 | public void setAirplaneMode(boolean enable) { |
| 3554 | try { |
| 3555 | mService.setAirplaneMode(enable); |
| 3556 | } catch (RemoteException e) { |
| 3557 | throw e.rethrowFromSystemServer(); |
| 3558 | } |
| 3559 | } |
| 3560 | |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 3561 | /** |
| 3562 | * Registers the specified {@link NetworkProvider}. |
| 3563 | * Each listener must only be registered once. The listener can be unregistered with |
| 3564 | * {@link #unregisterNetworkProvider}. |
| 3565 | * |
| 3566 | * @param provider the provider to register |
| 3567 | * @return the ID of the provider. This ID must be used by the provider when registering |
| 3568 | * {@link android.net.NetworkAgent}s. |
| 3569 | * @hide |
| 3570 | */ |
| 3571 | @SystemApi |
| 3572 | @RequiresPermission(anyOf = { |
| 3573 | NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK, |
| 3574 | android.Manifest.permission.NETWORK_FACTORY}) |
| 3575 | public int registerNetworkProvider(@NonNull NetworkProvider provider) { |
| 3576 | if (provider.getProviderId() != NetworkProvider.ID_NONE) { |
| 3577 | throw new IllegalStateException("NetworkProviders can only be registered once"); |
| 3578 | } |
| 3579 | |
| 3580 | try { |
| 3581 | int providerId = mService.registerNetworkProvider(provider.getMessenger(), |
| 3582 | provider.getName()); |
| 3583 | provider.setProviderId(providerId); |
| 3584 | } catch (RemoteException e) { |
| 3585 | throw e.rethrowFromSystemServer(); |
| 3586 | } |
| 3587 | return provider.getProviderId(); |
| 3588 | } |
| 3589 | |
| 3590 | /** |
| 3591 | * Unregisters the specified NetworkProvider. |
| 3592 | * |
| 3593 | * @param provider the provider to unregister |
| 3594 | * @hide |
| 3595 | */ |
| 3596 | @SystemApi |
| 3597 | @RequiresPermission(anyOf = { |
| 3598 | NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK, |
| 3599 | android.Manifest.permission.NETWORK_FACTORY}) |
| 3600 | public void unregisterNetworkProvider(@NonNull NetworkProvider provider) { |
| 3601 | try { |
| 3602 | mService.unregisterNetworkProvider(provider.getMessenger()); |
| 3603 | } catch (RemoteException e) { |
| 3604 | throw e.rethrowFromSystemServer(); |
| 3605 | } |
| 3606 | provider.setProviderId(NetworkProvider.ID_NONE); |
| 3607 | } |
| 3608 | |
Chalard Jean | d1b498b | 2021-01-05 08:40:09 +0900 | [diff] [blame] | 3609 | /** |
| 3610 | * Register or update a network offer with ConnectivityService. |
| 3611 | * |
| 3612 | * ConnectivityService keeps track of offers made by the various providers and matches |
Chalard Jean | 61e231f | 2021-03-24 17:43:10 +0900 | [diff] [blame] | 3613 | * them to networking requests made by apps or the system. A callback identifies an offer |
| 3614 | * uniquely, and later calls with the same callback update the offer. The provider supplies a |
| 3615 | * score and the capabilities of the network it might be able to bring up ; these act as |
| 3616 | * filters used by ConnectivityService to only send those requests that can be fulfilled by the |
Chalard Jean | d1b498b | 2021-01-05 08:40:09 +0900 | [diff] [blame] | 3617 | * provider. |
| 3618 | * |
| 3619 | * The provider is under no obligation to be able to bring up the network it offers at any |
| 3620 | * given time. Instead, this mechanism is meant to limit requests received by providers |
| 3621 | * to those they actually have a chance to fulfill, as providers don't have a way to compare |
| 3622 | * the quality of the network satisfying a given request to their own offer. |
| 3623 | * |
| 3624 | * An offer can be updated by calling this again with the same callback object. This is |
| 3625 | * similar to calling unofferNetwork and offerNetwork again, but will only update the |
| 3626 | * provider with the changes caused by the changes in the offer. |
| 3627 | * |
| 3628 | * @param provider The provider making this offer. |
| 3629 | * @param score The prospective score of the network. |
| 3630 | * @param caps The prospective capabilities of the network. |
| 3631 | * @param callback The callback to call when this offer is needed or unneeded. |
Chalard Jean | 428b913 | 2021-01-12 10:58:56 +0900 | [diff] [blame] | 3632 | * @hide exposed via the NetworkProvider class. |
Chalard Jean | d1b498b | 2021-01-05 08:40:09 +0900 | [diff] [blame] | 3633 | */ |
| 3634 | @RequiresPermission(anyOf = { |
| 3635 | NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK, |
| 3636 | android.Manifest.permission.NETWORK_FACTORY}) |
Chalard Jean | 148dcce | 2021-03-22 22:44:02 +0900 | [diff] [blame] | 3637 | public void offerNetwork(@NonNull final int providerId, |
Chalard Jean | d1b498b | 2021-01-05 08:40:09 +0900 | [diff] [blame] | 3638 | @NonNull final NetworkScore score, @NonNull final NetworkCapabilities caps, |
| 3639 | @NonNull final INetworkOfferCallback callback) { |
| 3640 | try { |
Chalard Jean | 148dcce | 2021-03-22 22:44:02 +0900 | [diff] [blame] | 3641 | mService.offerNetwork(providerId, |
Chalard Jean | d1b498b | 2021-01-05 08:40:09 +0900 | [diff] [blame] | 3642 | Objects.requireNonNull(score, "null score"), |
| 3643 | Objects.requireNonNull(caps, "null caps"), |
| 3644 | Objects.requireNonNull(callback, "null callback")); |
| 3645 | } catch (RemoteException e) { |
| 3646 | throw e.rethrowFromSystemServer(); |
| 3647 | } |
| 3648 | } |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 3649 | |
Chalard Jean | d1b498b | 2021-01-05 08:40:09 +0900 | [diff] [blame] | 3650 | /** |
| 3651 | * Withdraw a network offer made with {@link #offerNetwork}. |
| 3652 | * |
| 3653 | * @param callback The callback passed at registration time. This must be the same object |
| 3654 | * that was passed to {@link #offerNetwork} |
Chalard Jean | 428b913 | 2021-01-12 10:58:56 +0900 | [diff] [blame] | 3655 | * @hide exposed via the NetworkProvider class. |
Chalard Jean | d1b498b | 2021-01-05 08:40:09 +0900 | [diff] [blame] | 3656 | */ |
| 3657 | public void unofferNetwork(@NonNull final INetworkOfferCallback callback) { |
| 3658 | try { |
| 3659 | mService.unofferNetwork(Objects.requireNonNull(callback)); |
| 3660 | } catch (RemoteException e) { |
| 3661 | throw e.rethrowFromSystemServer(); |
| 3662 | } |
| 3663 | } |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 3664 | /** @hide exposed via the NetworkProvider class. */ |
| 3665 | @RequiresPermission(anyOf = { |
| 3666 | NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK, |
| 3667 | android.Manifest.permission.NETWORK_FACTORY}) |
| 3668 | public void declareNetworkRequestUnfulfillable(@NonNull NetworkRequest request) { |
| 3669 | try { |
| 3670 | mService.declareNetworkRequestUnfulfillable(request); |
| 3671 | } catch (RemoteException e) { |
| 3672 | throw e.rethrowFromSystemServer(); |
| 3673 | } |
| 3674 | } |
| 3675 | |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 3676 | /** |
| 3677 | * @hide |
| 3678 | * Register a NetworkAgent with ConnectivityService. |
| 3679 | * @return Network corresponding to NetworkAgent. |
| 3680 | */ |
| 3681 | @RequiresPermission(anyOf = { |
| 3682 | NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK, |
| 3683 | android.Manifest.permission.NETWORK_FACTORY}) |
| 3684 | public Network registerNetworkAgent(INetworkAgent na, NetworkInfo ni, LinkProperties lp, |
Chalard Jean | d637272 | 2020-12-21 18:36:52 +0900 | [diff] [blame] | 3685 | NetworkCapabilities nc, @NonNull NetworkScore score, NetworkAgentConfig config, |
| 3686 | int providerId) { |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 3687 | try { |
| 3688 | return mService.registerNetworkAgent(na, ni, lp, nc, score, config, providerId); |
| 3689 | } catch (RemoteException e) { |
| 3690 | throw e.rethrowFromSystemServer(); |
| 3691 | } |
| 3692 | } |
| 3693 | |
| 3694 | /** |
| 3695 | * Base class for {@code NetworkRequest} callbacks. Used for notifications about network |
| 3696 | * changes. Should be extended by applications wanting notifications. |
| 3697 | * |
| 3698 | * A {@code NetworkCallback} is registered by calling |
| 3699 | * {@link #requestNetwork(NetworkRequest, NetworkCallback)}, |
| 3700 | * {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)}, |
| 3701 | * or {@link #registerDefaultNetworkCallback(NetworkCallback)}. A {@code NetworkCallback} is |
| 3702 | * unregistered by calling {@link #unregisterNetworkCallback(NetworkCallback)}. |
| 3703 | * A {@code NetworkCallback} should be registered at most once at any time. |
| 3704 | * A {@code NetworkCallback} that has been unregistered can be registered again. |
| 3705 | */ |
| 3706 | public static class NetworkCallback { |
| 3707 | /** |
Roshan Pius | e08bc18 | 2020-12-22 15:10:42 -0800 | [diff] [blame] | 3708 | * No flags associated with this callback. |
| 3709 | * @hide |
| 3710 | */ |
| 3711 | public static final int FLAG_NONE = 0; |
lucaslin | c582d50 | 2022-01-27 09:07:00 +0800 | [diff] [blame] | 3712 | |
Roshan Pius | e08bc18 | 2020-12-22 15:10:42 -0800 | [diff] [blame] | 3713 | /** |
lucaslin | c582d50 | 2022-01-27 09:07:00 +0800 | [diff] [blame] | 3714 | * Inclusion of this flag means location-sensitive redaction requests keeping location info. |
| 3715 | * |
| 3716 | * Some objects like {@link NetworkCapabilities} may contain location-sensitive information. |
| 3717 | * Prior to Android 12, this information is always returned to apps holding the appropriate |
| 3718 | * permission, possibly noting that the app has used location. |
| 3719 | * <p>In Android 12 and above, by default the sent objects do not contain any location |
| 3720 | * information, even if the app holds the necessary permissions, and the system does not |
| 3721 | * take note of location usage by the app. Apps can request that location information is |
| 3722 | * included, in which case the system will check location permission and the location |
| 3723 | * toggle state, and take note of location usage by the app if any such information is |
| 3724 | * returned. |
| 3725 | * |
Roshan Pius | e08bc18 | 2020-12-22 15:10:42 -0800 | [diff] [blame] | 3726 | * Use this flag to include any location sensitive data in {@link NetworkCapabilities} sent |
| 3727 | * via {@link #onCapabilitiesChanged(Network, NetworkCapabilities)}. |
| 3728 | * <p> |
| 3729 | * These include: |
| 3730 | * <li> Some transport info instances (retrieved via |
| 3731 | * {@link NetworkCapabilities#getTransportInfo()}) like {@link android.net.wifi.WifiInfo} |
| 3732 | * contain location sensitive information. |
| 3733 | * <li> OwnerUid (retrieved via {@link NetworkCapabilities#getOwnerUid()} is location |
Anton Hansson | df40109 | 2021-10-20 11:27:13 +0100 | [diff] [blame] | 3734 | * sensitive for wifi suggestor apps (i.e using |
| 3735 | * {@link android.net.wifi.WifiNetworkSuggestion WifiNetworkSuggestion}).</li> |
Roshan Pius | e08bc18 | 2020-12-22 15:10:42 -0800 | [diff] [blame] | 3736 | * </p> |
| 3737 | * <p> |
| 3738 | * Note: |
| 3739 | * <li> Retrieving this location sensitive information (subject to app's location |
| 3740 | * permissions) will be noted by system. </li> |
| 3741 | * <li> Without this flag any {@link NetworkCapabilities} provided via the callback does |
lucaslin | c582d50 | 2022-01-27 09:07:00 +0800 | [diff] [blame] | 3742 | * not include location sensitive information. |
Roshan Pius | e08bc18 | 2020-12-22 15:10:42 -0800 | [diff] [blame] | 3743 | */ |
Roshan Pius | 189d009 | 2021-03-11 21:16:44 -0800 | [diff] [blame] | 3744 | // Note: Some existing fields which are location sensitive may still be included without |
| 3745 | // this flag if the app targets SDK < S (to maintain backwards compatibility). |
Roshan Pius | e08bc18 | 2020-12-22 15:10:42 -0800 | [diff] [blame] | 3746 | public static final int FLAG_INCLUDE_LOCATION_INFO = 1 << 0; |
| 3747 | |
| 3748 | /** @hide */ |
| 3749 | @Retention(RetentionPolicy.SOURCE) |
| 3750 | @IntDef(flag = true, prefix = "FLAG_", value = { |
| 3751 | FLAG_NONE, |
| 3752 | FLAG_INCLUDE_LOCATION_INFO |
| 3753 | }) |
| 3754 | public @interface Flag { } |
| 3755 | |
| 3756 | /** |
| 3757 | * All the valid flags for error checking. |
| 3758 | */ |
| 3759 | private static final int VALID_FLAGS = FLAG_INCLUDE_LOCATION_INFO; |
| 3760 | |
| 3761 | public NetworkCallback() { |
| 3762 | this(FLAG_NONE); |
| 3763 | } |
| 3764 | |
| 3765 | public NetworkCallback(@Flag int flags) { |
Remi NGUYEN VAN | 1818dbb | 2021-03-15 07:31:54 +0000 | [diff] [blame] | 3766 | if ((flags & VALID_FLAGS) != flags) { |
| 3767 | throw new IllegalArgumentException("Invalid flags"); |
| 3768 | } |
Roshan Pius | e08bc18 | 2020-12-22 15:10:42 -0800 | [diff] [blame] | 3769 | mFlags = flags; |
| 3770 | } |
| 3771 | |
| 3772 | /** |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 3773 | * Called when the framework connects to a new network to evaluate whether it satisfies this |
| 3774 | * request. If evaluation succeeds, this callback may be followed by an {@link #onAvailable} |
| 3775 | * callback. There is no guarantee that this new network will satisfy any requests, or that |
| 3776 | * the network will stay connected for longer than the time necessary to evaluate it. |
| 3777 | * <p> |
| 3778 | * Most applications <b>should not</b> act on this callback, and should instead use |
| 3779 | * {@link #onAvailable}. This callback is intended for use by applications that can assist |
| 3780 | * the framework in properly evaluating the network — for example, an application that |
| 3781 | * can automatically log in to a captive portal without user intervention. |
| 3782 | * |
| 3783 | * @param network The {@link Network} of the network that is being evaluated. |
| 3784 | * |
| 3785 | * @hide |
| 3786 | */ |
| 3787 | public void onPreCheck(@NonNull Network network) {} |
| 3788 | |
| 3789 | /** |
| 3790 | * Called when the framework connects and has declared a new network ready for use. |
| 3791 | * This callback may be called more than once if the {@link Network} that is |
| 3792 | * satisfying the request changes. |
| 3793 | * |
| 3794 | * @param network The {@link Network} of the satisfying network. |
| 3795 | * @param networkCapabilities The {@link NetworkCapabilities} of the satisfying network. |
| 3796 | * @param linkProperties The {@link LinkProperties} of the satisfying network. |
| 3797 | * @param blocked Whether access to the {@link Network} is blocked due to system policy. |
| 3798 | * @hide |
| 3799 | */ |
Lorenzo Colitti | 8ad5812 | 2021-03-18 00:54:57 +0900 | [diff] [blame] | 3800 | public final void onAvailable(@NonNull Network network, |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 3801 | @NonNull NetworkCapabilities networkCapabilities, |
Lorenzo Colitti | 8ad5812 | 2021-03-18 00:54:57 +0900 | [diff] [blame] | 3802 | @NonNull LinkProperties linkProperties, @BlockedReason int blocked) { |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 3803 | // Internally only this method is called when a new network is available, and |
| 3804 | // it calls the callback in the same way and order that older versions used |
| 3805 | // to call so as not to change the behavior. |
Lorenzo Colitti | 8ad5812 | 2021-03-18 00:54:57 +0900 | [diff] [blame] | 3806 | onAvailable(network, networkCapabilities, linkProperties, blocked != 0); |
| 3807 | onBlockedStatusChanged(network, blocked); |
| 3808 | } |
| 3809 | |
| 3810 | /** |
| 3811 | * Legacy variant of onAvailable that takes a boolean blocked reason. |
| 3812 | * |
| 3813 | * This method has never been public API, but it's not final, so there may be apps that |
| 3814 | * implemented it and rely on it being called. Do our best not to break them. |
| 3815 | * Note: such apps will also get a second call to onBlockedStatusChanged immediately after |
| 3816 | * this method is called. There does not seem to be a way to avoid this. |
| 3817 | * TODO: add a compat check to move apps off this method, and eventually stop calling it. |
| 3818 | * |
| 3819 | * @hide |
| 3820 | */ |
| 3821 | public void onAvailable(@NonNull Network network, |
| 3822 | @NonNull NetworkCapabilities networkCapabilities, |
| 3823 | @NonNull LinkProperties linkProperties, boolean blocked) { |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 3824 | onAvailable(network); |
| 3825 | if (!networkCapabilities.hasCapability( |
| 3826 | NetworkCapabilities.NET_CAPABILITY_NOT_SUSPENDED)) { |
| 3827 | onNetworkSuspended(network); |
| 3828 | } |
| 3829 | onCapabilitiesChanged(network, networkCapabilities); |
| 3830 | onLinkPropertiesChanged(network, linkProperties); |
Lorenzo Colitti | 8ad5812 | 2021-03-18 00:54:57 +0900 | [diff] [blame] | 3831 | // No call to onBlockedStatusChanged here. That is done by the caller. |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 3832 | } |
| 3833 | |
| 3834 | /** |
| 3835 | * Called when the framework connects and has declared a new network ready for use. |
| 3836 | * |
| 3837 | * <p>For callbacks registered with {@link #registerNetworkCallback}, multiple networks may |
| 3838 | * be available at the same time, and onAvailable will be called for each of these as they |
| 3839 | * appear. |
| 3840 | * |
| 3841 | * <p>For callbacks registered with {@link #requestNetwork} and |
| 3842 | * {@link #registerDefaultNetworkCallback}, this means the network passed as an argument |
| 3843 | * is the new best network for this request and is now tracked by this callback ; this |
| 3844 | * callback will no longer receive method calls about other networks that may have been |
| 3845 | * passed to this method previously. The previously-best network may have disconnected, or |
| 3846 | * it may still be around and the newly-best network may simply be better. |
| 3847 | * |
| 3848 | * <p>Starting with {@link android.os.Build.VERSION_CODES#O}, this will always immediately |
| 3849 | * be followed by a call to {@link #onCapabilitiesChanged(Network, NetworkCapabilities)} |
| 3850 | * then by a call to {@link #onLinkPropertiesChanged(Network, LinkProperties)}, and a call |
| 3851 | * to {@link #onBlockedStatusChanged(Network, boolean)}. |
| 3852 | * |
| 3853 | * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or |
| 3854 | * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in |
| 3855 | * this callback as this is prone to race conditions (there is no guarantee the objects |
| 3856 | * returned by these methods will be current). Instead, wait for a call to |
| 3857 | * {@link #onCapabilitiesChanged(Network, NetworkCapabilities)} and |
| 3858 | * {@link #onLinkPropertiesChanged(Network, LinkProperties)} whose arguments are guaranteed |
| 3859 | * to be well-ordered with respect to other callbacks. |
| 3860 | * |
| 3861 | * @param network The {@link Network} of the satisfying network. |
| 3862 | */ |
| 3863 | public void onAvailable(@NonNull Network network) {} |
| 3864 | |
| 3865 | /** |
| 3866 | * Called when the network is about to be lost, typically because there are no outstanding |
| 3867 | * requests left for it. This may be paired with a {@link NetworkCallback#onAvailable} call |
| 3868 | * with the new replacement network for graceful handover. This method is not guaranteed |
| 3869 | * to be called before {@link NetworkCallback#onLost} is called, for example in case a |
| 3870 | * network is suddenly disconnected. |
| 3871 | * |
| 3872 | * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or |
| 3873 | * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in |
| 3874 | * this callback as this is prone to race conditions ; calling these methods while in a |
| 3875 | * callback may return an outdated or even a null object. |
| 3876 | * |
| 3877 | * @param network The {@link Network} that is about to be lost. |
| 3878 | * @param maxMsToLive The time in milliseconds the system intends to keep the network |
| 3879 | * connected for graceful handover; note that the network may still |
| 3880 | * suffer a hard loss at any time. |
| 3881 | */ |
| 3882 | public void onLosing(@NonNull Network network, int maxMsToLive) {} |
| 3883 | |
| 3884 | /** |
| 3885 | * Called when a network disconnects or otherwise no longer satisfies this request or |
| 3886 | * callback. |
| 3887 | * |
| 3888 | * <p>If the callback was registered with requestNetwork() or |
| 3889 | * registerDefaultNetworkCallback(), it will only be invoked against the last network |
| 3890 | * returned by onAvailable() when that network is lost and no other network satisfies |
| 3891 | * the criteria of the request. |
| 3892 | * |
| 3893 | * <p>If the callback was registered with registerNetworkCallback() it will be called for |
| 3894 | * each network which no longer satisfies the criteria of the callback. |
| 3895 | * |
| 3896 | * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or |
| 3897 | * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in |
| 3898 | * this callback as this is prone to race conditions ; calling these methods while in a |
| 3899 | * callback may return an outdated or even a null object. |
| 3900 | * |
| 3901 | * @param network The {@link Network} lost. |
| 3902 | */ |
| 3903 | public void onLost(@NonNull Network network) {} |
| 3904 | |
| 3905 | /** |
| 3906 | * Called if no network is found within the timeout time specified in |
| 3907 | * {@link #requestNetwork(NetworkRequest, NetworkCallback, int)} call or if the |
| 3908 | * requested network request cannot be fulfilled (whether or not a timeout was |
| 3909 | * specified). When this callback is invoked the associated |
| 3910 | * {@link NetworkRequest} will have already been removed and released, as if |
| 3911 | * {@link #unregisterNetworkCallback(NetworkCallback)} had been called. |
| 3912 | */ |
| 3913 | public void onUnavailable() {} |
| 3914 | |
| 3915 | /** |
| 3916 | * Called when the network corresponding to this request changes capabilities but still |
| 3917 | * satisfies the requested criteria. |
| 3918 | * |
| 3919 | * <p>Starting with {@link android.os.Build.VERSION_CODES#O} this method is guaranteed |
| 3920 | * to be called immediately after {@link #onAvailable}. |
| 3921 | * |
| 3922 | * <p>Do NOT call {@link #getLinkProperties(Network)} or other synchronous |
| 3923 | * ConnectivityManager methods in this callback as this is prone to race conditions : |
| 3924 | * calling these methods while in a callback may return an outdated or even a null object. |
| 3925 | * |
| 3926 | * @param network The {@link Network} whose capabilities have changed. |
Roshan Pius | e08bc18 | 2020-12-22 15:10:42 -0800 | [diff] [blame] | 3927 | * @param networkCapabilities The new {@link NetworkCapabilities} for this |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 3928 | * network. |
| 3929 | */ |
| 3930 | public void onCapabilitiesChanged(@NonNull Network network, |
| 3931 | @NonNull NetworkCapabilities networkCapabilities) {} |
| 3932 | |
| 3933 | /** |
| 3934 | * Called when the network corresponding to this request changes {@link LinkProperties}. |
| 3935 | * |
| 3936 | * <p>Starting with {@link android.os.Build.VERSION_CODES#O} this method is guaranteed |
| 3937 | * to be called immediately after {@link #onAvailable}. |
| 3938 | * |
| 3939 | * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or other synchronous |
| 3940 | * ConnectivityManager methods in this callback as this is prone to race conditions : |
| 3941 | * calling these methods while in a callback may return an outdated or even a null object. |
| 3942 | * |
| 3943 | * @param network The {@link Network} whose link properties have changed. |
| 3944 | * @param linkProperties The new {@link LinkProperties} for this network. |
| 3945 | */ |
| 3946 | public void onLinkPropertiesChanged(@NonNull Network network, |
| 3947 | @NonNull LinkProperties linkProperties) {} |
| 3948 | |
| 3949 | /** |
| 3950 | * Called when the network the framework connected to for this request suspends data |
| 3951 | * transmission temporarily. |
| 3952 | * |
| 3953 | * <p>This generally means that while the TCP connections are still live temporarily |
| 3954 | * network data fails to transfer. To give a specific example, this is used on cellular |
| 3955 | * networks to mask temporary outages when driving through a tunnel, etc. In general this |
| 3956 | * means read operations on sockets on this network will block once the buffers are |
| 3957 | * drained, and write operations will block once the buffers are full. |
| 3958 | * |
| 3959 | * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or |
| 3960 | * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in |
| 3961 | * this callback as this is prone to race conditions (there is no guarantee the objects |
| 3962 | * returned by these methods will be current). |
| 3963 | * |
| 3964 | * @hide |
| 3965 | */ |
| 3966 | public void onNetworkSuspended(@NonNull Network network) {} |
| 3967 | |
| 3968 | /** |
| 3969 | * Called when the network the framework connected to for this request |
| 3970 | * returns from a {@link NetworkInfo.State#SUSPENDED} state. This should always be |
| 3971 | * preceded by a matching {@link NetworkCallback#onNetworkSuspended} call. |
| 3972 | |
| 3973 | * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or |
| 3974 | * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in |
| 3975 | * this callback as this is prone to race conditions : calling these methods while in a |
| 3976 | * callback may return an outdated or even a null object. |
| 3977 | * |
| 3978 | * @hide |
| 3979 | */ |
| 3980 | public void onNetworkResumed(@NonNull Network network) {} |
| 3981 | |
| 3982 | /** |
| 3983 | * Called when access to the specified network is blocked or unblocked. |
| 3984 | * |
| 3985 | * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or |
| 3986 | * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in |
| 3987 | * this callback as this is prone to race conditions : calling these methods while in a |
| 3988 | * callback may return an outdated or even a null object. |
| 3989 | * |
| 3990 | * @param network The {@link Network} whose blocked status has changed. |
| 3991 | * @param blocked The blocked status of this {@link Network}. |
| 3992 | */ |
| 3993 | public void onBlockedStatusChanged(@NonNull Network network, boolean blocked) {} |
| 3994 | |
Lorenzo Colitti | 8ad5812 | 2021-03-18 00:54:57 +0900 | [diff] [blame] | 3995 | /** |
Lorenzo Colitti | a1bd6f6 | 2021-03-25 23:17:36 +0900 | [diff] [blame] | 3996 | * Called when access to the specified network is blocked or unblocked, or the reason for |
| 3997 | * access being blocked changes. |
Lorenzo Colitti | 8ad5812 | 2021-03-18 00:54:57 +0900 | [diff] [blame] | 3998 | * |
| 3999 | * If a NetworkCallback object implements this method, |
| 4000 | * {@link #onBlockedStatusChanged(Network, boolean)} will not be called. |
| 4001 | * |
| 4002 | * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or |
| 4003 | * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in |
| 4004 | * this callback as this is prone to race conditions : calling these methods while in a |
| 4005 | * callback may return an outdated or even a null object. |
| 4006 | * |
| 4007 | * @param network The {@link Network} whose blocked status has changed. |
| 4008 | * @param blocked The blocked status of this {@link Network}. |
| 4009 | * @hide |
| 4010 | */ |
| 4011 | @SystemApi(client = MODULE_LIBRARIES) |
| 4012 | public void onBlockedStatusChanged(@NonNull Network network, @BlockedReason int blocked) { |
| 4013 | onBlockedStatusChanged(network, blocked != 0); |
| 4014 | } |
| 4015 | |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 4016 | private NetworkRequest networkRequest; |
Roshan Pius | e08bc18 | 2020-12-22 15:10:42 -0800 | [diff] [blame] | 4017 | private final int mFlags; |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 4018 | } |
| 4019 | |
| 4020 | /** |
| 4021 | * Constant error codes used by ConnectivityService to communicate about failures and errors |
| 4022 | * across a Binder boundary. |
| 4023 | * @hide |
| 4024 | */ |
| 4025 | public interface Errors { |
| 4026 | int TOO_MANY_REQUESTS = 1; |
| 4027 | } |
| 4028 | |
| 4029 | /** @hide */ |
| 4030 | public static class TooManyRequestsException extends RuntimeException {} |
| 4031 | |
| 4032 | private static RuntimeException convertServiceException(ServiceSpecificException e) { |
| 4033 | switch (e.errorCode) { |
| 4034 | case Errors.TOO_MANY_REQUESTS: |
| 4035 | return new TooManyRequestsException(); |
| 4036 | default: |
| 4037 | Log.w(TAG, "Unknown service error code " + e.errorCode); |
| 4038 | return new RuntimeException(e); |
| 4039 | } |
| 4040 | } |
| 4041 | |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 4042 | /** @hide */ |
Remi NGUYEN VAN | 1b9f03a | 2021-03-12 15:24:06 +0900 | [diff] [blame] | 4043 | public static final int CALLBACK_PRECHECK = 1; |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 4044 | /** @hide */ |
Remi NGUYEN VAN | 1b9f03a | 2021-03-12 15:24:06 +0900 | [diff] [blame] | 4045 | public static final int CALLBACK_AVAILABLE = 2; |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 4046 | /** @hide arg1 = TTL */ |
Remi NGUYEN VAN | 1b9f03a | 2021-03-12 15:24:06 +0900 | [diff] [blame] | 4047 | public static final int CALLBACK_LOSING = 3; |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 4048 | /** @hide */ |
Remi NGUYEN VAN | 1b9f03a | 2021-03-12 15:24:06 +0900 | [diff] [blame] | 4049 | public static final int CALLBACK_LOST = 4; |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 4050 | /** @hide */ |
Remi NGUYEN VAN | 1b9f03a | 2021-03-12 15:24:06 +0900 | [diff] [blame] | 4051 | public static final int CALLBACK_UNAVAIL = 5; |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 4052 | /** @hide */ |
Remi NGUYEN VAN | 1b9f03a | 2021-03-12 15:24:06 +0900 | [diff] [blame] | 4053 | public static final int CALLBACK_CAP_CHANGED = 6; |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 4054 | /** @hide */ |
Remi NGUYEN VAN | 1b9f03a | 2021-03-12 15:24:06 +0900 | [diff] [blame] | 4055 | public static final int CALLBACK_IP_CHANGED = 7; |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 4056 | /** @hide obj = NetworkCapabilities, arg1 = seq number */ |
Remi NGUYEN VAN | 1b9f03a | 2021-03-12 15:24:06 +0900 | [diff] [blame] | 4057 | private static final int EXPIRE_LEGACY_REQUEST = 8; |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 4058 | /** @hide */ |
Remi NGUYEN VAN | 1b9f03a | 2021-03-12 15:24:06 +0900 | [diff] [blame] | 4059 | public static final int CALLBACK_SUSPENDED = 9; |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 4060 | /** @hide */ |
Remi NGUYEN VAN | 1b9f03a | 2021-03-12 15:24:06 +0900 | [diff] [blame] | 4061 | public static final int CALLBACK_RESUMED = 10; |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 4062 | /** @hide */ |
Remi NGUYEN VAN | 1b9f03a | 2021-03-12 15:24:06 +0900 | [diff] [blame] | 4063 | public static final int CALLBACK_BLK_CHANGED = 11; |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 4064 | |
| 4065 | /** @hide */ |
| 4066 | public static String getCallbackName(int whichCallback) { |
| 4067 | switch (whichCallback) { |
| 4068 | case CALLBACK_PRECHECK: return "CALLBACK_PRECHECK"; |
| 4069 | case CALLBACK_AVAILABLE: return "CALLBACK_AVAILABLE"; |
| 4070 | case CALLBACK_LOSING: return "CALLBACK_LOSING"; |
| 4071 | case CALLBACK_LOST: return "CALLBACK_LOST"; |
| 4072 | case CALLBACK_UNAVAIL: return "CALLBACK_UNAVAIL"; |
| 4073 | case CALLBACK_CAP_CHANGED: return "CALLBACK_CAP_CHANGED"; |
| 4074 | case CALLBACK_IP_CHANGED: return "CALLBACK_IP_CHANGED"; |
| 4075 | case EXPIRE_LEGACY_REQUEST: return "EXPIRE_LEGACY_REQUEST"; |
| 4076 | case CALLBACK_SUSPENDED: return "CALLBACK_SUSPENDED"; |
| 4077 | case CALLBACK_RESUMED: return "CALLBACK_RESUMED"; |
| 4078 | case CALLBACK_BLK_CHANGED: return "CALLBACK_BLK_CHANGED"; |
| 4079 | default: |
| 4080 | return Integer.toString(whichCallback); |
| 4081 | } |
| 4082 | } |
| 4083 | |
| 4084 | private class CallbackHandler extends Handler { |
| 4085 | private static final String TAG = "ConnectivityManager.CallbackHandler"; |
| 4086 | private static final boolean DBG = false; |
| 4087 | |
| 4088 | CallbackHandler(Looper looper) { |
| 4089 | super(looper); |
| 4090 | } |
| 4091 | |
| 4092 | CallbackHandler(Handler handler) { |
Remi NGUYEN VAN | 1818dbb | 2021-03-15 07:31:54 +0000 | [diff] [blame] | 4093 | this(Objects.requireNonNull(handler, "Handler cannot be null.").getLooper()); |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 4094 | } |
| 4095 | |
| 4096 | @Override |
| 4097 | public void handleMessage(Message message) { |
| 4098 | if (message.what == EXPIRE_LEGACY_REQUEST) { |
| 4099 | expireRequest((NetworkCapabilities) message.obj, message.arg1); |
| 4100 | return; |
| 4101 | } |
| 4102 | |
| 4103 | final NetworkRequest request = getObject(message, NetworkRequest.class); |
| 4104 | final Network network = getObject(message, Network.class); |
| 4105 | final NetworkCallback callback; |
| 4106 | synchronized (sCallbacks) { |
| 4107 | callback = sCallbacks.get(request); |
| 4108 | if (callback == null) { |
| 4109 | Log.w(TAG, |
| 4110 | "callback not found for " + getCallbackName(message.what) + " message"); |
| 4111 | return; |
| 4112 | } |
| 4113 | if (message.what == CALLBACK_UNAVAIL) { |
| 4114 | sCallbacks.remove(request); |
| 4115 | callback.networkRequest = ALREADY_UNREGISTERED; |
| 4116 | } |
| 4117 | } |
| 4118 | if (DBG) { |
| 4119 | Log.d(TAG, getCallbackName(message.what) + " for network " + network); |
| 4120 | } |
| 4121 | |
| 4122 | switch (message.what) { |
| 4123 | case CALLBACK_PRECHECK: { |
| 4124 | callback.onPreCheck(network); |
| 4125 | break; |
| 4126 | } |
| 4127 | case CALLBACK_AVAILABLE: { |
| 4128 | NetworkCapabilities cap = getObject(message, NetworkCapabilities.class); |
| 4129 | LinkProperties lp = getObject(message, LinkProperties.class); |
Lorenzo Colitti | 8ad5812 | 2021-03-18 00:54:57 +0900 | [diff] [blame] | 4130 | callback.onAvailable(network, cap, lp, message.arg1); |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 4131 | break; |
| 4132 | } |
| 4133 | case CALLBACK_LOSING: { |
| 4134 | callback.onLosing(network, message.arg1); |
| 4135 | break; |
| 4136 | } |
| 4137 | case CALLBACK_LOST: { |
| 4138 | callback.onLost(network); |
| 4139 | break; |
| 4140 | } |
| 4141 | case CALLBACK_UNAVAIL: { |
| 4142 | callback.onUnavailable(); |
| 4143 | break; |
| 4144 | } |
| 4145 | case CALLBACK_CAP_CHANGED: { |
| 4146 | NetworkCapabilities cap = getObject(message, NetworkCapabilities.class); |
| 4147 | callback.onCapabilitiesChanged(network, cap); |
| 4148 | break; |
| 4149 | } |
| 4150 | case CALLBACK_IP_CHANGED: { |
| 4151 | LinkProperties lp = getObject(message, LinkProperties.class); |
| 4152 | callback.onLinkPropertiesChanged(network, lp); |
| 4153 | break; |
| 4154 | } |
| 4155 | case CALLBACK_SUSPENDED: { |
| 4156 | callback.onNetworkSuspended(network); |
| 4157 | break; |
| 4158 | } |
| 4159 | case CALLBACK_RESUMED: { |
| 4160 | callback.onNetworkResumed(network); |
| 4161 | break; |
| 4162 | } |
| 4163 | case CALLBACK_BLK_CHANGED: { |
Lorenzo Colitti | 8ad5812 | 2021-03-18 00:54:57 +0900 | [diff] [blame] | 4164 | callback.onBlockedStatusChanged(network, message.arg1); |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 4165 | } |
| 4166 | } |
| 4167 | } |
| 4168 | |
| 4169 | private <T> T getObject(Message msg, Class<T> c) { |
| 4170 | return (T) msg.getData().getParcelable(c.getSimpleName()); |
| 4171 | } |
| 4172 | } |
| 4173 | |
| 4174 | private CallbackHandler getDefaultHandler() { |
| 4175 | synchronized (sCallbacks) { |
| 4176 | if (sCallbackHandler == null) { |
| 4177 | sCallbackHandler = new CallbackHandler(ConnectivityThread.getInstanceLooper()); |
| 4178 | } |
| 4179 | return sCallbackHandler; |
| 4180 | } |
| 4181 | } |
| 4182 | |
| 4183 | private static final HashMap<NetworkRequest, NetworkCallback> sCallbacks = new HashMap<>(); |
| 4184 | private static CallbackHandler sCallbackHandler; |
| 4185 | |
Lorenzo Colitti | 5f26b19 | 2021-03-12 22:48:07 +0900 | [diff] [blame] | 4186 | private NetworkRequest sendRequestForNetwork(int asUid, NetworkCapabilities need, |
| 4187 | NetworkCallback callback, int timeoutMs, NetworkRequest.Type reqType, int legacyType, |
| 4188 | CallbackHandler handler) { |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 4189 | printStackTrace(); |
| 4190 | checkCallbackNotNull(callback); |
Remi NGUYEN VAN | 1818dbb | 2021-03-15 07:31:54 +0000 | [diff] [blame] | 4191 | if (reqType != TRACK_DEFAULT && reqType != TRACK_SYSTEM_DEFAULT && need == null) { |
| 4192 | throw new IllegalArgumentException("null NetworkCapabilities"); |
| 4193 | } |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 4194 | final NetworkRequest request; |
| 4195 | final String callingPackageName = mContext.getOpPackageName(); |
| 4196 | try { |
| 4197 | synchronized(sCallbacks) { |
| 4198 | if (callback.networkRequest != null |
| 4199 | && callback.networkRequest != ALREADY_UNREGISTERED) { |
| 4200 | // TODO: throw exception instead and enforce 1:1 mapping of callbacks |
| 4201 | // and requests (http://b/20701525). |
| 4202 | Log.e(TAG, "NetworkCallback was already registered"); |
| 4203 | } |
| 4204 | Messenger messenger = new Messenger(handler); |
| 4205 | Binder binder = new Binder(); |
Roshan Pius | e08bc18 | 2020-12-22 15:10:42 -0800 | [diff] [blame] | 4206 | final int callbackFlags = callback.mFlags; |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 4207 | if (reqType == LISTEN) { |
| 4208 | request = mService.listenForNetwork( |
Roshan Pius | e08bc18 | 2020-12-22 15:10:42 -0800 | [diff] [blame] | 4209 | need, messenger, binder, callbackFlags, callingPackageName, |
Roshan Pius | a8a477b | 2020-12-17 14:53:09 -0800 | [diff] [blame] | 4210 | getAttributionTag()); |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 4211 | } else { |
| 4212 | request = mService.requestNetwork( |
Lorenzo Colitti | 5f26b19 | 2021-03-12 22:48:07 +0900 | [diff] [blame] | 4213 | asUid, need, reqType.ordinal(), messenger, timeoutMs, binder, |
| 4214 | legacyType, callbackFlags, callingPackageName, getAttributionTag()); |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 4215 | } |
| 4216 | if (request != null) { |
| 4217 | sCallbacks.put(request, callback); |
| 4218 | } |
| 4219 | callback.networkRequest = request; |
| 4220 | } |
| 4221 | } catch (RemoteException e) { |
| 4222 | throw e.rethrowFromSystemServer(); |
| 4223 | } catch (ServiceSpecificException e) { |
| 4224 | throw convertServiceException(e); |
| 4225 | } |
| 4226 | return request; |
| 4227 | } |
| 4228 | |
Lorenzo Colitti | 5f26b19 | 2021-03-12 22:48:07 +0900 | [diff] [blame] | 4229 | private NetworkRequest sendRequestForNetwork(NetworkCapabilities need, NetworkCallback callback, |
| 4230 | int timeoutMs, NetworkRequest.Type reqType, int legacyType, CallbackHandler handler) { |
| 4231 | return sendRequestForNetwork(Process.INVALID_UID, need, callback, timeoutMs, reqType, |
| 4232 | legacyType, handler); |
| 4233 | } |
| 4234 | |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 4235 | /** |
| 4236 | * Helper function to request a network with a particular legacy type. |
| 4237 | * |
| 4238 | * This API is only for use in internal system code that requests networks with legacy type and |
| 4239 | * relies on CONNECTIVITY_ACTION broadcasts instead of NetworkCallbacks. New caller should use |
| 4240 | * {@link #requestNetwork(NetworkRequest, NetworkCallback, Handler)} instead. |
| 4241 | * |
| 4242 | * @param request {@link NetworkRequest} describing this request. |
| 4243 | * @param timeoutMs The time in milliseconds to attempt looking for a suitable network |
| 4244 | * before {@link NetworkCallback#onUnavailable()} is called. The timeout must |
| 4245 | * be a positive value (i.e. >0). |
| 4246 | * @param legacyType to specify the network type(#TYPE_*). |
| 4247 | * @param handler {@link Handler} to specify the thread upon which the callback will be invoked. |
| 4248 | * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note |
| 4249 | * the callback must not be shared - it uniquely specifies this request. |
| 4250 | * |
| 4251 | * @hide |
| 4252 | */ |
| 4253 | @SystemApi |
| 4254 | @RequiresPermission(NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK) |
| 4255 | public void requestNetwork(@NonNull NetworkRequest request, |
| 4256 | int timeoutMs, int legacyType, @NonNull Handler handler, |
| 4257 | @NonNull NetworkCallback networkCallback) { |
| 4258 | if (legacyType == TYPE_NONE) { |
| 4259 | throw new IllegalArgumentException("TYPE_NONE is meaningless legacy type"); |
| 4260 | } |
| 4261 | CallbackHandler cbHandler = new CallbackHandler(handler); |
| 4262 | NetworkCapabilities nc = request.networkCapabilities; |
| 4263 | sendRequestForNetwork(nc, networkCallback, timeoutMs, REQUEST, legacyType, cbHandler); |
| 4264 | } |
| 4265 | |
| 4266 | /** |
Roshan Pius | e08bc18 | 2020-12-22 15:10:42 -0800 | [diff] [blame] | 4267 | * Request a network to satisfy a set of {@link NetworkCapabilities}. |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 4268 | * |
| 4269 | * <p>This method will attempt to find the best network that matches the passed |
| 4270 | * {@link NetworkRequest}, and to bring up one that does if none currently satisfies the |
| 4271 | * criteria. The platform will evaluate which network is the best at its own discretion. |
| 4272 | * Throughput, latency, cost per byte, policy, user preference and other considerations |
| 4273 | * may be factored in the decision of what is considered the best network. |
| 4274 | * |
| 4275 | * <p>As long as this request is outstanding, the platform will try to maintain the best network |
| 4276 | * matching this request, while always attempting to match the request to a better network if |
| 4277 | * possible. If a better match is found, the platform will switch this request to the now-best |
| 4278 | * network and inform the app of the newly best network by invoking |
| 4279 | * {@link NetworkCallback#onAvailable(Network)} on the provided callback. Note that the platform |
| 4280 | * will not try to maintain any other network than the best one currently matching the request: |
| 4281 | * a network not matching any network request may be disconnected at any time. |
| 4282 | * |
| 4283 | * <p>For example, an application could use this method to obtain a connected cellular network |
| 4284 | * even if the device currently has a data connection over Ethernet. This may cause the cellular |
| 4285 | * radio to consume additional power. Or, an application could inform the system that it wants |
| 4286 | * a network supporting sending MMSes and have the system let it know about the currently best |
| 4287 | * MMS-supporting network through the provided {@link NetworkCallback}. |
| 4288 | * |
| 4289 | * <p>The status of the request can be followed by listening to the various callbacks described |
| 4290 | * in {@link NetworkCallback}. The {@link Network} object passed to the callback methods can be |
| 4291 | * used to direct traffic to the network (although accessing some networks may be subject to |
| 4292 | * holding specific permissions). Callers will learn about the specific characteristics of the |
| 4293 | * network through |
| 4294 | * {@link NetworkCallback#onCapabilitiesChanged(Network, NetworkCapabilities)} and |
| 4295 | * {@link NetworkCallback#onLinkPropertiesChanged(Network, LinkProperties)}. The methods of the |
| 4296 | * provided {@link NetworkCallback} will only be invoked due to changes in the best network |
| 4297 | * matching the request at any given time; therefore when a better network matching the request |
| 4298 | * becomes available, the {@link NetworkCallback#onAvailable(Network)} method is called |
| 4299 | * with the new network after which no further updates are given about the previously-best |
| 4300 | * network, unless it becomes the best again at some later time. All callbacks are invoked |
| 4301 | * in order on the same thread, which by default is a thread created by the framework running |
| 4302 | * in the app. |
| 4303 | * {@see #requestNetwork(NetworkRequest, NetworkCallback, Handler)} to change where the |
| 4304 | * callbacks are invoked. |
| 4305 | * |
| 4306 | * <p>This{@link NetworkRequest} will live until released via |
| 4307 | * {@link #unregisterNetworkCallback(NetworkCallback)} or the calling application exits, at |
| 4308 | * which point the system may let go of the network at any time. |
| 4309 | * |
| 4310 | * <p>A version of this method which takes a timeout is |
| 4311 | * {@link #requestNetwork(NetworkRequest, NetworkCallback, int)}, that an app can use to only |
| 4312 | * wait for a limited amount of time for the network to become unavailable. |
| 4313 | * |
| 4314 | * <p>It is presently unsupported to request a network with mutable |
| 4315 | * {@link NetworkCapabilities} such as |
| 4316 | * {@link NetworkCapabilities#NET_CAPABILITY_VALIDATED} or |
| 4317 | * {@link NetworkCapabilities#NET_CAPABILITY_CAPTIVE_PORTAL} |
| 4318 | * as these {@code NetworkCapabilities} represent states that a particular |
| 4319 | * network may never attain, and whether a network will attain these states |
| 4320 | * is unknown prior to bringing up the network so the framework does not |
| 4321 | * know how to go about satisfying a request with these capabilities. |
| 4322 | * |
| 4323 | * <p>This method requires the caller to hold either the |
| 4324 | * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission |
| 4325 | * or the ability to modify system settings as determined by |
| 4326 | * {@link android.provider.Settings.System#canWrite}.</p> |
| 4327 | * |
| 4328 | * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the |
| 4329 | * number of outstanding requests to 100 per app (identified by their UID), shared with |
| 4330 | * all variants of this method, of {@link #registerNetworkCallback} as well as |
| 4331 | * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}. |
| 4332 | * Requesting a network with this method will count toward this limit. If this limit is |
| 4333 | * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources, |
| 4334 | * make sure to unregister the callbacks with |
| 4335 | * {@link #unregisterNetworkCallback(NetworkCallback)}. |
| 4336 | * |
| 4337 | * @param request {@link NetworkRequest} describing this request. |
| 4338 | * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note |
| 4339 | * the callback must not be shared - it uniquely specifies this request. |
| 4340 | * The callback is invoked on the default internal Handler. |
| 4341 | * @throws IllegalArgumentException if {@code request} contains invalid network capabilities. |
| 4342 | * @throws SecurityException if missing the appropriate permissions. |
| 4343 | * @throws RuntimeException if the app already has too many callbacks registered. |
| 4344 | */ |
| 4345 | public void requestNetwork(@NonNull NetworkRequest request, |
| 4346 | @NonNull NetworkCallback networkCallback) { |
| 4347 | requestNetwork(request, networkCallback, getDefaultHandler()); |
| 4348 | } |
| 4349 | |
| 4350 | /** |
Roshan Pius | e08bc18 | 2020-12-22 15:10:42 -0800 | [diff] [blame] | 4351 | * Request a network to satisfy a set of {@link NetworkCapabilities}. |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 4352 | * |
| 4353 | * This method behaves identically to {@link #requestNetwork(NetworkRequest, NetworkCallback)} |
| 4354 | * but runs all the callbacks on the passed Handler. |
| 4355 | * |
| 4356 | * <p>This method has the same permission requirements as |
| 4357 | * {@link #requestNetwork(NetworkRequest, NetworkCallback)}, is subject to the same limitations, |
| 4358 | * and throws the same exceptions in the same conditions. |
| 4359 | * |
| 4360 | * @param request {@link NetworkRequest} describing this request. |
| 4361 | * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note |
| 4362 | * the callback must not be shared - it uniquely specifies this request. |
| 4363 | * @param handler {@link Handler} to specify the thread upon which the callback will be invoked. |
| 4364 | */ |
| 4365 | public void requestNetwork(@NonNull NetworkRequest request, |
| 4366 | @NonNull NetworkCallback networkCallback, @NonNull Handler handler) { |
| 4367 | CallbackHandler cbHandler = new CallbackHandler(handler); |
| 4368 | NetworkCapabilities nc = request.networkCapabilities; |
| 4369 | sendRequestForNetwork(nc, networkCallback, 0, REQUEST, TYPE_NONE, cbHandler); |
| 4370 | } |
| 4371 | |
| 4372 | /** |
Roshan Pius | e08bc18 | 2020-12-22 15:10:42 -0800 | [diff] [blame] | 4373 | * Request a network to satisfy a set of {@link NetworkCapabilities}, limited |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 4374 | * by a timeout. |
| 4375 | * |
| 4376 | * This function behaves identically to the non-timed-out version |
| 4377 | * {@link #requestNetwork(NetworkRequest, NetworkCallback)}, but if a suitable network |
| 4378 | * is not found within the given time (in milliseconds) the |
| 4379 | * {@link NetworkCallback#onUnavailable()} callback is called. The request can still be |
| 4380 | * released normally by calling {@link #unregisterNetworkCallback(NetworkCallback)} but does |
| 4381 | * not have to be released if timed-out (it is automatically released). Unregistering a |
| 4382 | * request that timed out is not an error. |
| 4383 | * |
| 4384 | * <p>Do not use this method to poll for the existence of specific networks (e.g. with a small |
| 4385 | * timeout) - {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)} is provided |
| 4386 | * for that purpose. Calling this method will attempt to bring up the requested network. |
| 4387 | * |
| 4388 | * <p>This method has the same permission requirements as |
| 4389 | * {@link #requestNetwork(NetworkRequest, NetworkCallback)}, is subject to the same limitations, |
| 4390 | * and throws the same exceptions in the same conditions. |
| 4391 | * |
| 4392 | * @param request {@link NetworkRequest} describing this request. |
| 4393 | * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note |
| 4394 | * the callback must not be shared - it uniquely specifies this request. |
| 4395 | * @param timeoutMs The time in milliseconds to attempt looking for a suitable network |
| 4396 | * before {@link NetworkCallback#onUnavailable()} is called. The timeout must |
| 4397 | * be a positive value (i.e. >0). |
| 4398 | */ |
| 4399 | public void requestNetwork(@NonNull NetworkRequest request, |
| 4400 | @NonNull NetworkCallback networkCallback, int timeoutMs) { |
| 4401 | checkTimeout(timeoutMs); |
| 4402 | NetworkCapabilities nc = request.networkCapabilities; |
| 4403 | sendRequestForNetwork(nc, networkCallback, timeoutMs, REQUEST, TYPE_NONE, |
| 4404 | getDefaultHandler()); |
| 4405 | } |
| 4406 | |
| 4407 | /** |
Roshan Pius | e08bc18 | 2020-12-22 15:10:42 -0800 | [diff] [blame] | 4408 | * Request a network to satisfy a set of {@link NetworkCapabilities}, limited |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 4409 | * by a timeout. |
| 4410 | * |
| 4411 | * This method behaves identically to |
| 4412 | * {@link #requestNetwork(NetworkRequest, NetworkCallback, int)} but runs all the callbacks |
| 4413 | * on the passed Handler. |
| 4414 | * |
| 4415 | * <p>This method has the same permission requirements as |
| 4416 | * {@link #requestNetwork(NetworkRequest, NetworkCallback)}, is subject to the same limitations, |
| 4417 | * and throws the same exceptions in the same conditions. |
| 4418 | * |
| 4419 | * @param request {@link NetworkRequest} describing this request. |
| 4420 | * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note |
| 4421 | * the callback must not be shared - it uniquely specifies this request. |
| 4422 | * @param handler {@link Handler} to specify the thread upon which the callback will be invoked. |
| 4423 | * @param timeoutMs The time in milliseconds to attempt looking for a suitable network |
| 4424 | * before {@link NetworkCallback#onUnavailable} is called. |
| 4425 | */ |
| 4426 | public void requestNetwork(@NonNull NetworkRequest request, |
| 4427 | @NonNull NetworkCallback networkCallback, @NonNull Handler handler, int timeoutMs) { |
| 4428 | checkTimeout(timeoutMs); |
| 4429 | CallbackHandler cbHandler = new CallbackHandler(handler); |
| 4430 | NetworkCapabilities nc = request.networkCapabilities; |
| 4431 | sendRequestForNetwork(nc, networkCallback, timeoutMs, REQUEST, TYPE_NONE, cbHandler); |
| 4432 | } |
| 4433 | |
| 4434 | /** |
| 4435 | * The lookup key for a {@link Network} object included with the intent after |
| 4436 | * successfully finding a network for the applications request. Retrieve it with |
| 4437 | * {@link android.content.Intent#getParcelableExtra(String)}. |
| 4438 | * <p> |
| 4439 | * Note that if you intend to invoke {@link Network#openConnection(java.net.URL)} |
| 4440 | * then you must get a ConnectivityManager instance before doing so. |
| 4441 | */ |
| 4442 | public static final String EXTRA_NETWORK = "android.net.extra.NETWORK"; |
| 4443 | |
| 4444 | /** |
| 4445 | * The lookup key for a {@link NetworkRequest} object included with the intent after |
| 4446 | * successfully finding a network for the applications request. Retrieve it with |
| 4447 | * {@link android.content.Intent#getParcelableExtra(String)}. |
| 4448 | */ |
| 4449 | public static final String EXTRA_NETWORK_REQUEST = "android.net.extra.NETWORK_REQUEST"; |
| 4450 | |
| 4451 | |
| 4452 | /** |
Roshan Pius | e08bc18 | 2020-12-22 15:10:42 -0800 | [diff] [blame] | 4453 | * Request a network to satisfy a set of {@link NetworkCapabilities}. |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 4454 | * |
| 4455 | * This function behaves identically to the version that takes a NetworkCallback, but instead |
| 4456 | * of {@link NetworkCallback} a {@link PendingIntent} is used. This means |
| 4457 | * the request may outlive the calling application and get called back when a suitable |
| 4458 | * network is found. |
| 4459 | * <p> |
| 4460 | * The operation is an Intent broadcast that goes to a broadcast receiver that |
| 4461 | * you registered with {@link Context#registerReceiver} or through the |
| 4462 | * <receiver> tag in an AndroidManifest.xml file |
| 4463 | * <p> |
| 4464 | * The operation Intent is delivered with two extras, a {@link Network} typed |
| 4465 | * extra called {@link #EXTRA_NETWORK} and a {@link NetworkRequest} |
| 4466 | * typed extra called {@link #EXTRA_NETWORK_REQUEST} containing |
| 4467 | * the original requests parameters. It is important to create a new, |
| 4468 | * {@link NetworkCallback} based request before completing the processing of the |
| 4469 | * Intent to reserve the network or it will be released shortly after the Intent |
| 4470 | * is processed. |
| 4471 | * <p> |
| 4472 | * If there is already a request for this Intent registered (with the equality of |
| 4473 | * two Intents defined by {@link Intent#filterEquals}), then it will be removed and |
| 4474 | * replaced by this one, effectively releasing the previous {@link NetworkRequest}. |
| 4475 | * <p> |
| 4476 | * The request may be released normally by calling |
| 4477 | * {@link #releaseNetworkRequest(android.app.PendingIntent)}. |
| 4478 | * <p>It is presently unsupported to request a network with either |
| 4479 | * {@link NetworkCapabilities#NET_CAPABILITY_VALIDATED} or |
| 4480 | * {@link NetworkCapabilities#NET_CAPABILITY_CAPTIVE_PORTAL} |
| 4481 | * as these {@code NetworkCapabilities} represent states that a particular |
| 4482 | * network may never attain, and whether a network will attain these states |
| 4483 | * is unknown prior to bringing up the network so the framework does not |
| 4484 | * know how to go about satisfying a request with these capabilities. |
| 4485 | * |
| 4486 | * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the |
| 4487 | * number of outstanding requests to 100 per app (identified by their UID), shared with |
| 4488 | * all variants of this method, of {@link #registerNetworkCallback} as well as |
| 4489 | * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}. |
| 4490 | * Requesting a network with this method will count toward this limit. If this limit is |
| 4491 | * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources, |
| 4492 | * make sure to unregister the callbacks with {@link #unregisterNetworkCallback(PendingIntent)} |
| 4493 | * or {@link #releaseNetworkRequest(PendingIntent)}. |
| 4494 | * |
| 4495 | * <p>This method requires the caller to hold either the |
| 4496 | * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission |
| 4497 | * or the ability to modify system settings as determined by |
| 4498 | * {@link android.provider.Settings.System#canWrite}.</p> |
| 4499 | * |
| 4500 | * @param request {@link NetworkRequest} describing this request. |
| 4501 | * @param operation Action to perform when the network is available (corresponds |
| 4502 | * to the {@link NetworkCallback#onAvailable} call. Typically |
| 4503 | * comes from {@link PendingIntent#getBroadcast}. Cannot be null. |
| 4504 | * @throws IllegalArgumentException if {@code request} contains invalid network capabilities. |
| 4505 | * @throws SecurityException if missing the appropriate permissions. |
| 4506 | * @throws RuntimeException if the app already has too many callbacks registered. |
| 4507 | */ |
| 4508 | public void requestNetwork(@NonNull NetworkRequest request, |
| 4509 | @NonNull PendingIntent operation) { |
| 4510 | printStackTrace(); |
| 4511 | checkPendingIntentNotNull(operation); |
| 4512 | try { |
| 4513 | mService.pendingRequestForNetwork( |
| 4514 | request.networkCapabilities, operation, mContext.getOpPackageName(), |
| 4515 | getAttributionTag()); |
| 4516 | } catch (RemoteException e) { |
| 4517 | throw e.rethrowFromSystemServer(); |
| 4518 | } catch (ServiceSpecificException e) { |
| 4519 | throw convertServiceException(e); |
| 4520 | } |
| 4521 | } |
| 4522 | |
| 4523 | /** |
| 4524 | * Removes a request made via {@link #requestNetwork(NetworkRequest, android.app.PendingIntent)} |
| 4525 | * <p> |
| 4526 | * This method has the same behavior as |
| 4527 | * {@link #unregisterNetworkCallback(android.app.PendingIntent)} with respect to |
| 4528 | * releasing network resources and disconnecting. |
| 4529 | * |
| 4530 | * @param operation A PendingIntent equal (as defined by {@link Intent#filterEquals}) to the |
| 4531 | * PendingIntent passed to |
| 4532 | * {@link #requestNetwork(NetworkRequest, android.app.PendingIntent)} with the |
| 4533 | * corresponding NetworkRequest you'd like to remove. Cannot be null. |
| 4534 | */ |
| 4535 | public void releaseNetworkRequest(@NonNull PendingIntent operation) { |
| 4536 | printStackTrace(); |
| 4537 | checkPendingIntentNotNull(operation); |
| 4538 | try { |
| 4539 | mService.releasePendingNetworkRequest(operation); |
| 4540 | } catch (RemoteException e) { |
| 4541 | throw e.rethrowFromSystemServer(); |
| 4542 | } |
| 4543 | } |
| 4544 | |
| 4545 | private static void checkPendingIntentNotNull(PendingIntent intent) { |
Remi NGUYEN VAN | 1818dbb | 2021-03-15 07:31:54 +0000 | [diff] [blame] | 4546 | Objects.requireNonNull(intent, "PendingIntent cannot be null."); |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 4547 | } |
| 4548 | |
| 4549 | private static void checkCallbackNotNull(NetworkCallback callback) { |
Remi NGUYEN VAN | 1818dbb | 2021-03-15 07:31:54 +0000 | [diff] [blame] | 4550 | Objects.requireNonNull(callback, "null NetworkCallback"); |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 4551 | } |
| 4552 | |
| 4553 | private static void checkTimeout(int timeoutMs) { |
Remi NGUYEN VAN | 1818dbb | 2021-03-15 07:31:54 +0000 | [diff] [blame] | 4554 | if (timeoutMs <= 0) { |
| 4555 | throw new IllegalArgumentException("timeoutMs must be strictly positive."); |
| 4556 | } |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 4557 | } |
| 4558 | |
| 4559 | /** |
| 4560 | * Registers to receive notifications about all networks which satisfy the given |
| 4561 | * {@link NetworkRequest}. The callbacks will continue to be called until |
| 4562 | * either the application exits or {@link #unregisterNetworkCallback(NetworkCallback)} is |
| 4563 | * called. |
| 4564 | * |
| 4565 | * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the |
| 4566 | * number of outstanding requests to 100 per app (identified by their UID), shared with |
| 4567 | * all variants of this method, of {@link #requestNetwork} as well as |
| 4568 | * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}. |
| 4569 | * Requesting a network with this method will count toward this limit. If this limit is |
| 4570 | * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources, |
| 4571 | * make sure to unregister the callbacks with |
| 4572 | * {@link #unregisterNetworkCallback(NetworkCallback)}. |
| 4573 | * |
| 4574 | * @param request {@link NetworkRequest} describing this request. |
| 4575 | * @param networkCallback The {@link NetworkCallback} that the system will call as suitable |
| 4576 | * networks change state. |
| 4577 | * The callback is invoked on the default internal Handler. |
| 4578 | * @throws RuntimeException if the app already has too many callbacks registered. |
| 4579 | */ |
| 4580 | @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE) |
| 4581 | public void registerNetworkCallback(@NonNull NetworkRequest request, |
| 4582 | @NonNull NetworkCallback networkCallback) { |
| 4583 | registerNetworkCallback(request, networkCallback, getDefaultHandler()); |
| 4584 | } |
| 4585 | |
| 4586 | /** |
| 4587 | * Registers to receive notifications about all networks which satisfy the given |
| 4588 | * {@link NetworkRequest}. The callbacks will continue to be called until |
| 4589 | * either the application exits or {@link #unregisterNetworkCallback(NetworkCallback)} is |
| 4590 | * called. |
| 4591 | * |
| 4592 | * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the |
| 4593 | * number of outstanding requests to 100 per app (identified by their UID), shared with |
| 4594 | * all variants of this method, of {@link #requestNetwork} as well as |
| 4595 | * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}. |
| 4596 | * Requesting a network with this method will count toward this limit. If this limit is |
| 4597 | * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources, |
| 4598 | * make sure to unregister the callbacks with |
| 4599 | * {@link #unregisterNetworkCallback(NetworkCallback)}. |
| 4600 | * |
| 4601 | * |
| 4602 | * @param request {@link NetworkRequest} describing this request. |
| 4603 | * @param networkCallback The {@link NetworkCallback} that the system will call as suitable |
| 4604 | * networks change state. |
| 4605 | * @param handler {@link Handler} to specify the thread upon which the callback will be invoked. |
| 4606 | * @throws RuntimeException if the app already has too many callbacks registered. |
| 4607 | */ |
| 4608 | @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE) |
| 4609 | public void registerNetworkCallback(@NonNull NetworkRequest request, |
| 4610 | @NonNull NetworkCallback networkCallback, @NonNull Handler handler) { |
| 4611 | CallbackHandler cbHandler = new CallbackHandler(handler); |
| 4612 | NetworkCapabilities nc = request.networkCapabilities; |
| 4613 | sendRequestForNetwork(nc, networkCallback, 0, LISTEN, TYPE_NONE, cbHandler); |
| 4614 | } |
| 4615 | |
| 4616 | /** |
| 4617 | * Registers a PendingIntent to be sent when a network is available which satisfies the given |
| 4618 | * {@link NetworkRequest}. |
| 4619 | * |
| 4620 | * This function behaves identically to the version that takes a NetworkCallback, but instead |
| 4621 | * of {@link NetworkCallback} a {@link PendingIntent} is used. This means |
| 4622 | * the request may outlive the calling application and get called back when a suitable |
| 4623 | * network is found. |
| 4624 | * <p> |
| 4625 | * The operation is an Intent broadcast that goes to a broadcast receiver that |
| 4626 | * you registered with {@link Context#registerReceiver} or through the |
| 4627 | * <receiver> tag in an AndroidManifest.xml file |
| 4628 | * <p> |
| 4629 | * The operation Intent is delivered with two extras, a {@link Network} typed |
| 4630 | * extra called {@link #EXTRA_NETWORK} and a {@link NetworkRequest} |
| 4631 | * typed extra called {@link #EXTRA_NETWORK_REQUEST} containing |
| 4632 | * the original requests parameters. |
| 4633 | * <p> |
| 4634 | * If there is already a request for this Intent registered (with the equality of |
| 4635 | * two Intents defined by {@link Intent#filterEquals}), then it will be removed and |
| 4636 | * replaced by this one, effectively releasing the previous {@link NetworkRequest}. |
| 4637 | * <p> |
| 4638 | * The request may be released normally by calling |
| 4639 | * {@link #unregisterNetworkCallback(android.app.PendingIntent)}. |
| 4640 | * |
| 4641 | * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the |
| 4642 | * number of outstanding requests to 100 per app (identified by their UID), shared with |
| 4643 | * all variants of this method, of {@link #requestNetwork} as well as |
| 4644 | * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}. |
| 4645 | * Requesting a network with this method will count toward this limit. If this limit is |
| 4646 | * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources, |
| 4647 | * make sure to unregister the callbacks with {@link #unregisterNetworkCallback(PendingIntent)} |
| 4648 | * or {@link #releaseNetworkRequest(PendingIntent)}. |
| 4649 | * |
| 4650 | * @param request {@link NetworkRequest} describing this request. |
| 4651 | * @param operation Action to perform when the network is available (corresponds |
| 4652 | * to the {@link NetworkCallback#onAvailable} call. Typically |
| 4653 | * comes from {@link PendingIntent#getBroadcast}. Cannot be null. |
| 4654 | * @throws RuntimeException if the app already has too many callbacks registered. |
| 4655 | */ |
| 4656 | @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE) |
| 4657 | public void registerNetworkCallback(@NonNull NetworkRequest request, |
| 4658 | @NonNull PendingIntent operation) { |
| 4659 | printStackTrace(); |
| 4660 | checkPendingIntentNotNull(operation); |
| 4661 | try { |
| 4662 | mService.pendingListenForNetwork( |
Roshan Pius | a8a477b | 2020-12-17 14:53:09 -0800 | [diff] [blame] | 4663 | request.networkCapabilities, operation, mContext.getOpPackageName(), |
| 4664 | getAttributionTag()); |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 4665 | } catch (RemoteException e) { |
| 4666 | throw e.rethrowFromSystemServer(); |
| 4667 | } catch (ServiceSpecificException e) { |
| 4668 | throw convertServiceException(e); |
| 4669 | } |
| 4670 | } |
| 4671 | |
| 4672 | /** |
Lorenzo Colitti | a77d05e | 2021-01-29 20:14:04 +0900 | [diff] [blame] | 4673 | * Registers to receive notifications about changes in the application's default network. This |
| 4674 | * may be a physical network or a virtual network, such as a VPN that applies to the |
| 4675 | * application. The callbacks will continue to be called until either the application exits or |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 4676 | * {@link #unregisterNetworkCallback(NetworkCallback)} is called. |
| 4677 | * |
| 4678 | * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the |
| 4679 | * number of outstanding requests to 100 per app (identified by their UID), shared with |
| 4680 | * all variants of this method, of {@link #requestNetwork} as well as |
| 4681 | * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}. |
| 4682 | * Requesting a network with this method will count toward this limit. If this limit is |
| 4683 | * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources, |
| 4684 | * make sure to unregister the callbacks with |
| 4685 | * {@link #unregisterNetworkCallback(NetworkCallback)}. |
| 4686 | * |
| 4687 | * @param networkCallback The {@link NetworkCallback} that the system will call as the |
Lorenzo Colitti | a77d05e | 2021-01-29 20:14:04 +0900 | [diff] [blame] | 4688 | * application's default network changes. |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 4689 | * The callback is invoked on the default internal Handler. |
| 4690 | * @throws RuntimeException if the app already has too many callbacks registered. |
| 4691 | */ |
| 4692 | @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE) |
| 4693 | public void registerDefaultNetworkCallback(@NonNull NetworkCallback networkCallback) { |
| 4694 | registerDefaultNetworkCallback(networkCallback, getDefaultHandler()); |
| 4695 | } |
| 4696 | |
| 4697 | /** |
Lorenzo Colitti | a77d05e | 2021-01-29 20:14:04 +0900 | [diff] [blame] | 4698 | * Registers to receive notifications about changes in the application's default network. This |
| 4699 | * may be a physical network or a virtual network, such as a VPN that applies to the |
| 4700 | * application. The callbacks will continue to be called until either the application exits or |
| 4701 | * {@link #unregisterNetworkCallback(NetworkCallback)} is called. |
| 4702 | * |
| 4703 | * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the |
| 4704 | * number of outstanding requests to 100 per app (identified by their UID), shared with |
| 4705 | * all variants of this method, of {@link #requestNetwork} as well as |
| 4706 | * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}. |
| 4707 | * Requesting a network with this method will count toward this limit. If this limit is |
| 4708 | * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources, |
| 4709 | * make sure to unregister the callbacks with |
| 4710 | * {@link #unregisterNetworkCallback(NetworkCallback)}. |
| 4711 | * |
| 4712 | * @param networkCallback The {@link NetworkCallback} that the system will call as the |
| 4713 | * application's default network changes. |
| 4714 | * @param handler {@link Handler} to specify the thread upon which the callback will be invoked. |
| 4715 | * @throws RuntimeException if the app already has too many callbacks registered. |
| 4716 | */ |
| 4717 | @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE) |
| 4718 | public void registerDefaultNetworkCallback(@NonNull NetworkCallback networkCallback, |
| 4719 | @NonNull Handler handler) { |
Chiachang Wang | c7d203d | 2021-04-20 15:41:24 +0800 | [diff] [blame] | 4720 | registerDefaultNetworkCallbackForUid(Process.INVALID_UID, networkCallback, handler); |
Lorenzo Colitti | 5f26b19 | 2021-03-12 22:48:07 +0900 | [diff] [blame] | 4721 | } |
| 4722 | |
| 4723 | /** |
| 4724 | * Registers to receive notifications about changes in the default network for the specified |
| 4725 | * UID. This may be a physical network or a virtual network, such as a VPN that applies to the |
| 4726 | * UID. The callbacks will continue to be called until either the application exits or |
| 4727 | * {@link #unregisterNetworkCallback(NetworkCallback)} is called. |
| 4728 | * |
| 4729 | * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the |
| 4730 | * number of outstanding requests to 100 per app (identified by their UID), shared with |
| 4731 | * all variants of this method, of {@link #requestNetwork} as well as |
| 4732 | * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}. |
| 4733 | * Requesting a network with this method will count toward this limit. If this limit is |
| 4734 | * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources, |
| 4735 | * make sure to unregister the callbacks with |
| 4736 | * {@link #unregisterNetworkCallback(NetworkCallback)}. |
| 4737 | * |
| 4738 | * @param uid the UID for which to track default network changes. |
| 4739 | * @param networkCallback The {@link NetworkCallback} that the system will call as the |
| 4740 | * UID's default network changes. |
| 4741 | * @param handler {@link Handler} to specify the thread upon which the callback will be invoked. |
| 4742 | * @throws RuntimeException if the app already has too many callbacks registered. |
| 4743 | * @hide |
| 4744 | */ |
Lorenzo Colitti | b90bdbd | 2021-03-22 18:23:21 +0900 | [diff] [blame] | 4745 | @SystemApi(client = MODULE_LIBRARIES) |
Lorenzo Colitti | 5f26b19 | 2021-03-12 22:48:07 +0900 | [diff] [blame] | 4746 | @SuppressLint({"ExecutorRegistration", "PairedRegistration"}) |
| 4747 | @RequiresPermission(anyOf = { |
| 4748 | NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK, |
| 4749 | android.Manifest.permission.NETWORK_SETTINGS}) |
Chiachang Wang | c7d203d | 2021-04-20 15:41:24 +0800 | [diff] [blame] | 4750 | public void registerDefaultNetworkCallbackForUid(int uid, |
Lorenzo Colitti | 5f26b19 | 2021-03-12 22:48:07 +0900 | [diff] [blame] | 4751 | @NonNull NetworkCallback networkCallback, @NonNull Handler handler) { |
Lorenzo Colitti | a77d05e | 2021-01-29 20:14:04 +0900 | [diff] [blame] | 4752 | CallbackHandler cbHandler = new CallbackHandler(handler); |
Lorenzo Colitti | 5f26b19 | 2021-03-12 22:48:07 +0900 | [diff] [blame] | 4753 | sendRequestForNetwork(uid, null /* need */, networkCallback, 0 /* timeoutMs */, |
Lorenzo Colitti | a77d05e | 2021-01-29 20:14:04 +0900 | [diff] [blame] | 4754 | TRACK_DEFAULT, TYPE_NONE, cbHandler); |
| 4755 | } |
| 4756 | |
| 4757 | /** |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 4758 | * Registers to receive notifications about changes in the system default network. The callbacks |
| 4759 | * will continue to be called until either the application exits or |
| 4760 | * {@link #unregisterNetworkCallback(NetworkCallback)} is called. |
| 4761 | * |
Lorenzo Colitti | a77d05e | 2021-01-29 20:14:04 +0900 | [diff] [blame] | 4762 | * This method should not be used to determine networking state seen by applications, because in |
| 4763 | * many cases, most or even all application traffic may not use the default network directly, |
| 4764 | * and traffic from different applications may go on different networks by default. As an |
| 4765 | * example, if a VPN is connected, traffic from all applications might be sent through the VPN |
| 4766 | * and not onto the system default network. Applications or system components desiring to do |
| 4767 | * determine network state as seen by applications should use other methods such as |
| 4768 | * {@link #registerDefaultNetworkCallback(NetworkCallback, Handler)}. |
| 4769 | * |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 4770 | * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the |
| 4771 | * number of outstanding requests to 100 per app (identified by their UID), shared with |
| 4772 | * all variants of this method, of {@link #requestNetwork} as well as |
| 4773 | * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}. |
| 4774 | * Requesting a network with this method will count toward this limit. If this limit is |
| 4775 | * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources, |
| 4776 | * make sure to unregister the callbacks with |
| 4777 | * {@link #unregisterNetworkCallback(NetworkCallback)}. |
| 4778 | * |
| 4779 | * @param networkCallback The {@link NetworkCallback} that the system will call as the |
| 4780 | * system default network changes. |
| 4781 | * @param handler {@link Handler} to specify the thread upon which the callback will be invoked. |
| 4782 | * @throws RuntimeException if the app already has too many callbacks registered. |
Lorenzo Colitti | a77d05e | 2021-01-29 20:14:04 +0900 | [diff] [blame] | 4783 | * |
| 4784 | * @hide |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 4785 | */ |
Lorenzo Colitti | a77d05e | 2021-01-29 20:14:04 +0900 | [diff] [blame] | 4786 | @SystemApi(client = MODULE_LIBRARIES) |
| 4787 | @SuppressLint({"ExecutorRegistration", "PairedRegistration"}) |
| 4788 | @RequiresPermission(anyOf = { |
| 4789 | NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK, |
| 4790 | android.Manifest.permission.NETWORK_SETTINGS}) |
| 4791 | public void registerSystemDefaultNetworkCallback(@NonNull NetworkCallback networkCallback, |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 4792 | @NonNull Handler handler) { |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 4793 | CallbackHandler cbHandler = new CallbackHandler(handler); |
| 4794 | sendRequestForNetwork(null /* NetworkCapabilities need */, networkCallback, 0, |
Lorenzo Colitti | a77d05e | 2021-01-29 20:14:04 +0900 | [diff] [blame] | 4795 | TRACK_SYSTEM_DEFAULT, TYPE_NONE, cbHandler); |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 4796 | } |
| 4797 | |
| 4798 | /** |
junyulai | bd12306 | 2021-03-15 11:48:48 +0800 | [diff] [blame] | 4799 | * Registers to receive notifications about the best matching network which satisfy the given |
| 4800 | * {@link NetworkRequest}. The callbacks will continue to be called until |
| 4801 | * either the application exits or {@link #unregisterNetworkCallback(NetworkCallback)} is |
| 4802 | * called. |
| 4803 | * |
| 4804 | * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the |
| 4805 | * number of outstanding requests to 100 per app (identified by their UID), shared with |
| 4806 | * {@link #registerNetworkCallback} and its variants and {@link #requestNetwork} as well as |
| 4807 | * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}. |
| 4808 | * Requesting a network with this method will count toward this limit. If this limit is |
| 4809 | * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources, |
| 4810 | * make sure to unregister the callbacks with |
| 4811 | * {@link #unregisterNetworkCallback(NetworkCallback)}. |
| 4812 | * |
| 4813 | * |
| 4814 | * @param request {@link NetworkRequest} describing this request. |
| 4815 | * @param networkCallback The {@link NetworkCallback} that the system will call as suitable |
| 4816 | * networks change state. |
| 4817 | * @param handler {@link Handler} to specify the thread upon which the callback will be invoked. |
| 4818 | * @throws RuntimeException if the app already has too many callbacks registered. |
junyulai | 5a5c99b | 2021-03-05 15:51:17 +0800 | [diff] [blame] | 4819 | */ |
junyulai | 5a5c99b | 2021-03-05 15:51:17 +0800 | [diff] [blame] | 4820 | @SuppressLint("ExecutorRegistration") |
| 4821 | public void registerBestMatchingNetworkCallback(@NonNull NetworkRequest request, |
| 4822 | @NonNull NetworkCallback networkCallback, @NonNull Handler handler) { |
| 4823 | final NetworkCapabilities nc = request.networkCapabilities; |
| 4824 | final CallbackHandler cbHandler = new CallbackHandler(handler); |
junyulai | 7664f62 | 2021-03-12 20:05:08 +0800 | [diff] [blame] | 4825 | sendRequestForNetwork(nc, networkCallback, 0, LISTEN_FOR_BEST, TYPE_NONE, cbHandler); |
junyulai | 5a5c99b | 2021-03-05 15:51:17 +0800 | [diff] [blame] | 4826 | } |
| 4827 | |
| 4828 | /** |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 4829 | * Requests bandwidth update for a given {@link Network} and returns whether the update request |
| 4830 | * is accepted by ConnectivityService. Once accepted, ConnectivityService will poll underlying |
| 4831 | * network connection for updated bandwidth information. The caller will be notified via |
| 4832 | * {@link ConnectivityManager.NetworkCallback} if there is an update. Notice that this |
| 4833 | * method assumes that the caller has previously called |
| 4834 | * {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)} to listen for network |
| 4835 | * changes. |
| 4836 | * |
| 4837 | * @param network {@link Network} specifying which network you're interested. |
| 4838 | * @return {@code true} on success, {@code false} if the {@link Network} is no longer valid. |
| 4839 | */ |
| 4840 | public boolean requestBandwidthUpdate(@NonNull Network network) { |
| 4841 | try { |
| 4842 | return mService.requestBandwidthUpdate(network); |
| 4843 | } catch (RemoteException e) { |
| 4844 | throw e.rethrowFromSystemServer(); |
| 4845 | } |
| 4846 | } |
| 4847 | |
| 4848 | /** |
| 4849 | * Unregisters a {@code NetworkCallback} and possibly releases networks originating from |
| 4850 | * {@link #requestNetwork(NetworkRequest, NetworkCallback)} and |
| 4851 | * {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)} calls. |
| 4852 | * If the given {@code NetworkCallback} had previously been used with |
| 4853 | * {@code #requestNetwork}, any networks that had been connected to only to satisfy that request |
| 4854 | * will be disconnected. |
| 4855 | * |
| 4856 | * Notifications that would have triggered that {@code NetworkCallback} will immediately stop |
| 4857 | * triggering it as soon as this call returns. |
| 4858 | * |
| 4859 | * @param networkCallback The {@link NetworkCallback} used when making the request. |
| 4860 | */ |
| 4861 | public void unregisterNetworkCallback(@NonNull NetworkCallback networkCallback) { |
| 4862 | printStackTrace(); |
| 4863 | checkCallbackNotNull(networkCallback); |
| 4864 | final List<NetworkRequest> reqs = new ArrayList<>(); |
| 4865 | // Find all requests associated to this callback and stop callback triggers immediately. |
| 4866 | // Callback is reusable immediately. http://b/20701525, http://b/35921499. |
| 4867 | synchronized (sCallbacks) { |
Remi NGUYEN VAN | 1818dbb | 2021-03-15 07:31:54 +0000 | [diff] [blame] | 4868 | if (networkCallback.networkRequest == null) { |
| 4869 | throw new IllegalArgumentException("NetworkCallback was not registered"); |
| 4870 | } |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 4871 | if (networkCallback.networkRequest == ALREADY_UNREGISTERED) { |
| 4872 | Log.d(TAG, "NetworkCallback was already unregistered"); |
| 4873 | return; |
| 4874 | } |
| 4875 | for (Map.Entry<NetworkRequest, NetworkCallback> e : sCallbacks.entrySet()) { |
| 4876 | if (e.getValue() == networkCallback) { |
| 4877 | reqs.add(e.getKey()); |
| 4878 | } |
| 4879 | } |
| 4880 | // TODO: throw exception if callback was registered more than once (http://b/20701525). |
| 4881 | for (NetworkRequest r : reqs) { |
| 4882 | try { |
| 4883 | mService.releaseNetworkRequest(r); |
| 4884 | } catch (RemoteException e) { |
| 4885 | throw e.rethrowFromSystemServer(); |
| 4886 | } |
| 4887 | // Only remove mapping if rpc was successful. |
| 4888 | sCallbacks.remove(r); |
| 4889 | } |
| 4890 | networkCallback.networkRequest = ALREADY_UNREGISTERED; |
| 4891 | } |
| 4892 | } |
| 4893 | |
| 4894 | /** |
| 4895 | * Unregisters a callback previously registered via |
| 4896 | * {@link #registerNetworkCallback(NetworkRequest, android.app.PendingIntent)}. |
| 4897 | * |
| 4898 | * @param operation A PendingIntent equal (as defined by {@link Intent#filterEquals}) to the |
| 4899 | * PendingIntent passed to |
| 4900 | * {@link #registerNetworkCallback(NetworkRequest, android.app.PendingIntent)}. |
| 4901 | * Cannot be null. |
| 4902 | */ |
| 4903 | public void unregisterNetworkCallback(@NonNull PendingIntent operation) { |
| 4904 | releaseNetworkRequest(operation); |
| 4905 | } |
| 4906 | |
| 4907 | /** |
| 4908 | * Informs the system whether it should switch to {@code network} regardless of whether it is |
| 4909 | * validated or not. If {@code accept} is true, and the network was explicitly selected by the |
| 4910 | * user (e.g., by selecting a Wi-Fi network in the Settings app), then the network will become |
| 4911 | * the system default network regardless of any other network that's currently connected. If |
| 4912 | * {@code always} is true, then the choice is remembered, so that the next time the user |
| 4913 | * connects to this network, the system will switch to it. |
| 4914 | * |
| 4915 | * @param network The network to accept. |
| 4916 | * @param accept Whether to accept the network even if unvalidated. |
| 4917 | * @param always Whether to remember this choice in the future. |
| 4918 | * |
| 4919 | * @hide |
| 4920 | */ |
Chiachang Wang | f9294e7 | 2021-03-18 09:44:34 +0800 | [diff] [blame] | 4921 | @SystemApi(client = MODULE_LIBRARIES) |
| 4922 | @RequiresPermission(anyOf = { |
| 4923 | android.Manifest.permission.NETWORK_SETTINGS, |
| 4924 | android.Manifest.permission.NETWORK_SETUP_WIZARD, |
| 4925 | android.Manifest.permission.NETWORK_STACK, |
| 4926 | NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK}) |
| 4927 | public void setAcceptUnvalidated(@NonNull Network network, boolean accept, boolean always) { |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 4928 | try { |
| 4929 | mService.setAcceptUnvalidated(network, accept, always); |
| 4930 | } catch (RemoteException e) { |
| 4931 | throw e.rethrowFromSystemServer(); |
| 4932 | } |
| 4933 | } |
| 4934 | |
| 4935 | /** |
| 4936 | * Informs the system whether it should consider the network as validated even if it only has |
| 4937 | * partial connectivity. If {@code accept} is true, then the network will be considered as |
| 4938 | * validated even if connectivity is only partial. If {@code always} is true, then the choice |
| 4939 | * is remembered, so that the next time the user connects to this network, the system will |
| 4940 | * switch to it. |
| 4941 | * |
| 4942 | * @param network The network to accept. |
| 4943 | * @param accept Whether to consider the network as validated even if it has partial |
| 4944 | * connectivity. |
| 4945 | * @param always Whether to remember this choice in the future. |
| 4946 | * |
| 4947 | * @hide |
| 4948 | */ |
Chiachang Wang | f9294e7 | 2021-03-18 09:44:34 +0800 | [diff] [blame] | 4949 | @SystemApi(client = MODULE_LIBRARIES) |
| 4950 | @RequiresPermission(anyOf = { |
| 4951 | android.Manifest.permission.NETWORK_SETTINGS, |
| 4952 | android.Manifest.permission.NETWORK_SETUP_WIZARD, |
| 4953 | android.Manifest.permission.NETWORK_STACK, |
| 4954 | NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK}) |
| 4955 | public void setAcceptPartialConnectivity(@NonNull Network network, boolean accept, |
| 4956 | boolean always) { |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 4957 | try { |
| 4958 | mService.setAcceptPartialConnectivity(network, accept, always); |
| 4959 | } catch (RemoteException e) { |
| 4960 | throw e.rethrowFromSystemServer(); |
| 4961 | } |
| 4962 | } |
| 4963 | |
| 4964 | /** |
| 4965 | * Informs the system to penalize {@code network}'s score when it becomes unvalidated. This is |
| 4966 | * only meaningful if the system is configured not to penalize such networks, e.g., if the |
| 4967 | * {@code config_networkAvoidBadWifi} configuration variable is set to 0 and the {@code |
| 4968 | * NETWORK_AVOID_BAD_WIFI setting is unset}. |
| 4969 | * |
| 4970 | * @param network The network to accept. |
| 4971 | * |
| 4972 | * @hide |
| 4973 | */ |
Chiachang Wang | f9294e7 | 2021-03-18 09:44:34 +0800 | [diff] [blame] | 4974 | @SystemApi(client = MODULE_LIBRARIES) |
| 4975 | @RequiresPermission(anyOf = { |
| 4976 | android.Manifest.permission.NETWORK_SETTINGS, |
| 4977 | android.Manifest.permission.NETWORK_SETUP_WIZARD, |
| 4978 | android.Manifest.permission.NETWORK_STACK, |
| 4979 | NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK}) |
| 4980 | public void setAvoidUnvalidated(@NonNull Network network) { |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 4981 | try { |
| 4982 | mService.setAvoidUnvalidated(network); |
| 4983 | } catch (RemoteException e) { |
| 4984 | throw e.rethrowFromSystemServer(); |
| 4985 | } |
| 4986 | } |
| 4987 | |
| 4988 | /** |
Chiachang Wang | 6eac9fb | 2021-06-17 22:11:30 +0800 | [diff] [blame] | 4989 | * Temporarily allow bad wifi to override {@code config_networkAvoidBadWifi} configuration. |
| 4990 | * |
| 4991 | * @param timeMs The expired current time. The value should be set within a limited time from |
| 4992 | * now. |
| 4993 | * |
| 4994 | * @hide |
| 4995 | */ |
| 4996 | public void setTestAllowBadWifiUntil(long timeMs) { |
| 4997 | try { |
| 4998 | mService.setTestAllowBadWifiUntil(timeMs); |
| 4999 | } catch (RemoteException e) { |
| 5000 | throw e.rethrowFromSystemServer(); |
| 5001 | } |
| 5002 | } |
| 5003 | |
| 5004 | /** |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 5005 | * Requests that the system open the captive portal app on the specified network. |
| 5006 | * |
Remi NGUYEN VAN | 8238a76 | 2021-03-16 18:06:06 +0900 | [diff] [blame] | 5007 | * <p>This is to be used on networks where a captive portal was detected, as per |
| 5008 | * {@link NetworkCapabilities#NET_CAPABILITY_CAPTIVE_PORTAL}. |
| 5009 | * |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 5010 | * @param network The network to log into. |
| 5011 | * |
| 5012 | * @hide |
| 5013 | */ |
Remi NGUYEN VAN | 8238a76 | 2021-03-16 18:06:06 +0900 | [diff] [blame] | 5014 | @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES) |
| 5015 | @RequiresPermission(anyOf = { |
| 5016 | android.Manifest.permission.NETWORK_SETTINGS, |
| 5017 | android.Manifest.permission.NETWORK_STACK, |
| 5018 | NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK |
| 5019 | }) |
| 5020 | public void startCaptivePortalApp(@NonNull Network network) { |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 5021 | try { |
| 5022 | mService.startCaptivePortalApp(network); |
| 5023 | } catch (RemoteException e) { |
| 5024 | throw e.rethrowFromSystemServer(); |
| 5025 | } |
| 5026 | } |
| 5027 | |
| 5028 | /** |
| 5029 | * Requests that the system open the captive portal app with the specified extras. |
| 5030 | * |
| 5031 | * <p>This endpoint is exclusively for use by the NetworkStack and is protected by the |
| 5032 | * corresponding permission. |
| 5033 | * @param network Network on which the captive portal was detected. |
| 5034 | * @param appExtras Extras to include in the app start intent. |
| 5035 | * @hide |
| 5036 | */ |
| 5037 | @SystemApi |
| 5038 | @RequiresPermission(NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK) |
| 5039 | public void startCaptivePortalApp(@NonNull Network network, @NonNull Bundle appExtras) { |
| 5040 | try { |
| 5041 | mService.startCaptivePortalAppInternal(network, appExtras); |
| 5042 | } catch (RemoteException e) { |
| 5043 | throw e.rethrowFromSystemServer(); |
| 5044 | } |
| 5045 | } |
| 5046 | |
| 5047 | /** |
| 5048 | * Determine whether the device is configured to avoid bad wifi. |
| 5049 | * @hide |
| 5050 | */ |
| 5051 | @SystemApi |
| 5052 | @RequiresPermission(anyOf = { |
| 5053 | NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK, |
| 5054 | android.Manifest.permission.NETWORK_STACK}) |
| 5055 | public boolean shouldAvoidBadWifi() { |
| 5056 | try { |
| 5057 | return mService.shouldAvoidBadWifi(); |
| 5058 | } catch (RemoteException e) { |
| 5059 | throw e.rethrowFromSystemServer(); |
| 5060 | } |
| 5061 | } |
| 5062 | |
| 5063 | /** |
| 5064 | * It is acceptable to briefly use multipath data to provide seamless connectivity for |
| 5065 | * time-sensitive user-facing operations when the system default network is temporarily |
| 5066 | * unresponsive. The amount of data should be limited (less than one megabyte for every call to |
| 5067 | * this method), and the operation should be infrequent to ensure that data usage is limited. |
| 5068 | * |
| 5069 | * An example of such an operation might be a time-sensitive foreground activity, such as a |
| 5070 | * voice command, that the user is performing while walking out of range of a Wi-Fi network. |
| 5071 | */ |
| 5072 | public static final int MULTIPATH_PREFERENCE_HANDOVER = 1 << 0; |
| 5073 | |
| 5074 | /** |
| 5075 | * It is acceptable to use small amounts of multipath data on an ongoing basis to provide |
| 5076 | * a backup channel for traffic that is primarily going over another network. |
| 5077 | * |
| 5078 | * An example might be maintaining backup connections to peers or servers for the purpose of |
| 5079 | * fast fallback if the default network is temporarily unresponsive or disconnects. The traffic |
| 5080 | * on backup paths should be negligible compared to the traffic on the main path. |
| 5081 | */ |
| 5082 | public static final int MULTIPATH_PREFERENCE_RELIABILITY = 1 << 1; |
| 5083 | |
| 5084 | /** |
| 5085 | * It is acceptable to use metered data to improve network latency and performance. |
| 5086 | */ |
| 5087 | public static final int MULTIPATH_PREFERENCE_PERFORMANCE = 1 << 2; |
| 5088 | |
| 5089 | /** |
| 5090 | * Return value to use for unmetered networks. On such networks we currently set all the flags |
| 5091 | * to true. |
| 5092 | * @hide |
| 5093 | */ |
| 5094 | public static final int MULTIPATH_PREFERENCE_UNMETERED = |
| 5095 | MULTIPATH_PREFERENCE_HANDOVER | |
| 5096 | MULTIPATH_PREFERENCE_RELIABILITY | |
| 5097 | MULTIPATH_PREFERENCE_PERFORMANCE; |
| 5098 | |
Aaron Huang | cff2294 | 2021-05-27 16:31:26 +0800 | [diff] [blame] | 5099 | /** @hide */ |
| 5100 | @Retention(RetentionPolicy.SOURCE) |
| 5101 | @IntDef(flag = true, value = { |
| 5102 | MULTIPATH_PREFERENCE_HANDOVER, |
| 5103 | MULTIPATH_PREFERENCE_RELIABILITY, |
| 5104 | MULTIPATH_PREFERENCE_PERFORMANCE, |
| 5105 | }) |
| 5106 | public @interface MultipathPreference { |
| 5107 | } |
| 5108 | |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 5109 | /** |
| 5110 | * Provides a hint to the calling application on whether it is desirable to use the |
| 5111 | * multinetwork APIs (e.g., {@link Network#openConnection}, {@link Network#bindSocket}, etc.) |
| 5112 | * for multipath data transfer on this network when it is not the system default network. |
| 5113 | * Applications desiring to use multipath network protocols should call this method before |
| 5114 | * each such operation. |
| 5115 | * |
| 5116 | * @param network The network on which the application desires to use multipath data. |
| 5117 | * If {@code null}, this method will return the a preference that will generally |
| 5118 | * apply to metered networks. |
| 5119 | * @return a bitwise OR of zero or more of the {@code MULTIPATH_PREFERENCE_*} constants. |
| 5120 | */ |
| 5121 | @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE) |
| 5122 | public @MultipathPreference int getMultipathPreference(@Nullable Network network) { |
| 5123 | try { |
| 5124 | return mService.getMultipathPreference(network); |
| 5125 | } catch (RemoteException e) { |
| 5126 | throw e.rethrowFromSystemServer(); |
| 5127 | } |
| 5128 | } |
| 5129 | |
| 5130 | /** |
| 5131 | * Resets all connectivity manager settings back to factory defaults. |
| 5132 | * @hide |
| 5133 | */ |
Chiachang Wang | f9294e7 | 2021-03-18 09:44:34 +0800 | [diff] [blame] | 5134 | @SystemApi(client = MODULE_LIBRARIES) |
| 5135 | @RequiresPermission(anyOf = { |
| 5136 | android.Manifest.permission.NETWORK_SETTINGS, |
| 5137 | NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK}) |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 5138 | public void factoryReset() { |
| 5139 | try { |
| 5140 | mService.factoryReset(); |
Remi NGUYEN VAN | e4d1cd9 | 2021-06-17 16:27:31 +0900 | [diff] [blame] | 5141 | getTetheringManager().stopAllTethering(); |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 5142 | } catch (RemoteException e) { |
| 5143 | throw e.rethrowFromSystemServer(); |
| 5144 | } |
| 5145 | } |
| 5146 | |
| 5147 | /** |
| 5148 | * Binds the current process to {@code network}. All Sockets created in the future |
| 5149 | * (and not explicitly bound via a bound SocketFactory from |
| 5150 | * {@link Network#getSocketFactory() Network.getSocketFactory()}) will be bound to |
| 5151 | * {@code network}. All host name resolutions will be limited to {@code network} as well. |
| 5152 | * Note that if {@code network} ever disconnects, all Sockets created in this way will cease to |
| 5153 | * work and all host name resolutions will fail. This is by design so an application doesn't |
| 5154 | * accidentally use Sockets it thinks are still bound to a particular {@link Network}. |
| 5155 | * To clear binding pass {@code null} for {@code network}. Using individually bound |
| 5156 | * Sockets created by Network.getSocketFactory().createSocket() and |
| 5157 | * performing network-specific host name resolutions via |
| 5158 | * {@link Network#getAllByName Network.getAllByName} is preferred to calling |
| 5159 | * {@code bindProcessToNetwork}. |
| 5160 | * |
| 5161 | * @param network The {@link Network} to bind the current process to, or {@code null} to clear |
| 5162 | * the current binding. |
| 5163 | * @return {@code true} on success, {@code false} if the {@link Network} is no longer valid. |
| 5164 | */ |
| 5165 | public boolean bindProcessToNetwork(@Nullable Network network) { |
| 5166 | // Forcing callers to call through non-static function ensures ConnectivityManager |
| 5167 | // instantiated. |
| 5168 | return setProcessDefaultNetwork(network); |
| 5169 | } |
| 5170 | |
| 5171 | /** |
| 5172 | * Binds the current process to {@code network}. All Sockets created in the future |
| 5173 | * (and not explicitly bound via a bound SocketFactory from |
| 5174 | * {@link Network#getSocketFactory() Network.getSocketFactory()}) will be bound to |
| 5175 | * {@code network}. All host name resolutions will be limited to {@code network} as well. |
| 5176 | * Note that if {@code network} ever disconnects, all Sockets created in this way will cease to |
| 5177 | * work and all host name resolutions will fail. This is by design so an application doesn't |
| 5178 | * accidentally use Sockets it thinks are still bound to a particular {@link Network}. |
| 5179 | * To clear binding pass {@code null} for {@code network}. Using individually bound |
| 5180 | * Sockets created by Network.getSocketFactory().createSocket() and |
| 5181 | * performing network-specific host name resolutions via |
| 5182 | * {@link Network#getAllByName Network.getAllByName} is preferred to calling |
| 5183 | * {@code setProcessDefaultNetwork}. |
| 5184 | * |
| 5185 | * @param network The {@link Network} to bind the current process to, or {@code null} to clear |
| 5186 | * the current binding. |
| 5187 | * @return {@code true} on success, {@code false} if the {@link Network} is no longer valid. |
| 5188 | * @deprecated This function can throw {@link IllegalStateException}. Use |
| 5189 | * {@link #bindProcessToNetwork} instead. {@code bindProcessToNetwork} |
| 5190 | * is a direct replacement. |
| 5191 | */ |
| 5192 | @Deprecated |
| 5193 | public static boolean setProcessDefaultNetwork(@Nullable Network network) { |
| 5194 | int netId = (network == null) ? NETID_UNSET : network.netId; |
| 5195 | boolean isSameNetId = (netId == NetworkUtils.getBoundNetworkForProcess()); |
| 5196 | |
| 5197 | if (netId != NETID_UNSET) { |
| 5198 | netId = network.getNetIdForResolv(); |
| 5199 | } |
| 5200 | |
| 5201 | if (!NetworkUtils.bindProcessToNetwork(netId)) { |
| 5202 | return false; |
| 5203 | } |
| 5204 | |
| 5205 | if (!isSameNetId) { |
| 5206 | // Set HTTP proxy system properties to match network. |
| 5207 | // TODO: Deprecate this static method and replace it with a non-static version. |
| 5208 | try { |
Remi NGUYEN VAN | 8a831d6 | 2021-02-03 10:18:20 +0900 | [diff] [blame] | 5209 | Proxy.setHttpProxyConfiguration(getInstance().getDefaultProxy()); |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 5210 | } catch (SecurityException e) { |
| 5211 | // The process doesn't have ACCESS_NETWORK_STATE, so we can't fetch the proxy. |
| 5212 | Log.e(TAG, "Can't set proxy properties", e); |
| 5213 | } |
| 5214 | // Must flush DNS cache as new network may have different DNS resolutions. |
Remi NGUYEN VAN | b2e919f | 2021-07-02 09:34:36 +0900 | [diff] [blame] | 5215 | InetAddress.clearDnsCache(); |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 5216 | // Must flush socket pool as idle sockets will be bound to previous network and may |
| 5217 | // cause subsequent fetches to be performed on old network. |
Orion Hodson | 1f4fa9f | 2021-05-25 21:02:02 +0100 | [diff] [blame] | 5218 | NetworkEventDispatcher.getInstance().dispatchNetworkConfigurationChange(); |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 5219 | } |
| 5220 | |
| 5221 | return true; |
| 5222 | } |
| 5223 | |
| 5224 | /** |
| 5225 | * Returns the {@link Network} currently bound to this process via |
| 5226 | * {@link #bindProcessToNetwork}, or {@code null} if no {@link Network} is explicitly bound. |
| 5227 | * |
| 5228 | * @return {@code Network} to which this process is bound, or {@code null}. |
| 5229 | */ |
| 5230 | @Nullable |
| 5231 | public Network getBoundNetworkForProcess() { |
| 5232 | // Forcing callers to call thru non-static function ensures ConnectivityManager |
| 5233 | // instantiated. |
| 5234 | return getProcessDefaultNetwork(); |
| 5235 | } |
| 5236 | |
| 5237 | /** |
| 5238 | * Returns the {@link Network} currently bound to this process via |
| 5239 | * {@link #bindProcessToNetwork}, or {@code null} if no {@link Network} is explicitly bound. |
| 5240 | * |
| 5241 | * @return {@code Network} to which this process is bound, or {@code null}. |
| 5242 | * @deprecated Using this function can lead to other functions throwing |
| 5243 | * {@link IllegalStateException}. Use {@link #getBoundNetworkForProcess} instead. |
| 5244 | * {@code getBoundNetworkForProcess} is a direct replacement. |
| 5245 | */ |
| 5246 | @Deprecated |
| 5247 | @Nullable |
| 5248 | public static Network getProcessDefaultNetwork() { |
| 5249 | int netId = NetworkUtils.getBoundNetworkForProcess(); |
| 5250 | if (netId == NETID_UNSET) return null; |
| 5251 | return new Network(netId); |
| 5252 | } |
| 5253 | |
| 5254 | private void unsupportedStartingFrom(int version) { |
| 5255 | if (Process.myUid() == Process.SYSTEM_UID) { |
| 5256 | // The getApplicationInfo() call we make below is not supported in system context. Let |
| 5257 | // the call through here, and rely on the fact that ConnectivityService will refuse to |
| 5258 | // allow the system to use these APIs anyway. |
| 5259 | return; |
| 5260 | } |
| 5261 | |
| 5262 | if (mContext.getApplicationInfo().targetSdkVersion >= version) { |
| 5263 | throw new UnsupportedOperationException( |
| 5264 | "This method is not supported in target SDK version " + version + " and above"); |
| 5265 | } |
| 5266 | } |
| 5267 | |
| 5268 | // Checks whether the calling app can use the legacy routing API (startUsingNetworkFeature, |
| 5269 | // stopUsingNetworkFeature, requestRouteToHost), and if not throw UnsupportedOperationException. |
| 5270 | // TODO: convert the existing system users (Tethering, GnssLocationProvider) to the new APIs and |
| 5271 | // remove these exemptions. Note that this check is not secure, and apps can still access these |
| 5272 | // functions by accessing ConnectivityService directly. However, it should be clear that doing |
| 5273 | // so is unsupported and may break in the future. http://b/22728205 |
| 5274 | private void checkLegacyRoutingApiAccess() { |
| 5275 | unsupportedStartingFrom(VERSION_CODES.M); |
| 5276 | } |
| 5277 | |
| 5278 | /** |
| 5279 | * Binds host resolutions performed by this process to {@code network}. |
| 5280 | * {@link #bindProcessToNetwork} takes precedence over this setting. |
| 5281 | * |
| 5282 | * @param network The {@link Network} to bind host resolutions from the current process to, or |
| 5283 | * {@code null} to clear the current binding. |
| 5284 | * @return {@code true} on success, {@code false} if the {@link Network} is no longer valid. |
| 5285 | * @hide |
| 5286 | * @deprecated This is strictly for legacy usage to support {@link #startUsingNetworkFeature}. |
| 5287 | */ |
| 5288 | @Deprecated |
| 5289 | @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553) |
| 5290 | public static boolean setProcessDefaultNetworkForHostResolution(Network network) { |
| 5291 | return NetworkUtils.bindProcessToNetworkForHostResolution( |
| 5292 | (network == null) ? NETID_UNSET : network.getNetIdForResolv()); |
| 5293 | } |
| 5294 | |
| 5295 | /** |
| 5296 | * Device is not restricting metered network activity while application is running on |
| 5297 | * background. |
| 5298 | */ |
| 5299 | public static final int RESTRICT_BACKGROUND_STATUS_DISABLED = 1; |
| 5300 | |
| 5301 | /** |
| 5302 | * Device is restricting metered network activity while application is running on background, |
| 5303 | * but application is allowed to bypass it. |
| 5304 | * <p> |
| 5305 | * In this state, application should take action to mitigate metered network access. |
| 5306 | * For example, a music streaming application should switch to a low-bandwidth bitrate. |
| 5307 | */ |
| 5308 | public static final int RESTRICT_BACKGROUND_STATUS_WHITELISTED = 2; |
| 5309 | |
| 5310 | /** |
| 5311 | * Device is restricting metered network activity while application is running on background. |
| 5312 | * <p> |
| 5313 | * In this state, application should not try to use the network while running on background, |
| 5314 | * because it would be denied. |
| 5315 | */ |
| 5316 | public static final int RESTRICT_BACKGROUND_STATUS_ENABLED = 3; |
| 5317 | |
| 5318 | /** |
| 5319 | * A change in the background metered network activity restriction has occurred. |
| 5320 | * <p> |
| 5321 | * Applications should call {@link #getRestrictBackgroundStatus()} to check if the restriction |
| 5322 | * applies to them. |
| 5323 | * <p> |
| 5324 | * This is only sent to registered receivers, not manifest receivers. |
| 5325 | */ |
| 5326 | @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION) |
| 5327 | public static final String ACTION_RESTRICT_BACKGROUND_CHANGED = |
| 5328 | "android.net.conn.RESTRICT_BACKGROUND_CHANGED"; |
| 5329 | |
Aaron Huang | cff2294 | 2021-05-27 16:31:26 +0800 | [diff] [blame] | 5330 | /** @hide */ |
| 5331 | @Retention(RetentionPolicy.SOURCE) |
| 5332 | @IntDef(flag = false, value = { |
| 5333 | RESTRICT_BACKGROUND_STATUS_DISABLED, |
| 5334 | RESTRICT_BACKGROUND_STATUS_WHITELISTED, |
| 5335 | RESTRICT_BACKGROUND_STATUS_ENABLED, |
| 5336 | }) |
| 5337 | public @interface RestrictBackgroundStatus { |
| 5338 | } |
| 5339 | |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 5340 | /** |
| 5341 | * Determines if the calling application is subject to metered network restrictions while |
| 5342 | * running on background. |
| 5343 | * |
| 5344 | * @return {@link #RESTRICT_BACKGROUND_STATUS_DISABLED}, |
| 5345 | * {@link #RESTRICT_BACKGROUND_STATUS_ENABLED}, |
| 5346 | * or {@link #RESTRICT_BACKGROUND_STATUS_WHITELISTED} |
| 5347 | */ |
| 5348 | public @RestrictBackgroundStatus int getRestrictBackgroundStatus() { |
| 5349 | try { |
Remi NGUYEN VAN | 1fdeb50 | 2021-03-18 14:23:12 +0900 | [diff] [blame] | 5350 | return mService.getRestrictBackgroundStatusByCaller(); |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 5351 | } catch (RemoteException e) { |
| 5352 | throw e.rethrowFromSystemServer(); |
| 5353 | } |
| 5354 | } |
| 5355 | |
| 5356 | /** |
| 5357 | * The network watchlist is a list of domains and IP addresses that are associated with |
| 5358 | * potentially harmful apps. This method returns the SHA-256 of the watchlist config file |
| 5359 | * currently used by the system for validation purposes. |
| 5360 | * |
| 5361 | * @return Hash of network watchlist config file. Null if config does not exist. |
| 5362 | */ |
| 5363 | @Nullable |
| 5364 | public byte[] getNetworkWatchlistConfigHash() { |
| 5365 | try { |
| 5366 | return mService.getNetworkWatchlistConfigHash(); |
| 5367 | } catch (RemoteException e) { |
| 5368 | Log.e(TAG, "Unable to get watchlist config hash"); |
| 5369 | throw e.rethrowFromSystemServer(); |
| 5370 | } |
| 5371 | } |
| 5372 | |
| 5373 | /** |
| 5374 | * Returns the {@code uid} of the owner of a network connection. |
| 5375 | * |
| 5376 | * @param protocol The protocol of the connection. Only {@code IPPROTO_TCP} and {@code |
| 5377 | * IPPROTO_UDP} currently supported. |
| 5378 | * @param local The local {@link InetSocketAddress} of a connection. |
| 5379 | * @param remote The remote {@link InetSocketAddress} of a connection. |
| 5380 | * @return {@code uid} if the connection is found and the app has permission to observe it |
| 5381 | * (e.g., if it is associated with the calling VPN app's VpnService tunnel) or {@link |
| 5382 | * android.os.Process#INVALID_UID} if the connection is not found. |
| 5383 | * @throws {@link SecurityException} if the caller is not the active VpnService for the current |
| 5384 | * user. |
| 5385 | * @throws {@link IllegalArgumentException} if an unsupported protocol is requested. |
| 5386 | */ |
| 5387 | public int getConnectionOwnerUid( |
| 5388 | int protocol, @NonNull InetSocketAddress local, @NonNull InetSocketAddress remote) { |
| 5389 | ConnectionInfo connectionInfo = new ConnectionInfo(protocol, local, remote); |
| 5390 | try { |
| 5391 | return mService.getConnectionOwnerUid(connectionInfo); |
| 5392 | } catch (RemoteException e) { |
| 5393 | throw e.rethrowFromSystemServer(); |
| 5394 | } |
| 5395 | } |
| 5396 | |
| 5397 | private void printStackTrace() { |
| 5398 | if (DEBUG) { |
| 5399 | final StackTraceElement[] callStack = Thread.currentThread().getStackTrace(); |
| 5400 | final StringBuffer sb = new StringBuffer(); |
| 5401 | for (int i = 3; i < callStack.length; i++) { |
| 5402 | final String stackTrace = callStack[i].toString(); |
| 5403 | if (stackTrace == null || stackTrace.contains("android.os")) { |
| 5404 | break; |
| 5405 | } |
| 5406 | sb.append(" [").append(stackTrace).append("]"); |
| 5407 | } |
| 5408 | Log.d(TAG, "StackLog:" + sb.toString()); |
| 5409 | } |
| 5410 | } |
| 5411 | |
Remi NGUYEN VAN | 91444ca | 2021-01-15 23:02:47 +0900 | [diff] [blame] | 5412 | /** @hide */ |
| 5413 | public TestNetworkManager startOrGetTestNetworkManager() { |
| 5414 | final IBinder tnBinder; |
| 5415 | try { |
| 5416 | tnBinder = mService.startOrGetTestNetworkService(); |
| 5417 | } catch (RemoteException e) { |
| 5418 | throw e.rethrowFromSystemServer(); |
| 5419 | } |
| 5420 | |
| 5421 | return new TestNetworkManager(ITestNetworkManager.Stub.asInterface(tnBinder)); |
| 5422 | } |
| 5423 | |
Remi NGUYEN VAN | 91444ca | 2021-01-15 23:02:47 +0900 | [diff] [blame] | 5424 | /** @hide */ |
| 5425 | public ConnectivityDiagnosticsManager createDiagnosticsManager() { |
| 5426 | return new ConnectivityDiagnosticsManager(mContext, mService); |
| 5427 | } |
| 5428 | |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 5429 | /** |
| 5430 | * Simulates a Data Stall for the specified Network. |
| 5431 | * |
| 5432 | * <p>This method should only be used for tests. |
| 5433 | * |
Remi NGUYEN VAN | 564f7f8 | 2021-04-08 16:26:20 +0900 | [diff] [blame] | 5434 | * <p>The caller must be the owner of the specified Network. This simulates a data stall to |
| 5435 | * have the system behave as if it had happened, but does not actually stall connectivity. |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 5436 | * |
| 5437 | * @param detectionMethod The detection method used to identify the Data Stall. |
Remi NGUYEN VAN | 564f7f8 | 2021-04-08 16:26:20 +0900 | [diff] [blame] | 5438 | * See ConnectivityDiagnosticsManager.DataStallReport.DETECTION_METHOD_*. |
| 5439 | * @param timestampMillis The timestamp at which the stall 'occurred', in milliseconds, as per |
| 5440 | * SystemClock.elapsedRealtime. |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 5441 | * @param network The Network for which a Data Stall is being simluated. |
| 5442 | * @param extras The PersistableBundle of extras included in the Data Stall notification. |
| 5443 | * @throws SecurityException if the caller is not the owner of the given network. |
| 5444 | * @hide |
| 5445 | */ |
| 5446 | @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES) |
| 5447 | @RequiresPermission(anyOf = {android.Manifest.permission.MANAGE_TEST_NETWORKS, |
| 5448 | android.Manifest.permission.NETWORK_STACK}) |
Remi NGUYEN VAN | 564f7f8 | 2021-04-08 16:26:20 +0900 | [diff] [blame] | 5449 | public void simulateDataStall(@DetectionMethod int detectionMethod, long timestampMillis, |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 5450 | @NonNull Network network, @NonNull PersistableBundle extras) { |
| 5451 | try { |
| 5452 | mService.simulateDataStall(detectionMethod, timestampMillis, network, extras); |
| 5453 | } catch (RemoteException e) { |
| 5454 | e.rethrowFromSystemServer(); |
| 5455 | } |
| 5456 | } |
| 5457 | |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 5458 | @NonNull |
| 5459 | private final List<QosCallbackConnection> mQosCallbackConnections = new ArrayList<>(); |
| 5460 | |
| 5461 | /** |
| 5462 | * Registers a {@link QosSocketInfo} with an associated {@link QosCallback}. The callback will |
| 5463 | * receive available QoS events related to the {@link Network} and local ip + port |
| 5464 | * specified within socketInfo. |
| 5465 | * <p/> |
| 5466 | * The same {@link QosCallback} must be unregistered before being registered a second time, |
| 5467 | * otherwise {@link QosCallbackRegistrationException} is thrown. |
| 5468 | * <p/> |
| 5469 | * This API does not, in itself, require any permission if called with a network that is not |
| 5470 | * restricted. However, the underlying implementation currently only supports the IMS network, |
| 5471 | * which is always restricted. That means non-preinstalled callers can't possibly find this API |
| 5472 | * useful, because they'd never be called back on networks that they would have access to. |
| 5473 | * |
| 5474 | * @throws SecurityException if {@link QosSocketInfo#getNetwork()} is restricted and the app is |
| 5475 | * missing CONNECTIVITY_USE_RESTRICTED_NETWORKS permission. |
| 5476 | * @throws QosCallback.QosCallbackRegistrationException if qosCallback is already registered. |
| 5477 | * @throws RuntimeException if the app already has too many callbacks registered. |
| 5478 | * |
| 5479 | * Exceptions after the time of registration is passed through |
| 5480 | * {@link QosCallback#onError(QosCallbackException)}. see: {@link QosCallbackException}. |
| 5481 | * |
| 5482 | * @param socketInfo the socket information used to match QoS events |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 5483 | * @param executor The executor on which the callback will be invoked. The provided |
| 5484 | * {@link Executor} must run callback sequentially, otherwise the order of |
Daniel Bright | 686d5d2 | 2021-03-10 11:51:50 -0800 | [diff] [blame] | 5485 | * callbacks cannot be guaranteed.onQosCallbackRegistered |
| 5486 | * @param callback receives qos events that satisfy socketInfo |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 5487 | * |
| 5488 | * @hide |
| 5489 | */ |
| 5490 | @SystemApi |
| 5491 | public void registerQosCallback(@NonNull final QosSocketInfo socketInfo, |
Daniel Bright | 686d5d2 | 2021-03-10 11:51:50 -0800 | [diff] [blame] | 5492 | @CallbackExecutor @NonNull final Executor executor, |
| 5493 | @NonNull final QosCallback callback) { |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 5494 | Objects.requireNonNull(socketInfo, "socketInfo must be non-null"); |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 5495 | Objects.requireNonNull(executor, "executor must be non-null"); |
Daniel Bright | 686d5d2 | 2021-03-10 11:51:50 -0800 | [diff] [blame] | 5496 | Objects.requireNonNull(callback, "callback must be non-null"); |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 5497 | |
| 5498 | try { |
| 5499 | synchronized (mQosCallbackConnections) { |
| 5500 | if (getQosCallbackConnection(callback) == null) { |
| 5501 | final QosCallbackConnection connection = |
| 5502 | new QosCallbackConnection(this, callback, executor); |
| 5503 | mQosCallbackConnections.add(connection); |
| 5504 | mService.registerQosSocketCallback(socketInfo, connection); |
| 5505 | } else { |
| 5506 | Log.e(TAG, "registerQosCallback: Callback already registered"); |
| 5507 | throw new QosCallbackRegistrationException(); |
| 5508 | } |
| 5509 | } |
| 5510 | } catch (final RemoteException e) { |
| 5511 | Log.e(TAG, "registerQosCallback: Error while registering ", e); |
| 5512 | |
| 5513 | // The same unregister method method is called for consistency even though nothing |
| 5514 | // will be sent to the ConnectivityService since the callback was never successfully |
| 5515 | // registered. |
| 5516 | unregisterQosCallback(callback); |
| 5517 | e.rethrowFromSystemServer(); |
| 5518 | } catch (final ServiceSpecificException e) { |
| 5519 | Log.e(TAG, "registerQosCallback: Error while registering ", e); |
| 5520 | unregisterQosCallback(callback); |
| 5521 | throw convertServiceException(e); |
| 5522 | } |
| 5523 | } |
| 5524 | |
| 5525 | /** |
| 5526 | * Unregisters the given {@link QosCallback}. The {@link QosCallback} will no longer receive |
| 5527 | * events once unregistered and can be registered a second time. |
| 5528 | * <p/> |
| 5529 | * If the {@link QosCallback} does not have an active registration, it is a no-op. |
| 5530 | * |
| 5531 | * @param callback the callback being unregistered |
| 5532 | * |
| 5533 | * @hide |
| 5534 | */ |
| 5535 | @SystemApi |
| 5536 | public void unregisterQosCallback(@NonNull final QosCallback callback) { |
| 5537 | Objects.requireNonNull(callback, "The callback must be non-null"); |
| 5538 | try { |
| 5539 | synchronized (mQosCallbackConnections) { |
| 5540 | final QosCallbackConnection connection = getQosCallbackConnection(callback); |
| 5541 | if (connection != null) { |
| 5542 | connection.stopReceivingMessages(); |
| 5543 | mService.unregisterQosCallback(connection); |
| 5544 | mQosCallbackConnections.remove(connection); |
| 5545 | } else { |
| 5546 | Log.d(TAG, "unregisterQosCallback: Callback not registered"); |
| 5547 | } |
| 5548 | } |
| 5549 | } catch (final RemoteException e) { |
| 5550 | Log.e(TAG, "unregisterQosCallback: Error while unregistering ", e); |
| 5551 | e.rethrowFromSystemServer(); |
| 5552 | } |
| 5553 | } |
| 5554 | |
| 5555 | /** |
| 5556 | * Gets the connection related to the callback. |
| 5557 | * |
| 5558 | * @param callback the callback to look up |
| 5559 | * @return the related connection |
| 5560 | */ |
| 5561 | @Nullable |
| 5562 | private QosCallbackConnection getQosCallbackConnection(final QosCallback callback) { |
| 5563 | for (final QosCallbackConnection connection : mQosCallbackConnections) { |
| 5564 | // Checking by reference here is intentional |
| 5565 | if (connection.getCallback() == callback) { |
| 5566 | return connection; |
| 5567 | } |
| 5568 | } |
| 5569 | return null; |
| 5570 | } |
| 5571 | |
| 5572 | /** |
Roshan Pius | e08bc18 | 2020-12-22 15:10:42 -0800 | [diff] [blame] | 5573 | * Request a network to satisfy a set of {@link NetworkCapabilities}, but |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 5574 | * does not cause any networks to retain the NET_CAPABILITY_FOREGROUND capability. This can |
| 5575 | * be used to request that the system provide a network without causing the network to be |
| 5576 | * in the foreground. |
| 5577 | * |
| 5578 | * <p>This method will attempt to find the best network that matches the passed |
| 5579 | * {@link NetworkRequest}, and to bring up one that does if none currently satisfies the |
| 5580 | * criteria. The platform will evaluate which network is the best at its own discretion. |
| 5581 | * Throughput, latency, cost per byte, policy, user preference and other considerations |
| 5582 | * may be factored in the decision of what is considered the best network. |
| 5583 | * |
| 5584 | * <p>As long as this request is outstanding, the platform will try to maintain the best network |
| 5585 | * matching this request, while always attempting to match the request to a better network if |
| 5586 | * possible. If a better match is found, the platform will switch this request to the now-best |
| 5587 | * network and inform the app of the newly best network by invoking |
| 5588 | * {@link NetworkCallback#onAvailable(Network)} on the provided callback. Note that the platform |
| 5589 | * will not try to maintain any other network than the best one currently matching the request: |
| 5590 | * a network not matching any network request may be disconnected at any time. |
| 5591 | * |
| 5592 | * <p>For example, an application could use this method to obtain a connected cellular network |
| 5593 | * even if the device currently has a data connection over Ethernet. This may cause the cellular |
| 5594 | * radio to consume additional power. Or, an application could inform the system that it wants |
| 5595 | * a network supporting sending MMSes and have the system let it know about the currently best |
| 5596 | * MMS-supporting network through the provided {@link NetworkCallback}. |
| 5597 | * |
| 5598 | * <p>The status of the request can be followed by listening to the various callbacks described |
| 5599 | * in {@link NetworkCallback}. The {@link Network} object passed to the callback methods can be |
| 5600 | * used to direct traffic to the network (although accessing some networks may be subject to |
| 5601 | * holding specific permissions). Callers will learn about the specific characteristics of the |
| 5602 | * network through |
| 5603 | * {@link NetworkCallback#onCapabilitiesChanged(Network, NetworkCapabilities)} and |
| 5604 | * {@link NetworkCallback#onLinkPropertiesChanged(Network, LinkProperties)}. The methods of the |
| 5605 | * provided {@link NetworkCallback} will only be invoked due to changes in the best network |
| 5606 | * matching the request at any given time; therefore when a better network matching the request |
| 5607 | * becomes available, the {@link NetworkCallback#onAvailable(Network)} method is called |
| 5608 | * with the new network after which no further updates are given about the previously-best |
| 5609 | * network, unless it becomes the best again at some later time. All callbacks are invoked |
| 5610 | * in order on the same thread, which by default is a thread created by the framework running |
| 5611 | * in the app. |
| 5612 | * |
| 5613 | * <p>This{@link NetworkRequest} will live until released via |
| 5614 | * {@link #unregisterNetworkCallback(NetworkCallback)} or the calling application exits, at |
| 5615 | * which point the system may let go of the network at any time. |
| 5616 | * |
| 5617 | * <p>It is presently unsupported to request a network with mutable |
| 5618 | * {@link NetworkCapabilities} such as |
| 5619 | * {@link NetworkCapabilities#NET_CAPABILITY_VALIDATED} or |
| 5620 | * {@link NetworkCapabilities#NET_CAPABILITY_CAPTIVE_PORTAL} |
| 5621 | * as these {@code NetworkCapabilities} represent states that a particular |
| 5622 | * network may never attain, and whether a network will attain these states |
| 5623 | * is unknown prior to bringing up the network so the framework does not |
| 5624 | * know how to go about satisfying a request with these capabilities. |
| 5625 | * |
| 5626 | * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the |
| 5627 | * number of outstanding requests to 100 per app (identified by their UID), shared with |
| 5628 | * all variants of this method, of {@link #registerNetworkCallback} as well as |
| 5629 | * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}. |
| 5630 | * Requesting a network with this method will count toward this limit. If this limit is |
| 5631 | * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources, |
| 5632 | * make sure to unregister the callbacks with |
| 5633 | * {@link #unregisterNetworkCallback(NetworkCallback)}. |
| 5634 | * |
| 5635 | * @param request {@link NetworkRequest} describing this request. |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 5636 | * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note |
| 5637 | * the callback must not be shared - it uniquely specifies this request. |
junyulai | ca657cb | 2021-04-15 00:39:49 +0800 | [diff] [blame] | 5638 | * @param handler {@link Handler} to specify the thread upon which the callback will be invoked. |
| 5639 | * If null, the callback is invoked on the default internal Handler. |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 5640 | * @throws IllegalArgumentException if {@code request} contains invalid network capabilities. |
| 5641 | * @throws SecurityException if missing the appropriate permissions. |
| 5642 | * @throws RuntimeException if the app already has too many callbacks registered. |
| 5643 | * |
| 5644 | * @hide |
| 5645 | */ |
| 5646 | @SystemApi(client = MODULE_LIBRARIES) |
| 5647 | @SuppressLint("ExecutorRegistration") |
| 5648 | @RequiresPermission(anyOf = { |
| 5649 | android.Manifest.permission.NETWORK_SETTINGS, |
| 5650 | android.Manifest.permission.NETWORK_STACK, |
| 5651 | NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK |
| 5652 | }) |
| 5653 | public void requestBackgroundNetwork(@NonNull NetworkRequest request, |
junyulai | ca657cb | 2021-04-15 00:39:49 +0800 | [diff] [blame] | 5654 | @NonNull NetworkCallback networkCallback, |
| 5655 | @SuppressLint("ListenerLast") @NonNull Handler handler) { |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 5656 | final NetworkCapabilities nc = request.networkCapabilities; |
| 5657 | sendRequestForNetwork(nc, networkCallback, 0, BACKGROUND_REQUEST, |
junyulai | dbb7046 | 2021-03-09 20:49:48 +0800 | [diff] [blame] | 5658 | TYPE_NONE, new CallbackHandler(handler)); |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 5659 | } |
James Mattis | 12aeab8 | 2021-01-10 14:24:24 -0800 | [diff] [blame] | 5660 | |
| 5661 | /** |
James Mattis | 12aeab8 | 2021-01-10 14:24:24 -0800 | [diff] [blame] | 5662 | * Used by automotive devices to set the network preferences used to direct traffic at an |
| 5663 | * application level as per the given OemNetworkPreferences. An example use-case would be an |
| 5664 | * automotive OEM wanting to provide connectivity for applications critical to the usage of a |
| 5665 | * vehicle via a particular network. |
| 5666 | * |
| 5667 | * Calling this will overwrite the existing preference. |
| 5668 | * |
| 5669 | * @param preference {@link OemNetworkPreferences} The application network preference to be set. |
| 5670 | * @param executor the executor on which listener will be invoked. |
| 5671 | * @param listener {@link OnSetOemNetworkPreferenceListener} optional listener used to |
| 5672 | * communicate completion of setOemNetworkPreference(). This will only be |
| 5673 | * called once upon successful completion of setOemNetworkPreference(). |
| 5674 | * @throws IllegalArgumentException if {@code preference} contains invalid preference values. |
| 5675 | * @throws SecurityException if missing the appropriate permissions. |
| 5676 | * @throws UnsupportedOperationException if called on a non-automotive device. |
James Mattis | 6e2d702 | 2021-01-26 16:23:52 -0800 | [diff] [blame] | 5677 | * @hide |
James Mattis | 12aeab8 | 2021-01-10 14:24:24 -0800 | [diff] [blame] | 5678 | */ |
James Mattis | 6e2d702 | 2021-01-26 16:23:52 -0800 | [diff] [blame] | 5679 | @SystemApi |
James Mattis | a46c144 | 2021-01-26 14:05:36 -0800 | [diff] [blame] | 5680 | @RequiresPermission(android.Manifest.permission.CONTROL_OEM_PAID_NETWORK_PREFERENCE) |
James Mattis | 6e2d702 | 2021-01-26 16:23:52 -0800 | [diff] [blame] | 5681 | public void setOemNetworkPreference(@NonNull final OemNetworkPreferences preference, |
James Mattis | 12aeab8 | 2021-01-10 14:24:24 -0800 | [diff] [blame] | 5682 | @Nullable @CallbackExecutor final Executor executor, |
Chalard Jean | 0a4aefc | 2021-03-03 16:37:13 +0900 | [diff] [blame] | 5683 | @Nullable final Runnable listener) { |
James Mattis | 12aeab8 | 2021-01-10 14:24:24 -0800 | [diff] [blame] | 5684 | Objects.requireNonNull(preference, "OemNetworkPreferences must be non-null"); |
| 5685 | if (null != listener) { |
| 5686 | Objects.requireNonNull(executor, "Executor must be non-null"); |
| 5687 | } |
Chalard Jean | 0a4aefc | 2021-03-03 16:37:13 +0900 | [diff] [blame] | 5688 | final IOnCompleteListener listenerInternal = listener == null ? null : |
| 5689 | new IOnCompleteListener.Stub() { |
James Mattis | 12aeab8 | 2021-01-10 14:24:24 -0800 | [diff] [blame] | 5690 | @Override |
| 5691 | public void onComplete() { |
Chalard Jean | 0a4aefc | 2021-03-03 16:37:13 +0900 | [diff] [blame] | 5692 | executor.execute(listener::run); |
James Mattis | 12aeab8 | 2021-01-10 14:24:24 -0800 | [diff] [blame] | 5693 | } |
| 5694 | }; |
| 5695 | |
| 5696 | try { |
| 5697 | mService.setOemNetworkPreference(preference, listenerInternal); |
| 5698 | } catch (RemoteException e) { |
| 5699 | Log.e(TAG, "setOemNetworkPreference() failed for preference: " + preference.toString()); |
| 5700 | throw e.rethrowFromSystemServer(); |
| 5701 | } |
| 5702 | } |
lucaslin | 5cdbcfb | 2021-03-12 00:46:33 +0800 | [diff] [blame] | 5703 | |
Chalard Jean | ad565e2 | 2021-02-25 17:23:40 +0900 | [diff] [blame] | 5704 | /** |
| 5705 | * Request that a user profile is put by default on a network matching a given preference. |
| 5706 | * |
| 5707 | * See the documentation for the individual preferences for a description of the supported |
| 5708 | * behaviors. |
| 5709 | * |
| 5710 | * @param profile the profile concerned. |
| 5711 | * @param preference the preference for this profile. |
| 5712 | * @param executor an executor to execute the listener on. Optional if listener is null. |
| 5713 | * @param listener an optional listener to listen for completion of the operation. |
| 5714 | * @throws IllegalArgumentException if {@code profile} is not a valid user profile. |
| 5715 | * @throws SecurityException if missing the appropriate permissions. |
Sooraj Sasindran | e7aee27 | 2021-11-24 20:26:55 -0800 | [diff] [blame] | 5716 | * @deprecated Use {@link #setProfileNetworkPreferences(UserHandle, List, Executor, Runnable)} |
| 5717 | * instead as it provides a more flexible API with more options. |
Chalard Jean | ad565e2 | 2021-02-25 17:23:40 +0900 | [diff] [blame] | 5718 | * @hide |
| 5719 | */ |
Chalard Jean | 0a4aefc | 2021-03-03 16:37:13 +0900 | [diff] [blame] | 5720 | // This function is for establishing per-profile default networking and can only be called by |
| 5721 | // the device policy manager, running as the system server. It would make no sense to call it |
| 5722 | // on a context for a user because it does not establish a setting on behalf of a user, rather |
| 5723 | // it establishes a setting for a user on behalf of the DPM. |
| 5724 | @SuppressLint({"UserHandle"}) |
| 5725 | @SystemApi(client = MODULE_LIBRARIES) |
Chalard Jean | ad565e2 | 2021-02-25 17:23:40 +0900 | [diff] [blame] | 5726 | @RequiresPermission(android.Manifest.permission.NETWORK_STACK) |
Sooraj Sasindran | e7aee27 | 2021-11-24 20:26:55 -0800 | [diff] [blame] | 5727 | @Deprecated |
Chalard Jean | ad565e2 | 2021-02-25 17:23:40 +0900 | [diff] [blame] | 5728 | public void setProfileNetworkPreference(@NonNull final UserHandle profile, |
Sooraj Sasindran | e7aee27 | 2021-11-24 20:26:55 -0800 | [diff] [blame] | 5729 | @ProfileNetworkPreferencePolicy final int preference, |
| 5730 | @Nullable @CallbackExecutor final Executor executor, |
| 5731 | @Nullable final Runnable listener) { |
| 5732 | |
| 5733 | ProfileNetworkPreference.Builder preferenceBuilder = |
| 5734 | new ProfileNetworkPreference.Builder(); |
| 5735 | preferenceBuilder.setPreference(preference); |
Sooraj Sasindran | f4a58dc | 2022-01-21 13:37:08 -0800 | [diff] [blame] | 5736 | if (preference != PROFILE_NETWORK_PREFERENCE_DEFAULT) { |
| 5737 | preferenceBuilder.setPreferenceEnterpriseId(NET_ENTERPRISE_ID_1); |
| 5738 | } |
Sooraj Sasindran | e7aee27 | 2021-11-24 20:26:55 -0800 | [diff] [blame] | 5739 | setProfileNetworkPreferences(profile, |
| 5740 | List.of(preferenceBuilder.build()), executor, listener); |
| 5741 | } |
| 5742 | |
| 5743 | /** |
| 5744 | * Set a list of default network selection policies for a user profile. |
| 5745 | * |
| 5746 | * Calling this API with a user handle defines the entire policy for that user handle. |
| 5747 | * It will overwrite any setting previously set for the same user profile, |
| 5748 | * and not affect previously set settings for other handles. |
| 5749 | * |
| 5750 | * Call this API with an empty list to remove settings for this user profile. |
| 5751 | * |
| 5752 | * See {@link ProfileNetworkPreference} for more details on each preference |
| 5753 | * parameter. |
| 5754 | * |
| 5755 | * @param profile the user profile for which the preference is being set. |
| 5756 | * @param profileNetworkPreferences the list of profile network preferences for the |
| 5757 | * provided profile. |
| 5758 | * @param executor an executor to execute the listener on. Optional if listener is null. |
| 5759 | * @param listener an optional listener to listen for completion of the operation. |
| 5760 | * @throws IllegalArgumentException if {@code profile} is not a valid user profile. |
| 5761 | * @throws SecurityException if missing the appropriate permissions. |
| 5762 | * @hide |
| 5763 | */ |
| 5764 | @SystemApi(client = MODULE_LIBRARIES) |
| 5765 | @RequiresPermission(android.Manifest.permission.NETWORK_STACK) |
| 5766 | public void setProfileNetworkPreferences( |
| 5767 | @NonNull final UserHandle profile, |
| 5768 | @NonNull List<ProfileNetworkPreference> profileNetworkPreferences, |
Chalard Jean | ad565e2 | 2021-02-25 17:23:40 +0900 | [diff] [blame] | 5769 | @Nullable @CallbackExecutor final Executor executor, |
| 5770 | @Nullable final Runnable listener) { |
| 5771 | if (null != listener) { |
| 5772 | Objects.requireNonNull(executor, "Pass a non-null executor, or a null listener"); |
| 5773 | } |
| 5774 | final IOnCompleteListener proxy; |
| 5775 | if (null == listener) { |
| 5776 | proxy = null; |
| 5777 | } else { |
| 5778 | proxy = new IOnCompleteListener.Stub() { |
| 5779 | @Override |
| 5780 | public void onComplete() { |
| 5781 | executor.execute(listener::run); |
| 5782 | } |
| 5783 | }; |
| 5784 | } |
| 5785 | try { |
Sooraj Sasindran | e7aee27 | 2021-11-24 20:26:55 -0800 | [diff] [blame] | 5786 | mService.setProfileNetworkPreferences(profile, profileNetworkPreferences, proxy); |
Chalard Jean | ad565e2 | 2021-02-25 17:23:40 +0900 | [diff] [blame] | 5787 | } catch (RemoteException e) { |
| 5788 | throw e.rethrowFromSystemServer(); |
| 5789 | } |
| 5790 | } |
| 5791 | |
lucaslin | 5cdbcfb | 2021-03-12 00:46:33 +0800 | [diff] [blame] | 5792 | // The first network ID of IPSec tunnel interface. |
lucaslin | c296fcc | 2021-03-15 17:24:12 +0800 | [diff] [blame] | 5793 | private static final int TUN_INTF_NETID_START = 0xFC00; // 0xFC00 = 64512 |
lucaslin | 5cdbcfb | 2021-03-12 00:46:33 +0800 | [diff] [blame] | 5794 | // The network ID range of IPSec tunnel interface. |
lucaslin | c296fcc | 2021-03-15 17:24:12 +0800 | [diff] [blame] | 5795 | private static final int TUN_INTF_NETID_RANGE = 0x0400; // 0x0400 = 1024 |
lucaslin | 5cdbcfb | 2021-03-12 00:46:33 +0800 | [diff] [blame] | 5796 | |
| 5797 | /** |
| 5798 | * Get the network ID range reserved for IPSec tunnel interfaces. |
| 5799 | * |
| 5800 | * @return A Range which indicates the network ID range of IPSec tunnel interface. |
| 5801 | * @hide |
| 5802 | */ |
| 5803 | @SystemApi(client = MODULE_LIBRARIES) |
| 5804 | @NonNull |
| 5805 | public static Range<Integer> getIpSecNetIdRange() { |
| 5806 | return new Range(TUN_INTF_NETID_START, TUN_INTF_NETID_START + TUN_INTF_NETID_RANGE - 1); |
| 5807 | } |
markchien | 738ad91 | 2021-12-09 18:15:45 +0800 | [diff] [blame] | 5808 | |
| 5809 | /** |
markchien | e46042b | 2022-03-02 18:07:35 +0800 | [diff] [blame] | 5810 | * Adds the specified UID to the list of UIds that are allowed to use data on metered networks |
| 5811 | * even when background data is restricted. The deny list takes precedence over the allow list. |
markchien | 738ad91 | 2021-12-09 18:15:45 +0800 | [diff] [blame] | 5812 | * |
| 5813 | * @param uid uid of target app |
markchien | 68cfadc | 2022-01-14 13:39:54 +0800 | [diff] [blame] | 5814 | * @throws IllegalStateException if updating allow list failed. |
markchien | 738ad91 | 2021-12-09 18:15:45 +0800 | [diff] [blame] | 5815 | * @hide |
| 5816 | */ |
| 5817 | @SystemApi(client = MODULE_LIBRARIES) |
| 5818 | @RequiresPermission(anyOf = { |
| 5819 | android.Manifest.permission.NETWORK_SETTINGS, |
| 5820 | android.Manifest.permission.NETWORK_STACK, |
| 5821 | NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK |
| 5822 | }) |
markchien | e46042b | 2022-03-02 18:07:35 +0800 | [diff] [blame] | 5823 | public void addUidToMeteredNetworkAllowList(final int uid) { |
markchien | 738ad91 | 2021-12-09 18:15:45 +0800 | [diff] [blame] | 5824 | try { |
markchien | e46042b | 2022-03-02 18:07:35 +0800 | [diff] [blame] | 5825 | mService.updateMeteredNetworkAllowList(uid, true /* add */); |
markchien | 738ad91 | 2021-12-09 18:15:45 +0800 | [diff] [blame] | 5826 | } catch (RemoteException e) { |
| 5827 | throw e.rethrowFromSystemServer(); |
markchien | 738ad91 | 2021-12-09 18:15:45 +0800 | [diff] [blame] | 5828 | } |
| 5829 | } |
| 5830 | |
| 5831 | /** |
markchien | e46042b | 2022-03-02 18:07:35 +0800 | [diff] [blame] | 5832 | * Removes the specified UID from the list of UIDs that are allowed to use background data on |
| 5833 | * metered networks when background data is restricted. The deny list takes precedence over |
| 5834 | * the allow list. |
| 5835 | * |
| 5836 | * @param uid uid of target app |
| 5837 | * @throws IllegalStateException if updating allow list failed. |
| 5838 | * @hide |
| 5839 | */ |
| 5840 | @SystemApi(client = MODULE_LIBRARIES) |
| 5841 | @RequiresPermission(anyOf = { |
| 5842 | android.Manifest.permission.NETWORK_SETTINGS, |
| 5843 | android.Manifest.permission.NETWORK_STACK, |
| 5844 | NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK |
| 5845 | }) |
| 5846 | public void removeUidFromMeteredNetworkAllowList(final int uid) { |
| 5847 | try { |
| 5848 | mService.updateMeteredNetworkAllowList(uid, false /* remove */); |
| 5849 | } catch (RemoteException e) { |
| 5850 | throw e.rethrowFromSystemServer(); |
| 5851 | } |
| 5852 | } |
| 5853 | |
| 5854 | /** |
| 5855 | * Adds the specified UID to the list of UIDs that are not allowed to use background data on |
| 5856 | * metered networks. Takes precedence over {@link #addUidToMeteredNetworkAllowList}. |
markchien | 738ad91 | 2021-12-09 18:15:45 +0800 | [diff] [blame] | 5857 | * |
| 5858 | * @param uid uid of target app |
markchien | 68cfadc | 2022-01-14 13:39:54 +0800 | [diff] [blame] | 5859 | * @throws IllegalStateException if updating deny list failed. |
markchien | 738ad91 | 2021-12-09 18:15:45 +0800 | [diff] [blame] | 5860 | * @hide |
| 5861 | */ |
| 5862 | @SystemApi(client = MODULE_LIBRARIES) |
| 5863 | @RequiresPermission(anyOf = { |
| 5864 | android.Manifest.permission.NETWORK_SETTINGS, |
| 5865 | android.Manifest.permission.NETWORK_STACK, |
| 5866 | NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK |
| 5867 | }) |
markchien | e46042b | 2022-03-02 18:07:35 +0800 | [diff] [blame] | 5868 | public void addUidToMeteredNetworkDenyList(final int uid) { |
markchien | 738ad91 | 2021-12-09 18:15:45 +0800 | [diff] [blame] | 5869 | try { |
markchien | e46042b | 2022-03-02 18:07:35 +0800 | [diff] [blame] | 5870 | mService.updateMeteredNetworkDenyList(uid, true /* add */); |
| 5871 | } catch (RemoteException e) { |
| 5872 | throw e.rethrowFromSystemServer(); |
| 5873 | } |
| 5874 | } |
| 5875 | |
| 5876 | /** |
| 5877 | * Removes the specified UID from the list of UIds that can use use background data on metered |
| 5878 | * networks if background data is not restricted. The deny list takes precedence over the |
| 5879 | * allow list. |
| 5880 | * |
| 5881 | * @param uid uid of target app |
| 5882 | * @throws IllegalStateException if updating deny list failed. |
| 5883 | * @hide |
| 5884 | */ |
| 5885 | @SystemApi(client = MODULE_LIBRARIES) |
| 5886 | @RequiresPermission(anyOf = { |
| 5887 | android.Manifest.permission.NETWORK_SETTINGS, |
| 5888 | android.Manifest.permission.NETWORK_STACK, |
| 5889 | NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK |
| 5890 | }) |
| 5891 | public void removeUidFromMeteredNetworkDenyList(final int uid) { |
| 5892 | try { |
| 5893 | mService.updateMeteredNetworkDenyList(uid, false /* remove */); |
markchien | 738ad91 | 2021-12-09 18:15:45 +0800 | [diff] [blame] | 5894 | } catch (RemoteException e) { |
| 5895 | throw e.rethrowFromSystemServer(); |
markchien | e1561fa | 2021-12-09 22:00:56 +0800 | [diff] [blame] | 5896 | } |
| 5897 | } |
| 5898 | |
| 5899 | /** |
| 5900 | * Sets a firewall rule for the specified UID on the specified chain. |
| 5901 | * |
| 5902 | * @param chain target chain. |
| 5903 | * @param uid uid to allow/deny. |
markchien | 3c04e66 | 2022-03-22 16:29:56 +0800 | [diff] [blame] | 5904 | * @param rule firewall rule to allow/drop packets. |
markchien | 68cfadc | 2022-01-14 13:39:54 +0800 | [diff] [blame] | 5905 | * @throws IllegalStateException if updating firewall rule failed. |
markchien | 3c04e66 | 2022-03-22 16:29:56 +0800 | [diff] [blame] | 5906 | * @throws IllegalArgumentException if {@code rule} is not a valid rule. |
markchien | e1561fa | 2021-12-09 22:00:56 +0800 | [diff] [blame] | 5907 | * @hide |
| 5908 | */ |
| 5909 | @SystemApi(client = MODULE_LIBRARIES) |
| 5910 | @RequiresPermission(anyOf = { |
| 5911 | android.Manifest.permission.NETWORK_SETTINGS, |
| 5912 | android.Manifest.permission.NETWORK_STACK, |
| 5913 | NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK |
| 5914 | }) |
markchien | 3c04e66 | 2022-03-22 16:29:56 +0800 | [diff] [blame] | 5915 | public void setUidFirewallRule(@FirewallChain final int chain, final int uid, |
| 5916 | @FirewallRule final int rule) { |
markchien | e1561fa | 2021-12-09 22:00:56 +0800 | [diff] [blame] | 5917 | try { |
markchien | 3c04e66 | 2022-03-22 16:29:56 +0800 | [diff] [blame] | 5918 | mService.setUidFirewallRule(chain, uid, rule); |
markchien | e1561fa | 2021-12-09 22:00:56 +0800 | [diff] [blame] | 5919 | } catch (RemoteException e) { |
| 5920 | throw e.rethrowFromSystemServer(); |
markchien | 738ad91 | 2021-12-09 18:15:45 +0800 | [diff] [blame] | 5921 | } |
| 5922 | } |
markchien | 98a6f95 | 2022-01-13 23:43:53 +0800 | [diff] [blame] | 5923 | |
| 5924 | /** |
| 5925 | * Enables or disables the specified firewall chain. |
| 5926 | * |
| 5927 | * @param chain target chain. |
| 5928 | * @param enable whether the chain should be enabled. |
markchien | 68cfadc | 2022-01-14 13:39:54 +0800 | [diff] [blame] | 5929 | * @throws IllegalStateException if enabling or disabling the firewall chain failed. |
markchien | 98a6f95 | 2022-01-13 23:43:53 +0800 | [diff] [blame] | 5930 | * @hide |
| 5931 | */ |
| 5932 | @SystemApi(client = MODULE_LIBRARIES) |
| 5933 | @RequiresPermission(anyOf = { |
| 5934 | android.Manifest.permission.NETWORK_SETTINGS, |
| 5935 | android.Manifest.permission.NETWORK_STACK, |
| 5936 | NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK |
| 5937 | }) |
| 5938 | public void setFirewallChainEnabled(@FirewallChain final int chain, final boolean enable) { |
| 5939 | try { |
| 5940 | mService.setFirewallChainEnabled(chain, enable); |
| 5941 | } catch (RemoteException e) { |
| 5942 | throw e.rethrowFromSystemServer(); |
| 5943 | } |
| 5944 | } |
markchien | 00a0bed | 2022-01-13 23:46:13 +0800 | [diff] [blame] | 5945 | |
| 5946 | /** |
| 5947 | * Replaces the contents of the specified UID-based firewall chain. |
| 5948 | * |
| 5949 | * @param chain target chain to replace. |
| 5950 | * @param uids The list of UIDs to be placed into chain. |
markchien | 68cfadc | 2022-01-14 13:39:54 +0800 | [diff] [blame] | 5951 | * @throws IllegalStateException if replacing the firewall chain failed. |
markchien | 00a0bed | 2022-01-13 23:46:13 +0800 | [diff] [blame] | 5952 | * @throws IllegalArgumentException if {@code chain} is not a valid chain. |
| 5953 | * @hide |
| 5954 | */ |
| 5955 | @SystemApi(client = MODULE_LIBRARIES) |
| 5956 | @RequiresPermission(anyOf = { |
| 5957 | android.Manifest.permission.NETWORK_SETTINGS, |
| 5958 | android.Manifest.permission.NETWORK_STACK, |
| 5959 | NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK |
| 5960 | }) |
| 5961 | public void replaceFirewallChain(@FirewallChain final int chain, @NonNull final int[] uids) { |
| 5962 | Objects.requireNonNull(uids); |
| 5963 | try { |
| 5964 | mService.replaceFirewallChain(chain, uids); |
| 5965 | } catch (RemoteException e) { |
| 5966 | throw e.rethrowFromSystemServer(); |
| 5967 | } |
| 5968 | } |
Remi NGUYEN VAN | fbbccbc | 2021-01-15 18:08:24 +0900 | [diff] [blame] | 5969 | } |