blob: ea1ba089f92df202927ae5c9d85bc8c890d4742e [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
chiachangwang9473c592022-07-15 02:25:52 +0000559 * appropriate network. See {@link NetworkCapabilities} for supported transports.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +0900560 */
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
chiachangwang9473c592022-07-15 02:25:52 +0000569 * appropriate network. See {@link NetworkCapabilities} for supported transports.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +0900570 */
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
chiachangwang9473c592022-07-15 02:25:52 +0000620 * appropriate network. See {@link NetworkCapabilities} for supported transports.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +0900621 */
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
chiachangwang9473c592022-07-15 02:25:52 +0000630 * appropriate network. See {@link NetworkCapabilities} for supported transports.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +0900631 */
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
chiachangwang9473c592022-07-15 02:25:52 +0000640 * appropriate network. See {@link NetworkCapabilities} for supported transports.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +0900641 */
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
chiachangwang9473c592022-07-15 02:25:52 +0000657 * appropriate network. See {@link NetworkCapabilities} for supported transports.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +0900658 */
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
Motomu Utsumib08654c2022-05-11 05:56:26 +0000985 /**
Motomu Utsumid9801492022-06-01 13:57:27 +0000986 * Firewall chain used for OEM-specific application restrictions.
Lorenzo Colittif683c402022-08-03 10:40:00 +0900987 *
988 * Denylist of apps that will not have network access due to OEM-specific restrictions. If an
989 * app UID is placed on this chain, and the chain is enabled, the app's packets will be dropped.
990 *
991 * All the {@code FIREWALL_CHAIN_OEM_DENY_x} chains are equivalent, and each one is
992 * independent of the others. The chains can be enabled and disabled independently, and apps can
993 * be added and removed from each chain independently.
994 *
995 * @see #FIREWALL_CHAIN_OEM_DENY_2
996 * @see #FIREWALL_CHAIN_OEM_DENY_3
Motomu Utsumid9801492022-06-01 13:57:27 +0000997 * @hide
998 */
Motomu Utsumi62385c82022-06-12 11:37:19 +0000999 @SystemApi(client = MODULE_LIBRARIES)
Motomu Utsumid9801492022-06-01 13:57:27 +00001000 public static final int FIREWALL_CHAIN_OEM_DENY_1 = 7;
1001
1002 /**
1003 * Firewall chain used for OEM-specific application restrictions.
Lorenzo Colittif683c402022-08-03 10:40:00 +09001004 *
1005 * Denylist of apps that will not have network access due to OEM-specific restrictions. If an
1006 * app UID is placed on this chain, and the chain is enabled, the app's packets will be dropped.
1007 *
1008 * All the {@code FIREWALL_CHAIN_OEM_DENY_x} chains are equivalent, and each one is
1009 * independent of the others. The chains can be enabled and disabled independently, and apps can
1010 * be added and removed from each chain independently.
1011 *
1012 * @see #FIREWALL_CHAIN_OEM_DENY_1
1013 * @see #FIREWALL_CHAIN_OEM_DENY_3
Motomu Utsumid9801492022-06-01 13:57:27 +00001014 * @hide
1015 */
Motomu Utsumi62385c82022-06-12 11:37:19 +00001016 @SystemApi(client = MODULE_LIBRARIES)
Motomu Utsumid9801492022-06-01 13:57:27 +00001017 public static final int FIREWALL_CHAIN_OEM_DENY_2 = 8;
1018
Motomu Utsumi1d9054b2022-06-06 07:44:05 +00001019 /**
1020 * Firewall chain used for OEM-specific application restrictions.
Lorenzo Colittif683c402022-08-03 10:40:00 +09001021 *
1022 * Denylist of apps that will not have network access due to OEM-specific restrictions. If an
1023 * app UID is placed on this chain, and the chain is enabled, the app's packets will be dropped.
1024 *
1025 * All the {@code FIREWALL_CHAIN_OEM_DENY_x} chains are equivalent, and each one is
1026 * independent of the others. The chains can be enabled and disabled independently, and apps can
1027 * be added and removed from each chain independently.
1028 *
1029 * @see #FIREWALL_CHAIN_OEM_DENY_1
1030 * @see #FIREWALL_CHAIN_OEM_DENY_2
Motomu Utsumi1d9054b2022-06-06 07:44:05 +00001031 * @hide
1032 */
Motomu Utsumi62385c82022-06-12 11:37:19 +00001033 @SystemApi(client = MODULE_LIBRARIES)
Motomu Utsumi1d9054b2022-06-06 07:44:05 +00001034 public static final int FIREWALL_CHAIN_OEM_DENY_3 = 9;
1035
markchiene1561fa2021-12-09 22:00:56 +08001036 /** @hide */
1037 @Retention(RetentionPolicy.SOURCE)
1038 @IntDef(flag = false, prefix = "FIREWALL_CHAIN_", value = {
1039 FIREWALL_CHAIN_DOZABLE,
1040 FIREWALL_CHAIN_STANDBY,
1041 FIREWALL_CHAIN_POWERSAVE,
Robert Horvath34cba142022-01-27 19:52:43 +01001042 FIREWALL_CHAIN_RESTRICTED,
Motomu Utsumib08654c2022-05-11 05:56:26 +00001043 FIREWALL_CHAIN_LOW_POWER_STANDBY,
Motomu Utsumid9801492022-06-01 13:57:27 +00001044 FIREWALL_CHAIN_OEM_DENY_1,
Motomu Utsumi1d9054b2022-06-06 07:44:05 +00001045 FIREWALL_CHAIN_OEM_DENY_2,
1046 FIREWALL_CHAIN_OEM_DENY_3
markchiene1561fa2021-12-09 22:00:56 +08001047 })
1048 public @interface FirewallChain {}
Robert Horvathd945bf02022-01-27 19:55:16 +01001049 // LINT.ThenChange(packages/modules/Connectivity/service/native/include/Common.h)
markchiene1561fa2021-12-09 22:00:56 +08001050
1051 /**
markchien011a7f52022-03-29 01:07:22 +08001052 * A firewall rule which allows or drops packets depending on existing policy.
1053 * Used by {@link #setUidFirewallRule(int, int, int)} to follow existing policy to handle
1054 * specific uid's packets in specific firewall chain.
markchien3c04e662022-03-22 16:29:56 +08001055 * @hide
1056 */
1057 @SystemApi(client = MODULE_LIBRARIES)
1058 public static final int FIREWALL_RULE_DEFAULT = 0;
1059
1060 /**
markchien011a7f52022-03-29 01:07:22 +08001061 * A firewall rule which allows packets. Used by {@link #setUidFirewallRule(int, int, int)} to
1062 * allow specific uid's packets in specific firewall chain.
markchien3c04e662022-03-22 16:29:56 +08001063 * @hide
1064 */
1065 @SystemApi(client = MODULE_LIBRARIES)
1066 public static final int FIREWALL_RULE_ALLOW = 1;
1067
1068 /**
markchien011a7f52022-03-29 01:07:22 +08001069 * A firewall rule which drops packets. Used by {@link #setUidFirewallRule(int, int, int)} to
1070 * drop specific uid's packets in specific firewall chain.
markchien3c04e662022-03-22 16:29:56 +08001071 * @hide
1072 */
1073 @SystemApi(client = MODULE_LIBRARIES)
1074 public static final int FIREWALL_RULE_DENY = 2;
1075
1076 /** @hide */
1077 @Retention(RetentionPolicy.SOURCE)
1078 @IntDef(flag = false, prefix = "FIREWALL_RULE_", value = {
1079 FIREWALL_RULE_DEFAULT,
1080 FIREWALL_RULE_ALLOW,
1081 FIREWALL_RULE_DENY
1082 })
1083 public @interface FirewallRule {}
1084
1085 /**
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001086 * A kludge to facilitate static access where a Context pointer isn't available, like in the
1087 * case of the static set/getProcessDefaultNetwork methods and from the Network class.
1088 * TODO: Remove this after deprecating the static methods in favor of non-static methods or
1089 * methods that take a Context argument.
1090 */
1091 private static ConnectivityManager sInstance;
1092
1093 private final Context mContext;
1094
Remi NGUYEN VANe4d1cd92021-06-17 16:27:31 +09001095 @GuardedBy("mTetheringEventCallbacks")
1096 private TetheringManager mTetheringManager;
1097
1098 private TetheringManager getTetheringManager() {
1099 synchronized (mTetheringEventCallbacks) {
1100 if (mTetheringManager == null) {
1101 mTetheringManager = mContext.getSystemService(TetheringManager.class);
1102 }
1103 return mTetheringManager;
1104 }
1105 }
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001106
1107 /**
1108 * Tests if a given integer represents a valid network type.
1109 * @param networkType the type to be tested
Chalard Jean0c7ebe92022-08-03 14:45:47 +09001110 * @return {@code true} if the type is valid, else {@code false}
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001111 * @deprecated All APIs accepting a network type are deprecated. There should be no need to
1112 * validate a network type.
1113 */
1114 @Deprecated
1115 public static boolean isNetworkTypeValid(int networkType) {
1116 return MIN_NETWORK_TYPE <= networkType && networkType <= MAX_NETWORK_TYPE;
1117 }
1118
1119 /**
1120 * Returns a non-localized string representing a given network type.
1121 * ONLY used for debugging output.
1122 * @param type the type needing naming
1123 * @return a String for the given type, or a string version of the type ("87")
1124 * if no name is known.
1125 * @deprecated Types are deprecated. Use {@link NetworkCapabilities} instead.
1126 * {@hide}
1127 */
1128 @Deprecated
1129 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
1130 public static String getNetworkTypeName(int type) {
1131 switch (type) {
1132 case TYPE_NONE:
1133 return "NONE";
1134 case TYPE_MOBILE:
1135 return "MOBILE";
1136 case TYPE_WIFI:
1137 return "WIFI";
1138 case TYPE_MOBILE_MMS:
1139 return "MOBILE_MMS";
1140 case TYPE_MOBILE_SUPL:
1141 return "MOBILE_SUPL";
1142 case TYPE_MOBILE_DUN:
1143 return "MOBILE_DUN";
1144 case TYPE_MOBILE_HIPRI:
1145 return "MOBILE_HIPRI";
1146 case TYPE_WIMAX:
1147 return "WIMAX";
1148 case TYPE_BLUETOOTH:
1149 return "BLUETOOTH";
1150 case TYPE_DUMMY:
1151 return "DUMMY";
1152 case TYPE_ETHERNET:
1153 return "ETHERNET";
1154 case TYPE_MOBILE_FOTA:
1155 return "MOBILE_FOTA";
1156 case TYPE_MOBILE_IMS:
1157 return "MOBILE_IMS";
1158 case TYPE_MOBILE_CBS:
1159 return "MOBILE_CBS";
1160 case TYPE_WIFI_P2P:
1161 return "WIFI_P2P";
1162 case TYPE_MOBILE_IA:
1163 return "MOBILE_IA";
1164 case TYPE_MOBILE_EMERGENCY:
1165 return "MOBILE_EMERGENCY";
1166 case TYPE_PROXY:
1167 return "PROXY";
1168 case TYPE_VPN:
1169 return "VPN";
Junyu Laic9f1ca62022-07-25 16:31:59 +08001170 case TYPE_TEST:
1171 return "TEST";
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001172 default:
1173 return Integer.toString(type);
1174 }
1175 }
1176
1177 /**
1178 * @hide
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001179 */
lucaslin10774b72021-03-17 14:16:01 +08001180 @SystemApi(client = MODULE_LIBRARIES)
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001181 public void systemReady() {
1182 try {
1183 mService.systemReady();
1184 } catch (RemoteException e) {
1185 throw e.rethrowFromSystemServer();
1186 }
1187 }
1188
1189 /**
1190 * Checks if a given type uses the cellular data connection.
1191 * This should be replaced in the future by a network property.
1192 * @param networkType the type to check
1193 * @return a boolean - {@code true} if uses cellular network, else {@code false}
1194 * @deprecated Types are deprecated. Use {@link NetworkCapabilities} instead.
1195 * {@hide}
1196 */
1197 @Deprecated
1198 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 130143562)
1199 public static boolean isNetworkTypeMobile(int networkType) {
1200 switch (networkType) {
1201 case TYPE_MOBILE:
1202 case TYPE_MOBILE_MMS:
1203 case TYPE_MOBILE_SUPL:
1204 case TYPE_MOBILE_DUN:
1205 case TYPE_MOBILE_HIPRI:
1206 case TYPE_MOBILE_FOTA:
1207 case TYPE_MOBILE_IMS:
1208 case TYPE_MOBILE_CBS:
1209 case TYPE_MOBILE_IA:
1210 case TYPE_MOBILE_EMERGENCY:
1211 return true;
1212 default:
1213 return false;
1214 }
1215 }
1216
1217 /**
1218 * Checks if the given network type is backed by a Wi-Fi radio.
1219 *
1220 * @deprecated Types are deprecated. Use {@link NetworkCapabilities} instead.
1221 * @hide
1222 */
1223 @Deprecated
1224 public static boolean isNetworkTypeWifi(int networkType) {
1225 switch (networkType) {
1226 case TYPE_WIFI:
1227 case TYPE_WIFI_P2P:
1228 return true;
1229 default:
1230 return false;
1231 }
1232 }
1233
1234 /**
Junyu Lai35665cc2022-12-19 17:37:48 +08001235 * Preference for {@link ProfileNetworkPreference.Builder#setPreference(int)}.
chiachangwang9473c592022-07-15 02:25:52 +00001236 * See {@link #setProfileNetworkPreferences(UserHandle, List, Executor, Runnable)}
Junyu Lai35665cc2022-12-19 17:37:48 +08001237 * Specify that the traffic for this user should by follow the default rules:
1238 * applications in the profile designated by the UserHandle behave like any
1239 * other application and use the system default network as their default
1240 * network. Compare other PROFILE_NETWORK_PREFERENCE_* settings.
Chalard Jeanad565e22021-02-25 17:23:40 +09001241 * @hide
1242 */
Chalard Jeanbef6b092021-03-17 14:33:24 +09001243 @SystemApi(client = MODULE_LIBRARIES)
Chalard Jeanad565e22021-02-25 17:23:40 +09001244 public static final int PROFILE_NETWORK_PREFERENCE_DEFAULT = 0;
1245
1246 /**
Junyu Lai35665cc2022-12-19 17:37:48 +08001247 * Preference for {@link ProfileNetworkPreference.Builder#setPreference(int)}.
chiachangwang9473c592022-07-15 02:25:52 +00001248 * See {@link #setProfileNetworkPreferences(UserHandle, List, Executor, Runnable)}
Chalard Jeanad565e22021-02-25 17:23:40 +09001249 * Specify that the traffic for this user should by default go on a network with
1250 * {@link NetworkCapabilities#NET_CAPABILITY_ENTERPRISE}, and on the system default network
1251 * if no such network is available.
1252 * @hide
1253 */
Chalard Jeanbef6b092021-03-17 14:33:24 +09001254 @SystemApi(client = MODULE_LIBRARIES)
Chalard Jeanad565e22021-02-25 17:23:40 +09001255 public static final int PROFILE_NETWORK_PREFERENCE_ENTERPRISE = 1;
1256
Sooraj Sasindran06baf4c2021-11-29 12:21:09 -08001257 /**
Junyu Lai35665cc2022-12-19 17:37:48 +08001258 * Preference for {@link ProfileNetworkPreference.Builder#setPreference(int)}.
chiachangwang9473c592022-07-15 02:25:52 +00001259 * See {@link #setProfileNetworkPreferences(UserHandle, List, Executor, Runnable)}
Sooraj Sasindran06baf4c2021-11-29 12:21:09 -08001260 * Specify that the traffic for this user should by default go on a network with
1261 * {@link NetworkCapabilities#NET_CAPABILITY_ENTERPRISE} and if no such network is available
Junyu Lai35665cc2022-12-19 17:37:48 +08001262 * should not have a default network at all (that is, network accesses that
1263 * do not specify a network explicitly terminate with an error), even if there
1264 * is a system default network available to apps outside this preference.
1265 * The apps can still use a non-enterprise network if they request it explicitly
1266 * provided that specific network doesn't require any specific permission they
1267 * do not hold.
Sooraj Sasindran06baf4c2021-11-29 12:21:09 -08001268 * @hide
1269 */
1270 @SystemApi(client = MODULE_LIBRARIES)
1271 public static final int PROFILE_NETWORK_PREFERENCE_ENTERPRISE_NO_FALLBACK = 2;
1272
Junyu Lai35665cc2022-12-19 17:37:48 +08001273 /**
1274 * Preference for {@link ProfileNetworkPreference.Builder#setPreference(int)}.
1275 * See {@link #setProfileNetworkPreferences(UserHandle, List, Executor, Runnable)}
1276 * Specify that the traffic for this user should by default go on a network with
1277 * {@link NetworkCapabilities#NET_CAPABILITY_ENTERPRISE}.
1278 * If there is no such network, the apps will have no default
1279 * network at all, even if there are available non-enterprise networks on the
1280 * device (that is, network accesses that do not specify a network explicitly
1281 * terminate with an error). Additionally, the designated apps should be
1282 * blocked from using any non-enterprise network even if they specify it
1283 * explicitly, unless they hold specific privilege overriding this (see
1284 * {@link android.Manifest.permission.CONNECTIVITY_USE_RESTRICTED_NETWORKS}).
1285 * @hide
1286 */
1287 @SystemApi(client = MODULE_LIBRARIES)
1288 public static final int PROFILE_NETWORK_PREFERENCE_ENTERPRISE_BLOCKING = 3;
1289
Chalard Jeanad565e22021-02-25 17:23:40 +09001290 /** @hide */
1291 @Retention(RetentionPolicy.SOURCE)
1292 @IntDef(value = {
1293 PROFILE_NETWORK_PREFERENCE_DEFAULT,
Sooraj Sasindran06baf4c2021-11-29 12:21:09 -08001294 PROFILE_NETWORK_PREFERENCE_ENTERPRISE,
1295 PROFILE_NETWORK_PREFERENCE_ENTERPRISE_NO_FALLBACK
Chalard Jeanad565e22021-02-25 17:23:40 +09001296 })
Sooraj Sasindrane7aee272021-11-24 20:26:55 -08001297 public @interface ProfileNetworkPreferencePolicy {
Chalard Jeanad565e22021-02-25 17:23:40 +09001298 }
1299
1300 /**
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001301 * Specifies the preferred network type. When the device has more
1302 * than one type available the preferred network type will be used.
1303 *
1304 * @param preference the network type to prefer over all others. It is
1305 * unspecified what happens to the old preferred network in the
1306 * overall ordering.
1307 * @deprecated Functionality has been removed as it no longer makes sense,
1308 * with many more than two networks - we'd need an array to express
1309 * preference. Instead we use dynamic network properties of
1310 * the networks to describe their precedence.
1311 */
1312 @Deprecated
1313 public void setNetworkPreference(int preference) {
1314 }
1315
1316 /**
1317 * Retrieves the current preferred network type.
1318 *
1319 * @return an integer representing the preferred network type
1320 *
1321 * @deprecated Functionality has been removed as it no longer makes sense,
1322 * with many more than two networks - we'd need an array to express
1323 * preference. Instead we use dynamic network properties of
1324 * the networks to describe their precedence.
1325 */
1326 @Deprecated
1327 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1328 public int getNetworkPreference() {
1329 return TYPE_NONE;
1330 }
1331
1332 /**
1333 * Returns details about the currently active default data network. When
1334 * connected, this network is the default route for outgoing connections.
1335 * You should always check {@link NetworkInfo#isConnected()} before initiating
1336 * network traffic. This may return {@code null} when there is no default
1337 * network.
1338 * Note that if the default network is a VPN, this method will return the
1339 * NetworkInfo for one of its underlying networks instead, or null if the
1340 * VPN agent did not specify any. Apps interested in learning about VPNs
1341 * should use {@link #getNetworkInfo(android.net.Network)} instead.
1342 *
1343 * @return a {@link NetworkInfo} object for the current default network
1344 * or {@code null} if no default network is currently active
1345 * @deprecated See {@link NetworkInfo}.
1346 */
1347 @Deprecated
1348 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1349 @Nullable
1350 public NetworkInfo getActiveNetworkInfo() {
1351 try {
1352 return mService.getActiveNetworkInfo();
1353 } catch (RemoteException e) {
1354 throw e.rethrowFromSystemServer();
1355 }
1356 }
1357
1358 /**
1359 * Returns a {@link Network} object corresponding to the currently active
1360 * default data network. In the event that the current active default data
1361 * network disconnects, the returned {@code Network} object will no longer
1362 * be usable. This will return {@code null} when there is no default
Chalard Jean0d051512021-09-28 15:31:15 +09001363 * network, or when the default network is blocked.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001364 *
1365 * @return a {@link Network} object for the current default network or
Chalard Jean0d051512021-09-28 15:31:15 +09001366 * {@code null} if no default network is currently active or if
1367 * the default network is blocked for the caller
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001368 */
1369 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1370 @Nullable
1371 public Network getActiveNetwork() {
1372 try {
1373 return mService.getActiveNetwork();
1374 } catch (RemoteException e) {
1375 throw e.rethrowFromSystemServer();
1376 }
1377 }
1378
1379 /**
1380 * Returns a {@link Network} object corresponding to the currently active
1381 * default data network for a specific UID. In the event that the default data
1382 * network disconnects, the returned {@code Network} object will no longer
1383 * be usable. This will return {@code null} when there is no default
1384 * network for the UID.
1385 *
1386 * @return a {@link Network} object for the current default network for the
1387 * given UID or {@code null} if no default network is currently active
lifrdb7d6762021-03-30 21:04:53 +08001388 *
1389 * @hide
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001390 */
1391 @RequiresPermission(android.Manifest.permission.NETWORK_STACK)
1392 @Nullable
1393 public Network getActiveNetworkForUid(int uid) {
1394 return getActiveNetworkForUid(uid, false);
1395 }
1396
1397 /** {@hide} */
1398 public Network getActiveNetworkForUid(int uid, boolean ignoreBlocked) {
1399 try {
1400 return mService.getActiveNetworkForUid(uid, ignoreBlocked);
1401 } catch (RemoteException e) {
1402 throw e.rethrowFromSystemServer();
1403 }
1404 }
1405
lucaslin3ba7cc22022-12-19 02:35:33 +00001406 private static UidRange[] getUidRangeArray(@NonNull Collection<Range<Integer>> ranges) {
1407 Objects.requireNonNull(ranges);
1408 final UidRange[] rangesArray = new UidRange[ranges.size()];
1409 int index = 0;
1410 for (Range<Integer> range : ranges) {
1411 rangesArray[index++] = new UidRange(range.getLower(), range.getUpper());
1412 }
1413
1414 return rangesArray;
1415 }
1416
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001417 /**
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001418 * Adds or removes a requirement for given UID ranges to use the VPN.
1419 *
1420 * If set to {@code true}, informs the system that the UIDs in the specified ranges must not
1421 * have any connectivity except if a VPN is connected and applies to the UIDs, or if the UIDs
1422 * otherwise have permission to bypass the VPN (e.g., because they have the
1423 * {@link android.Manifest.permission.CONNECTIVITY_USE_RESTRICTED_NETWORKS} permission, or when
1424 * using a socket protected by a method such as {@link VpnService#protect(DatagramSocket)}. If
1425 * set to {@code false}, a previously-added restriction is removed.
1426 * <p>
1427 * Each of the UID ranges specified by this method is added and removed as is, and no processing
1428 * is performed on the ranges to de-duplicate, merge, split, or intersect them. In order to
1429 * remove a previously-added range, the exact range must be removed as is.
1430 * <p>
1431 * The changes are applied asynchronously and may not have been applied by the time the method
1432 * returns. Apps will be notified about any changes that apply to them via
1433 * {@link NetworkCallback#onBlockedStatusChanged} callbacks called after the changes take
1434 * effect.
1435 * <p>
lucaslin3ba7cc22022-12-19 02:35:33 +00001436 * This method will block the specified UIDs from accessing non-VPN networks, but does not
1437 * affect what the UIDs get as their default network.
1438 * Compare {@link #setVpnDefaultForUids(String, Collection)}, which declares that the UIDs
1439 * should only have a VPN as their default network, but does not block them from accessing other
1440 * networks if they request them explicitly with the {@link Network} API.
1441 * <p>
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001442 * This method should be called only by the VPN code.
1443 *
1444 * @param ranges the UID ranges to restrict
1445 * @param requireVpn whether the specified UID ranges must use a VPN
1446 *
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001447 * @hide
1448 */
1449 @RequiresPermission(anyOf = {
1450 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
lucaslin97fb10a2021-03-22 11:51:27 +08001451 android.Manifest.permission.NETWORK_STACK,
1452 android.Manifest.permission.NETWORK_SETTINGS})
1453 @SystemApi(client = MODULE_LIBRARIES)
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001454 public void setRequireVpnForUids(boolean requireVpn,
1455 @NonNull Collection<Range<Integer>> ranges) {
1456 Objects.requireNonNull(ranges);
1457 // The Range class is not parcelable. Convert to UidRange, which is what is used internally.
1458 // This method is not necessarily expected to be used outside the system server, so
1459 // parceling may not be necessary, but it could be used out-of-process, e.g., by the network
1460 // stack process, or by tests.
lucaslin3ba7cc22022-12-19 02:35:33 +00001461 final UidRange[] rangesArray = getUidRangeArray(ranges);
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001462 try {
1463 mService.setRequireVpnForUids(requireVpn, rangesArray);
1464 } catch (RemoteException e) {
1465 throw e.rethrowFromSystemServer();
1466 }
1467 }
1468
1469 /**
lucaslin3ba7cc22022-12-19 02:35:33 +00001470 * Inform the system that this VPN session should manage the passed UIDs.
1471 *
1472 * A VPN with the specified session ID may call this method to inform the system that the UIDs
1473 * in the specified range are subject to a VPN.
1474 * When this is called, the system will only choose a VPN for the default network of the UIDs in
1475 * the specified ranges.
1476 *
1477 * This method declares that the UIDs in the range will only have a VPN for their default
1478 * network, but does not block the UIDs from accessing other networks (permissions allowing) by
1479 * explicitly requesting it with the {@link Network} API.
1480 * Compare {@link #setRequireVpnForUids(boolean, Collection)}, which does not affect what
1481 * network the UIDs get as default, but will block them from accessing non-VPN networks.
1482 *
1483 * @param session The VPN session which manages the passed UIDs.
1484 * @param ranges The uid ranges which will treat VPN as their only default network.
1485 *
1486 * @hide
1487 */
1488 @RequiresPermission(anyOf = {
1489 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
1490 android.Manifest.permission.NETWORK_STACK,
1491 android.Manifest.permission.NETWORK_SETTINGS})
1492 @SystemApi(client = MODULE_LIBRARIES)
1493 public void setVpnDefaultForUids(@NonNull String session,
1494 @NonNull Collection<Range<Integer>> ranges) {
1495 Objects.requireNonNull(ranges);
1496 final UidRange[] rangesArray = getUidRangeArray(ranges);
1497 try {
1498 mService.setVpnNetworkPreference(session, rangesArray);
1499 } catch (RemoteException e) {
1500 throw e.rethrowFromSystemServer();
1501 }
1502 }
1503
1504 /**
Lorenzo Colittic71cff82021-01-15 01:29:01 +09001505 * Informs ConnectivityService of whether the legacy lockdown VPN, as implemented by
1506 * LockdownVpnTracker, is in use. This is deprecated for new devices starting from Android 12
1507 * but is still supported for backwards compatibility.
1508 * <p>
1509 * This type of VPN is assumed always to use the system default network, and must always declare
1510 * exactly one underlying network, which is the network that was the default when the VPN
1511 * connected.
1512 * <p>
1513 * Calling this method with {@code true} enables legacy behaviour, specifically:
1514 * <ul>
1515 * <li>Any VPN that applies to userId 0 behaves specially with respect to deprecated
1516 * {@link #CONNECTIVITY_ACTION} broadcasts. Any such broadcasts will have the state in the
1517 * {@link #EXTRA_NETWORK_INFO} replaced by state of the VPN network. Also, any time the VPN
1518 * connects, a {@link #CONNECTIVITY_ACTION} broadcast will be sent for the network
1519 * underlying the VPN.</li>
1520 * <li>Deprecated APIs that return {@link NetworkInfo} objects will have their state
1521 * similarly replaced by the VPN network state.</li>
1522 * <li>Information on current network interfaces passed to NetworkStatsService will not
1523 * include any VPN interfaces.</li>
1524 * </ul>
1525 *
1526 * @param enabled whether legacy lockdown VPN is enabled or disabled
1527 *
Lorenzo Colittic71cff82021-01-15 01:29:01 +09001528 * @hide
1529 */
1530 @RequiresPermission(anyOf = {
1531 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
lucaslin97fb10a2021-03-22 11:51:27 +08001532 android.Manifest.permission.NETWORK_STACK,
Lorenzo Colittic71cff82021-01-15 01:29:01 +09001533 android.Manifest.permission.NETWORK_SETTINGS})
lucaslin97fb10a2021-03-22 11:51:27 +08001534 @SystemApi(client = MODULE_LIBRARIES)
Lorenzo Colittic71cff82021-01-15 01:29:01 +09001535 public void setLegacyLockdownVpnEnabled(boolean enabled) {
1536 try {
1537 mService.setLegacyLockdownVpnEnabled(enabled);
1538 } catch (RemoteException e) {
1539 throw e.rethrowFromSystemServer();
1540 }
1541 }
1542
1543 /**
Chalard Jean0c7ebe92022-08-03 14:45:47 +09001544 * Returns details about the currently active default data network for a given uid.
1545 * This is for privileged use only to avoid spying on other apps.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001546 *
1547 * @return a {@link NetworkInfo} object for the current default network
1548 * for the given uid or {@code null} if no default network is
1549 * available for the specified uid.
1550 *
1551 * {@hide}
1552 */
1553 @RequiresPermission(android.Manifest.permission.NETWORK_STACK)
1554 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
1555 public NetworkInfo getActiveNetworkInfoForUid(int uid) {
1556 return getActiveNetworkInfoForUid(uid, false);
1557 }
1558
1559 /** {@hide} */
1560 public NetworkInfo getActiveNetworkInfoForUid(int uid, boolean ignoreBlocked) {
1561 try {
1562 return mService.getActiveNetworkInfoForUid(uid, ignoreBlocked);
1563 } catch (RemoteException e) {
1564 throw e.rethrowFromSystemServer();
1565 }
1566 }
1567
1568 /**
Chalard Jean0c7ebe92022-08-03 14:45:47 +09001569 * Returns connection status information about a particular network type.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001570 *
1571 * @param networkType integer specifying which networkType in
1572 * which you're interested.
1573 * @return a {@link NetworkInfo} object for the requested
1574 * network type or {@code null} if the type is not
1575 * supported by the device. If {@code networkType} is
1576 * TYPE_VPN and a VPN is active for the calling app,
1577 * then this method will try to return one of the
1578 * underlying networks for the VPN or null if the
1579 * VPN agent didn't specify any.
1580 *
1581 * @deprecated This method does not support multiple connected networks
1582 * of the same type. Use {@link #getAllNetworks} and
1583 * {@link #getNetworkInfo(android.net.Network)} instead.
1584 */
1585 @Deprecated
1586 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1587 @Nullable
1588 public NetworkInfo getNetworkInfo(int networkType) {
1589 try {
1590 return mService.getNetworkInfo(networkType);
1591 } catch (RemoteException e) {
1592 throw e.rethrowFromSystemServer();
1593 }
1594 }
1595
1596 /**
Chalard Jean0c7ebe92022-08-03 14:45:47 +09001597 * Returns connection status information about a particular Network.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001598 *
1599 * @param network {@link Network} specifying which network
1600 * in which you're interested.
1601 * @return a {@link NetworkInfo} object for the requested
1602 * network or {@code null} if the {@code Network}
1603 * is not valid.
1604 * @deprecated See {@link NetworkInfo}.
1605 */
1606 @Deprecated
1607 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1608 @Nullable
1609 public NetworkInfo getNetworkInfo(@Nullable Network network) {
1610 return getNetworkInfoForUid(network, Process.myUid(), false);
1611 }
1612
1613 /** {@hide} */
1614 public NetworkInfo getNetworkInfoForUid(Network network, int uid, boolean ignoreBlocked) {
1615 try {
1616 return mService.getNetworkInfoForUid(network, uid, ignoreBlocked);
1617 } catch (RemoteException e) {
1618 throw e.rethrowFromSystemServer();
1619 }
1620 }
1621
1622 /**
Chalard Jean0c7ebe92022-08-03 14:45:47 +09001623 * Returns connection status information about all network types supported by the device.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001624 *
1625 * @return an array of {@link NetworkInfo} objects. Check each
1626 * {@link NetworkInfo#getType} for which type each applies.
1627 *
1628 * @deprecated This method does not support multiple connected networks
1629 * of the same type. Use {@link #getAllNetworks} and
1630 * {@link #getNetworkInfo(android.net.Network)} instead.
1631 */
1632 @Deprecated
1633 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1634 @NonNull
1635 public NetworkInfo[] getAllNetworkInfo() {
1636 try {
1637 return mService.getAllNetworkInfo();
1638 } catch (RemoteException e) {
1639 throw e.rethrowFromSystemServer();
1640 }
1641 }
1642
1643 /**
junyulaib1211372021-03-03 12:09:05 +08001644 * Return a list of {@link NetworkStateSnapshot}s, one for each network that is currently
1645 * connected.
1646 * @hide
1647 */
1648 @SystemApi(client = MODULE_LIBRARIES)
1649 @RequiresPermission(anyOf = {
1650 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
1651 android.Manifest.permission.NETWORK_STACK,
1652 android.Manifest.permission.NETWORK_SETTINGS})
1653 @NonNull
Aaron Huangab615e52021-04-17 13:46:25 +08001654 public List<NetworkStateSnapshot> getAllNetworkStateSnapshots() {
junyulaib1211372021-03-03 12:09:05 +08001655 try {
Aaron Huangab615e52021-04-17 13:46:25 +08001656 return mService.getAllNetworkStateSnapshots();
junyulaib1211372021-03-03 12:09:05 +08001657 } catch (RemoteException e) {
1658 throw e.rethrowFromSystemServer();
1659 }
1660 }
1661
1662 /**
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001663 * Returns the {@link Network} object currently serving a given type, or
1664 * null if the given type is not connected.
1665 *
1666 * @hide
1667 * @deprecated This method does not support multiple connected networks
1668 * of the same type. Use {@link #getAllNetworks} and
1669 * {@link #getNetworkInfo(android.net.Network)} instead.
1670 */
1671 @Deprecated
1672 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1673 @UnsupportedAppUsage
1674 public Network getNetworkForType(int networkType) {
1675 try {
1676 return mService.getNetworkForType(networkType);
1677 } catch (RemoteException e) {
1678 throw e.rethrowFromSystemServer();
1679 }
1680 }
1681
1682 /**
Chalard Jean0c7ebe92022-08-03 14:45:47 +09001683 * Returns an array of all {@link Network} currently tracked by the framework.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001684 *
Lorenzo Colitti86714b12021-05-17 20:31:21 +09001685 * @deprecated This method does not provide any notification of network state changes, forcing
1686 * apps to call it repeatedly. This is inefficient and prone to race conditions.
1687 * Apps should use methods such as
1688 * {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)} instead.
1689 * Apps that desire to obtain information about networks that do not apply to them
1690 * can use {@link NetworkRequest.Builder#setIncludeOtherUidNetworks}.
1691 *
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001692 * @return an array of {@link Network} objects.
1693 */
1694 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1695 @NonNull
Lorenzo Colitti86714b12021-05-17 20:31:21 +09001696 @Deprecated
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001697 public Network[] getAllNetworks() {
1698 try {
1699 return mService.getAllNetworks();
1700 } catch (RemoteException e) {
1701 throw e.rethrowFromSystemServer();
1702 }
1703 }
1704
1705 /**
Roshan Piuse08bc182020-12-22 15:10:42 -08001706 * Returns an array of {@link NetworkCapabilities} objects, representing
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001707 * the Networks that applications run by the given user will use by default.
1708 * @hide
1709 */
1710 @UnsupportedAppUsage
1711 public NetworkCapabilities[] getDefaultNetworkCapabilitiesForUser(int userId) {
1712 try {
1713 return mService.getDefaultNetworkCapabilitiesForUser(
Roshan Piusa8a477b2020-12-17 14:53:09 -08001714 userId, mContext.getOpPackageName(), getAttributionTag());
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001715 } catch (RemoteException e) {
1716 throw e.rethrowFromSystemServer();
1717 }
1718 }
1719
1720 /**
1721 * Returns the IP information for the current default network.
1722 *
1723 * @return a {@link LinkProperties} object describing the IP info
1724 * for the current default network, or {@code null} if there
1725 * is no current default network.
1726 *
1727 * {@hide}
1728 * @deprecated please use {@link #getLinkProperties(Network)} on the return
1729 * value of {@link #getActiveNetwork()} instead. In particular,
1730 * this method will return non-null LinkProperties even if the
1731 * app is blocked by policy from using this network.
1732 */
1733 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1734 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 109783091)
1735 public LinkProperties getActiveLinkProperties() {
1736 try {
1737 return mService.getActiveLinkProperties();
1738 } catch (RemoteException e) {
1739 throw e.rethrowFromSystemServer();
1740 }
1741 }
1742
1743 /**
1744 * Returns the IP information for a given network type.
1745 *
1746 * @param networkType the network type of interest.
1747 * @return a {@link LinkProperties} object describing the IP info
1748 * for the given networkType, or {@code null} if there is
1749 * no current default network.
1750 *
1751 * {@hide}
1752 * @deprecated This method does not support multiple connected networks
1753 * of the same type. Use {@link #getAllNetworks},
1754 * {@link #getNetworkInfo(android.net.Network)}, and
1755 * {@link #getLinkProperties(android.net.Network)} instead.
1756 */
1757 @Deprecated
1758 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1759 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 130143562)
1760 public LinkProperties getLinkProperties(int networkType) {
1761 try {
1762 return mService.getLinkPropertiesForType(networkType);
1763 } catch (RemoteException e) {
1764 throw e.rethrowFromSystemServer();
1765 }
1766 }
1767
1768 /**
1769 * Get the {@link LinkProperties} for the given {@link Network}. This
1770 * will return {@code null} if the network is unknown.
1771 *
1772 * @param network The {@link Network} object identifying the network in question.
1773 * @return The {@link LinkProperties} for the network, or {@code null}.
1774 */
1775 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1776 @Nullable
1777 public LinkProperties getLinkProperties(@Nullable Network network) {
1778 try {
1779 return mService.getLinkProperties(network);
1780 } catch (RemoteException e) {
1781 throw e.rethrowFromSystemServer();
1782 }
1783 }
1784
1785 /**
lucaslinc582d502022-01-27 09:07:00 +08001786 * Redact {@link LinkProperties} for a given package
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001787 *
lucaslinc582d502022-01-27 09:07:00 +08001788 * Returns an instance of the given {@link LinkProperties} appropriately redacted to send to the
1789 * given package, considering its permissions.
1790 *
1791 * @param lp A {@link LinkProperties} which will be redacted.
1792 * @param uid The target uid.
1793 * @param packageName The name of the package, for appops logging.
1794 * @return A redacted {@link LinkProperties} which is appropriate to send to the given uid,
1795 * or null if the uid lacks the ACCESS_NETWORK_STATE permission.
1796 * @hide
1797 */
1798 @RequiresPermission(anyOf = {
1799 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
1800 android.Manifest.permission.NETWORK_STACK,
1801 android.Manifest.permission.NETWORK_SETTINGS})
1802 @SystemApi(client = MODULE_LIBRARIES)
1803 @Nullable
lucaslind2b06132022-03-02 10:56:57 +08001804 public LinkProperties getRedactedLinkPropertiesForPackage(@NonNull LinkProperties lp, int uid,
lucaslinc582d502022-01-27 09:07:00 +08001805 @NonNull String packageName) {
1806 try {
lucaslind2b06132022-03-02 10:56:57 +08001807 return mService.getRedactedLinkPropertiesForPackage(
lucaslinc582d502022-01-27 09:07:00 +08001808 lp, uid, packageName, getAttributionTag());
1809 } catch (RemoteException e) {
1810 throw e.rethrowFromSystemServer();
1811 }
1812 }
1813
1814 /**
1815 * Get the {@link NetworkCapabilities} for the given {@link Network}, or null.
1816 *
1817 * This will remove any location sensitive data in the returned {@link NetworkCapabilities}.
1818 * Some {@link TransportInfo} instances like {@link android.net.wifi.WifiInfo} contain location
1819 * sensitive information. To retrieve this location sensitive information (subject to
1820 * the caller's location permissions), use a {@link NetworkCallback} with the
1821 * {@link NetworkCallback#FLAG_INCLUDE_LOCATION_INFO} flag instead.
1822 *
1823 * This method returns {@code null} if the network is unknown or if the |network| argument
1824 * is null.
Roshan Piuse08bc182020-12-22 15:10:42 -08001825 *
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001826 * @param network The {@link Network} object identifying the network in question.
Roshan Piuse08bc182020-12-22 15:10:42 -08001827 * @return The {@link NetworkCapabilities} for the network, or {@code null}.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001828 */
1829 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1830 @Nullable
1831 public NetworkCapabilities getNetworkCapabilities(@Nullable Network network) {
1832 try {
Roshan Piusa8a477b2020-12-17 14:53:09 -08001833 return mService.getNetworkCapabilities(
1834 network, mContext.getOpPackageName(), getAttributionTag());
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001835 } catch (RemoteException e) {
1836 throw e.rethrowFromSystemServer();
1837 }
1838 }
1839
1840 /**
lucaslinc582d502022-01-27 09:07:00 +08001841 * Redact {@link NetworkCapabilities} for a given package.
1842 *
1843 * Returns an instance of {@link NetworkCapabilities} that is appropriately redacted to send
lucaslind2b06132022-03-02 10:56:57 +08001844 * to the given package, considering its permissions. If the passed capabilities contain
1845 * location-sensitive information, they will be redacted to the correct degree for the location
1846 * permissions of the app (COARSE or FINE), and will blame the UID accordingly for retrieving
1847 * that level of location. If the UID holds no location permission, the returned object will
1848 * contain no location-sensitive information and the UID is not blamed.
lucaslinc582d502022-01-27 09:07:00 +08001849 *
1850 * @param nc A {@link NetworkCapabilities} instance which will be redacted.
1851 * @param uid The target uid.
1852 * @param packageName The name of the package, for appops logging.
1853 * @return A redacted {@link NetworkCapabilities} which is appropriate to send to the given uid,
1854 * or null if the uid lacks the ACCESS_NETWORK_STATE permission.
1855 * @hide
1856 */
1857 @RequiresPermission(anyOf = {
1858 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
1859 android.Manifest.permission.NETWORK_STACK,
1860 android.Manifest.permission.NETWORK_SETTINGS})
1861 @SystemApi(client = MODULE_LIBRARIES)
1862 @Nullable
lucaslind2b06132022-03-02 10:56:57 +08001863 public NetworkCapabilities getRedactedNetworkCapabilitiesForPackage(
lucaslinc582d502022-01-27 09:07:00 +08001864 @NonNull NetworkCapabilities nc,
1865 int uid, @NonNull String packageName) {
1866 try {
lucaslind2b06132022-03-02 10:56:57 +08001867 return mService.getRedactedNetworkCapabilitiesForPackage(nc, uid, packageName,
lucaslinc582d502022-01-27 09:07:00 +08001868 getAttributionTag());
1869 } catch (RemoteException e) {
1870 throw e.rethrowFromSystemServer();
1871 }
1872 }
1873
1874 /**
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001875 * Gets a URL that can be used for resolving whether a captive portal is present.
1876 * 1. This URL should respond with a 204 response to a GET request to indicate no captive
1877 * portal is present.
1878 * 2. This URL must be HTTP as redirect responses are used to find captive portal
1879 * sign-in pages. Captive portals cannot respond to HTTPS requests with redirects.
1880 *
1881 * The system network validation may be using different strategies to detect captive portals,
1882 * so this method does not necessarily return a URL used by the system. It only returns a URL
1883 * that may be relevant for other components trying to detect captive portals.
1884 *
1885 * @hide
Chalard Jean0c7ebe92022-08-03 14:45:47 +09001886 * @deprecated This API returns a URL which is not guaranteed to be one of the URLs used by the
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001887 * system.
1888 */
1889 @Deprecated
1890 @SystemApi
1891 @RequiresPermission(android.Manifest.permission.NETWORK_SETTINGS)
1892 public String getCaptivePortalServerUrl() {
1893 try {
1894 return mService.getCaptivePortalServerUrl();
1895 } catch (RemoteException e) {
1896 throw e.rethrowFromSystemServer();
1897 }
1898 }
1899
1900 /**
1901 * Tells the underlying networking system that the caller wants to
1902 * begin using the named feature. The interpretation of {@code feature}
1903 * is completely up to each networking implementation.
1904 *
1905 * <p>This method requires the caller to hold either the
1906 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
1907 * or the ability to modify system settings as determined by
1908 * {@link android.provider.Settings.System#canWrite}.</p>
1909 *
1910 * @param networkType specifies which network the request pertains to
1911 * @param feature the name of the feature to be used
1912 * @return an integer value representing the outcome of the request.
1913 * The interpretation of this value is specific to each networking
1914 * implementation+feature combination, except that the value {@code -1}
1915 * always indicates failure.
1916 *
1917 * @deprecated Deprecated in favor of the cleaner
1918 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} API.
1919 * In {@link VERSION_CODES#M}, and above, this method is unsupported and will
1920 * throw {@code UnsupportedOperationException} if called.
1921 * @removed
1922 */
1923 @Deprecated
1924 public int startUsingNetworkFeature(int networkType, String feature) {
1925 checkLegacyRoutingApiAccess();
1926 NetworkCapabilities netCap = networkCapabilitiesForFeature(networkType, feature);
1927 if (netCap == null) {
1928 Log.d(TAG, "Can't satisfy startUsingNetworkFeature for " + networkType + ", " +
1929 feature);
1930 return DEPRECATED_PHONE_CONSTANT_APN_REQUEST_FAILED;
1931 }
1932
1933 NetworkRequest request = null;
1934 synchronized (sLegacyRequests) {
1935 LegacyRequest l = sLegacyRequests.get(netCap);
1936 if (l != null) {
1937 Log.d(TAG, "renewing startUsingNetworkFeature request " + l.networkRequest);
1938 renewRequestLocked(l);
1939 if (l.currentNetwork != null) {
1940 return DEPRECATED_PHONE_CONSTANT_APN_ALREADY_ACTIVE;
1941 } else {
1942 return DEPRECATED_PHONE_CONSTANT_APN_REQUEST_STARTED;
1943 }
1944 }
1945
1946 request = requestNetworkForFeatureLocked(netCap);
1947 }
1948 if (request != null) {
1949 Log.d(TAG, "starting startUsingNetworkFeature for request " + request);
1950 return DEPRECATED_PHONE_CONSTANT_APN_REQUEST_STARTED;
1951 } else {
1952 Log.d(TAG, " request Failed");
1953 return DEPRECATED_PHONE_CONSTANT_APN_REQUEST_FAILED;
1954 }
1955 }
1956
1957 /**
1958 * Tells the underlying networking system that the caller is finished
1959 * using the named feature. The interpretation of {@code feature}
1960 * is completely up to each networking implementation.
1961 *
1962 * <p>This method requires the caller to hold either the
1963 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
1964 * or the ability to modify system settings as determined by
1965 * {@link android.provider.Settings.System#canWrite}.</p>
1966 *
1967 * @param networkType specifies which network the request pertains to
1968 * @param feature the name of the feature that is no longer needed
1969 * @return an integer value representing the outcome of the request.
1970 * The interpretation of this value is specific to each networking
1971 * implementation+feature combination, except that the value {@code -1}
1972 * always indicates failure.
1973 *
1974 * @deprecated Deprecated in favor of the cleaner
1975 * {@link #unregisterNetworkCallback(NetworkCallback)} API.
1976 * In {@link VERSION_CODES#M}, and above, this method is unsupported and will
1977 * throw {@code UnsupportedOperationException} if called.
1978 * @removed
1979 */
1980 @Deprecated
1981 public int stopUsingNetworkFeature(int networkType, String feature) {
1982 checkLegacyRoutingApiAccess();
1983 NetworkCapabilities netCap = networkCapabilitiesForFeature(networkType, feature);
1984 if (netCap == null) {
1985 Log.d(TAG, "Can't satisfy stopUsingNetworkFeature for " + networkType + ", " +
1986 feature);
1987 return -1;
1988 }
1989
1990 if (removeRequestForFeature(netCap)) {
1991 Log.d(TAG, "stopUsingNetworkFeature for " + networkType + ", " + feature);
1992 }
1993 return 1;
1994 }
1995
1996 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
1997 private NetworkCapabilities networkCapabilitiesForFeature(int networkType, String feature) {
1998 if (networkType == TYPE_MOBILE) {
1999 switch (feature) {
2000 case "enableCBS":
2001 return networkCapabilitiesForType(TYPE_MOBILE_CBS);
2002 case "enableDUN":
2003 case "enableDUNAlways":
2004 return networkCapabilitiesForType(TYPE_MOBILE_DUN);
2005 case "enableFOTA":
2006 return networkCapabilitiesForType(TYPE_MOBILE_FOTA);
2007 case "enableHIPRI":
2008 return networkCapabilitiesForType(TYPE_MOBILE_HIPRI);
2009 case "enableIMS":
2010 return networkCapabilitiesForType(TYPE_MOBILE_IMS);
2011 case "enableMMS":
2012 return networkCapabilitiesForType(TYPE_MOBILE_MMS);
2013 case "enableSUPL":
2014 return networkCapabilitiesForType(TYPE_MOBILE_SUPL);
2015 default:
2016 return null;
2017 }
2018 } else if (networkType == TYPE_WIFI && "p2p".equals(feature)) {
2019 return networkCapabilitiesForType(TYPE_WIFI_P2P);
2020 }
2021 return null;
2022 }
2023
2024 private int legacyTypeForNetworkCapabilities(NetworkCapabilities netCap) {
2025 if (netCap == null) return TYPE_NONE;
2026 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_CBS)) {
2027 return TYPE_MOBILE_CBS;
2028 }
2029 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_IMS)) {
2030 return TYPE_MOBILE_IMS;
2031 }
2032 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_FOTA)) {
2033 return TYPE_MOBILE_FOTA;
2034 }
2035 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_DUN)) {
2036 return TYPE_MOBILE_DUN;
2037 }
2038 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_SUPL)) {
2039 return TYPE_MOBILE_SUPL;
2040 }
2041 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_MMS)) {
2042 return TYPE_MOBILE_MMS;
2043 }
2044 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_INTERNET)) {
2045 return TYPE_MOBILE_HIPRI;
2046 }
2047 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_WIFI_P2P)) {
2048 return TYPE_WIFI_P2P;
2049 }
2050 return TYPE_NONE;
2051 }
2052
2053 private static class LegacyRequest {
2054 NetworkCapabilities networkCapabilities;
2055 NetworkRequest networkRequest;
2056 int expireSequenceNumber;
2057 Network currentNetwork;
2058 int delay = -1;
2059
2060 private void clearDnsBinding() {
2061 if (currentNetwork != null) {
2062 currentNetwork = null;
2063 setProcessDefaultNetworkForHostResolution(null);
2064 }
2065 }
2066
2067 NetworkCallback networkCallback = new NetworkCallback() {
2068 @Override
2069 public void onAvailable(Network network) {
2070 currentNetwork = network;
2071 Log.d(TAG, "startUsingNetworkFeature got Network:" + network);
2072 setProcessDefaultNetworkForHostResolution(network);
2073 }
2074 @Override
2075 public void onLost(Network network) {
2076 if (network.equals(currentNetwork)) clearDnsBinding();
2077 Log.d(TAG, "startUsingNetworkFeature lost Network:" + network);
2078 }
2079 };
2080 }
2081
2082 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
2083 private static final HashMap<NetworkCapabilities, LegacyRequest> sLegacyRequests =
2084 new HashMap<>();
2085
2086 private NetworkRequest findRequestForFeature(NetworkCapabilities netCap) {
2087 synchronized (sLegacyRequests) {
2088 LegacyRequest l = sLegacyRequests.get(netCap);
2089 if (l != null) return l.networkRequest;
2090 }
2091 return null;
2092 }
2093
2094 private void renewRequestLocked(LegacyRequest l) {
2095 l.expireSequenceNumber++;
2096 Log.d(TAG, "renewing request to seqNum " + l.expireSequenceNumber);
2097 sendExpireMsgForFeature(l.networkCapabilities, l.expireSequenceNumber, l.delay);
2098 }
2099
2100 private void expireRequest(NetworkCapabilities netCap, int sequenceNum) {
2101 int ourSeqNum = -1;
2102 synchronized (sLegacyRequests) {
2103 LegacyRequest l = sLegacyRequests.get(netCap);
2104 if (l == null) return;
2105 ourSeqNum = l.expireSequenceNumber;
2106 if (l.expireSequenceNumber == sequenceNum) removeRequestForFeature(netCap);
2107 }
2108 Log.d(TAG, "expireRequest with " + ourSeqNum + ", " + sequenceNum);
2109 }
2110
2111 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
2112 private NetworkRequest requestNetworkForFeatureLocked(NetworkCapabilities netCap) {
2113 int delay = -1;
2114 int type = legacyTypeForNetworkCapabilities(netCap);
2115 try {
2116 delay = mService.getRestoreDefaultNetworkDelay(type);
2117 } catch (RemoteException e) {
2118 throw e.rethrowFromSystemServer();
2119 }
2120 LegacyRequest l = new LegacyRequest();
2121 l.networkCapabilities = netCap;
2122 l.delay = delay;
2123 l.expireSequenceNumber = 0;
2124 l.networkRequest = sendRequestForNetwork(
2125 netCap, l.networkCallback, 0, REQUEST, type, getDefaultHandler());
2126 if (l.networkRequest == null) return null;
2127 sLegacyRequests.put(netCap, l);
2128 sendExpireMsgForFeature(netCap, l.expireSequenceNumber, delay);
2129 return l.networkRequest;
2130 }
2131
2132 private void sendExpireMsgForFeature(NetworkCapabilities netCap, int seqNum, int delay) {
2133 if (delay >= 0) {
2134 Log.d(TAG, "sending expire msg with seqNum " + seqNum + " and delay " + delay);
2135 CallbackHandler handler = getDefaultHandler();
2136 Message msg = handler.obtainMessage(EXPIRE_LEGACY_REQUEST, seqNum, 0, netCap);
2137 handler.sendMessageDelayed(msg, delay);
2138 }
2139 }
2140
2141 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
2142 private boolean removeRequestForFeature(NetworkCapabilities netCap) {
2143 final LegacyRequest l;
2144 synchronized (sLegacyRequests) {
2145 l = sLegacyRequests.remove(netCap);
2146 }
2147 if (l == null) return false;
2148 unregisterNetworkCallback(l.networkCallback);
2149 l.clearDnsBinding();
2150 return true;
2151 }
2152
2153 private static final SparseIntArray sLegacyTypeToTransport = new SparseIntArray();
2154 static {
2155 sLegacyTypeToTransport.put(TYPE_MOBILE, NetworkCapabilities.TRANSPORT_CELLULAR);
2156 sLegacyTypeToTransport.put(TYPE_MOBILE_CBS, NetworkCapabilities.TRANSPORT_CELLULAR);
2157 sLegacyTypeToTransport.put(TYPE_MOBILE_DUN, NetworkCapabilities.TRANSPORT_CELLULAR);
2158 sLegacyTypeToTransport.put(TYPE_MOBILE_FOTA, NetworkCapabilities.TRANSPORT_CELLULAR);
2159 sLegacyTypeToTransport.put(TYPE_MOBILE_HIPRI, NetworkCapabilities.TRANSPORT_CELLULAR);
2160 sLegacyTypeToTransport.put(TYPE_MOBILE_IMS, NetworkCapabilities.TRANSPORT_CELLULAR);
2161 sLegacyTypeToTransport.put(TYPE_MOBILE_MMS, NetworkCapabilities.TRANSPORT_CELLULAR);
2162 sLegacyTypeToTransport.put(TYPE_MOBILE_SUPL, NetworkCapabilities.TRANSPORT_CELLULAR);
2163 sLegacyTypeToTransport.put(TYPE_WIFI, NetworkCapabilities.TRANSPORT_WIFI);
2164 sLegacyTypeToTransport.put(TYPE_WIFI_P2P, NetworkCapabilities.TRANSPORT_WIFI);
2165 sLegacyTypeToTransport.put(TYPE_BLUETOOTH, NetworkCapabilities.TRANSPORT_BLUETOOTH);
2166 sLegacyTypeToTransport.put(TYPE_ETHERNET, NetworkCapabilities.TRANSPORT_ETHERNET);
2167 }
2168
2169 private static final SparseIntArray sLegacyTypeToCapability = new SparseIntArray();
2170 static {
2171 sLegacyTypeToCapability.put(TYPE_MOBILE_CBS, NetworkCapabilities.NET_CAPABILITY_CBS);
2172 sLegacyTypeToCapability.put(TYPE_MOBILE_DUN, NetworkCapabilities.NET_CAPABILITY_DUN);
2173 sLegacyTypeToCapability.put(TYPE_MOBILE_FOTA, NetworkCapabilities.NET_CAPABILITY_FOTA);
2174 sLegacyTypeToCapability.put(TYPE_MOBILE_IMS, NetworkCapabilities.NET_CAPABILITY_IMS);
2175 sLegacyTypeToCapability.put(TYPE_MOBILE_MMS, NetworkCapabilities.NET_CAPABILITY_MMS);
2176 sLegacyTypeToCapability.put(TYPE_MOBILE_SUPL, NetworkCapabilities.NET_CAPABILITY_SUPL);
2177 sLegacyTypeToCapability.put(TYPE_WIFI_P2P, NetworkCapabilities.NET_CAPABILITY_WIFI_P2P);
2178 }
2179
2180 /**
2181 * Given a legacy type (TYPE_WIFI, ...) returns a NetworkCapabilities
2182 * instance suitable for registering a request or callback. Throws an
2183 * IllegalArgumentException if no mapping from the legacy type to
2184 * NetworkCapabilities is known.
2185 *
2186 * @deprecated Types are deprecated. Use {@link NetworkCallback} or {@link NetworkRequest}
2187 * to find the network instead.
2188 * @hide
2189 */
2190 public static NetworkCapabilities networkCapabilitiesForType(int type) {
2191 final NetworkCapabilities nc = new NetworkCapabilities();
2192
2193 // Map from type to transports.
2194 final int NOT_FOUND = -1;
2195 final int transport = sLegacyTypeToTransport.get(type, NOT_FOUND);
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00002196 if (transport == NOT_FOUND) {
2197 throw new IllegalArgumentException("unknown legacy type: " + type);
2198 }
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002199 nc.addTransportType(transport);
2200
2201 // Map from type to capabilities.
2202 nc.addCapability(sLegacyTypeToCapability.get(
2203 type, NetworkCapabilities.NET_CAPABILITY_INTERNET));
2204 nc.maybeMarkCapabilitiesRestricted();
2205 return nc;
2206 }
2207
2208 /** @hide */
2209 public static class PacketKeepaliveCallback {
2210 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
2211 public PacketKeepaliveCallback() {
2212 }
2213 /** The requested keepalive was successfully started. */
2214 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
2215 public void onStarted() {}
2216 /** The keepalive was successfully stopped. */
2217 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
2218 public void onStopped() {}
2219 /** An error occurred. */
2220 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
2221 public void onError(int error) {}
2222 }
2223
2224 /**
2225 * Allows applications to request that the system periodically send specific packets on their
2226 * behalf, using hardware offload to save battery power.
2227 *
2228 * To request that the system send keepalives, call one of the methods that return a
2229 * {@link ConnectivityManager.PacketKeepalive} object, such as {@link #startNattKeepalive},
2230 * passing in a non-null callback. If the callback is successfully started, the callback's
2231 * {@code onStarted} method will be called. If an error occurs, {@code onError} will be called,
2232 * specifying one of the {@code ERROR_*} constants in this class.
2233 *
2234 * To stop an existing keepalive, call {@link PacketKeepalive#stop}. The system will call
2235 * {@link PacketKeepaliveCallback#onStopped} if the operation was successful or
2236 * {@link PacketKeepaliveCallback#onError} if an error occurred.
2237 *
2238 * @deprecated Use {@link SocketKeepalive} instead.
2239 *
2240 * @hide
2241 */
2242 public class PacketKeepalive {
2243
2244 private static final String TAG = "PacketKeepalive";
2245
2246 /** @hide */
2247 public static final int SUCCESS = 0;
2248
2249 /** @hide */
2250 public static final int NO_KEEPALIVE = -1;
2251
2252 /** @hide */
2253 public static final int BINDER_DIED = -10;
2254
2255 /** The specified {@code Network} is not connected. */
2256 public static final int ERROR_INVALID_NETWORK = -20;
2257 /** The specified IP addresses are invalid. For example, the specified source IP address is
2258 * not configured on the specified {@code Network}. */
2259 public static final int ERROR_INVALID_IP_ADDRESS = -21;
2260 /** The requested port is invalid. */
2261 public static final int ERROR_INVALID_PORT = -22;
2262 /** The packet length is invalid (e.g., too long). */
2263 public static final int ERROR_INVALID_LENGTH = -23;
2264 /** The packet transmission interval is invalid (e.g., too short). */
2265 public static final int ERROR_INVALID_INTERVAL = -24;
2266
2267 /** The hardware does not support this request. */
2268 public static final int ERROR_HARDWARE_UNSUPPORTED = -30;
2269 /** The hardware returned an error. */
2270 public static final int ERROR_HARDWARE_ERROR = -31;
2271
2272 /** The NAT-T destination port for IPsec */
2273 public static final int NATT_PORT = 4500;
2274
2275 /** The minimum interval in seconds between keepalive packet transmissions */
2276 public static final int MIN_INTERVAL = 10;
2277
2278 private final Network mNetwork;
2279 private final ISocketKeepaliveCallback mCallback;
2280 private final ExecutorService mExecutor;
2281
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002282 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
2283 public void stop() {
2284 try {
2285 mExecutor.execute(() -> {
2286 try {
Chalard Jeanf0b261e2023-02-03 22:11:20 +09002287 mService.stopKeepalive(mCallback);
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002288 } catch (RemoteException e) {
2289 Log.e(TAG, "Error stopping packet keepalive: ", e);
2290 throw e.rethrowFromSystemServer();
2291 }
2292 });
2293 } catch (RejectedExecutionException e) {
2294 // The internal executor has already stopped due to previous event.
2295 }
2296 }
2297
2298 private PacketKeepalive(Network network, PacketKeepaliveCallback callback) {
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00002299 Objects.requireNonNull(network, "network cannot be null");
2300 Objects.requireNonNull(callback, "callback cannot be null");
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002301 mNetwork = network;
2302 mExecutor = Executors.newSingleThreadExecutor();
2303 mCallback = new ISocketKeepaliveCallback.Stub() {
2304 @Override
Chalard Jeanf0b261e2023-02-03 22:11:20 +09002305 public void onStarted() {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002306 final long token = Binder.clearCallingIdentity();
2307 try {
2308 mExecutor.execute(() -> {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002309 callback.onStarted();
2310 });
2311 } finally {
2312 Binder.restoreCallingIdentity(token);
2313 }
2314 }
2315
2316 @Override
2317 public void onStopped() {
2318 final long token = Binder.clearCallingIdentity();
2319 try {
2320 mExecutor.execute(() -> {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002321 callback.onStopped();
2322 });
2323 } finally {
2324 Binder.restoreCallingIdentity(token);
2325 }
2326 mExecutor.shutdown();
2327 }
2328
2329 @Override
2330 public void onError(int error) {
2331 final long token = Binder.clearCallingIdentity();
2332 try {
2333 mExecutor.execute(() -> {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002334 callback.onError(error);
2335 });
2336 } finally {
2337 Binder.restoreCallingIdentity(token);
2338 }
2339 mExecutor.shutdown();
2340 }
2341
2342 @Override
2343 public void onDataReceived() {
2344 // PacketKeepalive is only used for Nat-T keepalive and as such does not invoke
2345 // this callback when data is received.
2346 }
2347 };
2348 }
2349 }
2350
2351 /**
2352 * Starts an IPsec NAT-T keepalive packet with the specified parameters.
2353 *
2354 * @deprecated Use {@link #createSocketKeepalive} instead.
2355 *
2356 * @hide
2357 */
2358 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
2359 public PacketKeepalive startNattKeepalive(
2360 Network network, int intervalSeconds, PacketKeepaliveCallback callback,
2361 InetAddress srcAddr, int srcPort, InetAddress dstAddr) {
2362 final PacketKeepalive k = new PacketKeepalive(network, callback);
2363 try {
2364 mService.startNattKeepalive(network, intervalSeconds, k.mCallback,
2365 srcAddr.getHostAddress(), srcPort, dstAddr.getHostAddress());
2366 } catch (RemoteException e) {
2367 Log.e(TAG, "Error starting packet keepalive: ", e);
2368 throw e.rethrowFromSystemServer();
2369 }
2370 return k;
2371 }
2372
2373 // Construct an invalid fd.
2374 private ParcelFileDescriptor createInvalidFd() {
2375 final int invalidFd = -1;
2376 return ParcelFileDescriptor.adoptFd(invalidFd);
2377 }
2378
2379 /**
2380 * Request that keepalives be started on a IPsec NAT-T socket.
2381 *
2382 * @param network The {@link Network} the socket is on.
2383 * @param socket The socket that needs to be kept alive.
2384 * @param source The source address of the {@link UdpEncapsulationSocket}.
2385 * @param destination The destination address of the {@link UdpEncapsulationSocket}.
2386 * @param executor The executor on which callback will be invoked. The provided {@link Executor}
2387 * must run callback sequentially, otherwise the order of callbacks cannot be
2388 * guaranteed.
2389 * @param callback A {@link SocketKeepalive.Callback}. Used for notifications about keepalive
2390 * changes. Must be extended by applications that use this API.
2391 *
2392 * @return A {@link SocketKeepalive} object that can be used to control the keepalive on the
2393 * given socket.
2394 **/
2395 public @NonNull SocketKeepalive createSocketKeepalive(@NonNull Network network,
2396 @NonNull UdpEncapsulationSocket socket,
2397 @NonNull InetAddress source,
2398 @NonNull InetAddress destination,
2399 @NonNull @CallbackExecutor Executor executor,
2400 @NonNull Callback callback) {
2401 ParcelFileDescriptor dup;
2402 try {
2403 // Dup is needed here as the pfd inside the socket is owned by the IpSecService,
2404 // which cannot be obtained by the app process.
2405 dup = ParcelFileDescriptor.dup(socket.getFileDescriptor());
2406 } catch (IOException ignored) {
2407 // Construct an invalid fd, so that if the user later calls start(), it will fail with
2408 // ERROR_INVALID_SOCKET.
2409 dup = createInvalidFd();
2410 }
2411 return new NattSocketKeepalive(mService, network, dup, socket.getResourceId(), source,
2412 destination, executor, callback);
2413 }
2414
2415 /**
2416 * Request that keepalives be started on a IPsec NAT-T socket file descriptor. Directly called
2417 * by system apps which don't use IpSecService to create {@link UdpEncapsulationSocket}.
2418 *
2419 * @param network The {@link Network} the socket is on.
2420 * @param pfd The {@link ParcelFileDescriptor} that needs to be kept alive. The provided
2421 * {@link ParcelFileDescriptor} must be bound to a port and the keepalives will be sent
2422 * from that port.
2423 * @param source The source address of the {@link UdpEncapsulationSocket}.
2424 * @param destination The destination address of the {@link UdpEncapsulationSocket}. The
2425 * keepalive packets will always be sent to port 4500 of the given {@code destination}.
2426 * @param executor The executor on which callback will be invoked. The provided {@link Executor}
2427 * must run callback sequentially, otherwise the order of callbacks cannot be
2428 * guaranteed.
2429 * @param callback A {@link SocketKeepalive.Callback}. Used for notifications about keepalive
2430 * changes. Must be extended by applications that use this API.
2431 *
2432 * @return A {@link SocketKeepalive} object that can be used to control the keepalive on the
2433 * given socket.
2434 * @hide
2435 */
2436 @SystemApi
2437 @RequiresPermission(android.Manifest.permission.PACKET_KEEPALIVE_OFFLOAD)
2438 public @NonNull SocketKeepalive createNattKeepalive(@NonNull Network network,
2439 @NonNull ParcelFileDescriptor pfd,
2440 @NonNull InetAddress source,
2441 @NonNull InetAddress destination,
2442 @NonNull @CallbackExecutor Executor executor,
2443 @NonNull Callback callback) {
2444 ParcelFileDescriptor dup;
2445 try {
2446 // TODO: Consider remove unnecessary dup.
2447 dup = pfd.dup();
2448 } catch (IOException ignored) {
2449 // Construct an invalid fd, so that if the user later calls start(), it will fail with
2450 // ERROR_INVALID_SOCKET.
2451 dup = createInvalidFd();
2452 }
2453 return new NattSocketKeepalive(mService, network, dup,
Remi NGUYEN VANa29be5c2021-03-11 10:56:49 +00002454 -1 /* Unused */, source, destination, executor, callback);
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002455 }
2456
2457 /**
Chalard Jean0c7ebe92022-08-03 14:45:47 +09002458 * Request that keepalives be started on a TCP socket. The socket must be established.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002459 *
2460 * @param network The {@link Network} the socket is on.
2461 * @param socket The socket that needs to be kept alive.
2462 * @param executor The executor on which callback will be invoked. This implementation assumes
2463 * the provided {@link Executor} runs the callbacks in sequence with no
2464 * concurrency. Failing this, no guarantee of correctness can be made. It is
2465 * the responsibility of the caller to ensure the executor provides this
2466 * guarantee. A simple way of creating such an executor is with the standard
2467 * tool {@code Executors.newSingleThreadExecutor}.
2468 * @param callback A {@link SocketKeepalive.Callback}. Used for notifications about keepalive
2469 * changes. Must be extended by applications that use this API.
2470 *
2471 * @return A {@link SocketKeepalive} object that can be used to control the keepalive on the
2472 * given socket.
2473 * @hide
2474 */
2475 @SystemApi
2476 @RequiresPermission(android.Manifest.permission.PACKET_KEEPALIVE_OFFLOAD)
2477 public @NonNull SocketKeepalive createSocketKeepalive(@NonNull Network network,
2478 @NonNull Socket socket,
2479 @NonNull Executor executor,
2480 @NonNull Callback callback) {
2481 ParcelFileDescriptor dup;
2482 try {
2483 dup = ParcelFileDescriptor.fromSocket(socket);
2484 } catch (UncheckedIOException ignored) {
2485 // Construct an invalid fd, so that if the user later calls start(), it will fail with
2486 // ERROR_INVALID_SOCKET.
2487 dup = createInvalidFd();
2488 }
2489 return new TcpSocketKeepalive(mService, network, dup, executor, callback);
2490 }
2491
2492 /**
2493 * Ensure that a network route exists to deliver traffic to the specified
2494 * host via the specified network interface. An attempt to add a route that
2495 * already exists is ignored, but treated as successful.
2496 *
2497 * <p>This method requires the caller to hold either the
2498 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
2499 * or the ability to modify system settings as determined by
2500 * {@link android.provider.Settings.System#canWrite}.</p>
2501 *
2502 * @param networkType the type of the network over which traffic to the specified
2503 * host is to be routed
2504 * @param hostAddress the IP address of the host to which the route is desired
2505 * @return {@code true} on success, {@code false} on failure
2506 *
2507 * @deprecated Deprecated in favor of the
2508 * {@link #requestNetwork(NetworkRequest, NetworkCallback)},
2509 * {@link #bindProcessToNetwork} and {@link Network#getSocketFactory} API.
2510 * In {@link VERSION_CODES#M}, and above, this method is unsupported and will
2511 * throw {@code UnsupportedOperationException} if called.
2512 * @removed
2513 */
2514 @Deprecated
2515 public boolean requestRouteToHost(int networkType, int hostAddress) {
2516 return requestRouteToHostAddress(networkType, NetworkUtils.intToInetAddress(hostAddress));
2517 }
2518
2519 /**
2520 * Ensure that a network route exists to deliver traffic to the specified
2521 * host via the specified network interface. An attempt to add a route that
2522 * already exists is ignored, but treated as successful.
2523 *
2524 * <p>This method requires the caller to hold either the
2525 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
2526 * or the ability to modify system settings as determined by
2527 * {@link android.provider.Settings.System#canWrite}.</p>
2528 *
2529 * @param networkType the type of the network over which traffic to the specified
2530 * host is to be routed
2531 * @param hostAddress the IP address of the host to which the route is desired
2532 * @return {@code true} on success, {@code false} on failure
2533 * @hide
2534 * @deprecated Deprecated in favor of the {@link #requestNetwork} and
2535 * {@link #bindProcessToNetwork} API.
2536 */
2537 @Deprecated
2538 @UnsupportedAppUsage
lucaslin97fb10a2021-03-22 11:51:27 +08002539 @SystemApi(client = MODULE_LIBRARIES)
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002540 public boolean requestRouteToHostAddress(int networkType, InetAddress hostAddress) {
2541 checkLegacyRoutingApiAccess();
2542 try {
2543 return mService.requestRouteToHostAddress(networkType, hostAddress.getAddress(),
2544 mContext.getOpPackageName(), getAttributionTag());
2545 } catch (RemoteException e) {
2546 throw e.rethrowFromSystemServer();
2547 }
2548 }
2549
2550 /**
2551 * @return the context's attribution tag
2552 */
2553 // TODO: Remove method and replace with direct call once R code is pushed to AOSP
2554 private @Nullable String getAttributionTag() {
Remi NGUYEN VANa522fc22021-02-01 10:25:24 +00002555 return mContext.getAttributionTag();
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002556 }
2557
2558 /**
2559 * Returns the value of the setting for background data usage. If false,
2560 * applications should not use the network if the application is not in the
2561 * foreground. Developers should respect this setting, and check the value
2562 * of this before performing any background data operations.
2563 * <p>
2564 * All applications that have background services that use the network
2565 * should listen to {@link #ACTION_BACKGROUND_DATA_SETTING_CHANGED}.
2566 * <p>
2567 * @deprecated As of {@link VERSION_CODES#ICE_CREAM_SANDWICH}, availability of
2568 * background data depends on several combined factors, and this method will
2569 * always return {@code true}. Instead, when background data is unavailable,
2570 * {@link #getActiveNetworkInfo()} will now appear disconnected.
2571 *
2572 * @return Whether background data usage is allowed.
2573 */
2574 @Deprecated
2575 public boolean getBackgroundDataSetting() {
2576 // assume that background data is allowed; final authority is
2577 // NetworkInfo which may be blocked.
2578 return true;
2579 }
2580
2581 /**
2582 * Sets the value of the setting for background data usage.
2583 *
2584 * @param allowBackgroundData Whether an application should use data while
2585 * it is in the background.
2586 *
2587 * @attr ref android.Manifest.permission#CHANGE_BACKGROUND_DATA_SETTING
2588 * @see #getBackgroundDataSetting()
2589 * @hide
2590 */
2591 @Deprecated
2592 @UnsupportedAppUsage
2593 public void setBackgroundDataSetting(boolean allowBackgroundData) {
2594 // ignored
2595 }
2596
2597 /**
2598 * @hide
2599 * @deprecated Talk to TelephonyManager directly
2600 */
2601 @Deprecated
2602 @UnsupportedAppUsage
2603 public boolean getMobileDataEnabled() {
2604 TelephonyManager tm = mContext.getSystemService(TelephonyManager.class);
2605 if (tm != null) {
2606 int subId = SubscriptionManager.getDefaultDataSubscriptionId();
2607 Log.d("ConnectivityManager", "getMobileDataEnabled()+ subId=" + subId);
2608 boolean retVal = tm.createForSubscriptionId(subId).isDataEnabled();
2609 Log.d("ConnectivityManager", "getMobileDataEnabled()- subId=" + subId
2610 + " retVal=" + retVal);
2611 return retVal;
2612 }
2613 Log.d("ConnectivityManager", "getMobileDataEnabled()- remote exception retVal=false");
2614 return false;
2615 }
2616
2617 /**
2618 * Callback for use with {@link ConnectivityManager#addDefaultNetworkActiveListener}
2619 * to find out when the system default network has gone in to a high power state.
2620 */
2621 public interface OnNetworkActiveListener {
2622 /**
2623 * Called on the main thread of the process to report that the current data network
2624 * has become active, and it is now a good time to perform any pending network
2625 * operations. Note that this listener only tells you when the network becomes
2626 * active; if at any other time you want to know whether it is active (and thus okay
2627 * to initiate network traffic), you can retrieve its instantaneous state with
2628 * {@link ConnectivityManager#isDefaultNetworkActive}.
2629 */
2630 void onNetworkActive();
2631 }
2632
Chiachang Wang2de41682021-09-23 10:46:03 +08002633 @GuardedBy("mNetworkActivityListeners")
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002634 private final ArrayMap<OnNetworkActiveListener, INetworkActivityListener>
2635 mNetworkActivityListeners = new ArrayMap<>();
2636
2637 /**
2638 * Start listening to reports when the system's default data network is active, meaning it is
2639 * a good time to perform network traffic. Use {@link #isDefaultNetworkActive()}
2640 * to determine the current state of the system's default network after registering the
2641 * listener.
2642 * <p>
2643 * If the process default network has been set with
2644 * {@link ConnectivityManager#bindProcessToNetwork} this function will not
2645 * reflect the process's default, but the system default.
2646 *
2647 * @param l The listener to be told when the network is active.
2648 */
2649 public void addDefaultNetworkActiveListener(final OnNetworkActiveListener l) {
Chiachang Wang2de41682021-09-23 10:46:03 +08002650 final INetworkActivityListener rl = new INetworkActivityListener.Stub() {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002651 @Override
2652 public void onNetworkActive() throws RemoteException {
2653 l.onNetworkActive();
2654 }
2655 };
2656
Chiachang Wang2de41682021-09-23 10:46:03 +08002657 synchronized (mNetworkActivityListeners) {
2658 try {
2659 mService.registerNetworkActivityListener(rl);
2660 mNetworkActivityListeners.put(l, rl);
2661 } catch (RemoteException e) {
2662 throw e.rethrowFromSystemServer();
2663 }
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002664 }
2665 }
2666
2667 /**
2668 * Remove network active listener previously registered with
2669 * {@link #addDefaultNetworkActiveListener}.
2670 *
2671 * @param l Previously registered listener.
2672 */
2673 public void removeDefaultNetworkActiveListener(@NonNull OnNetworkActiveListener l) {
Chiachang Wang2de41682021-09-23 10:46:03 +08002674 synchronized (mNetworkActivityListeners) {
2675 final INetworkActivityListener rl = mNetworkActivityListeners.get(l);
2676 if (rl == null) {
2677 throw new IllegalArgumentException("Listener was not registered.");
2678 }
2679 try {
2680 mService.unregisterNetworkActivityListener(rl);
2681 mNetworkActivityListeners.remove(l);
2682 } catch (RemoteException e) {
2683 throw e.rethrowFromSystemServer();
2684 }
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002685 }
2686 }
2687
2688 /**
2689 * Return whether the data network is currently active. An active network means that
2690 * it is currently in a high power state for performing data transmission. On some
2691 * types of networks, it may be expensive to move and stay in such a state, so it is
2692 * more power efficient to batch network traffic together when the radio is already in
2693 * this state. This method tells you whether right now is currently a good time to
2694 * initiate network traffic, as the network is already active.
2695 */
2696 public boolean isDefaultNetworkActive() {
2697 try {
lucaslin709eb842021-01-21 02:04:15 +08002698 return mService.isDefaultNetworkActive();
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002699 } catch (RemoteException e) {
2700 throw e.rethrowFromSystemServer();
2701 }
2702 }
2703
2704 /**
2705 * {@hide}
2706 */
2707 public ConnectivityManager(Context context, IConnectivityManager service) {
markchiend2015662022-04-26 18:08:03 +08002708 this(context, service, true /* newStatic */);
2709 }
2710
2711 private ConnectivityManager(Context context, IConnectivityManager service, boolean newStatic) {
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00002712 mContext = Objects.requireNonNull(context, "missing context");
2713 mService = Objects.requireNonNull(service, "missing IConnectivityManager");
markchiend2015662022-04-26 18:08:03 +08002714 // sInstance is accessed without a lock, so it may actually be reassigned several times with
2715 // different ConnectivityManager, but that's still OK considering its usage.
2716 if (sInstance == null && newStatic) {
2717 final Context appContext = mContext.getApplicationContext();
2718 // Don't create static ConnectivityManager instance again to prevent infinite loop.
2719 // If the application context is null, we're either in the system process or
2720 // it's the application context very early in app initialization. In both these
2721 // cases, the passed-in Context will not be freed, so it's safe to pass it to the
2722 // service. http://b/27532714 .
2723 sInstance = new ConnectivityManager(appContext != null ? appContext : context, service,
2724 false /* newStatic */);
2725 }
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002726 }
2727
2728 /** {@hide} */
2729 @UnsupportedAppUsage
2730 public static ConnectivityManager from(Context context) {
2731 return (ConnectivityManager) context.getSystemService(Context.CONNECTIVITY_SERVICE);
2732 }
2733
2734 /** @hide */
2735 public NetworkRequest getDefaultRequest() {
2736 try {
2737 // This is not racy as the default request is final in ConnectivityService.
2738 return mService.getDefaultRequest();
2739 } catch (RemoteException e) {
2740 throw e.rethrowFromSystemServer();
2741 }
2742 }
2743
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002744 /**
Chalard Jean0c7ebe92022-08-03 14:45:47 +09002745 * Check if the package is allowed to write settings. This also records that such an access
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002746 * happened.
2747 *
2748 * @return {@code true} iff the package is allowed to write settings.
2749 */
2750 // TODO: Remove method and replace with direct call once R code is pushed to AOSP
2751 private static boolean checkAndNoteWriteSettingsOperation(@NonNull Context context, int uid,
2752 @NonNull String callingPackage, @Nullable String callingAttributionTag,
2753 boolean throwException) {
2754 return Settings.checkAndNoteWriteSettingsOperation(context, uid, callingPackage,
Remi NGUYEN VANa522fc22021-02-01 10:25:24 +00002755 callingAttributionTag, throwException);
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002756 }
2757
2758 /**
2759 * @deprecated - use getSystemService. This is a kludge to support static access in certain
2760 * situations where a Context pointer is unavailable.
2761 * @hide
2762 */
2763 @Deprecated
2764 static ConnectivityManager getInstanceOrNull() {
2765 return sInstance;
2766 }
2767
2768 /**
2769 * @deprecated - use getSystemService. This is a kludge to support static access in certain
2770 * situations where a Context pointer is unavailable.
2771 * @hide
2772 */
2773 @Deprecated
2774 @UnsupportedAppUsage
2775 private static ConnectivityManager getInstance() {
2776 if (getInstanceOrNull() == null) {
2777 throw new IllegalStateException("No ConnectivityManager yet constructed");
2778 }
2779 return getInstanceOrNull();
2780 }
2781
2782 /**
2783 * Get the set of tetherable, available interfaces. This list is limited by
2784 * device configuration and current interface existence.
2785 *
2786 * @return an array of 0 or more Strings of tetherable interface names.
2787 *
2788 * @deprecated Use {@link TetheringEventCallback#onTetherableInterfacesChanged(List)} instead.
2789 * {@hide}
2790 */
2791 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
2792 @UnsupportedAppUsage
2793 @Deprecated
2794 public String[] getTetherableIfaces() {
Remi NGUYEN VANe4d1cd92021-06-17 16:27:31 +09002795 return getTetheringManager().getTetherableIfaces();
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002796 }
2797
2798 /**
2799 * Get the set of tethered interfaces.
2800 *
2801 * @return an array of 0 or more String of currently tethered interface names.
2802 *
2803 * @deprecated Use {@link TetheringEventCallback#onTetherableInterfacesChanged(List)} instead.
2804 * {@hide}
2805 */
2806 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
2807 @UnsupportedAppUsage
2808 @Deprecated
2809 public String[] getTetheredIfaces() {
Remi NGUYEN VANe4d1cd92021-06-17 16:27:31 +09002810 return getTetheringManager().getTetheredIfaces();
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002811 }
2812
2813 /**
2814 * Get the set of interface names which attempted to tether but
2815 * failed. Re-attempting to tether may cause them to reset to the Tethered
2816 * state. Alternatively, causing the interface to be destroyed and recreated
2817 * may cause them to reset to the available state.
2818 * {@link ConnectivityManager#getLastTetherError} can be used to get more
2819 * information on the cause of the errors.
2820 *
2821 * @return an array of 0 or more String indicating the interface names
2822 * which failed to tether.
2823 *
2824 * @deprecated Use {@link TetheringEventCallback#onError(String, int)} instead.
2825 * {@hide}
2826 */
2827 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
2828 @UnsupportedAppUsage
2829 @Deprecated
2830 public String[] getTetheringErroredIfaces() {
Remi NGUYEN VANe4d1cd92021-06-17 16:27:31 +09002831 return getTetheringManager().getTetheringErroredIfaces();
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002832 }
2833
2834 /**
2835 * Get the set of tethered dhcp ranges.
2836 *
2837 * @deprecated This method is not supported.
2838 * TODO: remove this function when all of clients are removed.
2839 * {@hide}
2840 */
2841 @RequiresPermission(android.Manifest.permission.NETWORK_SETTINGS)
2842 @Deprecated
2843 public String[] getTetheredDhcpRanges() {
2844 throw new UnsupportedOperationException("getTetheredDhcpRanges is not supported");
2845 }
2846
2847 /**
Chalard Jean0c7ebe92022-08-03 14:45:47 +09002848 * Attempt to tether the named interface. This will set up a dhcp server
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002849 * on the interface, forward and NAT IP packets and forward DNS requests
2850 * to the best active upstream network interface. Note that if no upstream
2851 * IP network interface is available, dhcp will still run and traffic will be
2852 * allowed between the tethered devices and this device, though upstream net
2853 * access will of course fail until an upstream network interface becomes
2854 * active.
2855 *
2856 * <p>This method requires the caller to hold either the
2857 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
2858 * or the ability to modify system settings as determined by
2859 * {@link android.provider.Settings.System#canWrite}.</p>
2860 *
2861 * <p>WARNING: New clients should not use this function. The only usages should be in PanService
2862 * and WifiStateMachine which need direct access. All other clients should use
2863 * {@link #startTethering} and {@link #stopTethering} which encapsulate proper provisioning
2864 * logic.</p>
2865 *
2866 * @param iface the interface name to tether.
2867 * @return error a {@code TETHER_ERROR} value indicating success or failure type
2868 * @deprecated Use {@link TetheringManager#startTethering} instead
2869 *
2870 * {@hide}
2871 */
2872 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
2873 @Deprecated
2874 public int tether(String iface) {
Remi NGUYEN VANe4d1cd92021-06-17 16:27:31 +09002875 return getTetheringManager().tether(iface);
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002876 }
2877
2878 /**
2879 * Stop tethering the named interface.
2880 *
2881 * <p>This method requires the caller to hold either the
2882 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
2883 * or the ability to modify system settings as determined by
2884 * {@link android.provider.Settings.System#canWrite}.</p>
2885 *
2886 * <p>WARNING: New clients should not use this function. The only usages should be in PanService
2887 * and WifiStateMachine which need direct access. All other clients should use
2888 * {@link #startTethering} and {@link #stopTethering} which encapsulate proper provisioning
2889 * logic.</p>
2890 *
2891 * @param iface the interface name to untether.
2892 * @return error a {@code TETHER_ERROR} value indicating success or failure type
2893 *
2894 * {@hide}
2895 */
2896 @UnsupportedAppUsage
2897 @Deprecated
2898 public int untether(String iface) {
Remi NGUYEN VANe4d1cd92021-06-17 16:27:31 +09002899 return getTetheringManager().untether(iface);
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002900 }
2901
2902 /**
2903 * Check if the device allows for tethering. It may be disabled via
2904 * {@code ro.tether.denied} system property, Settings.TETHER_SUPPORTED or
2905 * due to device configuration.
2906 *
2907 * <p>If this app does not have permission to use this API, it will always
2908 * return false rather than throw an exception.</p>
2909 *
2910 * <p>If the device has a hotspot provisioning app, the caller is required to hold the
2911 * {@link android.Manifest.permission.TETHER_PRIVILEGED} permission.</p>
2912 *
2913 * <p>Otherwise, this method requires the caller to hold the ability to modify system
2914 * settings as determined by {@link android.provider.Settings.System#canWrite}.</p>
2915 *
2916 * @return a boolean - {@code true} indicating Tethering is supported.
2917 *
2918 * @deprecated Use {@link TetheringEventCallback#onTetheringSupported(boolean)} instead.
2919 * {@hide}
2920 */
2921 @SystemApi
2922 @RequiresPermission(anyOf = {android.Manifest.permission.TETHER_PRIVILEGED,
2923 android.Manifest.permission.WRITE_SETTINGS})
2924 public boolean isTetheringSupported() {
Remi NGUYEN VANe4d1cd92021-06-17 16:27:31 +09002925 return getTetheringManager().isTetheringSupported();
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002926 }
2927
2928 /**
2929 * Callback for use with {@link #startTethering} to find out whether tethering succeeded.
2930 *
2931 * @deprecated Use {@link TetheringManager.StartTetheringCallback} instead.
2932 * @hide
2933 */
2934 @SystemApi
2935 @Deprecated
2936 public static abstract class OnStartTetheringCallback {
2937 /**
2938 * Called when tethering has been successfully started.
2939 */
2940 public void onTetheringStarted() {}
2941
2942 /**
2943 * Called when starting tethering failed.
2944 */
2945 public void onTetheringFailed() {}
2946 }
2947
2948 /**
2949 * Convenient overload for
2950 * {@link #startTethering(int, boolean, OnStartTetheringCallback, Handler)} which passes a null
2951 * handler to run on the current thread's {@link Looper}.
2952 *
2953 * @deprecated Use {@link TetheringManager#startTethering} instead.
2954 * @hide
2955 */
2956 @SystemApi
2957 @Deprecated
2958 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
2959 public void startTethering(int type, boolean showProvisioningUi,
2960 final OnStartTetheringCallback callback) {
2961 startTethering(type, showProvisioningUi, callback, null);
2962 }
2963
2964 /**
2965 * Runs tether provisioning for the given type if needed and then starts tethering if
2966 * the check succeeds. If no carrier provisioning is required for tethering, tethering is
2967 * enabled immediately. If provisioning fails, tethering will not be enabled. It also
2968 * schedules tether provisioning re-checks if appropriate.
2969 *
2970 * @param type The type of tethering to start. Must be one of
2971 * {@link ConnectivityManager.TETHERING_WIFI},
2972 * {@link ConnectivityManager.TETHERING_USB}, or
2973 * {@link ConnectivityManager.TETHERING_BLUETOOTH}.
2974 * @param showProvisioningUi a boolean indicating to show the provisioning app UI if there
2975 * is one. This should be true the first time this function is called and also any time
2976 * the user can see this UI. It gives users information from their carrier about the
2977 * check failing and how they can sign up for tethering if possible.
2978 * @param callback an {@link OnStartTetheringCallback} which will be called to notify the caller
2979 * of the result of trying to tether.
2980 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
2981 *
2982 * @deprecated Use {@link TetheringManager#startTethering} instead.
2983 * @hide
2984 */
2985 @SystemApi
2986 @Deprecated
2987 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
2988 public void startTethering(int type, boolean showProvisioningUi,
2989 final OnStartTetheringCallback callback, Handler handler) {
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00002990 Objects.requireNonNull(callback, "OnStartTetheringCallback cannot be null.");
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002991
2992 final Executor executor = new Executor() {
2993 @Override
2994 public void execute(Runnable command) {
2995 if (handler == null) {
2996 command.run();
2997 } else {
2998 handler.post(command);
2999 }
3000 }
3001 };
3002
3003 final StartTetheringCallback tetheringCallback = new StartTetheringCallback() {
3004 @Override
3005 public void onTetheringStarted() {
3006 callback.onTetheringStarted();
3007 }
3008
3009 @Override
3010 public void onTetheringFailed(final int error) {
3011 callback.onTetheringFailed();
3012 }
3013 };
3014
3015 final TetheringRequest request = new TetheringRequest.Builder(type)
3016 .setShouldShowEntitlementUi(showProvisioningUi).build();
3017
Remi NGUYEN VANe4d1cd92021-06-17 16:27:31 +09003018 getTetheringManager().startTethering(request, executor, tetheringCallback);
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003019 }
3020
3021 /**
3022 * Stops tethering for the given type. Also cancels any provisioning rechecks for that type if
3023 * applicable.
3024 *
3025 * @param type The type of tethering to stop. Must be one of
3026 * {@link ConnectivityManager.TETHERING_WIFI},
3027 * {@link ConnectivityManager.TETHERING_USB}, or
3028 * {@link ConnectivityManager.TETHERING_BLUETOOTH}.
3029 *
3030 * @deprecated Use {@link TetheringManager#stopTethering} instead.
3031 * @hide
3032 */
3033 @SystemApi
3034 @Deprecated
3035 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
3036 public void stopTethering(int type) {
Remi NGUYEN VANe4d1cd92021-06-17 16:27:31 +09003037 getTetheringManager().stopTethering(type);
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003038 }
3039
3040 /**
3041 * Callback for use with {@link registerTetheringEventCallback} to find out tethering
3042 * upstream status.
3043 *
3044 * @deprecated Use {@link TetheringManager#OnTetheringEventCallback} instead.
3045 * @hide
3046 */
3047 @SystemApi
3048 @Deprecated
3049 public abstract static class OnTetheringEventCallback {
3050
3051 /**
3052 * Called when tethering upstream changed. This can be called multiple times and can be
3053 * called any time.
3054 *
3055 * @param network the {@link Network} of tethering upstream. Null means tethering doesn't
3056 * have any upstream.
3057 */
3058 public void onUpstreamChanged(@Nullable Network network) {}
3059 }
3060
3061 @GuardedBy("mTetheringEventCallbacks")
3062 private final ArrayMap<OnTetheringEventCallback, TetheringEventCallback>
3063 mTetheringEventCallbacks = new ArrayMap<>();
3064
3065 /**
3066 * Start listening to tethering change events. Any new added callback will receive the last
3067 * tethering status right away. If callback is registered when tethering has no upstream or
3068 * disabled, {@link OnTetheringEventCallback#onUpstreamChanged} will immediately be called
3069 * with a null argument. The same callback object cannot be registered twice.
3070 *
3071 * @param executor the executor on which callback will be invoked.
3072 * @param callback the callback to be called when tethering has change events.
3073 *
3074 * @deprecated Use {@link TetheringManager#registerTetheringEventCallback} instead.
3075 * @hide
3076 */
3077 @SystemApi
3078 @Deprecated
3079 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
3080 public void registerTetheringEventCallback(
3081 @NonNull @CallbackExecutor Executor executor,
3082 @NonNull final OnTetheringEventCallback callback) {
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00003083 Objects.requireNonNull(callback, "OnTetheringEventCallback cannot be null.");
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003084
3085 final TetheringEventCallback tetherCallback =
3086 new TetheringEventCallback() {
3087 @Override
3088 public void onUpstreamChanged(@Nullable Network network) {
3089 callback.onUpstreamChanged(network);
3090 }
3091 };
3092
3093 synchronized (mTetheringEventCallbacks) {
3094 mTetheringEventCallbacks.put(callback, tetherCallback);
Remi NGUYEN VANe4d1cd92021-06-17 16:27:31 +09003095 getTetheringManager().registerTetheringEventCallback(executor, tetherCallback);
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003096 }
3097 }
3098
3099 /**
3100 * Remove tethering event callback previously registered with
3101 * {@link #registerTetheringEventCallback}.
3102 *
3103 * @param callback previously registered callback.
3104 *
3105 * @deprecated Use {@link TetheringManager#unregisterTetheringEventCallback} instead.
3106 * @hide
3107 */
3108 @SystemApi
3109 @Deprecated
3110 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
3111 public void unregisterTetheringEventCallback(
3112 @NonNull final OnTetheringEventCallback callback) {
3113 Objects.requireNonNull(callback, "The callback must be non-null");
3114 synchronized (mTetheringEventCallbacks) {
3115 final TetheringEventCallback tetherCallback =
3116 mTetheringEventCallbacks.remove(callback);
Remi NGUYEN VANe4d1cd92021-06-17 16:27:31 +09003117 getTetheringManager().unregisterTetheringEventCallback(tetherCallback);
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003118 }
3119 }
3120
3121
3122 /**
3123 * Get the list of regular expressions that define any tetherable
3124 * USB network interfaces. If USB tethering is not supported by the
3125 * device, this list should be empty.
3126 *
3127 * @return an array of 0 or more regular expression Strings defining
3128 * what interfaces are considered tetherable usb interfaces.
3129 *
3130 * @deprecated Use {@link TetheringEventCallback#onTetherableInterfaceRegexpsChanged} instead.
3131 * {@hide}
3132 */
3133 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
3134 @UnsupportedAppUsage
3135 @Deprecated
3136 public String[] getTetherableUsbRegexs() {
Remi NGUYEN VANe4d1cd92021-06-17 16:27:31 +09003137 return getTetheringManager().getTetherableUsbRegexs();
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003138 }
3139
3140 /**
3141 * Get the list of regular expressions that define any tetherable
3142 * Wifi network interfaces. If Wifi tethering is not supported by the
3143 * device, this list should be empty.
3144 *
3145 * @return an array of 0 or more regular expression Strings defining
3146 * what interfaces are considered tetherable wifi interfaces.
3147 *
3148 * @deprecated Use {@link TetheringEventCallback#onTetherableInterfaceRegexpsChanged} instead.
3149 * {@hide}
3150 */
3151 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
3152 @UnsupportedAppUsage
3153 @Deprecated
3154 public String[] getTetherableWifiRegexs() {
Remi NGUYEN VANe4d1cd92021-06-17 16:27:31 +09003155 return getTetheringManager().getTetherableWifiRegexs();
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003156 }
3157
3158 /**
3159 * Get the list of regular expressions that define any tetherable
3160 * Bluetooth network interfaces. If Bluetooth tethering is not supported by the
3161 * device, this list should be empty.
3162 *
3163 * @return an array of 0 or more regular expression Strings defining
3164 * what interfaces are considered tetherable bluetooth interfaces.
3165 *
3166 * @deprecated Use {@link TetheringEventCallback#onTetherableInterfaceRegexpsChanged(
3167 *TetheringManager.TetheringInterfaceRegexps)} instead.
3168 * {@hide}
3169 */
3170 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
3171 @UnsupportedAppUsage
3172 @Deprecated
3173 public String[] getTetherableBluetoothRegexs() {
Remi NGUYEN VANe4d1cd92021-06-17 16:27:31 +09003174 return getTetheringManager().getTetherableBluetoothRegexs();
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003175 }
3176
3177 /**
3178 * Attempt to both alter the mode of USB and Tethering of USB. A
3179 * utility method to deal with some of the complexity of USB - will
3180 * attempt to switch to Rndis and subsequently tether the resulting
3181 * interface on {@code true} or turn off tethering and switch off
3182 * Rndis on {@code false}.
3183 *
3184 * <p>This method requires the caller to hold either the
3185 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
3186 * or the ability to modify system settings as determined by
3187 * {@link android.provider.Settings.System#canWrite}.</p>
3188 *
3189 * @param enable a boolean - {@code true} to enable tethering
3190 * @return error a {@code TETHER_ERROR} value indicating success or failure type
3191 * @deprecated Use {@link TetheringManager#startTethering} instead
3192 *
3193 * {@hide}
3194 */
3195 @UnsupportedAppUsage
3196 @Deprecated
3197 public int setUsbTethering(boolean enable) {
Remi NGUYEN VANe4d1cd92021-06-17 16:27:31 +09003198 return getTetheringManager().setUsbTethering(enable);
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003199 }
3200
3201 /**
3202 * @deprecated Use {@link TetheringManager#TETHER_ERROR_NO_ERROR}.
3203 * {@hide}
3204 */
3205 @SystemApi
3206 @Deprecated
Remi NGUYEN VAN71ced8e2021-02-15 18:52:06 +09003207 public static final int TETHER_ERROR_NO_ERROR = 0;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003208 /**
3209 * @deprecated Use {@link TetheringManager#TETHER_ERROR_UNKNOWN_IFACE}.
3210 * {@hide}
3211 */
3212 @Deprecated
3213 public static final int TETHER_ERROR_UNKNOWN_IFACE =
3214 TetheringManager.TETHER_ERROR_UNKNOWN_IFACE;
3215 /**
3216 * @deprecated Use {@link TetheringManager#TETHER_ERROR_SERVICE_UNAVAIL}.
3217 * {@hide}
3218 */
3219 @Deprecated
3220 public static final int TETHER_ERROR_SERVICE_UNAVAIL =
3221 TetheringManager.TETHER_ERROR_SERVICE_UNAVAIL;
3222 /**
3223 * @deprecated Use {@link TetheringManager#TETHER_ERROR_UNSUPPORTED}.
3224 * {@hide}
3225 */
3226 @Deprecated
3227 public static final int TETHER_ERROR_UNSUPPORTED = TetheringManager.TETHER_ERROR_UNSUPPORTED;
3228 /**
3229 * @deprecated Use {@link TetheringManager#TETHER_ERROR_UNAVAIL_IFACE}.
3230 * {@hide}
3231 */
3232 @Deprecated
3233 public static final int TETHER_ERROR_UNAVAIL_IFACE =
3234 TetheringManager.TETHER_ERROR_UNAVAIL_IFACE;
3235 /**
3236 * @deprecated Use {@link TetheringManager#TETHER_ERROR_INTERNAL_ERROR}.
3237 * {@hide}
3238 */
3239 @Deprecated
3240 public static final int TETHER_ERROR_MASTER_ERROR =
3241 TetheringManager.TETHER_ERROR_INTERNAL_ERROR;
3242 /**
3243 * @deprecated Use {@link TetheringManager#TETHER_ERROR_TETHER_IFACE_ERROR}.
3244 * {@hide}
3245 */
3246 @Deprecated
3247 public static final int TETHER_ERROR_TETHER_IFACE_ERROR =
3248 TetheringManager.TETHER_ERROR_TETHER_IFACE_ERROR;
3249 /**
3250 * @deprecated Use {@link TetheringManager#TETHER_ERROR_UNTETHER_IFACE_ERROR}.
3251 * {@hide}
3252 */
3253 @Deprecated
3254 public static final int TETHER_ERROR_UNTETHER_IFACE_ERROR =
3255 TetheringManager.TETHER_ERROR_UNTETHER_IFACE_ERROR;
3256 /**
3257 * @deprecated Use {@link TetheringManager#TETHER_ERROR_ENABLE_FORWARDING_ERROR}.
3258 * {@hide}
3259 */
3260 @Deprecated
3261 public static final int TETHER_ERROR_ENABLE_NAT_ERROR =
3262 TetheringManager.TETHER_ERROR_ENABLE_FORWARDING_ERROR;
3263 /**
3264 * @deprecated Use {@link TetheringManager#TETHER_ERROR_DISABLE_FORWARDING_ERROR}.
3265 * {@hide}
3266 */
3267 @Deprecated
3268 public static final int TETHER_ERROR_DISABLE_NAT_ERROR =
3269 TetheringManager.TETHER_ERROR_DISABLE_FORWARDING_ERROR;
3270 /**
3271 * @deprecated Use {@link TetheringManager#TETHER_ERROR_IFACE_CFG_ERROR}.
3272 * {@hide}
3273 */
3274 @Deprecated
3275 public static final int TETHER_ERROR_IFACE_CFG_ERROR =
3276 TetheringManager.TETHER_ERROR_IFACE_CFG_ERROR;
3277 /**
3278 * @deprecated Use {@link TetheringManager#TETHER_ERROR_PROVISIONING_FAILED}.
3279 * {@hide}
3280 */
3281 @SystemApi
3282 @Deprecated
Remi NGUYEN VAN71ced8e2021-02-15 18:52:06 +09003283 public static final int TETHER_ERROR_PROVISION_FAILED = 11;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003284 /**
3285 * @deprecated Use {@link TetheringManager#TETHER_ERROR_DHCPSERVER_ERROR}.
3286 * {@hide}
3287 */
3288 @Deprecated
3289 public static final int TETHER_ERROR_DHCPSERVER_ERROR =
3290 TetheringManager.TETHER_ERROR_DHCPSERVER_ERROR;
3291 /**
3292 * @deprecated Use {@link TetheringManager#TETHER_ERROR_ENTITLEMENT_UNKNOWN}.
3293 * {@hide}
3294 */
3295 @SystemApi
3296 @Deprecated
Remi NGUYEN VAN71ced8e2021-02-15 18:52:06 +09003297 public static final int TETHER_ERROR_ENTITLEMENT_UNKONWN = 13;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003298
3299 /**
3300 * Get a more detailed error code after a Tethering or Untethering
3301 * request asynchronously failed.
3302 *
3303 * @param iface The name of the interface of interest
3304 * @return error The error code of the last error tethering or untethering the named
3305 * interface
3306 *
3307 * @deprecated Use {@link TetheringEventCallback#onError(String, int)} instead.
3308 * {@hide}
3309 */
3310 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
3311 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
3312 @Deprecated
3313 public int getLastTetherError(String iface) {
Remi NGUYEN VANe4d1cd92021-06-17 16:27:31 +09003314 int error = getTetheringManager().getLastTetherError(iface);
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003315 if (error == TetheringManager.TETHER_ERROR_UNKNOWN_TYPE) {
3316 // TETHER_ERROR_UNKNOWN_TYPE was introduced with TetheringManager and has never been
3317 // returned by ConnectivityManager. Convert it to the legacy TETHER_ERROR_UNKNOWN_IFACE
3318 // instead.
3319 error = TetheringManager.TETHER_ERROR_UNKNOWN_IFACE;
3320 }
3321 return error;
3322 }
3323
3324 /** @hide */
3325 @Retention(RetentionPolicy.SOURCE)
3326 @IntDef(value = {
3327 TETHER_ERROR_NO_ERROR,
3328 TETHER_ERROR_PROVISION_FAILED,
3329 TETHER_ERROR_ENTITLEMENT_UNKONWN,
3330 })
3331 public @interface EntitlementResultCode {
3332 }
3333
3334 /**
3335 * Callback for use with {@link #getLatestTetheringEntitlementResult} to find out whether
3336 * entitlement succeeded.
3337 *
3338 * @deprecated Use {@link TetheringManager#OnTetheringEntitlementResultListener} instead.
3339 * @hide
3340 */
3341 @SystemApi
3342 @Deprecated
3343 public interface OnTetheringEntitlementResultListener {
3344 /**
3345 * Called to notify entitlement result.
3346 *
3347 * @param resultCode an int value of entitlement result. It may be one of
3348 * {@link #TETHER_ERROR_NO_ERROR},
3349 * {@link #TETHER_ERROR_PROVISION_FAILED}, or
3350 * {@link #TETHER_ERROR_ENTITLEMENT_UNKONWN}.
3351 */
3352 void onTetheringEntitlementResult(@EntitlementResultCode int resultCode);
3353 }
3354
3355 /**
3356 * Get the last value of the entitlement check on this downstream. If the cached value is
Chalard Jean0c7ebe92022-08-03 14:45:47 +09003357 * {@link #TETHER_ERROR_NO_ERROR} or showEntitlementUi argument is false, this just returns the
3358 * cached value. Otherwise, a UI-based entitlement check will be performed. It is not
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003359 * guaranteed that the UI-based entitlement check will complete in any specific time period
Chalard Jean0c7ebe92022-08-03 14:45:47 +09003360 * and it may in fact never complete. Any successful entitlement check the platform performs for
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003361 * any reason will update the cached value.
3362 *
3363 * @param type the downstream type of tethering. Must be one of
3364 * {@link #TETHERING_WIFI},
3365 * {@link #TETHERING_USB}, or
3366 * {@link #TETHERING_BLUETOOTH}.
3367 * @param showEntitlementUi a boolean indicating whether to run UI-based entitlement check.
3368 * @param executor the executor on which callback will be invoked.
3369 * @param listener an {@link OnTetheringEntitlementResultListener} which will be called to
3370 * notify the caller of the result of entitlement check. The listener may be called zero
3371 * or one time.
3372 * @deprecated Use {@link TetheringManager#requestLatestTetheringEntitlementResult} instead.
3373 * {@hide}
3374 */
3375 @SystemApi
3376 @Deprecated
3377 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
3378 public void getLatestTetheringEntitlementResult(int type, boolean showEntitlementUi,
3379 @NonNull @CallbackExecutor Executor executor,
3380 @NonNull final OnTetheringEntitlementResultListener listener) {
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00003381 Objects.requireNonNull(listener, "TetheringEntitlementResultListener cannot be null.");
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003382 ResultReceiver wrappedListener = new ResultReceiver(null) {
3383 @Override
3384 protected void onReceiveResult(int resultCode, Bundle resultData) {
lucaslineaff72d2021-03-04 09:38:21 +08003385 final long token = Binder.clearCallingIdentity();
3386 try {
3387 executor.execute(() -> {
3388 listener.onTetheringEntitlementResult(resultCode);
3389 });
3390 } finally {
3391 Binder.restoreCallingIdentity(token);
3392 }
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003393 }
3394 };
3395
Remi NGUYEN VANe4d1cd92021-06-17 16:27:31 +09003396 getTetheringManager().requestLatestTetheringEntitlementResult(type, wrappedListener,
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003397 showEntitlementUi);
3398 }
3399
3400 /**
3401 * Report network connectivity status. This is currently used only
3402 * to alter status bar UI.
3403 * <p>This method requires the caller to hold the permission
3404 * {@link android.Manifest.permission#STATUS_BAR}.
3405 *
3406 * @param networkType The type of network you want to report on
3407 * @param percentage The quality of the connection 0 is bad, 100 is good
3408 * @deprecated Types are deprecated. Use {@link #reportNetworkConnectivity} instead.
3409 * {@hide}
3410 */
3411 public void reportInetCondition(int networkType, int percentage) {
3412 printStackTrace();
3413 try {
3414 mService.reportInetCondition(networkType, percentage);
3415 } catch (RemoteException e) {
3416 throw e.rethrowFromSystemServer();
3417 }
3418 }
3419
3420 /**
3421 * Report a problem network to the framework. This provides a hint to the system
3422 * that there might be connectivity problems on this network and may cause
3423 * the framework to re-evaluate network connectivity and/or switch to another
3424 * network.
3425 *
3426 * @param network The {@link Network} the application was attempting to use
3427 * or {@code null} to indicate the current default network.
3428 * @deprecated Use {@link #reportNetworkConnectivity} which allows reporting both
3429 * working and non-working connectivity.
3430 */
3431 @Deprecated
3432 public void reportBadNetwork(@Nullable Network network) {
3433 printStackTrace();
3434 try {
3435 // One of these will be ignored because it matches system's current state.
3436 // The other will trigger the necessary reevaluation.
3437 mService.reportNetworkConnectivity(network, true);
3438 mService.reportNetworkConnectivity(network, false);
3439 } catch (RemoteException e) {
3440 throw e.rethrowFromSystemServer();
3441 }
3442 }
3443
3444 /**
3445 * Report to the framework whether a network has working connectivity.
3446 * This provides a hint to the system that a particular network is providing
3447 * working connectivity or not. In response the framework may re-evaluate
3448 * the network's connectivity and might take further action thereafter.
3449 *
3450 * @param network The {@link Network} the application was attempting to use
3451 * or {@code null} to indicate the current default network.
3452 * @param hasConnectivity {@code true} if the application was able to successfully access the
3453 * Internet using {@code network} or {@code false} if not.
3454 */
3455 public void reportNetworkConnectivity(@Nullable Network network, boolean hasConnectivity) {
3456 printStackTrace();
3457 try {
3458 mService.reportNetworkConnectivity(network, hasConnectivity);
3459 } catch (RemoteException e) {
3460 throw e.rethrowFromSystemServer();
3461 }
3462 }
3463
3464 /**
Chalard Jeane1ce6ae2021-03-17 17:03:34 +09003465 * Set a network-independent global HTTP proxy.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003466 *
Chalard Jeane1ce6ae2021-03-17 17:03:34 +09003467 * This sets an HTTP proxy that applies to all networks and overrides any network-specific
3468 * proxy. If set, HTTP libraries that are proxy-aware will use this global proxy when
3469 * accessing any network, regardless of what the settings for that network are.
3470 *
3471 * Note that HTTP proxies are by nature typically network-dependent, and setting a global
3472 * proxy is likely to break networking on multiple networks. This method is only meant
3473 * for device policy clients looking to do general internal filtering or similar use cases.
3474 *
chiachangwang9473c592022-07-15 02:25:52 +00003475 * @see #getGlobalProxy
3476 * @see LinkProperties#getHttpProxy
Chalard Jeane1ce6ae2021-03-17 17:03:34 +09003477 *
3478 * @param p A {@link ProxyInfo} object defining the new global HTTP proxy. Calling this
3479 * method with a {@code null} value will clear the global HTTP proxy.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003480 * @hide
3481 */
Chalard Jeane1ce6ae2021-03-17 17:03:34 +09003482 // Used by Device Policy Manager to set the global proxy.
Chiachang Wangf9294e72021-03-18 09:44:34 +08003483 @SystemApi(client = MODULE_LIBRARIES)
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003484 @RequiresPermission(android.Manifest.permission.NETWORK_STACK)
Chalard Jeane1ce6ae2021-03-17 17:03:34 +09003485 public void setGlobalProxy(@Nullable final ProxyInfo p) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003486 try {
3487 mService.setGlobalProxy(p);
3488 } catch (RemoteException e) {
3489 throw e.rethrowFromSystemServer();
3490 }
3491 }
3492
3493 /**
3494 * Retrieve any network-independent global HTTP proxy.
3495 *
3496 * @return {@link ProxyInfo} for the current global HTTP proxy or {@code null}
3497 * if no global HTTP proxy is set.
3498 * @hide
3499 */
Chiachang Wangf9294e72021-03-18 09:44:34 +08003500 @SystemApi(client = MODULE_LIBRARIES)
3501 @Nullable
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003502 public ProxyInfo getGlobalProxy() {
3503 try {
3504 return mService.getGlobalProxy();
3505 } catch (RemoteException e) {
3506 throw e.rethrowFromSystemServer();
3507 }
3508 }
3509
3510 /**
3511 * Retrieve the global HTTP proxy, or if no global HTTP proxy is set, a
3512 * network-specific HTTP proxy. If {@code network} is null, the
3513 * network-specific proxy returned is the proxy of the default active
3514 * network.
3515 *
3516 * @return {@link ProxyInfo} for the current global HTTP proxy, or if no
3517 * global HTTP proxy is set, {@code ProxyInfo} for {@code network},
3518 * or when {@code network} is {@code null},
3519 * the {@code ProxyInfo} for the default active network. Returns
3520 * {@code null} when no proxy applies or the caller doesn't have
3521 * permission to use {@code network}.
3522 * @hide
3523 */
3524 public ProxyInfo getProxyForNetwork(Network network) {
3525 try {
3526 return mService.getProxyForNetwork(network);
3527 } catch (RemoteException e) {
3528 throw e.rethrowFromSystemServer();
3529 }
3530 }
3531
3532 /**
3533 * Get the current default HTTP proxy settings. If a global proxy is set it will be returned,
3534 * otherwise if this process is bound to a {@link Network} using
3535 * {@link #bindProcessToNetwork} then that {@code Network}'s proxy is returned, otherwise
3536 * the default network's proxy is returned.
3537 *
3538 * @return the {@link ProxyInfo} for the current HTTP proxy, or {@code null} if no
3539 * HTTP proxy is active.
3540 */
3541 @Nullable
3542 public ProxyInfo getDefaultProxy() {
3543 return getProxyForNetwork(getBoundNetworkForProcess());
3544 }
3545
3546 /**
Chalard Jean0c7ebe92022-08-03 14:45:47 +09003547 * Returns whether the hardware supports the given network type.
3548 *
3549 * This doesn't indicate there is coverage or such a network is available, just whether the
3550 * hardware supports it. For example a GSM phone without a SIM card will return {@code true}
3551 * for mobile data, but a WiFi only tablet would return {@code false}.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003552 *
3553 * @param networkType The network type we'd like to check
3554 * @return {@code true} if supported, else {@code false}
3555 * @deprecated Types are deprecated. Use {@link NetworkCapabilities} instead.
3556 * @hide
3557 */
3558 @Deprecated
3559 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
3560 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 130143562)
3561 public boolean isNetworkSupported(int networkType) {
3562 try {
3563 return mService.isNetworkSupported(networkType);
3564 } catch (RemoteException e) {
3565 throw e.rethrowFromSystemServer();
3566 }
3567 }
3568
3569 /**
3570 * Returns if the currently active data network is metered. A network is
3571 * classified as metered when the user is sensitive to heavy data usage on
3572 * that connection due to monetary costs, data limitations or
3573 * battery/performance issues. You should check this before doing large
3574 * data transfers, and warn the user or delay the operation until another
3575 * network is available.
3576 *
3577 * @return {@code true} if large transfers should be avoided, otherwise
3578 * {@code false}.
3579 */
3580 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
3581 public boolean isActiveNetworkMetered() {
3582 try {
3583 return mService.isActiveNetworkMetered();
3584 } catch (RemoteException e) {
3585 throw e.rethrowFromSystemServer();
3586 }
3587 }
3588
3589 /**
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003590 * Set sign in error notification to visible or invisible
3591 *
3592 * @hide
3593 * @deprecated Doesn't properly deal with multiple connected networks of the same type.
3594 */
3595 @Deprecated
3596 public void setProvisioningNotificationVisible(boolean visible, int networkType,
3597 String action) {
3598 try {
3599 mService.setProvisioningNotificationVisible(visible, networkType, action);
3600 } catch (RemoteException e) {
3601 throw e.rethrowFromSystemServer();
3602 }
3603 }
3604
3605 /**
3606 * Set the value for enabling/disabling airplane mode
3607 *
3608 * @param enable whether to enable airplane mode or not
3609 *
3610 * @hide
3611 */
3612 @RequiresPermission(anyOf = {
3613 android.Manifest.permission.NETWORK_AIRPLANE_MODE,
3614 android.Manifest.permission.NETWORK_SETTINGS,
3615 android.Manifest.permission.NETWORK_SETUP_WIZARD,
3616 android.Manifest.permission.NETWORK_STACK})
3617 @SystemApi
3618 public void setAirplaneMode(boolean enable) {
3619 try {
3620 mService.setAirplaneMode(enable);
3621 } catch (RemoteException e) {
3622 throw e.rethrowFromSystemServer();
3623 }
3624 }
3625
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003626 /**
3627 * Registers the specified {@link NetworkProvider}.
3628 * Each listener must only be registered once. The listener can be unregistered with
3629 * {@link #unregisterNetworkProvider}.
3630 *
3631 * @param provider the provider to register
3632 * @return the ID of the provider. This ID must be used by the provider when registering
3633 * {@link android.net.NetworkAgent}s.
3634 * @hide
3635 */
3636 @SystemApi
3637 @RequiresPermission(anyOf = {
3638 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
3639 android.Manifest.permission.NETWORK_FACTORY})
3640 public int registerNetworkProvider(@NonNull NetworkProvider provider) {
3641 if (provider.getProviderId() != NetworkProvider.ID_NONE) {
3642 throw new IllegalStateException("NetworkProviders can only be registered once");
3643 }
3644
3645 try {
3646 int providerId = mService.registerNetworkProvider(provider.getMessenger(),
3647 provider.getName());
3648 provider.setProviderId(providerId);
3649 } catch (RemoteException e) {
3650 throw e.rethrowFromSystemServer();
3651 }
3652 return provider.getProviderId();
3653 }
3654
3655 /**
3656 * Unregisters the specified NetworkProvider.
3657 *
3658 * @param provider the provider to unregister
3659 * @hide
3660 */
3661 @SystemApi
3662 @RequiresPermission(anyOf = {
3663 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
3664 android.Manifest.permission.NETWORK_FACTORY})
3665 public void unregisterNetworkProvider(@NonNull NetworkProvider provider) {
3666 try {
3667 mService.unregisterNetworkProvider(provider.getMessenger());
3668 } catch (RemoteException e) {
3669 throw e.rethrowFromSystemServer();
3670 }
3671 provider.setProviderId(NetworkProvider.ID_NONE);
3672 }
3673
Chalard Jeand1b498b2021-01-05 08:40:09 +09003674 /**
3675 * Register or update a network offer with ConnectivityService.
3676 *
3677 * ConnectivityService keeps track of offers made by the various providers and matches
Chalard Jean61e231f2021-03-24 17:43:10 +09003678 * them to networking requests made by apps or the system. A callback identifies an offer
3679 * uniquely, and later calls with the same callback update the offer. The provider supplies a
3680 * score and the capabilities of the network it might be able to bring up ; these act as
3681 * filters used by ConnectivityService to only send those requests that can be fulfilled by the
Chalard Jeand1b498b2021-01-05 08:40:09 +09003682 * provider.
3683 *
3684 * The provider is under no obligation to be able to bring up the network it offers at any
3685 * given time. Instead, this mechanism is meant to limit requests received by providers
3686 * to those they actually have a chance to fulfill, as providers don't have a way to compare
3687 * the quality of the network satisfying a given request to their own offer.
3688 *
3689 * An offer can be updated by calling this again with the same callback object. This is
3690 * similar to calling unofferNetwork and offerNetwork again, but will only update the
3691 * provider with the changes caused by the changes in the offer.
3692 *
3693 * @param provider The provider making this offer.
3694 * @param score The prospective score of the network.
3695 * @param caps The prospective capabilities of the network.
3696 * @param callback The callback to call when this offer is needed or unneeded.
Chalard Jean428b9132021-01-12 10:58:56 +09003697 * @hide exposed via the NetworkProvider class.
Chalard Jeand1b498b2021-01-05 08:40:09 +09003698 */
3699 @RequiresPermission(anyOf = {
3700 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
3701 android.Manifest.permission.NETWORK_FACTORY})
Chalard Jean148dcce2021-03-22 22:44:02 +09003702 public void offerNetwork(@NonNull final int providerId,
Chalard Jeand1b498b2021-01-05 08:40:09 +09003703 @NonNull final NetworkScore score, @NonNull final NetworkCapabilities caps,
3704 @NonNull final INetworkOfferCallback callback) {
3705 try {
Chalard Jean148dcce2021-03-22 22:44:02 +09003706 mService.offerNetwork(providerId,
Chalard Jeand1b498b2021-01-05 08:40:09 +09003707 Objects.requireNonNull(score, "null score"),
3708 Objects.requireNonNull(caps, "null caps"),
3709 Objects.requireNonNull(callback, "null callback"));
3710 } catch (RemoteException e) {
3711 throw e.rethrowFromSystemServer();
3712 }
3713 }
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003714
Chalard Jeand1b498b2021-01-05 08:40:09 +09003715 /**
3716 * Withdraw a network offer made with {@link #offerNetwork}.
3717 *
3718 * @param callback The callback passed at registration time. This must be the same object
3719 * that was passed to {@link #offerNetwork}
Chalard Jean428b9132021-01-12 10:58:56 +09003720 * @hide exposed via the NetworkProvider class.
Chalard Jeand1b498b2021-01-05 08:40:09 +09003721 */
3722 public void unofferNetwork(@NonNull final INetworkOfferCallback callback) {
3723 try {
3724 mService.unofferNetwork(Objects.requireNonNull(callback));
3725 } catch (RemoteException e) {
3726 throw e.rethrowFromSystemServer();
3727 }
3728 }
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003729 /** @hide exposed via the NetworkProvider class. */
3730 @RequiresPermission(anyOf = {
3731 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
3732 android.Manifest.permission.NETWORK_FACTORY})
3733 public void declareNetworkRequestUnfulfillable(@NonNull NetworkRequest request) {
3734 try {
3735 mService.declareNetworkRequestUnfulfillable(request);
3736 } catch (RemoteException e) {
3737 throw e.rethrowFromSystemServer();
3738 }
3739 }
3740
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003741 /**
3742 * @hide
3743 * Register a NetworkAgent with ConnectivityService.
3744 * @return Network corresponding to NetworkAgent.
3745 */
3746 @RequiresPermission(anyOf = {
3747 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
3748 android.Manifest.permission.NETWORK_FACTORY})
3749 public Network registerNetworkAgent(INetworkAgent na, NetworkInfo ni, LinkProperties lp,
Chalard Jeand6372722020-12-21 18:36:52 +09003750 NetworkCapabilities nc, @NonNull NetworkScore score, NetworkAgentConfig config,
3751 int providerId) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003752 try {
3753 return mService.registerNetworkAgent(na, ni, lp, nc, score, config, providerId);
3754 } catch (RemoteException e) {
3755 throw e.rethrowFromSystemServer();
3756 }
3757 }
3758
3759 /**
3760 * Base class for {@code NetworkRequest} callbacks. Used for notifications about network
3761 * changes. Should be extended by applications wanting notifications.
3762 *
3763 * A {@code NetworkCallback} is registered by calling
3764 * {@link #requestNetwork(NetworkRequest, NetworkCallback)},
3765 * {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)},
3766 * or {@link #registerDefaultNetworkCallback(NetworkCallback)}. A {@code NetworkCallback} is
3767 * unregistered by calling {@link #unregisterNetworkCallback(NetworkCallback)}.
3768 * A {@code NetworkCallback} should be registered at most once at any time.
3769 * A {@code NetworkCallback} that has been unregistered can be registered again.
3770 */
3771 public static class NetworkCallback {
3772 /**
Roshan Piuse08bc182020-12-22 15:10:42 -08003773 * No flags associated with this callback.
3774 * @hide
3775 */
3776 public static final int FLAG_NONE = 0;
lucaslinc582d502022-01-27 09:07:00 +08003777
Roshan Piuse08bc182020-12-22 15:10:42 -08003778 /**
lucaslinc582d502022-01-27 09:07:00 +08003779 * Inclusion of this flag means location-sensitive redaction requests keeping location info.
3780 *
3781 * Some objects like {@link NetworkCapabilities} may contain location-sensitive information.
3782 * Prior to Android 12, this information is always returned to apps holding the appropriate
3783 * permission, possibly noting that the app has used location.
3784 * <p>In Android 12 and above, by default the sent objects do not contain any location
3785 * information, even if the app holds the necessary permissions, and the system does not
3786 * take note of location usage by the app. Apps can request that location information is
3787 * included, in which case the system will check location permission and the location
3788 * toggle state, and take note of location usage by the app if any such information is
3789 * returned.
3790 *
Roshan Piuse08bc182020-12-22 15:10:42 -08003791 * Use this flag to include any location sensitive data in {@link NetworkCapabilities} sent
3792 * via {@link #onCapabilitiesChanged(Network, NetworkCapabilities)}.
3793 * <p>
3794 * These include:
3795 * <li> Some transport info instances (retrieved via
3796 * {@link NetworkCapabilities#getTransportInfo()}) like {@link android.net.wifi.WifiInfo}
3797 * contain location sensitive information.
3798 * <li> OwnerUid (retrieved via {@link NetworkCapabilities#getOwnerUid()} is location
Anton Hanssondf401092021-10-20 11:27:13 +01003799 * sensitive for wifi suggestor apps (i.e using
3800 * {@link android.net.wifi.WifiNetworkSuggestion WifiNetworkSuggestion}).</li>
Roshan Piuse08bc182020-12-22 15:10:42 -08003801 * </p>
3802 * <p>
3803 * Note:
3804 * <li> Retrieving this location sensitive information (subject to app's location
3805 * permissions) will be noted by system. </li>
3806 * <li> Without this flag any {@link NetworkCapabilities} provided via the callback does
lucaslinc582d502022-01-27 09:07:00 +08003807 * not include location sensitive information.
Roshan Piuse08bc182020-12-22 15:10:42 -08003808 */
Roshan Pius189d0092021-03-11 21:16:44 -08003809 // Note: Some existing fields which are location sensitive may still be included without
3810 // this flag if the app targets SDK < S (to maintain backwards compatibility).
Roshan Piuse08bc182020-12-22 15:10:42 -08003811 public static final int FLAG_INCLUDE_LOCATION_INFO = 1 << 0;
3812
3813 /** @hide */
3814 @Retention(RetentionPolicy.SOURCE)
3815 @IntDef(flag = true, prefix = "FLAG_", value = {
3816 FLAG_NONE,
3817 FLAG_INCLUDE_LOCATION_INFO
3818 })
3819 public @interface Flag { }
3820
3821 /**
3822 * All the valid flags for error checking.
3823 */
3824 private static final int VALID_FLAGS = FLAG_INCLUDE_LOCATION_INFO;
3825
3826 public NetworkCallback() {
3827 this(FLAG_NONE);
3828 }
3829
3830 public NetworkCallback(@Flag int flags) {
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00003831 if ((flags & VALID_FLAGS) != flags) {
3832 throw new IllegalArgumentException("Invalid flags");
3833 }
Roshan Piuse08bc182020-12-22 15:10:42 -08003834 mFlags = flags;
3835 }
3836
3837 /**
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003838 * Called when the framework connects to a new network to evaluate whether it satisfies this
3839 * request. If evaluation succeeds, this callback may be followed by an {@link #onAvailable}
3840 * callback. There is no guarantee that this new network will satisfy any requests, or that
3841 * the network will stay connected for longer than the time necessary to evaluate it.
3842 * <p>
3843 * Most applications <b>should not</b> act on this callback, and should instead use
3844 * {@link #onAvailable}. This callback is intended for use by applications that can assist
3845 * the framework in properly evaluating the network &mdash; for example, an application that
3846 * can automatically log in to a captive portal without user intervention.
3847 *
3848 * @param network The {@link Network} of the network that is being evaluated.
3849 *
3850 * @hide
3851 */
3852 public void onPreCheck(@NonNull Network network) {}
3853
3854 /**
3855 * Called when the framework connects and has declared a new network ready for use.
3856 * This callback may be called more than once if the {@link Network} that is
3857 * satisfying the request changes.
3858 *
3859 * @param network The {@link Network} of the satisfying network.
3860 * @param networkCapabilities The {@link NetworkCapabilities} of the satisfying network.
3861 * @param linkProperties The {@link LinkProperties} of the satisfying network.
3862 * @param blocked Whether access to the {@link Network} is blocked due to system policy.
3863 * @hide
3864 */
Lorenzo Colitti8ad58122021-03-18 00:54:57 +09003865 public final void onAvailable(@NonNull Network network,
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003866 @NonNull NetworkCapabilities networkCapabilities,
Lorenzo Colitti8ad58122021-03-18 00:54:57 +09003867 @NonNull LinkProperties linkProperties, @BlockedReason int blocked) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003868 // Internally only this method is called when a new network is available, and
3869 // it calls the callback in the same way and order that older versions used
3870 // to call so as not to change the behavior.
Lorenzo Colitti8ad58122021-03-18 00:54:57 +09003871 onAvailable(network, networkCapabilities, linkProperties, blocked != 0);
3872 onBlockedStatusChanged(network, blocked);
3873 }
3874
3875 /**
3876 * Legacy variant of onAvailable that takes a boolean blocked reason.
3877 *
3878 * This method has never been public API, but it's not final, so there may be apps that
3879 * implemented it and rely on it being called. Do our best not to break them.
3880 * Note: such apps will also get a second call to onBlockedStatusChanged immediately after
3881 * this method is called. There does not seem to be a way to avoid this.
3882 * TODO: add a compat check to move apps off this method, and eventually stop calling it.
3883 *
3884 * @hide
3885 */
3886 public void onAvailable(@NonNull Network network,
3887 @NonNull NetworkCapabilities networkCapabilities,
3888 @NonNull LinkProperties linkProperties, boolean blocked) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003889 onAvailable(network);
3890 if (!networkCapabilities.hasCapability(
3891 NetworkCapabilities.NET_CAPABILITY_NOT_SUSPENDED)) {
3892 onNetworkSuspended(network);
3893 }
3894 onCapabilitiesChanged(network, networkCapabilities);
3895 onLinkPropertiesChanged(network, linkProperties);
Lorenzo Colitti8ad58122021-03-18 00:54:57 +09003896 // No call to onBlockedStatusChanged here. That is done by the caller.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003897 }
3898
3899 /**
3900 * Called when the framework connects and has declared a new network ready for use.
3901 *
3902 * <p>For callbacks registered with {@link #registerNetworkCallback}, multiple networks may
3903 * be available at the same time, and onAvailable will be called for each of these as they
3904 * appear.
3905 *
3906 * <p>For callbacks registered with {@link #requestNetwork} and
3907 * {@link #registerDefaultNetworkCallback}, this means the network passed as an argument
3908 * is the new best network for this request and is now tracked by this callback ; this
3909 * callback will no longer receive method calls about other networks that may have been
3910 * passed to this method previously. The previously-best network may have disconnected, or
3911 * it may still be around and the newly-best network may simply be better.
3912 *
3913 * <p>Starting with {@link android.os.Build.VERSION_CODES#O}, this will always immediately
3914 * be followed by a call to {@link #onCapabilitiesChanged(Network, NetworkCapabilities)}
3915 * then by a call to {@link #onLinkPropertiesChanged(Network, LinkProperties)}, and a call
3916 * to {@link #onBlockedStatusChanged(Network, boolean)}.
3917 *
3918 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
3919 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
3920 * this callback as this is prone to race conditions (there is no guarantee the objects
3921 * returned by these methods will be current). Instead, wait for a call to
3922 * {@link #onCapabilitiesChanged(Network, NetworkCapabilities)} and
3923 * {@link #onLinkPropertiesChanged(Network, LinkProperties)} whose arguments are guaranteed
3924 * to be well-ordered with respect to other callbacks.
3925 *
3926 * @param network The {@link Network} of the satisfying network.
3927 */
3928 public void onAvailable(@NonNull Network network) {}
3929
3930 /**
3931 * Called when the network is about to be lost, typically because there are no outstanding
3932 * requests left for it. This may be paired with a {@link NetworkCallback#onAvailable} call
3933 * with the new replacement network for graceful handover. This method is not guaranteed
3934 * to be called before {@link NetworkCallback#onLost} is called, for example in case a
3935 * network is suddenly disconnected.
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} that is about to be lost.
3943 * @param maxMsToLive The time in milliseconds the system intends to keep the network
3944 * connected for graceful handover; note that the network may still
3945 * suffer a hard loss at any time.
3946 */
3947 public void onLosing(@NonNull Network network, int maxMsToLive) {}
3948
3949 /**
3950 * Called when a network disconnects or otherwise no longer satisfies this request or
3951 * callback.
3952 *
3953 * <p>If the callback was registered with requestNetwork() or
3954 * registerDefaultNetworkCallback(), it will only be invoked against the last network
3955 * returned by onAvailable() when that network is lost and no other network satisfies
3956 * the criteria of the request.
3957 *
3958 * <p>If the callback was registered with registerNetworkCallback() it will be called for
3959 * each network which no longer satisfies the criteria of the callback.
3960 *
3961 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
3962 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
3963 * this callback as this is prone to race conditions ; calling these methods while in a
3964 * callback may return an outdated or even a null object.
3965 *
3966 * @param network The {@link Network} lost.
3967 */
3968 public void onLost(@NonNull Network network) {}
3969
3970 /**
3971 * Called if no network is found within the timeout time specified in
3972 * {@link #requestNetwork(NetworkRequest, NetworkCallback, int)} call or if the
3973 * requested network request cannot be fulfilled (whether or not a timeout was
3974 * specified). When this callback is invoked the associated
3975 * {@link NetworkRequest} will have already been removed and released, as if
3976 * {@link #unregisterNetworkCallback(NetworkCallback)} had been called.
3977 */
3978 public void onUnavailable() {}
3979
3980 /**
3981 * Called when the network corresponding to this request changes capabilities but still
3982 * satisfies the requested criteria.
3983 *
3984 * <p>Starting with {@link android.os.Build.VERSION_CODES#O} this method is guaranteed
3985 * to be called immediately after {@link #onAvailable}.
3986 *
3987 * <p>Do NOT call {@link #getLinkProperties(Network)} or other synchronous
3988 * ConnectivityManager methods in this callback as this is prone to race conditions :
3989 * calling these methods while in a callback may return an outdated or even a null object.
3990 *
3991 * @param network The {@link Network} whose capabilities have changed.
Roshan Piuse08bc182020-12-22 15:10:42 -08003992 * @param networkCapabilities The new {@link NetworkCapabilities} for this
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003993 * network.
3994 */
3995 public void onCapabilitiesChanged(@NonNull Network network,
3996 @NonNull NetworkCapabilities networkCapabilities) {}
3997
3998 /**
3999 * Called when the network corresponding to this request changes {@link LinkProperties}.
4000 *
4001 * <p>Starting with {@link android.os.Build.VERSION_CODES#O} this method is guaranteed
4002 * to be called immediately after {@link #onAvailable}.
4003 *
4004 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or other synchronous
4005 * ConnectivityManager methods in this callback as this is prone to race conditions :
4006 * calling these methods while in a callback may return an outdated or even a null object.
4007 *
4008 * @param network The {@link Network} whose link properties have changed.
4009 * @param linkProperties The new {@link LinkProperties} for this network.
4010 */
4011 public void onLinkPropertiesChanged(@NonNull Network network,
4012 @NonNull LinkProperties linkProperties) {}
4013
4014 /**
4015 * Called when the network the framework connected to for this request suspends data
4016 * transmission temporarily.
4017 *
4018 * <p>This generally means that while the TCP connections are still live temporarily
4019 * network data fails to transfer. To give a specific example, this is used on cellular
4020 * networks to mask temporary outages when driving through a tunnel, etc. In general this
4021 * means read operations on sockets on this network will block once the buffers are
4022 * drained, and write operations will block once the buffers are full.
4023 *
4024 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
4025 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
4026 * this callback as this is prone to race conditions (there is no guarantee the objects
4027 * returned by these methods will be current).
4028 *
4029 * @hide
4030 */
4031 public void onNetworkSuspended(@NonNull Network network) {}
4032
4033 /**
4034 * Called when the network the framework connected to for this request
4035 * returns from a {@link NetworkInfo.State#SUSPENDED} state. This should always be
4036 * preceded by a matching {@link NetworkCallback#onNetworkSuspended} call.
4037
4038 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
4039 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
4040 * this callback as this is prone to race conditions : calling these methods while in a
4041 * callback may return an outdated or even a null object.
4042 *
4043 * @hide
4044 */
4045 public void onNetworkResumed(@NonNull Network network) {}
4046
4047 /**
4048 * Called when access to the specified network is blocked or unblocked.
4049 *
4050 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
4051 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
4052 * this callback as this is prone to race conditions : calling these methods while in a
4053 * callback may return an outdated or even a null object.
4054 *
4055 * @param network The {@link Network} whose blocked status has changed.
4056 * @param blocked The blocked status of this {@link Network}.
4057 */
4058 public void onBlockedStatusChanged(@NonNull Network network, boolean blocked) {}
4059
Lorenzo Colitti8ad58122021-03-18 00:54:57 +09004060 /**
Lorenzo Colittia1bd6f62021-03-25 23:17:36 +09004061 * Called when access to the specified network is blocked or unblocked, or the reason for
4062 * access being blocked changes.
Lorenzo Colitti8ad58122021-03-18 00:54:57 +09004063 *
4064 * If a NetworkCallback object implements this method,
4065 * {@link #onBlockedStatusChanged(Network, boolean)} will not be called.
4066 *
4067 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
4068 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
4069 * this callback as this is prone to race conditions : calling these methods while in a
4070 * callback may return an outdated or even a null object.
4071 *
4072 * @param network The {@link Network} whose blocked status has changed.
4073 * @param blocked The blocked status of this {@link Network}.
4074 * @hide
4075 */
4076 @SystemApi(client = MODULE_LIBRARIES)
4077 public void onBlockedStatusChanged(@NonNull Network network, @BlockedReason int blocked) {
4078 onBlockedStatusChanged(network, blocked != 0);
4079 }
4080
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004081 private NetworkRequest networkRequest;
Roshan Piuse08bc182020-12-22 15:10:42 -08004082 private final int mFlags;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004083 }
4084
4085 /**
4086 * Constant error codes used by ConnectivityService to communicate about failures and errors
4087 * across a Binder boundary.
4088 * @hide
4089 */
4090 public interface Errors {
4091 int TOO_MANY_REQUESTS = 1;
4092 }
4093
4094 /** @hide */
4095 public static class TooManyRequestsException extends RuntimeException {}
4096
4097 private static RuntimeException convertServiceException(ServiceSpecificException e) {
4098 switch (e.errorCode) {
4099 case Errors.TOO_MANY_REQUESTS:
4100 return new TooManyRequestsException();
4101 default:
4102 Log.w(TAG, "Unknown service error code " + e.errorCode);
4103 return new RuntimeException(e);
4104 }
4105 }
4106
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004107 /** @hide */
Remi NGUYEN VAN1b9f03a2021-03-12 15:24:06 +09004108 public static final int CALLBACK_PRECHECK = 1;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004109 /** @hide */
Remi NGUYEN VAN1b9f03a2021-03-12 15:24:06 +09004110 public static final int CALLBACK_AVAILABLE = 2;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004111 /** @hide arg1 = TTL */
Remi NGUYEN VAN1b9f03a2021-03-12 15:24:06 +09004112 public static final int CALLBACK_LOSING = 3;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004113 /** @hide */
Remi NGUYEN VAN1b9f03a2021-03-12 15:24:06 +09004114 public static final int CALLBACK_LOST = 4;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004115 /** @hide */
Remi NGUYEN VAN1b9f03a2021-03-12 15:24:06 +09004116 public static final int CALLBACK_UNAVAIL = 5;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004117 /** @hide */
Remi NGUYEN VAN1b9f03a2021-03-12 15:24:06 +09004118 public static final int CALLBACK_CAP_CHANGED = 6;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004119 /** @hide */
Remi NGUYEN VAN1b9f03a2021-03-12 15:24:06 +09004120 public static final int CALLBACK_IP_CHANGED = 7;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004121 /** @hide obj = NetworkCapabilities, arg1 = seq number */
Remi NGUYEN VAN1b9f03a2021-03-12 15:24:06 +09004122 private static final int EXPIRE_LEGACY_REQUEST = 8;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004123 /** @hide */
Remi NGUYEN VAN1b9f03a2021-03-12 15:24:06 +09004124 public static final int CALLBACK_SUSPENDED = 9;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004125 /** @hide */
Remi NGUYEN VAN1b9f03a2021-03-12 15:24:06 +09004126 public static final int CALLBACK_RESUMED = 10;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004127 /** @hide */
Remi NGUYEN VAN1b9f03a2021-03-12 15:24:06 +09004128 public static final int CALLBACK_BLK_CHANGED = 11;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004129
4130 /** @hide */
4131 public static String getCallbackName(int whichCallback) {
4132 switch (whichCallback) {
4133 case CALLBACK_PRECHECK: return "CALLBACK_PRECHECK";
4134 case CALLBACK_AVAILABLE: return "CALLBACK_AVAILABLE";
4135 case CALLBACK_LOSING: return "CALLBACK_LOSING";
4136 case CALLBACK_LOST: return "CALLBACK_LOST";
4137 case CALLBACK_UNAVAIL: return "CALLBACK_UNAVAIL";
4138 case CALLBACK_CAP_CHANGED: return "CALLBACK_CAP_CHANGED";
4139 case CALLBACK_IP_CHANGED: return "CALLBACK_IP_CHANGED";
4140 case EXPIRE_LEGACY_REQUEST: return "EXPIRE_LEGACY_REQUEST";
4141 case CALLBACK_SUSPENDED: return "CALLBACK_SUSPENDED";
4142 case CALLBACK_RESUMED: return "CALLBACK_RESUMED";
4143 case CALLBACK_BLK_CHANGED: return "CALLBACK_BLK_CHANGED";
4144 default:
4145 return Integer.toString(whichCallback);
4146 }
4147 }
4148
zhujiatai79b0de92022-09-22 15:44:02 +08004149 private static class CallbackHandler extends Handler {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004150 private static final String TAG = "ConnectivityManager.CallbackHandler";
4151 private static final boolean DBG = false;
4152
4153 CallbackHandler(Looper looper) {
4154 super(looper);
4155 }
4156
4157 CallbackHandler(Handler handler) {
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00004158 this(Objects.requireNonNull(handler, "Handler cannot be null.").getLooper());
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004159 }
4160
4161 @Override
4162 public void handleMessage(Message message) {
4163 if (message.what == EXPIRE_LEGACY_REQUEST) {
zhujiatai79b0de92022-09-22 15:44:02 +08004164 // the sInstance can't be null because to send this message a ConnectivityManager
4165 // instance must have been created prior to creating the thread on which this
4166 // Handler is running.
4167 sInstance.expireRequest((NetworkCapabilities) message.obj, message.arg1);
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004168 return;
4169 }
4170
4171 final NetworkRequest request = getObject(message, NetworkRequest.class);
4172 final Network network = getObject(message, Network.class);
4173 final NetworkCallback callback;
4174 synchronized (sCallbacks) {
4175 callback = sCallbacks.get(request);
4176 if (callback == null) {
4177 Log.w(TAG,
4178 "callback not found for " + getCallbackName(message.what) + " message");
4179 return;
4180 }
4181 if (message.what == CALLBACK_UNAVAIL) {
4182 sCallbacks.remove(request);
4183 callback.networkRequest = ALREADY_UNREGISTERED;
4184 }
4185 }
4186 if (DBG) {
4187 Log.d(TAG, getCallbackName(message.what) + " for network " + network);
4188 }
4189
4190 switch (message.what) {
4191 case CALLBACK_PRECHECK: {
4192 callback.onPreCheck(network);
4193 break;
4194 }
4195 case CALLBACK_AVAILABLE: {
4196 NetworkCapabilities cap = getObject(message, NetworkCapabilities.class);
4197 LinkProperties lp = getObject(message, LinkProperties.class);
Lorenzo Colitti8ad58122021-03-18 00:54:57 +09004198 callback.onAvailable(network, cap, lp, message.arg1);
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004199 break;
4200 }
4201 case CALLBACK_LOSING: {
4202 callback.onLosing(network, message.arg1);
4203 break;
4204 }
4205 case CALLBACK_LOST: {
4206 callback.onLost(network);
4207 break;
4208 }
4209 case CALLBACK_UNAVAIL: {
4210 callback.onUnavailable();
4211 break;
4212 }
4213 case CALLBACK_CAP_CHANGED: {
4214 NetworkCapabilities cap = getObject(message, NetworkCapabilities.class);
4215 callback.onCapabilitiesChanged(network, cap);
4216 break;
4217 }
4218 case CALLBACK_IP_CHANGED: {
4219 LinkProperties lp = getObject(message, LinkProperties.class);
4220 callback.onLinkPropertiesChanged(network, lp);
4221 break;
4222 }
4223 case CALLBACK_SUSPENDED: {
4224 callback.onNetworkSuspended(network);
4225 break;
4226 }
4227 case CALLBACK_RESUMED: {
4228 callback.onNetworkResumed(network);
4229 break;
4230 }
4231 case CALLBACK_BLK_CHANGED: {
Lorenzo Colitti8ad58122021-03-18 00:54:57 +09004232 callback.onBlockedStatusChanged(network, message.arg1);
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004233 }
4234 }
4235 }
4236
4237 private <T> T getObject(Message msg, Class<T> c) {
4238 return (T) msg.getData().getParcelable(c.getSimpleName());
4239 }
4240 }
4241
4242 private CallbackHandler getDefaultHandler() {
4243 synchronized (sCallbacks) {
4244 if (sCallbackHandler == null) {
4245 sCallbackHandler = new CallbackHandler(ConnectivityThread.getInstanceLooper());
4246 }
4247 return sCallbackHandler;
4248 }
4249 }
4250
4251 private static final HashMap<NetworkRequest, NetworkCallback> sCallbacks = new HashMap<>();
4252 private static CallbackHandler sCallbackHandler;
4253
Lorenzo Colitti5f26b192021-03-12 22:48:07 +09004254 private NetworkRequest sendRequestForNetwork(int asUid, NetworkCapabilities need,
4255 NetworkCallback callback, int timeoutMs, NetworkRequest.Type reqType, int legacyType,
4256 CallbackHandler handler) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004257 printStackTrace();
4258 checkCallbackNotNull(callback);
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00004259 if (reqType != TRACK_DEFAULT && reqType != TRACK_SYSTEM_DEFAULT && need == null) {
4260 throw new IllegalArgumentException("null NetworkCapabilities");
4261 }
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004262 final NetworkRequest request;
4263 final String callingPackageName = mContext.getOpPackageName();
4264 try {
4265 synchronized(sCallbacks) {
4266 if (callback.networkRequest != null
4267 && callback.networkRequest != ALREADY_UNREGISTERED) {
4268 // TODO: throw exception instead and enforce 1:1 mapping of callbacks
4269 // and requests (http://b/20701525).
4270 Log.e(TAG, "NetworkCallback was already registered");
4271 }
4272 Messenger messenger = new Messenger(handler);
4273 Binder binder = new Binder();
Roshan Piuse08bc182020-12-22 15:10:42 -08004274 final int callbackFlags = callback.mFlags;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004275 if (reqType == LISTEN) {
4276 request = mService.listenForNetwork(
Roshan Piuse08bc182020-12-22 15:10:42 -08004277 need, messenger, binder, callbackFlags, callingPackageName,
Roshan Piusa8a477b2020-12-17 14:53:09 -08004278 getAttributionTag());
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004279 } else {
4280 request = mService.requestNetwork(
Lorenzo Colitti5f26b192021-03-12 22:48:07 +09004281 asUid, need, reqType.ordinal(), messenger, timeoutMs, binder,
4282 legacyType, callbackFlags, callingPackageName, getAttributionTag());
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004283 }
4284 if (request != null) {
4285 sCallbacks.put(request, callback);
4286 }
4287 callback.networkRequest = request;
4288 }
4289 } catch (RemoteException e) {
4290 throw e.rethrowFromSystemServer();
4291 } catch (ServiceSpecificException e) {
4292 throw convertServiceException(e);
4293 }
4294 return request;
4295 }
4296
Lorenzo Colitti5f26b192021-03-12 22:48:07 +09004297 private NetworkRequest sendRequestForNetwork(NetworkCapabilities need, NetworkCallback callback,
4298 int timeoutMs, NetworkRequest.Type reqType, int legacyType, CallbackHandler handler) {
4299 return sendRequestForNetwork(Process.INVALID_UID, need, callback, timeoutMs, reqType,
4300 legacyType, handler);
4301 }
4302
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004303 /**
4304 * Helper function to request a network with a particular legacy type.
4305 *
4306 * This API is only for use in internal system code that requests networks with legacy type and
4307 * relies on CONNECTIVITY_ACTION broadcasts instead of NetworkCallbacks. New caller should use
4308 * {@link #requestNetwork(NetworkRequest, NetworkCallback, Handler)} instead.
4309 *
4310 * @param request {@link NetworkRequest} describing this request.
4311 * @param timeoutMs The time in milliseconds to attempt looking for a suitable network
4312 * before {@link NetworkCallback#onUnavailable()} is called. The timeout must
4313 * be a positive value (i.e. >0).
4314 * @param legacyType to specify the network type(#TYPE_*).
4315 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
4316 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
4317 * the callback must not be shared - it uniquely specifies this request.
4318 *
4319 * @hide
4320 */
4321 @SystemApi
4322 @RequiresPermission(NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK)
4323 public void requestNetwork(@NonNull NetworkRequest request,
4324 int timeoutMs, int legacyType, @NonNull Handler handler,
4325 @NonNull NetworkCallback networkCallback) {
4326 if (legacyType == TYPE_NONE) {
4327 throw new IllegalArgumentException("TYPE_NONE is meaningless legacy type");
4328 }
4329 CallbackHandler cbHandler = new CallbackHandler(handler);
4330 NetworkCapabilities nc = request.networkCapabilities;
4331 sendRequestForNetwork(nc, networkCallback, timeoutMs, REQUEST, legacyType, cbHandler);
4332 }
4333
4334 /**
Roshan Piuse08bc182020-12-22 15:10:42 -08004335 * Request a network to satisfy a set of {@link NetworkCapabilities}.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004336 *
4337 * <p>This method will attempt to find the best network that matches the passed
4338 * {@link NetworkRequest}, and to bring up one that does if none currently satisfies the
4339 * criteria. The platform will evaluate which network is the best at its own discretion.
4340 * Throughput, latency, cost per byte, policy, user preference and other considerations
4341 * may be factored in the decision of what is considered the best network.
4342 *
4343 * <p>As long as this request is outstanding, the platform will try to maintain the best network
4344 * matching this request, while always attempting to match the request to a better network if
4345 * possible. If a better match is found, the platform will switch this request to the now-best
4346 * network and inform the app of the newly best network by invoking
4347 * {@link NetworkCallback#onAvailable(Network)} on the provided callback. Note that the platform
4348 * will not try to maintain any other network than the best one currently matching the request:
4349 * a network not matching any network request may be disconnected at any time.
4350 *
4351 * <p>For example, an application could use this method to obtain a connected cellular network
4352 * even if the device currently has a data connection over Ethernet. This may cause the cellular
4353 * radio to consume additional power. Or, an application could inform the system that it wants
4354 * a network supporting sending MMSes and have the system let it know about the currently best
4355 * MMS-supporting network through the provided {@link NetworkCallback}.
4356 *
4357 * <p>The status of the request can be followed by listening to the various callbacks described
4358 * in {@link NetworkCallback}. The {@link Network} object passed to the callback methods can be
4359 * used to direct traffic to the network (although accessing some networks may be subject to
4360 * holding specific permissions). Callers will learn about the specific characteristics of the
4361 * network through
4362 * {@link NetworkCallback#onCapabilitiesChanged(Network, NetworkCapabilities)} and
4363 * {@link NetworkCallback#onLinkPropertiesChanged(Network, LinkProperties)}. The methods of the
4364 * provided {@link NetworkCallback} will only be invoked due to changes in the best network
4365 * matching the request at any given time; therefore when a better network matching the request
4366 * becomes available, the {@link NetworkCallback#onAvailable(Network)} method is called
4367 * with the new network after which no further updates are given about the previously-best
4368 * network, unless it becomes the best again at some later time. All callbacks are invoked
4369 * in order on the same thread, which by default is a thread created by the framework running
4370 * in the app.
chiachangwang9473c592022-07-15 02:25:52 +00004371 * See {@link #requestNetwork(NetworkRequest, NetworkCallback, Handler)} to change where the
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004372 * callbacks are invoked.
4373 *
4374 * <p>This{@link NetworkRequest} will live until released via
4375 * {@link #unregisterNetworkCallback(NetworkCallback)} or the calling application exits, at
4376 * which point the system may let go of the network at any time.
4377 *
4378 * <p>A version of this method which takes a timeout is
4379 * {@link #requestNetwork(NetworkRequest, NetworkCallback, int)}, that an app can use to only
4380 * wait for a limited amount of time for the network to become unavailable.
4381 *
4382 * <p>It is presently unsupported to request a network with mutable
4383 * {@link NetworkCapabilities} such as
4384 * {@link NetworkCapabilities#NET_CAPABILITY_VALIDATED} or
4385 * {@link NetworkCapabilities#NET_CAPABILITY_CAPTIVE_PORTAL}
4386 * as these {@code NetworkCapabilities} represent states that a particular
4387 * network may never attain, and whether a network will attain these states
4388 * is unknown prior to bringing up the network so the framework does not
4389 * know how to go about satisfying a request with these capabilities.
4390 *
4391 * <p>This method requires the caller to hold either the
4392 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
4393 * or the ability to modify system settings as determined by
4394 * {@link android.provider.Settings.System#canWrite}.</p>
4395 *
4396 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4397 * number of outstanding requests to 100 per app (identified by their UID), shared with
4398 * all variants of this method, of {@link #registerNetworkCallback} as well as
4399 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4400 * Requesting a network with this method will count toward this limit. If this limit is
4401 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4402 * make sure to unregister the callbacks with
4403 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4404 *
4405 * @param request {@link NetworkRequest} describing this request.
4406 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
4407 * the callback must not be shared - it uniquely specifies this request.
4408 * The callback is invoked on the default internal Handler.
4409 * @throws IllegalArgumentException if {@code request} contains invalid network capabilities.
4410 * @throws SecurityException if missing the appropriate permissions.
4411 * @throws RuntimeException if the app already has too many callbacks registered.
4412 */
4413 public void requestNetwork(@NonNull NetworkRequest request,
4414 @NonNull NetworkCallback networkCallback) {
4415 requestNetwork(request, networkCallback, getDefaultHandler());
4416 }
4417
4418 /**
Roshan Piuse08bc182020-12-22 15:10:42 -08004419 * Request a network to satisfy a set of {@link NetworkCapabilities}.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004420 *
4421 * This method behaves identically to {@link #requestNetwork(NetworkRequest, NetworkCallback)}
4422 * but runs all the callbacks on the passed Handler.
4423 *
4424 * <p>This method has the same permission requirements as
4425 * {@link #requestNetwork(NetworkRequest, NetworkCallback)}, is subject to the same limitations,
4426 * and throws the same exceptions in the same conditions.
4427 *
4428 * @param request {@link NetworkRequest} describing this request.
4429 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
4430 * the callback must not be shared - it uniquely specifies this request.
4431 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
4432 */
4433 public void requestNetwork(@NonNull NetworkRequest request,
4434 @NonNull NetworkCallback networkCallback, @NonNull Handler handler) {
4435 CallbackHandler cbHandler = new CallbackHandler(handler);
4436 NetworkCapabilities nc = request.networkCapabilities;
4437 sendRequestForNetwork(nc, networkCallback, 0, REQUEST, TYPE_NONE, cbHandler);
4438 }
4439
4440 /**
Roshan Piuse08bc182020-12-22 15:10:42 -08004441 * Request a network to satisfy a set of {@link NetworkCapabilities}, limited
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004442 * by a timeout.
4443 *
4444 * This function behaves identically to the non-timed-out version
4445 * {@link #requestNetwork(NetworkRequest, NetworkCallback)}, but if a suitable network
4446 * is not found within the given time (in milliseconds) the
4447 * {@link NetworkCallback#onUnavailable()} callback is called. The request can still be
4448 * released normally by calling {@link #unregisterNetworkCallback(NetworkCallback)} but does
4449 * not have to be released if timed-out (it is automatically released). Unregistering a
4450 * request that timed out is not an error.
4451 *
4452 * <p>Do not use this method to poll for the existence of specific networks (e.g. with a small
4453 * timeout) - {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)} is provided
4454 * for that purpose. Calling this method will attempt to bring up the requested network.
4455 *
4456 * <p>This method has the same permission requirements as
4457 * {@link #requestNetwork(NetworkRequest, NetworkCallback)}, is subject to the same limitations,
4458 * and throws the same exceptions in the same conditions.
4459 *
4460 * @param request {@link NetworkRequest} describing this request.
4461 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
4462 * the callback must not be shared - it uniquely specifies this request.
4463 * @param timeoutMs The time in milliseconds to attempt looking for a suitable network
4464 * before {@link NetworkCallback#onUnavailable()} is called. The timeout must
4465 * be a positive value (i.e. >0).
4466 */
4467 public void requestNetwork(@NonNull NetworkRequest request,
4468 @NonNull NetworkCallback networkCallback, int timeoutMs) {
4469 checkTimeout(timeoutMs);
4470 NetworkCapabilities nc = request.networkCapabilities;
4471 sendRequestForNetwork(nc, networkCallback, timeoutMs, REQUEST, TYPE_NONE,
4472 getDefaultHandler());
4473 }
4474
4475 /**
Roshan Piuse08bc182020-12-22 15:10:42 -08004476 * Request a network to satisfy a set of {@link NetworkCapabilities}, limited
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004477 * by a timeout.
4478 *
4479 * This method behaves identically to
4480 * {@link #requestNetwork(NetworkRequest, NetworkCallback, int)} but runs all the callbacks
4481 * on the passed Handler.
4482 *
4483 * <p>This method has the same permission requirements as
4484 * {@link #requestNetwork(NetworkRequest, NetworkCallback)}, is subject to the same limitations,
4485 * and throws the same exceptions in the same conditions.
4486 *
4487 * @param request {@link NetworkRequest} describing this request.
4488 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
4489 * the callback must not be shared - it uniquely specifies this request.
4490 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
4491 * @param timeoutMs The time in milliseconds to attempt looking for a suitable network
4492 * before {@link NetworkCallback#onUnavailable} is called.
4493 */
4494 public void requestNetwork(@NonNull NetworkRequest request,
4495 @NonNull NetworkCallback networkCallback, @NonNull Handler handler, int timeoutMs) {
4496 checkTimeout(timeoutMs);
4497 CallbackHandler cbHandler = new CallbackHandler(handler);
4498 NetworkCapabilities nc = request.networkCapabilities;
4499 sendRequestForNetwork(nc, networkCallback, timeoutMs, REQUEST, TYPE_NONE, cbHandler);
4500 }
4501
4502 /**
4503 * The lookup key for a {@link Network} object included with the intent after
4504 * successfully finding a network for the applications request. Retrieve it with
4505 * {@link android.content.Intent#getParcelableExtra(String)}.
4506 * <p>
4507 * Note that if you intend to invoke {@link Network#openConnection(java.net.URL)}
4508 * then you must get a ConnectivityManager instance before doing so.
4509 */
4510 public static final String EXTRA_NETWORK = "android.net.extra.NETWORK";
4511
4512 /**
4513 * The lookup key for a {@link NetworkRequest} object included with the intent after
4514 * successfully finding a network for the applications request. Retrieve it with
4515 * {@link android.content.Intent#getParcelableExtra(String)}.
4516 */
4517 public static final String EXTRA_NETWORK_REQUEST = "android.net.extra.NETWORK_REQUEST";
4518
4519
4520 /**
Roshan Piuse08bc182020-12-22 15:10:42 -08004521 * Request a network to satisfy a set of {@link NetworkCapabilities}.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004522 *
4523 * This function behaves identically to the version that takes a NetworkCallback, but instead
4524 * of {@link NetworkCallback} a {@link PendingIntent} is used. This means
4525 * the request may outlive the calling application and get called back when a suitable
4526 * network is found.
4527 * <p>
4528 * The operation is an Intent broadcast that goes to a broadcast receiver that
4529 * you registered with {@link Context#registerReceiver} or through the
4530 * &lt;receiver&gt; tag in an AndroidManifest.xml file
4531 * <p>
4532 * The operation Intent is delivered with two extras, a {@link Network} typed
4533 * extra called {@link #EXTRA_NETWORK} and a {@link NetworkRequest}
4534 * typed extra called {@link #EXTRA_NETWORK_REQUEST} containing
4535 * the original requests parameters. It is important to create a new,
4536 * {@link NetworkCallback} based request before completing the processing of the
4537 * Intent to reserve the network or it will be released shortly after the Intent
4538 * is processed.
4539 * <p>
4540 * If there is already a request for this Intent registered (with the equality of
4541 * two Intents defined by {@link Intent#filterEquals}), then it will be removed and
4542 * replaced by this one, effectively releasing the previous {@link NetworkRequest}.
4543 * <p>
4544 * The request may be released normally by calling
4545 * {@link #releaseNetworkRequest(android.app.PendingIntent)}.
4546 * <p>It is presently unsupported to request a network with either
4547 * {@link NetworkCapabilities#NET_CAPABILITY_VALIDATED} or
4548 * {@link NetworkCapabilities#NET_CAPABILITY_CAPTIVE_PORTAL}
4549 * as these {@code NetworkCapabilities} represent states that a particular
4550 * network may never attain, and whether a network will attain these states
4551 * is unknown prior to bringing up the network so the framework does not
4552 * know how to go about satisfying a request with these capabilities.
4553 *
4554 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4555 * number of outstanding requests to 100 per app (identified by their UID), shared with
4556 * all variants of this method, of {@link #registerNetworkCallback} as well as
4557 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4558 * Requesting a network with this method will count toward this limit. If this limit is
4559 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4560 * make sure to unregister the callbacks with {@link #unregisterNetworkCallback(PendingIntent)}
4561 * or {@link #releaseNetworkRequest(PendingIntent)}.
4562 *
4563 * <p>This method requires the caller to hold either the
4564 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
4565 * or the ability to modify system settings as determined by
4566 * {@link android.provider.Settings.System#canWrite}.</p>
4567 *
4568 * @param request {@link NetworkRequest} describing this request.
4569 * @param operation Action to perform when the network is available (corresponds
4570 * to the {@link NetworkCallback#onAvailable} call. Typically
4571 * comes from {@link PendingIntent#getBroadcast}. Cannot be null.
4572 * @throws IllegalArgumentException if {@code request} contains invalid network capabilities.
4573 * @throws SecurityException if missing the appropriate permissions.
4574 * @throws RuntimeException if the app already has too many callbacks registered.
4575 */
4576 public void requestNetwork(@NonNull NetworkRequest request,
4577 @NonNull PendingIntent operation) {
4578 printStackTrace();
4579 checkPendingIntentNotNull(operation);
4580 try {
4581 mService.pendingRequestForNetwork(
4582 request.networkCapabilities, operation, mContext.getOpPackageName(),
4583 getAttributionTag());
4584 } catch (RemoteException e) {
4585 throw e.rethrowFromSystemServer();
4586 } catch (ServiceSpecificException e) {
4587 throw convertServiceException(e);
4588 }
4589 }
4590
4591 /**
4592 * Removes a request made via {@link #requestNetwork(NetworkRequest, android.app.PendingIntent)}
4593 * <p>
4594 * This method has the same behavior as
4595 * {@link #unregisterNetworkCallback(android.app.PendingIntent)} with respect to
4596 * releasing network resources and disconnecting.
4597 *
4598 * @param operation A PendingIntent equal (as defined by {@link Intent#filterEquals}) to the
4599 * PendingIntent passed to
4600 * {@link #requestNetwork(NetworkRequest, android.app.PendingIntent)} with the
4601 * corresponding NetworkRequest you'd like to remove. Cannot be null.
4602 */
4603 public void releaseNetworkRequest(@NonNull PendingIntent operation) {
4604 printStackTrace();
4605 checkPendingIntentNotNull(operation);
4606 try {
4607 mService.releasePendingNetworkRequest(operation);
4608 } catch (RemoteException e) {
4609 throw e.rethrowFromSystemServer();
4610 }
4611 }
4612
4613 private static void checkPendingIntentNotNull(PendingIntent intent) {
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00004614 Objects.requireNonNull(intent, "PendingIntent cannot be null.");
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004615 }
4616
4617 private static void checkCallbackNotNull(NetworkCallback callback) {
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00004618 Objects.requireNonNull(callback, "null NetworkCallback");
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004619 }
4620
4621 private static void checkTimeout(int timeoutMs) {
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00004622 if (timeoutMs <= 0) {
4623 throw new IllegalArgumentException("timeoutMs must be strictly positive.");
4624 }
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004625 }
4626
4627 /**
4628 * Registers to receive notifications about all networks which satisfy the given
4629 * {@link NetworkRequest}. The callbacks will continue to be called until
4630 * either the application exits or {@link #unregisterNetworkCallback(NetworkCallback)} is
4631 * called.
4632 *
4633 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4634 * number of outstanding requests to 100 per app (identified by their UID), shared with
4635 * all variants of this method, of {@link #requestNetwork} as well as
4636 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4637 * Requesting a network with this method will count toward this limit. If this limit is
4638 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4639 * make sure to unregister the callbacks with
4640 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4641 *
4642 * @param request {@link NetworkRequest} describing this request.
4643 * @param networkCallback The {@link NetworkCallback} that the system will call as suitable
4644 * networks change state.
4645 * The callback is invoked on the default internal Handler.
4646 * @throws RuntimeException if the app already has too many callbacks registered.
4647 */
4648 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
4649 public void registerNetworkCallback(@NonNull NetworkRequest request,
4650 @NonNull NetworkCallback networkCallback) {
4651 registerNetworkCallback(request, networkCallback, getDefaultHandler());
4652 }
4653
4654 /**
4655 * Registers to receive notifications about all networks which satisfy the given
4656 * {@link NetworkRequest}. The callbacks will continue to be called until
4657 * either the application exits or {@link #unregisterNetworkCallback(NetworkCallback)} is
4658 * called.
4659 *
4660 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4661 * number of outstanding requests to 100 per app (identified by their UID), shared with
4662 * all variants of this method, of {@link #requestNetwork} as well as
4663 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4664 * Requesting a network with this method will count toward this limit. If this limit is
4665 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4666 * make sure to unregister the callbacks with
4667 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4668 *
4669 *
4670 * @param request {@link NetworkRequest} describing this request.
4671 * @param networkCallback The {@link NetworkCallback} that the system will call as suitable
4672 * networks change state.
4673 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
4674 * @throws RuntimeException if the app already has too many callbacks registered.
4675 */
4676 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
4677 public void registerNetworkCallback(@NonNull NetworkRequest request,
4678 @NonNull NetworkCallback networkCallback, @NonNull Handler handler) {
4679 CallbackHandler cbHandler = new CallbackHandler(handler);
4680 NetworkCapabilities nc = request.networkCapabilities;
4681 sendRequestForNetwork(nc, networkCallback, 0, LISTEN, TYPE_NONE, cbHandler);
4682 }
4683
4684 /**
4685 * Registers a PendingIntent to be sent when a network is available which satisfies the given
4686 * {@link NetworkRequest}.
4687 *
4688 * This function behaves identically to the version that takes a NetworkCallback, but instead
4689 * of {@link NetworkCallback} a {@link PendingIntent} is used. This means
4690 * the request may outlive the calling application and get called back when a suitable
4691 * network is found.
4692 * <p>
4693 * The operation is an Intent broadcast that goes to a broadcast receiver that
4694 * you registered with {@link Context#registerReceiver} or through the
4695 * &lt;receiver&gt; tag in an AndroidManifest.xml file
4696 * <p>
4697 * The operation Intent is delivered with two extras, a {@link Network} typed
4698 * extra called {@link #EXTRA_NETWORK} and a {@link NetworkRequest}
4699 * typed extra called {@link #EXTRA_NETWORK_REQUEST} containing
4700 * the original requests parameters.
4701 * <p>
4702 * If there is already a request for this Intent registered (with the equality of
4703 * two Intents defined by {@link Intent#filterEquals}), then it will be removed and
4704 * replaced by this one, effectively releasing the previous {@link NetworkRequest}.
4705 * <p>
4706 * The request may be released normally by calling
4707 * {@link #unregisterNetworkCallback(android.app.PendingIntent)}.
4708 *
4709 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4710 * number of outstanding requests to 100 per app (identified by their UID), shared with
4711 * all variants of this method, of {@link #requestNetwork} as well as
4712 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4713 * Requesting a network with this method will count toward this limit. If this limit is
4714 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4715 * make sure to unregister the callbacks with {@link #unregisterNetworkCallback(PendingIntent)}
4716 * or {@link #releaseNetworkRequest(PendingIntent)}.
4717 *
4718 * @param request {@link NetworkRequest} describing this request.
4719 * @param operation Action to perform when the network is available (corresponds
4720 * to the {@link NetworkCallback#onAvailable} call. Typically
4721 * comes from {@link PendingIntent#getBroadcast}. Cannot be null.
4722 * @throws RuntimeException if the app already has too many callbacks registered.
4723 */
4724 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
4725 public void registerNetworkCallback(@NonNull NetworkRequest request,
4726 @NonNull PendingIntent operation) {
4727 printStackTrace();
4728 checkPendingIntentNotNull(operation);
4729 try {
4730 mService.pendingListenForNetwork(
Roshan Piusa8a477b2020-12-17 14:53:09 -08004731 request.networkCapabilities, operation, mContext.getOpPackageName(),
4732 getAttributionTag());
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004733 } catch (RemoteException e) {
4734 throw e.rethrowFromSystemServer();
4735 } catch (ServiceSpecificException e) {
4736 throw convertServiceException(e);
4737 }
4738 }
4739
4740 /**
Lorenzo Colittia77d05e2021-01-29 20:14:04 +09004741 * Registers to receive notifications about changes in the application's default network. This
4742 * may be a physical network or a virtual network, such as a VPN that applies to the
4743 * application. The callbacks will continue to be called until either the application exits or
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004744 * {@link #unregisterNetworkCallback(NetworkCallback)} is called.
4745 *
4746 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4747 * number of outstanding requests to 100 per app (identified by their UID), shared with
4748 * all variants of this method, of {@link #requestNetwork} as well as
4749 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4750 * Requesting a network with this method will count toward this limit. If this limit is
4751 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4752 * make sure to unregister the callbacks with
4753 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4754 *
4755 * @param networkCallback The {@link NetworkCallback} that the system will call as the
Lorenzo Colittia77d05e2021-01-29 20:14:04 +09004756 * application's default network changes.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004757 * The callback is invoked on the default internal Handler.
4758 * @throws RuntimeException if the app already has too many callbacks registered.
4759 */
4760 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
4761 public void registerDefaultNetworkCallback(@NonNull NetworkCallback networkCallback) {
4762 registerDefaultNetworkCallback(networkCallback, getDefaultHandler());
4763 }
4764
4765 /**
Lorenzo Colittia77d05e2021-01-29 20:14:04 +09004766 * Registers to receive notifications about changes in the application's default network. This
4767 * may be a physical network or a virtual network, such as a VPN that applies to the
4768 * application. The callbacks will continue to be called until either the application exits or
4769 * {@link #unregisterNetworkCallback(NetworkCallback)} is called.
4770 *
4771 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4772 * number of outstanding requests to 100 per app (identified by their UID), shared with
4773 * all variants of this method, of {@link #requestNetwork} as well as
4774 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4775 * Requesting a network with this method will count toward this limit. If this limit is
4776 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4777 * make sure to unregister the callbacks with
4778 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4779 *
4780 * @param networkCallback The {@link NetworkCallback} that the system will call as the
4781 * application's default network changes.
4782 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
4783 * @throws RuntimeException if the app already has too many callbacks registered.
4784 */
4785 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
4786 public void registerDefaultNetworkCallback(@NonNull NetworkCallback networkCallback,
4787 @NonNull Handler handler) {
Chiachang Wangc7d203d2021-04-20 15:41:24 +08004788 registerDefaultNetworkCallbackForUid(Process.INVALID_UID, networkCallback, handler);
Lorenzo Colitti5f26b192021-03-12 22:48:07 +09004789 }
4790
4791 /**
4792 * Registers to receive notifications about changes in the default network for the specified
4793 * UID. This may be a physical network or a virtual network, such as a VPN that applies to the
4794 * UID. The callbacks will continue to be called until either the application exits or
4795 * {@link #unregisterNetworkCallback(NetworkCallback)} is called.
4796 *
4797 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4798 * number of outstanding requests to 100 per app (identified by their UID), shared with
4799 * all variants of this method, of {@link #requestNetwork} as well as
4800 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4801 * Requesting a network with this method will count toward this limit. If this limit is
4802 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4803 * make sure to unregister the callbacks with
4804 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4805 *
4806 * @param uid the UID for which to track default network changes.
4807 * @param networkCallback The {@link NetworkCallback} that the system will call as the
4808 * UID's default network changes.
4809 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
4810 * @throws RuntimeException if the app already has too many callbacks registered.
4811 * @hide
4812 */
Lorenzo Colittib90bdbd2021-03-22 18:23:21 +09004813 @SystemApi(client = MODULE_LIBRARIES)
Lorenzo Colitti5f26b192021-03-12 22:48:07 +09004814 @SuppressLint({"ExecutorRegistration", "PairedRegistration"})
4815 @RequiresPermission(anyOf = {
4816 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
4817 android.Manifest.permission.NETWORK_SETTINGS})
Chiachang Wangc7d203d2021-04-20 15:41:24 +08004818 public void registerDefaultNetworkCallbackForUid(int uid,
Lorenzo Colitti5f26b192021-03-12 22:48:07 +09004819 @NonNull NetworkCallback networkCallback, @NonNull Handler handler) {
Lorenzo Colittia77d05e2021-01-29 20:14:04 +09004820 CallbackHandler cbHandler = new CallbackHandler(handler);
Lorenzo Colitti5f26b192021-03-12 22:48:07 +09004821 sendRequestForNetwork(uid, null /* need */, networkCallback, 0 /* timeoutMs */,
Lorenzo Colittia77d05e2021-01-29 20:14:04 +09004822 TRACK_DEFAULT, TYPE_NONE, cbHandler);
4823 }
4824
4825 /**
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004826 * Registers to receive notifications about changes in the system default network. The callbacks
4827 * will continue to be called until either the application exits or
4828 * {@link #unregisterNetworkCallback(NetworkCallback)} is called.
4829 *
Lorenzo Colittia77d05e2021-01-29 20:14:04 +09004830 * This method should not be used to determine networking state seen by applications, because in
4831 * many cases, most or even all application traffic may not use the default network directly,
4832 * and traffic from different applications may go on different networks by default. As an
4833 * example, if a VPN is connected, traffic from all applications might be sent through the VPN
4834 * and not onto the system default network. Applications or system components desiring to do
4835 * determine network state as seen by applications should use other methods such as
4836 * {@link #registerDefaultNetworkCallback(NetworkCallback, Handler)}.
4837 *
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004838 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4839 * number of outstanding requests to 100 per app (identified by their UID), shared with
4840 * all variants of this method, of {@link #requestNetwork} as well as
4841 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4842 * Requesting a network with this method will count toward this limit. If this limit is
4843 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4844 * make sure to unregister the callbacks with
4845 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4846 *
4847 * @param networkCallback The {@link NetworkCallback} that the system will call as the
4848 * system default network changes.
4849 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
4850 * @throws RuntimeException if the app already has too many callbacks registered.
Lorenzo Colittia77d05e2021-01-29 20:14:04 +09004851 *
4852 * @hide
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004853 */
Lorenzo Colittia77d05e2021-01-29 20:14:04 +09004854 @SystemApi(client = MODULE_LIBRARIES)
4855 @SuppressLint({"ExecutorRegistration", "PairedRegistration"})
4856 @RequiresPermission(anyOf = {
4857 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
Junyu Laiaa4ad8c2022-10-28 15:42:00 +08004858 android.Manifest.permission.NETWORK_SETTINGS,
Quang Luong98858d62023-02-11 00:25:24 +00004859 android.Manifest.permission.NETWORK_SETUP_WIZARD,
Junyu Laiaa4ad8c2022-10-28 15:42:00 +08004860 android.Manifest.permission.CONNECTIVITY_USE_RESTRICTED_NETWORKS})
Lorenzo Colittia77d05e2021-01-29 20:14:04 +09004861 public void registerSystemDefaultNetworkCallback(@NonNull NetworkCallback networkCallback,
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004862 @NonNull Handler handler) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004863 CallbackHandler cbHandler = new CallbackHandler(handler);
4864 sendRequestForNetwork(null /* NetworkCapabilities need */, networkCallback, 0,
Lorenzo Colittia77d05e2021-01-29 20:14:04 +09004865 TRACK_SYSTEM_DEFAULT, TYPE_NONE, cbHandler);
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004866 }
4867
4868 /**
junyulaibd123062021-03-15 11:48:48 +08004869 * Registers to receive notifications about the best matching network which satisfy the given
4870 * {@link NetworkRequest}. The callbacks will continue to be called until
4871 * either the application exits or {@link #unregisterNetworkCallback(NetworkCallback)} is
4872 * called.
4873 *
4874 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4875 * number of outstanding requests to 100 per app (identified by their UID), shared with
4876 * {@link #registerNetworkCallback} and its variants and {@link #requestNetwork} as well as
4877 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4878 * Requesting a network with this method will count toward this limit. If this limit is
4879 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4880 * make sure to unregister the callbacks with
4881 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4882 *
4883 *
4884 * @param request {@link NetworkRequest} describing this request.
4885 * @param networkCallback The {@link NetworkCallback} that the system will call as suitable
4886 * networks change state.
4887 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
4888 * @throws RuntimeException if the app already has too many callbacks registered.
junyulai5a5c99b2021-03-05 15:51:17 +08004889 */
junyulai5a5c99b2021-03-05 15:51:17 +08004890 @SuppressLint("ExecutorRegistration")
4891 public void registerBestMatchingNetworkCallback(@NonNull NetworkRequest request,
4892 @NonNull NetworkCallback networkCallback, @NonNull Handler handler) {
4893 final NetworkCapabilities nc = request.networkCapabilities;
4894 final CallbackHandler cbHandler = new CallbackHandler(handler);
junyulai7664f622021-03-12 20:05:08 +08004895 sendRequestForNetwork(nc, networkCallback, 0, LISTEN_FOR_BEST, TYPE_NONE, cbHandler);
junyulai5a5c99b2021-03-05 15:51:17 +08004896 }
4897
4898 /**
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004899 * Requests bandwidth update for a given {@link Network} and returns whether the update request
4900 * is accepted by ConnectivityService. Once accepted, ConnectivityService will poll underlying
4901 * network connection for updated bandwidth information. The caller will be notified via
4902 * {@link ConnectivityManager.NetworkCallback} if there is an update. Notice that this
4903 * method assumes that the caller has previously called
4904 * {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)} to listen for network
4905 * changes.
4906 *
4907 * @param network {@link Network} specifying which network you're interested.
4908 * @return {@code true} on success, {@code false} if the {@link Network} is no longer valid.
4909 */
4910 public boolean requestBandwidthUpdate(@NonNull Network network) {
4911 try {
4912 return mService.requestBandwidthUpdate(network);
4913 } catch (RemoteException e) {
4914 throw e.rethrowFromSystemServer();
4915 }
4916 }
4917
4918 /**
4919 * Unregisters a {@code NetworkCallback} and possibly releases networks originating from
4920 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} and
4921 * {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)} calls.
Chalard Jean0c7ebe92022-08-03 14:45:47 +09004922 * If the given {@code NetworkCallback} had previously been used with {@code #requestNetwork},
4923 * any networks that the device brought up only to satisfy that request will be disconnected.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004924 *
4925 * Notifications that would have triggered that {@code NetworkCallback} will immediately stop
4926 * triggering it as soon as this call returns.
4927 *
4928 * @param networkCallback The {@link NetworkCallback} used when making the request.
4929 */
4930 public void unregisterNetworkCallback(@NonNull NetworkCallback networkCallback) {
4931 printStackTrace();
4932 checkCallbackNotNull(networkCallback);
4933 final List<NetworkRequest> reqs = new ArrayList<>();
4934 // Find all requests associated to this callback and stop callback triggers immediately.
4935 // Callback is reusable immediately. http://b/20701525, http://b/35921499.
4936 synchronized (sCallbacks) {
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00004937 if (networkCallback.networkRequest == null) {
4938 throw new IllegalArgumentException("NetworkCallback was not registered");
4939 }
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004940 if (networkCallback.networkRequest == ALREADY_UNREGISTERED) {
4941 Log.d(TAG, "NetworkCallback was already unregistered");
4942 return;
4943 }
4944 for (Map.Entry<NetworkRequest, NetworkCallback> e : sCallbacks.entrySet()) {
4945 if (e.getValue() == networkCallback) {
4946 reqs.add(e.getKey());
4947 }
4948 }
4949 // TODO: throw exception if callback was registered more than once (http://b/20701525).
4950 for (NetworkRequest r : reqs) {
4951 try {
4952 mService.releaseNetworkRequest(r);
4953 } catch (RemoteException e) {
4954 throw e.rethrowFromSystemServer();
4955 }
4956 // Only remove mapping if rpc was successful.
4957 sCallbacks.remove(r);
4958 }
4959 networkCallback.networkRequest = ALREADY_UNREGISTERED;
4960 }
4961 }
4962
4963 /**
4964 * Unregisters a callback previously registered via
4965 * {@link #registerNetworkCallback(NetworkRequest, android.app.PendingIntent)}.
4966 *
4967 * @param operation A PendingIntent equal (as defined by {@link Intent#filterEquals}) to the
4968 * PendingIntent passed to
4969 * {@link #registerNetworkCallback(NetworkRequest, android.app.PendingIntent)}.
4970 * Cannot be null.
4971 */
4972 public void unregisterNetworkCallback(@NonNull PendingIntent operation) {
4973 releaseNetworkRequest(operation);
4974 }
4975
4976 /**
4977 * Informs the system whether it should switch to {@code network} regardless of whether it is
4978 * validated or not. If {@code accept} is true, and the network was explicitly selected by the
4979 * user (e.g., by selecting a Wi-Fi network in the Settings app), then the network will become
4980 * the system default network regardless of any other network that's currently connected. If
4981 * {@code always} is true, then the choice is remembered, so that the next time the user
4982 * connects to this network, the system will switch to it.
4983 *
4984 * @param network The network to accept.
4985 * @param accept Whether to accept the network even if unvalidated.
4986 * @param always Whether to remember this choice in the future.
4987 *
4988 * @hide
4989 */
Chiachang Wangf9294e72021-03-18 09:44:34 +08004990 @SystemApi(client = MODULE_LIBRARIES)
4991 @RequiresPermission(anyOf = {
4992 android.Manifest.permission.NETWORK_SETTINGS,
4993 android.Manifest.permission.NETWORK_SETUP_WIZARD,
4994 android.Manifest.permission.NETWORK_STACK,
4995 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK})
4996 public void setAcceptUnvalidated(@NonNull Network network, boolean accept, boolean always) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004997 try {
4998 mService.setAcceptUnvalidated(network, accept, always);
4999 } catch (RemoteException e) {
5000 throw e.rethrowFromSystemServer();
5001 }
5002 }
5003
5004 /**
5005 * Informs the system whether it should consider the network as validated even if it only has
5006 * partial connectivity. If {@code accept} is true, then the network will be considered as
5007 * validated even if connectivity is only partial. If {@code always} is true, then the choice
5008 * is remembered, so that the next time the user connects to this network, the system will
5009 * switch to it.
5010 *
5011 * @param network The network to accept.
5012 * @param accept Whether to consider the network as validated even if it has partial
5013 * connectivity.
5014 * @param always Whether to remember this choice in the future.
5015 *
5016 * @hide
5017 */
Chiachang Wangf9294e72021-03-18 09:44:34 +08005018 @SystemApi(client = MODULE_LIBRARIES)
5019 @RequiresPermission(anyOf = {
5020 android.Manifest.permission.NETWORK_SETTINGS,
5021 android.Manifest.permission.NETWORK_SETUP_WIZARD,
5022 android.Manifest.permission.NETWORK_STACK,
5023 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK})
5024 public void setAcceptPartialConnectivity(@NonNull Network network, boolean accept,
5025 boolean always) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005026 try {
5027 mService.setAcceptPartialConnectivity(network, accept, always);
5028 } catch (RemoteException e) {
5029 throw e.rethrowFromSystemServer();
5030 }
5031 }
5032
5033 /**
5034 * Informs the system to penalize {@code network}'s score when it becomes unvalidated. This is
5035 * only meaningful if the system is configured not to penalize such networks, e.g., if the
5036 * {@code config_networkAvoidBadWifi} configuration variable is set to 0 and the {@code
5037 * NETWORK_AVOID_BAD_WIFI setting is unset}.
5038 *
5039 * @param network The network to accept.
5040 *
5041 * @hide
5042 */
Chiachang Wangf9294e72021-03-18 09:44:34 +08005043 @SystemApi(client = MODULE_LIBRARIES)
5044 @RequiresPermission(anyOf = {
5045 android.Manifest.permission.NETWORK_SETTINGS,
5046 android.Manifest.permission.NETWORK_SETUP_WIZARD,
5047 android.Manifest.permission.NETWORK_STACK,
5048 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK})
5049 public void setAvoidUnvalidated(@NonNull Network network) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005050 try {
5051 mService.setAvoidUnvalidated(network);
5052 } catch (RemoteException e) {
5053 throw e.rethrowFromSystemServer();
5054 }
5055 }
5056
5057 /**
Chalard Jean0c7ebe92022-08-03 14:45:47 +09005058 * Temporarily allow bad Wi-Fi to override {@code config_networkAvoidBadWifi} configuration.
Chiachang Wang6eac9fb2021-06-17 22:11:30 +08005059 *
5060 * @param timeMs The expired current time. The value should be set within a limited time from
5061 * now.
5062 *
5063 * @hide
5064 */
5065 public void setTestAllowBadWifiUntil(long timeMs) {
5066 try {
5067 mService.setTestAllowBadWifiUntil(timeMs);
5068 } catch (RemoteException e) {
5069 throw e.rethrowFromSystemServer();
5070 }
5071 }
5072
5073 /**
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005074 * Requests that the system open the captive portal app on the specified network.
5075 *
Remi NGUYEN VAN8238a762021-03-16 18:06:06 +09005076 * <p>This is to be used on networks where a captive portal was detected, as per
5077 * {@link NetworkCapabilities#NET_CAPABILITY_CAPTIVE_PORTAL}.
5078 *
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005079 * @param network The network to log into.
5080 *
5081 * @hide
5082 */
Remi NGUYEN VAN8238a762021-03-16 18:06:06 +09005083 @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
5084 @RequiresPermission(anyOf = {
5085 android.Manifest.permission.NETWORK_SETTINGS,
5086 android.Manifest.permission.NETWORK_STACK,
5087 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK
5088 })
5089 public void startCaptivePortalApp(@NonNull Network network) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005090 try {
5091 mService.startCaptivePortalApp(network);
5092 } catch (RemoteException e) {
5093 throw e.rethrowFromSystemServer();
5094 }
5095 }
5096
5097 /**
5098 * Requests that the system open the captive portal app with the specified extras.
5099 *
5100 * <p>This endpoint is exclusively for use by the NetworkStack and is protected by the
5101 * corresponding permission.
5102 * @param network Network on which the captive portal was detected.
5103 * @param appExtras Extras to include in the app start intent.
5104 * @hide
5105 */
5106 @SystemApi
5107 @RequiresPermission(NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK)
5108 public void startCaptivePortalApp(@NonNull Network network, @NonNull Bundle appExtras) {
5109 try {
5110 mService.startCaptivePortalAppInternal(network, appExtras);
5111 } catch (RemoteException e) {
5112 throw e.rethrowFromSystemServer();
5113 }
5114 }
5115
5116 /**
Chalard Jean0c7ebe92022-08-03 14:45:47 +09005117 * Determine whether the device is configured to avoid bad Wi-Fi.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005118 * @hide
5119 */
5120 @SystemApi
5121 @RequiresPermission(anyOf = {
5122 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
5123 android.Manifest.permission.NETWORK_STACK})
5124 public boolean shouldAvoidBadWifi() {
5125 try {
5126 return mService.shouldAvoidBadWifi();
5127 } catch (RemoteException e) {
5128 throw e.rethrowFromSystemServer();
5129 }
5130 }
5131
5132 /**
5133 * It is acceptable to briefly use multipath data to provide seamless connectivity for
5134 * time-sensitive user-facing operations when the system default network is temporarily
5135 * unresponsive. The amount of data should be limited (less than one megabyte for every call to
5136 * this method), and the operation should be infrequent to ensure that data usage is limited.
5137 *
5138 * An example of such an operation might be a time-sensitive foreground activity, such as a
5139 * voice command, that the user is performing while walking out of range of a Wi-Fi network.
5140 */
5141 public static final int MULTIPATH_PREFERENCE_HANDOVER = 1 << 0;
5142
5143 /**
5144 * It is acceptable to use small amounts of multipath data on an ongoing basis to provide
5145 * a backup channel for traffic that is primarily going over another network.
5146 *
5147 * An example might be maintaining backup connections to peers or servers for the purpose of
5148 * fast fallback if the default network is temporarily unresponsive or disconnects. The traffic
5149 * on backup paths should be negligible compared to the traffic on the main path.
5150 */
5151 public static final int MULTIPATH_PREFERENCE_RELIABILITY = 1 << 1;
5152
5153 /**
5154 * It is acceptable to use metered data to improve network latency and performance.
5155 */
5156 public static final int MULTIPATH_PREFERENCE_PERFORMANCE = 1 << 2;
5157
5158 /**
5159 * Return value to use for unmetered networks. On such networks we currently set all the flags
5160 * to true.
5161 * @hide
5162 */
5163 public static final int MULTIPATH_PREFERENCE_UNMETERED =
5164 MULTIPATH_PREFERENCE_HANDOVER |
5165 MULTIPATH_PREFERENCE_RELIABILITY |
5166 MULTIPATH_PREFERENCE_PERFORMANCE;
5167
Aaron Huangcff22942021-05-27 16:31:26 +08005168 /** @hide */
5169 @Retention(RetentionPolicy.SOURCE)
5170 @IntDef(flag = true, value = {
5171 MULTIPATH_PREFERENCE_HANDOVER,
5172 MULTIPATH_PREFERENCE_RELIABILITY,
5173 MULTIPATH_PREFERENCE_PERFORMANCE,
5174 })
5175 public @interface MultipathPreference {
5176 }
5177
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005178 /**
5179 * Provides a hint to the calling application on whether it is desirable to use the
5180 * multinetwork APIs (e.g., {@link Network#openConnection}, {@link Network#bindSocket}, etc.)
5181 * for multipath data transfer on this network when it is not the system default network.
5182 * Applications desiring to use multipath network protocols should call this method before
5183 * each such operation.
5184 *
5185 * @param network The network on which the application desires to use multipath data.
Chalard Jean0c7ebe92022-08-03 14:45:47 +09005186 * If {@code null}, this method will return a preference that will generally
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005187 * apply to metered networks.
Chalard Jean0c7ebe92022-08-03 14:45:47 +09005188 * @return a bitwise OR of zero or more of the {@code MULTIPATH_PREFERENCE_*} constants.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005189 */
5190 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
5191 public @MultipathPreference int getMultipathPreference(@Nullable Network network) {
5192 try {
5193 return mService.getMultipathPreference(network);
5194 } catch (RemoteException e) {
5195 throw e.rethrowFromSystemServer();
5196 }
5197 }
5198
5199 /**
5200 * Resets all connectivity manager settings back to factory defaults.
5201 * @hide
5202 */
Chiachang Wangf9294e72021-03-18 09:44:34 +08005203 @SystemApi(client = MODULE_LIBRARIES)
5204 @RequiresPermission(anyOf = {
5205 android.Manifest.permission.NETWORK_SETTINGS,
5206 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK})
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005207 public void factoryReset() {
5208 try {
5209 mService.factoryReset();
Remi NGUYEN VANe4d1cd92021-06-17 16:27:31 +09005210 getTetheringManager().stopAllTethering();
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005211 } catch (RemoteException e) {
5212 throw e.rethrowFromSystemServer();
5213 }
5214 }
5215
5216 /**
5217 * Binds the current process to {@code network}. All Sockets created in the future
5218 * (and not explicitly bound via a bound SocketFactory from
5219 * {@link Network#getSocketFactory() Network.getSocketFactory()}) will be bound to
5220 * {@code network}. All host name resolutions will be limited to {@code network} as well.
5221 * Note that if {@code network} ever disconnects, all Sockets created in this way will cease to
5222 * work and all host name resolutions will fail. This is by design so an application doesn't
5223 * accidentally use Sockets it thinks are still bound to a particular {@link Network}.
5224 * To clear binding pass {@code null} for {@code network}. Using individually bound
5225 * Sockets created by Network.getSocketFactory().createSocket() and
5226 * performing network-specific host name resolutions via
5227 * {@link Network#getAllByName Network.getAllByName} is preferred to calling
5228 * {@code bindProcessToNetwork}.
5229 *
5230 * @param network The {@link Network} to bind the current process to, or {@code null} to clear
5231 * the current binding.
5232 * @return {@code true} on success, {@code false} if the {@link Network} is no longer valid.
5233 */
5234 public boolean bindProcessToNetwork(@Nullable Network network) {
5235 // Forcing callers to call through non-static function ensures ConnectivityManager
5236 // instantiated.
5237 return setProcessDefaultNetwork(network);
5238 }
5239
5240 /**
5241 * Binds the current process to {@code network}. All Sockets created in the future
5242 * (and not explicitly bound via a bound SocketFactory from
5243 * {@link Network#getSocketFactory() Network.getSocketFactory()}) will be bound to
5244 * {@code network}. All host name resolutions will be limited to {@code network} as well.
5245 * Note that if {@code network} ever disconnects, all Sockets created in this way will cease to
5246 * work and all host name resolutions will fail. This is by design so an application doesn't
5247 * accidentally use Sockets it thinks are still bound to a particular {@link Network}.
5248 * To clear binding pass {@code null} for {@code network}. Using individually bound
5249 * Sockets created by Network.getSocketFactory().createSocket() and
5250 * performing network-specific host name resolutions via
5251 * {@link Network#getAllByName Network.getAllByName} is preferred to calling
5252 * {@code setProcessDefaultNetwork}.
5253 *
5254 * @param network The {@link Network} to bind the current process to, or {@code null} to clear
5255 * the current binding.
5256 * @return {@code true} on success, {@code false} if the {@link Network} is no longer valid.
5257 * @deprecated This function can throw {@link IllegalStateException}. Use
5258 * {@link #bindProcessToNetwork} instead. {@code bindProcessToNetwork}
5259 * is a direct replacement.
5260 */
5261 @Deprecated
5262 public static boolean setProcessDefaultNetwork(@Nullable Network network) {
5263 int netId = (network == null) ? NETID_UNSET : network.netId;
5264 boolean isSameNetId = (netId == NetworkUtils.getBoundNetworkForProcess());
5265
5266 if (netId != NETID_UNSET) {
5267 netId = network.getNetIdForResolv();
5268 }
5269
5270 if (!NetworkUtils.bindProcessToNetwork(netId)) {
5271 return false;
5272 }
5273
5274 if (!isSameNetId) {
5275 // Set HTTP proxy system properties to match network.
5276 // TODO: Deprecate this static method and replace it with a non-static version.
5277 try {
Remi NGUYEN VAN8a831d62021-02-03 10:18:20 +09005278 Proxy.setHttpProxyConfiguration(getInstance().getDefaultProxy());
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005279 } catch (SecurityException e) {
5280 // The process doesn't have ACCESS_NETWORK_STATE, so we can't fetch the proxy.
5281 Log.e(TAG, "Can't set proxy properties", e);
5282 }
5283 // Must flush DNS cache as new network may have different DNS resolutions.
Remi NGUYEN VANb2e919f2021-07-02 09:34:36 +09005284 InetAddress.clearDnsCache();
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005285 // Must flush socket pool as idle sockets will be bound to previous network and may
5286 // cause subsequent fetches to be performed on old network.
Orion Hodson1f4fa9f2021-05-25 21:02:02 +01005287 NetworkEventDispatcher.getInstance().dispatchNetworkConfigurationChange();
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005288 }
5289
5290 return true;
5291 }
5292
5293 /**
5294 * Returns the {@link Network} currently bound to this process via
5295 * {@link #bindProcessToNetwork}, or {@code null} if no {@link Network} is explicitly bound.
5296 *
5297 * @return {@code Network} to which this process is bound, or {@code null}.
5298 */
5299 @Nullable
5300 public Network getBoundNetworkForProcess() {
Chalard Jean0c7ebe92022-08-03 14:45:47 +09005301 // Forcing callers to call through non-static function ensures ConnectivityManager has been
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005302 // instantiated.
5303 return getProcessDefaultNetwork();
5304 }
5305
5306 /**
5307 * Returns the {@link Network} currently bound to this process via
5308 * {@link #bindProcessToNetwork}, or {@code null} if no {@link Network} is explicitly bound.
5309 *
5310 * @return {@code Network} to which this process is bound, or {@code null}.
5311 * @deprecated Using this function can lead to other functions throwing
5312 * {@link IllegalStateException}. Use {@link #getBoundNetworkForProcess} instead.
5313 * {@code getBoundNetworkForProcess} is a direct replacement.
5314 */
5315 @Deprecated
5316 @Nullable
5317 public static Network getProcessDefaultNetwork() {
5318 int netId = NetworkUtils.getBoundNetworkForProcess();
5319 if (netId == NETID_UNSET) return null;
5320 return new Network(netId);
5321 }
5322
5323 private void unsupportedStartingFrom(int version) {
5324 if (Process.myUid() == Process.SYSTEM_UID) {
5325 // The getApplicationInfo() call we make below is not supported in system context. Let
5326 // the call through here, and rely on the fact that ConnectivityService will refuse to
5327 // allow the system to use these APIs anyway.
5328 return;
5329 }
5330
5331 if (mContext.getApplicationInfo().targetSdkVersion >= version) {
5332 throw new UnsupportedOperationException(
5333 "This method is not supported in target SDK version " + version + " and above");
5334 }
5335 }
5336
5337 // Checks whether the calling app can use the legacy routing API (startUsingNetworkFeature,
5338 // stopUsingNetworkFeature, requestRouteToHost), and if not throw UnsupportedOperationException.
5339 // TODO: convert the existing system users (Tethering, GnssLocationProvider) to the new APIs and
5340 // remove these exemptions. Note that this check is not secure, and apps can still access these
5341 // functions by accessing ConnectivityService directly. However, it should be clear that doing
5342 // so is unsupported and may break in the future. http://b/22728205
5343 private void checkLegacyRoutingApiAccess() {
5344 unsupportedStartingFrom(VERSION_CODES.M);
5345 }
5346
5347 /**
5348 * Binds host resolutions performed by this process to {@code network}.
5349 * {@link #bindProcessToNetwork} takes precedence over this setting.
5350 *
5351 * @param network The {@link Network} to bind host resolutions from the current process to, or
5352 * {@code null} to clear the current binding.
5353 * @return {@code true} on success, {@code false} if the {@link Network} is no longer valid.
5354 * @hide
5355 * @deprecated This is strictly for legacy usage to support {@link #startUsingNetworkFeature}.
5356 */
5357 @Deprecated
5358 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
5359 public static boolean setProcessDefaultNetworkForHostResolution(Network network) {
5360 return NetworkUtils.bindProcessToNetworkForHostResolution(
5361 (network == null) ? NETID_UNSET : network.getNetIdForResolv());
5362 }
5363
5364 /**
5365 * Device is not restricting metered network activity while application is running on
5366 * background.
5367 */
5368 public static final int RESTRICT_BACKGROUND_STATUS_DISABLED = 1;
5369
5370 /**
5371 * Device is restricting metered network activity while application is running on background,
5372 * but application is allowed to bypass it.
5373 * <p>
5374 * In this state, application should take action to mitigate metered network access.
5375 * For example, a music streaming application should switch to a low-bandwidth bitrate.
5376 */
5377 public static final int RESTRICT_BACKGROUND_STATUS_WHITELISTED = 2;
5378
5379 /**
5380 * Device is restricting metered network activity while application is running on background.
5381 * <p>
5382 * In this state, application should not try to use the network while running on background,
5383 * because it would be denied.
5384 */
5385 public static final int RESTRICT_BACKGROUND_STATUS_ENABLED = 3;
5386
5387 /**
5388 * A change in the background metered network activity restriction has occurred.
5389 * <p>
5390 * Applications should call {@link #getRestrictBackgroundStatus()} to check if the restriction
5391 * applies to them.
5392 * <p>
5393 * This is only sent to registered receivers, not manifest receivers.
5394 */
5395 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
5396 public static final String ACTION_RESTRICT_BACKGROUND_CHANGED =
5397 "android.net.conn.RESTRICT_BACKGROUND_CHANGED";
5398
Aaron Huangcff22942021-05-27 16:31:26 +08005399 /** @hide */
5400 @Retention(RetentionPolicy.SOURCE)
5401 @IntDef(flag = false, value = {
5402 RESTRICT_BACKGROUND_STATUS_DISABLED,
5403 RESTRICT_BACKGROUND_STATUS_WHITELISTED,
5404 RESTRICT_BACKGROUND_STATUS_ENABLED,
5405 })
5406 public @interface RestrictBackgroundStatus {
5407 }
5408
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005409 /**
5410 * Determines if the calling application is subject to metered network restrictions while
5411 * running on background.
5412 *
5413 * @return {@link #RESTRICT_BACKGROUND_STATUS_DISABLED},
5414 * {@link #RESTRICT_BACKGROUND_STATUS_ENABLED},
5415 * or {@link #RESTRICT_BACKGROUND_STATUS_WHITELISTED}
5416 */
5417 public @RestrictBackgroundStatus int getRestrictBackgroundStatus() {
5418 try {
Remi NGUYEN VAN1fdeb502021-03-18 14:23:12 +09005419 return mService.getRestrictBackgroundStatusByCaller();
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005420 } catch (RemoteException e) {
5421 throw e.rethrowFromSystemServer();
5422 }
5423 }
5424
5425 /**
5426 * The network watchlist is a list of domains and IP addresses that are associated with
5427 * potentially harmful apps. This method returns the SHA-256 of the watchlist config file
5428 * currently used by the system for validation purposes.
5429 *
5430 * @return Hash of network watchlist config file. Null if config does not exist.
5431 */
5432 @Nullable
5433 public byte[] getNetworkWatchlistConfigHash() {
5434 try {
5435 return mService.getNetworkWatchlistConfigHash();
5436 } catch (RemoteException e) {
5437 Log.e(TAG, "Unable to get watchlist config hash");
5438 throw e.rethrowFromSystemServer();
5439 }
5440 }
5441
5442 /**
5443 * Returns the {@code uid} of the owner of a network connection.
5444 *
5445 * @param protocol The protocol of the connection. Only {@code IPPROTO_TCP} and {@code
5446 * IPPROTO_UDP} currently supported.
5447 * @param local The local {@link InetSocketAddress} of a connection.
5448 * @param remote The remote {@link InetSocketAddress} of a connection.
5449 * @return {@code uid} if the connection is found and the app has permission to observe it
5450 * (e.g., if it is associated with the calling VPN app's VpnService tunnel) or {@link
5451 * android.os.Process#INVALID_UID} if the connection is not found.
5452 * @throws {@link SecurityException} if the caller is not the active VpnService for the current
5453 * user.
5454 * @throws {@link IllegalArgumentException} if an unsupported protocol is requested.
5455 */
5456 public int getConnectionOwnerUid(
5457 int protocol, @NonNull InetSocketAddress local, @NonNull InetSocketAddress remote) {
5458 ConnectionInfo connectionInfo = new ConnectionInfo(protocol, local, remote);
5459 try {
5460 return mService.getConnectionOwnerUid(connectionInfo);
5461 } catch (RemoteException e) {
5462 throw e.rethrowFromSystemServer();
5463 }
5464 }
5465
5466 private void printStackTrace() {
5467 if (DEBUG) {
5468 final StackTraceElement[] callStack = Thread.currentThread().getStackTrace();
5469 final StringBuffer sb = new StringBuffer();
5470 for (int i = 3; i < callStack.length; i++) {
5471 final String stackTrace = callStack[i].toString();
5472 if (stackTrace == null || stackTrace.contains("android.os")) {
5473 break;
5474 }
5475 sb.append(" [").append(stackTrace).append("]");
5476 }
5477 Log.d(TAG, "StackLog:" + sb.toString());
5478 }
5479 }
5480
Remi NGUYEN VAN91444ca2021-01-15 23:02:47 +09005481 /** @hide */
5482 public TestNetworkManager startOrGetTestNetworkManager() {
5483 final IBinder tnBinder;
5484 try {
5485 tnBinder = mService.startOrGetTestNetworkService();
5486 } catch (RemoteException e) {
5487 throw e.rethrowFromSystemServer();
5488 }
5489
5490 return new TestNetworkManager(ITestNetworkManager.Stub.asInterface(tnBinder));
5491 }
5492
Remi NGUYEN VAN91444ca2021-01-15 23:02:47 +09005493 /** @hide */
5494 public ConnectivityDiagnosticsManager createDiagnosticsManager() {
5495 return new ConnectivityDiagnosticsManager(mContext, mService);
5496 }
5497
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005498 /**
5499 * Simulates a Data Stall for the specified Network.
5500 *
5501 * <p>This method should only be used for tests.
5502 *
Remi NGUYEN VAN564f7f82021-04-08 16:26:20 +09005503 * <p>The caller must be the owner of the specified Network. This simulates a data stall to
5504 * have the system behave as if it had happened, but does not actually stall connectivity.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005505 *
5506 * @param detectionMethod The detection method used to identify the Data Stall.
Remi NGUYEN VAN564f7f82021-04-08 16:26:20 +09005507 * See ConnectivityDiagnosticsManager.DataStallReport.DETECTION_METHOD_*.
5508 * @param timestampMillis The timestamp at which the stall 'occurred', in milliseconds, as per
5509 * SystemClock.elapsedRealtime.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005510 * @param network The Network for which a Data Stall is being simluated.
5511 * @param extras The PersistableBundle of extras included in the Data Stall notification.
5512 * @throws SecurityException if the caller is not the owner of the given network.
5513 * @hide
5514 */
5515 @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
5516 @RequiresPermission(anyOf = {android.Manifest.permission.MANAGE_TEST_NETWORKS,
5517 android.Manifest.permission.NETWORK_STACK})
Remi NGUYEN VAN564f7f82021-04-08 16:26:20 +09005518 public void simulateDataStall(@DetectionMethod int detectionMethod, long timestampMillis,
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005519 @NonNull Network network, @NonNull PersistableBundle extras) {
5520 try {
5521 mService.simulateDataStall(detectionMethod, timestampMillis, network, extras);
5522 } catch (RemoteException e) {
5523 e.rethrowFromSystemServer();
5524 }
5525 }
5526
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005527 @NonNull
5528 private final List<QosCallbackConnection> mQosCallbackConnections = new ArrayList<>();
5529
5530 /**
5531 * Registers a {@link QosSocketInfo} with an associated {@link QosCallback}. The callback will
5532 * receive available QoS events related to the {@link Network} and local ip + port
5533 * specified within socketInfo.
5534 * <p/>
5535 * The same {@link QosCallback} must be unregistered before being registered a second time,
5536 * otherwise {@link QosCallbackRegistrationException} is thrown.
5537 * <p/>
5538 * This API does not, in itself, require any permission if called with a network that is not
5539 * restricted. However, the underlying implementation currently only supports the IMS network,
5540 * which is always restricted. That means non-preinstalled callers can't possibly find this API
5541 * useful, because they'd never be called back on networks that they would have access to.
5542 *
5543 * @throws SecurityException if {@link QosSocketInfo#getNetwork()} is restricted and the app is
5544 * missing CONNECTIVITY_USE_RESTRICTED_NETWORKS permission.
5545 * @throws QosCallback.QosCallbackRegistrationException if qosCallback is already registered.
5546 * @throws RuntimeException if the app already has too many callbacks registered.
5547 *
5548 * Exceptions after the time of registration is passed through
5549 * {@link QosCallback#onError(QosCallbackException)}. see: {@link QosCallbackException}.
5550 *
5551 * @param socketInfo the socket information used to match QoS events
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005552 * @param executor The executor on which the callback will be invoked. The provided
5553 * {@link Executor} must run callback sequentially, otherwise the order of
Daniel Bright686d5d22021-03-10 11:51:50 -08005554 * callbacks cannot be guaranteed.onQosCallbackRegistered
5555 * @param callback receives qos events that satisfy socketInfo
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005556 *
5557 * @hide
5558 */
5559 @SystemApi
5560 public void registerQosCallback(@NonNull final QosSocketInfo socketInfo,
Daniel Bright686d5d22021-03-10 11:51:50 -08005561 @CallbackExecutor @NonNull final Executor executor,
5562 @NonNull final QosCallback callback) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005563 Objects.requireNonNull(socketInfo, "socketInfo must be non-null");
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005564 Objects.requireNonNull(executor, "executor must be non-null");
Daniel Bright686d5d22021-03-10 11:51:50 -08005565 Objects.requireNonNull(callback, "callback must be non-null");
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005566
5567 try {
5568 synchronized (mQosCallbackConnections) {
5569 if (getQosCallbackConnection(callback) == null) {
5570 final QosCallbackConnection connection =
5571 new QosCallbackConnection(this, callback, executor);
5572 mQosCallbackConnections.add(connection);
5573 mService.registerQosSocketCallback(socketInfo, connection);
5574 } else {
5575 Log.e(TAG, "registerQosCallback: Callback already registered");
5576 throw new QosCallbackRegistrationException();
5577 }
5578 }
5579 } catch (final RemoteException e) {
5580 Log.e(TAG, "registerQosCallback: Error while registering ", e);
5581
5582 // The same unregister method method is called for consistency even though nothing
5583 // will be sent to the ConnectivityService since the callback was never successfully
5584 // registered.
5585 unregisterQosCallback(callback);
5586 e.rethrowFromSystemServer();
5587 } catch (final ServiceSpecificException e) {
5588 Log.e(TAG, "registerQosCallback: Error while registering ", e);
5589 unregisterQosCallback(callback);
5590 throw convertServiceException(e);
5591 }
5592 }
5593
5594 /**
5595 * Unregisters the given {@link QosCallback}. The {@link QosCallback} will no longer receive
5596 * events once unregistered and can be registered a second time.
5597 * <p/>
5598 * If the {@link QosCallback} does not have an active registration, it is a no-op.
5599 *
5600 * @param callback the callback being unregistered
5601 *
5602 * @hide
5603 */
5604 @SystemApi
5605 public void unregisterQosCallback(@NonNull final QosCallback callback) {
5606 Objects.requireNonNull(callback, "The callback must be non-null");
5607 try {
5608 synchronized (mQosCallbackConnections) {
5609 final QosCallbackConnection connection = getQosCallbackConnection(callback);
5610 if (connection != null) {
5611 connection.stopReceivingMessages();
5612 mService.unregisterQosCallback(connection);
5613 mQosCallbackConnections.remove(connection);
5614 } else {
5615 Log.d(TAG, "unregisterQosCallback: Callback not registered");
5616 }
5617 }
5618 } catch (final RemoteException e) {
5619 Log.e(TAG, "unregisterQosCallback: Error while unregistering ", e);
5620 e.rethrowFromSystemServer();
5621 }
5622 }
5623
5624 /**
5625 * Gets the connection related to the callback.
5626 *
5627 * @param callback the callback to look up
5628 * @return the related connection
5629 */
5630 @Nullable
5631 private QosCallbackConnection getQosCallbackConnection(final QosCallback callback) {
5632 for (final QosCallbackConnection connection : mQosCallbackConnections) {
5633 // Checking by reference here is intentional
5634 if (connection.getCallback() == callback) {
5635 return connection;
5636 }
5637 }
5638 return null;
5639 }
5640
5641 /**
Roshan Piuse08bc182020-12-22 15:10:42 -08005642 * Request a network to satisfy a set of {@link NetworkCapabilities}, but
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005643 * does not cause any networks to retain the NET_CAPABILITY_FOREGROUND capability. This can
5644 * be used to request that the system provide a network without causing the network to be
5645 * in the foreground.
5646 *
5647 * <p>This method will attempt to find the best network that matches the passed
5648 * {@link NetworkRequest}, and to bring up one that does if none currently satisfies the
5649 * criteria. The platform will evaluate which network is the best at its own discretion.
5650 * Throughput, latency, cost per byte, policy, user preference and other considerations
5651 * may be factored in the decision of what is considered the best network.
5652 *
5653 * <p>As long as this request is outstanding, the platform will try to maintain the best network
5654 * matching this request, while always attempting to match the request to a better network if
5655 * possible. If a better match is found, the platform will switch this request to the now-best
5656 * network and inform the app of the newly best network by invoking
5657 * {@link NetworkCallback#onAvailable(Network)} on the provided callback. Note that the platform
5658 * will not try to maintain any other network than the best one currently matching the request:
5659 * a network not matching any network request may be disconnected at any time.
5660 *
5661 * <p>For example, an application could use this method to obtain a connected cellular network
5662 * even if the device currently has a data connection over Ethernet. This may cause the cellular
5663 * radio to consume additional power. Or, an application could inform the system that it wants
5664 * a network supporting sending MMSes and have the system let it know about the currently best
5665 * MMS-supporting network through the provided {@link NetworkCallback}.
5666 *
5667 * <p>The status of the request can be followed by listening to the various callbacks described
5668 * in {@link NetworkCallback}. The {@link Network} object passed to the callback methods can be
5669 * used to direct traffic to the network (although accessing some networks may be subject to
5670 * holding specific permissions). Callers will learn about the specific characteristics of the
5671 * network through
5672 * {@link NetworkCallback#onCapabilitiesChanged(Network, NetworkCapabilities)} and
5673 * {@link NetworkCallback#onLinkPropertiesChanged(Network, LinkProperties)}. The methods of the
5674 * provided {@link NetworkCallback} will only be invoked due to changes in the best network
5675 * matching the request at any given time; therefore when a better network matching the request
5676 * becomes available, the {@link NetworkCallback#onAvailable(Network)} method is called
5677 * with the new network after which no further updates are given about the previously-best
5678 * network, unless it becomes the best again at some later time. All callbacks are invoked
5679 * in order on the same thread, which by default is a thread created by the framework running
5680 * in the app.
5681 *
5682 * <p>This{@link NetworkRequest} will live until released via
5683 * {@link #unregisterNetworkCallback(NetworkCallback)} or the calling application exits, at
5684 * which point the system may let go of the network at any time.
5685 *
5686 * <p>It is presently unsupported to request a network with mutable
5687 * {@link NetworkCapabilities} such as
5688 * {@link NetworkCapabilities#NET_CAPABILITY_VALIDATED} or
5689 * {@link NetworkCapabilities#NET_CAPABILITY_CAPTIVE_PORTAL}
5690 * as these {@code NetworkCapabilities} represent states that a particular
5691 * network may never attain, and whether a network will attain these states
5692 * is unknown prior to bringing up the network so the framework does not
5693 * know how to go about satisfying a request with these capabilities.
5694 *
5695 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
5696 * number of outstanding requests to 100 per app (identified by their UID), shared with
5697 * all variants of this method, of {@link #registerNetworkCallback} as well as
5698 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
5699 * Requesting a network with this method will count toward this limit. If this limit is
5700 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
5701 * make sure to unregister the callbacks with
5702 * {@link #unregisterNetworkCallback(NetworkCallback)}.
5703 *
5704 * @param request {@link NetworkRequest} describing this request.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005705 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
5706 * the callback must not be shared - it uniquely specifies this request.
junyulaica657cb2021-04-15 00:39:49 +08005707 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
5708 * If null, the callback is invoked on the default internal Handler.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005709 * @throws IllegalArgumentException if {@code request} contains invalid network capabilities.
5710 * @throws SecurityException if missing the appropriate permissions.
5711 * @throws RuntimeException if the app already has too many callbacks registered.
5712 *
5713 * @hide
5714 */
5715 @SystemApi(client = MODULE_LIBRARIES)
5716 @SuppressLint("ExecutorRegistration")
5717 @RequiresPermission(anyOf = {
5718 android.Manifest.permission.NETWORK_SETTINGS,
5719 android.Manifest.permission.NETWORK_STACK,
5720 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK
5721 })
5722 public void requestBackgroundNetwork(@NonNull NetworkRequest request,
junyulaica657cb2021-04-15 00:39:49 +08005723 @NonNull NetworkCallback networkCallback,
5724 @SuppressLint("ListenerLast") @NonNull Handler handler) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005725 final NetworkCapabilities nc = request.networkCapabilities;
5726 sendRequestForNetwork(nc, networkCallback, 0, BACKGROUND_REQUEST,
junyulaidbb70462021-03-09 20:49:48 +08005727 TYPE_NONE, new CallbackHandler(handler));
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005728 }
James Mattis12aeab82021-01-10 14:24:24 -08005729
5730 /**
James Mattis12aeab82021-01-10 14:24:24 -08005731 * Used by automotive devices to set the network preferences used to direct traffic at an
5732 * application level as per the given OemNetworkPreferences. An example use-case would be an
5733 * automotive OEM wanting to provide connectivity for applications critical to the usage of a
5734 * vehicle via a particular network.
5735 *
5736 * Calling this will overwrite the existing preference.
5737 *
5738 * @param preference {@link OemNetworkPreferences} The application network preference to be set.
5739 * @param executor the executor on which listener will be invoked.
5740 * @param listener {@link OnSetOemNetworkPreferenceListener} optional listener used to
5741 * communicate completion of setOemNetworkPreference(). This will only be
5742 * called once upon successful completion of setOemNetworkPreference().
5743 * @throws IllegalArgumentException if {@code preference} contains invalid preference values.
5744 * @throws SecurityException if missing the appropriate permissions.
5745 * @throws UnsupportedOperationException if called on a non-automotive device.
James Mattis6e2d7022021-01-26 16:23:52 -08005746 * @hide
James Mattis12aeab82021-01-10 14:24:24 -08005747 */
James Mattis6e2d7022021-01-26 16:23:52 -08005748 @SystemApi
James Mattisa46c1442021-01-26 14:05:36 -08005749 @RequiresPermission(android.Manifest.permission.CONTROL_OEM_PAID_NETWORK_PREFERENCE)
James Mattis6e2d7022021-01-26 16:23:52 -08005750 public void setOemNetworkPreference(@NonNull final OemNetworkPreferences preference,
James Mattis12aeab82021-01-10 14:24:24 -08005751 @Nullable @CallbackExecutor final Executor executor,
Chalard Jean0a4aefc2021-03-03 16:37:13 +09005752 @Nullable final Runnable listener) {
James Mattis12aeab82021-01-10 14:24:24 -08005753 Objects.requireNonNull(preference, "OemNetworkPreferences must be non-null");
5754 if (null != listener) {
5755 Objects.requireNonNull(executor, "Executor must be non-null");
5756 }
Chalard Jean0a4aefc2021-03-03 16:37:13 +09005757 final IOnCompleteListener listenerInternal = listener == null ? null :
5758 new IOnCompleteListener.Stub() {
James Mattis12aeab82021-01-10 14:24:24 -08005759 @Override
5760 public void onComplete() {
Chalard Jean0a4aefc2021-03-03 16:37:13 +09005761 executor.execute(listener::run);
James Mattis12aeab82021-01-10 14:24:24 -08005762 }
5763 };
5764
5765 try {
5766 mService.setOemNetworkPreference(preference, listenerInternal);
5767 } catch (RemoteException e) {
5768 Log.e(TAG, "setOemNetworkPreference() failed for preference: " + preference.toString());
5769 throw e.rethrowFromSystemServer();
5770 }
5771 }
lucaslin5cdbcfb2021-03-12 00:46:33 +08005772
Chalard Jeanad565e22021-02-25 17:23:40 +09005773 /**
5774 * Request that a user profile is put by default on a network matching a given preference.
5775 *
5776 * See the documentation for the individual preferences for a description of the supported
5777 * behaviors.
5778 *
5779 * @param profile the profile concerned.
5780 * @param preference the preference for this profile.
5781 * @param executor an executor to execute the listener on. Optional if listener is null.
5782 * @param listener an optional listener to listen for completion of the operation.
5783 * @throws IllegalArgumentException if {@code profile} is not a valid user profile.
5784 * @throws SecurityException if missing the appropriate permissions.
Sooraj Sasindrane7aee272021-11-24 20:26:55 -08005785 * @deprecated Use {@link #setProfileNetworkPreferences(UserHandle, List, Executor, Runnable)}
5786 * instead as it provides a more flexible API with more options.
Chalard Jeanad565e22021-02-25 17:23:40 +09005787 * @hide
5788 */
Chalard Jean0a4aefc2021-03-03 16:37:13 +09005789 // This function is for establishing per-profile default networking and can only be called by
5790 // the device policy manager, running as the system server. It would make no sense to call it
5791 // on a context for a user because it does not establish a setting on behalf of a user, rather
5792 // it establishes a setting for a user on behalf of the DPM.
5793 @SuppressLint({"UserHandle"})
5794 @SystemApi(client = MODULE_LIBRARIES)
Chalard Jeanad565e22021-02-25 17:23:40 +09005795 @RequiresPermission(android.Manifest.permission.NETWORK_STACK)
Sooraj Sasindrane7aee272021-11-24 20:26:55 -08005796 @Deprecated
Chalard Jeanad565e22021-02-25 17:23:40 +09005797 public void setProfileNetworkPreference(@NonNull final UserHandle profile,
Sooraj Sasindrane7aee272021-11-24 20:26:55 -08005798 @ProfileNetworkPreferencePolicy final int preference,
5799 @Nullable @CallbackExecutor final Executor executor,
5800 @Nullable final Runnable listener) {
5801
5802 ProfileNetworkPreference.Builder preferenceBuilder =
5803 new ProfileNetworkPreference.Builder();
5804 preferenceBuilder.setPreference(preference);
Sooraj Sasindranf4a58dc2022-01-21 13:37:08 -08005805 if (preference != PROFILE_NETWORK_PREFERENCE_DEFAULT) {
5806 preferenceBuilder.setPreferenceEnterpriseId(NET_ENTERPRISE_ID_1);
5807 }
Sooraj Sasindrane7aee272021-11-24 20:26:55 -08005808 setProfileNetworkPreferences(profile,
5809 List.of(preferenceBuilder.build()), executor, listener);
5810 }
5811
5812 /**
5813 * Set a list of default network selection policies for a user profile.
5814 *
5815 * Calling this API with a user handle defines the entire policy for that user handle.
5816 * It will overwrite any setting previously set for the same user profile,
5817 * and not affect previously set settings for other handles.
5818 *
5819 * Call this API with an empty list to remove settings for this user profile.
5820 *
5821 * See {@link ProfileNetworkPreference} for more details on each preference
5822 * parameter.
5823 *
5824 * @param profile the user profile for which the preference is being set.
5825 * @param profileNetworkPreferences the list of profile network preferences for the
5826 * provided profile.
5827 * @param executor an executor to execute the listener on. Optional if listener is null.
5828 * @param listener an optional listener to listen for completion of the operation.
5829 * @throws IllegalArgumentException if {@code profile} is not a valid user profile.
5830 * @throws SecurityException if missing the appropriate permissions.
5831 * @hide
5832 */
5833 @SystemApi(client = MODULE_LIBRARIES)
5834 @RequiresPermission(android.Manifest.permission.NETWORK_STACK)
5835 public void setProfileNetworkPreferences(
5836 @NonNull final UserHandle profile,
5837 @NonNull List<ProfileNetworkPreference> profileNetworkPreferences,
Chalard Jeanad565e22021-02-25 17:23:40 +09005838 @Nullable @CallbackExecutor final Executor executor,
5839 @Nullable final Runnable listener) {
5840 if (null != listener) {
5841 Objects.requireNonNull(executor, "Pass a non-null executor, or a null listener");
5842 }
5843 final IOnCompleteListener proxy;
5844 if (null == listener) {
5845 proxy = null;
5846 } else {
5847 proxy = new IOnCompleteListener.Stub() {
5848 @Override
5849 public void onComplete() {
5850 executor.execute(listener::run);
5851 }
5852 };
5853 }
5854 try {
Sooraj Sasindrane7aee272021-11-24 20:26:55 -08005855 mService.setProfileNetworkPreferences(profile, profileNetworkPreferences, proxy);
Chalard Jeanad565e22021-02-25 17:23:40 +09005856 } catch (RemoteException e) {
5857 throw e.rethrowFromSystemServer();
5858 }
5859 }
5860
lucaslin5cdbcfb2021-03-12 00:46:33 +08005861 // The first network ID of IPSec tunnel interface.
lucaslinc296fcc2021-03-15 17:24:12 +08005862 private static final int TUN_INTF_NETID_START = 0xFC00; // 0xFC00 = 64512
lucaslin5cdbcfb2021-03-12 00:46:33 +08005863 // The network ID range of IPSec tunnel interface.
lucaslinc296fcc2021-03-15 17:24:12 +08005864 private static final int TUN_INTF_NETID_RANGE = 0x0400; // 0x0400 = 1024
lucaslin5cdbcfb2021-03-12 00:46:33 +08005865
5866 /**
5867 * Get the network ID range reserved for IPSec tunnel interfaces.
5868 *
5869 * @return A Range which indicates the network ID range of IPSec tunnel interface.
5870 * @hide
5871 */
5872 @SystemApi(client = MODULE_LIBRARIES)
5873 @NonNull
5874 public static Range<Integer> getIpSecNetIdRange() {
5875 return new Range(TUN_INTF_NETID_START, TUN_INTF_NETID_START + TUN_INTF_NETID_RANGE - 1);
5876 }
markchien738ad912021-12-09 18:15:45 +08005877
5878 /**
markchiene46042b2022-03-02 18:07:35 +08005879 * Adds the specified UID to the list of UIds that are allowed to use data on metered networks
5880 * even when background data is restricted. The deny list takes precedence over the allow list.
markchien738ad912021-12-09 18:15:45 +08005881 *
5882 * @param uid uid of target app
markchien68cfadc2022-01-14 13:39:54 +08005883 * @throws IllegalStateException if updating allow list failed.
markchien738ad912021-12-09 18:15:45 +08005884 * @hide
5885 */
5886 @SystemApi(client = MODULE_LIBRARIES)
5887 @RequiresPermission(anyOf = {
5888 android.Manifest.permission.NETWORK_SETTINGS,
5889 android.Manifest.permission.NETWORK_STACK,
5890 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK
5891 })
markchiene46042b2022-03-02 18:07:35 +08005892 public void addUidToMeteredNetworkAllowList(final int uid) {
markchien738ad912021-12-09 18:15:45 +08005893 try {
markchiene46042b2022-03-02 18:07:35 +08005894 mService.updateMeteredNetworkAllowList(uid, true /* add */);
markchien738ad912021-12-09 18:15:45 +08005895 } catch (RemoteException e) {
5896 throw e.rethrowFromSystemServer();
markchien738ad912021-12-09 18:15:45 +08005897 }
5898 }
5899
5900 /**
markchiene46042b2022-03-02 18:07:35 +08005901 * Removes the specified UID from the list of UIDs that are allowed to use background data on
5902 * metered networks when background data is restricted. The deny list takes precedence over
5903 * the allow list.
5904 *
5905 * @param uid uid of target app
5906 * @throws IllegalStateException if updating allow list failed.
5907 * @hide
5908 */
5909 @SystemApi(client = MODULE_LIBRARIES)
5910 @RequiresPermission(anyOf = {
5911 android.Manifest.permission.NETWORK_SETTINGS,
5912 android.Manifest.permission.NETWORK_STACK,
5913 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK
5914 })
5915 public void removeUidFromMeteredNetworkAllowList(final int uid) {
5916 try {
5917 mService.updateMeteredNetworkAllowList(uid, false /* remove */);
5918 } catch (RemoteException e) {
5919 throw e.rethrowFromSystemServer();
5920 }
5921 }
5922
5923 /**
5924 * Adds the specified UID to the list of UIDs that are not allowed to use background data on
5925 * metered networks. Takes precedence over {@link #addUidToMeteredNetworkAllowList}.
markchien738ad912021-12-09 18:15:45 +08005926 *
5927 * @param uid uid of target app
markchien68cfadc2022-01-14 13:39:54 +08005928 * @throws IllegalStateException if updating deny list failed.
markchien738ad912021-12-09 18:15:45 +08005929 * @hide
5930 */
5931 @SystemApi(client = MODULE_LIBRARIES)
5932 @RequiresPermission(anyOf = {
5933 android.Manifest.permission.NETWORK_SETTINGS,
5934 android.Manifest.permission.NETWORK_STACK,
5935 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK
5936 })
markchiene46042b2022-03-02 18:07:35 +08005937 public void addUidToMeteredNetworkDenyList(final int uid) {
markchien738ad912021-12-09 18:15:45 +08005938 try {
markchiene46042b2022-03-02 18:07:35 +08005939 mService.updateMeteredNetworkDenyList(uid, true /* add */);
5940 } catch (RemoteException e) {
5941 throw e.rethrowFromSystemServer();
5942 }
5943 }
5944
5945 /**
Chalard Jean0c7ebe92022-08-03 14:45:47 +09005946 * Removes the specified UID from the list of UIDs that can use background data on metered
markchiene46042b2022-03-02 18:07:35 +08005947 * networks if background data is not restricted. The deny list takes precedence over the
5948 * allow list.
5949 *
5950 * @param uid uid of target app
5951 * @throws IllegalStateException if updating deny list failed.
5952 * @hide
5953 */
5954 @SystemApi(client = MODULE_LIBRARIES)
5955 @RequiresPermission(anyOf = {
5956 android.Manifest.permission.NETWORK_SETTINGS,
5957 android.Manifest.permission.NETWORK_STACK,
5958 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK
5959 })
5960 public void removeUidFromMeteredNetworkDenyList(final int uid) {
5961 try {
5962 mService.updateMeteredNetworkDenyList(uid, false /* remove */);
markchien738ad912021-12-09 18:15:45 +08005963 } catch (RemoteException e) {
5964 throw e.rethrowFromSystemServer();
markchiene1561fa2021-12-09 22:00:56 +08005965 }
5966 }
5967
5968 /**
5969 * Sets a firewall rule for the specified UID on the specified chain.
5970 *
5971 * @param chain target chain.
5972 * @param uid uid to allow/deny.
markchien3c04e662022-03-22 16:29:56 +08005973 * @param rule firewall rule to allow/drop packets.
markchien68cfadc2022-01-14 13:39:54 +08005974 * @throws IllegalStateException if updating firewall rule failed.
markchien3c04e662022-03-22 16:29:56 +08005975 * @throws IllegalArgumentException if {@code rule} is not a valid rule.
markchiene1561fa2021-12-09 22:00:56 +08005976 * @hide
5977 */
5978 @SystemApi(client = MODULE_LIBRARIES)
5979 @RequiresPermission(anyOf = {
5980 android.Manifest.permission.NETWORK_SETTINGS,
5981 android.Manifest.permission.NETWORK_STACK,
5982 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK
5983 })
markchien3c04e662022-03-22 16:29:56 +08005984 public void setUidFirewallRule(@FirewallChain final int chain, final int uid,
5985 @FirewallRule final int rule) {
markchiene1561fa2021-12-09 22:00:56 +08005986 try {
markchien3c04e662022-03-22 16:29:56 +08005987 mService.setUidFirewallRule(chain, uid, rule);
markchiene1561fa2021-12-09 22:00:56 +08005988 } catch (RemoteException e) {
5989 throw e.rethrowFromSystemServer();
markchien738ad912021-12-09 18:15:45 +08005990 }
5991 }
markchien98a6f952022-01-13 23:43:53 +08005992
5993 /**
5994 * Enables or disables the specified firewall chain.
5995 *
5996 * @param chain target chain.
5997 * @param enable whether the chain should be enabled.
Motomu Utsumi18b287d2022-06-19 10:45:30 +00005998 * @throws UnsupportedOperationException if called on pre-T devices.
markchien68cfadc2022-01-14 13:39:54 +08005999 * @throws IllegalStateException if enabling or disabling the firewall chain failed.
markchien98a6f952022-01-13 23:43:53 +08006000 * @hide
6001 */
6002 @SystemApi(client = MODULE_LIBRARIES)
6003 @RequiresPermission(anyOf = {
6004 android.Manifest.permission.NETWORK_SETTINGS,
6005 android.Manifest.permission.NETWORK_STACK,
6006 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK
6007 })
6008 public void setFirewallChainEnabled(@FirewallChain final int chain, final boolean enable) {
6009 try {
6010 mService.setFirewallChainEnabled(chain, enable);
6011 } catch (RemoteException e) {
6012 throw e.rethrowFromSystemServer();
6013 }
6014 }
markchien00a0bed2022-01-13 23:46:13 +08006015
6016 /**
Motomu Utsumi25cf86f2022-06-27 08:50:19 +00006017 * Get the specified firewall chain's status.
Motomu Utsumibe3ff1e2022-06-08 10:05:07 +00006018 *
6019 * @param chain target chain.
6020 * @return {@code true} if chain is enabled, {@code false} if chain is disabled.
6021 * @throws UnsupportedOperationException if called on pre-T devices.
Motomu Utsumibe3ff1e2022-06-08 10:05:07 +00006022 * @throws ServiceSpecificException in case of failure, with an error code indicating the
6023 * cause of the failure.
6024 * @hide
6025 */
6026 @RequiresPermission(anyOf = {
6027 android.Manifest.permission.NETWORK_SETTINGS,
6028 android.Manifest.permission.NETWORK_STACK,
6029 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK
6030 })
6031 public boolean getFirewallChainEnabled(@FirewallChain final int chain) {
6032 try {
6033 return mService.getFirewallChainEnabled(chain);
6034 } catch (RemoteException e) {
6035 throw e.rethrowFromSystemServer();
6036 }
6037 }
6038
6039 /**
markchien00a0bed2022-01-13 23:46:13 +08006040 * Replaces the contents of the specified UID-based firewall chain.
6041 *
6042 * @param chain target chain to replace.
6043 * @param uids The list of UIDs to be placed into chain.
Motomu Utsumi9be2ea02022-07-05 06:14:59 +00006044 * @throws UnsupportedOperationException if called on pre-T devices.
markchien00a0bed2022-01-13 23:46:13 +08006045 * @throws IllegalArgumentException if {@code chain} is not a valid chain.
6046 * @hide
6047 */
6048 @SystemApi(client = MODULE_LIBRARIES)
6049 @RequiresPermission(anyOf = {
6050 android.Manifest.permission.NETWORK_SETTINGS,
6051 android.Manifest.permission.NETWORK_STACK,
6052 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK
6053 })
6054 public void replaceFirewallChain(@FirewallChain final int chain, @NonNull final int[] uids) {
6055 Objects.requireNonNull(uids);
6056 try {
6057 mService.replaceFirewallChain(chain, uids);
6058 } catch (RemoteException e) {
6059 throw e.rethrowFromSystemServer();
6060 }
6061 }
Igor Chernyshev9dac6602022-12-13 19:28:32 -08006062
6063 /** @hide */
6064 public IBinder getCompanionDeviceManagerProxyService() {
6065 try {
6066 return mService.getCompanionDeviceManagerProxyService();
6067 } catch (RemoteException e) {
6068 throw e.rethrowFromSystemServer();
6069 }
6070 }
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09006071}