blob: 3939c7f4410281b3594dcc322e88162ebf2e0520 [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 /**
453 * Invalid tethering type.
454 * @see #startTethering(int, boolean, OnStartTetheringCallback)
455 * @hide
456 */
457 public static final int TETHERING_INVALID = TetheringManager.TETHERING_INVALID;
458
459 /**
460 * Wifi tethering type.
461 * @see #startTethering(int, boolean, OnStartTetheringCallback)
462 * @hide
463 */
464 @SystemApi
Remi NGUYEN VAN71ced8e2021-02-15 18:52:06 +0900465 public static final int TETHERING_WIFI = 0;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +0900466
467 /**
468 * USB tethering type.
469 * @see #startTethering(int, boolean, OnStartTetheringCallback)
470 * @hide
471 */
472 @SystemApi
Remi NGUYEN VAN71ced8e2021-02-15 18:52:06 +0900473 public static final int TETHERING_USB = 1;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +0900474
475 /**
476 * Bluetooth tethering type.
477 * @see #startTethering(int, boolean, OnStartTetheringCallback)
478 * @hide
479 */
480 @SystemApi
Remi NGUYEN VAN71ced8e2021-02-15 18:52:06 +0900481 public static final int TETHERING_BLUETOOTH = 2;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +0900482
483 /**
484 * Wifi P2p tethering type.
485 * Wifi P2p tethering is set through events automatically, and don't
486 * need to start from #startTethering(int, boolean, OnStartTetheringCallback).
487 * @hide
488 */
489 public static final int TETHERING_WIFI_P2P = TetheringManager.TETHERING_WIFI_P2P;
490
491 /**
492 * Extra used for communicating with the TetherService. Includes the type of tethering to
493 * enable if any.
494 * @hide
495 */
496 public static final String EXTRA_ADD_TETHER_TYPE = TetheringConstants.EXTRA_ADD_TETHER_TYPE;
497
498 /**
499 * Extra used for communicating with the TetherService. Includes the type of tethering for
500 * which to cancel provisioning.
501 * @hide
502 */
503 public static final String EXTRA_REM_TETHER_TYPE = TetheringConstants.EXTRA_REM_TETHER_TYPE;
504
505 /**
506 * Extra used for communicating with the TetherService. True to schedule a recheck of tether
507 * provisioning.
508 * @hide
509 */
510 public static final String EXTRA_SET_ALARM = TetheringConstants.EXTRA_SET_ALARM;
511
512 /**
513 * Tells the TetherService to run a provision check now.
514 * @hide
515 */
516 public static final String EXTRA_RUN_PROVISION = TetheringConstants.EXTRA_RUN_PROVISION;
517
518 /**
519 * Extra used for communicating with the TetherService. Contains the {@link ResultReceiver}
520 * which will receive provisioning results. Can be left empty.
521 * @hide
522 */
523 public static final String EXTRA_PROVISION_CALLBACK =
524 TetheringConstants.EXTRA_PROVISION_CALLBACK;
525
526 /**
527 * The absence of a connection type.
528 * @hide
529 */
530 @SystemApi
531 public static final int TYPE_NONE = -1;
532
533 /**
534 * A Mobile data connection. Devices may support more than one.
535 *
536 * @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or
537 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an
538 * appropriate network. {@see NetworkCapabilities} for supported transports.
539 */
540 @Deprecated
541 public static final int TYPE_MOBILE = 0;
542
543 /**
544 * A WIFI data connection. Devices may support more than one.
545 *
546 * @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or
547 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an
548 * appropriate network. {@see NetworkCapabilities} for supported transports.
549 */
550 @Deprecated
551 public static final int TYPE_WIFI = 1;
552
553 /**
554 * An MMS-specific Mobile data connection. This network type may use the
555 * same network interface as {@link #TYPE_MOBILE} or it may use a different
556 * one. This is used by applications needing to talk to the carrier's
557 * Multimedia Messaging Service servers.
558 *
559 * @deprecated Applications should instead use {@link NetworkCapabilities#hasCapability} or
560 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request a network that
561 * provides the {@link NetworkCapabilities#NET_CAPABILITY_MMS} capability.
562 */
563 @Deprecated
564 public static final int TYPE_MOBILE_MMS = 2;
565
566 /**
567 * A SUPL-specific Mobile data connection. This network type may use the
568 * same network interface as {@link #TYPE_MOBILE} or it may use a different
569 * one. This is used by applications needing to talk to the carrier's
570 * Secure User Plane Location servers for help locating the device.
571 *
572 * @deprecated Applications should instead use {@link NetworkCapabilities#hasCapability} or
573 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request a network that
574 * provides the {@link NetworkCapabilities#NET_CAPABILITY_SUPL} capability.
575 */
576 @Deprecated
577 public static final int TYPE_MOBILE_SUPL = 3;
578
579 /**
580 * A DUN-specific Mobile data connection. This network type may use the
581 * same network interface as {@link #TYPE_MOBILE} or it may use a different
582 * one. This is sometimes by the system when setting up an upstream connection
583 * for tethering so that the carrier is aware of DUN traffic.
584 *
585 * @deprecated Applications should instead use {@link NetworkCapabilities#hasCapability} or
586 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request a network that
587 * provides the {@link NetworkCapabilities#NET_CAPABILITY_DUN} capability.
588 */
589 @Deprecated
590 public static final int TYPE_MOBILE_DUN = 4;
591
592 /**
593 * A High Priority Mobile data connection. This network type uses the
594 * same network interface as {@link #TYPE_MOBILE} but the routing setup
595 * is different.
596 *
597 * @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or
598 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an
599 * appropriate network. {@see NetworkCapabilities} for supported transports.
600 */
601 @Deprecated
602 public static final int TYPE_MOBILE_HIPRI = 5;
603
604 /**
605 * A WiMAX data connection.
606 *
607 * @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or
608 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an
609 * appropriate network. {@see NetworkCapabilities} for supported transports.
610 */
611 @Deprecated
612 public static final int TYPE_WIMAX = 6;
613
614 /**
615 * A Bluetooth data connection.
616 *
617 * @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or
618 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an
619 * appropriate network. {@see NetworkCapabilities} for supported transports.
620 */
621 @Deprecated
622 public static final int TYPE_BLUETOOTH = 7;
623
624 /**
625 * Fake data connection. This should not be used on shipping devices.
626 * @deprecated This is not used any more.
627 */
628 @Deprecated
629 public static final int TYPE_DUMMY = 8;
630
631 /**
632 * An Ethernet data connection.
633 *
634 * @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or
635 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an
636 * appropriate network. {@see NetworkCapabilities} for supported transports.
637 */
638 @Deprecated
639 public static final int TYPE_ETHERNET = 9;
640
641 /**
642 * Over the air Administration.
643 * @deprecated Use {@link NetworkCapabilities} instead.
644 * {@hide}
645 */
646 @Deprecated
647 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 130143562)
648 public static final int TYPE_MOBILE_FOTA = 10;
649
650 /**
651 * IP Multimedia Subsystem.
652 * @deprecated Use {@link NetworkCapabilities#NET_CAPABILITY_IMS} instead.
653 * {@hide}
654 */
655 @Deprecated
656 @UnsupportedAppUsage
657 public static final int TYPE_MOBILE_IMS = 11;
658
659 /**
660 * Carrier Branded Services.
661 * @deprecated Use {@link NetworkCapabilities#NET_CAPABILITY_CBS} instead.
662 * {@hide}
663 */
664 @Deprecated
665 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 130143562)
666 public static final int TYPE_MOBILE_CBS = 12;
667
668 /**
669 * A Wi-Fi p2p connection. Only requesting processes will have access to
670 * the peers connected.
671 * @deprecated Use {@link NetworkCapabilities#NET_CAPABILITY_WIFI_P2P} instead.
672 * {@hide}
673 */
674 @Deprecated
675 @SystemApi
676 public static final int TYPE_WIFI_P2P = 13;
677
678 /**
679 * The network to use for initially attaching to the network
680 * @deprecated Use {@link NetworkCapabilities#NET_CAPABILITY_IA} instead.
681 * {@hide}
682 */
683 @Deprecated
684 @UnsupportedAppUsage
685 public static final int TYPE_MOBILE_IA = 14;
686
687 /**
688 * Emergency PDN connection for emergency services. This
689 * may include IMS and MMS in emergency situations.
690 * @deprecated Use {@link NetworkCapabilities#NET_CAPABILITY_EIMS} instead.
691 * {@hide}
692 */
693 @Deprecated
694 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 130143562)
695 public static final int TYPE_MOBILE_EMERGENCY = 15;
696
697 /**
698 * The network that uses proxy to achieve connectivity.
699 * @deprecated Use {@link NetworkCapabilities} instead.
700 * {@hide}
701 */
702 @Deprecated
703 @SystemApi
704 public static final int TYPE_PROXY = 16;
705
706 /**
707 * A virtual network using one or more native bearers.
708 * It may or may not be providing security services.
709 * @deprecated Applications should use {@link NetworkCapabilities#TRANSPORT_VPN} instead.
710 */
711 @Deprecated
712 public static final int TYPE_VPN = 17;
713
714 /**
715 * A network that is exclusively meant to be used for testing
716 *
717 * @deprecated Use {@link NetworkCapabilities} instead.
718 * @hide
719 */
720 @Deprecated
721 public static final int TYPE_TEST = 18; // TODO: Remove this once NetworkTypes are unused.
722
723 /**
724 * @deprecated Use {@link NetworkCapabilities} instead.
725 * @hide
726 */
727 @Deprecated
728 @Retention(RetentionPolicy.SOURCE)
729 @IntDef(prefix = { "TYPE_" }, value = {
730 TYPE_NONE,
731 TYPE_MOBILE,
732 TYPE_WIFI,
733 TYPE_MOBILE_MMS,
734 TYPE_MOBILE_SUPL,
735 TYPE_MOBILE_DUN,
736 TYPE_MOBILE_HIPRI,
737 TYPE_WIMAX,
738 TYPE_BLUETOOTH,
739 TYPE_DUMMY,
740 TYPE_ETHERNET,
741 TYPE_MOBILE_FOTA,
742 TYPE_MOBILE_IMS,
743 TYPE_MOBILE_CBS,
744 TYPE_WIFI_P2P,
745 TYPE_MOBILE_IA,
746 TYPE_MOBILE_EMERGENCY,
747 TYPE_PROXY,
748 TYPE_VPN,
749 TYPE_TEST
750 })
751 public @interface LegacyNetworkType {}
752
753 // Deprecated constants for return values of startUsingNetworkFeature. They used to live
754 // in com.android.internal.telephony.PhoneConstants until they were made inaccessible.
755 private static final int DEPRECATED_PHONE_CONSTANT_APN_ALREADY_ACTIVE = 0;
756 private static final int DEPRECATED_PHONE_CONSTANT_APN_REQUEST_STARTED = 1;
757 private static final int DEPRECATED_PHONE_CONSTANT_APN_REQUEST_FAILED = 3;
758
759 /** {@hide} */
760 public static final int MAX_RADIO_TYPE = TYPE_TEST;
761
762 /** {@hide} */
763 public static final int MAX_NETWORK_TYPE = TYPE_TEST;
764
765 private static final int MIN_NETWORK_TYPE = TYPE_MOBILE;
766
767 /**
768 * If you want to set the default network preference,you can directly
769 * change the networkAttributes array in framework's config.xml.
770 *
771 * @deprecated Since we support so many more networks now, the single
772 * network default network preference can't really express
773 * the hierarchy. Instead, the default is defined by the
774 * networkAttributes in config.xml. You can determine
775 * the current value by calling {@link #getNetworkPreference()}
776 * from an App.
777 */
778 @Deprecated
779 public static final int DEFAULT_NETWORK_PREFERENCE = TYPE_WIFI;
780
781 /**
782 * @hide
783 */
784 public static final int REQUEST_ID_UNSET = 0;
785
786 /**
787 * Static unique request used as a tombstone for NetworkCallbacks that have been unregistered.
788 * This allows to distinguish when unregistering NetworkCallbacks those that were never
789 * registered from those that were already unregistered.
790 * @hide
791 */
792 private static final NetworkRequest ALREADY_UNREGISTERED =
793 new NetworkRequest.Builder().clearCapabilities().build();
794
795 /**
796 * A NetID indicating no Network is selected.
797 * Keep in sync with bionic/libc/dns/include/resolv_netid.h
798 * @hide
799 */
800 public static final int NETID_UNSET = 0;
801
802 /**
803 * Private DNS Mode values.
804 *
805 * The "private_dns_mode" global setting stores a String value which is
806 * expected to be one of the following.
807 */
808
809 /**
810 * @hide
811 */
lucaslin180f44f2021-03-12 16:11:27 +0800812 @SystemApi(client = MODULE_LIBRARIES)
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +0900813 public static final String PRIVATE_DNS_MODE_OFF = "off";
814 /**
815 * @hide
816 */
lucaslin180f44f2021-03-12 16:11:27 +0800817 @SystemApi(client = MODULE_LIBRARIES)
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +0900818 public static final String PRIVATE_DNS_MODE_OPPORTUNISTIC = "opportunistic";
819 /**
820 * @hide
821 */
lucaslin180f44f2021-03-12 16:11:27 +0800822 @SystemApi(client = MODULE_LIBRARIES)
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +0900823 public static final String PRIVATE_DNS_MODE_PROVIDER_HOSTNAME = "hostname";
lucaslin180f44f2021-03-12 16:11:27 +0800824
825 /** @hide */
826 @Retention(RetentionPolicy.SOURCE)
827 @StringDef(value = {
828 PRIVATE_DNS_MODE_OFF,
829 PRIVATE_DNS_MODE_OPPORTUNISTIC,
830 PRIVATE_DNS_MODE_PROVIDER_HOSTNAME,
831 })
832 public @interface PrivateDnsMode {}
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +0900833
Sudheer Shanka1d0d9b42021-03-23 08:12:28 +0000834 /**
835 * Flag to indicate that an app is not subject to any restrictions that could result in its
836 * network access blocked.
837 *
838 * @hide
839 */
840 @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
841 public static final int BLOCKED_REASON_NONE = 0;
842
843 /**
844 * Flag to indicate that an app is subject to Battery saver restrictions that would
845 * result in its network access being blocked.
846 *
847 * @hide
848 */
849 @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
850 public static final int BLOCKED_REASON_BATTERY_SAVER = 1 << 0;
851
852 /**
853 * Flag to indicate that an app is subject to Doze 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_DOZE = 1 << 1;
860
861 /**
862 * Flag to indicate that an app is subject to App Standby 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_APP_STANDBY = 1 << 2;
869
870 /**
871 * Flag to indicate that an app is subject to Restricted mode 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_RESTRICTED_MODE = 1 << 3;
878
879 /**
Lorenzo Colitti8ad58122021-03-18 00:54:57 +0900880 * Flag to indicate that an app is blocked because it is subject to an always-on VPN but the VPN
881 * is not currently connected.
882 *
883 * @see DevicePolicyManager#setAlwaysOnVpnPackage(ComponentName, String, boolean)
884 *
885 * @hide
886 */
887 @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
888 public static final int BLOCKED_REASON_LOCKDOWN_VPN = 1 << 4;
889
890 /**
Sudheer Shanka1d0d9b42021-03-23 08:12:28 +0000891 * Flag to indicate that an app is subject to Data saver restrictions that would
892 * result in its metered network access being blocked.
893 *
894 * @hide
895 */
896 @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
897 public static final int BLOCKED_METERED_REASON_DATA_SAVER = 1 << 16;
898
899 /**
900 * Flag to indicate that an app is subject to user 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_USER_RESTRICTED = 1 << 17;
907
908 /**
909 * Flag to indicate that an app is subject to Device admin 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_ADMIN_DISABLED = 1 << 18;
916
917 /**
918 * @hide
919 */
920 @Retention(RetentionPolicy.SOURCE)
921 @IntDef(flag = true, prefix = {"BLOCKED_"}, value = {
922 BLOCKED_REASON_NONE,
923 BLOCKED_REASON_BATTERY_SAVER,
924 BLOCKED_REASON_DOZE,
925 BLOCKED_REASON_APP_STANDBY,
926 BLOCKED_REASON_RESTRICTED_MODE,
927 BLOCKED_METERED_REASON_DATA_SAVER,
928 BLOCKED_METERED_REASON_USER_RESTRICTED,
929 BLOCKED_METERED_REASON_ADMIN_DISABLED,
930 })
931 public @interface BlockedReason {}
932
Lorenzo Colitti8ad58122021-03-18 00:54:57 +0900933 /**
934 * Set of blocked reasons that are only applicable on metered networks.
935 *
936 * @hide
937 */
938 @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
939 public static final int BLOCKED_METERED_REASON_MASK = 0xffff0000;
940
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +0900941 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 130143562)
942 private final IConnectivityManager mService;
Lorenzo Colitti842075e2021-02-04 17:32:07 +0900943
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +0900944 /**
945 * A kludge to facilitate static access where a Context pointer isn't available, like in the
946 * case of the static set/getProcessDefaultNetwork methods and from the Network class.
947 * TODO: Remove this after deprecating the static methods in favor of non-static methods or
948 * methods that take a Context argument.
949 */
950 private static ConnectivityManager sInstance;
951
952 private final Context mContext;
953
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +0900954 private final TetheringManager mTetheringManager;
955
956 /**
957 * Tests if a given integer represents a valid network type.
958 * @param networkType the type to be tested
959 * @return a boolean. {@code true} if the type is valid, else {@code false}
960 * @deprecated All APIs accepting a network type are deprecated. There should be no need to
961 * validate a network type.
962 */
963 @Deprecated
964 public static boolean isNetworkTypeValid(int networkType) {
965 return MIN_NETWORK_TYPE <= networkType && networkType <= MAX_NETWORK_TYPE;
966 }
967
968 /**
969 * Returns a non-localized string representing a given network type.
970 * ONLY used for debugging output.
971 * @param type the type needing naming
972 * @return a String for the given type, or a string version of the type ("87")
973 * if no name is known.
974 * @deprecated Types are deprecated. Use {@link NetworkCapabilities} instead.
975 * {@hide}
976 */
977 @Deprecated
978 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
979 public static String getNetworkTypeName(int type) {
980 switch (type) {
981 case TYPE_NONE:
982 return "NONE";
983 case TYPE_MOBILE:
984 return "MOBILE";
985 case TYPE_WIFI:
986 return "WIFI";
987 case TYPE_MOBILE_MMS:
988 return "MOBILE_MMS";
989 case TYPE_MOBILE_SUPL:
990 return "MOBILE_SUPL";
991 case TYPE_MOBILE_DUN:
992 return "MOBILE_DUN";
993 case TYPE_MOBILE_HIPRI:
994 return "MOBILE_HIPRI";
995 case TYPE_WIMAX:
996 return "WIMAX";
997 case TYPE_BLUETOOTH:
998 return "BLUETOOTH";
999 case TYPE_DUMMY:
1000 return "DUMMY";
1001 case TYPE_ETHERNET:
1002 return "ETHERNET";
1003 case TYPE_MOBILE_FOTA:
1004 return "MOBILE_FOTA";
1005 case TYPE_MOBILE_IMS:
1006 return "MOBILE_IMS";
1007 case TYPE_MOBILE_CBS:
1008 return "MOBILE_CBS";
1009 case TYPE_WIFI_P2P:
1010 return "WIFI_P2P";
1011 case TYPE_MOBILE_IA:
1012 return "MOBILE_IA";
1013 case TYPE_MOBILE_EMERGENCY:
1014 return "MOBILE_EMERGENCY";
1015 case TYPE_PROXY:
1016 return "PROXY";
1017 case TYPE_VPN:
1018 return "VPN";
1019 default:
1020 return Integer.toString(type);
1021 }
1022 }
1023
1024 /**
1025 * @hide
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001026 */
lucaslin10774b72021-03-17 14:16:01 +08001027 @SystemApi(client = MODULE_LIBRARIES)
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001028 public void systemReady() {
1029 try {
1030 mService.systemReady();
1031 } catch (RemoteException e) {
1032 throw e.rethrowFromSystemServer();
1033 }
1034 }
1035
1036 /**
1037 * Checks if a given type uses the cellular data connection.
1038 * This should be replaced in the future by a network property.
1039 * @param networkType the type to check
1040 * @return a boolean - {@code true} if uses cellular network, else {@code false}
1041 * @deprecated Types are deprecated. Use {@link NetworkCapabilities} instead.
1042 * {@hide}
1043 */
1044 @Deprecated
1045 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 130143562)
1046 public static boolean isNetworkTypeMobile(int networkType) {
1047 switch (networkType) {
1048 case TYPE_MOBILE:
1049 case TYPE_MOBILE_MMS:
1050 case TYPE_MOBILE_SUPL:
1051 case TYPE_MOBILE_DUN:
1052 case TYPE_MOBILE_HIPRI:
1053 case TYPE_MOBILE_FOTA:
1054 case TYPE_MOBILE_IMS:
1055 case TYPE_MOBILE_CBS:
1056 case TYPE_MOBILE_IA:
1057 case TYPE_MOBILE_EMERGENCY:
1058 return true;
1059 default:
1060 return false;
1061 }
1062 }
1063
1064 /**
1065 * Checks if the given network type is backed by a Wi-Fi radio.
1066 *
1067 * @deprecated Types are deprecated. Use {@link NetworkCapabilities} instead.
1068 * @hide
1069 */
1070 @Deprecated
1071 public static boolean isNetworkTypeWifi(int networkType) {
1072 switch (networkType) {
1073 case TYPE_WIFI:
1074 case TYPE_WIFI_P2P:
1075 return true;
1076 default:
1077 return false;
1078 }
1079 }
1080
1081 /**
Chalard Jeanad565e22021-02-25 17:23:40 +09001082 * Preference for {@link #setNetworkPreferenceForUser(UserHandle, int, Executor, Runnable)}.
1083 * Specify that the traffic for this user should by follow the default rules.
1084 * @hide
1085 */
Chalard Jeanbef6b092021-03-17 14:33:24 +09001086 @SystemApi(client = MODULE_LIBRARIES)
Chalard Jeanad565e22021-02-25 17:23:40 +09001087 public static final int PROFILE_NETWORK_PREFERENCE_DEFAULT = 0;
1088
1089 /**
1090 * Preference for {@link #setNetworkPreferenceForUser(UserHandle, int, Executor, Runnable)}.
1091 * Specify that the traffic for this user should by default go on a network with
1092 * {@link NetworkCapabilities#NET_CAPABILITY_ENTERPRISE}, and on the system default network
1093 * if no such network is available.
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_ENTERPRISE = 1;
1098
1099 /** @hide */
1100 @Retention(RetentionPolicy.SOURCE)
1101 @IntDef(value = {
1102 PROFILE_NETWORK_PREFERENCE_DEFAULT,
1103 PROFILE_NETWORK_PREFERENCE_ENTERPRISE
1104 })
1105 public @interface ProfileNetworkPreference {
1106 }
1107
1108 /**
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001109 * Specifies the preferred network type. When the device has more
1110 * than one type available the preferred network type will be used.
1111 *
1112 * @param preference the network type to prefer over all others. It is
1113 * unspecified what happens to the old preferred network in the
1114 * overall ordering.
1115 * @deprecated Functionality has been removed as it no longer makes sense,
1116 * with many more than two networks - we'd need an array to express
1117 * preference. Instead we use dynamic network properties of
1118 * the networks to describe their precedence.
1119 */
1120 @Deprecated
1121 public void setNetworkPreference(int preference) {
1122 }
1123
1124 /**
1125 * Retrieves the current preferred network type.
1126 *
1127 * @return an integer representing the preferred network type
1128 *
1129 * @deprecated Functionality has been removed as it no longer makes sense,
1130 * with many more than two networks - we'd need an array to express
1131 * preference. Instead we use dynamic network properties of
1132 * the networks to describe their precedence.
1133 */
1134 @Deprecated
1135 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1136 public int getNetworkPreference() {
1137 return TYPE_NONE;
1138 }
1139
1140 /**
1141 * Returns details about the currently active default data network. When
1142 * connected, this network is the default route for outgoing connections.
1143 * You should always check {@link NetworkInfo#isConnected()} before initiating
1144 * network traffic. This may return {@code null} when there is no default
1145 * network.
1146 * Note that if the default network is a VPN, this method will return the
1147 * NetworkInfo for one of its underlying networks instead, or null if the
1148 * VPN agent did not specify any. Apps interested in learning about VPNs
1149 * should use {@link #getNetworkInfo(android.net.Network)} instead.
1150 *
1151 * @return a {@link NetworkInfo} object for the current default network
1152 * or {@code null} if no default network is currently active
1153 * @deprecated See {@link NetworkInfo}.
1154 */
1155 @Deprecated
1156 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1157 @Nullable
1158 public NetworkInfo getActiveNetworkInfo() {
1159 try {
1160 return mService.getActiveNetworkInfo();
1161 } catch (RemoteException e) {
1162 throw e.rethrowFromSystemServer();
1163 }
1164 }
1165
1166 /**
1167 * Returns a {@link Network} object corresponding to the currently active
1168 * default data network. In the event that the current active default data
1169 * network disconnects, the returned {@code Network} object will no longer
1170 * be usable. This will return {@code null} when there is no default
1171 * network.
1172 *
1173 * @return a {@link Network} object for the current default network or
1174 * {@code null} if no default network is currently active
1175 */
1176 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1177 @Nullable
1178 public Network getActiveNetwork() {
1179 try {
1180 return mService.getActiveNetwork();
1181 } catch (RemoteException e) {
1182 throw e.rethrowFromSystemServer();
1183 }
1184 }
1185
1186 /**
1187 * Returns a {@link Network} object corresponding to the currently active
1188 * default data network for a specific UID. In the event that the default data
1189 * network disconnects, the returned {@code Network} object will no longer
1190 * be usable. This will return {@code null} when there is no default
1191 * network for the UID.
1192 *
1193 * @return a {@link Network} object for the current default network for the
1194 * given UID or {@code null} if no default network is currently active
lifr308bccc2021-03-11 20:11:09 +08001195 * TODO: b/183465229 Cleanup getActiveNetworkForUid once b/165835257 is fixed
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001196 */
1197 @RequiresPermission(android.Manifest.permission.NETWORK_STACK)
1198 @Nullable
1199 public Network getActiveNetworkForUid(int uid) {
1200 return getActiveNetworkForUid(uid, false);
1201 }
1202
1203 /** {@hide} */
1204 public Network getActiveNetworkForUid(int uid, boolean ignoreBlocked) {
1205 try {
1206 return mService.getActiveNetworkForUid(uid, ignoreBlocked);
1207 } catch (RemoteException e) {
1208 throw e.rethrowFromSystemServer();
1209 }
1210 }
1211
1212 /**
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001213 * Adds or removes a requirement for given UID ranges to use the VPN.
1214 *
1215 * If set to {@code true}, informs the system that the UIDs in the specified ranges must not
1216 * have any connectivity except if a VPN is connected and applies to the UIDs, or if the UIDs
1217 * otherwise have permission to bypass the VPN (e.g., because they have the
1218 * {@link android.Manifest.permission.CONNECTIVITY_USE_RESTRICTED_NETWORKS} permission, or when
1219 * using a socket protected by a method such as {@link VpnService#protect(DatagramSocket)}. If
1220 * set to {@code false}, a previously-added restriction is removed.
1221 * <p>
1222 * Each of the UID ranges specified by this method is added and removed as is, and no processing
1223 * is performed on the ranges to de-duplicate, merge, split, or intersect them. In order to
1224 * remove a previously-added range, the exact range must be removed as is.
1225 * <p>
1226 * The changes are applied asynchronously and may not have been applied by the time the method
1227 * returns. Apps will be notified about any changes that apply to them via
1228 * {@link NetworkCallback#onBlockedStatusChanged} callbacks called after the changes take
1229 * effect.
1230 * <p>
1231 * This method should be called only by the VPN code.
1232 *
1233 * @param ranges the UID ranges to restrict
1234 * @param requireVpn whether the specified UID ranges must use a VPN
1235 *
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001236 * @hide
1237 */
1238 @RequiresPermission(anyOf = {
1239 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
lucaslin97fb10a2021-03-22 11:51:27 +08001240 android.Manifest.permission.NETWORK_STACK,
1241 android.Manifest.permission.NETWORK_SETTINGS})
1242 @SystemApi(client = MODULE_LIBRARIES)
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001243 public void setRequireVpnForUids(boolean requireVpn,
1244 @NonNull Collection<Range<Integer>> ranges) {
1245 Objects.requireNonNull(ranges);
1246 // The Range class is not parcelable. Convert to UidRange, which is what is used internally.
1247 // This method is not necessarily expected to be used outside the system server, so
1248 // parceling may not be necessary, but it could be used out-of-process, e.g., by the network
1249 // stack process, or by tests.
1250 UidRange[] rangesArray = new UidRange[ranges.size()];
1251 int index = 0;
1252 for (Range<Integer> range : ranges) {
1253 rangesArray[index++] = new UidRange(range.getLower(), range.getUpper());
1254 }
1255 try {
1256 mService.setRequireVpnForUids(requireVpn, rangesArray);
1257 } catch (RemoteException e) {
1258 throw e.rethrowFromSystemServer();
1259 }
1260 }
1261
1262 /**
Lorenzo Colittic71cff82021-01-15 01:29:01 +09001263 * Informs ConnectivityService of whether the legacy lockdown VPN, as implemented by
1264 * LockdownVpnTracker, is in use. This is deprecated for new devices starting from Android 12
1265 * but is still supported for backwards compatibility.
1266 * <p>
1267 * This type of VPN is assumed always to use the system default network, and must always declare
1268 * exactly one underlying network, which is the network that was the default when the VPN
1269 * connected.
1270 * <p>
1271 * Calling this method with {@code true} enables legacy behaviour, specifically:
1272 * <ul>
1273 * <li>Any VPN that applies to userId 0 behaves specially with respect to deprecated
1274 * {@link #CONNECTIVITY_ACTION} broadcasts. Any such broadcasts will have the state in the
1275 * {@link #EXTRA_NETWORK_INFO} replaced by state of the VPN network. Also, any time the VPN
1276 * connects, a {@link #CONNECTIVITY_ACTION} broadcast will be sent for the network
1277 * underlying the VPN.</li>
1278 * <li>Deprecated APIs that return {@link NetworkInfo} objects will have their state
1279 * similarly replaced by the VPN network state.</li>
1280 * <li>Information on current network interfaces passed to NetworkStatsService will not
1281 * include any VPN interfaces.</li>
1282 * </ul>
1283 *
1284 * @param enabled whether legacy lockdown VPN is enabled or disabled
1285 *
Lorenzo Colittic71cff82021-01-15 01:29:01 +09001286 * @hide
1287 */
1288 @RequiresPermission(anyOf = {
1289 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
lucaslin97fb10a2021-03-22 11:51:27 +08001290 android.Manifest.permission.NETWORK_STACK,
Lorenzo Colittic71cff82021-01-15 01:29:01 +09001291 android.Manifest.permission.NETWORK_SETTINGS})
lucaslin97fb10a2021-03-22 11:51:27 +08001292 @SystemApi(client = MODULE_LIBRARIES)
Lorenzo Colittic71cff82021-01-15 01:29:01 +09001293 public void setLegacyLockdownVpnEnabled(boolean enabled) {
1294 try {
1295 mService.setLegacyLockdownVpnEnabled(enabled);
1296 } catch (RemoteException e) {
1297 throw e.rethrowFromSystemServer();
1298 }
1299 }
1300
1301 /**
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001302 * Returns details about the currently active default data network
1303 * for a given uid. This is for internal use only to avoid spying
1304 * other apps.
1305 *
1306 * @return a {@link NetworkInfo} object for the current default network
1307 * for the given uid or {@code null} if no default network is
1308 * available for the specified uid.
1309 *
1310 * {@hide}
1311 */
1312 @RequiresPermission(android.Manifest.permission.NETWORK_STACK)
1313 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
1314 public NetworkInfo getActiveNetworkInfoForUid(int uid) {
1315 return getActiveNetworkInfoForUid(uid, false);
1316 }
1317
1318 /** {@hide} */
1319 public NetworkInfo getActiveNetworkInfoForUid(int uid, boolean ignoreBlocked) {
1320 try {
1321 return mService.getActiveNetworkInfoForUid(uid, ignoreBlocked);
1322 } catch (RemoteException e) {
1323 throw e.rethrowFromSystemServer();
1324 }
1325 }
1326
1327 /**
1328 * Returns connection status information about a particular
1329 * network type.
1330 *
1331 * @param networkType integer specifying which networkType in
1332 * which you're interested.
1333 * @return a {@link NetworkInfo} object for the requested
1334 * network type or {@code null} if the type is not
1335 * supported by the device. If {@code networkType} is
1336 * TYPE_VPN and a VPN is active for the calling app,
1337 * then this method will try to return one of the
1338 * underlying networks for the VPN or null if the
1339 * VPN agent didn't specify any.
1340 *
1341 * @deprecated This method does not support multiple connected networks
1342 * of the same type. Use {@link #getAllNetworks} and
1343 * {@link #getNetworkInfo(android.net.Network)} instead.
1344 */
1345 @Deprecated
1346 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1347 @Nullable
1348 public NetworkInfo getNetworkInfo(int networkType) {
1349 try {
1350 return mService.getNetworkInfo(networkType);
1351 } catch (RemoteException e) {
1352 throw e.rethrowFromSystemServer();
1353 }
1354 }
1355
1356 /**
1357 * Returns connection status information about a particular
1358 * Network.
1359 *
1360 * @param network {@link Network} specifying which network
1361 * in which you're interested.
1362 * @return a {@link NetworkInfo} object for the requested
1363 * network or {@code null} if the {@code Network}
1364 * is not valid.
1365 * @deprecated See {@link NetworkInfo}.
1366 */
1367 @Deprecated
1368 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1369 @Nullable
1370 public NetworkInfo getNetworkInfo(@Nullable Network network) {
1371 return getNetworkInfoForUid(network, Process.myUid(), false);
1372 }
1373
1374 /** {@hide} */
1375 public NetworkInfo getNetworkInfoForUid(Network network, int uid, boolean ignoreBlocked) {
1376 try {
1377 return mService.getNetworkInfoForUid(network, uid, ignoreBlocked);
1378 } catch (RemoteException e) {
1379 throw e.rethrowFromSystemServer();
1380 }
1381 }
1382
1383 /**
1384 * Returns connection status information about all network
1385 * types supported by the device.
1386 *
1387 * @return an array of {@link NetworkInfo} objects. Check each
1388 * {@link NetworkInfo#getType} for which type each applies.
1389 *
1390 * @deprecated This method does not support multiple connected networks
1391 * of the same type. Use {@link #getAllNetworks} and
1392 * {@link #getNetworkInfo(android.net.Network)} instead.
1393 */
1394 @Deprecated
1395 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1396 @NonNull
1397 public NetworkInfo[] getAllNetworkInfo() {
1398 try {
1399 return mService.getAllNetworkInfo();
1400 } catch (RemoteException e) {
1401 throw e.rethrowFromSystemServer();
1402 }
1403 }
1404
1405 /**
junyulaib1211372021-03-03 12:09:05 +08001406 * Return a list of {@link NetworkStateSnapshot}s, one for each network that is currently
1407 * connected.
1408 * @hide
1409 */
1410 @SystemApi(client = MODULE_LIBRARIES)
1411 @RequiresPermission(anyOf = {
1412 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
1413 android.Manifest.permission.NETWORK_STACK,
1414 android.Manifest.permission.NETWORK_SETTINGS})
1415 @NonNull
1416 public List<NetworkStateSnapshot> getAllNetworkStateSnapshot() {
1417 try {
1418 return mService.getAllNetworkStateSnapshot();
1419 } catch (RemoteException e) {
1420 throw e.rethrowFromSystemServer();
1421 }
1422 }
1423
1424 /**
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001425 * Returns the {@link Network} object currently serving a given type, or
1426 * null if the given type is not connected.
1427 *
1428 * @hide
1429 * @deprecated This method does not support multiple connected networks
1430 * of the same type. Use {@link #getAllNetworks} and
1431 * {@link #getNetworkInfo(android.net.Network)} instead.
1432 */
1433 @Deprecated
1434 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1435 @UnsupportedAppUsage
1436 public Network getNetworkForType(int networkType) {
1437 try {
1438 return mService.getNetworkForType(networkType);
1439 } catch (RemoteException e) {
1440 throw e.rethrowFromSystemServer();
1441 }
1442 }
1443
1444 /**
1445 * Returns an array of all {@link Network} currently tracked by the
1446 * framework.
1447 *
1448 * @return an array of {@link Network} objects.
1449 */
1450 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1451 @NonNull
1452 public Network[] getAllNetworks() {
1453 try {
1454 return mService.getAllNetworks();
1455 } catch (RemoteException e) {
1456 throw e.rethrowFromSystemServer();
1457 }
1458 }
1459
1460 /**
Roshan Piuse08bc182020-12-22 15:10:42 -08001461 * Returns an array of {@link NetworkCapabilities} objects, representing
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001462 * the Networks that applications run by the given user will use by default.
1463 * @hide
1464 */
1465 @UnsupportedAppUsage
1466 public NetworkCapabilities[] getDefaultNetworkCapabilitiesForUser(int userId) {
1467 try {
1468 return mService.getDefaultNetworkCapabilitiesForUser(
Roshan Piusa8a477b2020-12-17 14:53:09 -08001469 userId, mContext.getOpPackageName(), getAttributionTag());
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001470 } catch (RemoteException e) {
1471 throw e.rethrowFromSystemServer();
1472 }
1473 }
1474
1475 /**
1476 * Returns the IP information for the current default network.
1477 *
1478 * @return a {@link LinkProperties} object describing the IP info
1479 * for the current default network, or {@code null} if there
1480 * is no current default network.
1481 *
1482 * {@hide}
1483 * @deprecated please use {@link #getLinkProperties(Network)} on the return
1484 * value of {@link #getActiveNetwork()} instead. In particular,
1485 * this method will return non-null LinkProperties even if the
1486 * app is blocked by policy from using this network.
1487 */
1488 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1489 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 109783091)
1490 public LinkProperties getActiveLinkProperties() {
1491 try {
1492 return mService.getActiveLinkProperties();
1493 } catch (RemoteException e) {
1494 throw e.rethrowFromSystemServer();
1495 }
1496 }
1497
1498 /**
1499 * Returns the IP information for a given network type.
1500 *
1501 * @param networkType the network type of interest.
1502 * @return a {@link LinkProperties} object describing the IP info
1503 * for the given networkType, or {@code null} if there is
1504 * no current default network.
1505 *
1506 * {@hide}
1507 * @deprecated This method does not support multiple connected networks
1508 * of the same type. Use {@link #getAllNetworks},
1509 * {@link #getNetworkInfo(android.net.Network)}, and
1510 * {@link #getLinkProperties(android.net.Network)} instead.
1511 */
1512 @Deprecated
1513 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1514 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 130143562)
1515 public LinkProperties getLinkProperties(int networkType) {
1516 try {
1517 return mService.getLinkPropertiesForType(networkType);
1518 } catch (RemoteException e) {
1519 throw e.rethrowFromSystemServer();
1520 }
1521 }
1522
1523 /**
1524 * Get the {@link LinkProperties} for the given {@link Network}. This
1525 * will return {@code null} if the network is unknown.
1526 *
1527 * @param network The {@link Network} object identifying the network in question.
1528 * @return The {@link LinkProperties} for the network, or {@code null}.
1529 */
1530 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1531 @Nullable
1532 public LinkProperties getLinkProperties(@Nullable Network network) {
1533 try {
1534 return mService.getLinkProperties(network);
1535 } catch (RemoteException e) {
1536 throw e.rethrowFromSystemServer();
1537 }
1538 }
1539
1540 /**
Roshan Piuse08bc182020-12-22 15:10:42 -08001541 * Get the {@link NetworkCapabilities} for the given {@link Network}. This
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001542 * will return {@code null} if the network is unknown.
1543 *
Roshan Piuse08bc182020-12-22 15:10:42 -08001544 * This will remove any location sensitive data in {@link TransportInfo} embedded in
1545 * {@link NetworkCapabilities#getTransportInfo()}. Some transport info instances like
1546 * {@link android.net.wifi.WifiInfo} contain location sensitive information. Retrieving
1547 * this location sensitive information (subject to app's location permissions) will be
1548 * noted by system. To include any location sensitive data in {@link TransportInfo},
1549 * use a {@link NetworkCallback} with
1550 * {@link NetworkCallback#FLAG_INCLUDE_LOCATION_INFO} flag.
1551 *
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001552 * @param network The {@link Network} object identifying the network in question.
Roshan Piuse08bc182020-12-22 15:10:42 -08001553 * @return The {@link NetworkCapabilities} for the network, or {@code null}.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001554 */
1555 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1556 @Nullable
1557 public NetworkCapabilities getNetworkCapabilities(@Nullable Network network) {
1558 try {
Roshan Piusa8a477b2020-12-17 14:53:09 -08001559 return mService.getNetworkCapabilities(
1560 network, mContext.getOpPackageName(), getAttributionTag());
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001561 } catch (RemoteException e) {
1562 throw e.rethrowFromSystemServer();
1563 }
1564 }
1565
1566 /**
1567 * Gets a URL that can be used for resolving whether a captive portal is present.
1568 * 1. This URL should respond with a 204 response to a GET request to indicate no captive
1569 * portal is present.
1570 * 2. This URL must be HTTP as redirect responses are used to find captive portal
1571 * sign-in pages. Captive portals cannot respond to HTTPS requests with redirects.
1572 *
1573 * The system network validation may be using different strategies to detect captive portals,
1574 * so this method does not necessarily return a URL used by the system. It only returns a URL
1575 * that may be relevant for other components trying to detect captive portals.
1576 *
1577 * @hide
1578 * @deprecated This API returns URL which is not guaranteed to be one of the URLs used by the
1579 * system.
1580 */
1581 @Deprecated
1582 @SystemApi
1583 @RequiresPermission(android.Manifest.permission.NETWORK_SETTINGS)
1584 public String getCaptivePortalServerUrl() {
1585 try {
1586 return mService.getCaptivePortalServerUrl();
1587 } catch (RemoteException e) {
1588 throw e.rethrowFromSystemServer();
1589 }
1590 }
1591
1592 /**
1593 * Tells the underlying networking system that the caller wants to
1594 * begin using the named feature. The interpretation of {@code feature}
1595 * is completely up to each networking implementation.
1596 *
1597 * <p>This method requires the caller to hold either the
1598 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
1599 * or the ability to modify system settings as determined by
1600 * {@link android.provider.Settings.System#canWrite}.</p>
1601 *
1602 * @param networkType specifies which network the request pertains to
1603 * @param feature the name of the feature to be used
1604 * @return an integer value representing the outcome of the request.
1605 * The interpretation of this value is specific to each networking
1606 * implementation+feature combination, except that the value {@code -1}
1607 * always indicates failure.
1608 *
1609 * @deprecated Deprecated in favor of the cleaner
1610 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} API.
1611 * In {@link VERSION_CODES#M}, and above, this method is unsupported and will
1612 * throw {@code UnsupportedOperationException} if called.
1613 * @removed
1614 */
1615 @Deprecated
1616 public int startUsingNetworkFeature(int networkType, String feature) {
1617 checkLegacyRoutingApiAccess();
1618 NetworkCapabilities netCap = networkCapabilitiesForFeature(networkType, feature);
1619 if (netCap == null) {
1620 Log.d(TAG, "Can't satisfy startUsingNetworkFeature for " + networkType + ", " +
1621 feature);
1622 return DEPRECATED_PHONE_CONSTANT_APN_REQUEST_FAILED;
1623 }
1624
1625 NetworkRequest request = null;
1626 synchronized (sLegacyRequests) {
1627 LegacyRequest l = sLegacyRequests.get(netCap);
1628 if (l != null) {
1629 Log.d(TAG, "renewing startUsingNetworkFeature request " + l.networkRequest);
1630 renewRequestLocked(l);
1631 if (l.currentNetwork != null) {
1632 return DEPRECATED_PHONE_CONSTANT_APN_ALREADY_ACTIVE;
1633 } else {
1634 return DEPRECATED_PHONE_CONSTANT_APN_REQUEST_STARTED;
1635 }
1636 }
1637
1638 request = requestNetworkForFeatureLocked(netCap);
1639 }
1640 if (request != null) {
1641 Log.d(TAG, "starting startUsingNetworkFeature for request " + request);
1642 return DEPRECATED_PHONE_CONSTANT_APN_REQUEST_STARTED;
1643 } else {
1644 Log.d(TAG, " request Failed");
1645 return DEPRECATED_PHONE_CONSTANT_APN_REQUEST_FAILED;
1646 }
1647 }
1648
1649 /**
1650 * Tells the underlying networking system that the caller is finished
1651 * using the named feature. The interpretation of {@code feature}
1652 * is completely up to each networking implementation.
1653 *
1654 * <p>This method requires the caller to hold either the
1655 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
1656 * or the ability to modify system settings as determined by
1657 * {@link android.provider.Settings.System#canWrite}.</p>
1658 *
1659 * @param networkType specifies which network the request pertains to
1660 * @param feature the name of the feature that is no longer needed
1661 * @return an integer value representing the outcome of the request.
1662 * The interpretation of this value is specific to each networking
1663 * implementation+feature combination, except that the value {@code -1}
1664 * always indicates failure.
1665 *
1666 * @deprecated Deprecated in favor of the cleaner
1667 * {@link #unregisterNetworkCallback(NetworkCallback)} API.
1668 * In {@link VERSION_CODES#M}, and above, this method is unsupported and will
1669 * throw {@code UnsupportedOperationException} if called.
1670 * @removed
1671 */
1672 @Deprecated
1673 public int stopUsingNetworkFeature(int networkType, String feature) {
1674 checkLegacyRoutingApiAccess();
1675 NetworkCapabilities netCap = networkCapabilitiesForFeature(networkType, feature);
1676 if (netCap == null) {
1677 Log.d(TAG, "Can't satisfy stopUsingNetworkFeature for " + networkType + ", " +
1678 feature);
1679 return -1;
1680 }
1681
1682 if (removeRequestForFeature(netCap)) {
1683 Log.d(TAG, "stopUsingNetworkFeature for " + networkType + ", " + feature);
1684 }
1685 return 1;
1686 }
1687
1688 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
1689 private NetworkCapabilities networkCapabilitiesForFeature(int networkType, String feature) {
1690 if (networkType == TYPE_MOBILE) {
1691 switch (feature) {
1692 case "enableCBS":
1693 return networkCapabilitiesForType(TYPE_MOBILE_CBS);
1694 case "enableDUN":
1695 case "enableDUNAlways":
1696 return networkCapabilitiesForType(TYPE_MOBILE_DUN);
1697 case "enableFOTA":
1698 return networkCapabilitiesForType(TYPE_MOBILE_FOTA);
1699 case "enableHIPRI":
1700 return networkCapabilitiesForType(TYPE_MOBILE_HIPRI);
1701 case "enableIMS":
1702 return networkCapabilitiesForType(TYPE_MOBILE_IMS);
1703 case "enableMMS":
1704 return networkCapabilitiesForType(TYPE_MOBILE_MMS);
1705 case "enableSUPL":
1706 return networkCapabilitiesForType(TYPE_MOBILE_SUPL);
1707 default:
1708 return null;
1709 }
1710 } else if (networkType == TYPE_WIFI && "p2p".equals(feature)) {
1711 return networkCapabilitiesForType(TYPE_WIFI_P2P);
1712 }
1713 return null;
1714 }
1715
1716 private int legacyTypeForNetworkCapabilities(NetworkCapabilities netCap) {
1717 if (netCap == null) return TYPE_NONE;
1718 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_CBS)) {
1719 return TYPE_MOBILE_CBS;
1720 }
1721 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_IMS)) {
1722 return TYPE_MOBILE_IMS;
1723 }
1724 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_FOTA)) {
1725 return TYPE_MOBILE_FOTA;
1726 }
1727 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_DUN)) {
1728 return TYPE_MOBILE_DUN;
1729 }
1730 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_SUPL)) {
1731 return TYPE_MOBILE_SUPL;
1732 }
1733 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_MMS)) {
1734 return TYPE_MOBILE_MMS;
1735 }
1736 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_INTERNET)) {
1737 return TYPE_MOBILE_HIPRI;
1738 }
1739 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_WIFI_P2P)) {
1740 return TYPE_WIFI_P2P;
1741 }
1742 return TYPE_NONE;
1743 }
1744
1745 private static class LegacyRequest {
1746 NetworkCapabilities networkCapabilities;
1747 NetworkRequest networkRequest;
1748 int expireSequenceNumber;
1749 Network currentNetwork;
1750 int delay = -1;
1751
1752 private void clearDnsBinding() {
1753 if (currentNetwork != null) {
1754 currentNetwork = null;
1755 setProcessDefaultNetworkForHostResolution(null);
1756 }
1757 }
1758
1759 NetworkCallback networkCallback = new NetworkCallback() {
1760 @Override
1761 public void onAvailable(Network network) {
1762 currentNetwork = network;
1763 Log.d(TAG, "startUsingNetworkFeature got Network:" + network);
1764 setProcessDefaultNetworkForHostResolution(network);
1765 }
1766 @Override
1767 public void onLost(Network network) {
1768 if (network.equals(currentNetwork)) clearDnsBinding();
1769 Log.d(TAG, "startUsingNetworkFeature lost Network:" + network);
1770 }
1771 };
1772 }
1773
1774 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
1775 private static final HashMap<NetworkCapabilities, LegacyRequest> sLegacyRequests =
1776 new HashMap<>();
1777
1778 private NetworkRequest findRequestForFeature(NetworkCapabilities netCap) {
1779 synchronized (sLegacyRequests) {
1780 LegacyRequest l = sLegacyRequests.get(netCap);
1781 if (l != null) return l.networkRequest;
1782 }
1783 return null;
1784 }
1785
1786 private void renewRequestLocked(LegacyRequest l) {
1787 l.expireSequenceNumber++;
1788 Log.d(TAG, "renewing request to seqNum " + l.expireSequenceNumber);
1789 sendExpireMsgForFeature(l.networkCapabilities, l.expireSequenceNumber, l.delay);
1790 }
1791
1792 private void expireRequest(NetworkCapabilities netCap, int sequenceNum) {
1793 int ourSeqNum = -1;
1794 synchronized (sLegacyRequests) {
1795 LegacyRequest l = sLegacyRequests.get(netCap);
1796 if (l == null) return;
1797 ourSeqNum = l.expireSequenceNumber;
1798 if (l.expireSequenceNumber == sequenceNum) removeRequestForFeature(netCap);
1799 }
1800 Log.d(TAG, "expireRequest with " + ourSeqNum + ", " + sequenceNum);
1801 }
1802
1803 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
1804 private NetworkRequest requestNetworkForFeatureLocked(NetworkCapabilities netCap) {
1805 int delay = -1;
1806 int type = legacyTypeForNetworkCapabilities(netCap);
1807 try {
1808 delay = mService.getRestoreDefaultNetworkDelay(type);
1809 } catch (RemoteException e) {
1810 throw e.rethrowFromSystemServer();
1811 }
1812 LegacyRequest l = new LegacyRequest();
1813 l.networkCapabilities = netCap;
1814 l.delay = delay;
1815 l.expireSequenceNumber = 0;
1816 l.networkRequest = sendRequestForNetwork(
1817 netCap, l.networkCallback, 0, REQUEST, type, getDefaultHandler());
1818 if (l.networkRequest == null) return null;
1819 sLegacyRequests.put(netCap, l);
1820 sendExpireMsgForFeature(netCap, l.expireSequenceNumber, delay);
1821 return l.networkRequest;
1822 }
1823
1824 private void sendExpireMsgForFeature(NetworkCapabilities netCap, int seqNum, int delay) {
1825 if (delay >= 0) {
1826 Log.d(TAG, "sending expire msg with seqNum " + seqNum + " and delay " + delay);
1827 CallbackHandler handler = getDefaultHandler();
1828 Message msg = handler.obtainMessage(EXPIRE_LEGACY_REQUEST, seqNum, 0, netCap);
1829 handler.sendMessageDelayed(msg, delay);
1830 }
1831 }
1832
1833 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
1834 private boolean removeRequestForFeature(NetworkCapabilities netCap) {
1835 final LegacyRequest l;
1836 synchronized (sLegacyRequests) {
1837 l = sLegacyRequests.remove(netCap);
1838 }
1839 if (l == null) return false;
1840 unregisterNetworkCallback(l.networkCallback);
1841 l.clearDnsBinding();
1842 return true;
1843 }
1844
1845 private static final SparseIntArray sLegacyTypeToTransport = new SparseIntArray();
1846 static {
1847 sLegacyTypeToTransport.put(TYPE_MOBILE, NetworkCapabilities.TRANSPORT_CELLULAR);
1848 sLegacyTypeToTransport.put(TYPE_MOBILE_CBS, NetworkCapabilities.TRANSPORT_CELLULAR);
1849 sLegacyTypeToTransport.put(TYPE_MOBILE_DUN, NetworkCapabilities.TRANSPORT_CELLULAR);
1850 sLegacyTypeToTransport.put(TYPE_MOBILE_FOTA, NetworkCapabilities.TRANSPORT_CELLULAR);
1851 sLegacyTypeToTransport.put(TYPE_MOBILE_HIPRI, NetworkCapabilities.TRANSPORT_CELLULAR);
1852 sLegacyTypeToTransport.put(TYPE_MOBILE_IMS, NetworkCapabilities.TRANSPORT_CELLULAR);
1853 sLegacyTypeToTransport.put(TYPE_MOBILE_MMS, NetworkCapabilities.TRANSPORT_CELLULAR);
1854 sLegacyTypeToTransport.put(TYPE_MOBILE_SUPL, NetworkCapabilities.TRANSPORT_CELLULAR);
1855 sLegacyTypeToTransport.put(TYPE_WIFI, NetworkCapabilities.TRANSPORT_WIFI);
1856 sLegacyTypeToTransport.put(TYPE_WIFI_P2P, NetworkCapabilities.TRANSPORT_WIFI);
1857 sLegacyTypeToTransport.put(TYPE_BLUETOOTH, NetworkCapabilities.TRANSPORT_BLUETOOTH);
1858 sLegacyTypeToTransport.put(TYPE_ETHERNET, NetworkCapabilities.TRANSPORT_ETHERNET);
1859 }
1860
1861 private static final SparseIntArray sLegacyTypeToCapability = new SparseIntArray();
1862 static {
1863 sLegacyTypeToCapability.put(TYPE_MOBILE_CBS, NetworkCapabilities.NET_CAPABILITY_CBS);
1864 sLegacyTypeToCapability.put(TYPE_MOBILE_DUN, NetworkCapabilities.NET_CAPABILITY_DUN);
1865 sLegacyTypeToCapability.put(TYPE_MOBILE_FOTA, NetworkCapabilities.NET_CAPABILITY_FOTA);
1866 sLegacyTypeToCapability.put(TYPE_MOBILE_IMS, NetworkCapabilities.NET_CAPABILITY_IMS);
1867 sLegacyTypeToCapability.put(TYPE_MOBILE_MMS, NetworkCapabilities.NET_CAPABILITY_MMS);
1868 sLegacyTypeToCapability.put(TYPE_MOBILE_SUPL, NetworkCapabilities.NET_CAPABILITY_SUPL);
1869 sLegacyTypeToCapability.put(TYPE_WIFI_P2P, NetworkCapabilities.NET_CAPABILITY_WIFI_P2P);
1870 }
1871
1872 /**
1873 * Given a legacy type (TYPE_WIFI, ...) returns a NetworkCapabilities
1874 * instance suitable for registering a request or callback. Throws an
1875 * IllegalArgumentException if no mapping from the legacy type to
1876 * NetworkCapabilities is known.
1877 *
1878 * @deprecated Types are deprecated. Use {@link NetworkCallback} or {@link NetworkRequest}
1879 * to find the network instead.
1880 * @hide
1881 */
1882 public static NetworkCapabilities networkCapabilitiesForType(int type) {
1883 final NetworkCapabilities nc = new NetworkCapabilities();
1884
1885 // Map from type to transports.
1886 final int NOT_FOUND = -1;
1887 final int transport = sLegacyTypeToTransport.get(type, NOT_FOUND);
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00001888 if (transport == NOT_FOUND) {
1889 throw new IllegalArgumentException("unknown legacy type: " + type);
1890 }
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001891 nc.addTransportType(transport);
1892
1893 // Map from type to capabilities.
1894 nc.addCapability(sLegacyTypeToCapability.get(
1895 type, NetworkCapabilities.NET_CAPABILITY_INTERNET));
1896 nc.maybeMarkCapabilitiesRestricted();
1897 return nc;
1898 }
1899
1900 /** @hide */
1901 public static class PacketKeepaliveCallback {
1902 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
1903 public PacketKeepaliveCallback() {
1904 }
1905 /** The requested keepalive was successfully started. */
1906 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
1907 public void onStarted() {}
1908 /** The keepalive was successfully stopped. */
1909 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
1910 public void onStopped() {}
1911 /** An error occurred. */
1912 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
1913 public void onError(int error) {}
1914 }
1915
1916 /**
1917 * Allows applications to request that the system periodically send specific packets on their
1918 * behalf, using hardware offload to save battery power.
1919 *
1920 * To request that the system send keepalives, call one of the methods that return a
1921 * {@link ConnectivityManager.PacketKeepalive} object, such as {@link #startNattKeepalive},
1922 * passing in a non-null callback. If the callback is successfully started, the callback's
1923 * {@code onStarted} method will be called. If an error occurs, {@code onError} will be called,
1924 * specifying one of the {@code ERROR_*} constants in this class.
1925 *
1926 * To stop an existing keepalive, call {@link PacketKeepalive#stop}. The system will call
1927 * {@link PacketKeepaliveCallback#onStopped} if the operation was successful or
1928 * {@link PacketKeepaliveCallback#onError} if an error occurred.
1929 *
1930 * @deprecated Use {@link SocketKeepalive} instead.
1931 *
1932 * @hide
1933 */
1934 public class PacketKeepalive {
1935
1936 private static final String TAG = "PacketKeepalive";
1937
1938 /** @hide */
1939 public static final int SUCCESS = 0;
1940
1941 /** @hide */
1942 public static final int NO_KEEPALIVE = -1;
1943
1944 /** @hide */
1945 public static final int BINDER_DIED = -10;
1946
1947 /** The specified {@code Network} is not connected. */
1948 public static final int ERROR_INVALID_NETWORK = -20;
1949 /** The specified IP addresses are invalid. For example, the specified source IP address is
1950 * not configured on the specified {@code Network}. */
1951 public static final int ERROR_INVALID_IP_ADDRESS = -21;
1952 /** The requested port is invalid. */
1953 public static final int ERROR_INVALID_PORT = -22;
1954 /** The packet length is invalid (e.g., too long). */
1955 public static final int ERROR_INVALID_LENGTH = -23;
1956 /** The packet transmission interval is invalid (e.g., too short). */
1957 public static final int ERROR_INVALID_INTERVAL = -24;
1958
1959 /** The hardware does not support this request. */
1960 public static final int ERROR_HARDWARE_UNSUPPORTED = -30;
1961 /** The hardware returned an error. */
1962 public static final int ERROR_HARDWARE_ERROR = -31;
1963
1964 /** The NAT-T destination port for IPsec */
1965 public static final int NATT_PORT = 4500;
1966
1967 /** The minimum interval in seconds between keepalive packet transmissions */
1968 public static final int MIN_INTERVAL = 10;
1969
1970 private final Network mNetwork;
1971 private final ISocketKeepaliveCallback mCallback;
1972 private final ExecutorService mExecutor;
1973
1974 private volatile Integer mSlot;
1975
1976 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
1977 public void stop() {
1978 try {
1979 mExecutor.execute(() -> {
1980 try {
1981 if (mSlot != null) {
1982 mService.stopKeepalive(mNetwork, mSlot);
1983 }
1984 } catch (RemoteException e) {
1985 Log.e(TAG, "Error stopping packet keepalive: ", e);
1986 throw e.rethrowFromSystemServer();
1987 }
1988 });
1989 } catch (RejectedExecutionException e) {
1990 // The internal executor has already stopped due to previous event.
1991 }
1992 }
1993
1994 private PacketKeepalive(Network network, PacketKeepaliveCallback callback) {
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00001995 Objects.requireNonNull(network, "network cannot be null");
1996 Objects.requireNonNull(callback, "callback cannot be null");
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001997 mNetwork = network;
1998 mExecutor = Executors.newSingleThreadExecutor();
1999 mCallback = new ISocketKeepaliveCallback.Stub() {
2000 @Override
2001 public void onStarted(int slot) {
2002 final long token = Binder.clearCallingIdentity();
2003 try {
2004 mExecutor.execute(() -> {
2005 mSlot = slot;
2006 callback.onStarted();
2007 });
2008 } finally {
2009 Binder.restoreCallingIdentity(token);
2010 }
2011 }
2012
2013 @Override
2014 public void onStopped() {
2015 final long token = Binder.clearCallingIdentity();
2016 try {
2017 mExecutor.execute(() -> {
2018 mSlot = null;
2019 callback.onStopped();
2020 });
2021 } finally {
2022 Binder.restoreCallingIdentity(token);
2023 }
2024 mExecutor.shutdown();
2025 }
2026
2027 @Override
2028 public void onError(int error) {
2029 final long token = Binder.clearCallingIdentity();
2030 try {
2031 mExecutor.execute(() -> {
2032 mSlot = null;
2033 callback.onError(error);
2034 });
2035 } finally {
2036 Binder.restoreCallingIdentity(token);
2037 }
2038 mExecutor.shutdown();
2039 }
2040
2041 @Override
2042 public void onDataReceived() {
2043 // PacketKeepalive is only used for Nat-T keepalive and as such does not invoke
2044 // this callback when data is received.
2045 }
2046 };
2047 }
2048 }
2049
2050 /**
2051 * Starts an IPsec NAT-T keepalive packet with the specified parameters.
2052 *
2053 * @deprecated Use {@link #createSocketKeepalive} instead.
2054 *
2055 * @hide
2056 */
2057 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
2058 public PacketKeepalive startNattKeepalive(
2059 Network network, int intervalSeconds, PacketKeepaliveCallback callback,
2060 InetAddress srcAddr, int srcPort, InetAddress dstAddr) {
2061 final PacketKeepalive k = new PacketKeepalive(network, callback);
2062 try {
2063 mService.startNattKeepalive(network, intervalSeconds, k.mCallback,
2064 srcAddr.getHostAddress(), srcPort, dstAddr.getHostAddress());
2065 } catch (RemoteException e) {
2066 Log.e(TAG, "Error starting packet keepalive: ", e);
2067 throw e.rethrowFromSystemServer();
2068 }
2069 return k;
2070 }
2071
2072 // Construct an invalid fd.
2073 private ParcelFileDescriptor createInvalidFd() {
2074 final int invalidFd = -1;
2075 return ParcelFileDescriptor.adoptFd(invalidFd);
2076 }
2077
2078 /**
2079 * Request that keepalives be started on a IPsec NAT-T socket.
2080 *
2081 * @param network The {@link Network} the socket is on.
2082 * @param socket The socket that needs to be kept alive.
2083 * @param source The source address of the {@link UdpEncapsulationSocket}.
2084 * @param destination The destination address of the {@link UdpEncapsulationSocket}.
2085 * @param executor The executor on which callback will be invoked. The provided {@link Executor}
2086 * must run callback sequentially, otherwise the order of callbacks cannot be
2087 * guaranteed.
2088 * @param callback A {@link SocketKeepalive.Callback}. Used for notifications about keepalive
2089 * changes. Must be extended by applications that use this API.
2090 *
2091 * @return A {@link SocketKeepalive} object that can be used to control the keepalive on the
2092 * given socket.
2093 **/
2094 public @NonNull SocketKeepalive createSocketKeepalive(@NonNull Network network,
2095 @NonNull UdpEncapsulationSocket socket,
2096 @NonNull InetAddress source,
2097 @NonNull InetAddress destination,
2098 @NonNull @CallbackExecutor Executor executor,
2099 @NonNull Callback callback) {
2100 ParcelFileDescriptor dup;
2101 try {
2102 // Dup is needed here as the pfd inside the socket is owned by the IpSecService,
2103 // which cannot be obtained by the app process.
2104 dup = ParcelFileDescriptor.dup(socket.getFileDescriptor());
2105 } catch (IOException ignored) {
2106 // Construct an invalid fd, so that if the user later calls start(), it will fail with
2107 // ERROR_INVALID_SOCKET.
2108 dup = createInvalidFd();
2109 }
2110 return new NattSocketKeepalive(mService, network, dup, socket.getResourceId(), source,
2111 destination, executor, callback);
2112 }
2113
2114 /**
2115 * Request that keepalives be started on a IPsec NAT-T socket file descriptor. Directly called
2116 * by system apps which don't use IpSecService to create {@link UdpEncapsulationSocket}.
2117 *
2118 * @param network The {@link Network} the socket is on.
2119 * @param pfd The {@link ParcelFileDescriptor} that needs to be kept alive. The provided
2120 * {@link ParcelFileDescriptor} must be bound to a port and the keepalives will be sent
2121 * from that port.
2122 * @param source The source address of the {@link UdpEncapsulationSocket}.
2123 * @param destination The destination address of the {@link UdpEncapsulationSocket}. The
2124 * keepalive packets will always be sent to port 4500 of the given {@code destination}.
2125 * @param executor The executor on which callback will be invoked. The provided {@link Executor}
2126 * must run callback sequentially, otherwise the order of callbacks cannot be
2127 * guaranteed.
2128 * @param callback A {@link SocketKeepalive.Callback}. Used for notifications about keepalive
2129 * changes. Must be extended by applications that use this API.
2130 *
2131 * @return A {@link SocketKeepalive} object that can be used to control the keepalive on the
2132 * given socket.
2133 * @hide
2134 */
2135 @SystemApi
2136 @RequiresPermission(android.Manifest.permission.PACKET_KEEPALIVE_OFFLOAD)
2137 public @NonNull SocketKeepalive createNattKeepalive(@NonNull Network network,
2138 @NonNull ParcelFileDescriptor pfd,
2139 @NonNull InetAddress source,
2140 @NonNull InetAddress destination,
2141 @NonNull @CallbackExecutor Executor executor,
2142 @NonNull Callback callback) {
2143 ParcelFileDescriptor dup;
2144 try {
2145 // TODO: Consider remove unnecessary dup.
2146 dup = pfd.dup();
2147 } catch (IOException ignored) {
2148 // Construct an invalid fd, so that if the user later calls start(), it will fail with
2149 // ERROR_INVALID_SOCKET.
2150 dup = createInvalidFd();
2151 }
2152 return new NattSocketKeepalive(mService, network, dup,
Remi NGUYEN VANa29be5c2021-03-11 10:56:49 +00002153 -1 /* Unused */, source, destination, executor, callback);
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002154 }
2155
2156 /**
2157 * Request that keepalives be started on a TCP socket.
2158 * The socket must be established.
2159 *
2160 * @param network The {@link Network} the socket is on.
2161 * @param socket The socket that needs to be kept alive.
2162 * @param executor The executor on which callback will be invoked. This implementation assumes
2163 * the provided {@link Executor} runs the callbacks in sequence with no
2164 * concurrency. Failing this, no guarantee of correctness can be made. It is
2165 * the responsibility of the caller to ensure the executor provides this
2166 * guarantee. A simple way of creating such an executor is with the standard
2167 * tool {@code Executors.newSingleThreadExecutor}.
2168 * @param callback A {@link SocketKeepalive.Callback}. Used for notifications about keepalive
2169 * changes. Must be extended by applications that use this API.
2170 *
2171 * @return A {@link SocketKeepalive} object that can be used to control the keepalive on the
2172 * given socket.
2173 * @hide
2174 */
2175 @SystemApi
2176 @RequiresPermission(android.Manifest.permission.PACKET_KEEPALIVE_OFFLOAD)
2177 public @NonNull SocketKeepalive createSocketKeepalive(@NonNull Network network,
2178 @NonNull Socket socket,
2179 @NonNull Executor executor,
2180 @NonNull Callback callback) {
2181 ParcelFileDescriptor dup;
2182 try {
2183 dup = ParcelFileDescriptor.fromSocket(socket);
2184 } catch (UncheckedIOException ignored) {
2185 // Construct an invalid fd, so that if the user later calls start(), it will fail with
2186 // ERROR_INVALID_SOCKET.
2187 dup = createInvalidFd();
2188 }
2189 return new TcpSocketKeepalive(mService, network, dup, executor, callback);
2190 }
2191
2192 /**
2193 * Ensure that a network route exists to deliver traffic to the specified
2194 * host via the specified network interface. An attempt to add a route that
2195 * already exists is ignored, but treated as successful.
2196 *
2197 * <p>This method requires the caller to hold either the
2198 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
2199 * or the ability to modify system settings as determined by
2200 * {@link android.provider.Settings.System#canWrite}.</p>
2201 *
2202 * @param networkType the type of the network over which traffic to the specified
2203 * host is to be routed
2204 * @param hostAddress the IP address of the host to which the route is desired
2205 * @return {@code true} on success, {@code false} on failure
2206 *
2207 * @deprecated Deprecated in favor of the
2208 * {@link #requestNetwork(NetworkRequest, NetworkCallback)},
2209 * {@link #bindProcessToNetwork} and {@link Network#getSocketFactory} API.
2210 * In {@link VERSION_CODES#M}, and above, this method is unsupported and will
2211 * throw {@code UnsupportedOperationException} if called.
2212 * @removed
2213 */
2214 @Deprecated
2215 public boolean requestRouteToHost(int networkType, int hostAddress) {
2216 return requestRouteToHostAddress(networkType, NetworkUtils.intToInetAddress(hostAddress));
2217 }
2218
2219 /**
2220 * Ensure that a network route exists to deliver traffic to the specified
2221 * host via the specified network interface. An attempt to add a route that
2222 * already exists is ignored, but treated as successful.
2223 *
2224 * <p>This method requires the caller to hold either the
2225 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
2226 * or the ability to modify system settings as determined by
2227 * {@link android.provider.Settings.System#canWrite}.</p>
2228 *
2229 * @param networkType the type of the network over which traffic to the specified
2230 * host is to be routed
2231 * @param hostAddress the IP address of the host to which the route is desired
2232 * @return {@code true} on success, {@code false} on failure
2233 * @hide
2234 * @deprecated Deprecated in favor of the {@link #requestNetwork} and
2235 * {@link #bindProcessToNetwork} API.
2236 */
2237 @Deprecated
2238 @UnsupportedAppUsage
lucaslin97fb10a2021-03-22 11:51:27 +08002239 @SystemApi(client = MODULE_LIBRARIES)
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002240 public boolean requestRouteToHostAddress(int networkType, InetAddress hostAddress) {
2241 checkLegacyRoutingApiAccess();
2242 try {
2243 return mService.requestRouteToHostAddress(networkType, hostAddress.getAddress(),
2244 mContext.getOpPackageName(), getAttributionTag());
2245 } catch (RemoteException e) {
2246 throw e.rethrowFromSystemServer();
2247 }
2248 }
2249
2250 /**
2251 * @return the context's attribution tag
2252 */
2253 // TODO: Remove method and replace with direct call once R code is pushed to AOSP
2254 private @Nullable String getAttributionTag() {
Remi NGUYEN VANa522fc22021-02-01 10:25:24 +00002255 return mContext.getAttributionTag();
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002256 }
2257
2258 /**
2259 * Returns the value of the setting for background data usage. If false,
2260 * applications should not use the network if the application is not in the
2261 * foreground. Developers should respect this setting, and check the value
2262 * of this before performing any background data operations.
2263 * <p>
2264 * All applications that have background services that use the network
2265 * should listen to {@link #ACTION_BACKGROUND_DATA_SETTING_CHANGED}.
2266 * <p>
2267 * @deprecated As of {@link VERSION_CODES#ICE_CREAM_SANDWICH}, availability of
2268 * background data depends on several combined factors, and this method will
2269 * always return {@code true}. Instead, when background data is unavailable,
2270 * {@link #getActiveNetworkInfo()} will now appear disconnected.
2271 *
2272 * @return Whether background data usage is allowed.
2273 */
2274 @Deprecated
2275 public boolean getBackgroundDataSetting() {
2276 // assume that background data is allowed; final authority is
2277 // NetworkInfo which may be blocked.
2278 return true;
2279 }
2280
2281 /**
2282 * Sets the value of the setting for background data usage.
2283 *
2284 * @param allowBackgroundData Whether an application should use data while
2285 * it is in the background.
2286 *
2287 * @attr ref android.Manifest.permission#CHANGE_BACKGROUND_DATA_SETTING
2288 * @see #getBackgroundDataSetting()
2289 * @hide
2290 */
2291 @Deprecated
2292 @UnsupportedAppUsage
2293 public void setBackgroundDataSetting(boolean allowBackgroundData) {
2294 // ignored
2295 }
2296
2297 /**
2298 * @hide
2299 * @deprecated Talk to TelephonyManager directly
2300 */
2301 @Deprecated
2302 @UnsupportedAppUsage
2303 public boolean getMobileDataEnabled() {
2304 TelephonyManager tm = mContext.getSystemService(TelephonyManager.class);
2305 if (tm != null) {
2306 int subId = SubscriptionManager.getDefaultDataSubscriptionId();
2307 Log.d("ConnectivityManager", "getMobileDataEnabled()+ subId=" + subId);
2308 boolean retVal = tm.createForSubscriptionId(subId).isDataEnabled();
2309 Log.d("ConnectivityManager", "getMobileDataEnabled()- subId=" + subId
2310 + " retVal=" + retVal);
2311 return retVal;
2312 }
2313 Log.d("ConnectivityManager", "getMobileDataEnabled()- remote exception retVal=false");
2314 return false;
2315 }
2316
2317 /**
2318 * Callback for use with {@link ConnectivityManager#addDefaultNetworkActiveListener}
2319 * to find out when the system default network has gone in to a high power state.
2320 */
2321 public interface OnNetworkActiveListener {
2322 /**
2323 * Called on the main thread of the process to report that the current data network
2324 * has become active, and it is now a good time to perform any pending network
2325 * operations. Note that this listener only tells you when the network becomes
2326 * active; if at any other time you want to know whether it is active (and thus okay
2327 * to initiate network traffic), you can retrieve its instantaneous state with
2328 * {@link ConnectivityManager#isDefaultNetworkActive}.
2329 */
2330 void onNetworkActive();
2331 }
2332
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002333 private final ArrayMap<OnNetworkActiveListener, INetworkActivityListener>
2334 mNetworkActivityListeners = new ArrayMap<>();
2335
2336 /**
2337 * Start listening to reports when the system's default data network is active, meaning it is
2338 * a good time to perform network traffic. Use {@link #isDefaultNetworkActive()}
2339 * to determine the current state of the system's default network after registering the
2340 * listener.
2341 * <p>
2342 * If the process default network has been set with
2343 * {@link ConnectivityManager#bindProcessToNetwork} this function will not
2344 * reflect the process's default, but the system default.
2345 *
2346 * @param l The listener to be told when the network is active.
2347 */
2348 public void addDefaultNetworkActiveListener(final OnNetworkActiveListener l) {
2349 INetworkActivityListener rl = new INetworkActivityListener.Stub() {
2350 @Override
2351 public void onNetworkActive() throws RemoteException {
2352 l.onNetworkActive();
2353 }
2354 };
2355
2356 try {
lucaslin709eb842021-01-21 02:04:15 +08002357 mService.registerNetworkActivityListener(rl);
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002358 mNetworkActivityListeners.put(l, rl);
2359 } catch (RemoteException e) {
2360 throw e.rethrowFromSystemServer();
2361 }
2362 }
2363
2364 /**
2365 * Remove network active listener previously registered with
2366 * {@link #addDefaultNetworkActiveListener}.
2367 *
2368 * @param l Previously registered listener.
2369 */
2370 public void removeDefaultNetworkActiveListener(@NonNull OnNetworkActiveListener l) {
2371 INetworkActivityListener rl = mNetworkActivityListeners.get(l);
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00002372 if (rl == null) {
2373 throw new IllegalArgumentException("Listener was not registered.");
2374 }
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002375 try {
lucaslin709eb842021-01-21 02:04:15 +08002376 mService.registerNetworkActivityListener(rl);
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002377 } catch (RemoteException e) {
2378 throw e.rethrowFromSystemServer();
2379 }
2380 }
2381
2382 /**
2383 * Return whether the data network is currently active. An active network means that
2384 * it is currently in a high power state for performing data transmission. On some
2385 * types of networks, it may be expensive to move and stay in such a state, so it is
2386 * more power efficient to batch network traffic together when the radio is already in
2387 * this state. This method tells you whether right now is currently a good time to
2388 * initiate network traffic, as the network is already active.
2389 */
2390 public boolean isDefaultNetworkActive() {
2391 try {
lucaslin709eb842021-01-21 02:04:15 +08002392 return mService.isDefaultNetworkActive();
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002393 } catch (RemoteException e) {
2394 throw e.rethrowFromSystemServer();
2395 }
2396 }
2397
2398 /**
2399 * {@hide}
2400 */
2401 public ConnectivityManager(Context context, IConnectivityManager service) {
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00002402 mContext = Objects.requireNonNull(context, "missing context");
2403 mService = Objects.requireNonNull(service, "missing IConnectivityManager");
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002404 mTetheringManager = (TetheringManager) mContext.getSystemService(Context.TETHERING_SERVICE);
2405 sInstance = this;
2406 }
2407
2408 /** {@hide} */
2409 @UnsupportedAppUsage
2410 public static ConnectivityManager from(Context context) {
2411 return (ConnectivityManager) context.getSystemService(Context.CONNECTIVITY_SERVICE);
2412 }
2413
2414 /** @hide */
2415 public NetworkRequest getDefaultRequest() {
2416 try {
2417 // This is not racy as the default request is final in ConnectivityService.
2418 return mService.getDefaultRequest();
2419 } catch (RemoteException e) {
2420 throw e.rethrowFromSystemServer();
2421 }
2422 }
2423
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002424 /**
2425 * Check if the package is a allowed to write settings. This also accounts that such an access
2426 * happened.
2427 *
2428 * @return {@code true} iff the package is allowed to write settings.
2429 */
2430 // TODO: Remove method and replace with direct call once R code is pushed to AOSP
2431 private static boolean checkAndNoteWriteSettingsOperation(@NonNull Context context, int uid,
2432 @NonNull String callingPackage, @Nullable String callingAttributionTag,
2433 boolean throwException) {
2434 return Settings.checkAndNoteWriteSettingsOperation(context, uid, callingPackage,
Remi NGUYEN VANa522fc22021-02-01 10:25:24 +00002435 callingAttributionTag, throwException);
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002436 }
2437
2438 /**
2439 * @deprecated - use getSystemService. This is a kludge to support static access in certain
2440 * situations where a Context pointer is unavailable.
2441 * @hide
2442 */
2443 @Deprecated
2444 static ConnectivityManager getInstanceOrNull() {
2445 return sInstance;
2446 }
2447
2448 /**
2449 * @deprecated - use getSystemService. This is a kludge to support static access in certain
2450 * situations where a Context pointer is unavailable.
2451 * @hide
2452 */
2453 @Deprecated
2454 @UnsupportedAppUsage
2455 private static ConnectivityManager getInstance() {
2456 if (getInstanceOrNull() == null) {
2457 throw new IllegalStateException("No ConnectivityManager yet constructed");
2458 }
2459 return getInstanceOrNull();
2460 }
2461
2462 /**
2463 * Get the set of tetherable, available interfaces. This list is limited by
2464 * device configuration and current interface existence.
2465 *
2466 * @return an array of 0 or more Strings of tetherable interface names.
2467 *
2468 * @deprecated Use {@link TetheringEventCallback#onTetherableInterfacesChanged(List)} instead.
2469 * {@hide}
2470 */
2471 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
2472 @UnsupportedAppUsage
2473 @Deprecated
2474 public String[] getTetherableIfaces() {
2475 return mTetheringManager.getTetherableIfaces();
2476 }
2477
2478 /**
2479 * Get the set of tethered interfaces.
2480 *
2481 * @return an array of 0 or more String of currently tethered interface names.
2482 *
2483 * @deprecated Use {@link TetheringEventCallback#onTetherableInterfacesChanged(List)} instead.
2484 * {@hide}
2485 */
2486 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
2487 @UnsupportedAppUsage
2488 @Deprecated
2489 public String[] getTetheredIfaces() {
2490 return mTetheringManager.getTetheredIfaces();
2491 }
2492
2493 /**
2494 * Get the set of interface names which attempted to tether but
2495 * failed. Re-attempting to tether may cause them to reset to the Tethered
2496 * state. Alternatively, causing the interface to be destroyed and recreated
2497 * may cause them to reset to the available state.
2498 * {@link ConnectivityManager#getLastTetherError} can be used to get more
2499 * information on the cause of the errors.
2500 *
2501 * @return an array of 0 or more String indicating the interface names
2502 * which failed to tether.
2503 *
2504 * @deprecated Use {@link TetheringEventCallback#onError(String, int)} instead.
2505 * {@hide}
2506 */
2507 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
2508 @UnsupportedAppUsage
2509 @Deprecated
2510 public String[] getTetheringErroredIfaces() {
2511 return mTetheringManager.getTetheringErroredIfaces();
2512 }
2513
2514 /**
2515 * Get the set of tethered dhcp ranges.
2516 *
2517 * @deprecated This method is not supported.
2518 * TODO: remove this function when all of clients are removed.
2519 * {@hide}
2520 */
2521 @RequiresPermission(android.Manifest.permission.NETWORK_SETTINGS)
2522 @Deprecated
2523 public String[] getTetheredDhcpRanges() {
2524 throw new UnsupportedOperationException("getTetheredDhcpRanges is not supported");
2525 }
2526
2527 /**
2528 * Attempt to tether the named interface. This will setup a dhcp server
2529 * on the interface, forward and NAT IP packets and forward DNS requests
2530 * to the best active upstream network interface. Note that if no upstream
2531 * IP network interface is available, dhcp will still run and traffic will be
2532 * allowed between the tethered devices and this device, though upstream net
2533 * access will of course fail until an upstream network interface becomes
2534 * active.
2535 *
2536 * <p>This method requires the caller to hold either the
2537 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
2538 * or the ability to modify system settings as determined by
2539 * {@link android.provider.Settings.System#canWrite}.</p>
2540 *
2541 * <p>WARNING: New clients should not use this function. The only usages should be in PanService
2542 * and WifiStateMachine which need direct access. All other clients should use
2543 * {@link #startTethering} and {@link #stopTethering} which encapsulate proper provisioning
2544 * logic.</p>
2545 *
2546 * @param iface the interface name to tether.
2547 * @return error a {@code TETHER_ERROR} value indicating success or failure type
2548 * @deprecated Use {@link TetheringManager#startTethering} instead
2549 *
2550 * {@hide}
2551 */
2552 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
2553 @Deprecated
2554 public int tether(String iface) {
2555 return mTetheringManager.tether(iface);
2556 }
2557
2558 /**
2559 * Stop tethering the named interface.
2560 *
2561 * <p>This method requires the caller to hold either the
2562 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
2563 * or the ability to modify system settings as determined by
2564 * {@link android.provider.Settings.System#canWrite}.</p>
2565 *
2566 * <p>WARNING: New clients should not use this function. The only usages should be in PanService
2567 * and WifiStateMachine which need direct access. All other clients should use
2568 * {@link #startTethering} and {@link #stopTethering} which encapsulate proper provisioning
2569 * logic.</p>
2570 *
2571 * @param iface the interface name to untether.
2572 * @return error a {@code TETHER_ERROR} value indicating success or failure type
2573 *
2574 * {@hide}
2575 */
2576 @UnsupportedAppUsage
2577 @Deprecated
2578 public int untether(String iface) {
2579 return mTetheringManager.untether(iface);
2580 }
2581
2582 /**
2583 * Check if the device allows for tethering. It may be disabled via
2584 * {@code ro.tether.denied} system property, Settings.TETHER_SUPPORTED or
2585 * due to device configuration.
2586 *
2587 * <p>If this app does not have permission to use this API, it will always
2588 * return false rather than throw an exception.</p>
2589 *
2590 * <p>If the device has a hotspot provisioning app, the caller is required to hold the
2591 * {@link android.Manifest.permission.TETHER_PRIVILEGED} permission.</p>
2592 *
2593 * <p>Otherwise, this method requires the caller to hold the ability to modify system
2594 * settings as determined by {@link android.provider.Settings.System#canWrite}.</p>
2595 *
2596 * @return a boolean - {@code true} indicating Tethering is supported.
2597 *
2598 * @deprecated Use {@link TetheringEventCallback#onTetheringSupported(boolean)} instead.
2599 * {@hide}
2600 */
2601 @SystemApi
2602 @RequiresPermission(anyOf = {android.Manifest.permission.TETHER_PRIVILEGED,
2603 android.Manifest.permission.WRITE_SETTINGS})
2604 public boolean isTetheringSupported() {
2605 return mTetheringManager.isTetheringSupported();
2606 }
2607
2608 /**
2609 * Callback for use with {@link #startTethering} to find out whether tethering succeeded.
2610 *
2611 * @deprecated Use {@link TetheringManager.StartTetheringCallback} instead.
2612 * @hide
2613 */
2614 @SystemApi
2615 @Deprecated
2616 public static abstract class OnStartTetheringCallback {
2617 /**
2618 * Called when tethering has been successfully started.
2619 */
2620 public void onTetheringStarted() {}
2621
2622 /**
2623 * Called when starting tethering failed.
2624 */
2625 public void onTetheringFailed() {}
2626 }
2627
2628 /**
2629 * Convenient overload for
2630 * {@link #startTethering(int, boolean, OnStartTetheringCallback, Handler)} which passes a null
2631 * handler to run on the current thread's {@link Looper}.
2632 *
2633 * @deprecated Use {@link TetheringManager#startTethering} instead.
2634 * @hide
2635 */
2636 @SystemApi
2637 @Deprecated
2638 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
2639 public void startTethering(int type, boolean showProvisioningUi,
2640 final OnStartTetheringCallback callback) {
2641 startTethering(type, showProvisioningUi, callback, null);
2642 }
2643
2644 /**
2645 * Runs tether provisioning for the given type if needed and then starts tethering if
2646 * the check succeeds. If no carrier provisioning is required for tethering, tethering is
2647 * enabled immediately. If provisioning fails, tethering will not be enabled. It also
2648 * schedules tether provisioning re-checks if appropriate.
2649 *
2650 * @param type The type of tethering to start. Must be one of
2651 * {@link ConnectivityManager.TETHERING_WIFI},
2652 * {@link ConnectivityManager.TETHERING_USB}, or
2653 * {@link ConnectivityManager.TETHERING_BLUETOOTH}.
2654 * @param showProvisioningUi a boolean indicating to show the provisioning app UI if there
2655 * is one. This should be true the first time this function is called and also any time
2656 * the user can see this UI. It gives users information from their carrier about the
2657 * check failing and how they can sign up for tethering if possible.
2658 * @param callback an {@link OnStartTetheringCallback} which will be called to notify the caller
2659 * of the result of trying to tether.
2660 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
2661 *
2662 * @deprecated Use {@link TetheringManager#startTethering} instead.
2663 * @hide
2664 */
2665 @SystemApi
2666 @Deprecated
2667 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
2668 public void startTethering(int type, boolean showProvisioningUi,
2669 final OnStartTetheringCallback callback, Handler handler) {
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00002670 Objects.requireNonNull(callback, "OnStartTetheringCallback cannot be null.");
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002671
2672 final Executor executor = new Executor() {
2673 @Override
2674 public void execute(Runnable command) {
2675 if (handler == null) {
2676 command.run();
2677 } else {
2678 handler.post(command);
2679 }
2680 }
2681 };
2682
2683 final StartTetheringCallback tetheringCallback = new StartTetheringCallback() {
2684 @Override
2685 public void onTetheringStarted() {
2686 callback.onTetheringStarted();
2687 }
2688
2689 @Override
2690 public void onTetheringFailed(final int error) {
2691 callback.onTetheringFailed();
2692 }
2693 };
2694
2695 final TetheringRequest request = new TetheringRequest.Builder(type)
2696 .setShouldShowEntitlementUi(showProvisioningUi).build();
2697
2698 mTetheringManager.startTethering(request, executor, tetheringCallback);
2699 }
2700
2701 /**
2702 * Stops tethering for the given type. Also cancels any provisioning rechecks for that type if
2703 * applicable.
2704 *
2705 * @param type The type of tethering to stop. Must be one of
2706 * {@link ConnectivityManager.TETHERING_WIFI},
2707 * {@link ConnectivityManager.TETHERING_USB}, or
2708 * {@link ConnectivityManager.TETHERING_BLUETOOTH}.
2709 *
2710 * @deprecated Use {@link TetheringManager#stopTethering} instead.
2711 * @hide
2712 */
2713 @SystemApi
2714 @Deprecated
2715 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
2716 public void stopTethering(int type) {
2717 mTetheringManager.stopTethering(type);
2718 }
2719
2720 /**
2721 * Callback for use with {@link registerTetheringEventCallback} to find out tethering
2722 * upstream status.
2723 *
2724 * @deprecated Use {@link TetheringManager#OnTetheringEventCallback} instead.
2725 * @hide
2726 */
2727 @SystemApi
2728 @Deprecated
2729 public abstract static class OnTetheringEventCallback {
2730
2731 /**
2732 * Called when tethering upstream changed. This can be called multiple times and can be
2733 * called any time.
2734 *
2735 * @param network the {@link Network} of tethering upstream. Null means tethering doesn't
2736 * have any upstream.
2737 */
2738 public void onUpstreamChanged(@Nullable Network network) {}
2739 }
2740
2741 @GuardedBy("mTetheringEventCallbacks")
2742 private final ArrayMap<OnTetheringEventCallback, TetheringEventCallback>
2743 mTetheringEventCallbacks = new ArrayMap<>();
2744
2745 /**
2746 * Start listening to tethering change events. Any new added callback will receive the last
2747 * tethering status right away. If callback is registered when tethering has no upstream or
2748 * disabled, {@link OnTetheringEventCallback#onUpstreamChanged} will immediately be called
2749 * with a null argument. The same callback object cannot be registered twice.
2750 *
2751 * @param executor the executor on which callback will be invoked.
2752 * @param callback the callback to be called when tethering has change events.
2753 *
2754 * @deprecated Use {@link TetheringManager#registerTetheringEventCallback} instead.
2755 * @hide
2756 */
2757 @SystemApi
2758 @Deprecated
2759 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
2760 public void registerTetheringEventCallback(
2761 @NonNull @CallbackExecutor Executor executor,
2762 @NonNull final OnTetheringEventCallback callback) {
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00002763 Objects.requireNonNull(callback, "OnTetheringEventCallback cannot be null.");
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002764
2765 final TetheringEventCallback tetherCallback =
2766 new TetheringEventCallback() {
2767 @Override
2768 public void onUpstreamChanged(@Nullable Network network) {
2769 callback.onUpstreamChanged(network);
2770 }
2771 };
2772
2773 synchronized (mTetheringEventCallbacks) {
2774 mTetheringEventCallbacks.put(callback, tetherCallback);
2775 mTetheringManager.registerTetheringEventCallback(executor, tetherCallback);
2776 }
2777 }
2778
2779 /**
2780 * Remove tethering event callback previously registered with
2781 * {@link #registerTetheringEventCallback}.
2782 *
2783 * @param callback previously registered callback.
2784 *
2785 * @deprecated Use {@link TetheringManager#unregisterTetheringEventCallback} instead.
2786 * @hide
2787 */
2788 @SystemApi
2789 @Deprecated
2790 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
2791 public void unregisterTetheringEventCallback(
2792 @NonNull final OnTetheringEventCallback callback) {
2793 Objects.requireNonNull(callback, "The callback must be non-null");
2794 synchronized (mTetheringEventCallbacks) {
2795 final TetheringEventCallback tetherCallback =
2796 mTetheringEventCallbacks.remove(callback);
2797 mTetheringManager.unregisterTetheringEventCallback(tetherCallback);
2798 }
2799 }
2800
2801
2802 /**
2803 * Get the list of regular expressions that define any tetherable
2804 * USB network interfaces. If USB tethering is not supported by the
2805 * device, this list should be empty.
2806 *
2807 * @return an array of 0 or more regular expression Strings defining
2808 * what interfaces are considered tetherable usb interfaces.
2809 *
2810 * @deprecated Use {@link TetheringEventCallback#onTetherableInterfaceRegexpsChanged} instead.
2811 * {@hide}
2812 */
2813 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
2814 @UnsupportedAppUsage
2815 @Deprecated
2816 public String[] getTetherableUsbRegexs() {
2817 return mTetheringManager.getTetherableUsbRegexs();
2818 }
2819
2820 /**
2821 * Get the list of regular expressions that define any tetherable
2822 * Wifi network interfaces. If Wifi tethering is not supported by the
2823 * device, this list should be empty.
2824 *
2825 * @return an array of 0 or more regular expression Strings defining
2826 * what interfaces are considered tetherable wifi interfaces.
2827 *
2828 * @deprecated Use {@link TetheringEventCallback#onTetherableInterfaceRegexpsChanged} instead.
2829 * {@hide}
2830 */
2831 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
2832 @UnsupportedAppUsage
2833 @Deprecated
2834 public String[] getTetherableWifiRegexs() {
2835 return mTetheringManager.getTetherableWifiRegexs();
2836 }
2837
2838 /**
2839 * Get the list of regular expressions that define any tetherable
2840 * Bluetooth network interfaces. If Bluetooth tethering is not supported by the
2841 * device, this list should be empty.
2842 *
2843 * @return an array of 0 or more regular expression Strings defining
2844 * what interfaces are considered tetherable bluetooth interfaces.
2845 *
2846 * @deprecated Use {@link TetheringEventCallback#onTetherableInterfaceRegexpsChanged(
2847 *TetheringManager.TetheringInterfaceRegexps)} instead.
2848 * {@hide}
2849 */
2850 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
2851 @UnsupportedAppUsage
2852 @Deprecated
2853 public String[] getTetherableBluetoothRegexs() {
2854 return mTetheringManager.getTetherableBluetoothRegexs();
2855 }
2856
2857 /**
2858 * Attempt to both alter the mode of USB and Tethering of USB. A
2859 * utility method to deal with some of the complexity of USB - will
2860 * attempt to switch to Rndis and subsequently tether the resulting
2861 * interface on {@code true} or turn off tethering and switch off
2862 * Rndis on {@code false}.
2863 *
2864 * <p>This method requires the caller to hold either the
2865 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
2866 * or the ability to modify system settings as determined by
2867 * {@link android.provider.Settings.System#canWrite}.</p>
2868 *
2869 * @param enable a boolean - {@code true} to enable tethering
2870 * @return error a {@code TETHER_ERROR} value indicating success or failure type
2871 * @deprecated Use {@link TetheringManager#startTethering} instead
2872 *
2873 * {@hide}
2874 */
2875 @UnsupportedAppUsage
2876 @Deprecated
2877 public int setUsbTethering(boolean enable) {
2878 return mTetheringManager.setUsbTethering(enable);
2879 }
2880
2881 /**
2882 * @deprecated Use {@link TetheringManager#TETHER_ERROR_NO_ERROR}.
2883 * {@hide}
2884 */
2885 @SystemApi
2886 @Deprecated
Remi NGUYEN VAN71ced8e2021-02-15 18:52:06 +09002887 public static final int TETHER_ERROR_NO_ERROR = 0;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002888 /**
2889 * @deprecated Use {@link TetheringManager#TETHER_ERROR_UNKNOWN_IFACE}.
2890 * {@hide}
2891 */
2892 @Deprecated
2893 public static final int TETHER_ERROR_UNKNOWN_IFACE =
2894 TetheringManager.TETHER_ERROR_UNKNOWN_IFACE;
2895 /**
2896 * @deprecated Use {@link TetheringManager#TETHER_ERROR_SERVICE_UNAVAIL}.
2897 * {@hide}
2898 */
2899 @Deprecated
2900 public static final int TETHER_ERROR_SERVICE_UNAVAIL =
2901 TetheringManager.TETHER_ERROR_SERVICE_UNAVAIL;
2902 /**
2903 * @deprecated Use {@link TetheringManager#TETHER_ERROR_UNSUPPORTED}.
2904 * {@hide}
2905 */
2906 @Deprecated
2907 public static final int TETHER_ERROR_UNSUPPORTED = TetheringManager.TETHER_ERROR_UNSUPPORTED;
2908 /**
2909 * @deprecated Use {@link TetheringManager#TETHER_ERROR_UNAVAIL_IFACE}.
2910 * {@hide}
2911 */
2912 @Deprecated
2913 public static final int TETHER_ERROR_UNAVAIL_IFACE =
2914 TetheringManager.TETHER_ERROR_UNAVAIL_IFACE;
2915 /**
2916 * @deprecated Use {@link TetheringManager#TETHER_ERROR_INTERNAL_ERROR}.
2917 * {@hide}
2918 */
2919 @Deprecated
2920 public static final int TETHER_ERROR_MASTER_ERROR =
2921 TetheringManager.TETHER_ERROR_INTERNAL_ERROR;
2922 /**
2923 * @deprecated Use {@link TetheringManager#TETHER_ERROR_TETHER_IFACE_ERROR}.
2924 * {@hide}
2925 */
2926 @Deprecated
2927 public static final int TETHER_ERROR_TETHER_IFACE_ERROR =
2928 TetheringManager.TETHER_ERROR_TETHER_IFACE_ERROR;
2929 /**
2930 * @deprecated Use {@link TetheringManager#TETHER_ERROR_UNTETHER_IFACE_ERROR}.
2931 * {@hide}
2932 */
2933 @Deprecated
2934 public static final int TETHER_ERROR_UNTETHER_IFACE_ERROR =
2935 TetheringManager.TETHER_ERROR_UNTETHER_IFACE_ERROR;
2936 /**
2937 * @deprecated Use {@link TetheringManager#TETHER_ERROR_ENABLE_FORWARDING_ERROR}.
2938 * {@hide}
2939 */
2940 @Deprecated
2941 public static final int TETHER_ERROR_ENABLE_NAT_ERROR =
2942 TetheringManager.TETHER_ERROR_ENABLE_FORWARDING_ERROR;
2943 /**
2944 * @deprecated Use {@link TetheringManager#TETHER_ERROR_DISABLE_FORWARDING_ERROR}.
2945 * {@hide}
2946 */
2947 @Deprecated
2948 public static final int TETHER_ERROR_DISABLE_NAT_ERROR =
2949 TetheringManager.TETHER_ERROR_DISABLE_FORWARDING_ERROR;
2950 /**
2951 * @deprecated Use {@link TetheringManager#TETHER_ERROR_IFACE_CFG_ERROR}.
2952 * {@hide}
2953 */
2954 @Deprecated
2955 public static final int TETHER_ERROR_IFACE_CFG_ERROR =
2956 TetheringManager.TETHER_ERROR_IFACE_CFG_ERROR;
2957 /**
2958 * @deprecated Use {@link TetheringManager#TETHER_ERROR_PROVISIONING_FAILED}.
2959 * {@hide}
2960 */
2961 @SystemApi
2962 @Deprecated
Remi NGUYEN VAN71ced8e2021-02-15 18:52:06 +09002963 public static final int TETHER_ERROR_PROVISION_FAILED = 11;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002964 /**
2965 * @deprecated Use {@link TetheringManager#TETHER_ERROR_DHCPSERVER_ERROR}.
2966 * {@hide}
2967 */
2968 @Deprecated
2969 public static final int TETHER_ERROR_DHCPSERVER_ERROR =
2970 TetheringManager.TETHER_ERROR_DHCPSERVER_ERROR;
2971 /**
2972 * @deprecated Use {@link TetheringManager#TETHER_ERROR_ENTITLEMENT_UNKNOWN}.
2973 * {@hide}
2974 */
2975 @SystemApi
2976 @Deprecated
Remi NGUYEN VAN71ced8e2021-02-15 18:52:06 +09002977 public static final int TETHER_ERROR_ENTITLEMENT_UNKONWN = 13;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002978
2979 /**
2980 * Get a more detailed error code after a Tethering or Untethering
2981 * request asynchronously failed.
2982 *
2983 * @param iface The name of the interface of interest
2984 * @return error The error code of the last error tethering or untethering the named
2985 * interface
2986 *
2987 * @deprecated Use {@link TetheringEventCallback#onError(String, int)} instead.
2988 * {@hide}
2989 */
2990 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
2991 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
2992 @Deprecated
2993 public int getLastTetherError(String iface) {
2994 int error = mTetheringManager.getLastTetherError(iface);
2995 if (error == TetheringManager.TETHER_ERROR_UNKNOWN_TYPE) {
2996 // TETHER_ERROR_UNKNOWN_TYPE was introduced with TetheringManager and has never been
2997 // returned by ConnectivityManager. Convert it to the legacy TETHER_ERROR_UNKNOWN_IFACE
2998 // instead.
2999 error = TetheringManager.TETHER_ERROR_UNKNOWN_IFACE;
3000 }
3001 return error;
3002 }
3003
3004 /** @hide */
3005 @Retention(RetentionPolicy.SOURCE)
3006 @IntDef(value = {
3007 TETHER_ERROR_NO_ERROR,
3008 TETHER_ERROR_PROVISION_FAILED,
3009 TETHER_ERROR_ENTITLEMENT_UNKONWN,
3010 })
3011 public @interface EntitlementResultCode {
3012 }
3013
3014 /**
3015 * Callback for use with {@link #getLatestTetheringEntitlementResult} to find out whether
3016 * entitlement succeeded.
3017 *
3018 * @deprecated Use {@link TetheringManager#OnTetheringEntitlementResultListener} instead.
3019 * @hide
3020 */
3021 @SystemApi
3022 @Deprecated
3023 public interface OnTetheringEntitlementResultListener {
3024 /**
3025 * Called to notify entitlement result.
3026 *
3027 * @param resultCode an int value of entitlement result. It may be one of
3028 * {@link #TETHER_ERROR_NO_ERROR},
3029 * {@link #TETHER_ERROR_PROVISION_FAILED}, or
3030 * {@link #TETHER_ERROR_ENTITLEMENT_UNKONWN}.
3031 */
3032 void onTetheringEntitlementResult(@EntitlementResultCode int resultCode);
3033 }
3034
3035 /**
3036 * Get the last value of the entitlement check on this downstream. If the cached value is
3037 * {@link #TETHER_ERROR_NO_ERROR} or showEntitlementUi argument is false, it just return the
3038 * cached value. Otherwise, a UI-based entitlement check would be performed. It is not
3039 * guaranteed that the UI-based entitlement check will complete in any specific time period
3040 * and may in fact never complete. Any successful entitlement check the platform performs for
3041 * any reason will update the cached value.
3042 *
3043 * @param type the downstream type of tethering. Must be one of
3044 * {@link #TETHERING_WIFI},
3045 * {@link #TETHERING_USB}, or
3046 * {@link #TETHERING_BLUETOOTH}.
3047 * @param showEntitlementUi a boolean indicating whether to run UI-based entitlement check.
3048 * @param executor the executor on which callback will be invoked.
3049 * @param listener an {@link OnTetheringEntitlementResultListener} which will be called to
3050 * notify the caller of the result of entitlement check. The listener may be called zero
3051 * or one time.
3052 * @deprecated Use {@link TetheringManager#requestLatestTetheringEntitlementResult} instead.
3053 * {@hide}
3054 */
3055 @SystemApi
3056 @Deprecated
3057 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
3058 public void getLatestTetheringEntitlementResult(int type, boolean showEntitlementUi,
3059 @NonNull @CallbackExecutor Executor executor,
3060 @NonNull final OnTetheringEntitlementResultListener listener) {
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00003061 Objects.requireNonNull(listener, "TetheringEntitlementResultListener cannot be null.");
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003062 ResultReceiver wrappedListener = new ResultReceiver(null) {
3063 @Override
3064 protected void onReceiveResult(int resultCode, Bundle resultData) {
lucaslineaff72d2021-03-04 09:38:21 +08003065 final long token = Binder.clearCallingIdentity();
3066 try {
3067 executor.execute(() -> {
3068 listener.onTetheringEntitlementResult(resultCode);
3069 });
3070 } finally {
3071 Binder.restoreCallingIdentity(token);
3072 }
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003073 }
3074 };
3075
3076 mTetheringManager.requestLatestTetheringEntitlementResult(type, wrappedListener,
3077 showEntitlementUi);
3078 }
3079
3080 /**
3081 * Report network connectivity status. This is currently used only
3082 * to alter status bar UI.
3083 * <p>This method requires the caller to hold the permission
3084 * {@link android.Manifest.permission#STATUS_BAR}.
3085 *
3086 * @param networkType The type of network you want to report on
3087 * @param percentage The quality of the connection 0 is bad, 100 is good
3088 * @deprecated Types are deprecated. Use {@link #reportNetworkConnectivity} instead.
3089 * {@hide}
3090 */
3091 public void reportInetCondition(int networkType, int percentage) {
3092 printStackTrace();
3093 try {
3094 mService.reportInetCondition(networkType, percentage);
3095 } catch (RemoteException e) {
3096 throw e.rethrowFromSystemServer();
3097 }
3098 }
3099
3100 /**
3101 * Report a problem network to the framework. This provides a hint to the system
3102 * that there might be connectivity problems on this network and may cause
3103 * the framework to re-evaluate network connectivity and/or switch to another
3104 * network.
3105 *
3106 * @param network The {@link Network} the application was attempting to use
3107 * or {@code null} to indicate the current default network.
3108 * @deprecated Use {@link #reportNetworkConnectivity} which allows reporting both
3109 * working and non-working connectivity.
3110 */
3111 @Deprecated
3112 public void reportBadNetwork(@Nullable Network network) {
3113 printStackTrace();
3114 try {
3115 // One of these will be ignored because it matches system's current state.
3116 // The other will trigger the necessary reevaluation.
3117 mService.reportNetworkConnectivity(network, true);
3118 mService.reportNetworkConnectivity(network, false);
3119 } catch (RemoteException e) {
3120 throw e.rethrowFromSystemServer();
3121 }
3122 }
3123
3124 /**
3125 * Report to the framework whether a network has working connectivity.
3126 * This provides a hint to the system that a particular network is providing
3127 * working connectivity or not. In response the framework may re-evaluate
3128 * the network's connectivity and might take further action thereafter.
3129 *
3130 * @param network The {@link Network} the application was attempting to use
3131 * or {@code null} to indicate the current default network.
3132 * @param hasConnectivity {@code true} if the application was able to successfully access the
3133 * Internet using {@code network} or {@code false} if not.
3134 */
3135 public void reportNetworkConnectivity(@Nullable Network network, boolean hasConnectivity) {
3136 printStackTrace();
3137 try {
3138 mService.reportNetworkConnectivity(network, hasConnectivity);
3139 } catch (RemoteException e) {
3140 throw e.rethrowFromSystemServer();
3141 }
3142 }
3143
3144 /**
3145 * Set a network-independent global http proxy. This is not normally what you want
3146 * for typical HTTP proxies - they are general network dependent. However if you're
3147 * doing something unusual like general internal filtering this may be useful. On
3148 * a private network where the proxy is not accessible, you may break HTTP using this.
3149 *
3150 * @param p A {@link ProxyInfo} object defining the new global
3151 * HTTP proxy. A {@code null} value will clear the global HTTP proxy.
3152 * @hide
3153 */
Chiachang Wangf9294e72021-03-18 09:44:34 +08003154 @SystemApi(client = MODULE_LIBRARIES)
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003155 @RequiresPermission(android.Manifest.permission.NETWORK_STACK)
Chiachang Wangf9294e72021-03-18 09:44:34 +08003156 public void setGlobalProxy(@Nullable ProxyInfo p) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003157 try {
3158 mService.setGlobalProxy(p);
3159 } catch (RemoteException e) {
3160 throw e.rethrowFromSystemServer();
3161 }
3162 }
3163
3164 /**
3165 * Retrieve any network-independent global HTTP proxy.
3166 *
3167 * @return {@link ProxyInfo} for the current global HTTP proxy or {@code null}
3168 * if no global HTTP proxy is set.
3169 * @hide
3170 */
Chiachang Wangf9294e72021-03-18 09:44:34 +08003171 @SystemApi(client = MODULE_LIBRARIES)
3172 @Nullable
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003173 public ProxyInfo getGlobalProxy() {
3174 try {
3175 return mService.getGlobalProxy();
3176 } catch (RemoteException e) {
3177 throw e.rethrowFromSystemServer();
3178 }
3179 }
3180
3181 /**
3182 * Retrieve the global HTTP proxy, or if no global HTTP proxy is set, a
3183 * network-specific HTTP proxy. If {@code network} is null, the
3184 * network-specific proxy returned is the proxy of the default active
3185 * network.
3186 *
3187 * @return {@link ProxyInfo} for the current global HTTP proxy, or if no
3188 * global HTTP proxy is set, {@code ProxyInfo} for {@code network},
3189 * or when {@code network} is {@code null},
3190 * the {@code ProxyInfo} for the default active network. Returns
3191 * {@code null} when no proxy applies or the caller doesn't have
3192 * permission to use {@code network}.
3193 * @hide
3194 */
3195 public ProxyInfo getProxyForNetwork(Network network) {
3196 try {
3197 return mService.getProxyForNetwork(network);
3198 } catch (RemoteException e) {
3199 throw e.rethrowFromSystemServer();
3200 }
3201 }
3202
3203 /**
3204 * Get the current default HTTP proxy settings. If a global proxy is set it will be returned,
3205 * otherwise if this process is bound to a {@link Network} using
3206 * {@link #bindProcessToNetwork} then that {@code Network}'s proxy is returned, otherwise
3207 * the default network's proxy is returned.
3208 *
3209 * @return the {@link ProxyInfo} for the current HTTP proxy, or {@code null} if no
3210 * HTTP proxy is active.
3211 */
3212 @Nullable
3213 public ProxyInfo getDefaultProxy() {
3214 return getProxyForNetwork(getBoundNetworkForProcess());
3215 }
3216
3217 /**
3218 * Returns true if the hardware supports the given network type
3219 * else it returns false. This doesn't indicate we have coverage
3220 * or are authorized onto a network, just whether or not the
3221 * hardware supports it. For example a GSM phone without a SIM
3222 * should still return {@code true} for mobile data, but a wifi only
3223 * tablet would return {@code false}.
3224 *
3225 * @param networkType The network type we'd like to check
3226 * @return {@code true} if supported, else {@code false}
3227 * @deprecated Types are deprecated. Use {@link NetworkCapabilities} instead.
3228 * @hide
3229 */
3230 @Deprecated
3231 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
3232 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 130143562)
3233 public boolean isNetworkSupported(int networkType) {
3234 try {
3235 return mService.isNetworkSupported(networkType);
3236 } catch (RemoteException e) {
3237 throw e.rethrowFromSystemServer();
3238 }
3239 }
3240
3241 /**
3242 * Returns if the currently active data network is metered. A network is
3243 * classified as metered when the user is sensitive to heavy data usage on
3244 * that connection due to monetary costs, data limitations or
3245 * battery/performance issues. You should check this before doing large
3246 * data transfers, and warn the user or delay the operation until another
3247 * network is available.
3248 *
3249 * @return {@code true} if large transfers should be avoided, otherwise
3250 * {@code false}.
3251 */
3252 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
3253 public boolean isActiveNetworkMetered() {
3254 try {
3255 return mService.isActiveNetworkMetered();
3256 } catch (RemoteException e) {
3257 throw e.rethrowFromSystemServer();
3258 }
3259 }
3260
3261 /**
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003262 * Set sign in error notification to visible or invisible
3263 *
3264 * @hide
3265 * @deprecated Doesn't properly deal with multiple connected networks of the same type.
3266 */
3267 @Deprecated
3268 public void setProvisioningNotificationVisible(boolean visible, int networkType,
3269 String action) {
3270 try {
3271 mService.setProvisioningNotificationVisible(visible, networkType, action);
3272 } catch (RemoteException e) {
3273 throw e.rethrowFromSystemServer();
3274 }
3275 }
3276
3277 /**
3278 * Set the value for enabling/disabling airplane mode
3279 *
3280 * @param enable whether to enable airplane mode or not
3281 *
3282 * @hide
3283 */
3284 @RequiresPermission(anyOf = {
3285 android.Manifest.permission.NETWORK_AIRPLANE_MODE,
3286 android.Manifest.permission.NETWORK_SETTINGS,
3287 android.Manifest.permission.NETWORK_SETUP_WIZARD,
3288 android.Manifest.permission.NETWORK_STACK})
3289 @SystemApi
3290 public void setAirplaneMode(boolean enable) {
3291 try {
3292 mService.setAirplaneMode(enable);
3293 } catch (RemoteException e) {
3294 throw e.rethrowFromSystemServer();
3295 }
3296 }
3297
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003298 /**
3299 * Registers the specified {@link NetworkProvider}.
3300 * Each listener must only be registered once. The listener can be unregistered with
3301 * {@link #unregisterNetworkProvider}.
3302 *
3303 * @param provider the provider to register
3304 * @return the ID of the provider. This ID must be used by the provider when registering
3305 * {@link android.net.NetworkAgent}s.
3306 * @hide
3307 */
3308 @SystemApi
3309 @RequiresPermission(anyOf = {
3310 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
3311 android.Manifest.permission.NETWORK_FACTORY})
3312 public int registerNetworkProvider(@NonNull NetworkProvider provider) {
3313 if (provider.getProviderId() != NetworkProvider.ID_NONE) {
3314 throw new IllegalStateException("NetworkProviders can only be registered once");
3315 }
3316
3317 try {
3318 int providerId = mService.registerNetworkProvider(provider.getMessenger(),
3319 provider.getName());
3320 provider.setProviderId(providerId);
3321 } catch (RemoteException e) {
3322 throw e.rethrowFromSystemServer();
3323 }
3324 return provider.getProviderId();
3325 }
3326
3327 /**
3328 * Unregisters the specified NetworkProvider.
3329 *
3330 * @param provider the provider to unregister
3331 * @hide
3332 */
3333 @SystemApi
3334 @RequiresPermission(anyOf = {
3335 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
3336 android.Manifest.permission.NETWORK_FACTORY})
3337 public void unregisterNetworkProvider(@NonNull NetworkProvider provider) {
3338 try {
3339 mService.unregisterNetworkProvider(provider.getMessenger());
3340 } catch (RemoteException e) {
3341 throw e.rethrowFromSystemServer();
3342 }
3343 provider.setProviderId(NetworkProvider.ID_NONE);
3344 }
3345
Chalard Jeand1b498b2021-01-05 08:40:09 +09003346 /**
3347 * Register or update a network offer with ConnectivityService.
3348 *
3349 * ConnectivityService keeps track of offers made by the various providers and matches
Chalard Jean61e231f2021-03-24 17:43:10 +09003350 * them to networking requests made by apps or the system. A callback identifies an offer
3351 * uniquely, and later calls with the same callback update the offer. The provider supplies a
3352 * score and the capabilities of the network it might be able to bring up ; these act as
3353 * filters used by ConnectivityService to only send those requests that can be fulfilled by the
Chalard Jeand1b498b2021-01-05 08:40:09 +09003354 * provider.
3355 *
3356 * The provider is under no obligation to be able to bring up the network it offers at any
3357 * given time. Instead, this mechanism is meant to limit requests received by providers
3358 * to those they actually have a chance to fulfill, as providers don't have a way to compare
3359 * the quality of the network satisfying a given request to their own offer.
3360 *
3361 * An offer can be updated by calling this again with the same callback object. This is
3362 * similar to calling unofferNetwork and offerNetwork again, but will only update the
3363 * provider with the changes caused by the changes in the offer.
3364 *
3365 * @param provider The provider making this offer.
3366 * @param score The prospective score of the network.
3367 * @param caps The prospective capabilities of the network.
3368 * @param callback The callback to call when this offer is needed or unneeded.
Chalard Jean428b9132021-01-12 10:58:56 +09003369 * @hide exposed via the NetworkProvider class.
Chalard Jeand1b498b2021-01-05 08:40:09 +09003370 */
3371 @RequiresPermission(anyOf = {
3372 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
3373 android.Manifest.permission.NETWORK_FACTORY})
Chalard Jean148dcce2021-03-22 22:44:02 +09003374 public void offerNetwork(@NonNull final int providerId,
Chalard Jeand1b498b2021-01-05 08:40:09 +09003375 @NonNull final NetworkScore score, @NonNull final NetworkCapabilities caps,
3376 @NonNull final INetworkOfferCallback callback) {
3377 try {
Chalard Jean148dcce2021-03-22 22:44:02 +09003378 mService.offerNetwork(providerId,
Chalard Jeand1b498b2021-01-05 08:40:09 +09003379 Objects.requireNonNull(score, "null score"),
3380 Objects.requireNonNull(caps, "null caps"),
3381 Objects.requireNonNull(callback, "null callback"));
3382 } catch (RemoteException e) {
3383 throw e.rethrowFromSystemServer();
3384 }
3385 }
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003386
Chalard Jeand1b498b2021-01-05 08:40:09 +09003387 /**
3388 * Withdraw a network offer made with {@link #offerNetwork}.
3389 *
3390 * @param callback The callback passed at registration time. This must be the same object
3391 * that was passed to {@link #offerNetwork}
Chalard Jean428b9132021-01-12 10:58:56 +09003392 * @hide exposed via the NetworkProvider class.
Chalard Jeand1b498b2021-01-05 08:40:09 +09003393 */
3394 public void unofferNetwork(@NonNull final INetworkOfferCallback callback) {
3395 try {
3396 mService.unofferNetwork(Objects.requireNonNull(callback));
3397 } catch (RemoteException e) {
3398 throw e.rethrowFromSystemServer();
3399 }
3400 }
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003401 /** @hide exposed via the NetworkProvider class. */
3402 @RequiresPermission(anyOf = {
3403 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
3404 android.Manifest.permission.NETWORK_FACTORY})
3405 public void declareNetworkRequestUnfulfillable(@NonNull NetworkRequest request) {
3406 try {
3407 mService.declareNetworkRequestUnfulfillable(request);
3408 } catch (RemoteException e) {
3409 throw e.rethrowFromSystemServer();
3410 }
3411 }
3412
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003413 /**
3414 * @hide
3415 * Register a NetworkAgent with ConnectivityService.
3416 * @return Network corresponding to NetworkAgent.
3417 */
3418 @RequiresPermission(anyOf = {
3419 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
3420 android.Manifest.permission.NETWORK_FACTORY})
3421 public Network registerNetworkAgent(INetworkAgent na, NetworkInfo ni, LinkProperties lp,
Chalard Jeand6372722020-12-21 18:36:52 +09003422 NetworkCapabilities nc, @NonNull NetworkScore score, NetworkAgentConfig config,
3423 int providerId) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003424 try {
3425 return mService.registerNetworkAgent(na, ni, lp, nc, score, config, providerId);
3426 } catch (RemoteException e) {
3427 throw e.rethrowFromSystemServer();
3428 }
3429 }
3430
3431 /**
3432 * Base class for {@code NetworkRequest} callbacks. Used for notifications about network
3433 * changes. Should be extended by applications wanting notifications.
3434 *
3435 * A {@code NetworkCallback} is registered by calling
3436 * {@link #requestNetwork(NetworkRequest, NetworkCallback)},
3437 * {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)},
3438 * or {@link #registerDefaultNetworkCallback(NetworkCallback)}. A {@code NetworkCallback} is
3439 * unregistered by calling {@link #unregisterNetworkCallback(NetworkCallback)}.
3440 * A {@code NetworkCallback} should be registered at most once at any time.
3441 * A {@code NetworkCallback} that has been unregistered can be registered again.
3442 */
3443 public static class NetworkCallback {
3444 /**
Roshan Piuse08bc182020-12-22 15:10:42 -08003445 * No flags associated with this callback.
3446 * @hide
3447 */
3448 public static final int FLAG_NONE = 0;
3449 /**
3450 * Use this flag to include any location sensitive data in {@link NetworkCapabilities} sent
3451 * via {@link #onCapabilitiesChanged(Network, NetworkCapabilities)}.
3452 * <p>
3453 * These include:
3454 * <li> Some transport info instances (retrieved via
3455 * {@link NetworkCapabilities#getTransportInfo()}) like {@link android.net.wifi.WifiInfo}
3456 * contain location sensitive information.
3457 * <li> OwnerUid (retrieved via {@link NetworkCapabilities#getOwnerUid()} is location
3458 * sensitive for wifi suggestor apps (i.e using {@link WifiNetworkSuggestion}).</li>
3459 * </p>
3460 * <p>
3461 * Note:
3462 * <li> Retrieving this location sensitive information (subject to app's location
3463 * permissions) will be noted by system. </li>
3464 * <li> Without this flag any {@link NetworkCapabilities} provided via the callback does
3465 * not include location sensitive info.
3466 * </p>
3467 */
3468 public static final int FLAG_INCLUDE_LOCATION_INFO = 1 << 0;
3469
3470 /** @hide */
3471 @Retention(RetentionPolicy.SOURCE)
3472 @IntDef(flag = true, prefix = "FLAG_", value = {
3473 FLAG_NONE,
3474 FLAG_INCLUDE_LOCATION_INFO
3475 })
3476 public @interface Flag { }
3477
3478 /**
3479 * All the valid flags for error checking.
3480 */
3481 private static final int VALID_FLAGS = FLAG_INCLUDE_LOCATION_INFO;
3482
3483 public NetworkCallback() {
3484 this(FLAG_NONE);
3485 }
3486
3487 public NetworkCallback(@Flag int flags) {
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00003488 if ((flags & VALID_FLAGS) != flags) {
3489 throw new IllegalArgumentException("Invalid flags");
3490 }
Roshan Piuse08bc182020-12-22 15:10:42 -08003491 mFlags = flags;
3492 }
3493
3494 /**
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003495 * Called when the framework connects to a new network to evaluate whether it satisfies this
3496 * request. If evaluation succeeds, this callback may be followed by an {@link #onAvailable}
3497 * callback. There is no guarantee that this new network will satisfy any requests, or that
3498 * the network will stay connected for longer than the time necessary to evaluate it.
3499 * <p>
3500 * Most applications <b>should not</b> act on this callback, and should instead use
3501 * {@link #onAvailable}. This callback is intended for use by applications that can assist
3502 * the framework in properly evaluating the network &mdash; for example, an application that
3503 * can automatically log in to a captive portal without user intervention.
3504 *
3505 * @param network The {@link Network} of the network that is being evaluated.
3506 *
3507 * @hide
3508 */
3509 public void onPreCheck(@NonNull Network network) {}
3510
3511 /**
3512 * Called when the framework connects and has declared a new network ready for use.
3513 * This callback may be called more than once if the {@link Network} that is
3514 * satisfying the request changes.
3515 *
3516 * @param network The {@link Network} of the satisfying network.
3517 * @param networkCapabilities The {@link NetworkCapabilities} of the satisfying network.
3518 * @param linkProperties The {@link LinkProperties} of the satisfying network.
3519 * @param blocked Whether access to the {@link Network} is blocked due to system policy.
3520 * @hide
3521 */
Lorenzo Colitti8ad58122021-03-18 00:54:57 +09003522 public final void onAvailable(@NonNull Network network,
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003523 @NonNull NetworkCapabilities networkCapabilities,
Lorenzo Colitti8ad58122021-03-18 00:54:57 +09003524 @NonNull LinkProperties linkProperties, @BlockedReason int blocked) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003525 // Internally only this method is called when a new network is available, and
3526 // it calls the callback in the same way and order that older versions used
3527 // to call so as not to change the behavior.
Lorenzo Colitti8ad58122021-03-18 00:54:57 +09003528 onAvailable(network, networkCapabilities, linkProperties, blocked != 0);
3529 onBlockedStatusChanged(network, blocked);
3530 }
3531
3532 /**
3533 * Legacy variant of onAvailable that takes a boolean blocked reason.
3534 *
3535 * This method has never been public API, but it's not final, so there may be apps that
3536 * implemented it and rely on it being called. Do our best not to break them.
3537 * Note: such apps will also get a second call to onBlockedStatusChanged immediately after
3538 * this method is called. There does not seem to be a way to avoid this.
3539 * TODO: add a compat check to move apps off this method, and eventually stop calling it.
3540 *
3541 * @hide
3542 */
3543 public void onAvailable(@NonNull Network network,
3544 @NonNull NetworkCapabilities networkCapabilities,
3545 @NonNull LinkProperties linkProperties, boolean blocked) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003546 onAvailable(network);
3547 if (!networkCapabilities.hasCapability(
3548 NetworkCapabilities.NET_CAPABILITY_NOT_SUSPENDED)) {
3549 onNetworkSuspended(network);
3550 }
3551 onCapabilitiesChanged(network, networkCapabilities);
3552 onLinkPropertiesChanged(network, linkProperties);
Lorenzo Colitti8ad58122021-03-18 00:54:57 +09003553 // No call to onBlockedStatusChanged here. That is done by the caller.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003554 }
3555
3556 /**
3557 * Called when the framework connects and has declared a new network ready for use.
3558 *
3559 * <p>For callbacks registered with {@link #registerNetworkCallback}, multiple networks may
3560 * be available at the same time, and onAvailable will be called for each of these as they
3561 * appear.
3562 *
3563 * <p>For callbacks registered with {@link #requestNetwork} and
3564 * {@link #registerDefaultNetworkCallback}, this means the network passed as an argument
3565 * is the new best network for this request and is now tracked by this callback ; this
3566 * callback will no longer receive method calls about other networks that may have been
3567 * passed to this method previously. The previously-best network may have disconnected, or
3568 * it may still be around and the newly-best network may simply be better.
3569 *
3570 * <p>Starting with {@link android.os.Build.VERSION_CODES#O}, this will always immediately
3571 * be followed by a call to {@link #onCapabilitiesChanged(Network, NetworkCapabilities)}
3572 * then by a call to {@link #onLinkPropertiesChanged(Network, LinkProperties)}, and a call
3573 * to {@link #onBlockedStatusChanged(Network, boolean)}.
3574 *
3575 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
3576 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
3577 * this callback as this is prone to race conditions (there is no guarantee the objects
3578 * returned by these methods will be current). Instead, wait for a call to
3579 * {@link #onCapabilitiesChanged(Network, NetworkCapabilities)} and
3580 * {@link #onLinkPropertiesChanged(Network, LinkProperties)} whose arguments are guaranteed
3581 * to be well-ordered with respect to other callbacks.
3582 *
3583 * @param network The {@link Network} of the satisfying network.
3584 */
3585 public void onAvailable(@NonNull Network network) {}
3586
3587 /**
3588 * Called when the network is about to be lost, typically because there are no outstanding
3589 * requests left for it. This may be paired with a {@link NetworkCallback#onAvailable} call
3590 * with the new replacement network for graceful handover. This method is not guaranteed
3591 * to be called before {@link NetworkCallback#onLost} is called, for example in case a
3592 * network is suddenly disconnected.
3593 *
3594 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
3595 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
3596 * this callback as this is prone to race conditions ; calling these methods while in a
3597 * callback may return an outdated or even a null object.
3598 *
3599 * @param network The {@link Network} that is about to be lost.
3600 * @param maxMsToLive The time in milliseconds the system intends to keep the network
3601 * connected for graceful handover; note that the network may still
3602 * suffer a hard loss at any time.
3603 */
3604 public void onLosing(@NonNull Network network, int maxMsToLive) {}
3605
3606 /**
3607 * Called when a network disconnects or otherwise no longer satisfies this request or
3608 * callback.
3609 *
3610 * <p>If the callback was registered with requestNetwork() or
3611 * registerDefaultNetworkCallback(), it will only be invoked against the last network
3612 * returned by onAvailable() when that network is lost and no other network satisfies
3613 * the criteria of the request.
3614 *
3615 * <p>If the callback was registered with registerNetworkCallback() it will be called for
3616 * each network which no longer satisfies the criteria of the callback.
3617 *
3618 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
3619 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
3620 * this callback as this is prone to race conditions ; calling these methods while in a
3621 * callback may return an outdated or even a null object.
3622 *
3623 * @param network The {@link Network} lost.
3624 */
3625 public void onLost(@NonNull Network network) {}
3626
3627 /**
3628 * Called if no network is found within the timeout time specified in
3629 * {@link #requestNetwork(NetworkRequest, NetworkCallback, int)} call or if the
3630 * requested network request cannot be fulfilled (whether or not a timeout was
3631 * specified). When this callback is invoked the associated
3632 * {@link NetworkRequest} will have already been removed and released, as if
3633 * {@link #unregisterNetworkCallback(NetworkCallback)} had been called.
3634 */
3635 public void onUnavailable() {}
3636
3637 /**
3638 * Called when the network corresponding to this request changes capabilities but still
3639 * satisfies the requested criteria.
3640 *
3641 * <p>Starting with {@link android.os.Build.VERSION_CODES#O} this method is guaranteed
3642 * to be called immediately after {@link #onAvailable}.
3643 *
3644 * <p>Do NOT call {@link #getLinkProperties(Network)} or other synchronous
3645 * ConnectivityManager methods in this callback as this is prone to race conditions :
3646 * calling these methods while in a callback may return an outdated or even a null object.
3647 *
3648 * @param network The {@link Network} whose capabilities have changed.
Roshan Piuse08bc182020-12-22 15:10:42 -08003649 * @param networkCapabilities The new {@link NetworkCapabilities} for this
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003650 * network.
3651 */
3652 public void onCapabilitiesChanged(@NonNull Network network,
3653 @NonNull NetworkCapabilities networkCapabilities) {}
3654
3655 /**
3656 * Called when the network corresponding to this request changes {@link LinkProperties}.
3657 *
3658 * <p>Starting with {@link android.os.Build.VERSION_CODES#O} this method is guaranteed
3659 * to be called immediately after {@link #onAvailable}.
3660 *
3661 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or other synchronous
3662 * ConnectivityManager methods in this callback as this is prone to race conditions :
3663 * calling these methods while in a callback may return an outdated or even a null object.
3664 *
3665 * @param network The {@link Network} whose link properties have changed.
3666 * @param linkProperties The new {@link LinkProperties} for this network.
3667 */
3668 public void onLinkPropertiesChanged(@NonNull Network network,
3669 @NonNull LinkProperties linkProperties) {}
3670
3671 /**
3672 * Called when the network the framework connected to for this request suspends data
3673 * transmission temporarily.
3674 *
3675 * <p>This generally means that while the TCP connections are still live temporarily
3676 * network data fails to transfer. To give a specific example, this is used on cellular
3677 * networks to mask temporary outages when driving through a tunnel, etc. In general this
3678 * means read operations on sockets on this network will block once the buffers are
3679 * drained, and write operations will block once the buffers are full.
3680 *
3681 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
3682 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
3683 * this callback as this is prone to race conditions (there is no guarantee the objects
3684 * returned by these methods will be current).
3685 *
3686 * @hide
3687 */
3688 public void onNetworkSuspended(@NonNull Network network) {}
3689
3690 /**
3691 * Called when the network the framework connected to for this request
3692 * returns from a {@link NetworkInfo.State#SUSPENDED} state. This should always be
3693 * preceded by a matching {@link NetworkCallback#onNetworkSuspended} call.
3694
3695 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
3696 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
3697 * this callback as this is prone to race conditions : calling these methods while in a
3698 * callback may return an outdated or even a null object.
3699 *
3700 * @hide
3701 */
3702 public void onNetworkResumed(@NonNull Network network) {}
3703
3704 /**
3705 * Called when access to the specified network is blocked or unblocked.
3706 *
3707 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
3708 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
3709 * this callback as this is prone to race conditions : calling these methods while in a
3710 * callback may return an outdated or even a null object.
3711 *
3712 * @param network The {@link Network} whose blocked status has changed.
3713 * @param blocked The blocked status of this {@link Network}.
3714 */
3715 public void onBlockedStatusChanged(@NonNull Network network, boolean blocked) {}
3716
Lorenzo Colitti8ad58122021-03-18 00:54:57 +09003717 /**
3718 * Called when access to the specified network is blocked or unblocked.
3719 *
3720 * If a NetworkCallback object implements this method,
3721 * {@link #onBlockedStatusChanged(Network, boolean)} will not be called.
3722 *
3723 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
3724 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
3725 * this callback as this is prone to race conditions : calling these methods while in a
3726 * callback may return an outdated or even a null object.
3727 *
3728 * @param network The {@link Network} whose blocked status has changed.
3729 * @param blocked The blocked status of this {@link Network}.
3730 * @hide
3731 */
3732 @SystemApi(client = MODULE_LIBRARIES)
3733 public void onBlockedStatusChanged(@NonNull Network network, @BlockedReason int blocked) {
3734 onBlockedStatusChanged(network, blocked != 0);
3735 }
3736
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003737 private NetworkRequest networkRequest;
Roshan Piuse08bc182020-12-22 15:10:42 -08003738 private final int mFlags;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003739 }
3740
3741 /**
3742 * Constant error codes used by ConnectivityService to communicate about failures and errors
3743 * across a Binder boundary.
3744 * @hide
3745 */
3746 public interface Errors {
3747 int TOO_MANY_REQUESTS = 1;
3748 }
3749
3750 /** @hide */
3751 public static class TooManyRequestsException extends RuntimeException {}
3752
3753 private static RuntimeException convertServiceException(ServiceSpecificException e) {
3754 switch (e.errorCode) {
3755 case Errors.TOO_MANY_REQUESTS:
3756 return new TooManyRequestsException();
3757 default:
3758 Log.w(TAG, "Unknown service error code " + e.errorCode);
3759 return new RuntimeException(e);
3760 }
3761 }
3762
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003763 /** @hide */
Remi NGUYEN VAN1b9f03a2021-03-12 15:24:06 +09003764 public static final int CALLBACK_PRECHECK = 1;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003765 /** @hide */
Remi NGUYEN VAN1b9f03a2021-03-12 15:24:06 +09003766 public static final int CALLBACK_AVAILABLE = 2;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003767 /** @hide arg1 = TTL */
Remi NGUYEN VAN1b9f03a2021-03-12 15:24:06 +09003768 public static final int CALLBACK_LOSING = 3;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003769 /** @hide */
Remi NGUYEN VAN1b9f03a2021-03-12 15:24:06 +09003770 public static final int CALLBACK_LOST = 4;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003771 /** @hide */
Remi NGUYEN VAN1b9f03a2021-03-12 15:24:06 +09003772 public static final int CALLBACK_UNAVAIL = 5;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003773 /** @hide */
Remi NGUYEN VAN1b9f03a2021-03-12 15:24:06 +09003774 public static final int CALLBACK_CAP_CHANGED = 6;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003775 /** @hide */
Remi NGUYEN VAN1b9f03a2021-03-12 15:24:06 +09003776 public static final int CALLBACK_IP_CHANGED = 7;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003777 /** @hide obj = NetworkCapabilities, arg1 = seq number */
Remi NGUYEN VAN1b9f03a2021-03-12 15:24:06 +09003778 private static final int EXPIRE_LEGACY_REQUEST = 8;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003779 /** @hide */
Remi NGUYEN VAN1b9f03a2021-03-12 15:24:06 +09003780 public static final int CALLBACK_SUSPENDED = 9;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003781 /** @hide */
Remi NGUYEN VAN1b9f03a2021-03-12 15:24:06 +09003782 public static final int CALLBACK_RESUMED = 10;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003783 /** @hide */
Remi NGUYEN VAN1b9f03a2021-03-12 15:24:06 +09003784 public static final int CALLBACK_BLK_CHANGED = 11;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003785
3786 /** @hide */
3787 public static String getCallbackName(int whichCallback) {
3788 switch (whichCallback) {
3789 case CALLBACK_PRECHECK: return "CALLBACK_PRECHECK";
3790 case CALLBACK_AVAILABLE: return "CALLBACK_AVAILABLE";
3791 case CALLBACK_LOSING: return "CALLBACK_LOSING";
3792 case CALLBACK_LOST: return "CALLBACK_LOST";
3793 case CALLBACK_UNAVAIL: return "CALLBACK_UNAVAIL";
3794 case CALLBACK_CAP_CHANGED: return "CALLBACK_CAP_CHANGED";
3795 case CALLBACK_IP_CHANGED: return "CALLBACK_IP_CHANGED";
3796 case EXPIRE_LEGACY_REQUEST: return "EXPIRE_LEGACY_REQUEST";
3797 case CALLBACK_SUSPENDED: return "CALLBACK_SUSPENDED";
3798 case CALLBACK_RESUMED: return "CALLBACK_RESUMED";
3799 case CALLBACK_BLK_CHANGED: return "CALLBACK_BLK_CHANGED";
3800 default:
3801 return Integer.toString(whichCallback);
3802 }
3803 }
3804
3805 private class CallbackHandler extends Handler {
3806 private static final String TAG = "ConnectivityManager.CallbackHandler";
3807 private static final boolean DBG = false;
3808
3809 CallbackHandler(Looper looper) {
3810 super(looper);
3811 }
3812
3813 CallbackHandler(Handler handler) {
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00003814 this(Objects.requireNonNull(handler, "Handler cannot be null.").getLooper());
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003815 }
3816
3817 @Override
3818 public void handleMessage(Message message) {
3819 if (message.what == EXPIRE_LEGACY_REQUEST) {
3820 expireRequest((NetworkCapabilities) message.obj, message.arg1);
3821 return;
3822 }
3823
3824 final NetworkRequest request = getObject(message, NetworkRequest.class);
3825 final Network network = getObject(message, Network.class);
3826 final NetworkCallback callback;
3827 synchronized (sCallbacks) {
3828 callback = sCallbacks.get(request);
3829 if (callback == null) {
3830 Log.w(TAG,
3831 "callback not found for " + getCallbackName(message.what) + " message");
3832 return;
3833 }
3834 if (message.what == CALLBACK_UNAVAIL) {
3835 sCallbacks.remove(request);
3836 callback.networkRequest = ALREADY_UNREGISTERED;
3837 }
3838 }
3839 if (DBG) {
3840 Log.d(TAG, getCallbackName(message.what) + " for network " + network);
3841 }
3842
3843 switch (message.what) {
3844 case CALLBACK_PRECHECK: {
3845 callback.onPreCheck(network);
3846 break;
3847 }
3848 case CALLBACK_AVAILABLE: {
3849 NetworkCapabilities cap = getObject(message, NetworkCapabilities.class);
3850 LinkProperties lp = getObject(message, LinkProperties.class);
Lorenzo Colitti8ad58122021-03-18 00:54:57 +09003851 callback.onAvailable(network, cap, lp, message.arg1);
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003852 break;
3853 }
3854 case CALLBACK_LOSING: {
3855 callback.onLosing(network, message.arg1);
3856 break;
3857 }
3858 case CALLBACK_LOST: {
3859 callback.onLost(network);
3860 break;
3861 }
3862 case CALLBACK_UNAVAIL: {
3863 callback.onUnavailable();
3864 break;
3865 }
3866 case CALLBACK_CAP_CHANGED: {
3867 NetworkCapabilities cap = getObject(message, NetworkCapabilities.class);
3868 callback.onCapabilitiesChanged(network, cap);
3869 break;
3870 }
3871 case CALLBACK_IP_CHANGED: {
3872 LinkProperties lp = getObject(message, LinkProperties.class);
3873 callback.onLinkPropertiesChanged(network, lp);
3874 break;
3875 }
3876 case CALLBACK_SUSPENDED: {
3877 callback.onNetworkSuspended(network);
3878 break;
3879 }
3880 case CALLBACK_RESUMED: {
3881 callback.onNetworkResumed(network);
3882 break;
3883 }
3884 case CALLBACK_BLK_CHANGED: {
Lorenzo Colitti8ad58122021-03-18 00:54:57 +09003885 callback.onBlockedStatusChanged(network, message.arg1);
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003886 }
3887 }
3888 }
3889
3890 private <T> T getObject(Message msg, Class<T> c) {
3891 return (T) msg.getData().getParcelable(c.getSimpleName());
3892 }
3893 }
3894
3895 private CallbackHandler getDefaultHandler() {
3896 synchronized (sCallbacks) {
3897 if (sCallbackHandler == null) {
3898 sCallbackHandler = new CallbackHandler(ConnectivityThread.getInstanceLooper());
3899 }
3900 return sCallbackHandler;
3901 }
3902 }
3903
3904 private static final HashMap<NetworkRequest, NetworkCallback> sCallbacks = new HashMap<>();
3905 private static CallbackHandler sCallbackHandler;
3906
Lorenzo Colitti5f26b192021-03-12 22:48:07 +09003907 private NetworkRequest sendRequestForNetwork(int asUid, NetworkCapabilities need,
3908 NetworkCallback callback, int timeoutMs, NetworkRequest.Type reqType, int legacyType,
3909 CallbackHandler handler) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003910 printStackTrace();
3911 checkCallbackNotNull(callback);
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00003912 if (reqType != TRACK_DEFAULT && reqType != TRACK_SYSTEM_DEFAULT && need == null) {
3913 throw new IllegalArgumentException("null NetworkCapabilities");
3914 }
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003915 final NetworkRequest request;
3916 final String callingPackageName = mContext.getOpPackageName();
3917 try {
3918 synchronized(sCallbacks) {
3919 if (callback.networkRequest != null
3920 && callback.networkRequest != ALREADY_UNREGISTERED) {
3921 // TODO: throw exception instead and enforce 1:1 mapping of callbacks
3922 // and requests (http://b/20701525).
3923 Log.e(TAG, "NetworkCallback was already registered");
3924 }
3925 Messenger messenger = new Messenger(handler);
3926 Binder binder = new Binder();
Roshan Piuse08bc182020-12-22 15:10:42 -08003927 final int callbackFlags = callback.mFlags;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003928 if (reqType == LISTEN) {
3929 request = mService.listenForNetwork(
Roshan Piuse08bc182020-12-22 15:10:42 -08003930 need, messenger, binder, callbackFlags, callingPackageName,
Roshan Piusa8a477b2020-12-17 14:53:09 -08003931 getAttributionTag());
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003932 } else {
3933 request = mService.requestNetwork(
Lorenzo Colitti5f26b192021-03-12 22:48:07 +09003934 asUid, need, reqType.ordinal(), messenger, timeoutMs, binder,
3935 legacyType, callbackFlags, callingPackageName, getAttributionTag());
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003936 }
3937 if (request != null) {
3938 sCallbacks.put(request, callback);
3939 }
3940 callback.networkRequest = request;
3941 }
3942 } catch (RemoteException e) {
3943 throw e.rethrowFromSystemServer();
3944 } catch (ServiceSpecificException e) {
3945 throw convertServiceException(e);
3946 }
3947 return request;
3948 }
3949
Lorenzo Colitti5f26b192021-03-12 22:48:07 +09003950 private NetworkRequest sendRequestForNetwork(NetworkCapabilities need, NetworkCallback callback,
3951 int timeoutMs, NetworkRequest.Type reqType, int legacyType, CallbackHandler handler) {
3952 return sendRequestForNetwork(Process.INVALID_UID, need, callback, timeoutMs, reqType,
3953 legacyType, handler);
3954 }
3955
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003956 /**
3957 * Helper function to request a network with a particular legacy type.
3958 *
3959 * This API is only for use in internal system code that requests networks with legacy type and
3960 * relies on CONNECTIVITY_ACTION broadcasts instead of NetworkCallbacks. New caller should use
3961 * {@link #requestNetwork(NetworkRequest, NetworkCallback, Handler)} instead.
3962 *
3963 * @param request {@link NetworkRequest} describing this request.
3964 * @param timeoutMs The time in milliseconds to attempt looking for a suitable network
3965 * before {@link NetworkCallback#onUnavailable()} is called. The timeout must
3966 * be a positive value (i.e. >0).
3967 * @param legacyType to specify the network type(#TYPE_*).
3968 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
3969 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
3970 * the callback must not be shared - it uniquely specifies this request.
3971 *
3972 * @hide
3973 */
3974 @SystemApi
3975 @RequiresPermission(NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK)
3976 public void requestNetwork(@NonNull NetworkRequest request,
3977 int timeoutMs, int legacyType, @NonNull Handler handler,
3978 @NonNull NetworkCallback networkCallback) {
3979 if (legacyType == TYPE_NONE) {
3980 throw new IllegalArgumentException("TYPE_NONE is meaningless legacy type");
3981 }
3982 CallbackHandler cbHandler = new CallbackHandler(handler);
3983 NetworkCapabilities nc = request.networkCapabilities;
3984 sendRequestForNetwork(nc, networkCallback, timeoutMs, REQUEST, legacyType, cbHandler);
3985 }
3986
3987 /**
Roshan Piuse08bc182020-12-22 15:10:42 -08003988 * Request a network to satisfy a set of {@link NetworkCapabilities}.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003989 *
3990 * <p>This method will attempt to find the best network that matches the passed
3991 * {@link NetworkRequest}, and to bring up one that does if none currently satisfies the
3992 * criteria. The platform will evaluate which network is the best at its own discretion.
3993 * Throughput, latency, cost per byte, policy, user preference and other considerations
3994 * may be factored in the decision of what is considered the best network.
3995 *
3996 * <p>As long as this request is outstanding, the platform will try to maintain the best network
3997 * matching this request, while always attempting to match the request to a better network if
3998 * possible. If a better match is found, the platform will switch this request to the now-best
3999 * network and inform the app of the newly best network by invoking
4000 * {@link NetworkCallback#onAvailable(Network)} on the provided callback. Note that the platform
4001 * will not try to maintain any other network than the best one currently matching the request:
4002 * a network not matching any network request may be disconnected at any time.
4003 *
4004 * <p>For example, an application could use this method to obtain a connected cellular network
4005 * even if the device currently has a data connection over Ethernet. This may cause the cellular
4006 * radio to consume additional power. Or, an application could inform the system that it wants
4007 * a network supporting sending MMSes and have the system let it know about the currently best
4008 * MMS-supporting network through the provided {@link NetworkCallback}.
4009 *
4010 * <p>The status of the request can be followed by listening to the various callbacks described
4011 * in {@link NetworkCallback}. The {@link Network} object passed to the callback methods can be
4012 * used to direct traffic to the network (although accessing some networks may be subject to
4013 * holding specific permissions). Callers will learn about the specific characteristics of the
4014 * network through
4015 * {@link NetworkCallback#onCapabilitiesChanged(Network, NetworkCapabilities)} and
4016 * {@link NetworkCallback#onLinkPropertiesChanged(Network, LinkProperties)}. The methods of the
4017 * provided {@link NetworkCallback} will only be invoked due to changes in the best network
4018 * matching the request at any given time; therefore when a better network matching the request
4019 * becomes available, the {@link NetworkCallback#onAvailable(Network)} method is called
4020 * with the new network after which no further updates are given about the previously-best
4021 * network, unless it becomes the best again at some later time. All callbacks are invoked
4022 * in order on the same thread, which by default is a thread created by the framework running
4023 * in the app.
4024 * {@see #requestNetwork(NetworkRequest, NetworkCallback, Handler)} to change where the
4025 * callbacks are invoked.
4026 *
4027 * <p>This{@link NetworkRequest} will live until released via
4028 * {@link #unregisterNetworkCallback(NetworkCallback)} or the calling application exits, at
4029 * which point the system may let go of the network at any time.
4030 *
4031 * <p>A version of this method which takes a timeout is
4032 * {@link #requestNetwork(NetworkRequest, NetworkCallback, int)}, that an app can use to only
4033 * wait for a limited amount of time for the network to become unavailable.
4034 *
4035 * <p>It is presently unsupported to request a network with mutable
4036 * {@link NetworkCapabilities} such as
4037 * {@link NetworkCapabilities#NET_CAPABILITY_VALIDATED} or
4038 * {@link NetworkCapabilities#NET_CAPABILITY_CAPTIVE_PORTAL}
4039 * as these {@code NetworkCapabilities} represent states that a particular
4040 * network may never attain, and whether a network will attain these states
4041 * is unknown prior to bringing up the network so the framework does not
4042 * know how to go about satisfying a request with these capabilities.
4043 *
4044 * <p>This method requires the caller to hold either the
4045 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
4046 * or the ability to modify system settings as determined by
4047 * {@link android.provider.Settings.System#canWrite}.</p>
4048 *
4049 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4050 * number of outstanding requests to 100 per app (identified by their UID), shared with
4051 * all variants of this method, of {@link #registerNetworkCallback} as well as
4052 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4053 * Requesting a network with this method will count toward this limit. If this limit is
4054 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4055 * make sure to unregister the callbacks with
4056 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4057 *
4058 * @param request {@link NetworkRequest} describing this request.
4059 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
4060 * the callback must not be shared - it uniquely specifies this request.
4061 * The callback is invoked on the default internal Handler.
4062 * @throws IllegalArgumentException if {@code request} contains invalid network capabilities.
4063 * @throws SecurityException if missing the appropriate permissions.
4064 * @throws RuntimeException if the app already has too many callbacks registered.
4065 */
4066 public void requestNetwork(@NonNull NetworkRequest request,
4067 @NonNull NetworkCallback networkCallback) {
4068 requestNetwork(request, networkCallback, getDefaultHandler());
4069 }
4070
4071 /**
Roshan Piuse08bc182020-12-22 15:10:42 -08004072 * Request a network to satisfy a set of {@link NetworkCapabilities}.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004073 *
4074 * This method behaves identically to {@link #requestNetwork(NetworkRequest, NetworkCallback)}
4075 * but runs all the callbacks on the passed Handler.
4076 *
4077 * <p>This method has the same permission requirements as
4078 * {@link #requestNetwork(NetworkRequest, NetworkCallback)}, is subject to the same limitations,
4079 * and throws the same exceptions in the same conditions.
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 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
4085 */
4086 public void requestNetwork(@NonNull NetworkRequest request,
4087 @NonNull NetworkCallback networkCallback, @NonNull Handler handler) {
4088 CallbackHandler cbHandler = new CallbackHandler(handler);
4089 NetworkCapabilities nc = request.networkCapabilities;
4090 sendRequestForNetwork(nc, networkCallback, 0, REQUEST, TYPE_NONE, cbHandler);
4091 }
4092
4093 /**
Roshan Piuse08bc182020-12-22 15:10:42 -08004094 * Request a network to satisfy a set of {@link NetworkCapabilities}, limited
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004095 * by a timeout.
4096 *
4097 * This function behaves identically to the non-timed-out version
4098 * {@link #requestNetwork(NetworkRequest, NetworkCallback)}, but if a suitable network
4099 * is not found within the given time (in milliseconds) the
4100 * {@link NetworkCallback#onUnavailable()} callback is called. The request can still be
4101 * released normally by calling {@link #unregisterNetworkCallback(NetworkCallback)} but does
4102 * not have to be released if timed-out (it is automatically released). Unregistering a
4103 * request that timed out is not an error.
4104 *
4105 * <p>Do not use this method to poll for the existence of specific networks (e.g. with a small
4106 * timeout) - {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)} is provided
4107 * for that purpose. Calling this method will attempt to bring up the requested network.
4108 *
4109 * <p>This method has the same permission requirements as
4110 * {@link #requestNetwork(NetworkRequest, NetworkCallback)}, is subject to the same limitations,
4111 * and throws the same exceptions in the same conditions.
4112 *
4113 * @param request {@link NetworkRequest} describing this request.
4114 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
4115 * the callback must not be shared - it uniquely specifies this request.
4116 * @param timeoutMs The time in milliseconds to attempt looking for a suitable network
4117 * before {@link NetworkCallback#onUnavailable()} is called. The timeout must
4118 * be a positive value (i.e. >0).
4119 */
4120 public void requestNetwork(@NonNull NetworkRequest request,
4121 @NonNull NetworkCallback networkCallback, int timeoutMs) {
4122 checkTimeout(timeoutMs);
4123 NetworkCapabilities nc = request.networkCapabilities;
4124 sendRequestForNetwork(nc, networkCallback, timeoutMs, REQUEST, TYPE_NONE,
4125 getDefaultHandler());
4126 }
4127
4128 /**
Roshan Piuse08bc182020-12-22 15:10:42 -08004129 * Request a network to satisfy a set of {@link NetworkCapabilities}, limited
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004130 * by a timeout.
4131 *
4132 * This method behaves identically to
4133 * {@link #requestNetwork(NetworkRequest, NetworkCallback, int)} but runs all the callbacks
4134 * on the passed Handler.
4135 *
4136 * <p>This method has the same permission requirements as
4137 * {@link #requestNetwork(NetworkRequest, NetworkCallback)}, is subject to the same limitations,
4138 * and throws the same exceptions in the same conditions.
4139 *
4140 * @param request {@link NetworkRequest} describing this request.
4141 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
4142 * the callback must not be shared - it uniquely specifies this request.
4143 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
4144 * @param timeoutMs The time in milliseconds to attempt looking for a suitable network
4145 * before {@link NetworkCallback#onUnavailable} is called.
4146 */
4147 public void requestNetwork(@NonNull NetworkRequest request,
4148 @NonNull NetworkCallback networkCallback, @NonNull Handler handler, int timeoutMs) {
4149 checkTimeout(timeoutMs);
4150 CallbackHandler cbHandler = new CallbackHandler(handler);
4151 NetworkCapabilities nc = request.networkCapabilities;
4152 sendRequestForNetwork(nc, networkCallback, timeoutMs, REQUEST, TYPE_NONE, cbHandler);
4153 }
4154
4155 /**
4156 * The lookup key for a {@link Network} object included with the intent after
4157 * successfully finding a network for the applications request. Retrieve it with
4158 * {@link android.content.Intent#getParcelableExtra(String)}.
4159 * <p>
4160 * Note that if you intend to invoke {@link Network#openConnection(java.net.URL)}
4161 * then you must get a ConnectivityManager instance before doing so.
4162 */
4163 public static final String EXTRA_NETWORK = "android.net.extra.NETWORK";
4164
4165 /**
4166 * The lookup key for a {@link NetworkRequest} object included with the intent after
4167 * successfully finding a network for the applications request. Retrieve it with
4168 * {@link android.content.Intent#getParcelableExtra(String)}.
4169 */
4170 public static final String EXTRA_NETWORK_REQUEST = "android.net.extra.NETWORK_REQUEST";
4171
4172
4173 /**
Roshan Piuse08bc182020-12-22 15:10:42 -08004174 * Request a network to satisfy a set of {@link NetworkCapabilities}.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004175 *
4176 * This function behaves identically to the version that takes a NetworkCallback, but instead
4177 * of {@link NetworkCallback} a {@link PendingIntent} is used. This means
4178 * the request may outlive the calling application and get called back when a suitable
4179 * network is found.
4180 * <p>
4181 * The operation is an Intent broadcast that goes to a broadcast receiver that
4182 * you registered with {@link Context#registerReceiver} or through the
4183 * &lt;receiver&gt; tag in an AndroidManifest.xml file
4184 * <p>
4185 * The operation Intent is delivered with two extras, a {@link Network} typed
4186 * extra called {@link #EXTRA_NETWORK} and a {@link NetworkRequest}
4187 * typed extra called {@link #EXTRA_NETWORK_REQUEST} containing
4188 * the original requests parameters. It is important to create a new,
4189 * {@link NetworkCallback} based request before completing the processing of the
4190 * Intent to reserve the network or it will be released shortly after the Intent
4191 * is processed.
4192 * <p>
4193 * If there is already a request for this Intent registered (with the equality of
4194 * two Intents defined by {@link Intent#filterEquals}), then it will be removed and
4195 * replaced by this one, effectively releasing the previous {@link NetworkRequest}.
4196 * <p>
4197 * The request may be released normally by calling
4198 * {@link #releaseNetworkRequest(android.app.PendingIntent)}.
4199 * <p>It is presently unsupported to request a network with either
4200 * {@link NetworkCapabilities#NET_CAPABILITY_VALIDATED} or
4201 * {@link NetworkCapabilities#NET_CAPABILITY_CAPTIVE_PORTAL}
4202 * as these {@code NetworkCapabilities} represent states that a particular
4203 * network may never attain, and whether a network will attain these states
4204 * is unknown prior to bringing up the network so the framework does not
4205 * know how to go about satisfying a request with these capabilities.
4206 *
4207 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4208 * number of outstanding requests to 100 per app (identified by their UID), shared with
4209 * all variants of this method, of {@link #registerNetworkCallback} as well as
4210 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4211 * Requesting a network with this method will count toward this limit. If this limit is
4212 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4213 * make sure to unregister the callbacks with {@link #unregisterNetworkCallback(PendingIntent)}
4214 * or {@link #releaseNetworkRequest(PendingIntent)}.
4215 *
4216 * <p>This method requires the caller to hold either the
4217 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
4218 * or the ability to modify system settings as determined by
4219 * {@link android.provider.Settings.System#canWrite}.</p>
4220 *
4221 * @param request {@link NetworkRequest} describing this request.
4222 * @param operation Action to perform when the network is available (corresponds
4223 * to the {@link NetworkCallback#onAvailable} call. Typically
4224 * comes from {@link PendingIntent#getBroadcast}. Cannot be null.
4225 * @throws IllegalArgumentException if {@code request} contains invalid network capabilities.
4226 * @throws SecurityException if missing the appropriate permissions.
4227 * @throws RuntimeException if the app already has too many callbacks registered.
4228 */
4229 public void requestNetwork(@NonNull NetworkRequest request,
4230 @NonNull PendingIntent operation) {
4231 printStackTrace();
4232 checkPendingIntentNotNull(operation);
4233 try {
4234 mService.pendingRequestForNetwork(
4235 request.networkCapabilities, operation, mContext.getOpPackageName(),
4236 getAttributionTag());
4237 } catch (RemoteException e) {
4238 throw e.rethrowFromSystemServer();
4239 } catch (ServiceSpecificException e) {
4240 throw convertServiceException(e);
4241 }
4242 }
4243
4244 /**
4245 * Removes a request made via {@link #requestNetwork(NetworkRequest, android.app.PendingIntent)}
4246 * <p>
4247 * This method has the same behavior as
4248 * {@link #unregisterNetworkCallback(android.app.PendingIntent)} with respect to
4249 * releasing network resources and disconnecting.
4250 *
4251 * @param operation A PendingIntent equal (as defined by {@link Intent#filterEquals}) to the
4252 * PendingIntent passed to
4253 * {@link #requestNetwork(NetworkRequest, android.app.PendingIntent)} with the
4254 * corresponding NetworkRequest you'd like to remove. Cannot be null.
4255 */
4256 public void releaseNetworkRequest(@NonNull PendingIntent operation) {
4257 printStackTrace();
4258 checkPendingIntentNotNull(operation);
4259 try {
4260 mService.releasePendingNetworkRequest(operation);
4261 } catch (RemoteException e) {
4262 throw e.rethrowFromSystemServer();
4263 }
4264 }
4265
4266 private static void checkPendingIntentNotNull(PendingIntent intent) {
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00004267 Objects.requireNonNull(intent, "PendingIntent cannot be null.");
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004268 }
4269
4270 private static void checkCallbackNotNull(NetworkCallback callback) {
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00004271 Objects.requireNonNull(callback, "null NetworkCallback");
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004272 }
4273
4274 private static void checkTimeout(int timeoutMs) {
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00004275 if (timeoutMs <= 0) {
4276 throw new IllegalArgumentException("timeoutMs must be strictly positive.");
4277 }
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004278 }
4279
4280 /**
4281 * Registers to receive notifications about all networks which satisfy the given
4282 * {@link NetworkRequest}. The callbacks will continue to be called until
4283 * either the application exits or {@link #unregisterNetworkCallback(NetworkCallback)} is
4284 * called.
4285 *
4286 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4287 * number of outstanding requests to 100 per app (identified by their UID), shared with
4288 * all variants of this method, of {@link #requestNetwork} as well as
4289 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4290 * Requesting a network with this method will count toward this limit. If this limit is
4291 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4292 * make sure to unregister the callbacks with
4293 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4294 *
4295 * @param request {@link NetworkRequest} describing this request.
4296 * @param networkCallback The {@link NetworkCallback} that the system will call as suitable
4297 * networks change state.
4298 * The callback is invoked on the default internal Handler.
4299 * @throws RuntimeException if the app already has too many callbacks registered.
4300 */
4301 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
4302 public void registerNetworkCallback(@NonNull NetworkRequest request,
4303 @NonNull NetworkCallback networkCallback) {
4304 registerNetworkCallback(request, networkCallback, getDefaultHandler());
4305 }
4306
4307 /**
4308 * Registers to receive notifications about all networks which satisfy the given
4309 * {@link NetworkRequest}. The callbacks will continue to be called until
4310 * either the application exits or {@link #unregisterNetworkCallback(NetworkCallback)} is
4311 * called.
4312 *
4313 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4314 * number of outstanding requests to 100 per app (identified by their UID), shared with
4315 * all variants of this method, of {@link #requestNetwork} as well as
4316 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4317 * Requesting a network with this method will count toward this limit. If this limit is
4318 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4319 * make sure to unregister the callbacks with
4320 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4321 *
4322 *
4323 * @param request {@link NetworkRequest} describing this request.
4324 * @param networkCallback The {@link NetworkCallback} that the system will call as suitable
4325 * networks change state.
4326 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
4327 * @throws RuntimeException if the app already has too many callbacks registered.
4328 */
4329 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
4330 public void registerNetworkCallback(@NonNull NetworkRequest request,
4331 @NonNull NetworkCallback networkCallback, @NonNull Handler handler) {
4332 CallbackHandler cbHandler = new CallbackHandler(handler);
4333 NetworkCapabilities nc = request.networkCapabilities;
4334 sendRequestForNetwork(nc, networkCallback, 0, LISTEN, TYPE_NONE, cbHandler);
4335 }
4336
4337 /**
4338 * Registers a PendingIntent to be sent when a network is available which satisfies the given
4339 * {@link NetworkRequest}.
4340 *
4341 * This function behaves identically to the version that takes a NetworkCallback, but instead
4342 * of {@link NetworkCallback} a {@link PendingIntent} is used. This means
4343 * the request may outlive the calling application and get called back when a suitable
4344 * network is found.
4345 * <p>
4346 * The operation is an Intent broadcast that goes to a broadcast receiver that
4347 * you registered with {@link Context#registerReceiver} or through the
4348 * &lt;receiver&gt; tag in an AndroidManifest.xml file
4349 * <p>
4350 * The operation Intent is delivered with two extras, a {@link Network} typed
4351 * extra called {@link #EXTRA_NETWORK} and a {@link NetworkRequest}
4352 * typed extra called {@link #EXTRA_NETWORK_REQUEST} containing
4353 * the original requests parameters.
4354 * <p>
4355 * If there is already a request for this Intent registered (with the equality of
4356 * two Intents defined by {@link Intent#filterEquals}), then it will be removed and
4357 * replaced by this one, effectively releasing the previous {@link NetworkRequest}.
4358 * <p>
4359 * The request may be released normally by calling
4360 * {@link #unregisterNetworkCallback(android.app.PendingIntent)}.
4361 *
4362 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4363 * number of outstanding requests to 100 per app (identified by their UID), shared with
4364 * all variants of this method, of {@link #requestNetwork} as well as
4365 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4366 * Requesting a network with this method will count toward this limit. If this limit is
4367 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4368 * make sure to unregister the callbacks with {@link #unregisterNetworkCallback(PendingIntent)}
4369 * or {@link #releaseNetworkRequest(PendingIntent)}.
4370 *
4371 * @param request {@link NetworkRequest} describing this request.
4372 * @param operation Action to perform when the network is available (corresponds
4373 * to the {@link NetworkCallback#onAvailable} call. Typically
4374 * comes from {@link PendingIntent#getBroadcast}. Cannot be null.
4375 * @throws RuntimeException if the app already has too many callbacks registered.
4376 */
4377 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
4378 public void registerNetworkCallback(@NonNull NetworkRequest request,
4379 @NonNull PendingIntent operation) {
4380 printStackTrace();
4381 checkPendingIntentNotNull(operation);
4382 try {
4383 mService.pendingListenForNetwork(
Roshan Piusa8a477b2020-12-17 14:53:09 -08004384 request.networkCapabilities, operation, mContext.getOpPackageName(),
4385 getAttributionTag());
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004386 } catch (RemoteException e) {
4387 throw e.rethrowFromSystemServer();
4388 } catch (ServiceSpecificException e) {
4389 throw convertServiceException(e);
4390 }
4391 }
4392
4393 /**
Lorenzo Colittia77d05e2021-01-29 20:14:04 +09004394 * Registers to receive notifications about changes in the application's default network. This
4395 * may be a physical network or a virtual network, such as a VPN that applies to the
4396 * application. The callbacks will continue to be called until either the application exits or
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004397 * {@link #unregisterNetworkCallback(NetworkCallback)} is called.
4398 *
4399 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4400 * number of outstanding requests to 100 per app (identified by their UID), shared with
4401 * all variants of this method, of {@link #requestNetwork} as well as
4402 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4403 * Requesting a network with this method will count toward this limit. If this limit is
4404 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4405 * make sure to unregister the callbacks with
4406 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4407 *
4408 * @param networkCallback The {@link NetworkCallback} that the system will call as the
Lorenzo Colittia77d05e2021-01-29 20:14:04 +09004409 * application's default network changes.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004410 * The callback is invoked on the default internal Handler.
4411 * @throws RuntimeException if the app already has too many callbacks registered.
4412 */
4413 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
4414 public void registerDefaultNetworkCallback(@NonNull NetworkCallback networkCallback) {
4415 registerDefaultNetworkCallback(networkCallback, getDefaultHandler());
4416 }
4417
4418 /**
Lorenzo Colittia77d05e2021-01-29 20:14:04 +09004419 * Registers to receive notifications about changes in the application's default network. This
4420 * may be a physical network or a virtual network, such as a VPN that applies to the
4421 * application. The callbacks will continue to be called until either the application exits or
4422 * {@link #unregisterNetworkCallback(NetworkCallback)} is called.
4423 *
4424 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4425 * number of outstanding requests to 100 per app (identified by their UID), shared with
4426 * all variants of this method, of {@link #requestNetwork} as well as
4427 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4428 * Requesting a network with this method will count toward this limit. If this limit is
4429 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4430 * make sure to unregister the callbacks with
4431 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4432 *
4433 * @param networkCallback The {@link NetworkCallback} that the system will call as the
4434 * application's default network changes.
4435 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
4436 * @throws RuntimeException if the app already has too many callbacks registered.
4437 */
4438 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
4439 public void registerDefaultNetworkCallback(@NonNull NetworkCallback networkCallback,
4440 @NonNull Handler handler) {
Lorenzo Colitti5f26b192021-03-12 22:48:07 +09004441 registerDefaultNetworkCallbackAsUid(Process.INVALID_UID, networkCallback, handler);
4442 }
4443
4444 /**
4445 * Registers to receive notifications about changes in the default network for the specified
4446 * UID. This may be a physical network or a virtual network, such as a VPN that applies to the
4447 * UID. The callbacks will continue to be called until either the application exits or
4448 * {@link #unregisterNetworkCallback(NetworkCallback)} is called.
4449 *
4450 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4451 * number of outstanding requests to 100 per app (identified by their UID), shared with
4452 * all variants of this method, of {@link #requestNetwork} as well as
4453 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4454 * Requesting a network with this method will count toward this limit. If this limit is
4455 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4456 * make sure to unregister the callbacks with
4457 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4458 *
4459 * @param uid the UID for which to track default network changes.
4460 * @param networkCallback The {@link NetworkCallback} that the system will call as the
4461 * UID's default network changes.
4462 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
4463 * @throws RuntimeException if the app already has too many callbacks registered.
4464 * @hide
4465 */
Lorenzo Colittib90bdbd2021-03-22 18:23:21 +09004466 @SystemApi(client = MODULE_LIBRARIES)
Lorenzo Colitti5f26b192021-03-12 22:48:07 +09004467 @SuppressLint({"ExecutorRegistration", "PairedRegistration"})
4468 @RequiresPermission(anyOf = {
4469 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
4470 android.Manifest.permission.NETWORK_SETTINGS})
4471 public void registerDefaultNetworkCallbackAsUid(int uid,
4472 @NonNull NetworkCallback networkCallback, @NonNull Handler handler) {
Lorenzo Colittia77d05e2021-01-29 20:14:04 +09004473 CallbackHandler cbHandler = new CallbackHandler(handler);
Lorenzo Colitti5f26b192021-03-12 22:48:07 +09004474 sendRequestForNetwork(uid, null /* need */, networkCallback, 0 /* timeoutMs */,
Lorenzo Colittia77d05e2021-01-29 20:14:04 +09004475 TRACK_DEFAULT, TYPE_NONE, cbHandler);
4476 }
4477
4478 /**
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004479 * Registers to receive notifications about changes in the system default network. The callbacks
4480 * will continue to be called until either the application exits or
4481 * {@link #unregisterNetworkCallback(NetworkCallback)} is called.
4482 *
Lorenzo Colittia77d05e2021-01-29 20:14:04 +09004483 * This method should not be used to determine networking state seen by applications, because in
4484 * many cases, most or even all application traffic may not use the default network directly,
4485 * and traffic from different applications may go on different networks by default. As an
4486 * example, if a VPN is connected, traffic from all applications might be sent through the VPN
4487 * and not onto the system default network. Applications or system components desiring to do
4488 * determine network state as seen by applications should use other methods such as
4489 * {@link #registerDefaultNetworkCallback(NetworkCallback, Handler)}.
4490 *
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004491 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4492 * number of outstanding requests to 100 per app (identified by their UID), shared with
4493 * all variants of this method, of {@link #requestNetwork} as well as
4494 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4495 * Requesting a network with this method will count toward this limit. If this limit is
4496 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4497 * make sure to unregister the callbacks with
4498 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4499 *
4500 * @param networkCallback The {@link NetworkCallback} that the system will call as the
4501 * system default network changes.
4502 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
4503 * @throws RuntimeException if the app already has too many callbacks registered.
Lorenzo Colittia77d05e2021-01-29 20:14:04 +09004504 *
4505 * @hide
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004506 */
Lorenzo Colittia77d05e2021-01-29 20:14:04 +09004507 @SystemApi(client = MODULE_LIBRARIES)
4508 @SuppressLint({"ExecutorRegistration", "PairedRegistration"})
4509 @RequiresPermission(anyOf = {
4510 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
4511 android.Manifest.permission.NETWORK_SETTINGS})
4512 public void registerSystemDefaultNetworkCallback(@NonNull NetworkCallback networkCallback,
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004513 @NonNull Handler handler) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004514 CallbackHandler cbHandler = new CallbackHandler(handler);
4515 sendRequestForNetwork(null /* NetworkCapabilities need */, networkCallback, 0,
Lorenzo Colittia77d05e2021-01-29 20:14:04 +09004516 TRACK_SYSTEM_DEFAULT, TYPE_NONE, cbHandler);
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004517 }
4518
4519 /**
junyulaibd123062021-03-15 11:48:48 +08004520 * Registers to receive notifications about the best matching network which satisfy the given
4521 * {@link NetworkRequest}. The callbacks will continue to be called until
4522 * either the application exits or {@link #unregisterNetworkCallback(NetworkCallback)} is
4523 * called.
4524 *
4525 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4526 * number of outstanding requests to 100 per app (identified by their UID), shared with
4527 * {@link #registerNetworkCallback} and its variants and {@link #requestNetwork} as well as
4528 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4529 * Requesting a network with this method will count toward this limit. If this limit is
4530 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4531 * make sure to unregister the callbacks with
4532 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4533 *
4534 *
4535 * @param request {@link NetworkRequest} describing this request.
4536 * @param networkCallback The {@link NetworkCallback} that the system will call as suitable
4537 * networks change state.
4538 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
4539 * @throws RuntimeException if the app already has too many callbacks registered.
junyulai5a5c99b2021-03-05 15:51:17 +08004540 */
junyulai5a5c99b2021-03-05 15:51:17 +08004541 @SuppressLint("ExecutorRegistration")
4542 public void registerBestMatchingNetworkCallback(@NonNull NetworkRequest request,
4543 @NonNull NetworkCallback networkCallback, @NonNull Handler handler) {
4544 final NetworkCapabilities nc = request.networkCapabilities;
4545 final CallbackHandler cbHandler = new CallbackHandler(handler);
junyulai7664f622021-03-12 20:05:08 +08004546 sendRequestForNetwork(nc, networkCallback, 0, LISTEN_FOR_BEST, TYPE_NONE, cbHandler);
junyulai5a5c99b2021-03-05 15:51:17 +08004547 }
4548
4549 /**
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004550 * Requests bandwidth update for a given {@link Network} and returns whether the update request
4551 * is accepted by ConnectivityService. Once accepted, ConnectivityService will poll underlying
4552 * network connection for updated bandwidth information. The caller will be notified via
4553 * {@link ConnectivityManager.NetworkCallback} if there is an update. Notice that this
4554 * method assumes that the caller has previously called
4555 * {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)} to listen for network
4556 * changes.
4557 *
4558 * @param network {@link Network} specifying which network you're interested.
4559 * @return {@code true} on success, {@code false} if the {@link Network} is no longer valid.
4560 */
4561 public boolean requestBandwidthUpdate(@NonNull Network network) {
4562 try {
4563 return mService.requestBandwidthUpdate(network);
4564 } catch (RemoteException e) {
4565 throw e.rethrowFromSystemServer();
4566 }
4567 }
4568
4569 /**
4570 * Unregisters a {@code NetworkCallback} and possibly releases networks originating from
4571 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} and
4572 * {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)} calls.
4573 * If the given {@code NetworkCallback} had previously been used with
4574 * {@code #requestNetwork}, any networks that had been connected to only to satisfy that request
4575 * will be disconnected.
4576 *
4577 * Notifications that would have triggered that {@code NetworkCallback} will immediately stop
4578 * triggering it as soon as this call returns.
4579 *
4580 * @param networkCallback The {@link NetworkCallback} used when making the request.
4581 */
4582 public void unregisterNetworkCallback(@NonNull NetworkCallback networkCallback) {
4583 printStackTrace();
4584 checkCallbackNotNull(networkCallback);
4585 final List<NetworkRequest> reqs = new ArrayList<>();
4586 // Find all requests associated to this callback and stop callback triggers immediately.
4587 // Callback is reusable immediately. http://b/20701525, http://b/35921499.
4588 synchronized (sCallbacks) {
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00004589 if (networkCallback.networkRequest == null) {
4590 throw new IllegalArgumentException("NetworkCallback was not registered");
4591 }
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004592 if (networkCallback.networkRequest == ALREADY_UNREGISTERED) {
4593 Log.d(TAG, "NetworkCallback was already unregistered");
4594 return;
4595 }
4596 for (Map.Entry<NetworkRequest, NetworkCallback> e : sCallbacks.entrySet()) {
4597 if (e.getValue() == networkCallback) {
4598 reqs.add(e.getKey());
4599 }
4600 }
4601 // TODO: throw exception if callback was registered more than once (http://b/20701525).
4602 for (NetworkRequest r : reqs) {
4603 try {
4604 mService.releaseNetworkRequest(r);
4605 } catch (RemoteException e) {
4606 throw e.rethrowFromSystemServer();
4607 }
4608 // Only remove mapping if rpc was successful.
4609 sCallbacks.remove(r);
4610 }
4611 networkCallback.networkRequest = ALREADY_UNREGISTERED;
4612 }
4613 }
4614
4615 /**
4616 * Unregisters a callback previously registered via
4617 * {@link #registerNetworkCallback(NetworkRequest, android.app.PendingIntent)}.
4618 *
4619 * @param operation A PendingIntent equal (as defined by {@link Intent#filterEquals}) to the
4620 * PendingIntent passed to
4621 * {@link #registerNetworkCallback(NetworkRequest, android.app.PendingIntent)}.
4622 * Cannot be null.
4623 */
4624 public void unregisterNetworkCallback(@NonNull PendingIntent operation) {
4625 releaseNetworkRequest(operation);
4626 }
4627
4628 /**
4629 * Informs the system whether it should switch to {@code network} regardless of whether it is
4630 * validated or not. If {@code accept} is true, and the network was explicitly selected by the
4631 * user (e.g., by selecting a Wi-Fi network in the Settings app), then the network will become
4632 * the system default network regardless of any other network that's currently connected. If
4633 * {@code always} is true, then the choice is remembered, so that the next time the user
4634 * connects to this network, the system will switch to it.
4635 *
4636 * @param network The network to accept.
4637 * @param accept Whether to accept the network even if unvalidated.
4638 * @param always Whether to remember this choice in the future.
4639 *
4640 * @hide
4641 */
Chiachang Wangf9294e72021-03-18 09:44:34 +08004642 @SystemApi(client = MODULE_LIBRARIES)
4643 @RequiresPermission(anyOf = {
4644 android.Manifest.permission.NETWORK_SETTINGS,
4645 android.Manifest.permission.NETWORK_SETUP_WIZARD,
4646 android.Manifest.permission.NETWORK_STACK,
4647 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK})
4648 public void setAcceptUnvalidated(@NonNull Network network, boolean accept, boolean always) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004649 try {
4650 mService.setAcceptUnvalidated(network, accept, always);
4651 } catch (RemoteException e) {
4652 throw e.rethrowFromSystemServer();
4653 }
4654 }
4655
4656 /**
4657 * Informs the system whether it should consider the network as validated even if it only has
4658 * partial connectivity. If {@code accept} is true, then the network will be considered as
4659 * validated even if connectivity is only partial. If {@code always} is true, then the choice
4660 * is remembered, so that the next time the user connects to this network, the system will
4661 * switch to it.
4662 *
4663 * @param network The network to accept.
4664 * @param accept Whether to consider the network as validated even if it has partial
4665 * connectivity.
4666 * @param always Whether to remember this choice in the future.
4667 *
4668 * @hide
4669 */
Chiachang Wangf9294e72021-03-18 09:44:34 +08004670 @SystemApi(client = MODULE_LIBRARIES)
4671 @RequiresPermission(anyOf = {
4672 android.Manifest.permission.NETWORK_SETTINGS,
4673 android.Manifest.permission.NETWORK_SETUP_WIZARD,
4674 android.Manifest.permission.NETWORK_STACK,
4675 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK})
4676 public void setAcceptPartialConnectivity(@NonNull Network network, boolean accept,
4677 boolean always) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004678 try {
4679 mService.setAcceptPartialConnectivity(network, accept, always);
4680 } catch (RemoteException e) {
4681 throw e.rethrowFromSystemServer();
4682 }
4683 }
4684
4685 /**
4686 * Informs the system to penalize {@code network}'s score when it becomes unvalidated. This is
4687 * only meaningful if the system is configured not to penalize such networks, e.g., if the
4688 * {@code config_networkAvoidBadWifi} configuration variable is set to 0 and the {@code
4689 * NETWORK_AVOID_BAD_WIFI setting is unset}.
4690 *
4691 * @param network The network to accept.
4692 *
4693 * @hide
4694 */
Chiachang Wangf9294e72021-03-18 09:44:34 +08004695 @SystemApi(client = MODULE_LIBRARIES)
4696 @RequiresPermission(anyOf = {
4697 android.Manifest.permission.NETWORK_SETTINGS,
4698 android.Manifest.permission.NETWORK_SETUP_WIZARD,
4699 android.Manifest.permission.NETWORK_STACK,
4700 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK})
4701 public void setAvoidUnvalidated(@NonNull Network network) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004702 try {
4703 mService.setAvoidUnvalidated(network);
4704 } catch (RemoteException e) {
4705 throw e.rethrowFromSystemServer();
4706 }
4707 }
4708
4709 /**
4710 * Requests that the system open the captive portal app on the specified network.
4711 *
Remi NGUYEN VAN8238a762021-03-16 18:06:06 +09004712 * <p>This is to be used on networks where a captive portal was detected, as per
4713 * {@link NetworkCapabilities#NET_CAPABILITY_CAPTIVE_PORTAL}.
4714 *
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004715 * @param network The network to log into.
4716 *
4717 * @hide
4718 */
Remi NGUYEN VAN8238a762021-03-16 18:06:06 +09004719 @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
4720 @RequiresPermission(anyOf = {
4721 android.Manifest.permission.NETWORK_SETTINGS,
4722 android.Manifest.permission.NETWORK_STACK,
4723 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK
4724 })
4725 public void startCaptivePortalApp(@NonNull Network network) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004726 try {
4727 mService.startCaptivePortalApp(network);
4728 } catch (RemoteException e) {
4729 throw e.rethrowFromSystemServer();
4730 }
4731 }
4732
4733 /**
4734 * Requests that the system open the captive portal app with the specified extras.
4735 *
4736 * <p>This endpoint is exclusively for use by the NetworkStack and is protected by the
4737 * corresponding permission.
4738 * @param network Network on which the captive portal was detected.
4739 * @param appExtras Extras to include in the app start intent.
4740 * @hide
4741 */
4742 @SystemApi
4743 @RequiresPermission(NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK)
4744 public void startCaptivePortalApp(@NonNull Network network, @NonNull Bundle appExtras) {
4745 try {
4746 mService.startCaptivePortalAppInternal(network, appExtras);
4747 } catch (RemoteException e) {
4748 throw e.rethrowFromSystemServer();
4749 }
4750 }
4751
4752 /**
4753 * Determine whether the device is configured to avoid bad wifi.
4754 * @hide
4755 */
4756 @SystemApi
4757 @RequiresPermission(anyOf = {
4758 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
4759 android.Manifest.permission.NETWORK_STACK})
4760 public boolean shouldAvoidBadWifi() {
4761 try {
4762 return mService.shouldAvoidBadWifi();
4763 } catch (RemoteException e) {
4764 throw e.rethrowFromSystemServer();
4765 }
4766 }
4767
4768 /**
4769 * It is acceptable to briefly use multipath data to provide seamless connectivity for
4770 * time-sensitive user-facing operations when the system default network is temporarily
4771 * unresponsive. The amount of data should be limited (less than one megabyte for every call to
4772 * this method), and the operation should be infrequent to ensure that data usage is limited.
4773 *
4774 * An example of such an operation might be a time-sensitive foreground activity, such as a
4775 * voice command, that the user is performing while walking out of range of a Wi-Fi network.
4776 */
4777 public static final int MULTIPATH_PREFERENCE_HANDOVER = 1 << 0;
4778
4779 /**
4780 * It is acceptable to use small amounts of multipath data on an ongoing basis to provide
4781 * a backup channel for traffic that is primarily going over another network.
4782 *
4783 * An example might be maintaining backup connections to peers or servers for the purpose of
4784 * fast fallback if the default network is temporarily unresponsive or disconnects. The traffic
4785 * on backup paths should be negligible compared to the traffic on the main path.
4786 */
4787 public static final int MULTIPATH_PREFERENCE_RELIABILITY = 1 << 1;
4788
4789 /**
4790 * It is acceptable to use metered data to improve network latency and performance.
4791 */
4792 public static final int MULTIPATH_PREFERENCE_PERFORMANCE = 1 << 2;
4793
4794 /**
4795 * Return value to use for unmetered networks. On such networks we currently set all the flags
4796 * to true.
4797 * @hide
4798 */
4799 public static final int MULTIPATH_PREFERENCE_UNMETERED =
4800 MULTIPATH_PREFERENCE_HANDOVER |
4801 MULTIPATH_PREFERENCE_RELIABILITY |
4802 MULTIPATH_PREFERENCE_PERFORMANCE;
4803
4804 /** @hide */
4805 @Retention(RetentionPolicy.SOURCE)
4806 @IntDef(flag = true, value = {
4807 MULTIPATH_PREFERENCE_HANDOVER,
4808 MULTIPATH_PREFERENCE_RELIABILITY,
4809 MULTIPATH_PREFERENCE_PERFORMANCE,
4810 })
4811 public @interface MultipathPreference {
4812 }
4813
4814 /**
4815 * Provides a hint to the calling application on whether it is desirable to use the
4816 * multinetwork APIs (e.g., {@link Network#openConnection}, {@link Network#bindSocket}, etc.)
4817 * for multipath data transfer on this network when it is not the system default network.
4818 * Applications desiring to use multipath network protocols should call this method before
4819 * each such operation.
4820 *
4821 * @param network The network on which the application desires to use multipath data.
4822 * If {@code null}, this method will return the a preference that will generally
4823 * apply to metered networks.
4824 * @return a bitwise OR of zero or more of the {@code MULTIPATH_PREFERENCE_*} constants.
4825 */
4826 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
4827 public @MultipathPreference int getMultipathPreference(@Nullable Network network) {
4828 try {
4829 return mService.getMultipathPreference(network);
4830 } catch (RemoteException e) {
4831 throw e.rethrowFromSystemServer();
4832 }
4833 }
4834
4835 /**
4836 * Resets all connectivity manager settings back to factory defaults.
4837 * @hide
4838 */
Chiachang Wangf9294e72021-03-18 09:44:34 +08004839 @SystemApi(client = MODULE_LIBRARIES)
4840 @RequiresPermission(anyOf = {
4841 android.Manifest.permission.NETWORK_SETTINGS,
4842 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK})
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004843 public void factoryReset() {
4844 try {
4845 mService.factoryReset();
4846 mTetheringManager.stopAllTethering();
4847 } catch (RemoteException e) {
4848 throw e.rethrowFromSystemServer();
4849 }
4850 }
4851
4852 /**
4853 * Binds the current process to {@code network}. All Sockets created in the future
4854 * (and not explicitly bound via a bound SocketFactory from
4855 * {@link Network#getSocketFactory() Network.getSocketFactory()}) will be bound to
4856 * {@code network}. All host name resolutions will be limited to {@code network} as well.
4857 * Note that if {@code network} ever disconnects, all Sockets created in this way will cease to
4858 * work and all host name resolutions will fail. This is by design so an application doesn't
4859 * accidentally use Sockets it thinks are still bound to a particular {@link Network}.
4860 * To clear binding pass {@code null} for {@code network}. Using individually bound
4861 * Sockets created by Network.getSocketFactory().createSocket() and
4862 * performing network-specific host name resolutions via
4863 * {@link Network#getAllByName Network.getAllByName} is preferred to calling
4864 * {@code bindProcessToNetwork}.
4865 *
4866 * @param network The {@link Network} to bind the current process to, or {@code null} to clear
4867 * the current binding.
4868 * @return {@code true} on success, {@code false} if the {@link Network} is no longer valid.
4869 */
4870 public boolean bindProcessToNetwork(@Nullable Network network) {
4871 // Forcing callers to call through non-static function ensures ConnectivityManager
4872 // instantiated.
4873 return setProcessDefaultNetwork(network);
4874 }
4875
4876 /**
4877 * Binds the current process to {@code network}. All Sockets created in the future
4878 * (and not explicitly bound via a bound SocketFactory from
4879 * {@link Network#getSocketFactory() Network.getSocketFactory()}) will be bound to
4880 * {@code network}. All host name resolutions will be limited to {@code network} as well.
4881 * Note that if {@code network} ever disconnects, all Sockets created in this way will cease to
4882 * work and all host name resolutions will fail. This is by design so an application doesn't
4883 * accidentally use Sockets it thinks are still bound to a particular {@link Network}.
4884 * To clear binding pass {@code null} for {@code network}. Using individually bound
4885 * Sockets created by Network.getSocketFactory().createSocket() and
4886 * performing network-specific host name resolutions via
4887 * {@link Network#getAllByName Network.getAllByName} is preferred to calling
4888 * {@code setProcessDefaultNetwork}.
4889 *
4890 * @param network The {@link Network} to bind the current process to, or {@code null} to clear
4891 * the current binding.
4892 * @return {@code true} on success, {@code false} if the {@link Network} is no longer valid.
4893 * @deprecated This function can throw {@link IllegalStateException}. Use
4894 * {@link #bindProcessToNetwork} instead. {@code bindProcessToNetwork}
4895 * is a direct replacement.
4896 */
4897 @Deprecated
4898 public static boolean setProcessDefaultNetwork(@Nullable Network network) {
4899 int netId = (network == null) ? NETID_UNSET : network.netId;
4900 boolean isSameNetId = (netId == NetworkUtils.getBoundNetworkForProcess());
4901
4902 if (netId != NETID_UNSET) {
4903 netId = network.getNetIdForResolv();
4904 }
4905
4906 if (!NetworkUtils.bindProcessToNetwork(netId)) {
4907 return false;
4908 }
4909
4910 if (!isSameNetId) {
4911 // Set HTTP proxy system properties to match network.
4912 // TODO: Deprecate this static method and replace it with a non-static version.
4913 try {
Remi NGUYEN VAN8a831d62021-02-03 10:18:20 +09004914 Proxy.setHttpProxyConfiguration(getInstance().getDefaultProxy());
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004915 } catch (SecurityException e) {
4916 // The process doesn't have ACCESS_NETWORK_STATE, so we can't fetch the proxy.
4917 Log.e(TAG, "Can't set proxy properties", e);
4918 }
4919 // Must flush DNS cache as new network may have different DNS resolutions.
Remi NGUYEN VAN342dddd2021-03-18 23:27:19 +09004920 InetAddressCompat.clearDnsCache();
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004921 // Must flush socket pool as idle sockets will be bound to previous network and may
4922 // cause subsequent fetches to be performed on old network.
4923 NetworkEventDispatcher.getInstance().onNetworkConfigurationChanged();
4924 }
4925
4926 return true;
4927 }
4928
4929 /**
4930 * Returns the {@link Network} currently bound to this process via
4931 * {@link #bindProcessToNetwork}, or {@code null} if no {@link Network} is explicitly bound.
4932 *
4933 * @return {@code Network} to which this process is bound, or {@code null}.
4934 */
4935 @Nullable
4936 public Network getBoundNetworkForProcess() {
4937 // Forcing callers to call thru non-static function ensures ConnectivityManager
4938 // instantiated.
4939 return getProcessDefaultNetwork();
4940 }
4941
4942 /**
4943 * Returns the {@link Network} currently bound to this process via
4944 * {@link #bindProcessToNetwork}, or {@code null} if no {@link Network} is explicitly bound.
4945 *
4946 * @return {@code Network} to which this process is bound, or {@code null}.
4947 * @deprecated Using this function can lead to other functions throwing
4948 * {@link IllegalStateException}. Use {@link #getBoundNetworkForProcess} instead.
4949 * {@code getBoundNetworkForProcess} is a direct replacement.
4950 */
4951 @Deprecated
4952 @Nullable
4953 public static Network getProcessDefaultNetwork() {
4954 int netId = NetworkUtils.getBoundNetworkForProcess();
4955 if (netId == NETID_UNSET) return null;
4956 return new Network(netId);
4957 }
4958
4959 private void unsupportedStartingFrom(int version) {
4960 if (Process.myUid() == Process.SYSTEM_UID) {
4961 // The getApplicationInfo() call we make below is not supported in system context. Let
4962 // the call through here, and rely on the fact that ConnectivityService will refuse to
4963 // allow the system to use these APIs anyway.
4964 return;
4965 }
4966
4967 if (mContext.getApplicationInfo().targetSdkVersion >= version) {
4968 throw new UnsupportedOperationException(
4969 "This method is not supported in target SDK version " + version + " and above");
4970 }
4971 }
4972
4973 // Checks whether the calling app can use the legacy routing API (startUsingNetworkFeature,
4974 // stopUsingNetworkFeature, requestRouteToHost), and if not throw UnsupportedOperationException.
4975 // TODO: convert the existing system users (Tethering, GnssLocationProvider) to the new APIs and
4976 // remove these exemptions. Note that this check is not secure, and apps can still access these
4977 // functions by accessing ConnectivityService directly. However, it should be clear that doing
4978 // so is unsupported and may break in the future. http://b/22728205
4979 private void checkLegacyRoutingApiAccess() {
4980 unsupportedStartingFrom(VERSION_CODES.M);
4981 }
4982
4983 /**
4984 * Binds host resolutions performed by this process to {@code network}.
4985 * {@link #bindProcessToNetwork} takes precedence over this setting.
4986 *
4987 * @param network The {@link Network} to bind host resolutions from the current process to, or
4988 * {@code null} to clear the current binding.
4989 * @return {@code true} on success, {@code false} if the {@link Network} is no longer valid.
4990 * @hide
4991 * @deprecated This is strictly for legacy usage to support {@link #startUsingNetworkFeature}.
4992 */
4993 @Deprecated
4994 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
4995 public static boolean setProcessDefaultNetworkForHostResolution(Network network) {
4996 return NetworkUtils.bindProcessToNetworkForHostResolution(
4997 (network == null) ? NETID_UNSET : network.getNetIdForResolv());
4998 }
4999
5000 /**
5001 * Device is not restricting metered network activity while application is running on
5002 * background.
5003 */
5004 public static final int RESTRICT_BACKGROUND_STATUS_DISABLED = 1;
5005
5006 /**
5007 * Device is restricting metered network activity while application is running on background,
5008 * but application is allowed to bypass it.
5009 * <p>
5010 * In this state, application should take action to mitigate metered network access.
5011 * For example, a music streaming application should switch to a low-bandwidth bitrate.
5012 */
5013 public static final int RESTRICT_BACKGROUND_STATUS_WHITELISTED = 2;
5014
5015 /**
5016 * Device is restricting metered network activity while application is running on background.
5017 * <p>
5018 * In this state, application should not try to use the network while running on background,
5019 * because it would be denied.
5020 */
5021 public static final int RESTRICT_BACKGROUND_STATUS_ENABLED = 3;
5022
5023 /**
5024 * A change in the background metered network activity restriction has occurred.
5025 * <p>
5026 * Applications should call {@link #getRestrictBackgroundStatus()} to check if the restriction
5027 * applies to them.
5028 * <p>
5029 * This is only sent to registered receivers, not manifest receivers.
5030 */
5031 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
5032 public static final String ACTION_RESTRICT_BACKGROUND_CHANGED =
5033 "android.net.conn.RESTRICT_BACKGROUND_CHANGED";
5034
5035 /** @hide */
5036 @Retention(RetentionPolicy.SOURCE)
5037 @IntDef(flag = false, value = {
5038 RESTRICT_BACKGROUND_STATUS_DISABLED,
5039 RESTRICT_BACKGROUND_STATUS_WHITELISTED,
5040 RESTRICT_BACKGROUND_STATUS_ENABLED,
5041 })
5042 public @interface RestrictBackgroundStatus {
5043 }
5044
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005045 /**
5046 * Determines if the calling application is subject to metered network restrictions while
5047 * running on background.
5048 *
5049 * @return {@link #RESTRICT_BACKGROUND_STATUS_DISABLED},
5050 * {@link #RESTRICT_BACKGROUND_STATUS_ENABLED},
5051 * or {@link #RESTRICT_BACKGROUND_STATUS_WHITELISTED}
5052 */
5053 public @RestrictBackgroundStatus int getRestrictBackgroundStatus() {
5054 try {
Remi NGUYEN VAN1fdeb502021-03-18 14:23:12 +09005055 return mService.getRestrictBackgroundStatusByCaller();
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005056 } catch (RemoteException e) {
5057 throw e.rethrowFromSystemServer();
5058 }
5059 }
5060
5061 /**
5062 * The network watchlist is a list of domains and IP addresses that are associated with
5063 * potentially harmful apps. This method returns the SHA-256 of the watchlist config file
5064 * currently used by the system for validation purposes.
5065 *
5066 * @return Hash of network watchlist config file. Null if config does not exist.
5067 */
5068 @Nullable
5069 public byte[] getNetworkWatchlistConfigHash() {
5070 try {
5071 return mService.getNetworkWatchlistConfigHash();
5072 } catch (RemoteException e) {
5073 Log.e(TAG, "Unable to get watchlist config hash");
5074 throw e.rethrowFromSystemServer();
5075 }
5076 }
5077
5078 /**
5079 * Returns the {@code uid} of the owner of a network connection.
5080 *
5081 * @param protocol The protocol of the connection. Only {@code IPPROTO_TCP} and {@code
5082 * IPPROTO_UDP} currently supported.
5083 * @param local The local {@link InetSocketAddress} of a connection.
5084 * @param remote The remote {@link InetSocketAddress} of a connection.
5085 * @return {@code uid} if the connection is found and the app has permission to observe it
5086 * (e.g., if it is associated with the calling VPN app's VpnService tunnel) or {@link
5087 * android.os.Process#INVALID_UID} if the connection is not found.
5088 * @throws {@link SecurityException} if the caller is not the active VpnService for the current
5089 * user.
5090 * @throws {@link IllegalArgumentException} if an unsupported protocol is requested.
5091 */
5092 public int getConnectionOwnerUid(
5093 int protocol, @NonNull InetSocketAddress local, @NonNull InetSocketAddress remote) {
5094 ConnectionInfo connectionInfo = new ConnectionInfo(protocol, local, remote);
5095 try {
5096 return mService.getConnectionOwnerUid(connectionInfo);
5097 } catch (RemoteException e) {
5098 throw e.rethrowFromSystemServer();
5099 }
5100 }
5101
5102 private void printStackTrace() {
5103 if (DEBUG) {
5104 final StackTraceElement[] callStack = Thread.currentThread().getStackTrace();
5105 final StringBuffer sb = new StringBuffer();
5106 for (int i = 3; i < callStack.length; i++) {
5107 final String stackTrace = callStack[i].toString();
5108 if (stackTrace == null || stackTrace.contains("android.os")) {
5109 break;
5110 }
5111 sb.append(" [").append(stackTrace).append("]");
5112 }
5113 Log.d(TAG, "StackLog:" + sb.toString());
5114 }
5115 }
5116
Remi NGUYEN VAN91444ca2021-01-15 23:02:47 +09005117 /** @hide */
5118 public TestNetworkManager startOrGetTestNetworkManager() {
5119 final IBinder tnBinder;
5120 try {
5121 tnBinder = mService.startOrGetTestNetworkService();
5122 } catch (RemoteException e) {
5123 throw e.rethrowFromSystemServer();
5124 }
5125
5126 return new TestNetworkManager(ITestNetworkManager.Stub.asInterface(tnBinder));
5127 }
5128
Remi NGUYEN VAN91444ca2021-01-15 23:02:47 +09005129 /** @hide */
5130 public ConnectivityDiagnosticsManager createDiagnosticsManager() {
5131 return new ConnectivityDiagnosticsManager(mContext, mService);
5132 }
5133
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005134 /**
5135 * Simulates a Data Stall for the specified Network.
5136 *
5137 * <p>This method should only be used for tests.
5138 *
5139 * <p>The caller must be the owner of the specified Network.
5140 *
5141 * @param detectionMethod The detection method used to identify the Data Stall.
5142 * @param timestampMillis The timestamp at which the stall 'occurred', in milliseconds.
5143 * @param network The Network for which a Data Stall is being simluated.
5144 * @param extras The PersistableBundle of extras included in the Data Stall notification.
5145 * @throws SecurityException if the caller is not the owner of the given network.
5146 * @hide
5147 */
5148 @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
5149 @RequiresPermission(anyOf = {android.Manifest.permission.MANAGE_TEST_NETWORKS,
5150 android.Manifest.permission.NETWORK_STACK})
5151 public void simulateDataStall(int detectionMethod, long timestampMillis,
5152 @NonNull Network network, @NonNull PersistableBundle extras) {
5153 try {
5154 mService.simulateDataStall(detectionMethod, timestampMillis, network, extras);
5155 } catch (RemoteException e) {
5156 e.rethrowFromSystemServer();
5157 }
5158 }
5159
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005160 @NonNull
5161 private final List<QosCallbackConnection> mQosCallbackConnections = new ArrayList<>();
5162
5163 /**
5164 * Registers a {@link QosSocketInfo} with an associated {@link QosCallback}. The callback will
5165 * receive available QoS events related to the {@link Network} and local ip + port
5166 * specified within socketInfo.
5167 * <p/>
5168 * The same {@link QosCallback} must be unregistered before being registered a second time,
5169 * otherwise {@link QosCallbackRegistrationException} is thrown.
5170 * <p/>
5171 * This API does not, in itself, require any permission if called with a network that is not
5172 * restricted. However, the underlying implementation currently only supports the IMS network,
5173 * which is always restricted. That means non-preinstalled callers can't possibly find this API
5174 * useful, because they'd never be called back on networks that they would have access to.
5175 *
5176 * @throws SecurityException if {@link QosSocketInfo#getNetwork()} is restricted and the app is
5177 * missing CONNECTIVITY_USE_RESTRICTED_NETWORKS permission.
5178 * @throws QosCallback.QosCallbackRegistrationException if qosCallback is already registered.
5179 * @throws RuntimeException if the app already has too many callbacks registered.
5180 *
5181 * Exceptions after the time of registration is passed through
5182 * {@link QosCallback#onError(QosCallbackException)}. see: {@link QosCallbackException}.
5183 *
5184 * @param socketInfo the socket information used to match QoS events
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005185 * @param executor The executor on which the callback will be invoked. The provided
5186 * {@link Executor} must run callback sequentially, otherwise the order of
Daniel Bright686d5d22021-03-10 11:51:50 -08005187 * callbacks cannot be guaranteed.onQosCallbackRegistered
5188 * @param callback receives qos events that satisfy socketInfo
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005189 *
5190 * @hide
5191 */
5192 @SystemApi
5193 public void registerQosCallback(@NonNull final QosSocketInfo socketInfo,
Daniel Bright686d5d22021-03-10 11:51:50 -08005194 @CallbackExecutor @NonNull final Executor executor,
5195 @NonNull final QosCallback callback) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005196 Objects.requireNonNull(socketInfo, "socketInfo must be non-null");
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005197 Objects.requireNonNull(executor, "executor must be non-null");
Daniel Bright686d5d22021-03-10 11:51:50 -08005198 Objects.requireNonNull(callback, "callback must be non-null");
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005199
5200 try {
5201 synchronized (mQosCallbackConnections) {
5202 if (getQosCallbackConnection(callback) == null) {
5203 final QosCallbackConnection connection =
5204 new QosCallbackConnection(this, callback, executor);
5205 mQosCallbackConnections.add(connection);
5206 mService.registerQosSocketCallback(socketInfo, connection);
5207 } else {
5208 Log.e(TAG, "registerQosCallback: Callback already registered");
5209 throw new QosCallbackRegistrationException();
5210 }
5211 }
5212 } catch (final RemoteException e) {
5213 Log.e(TAG, "registerQosCallback: Error while registering ", e);
5214
5215 // The same unregister method method is called for consistency even though nothing
5216 // will be sent to the ConnectivityService since the callback was never successfully
5217 // registered.
5218 unregisterQosCallback(callback);
5219 e.rethrowFromSystemServer();
5220 } catch (final ServiceSpecificException e) {
5221 Log.e(TAG, "registerQosCallback: Error while registering ", e);
5222 unregisterQosCallback(callback);
5223 throw convertServiceException(e);
5224 }
5225 }
5226
5227 /**
5228 * Unregisters the given {@link QosCallback}. The {@link QosCallback} will no longer receive
5229 * events once unregistered and can be registered a second time.
5230 * <p/>
5231 * If the {@link QosCallback} does not have an active registration, it is a no-op.
5232 *
5233 * @param callback the callback being unregistered
5234 *
5235 * @hide
5236 */
5237 @SystemApi
5238 public void unregisterQosCallback(@NonNull final QosCallback callback) {
5239 Objects.requireNonNull(callback, "The callback must be non-null");
5240 try {
5241 synchronized (mQosCallbackConnections) {
5242 final QosCallbackConnection connection = getQosCallbackConnection(callback);
5243 if (connection != null) {
5244 connection.stopReceivingMessages();
5245 mService.unregisterQosCallback(connection);
5246 mQosCallbackConnections.remove(connection);
5247 } else {
5248 Log.d(TAG, "unregisterQosCallback: Callback not registered");
5249 }
5250 }
5251 } catch (final RemoteException e) {
5252 Log.e(TAG, "unregisterQosCallback: Error while unregistering ", e);
5253 e.rethrowFromSystemServer();
5254 }
5255 }
5256
5257 /**
5258 * Gets the connection related to the callback.
5259 *
5260 * @param callback the callback to look up
5261 * @return the related connection
5262 */
5263 @Nullable
5264 private QosCallbackConnection getQosCallbackConnection(final QosCallback callback) {
5265 for (final QosCallbackConnection connection : mQosCallbackConnections) {
5266 // Checking by reference here is intentional
5267 if (connection.getCallback() == callback) {
5268 return connection;
5269 }
5270 }
5271 return null;
5272 }
5273
5274 /**
Roshan Piuse08bc182020-12-22 15:10:42 -08005275 * Request a network to satisfy a set of {@link NetworkCapabilities}, but
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005276 * does not cause any networks to retain the NET_CAPABILITY_FOREGROUND capability. This can
5277 * be used to request that the system provide a network without causing the network to be
5278 * in the foreground.
5279 *
5280 * <p>This method will attempt to find the best network that matches the passed
5281 * {@link NetworkRequest}, and to bring up one that does if none currently satisfies the
5282 * criteria. The platform will evaluate which network is the best at its own discretion.
5283 * Throughput, latency, cost per byte, policy, user preference and other considerations
5284 * may be factored in the decision of what is considered the best network.
5285 *
5286 * <p>As long as this request is outstanding, the platform will try to maintain the best network
5287 * matching this request, while always attempting to match the request to a better network if
5288 * possible. If a better match is found, the platform will switch this request to the now-best
5289 * network and inform the app of the newly best network by invoking
5290 * {@link NetworkCallback#onAvailable(Network)} on the provided callback. Note that the platform
5291 * will not try to maintain any other network than the best one currently matching the request:
5292 * a network not matching any network request may be disconnected at any time.
5293 *
5294 * <p>For example, an application could use this method to obtain a connected cellular network
5295 * even if the device currently has a data connection over Ethernet. This may cause the cellular
5296 * radio to consume additional power. Or, an application could inform the system that it wants
5297 * a network supporting sending MMSes and have the system let it know about the currently best
5298 * MMS-supporting network through the provided {@link NetworkCallback}.
5299 *
5300 * <p>The status of the request can be followed by listening to the various callbacks described
5301 * in {@link NetworkCallback}. The {@link Network} object passed to the callback methods can be
5302 * used to direct traffic to the network (although accessing some networks may be subject to
5303 * holding specific permissions). Callers will learn about the specific characteristics of the
5304 * network through
5305 * {@link NetworkCallback#onCapabilitiesChanged(Network, NetworkCapabilities)} and
5306 * {@link NetworkCallback#onLinkPropertiesChanged(Network, LinkProperties)}. The methods of the
5307 * provided {@link NetworkCallback} will only be invoked due to changes in the best network
5308 * matching the request at any given time; therefore when a better network matching the request
5309 * becomes available, the {@link NetworkCallback#onAvailable(Network)} method is called
5310 * with the new network after which no further updates are given about the previously-best
5311 * network, unless it becomes the best again at some later time. All callbacks are invoked
5312 * in order on the same thread, which by default is a thread created by the framework running
5313 * in the app.
5314 *
5315 * <p>This{@link NetworkRequest} will live until released via
5316 * {@link #unregisterNetworkCallback(NetworkCallback)} or the calling application exits, at
5317 * which point the system may let go of the network at any time.
5318 *
5319 * <p>It is presently unsupported to request a network with mutable
5320 * {@link NetworkCapabilities} such as
5321 * {@link NetworkCapabilities#NET_CAPABILITY_VALIDATED} or
5322 * {@link NetworkCapabilities#NET_CAPABILITY_CAPTIVE_PORTAL}
5323 * as these {@code NetworkCapabilities} represent states that a particular
5324 * network may never attain, and whether a network will attain these states
5325 * is unknown prior to bringing up the network so the framework does not
5326 * know how to go about satisfying a request with these capabilities.
5327 *
5328 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
5329 * number of outstanding requests to 100 per app (identified by their UID), shared with
5330 * all variants of this method, of {@link #registerNetworkCallback} as well as
5331 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
5332 * Requesting a network with this method will count toward this limit. If this limit is
5333 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
5334 * make sure to unregister the callbacks with
5335 * {@link #unregisterNetworkCallback(NetworkCallback)}.
5336 *
5337 * @param request {@link NetworkRequest} describing this request.
5338 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
5339 * If null, the callback is invoked on the default internal Handler.
5340 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
5341 * the callback must not be shared - it uniquely specifies this request.
5342 * @throws IllegalArgumentException if {@code request} contains invalid network capabilities.
5343 * @throws SecurityException if missing the appropriate permissions.
5344 * @throws RuntimeException if the app already has too many callbacks registered.
5345 *
5346 * @hide
5347 */
5348 @SystemApi(client = MODULE_LIBRARIES)
5349 @SuppressLint("ExecutorRegistration")
5350 @RequiresPermission(anyOf = {
5351 android.Manifest.permission.NETWORK_SETTINGS,
5352 android.Manifest.permission.NETWORK_STACK,
5353 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK
5354 })
5355 public void requestBackgroundNetwork(@NonNull NetworkRequest request,
junyulaidbb70462021-03-09 20:49:48 +08005356 @NonNull Handler handler, @NonNull NetworkCallback networkCallback) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005357 final NetworkCapabilities nc = request.networkCapabilities;
5358 sendRequestForNetwork(nc, networkCallback, 0, BACKGROUND_REQUEST,
junyulaidbb70462021-03-09 20:49:48 +08005359 TYPE_NONE, new CallbackHandler(handler));
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005360 }
James Mattis12aeab82021-01-10 14:24:24 -08005361
5362 /**
James Mattis12aeab82021-01-10 14:24:24 -08005363 * Used by automotive devices to set the network preferences used to direct traffic at an
5364 * application level as per the given OemNetworkPreferences. An example use-case would be an
5365 * automotive OEM wanting to provide connectivity for applications critical to the usage of a
5366 * vehicle via a particular network.
5367 *
5368 * Calling this will overwrite the existing preference.
5369 *
5370 * @param preference {@link OemNetworkPreferences} The application network preference to be set.
5371 * @param executor the executor on which listener will be invoked.
5372 * @param listener {@link OnSetOemNetworkPreferenceListener} optional listener used to
5373 * communicate completion of setOemNetworkPreference(). This will only be
5374 * called once upon successful completion of setOemNetworkPreference().
5375 * @throws IllegalArgumentException if {@code preference} contains invalid preference values.
5376 * @throws SecurityException if missing the appropriate permissions.
5377 * @throws UnsupportedOperationException if called on a non-automotive device.
James Mattis6e2d7022021-01-26 16:23:52 -08005378 * @hide
James Mattis12aeab82021-01-10 14:24:24 -08005379 */
James Mattis6e2d7022021-01-26 16:23:52 -08005380 @SystemApi
James Mattisa46c1442021-01-26 14:05:36 -08005381 @RequiresPermission(android.Manifest.permission.CONTROL_OEM_PAID_NETWORK_PREFERENCE)
James Mattis6e2d7022021-01-26 16:23:52 -08005382 public void setOemNetworkPreference(@NonNull final OemNetworkPreferences preference,
James Mattis12aeab82021-01-10 14:24:24 -08005383 @Nullable @CallbackExecutor final Executor executor,
Chalard Jean0a4aefc2021-03-03 16:37:13 +09005384 @Nullable final Runnable listener) {
James Mattis12aeab82021-01-10 14:24:24 -08005385 Objects.requireNonNull(preference, "OemNetworkPreferences must be non-null");
5386 if (null != listener) {
5387 Objects.requireNonNull(executor, "Executor must be non-null");
5388 }
Chalard Jean0a4aefc2021-03-03 16:37:13 +09005389 final IOnCompleteListener listenerInternal = listener == null ? null :
5390 new IOnCompleteListener.Stub() {
James Mattis12aeab82021-01-10 14:24:24 -08005391 @Override
5392 public void onComplete() {
Chalard Jean0a4aefc2021-03-03 16:37:13 +09005393 executor.execute(listener::run);
James Mattis12aeab82021-01-10 14:24:24 -08005394 }
5395 };
5396
5397 try {
5398 mService.setOemNetworkPreference(preference, listenerInternal);
5399 } catch (RemoteException e) {
5400 Log.e(TAG, "setOemNetworkPreference() failed for preference: " + preference.toString());
5401 throw e.rethrowFromSystemServer();
5402 }
5403 }
lucaslin5cdbcfb2021-03-12 00:46:33 +08005404
Chalard Jeanad565e22021-02-25 17:23:40 +09005405 /**
5406 * Request that a user profile is put by default on a network matching a given preference.
5407 *
5408 * See the documentation for the individual preferences for a description of the supported
5409 * behaviors.
5410 *
5411 * @param profile the profile concerned.
5412 * @param preference the preference for this profile.
5413 * @param executor an executor to execute the listener on. Optional if listener is null.
5414 * @param listener an optional listener to listen for completion of the operation.
5415 * @throws IllegalArgumentException if {@code profile} is not a valid user profile.
5416 * @throws SecurityException if missing the appropriate permissions.
5417 * @hide
5418 */
Chalard Jean0a4aefc2021-03-03 16:37:13 +09005419 // This function is for establishing per-profile default networking and can only be called by
5420 // the device policy manager, running as the system server. It would make no sense to call it
5421 // on a context for a user because it does not establish a setting on behalf of a user, rather
5422 // it establishes a setting for a user on behalf of the DPM.
5423 @SuppressLint({"UserHandle"})
5424 @SystemApi(client = MODULE_LIBRARIES)
Chalard Jeanad565e22021-02-25 17:23:40 +09005425 @RequiresPermission(android.Manifest.permission.NETWORK_STACK)
5426 public void setProfileNetworkPreference(@NonNull final UserHandle profile,
5427 @ProfileNetworkPreference final int preference,
5428 @Nullable @CallbackExecutor final Executor executor,
5429 @Nullable final Runnable listener) {
5430 if (null != listener) {
5431 Objects.requireNonNull(executor, "Pass a non-null executor, or a null listener");
5432 }
5433 final IOnCompleteListener proxy;
5434 if (null == listener) {
5435 proxy = null;
5436 } else {
5437 proxy = new IOnCompleteListener.Stub() {
5438 @Override
5439 public void onComplete() {
5440 executor.execute(listener::run);
5441 }
5442 };
5443 }
5444 try {
5445 mService.setProfileNetworkPreference(profile, preference, proxy);
5446 } catch (RemoteException e) {
5447 throw e.rethrowFromSystemServer();
5448 }
5449 }
5450
lucaslin5cdbcfb2021-03-12 00:46:33 +08005451 // The first network ID of IPSec tunnel interface.
lucaslinc296fcc2021-03-15 17:24:12 +08005452 private static final int TUN_INTF_NETID_START = 0xFC00; // 0xFC00 = 64512
lucaslin5cdbcfb2021-03-12 00:46:33 +08005453 // The network ID range of IPSec tunnel interface.
lucaslinc296fcc2021-03-15 17:24:12 +08005454 private static final int TUN_INTF_NETID_RANGE = 0x0400; // 0x0400 = 1024
lucaslin5cdbcfb2021-03-12 00:46:33 +08005455
5456 /**
5457 * Get the network ID range reserved for IPSec tunnel interfaces.
5458 *
5459 * @return A Range which indicates the network ID range of IPSec tunnel interface.
5460 * @hide
5461 */
5462 @SystemApi(client = MODULE_LIBRARIES)
5463 @NonNull
5464 public static Range<Integer> getIpSecNetIdRange() {
5465 return new Range(TUN_INTF_NETID_START, TUN_INTF_NETID_START + TUN_INTF_NETID_RANGE - 1);
5466 }
lucaslin180f44f2021-03-12 16:11:27 +08005467
5468 /**
5469 * Get private DNS mode from settings.
5470 *
lucaslindebfe602021-03-17 14:53:35 +08005471 * @param context The Context to query the private DNS mode from settings.
lucaslin180f44f2021-03-12 16:11:27 +08005472 * @return A string of private DNS mode as one of the PRIVATE_DNS_MODE_* constants.
5473 *
5474 * @hide
5475 */
5476 @SystemApi(client = MODULE_LIBRARIES)
5477 @NonNull
5478 @PrivateDnsMode
lucaslin2a4c17c2021-03-16 17:11:14 +08005479 public static String getPrivateDnsMode(@NonNull Context context) {
5480 final ContentResolver cr = context.getContentResolver();
lucaslin180f44f2021-03-12 16:11:27 +08005481 String mode = Settings.Global.getString(cr, PRIVATE_DNS_MODE);
5482 if (TextUtils.isEmpty(mode)) mode = Settings.Global.getString(cr, PRIVATE_DNS_DEFAULT_MODE);
5483 // If both PRIVATE_DNS_MODE and PRIVATE_DNS_DEFAULT_MODE are not set, choose
5484 // PRIVATE_DNS_MODE_OPPORTUNISTIC as default mode.
5485 if (TextUtils.isEmpty(mode)) mode = PRIVATE_DNS_MODE_OPPORTUNISTIC;
5486 return mode;
5487 }
paulhud5594412021-03-25 12:36:56 +08005488
5489 /**
5490 * Set private DNS mode to settings.
5491 *
5492 * @param context The {@link Context} to set the private DNS mode.
5493 * @param mode The private dns mode. This should be one of the PRIVATE_DNS_MODE_* constants.
5494 *
5495 * @hide
5496 */
5497 @SystemApi(client = MODULE_LIBRARIES)
5498 public static void setPrivateDnsMode(@NonNull Context context,
5499 @NonNull @PrivateDnsMode String mode) {
5500 if (!(mode == PRIVATE_DNS_MODE_OFF
5501 || mode == PRIVATE_DNS_MODE_OPPORTUNISTIC
5502 || mode == PRIVATE_DNS_MODE_PROVIDER_HOSTNAME)) {
5503 throw new IllegalArgumentException("Invalid private dns mode");
5504 }
5505 Settings.Global.putString(context.getContentResolver(), PRIVATE_DNS_MODE, mode);
5506 }
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005507}