blob: 0c5eaa7b6bc8851aadaaea32152a8ecbf1231180 [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 VANfbbccbc2021-01-15 18:08:24 +0900939 private final TetheringManager mTetheringManager;
940
941 /**
942 * Tests if a given integer represents a valid network type.
943 * @param networkType the type to be tested
944 * @return a boolean. {@code true} if the type is valid, else {@code false}
945 * @deprecated All APIs accepting a network type are deprecated. There should be no need to
946 * validate a network type.
947 */
948 @Deprecated
949 public static boolean isNetworkTypeValid(int networkType) {
950 return MIN_NETWORK_TYPE <= networkType && networkType <= MAX_NETWORK_TYPE;
951 }
952
953 /**
954 * Returns a non-localized string representing a given network type.
955 * ONLY used for debugging output.
956 * @param type the type needing naming
957 * @return a String for the given type, or a string version of the type ("87")
958 * if no name is known.
959 * @deprecated Types are deprecated. Use {@link NetworkCapabilities} instead.
960 * {@hide}
961 */
962 @Deprecated
963 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
964 public static String getNetworkTypeName(int type) {
965 switch (type) {
966 case TYPE_NONE:
967 return "NONE";
968 case TYPE_MOBILE:
969 return "MOBILE";
970 case TYPE_WIFI:
971 return "WIFI";
972 case TYPE_MOBILE_MMS:
973 return "MOBILE_MMS";
974 case TYPE_MOBILE_SUPL:
975 return "MOBILE_SUPL";
976 case TYPE_MOBILE_DUN:
977 return "MOBILE_DUN";
978 case TYPE_MOBILE_HIPRI:
979 return "MOBILE_HIPRI";
980 case TYPE_WIMAX:
981 return "WIMAX";
982 case TYPE_BLUETOOTH:
983 return "BLUETOOTH";
984 case TYPE_DUMMY:
985 return "DUMMY";
986 case TYPE_ETHERNET:
987 return "ETHERNET";
988 case TYPE_MOBILE_FOTA:
989 return "MOBILE_FOTA";
990 case TYPE_MOBILE_IMS:
991 return "MOBILE_IMS";
992 case TYPE_MOBILE_CBS:
993 return "MOBILE_CBS";
994 case TYPE_WIFI_P2P:
995 return "WIFI_P2P";
996 case TYPE_MOBILE_IA:
997 return "MOBILE_IA";
998 case TYPE_MOBILE_EMERGENCY:
999 return "MOBILE_EMERGENCY";
1000 case TYPE_PROXY:
1001 return "PROXY";
1002 case TYPE_VPN:
1003 return "VPN";
1004 default:
1005 return Integer.toString(type);
1006 }
1007 }
1008
1009 /**
1010 * @hide
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001011 */
lucaslin10774b72021-03-17 14:16:01 +08001012 @SystemApi(client = MODULE_LIBRARIES)
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001013 public void systemReady() {
1014 try {
1015 mService.systemReady();
1016 } catch (RemoteException e) {
1017 throw e.rethrowFromSystemServer();
1018 }
1019 }
1020
1021 /**
1022 * Checks if a given type uses the cellular data connection.
1023 * This should be replaced in the future by a network property.
1024 * @param networkType the type to check
1025 * @return a boolean - {@code true} if uses cellular network, else {@code false}
1026 * @deprecated Types are deprecated. Use {@link NetworkCapabilities} instead.
1027 * {@hide}
1028 */
1029 @Deprecated
1030 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 130143562)
1031 public static boolean isNetworkTypeMobile(int networkType) {
1032 switch (networkType) {
1033 case TYPE_MOBILE:
1034 case TYPE_MOBILE_MMS:
1035 case TYPE_MOBILE_SUPL:
1036 case TYPE_MOBILE_DUN:
1037 case TYPE_MOBILE_HIPRI:
1038 case TYPE_MOBILE_FOTA:
1039 case TYPE_MOBILE_IMS:
1040 case TYPE_MOBILE_CBS:
1041 case TYPE_MOBILE_IA:
1042 case TYPE_MOBILE_EMERGENCY:
1043 return true;
1044 default:
1045 return false;
1046 }
1047 }
1048
1049 /**
1050 * Checks if the given network type is backed by a Wi-Fi radio.
1051 *
1052 * @deprecated Types are deprecated. Use {@link NetworkCapabilities} instead.
1053 * @hide
1054 */
1055 @Deprecated
1056 public static boolean isNetworkTypeWifi(int networkType) {
1057 switch (networkType) {
1058 case TYPE_WIFI:
1059 case TYPE_WIFI_P2P:
1060 return true;
1061 default:
1062 return false;
1063 }
1064 }
1065
1066 /**
Chalard Jeanad565e22021-02-25 17:23:40 +09001067 * Preference for {@link #setNetworkPreferenceForUser(UserHandle, int, Executor, Runnable)}.
1068 * Specify that the traffic for this user should by follow the default rules.
1069 * @hide
1070 */
Chalard Jeanbef6b092021-03-17 14:33:24 +09001071 @SystemApi(client = MODULE_LIBRARIES)
Chalard Jeanad565e22021-02-25 17:23:40 +09001072 public static final int PROFILE_NETWORK_PREFERENCE_DEFAULT = 0;
1073
1074 /**
1075 * Preference for {@link #setNetworkPreferenceForUser(UserHandle, int, Executor, Runnable)}.
1076 * Specify that the traffic for this user should by default go on a network with
1077 * {@link NetworkCapabilities#NET_CAPABILITY_ENTERPRISE}, and on the system default network
1078 * if no such network is available.
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_ENTERPRISE = 1;
1083
1084 /** @hide */
1085 @Retention(RetentionPolicy.SOURCE)
1086 @IntDef(value = {
1087 PROFILE_NETWORK_PREFERENCE_DEFAULT,
1088 PROFILE_NETWORK_PREFERENCE_ENTERPRISE
1089 })
1090 public @interface ProfileNetworkPreference {
1091 }
1092
1093 /**
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001094 * Specifies the preferred network type. When the device has more
1095 * than one type available the preferred network type will be used.
1096 *
1097 * @param preference the network type to prefer over all others. It is
1098 * unspecified what happens to the old preferred network in the
1099 * overall ordering.
1100 * @deprecated Functionality has been removed as it no longer makes sense,
1101 * with many more than two networks - we'd need an array to express
1102 * preference. Instead we use dynamic network properties of
1103 * the networks to describe their precedence.
1104 */
1105 @Deprecated
1106 public void setNetworkPreference(int preference) {
1107 }
1108
1109 /**
1110 * Retrieves the current preferred network type.
1111 *
1112 * @return an integer representing the preferred network type
1113 *
1114 * @deprecated Functionality has been removed as it no longer makes sense,
1115 * with many more than two networks - we'd need an array to express
1116 * preference. Instead we use dynamic network properties of
1117 * the networks to describe their precedence.
1118 */
1119 @Deprecated
1120 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1121 public int getNetworkPreference() {
1122 return TYPE_NONE;
1123 }
1124
1125 /**
1126 * Returns details about the currently active default data network. When
1127 * connected, this network is the default route for outgoing connections.
1128 * You should always check {@link NetworkInfo#isConnected()} before initiating
1129 * network traffic. This may return {@code null} when there is no default
1130 * network.
1131 * Note that if the default network is a VPN, this method will return the
1132 * NetworkInfo for one of its underlying networks instead, or null if the
1133 * VPN agent did not specify any. Apps interested in learning about VPNs
1134 * should use {@link #getNetworkInfo(android.net.Network)} instead.
1135 *
1136 * @return a {@link NetworkInfo} object for the current default network
1137 * or {@code null} if no default network is currently active
1138 * @deprecated See {@link NetworkInfo}.
1139 */
1140 @Deprecated
1141 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1142 @Nullable
1143 public NetworkInfo getActiveNetworkInfo() {
1144 try {
1145 return mService.getActiveNetworkInfo();
1146 } catch (RemoteException e) {
1147 throw e.rethrowFromSystemServer();
1148 }
1149 }
1150
1151 /**
1152 * Returns a {@link Network} object corresponding to the currently active
1153 * default data network. In the event that the current active default data
1154 * network disconnects, the returned {@code Network} object will no longer
1155 * be usable. This will return {@code null} when there is no default
1156 * network.
1157 *
1158 * @return a {@link Network} object for the current default network or
1159 * {@code null} if no default network is currently active
1160 */
1161 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1162 @Nullable
1163 public Network getActiveNetwork() {
1164 try {
1165 return mService.getActiveNetwork();
1166 } catch (RemoteException e) {
1167 throw e.rethrowFromSystemServer();
1168 }
1169 }
1170
1171 /**
1172 * Returns a {@link Network} object corresponding to the currently active
1173 * default data network for a specific UID. In the event that the default data
1174 * network disconnects, the returned {@code Network} object will no longer
1175 * be usable. This will return {@code null} when there is no default
1176 * network for the UID.
1177 *
1178 * @return a {@link Network} object for the current default network for the
1179 * given UID or {@code null} if no default network is currently active
lifrdb7d6762021-03-30 21:04:53 +08001180 *
1181 * @hide
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001182 */
1183 @RequiresPermission(android.Manifest.permission.NETWORK_STACK)
1184 @Nullable
1185 public Network getActiveNetworkForUid(int uid) {
1186 return getActiveNetworkForUid(uid, false);
1187 }
1188
1189 /** {@hide} */
1190 public Network getActiveNetworkForUid(int uid, boolean ignoreBlocked) {
1191 try {
1192 return mService.getActiveNetworkForUid(uid, ignoreBlocked);
1193 } catch (RemoteException e) {
1194 throw e.rethrowFromSystemServer();
1195 }
1196 }
1197
1198 /**
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001199 * Adds or removes a requirement for given UID ranges to use the VPN.
1200 *
1201 * If set to {@code true}, informs the system that the UIDs in the specified ranges must not
1202 * have any connectivity except if a VPN is connected and applies to the UIDs, or if the UIDs
1203 * otherwise have permission to bypass the VPN (e.g., because they have the
1204 * {@link android.Manifest.permission.CONNECTIVITY_USE_RESTRICTED_NETWORKS} permission, or when
1205 * using a socket protected by a method such as {@link VpnService#protect(DatagramSocket)}. If
1206 * set to {@code false}, a previously-added restriction is removed.
1207 * <p>
1208 * Each of the UID ranges specified by this method is added and removed as is, and no processing
1209 * is performed on the ranges to de-duplicate, merge, split, or intersect them. In order to
1210 * remove a previously-added range, the exact range must be removed as is.
1211 * <p>
1212 * The changes are applied asynchronously and may not have been applied by the time the method
1213 * returns. Apps will be notified about any changes that apply to them via
1214 * {@link NetworkCallback#onBlockedStatusChanged} callbacks called after the changes take
1215 * effect.
1216 * <p>
1217 * This method should be called only by the VPN code.
1218 *
1219 * @param ranges the UID ranges to restrict
1220 * @param requireVpn whether the specified UID ranges must use a VPN
1221 *
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001222 * @hide
1223 */
1224 @RequiresPermission(anyOf = {
1225 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
lucaslin97fb10a2021-03-22 11:51:27 +08001226 android.Manifest.permission.NETWORK_STACK,
1227 android.Manifest.permission.NETWORK_SETTINGS})
1228 @SystemApi(client = MODULE_LIBRARIES)
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001229 public void setRequireVpnForUids(boolean requireVpn,
1230 @NonNull Collection<Range<Integer>> ranges) {
1231 Objects.requireNonNull(ranges);
1232 // The Range class is not parcelable. Convert to UidRange, which is what is used internally.
1233 // This method is not necessarily expected to be used outside the system server, so
1234 // parceling may not be necessary, but it could be used out-of-process, e.g., by the network
1235 // stack process, or by tests.
1236 UidRange[] rangesArray = new UidRange[ranges.size()];
1237 int index = 0;
1238 for (Range<Integer> range : ranges) {
1239 rangesArray[index++] = new UidRange(range.getLower(), range.getUpper());
1240 }
1241 try {
1242 mService.setRequireVpnForUids(requireVpn, rangesArray);
1243 } catch (RemoteException e) {
1244 throw e.rethrowFromSystemServer();
1245 }
1246 }
1247
1248 /**
Lorenzo Colittic71cff82021-01-15 01:29:01 +09001249 * Informs ConnectivityService of whether the legacy lockdown VPN, as implemented by
1250 * LockdownVpnTracker, is in use. This is deprecated for new devices starting from Android 12
1251 * but is still supported for backwards compatibility.
1252 * <p>
1253 * This type of VPN is assumed always to use the system default network, and must always declare
1254 * exactly one underlying network, which is the network that was the default when the VPN
1255 * connected.
1256 * <p>
1257 * Calling this method with {@code true} enables legacy behaviour, specifically:
1258 * <ul>
1259 * <li>Any VPN that applies to userId 0 behaves specially with respect to deprecated
1260 * {@link #CONNECTIVITY_ACTION} broadcasts. Any such broadcasts will have the state in the
1261 * {@link #EXTRA_NETWORK_INFO} replaced by state of the VPN network. Also, any time the VPN
1262 * connects, a {@link #CONNECTIVITY_ACTION} broadcast will be sent for the network
1263 * underlying the VPN.</li>
1264 * <li>Deprecated APIs that return {@link NetworkInfo} objects will have their state
1265 * similarly replaced by the VPN network state.</li>
1266 * <li>Information on current network interfaces passed to NetworkStatsService will not
1267 * include any VPN interfaces.</li>
1268 * </ul>
1269 *
1270 * @param enabled whether legacy lockdown VPN is enabled or disabled
1271 *
Lorenzo Colittic71cff82021-01-15 01:29:01 +09001272 * @hide
1273 */
1274 @RequiresPermission(anyOf = {
1275 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
lucaslin97fb10a2021-03-22 11:51:27 +08001276 android.Manifest.permission.NETWORK_STACK,
Lorenzo Colittic71cff82021-01-15 01:29:01 +09001277 android.Manifest.permission.NETWORK_SETTINGS})
lucaslin97fb10a2021-03-22 11:51:27 +08001278 @SystemApi(client = MODULE_LIBRARIES)
Lorenzo Colittic71cff82021-01-15 01:29:01 +09001279 public void setLegacyLockdownVpnEnabled(boolean enabled) {
1280 try {
1281 mService.setLegacyLockdownVpnEnabled(enabled);
1282 } catch (RemoteException e) {
1283 throw e.rethrowFromSystemServer();
1284 }
1285 }
1286
1287 /**
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001288 * Returns details about the currently active default data network
1289 * for a given uid. This is for internal use only to avoid spying
1290 * other apps.
1291 *
1292 * @return a {@link NetworkInfo} object for the current default network
1293 * for the given uid or {@code null} if no default network is
1294 * available for the specified uid.
1295 *
1296 * {@hide}
1297 */
1298 @RequiresPermission(android.Manifest.permission.NETWORK_STACK)
1299 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
1300 public NetworkInfo getActiveNetworkInfoForUid(int uid) {
1301 return getActiveNetworkInfoForUid(uid, false);
1302 }
1303
1304 /** {@hide} */
1305 public NetworkInfo getActiveNetworkInfoForUid(int uid, boolean ignoreBlocked) {
1306 try {
1307 return mService.getActiveNetworkInfoForUid(uid, ignoreBlocked);
1308 } catch (RemoteException e) {
1309 throw e.rethrowFromSystemServer();
1310 }
1311 }
1312
1313 /**
1314 * Returns connection status information about a particular
1315 * network type.
1316 *
1317 * @param networkType integer specifying which networkType in
1318 * which you're interested.
1319 * @return a {@link NetworkInfo} object for the requested
1320 * network type or {@code null} if the type is not
1321 * supported by the device. If {@code networkType} is
1322 * TYPE_VPN and a VPN is active for the calling app,
1323 * then this method will try to return one of the
1324 * underlying networks for the VPN or null if the
1325 * VPN agent didn't specify any.
1326 *
1327 * @deprecated This method does not support multiple connected networks
1328 * of the same type. Use {@link #getAllNetworks} and
1329 * {@link #getNetworkInfo(android.net.Network)} instead.
1330 */
1331 @Deprecated
1332 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1333 @Nullable
1334 public NetworkInfo getNetworkInfo(int networkType) {
1335 try {
1336 return mService.getNetworkInfo(networkType);
1337 } catch (RemoteException e) {
1338 throw e.rethrowFromSystemServer();
1339 }
1340 }
1341
1342 /**
1343 * Returns connection status information about a particular
1344 * Network.
1345 *
1346 * @param network {@link Network} specifying which network
1347 * in which you're interested.
1348 * @return a {@link NetworkInfo} object for the requested
1349 * network or {@code null} if the {@code Network}
1350 * is not valid.
1351 * @deprecated See {@link NetworkInfo}.
1352 */
1353 @Deprecated
1354 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1355 @Nullable
1356 public NetworkInfo getNetworkInfo(@Nullable Network network) {
1357 return getNetworkInfoForUid(network, Process.myUid(), false);
1358 }
1359
1360 /** {@hide} */
1361 public NetworkInfo getNetworkInfoForUid(Network network, int uid, boolean ignoreBlocked) {
1362 try {
1363 return mService.getNetworkInfoForUid(network, uid, ignoreBlocked);
1364 } catch (RemoteException e) {
1365 throw e.rethrowFromSystemServer();
1366 }
1367 }
1368
1369 /**
1370 * Returns connection status information about all network
1371 * types supported by the device.
1372 *
1373 * @return an array of {@link NetworkInfo} objects. Check each
1374 * {@link NetworkInfo#getType} for which type each applies.
1375 *
1376 * @deprecated This method does not support multiple connected networks
1377 * of the same type. Use {@link #getAllNetworks} and
1378 * {@link #getNetworkInfo(android.net.Network)} instead.
1379 */
1380 @Deprecated
1381 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1382 @NonNull
1383 public NetworkInfo[] getAllNetworkInfo() {
1384 try {
1385 return mService.getAllNetworkInfo();
1386 } catch (RemoteException e) {
1387 throw e.rethrowFromSystemServer();
1388 }
1389 }
1390
1391 /**
junyulaib1211372021-03-03 12:09:05 +08001392 * Return a list of {@link NetworkStateSnapshot}s, one for each network that is currently
1393 * connected.
1394 * @hide
1395 */
1396 @SystemApi(client = MODULE_LIBRARIES)
1397 @RequiresPermission(anyOf = {
1398 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
1399 android.Manifest.permission.NETWORK_STACK,
1400 android.Manifest.permission.NETWORK_SETTINGS})
1401 @NonNull
Aaron Huangab615e52021-04-17 13:46:25 +08001402 public List<NetworkStateSnapshot> getAllNetworkStateSnapshots() {
junyulaib1211372021-03-03 12:09:05 +08001403 try {
Aaron Huangab615e52021-04-17 13:46:25 +08001404 return mService.getAllNetworkStateSnapshots();
junyulaib1211372021-03-03 12:09:05 +08001405 } catch (RemoteException e) {
1406 throw e.rethrowFromSystemServer();
1407 }
1408 }
1409
1410 /**
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001411 * Returns the {@link Network} object currently serving a given type, or
1412 * null if the given type is not connected.
1413 *
1414 * @hide
1415 * @deprecated This method does not support multiple connected networks
1416 * of the same type. Use {@link #getAllNetworks} and
1417 * {@link #getNetworkInfo(android.net.Network)} instead.
1418 */
1419 @Deprecated
1420 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1421 @UnsupportedAppUsage
1422 public Network getNetworkForType(int networkType) {
1423 try {
1424 return mService.getNetworkForType(networkType);
1425 } catch (RemoteException e) {
1426 throw e.rethrowFromSystemServer();
1427 }
1428 }
1429
1430 /**
1431 * Returns an array of all {@link Network} currently tracked by the
1432 * framework.
1433 *
1434 * @return an array of {@link Network} objects.
1435 */
1436 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1437 @NonNull
1438 public Network[] getAllNetworks() {
1439 try {
1440 return mService.getAllNetworks();
1441 } catch (RemoteException e) {
1442 throw e.rethrowFromSystemServer();
1443 }
1444 }
1445
1446 /**
Roshan Piuse08bc182020-12-22 15:10:42 -08001447 * Returns an array of {@link NetworkCapabilities} objects, representing
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001448 * the Networks that applications run by the given user will use by default.
1449 * @hide
1450 */
1451 @UnsupportedAppUsage
1452 public NetworkCapabilities[] getDefaultNetworkCapabilitiesForUser(int userId) {
1453 try {
1454 return mService.getDefaultNetworkCapabilitiesForUser(
Roshan Piusa8a477b2020-12-17 14:53:09 -08001455 userId, mContext.getOpPackageName(), getAttributionTag());
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001456 } catch (RemoteException e) {
1457 throw e.rethrowFromSystemServer();
1458 }
1459 }
1460
1461 /**
1462 * Returns the IP information for the current default network.
1463 *
1464 * @return a {@link LinkProperties} object describing the IP info
1465 * for the current default network, or {@code null} if there
1466 * is no current default network.
1467 *
1468 * {@hide}
1469 * @deprecated please use {@link #getLinkProperties(Network)} on the return
1470 * value of {@link #getActiveNetwork()} instead. In particular,
1471 * this method will return non-null LinkProperties even if the
1472 * app is blocked by policy from using this network.
1473 */
1474 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1475 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 109783091)
1476 public LinkProperties getActiveLinkProperties() {
1477 try {
1478 return mService.getActiveLinkProperties();
1479 } catch (RemoteException e) {
1480 throw e.rethrowFromSystemServer();
1481 }
1482 }
1483
1484 /**
1485 * Returns the IP information for a given network type.
1486 *
1487 * @param networkType the network type of interest.
1488 * @return a {@link LinkProperties} object describing the IP info
1489 * for the given networkType, or {@code null} if there is
1490 * no current default network.
1491 *
1492 * {@hide}
1493 * @deprecated This method does not support multiple connected networks
1494 * of the same type. Use {@link #getAllNetworks},
1495 * {@link #getNetworkInfo(android.net.Network)}, and
1496 * {@link #getLinkProperties(android.net.Network)} instead.
1497 */
1498 @Deprecated
1499 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1500 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 130143562)
1501 public LinkProperties getLinkProperties(int networkType) {
1502 try {
1503 return mService.getLinkPropertiesForType(networkType);
1504 } catch (RemoteException e) {
1505 throw e.rethrowFromSystemServer();
1506 }
1507 }
1508
1509 /**
1510 * Get the {@link LinkProperties} for the given {@link Network}. This
1511 * will return {@code null} if the network is unknown.
1512 *
1513 * @param network The {@link Network} object identifying the network in question.
1514 * @return The {@link LinkProperties} for the network, or {@code null}.
1515 */
1516 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1517 @Nullable
1518 public LinkProperties getLinkProperties(@Nullable Network network) {
1519 try {
1520 return mService.getLinkProperties(network);
1521 } catch (RemoteException e) {
1522 throw e.rethrowFromSystemServer();
1523 }
1524 }
1525
1526 /**
Roshan Piuse08bc182020-12-22 15:10:42 -08001527 * Get the {@link NetworkCapabilities} for the given {@link Network}. This
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001528 * will return {@code null} if the network is unknown.
1529 *
Roshan Piuse08bc182020-12-22 15:10:42 -08001530 * This will remove any location sensitive data in {@link TransportInfo} embedded in
1531 * {@link NetworkCapabilities#getTransportInfo()}. Some transport info instances like
1532 * {@link android.net.wifi.WifiInfo} contain location sensitive information. Retrieving
1533 * this location sensitive information (subject to app's location permissions) will be
1534 * noted by system. To include any location sensitive data in {@link TransportInfo},
1535 * use a {@link NetworkCallback} with
1536 * {@link NetworkCallback#FLAG_INCLUDE_LOCATION_INFO} flag.
1537 *
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001538 * @param network The {@link Network} object identifying the network in question.
Roshan Piuse08bc182020-12-22 15:10:42 -08001539 * @return The {@link NetworkCapabilities} for the network, or {@code null}.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001540 */
1541 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
1542 @Nullable
1543 public NetworkCapabilities getNetworkCapabilities(@Nullable Network network) {
1544 try {
Roshan Piusa8a477b2020-12-17 14:53:09 -08001545 return mService.getNetworkCapabilities(
1546 network, mContext.getOpPackageName(), getAttributionTag());
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001547 } catch (RemoteException e) {
1548 throw e.rethrowFromSystemServer();
1549 }
1550 }
1551
1552 /**
1553 * Gets a URL that can be used for resolving whether a captive portal is present.
1554 * 1. This URL should respond with a 204 response to a GET request to indicate no captive
1555 * portal is present.
1556 * 2. This URL must be HTTP as redirect responses are used to find captive portal
1557 * sign-in pages. Captive portals cannot respond to HTTPS requests with redirects.
1558 *
1559 * The system network validation may be using different strategies to detect captive portals,
1560 * so this method does not necessarily return a URL used by the system. It only returns a URL
1561 * that may be relevant for other components trying to detect captive portals.
1562 *
1563 * @hide
1564 * @deprecated This API returns URL which is not guaranteed to be one of the URLs used by the
1565 * system.
1566 */
1567 @Deprecated
1568 @SystemApi
1569 @RequiresPermission(android.Manifest.permission.NETWORK_SETTINGS)
1570 public String getCaptivePortalServerUrl() {
1571 try {
1572 return mService.getCaptivePortalServerUrl();
1573 } catch (RemoteException e) {
1574 throw e.rethrowFromSystemServer();
1575 }
1576 }
1577
1578 /**
1579 * Tells the underlying networking system that the caller wants to
1580 * begin using the named feature. The interpretation of {@code feature}
1581 * is completely up to each networking implementation.
1582 *
1583 * <p>This method requires the caller to hold either the
1584 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
1585 * or the ability to modify system settings as determined by
1586 * {@link android.provider.Settings.System#canWrite}.</p>
1587 *
1588 * @param networkType specifies which network the request pertains to
1589 * @param feature the name of the feature to be used
1590 * @return an integer value representing the outcome of the request.
1591 * The interpretation of this value is specific to each networking
1592 * implementation+feature combination, except that the value {@code -1}
1593 * always indicates failure.
1594 *
1595 * @deprecated Deprecated in favor of the cleaner
1596 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} API.
1597 * In {@link VERSION_CODES#M}, and above, this method is unsupported and will
1598 * throw {@code UnsupportedOperationException} if called.
1599 * @removed
1600 */
1601 @Deprecated
1602 public int startUsingNetworkFeature(int networkType, String feature) {
1603 checkLegacyRoutingApiAccess();
1604 NetworkCapabilities netCap = networkCapabilitiesForFeature(networkType, feature);
1605 if (netCap == null) {
1606 Log.d(TAG, "Can't satisfy startUsingNetworkFeature for " + networkType + ", " +
1607 feature);
1608 return DEPRECATED_PHONE_CONSTANT_APN_REQUEST_FAILED;
1609 }
1610
1611 NetworkRequest request = null;
1612 synchronized (sLegacyRequests) {
1613 LegacyRequest l = sLegacyRequests.get(netCap);
1614 if (l != null) {
1615 Log.d(TAG, "renewing startUsingNetworkFeature request " + l.networkRequest);
1616 renewRequestLocked(l);
1617 if (l.currentNetwork != null) {
1618 return DEPRECATED_PHONE_CONSTANT_APN_ALREADY_ACTIVE;
1619 } else {
1620 return DEPRECATED_PHONE_CONSTANT_APN_REQUEST_STARTED;
1621 }
1622 }
1623
1624 request = requestNetworkForFeatureLocked(netCap);
1625 }
1626 if (request != null) {
1627 Log.d(TAG, "starting startUsingNetworkFeature for request " + request);
1628 return DEPRECATED_PHONE_CONSTANT_APN_REQUEST_STARTED;
1629 } else {
1630 Log.d(TAG, " request Failed");
1631 return DEPRECATED_PHONE_CONSTANT_APN_REQUEST_FAILED;
1632 }
1633 }
1634
1635 /**
1636 * Tells the underlying networking system that the caller is finished
1637 * using the named feature. The interpretation of {@code feature}
1638 * is completely up to each networking implementation.
1639 *
1640 * <p>This method requires the caller to hold either the
1641 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
1642 * or the ability to modify system settings as determined by
1643 * {@link android.provider.Settings.System#canWrite}.</p>
1644 *
1645 * @param networkType specifies which network the request pertains to
1646 * @param feature the name of the feature that is no longer needed
1647 * @return an integer value representing the outcome of the request.
1648 * The interpretation of this value is specific to each networking
1649 * implementation+feature combination, except that the value {@code -1}
1650 * always indicates failure.
1651 *
1652 * @deprecated Deprecated in favor of the cleaner
1653 * {@link #unregisterNetworkCallback(NetworkCallback)} API.
1654 * In {@link VERSION_CODES#M}, and above, this method is unsupported and will
1655 * throw {@code UnsupportedOperationException} if called.
1656 * @removed
1657 */
1658 @Deprecated
1659 public int stopUsingNetworkFeature(int networkType, String feature) {
1660 checkLegacyRoutingApiAccess();
1661 NetworkCapabilities netCap = networkCapabilitiesForFeature(networkType, feature);
1662 if (netCap == null) {
1663 Log.d(TAG, "Can't satisfy stopUsingNetworkFeature for " + networkType + ", " +
1664 feature);
1665 return -1;
1666 }
1667
1668 if (removeRequestForFeature(netCap)) {
1669 Log.d(TAG, "stopUsingNetworkFeature for " + networkType + ", " + feature);
1670 }
1671 return 1;
1672 }
1673
1674 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
1675 private NetworkCapabilities networkCapabilitiesForFeature(int networkType, String feature) {
1676 if (networkType == TYPE_MOBILE) {
1677 switch (feature) {
1678 case "enableCBS":
1679 return networkCapabilitiesForType(TYPE_MOBILE_CBS);
1680 case "enableDUN":
1681 case "enableDUNAlways":
1682 return networkCapabilitiesForType(TYPE_MOBILE_DUN);
1683 case "enableFOTA":
1684 return networkCapabilitiesForType(TYPE_MOBILE_FOTA);
1685 case "enableHIPRI":
1686 return networkCapabilitiesForType(TYPE_MOBILE_HIPRI);
1687 case "enableIMS":
1688 return networkCapabilitiesForType(TYPE_MOBILE_IMS);
1689 case "enableMMS":
1690 return networkCapabilitiesForType(TYPE_MOBILE_MMS);
1691 case "enableSUPL":
1692 return networkCapabilitiesForType(TYPE_MOBILE_SUPL);
1693 default:
1694 return null;
1695 }
1696 } else if (networkType == TYPE_WIFI && "p2p".equals(feature)) {
1697 return networkCapabilitiesForType(TYPE_WIFI_P2P);
1698 }
1699 return null;
1700 }
1701
1702 private int legacyTypeForNetworkCapabilities(NetworkCapabilities netCap) {
1703 if (netCap == null) return TYPE_NONE;
1704 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_CBS)) {
1705 return TYPE_MOBILE_CBS;
1706 }
1707 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_IMS)) {
1708 return TYPE_MOBILE_IMS;
1709 }
1710 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_FOTA)) {
1711 return TYPE_MOBILE_FOTA;
1712 }
1713 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_DUN)) {
1714 return TYPE_MOBILE_DUN;
1715 }
1716 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_SUPL)) {
1717 return TYPE_MOBILE_SUPL;
1718 }
1719 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_MMS)) {
1720 return TYPE_MOBILE_MMS;
1721 }
1722 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_INTERNET)) {
1723 return TYPE_MOBILE_HIPRI;
1724 }
1725 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_WIFI_P2P)) {
1726 return TYPE_WIFI_P2P;
1727 }
1728 return TYPE_NONE;
1729 }
1730
1731 private static class LegacyRequest {
1732 NetworkCapabilities networkCapabilities;
1733 NetworkRequest networkRequest;
1734 int expireSequenceNumber;
1735 Network currentNetwork;
1736 int delay = -1;
1737
1738 private void clearDnsBinding() {
1739 if (currentNetwork != null) {
1740 currentNetwork = null;
1741 setProcessDefaultNetworkForHostResolution(null);
1742 }
1743 }
1744
1745 NetworkCallback networkCallback = new NetworkCallback() {
1746 @Override
1747 public void onAvailable(Network network) {
1748 currentNetwork = network;
1749 Log.d(TAG, "startUsingNetworkFeature got Network:" + network);
1750 setProcessDefaultNetworkForHostResolution(network);
1751 }
1752 @Override
1753 public void onLost(Network network) {
1754 if (network.equals(currentNetwork)) clearDnsBinding();
1755 Log.d(TAG, "startUsingNetworkFeature lost Network:" + network);
1756 }
1757 };
1758 }
1759
1760 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
1761 private static final HashMap<NetworkCapabilities, LegacyRequest> sLegacyRequests =
1762 new HashMap<>();
1763
1764 private NetworkRequest findRequestForFeature(NetworkCapabilities netCap) {
1765 synchronized (sLegacyRequests) {
1766 LegacyRequest l = sLegacyRequests.get(netCap);
1767 if (l != null) return l.networkRequest;
1768 }
1769 return null;
1770 }
1771
1772 private void renewRequestLocked(LegacyRequest l) {
1773 l.expireSequenceNumber++;
1774 Log.d(TAG, "renewing request to seqNum " + l.expireSequenceNumber);
1775 sendExpireMsgForFeature(l.networkCapabilities, l.expireSequenceNumber, l.delay);
1776 }
1777
1778 private void expireRequest(NetworkCapabilities netCap, int sequenceNum) {
1779 int ourSeqNum = -1;
1780 synchronized (sLegacyRequests) {
1781 LegacyRequest l = sLegacyRequests.get(netCap);
1782 if (l == null) return;
1783 ourSeqNum = l.expireSequenceNumber;
1784 if (l.expireSequenceNumber == sequenceNum) removeRequestForFeature(netCap);
1785 }
1786 Log.d(TAG, "expireRequest with " + ourSeqNum + ", " + sequenceNum);
1787 }
1788
1789 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
1790 private NetworkRequest requestNetworkForFeatureLocked(NetworkCapabilities netCap) {
1791 int delay = -1;
1792 int type = legacyTypeForNetworkCapabilities(netCap);
1793 try {
1794 delay = mService.getRestoreDefaultNetworkDelay(type);
1795 } catch (RemoteException e) {
1796 throw e.rethrowFromSystemServer();
1797 }
1798 LegacyRequest l = new LegacyRequest();
1799 l.networkCapabilities = netCap;
1800 l.delay = delay;
1801 l.expireSequenceNumber = 0;
1802 l.networkRequest = sendRequestForNetwork(
1803 netCap, l.networkCallback, 0, REQUEST, type, getDefaultHandler());
1804 if (l.networkRequest == null) return null;
1805 sLegacyRequests.put(netCap, l);
1806 sendExpireMsgForFeature(netCap, l.expireSequenceNumber, delay);
1807 return l.networkRequest;
1808 }
1809
1810 private void sendExpireMsgForFeature(NetworkCapabilities netCap, int seqNum, int delay) {
1811 if (delay >= 0) {
1812 Log.d(TAG, "sending expire msg with seqNum " + seqNum + " and delay " + delay);
1813 CallbackHandler handler = getDefaultHandler();
1814 Message msg = handler.obtainMessage(EXPIRE_LEGACY_REQUEST, seqNum, 0, netCap);
1815 handler.sendMessageDelayed(msg, delay);
1816 }
1817 }
1818
1819 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
1820 private boolean removeRequestForFeature(NetworkCapabilities netCap) {
1821 final LegacyRequest l;
1822 synchronized (sLegacyRequests) {
1823 l = sLegacyRequests.remove(netCap);
1824 }
1825 if (l == null) return false;
1826 unregisterNetworkCallback(l.networkCallback);
1827 l.clearDnsBinding();
1828 return true;
1829 }
1830
1831 private static final SparseIntArray sLegacyTypeToTransport = new SparseIntArray();
1832 static {
1833 sLegacyTypeToTransport.put(TYPE_MOBILE, NetworkCapabilities.TRANSPORT_CELLULAR);
1834 sLegacyTypeToTransport.put(TYPE_MOBILE_CBS, NetworkCapabilities.TRANSPORT_CELLULAR);
1835 sLegacyTypeToTransport.put(TYPE_MOBILE_DUN, NetworkCapabilities.TRANSPORT_CELLULAR);
1836 sLegacyTypeToTransport.put(TYPE_MOBILE_FOTA, NetworkCapabilities.TRANSPORT_CELLULAR);
1837 sLegacyTypeToTransport.put(TYPE_MOBILE_HIPRI, NetworkCapabilities.TRANSPORT_CELLULAR);
1838 sLegacyTypeToTransport.put(TYPE_MOBILE_IMS, NetworkCapabilities.TRANSPORT_CELLULAR);
1839 sLegacyTypeToTransport.put(TYPE_MOBILE_MMS, NetworkCapabilities.TRANSPORT_CELLULAR);
1840 sLegacyTypeToTransport.put(TYPE_MOBILE_SUPL, NetworkCapabilities.TRANSPORT_CELLULAR);
1841 sLegacyTypeToTransport.put(TYPE_WIFI, NetworkCapabilities.TRANSPORT_WIFI);
1842 sLegacyTypeToTransport.put(TYPE_WIFI_P2P, NetworkCapabilities.TRANSPORT_WIFI);
1843 sLegacyTypeToTransport.put(TYPE_BLUETOOTH, NetworkCapabilities.TRANSPORT_BLUETOOTH);
1844 sLegacyTypeToTransport.put(TYPE_ETHERNET, NetworkCapabilities.TRANSPORT_ETHERNET);
1845 }
1846
1847 private static final SparseIntArray sLegacyTypeToCapability = new SparseIntArray();
1848 static {
1849 sLegacyTypeToCapability.put(TYPE_MOBILE_CBS, NetworkCapabilities.NET_CAPABILITY_CBS);
1850 sLegacyTypeToCapability.put(TYPE_MOBILE_DUN, NetworkCapabilities.NET_CAPABILITY_DUN);
1851 sLegacyTypeToCapability.put(TYPE_MOBILE_FOTA, NetworkCapabilities.NET_CAPABILITY_FOTA);
1852 sLegacyTypeToCapability.put(TYPE_MOBILE_IMS, NetworkCapabilities.NET_CAPABILITY_IMS);
1853 sLegacyTypeToCapability.put(TYPE_MOBILE_MMS, NetworkCapabilities.NET_CAPABILITY_MMS);
1854 sLegacyTypeToCapability.put(TYPE_MOBILE_SUPL, NetworkCapabilities.NET_CAPABILITY_SUPL);
1855 sLegacyTypeToCapability.put(TYPE_WIFI_P2P, NetworkCapabilities.NET_CAPABILITY_WIFI_P2P);
1856 }
1857
1858 /**
1859 * Given a legacy type (TYPE_WIFI, ...) returns a NetworkCapabilities
1860 * instance suitable for registering a request or callback. Throws an
1861 * IllegalArgumentException if no mapping from the legacy type to
1862 * NetworkCapabilities is known.
1863 *
1864 * @deprecated Types are deprecated. Use {@link NetworkCallback} or {@link NetworkRequest}
1865 * to find the network instead.
1866 * @hide
1867 */
1868 public static NetworkCapabilities networkCapabilitiesForType(int type) {
1869 final NetworkCapabilities nc = new NetworkCapabilities();
1870
1871 // Map from type to transports.
1872 final int NOT_FOUND = -1;
1873 final int transport = sLegacyTypeToTransport.get(type, NOT_FOUND);
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00001874 if (transport == NOT_FOUND) {
1875 throw new IllegalArgumentException("unknown legacy type: " + type);
1876 }
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001877 nc.addTransportType(transport);
1878
1879 // Map from type to capabilities.
1880 nc.addCapability(sLegacyTypeToCapability.get(
1881 type, NetworkCapabilities.NET_CAPABILITY_INTERNET));
1882 nc.maybeMarkCapabilitiesRestricted();
1883 return nc;
1884 }
1885
1886 /** @hide */
1887 public static class PacketKeepaliveCallback {
1888 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
1889 public PacketKeepaliveCallback() {
1890 }
1891 /** The requested keepalive was successfully started. */
1892 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
1893 public void onStarted() {}
1894 /** The keepalive was successfully stopped. */
1895 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
1896 public void onStopped() {}
1897 /** An error occurred. */
1898 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
1899 public void onError(int error) {}
1900 }
1901
1902 /**
1903 * Allows applications to request that the system periodically send specific packets on their
1904 * behalf, using hardware offload to save battery power.
1905 *
1906 * To request that the system send keepalives, call one of the methods that return a
1907 * {@link ConnectivityManager.PacketKeepalive} object, such as {@link #startNattKeepalive},
1908 * passing in a non-null callback. If the callback is successfully started, the callback's
1909 * {@code onStarted} method will be called. If an error occurs, {@code onError} will be called,
1910 * specifying one of the {@code ERROR_*} constants in this class.
1911 *
1912 * To stop an existing keepalive, call {@link PacketKeepalive#stop}. The system will call
1913 * {@link PacketKeepaliveCallback#onStopped} if the operation was successful or
1914 * {@link PacketKeepaliveCallback#onError} if an error occurred.
1915 *
1916 * @deprecated Use {@link SocketKeepalive} instead.
1917 *
1918 * @hide
1919 */
1920 public class PacketKeepalive {
1921
1922 private static final String TAG = "PacketKeepalive";
1923
1924 /** @hide */
1925 public static final int SUCCESS = 0;
1926
1927 /** @hide */
1928 public static final int NO_KEEPALIVE = -1;
1929
1930 /** @hide */
1931 public static final int BINDER_DIED = -10;
1932
1933 /** The specified {@code Network} is not connected. */
1934 public static final int ERROR_INVALID_NETWORK = -20;
1935 /** The specified IP addresses are invalid. For example, the specified source IP address is
1936 * not configured on the specified {@code Network}. */
1937 public static final int ERROR_INVALID_IP_ADDRESS = -21;
1938 /** The requested port is invalid. */
1939 public static final int ERROR_INVALID_PORT = -22;
1940 /** The packet length is invalid (e.g., too long). */
1941 public static final int ERROR_INVALID_LENGTH = -23;
1942 /** The packet transmission interval is invalid (e.g., too short). */
1943 public static final int ERROR_INVALID_INTERVAL = -24;
1944
1945 /** The hardware does not support this request. */
1946 public static final int ERROR_HARDWARE_UNSUPPORTED = -30;
1947 /** The hardware returned an error. */
1948 public static final int ERROR_HARDWARE_ERROR = -31;
1949
1950 /** The NAT-T destination port for IPsec */
1951 public static final int NATT_PORT = 4500;
1952
1953 /** The minimum interval in seconds between keepalive packet transmissions */
1954 public static final int MIN_INTERVAL = 10;
1955
1956 private final Network mNetwork;
1957 private final ISocketKeepaliveCallback mCallback;
1958 private final ExecutorService mExecutor;
1959
1960 private volatile Integer mSlot;
1961
1962 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
1963 public void stop() {
1964 try {
1965 mExecutor.execute(() -> {
1966 try {
1967 if (mSlot != null) {
1968 mService.stopKeepalive(mNetwork, mSlot);
1969 }
1970 } catch (RemoteException e) {
1971 Log.e(TAG, "Error stopping packet keepalive: ", e);
1972 throw e.rethrowFromSystemServer();
1973 }
1974 });
1975 } catch (RejectedExecutionException e) {
1976 // The internal executor has already stopped due to previous event.
1977 }
1978 }
1979
1980 private PacketKeepalive(Network network, PacketKeepaliveCallback callback) {
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00001981 Objects.requireNonNull(network, "network cannot be null");
1982 Objects.requireNonNull(callback, "callback cannot be null");
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09001983 mNetwork = network;
1984 mExecutor = Executors.newSingleThreadExecutor();
1985 mCallback = new ISocketKeepaliveCallback.Stub() {
1986 @Override
1987 public void onStarted(int slot) {
1988 final long token = Binder.clearCallingIdentity();
1989 try {
1990 mExecutor.execute(() -> {
1991 mSlot = slot;
1992 callback.onStarted();
1993 });
1994 } finally {
1995 Binder.restoreCallingIdentity(token);
1996 }
1997 }
1998
1999 @Override
2000 public void onStopped() {
2001 final long token = Binder.clearCallingIdentity();
2002 try {
2003 mExecutor.execute(() -> {
2004 mSlot = null;
2005 callback.onStopped();
2006 });
2007 } finally {
2008 Binder.restoreCallingIdentity(token);
2009 }
2010 mExecutor.shutdown();
2011 }
2012
2013 @Override
2014 public void onError(int error) {
2015 final long token = Binder.clearCallingIdentity();
2016 try {
2017 mExecutor.execute(() -> {
2018 mSlot = null;
2019 callback.onError(error);
2020 });
2021 } finally {
2022 Binder.restoreCallingIdentity(token);
2023 }
2024 mExecutor.shutdown();
2025 }
2026
2027 @Override
2028 public void onDataReceived() {
2029 // PacketKeepalive is only used for Nat-T keepalive and as such does not invoke
2030 // this callback when data is received.
2031 }
2032 };
2033 }
2034 }
2035
2036 /**
2037 * Starts an IPsec NAT-T keepalive packet with the specified parameters.
2038 *
2039 * @deprecated Use {@link #createSocketKeepalive} instead.
2040 *
2041 * @hide
2042 */
2043 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
2044 public PacketKeepalive startNattKeepalive(
2045 Network network, int intervalSeconds, PacketKeepaliveCallback callback,
2046 InetAddress srcAddr, int srcPort, InetAddress dstAddr) {
2047 final PacketKeepalive k = new PacketKeepalive(network, callback);
2048 try {
2049 mService.startNattKeepalive(network, intervalSeconds, k.mCallback,
2050 srcAddr.getHostAddress(), srcPort, dstAddr.getHostAddress());
2051 } catch (RemoteException e) {
2052 Log.e(TAG, "Error starting packet keepalive: ", e);
2053 throw e.rethrowFromSystemServer();
2054 }
2055 return k;
2056 }
2057
2058 // Construct an invalid fd.
2059 private ParcelFileDescriptor createInvalidFd() {
2060 final int invalidFd = -1;
2061 return ParcelFileDescriptor.adoptFd(invalidFd);
2062 }
2063
2064 /**
2065 * Request that keepalives be started on a IPsec NAT-T socket.
2066 *
2067 * @param network The {@link Network} the socket is on.
2068 * @param socket The socket that needs to be kept alive.
2069 * @param source The source address of the {@link UdpEncapsulationSocket}.
2070 * @param destination The destination address of the {@link UdpEncapsulationSocket}.
2071 * @param executor The executor on which callback will be invoked. The provided {@link Executor}
2072 * must run callback sequentially, otherwise the order of callbacks cannot be
2073 * guaranteed.
2074 * @param callback A {@link SocketKeepalive.Callback}. Used for notifications about keepalive
2075 * changes. Must be extended by applications that use this API.
2076 *
2077 * @return A {@link SocketKeepalive} object that can be used to control the keepalive on the
2078 * given socket.
2079 **/
2080 public @NonNull SocketKeepalive createSocketKeepalive(@NonNull Network network,
2081 @NonNull UdpEncapsulationSocket socket,
2082 @NonNull InetAddress source,
2083 @NonNull InetAddress destination,
2084 @NonNull @CallbackExecutor Executor executor,
2085 @NonNull Callback callback) {
2086 ParcelFileDescriptor dup;
2087 try {
2088 // Dup is needed here as the pfd inside the socket is owned by the IpSecService,
2089 // which cannot be obtained by the app process.
2090 dup = ParcelFileDescriptor.dup(socket.getFileDescriptor());
2091 } catch (IOException ignored) {
2092 // Construct an invalid fd, so that if the user later calls start(), it will fail with
2093 // ERROR_INVALID_SOCKET.
2094 dup = createInvalidFd();
2095 }
2096 return new NattSocketKeepalive(mService, network, dup, socket.getResourceId(), source,
2097 destination, executor, callback);
2098 }
2099
2100 /**
2101 * Request that keepalives be started on a IPsec NAT-T socket file descriptor. Directly called
2102 * by system apps which don't use IpSecService to create {@link UdpEncapsulationSocket}.
2103 *
2104 * @param network The {@link Network} the socket is on.
2105 * @param pfd The {@link ParcelFileDescriptor} that needs to be kept alive. The provided
2106 * {@link ParcelFileDescriptor} must be bound to a port and the keepalives will be sent
2107 * from that port.
2108 * @param source The source address of the {@link UdpEncapsulationSocket}.
2109 * @param destination The destination address of the {@link UdpEncapsulationSocket}. The
2110 * keepalive packets will always be sent to port 4500 of the given {@code destination}.
2111 * @param executor The executor on which callback will be invoked. The provided {@link Executor}
2112 * must run callback sequentially, otherwise the order of callbacks cannot be
2113 * guaranteed.
2114 * @param callback A {@link SocketKeepalive.Callback}. Used for notifications about keepalive
2115 * changes. Must be extended by applications that use this API.
2116 *
2117 * @return A {@link SocketKeepalive} object that can be used to control the keepalive on the
2118 * given socket.
2119 * @hide
2120 */
2121 @SystemApi
2122 @RequiresPermission(android.Manifest.permission.PACKET_KEEPALIVE_OFFLOAD)
2123 public @NonNull SocketKeepalive createNattKeepalive(@NonNull Network network,
2124 @NonNull ParcelFileDescriptor pfd,
2125 @NonNull InetAddress source,
2126 @NonNull InetAddress destination,
2127 @NonNull @CallbackExecutor Executor executor,
2128 @NonNull Callback callback) {
2129 ParcelFileDescriptor dup;
2130 try {
2131 // TODO: Consider remove unnecessary dup.
2132 dup = pfd.dup();
2133 } catch (IOException ignored) {
2134 // Construct an invalid fd, so that if the user later calls start(), it will fail with
2135 // ERROR_INVALID_SOCKET.
2136 dup = createInvalidFd();
2137 }
2138 return new NattSocketKeepalive(mService, network, dup,
Remi NGUYEN VANa29be5c2021-03-11 10:56:49 +00002139 -1 /* Unused */, source, destination, executor, callback);
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002140 }
2141
2142 /**
2143 * Request that keepalives be started on a TCP socket.
2144 * The socket must be established.
2145 *
2146 * @param network The {@link Network} the socket is on.
2147 * @param socket The socket that needs to be kept alive.
2148 * @param executor The executor on which callback will be invoked. This implementation assumes
2149 * the provided {@link Executor} runs the callbacks in sequence with no
2150 * concurrency. Failing this, no guarantee of correctness can be made. It is
2151 * the responsibility of the caller to ensure the executor provides this
2152 * guarantee. A simple way of creating such an executor is with the standard
2153 * tool {@code Executors.newSingleThreadExecutor}.
2154 * @param callback A {@link SocketKeepalive.Callback}. Used for notifications about keepalive
2155 * changes. Must be extended by applications that use this API.
2156 *
2157 * @return A {@link SocketKeepalive} object that can be used to control the keepalive on the
2158 * given socket.
2159 * @hide
2160 */
2161 @SystemApi
2162 @RequiresPermission(android.Manifest.permission.PACKET_KEEPALIVE_OFFLOAD)
2163 public @NonNull SocketKeepalive createSocketKeepalive(@NonNull Network network,
2164 @NonNull Socket socket,
2165 @NonNull Executor executor,
2166 @NonNull Callback callback) {
2167 ParcelFileDescriptor dup;
2168 try {
2169 dup = ParcelFileDescriptor.fromSocket(socket);
2170 } catch (UncheckedIOException ignored) {
2171 // Construct an invalid fd, so that if the user later calls start(), it will fail with
2172 // ERROR_INVALID_SOCKET.
2173 dup = createInvalidFd();
2174 }
2175 return new TcpSocketKeepalive(mService, network, dup, executor, callback);
2176 }
2177
2178 /**
2179 * Ensure that a network route exists to deliver traffic to the specified
2180 * host via the specified network interface. An attempt to add a route that
2181 * already exists is ignored, but treated as successful.
2182 *
2183 * <p>This method requires the caller to hold either the
2184 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
2185 * or the ability to modify system settings as determined by
2186 * {@link android.provider.Settings.System#canWrite}.</p>
2187 *
2188 * @param networkType the type of the network over which traffic to the specified
2189 * host is to be routed
2190 * @param hostAddress the IP address of the host to which the route is desired
2191 * @return {@code true} on success, {@code false} on failure
2192 *
2193 * @deprecated Deprecated in favor of the
2194 * {@link #requestNetwork(NetworkRequest, NetworkCallback)},
2195 * {@link #bindProcessToNetwork} and {@link Network#getSocketFactory} API.
2196 * In {@link VERSION_CODES#M}, and above, this method is unsupported and will
2197 * throw {@code UnsupportedOperationException} if called.
2198 * @removed
2199 */
2200 @Deprecated
2201 public boolean requestRouteToHost(int networkType, int hostAddress) {
2202 return requestRouteToHostAddress(networkType, NetworkUtils.intToInetAddress(hostAddress));
2203 }
2204
2205 /**
2206 * Ensure that a network route exists to deliver traffic to the specified
2207 * host via the specified network interface. An attempt to add a route that
2208 * already exists is ignored, but treated as successful.
2209 *
2210 * <p>This method requires the caller to hold either the
2211 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
2212 * or the ability to modify system settings as determined by
2213 * {@link android.provider.Settings.System#canWrite}.</p>
2214 *
2215 * @param networkType the type of the network over which traffic to the specified
2216 * host is to be routed
2217 * @param hostAddress the IP address of the host to which the route is desired
2218 * @return {@code true} on success, {@code false} on failure
2219 * @hide
2220 * @deprecated Deprecated in favor of the {@link #requestNetwork} and
2221 * {@link #bindProcessToNetwork} API.
2222 */
2223 @Deprecated
2224 @UnsupportedAppUsage
lucaslin97fb10a2021-03-22 11:51:27 +08002225 @SystemApi(client = MODULE_LIBRARIES)
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002226 public boolean requestRouteToHostAddress(int networkType, InetAddress hostAddress) {
2227 checkLegacyRoutingApiAccess();
2228 try {
2229 return mService.requestRouteToHostAddress(networkType, hostAddress.getAddress(),
2230 mContext.getOpPackageName(), getAttributionTag());
2231 } catch (RemoteException e) {
2232 throw e.rethrowFromSystemServer();
2233 }
2234 }
2235
2236 /**
2237 * @return the context's attribution tag
2238 */
2239 // TODO: Remove method and replace with direct call once R code is pushed to AOSP
2240 private @Nullable String getAttributionTag() {
Remi NGUYEN VANa522fc22021-02-01 10:25:24 +00002241 return mContext.getAttributionTag();
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002242 }
2243
2244 /**
2245 * Returns the value of the setting for background data usage. If false,
2246 * applications should not use the network if the application is not in the
2247 * foreground. Developers should respect this setting, and check the value
2248 * of this before performing any background data operations.
2249 * <p>
2250 * All applications that have background services that use the network
2251 * should listen to {@link #ACTION_BACKGROUND_DATA_SETTING_CHANGED}.
2252 * <p>
2253 * @deprecated As of {@link VERSION_CODES#ICE_CREAM_SANDWICH}, availability of
2254 * background data depends on several combined factors, and this method will
2255 * always return {@code true}. Instead, when background data is unavailable,
2256 * {@link #getActiveNetworkInfo()} will now appear disconnected.
2257 *
2258 * @return Whether background data usage is allowed.
2259 */
2260 @Deprecated
2261 public boolean getBackgroundDataSetting() {
2262 // assume that background data is allowed; final authority is
2263 // NetworkInfo which may be blocked.
2264 return true;
2265 }
2266
2267 /**
2268 * Sets the value of the setting for background data usage.
2269 *
2270 * @param allowBackgroundData Whether an application should use data while
2271 * it is in the background.
2272 *
2273 * @attr ref android.Manifest.permission#CHANGE_BACKGROUND_DATA_SETTING
2274 * @see #getBackgroundDataSetting()
2275 * @hide
2276 */
2277 @Deprecated
2278 @UnsupportedAppUsage
2279 public void setBackgroundDataSetting(boolean allowBackgroundData) {
2280 // ignored
2281 }
2282
2283 /**
2284 * @hide
2285 * @deprecated Talk to TelephonyManager directly
2286 */
2287 @Deprecated
2288 @UnsupportedAppUsage
2289 public boolean getMobileDataEnabled() {
2290 TelephonyManager tm = mContext.getSystemService(TelephonyManager.class);
2291 if (tm != null) {
2292 int subId = SubscriptionManager.getDefaultDataSubscriptionId();
2293 Log.d("ConnectivityManager", "getMobileDataEnabled()+ subId=" + subId);
2294 boolean retVal = tm.createForSubscriptionId(subId).isDataEnabled();
2295 Log.d("ConnectivityManager", "getMobileDataEnabled()- subId=" + subId
2296 + " retVal=" + retVal);
2297 return retVal;
2298 }
2299 Log.d("ConnectivityManager", "getMobileDataEnabled()- remote exception retVal=false");
2300 return false;
2301 }
2302
2303 /**
2304 * Callback for use with {@link ConnectivityManager#addDefaultNetworkActiveListener}
2305 * to find out when the system default network has gone in to a high power state.
2306 */
2307 public interface OnNetworkActiveListener {
2308 /**
2309 * Called on the main thread of the process to report that the current data network
2310 * has become active, and it is now a good time to perform any pending network
2311 * operations. Note that this listener only tells you when the network becomes
2312 * active; if at any other time you want to know whether it is active (and thus okay
2313 * to initiate network traffic), you can retrieve its instantaneous state with
2314 * {@link ConnectivityManager#isDefaultNetworkActive}.
2315 */
2316 void onNetworkActive();
2317 }
2318
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002319 private final ArrayMap<OnNetworkActiveListener, INetworkActivityListener>
2320 mNetworkActivityListeners = new ArrayMap<>();
2321
2322 /**
2323 * Start listening to reports when the system's default data network is active, meaning it is
2324 * a good time to perform network traffic. Use {@link #isDefaultNetworkActive()}
2325 * to determine the current state of the system's default network after registering the
2326 * listener.
2327 * <p>
2328 * If the process default network has been set with
2329 * {@link ConnectivityManager#bindProcessToNetwork} this function will not
2330 * reflect the process's default, but the system default.
2331 *
2332 * @param l The listener to be told when the network is active.
2333 */
2334 public void addDefaultNetworkActiveListener(final OnNetworkActiveListener l) {
2335 INetworkActivityListener rl = new INetworkActivityListener.Stub() {
2336 @Override
2337 public void onNetworkActive() throws RemoteException {
2338 l.onNetworkActive();
2339 }
2340 };
2341
2342 try {
lucaslin709eb842021-01-21 02:04:15 +08002343 mService.registerNetworkActivityListener(rl);
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002344 mNetworkActivityListeners.put(l, rl);
2345 } catch (RemoteException e) {
2346 throw e.rethrowFromSystemServer();
2347 }
2348 }
2349
2350 /**
2351 * Remove network active listener previously registered with
2352 * {@link #addDefaultNetworkActiveListener}.
2353 *
2354 * @param l Previously registered listener.
2355 */
2356 public void removeDefaultNetworkActiveListener(@NonNull OnNetworkActiveListener l) {
2357 INetworkActivityListener rl = mNetworkActivityListeners.get(l);
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00002358 if (rl == null) {
2359 throw new IllegalArgumentException("Listener was not registered.");
2360 }
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002361 try {
lucaslin709eb842021-01-21 02:04:15 +08002362 mService.registerNetworkActivityListener(rl);
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002363 } catch (RemoteException e) {
2364 throw e.rethrowFromSystemServer();
2365 }
2366 }
2367
2368 /**
2369 * Return whether the data network is currently active. An active network means that
2370 * it is currently in a high power state for performing data transmission. On some
2371 * types of networks, it may be expensive to move and stay in such a state, so it is
2372 * more power efficient to batch network traffic together when the radio is already in
2373 * this state. This method tells you whether right now is currently a good time to
2374 * initiate network traffic, as the network is already active.
2375 */
2376 public boolean isDefaultNetworkActive() {
2377 try {
lucaslin709eb842021-01-21 02:04:15 +08002378 return mService.isDefaultNetworkActive();
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002379 } catch (RemoteException e) {
2380 throw e.rethrowFromSystemServer();
2381 }
2382 }
2383
2384 /**
2385 * {@hide}
2386 */
2387 public ConnectivityManager(Context context, IConnectivityManager service) {
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00002388 mContext = Objects.requireNonNull(context, "missing context");
2389 mService = Objects.requireNonNull(service, "missing IConnectivityManager");
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002390 mTetheringManager = (TetheringManager) mContext.getSystemService(Context.TETHERING_SERVICE);
2391 sInstance = this;
2392 }
2393
2394 /** {@hide} */
2395 @UnsupportedAppUsage
2396 public static ConnectivityManager from(Context context) {
2397 return (ConnectivityManager) context.getSystemService(Context.CONNECTIVITY_SERVICE);
2398 }
2399
2400 /** @hide */
2401 public NetworkRequest getDefaultRequest() {
2402 try {
2403 // This is not racy as the default request is final in ConnectivityService.
2404 return mService.getDefaultRequest();
2405 } catch (RemoteException e) {
2406 throw e.rethrowFromSystemServer();
2407 }
2408 }
2409
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002410 /**
2411 * Check if the package is a allowed to write settings. This also accounts that such an access
2412 * happened.
2413 *
2414 * @return {@code true} iff the package is allowed to write settings.
2415 */
2416 // TODO: Remove method and replace with direct call once R code is pushed to AOSP
2417 private static boolean checkAndNoteWriteSettingsOperation(@NonNull Context context, int uid,
2418 @NonNull String callingPackage, @Nullable String callingAttributionTag,
2419 boolean throwException) {
2420 return Settings.checkAndNoteWriteSettingsOperation(context, uid, callingPackage,
Remi NGUYEN VANa522fc22021-02-01 10:25:24 +00002421 callingAttributionTag, throwException);
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002422 }
2423
2424 /**
2425 * @deprecated - use getSystemService. This is a kludge to support static access in certain
2426 * situations where a Context pointer is unavailable.
2427 * @hide
2428 */
2429 @Deprecated
2430 static ConnectivityManager getInstanceOrNull() {
2431 return sInstance;
2432 }
2433
2434 /**
2435 * @deprecated - use getSystemService. This is a kludge to support static access in certain
2436 * situations where a Context pointer is unavailable.
2437 * @hide
2438 */
2439 @Deprecated
2440 @UnsupportedAppUsage
2441 private static ConnectivityManager getInstance() {
2442 if (getInstanceOrNull() == null) {
2443 throw new IllegalStateException("No ConnectivityManager yet constructed");
2444 }
2445 return getInstanceOrNull();
2446 }
2447
2448 /**
2449 * Get the set of tetherable, available interfaces. This list is limited by
2450 * device configuration and current interface existence.
2451 *
2452 * @return an array of 0 or more Strings of tetherable interface names.
2453 *
2454 * @deprecated Use {@link TetheringEventCallback#onTetherableInterfacesChanged(List)} instead.
2455 * {@hide}
2456 */
2457 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
2458 @UnsupportedAppUsage
2459 @Deprecated
2460 public String[] getTetherableIfaces() {
2461 return mTetheringManager.getTetherableIfaces();
2462 }
2463
2464 /**
2465 * Get the set of tethered interfaces.
2466 *
2467 * @return an array of 0 or more String of currently tethered interface names.
2468 *
2469 * @deprecated Use {@link TetheringEventCallback#onTetherableInterfacesChanged(List)} instead.
2470 * {@hide}
2471 */
2472 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
2473 @UnsupportedAppUsage
2474 @Deprecated
2475 public String[] getTetheredIfaces() {
2476 return mTetheringManager.getTetheredIfaces();
2477 }
2478
2479 /**
2480 * Get the set of interface names which attempted to tether but
2481 * failed. Re-attempting to tether may cause them to reset to the Tethered
2482 * state. Alternatively, causing the interface to be destroyed and recreated
2483 * may cause them to reset to the available state.
2484 * {@link ConnectivityManager#getLastTetherError} can be used to get more
2485 * information on the cause of the errors.
2486 *
2487 * @return an array of 0 or more String indicating the interface names
2488 * which failed to tether.
2489 *
2490 * @deprecated Use {@link TetheringEventCallback#onError(String, int)} instead.
2491 * {@hide}
2492 */
2493 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
2494 @UnsupportedAppUsage
2495 @Deprecated
2496 public String[] getTetheringErroredIfaces() {
2497 return mTetheringManager.getTetheringErroredIfaces();
2498 }
2499
2500 /**
2501 * Get the set of tethered dhcp ranges.
2502 *
2503 * @deprecated This method is not supported.
2504 * TODO: remove this function when all of clients are removed.
2505 * {@hide}
2506 */
2507 @RequiresPermission(android.Manifest.permission.NETWORK_SETTINGS)
2508 @Deprecated
2509 public String[] getTetheredDhcpRanges() {
2510 throw new UnsupportedOperationException("getTetheredDhcpRanges is not supported");
2511 }
2512
2513 /**
2514 * Attempt to tether the named interface. This will setup a dhcp server
2515 * on the interface, forward and NAT IP packets and forward DNS requests
2516 * to the best active upstream network interface. Note that if no upstream
2517 * IP network interface is available, dhcp will still run and traffic will be
2518 * allowed between the tethered devices and this device, though upstream net
2519 * access will of course fail until an upstream network interface becomes
2520 * active.
2521 *
2522 * <p>This method requires the caller to hold either the
2523 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
2524 * or the ability to modify system settings as determined by
2525 * {@link android.provider.Settings.System#canWrite}.</p>
2526 *
2527 * <p>WARNING: New clients should not use this function. The only usages should be in PanService
2528 * and WifiStateMachine which need direct access. All other clients should use
2529 * {@link #startTethering} and {@link #stopTethering} which encapsulate proper provisioning
2530 * logic.</p>
2531 *
2532 * @param iface the interface name to tether.
2533 * @return error a {@code TETHER_ERROR} value indicating success or failure type
2534 * @deprecated Use {@link TetheringManager#startTethering} instead
2535 *
2536 * {@hide}
2537 */
2538 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
2539 @Deprecated
2540 public int tether(String iface) {
2541 return mTetheringManager.tether(iface);
2542 }
2543
2544 /**
2545 * Stop tethering the named interface.
2546 *
2547 * <p>This method requires the caller to hold either the
2548 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
2549 * or the ability to modify system settings as determined by
2550 * {@link android.provider.Settings.System#canWrite}.</p>
2551 *
2552 * <p>WARNING: New clients should not use this function. The only usages should be in PanService
2553 * and WifiStateMachine which need direct access. All other clients should use
2554 * {@link #startTethering} and {@link #stopTethering} which encapsulate proper provisioning
2555 * logic.</p>
2556 *
2557 * @param iface the interface name to untether.
2558 * @return error a {@code TETHER_ERROR} value indicating success or failure type
2559 *
2560 * {@hide}
2561 */
2562 @UnsupportedAppUsage
2563 @Deprecated
2564 public int untether(String iface) {
2565 return mTetheringManager.untether(iface);
2566 }
2567
2568 /**
2569 * Check if the device allows for tethering. It may be disabled via
2570 * {@code ro.tether.denied} system property, Settings.TETHER_SUPPORTED or
2571 * due to device configuration.
2572 *
2573 * <p>If this app does not have permission to use this API, it will always
2574 * return false rather than throw an exception.</p>
2575 *
2576 * <p>If the device has a hotspot provisioning app, the caller is required to hold the
2577 * {@link android.Manifest.permission.TETHER_PRIVILEGED} permission.</p>
2578 *
2579 * <p>Otherwise, this method requires the caller to hold the ability to modify system
2580 * settings as determined by {@link android.provider.Settings.System#canWrite}.</p>
2581 *
2582 * @return a boolean - {@code true} indicating Tethering is supported.
2583 *
2584 * @deprecated Use {@link TetheringEventCallback#onTetheringSupported(boolean)} instead.
2585 * {@hide}
2586 */
2587 @SystemApi
2588 @RequiresPermission(anyOf = {android.Manifest.permission.TETHER_PRIVILEGED,
2589 android.Manifest.permission.WRITE_SETTINGS})
2590 public boolean isTetheringSupported() {
2591 return mTetheringManager.isTetheringSupported();
2592 }
2593
2594 /**
2595 * Callback for use with {@link #startTethering} to find out whether tethering succeeded.
2596 *
2597 * @deprecated Use {@link TetheringManager.StartTetheringCallback} instead.
2598 * @hide
2599 */
2600 @SystemApi
2601 @Deprecated
2602 public static abstract class OnStartTetheringCallback {
2603 /**
2604 * Called when tethering has been successfully started.
2605 */
2606 public void onTetheringStarted() {}
2607
2608 /**
2609 * Called when starting tethering failed.
2610 */
2611 public void onTetheringFailed() {}
2612 }
2613
2614 /**
2615 * Convenient overload for
2616 * {@link #startTethering(int, boolean, OnStartTetheringCallback, Handler)} which passes a null
2617 * handler to run on the current thread's {@link Looper}.
2618 *
2619 * @deprecated Use {@link TetheringManager#startTethering} instead.
2620 * @hide
2621 */
2622 @SystemApi
2623 @Deprecated
2624 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
2625 public void startTethering(int type, boolean showProvisioningUi,
2626 final OnStartTetheringCallback callback) {
2627 startTethering(type, showProvisioningUi, callback, null);
2628 }
2629
2630 /**
2631 * Runs tether provisioning for the given type if needed and then starts tethering if
2632 * the check succeeds. If no carrier provisioning is required for tethering, tethering is
2633 * enabled immediately. If provisioning fails, tethering will not be enabled. It also
2634 * schedules tether provisioning re-checks if appropriate.
2635 *
2636 * @param type The type of tethering to start. Must be one of
2637 * {@link ConnectivityManager.TETHERING_WIFI},
2638 * {@link ConnectivityManager.TETHERING_USB}, or
2639 * {@link ConnectivityManager.TETHERING_BLUETOOTH}.
2640 * @param showProvisioningUi a boolean indicating to show the provisioning app UI if there
2641 * is one. This should be true the first time this function is called and also any time
2642 * the user can see this UI. It gives users information from their carrier about the
2643 * check failing and how they can sign up for tethering if possible.
2644 * @param callback an {@link OnStartTetheringCallback} which will be called to notify the caller
2645 * of the result of trying to tether.
2646 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
2647 *
2648 * @deprecated Use {@link TetheringManager#startTethering} instead.
2649 * @hide
2650 */
2651 @SystemApi
2652 @Deprecated
2653 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
2654 public void startTethering(int type, boolean showProvisioningUi,
2655 final OnStartTetheringCallback callback, Handler handler) {
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00002656 Objects.requireNonNull(callback, "OnStartTetheringCallback cannot be null.");
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002657
2658 final Executor executor = new Executor() {
2659 @Override
2660 public void execute(Runnable command) {
2661 if (handler == null) {
2662 command.run();
2663 } else {
2664 handler.post(command);
2665 }
2666 }
2667 };
2668
2669 final StartTetheringCallback tetheringCallback = new StartTetheringCallback() {
2670 @Override
2671 public void onTetheringStarted() {
2672 callback.onTetheringStarted();
2673 }
2674
2675 @Override
2676 public void onTetheringFailed(final int error) {
2677 callback.onTetheringFailed();
2678 }
2679 };
2680
2681 final TetheringRequest request = new TetheringRequest.Builder(type)
2682 .setShouldShowEntitlementUi(showProvisioningUi).build();
2683
2684 mTetheringManager.startTethering(request, executor, tetheringCallback);
2685 }
2686
2687 /**
2688 * Stops tethering for the given type. Also cancels any provisioning rechecks for that type if
2689 * applicable.
2690 *
2691 * @param type The type of tethering to stop. Must be one of
2692 * {@link ConnectivityManager.TETHERING_WIFI},
2693 * {@link ConnectivityManager.TETHERING_USB}, or
2694 * {@link ConnectivityManager.TETHERING_BLUETOOTH}.
2695 *
2696 * @deprecated Use {@link TetheringManager#stopTethering} instead.
2697 * @hide
2698 */
2699 @SystemApi
2700 @Deprecated
2701 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
2702 public void stopTethering(int type) {
2703 mTetheringManager.stopTethering(type);
2704 }
2705
2706 /**
2707 * Callback for use with {@link registerTetheringEventCallback} to find out tethering
2708 * upstream status.
2709 *
2710 * @deprecated Use {@link TetheringManager#OnTetheringEventCallback} instead.
2711 * @hide
2712 */
2713 @SystemApi
2714 @Deprecated
2715 public abstract static class OnTetheringEventCallback {
2716
2717 /**
2718 * Called when tethering upstream changed. This can be called multiple times and can be
2719 * called any time.
2720 *
2721 * @param network the {@link Network} of tethering upstream. Null means tethering doesn't
2722 * have any upstream.
2723 */
2724 public void onUpstreamChanged(@Nullable Network network) {}
2725 }
2726
2727 @GuardedBy("mTetheringEventCallbacks")
2728 private final ArrayMap<OnTetheringEventCallback, TetheringEventCallback>
2729 mTetheringEventCallbacks = new ArrayMap<>();
2730
2731 /**
2732 * Start listening to tethering change events. Any new added callback will receive the last
2733 * tethering status right away. If callback is registered when tethering has no upstream or
2734 * disabled, {@link OnTetheringEventCallback#onUpstreamChanged} will immediately be called
2735 * with a null argument. The same callback object cannot be registered twice.
2736 *
2737 * @param executor the executor on which callback will be invoked.
2738 * @param callback the callback to be called when tethering has change events.
2739 *
2740 * @deprecated Use {@link TetheringManager#registerTetheringEventCallback} instead.
2741 * @hide
2742 */
2743 @SystemApi
2744 @Deprecated
2745 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
2746 public void registerTetheringEventCallback(
2747 @NonNull @CallbackExecutor Executor executor,
2748 @NonNull final OnTetheringEventCallback callback) {
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00002749 Objects.requireNonNull(callback, "OnTetheringEventCallback cannot be null.");
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002750
2751 final TetheringEventCallback tetherCallback =
2752 new TetheringEventCallback() {
2753 @Override
2754 public void onUpstreamChanged(@Nullable Network network) {
2755 callback.onUpstreamChanged(network);
2756 }
2757 };
2758
2759 synchronized (mTetheringEventCallbacks) {
2760 mTetheringEventCallbacks.put(callback, tetherCallback);
2761 mTetheringManager.registerTetheringEventCallback(executor, tetherCallback);
2762 }
2763 }
2764
2765 /**
2766 * Remove tethering event callback previously registered with
2767 * {@link #registerTetheringEventCallback}.
2768 *
2769 * @param callback previously registered callback.
2770 *
2771 * @deprecated Use {@link TetheringManager#unregisterTetheringEventCallback} instead.
2772 * @hide
2773 */
2774 @SystemApi
2775 @Deprecated
2776 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
2777 public void unregisterTetheringEventCallback(
2778 @NonNull final OnTetheringEventCallback callback) {
2779 Objects.requireNonNull(callback, "The callback must be non-null");
2780 synchronized (mTetheringEventCallbacks) {
2781 final TetheringEventCallback tetherCallback =
2782 mTetheringEventCallbacks.remove(callback);
2783 mTetheringManager.unregisterTetheringEventCallback(tetherCallback);
2784 }
2785 }
2786
2787
2788 /**
2789 * Get the list of regular expressions that define any tetherable
2790 * USB network interfaces. If USB tethering is not supported by the
2791 * device, this list should be empty.
2792 *
2793 * @return an array of 0 or more regular expression Strings defining
2794 * what interfaces are considered tetherable usb interfaces.
2795 *
2796 * @deprecated Use {@link TetheringEventCallback#onTetherableInterfaceRegexpsChanged} instead.
2797 * {@hide}
2798 */
2799 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
2800 @UnsupportedAppUsage
2801 @Deprecated
2802 public String[] getTetherableUsbRegexs() {
2803 return mTetheringManager.getTetherableUsbRegexs();
2804 }
2805
2806 /**
2807 * Get the list of regular expressions that define any tetherable
2808 * Wifi network interfaces. If Wifi 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 wifi 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[] getTetherableWifiRegexs() {
2821 return mTetheringManager.getTetherableWifiRegexs();
2822 }
2823
2824 /**
2825 * Get the list of regular expressions that define any tetherable
2826 * Bluetooth network interfaces. If Bluetooth 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 bluetooth interfaces.
2831 *
2832 * @deprecated Use {@link TetheringEventCallback#onTetherableInterfaceRegexpsChanged(
2833 *TetheringManager.TetheringInterfaceRegexps)} instead.
2834 * {@hide}
2835 */
2836 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
2837 @UnsupportedAppUsage
2838 @Deprecated
2839 public String[] getTetherableBluetoothRegexs() {
2840 return mTetheringManager.getTetherableBluetoothRegexs();
2841 }
2842
2843 /**
2844 * Attempt to both alter the mode of USB and Tethering of USB. A
2845 * utility method to deal with some of the complexity of USB - will
2846 * attempt to switch to Rndis and subsequently tether the resulting
2847 * interface on {@code true} or turn off tethering and switch off
2848 * Rndis on {@code false}.
2849 *
2850 * <p>This method requires the caller to hold either the
2851 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
2852 * or the ability to modify system settings as determined by
2853 * {@link android.provider.Settings.System#canWrite}.</p>
2854 *
2855 * @param enable a boolean - {@code true} to enable tethering
2856 * @return error a {@code TETHER_ERROR} value indicating success or failure type
2857 * @deprecated Use {@link TetheringManager#startTethering} instead
2858 *
2859 * {@hide}
2860 */
2861 @UnsupportedAppUsage
2862 @Deprecated
2863 public int setUsbTethering(boolean enable) {
2864 return mTetheringManager.setUsbTethering(enable);
2865 }
2866
2867 /**
2868 * @deprecated Use {@link TetheringManager#TETHER_ERROR_NO_ERROR}.
2869 * {@hide}
2870 */
2871 @SystemApi
2872 @Deprecated
Remi NGUYEN VAN71ced8e2021-02-15 18:52:06 +09002873 public static final int TETHER_ERROR_NO_ERROR = 0;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002874 /**
2875 * @deprecated Use {@link TetheringManager#TETHER_ERROR_UNKNOWN_IFACE}.
2876 * {@hide}
2877 */
2878 @Deprecated
2879 public static final int TETHER_ERROR_UNKNOWN_IFACE =
2880 TetheringManager.TETHER_ERROR_UNKNOWN_IFACE;
2881 /**
2882 * @deprecated Use {@link TetheringManager#TETHER_ERROR_SERVICE_UNAVAIL}.
2883 * {@hide}
2884 */
2885 @Deprecated
2886 public static final int TETHER_ERROR_SERVICE_UNAVAIL =
2887 TetheringManager.TETHER_ERROR_SERVICE_UNAVAIL;
2888 /**
2889 * @deprecated Use {@link TetheringManager#TETHER_ERROR_UNSUPPORTED}.
2890 * {@hide}
2891 */
2892 @Deprecated
2893 public static final int TETHER_ERROR_UNSUPPORTED = TetheringManager.TETHER_ERROR_UNSUPPORTED;
2894 /**
2895 * @deprecated Use {@link TetheringManager#TETHER_ERROR_UNAVAIL_IFACE}.
2896 * {@hide}
2897 */
2898 @Deprecated
2899 public static final int TETHER_ERROR_UNAVAIL_IFACE =
2900 TetheringManager.TETHER_ERROR_UNAVAIL_IFACE;
2901 /**
2902 * @deprecated Use {@link TetheringManager#TETHER_ERROR_INTERNAL_ERROR}.
2903 * {@hide}
2904 */
2905 @Deprecated
2906 public static final int TETHER_ERROR_MASTER_ERROR =
2907 TetheringManager.TETHER_ERROR_INTERNAL_ERROR;
2908 /**
2909 * @deprecated Use {@link TetheringManager#TETHER_ERROR_TETHER_IFACE_ERROR}.
2910 * {@hide}
2911 */
2912 @Deprecated
2913 public static final int TETHER_ERROR_TETHER_IFACE_ERROR =
2914 TetheringManager.TETHER_ERROR_TETHER_IFACE_ERROR;
2915 /**
2916 * @deprecated Use {@link TetheringManager#TETHER_ERROR_UNTETHER_IFACE_ERROR}.
2917 * {@hide}
2918 */
2919 @Deprecated
2920 public static final int TETHER_ERROR_UNTETHER_IFACE_ERROR =
2921 TetheringManager.TETHER_ERROR_UNTETHER_IFACE_ERROR;
2922 /**
2923 * @deprecated Use {@link TetheringManager#TETHER_ERROR_ENABLE_FORWARDING_ERROR}.
2924 * {@hide}
2925 */
2926 @Deprecated
2927 public static final int TETHER_ERROR_ENABLE_NAT_ERROR =
2928 TetheringManager.TETHER_ERROR_ENABLE_FORWARDING_ERROR;
2929 /**
2930 * @deprecated Use {@link TetheringManager#TETHER_ERROR_DISABLE_FORWARDING_ERROR}.
2931 * {@hide}
2932 */
2933 @Deprecated
2934 public static final int TETHER_ERROR_DISABLE_NAT_ERROR =
2935 TetheringManager.TETHER_ERROR_DISABLE_FORWARDING_ERROR;
2936 /**
2937 * @deprecated Use {@link TetheringManager#TETHER_ERROR_IFACE_CFG_ERROR}.
2938 * {@hide}
2939 */
2940 @Deprecated
2941 public static final int TETHER_ERROR_IFACE_CFG_ERROR =
2942 TetheringManager.TETHER_ERROR_IFACE_CFG_ERROR;
2943 /**
2944 * @deprecated Use {@link TetheringManager#TETHER_ERROR_PROVISIONING_FAILED}.
2945 * {@hide}
2946 */
2947 @SystemApi
2948 @Deprecated
Remi NGUYEN VAN71ced8e2021-02-15 18:52:06 +09002949 public static final int TETHER_ERROR_PROVISION_FAILED = 11;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002950 /**
2951 * @deprecated Use {@link TetheringManager#TETHER_ERROR_DHCPSERVER_ERROR}.
2952 * {@hide}
2953 */
2954 @Deprecated
2955 public static final int TETHER_ERROR_DHCPSERVER_ERROR =
2956 TetheringManager.TETHER_ERROR_DHCPSERVER_ERROR;
2957 /**
2958 * @deprecated Use {@link TetheringManager#TETHER_ERROR_ENTITLEMENT_UNKNOWN}.
2959 * {@hide}
2960 */
2961 @SystemApi
2962 @Deprecated
Remi NGUYEN VAN71ced8e2021-02-15 18:52:06 +09002963 public static final int TETHER_ERROR_ENTITLEMENT_UNKONWN = 13;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09002964
2965 /**
2966 * Get a more detailed error code after a Tethering or Untethering
2967 * request asynchronously failed.
2968 *
2969 * @param iface The name of the interface of interest
2970 * @return error The error code of the last error tethering or untethering the named
2971 * interface
2972 *
2973 * @deprecated Use {@link TetheringEventCallback#onError(String, int)} instead.
2974 * {@hide}
2975 */
2976 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
2977 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
2978 @Deprecated
2979 public int getLastTetherError(String iface) {
2980 int error = mTetheringManager.getLastTetherError(iface);
2981 if (error == TetheringManager.TETHER_ERROR_UNKNOWN_TYPE) {
2982 // TETHER_ERROR_UNKNOWN_TYPE was introduced with TetheringManager and has never been
2983 // returned by ConnectivityManager. Convert it to the legacy TETHER_ERROR_UNKNOWN_IFACE
2984 // instead.
2985 error = TetheringManager.TETHER_ERROR_UNKNOWN_IFACE;
2986 }
2987 return error;
2988 }
2989
2990 /** @hide */
2991 @Retention(RetentionPolicy.SOURCE)
2992 @IntDef(value = {
2993 TETHER_ERROR_NO_ERROR,
2994 TETHER_ERROR_PROVISION_FAILED,
2995 TETHER_ERROR_ENTITLEMENT_UNKONWN,
2996 })
2997 public @interface EntitlementResultCode {
2998 }
2999
3000 /**
3001 * Callback for use with {@link #getLatestTetheringEntitlementResult} to find out whether
3002 * entitlement succeeded.
3003 *
3004 * @deprecated Use {@link TetheringManager#OnTetheringEntitlementResultListener} instead.
3005 * @hide
3006 */
3007 @SystemApi
3008 @Deprecated
3009 public interface OnTetheringEntitlementResultListener {
3010 /**
3011 * Called to notify entitlement result.
3012 *
3013 * @param resultCode an int value of entitlement result. It may be one of
3014 * {@link #TETHER_ERROR_NO_ERROR},
3015 * {@link #TETHER_ERROR_PROVISION_FAILED}, or
3016 * {@link #TETHER_ERROR_ENTITLEMENT_UNKONWN}.
3017 */
3018 void onTetheringEntitlementResult(@EntitlementResultCode int resultCode);
3019 }
3020
3021 /**
3022 * Get the last value of the entitlement check on this downstream. If the cached value is
3023 * {@link #TETHER_ERROR_NO_ERROR} or showEntitlementUi argument is false, it just return the
3024 * cached value. Otherwise, a UI-based entitlement check would be performed. It is not
3025 * guaranteed that the UI-based entitlement check will complete in any specific time period
3026 * and may in fact never complete. Any successful entitlement check the platform performs for
3027 * any reason will update the cached value.
3028 *
3029 * @param type the downstream type of tethering. Must be one of
3030 * {@link #TETHERING_WIFI},
3031 * {@link #TETHERING_USB}, or
3032 * {@link #TETHERING_BLUETOOTH}.
3033 * @param showEntitlementUi a boolean indicating whether to run UI-based entitlement check.
3034 * @param executor the executor on which callback will be invoked.
3035 * @param listener an {@link OnTetheringEntitlementResultListener} which will be called to
3036 * notify the caller of the result of entitlement check. The listener may be called zero
3037 * or one time.
3038 * @deprecated Use {@link TetheringManager#requestLatestTetheringEntitlementResult} instead.
3039 * {@hide}
3040 */
3041 @SystemApi
3042 @Deprecated
3043 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
3044 public void getLatestTetheringEntitlementResult(int type, boolean showEntitlementUi,
3045 @NonNull @CallbackExecutor Executor executor,
3046 @NonNull final OnTetheringEntitlementResultListener listener) {
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00003047 Objects.requireNonNull(listener, "TetheringEntitlementResultListener cannot be null.");
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003048 ResultReceiver wrappedListener = new ResultReceiver(null) {
3049 @Override
3050 protected void onReceiveResult(int resultCode, Bundle resultData) {
lucaslineaff72d2021-03-04 09:38:21 +08003051 final long token = Binder.clearCallingIdentity();
3052 try {
3053 executor.execute(() -> {
3054 listener.onTetheringEntitlementResult(resultCode);
3055 });
3056 } finally {
3057 Binder.restoreCallingIdentity(token);
3058 }
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003059 }
3060 };
3061
3062 mTetheringManager.requestLatestTetheringEntitlementResult(type, wrappedListener,
3063 showEntitlementUi);
3064 }
3065
3066 /**
3067 * Report network connectivity status. This is currently used only
3068 * to alter status bar UI.
3069 * <p>This method requires the caller to hold the permission
3070 * {@link android.Manifest.permission#STATUS_BAR}.
3071 *
3072 * @param networkType The type of network you want to report on
3073 * @param percentage The quality of the connection 0 is bad, 100 is good
3074 * @deprecated Types are deprecated. Use {@link #reportNetworkConnectivity} instead.
3075 * {@hide}
3076 */
3077 public void reportInetCondition(int networkType, int percentage) {
3078 printStackTrace();
3079 try {
3080 mService.reportInetCondition(networkType, percentage);
3081 } catch (RemoteException e) {
3082 throw e.rethrowFromSystemServer();
3083 }
3084 }
3085
3086 /**
3087 * Report a problem network to the framework. This provides a hint to the system
3088 * that there might be connectivity problems on this network and may cause
3089 * the framework to re-evaluate network connectivity and/or switch to another
3090 * network.
3091 *
3092 * @param network The {@link Network} the application was attempting to use
3093 * or {@code null} to indicate the current default network.
3094 * @deprecated Use {@link #reportNetworkConnectivity} which allows reporting both
3095 * working and non-working connectivity.
3096 */
3097 @Deprecated
3098 public void reportBadNetwork(@Nullable Network network) {
3099 printStackTrace();
3100 try {
3101 // One of these will be ignored because it matches system's current state.
3102 // The other will trigger the necessary reevaluation.
3103 mService.reportNetworkConnectivity(network, true);
3104 mService.reportNetworkConnectivity(network, false);
3105 } catch (RemoteException e) {
3106 throw e.rethrowFromSystemServer();
3107 }
3108 }
3109
3110 /**
3111 * Report to the framework whether a network has working connectivity.
3112 * This provides a hint to the system that a particular network is providing
3113 * working connectivity or not. In response the framework may re-evaluate
3114 * the network's connectivity and might take further action thereafter.
3115 *
3116 * @param network The {@link Network} the application was attempting to use
3117 * or {@code null} to indicate the current default network.
3118 * @param hasConnectivity {@code true} if the application was able to successfully access the
3119 * Internet using {@code network} or {@code false} if not.
3120 */
3121 public void reportNetworkConnectivity(@Nullable Network network, boolean hasConnectivity) {
3122 printStackTrace();
3123 try {
3124 mService.reportNetworkConnectivity(network, hasConnectivity);
3125 } catch (RemoteException e) {
3126 throw e.rethrowFromSystemServer();
3127 }
3128 }
3129
3130 /**
Chalard Jeane1ce6ae2021-03-17 17:03:34 +09003131 * Set a network-independent global HTTP proxy.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003132 *
Chalard Jeane1ce6ae2021-03-17 17:03:34 +09003133 * This sets an HTTP proxy that applies to all networks and overrides any network-specific
3134 * proxy. If set, HTTP libraries that are proxy-aware will use this global proxy when
3135 * accessing any network, regardless of what the settings for that network are.
3136 *
3137 * Note that HTTP proxies are by nature typically network-dependent, and setting a global
3138 * proxy is likely to break networking on multiple networks. This method is only meant
3139 * for device policy clients looking to do general internal filtering or similar use cases.
3140 *
3141 * {@see #getGlobalProxy}
3142 * {@see LinkProperties#getHttpProxy}
3143 *
3144 * @param p A {@link ProxyInfo} object defining the new global HTTP proxy. Calling this
3145 * method with a {@code null} value will clear the global HTTP proxy.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003146 * @hide
3147 */
Chalard Jeane1ce6ae2021-03-17 17:03:34 +09003148 // Used by Device Policy Manager to set the global proxy.
Chiachang Wangf9294e72021-03-18 09:44:34 +08003149 @SystemApi(client = MODULE_LIBRARIES)
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003150 @RequiresPermission(android.Manifest.permission.NETWORK_STACK)
Chalard Jeane1ce6ae2021-03-17 17:03:34 +09003151 public void setGlobalProxy(@Nullable final ProxyInfo p) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003152 try {
3153 mService.setGlobalProxy(p);
3154 } catch (RemoteException e) {
3155 throw e.rethrowFromSystemServer();
3156 }
3157 }
3158
3159 /**
3160 * Retrieve any network-independent global HTTP proxy.
3161 *
3162 * @return {@link ProxyInfo} for the current global HTTP proxy or {@code null}
3163 * if no global HTTP proxy is set.
3164 * @hide
3165 */
Chiachang Wangf9294e72021-03-18 09:44:34 +08003166 @SystemApi(client = MODULE_LIBRARIES)
3167 @Nullable
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003168 public ProxyInfo getGlobalProxy() {
3169 try {
3170 return mService.getGlobalProxy();
3171 } catch (RemoteException e) {
3172 throw e.rethrowFromSystemServer();
3173 }
3174 }
3175
3176 /**
3177 * Retrieve the global HTTP proxy, or if no global HTTP proxy is set, a
3178 * network-specific HTTP proxy. If {@code network} is null, the
3179 * network-specific proxy returned is the proxy of the default active
3180 * network.
3181 *
3182 * @return {@link ProxyInfo} for the current global HTTP proxy, or if no
3183 * global HTTP proxy is set, {@code ProxyInfo} for {@code network},
3184 * or when {@code network} is {@code null},
3185 * the {@code ProxyInfo} for the default active network. Returns
3186 * {@code null} when no proxy applies or the caller doesn't have
3187 * permission to use {@code network}.
3188 * @hide
3189 */
3190 public ProxyInfo getProxyForNetwork(Network network) {
3191 try {
3192 return mService.getProxyForNetwork(network);
3193 } catch (RemoteException e) {
3194 throw e.rethrowFromSystemServer();
3195 }
3196 }
3197
3198 /**
3199 * Get the current default HTTP proxy settings. If a global proxy is set it will be returned,
3200 * otherwise if this process is bound to a {@link Network} using
3201 * {@link #bindProcessToNetwork} then that {@code Network}'s proxy is returned, otherwise
3202 * the default network's proxy is returned.
3203 *
3204 * @return the {@link ProxyInfo} for the current HTTP proxy, or {@code null} if no
3205 * HTTP proxy is active.
3206 */
3207 @Nullable
3208 public ProxyInfo getDefaultProxy() {
3209 return getProxyForNetwork(getBoundNetworkForProcess());
3210 }
3211
3212 /**
3213 * Returns true if the hardware supports the given network type
3214 * else it returns false. This doesn't indicate we have coverage
3215 * or are authorized onto a network, just whether or not the
3216 * hardware supports it. For example a GSM phone without a SIM
3217 * should still return {@code true} for mobile data, but a wifi only
3218 * tablet would return {@code false}.
3219 *
3220 * @param networkType The network type we'd like to check
3221 * @return {@code true} if supported, else {@code false}
3222 * @deprecated Types are deprecated. Use {@link NetworkCapabilities} instead.
3223 * @hide
3224 */
3225 @Deprecated
3226 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
3227 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 130143562)
3228 public boolean isNetworkSupported(int networkType) {
3229 try {
3230 return mService.isNetworkSupported(networkType);
3231 } catch (RemoteException e) {
3232 throw e.rethrowFromSystemServer();
3233 }
3234 }
3235
3236 /**
3237 * Returns if the currently active data network is metered. A network is
3238 * classified as metered when the user is sensitive to heavy data usage on
3239 * that connection due to monetary costs, data limitations or
3240 * battery/performance issues. You should check this before doing large
3241 * data transfers, and warn the user or delay the operation until another
3242 * network is available.
3243 *
3244 * @return {@code true} if large transfers should be avoided, otherwise
3245 * {@code false}.
3246 */
3247 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
3248 public boolean isActiveNetworkMetered() {
3249 try {
3250 return mService.isActiveNetworkMetered();
3251 } catch (RemoteException e) {
3252 throw e.rethrowFromSystemServer();
3253 }
3254 }
3255
3256 /**
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003257 * Set sign in error notification to visible or invisible
3258 *
3259 * @hide
3260 * @deprecated Doesn't properly deal with multiple connected networks of the same type.
3261 */
3262 @Deprecated
3263 public void setProvisioningNotificationVisible(boolean visible, int networkType,
3264 String action) {
3265 try {
3266 mService.setProvisioningNotificationVisible(visible, networkType, action);
3267 } catch (RemoteException e) {
3268 throw e.rethrowFromSystemServer();
3269 }
3270 }
3271
3272 /**
3273 * Set the value for enabling/disabling airplane mode
3274 *
3275 * @param enable whether to enable airplane mode or not
3276 *
3277 * @hide
3278 */
3279 @RequiresPermission(anyOf = {
3280 android.Manifest.permission.NETWORK_AIRPLANE_MODE,
3281 android.Manifest.permission.NETWORK_SETTINGS,
3282 android.Manifest.permission.NETWORK_SETUP_WIZARD,
3283 android.Manifest.permission.NETWORK_STACK})
3284 @SystemApi
3285 public void setAirplaneMode(boolean enable) {
3286 try {
3287 mService.setAirplaneMode(enable);
3288 } catch (RemoteException e) {
3289 throw e.rethrowFromSystemServer();
3290 }
3291 }
3292
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003293 /**
3294 * Registers the specified {@link NetworkProvider}.
3295 * Each listener must only be registered once. The listener can be unregistered with
3296 * {@link #unregisterNetworkProvider}.
3297 *
3298 * @param provider the provider to register
3299 * @return the ID of the provider. This ID must be used by the provider when registering
3300 * {@link android.net.NetworkAgent}s.
3301 * @hide
3302 */
3303 @SystemApi
3304 @RequiresPermission(anyOf = {
3305 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
3306 android.Manifest.permission.NETWORK_FACTORY})
3307 public int registerNetworkProvider(@NonNull NetworkProvider provider) {
3308 if (provider.getProviderId() != NetworkProvider.ID_NONE) {
3309 throw new IllegalStateException("NetworkProviders can only be registered once");
3310 }
3311
3312 try {
3313 int providerId = mService.registerNetworkProvider(provider.getMessenger(),
3314 provider.getName());
3315 provider.setProviderId(providerId);
3316 } catch (RemoteException e) {
3317 throw e.rethrowFromSystemServer();
3318 }
3319 return provider.getProviderId();
3320 }
3321
3322 /**
3323 * Unregisters the specified NetworkProvider.
3324 *
3325 * @param provider the provider to unregister
3326 * @hide
3327 */
3328 @SystemApi
3329 @RequiresPermission(anyOf = {
3330 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
3331 android.Manifest.permission.NETWORK_FACTORY})
3332 public void unregisterNetworkProvider(@NonNull NetworkProvider provider) {
3333 try {
3334 mService.unregisterNetworkProvider(provider.getMessenger());
3335 } catch (RemoteException e) {
3336 throw e.rethrowFromSystemServer();
3337 }
3338 provider.setProviderId(NetworkProvider.ID_NONE);
3339 }
3340
Chalard Jeand1b498b2021-01-05 08:40:09 +09003341 /**
3342 * Register or update a network offer with ConnectivityService.
3343 *
3344 * ConnectivityService keeps track of offers made by the various providers and matches
Chalard Jean61e231f2021-03-24 17:43:10 +09003345 * them to networking requests made by apps or the system. A callback identifies an offer
3346 * uniquely, and later calls with the same callback update the offer. The provider supplies a
3347 * score and the capabilities of the network it might be able to bring up ; these act as
3348 * filters used by ConnectivityService to only send those requests that can be fulfilled by the
Chalard Jeand1b498b2021-01-05 08:40:09 +09003349 * provider.
3350 *
3351 * The provider is under no obligation to be able to bring up the network it offers at any
3352 * given time. Instead, this mechanism is meant to limit requests received by providers
3353 * to those they actually have a chance to fulfill, as providers don't have a way to compare
3354 * the quality of the network satisfying a given request to their own offer.
3355 *
3356 * An offer can be updated by calling this again with the same callback object. This is
3357 * similar to calling unofferNetwork and offerNetwork again, but will only update the
3358 * provider with the changes caused by the changes in the offer.
3359 *
3360 * @param provider The provider making this offer.
3361 * @param score The prospective score of the network.
3362 * @param caps The prospective capabilities of the network.
3363 * @param callback The callback to call when this offer is needed or unneeded.
Chalard Jean428b9132021-01-12 10:58:56 +09003364 * @hide exposed via the NetworkProvider class.
Chalard Jeand1b498b2021-01-05 08:40:09 +09003365 */
3366 @RequiresPermission(anyOf = {
3367 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
3368 android.Manifest.permission.NETWORK_FACTORY})
Chalard Jean148dcce2021-03-22 22:44:02 +09003369 public void offerNetwork(@NonNull final int providerId,
Chalard Jeand1b498b2021-01-05 08:40:09 +09003370 @NonNull final NetworkScore score, @NonNull final NetworkCapabilities caps,
3371 @NonNull final INetworkOfferCallback callback) {
3372 try {
Chalard Jean148dcce2021-03-22 22:44:02 +09003373 mService.offerNetwork(providerId,
Chalard Jeand1b498b2021-01-05 08:40:09 +09003374 Objects.requireNonNull(score, "null score"),
3375 Objects.requireNonNull(caps, "null caps"),
3376 Objects.requireNonNull(callback, "null callback"));
3377 } catch (RemoteException e) {
3378 throw e.rethrowFromSystemServer();
3379 }
3380 }
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003381
Chalard Jeand1b498b2021-01-05 08:40:09 +09003382 /**
3383 * Withdraw a network offer made with {@link #offerNetwork}.
3384 *
3385 * @param callback The callback passed at registration time. This must be the same object
3386 * that was passed to {@link #offerNetwork}
Chalard Jean428b9132021-01-12 10:58:56 +09003387 * @hide exposed via the NetworkProvider class.
Chalard Jeand1b498b2021-01-05 08:40:09 +09003388 */
3389 public void unofferNetwork(@NonNull final INetworkOfferCallback callback) {
3390 try {
3391 mService.unofferNetwork(Objects.requireNonNull(callback));
3392 } catch (RemoteException e) {
3393 throw e.rethrowFromSystemServer();
3394 }
3395 }
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003396 /** @hide exposed via the NetworkProvider class. */
3397 @RequiresPermission(anyOf = {
3398 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
3399 android.Manifest.permission.NETWORK_FACTORY})
3400 public void declareNetworkRequestUnfulfillable(@NonNull NetworkRequest request) {
3401 try {
3402 mService.declareNetworkRequestUnfulfillable(request);
3403 } catch (RemoteException e) {
3404 throw e.rethrowFromSystemServer();
3405 }
3406 }
3407
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003408 /**
3409 * @hide
3410 * Register a NetworkAgent with ConnectivityService.
3411 * @return Network corresponding to NetworkAgent.
3412 */
3413 @RequiresPermission(anyOf = {
3414 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
3415 android.Manifest.permission.NETWORK_FACTORY})
3416 public Network registerNetworkAgent(INetworkAgent na, NetworkInfo ni, LinkProperties lp,
Chalard Jeand6372722020-12-21 18:36:52 +09003417 NetworkCapabilities nc, @NonNull NetworkScore score, NetworkAgentConfig config,
3418 int providerId) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003419 try {
3420 return mService.registerNetworkAgent(na, ni, lp, nc, score, config, providerId);
3421 } catch (RemoteException e) {
3422 throw e.rethrowFromSystemServer();
3423 }
3424 }
3425
3426 /**
3427 * Base class for {@code NetworkRequest} callbacks. Used for notifications about network
3428 * changes. Should be extended by applications wanting notifications.
3429 *
3430 * A {@code NetworkCallback} is registered by calling
3431 * {@link #requestNetwork(NetworkRequest, NetworkCallback)},
3432 * {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)},
3433 * or {@link #registerDefaultNetworkCallback(NetworkCallback)}. A {@code NetworkCallback} is
3434 * unregistered by calling {@link #unregisterNetworkCallback(NetworkCallback)}.
3435 * A {@code NetworkCallback} should be registered at most once at any time.
3436 * A {@code NetworkCallback} that has been unregistered can be registered again.
3437 */
3438 public static class NetworkCallback {
3439 /**
Roshan Piuse08bc182020-12-22 15:10:42 -08003440 * No flags associated with this callback.
3441 * @hide
3442 */
3443 public static final int FLAG_NONE = 0;
3444 /**
3445 * Use this flag to include any location sensitive data in {@link NetworkCapabilities} sent
3446 * via {@link #onCapabilitiesChanged(Network, NetworkCapabilities)}.
3447 * <p>
3448 * These include:
3449 * <li> Some transport info instances (retrieved via
3450 * {@link NetworkCapabilities#getTransportInfo()}) like {@link android.net.wifi.WifiInfo}
3451 * contain location sensitive information.
3452 * <li> OwnerUid (retrieved via {@link NetworkCapabilities#getOwnerUid()} is location
3453 * sensitive for wifi suggestor apps (i.e using {@link WifiNetworkSuggestion}).</li>
3454 * </p>
3455 * <p>
3456 * Note:
3457 * <li> Retrieving this location sensitive information (subject to app's location
3458 * permissions) will be noted by system. </li>
3459 * <li> Without this flag any {@link NetworkCapabilities} provided via the callback does
3460 * not include location sensitive info.
3461 * </p>
3462 */
Roshan Pius189d0092021-03-11 21:16:44 -08003463 // Note: Some existing fields which are location sensitive may still be included without
3464 // this flag if the app targets SDK < S (to maintain backwards compatibility).
Roshan Piuse08bc182020-12-22 15:10:42 -08003465 public static final int FLAG_INCLUDE_LOCATION_INFO = 1 << 0;
3466
3467 /** @hide */
3468 @Retention(RetentionPolicy.SOURCE)
3469 @IntDef(flag = true, prefix = "FLAG_", value = {
3470 FLAG_NONE,
3471 FLAG_INCLUDE_LOCATION_INFO
3472 })
3473 public @interface Flag { }
3474
3475 /**
3476 * All the valid flags for error checking.
3477 */
3478 private static final int VALID_FLAGS = FLAG_INCLUDE_LOCATION_INFO;
3479
3480 public NetworkCallback() {
3481 this(FLAG_NONE);
3482 }
3483
3484 public NetworkCallback(@Flag int flags) {
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00003485 if ((flags & VALID_FLAGS) != flags) {
3486 throw new IllegalArgumentException("Invalid flags");
3487 }
Roshan Piuse08bc182020-12-22 15:10:42 -08003488 mFlags = flags;
3489 }
3490
3491 /**
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003492 * Called when the framework connects to a new network to evaluate whether it satisfies this
3493 * request. If evaluation succeeds, this callback may be followed by an {@link #onAvailable}
3494 * callback. There is no guarantee that this new network will satisfy any requests, or that
3495 * the network will stay connected for longer than the time necessary to evaluate it.
3496 * <p>
3497 * Most applications <b>should not</b> act on this callback, and should instead use
3498 * {@link #onAvailable}. This callback is intended for use by applications that can assist
3499 * the framework in properly evaluating the network &mdash; for example, an application that
3500 * can automatically log in to a captive portal without user intervention.
3501 *
3502 * @param network The {@link Network} of the network that is being evaluated.
3503 *
3504 * @hide
3505 */
3506 public void onPreCheck(@NonNull Network network) {}
3507
3508 /**
3509 * Called when the framework connects and has declared a new network ready for use.
3510 * This callback may be called more than once if the {@link Network} that is
3511 * satisfying the request changes.
3512 *
3513 * @param network The {@link Network} of the satisfying network.
3514 * @param networkCapabilities The {@link NetworkCapabilities} of the satisfying network.
3515 * @param linkProperties The {@link LinkProperties} of the satisfying network.
3516 * @param blocked Whether access to the {@link Network} is blocked due to system policy.
3517 * @hide
3518 */
Lorenzo Colitti8ad58122021-03-18 00:54:57 +09003519 public final void onAvailable(@NonNull Network network,
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003520 @NonNull NetworkCapabilities networkCapabilities,
Lorenzo Colitti8ad58122021-03-18 00:54:57 +09003521 @NonNull LinkProperties linkProperties, @BlockedReason int blocked) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003522 // Internally only this method is called when a new network is available, and
3523 // it calls the callback in the same way and order that older versions used
3524 // to call so as not to change the behavior.
Lorenzo Colitti8ad58122021-03-18 00:54:57 +09003525 onAvailable(network, networkCapabilities, linkProperties, blocked != 0);
3526 onBlockedStatusChanged(network, blocked);
3527 }
3528
3529 /**
3530 * Legacy variant of onAvailable that takes a boolean blocked reason.
3531 *
3532 * This method has never been public API, but it's not final, so there may be apps that
3533 * implemented it and rely on it being called. Do our best not to break them.
3534 * Note: such apps will also get a second call to onBlockedStatusChanged immediately after
3535 * this method is called. There does not seem to be a way to avoid this.
3536 * TODO: add a compat check to move apps off this method, and eventually stop calling it.
3537 *
3538 * @hide
3539 */
3540 public void onAvailable(@NonNull Network network,
3541 @NonNull NetworkCapabilities networkCapabilities,
3542 @NonNull LinkProperties linkProperties, boolean blocked) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003543 onAvailable(network);
3544 if (!networkCapabilities.hasCapability(
3545 NetworkCapabilities.NET_CAPABILITY_NOT_SUSPENDED)) {
3546 onNetworkSuspended(network);
3547 }
3548 onCapabilitiesChanged(network, networkCapabilities);
3549 onLinkPropertiesChanged(network, linkProperties);
Lorenzo Colitti8ad58122021-03-18 00:54:57 +09003550 // No call to onBlockedStatusChanged here. That is done by the caller.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003551 }
3552
3553 /**
3554 * Called when the framework connects and has declared a new network ready for use.
3555 *
3556 * <p>For callbacks registered with {@link #registerNetworkCallback}, multiple networks may
3557 * be available at the same time, and onAvailable will be called for each of these as they
3558 * appear.
3559 *
3560 * <p>For callbacks registered with {@link #requestNetwork} and
3561 * {@link #registerDefaultNetworkCallback}, this means the network passed as an argument
3562 * is the new best network for this request and is now tracked by this callback ; this
3563 * callback will no longer receive method calls about other networks that may have been
3564 * passed to this method previously. The previously-best network may have disconnected, or
3565 * it may still be around and the newly-best network may simply be better.
3566 *
3567 * <p>Starting with {@link android.os.Build.VERSION_CODES#O}, this will always immediately
3568 * be followed by a call to {@link #onCapabilitiesChanged(Network, NetworkCapabilities)}
3569 * then by a call to {@link #onLinkPropertiesChanged(Network, LinkProperties)}, and a call
3570 * to {@link #onBlockedStatusChanged(Network, boolean)}.
3571 *
3572 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
3573 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
3574 * this callback as this is prone to race conditions (there is no guarantee the objects
3575 * returned by these methods will be current). Instead, wait for a call to
3576 * {@link #onCapabilitiesChanged(Network, NetworkCapabilities)} and
3577 * {@link #onLinkPropertiesChanged(Network, LinkProperties)} whose arguments are guaranteed
3578 * to be well-ordered with respect to other callbacks.
3579 *
3580 * @param network The {@link Network} of the satisfying network.
3581 */
3582 public void onAvailable(@NonNull Network network) {}
3583
3584 /**
3585 * Called when the network is about to be lost, typically because there are no outstanding
3586 * requests left for it. This may be paired with a {@link NetworkCallback#onAvailable} call
3587 * with the new replacement network for graceful handover. This method is not guaranteed
3588 * to be called before {@link NetworkCallback#onLost} is called, for example in case a
3589 * network is suddenly disconnected.
3590 *
3591 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
3592 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
3593 * this callback as this is prone to race conditions ; calling these methods while in a
3594 * callback may return an outdated or even a null object.
3595 *
3596 * @param network The {@link Network} that is about to be lost.
3597 * @param maxMsToLive The time in milliseconds the system intends to keep the network
3598 * connected for graceful handover; note that the network may still
3599 * suffer a hard loss at any time.
3600 */
3601 public void onLosing(@NonNull Network network, int maxMsToLive) {}
3602
3603 /**
3604 * Called when a network disconnects or otherwise no longer satisfies this request or
3605 * callback.
3606 *
3607 * <p>If the callback was registered with requestNetwork() or
3608 * registerDefaultNetworkCallback(), it will only be invoked against the last network
3609 * returned by onAvailable() when that network is lost and no other network satisfies
3610 * the criteria of the request.
3611 *
3612 * <p>If the callback was registered with registerNetworkCallback() it will be called for
3613 * each network which no longer satisfies the criteria of the callback.
3614 *
3615 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
3616 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
3617 * this callback as this is prone to race conditions ; calling these methods while in a
3618 * callback may return an outdated or even a null object.
3619 *
3620 * @param network The {@link Network} lost.
3621 */
3622 public void onLost(@NonNull Network network) {}
3623
3624 /**
3625 * Called if no network is found within the timeout time specified in
3626 * {@link #requestNetwork(NetworkRequest, NetworkCallback, int)} call or if the
3627 * requested network request cannot be fulfilled (whether or not a timeout was
3628 * specified). When this callback is invoked the associated
3629 * {@link NetworkRequest} will have already been removed and released, as if
3630 * {@link #unregisterNetworkCallback(NetworkCallback)} had been called.
3631 */
3632 public void onUnavailable() {}
3633
3634 /**
3635 * Called when the network corresponding to this request changes capabilities but still
3636 * satisfies the requested criteria.
3637 *
3638 * <p>Starting with {@link android.os.Build.VERSION_CODES#O} this method is guaranteed
3639 * to be called immediately after {@link #onAvailable}.
3640 *
3641 * <p>Do NOT call {@link #getLinkProperties(Network)} or other synchronous
3642 * ConnectivityManager methods in this callback as this is prone to race conditions :
3643 * calling these methods while in a callback may return an outdated or even a null object.
3644 *
3645 * @param network The {@link Network} whose capabilities have changed.
Roshan Piuse08bc182020-12-22 15:10:42 -08003646 * @param networkCapabilities The new {@link NetworkCapabilities} for this
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003647 * network.
3648 */
3649 public void onCapabilitiesChanged(@NonNull Network network,
3650 @NonNull NetworkCapabilities networkCapabilities) {}
3651
3652 /**
3653 * Called when the network corresponding to this request changes {@link LinkProperties}.
3654 *
3655 * <p>Starting with {@link android.os.Build.VERSION_CODES#O} this method is guaranteed
3656 * to be called immediately after {@link #onAvailable}.
3657 *
3658 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or other synchronous
3659 * ConnectivityManager methods in this callback as this is prone to race conditions :
3660 * calling these methods while in a callback may return an outdated or even a null object.
3661 *
3662 * @param network The {@link Network} whose link properties have changed.
3663 * @param linkProperties The new {@link LinkProperties} for this network.
3664 */
3665 public void onLinkPropertiesChanged(@NonNull Network network,
3666 @NonNull LinkProperties linkProperties) {}
3667
3668 /**
3669 * Called when the network the framework connected to for this request suspends data
3670 * transmission temporarily.
3671 *
3672 * <p>This generally means that while the TCP connections are still live temporarily
3673 * network data fails to transfer. To give a specific example, this is used on cellular
3674 * networks to mask temporary outages when driving through a tunnel, etc. In general this
3675 * means read operations on sockets on this network will block once the buffers are
3676 * drained, and write operations will block once the buffers are full.
3677 *
3678 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
3679 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
3680 * this callback as this is prone to race conditions (there is no guarantee the objects
3681 * returned by these methods will be current).
3682 *
3683 * @hide
3684 */
3685 public void onNetworkSuspended(@NonNull Network network) {}
3686
3687 /**
3688 * Called when the network the framework connected to for this request
3689 * returns from a {@link NetworkInfo.State#SUSPENDED} state. This should always be
3690 * preceded by a matching {@link NetworkCallback#onNetworkSuspended} call.
3691
3692 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
3693 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
3694 * this callback as this is prone to race conditions : calling these methods while in a
3695 * callback may return an outdated or even a null object.
3696 *
3697 * @hide
3698 */
3699 public void onNetworkResumed(@NonNull Network network) {}
3700
3701 /**
3702 * Called when access to the specified network is blocked or unblocked.
3703 *
3704 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
3705 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
3706 * this callback as this is prone to race conditions : calling these methods while in a
3707 * callback may return an outdated or even a null object.
3708 *
3709 * @param network The {@link Network} whose blocked status has changed.
3710 * @param blocked The blocked status of this {@link Network}.
3711 */
3712 public void onBlockedStatusChanged(@NonNull Network network, boolean blocked) {}
3713
Lorenzo Colitti8ad58122021-03-18 00:54:57 +09003714 /**
Lorenzo Colittia1bd6f62021-03-25 23:17:36 +09003715 * Called when access to the specified network is blocked or unblocked, or the reason for
3716 * access being blocked changes.
Lorenzo Colitti8ad58122021-03-18 00:54:57 +09003717 *
3718 * If a NetworkCallback object implements this method,
3719 * {@link #onBlockedStatusChanged(Network, boolean)} will not be called.
3720 *
3721 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
3722 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
3723 * this callback as this is prone to race conditions : calling these methods while in a
3724 * callback may return an outdated or even a null object.
3725 *
3726 * @param network The {@link Network} whose blocked status has changed.
3727 * @param blocked The blocked status of this {@link Network}.
3728 * @hide
3729 */
3730 @SystemApi(client = MODULE_LIBRARIES)
3731 public void onBlockedStatusChanged(@NonNull Network network, @BlockedReason int blocked) {
3732 onBlockedStatusChanged(network, blocked != 0);
3733 }
3734
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003735 private NetworkRequest networkRequest;
Roshan Piuse08bc182020-12-22 15:10:42 -08003736 private final int mFlags;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003737 }
3738
3739 /**
3740 * Constant error codes used by ConnectivityService to communicate about failures and errors
3741 * across a Binder boundary.
3742 * @hide
3743 */
3744 public interface Errors {
3745 int TOO_MANY_REQUESTS = 1;
3746 }
3747
3748 /** @hide */
3749 public static class TooManyRequestsException extends RuntimeException {}
3750
3751 private static RuntimeException convertServiceException(ServiceSpecificException e) {
3752 switch (e.errorCode) {
3753 case Errors.TOO_MANY_REQUESTS:
3754 return new TooManyRequestsException();
3755 default:
3756 Log.w(TAG, "Unknown service error code " + e.errorCode);
3757 return new RuntimeException(e);
3758 }
3759 }
3760
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003761 /** @hide */
Remi NGUYEN VAN1b9f03a2021-03-12 15:24:06 +09003762 public static final int CALLBACK_PRECHECK = 1;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003763 /** @hide */
Remi NGUYEN VAN1b9f03a2021-03-12 15:24:06 +09003764 public static final int CALLBACK_AVAILABLE = 2;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003765 /** @hide arg1 = TTL */
Remi NGUYEN VAN1b9f03a2021-03-12 15:24:06 +09003766 public static final int CALLBACK_LOSING = 3;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003767 /** @hide */
Remi NGUYEN VAN1b9f03a2021-03-12 15:24:06 +09003768 public static final int CALLBACK_LOST = 4;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003769 /** @hide */
Remi NGUYEN VAN1b9f03a2021-03-12 15:24:06 +09003770 public static final int CALLBACK_UNAVAIL = 5;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003771 /** @hide */
Remi NGUYEN VAN1b9f03a2021-03-12 15:24:06 +09003772 public static final int CALLBACK_CAP_CHANGED = 6;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003773 /** @hide */
Remi NGUYEN VAN1b9f03a2021-03-12 15:24:06 +09003774 public static final int CALLBACK_IP_CHANGED = 7;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003775 /** @hide obj = NetworkCapabilities, arg1 = seq number */
Remi NGUYEN VAN1b9f03a2021-03-12 15:24:06 +09003776 private static final int EXPIRE_LEGACY_REQUEST = 8;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003777 /** @hide */
Remi NGUYEN VAN1b9f03a2021-03-12 15:24:06 +09003778 public static final int CALLBACK_SUSPENDED = 9;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003779 /** @hide */
Remi NGUYEN VAN1b9f03a2021-03-12 15:24:06 +09003780 public static final int CALLBACK_RESUMED = 10;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003781 /** @hide */
Remi NGUYEN VAN1b9f03a2021-03-12 15:24:06 +09003782 public static final int CALLBACK_BLK_CHANGED = 11;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003783
3784 /** @hide */
3785 public static String getCallbackName(int whichCallback) {
3786 switch (whichCallback) {
3787 case CALLBACK_PRECHECK: return "CALLBACK_PRECHECK";
3788 case CALLBACK_AVAILABLE: return "CALLBACK_AVAILABLE";
3789 case CALLBACK_LOSING: return "CALLBACK_LOSING";
3790 case CALLBACK_LOST: return "CALLBACK_LOST";
3791 case CALLBACK_UNAVAIL: return "CALLBACK_UNAVAIL";
3792 case CALLBACK_CAP_CHANGED: return "CALLBACK_CAP_CHANGED";
3793 case CALLBACK_IP_CHANGED: return "CALLBACK_IP_CHANGED";
3794 case EXPIRE_LEGACY_REQUEST: return "EXPIRE_LEGACY_REQUEST";
3795 case CALLBACK_SUSPENDED: return "CALLBACK_SUSPENDED";
3796 case CALLBACK_RESUMED: return "CALLBACK_RESUMED";
3797 case CALLBACK_BLK_CHANGED: return "CALLBACK_BLK_CHANGED";
3798 default:
3799 return Integer.toString(whichCallback);
3800 }
3801 }
3802
3803 private class CallbackHandler extends Handler {
3804 private static final String TAG = "ConnectivityManager.CallbackHandler";
3805 private static final boolean DBG = false;
3806
3807 CallbackHandler(Looper looper) {
3808 super(looper);
3809 }
3810
3811 CallbackHandler(Handler handler) {
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00003812 this(Objects.requireNonNull(handler, "Handler cannot be null.").getLooper());
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003813 }
3814
3815 @Override
3816 public void handleMessage(Message message) {
3817 if (message.what == EXPIRE_LEGACY_REQUEST) {
3818 expireRequest((NetworkCapabilities) message.obj, message.arg1);
3819 return;
3820 }
3821
3822 final NetworkRequest request = getObject(message, NetworkRequest.class);
3823 final Network network = getObject(message, Network.class);
3824 final NetworkCallback callback;
3825 synchronized (sCallbacks) {
3826 callback = sCallbacks.get(request);
3827 if (callback == null) {
3828 Log.w(TAG,
3829 "callback not found for " + getCallbackName(message.what) + " message");
3830 return;
3831 }
3832 if (message.what == CALLBACK_UNAVAIL) {
3833 sCallbacks.remove(request);
3834 callback.networkRequest = ALREADY_UNREGISTERED;
3835 }
3836 }
3837 if (DBG) {
3838 Log.d(TAG, getCallbackName(message.what) + " for network " + network);
3839 }
3840
3841 switch (message.what) {
3842 case CALLBACK_PRECHECK: {
3843 callback.onPreCheck(network);
3844 break;
3845 }
3846 case CALLBACK_AVAILABLE: {
3847 NetworkCapabilities cap = getObject(message, NetworkCapabilities.class);
3848 LinkProperties lp = getObject(message, LinkProperties.class);
Lorenzo Colitti8ad58122021-03-18 00:54:57 +09003849 callback.onAvailable(network, cap, lp, message.arg1);
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003850 break;
3851 }
3852 case CALLBACK_LOSING: {
3853 callback.onLosing(network, message.arg1);
3854 break;
3855 }
3856 case CALLBACK_LOST: {
3857 callback.onLost(network);
3858 break;
3859 }
3860 case CALLBACK_UNAVAIL: {
3861 callback.onUnavailable();
3862 break;
3863 }
3864 case CALLBACK_CAP_CHANGED: {
3865 NetworkCapabilities cap = getObject(message, NetworkCapabilities.class);
3866 callback.onCapabilitiesChanged(network, cap);
3867 break;
3868 }
3869 case CALLBACK_IP_CHANGED: {
3870 LinkProperties lp = getObject(message, LinkProperties.class);
3871 callback.onLinkPropertiesChanged(network, lp);
3872 break;
3873 }
3874 case CALLBACK_SUSPENDED: {
3875 callback.onNetworkSuspended(network);
3876 break;
3877 }
3878 case CALLBACK_RESUMED: {
3879 callback.onNetworkResumed(network);
3880 break;
3881 }
3882 case CALLBACK_BLK_CHANGED: {
Lorenzo Colitti8ad58122021-03-18 00:54:57 +09003883 callback.onBlockedStatusChanged(network, message.arg1);
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003884 }
3885 }
3886 }
3887
3888 private <T> T getObject(Message msg, Class<T> c) {
3889 return (T) msg.getData().getParcelable(c.getSimpleName());
3890 }
3891 }
3892
3893 private CallbackHandler getDefaultHandler() {
3894 synchronized (sCallbacks) {
3895 if (sCallbackHandler == null) {
3896 sCallbackHandler = new CallbackHandler(ConnectivityThread.getInstanceLooper());
3897 }
3898 return sCallbackHandler;
3899 }
3900 }
3901
3902 private static final HashMap<NetworkRequest, NetworkCallback> sCallbacks = new HashMap<>();
3903 private static CallbackHandler sCallbackHandler;
3904
Lorenzo Colitti5f26b192021-03-12 22:48:07 +09003905 private NetworkRequest sendRequestForNetwork(int asUid, NetworkCapabilities need,
3906 NetworkCallback callback, int timeoutMs, NetworkRequest.Type reqType, int legacyType,
3907 CallbackHandler handler) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003908 printStackTrace();
3909 checkCallbackNotNull(callback);
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00003910 if (reqType != TRACK_DEFAULT && reqType != TRACK_SYSTEM_DEFAULT && need == null) {
3911 throw new IllegalArgumentException("null NetworkCapabilities");
3912 }
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003913 final NetworkRequest request;
3914 final String callingPackageName = mContext.getOpPackageName();
3915 try {
3916 synchronized(sCallbacks) {
3917 if (callback.networkRequest != null
3918 && callback.networkRequest != ALREADY_UNREGISTERED) {
3919 // TODO: throw exception instead and enforce 1:1 mapping of callbacks
3920 // and requests (http://b/20701525).
3921 Log.e(TAG, "NetworkCallback was already registered");
3922 }
3923 Messenger messenger = new Messenger(handler);
3924 Binder binder = new Binder();
Roshan Piuse08bc182020-12-22 15:10:42 -08003925 final int callbackFlags = callback.mFlags;
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003926 if (reqType == LISTEN) {
3927 request = mService.listenForNetwork(
Roshan Piuse08bc182020-12-22 15:10:42 -08003928 need, messenger, binder, callbackFlags, callingPackageName,
Roshan Piusa8a477b2020-12-17 14:53:09 -08003929 getAttributionTag());
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003930 } else {
3931 request = mService.requestNetwork(
Lorenzo Colitti5f26b192021-03-12 22:48:07 +09003932 asUid, need, reqType.ordinal(), messenger, timeoutMs, binder,
3933 legacyType, callbackFlags, callingPackageName, getAttributionTag());
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003934 }
3935 if (request != null) {
3936 sCallbacks.put(request, callback);
3937 }
3938 callback.networkRequest = request;
3939 }
3940 } catch (RemoteException e) {
3941 throw e.rethrowFromSystemServer();
3942 } catch (ServiceSpecificException e) {
3943 throw convertServiceException(e);
3944 }
3945 return request;
3946 }
3947
Lorenzo Colitti5f26b192021-03-12 22:48:07 +09003948 private NetworkRequest sendRequestForNetwork(NetworkCapabilities need, NetworkCallback callback,
3949 int timeoutMs, NetworkRequest.Type reqType, int legacyType, CallbackHandler handler) {
3950 return sendRequestForNetwork(Process.INVALID_UID, need, callback, timeoutMs, reqType,
3951 legacyType, handler);
3952 }
3953
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003954 /**
3955 * Helper function to request a network with a particular legacy type.
3956 *
3957 * This API is only for use in internal system code that requests networks with legacy type and
3958 * relies on CONNECTIVITY_ACTION broadcasts instead of NetworkCallbacks. New caller should use
3959 * {@link #requestNetwork(NetworkRequest, NetworkCallback, Handler)} instead.
3960 *
3961 * @param request {@link NetworkRequest} describing this request.
3962 * @param timeoutMs The time in milliseconds to attempt looking for a suitable network
3963 * before {@link NetworkCallback#onUnavailable()} is called. The timeout must
3964 * be a positive value (i.e. >0).
3965 * @param legacyType to specify the network type(#TYPE_*).
3966 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
3967 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
3968 * the callback must not be shared - it uniquely specifies this request.
3969 *
3970 * @hide
3971 */
3972 @SystemApi
3973 @RequiresPermission(NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK)
3974 public void requestNetwork(@NonNull NetworkRequest request,
3975 int timeoutMs, int legacyType, @NonNull Handler handler,
3976 @NonNull NetworkCallback networkCallback) {
3977 if (legacyType == TYPE_NONE) {
3978 throw new IllegalArgumentException("TYPE_NONE is meaningless legacy type");
3979 }
3980 CallbackHandler cbHandler = new CallbackHandler(handler);
3981 NetworkCapabilities nc = request.networkCapabilities;
3982 sendRequestForNetwork(nc, networkCallback, timeoutMs, REQUEST, legacyType, cbHandler);
3983 }
3984
3985 /**
Roshan Piuse08bc182020-12-22 15:10:42 -08003986 * Request a network to satisfy a set of {@link NetworkCapabilities}.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09003987 *
3988 * <p>This method will attempt to find the best network that matches the passed
3989 * {@link NetworkRequest}, and to bring up one that does if none currently satisfies the
3990 * criteria. The platform will evaluate which network is the best at its own discretion.
3991 * Throughput, latency, cost per byte, policy, user preference and other considerations
3992 * may be factored in the decision of what is considered the best network.
3993 *
3994 * <p>As long as this request is outstanding, the platform will try to maintain the best network
3995 * matching this request, while always attempting to match the request to a better network if
3996 * possible. If a better match is found, the platform will switch this request to the now-best
3997 * network and inform the app of the newly best network by invoking
3998 * {@link NetworkCallback#onAvailable(Network)} on the provided callback. Note that the platform
3999 * will not try to maintain any other network than the best one currently matching the request:
4000 * a network not matching any network request may be disconnected at any time.
4001 *
4002 * <p>For example, an application could use this method to obtain a connected cellular network
4003 * even if the device currently has a data connection over Ethernet. This may cause the cellular
4004 * radio to consume additional power. Or, an application could inform the system that it wants
4005 * a network supporting sending MMSes and have the system let it know about the currently best
4006 * MMS-supporting network through the provided {@link NetworkCallback}.
4007 *
4008 * <p>The status of the request can be followed by listening to the various callbacks described
4009 * in {@link NetworkCallback}. The {@link Network} object passed to the callback methods can be
4010 * used to direct traffic to the network (although accessing some networks may be subject to
4011 * holding specific permissions). Callers will learn about the specific characteristics of the
4012 * network through
4013 * {@link NetworkCallback#onCapabilitiesChanged(Network, NetworkCapabilities)} and
4014 * {@link NetworkCallback#onLinkPropertiesChanged(Network, LinkProperties)}. The methods of the
4015 * provided {@link NetworkCallback} will only be invoked due to changes in the best network
4016 * matching the request at any given time; therefore when a better network matching the request
4017 * becomes available, the {@link NetworkCallback#onAvailable(Network)} method is called
4018 * with the new network after which no further updates are given about the previously-best
4019 * network, unless it becomes the best again at some later time. All callbacks are invoked
4020 * in order on the same thread, which by default is a thread created by the framework running
4021 * in the app.
4022 * {@see #requestNetwork(NetworkRequest, NetworkCallback, Handler)} to change where the
4023 * callbacks are invoked.
4024 *
4025 * <p>This{@link NetworkRequest} will live until released via
4026 * {@link #unregisterNetworkCallback(NetworkCallback)} or the calling application exits, at
4027 * which point the system may let go of the network at any time.
4028 *
4029 * <p>A version of this method which takes a timeout is
4030 * {@link #requestNetwork(NetworkRequest, NetworkCallback, int)}, that an app can use to only
4031 * wait for a limited amount of time for the network to become unavailable.
4032 *
4033 * <p>It is presently unsupported to request a network with mutable
4034 * {@link NetworkCapabilities} such as
4035 * {@link NetworkCapabilities#NET_CAPABILITY_VALIDATED} or
4036 * {@link NetworkCapabilities#NET_CAPABILITY_CAPTIVE_PORTAL}
4037 * as these {@code NetworkCapabilities} represent states that a particular
4038 * network may never attain, and whether a network will attain these states
4039 * is unknown prior to bringing up the network so the framework does not
4040 * know how to go about satisfying a request with these capabilities.
4041 *
4042 * <p>This method requires the caller to hold either the
4043 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
4044 * or the ability to modify system settings as determined by
4045 * {@link android.provider.Settings.System#canWrite}.</p>
4046 *
4047 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4048 * number of outstanding requests to 100 per app (identified by their UID), shared with
4049 * all variants of this method, of {@link #registerNetworkCallback} as well as
4050 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4051 * Requesting a network with this method will count toward this limit. If this limit is
4052 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4053 * make sure to unregister the callbacks with
4054 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4055 *
4056 * @param request {@link NetworkRequest} describing this request.
4057 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
4058 * the callback must not be shared - it uniquely specifies this request.
4059 * The callback is invoked on the default internal Handler.
4060 * @throws IllegalArgumentException if {@code request} contains invalid network capabilities.
4061 * @throws SecurityException if missing the appropriate permissions.
4062 * @throws RuntimeException if the app already has too many callbacks registered.
4063 */
4064 public void requestNetwork(@NonNull NetworkRequest request,
4065 @NonNull NetworkCallback networkCallback) {
4066 requestNetwork(request, networkCallback, getDefaultHandler());
4067 }
4068
4069 /**
Roshan Piuse08bc182020-12-22 15:10:42 -08004070 * Request a network to satisfy a set of {@link NetworkCapabilities}.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004071 *
4072 * This method behaves identically to {@link #requestNetwork(NetworkRequest, NetworkCallback)}
4073 * but runs all the callbacks on the passed Handler.
4074 *
4075 * <p>This method has the same permission requirements as
4076 * {@link #requestNetwork(NetworkRequest, NetworkCallback)}, is subject to the same limitations,
4077 * and throws the same exceptions in the same conditions.
4078 *
4079 * @param request {@link NetworkRequest} describing this request.
4080 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
4081 * the callback must not be shared - it uniquely specifies this request.
4082 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
4083 */
4084 public void requestNetwork(@NonNull NetworkRequest request,
4085 @NonNull NetworkCallback networkCallback, @NonNull Handler handler) {
4086 CallbackHandler cbHandler = new CallbackHandler(handler);
4087 NetworkCapabilities nc = request.networkCapabilities;
4088 sendRequestForNetwork(nc, networkCallback, 0, REQUEST, TYPE_NONE, cbHandler);
4089 }
4090
4091 /**
Roshan Piuse08bc182020-12-22 15:10:42 -08004092 * Request a network to satisfy a set of {@link NetworkCapabilities}, limited
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004093 * by a timeout.
4094 *
4095 * This function behaves identically to the non-timed-out version
4096 * {@link #requestNetwork(NetworkRequest, NetworkCallback)}, but if a suitable network
4097 * is not found within the given time (in milliseconds) the
4098 * {@link NetworkCallback#onUnavailable()} callback is called. The request can still be
4099 * released normally by calling {@link #unregisterNetworkCallback(NetworkCallback)} but does
4100 * not have to be released if timed-out (it is automatically released). Unregistering a
4101 * request that timed out is not an error.
4102 *
4103 * <p>Do not use this method to poll for the existence of specific networks (e.g. with a small
4104 * timeout) - {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)} is provided
4105 * for that purpose. Calling this method will attempt to bring up the requested network.
4106 *
4107 * <p>This method has the same permission requirements as
4108 * {@link #requestNetwork(NetworkRequest, NetworkCallback)}, is subject to the same limitations,
4109 * and throws the same exceptions in the same conditions.
4110 *
4111 * @param request {@link NetworkRequest} describing this request.
4112 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
4113 * the callback must not be shared - it uniquely specifies this request.
4114 * @param timeoutMs The time in milliseconds to attempt looking for a suitable network
4115 * before {@link NetworkCallback#onUnavailable()} is called. The timeout must
4116 * be a positive value (i.e. >0).
4117 */
4118 public void requestNetwork(@NonNull NetworkRequest request,
4119 @NonNull NetworkCallback networkCallback, int timeoutMs) {
4120 checkTimeout(timeoutMs);
4121 NetworkCapabilities nc = request.networkCapabilities;
4122 sendRequestForNetwork(nc, networkCallback, timeoutMs, REQUEST, TYPE_NONE,
4123 getDefaultHandler());
4124 }
4125
4126 /**
Roshan Piuse08bc182020-12-22 15:10:42 -08004127 * Request a network to satisfy a set of {@link NetworkCapabilities}, limited
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004128 * by a timeout.
4129 *
4130 * This method behaves identically to
4131 * {@link #requestNetwork(NetworkRequest, NetworkCallback, int)} but runs all the callbacks
4132 * on the passed Handler.
4133 *
4134 * <p>This method has the same permission requirements as
4135 * {@link #requestNetwork(NetworkRequest, NetworkCallback)}, is subject to the same limitations,
4136 * and throws the same exceptions in the same conditions.
4137 *
4138 * @param request {@link NetworkRequest} describing this request.
4139 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
4140 * the callback must not be shared - it uniquely specifies this request.
4141 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
4142 * @param timeoutMs The time in milliseconds to attempt looking for a suitable network
4143 * before {@link NetworkCallback#onUnavailable} is called.
4144 */
4145 public void requestNetwork(@NonNull NetworkRequest request,
4146 @NonNull NetworkCallback networkCallback, @NonNull Handler handler, int timeoutMs) {
4147 checkTimeout(timeoutMs);
4148 CallbackHandler cbHandler = new CallbackHandler(handler);
4149 NetworkCapabilities nc = request.networkCapabilities;
4150 sendRequestForNetwork(nc, networkCallback, timeoutMs, REQUEST, TYPE_NONE, cbHandler);
4151 }
4152
4153 /**
4154 * The lookup key for a {@link Network} object included with the intent after
4155 * successfully finding a network for the applications request. Retrieve it with
4156 * {@link android.content.Intent#getParcelableExtra(String)}.
4157 * <p>
4158 * Note that if you intend to invoke {@link Network#openConnection(java.net.URL)}
4159 * then you must get a ConnectivityManager instance before doing so.
4160 */
4161 public static final String EXTRA_NETWORK = "android.net.extra.NETWORK";
4162
4163 /**
4164 * The lookup key for a {@link NetworkRequest} object included with the intent after
4165 * successfully finding a network for the applications request. Retrieve it with
4166 * {@link android.content.Intent#getParcelableExtra(String)}.
4167 */
4168 public static final String EXTRA_NETWORK_REQUEST = "android.net.extra.NETWORK_REQUEST";
4169
4170
4171 /**
Roshan Piuse08bc182020-12-22 15:10:42 -08004172 * Request a network to satisfy a set of {@link NetworkCapabilities}.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004173 *
4174 * This function behaves identically to the version that takes a NetworkCallback, but instead
4175 * of {@link NetworkCallback} a {@link PendingIntent} is used. This means
4176 * the request may outlive the calling application and get called back when a suitable
4177 * network is found.
4178 * <p>
4179 * The operation is an Intent broadcast that goes to a broadcast receiver that
4180 * you registered with {@link Context#registerReceiver} or through the
4181 * &lt;receiver&gt; tag in an AndroidManifest.xml file
4182 * <p>
4183 * The operation Intent is delivered with two extras, a {@link Network} typed
4184 * extra called {@link #EXTRA_NETWORK} and a {@link NetworkRequest}
4185 * typed extra called {@link #EXTRA_NETWORK_REQUEST} containing
4186 * the original requests parameters. It is important to create a new,
4187 * {@link NetworkCallback} based request before completing the processing of the
4188 * Intent to reserve the network or it will be released shortly after the Intent
4189 * is processed.
4190 * <p>
4191 * If there is already a request for this Intent registered (with the equality of
4192 * two Intents defined by {@link Intent#filterEquals}), then it will be removed and
4193 * replaced by this one, effectively releasing the previous {@link NetworkRequest}.
4194 * <p>
4195 * The request may be released normally by calling
4196 * {@link #releaseNetworkRequest(android.app.PendingIntent)}.
4197 * <p>It is presently unsupported to request a network with either
4198 * {@link NetworkCapabilities#NET_CAPABILITY_VALIDATED} or
4199 * {@link NetworkCapabilities#NET_CAPABILITY_CAPTIVE_PORTAL}
4200 * as these {@code NetworkCapabilities} represent states that a particular
4201 * network may never attain, and whether a network will attain these states
4202 * is unknown prior to bringing up the network so the framework does not
4203 * know how to go about satisfying a request with these capabilities.
4204 *
4205 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4206 * number of outstanding requests to 100 per app (identified by their UID), shared with
4207 * all variants of this method, of {@link #registerNetworkCallback} as well as
4208 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4209 * Requesting a network with this method will count toward this limit. If this limit is
4210 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4211 * make sure to unregister the callbacks with {@link #unregisterNetworkCallback(PendingIntent)}
4212 * or {@link #releaseNetworkRequest(PendingIntent)}.
4213 *
4214 * <p>This method requires the caller to hold either the
4215 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
4216 * or the ability to modify system settings as determined by
4217 * {@link android.provider.Settings.System#canWrite}.</p>
4218 *
4219 * @param request {@link NetworkRequest} describing this request.
4220 * @param operation Action to perform when the network is available (corresponds
4221 * to the {@link NetworkCallback#onAvailable} call. Typically
4222 * comes from {@link PendingIntent#getBroadcast}. Cannot be null.
4223 * @throws IllegalArgumentException if {@code request} contains invalid network capabilities.
4224 * @throws SecurityException if missing the appropriate permissions.
4225 * @throws RuntimeException if the app already has too many callbacks registered.
4226 */
4227 public void requestNetwork(@NonNull NetworkRequest request,
4228 @NonNull PendingIntent operation) {
4229 printStackTrace();
4230 checkPendingIntentNotNull(operation);
4231 try {
4232 mService.pendingRequestForNetwork(
4233 request.networkCapabilities, operation, mContext.getOpPackageName(),
4234 getAttributionTag());
4235 } catch (RemoteException e) {
4236 throw e.rethrowFromSystemServer();
4237 } catch (ServiceSpecificException e) {
4238 throw convertServiceException(e);
4239 }
4240 }
4241
4242 /**
4243 * Removes a request made via {@link #requestNetwork(NetworkRequest, android.app.PendingIntent)}
4244 * <p>
4245 * This method has the same behavior as
4246 * {@link #unregisterNetworkCallback(android.app.PendingIntent)} with respect to
4247 * releasing network resources and disconnecting.
4248 *
4249 * @param operation A PendingIntent equal (as defined by {@link Intent#filterEquals}) to the
4250 * PendingIntent passed to
4251 * {@link #requestNetwork(NetworkRequest, android.app.PendingIntent)} with the
4252 * corresponding NetworkRequest you'd like to remove. Cannot be null.
4253 */
4254 public void releaseNetworkRequest(@NonNull PendingIntent operation) {
4255 printStackTrace();
4256 checkPendingIntentNotNull(operation);
4257 try {
4258 mService.releasePendingNetworkRequest(operation);
4259 } catch (RemoteException e) {
4260 throw e.rethrowFromSystemServer();
4261 }
4262 }
4263
4264 private static void checkPendingIntentNotNull(PendingIntent intent) {
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00004265 Objects.requireNonNull(intent, "PendingIntent cannot be null.");
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004266 }
4267
4268 private static void checkCallbackNotNull(NetworkCallback callback) {
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00004269 Objects.requireNonNull(callback, "null NetworkCallback");
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004270 }
4271
4272 private static void checkTimeout(int timeoutMs) {
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00004273 if (timeoutMs <= 0) {
4274 throw new IllegalArgumentException("timeoutMs must be strictly positive.");
4275 }
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004276 }
4277
4278 /**
4279 * Registers to receive notifications about all networks which satisfy the given
4280 * {@link NetworkRequest}. The callbacks will continue to be called until
4281 * either the application exits or {@link #unregisterNetworkCallback(NetworkCallback)} is
4282 * called.
4283 *
4284 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4285 * number of outstanding requests to 100 per app (identified by their UID), shared with
4286 * all variants of this method, of {@link #requestNetwork} as well as
4287 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4288 * Requesting a network with this method will count toward this limit. If this limit is
4289 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4290 * make sure to unregister the callbacks with
4291 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4292 *
4293 * @param request {@link NetworkRequest} describing this request.
4294 * @param networkCallback The {@link NetworkCallback} that the system will call as suitable
4295 * networks change state.
4296 * The callback is invoked on the default internal Handler.
4297 * @throws RuntimeException if the app already has too many callbacks registered.
4298 */
4299 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
4300 public void registerNetworkCallback(@NonNull NetworkRequest request,
4301 @NonNull NetworkCallback networkCallback) {
4302 registerNetworkCallback(request, networkCallback, getDefaultHandler());
4303 }
4304
4305 /**
4306 * Registers to receive notifications about all networks which satisfy the given
4307 * {@link NetworkRequest}. The callbacks will continue to be called until
4308 * either the application exits or {@link #unregisterNetworkCallback(NetworkCallback)} is
4309 * called.
4310 *
4311 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4312 * number of outstanding requests to 100 per app (identified by their UID), shared with
4313 * all variants of this method, of {@link #requestNetwork} as well as
4314 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4315 * Requesting a network with this method will count toward this limit. If this limit is
4316 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4317 * make sure to unregister the callbacks with
4318 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4319 *
4320 *
4321 * @param request {@link NetworkRequest} describing this request.
4322 * @param networkCallback The {@link NetworkCallback} that the system will call as suitable
4323 * networks change state.
4324 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
4325 * @throws RuntimeException if the app already has too many callbacks registered.
4326 */
4327 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
4328 public void registerNetworkCallback(@NonNull NetworkRequest request,
4329 @NonNull NetworkCallback networkCallback, @NonNull Handler handler) {
4330 CallbackHandler cbHandler = new CallbackHandler(handler);
4331 NetworkCapabilities nc = request.networkCapabilities;
4332 sendRequestForNetwork(nc, networkCallback, 0, LISTEN, TYPE_NONE, cbHandler);
4333 }
4334
4335 /**
4336 * Registers a PendingIntent to be sent when a network is available which satisfies the given
4337 * {@link NetworkRequest}.
4338 *
4339 * This function behaves identically to the version that takes a NetworkCallback, but instead
4340 * of {@link NetworkCallback} a {@link PendingIntent} is used. This means
4341 * the request may outlive the calling application and get called back when a suitable
4342 * network is found.
4343 * <p>
4344 * The operation is an Intent broadcast that goes to a broadcast receiver that
4345 * you registered with {@link Context#registerReceiver} or through the
4346 * &lt;receiver&gt; tag in an AndroidManifest.xml file
4347 * <p>
4348 * The operation Intent is delivered with two extras, a {@link Network} typed
4349 * extra called {@link #EXTRA_NETWORK} and a {@link NetworkRequest}
4350 * typed extra called {@link #EXTRA_NETWORK_REQUEST} containing
4351 * the original requests parameters.
4352 * <p>
4353 * If there is already a request for this Intent registered (with the equality of
4354 * two Intents defined by {@link Intent#filterEquals}), then it will be removed and
4355 * replaced by this one, effectively releasing the previous {@link NetworkRequest}.
4356 * <p>
4357 * The request may be released normally by calling
4358 * {@link #unregisterNetworkCallback(android.app.PendingIntent)}.
4359 *
4360 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4361 * number of outstanding requests to 100 per app (identified by their UID), shared with
4362 * all variants of this method, of {@link #requestNetwork} as well as
4363 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4364 * Requesting a network with this method will count toward this limit. If this limit is
4365 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4366 * make sure to unregister the callbacks with {@link #unregisterNetworkCallback(PendingIntent)}
4367 * or {@link #releaseNetworkRequest(PendingIntent)}.
4368 *
4369 * @param request {@link NetworkRequest} describing this request.
4370 * @param operation Action to perform when the network is available (corresponds
4371 * to the {@link NetworkCallback#onAvailable} call. Typically
4372 * comes from {@link PendingIntent#getBroadcast}. Cannot be null.
4373 * @throws RuntimeException if the app already has too many callbacks registered.
4374 */
4375 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
4376 public void registerNetworkCallback(@NonNull NetworkRequest request,
4377 @NonNull PendingIntent operation) {
4378 printStackTrace();
4379 checkPendingIntentNotNull(operation);
4380 try {
4381 mService.pendingListenForNetwork(
Roshan Piusa8a477b2020-12-17 14:53:09 -08004382 request.networkCapabilities, operation, mContext.getOpPackageName(),
4383 getAttributionTag());
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004384 } catch (RemoteException e) {
4385 throw e.rethrowFromSystemServer();
4386 } catch (ServiceSpecificException e) {
4387 throw convertServiceException(e);
4388 }
4389 }
4390
4391 /**
Lorenzo Colittia77d05e2021-01-29 20:14:04 +09004392 * Registers to receive notifications about changes in the application's default network. This
4393 * may be a physical network or a virtual network, such as a VPN that applies to the
4394 * application. The callbacks will continue to be called until either the application exits or
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004395 * {@link #unregisterNetworkCallback(NetworkCallback)} is called.
4396 *
4397 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4398 * number of outstanding requests to 100 per app (identified by their UID), shared with
4399 * all variants of this method, of {@link #requestNetwork} as well as
4400 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4401 * Requesting a network with this method will count toward this limit. If this limit is
4402 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4403 * make sure to unregister the callbacks with
4404 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4405 *
4406 * @param networkCallback The {@link NetworkCallback} that the system will call as the
Lorenzo Colittia77d05e2021-01-29 20:14:04 +09004407 * application's default network changes.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004408 * The callback is invoked on the default internal Handler.
4409 * @throws RuntimeException if the app already has too many callbacks registered.
4410 */
4411 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
4412 public void registerDefaultNetworkCallback(@NonNull NetworkCallback networkCallback) {
4413 registerDefaultNetworkCallback(networkCallback, getDefaultHandler());
4414 }
4415
4416 /**
Lorenzo Colittia77d05e2021-01-29 20:14:04 +09004417 * Registers to receive notifications about changes in the application's default network. This
4418 * may be a physical network or a virtual network, such as a VPN that applies to the
4419 * application. The callbacks will continue to be called until either the application exits or
4420 * {@link #unregisterNetworkCallback(NetworkCallback)} is called.
4421 *
4422 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4423 * number of outstanding requests to 100 per app (identified by their UID), shared with
4424 * all variants of this method, of {@link #requestNetwork} as well as
4425 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4426 * Requesting a network with this method will count toward this limit. If this limit is
4427 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4428 * make sure to unregister the callbacks with
4429 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4430 *
4431 * @param networkCallback The {@link NetworkCallback} that the system will call as the
4432 * application's default network changes.
4433 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
4434 * @throws RuntimeException if the app already has too many callbacks registered.
4435 */
4436 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
4437 public void registerDefaultNetworkCallback(@NonNull NetworkCallback networkCallback,
4438 @NonNull Handler handler) {
Chiachang Wangc7d203d2021-04-20 15:41:24 +08004439 registerDefaultNetworkCallbackForUid(Process.INVALID_UID, networkCallback, handler);
Lorenzo Colitti5f26b192021-03-12 22:48:07 +09004440 }
4441
4442 /**
4443 * Registers to receive notifications about changes in the default network for the specified
4444 * UID. This may be a physical network or a virtual network, such as a VPN that applies to the
4445 * UID. The callbacks will continue to be called until either the application exits or
4446 * {@link #unregisterNetworkCallback(NetworkCallback)} is called.
4447 *
4448 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4449 * number of outstanding requests to 100 per app (identified by their UID), shared with
4450 * all variants of this method, of {@link #requestNetwork} as well as
4451 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4452 * Requesting a network with this method will count toward this limit. If this limit is
4453 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4454 * make sure to unregister the callbacks with
4455 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4456 *
4457 * @param uid the UID for which to track default network changes.
4458 * @param networkCallback The {@link NetworkCallback} that the system will call as the
4459 * UID's default network changes.
4460 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
4461 * @throws RuntimeException if the app already has too many callbacks registered.
4462 * @hide
4463 */
Lorenzo Colittib90bdbd2021-03-22 18:23:21 +09004464 @SystemApi(client = MODULE_LIBRARIES)
Lorenzo Colitti5f26b192021-03-12 22:48:07 +09004465 @SuppressLint({"ExecutorRegistration", "PairedRegistration"})
4466 @RequiresPermission(anyOf = {
4467 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
4468 android.Manifest.permission.NETWORK_SETTINGS})
Chiachang Wangc7d203d2021-04-20 15:41:24 +08004469 public void registerDefaultNetworkCallbackForUid(int uid,
Lorenzo Colitti5f26b192021-03-12 22:48:07 +09004470 @NonNull NetworkCallback networkCallback, @NonNull Handler handler) {
Lorenzo Colittia77d05e2021-01-29 20:14:04 +09004471 CallbackHandler cbHandler = new CallbackHandler(handler);
Lorenzo Colitti5f26b192021-03-12 22:48:07 +09004472 sendRequestForNetwork(uid, null /* need */, networkCallback, 0 /* timeoutMs */,
Lorenzo Colittia77d05e2021-01-29 20:14:04 +09004473 TRACK_DEFAULT, TYPE_NONE, cbHandler);
4474 }
4475
4476 /**
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004477 * Registers to receive notifications about changes in the system default network. The callbacks
4478 * will continue to be called until either the application exits or
4479 * {@link #unregisterNetworkCallback(NetworkCallback)} is called.
4480 *
Lorenzo Colittia77d05e2021-01-29 20:14:04 +09004481 * This method should not be used to determine networking state seen by applications, because in
4482 * many cases, most or even all application traffic may not use the default network directly,
4483 * and traffic from different applications may go on different networks by default. As an
4484 * example, if a VPN is connected, traffic from all applications might be sent through the VPN
4485 * and not onto the system default network. Applications or system components desiring to do
4486 * determine network state as seen by applications should use other methods such as
4487 * {@link #registerDefaultNetworkCallback(NetworkCallback, Handler)}.
4488 *
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004489 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4490 * number of outstanding requests to 100 per app (identified by their UID), shared with
4491 * all variants of this method, of {@link #requestNetwork} as well as
4492 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4493 * Requesting a network with this method will count toward this limit. If this limit is
4494 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4495 * make sure to unregister the callbacks with
4496 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4497 *
4498 * @param networkCallback The {@link NetworkCallback} that the system will call as the
4499 * system default network changes.
4500 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
4501 * @throws RuntimeException if the app already has too many callbacks registered.
Lorenzo Colittia77d05e2021-01-29 20:14:04 +09004502 *
4503 * @hide
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004504 */
Lorenzo Colittia77d05e2021-01-29 20:14:04 +09004505 @SystemApi(client = MODULE_LIBRARIES)
4506 @SuppressLint({"ExecutorRegistration", "PairedRegistration"})
4507 @RequiresPermission(anyOf = {
4508 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
4509 android.Manifest.permission.NETWORK_SETTINGS})
4510 public void registerSystemDefaultNetworkCallback(@NonNull NetworkCallback networkCallback,
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004511 @NonNull Handler handler) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004512 CallbackHandler cbHandler = new CallbackHandler(handler);
4513 sendRequestForNetwork(null /* NetworkCapabilities need */, networkCallback, 0,
Lorenzo Colittia77d05e2021-01-29 20:14:04 +09004514 TRACK_SYSTEM_DEFAULT, TYPE_NONE, cbHandler);
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004515 }
4516
4517 /**
junyulaibd123062021-03-15 11:48:48 +08004518 * Registers to receive notifications about the best matching network which satisfy the given
4519 * {@link NetworkRequest}. The callbacks will continue to be called until
4520 * either the application exits or {@link #unregisterNetworkCallback(NetworkCallback)} is
4521 * called.
4522 *
4523 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4524 * number of outstanding requests to 100 per app (identified by their UID), shared with
4525 * {@link #registerNetworkCallback} and its variants and {@link #requestNetwork} as well as
4526 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4527 * Requesting a network with this method will count toward this limit. If this limit is
4528 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4529 * make sure to unregister the callbacks with
4530 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4531 *
4532 *
4533 * @param request {@link NetworkRequest} describing this request.
4534 * @param networkCallback The {@link NetworkCallback} that the system will call as suitable
4535 * networks change state.
4536 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
4537 * @throws RuntimeException if the app already has too many callbacks registered.
junyulai5a5c99b2021-03-05 15:51:17 +08004538 */
junyulai5a5c99b2021-03-05 15:51:17 +08004539 @SuppressLint("ExecutorRegistration")
4540 public void registerBestMatchingNetworkCallback(@NonNull NetworkRequest request,
4541 @NonNull NetworkCallback networkCallback, @NonNull Handler handler) {
4542 final NetworkCapabilities nc = request.networkCapabilities;
4543 final CallbackHandler cbHandler = new CallbackHandler(handler);
junyulai7664f622021-03-12 20:05:08 +08004544 sendRequestForNetwork(nc, networkCallback, 0, LISTEN_FOR_BEST, TYPE_NONE, cbHandler);
junyulai5a5c99b2021-03-05 15:51:17 +08004545 }
4546
4547 /**
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004548 * Requests bandwidth update for a given {@link Network} and returns whether the update request
4549 * is accepted by ConnectivityService. Once accepted, ConnectivityService will poll underlying
4550 * network connection for updated bandwidth information. The caller will be notified via
4551 * {@link ConnectivityManager.NetworkCallback} if there is an update. Notice that this
4552 * method assumes that the caller has previously called
4553 * {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)} to listen for network
4554 * changes.
4555 *
4556 * @param network {@link Network} specifying which network you're interested.
4557 * @return {@code true} on success, {@code false} if the {@link Network} is no longer valid.
4558 */
4559 public boolean requestBandwidthUpdate(@NonNull Network network) {
4560 try {
4561 return mService.requestBandwidthUpdate(network);
4562 } catch (RemoteException e) {
4563 throw e.rethrowFromSystemServer();
4564 }
4565 }
4566
4567 /**
4568 * Unregisters a {@code NetworkCallback} and possibly releases networks originating from
4569 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} and
4570 * {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)} calls.
4571 * If the given {@code NetworkCallback} had previously been used with
4572 * {@code #requestNetwork}, any networks that had been connected to only to satisfy that request
4573 * will be disconnected.
4574 *
4575 * Notifications that would have triggered that {@code NetworkCallback} will immediately stop
4576 * triggering it as soon as this call returns.
4577 *
4578 * @param networkCallback The {@link NetworkCallback} used when making the request.
4579 */
4580 public void unregisterNetworkCallback(@NonNull NetworkCallback networkCallback) {
4581 printStackTrace();
4582 checkCallbackNotNull(networkCallback);
4583 final List<NetworkRequest> reqs = new ArrayList<>();
4584 // Find all requests associated to this callback and stop callback triggers immediately.
4585 // Callback is reusable immediately. http://b/20701525, http://b/35921499.
4586 synchronized (sCallbacks) {
Remi NGUYEN VAN1818dbb2021-03-15 07:31:54 +00004587 if (networkCallback.networkRequest == null) {
4588 throw new IllegalArgumentException("NetworkCallback was not registered");
4589 }
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004590 if (networkCallback.networkRequest == ALREADY_UNREGISTERED) {
4591 Log.d(TAG, "NetworkCallback was already unregistered");
4592 return;
4593 }
4594 for (Map.Entry<NetworkRequest, NetworkCallback> e : sCallbacks.entrySet()) {
4595 if (e.getValue() == networkCallback) {
4596 reqs.add(e.getKey());
4597 }
4598 }
4599 // TODO: throw exception if callback was registered more than once (http://b/20701525).
4600 for (NetworkRequest r : reqs) {
4601 try {
4602 mService.releaseNetworkRequest(r);
4603 } catch (RemoteException e) {
4604 throw e.rethrowFromSystemServer();
4605 }
4606 // Only remove mapping if rpc was successful.
4607 sCallbacks.remove(r);
4608 }
4609 networkCallback.networkRequest = ALREADY_UNREGISTERED;
4610 }
4611 }
4612
4613 /**
4614 * Unregisters a callback previously registered via
4615 * {@link #registerNetworkCallback(NetworkRequest, android.app.PendingIntent)}.
4616 *
4617 * @param operation A PendingIntent equal (as defined by {@link Intent#filterEquals}) to the
4618 * PendingIntent passed to
4619 * {@link #registerNetworkCallback(NetworkRequest, android.app.PendingIntent)}.
4620 * Cannot be null.
4621 */
4622 public void unregisterNetworkCallback(@NonNull PendingIntent operation) {
4623 releaseNetworkRequest(operation);
4624 }
4625
4626 /**
4627 * Informs the system whether it should switch to {@code network} regardless of whether it is
4628 * validated or not. If {@code accept} is true, and the network was explicitly selected by the
4629 * user (e.g., by selecting a Wi-Fi network in the Settings app), then the network will become
4630 * the system default network regardless of any other network that's currently connected. If
4631 * {@code always} is true, then the choice is remembered, so that the next time the user
4632 * connects to this network, the system will switch to it.
4633 *
4634 * @param network The network to accept.
4635 * @param accept Whether to accept the network even if unvalidated.
4636 * @param always Whether to remember this choice in the future.
4637 *
4638 * @hide
4639 */
Chiachang Wangf9294e72021-03-18 09:44:34 +08004640 @SystemApi(client = MODULE_LIBRARIES)
4641 @RequiresPermission(anyOf = {
4642 android.Manifest.permission.NETWORK_SETTINGS,
4643 android.Manifest.permission.NETWORK_SETUP_WIZARD,
4644 android.Manifest.permission.NETWORK_STACK,
4645 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK})
4646 public void setAcceptUnvalidated(@NonNull Network network, boolean accept, boolean always) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004647 try {
4648 mService.setAcceptUnvalidated(network, accept, always);
4649 } catch (RemoteException e) {
4650 throw e.rethrowFromSystemServer();
4651 }
4652 }
4653
4654 /**
4655 * Informs the system whether it should consider the network as validated even if it only has
4656 * partial connectivity. If {@code accept} is true, then the network will be considered as
4657 * validated even if connectivity is only partial. If {@code always} is true, then the choice
4658 * is remembered, so that the next time the user connects to this network, the system will
4659 * switch to it.
4660 *
4661 * @param network The network to accept.
4662 * @param accept Whether to consider the network as validated even if it has partial
4663 * connectivity.
4664 * @param always Whether to remember this choice in the future.
4665 *
4666 * @hide
4667 */
Chiachang Wangf9294e72021-03-18 09:44:34 +08004668 @SystemApi(client = MODULE_LIBRARIES)
4669 @RequiresPermission(anyOf = {
4670 android.Manifest.permission.NETWORK_SETTINGS,
4671 android.Manifest.permission.NETWORK_SETUP_WIZARD,
4672 android.Manifest.permission.NETWORK_STACK,
4673 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK})
4674 public void setAcceptPartialConnectivity(@NonNull Network network, boolean accept,
4675 boolean always) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004676 try {
4677 mService.setAcceptPartialConnectivity(network, accept, always);
4678 } catch (RemoteException e) {
4679 throw e.rethrowFromSystemServer();
4680 }
4681 }
4682
4683 /**
4684 * Informs the system to penalize {@code network}'s score when it becomes unvalidated. This is
4685 * only meaningful if the system is configured not to penalize such networks, e.g., if the
4686 * {@code config_networkAvoidBadWifi} configuration variable is set to 0 and the {@code
4687 * NETWORK_AVOID_BAD_WIFI setting is unset}.
4688 *
4689 * @param network The network to accept.
4690 *
4691 * @hide
4692 */
Chiachang Wangf9294e72021-03-18 09:44:34 +08004693 @SystemApi(client = MODULE_LIBRARIES)
4694 @RequiresPermission(anyOf = {
4695 android.Manifest.permission.NETWORK_SETTINGS,
4696 android.Manifest.permission.NETWORK_SETUP_WIZARD,
4697 android.Manifest.permission.NETWORK_STACK,
4698 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK})
4699 public void setAvoidUnvalidated(@NonNull Network network) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004700 try {
4701 mService.setAvoidUnvalidated(network);
4702 } catch (RemoteException e) {
4703 throw e.rethrowFromSystemServer();
4704 }
4705 }
4706
4707 /**
4708 * Requests that the system open the captive portal app on the specified network.
4709 *
Remi NGUYEN VAN8238a762021-03-16 18:06:06 +09004710 * <p>This is to be used on networks where a captive portal was detected, as per
4711 * {@link NetworkCapabilities#NET_CAPABILITY_CAPTIVE_PORTAL}.
4712 *
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004713 * @param network The network to log into.
4714 *
4715 * @hide
4716 */
Remi NGUYEN VAN8238a762021-03-16 18:06:06 +09004717 @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
4718 @RequiresPermission(anyOf = {
4719 android.Manifest.permission.NETWORK_SETTINGS,
4720 android.Manifest.permission.NETWORK_STACK,
4721 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK
4722 })
4723 public void startCaptivePortalApp(@NonNull Network network) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004724 try {
4725 mService.startCaptivePortalApp(network);
4726 } catch (RemoteException e) {
4727 throw e.rethrowFromSystemServer();
4728 }
4729 }
4730
4731 /**
4732 * Requests that the system open the captive portal app with the specified extras.
4733 *
4734 * <p>This endpoint is exclusively for use by the NetworkStack and is protected by the
4735 * corresponding permission.
4736 * @param network Network on which the captive portal was detected.
4737 * @param appExtras Extras to include in the app start intent.
4738 * @hide
4739 */
4740 @SystemApi
4741 @RequiresPermission(NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK)
4742 public void startCaptivePortalApp(@NonNull Network network, @NonNull Bundle appExtras) {
4743 try {
4744 mService.startCaptivePortalAppInternal(network, appExtras);
4745 } catch (RemoteException e) {
4746 throw e.rethrowFromSystemServer();
4747 }
4748 }
4749
4750 /**
4751 * Determine whether the device is configured to avoid bad wifi.
4752 * @hide
4753 */
4754 @SystemApi
4755 @RequiresPermission(anyOf = {
4756 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
4757 android.Manifest.permission.NETWORK_STACK})
4758 public boolean shouldAvoidBadWifi() {
4759 try {
4760 return mService.shouldAvoidBadWifi();
4761 } catch (RemoteException e) {
4762 throw e.rethrowFromSystemServer();
4763 }
4764 }
4765
4766 /**
4767 * It is acceptable to briefly use multipath data to provide seamless connectivity for
4768 * time-sensitive user-facing operations when the system default network is temporarily
4769 * unresponsive. The amount of data should be limited (less than one megabyte for every call to
4770 * this method), and the operation should be infrequent to ensure that data usage is limited.
4771 *
4772 * An example of such an operation might be a time-sensitive foreground activity, such as a
4773 * voice command, that the user is performing while walking out of range of a Wi-Fi network.
4774 */
4775 public static final int MULTIPATH_PREFERENCE_HANDOVER = 1 << 0;
4776
4777 /**
4778 * It is acceptable to use small amounts of multipath data on an ongoing basis to provide
4779 * a backup channel for traffic that is primarily going over another network.
4780 *
4781 * An example might be maintaining backup connections to peers or servers for the purpose of
4782 * fast fallback if the default network is temporarily unresponsive or disconnects. The traffic
4783 * on backup paths should be negligible compared to the traffic on the main path.
4784 */
4785 public static final int MULTIPATH_PREFERENCE_RELIABILITY = 1 << 1;
4786
4787 /**
4788 * It is acceptable to use metered data to improve network latency and performance.
4789 */
4790 public static final int MULTIPATH_PREFERENCE_PERFORMANCE = 1 << 2;
4791
4792 /**
4793 * Return value to use for unmetered networks. On such networks we currently set all the flags
4794 * to true.
4795 * @hide
4796 */
4797 public static final int MULTIPATH_PREFERENCE_UNMETERED =
4798 MULTIPATH_PREFERENCE_HANDOVER |
4799 MULTIPATH_PREFERENCE_RELIABILITY |
4800 MULTIPATH_PREFERENCE_PERFORMANCE;
4801
4802 /** @hide */
4803 @Retention(RetentionPolicy.SOURCE)
4804 @IntDef(flag = true, value = {
4805 MULTIPATH_PREFERENCE_HANDOVER,
4806 MULTIPATH_PREFERENCE_RELIABILITY,
4807 MULTIPATH_PREFERENCE_PERFORMANCE,
4808 })
4809 public @interface MultipathPreference {
4810 }
4811
4812 /**
4813 * Provides a hint to the calling application on whether it is desirable to use the
4814 * multinetwork APIs (e.g., {@link Network#openConnection}, {@link Network#bindSocket}, etc.)
4815 * for multipath data transfer on this network when it is not the system default network.
4816 * Applications desiring to use multipath network protocols should call this method before
4817 * each such operation.
4818 *
4819 * @param network The network on which the application desires to use multipath data.
4820 * If {@code null}, this method will return the a preference that will generally
4821 * apply to metered networks.
4822 * @return a bitwise OR of zero or more of the {@code MULTIPATH_PREFERENCE_*} constants.
4823 */
4824 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
4825 public @MultipathPreference int getMultipathPreference(@Nullable Network network) {
4826 try {
4827 return mService.getMultipathPreference(network);
4828 } catch (RemoteException e) {
4829 throw e.rethrowFromSystemServer();
4830 }
4831 }
4832
4833 /**
4834 * Resets all connectivity manager settings back to factory defaults.
4835 * @hide
4836 */
Chiachang Wangf9294e72021-03-18 09:44:34 +08004837 @SystemApi(client = MODULE_LIBRARIES)
4838 @RequiresPermission(anyOf = {
4839 android.Manifest.permission.NETWORK_SETTINGS,
4840 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK})
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004841 public void factoryReset() {
4842 try {
4843 mService.factoryReset();
4844 mTetheringManager.stopAllTethering();
4845 } catch (RemoteException e) {
4846 throw e.rethrowFromSystemServer();
4847 }
4848 }
4849
4850 /**
4851 * Binds the current process to {@code network}. All Sockets created in the future
4852 * (and not explicitly bound via a bound SocketFactory from
4853 * {@link Network#getSocketFactory() Network.getSocketFactory()}) will be bound to
4854 * {@code network}. All host name resolutions will be limited to {@code network} as well.
4855 * Note that if {@code network} ever disconnects, all Sockets created in this way will cease to
4856 * work and all host name resolutions will fail. This is by design so an application doesn't
4857 * accidentally use Sockets it thinks are still bound to a particular {@link Network}.
4858 * To clear binding pass {@code null} for {@code network}. Using individually bound
4859 * Sockets created by Network.getSocketFactory().createSocket() and
4860 * performing network-specific host name resolutions via
4861 * {@link Network#getAllByName Network.getAllByName} is preferred to calling
4862 * {@code bindProcessToNetwork}.
4863 *
4864 * @param network The {@link Network} to bind the current process to, or {@code null} to clear
4865 * the current binding.
4866 * @return {@code true} on success, {@code false} if the {@link Network} is no longer valid.
4867 */
4868 public boolean bindProcessToNetwork(@Nullable Network network) {
4869 // Forcing callers to call through non-static function ensures ConnectivityManager
4870 // instantiated.
4871 return setProcessDefaultNetwork(network);
4872 }
4873
4874 /**
4875 * Binds the current process to {@code network}. All Sockets created in the future
4876 * (and not explicitly bound via a bound SocketFactory from
4877 * {@link Network#getSocketFactory() Network.getSocketFactory()}) will be bound to
4878 * {@code network}. All host name resolutions will be limited to {@code network} as well.
4879 * Note that if {@code network} ever disconnects, all Sockets created in this way will cease to
4880 * work and all host name resolutions will fail. This is by design so an application doesn't
4881 * accidentally use Sockets it thinks are still bound to a particular {@link Network}.
4882 * To clear binding pass {@code null} for {@code network}. Using individually bound
4883 * Sockets created by Network.getSocketFactory().createSocket() and
4884 * performing network-specific host name resolutions via
4885 * {@link Network#getAllByName Network.getAllByName} is preferred to calling
4886 * {@code setProcessDefaultNetwork}.
4887 *
4888 * @param network The {@link Network} to bind the current process to, or {@code null} to clear
4889 * the current binding.
4890 * @return {@code true} on success, {@code false} if the {@link Network} is no longer valid.
4891 * @deprecated This function can throw {@link IllegalStateException}. Use
4892 * {@link #bindProcessToNetwork} instead. {@code bindProcessToNetwork}
4893 * is a direct replacement.
4894 */
4895 @Deprecated
4896 public static boolean setProcessDefaultNetwork(@Nullable Network network) {
4897 int netId = (network == null) ? NETID_UNSET : network.netId;
4898 boolean isSameNetId = (netId == NetworkUtils.getBoundNetworkForProcess());
4899
4900 if (netId != NETID_UNSET) {
4901 netId = network.getNetIdForResolv();
4902 }
4903
4904 if (!NetworkUtils.bindProcessToNetwork(netId)) {
4905 return false;
4906 }
4907
4908 if (!isSameNetId) {
4909 // Set HTTP proxy system properties to match network.
4910 // TODO: Deprecate this static method and replace it with a non-static version.
4911 try {
Remi NGUYEN VAN8a831d62021-02-03 10:18:20 +09004912 Proxy.setHttpProxyConfiguration(getInstance().getDefaultProxy());
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004913 } catch (SecurityException e) {
4914 // The process doesn't have ACCESS_NETWORK_STATE, so we can't fetch the proxy.
4915 Log.e(TAG, "Can't set proxy properties", e);
4916 }
4917 // Must flush DNS cache as new network may have different DNS resolutions.
Remi NGUYEN VAN342dddd2021-03-18 23:27:19 +09004918 InetAddressCompat.clearDnsCache();
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09004919 // Must flush socket pool as idle sockets will be bound to previous network and may
4920 // cause subsequent fetches to be performed on old network.
4921 NetworkEventDispatcher.getInstance().onNetworkConfigurationChanged();
4922 }
4923
4924 return true;
4925 }
4926
4927 /**
4928 * Returns the {@link Network} currently bound to this process via
4929 * {@link #bindProcessToNetwork}, or {@code null} if no {@link Network} is explicitly bound.
4930 *
4931 * @return {@code Network} to which this process is bound, or {@code null}.
4932 */
4933 @Nullable
4934 public Network getBoundNetworkForProcess() {
4935 // Forcing callers to call thru non-static function ensures ConnectivityManager
4936 // instantiated.
4937 return getProcessDefaultNetwork();
4938 }
4939
4940 /**
4941 * Returns the {@link Network} currently bound to this process via
4942 * {@link #bindProcessToNetwork}, or {@code null} if no {@link Network} is explicitly bound.
4943 *
4944 * @return {@code Network} to which this process is bound, or {@code null}.
4945 * @deprecated Using this function can lead to other functions throwing
4946 * {@link IllegalStateException}. Use {@link #getBoundNetworkForProcess} instead.
4947 * {@code getBoundNetworkForProcess} is a direct replacement.
4948 */
4949 @Deprecated
4950 @Nullable
4951 public static Network getProcessDefaultNetwork() {
4952 int netId = NetworkUtils.getBoundNetworkForProcess();
4953 if (netId == NETID_UNSET) return null;
4954 return new Network(netId);
4955 }
4956
4957 private void unsupportedStartingFrom(int version) {
4958 if (Process.myUid() == Process.SYSTEM_UID) {
4959 // The getApplicationInfo() call we make below is not supported in system context. Let
4960 // the call through here, and rely on the fact that ConnectivityService will refuse to
4961 // allow the system to use these APIs anyway.
4962 return;
4963 }
4964
4965 if (mContext.getApplicationInfo().targetSdkVersion >= version) {
4966 throw new UnsupportedOperationException(
4967 "This method is not supported in target SDK version " + version + " and above");
4968 }
4969 }
4970
4971 // Checks whether the calling app can use the legacy routing API (startUsingNetworkFeature,
4972 // stopUsingNetworkFeature, requestRouteToHost), and if not throw UnsupportedOperationException.
4973 // TODO: convert the existing system users (Tethering, GnssLocationProvider) to the new APIs and
4974 // remove these exemptions. Note that this check is not secure, and apps can still access these
4975 // functions by accessing ConnectivityService directly. However, it should be clear that doing
4976 // so is unsupported and may break in the future. http://b/22728205
4977 private void checkLegacyRoutingApiAccess() {
4978 unsupportedStartingFrom(VERSION_CODES.M);
4979 }
4980
4981 /**
4982 * Binds host resolutions performed by this process to {@code network}.
4983 * {@link #bindProcessToNetwork} takes precedence over this setting.
4984 *
4985 * @param network The {@link Network} to bind host resolutions from the current process to, or
4986 * {@code null} to clear the current binding.
4987 * @return {@code true} on success, {@code false} if the {@link Network} is no longer valid.
4988 * @hide
4989 * @deprecated This is strictly for legacy usage to support {@link #startUsingNetworkFeature}.
4990 */
4991 @Deprecated
4992 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
4993 public static boolean setProcessDefaultNetworkForHostResolution(Network network) {
4994 return NetworkUtils.bindProcessToNetworkForHostResolution(
4995 (network == null) ? NETID_UNSET : network.getNetIdForResolv());
4996 }
4997
4998 /**
4999 * Device is not restricting metered network activity while application is running on
5000 * background.
5001 */
5002 public static final int RESTRICT_BACKGROUND_STATUS_DISABLED = 1;
5003
5004 /**
5005 * Device is restricting metered network activity while application is running on background,
5006 * but application is allowed to bypass it.
5007 * <p>
5008 * In this state, application should take action to mitigate metered network access.
5009 * For example, a music streaming application should switch to a low-bandwidth bitrate.
5010 */
5011 public static final int RESTRICT_BACKGROUND_STATUS_WHITELISTED = 2;
5012
5013 /**
5014 * Device is restricting metered network activity while application is running on background.
5015 * <p>
5016 * In this state, application should not try to use the network while running on background,
5017 * because it would be denied.
5018 */
5019 public static final int RESTRICT_BACKGROUND_STATUS_ENABLED = 3;
5020
5021 /**
5022 * A change in the background metered network activity restriction has occurred.
5023 * <p>
5024 * Applications should call {@link #getRestrictBackgroundStatus()} to check if the restriction
5025 * applies to them.
5026 * <p>
5027 * This is only sent to registered receivers, not manifest receivers.
5028 */
5029 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
5030 public static final String ACTION_RESTRICT_BACKGROUND_CHANGED =
5031 "android.net.conn.RESTRICT_BACKGROUND_CHANGED";
5032
5033 /** @hide */
5034 @Retention(RetentionPolicy.SOURCE)
5035 @IntDef(flag = false, value = {
5036 RESTRICT_BACKGROUND_STATUS_DISABLED,
5037 RESTRICT_BACKGROUND_STATUS_WHITELISTED,
5038 RESTRICT_BACKGROUND_STATUS_ENABLED,
5039 })
5040 public @interface RestrictBackgroundStatus {
5041 }
5042
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005043 /**
5044 * Determines if the calling application is subject to metered network restrictions while
5045 * running on background.
5046 *
5047 * @return {@link #RESTRICT_BACKGROUND_STATUS_DISABLED},
5048 * {@link #RESTRICT_BACKGROUND_STATUS_ENABLED},
5049 * or {@link #RESTRICT_BACKGROUND_STATUS_WHITELISTED}
5050 */
5051 public @RestrictBackgroundStatus int getRestrictBackgroundStatus() {
5052 try {
Remi NGUYEN VAN1fdeb502021-03-18 14:23:12 +09005053 return mService.getRestrictBackgroundStatusByCaller();
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005054 } catch (RemoteException e) {
5055 throw e.rethrowFromSystemServer();
5056 }
5057 }
5058
5059 /**
5060 * The network watchlist is a list of domains and IP addresses that are associated with
5061 * potentially harmful apps. This method returns the SHA-256 of the watchlist config file
5062 * currently used by the system for validation purposes.
5063 *
5064 * @return Hash of network watchlist config file. Null if config does not exist.
5065 */
5066 @Nullable
5067 public byte[] getNetworkWatchlistConfigHash() {
5068 try {
5069 return mService.getNetworkWatchlistConfigHash();
5070 } catch (RemoteException e) {
5071 Log.e(TAG, "Unable to get watchlist config hash");
5072 throw e.rethrowFromSystemServer();
5073 }
5074 }
5075
5076 /**
5077 * Returns the {@code uid} of the owner of a network connection.
5078 *
5079 * @param protocol The protocol of the connection. Only {@code IPPROTO_TCP} and {@code
5080 * IPPROTO_UDP} currently supported.
5081 * @param local The local {@link InetSocketAddress} of a connection.
5082 * @param remote The remote {@link InetSocketAddress} of a connection.
5083 * @return {@code uid} if the connection is found and the app has permission to observe it
5084 * (e.g., if it is associated with the calling VPN app's VpnService tunnel) or {@link
5085 * android.os.Process#INVALID_UID} if the connection is not found.
5086 * @throws {@link SecurityException} if the caller is not the active VpnService for the current
5087 * user.
5088 * @throws {@link IllegalArgumentException} if an unsupported protocol is requested.
5089 */
5090 public int getConnectionOwnerUid(
5091 int protocol, @NonNull InetSocketAddress local, @NonNull InetSocketAddress remote) {
5092 ConnectionInfo connectionInfo = new ConnectionInfo(protocol, local, remote);
5093 try {
5094 return mService.getConnectionOwnerUid(connectionInfo);
5095 } catch (RemoteException e) {
5096 throw e.rethrowFromSystemServer();
5097 }
5098 }
5099
5100 private void printStackTrace() {
5101 if (DEBUG) {
5102 final StackTraceElement[] callStack = Thread.currentThread().getStackTrace();
5103 final StringBuffer sb = new StringBuffer();
5104 for (int i = 3; i < callStack.length; i++) {
5105 final String stackTrace = callStack[i].toString();
5106 if (stackTrace == null || stackTrace.contains("android.os")) {
5107 break;
5108 }
5109 sb.append(" [").append(stackTrace).append("]");
5110 }
5111 Log.d(TAG, "StackLog:" + sb.toString());
5112 }
5113 }
5114
Remi NGUYEN VAN91444ca2021-01-15 23:02:47 +09005115 /** @hide */
5116 public TestNetworkManager startOrGetTestNetworkManager() {
5117 final IBinder tnBinder;
5118 try {
5119 tnBinder = mService.startOrGetTestNetworkService();
5120 } catch (RemoteException e) {
5121 throw e.rethrowFromSystemServer();
5122 }
5123
5124 return new TestNetworkManager(ITestNetworkManager.Stub.asInterface(tnBinder));
5125 }
5126
Remi NGUYEN VAN91444ca2021-01-15 23:02:47 +09005127 /** @hide */
5128 public ConnectivityDiagnosticsManager createDiagnosticsManager() {
5129 return new ConnectivityDiagnosticsManager(mContext, mService);
5130 }
5131
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005132 /**
5133 * Simulates a Data Stall for the specified Network.
5134 *
5135 * <p>This method should only be used for tests.
5136 *
Remi NGUYEN VAN564f7f82021-04-08 16:26:20 +09005137 * <p>The caller must be the owner of the specified Network. This simulates a data stall to
5138 * have the system behave as if it had happened, but does not actually stall connectivity.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005139 *
5140 * @param detectionMethod The detection method used to identify the Data Stall.
Remi NGUYEN VAN564f7f82021-04-08 16:26:20 +09005141 * See ConnectivityDiagnosticsManager.DataStallReport.DETECTION_METHOD_*.
5142 * @param timestampMillis The timestamp at which the stall 'occurred', in milliseconds, as per
5143 * SystemClock.elapsedRealtime.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005144 * @param network The Network for which a Data Stall is being simluated.
5145 * @param extras The PersistableBundle of extras included in the Data Stall notification.
5146 * @throws SecurityException if the caller is not the owner of the given network.
5147 * @hide
5148 */
5149 @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
5150 @RequiresPermission(anyOf = {android.Manifest.permission.MANAGE_TEST_NETWORKS,
5151 android.Manifest.permission.NETWORK_STACK})
Remi NGUYEN VAN564f7f82021-04-08 16:26:20 +09005152 public void simulateDataStall(@DetectionMethod int detectionMethod, long timestampMillis,
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005153 @NonNull Network network, @NonNull PersistableBundle extras) {
5154 try {
5155 mService.simulateDataStall(detectionMethod, timestampMillis, network, extras);
5156 } catch (RemoteException e) {
5157 e.rethrowFromSystemServer();
5158 }
5159 }
5160
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005161 @NonNull
5162 private final List<QosCallbackConnection> mQosCallbackConnections = new ArrayList<>();
5163
5164 /**
5165 * Registers a {@link QosSocketInfo} with an associated {@link QosCallback}. The callback will
5166 * receive available QoS events related to the {@link Network} and local ip + port
5167 * specified within socketInfo.
5168 * <p/>
5169 * The same {@link QosCallback} must be unregistered before being registered a second time,
5170 * otherwise {@link QosCallbackRegistrationException} is thrown.
5171 * <p/>
5172 * This API does not, in itself, require any permission if called with a network that is not
5173 * restricted. However, the underlying implementation currently only supports the IMS network,
5174 * which is always restricted. That means non-preinstalled callers can't possibly find this API
5175 * useful, because they'd never be called back on networks that they would have access to.
5176 *
5177 * @throws SecurityException if {@link QosSocketInfo#getNetwork()} is restricted and the app is
5178 * missing CONNECTIVITY_USE_RESTRICTED_NETWORKS permission.
5179 * @throws QosCallback.QosCallbackRegistrationException if qosCallback is already registered.
5180 * @throws RuntimeException if the app already has too many callbacks registered.
5181 *
5182 * Exceptions after the time of registration is passed through
5183 * {@link QosCallback#onError(QosCallbackException)}. see: {@link QosCallbackException}.
5184 *
5185 * @param socketInfo the socket information used to match QoS events
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005186 * @param executor The executor on which the callback will be invoked. The provided
5187 * {@link Executor} must run callback sequentially, otherwise the order of
Daniel Bright686d5d22021-03-10 11:51:50 -08005188 * callbacks cannot be guaranteed.onQosCallbackRegistered
5189 * @param callback receives qos events that satisfy socketInfo
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005190 *
5191 * @hide
5192 */
5193 @SystemApi
5194 public void registerQosCallback(@NonNull final QosSocketInfo socketInfo,
Daniel Bright686d5d22021-03-10 11:51:50 -08005195 @CallbackExecutor @NonNull final Executor executor,
5196 @NonNull final QosCallback callback) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005197 Objects.requireNonNull(socketInfo, "socketInfo must be non-null");
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005198 Objects.requireNonNull(executor, "executor must be non-null");
Daniel Bright686d5d22021-03-10 11:51:50 -08005199 Objects.requireNonNull(callback, "callback must be non-null");
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005200
5201 try {
5202 synchronized (mQosCallbackConnections) {
5203 if (getQosCallbackConnection(callback) == null) {
5204 final QosCallbackConnection connection =
5205 new QosCallbackConnection(this, callback, executor);
5206 mQosCallbackConnections.add(connection);
5207 mService.registerQosSocketCallback(socketInfo, connection);
5208 } else {
5209 Log.e(TAG, "registerQosCallback: Callback already registered");
5210 throw new QosCallbackRegistrationException();
5211 }
5212 }
5213 } catch (final RemoteException e) {
5214 Log.e(TAG, "registerQosCallback: Error while registering ", e);
5215
5216 // The same unregister method method is called for consistency even though nothing
5217 // will be sent to the ConnectivityService since the callback was never successfully
5218 // registered.
5219 unregisterQosCallback(callback);
5220 e.rethrowFromSystemServer();
5221 } catch (final ServiceSpecificException e) {
5222 Log.e(TAG, "registerQosCallback: Error while registering ", e);
5223 unregisterQosCallback(callback);
5224 throw convertServiceException(e);
5225 }
5226 }
5227
5228 /**
5229 * Unregisters the given {@link QosCallback}. The {@link QosCallback} will no longer receive
5230 * events once unregistered and can be registered a second time.
5231 * <p/>
5232 * If the {@link QosCallback} does not have an active registration, it is a no-op.
5233 *
5234 * @param callback the callback being unregistered
5235 *
5236 * @hide
5237 */
5238 @SystemApi
5239 public void unregisterQosCallback(@NonNull final QosCallback callback) {
5240 Objects.requireNonNull(callback, "The callback must be non-null");
5241 try {
5242 synchronized (mQosCallbackConnections) {
5243 final QosCallbackConnection connection = getQosCallbackConnection(callback);
5244 if (connection != null) {
5245 connection.stopReceivingMessages();
5246 mService.unregisterQosCallback(connection);
5247 mQosCallbackConnections.remove(connection);
5248 } else {
5249 Log.d(TAG, "unregisterQosCallback: Callback not registered");
5250 }
5251 }
5252 } catch (final RemoteException e) {
5253 Log.e(TAG, "unregisterQosCallback: Error while unregistering ", e);
5254 e.rethrowFromSystemServer();
5255 }
5256 }
5257
5258 /**
5259 * Gets the connection related to the callback.
5260 *
5261 * @param callback the callback to look up
5262 * @return the related connection
5263 */
5264 @Nullable
5265 private QosCallbackConnection getQosCallbackConnection(final QosCallback callback) {
5266 for (final QosCallbackConnection connection : mQosCallbackConnections) {
5267 // Checking by reference here is intentional
5268 if (connection.getCallback() == callback) {
5269 return connection;
5270 }
5271 }
5272 return null;
5273 }
5274
5275 /**
Roshan Piuse08bc182020-12-22 15:10:42 -08005276 * Request a network to satisfy a set of {@link NetworkCapabilities}, but
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005277 * does not cause any networks to retain the NET_CAPABILITY_FOREGROUND capability. This can
5278 * be used to request that the system provide a network without causing the network to be
5279 * in the foreground.
5280 *
5281 * <p>This method will attempt to find the best network that matches the passed
5282 * {@link NetworkRequest}, and to bring up one that does if none currently satisfies the
5283 * criteria. The platform will evaluate which network is the best at its own discretion.
5284 * Throughput, latency, cost per byte, policy, user preference and other considerations
5285 * may be factored in the decision of what is considered the best network.
5286 *
5287 * <p>As long as this request is outstanding, the platform will try to maintain the best network
5288 * matching this request, while always attempting to match the request to a better network if
5289 * possible. If a better match is found, the platform will switch this request to the now-best
5290 * network and inform the app of the newly best network by invoking
5291 * {@link NetworkCallback#onAvailable(Network)} on the provided callback. Note that the platform
5292 * will not try to maintain any other network than the best one currently matching the request:
5293 * a network not matching any network request may be disconnected at any time.
5294 *
5295 * <p>For example, an application could use this method to obtain a connected cellular network
5296 * even if the device currently has a data connection over Ethernet. This may cause the cellular
5297 * radio to consume additional power. Or, an application could inform the system that it wants
5298 * a network supporting sending MMSes and have the system let it know about the currently best
5299 * MMS-supporting network through the provided {@link NetworkCallback}.
5300 *
5301 * <p>The status of the request can be followed by listening to the various callbacks described
5302 * in {@link NetworkCallback}. The {@link Network} object passed to the callback methods can be
5303 * used to direct traffic to the network (although accessing some networks may be subject to
5304 * holding specific permissions). Callers will learn about the specific characteristics of the
5305 * network through
5306 * {@link NetworkCallback#onCapabilitiesChanged(Network, NetworkCapabilities)} and
5307 * {@link NetworkCallback#onLinkPropertiesChanged(Network, LinkProperties)}. The methods of the
5308 * provided {@link NetworkCallback} will only be invoked due to changes in the best network
5309 * matching the request at any given time; therefore when a better network matching the request
5310 * becomes available, the {@link NetworkCallback#onAvailable(Network)} method is called
5311 * with the new network after which no further updates are given about the previously-best
5312 * network, unless it becomes the best again at some later time. All callbacks are invoked
5313 * in order on the same thread, which by default is a thread created by the framework running
5314 * in the app.
5315 *
5316 * <p>This{@link NetworkRequest} will live until released via
5317 * {@link #unregisterNetworkCallback(NetworkCallback)} or the calling application exits, at
5318 * which point the system may let go of the network at any time.
5319 *
5320 * <p>It is presently unsupported to request a network with mutable
5321 * {@link NetworkCapabilities} such as
5322 * {@link NetworkCapabilities#NET_CAPABILITY_VALIDATED} or
5323 * {@link NetworkCapabilities#NET_CAPABILITY_CAPTIVE_PORTAL}
5324 * as these {@code NetworkCapabilities} represent states that a particular
5325 * network may never attain, and whether a network will attain these states
5326 * is unknown prior to bringing up the network so the framework does not
5327 * know how to go about satisfying a request with these capabilities.
5328 *
5329 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
5330 * number of outstanding requests to 100 per app (identified by their UID), shared with
5331 * all variants of this method, of {@link #registerNetworkCallback} as well as
5332 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
5333 * Requesting a network with this method will count toward this limit. If this limit is
5334 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
5335 * make sure to unregister the callbacks with
5336 * {@link #unregisterNetworkCallback(NetworkCallback)}.
5337 *
5338 * @param request {@link NetworkRequest} describing this request.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005339 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
5340 * the callback must not be shared - it uniquely specifies this request.
junyulaica657cb2021-04-15 00:39:49 +08005341 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
5342 * If null, the callback is invoked on the default internal Handler.
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005343 * @throws IllegalArgumentException if {@code request} contains invalid network capabilities.
5344 * @throws SecurityException if missing the appropriate permissions.
5345 * @throws RuntimeException if the app already has too many callbacks registered.
5346 *
5347 * @hide
5348 */
5349 @SystemApi(client = MODULE_LIBRARIES)
5350 @SuppressLint("ExecutorRegistration")
5351 @RequiresPermission(anyOf = {
5352 android.Manifest.permission.NETWORK_SETTINGS,
5353 android.Manifest.permission.NETWORK_STACK,
5354 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK
5355 })
5356 public void requestBackgroundNetwork(@NonNull NetworkRequest request,
junyulaica657cb2021-04-15 00:39:49 +08005357 @NonNull NetworkCallback networkCallback,
5358 @SuppressLint("ListenerLast") @NonNull Handler handler) {
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005359 final NetworkCapabilities nc = request.networkCapabilities;
5360 sendRequestForNetwork(nc, networkCallback, 0, BACKGROUND_REQUEST,
junyulaidbb70462021-03-09 20:49:48 +08005361 TYPE_NONE, new CallbackHandler(handler));
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005362 }
James Mattis12aeab82021-01-10 14:24:24 -08005363
5364 /**
James Mattis12aeab82021-01-10 14:24:24 -08005365 * Used by automotive devices to set the network preferences used to direct traffic at an
5366 * application level as per the given OemNetworkPreferences. An example use-case would be an
5367 * automotive OEM wanting to provide connectivity for applications critical to the usage of a
5368 * vehicle via a particular network.
5369 *
5370 * Calling this will overwrite the existing preference.
5371 *
5372 * @param preference {@link OemNetworkPreferences} The application network preference to be set.
5373 * @param executor the executor on which listener will be invoked.
5374 * @param listener {@link OnSetOemNetworkPreferenceListener} optional listener used to
5375 * communicate completion of setOemNetworkPreference(). This will only be
5376 * called once upon successful completion of setOemNetworkPreference().
5377 * @throws IllegalArgumentException if {@code preference} contains invalid preference values.
5378 * @throws SecurityException if missing the appropriate permissions.
5379 * @throws UnsupportedOperationException if called on a non-automotive device.
James Mattis6e2d7022021-01-26 16:23:52 -08005380 * @hide
James Mattis12aeab82021-01-10 14:24:24 -08005381 */
James Mattis6e2d7022021-01-26 16:23:52 -08005382 @SystemApi
James Mattisa46c1442021-01-26 14:05:36 -08005383 @RequiresPermission(android.Manifest.permission.CONTROL_OEM_PAID_NETWORK_PREFERENCE)
James Mattis6e2d7022021-01-26 16:23:52 -08005384 public void setOemNetworkPreference(@NonNull final OemNetworkPreferences preference,
James Mattis12aeab82021-01-10 14:24:24 -08005385 @Nullable @CallbackExecutor final Executor executor,
Chalard Jean0a4aefc2021-03-03 16:37:13 +09005386 @Nullable final Runnable listener) {
James Mattis12aeab82021-01-10 14:24:24 -08005387 Objects.requireNonNull(preference, "OemNetworkPreferences must be non-null");
5388 if (null != listener) {
5389 Objects.requireNonNull(executor, "Executor must be non-null");
5390 }
Chalard Jean0a4aefc2021-03-03 16:37:13 +09005391 final IOnCompleteListener listenerInternal = listener == null ? null :
5392 new IOnCompleteListener.Stub() {
James Mattis12aeab82021-01-10 14:24:24 -08005393 @Override
5394 public void onComplete() {
Chalard Jean0a4aefc2021-03-03 16:37:13 +09005395 executor.execute(listener::run);
James Mattis12aeab82021-01-10 14:24:24 -08005396 }
5397 };
5398
5399 try {
5400 mService.setOemNetworkPreference(preference, listenerInternal);
5401 } catch (RemoteException e) {
5402 Log.e(TAG, "setOemNetworkPreference() failed for preference: " + preference.toString());
5403 throw e.rethrowFromSystemServer();
5404 }
5405 }
lucaslin5cdbcfb2021-03-12 00:46:33 +08005406
Chalard Jeanad565e22021-02-25 17:23:40 +09005407 /**
5408 * Request that a user profile is put by default on a network matching a given preference.
5409 *
5410 * See the documentation for the individual preferences for a description of the supported
5411 * behaviors.
5412 *
5413 * @param profile the profile concerned.
5414 * @param preference the preference for this profile.
5415 * @param executor an executor to execute the listener on. Optional if listener is null.
5416 * @param listener an optional listener to listen for completion of the operation.
5417 * @throws IllegalArgumentException if {@code profile} is not a valid user profile.
5418 * @throws SecurityException if missing the appropriate permissions.
5419 * @hide
5420 */
Chalard Jean0a4aefc2021-03-03 16:37:13 +09005421 // This function is for establishing per-profile default networking and can only be called by
5422 // the device policy manager, running as the system server. It would make no sense to call it
5423 // on a context for a user because it does not establish a setting on behalf of a user, rather
5424 // it establishes a setting for a user on behalf of the DPM.
5425 @SuppressLint({"UserHandle"})
5426 @SystemApi(client = MODULE_LIBRARIES)
Chalard Jeanad565e22021-02-25 17:23:40 +09005427 @RequiresPermission(android.Manifest.permission.NETWORK_STACK)
5428 public void setProfileNetworkPreference(@NonNull final UserHandle profile,
5429 @ProfileNetworkPreference final int preference,
5430 @Nullable @CallbackExecutor final Executor executor,
5431 @Nullable final Runnable listener) {
5432 if (null != listener) {
5433 Objects.requireNonNull(executor, "Pass a non-null executor, or a null listener");
5434 }
5435 final IOnCompleteListener proxy;
5436 if (null == listener) {
5437 proxy = null;
5438 } else {
5439 proxy = new IOnCompleteListener.Stub() {
5440 @Override
5441 public void onComplete() {
5442 executor.execute(listener::run);
5443 }
5444 };
5445 }
5446 try {
5447 mService.setProfileNetworkPreference(profile, preference, proxy);
5448 } catch (RemoteException e) {
5449 throw e.rethrowFromSystemServer();
5450 }
5451 }
5452
lucaslin5cdbcfb2021-03-12 00:46:33 +08005453 // The first network ID of IPSec tunnel interface.
lucaslinc296fcc2021-03-15 17:24:12 +08005454 private static final int TUN_INTF_NETID_START = 0xFC00; // 0xFC00 = 64512
lucaslin5cdbcfb2021-03-12 00:46:33 +08005455 // The network ID range of IPSec tunnel interface.
lucaslinc296fcc2021-03-15 17:24:12 +08005456 private static final int TUN_INTF_NETID_RANGE = 0x0400; // 0x0400 = 1024
lucaslin5cdbcfb2021-03-12 00:46:33 +08005457
5458 /**
5459 * Get the network ID range reserved for IPSec tunnel interfaces.
5460 *
5461 * @return A Range which indicates the network ID range of IPSec tunnel interface.
5462 * @hide
5463 */
5464 @SystemApi(client = MODULE_LIBRARIES)
5465 @NonNull
5466 public static Range<Integer> getIpSecNetIdRange() {
5467 return new Range(TUN_INTF_NETID_START, TUN_INTF_NETID_START + TUN_INTF_NETID_RANGE - 1);
5468 }
Remi NGUYEN VANfbbccbc2021-01-15 18:08:24 +09005469}