blob: a174fe34cee24ea90be433247233d50a3023bc20 [file] [log] [blame]
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001/*
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 */
16package android.net;
17
18import static android.annotation.SystemApi.Client.MODULE_LIBRARIES;
Sooraj Sasindranf4a58dc2022-01-21 13:37:08 -080019import static android.net.NetworkCapabilities.NET_ENTERPRISE_ID_1;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +090020import static android.net.NetworkRequest.Type.BACKGROUND_REQUEST;
21import static android.net.NetworkRequest.Type.LISTEN;
junyulai7664f622021-03-12 20:05:08 +080022import static android.net.NetworkRequest.Type.LISTEN_FOR_BEST;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +090023import static android.net.NetworkRequest.Type.REQUEST;
24import static android.net.NetworkRequest.Type.TRACK_DEFAULT;
Lorenzo Colittia77d05e2021-01-29 20:14:04 +090025import static android.net.NetworkRequest.Type.TRACK_SYSTEM_DEFAULT;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +090026import static android.net.QosCallback.QosCallbackRegistrationException;
27
28import android.annotation.CallbackExecutor;
29import android.annotation.IntDef;
30import android.annotation.NonNull;
31import android.annotation.Nullable;
32import android.annotation.RequiresPermission;
33import android.annotation.SdkConstant;
34import android.annotation.SdkConstant.SdkConstantType;
35import android.annotation.SuppressLint;
36import android.annotation.SystemApi;
37import android.annotation.SystemService;
38import android.app.PendingIntent;
Lorenzo Colitti8ad58122021-03-18 00:54:57 +090039import android.app.admin.DevicePolicyManager;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +090040import android.compat.annotation.UnsupportedAppUsage;
Lorenzo Colitti8ad58122021-03-18 00:54:57 +090041import android.content.ComponentName;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +090042import android.content.Context;
43import android.content.Intent;
Remi NGUYEN VAN564f7f82021-04-08 16:26:20 +090044import android.net.ConnectivityDiagnosticsManager.DataStallReport.DetectionMethod;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +090045import android.net.IpSecManager.UdpEncapsulationSocket;
46import android.net.SocketKeepalive.Callback;
47import android.net.TetheringManager.StartTetheringCallback;
48import android.net.TetheringManager.TetheringEventCallback;
49import android.net.TetheringManager.TetheringRequest;
50import android.os.Binder;
51import android.os.Build;
52import android.os.Build.VERSION_CODES;
53import android.os.Bundle;
54import android.os.Handler;
55import android.os.IBinder;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +090056import android.os.Looper;
57import android.os.Message;
58import android.os.Messenger;
59import android.os.ParcelFileDescriptor;
60import android.os.PersistableBundle;
61import android.os.Process;
62import android.os.RemoteException;
63import android.os.ResultReceiver;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +090064import android.os.ServiceSpecificException;
Chalard Jeanad565e22021-02-25 17:23:40 +090065import android.os.UserHandle;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +090066import android.provider.Settings;
67import android.telephony.SubscriptionManager;
68import android.telephony.TelephonyManager;
69import android.util.ArrayMap;
70import android.util.Log;
71import android.util.Range;
72import android.util.SparseIntArray;
73
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +090074import com.android.internal.annotations.GuardedBy;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +090075
76import libcore.net.event.NetworkEventDispatcher;
77
78import java.io.IOException;
79import java.io.UncheckedIOException;
80import java.lang.annotation.Retention;
81import java.lang.annotation.RetentionPolicy;
82import java.net.DatagramSocket;
83import java.net.InetAddress;
84import java.net.InetSocketAddress;
85import java.net.Socket;
86import java.util.ArrayList;
87import java.util.Collection;
88import java.util.HashMap;
89import java.util.List;
90import java.util.Map;
91import java.util.Objects;
92import java.util.concurrent.Executor;
93import java.util.concurrent.ExecutorService;
94import java.util.concurrent.Executors;
95import 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)
114public 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 Jean025f40b2021-10-04 18:33:36 +0900147 * <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 VANfbbccbc2021-01-15 18:08:24 +0900152 *
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 *
lucaslin8bee2fd2021-04-21 10:43:15 +0800427 * 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 VANfbbccbc2021-01-15 18:08:24 +0900430 * @hide
431 */
lucaslincf6d4502021-03-04 17:09:51 +0800432 @SystemApi(client = MODULE_LIBRARIES)
433 public static final String ACTION_PROMPT_UNVALIDATED = "android.net.action.PROMPT_UNVALIDATED";
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +0900434
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 *
lucaslin8bee2fd2021-04-21 10:43:15 +0800439 * 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 VANfbbccbc2021-01-15 18:08:24 +0900443 * @hide
444 */
lucaslincf6d4502021-03-04 17:09:51 +0800445 @SystemApi(client = MODULE_LIBRARIES)
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +0900446 public static final String ACTION_PROMPT_LOST_VALIDATION =
lucaslincf6d4502021-03-04 17:09:51 +0800447 "android.net.action.PROMPT_LOST_VALIDATION";
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +0900448
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 *
lucaslin8bee2fd2021-04-21 10:43:15 +0800454 * 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 VANfbbccbc2021-01-15 18:08:24 +0900458 * @hide
459 */
lucaslincf6d4502021-03-04 17:09:51 +0800460 @SystemApi(client = MODULE_LIBRARIES)
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +0900461 public static final String ACTION_PROMPT_PARTIAL_CONNECTIVITY =
lucaslincf6d4502021-03-04 17:09:51 +0800462 "android.net.action.PROMPT_PARTIAL_CONNECTIVITY";
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +0900463
464 /**
paulhub49c8422021-04-07 16:18:13 +0800465 * 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 VANfbbccbc2021-01-15 18:08:24 +0900474 * 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 VAN71ced8e2021-02-15 18:52:06 +0900486 public static final int TETHERING_WIFI = 0;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +0900487
488 /**
489 * USB tethering type.
490 * @see #startTethering(int, boolean, OnStartTetheringCallback)
491 * @hide
492 */
493 @SystemApi
Remi NGUYEN VAN71ced8e2021-02-15 18:52:06 +0900494 public static final int TETHERING_USB = 1;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +0900495
496 /**
497 * Bluetooth tethering type.
498 * @see #startTethering(int, boolean, OnStartTetheringCallback)
499 * @hide
500 */
501 @SystemApi
Remi NGUYEN VAN71ced8e2021-02-15 18:52:06 +0900502 public static final int TETHERING_BLUETOOTH = 2;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +0900503
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 Shanka1d0d9b42021-03-23 08:12:28 +0000824 * 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 Colitti8ad58122021-03-18 00:54:57 +0900869 * 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 Horvath2dac9482021-11-15 15:49:37 +0100880 * 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 Shanka1d0d9b42021-03-23 08:12:28 +0000889 * 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 Colittia1bd6f62021-03-25 23:17:36 +0900925 BLOCKED_REASON_LOCKDOWN_VPN,
Robert Horvath2dac9482021-11-15 15:49:37 +0100926 BLOCKED_REASON_LOW_POWER_STANDBY,
Sudheer Shanka1d0d9b42021-03-23 08:12:28 +0000927 BLOCKED_METERED_REASON_DATA_SAVER,
928 BLOCKED_METERED_REASON_USER_RESTRICTED,
929 BLOCKED_METERED_REASON_ADMIN_DISABLED,
930 })
931 public @interface BlockedReason {}
932
Lorenzo Colitti8ad58122021-03-18 00:54:57 +0900933 /**
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 VANfbbccbc2021-01-15 18:08:24 +0900941 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 130143562)
942 private final IConnectivityManager mService;
Lorenzo Colitti842075e2021-02-04 17:32:07 +0900943
Robert Horvathd945bf02022-01-27 19:55:16 +0100944 // LINT.IfChange(firewall_chain)
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +0900945 /**
markchiene1561fa2021-12-09 22:00:56 +0800946 * 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 Horvath34cba142022-01-27 19:52:43 +0100977 /**
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
markchiene1561fa2021-12-09 22:00:56 +0800985 /** @hide */
986 @Retention(RetentionPolicy.SOURCE)
987 @IntDef(flag = false, prefix = "FIREWALL_CHAIN_", value = {
988 FIREWALL_CHAIN_DOZABLE,
989 FIREWALL_CHAIN_STANDBY,
990 FIREWALL_CHAIN_POWERSAVE,
Robert Horvath34cba142022-01-27 19:52:43 +0100991 FIREWALL_CHAIN_RESTRICTED,
992 FIREWALL_CHAIN_LOW_POWER_STANDBY
markchiene1561fa2021-12-09 22:00:56 +0800993 })
994 public @interface FirewallChain {}
Robert Horvathd945bf02022-01-27 19:55:16 +0100995 // LINT.ThenChange(packages/modules/Connectivity/service/native/include/Common.h)
markchiene1561fa2021-12-09 22:00:56 +0800996
997 /**
markchien011a7f52022-03-29 01:07:22 +0800998 * A firewall rule which allows or drops packets depending on existing policy.
999 * Used by {@link #setUidFirewallRule(int, int, int)} to follow existing policy to handle
1000 * specific uid's packets in specific firewall chain.
markchien3c04e662022-03-22 16:29:56 +08001001 * @hide
1002 */
1003 @SystemApi(client = MODULE_LIBRARIES)
1004 public static final int FIREWALL_RULE_DEFAULT = 0;
1005
1006 /**
markchien011a7f52022-03-29 01:07:22 +08001007 * A firewall rule which allows packets. Used by {@link #setUidFirewallRule(int, int, int)} to
1008 * allow specific uid's packets in specific firewall chain.
markchien3c04e662022-03-22 16:29:56 +08001009 * @hide
1010 */
1011 @SystemApi(client = MODULE_LIBRARIES)
1012 public static final int FIREWALL_RULE_ALLOW = 1;
1013
1014 /**
markchien011a7f52022-03-29 01:07:22 +08001015 * A firewall rule which drops packets. Used by {@link #setUidFirewallRule(int, int, int)} to
1016 * drop specific uid's packets in specific firewall chain.
markchien3c04e662022-03-22 16:29:56 +08001017 * @hide
1018 */
1019 @SystemApi(client = MODULE_LIBRARIES)
1020 public static final int FIREWALL_RULE_DENY = 2;
1021
1022 /** @hide */
1023 @Retention(RetentionPolicy.SOURCE)
1024 @IntDef(flag = false, prefix = "FIREWALL_RULE_", value = {
1025 FIREWALL_RULE_DEFAULT,
1026 FIREWALL_RULE_ALLOW,
1027 FIREWALL_RULE_DENY
1028 })
1029 public @interface FirewallRule {}
1030
1031 /**
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001032 * A kludge to facilitate static access where a Context pointer isn't available, like in the
1033 * case of the static set/getProcessDefaultNetwork methods and from the Network class.
1034 * TODO: Remove this after deprecating the static methods in favor of non-static methods or
1035 * methods that take a Context argument.
1036 */
1037 private static ConnectivityManager sInstance;
1038
1039 private final Context mContext;
1040
Remi NGUYEN VANe4d1cd92021-06-17 16:27:31 +09001041 @GuardedBy("mTetheringEventCallbacks")
1042 private TetheringManager mTetheringManager;
1043
1044 private TetheringManager getTetheringManager() {
1045 synchronized (mTetheringEventCallbacks) {
1046 if (mTetheringManager == null) {
1047 mTetheringManager = mContext.getSystemService(TetheringManager.class);
1048 }
1049 return mTetheringManager;
1050 }
1051 }
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001052
1053 /**
1054 * Tests if a given integer represents a valid network type.
1055 * @param networkType the type to be tested
1056 * @return a boolean. {@code true} if the type is valid, else {@code false}
1057 * @deprecated All APIs accepting a network type are deprecated. There should be no need to
1058 * validate a network type.
1059 */
1060 @Deprecated
1061 public static boolean isNetworkTypeValid(int networkType) {
1062 return MIN_NETWORK_TYPE <= networkType && networkType <= MAX_NETWORK_TYPE;
1063 }
1064
1065 /**
1066 * Returns a non-localized string representing a given network type.
1067 * ONLY used for debugging output.
1068 * @param type the type needing naming
1069 * @return a String for the given type, or a string version of the type ("87")
1070 * if no name is known.
1071 * @deprecated Types are deprecated. Use {@link NetworkCapabilities} instead.
1072 * {@hide}
1073 */
1074 @Deprecated
1075 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
1076 public static String getNetworkTypeName(int type) {
1077 switch (type) {
1078 case TYPE_NONE:
1079 return "NONE";
1080 case TYPE_MOBILE:
1081 return "MOBILE";
1082 case TYPE_WIFI:
1083 return "WIFI";
1084 case TYPE_MOBILE_MMS:
1085 return "MOBILE_MMS";
1086 case TYPE_MOBILE_SUPL:
1087 return "MOBILE_SUPL";
1088 case TYPE_MOBILE_DUN:
1089 return "MOBILE_DUN";
1090 case TYPE_MOBILE_HIPRI:
1091 return "MOBILE_HIPRI";
1092 case TYPE_WIMAX:
1093 return "WIMAX";
1094 case TYPE_BLUETOOTH:
1095 return "BLUETOOTH";
1096 case TYPE_DUMMY:
1097 return "DUMMY";
1098 case TYPE_ETHERNET:
1099 return "ETHERNET";
1100 case TYPE_MOBILE_FOTA:
1101 return "MOBILE_FOTA";
1102 case TYPE_MOBILE_IMS:
1103 return "MOBILE_IMS";
1104 case TYPE_MOBILE_CBS:
1105 return "MOBILE_CBS";
1106 case TYPE_WIFI_P2P:
1107 return "WIFI_P2P";
1108 case TYPE_MOBILE_IA:
1109 return "MOBILE_IA";
1110 case TYPE_MOBILE_EMERGENCY:
1111 return "MOBILE_EMERGENCY";
1112 case TYPE_PROXY:
1113 return "PROXY";
1114 case TYPE_VPN:
1115 return "VPN";
1116 default:
1117 return Integer.toString(type);
1118 }
1119 }
1120
1121 /**
1122 * @hide
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001123 */
lucaslin10774b72021-03-17 14:16:01 +08001124 @SystemApi(client = MODULE_LIBRARIES)
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001125 public void systemReady() {
1126 try {
1127 mService.systemReady();
1128 } catch (RemoteException e) {
1129 throw e.rethrowFromSystemServer();
1130 }
1131 }
1132
1133 /**
1134 * Checks if a given type uses the cellular data connection.
1135 * This should be replaced in the future by a network property.
1136 * @param networkType the type to check
1137 * @return a boolean - {@code true} if uses cellular network, else {@code false}
1138 * @deprecated Types are deprecated. Use {@link NetworkCapabilities} instead.
1139 * {@hide}
1140 */
1141 @Deprecated
1142 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 130143562)
1143 public static boolean isNetworkTypeMobile(int networkType) {
1144 switch (networkType) {
1145 case TYPE_MOBILE:
1146 case TYPE_MOBILE_MMS:
1147 case TYPE_MOBILE_SUPL:
1148 case TYPE_MOBILE_DUN:
1149 case TYPE_MOBILE_HIPRI:
1150 case TYPE_MOBILE_FOTA:
1151 case TYPE_MOBILE_IMS:
1152 case TYPE_MOBILE_CBS:
1153 case TYPE_MOBILE_IA:
1154 case TYPE_MOBILE_EMERGENCY:
1155 return true;
1156 default:
1157 return false;
1158 }
1159 }
1160
1161 /**
1162 * Checks if the given network type is backed by a Wi-Fi radio.
1163 *
1164 * @deprecated Types are deprecated. Use {@link NetworkCapabilities} instead.
1165 * @hide
1166 */
1167 @Deprecated
1168 public static boolean isNetworkTypeWifi(int networkType) {
1169 switch (networkType) {
1170 case TYPE_WIFI:
1171 case TYPE_WIFI_P2P:
1172 return true;
1173 default:
1174 return false;
1175 }
1176 }
1177
1178 /**
Sooraj Sasindran06baf4c2021-11-29 12:21:09 -08001179 * Preference for {@link ProfileNetworkPreference#setPreference(int)}.
1180 * {@see #setProfileNetworkPreferences(UserHandle, List, Executor, Runnable)}
Chalard Jeanad565e22021-02-25 17:23:40 +09001181 * Specify that the traffic for this user should by follow the default rules.
1182 * @hide
1183 */
Chalard Jeanbef6b092021-03-17 14:33:24 +09001184 @SystemApi(client = MODULE_LIBRARIES)
Chalard Jeanad565e22021-02-25 17:23:40 +09001185 public static final int PROFILE_NETWORK_PREFERENCE_DEFAULT = 0;
1186
1187 /**
Sooraj Sasindran06baf4c2021-11-29 12:21:09 -08001188 * Preference for {@link ProfileNetworkPreference#setPreference(int)}.
1189 * {@see #setProfileNetworkPreferences(UserHandle, List, Executor, Runnable)}
Chalard Jeanad565e22021-02-25 17:23:40 +09001190 * Specify that the traffic for this user should by default go on a network with
1191 * {@link NetworkCapabilities#NET_CAPABILITY_ENTERPRISE}, and on the system default network
1192 * if no such network is available.
1193 * @hide
1194 */
Chalard Jeanbef6b092021-03-17 14:33:24 +09001195 @SystemApi(client = MODULE_LIBRARIES)
Chalard Jeanad565e22021-02-25 17:23:40 +09001196 public static final int PROFILE_NETWORK_PREFERENCE_ENTERPRISE = 1;
1197
Sooraj Sasindran06baf4c2021-11-29 12:21:09 -08001198 /**
1199 * Preference for {@link ProfileNetworkPreference#setPreference(int)}.
1200 * {@see #setProfileNetworkPreferences(UserHandle, List, Executor, Runnable)}
1201 * Specify that the traffic for this user should by default go on a network with
1202 * {@link NetworkCapabilities#NET_CAPABILITY_ENTERPRISE} and if no such network is available
1203 * should not go on the system default network
1204 * @hide
1205 */
1206 @SystemApi(client = MODULE_LIBRARIES)
1207 public static final int PROFILE_NETWORK_PREFERENCE_ENTERPRISE_NO_FALLBACK = 2;
1208
Chalard Jeanad565e22021-02-25 17:23:40 +09001209 /** @hide */
1210 @Retention(RetentionPolicy.SOURCE)
1211 @IntDef(value = {
1212 PROFILE_NETWORK_PREFERENCE_DEFAULT,
Sooraj Sasindran06baf4c2021-11-29 12:21:09 -08001213 PROFILE_NETWORK_PREFERENCE_ENTERPRISE,
1214 PROFILE_NETWORK_PREFERENCE_ENTERPRISE_NO_FALLBACK
Chalard Jeanad565e22021-02-25 17:23:40 +09001215 })
Sooraj Sasindrane7aee272021-11-24 20:26:55 -08001216 public @interface ProfileNetworkPreferencePolicy {
Chalard Jeanad565e22021-02-25 17:23:40 +09001217 }
1218
1219 /**
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001220 * Specifies the preferred network type. When the device has more
1221 * than one type available the preferred network type will be used.
1222 *
1223 * @param preference the network type to prefer over all others. It is
1224 * unspecified what happens to the old preferred network in the
1225 * overall ordering.
1226 * @deprecated Functionality has been removed as it no longer makes sense,
1227 * with many more than two networks - we'd need an array to express
1228 * preference. Instead we use dynamic network properties of
1229 * the networks to describe their precedence.
1230 */
1231 @Deprecated
1232 public void setNetworkPreference(int preference) {
1233 }
1234
1235 /**
1236 * Retrieves the current preferred network type.
1237 *
1238 * @return an integer representing the preferred network type
1239 *
1240 * @deprecated Functionality has been removed as it no longer makes sense,
1241 * with many more than two networks - we'd need an array to express
1242 * preference. Instead we use dynamic network properties of
1243 * the networks to describe their precedence.
1244 */
1245 @Deprecated
1246 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1247 public int getNetworkPreference() {
1248 return TYPE_NONE;
1249 }
1250
1251 /**
1252 * Returns details about the currently active default data network. When
1253 * connected, this network is the default route for outgoing connections.
1254 * You should always check {@link NetworkInfo#isConnected()} before initiating
1255 * network traffic. This may return {@code null} when there is no default
1256 * network.
1257 * Note that if the default network is a VPN, this method will return the
1258 * NetworkInfo for one of its underlying networks instead, or null if the
1259 * VPN agent did not specify any. Apps interested in learning about VPNs
1260 * should use {@link #getNetworkInfo(android.net.Network)} instead.
1261 *
1262 * @return a {@link NetworkInfo} object for the current default network
1263 * or {@code null} if no default network is currently active
1264 * @deprecated See {@link NetworkInfo}.
1265 */
1266 @Deprecated
1267 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1268 @Nullable
1269 public NetworkInfo getActiveNetworkInfo() {
1270 try {
1271 return mService.getActiveNetworkInfo();
1272 } catch (RemoteException e) {
1273 throw e.rethrowFromSystemServer();
1274 }
1275 }
1276
1277 /**
1278 * Returns a {@link Network} object corresponding to the currently active
1279 * default data network. In the event that the current active default data
1280 * network disconnects, the returned {@code Network} object will no longer
1281 * be usable. This will return {@code null} when there is no default
Chalard Jean0d051512021-09-28 15:31:15 +09001282 * network, or when the default network is blocked.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001283 *
1284 * @return a {@link Network} object for the current default network or
Chalard Jean0d051512021-09-28 15:31:15 +09001285 * {@code null} if no default network is currently active or if
1286 * the default network is blocked for the caller
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001287 */
1288 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1289 @Nullable
1290 public Network getActiveNetwork() {
1291 try {
1292 return mService.getActiveNetwork();
1293 } catch (RemoteException e) {
1294 throw e.rethrowFromSystemServer();
1295 }
1296 }
1297
1298 /**
1299 * Returns a {@link Network} object corresponding to the currently active
1300 * default data network for a specific UID. In the event that the default data
1301 * network disconnects, the returned {@code Network} object will no longer
1302 * be usable. This will return {@code null} when there is no default
1303 * network for the UID.
1304 *
1305 * @return a {@link Network} object for the current default network for the
1306 * given UID or {@code null} if no default network is currently active
lifrdb7d6762021-03-30 21:04:53 +08001307 *
1308 * @hide
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001309 */
1310 @RequiresPermission(android.Manifest.permission.NETWORK_STACK)
1311 @Nullable
1312 public Network getActiveNetworkForUid(int uid) {
1313 return getActiveNetworkForUid(uid, false);
1314 }
1315
1316 /** {@hide} */
1317 public Network getActiveNetworkForUid(int uid, boolean ignoreBlocked) {
1318 try {
1319 return mService.getActiveNetworkForUid(uid, ignoreBlocked);
1320 } catch (RemoteException e) {
1321 throw e.rethrowFromSystemServer();
1322 }
1323 }
1324
1325 /**
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001326 * Adds or removes a requirement for given UID ranges to use the VPN.
1327 *
1328 * If set to {@code true}, informs the system that the UIDs in the specified ranges must not
1329 * have any connectivity except if a VPN is connected and applies to the UIDs, or if the UIDs
1330 * otherwise have permission to bypass the VPN (e.g., because they have the
1331 * {@link android.Manifest.permission.CONNECTIVITY_USE_RESTRICTED_NETWORKS} permission, or when
1332 * using a socket protected by a method such as {@link VpnService#protect(DatagramSocket)}. If
1333 * set to {@code false}, a previously-added restriction is removed.
1334 * <p>
1335 * Each of the UID ranges specified by this method is added and removed as is, and no processing
1336 * is performed on the ranges to de-duplicate, merge, split, or intersect them. In order to
1337 * remove a previously-added range, the exact range must be removed as is.
1338 * <p>
1339 * The changes are applied asynchronously and may not have been applied by the time the method
1340 * returns. Apps will be notified about any changes that apply to them via
1341 * {@link NetworkCallback#onBlockedStatusChanged} callbacks called after the changes take
1342 * effect.
1343 * <p>
1344 * This method should be called only by the VPN code.
1345 *
1346 * @param ranges the UID ranges to restrict
1347 * @param requireVpn whether the specified UID ranges must use a VPN
1348 *
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001349 * @hide
1350 */
1351 @RequiresPermission(anyOf = {
1352 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
lucaslin97fb10a2021-03-22 11:51:27 +08001353 android.Manifest.permission.NETWORK_STACK,
1354 android.Manifest.permission.NETWORK_SETTINGS})
1355 @SystemApi(client = MODULE_LIBRARIES)
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001356 public void setRequireVpnForUids(boolean requireVpn,
1357 @NonNull Collection<Range<Integer>> ranges) {
1358 Objects.requireNonNull(ranges);
1359 // The Range class is not parcelable. Convert to UidRange, which is what is used internally.
1360 // This method is not necessarily expected to be used outside the system server, so
1361 // parceling may not be necessary, but it could be used out-of-process, e.g., by the network
1362 // stack process, or by tests.
1363 UidRange[] rangesArray = new UidRange[ranges.size()];
1364 int index = 0;
1365 for (Range<Integer> range : ranges) {
1366 rangesArray[index++] = new UidRange(range.getLower(), range.getUpper());
1367 }
1368 try {
1369 mService.setRequireVpnForUids(requireVpn, rangesArray);
1370 } catch (RemoteException e) {
1371 throw e.rethrowFromSystemServer();
1372 }
1373 }
1374
1375 /**
Lorenzo Colittic71cff82021-01-15 01:29:01 +09001376 * Informs ConnectivityService of whether the legacy lockdown VPN, as implemented by
1377 * LockdownVpnTracker, is in use. This is deprecated for new devices starting from Android 12
1378 * but is still supported for backwards compatibility.
1379 * <p>
1380 * This type of VPN is assumed always to use the system default network, and must always declare
1381 * exactly one underlying network, which is the network that was the default when the VPN
1382 * connected.
1383 * <p>
1384 * Calling this method with {@code true} enables legacy behaviour, specifically:
1385 * <ul>
1386 * <li>Any VPN that applies to userId 0 behaves specially with respect to deprecated
1387 * {@link #CONNECTIVITY_ACTION} broadcasts. Any such broadcasts will have the state in the
1388 * {@link #EXTRA_NETWORK_INFO} replaced by state of the VPN network. Also, any time the VPN
1389 * connects, a {@link #CONNECTIVITY_ACTION} broadcast will be sent for the network
1390 * underlying the VPN.</li>
1391 * <li>Deprecated APIs that return {@link NetworkInfo} objects will have their state
1392 * similarly replaced by the VPN network state.</li>
1393 * <li>Information on current network interfaces passed to NetworkStatsService will not
1394 * include any VPN interfaces.</li>
1395 * </ul>
1396 *
1397 * @param enabled whether legacy lockdown VPN is enabled or disabled
1398 *
Lorenzo Colittic71cff82021-01-15 01:29:01 +09001399 * @hide
1400 */
1401 @RequiresPermission(anyOf = {
1402 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
lucaslin97fb10a2021-03-22 11:51:27 +08001403 android.Manifest.permission.NETWORK_STACK,
Lorenzo Colittic71cff82021-01-15 01:29:01 +09001404 android.Manifest.permission.NETWORK_SETTINGS})
lucaslin97fb10a2021-03-22 11:51:27 +08001405 @SystemApi(client = MODULE_LIBRARIES)
Lorenzo Colittic71cff82021-01-15 01:29:01 +09001406 public void setLegacyLockdownVpnEnabled(boolean enabled) {
1407 try {
1408 mService.setLegacyLockdownVpnEnabled(enabled);
1409 } catch (RemoteException e) {
1410 throw e.rethrowFromSystemServer();
1411 }
1412 }
1413
1414 /**
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001415 * Returns details about the currently active default data network
1416 * for a given uid. This is for internal use only to avoid spying
1417 * other apps.
1418 *
1419 * @return a {@link NetworkInfo} object for the current default network
1420 * for the given uid or {@code null} if no default network is
1421 * available for the specified uid.
1422 *
1423 * {@hide}
1424 */
1425 @RequiresPermission(android.Manifest.permission.NETWORK_STACK)
1426 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
1427 public NetworkInfo getActiveNetworkInfoForUid(int uid) {
1428 return getActiveNetworkInfoForUid(uid, false);
1429 }
1430
1431 /** {@hide} */
1432 public NetworkInfo getActiveNetworkInfoForUid(int uid, boolean ignoreBlocked) {
1433 try {
1434 return mService.getActiveNetworkInfoForUid(uid, ignoreBlocked);
1435 } catch (RemoteException e) {
1436 throw e.rethrowFromSystemServer();
1437 }
1438 }
1439
1440 /**
1441 * Returns connection status information about a particular
1442 * network type.
1443 *
1444 * @param networkType integer specifying which networkType in
1445 * which you're interested.
1446 * @return a {@link NetworkInfo} object for the requested
1447 * network type or {@code null} if the type is not
1448 * supported by the device. If {@code networkType} is
1449 * TYPE_VPN and a VPN is active for the calling app,
1450 * then this method will try to return one of the
1451 * underlying networks for the VPN or null if the
1452 * VPN agent didn't specify any.
1453 *
1454 * @deprecated This method does not support multiple connected networks
1455 * of the same type. Use {@link #getAllNetworks} and
1456 * {@link #getNetworkInfo(android.net.Network)} instead.
1457 */
1458 @Deprecated
1459 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1460 @Nullable
1461 public NetworkInfo getNetworkInfo(int networkType) {
1462 try {
1463 return mService.getNetworkInfo(networkType);
1464 } catch (RemoteException e) {
1465 throw e.rethrowFromSystemServer();
1466 }
1467 }
1468
1469 /**
1470 * Returns connection status information about a particular
1471 * Network.
1472 *
1473 * @param network {@link Network} specifying which network
1474 * in which you're interested.
1475 * @return a {@link NetworkInfo} object for the requested
1476 * network or {@code null} if the {@code Network}
1477 * is not valid.
1478 * @deprecated See {@link NetworkInfo}.
1479 */
1480 @Deprecated
1481 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1482 @Nullable
1483 public NetworkInfo getNetworkInfo(@Nullable Network network) {
1484 return getNetworkInfoForUid(network, Process.myUid(), false);
1485 }
1486
1487 /** {@hide} */
1488 public NetworkInfo getNetworkInfoForUid(Network network, int uid, boolean ignoreBlocked) {
1489 try {
1490 return mService.getNetworkInfoForUid(network, uid, ignoreBlocked);
1491 } catch (RemoteException e) {
1492 throw e.rethrowFromSystemServer();
1493 }
1494 }
1495
1496 /**
1497 * Returns connection status information about all network
1498 * types supported by the device.
1499 *
1500 * @return an array of {@link NetworkInfo} objects. Check each
1501 * {@link NetworkInfo#getType} for which type each applies.
1502 *
1503 * @deprecated This method does not support multiple connected networks
1504 * of the same type. Use {@link #getAllNetworks} and
1505 * {@link #getNetworkInfo(android.net.Network)} instead.
1506 */
1507 @Deprecated
1508 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1509 @NonNull
1510 public NetworkInfo[] getAllNetworkInfo() {
1511 try {
1512 return mService.getAllNetworkInfo();
1513 } catch (RemoteException e) {
1514 throw e.rethrowFromSystemServer();
1515 }
1516 }
1517
1518 /**
junyulaib1211372021-03-03 12:09:05 +08001519 * Return a list of {@link NetworkStateSnapshot}s, one for each network that is currently
1520 * connected.
1521 * @hide
1522 */
1523 @SystemApi(client = MODULE_LIBRARIES)
1524 @RequiresPermission(anyOf = {
1525 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
1526 android.Manifest.permission.NETWORK_STACK,
1527 android.Manifest.permission.NETWORK_SETTINGS})
1528 @NonNull
Aaron Huangab615e52021-04-17 13:46:25 +08001529 public List<NetworkStateSnapshot> getAllNetworkStateSnapshots() {
junyulaib1211372021-03-03 12:09:05 +08001530 try {
Aaron Huangab615e52021-04-17 13:46:25 +08001531 return mService.getAllNetworkStateSnapshots();
junyulaib1211372021-03-03 12:09:05 +08001532 } catch (RemoteException e) {
1533 throw e.rethrowFromSystemServer();
1534 }
1535 }
1536
1537 /**
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001538 * Returns the {@link Network} object currently serving a given type, or
1539 * null if the given type is not connected.
1540 *
1541 * @hide
1542 * @deprecated This method does not support multiple connected networks
1543 * of the same type. Use {@link #getAllNetworks} and
1544 * {@link #getNetworkInfo(android.net.Network)} instead.
1545 */
1546 @Deprecated
1547 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1548 @UnsupportedAppUsage
1549 public Network getNetworkForType(int networkType) {
1550 try {
1551 return mService.getNetworkForType(networkType);
1552 } catch (RemoteException e) {
1553 throw e.rethrowFromSystemServer();
1554 }
1555 }
1556
1557 /**
1558 * Returns an array of all {@link Network} currently tracked by the
1559 * framework.
1560 *
Lorenzo Colitti86714b12021-05-17 20:31:21 +09001561 * @deprecated This method does not provide any notification of network state changes, forcing
1562 * apps to call it repeatedly. This is inefficient and prone to race conditions.
1563 * Apps should use methods such as
1564 * {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)} instead.
1565 * Apps that desire to obtain information about networks that do not apply to them
1566 * can use {@link NetworkRequest.Builder#setIncludeOtherUidNetworks}.
1567 *
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001568 * @return an array of {@link Network} objects.
1569 */
1570 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1571 @NonNull
Lorenzo Colitti86714b12021-05-17 20:31:21 +09001572 @Deprecated
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001573 public Network[] getAllNetworks() {
1574 try {
1575 return mService.getAllNetworks();
1576 } catch (RemoteException e) {
1577 throw e.rethrowFromSystemServer();
1578 }
1579 }
1580
1581 /**
Roshan Piuse08bc182020-12-22 15:10:42 -08001582 * Returns an array of {@link NetworkCapabilities} objects, representing
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001583 * the Networks that applications run by the given user will use by default.
1584 * @hide
1585 */
1586 @UnsupportedAppUsage
1587 public NetworkCapabilities[] getDefaultNetworkCapabilitiesForUser(int userId) {
1588 try {
1589 return mService.getDefaultNetworkCapabilitiesForUser(
Roshan Piusa8a477b2020-12-17 14:53:09 -08001590 userId, mContext.getOpPackageName(), getAttributionTag());
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001591 } catch (RemoteException e) {
1592 throw e.rethrowFromSystemServer();
1593 }
1594 }
1595
1596 /**
1597 * Returns the IP information for the current default network.
1598 *
1599 * @return a {@link LinkProperties} object describing the IP info
1600 * for the current default network, or {@code null} if there
1601 * is no current default network.
1602 *
1603 * {@hide}
1604 * @deprecated please use {@link #getLinkProperties(Network)} on the return
1605 * value of {@link #getActiveNetwork()} instead. In particular,
1606 * this method will return non-null LinkProperties even if the
1607 * app is blocked by policy from using this network.
1608 */
1609 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1610 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 109783091)
1611 public LinkProperties getActiveLinkProperties() {
1612 try {
1613 return mService.getActiveLinkProperties();
1614 } catch (RemoteException e) {
1615 throw e.rethrowFromSystemServer();
1616 }
1617 }
1618
1619 /**
1620 * Returns the IP information for a given network type.
1621 *
1622 * @param networkType the network type of interest.
1623 * @return a {@link LinkProperties} object describing the IP info
1624 * for the given networkType, or {@code null} if there is
1625 * no current default network.
1626 *
1627 * {@hide}
1628 * @deprecated This method does not support multiple connected networks
1629 * of the same type. Use {@link #getAllNetworks},
1630 * {@link #getNetworkInfo(android.net.Network)}, and
1631 * {@link #getLinkProperties(android.net.Network)} instead.
1632 */
1633 @Deprecated
1634 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1635 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 130143562)
1636 public LinkProperties getLinkProperties(int networkType) {
1637 try {
1638 return mService.getLinkPropertiesForType(networkType);
1639 } catch (RemoteException e) {
1640 throw e.rethrowFromSystemServer();
1641 }
1642 }
1643
1644 /**
1645 * Get the {@link LinkProperties} for the given {@link Network}. This
1646 * will return {@code null} if the network is unknown.
1647 *
1648 * @param network The {@link Network} object identifying the network in question.
1649 * @return The {@link LinkProperties} for the network, or {@code null}.
1650 */
1651 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1652 @Nullable
1653 public LinkProperties getLinkProperties(@Nullable Network network) {
1654 try {
1655 return mService.getLinkProperties(network);
1656 } catch (RemoteException e) {
1657 throw e.rethrowFromSystemServer();
1658 }
1659 }
1660
1661 /**
lucaslinc582d502022-01-27 09:07:00 +08001662 * Redact {@link LinkProperties} for a given package
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001663 *
lucaslinc582d502022-01-27 09:07:00 +08001664 * Returns an instance of the given {@link LinkProperties} appropriately redacted to send to the
1665 * given package, considering its permissions.
1666 *
1667 * @param lp A {@link LinkProperties} which will be redacted.
1668 * @param uid The target uid.
1669 * @param packageName The name of the package, for appops logging.
1670 * @return A redacted {@link LinkProperties} which is appropriate to send to the given uid,
1671 * or null if the uid lacks the ACCESS_NETWORK_STATE permission.
1672 * @hide
1673 */
1674 @RequiresPermission(anyOf = {
1675 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
1676 android.Manifest.permission.NETWORK_STACK,
1677 android.Manifest.permission.NETWORK_SETTINGS})
1678 @SystemApi(client = MODULE_LIBRARIES)
1679 @Nullable
lucaslind2b06132022-03-02 10:56:57 +08001680 public LinkProperties getRedactedLinkPropertiesForPackage(@NonNull LinkProperties lp, int uid,
lucaslinc582d502022-01-27 09:07:00 +08001681 @NonNull String packageName) {
1682 try {
lucaslind2b06132022-03-02 10:56:57 +08001683 return mService.getRedactedLinkPropertiesForPackage(
lucaslinc582d502022-01-27 09:07:00 +08001684 lp, uid, packageName, getAttributionTag());
1685 } catch (RemoteException e) {
1686 throw e.rethrowFromSystemServer();
1687 }
1688 }
1689
1690 /**
1691 * Get the {@link NetworkCapabilities} for the given {@link Network}, or null.
1692 *
1693 * This will remove any location sensitive data in the returned {@link NetworkCapabilities}.
1694 * Some {@link TransportInfo} instances like {@link android.net.wifi.WifiInfo} contain location
1695 * sensitive information. To retrieve this location sensitive information (subject to
1696 * the caller's location permissions), use a {@link NetworkCallback} with the
1697 * {@link NetworkCallback#FLAG_INCLUDE_LOCATION_INFO} flag instead.
1698 *
1699 * This method returns {@code null} if the network is unknown or if the |network| argument
1700 * is null.
Roshan Piuse08bc182020-12-22 15:10:42 -08001701 *
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001702 * @param network The {@link Network} object identifying the network in question.
Roshan Piuse08bc182020-12-22 15:10:42 -08001703 * @return The {@link NetworkCapabilities} for the network, or {@code null}.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001704 */
1705 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1706 @Nullable
1707 public NetworkCapabilities getNetworkCapabilities(@Nullable Network network) {
1708 try {
Roshan Piusa8a477b2020-12-17 14:53:09 -08001709 return mService.getNetworkCapabilities(
1710 network, mContext.getOpPackageName(), getAttributionTag());
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001711 } catch (RemoteException e) {
1712 throw e.rethrowFromSystemServer();
1713 }
1714 }
1715
1716 /**
lucaslinc582d502022-01-27 09:07:00 +08001717 * Redact {@link NetworkCapabilities} for a given package.
1718 *
1719 * Returns an instance of {@link NetworkCapabilities} that is appropriately redacted to send
lucaslind2b06132022-03-02 10:56:57 +08001720 * to the given package, considering its permissions. If the passed capabilities contain
1721 * location-sensitive information, they will be redacted to the correct degree for the location
1722 * permissions of the app (COARSE or FINE), and will blame the UID accordingly for retrieving
1723 * that level of location. If the UID holds no location permission, the returned object will
1724 * contain no location-sensitive information and the UID is not blamed.
lucaslinc582d502022-01-27 09:07:00 +08001725 *
1726 * @param nc A {@link NetworkCapabilities} instance which will be redacted.
1727 * @param uid The target uid.
1728 * @param packageName The name of the package, for appops logging.
1729 * @return A redacted {@link NetworkCapabilities} which is appropriate to send to the given uid,
1730 * or null if the uid lacks the ACCESS_NETWORK_STATE permission.
1731 * @hide
1732 */
1733 @RequiresPermission(anyOf = {
1734 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
1735 android.Manifest.permission.NETWORK_STACK,
1736 android.Manifest.permission.NETWORK_SETTINGS})
1737 @SystemApi(client = MODULE_LIBRARIES)
1738 @Nullable
lucaslind2b06132022-03-02 10:56:57 +08001739 public NetworkCapabilities getRedactedNetworkCapabilitiesForPackage(
lucaslinc582d502022-01-27 09:07:00 +08001740 @NonNull NetworkCapabilities nc,
1741 int uid, @NonNull String packageName) {
1742 try {
lucaslind2b06132022-03-02 10:56:57 +08001743 return mService.getRedactedNetworkCapabilitiesForPackage(nc, uid, packageName,
lucaslinc582d502022-01-27 09:07:00 +08001744 getAttributionTag());
1745 } catch (RemoteException e) {
1746 throw e.rethrowFromSystemServer();
1747 }
1748 }
1749
1750 /**
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001751 * Gets a URL that can be used for resolving whether a captive portal is present.
1752 * 1. This URL should respond with a 204 response to a GET request to indicate no captive
1753 * portal is present.
1754 * 2. This URL must be HTTP as redirect responses are used to find captive portal
1755 * sign-in pages. Captive portals cannot respond to HTTPS requests with redirects.
1756 *
1757 * The system network validation may be using different strategies to detect captive portals,
1758 * so this method does not necessarily return a URL used by the system. It only returns a URL
1759 * that may be relevant for other components trying to detect captive portals.
1760 *
1761 * @hide
1762 * @deprecated This API returns URL which is not guaranteed to be one of the URLs used by the
1763 * system.
1764 */
1765 @Deprecated
1766 @SystemApi
1767 @RequiresPermission(android.Manifest.permission.NETWORK_SETTINGS)
1768 public String getCaptivePortalServerUrl() {
1769 try {
1770 return mService.getCaptivePortalServerUrl();
1771 } catch (RemoteException e) {
1772 throw e.rethrowFromSystemServer();
1773 }
1774 }
1775
1776 /**
1777 * Tells the underlying networking system that the caller wants to
1778 * begin using the named feature. The interpretation of {@code feature}
1779 * is completely up to each networking implementation.
1780 *
1781 * <p>This method requires the caller to hold either the
1782 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
1783 * or the ability to modify system settings as determined by
1784 * {@link android.provider.Settings.System#canWrite}.</p>
1785 *
1786 * @param networkType specifies which network the request pertains to
1787 * @param feature the name of the feature to be used
1788 * @return an integer value representing the outcome of the request.
1789 * The interpretation of this value is specific to each networking
1790 * implementation+feature combination, except that the value {@code -1}
1791 * always indicates failure.
1792 *
1793 * @deprecated Deprecated in favor of the cleaner
1794 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} API.
1795 * In {@link VERSION_CODES#M}, and above, this method is unsupported and will
1796 * throw {@code UnsupportedOperationException} if called.
1797 * @removed
1798 */
1799 @Deprecated
1800 public int startUsingNetworkFeature(int networkType, String feature) {
1801 checkLegacyRoutingApiAccess();
1802 NetworkCapabilities netCap = networkCapabilitiesForFeature(networkType, feature);
1803 if (netCap == null) {
1804 Log.d(TAG, "Can't satisfy startUsingNetworkFeature for " + networkType + ", " +
1805 feature);
1806 return DEPRECATED_PHONE_CONSTANT_APN_REQUEST_FAILED;
1807 }
1808
1809 NetworkRequest request = null;
1810 synchronized (sLegacyRequests) {
1811 LegacyRequest l = sLegacyRequests.get(netCap);
1812 if (l != null) {
1813 Log.d(TAG, "renewing startUsingNetworkFeature request " + l.networkRequest);
1814 renewRequestLocked(l);
1815 if (l.currentNetwork != null) {
1816 return DEPRECATED_PHONE_CONSTANT_APN_ALREADY_ACTIVE;
1817 } else {
1818 return DEPRECATED_PHONE_CONSTANT_APN_REQUEST_STARTED;
1819 }
1820 }
1821
1822 request = requestNetworkForFeatureLocked(netCap);
1823 }
1824 if (request != null) {
1825 Log.d(TAG, "starting startUsingNetworkFeature for request " + request);
1826 return DEPRECATED_PHONE_CONSTANT_APN_REQUEST_STARTED;
1827 } else {
1828 Log.d(TAG, " request Failed");
1829 return DEPRECATED_PHONE_CONSTANT_APN_REQUEST_FAILED;
1830 }
1831 }
1832
1833 /**
1834 * Tells the underlying networking system that the caller is finished
1835 * using the named feature. The interpretation of {@code feature}
1836 * is completely up to each networking implementation.
1837 *
1838 * <p>This method requires the caller to hold either the
1839 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
1840 * or the ability to modify system settings as determined by
1841 * {@link android.provider.Settings.System#canWrite}.</p>
1842 *
1843 * @param networkType specifies which network the request pertains to
1844 * @param feature the name of the feature that is no longer needed
1845 * @return an integer value representing the outcome of the request.
1846 * The interpretation of this value is specific to each networking
1847 * implementation+feature combination, except that the value {@code -1}
1848 * always indicates failure.
1849 *
1850 * @deprecated Deprecated in favor of the cleaner
1851 * {@link #unregisterNetworkCallback(NetworkCallback)} API.
1852 * In {@link VERSION_CODES#M}, and above, this method is unsupported and will
1853 * throw {@code UnsupportedOperationException} if called.
1854 * @removed
1855 */
1856 @Deprecated
1857 public int stopUsingNetworkFeature(int networkType, String feature) {
1858 checkLegacyRoutingApiAccess();
1859 NetworkCapabilities netCap = networkCapabilitiesForFeature(networkType, feature);
1860 if (netCap == null) {
1861 Log.d(TAG, "Can't satisfy stopUsingNetworkFeature for " + networkType + ", " +
1862 feature);
1863 return -1;
1864 }
1865
1866 if (removeRequestForFeature(netCap)) {
1867 Log.d(TAG, "stopUsingNetworkFeature for " + networkType + ", " + feature);
1868 }
1869 return 1;
1870 }
1871
1872 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
1873 private NetworkCapabilities networkCapabilitiesForFeature(int networkType, String feature) {
1874 if (networkType == TYPE_MOBILE) {
1875 switch (feature) {
1876 case "enableCBS":
1877 return networkCapabilitiesForType(TYPE_MOBILE_CBS);
1878 case "enableDUN":
1879 case "enableDUNAlways":
1880 return networkCapabilitiesForType(TYPE_MOBILE_DUN);
1881 case "enableFOTA":
1882 return networkCapabilitiesForType(TYPE_MOBILE_FOTA);
1883 case "enableHIPRI":
1884 return networkCapabilitiesForType(TYPE_MOBILE_HIPRI);
1885 case "enableIMS":
1886 return networkCapabilitiesForType(TYPE_MOBILE_IMS);
1887 case "enableMMS":
1888 return networkCapabilitiesForType(TYPE_MOBILE_MMS);
1889 case "enableSUPL":
1890 return networkCapabilitiesForType(TYPE_MOBILE_SUPL);
1891 default:
1892 return null;
1893 }
1894 } else if (networkType == TYPE_WIFI && "p2p".equals(feature)) {
1895 return networkCapabilitiesForType(TYPE_WIFI_P2P);
1896 }
1897 return null;
1898 }
1899
1900 private int legacyTypeForNetworkCapabilities(NetworkCapabilities netCap) {
1901 if (netCap == null) return TYPE_NONE;
1902 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_CBS)) {
1903 return TYPE_MOBILE_CBS;
1904 }
1905 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_IMS)) {
1906 return TYPE_MOBILE_IMS;
1907 }
1908 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_FOTA)) {
1909 return TYPE_MOBILE_FOTA;
1910 }
1911 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_DUN)) {
1912 return TYPE_MOBILE_DUN;
1913 }
1914 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_SUPL)) {
1915 return TYPE_MOBILE_SUPL;
1916 }
1917 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_MMS)) {
1918 return TYPE_MOBILE_MMS;
1919 }
1920 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_INTERNET)) {
1921 return TYPE_MOBILE_HIPRI;
1922 }
1923 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_WIFI_P2P)) {
1924 return TYPE_WIFI_P2P;
1925 }
1926 return TYPE_NONE;
1927 }
1928
1929 private static class LegacyRequest {
1930 NetworkCapabilities networkCapabilities;
1931 NetworkRequest networkRequest;
1932 int expireSequenceNumber;
1933 Network currentNetwork;
1934 int delay = -1;
1935
1936 private void clearDnsBinding() {
1937 if (currentNetwork != null) {
1938 currentNetwork = null;
1939 setProcessDefaultNetworkForHostResolution(null);
1940 }
1941 }
1942
1943 NetworkCallback networkCallback = new NetworkCallback() {
1944 @Override
1945 public void onAvailable(Network network) {
1946 currentNetwork = network;
1947 Log.d(TAG, "startUsingNetworkFeature got Network:" + network);
1948 setProcessDefaultNetworkForHostResolution(network);
1949 }
1950 @Override
1951 public void onLost(Network network) {
1952 if (network.equals(currentNetwork)) clearDnsBinding();
1953 Log.d(TAG, "startUsingNetworkFeature lost Network:" + network);
1954 }
1955 };
1956 }
1957
1958 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
1959 private static final HashMap<NetworkCapabilities, LegacyRequest> sLegacyRequests =
1960 new HashMap<>();
1961
1962 private NetworkRequest findRequestForFeature(NetworkCapabilities netCap) {
1963 synchronized (sLegacyRequests) {
1964 LegacyRequest l = sLegacyRequests.get(netCap);
1965 if (l != null) return l.networkRequest;
1966 }
1967 return null;
1968 }
1969
1970 private void renewRequestLocked(LegacyRequest l) {
1971 l.expireSequenceNumber++;
1972 Log.d(TAG, "renewing request to seqNum " + l.expireSequenceNumber);
1973 sendExpireMsgForFeature(l.networkCapabilities, l.expireSequenceNumber, l.delay);
1974 }
1975
1976 private void expireRequest(NetworkCapabilities netCap, int sequenceNum) {
1977 int ourSeqNum = -1;
1978 synchronized (sLegacyRequests) {
1979 LegacyRequest l = sLegacyRequests.get(netCap);
1980 if (l == null) return;
1981 ourSeqNum = l.expireSequenceNumber;
1982 if (l.expireSequenceNumber == sequenceNum) removeRequestForFeature(netCap);
1983 }
1984 Log.d(TAG, "expireRequest with " + ourSeqNum + ", " + sequenceNum);
1985 }
1986
1987 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
1988 private NetworkRequest requestNetworkForFeatureLocked(NetworkCapabilities netCap) {
1989 int delay = -1;
1990 int type = legacyTypeForNetworkCapabilities(netCap);
1991 try {
1992 delay = mService.getRestoreDefaultNetworkDelay(type);
1993 } catch (RemoteException e) {
1994 throw e.rethrowFromSystemServer();
1995 }
1996 LegacyRequest l = new LegacyRequest();
1997 l.networkCapabilities = netCap;
1998 l.delay = delay;
1999 l.expireSequenceNumber = 0;
2000 l.networkRequest = sendRequestForNetwork(
2001 netCap, l.networkCallback, 0, REQUEST, type, getDefaultHandler());
2002 if (l.networkRequest == null) return null;
2003 sLegacyRequests.put(netCap, l);
2004 sendExpireMsgForFeature(netCap, l.expireSequenceNumber, delay);
2005 return l.networkRequest;
2006 }
2007
2008 private void sendExpireMsgForFeature(NetworkCapabilities netCap, int seqNum, int delay) {
2009 if (delay >= 0) {
2010 Log.d(TAG, "sending expire msg with seqNum " + seqNum + " and delay " + delay);
2011 CallbackHandler handler = getDefaultHandler();
2012 Message msg = handler.obtainMessage(EXPIRE_LEGACY_REQUEST, seqNum, 0, netCap);
2013 handler.sendMessageDelayed(msg, delay);
2014 }
2015 }
2016
2017 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
2018 private boolean removeRequestForFeature(NetworkCapabilities netCap) {
2019 final LegacyRequest l;
2020 synchronized (sLegacyRequests) {
2021 l = sLegacyRequests.remove(netCap);
2022 }
2023 if (l == null) return false;
2024 unregisterNetworkCallback(l.networkCallback);
2025 l.clearDnsBinding();
2026 return true;
2027 }
2028
2029 private static final SparseIntArray sLegacyTypeToTransport = new SparseIntArray();
2030 static {
2031 sLegacyTypeToTransport.put(TYPE_MOBILE, NetworkCapabilities.TRANSPORT_CELLULAR);
2032 sLegacyTypeToTransport.put(TYPE_MOBILE_CBS, NetworkCapabilities.TRANSPORT_CELLULAR);
2033 sLegacyTypeToTransport.put(TYPE_MOBILE_DUN, NetworkCapabilities.TRANSPORT_CELLULAR);
2034 sLegacyTypeToTransport.put(TYPE_MOBILE_FOTA, NetworkCapabilities.TRANSPORT_CELLULAR);
2035 sLegacyTypeToTransport.put(TYPE_MOBILE_HIPRI, NetworkCapabilities.TRANSPORT_CELLULAR);
2036 sLegacyTypeToTransport.put(TYPE_MOBILE_IMS, NetworkCapabilities.TRANSPORT_CELLULAR);
2037 sLegacyTypeToTransport.put(TYPE_MOBILE_MMS, NetworkCapabilities.TRANSPORT_CELLULAR);
2038 sLegacyTypeToTransport.put(TYPE_MOBILE_SUPL, NetworkCapabilities.TRANSPORT_CELLULAR);
2039 sLegacyTypeToTransport.put(TYPE_WIFI, NetworkCapabilities.TRANSPORT_WIFI);
2040 sLegacyTypeToTransport.put(TYPE_WIFI_P2P, NetworkCapabilities.TRANSPORT_WIFI);
2041 sLegacyTypeToTransport.put(TYPE_BLUETOOTH, NetworkCapabilities.TRANSPORT_BLUETOOTH);
2042 sLegacyTypeToTransport.put(TYPE_ETHERNET, NetworkCapabilities.TRANSPORT_ETHERNET);
2043 }
2044
2045 private static final SparseIntArray sLegacyTypeToCapability = new SparseIntArray();
2046 static {
2047 sLegacyTypeToCapability.put(TYPE_MOBILE_CBS, NetworkCapabilities.NET_CAPABILITY_CBS);
2048 sLegacyTypeToCapability.put(TYPE_MOBILE_DUN, NetworkCapabilities.NET_CAPABILITY_DUN);
2049 sLegacyTypeToCapability.put(TYPE_MOBILE_FOTA, NetworkCapabilities.NET_CAPABILITY_FOTA);
2050 sLegacyTypeToCapability.put(TYPE_MOBILE_IMS, NetworkCapabilities.NET_CAPABILITY_IMS);
2051 sLegacyTypeToCapability.put(TYPE_MOBILE_MMS, NetworkCapabilities.NET_CAPABILITY_MMS);
2052 sLegacyTypeToCapability.put(TYPE_MOBILE_SUPL, NetworkCapabilities.NET_CAPABILITY_SUPL);
2053 sLegacyTypeToCapability.put(TYPE_WIFI_P2P, NetworkCapabilities.NET_CAPABILITY_WIFI_P2P);
2054 }
2055
2056 /**
2057 * Given a legacy type (TYPE_WIFI, ...) returns a NetworkCapabilities
2058 * instance suitable for registering a request or callback. Throws an
2059 * IllegalArgumentException if no mapping from the legacy type to
2060 * NetworkCapabilities is known.
2061 *
2062 * @deprecated Types are deprecated. Use {@link NetworkCallback} or {@link NetworkRequest}
2063 * to find the network instead.
2064 * @hide
2065 */
2066 public static NetworkCapabilities networkCapabilitiesForType(int type) {
2067 final NetworkCapabilities nc = new NetworkCapabilities();
2068
2069 // Map from type to transports.
2070 final int NOT_FOUND = -1;
2071 final int transport = sLegacyTypeToTransport.get(type, NOT_FOUND);
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00002072 if (transport == NOT_FOUND) {
2073 throw new IllegalArgumentException("unknown legacy type: " + type);
2074 }
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002075 nc.addTransportType(transport);
2076
2077 // Map from type to capabilities.
2078 nc.addCapability(sLegacyTypeToCapability.get(
2079 type, NetworkCapabilities.NET_CAPABILITY_INTERNET));
2080 nc.maybeMarkCapabilitiesRestricted();
2081 return nc;
2082 }
2083
2084 /** @hide */
2085 public static class PacketKeepaliveCallback {
2086 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
2087 public PacketKeepaliveCallback() {
2088 }
2089 /** The requested keepalive was successfully started. */
2090 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
2091 public void onStarted() {}
2092 /** The keepalive was successfully stopped. */
2093 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
2094 public void onStopped() {}
2095 /** An error occurred. */
2096 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
2097 public void onError(int error) {}
2098 }
2099
2100 /**
2101 * Allows applications to request that the system periodically send specific packets on their
2102 * behalf, using hardware offload to save battery power.
2103 *
2104 * To request that the system send keepalives, call one of the methods that return a
2105 * {@link ConnectivityManager.PacketKeepalive} object, such as {@link #startNattKeepalive},
2106 * passing in a non-null callback. If the callback is successfully started, the callback's
2107 * {@code onStarted} method will be called. If an error occurs, {@code onError} will be called,
2108 * specifying one of the {@code ERROR_*} constants in this class.
2109 *
2110 * To stop an existing keepalive, call {@link PacketKeepalive#stop}. The system will call
2111 * {@link PacketKeepaliveCallback#onStopped} if the operation was successful or
2112 * {@link PacketKeepaliveCallback#onError} if an error occurred.
2113 *
2114 * @deprecated Use {@link SocketKeepalive} instead.
2115 *
2116 * @hide
2117 */
2118 public class PacketKeepalive {
2119
2120 private static final String TAG = "PacketKeepalive";
2121
2122 /** @hide */
2123 public static final int SUCCESS = 0;
2124
2125 /** @hide */
2126 public static final int NO_KEEPALIVE = -1;
2127
2128 /** @hide */
2129 public static final int BINDER_DIED = -10;
2130
2131 /** The specified {@code Network} is not connected. */
2132 public static final int ERROR_INVALID_NETWORK = -20;
2133 /** The specified IP addresses are invalid. For example, the specified source IP address is
2134 * not configured on the specified {@code Network}. */
2135 public static final int ERROR_INVALID_IP_ADDRESS = -21;
2136 /** The requested port is invalid. */
2137 public static final int ERROR_INVALID_PORT = -22;
2138 /** The packet length is invalid (e.g., too long). */
2139 public static final int ERROR_INVALID_LENGTH = -23;
2140 /** The packet transmission interval is invalid (e.g., too short). */
2141 public static final int ERROR_INVALID_INTERVAL = -24;
2142
2143 /** The hardware does not support this request. */
2144 public static final int ERROR_HARDWARE_UNSUPPORTED = -30;
2145 /** The hardware returned an error. */
2146 public static final int ERROR_HARDWARE_ERROR = -31;
2147
2148 /** The NAT-T destination port for IPsec */
2149 public static final int NATT_PORT = 4500;
2150
2151 /** The minimum interval in seconds between keepalive packet transmissions */
2152 public static final int MIN_INTERVAL = 10;
2153
2154 private final Network mNetwork;
2155 private final ISocketKeepaliveCallback mCallback;
2156 private final ExecutorService mExecutor;
2157
2158 private volatile Integer mSlot;
2159
2160 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
2161 public void stop() {
2162 try {
2163 mExecutor.execute(() -> {
2164 try {
2165 if (mSlot != null) {
2166 mService.stopKeepalive(mNetwork, mSlot);
2167 }
2168 } catch (RemoteException e) {
2169 Log.e(TAG, "Error stopping packet keepalive: ", e);
2170 throw e.rethrowFromSystemServer();
2171 }
2172 });
2173 } catch (RejectedExecutionException e) {
2174 // The internal executor has already stopped due to previous event.
2175 }
2176 }
2177
2178 private PacketKeepalive(Network network, PacketKeepaliveCallback callback) {
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00002179 Objects.requireNonNull(network, "network cannot be null");
2180 Objects.requireNonNull(callback, "callback cannot be null");
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002181 mNetwork = network;
2182 mExecutor = Executors.newSingleThreadExecutor();
2183 mCallback = new ISocketKeepaliveCallback.Stub() {
2184 @Override
2185 public void onStarted(int slot) {
2186 final long token = Binder.clearCallingIdentity();
2187 try {
2188 mExecutor.execute(() -> {
2189 mSlot = slot;
2190 callback.onStarted();
2191 });
2192 } finally {
2193 Binder.restoreCallingIdentity(token);
2194 }
2195 }
2196
2197 @Override
2198 public void onStopped() {
2199 final long token = Binder.clearCallingIdentity();
2200 try {
2201 mExecutor.execute(() -> {
2202 mSlot = null;
2203 callback.onStopped();
2204 });
2205 } finally {
2206 Binder.restoreCallingIdentity(token);
2207 }
2208 mExecutor.shutdown();
2209 }
2210
2211 @Override
2212 public void onError(int error) {
2213 final long token = Binder.clearCallingIdentity();
2214 try {
2215 mExecutor.execute(() -> {
2216 mSlot = null;
2217 callback.onError(error);
2218 });
2219 } finally {
2220 Binder.restoreCallingIdentity(token);
2221 }
2222 mExecutor.shutdown();
2223 }
2224
2225 @Override
2226 public void onDataReceived() {
2227 // PacketKeepalive is only used for Nat-T keepalive and as such does not invoke
2228 // this callback when data is received.
2229 }
2230 };
2231 }
2232 }
2233
2234 /**
2235 * Starts an IPsec NAT-T keepalive packet with the specified parameters.
2236 *
2237 * @deprecated Use {@link #createSocketKeepalive} instead.
2238 *
2239 * @hide
2240 */
2241 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
2242 public PacketKeepalive startNattKeepalive(
2243 Network network, int intervalSeconds, PacketKeepaliveCallback callback,
2244 InetAddress srcAddr, int srcPort, InetAddress dstAddr) {
2245 final PacketKeepalive k = new PacketKeepalive(network, callback);
2246 try {
2247 mService.startNattKeepalive(network, intervalSeconds, k.mCallback,
2248 srcAddr.getHostAddress(), srcPort, dstAddr.getHostAddress());
2249 } catch (RemoteException e) {
2250 Log.e(TAG, "Error starting packet keepalive: ", e);
2251 throw e.rethrowFromSystemServer();
2252 }
2253 return k;
2254 }
2255
2256 // Construct an invalid fd.
2257 private ParcelFileDescriptor createInvalidFd() {
2258 final int invalidFd = -1;
2259 return ParcelFileDescriptor.adoptFd(invalidFd);
2260 }
2261
2262 /**
2263 * Request that keepalives be started on a IPsec NAT-T socket.
2264 *
2265 * @param network The {@link Network} the socket is on.
2266 * @param socket The socket that needs to be kept alive.
2267 * @param source The source address of the {@link UdpEncapsulationSocket}.
2268 * @param destination The destination address of the {@link UdpEncapsulationSocket}.
2269 * @param executor The executor on which callback will be invoked. The provided {@link Executor}
2270 * must run callback sequentially, otherwise the order of callbacks cannot be
2271 * guaranteed.
2272 * @param callback A {@link SocketKeepalive.Callback}. Used for notifications about keepalive
2273 * changes. Must be extended by applications that use this API.
2274 *
2275 * @return A {@link SocketKeepalive} object that can be used to control the keepalive on the
2276 * given socket.
2277 **/
2278 public @NonNull SocketKeepalive createSocketKeepalive(@NonNull Network network,
2279 @NonNull UdpEncapsulationSocket socket,
2280 @NonNull InetAddress source,
2281 @NonNull InetAddress destination,
2282 @NonNull @CallbackExecutor Executor executor,
2283 @NonNull Callback callback) {
2284 ParcelFileDescriptor dup;
2285 try {
2286 // Dup is needed here as the pfd inside the socket is owned by the IpSecService,
2287 // which cannot be obtained by the app process.
2288 dup = ParcelFileDescriptor.dup(socket.getFileDescriptor());
2289 } catch (IOException ignored) {
2290 // Construct an invalid fd, so that if the user later calls start(), it will fail with
2291 // ERROR_INVALID_SOCKET.
2292 dup = createInvalidFd();
2293 }
2294 return new NattSocketKeepalive(mService, network, dup, socket.getResourceId(), source,
2295 destination, executor, callback);
2296 }
2297
2298 /**
2299 * Request that keepalives be started on a IPsec NAT-T socket file descriptor. Directly called
2300 * by system apps which don't use IpSecService to create {@link UdpEncapsulationSocket}.
2301 *
2302 * @param network The {@link Network} the socket is on.
2303 * @param pfd The {@link ParcelFileDescriptor} that needs to be kept alive. The provided
2304 * {@link ParcelFileDescriptor} must be bound to a port and the keepalives will be sent
2305 * from that port.
2306 * @param source The source address of the {@link UdpEncapsulationSocket}.
2307 * @param destination The destination address of the {@link UdpEncapsulationSocket}. The
2308 * keepalive packets will always be sent to port 4500 of the given {@code destination}.
2309 * @param executor The executor on which callback will be invoked. The provided {@link Executor}
2310 * must run callback sequentially, otherwise the order of callbacks cannot be
2311 * guaranteed.
2312 * @param callback A {@link SocketKeepalive.Callback}. Used for notifications about keepalive
2313 * changes. Must be extended by applications that use this API.
2314 *
2315 * @return A {@link SocketKeepalive} object that can be used to control the keepalive on the
2316 * given socket.
2317 * @hide
2318 */
2319 @SystemApi
2320 @RequiresPermission(android.Manifest.permission.PACKET_KEEPALIVE_OFFLOAD)
2321 public @NonNull SocketKeepalive createNattKeepalive(@NonNull Network network,
2322 @NonNull ParcelFileDescriptor pfd,
2323 @NonNull InetAddress source,
2324 @NonNull InetAddress destination,
2325 @NonNull @CallbackExecutor Executor executor,
2326 @NonNull Callback callback) {
2327 ParcelFileDescriptor dup;
2328 try {
2329 // TODO: Consider remove unnecessary dup.
2330 dup = pfd.dup();
2331 } catch (IOException ignored) {
2332 // Construct an invalid fd, so that if the user later calls start(), it will fail with
2333 // ERROR_INVALID_SOCKET.
2334 dup = createInvalidFd();
2335 }
2336 return new NattSocketKeepalive(mService, network, dup,
Remi NGUYEN VANa29be5c2021-03-11 10:56:49 +00002337 -1 /* Unused */, source, destination, executor, callback);
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002338 }
2339
2340 /**
2341 * Request that keepalives be started on a TCP socket.
2342 * The socket must be established.
2343 *
2344 * @param network The {@link Network} the socket is on.
2345 * @param socket The socket that needs to be kept alive.
2346 * @param executor The executor on which callback will be invoked. This implementation assumes
2347 * the provided {@link Executor} runs the callbacks in sequence with no
2348 * concurrency. Failing this, no guarantee of correctness can be made. It is
2349 * the responsibility of the caller to ensure the executor provides this
2350 * guarantee. A simple way of creating such an executor is with the standard
2351 * tool {@code Executors.newSingleThreadExecutor}.
2352 * @param callback A {@link SocketKeepalive.Callback}. Used for notifications about keepalive
2353 * changes. Must be extended by applications that use this API.
2354 *
2355 * @return A {@link SocketKeepalive} object that can be used to control the keepalive on the
2356 * given socket.
2357 * @hide
2358 */
2359 @SystemApi
2360 @RequiresPermission(android.Manifest.permission.PACKET_KEEPALIVE_OFFLOAD)
2361 public @NonNull SocketKeepalive createSocketKeepalive(@NonNull Network network,
2362 @NonNull Socket socket,
2363 @NonNull Executor executor,
2364 @NonNull Callback callback) {
2365 ParcelFileDescriptor dup;
2366 try {
2367 dup = ParcelFileDescriptor.fromSocket(socket);
2368 } catch (UncheckedIOException ignored) {
2369 // Construct an invalid fd, so that if the user later calls start(), it will fail with
2370 // ERROR_INVALID_SOCKET.
2371 dup = createInvalidFd();
2372 }
2373 return new TcpSocketKeepalive(mService, network, dup, executor, callback);
2374 }
2375
2376 /**
2377 * Ensure that a network route exists to deliver traffic to the specified
2378 * host via the specified network interface. An attempt to add a route that
2379 * already exists is ignored, but treated as successful.
2380 *
2381 * <p>This method requires the caller to hold either the
2382 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
2383 * or the ability to modify system settings as determined by
2384 * {@link android.provider.Settings.System#canWrite}.</p>
2385 *
2386 * @param networkType the type of the network over which traffic to the specified
2387 * host is to be routed
2388 * @param hostAddress the IP address of the host to which the route is desired
2389 * @return {@code true} on success, {@code false} on failure
2390 *
2391 * @deprecated Deprecated in favor of the
2392 * {@link #requestNetwork(NetworkRequest, NetworkCallback)},
2393 * {@link #bindProcessToNetwork} and {@link Network#getSocketFactory} API.
2394 * In {@link VERSION_CODES#M}, and above, this method is unsupported and will
2395 * throw {@code UnsupportedOperationException} if called.
2396 * @removed
2397 */
2398 @Deprecated
2399 public boolean requestRouteToHost(int networkType, int hostAddress) {
2400 return requestRouteToHostAddress(networkType, NetworkUtils.intToInetAddress(hostAddress));
2401 }
2402
2403 /**
2404 * Ensure that a network route exists to deliver traffic to the specified
2405 * host via the specified network interface. An attempt to add a route that
2406 * already exists is ignored, but treated as successful.
2407 *
2408 * <p>This method requires the caller to hold either the
2409 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
2410 * or the ability to modify system settings as determined by
2411 * {@link android.provider.Settings.System#canWrite}.</p>
2412 *
2413 * @param networkType the type of the network over which traffic to the specified
2414 * host is to be routed
2415 * @param hostAddress the IP address of the host to which the route is desired
2416 * @return {@code true} on success, {@code false} on failure
2417 * @hide
2418 * @deprecated Deprecated in favor of the {@link #requestNetwork} and
2419 * {@link #bindProcessToNetwork} API.
2420 */
2421 @Deprecated
2422 @UnsupportedAppUsage
lucaslin97fb10a2021-03-22 11:51:27 +08002423 @SystemApi(client = MODULE_LIBRARIES)
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002424 public boolean requestRouteToHostAddress(int networkType, InetAddress hostAddress) {
2425 checkLegacyRoutingApiAccess();
2426 try {
2427 return mService.requestRouteToHostAddress(networkType, hostAddress.getAddress(),
2428 mContext.getOpPackageName(), getAttributionTag());
2429 } catch (RemoteException e) {
2430 throw e.rethrowFromSystemServer();
2431 }
2432 }
2433
2434 /**
2435 * @return the context's attribution tag
2436 */
2437 // TODO: Remove method and replace with direct call once R code is pushed to AOSP
2438 private @Nullable String getAttributionTag() {
Remi NGUYEN VANa522fc22021-02-01 10:25:24 +00002439 return mContext.getAttributionTag();
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002440 }
2441
2442 /**
2443 * Returns the value of the setting for background data usage. If false,
2444 * applications should not use the network if the application is not in the
2445 * foreground. Developers should respect this setting, and check the value
2446 * of this before performing any background data operations.
2447 * <p>
2448 * All applications that have background services that use the network
2449 * should listen to {@link #ACTION_BACKGROUND_DATA_SETTING_CHANGED}.
2450 * <p>
2451 * @deprecated As of {@link VERSION_CODES#ICE_CREAM_SANDWICH}, availability of
2452 * background data depends on several combined factors, and this method will
2453 * always return {@code true}. Instead, when background data is unavailable,
2454 * {@link #getActiveNetworkInfo()} will now appear disconnected.
2455 *
2456 * @return Whether background data usage is allowed.
2457 */
2458 @Deprecated
2459 public boolean getBackgroundDataSetting() {
2460 // assume that background data is allowed; final authority is
2461 // NetworkInfo which may be blocked.
2462 return true;
2463 }
2464
2465 /**
2466 * Sets the value of the setting for background data usage.
2467 *
2468 * @param allowBackgroundData Whether an application should use data while
2469 * it is in the background.
2470 *
2471 * @attr ref android.Manifest.permission#CHANGE_BACKGROUND_DATA_SETTING
2472 * @see #getBackgroundDataSetting()
2473 * @hide
2474 */
2475 @Deprecated
2476 @UnsupportedAppUsage
2477 public void setBackgroundDataSetting(boolean allowBackgroundData) {
2478 // ignored
2479 }
2480
2481 /**
2482 * @hide
2483 * @deprecated Talk to TelephonyManager directly
2484 */
2485 @Deprecated
2486 @UnsupportedAppUsage
2487 public boolean getMobileDataEnabled() {
2488 TelephonyManager tm = mContext.getSystemService(TelephonyManager.class);
2489 if (tm != null) {
2490 int subId = SubscriptionManager.getDefaultDataSubscriptionId();
2491 Log.d("ConnectivityManager", "getMobileDataEnabled()+ subId=" + subId);
2492 boolean retVal = tm.createForSubscriptionId(subId).isDataEnabled();
2493 Log.d("ConnectivityManager", "getMobileDataEnabled()- subId=" + subId
2494 + " retVal=" + retVal);
2495 return retVal;
2496 }
2497 Log.d("ConnectivityManager", "getMobileDataEnabled()- remote exception retVal=false");
2498 return false;
2499 }
2500
2501 /**
2502 * Callback for use with {@link ConnectivityManager#addDefaultNetworkActiveListener}
2503 * to find out when the system default network has gone in to a high power state.
2504 */
2505 public interface OnNetworkActiveListener {
2506 /**
2507 * Called on the main thread of the process to report that the current data network
2508 * has become active, and it is now a good time to perform any pending network
2509 * operations. Note that this listener only tells you when the network becomes
2510 * active; if at any other time you want to know whether it is active (and thus okay
2511 * to initiate network traffic), you can retrieve its instantaneous state with
2512 * {@link ConnectivityManager#isDefaultNetworkActive}.
2513 */
2514 void onNetworkActive();
2515 }
2516
Chiachang Wang2de41682021-09-23 10:46:03 +08002517 @GuardedBy("mNetworkActivityListeners")
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002518 private final ArrayMap<OnNetworkActiveListener, INetworkActivityListener>
2519 mNetworkActivityListeners = new ArrayMap<>();
2520
2521 /**
2522 * Start listening to reports when the system's default data network is active, meaning it is
2523 * a good time to perform network traffic. Use {@link #isDefaultNetworkActive()}
2524 * to determine the current state of the system's default network after registering the
2525 * listener.
2526 * <p>
2527 * If the process default network has been set with
2528 * {@link ConnectivityManager#bindProcessToNetwork} this function will not
2529 * reflect the process's default, but the system default.
2530 *
2531 * @param l The listener to be told when the network is active.
2532 */
2533 public void addDefaultNetworkActiveListener(final OnNetworkActiveListener l) {
Chiachang Wang2de41682021-09-23 10:46:03 +08002534 final INetworkActivityListener rl = new INetworkActivityListener.Stub() {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002535 @Override
2536 public void onNetworkActive() throws RemoteException {
2537 l.onNetworkActive();
2538 }
2539 };
2540
Chiachang Wang2de41682021-09-23 10:46:03 +08002541 synchronized (mNetworkActivityListeners) {
2542 try {
2543 mService.registerNetworkActivityListener(rl);
2544 mNetworkActivityListeners.put(l, rl);
2545 } catch (RemoteException e) {
2546 throw e.rethrowFromSystemServer();
2547 }
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002548 }
2549 }
2550
2551 /**
2552 * Remove network active listener previously registered with
2553 * {@link #addDefaultNetworkActiveListener}.
2554 *
2555 * @param l Previously registered listener.
2556 */
2557 public void removeDefaultNetworkActiveListener(@NonNull OnNetworkActiveListener l) {
Chiachang Wang2de41682021-09-23 10:46:03 +08002558 synchronized (mNetworkActivityListeners) {
2559 final INetworkActivityListener rl = mNetworkActivityListeners.get(l);
2560 if (rl == null) {
2561 throw new IllegalArgumentException("Listener was not registered.");
2562 }
2563 try {
2564 mService.unregisterNetworkActivityListener(rl);
2565 mNetworkActivityListeners.remove(l);
2566 } catch (RemoteException e) {
2567 throw e.rethrowFromSystemServer();
2568 }
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002569 }
2570 }
2571
2572 /**
2573 * Return whether the data network is currently active. An active network means that
2574 * it is currently in a high power state for performing data transmission. On some
2575 * types of networks, it may be expensive to move and stay in such a state, so it is
2576 * more power efficient to batch network traffic together when the radio is already in
2577 * this state. This method tells you whether right now is currently a good time to
2578 * initiate network traffic, as the network is already active.
2579 */
2580 public boolean isDefaultNetworkActive() {
2581 try {
lucaslin709eb842021-01-21 02:04:15 +08002582 return mService.isDefaultNetworkActive();
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002583 } catch (RemoteException e) {
2584 throw e.rethrowFromSystemServer();
2585 }
2586 }
2587
2588 /**
2589 * {@hide}
2590 */
2591 public ConnectivityManager(Context context, IConnectivityManager service) {
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00002592 mContext = Objects.requireNonNull(context, "missing context");
2593 mService = Objects.requireNonNull(service, "missing IConnectivityManager");
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002594 sInstance = this;
2595 }
2596
2597 /** {@hide} */
2598 @UnsupportedAppUsage
2599 public static ConnectivityManager from(Context context) {
2600 return (ConnectivityManager) context.getSystemService(Context.CONNECTIVITY_SERVICE);
2601 }
2602
2603 /** @hide */
2604 public NetworkRequest getDefaultRequest() {
2605 try {
2606 // This is not racy as the default request is final in ConnectivityService.
2607 return mService.getDefaultRequest();
2608 } catch (RemoteException e) {
2609 throw e.rethrowFromSystemServer();
2610 }
2611 }
2612
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002613 /**
2614 * Check if the package is a allowed to write settings. This also accounts that such an access
2615 * happened.
2616 *
2617 * @return {@code true} iff the package is allowed to write settings.
2618 */
2619 // TODO: Remove method and replace with direct call once R code is pushed to AOSP
2620 private static boolean checkAndNoteWriteSettingsOperation(@NonNull Context context, int uid,
2621 @NonNull String callingPackage, @Nullable String callingAttributionTag,
2622 boolean throwException) {
2623 return Settings.checkAndNoteWriteSettingsOperation(context, uid, callingPackage,
Remi NGUYEN VANa522fc22021-02-01 10:25:24 +00002624 callingAttributionTag, throwException);
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002625 }
2626
2627 /**
2628 * @deprecated - use getSystemService. This is a kludge to support static access in certain
2629 * situations where a Context pointer is unavailable.
2630 * @hide
2631 */
2632 @Deprecated
2633 static ConnectivityManager getInstanceOrNull() {
2634 return sInstance;
2635 }
2636
2637 /**
2638 * @deprecated - use getSystemService. This is a kludge to support static access in certain
2639 * situations where a Context pointer is unavailable.
2640 * @hide
2641 */
2642 @Deprecated
2643 @UnsupportedAppUsage
2644 private static ConnectivityManager getInstance() {
2645 if (getInstanceOrNull() == null) {
2646 throw new IllegalStateException("No ConnectivityManager yet constructed");
2647 }
2648 return getInstanceOrNull();
2649 }
2650
2651 /**
2652 * Get the set of tetherable, available interfaces. This list is limited by
2653 * device configuration and current interface existence.
2654 *
2655 * @return an array of 0 or more Strings of tetherable interface names.
2656 *
2657 * @deprecated Use {@link TetheringEventCallback#onTetherableInterfacesChanged(List)} instead.
2658 * {@hide}
2659 */
2660 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
2661 @UnsupportedAppUsage
2662 @Deprecated
2663 public String[] getTetherableIfaces() {
Remi NGUYEN VANe4d1cd92021-06-17 16:27:31 +09002664 return getTetheringManager().getTetherableIfaces();
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002665 }
2666
2667 /**
2668 * Get the set of tethered interfaces.
2669 *
2670 * @return an array of 0 or more String of currently tethered interface names.
2671 *
2672 * @deprecated Use {@link TetheringEventCallback#onTetherableInterfacesChanged(List)} instead.
2673 * {@hide}
2674 */
2675 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
2676 @UnsupportedAppUsage
2677 @Deprecated
2678 public String[] getTetheredIfaces() {
Remi NGUYEN VANe4d1cd92021-06-17 16:27:31 +09002679 return getTetheringManager().getTetheredIfaces();
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002680 }
2681
2682 /**
2683 * Get the set of interface names which attempted to tether but
2684 * failed. Re-attempting to tether may cause them to reset to the Tethered
2685 * state. Alternatively, causing the interface to be destroyed and recreated
2686 * may cause them to reset to the available state.
2687 * {@link ConnectivityManager#getLastTetherError} can be used to get more
2688 * information on the cause of the errors.
2689 *
2690 * @return an array of 0 or more String indicating the interface names
2691 * which failed to tether.
2692 *
2693 * @deprecated Use {@link TetheringEventCallback#onError(String, int)} instead.
2694 * {@hide}
2695 */
2696 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
2697 @UnsupportedAppUsage
2698 @Deprecated
2699 public String[] getTetheringErroredIfaces() {
Remi NGUYEN VANe4d1cd92021-06-17 16:27:31 +09002700 return getTetheringManager().getTetheringErroredIfaces();
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002701 }
2702
2703 /**
2704 * Get the set of tethered dhcp ranges.
2705 *
2706 * @deprecated This method is not supported.
2707 * TODO: remove this function when all of clients are removed.
2708 * {@hide}
2709 */
2710 @RequiresPermission(android.Manifest.permission.NETWORK_SETTINGS)
2711 @Deprecated
2712 public String[] getTetheredDhcpRanges() {
2713 throw new UnsupportedOperationException("getTetheredDhcpRanges is not supported");
2714 }
2715
2716 /**
2717 * Attempt to tether the named interface. This will setup a dhcp server
2718 * on the interface, forward and NAT IP packets and forward DNS requests
2719 * to the best active upstream network interface. Note that if no upstream
2720 * IP network interface is available, dhcp will still run and traffic will be
2721 * allowed between the tethered devices and this device, though upstream net
2722 * access will of course fail until an upstream network interface becomes
2723 * active.
2724 *
2725 * <p>This method requires the caller to hold either the
2726 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
2727 * or the ability to modify system settings as determined by
2728 * {@link android.provider.Settings.System#canWrite}.</p>
2729 *
2730 * <p>WARNING: New clients should not use this function. The only usages should be in PanService
2731 * and WifiStateMachine which need direct access. All other clients should use
2732 * {@link #startTethering} and {@link #stopTethering} which encapsulate proper provisioning
2733 * logic.</p>
2734 *
2735 * @param iface the interface name to tether.
2736 * @return error a {@code TETHER_ERROR} value indicating success or failure type
2737 * @deprecated Use {@link TetheringManager#startTethering} instead
2738 *
2739 * {@hide}
2740 */
2741 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
2742 @Deprecated
2743 public int tether(String iface) {
Remi NGUYEN VANe4d1cd92021-06-17 16:27:31 +09002744 return getTetheringManager().tether(iface);
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002745 }
2746
2747 /**
2748 * Stop tethering the named interface.
2749 *
2750 * <p>This method requires the caller to hold either the
2751 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
2752 * or the ability to modify system settings as determined by
2753 * {@link android.provider.Settings.System#canWrite}.</p>
2754 *
2755 * <p>WARNING: New clients should not use this function. The only usages should be in PanService
2756 * and WifiStateMachine which need direct access. All other clients should use
2757 * {@link #startTethering} and {@link #stopTethering} which encapsulate proper provisioning
2758 * logic.</p>
2759 *
2760 * @param iface the interface name to untether.
2761 * @return error a {@code TETHER_ERROR} value indicating success or failure type
2762 *
2763 * {@hide}
2764 */
2765 @UnsupportedAppUsage
2766 @Deprecated
2767 public int untether(String iface) {
Remi NGUYEN VANe4d1cd92021-06-17 16:27:31 +09002768 return getTetheringManager().untether(iface);
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002769 }
2770
2771 /**
2772 * Check if the device allows for tethering. It may be disabled via
2773 * {@code ro.tether.denied} system property, Settings.TETHER_SUPPORTED or
2774 * due to device configuration.
2775 *
2776 * <p>If this app does not have permission to use this API, it will always
2777 * return false rather than throw an exception.</p>
2778 *
2779 * <p>If the device has a hotspot provisioning app, the caller is required to hold the
2780 * {@link android.Manifest.permission.TETHER_PRIVILEGED} permission.</p>
2781 *
2782 * <p>Otherwise, this method requires the caller to hold the ability to modify system
2783 * settings as determined by {@link android.provider.Settings.System#canWrite}.</p>
2784 *
2785 * @return a boolean - {@code true} indicating Tethering is supported.
2786 *
2787 * @deprecated Use {@link TetheringEventCallback#onTetheringSupported(boolean)} instead.
2788 * {@hide}
2789 */
2790 @SystemApi
2791 @RequiresPermission(anyOf = {android.Manifest.permission.TETHER_PRIVILEGED,
2792 android.Manifest.permission.WRITE_SETTINGS})
2793 public boolean isTetheringSupported() {
Remi NGUYEN VANe4d1cd92021-06-17 16:27:31 +09002794 return getTetheringManager().isTetheringSupported();
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002795 }
2796
2797 /**
2798 * Callback for use with {@link #startTethering} to find out whether tethering succeeded.
2799 *
2800 * @deprecated Use {@link TetheringManager.StartTetheringCallback} instead.
2801 * @hide
2802 */
2803 @SystemApi
2804 @Deprecated
2805 public static abstract class OnStartTetheringCallback {
2806 /**
2807 * Called when tethering has been successfully started.
2808 */
2809 public void onTetheringStarted() {}
2810
2811 /**
2812 * Called when starting tethering failed.
2813 */
2814 public void onTetheringFailed() {}
2815 }
2816
2817 /**
2818 * Convenient overload for
2819 * {@link #startTethering(int, boolean, OnStartTetheringCallback, Handler)} which passes a null
2820 * handler to run on the current thread's {@link Looper}.
2821 *
2822 * @deprecated Use {@link TetheringManager#startTethering} instead.
2823 * @hide
2824 */
2825 @SystemApi
2826 @Deprecated
2827 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
2828 public void startTethering(int type, boolean showProvisioningUi,
2829 final OnStartTetheringCallback callback) {
2830 startTethering(type, showProvisioningUi, callback, null);
2831 }
2832
2833 /**
2834 * Runs tether provisioning for the given type if needed and then starts tethering if
2835 * the check succeeds. If no carrier provisioning is required for tethering, tethering is
2836 * enabled immediately. If provisioning fails, tethering will not be enabled. It also
2837 * schedules tether provisioning re-checks if appropriate.
2838 *
2839 * @param type The type of tethering to start. Must be one of
2840 * {@link ConnectivityManager.TETHERING_WIFI},
2841 * {@link ConnectivityManager.TETHERING_USB}, or
2842 * {@link ConnectivityManager.TETHERING_BLUETOOTH}.
2843 * @param showProvisioningUi a boolean indicating to show the provisioning app UI if there
2844 * is one. This should be true the first time this function is called and also any time
2845 * the user can see this UI. It gives users information from their carrier about the
2846 * check failing and how they can sign up for tethering if possible.
2847 * @param callback an {@link OnStartTetheringCallback} which will be called to notify the caller
2848 * of the result of trying to tether.
2849 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
2850 *
2851 * @deprecated Use {@link TetheringManager#startTethering} instead.
2852 * @hide
2853 */
2854 @SystemApi
2855 @Deprecated
2856 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
2857 public void startTethering(int type, boolean showProvisioningUi,
2858 final OnStartTetheringCallback callback, Handler handler) {
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00002859 Objects.requireNonNull(callback, "OnStartTetheringCallback cannot be null.");
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002860
2861 final Executor executor = new Executor() {
2862 @Override
2863 public void execute(Runnable command) {
2864 if (handler == null) {
2865 command.run();
2866 } else {
2867 handler.post(command);
2868 }
2869 }
2870 };
2871
2872 final StartTetheringCallback tetheringCallback = new StartTetheringCallback() {
2873 @Override
2874 public void onTetheringStarted() {
2875 callback.onTetheringStarted();
2876 }
2877
2878 @Override
2879 public void onTetheringFailed(final int error) {
2880 callback.onTetheringFailed();
2881 }
2882 };
2883
2884 final TetheringRequest request = new TetheringRequest.Builder(type)
2885 .setShouldShowEntitlementUi(showProvisioningUi).build();
2886
Remi NGUYEN VANe4d1cd92021-06-17 16:27:31 +09002887 getTetheringManager().startTethering(request, executor, tetheringCallback);
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002888 }
2889
2890 /**
2891 * Stops tethering for the given type. Also cancels any provisioning rechecks for that type if
2892 * applicable.
2893 *
2894 * @param type The type of tethering to stop. Must be one of
2895 * {@link ConnectivityManager.TETHERING_WIFI},
2896 * {@link ConnectivityManager.TETHERING_USB}, or
2897 * {@link ConnectivityManager.TETHERING_BLUETOOTH}.
2898 *
2899 * @deprecated Use {@link TetheringManager#stopTethering} instead.
2900 * @hide
2901 */
2902 @SystemApi
2903 @Deprecated
2904 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
2905 public void stopTethering(int type) {
Remi NGUYEN VANe4d1cd92021-06-17 16:27:31 +09002906 getTetheringManager().stopTethering(type);
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002907 }
2908
2909 /**
2910 * Callback for use with {@link registerTetheringEventCallback} to find out tethering
2911 * upstream status.
2912 *
2913 * @deprecated Use {@link TetheringManager#OnTetheringEventCallback} instead.
2914 * @hide
2915 */
2916 @SystemApi
2917 @Deprecated
2918 public abstract static class OnTetheringEventCallback {
2919
2920 /**
2921 * Called when tethering upstream changed. This can be called multiple times and can be
2922 * called any time.
2923 *
2924 * @param network the {@link Network} of tethering upstream. Null means tethering doesn't
2925 * have any upstream.
2926 */
2927 public void onUpstreamChanged(@Nullable Network network) {}
2928 }
2929
2930 @GuardedBy("mTetheringEventCallbacks")
2931 private final ArrayMap<OnTetheringEventCallback, TetheringEventCallback>
2932 mTetheringEventCallbacks = new ArrayMap<>();
2933
2934 /**
2935 * Start listening to tethering change events. Any new added callback will receive the last
2936 * tethering status right away. If callback is registered when tethering has no upstream or
2937 * disabled, {@link OnTetheringEventCallback#onUpstreamChanged} will immediately be called
2938 * with a null argument. The same callback object cannot be registered twice.
2939 *
2940 * @param executor the executor on which callback will be invoked.
2941 * @param callback the callback to be called when tethering has change events.
2942 *
2943 * @deprecated Use {@link TetheringManager#registerTetheringEventCallback} instead.
2944 * @hide
2945 */
2946 @SystemApi
2947 @Deprecated
2948 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
2949 public void registerTetheringEventCallback(
2950 @NonNull @CallbackExecutor Executor executor,
2951 @NonNull final OnTetheringEventCallback callback) {
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00002952 Objects.requireNonNull(callback, "OnTetheringEventCallback cannot be null.");
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002953
2954 final TetheringEventCallback tetherCallback =
2955 new TetheringEventCallback() {
2956 @Override
2957 public void onUpstreamChanged(@Nullable Network network) {
2958 callback.onUpstreamChanged(network);
2959 }
2960 };
2961
2962 synchronized (mTetheringEventCallbacks) {
2963 mTetheringEventCallbacks.put(callback, tetherCallback);
Remi NGUYEN VANe4d1cd92021-06-17 16:27:31 +09002964 getTetheringManager().registerTetheringEventCallback(executor, tetherCallback);
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002965 }
2966 }
2967
2968 /**
2969 * Remove tethering event callback previously registered with
2970 * {@link #registerTetheringEventCallback}.
2971 *
2972 * @param callback previously registered callback.
2973 *
2974 * @deprecated Use {@link TetheringManager#unregisterTetheringEventCallback} instead.
2975 * @hide
2976 */
2977 @SystemApi
2978 @Deprecated
2979 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
2980 public void unregisterTetheringEventCallback(
2981 @NonNull final OnTetheringEventCallback callback) {
2982 Objects.requireNonNull(callback, "The callback must be non-null");
2983 synchronized (mTetheringEventCallbacks) {
2984 final TetheringEventCallback tetherCallback =
2985 mTetheringEventCallbacks.remove(callback);
Remi NGUYEN VANe4d1cd92021-06-17 16:27:31 +09002986 getTetheringManager().unregisterTetheringEventCallback(tetherCallback);
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002987 }
2988 }
2989
2990
2991 /**
2992 * Get the list of regular expressions that define any tetherable
2993 * USB network interfaces. If USB tethering is not supported by the
2994 * device, this list should be empty.
2995 *
2996 * @return an array of 0 or more regular expression Strings defining
2997 * what interfaces are considered tetherable usb interfaces.
2998 *
2999 * @deprecated Use {@link TetheringEventCallback#onTetherableInterfaceRegexpsChanged} instead.
3000 * {@hide}
3001 */
3002 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
3003 @UnsupportedAppUsage
3004 @Deprecated
3005 public String[] getTetherableUsbRegexs() {
Remi NGUYEN VANe4d1cd92021-06-17 16:27:31 +09003006 return getTetheringManager().getTetherableUsbRegexs();
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003007 }
3008
3009 /**
3010 * Get the list of regular expressions that define any tetherable
3011 * Wifi network interfaces. If Wifi tethering is not supported by the
3012 * device, this list should be empty.
3013 *
3014 * @return an array of 0 or more regular expression Strings defining
3015 * what interfaces are considered tetherable wifi interfaces.
3016 *
3017 * @deprecated Use {@link TetheringEventCallback#onTetherableInterfaceRegexpsChanged} instead.
3018 * {@hide}
3019 */
3020 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
3021 @UnsupportedAppUsage
3022 @Deprecated
3023 public String[] getTetherableWifiRegexs() {
Remi NGUYEN VANe4d1cd92021-06-17 16:27:31 +09003024 return getTetheringManager().getTetherableWifiRegexs();
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003025 }
3026
3027 /**
3028 * Get the list of regular expressions that define any tetherable
3029 * Bluetooth network interfaces. If Bluetooth tethering is not supported by the
3030 * device, this list should be empty.
3031 *
3032 * @return an array of 0 or more regular expression Strings defining
3033 * what interfaces are considered tetherable bluetooth interfaces.
3034 *
3035 * @deprecated Use {@link TetheringEventCallback#onTetherableInterfaceRegexpsChanged(
3036 *TetheringManager.TetheringInterfaceRegexps)} instead.
3037 * {@hide}
3038 */
3039 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
3040 @UnsupportedAppUsage
3041 @Deprecated
3042 public String[] getTetherableBluetoothRegexs() {
Remi NGUYEN VANe4d1cd92021-06-17 16:27:31 +09003043 return getTetheringManager().getTetherableBluetoothRegexs();
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003044 }
3045
3046 /**
3047 * Attempt to both alter the mode of USB and Tethering of USB. A
3048 * utility method to deal with some of the complexity of USB - will
3049 * attempt to switch to Rndis and subsequently tether the resulting
3050 * interface on {@code true} or turn off tethering and switch off
3051 * Rndis on {@code false}.
3052 *
3053 * <p>This method requires the caller to hold either the
3054 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
3055 * or the ability to modify system settings as determined by
3056 * {@link android.provider.Settings.System#canWrite}.</p>
3057 *
3058 * @param enable a boolean - {@code true} to enable tethering
3059 * @return error a {@code TETHER_ERROR} value indicating success or failure type
3060 * @deprecated Use {@link TetheringManager#startTethering} instead
3061 *
3062 * {@hide}
3063 */
3064 @UnsupportedAppUsage
3065 @Deprecated
3066 public int setUsbTethering(boolean enable) {
Remi NGUYEN VANe4d1cd92021-06-17 16:27:31 +09003067 return getTetheringManager().setUsbTethering(enable);
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003068 }
3069
3070 /**
3071 * @deprecated Use {@link TetheringManager#TETHER_ERROR_NO_ERROR}.
3072 * {@hide}
3073 */
3074 @SystemApi
3075 @Deprecated
Remi NGUYEN VAN71ced8e2021-02-15 18:52:06 +09003076 public static final int TETHER_ERROR_NO_ERROR = 0;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003077 /**
3078 * @deprecated Use {@link TetheringManager#TETHER_ERROR_UNKNOWN_IFACE}.
3079 * {@hide}
3080 */
3081 @Deprecated
3082 public static final int TETHER_ERROR_UNKNOWN_IFACE =
3083 TetheringManager.TETHER_ERROR_UNKNOWN_IFACE;
3084 /**
3085 * @deprecated Use {@link TetheringManager#TETHER_ERROR_SERVICE_UNAVAIL}.
3086 * {@hide}
3087 */
3088 @Deprecated
3089 public static final int TETHER_ERROR_SERVICE_UNAVAIL =
3090 TetheringManager.TETHER_ERROR_SERVICE_UNAVAIL;
3091 /**
3092 * @deprecated Use {@link TetheringManager#TETHER_ERROR_UNSUPPORTED}.
3093 * {@hide}
3094 */
3095 @Deprecated
3096 public static final int TETHER_ERROR_UNSUPPORTED = TetheringManager.TETHER_ERROR_UNSUPPORTED;
3097 /**
3098 * @deprecated Use {@link TetheringManager#TETHER_ERROR_UNAVAIL_IFACE}.
3099 * {@hide}
3100 */
3101 @Deprecated
3102 public static final int TETHER_ERROR_UNAVAIL_IFACE =
3103 TetheringManager.TETHER_ERROR_UNAVAIL_IFACE;
3104 /**
3105 * @deprecated Use {@link TetheringManager#TETHER_ERROR_INTERNAL_ERROR}.
3106 * {@hide}
3107 */
3108 @Deprecated
3109 public static final int TETHER_ERROR_MASTER_ERROR =
3110 TetheringManager.TETHER_ERROR_INTERNAL_ERROR;
3111 /**
3112 * @deprecated Use {@link TetheringManager#TETHER_ERROR_TETHER_IFACE_ERROR}.
3113 * {@hide}
3114 */
3115 @Deprecated
3116 public static final int TETHER_ERROR_TETHER_IFACE_ERROR =
3117 TetheringManager.TETHER_ERROR_TETHER_IFACE_ERROR;
3118 /**
3119 * @deprecated Use {@link TetheringManager#TETHER_ERROR_UNTETHER_IFACE_ERROR}.
3120 * {@hide}
3121 */
3122 @Deprecated
3123 public static final int TETHER_ERROR_UNTETHER_IFACE_ERROR =
3124 TetheringManager.TETHER_ERROR_UNTETHER_IFACE_ERROR;
3125 /**
3126 * @deprecated Use {@link TetheringManager#TETHER_ERROR_ENABLE_FORWARDING_ERROR}.
3127 * {@hide}
3128 */
3129 @Deprecated
3130 public static final int TETHER_ERROR_ENABLE_NAT_ERROR =
3131 TetheringManager.TETHER_ERROR_ENABLE_FORWARDING_ERROR;
3132 /**
3133 * @deprecated Use {@link TetheringManager#TETHER_ERROR_DISABLE_FORWARDING_ERROR}.
3134 * {@hide}
3135 */
3136 @Deprecated
3137 public static final int TETHER_ERROR_DISABLE_NAT_ERROR =
3138 TetheringManager.TETHER_ERROR_DISABLE_FORWARDING_ERROR;
3139 /**
3140 * @deprecated Use {@link TetheringManager#TETHER_ERROR_IFACE_CFG_ERROR}.
3141 * {@hide}
3142 */
3143 @Deprecated
3144 public static final int TETHER_ERROR_IFACE_CFG_ERROR =
3145 TetheringManager.TETHER_ERROR_IFACE_CFG_ERROR;
3146 /**
3147 * @deprecated Use {@link TetheringManager#TETHER_ERROR_PROVISIONING_FAILED}.
3148 * {@hide}
3149 */
3150 @SystemApi
3151 @Deprecated
Remi NGUYEN VAN71ced8e2021-02-15 18:52:06 +09003152 public static final int TETHER_ERROR_PROVISION_FAILED = 11;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003153 /**
3154 * @deprecated Use {@link TetheringManager#TETHER_ERROR_DHCPSERVER_ERROR}.
3155 * {@hide}
3156 */
3157 @Deprecated
3158 public static final int TETHER_ERROR_DHCPSERVER_ERROR =
3159 TetheringManager.TETHER_ERROR_DHCPSERVER_ERROR;
3160 /**
3161 * @deprecated Use {@link TetheringManager#TETHER_ERROR_ENTITLEMENT_UNKNOWN}.
3162 * {@hide}
3163 */
3164 @SystemApi
3165 @Deprecated
Remi NGUYEN VAN71ced8e2021-02-15 18:52:06 +09003166 public static final int TETHER_ERROR_ENTITLEMENT_UNKONWN = 13;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003167
3168 /**
3169 * Get a more detailed error code after a Tethering or Untethering
3170 * request asynchronously failed.
3171 *
3172 * @param iface The name of the interface of interest
3173 * @return error The error code of the last error tethering or untethering the named
3174 * interface
3175 *
3176 * @deprecated Use {@link TetheringEventCallback#onError(String, int)} instead.
3177 * {@hide}
3178 */
3179 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
3180 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
3181 @Deprecated
3182 public int getLastTetherError(String iface) {
Remi NGUYEN VANe4d1cd92021-06-17 16:27:31 +09003183 int error = getTetheringManager().getLastTetherError(iface);
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003184 if (error == TetheringManager.TETHER_ERROR_UNKNOWN_TYPE) {
3185 // TETHER_ERROR_UNKNOWN_TYPE was introduced with TetheringManager and has never been
3186 // returned by ConnectivityManager. Convert it to the legacy TETHER_ERROR_UNKNOWN_IFACE
3187 // instead.
3188 error = TetheringManager.TETHER_ERROR_UNKNOWN_IFACE;
3189 }
3190 return error;
3191 }
3192
3193 /** @hide */
3194 @Retention(RetentionPolicy.SOURCE)
3195 @IntDef(value = {
3196 TETHER_ERROR_NO_ERROR,
3197 TETHER_ERROR_PROVISION_FAILED,
3198 TETHER_ERROR_ENTITLEMENT_UNKONWN,
3199 })
3200 public @interface EntitlementResultCode {
3201 }
3202
3203 /**
3204 * Callback for use with {@link #getLatestTetheringEntitlementResult} to find out whether
3205 * entitlement succeeded.
3206 *
3207 * @deprecated Use {@link TetheringManager#OnTetheringEntitlementResultListener} instead.
3208 * @hide
3209 */
3210 @SystemApi
3211 @Deprecated
3212 public interface OnTetheringEntitlementResultListener {
3213 /**
3214 * Called to notify entitlement result.
3215 *
3216 * @param resultCode an int value of entitlement result. It may be one of
3217 * {@link #TETHER_ERROR_NO_ERROR},
3218 * {@link #TETHER_ERROR_PROVISION_FAILED}, or
3219 * {@link #TETHER_ERROR_ENTITLEMENT_UNKONWN}.
3220 */
3221 void onTetheringEntitlementResult(@EntitlementResultCode int resultCode);
3222 }
3223
3224 /**
3225 * Get the last value of the entitlement check on this downstream. If the cached value is
3226 * {@link #TETHER_ERROR_NO_ERROR} or showEntitlementUi argument is false, it just return the
3227 * cached value. Otherwise, a UI-based entitlement check would be performed. It is not
3228 * guaranteed that the UI-based entitlement check will complete in any specific time period
3229 * and may in fact never complete. Any successful entitlement check the platform performs for
3230 * any reason will update the cached value.
3231 *
3232 * @param type the downstream type of tethering. Must be one of
3233 * {@link #TETHERING_WIFI},
3234 * {@link #TETHERING_USB}, or
3235 * {@link #TETHERING_BLUETOOTH}.
3236 * @param showEntitlementUi a boolean indicating whether to run UI-based entitlement check.
3237 * @param executor the executor on which callback will be invoked.
3238 * @param listener an {@link OnTetheringEntitlementResultListener} which will be called to
3239 * notify the caller of the result of entitlement check. The listener may be called zero
3240 * or one time.
3241 * @deprecated Use {@link TetheringManager#requestLatestTetheringEntitlementResult} instead.
3242 * {@hide}
3243 */
3244 @SystemApi
3245 @Deprecated
3246 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
3247 public void getLatestTetheringEntitlementResult(int type, boolean showEntitlementUi,
3248 @NonNull @CallbackExecutor Executor executor,
3249 @NonNull final OnTetheringEntitlementResultListener listener) {
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00003250 Objects.requireNonNull(listener, "TetheringEntitlementResultListener cannot be null.");
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003251 ResultReceiver wrappedListener = new ResultReceiver(null) {
3252 @Override
3253 protected void onReceiveResult(int resultCode, Bundle resultData) {
lucaslineaff72d2021-03-04 09:38:21 +08003254 final long token = Binder.clearCallingIdentity();
3255 try {
3256 executor.execute(() -> {
3257 listener.onTetheringEntitlementResult(resultCode);
3258 });
3259 } finally {
3260 Binder.restoreCallingIdentity(token);
3261 }
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003262 }
3263 };
3264
Remi NGUYEN VANe4d1cd92021-06-17 16:27:31 +09003265 getTetheringManager().requestLatestTetheringEntitlementResult(type, wrappedListener,
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003266 showEntitlementUi);
3267 }
3268
3269 /**
3270 * Report network connectivity status. This is currently used only
3271 * to alter status bar UI.
3272 * <p>This method requires the caller to hold the permission
3273 * {@link android.Manifest.permission#STATUS_BAR}.
3274 *
3275 * @param networkType The type of network you want to report on
3276 * @param percentage The quality of the connection 0 is bad, 100 is good
3277 * @deprecated Types are deprecated. Use {@link #reportNetworkConnectivity} instead.
3278 * {@hide}
3279 */
3280 public void reportInetCondition(int networkType, int percentage) {
3281 printStackTrace();
3282 try {
3283 mService.reportInetCondition(networkType, percentage);
3284 } catch (RemoteException e) {
3285 throw e.rethrowFromSystemServer();
3286 }
3287 }
3288
3289 /**
3290 * Report a problem network to the framework. This provides a hint to the system
3291 * that there might be connectivity problems on this network and may cause
3292 * the framework to re-evaluate network connectivity and/or switch to another
3293 * network.
3294 *
3295 * @param network The {@link Network} the application was attempting to use
3296 * or {@code null} to indicate the current default network.
3297 * @deprecated Use {@link #reportNetworkConnectivity} which allows reporting both
3298 * working and non-working connectivity.
3299 */
3300 @Deprecated
3301 public void reportBadNetwork(@Nullable Network network) {
3302 printStackTrace();
3303 try {
3304 // One of these will be ignored because it matches system's current state.
3305 // The other will trigger the necessary reevaluation.
3306 mService.reportNetworkConnectivity(network, true);
3307 mService.reportNetworkConnectivity(network, false);
3308 } catch (RemoteException e) {
3309 throw e.rethrowFromSystemServer();
3310 }
3311 }
3312
3313 /**
3314 * Report to the framework whether a network has working connectivity.
3315 * This provides a hint to the system that a particular network is providing
3316 * working connectivity or not. In response the framework may re-evaluate
3317 * the network's connectivity and might take further action thereafter.
3318 *
3319 * @param network The {@link Network} the application was attempting to use
3320 * or {@code null} to indicate the current default network.
3321 * @param hasConnectivity {@code true} if the application was able to successfully access the
3322 * Internet using {@code network} or {@code false} if not.
3323 */
3324 public void reportNetworkConnectivity(@Nullable Network network, boolean hasConnectivity) {
3325 printStackTrace();
3326 try {
3327 mService.reportNetworkConnectivity(network, hasConnectivity);
3328 } catch (RemoteException e) {
3329 throw e.rethrowFromSystemServer();
3330 }
3331 }
3332
3333 /**
Chalard Jeane1ce6ae2021-03-17 17:03:34 +09003334 * Set a network-independent global HTTP proxy.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003335 *
Chalard Jeane1ce6ae2021-03-17 17:03:34 +09003336 * This sets an HTTP proxy that applies to all networks and overrides any network-specific
3337 * proxy. If set, HTTP libraries that are proxy-aware will use this global proxy when
3338 * accessing any network, regardless of what the settings for that network are.
3339 *
3340 * Note that HTTP proxies are by nature typically network-dependent, and setting a global
3341 * proxy is likely to break networking on multiple networks. This method is only meant
3342 * for device policy clients looking to do general internal filtering or similar use cases.
3343 *
3344 * {@see #getGlobalProxy}
3345 * {@see LinkProperties#getHttpProxy}
3346 *
3347 * @param p A {@link ProxyInfo} object defining the new global HTTP proxy. Calling this
3348 * method with a {@code null} value will clear the global HTTP proxy.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003349 * @hide
3350 */
Chalard Jeane1ce6ae2021-03-17 17:03:34 +09003351 // Used by Device Policy Manager to set the global proxy.
Chiachang Wangf9294e72021-03-18 09:44:34 +08003352 @SystemApi(client = MODULE_LIBRARIES)
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003353 @RequiresPermission(android.Manifest.permission.NETWORK_STACK)
Chalard Jeane1ce6ae2021-03-17 17:03:34 +09003354 public void setGlobalProxy(@Nullable final ProxyInfo p) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003355 try {
3356 mService.setGlobalProxy(p);
3357 } catch (RemoteException e) {
3358 throw e.rethrowFromSystemServer();
3359 }
3360 }
3361
3362 /**
3363 * Retrieve any network-independent global HTTP proxy.
3364 *
3365 * @return {@link ProxyInfo} for the current global HTTP proxy or {@code null}
3366 * if no global HTTP proxy is set.
3367 * @hide
3368 */
Chiachang Wangf9294e72021-03-18 09:44:34 +08003369 @SystemApi(client = MODULE_LIBRARIES)
3370 @Nullable
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003371 public ProxyInfo getGlobalProxy() {
3372 try {
3373 return mService.getGlobalProxy();
3374 } catch (RemoteException e) {
3375 throw e.rethrowFromSystemServer();
3376 }
3377 }
3378
3379 /**
3380 * Retrieve the global HTTP proxy, or if no global HTTP proxy is set, a
3381 * network-specific HTTP proxy. If {@code network} is null, the
3382 * network-specific proxy returned is the proxy of the default active
3383 * network.
3384 *
3385 * @return {@link ProxyInfo} for the current global HTTP proxy, or if no
3386 * global HTTP proxy is set, {@code ProxyInfo} for {@code network},
3387 * or when {@code network} is {@code null},
3388 * the {@code ProxyInfo} for the default active network. Returns
3389 * {@code null} when no proxy applies or the caller doesn't have
3390 * permission to use {@code network}.
3391 * @hide
3392 */
3393 public ProxyInfo getProxyForNetwork(Network network) {
3394 try {
3395 return mService.getProxyForNetwork(network);
3396 } catch (RemoteException e) {
3397 throw e.rethrowFromSystemServer();
3398 }
3399 }
3400
3401 /**
3402 * Get the current default HTTP proxy settings. If a global proxy is set it will be returned,
3403 * otherwise if this process is bound to a {@link Network} using
3404 * {@link #bindProcessToNetwork} then that {@code Network}'s proxy is returned, otherwise
3405 * the default network's proxy is returned.
3406 *
3407 * @return the {@link ProxyInfo} for the current HTTP proxy, or {@code null} if no
3408 * HTTP proxy is active.
3409 */
3410 @Nullable
3411 public ProxyInfo getDefaultProxy() {
3412 return getProxyForNetwork(getBoundNetworkForProcess());
3413 }
3414
3415 /**
3416 * Returns true if the hardware supports the given network type
3417 * else it returns false. This doesn't indicate we have coverage
3418 * or are authorized onto a network, just whether or not the
3419 * hardware supports it. For example a GSM phone without a SIM
3420 * should still return {@code true} for mobile data, but a wifi only
3421 * tablet would return {@code false}.
3422 *
3423 * @param networkType The network type we'd like to check
3424 * @return {@code true} if supported, else {@code false}
3425 * @deprecated Types are deprecated. Use {@link NetworkCapabilities} instead.
3426 * @hide
3427 */
3428 @Deprecated
3429 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
3430 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 130143562)
3431 public boolean isNetworkSupported(int networkType) {
3432 try {
3433 return mService.isNetworkSupported(networkType);
3434 } catch (RemoteException e) {
3435 throw e.rethrowFromSystemServer();
3436 }
3437 }
3438
3439 /**
3440 * Returns if the currently active data network is metered. A network is
3441 * classified as metered when the user is sensitive to heavy data usage on
3442 * that connection due to monetary costs, data limitations or
3443 * battery/performance issues. You should check this before doing large
3444 * data transfers, and warn the user or delay the operation until another
3445 * network is available.
3446 *
3447 * @return {@code true} if large transfers should be avoided, otherwise
3448 * {@code false}.
3449 */
3450 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
3451 public boolean isActiveNetworkMetered() {
3452 try {
3453 return mService.isActiveNetworkMetered();
3454 } catch (RemoteException e) {
3455 throw e.rethrowFromSystemServer();
3456 }
3457 }
3458
3459 /**
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003460 * Set sign in error notification to visible or invisible
3461 *
3462 * @hide
3463 * @deprecated Doesn't properly deal with multiple connected networks of the same type.
3464 */
3465 @Deprecated
3466 public void setProvisioningNotificationVisible(boolean visible, int networkType,
3467 String action) {
3468 try {
3469 mService.setProvisioningNotificationVisible(visible, networkType, action);
3470 } catch (RemoteException e) {
3471 throw e.rethrowFromSystemServer();
3472 }
3473 }
3474
3475 /**
3476 * Set the value for enabling/disabling airplane mode
3477 *
3478 * @param enable whether to enable airplane mode or not
3479 *
3480 * @hide
3481 */
3482 @RequiresPermission(anyOf = {
3483 android.Manifest.permission.NETWORK_AIRPLANE_MODE,
3484 android.Manifest.permission.NETWORK_SETTINGS,
3485 android.Manifest.permission.NETWORK_SETUP_WIZARD,
3486 android.Manifest.permission.NETWORK_STACK})
3487 @SystemApi
3488 public void setAirplaneMode(boolean enable) {
3489 try {
3490 mService.setAirplaneMode(enable);
3491 } catch (RemoteException e) {
3492 throw e.rethrowFromSystemServer();
3493 }
3494 }
3495
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003496 /**
3497 * Registers the specified {@link NetworkProvider}.
3498 * Each listener must only be registered once. The listener can be unregistered with
3499 * {@link #unregisterNetworkProvider}.
3500 *
3501 * @param provider the provider to register
3502 * @return the ID of the provider. This ID must be used by the provider when registering
3503 * {@link android.net.NetworkAgent}s.
3504 * @hide
3505 */
3506 @SystemApi
3507 @RequiresPermission(anyOf = {
3508 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
3509 android.Manifest.permission.NETWORK_FACTORY})
3510 public int registerNetworkProvider(@NonNull NetworkProvider provider) {
3511 if (provider.getProviderId() != NetworkProvider.ID_NONE) {
3512 throw new IllegalStateException("NetworkProviders can only be registered once");
3513 }
3514
3515 try {
3516 int providerId = mService.registerNetworkProvider(provider.getMessenger(),
3517 provider.getName());
3518 provider.setProviderId(providerId);
3519 } catch (RemoteException e) {
3520 throw e.rethrowFromSystemServer();
3521 }
3522 return provider.getProviderId();
3523 }
3524
3525 /**
3526 * Unregisters the specified NetworkProvider.
3527 *
3528 * @param provider the provider to unregister
3529 * @hide
3530 */
3531 @SystemApi
3532 @RequiresPermission(anyOf = {
3533 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
3534 android.Manifest.permission.NETWORK_FACTORY})
3535 public void unregisterNetworkProvider(@NonNull NetworkProvider provider) {
3536 try {
3537 mService.unregisterNetworkProvider(provider.getMessenger());
3538 } catch (RemoteException e) {
3539 throw e.rethrowFromSystemServer();
3540 }
3541 provider.setProviderId(NetworkProvider.ID_NONE);
3542 }
3543
Chalard Jeand1b498b2021-01-05 08:40:09 +09003544 /**
3545 * Register or update a network offer with ConnectivityService.
3546 *
3547 * ConnectivityService keeps track of offers made by the various providers and matches
Chalard Jean61e231f2021-03-24 17:43:10 +09003548 * them to networking requests made by apps or the system. A callback identifies an offer
3549 * uniquely, and later calls with the same callback update the offer. The provider supplies a
3550 * score and the capabilities of the network it might be able to bring up ; these act as
3551 * filters used by ConnectivityService to only send those requests that can be fulfilled by the
Chalard Jeand1b498b2021-01-05 08:40:09 +09003552 * provider.
3553 *
3554 * The provider is under no obligation to be able to bring up the network it offers at any
3555 * given time. Instead, this mechanism is meant to limit requests received by providers
3556 * to those they actually have a chance to fulfill, as providers don't have a way to compare
3557 * the quality of the network satisfying a given request to their own offer.
3558 *
3559 * An offer can be updated by calling this again with the same callback object. This is
3560 * similar to calling unofferNetwork and offerNetwork again, but will only update the
3561 * provider with the changes caused by the changes in the offer.
3562 *
3563 * @param provider The provider making this offer.
3564 * @param score The prospective score of the network.
3565 * @param caps The prospective capabilities of the network.
3566 * @param callback The callback to call when this offer is needed or unneeded.
Chalard Jean428b9132021-01-12 10:58:56 +09003567 * @hide exposed via the NetworkProvider class.
Chalard Jeand1b498b2021-01-05 08:40:09 +09003568 */
3569 @RequiresPermission(anyOf = {
3570 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
3571 android.Manifest.permission.NETWORK_FACTORY})
Chalard Jean148dcce2021-03-22 22:44:02 +09003572 public void offerNetwork(@NonNull final int providerId,
Chalard Jeand1b498b2021-01-05 08:40:09 +09003573 @NonNull final NetworkScore score, @NonNull final NetworkCapabilities caps,
3574 @NonNull final INetworkOfferCallback callback) {
3575 try {
Chalard Jean148dcce2021-03-22 22:44:02 +09003576 mService.offerNetwork(providerId,
Chalard Jeand1b498b2021-01-05 08:40:09 +09003577 Objects.requireNonNull(score, "null score"),
3578 Objects.requireNonNull(caps, "null caps"),
3579 Objects.requireNonNull(callback, "null callback"));
3580 } catch (RemoteException e) {
3581 throw e.rethrowFromSystemServer();
3582 }
3583 }
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003584
Chalard Jeand1b498b2021-01-05 08:40:09 +09003585 /**
3586 * Withdraw a network offer made with {@link #offerNetwork}.
3587 *
3588 * @param callback The callback passed at registration time. This must be the same object
3589 * that was passed to {@link #offerNetwork}
Chalard Jean428b9132021-01-12 10:58:56 +09003590 * @hide exposed via the NetworkProvider class.
Chalard Jeand1b498b2021-01-05 08:40:09 +09003591 */
3592 public void unofferNetwork(@NonNull final INetworkOfferCallback callback) {
3593 try {
3594 mService.unofferNetwork(Objects.requireNonNull(callback));
3595 } catch (RemoteException e) {
3596 throw e.rethrowFromSystemServer();
3597 }
3598 }
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003599 /** @hide exposed via the NetworkProvider class. */
3600 @RequiresPermission(anyOf = {
3601 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
3602 android.Manifest.permission.NETWORK_FACTORY})
3603 public void declareNetworkRequestUnfulfillable(@NonNull NetworkRequest request) {
3604 try {
3605 mService.declareNetworkRequestUnfulfillable(request);
3606 } catch (RemoteException e) {
3607 throw e.rethrowFromSystemServer();
3608 }
3609 }
3610
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003611 /**
3612 * @hide
3613 * Register a NetworkAgent with ConnectivityService.
3614 * @return Network corresponding to NetworkAgent.
3615 */
3616 @RequiresPermission(anyOf = {
3617 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
3618 android.Manifest.permission.NETWORK_FACTORY})
3619 public Network registerNetworkAgent(INetworkAgent na, NetworkInfo ni, LinkProperties lp,
Chalard Jeand6372722020-12-21 18:36:52 +09003620 NetworkCapabilities nc, @NonNull NetworkScore score, NetworkAgentConfig config,
3621 int providerId) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003622 try {
3623 return mService.registerNetworkAgent(na, ni, lp, nc, score, config, providerId);
3624 } catch (RemoteException e) {
3625 throw e.rethrowFromSystemServer();
3626 }
3627 }
3628
3629 /**
3630 * Base class for {@code NetworkRequest} callbacks. Used for notifications about network
3631 * changes. Should be extended by applications wanting notifications.
3632 *
3633 * A {@code NetworkCallback} is registered by calling
3634 * {@link #requestNetwork(NetworkRequest, NetworkCallback)},
3635 * {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)},
3636 * or {@link #registerDefaultNetworkCallback(NetworkCallback)}. A {@code NetworkCallback} is
3637 * unregistered by calling {@link #unregisterNetworkCallback(NetworkCallback)}.
3638 * A {@code NetworkCallback} should be registered at most once at any time.
3639 * A {@code NetworkCallback} that has been unregistered can be registered again.
3640 */
3641 public static class NetworkCallback {
3642 /**
Roshan Piuse08bc182020-12-22 15:10:42 -08003643 * No flags associated with this callback.
3644 * @hide
3645 */
3646 public static final int FLAG_NONE = 0;
lucaslinc582d502022-01-27 09:07:00 +08003647
Roshan Piuse08bc182020-12-22 15:10:42 -08003648 /**
lucaslinc582d502022-01-27 09:07:00 +08003649 * Inclusion of this flag means location-sensitive redaction requests keeping location info.
3650 *
3651 * Some objects like {@link NetworkCapabilities} may contain location-sensitive information.
3652 * Prior to Android 12, this information is always returned to apps holding the appropriate
3653 * permission, possibly noting that the app has used location.
3654 * <p>In Android 12 and above, by default the sent objects do not contain any location
3655 * information, even if the app holds the necessary permissions, and the system does not
3656 * take note of location usage by the app. Apps can request that location information is
3657 * included, in which case the system will check location permission and the location
3658 * toggle state, and take note of location usage by the app if any such information is
3659 * returned.
3660 *
Roshan Piuse08bc182020-12-22 15:10:42 -08003661 * Use this flag to include any location sensitive data in {@link NetworkCapabilities} sent
3662 * via {@link #onCapabilitiesChanged(Network, NetworkCapabilities)}.
3663 * <p>
3664 * These include:
3665 * <li> Some transport info instances (retrieved via
3666 * {@link NetworkCapabilities#getTransportInfo()}) like {@link android.net.wifi.WifiInfo}
3667 * contain location sensitive information.
3668 * <li> OwnerUid (retrieved via {@link NetworkCapabilities#getOwnerUid()} is location
Anton Hanssondf401092021-10-20 11:27:13 +01003669 * sensitive for wifi suggestor apps (i.e using
3670 * {@link android.net.wifi.WifiNetworkSuggestion WifiNetworkSuggestion}).</li>
Roshan Piuse08bc182020-12-22 15:10:42 -08003671 * </p>
3672 * <p>
3673 * Note:
3674 * <li> Retrieving this location sensitive information (subject to app's location
3675 * permissions) will be noted by system. </li>
3676 * <li> Without this flag any {@link NetworkCapabilities} provided via the callback does
lucaslinc582d502022-01-27 09:07:00 +08003677 * not include location sensitive information.
Roshan Piuse08bc182020-12-22 15:10:42 -08003678 */
Roshan Pius189d0092021-03-11 21:16:44 -08003679 // Note: Some existing fields which are location sensitive may still be included without
3680 // this flag if the app targets SDK < S (to maintain backwards compatibility).
Roshan Piuse08bc182020-12-22 15:10:42 -08003681 public static final int FLAG_INCLUDE_LOCATION_INFO = 1 << 0;
3682
3683 /** @hide */
3684 @Retention(RetentionPolicy.SOURCE)
3685 @IntDef(flag = true, prefix = "FLAG_", value = {
3686 FLAG_NONE,
3687 FLAG_INCLUDE_LOCATION_INFO
3688 })
3689 public @interface Flag { }
3690
3691 /**
3692 * All the valid flags for error checking.
3693 */
3694 private static final int VALID_FLAGS = FLAG_INCLUDE_LOCATION_INFO;
3695
3696 public NetworkCallback() {
3697 this(FLAG_NONE);
3698 }
3699
3700 public NetworkCallback(@Flag int flags) {
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00003701 if ((flags & VALID_FLAGS) != flags) {
3702 throw new IllegalArgumentException("Invalid flags");
3703 }
Roshan Piuse08bc182020-12-22 15:10:42 -08003704 mFlags = flags;
3705 }
3706
3707 /**
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003708 * Called when the framework connects to a new network to evaluate whether it satisfies this
3709 * request. If evaluation succeeds, this callback may be followed by an {@link #onAvailable}
3710 * callback. There is no guarantee that this new network will satisfy any requests, or that
3711 * the network will stay connected for longer than the time necessary to evaluate it.
3712 * <p>
3713 * Most applications <b>should not</b> act on this callback, and should instead use
3714 * {@link #onAvailable}. This callback is intended for use by applications that can assist
3715 * the framework in properly evaluating the network &mdash; for example, an application that
3716 * can automatically log in to a captive portal without user intervention.
3717 *
3718 * @param network The {@link Network} of the network that is being evaluated.
3719 *
3720 * @hide
3721 */
3722 public void onPreCheck(@NonNull Network network) {}
3723
3724 /**
3725 * Called when the framework connects and has declared a new network ready for use.
3726 * This callback may be called more than once if the {@link Network} that is
3727 * satisfying the request changes.
3728 *
3729 * @param network The {@link Network} of the satisfying network.
3730 * @param networkCapabilities The {@link NetworkCapabilities} of the satisfying network.
3731 * @param linkProperties The {@link LinkProperties} of the satisfying network.
3732 * @param blocked Whether access to the {@link Network} is blocked due to system policy.
3733 * @hide
3734 */
Lorenzo Colitti8ad58122021-03-18 00:54:57 +09003735 public final void onAvailable(@NonNull Network network,
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003736 @NonNull NetworkCapabilities networkCapabilities,
Lorenzo Colitti8ad58122021-03-18 00:54:57 +09003737 @NonNull LinkProperties linkProperties, @BlockedReason int blocked) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003738 // Internally only this method is called when a new network is available, and
3739 // it calls the callback in the same way and order that older versions used
3740 // to call so as not to change the behavior.
Lorenzo Colitti8ad58122021-03-18 00:54:57 +09003741 onAvailable(network, networkCapabilities, linkProperties, blocked != 0);
3742 onBlockedStatusChanged(network, blocked);
3743 }
3744
3745 /**
3746 * Legacy variant of onAvailable that takes a boolean blocked reason.
3747 *
3748 * This method has never been public API, but it's not final, so there may be apps that
3749 * implemented it and rely on it being called. Do our best not to break them.
3750 * Note: such apps will also get a second call to onBlockedStatusChanged immediately after
3751 * this method is called. There does not seem to be a way to avoid this.
3752 * TODO: add a compat check to move apps off this method, and eventually stop calling it.
3753 *
3754 * @hide
3755 */
3756 public void onAvailable(@NonNull Network network,
3757 @NonNull NetworkCapabilities networkCapabilities,
3758 @NonNull LinkProperties linkProperties, boolean blocked) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003759 onAvailable(network);
3760 if (!networkCapabilities.hasCapability(
3761 NetworkCapabilities.NET_CAPABILITY_NOT_SUSPENDED)) {
3762 onNetworkSuspended(network);
3763 }
3764 onCapabilitiesChanged(network, networkCapabilities);
3765 onLinkPropertiesChanged(network, linkProperties);
Lorenzo Colitti8ad58122021-03-18 00:54:57 +09003766 // No call to onBlockedStatusChanged here. That is done by the caller.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003767 }
3768
3769 /**
3770 * Called when the framework connects and has declared a new network ready for use.
3771 *
3772 * <p>For callbacks registered with {@link #registerNetworkCallback}, multiple networks may
3773 * be available at the same time, and onAvailable will be called for each of these as they
3774 * appear.
3775 *
3776 * <p>For callbacks registered with {@link #requestNetwork} and
3777 * {@link #registerDefaultNetworkCallback}, this means the network passed as an argument
3778 * is the new best network for this request and is now tracked by this callback ; this
3779 * callback will no longer receive method calls about other networks that may have been
3780 * passed to this method previously. The previously-best network may have disconnected, or
3781 * it may still be around and the newly-best network may simply be better.
3782 *
3783 * <p>Starting with {@link android.os.Build.VERSION_CODES#O}, this will always immediately
3784 * be followed by a call to {@link #onCapabilitiesChanged(Network, NetworkCapabilities)}
3785 * then by a call to {@link #onLinkPropertiesChanged(Network, LinkProperties)}, and a call
3786 * to {@link #onBlockedStatusChanged(Network, boolean)}.
3787 *
3788 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
3789 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
3790 * this callback as this is prone to race conditions (there is no guarantee the objects
3791 * returned by these methods will be current). Instead, wait for a call to
3792 * {@link #onCapabilitiesChanged(Network, NetworkCapabilities)} and
3793 * {@link #onLinkPropertiesChanged(Network, LinkProperties)} whose arguments are guaranteed
3794 * to be well-ordered with respect to other callbacks.
3795 *
3796 * @param network The {@link Network} of the satisfying network.
3797 */
3798 public void onAvailable(@NonNull Network network) {}
3799
3800 /**
3801 * Called when the network is about to be lost, typically because there are no outstanding
3802 * requests left for it. This may be paired with a {@link NetworkCallback#onAvailable} call
3803 * with the new replacement network for graceful handover. This method is not guaranteed
3804 * to be called before {@link NetworkCallback#onLost} is called, for example in case a
3805 * network is suddenly disconnected.
3806 *
3807 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
3808 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
3809 * this callback as this is prone to race conditions ; calling these methods while in a
3810 * callback may return an outdated or even a null object.
3811 *
3812 * @param network The {@link Network} that is about to be lost.
3813 * @param maxMsToLive The time in milliseconds the system intends to keep the network
3814 * connected for graceful handover; note that the network may still
3815 * suffer a hard loss at any time.
3816 */
3817 public void onLosing(@NonNull Network network, int maxMsToLive) {}
3818
3819 /**
3820 * Called when a network disconnects or otherwise no longer satisfies this request or
3821 * callback.
3822 *
3823 * <p>If the callback was registered with requestNetwork() or
3824 * registerDefaultNetworkCallback(), it will only be invoked against the last network
3825 * returned by onAvailable() when that network is lost and no other network satisfies
3826 * the criteria of the request.
3827 *
3828 * <p>If the callback was registered with registerNetworkCallback() it will be called for
3829 * each network which no longer satisfies the criteria of the callback.
3830 *
3831 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
3832 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
3833 * this callback as this is prone to race conditions ; calling these methods while in a
3834 * callback may return an outdated or even a null object.
3835 *
3836 * @param network The {@link Network} lost.
3837 */
3838 public void onLost(@NonNull Network network) {}
3839
3840 /**
3841 * Called if no network is found within the timeout time specified in
3842 * {@link #requestNetwork(NetworkRequest, NetworkCallback, int)} call or if the
3843 * requested network request cannot be fulfilled (whether or not a timeout was
3844 * specified). When this callback is invoked the associated
3845 * {@link NetworkRequest} will have already been removed and released, as if
3846 * {@link #unregisterNetworkCallback(NetworkCallback)} had been called.
3847 */
3848 public void onUnavailable() {}
3849
3850 /**
3851 * Called when the network corresponding to this request changes capabilities but still
3852 * satisfies the requested criteria.
3853 *
3854 * <p>Starting with {@link android.os.Build.VERSION_CODES#O} this method is guaranteed
3855 * to be called immediately after {@link #onAvailable}.
3856 *
3857 * <p>Do NOT call {@link #getLinkProperties(Network)} or other synchronous
3858 * ConnectivityManager methods in this callback as this is prone to race conditions :
3859 * calling these methods while in a callback may return an outdated or even a null object.
3860 *
3861 * @param network The {@link Network} whose capabilities have changed.
Roshan Piuse08bc182020-12-22 15:10:42 -08003862 * @param networkCapabilities The new {@link NetworkCapabilities} for this
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003863 * network.
3864 */
3865 public void onCapabilitiesChanged(@NonNull Network network,
3866 @NonNull NetworkCapabilities networkCapabilities) {}
3867
3868 /**
3869 * Called when the network corresponding to this request changes {@link LinkProperties}.
3870 *
3871 * <p>Starting with {@link android.os.Build.VERSION_CODES#O} this method is guaranteed
3872 * to be called immediately after {@link #onAvailable}.
3873 *
3874 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or other synchronous
3875 * ConnectivityManager methods in this callback as this is prone to race conditions :
3876 * calling these methods while in a callback may return an outdated or even a null object.
3877 *
3878 * @param network The {@link Network} whose link properties have changed.
3879 * @param linkProperties The new {@link LinkProperties} for this network.
3880 */
3881 public void onLinkPropertiesChanged(@NonNull Network network,
3882 @NonNull LinkProperties linkProperties) {}
3883
3884 /**
3885 * Called when the network the framework connected to for this request suspends data
3886 * transmission temporarily.
3887 *
3888 * <p>This generally means that while the TCP connections are still live temporarily
3889 * network data fails to transfer. To give a specific example, this is used on cellular
3890 * networks to mask temporary outages when driving through a tunnel, etc. In general this
3891 * means read operations on sockets on this network will block once the buffers are
3892 * drained, and write operations will block once the buffers are full.
3893 *
3894 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
3895 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
3896 * this callback as this is prone to race conditions (there is no guarantee the objects
3897 * returned by these methods will be current).
3898 *
3899 * @hide
3900 */
3901 public void onNetworkSuspended(@NonNull Network network) {}
3902
3903 /**
3904 * Called when the network the framework connected to for this request
3905 * returns from a {@link NetworkInfo.State#SUSPENDED} state. This should always be
3906 * preceded by a matching {@link NetworkCallback#onNetworkSuspended} call.
3907
3908 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
3909 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
3910 * this callback as this is prone to race conditions : calling these methods while in a
3911 * callback may return an outdated or even a null object.
3912 *
3913 * @hide
3914 */
3915 public void onNetworkResumed(@NonNull Network network) {}
3916
3917 /**
3918 * Called when access to the specified network is blocked or unblocked.
3919 *
3920 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
3921 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
3922 * this callback as this is prone to race conditions : calling these methods while in a
3923 * callback may return an outdated or even a null object.
3924 *
3925 * @param network The {@link Network} whose blocked status has changed.
3926 * @param blocked The blocked status of this {@link Network}.
3927 */
3928 public void onBlockedStatusChanged(@NonNull Network network, boolean blocked) {}
3929
Lorenzo Colitti8ad58122021-03-18 00:54:57 +09003930 /**
Lorenzo Colittia1bd6f62021-03-25 23:17:36 +09003931 * Called when access to the specified network is blocked or unblocked, or the reason for
3932 * access being blocked changes.
Lorenzo Colitti8ad58122021-03-18 00:54:57 +09003933 *
3934 * If a NetworkCallback object implements this method,
3935 * {@link #onBlockedStatusChanged(Network, boolean)} will not be called.
3936 *
3937 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
3938 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
3939 * this callback as this is prone to race conditions : calling these methods while in a
3940 * callback may return an outdated or even a null object.
3941 *
3942 * @param network The {@link Network} whose blocked status has changed.
3943 * @param blocked The blocked status of this {@link Network}.
3944 * @hide
3945 */
3946 @SystemApi(client = MODULE_LIBRARIES)
3947 public void onBlockedStatusChanged(@NonNull Network network, @BlockedReason int blocked) {
3948 onBlockedStatusChanged(network, blocked != 0);
3949 }
3950
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003951 private NetworkRequest networkRequest;
Roshan Piuse08bc182020-12-22 15:10:42 -08003952 private final int mFlags;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003953 }
3954
3955 /**
3956 * Constant error codes used by ConnectivityService to communicate about failures and errors
3957 * across a Binder boundary.
3958 * @hide
3959 */
3960 public interface Errors {
3961 int TOO_MANY_REQUESTS = 1;
3962 }
3963
3964 /** @hide */
3965 public static class TooManyRequestsException extends RuntimeException {}
3966
3967 private static RuntimeException convertServiceException(ServiceSpecificException e) {
3968 switch (e.errorCode) {
3969 case Errors.TOO_MANY_REQUESTS:
3970 return new TooManyRequestsException();
3971 default:
3972 Log.w(TAG, "Unknown service error code " + e.errorCode);
3973 return new RuntimeException(e);
3974 }
3975 }
3976
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003977 /** @hide */
Remi NGUYEN VAN1b9f03a2021-03-12 15:24:06 +09003978 public static final int CALLBACK_PRECHECK = 1;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003979 /** @hide */
Remi NGUYEN VAN1b9f03a2021-03-12 15:24:06 +09003980 public static final int CALLBACK_AVAILABLE = 2;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003981 /** @hide arg1 = TTL */
Remi NGUYEN VAN1b9f03a2021-03-12 15:24:06 +09003982 public static final int CALLBACK_LOSING = 3;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003983 /** @hide */
Remi NGUYEN VAN1b9f03a2021-03-12 15:24:06 +09003984 public static final int CALLBACK_LOST = 4;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003985 /** @hide */
Remi NGUYEN VAN1b9f03a2021-03-12 15:24:06 +09003986 public static final int CALLBACK_UNAVAIL = 5;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003987 /** @hide */
Remi NGUYEN VAN1b9f03a2021-03-12 15:24:06 +09003988 public static final int CALLBACK_CAP_CHANGED = 6;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003989 /** @hide */
Remi NGUYEN VAN1b9f03a2021-03-12 15:24:06 +09003990 public static final int CALLBACK_IP_CHANGED = 7;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003991 /** @hide obj = NetworkCapabilities, arg1 = seq number */
Remi NGUYEN VAN1b9f03a2021-03-12 15:24:06 +09003992 private static final int EXPIRE_LEGACY_REQUEST = 8;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003993 /** @hide */
Remi NGUYEN VAN1b9f03a2021-03-12 15:24:06 +09003994 public static final int CALLBACK_SUSPENDED = 9;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003995 /** @hide */
Remi NGUYEN VAN1b9f03a2021-03-12 15:24:06 +09003996 public static final int CALLBACK_RESUMED = 10;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003997 /** @hide */
Remi NGUYEN VAN1b9f03a2021-03-12 15:24:06 +09003998 public static final int CALLBACK_BLK_CHANGED = 11;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003999
4000 /** @hide */
4001 public static String getCallbackName(int whichCallback) {
4002 switch (whichCallback) {
4003 case CALLBACK_PRECHECK: return "CALLBACK_PRECHECK";
4004 case CALLBACK_AVAILABLE: return "CALLBACK_AVAILABLE";
4005 case CALLBACK_LOSING: return "CALLBACK_LOSING";
4006 case CALLBACK_LOST: return "CALLBACK_LOST";
4007 case CALLBACK_UNAVAIL: return "CALLBACK_UNAVAIL";
4008 case CALLBACK_CAP_CHANGED: return "CALLBACK_CAP_CHANGED";
4009 case CALLBACK_IP_CHANGED: return "CALLBACK_IP_CHANGED";
4010 case EXPIRE_LEGACY_REQUEST: return "EXPIRE_LEGACY_REQUEST";
4011 case CALLBACK_SUSPENDED: return "CALLBACK_SUSPENDED";
4012 case CALLBACK_RESUMED: return "CALLBACK_RESUMED";
4013 case CALLBACK_BLK_CHANGED: return "CALLBACK_BLK_CHANGED";
4014 default:
4015 return Integer.toString(whichCallback);
4016 }
4017 }
4018
4019 private class CallbackHandler extends Handler {
4020 private static final String TAG = "ConnectivityManager.CallbackHandler";
4021 private static final boolean DBG = false;
4022
4023 CallbackHandler(Looper looper) {
4024 super(looper);
4025 }
4026
4027 CallbackHandler(Handler handler) {
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00004028 this(Objects.requireNonNull(handler, "Handler cannot be null.").getLooper());
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004029 }
4030
4031 @Override
4032 public void handleMessage(Message message) {
4033 if (message.what == EXPIRE_LEGACY_REQUEST) {
4034 expireRequest((NetworkCapabilities) message.obj, message.arg1);
4035 return;
4036 }
4037
4038 final NetworkRequest request = getObject(message, NetworkRequest.class);
4039 final Network network = getObject(message, Network.class);
4040 final NetworkCallback callback;
4041 synchronized (sCallbacks) {
4042 callback = sCallbacks.get(request);
4043 if (callback == null) {
4044 Log.w(TAG,
4045 "callback not found for " + getCallbackName(message.what) + " message");
4046 return;
4047 }
4048 if (message.what == CALLBACK_UNAVAIL) {
4049 sCallbacks.remove(request);
4050 callback.networkRequest = ALREADY_UNREGISTERED;
4051 }
4052 }
4053 if (DBG) {
4054 Log.d(TAG, getCallbackName(message.what) + " for network " + network);
4055 }
4056
4057 switch (message.what) {
4058 case CALLBACK_PRECHECK: {
4059 callback.onPreCheck(network);
4060 break;
4061 }
4062 case CALLBACK_AVAILABLE: {
4063 NetworkCapabilities cap = getObject(message, NetworkCapabilities.class);
4064 LinkProperties lp = getObject(message, LinkProperties.class);
Lorenzo Colitti8ad58122021-03-18 00:54:57 +09004065 callback.onAvailable(network, cap, lp, message.arg1);
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004066 break;
4067 }
4068 case CALLBACK_LOSING: {
4069 callback.onLosing(network, message.arg1);
4070 break;
4071 }
4072 case CALLBACK_LOST: {
4073 callback.onLost(network);
4074 break;
4075 }
4076 case CALLBACK_UNAVAIL: {
4077 callback.onUnavailable();
4078 break;
4079 }
4080 case CALLBACK_CAP_CHANGED: {
4081 NetworkCapabilities cap = getObject(message, NetworkCapabilities.class);
4082 callback.onCapabilitiesChanged(network, cap);
4083 break;
4084 }
4085 case CALLBACK_IP_CHANGED: {
4086 LinkProperties lp = getObject(message, LinkProperties.class);
4087 callback.onLinkPropertiesChanged(network, lp);
4088 break;
4089 }
4090 case CALLBACK_SUSPENDED: {
4091 callback.onNetworkSuspended(network);
4092 break;
4093 }
4094 case CALLBACK_RESUMED: {
4095 callback.onNetworkResumed(network);
4096 break;
4097 }
4098 case CALLBACK_BLK_CHANGED: {
Lorenzo Colitti8ad58122021-03-18 00:54:57 +09004099 callback.onBlockedStatusChanged(network, message.arg1);
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004100 }
4101 }
4102 }
4103
4104 private <T> T getObject(Message msg, Class<T> c) {
4105 return (T) msg.getData().getParcelable(c.getSimpleName());
4106 }
4107 }
4108
4109 private CallbackHandler getDefaultHandler() {
4110 synchronized (sCallbacks) {
4111 if (sCallbackHandler == null) {
4112 sCallbackHandler = new CallbackHandler(ConnectivityThread.getInstanceLooper());
4113 }
4114 return sCallbackHandler;
4115 }
4116 }
4117
4118 private static final HashMap<NetworkRequest, NetworkCallback> sCallbacks = new HashMap<>();
4119 private static CallbackHandler sCallbackHandler;
4120
Lorenzo Colitti5f26b192021-03-12 22:48:07 +09004121 private NetworkRequest sendRequestForNetwork(int asUid, NetworkCapabilities need,
4122 NetworkCallback callback, int timeoutMs, NetworkRequest.Type reqType, int legacyType,
4123 CallbackHandler handler) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004124 printStackTrace();
4125 checkCallbackNotNull(callback);
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00004126 if (reqType != TRACK_DEFAULT && reqType != TRACK_SYSTEM_DEFAULT && need == null) {
4127 throw new IllegalArgumentException("null NetworkCapabilities");
4128 }
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004129 final NetworkRequest request;
4130 final String callingPackageName = mContext.getOpPackageName();
4131 try {
4132 synchronized(sCallbacks) {
4133 if (callback.networkRequest != null
4134 && callback.networkRequest != ALREADY_UNREGISTERED) {
4135 // TODO: throw exception instead and enforce 1:1 mapping of callbacks
4136 // and requests (http://b/20701525).
4137 Log.e(TAG, "NetworkCallback was already registered");
4138 }
4139 Messenger messenger = new Messenger(handler);
4140 Binder binder = new Binder();
Roshan Piuse08bc182020-12-22 15:10:42 -08004141 final int callbackFlags = callback.mFlags;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004142 if (reqType == LISTEN) {
4143 request = mService.listenForNetwork(
Roshan Piuse08bc182020-12-22 15:10:42 -08004144 need, messenger, binder, callbackFlags, callingPackageName,
Roshan Piusa8a477b2020-12-17 14:53:09 -08004145 getAttributionTag());
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004146 } else {
4147 request = mService.requestNetwork(
Lorenzo Colitti5f26b192021-03-12 22:48:07 +09004148 asUid, need, reqType.ordinal(), messenger, timeoutMs, binder,
4149 legacyType, callbackFlags, callingPackageName, getAttributionTag());
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004150 }
4151 if (request != null) {
4152 sCallbacks.put(request, callback);
4153 }
4154 callback.networkRequest = request;
4155 }
4156 } catch (RemoteException e) {
4157 throw e.rethrowFromSystemServer();
4158 } catch (ServiceSpecificException e) {
4159 throw convertServiceException(e);
4160 }
4161 return request;
4162 }
4163
Lorenzo Colitti5f26b192021-03-12 22:48:07 +09004164 private NetworkRequest sendRequestForNetwork(NetworkCapabilities need, NetworkCallback callback,
4165 int timeoutMs, NetworkRequest.Type reqType, int legacyType, CallbackHandler handler) {
4166 return sendRequestForNetwork(Process.INVALID_UID, need, callback, timeoutMs, reqType,
4167 legacyType, handler);
4168 }
4169
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004170 /**
4171 * Helper function to request a network with a particular legacy type.
4172 *
4173 * This API is only for use in internal system code that requests networks with legacy type and
4174 * relies on CONNECTIVITY_ACTION broadcasts instead of NetworkCallbacks. New caller should use
4175 * {@link #requestNetwork(NetworkRequest, NetworkCallback, Handler)} instead.
4176 *
4177 * @param request {@link NetworkRequest} describing this request.
4178 * @param timeoutMs The time in milliseconds to attempt looking for a suitable network
4179 * before {@link NetworkCallback#onUnavailable()} is called. The timeout must
4180 * be a positive value (i.e. >0).
4181 * @param legacyType to specify the network type(#TYPE_*).
4182 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
4183 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
4184 * the callback must not be shared - it uniquely specifies this request.
4185 *
4186 * @hide
4187 */
4188 @SystemApi
4189 @RequiresPermission(NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK)
4190 public void requestNetwork(@NonNull NetworkRequest request,
4191 int timeoutMs, int legacyType, @NonNull Handler handler,
4192 @NonNull NetworkCallback networkCallback) {
4193 if (legacyType == TYPE_NONE) {
4194 throw new IllegalArgumentException("TYPE_NONE is meaningless legacy type");
4195 }
4196 CallbackHandler cbHandler = new CallbackHandler(handler);
4197 NetworkCapabilities nc = request.networkCapabilities;
4198 sendRequestForNetwork(nc, networkCallback, timeoutMs, REQUEST, legacyType, cbHandler);
4199 }
4200
4201 /**
Roshan Piuse08bc182020-12-22 15:10:42 -08004202 * Request a network to satisfy a set of {@link NetworkCapabilities}.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004203 *
4204 * <p>This method will attempt to find the best network that matches the passed
4205 * {@link NetworkRequest}, and to bring up one that does if none currently satisfies the
4206 * criteria. The platform will evaluate which network is the best at its own discretion.
4207 * Throughput, latency, cost per byte, policy, user preference and other considerations
4208 * may be factored in the decision of what is considered the best network.
4209 *
4210 * <p>As long as this request is outstanding, the platform will try to maintain the best network
4211 * matching this request, while always attempting to match the request to a better network if
4212 * possible. If a better match is found, the platform will switch this request to the now-best
4213 * network and inform the app of the newly best network by invoking
4214 * {@link NetworkCallback#onAvailable(Network)} on the provided callback. Note that the platform
4215 * will not try to maintain any other network than the best one currently matching the request:
4216 * a network not matching any network request may be disconnected at any time.
4217 *
4218 * <p>For example, an application could use this method to obtain a connected cellular network
4219 * even if the device currently has a data connection over Ethernet. This may cause the cellular
4220 * radio to consume additional power. Or, an application could inform the system that it wants
4221 * a network supporting sending MMSes and have the system let it know about the currently best
4222 * MMS-supporting network through the provided {@link NetworkCallback}.
4223 *
4224 * <p>The status of the request can be followed by listening to the various callbacks described
4225 * in {@link NetworkCallback}. The {@link Network} object passed to the callback methods can be
4226 * used to direct traffic to the network (although accessing some networks may be subject to
4227 * holding specific permissions). Callers will learn about the specific characteristics of the
4228 * network through
4229 * {@link NetworkCallback#onCapabilitiesChanged(Network, NetworkCapabilities)} and
4230 * {@link NetworkCallback#onLinkPropertiesChanged(Network, LinkProperties)}. The methods of the
4231 * provided {@link NetworkCallback} will only be invoked due to changes in the best network
4232 * matching the request at any given time; therefore when a better network matching the request
4233 * becomes available, the {@link NetworkCallback#onAvailable(Network)} method is called
4234 * with the new network after which no further updates are given about the previously-best
4235 * network, unless it becomes the best again at some later time. All callbacks are invoked
4236 * in order on the same thread, which by default is a thread created by the framework running
4237 * in the app.
4238 * {@see #requestNetwork(NetworkRequest, NetworkCallback, Handler)} to change where the
4239 * callbacks are invoked.
4240 *
4241 * <p>This{@link NetworkRequest} will live until released via
4242 * {@link #unregisterNetworkCallback(NetworkCallback)} or the calling application exits, at
4243 * which point the system may let go of the network at any time.
4244 *
4245 * <p>A version of this method which takes a timeout is
4246 * {@link #requestNetwork(NetworkRequest, NetworkCallback, int)}, that an app can use to only
4247 * wait for a limited amount of time for the network to become unavailable.
4248 *
4249 * <p>It is presently unsupported to request a network with mutable
4250 * {@link NetworkCapabilities} such as
4251 * {@link NetworkCapabilities#NET_CAPABILITY_VALIDATED} or
4252 * {@link NetworkCapabilities#NET_CAPABILITY_CAPTIVE_PORTAL}
4253 * as these {@code NetworkCapabilities} represent states that a particular
4254 * network may never attain, and whether a network will attain these states
4255 * is unknown prior to bringing up the network so the framework does not
4256 * know how to go about satisfying a request with these capabilities.
4257 *
4258 * <p>This method requires the caller to hold either the
4259 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
4260 * or the ability to modify system settings as determined by
4261 * {@link android.provider.Settings.System#canWrite}.</p>
4262 *
4263 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4264 * number of outstanding requests to 100 per app (identified by their UID), shared with
4265 * all variants of this method, of {@link #registerNetworkCallback} as well as
4266 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4267 * Requesting a network with this method will count toward this limit. If this limit is
4268 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4269 * make sure to unregister the callbacks with
4270 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4271 *
4272 * @param request {@link NetworkRequest} describing this request.
4273 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
4274 * the callback must not be shared - it uniquely specifies this request.
4275 * The callback is invoked on the default internal Handler.
4276 * @throws IllegalArgumentException if {@code request} contains invalid network capabilities.
4277 * @throws SecurityException if missing the appropriate permissions.
4278 * @throws RuntimeException if the app already has too many callbacks registered.
4279 */
4280 public void requestNetwork(@NonNull NetworkRequest request,
4281 @NonNull NetworkCallback networkCallback) {
4282 requestNetwork(request, networkCallback, getDefaultHandler());
4283 }
4284
4285 /**
Roshan Piuse08bc182020-12-22 15:10:42 -08004286 * Request a network to satisfy a set of {@link NetworkCapabilities}.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004287 *
4288 * This method behaves identically to {@link #requestNetwork(NetworkRequest, NetworkCallback)}
4289 * but runs all the callbacks on the passed Handler.
4290 *
4291 * <p>This method has the same permission requirements as
4292 * {@link #requestNetwork(NetworkRequest, NetworkCallback)}, is subject to the same limitations,
4293 * and throws the same exceptions in the same conditions.
4294 *
4295 * @param request {@link NetworkRequest} describing this request.
4296 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
4297 * the callback must not be shared - it uniquely specifies this request.
4298 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
4299 */
4300 public void requestNetwork(@NonNull NetworkRequest request,
4301 @NonNull NetworkCallback networkCallback, @NonNull Handler handler) {
4302 CallbackHandler cbHandler = new CallbackHandler(handler);
4303 NetworkCapabilities nc = request.networkCapabilities;
4304 sendRequestForNetwork(nc, networkCallback, 0, REQUEST, TYPE_NONE, cbHandler);
4305 }
4306
4307 /**
Roshan Piuse08bc182020-12-22 15:10:42 -08004308 * Request a network to satisfy a set of {@link NetworkCapabilities}, limited
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004309 * by a timeout.
4310 *
4311 * This function behaves identically to the non-timed-out version
4312 * {@link #requestNetwork(NetworkRequest, NetworkCallback)}, but if a suitable network
4313 * is not found within the given time (in milliseconds) the
4314 * {@link NetworkCallback#onUnavailable()} callback is called. The request can still be
4315 * released normally by calling {@link #unregisterNetworkCallback(NetworkCallback)} but does
4316 * not have to be released if timed-out (it is automatically released). Unregistering a
4317 * request that timed out is not an error.
4318 *
4319 * <p>Do not use this method to poll for the existence of specific networks (e.g. with a small
4320 * timeout) - {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)} is provided
4321 * for that purpose. Calling this method will attempt to bring up the requested network.
4322 *
4323 * <p>This method has the same permission requirements as
4324 * {@link #requestNetwork(NetworkRequest, NetworkCallback)}, is subject to the same limitations,
4325 * and throws the same exceptions in the same conditions.
4326 *
4327 * @param request {@link NetworkRequest} describing this request.
4328 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
4329 * the callback must not be shared - it uniquely specifies this request.
4330 * @param timeoutMs The time in milliseconds to attempt looking for a suitable network
4331 * before {@link NetworkCallback#onUnavailable()} is called. The timeout must
4332 * be a positive value (i.e. >0).
4333 */
4334 public void requestNetwork(@NonNull NetworkRequest request,
4335 @NonNull NetworkCallback networkCallback, int timeoutMs) {
4336 checkTimeout(timeoutMs);
4337 NetworkCapabilities nc = request.networkCapabilities;
4338 sendRequestForNetwork(nc, networkCallback, timeoutMs, REQUEST, TYPE_NONE,
4339 getDefaultHandler());
4340 }
4341
4342 /**
Roshan Piuse08bc182020-12-22 15:10:42 -08004343 * Request a network to satisfy a set of {@link NetworkCapabilities}, limited
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004344 * by a timeout.
4345 *
4346 * This method behaves identically to
4347 * {@link #requestNetwork(NetworkRequest, NetworkCallback, int)} but runs all the callbacks
4348 * on the passed Handler.
4349 *
4350 * <p>This method has the same permission requirements as
4351 * {@link #requestNetwork(NetworkRequest, NetworkCallback)}, is subject to the same limitations,
4352 * and throws the same exceptions in the same conditions.
4353 *
4354 * @param request {@link NetworkRequest} describing this request.
4355 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
4356 * the callback must not be shared - it uniquely specifies this request.
4357 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
4358 * @param timeoutMs The time in milliseconds to attempt looking for a suitable network
4359 * before {@link NetworkCallback#onUnavailable} is called.
4360 */
4361 public void requestNetwork(@NonNull NetworkRequest request,
4362 @NonNull NetworkCallback networkCallback, @NonNull Handler handler, int timeoutMs) {
4363 checkTimeout(timeoutMs);
4364 CallbackHandler cbHandler = new CallbackHandler(handler);
4365 NetworkCapabilities nc = request.networkCapabilities;
4366 sendRequestForNetwork(nc, networkCallback, timeoutMs, REQUEST, TYPE_NONE, cbHandler);
4367 }
4368
4369 /**
4370 * The lookup key for a {@link Network} object included with the intent after
4371 * successfully finding a network for the applications request. Retrieve it with
4372 * {@link android.content.Intent#getParcelableExtra(String)}.
4373 * <p>
4374 * Note that if you intend to invoke {@link Network#openConnection(java.net.URL)}
4375 * then you must get a ConnectivityManager instance before doing so.
4376 */
4377 public static final String EXTRA_NETWORK = "android.net.extra.NETWORK";
4378
4379 /**
4380 * The lookup key for a {@link NetworkRequest} object included with the intent after
4381 * successfully finding a network for the applications request. Retrieve it with
4382 * {@link android.content.Intent#getParcelableExtra(String)}.
4383 */
4384 public static final String EXTRA_NETWORK_REQUEST = "android.net.extra.NETWORK_REQUEST";
4385
4386
4387 /**
Roshan Piuse08bc182020-12-22 15:10:42 -08004388 * Request a network to satisfy a set of {@link NetworkCapabilities}.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004389 *
4390 * This function behaves identically to the version that takes a NetworkCallback, but instead
4391 * of {@link NetworkCallback} a {@link PendingIntent} is used. This means
4392 * the request may outlive the calling application and get called back when a suitable
4393 * network is found.
4394 * <p>
4395 * The operation is an Intent broadcast that goes to a broadcast receiver that
4396 * you registered with {@link Context#registerReceiver} or through the
4397 * &lt;receiver&gt; tag in an AndroidManifest.xml file
4398 * <p>
4399 * The operation Intent is delivered with two extras, a {@link Network} typed
4400 * extra called {@link #EXTRA_NETWORK} and a {@link NetworkRequest}
4401 * typed extra called {@link #EXTRA_NETWORK_REQUEST} containing
4402 * the original requests parameters. It is important to create a new,
4403 * {@link NetworkCallback} based request before completing the processing of the
4404 * Intent to reserve the network or it will be released shortly after the Intent
4405 * is processed.
4406 * <p>
4407 * If there is already a request for this Intent registered (with the equality of
4408 * two Intents defined by {@link Intent#filterEquals}), then it will be removed and
4409 * replaced by this one, effectively releasing the previous {@link NetworkRequest}.
4410 * <p>
4411 * The request may be released normally by calling
4412 * {@link #releaseNetworkRequest(android.app.PendingIntent)}.
4413 * <p>It is presently unsupported to request a network with either
4414 * {@link NetworkCapabilities#NET_CAPABILITY_VALIDATED} or
4415 * {@link NetworkCapabilities#NET_CAPABILITY_CAPTIVE_PORTAL}
4416 * as these {@code NetworkCapabilities} represent states that a particular
4417 * network may never attain, and whether a network will attain these states
4418 * is unknown prior to bringing up the network so the framework does not
4419 * know how to go about satisfying a request with these capabilities.
4420 *
4421 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4422 * number of outstanding requests to 100 per app (identified by their UID), shared with
4423 * all variants of this method, of {@link #registerNetworkCallback} as well as
4424 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4425 * Requesting a network with this method will count toward this limit. If this limit is
4426 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4427 * make sure to unregister the callbacks with {@link #unregisterNetworkCallback(PendingIntent)}
4428 * or {@link #releaseNetworkRequest(PendingIntent)}.
4429 *
4430 * <p>This method requires the caller to hold either the
4431 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
4432 * or the ability to modify system settings as determined by
4433 * {@link android.provider.Settings.System#canWrite}.</p>
4434 *
4435 * @param request {@link NetworkRequest} describing this request.
4436 * @param operation Action to perform when the network is available (corresponds
4437 * to the {@link NetworkCallback#onAvailable} call. Typically
4438 * comes from {@link PendingIntent#getBroadcast}. Cannot be null.
4439 * @throws IllegalArgumentException if {@code request} contains invalid network capabilities.
4440 * @throws SecurityException if missing the appropriate permissions.
4441 * @throws RuntimeException if the app already has too many callbacks registered.
4442 */
4443 public void requestNetwork(@NonNull NetworkRequest request,
4444 @NonNull PendingIntent operation) {
4445 printStackTrace();
4446 checkPendingIntentNotNull(operation);
4447 try {
4448 mService.pendingRequestForNetwork(
4449 request.networkCapabilities, operation, mContext.getOpPackageName(),
4450 getAttributionTag());
4451 } catch (RemoteException e) {
4452 throw e.rethrowFromSystemServer();
4453 } catch (ServiceSpecificException e) {
4454 throw convertServiceException(e);
4455 }
4456 }
4457
4458 /**
4459 * Removes a request made via {@link #requestNetwork(NetworkRequest, android.app.PendingIntent)}
4460 * <p>
4461 * This method has the same behavior as
4462 * {@link #unregisterNetworkCallback(android.app.PendingIntent)} with respect to
4463 * releasing network resources and disconnecting.
4464 *
4465 * @param operation A PendingIntent equal (as defined by {@link Intent#filterEquals}) to the
4466 * PendingIntent passed to
4467 * {@link #requestNetwork(NetworkRequest, android.app.PendingIntent)} with the
4468 * corresponding NetworkRequest you'd like to remove. Cannot be null.
4469 */
4470 public void releaseNetworkRequest(@NonNull PendingIntent operation) {
4471 printStackTrace();
4472 checkPendingIntentNotNull(operation);
4473 try {
4474 mService.releasePendingNetworkRequest(operation);
4475 } catch (RemoteException e) {
4476 throw e.rethrowFromSystemServer();
4477 }
4478 }
4479
4480 private static void checkPendingIntentNotNull(PendingIntent intent) {
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00004481 Objects.requireNonNull(intent, "PendingIntent cannot be null.");
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004482 }
4483
4484 private static void checkCallbackNotNull(NetworkCallback callback) {
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00004485 Objects.requireNonNull(callback, "null NetworkCallback");
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004486 }
4487
4488 private static void checkTimeout(int timeoutMs) {
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00004489 if (timeoutMs <= 0) {
4490 throw new IllegalArgumentException("timeoutMs must be strictly positive.");
4491 }
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004492 }
4493
4494 /**
4495 * Registers to receive notifications about all networks which satisfy the given
4496 * {@link NetworkRequest}. The callbacks will continue to be called until
4497 * either the application exits or {@link #unregisterNetworkCallback(NetworkCallback)} is
4498 * called.
4499 *
4500 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4501 * number of outstanding requests to 100 per app (identified by their UID), shared with
4502 * all variants of this method, of {@link #requestNetwork} as well as
4503 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4504 * Requesting a network with this method will count toward this limit. If this limit is
4505 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4506 * make sure to unregister the callbacks with
4507 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4508 *
4509 * @param request {@link NetworkRequest} describing this request.
4510 * @param networkCallback The {@link NetworkCallback} that the system will call as suitable
4511 * networks change state.
4512 * The callback is invoked on the default internal Handler.
4513 * @throws RuntimeException if the app already has too many callbacks registered.
4514 */
4515 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
4516 public void registerNetworkCallback(@NonNull NetworkRequest request,
4517 @NonNull NetworkCallback networkCallback) {
4518 registerNetworkCallback(request, networkCallback, getDefaultHandler());
4519 }
4520
4521 /**
4522 * Registers to receive notifications about all networks which satisfy the given
4523 * {@link NetworkRequest}. The callbacks will continue to be called until
4524 * either the application exits or {@link #unregisterNetworkCallback(NetworkCallback)} is
4525 * called.
4526 *
4527 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4528 * number of outstanding requests to 100 per app (identified by their UID), shared with
4529 * all variants of this method, of {@link #requestNetwork} as well as
4530 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4531 * Requesting a network with this method will count toward this limit. If this limit is
4532 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4533 * make sure to unregister the callbacks with
4534 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4535 *
4536 *
4537 * @param request {@link NetworkRequest} describing this request.
4538 * @param networkCallback The {@link NetworkCallback} that the system will call as suitable
4539 * networks change state.
4540 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
4541 * @throws RuntimeException if the app already has too many callbacks registered.
4542 */
4543 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
4544 public void registerNetworkCallback(@NonNull NetworkRequest request,
4545 @NonNull NetworkCallback networkCallback, @NonNull Handler handler) {
4546 CallbackHandler cbHandler = new CallbackHandler(handler);
4547 NetworkCapabilities nc = request.networkCapabilities;
4548 sendRequestForNetwork(nc, networkCallback, 0, LISTEN, TYPE_NONE, cbHandler);
4549 }
4550
4551 /**
4552 * Registers a PendingIntent to be sent when a network is available which satisfies the given
4553 * {@link NetworkRequest}.
4554 *
4555 * This function behaves identically to the version that takes a NetworkCallback, but instead
4556 * of {@link NetworkCallback} a {@link PendingIntent} is used. This means
4557 * the request may outlive the calling application and get called back when a suitable
4558 * network is found.
4559 * <p>
4560 * The operation is an Intent broadcast that goes to a broadcast receiver that
4561 * you registered with {@link Context#registerReceiver} or through the
4562 * &lt;receiver&gt; tag in an AndroidManifest.xml file
4563 * <p>
4564 * The operation Intent is delivered with two extras, a {@link Network} typed
4565 * extra called {@link #EXTRA_NETWORK} and a {@link NetworkRequest}
4566 * typed extra called {@link #EXTRA_NETWORK_REQUEST} containing
4567 * the original requests parameters.
4568 * <p>
4569 * If there is already a request for this Intent registered (with the equality of
4570 * two Intents defined by {@link Intent#filterEquals}), then it will be removed and
4571 * replaced by this one, effectively releasing the previous {@link NetworkRequest}.
4572 * <p>
4573 * The request may be released normally by calling
4574 * {@link #unregisterNetworkCallback(android.app.PendingIntent)}.
4575 *
4576 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4577 * number of outstanding requests to 100 per app (identified by their UID), shared with
4578 * all variants of this method, of {@link #requestNetwork} as well as
4579 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4580 * Requesting a network with this method will count toward this limit. If this limit is
4581 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4582 * make sure to unregister the callbacks with {@link #unregisterNetworkCallback(PendingIntent)}
4583 * or {@link #releaseNetworkRequest(PendingIntent)}.
4584 *
4585 * @param request {@link NetworkRequest} describing this request.
4586 * @param operation Action to perform when the network is available (corresponds
4587 * to the {@link NetworkCallback#onAvailable} call. Typically
4588 * comes from {@link PendingIntent#getBroadcast}. Cannot be null.
4589 * @throws RuntimeException if the app already has too many callbacks registered.
4590 */
4591 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
4592 public void registerNetworkCallback(@NonNull NetworkRequest request,
4593 @NonNull PendingIntent operation) {
4594 printStackTrace();
4595 checkPendingIntentNotNull(operation);
4596 try {
4597 mService.pendingListenForNetwork(
Roshan Piusa8a477b2020-12-17 14:53:09 -08004598 request.networkCapabilities, operation, mContext.getOpPackageName(),
4599 getAttributionTag());
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004600 } catch (RemoteException e) {
4601 throw e.rethrowFromSystemServer();
4602 } catch (ServiceSpecificException e) {
4603 throw convertServiceException(e);
4604 }
4605 }
4606
4607 /**
Lorenzo Colittia77d05e2021-01-29 20:14:04 +09004608 * Registers to receive notifications about changes in the application's default network. This
4609 * may be a physical network or a virtual network, such as a VPN that applies to the
4610 * application. The callbacks will continue to be called until either the application exits or
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004611 * {@link #unregisterNetworkCallback(NetworkCallback)} is called.
4612 *
4613 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4614 * number of outstanding requests to 100 per app (identified by their UID), shared with
4615 * all variants of this method, of {@link #requestNetwork} as well as
4616 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4617 * Requesting a network with this method will count toward this limit. If this limit is
4618 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4619 * make sure to unregister the callbacks with
4620 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4621 *
4622 * @param networkCallback The {@link NetworkCallback} that the system will call as the
Lorenzo Colittia77d05e2021-01-29 20:14:04 +09004623 * application's default network changes.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004624 * The callback is invoked on the default internal Handler.
4625 * @throws RuntimeException if the app already has too many callbacks registered.
4626 */
4627 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
4628 public void registerDefaultNetworkCallback(@NonNull NetworkCallback networkCallback) {
4629 registerDefaultNetworkCallback(networkCallback, getDefaultHandler());
4630 }
4631
4632 /**
Lorenzo Colittia77d05e2021-01-29 20:14:04 +09004633 * Registers to receive notifications about changes in the application's default network. This
4634 * may be a physical network or a virtual network, such as a VPN that applies to the
4635 * application. The callbacks will continue to be called until either the application exits or
4636 * {@link #unregisterNetworkCallback(NetworkCallback)} is called.
4637 *
4638 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4639 * number of outstanding requests to 100 per app (identified by their UID), shared with
4640 * all variants of this method, of {@link #requestNetwork} as well as
4641 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4642 * Requesting a network with this method will count toward this limit. If this limit is
4643 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4644 * make sure to unregister the callbacks with
4645 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4646 *
4647 * @param networkCallback The {@link NetworkCallback} that the system will call as the
4648 * application's default network changes.
4649 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
4650 * @throws RuntimeException if the app already has too many callbacks registered.
4651 */
4652 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
4653 public void registerDefaultNetworkCallback(@NonNull NetworkCallback networkCallback,
4654 @NonNull Handler handler) {
Chiachang Wangc7d203d2021-04-20 15:41:24 +08004655 registerDefaultNetworkCallbackForUid(Process.INVALID_UID, networkCallback, handler);
Lorenzo Colitti5f26b192021-03-12 22:48:07 +09004656 }
4657
4658 /**
4659 * Registers to receive notifications about changes in the default network for the specified
4660 * UID. This may be a physical network or a virtual network, such as a VPN that applies to the
4661 * UID. The callbacks will continue to be called until either the application exits or
4662 * {@link #unregisterNetworkCallback(NetworkCallback)} is called.
4663 *
4664 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4665 * number of outstanding requests to 100 per app (identified by their UID), shared with
4666 * all variants of this method, of {@link #requestNetwork} as well as
4667 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4668 * Requesting a network with this method will count toward this limit. If this limit is
4669 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4670 * make sure to unregister the callbacks with
4671 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4672 *
4673 * @param uid the UID for which to track default network changes.
4674 * @param networkCallback The {@link NetworkCallback} that the system will call as the
4675 * UID's default network changes.
4676 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
4677 * @throws RuntimeException if the app already has too many callbacks registered.
4678 * @hide
4679 */
Lorenzo Colittib90bdbd2021-03-22 18:23:21 +09004680 @SystemApi(client = MODULE_LIBRARIES)
Lorenzo Colitti5f26b192021-03-12 22:48:07 +09004681 @SuppressLint({"ExecutorRegistration", "PairedRegistration"})
4682 @RequiresPermission(anyOf = {
4683 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
4684 android.Manifest.permission.NETWORK_SETTINGS})
Chiachang Wangc7d203d2021-04-20 15:41:24 +08004685 public void registerDefaultNetworkCallbackForUid(int uid,
Lorenzo Colitti5f26b192021-03-12 22:48:07 +09004686 @NonNull NetworkCallback networkCallback, @NonNull Handler handler) {
Lorenzo Colittia77d05e2021-01-29 20:14:04 +09004687 CallbackHandler cbHandler = new CallbackHandler(handler);
Lorenzo Colitti5f26b192021-03-12 22:48:07 +09004688 sendRequestForNetwork(uid, null /* need */, networkCallback, 0 /* timeoutMs */,
Lorenzo Colittia77d05e2021-01-29 20:14:04 +09004689 TRACK_DEFAULT, TYPE_NONE, cbHandler);
4690 }
4691
4692 /**
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004693 * Registers to receive notifications about changes in the system default network. The callbacks
4694 * will continue to be called until either the application exits or
4695 * {@link #unregisterNetworkCallback(NetworkCallback)} is called.
4696 *
Lorenzo Colittia77d05e2021-01-29 20:14:04 +09004697 * This method should not be used to determine networking state seen by applications, because in
4698 * many cases, most or even all application traffic may not use the default network directly,
4699 * and traffic from different applications may go on different networks by default. As an
4700 * example, if a VPN is connected, traffic from all applications might be sent through the VPN
4701 * and not onto the system default network. Applications or system components desiring to do
4702 * determine network state as seen by applications should use other methods such as
4703 * {@link #registerDefaultNetworkCallback(NetworkCallback, Handler)}.
4704 *
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004705 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4706 * number of outstanding requests to 100 per app (identified by their UID), shared with
4707 * all variants of this method, of {@link #requestNetwork} as well as
4708 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4709 * Requesting a network with this method will count toward this limit. If this limit is
4710 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4711 * make sure to unregister the callbacks with
4712 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4713 *
4714 * @param networkCallback The {@link NetworkCallback} that the system will call as the
4715 * system default network changes.
4716 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
4717 * @throws RuntimeException if the app already has too many callbacks registered.
Lorenzo Colittia77d05e2021-01-29 20:14:04 +09004718 *
4719 * @hide
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004720 */
Lorenzo Colittia77d05e2021-01-29 20:14:04 +09004721 @SystemApi(client = MODULE_LIBRARIES)
4722 @SuppressLint({"ExecutorRegistration", "PairedRegistration"})
4723 @RequiresPermission(anyOf = {
4724 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
4725 android.Manifest.permission.NETWORK_SETTINGS})
4726 public void registerSystemDefaultNetworkCallback(@NonNull NetworkCallback networkCallback,
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004727 @NonNull Handler handler) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004728 CallbackHandler cbHandler = new CallbackHandler(handler);
4729 sendRequestForNetwork(null /* NetworkCapabilities need */, networkCallback, 0,
Lorenzo Colittia77d05e2021-01-29 20:14:04 +09004730 TRACK_SYSTEM_DEFAULT, TYPE_NONE, cbHandler);
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004731 }
4732
4733 /**
junyulaibd123062021-03-15 11:48:48 +08004734 * Registers to receive notifications about the best matching network which satisfy the given
4735 * {@link NetworkRequest}. The callbacks will continue to be called until
4736 * either the application exits or {@link #unregisterNetworkCallback(NetworkCallback)} is
4737 * called.
4738 *
4739 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4740 * number of outstanding requests to 100 per app (identified by their UID), shared with
4741 * {@link #registerNetworkCallback} and its variants and {@link #requestNetwork} as well as
4742 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4743 * Requesting a network with this method will count toward this limit. If this limit is
4744 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4745 * make sure to unregister the callbacks with
4746 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4747 *
4748 *
4749 * @param request {@link NetworkRequest} describing this request.
4750 * @param networkCallback The {@link NetworkCallback} that the system will call as suitable
4751 * networks change state.
4752 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
4753 * @throws RuntimeException if the app already has too many callbacks registered.
junyulai5a5c99b2021-03-05 15:51:17 +08004754 */
junyulai5a5c99b2021-03-05 15:51:17 +08004755 @SuppressLint("ExecutorRegistration")
4756 public void registerBestMatchingNetworkCallback(@NonNull NetworkRequest request,
4757 @NonNull NetworkCallback networkCallback, @NonNull Handler handler) {
4758 final NetworkCapabilities nc = request.networkCapabilities;
4759 final CallbackHandler cbHandler = new CallbackHandler(handler);
junyulai7664f622021-03-12 20:05:08 +08004760 sendRequestForNetwork(nc, networkCallback, 0, LISTEN_FOR_BEST, TYPE_NONE, cbHandler);
junyulai5a5c99b2021-03-05 15:51:17 +08004761 }
4762
4763 /**
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004764 * Requests bandwidth update for a given {@link Network} and returns whether the update request
4765 * is accepted by ConnectivityService. Once accepted, ConnectivityService will poll underlying
4766 * network connection for updated bandwidth information. The caller will be notified via
4767 * {@link ConnectivityManager.NetworkCallback} if there is an update. Notice that this
4768 * method assumes that the caller has previously called
4769 * {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)} to listen for network
4770 * changes.
4771 *
4772 * @param network {@link Network} specifying which network you're interested.
4773 * @return {@code true} on success, {@code false} if the {@link Network} is no longer valid.
4774 */
4775 public boolean requestBandwidthUpdate(@NonNull Network network) {
4776 try {
4777 return mService.requestBandwidthUpdate(network);
4778 } catch (RemoteException e) {
4779 throw e.rethrowFromSystemServer();
4780 }
4781 }
4782
4783 /**
4784 * Unregisters a {@code NetworkCallback} and possibly releases networks originating from
4785 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} and
4786 * {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)} calls.
4787 * If the given {@code NetworkCallback} had previously been used with
4788 * {@code #requestNetwork}, any networks that had been connected to only to satisfy that request
4789 * will be disconnected.
4790 *
4791 * Notifications that would have triggered that {@code NetworkCallback} will immediately stop
4792 * triggering it as soon as this call returns.
4793 *
4794 * @param networkCallback The {@link NetworkCallback} used when making the request.
4795 */
4796 public void unregisterNetworkCallback(@NonNull NetworkCallback networkCallback) {
4797 printStackTrace();
4798 checkCallbackNotNull(networkCallback);
4799 final List<NetworkRequest> reqs = new ArrayList<>();
4800 // Find all requests associated to this callback and stop callback triggers immediately.
4801 // Callback is reusable immediately. http://b/20701525, http://b/35921499.
4802 synchronized (sCallbacks) {
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00004803 if (networkCallback.networkRequest == null) {
4804 throw new IllegalArgumentException("NetworkCallback was not registered");
4805 }
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004806 if (networkCallback.networkRequest == ALREADY_UNREGISTERED) {
4807 Log.d(TAG, "NetworkCallback was already unregistered");
4808 return;
4809 }
4810 for (Map.Entry<NetworkRequest, NetworkCallback> e : sCallbacks.entrySet()) {
4811 if (e.getValue() == networkCallback) {
4812 reqs.add(e.getKey());
4813 }
4814 }
4815 // TODO: throw exception if callback was registered more than once (http://b/20701525).
4816 for (NetworkRequest r : reqs) {
4817 try {
4818 mService.releaseNetworkRequest(r);
4819 } catch (RemoteException e) {
4820 throw e.rethrowFromSystemServer();
4821 }
4822 // Only remove mapping if rpc was successful.
4823 sCallbacks.remove(r);
4824 }
4825 networkCallback.networkRequest = ALREADY_UNREGISTERED;
4826 }
4827 }
4828
4829 /**
4830 * Unregisters a callback previously registered via
4831 * {@link #registerNetworkCallback(NetworkRequest, android.app.PendingIntent)}.
4832 *
4833 * @param operation A PendingIntent equal (as defined by {@link Intent#filterEquals}) to the
4834 * PendingIntent passed to
4835 * {@link #registerNetworkCallback(NetworkRequest, android.app.PendingIntent)}.
4836 * Cannot be null.
4837 */
4838 public void unregisterNetworkCallback(@NonNull PendingIntent operation) {
4839 releaseNetworkRequest(operation);
4840 }
4841
4842 /**
4843 * Informs the system whether it should switch to {@code network} regardless of whether it is
4844 * validated or not. If {@code accept} is true, and the network was explicitly selected by the
4845 * user (e.g., by selecting a Wi-Fi network in the Settings app), then the network will become
4846 * the system default network regardless of any other network that's currently connected. If
4847 * {@code always} is true, then the choice is remembered, so that the next time the user
4848 * connects to this network, the system will switch to it.
4849 *
4850 * @param network The network to accept.
4851 * @param accept Whether to accept the network even if unvalidated.
4852 * @param always Whether to remember this choice in the future.
4853 *
4854 * @hide
4855 */
Chiachang Wangf9294e72021-03-18 09:44:34 +08004856 @SystemApi(client = MODULE_LIBRARIES)
4857 @RequiresPermission(anyOf = {
4858 android.Manifest.permission.NETWORK_SETTINGS,
4859 android.Manifest.permission.NETWORK_SETUP_WIZARD,
4860 android.Manifest.permission.NETWORK_STACK,
4861 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK})
4862 public void setAcceptUnvalidated(@NonNull Network network, boolean accept, boolean always) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004863 try {
4864 mService.setAcceptUnvalidated(network, accept, always);
4865 } catch (RemoteException e) {
4866 throw e.rethrowFromSystemServer();
4867 }
4868 }
4869
4870 /**
4871 * Informs the system whether it should consider the network as validated even if it only has
4872 * partial connectivity. If {@code accept} is true, then the network will be considered as
4873 * validated even if connectivity is only partial. If {@code always} is true, then the choice
4874 * is remembered, so that the next time the user connects to this network, the system will
4875 * switch to it.
4876 *
4877 * @param network The network to accept.
4878 * @param accept Whether to consider the network as validated even if it has partial
4879 * connectivity.
4880 * @param always Whether to remember this choice in the future.
4881 *
4882 * @hide
4883 */
Chiachang Wangf9294e72021-03-18 09:44:34 +08004884 @SystemApi(client = MODULE_LIBRARIES)
4885 @RequiresPermission(anyOf = {
4886 android.Manifest.permission.NETWORK_SETTINGS,
4887 android.Manifest.permission.NETWORK_SETUP_WIZARD,
4888 android.Manifest.permission.NETWORK_STACK,
4889 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK})
4890 public void setAcceptPartialConnectivity(@NonNull Network network, boolean accept,
4891 boolean always) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004892 try {
4893 mService.setAcceptPartialConnectivity(network, accept, always);
4894 } catch (RemoteException e) {
4895 throw e.rethrowFromSystemServer();
4896 }
4897 }
4898
4899 /**
4900 * Informs the system to penalize {@code network}'s score when it becomes unvalidated. This is
4901 * only meaningful if the system is configured not to penalize such networks, e.g., if the
4902 * {@code config_networkAvoidBadWifi} configuration variable is set to 0 and the {@code
4903 * NETWORK_AVOID_BAD_WIFI setting is unset}.
4904 *
4905 * @param network The network to accept.
4906 *
4907 * @hide
4908 */
Chiachang Wangf9294e72021-03-18 09:44:34 +08004909 @SystemApi(client = MODULE_LIBRARIES)
4910 @RequiresPermission(anyOf = {
4911 android.Manifest.permission.NETWORK_SETTINGS,
4912 android.Manifest.permission.NETWORK_SETUP_WIZARD,
4913 android.Manifest.permission.NETWORK_STACK,
4914 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK})
4915 public void setAvoidUnvalidated(@NonNull Network network) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004916 try {
4917 mService.setAvoidUnvalidated(network);
4918 } catch (RemoteException e) {
4919 throw e.rethrowFromSystemServer();
4920 }
4921 }
4922
4923 /**
Chiachang Wang6eac9fb2021-06-17 22:11:30 +08004924 * Temporarily allow bad wifi to override {@code config_networkAvoidBadWifi} configuration.
4925 *
4926 * @param timeMs The expired current time. The value should be set within a limited time from
4927 * now.
4928 *
4929 * @hide
4930 */
4931 public void setTestAllowBadWifiUntil(long timeMs) {
4932 try {
4933 mService.setTestAllowBadWifiUntil(timeMs);
4934 } catch (RemoteException e) {
4935 throw e.rethrowFromSystemServer();
4936 }
4937 }
4938
4939 /**
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004940 * Requests that the system open the captive portal app on the specified network.
4941 *
Remi NGUYEN VAN8238a762021-03-16 18:06:06 +09004942 * <p>This is to be used on networks where a captive portal was detected, as per
4943 * {@link NetworkCapabilities#NET_CAPABILITY_CAPTIVE_PORTAL}.
4944 *
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004945 * @param network The network to log into.
4946 *
4947 * @hide
4948 */
Remi NGUYEN VAN8238a762021-03-16 18:06:06 +09004949 @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
4950 @RequiresPermission(anyOf = {
4951 android.Manifest.permission.NETWORK_SETTINGS,
4952 android.Manifest.permission.NETWORK_STACK,
4953 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK
4954 })
4955 public void startCaptivePortalApp(@NonNull Network network) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004956 try {
4957 mService.startCaptivePortalApp(network);
4958 } catch (RemoteException e) {
4959 throw e.rethrowFromSystemServer();
4960 }
4961 }
4962
4963 /**
4964 * Requests that the system open the captive portal app with the specified extras.
4965 *
4966 * <p>This endpoint is exclusively for use by the NetworkStack and is protected by the
4967 * corresponding permission.
4968 * @param network Network on which the captive portal was detected.
4969 * @param appExtras Extras to include in the app start intent.
4970 * @hide
4971 */
4972 @SystemApi
4973 @RequiresPermission(NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK)
4974 public void startCaptivePortalApp(@NonNull Network network, @NonNull Bundle appExtras) {
4975 try {
4976 mService.startCaptivePortalAppInternal(network, appExtras);
4977 } catch (RemoteException e) {
4978 throw e.rethrowFromSystemServer();
4979 }
4980 }
4981
4982 /**
4983 * Determine whether the device is configured to avoid bad wifi.
4984 * @hide
4985 */
4986 @SystemApi
4987 @RequiresPermission(anyOf = {
4988 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
4989 android.Manifest.permission.NETWORK_STACK})
4990 public boolean shouldAvoidBadWifi() {
4991 try {
4992 return mService.shouldAvoidBadWifi();
4993 } catch (RemoteException e) {
4994 throw e.rethrowFromSystemServer();
4995 }
4996 }
4997
4998 /**
4999 * It is acceptable to briefly use multipath data to provide seamless connectivity for
5000 * time-sensitive user-facing operations when the system default network is temporarily
5001 * unresponsive. The amount of data should be limited (less than one megabyte for every call to
5002 * this method), and the operation should be infrequent to ensure that data usage is limited.
5003 *
5004 * An example of such an operation might be a time-sensitive foreground activity, such as a
5005 * voice command, that the user is performing while walking out of range of a Wi-Fi network.
5006 */
5007 public static final int MULTIPATH_PREFERENCE_HANDOVER = 1 << 0;
5008
5009 /**
5010 * It is acceptable to use small amounts of multipath data on an ongoing basis to provide
5011 * a backup channel for traffic that is primarily going over another network.
5012 *
5013 * An example might be maintaining backup connections to peers or servers for the purpose of
5014 * fast fallback if the default network is temporarily unresponsive or disconnects. The traffic
5015 * on backup paths should be negligible compared to the traffic on the main path.
5016 */
5017 public static final int MULTIPATH_PREFERENCE_RELIABILITY = 1 << 1;
5018
5019 /**
5020 * It is acceptable to use metered data to improve network latency and performance.
5021 */
5022 public static final int MULTIPATH_PREFERENCE_PERFORMANCE = 1 << 2;
5023
5024 /**
5025 * Return value to use for unmetered networks. On such networks we currently set all the flags
5026 * to true.
5027 * @hide
5028 */
5029 public static final int MULTIPATH_PREFERENCE_UNMETERED =
5030 MULTIPATH_PREFERENCE_HANDOVER |
5031 MULTIPATH_PREFERENCE_RELIABILITY |
5032 MULTIPATH_PREFERENCE_PERFORMANCE;
5033
Aaron Huangcff22942021-05-27 16:31:26 +08005034 /** @hide */
5035 @Retention(RetentionPolicy.SOURCE)
5036 @IntDef(flag = true, value = {
5037 MULTIPATH_PREFERENCE_HANDOVER,
5038 MULTIPATH_PREFERENCE_RELIABILITY,
5039 MULTIPATH_PREFERENCE_PERFORMANCE,
5040 })
5041 public @interface MultipathPreference {
5042 }
5043
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005044 /**
5045 * Provides a hint to the calling application on whether it is desirable to use the
5046 * multinetwork APIs (e.g., {@link Network#openConnection}, {@link Network#bindSocket}, etc.)
5047 * for multipath data transfer on this network when it is not the system default network.
5048 * Applications desiring to use multipath network protocols should call this method before
5049 * each such operation.
5050 *
5051 * @param network The network on which the application desires to use multipath data.
5052 * If {@code null}, this method will return the a preference that will generally
5053 * apply to metered networks.
5054 * @return a bitwise OR of zero or more of the {@code MULTIPATH_PREFERENCE_*} constants.
5055 */
5056 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
5057 public @MultipathPreference int getMultipathPreference(@Nullable Network network) {
5058 try {
5059 return mService.getMultipathPreference(network);
5060 } catch (RemoteException e) {
5061 throw e.rethrowFromSystemServer();
5062 }
5063 }
5064
5065 /**
5066 * Resets all connectivity manager settings back to factory defaults.
5067 * @hide
5068 */
Chiachang Wangf9294e72021-03-18 09:44:34 +08005069 @SystemApi(client = MODULE_LIBRARIES)
5070 @RequiresPermission(anyOf = {
5071 android.Manifest.permission.NETWORK_SETTINGS,
5072 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK})
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005073 public void factoryReset() {
5074 try {
5075 mService.factoryReset();
Remi NGUYEN VANe4d1cd92021-06-17 16:27:31 +09005076 getTetheringManager().stopAllTethering();
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005077 } catch (RemoteException e) {
5078 throw e.rethrowFromSystemServer();
5079 }
5080 }
5081
5082 /**
5083 * Binds the current process to {@code network}. All Sockets created in the future
5084 * (and not explicitly bound via a bound SocketFactory from
5085 * {@link Network#getSocketFactory() Network.getSocketFactory()}) will be bound to
5086 * {@code network}. All host name resolutions will be limited to {@code network} as well.
5087 * Note that if {@code network} ever disconnects, all Sockets created in this way will cease to
5088 * work and all host name resolutions will fail. This is by design so an application doesn't
5089 * accidentally use Sockets it thinks are still bound to a particular {@link Network}.
5090 * To clear binding pass {@code null} for {@code network}. Using individually bound
5091 * Sockets created by Network.getSocketFactory().createSocket() and
5092 * performing network-specific host name resolutions via
5093 * {@link Network#getAllByName Network.getAllByName} is preferred to calling
5094 * {@code bindProcessToNetwork}.
5095 *
5096 * @param network The {@link Network} to bind the current process to, or {@code null} to clear
5097 * the current binding.
5098 * @return {@code true} on success, {@code false} if the {@link Network} is no longer valid.
5099 */
5100 public boolean bindProcessToNetwork(@Nullable Network network) {
5101 // Forcing callers to call through non-static function ensures ConnectivityManager
5102 // instantiated.
5103 return setProcessDefaultNetwork(network);
5104 }
5105
5106 /**
5107 * Binds the current process to {@code network}. All Sockets created in the future
5108 * (and not explicitly bound via a bound SocketFactory from
5109 * {@link Network#getSocketFactory() Network.getSocketFactory()}) will be bound to
5110 * {@code network}. All host name resolutions will be limited to {@code network} as well.
5111 * Note that if {@code network} ever disconnects, all Sockets created in this way will cease to
5112 * work and all host name resolutions will fail. This is by design so an application doesn't
5113 * accidentally use Sockets it thinks are still bound to a particular {@link Network}.
5114 * To clear binding pass {@code null} for {@code network}. Using individually bound
5115 * Sockets created by Network.getSocketFactory().createSocket() and
5116 * performing network-specific host name resolutions via
5117 * {@link Network#getAllByName Network.getAllByName} is preferred to calling
5118 * {@code setProcessDefaultNetwork}.
5119 *
5120 * @param network The {@link Network} to bind the current process to, or {@code null} to clear
5121 * the current binding.
5122 * @return {@code true} on success, {@code false} if the {@link Network} is no longer valid.
5123 * @deprecated This function can throw {@link IllegalStateException}. Use
5124 * {@link #bindProcessToNetwork} instead. {@code bindProcessToNetwork}
5125 * is a direct replacement.
5126 */
5127 @Deprecated
5128 public static boolean setProcessDefaultNetwork(@Nullable Network network) {
5129 int netId = (network == null) ? NETID_UNSET : network.netId;
5130 boolean isSameNetId = (netId == NetworkUtils.getBoundNetworkForProcess());
5131
5132 if (netId != NETID_UNSET) {
5133 netId = network.getNetIdForResolv();
5134 }
5135
5136 if (!NetworkUtils.bindProcessToNetwork(netId)) {
5137 return false;
5138 }
5139
5140 if (!isSameNetId) {
5141 // Set HTTP proxy system properties to match network.
5142 // TODO: Deprecate this static method and replace it with a non-static version.
5143 try {
Remi NGUYEN VAN8a831d62021-02-03 10:18:20 +09005144 Proxy.setHttpProxyConfiguration(getInstance().getDefaultProxy());
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005145 } catch (SecurityException e) {
5146 // The process doesn't have ACCESS_NETWORK_STATE, so we can't fetch the proxy.
5147 Log.e(TAG, "Can't set proxy properties", e);
5148 }
5149 // Must flush DNS cache as new network may have different DNS resolutions.
Remi NGUYEN VANb2e919f2021-07-02 09:34:36 +09005150 InetAddress.clearDnsCache();
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005151 // Must flush socket pool as idle sockets will be bound to previous network and may
5152 // cause subsequent fetches to be performed on old network.
Orion Hodson1f4fa9f2021-05-25 21:02:02 +01005153 NetworkEventDispatcher.getInstance().dispatchNetworkConfigurationChange();
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005154 }
5155
5156 return true;
5157 }
5158
5159 /**
5160 * Returns the {@link Network} currently bound to this process via
5161 * {@link #bindProcessToNetwork}, or {@code null} if no {@link Network} is explicitly bound.
5162 *
5163 * @return {@code Network} to which this process is bound, or {@code null}.
5164 */
5165 @Nullable
5166 public Network getBoundNetworkForProcess() {
5167 // Forcing callers to call thru non-static function ensures ConnectivityManager
5168 // instantiated.
5169 return getProcessDefaultNetwork();
5170 }
5171
5172 /**
5173 * Returns the {@link Network} currently bound to this process via
5174 * {@link #bindProcessToNetwork}, or {@code null} if no {@link Network} is explicitly bound.
5175 *
5176 * @return {@code Network} to which this process is bound, or {@code null}.
5177 * @deprecated Using this function can lead to other functions throwing
5178 * {@link IllegalStateException}. Use {@link #getBoundNetworkForProcess} instead.
5179 * {@code getBoundNetworkForProcess} is a direct replacement.
5180 */
5181 @Deprecated
5182 @Nullable
5183 public static Network getProcessDefaultNetwork() {
5184 int netId = NetworkUtils.getBoundNetworkForProcess();
5185 if (netId == NETID_UNSET) return null;
5186 return new Network(netId);
5187 }
5188
5189 private void unsupportedStartingFrom(int version) {
5190 if (Process.myUid() == Process.SYSTEM_UID) {
5191 // The getApplicationInfo() call we make below is not supported in system context. Let
5192 // the call through here, and rely on the fact that ConnectivityService will refuse to
5193 // allow the system to use these APIs anyway.
5194 return;
5195 }
5196
5197 if (mContext.getApplicationInfo().targetSdkVersion >= version) {
5198 throw new UnsupportedOperationException(
5199 "This method is not supported in target SDK version " + version + " and above");
5200 }
5201 }
5202
5203 // Checks whether the calling app can use the legacy routing API (startUsingNetworkFeature,
5204 // stopUsingNetworkFeature, requestRouteToHost), and if not throw UnsupportedOperationException.
5205 // TODO: convert the existing system users (Tethering, GnssLocationProvider) to the new APIs and
5206 // remove these exemptions. Note that this check is not secure, and apps can still access these
5207 // functions by accessing ConnectivityService directly. However, it should be clear that doing
5208 // so is unsupported and may break in the future. http://b/22728205
5209 private void checkLegacyRoutingApiAccess() {
5210 unsupportedStartingFrom(VERSION_CODES.M);
5211 }
5212
5213 /**
5214 * Binds host resolutions performed by this process to {@code network}.
5215 * {@link #bindProcessToNetwork} takes precedence over this setting.
5216 *
5217 * @param network The {@link Network} to bind host resolutions from the current process to, or
5218 * {@code null} to clear the current binding.
5219 * @return {@code true} on success, {@code false} if the {@link Network} is no longer valid.
5220 * @hide
5221 * @deprecated This is strictly for legacy usage to support {@link #startUsingNetworkFeature}.
5222 */
5223 @Deprecated
5224 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
5225 public static boolean setProcessDefaultNetworkForHostResolution(Network network) {
5226 return NetworkUtils.bindProcessToNetworkForHostResolution(
5227 (network == null) ? NETID_UNSET : network.getNetIdForResolv());
5228 }
5229
5230 /**
5231 * Device is not restricting metered network activity while application is running on
5232 * background.
5233 */
5234 public static final int RESTRICT_BACKGROUND_STATUS_DISABLED = 1;
5235
5236 /**
5237 * Device is restricting metered network activity while application is running on background,
5238 * but application is allowed to bypass it.
5239 * <p>
5240 * In this state, application should take action to mitigate metered network access.
5241 * For example, a music streaming application should switch to a low-bandwidth bitrate.
5242 */
5243 public static final int RESTRICT_BACKGROUND_STATUS_WHITELISTED = 2;
5244
5245 /**
5246 * Device is restricting metered network activity while application is running on background.
5247 * <p>
5248 * In this state, application should not try to use the network while running on background,
5249 * because it would be denied.
5250 */
5251 public static final int RESTRICT_BACKGROUND_STATUS_ENABLED = 3;
5252
5253 /**
5254 * A change in the background metered network activity restriction has occurred.
5255 * <p>
5256 * Applications should call {@link #getRestrictBackgroundStatus()} to check if the restriction
5257 * applies to them.
5258 * <p>
5259 * This is only sent to registered receivers, not manifest receivers.
5260 */
5261 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
5262 public static final String ACTION_RESTRICT_BACKGROUND_CHANGED =
5263 "android.net.conn.RESTRICT_BACKGROUND_CHANGED";
5264
Aaron Huangcff22942021-05-27 16:31:26 +08005265 /** @hide */
5266 @Retention(RetentionPolicy.SOURCE)
5267 @IntDef(flag = false, value = {
5268 RESTRICT_BACKGROUND_STATUS_DISABLED,
5269 RESTRICT_BACKGROUND_STATUS_WHITELISTED,
5270 RESTRICT_BACKGROUND_STATUS_ENABLED,
5271 })
5272 public @interface RestrictBackgroundStatus {
5273 }
5274
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005275 /**
5276 * Determines if the calling application is subject to metered network restrictions while
5277 * running on background.
5278 *
5279 * @return {@link #RESTRICT_BACKGROUND_STATUS_DISABLED},
5280 * {@link #RESTRICT_BACKGROUND_STATUS_ENABLED},
5281 * or {@link #RESTRICT_BACKGROUND_STATUS_WHITELISTED}
5282 */
5283 public @RestrictBackgroundStatus int getRestrictBackgroundStatus() {
5284 try {
Remi NGUYEN VAN1fdeb502021-03-18 14:23:12 +09005285 return mService.getRestrictBackgroundStatusByCaller();
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005286 } catch (RemoteException e) {
5287 throw e.rethrowFromSystemServer();
5288 }
5289 }
5290
5291 /**
5292 * The network watchlist is a list of domains and IP addresses that are associated with
5293 * potentially harmful apps. This method returns the SHA-256 of the watchlist config file
5294 * currently used by the system for validation purposes.
5295 *
5296 * @return Hash of network watchlist config file. Null if config does not exist.
5297 */
5298 @Nullable
5299 public byte[] getNetworkWatchlistConfigHash() {
5300 try {
5301 return mService.getNetworkWatchlistConfigHash();
5302 } catch (RemoteException e) {
5303 Log.e(TAG, "Unable to get watchlist config hash");
5304 throw e.rethrowFromSystemServer();
5305 }
5306 }
5307
5308 /**
5309 * Returns the {@code uid} of the owner of a network connection.
5310 *
5311 * @param protocol The protocol of the connection. Only {@code IPPROTO_TCP} and {@code
5312 * IPPROTO_UDP} currently supported.
5313 * @param local The local {@link InetSocketAddress} of a connection.
5314 * @param remote The remote {@link InetSocketAddress} of a connection.
5315 * @return {@code uid} if the connection is found and the app has permission to observe it
5316 * (e.g., if it is associated with the calling VPN app's VpnService tunnel) or {@link
5317 * android.os.Process#INVALID_UID} if the connection is not found.
5318 * @throws {@link SecurityException} if the caller is not the active VpnService for the current
5319 * user.
5320 * @throws {@link IllegalArgumentException} if an unsupported protocol is requested.
5321 */
5322 public int getConnectionOwnerUid(
5323 int protocol, @NonNull InetSocketAddress local, @NonNull InetSocketAddress remote) {
5324 ConnectionInfo connectionInfo = new ConnectionInfo(protocol, local, remote);
5325 try {
5326 return mService.getConnectionOwnerUid(connectionInfo);
5327 } catch (RemoteException e) {
5328 throw e.rethrowFromSystemServer();
5329 }
5330 }
5331
5332 private void printStackTrace() {
5333 if (DEBUG) {
5334 final StackTraceElement[] callStack = Thread.currentThread().getStackTrace();
5335 final StringBuffer sb = new StringBuffer();
5336 for (int i = 3; i < callStack.length; i++) {
5337 final String stackTrace = callStack[i].toString();
5338 if (stackTrace == null || stackTrace.contains("android.os")) {
5339 break;
5340 }
5341 sb.append(" [").append(stackTrace).append("]");
5342 }
5343 Log.d(TAG, "StackLog:" + sb.toString());
5344 }
5345 }
5346
Remi NGUYEN VAN91444ca2021-01-15 23:02:47 +09005347 /** @hide */
5348 public TestNetworkManager startOrGetTestNetworkManager() {
5349 final IBinder tnBinder;
5350 try {
5351 tnBinder = mService.startOrGetTestNetworkService();
5352 } catch (RemoteException e) {
5353 throw e.rethrowFromSystemServer();
5354 }
5355
5356 return new TestNetworkManager(ITestNetworkManager.Stub.asInterface(tnBinder));
5357 }
5358
Remi NGUYEN VAN91444ca2021-01-15 23:02:47 +09005359 /** @hide */
5360 public ConnectivityDiagnosticsManager createDiagnosticsManager() {
5361 return new ConnectivityDiagnosticsManager(mContext, mService);
5362 }
5363
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005364 /**
5365 * Simulates a Data Stall for the specified Network.
5366 *
5367 * <p>This method should only be used for tests.
5368 *
Remi NGUYEN VAN564f7f82021-04-08 16:26:20 +09005369 * <p>The caller must be the owner of the specified Network. This simulates a data stall to
5370 * have the system behave as if it had happened, but does not actually stall connectivity.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005371 *
5372 * @param detectionMethod The detection method used to identify the Data Stall.
Remi NGUYEN VAN564f7f82021-04-08 16:26:20 +09005373 * See ConnectivityDiagnosticsManager.DataStallReport.DETECTION_METHOD_*.
5374 * @param timestampMillis The timestamp at which the stall 'occurred', in milliseconds, as per
5375 * SystemClock.elapsedRealtime.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005376 * @param network The Network for which a Data Stall is being simluated.
5377 * @param extras The PersistableBundle of extras included in the Data Stall notification.
5378 * @throws SecurityException if the caller is not the owner of the given network.
5379 * @hide
5380 */
5381 @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
5382 @RequiresPermission(anyOf = {android.Manifest.permission.MANAGE_TEST_NETWORKS,
5383 android.Manifest.permission.NETWORK_STACK})
Remi NGUYEN VAN564f7f82021-04-08 16:26:20 +09005384 public void simulateDataStall(@DetectionMethod int detectionMethod, long timestampMillis,
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005385 @NonNull Network network, @NonNull PersistableBundle extras) {
5386 try {
5387 mService.simulateDataStall(detectionMethod, timestampMillis, network, extras);
5388 } catch (RemoteException e) {
5389 e.rethrowFromSystemServer();
5390 }
5391 }
5392
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005393 @NonNull
5394 private final List<QosCallbackConnection> mQosCallbackConnections = new ArrayList<>();
5395
5396 /**
5397 * Registers a {@link QosSocketInfo} with an associated {@link QosCallback}. The callback will
5398 * receive available QoS events related to the {@link Network} and local ip + port
5399 * specified within socketInfo.
5400 * <p/>
5401 * The same {@link QosCallback} must be unregistered before being registered a second time,
5402 * otherwise {@link QosCallbackRegistrationException} is thrown.
5403 * <p/>
5404 * This API does not, in itself, require any permission if called with a network that is not
5405 * restricted. However, the underlying implementation currently only supports the IMS network,
5406 * which is always restricted. That means non-preinstalled callers can't possibly find this API
5407 * useful, because they'd never be called back on networks that they would have access to.
5408 *
5409 * @throws SecurityException if {@link QosSocketInfo#getNetwork()} is restricted and the app is
5410 * missing CONNECTIVITY_USE_RESTRICTED_NETWORKS permission.
5411 * @throws QosCallback.QosCallbackRegistrationException if qosCallback is already registered.
5412 * @throws RuntimeException if the app already has too many callbacks registered.
5413 *
5414 * Exceptions after the time of registration is passed through
5415 * {@link QosCallback#onError(QosCallbackException)}. see: {@link QosCallbackException}.
5416 *
5417 * @param socketInfo the socket information used to match QoS events
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005418 * @param executor The executor on which the callback will be invoked. The provided
5419 * {@link Executor} must run callback sequentially, otherwise the order of
Daniel Bright686d5d22021-03-10 11:51:50 -08005420 * callbacks cannot be guaranteed.onQosCallbackRegistered
5421 * @param callback receives qos events that satisfy socketInfo
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005422 *
5423 * @hide
5424 */
5425 @SystemApi
5426 public void registerQosCallback(@NonNull final QosSocketInfo socketInfo,
Daniel Bright686d5d22021-03-10 11:51:50 -08005427 @CallbackExecutor @NonNull final Executor executor,
5428 @NonNull final QosCallback callback) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005429 Objects.requireNonNull(socketInfo, "socketInfo must be non-null");
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005430 Objects.requireNonNull(executor, "executor must be non-null");
Daniel Bright686d5d22021-03-10 11:51:50 -08005431 Objects.requireNonNull(callback, "callback must be non-null");
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005432
5433 try {
5434 synchronized (mQosCallbackConnections) {
5435 if (getQosCallbackConnection(callback) == null) {
5436 final QosCallbackConnection connection =
5437 new QosCallbackConnection(this, callback, executor);
5438 mQosCallbackConnections.add(connection);
5439 mService.registerQosSocketCallback(socketInfo, connection);
5440 } else {
5441 Log.e(TAG, "registerQosCallback: Callback already registered");
5442 throw new QosCallbackRegistrationException();
5443 }
5444 }
5445 } catch (final RemoteException e) {
5446 Log.e(TAG, "registerQosCallback: Error while registering ", e);
5447
5448 // The same unregister method method is called for consistency even though nothing
5449 // will be sent to the ConnectivityService since the callback was never successfully
5450 // registered.
5451 unregisterQosCallback(callback);
5452 e.rethrowFromSystemServer();
5453 } catch (final ServiceSpecificException e) {
5454 Log.e(TAG, "registerQosCallback: Error while registering ", e);
5455 unregisterQosCallback(callback);
5456 throw convertServiceException(e);
5457 }
5458 }
5459
5460 /**
5461 * Unregisters the given {@link QosCallback}. The {@link QosCallback} will no longer receive
5462 * events once unregistered and can be registered a second time.
5463 * <p/>
5464 * If the {@link QosCallback} does not have an active registration, it is a no-op.
5465 *
5466 * @param callback the callback being unregistered
5467 *
5468 * @hide
5469 */
5470 @SystemApi
5471 public void unregisterQosCallback(@NonNull final QosCallback callback) {
5472 Objects.requireNonNull(callback, "The callback must be non-null");
5473 try {
5474 synchronized (mQosCallbackConnections) {
5475 final QosCallbackConnection connection = getQosCallbackConnection(callback);
5476 if (connection != null) {
5477 connection.stopReceivingMessages();
5478 mService.unregisterQosCallback(connection);
5479 mQosCallbackConnections.remove(connection);
5480 } else {
5481 Log.d(TAG, "unregisterQosCallback: Callback not registered");
5482 }
5483 }
5484 } catch (final RemoteException e) {
5485 Log.e(TAG, "unregisterQosCallback: Error while unregistering ", e);
5486 e.rethrowFromSystemServer();
5487 }
5488 }
5489
5490 /**
5491 * Gets the connection related to the callback.
5492 *
5493 * @param callback the callback to look up
5494 * @return the related connection
5495 */
5496 @Nullable
5497 private QosCallbackConnection getQosCallbackConnection(final QosCallback callback) {
5498 for (final QosCallbackConnection connection : mQosCallbackConnections) {
5499 // Checking by reference here is intentional
5500 if (connection.getCallback() == callback) {
5501 return connection;
5502 }
5503 }
5504 return null;
5505 }
5506
5507 /**
Roshan Piuse08bc182020-12-22 15:10:42 -08005508 * Request a network to satisfy a set of {@link NetworkCapabilities}, but
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005509 * does not cause any networks to retain the NET_CAPABILITY_FOREGROUND capability. This can
5510 * be used to request that the system provide a network without causing the network to be
5511 * in the foreground.
5512 *
5513 * <p>This method will attempt to find the best network that matches the passed
5514 * {@link NetworkRequest}, and to bring up one that does if none currently satisfies the
5515 * criteria. The platform will evaluate which network is the best at its own discretion.
5516 * Throughput, latency, cost per byte, policy, user preference and other considerations
5517 * may be factored in the decision of what is considered the best network.
5518 *
5519 * <p>As long as this request is outstanding, the platform will try to maintain the best network
5520 * matching this request, while always attempting to match the request to a better network if
5521 * possible. If a better match is found, the platform will switch this request to the now-best
5522 * network and inform the app of the newly best network by invoking
5523 * {@link NetworkCallback#onAvailable(Network)} on the provided callback. Note that the platform
5524 * will not try to maintain any other network than the best one currently matching the request:
5525 * a network not matching any network request may be disconnected at any time.
5526 *
5527 * <p>For example, an application could use this method to obtain a connected cellular network
5528 * even if the device currently has a data connection over Ethernet. This may cause the cellular
5529 * radio to consume additional power. Or, an application could inform the system that it wants
5530 * a network supporting sending MMSes and have the system let it know about the currently best
5531 * MMS-supporting network through the provided {@link NetworkCallback}.
5532 *
5533 * <p>The status of the request can be followed by listening to the various callbacks described
5534 * in {@link NetworkCallback}. The {@link Network} object passed to the callback methods can be
5535 * used to direct traffic to the network (although accessing some networks may be subject to
5536 * holding specific permissions). Callers will learn about the specific characteristics of the
5537 * network through
5538 * {@link NetworkCallback#onCapabilitiesChanged(Network, NetworkCapabilities)} and
5539 * {@link NetworkCallback#onLinkPropertiesChanged(Network, LinkProperties)}. The methods of the
5540 * provided {@link NetworkCallback} will only be invoked due to changes in the best network
5541 * matching the request at any given time; therefore when a better network matching the request
5542 * becomes available, the {@link NetworkCallback#onAvailable(Network)} method is called
5543 * with the new network after which no further updates are given about the previously-best
5544 * network, unless it becomes the best again at some later time. All callbacks are invoked
5545 * in order on the same thread, which by default is a thread created by the framework running
5546 * in the app.
5547 *
5548 * <p>This{@link NetworkRequest} will live until released via
5549 * {@link #unregisterNetworkCallback(NetworkCallback)} or the calling application exits, at
5550 * which point the system may let go of the network at any time.
5551 *
5552 * <p>It is presently unsupported to request a network with mutable
5553 * {@link NetworkCapabilities} such as
5554 * {@link NetworkCapabilities#NET_CAPABILITY_VALIDATED} or
5555 * {@link NetworkCapabilities#NET_CAPABILITY_CAPTIVE_PORTAL}
5556 * as these {@code NetworkCapabilities} represent states that a particular
5557 * network may never attain, and whether a network will attain these states
5558 * is unknown prior to bringing up the network so the framework does not
5559 * know how to go about satisfying a request with these capabilities.
5560 *
5561 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
5562 * number of outstanding requests to 100 per app (identified by their UID), shared with
5563 * all variants of this method, of {@link #registerNetworkCallback} as well as
5564 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
5565 * Requesting a network with this method will count toward this limit. If this limit is
5566 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
5567 * make sure to unregister the callbacks with
5568 * {@link #unregisterNetworkCallback(NetworkCallback)}.
5569 *
5570 * @param request {@link NetworkRequest} describing this request.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005571 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
5572 * the callback must not be shared - it uniquely specifies this request.
junyulaica657cb2021-04-15 00:39:49 +08005573 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
5574 * If null, the callback is invoked on the default internal Handler.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005575 * @throws IllegalArgumentException if {@code request} contains invalid network capabilities.
5576 * @throws SecurityException if missing the appropriate permissions.
5577 * @throws RuntimeException if the app already has too many callbacks registered.
5578 *
5579 * @hide
5580 */
5581 @SystemApi(client = MODULE_LIBRARIES)
5582 @SuppressLint("ExecutorRegistration")
5583 @RequiresPermission(anyOf = {
5584 android.Manifest.permission.NETWORK_SETTINGS,
5585 android.Manifest.permission.NETWORK_STACK,
5586 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK
5587 })
5588 public void requestBackgroundNetwork(@NonNull NetworkRequest request,
junyulaica657cb2021-04-15 00:39:49 +08005589 @NonNull NetworkCallback networkCallback,
5590 @SuppressLint("ListenerLast") @NonNull Handler handler) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005591 final NetworkCapabilities nc = request.networkCapabilities;
5592 sendRequestForNetwork(nc, networkCallback, 0, BACKGROUND_REQUEST,
junyulaidbb70462021-03-09 20:49:48 +08005593 TYPE_NONE, new CallbackHandler(handler));
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005594 }
James Mattis12aeab82021-01-10 14:24:24 -08005595
5596 /**
James Mattis12aeab82021-01-10 14:24:24 -08005597 * Used by automotive devices to set the network preferences used to direct traffic at an
5598 * application level as per the given OemNetworkPreferences. An example use-case would be an
5599 * automotive OEM wanting to provide connectivity for applications critical to the usage of a
5600 * vehicle via a particular network.
5601 *
5602 * Calling this will overwrite the existing preference.
5603 *
5604 * @param preference {@link OemNetworkPreferences} The application network preference to be set.
5605 * @param executor the executor on which listener will be invoked.
5606 * @param listener {@link OnSetOemNetworkPreferenceListener} optional listener used to
5607 * communicate completion of setOemNetworkPreference(). This will only be
5608 * called once upon successful completion of setOemNetworkPreference().
5609 * @throws IllegalArgumentException if {@code preference} contains invalid preference values.
5610 * @throws SecurityException if missing the appropriate permissions.
5611 * @throws UnsupportedOperationException if called on a non-automotive device.
James Mattis6e2d7022021-01-26 16:23:52 -08005612 * @hide
James Mattis12aeab82021-01-10 14:24:24 -08005613 */
James Mattis6e2d7022021-01-26 16:23:52 -08005614 @SystemApi
James Mattisa46c1442021-01-26 14:05:36 -08005615 @RequiresPermission(android.Manifest.permission.CONTROL_OEM_PAID_NETWORK_PREFERENCE)
James Mattis6e2d7022021-01-26 16:23:52 -08005616 public void setOemNetworkPreference(@NonNull final OemNetworkPreferences preference,
James Mattis12aeab82021-01-10 14:24:24 -08005617 @Nullable @CallbackExecutor final Executor executor,
Chalard Jean0a4aefc2021-03-03 16:37:13 +09005618 @Nullable final Runnable listener) {
James Mattis12aeab82021-01-10 14:24:24 -08005619 Objects.requireNonNull(preference, "OemNetworkPreferences must be non-null");
5620 if (null != listener) {
5621 Objects.requireNonNull(executor, "Executor must be non-null");
5622 }
Chalard Jean0a4aefc2021-03-03 16:37:13 +09005623 final IOnCompleteListener listenerInternal = listener == null ? null :
5624 new IOnCompleteListener.Stub() {
James Mattis12aeab82021-01-10 14:24:24 -08005625 @Override
5626 public void onComplete() {
Chalard Jean0a4aefc2021-03-03 16:37:13 +09005627 executor.execute(listener::run);
James Mattis12aeab82021-01-10 14:24:24 -08005628 }
5629 };
5630
5631 try {
5632 mService.setOemNetworkPreference(preference, listenerInternal);
5633 } catch (RemoteException e) {
5634 Log.e(TAG, "setOemNetworkPreference() failed for preference: " + preference.toString());
5635 throw e.rethrowFromSystemServer();
5636 }
5637 }
lucaslin5cdbcfb2021-03-12 00:46:33 +08005638
Chalard Jeanad565e22021-02-25 17:23:40 +09005639 /**
5640 * Request that a user profile is put by default on a network matching a given preference.
5641 *
5642 * See the documentation for the individual preferences for a description of the supported
5643 * behaviors.
5644 *
5645 * @param profile the profile concerned.
5646 * @param preference the preference for this profile.
5647 * @param executor an executor to execute the listener on. Optional if listener is null.
5648 * @param listener an optional listener to listen for completion of the operation.
5649 * @throws IllegalArgumentException if {@code profile} is not a valid user profile.
5650 * @throws SecurityException if missing the appropriate permissions.
Sooraj Sasindrane7aee272021-11-24 20:26:55 -08005651 * @deprecated Use {@link #setProfileNetworkPreferences(UserHandle, List, Executor, Runnable)}
5652 * instead as it provides a more flexible API with more options.
Chalard Jeanad565e22021-02-25 17:23:40 +09005653 * @hide
5654 */
Chalard Jean0a4aefc2021-03-03 16:37:13 +09005655 // This function is for establishing per-profile default networking and can only be called by
5656 // the device policy manager, running as the system server. It would make no sense to call it
5657 // on a context for a user because it does not establish a setting on behalf of a user, rather
5658 // it establishes a setting for a user on behalf of the DPM.
5659 @SuppressLint({"UserHandle"})
5660 @SystemApi(client = MODULE_LIBRARIES)
Chalard Jeanad565e22021-02-25 17:23:40 +09005661 @RequiresPermission(android.Manifest.permission.NETWORK_STACK)
Sooraj Sasindrane7aee272021-11-24 20:26:55 -08005662 @Deprecated
Chalard Jeanad565e22021-02-25 17:23:40 +09005663 public void setProfileNetworkPreference(@NonNull final UserHandle profile,
Sooraj Sasindrane7aee272021-11-24 20:26:55 -08005664 @ProfileNetworkPreferencePolicy final int preference,
5665 @Nullable @CallbackExecutor final Executor executor,
5666 @Nullable final Runnable listener) {
5667
5668 ProfileNetworkPreference.Builder preferenceBuilder =
5669 new ProfileNetworkPreference.Builder();
5670 preferenceBuilder.setPreference(preference);
Sooraj Sasindranf4a58dc2022-01-21 13:37:08 -08005671 if (preference != PROFILE_NETWORK_PREFERENCE_DEFAULT) {
5672 preferenceBuilder.setPreferenceEnterpriseId(NET_ENTERPRISE_ID_1);
5673 }
Sooraj Sasindrane7aee272021-11-24 20:26:55 -08005674 setProfileNetworkPreferences(profile,
5675 List.of(preferenceBuilder.build()), executor, listener);
5676 }
5677
5678 /**
5679 * Set a list of default network selection policies for a user profile.
5680 *
5681 * Calling this API with a user handle defines the entire policy for that user handle.
5682 * It will overwrite any setting previously set for the same user profile,
5683 * and not affect previously set settings for other handles.
5684 *
5685 * Call this API with an empty list to remove settings for this user profile.
5686 *
5687 * See {@link ProfileNetworkPreference} for more details on each preference
5688 * parameter.
5689 *
5690 * @param profile the user profile for which the preference is being set.
5691 * @param profileNetworkPreferences the list of profile network preferences for the
5692 * provided profile.
5693 * @param executor an executor to execute the listener on. Optional if listener is null.
5694 * @param listener an optional listener to listen for completion of the operation.
5695 * @throws IllegalArgumentException if {@code profile} is not a valid user profile.
5696 * @throws SecurityException if missing the appropriate permissions.
5697 * @hide
5698 */
5699 @SystemApi(client = MODULE_LIBRARIES)
5700 @RequiresPermission(android.Manifest.permission.NETWORK_STACK)
5701 public void setProfileNetworkPreferences(
5702 @NonNull final UserHandle profile,
5703 @NonNull List<ProfileNetworkPreference> profileNetworkPreferences,
Chalard Jeanad565e22021-02-25 17:23:40 +09005704 @Nullable @CallbackExecutor final Executor executor,
5705 @Nullable final Runnable listener) {
5706 if (null != listener) {
5707 Objects.requireNonNull(executor, "Pass a non-null executor, or a null listener");
5708 }
5709 final IOnCompleteListener proxy;
5710 if (null == listener) {
5711 proxy = null;
5712 } else {
5713 proxy = new IOnCompleteListener.Stub() {
5714 @Override
5715 public void onComplete() {
5716 executor.execute(listener::run);
5717 }
5718 };
5719 }
5720 try {
Sooraj Sasindrane7aee272021-11-24 20:26:55 -08005721 mService.setProfileNetworkPreferences(profile, profileNetworkPreferences, proxy);
Chalard Jeanad565e22021-02-25 17:23:40 +09005722 } catch (RemoteException e) {
5723 throw e.rethrowFromSystemServer();
5724 }
5725 }
5726
lucaslin5cdbcfb2021-03-12 00:46:33 +08005727 // The first network ID of IPSec tunnel interface.
lucaslinc296fcc2021-03-15 17:24:12 +08005728 private static final int TUN_INTF_NETID_START = 0xFC00; // 0xFC00 = 64512
lucaslin5cdbcfb2021-03-12 00:46:33 +08005729 // The network ID range of IPSec tunnel interface.
lucaslinc296fcc2021-03-15 17:24:12 +08005730 private static final int TUN_INTF_NETID_RANGE = 0x0400; // 0x0400 = 1024
lucaslin5cdbcfb2021-03-12 00:46:33 +08005731
5732 /**
5733 * Get the network ID range reserved for IPSec tunnel interfaces.
5734 *
5735 * @return A Range which indicates the network ID range of IPSec tunnel interface.
5736 * @hide
5737 */
5738 @SystemApi(client = MODULE_LIBRARIES)
5739 @NonNull
5740 public static Range<Integer> getIpSecNetIdRange() {
5741 return new Range(TUN_INTF_NETID_START, TUN_INTF_NETID_START + TUN_INTF_NETID_RANGE - 1);
5742 }
markchien738ad912021-12-09 18:15:45 +08005743
5744 /**
markchiene46042b2022-03-02 18:07:35 +08005745 * Adds the specified UID to the list of UIds that are allowed to use data on metered networks
5746 * even when background data is restricted. The deny list takes precedence over the allow list.
markchien738ad912021-12-09 18:15:45 +08005747 *
5748 * @param uid uid of target app
markchien68cfadc2022-01-14 13:39:54 +08005749 * @throws IllegalStateException if updating allow list failed.
markchien738ad912021-12-09 18:15:45 +08005750 * @hide
5751 */
5752 @SystemApi(client = MODULE_LIBRARIES)
5753 @RequiresPermission(anyOf = {
5754 android.Manifest.permission.NETWORK_SETTINGS,
5755 android.Manifest.permission.NETWORK_STACK,
5756 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK
5757 })
markchiene46042b2022-03-02 18:07:35 +08005758 public void addUidToMeteredNetworkAllowList(final int uid) {
markchien738ad912021-12-09 18:15:45 +08005759 try {
markchiene46042b2022-03-02 18:07:35 +08005760 mService.updateMeteredNetworkAllowList(uid, true /* add */);
markchien738ad912021-12-09 18:15:45 +08005761 } catch (RemoteException e) {
5762 throw e.rethrowFromSystemServer();
markchien738ad912021-12-09 18:15:45 +08005763 }
5764 }
5765
5766 /**
markchiene46042b2022-03-02 18:07:35 +08005767 * Removes the specified UID from the list of UIDs that are allowed to use background data on
5768 * metered networks when background data is restricted. The deny list takes precedence over
5769 * the allow list.
5770 *
5771 * @param uid uid of target app
5772 * @throws IllegalStateException if updating allow list failed.
5773 * @hide
5774 */
5775 @SystemApi(client = MODULE_LIBRARIES)
5776 @RequiresPermission(anyOf = {
5777 android.Manifest.permission.NETWORK_SETTINGS,
5778 android.Manifest.permission.NETWORK_STACK,
5779 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK
5780 })
5781 public void removeUidFromMeteredNetworkAllowList(final int uid) {
5782 try {
5783 mService.updateMeteredNetworkAllowList(uid, false /* remove */);
5784 } catch (RemoteException e) {
5785 throw e.rethrowFromSystemServer();
5786 }
5787 }
5788
5789 /**
5790 * Adds the specified UID to the list of UIDs that are not allowed to use background data on
5791 * metered networks. Takes precedence over {@link #addUidToMeteredNetworkAllowList}.
markchien738ad912021-12-09 18:15:45 +08005792 *
5793 * @param uid uid of target app
markchien68cfadc2022-01-14 13:39:54 +08005794 * @throws IllegalStateException if updating deny list failed.
markchien738ad912021-12-09 18:15:45 +08005795 * @hide
5796 */
5797 @SystemApi(client = MODULE_LIBRARIES)
5798 @RequiresPermission(anyOf = {
5799 android.Manifest.permission.NETWORK_SETTINGS,
5800 android.Manifest.permission.NETWORK_STACK,
5801 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK
5802 })
markchiene46042b2022-03-02 18:07:35 +08005803 public void addUidToMeteredNetworkDenyList(final int uid) {
markchien738ad912021-12-09 18:15:45 +08005804 try {
markchiene46042b2022-03-02 18:07:35 +08005805 mService.updateMeteredNetworkDenyList(uid, true /* add */);
5806 } catch (RemoteException e) {
5807 throw e.rethrowFromSystemServer();
5808 }
5809 }
5810
5811 /**
5812 * Removes the specified UID from the list of UIds that can use use background data on metered
5813 * networks if background data is not restricted. The deny list takes precedence over the
5814 * allow list.
5815 *
5816 * @param uid uid of target app
5817 * @throws IllegalStateException if updating deny list failed.
5818 * @hide
5819 */
5820 @SystemApi(client = MODULE_LIBRARIES)
5821 @RequiresPermission(anyOf = {
5822 android.Manifest.permission.NETWORK_SETTINGS,
5823 android.Manifest.permission.NETWORK_STACK,
5824 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK
5825 })
5826 public void removeUidFromMeteredNetworkDenyList(final int uid) {
5827 try {
5828 mService.updateMeteredNetworkDenyList(uid, false /* remove */);
markchien738ad912021-12-09 18:15:45 +08005829 } catch (RemoteException e) {
5830 throw e.rethrowFromSystemServer();
markchiene1561fa2021-12-09 22:00:56 +08005831 }
5832 }
5833
5834 /**
5835 * Sets a firewall rule for the specified UID on the specified chain.
5836 *
5837 * @param chain target chain.
5838 * @param uid uid to allow/deny.
markchien3c04e662022-03-22 16:29:56 +08005839 * @param rule firewall rule to allow/drop packets.
markchien68cfadc2022-01-14 13:39:54 +08005840 * @throws IllegalStateException if updating firewall rule failed.
markchien3c04e662022-03-22 16:29:56 +08005841 * @throws IllegalArgumentException if {@code rule} is not a valid rule.
markchiene1561fa2021-12-09 22:00:56 +08005842 * @hide
5843 */
5844 @SystemApi(client = MODULE_LIBRARIES)
5845 @RequiresPermission(anyOf = {
5846 android.Manifest.permission.NETWORK_SETTINGS,
5847 android.Manifest.permission.NETWORK_STACK,
5848 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK
5849 })
markchien3c04e662022-03-22 16:29:56 +08005850 public void setUidFirewallRule(@FirewallChain final int chain, final int uid,
5851 @FirewallRule final int rule) {
markchiene1561fa2021-12-09 22:00:56 +08005852 try {
markchien3c04e662022-03-22 16:29:56 +08005853 mService.setUidFirewallRule(chain, uid, rule);
markchiene1561fa2021-12-09 22:00:56 +08005854 } catch (RemoteException e) {
5855 throw e.rethrowFromSystemServer();
markchien738ad912021-12-09 18:15:45 +08005856 }
5857 }
markchien98a6f952022-01-13 23:43:53 +08005858
5859 /**
5860 * Enables or disables the specified firewall chain.
5861 *
5862 * @param chain target chain.
5863 * @param enable whether the chain should be enabled.
markchien68cfadc2022-01-14 13:39:54 +08005864 * @throws IllegalStateException if enabling or disabling the firewall chain failed.
markchien98a6f952022-01-13 23:43:53 +08005865 * @hide
5866 */
5867 @SystemApi(client = MODULE_LIBRARIES)
5868 @RequiresPermission(anyOf = {
5869 android.Manifest.permission.NETWORK_SETTINGS,
5870 android.Manifest.permission.NETWORK_STACK,
5871 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK
5872 })
5873 public void setFirewallChainEnabled(@FirewallChain final int chain, final boolean enable) {
5874 try {
5875 mService.setFirewallChainEnabled(chain, enable);
5876 } catch (RemoteException e) {
5877 throw e.rethrowFromSystemServer();
5878 }
5879 }
markchien00a0bed2022-01-13 23:46:13 +08005880
5881 /**
5882 * Replaces the contents of the specified UID-based firewall chain.
5883 *
5884 * @param chain target chain to replace.
5885 * @param uids The list of UIDs to be placed into chain.
markchien68cfadc2022-01-14 13:39:54 +08005886 * @throws IllegalStateException if replacing the firewall chain failed.
markchien00a0bed2022-01-13 23:46:13 +08005887 * @throws IllegalArgumentException if {@code chain} is not a valid chain.
5888 * @hide
5889 */
5890 @SystemApi(client = MODULE_LIBRARIES)
5891 @RequiresPermission(anyOf = {
5892 android.Manifest.permission.NETWORK_SETTINGS,
5893 android.Manifest.permission.NETWORK_STACK,
5894 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK
5895 })
5896 public void replaceFirewallChain(@FirewallChain final int chain, @NonNull final int[] uids) {
5897 Objects.requireNonNull(uids);
5898 try {
5899 mService.replaceFirewallChain(chain, uids);
5900 } catch (RemoteException e) {
5901 throw e.rethrowFromSystemServer();
5902 }
5903 }
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005904}