blob: 92ed7fc29eb23f4944061d51d9e7ff89f3b62ac9 [file] [log] [blame]
The Android Open Source Project28527d22009-03-03 19:31:44 -08001/*
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 */
The Android Open Source Project28527d22009-03-03 19:31:44 -080016package android.net;
17
Junyu Laia62493f2021-01-19 11:10:56 +000018import static android.annotation.SystemApi.Client.MODULE_LIBRARIES;
paulhu56e09df2021-03-17 20:30:33 +080019import static android.net.ConnectivitySettingsManager.PRIVATE_DNS_DEFAULT_MODE;
20import static android.net.ConnectivitySettingsManager.PRIVATE_DNS_MODE;
Junyu Laia62493f2021-01-19 11:10:56 +000021import static android.net.NetworkRequest.Type.BACKGROUND_REQUEST;
junyulaiad010792021-01-11 16:53:38 +080022import static android.net.NetworkRequest.Type.LISTEN;
junyulai1b1c8742021-03-12 20:05:08 +080023import static android.net.NetworkRequest.Type.LISTEN_FOR_BEST;
junyulaiad010792021-01-11 16:53:38 +080024import static android.net.NetworkRequest.Type.REQUEST;
25import static android.net.NetworkRequest.Type.TRACK_DEFAULT;
Lorenzo Colitti76b639e2021-01-29 20:14:04 +090026import static android.net.NetworkRequest.Type.TRACK_SYSTEM_DEFAULT;
Daniel Brightf9e945b2020-06-15 16:10:01 -070027import static android.net.QosCallback.QosCallbackRegistrationException;
junyulaid05a1922019-01-15 11:32:44 +080028
junyulai4c95b082018-12-27 17:25:29 +080029import android.annotation.CallbackExecutor;
Felipe Leme30511352016-01-22 09:44:57 -080030import android.annotation.IntDef;
Chalard Jean158702d2019-01-07 19:26:34 +090031import android.annotation.NonNull;
Robin Leee5d5ed52016-01-05 18:03:46 +000032import android.annotation.Nullable;
Jeff Sharkey656584a2017-04-24 11:18:03 -060033import android.annotation.RequiresPermission;
The Android Open Source Project28527d22009-03-03 19:31:44 -080034import android.annotation.SdkConstant;
35import android.annotation.SdkConstant.SdkConstantType;
lucaslin705c3332021-03-12 17:56:09 +080036import android.annotation.StringDef;
Junyu Laia62493f2021-01-19 11:10:56 +000037import android.annotation.SuppressLint;
Udam Sainicd645462016-01-04 12:16:14 -080038import android.annotation.SystemApi;
Jeff Sharkey9b39e9a2017-06-02 17:36:26 -060039import android.annotation.SystemService;
Robert Greenwaltf99b8392014-03-26 16:47:06 -070040import android.app.PendingIntent;
Lorenzo Colitti79c6f222021-03-18 00:54:57 +090041import android.app.admin.DevicePolicyManager;
Artur Satayev9c2add62019-12-10 17:47:52 +000042import android.compat.annotation.UnsupportedAppUsage;
Lorenzo Colitti79c6f222021-03-18 00:54:57 +090043import android.content.ComponentName;
lucaslin705c3332021-03-12 17:56:09 +080044import android.content.ContentResolver;
Jeff Sharkey2d9e5a52012-04-04 20:40:58 -070045import android.content.Context;
Robert Greenwaltf3017f72014-05-18 23:07:25 -070046import android.content.Intent;
junyulai4c95b082018-12-27 17:25:29 +080047import android.net.IpSecManager.UdpEncapsulationSocket;
48import android.net.SocketKeepalive.Callback;
markchien91c78e52020-01-20 19:31:56 +080049import android.net.TetheringManager.StartTetheringCallback;
markchien6ae63e52020-01-21 13:11:06 +080050import android.net.TetheringManager.TetheringEventCallback;
markchien91c78e52020-01-20 19:31:56 +080051import android.net.TetheringManager.TetheringRequest;
Roshan Pius951c0032020-12-22 15:10:42 -080052import android.net.wifi.WifiNetworkSuggestion;
Robert Greenwalt2034b912009-08-12 16:08:25 -070053import android.os.Binder;
Mathew Inwoodbdfc1fc2018-12-20 15:30:45 +000054import android.os.Build;
Jeff Sharkey39c01eb2011-08-16 14:37:57 -070055import android.os.Build.VERSION_CODES;
Jeremy Klein3dabcb92016-01-22 14:11:45 -080056import android.os.Bundle;
Robert Greenwaltf99b8392014-03-26 16:47:06 -070057import android.os.Handler;
Dianne Hackborn5ac88162014-02-26 16:20:52 -080058import android.os.IBinder;
Robert Greenwaltf99b8392014-03-26 16:47:06 -070059import android.os.Looper;
60import android.os.Message;
Robert Greenwalt15a41532012-08-21 19:27:00 -070061import android.os.Messenger;
junyulai7e06ad42019-03-04 22:45:36 +080062import android.os.ParcelFileDescriptor;
Cody Kestingf53a0752020-04-15 12:33:28 -070063import android.os.PersistableBundle;
Lorenzo Colitti2780e4b2015-07-29 11:41:21 +090064import android.os.Process;
The Android Open Source Project28527d22009-03-03 19:31:44 -080065import android.os.RemoteException;
Jeremy Klein3dabcb92016-01-22 14:11:45 -080066import android.os.ResultReceiver;
Hugo Benichia590ab82017-05-11 13:16:17 +090067import android.os.ServiceSpecificException;
Chalard Jeanfa45a682021-02-25 17:23:40 +090068import android.os.UserHandle;
Jeff Sharkey971cd162011-08-29 16:02:57 -070069import android.provider.Settings;
Wink Saville689f7042014-12-05 11:10:30 -080070import android.telephony.SubscriptionManager;
Meng Wanged6f4412019-11-18 17:10:00 -080071import android.telephony.TelephonyManager;
lucaslin705c3332021-03-12 17:56:09 +080072import android.text.TextUtils;
Dianne Hackborn5ac88162014-02-26 16:20:52 -080073import android.util.ArrayMap;
Robert Greenwaltf99b8392014-03-26 16:47:06 -070074import android.util.Log;
Lorenzo Colitti3f54f102020-12-12 00:51:11 +090075import android.util.Range;
Erik Klinece55eb12017-01-26 18:08:28 +090076import android.util.SparseIntArray;
The Android Open Source Project28527d22009-03-03 19:31:44 -080077
markchien6ae63e52020-01-21 13:11:06 +080078import com.android.internal.annotations.GuardedBy;
Robert Greenwalt0c150c02014-05-21 20:04:36 -070079
Paul Jensen3e2917c2014-08-27 12:38:45 -040080import libcore.net.event.NetworkEventDispatcher;
81
junyulai7e06ad42019-03-04 22:45:36 +080082import java.io.IOException;
83import java.io.UncheckedIOException;
Felipe Leme30511352016-01-22 09:44:57 -080084import java.lang.annotation.Retention;
85import java.lang.annotation.RetentionPolicy;
Lorenzo Colitti3f54f102020-12-12 00:51:11 +090086import java.net.DatagramSocket;
Jeremy Klein434835a2015-12-28 15:11:58 -080087import java.net.InetAddress;
Jeff Vander Stoep39a51e02018-07-23 10:57:53 -070088import java.net.InetSocketAddress;
junyulai0835a1e2019-01-08 20:04:33 +080089import java.net.Socket;
Hugo Benichi2aa65af2017-03-06 09:17:06 +090090import java.util.ArrayList;
Lorenzo Colitti3f54f102020-12-12 00:51:11 +090091import java.util.Collection;
Jeremy Klein434835a2015-12-28 15:11:58 -080092import java.util.HashMap;
Hugo Benichi2aa65af2017-03-06 09:17:06 +090093import java.util.List;
94import java.util.Map;
markchien6ae63e52020-01-21 13:11:06 +080095import java.util.Objects;
junyulai4c95b082018-12-27 17:25:29 +080096import java.util.concurrent.Executor;
junyulai070f9ff2019-01-16 20:23:34 +080097import java.util.concurrent.ExecutorService;
98import java.util.concurrent.Executors;
99import java.util.concurrent.RejectedExecutionException;
Jeremy Klein434835a2015-12-28 15:11:58 -0800100
The Android Open Source Project28527d22009-03-03 19:31:44 -0800101/**
102 * Class that answers queries about the state of network connectivity. It also
Jeff Sharkey9b39e9a2017-06-02 17:36:26 -0600103 * notifies applications when network connectivity changes.
The Android Open Source Project28527d22009-03-03 19:31:44 -0800104 * <p>
105 * The primary responsibilities of this class are to:
106 * <ol>
107 * <li>Monitor network connections (Wi-Fi, GPRS, UMTS, etc.)</li>
108 * <li>Send broadcast intents when network connectivity changes</li>
109 * <li>Attempt to "fail over" to another network when connectivity to a network
110 * is lost</li>
111 * <li>Provide an API that allows applications to query the coarse-grained or fine-grained
112 * state of the available networks</li>
Robert Greenwaltf3017f72014-05-18 23:07:25 -0700113 * <li>Provide an API that allows applications to request and select networks for their data
114 * traffic</li>
The Android Open Source Project28527d22009-03-03 19:31:44 -0800115 * </ol>
116 */
Jeff Sharkey9b39e9a2017-06-02 17:36:26 -0600117@SystemService(Context.CONNECTIVITY_SERVICE)
Jeff Sharkey921ebf22011-05-19 17:12:49 -0700118public class ConnectivityManager {
119 private static final String TAG = "ConnectivityManager";
Soi, Yoshinarib8102ef2015-11-12 12:09:02 +0900120 private static final boolean DEBUG = Log.isLoggable(TAG, Log.DEBUG);
Jeff Sharkey921ebf22011-05-19 17:12:49 -0700121
The Android Open Source Project28527d22009-03-03 19:31:44 -0800122 /**
Robert Greenwaltf3017f72014-05-18 23:07:25 -0700123 * A change in network connectivity has occurred. A default connection has either
The Android Open Source Project28527d22009-03-03 19:31:44 -0800124 * been established or lost. The NetworkInfo for the affected network is
125 * sent as an extra; it should be consulted to see what kind of
126 * connectivity event occurred.
127 * <p/>
Mark Lu3e422ac2016-12-05 10:57:55 -0800128 * Apps targeting Android 7.0 (API level 24) and higher do not receive this
129 * broadcast if they declare the broadcast receiver in their manifest. Apps
130 * will still receive broadcasts if they register their
131 * {@link android.content.BroadcastReceiver} with
132 * {@link android.content.Context#registerReceiver Context.registerReceiver()}
133 * and that context is still valid.
134 * <p/>
The Android Open Source Project28527d22009-03-03 19:31:44 -0800135 * If this is a connection that was the result of failing over from a
136 * disconnected network, then the FAILOVER_CONNECTION boolean extra is
137 * set to true.
138 * <p/>
139 * For a loss of connectivity, if the connectivity manager is attempting
140 * to connect (or has already connected) to another network, the
141 * NetworkInfo for the new network is also passed as an extra. This lets
142 * any receivers of the broadcast know that they should not necessarily
143 * tell the user that no data traffic will be possible. Instead, the
Robert Greenwaltfaa4b402013-02-15 10:56:35 -0800144 * receiver should expect another broadcast soon, indicating either that
The Android Open Source Project28527d22009-03-03 19:31:44 -0800145 * the failover attempt succeeded (and so there is still overall data
146 * connectivity), or that the failover attempt failed, meaning that all
147 * connectivity has been lost.
148 * <p/>
149 * For a disconnect event, the boolean extra EXTRA_NO_CONNECTIVITY
150 * is set to {@code true} if there are no connected networks at all.
Chalard Jean52e23962018-02-10 05:33:50 +0900151 *
152 * @deprecated apps should use the more versatile {@link #requestNetwork},
153 * {@link #registerNetworkCallback} or {@link #registerDefaultNetworkCallback}
154 * functions instead for faster and more detailed updates about the network
155 * changes they care about.
The Android Open Source Project28527d22009-03-03 19:31:44 -0800156 */
Jeff Sharkeyee9275b2013-02-20 18:21:19 -0800157 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Chalard Jean52e23962018-02-10 05:33:50 +0900158 @Deprecated
The Android Open Source Project28527d22009-03-03 19:31:44 -0800159 public static final String CONNECTIVITY_ACTION = "android.net.conn.CONNECTIVITY_CHANGE";
Jeff Sharkey66fa9682011-08-02 17:22:34 -0700160
The Android Open Source Project28527d22009-03-03 19:31:44 -0800161 /**
Paul Jensen60df4aa2015-02-27 22:55:47 -0500162 * The device has connected to a network that has presented a captive
163 * portal, which is blocking Internet connectivity. The user was presented
164 * with a notification that network sign in is required,
165 * and the user invoked the notification's action indicating they
Paul Jensen75e0adb2015-05-22 10:50:39 -0400166 * desire to sign in to the network. Apps handling this activity should
Paul Jensen60df4aa2015-02-27 22:55:47 -0500167 * facilitate signing in to the network. This action includes a
168 * {@link Network} typed extra called {@link #EXTRA_NETWORK} that represents
169 * the network presenting the captive portal; all communication with the
170 * captive portal must be done using this {@code Network} object.
171 * <p/>
Paul Jensen75e0adb2015-05-22 10:50:39 -0400172 * This activity includes a {@link CaptivePortal} extra named
173 * {@link #EXTRA_CAPTIVE_PORTAL} that can be used to indicate different
174 * outcomes of the captive portal sign in to the system:
175 * <ul>
176 * <li> When the app handling this action believes the user has signed in to
177 * the network and the captive portal has been dismissed, the app should
178 * call {@link CaptivePortal#reportCaptivePortalDismissed} so the system can
179 * reevaluate the network. If reevaluation finds the network no longer
180 * subject to a captive portal, the network may become the default active
Chalard Jean9dd11612018-06-04 16:52:49 +0900181 * data network.</li>
Paul Jensen75e0adb2015-05-22 10:50:39 -0400182 * <li> When the app handling this action believes the user explicitly wants
Paul Jensen60df4aa2015-02-27 22:55:47 -0500183 * to ignore the captive portal and the network, the app should call
Paul Jensen75e0adb2015-05-22 10:50:39 -0400184 * {@link CaptivePortal#ignoreNetwork}. </li>
185 * </ul>
Paul Jensen60df4aa2015-02-27 22:55:47 -0500186 */
187 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
188 public static final String ACTION_CAPTIVE_PORTAL_SIGN_IN = "android.net.conn.CAPTIVE_PORTAL";
189
190 /**
The Android Open Source Project28527d22009-03-03 19:31:44 -0800191 * The lookup key for a {@link NetworkInfo} object. Retrieve with
192 * {@link android.content.Intent#getParcelableExtra(String)}.
Jeff Sharkey66fa9682011-08-02 17:22:34 -0700193 *
Chalard Jean97021a12019-01-11 16:47:53 +0900194 * @deprecated The {@link NetworkInfo} object is deprecated, as many of its properties
195 * can't accurately represent modern network characteristics.
196 * Please obtain information about networks from the {@link NetworkCapabilities}
197 * or {@link LinkProperties} objects instead.
The Android Open Source Project28527d22009-03-03 19:31:44 -0800198 */
Jeff Sharkey66fa9682011-08-02 17:22:34 -0700199 @Deprecated
The Android Open Source Project28527d22009-03-03 19:31:44 -0800200 public static final String EXTRA_NETWORK_INFO = "networkInfo";
Jeff Sharkey66fa9682011-08-02 17:22:34 -0700201
The Android Open Source Project28527d22009-03-03 19:31:44 -0800202 /**
Jeff Sharkey47905d12012-08-06 11:41:50 -0700203 * Network type which triggered a {@link #CONNECTIVITY_ACTION} broadcast.
Jeff Sharkey47905d12012-08-06 11:41:50 -0700204 *
205 * @see android.content.Intent#getIntExtra(String, int)
Chalard Jean97021a12019-01-11 16:47:53 +0900206 * @deprecated The network type is not rich enough to represent the characteristics
207 * of modern networks. Please use {@link NetworkCapabilities} instead,
208 * in particular the transports.
Jeff Sharkey47905d12012-08-06 11:41:50 -0700209 */
Chalard Jean97021a12019-01-11 16:47:53 +0900210 @Deprecated
Jeff Sharkey47905d12012-08-06 11:41:50 -0700211 public static final String EXTRA_NETWORK_TYPE = "networkType";
212
213 /**
The Android Open Source Project28527d22009-03-03 19:31:44 -0800214 * The lookup key for a boolean that indicates whether a connect event
215 * is for a network to which the connectivity manager was failing over
216 * following a disconnect on another network.
217 * Retrieve it with {@link android.content.Intent#getBooleanExtra(String,boolean)}.
junyulai9826e7f2018-12-13 12:47:51 +0800218 *
219 * @deprecated See {@link NetworkInfo}.
The Android Open Source Project28527d22009-03-03 19:31:44 -0800220 */
junyulai9826e7f2018-12-13 12:47:51 +0800221 @Deprecated
The Android Open Source Project28527d22009-03-03 19:31:44 -0800222 public static final String EXTRA_IS_FAILOVER = "isFailover";
223 /**
224 * The lookup key for a {@link NetworkInfo} object. This is supplied when
225 * there is another network that it may be possible to connect to. Retrieve with
226 * {@link android.content.Intent#getParcelableExtra(String)}.
junyulai9826e7f2018-12-13 12:47:51 +0800227 *
228 * @deprecated See {@link NetworkInfo}.
The Android Open Source Project28527d22009-03-03 19:31:44 -0800229 */
junyulai9826e7f2018-12-13 12:47:51 +0800230 @Deprecated
The Android Open Source Project28527d22009-03-03 19:31:44 -0800231 public static final String EXTRA_OTHER_NETWORK_INFO = "otherNetwork";
232 /**
233 * The lookup key for a boolean that indicates whether there is a
234 * complete lack of connectivity, i.e., no network is available.
235 * Retrieve it with {@link android.content.Intent#getBooleanExtra(String,boolean)}.
236 */
237 public static final String EXTRA_NO_CONNECTIVITY = "noConnectivity";
238 /**
239 * The lookup key for a string that indicates why an attempt to connect
240 * to a network failed. The string has no particular structure. It is
241 * intended to be used in notifications presented to users. Retrieve
242 * it with {@link android.content.Intent#getStringExtra(String)}.
243 */
244 public static final String EXTRA_REASON = "reason";
245 /**
246 * The lookup key for a string that provides optionally supplied
247 * extra information about the network state. The information
248 * may be passed up from the lower networking layers, and its
249 * meaning may be specific to a particular network type. Retrieve
250 * it with {@link android.content.Intent#getStringExtra(String)}.
junyulai9826e7f2018-12-13 12:47:51 +0800251 *
252 * @deprecated See {@link NetworkInfo#getExtraInfo()}.
The Android Open Source Project28527d22009-03-03 19:31:44 -0800253 */
junyulai9826e7f2018-12-13 12:47:51 +0800254 @Deprecated
The Android Open Source Project28527d22009-03-03 19:31:44 -0800255 public static final String EXTRA_EXTRA_INFO = "extraInfo";
Robert Greenwalt986c7412010-09-08 15:24:47 -0700256 /**
257 * The lookup key for an int that provides information about
258 * our connection to the internet at large. 0 indicates no connection,
259 * 100 indicates a great connection. Retrieve it with
Jeff Sharkey921ebf22011-05-19 17:12:49 -0700260 * {@link android.content.Intent#getIntExtra(String, int)}.
Robert Greenwalt986c7412010-09-08 15:24:47 -0700261 * {@hide}
262 */
263 public static final String EXTRA_INET_CONDITION = "inetCondition";
The Android Open Source Project28527d22009-03-03 19:31:44 -0800264 /**
Paul Jensen75e0adb2015-05-22 10:50:39 -0400265 * The lookup key for a {@link CaptivePortal} object included with the
266 * {@link #ACTION_CAPTIVE_PORTAL_SIGN_IN} intent. The {@code CaptivePortal}
267 * object can be used to either indicate to the system that the captive
268 * portal has been dismissed or that the user does not want to pursue
269 * signing in to captive portal. Retrieve it with
270 * {@link android.content.Intent#getParcelableExtra(String)}.
Paul Jensen60df4aa2015-02-27 22:55:47 -0500271 */
Paul Jensen75e0adb2015-05-22 10:50:39 -0400272 public static final String EXTRA_CAPTIVE_PORTAL = "android.net.extra.CAPTIVE_PORTAL";
Jan Nordqvist032e2672015-09-22 15:54:32 -0700273
274 /**
275 * Key for passing a URL to the captive portal login activity.
276 */
277 public static final String EXTRA_CAPTIVE_PORTAL_URL = "android.net.extra.CAPTIVE_PORTAL_URL";
278
Paul Jensen60df4aa2015-02-27 22:55:47 -0500279 /**
Remi NGUYEN VANc2491572018-05-22 10:01:53 +0900280 * Key for passing a {@link android.net.captiveportal.CaptivePortalProbeSpec} to the captive
281 * portal login activity.
282 * {@hide}
283 */
Remi NGUYEN VAN70ab67f2019-01-17 14:38:31 +0900284 @SystemApi
Remi NGUYEN VANc2491572018-05-22 10:01:53 +0900285 public static final String EXTRA_CAPTIVE_PORTAL_PROBE_SPEC =
286 "android.net.extra.CAPTIVE_PORTAL_PROBE_SPEC";
287
288 /**
Hugo Benichi454e0662016-12-14 08:23:40 +0900289 * Key for passing a user agent string to the captive portal login activity.
290 * {@hide}
291 */
Remi NGUYEN VAN70ab67f2019-01-17 14:38:31 +0900292 @SystemApi
Hugo Benichi454e0662016-12-14 08:23:40 +0900293 public static final String EXTRA_CAPTIVE_PORTAL_USER_AGENT =
294 "android.net.extra.CAPTIVE_PORTAL_USER_AGENT";
295
296 /**
Haoyu Baib5da5752012-06-20 14:29:57 -0700297 * Broadcast action to indicate the change of data activity status
298 * (idle or active) on a network in a recent period.
Robert Greenwaltfaa4b402013-02-15 10:56:35 -0800299 * The network becomes active when data transmission is started, or
300 * idle if there is no data transmission for a period of time.
Haoyu Baib5da5752012-06-20 14:29:57 -0700301 * {@hide}
302 */
303 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Chalard Jean9dd11612018-06-04 16:52:49 +0900304 public static final String ACTION_DATA_ACTIVITY_CHANGE =
305 "android.net.conn.DATA_ACTIVITY_CHANGE";
Haoyu Baib5da5752012-06-20 14:29:57 -0700306 /**
307 * The lookup key for an enum that indicates the network device type on which this data activity
308 * change happens.
309 * {@hide}
310 */
311 public static final String EXTRA_DEVICE_TYPE = "deviceType";
312 /**
313 * The lookup key for a boolean that indicates the device is active or not. {@code true} means
314 * it is actively sending or receiving data and {@code false} means it is idle.
315 * {@hide}
316 */
317 public static final String EXTRA_IS_ACTIVE = "isActive";
Ashish Sharma29f7e0e2014-03-12 18:42:23 -0700318 /**
319 * The lookup key for a long that contains the timestamp (nanos) of the radio state change.
320 * {@hide}
321 */
322 public static final String EXTRA_REALTIME_NS = "tsNanos";
Haoyu Baib5da5752012-06-20 14:29:57 -0700323
324 /**
The Android Open Source Project28527d22009-03-03 19:31:44 -0800325 * Broadcast Action: The setting for background data usage has changed
326 * values. Use {@link #getBackgroundDataSetting()} to get the current value.
327 * <p>
328 * If an application uses the network in the background, it should listen
329 * for this broadcast and stop using the background data if the value is
Jeff Sharkey921ebf22011-05-19 17:12:49 -0700330 * {@code false}.
Jeff Sharkeyc958c772012-01-30 16:29:24 -0800331 * <p>
332 *
333 * @deprecated As of {@link VERSION_CODES#ICE_CREAM_SANDWICH}, availability
334 * of background data depends on several combined factors, and
335 * this broadcast is no longer sent. Instead, when background
336 * data is unavailable, {@link #getActiveNetworkInfo()} will now
337 * appear disconnected. During first boot after a platform
338 * upgrade, this broadcast will be sent once if
339 * {@link #getBackgroundDataSetting()} was {@code false} before
340 * the upgrade.
The Android Open Source Project28527d22009-03-03 19:31:44 -0800341 */
342 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkeyc958c772012-01-30 16:29:24 -0800343 @Deprecated
The Android Open Source Project28527d22009-03-03 19:31:44 -0800344 public static final String ACTION_BACKGROUND_DATA_SETTING_CHANGED =
345 "android.net.conn.BACKGROUND_DATA_SETTING_CHANGED";
346
Robert Greenwaltd3401f92010-09-15 17:36:33 -0700347 /**
348 * Broadcast Action: The network connection may not be good
349 * uses {@code ConnectivityManager.EXTRA_INET_CONDITION} and
350 * {@code ConnectivityManager.EXTRA_NETWORK_INFO} to specify
351 * the network and it's condition.
352 * @hide
353 */
Jeff Sharkeyee9275b2013-02-20 18:21:19 -0800354 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Mathew Inwoodc5b9bec2018-08-08 14:52:47 +0100355 @UnsupportedAppUsage
Robert Greenwaltd3401f92010-09-15 17:36:33 -0700356 public static final String INET_CONDITION_ACTION =
357 "android.net.conn.INET_CONDITION_ACTION";
358
Robert Greenwalt2034b912009-08-12 16:08:25 -0700359 /**
Robert Greenwaltfaa4b402013-02-15 10:56:35 -0800360 * Broadcast Action: A tetherable connection has come or gone.
361 * Uses {@code ConnectivityManager.EXTRA_AVAILABLE_TETHER},
Erik Kline762fa8e2017-04-17 16:47:23 +0900362 * {@code ConnectivityManager.EXTRA_ACTIVE_LOCAL_ONLY},
363 * {@code ConnectivityManager.EXTRA_ACTIVE_TETHER}, and
Robert Greenwaltfaa4b402013-02-15 10:56:35 -0800364 * {@code ConnectivityManager.EXTRA_ERRORED_TETHER} to indicate
365 * the current state of tethering. Each include a list of
366 * interface names in that state (may be empty).
Robert Greenwalt0c4828c2010-01-26 11:40:34 -0800367 * @hide
368 */
Jeff Sharkeyee9275b2013-02-20 18:21:19 -0800369 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Mathew Inwoode1a17ba2020-11-04 09:29:36 +0000370 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
Robert Greenwalt0c4828c2010-01-26 11:40:34 -0800371 public static final String ACTION_TETHER_STATE_CHANGED =
markchiena0f8fd92019-12-25 19:40:32 +0800372 TetheringManager.ACTION_TETHER_STATE_CHANGED;
Robert Greenwalt0c4828c2010-01-26 11:40:34 -0800373
374 /**
375 * @hide
Robert Greenwaltfaa4b402013-02-15 10:56:35 -0800376 * gives a String[] listing all the interfaces configured for
377 * tethering and currently available for tethering.
Robert Greenwalt0c4828c2010-01-26 11:40:34 -0800378 */
Mathew Inwoode1a17ba2020-11-04 09:29:36 +0000379 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
markchiena0f8fd92019-12-25 19:40:32 +0800380 public static final String EXTRA_AVAILABLE_TETHER = TetheringManager.EXTRA_AVAILABLE_TETHER;
Robert Greenwalt0c4828c2010-01-26 11:40:34 -0800381
382 /**
383 * @hide
Erik Kline762fa8e2017-04-17 16:47:23 +0900384 * gives a String[] listing all the interfaces currently in local-only
385 * mode (ie, has DHCPv4+IPv6-ULA support and no packet forwarding)
Robert Greenwalt0c4828c2010-01-26 11:40:34 -0800386 */
markchiena0f8fd92019-12-25 19:40:32 +0800387 public static final String EXTRA_ACTIVE_LOCAL_ONLY = TetheringManager.EXTRA_ACTIVE_LOCAL_ONLY;
Erik Kline762fa8e2017-04-17 16:47:23 +0900388
389 /**
390 * @hide
391 * gives a String[] listing all the interfaces currently tethered
392 * (ie, has DHCPv4 support and packets potentially forwarded/NATed)
393 */
Mathew Inwoode1a17ba2020-11-04 09:29:36 +0000394 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
markchiena0f8fd92019-12-25 19:40:32 +0800395 public static final String EXTRA_ACTIVE_TETHER = TetheringManager.EXTRA_ACTIVE_TETHER;
Robert Greenwalt8e87f122010-02-11 18:18:40 -0800396
397 /**
398 * @hide
Robert Greenwaltfaa4b402013-02-15 10:56:35 -0800399 * gives a String[] listing all the interfaces we tried to tether and
400 * failed. Use {@link #getLastTetherError} to find the error code
401 * for any interfaces listed here.
Robert Greenwalt8e87f122010-02-11 18:18:40 -0800402 */
Mathew Inwoode1a17ba2020-11-04 09:29:36 +0000403 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
markchiena0f8fd92019-12-25 19:40:32 +0800404 public static final String EXTRA_ERRORED_TETHER = TetheringManager.EXTRA_ERRORED_TETHER;
Robert Greenwalt0c4828c2010-01-26 11:40:34 -0800405
406 /**
Russell Brenner30fe2642013-02-12 10:03:14 -0800407 * Broadcast Action: The captive portal tracker has finished its test.
408 * Sent only while running Setup Wizard, in lieu of showing a user
409 * notification.
410 * @hide
411 */
Jeff Sharkeyee9275b2013-02-20 18:21:19 -0800412 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Russell Brenner30fe2642013-02-12 10:03:14 -0800413 public static final String ACTION_CAPTIVE_PORTAL_TEST_COMPLETED =
414 "android.net.conn.CAPTIVE_PORTAL_TEST_COMPLETED";
415 /**
416 * The lookup key for a boolean that indicates whether a captive portal was detected.
417 * Retrieve it with {@link android.content.Intent#getBooleanExtra(String,boolean)}.
418 * @hide
419 */
420 public static final String EXTRA_IS_CAPTIVE_PORTAL = "captivePortal";
421
422 /**
Lorenzo Colitti6947c062015-04-03 16:38:52 +0900423 * Action used to display a dialog that asks the user whether to connect to a network that is
424 * not validated. This intent is used to start the dialog in settings via startActivity.
425 *
426 * @hide
427 */
428 public static final String ACTION_PROMPT_UNVALIDATED = "android.net.conn.PROMPT_UNVALIDATED";
429
430 /**
Lorenzo Colitti199ecfc2016-09-15 14:02:29 +0900431 * 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 *
434 * @hide
435 */
436 public static final String ACTION_PROMPT_LOST_VALIDATION =
437 "android.net.conn.PROMPT_LOST_VALIDATION";
438
439 /**
lucaslin2240ef62019-03-12 13:08:03 +0800440 * Action used to display a dialog that asks the user whether to stay connected to a network
441 * that has not validated. This intent is used to start the dialog in settings via
442 * startActivity.
443 *
444 * @hide
445 */
446 public static final String ACTION_PROMPT_PARTIAL_CONNECTIVITY =
447 "android.net.conn.PROMPT_PARTIAL_CONNECTIVITY";
448
449 /**
Jeremy Klein3dabcb92016-01-22 14:11:45 -0800450 * Invalid tethering type.
Chalard Jean9dd11612018-06-04 16:52:49 +0900451 * @see #startTethering(int, boolean, OnStartTetheringCallback)
Jeremy Klein3dabcb92016-01-22 14:11:45 -0800452 * @hide
453 */
markchiena0f8fd92019-12-25 19:40:32 +0800454 public static final int TETHERING_INVALID = TetheringManager.TETHERING_INVALID;
Jeremy Klein3dabcb92016-01-22 14:11:45 -0800455
456 /**
457 * Wifi tethering type.
Chalard Jean9dd11612018-06-04 16:52:49 +0900458 * @see #startTethering(int, boolean, OnStartTetheringCallback)
Jeremy Klein3dabcb92016-01-22 14:11:45 -0800459 * @hide
460 */
461 @SystemApi
Remi NGUYEN VAN09f8ed22021-02-15 18:52:06 +0900462 public static final int TETHERING_WIFI = 0;
Jeremy Klein3dabcb92016-01-22 14:11:45 -0800463
464 /**
465 * USB tethering type.
Chalard Jean9dd11612018-06-04 16:52:49 +0900466 * @see #startTethering(int, boolean, OnStartTetheringCallback)
Jeremy Klein3dabcb92016-01-22 14:11:45 -0800467 * @hide
468 */
469 @SystemApi
Remi NGUYEN VAN09f8ed22021-02-15 18:52:06 +0900470 public static final int TETHERING_USB = 1;
Jeremy Klein3dabcb92016-01-22 14:11:45 -0800471
472 /**
473 * Bluetooth tethering type.
Chalard Jean9dd11612018-06-04 16:52:49 +0900474 * @see #startTethering(int, boolean, OnStartTetheringCallback)
Jeremy Klein3dabcb92016-01-22 14:11:45 -0800475 * @hide
476 */
477 @SystemApi
Remi NGUYEN VAN09f8ed22021-02-15 18:52:06 +0900478 public static final int TETHERING_BLUETOOTH = 2;
Jeremy Klein3dabcb92016-01-22 14:11:45 -0800479
480 /**
Jimmy Chendd31bc42019-07-15 18:03:23 +0800481 * Wifi P2p tethering type.
482 * Wifi P2p tethering is set through events automatically, and don't
483 * need to start from #startTethering(int, boolean, OnStartTetheringCallback).
484 * @hide
485 */
markchiena0f8fd92019-12-25 19:40:32 +0800486 public static final int TETHERING_WIFI_P2P = TetheringManager.TETHERING_WIFI_P2P;
Jimmy Chendd31bc42019-07-15 18:03:23 +0800487
488 /**
Jeremy Klein3dabcb92016-01-22 14:11:45 -0800489 * Extra used for communicating with the TetherService. Includes the type of tethering to
490 * enable if any.
491 * @hide
492 */
markchien6ae63e52020-01-21 13:11:06 +0800493 public static final String EXTRA_ADD_TETHER_TYPE = TetheringConstants.EXTRA_ADD_TETHER_TYPE;
Jeremy Klein3dabcb92016-01-22 14:11:45 -0800494
495 /**
496 * Extra used for communicating with the TetherService. Includes the type of tethering for
497 * which to cancel provisioning.
498 * @hide
499 */
markchien6ae63e52020-01-21 13:11:06 +0800500 public static final String EXTRA_REM_TETHER_TYPE = TetheringConstants.EXTRA_REM_TETHER_TYPE;
Jeremy Klein3dabcb92016-01-22 14:11:45 -0800501
502 /**
503 * Extra used for communicating with the TetherService. True to schedule a recheck of tether
504 * provisioning.
505 * @hide
506 */
markchien6ae63e52020-01-21 13:11:06 +0800507 public static final String EXTRA_SET_ALARM = TetheringConstants.EXTRA_SET_ALARM;
Jeremy Klein3dabcb92016-01-22 14:11:45 -0800508
509 /**
510 * Tells the TetherService to run a provision check now.
511 * @hide
512 */
markchien6ae63e52020-01-21 13:11:06 +0800513 public static final String EXTRA_RUN_PROVISION = TetheringConstants.EXTRA_RUN_PROVISION;
Jeremy Klein3dabcb92016-01-22 14:11:45 -0800514
515 /**
516 * Extra used for communicating with the TetherService. Contains the {@link ResultReceiver}
517 * which will receive provisioning results. Can be left empty.
518 * @hide
519 */
markchien6ae63e52020-01-21 13:11:06 +0800520 public static final String EXTRA_PROVISION_CALLBACK =
521 TetheringConstants.EXTRA_PROVISION_CALLBACK;
Jeremy Klein3dabcb92016-01-22 14:11:45 -0800522
523 /**
Robert Greenwaltfaa4b402013-02-15 10:56:35 -0800524 * The absence of a connection type.
Robert Greenwalt33cdcdf2011-06-02 17:30:47 -0700525 * @hide
526 */
paulhu74357e72020-01-13 16:46:45 +0800527 @SystemApi
Robert Greenwalt33cdcdf2011-06-02 17:30:47 -0700528 public static final int TYPE_NONE = -1;
529
530 /**
Chalard Jean7eaf3b12018-03-08 13:54:53 +0900531 * A Mobile data connection. Devices may support more than one.
532 *
533 * @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or
534 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an
535 * appropriate network. {@see NetworkCapabilities} for supported transports.
Robert Greenwalt2034b912009-08-12 16:08:25 -0700536 */
Chalard Jean7eaf3b12018-03-08 13:54:53 +0900537 @Deprecated
Robert Greenwalt2034b912009-08-12 16:08:25 -0700538 public static final int TYPE_MOBILE = 0;
Chalard Jean7eaf3b12018-03-08 13:54:53 +0900539
Robert Greenwalt2034b912009-08-12 16:08:25 -0700540 /**
Chalard Jean7eaf3b12018-03-08 13:54:53 +0900541 * A WIFI data connection. Devices may support more than one.
542 *
543 * @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or
544 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an
545 * appropriate network. {@see NetworkCapabilities} for supported transports.
Robert Greenwalt2034b912009-08-12 16:08:25 -0700546 */
Chalard Jean7eaf3b12018-03-08 13:54:53 +0900547 @Deprecated
Robert Greenwalt2034b912009-08-12 16:08:25 -0700548 public static final int TYPE_WIFI = 1;
Chalard Jean7eaf3b12018-03-08 13:54:53 +0900549
Robert Greenwalt2034b912009-08-12 16:08:25 -0700550 /**
Robert Greenwaltfaa4b402013-02-15 10:56:35 -0800551 * An MMS-specific Mobile data connection. This network type may use the
552 * same network interface as {@link #TYPE_MOBILE} or it may use a different
553 * one. This is used by applications needing to talk to the carrier's
554 * Multimedia Messaging Service servers.
Lorenzo Colitti21e9a152015-04-23 15:32:42 +0900555 *
Chalard Jean7eaf3b12018-03-08 13:54:53 +0900556 * @deprecated Applications should instead use {@link NetworkCapabilities#hasCapability} or
Lorenzo Colitti7f6a2bf2015-04-24 17:03:31 +0900557 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request a network that
Lorenzo Colitti21e9a152015-04-23 15:32:42 +0900558 * provides the {@link NetworkCapabilities#NET_CAPABILITY_MMS} capability.
Robert Greenwalt2034b912009-08-12 16:08:25 -0700559 */
Aurimas Liutikase80a0eb2016-05-24 15:22:55 -0700560 @Deprecated
Robert Greenwalt2034b912009-08-12 16:08:25 -0700561 public static final int TYPE_MOBILE_MMS = 2;
Chalard Jean7eaf3b12018-03-08 13:54:53 +0900562
Robert Greenwalt2034b912009-08-12 16:08:25 -0700563 /**
Robert Greenwaltfaa4b402013-02-15 10:56:35 -0800564 * A SUPL-specific Mobile data connection. This network type may use the
565 * same network interface as {@link #TYPE_MOBILE} or it may use a different
566 * one. This is used by applications needing to talk to the carrier's
567 * Secure User Plane Location servers for help locating the device.
Lorenzo Colitti21e9a152015-04-23 15:32:42 +0900568 *
Chalard Jean7eaf3b12018-03-08 13:54:53 +0900569 * @deprecated Applications should instead use {@link NetworkCapabilities#hasCapability} or
Lorenzo Colitti7f6a2bf2015-04-24 17:03:31 +0900570 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request a network that
Lorenzo Colitti21e9a152015-04-23 15:32:42 +0900571 * provides the {@link NetworkCapabilities#NET_CAPABILITY_SUPL} capability.
Robert Greenwalt2034b912009-08-12 16:08:25 -0700572 */
Aurimas Liutikase80a0eb2016-05-24 15:22:55 -0700573 @Deprecated
Robert Greenwalt2034b912009-08-12 16:08:25 -0700574 public static final int TYPE_MOBILE_SUPL = 3;
Chalard Jean7eaf3b12018-03-08 13:54:53 +0900575
Robert Greenwalt2034b912009-08-12 16:08:25 -0700576 /**
Robert Greenwaltfaa4b402013-02-15 10:56:35 -0800577 * A DUN-specific Mobile data connection. This network type may use the
578 * same network interface as {@link #TYPE_MOBILE} or it may use a different
579 * one. This is sometimes by the system when setting up an upstream connection
580 * for tethering so that the carrier is aware of DUN traffic.
Chalard Jean7eaf3b12018-03-08 13:54:53 +0900581 *
582 * @deprecated Applications should instead use {@link NetworkCapabilities#hasCapability} or
583 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request a network that
584 * provides the {@link NetworkCapabilities#NET_CAPABILITY_DUN} capability.
Robert Greenwalt2034b912009-08-12 16:08:25 -0700585 */
Chalard Jean7eaf3b12018-03-08 13:54:53 +0900586 @Deprecated
Robert Greenwalt2034b912009-08-12 16:08:25 -0700587 public static final int TYPE_MOBILE_DUN = 4;
Chalard Jean7eaf3b12018-03-08 13:54:53 +0900588
Robert Greenwalt2034b912009-08-12 16:08:25 -0700589 /**
Robert Greenwaltfaa4b402013-02-15 10:56:35 -0800590 * A High Priority Mobile data connection. This network type uses the
591 * same network interface as {@link #TYPE_MOBILE} but the routing setup
Lorenzo Colitti21e9a152015-04-23 15:32:42 +0900592 * is different.
593 *
Chalard Jean7eaf3b12018-03-08 13:54:53 +0900594 * @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or
595 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an
596 * appropriate network. {@see NetworkCapabilities} for supported transports.
Robert Greenwalt2034b912009-08-12 16:08:25 -0700597 */
Aurimas Liutikase80a0eb2016-05-24 15:22:55 -0700598 @Deprecated
Robert Greenwalt2034b912009-08-12 16:08:25 -0700599 public static final int TYPE_MOBILE_HIPRI = 5;
Chalard Jean7eaf3b12018-03-08 13:54:53 +0900600
jshbfa81722010-03-11 15:04:43 -0800601 /**
Chalard Jean7eaf3b12018-03-08 13:54:53 +0900602 * A WiMAX data connection.
603 *
604 * @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or
605 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an
606 * appropriate network. {@see NetworkCapabilities} for supported transports.
jshbfa81722010-03-11 15:04:43 -0800607 */
Chalard Jean7eaf3b12018-03-08 13:54:53 +0900608 @Deprecated
jshbfa81722010-03-11 15:04:43 -0800609 public static final int TYPE_WIMAX = 6;
Robert Greenwalteb123ac2010-12-06 13:56:24 -0800610
Jaikumar Ganesh0db51a02010-12-21 22:31:44 -0800611 /**
Chalard Jean7eaf3b12018-03-08 13:54:53 +0900612 * A Bluetooth data connection.
613 *
614 * @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or
615 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an
616 * appropriate network. {@see NetworkCapabilities} for supported transports.
Jaikumar Ganesh0db51a02010-12-21 22:31:44 -0800617 */
Chalard Jean7eaf3b12018-03-08 13:54:53 +0900618 @Deprecated
Jaikumar Ganesh0db51a02010-12-21 22:31:44 -0800619 public static final int TYPE_BLUETOOTH = 7;
620
Robert Greenwaltf76c55d2011-04-22 15:28:18 -0700621 /**
Chiachang Wang3b9549f2020-07-28 13:53:09 +0800622 * Fake data connection. This should not be used on shipping devices.
Chalard Jean7eaf3b12018-03-08 13:54:53 +0900623 * @deprecated This is not used any more.
Robert Greenwaltf76c55d2011-04-22 15:28:18 -0700624 */
Chalard Jean7eaf3b12018-03-08 13:54:53 +0900625 @Deprecated
Jaikumar Ganesh0db51a02010-12-21 22:31:44 -0800626 public static final int TYPE_DUMMY = 8;
Wink Savilleb7c92c72011-03-12 14:52:01 -0800627
Robert Greenwaltf76c55d2011-04-22 15:28:18 -0700628 /**
Chalard Jean7eaf3b12018-03-08 13:54:53 +0900629 * An Ethernet data connection.
630 *
631 * @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or
632 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an
633 * appropriate network. {@see NetworkCapabilities} for supported transports.
Robert Greenwaltf76c55d2011-04-22 15:28:18 -0700634 */
Chalard Jean7eaf3b12018-03-08 13:54:53 +0900635 @Deprecated
Robert Greenwalt9d077812011-01-28 14:48:37 -0800636 public static final int TYPE_ETHERNET = 9;
Robert Greenwaltf76c55d2011-04-22 15:28:18 -0700637
Wink Savilleb7c92c72011-03-12 14:52:01 -0800638 /**
Robert Greenwaltfaa4b402013-02-15 10:56:35 -0800639 * Over the air Administration.
Chalard Jean7eaf3b12018-03-08 13:54:53 +0900640 * @deprecated Use {@link NetworkCapabilities} instead.
Wink Savilleb7c92c72011-03-12 14:52:01 -0800641 * {@hide}
642 */
Chalard Jean7eaf3b12018-03-08 13:54:53 +0900643 @Deprecated
Chalard Jeana3b77512019-04-09 15:46:21 +0900644 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 130143562)
Wink Savilleb7c92c72011-03-12 14:52:01 -0800645 public static final int TYPE_MOBILE_FOTA = 10;
646
647 /**
Robert Greenwaltfaa4b402013-02-15 10:56:35 -0800648 * IP Multimedia Subsystem.
Chalard Jean7eaf3b12018-03-08 13:54:53 +0900649 * @deprecated Use {@link NetworkCapabilities#NET_CAPABILITY_IMS} instead.
Wink Savilleb7c92c72011-03-12 14:52:01 -0800650 * {@hide}
651 */
Chalard Jean7eaf3b12018-03-08 13:54:53 +0900652 @Deprecated
Mathew Inwoodc5b9bec2018-08-08 14:52:47 +0100653 @UnsupportedAppUsage
Wink Savilleb7c92c72011-03-12 14:52:01 -0800654 public static final int TYPE_MOBILE_IMS = 11;
655
656 /**
Robert Greenwaltfaa4b402013-02-15 10:56:35 -0800657 * Carrier Branded Services.
Chalard Jean7eaf3b12018-03-08 13:54:53 +0900658 * @deprecated Use {@link NetworkCapabilities#NET_CAPABILITY_CBS} instead.
Wink Savilleb7c92c72011-03-12 14:52:01 -0800659 * {@hide}
660 */
Chalard Jean7eaf3b12018-03-08 13:54:53 +0900661 @Deprecated
Chalard Jeana3b77512019-04-09 15:46:21 +0900662 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 130143562)
Wink Savilleb7c92c72011-03-12 14:52:01 -0800663 public static final int TYPE_MOBILE_CBS = 12;
664
repo syncf5de5572011-07-29 23:55:49 -0700665 /**
666 * A Wi-Fi p2p connection. Only requesting processes will have access to
667 * the peers connected.
Chalard Jean7eaf3b12018-03-08 13:54:53 +0900668 * @deprecated Use {@link NetworkCapabilities#NET_CAPABILITY_WIFI_P2P} instead.
repo syncf5de5572011-07-29 23:55:49 -0700669 * {@hide}
670 */
Chalard Jean7eaf3b12018-03-08 13:54:53 +0900671 @Deprecated
paulhue102b0b2020-01-15 15:38:23 +0800672 @SystemApi
repo syncf5de5572011-07-29 23:55:49 -0700673 public static final int TYPE_WIFI_P2P = 13;
Wink Savilleb7c92c72011-03-12 14:52:01 -0800674
Wink Saville512c2202013-07-29 15:00:57 -0700675 /**
676 * The network to use for initially attaching to the network
Chalard Jean7eaf3b12018-03-08 13:54:53 +0900677 * @deprecated Use {@link NetworkCapabilities#NET_CAPABILITY_IA} instead.
Wink Saville512c2202013-07-29 15:00:57 -0700678 * {@hide}
679 */
Chalard Jean7eaf3b12018-03-08 13:54:53 +0900680 @Deprecated
Mathew Inwoodc5b9bec2018-08-08 14:52:47 +0100681 @UnsupportedAppUsage
Wink Saville512c2202013-07-29 15:00:57 -0700682 public static final int TYPE_MOBILE_IA = 14;
repo syncf5de5572011-07-29 23:55:49 -0700683
Lorenzo Colitti21e9a152015-04-23 15:32:42 +0900684 /**
Robert Greenwaltb1f7f752015-07-09 14:49:35 -0700685 * Emergency PDN connection for emergency services. This
686 * may include IMS and MMS in emergency situations.
Chalard Jean7eaf3b12018-03-08 13:54:53 +0900687 * @deprecated Use {@link NetworkCapabilities#NET_CAPABILITY_EIMS} instead.
Ram693d07a2014-06-26 11:03:44 -0700688 * {@hide}
689 */
Chalard Jean7eaf3b12018-03-08 13:54:53 +0900690 @Deprecated
Chalard Jeana3b77512019-04-09 15:46:21 +0900691 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 130143562)
Ram693d07a2014-06-26 11:03:44 -0700692 public static final int TYPE_MOBILE_EMERGENCY = 15;
693
Hui Lu865b70d2014-01-15 11:05:36 -0500694 /**
695 * The network that uses proxy to achieve connectivity.
Chalard Jean7eaf3b12018-03-08 13:54:53 +0900696 * @deprecated Use {@link NetworkCapabilities} instead.
Hui Lu865b70d2014-01-15 11:05:36 -0500697 * {@hide}
698 */
Chalard Jean7eaf3b12018-03-08 13:54:53 +0900699 @Deprecated
Remi NGUYEN VANee660cf2020-11-30 19:23:45 +0900700 @SystemApi
Hui Lu865b70d2014-01-15 11:05:36 -0500701 public static final int TYPE_PROXY = 16;
Wink Saville512c2202013-07-29 15:00:57 -0700702
Robert Greenwaltce7a1442014-07-07 17:09:01 -0700703 /**
704 * A virtual network using one or more native bearers.
705 * It may or may not be providing security services.
Chalard Jean7eaf3b12018-03-08 13:54:53 +0900706 * @deprecated Applications should use {@link NetworkCapabilities#TRANSPORT_VPN} instead.
Robert Greenwaltce7a1442014-07-07 17:09:01 -0700707 */
Chalard Jean7eaf3b12018-03-08 13:54:53 +0900708 @Deprecated
Robert Greenwaltce7a1442014-07-07 17:09:01 -0700709 public static final int TYPE_VPN = 17;
Hui Lu865b70d2014-01-15 11:05:36 -0500710
Benedict Wongbdfaa482018-11-14 17:40:55 -0800711 /**
712 * A network that is exclusively meant to be used for testing
713 *
714 * @deprecated Use {@link NetworkCapabilities} instead.
715 * @hide
716 */
717 @Deprecated
718 public static final int TYPE_TEST = 18; // TODO: Remove this once NetworkTypes are unused.
Robert Greenwaltce7a1442014-07-07 17:09:01 -0700719
Chalard Jeanaea539a2020-03-25 01:24:04 +0900720 /**
721 * @deprecated Use {@link NetworkCapabilities} instead.
722 * @hide
723 */
724 @Deprecated
725 @Retention(RetentionPolicy.SOURCE)
726 @IntDef(prefix = { "TYPE_" }, value = {
727 TYPE_NONE,
728 TYPE_MOBILE,
729 TYPE_WIFI,
730 TYPE_MOBILE_MMS,
731 TYPE_MOBILE_SUPL,
732 TYPE_MOBILE_DUN,
733 TYPE_MOBILE_HIPRI,
734 TYPE_WIMAX,
735 TYPE_BLUETOOTH,
736 TYPE_DUMMY,
737 TYPE_ETHERNET,
738 TYPE_MOBILE_FOTA,
739 TYPE_MOBILE_IMS,
740 TYPE_MOBILE_CBS,
741 TYPE_WIFI_P2P,
742 TYPE_MOBILE_IA,
743 TYPE_MOBILE_EMERGENCY,
744 TYPE_PROXY,
745 TYPE_VPN,
746 TYPE_TEST
747 })
748 public @interface LegacyNetworkType {}
749
Chalard Jeanafaed1a2019-11-21 14:48:00 +0900750 // Deprecated constants for return values of startUsingNetworkFeature. They used to live
751 // in com.android.internal.telephony.PhoneConstants until they were made inaccessible.
752 private static final int DEPRECATED_PHONE_CONSTANT_APN_ALREADY_ACTIVE = 0;
753 private static final int DEPRECATED_PHONE_CONSTANT_APN_REQUEST_STARTED = 1;
754 private static final int DEPRECATED_PHONE_CONSTANT_APN_REQUEST_FAILED = 3;
755
Robert Greenwaltce7a1442014-07-07 17:09:01 -0700756 /** {@hide} */
Benedict Wongbdfaa482018-11-14 17:40:55 -0800757 public static final int MAX_RADIO_TYPE = TYPE_TEST;
758
759 /** {@hide} */
760 public static final int MAX_NETWORK_TYPE = TYPE_TEST;
The Android Open Source Project28527d22009-03-03 19:31:44 -0800761
Hugo Benichiad353f42017-06-20 14:07:59 +0900762 private static final int MIN_NETWORK_TYPE = TYPE_MOBILE;
763
Jianzheng Zhou028d2032012-11-16 13:45:20 +0800764 /**
765 * If you want to set the default network preference,you can directly
766 * change the networkAttributes array in framework's config.xml.
767 *
768 * @deprecated Since we support so many more networks now, the single
769 * network default network preference can't really express
Robert Greenwaltfaa4b402013-02-15 10:56:35 -0800770 * the hierarchy. Instead, the default is defined by the
Jianzheng Zhou028d2032012-11-16 13:45:20 +0800771 * networkAttributes in config.xml. You can determine
Robert Greenwaltf909cb12012-12-07 09:56:50 -0800772 * the current value by calling {@link #getNetworkPreference()}
Jianzheng Zhou028d2032012-11-16 13:45:20 +0800773 * from an App.
774 */
775 @Deprecated
The Android Open Source Project28527d22009-03-03 19:31:44 -0800776 public static final int DEFAULT_NETWORK_PREFERENCE = TYPE_WIFI;
777
Jeff Sharkey8c870452012-09-26 22:03:49 -0700778 /**
Robert Greenwalt42a0e1e2014-03-19 17:56:12 -0700779 * @hide
780 */
Hugo Benichi7ab07a32017-06-20 14:10:14 +0900781 public static final int REQUEST_ID_UNSET = 0;
Robert Greenwaltbfd1f4c2014-06-08 16:42:59 -0700782
Paul Jensen5dea4352014-07-11 12:28:19 -0400783 /**
Hugo Benichibee30fe2017-06-17 13:14:12 +0900784 * Static unique request used as a tombstone for NetworkCallbacks that have been unregistered.
785 * This allows to distinguish when unregistering NetworkCallbacks those that were never
Chalard Jean9dd11612018-06-04 16:52:49 +0900786 * registered from those that were already unregistered.
Hugo Benichibee30fe2017-06-17 13:14:12 +0900787 * @hide
788 */
Hugo Benichi7ab07a32017-06-20 14:10:14 +0900789 private static final NetworkRequest ALREADY_UNREGISTERED =
Hugo Benichibee30fe2017-06-17 13:14:12 +0900790 new NetworkRequest.Builder().clearCapabilities().build();
791
792 /**
Paul Jensen5dea4352014-07-11 12:28:19 -0400793 * A NetID indicating no Network is selected.
794 * Keep in sync with bionic/libc/dns/include/resolv_netid.h
795 * @hide
796 */
797 public static final int NETID_UNSET = 0;
798
Erik Klineb0be3e62017-10-30 15:29:44 +0900799 /**
800 * Private DNS Mode values.
801 *
802 * The "private_dns_mode" global setting stores a String value which is
803 * expected to be one of the following.
804 */
805
806 /**
807 * @hide
808 */
lucaslin705c3332021-03-12 17:56:09 +0800809 @SystemApi(client = MODULE_LIBRARIES)
Erik Klineb0be3e62017-10-30 15:29:44 +0900810 public static final String PRIVATE_DNS_MODE_OFF = "off";
811 /**
812 * @hide
813 */
lucaslin705c3332021-03-12 17:56:09 +0800814 @SystemApi(client = MODULE_LIBRARIES)
Erik Klineb0be3e62017-10-30 15:29:44 +0900815 public static final String PRIVATE_DNS_MODE_OPPORTUNISTIC = "opportunistic";
816 /**
817 * @hide
818 */
lucaslin705c3332021-03-12 17:56:09 +0800819 @SystemApi(client = MODULE_LIBRARIES)
Erik Klineb0be3e62017-10-30 15:29:44 +0900820 public static final String PRIVATE_DNS_MODE_PROVIDER_HOSTNAME = "hostname";
lucaslin705c3332021-03-12 17:56:09 +0800821
822 /** @hide */
823 @Retention(RetentionPolicy.SOURCE)
824 @StringDef(value = {
825 PRIVATE_DNS_MODE_OFF,
826 PRIVATE_DNS_MODE_OPPORTUNISTIC,
827 PRIVATE_DNS_MODE_PROVIDER_HOSTNAME,
828 })
829 public @interface PrivateDnsMode {}
Erik Klineb0be3e62017-10-30 15:29:44 +0900830
Sudheer Shanka98215562021-03-23 08:12:28 +0000831 /**
832 * Flag to indicate that an app is not subject to any restrictions that could result in its
833 * network access blocked.
834 *
835 * @hide
836 */
837 @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
838 public static final int BLOCKED_REASON_NONE = 0;
839
840 /**
841 * Flag to indicate that an app is subject to Battery saver restrictions that would
842 * result in its network access being blocked.
843 *
844 * @hide
845 */
846 @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
847 public static final int BLOCKED_REASON_BATTERY_SAVER = 1 << 0;
848
849 /**
850 * Flag to indicate that an app is subject to Doze restrictions that would
851 * result in its network access being blocked.
852 *
853 * @hide
854 */
855 @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
856 public static final int BLOCKED_REASON_DOZE = 1 << 1;
857
858 /**
859 * Flag to indicate that an app is subject to App Standby restrictions that would
860 * result in its network access being blocked.
861 *
862 * @hide
863 */
864 @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
865 public static final int BLOCKED_REASON_APP_STANDBY = 1 << 2;
866
867 /**
868 * Flag to indicate that an app is subject to Restricted mode restrictions that would
869 * result in its network access being blocked.
870 *
871 * @hide
872 */
873 @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
874 public static final int BLOCKED_REASON_RESTRICTED_MODE = 1 << 3;
875
876 /**
Lorenzo Colitti79c6f222021-03-18 00:54:57 +0900877 * Flag to indicate that an app is blocked because it is subject to an always-on VPN but the VPN
878 * is not currently connected.
879 *
880 * @see DevicePolicyManager#setAlwaysOnVpnPackage(ComponentName, String, boolean)
881 *
882 * @hide
883 */
884 @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
885 public static final int BLOCKED_REASON_LOCKDOWN_VPN = 1 << 4;
886
887 /**
Sudheer Shanka98215562021-03-23 08:12:28 +0000888 * Flag to indicate that an app is subject to Data saver restrictions that would
889 * result in its metered network access being blocked.
890 *
891 * @hide
892 */
893 @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
894 public static final int BLOCKED_METERED_REASON_DATA_SAVER = 1 << 16;
895
896 /**
897 * Flag to indicate that an app is subject to user restrictions that would
898 * result in its metered network access being blocked.
899 *
900 * @hide
901 */
902 @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
903 public static final int BLOCKED_METERED_REASON_USER_RESTRICTED = 1 << 17;
904
905 /**
906 * Flag to indicate that an app is subject to Device admin restrictions that would
907 * result in its metered network access being blocked.
908 *
909 * @hide
910 */
911 @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
912 public static final int BLOCKED_METERED_REASON_ADMIN_DISABLED = 1 << 18;
913
914 /**
915 * @hide
916 */
917 @Retention(RetentionPolicy.SOURCE)
918 @IntDef(flag = true, prefix = {"BLOCKED_"}, value = {
919 BLOCKED_REASON_NONE,
920 BLOCKED_REASON_BATTERY_SAVER,
921 BLOCKED_REASON_DOZE,
922 BLOCKED_REASON_APP_STANDBY,
923 BLOCKED_REASON_RESTRICTED_MODE,
Lorenzo Colitti42fe2232021-03-25 23:17:36 +0900924 BLOCKED_REASON_LOCKDOWN_VPN,
Sudheer Shanka98215562021-03-23 08:12:28 +0000925 BLOCKED_METERED_REASON_DATA_SAVER,
926 BLOCKED_METERED_REASON_USER_RESTRICTED,
927 BLOCKED_METERED_REASON_ADMIN_DISABLED,
928 })
929 public @interface BlockedReason {}
930
Lorenzo Colitti79c6f222021-03-18 00:54:57 +0900931 /**
932 * Set of blocked reasons that are only applicable on metered networks.
933 *
934 * @hide
935 */
936 @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
937 public static final int BLOCKED_METERED_REASON_MASK = 0xffff0000;
938
Chalard Jeana3b77512019-04-09 15:46:21 +0900939 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 130143562)
Jeff Sharkey921ebf22011-05-19 17:12:49 -0700940 private final IConnectivityManager mService;
Lorenzo Colitticd675292021-02-04 17:32:07 +0900941
Paul Jensenc0618a62014-12-10 15:12:18 -0500942 /**
943 * A kludge to facilitate static access where a Context pointer isn't available, like in the
944 * case of the static set/getProcessDefaultNetwork methods and from the Network class.
945 * TODO: Remove this after deprecating the static methods in favor of non-static methods or
946 * methods that take a Context argument.
947 */
948 private static ConnectivityManager sInstance;
The Android Open Source Project28527d22009-03-03 19:31:44 -0800949
Lorenzo Colitti2780e4b2015-07-29 11:41:21 +0900950 private final Context mContext;
951
Amos Bianchia9b415a2020-03-04 11:07:38 -0800952 private final TetheringManager mTetheringManager;
Dianne Hackborn5ac88162014-02-26 16:20:52 -0800953
Robert Greenwaltfaa4b402013-02-15 10:56:35 -0800954 /**
955 * Tests if a given integer represents a valid network type.
956 * @param networkType the type to be tested
957 * @return a boolean. {@code true} if the type is valid, else {@code false}
Paul Jensenbbb61092015-05-06 10:42:25 -0400958 * @deprecated All APIs accepting a network type are deprecated. There should be no need to
959 * validate a network type.
Robert Greenwaltfaa4b402013-02-15 10:56:35 -0800960 */
Aurimas Liutikase80a0eb2016-05-24 15:22:55 -0700961 @Deprecated
Jeff Sharkey21062e72011-05-28 20:56:34 -0700962 public static boolean isNetworkTypeValid(int networkType) {
Hugo Benichiad353f42017-06-20 14:07:59 +0900963 return MIN_NETWORK_TYPE <= networkType && networkType <= MAX_NETWORK_TYPE;
The Android Open Source Project28527d22009-03-03 19:31:44 -0800964 }
965
Robert Greenwaltfaa4b402013-02-15 10:56:35 -0800966 /**
967 * Returns a non-localized string representing a given network type.
968 * ONLY used for debugging output.
969 * @param type the type needing naming
970 * @return a String for the given type, or a string version of the type ("87")
971 * if no name is known.
Chalard Jean7eaf3b12018-03-08 13:54:53 +0900972 * @deprecated Types are deprecated. Use {@link NetworkCapabilities} instead.
Robert Greenwaltfaa4b402013-02-15 10:56:35 -0800973 * {@hide}
974 */
Chalard Jean7eaf3b12018-03-08 13:54:53 +0900975 @Deprecated
Mathew Inwoode1a17ba2020-11-04 09:29:36 +0000976 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
Jeff Sharkey21062e72011-05-28 20:56:34 -0700977 public static String getNetworkTypeName(int type) {
978 switch (type) {
Hugo Benichiad353f42017-06-20 14:07:59 +0900979 case TYPE_NONE:
980 return "NONE";
Jeff Sharkey21062e72011-05-28 20:56:34 -0700981 case TYPE_MOBILE:
982 return "MOBILE";
983 case TYPE_WIFI:
984 return "WIFI";
985 case TYPE_MOBILE_MMS:
986 return "MOBILE_MMS";
987 case TYPE_MOBILE_SUPL:
988 return "MOBILE_SUPL";
989 case TYPE_MOBILE_DUN:
990 return "MOBILE_DUN";
991 case TYPE_MOBILE_HIPRI:
992 return "MOBILE_HIPRI";
993 case TYPE_WIMAX:
994 return "WIMAX";
995 case TYPE_BLUETOOTH:
996 return "BLUETOOTH";
997 case TYPE_DUMMY:
998 return "DUMMY";
999 case TYPE_ETHERNET:
1000 return "ETHERNET";
1001 case TYPE_MOBILE_FOTA:
1002 return "MOBILE_FOTA";
1003 case TYPE_MOBILE_IMS:
1004 return "MOBILE_IMS";
1005 case TYPE_MOBILE_CBS:
1006 return "MOBILE_CBS";
repo syncf5de5572011-07-29 23:55:49 -07001007 case TYPE_WIFI_P2P:
1008 return "WIFI_P2P";
Wink Saville512c2202013-07-29 15:00:57 -07001009 case TYPE_MOBILE_IA:
1010 return "MOBILE_IA";
Ram693d07a2014-06-26 11:03:44 -07001011 case TYPE_MOBILE_EMERGENCY:
1012 return "MOBILE_EMERGENCY";
Hui Lu865b70d2014-01-15 11:05:36 -05001013 case TYPE_PROXY:
1014 return "PROXY";
Erik Kline137fadc2014-11-19 17:23:41 +09001015 case TYPE_VPN:
1016 return "VPN";
Jeff Sharkey21062e72011-05-28 20:56:34 -07001017 default:
1018 return Integer.toString(type);
1019 }
1020 }
1021
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08001022 /**
Aaron Huang96011892020-06-27 07:18:23 +08001023 * @hide
Aaron Huang96011892020-06-27 07:18:23 +08001024 */
lucaslin7fc930b2021-03-17 14:16:01 +08001025 @SystemApi(client = MODULE_LIBRARIES)
Aaron Huang96011892020-06-27 07:18:23 +08001026 public void systemReady() {
1027 try {
1028 mService.systemReady();
1029 } catch (RemoteException e) {
1030 throw e.rethrowFromSystemServer();
1031 }
1032 }
1033
1034 /**
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08001035 * Checks if a given type uses the cellular data connection.
1036 * This should be replaced in the future by a network property.
1037 * @param networkType the type to check
1038 * @return a boolean - {@code true} if uses cellular network, else {@code false}
Chalard Jean7eaf3b12018-03-08 13:54:53 +09001039 * @deprecated Types are deprecated. Use {@link NetworkCapabilities} instead.
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08001040 * {@hide}
1041 */
Chalard Jean7eaf3b12018-03-08 13:54:53 +09001042 @Deprecated
Chalard Jeana3b77512019-04-09 15:46:21 +09001043 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 130143562)
Jeff Sharkey21062e72011-05-28 20:56:34 -07001044 public static boolean isNetworkTypeMobile(int networkType) {
1045 switch (networkType) {
1046 case TYPE_MOBILE:
1047 case TYPE_MOBILE_MMS:
1048 case TYPE_MOBILE_SUPL:
1049 case TYPE_MOBILE_DUN:
1050 case TYPE_MOBILE_HIPRI:
1051 case TYPE_MOBILE_FOTA:
1052 case TYPE_MOBILE_IMS:
1053 case TYPE_MOBILE_CBS:
Wink Saville512c2202013-07-29 15:00:57 -07001054 case TYPE_MOBILE_IA:
Ram693d07a2014-06-26 11:03:44 -07001055 case TYPE_MOBILE_EMERGENCY:
Jeff Sharkey21062e72011-05-28 20:56:34 -07001056 return true;
1057 default:
1058 return false;
1059 }
1060 }
1061
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08001062 /**
Jeff Sharkey79f3e022013-06-04 12:29:00 -07001063 * Checks if the given network type is backed by a Wi-Fi radio.
1064 *
Chalard Jean7eaf3b12018-03-08 13:54:53 +09001065 * @deprecated Types are deprecated. Use {@link NetworkCapabilities} instead.
Jeff Sharkey79f3e022013-06-04 12:29:00 -07001066 * @hide
1067 */
Chalard Jean7eaf3b12018-03-08 13:54:53 +09001068 @Deprecated
Jeff Sharkey79f3e022013-06-04 12:29:00 -07001069 public static boolean isNetworkTypeWifi(int networkType) {
1070 switch (networkType) {
1071 case TYPE_WIFI:
1072 case TYPE_WIFI_P2P:
1073 return true;
1074 default:
1075 return false;
1076 }
1077 }
1078
1079 /**
Chalard Jeanfa45a682021-02-25 17:23:40 +09001080 * Preference for {@link #setNetworkPreferenceForUser(UserHandle, int, Executor, Runnable)}.
1081 * Specify that the traffic for this user should by follow the default rules.
1082 * @hide
1083 */
Chalard Jeanb43f3962021-03-17 14:33:24 +09001084 @SystemApi(client = MODULE_LIBRARIES)
Chalard Jeanfa45a682021-02-25 17:23:40 +09001085 public static final int PROFILE_NETWORK_PREFERENCE_DEFAULT = 0;
1086
1087 /**
1088 * Preference for {@link #setNetworkPreferenceForUser(UserHandle, int, Executor, Runnable)}.
1089 * Specify that the traffic for this user should by default go on a network with
1090 * {@link NetworkCapabilities#NET_CAPABILITY_ENTERPRISE}, and on the system default network
1091 * if no such network is available.
1092 * @hide
1093 */
Chalard Jeanb43f3962021-03-17 14:33:24 +09001094 @SystemApi(client = MODULE_LIBRARIES)
Chalard Jeanfa45a682021-02-25 17:23:40 +09001095 public static final int PROFILE_NETWORK_PREFERENCE_ENTERPRISE = 1;
1096
1097 /** @hide */
1098 @Retention(RetentionPolicy.SOURCE)
1099 @IntDef(value = {
1100 PROFILE_NETWORK_PREFERENCE_DEFAULT,
1101 PROFILE_NETWORK_PREFERENCE_ENTERPRISE
1102 })
1103 public @interface ProfileNetworkPreference {
1104 }
1105
1106 /**
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08001107 * Specifies the preferred network type. When the device has more
1108 * than one type available the preferred network type will be used.
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08001109 *
1110 * @param preference the network type to prefer over all others. It is
1111 * unspecified what happens to the old preferred network in the
1112 * overall ordering.
Robert Greenwaltf3017f72014-05-18 23:07:25 -07001113 * @deprecated Functionality has been removed as it no longer makes sense,
1114 * with many more than two networks - we'd need an array to express
1115 * preference. Instead we use dynamic network properties of
1116 * the networks to describe their precedence.
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08001117 */
Aurimas Liutikase80a0eb2016-05-24 15:22:55 -07001118 @Deprecated
The Android Open Source Project28527d22009-03-03 19:31:44 -08001119 public void setNetworkPreference(int preference) {
The Android Open Source Project28527d22009-03-03 19:31:44 -08001120 }
1121
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08001122 /**
1123 * Retrieves the current preferred network type.
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08001124 *
1125 * @return an integer representing the preferred network type
1126 *
Robert Greenwaltf3017f72014-05-18 23:07:25 -07001127 * @deprecated Functionality has been removed as it no longer makes sense,
1128 * with many more than two networks - we'd need an array to express
1129 * preference. Instead we use dynamic network properties of
1130 * the networks to describe their precedence.
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08001131 */
Aurimas Liutikase80a0eb2016-05-24 15:22:55 -07001132 @Deprecated
Jeff Sharkey656584a2017-04-24 11:18:03 -06001133 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
The Android Open Source Project28527d22009-03-03 19:31:44 -08001134 public int getNetworkPreference() {
Robert Greenwaltf3017f72014-05-18 23:07:25 -07001135 return TYPE_NONE;
The Android Open Source Project28527d22009-03-03 19:31:44 -08001136 }
1137
Scott Mainf58b7d82011-10-06 19:02:28 -07001138 /**
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08001139 * Returns details about the currently active default data network. When
1140 * connected, this network is the default route for outgoing connections.
1141 * You should always check {@link NetworkInfo#isConnected()} before initiating
1142 * network traffic. This may return {@code null} when there is no default
1143 * network.
Chalard Jean96d10a72018-03-29 17:45:24 +09001144 * Note that if the default network is a VPN, this method will return the
1145 * NetworkInfo for one of its underlying networks instead, or null if the
1146 * VPN agent did not specify any. Apps interested in learning about VPNs
1147 * should use {@link #getNetworkInfo(android.net.Network)} instead.
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08001148 *
1149 * @return a {@link NetworkInfo} object for the current default network
Paul Jensenbd2d3782015-02-13 14:18:39 -05001150 * or {@code null} if no default network is currently active
junyulai9826e7f2018-12-13 12:47:51 +08001151 * @deprecated See {@link NetworkInfo}.
Jeff Sharkeyd00b1302012-04-12 18:34:54 -07001152 */
junyulai9826e7f2018-12-13 12:47:51 +08001153 @Deprecated
Jeff Sharkey656584a2017-04-24 11:18:03 -06001154 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean158702d2019-01-07 19:26:34 +09001155 @Nullable
The Android Open Source Project28527d22009-03-03 19:31:44 -08001156 public NetworkInfo getActiveNetworkInfo() {
1157 try {
1158 return mService.getActiveNetworkInfo();
1159 } catch (RemoteException e) {
Jeff Sharkeyc78f85c2016-03-01 19:27:23 -07001160 throw e.rethrowFromSystemServer();
The Android Open Source Project28527d22009-03-03 19:31:44 -08001161 }
1162 }
1163
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08001164 /**
Paul Jensen1f567382015-02-13 14:18:39 -05001165 * Returns a {@link Network} object corresponding to the currently active
1166 * default data network. In the event that the current active default data
1167 * network disconnects, the returned {@code Network} object will no longer
1168 * be usable. This will return {@code null} when there is no default
1169 * network.
1170 *
1171 * @return a {@link Network} object for the current default network or
1172 * {@code null} if no default network is currently active
Paul Jensen1f567382015-02-13 14:18:39 -05001173 */
Jeff Sharkey656584a2017-04-24 11:18:03 -06001174 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean158702d2019-01-07 19:26:34 +09001175 @Nullable
Paul Jensen1f567382015-02-13 14:18:39 -05001176 public Network getActiveNetwork() {
1177 try {
1178 return mService.getActiveNetwork();
1179 } catch (RemoteException e) {
Jeff Sharkeyc78f85c2016-03-01 19:27:23 -07001180 throw e.rethrowFromSystemServer();
Paul Jensen1f567382015-02-13 14:18:39 -05001181 }
1182 }
1183
1184 /**
Robin Lee5b52bef2016-03-24 12:07:00 +00001185 * Returns a {@link Network} object corresponding to the currently active
1186 * default data network for a specific UID. In the event that the default data
1187 * network disconnects, the returned {@code Network} object will no longer
1188 * be usable. This will return {@code null} when there is no default
1189 * network for the UID.
Robin Lee5b52bef2016-03-24 12:07:00 +00001190 *
1191 * @return a {@link Network} object for the current default network for the
1192 * given UID or {@code null} if no default network is currently active
lifr42a60c22021-03-11 20:11:09 +08001193 * TODO: b/183465229 Cleanup getActiveNetworkForUid once b/165835257 is fixed
Robin Lee5b52bef2016-03-24 12:07:00 +00001194 */
paulhu8e96a752019-08-12 16:25:11 +08001195 @RequiresPermission(android.Manifest.permission.NETWORK_STACK)
Chalard Jean158702d2019-01-07 19:26:34 +09001196 @Nullable
Robin Lee5b52bef2016-03-24 12:07:00 +00001197 public Network getActiveNetworkForUid(int uid) {
Jeff Sharkey7dbf83d2016-04-28 15:33:18 -06001198 return getActiveNetworkForUid(uid, false);
1199 }
1200
1201 /** {@hide} */
1202 public Network getActiveNetworkForUid(int uid, boolean ignoreBlocked) {
Robin Lee5b52bef2016-03-24 12:07:00 +00001203 try {
Jeff Sharkey7dbf83d2016-04-28 15:33:18 -06001204 return mService.getActiveNetworkForUid(uid, ignoreBlocked);
Robin Lee5b52bef2016-03-24 12:07:00 +00001205 } catch (RemoteException e) {
1206 throw e.rethrowFromSystemServer();
1207 }
1208 }
1209
1210 /**
Lorenzo Colitti3f54f102020-12-12 00:51:11 +09001211 * Adds or removes a requirement for given UID ranges to use the VPN.
1212 *
1213 * If set to {@code true}, informs the system that the UIDs in the specified ranges must not
1214 * have any connectivity except if a VPN is connected and applies to the UIDs, or if the UIDs
1215 * otherwise have permission to bypass the VPN (e.g., because they have the
1216 * {@link android.Manifest.permission.CONNECTIVITY_USE_RESTRICTED_NETWORKS} permission, or when
1217 * using a socket protected by a method such as {@link VpnService#protect(DatagramSocket)}. If
1218 * set to {@code false}, a previously-added restriction is removed.
1219 * <p>
1220 * Each of the UID ranges specified by this method is added and removed as is, and no processing
1221 * is performed on the ranges to de-duplicate, merge, split, or intersect them. In order to
1222 * remove a previously-added range, the exact range must be removed as is.
1223 * <p>
1224 * The changes are applied asynchronously and may not have been applied by the time the method
1225 * returns. Apps will be notified about any changes that apply to them via
1226 * {@link NetworkCallback#onBlockedStatusChanged} callbacks called after the changes take
1227 * effect.
1228 * <p>
1229 * This method should be called only by the VPN code.
1230 *
1231 * @param ranges the UID ranges to restrict
1232 * @param requireVpn whether the specified UID ranges must use a VPN
1233 *
Lorenzo Colitti3f54f102020-12-12 00:51:11 +09001234 * @hide
1235 */
1236 @RequiresPermission(anyOf = {
1237 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
lucasline257bce2021-03-22 11:51:27 +08001238 android.Manifest.permission.NETWORK_STACK,
1239 android.Manifest.permission.NETWORK_SETTINGS})
1240 @SystemApi(client = MODULE_LIBRARIES)
Lorenzo Colitti3f54f102020-12-12 00:51:11 +09001241 public void setRequireVpnForUids(boolean requireVpn,
1242 @NonNull Collection<Range<Integer>> ranges) {
1243 Objects.requireNonNull(ranges);
1244 // The Range class is not parcelable. Convert to UidRange, which is what is used internally.
1245 // This method is not necessarily expected to be used outside the system server, so
1246 // parceling may not be necessary, but it could be used out-of-process, e.g., by the network
1247 // stack process, or by tests.
1248 UidRange[] rangesArray = new UidRange[ranges.size()];
1249 int index = 0;
1250 for (Range<Integer> range : ranges) {
1251 rangesArray[index++] = new UidRange(range.getLower(), range.getUpper());
1252 }
1253 try {
1254 mService.setRequireVpnForUids(requireVpn, rangesArray);
1255 } catch (RemoteException e) {
1256 throw e.rethrowFromSystemServer();
1257 }
1258 }
1259
1260 /**
Lorenzo Colittibcd692f2021-01-15 01:29:01 +09001261 * Informs ConnectivityService of whether the legacy lockdown VPN, as implemented by
1262 * LockdownVpnTracker, is in use. This is deprecated for new devices starting from Android 12
1263 * but is still supported for backwards compatibility.
1264 * <p>
1265 * This type of VPN is assumed always to use the system default network, and must always declare
1266 * exactly one underlying network, which is the network that was the default when the VPN
1267 * connected.
1268 * <p>
1269 * Calling this method with {@code true} enables legacy behaviour, specifically:
1270 * <ul>
1271 * <li>Any VPN that applies to userId 0 behaves specially with respect to deprecated
1272 * {@link #CONNECTIVITY_ACTION} broadcasts. Any such broadcasts will have the state in the
1273 * {@link #EXTRA_NETWORK_INFO} replaced by state of the VPN network. Also, any time the VPN
1274 * connects, a {@link #CONNECTIVITY_ACTION} broadcast will be sent for the network
1275 * underlying the VPN.</li>
1276 * <li>Deprecated APIs that return {@link NetworkInfo} objects will have their state
1277 * similarly replaced by the VPN network state.</li>
1278 * <li>Information on current network interfaces passed to NetworkStatsService will not
1279 * include any VPN interfaces.</li>
1280 * </ul>
1281 *
1282 * @param enabled whether legacy lockdown VPN is enabled or disabled
1283 *
Lorenzo Colittibcd692f2021-01-15 01:29:01 +09001284 * @hide
1285 */
1286 @RequiresPermission(anyOf = {
1287 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
lucasline257bce2021-03-22 11:51:27 +08001288 android.Manifest.permission.NETWORK_STACK,
Lorenzo Colittibcd692f2021-01-15 01:29:01 +09001289 android.Manifest.permission.NETWORK_SETTINGS})
lucasline257bce2021-03-22 11:51:27 +08001290 @SystemApi(client = MODULE_LIBRARIES)
Lorenzo Colittibcd692f2021-01-15 01:29:01 +09001291 public void setLegacyLockdownVpnEnabled(boolean enabled) {
1292 try {
1293 mService.setLegacyLockdownVpnEnabled(enabled);
1294 } catch (RemoteException e) {
1295 throw e.rethrowFromSystemServer();
1296 }
1297 }
1298
1299 /**
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08001300 * Returns details about the currently active default data network
1301 * for a given uid. This is for internal use only to avoid spying
1302 * other apps.
1303 *
1304 * @return a {@link NetworkInfo} object for the current default network
1305 * for the given uid or {@code null} if no default network is
1306 * available for the specified uid.
1307 *
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08001308 * {@hide}
1309 */
paulhu8e96a752019-08-12 16:25:11 +08001310 @RequiresPermission(android.Manifest.permission.NETWORK_STACK)
Mathew Inwoode1a17ba2020-11-04 09:29:36 +00001311 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
Jeff Sharkey921ebf22011-05-19 17:12:49 -07001312 public NetworkInfo getActiveNetworkInfoForUid(int uid) {
Jeff Sharkey7dbf83d2016-04-28 15:33:18 -06001313 return getActiveNetworkInfoForUid(uid, false);
1314 }
1315
1316 /** {@hide} */
1317 public NetworkInfo getActiveNetworkInfoForUid(int uid, boolean ignoreBlocked) {
Jeff Sharkey921ebf22011-05-19 17:12:49 -07001318 try {
Jeff Sharkey7dbf83d2016-04-28 15:33:18 -06001319 return mService.getActiveNetworkInfoForUid(uid, ignoreBlocked);
Jeff Sharkey921ebf22011-05-19 17:12:49 -07001320 } catch (RemoteException e) {
Jeff Sharkeyc78f85c2016-03-01 19:27:23 -07001321 throw e.rethrowFromSystemServer();
Jeff Sharkey921ebf22011-05-19 17:12:49 -07001322 }
1323 }
1324
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08001325 /**
1326 * Returns connection status information about a particular
1327 * network type.
1328 *
1329 * @param networkType integer specifying which networkType in
1330 * which you're interested.
1331 * @return a {@link NetworkInfo} object for the requested
1332 * network type or {@code null} if the type is not
Chalard Jean96d10a72018-03-29 17:45:24 +09001333 * supported by the device. If {@code networkType} is
1334 * TYPE_VPN and a VPN is active for the calling app,
1335 * then this method will try to return one of the
1336 * underlying networks for the VPN or null if the
1337 * VPN agent didn't specify any.
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08001338 *
Paul Jensendda8e592015-03-18 12:23:02 -04001339 * @deprecated This method does not support multiple connected networks
1340 * of the same type. Use {@link #getAllNetworks} and
1341 * {@link #getNetworkInfo(android.net.Network)} instead.
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08001342 */
Aurimas Liutikase80a0eb2016-05-24 15:22:55 -07001343 @Deprecated
Jeff Sharkey656584a2017-04-24 11:18:03 -06001344 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean158702d2019-01-07 19:26:34 +09001345 @Nullable
The Android Open Source Project28527d22009-03-03 19:31:44 -08001346 public NetworkInfo getNetworkInfo(int networkType) {
1347 try {
1348 return mService.getNetworkInfo(networkType);
1349 } catch (RemoteException e) {
Jeff Sharkeyc78f85c2016-03-01 19:27:23 -07001350 throw e.rethrowFromSystemServer();
The Android Open Source Project28527d22009-03-03 19:31:44 -08001351 }
1352 }
1353
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08001354 /**
Robert Greenwalt02fe11e2014-06-23 11:40:00 -07001355 * Returns connection status information about a particular
1356 * Network.
1357 *
1358 * @param network {@link Network} specifying which network
1359 * in which you're interested.
1360 * @return a {@link NetworkInfo} object for the requested
1361 * network or {@code null} if the {@code Network}
1362 * is not valid.
junyulai9826e7f2018-12-13 12:47:51 +08001363 * @deprecated See {@link NetworkInfo}.
Robert Greenwalt02fe11e2014-06-23 11:40:00 -07001364 */
junyulai9826e7f2018-12-13 12:47:51 +08001365 @Deprecated
Jeff Sharkey656584a2017-04-24 11:18:03 -06001366 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean158702d2019-01-07 19:26:34 +09001367 @Nullable
1368 public NetworkInfo getNetworkInfo(@Nullable Network network) {
Jeff Sharkey7dbf83d2016-04-28 15:33:18 -06001369 return getNetworkInfoForUid(network, Process.myUid(), false);
1370 }
1371
1372 /** {@hide} */
1373 public NetworkInfo getNetworkInfoForUid(Network network, int uid, boolean ignoreBlocked) {
Robert Greenwalt02fe11e2014-06-23 11:40:00 -07001374 try {
Jeff Sharkey7dbf83d2016-04-28 15:33:18 -06001375 return mService.getNetworkInfoForUid(network, uid, ignoreBlocked);
Robert Greenwalt02fe11e2014-06-23 11:40:00 -07001376 } catch (RemoteException e) {
Jeff Sharkeyc78f85c2016-03-01 19:27:23 -07001377 throw e.rethrowFromSystemServer();
Robert Greenwalt02fe11e2014-06-23 11:40:00 -07001378 }
1379 }
1380
1381 /**
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08001382 * Returns connection status information about all network
1383 * types supported by the device.
1384 *
1385 * @return an array of {@link NetworkInfo} objects. Check each
1386 * {@link NetworkInfo#getType} for which type each applies.
1387 *
Paul Jensendda8e592015-03-18 12:23:02 -04001388 * @deprecated This method does not support multiple connected networks
1389 * of the same type. Use {@link #getAllNetworks} and
1390 * {@link #getNetworkInfo(android.net.Network)} instead.
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08001391 */
Aurimas Liutikase80a0eb2016-05-24 15:22:55 -07001392 @Deprecated
Jeff Sharkey656584a2017-04-24 11:18:03 -06001393 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean158702d2019-01-07 19:26:34 +09001394 @NonNull
The Android Open Source Project28527d22009-03-03 19:31:44 -08001395 public NetworkInfo[] getAllNetworkInfo() {
1396 try {
1397 return mService.getAllNetworkInfo();
1398 } catch (RemoteException e) {
Jeff Sharkeyc78f85c2016-03-01 19:27:23 -07001399 throw e.rethrowFromSystemServer();
The Android Open Source Project28527d22009-03-03 19:31:44 -08001400 }
1401 }
1402
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08001403 /**
junyulaiebd15162021-03-03 12:09:05 +08001404 * Return a list of {@link NetworkStateSnapshot}s, one for each network that is currently
1405 * connected.
1406 * @hide
1407 */
1408 @SystemApi(client = MODULE_LIBRARIES)
1409 @RequiresPermission(anyOf = {
1410 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
1411 android.Manifest.permission.NETWORK_STACK,
1412 android.Manifest.permission.NETWORK_SETTINGS})
1413 @NonNull
1414 public List<NetworkStateSnapshot> getAllNetworkStateSnapshot() {
1415 try {
1416 return mService.getAllNetworkStateSnapshot();
1417 } catch (RemoteException e) {
1418 throw e.rethrowFromSystemServer();
1419 }
1420 }
1421
1422 /**
Lorenzo Colitti860a7aa2014-08-22 17:10:50 -07001423 * Returns the {@link Network} object currently serving a given type, or
1424 * null if the given type is not connected.
1425 *
Lorenzo Colitti860a7aa2014-08-22 17:10:50 -07001426 * @hide
Paul Jensendda8e592015-03-18 12:23:02 -04001427 * @deprecated This method does not support multiple connected networks
1428 * of the same type. Use {@link #getAllNetworks} and
1429 * {@link #getNetworkInfo(android.net.Network)} instead.
Lorenzo Colitti860a7aa2014-08-22 17:10:50 -07001430 */
Aurimas Liutikase80a0eb2016-05-24 15:22:55 -07001431 @Deprecated
Jeff Sharkey656584a2017-04-24 11:18:03 -06001432 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Mathew Inwoodc5b9bec2018-08-08 14:52:47 +01001433 @UnsupportedAppUsage
Lorenzo Colitti860a7aa2014-08-22 17:10:50 -07001434 public Network getNetworkForType(int networkType) {
1435 try {
1436 return mService.getNetworkForType(networkType);
1437 } catch (RemoteException e) {
Jeff Sharkeyc78f85c2016-03-01 19:27:23 -07001438 throw e.rethrowFromSystemServer();
Lorenzo Colitti860a7aa2014-08-22 17:10:50 -07001439 }
1440 }
1441
1442 /**
Robert Greenwalt02fe11e2014-06-23 11:40:00 -07001443 * Returns an array of all {@link Network} currently tracked by the
1444 * framework.
Paul Jensen08f9dbb2015-05-06 11:10:18 -04001445 *
1446 * @return an array of {@link Network} objects.
Robert Greenwalt02fe11e2014-06-23 11:40:00 -07001447 */
Jeff Sharkey656584a2017-04-24 11:18:03 -06001448 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean158702d2019-01-07 19:26:34 +09001449 @NonNull
Robert Greenwalt02fe11e2014-06-23 11:40:00 -07001450 public Network[] getAllNetworks() {
1451 try {
1452 return mService.getAllNetworks();
1453 } catch (RemoteException e) {
Jeff Sharkeyc78f85c2016-03-01 19:27:23 -07001454 throw e.rethrowFromSystemServer();
Robert Greenwalt02fe11e2014-06-23 11:40:00 -07001455 }
1456 }
1457
1458 /**
Roshan Pius951c0032020-12-22 15:10:42 -08001459 * Returns an array of {@link NetworkCapabilities} objects, representing
Lorenzo Colitti79bd2e22014-11-28 11:21:30 +09001460 * the Networks that applications run by the given user will use by default.
1461 * @hide
1462 */
Mathew Inwoodc5b9bec2018-08-08 14:52:47 +01001463 @UnsupportedAppUsage
Lorenzo Colitti79bd2e22014-11-28 11:21:30 +09001464 public NetworkCapabilities[] getDefaultNetworkCapabilitiesForUser(int userId) {
1465 try {
Qingxi Lib2748102020-01-08 12:51:49 -08001466 return mService.getDefaultNetworkCapabilitiesForUser(
Roshan Piusaa24fde2020-12-17 14:53:09 -08001467 userId, mContext.getOpPackageName(), getAttributionTag());
Lorenzo Colitti79bd2e22014-11-28 11:21:30 +09001468 } catch (RemoteException e) {
Jeff Sharkeyc78f85c2016-03-01 19:27:23 -07001469 throw e.rethrowFromSystemServer();
Lorenzo Colitti79bd2e22014-11-28 11:21:30 +09001470 }
1471 }
1472
1473 /**
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08001474 * Returns the IP information for the current default network.
1475 *
1476 * @return a {@link LinkProperties} object describing the IP info
1477 * for the current default network, or {@code null} if there
1478 * is no current default network.
1479 *
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08001480 * {@hide}
Chalard Jean97021a12019-01-11 16:47:53 +09001481 * @deprecated please use {@link #getLinkProperties(Network)} on the return
1482 * value of {@link #getActiveNetwork()} instead. In particular,
1483 * this method will return non-null LinkProperties even if the
1484 * app is blocked by policy from using this network.
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08001485 */
Jeff Sharkey656584a2017-04-24 11:18:03 -06001486 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean97021a12019-01-11 16:47:53 +09001487 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 109783091)
Robert Greenwalt9f0ee4f2010-09-14 09:18:02 -07001488 public LinkProperties getActiveLinkProperties() {
1489 try {
1490 return mService.getActiveLinkProperties();
1491 } catch (RemoteException e) {
Jeff Sharkeyc78f85c2016-03-01 19:27:23 -07001492 throw e.rethrowFromSystemServer();
Robert Greenwalt9f0ee4f2010-09-14 09:18:02 -07001493 }
1494 }
1495
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08001496 /**
1497 * Returns the IP information for a given network type.
1498 *
1499 * @param networkType the network type of interest.
1500 * @return a {@link LinkProperties} object describing the IP info
1501 * for the given networkType, or {@code null} if there is
1502 * no current default network.
1503 *
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08001504 * {@hide}
Paul Jensendda8e592015-03-18 12:23:02 -04001505 * @deprecated This method does not support multiple connected networks
1506 * of the same type. Use {@link #getAllNetworks},
1507 * {@link #getNetworkInfo(android.net.Network)}, and
1508 * {@link #getLinkProperties(android.net.Network)} instead.
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08001509 */
Aurimas Liutikase80a0eb2016-05-24 15:22:55 -07001510 @Deprecated
Jeff Sharkey656584a2017-04-24 11:18:03 -06001511 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jeana3b77512019-04-09 15:46:21 +09001512 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 130143562)
Robert Greenwalt9f0ee4f2010-09-14 09:18:02 -07001513 public LinkProperties getLinkProperties(int networkType) {
1514 try {
Robert Greenwaltf99b8392014-03-26 16:47:06 -07001515 return mService.getLinkPropertiesForType(networkType);
1516 } catch (RemoteException e) {
Jeff Sharkeyc78f85c2016-03-01 19:27:23 -07001517 throw e.rethrowFromSystemServer();
Robert Greenwaltf99b8392014-03-26 16:47:06 -07001518 }
1519 }
1520
Robert Greenwaltf3017f72014-05-18 23:07:25 -07001521 /**
1522 * Get the {@link LinkProperties} for the given {@link Network}. This
1523 * will return {@code null} if the network is unknown.
1524 *
1525 * @param network The {@link Network} object identifying the network in question.
1526 * @return The {@link LinkProperties} for the network, or {@code null}.
Paul Jensen08f9dbb2015-05-06 11:10:18 -04001527 */
Jeff Sharkey656584a2017-04-24 11:18:03 -06001528 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean158702d2019-01-07 19:26:34 +09001529 @Nullable
1530 public LinkProperties getLinkProperties(@Nullable Network network) {
Robert Greenwaltf99b8392014-03-26 16:47:06 -07001531 try {
1532 return mService.getLinkProperties(network);
1533 } catch (RemoteException e) {
Jeff Sharkeyc78f85c2016-03-01 19:27:23 -07001534 throw e.rethrowFromSystemServer();
Robert Greenwaltf99b8392014-03-26 16:47:06 -07001535 }
1536 }
1537
Robert Greenwaltf3017f72014-05-18 23:07:25 -07001538 /**
Roshan Pius951c0032020-12-22 15:10:42 -08001539 * Get the {@link NetworkCapabilities} for the given {@link Network}. This
Robert Greenwaltf3017f72014-05-18 23:07:25 -07001540 * will return {@code null} if the network is unknown.
1541 *
Roshan Pius951c0032020-12-22 15:10:42 -08001542 * This will remove any location sensitive data in {@link TransportInfo} embedded in
1543 * {@link NetworkCapabilities#getTransportInfo()}. Some transport info instances like
1544 * {@link android.net.wifi.WifiInfo} contain location sensitive information. Retrieving
1545 * this location sensitive information (subject to app's location permissions) will be
1546 * noted by system. To include any location sensitive data in {@link TransportInfo},
1547 * use a {@link NetworkCallback} with
1548 * {@link NetworkCallback#FLAG_INCLUDE_LOCATION_INFO} flag.
1549 *
Robert Greenwaltf3017f72014-05-18 23:07:25 -07001550 * @param network The {@link Network} object identifying the network in question.
Roshan Pius951c0032020-12-22 15:10:42 -08001551 * @return The {@link NetworkCapabilities} for the network, or {@code null}.
Robert Greenwaltf3017f72014-05-18 23:07:25 -07001552 */
Jeff Sharkey656584a2017-04-24 11:18:03 -06001553 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean158702d2019-01-07 19:26:34 +09001554 @Nullable
1555 public NetworkCapabilities getNetworkCapabilities(@Nullable Network network) {
Robert Greenwaltf99b8392014-03-26 16:47:06 -07001556 try {
Roshan Piusaa24fde2020-12-17 14:53:09 -08001557 return mService.getNetworkCapabilities(
1558 network, mContext.getOpPackageName(), getAttributionTag());
Robert Greenwalt9f0ee4f2010-09-14 09:18:02 -07001559 } catch (RemoteException e) {
Jeff Sharkeyc78f85c2016-03-01 19:27:23 -07001560 throw e.rethrowFromSystemServer();
Robert Greenwalt9f0ee4f2010-09-14 09:18:02 -07001561 }
1562 }
1563
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08001564 /**
Remi NGUYEN VAN035f6532019-03-20 14:22:49 +09001565 * Gets a URL that can be used for resolving whether a captive portal is present.
Udam Sainicd645462016-01-04 12:16:14 -08001566 * 1. This URL should respond with a 204 response to a GET request to indicate no captive
1567 * portal is present.
1568 * 2. This URL must be HTTP as redirect responses are used to find captive portal
1569 * sign-in pages. Captive portals cannot respond to HTTPS requests with redirects.
1570 *
Remi NGUYEN VAN035f6532019-03-20 14:22:49 +09001571 * The system network validation may be using different strategies to detect captive portals,
1572 * so this method does not necessarily return a URL used by the system. It only returns a URL
1573 * that may be relevant for other components trying to detect captive portals.
paulhu8e96a752019-08-12 16:25:11 +08001574 *
Udam Sainicd645462016-01-04 12:16:14 -08001575 * @hide
paulhu8e96a752019-08-12 16:25:11 +08001576 * @deprecated This API returns URL which is not guaranteed to be one of the URLs used by the
1577 * system.
Udam Sainicd645462016-01-04 12:16:14 -08001578 */
paulhu8e96a752019-08-12 16:25:11 +08001579 @Deprecated
Udam Sainicd645462016-01-04 12:16:14 -08001580 @SystemApi
paulhu8e96a752019-08-12 16:25:11 +08001581 @RequiresPermission(android.Manifest.permission.NETWORK_SETTINGS)
Udam Sainicd645462016-01-04 12:16:14 -08001582 public String getCaptivePortalServerUrl() {
1583 try {
1584 return mService.getCaptivePortalServerUrl();
1585 } catch (RemoteException e) {
Jeff Sharkeyc78f85c2016-03-01 19:27:23 -07001586 throw e.rethrowFromSystemServer();
Udam Sainicd645462016-01-04 12:16:14 -08001587 }
1588 }
1589
1590 /**
The Android Open Source Project28527d22009-03-03 19:31:44 -08001591 * Tells the underlying networking system that the caller wants to
1592 * begin using the named feature. The interpretation of {@code feature}
1593 * is completely up to each networking implementation.
Lorenzo Colitti0b40c872015-10-15 16:29:00 +09001594 *
1595 * <p>This method requires the caller to hold either the
1596 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
1597 * or the ability to modify system settings as determined by
1598 * {@link android.provider.Settings.System#canWrite}.</p>
1599 *
The Android Open Source Project28527d22009-03-03 19:31:44 -08001600 * @param networkType specifies which network the request pertains to
1601 * @param feature the name of the feature to be used
1602 * @return an integer value representing the outcome of the request.
1603 * The interpretation of this value is specific to each networking
1604 * implementation+feature combination, except that the value {@code -1}
1605 * always indicates failure.
Robert Greenwaltf3017f72014-05-18 23:07:25 -07001606 *
Lorenzo Colitti7f6a2bf2015-04-24 17:03:31 +09001607 * @deprecated Deprecated in favor of the cleaner
1608 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} API.
Dianne Hackborn18c1d832015-07-31 10:35:34 -07001609 * In {@link VERSION_CODES#M}, and above, this method is unsupported and will
Lorenzo Colitti2780e4b2015-07-29 11:41:21 +09001610 * throw {@code UnsupportedOperationException} if called.
Lorenzo Colitti84d7f072016-12-09 18:39:30 +09001611 * @removed
The Android Open Source Project28527d22009-03-03 19:31:44 -08001612 */
Aurimas Liutikase80a0eb2016-05-24 15:22:55 -07001613 @Deprecated
The Android Open Source Project28527d22009-03-03 19:31:44 -08001614 public int startUsingNetworkFeature(int networkType, String feature) {
Lorenzo Colitti2780e4b2015-07-29 11:41:21 +09001615 checkLegacyRoutingApiAccess();
Robert Greenwalt3dc73e52014-05-15 18:07:26 -07001616 NetworkCapabilities netCap = networkCapabilitiesForFeature(networkType, feature);
1617 if (netCap == null) {
1618 Log.d(TAG, "Can't satisfy startUsingNetworkFeature for " + networkType + ", " +
1619 feature);
Chalard Jeanafaed1a2019-11-21 14:48:00 +09001620 return DEPRECATED_PHONE_CONSTANT_APN_REQUEST_FAILED;
Robert Greenwalt3dc73e52014-05-15 18:07:26 -07001621 }
1622
1623 NetworkRequest request = null;
1624 synchronized (sLegacyRequests) {
1625 LegacyRequest l = sLegacyRequests.get(netCap);
1626 if (l != null) {
1627 Log.d(TAG, "renewing startUsingNetworkFeature request " + l.networkRequest);
1628 renewRequestLocked(l);
1629 if (l.currentNetwork != null) {
Chalard Jeanafaed1a2019-11-21 14:48:00 +09001630 return DEPRECATED_PHONE_CONSTANT_APN_ALREADY_ACTIVE;
Robert Greenwalt3dc73e52014-05-15 18:07:26 -07001631 } else {
Chalard Jeanafaed1a2019-11-21 14:48:00 +09001632 return DEPRECATED_PHONE_CONSTANT_APN_REQUEST_STARTED;
Robert Greenwalt3dc73e52014-05-15 18:07:26 -07001633 }
1634 }
1635
1636 request = requestNetworkForFeatureLocked(netCap);
1637 }
1638 if (request != null) {
Robert Greenwaltb8401732014-06-20 10:58:45 -07001639 Log.d(TAG, "starting startUsingNetworkFeature for request " + request);
Chalard Jeanafaed1a2019-11-21 14:48:00 +09001640 return DEPRECATED_PHONE_CONSTANT_APN_REQUEST_STARTED;
Robert Greenwalt3dc73e52014-05-15 18:07:26 -07001641 } else {
1642 Log.d(TAG, " request Failed");
Chalard Jeanafaed1a2019-11-21 14:48:00 +09001643 return DEPRECATED_PHONE_CONSTANT_APN_REQUEST_FAILED;
The Android Open Source Project28527d22009-03-03 19:31:44 -08001644 }
1645 }
1646
1647 /**
1648 * Tells the underlying networking system that the caller is finished
1649 * using the named feature. The interpretation of {@code feature}
1650 * is completely up to each networking implementation.
Lorenzo Colitti0b40c872015-10-15 16:29:00 +09001651 *
1652 * <p>This method requires the caller to hold either the
1653 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
1654 * or the ability to modify system settings as determined by
1655 * {@link android.provider.Settings.System#canWrite}.</p>
1656 *
The Android Open Source Project28527d22009-03-03 19:31:44 -08001657 * @param networkType specifies which network the request pertains to
1658 * @param feature the name of the feature that is no longer needed
1659 * @return an integer value representing the outcome of the request.
1660 * The interpretation of this value is specific to each networking
1661 * implementation+feature combination, except that the value {@code -1}
1662 * always indicates failure.
Robert Greenwaltf3017f72014-05-18 23:07:25 -07001663 *
Lorenzo Colitti15874cd2016-04-13 22:00:02 +09001664 * @deprecated Deprecated in favor of the cleaner
1665 * {@link #unregisterNetworkCallback(NetworkCallback)} API.
Dianne Hackborn18c1d832015-07-31 10:35:34 -07001666 * In {@link VERSION_CODES#M}, and above, this method is unsupported and will
Lorenzo Colitti2780e4b2015-07-29 11:41:21 +09001667 * throw {@code UnsupportedOperationException} if called.
Lorenzo Colitti84d7f072016-12-09 18:39:30 +09001668 * @removed
The Android Open Source Project28527d22009-03-03 19:31:44 -08001669 */
Aurimas Liutikase80a0eb2016-05-24 15:22:55 -07001670 @Deprecated
The Android Open Source Project28527d22009-03-03 19:31:44 -08001671 public int stopUsingNetworkFeature(int networkType, String feature) {
Lorenzo Colitti2780e4b2015-07-29 11:41:21 +09001672 checkLegacyRoutingApiAccess();
Robert Greenwalt3dc73e52014-05-15 18:07:26 -07001673 NetworkCapabilities netCap = networkCapabilitiesForFeature(networkType, feature);
1674 if (netCap == null) {
1675 Log.d(TAG, "Can't satisfy stopUsingNetworkFeature for " + networkType + ", " +
1676 feature);
The Android Open Source Project28527d22009-03-03 19:31:44 -08001677 return -1;
1678 }
Robert Greenwalt3dc73e52014-05-15 18:07:26 -07001679
Paul Jensen49f74a32014-12-17 10:39:34 -05001680 if (removeRequestForFeature(netCap)) {
Robert Greenwalt3dc73e52014-05-15 18:07:26 -07001681 Log.d(TAG, "stopUsingNetworkFeature for " + networkType + ", " + feature);
Robert Greenwalt3dc73e52014-05-15 18:07:26 -07001682 }
1683 return 1;
1684 }
1685
Mathew Inwoode1a17ba2020-11-04 09:29:36 +00001686 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
Robert Greenwalt3dc73e52014-05-15 18:07:26 -07001687 private NetworkCapabilities networkCapabilitiesForFeature(int networkType, String feature) {
1688 if (networkType == TYPE_MOBILE) {
Erik Klinece55eb12017-01-26 18:08:28 +09001689 switch (feature) {
1690 case "enableCBS":
1691 return networkCapabilitiesForType(TYPE_MOBILE_CBS);
1692 case "enableDUN":
1693 case "enableDUNAlways":
1694 return networkCapabilitiesForType(TYPE_MOBILE_DUN);
1695 case "enableFOTA":
1696 return networkCapabilitiesForType(TYPE_MOBILE_FOTA);
1697 case "enableHIPRI":
1698 return networkCapabilitiesForType(TYPE_MOBILE_HIPRI);
1699 case "enableIMS":
1700 return networkCapabilitiesForType(TYPE_MOBILE_IMS);
1701 case "enableMMS":
1702 return networkCapabilitiesForType(TYPE_MOBILE_MMS);
1703 case "enableSUPL":
1704 return networkCapabilitiesForType(TYPE_MOBILE_SUPL);
1705 default:
1706 return null;
Robert Greenwalt3dc73e52014-05-15 18:07:26 -07001707 }
Erik Klinece55eb12017-01-26 18:08:28 +09001708 } else if (networkType == TYPE_WIFI && "p2p".equals(feature)) {
1709 return networkCapabilitiesForType(TYPE_WIFI_P2P);
Robert Greenwalt3dc73e52014-05-15 18:07:26 -07001710 }
1711 return null;
1712 }
1713
Robert Greenwalt802c1102014-06-02 15:32:02 -07001714 private int legacyTypeForNetworkCapabilities(NetworkCapabilities netCap) {
Robert Greenwalt3dc73e52014-05-15 18:07:26 -07001715 if (netCap == null) return TYPE_NONE;
1716 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_CBS)) {
1717 return TYPE_MOBILE_CBS;
1718 }
1719 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_IMS)) {
1720 return TYPE_MOBILE_IMS;
1721 }
1722 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_FOTA)) {
1723 return TYPE_MOBILE_FOTA;
1724 }
1725 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_DUN)) {
1726 return TYPE_MOBILE_DUN;
1727 }
1728 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_SUPL)) {
1729 return TYPE_MOBILE_SUPL;
1730 }
1731 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_MMS)) {
1732 return TYPE_MOBILE_MMS;
1733 }
1734 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_INTERNET)) {
1735 return TYPE_MOBILE_HIPRI;
1736 }
Robert Greenwalt802c1102014-06-02 15:32:02 -07001737 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_WIFI_P2P)) {
1738 return TYPE_WIFI_P2P;
1739 }
Robert Greenwalt3dc73e52014-05-15 18:07:26 -07001740 return TYPE_NONE;
1741 }
1742
1743 private static class LegacyRequest {
1744 NetworkCapabilities networkCapabilities;
1745 NetworkRequest networkRequest;
1746 int expireSequenceNumber;
1747 Network currentNetwork;
1748 int delay = -1;
Paul Jensen49f74a32014-12-17 10:39:34 -05001749
1750 private void clearDnsBinding() {
1751 if (currentNetwork != null) {
1752 currentNetwork = null;
1753 setProcessDefaultNetworkForHostResolution(null);
1754 }
1755 }
1756
Robert Greenwaltf57c03c2014-06-11 16:05:07 -07001757 NetworkCallback networkCallback = new NetworkCallback() {
Robert Greenwalt3dc73e52014-05-15 18:07:26 -07001758 @Override
Robert Greenwaltf57c03c2014-06-11 16:05:07 -07001759 public void onAvailable(Network network) {
Robert Greenwalt3dc73e52014-05-15 18:07:26 -07001760 currentNetwork = network;
1761 Log.d(TAG, "startUsingNetworkFeature got Network:" + network);
Paul Jensen8cdda642014-05-29 10:12:39 -04001762 setProcessDefaultNetworkForHostResolution(network);
Robert Greenwalt3dc73e52014-05-15 18:07:26 -07001763 }
1764 @Override
Robert Greenwaltf57c03c2014-06-11 16:05:07 -07001765 public void onLost(Network network) {
Paul Jensen49f74a32014-12-17 10:39:34 -05001766 if (network.equals(currentNetwork)) clearDnsBinding();
Robert Greenwalt3dc73e52014-05-15 18:07:26 -07001767 Log.d(TAG, "startUsingNetworkFeature lost Network:" + network);
1768 }
1769 };
1770 }
1771
Mathew Inwoode1a17ba2020-11-04 09:29:36 +00001772 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
Chalard Jean9dd11612018-06-04 16:52:49 +09001773 private static final HashMap<NetworkCapabilities, LegacyRequest> sLegacyRequests =
1774 new HashMap<>();
Robert Greenwalt3dc73e52014-05-15 18:07:26 -07001775
1776 private NetworkRequest findRequestForFeature(NetworkCapabilities netCap) {
1777 synchronized (sLegacyRequests) {
1778 LegacyRequest l = sLegacyRequests.get(netCap);
1779 if (l != null) return l.networkRequest;
1780 }
1781 return null;
1782 }
1783
1784 private void renewRequestLocked(LegacyRequest l) {
1785 l.expireSequenceNumber++;
1786 Log.d(TAG, "renewing request to seqNum " + l.expireSequenceNumber);
1787 sendExpireMsgForFeature(l.networkCapabilities, l.expireSequenceNumber, l.delay);
1788 }
1789
1790 private void expireRequest(NetworkCapabilities netCap, int sequenceNum) {
1791 int ourSeqNum = -1;
1792 synchronized (sLegacyRequests) {
1793 LegacyRequest l = sLegacyRequests.get(netCap);
1794 if (l == null) return;
1795 ourSeqNum = l.expireSequenceNumber;
Paul Jensen49f74a32014-12-17 10:39:34 -05001796 if (l.expireSequenceNumber == sequenceNum) removeRequestForFeature(netCap);
Robert Greenwalt3dc73e52014-05-15 18:07:26 -07001797 }
1798 Log.d(TAG, "expireRequest with " + ourSeqNum + ", " + sequenceNum);
1799 }
1800
Mathew Inwoode1a17ba2020-11-04 09:29:36 +00001801 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
Robert Greenwalt3dc73e52014-05-15 18:07:26 -07001802 private NetworkRequest requestNetworkForFeatureLocked(NetworkCapabilities netCap) {
1803 int delay = -1;
Robert Greenwalt802c1102014-06-02 15:32:02 -07001804 int type = legacyTypeForNetworkCapabilities(netCap);
Robert Greenwalt3dc73e52014-05-15 18:07:26 -07001805 try {
1806 delay = mService.getRestoreDefaultNetworkDelay(type);
Jeff Sharkeyc78f85c2016-03-01 19:27:23 -07001807 } catch (RemoteException e) {
1808 throw e.rethrowFromSystemServer();
1809 }
Robert Greenwalt3dc73e52014-05-15 18:07:26 -07001810 LegacyRequest l = new LegacyRequest();
1811 l.networkCapabilities = netCap;
1812 l.delay = delay;
1813 l.expireSequenceNumber = 0;
Hugo Benichifd44e912017-02-02 17:02:36 +09001814 l.networkRequest = sendRequestForNetwork(
1815 netCap, l.networkCallback, 0, REQUEST, type, getDefaultHandler());
Robert Greenwalt3dc73e52014-05-15 18:07:26 -07001816 if (l.networkRequest == null) return null;
1817 sLegacyRequests.put(netCap, l);
1818 sendExpireMsgForFeature(netCap, l.expireSequenceNumber, delay);
1819 return l.networkRequest;
1820 }
1821
1822 private void sendExpireMsgForFeature(NetworkCapabilities netCap, int seqNum, int delay) {
1823 if (delay >= 0) {
1824 Log.d(TAG, "sending expire msg with seqNum " + seqNum + " and delay " + delay);
Hugo Benichifd44e912017-02-02 17:02:36 +09001825 CallbackHandler handler = getDefaultHandler();
Hugo Benichibc4ac972017-02-03 14:18:44 +09001826 Message msg = handler.obtainMessage(EXPIRE_LEGACY_REQUEST, seqNum, 0, netCap);
1827 handler.sendMessageDelayed(msg, delay);
Robert Greenwalt3dc73e52014-05-15 18:07:26 -07001828 }
1829 }
1830
Mathew Inwoode1a17ba2020-11-04 09:29:36 +00001831 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
Paul Jensen49f74a32014-12-17 10:39:34 -05001832 private boolean removeRequestForFeature(NetworkCapabilities netCap) {
1833 final LegacyRequest l;
Robert Greenwalt3dc73e52014-05-15 18:07:26 -07001834 synchronized (sLegacyRequests) {
Paul Jensen49f74a32014-12-17 10:39:34 -05001835 l = sLegacyRequests.remove(netCap);
Robert Greenwalt3dc73e52014-05-15 18:07:26 -07001836 }
Paul Jensen49f74a32014-12-17 10:39:34 -05001837 if (l == null) return false;
1838 unregisterNetworkCallback(l.networkCallback);
1839 l.clearDnsBinding();
1840 return true;
The Android Open Source Project28527d22009-03-03 19:31:44 -08001841 }
1842
Erik Klinece55eb12017-01-26 18:08:28 +09001843 private static final SparseIntArray sLegacyTypeToTransport = new SparseIntArray();
1844 static {
1845 sLegacyTypeToTransport.put(TYPE_MOBILE, NetworkCapabilities.TRANSPORT_CELLULAR);
1846 sLegacyTypeToTransport.put(TYPE_MOBILE_CBS, NetworkCapabilities.TRANSPORT_CELLULAR);
1847 sLegacyTypeToTransport.put(TYPE_MOBILE_DUN, NetworkCapabilities.TRANSPORT_CELLULAR);
1848 sLegacyTypeToTransport.put(TYPE_MOBILE_FOTA, NetworkCapabilities.TRANSPORT_CELLULAR);
1849 sLegacyTypeToTransport.put(TYPE_MOBILE_HIPRI, NetworkCapabilities.TRANSPORT_CELLULAR);
1850 sLegacyTypeToTransport.put(TYPE_MOBILE_IMS, NetworkCapabilities.TRANSPORT_CELLULAR);
1851 sLegacyTypeToTransport.put(TYPE_MOBILE_MMS, NetworkCapabilities.TRANSPORT_CELLULAR);
1852 sLegacyTypeToTransport.put(TYPE_MOBILE_SUPL, NetworkCapabilities.TRANSPORT_CELLULAR);
1853 sLegacyTypeToTransport.put(TYPE_WIFI, NetworkCapabilities.TRANSPORT_WIFI);
1854 sLegacyTypeToTransport.put(TYPE_WIFI_P2P, NetworkCapabilities.TRANSPORT_WIFI);
1855 sLegacyTypeToTransport.put(TYPE_BLUETOOTH, NetworkCapabilities.TRANSPORT_BLUETOOTH);
1856 sLegacyTypeToTransport.put(TYPE_ETHERNET, NetworkCapabilities.TRANSPORT_ETHERNET);
1857 }
1858
1859 private static final SparseIntArray sLegacyTypeToCapability = new SparseIntArray();
1860 static {
1861 sLegacyTypeToCapability.put(TYPE_MOBILE_CBS, NetworkCapabilities.NET_CAPABILITY_CBS);
1862 sLegacyTypeToCapability.put(TYPE_MOBILE_DUN, NetworkCapabilities.NET_CAPABILITY_DUN);
1863 sLegacyTypeToCapability.put(TYPE_MOBILE_FOTA, NetworkCapabilities.NET_CAPABILITY_FOTA);
1864 sLegacyTypeToCapability.put(TYPE_MOBILE_IMS, NetworkCapabilities.NET_CAPABILITY_IMS);
1865 sLegacyTypeToCapability.put(TYPE_MOBILE_MMS, NetworkCapabilities.NET_CAPABILITY_MMS);
1866 sLegacyTypeToCapability.put(TYPE_MOBILE_SUPL, NetworkCapabilities.NET_CAPABILITY_SUPL);
1867 sLegacyTypeToCapability.put(TYPE_WIFI_P2P, NetworkCapabilities.NET_CAPABILITY_WIFI_P2P);
1868 }
1869
1870 /**
1871 * Given a legacy type (TYPE_WIFI, ...) returns a NetworkCapabilities
1872 * instance suitable for registering a request or callback. Throws an
1873 * IllegalArgumentException if no mapping from the legacy type to
1874 * NetworkCapabilities is known.
1875 *
Chalard Jean7eaf3b12018-03-08 13:54:53 +09001876 * @deprecated Types are deprecated. Use {@link NetworkCallback} or {@link NetworkRequest}
1877 * to find the network instead.
Erik Klinece55eb12017-01-26 18:08:28 +09001878 * @hide
1879 */
1880 public static NetworkCapabilities networkCapabilitiesForType(int type) {
1881 final NetworkCapabilities nc = new NetworkCapabilities();
1882
1883 // Map from type to transports.
1884 final int NOT_FOUND = -1;
1885 final int transport = sLegacyTypeToTransport.get(type, NOT_FOUND);
Remi NGUYEN VAN81f68422021-03-15 07:31:54 +00001886 if (transport == NOT_FOUND) {
1887 throw new IllegalArgumentException("unknown legacy type: " + type);
1888 }
Erik Klinece55eb12017-01-26 18:08:28 +09001889 nc.addTransportType(transport);
1890
1891 // Map from type to capabilities.
1892 nc.addCapability(sLegacyTypeToCapability.get(
1893 type, NetworkCapabilities.NET_CAPABILITY_INTERNET));
1894 nc.maybeMarkCapabilitiesRestricted();
1895 return nc;
1896 }
1897
Lorenzo Colitti0b798a82015-06-15 14:29:22 +09001898 /** @hide */
1899 public static class PacketKeepaliveCallback {
Mathew Inwoode1a17ba2020-11-04 09:29:36 +00001900 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
Artur Satayev56cb6bb2019-11-04 17:50:59 +00001901 public PacketKeepaliveCallback() {
1902 }
Lorenzo Colitti0b798a82015-06-15 14:29:22 +09001903 /** The requested keepalive was successfully started. */
Mathew Inwoode1a17ba2020-11-04 09:29:36 +00001904 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
Lorenzo Colitti0b798a82015-06-15 14:29:22 +09001905 public void onStarted() {}
1906 /** The keepalive was successfully stopped. */
Mathew Inwoode1a17ba2020-11-04 09:29:36 +00001907 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
Lorenzo Colitti0b798a82015-06-15 14:29:22 +09001908 public void onStopped() {}
1909 /** An error occurred. */
Mathew Inwoode1a17ba2020-11-04 09:29:36 +00001910 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
Lorenzo Colitti0b798a82015-06-15 14:29:22 +09001911 public void onError(int error) {}
1912 }
1913
1914 /**
1915 * Allows applications to request that the system periodically send specific packets on their
1916 * behalf, using hardware offload to save battery power.
1917 *
1918 * To request that the system send keepalives, call one of the methods that return a
1919 * {@link ConnectivityManager.PacketKeepalive} object, such as {@link #startNattKeepalive},
1920 * passing in a non-null callback. If the callback is successfully started, the callback's
1921 * {@code onStarted} method will be called. If an error occurs, {@code onError} will be called,
1922 * specifying one of the {@code ERROR_*} constants in this class.
1923 *
Chalard Jean9dd11612018-06-04 16:52:49 +09001924 * To stop an existing keepalive, call {@link PacketKeepalive#stop}. The system will call
1925 * {@link PacketKeepaliveCallback#onStopped} if the operation was successful or
1926 * {@link PacketKeepaliveCallback#onError} if an error occurred.
Lorenzo Colitti0b798a82015-06-15 14:29:22 +09001927 *
junyulai4c95b082018-12-27 17:25:29 +08001928 * @deprecated Use {@link SocketKeepalive} instead.
1929 *
Lorenzo Colitti0b798a82015-06-15 14:29:22 +09001930 * @hide
1931 */
1932 public class PacketKeepalive {
1933
1934 private static final String TAG = "PacketKeepalive";
1935
1936 /** @hide */
1937 public static final int SUCCESS = 0;
1938
1939 /** @hide */
1940 public static final int NO_KEEPALIVE = -1;
1941
1942 /** @hide */
1943 public static final int BINDER_DIED = -10;
1944
1945 /** The specified {@code Network} is not connected. */
1946 public static final int ERROR_INVALID_NETWORK = -20;
1947 /** The specified IP addresses are invalid. For example, the specified source IP address is
1948 * not configured on the specified {@code Network}. */
1949 public static final int ERROR_INVALID_IP_ADDRESS = -21;
1950 /** The requested port is invalid. */
1951 public static final int ERROR_INVALID_PORT = -22;
1952 /** The packet length is invalid (e.g., too long). */
1953 public static final int ERROR_INVALID_LENGTH = -23;
1954 /** The packet transmission interval is invalid (e.g., too short). */
1955 public static final int ERROR_INVALID_INTERVAL = -24;
1956
1957 /** The hardware does not support this request. */
1958 public static final int ERROR_HARDWARE_UNSUPPORTED = -30;
Lorenzo Colitti723f82f2015-09-08 16:46:36 +09001959 /** The hardware returned an error. */
1960 public static final int ERROR_HARDWARE_ERROR = -31;
Lorenzo Colitti0b798a82015-06-15 14:29:22 +09001961
Nathan Harold0990bc82018-02-14 13:09:45 -08001962 /** The NAT-T destination port for IPsec */
Lorenzo Colitti0b798a82015-06-15 14:29:22 +09001963 public static final int NATT_PORT = 4500;
1964
Nathan Harold0990bc82018-02-14 13:09:45 -08001965 /** The minimum interval in seconds between keepalive packet transmissions */
1966 public static final int MIN_INTERVAL = 10;
1967
Lorenzo Colitti0b798a82015-06-15 14:29:22 +09001968 private final Network mNetwork;
junyulai070f9ff2019-01-16 20:23:34 +08001969 private final ISocketKeepaliveCallback mCallback;
1970 private final ExecutorService mExecutor;
Lorenzo Colitti0b798a82015-06-15 14:29:22 +09001971
1972 private volatile Integer mSlot;
1973
Mathew Inwoode1a17ba2020-11-04 09:29:36 +00001974 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
Lorenzo Colitti0b798a82015-06-15 14:29:22 +09001975 public void stop() {
1976 try {
junyulai070f9ff2019-01-16 20:23:34 +08001977 mExecutor.execute(() -> {
1978 try {
1979 if (mSlot != null) {
1980 mService.stopKeepalive(mNetwork, mSlot);
1981 }
1982 } catch (RemoteException e) {
1983 Log.e(TAG, "Error stopping packet keepalive: ", e);
1984 throw e.rethrowFromSystemServer();
1985 }
1986 });
1987 } catch (RejectedExecutionException e) {
1988 // The internal executor has already stopped due to previous event.
Lorenzo Colitti0b798a82015-06-15 14:29:22 +09001989 }
1990 }
1991
1992 private PacketKeepalive(Network network, PacketKeepaliveCallback callback) {
Remi NGUYEN VAN81f68422021-03-15 07:31:54 +00001993 Objects.requireNonNull(network, "network cannot be null");
1994 Objects.requireNonNull(callback, "callback cannot be null");
Lorenzo Colitti0b798a82015-06-15 14:29:22 +09001995 mNetwork = network;
junyulai070f9ff2019-01-16 20:23:34 +08001996 mExecutor = Executors.newSingleThreadExecutor();
1997 mCallback = new ISocketKeepaliveCallback.Stub() {
Lorenzo Colitti0b798a82015-06-15 14:29:22 +09001998 @Override
junyulai070f9ff2019-01-16 20:23:34 +08001999 public void onStarted(int slot) {
lucaslinbe801382020-12-30 11:54:55 +08002000 final long token = Binder.clearCallingIdentity();
2001 try {
2002 mExecutor.execute(() -> {
2003 mSlot = slot;
2004 callback.onStarted();
2005 });
2006 } finally {
2007 Binder.restoreCallingIdentity(token);
2008 }
Lorenzo Colitti0b798a82015-06-15 14:29:22 +09002009 }
junyulai070f9ff2019-01-16 20:23:34 +08002010
2011 @Override
2012 public void onStopped() {
lucaslinbe801382020-12-30 11:54:55 +08002013 final long token = Binder.clearCallingIdentity();
2014 try {
2015 mExecutor.execute(() -> {
2016 mSlot = null;
2017 callback.onStopped();
2018 });
2019 } finally {
2020 Binder.restoreCallingIdentity(token);
2021 }
junyulai070f9ff2019-01-16 20:23:34 +08002022 mExecutor.shutdown();
2023 }
2024
2025 @Override
2026 public void onError(int error) {
lucaslinbe801382020-12-30 11:54:55 +08002027 final long token = Binder.clearCallingIdentity();
2028 try {
2029 mExecutor.execute(() -> {
2030 mSlot = null;
2031 callback.onError(error);
2032 });
2033 } finally {
2034 Binder.restoreCallingIdentity(token);
2035 }
junyulai070f9ff2019-01-16 20:23:34 +08002036 mExecutor.shutdown();
2037 }
2038
2039 @Override
2040 public void onDataReceived() {
2041 // PacketKeepalive is only used for Nat-T keepalive and as such does not invoke
2042 // this callback when data is received.
2043 }
2044 };
Lorenzo Colitti0b798a82015-06-15 14:29:22 +09002045 }
2046 }
2047
2048 /**
2049 * Starts an IPsec NAT-T keepalive packet with the specified parameters.
2050 *
junyulai4c95b082018-12-27 17:25:29 +08002051 * @deprecated Use {@link #createSocketKeepalive} instead.
2052 *
Lorenzo Colitti0b798a82015-06-15 14:29:22 +09002053 * @hide
2054 */
Mathew Inwoode1a17ba2020-11-04 09:29:36 +00002055 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
Lorenzo Colitti0b798a82015-06-15 14:29:22 +09002056 public PacketKeepalive startNattKeepalive(
2057 Network network, int intervalSeconds, PacketKeepaliveCallback callback,
2058 InetAddress srcAddr, int srcPort, InetAddress dstAddr) {
2059 final PacketKeepalive k = new PacketKeepalive(network, callback);
2060 try {
junyulai070f9ff2019-01-16 20:23:34 +08002061 mService.startNattKeepalive(network, intervalSeconds, k.mCallback,
Lorenzo Colitti0b798a82015-06-15 14:29:22 +09002062 srcAddr.getHostAddress(), srcPort, dstAddr.getHostAddress());
2063 } catch (RemoteException e) {
2064 Log.e(TAG, "Error starting packet keepalive: ", e);
junyulai070f9ff2019-01-16 20:23:34 +08002065 throw e.rethrowFromSystemServer();
Lorenzo Colitti0b798a82015-06-15 14:29:22 +09002066 }
2067 return k;
2068 }
2069
Chiachang Wang619319a2021-01-15 11:06:21 +08002070 // Construct an invalid fd.
2071 private ParcelFileDescriptor createInvalidFd() {
2072 final int invalidFd = -1;
2073 return ParcelFileDescriptor.adoptFd(invalidFd);
2074 }
2075
The Android Open Source Project28527d22009-03-03 19:31:44 -08002076 /**
junyulai4c95b082018-12-27 17:25:29 +08002077 * Request that keepalives be started on a IPsec NAT-T socket.
2078 *
2079 * @param network The {@link Network} the socket is on.
2080 * @param socket The socket that needs to be kept alive.
2081 * @param source The source address of the {@link UdpEncapsulationSocket}.
2082 * @param destination The destination address of the {@link UdpEncapsulationSocket}.
2083 * @param executor The executor on which callback will be invoked. The provided {@link Executor}
2084 * must run callback sequentially, otherwise the order of callbacks cannot be
2085 * guaranteed.
2086 * @param callback A {@link SocketKeepalive.Callback}. Used for notifications about keepalive
2087 * changes. Must be extended by applications that use this API.
2088 *
junyulai0835a1e2019-01-08 20:04:33 +08002089 * @return A {@link SocketKeepalive} object that can be used to control the keepalive on the
2090 * given socket.
junyulai4c95b082018-12-27 17:25:29 +08002091 **/
junyulai7e06ad42019-03-04 22:45:36 +08002092 public @NonNull SocketKeepalive createSocketKeepalive(@NonNull Network network,
junyulai4c95b082018-12-27 17:25:29 +08002093 @NonNull UdpEncapsulationSocket socket,
2094 @NonNull InetAddress source,
2095 @NonNull InetAddress destination,
2096 @NonNull @CallbackExecutor Executor executor,
2097 @NonNull Callback callback) {
junyulai7e06ad42019-03-04 22:45:36 +08002098 ParcelFileDescriptor dup;
2099 try {
junyulai828dad12019-03-27 11:00:37 +08002100 // Dup is needed here as the pfd inside the socket is owned by the IpSecService,
2101 // which cannot be obtained by the app process.
junyulai7e06ad42019-03-04 22:45:36 +08002102 dup = ParcelFileDescriptor.dup(socket.getFileDescriptor());
2103 } catch (IOException ignored) {
2104 // Construct an invalid fd, so that if the user later calls start(), it will fail with
2105 // ERROR_INVALID_SOCKET.
Chiachang Wang619319a2021-01-15 11:06:21 +08002106 dup = createInvalidFd();
junyulai7e06ad42019-03-04 22:45:36 +08002107 }
2108 return new NattSocketKeepalive(mService, network, dup, socket.getResourceId(), source,
2109 destination, executor, callback);
junyulaid05a1922019-01-15 11:32:44 +08002110 }
2111
2112 /**
2113 * Request that keepalives be started on a IPsec NAT-T socket file descriptor. Directly called
2114 * by system apps which don't use IpSecService to create {@link UdpEncapsulationSocket}.
2115 *
2116 * @param network The {@link Network} the socket is on.
junyulai7e06ad42019-03-04 22:45:36 +08002117 * @param pfd The {@link ParcelFileDescriptor} that needs to be kept alive. The provided
2118 * {@link ParcelFileDescriptor} must be bound to a port and the keepalives will be sent
2119 * from that port.
junyulaid05a1922019-01-15 11:32:44 +08002120 * @param source The source address of the {@link UdpEncapsulationSocket}.
2121 * @param destination The destination address of the {@link UdpEncapsulationSocket}. The
2122 * keepalive packets will always be sent to port 4500 of the given {@code destination}.
2123 * @param executor The executor on which callback will be invoked. The provided {@link Executor}
2124 * must run callback sequentially, otherwise the order of callbacks cannot be
2125 * guaranteed.
2126 * @param callback A {@link SocketKeepalive.Callback}. Used for notifications about keepalive
2127 * changes. Must be extended by applications that use this API.
2128 *
junyulai0835a1e2019-01-08 20:04:33 +08002129 * @return A {@link SocketKeepalive} object that can be used to control the keepalive on the
2130 * given socket.
junyulaid05a1922019-01-15 11:32:44 +08002131 * @hide
2132 */
2133 @SystemApi
2134 @RequiresPermission(android.Manifest.permission.PACKET_KEEPALIVE_OFFLOAD)
junyulai7e06ad42019-03-04 22:45:36 +08002135 public @NonNull SocketKeepalive createNattKeepalive(@NonNull Network network,
2136 @NonNull ParcelFileDescriptor pfd,
junyulaid05a1922019-01-15 11:32:44 +08002137 @NonNull InetAddress source,
2138 @NonNull InetAddress destination,
2139 @NonNull @CallbackExecutor Executor executor,
2140 @NonNull Callback callback) {
junyulai7e06ad42019-03-04 22:45:36 +08002141 ParcelFileDescriptor dup;
2142 try {
junyulai828dad12019-03-27 11:00:37 +08002143 // TODO: Consider remove unnecessary dup.
junyulai7e06ad42019-03-04 22:45:36 +08002144 dup = pfd.dup();
2145 } catch (IOException ignored) {
2146 // Construct an invalid fd, so that if the user later calls start(), it will fail with
2147 // ERROR_INVALID_SOCKET.
Chiachang Wang619319a2021-01-15 11:06:21 +08002148 dup = createInvalidFd();
junyulai7e06ad42019-03-04 22:45:36 +08002149 }
2150 return new NattSocketKeepalive(mService, network, dup,
Remi NGUYEN VANce355502021-03-11 10:56:49 +00002151 -1 /* Unused */, source, destination, executor, callback);
junyulai4c95b082018-12-27 17:25:29 +08002152 }
2153
2154 /**
junyulai0835a1e2019-01-08 20:04:33 +08002155 * Request that keepalives be started on a TCP socket.
2156 * The socket must be established.
2157 *
2158 * @param network The {@link Network} the socket is on.
2159 * @param socket The socket that needs to be kept alive.
2160 * @param executor The executor on which callback will be invoked. This implementation assumes
2161 * the provided {@link Executor} runs the callbacks in sequence with no
2162 * concurrency. Failing this, no guarantee of correctness can be made. It is
2163 * the responsibility of the caller to ensure the executor provides this
2164 * guarantee. A simple way of creating such an executor is with the standard
2165 * tool {@code Executors.newSingleThreadExecutor}.
2166 * @param callback A {@link SocketKeepalive.Callback}. Used for notifications about keepalive
2167 * changes. Must be extended by applications that use this API.
2168 *
2169 * @return A {@link SocketKeepalive} object that can be used to control the keepalive on the
2170 * given socket.
2171 * @hide
2172 */
2173 @SystemApi
2174 @RequiresPermission(android.Manifest.permission.PACKET_KEEPALIVE_OFFLOAD)
junyulai7e06ad42019-03-04 22:45:36 +08002175 public @NonNull SocketKeepalive createSocketKeepalive(@NonNull Network network,
junyulai0835a1e2019-01-08 20:04:33 +08002176 @NonNull Socket socket,
2177 @NonNull Executor executor,
2178 @NonNull Callback callback) {
junyulai7e06ad42019-03-04 22:45:36 +08002179 ParcelFileDescriptor dup;
2180 try {
2181 dup = ParcelFileDescriptor.fromSocket(socket);
2182 } catch (UncheckedIOException ignored) {
2183 // Construct an invalid fd, so that if the user later calls start(), it will fail with
2184 // ERROR_INVALID_SOCKET.
Chiachang Wang619319a2021-01-15 11:06:21 +08002185 dup = createInvalidFd();
junyulai7e06ad42019-03-04 22:45:36 +08002186 }
2187 return new TcpSocketKeepalive(mService, network, dup, executor, callback);
junyulai0835a1e2019-01-08 20:04:33 +08002188 }
2189
2190 /**
The Android Open Source Project28527d22009-03-03 19:31:44 -08002191 * Ensure that a network route exists to deliver traffic to the specified
2192 * host via the specified network interface. An attempt to add a route that
2193 * already exists is ignored, but treated as successful.
Lorenzo Colitti0b40c872015-10-15 16:29:00 +09002194 *
2195 * <p>This method requires the caller to hold either the
2196 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
2197 * or the ability to modify system settings as determined by
2198 * {@link android.provider.Settings.System#canWrite}.</p>
2199 *
The Android Open Source Project28527d22009-03-03 19:31:44 -08002200 * @param networkType the type of the network over which traffic to the specified
2201 * host is to be routed
2202 * @param hostAddress the IP address of the host to which the route is desired
2203 * @return {@code true} on success, {@code false} on failure
Robert Greenwaltf3017f72014-05-18 23:07:25 -07002204 *
Lorenzo Colitti7f6a2bf2015-04-24 17:03:31 +09002205 * @deprecated Deprecated in favor of the
2206 * {@link #requestNetwork(NetworkRequest, NetworkCallback)},
2207 * {@link #bindProcessToNetwork} and {@link Network#getSocketFactory} API.
Dianne Hackborn18c1d832015-07-31 10:35:34 -07002208 * In {@link VERSION_CODES#M}, and above, this method is unsupported and will
Lorenzo Colitti2780e4b2015-07-29 11:41:21 +09002209 * throw {@code UnsupportedOperationException} if called.
Lorenzo Colitti84d7f072016-12-09 18:39:30 +09002210 * @removed
The Android Open Source Project28527d22009-03-03 19:31:44 -08002211 */
Aurimas Liutikase80a0eb2016-05-24 15:22:55 -07002212 @Deprecated
The Android Open Source Project28527d22009-03-03 19:31:44 -08002213 public boolean requestRouteToHost(int networkType, int hostAddress) {
Sreeram Ramachandranc06ec732014-07-19 23:21:46 -07002214 return requestRouteToHostAddress(networkType, NetworkUtils.intToInetAddress(hostAddress));
Robert Greenwalt7fe44cb2010-08-27 09:24:29 -07002215 }
2216
2217 /**
2218 * Ensure that a network route exists to deliver traffic to the specified
2219 * host via the specified network interface. An attempt to add a route that
2220 * already exists is ignored, but treated as successful.
Lorenzo Colitti0b40c872015-10-15 16:29:00 +09002221 *
2222 * <p>This method requires the caller to hold either the
2223 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
2224 * or the ability to modify system settings as determined by
2225 * {@link android.provider.Settings.System#canWrite}.</p>
2226 *
Robert Greenwalt7fe44cb2010-08-27 09:24:29 -07002227 * @param networkType the type of the network over which traffic to the specified
2228 * host is to be routed
2229 * @param hostAddress the IP address of the host to which the route is desired
2230 * @return {@code true} on success, {@code false} on failure
2231 * @hide
Robert Greenwaltf3017f72014-05-18 23:07:25 -07002232 * @deprecated Deprecated in favor of the {@link #requestNetwork} and
Lorenzo Colitti7f6a2bf2015-04-24 17:03:31 +09002233 * {@link #bindProcessToNetwork} API.
Robert Greenwalt7fe44cb2010-08-27 09:24:29 -07002234 */
Aurimas Liutikase80a0eb2016-05-24 15:22:55 -07002235 @Deprecated
Mathew Inwoodc5b9bec2018-08-08 14:52:47 +01002236 @UnsupportedAppUsage
lucasline257bce2021-03-22 11:51:27 +08002237 @SystemApi(client = MODULE_LIBRARIES)
Robert Greenwalt7fe44cb2010-08-27 09:24:29 -07002238 public boolean requestRouteToHostAddress(int networkType, InetAddress hostAddress) {
Lorenzo Colitti2780e4b2015-07-29 11:41:21 +09002239 checkLegacyRoutingApiAccess();
The Android Open Source Project28527d22009-03-03 19:31:44 -08002240 try {
Philip P. Moltmann7bc33df2020-03-26 11:50:35 -07002241 return mService.requestRouteToHostAddress(networkType, hostAddress.getAddress(),
2242 mContext.getOpPackageName(), getAttributionTag());
The Android Open Source Project28527d22009-03-03 19:31:44 -08002243 } catch (RemoteException e) {
Jeff Sharkeyc78f85c2016-03-01 19:27:23 -07002244 throw e.rethrowFromSystemServer();
The Android Open Source Project28527d22009-03-03 19:31:44 -08002245 }
2246 }
2247
2248 /**
Philip P. Moltmann7bc33df2020-03-26 11:50:35 -07002249 * @return the context's attribution tag
2250 */
2251 // TODO: Remove method and replace with direct call once R code is pushed to AOSP
2252 private @Nullable String getAttributionTag() {
Roshan Piusaa24fde2020-12-17 14:53:09 -08002253 return mContext.getAttributionTag();
Philip P. Moltmann7bc33df2020-03-26 11:50:35 -07002254 }
2255
2256 /**
The Android Open Source Project28527d22009-03-03 19:31:44 -08002257 * Returns the value of the setting for background data usage. If false,
2258 * applications should not use the network if the application is not in the
2259 * foreground. Developers should respect this setting, and check the value
2260 * of this before performing any background data operations.
2261 * <p>
2262 * All applications that have background services that use the network
2263 * should listen to {@link #ACTION_BACKGROUND_DATA_SETTING_CHANGED}.
Jeff Sharkey39c01eb2011-08-16 14:37:57 -07002264 * <p>
Scott Main50589142011-10-06 18:32:43 -07002265 * @deprecated As of {@link VERSION_CODES#ICE_CREAM_SANDWICH}, availability of
Jeff Sharkey39c01eb2011-08-16 14:37:57 -07002266 * background data depends on several combined factors, and this method will
2267 * always return {@code true}. Instead, when background data is unavailable,
2268 * {@link #getActiveNetworkInfo()} will now appear disconnected.
Danica Chang96567052010-08-11 14:54:43 -07002269 *
The Android Open Source Project28527d22009-03-03 19:31:44 -08002270 * @return Whether background data usage is allowed.
2271 */
Jeff Sharkey39c01eb2011-08-16 14:37:57 -07002272 @Deprecated
The Android Open Source Project28527d22009-03-03 19:31:44 -08002273 public boolean getBackgroundDataSetting() {
Jeff Sharkey39c01eb2011-08-16 14:37:57 -07002274 // assume that background data is allowed; final authority is
2275 // NetworkInfo which may be blocked.
2276 return true;
The Android Open Source Project28527d22009-03-03 19:31:44 -08002277 }
2278
2279 /**
2280 * Sets the value of the setting for background data usage.
Robert Greenwalt1b21f6c2010-02-23 18:58:05 -08002281 *
The Android Open Source Project28527d22009-03-03 19:31:44 -08002282 * @param allowBackgroundData Whether an application should use data while
2283 * it is in the background.
Robert Greenwalt1b21f6c2010-02-23 18:58:05 -08002284 *
The Android Open Source Project28527d22009-03-03 19:31:44 -08002285 * @attr ref android.Manifest.permission#CHANGE_BACKGROUND_DATA_SETTING
2286 * @see #getBackgroundDataSetting()
2287 * @hide
2288 */
Jeff Sharkey39c01eb2011-08-16 14:37:57 -07002289 @Deprecated
Mathew Inwoodc5b9bec2018-08-08 14:52:47 +01002290 @UnsupportedAppUsage
The Android Open Source Project28527d22009-03-03 19:31:44 -08002291 public void setBackgroundDataSetting(boolean allowBackgroundData) {
Jeff Sharkey39c01eb2011-08-16 14:37:57 -07002292 // ignored
The Android Open Source Project28527d22009-03-03 19:31:44 -08002293 }
Robert Greenwalt1b21f6c2010-02-23 18:58:05 -08002294
Jeff Sharkey66fa9682011-08-02 17:22:34 -07002295 /**
Robert Greenwalt1b21f6c2010-02-23 18:58:05 -08002296 * @hide
Robert Greenwalt0c150c02014-05-21 20:04:36 -07002297 * @deprecated Talk to TelephonyManager directly
Robert Greenwalt1b21f6c2010-02-23 18:58:05 -08002298 */
Aurimas Liutikase80a0eb2016-05-24 15:22:55 -07002299 @Deprecated
Mathew Inwoodc5b9bec2018-08-08 14:52:47 +01002300 @UnsupportedAppUsage
Robert Greenwalt1b21f6c2010-02-23 18:58:05 -08002301 public boolean getMobileDataEnabled() {
Meng Wanged6f4412019-11-18 17:10:00 -08002302 TelephonyManager tm = mContext.getSystemService(TelephonyManager.class);
2303 if (tm != null) {
2304 int subId = SubscriptionManager.getDefaultDataSubscriptionId();
2305 Log.d("ConnectivityManager", "getMobileDataEnabled()+ subId=" + subId);
2306 boolean retVal = tm.createForSubscriptionId(subId).isDataEnabled();
2307 Log.d("ConnectivityManager", "getMobileDataEnabled()- subId=" + subId
2308 + " retVal=" + retVal);
2309 return retVal;
Robert Greenwalt1b21f6c2010-02-23 18:58:05 -08002310 }
Wink Saville689f7042014-12-05 11:10:30 -08002311 Log.d("ConnectivityManager", "getMobileDataEnabled()- remote exception retVal=false");
Robert Greenwalt0c150c02014-05-21 20:04:36 -07002312 return false;
Robert Greenwalt1b21f6c2010-02-23 18:58:05 -08002313 }
2314
The Android Open Source Project28527d22009-03-03 19:31:44 -08002315 /**
Robert Greenwaltad35b132014-09-04 16:44:35 -07002316 * Callback for use with {@link ConnectivityManager#addDefaultNetworkActiveListener}
Robert Greenwaltf57c03c2014-06-11 16:05:07 -07002317 * to find out when the system default network has gone in to a high power state.
Dianne Hackborn5ac88162014-02-26 16:20:52 -08002318 */
2319 public interface OnNetworkActiveListener {
2320 /**
2321 * Called on the main thread of the process to report that the current data network
2322 * has become active, and it is now a good time to perform any pending network
2323 * operations. Note that this listener only tells you when the network becomes
2324 * active; if at any other time you want to know whether it is active (and thus okay
2325 * to initiate network traffic), you can retrieve its instantaneous state with
Robert Greenwaltf57c03c2014-06-11 16:05:07 -07002326 * {@link ConnectivityManager#isDefaultNetworkActive}.
Dianne Hackborn5ac88162014-02-26 16:20:52 -08002327 */
Chalard Jean9dd11612018-06-04 16:52:49 +09002328 void onNetworkActive();
Dianne Hackborn5ac88162014-02-26 16:20:52 -08002329 }
2330
Dianne Hackborn5ac88162014-02-26 16:20:52 -08002331 private final ArrayMap<OnNetworkActiveListener, INetworkActivityListener>
Chalard Jean9dd11612018-06-04 16:52:49 +09002332 mNetworkActivityListeners = new ArrayMap<>();
Dianne Hackborn5ac88162014-02-26 16:20:52 -08002333
2334 /**
Robert Greenwaltf57c03c2014-06-11 16:05:07 -07002335 * Start listening to reports when the system's default data network is active, meaning it is
2336 * a good time to perform network traffic. Use {@link #isDefaultNetworkActive()}
2337 * to determine the current state of the system's default network after registering the
2338 * listener.
2339 * <p>
2340 * If the process default network has been set with
Paul Jensenee2f45d2015-03-10 10:54:12 -04002341 * {@link ConnectivityManager#bindProcessToNetwork} this function will not
Robert Greenwaltf57c03c2014-06-11 16:05:07 -07002342 * reflect the process's default, but the system default.
Dianne Hackborn5ac88162014-02-26 16:20:52 -08002343 *
2344 * @param l The listener to be told when the network is active.
2345 */
Robert Greenwaltad35b132014-09-04 16:44:35 -07002346 public void addDefaultNetworkActiveListener(final OnNetworkActiveListener l) {
Dianne Hackborn5ac88162014-02-26 16:20:52 -08002347 INetworkActivityListener rl = new INetworkActivityListener.Stub() {
2348 @Override
2349 public void onNetworkActive() throws RemoteException {
2350 l.onNetworkActive();
2351 }
2352 };
2353
2354 try {
lucaslin1193a5d2021-01-21 02:04:15 +08002355 mService.registerNetworkActivityListener(rl);
Dianne Hackborn5ac88162014-02-26 16:20:52 -08002356 mNetworkActivityListeners.put(l, rl);
2357 } catch (RemoteException e) {
Jeff Sharkeyc78f85c2016-03-01 19:27:23 -07002358 throw e.rethrowFromSystemServer();
Dianne Hackborn5ac88162014-02-26 16:20:52 -08002359 }
2360 }
2361
2362 /**
2363 * Remove network active listener previously registered with
Robert Greenwaltad35b132014-09-04 16:44:35 -07002364 * {@link #addDefaultNetworkActiveListener}.
Dianne Hackborn5ac88162014-02-26 16:20:52 -08002365 *
2366 * @param l Previously registered listener.
2367 */
Chalard Jean158702d2019-01-07 19:26:34 +09002368 public void removeDefaultNetworkActiveListener(@NonNull OnNetworkActiveListener l) {
Dianne Hackborn5ac88162014-02-26 16:20:52 -08002369 INetworkActivityListener rl = mNetworkActivityListeners.get(l);
Remi NGUYEN VAN81f68422021-03-15 07:31:54 +00002370 if (rl == null) {
2371 throw new IllegalArgumentException("Listener was not registered.");
2372 }
Dianne Hackborn5ac88162014-02-26 16:20:52 -08002373 try {
lucaslin1193a5d2021-01-21 02:04:15 +08002374 mService.registerNetworkActivityListener(rl);
Dianne Hackborn5ac88162014-02-26 16:20:52 -08002375 } catch (RemoteException e) {
Jeff Sharkeyc78f85c2016-03-01 19:27:23 -07002376 throw e.rethrowFromSystemServer();
Dianne Hackborn5ac88162014-02-26 16:20:52 -08002377 }
2378 }
2379
2380 /**
2381 * Return whether the data network is currently active. An active network means that
2382 * it is currently in a high power state for performing data transmission. On some
2383 * types of networks, it may be expensive to move and stay in such a state, so it is
2384 * more power efficient to batch network traffic together when the radio is already in
2385 * this state. This method tells you whether right now is currently a good time to
2386 * initiate network traffic, as the network is already active.
2387 */
Robert Greenwaltf57c03c2014-06-11 16:05:07 -07002388 public boolean isDefaultNetworkActive() {
Dianne Hackborn5ac88162014-02-26 16:20:52 -08002389 try {
lucaslin1193a5d2021-01-21 02:04:15 +08002390 return mService.isDefaultNetworkActive();
Dianne Hackborn5ac88162014-02-26 16:20:52 -08002391 } catch (RemoteException e) {
Jeff Sharkeyc78f85c2016-03-01 19:27:23 -07002392 throw e.rethrowFromSystemServer();
Dianne Hackborn5ac88162014-02-26 16:20:52 -08002393 }
Dianne Hackborn5ac88162014-02-26 16:20:52 -08002394 }
2395
2396 /**
The Android Open Source Project28527d22009-03-03 19:31:44 -08002397 * {@hide}
2398 */
Lorenzo Colitti2780e4b2015-07-29 11:41:21 +09002399 public ConnectivityManager(Context context, IConnectivityManager service) {
Remi NGUYEN VAN81f68422021-03-15 07:31:54 +00002400 mContext = Objects.requireNonNull(context, "missing context");
2401 mService = Objects.requireNonNull(service, "missing IConnectivityManager");
Amos Bianchia9b415a2020-03-04 11:07:38 -08002402 mTetheringManager = (TetheringManager) mContext.getSystemService(Context.TETHERING_SERVICE);
Paul Jensenc0618a62014-12-10 15:12:18 -05002403 sInstance = this;
The Android Open Source Project28527d22009-03-03 19:31:44 -08002404 }
Robert Greenwalt0c4828c2010-01-26 11:40:34 -08002405
Jeff Sharkey2d9e5a52012-04-04 20:40:58 -07002406 /** {@hide} */
Mathew Inwoodc5b9bec2018-08-08 14:52:47 +01002407 @UnsupportedAppUsage
Jeff Sharkey2d9e5a52012-04-04 20:40:58 -07002408 public static ConnectivityManager from(Context context) {
2409 return (ConnectivityManager) context.getSystemService(Context.CONNECTIVITY_SERVICE);
2410 }
2411
Remi NGUYEN VAN85391292018-12-27 16:43:56 +09002412 /** @hide */
2413 public NetworkRequest getDefaultRequest() {
2414 try {
2415 // This is not racy as the default request is final in ConnectivityService.
2416 return mService.getDefaultRequest();
2417 } catch (RemoteException e) {
2418 throw e.rethrowFromSystemServer();
2419 }
2420 }
2421
Robert Greenwalt0c4828c2010-01-26 11:40:34 -08002422 /**
Philip P. Moltmann7bc33df2020-03-26 11:50:35 -07002423 * Check if the package is a allowed to write settings. This also accounts that such an access
2424 * happened.
2425 *
2426 * @return {@code true} iff the package is allowed to write settings.
2427 */
2428 // TODO: Remove method and replace with direct call once R code is pushed to AOSP
2429 private static boolean checkAndNoteWriteSettingsOperation(@NonNull Context context, int uid,
2430 @NonNull String callingPackage, @Nullable String callingAttributionTag,
2431 boolean throwException) {
2432 return Settings.checkAndNoteWriteSettingsOperation(context, uid, callingPackage,
2433 throwException);
2434 }
2435
2436 /**
Paul Jensenc0618a62014-12-10 15:12:18 -05002437 * @deprecated - use getSystemService. This is a kludge to support static access in certain
2438 * situations where a Context pointer is unavailable.
2439 * @hide
2440 */
Aurimas Liutikase80a0eb2016-05-24 15:22:55 -07002441 @Deprecated
Paul Jensenee2f45d2015-03-10 10:54:12 -04002442 static ConnectivityManager getInstanceOrNull() {
2443 return sInstance;
2444 }
2445
2446 /**
2447 * @deprecated - use getSystemService. This is a kludge to support static access in certain
2448 * situations where a Context pointer is unavailable.
2449 * @hide
2450 */
Aurimas Liutikase80a0eb2016-05-24 15:22:55 -07002451 @Deprecated
Mathew Inwoodc5b9bec2018-08-08 14:52:47 +01002452 @UnsupportedAppUsage
Paul Jensenee2f45d2015-03-10 10:54:12 -04002453 private static ConnectivityManager getInstance() {
2454 if (getInstanceOrNull() == null) {
Paul Jensenc0618a62014-12-10 15:12:18 -05002455 throw new IllegalStateException("No ConnectivityManager yet constructed");
2456 }
Paul Jensenee2f45d2015-03-10 10:54:12 -04002457 return getInstanceOrNull();
Paul Jensenc0618a62014-12-10 15:12:18 -05002458 }
2459
2460 /**
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08002461 * Get the set of tetherable, available interfaces. This list is limited by
2462 * device configuration and current interface existence.
2463 *
2464 * @return an array of 0 or more Strings of tetherable interface names.
2465 *
markchien6ae63e52020-01-21 13:11:06 +08002466 * @deprecated Use {@link TetheringEventCallback#onTetherableInterfacesChanged(List)} instead.
Robert Greenwalt0c4828c2010-01-26 11:40:34 -08002467 * {@hide}
2468 */
Jeff Sharkey656584a2017-04-24 11:18:03 -06002469 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Mathew Inwoodc5b9bec2018-08-08 14:52:47 +01002470 @UnsupportedAppUsage
markchien6ae63e52020-01-21 13:11:06 +08002471 @Deprecated
Robert Greenwalt0c4828c2010-01-26 11:40:34 -08002472 public String[] getTetherableIfaces() {
Amos Bianchia9b415a2020-03-04 11:07:38 -08002473 return mTetheringManager.getTetherableIfaces();
Robert Greenwalt0c4828c2010-01-26 11:40:34 -08002474 }
2475
2476 /**
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08002477 * Get the set of tethered interfaces.
2478 *
2479 * @return an array of 0 or more String of currently tethered interface names.
2480 *
markchien6ae63e52020-01-21 13:11:06 +08002481 * @deprecated Use {@link TetheringEventCallback#onTetherableInterfacesChanged(List)} instead.
Robert Greenwalt0c4828c2010-01-26 11:40:34 -08002482 * {@hide}
2483 */
Jeff Sharkey656584a2017-04-24 11:18:03 -06002484 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Mathew Inwoodc5b9bec2018-08-08 14:52:47 +01002485 @UnsupportedAppUsage
markchien6ae63e52020-01-21 13:11:06 +08002486 @Deprecated
Robert Greenwalt0c4828c2010-01-26 11:40:34 -08002487 public String[] getTetheredIfaces() {
Amos Bianchia9b415a2020-03-04 11:07:38 -08002488 return mTetheringManager.getTetheredIfaces();
Robert Greenwalt0c4828c2010-01-26 11:40:34 -08002489 }
2490
2491 /**
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08002492 * Get the set of interface names which attempted to tether but
2493 * failed. Re-attempting to tether may cause them to reset to the Tethered
2494 * state. Alternatively, causing the interface to be destroyed and recreated
2495 * may cause them to reset to the available state.
2496 * {@link ConnectivityManager#getLastTetherError} can be used to get more
2497 * information on the cause of the errors.
2498 *
2499 * @return an array of 0 or more String indicating the interface names
2500 * which failed to tether.
2501 *
markchien6ae63e52020-01-21 13:11:06 +08002502 * @deprecated Use {@link TetheringEventCallback#onError(String, int)} instead.
Robert Greenwalt0c4828c2010-01-26 11:40:34 -08002503 * {@hide}
2504 */
Jeff Sharkey656584a2017-04-24 11:18:03 -06002505 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Mathew Inwoodc5b9bec2018-08-08 14:52:47 +01002506 @UnsupportedAppUsage
markchien6ae63e52020-01-21 13:11:06 +08002507 @Deprecated
Robert Greenwalt4283ded2010-03-02 17:25:02 -08002508 public String[] getTetheringErroredIfaces() {
Amos Bianchia9b415a2020-03-04 11:07:38 -08002509 return mTetheringManager.getTetheringErroredIfaces();
Robert Greenwalt0c4828c2010-01-26 11:40:34 -08002510 }
2511
2512 /**
Robert Greenwalte594a762014-06-23 14:53:42 -07002513 * Get the set of tethered dhcp ranges.
2514 *
markchien2e6ba522020-02-14 11:55:48 +08002515 * @deprecated This method is not supported.
2516 * TODO: remove this function when all of clients are removed.
Robert Greenwalte594a762014-06-23 14:53:42 -07002517 * {@hide}
2518 */
paulhu8e96a752019-08-12 16:25:11 +08002519 @RequiresPermission(android.Manifest.permission.NETWORK_SETTINGS)
markchien6ae63e52020-01-21 13:11:06 +08002520 @Deprecated
Robert Greenwalte594a762014-06-23 14:53:42 -07002521 public String[] getTetheredDhcpRanges() {
markchien2e6ba522020-02-14 11:55:48 +08002522 throw new UnsupportedOperationException("getTetheredDhcpRanges is not supported");
Robert Greenwalte594a762014-06-23 14:53:42 -07002523 }
2524
2525 /**
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08002526 * Attempt to tether the named interface. This will setup a dhcp server
2527 * on the interface, forward and NAT IP packets and forward DNS requests
2528 * to the best active upstream network interface. Note that if no upstream
2529 * IP network interface is available, dhcp will still run and traffic will be
2530 * allowed between the tethered devices and this device, though upstream net
2531 * access will of course fail until an upstream network interface becomes
2532 * active.
Lorenzo Colitti0b40c872015-10-15 16:29:00 +09002533 *
2534 * <p>This method requires the caller to hold either the
2535 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
2536 * or the ability to modify system settings as determined by
2537 * {@link android.provider.Settings.System#canWrite}.</p>
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08002538 *
Jeremy Klein3dabcb92016-01-22 14:11:45 -08002539 * <p>WARNING: New clients should not use this function. The only usages should be in PanService
2540 * and WifiStateMachine which need direct access. All other clients should use
2541 * {@link #startTethering} and {@link #stopTethering} which encapsulate proper provisioning
2542 * logic.</p>
2543 *
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08002544 * @param iface the interface name to tether.
2545 * @return error a {@code TETHER_ERROR} value indicating success or failure type
markchien91c78e52020-01-20 19:31:56 +08002546 * @deprecated Use {@link TetheringManager#startTethering} instead
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08002547 *
Robert Greenwalt0c4828c2010-01-26 11:40:34 -08002548 * {@hide}
2549 */
Mathew Inwoode1a17ba2020-11-04 09:29:36 +00002550 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
markchien91c78e52020-01-20 19:31:56 +08002551 @Deprecated
Robert Greenwalt4283ded2010-03-02 17:25:02 -08002552 public int tether(String iface) {
Amos Bianchia9b415a2020-03-04 11:07:38 -08002553 return mTetheringManager.tether(iface);
Robert Greenwalt4283ded2010-03-02 17:25:02 -08002554 }
2555
2556 /**
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08002557 * Stop tethering the named interface.
Lorenzo Colitti0b40c872015-10-15 16:29:00 +09002558 *
2559 * <p>This method requires the caller to hold either the
2560 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
2561 * or the ability to modify system settings as determined by
2562 * {@link android.provider.Settings.System#canWrite}.</p>
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08002563 *
Jeremy Klein3dabcb92016-01-22 14:11:45 -08002564 * <p>WARNING: New clients should not use this function. The only usages should be in PanService
2565 * and WifiStateMachine which need direct access. All other clients should use
2566 * {@link #startTethering} and {@link #stopTethering} which encapsulate proper provisioning
2567 * logic.</p>
2568 *
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08002569 * @param iface the interface name to untether.
2570 * @return error a {@code TETHER_ERROR} value indicating success or failure type
2571 *
Robert Greenwalt4283ded2010-03-02 17:25:02 -08002572 * {@hide}
2573 */
Mathew Inwoodc5b9bec2018-08-08 14:52:47 +01002574 @UnsupportedAppUsage
markchien6ae63e52020-01-21 13:11:06 +08002575 @Deprecated
Robert Greenwalt4283ded2010-03-02 17:25:02 -08002576 public int untether(String iface) {
Amos Bianchia9b415a2020-03-04 11:07:38 -08002577 return mTetheringManager.untether(iface);
Robert Greenwalt0c4828c2010-01-26 11:40:34 -08002578 }
Robert Greenwalt8e87f122010-02-11 18:18:40 -08002579
2580 /**
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08002581 * Check if the device allows for tethering. It may be disabled via
Dianne Hackborn5ac88162014-02-26 16:20:52 -08002582 * {@code ro.tether.denied} system property, Settings.TETHER_SUPPORTED or
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08002583 * due to device configuration.
2584 *
Chalard Jeanffacaef2017-09-26 15:45:18 +09002585 * <p>If this app does not have permission to use this API, it will always
2586 * return false rather than throw an exception.</p>
2587 *
2588 * <p>If the device has a hotspot provisioning app, the caller is required to hold the
2589 * {@link android.Manifest.permission.TETHER_PRIVILEGED} permission.</p>
2590 *
2591 * <p>Otherwise, this method requires the caller to hold the ability to modify system
2592 * settings as determined by {@link android.provider.Settings.System#canWrite}.</p>
2593 *
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08002594 * @return a boolean - {@code true} indicating Tethering is supported.
2595 *
markchien6ae63e52020-01-21 13:11:06 +08002596 * @deprecated Use {@link TetheringEventCallback#onTetheringSupported(boolean)} instead.
Robert Greenwalt8e87f122010-02-11 18:18:40 -08002597 * {@hide}
2598 */
Jeremy Klein3dabcb92016-01-22 14:11:45 -08002599 @SystemApi
Chalard Jeanffacaef2017-09-26 15:45:18 +09002600 @RequiresPermission(anyOf = {android.Manifest.permission.TETHER_PRIVILEGED,
2601 android.Manifest.permission.WRITE_SETTINGS})
Robert Greenwalt8e87f122010-02-11 18:18:40 -08002602 public boolean isTetheringSupported() {
Amos Bianchia9b415a2020-03-04 11:07:38 -08002603 return mTetheringManager.isTetheringSupported();
Robert Greenwalt8e87f122010-02-11 18:18:40 -08002604 }
2605
2606 /**
Jeremy Klein3dabcb92016-01-22 14:11:45 -08002607 * Callback for use with {@link #startTethering} to find out whether tethering succeeded.
markchien91c78e52020-01-20 19:31:56 +08002608 *
2609 * @deprecated Use {@link TetheringManager.StartTetheringCallback} instead.
Jeremy Klein3dabcb92016-01-22 14:11:45 -08002610 * @hide
2611 */
2612 @SystemApi
markchien91c78e52020-01-20 19:31:56 +08002613 @Deprecated
Jeremy Klein3dabcb92016-01-22 14:11:45 -08002614 public static abstract class OnStartTetheringCallback {
2615 /**
2616 * Called when tethering has been successfully started.
2617 */
Chalard Jean9dd11612018-06-04 16:52:49 +09002618 public void onTetheringStarted() {}
Jeremy Klein3dabcb92016-01-22 14:11:45 -08002619
2620 /**
2621 * Called when starting tethering failed.
2622 */
Chalard Jean9dd11612018-06-04 16:52:49 +09002623 public void onTetheringFailed() {}
Jeremy Klein3dabcb92016-01-22 14:11:45 -08002624 }
2625
2626 /**
2627 * Convenient overload for
2628 * {@link #startTethering(int, boolean, OnStartTetheringCallback, Handler)} which passes a null
2629 * handler to run on the current thread's {@link Looper}.
markchien91c78e52020-01-20 19:31:56 +08002630 *
2631 * @deprecated Use {@link TetheringManager#startTethering} instead.
Jeremy Klein3dabcb92016-01-22 14:11:45 -08002632 * @hide
2633 */
2634 @SystemApi
markchien91c78e52020-01-20 19:31:56 +08002635 @Deprecated
Udam Saini8f7d6a72017-06-07 12:06:28 -07002636 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
Jeremy Klein3dabcb92016-01-22 14:11:45 -08002637 public void startTethering(int type, boolean showProvisioningUi,
2638 final OnStartTetheringCallback callback) {
2639 startTethering(type, showProvisioningUi, callback, null);
2640 }
2641
2642 /**
2643 * Runs tether provisioning for the given type if needed and then starts tethering if
2644 * the check succeeds. If no carrier provisioning is required for tethering, tethering is
2645 * enabled immediately. If provisioning fails, tethering will not be enabled. It also
2646 * schedules tether provisioning re-checks if appropriate.
2647 *
2648 * @param type The type of tethering to start. Must be one of
2649 * {@link ConnectivityManager.TETHERING_WIFI},
2650 * {@link ConnectivityManager.TETHERING_USB}, or
2651 * {@link ConnectivityManager.TETHERING_BLUETOOTH}.
2652 * @param showProvisioningUi a boolean indicating to show the provisioning app UI if there
2653 * is one. This should be true the first time this function is called and also any time
2654 * the user can see this UI. It gives users information from their carrier about the
2655 * check failing and how they can sign up for tethering if possible.
2656 * @param callback an {@link OnStartTetheringCallback} which will be called to notify the caller
2657 * of the result of trying to tether.
2658 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
markchien91c78e52020-01-20 19:31:56 +08002659 *
2660 * @deprecated Use {@link TetheringManager#startTethering} instead.
Jeremy Klein3dabcb92016-01-22 14:11:45 -08002661 * @hide
2662 */
2663 @SystemApi
markchien91c78e52020-01-20 19:31:56 +08002664 @Deprecated
Jeff Sharkey9b39e9a2017-06-02 17:36:26 -06002665 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
Jeremy Klein3dabcb92016-01-22 14:11:45 -08002666 public void startTethering(int type, boolean showProvisioningUi,
2667 final OnStartTetheringCallback callback, Handler handler) {
Remi NGUYEN VAN81f68422021-03-15 07:31:54 +00002668 Objects.requireNonNull(callback, "OnStartTetheringCallback cannot be null.");
Jeremy Klein35e99ea2016-03-12 16:29:54 -08002669
markchien91c78e52020-01-20 19:31:56 +08002670 final Executor executor = new Executor() {
Jeremy Klein3dabcb92016-01-22 14:11:45 -08002671 @Override
markchien91c78e52020-01-20 19:31:56 +08002672 public void execute(Runnable command) {
2673 if (handler == null) {
2674 command.run();
Jeremy Klein3dabcb92016-01-22 14:11:45 -08002675 } else {
markchien91c78e52020-01-20 19:31:56 +08002676 handler.post(command);
Jeremy Klein3dabcb92016-01-22 14:11:45 -08002677 }
2678 }
2679 };
Jeremy Klein35e99ea2016-03-12 16:29:54 -08002680
markchien91c78e52020-01-20 19:31:56 +08002681 final StartTetheringCallback tetheringCallback = new StartTetheringCallback() {
2682 @Override
2683 public void onTetheringStarted() {
2684 callback.onTetheringStarted();
2685 }
2686
2687 @Override
markchienf47d8342020-03-19 13:37:43 +08002688 public void onTetheringFailed(final int error) {
markchien91c78e52020-01-20 19:31:56 +08002689 callback.onTetheringFailed();
2690 }
2691 };
2692
2693 final TetheringRequest request = new TetheringRequest.Builder(type)
markchienf47d8342020-03-19 13:37:43 +08002694 .setShouldShowEntitlementUi(showProvisioningUi).build();
markchien91c78e52020-01-20 19:31:56 +08002695
Amos Bianchia9b415a2020-03-04 11:07:38 -08002696 mTetheringManager.startTethering(request, executor, tetheringCallback);
Jeremy Klein3dabcb92016-01-22 14:11:45 -08002697 }
2698
2699 /**
2700 * Stops tethering for the given type. Also cancels any provisioning rechecks for that type if
2701 * applicable.
2702 *
2703 * @param type The type of tethering to stop. Must be one of
2704 * {@link ConnectivityManager.TETHERING_WIFI},
2705 * {@link ConnectivityManager.TETHERING_USB}, or
2706 * {@link ConnectivityManager.TETHERING_BLUETOOTH}.
markchien6ae63e52020-01-21 13:11:06 +08002707 *
2708 * @deprecated Use {@link TetheringManager#stopTethering} instead.
Jeremy Klein3dabcb92016-01-22 14:11:45 -08002709 * @hide
2710 */
2711 @SystemApi
markchien6ae63e52020-01-21 13:11:06 +08002712 @Deprecated
Jeff Sharkey9b39e9a2017-06-02 17:36:26 -06002713 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
Jeremy Klein3dabcb92016-01-22 14:11:45 -08002714 public void stopTethering(int type) {
Amos Bianchia9b415a2020-03-04 11:07:38 -08002715 mTetheringManager.stopTethering(type);
Jeremy Klein3dabcb92016-01-22 14:11:45 -08002716 }
2717
2718 /**
markchien4ef53e82019-02-27 14:56:11 +08002719 * Callback for use with {@link registerTetheringEventCallback} to find out tethering
2720 * upstream status.
2721 *
Nathan Harold74f0fb82020-01-23 18:03:46 -08002722 * @deprecated Use {@link TetheringManager#OnTetheringEventCallback} instead.
markchien6ae63e52020-01-21 13:11:06 +08002723 * @hide
markchien4ef53e82019-02-27 14:56:11 +08002724 */
2725 @SystemApi
markchien6ae63e52020-01-21 13:11:06 +08002726 @Deprecated
markchien4ef53e82019-02-27 14:56:11 +08002727 public abstract static class OnTetheringEventCallback {
2728
2729 /**
2730 * Called when tethering upstream changed. This can be called multiple times and can be
2731 * called any time.
2732 *
2733 * @param network the {@link Network} of tethering upstream. Null means tethering doesn't
2734 * have any upstream.
2735 */
2736 public void onUpstreamChanged(@Nullable Network network) {}
2737 }
2738
markchien6ae63e52020-01-21 13:11:06 +08002739 @GuardedBy("mTetheringEventCallbacks")
2740 private final ArrayMap<OnTetheringEventCallback, TetheringEventCallback>
2741 mTetheringEventCallbacks = new ArrayMap<>();
2742
markchien4ef53e82019-02-27 14:56:11 +08002743 /**
2744 * Start listening to tethering change events. Any new added callback will receive the last
markchien42e22092019-04-03 10:43:09 +08002745 * tethering status right away. If callback is registered when tethering has no upstream or
markchien4ef53e82019-02-27 14:56:11 +08002746 * disabled, {@link OnTetheringEventCallback#onUpstreamChanged} will immediately be called
2747 * with a null argument. The same callback object cannot be registered twice.
2748 *
2749 * @param executor the executor on which callback will be invoked.
2750 * @param callback the callback to be called when tethering has change events.
markchien6ae63e52020-01-21 13:11:06 +08002751 *
Nathan Harold74f0fb82020-01-23 18:03:46 -08002752 * @deprecated Use {@link TetheringManager#registerTetheringEventCallback} instead.
markchien4ef53e82019-02-27 14:56:11 +08002753 * @hide
2754 */
2755 @SystemApi
markchien6ae63e52020-01-21 13:11:06 +08002756 @Deprecated
markchien4ef53e82019-02-27 14:56:11 +08002757 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
2758 public void registerTetheringEventCallback(
2759 @NonNull @CallbackExecutor Executor executor,
2760 @NonNull final OnTetheringEventCallback callback) {
Remi NGUYEN VAN81f68422021-03-15 07:31:54 +00002761 Objects.requireNonNull(callback, "OnTetheringEventCallback cannot be null.");
markchien4ef53e82019-02-27 14:56:11 +08002762
markchien6ae63e52020-01-21 13:11:06 +08002763 final TetheringEventCallback tetherCallback =
2764 new TetheringEventCallback() {
2765 @Override
2766 public void onUpstreamChanged(@Nullable Network network) {
2767 callback.onUpstreamChanged(network);
2768 }
2769 };
2770
2771 synchronized (mTetheringEventCallbacks) {
2772 mTetheringEventCallbacks.put(callback, tetherCallback);
Amos Bianchia9b415a2020-03-04 11:07:38 -08002773 mTetheringManager.registerTetheringEventCallback(executor, tetherCallback);
markchien6ae63e52020-01-21 13:11:06 +08002774 }
markchien4ef53e82019-02-27 14:56:11 +08002775 }
2776
2777 /**
2778 * Remove tethering event callback previously registered with
2779 * {@link #registerTetheringEventCallback}.
2780 *
2781 * @param callback previously registered callback.
markchien6ae63e52020-01-21 13:11:06 +08002782 *
2783 * @deprecated Use {@link TetheringManager#unregisterTetheringEventCallback} instead.
markchien4ef53e82019-02-27 14:56:11 +08002784 * @hide
2785 */
2786 @SystemApi
markchien6ae63e52020-01-21 13:11:06 +08002787 @Deprecated
markchien4ef53e82019-02-27 14:56:11 +08002788 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
2789 public void unregisterTetheringEventCallback(
2790 @NonNull final OnTetheringEventCallback callback) {
markchien6ae63e52020-01-21 13:11:06 +08002791 Objects.requireNonNull(callback, "The callback must be non-null");
2792 synchronized (mTetheringEventCallbacks) {
2793 final TetheringEventCallback tetherCallback =
2794 mTetheringEventCallbacks.remove(callback);
Amos Bianchia9b415a2020-03-04 11:07:38 -08002795 mTetheringManager.unregisterTetheringEventCallback(tetherCallback);
markchien6ae63e52020-01-21 13:11:06 +08002796 }
markchien4ef53e82019-02-27 14:56:11 +08002797 }
2798
2799
2800 /**
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08002801 * Get the list of regular expressions that define any tetherable
2802 * USB network interfaces. If USB tethering is not supported by the
2803 * device, this list should be empty.
2804 *
2805 * @return an array of 0 or more regular expression Strings defining
2806 * what interfaces are considered tetherable usb interfaces.
2807 *
markchien6ae63e52020-01-21 13:11:06 +08002808 * @deprecated Use {@link TetheringEventCallback#onTetherableInterfaceRegexpsChanged} instead.
Robert Greenwalt8e87f122010-02-11 18:18:40 -08002809 * {@hide}
2810 */
Jeff Sharkey656584a2017-04-24 11:18:03 -06002811 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Mathew Inwoodc5b9bec2018-08-08 14:52:47 +01002812 @UnsupportedAppUsage
markchien6ae63e52020-01-21 13:11:06 +08002813 @Deprecated
Robert Greenwalt8e87f122010-02-11 18:18:40 -08002814 public String[] getTetherableUsbRegexs() {
Amos Bianchia9b415a2020-03-04 11:07:38 -08002815 return mTetheringManager.getTetherableUsbRegexs();
Robert Greenwalt8e87f122010-02-11 18:18:40 -08002816 }
2817
2818 /**
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08002819 * Get the list of regular expressions that define any tetherable
2820 * Wifi network interfaces. If Wifi tethering is not supported by the
2821 * device, this list should be empty.
2822 *
2823 * @return an array of 0 or more regular expression Strings defining
2824 * what interfaces are considered tetherable wifi interfaces.
2825 *
markchien6ae63e52020-01-21 13:11:06 +08002826 * @deprecated Use {@link TetheringEventCallback#onTetherableInterfaceRegexpsChanged} instead.
Robert Greenwalt8e87f122010-02-11 18:18:40 -08002827 * {@hide}
2828 */
Jeff Sharkey656584a2017-04-24 11:18:03 -06002829 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Mathew Inwoodc5b9bec2018-08-08 14:52:47 +01002830 @UnsupportedAppUsage
markchien6ae63e52020-01-21 13:11:06 +08002831 @Deprecated
Robert Greenwalt8e87f122010-02-11 18:18:40 -08002832 public String[] getTetherableWifiRegexs() {
Amos Bianchia9b415a2020-03-04 11:07:38 -08002833 return mTetheringManager.getTetherableWifiRegexs();
Robert Greenwalt8e87f122010-02-11 18:18:40 -08002834 }
Robert Greenwalt4283ded2010-03-02 17:25:02 -08002835
Danica Chang96567052010-08-11 14:54:43 -07002836 /**
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08002837 * Get the list of regular expressions that define any tetherable
2838 * Bluetooth network interfaces. If Bluetooth tethering is not supported by the
2839 * device, this list should be empty.
2840 *
2841 * @return an array of 0 or more regular expression Strings defining
2842 * what interfaces are considered tetherable bluetooth interfaces.
2843 *
markchien6ae63e52020-01-21 13:11:06 +08002844 * @deprecated Use {@link TetheringEventCallback#onTetherableInterfaceRegexpsChanged(
2845 *TetheringManager.TetheringInterfaceRegexps)} instead.
Danica Chang96567052010-08-11 14:54:43 -07002846 * {@hide}
2847 */
Jeff Sharkey656584a2017-04-24 11:18:03 -06002848 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Mathew Inwoodc5b9bec2018-08-08 14:52:47 +01002849 @UnsupportedAppUsage
markchien6ae63e52020-01-21 13:11:06 +08002850 @Deprecated
Danica Chang96567052010-08-11 14:54:43 -07002851 public String[] getTetherableBluetoothRegexs() {
Amos Bianchia9b415a2020-03-04 11:07:38 -08002852 return mTetheringManager.getTetherableBluetoothRegexs();
Danica Chang96567052010-08-11 14:54:43 -07002853 }
2854
Mike Lockwooded4a1742011-07-19 13:04:47 -07002855 /**
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08002856 * Attempt to both alter the mode of USB and Tethering of USB. A
2857 * utility method to deal with some of the complexity of USB - will
2858 * attempt to switch to Rndis and subsequently tether the resulting
2859 * interface on {@code true} or turn off tethering and switch off
2860 * Rndis on {@code false}.
Lorenzo Colitti0b40c872015-10-15 16:29:00 +09002861 *
2862 * <p>This method requires the caller to hold either the
2863 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
2864 * or the ability to modify system settings as determined by
2865 * {@link android.provider.Settings.System#canWrite}.</p>
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08002866 *
2867 * @param enable a boolean - {@code true} to enable tethering
2868 * @return error a {@code TETHER_ERROR} value indicating success or failure type
markchien91c78e52020-01-20 19:31:56 +08002869 * @deprecated Use {@link TetheringManager#startTethering} instead
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08002870 *
Mike Lockwooded4a1742011-07-19 13:04:47 -07002871 * {@hide}
2872 */
Mathew Inwoodc5b9bec2018-08-08 14:52:47 +01002873 @UnsupportedAppUsage
markchien91c78e52020-01-20 19:31:56 +08002874 @Deprecated
Mike Lockwooded4a1742011-07-19 13:04:47 -07002875 public int setUsbTethering(boolean enable) {
Amos Bianchia9b415a2020-03-04 11:07:38 -08002876 return mTetheringManager.setUsbTethering(enable);
Mike Lockwooded4a1742011-07-19 13:04:47 -07002877 }
2878
markchien6ae63e52020-01-21 13:11:06 +08002879 /**
2880 * @deprecated Use {@link TetheringManager#TETHER_ERROR_NO_ERROR}.
2881 * {@hide}
2882 */
markchien0f45bb92019-01-16 17:44:13 +08002883 @SystemApi
markchien6ae63e52020-01-21 13:11:06 +08002884 @Deprecated
Remi NGUYEN VAN09f8ed22021-02-15 18:52:06 +09002885 public static final int TETHER_ERROR_NO_ERROR = 0;
markchien6ae63e52020-01-21 13:11:06 +08002886 /**
2887 * @deprecated Use {@link TetheringManager#TETHER_ERROR_UNKNOWN_IFACE}.
2888 * {@hide}
2889 */
2890 @Deprecated
2891 public static final int TETHER_ERROR_UNKNOWN_IFACE =
2892 TetheringManager.TETHER_ERROR_UNKNOWN_IFACE;
2893 /**
2894 * @deprecated Use {@link TetheringManager#TETHER_ERROR_SERVICE_UNAVAIL}.
2895 * {@hide}
2896 */
2897 @Deprecated
2898 public static final int TETHER_ERROR_SERVICE_UNAVAIL =
2899 TetheringManager.TETHER_ERROR_SERVICE_UNAVAIL;
2900 /**
2901 * @deprecated Use {@link TetheringManager#TETHER_ERROR_UNSUPPORTED}.
2902 * {@hide}
2903 */
2904 @Deprecated
2905 public static final int TETHER_ERROR_UNSUPPORTED = TetheringManager.TETHER_ERROR_UNSUPPORTED;
2906 /**
2907 * @deprecated Use {@link TetheringManager#TETHER_ERROR_UNAVAIL_IFACE}.
2908 * {@hide}
2909 */
2910 @Deprecated
2911 public static final int TETHER_ERROR_UNAVAIL_IFACE =
2912 TetheringManager.TETHER_ERROR_UNAVAIL_IFACE;
2913 /**
markchienf47d8342020-03-19 13:37:43 +08002914 * @deprecated Use {@link TetheringManager#TETHER_ERROR_INTERNAL_ERROR}.
markchien6ae63e52020-01-21 13:11:06 +08002915 * {@hide}
2916 */
2917 @Deprecated
markchienf47d8342020-03-19 13:37:43 +08002918 public static final int TETHER_ERROR_MASTER_ERROR =
2919 TetheringManager.TETHER_ERROR_INTERNAL_ERROR;
markchien6ae63e52020-01-21 13:11:06 +08002920 /**
2921 * @deprecated Use {@link TetheringManager#TETHER_ERROR_TETHER_IFACE_ERROR}.
2922 * {@hide}
2923 */
2924 @Deprecated
2925 public static final int TETHER_ERROR_TETHER_IFACE_ERROR =
2926 TetheringManager.TETHER_ERROR_TETHER_IFACE_ERROR;
2927 /**
2928 * @deprecated Use {@link TetheringManager#TETHER_ERROR_UNTETHER_IFACE_ERROR}.
2929 * {@hide}
2930 */
2931 @Deprecated
2932 public static final int TETHER_ERROR_UNTETHER_IFACE_ERROR =
2933 TetheringManager.TETHER_ERROR_UNTETHER_IFACE_ERROR;
2934 /**
markchienf47d8342020-03-19 13:37:43 +08002935 * @deprecated Use {@link TetheringManager#TETHER_ERROR_ENABLE_FORWARDING_ERROR}.
markchien6ae63e52020-01-21 13:11:06 +08002936 * {@hide}
2937 */
2938 @Deprecated
2939 public static final int TETHER_ERROR_ENABLE_NAT_ERROR =
markchienf47d8342020-03-19 13:37:43 +08002940 TetheringManager.TETHER_ERROR_ENABLE_FORWARDING_ERROR;
markchien6ae63e52020-01-21 13:11:06 +08002941 /**
markchienf47d8342020-03-19 13:37:43 +08002942 * @deprecated Use {@link TetheringManager#TETHER_ERROR_DISABLE_FORWARDING_ERROR}.
markchien6ae63e52020-01-21 13:11:06 +08002943 * {@hide}
2944 */
2945 @Deprecated
2946 public static final int TETHER_ERROR_DISABLE_NAT_ERROR =
markchienf47d8342020-03-19 13:37:43 +08002947 TetheringManager.TETHER_ERROR_DISABLE_FORWARDING_ERROR;
markchien6ae63e52020-01-21 13:11:06 +08002948 /**
2949 * @deprecated Use {@link TetheringManager#TETHER_ERROR_IFACE_CFG_ERROR}.
2950 * {@hide}
2951 */
2952 @Deprecated
2953 public static final int TETHER_ERROR_IFACE_CFG_ERROR =
2954 TetheringManager.TETHER_ERROR_IFACE_CFG_ERROR;
2955 /**
markchienf47d8342020-03-19 13:37:43 +08002956 * @deprecated Use {@link TetheringManager#TETHER_ERROR_PROVISIONING_FAILED}.
markchien6ae63e52020-01-21 13:11:06 +08002957 * {@hide}
2958 */
markchien0f45bb92019-01-16 17:44:13 +08002959 @SystemApi
markchien6ae63e52020-01-21 13:11:06 +08002960 @Deprecated
Remi NGUYEN VAN09f8ed22021-02-15 18:52:06 +09002961 public static final int TETHER_ERROR_PROVISION_FAILED = 11;
markchien6ae63e52020-01-21 13:11:06 +08002962 /**
2963 * @deprecated Use {@link TetheringManager#TETHER_ERROR_DHCPSERVER_ERROR}.
2964 * {@hide}
2965 */
2966 @Deprecated
2967 public static final int TETHER_ERROR_DHCPSERVER_ERROR =
2968 TetheringManager.TETHER_ERROR_DHCPSERVER_ERROR;
2969 /**
2970 * @deprecated Use {@link TetheringManager#TETHER_ERROR_ENTITLEMENT_UNKNOWN}.
2971 * {@hide}
2972 */
markchien0f45bb92019-01-16 17:44:13 +08002973 @SystemApi
markchien6ae63e52020-01-21 13:11:06 +08002974 @Deprecated
Remi NGUYEN VAN09f8ed22021-02-15 18:52:06 +09002975 public static final int TETHER_ERROR_ENTITLEMENT_UNKONWN = 13;
Robert Greenwalt4283ded2010-03-02 17:25:02 -08002976
2977 /**
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08002978 * Get a more detailed error code after a Tethering or Untethering
2979 * request asynchronously failed.
2980 *
2981 * @param iface The name of the interface of interest
Robert Greenwalt4283ded2010-03-02 17:25:02 -08002982 * @return error The error code of the last error tethering or untethering the named
2983 * interface
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08002984 *
markchien6ae63e52020-01-21 13:11:06 +08002985 * @deprecated Use {@link TetheringEventCallback#onError(String, int)} instead.
Robert Greenwalt4283ded2010-03-02 17:25:02 -08002986 * {@hide}
2987 */
Jeff Sharkey656584a2017-04-24 11:18:03 -06002988 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Mathew Inwoode1a17ba2020-11-04 09:29:36 +00002989 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
markchien6ae63e52020-01-21 13:11:06 +08002990 @Deprecated
Robert Greenwalt4283ded2010-03-02 17:25:02 -08002991 public int getLastTetherError(String iface) {
markchienf47d8342020-03-19 13:37:43 +08002992 int error = mTetheringManager.getLastTetherError(iface);
2993 if (error == TetheringManager.TETHER_ERROR_UNKNOWN_TYPE) {
2994 // TETHER_ERROR_UNKNOWN_TYPE was introduced with TetheringManager and has never been
2995 // returned by ConnectivityManager. Convert it to the legacy TETHER_ERROR_UNKNOWN_IFACE
2996 // instead.
2997 error = TetheringManager.TETHER_ERROR_UNKNOWN_IFACE;
2998 }
2999 return error;
Robert Greenwalt93dc1042010-06-15 12:19:37 -07003000 }
3001
markchienbf5ab012019-03-06 16:25:00 +08003002 /** @hide */
3003 @Retention(RetentionPolicy.SOURCE)
3004 @IntDef(value = {
3005 TETHER_ERROR_NO_ERROR,
3006 TETHER_ERROR_PROVISION_FAILED,
3007 TETHER_ERROR_ENTITLEMENT_UNKONWN,
3008 })
3009 public @interface EntitlementResultCode {
3010 }
3011
Robert Greenwalt93dc1042010-06-15 12:19:37 -07003012 /**
markchienbf5ab012019-03-06 16:25:00 +08003013 * Callback for use with {@link #getLatestTetheringEntitlementResult} to find out whether
markchien0f45bb92019-01-16 17:44:13 +08003014 * entitlement succeeded.
markchien6ae63e52020-01-21 13:11:06 +08003015 *
3016 * @deprecated Use {@link TetheringManager#OnTetheringEntitlementResultListener} instead.
markchien0f45bb92019-01-16 17:44:13 +08003017 * @hide
3018 */
3019 @SystemApi
markchien6ae63e52020-01-21 13:11:06 +08003020 @Deprecated
markchienbf5ab012019-03-06 16:25:00 +08003021 public interface OnTetheringEntitlementResultListener {
3022 /**
3023 * Called to notify entitlement result.
3024 *
3025 * @param resultCode an int value of entitlement result. It may be one of
3026 * {@link #TETHER_ERROR_NO_ERROR},
3027 * {@link #TETHER_ERROR_PROVISION_FAILED}, or
3028 * {@link #TETHER_ERROR_ENTITLEMENT_UNKONWN}.
3029 */
Jeremy Klein7e7c7422019-03-12 13:32:08 -07003030 void onTetheringEntitlementResult(@EntitlementResultCode int resultCode);
markchienbf5ab012019-03-06 16:25:00 +08003031 }
3032
3033 /**
markchien0f45bb92019-01-16 17:44:13 +08003034 * Get the last value of the entitlement check on this downstream. If the cached value is
3035 * {@link #TETHER_ERROR_NO_ERROR} or showEntitlementUi argument is false, it just return the
3036 * cached value. Otherwise, a UI-based entitlement check would be performed. It is not
3037 * guaranteed that the UI-based entitlement check will complete in any specific time period
3038 * and may in fact never complete. Any successful entitlement check the platform performs for
3039 * any reason will update the cached value.
3040 *
3041 * @param type the downstream type of tethering. Must be one of
3042 * {@link #TETHERING_WIFI},
3043 * {@link #TETHERING_USB}, or
3044 * {@link #TETHERING_BLUETOOTH}.
3045 * @param showEntitlementUi a boolean indicating whether to run UI-based entitlement check.
markchienbf5ab012019-03-06 16:25:00 +08003046 * @param executor the executor on which callback will be invoked.
3047 * @param listener an {@link OnTetheringEntitlementResultListener} which will be called to
3048 * notify the caller of the result of entitlement check. The listener may be called zero
3049 * or one time.
markchien6ae63e52020-01-21 13:11:06 +08003050 * @deprecated Use {@link TetheringManager#requestLatestTetheringEntitlementResult} instead.
markchien0f45bb92019-01-16 17:44:13 +08003051 * {@hide}
3052 */
3053 @SystemApi
markchien6ae63e52020-01-21 13:11:06 +08003054 @Deprecated
markchien0f45bb92019-01-16 17:44:13 +08003055 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
markchienbf5ab012019-03-06 16:25:00 +08003056 public void getLatestTetheringEntitlementResult(int type, boolean showEntitlementUi,
3057 @NonNull @CallbackExecutor Executor executor,
3058 @NonNull final OnTetheringEntitlementResultListener listener) {
Remi NGUYEN VAN81f68422021-03-15 07:31:54 +00003059 Objects.requireNonNull(listener, "TetheringEntitlementResultListener cannot be null.");
markchienbf5ab012019-03-06 16:25:00 +08003060 ResultReceiver wrappedListener = new ResultReceiver(null) {
3061 @Override
3062 protected void onReceiveResult(int resultCode, Bundle resultData) {
lucaslinc6170bb2021-03-04 09:38:21 +08003063 final long token = Binder.clearCallingIdentity();
3064 try {
3065 executor.execute(() -> {
3066 listener.onTetheringEntitlementResult(resultCode);
3067 });
3068 } finally {
3069 Binder.restoreCallingIdentity(token);
3070 }
markchienbf5ab012019-03-06 16:25:00 +08003071 }
3072 };
3073
Amos Bianchia9b415a2020-03-04 11:07:38 -08003074 mTetheringManager.requestLatestTetheringEntitlementResult(type, wrappedListener,
markchien5776f962019-12-16 20:15:20 +08003075 showEntitlementUi);
markchienbf5ab012019-03-06 16:25:00 +08003076 }
3077
3078 /**
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08003079 * Report network connectivity status. This is currently used only
3080 * to alter status bar UI.
Paul Jensen08f9dbb2015-05-06 11:10:18 -04003081 * <p>This method requires the caller to hold the permission
3082 * {@link android.Manifest.permission#STATUS_BAR}.
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08003083 *
Robert Greenwalt986c7412010-09-08 15:24:47 -07003084 * @param networkType The type of network you want to report on
3085 * @param percentage The quality of the connection 0 is bad, 100 is good
Chalard Jean7eaf3b12018-03-08 13:54:53 +09003086 * @deprecated Types are deprecated. Use {@link #reportNetworkConnectivity} instead.
Robert Greenwalt986c7412010-09-08 15:24:47 -07003087 * {@hide}
3088 */
3089 public void reportInetCondition(int networkType, int percentage) {
Soi, Yoshinarib8102ef2015-11-12 12:09:02 +09003090 printStackTrace();
Robert Greenwalt986c7412010-09-08 15:24:47 -07003091 try {
3092 mService.reportInetCondition(networkType, percentage);
3093 } catch (RemoteException e) {
Jeff Sharkeyc78f85c2016-03-01 19:27:23 -07003094 throw e.rethrowFromSystemServer();
Robert Greenwalt986c7412010-09-08 15:24:47 -07003095 }
3096 }
Robert Greenwaltc3c5f862010-10-11 16:00:27 -07003097
3098 /**
Robert Greenwaltf3017f72014-05-18 23:07:25 -07003099 * Report a problem network to the framework. This provides a hint to the system
Ye Wenca7abab2014-07-21 14:19:01 -07003100 * that there might be connectivity problems on this network and may cause
Robert Greenwaltf3017f72014-05-18 23:07:25 -07003101 * the framework to re-evaluate network connectivity and/or switch to another
3102 * network.
Robert Greenwaltf99b8392014-03-26 16:47:06 -07003103 *
Robert Greenwaltf3017f72014-05-18 23:07:25 -07003104 * @param network The {@link Network} the application was attempting to use
3105 * or {@code null} to indicate the current default network.
Paul Jensenb95d7952015-04-07 12:43:13 -04003106 * @deprecated Use {@link #reportNetworkConnectivity} which allows reporting both
3107 * working and non-working connectivity.
Robert Greenwaltf99b8392014-03-26 16:47:06 -07003108 */
Aurimas Liutikase80a0eb2016-05-24 15:22:55 -07003109 @Deprecated
Chalard Jean158702d2019-01-07 19:26:34 +09003110 public void reportBadNetwork(@Nullable Network network) {
Soi, Yoshinarib8102ef2015-11-12 12:09:02 +09003111 printStackTrace();
Robert Greenwaltf99b8392014-03-26 16:47:06 -07003112 try {
Paul Jensenb95d7952015-04-07 12:43:13 -04003113 // One of these will be ignored because it matches system's current state.
3114 // The other will trigger the necessary reevaluation.
3115 mService.reportNetworkConnectivity(network, true);
3116 mService.reportNetworkConnectivity(network, false);
3117 } catch (RemoteException e) {
Jeff Sharkeyc78f85c2016-03-01 19:27:23 -07003118 throw e.rethrowFromSystemServer();
Paul Jensenb95d7952015-04-07 12:43:13 -04003119 }
3120 }
3121
3122 /**
3123 * Report to the framework whether a network has working connectivity.
3124 * This provides a hint to the system that a particular network is providing
3125 * working connectivity or not. In response the framework may re-evaluate
3126 * the network's connectivity and might take further action thereafter.
3127 *
3128 * @param network The {@link Network} the application was attempting to use
3129 * or {@code null} to indicate the current default network.
3130 * @param hasConnectivity {@code true} if the application was able to successfully access the
3131 * Internet using {@code network} or {@code false} if not.
3132 */
Chalard Jean158702d2019-01-07 19:26:34 +09003133 public void reportNetworkConnectivity(@Nullable Network network, boolean hasConnectivity) {
Soi, Yoshinarib8102ef2015-11-12 12:09:02 +09003134 printStackTrace();
Paul Jensenb95d7952015-04-07 12:43:13 -04003135 try {
3136 mService.reportNetworkConnectivity(network, hasConnectivity);
Robert Greenwaltf99b8392014-03-26 16:47:06 -07003137 } catch (RemoteException e) {
Jeff Sharkeyc78f85c2016-03-01 19:27:23 -07003138 throw e.rethrowFromSystemServer();
Robert Greenwaltf99b8392014-03-26 16:47:06 -07003139 }
3140 }
3141
3142 /**
Chalard Jean48d60ea2021-03-17 17:03:34 +09003143 * Set a network-independent global HTTP proxy.
Paul Jensen08f9dbb2015-05-06 11:10:18 -04003144 *
Chalard Jean48d60ea2021-03-17 17:03:34 +09003145 * This sets an HTTP proxy that applies to all networks and overrides any network-specific
3146 * proxy. If set, HTTP libraries that are proxy-aware will use this global proxy when
3147 * accessing any network, regardless of what the settings for that network are.
3148 *
3149 * Note that HTTP proxies are by nature typically network-dependent, and setting a global
3150 * proxy is likely to break networking on multiple networks. This method is only meant
3151 * for device policy clients looking to do general internal filtering or similar use cases.
3152 *
3153 * {@see #getGlobalProxy}
3154 * {@see LinkProperties#getHttpProxy}
3155 *
3156 * @param p A {@link ProxyInfo} object defining the new global HTTP proxy. Calling this
3157 * method with a {@code null} value will clear the global HTTP proxy.
Robert Greenwaltf3017f72014-05-18 23:07:25 -07003158 * @hide
Robert Greenwaltc3c5f862010-10-11 16:00:27 -07003159 */
Chalard Jean48d60ea2021-03-17 17:03:34 +09003160 // Used by Device Policy Manager to set the global proxy.
Chiachang Wang4d513572021-03-18 09:44:34 +08003161 @SystemApi(client = MODULE_LIBRARIES)
paulhu8e96a752019-08-12 16:25:11 +08003162 @RequiresPermission(android.Manifest.permission.NETWORK_STACK)
Chalard Jean48d60ea2021-03-17 17:03:34 +09003163 public void setGlobalProxy(@Nullable final ProxyInfo p) {
Robert Greenwaltc3c5f862010-10-11 16:00:27 -07003164 try {
3165 mService.setGlobalProxy(p);
3166 } catch (RemoteException e) {
Jeff Sharkeyc78f85c2016-03-01 19:27:23 -07003167 throw e.rethrowFromSystemServer();
Robert Greenwaltc3c5f862010-10-11 16:00:27 -07003168 }
3169 }
3170
3171 /**
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08003172 * Retrieve any network-independent global HTTP proxy.
3173 *
Jason Monk4d5e20f2014-04-25 15:00:09 -04003174 * @return {@link ProxyInfo} for the current global HTTP proxy or {@code null}
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08003175 * if no global HTTP proxy is set.
Robert Greenwaltf3017f72014-05-18 23:07:25 -07003176 * @hide
Robert Greenwaltc3c5f862010-10-11 16:00:27 -07003177 */
Chiachang Wang4d513572021-03-18 09:44:34 +08003178 @SystemApi(client = MODULE_LIBRARIES)
3179 @Nullable
Jason Monk4d5e20f2014-04-25 15:00:09 -04003180 public ProxyInfo getGlobalProxy() {
Robert Greenwaltc3c5f862010-10-11 16:00:27 -07003181 try {
3182 return mService.getGlobalProxy();
3183 } catch (RemoteException e) {
Jeff Sharkeyc78f85c2016-03-01 19:27:23 -07003184 throw e.rethrowFromSystemServer();
Robert Greenwaltc3c5f862010-10-11 16:00:27 -07003185 }
3186 }
3187
3188 /**
Paul Jensendb93dd92015-05-06 07:32:40 -04003189 * Retrieve the global HTTP proxy, or if no global HTTP proxy is set, a
3190 * network-specific HTTP proxy. If {@code network} is null, the
3191 * network-specific proxy returned is the proxy of the default active
3192 * network.
3193 *
3194 * @return {@link ProxyInfo} for the current global HTTP proxy, or if no
3195 * global HTTP proxy is set, {@code ProxyInfo} for {@code network},
3196 * or when {@code network} is {@code null},
3197 * the {@code ProxyInfo} for the default active network. Returns
3198 * {@code null} when no proxy applies or the caller doesn't have
3199 * permission to use {@code network}.
3200 * @hide
3201 */
3202 public ProxyInfo getProxyForNetwork(Network network) {
3203 try {
3204 return mService.getProxyForNetwork(network);
3205 } catch (RemoteException e) {
Jeff Sharkeyc78f85c2016-03-01 19:27:23 -07003206 throw e.rethrowFromSystemServer();
Paul Jensendb93dd92015-05-06 07:32:40 -04003207 }
3208 }
3209
3210 /**
Paul Jensenc0618a62014-12-10 15:12:18 -05003211 * Get the current default HTTP proxy settings. If a global proxy is set it will be returned,
3212 * otherwise if this process is bound to a {@link Network} using
Paul Jensenee2f45d2015-03-10 10:54:12 -04003213 * {@link #bindProcessToNetwork} then that {@code Network}'s proxy is returned, otherwise
Paul Jensenc0618a62014-12-10 15:12:18 -05003214 * the default network's proxy is returned.
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08003215 *
Jason Monk4d5e20f2014-04-25 15:00:09 -04003216 * @return the {@link ProxyInfo} for the current HTTP proxy, or {@code null} if no
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08003217 * HTTP proxy is active.
Robert Greenwaltc3c5f862010-10-11 16:00:27 -07003218 */
Chalard Jean158702d2019-01-07 19:26:34 +09003219 @Nullable
Paul Jensenc0618a62014-12-10 15:12:18 -05003220 public ProxyInfo getDefaultProxy() {
Paul Jensendb93dd92015-05-06 07:32:40 -04003221 return getProxyForNetwork(getBoundNetworkForProcess());
Robert Greenwaltc3c5f862010-10-11 16:00:27 -07003222 }
Robert Greenwalt34848c02011-03-25 13:09:25 -07003223
3224 /**
Robert Greenwalt0114f6e2011-08-31 11:46:42 -07003225 * Returns true if the hardware supports the given network type
3226 * else it returns false. This doesn't indicate we have coverage
3227 * or are authorized onto a network, just whether or not the
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08003228 * hardware supports it. For example a GSM phone without a SIM
3229 * should still return {@code true} for mobile data, but a wifi only
3230 * tablet would return {@code false}.
3231 *
3232 * @param networkType The network type we'd like to check
3233 * @return {@code true} if supported, else {@code false}
Chalard Jean7eaf3b12018-03-08 13:54:53 +09003234 * @deprecated Types are deprecated. Use {@link NetworkCapabilities} instead.
Robert Greenwalt0114f6e2011-08-31 11:46:42 -07003235 * @hide
3236 */
Chalard Jean7eaf3b12018-03-08 13:54:53 +09003237 @Deprecated
Jeff Sharkey656584a2017-04-24 11:18:03 -06003238 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jeana3b77512019-04-09 15:46:21 +09003239 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 130143562)
Robert Greenwalt0114f6e2011-08-31 11:46:42 -07003240 public boolean isNetworkSupported(int networkType) {
3241 try {
3242 return mService.isNetworkSupported(networkType);
Jeff Sharkeyc78f85c2016-03-01 19:27:23 -07003243 } catch (RemoteException e) {
3244 throw e.rethrowFromSystemServer();
3245 }
Robert Greenwalt0114f6e2011-08-31 11:46:42 -07003246 }
Jeff Sharkeyd00b1302012-04-12 18:34:54 -07003247
3248 /**
3249 * Returns if the currently active data network is metered. A network is
3250 * classified as metered when the user is sensitive to heavy data usage on
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08003251 * that connection due to monetary costs, data limitations or
3252 * battery/performance issues. You should check this before doing large
3253 * data transfers, and warn the user or delay the operation until another
3254 * network is available.
3255 *
3256 * @return {@code true} if large transfers should be avoided, otherwise
3257 * {@code false}.
Jeff Sharkeyd00b1302012-04-12 18:34:54 -07003258 */
Jeff Sharkey656584a2017-04-24 11:18:03 -06003259 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Jeff Sharkeyd00b1302012-04-12 18:34:54 -07003260 public boolean isActiveNetworkMetered() {
3261 try {
3262 return mService.isActiveNetworkMetered();
3263 } catch (RemoteException e) {
Jeff Sharkeyc78f85c2016-03-01 19:27:23 -07003264 throw e.rethrowFromSystemServer();
Jeff Sharkeyd00b1302012-04-12 18:34:54 -07003265 }
3266 }
Jeff Sharkeyebcc7972012-08-25 00:05:46 -07003267
Robert Greenwaltfaa4b402013-02-15 10:56:35 -08003268 /**
Sarah Chincabcbff2020-11-25 12:15:14 -08003269 * Set sign in error notification to visible or invisible
Wink Saville9a1a7ef2013-08-29 08:55:16 -07003270 *
Sarah Chincabcbff2020-11-25 12:15:14 -08003271 * @hide
Paul Jensendda8e592015-03-18 12:23:02 -04003272 * @deprecated Doesn't properly deal with multiple connected networks of the same type.
Wink Saville9a1a7ef2013-08-29 08:55:16 -07003273 */
Aurimas Liutikase80a0eb2016-05-24 15:22:55 -07003274 @Deprecated
Wink Saville9a1a7ef2013-08-29 08:55:16 -07003275 public void setProvisioningNotificationVisible(boolean visible, int networkType,
Paul Jensenebeaecd2014-09-15 15:59:36 -04003276 String action) {
Wink Saville9a1a7ef2013-08-29 08:55:16 -07003277 try {
Paul Jensenebeaecd2014-09-15 15:59:36 -04003278 mService.setProvisioningNotificationVisible(visible, networkType, action);
Wink Saville9a1a7ef2013-08-29 08:55:16 -07003279 } catch (RemoteException e) {
Jeff Sharkeyc78f85c2016-03-01 19:27:23 -07003280 throw e.rethrowFromSystemServer();
Wink Saville9a1a7ef2013-08-29 08:55:16 -07003281 }
3282 }
Yuhao Zhengb77f15d2013-09-09 17:00:04 -07003283
3284 /**
3285 * Set the value for enabling/disabling airplane mode
3286 *
3287 * @param enable whether to enable airplane mode or not
3288 *
Yuhao Zhengb77f15d2013-09-09 17:00:04 -07003289 * @hide
3290 */
Lorenzo Colittic7da00d2018-10-09 18:55:11 +09003291 @RequiresPermission(anyOf = {
Edward Savage-Jonesd4723692019-11-26 13:18:08 +01003292 android.Manifest.permission.NETWORK_AIRPLANE_MODE,
Lorenzo Colittic7da00d2018-10-09 18:55:11 +09003293 android.Manifest.permission.NETWORK_SETTINGS,
3294 android.Manifest.permission.NETWORK_SETUP_WIZARD,
3295 android.Manifest.permission.NETWORK_STACK})
Lorenzo Colitti0bfef022018-10-09 18:50:32 +09003296 @SystemApi
Yuhao Zhengb77f15d2013-09-09 17:00:04 -07003297 public void setAirplaneMode(boolean enable) {
3298 try {
3299 mService.setAirplaneMode(enable);
3300 } catch (RemoteException e) {
Jeff Sharkeyc78f85c2016-03-01 19:27:23 -07003301 throw e.rethrowFromSystemServer();
Yuhao Zhengb77f15d2013-09-09 17:00:04 -07003302 }
3303 }
Robert Greenwalt7e45d112014-04-11 15:53:27 -07003304
Lorenzo Colitti6702d4b2020-01-08 00:04:09 +09003305 /**
3306 * Registers the specified {@link NetworkProvider}.
3307 * Each listener must only be registered once. The listener can be unregistered with
3308 * {@link #unregisterNetworkProvider}.
3309 *
3310 * @param provider the provider to register
3311 * @return the ID of the provider. This ID must be used by the provider when registering
3312 * {@link android.net.NetworkAgent}s.
3313 * @hide
3314 */
3315 @SystemApi
paulhub6ba8e82020-03-04 09:43:41 +08003316 @RequiresPermission(anyOf = {
3317 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
3318 android.Manifest.permission.NETWORK_FACTORY})
Lorenzo Colitti6702d4b2020-01-08 00:04:09 +09003319 public int registerNetworkProvider(@NonNull NetworkProvider provider) {
3320 if (provider.getProviderId() != NetworkProvider.ID_NONE) {
Lorenzo Colitti6702d4b2020-01-08 00:04:09 +09003321 throw new IllegalStateException("NetworkProviders can only be registered once");
3322 }
3323
3324 try {
3325 int providerId = mService.registerNetworkProvider(provider.getMessenger(),
3326 provider.getName());
3327 provider.setProviderId(providerId);
3328 } catch (RemoteException e) {
3329 throw e.rethrowFromSystemServer();
3330 }
3331 return provider.getProviderId();
3332 }
3333
3334 /**
3335 * Unregisters the specified NetworkProvider.
3336 *
3337 * @param provider the provider to unregister
3338 * @hide
3339 */
3340 @SystemApi
paulhub6ba8e82020-03-04 09:43:41 +08003341 @RequiresPermission(anyOf = {
3342 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
3343 android.Manifest.permission.NETWORK_FACTORY})
Lorenzo Colitti6702d4b2020-01-08 00:04:09 +09003344 public void unregisterNetworkProvider(@NonNull NetworkProvider provider) {
3345 try {
3346 mService.unregisterNetworkProvider(provider.getMessenger());
3347 } catch (RemoteException e) {
3348 throw e.rethrowFromSystemServer();
3349 }
3350 provider.setProviderId(NetworkProvider.ID_NONE);
3351 }
3352
3353
3354 /** @hide exposed via the NetworkProvider class. */
paulhub6ba8e82020-03-04 09:43:41 +08003355 @RequiresPermission(anyOf = {
3356 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
3357 android.Manifest.permission.NETWORK_FACTORY})
Lorenzo Colitti6702d4b2020-01-08 00:04:09 +09003358 public void declareNetworkRequestUnfulfillable(@NonNull NetworkRequest request) {
3359 try {
3360 mService.declareNetworkRequestUnfulfillable(request);
3361 } catch (RemoteException e) {
3362 throw e.rethrowFromSystemServer();
3363 }
3364 }
3365
Paul Jensen1f567382015-02-13 14:18:39 -05003366 /**
3367 * @hide
3368 * Register a NetworkAgent with ConnectivityService.
Chalard Jeanf78c9642019-12-13 19:47:12 +09003369 * @return Network corresponding to NetworkAgent.
Paul Jensen1f567382015-02-13 14:18:39 -05003370 */
paulhub6ba8e82020-03-04 09:43:41 +08003371 @RequiresPermission(anyOf = {
3372 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
3373 android.Manifest.permission.NETWORK_FACTORY})
Remi NGUYEN VAN77b0c1c2020-12-23 12:45:08 +09003374 public Network registerNetworkAgent(INetworkAgent na, NetworkInfo ni, LinkProperties lp,
Chalard Jean28018572020-12-21 18:36:52 +09003375 NetworkCapabilities nc, @NonNull NetworkScore score, NetworkAgentConfig config,
3376 int providerId) {
Robert Greenwalte20f7a22014-04-18 15:25:25 -07003377 try {
Remi NGUYEN VAN77b0c1c2020-12-23 12:45:08 +09003378 return mService.registerNetworkAgent(na, ni, lp, nc, score, config, providerId);
Paul Jensen1f567382015-02-13 14:18:39 -05003379 } catch (RemoteException e) {
Jeff Sharkeyc78f85c2016-03-01 19:27:23 -07003380 throw e.rethrowFromSystemServer();
Paul Jensen1f567382015-02-13 14:18:39 -05003381 }
Robert Greenwalte20f7a22014-04-18 15:25:25 -07003382 }
3383
Robert Greenwaltf99b8392014-03-26 16:47:06 -07003384 /**
Hugo Benichi2aa65af2017-03-06 09:17:06 +09003385 * Base class for {@code NetworkRequest} callbacks. Used for notifications about network
3386 * changes. Should be extended by applications wanting notifications.
3387 *
3388 * A {@code NetworkCallback} is registered by calling
3389 * {@link #requestNetwork(NetworkRequest, NetworkCallback)},
3390 * {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)},
Hugo Benichicbfbb372018-02-07 21:17:43 +09003391 * or {@link #registerDefaultNetworkCallback(NetworkCallback)}. A {@code NetworkCallback} is
Hugo Benichi2aa65af2017-03-06 09:17:06 +09003392 * unregistered by calling {@link #unregisterNetworkCallback(NetworkCallback)}.
3393 * A {@code NetworkCallback} should be registered at most once at any time.
3394 * A {@code NetworkCallback} that has been unregistered can be registered again.
Robert Greenwaltf99b8392014-03-26 16:47:06 -07003395 */
Robert Greenwaltf57c03c2014-06-11 16:05:07 -07003396 public static class NetworkCallback {
Robert Greenwalte20f7a22014-04-18 15:25:25 -07003397 /**
Roshan Pius951c0032020-12-22 15:10:42 -08003398 * No flags associated with this callback.
3399 * @hide
3400 */
3401 public static final int FLAG_NONE = 0;
3402 /**
3403 * Use this flag to include any location sensitive data in {@link NetworkCapabilities} sent
3404 * via {@link #onCapabilitiesChanged(Network, NetworkCapabilities)}.
3405 * <p>
3406 * These include:
3407 * <li> Some transport info instances (retrieved via
3408 * {@link NetworkCapabilities#getTransportInfo()}) like {@link android.net.wifi.WifiInfo}
3409 * contain location sensitive information.
3410 * <li> OwnerUid (retrieved via {@link NetworkCapabilities#getOwnerUid()} is location
3411 * sensitive for wifi suggestor apps (i.e using {@link WifiNetworkSuggestion}).</li>
3412 * </p>
3413 * <p>
3414 * Note:
3415 * <li> Retrieving this location sensitive information (subject to app's location
3416 * permissions) will be noted by system. </li>
3417 * <li> Without this flag any {@link NetworkCapabilities} provided via the callback does
3418 * not include location sensitive info.
3419 * </p>
3420 */
3421 public static final int FLAG_INCLUDE_LOCATION_INFO = 1 << 0;
3422
3423 /** @hide */
3424 @Retention(RetentionPolicy.SOURCE)
3425 @IntDef(flag = true, prefix = "FLAG_", value = {
3426 FLAG_NONE,
3427 FLAG_INCLUDE_LOCATION_INFO
3428 })
3429 public @interface Flag { }
3430
3431 /**
3432 * All the valid flags for error checking.
3433 */
3434 private static final int VALID_FLAGS = FLAG_INCLUDE_LOCATION_INFO;
3435
3436 public NetworkCallback() {
3437 this(FLAG_NONE);
3438 }
3439
3440 public NetworkCallback(@Flag int flags) {
Remi NGUYEN VAN81f68422021-03-15 07:31:54 +00003441 if ((flags & VALID_FLAGS) != flags) {
3442 throw new IllegalArgumentException("Invalid flags");
3443 }
Roshan Pius951c0032020-12-22 15:10:42 -08003444 mFlags = flags;
3445 }
3446
3447 /**
Lorenzo Colitti14574592015-04-24 12:23:24 +09003448 * Called when the framework connects to a new network to evaluate whether it satisfies this
3449 * request. If evaluation succeeds, this callback may be followed by an {@link #onAvailable}
3450 * callback. There is no guarantee that this new network will satisfy any requests, or that
3451 * the network will stay connected for longer than the time necessary to evaluate it.
3452 * <p>
3453 * Most applications <b>should not</b> act on this callback, and should instead use
3454 * {@link #onAvailable}. This callback is intended for use by applications that can assist
3455 * the framework in properly evaluating the network &mdash; for example, an application that
3456 * can automatically log in to a captive portal without user intervention.
3457 *
3458 * @param network The {@link Network} of the network that is being evaluated.
Lorenzo Colitti3a9df1a2015-06-11 14:27:17 +09003459 *
3460 * @hide
Robert Greenwalte20f7a22014-04-18 15:25:25 -07003461 */
paulhu1a407652019-03-22 16:35:06 +08003462 public void onPreCheck(@NonNull Network network) {}
Robert Greenwalte20f7a22014-04-18 15:25:25 -07003463
3464 /**
Lorenzo Colitti14574592015-04-24 12:23:24 +09003465 * Called when the framework connects and has declared a new network ready for use.
Robert Greenwaltf57c03c2014-06-11 16:05:07 -07003466 * This callback may be called more than once if the {@link Network} that is
3467 * satisfying the request changes.
Robert Greenwaltf3017f72014-05-18 23:07:25 -07003468 *
Robert Greenwaltf3017f72014-05-18 23:07:25 -07003469 * @param network The {@link Network} of the satisfying network.
Chalard Jeana23bc9e2018-01-30 22:41:41 +09003470 * @param networkCapabilities The {@link NetworkCapabilities} of the satisfying network.
3471 * @param linkProperties The {@link LinkProperties} of the satisfying network.
junyulaif2c67e42018-08-07 19:50:45 +08003472 * @param blocked Whether access to the {@link Network} is blocked due to system policy.
Chalard Jeana23bc9e2018-01-30 22:41:41 +09003473 * @hide
3474 */
Lorenzo Colitti79c6f222021-03-18 00:54:57 +09003475 public final void onAvailable(@NonNull Network network,
paulhu1a407652019-03-22 16:35:06 +08003476 @NonNull NetworkCapabilities networkCapabilities,
Lorenzo Colitti79c6f222021-03-18 00:54:57 +09003477 @NonNull LinkProperties linkProperties, @BlockedReason int blocked) {
Chalard Jeana23bc9e2018-01-30 22:41:41 +09003478 // Internally only this method is called when a new network is available, and
3479 // it calls the callback in the same way and order that older versions used
3480 // to call so as not to change the behavior.
Lorenzo Colitti79c6f222021-03-18 00:54:57 +09003481 onAvailable(network, networkCapabilities, linkProperties, blocked != 0);
3482 onBlockedStatusChanged(network, blocked);
3483 }
3484
3485 /**
3486 * Legacy variant of onAvailable that takes a boolean blocked reason.
3487 *
3488 * This method has never been public API, but it's not final, so there may be apps that
3489 * implemented it and rely on it being called. Do our best not to break them.
3490 * Note: such apps will also get a second call to onBlockedStatusChanged immediately after
3491 * this method is called. There does not seem to be a way to avoid this.
3492 * TODO: add a compat check to move apps off this method, and eventually stop calling it.
3493 *
3494 * @hide
3495 */
3496 public void onAvailable(@NonNull Network network,
3497 @NonNull NetworkCapabilities networkCapabilities,
3498 @NonNull LinkProperties linkProperties, boolean blocked) {
Chalard Jeana23bc9e2018-01-30 22:41:41 +09003499 onAvailable(network);
3500 if (!networkCapabilities.hasCapability(
3501 NetworkCapabilities.NET_CAPABILITY_NOT_SUSPENDED)) {
3502 onNetworkSuspended(network);
3503 }
3504 onCapabilitiesChanged(network, networkCapabilities);
3505 onLinkPropertiesChanged(network, linkProperties);
Lorenzo Colitti79c6f222021-03-18 00:54:57 +09003506 // No call to onBlockedStatusChanged here. That is done by the caller.
Chalard Jeana23bc9e2018-01-30 22:41:41 +09003507 }
3508
3509 /**
3510 * Called when the framework connects and has declared a new network ready for use.
Chalard Jean01378b62019-08-30 16:27:28 +09003511 *
3512 * <p>For callbacks registered with {@link #registerNetworkCallback}, multiple networks may
3513 * be available at the same time, and onAvailable will be called for each of these as they
3514 * appear.
3515 *
3516 * <p>For callbacks registered with {@link #requestNetwork} and
3517 * {@link #registerDefaultNetworkCallback}, this means the network passed as an argument
3518 * is the new best network for this request and is now tracked by this callback ; this
3519 * callback will no longer receive method calls about other networks that may have been
3520 * passed to this method previously. The previously-best network may have disconnected, or
3521 * it may still be around and the newly-best network may simply be better.
3522 *
3523 * <p>Starting with {@link android.os.Build.VERSION_CODES#O}, this will always immediately
3524 * be followed by a call to {@link #onCapabilitiesChanged(Network, NetworkCapabilities)}
3525 * then by a call to {@link #onLinkPropertiesChanged(Network, LinkProperties)}, and a call
3526 * to {@link #onBlockedStatusChanged(Network, boolean)}.
3527 *
3528 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
3529 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
3530 * this callback as this is prone to race conditions (there is no guarantee the objects
3531 * returned by these methods will be current). Instead, wait for a call to
3532 * {@link #onCapabilitiesChanged(Network, NetworkCapabilities)} and
3533 * {@link #onLinkPropertiesChanged(Network, LinkProperties)} whose arguments are guaranteed
3534 * to be well-ordered with respect to other callbacks.
Chalard Jeana23bc9e2018-01-30 22:41:41 +09003535 *
3536 * @param network The {@link Network} of the satisfying network.
Robert Greenwalte20f7a22014-04-18 15:25:25 -07003537 */
paulhu1a407652019-03-22 16:35:06 +08003538 public void onAvailable(@NonNull Network network) {}
Robert Greenwalte20f7a22014-04-18 15:25:25 -07003539
3540 /**
Chalard Jean01378b62019-08-30 16:27:28 +09003541 * Called when the network is about to be lost, typically because there are no outstanding
3542 * requests left for it. This may be paired with a {@link NetworkCallback#onAvailable} call
3543 * with the new replacement network for graceful handover. This method is not guaranteed
3544 * to be called before {@link NetworkCallback#onLost} is called, for example in case a
3545 * network is suddenly disconnected.
Robert Greenwaltf3017f72014-05-18 23:07:25 -07003546 *
Chalard Jean01378b62019-08-30 16:27:28 +09003547 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
3548 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
3549 * this callback as this is prone to race conditions ; calling these methods while in a
3550 * callback may return an outdated or even a null object.
3551 *
3552 * @param network The {@link Network} that is about to be lost.
3553 * @param maxMsToLive The time in milliseconds the system intends to keep the network
3554 * connected for graceful handover; note that the network may still
3555 * suffer a hard loss at any time.
Robert Greenwalte20f7a22014-04-18 15:25:25 -07003556 */
paulhu1a407652019-03-22 16:35:06 +08003557 public void onLosing(@NonNull Network network, int maxMsToLive) {}
Robert Greenwalte20f7a22014-04-18 15:25:25 -07003558
3559 /**
Chalard Jean01378b62019-08-30 16:27:28 +09003560 * Called when a network disconnects or otherwise no longer satisfies this request or
3561 * callback.
3562 *
3563 * <p>If the callback was registered with requestNetwork() or
3564 * registerDefaultNetworkCallback(), it will only be invoked against the last network
3565 * returned by onAvailable() when that network is lost and no other network satisfies
3566 * the criteria of the request.
3567 *
3568 * <p>If the callback was registered with registerNetworkCallback() it will be called for
3569 * each network which no longer satisfies the criteria of the callback.
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 ; calling these methods while in a
3574 * callback may return an outdated or even a null object.
Robert Greenwaltf3017f72014-05-18 23:07:25 -07003575 *
Robert Greenwaltf3017f72014-05-18 23:07:25 -07003576 * @param network The {@link Network} lost.
Robert Greenwalte20f7a22014-04-18 15:25:25 -07003577 */
paulhu1a407652019-03-22 16:35:06 +08003578 public void onLost(@NonNull Network network) {}
Robert Greenwalte20f7a22014-04-18 15:25:25 -07003579
3580 /**
Chalard Jean01378b62019-08-30 16:27:28 +09003581 * Called if no network is found within the timeout time specified in
Etan Cohenfbfdd842019-01-08 12:09:18 -08003582 * {@link #requestNetwork(NetworkRequest, NetworkCallback, int)} call or if the
3583 * requested network request cannot be fulfilled (whether or not a timeout was
3584 * specified). When this callback is invoked the associated
Etan Cohenf67bde92017-03-01 12:47:28 -08003585 * {@link NetworkRequest} will have already been removed and released, as if
3586 * {@link #unregisterNetworkCallback(NetworkCallback)} had been called.
Robert Greenwalte20f7a22014-04-18 15:25:25 -07003587 */
Robert Greenwaltf57c03c2014-06-11 16:05:07 -07003588 public void onUnavailable() {}
Robert Greenwalte20f7a22014-04-18 15:25:25 -07003589
3590 /**
Chalard Jean01378b62019-08-30 16:27:28 +09003591 * Called when the network corresponding to this request changes capabilities but still
3592 * satisfies the requested criteria.
3593 *
3594 * <p>Starting with {@link android.os.Build.VERSION_CODES#O} this method is guaranteed
3595 * to be called immediately after {@link #onAvailable}.
3596 *
3597 * <p>Do NOT call {@link #getLinkProperties(Network)} or other synchronous
3598 * ConnectivityManager methods in this callback as this is prone to race conditions :
3599 * calling these methods while in a callback may return an outdated or even a null object.
Robert Greenwaltf3017f72014-05-18 23:07:25 -07003600 *
Robert Greenwaltf3017f72014-05-18 23:07:25 -07003601 * @param network The {@link Network} whose capabilities have changed.
Roshan Pius951c0032020-12-22 15:10:42 -08003602 * @param networkCapabilities The new {@link NetworkCapabilities} for this
Chalard Jeana23bc9e2018-01-30 22:41:41 +09003603 * network.
Robert Greenwalte20f7a22014-04-18 15:25:25 -07003604 */
paulhu1a407652019-03-22 16:35:06 +08003605 public void onCapabilitiesChanged(@NonNull Network network,
3606 @NonNull NetworkCapabilities networkCapabilities) {}
Robert Greenwalte20f7a22014-04-18 15:25:25 -07003607
3608 /**
Chalard Jean01378b62019-08-30 16:27:28 +09003609 * Called when the network corresponding to this request changes {@link LinkProperties}.
3610 *
3611 * <p>Starting with {@link android.os.Build.VERSION_CODES#O} this method is guaranteed
3612 * to be called immediately after {@link #onAvailable}.
3613 *
3614 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or other synchronous
3615 * ConnectivityManager methods in this callback as this is prone to race conditions :
3616 * calling these methods while in a callback may return an outdated or even a null object.
Robert Greenwaltf3017f72014-05-18 23:07:25 -07003617 *
Robert Greenwaltf3017f72014-05-18 23:07:25 -07003618 * @param network The {@link Network} whose link properties have changed.
3619 * @param linkProperties The new {@link LinkProperties} for this network.
Robert Greenwalte20f7a22014-04-18 15:25:25 -07003620 */
paulhu1a407652019-03-22 16:35:06 +08003621 public void onLinkPropertiesChanged(@NonNull Network network,
3622 @NonNull LinkProperties linkProperties) {}
Robert Greenwalte20f7a22014-04-18 15:25:25 -07003623
Robert Greenwalt7fb8adc2015-06-24 13:23:42 -07003624 /**
Chalard Jean01378b62019-08-30 16:27:28 +09003625 * Called when the network the framework connected to for this request suspends data
3626 * transmission temporarily.
3627 *
3628 * <p>This generally means that while the TCP connections are still live temporarily
3629 * network data fails to transfer. To give a specific example, this is used on cellular
3630 * networks to mask temporary outages when driving through a tunnel, etc. In general this
3631 * means read operations on sockets on this network will block once the buffers are
3632 * drained, and write operations will block once the buffers are full.
3633 *
3634 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
3635 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
3636 * this callback as this is prone to race conditions (there is no guarantee the objects
3637 * returned by these methods will be current).
3638 *
Robert Greenwalt7fb8adc2015-06-24 13:23:42 -07003639 * @hide
3640 */
paulhu1a407652019-03-22 16:35:06 +08003641 public void onNetworkSuspended(@NonNull Network network) {}
Robert Greenwalt7fb8adc2015-06-24 13:23:42 -07003642
3643 /**
3644 * Called when the network the framework connected to for this request
Chalard Jeana23bc9e2018-01-30 22:41:41 +09003645 * returns from a {@link NetworkInfo.State#SUSPENDED} state. This should always be
3646 * preceded by a matching {@link NetworkCallback#onNetworkSuspended} call.
Chalard Jean01378b62019-08-30 16:27:28 +09003647
3648 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
3649 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
3650 * this callback as this is prone to race conditions : calling these methods while in a
3651 * callback may return an outdated or even a null object.
3652 *
Robert Greenwalt7fb8adc2015-06-24 13:23:42 -07003653 * @hide
3654 */
paulhu1a407652019-03-22 16:35:06 +08003655 public void onNetworkResumed(@NonNull Network network) {}
Robert Greenwalt7fb8adc2015-06-24 13:23:42 -07003656
junyulaif2c67e42018-08-07 19:50:45 +08003657 /**
3658 * Called when access to the specified network is blocked or unblocked.
3659 *
Chalard Jean01378b62019-08-30 16:27:28 +09003660 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
3661 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
3662 * this callback as this is prone to race conditions : calling these methods while in a
3663 * callback may return an outdated or even a null object.
3664 *
junyulaif2c67e42018-08-07 19:50:45 +08003665 * @param network The {@link Network} whose blocked status has changed.
3666 * @param blocked The blocked status of this {@link Network}.
3667 */
junyulai7e06ad42019-03-04 22:45:36 +08003668 public void onBlockedStatusChanged(@NonNull Network network, boolean blocked) {}
junyulaif2c67e42018-08-07 19:50:45 +08003669
Lorenzo Colitti79c6f222021-03-18 00:54:57 +09003670 /**
Lorenzo Colitti42fe2232021-03-25 23:17:36 +09003671 * Called when access to the specified network is blocked or unblocked, or the reason for
3672 * access being blocked changes.
Lorenzo Colitti79c6f222021-03-18 00:54:57 +09003673 *
3674 * If a NetworkCallback object implements this method,
3675 * {@link #onBlockedStatusChanged(Network, boolean)} will not be called.
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 : calling these methods while in a
3680 * callback may return an outdated or even a null object.
3681 *
3682 * @param network The {@link Network} whose blocked status has changed.
3683 * @param blocked The blocked status of this {@link Network}.
3684 * @hide
3685 */
3686 @SystemApi(client = MODULE_LIBRARIES)
3687 public void onBlockedStatusChanged(@NonNull Network network, @BlockedReason int blocked) {
3688 onBlockedStatusChanged(network, blocked != 0);
3689 }
3690
Robert Greenwaltf57c03c2014-06-11 16:05:07 -07003691 private NetworkRequest networkRequest;
Roshan Pius951c0032020-12-22 15:10:42 -08003692 private final int mFlags;
Robert Greenwalte20f7a22014-04-18 15:25:25 -07003693 }
3694
Hugo Benichia590ab82017-05-11 13:16:17 +09003695 /**
3696 * Constant error codes used by ConnectivityService to communicate about failures and errors
3697 * across a Binder boundary.
3698 * @hide
3699 */
3700 public interface Errors {
Chalard Jean9dd11612018-06-04 16:52:49 +09003701 int TOO_MANY_REQUESTS = 1;
Hugo Benichia590ab82017-05-11 13:16:17 +09003702 }
3703
3704 /** @hide */
3705 public static class TooManyRequestsException extends RuntimeException {}
3706
3707 private static RuntimeException convertServiceException(ServiceSpecificException e) {
3708 switch (e.errorCode) {
3709 case Errors.TOO_MANY_REQUESTS:
3710 return new TooManyRequestsException();
3711 default:
3712 Log.w(TAG, "Unknown service error code " + e.errorCode);
3713 return new RuntimeException(e);
3714 }
3715 }
3716
Robert Greenwaltf99b8392014-03-26 16:47:06 -07003717 /** @hide */
Remi NGUYEN VAN1fb66ad2021-03-12 15:24:06 +09003718 public static final int CALLBACK_PRECHECK = 1;
Robert Greenwalt7fb8adc2015-06-24 13:23:42 -07003719 /** @hide */
Remi NGUYEN VAN1fb66ad2021-03-12 15:24:06 +09003720 public static final int CALLBACK_AVAILABLE = 2;
Robert Greenwalt7fb8adc2015-06-24 13:23:42 -07003721 /** @hide arg1 = TTL */
Remi NGUYEN VAN1fb66ad2021-03-12 15:24:06 +09003722 public static final int CALLBACK_LOSING = 3;
Robert Greenwalt7fb8adc2015-06-24 13:23:42 -07003723 /** @hide */
Remi NGUYEN VAN1fb66ad2021-03-12 15:24:06 +09003724 public static final int CALLBACK_LOST = 4;
Robert Greenwalt7fb8adc2015-06-24 13:23:42 -07003725 /** @hide */
Remi NGUYEN VAN1fb66ad2021-03-12 15:24:06 +09003726 public static final int CALLBACK_UNAVAIL = 5;
Robert Greenwalt7fb8adc2015-06-24 13:23:42 -07003727 /** @hide */
Remi NGUYEN VAN1fb66ad2021-03-12 15:24:06 +09003728 public static final int CALLBACK_CAP_CHANGED = 6;
Robert Greenwalt7fb8adc2015-06-24 13:23:42 -07003729 /** @hide */
Remi NGUYEN VAN1fb66ad2021-03-12 15:24:06 +09003730 public static final int CALLBACK_IP_CHANGED = 7;
Robert Greenwalt3dc73e52014-05-15 18:07:26 -07003731 /** @hide obj = NetworkCapabilities, arg1 = seq number */
Remi NGUYEN VAN1fb66ad2021-03-12 15:24:06 +09003732 private static final int EXPIRE_LEGACY_REQUEST = 8;
Robert Greenwalt7fb8adc2015-06-24 13:23:42 -07003733 /** @hide */
Remi NGUYEN VAN1fb66ad2021-03-12 15:24:06 +09003734 public static final int CALLBACK_SUSPENDED = 9;
Robert Greenwalt7fb8adc2015-06-24 13:23:42 -07003735 /** @hide */
Remi NGUYEN VAN1fb66ad2021-03-12 15:24:06 +09003736 public static final int CALLBACK_RESUMED = 10;
junyulaif2c67e42018-08-07 19:50:45 +08003737 /** @hide */
Remi NGUYEN VAN1fb66ad2021-03-12 15:24:06 +09003738 public static final int CALLBACK_BLK_CHANGED = 11;
Robert Greenwaltf99b8392014-03-26 16:47:06 -07003739
Erik Kline155a59a2015-11-25 12:49:38 +09003740 /** @hide */
3741 public static String getCallbackName(int whichCallback) {
3742 switch (whichCallback) {
3743 case CALLBACK_PRECHECK: return "CALLBACK_PRECHECK";
3744 case CALLBACK_AVAILABLE: return "CALLBACK_AVAILABLE";
3745 case CALLBACK_LOSING: return "CALLBACK_LOSING";
3746 case CALLBACK_LOST: return "CALLBACK_LOST";
3747 case CALLBACK_UNAVAIL: return "CALLBACK_UNAVAIL";
3748 case CALLBACK_CAP_CHANGED: return "CALLBACK_CAP_CHANGED";
3749 case CALLBACK_IP_CHANGED: return "CALLBACK_IP_CHANGED";
Erik Kline155a59a2015-11-25 12:49:38 +09003750 case EXPIRE_LEGACY_REQUEST: return "EXPIRE_LEGACY_REQUEST";
3751 case CALLBACK_SUSPENDED: return "CALLBACK_SUSPENDED";
3752 case CALLBACK_RESUMED: return "CALLBACK_RESUMED";
junyulaif2c67e42018-08-07 19:50:45 +08003753 case CALLBACK_BLK_CHANGED: return "CALLBACK_BLK_CHANGED";
Erik Kline155a59a2015-11-25 12:49:38 +09003754 default:
3755 return Integer.toString(whichCallback);
3756 }
3757 }
3758
Robert Greenwalt3dc73e52014-05-15 18:07:26 -07003759 private class CallbackHandler extends Handler {
Robert Greenwaltf99b8392014-03-26 16:47:06 -07003760 private static final String TAG = "ConnectivityManager.CallbackHandler";
Robert Greenwalt72877c22015-09-03 16:41:45 -07003761 private static final boolean DBG = false;
Robert Greenwaltf99b8392014-03-26 16:47:06 -07003762
Hugo Benichi0b42baf2016-07-06 22:53:17 +09003763 CallbackHandler(Looper looper) {
Robert Greenwaltf99b8392014-03-26 16:47:06 -07003764 super(looper);
Robert Greenwaltf99b8392014-03-26 16:47:06 -07003765 }
3766
Hugo Benichifd44e912017-02-02 17:02:36 +09003767 CallbackHandler(Handler handler) {
Remi NGUYEN VAN81f68422021-03-15 07:31:54 +00003768 this(Objects.requireNonNull(handler, "Handler cannot be null.").getLooper());
Hugo Benichifd44e912017-02-02 17:02:36 +09003769 }
3770
Robert Greenwaltf99b8392014-03-26 16:47:06 -07003771 @Override
3772 public void handleMessage(Message message) {
Hugo Benichib6c24062017-05-09 14:36:02 +09003773 if (message.what == EXPIRE_LEGACY_REQUEST) {
3774 expireRequest((NetworkCapabilities) message.obj, message.arg1);
3775 return;
3776 }
3777
3778 final NetworkRequest request = getObject(message, NetworkRequest.class);
3779 final Network network = getObject(message, Network.class);
3780 final NetworkCallback callback;
3781 synchronized (sCallbacks) {
3782 callback = sCallbacks.get(request);
Etan Cohenb58e3662019-05-21 12:06:04 -07003783 if (callback == null) {
3784 Log.w(TAG,
3785 "callback not found for " + getCallbackName(message.what) + " message");
3786 return;
3787 }
Etan Cohen6cb65992019-04-16 15:07:55 -07003788 if (message.what == CALLBACK_UNAVAIL) {
3789 sCallbacks.remove(request);
3790 callback.networkRequest = ALREADY_UNREGISTERED;
3791 }
Hugo Benichib6c24062017-05-09 14:36:02 +09003792 }
Lorenzo Colittib027e6e2016-03-01 22:56:37 +09003793 if (DBG) {
Hugo Benichi8d962922017-03-22 17:07:57 +09003794 Log.d(TAG, getCallbackName(message.what) + " for network " + network);
Lorenzo Colittib027e6e2016-03-01 22:56:37 +09003795 }
Hugo Benichib6c24062017-05-09 14:36:02 +09003796
Robert Greenwaltf99b8392014-03-26 16:47:06 -07003797 switch (message.what) {
3798 case CALLBACK_PRECHECK: {
Hugo Benichib6c24062017-05-09 14:36:02 +09003799 callback.onPreCheck(network);
Robert Greenwaltf99b8392014-03-26 16:47:06 -07003800 break;
3801 }
3802 case CALLBACK_AVAILABLE: {
Chalard Jeana23bc9e2018-01-30 22:41:41 +09003803 NetworkCapabilities cap = getObject(message, NetworkCapabilities.class);
3804 LinkProperties lp = getObject(message, LinkProperties.class);
Lorenzo Colitti79c6f222021-03-18 00:54:57 +09003805 callback.onAvailable(network, cap, lp, message.arg1);
Robert Greenwaltf99b8392014-03-26 16:47:06 -07003806 break;
3807 }
3808 case CALLBACK_LOSING: {
Hugo Benichib6c24062017-05-09 14:36:02 +09003809 callback.onLosing(network, message.arg1);
Robert Greenwaltf99b8392014-03-26 16:47:06 -07003810 break;
3811 }
3812 case CALLBACK_LOST: {
Hugo Benichib6c24062017-05-09 14:36:02 +09003813 callback.onLost(network);
Robert Greenwaltf99b8392014-03-26 16:47:06 -07003814 break;
3815 }
3816 case CALLBACK_UNAVAIL: {
Hugo Benichib6c24062017-05-09 14:36:02 +09003817 callback.onUnavailable();
Robert Greenwaltf99b8392014-03-26 16:47:06 -07003818 break;
3819 }
3820 case CALLBACK_CAP_CHANGED: {
Hugo Benichib6c24062017-05-09 14:36:02 +09003821 NetworkCapabilities cap = getObject(message, NetworkCapabilities.class);
3822 callback.onCapabilitiesChanged(network, cap);
Robert Greenwaltf99b8392014-03-26 16:47:06 -07003823 break;
3824 }
3825 case CALLBACK_IP_CHANGED: {
Hugo Benichib6c24062017-05-09 14:36:02 +09003826 LinkProperties lp = getObject(message, LinkProperties.class);
3827 callback.onLinkPropertiesChanged(network, lp);
Robert Greenwaltf99b8392014-03-26 16:47:06 -07003828 break;
3829 }
Robert Greenwalt7fb8adc2015-06-24 13:23:42 -07003830 case CALLBACK_SUSPENDED: {
Hugo Benichib6c24062017-05-09 14:36:02 +09003831 callback.onNetworkSuspended(network);
Robert Greenwalt7fb8adc2015-06-24 13:23:42 -07003832 break;
3833 }
3834 case CALLBACK_RESUMED: {
Hugo Benichib6c24062017-05-09 14:36:02 +09003835 callback.onNetworkResumed(network);
Robert Greenwalt3dc73e52014-05-15 18:07:26 -07003836 break;
3837 }
junyulaif2c67e42018-08-07 19:50:45 +08003838 case CALLBACK_BLK_CHANGED: {
Lorenzo Colitti79c6f222021-03-18 00:54:57 +09003839 callback.onBlockedStatusChanged(network, message.arg1);
junyulaif2c67e42018-08-07 19:50:45 +08003840 }
Robert Greenwaltf99b8392014-03-26 16:47:06 -07003841 }
3842 }
3843
Hugo Benichi0b42baf2016-07-06 22:53:17 +09003844 private <T> T getObject(Message msg, Class<T> c) {
3845 return (T) msg.getData().getParcelable(c.getSimpleName());
Robert Greenwaltf99b8392014-03-26 16:47:06 -07003846 }
Robert Greenwaltf99b8392014-03-26 16:47:06 -07003847 }
3848
Hugo Benichifd44e912017-02-02 17:02:36 +09003849 private CallbackHandler getDefaultHandler() {
Hugo Benichi3b41f052016-07-07 10:15:56 +09003850 synchronized (sCallbacks) {
3851 if (sCallbackHandler == null) {
3852 sCallbackHandler = new CallbackHandler(ConnectivityThread.getInstanceLooper());
Robert Greenwaltf99b8392014-03-26 16:47:06 -07003853 }
Hugo Benichi3b41f052016-07-07 10:15:56 +09003854 return sCallbackHandler;
Robert Greenwaltf99b8392014-03-26 16:47:06 -07003855 }
3856 }
3857
Hugo Benichibc4ac972017-02-03 14:18:44 +09003858 private static final HashMap<NetworkRequest, NetworkCallback> sCallbacks = new HashMap<>();
3859 private static CallbackHandler sCallbackHandler;
Robert Greenwaltf99b8392014-03-26 16:47:06 -07003860
Lorenzo Colitti2a49c5d2021-03-12 22:48:07 +09003861 private NetworkRequest sendRequestForNetwork(int asUid, NetworkCapabilities need,
3862 NetworkCallback callback, int timeoutMs, NetworkRequest.Type reqType, int legacyType,
3863 CallbackHandler handler) {
Soi, Yoshinarib8102ef2015-11-12 12:09:02 +09003864 printStackTrace();
Hugo Benichibc1104b2017-05-09 15:19:01 +09003865 checkCallbackNotNull(callback);
Remi NGUYEN VAN81f68422021-03-15 07:31:54 +00003866 if (reqType != TRACK_DEFAULT && reqType != TRACK_SYSTEM_DEFAULT && need == null) {
3867 throw new IllegalArgumentException("null NetworkCapabilities");
3868 }
Hugo Benichi0b42baf2016-07-06 22:53:17 +09003869 final NetworkRequest request;
Roshan Piusbc7e37d2020-01-16 12:17:17 -08003870 final String callingPackageName = mContext.getOpPackageName();
Robert Greenwaltf99b8392014-03-26 16:47:06 -07003871 try {
Hugo Benichi0b42baf2016-07-06 22:53:17 +09003872 synchronized(sCallbacks) {
Hugo Benichibee30fe2017-06-17 13:14:12 +09003873 if (callback.networkRequest != null
3874 && callback.networkRequest != ALREADY_UNREGISTERED) {
Hugo Benichi2aa65af2017-03-06 09:17:06 +09003875 // TODO: throw exception instead and enforce 1:1 mapping of callbacks
3876 // and requests (http://b/20701525).
3877 Log.e(TAG, "NetworkCallback was already registered");
3878 }
Hugo Benichi3b41f052016-07-07 10:15:56 +09003879 Messenger messenger = new Messenger(handler);
Hugo Benichi0b42baf2016-07-06 22:53:17 +09003880 Binder binder = new Binder();
Roshan Pius951c0032020-12-22 15:10:42 -08003881 final int callbackFlags = callback.mFlags;
junyulaiad010792021-01-11 16:53:38 +08003882 if (reqType == LISTEN) {
Roshan Piusbc7e37d2020-01-16 12:17:17 -08003883 request = mService.listenForNetwork(
Roshan Pius951c0032020-12-22 15:10:42 -08003884 need, messenger, binder, callbackFlags, callingPackageName,
Roshan Piusaa24fde2020-12-17 14:53:09 -08003885 getAttributionTag());
Paul Jensenbb427682014-06-27 11:05:32 -04003886 } else {
Hugo Benichi0b42baf2016-07-06 22:53:17 +09003887 request = mService.requestNetwork(
Lorenzo Colitti2a49c5d2021-03-12 22:48:07 +09003888 asUid, need, reqType.ordinal(), messenger, timeoutMs, binder,
3889 legacyType, callbackFlags, callingPackageName, getAttributionTag());
Paul Jensenbb427682014-06-27 11:05:32 -04003890 }
Hugo Benichi0b42baf2016-07-06 22:53:17 +09003891 if (request != null) {
Hugo Benichi3b41f052016-07-07 10:15:56 +09003892 sCallbacks.put(request, callback);
Robert Greenwaltf99b8392014-03-26 16:47:06 -07003893 }
Hugo Benichi3b41f052016-07-07 10:15:56 +09003894 callback.networkRequest = request;
Robert Greenwaltf99b8392014-03-26 16:47:06 -07003895 }
Jeff Sharkeyc78f85c2016-03-01 19:27:23 -07003896 } catch (RemoteException e) {
3897 throw e.rethrowFromSystemServer();
Hugo Benichia590ab82017-05-11 13:16:17 +09003898 } catch (ServiceSpecificException e) {
3899 throw convertServiceException(e);
Jeff Sharkeyc78f85c2016-03-01 19:27:23 -07003900 }
Hugo Benichi0b42baf2016-07-06 22:53:17 +09003901 return request;
Robert Greenwaltf99b8392014-03-26 16:47:06 -07003902 }
3903
Lorenzo Colitti2a49c5d2021-03-12 22:48:07 +09003904 private NetworkRequest sendRequestForNetwork(NetworkCapabilities need, NetworkCallback callback,
3905 int timeoutMs, NetworkRequest.Type reqType, int legacyType, CallbackHandler handler) {
3906 return sendRequestForNetwork(Process.INVALID_UID, need, callback, timeoutMs, reqType,
3907 legacyType, handler);
3908 }
3909
Robert Greenwaltf99b8392014-03-26 16:47:06 -07003910 /**
Erik Kline23bf99c2016-03-16 15:31:39 +09003911 * Helper function to request a network with a particular legacy type.
Lorenzo Colitti6653c4d2015-11-25 12:00:52 +09003912 *
markchienfac84a22020-03-18 21:16:15 +08003913 * This API is only for use in internal system code that requests networks with legacy type and
3914 * relies on CONNECTIVITY_ACTION broadcasts instead of NetworkCallbacks. New caller should use
markchiend6eeffd2020-01-14 00:55:21 +08003915 * {@link #requestNetwork(NetworkRequest, NetworkCallback, Handler)} instead.
Lorenzo Colitti6653c4d2015-11-25 12:00:52 +09003916 *
markchiend6eeffd2020-01-14 00:55:21 +08003917 * @param request {@link NetworkRequest} describing this request.
markchiend6eeffd2020-01-14 00:55:21 +08003918 * @param timeoutMs The time in milliseconds to attempt looking for a suitable network
3919 * before {@link NetworkCallback#onUnavailable()} is called. The timeout must
3920 * be a positive value (i.e. >0).
3921 * @param legacyType to specify the network type(#TYPE_*).
3922 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
markchienfac84a22020-03-18 21:16:15 +08003923 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
3924 * the callback must not be shared - it uniquely specifies this request.
Lorenzo Colitti6653c4d2015-11-25 12:00:52 +09003925 *
3926 * @hide
3927 */
markchiend6eeffd2020-01-14 00:55:21 +08003928 @SystemApi
markchienfac84a22020-03-18 21:16:15 +08003929 @RequiresPermission(NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK)
Chalard Jean158702d2019-01-07 19:26:34 +09003930 public void requestNetwork(@NonNull NetworkRequest request,
markchienfac84a22020-03-18 21:16:15 +08003931 int timeoutMs, int legacyType, @NonNull Handler handler,
3932 @NonNull NetworkCallback networkCallback) {
3933 if (legacyType == TYPE_NONE) {
3934 throw new IllegalArgumentException("TYPE_NONE is meaningless legacy type");
3935 }
Hugo Benichifd44e912017-02-02 17:02:36 +09003936 CallbackHandler cbHandler = new CallbackHandler(handler);
3937 NetworkCapabilities nc = request.networkCapabilities;
3938 sendRequestForNetwork(nc, networkCallback, timeoutMs, REQUEST, legacyType, cbHandler);
Lorenzo Colitti6653c4d2015-11-25 12:00:52 +09003939 }
3940
3941 /**
Roshan Pius951c0032020-12-22 15:10:42 -08003942 * Request a network to satisfy a set of {@link NetworkCapabilities}.
Robert Greenwaltf99b8392014-03-26 16:47:06 -07003943 *
Chalard Jean01378b62019-08-30 16:27:28 +09003944 * <p>This method will attempt to find the best network that matches the passed
3945 * {@link NetworkRequest}, and to bring up one that does if none currently satisfies the
3946 * criteria. The platform will evaluate which network is the best at its own discretion.
3947 * Throughput, latency, cost per byte, policy, user preference and other considerations
3948 * may be factored in the decision of what is considered the best network.
3949 *
3950 * <p>As long as this request is outstanding, the platform will try to maintain the best network
3951 * matching this request, while always attempting to match the request to a better network if
3952 * possible. If a better match is found, the platform will switch this request to the now-best
3953 * network and inform the app of the newly best network by invoking
3954 * {@link NetworkCallback#onAvailable(Network)} on the provided callback. Note that the platform
3955 * will not try to maintain any other network than the best one currently matching the request:
3956 * a network not matching any network request may be disconnected at any time.
3957 *
3958 * <p>For example, an application could use this method to obtain a connected cellular network
3959 * even if the device currently has a data connection over Ethernet. This may cause the cellular
3960 * radio to consume additional power. Or, an application could inform the system that it wants
3961 * a network supporting sending MMSes and have the system let it know about the currently best
3962 * MMS-supporting network through the provided {@link NetworkCallback}.
3963 *
3964 * <p>The status of the request can be followed by listening to the various callbacks described
3965 * in {@link NetworkCallback}. The {@link Network} object passed to the callback methods can be
3966 * used to direct traffic to the network (although accessing some networks may be subject to
3967 * holding specific permissions). Callers will learn about the specific characteristics of the
3968 * network through
3969 * {@link NetworkCallback#onCapabilitiesChanged(Network, NetworkCapabilities)} and
3970 * {@link NetworkCallback#onLinkPropertiesChanged(Network, LinkProperties)}. The methods of the
3971 * provided {@link NetworkCallback} will only be invoked due to changes in the best network
3972 * matching the request at any given time; therefore when a better network matching the request
3973 * becomes available, the {@link NetworkCallback#onAvailable(Network)} method is called
3974 * with the new network after which no further updates are given about the previously-best
3975 * network, unless it becomes the best again at some later time. All callbacks are invoked
3976 * in order on the same thread, which by default is a thread created by the framework running
3977 * in the app.
3978 * {@see #requestNetwork(NetworkRequest, NetworkCallback, Handler)} to change where the
3979 * callbacks are invoked.
3980 *
3981 * <p>This{@link NetworkRequest} will live until released via
3982 * {@link #unregisterNetworkCallback(NetworkCallback)} or the calling application exits, at
3983 * which point the system may let go of the network at any time.
3984 *
3985 * <p>A version of this method which takes a timeout is
3986 * {@link #requestNetwork(NetworkRequest, NetworkCallback, int)}, that an app can use to only
3987 * wait for a limited amount of time for the network to become unavailable.
3988 *
Paul Jensenee52d232015-06-16 15:11:58 -04003989 * <p>It is presently unsupported to request a network with mutable
3990 * {@link NetworkCapabilities} such as
3991 * {@link NetworkCapabilities#NET_CAPABILITY_VALIDATED} or
3992 * {@link NetworkCapabilities#NET_CAPABILITY_CAPTIVE_PORTAL}
3993 * as these {@code NetworkCapabilities} represent states that a particular
3994 * network may never attain, and whether a network will attain these states
3995 * is unknown prior to bringing up the network so the framework does not
Chalard Jean01378b62019-08-30 16:27:28 +09003996 * know how to go about satisfying a request with these capabilities.
Lorenzo Colitti0b40c872015-10-15 16:29:00 +09003997 *
3998 * <p>This method requires the caller to hold either the
3999 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
4000 * or the ability to modify system settings as determined by
4001 * {@link android.provider.Settings.System#canWrite}.</p>
Robert Greenwaltf99b8392014-03-26 16:47:06 -07004002 *
Chalard Jeana5ff1132020-05-20 16:11:50 +09004003 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4004 * number of outstanding requests to 100 per app (identified by their UID), shared with
4005 * all variants of this method, of {@link #registerNetworkCallback} as well as
4006 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4007 * Requesting a network with this method will count toward this limit. If this limit is
4008 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4009 * make sure to unregister the callbacks with
4010 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4011 *
Robert Greenwaltf57c03c2014-06-11 16:05:07 -07004012 * @param request {@link NetworkRequest} describing this request.
Hugo Benichifd44e912017-02-02 17:02:36 +09004013 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
4014 * the callback must not be shared - it uniquely specifies this request.
4015 * The callback is invoked on the default internal Handler.
Chalard Jean31740e42019-05-13 15:13:58 +09004016 * @throws IllegalArgumentException if {@code request} contains invalid network capabilities.
4017 * @throws SecurityException if missing the appropriate permissions.
Chalard Jeana5ff1132020-05-20 16:11:50 +09004018 * @throws RuntimeException if the app already has too many callbacks registered.
Robert Greenwaltf99b8392014-03-26 16:47:06 -07004019 */
Chalard Jean158702d2019-01-07 19:26:34 +09004020 public void requestNetwork(@NonNull NetworkRequest request,
4021 @NonNull NetworkCallback networkCallback) {
Hugo Benichifd44e912017-02-02 17:02:36 +09004022 requestNetwork(request, networkCallback, getDefaultHandler());
4023 }
4024
4025 /**
Roshan Pius951c0032020-12-22 15:10:42 -08004026 * Request a network to satisfy a set of {@link NetworkCapabilities}.
Hugo Benichifd44e912017-02-02 17:02:36 +09004027 *
Chalard Jean01378b62019-08-30 16:27:28 +09004028 * This method behaves identically to {@link #requestNetwork(NetworkRequest, NetworkCallback)}
4029 * but runs all the callbacks on the passed Handler.
Hugo Benichifd44e912017-02-02 17:02:36 +09004030 *
Chalard Jean01378b62019-08-30 16:27:28 +09004031 * <p>This method has the same permission requirements as
Chalard Jeana5ff1132020-05-20 16:11:50 +09004032 * {@link #requestNetwork(NetworkRequest, NetworkCallback)}, is subject to the same limitations,
4033 * and throws the same exceptions in the same conditions.
Hugo Benichifd44e912017-02-02 17:02:36 +09004034 *
4035 * @param request {@link NetworkRequest} describing this request.
4036 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
4037 * the callback must not be shared - it uniquely specifies this request.
4038 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
Hugo Benichifd44e912017-02-02 17:02:36 +09004039 */
Chalard Jean158702d2019-01-07 19:26:34 +09004040 public void requestNetwork(@NonNull NetworkRequest request,
4041 @NonNull NetworkCallback networkCallback, @NonNull Handler handler) {
Hugo Benichifd44e912017-02-02 17:02:36 +09004042 CallbackHandler cbHandler = new CallbackHandler(handler);
markchienfac84a22020-03-18 21:16:15 +08004043 NetworkCapabilities nc = request.networkCapabilities;
4044 sendRequestForNetwork(nc, networkCallback, 0, REQUEST, TYPE_NONE, cbHandler);
Robert Greenwaltf99b8392014-03-26 16:47:06 -07004045 }
4046
4047 /**
Roshan Pius951c0032020-12-22 15:10:42 -08004048 * Request a network to satisfy a set of {@link NetworkCapabilities}, limited
Etan Cohenf67bde92017-03-01 12:47:28 -08004049 * by a timeout.
4050 *
4051 * This function behaves identically to the non-timed-out version
4052 * {@link #requestNetwork(NetworkRequest, NetworkCallback)}, but if a suitable network
4053 * is not found within the given time (in milliseconds) the
4054 * {@link NetworkCallback#onUnavailable()} callback is called. The request can still be
4055 * released normally by calling {@link #unregisterNetworkCallback(NetworkCallback)} but does
4056 * not have to be released if timed-out (it is automatically released). Unregistering a
4057 * request that timed out is not an error.
4058 *
4059 * <p>Do not use this method to poll for the existence of specific networks (e.g. with a small
4060 * timeout) - {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)} is provided
4061 * for that purpose. Calling this method will attempt to bring up the requested network.
4062 *
Chalard Jean01378b62019-08-30 16:27:28 +09004063 * <p>This method has the same permission requirements as
Chalard Jeana5ff1132020-05-20 16:11:50 +09004064 * {@link #requestNetwork(NetworkRequest, NetworkCallback)}, is subject to the same limitations,
4065 * and throws the same exceptions in the same conditions.
Etan Cohenf67bde92017-03-01 12:47:28 -08004066 *
4067 * @param request {@link NetworkRequest} describing this request.
Lorenzo Colitti139a48c2017-04-28 00:56:30 +09004068 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
4069 * the callback must not be shared - it uniquely specifies this request.
Etan Cohenf67bde92017-03-01 12:47:28 -08004070 * @param timeoutMs The time in milliseconds to attempt looking for a suitable network
4071 * before {@link NetworkCallback#onUnavailable()} is called. The timeout must
4072 * be a positive value (i.e. >0).
Etan Cohenf67bde92017-03-01 12:47:28 -08004073 */
Chalard Jean158702d2019-01-07 19:26:34 +09004074 public void requestNetwork(@NonNull NetworkRequest request,
4075 @NonNull NetworkCallback networkCallback, int timeoutMs) {
Hugo Benichibc1104b2017-05-09 15:19:01 +09004076 checkTimeout(timeoutMs);
markchienfac84a22020-03-18 21:16:15 +08004077 NetworkCapabilities nc = request.networkCapabilities;
4078 sendRequestForNetwork(nc, networkCallback, timeoutMs, REQUEST, TYPE_NONE,
4079 getDefaultHandler());
Hugo Benichifd44e912017-02-02 17:02:36 +09004080 }
4081
Hugo Benichifd44e912017-02-02 17:02:36 +09004082 /**
Roshan Pius951c0032020-12-22 15:10:42 -08004083 * Request a network to satisfy a set of {@link NetworkCapabilities}, limited
Hugo Benichifd44e912017-02-02 17:02:36 +09004084 * by a timeout.
4085 *
Chalard Jean01378b62019-08-30 16:27:28 +09004086 * This method behaves identically to
4087 * {@link #requestNetwork(NetworkRequest, NetworkCallback, int)} but runs all the callbacks
4088 * on the passed Handler.
Etan Cohenf67bde92017-03-01 12:47:28 -08004089 *
Chalard Jean01378b62019-08-30 16:27:28 +09004090 * <p>This method has the same permission requirements as
Chalard Jeana5ff1132020-05-20 16:11:50 +09004091 * {@link #requestNetwork(NetworkRequest, NetworkCallback)}, is subject to the same limitations,
4092 * and throws the same exceptions in the same conditions.
Hugo Benichifd44e912017-02-02 17:02:36 +09004093 *
4094 * @param request {@link NetworkRequest} describing this request.
Etan Cohenf67bde92017-03-01 12:47:28 -08004095 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
4096 * the callback must not be shared - it uniquely specifies this request.
Hugo Benichifd44e912017-02-02 17:02:36 +09004097 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
Lorenzo Colitti139a48c2017-04-28 00:56:30 +09004098 * @param timeoutMs The time in milliseconds to attempt looking for a suitable network
4099 * before {@link NetworkCallback#onUnavailable} is called.
Hugo Benichifd44e912017-02-02 17:02:36 +09004100 */
Chalard Jean158702d2019-01-07 19:26:34 +09004101 public void requestNetwork(@NonNull NetworkRequest request,
4102 @NonNull NetworkCallback networkCallback, @NonNull Handler handler, int timeoutMs) {
Hugo Benichibc1104b2017-05-09 15:19:01 +09004103 checkTimeout(timeoutMs);
Hugo Benichifd44e912017-02-02 17:02:36 +09004104 CallbackHandler cbHandler = new CallbackHandler(handler);
markchienfac84a22020-03-18 21:16:15 +08004105 NetworkCapabilities nc = request.networkCapabilities;
4106 sendRequestForNetwork(nc, networkCallback, timeoutMs, REQUEST, TYPE_NONE, cbHandler);
Robert Greenwaltf99b8392014-03-26 16:47:06 -07004107 }
4108
4109 /**
Robert Greenwaltf3017f72014-05-18 23:07:25 -07004110 * The lookup key for a {@link Network} object included with the intent after
Jeremy Joslin60d379b2014-11-05 10:32:09 -08004111 * successfully finding a network for the applications request. Retrieve it with
Robert Greenwaltf3017f72014-05-18 23:07:25 -07004112 * {@link android.content.Intent#getParcelableExtra(String)}.
Jeremy Joslinc5302632015-02-11 16:51:13 -08004113 * <p>
Paul Jensenee2f45d2015-03-10 10:54:12 -04004114 * Note that if you intend to invoke {@link Network#openConnection(java.net.URL)}
4115 * then you must get a ConnectivityManager instance before doing so.
Robert Greenwaltf3017f72014-05-18 23:07:25 -07004116 */
Erik Kline8a826212014-11-19 12:12:24 +09004117 public static final String EXTRA_NETWORK = "android.net.extra.NETWORK";
Robert Greenwaltf3017f72014-05-18 23:07:25 -07004118
4119 /**
Robert Greenwaltf57c03c2014-06-11 16:05:07 -07004120 * The lookup key for a {@link NetworkRequest} object included with the intent after
Jeremy Joslin60d379b2014-11-05 10:32:09 -08004121 * successfully finding a network for the applications request. Retrieve it with
Robert Greenwaltf3017f72014-05-18 23:07:25 -07004122 * {@link android.content.Intent#getParcelableExtra(String)}.
4123 */
Erik Kline8a826212014-11-19 12:12:24 +09004124 public static final String EXTRA_NETWORK_REQUEST = "android.net.extra.NETWORK_REQUEST";
Robert Greenwaltf3017f72014-05-18 23:07:25 -07004125
4126
4127 /**
Roshan Pius951c0032020-12-22 15:10:42 -08004128 * Request a network to satisfy a set of {@link NetworkCapabilities}.
Robert Greenwaltf99b8392014-03-26 16:47:06 -07004129 *
Jeremy Joslin60d379b2014-11-05 10:32:09 -08004130 * This function behaves identically to the version that takes a NetworkCallback, but instead
Robert Greenwaltf57c03c2014-06-11 16:05:07 -07004131 * of {@link NetworkCallback} a {@link PendingIntent} is used. This means
Robert Greenwaltf3017f72014-05-18 23:07:25 -07004132 * the request may outlive the calling application and get called back when a suitable
4133 * network is found.
Robert Greenwaltf99b8392014-03-26 16:47:06 -07004134 * <p>
4135 * The operation is an Intent broadcast that goes to a broadcast receiver that
4136 * you registered with {@link Context#registerReceiver} or through the
4137 * &lt;receiver&gt; tag in an AndroidManifest.xml file
4138 * <p>
4139 * The operation Intent is delivered with two extras, a {@link Network} typed
Erik Kline8a826212014-11-19 12:12:24 +09004140 * extra called {@link #EXTRA_NETWORK} and a {@link NetworkRequest}
4141 * typed extra called {@link #EXTRA_NETWORK_REQUEST} containing
Robert Greenwaltf99b8392014-03-26 16:47:06 -07004142 * the original requests parameters. It is important to create a new,
Robert Greenwaltf57c03c2014-06-11 16:05:07 -07004143 * {@link NetworkCallback} based request before completing the processing of the
Robert Greenwaltf99b8392014-03-26 16:47:06 -07004144 * Intent to reserve the network or it will be released shortly after the Intent
4145 * is processed.
4146 * <p>
Paul Jensenc8873fc2015-06-17 14:15:39 -04004147 * If there is already a request for this Intent registered (with the equality of
Robert Greenwaltf99b8392014-03-26 16:47:06 -07004148 * two Intents defined by {@link Intent#filterEquals}), then it will be removed and
Robert Greenwaltf3017f72014-05-18 23:07:25 -07004149 * replaced by this one, effectively releasing the previous {@link NetworkRequest}.
Robert Greenwaltf99b8392014-03-26 16:47:06 -07004150 * <p>
Jeremy Joslin60d379b2014-11-05 10:32:09 -08004151 * The request may be released normally by calling
4152 * {@link #releaseNetworkRequest(android.app.PendingIntent)}.
Paul Jensenee52d232015-06-16 15:11:58 -04004153 * <p>It is presently unsupported to request a network with either
4154 * {@link NetworkCapabilities#NET_CAPABILITY_VALIDATED} or
4155 * {@link NetworkCapabilities#NET_CAPABILITY_CAPTIVE_PORTAL}
4156 * as these {@code NetworkCapabilities} represent states that a particular
4157 * network may never attain, and whether a network will attain these states
4158 * is unknown prior to bringing up the network so the framework does not
Chalard Jean9dd11612018-06-04 16:52:49 +09004159 * know how to go about satisfying a request with these capabilities.
Lorenzo Colitti0b40c872015-10-15 16:29:00 +09004160 *
Chalard Jeana5ff1132020-05-20 16:11:50 +09004161 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4162 * number of outstanding requests to 100 per app (identified by their UID), shared with
4163 * all variants of this method, of {@link #registerNetworkCallback} as well as
4164 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4165 * Requesting a network with this method will count toward this limit. If this limit is
4166 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4167 * make sure to unregister the callbacks with {@link #unregisterNetworkCallback(PendingIntent)}
4168 * or {@link #releaseNetworkRequest(PendingIntent)}.
4169 *
Lorenzo Colitti0b40c872015-10-15 16:29:00 +09004170 * <p>This method requires the caller to hold either the
4171 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
4172 * or the ability to modify system settings as determined by
4173 * {@link android.provider.Settings.System#canWrite}.</p>
4174 *
Robert Greenwaltf57c03c2014-06-11 16:05:07 -07004175 * @param request {@link NetworkRequest} describing this request.
Robert Greenwaltf99b8392014-03-26 16:47:06 -07004176 * @param operation Action to perform when the network is available (corresponds
Robert Greenwaltf57c03c2014-06-11 16:05:07 -07004177 * to the {@link NetworkCallback#onAvailable} call. Typically
Jeremy Joslin60d379b2014-11-05 10:32:09 -08004178 * comes from {@link PendingIntent#getBroadcast}. Cannot be null.
Chalard Jean31740e42019-05-13 15:13:58 +09004179 * @throws IllegalArgumentException if {@code request} contains invalid network capabilities.
4180 * @throws SecurityException if missing the appropriate permissions.
Chalard Jeana5ff1132020-05-20 16:11:50 +09004181 * @throws RuntimeException if the app already has too many callbacks registered.
Robert Greenwaltf99b8392014-03-26 16:47:06 -07004182 */
Chalard Jean158702d2019-01-07 19:26:34 +09004183 public void requestNetwork(@NonNull NetworkRequest request,
4184 @NonNull PendingIntent operation) {
Soi, Yoshinarib8102ef2015-11-12 12:09:02 +09004185 printStackTrace();
Hugo Benichibc1104b2017-05-09 15:19:01 +09004186 checkPendingIntentNotNull(operation);
Robert Greenwaltf99b8392014-03-26 16:47:06 -07004187 try {
Roshan Piusbc7e37d2020-01-16 12:17:17 -08004188 mService.pendingRequestForNetwork(
Philip P. Moltmann7bc33df2020-03-26 11:50:35 -07004189 request.networkCapabilities, operation, mContext.getOpPackageName(),
4190 getAttributionTag());
Jeff Sharkeyc78f85c2016-03-01 19:27:23 -07004191 } catch (RemoteException e) {
4192 throw e.rethrowFromSystemServer();
Hugo Benichia590ab82017-05-11 13:16:17 +09004193 } catch (ServiceSpecificException e) {
4194 throw convertServiceException(e);
Jeff Sharkeyc78f85c2016-03-01 19:27:23 -07004195 }
Robert Greenwaltf99b8392014-03-26 16:47:06 -07004196 }
4197
4198 /**
Jeremy Joslin60d379b2014-11-05 10:32:09 -08004199 * Removes a request made via {@link #requestNetwork(NetworkRequest, android.app.PendingIntent)}
4200 * <p>
Lorenzo Colitti15874cd2016-04-13 22:00:02 +09004201 * This method has the same behavior as
4202 * {@link #unregisterNetworkCallback(android.app.PendingIntent)} with respect to
Jeremy Joslin60d379b2014-11-05 10:32:09 -08004203 * releasing network resources and disconnecting.
4204 *
4205 * @param operation A PendingIntent equal (as defined by {@link Intent#filterEquals}) to the
4206 * PendingIntent passed to
4207 * {@link #requestNetwork(NetworkRequest, android.app.PendingIntent)} with the
4208 * corresponding NetworkRequest you'd like to remove. Cannot be null.
4209 */
Chalard Jean158702d2019-01-07 19:26:34 +09004210 public void releaseNetworkRequest(@NonNull PendingIntent operation) {
Soi, Yoshinarib8102ef2015-11-12 12:09:02 +09004211 printStackTrace();
Hugo Benichibc1104b2017-05-09 15:19:01 +09004212 checkPendingIntentNotNull(operation);
Jeremy Joslin60d379b2014-11-05 10:32:09 -08004213 try {
4214 mService.releasePendingNetworkRequest(operation);
Jeff Sharkeyc78f85c2016-03-01 19:27:23 -07004215 } catch (RemoteException e) {
4216 throw e.rethrowFromSystemServer();
4217 }
Jeremy Joslin60d379b2014-11-05 10:32:09 -08004218 }
4219
Hugo Benichibc1104b2017-05-09 15:19:01 +09004220 private static void checkPendingIntentNotNull(PendingIntent intent) {
Remi NGUYEN VAN81f68422021-03-15 07:31:54 +00004221 Objects.requireNonNull(intent, "PendingIntent cannot be null.");
Hugo Benichibc1104b2017-05-09 15:19:01 +09004222 }
4223
4224 private static void checkCallbackNotNull(NetworkCallback callback) {
Remi NGUYEN VAN81f68422021-03-15 07:31:54 +00004225 Objects.requireNonNull(callback, "null NetworkCallback");
Hugo Benichibc1104b2017-05-09 15:19:01 +09004226 }
4227
4228 private static void checkTimeout(int timeoutMs) {
Remi NGUYEN VAN81f68422021-03-15 07:31:54 +00004229 if (timeoutMs <= 0) {
4230 throw new IllegalArgumentException("timeoutMs must be strictly positive.");
4231 }
Jeremy Joslin60d379b2014-11-05 10:32:09 -08004232 }
4233
4234 /**
Robert Greenwaltf99b8392014-03-26 16:47:06 -07004235 * Registers to receive notifications about all networks which satisfy the given
Robert Greenwaltf57c03c2014-06-11 16:05:07 -07004236 * {@link NetworkRequest}. The callbacks will continue to be called until
Chiachang Wang3b723c22019-02-27 17:14:50 +08004237 * either the application exits or {@link #unregisterNetworkCallback(NetworkCallback)} is
4238 * called.
Robert Greenwaltf99b8392014-03-26 16:47:06 -07004239 *
Chalard Jeana5ff1132020-05-20 16:11:50 +09004240 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4241 * number of outstanding requests to 100 per app (identified by their UID), shared with
4242 * all variants of this method, of {@link #requestNetwork} as well as
4243 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4244 * Requesting a network with this method will count toward this limit. If this limit is
4245 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4246 * make sure to unregister the callbacks with
4247 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4248 *
Robert Greenwaltf57c03c2014-06-11 16:05:07 -07004249 * @param request {@link NetworkRequest} describing this request.
4250 * @param networkCallback The {@link NetworkCallback} that the system will call as suitable
4251 * networks change state.
Hugo Benichifd44e912017-02-02 17:02:36 +09004252 * The callback is invoked on the default internal Handler.
Chalard Jeana5ff1132020-05-20 16:11:50 +09004253 * @throws RuntimeException if the app already has too many callbacks registered.
Robert Greenwaltf99b8392014-03-26 16:47:06 -07004254 */
Jeff Sharkey656584a2017-04-24 11:18:03 -06004255 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean158702d2019-01-07 19:26:34 +09004256 public void registerNetworkCallback(@NonNull NetworkRequest request,
4257 @NonNull NetworkCallback networkCallback) {
Hugo Benichifd44e912017-02-02 17:02:36 +09004258 registerNetworkCallback(request, networkCallback, getDefaultHandler());
4259 }
4260
4261 /**
4262 * Registers to receive notifications about all networks which satisfy the given
4263 * {@link NetworkRequest}. The callbacks will continue to be called until
Chiachang Wang3b723c22019-02-27 17:14:50 +08004264 * either the application exits or {@link #unregisterNetworkCallback(NetworkCallback)} is
4265 * called.
Hugo Benichifd44e912017-02-02 17:02:36 +09004266 *
Chalard Jeana5ff1132020-05-20 16:11:50 +09004267 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4268 * number of outstanding requests to 100 per app (identified by their UID), shared with
4269 * all variants of this method, of {@link #requestNetwork} as well as
4270 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4271 * Requesting a network with this method will count toward this limit. If this limit is
4272 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4273 * make sure to unregister the callbacks with
4274 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4275 *
4276 *
Hugo Benichifd44e912017-02-02 17:02:36 +09004277 * @param request {@link NetworkRequest} describing this request.
4278 * @param networkCallback The {@link NetworkCallback} that the system will call as suitable
4279 * networks change state.
4280 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
Chalard Jeana5ff1132020-05-20 16:11:50 +09004281 * @throws RuntimeException if the app already has too many callbacks registered.
Hugo Benichifd44e912017-02-02 17:02:36 +09004282 */
Jeff Sharkey656584a2017-04-24 11:18:03 -06004283 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean158702d2019-01-07 19:26:34 +09004284 public void registerNetworkCallback(@NonNull NetworkRequest request,
4285 @NonNull NetworkCallback networkCallback, @NonNull Handler handler) {
Hugo Benichifd44e912017-02-02 17:02:36 +09004286 CallbackHandler cbHandler = new CallbackHandler(handler);
4287 NetworkCapabilities nc = request.networkCapabilities;
4288 sendRequestForNetwork(nc, networkCallback, 0, LISTEN, TYPE_NONE, cbHandler);
Robert Greenwaltf99b8392014-03-26 16:47:06 -07004289 }
4290
4291 /**
Paul Jensenc8873fc2015-06-17 14:15:39 -04004292 * Registers a PendingIntent to be sent when a network is available which satisfies the given
4293 * {@link NetworkRequest}.
4294 *
4295 * This function behaves identically to the version that takes a NetworkCallback, but instead
4296 * of {@link NetworkCallback} a {@link PendingIntent} is used. This means
4297 * the request may outlive the calling application and get called back when a suitable
4298 * network is found.
4299 * <p>
4300 * The operation is an Intent broadcast that goes to a broadcast receiver that
4301 * you registered with {@link Context#registerReceiver} or through the
4302 * &lt;receiver&gt; tag in an AndroidManifest.xml file
4303 * <p>
4304 * The operation Intent is delivered with two extras, a {@link Network} typed
4305 * extra called {@link #EXTRA_NETWORK} and a {@link NetworkRequest}
4306 * typed extra called {@link #EXTRA_NETWORK_REQUEST} containing
4307 * the original requests parameters.
4308 * <p>
4309 * If there is already a request for this Intent registered (with the equality of
4310 * two Intents defined by {@link Intent#filterEquals}), then it will be removed and
4311 * replaced by this one, effectively releasing the previous {@link NetworkRequest}.
4312 * <p>
4313 * The request may be released normally by calling
Paul Jensen169f6622015-06-30 14:29:18 -04004314 * {@link #unregisterNetworkCallback(android.app.PendingIntent)}.
Chalard Jeana5ff1132020-05-20 16:11:50 +09004315 *
4316 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4317 * number of outstanding requests to 100 per app (identified by their UID), shared with
4318 * all variants of this method, of {@link #requestNetwork} as well as
4319 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4320 * Requesting a network with this method will count toward this limit. If this limit is
4321 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4322 * make sure to unregister the callbacks with {@link #unregisterNetworkCallback(PendingIntent)}
4323 * or {@link #releaseNetworkRequest(PendingIntent)}.
4324 *
Paul Jensenc8873fc2015-06-17 14:15:39 -04004325 * @param request {@link NetworkRequest} describing this request.
4326 * @param operation Action to perform when the network is available (corresponds
4327 * to the {@link NetworkCallback#onAvailable} call. Typically
4328 * comes from {@link PendingIntent#getBroadcast}. Cannot be null.
Chalard Jeana5ff1132020-05-20 16:11:50 +09004329 * @throws RuntimeException if the app already has too many callbacks registered.
Paul Jensenc8873fc2015-06-17 14:15:39 -04004330 */
Jeff Sharkey656584a2017-04-24 11:18:03 -06004331 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean158702d2019-01-07 19:26:34 +09004332 public void registerNetworkCallback(@NonNull NetworkRequest request,
4333 @NonNull PendingIntent operation) {
Soi, Yoshinarib8102ef2015-11-12 12:09:02 +09004334 printStackTrace();
Hugo Benichibc1104b2017-05-09 15:19:01 +09004335 checkPendingIntentNotNull(operation);
Paul Jensenc8873fc2015-06-17 14:15:39 -04004336 try {
Roshan Piusbc7e37d2020-01-16 12:17:17 -08004337 mService.pendingListenForNetwork(
Roshan Piusaa24fde2020-12-17 14:53:09 -08004338 request.networkCapabilities, operation, mContext.getOpPackageName(),
4339 getAttributionTag());
Jeff Sharkeyc78f85c2016-03-01 19:27:23 -07004340 } catch (RemoteException e) {
4341 throw e.rethrowFromSystemServer();
Hugo Benichia590ab82017-05-11 13:16:17 +09004342 } catch (ServiceSpecificException e) {
4343 throw convertServiceException(e);
Jeff Sharkeyc78f85c2016-03-01 19:27:23 -07004344 }
Paul Jensenc8873fc2015-06-17 14:15:39 -04004345 }
4346
4347 /**
Lorenzo Colitti76b639e2021-01-29 20:14:04 +09004348 * Registers to receive notifications about changes in the application's default network. This
4349 * may be a physical network or a virtual network, such as a VPN that applies to the
4350 * application. The callbacks will continue to be called until either the application exits or
Lorenzo Colitti15874cd2016-04-13 22:00:02 +09004351 * {@link #unregisterNetworkCallback(NetworkCallback)} is called.
Erik Kline23bf99c2016-03-16 15:31:39 +09004352 *
Chalard Jeana5ff1132020-05-20 16:11:50 +09004353 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4354 * number of outstanding requests to 100 per app (identified by their UID), shared with
4355 * all variants of this method, of {@link #requestNetwork} as well as
4356 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4357 * Requesting a network with this method will count toward this limit. If this limit is
4358 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4359 * make sure to unregister the callbacks with
4360 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4361 *
Erik Kline23bf99c2016-03-16 15:31:39 +09004362 * @param networkCallback The {@link NetworkCallback} that the system will call as the
Lorenzo Colitti76b639e2021-01-29 20:14:04 +09004363 * application's default network changes.
Hugo Benichifd44e912017-02-02 17:02:36 +09004364 * The callback is invoked on the default internal Handler.
Chalard Jeana5ff1132020-05-20 16:11:50 +09004365 * @throws RuntimeException if the app already has too many callbacks registered.
Erik Kline23bf99c2016-03-16 15:31:39 +09004366 */
Jeff Sharkey656584a2017-04-24 11:18:03 -06004367 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean158702d2019-01-07 19:26:34 +09004368 public void registerDefaultNetworkCallback(@NonNull NetworkCallback networkCallback) {
Hugo Benichifd44e912017-02-02 17:02:36 +09004369 registerDefaultNetworkCallback(networkCallback, getDefaultHandler());
4370 }
4371
4372 /**
Lorenzo Colitti76b639e2021-01-29 20:14:04 +09004373 * Registers to receive notifications about changes in the application's default network. This
4374 * may be a physical network or a virtual network, such as a VPN that applies to the
4375 * application. The callbacks will continue to be called until either the application exits or
4376 * {@link #unregisterNetworkCallback(NetworkCallback)} is called.
4377 *
4378 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4379 * number of outstanding requests to 100 per app (identified by their UID), shared with
4380 * all variants of this method, of {@link #requestNetwork} as well as
4381 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4382 * Requesting a network with this method will count toward this limit. If this limit is
4383 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4384 * make sure to unregister the callbacks with
4385 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4386 *
4387 * @param networkCallback The {@link NetworkCallback} that the system will call as the
4388 * application's default network changes.
4389 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
4390 * @throws RuntimeException if the app already has too many callbacks registered.
4391 */
4392 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
4393 public void registerDefaultNetworkCallback(@NonNull NetworkCallback networkCallback,
4394 @NonNull Handler handler) {
Lorenzo Colitti2a49c5d2021-03-12 22:48:07 +09004395 registerDefaultNetworkCallbackAsUid(Process.INVALID_UID, networkCallback, handler);
4396 }
4397
4398 /**
4399 * Registers to receive notifications about changes in the default network for the specified
4400 * UID. This may be a physical network or a virtual network, such as a VPN that applies to the
4401 * UID. The callbacks will continue to be called until either the application exits or
4402 * {@link #unregisterNetworkCallback(NetworkCallback)} is called.
4403 *
4404 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4405 * number of outstanding requests to 100 per app (identified by their UID), shared with
4406 * all variants of this method, of {@link #requestNetwork} as well as
4407 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4408 * Requesting a network with this method will count toward this limit. If this limit is
4409 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4410 * make sure to unregister the callbacks with
4411 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4412 *
4413 * @param uid the UID for which to track default network changes.
4414 * @param networkCallback The {@link NetworkCallback} that the system will call as the
4415 * UID's default network changes.
4416 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
4417 * @throws RuntimeException if the app already has too many callbacks registered.
4418 * @hide
4419 */
Lorenzo Colitti92ed8b92021-03-22 18:23:21 +09004420 @SystemApi(client = MODULE_LIBRARIES)
Lorenzo Colitti2a49c5d2021-03-12 22:48:07 +09004421 @SuppressLint({"ExecutorRegistration", "PairedRegistration"})
4422 @RequiresPermission(anyOf = {
4423 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
4424 android.Manifest.permission.NETWORK_SETTINGS})
4425 public void registerDefaultNetworkCallbackAsUid(int uid,
4426 @NonNull NetworkCallback networkCallback, @NonNull Handler handler) {
Lorenzo Colitti76b639e2021-01-29 20:14:04 +09004427 CallbackHandler cbHandler = new CallbackHandler(handler);
Lorenzo Colitti2a49c5d2021-03-12 22:48:07 +09004428 sendRequestForNetwork(uid, null /* need */, networkCallback, 0 /* timeoutMs */,
Lorenzo Colitti76b639e2021-01-29 20:14:04 +09004429 TRACK_DEFAULT, TYPE_NONE, cbHandler);
4430 }
4431
4432 /**
Hugo Benichifd44e912017-02-02 17:02:36 +09004433 * Registers to receive notifications about changes in the system default network. The callbacks
4434 * will continue to be called until either the application exits or
4435 * {@link #unregisterNetworkCallback(NetworkCallback)} is called.
Hugo Benichifd44e912017-02-02 17:02:36 +09004436 *
Lorenzo Colitti76b639e2021-01-29 20:14:04 +09004437 * This method should not be used to determine networking state seen by applications, because in
4438 * many cases, most or even all application traffic may not use the default network directly,
4439 * and traffic from different applications may go on different networks by default. As an
4440 * example, if a VPN is connected, traffic from all applications might be sent through the VPN
4441 * and not onto the system default network. Applications or system components desiring to do
4442 * determine network state as seen by applications should use other methods such as
4443 * {@link #registerDefaultNetworkCallback(NetworkCallback, Handler)}.
4444 *
Chalard Jeana5ff1132020-05-20 16:11:50 +09004445 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4446 * number of outstanding requests to 100 per app (identified by their UID), shared with
4447 * all variants of this method, of {@link #requestNetwork} as well as
4448 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4449 * Requesting a network with this method will count toward this limit. If this limit is
4450 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4451 * make sure to unregister the callbacks with
4452 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4453 *
Hugo Benichifd44e912017-02-02 17:02:36 +09004454 * @param networkCallback The {@link NetworkCallback} that the system will call as the
4455 * system default network changes.
4456 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
Chalard Jeana5ff1132020-05-20 16:11:50 +09004457 * @throws RuntimeException if the app already has too many callbacks registered.
Lorenzo Colitti76b639e2021-01-29 20:14:04 +09004458 *
4459 * @hide
Hugo Benichifd44e912017-02-02 17:02:36 +09004460 */
Lorenzo Colitti76b639e2021-01-29 20:14:04 +09004461 @SystemApi(client = MODULE_LIBRARIES)
4462 @SuppressLint({"ExecutorRegistration", "PairedRegistration"})
4463 @RequiresPermission(anyOf = {
4464 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
4465 android.Manifest.permission.NETWORK_SETTINGS})
4466 public void registerSystemDefaultNetworkCallback(@NonNull NetworkCallback networkCallback,
Chalard Jean158702d2019-01-07 19:26:34 +09004467 @NonNull Handler handler) {
Hugo Benichifd44e912017-02-02 17:02:36 +09004468 CallbackHandler cbHandler = new CallbackHandler(handler);
Chalard Jean9dd11612018-06-04 16:52:49 +09004469 sendRequestForNetwork(null /* NetworkCapabilities need */, networkCallback, 0,
Lorenzo Colitti76b639e2021-01-29 20:14:04 +09004470 TRACK_SYSTEM_DEFAULT, TYPE_NONE, cbHandler);
Erik Kline23bf99c2016-03-16 15:31:39 +09004471 }
4472
4473 /**
junyulai8eb13a22021-03-15 11:48:48 +08004474 * Registers to receive notifications about the best matching network which satisfy the given
4475 * {@link NetworkRequest}. The callbacks will continue to be called until
4476 * either the application exits or {@link #unregisterNetworkCallback(NetworkCallback)} is
4477 * called.
4478 *
4479 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4480 * number of outstanding requests to 100 per app (identified by their UID), shared with
4481 * {@link #registerNetworkCallback} and its variants and {@link #requestNetwork} as well as
4482 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4483 * Requesting a network with this method will count toward this limit. If this limit is
4484 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4485 * make sure to unregister the callbacks with
4486 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4487 *
4488 *
4489 * @param request {@link NetworkRequest} describing this request.
4490 * @param networkCallback The {@link NetworkCallback} that the system will call as suitable
4491 * networks change state.
4492 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
4493 * @throws RuntimeException if the app already has too many callbacks registered.
junyulai7514e312021-03-05 15:51:17 +08004494 */
junyulai7514e312021-03-05 15:51:17 +08004495 @SuppressLint("ExecutorRegistration")
4496 public void registerBestMatchingNetworkCallback(@NonNull NetworkRequest request,
4497 @NonNull NetworkCallback networkCallback, @NonNull Handler handler) {
4498 final NetworkCapabilities nc = request.networkCapabilities;
4499 final CallbackHandler cbHandler = new CallbackHandler(handler);
junyulai1b1c8742021-03-12 20:05:08 +08004500 sendRequestForNetwork(nc, networkCallback, 0, LISTEN_FOR_BEST, TYPE_NONE, cbHandler);
junyulai7514e312021-03-05 15:51:17 +08004501 }
4502
4503 /**
fenglub00f4882015-04-21 17:12:05 -07004504 * Requests bandwidth update for a given {@link Network} and returns whether the update request
4505 * is accepted by ConnectivityService. Once accepted, ConnectivityService will poll underlying
4506 * network connection for updated bandwidth information. The caller will be notified via
4507 * {@link ConnectivityManager.NetworkCallback} if there is an update. Notice that this
Lorenzo Colitti15874cd2016-04-13 22:00:02 +09004508 * method assumes that the caller has previously called
4509 * {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)} to listen for network
4510 * changes.
fenglu3f357402015-03-20 11:29:56 -07004511 *
fengluea2d9282015-04-27 14:28:04 -07004512 * @param network {@link Network} specifying which network you're interested.
fenglub00f4882015-04-21 17:12:05 -07004513 * @return {@code true} on success, {@code false} if the {@link Network} is no longer valid.
fenglu3f357402015-03-20 11:29:56 -07004514 */
Chalard Jean158702d2019-01-07 19:26:34 +09004515 public boolean requestBandwidthUpdate(@NonNull Network network) {
fenglu3f357402015-03-20 11:29:56 -07004516 try {
fenglub00f4882015-04-21 17:12:05 -07004517 return mService.requestBandwidthUpdate(network);
fenglu3f357402015-03-20 11:29:56 -07004518 } catch (RemoteException e) {
Jeff Sharkeyc78f85c2016-03-01 19:27:23 -07004519 throw e.rethrowFromSystemServer();
fenglu3f357402015-03-20 11:29:56 -07004520 }
4521 }
4522
4523 /**
Hugo Benichi2aa65af2017-03-06 09:17:06 +09004524 * Unregisters a {@code NetworkCallback} and possibly releases networks originating from
Lorenzo Colitti15874cd2016-04-13 22:00:02 +09004525 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} and
4526 * {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)} calls.
4527 * If the given {@code NetworkCallback} had previously been used with
Lorenzo Colitti7f6a2bf2015-04-24 17:03:31 +09004528 * {@code #requestNetwork}, any networks that had been connected to only to satisfy that request
4529 * will be disconnected.
Robert Greenwaltf99b8392014-03-26 16:47:06 -07004530 *
Hugo Benichi2aa65af2017-03-06 09:17:06 +09004531 * Notifications that would have triggered that {@code NetworkCallback} will immediately stop
4532 * triggering it as soon as this call returns.
4533 *
Robert Greenwaltf57c03c2014-06-11 16:05:07 -07004534 * @param networkCallback The {@link NetworkCallback} used when making the request.
Robert Greenwaltf99b8392014-03-26 16:47:06 -07004535 */
Chalard Jean158702d2019-01-07 19:26:34 +09004536 public void unregisterNetworkCallback(@NonNull NetworkCallback networkCallback) {
Soi, Yoshinarib8102ef2015-11-12 12:09:02 +09004537 printStackTrace();
Hugo Benichibc1104b2017-05-09 15:19:01 +09004538 checkCallbackNotNull(networkCallback);
Hugo Benichi2aa65af2017-03-06 09:17:06 +09004539 final List<NetworkRequest> reqs = new ArrayList<>();
4540 // Find all requests associated to this callback and stop callback triggers immediately.
4541 // Callback is reusable immediately. http://b/20701525, http://b/35921499.
4542 synchronized (sCallbacks) {
Remi NGUYEN VAN81f68422021-03-15 07:31:54 +00004543 if (networkCallback.networkRequest == null) {
4544 throw new IllegalArgumentException("NetworkCallback was not registered");
4545 }
Etan Cohen6cb65992019-04-16 15:07:55 -07004546 if (networkCallback.networkRequest == ALREADY_UNREGISTERED) {
4547 Log.d(TAG, "NetworkCallback was already unregistered");
4548 return;
4549 }
Hugo Benichi2aa65af2017-03-06 09:17:06 +09004550 for (Map.Entry<NetworkRequest, NetworkCallback> e : sCallbacks.entrySet()) {
4551 if (e.getValue() == networkCallback) {
4552 reqs.add(e.getKey());
4553 }
4554 }
4555 // TODO: throw exception if callback was registered more than once (http://b/20701525).
4556 for (NetworkRequest r : reqs) {
4557 try {
4558 mService.releaseNetworkRequest(r);
4559 } catch (RemoteException e) {
4560 throw e.rethrowFromSystemServer();
4561 }
4562 // Only remove mapping if rpc was successful.
4563 sCallbacks.remove(r);
4564 }
Hugo Benichibee30fe2017-06-17 13:14:12 +09004565 networkCallback.networkRequest = ALREADY_UNREGISTERED;
Jeff Sharkeyc78f85c2016-03-01 19:27:23 -07004566 }
Robert Greenwaltf99b8392014-03-26 16:47:06 -07004567 }
Paul Jensen8cdda642014-05-29 10:12:39 -04004568
4569 /**
Paul Jensen169f6622015-06-30 14:29:18 -04004570 * Unregisters a callback previously registered via
4571 * {@link #registerNetworkCallback(NetworkRequest, android.app.PendingIntent)}.
4572 *
4573 * @param operation A PendingIntent equal (as defined by {@link Intent#filterEquals}) to the
4574 * PendingIntent passed to
4575 * {@link #registerNetworkCallback(NetworkRequest, android.app.PendingIntent)}.
4576 * Cannot be null.
4577 */
Chalard Jean158702d2019-01-07 19:26:34 +09004578 public void unregisterNetworkCallback(@NonNull PendingIntent operation) {
Paul Jensen169f6622015-06-30 14:29:18 -04004579 releaseNetworkRequest(operation);
4580 }
4581
4582 /**
Lorenzo Colitti6947c062015-04-03 16:38:52 +09004583 * Informs the system whether it should switch to {@code network} regardless of whether it is
4584 * validated or not. If {@code accept} is true, and the network was explicitly selected by the
4585 * user (e.g., by selecting a Wi-Fi network in the Settings app), then the network will become
4586 * the system default network regardless of any other network that's currently connected. If
4587 * {@code always} is true, then the choice is remembered, so that the next time the user
4588 * connects to this network, the system will switch to it.
4589 *
Lorenzo Colitti6947c062015-04-03 16:38:52 +09004590 * @param network The network to accept.
4591 * @param accept Whether to accept the network even if unvalidated.
4592 * @param always Whether to remember this choice in the future.
4593 *
4594 * @hide
4595 */
Chiachang Wang4d513572021-03-18 09:44:34 +08004596 @SystemApi(client = MODULE_LIBRARIES)
4597 @RequiresPermission(anyOf = {
4598 android.Manifest.permission.NETWORK_SETTINGS,
4599 android.Manifest.permission.NETWORK_SETUP_WIZARD,
4600 android.Manifest.permission.NETWORK_STACK,
4601 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK})
4602 public void setAcceptUnvalidated(@NonNull Network network, boolean accept, boolean always) {
Lorenzo Colitti6947c062015-04-03 16:38:52 +09004603 try {
4604 mService.setAcceptUnvalidated(network, accept, always);
Jeff Sharkeyc78f85c2016-03-01 19:27:23 -07004605 } catch (RemoteException e) {
4606 throw e.rethrowFromSystemServer();
4607 }
Lorenzo Colitti6947c062015-04-03 16:38:52 +09004608 }
4609
4610 /**
lucaslin2240ef62019-03-12 13:08:03 +08004611 * Informs the system whether it should consider the network as validated even if it only has
4612 * partial connectivity. If {@code accept} is true, then the network will be considered as
4613 * validated even if connectivity is only partial. If {@code always} is true, then the choice
4614 * is remembered, so that the next time the user connects to this network, the system will
4615 * switch to it.
4616 *
4617 * @param network The network to accept.
4618 * @param accept Whether to consider the network as validated even if it has partial
4619 * connectivity.
4620 * @param always Whether to remember this choice in the future.
4621 *
4622 * @hide
4623 */
Chiachang Wang4d513572021-03-18 09:44:34 +08004624 @SystemApi(client = MODULE_LIBRARIES)
4625 @RequiresPermission(anyOf = {
4626 android.Manifest.permission.NETWORK_SETTINGS,
4627 android.Manifest.permission.NETWORK_SETUP_WIZARD,
4628 android.Manifest.permission.NETWORK_STACK,
4629 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK})
4630 public void setAcceptPartialConnectivity(@NonNull Network network, boolean accept,
4631 boolean always) {
lucaslin2240ef62019-03-12 13:08:03 +08004632 try {
4633 mService.setAcceptPartialConnectivity(network, accept, always);
4634 } catch (RemoteException e) {
4635 throw e.rethrowFromSystemServer();
4636 }
4637 }
4638
4639 /**
Lorenzo Colittic65750c2016-09-19 01:00:19 +09004640 * Informs the system to penalize {@code network}'s score when it becomes unvalidated. This is
4641 * only meaningful if the system is configured not to penalize such networks, e.g., if the
4642 * {@code config_networkAvoidBadWifi} configuration variable is set to 0 and the {@code
4643 * NETWORK_AVOID_BAD_WIFI setting is unset}.
4644 *
Lorenzo Colittic65750c2016-09-19 01:00:19 +09004645 * @param network The network to accept.
4646 *
4647 * @hide
4648 */
Chiachang Wang4d513572021-03-18 09:44:34 +08004649 @SystemApi(client = MODULE_LIBRARIES)
4650 @RequiresPermission(anyOf = {
4651 android.Manifest.permission.NETWORK_SETTINGS,
4652 android.Manifest.permission.NETWORK_SETUP_WIZARD,
4653 android.Manifest.permission.NETWORK_STACK,
4654 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK})
4655 public void setAvoidUnvalidated(@NonNull Network network) {
Lorenzo Colittic65750c2016-09-19 01:00:19 +09004656 try {
4657 mService.setAvoidUnvalidated(network);
4658 } catch (RemoteException e) {
4659 throw e.rethrowFromSystemServer();
4660 }
4661 }
4662
4663 /**
Lorenzo Colitti500dbae2017-04-27 14:30:21 +09004664 * Requests that the system open the captive portal app on the specified network.
4665 *
Remi NGUYEN VAN4cf96ab2021-03-16 18:06:06 +09004666 * <p>This is to be used on networks where a captive portal was detected, as per
4667 * {@link NetworkCapabilities#NET_CAPABILITY_CAPTIVE_PORTAL}.
4668 *
Lorenzo Colitti500dbae2017-04-27 14:30:21 +09004669 * @param network The network to log into.
4670 *
4671 * @hide
4672 */
Remi NGUYEN VAN4cf96ab2021-03-16 18:06:06 +09004673 @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
4674 @RequiresPermission(anyOf = {
4675 android.Manifest.permission.NETWORK_SETTINGS,
4676 android.Manifest.permission.NETWORK_STACK,
4677 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK
4678 })
4679 public void startCaptivePortalApp(@NonNull Network network) {
Lorenzo Colitti500dbae2017-04-27 14:30:21 +09004680 try {
4681 mService.startCaptivePortalApp(network);
4682 } catch (RemoteException e) {
4683 throw e.rethrowFromSystemServer();
4684 }
4685 }
4686
4687 /**
Remi NGUYEN VAN94ff95b2019-02-04 11:32:20 +09004688 * Requests that the system open the captive portal app with the specified extras.
4689 *
4690 * <p>This endpoint is exclusively for use by the NetworkStack and is protected by the
4691 * corresponding permission.
Remi NGUYEN VANeab0f542019-02-13 20:58:59 +09004692 * @param network Network on which the captive portal was detected.
Remi NGUYEN VAN94ff95b2019-02-04 11:32:20 +09004693 * @param appExtras Extras to include in the app start intent.
4694 * @hide
4695 */
4696 @SystemApi
Remi NGUYEN VAN94ff95b2019-02-04 11:32:20 +09004697 @RequiresPermission(NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK)
paulhucbbc3db2019-03-08 16:35:20 +08004698 public void startCaptivePortalApp(@NonNull Network network, @NonNull Bundle appExtras) {
Remi NGUYEN VAN94ff95b2019-02-04 11:32:20 +09004699 try {
Remi NGUYEN VANeab0f542019-02-13 20:58:59 +09004700 mService.startCaptivePortalAppInternal(network, appExtras);
Remi NGUYEN VAN94ff95b2019-02-04 11:32:20 +09004701 } catch (RemoteException e) {
4702 throw e.rethrowFromSystemServer();
4703 }
4704 }
4705
4706 /**
Remi NGUYEN VAN27de63e2019-01-20 20:35:06 +09004707 * Determine whether the device is configured to avoid bad wifi.
4708 * @hide
4709 */
4710 @SystemApi
Remi NGUYEN VAN1fb7cab2019-03-22 11:14:13 +09004711 @RequiresPermission(anyOf = {
4712 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
4713 android.Manifest.permission.NETWORK_STACK})
4714 public boolean shouldAvoidBadWifi() {
Remi NGUYEN VAN27de63e2019-01-20 20:35:06 +09004715 try {
Remi NGUYEN VAN1fb7cab2019-03-22 11:14:13 +09004716 return mService.shouldAvoidBadWifi();
Remi NGUYEN VAN27de63e2019-01-20 20:35:06 +09004717 } catch (RemoteException e) {
4718 throw e.rethrowFromSystemServer();
4719 }
4720 }
4721
4722 /**
Lorenzo Colitti48a2a322017-01-24 18:08:41 +09004723 * It is acceptable to briefly use multipath data to provide seamless connectivity for
4724 * time-sensitive user-facing operations when the system default network is temporarily
Lorenzo Colitti139a48c2017-04-28 00:56:30 +09004725 * unresponsive. The amount of data should be limited (less than one megabyte for every call to
4726 * this method), and the operation should be infrequent to ensure that data usage is limited.
Lorenzo Colitti48a2a322017-01-24 18:08:41 +09004727 *
4728 * An example of such an operation might be a time-sensitive foreground activity, such as a
4729 * voice command, that the user is performing while walking out of range of a Wi-Fi network.
4730 */
4731 public static final int MULTIPATH_PREFERENCE_HANDOVER = 1 << 0;
4732
4733 /**
4734 * It is acceptable to use small amounts of multipath data on an ongoing basis to provide
4735 * a backup channel for traffic that is primarily going over another network.
4736 *
4737 * An example might be maintaining backup connections to peers or servers for the purpose of
4738 * fast fallback if the default network is temporarily unresponsive or disconnects. The traffic
4739 * on backup paths should be negligible compared to the traffic on the main path.
4740 */
4741 public static final int MULTIPATH_PREFERENCE_RELIABILITY = 1 << 1;
4742
4743 /**
4744 * It is acceptable to use metered data to improve network latency and performance.
4745 */
4746 public static final int MULTIPATH_PREFERENCE_PERFORMANCE = 1 << 2;
4747
4748 /**
4749 * Return value to use for unmetered networks. On such networks we currently set all the flags
4750 * to true.
4751 * @hide
4752 */
4753 public static final int MULTIPATH_PREFERENCE_UNMETERED =
4754 MULTIPATH_PREFERENCE_HANDOVER |
4755 MULTIPATH_PREFERENCE_RELIABILITY |
4756 MULTIPATH_PREFERENCE_PERFORMANCE;
4757
4758 /** @hide */
4759 @Retention(RetentionPolicy.SOURCE)
4760 @IntDef(flag = true, value = {
4761 MULTIPATH_PREFERENCE_HANDOVER,
4762 MULTIPATH_PREFERENCE_RELIABILITY,
4763 MULTIPATH_PREFERENCE_PERFORMANCE,
4764 })
4765 public @interface MultipathPreference {
4766 }
4767
4768 /**
4769 * Provides a hint to the calling application on whether it is desirable to use the
4770 * multinetwork APIs (e.g., {@link Network#openConnection}, {@link Network#bindSocket}, etc.)
4771 * for multipath data transfer on this network when it is not the system default network.
4772 * Applications desiring to use multipath network protocols should call this method before
4773 * each such operation.
Lorenzo Colitti48a2a322017-01-24 18:08:41 +09004774 *
4775 * @param network The network on which the application desires to use multipath data.
4776 * If {@code null}, this method will return the a preference that will generally
4777 * apply to metered networks.
4778 * @return a bitwise OR of zero or more of the {@code MULTIPATH_PREFERENCE_*} constants.
4779 */
Jeff Sharkey656584a2017-04-24 11:18:03 -06004780 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean158702d2019-01-07 19:26:34 +09004781 public @MultipathPreference int getMultipathPreference(@Nullable Network network) {
Lorenzo Colitti48a2a322017-01-24 18:08:41 +09004782 try {
4783 return mService.getMultipathPreference(network);
4784 } catch (RemoteException e) {
4785 throw e.rethrowFromSystemServer();
4786 }
4787 }
4788
4789 /**
Stuart Scott0f835ac2015-03-30 13:17:11 -07004790 * Resets all connectivity manager settings back to factory defaults.
4791 * @hide
4792 */
Chiachang Wang4d513572021-03-18 09:44:34 +08004793 @SystemApi(client = MODULE_LIBRARIES)
4794 @RequiresPermission(anyOf = {
4795 android.Manifest.permission.NETWORK_SETTINGS,
4796 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK})
Stuart Scott0f835ac2015-03-30 13:17:11 -07004797 public void factoryReset() {
Stuart Scott0f835ac2015-03-30 13:17:11 -07004798 try {
Stuart Scottd5463642015-04-02 18:00:02 -07004799 mService.factoryReset();
Amos Bianchia9b415a2020-03-04 11:07:38 -08004800 mTetheringManager.stopAllTethering();
Stuart Scott0f835ac2015-03-30 13:17:11 -07004801 } catch (RemoteException e) {
Jeff Sharkeyc78f85c2016-03-01 19:27:23 -07004802 throw e.rethrowFromSystemServer();
Stuart Scott0f835ac2015-03-30 13:17:11 -07004803 }
4804 }
4805
4806 /**
Paul Jensen8cdda642014-05-29 10:12:39 -04004807 * Binds the current process to {@code network}. All Sockets created in the future
4808 * (and not explicitly bound via a bound SocketFactory from
4809 * {@link Network#getSocketFactory() Network.getSocketFactory()}) will be bound to
4810 * {@code network}. All host name resolutions will be limited to {@code network} as well.
4811 * Note that if {@code network} ever disconnects, all Sockets created in this way will cease to
4812 * work and all host name resolutions will fail. This is by design so an application doesn't
4813 * accidentally use Sockets it thinks are still bound to a particular {@link Network}.
4814 * To clear binding pass {@code null} for {@code network}. Using individually bound
4815 * Sockets created by Network.getSocketFactory().createSocket() and
4816 * performing network-specific host name resolutions via
4817 * {@link Network#getAllByName Network.getAllByName} is preferred to calling
Paul Jensenee2f45d2015-03-10 10:54:12 -04004818 * {@code bindProcessToNetwork}.
Paul Jensen8cdda642014-05-29 10:12:39 -04004819 *
4820 * @param network The {@link Network} to bind the current process to, or {@code null} to clear
4821 * the current binding.
4822 * @return {@code true} on success, {@code false} if the {@link Network} is no longer valid.
4823 */
Chalard Jean158702d2019-01-07 19:26:34 +09004824 public boolean bindProcessToNetwork(@Nullable Network network) {
Chalard Jean9dd11612018-06-04 16:52:49 +09004825 // Forcing callers to call through non-static function ensures ConnectivityManager
Paul Jensenee2f45d2015-03-10 10:54:12 -04004826 // instantiated.
4827 return setProcessDefaultNetwork(network);
4828 }
4829
4830 /**
4831 * Binds the current process to {@code network}. All Sockets created in the future
4832 * (and not explicitly bound via a bound SocketFactory from
4833 * {@link Network#getSocketFactory() Network.getSocketFactory()}) will be bound to
4834 * {@code network}. All host name resolutions will be limited to {@code network} as well.
4835 * Note that if {@code network} ever disconnects, all Sockets created in this way will cease to
4836 * work and all host name resolutions will fail. This is by design so an application doesn't
4837 * accidentally use Sockets it thinks are still bound to a particular {@link Network}.
4838 * To clear binding pass {@code null} for {@code network}. Using individually bound
4839 * Sockets created by Network.getSocketFactory().createSocket() and
4840 * performing network-specific host name resolutions via
4841 * {@link Network#getAllByName Network.getAllByName} is preferred to calling
4842 * {@code setProcessDefaultNetwork}.
4843 *
4844 * @param network The {@link Network} to bind the current process to, or {@code null} to clear
4845 * the current binding.
4846 * @return {@code true} on success, {@code false} if the {@link Network} is no longer valid.
4847 * @deprecated This function can throw {@link IllegalStateException}. Use
4848 * {@link #bindProcessToNetwork} instead. {@code bindProcessToNetwork}
4849 * is a direct replacement.
4850 */
Aurimas Liutikase80a0eb2016-05-24 15:22:55 -07004851 @Deprecated
Chalard Jean158702d2019-01-07 19:26:34 +09004852 public static boolean setProcessDefaultNetwork(@Nullable Network network) {
Paul Jensen3e2917c2014-08-27 12:38:45 -04004853 int netId = (network == null) ? NETID_UNSET : network.netId;
Lorenzo Colitti3c766eb2019-01-31 13:08:24 +09004854 boolean isSameNetId = (netId == NetworkUtils.getBoundNetworkForProcess());
4855
Lorenzo Colitti3a1cb9d2019-01-30 23:04:54 +09004856 if (netId != NETID_UNSET) {
4857 netId = network.getNetIdForResolv();
Paul Jensen3e2917c2014-08-27 12:38:45 -04004858 }
Lorenzo Colitti3c766eb2019-01-31 13:08:24 +09004859
4860 if (!NetworkUtils.bindProcessToNetwork(netId)) {
4861 return false;
4862 }
4863
4864 if (!isSameNetId) {
Paul Jensenc0618a62014-12-10 15:12:18 -05004865 // Set HTTP proxy system properties to match network.
4866 // TODO: Deprecate this static method and replace it with a non-static version.
Lorenzo Colitti41b1fbc2015-04-22 11:52:48 +09004867 try {
Remi NGUYEN VANb33335c2021-02-03 10:18:20 +09004868 Proxy.setHttpProxyConfiguration(getInstance().getDefaultProxy());
Lorenzo Colitti41b1fbc2015-04-22 11:52:48 +09004869 } catch (SecurityException e) {
4870 // The process doesn't have ACCESS_NETWORK_STATE, so we can't fetch the proxy.
4871 Log.e(TAG, "Can't set proxy properties", e);
4872 }
Paul Jensen3e2917c2014-08-27 12:38:45 -04004873 // Must flush DNS cache as new network may have different DNS resolutions.
Remi NGUYEN VANe1b04f62021-03-18 23:27:19 +09004874 InetAddressCompat.clearDnsCache();
Paul Jensen3e2917c2014-08-27 12:38:45 -04004875 // Must flush socket pool as idle sockets will be bound to previous network and may
4876 // cause subsequent fetches to be performed on old network.
4877 NetworkEventDispatcher.getInstance().onNetworkConfigurationChanged();
Paul Jensen3e2917c2014-08-27 12:38:45 -04004878 }
Lorenzo Colitti3c766eb2019-01-31 13:08:24 +09004879
4880 return true;
Paul Jensen8cdda642014-05-29 10:12:39 -04004881 }
4882
4883 /**
4884 * Returns the {@link Network} currently bound to this process via
Paul Jensenee2f45d2015-03-10 10:54:12 -04004885 * {@link #bindProcessToNetwork}, or {@code null} if no {@link Network} is explicitly bound.
Paul Jensen8cdda642014-05-29 10:12:39 -04004886 *
4887 * @return {@code Network} to which this process is bound, or {@code null}.
4888 */
Chalard Jean158702d2019-01-07 19:26:34 +09004889 @Nullable
Paul Jensenee2f45d2015-03-10 10:54:12 -04004890 public Network getBoundNetworkForProcess() {
4891 // Forcing callers to call thru non-static function ensures ConnectivityManager
4892 // instantiated.
4893 return getProcessDefaultNetwork();
4894 }
4895
4896 /**
4897 * Returns the {@link Network} currently bound to this process via
4898 * {@link #bindProcessToNetwork}, or {@code null} if no {@link Network} is explicitly bound.
4899 *
4900 * @return {@code Network} to which this process is bound, or {@code null}.
4901 * @deprecated Using this function can lead to other functions throwing
4902 * {@link IllegalStateException}. Use {@link #getBoundNetworkForProcess} instead.
4903 * {@code getBoundNetworkForProcess} is a direct replacement.
4904 */
Aurimas Liutikase80a0eb2016-05-24 15:22:55 -07004905 @Deprecated
Chalard Jean158702d2019-01-07 19:26:34 +09004906 @Nullable
Paul Jensen8cdda642014-05-29 10:12:39 -04004907 public static Network getProcessDefaultNetwork() {
Paul Jensenee2f45d2015-03-10 10:54:12 -04004908 int netId = NetworkUtils.getBoundNetworkForProcess();
Paul Jensen65743a22014-07-11 08:17:29 -04004909 if (netId == NETID_UNSET) return null;
Paul Jensen8cdda642014-05-29 10:12:39 -04004910 return new Network(netId);
4911 }
4912
Lorenzo Colitti2780e4b2015-07-29 11:41:21 +09004913 private void unsupportedStartingFrom(int version) {
4914 if (Process.myUid() == Process.SYSTEM_UID) {
Lorenzo Colitti23862912018-09-28 11:31:55 +09004915 // The getApplicationInfo() call we make below is not supported in system context. Let
4916 // the call through here, and rely on the fact that ConnectivityService will refuse to
4917 // allow the system to use these APIs anyway.
Lorenzo Colitti2780e4b2015-07-29 11:41:21 +09004918 return;
4919 }
4920
4921 if (mContext.getApplicationInfo().targetSdkVersion >= version) {
4922 throw new UnsupportedOperationException(
4923 "This method is not supported in target SDK version " + version + " and above");
4924 }
4925 }
4926
4927 // Checks whether the calling app can use the legacy routing API (startUsingNetworkFeature,
4928 // stopUsingNetworkFeature, requestRouteToHost), and if not throw UnsupportedOperationException.
Lifu Tang0a922fd2016-01-07 23:20:38 -08004929 // TODO: convert the existing system users (Tethering, GnssLocationProvider) to the new APIs and
Lorenzo Colitti2780e4b2015-07-29 11:41:21 +09004930 // remove these exemptions. Note that this check is not secure, and apps can still access these
4931 // functions by accessing ConnectivityService directly. However, it should be clear that doing
4932 // so is unsupported and may break in the future. http://b/22728205
4933 private void checkLegacyRoutingApiAccess() {
Dianne Hackborn18c1d832015-07-31 10:35:34 -07004934 unsupportedStartingFrom(VERSION_CODES.M);
Lorenzo Colitti2780e4b2015-07-29 11:41:21 +09004935 }
4936
Paul Jensen8cdda642014-05-29 10:12:39 -04004937 /**
4938 * Binds host resolutions performed by this process to {@code network}.
Paul Jensenee2f45d2015-03-10 10:54:12 -04004939 * {@link #bindProcessToNetwork} takes precedence over this setting.
Paul Jensen8cdda642014-05-29 10:12:39 -04004940 *
4941 * @param network The {@link Network} to bind host resolutions from the current process to, or
4942 * {@code null} to clear the current binding.
4943 * @return {@code true} on success, {@code false} if the {@link Network} is no longer valid.
4944 * @hide
4945 * @deprecated This is strictly for legacy usage to support {@link #startUsingNetworkFeature}.
4946 */
Aurimas Liutikase80a0eb2016-05-24 15:22:55 -07004947 @Deprecated
Mathew Inwoode1a17ba2020-11-04 09:29:36 +00004948 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
Paul Jensen8cdda642014-05-29 10:12:39 -04004949 public static boolean setProcessDefaultNetworkForHostResolution(Network network) {
Paul Jensen65743a22014-07-11 08:17:29 -04004950 return NetworkUtils.bindProcessToNetworkForHostResolution(
Erik Kline767b7f22018-04-27 22:48:33 +09004951 (network == null) ? NETID_UNSET : network.getNetIdForResolv());
Paul Jensen8cdda642014-05-29 10:12:39 -04004952 }
Felipe Leme30511352016-01-22 09:44:57 -08004953
4954 /**
4955 * Device is not restricting metered network activity while application is running on
4956 * background.
4957 */
4958 public static final int RESTRICT_BACKGROUND_STATUS_DISABLED = 1;
4959
4960 /**
4961 * Device is restricting metered network activity while application is running on background,
4962 * but application is allowed to bypass it.
4963 * <p>
4964 * In this state, application should take action to mitigate metered network access.
4965 * For example, a music streaming application should switch to a low-bandwidth bitrate.
4966 */
4967 public static final int RESTRICT_BACKGROUND_STATUS_WHITELISTED = 2;
4968
4969 /**
4970 * Device is restricting metered network activity while application is running on background.
Felipe Lemed34c9af2016-01-27 14:46:39 -08004971 * <p>
Felipe Leme30511352016-01-22 09:44:57 -08004972 * In this state, application should not try to use the network while running on background,
4973 * because it would be denied.
4974 */
4975 public static final int RESTRICT_BACKGROUND_STATUS_ENABLED = 3;
4976
Felipe Lemed34c9af2016-01-27 14:46:39 -08004977 /**
4978 * A change in the background metered network activity restriction has occurred.
4979 * <p>
4980 * Applications should call {@link #getRestrictBackgroundStatus()} to check if the restriction
4981 * applies to them.
4982 * <p>
4983 * This is only sent to registered receivers, not manifest receivers.
4984 */
4985 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
4986 public static final String ACTION_RESTRICT_BACKGROUND_CHANGED =
4987 "android.net.conn.RESTRICT_BACKGROUND_CHANGED";
4988
Felipe Leme7e4c1852016-01-25 11:48:04 -08004989 /** @hide */
4990 @Retention(RetentionPolicy.SOURCE)
Felipe Leme30511352016-01-22 09:44:57 -08004991 @IntDef(flag = false, value = {
4992 RESTRICT_BACKGROUND_STATUS_DISABLED,
4993 RESTRICT_BACKGROUND_STATUS_WHITELISTED,
4994 RESTRICT_BACKGROUND_STATUS_ENABLED,
4995 })
Felipe Leme30511352016-01-22 09:44:57 -08004996 public @interface RestrictBackgroundStatus {
4997 }
4998
Felipe Leme30511352016-01-22 09:44:57 -08004999 /**
5000 * Determines if the calling application is subject to metered network restrictions while
5001 * running on background.
Felipe Leme3edc6162016-05-16 13:57:19 -07005002 *
5003 * @return {@link #RESTRICT_BACKGROUND_STATUS_DISABLED},
5004 * {@link #RESTRICT_BACKGROUND_STATUS_ENABLED},
5005 * or {@link #RESTRICT_BACKGROUND_STATUS_WHITELISTED}
Felipe Leme30511352016-01-22 09:44:57 -08005006 */
5007 public @RestrictBackgroundStatus int getRestrictBackgroundStatus() {
5008 try {
Remi NGUYEN VANe2139a02021-03-18 14:23:12 +09005009 return mService.getRestrictBackgroundStatusByCaller();
Felipe Leme30511352016-01-22 09:44:57 -08005010 } catch (RemoteException e) {
Jeff Sharkeyc78f85c2016-03-01 19:27:23 -07005011 throw e.rethrowFromSystemServer();
Felipe Leme30511352016-01-22 09:44:57 -08005012 }
5013 }
Ricky Wai7097cc92018-01-23 04:09:45 +00005014
5015 /**
5016 * The network watchlist is a list of domains and IP addresses that are associated with
Ricky Wai04baf112018-03-20 14:20:54 +00005017 * potentially harmful apps. This method returns the SHA-256 of the watchlist config file
5018 * currently used by the system for validation purposes.
Ricky Wai7097cc92018-01-23 04:09:45 +00005019 *
5020 * @return Hash of network watchlist config file. Null if config does not exist.
5021 */
Chalard Jean158702d2019-01-07 19:26:34 +09005022 @Nullable
Ricky Wai7097cc92018-01-23 04:09:45 +00005023 public byte[] getNetworkWatchlistConfigHash() {
5024 try {
5025 return mService.getNetworkWatchlistConfigHash();
5026 } catch (RemoteException e) {
5027 Log.e(TAG, "Unable to get watchlist config hash");
5028 throw e.rethrowFromSystemServer();
5029 }
5030 }
Jeff Vander Stoep39a51e02018-07-23 10:57:53 -07005031
5032 /**
5033 * Returns the {@code uid} of the owner of a network connection.
5034 *
Benedict Wong0bd4bba2020-01-20 22:14:59 -08005035 * @param protocol The protocol of the connection. Only {@code IPPROTO_TCP} and {@code
5036 * IPPROTO_UDP} currently supported.
Jeff Vander Stoep39a51e02018-07-23 10:57:53 -07005037 * @param local The local {@link InetSocketAddress} of a connection.
5038 * @param remote The remote {@link InetSocketAddress} of a connection.
Jeff Vander Stoep39a51e02018-07-23 10:57:53 -07005039 * @return {@code uid} if the connection is found and the app has permission to observe it
Benedict Wong0bd4bba2020-01-20 22:14:59 -08005040 * (e.g., if it is associated with the calling VPN app's VpnService tunnel) or {@link
5041 * android.os.Process#INVALID_UID} if the connection is not found.
5042 * @throws {@link SecurityException} if the caller is not the active VpnService for the current
5043 * user.
5044 * @throws {@link IllegalArgumentException} if an unsupported protocol is requested.
Jeff Vander Stoep39a51e02018-07-23 10:57:53 -07005045 */
Benedict Wong0bd4bba2020-01-20 22:14:59 -08005046 public int getConnectionOwnerUid(
5047 int protocol, @NonNull InetSocketAddress local, @NonNull InetSocketAddress remote) {
Jeff Vander Stoep39a51e02018-07-23 10:57:53 -07005048 ConnectionInfo connectionInfo = new ConnectionInfo(protocol, local, remote);
5049 try {
5050 return mService.getConnectionOwnerUid(connectionInfo);
5051 } catch (RemoteException e) {
5052 throw e.rethrowFromSystemServer();
5053 }
5054 }
Soi, Yoshinarib8102ef2015-11-12 12:09:02 +09005055
5056 private void printStackTrace() {
5057 if (DEBUG) {
5058 final StackTraceElement[] callStack = Thread.currentThread().getStackTrace();
5059 final StringBuffer sb = new StringBuffer();
5060 for (int i = 3; i < callStack.length; i++) {
5061 final String stackTrace = callStack[i].toString();
5062 if (stackTrace == null || stackTrace.contains("android.os")) {
5063 break;
5064 }
5065 sb.append(" [").append(stackTrace).append("]");
5066 }
5067 Log.d(TAG, "StackLog:" + sb.toString());
5068 }
5069 }
Cody Kestingf53a0752020-04-15 12:33:28 -07005070
Remi NGUYEN VAN5f406422021-01-15 23:02:47 +09005071 /** @hide */
5072 public TestNetworkManager startOrGetTestNetworkManager() {
5073 final IBinder tnBinder;
5074 try {
5075 tnBinder = mService.startOrGetTestNetworkService();
5076 } catch (RemoteException e) {
5077 throw e.rethrowFromSystemServer();
5078 }
5079
5080 return new TestNetworkManager(ITestNetworkManager.Stub.asInterface(tnBinder));
5081 }
5082
Remi NGUYEN VAN5f406422021-01-15 23:02:47 +09005083 /** @hide */
5084 public ConnectivityDiagnosticsManager createDiagnosticsManager() {
5085 return new ConnectivityDiagnosticsManager(mContext, mService);
5086 }
5087
Cody Kestingf53a0752020-04-15 12:33:28 -07005088 /**
5089 * Simulates a Data Stall for the specified Network.
5090 *
Remi NGUYEN VAN761c7ad2021-01-12 18:40:04 +09005091 * <p>This method should only be used for tests.
5092 *
Cody Kestingf53a0752020-04-15 12:33:28 -07005093 * <p>The caller must be the owner of the specified Network.
5094 *
5095 * @param detectionMethod The detection method used to identify the Data Stall.
5096 * @param timestampMillis The timestamp at which the stall 'occurred', in milliseconds.
5097 * @param network The Network for which a Data Stall is being simluated.
5098 * @param extras The PersistableBundle of extras included in the Data Stall notification.
5099 * @throws SecurityException if the caller is not the owner of the given network.
5100 * @hide
5101 */
Remi NGUYEN VAN761c7ad2021-01-12 18:40:04 +09005102 @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
Cody Kestingf53a0752020-04-15 12:33:28 -07005103 @RequiresPermission(anyOf = {android.Manifest.permission.MANAGE_TEST_NETWORKS,
5104 android.Manifest.permission.NETWORK_STACK})
5105 public void simulateDataStall(int detectionMethod, long timestampMillis,
5106 @NonNull Network network, @NonNull PersistableBundle extras) {
5107 try {
5108 mService.simulateDataStall(detectionMethod, timestampMillis, network, extras);
5109 } catch (RemoteException e) {
5110 e.rethrowFromSystemServer();
5111 }
5112 }
James Mattis356a8792020-10-28 21:48:54 -07005113
Daniel Brightf9e945b2020-06-15 16:10:01 -07005114 @NonNull
5115 private final List<QosCallbackConnection> mQosCallbackConnections = new ArrayList<>();
5116
5117 /**
5118 * Registers a {@link QosSocketInfo} with an associated {@link QosCallback}. The callback will
5119 * receive available QoS events related to the {@link Network} and local ip + port
5120 * specified within socketInfo.
5121 * <p/>
5122 * The same {@link QosCallback} must be unregistered before being registered a second time,
5123 * otherwise {@link QosCallbackRegistrationException} is thrown.
5124 * <p/>
5125 * This API does not, in itself, require any permission if called with a network that is not
5126 * restricted. However, the underlying implementation currently only supports the IMS network,
5127 * which is always restricted. That means non-preinstalled callers can't possibly find this API
5128 * useful, because they'd never be called back on networks that they would have access to.
5129 *
5130 * @throws SecurityException if {@link QosSocketInfo#getNetwork()} is restricted and the app is
5131 * missing CONNECTIVITY_USE_RESTRICTED_NETWORKS permission.
5132 * @throws QosCallback.QosCallbackRegistrationException if qosCallback is already registered.
5133 * @throws RuntimeException if the app already has too many callbacks registered.
5134 *
5135 * Exceptions after the time of registration is passed through
5136 * {@link QosCallback#onError(QosCallbackException)}. see: {@link QosCallbackException}.
5137 *
5138 * @param socketInfo the socket information used to match QoS events
Daniel Brightf9e945b2020-06-15 16:10:01 -07005139 * @param executor The executor on which the callback will be invoked. The provided
5140 * {@link Executor} must run callback sequentially, otherwise the order of
Daniel Bright7ee5f522021-03-10 11:51:50 -08005141 * callbacks cannot be guaranteed.onQosCallbackRegistered
5142 * @param callback receives qos events that satisfy socketInfo
Daniel Brightf9e945b2020-06-15 16:10:01 -07005143 *
5144 * @hide
5145 */
5146 @SystemApi
5147 public void registerQosCallback(@NonNull final QosSocketInfo socketInfo,
Daniel Bright7ee5f522021-03-10 11:51:50 -08005148 @CallbackExecutor @NonNull final Executor executor,
5149 @NonNull final QosCallback callback) {
Daniel Brightf9e945b2020-06-15 16:10:01 -07005150 Objects.requireNonNull(socketInfo, "socketInfo must be non-null");
Daniel Brightf9e945b2020-06-15 16:10:01 -07005151 Objects.requireNonNull(executor, "executor must be non-null");
Daniel Bright7ee5f522021-03-10 11:51:50 -08005152 Objects.requireNonNull(callback, "callback must be non-null");
Daniel Brightf9e945b2020-06-15 16:10:01 -07005153
5154 try {
5155 synchronized (mQosCallbackConnections) {
5156 if (getQosCallbackConnection(callback) == null) {
5157 final QosCallbackConnection connection =
5158 new QosCallbackConnection(this, callback, executor);
5159 mQosCallbackConnections.add(connection);
5160 mService.registerQosSocketCallback(socketInfo, connection);
5161 } else {
5162 Log.e(TAG, "registerQosCallback: Callback already registered");
5163 throw new QosCallbackRegistrationException();
5164 }
5165 }
5166 } catch (final RemoteException e) {
5167 Log.e(TAG, "registerQosCallback: Error while registering ", e);
5168
5169 // The same unregister method method is called for consistency even though nothing
5170 // will be sent to the ConnectivityService since the callback was never successfully
5171 // registered.
5172 unregisterQosCallback(callback);
5173 e.rethrowFromSystemServer();
5174 } catch (final ServiceSpecificException e) {
5175 Log.e(TAG, "registerQosCallback: Error while registering ", e);
5176 unregisterQosCallback(callback);
5177 throw convertServiceException(e);
5178 }
5179 }
5180
5181 /**
5182 * Unregisters the given {@link QosCallback}. The {@link QosCallback} will no longer receive
5183 * events once unregistered and can be registered a second time.
5184 * <p/>
5185 * If the {@link QosCallback} does not have an active registration, it is a no-op.
5186 *
5187 * @param callback the callback being unregistered
5188 *
5189 * @hide
5190 */
5191 @SystemApi
5192 public void unregisterQosCallback(@NonNull final QosCallback callback) {
5193 Objects.requireNonNull(callback, "The callback must be non-null");
5194 try {
5195 synchronized (mQosCallbackConnections) {
5196 final QosCallbackConnection connection = getQosCallbackConnection(callback);
5197 if (connection != null) {
5198 connection.stopReceivingMessages();
5199 mService.unregisterQosCallback(connection);
5200 mQosCallbackConnections.remove(connection);
5201 } else {
5202 Log.d(TAG, "unregisterQosCallback: Callback not registered");
5203 }
5204 }
5205 } catch (final RemoteException e) {
5206 Log.e(TAG, "unregisterQosCallback: Error while unregistering ", e);
5207 e.rethrowFromSystemServer();
5208 }
5209 }
5210
5211 /**
5212 * Gets the connection related to the callback.
5213 *
5214 * @param callback the callback to look up
5215 * @return the related connection
5216 */
5217 @Nullable
5218 private QosCallbackConnection getQosCallbackConnection(final QosCallback callback) {
5219 for (final QosCallbackConnection connection : mQosCallbackConnections) {
5220 // Checking by reference here is intentional
5221 if (connection.getCallback() == callback) {
5222 return connection;
5223 }
5224 }
5225 return null;
5226 }
Junyu Laia62493f2021-01-19 11:10:56 +00005227
5228 /**
Roshan Pius951c0032020-12-22 15:10:42 -08005229 * Request a network to satisfy a set of {@link NetworkCapabilities}, but
Junyu Laia62493f2021-01-19 11:10:56 +00005230 * does not cause any networks to retain the NET_CAPABILITY_FOREGROUND capability. This can
5231 * be used to request that the system provide a network without causing the network to be
5232 * in the foreground.
5233 *
5234 * <p>This method will attempt to find the best network that matches the passed
5235 * {@link NetworkRequest}, and to bring up one that does if none currently satisfies the
5236 * criteria. The platform will evaluate which network is the best at its own discretion.
5237 * Throughput, latency, cost per byte, policy, user preference and other considerations
5238 * may be factored in the decision of what is considered the best network.
5239 *
5240 * <p>As long as this request is outstanding, the platform will try to maintain the best network
5241 * matching this request, while always attempting to match the request to a better network if
5242 * possible. If a better match is found, the platform will switch this request to the now-best
5243 * network and inform the app of the newly best network by invoking
5244 * {@link NetworkCallback#onAvailable(Network)} on the provided callback. Note that the platform
5245 * will not try to maintain any other network than the best one currently matching the request:
5246 * a network not matching any network request may be disconnected at any time.
5247 *
5248 * <p>For example, an application could use this method to obtain a connected cellular network
5249 * even if the device currently has a data connection over Ethernet. This may cause the cellular
5250 * radio to consume additional power. Or, an application could inform the system that it wants
5251 * a network supporting sending MMSes and have the system let it know about the currently best
5252 * MMS-supporting network through the provided {@link NetworkCallback}.
5253 *
5254 * <p>The status of the request can be followed by listening to the various callbacks described
5255 * in {@link NetworkCallback}. The {@link Network} object passed to the callback methods can be
5256 * used to direct traffic to the network (although accessing some networks may be subject to
5257 * holding specific permissions). Callers will learn about the specific characteristics of the
5258 * network through
5259 * {@link NetworkCallback#onCapabilitiesChanged(Network, NetworkCapabilities)} and
5260 * {@link NetworkCallback#onLinkPropertiesChanged(Network, LinkProperties)}. The methods of the
5261 * provided {@link NetworkCallback} will only be invoked due to changes in the best network
5262 * matching the request at any given time; therefore when a better network matching the request
5263 * becomes available, the {@link NetworkCallback#onAvailable(Network)} method is called
5264 * with the new network after which no further updates are given about the previously-best
5265 * network, unless it becomes the best again at some later time. All callbacks are invoked
5266 * in order on the same thread, which by default is a thread created by the framework running
5267 * in the app.
5268 *
5269 * <p>This{@link NetworkRequest} will live until released via
5270 * {@link #unregisterNetworkCallback(NetworkCallback)} or the calling application exits, at
5271 * which point the system may let go of the network at any time.
5272 *
5273 * <p>It is presently unsupported to request a network with mutable
5274 * {@link NetworkCapabilities} such as
5275 * {@link NetworkCapabilities#NET_CAPABILITY_VALIDATED} or
5276 * {@link NetworkCapabilities#NET_CAPABILITY_CAPTIVE_PORTAL}
5277 * as these {@code NetworkCapabilities} represent states that a particular
5278 * network may never attain, and whether a network will attain these states
5279 * is unknown prior to bringing up the network so the framework does not
5280 * know how to go about satisfying a request with these capabilities.
5281 *
5282 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
5283 * number of outstanding requests to 100 per app (identified by their UID), shared with
5284 * all variants of this method, of {@link #registerNetworkCallback} as well as
5285 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
5286 * Requesting a network with this method will count toward this limit. If this limit is
5287 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
5288 * make sure to unregister the callbacks with
5289 * {@link #unregisterNetworkCallback(NetworkCallback)}.
5290 *
5291 * @param request {@link NetworkRequest} describing this request.
5292 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
5293 * If null, the callback is invoked on the default internal Handler.
5294 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
5295 * the callback must not be shared - it uniquely specifies this request.
5296 * @throws IllegalArgumentException if {@code request} contains invalid network capabilities.
5297 * @throws SecurityException if missing the appropriate permissions.
5298 * @throws RuntimeException if the app already has too many callbacks registered.
5299 *
5300 * @hide
5301 */
5302 @SystemApi(client = MODULE_LIBRARIES)
5303 @SuppressLint("ExecutorRegistration")
5304 @RequiresPermission(anyOf = {
5305 android.Manifest.permission.NETWORK_SETTINGS,
5306 android.Manifest.permission.NETWORK_STACK,
5307 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK
5308 })
5309 public void requestBackgroundNetwork(@NonNull NetworkRequest request,
junyulai962bdb82021-03-09 20:49:48 +08005310 @NonNull Handler handler, @NonNull NetworkCallback networkCallback) {
Junyu Laia62493f2021-01-19 11:10:56 +00005311 final NetworkCapabilities nc = request.networkCapabilities;
5312 sendRequestForNetwork(nc, networkCallback, 0, BACKGROUND_REQUEST,
junyulai962bdb82021-03-09 20:49:48 +08005313 TYPE_NONE, new CallbackHandler(handler));
Junyu Laia62493f2021-01-19 11:10:56 +00005314 }
James Mattis45d81842021-01-10 14:24:24 -08005315
5316 /**
James Mattis45d81842021-01-10 14:24:24 -08005317 * Used by automotive devices to set the network preferences used to direct traffic at an
5318 * application level as per the given OemNetworkPreferences. An example use-case would be an
5319 * automotive OEM wanting to provide connectivity for applications critical to the usage of a
5320 * vehicle via a particular network.
5321 *
5322 * Calling this will overwrite the existing preference.
5323 *
5324 * @param preference {@link OemNetworkPreferences} The application network preference to be set.
5325 * @param executor the executor on which listener will be invoked.
5326 * @param listener {@link OnSetOemNetworkPreferenceListener} optional listener used to
5327 * communicate completion of setOemNetworkPreference(). This will only be
5328 * called once upon successful completion of setOemNetworkPreference().
5329 * @throws IllegalArgumentException if {@code preference} contains invalid preference values.
5330 * @throws SecurityException if missing the appropriate permissions.
5331 * @throws UnsupportedOperationException if called on a non-automotive device.
James Mattisda32cfe2021-01-26 16:23:52 -08005332 * @hide
James Mattis45d81842021-01-10 14:24:24 -08005333 */
James Mattisda32cfe2021-01-26 16:23:52 -08005334 @SystemApi
James Mattis8378aec2021-01-26 14:05:36 -08005335 @RequiresPermission(android.Manifest.permission.CONTROL_OEM_PAID_NETWORK_PREFERENCE)
James Mattisda32cfe2021-01-26 16:23:52 -08005336 public void setOemNetworkPreference(@NonNull final OemNetworkPreferences preference,
James Mattis45d81842021-01-10 14:24:24 -08005337 @Nullable @CallbackExecutor final Executor executor,
Chalard Jean6010c002021-03-03 16:37:13 +09005338 @Nullable final Runnable listener) {
James Mattis45d81842021-01-10 14:24:24 -08005339 Objects.requireNonNull(preference, "OemNetworkPreferences must be non-null");
5340 if (null != listener) {
5341 Objects.requireNonNull(executor, "Executor must be non-null");
5342 }
Chalard Jean6010c002021-03-03 16:37:13 +09005343 final IOnCompleteListener listenerInternal = listener == null ? null :
5344 new IOnCompleteListener.Stub() {
James Mattis45d81842021-01-10 14:24:24 -08005345 @Override
5346 public void onComplete() {
Chalard Jean6010c002021-03-03 16:37:13 +09005347 executor.execute(listener::run);
James Mattis45d81842021-01-10 14:24:24 -08005348 }
5349 };
5350
5351 try {
5352 mService.setOemNetworkPreference(preference, listenerInternal);
5353 } catch (RemoteException e) {
5354 Log.e(TAG, "setOemNetworkPreference() failed for preference: " + preference.toString());
5355 throw e.rethrowFromSystemServer();
5356 }
5357 }
lucaslin30e70a82021-03-12 00:46:33 +08005358
Chalard Jeanfa45a682021-02-25 17:23:40 +09005359 /**
5360 * Request that a user profile is put by default on a network matching a given preference.
5361 *
5362 * See the documentation for the individual preferences for a description of the supported
5363 * behaviors.
5364 *
5365 * @param profile the profile concerned.
5366 * @param preference the preference for this profile.
5367 * @param executor an executor to execute the listener on. Optional if listener is null.
5368 * @param listener an optional listener to listen for completion of the operation.
5369 * @throws IllegalArgumentException if {@code profile} is not a valid user profile.
5370 * @throws SecurityException if missing the appropriate permissions.
5371 * @hide
5372 */
Chalard Jean6010c002021-03-03 16:37:13 +09005373 // This function is for establishing per-profile default networking and can only be called by
5374 // the device policy manager, running as the system server. It would make no sense to call it
5375 // on a context for a user because it does not establish a setting on behalf of a user, rather
5376 // it establishes a setting for a user on behalf of the DPM.
5377 @SuppressLint({"UserHandle"})
5378 @SystemApi(client = MODULE_LIBRARIES)
Chalard Jeanfa45a682021-02-25 17:23:40 +09005379 @RequiresPermission(android.Manifest.permission.NETWORK_STACK)
5380 public void setProfileNetworkPreference(@NonNull final UserHandle profile,
5381 @ProfileNetworkPreference final int preference,
5382 @Nullable @CallbackExecutor final Executor executor,
5383 @Nullable final Runnable listener) {
5384 if (null != listener) {
5385 Objects.requireNonNull(executor, "Pass a non-null executor, or a null listener");
5386 }
5387 final IOnCompleteListener proxy;
5388 if (null == listener) {
5389 proxy = null;
5390 } else {
5391 proxy = new IOnCompleteListener.Stub() {
5392 @Override
5393 public void onComplete() {
5394 executor.execute(listener::run);
5395 }
5396 };
5397 }
5398 try {
5399 mService.setProfileNetworkPreference(profile, preference, proxy);
5400 } catch (RemoteException e) {
5401 throw e.rethrowFromSystemServer();
5402 }
5403 }
5404
lucaslin30e70a82021-03-12 00:46:33 +08005405 // The first network ID of IPSec tunnel interface.
lucaslin0cdcea12021-03-15 17:24:12 +08005406 private static final int TUN_INTF_NETID_START = 0xFC00; // 0xFC00 = 64512
lucaslin30e70a82021-03-12 00:46:33 +08005407 // The network ID range of IPSec tunnel interface.
lucaslin0cdcea12021-03-15 17:24:12 +08005408 private static final int TUN_INTF_NETID_RANGE = 0x0400; // 0x0400 = 1024
lucaslin30e70a82021-03-12 00:46:33 +08005409
5410 /**
5411 * Get the network ID range reserved for IPSec tunnel interfaces.
5412 *
5413 * @return A Range which indicates the network ID range of IPSec tunnel interface.
5414 * @hide
5415 */
5416 @SystemApi(client = MODULE_LIBRARIES)
5417 @NonNull
5418 public static Range<Integer> getIpSecNetIdRange() {
5419 return new Range(TUN_INTF_NETID_START, TUN_INTF_NETID_START + TUN_INTF_NETID_RANGE - 1);
5420 }
lucaslin705c3332021-03-12 17:56:09 +08005421
5422 /**
5423 * Get private DNS mode from settings.
5424 *
lucaslin7abe7e02021-03-17 14:53:35 +08005425 * @param context The Context to query the private DNS mode from settings.
lucaslin705c3332021-03-12 17:56:09 +08005426 * @return A string of private DNS mode as one of the PRIVATE_DNS_MODE_* constants.
5427 *
5428 * @hide
5429 */
5430 @SystemApi(client = MODULE_LIBRARIES)
5431 @NonNull
5432 @PrivateDnsMode
lucaslin20f04882021-03-16 17:11:14 +08005433 public static String getPrivateDnsMode(@NonNull Context context) {
5434 final ContentResolver cr = context.getContentResolver();
lucaslin705c3332021-03-12 17:56:09 +08005435 String mode = Settings.Global.getString(cr, PRIVATE_DNS_MODE);
5436 if (TextUtils.isEmpty(mode)) mode = Settings.Global.getString(cr, PRIVATE_DNS_DEFAULT_MODE);
5437 // If both PRIVATE_DNS_MODE and PRIVATE_DNS_DEFAULT_MODE are not set, choose
5438 // PRIVATE_DNS_MODE_OPPORTUNISTIC as default mode.
5439 if (TextUtils.isEmpty(mode)) mode = PRIVATE_DNS_MODE_OPPORTUNISTIC;
5440 return mode;
5441 }
paulhu89a762a2021-03-25 12:36:56 +08005442
5443 /**
5444 * Set private DNS mode to settings.
5445 *
5446 * @param context The {@link Context} to set the private DNS mode.
5447 * @param mode The private dns mode. This should be one of the PRIVATE_DNS_MODE_* constants.
5448 *
5449 * @hide
5450 */
5451 @SystemApi(client = MODULE_LIBRARIES)
5452 public static void setPrivateDnsMode(@NonNull Context context,
5453 @NonNull @PrivateDnsMode String mode) {
5454 if (!(mode == PRIVATE_DNS_MODE_OFF
5455 || mode == PRIVATE_DNS_MODE_OPPORTUNISTIC
5456 || mode == PRIVATE_DNS_MODE_PROVIDER_HOSTNAME)) {
5457 throw new IllegalArgumentException("Invalid private dns mode");
5458 }
5459 Settings.Global.putString(context.getContentResolver(), PRIVATE_DNS_MODE, mode);
5460 }
The Android Open Source Project28527d22009-03-03 19:31:44 -08005461}