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