blob: 1fbbd25bf56db0e5c473fa5885e4e2a92ac6cabf [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";
1170 default:
1171 return Integer.toString(type);
1172 }
1173 }
1174
1175 /**
1176 * @hide
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001177 */
lucaslin10774b72021-03-17 14:16:01 +08001178 @SystemApi(client = MODULE_LIBRARIES)
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001179 public void systemReady() {
1180 try {
1181 mService.systemReady();
1182 } catch (RemoteException e) {
1183 throw e.rethrowFromSystemServer();
1184 }
1185 }
1186
1187 /**
1188 * Checks if a given type uses the cellular data connection.
1189 * This should be replaced in the future by a network property.
1190 * @param networkType the type to check
1191 * @return a boolean - {@code true} if uses cellular network, else {@code false}
1192 * @deprecated Types are deprecated. Use {@link NetworkCapabilities} instead.
1193 * {@hide}
1194 */
1195 @Deprecated
1196 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 130143562)
1197 public static boolean isNetworkTypeMobile(int networkType) {
1198 switch (networkType) {
1199 case TYPE_MOBILE:
1200 case TYPE_MOBILE_MMS:
1201 case TYPE_MOBILE_SUPL:
1202 case TYPE_MOBILE_DUN:
1203 case TYPE_MOBILE_HIPRI:
1204 case TYPE_MOBILE_FOTA:
1205 case TYPE_MOBILE_IMS:
1206 case TYPE_MOBILE_CBS:
1207 case TYPE_MOBILE_IA:
1208 case TYPE_MOBILE_EMERGENCY:
1209 return true;
1210 default:
1211 return false;
1212 }
1213 }
1214
1215 /**
1216 * Checks if the given network type is backed by a Wi-Fi radio.
1217 *
1218 * @deprecated Types are deprecated. Use {@link NetworkCapabilities} instead.
1219 * @hide
1220 */
1221 @Deprecated
1222 public static boolean isNetworkTypeWifi(int networkType) {
1223 switch (networkType) {
1224 case TYPE_WIFI:
1225 case TYPE_WIFI_P2P:
1226 return true;
1227 default:
1228 return false;
1229 }
1230 }
1231
1232 /**
Sooraj Sasindran06baf4c2021-11-29 12:21:09 -08001233 * Preference for {@link ProfileNetworkPreference#setPreference(int)}.
chiachangwang9473c592022-07-15 02:25:52 +00001234 * See {@link #setProfileNetworkPreferences(UserHandle, List, Executor, Runnable)}
Chalard Jeanad565e22021-02-25 17:23:40 +09001235 * Specify that the traffic for this user should by follow the default rules.
1236 * @hide
1237 */
Chalard Jeanbef6b092021-03-17 14:33:24 +09001238 @SystemApi(client = MODULE_LIBRARIES)
Chalard Jeanad565e22021-02-25 17:23:40 +09001239 public static final int PROFILE_NETWORK_PREFERENCE_DEFAULT = 0;
1240
1241 /**
Sooraj Sasindran06baf4c2021-11-29 12:21:09 -08001242 * Preference for {@link ProfileNetworkPreference#setPreference(int)}.
chiachangwang9473c592022-07-15 02:25:52 +00001243 * See {@link #setProfileNetworkPreferences(UserHandle, List, Executor, Runnable)}
Chalard Jeanad565e22021-02-25 17:23:40 +09001244 * Specify that the traffic for this user should by default go on a network with
1245 * {@link NetworkCapabilities#NET_CAPABILITY_ENTERPRISE}, and on the system default network
1246 * if no such network is available.
1247 * @hide
1248 */
Chalard Jeanbef6b092021-03-17 14:33:24 +09001249 @SystemApi(client = MODULE_LIBRARIES)
Chalard Jeanad565e22021-02-25 17:23:40 +09001250 public static final int PROFILE_NETWORK_PREFERENCE_ENTERPRISE = 1;
1251
Sooraj Sasindran06baf4c2021-11-29 12:21:09 -08001252 /**
1253 * Preference for {@link ProfileNetworkPreference#setPreference(int)}.
chiachangwang9473c592022-07-15 02:25:52 +00001254 * See {@link #setProfileNetworkPreferences(UserHandle, List, Executor, Runnable)}
Sooraj Sasindran06baf4c2021-11-29 12:21:09 -08001255 * Specify that the traffic for this user should by default go on a network with
1256 * {@link NetworkCapabilities#NET_CAPABILITY_ENTERPRISE} and if no such network is available
1257 * should not go on the system default network
1258 * @hide
1259 */
1260 @SystemApi(client = MODULE_LIBRARIES)
1261 public static final int PROFILE_NETWORK_PREFERENCE_ENTERPRISE_NO_FALLBACK = 2;
1262
Chalard Jeanad565e22021-02-25 17:23:40 +09001263 /** @hide */
1264 @Retention(RetentionPolicy.SOURCE)
1265 @IntDef(value = {
1266 PROFILE_NETWORK_PREFERENCE_DEFAULT,
Sooraj Sasindran06baf4c2021-11-29 12:21:09 -08001267 PROFILE_NETWORK_PREFERENCE_ENTERPRISE,
1268 PROFILE_NETWORK_PREFERENCE_ENTERPRISE_NO_FALLBACK
Chalard Jeanad565e22021-02-25 17:23:40 +09001269 })
Sooraj Sasindrane7aee272021-11-24 20:26:55 -08001270 public @interface ProfileNetworkPreferencePolicy {
Chalard Jeanad565e22021-02-25 17:23:40 +09001271 }
1272
1273 /**
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001274 * Specifies the preferred network type. When the device has more
1275 * than one type available the preferred network type will be used.
1276 *
1277 * @param preference the network type to prefer over all others. It is
1278 * unspecified what happens to the old preferred network in the
1279 * overall ordering.
1280 * @deprecated Functionality has been removed as it no longer makes sense,
1281 * with many more than two networks - we'd need an array to express
1282 * preference. Instead we use dynamic network properties of
1283 * the networks to describe their precedence.
1284 */
1285 @Deprecated
1286 public void setNetworkPreference(int preference) {
1287 }
1288
1289 /**
1290 * Retrieves the current preferred network type.
1291 *
1292 * @return an integer representing the preferred network type
1293 *
1294 * @deprecated Functionality has been removed as it no longer makes sense,
1295 * with many more than two networks - we'd need an array to express
1296 * preference. Instead we use dynamic network properties of
1297 * the networks to describe their precedence.
1298 */
1299 @Deprecated
1300 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1301 public int getNetworkPreference() {
1302 return TYPE_NONE;
1303 }
1304
1305 /**
1306 * Returns details about the currently active default data network. When
1307 * connected, this network is the default route for outgoing connections.
1308 * You should always check {@link NetworkInfo#isConnected()} before initiating
1309 * network traffic. This may return {@code null} when there is no default
1310 * network.
1311 * Note that if the default network is a VPN, this method will return the
1312 * NetworkInfo for one of its underlying networks instead, or null if the
1313 * VPN agent did not specify any. Apps interested in learning about VPNs
1314 * should use {@link #getNetworkInfo(android.net.Network)} instead.
1315 *
1316 * @return a {@link NetworkInfo} object for the current default network
1317 * or {@code null} if no default network is currently active
1318 * @deprecated See {@link NetworkInfo}.
1319 */
1320 @Deprecated
1321 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1322 @Nullable
1323 public NetworkInfo getActiveNetworkInfo() {
1324 try {
1325 return mService.getActiveNetworkInfo();
1326 } catch (RemoteException e) {
1327 throw e.rethrowFromSystemServer();
1328 }
1329 }
1330
1331 /**
1332 * Returns a {@link Network} object corresponding to the currently active
1333 * default data network. In the event that the current active default data
1334 * network disconnects, the returned {@code Network} object will no longer
1335 * be usable. This will return {@code null} when there is no default
Chalard Jean0d051512021-09-28 15:31:15 +09001336 * network, or when the default network is blocked.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001337 *
1338 * @return a {@link Network} object for the current default network or
Chalard Jean0d051512021-09-28 15:31:15 +09001339 * {@code null} if no default network is currently active or if
1340 * the default network is blocked for the caller
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001341 */
1342 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1343 @Nullable
1344 public Network getActiveNetwork() {
1345 try {
1346 return mService.getActiveNetwork();
1347 } catch (RemoteException e) {
1348 throw e.rethrowFromSystemServer();
1349 }
1350 }
1351
1352 /**
1353 * Returns a {@link Network} object corresponding to the currently active
1354 * default data network for a specific UID. In the event that the default data
1355 * network disconnects, the returned {@code Network} object will no longer
1356 * be usable. This will return {@code null} when there is no default
1357 * network for the UID.
1358 *
1359 * @return a {@link Network} object for the current default network for the
1360 * given UID or {@code null} if no default network is currently active
lifrdb7d6762021-03-30 21:04:53 +08001361 *
1362 * @hide
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001363 */
1364 @RequiresPermission(android.Manifest.permission.NETWORK_STACK)
1365 @Nullable
1366 public Network getActiveNetworkForUid(int uid) {
1367 return getActiveNetworkForUid(uid, false);
1368 }
1369
1370 /** {@hide} */
1371 public Network getActiveNetworkForUid(int uid, boolean ignoreBlocked) {
1372 try {
1373 return mService.getActiveNetworkForUid(uid, ignoreBlocked);
1374 } catch (RemoteException e) {
1375 throw e.rethrowFromSystemServer();
1376 }
1377 }
1378
1379 /**
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001380 * Adds or removes a requirement for given UID ranges to use the VPN.
1381 *
1382 * If set to {@code true}, informs the system that the UIDs in the specified ranges must not
1383 * have any connectivity except if a VPN is connected and applies to the UIDs, or if the UIDs
1384 * otherwise have permission to bypass the VPN (e.g., because they have the
1385 * {@link android.Manifest.permission.CONNECTIVITY_USE_RESTRICTED_NETWORKS} permission, or when
1386 * using a socket protected by a method such as {@link VpnService#protect(DatagramSocket)}. If
1387 * set to {@code false}, a previously-added restriction is removed.
1388 * <p>
1389 * Each of the UID ranges specified by this method is added and removed as is, and no processing
1390 * is performed on the ranges to de-duplicate, merge, split, or intersect them. In order to
1391 * remove a previously-added range, the exact range must be removed as is.
1392 * <p>
1393 * The changes are applied asynchronously and may not have been applied by the time the method
1394 * returns. Apps will be notified about any changes that apply to them via
1395 * {@link NetworkCallback#onBlockedStatusChanged} callbacks called after the changes take
1396 * effect.
1397 * <p>
1398 * This method should be called only by the VPN code.
1399 *
1400 * @param ranges the UID ranges to restrict
1401 * @param requireVpn whether the specified UID ranges must use a VPN
1402 *
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001403 * @hide
1404 */
1405 @RequiresPermission(anyOf = {
1406 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
lucaslin97fb10a2021-03-22 11:51:27 +08001407 android.Manifest.permission.NETWORK_STACK,
1408 android.Manifest.permission.NETWORK_SETTINGS})
1409 @SystemApi(client = MODULE_LIBRARIES)
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001410 public void setRequireVpnForUids(boolean requireVpn,
1411 @NonNull Collection<Range<Integer>> ranges) {
1412 Objects.requireNonNull(ranges);
1413 // The Range class is not parcelable. Convert to UidRange, which is what is used internally.
1414 // This method is not necessarily expected to be used outside the system server, so
1415 // parceling may not be necessary, but it could be used out-of-process, e.g., by the network
1416 // stack process, or by tests.
1417 UidRange[] rangesArray = new UidRange[ranges.size()];
1418 int index = 0;
1419 for (Range<Integer> range : ranges) {
1420 rangesArray[index++] = new UidRange(range.getLower(), range.getUpper());
1421 }
1422 try {
1423 mService.setRequireVpnForUids(requireVpn, rangesArray);
1424 } catch (RemoteException e) {
1425 throw e.rethrowFromSystemServer();
1426 }
1427 }
1428
1429 /**
Lorenzo Colittic71cff82021-01-15 01:29:01 +09001430 * Informs ConnectivityService of whether the legacy lockdown VPN, as implemented by
1431 * LockdownVpnTracker, is in use. This is deprecated for new devices starting from Android 12
1432 * but is still supported for backwards compatibility.
1433 * <p>
1434 * This type of VPN is assumed always to use the system default network, and must always declare
1435 * exactly one underlying network, which is the network that was the default when the VPN
1436 * connected.
1437 * <p>
1438 * Calling this method with {@code true} enables legacy behaviour, specifically:
1439 * <ul>
1440 * <li>Any VPN that applies to userId 0 behaves specially with respect to deprecated
1441 * {@link #CONNECTIVITY_ACTION} broadcasts. Any such broadcasts will have the state in the
1442 * {@link #EXTRA_NETWORK_INFO} replaced by state of the VPN network. Also, any time the VPN
1443 * connects, a {@link #CONNECTIVITY_ACTION} broadcast will be sent for the network
1444 * underlying the VPN.</li>
1445 * <li>Deprecated APIs that return {@link NetworkInfo} objects will have their state
1446 * similarly replaced by the VPN network state.</li>
1447 * <li>Information on current network interfaces passed to NetworkStatsService will not
1448 * include any VPN interfaces.</li>
1449 * </ul>
1450 *
1451 * @param enabled whether legacy lockdown VPN is enabled or disabled
1452 *
Lorenzo Colittic71cff82021-01-15 01:29:01 +09001453 * @hide
1454 */
1455 @RequiresPermission(anyOf = {
1456 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
lucaslin97fb10a2021-03-22 11:51:27 +08001457 android.Manifest.permission.NETWORK_STACK,
Lorenzo Colittic71cff82021-01-15 01:29:01 +09001458 android.Manifest.permission.NETWORK_SETTINGS})
lucaslin97fb10a2021-03-22 11:51:27 +08001459 @SystemApi(client = MODULE_LIBRARIES)
Lorenzo Colittic71cff82021-01-15 01:29:01 +09001460 public void setLegacyLockdownVpnEnabled(boolean enabled) {
1461 try {
1462 mService.setLegacyLockdownVpnEnabled(enabled);
1463 } catch (RemoteException e) {
1464 throw e.rethrowFromSystemServer();
1465 }
1466 }
1467
1468 /**
Chalard Jean0c7ebe92022-08-03 14:45:47 +09001469 * Returns details about the currently active default data network for a given uid.
1470 * This is for privileged use only to avoid spying on other apps.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001471 *
1472 * @return a {@link NetworkInfo} object for the current default network
1473 * for the given uid or {@code null} if no default network is
1474 * available for the specified uid.
1475 *
1476 * {@hide}
1477 */
1478 @RequiresPermission(android.Manifest.permission.NETWORK_STACK)
1479 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
1480 public NetworkInfo getActiveNetworkInfoForUid(int uid) {
1481 return getActiveNetworkInfoForUid(uid, false);
1482 }
1483
1484 /** {@hide} */
1485 public NetworkInfo getActiveNetworkInfoForUid(int uid, boolean ignoreBlocked) {
1486 try {
1487 return mService.getActiveNetworkInfoForUid(uid, ignoreBlocked);
1488 } catch (RemoteException e) {
1489 throw e.rethrowFromSystemServer();
1490 }
1491 }
1492
1493 /**
Chalard Jean0c7ebe92022-08-03 14:45:47 +09001494 * Returns connection status information about a particular network type.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001495 *
1496 * @param networkType integer specifying which networkType in
1497 * which you're interested.
1498 * @return a {@link NetworkInfo} object for the requested
1499 * network type or {@code null} if the type is not
1500 * supported by the device. If {@code networkType} is
1501 * TYPE_VPN and a VPN is active for the calling app,
1502 * then this method will try to return one of the
1503 * underlying networks for the VPN or null if the
1504 * VPN agent didn't specify any.
1505 *
1506 * @deprecated This method does not support multiple connected networks
1507 * of the same type. Use {@link #getAllNetworks} and
1508 * {@link #getNetworkInfo(android.net.Network)} instead.
1509 */
1510 @Deprecated
1511 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1512 @Nullable
1513 public NetworkInfo getNetworkInfo(int networkType) {
1514 try {
1515 return mService.getNetworkInfo(networkType);
1516 } catch (RemoteException e) {
1517 throw e.rethrowFromSystemServer();
1518 }
1519 }
1520
1521 /**
Chalard Jean0c7ebe92022-08-03 14:45:47 +09001522 * Returns connection status information about a particular Network.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001523 *
1524 * @param network {@link Network} specifying which network
1525 * in which you're interested.
1526 * @return a {@link NetworkInfo} object for the requested
1527 * network or {@code null} if the {@code Network}
1528 * is not valid.
1529 * @deprecated See {@link NetworkInfo}.
1530 */
1531 @Deprecated
1532 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1533 @Nullable
1534 public NetworkInfo getNetworkInfo(@Nullable Network network) {
1535 return getNetworkInfoForUid(network, Process.myUid(), false);
1536 }
1537
1538 /** {@hide} */
1539 public NetworkInfo getNetworkInfoForUid(Network network, int uid, boolean ignoreBlocked) {
1540 try {
1541 return mService.getNetworkInfoForUid(network, uid, ignoreBlocked);
1542 } catch (RemoteException e) {
1543 throw e.rethrowFromSystemServer();
1544 }
1545 }
1546
1547 /**
Chalard Jean0c7ebe92022-08-03 14:45:47 +09001548 * Returns connection status information about all network types supported by the device.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001549 *
1550 * @return an array of {@link NetworkInfo} objects. Check each
1551 * {@link NetworkInfo#getType} for which type each applies.
1552 *
1553 * @deprecated This method does not support multiple connected networks
1554 * of the same type. Use {@link #getAllNetworks} and
1555 * {@link #getNetworkInfo(android.net.Network)} instead.
1556 */
1557 @Deprecated
1558 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1559 @NonNull
1560 public NetworkInfo[] getAllNetworkInfo() {
1561 try {
1562 return mService.getAllNetworkInfo();
1563 } catch (RemoteException e) {
1564 throw e.rethrowFromSystemServer();
1565 }
1566 }
1567
1568 /**
junyulaib1211372021-03-03 12:09:05 +08001569 * Return a list of {@link NetworkStateSnapshot}s, one for each network that is currently
1570 * connected.
1571 * @hide
1572 */
1573 @SystemApi(client = MODULE_LIBRARIES)
1574 @RequiresPermission(anyOf = {
1575 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
1576 android.Manifest.permission.NETWORK_STACK,
1577 android.Manifest.permission.NETWORK_SETTINGS})
1578 @NonNull
Aaron Huangab615e52021-04-17 13:46:25 +08001579 public List<NetworkStateSnapshot> getAllNetworkStateSnapshots() {
junyulaib1211372021-03-03 12:09:05 +08001580 try {
Aaron Huangab615e52021-04-17 13:46:25 +08001581 return mService.getAllNetworkStateSnapshots();
junyulaib1211372021-03-03 12:09:05 +08001582 } catch (RemoteException e) {
1583 throw e.rethrowFromSystemServer();
1584 }
1585 }
1586
1587 /**
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001588 * Returns the {@link Network} object currently serving a given type, or
1589 * null if the given type is not connected.
1590 *
1591 * @hide
1592 * @deprecated This method does not support multiple connected networks
1593 * of the same type. Use {@link #getAllNetworks} and
1594 * {@link #getNetworkInfo(android.net.Network)} instead.
1595 */
1596 @Deprecated
1597 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1598 @UnsupportedAppUsage
1599 public Network getNetworkForType(int networkType) {
1600 try {
1601 return mService.getNetworkForType(networkType);
1602 } catch (RemoteException e) {
1603 throw e.rethrowFromSystemServer();
1604 }
1605 }
1606
1607 /**
Chalard Jean0c7ebe92022-08-03 14:45:47 +09001608 * Returns an array of all {@link Network} currently tracked by the framework.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001609 *
Lorenzo Colitti86714b12021-05-17 20:31:21 +09001610 * @deprecated This method does not provide any notification of network state changes, forcing
1611 * apps to call it repeatedly. This is inefficient and prone to race conditions.
1612 * Apps should use methods such as
1613 * {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)} instead.
1614 * Apps that desire to obtain information about networks that do not apply to them
1615 * can use {@link NetworkRequest.Builder#setIncludeOtherUidNetworks}.
1616 *
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001617 * @return an array of {@link Network} objects.
1618 */
1619 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1620 @NonNull
Lorenzo Colitti86714b12021-05-17 20:31:21 +09001621 @Deprecated
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001622 public Network[] getAllNetworks() {
1623 try {
1624 return mService.getAllNetworks();
1625 } catch (RemoteException e) {
1626 throw e.rethrowFromSystemServer();
1627 }
1628 }
1629
1630 /**
Roshan Piuse08bc182020-12-22 15:10:42 -08001631 * Returns an array of {@link NetworkCapabilities} objects, representing
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001632 * the Networks that applications run by the given user will use by default.
1633 * @hide
1634 */
1635 @UnsupportedAppUsage
1636 public NetworkCapabilities[] getDefaultNetworkCapabilitiesForUser(int userId) {
1637 try {
1638 return mService.getDefaultNetworkCapabilitiesForUser(
Roshan Piusa8a477b2020-12-17 14:53:09 -08001639 userId, mContext.getOpPackageName(), getAttributionTag());
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001640 } catch (RemoteException e) {
1641 throw e.rethrowFromSystemServer();
1642 }
1643 }
1644
1645 /**
1646 * Returns the IP information for the current default network.
1647 *
1648 * @return a {@link LinkProperties} object describing the IP info
1649 * for the current default network, or {@code null} if there
1650 * is no current default network.
1651 *
1652 * {@hide}
1653 * @deprecated please use {@link #getLinkProperties(Network)} on the return
1654 * value of {@link #getActiveNetwork()} instead. In particular,
1655 * this method will return non-null LinkProperties even if the
1656 * app is blocked by policy from using this network.
1657 */
1658 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1659 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 109783091)
1660 public LinkProperties getActiveLinkProperties() {
1661 try {
1662 return mService.getActiveLinkProperties();
1663 } catch (RemoteException e) {
1664 throw e.rethrowFromSystemServer();
1665 }
1666 }
1667
1668 /**
1669 * Returns the IP information for a given network type.
1670 *
1671 * @param networkType the network type of interest.
1672 * @return a {@link LinkProperties} object describing the IP info
1673 * for the given networkType, or {@code null} if there is
1674 * no current default network.
1675 *
1676 * {@hide}
1677 * @deprecated This method does not support multiple connected networks
1678 * of the same type. Use {@link #getAllNetworks},
1679 * {@link #getNetworkInfo(android.net.Network)}, and
1680 * {@link #getLinkProperties(android.net.Network)} instead.
1681 */
1682 @Deprecated
1683 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1684 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 130143562)
1685 public LinkProperties getLinkProperties(int networkType) {
1686 try {
1687 return mService.getLinkPropertiesForType(networkType);
1688 } catch (RemoteException e) {
1689 throw e.rethrowFromSystemServer();
1690 }
1691 }
1692
1693 /**
1694 * Get the {@link LinkProperties} for the given {@link Network}. This
1695 * will return {@code null} if the network is unknown.
1696 *
1697 * @param network The {@link Network} object identifying the network in question.
1698 * @return The {@link LinkProperties} for the network, or {@code null}.
1699 */
1700 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1701 @Nullable
1702 public LinkProperties getLinkProperties(@Nullable Network network) {
1703 try {
1704 return mService.getLinkProperties(network);
1705 } catch (RemoteException e) {
1706 throw e.rethrowFromSystemServer();
1707 }
1708 }
1709
1710 /**
lucaslinc582d502022-01-27 09:07:00 +08001711 * Redact {@link LinkProperties} for a given package
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001712 *
lucaslinc582d502022-01-27 09:07:00 +08001713 * Returns an instance of the given {@link LinkProperties} appropriately redacted to send to the
1714 * given package, considering its permissions.
1715 *
1716 * @param lp A {@link LinkProperties} which will be redacted.
1717 * @param uid The target uid.
1718 * @param packageName The name of the package, for appops logging.
1719 * @return A redacted {@link LinkProperties} which is appropriate to send to the given uid,
1720 * or null if the uid lacks the ACCESS_NETWORK_STATE permission.
1721 * @hide
1722 */
1723 @RequiresPermission(anyOf = {
1724 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
1725 android.Manifest.permission.NETWORK_STACK,
1726 android.Manifest.permission.NETWORK_SETTINGS})
1727 @SystemApi(client = MODULE_LIBRARIES)
1728 @Nullable
lucaslind2b06132022-03-02 10:56:57 +08001729 public LinkProperties getRedactedLinkPropertiesForPackage(@NonNull LinkProperties lp, int uid,
lucaslinc582d502022-01-27 09:07:00 +08001730 @NonNull String packageName) {
1731 try {
lucaslind2b06132022-03-02 10:56:57 +08001732 return mService.getRedactedLinkPropertiesForPackage(
lucaslinc582d502022-01-27 09:07:00 +08001733 lp, uid, packageName, getAttributionTag());
1734 } catch (RemoteException e) {
1735 throw e.rethrowFromSystemServer();
1736 }
1737 }
1738
1739 /**
1740 * Get the {@link NetworkCapabilities} for the given {@link Network}, or null.
1741 *
1742 * This will remove any location sensitive data in the returned {@link NetworkCapabilities}.
1743 * Some {@link TransportInfo} instances like {@link android.net.wifi.WifiInfo} contain location
1744 * sensitive information. To retrieve this location sensitive information (subject to
1745 * the caller's location permissions), use a {@link NetworkCallback} with the
1746 * {@link NetworkCallback#FLAG_INCLUDE_LOCATION_INFO} flag instead.
1747 *
1748 * This method returns {@code null} if the network is unknown or if the |network| argument
1749 * is null.
Roshan Piuse08bc182020-12-22 15:10:42 -08001750 *
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001751 * @param network The {@link Network} object identifying the network in question.
Roshan Piuse08bc182020-12-22 15:10:42 -08001752 * @return The {@link NetworkCapabilities} for the network, or {@code null}.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001753 */
1754 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1755 @Nullable
1756 public NetworkCapabilities getNetworkCapabilities(@Nullable Network network) {
1757 try {
Roshan Piusa8a477b2020-12-17 14:53:09 -08001758 return mService.getNetworkCapabilities(
1759 network, mContext.getOpPackageName(), getAttributionTag());
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001760 } catch (RemoteException e) {
1761 throw e.rethrowFromSystemServer();
1762 }
1763 }
1764
1765 /**
lucaslinc582d502022-01-27 09:07:00 +08001766 * Redact {@link NetworkCapabilities} for a given package.
1767 *
1768 * Returns an instance of {@link NetworkCapabilities} that is appropriately redacted to send
lucaslind2b06132022-03-02 10:56:57 +08001769 * to the given package, considering its permissions. If the passed capabilities contain
1770 * location-sensitive information, they will be redacted to the correct degree for the location
1771 * permissions of the app (COARSE or FINE), and will blame the UID accordingly for retrieving
1772 * that level of location. If the UID holds no location permission, the returned object will
1773 * contain no location-sensitive information and the UID is not blamed.
lucaslinc582d502022-01-27 09:07:00 +08001774 *
1775 * @param nc A {@link NetworkCapabilities} instance which will be redacted.
1776 * @param uid The target uid.
1777 * @param packageName The name of the package, for appops logging.
1778 * @return A redacted {@link NetworkCapabilities} which is appropriate to send to the given uid,
1779 * or null if the uid lacks the ACCESS_NETWORK_STATE permission.
1780 * @hide
1781 */
1782 @RequiresPermission(anyOf = {
1783 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
1784 android.Manifest.permission.NETWORK_STACK,
1785 android.Manifest.permission.NETWORK_SETTINGS})
1786 @SystemApi(client = MODULE_LIBRARIES)
1787 @Nullable
lucaslind2b06132022-03-02 10:56:57 +08001788 public NetworkCapabilities getRedactedNetworkCapabilitiesForPackage(
lucaslinc582d502022-01-27 09:07:00 +08001789 @NonNull NetworkCapabilities nc,
1790 int uid, @NonNull String packageName) {
1791 try {
lucaslind2b06132022-03-02 10:56:57 +08001792 return mService.getRedactedNetworkCapabilitiesForPackage(nc, uid, packageName,
lucaslinc582d502022-01-27 09:07:00 +08001793 getAttributionTag());
1794 } catch (RemoteException e) {
1795 throw e.rethrowFromSystemServer();
1796 }
1797 }
1798
1799 /**
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001800 * Gets a URL that can be used for resolving whether a captive portal is present.
1801 * 1. This URL should respond with a 204 response to a GET request to indicate no captive
1802 * portal is present.
1803 * 2. This URL must be HTTP as redirect responses are used to find captive portal
1804 * sign-in pages. Captive portals cannot respond to HTTPS requests with redirects.
1805 *
1806 * The system network validation may be using different strategies to detect captive portals,
1807 * so this method does not necessarily return a URL used by the system. It only returns a URL
1808 * that may be relevant for other components trying to detect captive portals.
1809 *
1810 * @hide
Chalard Jean0c7ebe92022-08-03 14:45:47 +09001811 * @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 +09001812 * system.
1813 */
1814 @Deprecated
1815 @SystemApi
1816 @RequiresPermission(android.Manifest.permission.NETWORK_SETTINGS)
1817 public String getCaptivePortalServerUrl() {
1818 try {
1819 return mService.getCaptivePortalServerUrl();
1820 } catch (RemoteException e) {
1821 throw e.rethrowFromSystemServer();
1822 }
1823 }
1824
1825 /**
1826 * Tells the underlying networking system that the caller wants to
1827 * begin using the named feature. The interpretation of {@code feature}
1828 * is completely up to each networking implementation.
1829 *
1830 * <p>This method requires the caller to hold either the
1831 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
1832 * or the ability to modify system settings as determined by
1833 * {@link android.provider.Settings.System#canWrite}.</p>
1834 *
1835 * @param networkType specifies which network the request pertains to
1836 * @param feature the name of the feature to be used
1837 * @return an integer value representing the outcome of the request.
1838 * The interpretation of this value is specific to each networking
1839 * implementation+feature combination, except that the value {@code -1}
1840 * always indicates failure.
1841 *
1842 * @deprecated Deprecated in favor of the cleaner
1843 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} API.
1844 * In {@link VERSION_CODES#M}, and above, this method is unsupported and will
1845 * throw {@code UnsupportedOperationException} if called.
1846 * @removed
1847 */
1848 @Deprecated
1849 public int startUsingNetworkFeature(int networkType, String feature) {
1850 checkLegacyRoutingApiAccess();
1851 NetworkCapabilities netCap = networkCapabilitiesForFeature(networkType, feature);
1852 if (netCap == null) {
1853 Log.d(TAG, "Can't satisfy startUsingNetworkFeature for " + networkType + ", " +
1854 feature);
1855 return DEPRECATED_PHONE_CONSTANT_APN_REQUEST_FAILED;
1856 }
1857
1858 NetworkRequest request = null;
1859 synchronized (sLegacyRequests) {
1860 LegacyRequest l = sLegacyRequests.get(netCap);
1861 if (l != null) {
1862 Log.d(TAG, "renewing startUsingNetworkFeature request " + l.networkRequest);
1863 renewRequestLocked(l);
1864 if (l.currentNetwork != null) {
1865 return DEPRECATED_PHONE_CONSTANT_APN_ALREADY_ACTIVE;
1866 } else {
1867 return DEPRECATED_PHONE_CONSTANT_APN_REQUEST_STARTED;
1868 }
1869 }
1870
1871 request = requestNetworkForFeatureLocked(netCap);
1872 }
1873 if (request != null) {
1874 Log.d(TAG, "starting startUsingNetworkFeature for request " + request);
1875 return DEPRECATED_PHONE_CONSTANT_APN_REQUEST_STARTED;
1876 } else {
1877 Log.d(TAG, " request Failed");
1878 return DEPRECATED_PHONE_CONSTANT_APN_REQUEST_FAILED;
1879 }
1880 }
1881
1882 /**
1883 * Tells the underlying networking system that the caller is finished
1884 * using the named feature. The interpretation of {@code feature}
1885 * is completely up to each networking implementation.
1886 *
1887 * <p>This method requires the caller to hold either the
1888 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
1889 * or the ability to modify system settings as determined by
1890 * {@link android.provider.Settings.System#canWrite}.</p>
1891 *
1892 * @param networkType specifies which network the request pertains to
1893 * @param feature the name of the feature that is no longer needed
1894 * @return an integer value representing the outcome of the request.
1895 * The interpretation of this value is specific to each networking
1896 * implementation+feature combination, except that the value {@code -1}
1897 * always indicates failure.
1898 *
1899 * @deprecated Deprecated in favor of the cleaner
1900 * {@link #unregisterNetworkCallback(NetworkCallback)} API.
1901 * In {@link VERSION_CODES#M}, and above, this method is unsupported and will
1902 * throw {@code UnsupportedOperationException} if called.
1903 * @removed
1904 */
1905 @Deprecated
1906 public int stopUsingNetworkFeature(int networkType, String feature) {
1907 checkLegacyRoutingApiAccess();
1908 NetworkCapabilities netCap = networkCapabilitiesForFeature(networkType, feature);
1909 if (netCap == null) {
1910 Log.d(TAG, "Can't satisfy stopUsingNetworkFeature for " + networkType + ", " +
1911 feature);
1912 return -1;
1913 }
1914
1915 if (removeRequestForFeature(netCap)) {
1916 Log.d(TAG, "stopUsingNetworkFeature for " + networkType + ", " + feature);
1917 }
1918 return 1;
1919 }
1920
1921 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
1922 private NetworkCapabilities networkCapabilitiesForFeature(int networkType, String feature) {
1923 if (networkType == TYPE_MOBILE) {
1924 switch (feature) {
1925 case "enableCBS":
1926 return networkCapabilitiesForType(TYPE_MOBILE_CBS);
1927 case "enableDUN":
1928 case "enableDUNAlways":
1929 return networkCapabilitiesForType(TYPE_MOBILE_DUN);
1930 case "enableFOTA":
1931 return networkCapabilitiesForType(TYPE_MOBILE_FOTA);
1932 case "enableHIPRI":
1933 return networkCapabilitiesForType(TYPE_MOBILE_HIPRI);
1934 case "enableIMS":
1935 return networkCapabilitiesForType(TYPE_MOBILE_IMS);
1936 case "enableMMS":
1937 return networkCapabilitiesForType(TYPE_MOBILE_MMS);
1938 case "enableSUPL":
1939 return networkCapabilitiesForType(TYPE_MOBILE_SUPL);
1940 default:
1941 return null;
1942 }
1943 } else if (networkType == TYPE_WIFI && "p2p".equals(feature)) {
1944 return networkCapabilitiesForType(TYPE_WIFI_P2P);
1945 }
1946 return null;
1947 }
1948
1949 private int legacyTypeForNetworkCapabilities(NetworkCapabilities netCap) {
1950 if (netCap == null) return TYPE_NONE;
1951 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_CBS)) {
1952 return TYPE_MOBILE_CBS;
1953 }
1954 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_IMS)) {
1955 return TYPE_MOBILE_IMS;
1956 }
1957 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_FOTA)) {
1958 return TYPE_MOBILE_FOTA;
1959 }
1960 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_DUN)) {
1961 return TYPE_MOBILE_DUN;
1962 }
1963 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_SUPL)) {
1964 return TYPE_MOBILE_SUPL;
1965 }
1966 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_MMS)) {
1967 return TYPE_MOBILE_MMS;
1968 }
1969 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_INTERNET)) {
1970 return TYPE_MOBILE_HIPRI;
1971 }
1972 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_WIFI_P2P)) {
1973 return TYPE_WIFI_P2P;
1974 }
1975 return TYPE_NONE;
1976 }
1977
1978 private static class LegacyRequest {
1979 NetworkCapabilities networkCapabilities;
1980 NetworkRequest networkRequest;
1981 int expireSequenceNumber;
1982 Network currentNetwork;
1983 int delay = -1;
1984
1985 private void clearDnsBinding() {
1986 if (currentNetwork != null) {
1987 currentNetwork = null;
1988 setProcessDefaultNetworkForHostResolution(null);
1989 }
1990 }
1991
1992 NetworkCallback networkCallback = new NetworkCallback() {
1993 @Override
1994 public void onAvailable(Network network) {
1995 currentNetwork = network;
1996 Log.d(TAG, "startUsingNetworkFeature got Network:" + network);
1997 setProcessDefaultNetworkForHostResolution(network);
1998 }
1999 @Override
2000 public void onLost(Network network) {
2001 if (network.equals(currentNetwork)) clearDnsBinding();
2002 Log.d(TAG, "startUsingNetworkFeature lost Network:" + network);
2003 }
2004 };
2005 }
2006
2007 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
2008 private static final HashMap<NetworkCapabilities, LegacyRequest> sLegacyRequests =
2009 new HashMap<>();
2010
2011 private NetworkRequest findRequestForFeature(NetworkCapabilities netCap) {
2012 synchronized (sLegacyRequests) {
2013 LegacyRequest l = sLegacyRequests.get(netCap);
2014 if (l != null) return l.networkRequest;
2015 }
2016 return null;
2017 }
2018
2019 private void renewRequestLocked(LegacyRequest l) {
2020 l.expireSequenceNumber++;
2021 Log.d(TAG, "renewing request to seqNum " + l.expireSequenceNumber);
2022 sendExpireMsgForFeature(l.networkCapabilities, l.expireSequenceNumber, l.delay);
2023 }
2024
2025 private void expireRequest(NetworkCapabilities netCap, int sequenceNum) {
2026 int ourSeqNum = -1;
2027 synchronized (sLegacyRequests) {
2028 LegacyRequest l = sLegacyRequests.get(netCap);
2029 if (l == null) return;
2030 ourSeqNum = l.expireSequenceNumber;
2031 if (l.expireSequenceNumber == sequenceNum) removeRequestForFeature(netCap);
2032 }
2033 Log.d(TAG, "expireRequest with " + ourSeqNum + ", " + sequenceNum);
2034 }
2035
2036 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
2037 private NetworkRequest requestNetworkForFeatureLocked(NetworkCapabilities netCap) {
2038 int delay = -1;
2039 int type = legacyTypeForNetworkCapabilities(netCap);
2040 try {
2041 delay = mService.getRestoreDefaultNetworkDelay(type);
2042 } catch (RemoteException e) {
2043 throw e.rethrowFromSystemServer();
2044 }
2045 LegacyRequest l = new LegacyRequest();
2046 l.networkCapabilities = netCap;
2047 l.delay = delay;
2048 l.expireSequenceNumber = 0;
2049 l.networkRequest = sendRequestForNetwork(
2050 netCap, l.networkCallback, 0, REQUEST, type, getDefaultHandler());
2051 if (l.networkRequest == null) return null;
2052 sLegacyRequests.put(netCap, l);
2053 sendExpireMsgForFeature(netCap, l.expireSequenceNumber, delay);
2054 return l.networkRequest;
2055 }
2056
2057 private void sendExpireMsgForFeature(NetworkCapabilities netCap, int seqNum, int delay) {
2058 if (delay >= 0) {
2059 Log.d(TAG, "sending expire msg with seqNum " + seqNum + " and delay " + delay);
2060 CallbackHandler handler = getDefaultHandler();
2061 Message msg = handler.obtainMessage(EXPIRE_LEGACY_REQUEST, seqNum, 0, netCap);
2062 handler.sendMessageDelayed(msg, delay);
2063 }
2064 }
2065
2066 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
2067 private boolean removeRequestForFeature(NetworkCapabilities netCap) {
2068 final LegacyRequest l;
2069 synchronized (sLegacyRequests) {
2070 l = sLegacyRequests.remove(netCap);
2071 }
2072 if (l == null) return false;
2073 unregisterNetworkCallback(l.networkCallback);
2074 l.clearDnsBinding();
2075 return true;
2076 }
2077
2078 private static final SparseIntArray sLegacyTypeToTransport = new SparseIntArray();
2079 static {
2080 sLegacyTypeToTransport.put(TYPE_MOBILE, NetworkCapabilities.TRANSPORT_CELLULAR);
2081 sLegacyTypeToTransport.put(TYPE_MOBILE_CBS, NetworkCapabilities.TRANSPORT_CELLULAR);
2082 sLegacyTypeToTransport.put(TYPE_MOBILE_DUN, NetworkCapabilities.TRANSPORT_CELLULAR);
2083 sLegacyTypeToTransport.put(TYPE_MOBILE_FOTA, NetworkCapabilities.TRANSPORT_CELLULAR);
2084 sLegacyTypeToTransport.put(TYPE_MOBILE_HIPRI, NetworkCapabilities.TRANSPORT_CELLULAR);
2085 sLegacyTypeToTransport.put(TYPE_MOBILE_IMS, NetworkCapabilities.TRANSPORT_CELLULAR);
2086 sLegacyTypeToTransport.put(TYPE_MOBILE_MMS, NetworkCapabilities.TRANSPORT_CELLULAR);
2087 sLegacyTypeToTransport.put(TYPE_MOBILE_SUPL, NetworkCapabilities.TRANSPORT_CELLULAR);
2088 sLegacyTypeToTransport.put(TYPE_WIFI, NetworkCapabilities.TRANSPORT_WIFI);
2089 sLegacyTypeToTransport.put(TYPE_WIFI_P2P, NetworkCapabilities.TRANSPORT_WIFI);
2090 sLegacyTypeToTransport.put(TYPE_BLUETOOTH, NetworkCapabilities.TRANSPORT_BLUETOOTH);
2091 sLegacyTypeToTransport.put(TYPE_ETHERNET, NetworkCapabilities.TRANSPORT_ETHERNET);
2092 }
2093
2094 private static final SparseIntArray sLegacyTypeToCapability = new SparseIntArray();
2095 static {
2096 sLegacyTypeToCapability.put(TYPE_MOBILE_CBS, NetworkCapabilities.NET_CAPABILITY_CBS);
2097 sLegacyTypeToCapability.put(TYPE_MOBILE_DUN, NetworkCapabilities.NET_CAPABILITY_DUN);
2098 sLegacyTypeToCapability.put(TYPE_MOBILE_FOTA, NetworkCapabilities.NET_CAPABILITY_FOTA);
2099 sLegacyTypeToCapability.put(TYPE_MOBILE_IMS, NetworkCapabilities.NET_CAPABILITY_IMS);
2100 sLegacyTypeToCapability.put(TYPE_MOBILE_MMS, NetworkCapabilities.NET_CAPABILITY_MMS);
2101 sLegacyTypeToCapability.put(TYPE_MOBILE_SUPL, NetworkCapabilities.NET_CAPABILITY_SUPL);
2102 sLegacyTypeToCapability.put(TYPE_WIFI_P2P, NetworkCapabilities.NET_CAPABILITY_WIFI_P2P);
2103 }
2104
2105 /**
2106 * Given a legacy type (TYPE_WIFI, ...) returns a NetworkCapabilities
2107 * instance suitable for registering a request or callback. Throws an
2108 * IllegalArgumentException if no mapping from the legacy type to
2109 * NetworkCapabilities is known.
2110 *
2111 * @deprecated Types are deprecated. Use {@link NetworkCallback} or {@link NetworkRequest}
2112 * to find the network instead.
2113 * @hide
2114 */
2115 public static NetworkCapabilities networkCapabilitiesForType(int type) {
2116 final NetworkCapabilities nc = new NetworkCapabilities();
2117
2118 // Map from type to transports.
2119 final int NOT_FOUND = -1;
2120 final int transport = sLegacyTypeToTransport.get(type, NOT_FOUND);
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00002121 if (transport == NOT_FOUND) {
2122 throw new IllegalArgumentException("unknown legacy type: " + type);
2123 }
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002124 nc.addTransportType(transport);
2125
2126 // Map from type to capabilities.
2127 nc.addCapability(sLegacyTypeToCapability.get(
2128 type, NetworkCapabilities.NET_CAPABILITY_INTERNET));
2129 nc.maybeMarkCapabilitiesRestricted();
2130 return nc;
2131 }
2132
2133 /** @hide */
2134 public static class PacketKeepaliveCallback {
2135 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
2136 public PacketKeepaliveCallback() {
2137 }
2138 /** The requested keepalive was successfully started. */
2139 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
2140 public void onStarted() {}
2141 /** The keepalive was successfully stopped. */
2142 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
2143 public void onStopped() {}
2144 /** An error occurred. */
2145 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
2146 public void onError(int error) {}
2147 }
2148
2149 /**
2150 * Allows applications to request that the system periodically send specific packets on their
2151 * behalf, using hardware offload to save battery power.
2152 *
2153 * To request that the system send keepalives, call one of the methods that return a
2154 * {@link ConnectivityManager.PacketKeepalive} object, such as {@link #startNattKeepalive},
2155 * passing in a non-null callback. If the callback is successfully started, the callback's
2156 * {@code onStarted} method will be called. If an error occurs, {@code onError} will be called,
2157 * specifying one of the {@code ERROR_*} constants in this class.
2158 *
2159 * To stop an existing keepalive, call {@link PacketKeepalive#stop}. The system will call
2160 * {@link PacketKeepaliveCallback#onStopped} if the operation was successful or
2161 * {@link PacketKeepaliveCallback#onError} if an error occurred.
2162 *
2163 * @deprecated Use {@link SocketKeepalive} instead.
2164 *
2165 * @hide
2166 */
2167 public class PacketKeepalive {
2168
2169 private static final String TAG = "PacketKeepalive";
2170
2171 /** @hide */
2172 public static final int SUCCESS = 0;
2173
2174 /** @hide */
2175 public static final int NO_KEEPALIVE = -1;
2176
2177 /** @hide */
2178 public static final int BINDER_DIED = -10;
2179
2180 /** The specified {@code Network} is not connected. */
2181 public static final int ERROR_INVALID_NETWORK = -20;
2182 /** The specified IP addresses are invalid. For example, the specified source IP address is
2183 * not configured on the specified {@code Network}. */
2184 public static final int ERROR_INVALID_IP_ADDRESS = -21;
2185 /** The requested port is invalid. */
2186 public static final int ERROR_INVALID_PORT = -22;
2187 /** The packet length is invalid (e.g., too long). */
2188 public static final int ERROR_INVALID_LENGTH = -23;
2189 /** The packet transmission interval is invalid (e.g., too short). */
2190 public static final int ERROR_INVALID_INTERVAL = -24;
2191
2192 /** The hardware does not support this request. */
2193 public static final int ERROR_HARDWARE_UNSUPPORTED = -30;
2194 /** The hardware returned an error. */
2195 public static final int ERROR_HARDWARE_ERROR = -31;
2196
2197 /** The NAT-T destination port for IPsec */
2198 public static final int NATT_PORT = 4500;
2199
2200 /** The minimum interval in seconds between keepalive packet transmissions */
2201 public static final int MIN_INTERVAL = 10;
2202
2203 private final Network mNetwork;
2204 private final ISocketKeepaliveCallback mCallback;
2205 private final ExecutorService mExecutor;
2206
2207 private volatile Integer mSlot;
2208
2209 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
2210 public void stop() {
2211 try {
2212 mExecutor.execute(() -> {
2213 try {
2214 if (mSlot != null) {
2215 mService.stopKeepalive(mNetwork, mSlot);
2216 }
2217 } catch (RemoteException e) {
2218 Log.e(TAG, "Error stopping packet keepalive: ", e);
2219 throw e.rethrowFromSystemServer();
2220 }
2221 });
2222 } catch (RejectedExecutionException e) {
2223 // The internal executor has already stopped due to previous event.
2224 }
2225 }
2226
2227 private PacketKeepalive(Network network, PacketKeepaliveCallback callback) {
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00002228 Objects.requireNonNull(network, "network cannot be null");
2229 Objects.requireNonNull(callback, "callback cannot be null");
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002230 mNetwork = network;
2231 mExecutor = Executors.newSingleThreadExecutor();
2232 mCallback = new ISocketKeepaliveCallback.Stub() {
2233 @Override
2234 public void onStarted(int slot) {
2235 final long token = Binder.clearCallingIdentity();
2236 try {
2237 mExecutor.execute(() -> {
2238 mSlot = slot;
2239 callback.onStarted();
2240 });
2241 } finally {
2242 Binder.restoreCallingIdentity(token);
2243 }
2244 }
2245
2246 @Override
2247 public void onStopped() {
2248 final long token = Binder.clearCallingIdentity();
2249 try {
2250 mExecutor.execute(() -> {
2251 mSlot = null;
2252 callback.onStopped();
2253 });
2254 } finally {
2255 Binder.restoreCallingIdentity(token);
2256 }
2257 mExecutor.shutdown();
2258 }
2259
2260 @Override
2261 public void onError(int error) {
2262 final long token = Binder.clearCallingIdentity();
2263 try {
2264 mExecutor.execute(() -> {
2265 mSlot = null;
2266 callback.onError(error);
2267 });
2268 } finally {
2269 Binder.restoreCallingIdentity(token);
2270 }
2271 mExecutor.shutdown();
2272 }
2273
2274 @Override
2275 public void onDataReceived() {
2276 // PacketKeepalive is only used for Nat-T keepalive and as such does not invoke
2277 // this callback when data is received.
2278 }
2279 };
2280 }
2281 }
2282
2283 /**
2284 * Starts an IPsec NAT-T keepalive packet with the specified parameters.
2285 *
2286 * @deprecated Use {@link #createSocketKeepalive} instead.
2287 *
2288 * @hide
2289 */
2290 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
2291 public PacketKeepalive startNattKeepalive(
2292 Network network, int intervalSeconds, PacketKeepaliveCallback callback,
2293 InetAddress srcAddr, int srcPort, InetAddress dstAddr) {
2294 final PacketKeepalive k = new PacketKeepalive(network, callback);
2295 try {
2296 mService.startNattKeepalive(network, intervalSeconds, k.mCallback,
2297 srcAddr.getHostAddress(), srcPort, dstAddr.getHostAddress());
2298 } catch (RemoteException e) {
2299 Log.e(TAG, "Error starting packet keepalive: ", e);
2300 throw e.rethrowFromSystemServer();
2301 }
2302 return k;
2303 }
2304
2305 // Construct an invalid fd.
2306 private ParcelFileDescriptor createInvalidFd() {
2307 final int invalidFd = -1;
2308 return ParcelFileDescriptor.adoptFd(invalidFd);
2309 }
2310
2311 /**
2312 * Request that keepalives be started on a IPsec NAT-T socket.
2313 *
2314 * @param network The {@link Network} the socket is on.
2315 * @param socket The socket that needs to be kept alive.
2316 * @param source The source address of the {@link UdpEncapsulationSocket}.
2317 * @param destination The destination address of the {@link UdpEncapsulationSocket}.
2318 * @param executor The executor on which callback will be invoked. The provided {@link Executor}
2319 * must run callback sequentially, otherwise the order of callbacks cannot be
2320 * guaranteed.
2321 * @param callback A {@link SocketKeepalive.Callback}. Used for notifications about keepalive
2322 * changes. Must be extended by applications that use this API.
2323 *
2324 * @return A {@link SocketKeepalive} object that can be used to control the keepalive on the
2325 * given socket.
2326 **/
2327 public @NonNull SocketKeepalive createSocketKeepalive(@NonNull Network network,
2328 @NonNull UdpEncapsulationSocket socket,
2329 @NonNull InetAddress source,
2330 @NonNull InetAddress destination,
2331 @NonNull @CallbackExecutor Executor executor,
2332 @NonNull Callback callback) {
2333 ParcelFileDescriptor dup;
2334 try {
2335 // Dup is needed here as the pfd inside the socket is owned by the IpSecService,
2336 // which cannot be obtained by the app process.
2337 dup = ParcelFileDescriptor.dup(socket.getFileDescriptor());
2338 } catch (IOException ignored) {
2339 // Construct an invalid fd, so that if the user later calls start(), it will fail with
2340 // ERROR_INVALID_SOCKET.
2341 dup = createInvalidFd();
2342 }
2343 return new NattSocketKeepalive(mService, network, dup, socket.getResourceId(), source,
2344 destination, executor, callback);
2345 }
2346
2347 /**
2348 * Request that keepalives be started on a IPsec NAT-T socket file descriptor. Directly called
2349 * by system apps which don't use IpSecService to create {@link UdpEncapsulationSocket}.
2350 *
2351 * @param network The {@link Network} the socket is on.
2352 * @param pfd The {@link ParcelFileDescriptor} that needs to be kept alive. The provided
2353 * {@link ParcelFileDescriptor} must be bound to a port and the keepalives will be sent
2354 * from that port.
2355 * @param source The source address of the {@link UdpEncapsulationSocket}.
2356 * @param destination The destination address of the {@link UdpEncapsulationSocket}. The
2357 * keepalive packets will always be sent to port 4500 of the given {@code destination}.
2358 * @param executor The executor on which callback will be invoked. The provided {@link Executor}
2359 * must run callback sequentially, otherwise the order of callbacks cannot be
2360 * guaranteed.
2361 * @param callback A {@link SocketKeepalive.Callback}. Used for notifications about keepalive
2362 * changes. Must be extended by applications that use this API.
2363 *
2364 * @return A {@link SocketKeepalive} object that can be used to control the keepalive on the
2365 * given socket.
2366 * @hide
2367 */
2368 @SystemApi
2369 @RequiresPermission(android.Manifest.permission.PACKET_KEEPALIVE_OFFLOAD)
2370 public @NonNull SocketKeepalive createNattKeepalive(@NonNull Network network,
2371 @NonNull ParcelFileDescriptor pfd,
2372 @NonNull InetAddress source,
2373 @NonNull InetAddress destination,
2374 @NonNull @CallbackExecutor Executor executor,
2375 @NonNull Callback callback) {
2376 ParcelFileDescriptor dup;
2377 try {
2378 // TODO: Consider remove unnecessary dup.
2379 dup = pfd.dup();
2380 } catch (IOException ignored) {
2381 // Construct an invalid fd, so that if the user later calls start(), it will fail with
2382 // ERROR_INVALID_SOCKET.
2383 dup = createInvalidFd();
2384 }
2385 return new NattSocketKeepalive(mService, network, dup,
Remi NGUYEN VANa29be5c2021-03-11 10:56:49 +00002386 -1 /* Unused */, source, destination, executor, callback);
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002387 }
2388
2389 /**
Chalard Jean0c7ebe92022-08-03 14:45:47 +09002390 * Request that keepalives be started on a TCP socket. The socket must be established.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002391 *
2392 * @param network The {@link Network} the socket is on.
2393 * @param socket The socket that needs to be kept alive.
2394 * @param executor The executor on which callback will be invoked. This implementation assumes
2395 * the provided {@link Executor} runs the callbacks in sequence with no
2396 * concurrency. Failing this, no guarantee of correctness can be made. It is
2397 * the responsibility of the caller to ensure the executor provides this
2398 * guarantee. A simple way of creating such an executor is with the standard
2399 * tool {@code Executors.newSingleThreadExecutor}.
2400 * @param callback A {@link SocketKeepalive.Callback}. Used for notifications about keepalive
2401 * changes. Must be extended by applications that use this API.
2402 *
2403 * @return A {@link SocketKeepalive} object that can be used to control the keepalive on the
2404 * given socket.
2405 * @hide
2406 */
2407 @SystemApi
2408 @RequiresPermission(android.Manifest.permission.PACKET_KEEPALIVE_OFFLOAD)
2409 public @NonNull SocketKeepalive createSocketKeepalive(@NonNull Network network,
2410 @NonNull Socket socket,
2411 @NonNull Executor executor,
2412 @NonNull Callback callback) {
2413 ParcelFileDescriptor dup;
2414 try {
2415 dup = ParcelFileDescriptor.fromSocket(socket);
2416 } catch (UncheckedIOException ignored) {
2417 // Construct an invalid fd, so that if the user later calls start(), it will fail with
2418 // ERROR_INVALID_SOCKET.
2419 dup = createInvalidFd();
2420 }
2421 return new TcpSocketKeepalive(mService, network, dup, executor, callback);
2422 }
2423
2424 /**
2425 * Ensure that a network route exists to deliver traffic to the specified
2426 * host via the specified network interface. An attempt to add a route that
2427 * already exists is ignored, but treated as successful.
2428 *
2429 * <p>This method requires the caller to hold either the
2430 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
2431 * or the ability to modify system settings as determined by
2432 * {@link android.provider.Settings.System#canWrite}.</p>
2433 *
2434 * @param networkType the type of the network over which traffic to the specified
2435 * host is to be routed
2436 * @param hostAddress the IP address of the host to which the route is desired
2437 * @return {@code true} on success, {@code false} on failure
2438 *
2439 * @deprecated Deprecated in favor of the
2440 * {@link #requestNetwork(NetworkRequest, NetworkCallback)},
2441 * {@link #bindProcessToNetwork} and {@link Network#getSocketFactory} API.
2442 * In {@link VERSION_CODES#M}, and above, this method is unsupported and will
2443 * throw {@code UnsupportedOperationException} if called.
2444 * @removed
2445 */
2446 @Deprecated
2447 public boolean requestRouteToHost(int networkType, int hostAddress) {
2448 return requestRouteToHostAddress(networkType, NetworkUtils.intToInetAddress(hostAddress));
2449 }
2450
2451 /**
2452 * Ensure that a network route exists to deliver traffic to the specified
2453 * host via the specified network interface. An attempt to add a route that
2454 * already exists is ignored, but treated as successful.
2455 *
2456 * <p>This method requires the caller to hold either the
2457 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
2458 * or the ability to modify system settings as determined by
2459 * {@link android.provider.Settings.System#canWrite}.</p>
2460 *
2461 * @param networkType the type of the network over which traffic to the specified
2462 * host is to be routed
2463 * @param hostAddress the IP address of the host to which the route is desired
2464 * @return {@code true} on success, {@code false} on failure
2465 * @hide
2466 * @deprecated Deprecated in favor of the {@link #requestNetwork} and
2467 * {@link #bindProcessToNetwork} API.
2468 */
2469 @Deprecated
2470 @UnsupportedAppUsage
lucaslin97fb10a2021-03-22 11:51:27 +08002471 @SystemApi(client = MODULE_LIBRARIES)
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002472 public boolean requestRouteToHostAddress(int networkType, InetAddress hostAddress) {
2473 checkLegacyRoutingApiAccess();
2474 try {
2475 return mService.requestRouteToHostAddress(networkType, hostAddress.getAddress(),
2476 mContext.getOpPackageName(), getAttributionTag());
2477 } catch (RemoteException e) {
2478 throw e.rethrowFromSystemServer();
2479 }
2480 }
2481
2482 /**
2483 * @return the context's attribution tag
2484 */
2485 // TODO: Remove method and replace with direct call once R code is pushed to AOSP
2486 private @Nullable String getAttributionTag() {
Remi NGUYEN VANa522fc22021-02-01 10:25:24 +00002487 return mContext.getAttributionTag();
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002488 }
2489
2490 /**
2491 * Returns the value of the setting for background data usage. If false,
2492 * applications should not use the network if the application is not in the
2493 * foreground. Developers should respect this setting, and check the value
2494 * of this before performing any background data operations.
2495 * <p>
2496 * All applications that have background services that use the network
2497 * should listen to {@link #ACTION_BACKGROUND_DATA_SETTING_CHANGED}.
2498 * <p>
2499 * @deprecated As of {@link VERSION_CODES#ICE_CREAM_SANDWICH}, availability of
2500 * background data depends on several combined factors, and this method will
2501 * always return {@code true}. Instead, when background data is unavailable,
2502 * {@link #getActiveNetworkInfo()} will now appear disconnected.
2503 *
2504 * @return Whether background data usage is allowed.
2505 */
2506 @Deprecated
2507 public boolean getBackgroundDataSetting() {
2508 // assume that background data is allowed; final authority is
2509 // NetworkInfo which may be blocked.
2510 return true;
2511 }
2512
2513 /**
2514 * Sets the value of the setting for background data usage.
2515 *
2516 * @param allowBackgroundData Whether an application should use data while
2517 * it is in the background.
2518 *
2519 * @attr ref android.Manifest.permission#CHANGE_BACKGROUND_DATA_SETTING
2520 * @see #getBackgroundDataSetting()
2521 * @hide
2522 */
2523 @Deprecated
2524 @UnsupportedAppUsage
2525 public void setBackgroundDataSetting(boolean allowBackgroundData) {
2526 // ignored
2527 }
2528
2529 /**
2530 * @hide
2531 * @deprecated Talk to TelephonyManager directly
2532 */
2533 @Deprecated
2534 @UnsupportedAppUsage
2535 public boolean getMobileDataEnabled() {
2536 TelephonyManager tm = mContext.getSystemService(TelephonyManager.class);
2537 if (tm != null) {
2538 int subId = SubscriptionManager.getDefaultDataSubscriptionId();
2539 Log.d("ConnectivityManager", "getMobileDataEnabled()+ subId=" + subId);
2540 boolean retVal = tm.createForSubscriptionId(subId).isDataEnabled();
2541 Log.d("ConnectivityManager", "getMobileDataEnabled()- subId=" + subId
2542 + " retVal=" + retVal);
2543 return retVal;
2544 }
2545 Log.d("ConnectivityManager", "getMobileDataEnabled()- remote exception retVal=false");
2546 return false;
2547 }
2548
2549 /**
2550 * Callback for use with {@link ConnectivityManager#addDefaultNetworkActiveListener}
2551 * to find out when the system default network has gone in to a high power state.
2552 */
2553 public interface OnNetworkActiveListener {
2554 /**
2555 * Called on the main thread of the process to report that the current data network
2556 * has become active, and it is now a good time to perform any pending network
2557 * operations. Note that this listener only tells you when the network becomes
2558 * active; if at any other time you want to know whether it is active (and thus okay
2559 * to initiate network traffic), you can retrieve its instantaneous state with
2560 * {@link ConnectivityManager#isDefaultNetworkActive}.
2561 */
2562 void onNetworkActive();
2563 }
2564
Chiachang Wang2de41682021-09-23 10:46:03 +08002565 @GuardedBy("mNetworkActivityListeners")
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002566 private final ArrayMap<OnNetworkActiveListener, INetworkActivityListener>
2567 mNetworkActivityListeners = new ArrayMap<>();
2568
2569 /**
2570 * Start listening to reports when the system's default data network is active, meaning it is
2571 * a good time to perform network traffic. Use {@link #isDefaultNetworkActive()}
2572 * to determine the current state of the system's default network after registering the
2573 * listener.
2574 * <p>
2575 * If the process default network has been set with
2576 * {@link ConnectivityManager#bindProcessToNetwork} this function will not
2577 * reflect the process's default, but the system default.
2578 *
2579 * @param l The listener to be told when the network is active.
2580 */
2581 public void addDefaultNetworkActiveListener(final OnNetworkActiveListener l) {
Chiachang Wang2de41682021-09-23 10:46:03 +08002582 final INetworkActivityListener rl = new INetworkActivityListener.Stub() {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002583 @Override
2584 public void onNetworkActive() throws RemoteException {
2585 l.onNetworkActive();
2586 }
2587 };
2588
Chiachang Wang2de41682021-09-23 10:46:03 +08002589 synchronized (mNetworkActivityListeners) {
2590 try {
2591 mService.registerNetworkActivityListener(rl);
2592 mNetworkActivityListeners.put(l, rl);
2593 } catch (RemoteException e) {
2594 throw e.rethrowFromSystemServer();
2595 }
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002596 }
2597 }
2598
2599 /**
2600 * Remove network active listener previously registered with
2601 * {@link #addDefaultNetworkActiveListener}.
2602 *
2603 * @param l Previously registered listener.
2604 */
2605 public void removeDefaultNetworkActiveListener(@NonNull OnNetworkActiveListener l) {
Chiachang Wang2de41682021-09-23 10:46:03 +08002606 synchronized (mNetworkActivityListeners) {
2607 final INetworkActivityListener rl = mNetworkActivityListeners.get(l);
2608 if (rl == null) {
2609 throw new IllegalArgumentException("Listener was not registered.");
2610 }
2611 try {
2612 mService.unregisterNetworkActivityListener(rl);
2613 mNetworkActivityListeners.remove(l);
2614 } catch (RemoteException e) {
2615 throw e.rethrowFromSystemServer();
2616 }
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002617 }
2618 }
2619
2620 /**
2621 * Return whether the data network is currently active. An active network means that
2622 * it is currently in a high power state for performing data transmission. On some
2623 * types of networks, it may be expensive to move and stay in such a state, so it is
2624 * more power efficient to batch network traffic together when the radio is already in
2625 * this state. This method tells you whether right now is currently a good time to
2626 * initiate network traffic, as the network is already active.
2627 */
2628 public boolean isDefaultNetworkActive() {
2629 try {
lucaslin709eb842021-01-21 02:04:15 +08002630 return mService.isDefaultNetworkActive();
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002631 } catch (RemoteException e) {
2632 throw e.rethrowFromSystemServer();
2633 }
2634 }
2635
2636 /**
2637 * {@hide}
2638 */
2639 public ConnectivityManager(Context context, IConnectivityManager service) {
markchiend2015662022-04-26 18:08:03 +08002640 this(context, service, true /* newStatic */);
2641 }
2642
2643 private ConnectivityManager(Context context, IConnectivityManager service, boolean newStatic) {
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00002644 mContext = Objects.requireNonNull(context, "missing context");
2645 mService = Objects.requireNonNull(service, "missing IConnectivityManager");
markchiend2015662022-04-26 18:08:03 +08002646 // sInstance is accessed without a lock, so it may actually be reassigned several times with
2647 // different ConnectivityManager, but that's still OK considering its usage.
2648 if (sInstance == null && newStatic) {
2649 final Context appContext = mContext.getApplicationContext();
2650 // Don't create static ConnectivityManager instance again to prevent infinite loop.
2651 // If the application context is null, we're either in the system process or
2652 // it's the application context very early in app initialization. In both these
2653 // cases, the passed-in Context will not be freed, so it's safe to pass it to the
2654 // service. http://b/27532714 .
2655 sInstance = new ConnectivityManager(appContext != null ? appContext : context, service,
2656 false /* newStatic */);
2657 }
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002658 }
2659
2660 /** {@hide} */
2661 @UnsupportedAppUsage
2662 public static ConnectivityManager from(Context context) {
2663 return (ConnectivityManager) context.getSystemService(Context.CONNECTIVITY_SERVICE);
2664 }
2665
2666 /** @hide */
2667 public NetworkRequest getDefaultRequest() {
2668 try {
2669 // This is not racy as the default request is final in ConnectivityService.
2670 return mService.getDefaultRequest();
2671 } catch (RemoteException e) {
2672 throw e.rethrowFromSystemServer();
2673 }
2674 }
2675
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002676 /**
Chalard Jean0c7ebe92022-08-03 14:45:47 +09002677 * Check if the package is allowed to write settings. This also records that such an access
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002678 * happened.
2679 *
2680 * @return {@code true} iff the package is allowed to write settings.
2681 */
2682 // TODO: Remove method and replace with direct call once R code is pushed to AOSP
2683 private static boolean checkAndNoteWriteSettingsOperation(@NonNull Context context, int uid,
2684 @NonNull String callingPackage, @Nullable String callingAttributionTag,
2685 boolean throwException) {
2686 return Settings.checkAndNoteWriteSettingsOperation(context, uid, callingPackage,
Remi NGUYEN VANa522fc22021-02-01 10:25:24 +00002687 callingAttributionTag, throwException);
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002688 }
2689
2690 /**
2691 * @deprecated - use getSystemService. This is a kludge to support static access in certain
2692 * situations where a Context pointer is unavailable.
2693 * @hide
2694 */
2695 @Deprecated
2696 static ConnectivityManager getInstanceOrNull() {
2697 return sInstance;
2698 }
2699
2700 /**
2701 * @deprecated - use getSystemService. This is a kludge to support static access in certain
2702 * situations where a Context pointer is unavailable.
2703 * @hide
2704 */
2705 @Deprecated
2706 @UnsupportedAppUsage
2707 private static ConnectivityManager getInstance() {
2708 if (getInstanceOrNull() == null) {
2709 throw new IllegalStateException("No ConnectivityManager yet constructed");
2710 }
2711 return getInstanceOrNull();
2712 }
2713
2714 /**
2715 * Get the set of tetherable, available interfaces. This list is limited by
2716 * device configuration and current interface existence.
2717 *
2718 * @return an array of 0 or more Strings of tetherable interface names.
2719 *
2720 * @deprecated Use {@link TetheringEventCallback#onTetherableInterfacesChanged(List)} instead.
2721 * {@hide}
2722 */
2723 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
2724 @UnsupportedAppUsage
2725 @Deprecated
2726 public String[] getTetherableIfaces() {
Remi NGUYEN VANe4d1cd92021-06-17 16:27:31 +09002727 return getTetheringManager().getTetherableIfaces();
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002728 }
2729
2730 /**
2731 * Get the set of tethered interfaces.
2732 *
2733 * @return an array of 0 or more String of currently tethered interface names.
2734 *
2735 * @deprecated Use {@link TetheringEventCallback#onTetherableInterfacesChanged(List)} instead.
2736 * {@hide}
2737 */
2738 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
2739 @UnsupportedAppUsage
2740 @Deprecated
2741 public String[] getTetheredIfaces() {
Remi NGUYEN VANe4d1cd92021-06-17 16:27:31 +09002742 return getTetheringManager().getTetheredIfaces();
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002743 }
2744
2745 /**
2746 * Get the set of interface names which attempted to tether but
2747 * failed. Re-attempting to tether may cause them to reset to the Tethered
2748 * state. Alternatively, causing the interface to be destroyed and recreated
2749 * may cause them to reset to the available state.
2750 * {@link ConnectivityManager#getLastTetherError} can be used to get more
2751 * information on the cause of the errors.
2752 *
2753 * @return an array of 0 or more String indicating the interface names
2754 * which failed to tether.
2755 *
2756 * @deprecated Use {@link TetheringEventCallback#onError(String, int)} instead.
2757 * {@hide}
2758 */
2759 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
2760 @UnsupportedAppUsage
2761 @Deprecated
2762 public String[] getTetheringErroredIfaces() {
Remi NGUYEN VANe4d1cd92021-06-17 16:27:31 +09002763 return getTetheringManager().getTetheringErroredIfaces();
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002764 }
2765
2766 /**
2767 * Get the set of tethered dhcp ranges.
2768 *
2769 * @deprecated This method is not supported.
2770 * TODO: remove this function when all of clients are removed.
2771 * {@hide}
2772 */
2773 @RequiresPermission(android.Manifest.permission.NETWORK_SETTINGS)
2774 @Deprecated
2775 public String[] getTetheredDhcpRanges() {
2776 throw new UnsupportedOperationException("getTetheredDhcpRanges is not supported");
2777 }
2778
2779 /**
Chalard Jean0c7ebe92022-08-03 14:45:47 +09002780 * Attempt to tether the named interface. This will set up a dhcp server
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002781 * on the interface, forward and NAT IP packets and forward DNS requests
2782 * to the best active upstream network interface. Note that if no upstream
2783 * IP network interface is available, dhcp will still run and traffic will be
2784 * allowed between the tethered devices and this device, though upstream net
2785 * access will of course fail until an upstream network interface becomes
2786 * active.
2787 *
2788 * <p>This method requires the caller to hold either the
2789 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
2790 * or the ability to modify system settings as determined by
2791 * {@link android.provider.Settings.System#canWrite}.</p>
2792 *
2793 * <p>WARNING: New clients should not use this function. The only usages should be in PanService
2794 * and WifiStateMachine which need direct access. All other clients should use
2795 * {@link #startTethering} and {@link #stopTethering} which encapsulate proper provisioning
2796 * logic.</p>
2797 *
2798 * @param iface the interface name to tether.
2799 * @return error a {@code TETHER_ERROR} value indicating success or failure type
2800 * @deprecated Use {@link TetheringManager#startTethering} instead
2801 *
2802 * {@hide}
2803 */
2804 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
2805 @Deprecated
2806 public int tether(String iface) {
Remi NGUYEN VANe4d1cd92021-06-17 16:27:31 +09002807 return getTetheringManager().tether(iface);
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002808 }
2809
2810 /**
2811 * Stop tethering the named interface.
2812 *
2813 * <p>This method requires the caller to hold either the
2814 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
2815 * or the ability to modify system settings as determined by
2816 * {@link android.provider.Settings.System#canWrite}.</p>
2817 *
2818 * <p>WARNING: New clients should not use this function. The only usages should be in PanService
2819 * and WifiStateMachine which need direct access. All other clients should use
2820 * {@link #startTethering} and {@link #stopTethering} which encapsulate proper provisioning
2821 * logic.</p>
2822 *
2823 * @param iface the interface name to untether.
2824 * @return error a {@code TETHER_ERROR} value indicating success or failure type
2825 *
2826 * {@hide}
2827 */
2828 @UnsupportedAppUsage
2829 @Deprecated
2830 public int untether(String iface) {
Remi NGUYEN VANe4d1cd92021-06-17 16:27:31 +09002831 return getTetheringManager().untether(iface);
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002832 }
2833
2834 /**
2835 * Check if the device allows for tethering. It may be disabled via
2836 * {@code ro.tether.denied} system property, Settings.TETHER_SUPPORTED or
2837 * due to device configuration.
2838 *
2839 * <p>If this app does not have permission to use this API, it will always
2840 * return false rather than throw an exception.</p>
2841 *
2842 * <p>If the device has a hotspot provisioning app, the caller is required to hold the
2843 * {@link android.Manifest.permission.TETHER_PRIVILEGED} permission.</p>
2844 *
2845 * <p>Otherwise, this method requires the caller to hold the ability to modify system
2846 * settings as determined by {@link android.provider.Settings.System#canWrite}.</p>
2847 *
2848 * @return a boolean - {@code true} indicating Tethering is supported.
2849 *
2850 * @deprecated Use {@link TetheringEventCallback#onTetheringSupported(boolean)} instead.
2851 * {@hide}
2852 */
2853 @SystemApi
2854 @RequiresPermission(anyOf = {android.Manifest.permission.TETHER_PRIVILEGED,
2855 android.Manifest.permission.WRITE_SETTINGS})
2856 public boolean isTetheringSupported() {
Remi NGUYEN VANe4d1cd92021-06-17 16:27:31 +09002857 return getTetheringManager().isTetheringSupported();
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002858 }
2859
2860 /**
2861 * Callback for use with {@link #startTethering} to find out whether tethering succeeded.
2862 *
2863 * @deprecated Use {@link TetheringManager.StartTetheringCallback} instead.
2864 * @hide
2865 */
2866 @SystemApi
2867 @Deprecated
2868 public static abstract class OnStartTetheringCallback {
2869 /**
2870 * Called when tethering has been successfully started.
2871 */
2872 public void onTetheringStarted() {}
2873
2874 /**
2875 * Called when starting tethering failed.
2876 */
2877 public void onTetheringFailed() {}
2878 }
2879
2880 /**
2881 * Convenient overload for
2882 * {@link #startTethering(int, boolean, OnStartTetheringCallback, Handler)} which passes a null
2883 * handler to run on the current thread's {@link Looper}.
2884 *
2885 * @deprecated Use {@link TetheringManager#startTethering} instead.
2886 * @hide
2887 */
2888 @SystemApi
2889 @Deprecated
2890 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
2891 public void startTethering(int type, boolean showProvisioningUi,
2892 final OnStartTetheringCallback callback) {
2893 startTethering(type, showProvisioningUi, callback, null);
2894 }
2895
2896 /**
2897 * Runs tether provisioning for the given type if needed and then starts tethering if
2898 * the check succeeds. If no carrier provisioning is required for tethering, tethering is
2899 * enabled immediately. If provisioning fails, tethering will not be enabled. It also
2900 * schedules tether provisioning re-checks if appropriate.
2901 *
2902 * @param type The type of tethering to start. Must be one of
2903 * {@link ConnectivityManager.TETHERING_WIFI},
2904 * {@link ConnectivityManager.TETHERING_USB}, or
2905 * {@link ConnectivityManager.TETHERING_BLUETOOTH}.
2906 * @param showProvisioningUi a boolean indicating to show the provisioning app UI if there
2907 * is one. This should be true the first time this function is called and also any time
2908 * the user can see this UI. It gives users information from their carrier about the
2909 * check failing and how they can sign up for tethering if possible.
2910 * @param callback an {@link OnStartTetheringCallback} which will be called to notify the caller
2911 * of the result of trying to tether.
2912 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
2913 *
2914 * @deprecated Use {@link TetheringManager#startTethering} instead.
2915 * @hide
2916 */
2917 @SystemApi
2918 @Deprecated
2919 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
2920 public void startTethering(int type, boolean showProvisioningUi,
2921 final OnStartTetheringCallback callback, Handler handler) {
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00002922 Objects.requireNonNull(callback, "OnStartTetheringCallback cannot be null.");
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002923
2924 final Executor executor = new Executor() {
2925 @Override
2926 public void execute(Runnable command) {
2927 if (handler == null) {
2928 command.run();
2929 } else {
2930 handler.post(command);
2931 }
2932 }
2933 };
2934
2935 final StartTetheringCallback tetheringCallback = new StartTetheringCallback() {
2936 @Override
2937 public void onTetheringStarted() {
2938 callback.onTetheringStarted();
2939 }
2940
2941 @Override
2942 public void onTetheringFailed(final int error) {
2943 callback.onTetheringFailed();
2944 }
2945 };
2946
2947 final TetheringRequest request = new TetheringRequest.Builder(type)
2948 .setShouldShowEntitlementUi(showProvisioningUi).build();
2949
Remi NGUYEN VANe4d1cd92021-06-17 16:27:31 +09002950 getTetheringManager().startTethering(request, executor, tetheringCallback);
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002951 }
2952
2953 /**
2954 * Stops tethering for the given type. Also cancels any provisioning rechecks for that type if
2955 * applicable.
2956 *
2957 * @param type The type of tethering to stop. Must be one of
2958 * {@link ConnectivityManager.TETHERING_WIFI},
2959 * {@link ConnectivityManager.TETHERING_USB}, or
2960 * {@link ConnectivityManager.TETHERING_BLUETOOTH}.
2961 *
2962 * @deprecated Use {@link TetheringManager#stopTethering} instead.
2963 * @hide
2964 */
2965 @SystemApi
2966 @Deprecated
2967 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
2968 public void stopTethering(int type) {
Remi NGUYEN VANe4d1cd92021-06-17 16:27:31 +09002969 getTetheringManager().stopTethering(type);
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002970 }
2971
2972 /**
2973 * Callback for use with {@link registerTetheringEventCallback} to find out tethering
2974 * upstream status.
2975 *
2976 * @deprecated Use {@link TetheringManager#OnTetheringEventCallback} instead.
2977 * @hide
2978 */
2979 @SystemApi
2980 @Deprecated
2981 public abstract static class OnTetheringEventCallback {
2982
2983 /**
2984 * Called when tethering upstream changed. This can be called multiple times and can be
2985 * called any time.
2986 *
2987 * @param network the {@link Network} of tethering upstream. Null means tethering doesn't
2988 * have any upstream.
2989 */
2990 public void onUpstreamChanged(@Nullable Network network) {}
2991 }
2992
2993 @GuardedBy("mTetheringEventCallbacks")
2994 private final ArrayMap<OnTetheringEventCallback, TetheringEventCallback>
2995 mTetheringEventCallbacks = new ArrayMap<>();
2996
2997 /**
2998 * Start listening to tethering change events. Any new added callback will receive the last
2999 * tethering status right away. If callback is registered when tethering has no upstream or
3000 * disabled, {@link OnTetheringEventCallback#onUpstreamChanged} will immediately be called
3001 * with a null argument. The same callback object cannot be registered twice.
3002 *
3003 * @param executor the executor on which callback will be invoked.
3004 * @param callback the callback to be called when tethering has change events.
3005 *
3006 * @deprecated Use {@link TetheringManager#registerTetheringEventCallback} instead.
3007 * @hide
3008 */
3009 @SystemApi
3010 @Deprecated
3011 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
3012 public void registerTetheringEventCallback(
3013 @NonNull @CallbackExecutor Executor executor,
3014 @NonNull final OnTetheringEventCallback callback) {
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00003015 Objects.requireNonNull(callback, "OnTetheringEventCallback cannot be null.");
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003016
3017 final TetheringEventCallback tetherCallback =
3018 new TetheringEventCallback() {
3019 @Override
3020 public void onUpstreamChanged(@Nullable Network network) {
3021 callback.onUpstreamChanged(network);
3022 }
3023 };
3024
3025 synchronized (mTetheringEventCallbacks) {
3026 mTetheringEventCallbacks.put(callback, tetherCallback);
Remi NGUYEN VANe4d1cd92021-06-17 16:27:31 +09003027 getTetheringManager().registerTetheringEventCallback(executor, tetherCallback);
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003028 }
3029 }
3030
3031 /**
3032 * Remove tethering event callback previously registered with
3033 * {@link #registerTetheringEventCallback}.
3034 *
3035 * @param callback previously registered callback.
3036 *
3037 * @deprecated Use {@link TetheringManager#unregisterTetheringEventCallback} instead.
3038 * @hide
3039 */
3040 @SystemApi
3041 @Deprecated
3042 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
3043 public void unregisterTetheringEventCallback(
3044 @NonNull final OnTetheringEventCallback callback) {
3045 Objects.requireNonNull(callback, "The callback must be non-null");
3046 synchronized (mTetheringEventCallbacks) {
3047 final TetheringEventCallback tetherCallback =
3048 mTetheringEventCallbacks.remove(callback);
Remi NGUYEN VANe4d1cd92021-06-17 16:27:31 +09003049 getTetheringManager().unregisterTetheringEventCallback(tetherCallback);
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003050 }
3051 }
3052
3053
3054 /**
3055 * Get the list of regular expressions that define any tetherable
3056 * USB network interfaces. If USB tethering is not supported by the
3057 * device, this list should be empty.
3058 *
3059 * @return an array of 0 or more regular expression Strings defining
3060 * what interfaces are considered tetherable usb interfaces.
3061 *
3062 * @deprecated Use {@link TetheringEventCallback#onTetherableInterfaceRegexpsChanged} instead.
3063 * {@hide}
3064 */
3065 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
3066 @UnsupportedAppUsage
3067 @Deprecated
3068 public String[] getTetherableUsbRegexs() {
Remi NGUYEN VANe4d1cd92021-06-17 16:27:31 +09003069 return getTetheringManager().getTetherableUsbRegexs();
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003070 }
3071
3072 /**
3073 * Get the list of regular expressions that define any tetherable
3074 * Wifi network interfaces. If Wifi tethering is not supported by the
3075 * device, this list should be empty.
3076 *
3077 * @return an array of 0 or more regular expression Strings defining
3078 * what interfaces are considered tetherable wifi interfaces.
3079 *
3080 * @deprecated Use {@link TetheringEventCallback#onTetherableInterfaceRegexpsChanged} instead.
3081 * {@hide}
3082 */
3083 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
3084 @UnsupportedAppUsage
3085 @Deprecated
3086 public String[] getTetherableWifiRegexs() {
Remi NGUYEN VANe4d1cd92021-06-17 16:27:31 +09003087 return getTetheringManager().getTetherableWifiRegexs();
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003088 }
3089
3090 /**
3091 * Get the list of regular expressions that define any tetherable
3092 * Bluetooth network interfaces. If Bluetooth tethering is not supported by the
3093 * device, this list should be empty.
3094 *
3095 * @return an array of 0 or more regular expression Strings defining
3096 * what interfaces are considered tetherable bluetooth interfaces.
3097 *
3098 * @deprecated Use {@link TetheringEventCallback#onTetherableInterfaceRegexpsChanged(
3099 *TetheringManager.TetheringInterfaceRegexps)} instead.
3100 * {@hide}
3101 */
3102 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
3103 @UnsupportedAppUsage
3104 @Deprecated
3105 public String[] getTetherableBluetoothRegexs() {
Remi NGUYEN VANe4d1cd92021-06-17 16:27:31 +09003106 return getTetheringManager().getTetherableBluetoothRegexs();
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003107 }
3108
3109 /**
3110 * Attempt to both alter the mode of USB and Tethering of USB. A
3111 * utility method to deal with some of the complexity of USB - will
3112 * attempt to switch to Rndis and subsequently tether the resulting
3113 * interface on {@code true} or turn off tethering and switch off
3114 * Rndis on {@code false}.
3115 *
3116 * <p>This method requires the caller to hold either the
3117 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
3118 * or the ability to modify system settings as determined by
3119 * {@link android.provider.Settings.System#canWrite}.</p>
3120 *
3121 * @param enable a boolean - {@code true} to enable tethering
3122 * @return error a {@code TETHER_ERROR} value indicating success or failure type
3123 * @deprecated Use {@link TetheringManager#startTethering} instead
3124 *
3125 * {@hide}
3126 */
3127 @UnsupportedAppUsage
3128 @Deprecated
3129 public int setUsbTethering(boolean enable) {
Remi NGUYEN VANe4d1cd92021-06-17 16:27:31 +09003130 return getTetheringManager().setUsbTethering(enable);
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003131 }
3132
3133 /**
3134 * @deprecated Use {@link TetheringManager#TETHER_ERROR_NO_ERROR}.
3135 * {@hide}
3136 */
3137 @SystemApi
3138 @Deprecated
Remi NGUYEN VAN71ced8e2021-02-15 18:52:06 +09003139 public static final int TETHER_ERROR_NO_ERROR = 0;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003140 /**
3141 * @deprecated Use {@link TetheringManager#TETHER_ERROR_UNKNOWN_IFACE}.
3142 * {@hide}
3143 */
3144 @Deprecated
3145 public static final int TETHER_ERROR_UNKNOWN_IFACE =
3146 TetheringManager.TETHER_ERROR_UNKNOWN_IFACE;
3147 /**
3148 * @deprecated Use {@link TetheringManager#TETHER_ERROR_SERVICE_UNAVAIL}.
3149 * {@hide}
3150 */
3151 @Deprecated
3152 public static final int TETHER_ERROR_SERVICE_UNAVAIL =
3153 TetheringManager.TETHER_ERROR_SERVICE_UNAVAIL;
3154 /**
3155 * @deprecated Use {@link TetheringManager#TETHER_ERROR_UNSUPPORTED}.
3156 * {@hide}
3157 */
3158 @Deprecated
3159 public static final int TETHER_ERROR_UNSUPPORTED = TetheringManager.TETHER_ERROR_UNSUPPORTED;
3160 /**
3161 * @deprecated Use {@link TetheringManager#TETHER_ERROR_UNAVAIL_IFACE}.
3162 * {@hide}
3163 */
3164 @Deprecated
3165 public static final int TETHER_ERROR_UNAVAIL_IFACE =
3166 TetheringManager.TETHER_ERROR_UNAVAIL_IFACE;
3167 /**
3168 * @deprecated Use {@link TetheringManager#TETHER_ERROR_INTERNAL_ERROR}.
3169 * {@hide}
3170 */
3171 @Deprecated
3172 public static final int TETHER_ERROR_MASTER_ERROR =
3173 TetheringManager.TETHER_ERROR_INTERNAL_ERROR;
3174 /**
3175 * @deprecated Use {@link TetheringManager#TETHER_ERROR_TETHER_IFACE_ERROR}.
3176 * {@hide}
3177 */
3178 @Deprecated
3179 public static final int TETHER_ERROR_TETHER_IFACE_ERROR =
3180 TetheringManager.TETHER_ERROR_TETHER_IFACE_ERROR;
3181 /**
3182 * @deprecated Use {@link TetheringManager#TETHER_ERROR_UNTETHER_IFACE_ERROR}.
3183 * {@hide}
3184 */
3185 @Deprecated
3186 public static final int TETHER_ERROR_UNTETHER_IFACE_ERROR =
3187 TetheringManager.TETHER_ERROR_UNTETHER_IFACE_ERROR;
3188 /**
3189 * @deprecated Use {@link TetheringManager#TETHER_ERROR_ENABLE_FORWARDING_ERROR}.
3190 * {@hide}
3191 */
3192 @Deprecated
3193 public static final int TETHER_ERROR_ENABLE_NAT_ERROR =
3194 TetheringManager.TETHER_ERROR_ENABLE_FORWARDING_ERROR;
3195 /**
3196 * @deprecated Use {@link TetheringManager#TETHER_ERROR_DISABLE_FORWARDING_ERROR}.
3197 * {@hide}
3198 */
3199 @Deprecated
3200 public static final int TETHER_ERROR_DISABLE_NAT_ERROR =
3201 TetheringManager.TETHER_ERROR_DISABLE_FORWARDING_ERROR;
3202 /**
3203 * @deprecated Use {@link TetheringManager#TETHER_ERROR_IFACE_CFG_ERROR}.
3204 * {@hide}
3205 */
3206 @Deprecated
3207 public static final int TETHER_ERROR_IFACE_CFG_ERROR =
3208 TetheringManager.TETHER_ERROR_IFACE_CFG_ERROR;
3209 /**
3210 * @deprecated Use {@link TetheringManager#TETHER_ERROR_PROVISIONING_FAILED}.
3211 * {@hide}
3212 */
3213 @SystemApi
3214 @Deprecated
Remi NGUYEN VAN71ced8e2021-02-15 18:52:06 +09003215 public static final int TETHER_ERROR_PROVISION_FAILED = 11;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003216 /**
3217 * @deprecated Use {@link TetheringManager#TETHER_ERROR_DHCPSERVER_ERROR}.
3218 * {@hide}
3219 */
3220 @Deprecated
3221 public static final int TETHER_ERROR_DHCPSERVER_ERROR =
3222 TetheringManager.TETHER_ERROR_DHCPSERVER_ERROR;
3223 /**
3224 * @deprecated Use {@link TetheringManager#TETHER_ERROR_ENTITLEMENT_UNKNOWN}.
3225 * {@hide}
3226 */
3227 @SystemApi
3228 @Deprecated
Remi NGUYEN VAN71ced8e2021-02-15 18:52:06 +09003229 public static final int TETHER_ERROR_ENTITLEMENT_UNKONWN = 13;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003230
3231 /**
3232 * Get a more detailed error code after a Tethering or Untethering
3233 * request asynchronously failed.
3234 *
3235 * @param iface The name of the interface of interest
3236 * @return error The error code of the last error tethering or untethering the named
3237 * interface
3238 *
3239 * @deprecated Use {@link TetheringEventCallback#onError(String, int)} instead.
3240 * {@hide}
3241 */
3242 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
3243 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
3244 @Deprecated
3245 public int getLastTetherError(String iface) {
Remi NGUYEN VANe4d1cd92021-06-17 16:27:31 +09003246 int error = getTetheringManager().getLastTetherError(iface);
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003247 if (error == TetheringManager.TETHER_ERROR_UNKNOWN_TYPE) {
3248 // TETHER_ERROR_UNKNOWN_TYPE was introduced with TetheringManager and has never been
3249 // returned by ConnectivityManager. Convert it to the legacy TETHER_ERROR_UNKNOWN_IFACE
3250 // instead.
3251 error = TetheringManager.TETHER_ERROR_UNKNOWN_IFACE;
3252 }
3253 return error;
3254 }
3255
3256 /** @hide */
3257 @Retention(RetentionPolicy.SOURCE)
3258 @IntDef(value = {
3259 TETHER_ERROR_NO_ERROR,
3260 TETHER_ERROR_PROVISION_FAILED,
3261 TETHER_ERROR_ENTITLEMENT_UNKONWN,
3262 })
3263 public @interface EntitlementResultCode {
3264 }
3265
3266 /**
3267 * Callback for use with {@link #getLatestTetheringEntitlementResult} to find out whether
3268 * entitlement succeeded.
3269 *
3270 * @deprecated Use {@link TetheringManager#OnTetheringEntitlementResultListener} instead.
3271 * @hide
3272 */
3273 @SystemApi
3274 @Deprecated
3275 public interface OnTetheringEntitlementResultListener {
3276 /**
3277 * Called to notify entitlement result.
3278 *
3279 * @param resultCode an int value of entitlement result. It may be one of
3280 * {@link #TETHER_ERROR_NO_ERROR},
3281 * {@link #TETHER_ERROR_PROVISION_FAILED}, or
3282 * {@link #TETHER_ERROR_ENTITLEMENT_UNKONWN}.
3283 */
3284 void onTetheringEntitlementResult(@EntitlementResultCode int resultCode);
3285 }
3286
3287 /**
3288 * Get the last value of the entitlement check on this downstream. If the cached value is
Chalard Jean0c7ebe92022-08-03 14:45:47 +09003289 * {@link #TETHER_ERROR_NO_ERROR} or showEntitlementUi argument is false, this just returns the
3290 * cached value. Otherwise, a UI-based entitlement check will be performed. It is not
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003291 * guaranteed that the UI-based entitlement check will complete in any specific time period
Chalard Jean0c7ebe92022-08-03 14:45:47 +09003292 * and it may in fact never complete. Any successful entitlement check the platform performs for
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003293 * any reason will update the cached value.
3294 *
3295 * @param type the downstream type of tethering. Must be one of
3296 * {@link #TETHERING_WIFI},
3297 * {@link #TETHERING_USB}, or
3298 * {@link #TETHERING_BLUETOOTH}.
3299 * @param showEntitlementUi a boolean indicating whether to run UI-based entitlement check.
3300 * @param executor the executor on which callback will be invoked.
3301 * @param listener an {@link OnTetheringEntitlementResultListener} which will be called to
3302 * notify the caller of the result of entitlement check. The listener may be called zero
3303 * or one time.
3304 * @deprecated Use {@link TetheringManager#requestLatestTetheringEntitlementResult} instead.
3305 * {@hide}
3306 */
3307 @SystemApi
3308 @Deprecated
3309 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
3310 public void getLatestTetheringEntitlementResult(int type, boolean showEntitlementUi,
3311 @NonNull @CallbackExecutor Executor executor,
3312 @NonNull final OnTetheringEntitlementResultListener listener) {
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00003313 Objects.requireNonNull(listener, "TetheringEntitlementResultListener cannot be null.");
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003314 ResultReceiver wrappedListener = new ResultReceiver(null) {
3315 @Override
3316 protected void onReceiveResult(int resultCode, Bundle resultData) {
lucaslineaff72d2021-03-04 09:38:21 +08003317 final long token = Binder.clearCallingIdentity();
3318 try {
3319 executor.execute(() -> {
3320 listener.onTetheringEntitlementResult(resultCode);
3321 });
3322 } finally {
3323 Binder.restoreCallingIdentity(token);
3324 }
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003325 }
3326 };
3327
Remi NGUYEN VANe4d1cd92021-06-17 16:27:31 +09003328 getTetheringManager().requestLatestTetheringEntitlementResult(type, wrappedListener,
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003329 showEntitlementUi);
3330 }
3331
3332 /**
3333 * Report network connectivity status. This is currently used only
3334 * to alter status bar UI.
3335 * <p>This method requires the caller to hold the permission
3336 * {@link android.Manifest.permission#STATUS_BAR}.
3337 *
3338 * @param networkType The type of network you want to report on
3339 * @param percentage The quality of the connection 0 is bad, 100 is good
3340 * @deprecated Types are deprecated. Use {@link #reportNetworkConnectivity} instead.
3341 * {@hide}
3342 */
3343 public void reportInetCondition(int networkType, int percentage) {
3344 printStackTrace();
3345 try {
3346 mService.reportInetCondition(networkType, percentage);
3347 } catch (RemoteException e) {
3348 throw e.rethrowFromSystemServer();
3349 }
3350 }
3351
3352 /**
3353 * Report a problem network to the framework. This provides a hint to the system
3354 * that there might be connectivity problems on this network and may cause
3355 * the framework to re-evaluate network connectivity and/or switch to another
3356 * network.
3357 *
3358 * @param network The {@link Network} the application was attempting to use
3359 * or {@code null} to indicate the current default network.
3360 * @deprecated Use {@link #reportNetworkConnectivity} which allows reporting both
3361 * working and non-working connectivity.
3362 */
3363 @Deprecated
3364 public void reportBadNetwork(@Nullable Network network) {
3365 printStackTrace();
3366 try {
3367 // One of these will be ignored because it matches system's current state.
3368 // The other will trigger the necessary reevaluation.
3369 mService.reportNetworkConnectivity(network, true);
3370 mService.reportNetworkConnectivity(network, false);
3371 } catch (RemoteException e) {
3372 throw e.rethrowFromSystemServer();
3373 }
3374 }
3375
3376 /**
3377 * Report to the framework whether a network has working connectivity.
3378 * This provides a hint to the system that a particular network is providing
3379 * working connectivity or not. In response the framework may re-evaluate
3380 * the network's connectivity and might take further action thereafter.
3381 *
3382 * @param network The {@link Network} the application was attempting to use
3383 * or {@code null} to indicate the current default network.
3384 * @param hasConnectivity {@code true} if the application was able to successfully access the
3385 * Internet using {@code network} or {@code false} if not.
3386 */
3387 public void reportNetworkConnectivity(@Nullable Network network, boolean hasConnectivity) {
3388 printStackTrace();
3389 try {
3390 mService.reportNetworkConnectivity(network, hasConnectivity);
3391 } catch (RemoteException e) {
3392 throw e.rethrowFromSystemServer();
3393 }
3394 }
3395
3396 /**
Chalard Jeane1ce6ae2021-03-17 17:03:34 +09003397 * Set a network-independent global HTTP proxy.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003398 *
Chalard Jeane1ce6ae2021-03-17 17:03:34 +09003399 * This sets an HTTP proxy that applies to all networks and overrides any network-specific
3400 * proxy. If set, HTTP libraries that are proxy-aware will use this global proxy when
3401 * accessing any network, regardless of what the settings for that network are.
3402 *
3403 * Note that HTTP proxies are by nature typically network-dependent, and setting a global
3404 * proxy is likely to break networking on multiple networks. This method is only meant
3405 * for device policy clients looking to do general internal filtering or similar use cases.
3406 *
chiachangwang9473c592022-07-15 02:25:52 +00003407 * @see #getGlobalProxy
3408 * @see LinkProperties#getHttpProxy
Chalard Jeane1ce6ae2021-03-17 17:03:34 +09003409 *
3410 * @param p A {@link ProxyInfo} object defining the new global HTTP proxy. Calling this
3411 * method with a {@code null} value will clear the global HTTP proxy.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003412 * @hide
3413 */
Chalard Jeane1ce6ae2021-03-17 17:03:34 +09003414 // Used by Device Policy Manager to set the global proxy.
Chiachang Wangf9294e72021-03-18 09:44:34 +08003415 @SystemApi(client = MODULE_LIBRARIES)
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003416 @RequiresPermission(android.Manifest.permission.NETWORK_STACK)
Chalard Jeane1ce6ae2021-03-17 17:03:34 +09003417 public void setGlobalProxy(@Nullable final ProxyInfo p) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003418 try {
3419 mService.setGlobalProxy(p);
3420 } catch (RemoteException e) {
3421 throw e.rethrowFromSystemServer();
3422 }
3423 }
3424
3425 /**
3426 * Retrieve any network-independent global HTTP proxy.
3427 *
3428 * @return {@link ProxyInfo} for the current global HTTP proxy or {@code null}
3429 * if no global HTTP proxy is set.
3430 * @hide
3431 */
Chiachang Wangf9294e72021-03-18 09:44:34 +08003432 @SystemApi(client = MODULE_LIBRARIES)
3433 @Nullable
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003434 public ProxyInfo getGlobalProxy() {
3435 try {
3436 return mService.getGlobalProxy();
3437 } catch (RemoteException e) {
3438 throw e.rethrowFromSystemServer();
3439 }
3440 }
3441
3442 /**
3443 * Retrieve the global HTTP proxy, or if no global HTTP proxy is set, a
3444 * network-specific HTTP proxy. If {@code network} is null, the
3445 * network-specific proxy returned is the proxy of the default active
3446 * network.
3447 *
3448 * @return {@link ProxyInfo} for the current global HTTP proxy, or if no
3449 * global HTTP proxy is set, {@code ProxyInfo} for {@code network},
3450 * or when {@code network} is {@code null},
3451 * the {@code ProxyInfo} for the default active network. Returns
3452 * {@code null} when no proxy applies or the caller doesn't have
3453 * permission to use {@code network}.
3454 * @hide
3455 */
3456 public ProxyInfo getProxyForNetwork(Network network) {
3457 try {
3458 return mService.getProxyForNetwork(network);
3459 } catch (RemoteException e) {
3460 throw e.rethrowFromSystemServer();
3461 }
3462 }
3463
3464 /**
3465 * Get the current default HTTP proxy settings. If a global proxy is set it will be returned,
3466 * otherwise if this process is bound to a {@link Network} using
3467 * {@link #bindProcessToNetwork} then that {@code Network}'s proxy is returned, otherwise
3468 * the default network's proxy is returned.
3469 *
3470 * @return the {@link ProxyInfo} for the current HTTP proxy, or {@code null} if no
3471 * HTTP proxy is active.
3472 */
3473 @Nullable
3474 public ProxyInfo getDefaultProxy() {
3475 return getProxyForNetwork(getBoundNetworkForProcess());
3476 }
3477
3478 /**
Chalard Jean0c7ebe92022-08-03 14:45:47 +09003479 * Returns whether the hardware supports the given network type.
3480 *
3481 * This doesn't indicate there is coverage or such a network is available, just whether the
3482 * hardware supports it. For example a GSM phone without a SIM card will return {@code true}
3483 * for mobile data, but a WiFi only tablet would return {@code false}.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003484 *
3485 * @param networkType The network type we'd like to check
3486 * @return {@code true} if supported, else {@code false}
3487 * @deprecated Types are deprecated. Use {@link NetworkCapabilities} instead.
3488 * @hide
3489 */
3490 @Deprecated
3491 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
3492 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 130143562)
3493 public boolean isNetworkSupported(int networkType) {
3494 try {
3495 return mService.isNetworkSupported(networkType);
3496 } catch (RemoteException e) {
3497 throw e.rethrowFromSystemServer();
3498 }
3499 }
3500
3501 /**
3502 * Returns if the currently active data network is metered. A network is
3503 * classified as metered when the user is sensitive to heavy data usage on
3504 * that connection due to monetary costs, data limitations or
3505 * battery/performance issues. You should check this before doing large
3506 * data transfers, and warn the user or delay the operation until another
3507 * network is available.
3508 *
3509 * @return {@code true} if large transfers should be avoided, otherwise
3510 * {@code false}.
3511 */
3512 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
3513 public boolean isActiveNetworkMetered() {
3514 try {
3515 return mService.isActiveNetworkMetered();
3516 } catch (RemoteException e) {
3517 throw e.rethrowFromSystemServer();
3518 }
3519 }
3520
3521 /**
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003522 * Set sign in error notification to visible or invisible
3523 *
3524 * @hide
3525 * @deprecated Doesn't properly deal with multiple connected networks of the same type.
3526 */
3527 @Deprecated
3528 public void setProvisioningNotificationVisible(boolean visible, int networkType,
3529 String action) {
3530 try {
3531 mService.setProvisioningNotificationVisible(visible, networkType, action);
3532 } catch (RemoteException e) {
3533 throw e.rethrowFromSystemServer();
3534 }
3535 }
3536
3537 /**
3538 * Set the value for enabling/disabling airplane mode
3539 *
3540 * @param enable whether to enable airplane mode or not
3541 *
3542 * @hide
3543 */
3544 @RequiresPermission(anyOf = {
3545 android.Manifest.permission.NETWORK_AIRPLANE_MODE,
3546 android.Manifest.permission.NETWORK_SETTINGS,
3547 android.Manifest.permission.NETWORK_SETUP_WIZARD,
3548 android.Manifest.permission.NETWORK_STACK})
3549 @SystemApi
3550 public void setAirplaneMode(boolean enable) {
3551 try {
3552 mService.setAirplaneMode(enable);
3553 } catch (RemoteException e) {
3554 throw e.rethrowFromSystemServer();
3555 }
3556 }
3557
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003558 /**
3559 * Registers the specified {@link NetworkProvider}.
3560 * Each listener must only be registered once. The listener can be unregistered with
3561 * {@link #unregisterNetworkProvider}.
3562 *
3563 * @param provider the provider to register
3564 * @return the ID of the provider. This ID must be used by the provider when registering
3565 * {@link android.net.NetworkAgent}s.
3566 * @hide
3567 */
3568 @SystemApi
3569 @RequiresPermission(anyOf = {
3570 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
3571 android.Manifest.permission.NETWORK_FACTORY})
3572 public int registerNetworkProvider(@NonNull NetworkProvider provider) {
3573 if (provider.getProviderId() != NetworkProvider.ID_NONE) {
3574 throw new IllegalStateException("NetworkProviders can only be registered once");
3575 }
3576
3577 try {
3578 int providerId = mService.registerNetworkProvider(provider.getMessenger(),
3579 provider.getName());
3580 provider.setProviderId(providerId);
3581 } catch (RemoteException e) {
3582 throw e.rethrowFromSystemServer();
3583 }
3584 return provider.getProviderId();
3585 }
3586
3587 /**
3588 * Unregisters the specified NetworkProvider.
3589 *
3590 * @param provider the provider to unregister
3591 * @hide
3592 */
3593 @SystemApi
3594 @RequiresPermission(anyOf = {
3595 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
3596 android.Manifest.permission.NETWORK_FACTORY})
3597 public void unregisterNetworkProvider(@NonNull NetworkProvider provider) {
3598 try {
3599 mService.unregisterNetworkProvider(provider.getMessenger());
3600 } catch (RemoteException e) {
3601 throw e.rethrowFromSystemServer();
3602 }
3603 provider.setProviderId(NetworkProvider.ID_NONE);
3604 }
3605
Chalard Jeand1b498b2021-01-05 08:40:09 +09003606 /**
3607 * Register or update a network offer with ConnectivityService.
3608 *
3609 * ConnectivityService keeps track of offers made by the various providers and matches
Chalard Jean61e231f2021-03-24 17:43:10 +09003610 * them to networking requests made by apps or the system. A callback identifies an offer
3611 * uniquely, and later calls with the same callback update the offer. The provider supplies a
3612 * score and the capabilities of the network it might be able to bring up ; these act as
3613 * filters used by ConnectivityService to only send those requests that can be fulfilled by the
Chalard Jeand1b498b2021-01-05 08:40:09 +09003614 * provider.
3615 *
3616 * The provider is under no obligation to be able to bring up the network it offers at any
3617 * given time. Instead, this mechanism is meant to limit requests received by providers
3618 * to those they actually have a chance to fulfill, as providers don't have a way to compare
3619 * the quality of the network satisfying a given request to their own offer.
3620 *
3621 * An offer can be updated by calling this again with the same callback object. This is
3622 * similar to calling unofferNetwork and offerNetwork again, but will only update the
3623 * provider with the changes caused by the changes in the offer.
3624 *
3625 * @param provider The provider making this offer.
3626 * @param score The prospective score of the network.
3627 * @param caps The prospective capabilities of the network.
3628 * @param callback The callback to call when this offer is needed or unneeded.
Chalard Jean428b9132021-01-12 10:58:56 +09003629 * @hide exposed via the NetworkProvider class.
Chalard Jeand1b498b2021-01-05 08:40:09 +09003630 */
3631 @RequiresPermission(anyOf = {
3632 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
3633 android.Manifest.permission.NETWORK_FACTORY})
Chalard Jean148dcce2021-03-22 22:44:02 +09003634 public void offerNetwork(@NonNull final int providerId,
Chalard Jeand1b498b2021-01-05 08:40:09 +09003635 @NonNull final NetworkScore score, @NonNull final NetworkCapabilities caps,
3636 @NonNull final INetworkOfferCallback callback) {
3637 try {
Chalard Jean148dcce2021-03-22 22:44:02 +09003638 mService.offerNetwork(providerId,
Chalard Jeand1b498b2021-01-05 08:40:09 +09003639 Objects.requireNonNull(score, "null score"),
3640 Objects.requireNonNull(caps, "null caps"),
3641 Objects.requireNonNull(callback, "null callback"));
3642 } catch (RemoteException e) {
3643 throw e.rethrowFromSystemServer();
3644 }
3645 }
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003646
Chalard Jeand1b498b2021-01-05 08:40:09 +09003647 /**
3648 * Withdraw a network offer made with {@link #offerNetwork}.
3649 *
3650 * @param callback The callback passed at registration time. This must be the same object
3651 * that was passed to {@link #offerNetwork}
Chalard Jean428b9132021-01-12 10:58:56 +09003652 * @hide exposed via the NetworkProvider class.
Chalard Jeand1b498b2021-01-05 08:40:09 +09003653 */
3654 public void unofferNetwork(@NonNull final INetworkOfferCallback callback) {
3655 try {
3656 mService.unofferNetwork(Objects.requireNonNull(callback));
3657 } catch (RemoteException e) {
3658 throw e.rethrowFromSystemServer();
3659 }
3660 }
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003661 /** @hide exposed via the NetworkProvider class. */
3662 @RequiresPermission(anyOf = {
3663 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
3664 android.Manifest.permission.NETWORK_FACTORY})
3665 public void declareNetworkRequestUnfulfillable(@NonNull NetworkRequest request) {
3666 try {
3667 mService.declareNetworkRequestUnfulfillable(request);
3668 } catch (RemoteException e) {
3669 throw e.rethrowFromSystemServer();
3670 }
3671 }
3672
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003673 /**
3674 * @hide
3675 * Register a NetworkAgent with ConnectivityService.
3676 * @return Network corresponding to NetworkAgent.
3677 */
3678 @RequiresPermission(anyOf = {
3679 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
3680 android.Manifest.permission.NETWORK_FACTORY})
3681 public Network registerNetworkAgent(INetworkAgent na, NetworkInfo ni, LinkProperties lp,
Chalard Jeand6372722020-12-21 18:36:52 +09003682 NetworkCapabilities nc, @NonNull NetworkScore score, NetworkAgentConfig config,
3683 int providerId) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003684 try {
3685 return mService.registerNetworkAgent(na, ni, lp, nc, score, config, providerId);
3686 } catch (RemoteException e) {
3687 throw e.rethrowFromSystemServer();
3688 }
3689 }
3690
3691 /**
3692 * Base class for {@code NetworkRequest} callbacks. Used for notifications about network
3693 * changes. Should be extended by applications wanting notifications.
3694 *
3695 * A {@code NetworkCallback} is registered by calling
3696 * {@link #requestNetwork(NetworkRequest, NetworkCallback)},
3697 * {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)},
3698 * or {@link #registerDefaultNetworkCallback(NetworkCallback)}. A {@code NetworkCallback} is
3699 * unregistered by calling {@link #unregisterNetworkCallback(NetworkCallback)}.
3700 * A {@code NetworkCallback} should be registered at most once at any time.
3701 * A {@code NetworkCallback} that has been unregistered can be registered again.
3702 */
3703 public static class NetworkCallback {
3704 /**
Roshan Piuse08bc182020-12-22 15:10:42 -08003705 * No flags associated with this callback.
3706 * @hide
3707 */
3708 public static final int FLAG_NONE = 0;
lucaslinc582d502022-01-27 09:07:00 +08003709
Roshan Piuse08bc182020-12-22 15:10:42 -08003710 /**
lucaslinc582d502022-01-27 09:07:00 +08003711 * Inclusion of this flag means location-sensitive redaction requests keeping location info.
3712 *
3713 * Some objects like {@link NetworkCapabilities} may contain location-sensitive information.
3714 * Prior to Android 12, this information is always returned to apps holding the appropriate
3715 * permission, possibly noting that the app has used location.
3716 * <p>In Android 12 and above, by default the sent objects do not contain any location
3717 * information, even if the app holds the necessary permissions, and the system does not
3718 * take note of location usage by the app. Apps can request that location information is
3719 * included, in which case the system will check location permission and the location
3720 * toggle state, and take note of location usage by the app if any such information is
3721 * returned.
3722 *
Roshan Piuse08bc182020-12-22 15:10:42 -08003723 * Use this flag to include any location sensitive data in {@link NetworkCapabilities} sent
3724 * via {@link #onCapabilitiesChanged(Network, NetworkCapabilities)}.
3725 * <p>
3726 * These include:
3727 * <li> Some transport info instances (retrieved via
3728 * {@link NetworkCapabilities#getTransportInfo()}) like {@link android.net.wifi.WifiInfo}
3729 * contain location sensitive information.
3730 * <li> OwnerUid (retrieved via {@link NetworkCapabilities#getOwnerUid()} is location
Anton Hanssondf401092021-10-20 11:27:13 +01003731 * sensitive for wifi suggestor apps (i.e using
3732 * {@link android.net.wifi.WifiNetworkSuggestion WifiNetworkSuggestion}).</li>
Roshan Piuse08bc182020-12-22 15:10:42 -08003733 * </p>
3734 * <p>
3735 * Note:
3736 * <li> Retrieving this location sensitive information (subject to app's location
3737 * permissions) will be noted by system. </li>
3738 * <li> Without this flag any {@link NetworkCapabilities} provided via the callback does
lucaslinc582d502022-01-27 09:07:00 +08003739 * not include location sensitive information.
Roshan Piuse08bc182020-12-22 15:10:42 -08003740 */
Roshan Pius189d0092021-03-11 21:16:44 -08003741 // Note: Some existing fields which are location sensitive may still be included without
3742 // this flag if the app targets SDK < S (to maintain backwards compatibility).
Roshan Piuse08bc182020-12-22 15:10:42 -08003743 public static final int FLAG_INCLUDE_LOCATION_INFO = 1 << 0;
3744
3745 /** @hide */
3746 @Retention(RetentionPolicy.SOURCE)
3747 @IntDef(flag = true, prefix = "FLAG_", value = {
3748 FLAG_NONE,
3749 FLAG_INCLUDE_LOCATION_INFO
3750 })
3751 public @interface Flag { }
3752
3753 /**
3754 * All the valid flags for error checking.
3755 */
3756 private static final int VALID_FLAGS = FLAG_INCLUDE_LOCATION_INFO;
3757
3758 public NetworkCallback() {
3759 this(FLAG_NONE);
3760 }
3761
3762 public NetworkCallback(@Flag int flags) {
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00003763 if ((flags & VALID_FLAGS) != flags) {
3764 throw new IllegalArgumentException("Invalid flags");
3765 }
Roshan Piuse08bc182020-12-22 15:10:42 -08003766 mFlags = flags;
3767 }
3768
3769 /**
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003770 * Called when the framework connects to a new network to evaluate whether it satisfies this
3771 * request. If evaluation succeeds, this callback may be followed by an {@link #onAvailable}
3772 * callback. There is no guarantee that this new network will satisfy any requests, or that
3773 * the network will stay connected for longer than the time necessary to evaluate it.
3774 * <p>
3775 * Most applications <b>should not</b> act on this callback, and should instead use
3776 * {@link #onAvailable}. This callback is intended for use by applications that can assist
3777 * the framework in properly evaluating the network &mdash; for example, an application that
3778 * can automatically log in to a captive portal without user intervention.
3779 *
3780 * @param network The {@link Network} of the network that is being evaluated.
3781 *
3782 * @hide
3783 */
3784 public void onPreCheck(@NonNull Network network) {}
3785
3786 /**
3787 * Called when the framework connects and has declared a new network ready for use.
3788 * This callback may be called more than once if the {@link Network} that is
3789 * satisfying the request changes.
3790 *
3791 * @param network The {@link Network} of the satisfying network.
3792 * @param networkCapabilities The {@link NetworkCapabilities} of the satisfying network.
3793 * @param linkProperties The {@link LinkProperties} of the satisfying network.
3794 * @param blocked Whether access to the {@link Network} is blocked due to system policy.
3795 * @hide
3796 */
Lorenzo Colitti8ad58122021-03-18 00:54:57 +09003797 public final void onAvailable(@NonNull Network network,
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003798 @NonNull NetworkCapabilities networkCapabilities,
Lorenzo Colitti8ad58122021-03-18 00:54:57 +09003799 @NonNull LinkProperties linkProperties, @BlockedReason int blocked) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003800 // Internally only this method is called when a new network is available, and
3801 // it calls the callback in the same way and order that older versions used
3802 // to call so as not to change the behavior.
Lorenzo Colitti8ad58122021-03-18 00:54:57 +09003803 onAvailable(network, networkCapabilities, linkProperties, blocked != 0);
3804 onBlockedStatusChanged(network, blocked);
3805 }
3806
3807 /**
3808 * Legacy variant of onAvailable that takes a boolean blocked reason.
3809 *
3810 * This method has never been public API, but it's not final, so there may be apps that
3811 * implemented it and rely on it being called. Do our best not to break them.
3812 * Note: such apps will also get a second call to onBlockedStatusChanged immediately after
3813 * this method is called. There does not seem to be a way to avoid this.
3814 * TODO: add a compat check to move apps off this method, and eventually stop calling it.
3815 *
3816 * @hide
3817 */
3818 public void onAvailable(@NonNull Network network,
3819 @NonNull NetworkCapabilities networkCapabilities,
3820 @NonNull LinkProperties linkProperties, boolean blocked) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003821 onAvailable(network);
3822 if (!networkCapabilities.hasCapability(
3823 NetworkCapabilities.NET_CAPABILITY_NOT_SUSPENDED)) {
3824 onNetworkSuspended(network);
3825 }
3826 onCapabilitiesChanged(network, networkCapabilities);
3827 onLinkPropertiesChanged(network, linkProperties);
Lorenzo Colitti8ad58122021-03-18 00:54:57 +09003828 // No call to onBlockedStatusChanged here. That is done by the caller.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003829 }
3830
3831 /**
3832 * Called when the framework connects and has declared a new network ready for use.
3833 *
3834 * <p>For callbacks registered with {@link #registerNetworkCallback}, multiple networks may
3835 * be available at the same time, and onAvailable will be called for each of these as they
3836 * appear.
3837 *
3838 * <p>For callbacks registered with {@link #requestNetwork} and
3839 * {@link #registerDefaultNetworkCallback}, this means the network passed as an argument
3840 * is the new best network for this request and is now tracked by this callback ; this
3841 * callback will no longer receive method calls about other networks that may have been
3842 * passed to this method previously. The previously-best network may have disconnected, or
3843 * it may still be around and the newly-best network may simply be better.
3844 *
3845 * <p>Starting with {@link android.os.Build.VERSION_CODES#O}, this will always immediately
3846 * be followed by a call to {@link #onCapabilitiesChanged(Network, NetworkCapabilities)}
3847 * then by a call to {@link #onLinkPropertiesChanged(Network, LinkProperties)}, and a call
3848 * to {@link #onBlockedStatusChanged(Network, boolean)}.
3849 *
3850 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
3851 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
3852 * this callback as this is prone to race conditions (there is no guarantee the objects
3853 * returned by these methods will be current). Instead, wait for a call to
3854 * {@link #onCapabilitiesChanged(Network, NetworkCapabilities)} and
3855 * {@link #onLinkPropertiesChanged(Network, LinkProperties)} whose arguments are guaranteed
3856 * to be well-ordered with respect to other callbacks.
3857 *
3858 * @param network The {@link Network} of the satisfying network.
3859 */
3860 public void onAvailable(@NonNull Network network) {}
3861
3862 /**
3863 * Called when the network is about to be lost, typically because there are no outstanding
3864 * requests left for it. This may be paired with a {@link NetworkCallback#onAvailable} call
3865 * with the new replacement network for graceful handover. This method is not guaranteed
3866 * to be called before {@link NetworkCallback#onLost} is called, for example in case a
3867 * network is suddenly disconnected.
3868 *
3869 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
3870 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
3871 * this callback as this is prone to race conditions ; calling these methods while in a
3872 * callback may return an outdated or even a null object.
3873 *
3874 * @param network The {@link Network} that is about to be lost.
3875 * @param maxMsToLive The time in milliseconds the system intends to keep the network
3876 * connected for graceful handover; note that the network may still
3877 * suffer a hard loss at any time.
3878 */
3879 public void onLosing(@NonNull Network network, int maxMsToLive) {}
3880
3881 /**
3882 * Called when a network disconnects or otherwise no longer satisfies this request or
3883 * callback.
3884 *
3885 * <p>If the callback was registered with requestNetwork() or
3886 * registerDefaultNetworkCallback(), it will only be invoked against the last network
3887 * returned by onAvailable() when that network is lost and no other network satisfies
3888 * the criteria of the request.
3889 *
3890 * <p>If the callback was registered with registerNetworkCallback() it will be called for
3891 * each network which no longer satisfies the criteria of the callback.
3892 *
3893 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
3894 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
3895 * this callback as this is prone to race conditions ; calling these methods while in a
3896 * callback may return an outdated or even a null object.
3897 *
3898 * @param network The {@link Network} lost.
3899 */
3900 public void onLost(@NonNull Network network) {}
3901
3902 /**
3903 * Called if no network is found within the timeout time specified in
3904 * {@link #requestNetwork(NetworkRequest, NetworkCallback, int)} call or if the
3905 * requested network request cannot be fulfilled (whether or not a timeout was
3906 * specified). When this callback is invoked the associated
3907 * {@link NetworkRequest} will have already been removed and released, as if
3908 * {@link #unregisterNetworkCallback(NetworkCallback)} had been called.
3909 */
3910 public void onUnavailable() {}
3911
3912 /**
3913 * Called when the network corresponding to this request changes capabilities but still
3914 * satisfies the requested criteria.
3915 *
3916 * <p>Starting with {@link android.os.Build.VERSION_CODES#O} this method is guaranteed
3917 * to be called immediately after {@link #onAvailable}.
3918 *
3919 * <p>Do NOT call {@link #getLinkProperties(Network)} or other synchronous
3920 * ConnectivityManager methods in this callback as this is prone to race conditions :
3921 * calling these methods while in a callback may return an outdated or even a null object.
3922 *
3923 * @param network The {@link Network} whose capabilities have changed.
Roshan Piuse08bc182020-12-22 15:10:42 -08003924 * @param networkCapabilities The new {@link NetworkCapabilities} for this
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003925 * network.
3926 */
3927 public void onCapabilitiesChanged(@NonNull Network network,
3928 @NonNull NetworkCapabilities networkCapabilities) {}
3929
3930 /**
3931 * Called when the network corresponding to this request changes {@link LinkProperties}.
3932 *
3933 * <p>Starting with {@link android.os.Build.VERSION_CODES#O} this method is guaranteed
3934 * to be called immediately after {@link #onAvailable}.
3935 *
3936 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or other synchronous
3937 * ConnectivityManager methods in this callback as this is prone to race conditions :
3938 * calling these methods while in a callback may return an outdated or even a null object.
3939 *
3940 * @param network The {@link Network} whose link properties have changed.
3941 * @param linkProperties The new {@link LinkProperties} for this network.
3942 */
3943 public void onLinkPropertiesChanged(@NonNull Network network,
3944 @NonNull LinkProperties linkProperties) {}
3945
3946 /**
3947 * Called when the network the framework connected to for this request suspends data
3948 * transmission temporarily.
3949 *
3950 * <p>This generally means that while the TCP connections are still live temporarily
3951 * network data fails to transfer. To give a specific example, this is used on cellular
3952 * networks to mask temporary outages when driving through a tunnel, etc. In general this
3953 * means read operations on sockets on this network will block once the buffers are
3954 * drained, and write operations will block once the buffers are full.
3955 *
3956 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
3957 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
3958 * this callback as this is prone to race conditions (there is no guarantee the objects
3959 * returned by these methods will be current).
3960 *
3961 * @hide
3962 */
3963 public void onNetworkSuspended(@NonNull Network network) {}
3964
3965 /**
3966 * Called when the network the framework connected to for this request
3967 * returns from a {@link NetworkInfo.State#SUSPENDED} state. This should always be
3968 * preceded by a matching {@link NetworkCallback#onNetworkSuspended} call.
3969
3970 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
3971 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
3972 * this callback as this is prone to race conditions : calling these methods while in a
3973 * callback may return an outdated or even a null object.
3974 *
3975 * @hide
3976 */
3977 public void onNetworkResumed(@NonNull Network network) {}
3978
3979 /**
3980 * Called when access to the specified network is blocked or unblocked.
3981 *
3982 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
3983 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
3984 * this callback as this is prone to race conditions : calling these methods while in a
3985 * callback may return an outdated or even a null object.
3986 *
3987 * @param network The {@link Network} whose blocked status has changed.
3988 * @param blocked The blocked status of this {@link Network}.
3989 */
3990 public void onBlockedStatusChanged(@NonNull Network network, boolean blocked) {}
3991
Lorenzo Colitti8ad58122021-03-18 00:54:57 +09003992 /**
Lorenzo Colittia1bd6f62021-03-25 23:17:36 +09003993 * Called when access to the specified network is blocked or unblocked, or the reason for
3994 * access being blocked changes.
Lorenzo Colitti8ad58122021-03-18 00:54:57 +09003995 *
3996 * If a NetworkCallback object implements this method,
3997 * {@link #onBlockedStatusChanged(Network, boolean)} will not be called.
3998 *
3999 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
4000 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
4001 * this callback as this is prone to race conditions : calling these methods while in a
4002 * callback may return an outdated or even a null object.
4003 *
4004 * @param network The {@link Network} whose blocked status has changed.
4005 * @param blocked The blocked status of this {@link Network}.
4006 * @hide
4007 */
4008 @SystemApi(client = MODULE_LIBRARIES)
4009 public void onBlockedStatusChanged(@NonNull Network network, @BlockedReason int blocked) {
4010 onBlockedStatusChanged(network, blocked != 0);
4011 }
4012
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004013 private NetworkRequest networkRequest;
Roshan Piuse08bc182020-12-22 15:10:42 -08004014 private final int mFlags;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004015 }
4016
4017 /**
4018 * Constant error codes used by ConnectivityService to communicate about failures and errors
4019 * across a Binder boundary.
4020 * @hide
4021 */
4022 public interface Errors {
4023 int TOO_MANY_REQUESTS = 1;
4024 }
4025
4026 /** @hide */
4027 public static class TooManyRequestsException extends RuntimeException {}
4028
4029 private static RuntimeException convertServiceException(ServiceSpecificException e) {
4030 switch (e.errorCode) {
4031 case Errors.TOO_MANY_REQUESTS:
4032 return new TooManyRequestsException();
4033 default:
4034 Log.w(TAG, "Unknown service error code " + e.errorCode);
4035 return new RuntimeException(e);
4036 }
4037 }
4038
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004039 /** @hide */
Remi NGUYEN VAN1b9f03a2021-03-12 15:24:06 +09004040 public static final int CALLBACK_PRECHECK = 1;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004041 /** @hide */
Remi NGUYEN VAN1b9f03a2021-03-12 15:24:06 +09004042 public static final int CALLBACK_AVAILABLE = 2;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004043 /** @hide arg1 = TTL */
Remi NGUYEN VAN1b9f03a2021-03-12 15:24:06 +09004044 public static final int CALLBACK_LOSING = 3;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004045 /** @hide */
Remi NGUYEN VAN1b9f03a2021-03-12 15:24:06 +09004046 public static final int CALLBACK_LOST = 4;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004047 /** @hide */
Remi NGUYEN VAN1b9f03a2021-03-12 15:24:06 +09004048 public static final int CALLBACK_UNAVAIL = 5;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004049 /** @hide */
Remi NGUYEN VAN1b9f03a2021-03-12 15:24:06 +09004050 public static final int CALLBACK_CAP_CHANGED = 6;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004051 /** @hide */
Remi NGUYEN VAN1b9f03a2021-03-12 15:24:06 +09004052 public static final int CALLBACK_IP_CHANGED = 7;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004053 /** @hide obj = NetworkCapabilities, arg1 = seq number */
Remi NGUYEN VAN1b9f03a2021-03-12 15:24:06 +09004054 private static final int EXPIRE_LEGACY_REQUEST = 8;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004055 /** @hide */
Remi NGUYEN VAN1b9f03a2021-03-12 15:24:06 +09004056 public static final int CALLBACK_SUSPENDED = 9;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004057 /** @hide */
Remi NGUYEN VAN1b9f03a2021-03-12 15:24:06 +09004058 public static final int CALLBACK_RESUMED = 10;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004059 /** @hide */
Remi NGUYEN VAN1b9f03a2021-03-12 15:24:06 +09004060 public static final int CALLBACK_BLK_CHANGED = 11;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004061
4062 /** @hide */
4063 public static String getCallbackName(int whichCallback) {
4064 switch (whichCallback) {
4065 case CALLBACK_PRECHECK: return "CALLBACK_PRECHECK";
4066 case CALLBACK_AVAILABLE: return "CALLBACK_AVAILABLE";
4067 case CALLBACK_LOSING: return "CALLBACK_LOSING";
4068 case CALLBACK_LOST: return "CALLBACK_LOST";
4069 case CALLBACK_UNAVAIL: return "CALLBACK_UNAVAIL";
4070 case CALLBACK_CAP_CHANGED: return "CALLBACK_CAP_CHANGED";
4071 case CALLBACK_IP_CHANGED: return "CALLBACK_IP_CHANGED";
4072 case EXPIRE_LEGACY_REQUEST: return "EXPIRE_LEGACY_REQUEST";
4073 case CALLBACK_SUSPENDED: return "CALLBACK_SUSPENDED";
4074 case CALLBACK_RESUMED: return "CALLBACK_RESUMED";
4075 case CALLBACK_BLK_CHANGED: return "CALLBACK_BLK_CHANGED";
4076 default:
4077 return Integer.toString(whichCallback);
4078 }
4079 }
4080
4081 private class CallbackHandler extends Handler {
4082 private static final String TAG = "ConnectivityManager.CallbackHandler";
4083 private static final boolean DBG = false;
4084
4085 CallbackHandler(Looper looper) {
4086 super(looper);
4087 }
4088
4089 CallbackHandler(Handler handler) {
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00004090 this(Objects.requireNonNull(handler, "Handler cannot be null.").getLooper());
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004091 }
4092
4093 @Override
4094 public void handleMessage(Message message) {
4095 if (message.what == EXPIRE_LEGACY_REQUEST) {
4096 expireRequest((NetworkCapabilities) message.obj, message.arg1);
4097 return;
4098 }
4099
4100 final NetworkRequest request = getObject(message, NetworkRequest.class);
4101 final Network network = getObject(message, Network.class);
4102 final NetworkCallback callback;
4103 synchronized (sCallbacks) {
4104 callback = sCallbacks.get(request);
4105 if (callback == null) {
4106 Log.w(TAG,
4107 "callback not found for " + getCallbackName(message.what) + " message");
4108 return;
4109 }
4110 if (message.what == CALLBACK_UNAVAIL) {
4111 sCallbacks.remove(request);
4112 callback.networkRequest = ALREADY_UNREGISTERED;
4113 }
4114 }
4115 if (DBG) {
4116 Log.d(TAG, getCallbackName(message.what) + " for network " + network);
4117 }
4118
4119 switch (message.what) {
4120 case CALLBACK_PRECHECK: {
4121 callback.onPreCheck(network);
4122 break;
4123 }
4124 case CALLBACK_AVAILABLE: {
4125 NetworkCapabilities cap = getObject(message, NetworkCapabilities.class);
4126 LinkProperties lp = getObject(message, LinkProperties.class);
Lorenzo Colitti8ad58122021-03-18 00:54:57 +09004127 callback.onAvailable(network, cap, lp, message.arg1);
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004128 break;
4129 }
4130 case CALLBACK_LOSING: {
4131 callback.onLosing(network, message.arg1);
4132 break;
4133 }
4134 case CALLBACK_LOST: {
4135 callback.onLost(network);
4136 break;
4137 }
4138 case CALLBACK_UNAVAIL: {
4139 callback.onUnavailable();
4140 break;
4141 }
4142 case CALLBACK_CAP_CHANGED: {
4143 NetworkCapabilities cap = getObject(message, NetworkCapabilities.class);
4144 callback.onCapabilitiesChanged(network, cap);
4145 break;
4146 }
4147 case CALLBACK_IP_CHANGED: {
4148 LinkProperties lp = getObject(message, LinkProperties.class);
4149 callback.onLinkPropertiesChanged(network, lp);
4150 break;
4151 }
4152 case CALLBACK_SUSPENDED: {
4153 callback.onNetworkSuspended(network);
4154 break;
4155 }
4156 case CALLBACK_RESUMED: {
4157 callback.onNetworkResumed(network);
4158 break;
4159 }
4160 case CALLBACK_BLK_CHANGED: {
Lorenzo Colitti8ad58122021-03-18 00:54:57 +09004161 callback.onBlockedStatusChanged(network, message.arg1);
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004162 }
4163 }
4164 }
4165
4166 private <T> T getObject(Message msg, Class<T> c) {
4167 return (T) msg.getData().getParcelable(c.getSimpleName());
4168 }
4169 }
4170
4171 private CallbackHandler getDefaultHandler() {
4172 synchronized (sCallbacks) {
4173 if (sCallbackHandler == null) {
4174 sCallbackHandler = new CallbackHandler(ConnectivityThread.getInstanceLooper());
4175 }
4176 return sCallbackHandler;
4177 }
4178 }
4179
4180 private static final HashMap<NetworkRequest, NetworkCallback> sCallbacks = new HashMap<>();
4181 private static CallbackHandler sCallbackHandler;
4182
Lorenzo Colitti5f26b192021-03-12 22:48:07 +09004183 private NetworkRequest sendRequestForNetwork(int asUid, NetworkCapabilities need,
4184 NetworkCallback callback, int timeoutMs, NetworkRequest.Type reqType, int legacyType,
4185 CallbackHandler handler) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004186 printStackTrace();
4187 checkCallbackNotNull(callback);
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00004188 if (reqType != TRACK_DEFAULT && reqType != TRACK_SYSTEM_DEFAULT && need == null) {
4189 throw new IllegalArgumentException("null NetworkCapabilities");
4190 }
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004191 final NetworkRequest request;
4192 final String callingPackageName = mContext.getOpPackageName();
4193 try {
4194 synchronized(sCallbacks) {
4195 if (callback.networkRequest != null
4196 && callback.networkRequest != ALREADY_UNREGISTERED) {
4197 // TODO: throw exception instead and enforce 1:1 mapping of callbacks
4198 // and requests (http://b/20701525).
4199 Log.e(TAG, "NetworkCallback was already registered");
4200 }
4201 Messenger messenger = new Messenger(handler);
4202 Binder binder = new Binder();
Roshan Piuse08bc182020-12-22 15:10:42 -08004203 final int callbackFlags = callback.mFlags;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004204 if (reqType == LISTEN) {
4205 request = mService.listenForNetwork(
Roshan Piuse08bc182020-12-22 15:10:42 -08004206 need, messenger, binder, callbackFlags, callingPackageName,
Roshan Piusa8a477b2020-12-17 14:53:09 -08004207 getAttributionTag());
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004208 } else {
4209 request = mService.requestNetwork(
Lorenzo Colitti5f26b192021-03-12 22:48:07 +09004210 asUid, need, reqType.ordinal(), messenger, timeoutMs, binder,
4211 legacyType, callbackFlags, callingPackageName, getAttributionTag());
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004212 }
4213 if (request != null) {
4214 sCallbacks.put(request, callback);
4215 }
4216 callback.networkRequest = request;
4217 }
4218 } catch (RemoteException e) {
4219 throw e.rethrowFromSystemServer();
4220 } catch (ServiceSpecificException e) {
4221 throw convertServiceException(e);
4222 }
4223 return request;
4224 }
4225
Lorenzo Colitti5f26b192021-03-12 22:48:07 +09004226 private NetworkRequest sendRequestForNetwork(NetworkCapabilities need, NetworkCallback callback,
4227 int timeoutMs, NetworkRequest.Type reqType, int legacyType, CallbackHandler handler) {
4228 return sendRequestForNetwork(Process.INVALID_UID, need, callback, timeoutMs, reqType,
4229 legacyType, handler);
4230 }
4231
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004232 /**
4233 * Helper function to request a network with a particular legacy type.
4234 *
4235 * This API is only for use in internal system code that requests networks with legacy type and
4236 * relies on CONNECTIVITY_ACTION broadcasts instead of NetworkCallbacks. New caller should use
4237 * {@link #requestNetwork(NetworkRequest, NetworkCallback, Handler)} instead.
4238 *
4239 * @param request {@link NetworkRequest} describing this request.
4240 * @param timeoutMs The time in milliseconds to attempt looking for a suitable network
4241 * before {@link NetworkCallback#onUnavailable()} is called. The timeout must
4242 * be a positive value (i.e. >0).
4243 * @param legacyType to specify the network type(#TYPE_*).
4244 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
4245 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
4246 * the callback must not be shared - it uniquely specifies this request.
4247 *
4248 * @hide
4249 */
4250 @SystemApi
4251 @RequiresPermission(NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK)
4252 public void requestNetwork(@NonNull NetworkRequest request,
4253 int timeoutMs, int legacyType, @NonNull Handler handler,
4254 @NonNull NetworkCallback networkCallback) {
4255 if (legacyType == TYPE_NONE) {
4256 throw new IllegalArgumentException("TYPE_NONE is meaningless legacy type");
4257 }
4258 CallbackHandler cbHandler = new CallbackHandler(handler);
4259 NetworkCapabilities nc = request.networkCapabilities;
4260 sendRequestForNetwork(nc, networkCallback, timeoutMs, REQUEST, legacyType, cbHandler);
4261 }
4262
4263 /**
Roshan Piuse08bc182020-12-22 15:10:42 -08004264 * Request a network to satisfy a set of {@link NetworkCapabilities}.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004265 *
4266 * <p>This method will attempt to find the best network that matches the passed
4267 * {@link NetworkRequest}, and to bring up one that does if none currently satisfies the
4268 * criteria. The platform will evaluate which network is the best at its own discretion.
4269 * Throughput, latency, cost per byte, policy, user preference and other considerations
4270 * may be factored in the decision of what is considered the best network.
4271 *
4272 * <p>As long as this request is outstanding, the platform will try to maintain the best network
4273 * matching this request, while always attempting to match the request to a better network if
4274 * possible. If a better match is found, the platform will switch this request to the now-best
4275 * network and inform the app of the newly best network by invoking
4276 * {@link NetworkCallback#onAvailable(Network)} on the provided callback. Note that the platform
4277 * will not try to maintain any other network than the best one currently matching the request:
4278 * a network not matching any network request may be disconnected at any time.
4279 *
4280 * <p>For example, an application could use this method to obtain a connected cellular network
4281 * even if the device currently has a data connection over Ethernet. This may cause the cellular
4282 * radio to consume additional power. Or, an application could inform the system that it wants
4283 * a network supporting sending MMSes and have the system let it know about the currently best
4284 * MMS-supporting network through the provided {@link NetworkCallback}.
4285 *
4286 * <p>The status of the request can be followed by listening to the various callbacks described
4287 * in {@link NetworkCallback}. The {@link Network} object passed to the callback methods can be
4288 * used to direct traffic to the network (although accessing some networks may be subject to
4289 * holding specific permissions). Callers will learn about the specific characteristics of the
4290 * network through
4291 * {@link NetworkCallback#onCapabilitiesChanged(Network, NetworkCapabilities)} and
4292 * {@link NetworkCallback#onLinkPropertiesChanged(Network, LinkProperties)}. The methods of the
4293 * provided {@link NetworkCallback} will only be invoked due to changes in the best network
4294 * matching the request at any given time; therefore when a better network matching the request
4295 * becomes available, the {@link NetworkCallback#onAvailable(Network)} method is called
4296 * with the new network after which no further updates are given about the previously-best
4297 * network, unless it becomes the best again at some later time. All callbacks are invoked
4298 * in order on the same thread, which by default is a thread created by the framework running
4299 * in the app.
chiachangwang9473c592022-07-15 02:25:52 +00004300 * See {@link #requestNetwork(NetworkRequest, NetworkCallback, Handler)} to change where the
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004301 * callbacks are invoked.
4302 *
4303 * <p>This{@link NetworkRequest} will live until released via
4304 * {@link #unregisterNetworkCallback(NetworkCallback)} or the calling application exits, at
4305 * which point the system may let go of the network at any time.
4306 *
4307 * <p>A version of this method which takes a timeout is
4308 * {@link #requestNetwork(NetworkRequest, NetworkCallback, int)}, that an app can use to only
4309 * wait for a limited amount of time for the network to become unavailable.
4310 *
4311 * <p>It is presently unsupported to request a network with mutable
4312 * {@link NetworkCapabilities} such as
4313 * {@link NetworkCapabilities#NET_CAPABILITY_VALIDATED} or
4314 * {@link NetworkCapabilities#NET_CAPABILITY_CAPTIVE_PORTAL}
4315 * as these {@code NetworkCapabilities} represent states that a particular
4316 * network may never attain, and whether a network will attain these states
4317 * is unknown prior to bringing up the network so the framework does not
4318 * know how to go about satisfying a request with these capabilities.
4319 *
4320 * <p>This method requires the caller to hold either the
4321 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
4322 * or the ability to modify system settings as determined by
4323 * {@link android.provider.Settings.System#canWrite}.</p>
4324 *
4325 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4326 * number of outstanding requests to 100 per app (identified by their UID), shared with
4327 * all variants of this method, of {@link #registerNetworkCallback} as well as
4328 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4329 * Requesting a network with this method will count toward this limit. If this limit is
4330 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4331 * make sure to unregister the callbacks with
4332 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4333 *
4334 * @param request {@link NetworkRequest} describing this request.
4335 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
4336 * the callback must not be shared - it uniquely specifies this request.
4337 * The callback is invoked on the default internal Handler.
4338 * @throws IllegalArgumentException if {@code request} contains invalid network capabilities.
4339 * @throws SecurityException if missing the appropriate permissions.
4340 * @throws RuntimeException if the app already has too many callbacks registered.
4341 */
4342 public void requestNetwork(@NonNull NetworkRequest request,
4343 @NonNull NetworkCallback networkCallback) {
4344 requestNetwork(request, networkCallback, getDefaultHandler());
4345 }
4346
4347 /**
Roshan Piuse08bc182020-12-22 15:10:42 -08004348 * Request a network to satisfy a set of {@link NetworkCapabilities}.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004349 *
4350 * This method behaves identically to {@link #requestNetwork(NetworkRequest, NetworkCallback)}
4351 * but runs all the callbacks on the passed Handler.
4352 *
4353 * <p>This method has the same permission requirements as
4354 * {@link #requestNetwork(NetworkRequest, NetworkCallback)}, is subject to the same limitations,
4355 * and throws the same exceptions in the same conditions.
4356 *
4357 * @param request {@link NetworkRequest} describing this request.
4358 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
4359 * the callback must not be shared - it uniquely specifies this request.
4360 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
4361 */
4362 public void requestNetwork(@NonNull NetworkRequest request,
4363 @NonNull NetworkCallback networkCallback, @NonNull Handler handler) {
4364 CallbackHandler cbHandler = new CallbackHandler(handler);
4365 NetworkCapabilities nc = request.networkCapabilities;
4366 sendRequestForNetwork(nc, networkCallback, 0, REQUEST, TYPE_NONE, cbHandler);
4367 }
4368
4369 /**
Roshan Piuse08bc182020-12-22 15:10:42 -08004370 * Request a network to satisfy a set of {@link NetworkCapabilities}, limited
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004371 * by a timeout.
4372 *
4373 * This function behaves identically to the non-timed-out version
4374 * {@link #requestNetwork(NetworkRequest, NetworkCallback)}, but if a suitable network
4375 * is not found within the given time (in milliseconds) the
4376 * {@link NetworkCallback#onUnavailable()} callback is called. The request can still be
4377 * released normally by calling {@link #unregisterNetworkCallback(NetworkCallback)} but does
4378 * not have to be released if timed-out (it is automatically released). Unregistering a
4379 * request that timed out is not an error.
4380 *
4381 * <p>Do not use this method to poll for the existence of specific networks (e.g. with a small
4382 * timeout) - {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)} is provided
4383 * for that purpose. Calling this method will attempt to bring up the requested network.
4384 *
4385 * <p>This method has the same permission requirements as
4386 * {@link #requestNetwork(NetworkRequest, NetworkCallback)}, is subject to the same limitations,
4387 * and throws the same exceptions in the same conditions.
4388 *
4389 * @param request {@link NetworkRequest} describing this request.
4390 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
4391 * the callback must not be shared - it uniquely specifies this request.
4392 * @param timeoutMs The time in milliseconds to attempt looking for a suitable network
4393 * before {@link NetworkCallback#onUnavailable()} is called. The timeout must
4394 * be a positive value (i.e. >0).
4395 */
4396 public void requestNetwork(@NonNull NetworkRequest request,
4397 @NonNull NetworkCallback networkCallback, int timeoutMs) {
4398 checkTimeout(timeoutMs);
4399 NetworkCapabilities nc = request.networkCapabilities;
4400 sendRequestForNetwork(nc, networkCallback, timeoutMs, REQUEST, TYPE_NONE,
4401 getDefaultHandler());
4402 }
4403
4404 /**
Roshan Piuse08bc182020-12-22 15:10:42 -08004405 * Request a network to satisfy a set of {@link NetworkCapabilities}, limited
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004406 * by a timeout.
4407 *
4408 * This method behaves identically to
4409 * {@link #requestNetwork(NetworkRequest, NetworkCallback, int)} but runs all the callbacks
4410 * on the passed Handler.
4411 *
4412 * <p>This method has the same permission requirements as
4413 * {@link #requestNetwork(NetworkRequest, NetworkCallback)}, is subject to the same limitations,
4414 * and throws the same exceptions in the same conditions.
4415 *
4416 * @param request {@link NetworkRequest} describing this request.
4417 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
4418 * the callback must not be shared - it uniquely specifies this request.
4419 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
4420 * @param timeoutMs The time in milliseconds to attempt looking for a suitable network
4421 * before {@link NetworkCallback#onUnavailable} is called.
4422 */
4423 public void requestNetwork(@NonNull NetworkRequest request,
4424 @NonNull NetworkCallback networkCallback, @NonNull Handler handler, int timeoutMs) {
4425 checkTimeout(timeoutMs);
4426 CallbackHandler cbHandler = new CallbackHandler(handler);
4427 NetworkCapabilities nc = request.networkCapabilities;
4428 sendRequestForNetwork(nc, networkCallback, timeoutMs, REQUEST, TYPE_NONE, cbHandler);
4429 }
4430
4431 /**
4432 * The lookup key for a {@link Network} object included with the intent after
4433 * successfully finding a network for the applications request. Retrieve it with
4434 * {@link android.content.Intent#getParcelableExtra(String)}.
4435 * <p>
4436 * Note that if you intend to invoke {@link Network#openConnection(java.net.URL)}
4437 * then you must get a ConnectivityManager instance before doing so.
4438 */
4439 public static final String EXTRA_NETWORK = "android.net.extra.NETWORK";
4440
4441 /**
4442 * The lookup key for a {@link NetworkRequest} object included with the intent after
4443 * successfully finding a network for the applications request. Retrieve it with
4444 * {@link android.content.Intent#getParcelableExtra(String)}.
4445 */
4446 public static final String EXTRA_NETWORK_REQUEST = "android.net.extra.NETWORK_REQUEST";
4447
4448
4449 /**
Roshan Piuse08bc182020-12-22 15:10:42 -08004450 * Request a network to satisfy a set of {@link NetworkCapabilities}.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004451 *
4452 * This function behaves identically to the version that takes a NetworkCallback, but instead
4453 * of {@link NetworkCallback} a {@link PendingIntent} is used. This means
4454 * the request may outlive the calling application and get called back when a suitable
4455 * network is found.
4456 * <p>
4457 * The operation is an Intent broadcast that goes to a broadcast receiver that
4458 * you registered with {@link Context#registerReceiver} or through the
4459 * &lt;receiver&gt; tag in an AndroidManifest.xml file
4460 * <p>
4461 * The operation Intent is delivered with two extras, a {@link Network} typed
4462 * extra called {@link #EXTRA_NETWORK} and a {@link NetworkRequest}
4463 * typed extra called {@link #EXTRA_NETWORK_REQUEST} containing
4464 * the original requests parameters. It is important to create a new,
4465 * {@link NetworkCallback} based request before completing the processing of the
4466 * Intent to reserve the network or it will be released shortly after the Intent
4467 * is processed.
4468 * <p>
4469 * If there is already a request for this Intent registered (with the equality of
4470 * two Intents defined by {@link Intent#filterEquals}), then it will be removed and
4471 * replaced by this one, effectively releasing the previous {@link NetworkRequest}.
4472 * <p>
4473 * The request may be released normally by calling
4474 * {@link #releaseNetworkRequest(android.app.PendingIntent)}.
4475 * <p>It is presently unsupported to request a network with either
4476 * {@link NetworkCapabilities#NET_CAPABILITY_VALIDATED} or
4477 * {@link NetworkCapabilities#NET_CAPABILITY_CAPTIVE_PORTAL}
4478 * as these {@code NetworkCapabilities} represent states that a particular
4479 * network may never attain, and whether a network will attain these states
4480 * is unknown prior to bringing up the network so the framework does not
4481 * know how to go about satisfying a request with these capabilities.
4482 *
4483 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4484 * number of outstanding requests to 100 per app (identified by their UID), shared with
4485 * all variants of this method, of {@link #registerNetworkCallback} as well as
4486 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4487 * Requesting a network with this method will count toward this limit. If this limit is
4488 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4489 * make sure to unregister the callbacks with {@link #unregisterNetworkCallback(PendingIntent)}
4490 * or {@link #releaseNetworkRequest(PendingIntent)}.
4491 *
4492 * <p>This method requires the caller to hold either the
4493 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
4494 * or the ability to modify system settings as determined by
4495 * {@link android.provider.Settings.System#canWrite}.</p>
4496 *
4497 * @param request {@link NetworkRequest} describing this request.
4498 * @param operation Action to perform when the network is available (corresponds
4499 * to the {@link NetworkCallback#onAvailable} call. Typically
4500 * comes from {@link PendingIntent#getBroadcast}. Cannot be null.
4501 * @throws IllegalArgumentException if {@code request} contains invalid network capabilities.
4502 * @throws SecurityException if missing the appropriate permissions.
4503 * @throws RuntimeException if the app already has too many callbacks registered.
4504 */
4505 public void requestNetwork(@NonNull NetworkRequest request,
4506 @NonNull PendingIntent operation) {
4507 printStackTrace();
4508 checkPendingIntentNotNull(operation);
4509 try {
4510 mService.pendingRequestForNetwork(
4511 request.networkCapabilities, operation, mContext.getOpPackageName(),
4512 getAttributionTag());
4513 } catch (RemoteException e) {
4514 throw e.rethrowFromSystemServer();
4515 } catch (ServiceSpecificException e) {
4516 throw convertServiceException(e);
4517 }
4518 }
4519
4520 /**
4521 * Removes a request made via {@link #requestNetwork(NetworkRequest, android.app.PendingIntent)}
4522 * <p>
4523 * This method has the same behavior as
4524 * {@link #unregisterNetworkCallback(android.app.PendingIntent)} with respect to
4525 * releasing network resources and disconnecting.
4526 *
4527 * @param operation A PendingIntent equal (as defined by {@link Intent#filterEquals}) to the
4528 * PendingIntent passed to
4529 * {@link #requestNetwork(NetworkRequest, android.app.PendingIntent)} with the
4530 * corresponding NetworkRequest you'd like to remove. Cannot be null.
4531 */
4532 public void releaseNetworkRequest(@NonNull PendingIntent operation) {
4533 printStackTrace();
4534 checkPendingIntentNotNull(operation);
4535 try {
4536 mService.releasePendingNetworkRequest(operation);
4537 } catch (RemoteException e) {
4538 throw e.rethrowFromSystemServer();
4539 }
4540 }
4541
4542 private static void checkPendingIntentNotNull(PendingIntent intent) {
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00004543 Objects.requireNonNull(intent, "PendingIntent cannot be null.");
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004544 }
4545
4546 private static void checkCallbackNotNull(NetworkCallback callback) {
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00004547 Objects.requireNonNull(callback, "null NetworkCallback");
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004548 }
4549
4550 private static void checkTimeout(int timeoutMs) {
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00004551 if (timeoutMs <= 0) {
4552 throw new IllegalArgumentException("timeoutMs must be strictly positive.");
4553 }
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004554 }
4555
4556 /**
4557 * Registers to receive notifications about all networks which satisfy the given
4558 * {@link NetworkRequest}. The callbacks will continue to be called until
4559 * either the application exits or {@link #unregisterNetworkCallback(NetworkCallback)} is
4560 * called.
4561 *
4562 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4563 * number of outstanding requests to 100 per app (identified by their UID), shared with
4564 * all variants of this method, of {@link #requestNetwork} as well as
4565 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4566 * Requesting a network with this method will count toward this limit. If this limit is
4567 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4568 * make sure to unregister the callbacks with
4569 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4570 *
4571 * @param request {@link NetworkRequest} describing this request.
4572 * @param networkCallback The {@link NetworkCallback} that the system will call as suitable
4573 * networks change state.
4574 * The callback is invoked on the default internal Handler.
4575 * @throws RuntimeException if the app already has too many callbacks registered.
4576 */
4577 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
4578 public void registerNetworkCallback(@NonNull NetworkRequest request,
4579 @NonNull NetworkCallback networkCallback) {
4580 registerNetworkCallback(request, networkCallback, getDefaultHandler());
4581 }
4582
4583 /**
4584 * Registers to receive notifications about all networks which satisfy the given
4585 * {@link NetworkRequest}. The callbacks will continue to be called until
4586 * either the application exits or {@link #unregisterNetworkCallback(NetworkCallback)} is
4587 * called.
4588 *
4589 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4590 * number of outstanding requests to 100 per app (identified by their UID), shared with
4591 * all variants of this method, of {@link #requestNetwork} as well as
4592 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4593 * Requesting a network with this method will count toward this limit. If this limit is
4594 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4595 * make sure to unregister the callbacks with
4596 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4597 *
4598 *
4599 * @param request {@link NetworkRequest} describing this request.
4600 * @param networkCallback The {@link NetworkCallback} that the system will call as suitable
4601 * networks change state.
4602 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
4603 * @throws RuntimeException if the app already has too many callbacks registered.
4604 */
4605 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
4606 public void registerNetworkCallback(@NonNull NetworkRequest request,
4607 @NonNull NetworkCallback networkCallback, @NonNull Handler handler) {
4608 CallbackHandler cbHandler = new CallbackHandler(handler);
4609 NetworkCapabilities nc = request.networkCapabilities;
4610 sendRequestForNetwork(nc, networkCallback, 0, LISTEN, TYPE_NONE, cbHandler);
4611 }
4612
4613 /**
4614 * Registers a PendingIntent to be sent when a network is available which satisfies the given
4615 * {@link NetworkRequest}.
4616 *
4617 * This function behaves identically to the version that takes a NetworkCallback, but instead
4618 * of {@link NetworkCallback} a {@link PendingIntent} is used. This means
4619 * the request may outlive the calling application and get called back when a suitable
4620 * network is found.
4621 * <p>
4622 * The operation is an Intent broadcast that goes to a broadcast receiver that
4623 * you registered with {@link Context#registerReceiver} or through the
4624 * &lt;receiver&gt; tag in an AndroidManifest.xml file
4625 * <p>
4626 * The operation Intent is delivered with two extras, a {@link Network} typed
4627 * extra called {@link #EXTRA_NETWORK} and a {@link NetworkRequest}
4628 * typed extra called {@link #EXTRA_NETWORK_REQUEST} containing
4629 * the original requests parameters.
4630 * <p>
4631 * If there is already a request for this Intent registered (with the equality of
4632 * two Intents defined by {@link Intent#filterEquals}), then it will be removed and
4633 * replaced by this one, effectively releasing the previous {@link NetworkRequest}.
4634 * <p>
4635 * The request may be released normally by calling
4636 * {@link #unregisterNetworkCallback(android.app.PendingIntent)}.
4637 *
4638 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4639 * number of outstanding requests to 100 per app (identified by their UID), shared with
4640 * all variants of this method, of {@link #requestNetwork} as well as
4641 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4642 * Requesting a network with this method will count toward this limit. If this limit is
4643 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4644 * make sure to unregister the callbacks with {@link #unregisterNetworkCallback(PendingIntent)}
4645 * or {@link #releaseNetworkRequest(PendingIntent)}.
4646 *
4647 * @param request {@link NetworkRequest} describing this request.
4648 * @param operation Action to perform when the network is available (corresponds
4649 * to the {@link NetworkCallback#onAvailable} call. Typically
4650 * comes from {@link PendingIntent#getBroadcast}. Cannot be null.
4651 * @throws RuntimeException if the app already has too many callbacks registered.
4652 */
4653 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
4654 public void registerNetworkCallback(@NonNull NetworkRequest request,
4655 @NonNull PendingIntent operation) {
4656 printStackTrace();
4657 checkPendingIntentNotNull(operation);
4658 try {
4659 mService.pendingListenForNetwork(
Roshan Piusa8a477b2020-12-17 14:53:09 -08004660 request.networkCapabilities, operation, mContext.getOpPackageName(),
4661 getAttributionTag());
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004662 } catch (RemoteException e) {
4663 throw e.rethrowFromSystemServer();
4664 } catch (ServiceSpecificException e) {
4665 throw convertServiceException(e);
4666 }
4667 }
4668
4669 /**
Lorenzo Colittia77d05e2021-01-29 20:14:04 +09004670 * Registers to receive notifications about changes in the application's default network. This
4671 * may be a physical network or a virtual network, such as a VPN that applies to the
4672 * application. The callbacks will continue to be called until either the application exits or
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004673 * {@link #unregisterNetworkCallback(NetworkCallback)} is called.
4674 *
4675 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4676 * number of outstanding requests to 100 per app (identified by their UID), shared with
4677 * all variants of this method, of {@link #requestNetwork} as well as
4678 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4679 * Requesting a network with this method will count toward this limit. If this limit is
4680 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4681 * make sure to unregister the callbacks with
4682 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4683 *
4684 * @param networkCallback The {@link NetworkCallback} that the system will call as the
Lorenzo Colittia77d05e2021-01-29 20:14:04 +09004685 * application's default network changes.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004686 * The callback is invoked on the default internal Handler.
4687 * @throws RuntimeException if the app already has too many callbacks registered.
4688 */
4689 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
4690 public void registerDefaultNetworkCallback(@NonNull NetworkCallback networkCallback) {
4691 registerDefaultNetworkCallback(networkCallback, getDefaultHandler());
4692 }
4693
4694 /**
Lorenzo Colittia77d05e2021-01-29 20:14:04 +09004695 * Registers to receive notifications about changes in the application's default network. This
4696 * may be a physical network or a virtual network, such as a VPN that applies to the
4697 * application. The callbacks will continue to be called until either the application exits or
4698 * {@link #unregisterNetworkCallback(NetworkCallback)} is called.
4699 *
4700 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4701 * number of outstanding requests to 100 per app (identified by their UID), shared with
4702 * all variants of this method, of {@link #requestNetwork} as well as
4703 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4704 * Requesting a network with this method will count toward this limit. If this limit is
4705 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4706 * make sure to unregister the callbacks with
4707 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4708 *
4709 * @param networkCallback The {@link NetworkCallback} that the system will call as the
4710 * application's default network changes.
4711 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
4712 * @throws RuntimeException if the app already has too many callbacks registered.
4713 */
4714 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
4715 public void registerDefaultNetworkCallback(@NonNull NetworkCallback networkCallback,
4716 @NonNull Handler handler) {
Chiachang Wangc7d203d2021-04-20 15:41:24 +08004717 registerDefaultNetworkCallbackForUid(Process.INVALID_UID, networkCallback, handler);
Lorenzo Colitti5f26b192021-03-12 22:48:07 +09004718 }
4719
4720 /**
4721 * Registers to receive notifications about changes in the default network for the specified
4722 * UID. This may be a physical network or a virtual network, such as a VPN that applies to the
4723 * UID. The callbacks will continue to be called until either the application exits or
4724 * {@link #unregisterNetworkCallback(NetworkCallback)} is called.
4725 *
4726 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4727 * number of outstanding requests to 100 per app (identified by their UID), shared with
4728 * all variants of this method, of {@link #requestNetwork} as well as
4729 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4730 * Requesting a network with this method will count toward this limit. If this limit is
4731 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4732 * make sure to unregister the callbacks with
4733 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4734 *
4735 * @param uid the UID for which to track default network changes.
4736 * @param networkCallback The {@link NetworkCallback} that the system will call as the
4737 * UID's default network changes.
4738 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
4739 * @throws RuntimeException if the app already has too many callbacks registered.
4740 * @hide
4741 */
Lorenzo Colittib90bdbd2021-03-22 18:23:21 +09004742 @SystemApi(client = MODULE_LIBRARIES)
Lorenzo Colitti5f26b192021-03-12 22:48:07 +09004743 @SuppressLint({"ExecutorRegistration", "PairedRegistration"})
4744 @RequiresPermission(anyOf = {
4745 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
4746 android.Manifest.permission.NETWORK_SETTINGS})
Chiachang Wangc7d203d2021-04-20 15:41:24 +08004747 public void registerDefaultNetworkCallbackForUid(int uid,
Lorenzo Colitti5f26b192021-03-12 22:48:07 +09004748 @NonNull NetworkCallback networkCallback, @NonNull Handler handler) {
Lorenzo Colittia77d05e2021-01-29 20:14:04 +09004749 CallbackHandler cbHandler = new CallbackHandler(handler);
Lorenzo Colitti5f26b192021-03-12 22:48:07 +09004750 sendRequestForNetwork(uid, null /* need */, networkCallback, 0 /* timeoutMs */,
Lorenzo Colittia77d05e2021-01-29 20:14:04 +09004751 TRACK_DEFAULT, TYPE_NONE, cbHandler);
4752 }
4753
4754 /**
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004755 * Registers to receive notifications about changes in the system default network. The callbacks
4756 * will continue to be called until either the application exits or
4757 * {@link #unregisterNetworkCallback(NetworkCallback)} is called.
4758 *
Lorenzo Colittia77d05e2021-01-29 20:14:04 +09004759 * This method should not be used to determine networking state seen by applications, because in
4760 * many cases, most or even all application traffic may not use the default network directly,
4761 * and traffic from different applications may go on different networks by default. As an
4762 * example, if a VPN is connected, traffic from all applications might be sent through the VPN
4763 * and not onto the system default network. Applications or system components desiring to do
4764 * determine network state as seen by applications should use other methods such as
4765 * {@link #registerDefaultNetworkCallback(NetworkCallback, Handler)}.
4766 *
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004767 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4768 * number of outstanding requests to 100 per app (identified by their UID), shared with
4769 * all variants of this method, of {@link #requestNetwork} as well as
4770 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4771 * Requesting a network with this method will count toward this limit. If this limit is
4772 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4773 * make sure to unregister the callbacks with
4774 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4775 *
4776 * @param networkCallback The {@link NetworkCallback} that the system will call as the
4777 * system default network changes.
4778 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
4779 * @throws RuntimeException if the app already has too many callbacks registered.
Lorenzo Colittia77d05e2021-01-29 20:14:04 +09004780 *
4781 * @hide
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004782 */
Lorenzo Colittia77d05e2021-01-29 20:14:04 +09004783 @SystemApi(client = MODULE_LIBRARIES)
4784 @SuppressLint({"ExecutorRegistration", "PairedRegistration"})
4785 @RequiresPermission(anyOf = {
4786 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
4787 android.Manifest.permission.NETWORK_SETTINGS})
4788 public void registerSystemDefaultNetworkCallback(@NonNull NetworkCallback networkCallback,
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004789 @NonNull Handler handler) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004790 CallbackHandler cbHandler = new CallbackHandler(handler);
4791 sendRequestForNetwork(null /* NetworkCapabilities need */, networkCallback, 0,
Lorenzo Colittia77d05e2021-01-29 20:14:04 +09004792 TRACK_SYSTEM_DEFAULT, TYPE_NONE, cbHandler);
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004793 }
4794
4795 /**
junyulaibd123062021-03-15 11:48:48 +08004796 * Registers to receive notifications about the best matching network which satisfy the given
4797 * {@link NetworkRequest}. The callbacks will continue to be called until
4798 * either the application exits or {@link #unregisterNetworkCallback(NetworkCallback)} is
4799 * called.
4800 *
4801 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4802 * number of outstanding requests to 100 per app (identified by their UID), shared with
4803 * {@link #registerNetworkCallback} and its variants and {@link #requestNetwork} as well as
4804 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4805 * Requesting a network with this method will count toward this limit. If this limit is
4806 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4807 * make sure to unregister the callbacks with
4808 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4809 *
4810 *
4811 * @param request {@link NetworkRequest} describing this request.
4812 * @param networkCallback The {@link NetworkCallback} that the system will call as suitable
4813 * networks change state.
4814 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
4815 * @throws RuntimeException if the app already has too many callbacks registered.
junyulai5a5c99b2021-03-05 15:51:17 +08004816 */
junyulai5a5c99b2021-03-05 15:51:17 +08004817 @SuppressLint("ExecutorRegistration")
4818 public void registerBestMatchingNetworkCallback(@NonNull NetworkRequest request,
4819 @NonNull NetworkCallback networkCallback, @NonNull Handler handler) {
4820 final NetworkCapabilities nc = request.networkCapabilities;
4821 final CallbackHandler cbHandler = new CallbackHandler(handler);
junyulai7664f622021-03-12 20:05:08 +08004822 sendRequestForNetwork(nc, networkCallback, 0, LISTEN_FOR_BEST, TYPE_NONE, cbHandler);
junyulai5a5c99b2021-03-05 15:51:17 +08004823 }
4824
4825 /**
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004826 * Requests bandwidth update for a given {@link Network} and returns whether the update request
4827 * is accepted by ConnectivityService. Once accepted, ConnectivityService will poll underlying
4828 * network connection for updated bandwidth information. The caller will be notified via
4829 * {@link ConnectivityManager.NetworkCallback} if there is an update. Notice that this
4830 * method assumes that the caller has previously called
4831 * {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)} to listen for network
4832 * changes.
4833 *
4834 * @param network {@link Network} specifying which network you're interested.
4835 * @return {@code true} on success, {@code false} if the {@link Network} is no longer valid.
4836 */
4837 public boolean requestBandwidthUpdate(@NonNull Network network) {
4838 try {
4839 return mService.requestBandwidthUpdate(network);
4840 } catch (RemoteException e) {
4841 throw e.rethrowFromSystemServer();
4842 }
4843 }
4844
4845 /**
4846 * Unregisters a {@code NetworkCallback} and possibly releases networks originating from
4847 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} and
4848 * {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)} calls.
Chalard Jean0c7ebe92022-08-03 14:45:47 +09004849 * If the given {@code NetworkCallback} had previously been used with {@code #requestNetwork},
4850 * any networks that the device brought up only to satisfy that request will be disconnected.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004851 *
4852 * Notifications that would have triggered that {@code NetworkCallback} will immediately stop
4853 * triggering it as soon as this call returns.
4854 *
4855 * @param networkCallback The {@link NetworkCallback} used when making the request.
4856 */
4857 public void unregisterNetworkCallback(@NonNull NetworkCallback networkCallback) {
4858 printStackTrace();
4859 checkCallbackNotNull(networkCallback);
4860 final List<NetworkRequest> reqs = new ArrayList<>();
4861 // Find all requests associated to this callback and stop callback triggers immediately.
4862 // Callback is reusable immediately. http://b/20701525, http://b/35921499.
4863 synchronized (sCallbacks) {
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00004864 if (networkCallback.networkRequest == null) {
4865 throw new IllegalArgumentException("NetworkCallback was not registered");
4866 }
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004867 if (networkCallback.networkRequest == ALREADY_UNREGISTERED) {
4868 Log.d(TAG, "NetworkCallback was already unregistered");
4869 return;
4870 }
4871 for (Map.Entry<NetworkRequest, NetworkCallback> e : sCallbacks.entrySet()) {
4872 if (e.getValue() == networkCallback) {
4873 reqs.add(e.getKey());
4874 }
4875 }
4876 // TODO: throw exception if callback was registered more than once (http://b/20701525).
4877 for (NetworkRequest r : reqs) {
4878 try {
4879 mService.releaseNetworkRequest(r);
4880 } catch (RemoteException e) {
4881 throw e.rethrowFromSystemServer();
4882 }
4883 // Only remove mapping if rpc was successful.
4884 sCallbacks.remove(r);
4885 }
4886 networkCallback.networkRequest = ALREADY_UNREGISTERED;
4887 }
4888 }
4889
4890 /**
4891 * Unregisters a callback previously registered via
4892 * {@link #registerNetworkCallback(NetworkRequest, android.app.PendingIntent)}.
4893 *
4894 * @param operation A PendingIntent equal (as defined by {@link Intent#filterEquals}) to the
4895 * PendingIntent passed to
4896 * {@link #registerNetworkCallback(NetworkRequest, android.app.PendingIntent)}.
4897 * Cannot be null.
4898 */
4899 public void unregisterNetworkCallback(@NonNull PendingIntent operation) {
4900 releaseNetworkRequest(operation);
4901 }
4902
4903 /**
4904 * Informs the system whether it should switch to {@code network} regardless of whether it is
4905 * validated or not. If {@code accept} is true, and the network was explicitly selected by the
4906 * user (e.g., by selecting a Wi-Fi network in the Settings app), then the network will become
4907 * the system default network regardless of any other network that's currently connected. If
4908 * {@code always} is true, then the choice is remembered, so that the next time the user
4909 * connects to this network, the system will switch to it.
4910 *
4911 * @param network The network to accept.
4912 * @param accept Whether to accept the network even if unvalidated.
4913 * @param always Whether to remember this choice in the future.
4914 *
4915 * @hide
4916 */
Chiachang Wangf9294e72021-03-18 09:44:34 +08004917 @SystemApi(client = MODULE_LIBRARIES)
4918 @RequiresPermission(anyOf = {
4919 android.Manifest.permission.NETWORK_SETTINGS,
4920 android.Manifest.permission.NETWORK_SETUP_WIZARD,
4921 android.Manifest.permission.NETWORK_STACK,
4922 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK})
4923 public void setAcceptUnvalidated(@NonNull Network network, boolean accept, boolean always) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004924 try {
4925 mService.setAcceptUnvalidated(network, accept, always);
4926 } catch (RemoteException e) {
4927 throw e.rethrowFromSystemServer();
4928 }
4929 }
4930
4931 /**
4932 * Informs the system whether it should consider the network as validated even if it only has
4933 * partial connectivity. If {@code accept} is true, then the network will be considered as
4934 * validated even if connectivity is only partial. If {@code always} is true, then the choice
4935 * is remembered, so that the next time the user connects to this network, the system will
4936 * switch to it.
4937 *
4938 * @param network The network to accept.
4939 * @param accept Whether to consider the network as validated even if it has partial
4940 * connectivity.
4941 * @param always Whether to remember this choice in the future.
4942 *
4943 * @hide
4944 */
Chiachang Wangf9294e72021-03-18 09:44:34 +08004945 @SystemApi(client = MODULE_LIBRARIES)
4946 @RequiresPermission(anyOf = {
4947 android.Manifest.permission.NETWORK_SETTINGS,
4948 android.Manifest.permission.NETWORK_SETUP_WIZARD,
4949 android.Manifest.permission.NETWORK_STACK,
4950 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK})
4951 public void setAcceptPartialConnectivity(@NonNull Network network, boolean accept,
4952 boolean always) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004953 try {
4954 mService.setAcceptPartialConnectivity(network, accept, always);
4955 } catch (RemoteException e) {
4956 throw e.rethrowFromSystemServer();
4957 }
4958 }
4959
4960 /**
4961 * Informs the system to penalize {@code network}'s score when it becomes unvalidated. This is
4962 * only meaningful if the system is configured not to penalize such networks, e.g., if the
4963 * {@code config_networkAvoidBadWifi} configuration variable is set to 0 and the {@code
4964 * NETWORK_AVOID_BAD_WIFI setting is unset}.
4965 *
4966 * @param network The network to accept.
4967 *
4968 * @hide
4969 */
Chiachang Wangf9294e72021-03-18 09:44:34 +08004970 @SystemApi(client = MODULE_LIBRARIES)
4971 @RequiresPermission(anyOf = {
4972 android.Manifest.permission.NETWORK_SETTINGS,
4973 android.Manifest.permission.NETWORK_SETUP_WIZARD,
4974 android.Manifest.permission.NETWORK_STACK,
4975 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK})
4976 public void setAvoidUnvalidated(@NonNull Network network) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004977 try {
4978 mService.setAvoidUnvalidated(network);
4979 } catch (RemoteException e) {
4980 throw e.rethrowFromSystemServer();
4981 }
4982 }
4983
4984 /**
Chalard Jean0c7ebe92022-08-03 14:45:47 +09004985 * Temporarily allow bad Wi-Fi to override {@code config_networkAvoidBadWifi} configuration.
Chiachang Wang6eac9fb2021-06-17 22:11:30 +08004986 *
4987 * @param timeMs The expired current time. The value should be set within a limited time from
4988 * now.
4989 *
4990 * @hide
4991 */
4992 public void setTestAllowBadWifiUntil(long timeMs) {
4993 try {
4994 mService.setTestAllowBadWifiUntil(timeMs);
4995 } catch (RemoteException e) {
4996 throw e.rethrowFromSystemServer();
4997 }
4998 }
4999
5000 /**
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005001 * Requests that the system open the captive portal app on the specified network.
5002 *
Remi NGUYEN VAN8238a762021-03-16 18:06:06 +09005003 * <p>This is to be used on networks where a captive portal was detected, as per
5004 * {@link NetworkCapabilities#NET_CAPABILITY_CAPTIVE_PORTAL}.
5005 *
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005006 * @param network The network to log into.
5007 *
5008 * @hide
5009 */
Remi NGUYEN VAN8238a762021-03-16 18:06:06 +09005010 @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
5011 @RequiresPermission(anyOf = {
5012 android.Manifest.permission.NETWORK_SETTINGS,
5013 android.Manifest.permission.NETWORK_STACK,
5014 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK
5015 })
5016 public void startCaptivePortalApp(@NonNull Network network) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005017 try {
5018 mService.startCaptivePortalApp(network);
5019 } catch (RemoteException e) {
5020 throw e.rethrowFromSystemServer();
5021 }
5022 }
5023
5024 /**
5025 * Requests that the system open the captive portal app with the specified extras.
5026 *
5027 * <p>This endpoint is exclusively for use by the NetworkStack and is protected by the
5028 * corresponding permission.
5029 * @param network Network on which the captive portal was detected.
5030 * @param appExtras Extras to include in the app start intent.
5031 * @hide
5032 */
5033 @SystemApi
5034 @RequiresPermission(NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK)
5035 public void startCaptivePortalApp(@NonNull Network network, @NonNull Bundle appExtras) {
5036 try {
5037 mService.startCaptivePortalAppInternal(network, appExtras);
5038 } catch (RemoteException e) {
5039 throw e.rethrowFromSystemServer();
5040 }
5041 }
5042
5043 /**
Chalard Jean0c7ebe92022-08-03 14:45:47 +09005044 * Determine whether the device is configured to avoid bad Wi-Fi.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005045 * @hide
5046 */
5047 @SystemApi
5048 @RequiresPermission(anyOf = {
5049 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
5050 android.Manifest.permission.NETWORK_STACK})
5051 public boolean shouldAvoidBadWifi() {
5052 try {
5053 return mService.shouldAvoidBadWifi();
5054 } catch (RemoteException e) {
5055 throw e.rethrowFromSystemServer();
5056 }
5057 }
5058
5059 /**
5060 * It is acceptable to briefly use multipath data to provide seamless connectivity for
5061 * time-sensitive user-facing operations when the system default network is temporarily
5062 * unresponsive. The amount of data should be limited (less than one megabyte for every call to
5063 * this method), and the operation should be infrequent to ensure that data usage is limited.
5064 *
5065 * An example of such an operation might be a time-sensitive foreground activity, such as a
5066 * voice command, that the user is performing while walking out of range of a Wi-Fi network.
5067 */
5068 public static final int MULTIPATH_PREFERENCE_HANDOVER = 1 << 0;
5069
5070 /**
5071 * It is acceptable to use small amounts of multipath data on an ongoing basis to provide
5072 * a backup channel for traffic that is primarily going over another network.
5073 *
5074 * An example might be maintaining backup connections to peers or servers for the purpose of
5075 * fast fallback if the default network is temporarily unresponsive or disconnects. The traffic
5076 * on backup paths should be negligible compared to the traffic on the main path.
5077 */
5078 public static final int MULTIPATH_PREFERENCE_RELIABILITY = 1 << 1;
5079
5080 /**
5081 * It is acceptable to use metered data to improve network latency and performance.
5082 */
5083 public static final int MULTIPATH_PREFERENCE_PERFORMANCE = 1 << 2;
5084
5085 /**
5086 * Return value to use for unmetered networks. On such networks we currently set all the flags
5087 * to true.
5088 * @hide
5089 */
5090 public static final int MULTIPATH_PREFERENCE_UNMETERED =
5091 MULTIPATH_PREFERENCE_HANDOVER |
5092 MULTIPATH_PREFERENCE_RELIABILITY |
5093 MULTIPATH_PREFERENCE_PERFORMANCE;
5094
Aaron Huangcff22942021-05-27 16:31:26 +08005095 /** @hide */
5096 @Retention(RetentionPolicy.SOURCE)
5097 @IntDef(flag = true, value = {
5098 MULTIPATH_PREFERENCE_HANDOVER,
5099 MULTIPATH_PREFERENCE_RELIABILITY,
5100 MULTIPATH_PREFERENCE_PERFORMANCE,
5101 })
5102 public @interface MultipathPreference {
5103 }
5104
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005105 /**
5106 * Provides a hint to the calling application on whether it is desirable to use the
5107 * multinetwork APIs (e.g., {@link Network#openConnection}, {@link Network#bindSocket}, etc.)
5108 * for multipath data transfer on this network when it is not the system default network.
5109 * Applications desiring to use multipath network protocols should call this method before
5110 * each such operation.
5111 *
5112 * @param network The network on which the application desires to use multipath data.
Chalard Jean0c7ebe92022-08-03 14:45:47 +09005113 * If {@code null}, this method will return a preference that will generally
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005114 * apply to metered networks.
Chalard Jean0c7ebe92022-08-03 14:45:47 +09005115 * @return a bitwise OR of zero or more of the {@code MULTIPATH_PREFERENCE_*} constants.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005116 */
5117 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
5118 public @MultipathPreference int getMultipathPreference(@Nullable Network network) {
5119 try {
5120 return mService.getMultipathPreference(network);
5121 } catch (RemoteException e) {
5122 throw e.rethrowFromSystemServer();
5123 }
5124 }
5125
5126 /**
5127 * Resets all connectivity manager settings back to factory defaults.
5128 * @hide
5129 */
Chiachang Wangf9294e72021-03-18 09:44:34 +08005130 @SystemApi(client = MODULE_LIBRARIES)
5131 @RequiresPermission(anyOf = {
5132 android.Manifest.permission.NETWORK_SETTINGS,
5133 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK})
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005134 public void factoryReset() {
5135 try {
5136 mService.factoryReset();
Remi NGUYEN VANe4d1cd92021-06-17 16:27:31 +09005137 getTetheringManager().stopAllTethering();
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005138 } catch (RemoteException e) {
5139 throw e.rethrowFromSystemServer();
5140 }
5141 }
5142
5143 /**
5144 * Binds the current process to {@code network}. All Sockets created in the future
5145 * (and not explicitly bound via a bound SocketFactory from
5146 * {@link Network#getSocketFactory() Network.getSocketFactory()}) will be bound to
5147 * {@code network}. All host name resolutions will be limited to {@code network} as well.
5148 * Note that if {@code network} ever disconnects, all Sockets created in this way will cease to
5149 * work and all host name resolutions will fail. This is by design so an application doesn't
5150 * accidentally use Sockets it thinks are still bound to a particular {@link Network}.
5151 * To clear binding pass {@code null} for {@code network}. Using individually bound
5152 * Sockets created by Network.getSocketFactory().createSocket() and
5153 * performing network-specific host name resolutions via
5154 * {@link Network#getAllByName Network.getAllByName} is preferred to calling
5155 * {@code bindProcessToNetwork}.
5156 *
5157 * @param network The {@link Network} to bind the current process to, or {@code null} to clear
5158 * the current binding.
5159 * @return {@code true} on success, {@code false} if the {@link Network} is no longer valid.
5160 */
5161 public boolean bindProcessToNetwork(@Nullable Network network) {
5162 // Forcing callers to call through non-static function ensures ConnectivityManager
5163 // instantiated.
5164 return setProcessDefaultNetwork(network);
5165 }
5166
5167 /**
5168 * Binds the current process to {@code network}. All Sockets created in the future
5169 * (and not explicitly bound via a bound SocketFactory from
5170 * {@link Network#getSocketFactory() Network.getSocketFactory()}) will be bound to
5171 * {@code network}. All host name resolutions will be limited to {@code network} as well.
5172 * Note that if {@code network} ever disconnects, all Sockets created in this way will cease to
5173 * work and all host name resolutions will fail. This is by design so an application doesn't
5174 * accidentally use Sockets it thinks are still bound to a particular {@link Network}.
5175 * To clear binding pass {@code null} for {@code network}. Using individually bound
5176 * Sockets created by Network.getSocketFactory().createSocket() and
5177 * performing network-specific host name resolutions via
5178 * {@link Network#getAllByName Network.getAllByName} is preferred to calling
5179 * {@code setProcessDefaultNetwork}.
5180 *
5181 * @param network The {@link Network} to bind the current process to, or {@code null} to clear
5182 * the current binding.
5183 * @return {@code true} on success, {@code false} if the {@link Network} is no longer valid.
5184 * @deprecated This function can throw {@link IllegalStateException}. Use
5185 * {@link #bindProcessToNetwork} instead. {@code bindProcessToNetwork}
5186 * is a direct replacement.
5187 */
5188 @Deprecated
5189 public static boolean setProcessDefaultNetwork(@Nullable Network network) {
5190 int netId = (network == null) ? NETID_UNSET : network.netId;
5191 boolean isSameNetId = (netId == NetworkUtils.getBoundNetworkForProcess());
5192
5193 if (netId != NETID_UNSET) {
5194 netId = network.getNetIdForResolv();
5195 }
5196
5197 if (!NetworkUtils.bindProcessToNetwork(netId)) {
5198 return false;
5199 }
5200
5201 if (!isSameNetId) {
5202 // Set HTTP proxy system properties to match network.
5203 // TODO: Deprecate this static method and replace it with a non-static version.
5204 try {
Remi NGUYEN VAN8a831d62021-02-03 10:18:20 +09005205 Proxy.setHttpProxyConfiguration(getInstance().getDefaultProxy());
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005206 } catch (SecurityException e) {
5207 // The process doesn't have ACCESS_NETWORK_STATE, so we can't fetch the proxy.
5208 Log.e(TAG, "Can't set proxy properties", e);
5209 }
5210 // Must flush DNS cache as new network may have different DNS resolutions.
Remi NGUYEN VANb2e919f2021-07-02 09:34:36 +09005211 InetAddress.clearDnsCache();
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005212 // Must flush socket pool as idle sockets will be bound to previous network and may
5213 // cause subsequent fetches to be performed on old network.
Orion Hodson1f4fa9f2021-05-25 21:02:02 +01005214 NetworkEventDispatcher.getInstance().dispatchNetworkConfigurationChange();
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005215 }
5216
5217 return true;
5218 }
5219
5220 /**
5221 * Returns the {@link Network} currently bound to this process via
5222 * {@link #bindProcessToNetwork}, or {@code null} if no {@link Network} is explicitly bound.
5223 *
5224 * @return {@code Network} to which this process is bound, or {@code null}.
5225 */
5226 @Nullable
5227 public Network getBoundNetworkForProcess() {
Chalard Jean0c7ebe92022-08-03 14:45:47 +09005228 // Forcing callers to call through non-static function ensures ConnectivityManager has been
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005229 // instantiated.
5230 return getProcessDefaultNetwork();
5231 }
5232
5233 /**
5234 * Returns the {@link Network} currently bound to this process via
5235 * {@link #bindProcessToNetwork}, or {@code null} if no {@link Network} is explicitly bound.
5236 *
5237 * @return {@code Network} to which this process is bound, or {@code null}.
5238 * @deprecated Using this function can lead to other functions throwing
5239 * {@link IllegalStateException}. Use {@link #getBoundNetworkForProcess} instead.
5240 * {@code getBoundNetworkForProcess} is a direct replacement.
5241 */
5242 @Deprecated
5243 @Nullable
5244 public static Network getProcessDefaultNetwork() {
5245 int netId = NetworkUtils.getBoundNetworkForProcess();
5246 if (netId == NETID_UNSET) return null;
5247 return new Network(netId);
5248 }
5249
5250 private void unsupportedStartingFrom(int version) {
5251 if (Process.myUid() == Process.SYSTEM_UID) {
5252 // The getApplicationInfo() call we make below is not supported in system context. Let
5253 // the call through here, and rely on the fact that ConnectivityService will refuse to
5254 // allow the system to use these APIs anyway.
5255 return;
5256 }
5257
5258 if (mContext.getApplicationInfo().targetSdkVersion >= version) {
5259 throw new UnsupportedOperationException(
5260 "This method is not supported in target SDK version " + version + " and above");
5261 }
5262 }
5263
5264 // Checks whether the calling app can use the legacy routing API (startUsingNetworkFeature,
5265 // stopUsingNetworkFeature, requestRouteToHost), and if not throw UnsupportedOperationException.
5266 // TODO: convert the existing system users (Tethering, GnssLocationProvider) to the new APIs and
5267 // remove these exemptions. Note that this check is not secure, and apps can still access these
5268 // functions by accessing ConnectivityService directly. However, it should be clear that doing
5269 // so is unsupported and may break in the future. http://b/22728205
5270 private void checkLegacyRoutingApiAccess() {
5271 unsupportedStartingFrom(VERSION_CODES.M);
5272 }
5273
5274 /**
5275 * Binds host resolutions performed by this process to {@code network}.
5276 * {@link #bindProcessToNetwork} takes precedence over this setting.
5277 *
5278 * @param network The {@link Network} to bind host resolutions from the current process to, or
5279 * {@code null} to clear the current binding.
5280 * @return {@code true} on success, {@code false} if the {@link Network} is no longer valid.
5281 * @hide
5282 * @deprecated This is strictly for legacy usage to support {@link #startUsingNetworkFeature}.
5283 */
5284 @Deprecated
5285 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
5286 public static boolean setProcessDefaultNetworkForHostResolution(Network network) {
5287 return NetworkUtils.bindProcessToNetworkForHostResolution(
5288 (network == null) ? NETID_UNSET : network.getNetIdForResolv());
5289 }
5290
5291 /**
5292 * Device is not restricting metered network activity while application is running on
5293 * background.
5294 */
5295 public static final int RESTRICT_BACKGROUND_STATUS_DISABLED = 1;
5296
5297 /**
5298 * Device is restricting metered network activity while application is running on background,
5299 * but application is allowed to bypass it.
5300 * <p>
5301 * In this state, application should take action to mitigate metered network access.
5302 * For example, a music streaming application should switch to a low-bandwidth bitrate.
5303 */
5304 public static final int RESTRICT_BACKGROUND_STATUS_WHITELISTED = 2;
5305
5306 /**
5307 * Device is restricting metered network activity while application is running on background.
5308 * <p>
5309 * In this state, application should not try to use the network while running on background,
5310 * because it would be denied.
5311 */
5312 public static final int RESTRICT_BACKGROUND_STATUS_ENABLED = 3;
5313
5314 /**
5315 * A change in the background metered network activity restriction has occurred.
5316 * <p>
5317 * Applications should call {@link #getRestrictBackgroundStatus()} to check if the restriction
5318 * applies to them.
5319 * <p>
5320 * This is only sent to registered receivers, not manifest receivers.
5321 */
5322 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
5323 public static final String ACTION_RESTRICT_BACKGROUND_CHANGED =
5324 "android.net.conn.RESTRICT_BACKGROUND_CHANGED";
5325
Aaron Huangcff22942021-05-27 16:31:26 +08005326 /** @hide */
5327 @Retention(RetentionPolicy.SOURCE)
5328 @IntDef(flag = false, value = {
5329 RESTRICT_BACKGROUND_STATUS_DISABLED,
5330 RESTRICT_BACKGROUND_STATUS_WHITELISTED,
5331 RESTRICT_BACKGROUND_STATUS_ENABLED,
5332 })
5333 public @interface RestrictBackgroundStatus {
5334 }
5335
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005336 /**
5337 * Determines if the calling application is subject to metered network restrictions while
5338 * running on background.
5339 *
5340 * @return {@link #RESTRICT_BACKGROUND_STATUS_DISABLED},
5341 * {@link #RESTRICT_BACKGROUND_STATUS_ENABLED},
5342 * or {@link #RESTRICT_BACKGROUND_STATUS_WHITELISTED}
5343 */
5344 public @RestrictBackgroundStatus int getRestrictBackgroundStatus() {
5345 try {
Remi NGUYEN VAN1fdeb502021-03-18 14:23:12 +09005346 return mService.getRestrictBackgroundStatusByCaller();
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005347 } catch (RemoteException e) {
5348 throw e.rethrowFromSystemServer();
5349 }
5350 }
5351
5352 /**
5353 * The network watchlist is a list of domains and IP addresses that are associated with
5354 * potentially harmful apps. This method returns the SHA-256 of the watchlist config file
5355 * currently used by the system for validation purposes.
5356 *
5357 * @return Hash of network watchlist config file. Null if config does not exist.
5358 */
5359 @Nullable
5360 public byte[] getNetworkWatchlistConfigHash() {
5361 try {
5362 return mService.getNetworkWatchlistConfigHash();
5363 } catch (RemoteException e) {
5364 Log.e(TAG, "Unable to get watchlist config hash");
5365 throw e.rethrowFromSystemServer();
5366 }
5367 }
5368
5369 /**
5370 * Returns the {@code uid} of the owner of a network connection.
5371 *
5372 * @param protocol The protocol of the connection. Only {@code IPPROTO_TCP} and {@code
5373 * IPPROTO_UDP} currently supported.
5374 * @param local The local {@link InetSocketAddress} of a connection.
5375 * @param remote The remote {@link InetSocketAddress} of a connection.
5376 * @return {@code uid} if the connection is found and the app has permission to observe it
5377 * (e.g., if it is associated with the calling VPN app's VpnService tunnel) or {@link
5378 * android.os.Process#INVALID_UID} if the connection is not found.
5379 * @throws {@link SecurityException} if the caller is not the active VpnService for the current
5380 * user.
5381 * @throws {@link IllegalArgumentException} if an unsupported protocol is requested.
5382 */
5383 public int getConnectionOwnerUid(
5384 int protocol, @NonNull InetSocketAddress local, @NonNull InetSocketAddress remote) {
5385 ConnectionInfo connectionInfo = new ConnectionInfo(protocol, local, remote);
5386 try {
5387 return mService.getConnectionOwnerUid(connectionInfo);
5388 } catch (RemoteException e) {
5389 throw e.rethrowFromSystemServer();
5390 }
5391 }
5392
5393 private void printStackTrace() {
5394 if (DEBUG) {
5395 final StackTraceElement[] callStack = Thread.currentThread().getStackTrace();
5396 final StringBuffer sb = new StringBuffer();
5397 for (int i = 3; i < callStack.length; i++) {
5398 final String stackTrace = callStack[i].toString();
5399 if (stackTrace == null || stackTrace.contains("android.os")) {
5400 break;
5401 }
5402 sb.append(" [").append(stackTrace).append("]");
5403 }
5404 Log.d(TAG, "StackLog:" + sb.toString());
5405 }
5406 }
5407
Remi NGUYEN VAN91444ca2021-01-15 23:02:47 +09005408 /** @hide */
5409 public TestNetworkManager startOrGetTestNetworkManager() {
5410 final IBinder tnBinder;
5411 try {
5412 tnBinder = mService.startOrGetTestNetworkService();
5413 } catch (RemoteException e) {
5414 throw e.rethrowFromSystemServer();
5415 }
5416
5417 return new TestNetworkManager(ITestNetworkManager.Stub.asInterface(tnBinder));
5418 }
5419
Remi NGUYEN VAN91444ca2021-01-15 23:02:47 +09005420 /** @hide */
5421 public ConnectivityDiagnosticsManager createDiagnosticsManager() {
5422 return new ConnectivityDiagnosticsManager(mContext, mService);
5423 }
5424
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005425 /**
5426 * Simulates a Data Stall for the specified Network.
5427 *
5428 * <p>This method should only be used for tests.
5429 *
Remi NGUYEN VAN564f7f82021-04-08 16:26:20 +09005430 * <p>The caller must be the owner of the specified Network. This simulates a data stall to
5431 * have the system behave as if it had happened, but does not actually stall connectivity.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005432 *
5433 * @param detectionMethod The detection method used to identify the Data Stall.
Remi NGUYEN VAN564f7f82021-04-08 16:26:20 +09005434 * See ConnectivityDiagnosticsManager.DataStallReport.DETECTION_METHOD_*.
5435 * @param timestampMillis The timestamp at which the stall 'occurred', in milliseconds, as per
5436 * SystemClock.elapsedRealtime.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005437 * @param network The Network for which a Data Stall is being simluated.
5438 * @param extras The PersistableBundle of extras included in the Data Stall notification.
5439 * @throws SecurityException if the caller is not the owner of the given network.
5440 * @hide
5441 */
5442 @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
5443 @RequiresPermission(anyOf = {android.Manifest.permission.MANAGE_TEST_NETWORKS,
5444 android.Manifest.permission.NETWORK_STACK})
Remi NGUYEN VAN564f7f82021-04-08 16:26:20 +09005445 public void simulateDataStall(@DetectionMethod int detectionMethod, long timestampMillis,
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005446 @NonNull Network network, @NonNull PersistableBundle extras) {
5447 try {
5448 mService.simulateDataStall(detectionMethod, timestampMillis, network, extras);
5449 } catch (RemoteException e) {
5450 e.rethrowFromSystemServer();
5451 }
5452 }
5453
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005454 @NonNull
5455 private final List<QosCallbackConnection> mQosCallbackConnections = new ArrayList<>();
5456
5457 /**
5458 * Registers a {@link QosSocketInfo} with an associated {@link QosCallback}. The callback will
5459 * receive available QoS events related to the {@link Network} and local ip + port
5460 * specified within socketInfo.
5461 * <p/>
5462 * The same {@link QosCallback} must be unregistered before being registered a second time,
5463 * otherwise {@link QosCallbackRegistrationException} is thrown.
5464 * <p/>
5465 * This API does not, in itself, require any permission if called with a network that is not
5466 * restricted. However, the underlying implementation currently only supports the IMS network,
5467 * which is always restricted. That means non-preinstalled callers can't possibly find this API
5468 * useful, because they'd never be called back on networks that they would have access to.
5469 *
5470 * @throws SecurityException if {@link QosSocketInfo#getNetwork()} is restricted and the app is
5471 * missing CONNECTIVITY_USE_RESTRICTED_NETWORKS permission.
5472 * @throws QosCallback.QosCallbackRegistrationException if qosCallback is already registered.
5473 * @throws RuntimeException if the app already has too many callbacks registered.
5474 *
5475 * Exceptions after the time of registration is passed through
5476 * {@link QosCallback#onError(QosCallbackException)}. see: {@link QosCallbackException}.
5477 *
5478 * @param socketInfo the socket information used to match QoS events
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005479 * @param executor The executor on which the callback will be invoked. The provided
5480 * {@link Executor} must run callback sequentially, otherwise the order of
Daniel Bright686d5d22021-03-10 11:51:50 -08005481 * callbacks cannot be guaranteed.onQosCallbackRegistered
5482 * @param callback receives qos events that satisfy socketInfo
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005483 *
5484 * @hide
5485 */
5486 @SystemApi
5487 public void registerQosCallback(@NonNull final QosSocketInfo socketInfo,
Daniel Bright686d5d22021-03-10 11:51:50 -08005488 @CallbackExecutor @NonNull final Executor executor,
5489 @NonNull final QosCallback callback) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005490 Objects.requireNonNull(socketInfo, "socketInfo must be non-null");
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005491 Objects.requireNonNull(executor, "executor must be non-null");
Daniel Bright686d5d22021-03-10 11:51:50 -08005492 Objects.requireNonNull(callback, "callback must be non-null");
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005493
5494 try {
5495 synchronized (mQosCallbackConnections) {
5496 if (getQosCallbackConnection(callback) == null) {
5497 final QosCallbackConnection connection =
5498 new QosCallbackConnection(this, callback, executor);
5499 mQosCallbackConnections.add(connection);
5500 mService.registerQosSocketCallback(socketInfo, connection);
5501 } else {
5502 Log.e(TAG, "registerQosCallback: Callback already registered");
5503 throw new QosCallbackRegistrationException();
5504 }
5505 }
5506 } catch (final RemoteException e) {
5507 Log.e(TAG, "registerQosCallback: Error while registering ", e);
5508
5509 // The same unregister method method is called for consistency even though nothing
5510 // will be sent to the ConnectivityService since the callback was never successfully
5511 // registered.
5512 unregisterQosCallback(callback);
5513 e.rethrowFromSystemServer();
5514 } catch (final ServiceSpecificException e) {
5515 Log.e(TAG, "registerQosCallback: Error while registering ", e);
5516 unregisterQosCallback(callback);
5517 throw convertServiceException(e);
5518 }
5519 }
5520
5521 /**
5522 * Unregisters the given {@link QosCallback}. The {@link QosCallback} will no longer receive
5523 * events once unregistered and can be registered a second time.
5524 * <p/>
5525 * If the {@link QosCallback} does not have an active registration, it is a no-op.
5526 *
5527 * @param callback the callback being unregistered
5528 *
5529 * @hide
5530 */
5531 @SystemApi
5532 public void unregisterQosCallback(@NonNull final QosCallback callback) {
5533 Objects.requireNonNull(callback, "The callback must be non-null");
5534 try {
5535 synchronized (mQosCallbackConnections) {
5536 final QosCallbackConnection connection = getQosCallbackConnection(callback);
5537 if (connection != null) {
5538 connection.stopReceivingMessages();
5539 mService.unregisterQosCallback(connection);
5540 mQosCallbackConnections.remove(connection);
5541 } else {
5542 Log.d(TAG, "unregisterQosCallback: Callback not registered");
5543 }
5544 }
5545 } catch (final RemoteException e) {
5546 Log.e(TAG, "unregisterQosCallback: Error while unregistering ", e);
5547 e.rethrowFromSystemServer();
5548 }
5549 }
5550
5551 /**
5552 * Gets the connection related to the callback.
5553 *
5554 * @param callback the callback to look up
5555 * @return the related connection
5556 */
5557 @Nullable
5558 private QosCallbackConnection getQosCallbackConnection(final QosCallback callback) {
5559 for (final QosCallbackConnection connection : mQosCallbackConnections) {
5560 // Checking by reference here is intentional
5561 if (connection.getCallback() == callback) {
5562 return connection;
5563 }
5564 }
5565 return null;
5566 }
5567
5568 /**
Roshan Piuse08bc182020-12-22 15:10:42 -08005569 * Request a network to satisfy a set of {@link NetworkCapabilities}, but
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005570 * does not cause any networks to retain the NET_CAPABILITY_FOREGROUND capability. This can
5571 * be used to request that the system provide a network without causing the network to be
5572 * in the foreground.
5573 *
5574 * <p>This method will attempt to find the best network that matches the passed
5575 * {@link NetworkRequest}, and to bring up one that does if none currently satisfies the
5576 * criteria. The platform will evaluate which network is the best at its own discretion.
5577 * Throughput, latency, cost per byte, policy, user preference and other considerations
5578 * may be factored in the decision of what is considered the best network.
5579 *
5580 * <p>As long as this request is outstanding, the platform will try to maintain the best network
5581 * matching this request, while always attempting to match the request to a better network if
5582 * possible. If a better match is found, the platform will switch this request to the now-best
5583 * network and inform the app of the newly best network by invoking
5584 * {@link NetworkCallback#onAvailable(Network)} on the provided callback. Note that the platform
5585 * will not try to maintain any other network than the best one currently matching the request:
5586 * a network not matching any network request may be disconnected at any time.
5587 *
5588 * <p>For example, an application could use this method to obtain a connected cellular network
5589 * even if the device currently has a data connection over Ethernet. This may cause the cellular
5590 * radio to consume additional power. Or, an application could inform the system that it wants
5591 * a network supporting sending MMSes and have the system let it know about the currently best
5592 * MMS-supporting network through the provided {@link NetworkCallback}.
5593 *
5594 * <p>The status of the request can be followed by listening to the various callbacks described
5595 * in {@link NetworkCallback}. The {@link Network} object passed to the callback methods can be
5596 * used to direct traffic to the network (although accessing some networks may be subject to
5597 * holding specific permissions). Callers will learn about the specific characteristics of the
5598 * network through
5599 * {@link NetworkCallback#onCapabilitiesChanged(Network, NetworkCapabilities)} and
5600 * {@link NetworkCallback#onLinkPropertiesChanged(Network, LinkProperties)}. The methods of the
5601 * provided {@link NetworkCallback} will only be invoked due to changes in the best network
5602 * matching the request at any given time; therefore when a better network matching the request
5603 * becomes available, the {@link NetworkCallback#onAvailable(Network)} method is called
5604 * with the new network after which no further updates are given about the previously-best
5605 * network, unless it becomes the best again at some later time. All callbacks are invoked
5606 * in order on the same thread, which by default is a thread created by the framework running
5607 * in the app.
5608 *
5609 * <p>This{@link NetworkRequest} will live until released via
5610 * {@link #unregisterNetworkCallback(NetworkCallback)} or the calling application exits, at
5611 * which point the system may let go of the network at any time.
5612 *
5613 * <p>It is presently unsupported to request a network with mutable
5614 * {@link NetworkCapabilities} such as
5615 * {@link NetworkCapabilities#NET_CAPABILITY_VALIDATED} or
5616 * {@link NetworkCapabilities#NET_CAPABILITY_CAPTIVE_PORTAL}
5617 * as these {@code NetworkCapabilities} represent states that a particular
5618 * network may never attain, and whether a network will attain these states
5619 * is unknown prior to bringing up the network so the framework does not
5620 * know how to go about satisfying a request with these capabilities.
5621 *
5622 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
5623 * number of outstanding requests to 100 per app (identified by their UID), shared with
5624 * all variants of this method, of {@link #registerNetworkCallback} as well as
5625 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
5626 * Requesting a network with this method will count toward this limit. If this limit is
5627 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
5628 * make sure to unregister the callbacks with
5629 * {@link #unregisterNetworkCallback(NetworkCallback)}.
5630 *
5631 * @param request {@link NetworkRequest} describing this request.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005632 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
5633 * the callback must not be shared - it uniquely specifies this request.
junyulaica657cb2021-04-15 00:39:49 +08005634 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
5635 * If null, the callback is invoked on the default internal Handler.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005636 * @throws IllegalArgumentException if {@code request} contains invalid network capabilities.
5637 * @throws SecurityException if missing the appropriate permissions.
5638 * @throws RuntimeException if the app already has too many callbacks registered.
5639 *
5640 * @hide
5641 */
5642 @SystemApi(client = MODULE_LIBRARIES)
5643 @SuppressLint("ExecutorRegistration")
5644 @RequiresPermission(anyOf = {
5645 android.Manifest.permission.NETWORK_SETTINGS,
5646 android.Manifest.permission.NETWORK_STACK,
5647 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK
5648 })
5649 public void requestBackgroundNetwork(@NonNull NetworkRequest request,
junyulaica657cb2021-04-15 00:39:49 +08005650 @NonNull NetworkCallback networkCallback,
5651 @SuppressLint("ListenerLast") @NonNull Handler handler) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005652 final NetworkCapabilities nc = request.networkCapabilities;
5653 sendRequestForNetwork(nc, networkCallback, 0, BACKGROUND_REQUEST,
junyulaidbb70462021-03-09 20:49:48 +08005654 TYPE_NONE, new CallbackHandler(handler));
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005655 }
James Mattis12aeab82021-01-10 14:24:24 -08005656
5657 /**
James Mattis12aeab82021-01-10 14:24:24 -08005658 * Used by automotive devices to set the network preferences used to direct traffic at an
5659 * application level as per the given OemNetworkPreferences. An example use-case would be an
5660 * automotive OEM wanting to provide connectivity for applications critical to the usage of a
5661 * vehicle via a particular network.
5662 *
5663 * Calling this will overwrite the existing preference.
5664 *
5665 * @param preference {@link OemNetworkPreferences} The application network preference to be set.
5666 * @param executor the executor on which listener will be invoked.
5667 * @param listener {@link OnSetOemNetworkPreferenceListener} optional listener used to
5668 * communicate completion of setOemNetworkPreference(). This will only be
5669 * called once upon successful completion of setOemNetworkPreference().
5670 * @throws IllegalArgumentException if {@code preference} contains invalid preference values.
5671 * @throws SecurityException if missing the appropriate permissions.
5672 * @throws UnsupportedOperationException if called on a non-automotive device.
James Mattis6e2d7022021-01-26 16:23:52 -08005673 * @hide
James Mattis12aeab82021-01-10 14:24:24 -08005674 */
James Mattis6e2d7022021-01-26 16:23:52 -08005675 @SystemApi
James Mattisa46c1442021-01-26 14:05:36 -08005676 @RequiresPermission(android.Manifest.permission.CONTROL_OEM_PAID_NETWORK_PREFERENCE)
James Mattis6e2d7022021-01-26 16:23:52 -08005677 public void setOemNetworkPreference(@NonNull final OemNetworkPreferences preference,
James Mattis12aeab82021-01-10 14:24:24 -08005678 @Nullable @CallbackExecutor final Executor executor,
Chalard Jean0a4aefc2021-03-03 16:37:13 +09005679 @Nullable final Runnable listener) {
James Mattis12aeab82021-01-10 14:24:24 -08005680 Objects.requireNonNull(preference, "OemNetworkPreferences must be non-null");
5681 if (null != listener) {
5682 Objects.requireNonNull(executor, "Executor must be non-null");
5683 }
Chalard Jean0a4aefc2021-03-03 16:37:13 +09005684 final IOnCompleteListener listenerInternal = listener == null ? null :
5685 new IOnCompleteListener.Stub() {
James Mattis12aeab82021-01-10 14:24:24 -08005686 @Override
5687 public void onComplete() {
Chalard Jean0a4aefc2021-03-03 16:37:13 +09005688 executor.execute(listener::run);
James Mattis12aeab82021-01-10 14:24:24 -08005689 }
5690 };
5691
5692 try {
5693 mService.setOemNetworkPreference(preference, listenerInternal);
5694 } catch (RemoteException e) {
5695 Log.e(TAG, "setOemNetworkPreference() failed for preference: " + preference.toString());
5696 throw e.rethrowFromSystemServer();
5697 }
5698 }
lucaslin5cdbcfb2021-03-12 00:46:33 +08005699
Chalard Jeanad565e22021-02-25 17:23:40 +09005700 /**
5701 * Request that a user profile is put by default on a network matching a given preference.
5702 *
5703 * See the documentation for the individual preferences for a description of the supported
5704 * behaviors.
5705 *
5706 * @param profile the profile concerned.
5707 * @param preference the preference for this profile.
5708 * @param executor an executor to execute the listener on. Optional if listener is null.
5709 * @param listener an optional listener to listen for completion of the operation.
5710 * @throws IllegalArgumentException if {@code profile} is not a valid user profile.
5711 * @throws SecurityException if missing the appropriate permissions.
Sooraj Sasindrane7aee272021-11-24 20:26:55 -08005712 * @deprecated Use {@link #setProfileNetworkPreferences(UserHandle, List, Executor, Runnable)}
5713 * instead as it provides a more flexible API with more options.
Chalard Jeanad565e22021-02-25 17:23:40 +09005714 * @hide
5715 */
Chalard Jean0a4aefc2021-03-03 16:37:13 +09005716 // This function is for establishing per-profile default networking and can only be called by
5717 // the device policy manager, running as the system server. It would make no sense to call it
5718 // on a context for a user because it does not establish a setting on behalf of a user, rather
5719 // it establishes a setting for a user on behalf of the DPM.
5720 @SuppressLint({"UserHandle"})
5721 @SystemApi(client = MODULE_LIBRARIES)
Chalard Jeanad565e22021-02-25 17:23:40 +09005722 @RequiresPermission(android.Manifest.permission.NETWORK_STACK)
Sooraj Sasindrane7aee272021-11-24 20:26:55 -08005723 @Deprecated
Chalard Jeanad565e22021-02-25 17:23:40 +09005724 public void setProfileNetworkPreference(@NonNull final UserHandle profile,
Sooraj Sasindrane7aee272021-11-24 20:26:55 -08005725 @ProfileNetworkPreferencePolicy final int preference,
5726 @Nullable @CallbackExecutor final Executor executor,
5727 @Nullable final Runnable listener) {
5728
5729 ProfileNetworkPreference.Builder preferenceBuilder =
5730 new ProfileNetworkPreference.Builder();
5731 preferenceBuilder.setPreference(preference);
Sooraj Sasindranf4a58dc2022-01-21 13:37:08 -08005732 if (preference != PROFILE_NETWORK_PREFERENCE_DEFAULT) {
5733 preferenceBuilder.setPreferenceEnterpriseId(NET_ENTERPRISE_ID_1);
5734 }
Sooraj Sasindrane7aee272021-11-24 20:26:55 -08005735 setProfileNetworkPreferences(profile,
5736 List.of(preferenceBuilder.build()), executor, listener);
5737 }
5738
5739 /**
5740 * Set a list of default network selection policies for a user profile.
5741 *
5742 * Calling this API with a user handle defines the entire policy for that user handle.
5743 * It will overwrite any setting previously set for the same user profile,
5744 * and not affect previously set settings for other handles.
5745 *
5746 * Call this API with an empty list to remove settings for this user profile.
5747 *
5748 * See {@link ProfileNetworkPreference} for more details on each preference
5749 * parameter.
5750 *
5751 * @param profile the user profile for which the preference is being set.
5752 * @param profileNetworkPreferences the list of profile network preferences for the
5753 * provided profile.
5754 * @param executor an executor to execute the listener on. Optional if listener is null.
5755 * @param listener an optional listener to listen for completion of the operation.
5756 * @throws IllegalArgumentException if {@code profile} is not a valid user profile.
5757 * @throws SecurityException if missing the appropriate permissions.
5758 * @hide
5759 */
5760 @SystemApi(client = MODULE_LIBRARIES)
5761 @RequiresPermission(android.Manifest.permission.NETWORK_STACK)
5762 public void setProfileNetworkPreferences(
5763 @NonNull final UserHandle profile,
5764 @NonNull List<ProfileNetworkPreference> profileNetworkPreferences,
Chalard Jeanad565e22021-02-25 17:23:40 +09005765 @Nullable @CallbackExecutor final Executor executor,
5766 @Nullable final Runnable listener) {
5767 if (null != listener) {
5768 Objects.requireNonNull(executor, "Pass a non-null executor, or a null listener");
5769 }
5770 final IOnCompleteListener proxy;
5771 if (null == listener) {
5772 proxy = null;
5773 } else {
5774 proxy = new IOnCompleteListener.Stub() {
5775 @Override
5776 public void onComplete() {
5777 executor.execute(listener::run);
5778 }
5779 };
5780 }
5781 try {
Sooraj Sasindrane7aee272021-11-24 20:26:55 -08005782 mService.setProfileNetworkPreferences(profile, profileNetworkPreferences, proxy);
Chalard Jeanad565e22021-02-25 17:23:40 +09005783 } catch (RemoteException e) {
5784 throw e.rethrowFromSystemServer();
5785 }
5786 }
5787
lucaslin5cdbcfb2021-03-12 00:46:33 +08005788 // The first network ID of IPSec tunnel interface.
lucaslinc296fcc2021-03-15 17:24:12 +08005789 private static final int TUN_INTF_NETID_START = 0xFC00; // 0xFC00 = 64512
lucaslin5cdbcfb2021-03-12 00:46:33 +08005790 // The network ID range of IPSec tunnel interface.
lucaslinc296fcc2021-03-15 17:24:12 +08005791 private static final int TUN_INTF_NETID_RANGE = 0x0400; // 0x0400 = 1024
lucaslin5cdbcfb2021-03-12 00:46:33 +08005792
5793 /**
5794 * Get the network ID range reserved for IPSec tunnel interfaces.
5795 *
5796 * @return A Range which indicates the network ID range of IPSec tunnel interface.
5797 * @hide
5798 */
5799 @SystemApi(client = MODULE_LIBRARIES)
5800 @NonNull
5801 public static Range<Integer> getIpSecNetIdRange() {
5802 return new Range(TUN_INTF_NETID_START, TUN_INTF_NETID_START + TUN_INTF_NETID_RANGE - 1);
5803 }
markchien738ad912021-12-09 18:15:45 +08005804
5805 /**
markchiene46042b2022-03-02 18:07:35 +08005806 * Adds the specified UID to the list of UIds that are allowed to use data on metered networks
5807 * even when background data is restricted. The deny list takes precedence over the allow list.
markchien738ad912021-12-09 18:15:45 +08005808 *
5809 * @param uid uid of target app
markchien68cfadc2022-01-14 13:39:54 +08005810 * @throws IllegalStateException if updating allow list failed.
markchien738ad912021-12-09 18:15:45 +08005811 * @hide
5812 */
5813 @SystemApi(client = MODULE_LIBRARIES)
5814 @RequiresPermission(anyOf = {
5815 android.Manifest.permission.NETWORK_SETTINGS,
5816 android.Manifest.permission.NETWORK_STACK,
5817 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK
5818 })
markchiene46042b2022-03-02 18:07:35 +08005819 public void addUidToMeteredNetworkAllowList(final int uid) {
markchien738ad912021-12-09 18:15:45 +08005820 try {
markchiene46042b2022-03-02 18:07:35 +08005821 mService.updateMeteredNetworkAllowList(uid, true /* add */);
markchien738ad912021-12-09 18:15:45 +08005822 } catch (RemoteException e) {
5823 throw e.rethrowFromSystemServer();
markchien738ad912021-12-09 18:15:45 +08005824 }
5825 }
5826
5827 /**
markchiene46042b2022-03-02 18:07:35 +08005828 * Removes the specified UID from the list of UIDs that are allowed to use background data on
5829 * metered networks when background data is restricted. The deny list takes precedence over
5830 * the allow list.
5831 *
5832 * @param uid uid of target app
5833 * @throws IllegalStateException if updating allow list failed.
5834 * @hide
5835 */
5836 @SystemApi(client = MODULE_LIBRARIES)
5837 @RequiresPermission(anyOf = {
5838 android.Manifest.permission.NETWORK_SETTINGS,
5839 android.Manifest.permission.NETWORK_STACK,
5840 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK
5841 })
5842 public void removeUidFromMeteredNetworkAllowList(final int uid) {
5843 try {
5844 mService.updateMeteredNetworkAllowList(uid, false /* remove */);
5845 } catch (RemoteException e) {
5846 throw e.rethrowFromSystemServer();
5847 }
5848 }
5849
5850 /**
5851 * Adds the specified UID to the list of UIDs that are not allowed to use background data on
5852 * metered networks. Takes precedence over {@link #addUidToMeteredNetworkAllowList}.
markchien738ad912021-12-09 18:15:45 +08005853 *
5854 * @param uid uid of target app
markchien68cfadc2022-01-14 13:39:54 +08005855 * @throws IllegalStateException if updating deny list failed.
markchien738ad912021-12-09 18:15:45 +08005856 * @hide
5857 */
5858 @SystemApi(client = MODULE_LIBRARIES)
5859 @RequiresPermission(anyOf = {
5860 android.Manifest.permission.NETWORK_SETTINGS,
5861 android.Manifest.permission.NETWORK_STACK,
5862 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK
5863 })
markchiene46042b2022-03-02 18:07:35 +08005864 public void addUidToMeteredNetworkDenyList(final int uid) {
markchien738ad912021-12-09 18:15:45 +08005865 try {
markchiene46042b2022-03-02 18:07:35 +08005866 mService.updateMeteredNetworkDenyList(uid, true /* add */);
5867 } catch (RemoteException e) {
5868 throw e.rethrowFromSystemServer();
5869 }
5870 }
5871
5872 /**
Chalard Jean0c7ebe92022-08-03 14:45:47 +09005873 * Removes the specified UID from the list of UIDs that can use background data on metered
markchiene46042b2022-03-02 18:07:35 +08005874 * networks if background data is not restricted. The deny list takes precedence over the
5875 * allow list.
5876 *
5877 * @param uid uid of target app
5878 * @throws IllegalStateException if updating deny list failed.
5879 * @hide
5880 */
5881 @SystemApi(client = MODULE_LIBRARIES)
5882 @RequiresPermission(anyOf = {
5883 android.Manifest.permission.NETWORK_SETTINGS,
5884 android.Manifest.permission.NETWORK_STACK,
5885 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK
5886 })
5887 public void removeUidFromMeteredNetworkDenyList(final int uid) {
5888 try {
5889 mService.updateMeteredNetworkDenyList(uid, false /* remove */);
markchien738ad912021-12-09 18:15:45 +08005890 } catch (RemoteException e) {
5891 throw e.rethrowFromSystemServer();
markchiene1561fa2021-12-09 22:00:56 +08005892 }
5893 }
5894
5895 /**
5896 * Sets a firewall rule for the specified UID on the specified chain.
5897 *
5898 * @param chain target chain.
5899 * @param uid uid to allow/deny.
markchien3c04e662022-03-22 16:29:56 +08005900 * @param rule firewall rule to allow/drop packets.
markchien68cfadc2022-01-14 13:39:54 +08005901 * @throws IllegalStateException if updating firewall rule failed.
markchien3c04e662022-03-22 16:29:56 +08005902 * @throws IllegalArgumentException if {@code rule} is not a valid rule.
markchiene1561fa2021-12-09 22:00:56 +08005903 * @hide
5904 */
5905 @SystemApi(client = MODULE_LIBRARIES)
5906 @RequiresPermission(anyOf = {
5907 android.Manifest.permission.NETWORK_SETTINGS,
5908 android.Manifest.permission.NETWORK_STACK,
5909 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK
5910 })
markchien3c04e662022-03-22 16:29:56 +08005911 public void setUidFirewallRule(@FirewallChain final int chain, final int uid,
5912 @FirewallRule final int rule) {
markchiene1561fa2021-12-09 22:00:56 +08005913 try {
markchien3c04e662022-03-22 16:29:56 +08005914 mService.setUidFirewallRule(chain, uid, rule);
markchiene1561fa2021-12-09 22:00:56 +08005915 } catch (RemoteException e) {
5916 throw e.rethrowFromSystemServer();
markchien738ad912021-12-09 18:15:45 +08005917 }
5918 }
markchien98a6f952022-01-13 23:43:53 +08005919
5920 /**
5921 * Enables or disables the specified firewall chain.
5922 *
5923 * @param chain target chain.
5924 * @param enable whether the chain should be enabled.
Motomu Utsumi18b287d2022-06-19 10:45:30 +00005925 * @throws UnsupportedOperationException if called on pre-T devices.
markchien68cfadc2022-01-14 13:39:54 +08005926 * @throws IllegalStateException if enabling or disabling the firewall chain failed.
markchien98a6f952022-01-13 23:43:53 +08005927 * @hide
5928 */
5929 @SystemApi(client = MODULE_LIBRARIES)
5930 @RequiresPermission(anyOf = {
5931 android.Manifest.permission.NETWORK_SETTINGS,
5932 android.Manifest.permission.NETWORK_STACK,
5933 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK
5934 })
5935 public void setFirewallChainEnabled(@FirewallChain final int chain, final boolean enable) {
5936 try {
5937 mService.setFirewallChainEnabled(chain, enable);
5938 } catch (RemoteException e) {
5939 throw e.rethrowFromSystemServer();
5940 }
5941 }
markchien00a0bed2022-01-13 23:46:13 +08005942
5943 /**
Motomu Utsumi25cf86f2022-06-27 08:50:19 +00005944 * Get the specified firewall chain's status.
Motomu Utsumibe3ff1e2022-06-08 10:05:07 +00005945 *
5946 * @param chain target chain.
5947 * @return {@code true} if chain is enabled, {@code false} if chain is disabled.
5948 * @throws UnsupportedOperationException if called on pre-T devices.
Motomu Utsumibe3ff1e2022-06-08 10:05:07 +00005949 * @throws ServiceSpecificException in case of failure, with an error code indicating the
5950 * cause of the failure.
5951 * @hide
5952 */
5953 @RequiresPermission(anyOf = {
5954 android.Manifest.permission.NETWORK_SETTINGS,
5955 android.Manifest.permission.NETWORK_STACK,
5956 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK
5957 })
5958 public boolean getFirewallChainEnabled(@FirewallChain final int chain) {
5959 try {
5960 return mService.getFirewallChainEnabled(chain);
5961 } catch (RemoteException e) {
5962 throw e.rethrowFromSystemServer();
5963 }
5964 }
5965
5966 /**
markchien00a0bed2022-01-13 23:46:13 +08005967 * Replaces the contents of the specified UID-based firewall chain.
5968 *
5969 * @param chain target chain to replace.
5970 * @param uids The list of UIDs to be placed into chain.
Motomu Utsumi9be2ea02022-07-05 06:14:59 +00005971 * @throws UnsupportedOperationException if called on pre-T devices.
markchien00a0bed2022-01-13 23:46:13 +08005972 * @throws IllegalArgumentException if {@code chain} is not a valid chain.
5973 * @hide
5974 */
5975 @SystemApi(client = MODULE_LIBRARIES)
5976 @RequiresPermission(anyOf = {
5977 android.Manifest.permission.NETWORK_SETTINGS,
5978 android.Manifest.permission.NETWORK_STACK,
5979 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK
5980 })
5981 public void replaceFirewallChain(@FirewallChain final int chain, @NonNull final int[] uids) {
5982 Objects.requireNonNull(uids);
5983 try {
5984 mService.replaceFirewallChain(chain, uids);
5985 } catch (RemoteException e) {
5986 throw e.rethrowFromSystemServer();
5987 }
5988 }
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005989}