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