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