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