blob: a5e38fa976d145e4214e47114e0e114a1d9ecb48 [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 Lai23568a42021-01-19 11:10:56 +000018import static android.annotation.SystemApi.Client.MODULE_LIBRARIES;
paulhu79260c22021-03-17 20:30:33 +080019import static android.net.ConnectivitySettingsManager.PRIVATE_DNS_DEFAULT_MODE;
20import static android.net.ConnectivitySettingsManager.PRIVATE_DNS_MODE;
Junyu Lai23568a42021-01-19 11:10:56 +000021import static android.net.NetworkRequest.Type.BACKGROUND_REQUEST;
junyulaid1a78162021-01-11 16:53:38 +080022import static android.net.NetworkRequest.Type.LISTEN;
junyulai8cae3c72021-03-12 20:05:08 +080023import static android.net.NetworkRequest.Type.LISTEN_FOR_BEST;
junyulaid1a78162021-01-11 16:53:38 +080024import static android.net.NetworkRequest.Type.REQUEST;
25import static android.net.NetworkRequest.Type.TRACK_DEFAULT;
Lorenzo Colitti80b48bc2021-01-29 20:14:04 +090026import static android.net.NetworkRequest.Type.TRACK_SYSTEM_DEFAULT;
Daniel Bright60f02ed2020-06-15 16:10:01 -070027import static android.net.QosCallback.QosCallbackRegistrationException;
junyulai48a59382019-01-15 11:32:44 +080028
junyulaia86defc2018-12-27 17:25:29 +080029import android.annotation.CallbackExecutor;
Felipe Lemed16384b2016-01-22 09:44:57 -080030import android.annotation.IntDef;
Chalard Jean42a9c292019-01-07 19:26:34 +090031import android.annotation.NonNull;
Robin Lee33c73e22016-01-05 18:03:46 +000032import android.annotation.Nullable;
Jeff Sharkey2ac62992017-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;
lucaslin50205af2021-03-12 16:11:27 +080036import android.annotation.StringDef;
Junyu Lai23568a42021-01-19 11:10:56 +000037import android.annotation.SuppressLint;
Udam Saini53b71ee2016-01-04 12:16:14 -080038import android.annotation.SystemApi;
Jeff Sharkeyb8c73032017-06-02 17:36:26 -060039import android.annotation.SystemService;
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -070040import android.app.PendingIntent;
Artur Satayevb9ea02f2019-12-10 17:47:52 +000041import android.compat.annotation.UnsupportedAppUsage;
lucaslin50205af2021-03-12 16:11:27 +080042import android.content.ContentResolver;
Jeff Sharkey2d9e5a52012-04-04 20:40:58 -070043import android.content.Context;
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -070044import android.content.Intent;
junyulaia86defc2018-12-27 17:25:29 +080045import android.net.IpSecManager.UdpEncapsulationSocket;
46import android.net.SocketKeepalive.Callback;
markchien10ddd022020-01-20 19:31:56 +080047import android.net.TetheringManager.StartTetheringCallback;
markchien75721e42020-01-21 13:11:06 +080048import android.net.TetheringManager.TetheringEventCallback;
markchien10ddd022020-01-20 19:31:56 +080049import android.net.TetheringManager.TetheringRequest;
Roshan Pius7992afd2020-12-22 15:10:42 -080050import android.net.wifi.WifiNetworkSuggestion;
Robert Greenwalt2034b912009-08-12 16:08:25 -070051import android.os.Binder;
Mathew Inwoodac5968e2018-12-20 15:30:45 +000052import android.os.Build;
Jeff Sharkey39c01eb2011-08-16 14:37:57 -070053import android.os.Build.VERSION_CODES;
Jeremy Klein9a36ec82016-01-22 14:11:45 -080054import android.os.Bundle;
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -070055import android.os.Handler;
Dianne Hackbornb4b09e82014-02-26 16:20:52 -080056import android.os.IBinder;
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -070057import android.os.Looper;
58import android.os.Message;
Robert Greenwalt030e1d32012-08-21 19:27:00 -070059import android.os.Messenger;
junyulai61143782019-03-04 22:45:36 +080060import android.os.ParcelFileDescriptor;
Cody Kestingb5c7abd2020-04-15 12:33:28 -070061import android.os.PersistableBundle;
Lorenzo Colitti9b026fa2015-07-29 11:41:21 +090062import android.os.Process;
The Android Open Source Project28527d22009-03-03 19:31:44 -080063import android.os.RemoteException;
Jeremy Klein9a36ec82016-01-22 14:11:45 -080064import android.os.ResultReceiver;
Hugo Benichi145e3792017-05-11 13:16:17 +090065import android.os.ServiceSpecificException;
Chalard Jean03433052021-02-25 17:23:40 +090066import android.os.UserHandle;
Jeff Sharkey971cd162011-08-29 16:02:57 -070067import android.provider.Settings;
Wink Saville02eb35c2014-12-05 11:10:30 -080068import android.telephony.SubscriptionManager;
Meng Wang91311c02019-11-18 17:10:00 -080069import android.telephony.TelephonyManager;
lucaslin50205af2021-03-12 16:11:27 +080070import android.text.TextUtils;
Dianne Hackbornb4b09e82014-02-26 16:20:52 -080071import android.util.ArrayMap;
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -070072import android.util.Log;
Lorenzo Colittie8ce2052020-12-12 00:51:11 +090073import android.util.Range;
Erik Kline50068e52017-01-26 18:08:28 +090074import android.util.SparseIntArray;
The Android Open Source Project28527d22009-03-03 19:31:44 -080075
Remi NGUYEN VAN37ebfa82020-12-23 12:45:08 +090076import com.android.connectivity.aidl.INetworkAgent;
markchien75721e42020-01-21 13:11:06 +080077import com.android.internal.annotations.GuardedBy;
Remi NGUYEN VAN00c531f2021-03-15 07:27:44 +000078import com.android.internal.util.Preconditions;
Robert Greenwalt3d6c9582014-05-21 20:04:36 -070079
Paul Jensen99c36662014-08-27 12:38:45 -040080import libcore.net.event.NetworkEventDispatcher;
81
junyulai61143782019-03-04 22:45:36 +080082import java.io.IOException;
83import java.io.UncheckedIOException;
Felipe Lemed16384b2016-01-22 09:44:57 -080084import java.lang.annotation.Retention;
85import java.lang.annotation.RetentionPolicy;
Lorenzo Colittie8ce2052020-12-12 00:51:11 +090086import java.net.DatagramSocket;
Jeremy Klein04863332015-12-28 15:11:58 -080087import java.net.InetAddress;
Jeff Vander Stoepe7205d62018-07-23 10:57:53 -070088import java.net.InetSocketAddress;
junyulaic7ea1242019-01-08 20:04:33 +080089import java.net.Socket;
Hugo Benichi45a49542017-03-06 09:17:06 +090090import java.util.ArrayList;
Lorenzo Colittie8ce2052020-12-12 00:51:11 +090091import java.util.Collection;
Jeremy Klein04863332015-12-28 15:11:58 -080092import java.util.HashMap;
Hugo Benichi45a49542017-03-06 09:17:06 +090093import java.util.List;
94import java.util.Map;
markchien75721e42020-01-21 13:11:06 +080095import java.util.Objects;
junyulaia86defc2018-12-27 17:25:29 +080096import java.util.concurrent.Executor;
junyulai9f872232019-01-16 20:23:34 +080097import java.util.concurrent.ExecutorService;
98import java.util.concurrent.Executors;
99import java.util.concurrent.RejectedExecutionException;
Jeremy Klein04863332015-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 Sharkeyb8c73032017-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 Greenwaltd0ebdbb2014-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 Sharkeyb8c73032017-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, Yoshinari99efcbd2015-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 Greenwaltd0ebdbb2014-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 Lue1682a02016-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 Greenwalt26744a52013-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 Jeanae2424a2018-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 Sharkey6932ff62013-02-20 18:21:19 -0800157 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Chalard Jeanae2424a2018-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 Jensened4d55c2015-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 Jensen4173cce2015-05-22 10:50:39 -0400166 * desire to sign in to the network. Apps handling this activity should
Paul Jensened4d55c2015-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 Jensen4173cce2015-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 Jean73d9db72018-06-04 16:52:49 +0900181 * data network.</li>
Paul Jensen4173cce2015-05-22 10:50:39 -0400182 * <li> When the app handling this action believes the user explicitly wants
Paul Jensened4d55c2015-02-27 22:55:47 -0500183 * to ignore the captive portal and the network, the app should call
Paul Jensen4173cce2015-05-22 10:50:39 -0400184 * {@link CaptivePortal#ignoreNetwork}. </li>
185 * </ul>
Paul Jensened4d55c2015-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 Jeancc47b522019-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 Jeancc47b522019-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 Jeancc47b522019-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)}.
junyulai5c2f6262018-12-13 12:47:51 +0800218 *
219 * @deprecated See {@link NetworkInfo}.
The Android Open Source Project28527d22009-03-03 19:31:44 -0800220 */
junyulai5c2f6262018-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)}.
junyulai5c2f6262018-12-13 12:47:51 +0800227 *
228 * @deprecated See {@link NetworkInfo}.
The Android Open Source Project28527d22009-03-03 19:31:44 -0800229 */
junyulai5c2f6262018-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)}.
junyulai5c2f6262018-12-13 12:47:51 +0800251 *
252 * @deprecated See {@link NetworkInfo#getExtraInfo()}.
The Android Open Source Project28527d22009-03-03 19:31:44 -0800253 */
junyulai5c2f6262018-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 Jensen4173cce2015-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 Jensened4d55c2015-02-27 22:55:47 -0500271 */
Paul Jensen4173cce2015-05-22 10:50:39 -0400272 public static final String EXTRA_CAPTIVE_PORTAL = "android.net.extra.CAPTIVE_PORTAL";
Jan Nordqvist0f3b4442015-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 Jensened4d55c2015-02-27 22:55:47 -0500279 /**
Remi NGUYEN VANd937e3a2018-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 VANe541d182019-01-17 14:38:31 +0900284 @SystemApi
Remi NGUYEN VANd937e3a2018-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 Benichidce21c52016-12-14 08:23:40 +0900289 * Key for passing a user agent string to the captive portal login activity.
290 * {@hide}
291 */
Remi NGUYEN VANe541d182019-01-17 14:38:31 +0900292 @SystemApi
Hugo Benichidce21c52016-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 Greenwalt26744a52013-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 Jean73d9db72018-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 Sharma601fba92014-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 Sharkey6932ff62013-02-20 18:21:19 -0800354 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Mathew Inwood0b8f8612018-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 Greenwalt26744a52013-02-15 10:56:35 -0800360 * Broadcast Action: A tetherable connection has come or gone.
361 * Uses {@code ConnectivityManager.EXTRA_AVAILABLE_TETHER},
Erik Kline449ccfe2017-04-17 16:47:23 +0900362 * {@code ConnectivityManager.EXTRA_ACTIVE_LOCAL_ONLY},
363 * {@code ConnectivityManager.EXTRA_ACTIVE_TETHER}, and
Robert Greenwalt26744a52013-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 Sharkey6932ff62013-02-20 18:21:19 -0800369 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Mathew Inwoodd078d3d2020-10-27 11:47:29 +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 =
markchien1f523702019-12-25 19:40:32 +0800372 TetheringManager.ACTION_TETHER_STATE_CHANGED;
Robert Greenwalt0c4828c2010-01-26 11:40:34 -0800373
374 /**
375 * @hide
Robert Greenwalt26744a52013-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 Inwoodd078d3d2020-10-27 11:47:29 +0000379 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
markchien1f523702019-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 Kline449ccfe2017-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 */
markchien1f523702019-12-25 19:40:32 +0800387 public static final String EXTRA_ACTIVE_LOCAL_ONLY = TetheringManager.EXTRA_ACTIVE_LOCAL_ONLY;
Erik Kline449ccfe2017-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 Inwoodd078d3d2020-10-27 11:47:29 +0000394 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
markchien1f523702019-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 Greenwalt26744a52013-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 Inwoodd078d3d2020-10-27 11:47:29 +0000403 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
markchien1f523702019-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 Brenner4774b022013-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 Sharkey6932ff62013-02-20 18:21:19 -0800412 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Russell Brenner4774b022013-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 Colitti36fbebe2015-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 */
lucaslin1a0ca5f2021-03-04 17:09:51 +0800428 @SystemApi(client = MODULE_LIBRARIES)
429 public static final String ACTION_PROMPT_UNVALIDATED = "android.net.action.PROMPT_UNVALIDATED";
Lorenzo Colitti36fbebe2015-04-03 16:38:52 +0900430
431 /**
Lorenzo Colitti477bf5c2016-09-15 14:02:29 +0900432 * Action used to display a dialog that asks the user whether to avoid a network that is no
433 * longer validated. This intent is used to start the dialog in settings via startActivity.
434 *
435 * @hide
436 */
lucaslin1a0ca5f2021-03-04 17:09:51 +0800437 @SystemApi(client = MODULE_LIBRARIES)
Lorenzo Colitti477bf5c2016-09-15 14:02:29 +0900438 public static final String ACTION_PROMPT_LOST_VALIDATION =
lucaslin1a0ca5f2021-03-04 17:09:51 +0800439 "android.net.action.PROMPT_LOST_VALIDATION";
Lorenzo Colitti477bf5c2016-09-15 14:02:29 +0900440
441 /**
lucaslin25a50472019-03-12 13:08:03 +0800442 * Action used to display a dialog that asks the user whether to stay connected to a network
443 * that has not validated. This intent is used to start the dialog in settings via
444 * startActivity.
445 *
446 * @hide
447 */
lucaslin1a0ca5f2021-03-04 17:09:51 +0800448 @SystemApi(client = MODULE_LIBRARIES)
lucaslin25a50472019-03-12 13:08:03 +0800449 public static final String ACTION_PROMPT_PARTIAL_CONNECTIVITY =
lucaslin1a0ca5f2021-03-04 17:09:51 +0800450 "android.net.action.PROMPT_PARTIAL_CONNECTIVITY";
lucaslin25a50472019-03-12 13:08:03 +0800451
452 /**
Jeremy Klein9a36ec82016-01-22 14:11:45 -0800453 * Invalid tethering type.
Chalard Jean73d9db72018-06-04 16:52:49 +0900454 * @see #startTethering(int, boolean, OnStartTetheringCallback)
Jeremy Klein9a36ec82016-01-22 14:11:45 -0800455 * @hide
456 */
markchien1f523702019-12-25 19:40:32 +0800457 public static final int TETHERING_INVALID = TetheringManager.TETHERING_INVALID;
Jeremy Klein9a36ec82016-01-22 14:11:45 -0800458
459 /**
460 * Wifi tethering type.
Chalard Jean73d9db72018-06-04 16:52:49 +0900461 * @see #startTethering(int, boolean, OnStartTetheringCallback)
Jeremy Klein9a36ec82016-01-22 14:11:45 -0800462 * @hide
463 */
464 @SystemApi
Remi NGUYEN VAN23b853b2021-02-15 18:52:06 +0900465 public static final int TETHERING_WIFI = 0;
Jeremy Klein9a36ec82016-01-22 14:11:45 -0800466
467 /**
468 * USB tethering type.
Chalard Jean73d9db72018-06-04 16:52:49 +0900469 * @see #startTethering(int, boolean, OnStartTetheringCallback)
Jeremy Klein9a36ec82016-01-22 14:11:45 -0800470 * @hide
471 */
472 @SystemApi
Remi NGUYEN VAN23b853b2021-02-15 18:52:06 +0900473 public static final int TETHERING_USB = 1;
Jeremy Klein9a36ec82016-01-22 14:11:45 -0800474
475 /**
476 * Bluetooth tethering type.
Chalard Jean73d9db72018-06-04 16:52:49 +0900477 * @see #startTethering(int, boolean, OnStartTetheringCallback)
Jeremy Klein9a36ec82016-01-22 14:11:45 -0800478 * @hide
479 */
480 @SystemApi
Remi NGUYEN VAN23b853b2021-02-15 18:52:06 +0900481 public static final int TETHERING_BLUETOOTH = 2;
Jeremy Klein9a36ec82016-01-22 14:11:45 -0800482
483 /**
Jimmy Chen87db1542019-07-15 18:03:23 +0800484 * Wifi P2p tethering type.
485 * Wifi P2p tethering is set through events automatically, and don't
486 * need to start from #startTethering(int, boolean, OnStartTetheringCallback).
487 * @hide
488 */
markchien1f523702019-12-25 19:40:32 +0800489 public static final int TETHERING_WIFI_P2P = TetheringManager.TETHERING_WIFI_P2P;
Jimmy Chen87db1542019-07-15 18:03:23 +0800490
491 /**
Jeremy Klein9a36ec82016-01-22 14:11:45 -0800492 * Extra used for communicating with the TetherService. Includes the type of tethering to
493 * enable if any.
494 * @hide
495 */
markchien75721e42020-01-21 13:11:06 +0800496 public static final String EXTRA_ADD_TETHER_TYPE = TetheringConstants.EXTRA_ADD_TETHER_TYPE;
Jeremy Klein9a36ec82016-01-22 14:11:45 -0800497
498 /**
499 * Extra used for communicating with the TetherService. Includes the type of tethering for
500 * which to cancel provisioning.
501 * @hide
502 */
markchien75721e42020-01-21 13:11:06 +0800503 public static final String EXTRA_REM_TETHER_TYPE = TetheringConstants.EXTRA_REM_TETHER_TYPE;
Jeremy Klein9a36ec82016-01-22 14:11:45 -0800504
505 /**
506 * Extra used for communicating with the TetherService. True to schedule a recheck of tether
507 * provisioning.
508 * @hide
509 */
markchien75721e42020-01-21 13:11:06 +0800510 public static final String EXTRA_SET_ALARM = TetheringConstants.EXTRA_SET_ALARM;
Jeremy Klein9a36ec82016-01-22 14:11:45 -0800511
512 /**
513 * Tells the TetherService to run a provision check now.
514 * @hide
515 */
markchien75721e42020-01-21 13:11:06 +0800516 public static final String EXTRA_RUN_PROVISION = TetheringConstants.EXTRA_RUN_PROVISION;
Jeremy Klein9a36ec82016-01-22 14:11:45 -0800517
518 /**
519 * Extra used for communicating with the TetherService. Contains the {@link ResultReceiver}
520 * which will receive provisioning results. Can be left empty.
521 * @hide
522 */
markchien75721e42020-01-21 13:11:06 +0800523 public static final String EXTRA_PROVISION_CALLBACK =
524 TetheringConstants.EXTRA_PROVISION_CALLBACK;
Jeremy Klein9a36ec82016-01-22 14:11:45 -0800525
526 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -0800527 * The absence of a connection type.
Robert Greenwalt33cdcdf2011-06-02 17:30:47 -0700528 * @hide
529 */
paulhu62af6122020-01-13 16:46:45 +0800530 @SystemApi
Robert Greenwalt33cdcdf2011-06-02 17:30:47 -0700531 public static final int TYPE_NONE = -1;
532
533 /**
Chalard Jean5acb7b72018-03-08 13:54:53 +0900534 * A Mobile data connection. Devices may support more than one.
535 *
536 * @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or
537 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an
538 * appropriate network. {@see NetworkCapabilities} for supported transports.
Robert Greenwalt2034b912009-08-12 16:08:25 -0700539 */
Chalard Jean5acb7b72018-03-08 13:54:53 +0900540 @Deprecated
Robert Greenwalt2034b912009-08-12 16:08:25 -0700541 public static final int TYPE_MOBILE = 0;
Chalard Jean5acb7b72018-03-08 13:54:53 +0900542
Robert Greenwalt2034b912009-08-12 16:08:25 -0700543 /**
Chalard Jean5acb7b72018-03-08 13:54:53 +0900544 * A WIFI data connection. Devices may support more than one.
545 *
546 * @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or
547 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an
548 * appropriate network. {@see NetworkCapabilities} for supported transports.
Robert Greenwalt2034b912009-08-12 16:08:25 -0700549 */
Chalard Jean5acb7b72018-03-08 13:54:53 +0900550 @Deprecated
Robert Greenwalt2034b912009-08-12 16:08:25 -0700551 public static final int TYPE_WIFI = 1;
Chalard Jean5acb7b72018-03-08 13:54:53 +0900552
Robert Greenwalt2034b912009-08-12 16:08:25 -0700553 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -0800554 * An MMS-specific Mobile data connection. This network type may use the
555 * same network interface as {@link #TYPE_MOBILE} or it may use a different
556 * one. This is used by applications needing to talk to the carrier's
557 * Multimedia Messaging Service servers.
Lorenzo Colitti7cc32c52015-04-23 15:32:42 +0900558 *
Chalard Jean5acb7b72018-03-08 13:54:53 +0900559 * @deprecated Applications should instead use {@link NetworkCapabilities#hasCapability} or
Lorenzo Colittiefd396e2015-04-24 17:03:31 +0900560 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request a network that
Lorenzo Colitti7cc32c52015-04-23 15:32:42 +0900561 * provides the {@link NetworkCapabilities#NET_CAPABILITY_MMS} capability.
Robert Greenwalt2034b912009-08-12 16:08:25 -0700562 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -0700563 @Deprecated
Robert Greenwalt2034b912009-08-12 16:08:25 -0700564 public static final int TYPE_MOBILE_MMS = 2;
Chalard Jean5acb7b72018-03-08 13:54:53 +0900565
Robert Greenwalt2034b912009-08-12 16:08:25 -0700566 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -0800567 * A SUPL-specific Mobile data connection. This network type may use the
568 * same network interface as {@link #TYPE_MOBILE} or it may use a different
569 * one. This is used by applications needing to talk to the carrier's
570 * Secure User Plane Location servers for help locating the device.
Lorenzo Colitti7cc32c52015-04-23 15:32:42 +0900571 *
Chalard Jean5acb7b72018-03-08 13:54:53 +0900572 * @deprecated Applications should instead use {@link NetworkCapabilities#hasCapability} or
Lorenzo Colittiefd396e2015-04-24 17:03:31 +0900573 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request a network that
Lorenzo Colitti7cc32c52015-04-23 15:32:42 +0900574 * provides the {@link NetworkCapabilities#NET_CAPABILITY_SUPL} capability.
Robert Greenwalt2034b912009-08-12 16:08:25 -0700575 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -0700576 @Deprecated
Robert Greenwalt2034b912009-08-12 16:08:25 -0700577 public static final int TYPE_MOBILE_SUPL = 3;
Chalard Jean5acb7b72018-03-08 13:54:53 +0900578
Robert Greenwalt2034b912009-08-12 16:08:25 -0700579 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -0800580 * A DUN-specific Mobile data connection. This network type may use the
581 * same network interface as {@link #TYPE_MOBILE} or it may use a different
582 * one. This is sometimes by the system when setting up an upstream connection
583 * for tethering so that the carrier is aware of DUN traffic.
Chalard Jean5acb7b72018-03-08 13:54:53 +0900584 *
585 * @deprecated Applications should instead use {@link NetworkCapabilities#hasCapability} or
586 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request a network that
587 * provides the {@link NetworkCapabilities#NET_CAPABILITY_DUN} capability.
Robert Greenwalt2034b912009-08-12 16:08:25 -0700588 */
Chalard Jean5acb7b72018-03-08 13:54:53 +0900589 @Deprecated
Robert Greenwalt2034b912009-08-12 16:08:25 -0700590 public static final int TYPE_MOBILE_DUN = 4;
Chalard Jean5acb7b72018-03-08 13:54:53 +0900591
Robert Greenwalt2034b912009-08-12 16:08:25 -0700592 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -0800593 * A High Priority Mobile data connection. This network type uses the
594 * same network interface as {@link #TYPE_MOBILE} but the routing setup
Lorenzo Colitti7cc32c52015-04-23 15:32:42 +0900595 * is different.
596 *
Chalard Jean5acb7b72018-03-08 13:54:53 +0900597 * @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or
598 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an
599 * appropriate network. {@see NetworkCapabilities} for supported transports.
Robert Greenwalt2034b912009-08-12 16:08:25 -0700600 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -0700601 @Deprecated
Robert Greenwalt2034b912009-08-12 16:08:25 -0700602 public static final int TYPE_MOBILE_HIPRI = 5;
Chalard Jean5acb7b72018-03-08 13:54:53 +0900603
jshbfa81722010-03-11 15:04:43 -0800604 /**
Chalard Jean5acb7b72018-03-08 13:54:53 +0900605 * A WiMAX data connection.
606 *
607 * @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or
608 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an
609 * appropriate network. {@see NetworkCapabilities} for supported transports.
jshbfa81722010-03-11 15:04:43 -0800610 */
Chalard Jean5acb7b72018-03-08 13:54:53 +0900611 @Deprecated
jshbfa81722010-03-11 15:04:43 -0800612 public static final int TYPE_WIMAX = 6;
Robert Greenwalteb123ac2010-12-06 13:56:24 -0800613
Jaikumar Ganesh0db51a02010-12-21 22:31:44 -0800614 /**
Chalard Jean5acb7b72018-03-08 13:54:53 +0900615 * A Bluetooth data connection.
616 *
617 * @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or
618 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an
619 * appropriate network. {@see NetworkCapabilities} for supported transports.
Jaikumar Ganesh0db51a02010-12-21 22:31:44 -0800620 */
Chalard Jean5acb7b72018-03-08 13:54:53 +0900621 @Deprecated
Jaikumar Ganesh0db51a02010-12-21 22:31:44 -0800622 public static final int TYPE_BLUETOOTH = 7;
623
Robert Greenwaltf76c55d2011-04-22 15:28:18 -0700624 /**
Chiachang Wang7d5f3782020-07-28 13:53:09 +0800625 * Fake data connection. This should not be used on shipping devices.
Chalard Jean5acb7b72018-03-08 13:54:53 +0900626 * @deprecated This is not used any more.
Robert Greenwaltf76c55d2011-04-22 15:28:18 -0700627 */
Chalard Jean5acb7b72018-03-08 13:54:53 +0900628 @Deprecated
Jaikumar Ganesh0db51a02010-12-21 22:31:44 -0800629 public static final int TYPE_DUMMY = 8;
Wink Savilleb7c92c72011-03-12 14:52:01 -0800630
Robert Greenwaltf76c55d2011-04-22 15:28:18 -0700631 /**
Chalard Jean5acb7b72018-03-08 13:54:53 +0900632 * An Ethernet data connection.
633 *
634 * @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or
635 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an
636 * appropriate network. {@see NetworkCapabilities} for supported transports.
Robert Greenwaltf76c55d2011-04-22 15:28:18 -0700637 */
Chalard Jean5acb7b72018-03-08 13:54:53 +0900638 @Deprecated
Robert Greenwalt9d077812011-01-28 14:48:37 -0800639 public static final int TYPE_ETHERNET = 9;
Robert Greenwaltf76c55d2011-04-22 15:28:18 -0700640
Wink Savilleb7c92c72011-03-12 14:52:01 -0800641 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -0800642 * Over the air Administration.
Chalard Jean5acb7b72018-03-08 13:54:53 +0900643 * @deprecated Use {@link NetworkCapabilities} instead.
Wink Savilleb7c92c72011-03-12 14:52:01 -0800644 * {@hide}
645 */
Chalard Jean5acb7b72018-03-08 13:54:53 +0900646 @Deprecated
Chalard Jeanaa91c9d2019-04-09 15:46:21 +0900647 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 130143562)
Wink Savilleb7c92c72011-03-12 14:52:01 -0800648 public static final int TYPE_MOBILE_FOTA = 10;
649
650 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -0800651 * IP Multimedia Subsystem.
Chalard Jean5acb7b72018-03-08 13:54:53 +0900652 * @deprecated Use {@link NetworkCapabilities#NET_CAPABILITY_IMS} instead.
Wink Savilleb7c92c72011-03-12 14:52:01 -0800653 * {@hide}
654 */
Chalard Jean5acb7b72018-03-08 13:54:53 +0900655 @Deprecated
Mathew Inwood0b8f8612018-08-08 14:52:47 +0100656 @UnsupportedAppUsage
Wink Savilleb7c92c72011-03-12 14:52:01 -0800657 public static final int TYPE_MOBILE_IMS = 11;
658
659 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -0800660 * Carrier Branded Services.
Chalard Jean5acb7b72018-03-08 13:54:53 +0900661 * @deprecated Use {@link NetworkCapabilities#NET_CAPABILITY_CBS} instead.
Wink Savilleb7c92c72011-03-12 14:52:01 -0800662 * {@hide}
663 */
Chalard Jean5acb7b72018-03-08 13:54:53 +0900664 @Deprecated
Chalard Jeanaa91c9d2019-04-09 15:46:21 +0900665 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 130143562)
Wink Savilleb7c92c72011-03-12 14:52:01 -0800666 public static final int TYPE_MOBILE_CBS = 12;
667
repo syncf5de5572011-07-29 23:55:49 -0700668 /**
669 * A Wi-Fi p2p connection. Only requesting processes will have access to
670 * the peers connected.
Chalard Jean5acb7b72018-03-08 13:54:53 +0900671 * @deprecated Use {@link NetworkCapabilities#NET_CAPABILITY_WIFI_P2P} instead.
repo syncf5de5572011-07-29 23:55:49 -0700672 * {@hide}
673 */
Chalard Jean5acb7b72018-03-08 13:54:53 +0900674 @Deprecated
paulhu028732e2020-01-15 15:38:23 +0800675 @SystemApi
repo syncf5de5572011-07-29 23:55:49 -0700676 public static final int TYPE_WIFI_P2P = 13;
Wink Savilleb7c92c72011-03-12 14:52:01 -0800677
Wink Saville70dbdcc2013-07-29 15:00:57 -0700678 /**
679 * The network to use for initially attaching to the network
Chalard Jean5acb7b72018-03-08 13:54:53 +0900680 * @deprecated Use {@link NetworkCapabilities#NET_CAPABILITY_IA} instead.
Wink Saville70dbdcc2013-07-29 15:00:57 -0700681 * {@hide}
682 */
Chalard Jean5acb7b72018-03-08 13:54:53 +0900683 @Deprecated
Mathew Inwood0b8f8612018-08-08 14:52:47 +0100684 @UnsupportedAppUsage
Wink Saville70dbdcc2013-07-29 15:00:57 -0700685 public static final int TYPE_MOBILE_IA = 14;
repo syncf5de5572011-07-29 23:55:49 -0700686
Lorenzo Colitti7cc32c52015-04-23 15:32:42 +0900687 /**
Robert Greenwalt9db5f3c2015-07-09 14:49:35 -0700688 * Emergency PDN connection for emergency services. This
689 * may include IMS and MMS in emergency situations.
Chalard Jean5acb7b72018-03-08 13:54:53 +0900690 * @deprecated Use {@link NetworkCapabilities#NET_CAPABILITY_EIMS} instead.
Ram201d45f2014-06-26 11:03:44 -0700691 * {@hide}
692 */
Chalard Jean5acb7b72018-03-08 13:54:53 +0900693 @Deprecated
Chalard Jeanaa91c9d2019-04-09 15:46:21 +0900694 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 130143562)
Ram201d45f2014-06-26 11:03:44 -0700695 public static final int TYPE_MOBILE_EMERGENCY = 15;
696
Hui Lu07f29332014-01-15 11:05:36 -0500697 /**
698 * The network that uses proxy to achieve connectivity.
Chalard Jean5acb7b72018-03-08 13:54:53 +0900699 * @deprecated Use {@link NetworkCapabilities} instead.
Hui Lu07f29332014-01-15 11:05:36 -0500700 * {@hide}
701 */
Chalard Jean5acb7b72018-03-08 13:54:53 +0900702 @Deprecated
Remi NGUYEN VANdaeafee2020-11-30 19:23:45 +0900703 @SystemApi
Hui Lu07f29332014-01-15 11:05:36 -0500704 public static final int TYPE_PROXY = 16;
Wink Saville70dbdcc2013-07-29 15:00:57 -0700705
Robert Greenwaltb2a03d12014-07-07 17:09:01 -0700706 /**
707 * A virtual network using one or more native bearers.
708 * It may or may not be providing security services.
Chalard Jean5acb7b72018-03-08 13:54:53 +0900709 * @deprecated Applications should use {@link NetworkCapabilities#TRANSPORT_VPN} instead.
Robert Greenwaltb2a03d12014-07-07 17:09:01 -0700710 */
Chalard Jean5acb7b72018-03-08 13:54:53 +0900711 @Deprecated
Robert Greenwaltb2a03d12014-07-07 17:09:01 -0700712 public static final int TYPE_VPN = 17;
Hui Lu07f29332014-01-15 11:05:36 -0500713
Benedict Wong80156022018-11-14 17:40:55 -0800714 /**
715 * A network that is exclusively meant to be used for testing
716 *
717 * @deprecated Use {@link NetworkCapabilities} instead.
718 * @hide
719 */
720 @Deprecated
721 public static final int TYPE_TEST = 18; // TODO: Remove this once NetworkTypes are unused.
Robert Greenwaltb2a03d12014-07-07 17:09:01 -0700722
Chalard Jean74fe1c72020-03-25 01:24:04 +0900723 /**
724 * @deprecated Use {@link NetworkCapabilities} instead.
725 * @hide
726 */
727 @Deprecated
728 @Retention(RetentionPolicy.SOURCE)
729 @IntDef(prefix = { "TYPE_" }, value = {
730 TYPE_NONE,
731 TYPE_MOBILE,
732 TYPE_WIFI,
733 TYPE_MOBILE_MMS,
734 TYPE_MOBILE_SUPL,
735 TYPE_MOBILE_DUN,
736 TYPE_MOBILE_HIPRI,
737 TYPE_WIMAX,
738 TYPE_BLUETOOTH,
739 TYPE_DUMMY,
740 TYPE_ETHERNET,
741 TYPE_MOBILE_FOTA,
742 TYPE_MOBILE_IMS,
743 TYPE_MOBILE_CBS,
744 TYPE_WIFI_P2P,
745 TYPE_MOBILE_IA,
746 TYPE_MOBILE_EMERGENCY,
747 TYPE_PROXY,
748 TYPE_VPN,
749 TYPE_TEST
750 })
751 public @interface LegacyNetworkType {}
752
Chalard Jean1f42df12019-11-21 14:48:00 +0900753 // Deprecated constants for return values of startUsingNetworkFeature. They used to live
754 // in com.android.internal.telephony.PhoneConstants until they were made inaccessible.
755 private static final int DEPRECATED_PHONE_CONSTANT_APN_ALREADY_ACTIVE = 0;
756 private static final int DEPRECATED_PHONE_CONSTANT_APN_REQUEST_STARTED = 1;
757 private static final int DEPRECATED_PHONE_CONSTANT_APN_REQUEST_FAILED = 3;
758
Robert Greenwaltb2a03d12014-07-07 17:09:01 -0700759 /** {@hide} */
Benedict Wong80156022018-11-14 17:40:55 -0800760 public static final int MAX_RADIO_TYPE = TYPE_TEST;
761
762 /** {@hide} */
763 public static final int MAX_NETWORK_TYPE = TYPE_TEST;
The Android Open Source Project28527d22009-03-03 19:31:44 -0800764
Hugo Benichi37d5c3c2017-06-20 14:07:59 +0900765 private static final int MIN_NETWORK_TYPE = TYPE_MOBILE;
766
Jianzheng Zhoua8aa1602012-11-16 13:45:20 +0800767 /**
768 * If you want to set the default network preference,you can directly
769 * change the networkAttributes array in framework's config.xml.
770 *
771 * @deprecated Since we support so many more networks now, the single
772 * network default network preference can't really express
Robert Greenwalt26744a52013-02-15 10:56:35 -0800773 * the hierarchy. Instead, the default is defined by the
Jianzheng Zhoua8aa1602012-11-16 13:45:20 +0800774 * networkAttributes in config.xml. You can determine
Robert Greenwalt1ee3d2c2012-12-07 09:56:50 -0800775 * the current value by calling {@link #getNetworkPreference()}
Jianzheng Zhoua8aa1602012-11-16 13:45:20 +0800776 * from an App.
777 */
778 @Deprecated
The Android Open Source Project28527d22009-03-03 19:31:44 -0800779 public static final int DEFAULT_NETWORK_PREFERENCE = TYPE_WIFI;
780
Jeff Sharkey5eccd9c2012-09-26 22:03:49 -0700781 /**
Robert Greenwalta1402df2014-03-19 17:56:12 -0700782 * @hide
783 */
Hugo Benichibcc81df2017-06-20 14:10:14 +0900784 public static final int REQUEST_ID_UNSET = 0;
Robert Greenwaltc34f83b2014-06-08 16:42:59 -0700785
Paul Jensen0478ace2014-07-11 12:28:19 -0400786 /**
Hugo Benichi1c027fe2017-06-17 13:14:12 +0900787 * Static unique request used as a tombstone for NetworkCallbacks that have been unregistered.
788 * This allows to distinguish when unregistering NetworkCallbacks those that were never
Chalard Jean73d9db72018-06-04 16:52:49 +0900789 * registered from those that were already unregistered.
Hugo Benichi1c027fe2017-06-17 13:14:12 +0900790 * @hide
791 */
Hugo Benichibcc81df2017-06-20 14:10:14 +0900792 private static final NetworkRequest ALREADY_UNREGISTERED =
Hugo Benichi1c027fe2017-06-17 13:14:12 +0900793 new NetworkRequest.Builder().clearCapabilities().build();
794
795 /**
Paul Jensen0478ace2014-07-11 12:28:19 -0400796 * A NetID indicating no Network is selected.
797 * Keep in sync with bionic/libc/dns/include/resolv_netid.h
798 * @hide
799 */
800 public static final int NETID_UNSET = 0;
801
Erik Kline1ecdd962017-10-30 15:29:44 +0900802 /**
803 * Private DNS Mode values.
804 *
805 * The "private_dns_mode" global setting stores a String value which is
806 * expected to be one of the following.
807 */
808
809 /**
810 * @hide
811 */
lucaslin50205af2021-03-12 16:11:27 +0800812 @SystemApi(client = MODULE_LIBRARIES)
Erik Kline1ecdd962017-10-30 15:29:44 +0900813 public static final String PRIVATE_DNS_MODE_OFF = "off";
814 /**
815 * @hide
816 */
lucaslin50205af2021-03-12 16:11:27 +0800817 @SystemApi(client = MODULE_LIBRARIES)
Erik Kline1ecdd962017-10-30 15:29:44 +0900818 public static final String PRIVATE_DNS_MODE_OPPORTUNISTIC = "opportunistic";
819 /**
820 * @hide
821 */
lucaslin50205af2021-03-12 16:11:27 +0800822 @SystemApi(client = MODULE_LIBRARIES)
Erik Kline1ecdd962017-10-30 15:29:44 +0900823 public static final String PRIVATE_DNS_MODE_PROVIDER_HOSTNAME = "hostname";
lucaslin50205af2021-03-12 16:11:27 +0800824
825 /** @hide */
826 @Retention(RetentionPolicy.SOURCE)
827 @StringDef(value = {
828 PRIVATE_DNS_MODE_OFF,
829 PRIVATE_DNS_MODE_OPPORTUNISTIC,
830 PRIVATE_DNS_MODE_PROVIDER_HOSTNAME,
831 })
832 public @interface PrivateDnsMode {}
Erik Kline1ecdd962017-10-30 15:29:44 +0900833
Chalard Jeanaa91c9d2019-04-09 15:46:21 +0900834 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 130143562)
Jeff Sharkey921ebf22011-05-19 17:12:49 -0700835 private final IConnectivityManager mService;
Lorenzo Colitti0dd4b6f2021-02-04 17:32:07 +0900836
Paul Jensen12131352014-12-10 15:12:18 -0500837 /**
838 * A kludge to facilitate static access where a Context pointer isn't available, like in the
839 * case of the static set/getProcessDefaultNetwork methods and from the Network class.
840 * TODO: Remove this after deprecating the static methods in favor of non-static methods or
841 * methods that take a Context argument.
842 */
843 private static ConnectivityManager sInstance;
The Android Open Source Project28527d22009-03-03 19:31:44 -0800844
Lorenzo Colitti9b026fa2015-07-29 11:41:21 +0900845 private final Context mContext;
846
Automerger Merge Worker9b0c0c62020-03-06 00:38:43 +0000847 private final TetheringManager mTetheringManager;
Dianne Hackbornb4b09e82014-02-26 16:20:52 -0800848
Robert Greenwalt26744a52013-02-15 10:56:35 -0800849 /**
850 * Tests if a given integer represents a valid network type.
851 * @param networkType the type to be tested
852 * @return a boolean. {@code true} if the type is valid, else {@code false}
Paul Jensen1c9f2e42015-05-06 10:42:25 -0400853 * @deprecated All APIs accepting a network type are deprecated. There should be no need to
854 * validate a network type.
Robert Greenwalt26744a52013-02-15 10:56:35 -0800855 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -0700856 @Deprecated
Jeff Sharkey21062e72011-05-28 20:56:34 -0700857 public static boolean isNetworkTypeValid(int networkType) {
Hugo Benichi37d5c3c2017-06-20 14:07:59 +0900858 return MIN_NETWORK_TYPE <= networkType && networkType <= MAX_NETWORK_TYPE;
The Android Open Source Project28527d22009-03-03 19:31:44 -0800859 }
860
Robert Greenwalt26744a52013-02-15 10:56:35 -0800861 /**
862 * Returns a non-localized string representing a given network type.
863 * ONLY used for debugging output.
864 * @param type the type needing naming
865 * @return a String for the given type, or a string version of the type ("87")
866 * if no name is known.
Chalard Jean5acb7b72018-03-08 13:54:53 +0900867 * @deprecated Types are deprecated. Use {@link NetworkCapabilities} instead.
Robert Greenwalt26744a52013-02-15 10:56:35 -0800868 * {@hide}
869 */
Chalard Jean5acb7b72018-03-08 13:54:53 +0900870 @Deprecated
Mathew Inwoodd078d3d2020-10-27 11:47:29 +0000871 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
Jeff Sharkey21062e72011-05-28 20:56:34 -0700872 public static String getNetworkTypeName(int type) {
873 switch (type) {
Hugo Benichi37d5c3c2017-06-20 14:07:59 +0900874 case TYPE_NONE:
875 return "NONE";
Jeff Sharkey21062e72011-05-28 20:56:34 -0700876 case TYPE_MOBILE:
877 return "MOBILE";
878 case TYPE_WIFI:
879 return "WIFI";
880 case TYPE_MOBILE_MMS:
881 return "MOBILE_MMS";
882 case TYPE_MOBILE_SUPL:
883 return "MOBILE_SUPL";
884 case TYPE_MOBILE_DUN:
885 return "MOBILE_DUN";
886 case TYPE_MOBILE_HIPRI:
887 return "MOBILE_HIPRI";
888 case TYPE_WIMAX:
889 return "WIMAX";
890 case TYPE_BLUETOOTH:
891 return "BLUETOOTH";
892 case TYPE_DUMMY:
893 return "DUMMY";
894 case TYPE_ETHERNET:
895 return "ETHERNET";
896 case TYPE_MOBILE_FOTA:
897 return "MOBILE_FOTA";
898 case TYPE_MOBILE_IMS:
899 return "MOBILE_IMS";
900 case TYPE_MOBILE_CBS:
901 return "MOBILE_CBS";
repo syncf5de5572011-07-29 23:55:49 -0700902 case TYPE_WIFI_P2P:
903 return "WIFI_P2P";
Wink Saville70dbdcc2013-07-29 15:00:57 -0700904 case TYPE_MOBILE_IA:
905 return "MOBILE_IA";
Ram201d45f2014-06-26 11:03:44 -0700906 case TYPE_MOBILE_EMERGENCY:
907 return "MOBILE_EMERGENCY";
Hui Lu07f29332014-01-15 11:05:36 -0500908 case TYPE_PROXY:
909 return "PROXY";
Erik Klineb1ff7002014-11-19 17:23:41 +0900910 case TYPE_VPN:
911 return "VPN";
Jeff Sharkey21062e72011-05-28 20:56:34 -0700912 default:
913 return Integer.toString(type);
914 }
915 }
916
Robert Greenwalt26744a52013-02-15 10:56:35 -0800917 /**
Aaron Huangdfba5d12020-06-27 07:18:23 +0800918 * @hide
Aaron Huangdfba5d12020-06-27 07:18:23 +0800919 */
lucaslin8c121bf2021-03-17 14:16:01 +0800920 @SystemApi(client = MODULE_LIBRARIES)
Aaron Huangdfba5d12020-06-27 07:18:23 +0800921 public void systemReady() {
922 try {
923 mService.systemReady();
924 } catch (RemoteException e) {
925 throw e.rethrowFromSystemServer();
926 }
927 }
928
929 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -0800930 * Checks if a given type uses the cellular data connection.
931 * This should be replaced in the future by a network property.
932 * @param networkType the type to check
933 * @return a boolean - {@code true} if uses cellular network, else {@code false}
Chalard Jean5acb7b72018-03-08 13:54:53 +0900934 * @deprecated Types are deprecated. Use {@link NetworkCapabilities} instead.
Robert Greenwalt26744a52013-02-15 10:56:35 -0800935 * {@hide}
936 */
Chalard Jean5acb7b72018-03-08 13:54:53 +0900937 @Deprecated
Chalard Jeanaa91c9d2019-04-09 15:46:21 +0900938 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 130143562)
Jeff Sharkey21062e72011-05-28 20:56:34 -0700939 public static boolean isNetworkTypeMobile(int networkType) {
940 switch (networkType) {
941 case TYPE_MOBILE:
942 case TYPE_MOBILE_MMS:
943 case TYPE_MOBILE_SUPL:
944 case TYPE_MOBILE_DUN:
945 case TYPE_MOBILE_HIPRI:
946 case TYPE_MOBILE_FOTA:
947 case TYPE_MOBILE_IMS:
948 case TYPE_MOBILE_CBS:
Wink Saville70dbdcc2013-07-29 15:00:57 -0700949 case TYPE_MOBILE_IA:
Ram201d45f2014-06-26 11:03:44 -0700950 case TYPE_MOBILE_EMERGENCY:
Jeff Sharkey21062e72011-05-28 20:56:34 -0700951 return true;
952 default:
953 return false;
954 }
955 }
956
Robert Greenwalt26744a52013-02-15 10:56:35 -0800957 /**
Jeff Sharkeye9bda1d2013-06-04 12:29:00 -0700958 * Checks if the given network type is backed by a Wi-Fi radio.
959 *
Chalard Jean5acb7b72018-03-08 13:54:53 +0900960 * @deprecated Types are deprecated. Use {@link NetworkCapabilities} instead.
Jeff Sharkeye9bda1d2013-06-04 12:29:00 -0700961 * @hide
962 */
Chalard Jean5acb7b72018-03-08 13:54:53 +0900963 @Deprecated
Jeff Sharkeye9bda1d2013-06-04 12:29:00 -0700964 public static boolean isNetworkTypeWifi(int networkType) {
965 switch (networkType) {
966 case TYPE_WIFI:
967 case TYPE_WIFI_P2P:
968 return true;
969 default:
970 return false;
971 }
972 }
973
974 /**
Chalard Jean03433052021-02-25 17:23:40 +0900975 * Preference for {@link #setNetworkPreferenceForUser(UserHandle, int, Executor, Runnable)}.
976 * Specify that the traffic for this user should by follow the default rules.
977 * @hide
978 */
Chalard Jean560d4032021-03-17 14:33:24 +0900979 @SystemApi(client = MODULE_LIBRARIES)
Chalard Jean03433052021-02-25 17:23:40 +0900980 public static final int PROFILE_NETWORK_PREFERENCE_DEFAULT = 0;
981
982 /**
983 * Preference for {@link #setNetworkPreferenceForUser(UserHandle, int, Executor, Runnable)}.
984 * Specify that the traffic for this user should by default go on a network with
985 * {@link NetworkCapabilities#NET_CAPABILITY_ENTERPRISE}, and on the system default network
986 * if no such network is available.
987 * @hide
988 */
Chalard Jean560d4032021-03-17 14:33:24 +0900989 @SystemApi(client = MODULE_LIBRARIES)
Chalard Jean03433052021-02-25 17:23:40 +0900990 public static final int PROFILE_NETWORK_PREFERENCE_ENTERPRISE = 1;
991
992 /** @hide */
993 @Retention(RetentionPolicy.SOURCE)
994 @IntDef(value = {
995 PROFILE_NETWORK_PREFERENCE_DEFAULT,
996 PROFILE_NETWORK_PREFERENCE_ENTERPRISE
997 })
998 public @interface ProfileNetworkPreference {
999 }
1000
1001 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -08001002 * Specifies the preferred network type. When the device has more
1003 * than one type available the preferred network type will be used.
Robert Greenwalt26744a52013-02-15 10:56:35 -08001004 *
1005 * @param preference the network type to prefer over all others. It is
1006 * unspecified what happens to the old preferred network in the
1007 * overall ordering.
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07001008 * @deprecated Functionality has been removed as it no longer makes sense,
1009 * with many more than two networks - we'd need an array to express
1010 * preference. Instead we use dynamic network properties of
1011 * the networks to describe their precedence.
Robert Greenwalt26744a52013-02-15 10:56:35 -08001012 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -07001013 @Deprecated
The Android Open Source Project28527d22009-03-03 19:31:44 -08001014 public void setNetworkPreference(int preference) {
The Android Open Source Project28527d22009-03-03 19:31:44 -08001015 }
1016
Robert Greenwalt26744a52013-02-15 10:56:35 -08001017 /**
1018 * Retrieves the current preferred network type.
Robert Greenwalt26744a52013-02-15 10:56:35 -08001019 *
1020 * @return an integer representing the preferred network type
1021 *
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07001022 * @deprecated Functionality has been removed as it no longer makes sense,
1023 * with many more than two networks - we'd need an array to express
1024 * preference. Instead we use dynamic network properties of
1025 * the networks to describe their precedence.
Robert Greenwalt26744a52013-02-15 10:56:35 -08001026 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -07001027 @Deprecated
Jeff Sharkey2ac62992017-04-24 11:18:03 -06001028 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
The Android Open Source Project28527d22009-03-03 19:31:44 -08001029 public int getNetworkPreference() {
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07001030 return TYPE_NONE;
The Android Open Source Project28527d22009-03-03 19:31:44 -08001031 }
1032
Scott Mainf58b7d82011-10-06 19:02:28 -07001033 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -08001034 * Returns details about the currently active default data network. When
1035 * connected, this network is the default route for outgoing connections.
1036 * You should always check {@link NetworkInfo#isConnected()} before initiating
1037 * network traffic. This may return {@code null} when there is no default
1038 * network.
Chalard Jean7c85ba42018-03-29 17:45:24 +09001039 * Note that if the default network is a VPN, this method will return the
1040 * NetworkInfo for one of its underlying networks instead, or null if the
1041 * VPN agent did not specify any. Apps interested in learning about VPNs
1042 * should use {@link #getNetworkInfo(android.net.Network)} instead.
Robert Greenwalt26744a52013-02-15 10:56:35 -08001043 *
1044 * @return a {@link NetworkInfo} object for the current default network
Paul Jensena9208b92015-02-13 14:18:39 -05001045 * or {@code null} if no default network is currently active
junyulai5c2f6262018-12-13 12:47:51 +08001046 * @deprecated See {@link NetworkInfo}.
Jeff Sharkeyd00b1302012-04-12 18:34:54 -07001047 */
junyulai5c2f6262018-12-13 12:47:51 +08001048 @Deprecated
Jeff Sharkey2ac62992017-04-24 11:18:03 -06001049 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean42a9c292019-01-07 19:26:34 +09001050 @Nullable
The Android Open Source Project28527d22009-03-03 19:31:44 -08001051 public NetworkInfo getActiveNetworkInfo() {
1052 try {
1053 return mService.getActiveNetworkInfo();
1054 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07001055 throw e.rethrowFromSystemServer();
The Android Open Source Project28527d22009-03-03 19:31:44 -08001056 }
1057 }
1058
Robert Greenwalt26744a52013-02-15 10:56:35 -08001059 /**
Paul Jensenc2569432015-02-13 14:18:39 -05001060 * Returns a {@link Network} object corresponding to the currently active
1061 * default data network. In the event that the current active default data
1062 * network disconnects, the returned {@code Network} object will no longer
1063 * be usable. This will return {@code null} when there is no default
1064 * network.
1065 *
1066 * @return a {@link Network} object for the current default network or
1067 * {@code null} if no default network is currently active
Paul Jensenc2569432015-02-13 14:18:39 -05001068 */
Jeff Sharkey2ac62992017-04-24 11:18:03 -06001069 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean42a9c292019-01-07 19:26:34 +09001070 @Nullable
Paul Jensenc2569432015-02-13 14:18:39 -05001071 public Network getActiveNetwork() {
1072 try {
1073 return mService.getActiveNetwork();
1074 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07001075 throw e.rethrowFromSystemServer();
Paul Jensenc2569432015-02-13 14:18:39 -05001076 }
1077 }
1078
1079 /**
Robin Leeda4d2e22016-03-24 12:07:00 +00001080 * Returns a {@link Network} object corresponding to the currently active
1081 * default data network for a specific UID. In the event that the default data
1082 * network disconnects, the returned {@code Network} object will no longer
1083 * be usable. This will return {@code null} when there is no default
1084 * network for the UID.
Robin Leeda4d2e22016-03-24 12:07:00 +00001085 *
1086 * @return a {@link Network} object for the current default network for the
1087 * given UID or {@code null} if no default network is currently active
1088 *
1089 * @hide
1090 */
paulhuec0a9632019-08-12 16:25:11 +08001091 @RequiresPermission(android.Manifest.permission.NETWORK_STACK)
Chalard Jean42a9c292019-01-07 19:26:34 +09001092 @Nullable
Robin Leeda4d2e22016-03-24 12:07:00 +00001093 public Network getActiveNetworkForUid(int uid) {
Jeff Sharkey833c35b2016-04-28 15:33:18 -06001094 return getActiveNetworkForUid(uid, false);
1095 }
1096
1097 /** {@hide} */
1098 public Network getActiveNetworkForUid(int uid, boolean ignoreBlocked) {
Robin Leeda4d2e22016-03-24 12:07:00 +00001099 try {
Jeff Sharkey833c35b2016-04-28 15:33:18 -06001100 return mService.getActiveNetworkForUid(uid, ignoreBlocked);
Robin Leeda4d2e22016-03-24 12:07:00 +00001101 } catch (RemoteException e) {
1102 throw e.rethrowFromSystemServer();
1103 }
1104 }
1105
1106 /**
Lorenzo Colittie8ce2052020-12-12 00:51:11 +09001107 * Adds or removes a requirement for given UID ranges to use the VPN.
1108 *
1109 * If set to {@code true}, informs the system that the UIDs in the specified ranges must not
1110 * have any connectivity except if a VPN is connected and applies to the UIDs, or if the UIDs
1111 * otherwise have permission to bypass the VPN (e.g., because they have the
1112 * {@link android.Manifest.permission.CONNECTIVITY_USE_RESTRICTED_NETWORKS} permission, or when
1113 * using a socket protected by a method such as {@link VpnService#protect(DatagramSocket)}. If
1114 * set to {@code false}, a previously-added restriction is removed.
1115 * <p>
1116 * Each of the UID ranges specified by this method is added and removed as is, and no processing
1117 * is performed on the ranges to de-duplicate, merge, split, or intersect them. In order to
1118 * remove a previously-added range, the exact range must be removed as is.
1119 * <p>
1120 * The changes are applied asynchronously and may not have been applied by the time the method
1121 * returns. Apps will be notified about any changes that apply to them via
1122 * {@link NetworkCallback#onBlockedStatusChanged} callbacks called after the changes take
1123 * effect.
1124 * <p>
1125 * This method should be called only by the VPN code.
1126 *
1127 * @param ranges the UID ranges to restrict
1128 * @param requireVpn whether the specified UID ranges must use a VPN
1129 *
1130 * TODO: expose as @SystemApi.
1131 * @hide
1132 */
1133 @RequiresPermission(anyOf = {
1134 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
1135 android.Manifest.permission.NETWORK_STACK})
1136 public void setRequireVpnForUids(boolean requireVpn,
1137 @NonNull Collection<Range<Integer>> ranges) {
1138 Objects.requireNonNull(ranges);
1139 // The Range class is not parcelable. Convert to UidRange, which is what is used internally.
1140 // This method is not necessarily expected to be used outside the system server, so
1141 // parceling may not be necessary, but it could be used out-of-process, e.g., by the network
1142 // stack process, or by tests.
1143 UidRange[] rangesArray = new UidRange[ranges.size()];
1144 int index = 0;
1145 for (Range<Integer> range : ranges) {
1146 rangesArray[index++] = new UidRange(range.getLower(), range.getUpper());
1147 }
1148 try {
1149 mService.setRequireVpnForUids(requireVpn, rangesArray);
1150 } catch (RemoteException e) {
1151 throw e.rethrowFromSystemServer();
1152 }
1153 }
1154
1155 /**
Lorenzo Colitti549e9ac2021-01-15 01:29:01 +09001156 * Informs ConnectivityService of whether the legacy lockdown VPN, as implemented by
1157 * LockdownVpnTracker, is in use. This is deprecated for new devices starting from Android 12
1158 * but is still supported for backwards compatibility.
1159 * <p>
1160 * This type of VPN is assumed always to use the system default network, and must always declare
1161 * exactly one underlying network, which is the network that was the default when the VPN
1162 * connected.
1163 * <p>
1164 * Calling this method with {@code true} enables legacy behaviour, specifically:
1165 * <ul>
1166 * <li>Any VPN that applies to userId 0 behaves specially with respect to deprecated
1167 * {@link #CONNECTIVITY_ACTION} broadcasts. Any such broadcasts will have the state in the
1168 * {@link #EXTRA_NETWORK_INFO} replaced by state of the VPN network. Also, any time the VPN
1169 * connects, a {@link #CONNECTIVITY_ACTION} broadcast will be sent for the network
1170 * underlying the VPN.</li>
1171 * <li>Deprecated APIs that return {@link NetworkInfo} objects will have their state
1172 * similarly replaced by the VPN network state.</li>
1173 * <li>Information on current network interfaces passed to NetworkStatsService will not
1174 * include any VPN interfaces.</li>
1175 * </ul>
1176 *
1177 * @param enabled whether legacy lockdown VPN is enabled or disabled
1178 *
1179 * TODO: @SystemApi(client = MODULE_LIBRARIES)
1180 *
1181 * @hide
1182 */
1183 @RequiresPermission(anyOf = {
1184 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
1185 android.Manifest.permission.NETWORK_SETTINGS})
1186 public void setLegacyLockdownVpnEnabled(boolean enabled) {
1187 try {
1188 mService.setLegacyLockdownVpnEnabled(enabled);
1189 } catch (RemoteException e) {
1190 throw e.rethrowFromSystemServer();
1191 }
1192 }
1193
1194 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -08001195 * Returns details about the currently active default data network
1196 * for a given uid. This is for internal use only to avoid spying
1197 * other apps.
1198 *
1199 * @return a {@link NetworkInfo} object for the current default network
1200 * for the given uid or {@code null} if no default network is
1201 * available for the specified uid.
1202 *
Robert Greenwalt26744a52013-02-15 10:56:35 -08001203 * {@hide}
1204 */
paulhuec0a9632019-08-12 16:25:11 +08001205 @RequiresPermission(android.Manifest.permission.NETWORK_STACK)
Mathew Inwoodd078d3d2020-10-27 11:47:29 +00001206 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
Jeff Sharkey921ebf22011-05-19 17:12:49 -07001207 public NetworkInfo getActiveNetworkInfoForUid(int uid) {
Jeff Sharkey833c35b2016-04-28 15:33:18 -06001208 return getActiveNetworkInfoForUid(uid, false);
1209 }
1210
1211 /** {@hide} */
1212 public NetworkInfo getActiveNetworkInfoForUid(int uid, boolean ignoreBlocked) {
Jeff Sharkey921ebf22011-05-19 17:12:49 -07001213 try {
Jeff Sharkey833c35b2016-04-28 15:33:18 -06001214 return mService.getActiveNetworkInfoForUid(uid, ignoreBlocked);
Jeff Sharkey921ebf22011-05-19 17:12:49 -07001215 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07001216 throw e.rethrowFromSystemServer();
Jeff Sharkey921ebf22011-05-19 17:12:49 -07001217 }
1218 }
1219
Robert Greenwalt26744a52013-02-15 10:56:35 -08001220 /**
1221 * Returns connection status information about a particular
1222 * network type.
1223 *
1224 * @param networkType integer specifying which networkType in
1225 * which you're interested.
1226 * @return a {@link NetworkInfo} object for the requested
1227 * network type or {@code null} if the type is not
Chalard Jean7c85ba42018-03-29 17:45:24 +09001228 * supported by the device. If {@code networkType} is
1229 * TYPE_VPN and a VPN is active for the calling app,
1230 * then this method will try to return one of the
1231 * underlying networks for the VPN or null if the
1232 * VPN agent didn't specify any.
Robert Greenwalt26744a52013-02-15 10:56:35 -08001233 *
Paul Jensena8e6dc62015-03-18 12:23:02 -04001234 * @deprecated This method does not support multiple connected networks
1235 * of the same type. Use {@link #getAllNetworks} and
1236 * {@link #getNetworkInfo(android.net.Network)} instead.
Robert Greenwalt26744a52013-02-15 10:56:35 -08001237 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -07001238 @Deprecated
Jeff Sharkey2ac62992017-04-24 11:18:03 -06001239 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean42a9c292019-01-07 19:26:34 +09001240 @Nullable
The Android Open Source Project28527d22009-03-03 19:31:44 -08001241 public NetworkInfo getNetworkInfo(int networkType) {
1242 try {
1243 return mService.getNetworkInfo(networkType);
1244 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07001245 throw e.rethrowFromSystemServer();
The Android Open Source Project28527d22009-03-03 19:31:44 -08001246 }
1247 }
1248
Robert Greenwalt26744a52013-02-15 10:56:35 -08001249 /**
Robert Greenwalt701a5c32014-06-23 11:40:00 -07001250 * Returns connection status information about a particular
1251 * Network.
1252 *
1253 * @param network {@link Network} specifying which network
1254 * in which you're interested.
1255 * @return a {@link NetworkInfo} object for the requested
1256 * network or {@code null} if the {@code Network}
1257 * is not valid.
junyulai5c2f6262018-12-13 12:47:51 +08001258 * @deprecated See {@link NetworkInfo}.
Robert Greenwalt701a5c32014-06-23 11:40:00 -07001259 */
junyulai5c2f6262018-12-13 12:47:51 +08001260 @Deprecated
Jeff Sharkey2ac62992017-04-24 11:18:03 -06001261 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean42a9c292019-01-07 19:26:34 +09001262 @Nullable
1263 public NetworkInfo getNetworkInfo(@Nullable Network network) {
Jeff Sharkey833c35b2016-04-28 15:33:18 -06001264 return getNetworkInfoForUid(network, Process.myUid(), false);
1265 }
1266
1267 /** {@hide} */
1268 public NetworkInfo getNetworkInfoForUid(Network network, int uid, boolean ignoreBlocked) {
Robert Greenwalt701a5c32014-06-23 11:40:00 -07001269 try {
Jeff Sharkey833c35b2016-04-28 15:33:18 -06001270 return mService.getNetworkInfoForUid(network, uid, ignoreBlocked);
Robert Greenwalt701a5c32014-06-23 11:40:00 -07001271 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07001272 throw e.rethrowFromSystemServer();
Robert Greenwalt701a5c32014-06-23 11:40:00 -07001273 }
1274 }
1275
1276 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -08001277 * Returns connection status information about all network
1278 * types supported by the device.
1279 *
1280 * @return an array of {@link NetworkInfo} objects. Check each
1281 * {@link NetworkInfo#getType} for which type each applies.
1282 *
Paul Jensena8e6dc62015-03-18 12:23:02 -04001283 * @deprecated This method does not support multiple connected networks
1284 * of the same type. Use {@link #getAllNetworks} and
1285 * {@link #getNetworkInfo(android.net.Network)} instead.
Robert Greenwalt26744a52013-02-15 10:56:35 -08001286 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -07001287 @Deprecated
Jeff Sharkey2ac62992017-04-24 11:18:03 -06001288 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean42a9c292019-01-07 19:26:34 +09001289 @NonNull
The Android Open Source Project28527d22009-03-03 19:31:44 -08001290 public NetworkInfo[] getAllNetworkInfo() {
1291 try {
1292 return mService.getAllNetworkInfo();
1293 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07001294 throw e.rethrowFromSystemServer();
The Android Open Source Project28527d22009-03-03 19:31:44 -08001295 }
1296 }
1297
Robert Greenwalt26744a52013-02-15 10:56:35 -08001298 /**
junyulai57840802021-03-03 12:09:05 +08001299 * Return a list of {@link NetworkStateSnapshot}s, one for each network that is currently
1300 * connected.
1301 * @hide
1302 */
1303 @SystemApi(client = MODULE_LIBRARIES)
1304 @RequiresPermission(anyOf = {
1305 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
1306 android.Manifest.permission.NETWORK_STACK,
1307 android.Manifest.permission.NETWORK_SETTINGS})
1308 @NonNull
1309 public List<NetworkStateSnapshot> getAllNetworkStateSnapshot() {
1310 try {
1311 return mService.getAllNetworkStateSnapshot();
1312 } catch (RemoteException e) {
1313 throw e.rethrowFromSystemServer();
1314 }
1315 }
1316
1317 /**
Lorenzo Colitti2b2d73c2014-08-22 17:10:50 -07001318 * Returns the {@link Network} object currently serving a given type, or
1319 * null if the given type is not connected.
1320 *
Lorenzo Colitti2b2d73c2014-08-22 17:10:50 -07001321 * @hide
Paul Jensena8e6dc62015-03-18 12:23:02 -04001322 * @deprecated This method does not support multiple connected networks
1323 * of the same type. Use {@link #getAllNetworks} and
1324 * {@link #getNetworkInfo(android.net.Network)} instead.
Lorenzo Colitti2b2d73c2014-08-22 17:10:50 -07001325 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -07001326 @Deprecated
Jeff Sharkey2ac62992017-04-24 11:18:03 -06001327 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Mathew Inwood0b8f8612018-08-08 14:52:47 +01001328 @UnsupportedAppUsage
Lorenzo Colitti2b2d73c2014-08-22 17:10:50 -07001329 public Network getNetworkForType(int networkType) {
1330 try {
1331 return mService.getNetworkForType(networkType);
1332 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07001333 throw e.rethrowFromSystemServer();
Lorenzo Colitti2b2d73c2014-08-22 17:10:50 -07001334 }
1335 }
1336
1337 /**
Robert Greenwalt701a5c32014-06-23 11:40:00 -07001338 * Returns an array of all {@link Network} currently tracked by the
1339 * framework.
Paul Jensen19b3ee72015-05-06 11:10:18 -04001340 *
1341 * @return an array of {@link Network} objects.
Robert Greenwalt701a5c32014-06-23 11:40:00 -07001342 */
Jeff Sharkey2ac62992017-04-24 11:18:03 -06001343 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean42a9c292019-01-07 19:26:34 +09001344 @NonNull
Robert Greenwalt701a5c32014-06-23 11:40:00 -07001345 public Network[] getAllNetworks() {
1346 try {
1347 return mService.getAllNetworks();
1348 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07001349 throw e.rethrowFromSystemServer();
Robert Greenwalt701a5c32014-06-23 11:40:00 -07001350 }
1351 }
1352
1353 /**
Roshan Pius7992afd2020-12-22 15:10:42 -08001354 * Returns an array of {@link NetworkCapabilities} objects, representing
Lorenzo Colitti8db934a2014-11-28 11:21:30 +09001355 * the Networks that applications run by the given user will use by default.
1356 * @hide
1357 */
Mathew Inwood0b8f8612018-08-08 14:52:47 +01001358 @UnsupportedAppUsage
Lorenzo Colitti8db934a2014-11-28 11:21:30 +09001359 public NetworkCapabilities[] getDefaultNetworkCapabilitiesForUser(int userId) {
1360 try {
Qingxi Libf6bf082020-01-08 12:51:49 -08001361 return mService.getDefaultNetworkCapabilitiesForUser(
Roshan Piusc97d8062020-12-17 14:53:09 -08001362 userId, mContext.getOpPackageName(), getAttributionTag());
Lorenzo Colitti8db934a2014-11-28 11:21:30 +09001363 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07001364 throw e.rethrowFromSystemServer();
Lorenzo Colitti8db934a2014-11-28 11:21:30 +09001365 }
1366 }
1367
1368 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -08001369 * Returns the IP information for the current default network.
1370 *
1371 * @return a {@link LinkProperties} object describing the IP info
1372 * for the current default network, or {@code null} if there
1373 * is no current default network.
1374 *
Robert Greenwalt26744a52013-02-15 10:56:35 -08001375 * {@hide}
Chalard Jeancc47b522019-01-11 16:47:53 +09001376 * @deprecated please use {@link #getLinkProperties(Network)} on the return
1377 * value of {@link #getActiveNetwork()} instead. In particular,
1378 * this method will return non-null LinkProperties even if the
1379 * app is blocked by policy from using this network.
Robert Greenwalt26744a52013-02-15 10:56:35 -08001380 */
Jeff Sharkey2ac62992017-04-24 11:18:03 -06001381 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jeancc47b522019-01-11 16:47:53 +09001382 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 109783091)
Robert Greenwalt9f0ee4f2010-09-14 09:18:02 -07001383 public LinkProperties getActiveLinkProperties() {
1384 try {
1385 return mService.getActiveLinkProperties();
1386 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07001387 throw e.rethrowFromSystemServer();
Robert Greenwalt9f0ee4f2010-09-14 09:18:02 -07001388 }
1389 }
1390
Robert Greenwalt26744a52013-02-15 10:56:35 -08001391 /**
1392 * Returns the IP information for a given network type.
1393 *
1394 * @param networkType the network type of interest.
1395 * @return a {@link LinkProperties} object describing the IP info
1396 * for the given networkType, or {@code null} if there is
1397 * no current default network.
1398 *
Robert Greenwalt26744a52013-02-15 10:56:35 -08001399 * {@hide}
Paul Jensena8e6dc62015-03-18 12:23:02 -04001400 * @deprecated This method does not support multiple connected networks
1401 * of the same type. Use {@link #getAllNetworks},
1402 * {@link #getNetworkInfo(android.net.Network)}, and
1403 * {@link #getLinkProperties(android.net.Network)} instead.
Robert Greenwalt26744a52013-02-15 10:56:35 -08001404 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -07001405 @Deprecated
Jeff Sharkey2ac62992017-04-24 11:18:03 -06001406 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jeanaa91c9d2019-04-09 15:46:21 +09001407 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 130143562)
Robert Greenwalt9f0ee4f2010-09-14 09:18:02 -07001408 public LinkProperties getLinkProperties(int networkType) {
1409 try {
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07001410 return mService.getLinkPropertiesForType(networkType);
1411 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07001412 throw e.rethrowFromSystemServer();
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07001413 }
1414 }
1415
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07001416 /**
1417 * Get the {@link LinkProperties} for the given {@link Network}. This
1418 * will return {@code null} if the network is unknown.
1419 *
1420 * @param network The {@link Network} object identifying the network in question.
1421 * @return The {@link LinkProperties} for the network, or {@code null}.
Paul Jensen19b3ee72015-05-06 11:10:18 -04001422 */
Jeff Sharkey2ac62992017-04-24 11:18:03 -06001423 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean42a9c292019-01-07 19:26:34 +09001424 @Nullable
1425 public LinkProperties getLinkProperties(@Nullable Network network) {
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07001426 try {
1427 return mService.getLinkProperties(network);
1428 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07001429 throw e.rethrowFromSystemServer();
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07001430 }
1431 }
1432
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07001433 /**
Roshan Pius7992afd2020-12-22 15:10:42 -08001434 * Get the {@link NetworkCapabilities} for the given {@link Network}. This
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07001435 * will return {@code null} if the network is unknown.
1436 *
Roshan Pius7992afd2020-12-22 15:10:42 -08001437 * This will remove any location sensitive data in {@link TransportInfo} embedded in
1438 * {@link NetworkCapabilities#getTransportInfo()}. Some transport info instances like
1439 * {@link android.net.wifi.WifiInfo} contain location sensitive information. Retrieving
1440 * this location sensitive information (subject to app's location permissions) will be
1441 * noted by system. To include any location sensitive data in {@link TransportInfo},
1442 * use a {@link NetworkCallback} with
1443 * {@link NetworkCallback#FLAG_INCLUDE_LOCATION_INFO} flag.
1444 *
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07001445 * @param network The {@link Network} object identifying the network in question.
Roshan Pius7992afd2020-12-22 15:10:42 -08001446 * @return The {@link NetworkCapabilities} for the network, or {@code null}.
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07001447 */
Jeff Sharkey2ac62992017-04-24 11:18:03 -06001448 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean42a9c292019-01-07 19:26:34 +09001449 @Nullable
1450 public NetworkCapabilities getNetworkCapabilities(@Nullable Network network) {
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07001451 try {
Roshan Piusc97d8062020-12-17 14:53:09 -08001452 return mService.getNetworkCapabilities(
1453 network, mContext.getOpPackageName(), getAttributionTag());
Robert Greenwalt9f0ee4f2010-09-14 09:18:02 -07001454 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07001455 throw e.rethrowFromSystemServer();
Robert Greenwalt9f0ee4f2010-09-14 09:18:02 -07001456 }
1457 }
1458
Robert Greenwalt26744a52013-02-15 10:56:35 -08001459 /**
Remi NGUYEN VAN69a57cb2019-03-20 14:22:49 +09001460 * Gets a URL that can be used for resolving whether a captive portal is present.
Udam Saini53b71ee2016-01-04 12:16:14 -08001461 * 1. This URL should respond with a 204 response to a GET request to indicate no captive
1462 * portal is present.
1463 * 2. This URL must be HTTP as redirect responses are used to find captive portal
1464 * sign-in pages. Captive portals cannot respond to HTTPS requests with redirects.
1465 *
Remi NGUYEN VAN69a57cb2019-03-20 14:22:49 +09001466 * The system network validation may be using different strategies to detect captive portals,
1467 * so this method does not necessarily return a URL used by the system. It only returns a URL
1468 * that may be relevant for other components trying to detect captive portals.
paulhuec0a9632019-08-12 16:25:11 +08001469 *
Udam Saini53b71ee2016-01-04 12:16:14 -08001470 * @hide
paulhuec0a9632019-08-12 16:25:11 +08001471 * @deprecated This API returns URL which is not guaranteed to be one of the URLs used by the
1472 * system.
Udam Saini53b71ee2016-01-04 12:16:14 -08001473 */
paulhuec0a9632019-08-12 16:25:11 +08001474 @Deprecated
Udam Saini53b71ee2016-01-04 12:16:14 -08001475 @SystemApi
paulhuec0a9632019-08-12 16:25:11 +08001476 @RequiresPermission(android.Manifest.permission.NETWORK_SETTINGS)
Udam Saini53b71ee2016-01-04 12:16:14 -08001477 public String getCaptivePortalServerUrl() {
1478 try {
1479 return mService.getCaptivePortalServerUrl();
1480 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07001481 throw e.rethrowFromSystemServer();
Udam Saini53b71ee2016-01-04 12:16:14 -08001482 }
1483 }
1484
1485 /**
The Android Open Source Project28527d22009-03-03 19:31:44 -08001486 * Tells the underlying networking system that the caller wants to
1487 * begin using the named feature. The interpretation of {@code feature}
1488 * is completely up to each networking implementation.
Lorenzo Colitti91de63b2015-10-15 16:29:00 +09001489 *
1490 * <p>This method requires the caller to hold either the
1491 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
1492 * or the ability to modify system settings as determined by
1493 * {@link android.provider.Settings.System#canWrite}.</p>
1494 *
The Android Open Source Project28527d22009-03-03 19:31:44 -08001495 * @param networkType specifies which network the request pertains to
1496 * @param feature the name of the feature to be used
1497 * @return an integer value representing the outcome of the request.
1498 * The interpretation of this value is specific to each networking
1499 * implementation+feature combination, except that the value {@code -1}
1500 * always indicates failure.
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07001501 *
Lorenzo Colittiefd396e2015-04-24 17:03:31 +09001502 * @deprecated Deprecated in favor of the cleaner
1503 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} API.
Dianne Hackbornc16abda2015-07-31 10:35:34 -07001504 * In {@link VERSION_CODES#M}, and above, this method is unsupported and will
Lorenzo Colitti9b026fa2015-07-29 11:41:21 +09001505 * throw {@code UnsupportedOperationException} if called.
Lorenzo Colitti7cb18342016-12-09 18:39:30 +09001506 * @removed
The Android Open Source Project28527d22009-03-03 19:31:44 -08001507 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -07001508 @Deprecated
The Android Open Source Project28527d22009-03-03 19:31:44 -08001509 public int startUsingNetworkFeature(int networkType, String feature) {
Lorenzo Colitti9b026fa2015-07-29 11:41:21 +09001510 checkLegacyRoutingApiAccess();
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001511 NetworkCapabilities netCap = networkCapabilitiesForFeature(networkType, feature);
1512 if (netCap == null) {
1513 Log.d(TAG, "Can't satisfy startUsingNetworkFeature for " + networkType + ", " +
1514 feature);
Chalard Jean1f42df12019-11-21 14:48:00 +09001515 return DEPRECATED_PHONE_CONSTANT_APN_REQUEST_FAILED;
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001516 }
1517
1518 NetworkRequest request = null;
1519 synchronized (sLegacyRequests) {
1520 LegacyRequest l = sLegacyRequests.get(netCap);
1521 if (l != null) {
1522 Log.d(TAG, "renewing startUsingNetworkFeature request " + l.networkRequest);
1523 renewRequestLocked(l);
1524 if (l.currentNetwork != null) {
Chalard Jean1f42df12019-11-21 14:48:00 +09001525 return DEPRECATED_PHONE_CONSTANT_APN_ALREADY_ACTIVE;
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001526 } else {
Chalard Jean1f42df12019-11-21 14:48:00 +09001527 return DEPRECATED_PHONE_CONSTANT_APN_REQUEST_STARTED;
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001528 }
1529 }
1530
1531 request = requestNetworkForFeatureLocked(netCap);
1532 }
1533 if (request != null) {
Robert Greenwaltca3c5cf2014-06-20 10:58:45 -07001534 Log.d(TAG, "starting startUsingNetworkFeature for request " + request);
Chalard Jean1f42df12019-11-21 14:48:00 +09001535 return DEPRECATED_PHONE_CONSTANT_APN_REQUEST_STARTED;
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001536 } else {
1537 Log.d(TAG, " request Failed");
Chalard Jean1f42df12019-11-21 14:48:00 +09001538 return DEPRECATED_PHONE_CONSTANT_APN_REQUEST_FAILED;
The Android Open Source Project28527d22009-03-03 19:31:44 -08001539 }
1540 }
1541
1542 /**
1543 * Tells the underlying networking system that the caller is finished
1544 * using the named feature. The interpretation of {@code feature}
1545 * is completely up to each networking implementation.
Lorenzo Colitti91de63b2015-10-15 16:29:00 +09001546 *
1547 * <p>This method requires the caller to hold either the
1548 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
1549 * or the ability to modify system settings as determined by
1550 * {@link android.provider.Settings.System#canWrite}.</p>
1551 *
The Android Open Source Project28527d22009-03-03 19:31:44 -08001552 * @param networkType specifies which network the request pertains to
1553 * @param feature the name of the feature that is no longer needed
1554 * @return an integer value representing the outcome of the request.
1555 * The interpretation of this value is specific to each networking
1556 * implementation+feature combination, except that the value {@code -1}
1557 * always indicates failure.
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07001558 *
Lorenzo Colittiad458ad2016-04-13 22:00:02 +09001559 * @deprecated Deprecated in favor of the cleaner
1560 * {@link #unregisterNetworkCallback(NetworkCallback)} API.
Dianne Hackbornc16abda2015-07-31 10:35:34 -07001561 * In {@link VERSION_CODES#M}, and above, this method is unsupported and will
Lorenzo Colitti9b026fa2015-07-29 11:41:21 +09001562 * throw {@code UnsupportedOperationException} if called.
Lorenzo Colitti7cb18342016-12-09 18:39:30 +09001563 * @removed
The Android Open Source Project28527d22009-03-03 19:31:44 -08001564 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -07001565 @Deprecated
The Android Open Source Project28527d22009-03-03 19:31:44 -08001566 public int stopUsingNetworkFeature(int networkType, String feature) {
Lorenzo Colitti9b026fa2015-07-29 11:41:21 +09001567 checkLegacyRoutingApiAccess();
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001568 NetworkCapabilities netCap = networkCapabilitiesForFeature(networkType, feature);
1569 if (netCap == null) {
1570 Log.d(TAG, "Can't satisfy stopUsingNetworkFeature for " + networkType + ", " +
1571 feature);
The Android Open Source Project28527d22009-03-03 19:31:44 -08001572 return -1;
1573 }
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001574
Paul Jensen034dea32014-12-17 10:39:34 -05001575 if (removeRequestForFeature(netCap)) {
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001576 Log.d(TAG, "stopUsingNetworkFeature for " + networkType + ", " + feature);
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001577 }
1578 return 1;
1579 }
1580
Mathew Inwoodd078d3d2020-10-27 11:47:29 +00001581 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001582 private NetworkCapabilities networkCapabilitiesForFeature(int networkType, String feature) {
1583 if (networkType == TYPE_MOBILE) {
Erik Kline50068e52017-01-26 18:08:28 +09001584 switch (feature) {
1585 case "enableCBS":
1586 return networkCapabilitiesForType(TYPE_MOBILE_CBS);
1587 case "enableDUN":
1588 case "enableDUNAlways":
1589 return networkCapabilitiesForType(TYPE_MOBILE_DUN);
1590 case "enableFOTA":
1591 return networkCapabilitiesForType(TYPE_MOBILE_FOTA);
1592 case "enableHIPRI":
1593 return networkCapabilitiesForType(TYPE_MOBILE_HIPRI);
1594 case "enableIMS":
1595 return networkCapabilitiesForType(TYPE_MOBILE_IMS);
1596 case "enableMMS":
1597 return networkCapabilitiesForType(TYPE_MOBILE_MMS);
1598 case "enableSUPL":
1599 return networkCapabilitiesForType(TYPE_MOBILE_SUPL);
1600 default:
1601 return null;
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001602 }
Erik Kline50068e52017-01-26 18:08:28 +09001603 } else if (networkType == TYPE_WIFI && "p2p".equals(feature)) {
1604 return networkCapabilitiesForType(TYPE_WIFI_P2P);
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001605 }
1606 return null;
1607 }
1608
Robert Greenwalt5a367872014-06-02 15:32:02 -07001609 private int legacyTypeForNetworkCapabilities(NetworkCapabilities netCap) {
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001610 if (netCap == null) return TYPE_NONE;
1611 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_CBS)) {
1612 return TYPE_MOBILE_CBS;
1613 }
1614 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_IMS)) {
1615 return TYPE_MOBILE_IMS;
1616 }
1617 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_FOTA)) {
1618 return TYPE_MOBILE_FOTA;
1619 }
1620 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_DUN)) {
1621 return TYPE_MOBILE_DUN;
1622 }
1623 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_SUPL)) {
1624 return TYPE_MOBILE_SUPL;
1625 }
1626 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_MMS)) {
1627 return TYPE_MOBILE_MMS;
1628 }
1629 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_INTERNET)) {
1630 return TYPE_MOBILE_HIPRI;
1631 }
Robert Greenwalt5a367872014-06-02 15:32:02 -07001632 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_WIFI_P2P)) {
1633 return TYPE_WIFI_P2P;
1634 }
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001635 return TYPE_NONE;
1636 }
1637
1638 private static class LegacyRequest {
1639 NetworkCapabilities networkCapabilities;
1640 NetworkRequest networkRequest;
1641 int expireSequenceNumber;
1642 Network currentNetwork;
1643 int delay = -1;
Paul Jensen034dea32014-12-17 10:39:34 -05001644
1645 private void clearDnsBinding() {
1646 if (currentNetwork != null) {
1647 currentNetwork = null;
1648 setProcessDefaultNetworkForHostResolution(null);
1649 }
1650 }
1651
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07001652 NetworkCallback networkCallback = new NetworkCallback() {
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001653 @Override
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07001654 public void onAvailable(Network network) {
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001655 currentNetwork = network;
1656 Log.d(TAG, "startUsingNetworkFeature got Network:" + network);
Paul Jensene98c6e02014-05-29 10:12:39 -04001657 setProcessDefaultNetworkForHostResolution(network);
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001658 }
1659 @Override
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07001660 public void onLost(Network network) {
Paul Jensen034dea32014-12-17 10:39:34 -05001661 if (network.equals(currentNetwork)) clearDnsBinding();
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001662 Log.d(TAG, "startUsingNetworkFeature lost Network:" + network);
1663 }
1664 };
1665 }
1666
Mathew Inwoodd078d3d2020-10-27 11:47:29 +00001667 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
Chalard Jean73d9db72018-06-04 16:52:49 +09001668 private static final HashMap<NetworkCapabilities, LegacyRequest> sLegacyRequests =
1669 new HashMap<>();
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001670
1671 private NetworkRequest findRequestForFeature(NetworkCapabilities netCap) {
1672 synchronized (sLegacyRequests) {
1673 LegacyRequest l = sLegacyRequests.get(netCap);
1674 if (l != null) return l.networkRequest;
1675 }
1676 return null;
1677 }
1678
1679 private void renewRequestLocked(LegacyRequest l) {
1680 l.expireSequenceNumber++;
1681 Log.d(TAG, "renewing request to seqNum " + l.expireSequenceNumber);
1682 sendExpireMsgForFeature(l.networkCapabilities, l.expireSequenceNumber, l.delay);
1683 }
1684
1685 private void expireRequest(NetworkCapabilities netCap, int sequenceNum) {
1686 int ourSeqNum = -1;
1687 synchronized (sLegacyRequests) {
1688 LegacyRequest l = sLegacyRequests.get(netCap);
1689 if (l == null) return;
1690 ourSeqNum = l.expireSequenceNumber;
Paul Jensen034dea32014-12-17 10:39:34 -05001691 if (l.expireSequenceNumber == sequenceNum) removeRequestForFeature(netCap);
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001692 }
1693 Log.d(TAG, "expireRequest with " + ourSeqNum + ", " + sequenceNum);
1694 }
1695
Mathew Inwoodd078d3d2020-10-27 11:47:29 +00001696 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001697 private NetworkRequest requestNetworkForFeatureLocked(NetworkCapabilities netCap) {
1698 int delay = -1;
Robert Greenwalt5a367872014-06-02 15:32:02 -07001699 int type = legacyTypeForNetworkCapabilities(netCap);
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001700 try {
1701 delay = mService.getRestoreDefaultNetworkDelay(type);
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07001702 } catch (RemoteException e) {
1703 throw e.rethrowFromSystemServer();
1704 }
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001705 LegacyRequest l = new LegacyRequest();
1706 l.networkCapabilities = netCap;
1707 l.delay = delay;
1708 l.expireSequenceNumber = 0;
Hugo Benichicd5a0e02017-02-02 17:02:36 +09001709 l.networkRequest = sendRequestForNetwork(
1710 netCap, l.networkCallback, 0, REQUEST, type, getDefaultHandler());
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001711 if (l.networkRequest == null) return null;
1712 sLegacyRequests.put(netCap, l);
1713 sendExpireMsgForFeature(netCap, l.expireSequenceNumber, delay);
1714 return l.networkRequest;
1715 }
1716
1717 private void sendExpireMsgForFeature(NetworkCapabilities netCap, int seqNum, int delay) {
1718 if (delay >= 0) {
1719 Log.d(TAG, "sending expire msg with seqNum " + seqNum + " and delay " + delay);
Hugo Benichicd5a0e02017-02-02 17:02:36 +09001720 CallbackHandler handler = getDefaultHandler();
Hugo Benichiec180d52017-02-03 14:18:44 +09001721 Message msg = handler.obtainMessage(EXPIRE_LEGACY_REQUEST, seqNum, 0, netCap);
1722 handler.sendMessageDelayed(msg, delay);
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001723 }
1724 }
1725
Mathew Inwoodd078d3d2020-10-27 11:47:29 +00001726 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
Paul Jensen034dea32014-12-17 10:39:34 -05001727 private boolean removeRequestForFeature(NetworkCapabilities netCap) {
1728 final LegacyRequest l;
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001729 synchronized (sLegacyRequests) {
Paul Jensen034dea32014-12-17 10:39:34 -05001730 l = sLegacyRequests.remove(netCap);
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001731 }
Paul Jensen034dea32014-12-17 10:39:34 -05001732 if (l == null) return false;
1733 unregisterNetworkCallback(l.networkCallback);
1734 l.clearDnsBinding();
1735 return true;
The Android Open Source Project28527d22009-03-03 19:31:44 -08001736 }
1737
Erik Kline50068e52017-01-26 18:08:28 +09001738 private static final SparseIntArray sLegacyTypeToTransport = new SparseIntArray();
1739 static {
1740 sLegacyTypeToTransport.put(TYPE_MOBILE, NetworkCapabilities.TRANSPORT_CELLULAR);
1741 sLegacyTypeToTransport.put(TYPE_MOBILE_CBS, NetworkCapabilities.TRANSPORT_CELLULAR);
1742 sLegacyTypeToTransport.put(TYPE_MOBILE_DUN, NetworkCapabilities.TRANSPORT_CELLULAR);
1743 sLegacyTypeToTransport.put(TYPE_MOBILE_FOTA, NetworkCapabilities.TRANSPORT_CELLULAR);
1744 sLegacyTypeToTransport.put(TYPE_MOBILE_HIPRI, NetworkCapabilities.TRANSPORT_CELLULAR);
1745 sLegacyTypeToTransport.put(TYPE_MOBILE_IMS, NetworkCapabilities.TRANSPORT_CELLULAR);
1746 sLegacyTypeToTransport.put(TYPE_MOBILE_MMS, NetworkCapabilities.TRANSPORT_CELLULAR);
1747 sLegacyTypeToTransport.put(TYPE_MOBILE_SUPL, NetworkCapabilities.TRANSPORT_CELLULAR);
1748 sLegacyTypeToTransport.put(TYPE_WIFI, NetworkCapabilities.TRANSPORT_WIFI);
1749 sLegacyTypeToTransport.put(TYPE_WIFI_P2P, NetworkCapabilities.TRANSPORT_WIFI);
1750 sLegacyTypeToTransport.put(TYPE_BLUETOOTH, NetworkCapabilities.TRANSPORT_BLUETOOTH);
1751 sLegacyTypeToTransport.put(TYPE_ETHERNET, NetworkCapabilities.TRANSPORT_ETHERNET);
1752 }
1753
1754 private static final SparseIntArray sLegacyTypeToCapability = new SparseIntArray();
1755 static {
1756 sLegacyTypeToCapability.put(TYPE_MOBILE_CBS, NetworkCapabilities.NET_CAPABILITY_CBS);
1757 sLegacyTypeToCapability.put(TYPE_MOBILE_DUN, NetworkCapabilities.NET_CAPABILITY_DUN);
1758 sLegacyTypeToCapability.put(TYPE_MOBILE_FOTA, NetworkCapabilities.NET_CAPABILITY_FOTA);
1759 sLegacyTypeToCapability.put(TYPE_MOBILE_IMS, NetworkCapabilities.NET_CAPABILITY_IMS);
1760 sLegacyTypeToCapability.put(TYPE_MOBILE_MMS, NetworkCapabilities.NET_CAPABILITY_MMS);
1761 sLegacyTypeToCapability.put(TYPE_MOBILE_SUPL, NetworkCapabilities.NET_CAPABILITY_SUPL);
1762 sLegacyTypeToCapability.put(TYPE_WIFI_P2P, NetworkCapabilities.NET_CAPABILITY_WIFI_P2P);
1763 }
1764
1765 /**
1766 * Given a legacy type (TYPE_WIFI, ...) returns a NetworkCapabilities
1767 * instance suitable for registering a request or callback. Throws an
1768 * IllegalArgumentException if no mapping from the legacy type to
1769 * NetworkCapabilities is known.
1770 *
Chalard Jean5acb7b72018-03-08 13:54:53 +09001771 * @deprecated Types are deprecated. Use {@link NetworkCallback} or {@link NetworkRequest}
1772 * to find the network instead.
Erik Kline50068e52017-01-26 18:08:28 +09001773 * @hide
1774 */
1775 public static NetworkCapabilities networkCapabilitiesForType(int type) {
1776 final NetworkCapabilities nc = new NetworkCapabilities();
1777
1778 // Map from type to transports.
1779 final int NOT_FOUND = -1;
1780 final int transport = sLegacyTypeToTransport.get(type, NOT_FOUND);
Remi NGUYEN VAN00c531f2021-03-15 07:27:44 +00001781 Preconditions.checkArgument(transport != NOT_FOUND, "unknown legacy type: " + type);
Erik Kline50068e52017-01-26 18:08:28 +09001782 nc.addTransportType(transport);
1783
1784 // Map from type to capabilities.
1785 nc.addCapability(sLegacyTypeToCapability.get(
1786 type, NetworkCapabilities.NET_CAPABILITY_INTERNET));
1787 nc.maybeMarkCapabilitiesRestricted();
1788 return nc;
1789 }
1790
Lorenzo Colittid1039d12015-06-15 14:29:22 +09001791 /** @hide */
1792 public static class PacketKeepaliveCallback {
Mathew Inwoodd078d3d2020-10-27 11:47:29 +00001793 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
Artur Satayevfc03a992019-11-15 19:12:49 +00001794 public PacketKeepaliveCallback() {
1795 }
Lorenzo Colittid1039d12015-06-15 14:29:22 +09001796 /** The requested keepalive was successfully started. */
Mathew Inwoodd078d3d2020-10-27 11:47:29 +00001797 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
Lorenzo Colittid1039d12015-06-15 14:29:22 +09001798 public void onStarted() {}
1799 /** The keepalive was successfully stopped. */
Mathew Inwoodd078d3d2020-10-27 11:47:29 +00001800 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
Lorenzo Colittid1039d12015-06-15 14:29:22 +09001801 public void onStopped() {}
1802 /** An error occurred. */
Mathew Inwoodd078d3d2020-10-27 11:47:29 +00001803 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
Lorenzo Colittid1039d12015-06-15 14:29:22 +09001804 public void onError(int error) {}
1805 }
1806
1807 /**
1808 * Allows applications to request that the system periodically send specific packets on their
1809 * behalf, using hardware offload to save battery power.
1810 *
1811 * To request that the system send keepalives, call one of the methods that return a
1812 * {@link ConnectivityManager.PacketKeepalive} object, such as {@link #startNattKeepalive},
1813 * passing in a non-null callback. If the callback is successfully started, the callback's
1814 * {@code onStarted} method will be called. If an error occurs, {@code onError} will be called,
1815 * specifying one of the {@code ERROR_*} constants in this class.
1816 *
Chalard Jean73d9db72018-06-04 16:52:49 +09001817 * To stop an existing keepalive, call {@link PacketKeepalive#stop}. The system will call
1818 * {@link PacketKeepaliveCallback#onStopped} if the operation was successful or
1819 * {@link PacketKeepaliveCallback#onError} if an error occurred.
Lorenzo Colittid1039d12015-06-15 14:29:22 +09001820 *
junyulaia86defc2018-12-27 17:25:29 +08001821 * @deprecated Use {@link SocketKeepalive} instead.
1822 *
Lorenzo Colittid1039d12015-06-15 14:29:22 +09001823 * @hide
1824 */
1825 public class PacketKeepalive {
1826
1827 private static final String TAG = "PacketKeepalive";
1828
1829 /** @hide */
1830 public static final int SUCCESS = 0;
1831
1832 /** @hide */
1833 public static final int NO_KEEPALIVE = -1;
1834
1835 /** @hide */
1836 public static final int BINDER_DIED = -10;
1837
1838 /** The specified {@code Network} is not connected. */
1839 public static final int ERROR_INVALID_NETWORK = -20;
1840 /** The specified IP addresses are invalid. For example, the specified source IP address is
1841 * not configured on the specified {@code Network}. */
1842 public static final int ERROR_INVALID_IP_ADDRESS = -21;
1843 /** The requested port is invalid. */
1844 public static final int ERROR_INVALID_PORT = -22;
1845 /** The packet length is invalid (e.g., too long). */
1846 public static final int ERROR_INVALID_LENGTH = -23;
1847 /** The packet transmission interval is invalid (e.g., too short). */
1848 public static final int ERROR_INVALID_INTERVAL = -24;
1849
1850 /** The hardware does not support this request. */
1851 public static final int ERROR_HARDWARE_UNSUPPORTED = -30;
Lorenzo Colitti2aab7182015-09-08 16:46:36 +09001852 /** The hardware returned an error. */
1853 public static final int ERROR_HARDWARE_ERROR = -31;
Lorenzo Colittid1039d12015-06-15 14:29:22 +09001854
Nathan Harolde8ae0eb2018-02-14 13:09:45 -08001855 /** The NAT-T destination port for IPsec */
Lorenzo Colittid1039d12015-06-15 14:29:22 +09001856 public static final int NATT_PORT = 4500;
1857
Nathan Harolde8ae0eb2018-02-14 13:09:45 -08001858 /** The minimum interval in seconds between keepalive packet transmissions */
1859 public static final int MIN_INTERVAL = 10;
1860
Lorenzo Colittid1039d12015-06-15 14:29:22 +09001861 private final Network mNetwork;
junyulai9f872232019-01-16 20:23:34 +08001862 private final ISocketKeepaliveCallback mCallback;
1863 private final ExecutorService mExecutor;
Lorenzo Colittid1039d12015-06-15 14:29:22 +09001864
1865 private volatile Integer mSlot;
1866
Mathew Inwoodd078d3d2020-10-27 11:47:29 +00001867 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
Lorenzo Colittid1039d12015-06-15 14:29:22 +09001868 public void stop() {
1869 try {
junyulai9f872232019-01-16 20:23:34 +08001870 mExecutor.execute(() -> {
1871 try {
1872 if (mSlot != null) {
1873 mService.stopKeepalive(mNetwork, mSlot);
1874 }
1875 } catch (RemoteException e) {
1876 Log.e(TAG, "Error stopping packet keepalive: ", e);
1877 throw e.rethrowFromSystemServer();
1878 }
1879 });
1880 } catch (RejectedExecutionException e) {
1881 // The internal executor has already stopped due to previous event.
Lorenzo Colittid1039d12015-06-15 14:29:22 +09001882 }
1883 }
1884
1885 private PacketKeepalive(Network network, PacketKeepaliveCallback callback) {
Remi NGUYEN VAN00c531f2021-03-15 07:27:44 +00001886 Preconditions.checkNotNull(network, "network cannot be null");
1887 Preconditions.checkNotNull(callback, "callback cannot be null");
Lorenzo Colittid1039d12015-06-15 14:29:22 +09001888 mNetwork = network;
junyulai9f872232019-01-16 20:23:34 +08001889 mExecutor = Executors.newSingleThreadExecutor();
1890 mCallback = new ISocketKeepaliveCallback.Stub() {
Lorenzo Colittid1039d12015-06-15 14:29:22 +09001891 @Override
junyulai9f872232019-01-16 20:23:34 +08001892 public void onStarted(int slot) {
lucaslinad369e32020-12-30 11:54:55 +08001893 final long token = Binder.clearCallingIdentity();
1894 try {
1895 mExecutor.execute(() -> {
1896 mSlot = slot;
1897 callback.onStarted();
1898 });
1899 } finally {
1900 Binder.restoreCallingIdentity(token);
1901 }
Lorenzo Colittid1039d12015-06-15 14:29:22 +09001902 }
junyulai9f872232019-01-16 20:23:34 +08001903
1904 @Override
1905 public void onStopped() {
lucaslinad369e32020-12-30 11:54:55 +08001906 final long token = Binder.clearCallingIdentity();
1907 try {
1908 mExecutor.execute(() -> {
1909 mSlot = null;
1910 callback.onStopped();
1911 });
1912 } finally {
1913 Binder.restoreCallingIdentity(token);
1914 }
junyulai9f872232019-01-16 20:23:34 +08001915 mExecutor.shutdown();
1916 }
1917
1918 @Override
1919 public void onError(int error) {
lucaslinad369e32020-12-30 11:54:55 +08001920 final long token = Binder.clearCallingIdentity();
1921 try {
1922 mExecutor.execute(() -> {
1923 mSlot = null;
1924 callback.onError(error);
1925 });
1926 } finally {
1927 Binder.restoreCallingIdentity(token);
1928 }
junyulai9f872232019-01-16 20:23:34 +08001929 mExecutor.shutdown();
1930 }
1931
1932 @Override
1933 public void onDataReceived() {
1934 // PacketKeepalive is only used for Nat-T keepalive and as such does not invoke
1935 // this callback when data is received.
1936 }
1937 };
Lorenzo Colittid1039d12015-06-15 14:29:22 +09001938 }
1939 }
1940
1941 /**
1942 * Starts an IPsec NAT-T keepalive packet with the specified parameters.
1943 *
junyulaia86defc2018-12-27 17:25:29 +08001944 * @deprecated Use {@link #createSocketKeepalive} instead.
1945 *
Lorenzo Colittid1039d12015-06-15 14:29:22 +09001946 * @hide
1947 */
Mathew Inwoodd078d3d2020-10-27 11:47:29 +00001948 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
Lorenzo Colittid1039d12015-06-15 14:29:22 +09001949 public PacketKeepalive startNattKeepalive(
1950 Network network, int intervalSeconds, PacketKeepaliveCallback callback,
1951 InetAddress srcAddr, int srcPort, InetAddress dstAddr) {
1952 final PacketKeepalive k = new PacketKeepalive(network, callback);
1953 try {
junyulai9f872232019-01-16 20:23:34 +08001954 mService.startNattKeepalive(network, intervalSeconds, k.mCallback,
Lorenzo Colittid1039d12015-06-15 14:29:22 +09001955 srcAddr.getHostAddress(), srcPort, dstAddr.getHostAddress());
1956 } catch (RemoteException e) {
1957 Log.e(TAG, "Error starting packet keepalive: ", e);
junyulai9f872232019-01-16 20:23:34 +08001958 throw e.rethrowFromSystemServer();
Lorenzo Colittid1039d12015-06-15 14:29:22 +09001959 }
1960 return k;
1961 }
1962
Chiachang Wangc5f86f42021-01-15 11:06:21 +08001963 // Construct an invalid fd.
1964 private ParcelFileDescriptor createInvalidFd() {
1965 final int invalidFd = -1;
1966 return ParcelFileDescriptor.adoptFd(invalidFd);
1967 }
1968
The Android Open Source Project28527d22009-03-03 19:31:44 -08001969 /**
junyulaia86defc2018-12-27 17:25:29 +08001970 * Request that keepalives be started on a IPsec NAT-T socket.
1971 *
1972 * @param network The {@link Network} the socket is on.
1973 * @param socket The socket that needs to be kept alive.
1974 * @param source The source address of the {@link UdpEncapsulationSocket}.
1975 * @param destination The destination address of the {@link UdpEncapsulationSocket}.
1976 * @param executor The executor on which callback will be invoked. The provided {@link Executor}
1977 * must run callback sequentially, otherwise the order of callbacks cannot be
1978 * guaranteed.
1979 * @param callback A {@link SocketKeepalive.Callback}. Used for notifications about keepalive
1980 * changes. Must be extended by applications that use this API.
1981 *
junyulaic7ea1242019-01-08 20:04:33 +08001982 * @return A {@link SocketKeepalive} object that can be used to control the keepalive on the
1983 * given socket.
junyulaia86defc2018-12-27 17:25:29 +08001984 **/
junyulai61143782019-03-04 22:45:36 +08001985 public @NonNull SocketKeepalive createSocketKeepalive(@NonNull Network network,
junyulaia86defc2018-12-27 17:25:29 +08001986 @NonNull UdpEncapsulationSocket socket,
1987 @NonNull InetAddress source,
1988 @NonNull InetAddress destination,
1989 @NonNull @CallbackExecutor Executor executor,
1990 @NonNull Callback callback) {
junyulai61143782019-03-04 22:45:36 +08001991 ParcelFileDescriptor dup;
1992 try {
junyulaic4fb2482019-03-27 11:00:37 +08001993 // Dup is needed here as the pfd inside the socket is owned by the IpSecService,
1994 // which cannot be obtained by the app process.
junyulai61143782019-03-04 22:45:36 +08001995 dup = ParcelFileDescriptor.dup(socket.getFileDescriptor());
1996 } catch (IOException ignored) {
1997 // Construct an invalid fd, so that if the user later calls start(), it will fail with
1998 // ERROR_INVALID_SOCKET.
Chiachang Wangc5f86f42021-01-15 11:06:21 +08001999 dup = createInvalidFd();
junyulai61143782019-03-04 22:45:36 +08002000 }
2001 return new NattSocketKeepalive(mService, network, dup, socket.getResourceId(), source,
2002 destination, executor, callback);
junyulai48a59382019-01-15 11:32:44 +08002003 }
2004
2005 /**
2006 * Request that keepalives be started on a IPsec NAT-T socket file descriptor. Directly called
2007 * by system apps which don't use IpSecService to create {@link UdpEncapsulationSocket}.
2008 *
2009 * @param network The {@link Network} the socket is on.
junyulai61143782019-03-04 22:45:36 +08002010 * @param pfd The {@link ParcelFileDescriptor} that needs to be kept alive. The provided
2011 * {@link ParcelFileDescriptor} must be bound to a port and the keepalives will be sent
2012 * from that port.
junyulai48a59382019-01-15 11:32:44 +08002013 * @param source The source address of the {@link UdpEncapsulationSocket}.
2014 * @param destination The destination address of the {@link UdpEncapsulationSocket}. The
2015 * keepalive packets will always be sent to port 4500 of the given {@code destination}.
2016 * @param executor The executor on which callback will be invoked. The provided {@link Executor}
2017 * must run callback sequentially, otherwise the order of callbacks cannot be
2018 * guaranteed.
2019 * @param callback A {@link SocketKeepalive.Callback}. Used for notifications about keepalive
2020 * changes. Must be extended by applications that use this API.
2021 *
junyulaic7ea1242019-01-08 20:04:33 +08002022 * @return A {@link SocketKeepalive} object that can be used to control the keepalive on the
2023 * given socket.
junyulai48a59382019-01-15 11:32:44 +08002024 * @hide
2025 */
2026 @SystemApi
2027 @RequiresPermission(android.Manifest.permission.PACKET_KEEPALIVE_OFFLOAD)
junyulai61143782019-03-04 22:45:36 +08002028 public @NonNull SocketKeepalive createNattKeepalive(@NonNull Network network,
2029 @NonNull ParcelFileDescriptor pfd,
junyulai48a59382019-01-15 11:32:44 +08002030 @NonNull InetAddress source,
2031 @NonNull InetAddress destination,
2032 @NonNull @CallbackExecutor Executor executor,
2033 @NonNull Callback callback) {
junyulai61143782019-03-04 22:45:36 +08002034 ParcelFileDescriptor dup;
2035 try {
junyulaic4fb2482019-03-27 11:00:37 +08002036 // TODO: Consider remove unnecessary dup.
junyulai61143782019-03-04 22:45:36 +08002037 dup = pfd.dup();
2038 } catch (IOException ignored) {
2039 // Construct an invalid fd, so that if the user later calls start(), it will fail with
2040 // ERROR_INVALID_SOCKET.
Chiachang Wangc5f86f42021-01-15 11:06:21 +08002041 dup = createInvalidFd();
junyulai61143782019-03-04 22:45:36 +08002042 }
2043 return new NattSocketKeepalive(mService, network, dup,
Remi NGUYEN VAN642d6ab2021-03-11 10:56:49 +00002044 -1 /* Unused */, source, destination, executor, callback);
junyulaia86defc2018-12-27 17:25:29 +08002045 }
2046
2047 /**
junyulaic7ea1242019-01-08 20:04:33 +08002048 * Request that keepalives be started on a TCP socket.
2049 * The socket must be established.
2050 *
2051 * @param network The {@link Network} the socket is on.
2052 * @param socket The socket that needs to be kept alive.
2053 * @param executor The executor on which callback will be invoked. This implementation assumes
2054 * the provided {@link Executor} runs the callbacks in sequence with no
2055 * concurrency. Failing this, no guarantee of correctness can be made. It is
2056 * the responsibility of the caller to ensure the executor provides this
2057 * guarantee. A simple way of creating such an executor is with the standard
2058 * tool {@code Executors.newSingleThreadExecutor}.
2059 * @param callback A {@link SocketKeepalive.Callback}. Used for notifications about keepalive
2060 * changes. Must be extended by applications that use this API.
2061 *
2062 * @return A {@link SocketKeepalive} object that can be used to control the keepalive on the
2063 * given socket.
2064 * @hide
2065 */
2066 @SystemApi
2067 @RequiresPermission(android.Manifest.permission.PACKET_KEEPALIVE_OFFLOAD)
junyulai61143782019-03-04 22:45:36 +08002068 public @NonNull SocketKeepalive createSocketKeepalive(@NonNull Network network,
junyulaic7ea1242019-01-08 20:04:33 +08002069 @NonNull Socket socket,
2070 @NonNull Executor executor,
2071 @NonNull Callback callback) {
junyulai61143782019-03-04 22:45:36 +08002072 ParcelFileDescriptor dup;
2073 try {
2074 dup = ParcelFileDescriptor.fromSocket(socket);
2075 } catch (UncheckedIOException ignored) {
2076 // Construct an invalid fd, so that if the user later calls start(), it will fail with
2077 // ERROR_INVALID_SOCKET.
Chiachang Wangc5f86f42021-01-15 11:06:21 +08002078 dup = createInvalidFd();
junyulai61143782019-03-04 22:45:36 +08002079 }
2080 return new TcpSocketKeepalive(mService, network, dup, executor, callback);
junyulaic7ea1242019-01-08 20:04:33 +08002081 }
2082
2083 /**
The Android Open Source Project28527d22009-03-03 19:31:44 -08002084 * Ensure that a network route exists to deliver traffic to the specified
2085 * host via the specified network interface. An attempt to add a route that
2086 * already exists is ignored, but treated as successful.
Lorenzo Colitti91de63b2015-10-15 16:29:00 +09002087 *
2088 * <p>This method requires the caller to hold either the
2089 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
2090 * or the ability to modify system settings as determined by
2091 * {@link android.provider.Settings.System#canWrite}.</p>
2092 *
The Android Open Source Project28527d22009-03-03 19:31:44 -08002093 * @param networkType the type of the network over which traffic to the specified
2094 * host is to be routed
2095 * @param hostAddress the IP address of the host to which the route is desired
2096 * @return {@code true} on success, {@code false} on failure
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07002097 *
Lorenzo Colittiefd396e2015-04-24 17:03:31 +09002098 * @deprecated Deprecated in favor of the
2099 * {@link #requestNetwork(NetworkRequest, NetworkCallback)},
2100 * {@link #bindProcessToNetwork} and {@link Network#getSocketFactory} API.
Dianne Hackbornc16abda2015-07-31 10:35:34 -07002101 * In {@link VERSION_CODES#M}, and above, this method is unsupported and will
Lorenzo Colitti9b026fa2015-07-29 11:41:21 +09002102 * throw {@code UnsupportedOperationException} if called.
Lorenzo Colitti7cb18342016-12-09 18:39:30 +09002103 * @removed
The Android Open Source Project28527d22009-03-03 19:31:44 -08002104 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -07002105 @Deprecated
The Android Open Source Project28527d22009-03-03 19:31:44 -08002106 public boolean requestRouteToHost(int networkType, int hostAddress) {
Sreeram Ramachandranc05e2a92014-07-19 23:21:46 -07002107 return requestRouteToHostAddress(networkType, NetworkUtils.intToInetAddress(hostAddress));
Robert Greenwalt7fe44cb2010-08-27 09:24:29 -07002108 }
2109
2110 /**
2111 * Ensure that a network route exists to deliver traffic to the specified
2112 * host via the specified network interface. An attempt to add a route that
2113 * already exists is ignored, but treated as successful.
Lorenzo Colitti91de63b2015-10-15 16:29:00 +09002114 *
2115 * <p>This method requires the caller to hold either the
2116 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
2117 * or the ability to modify system settings as determined by
2118 * {@link android.provider.Settings.System#canWrite}.</p>
2119 *
Robert Greenwalt7fe44cb2010-08-27 09:24:29 -07002120 * @param networkType the type of the network over which traffic to the specified
2121 * host is to be routed
2122 * @param hostAddress the IP address of the host to which the route is desired
2123 * @return {@code true} on success, {@code false} on failure
2124 * @hide
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07002125 * @deprecated Deprecated in favor of the {@link #requestNetwork} and
Lorenzo Colittiefd396e2015-04-24 17:03:31 +09002126 * {@link #bindProcessToNetwork} API.
Robert Greenwalt7fe44cb2010-08-27 09:24:29 -07002127 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -07002128 @Deprecated
Mathew Inwood0b8f8612018-08-08 14:52:47 +01002129 @UnsupportedAppUsage
Robert Greenwalt7fe44cb2010-08-27 09:24:29 -07002130 public boolean requestRouteToHostAddress(int networkType, InetAddress hostAddress) {
Lorenzo Colitti9b026fa2015-07-29 11:41:21 +09002131 checkLegacyRoutingApiAccess();
The Android Open Source Project28527d22009-03-03 19:31:44 -08002132 try {
Philip P. Moltmannddbcf5b2020-03-24 15:57:49 -07002133 return mService.requestRouteToHostAddress(networkType, hostAddress.getAddress(),
2134 mContext.getOpPackageName(), getAttributionTag());
The Android Open Source Project28527d22009-03-03 19:31:44 -08002135 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07002136 throw e.rethrowFromSystemServer();
The Android Open Source Project28527d22009-03-03 19:31:44 -08002137 }
2138 }
2139
2140 /**
Philip P. Moltmannddbcf5b2020-03-24 15:57:49 -07002141 * @return the context's attribution tag
2142 */
2143 // TODO: Remove method and replace with direct call once R code is pushed to AOSP
2144 private @Nullable String getAttributionTag() {
2145 return mContext.getAttributionTag();
2146 }
2147
2148 /**
The Android Open Source Project28527d22009-03-03 19:31:44 -08002149 * Returns the value of the setting for background data usage. If false,
2150 * applications should not use the network if the application is not in the
2151 * foreground. Developers should respect this setting, and check the value
2152 * of this before performing any background data operations.
2153 * <p>
2154 * All applications that have background services that use the network
2155 * should listen to {@link #ACTION_BACKGROUND_DATA_SETTING_CHANGED}.
Jeff Sharkey39c01eb2011-08-16 14:37:57 -07002156 * <p>
Scott Main50589142011-10-06 18:32:43 -07002157 * @deprecated As of {@link VERSION_CODES#ICE_CREAM_SANDWICH}, availability of
Jeff Sharkey39c01eb2011-08-16 14:37:57 -07002158 * background data depends on several combined factors, and this method will
2159 * always return {@code true}. Instead, when background data is unavailable,
2160 * {@link #getActiveNetworkInfo()} will now appear disconnected.
Danica Chang96567052010-08-11 14:54:43 -07002161 *
The Android Open Source Project28527d22009-03-03 19:31:44 -08002162 * @return Whether background data usage is allowed.
2163 */
Jeff Sharkey39c01eb2011-08-16 14:37:57 -07002164 @Deprecated
The Android Open Source Project28527d22009-03-03 19:31:44 -08002165 public boolean getBackgroundDataSetting() {
Jeff Sharkey39c01eb2011-08-16 14:37:57 -07002166 // assume that background data is allowed; final authority is
2167 // NetworkInfo which may be blocked.
2168 return true;
The Android Open Source Project28527d22009-03-03 19:31:44 -08002169 }
2170
2171 /**
2172 * Sets the value of the setting for background data usage.
Robert Greenwalt1b21f6c2010-02-23 18:58:05 -08002173 *
The Android Open Source Project28527d22009-03-03 19:31:44 -08002174 * @param allowBackgroundData Whether an application should use data while
2175 * it is in the background.
Robert Greenwalt1b21f6c2010-02-23 18:58:05 -08002176 *
The Android Open Source Project28527d22009-03-03 19:31:44 -08002177 * @attr ref android.Manifest.permission#CHANGE_BACKGROUND_DATA_SETTING
2178 * @see #getBackgroundDataSetting()
2179 * @hide
2180 */
Jeff Sharkey39c01eb2011-08-16 14:37:57 -07002181 @Deprecated
Mathew Inwood0b8f8612018-08-08 14:52:47 +01002182 @UnsupportedAppUsage
The Android Open Source Project28527d22009-03-03 19:31:44 -08002183 public void setBackgroundDataSetting(boolean allowBackgroundData) {
Jeff Sharkey39c01eb2011-08-16 14:37:57 -07002184 // ignored
The Android Open Source Project28527d22009-03-03 19:31:44 -08002185 }
Robert Greenwalt1b21f6c2010-02-23 18:58:05 -08002186
Jeff Sharkey66fa9682011-08-02 17:22:34 -07002187 /**
Robert Greenwalt1b21f6c2010-02-23 18:58:05 -08002188 * @hide
Robert Greenwalt3d6c9582014-05-21 20:04:36 -07002189 * @deprecated Talk to TelephonyManager directly
Robert Greenwalt1b21f6c2010-02-23 18:58:05 -08002190 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -07002191 @Deprecated
Mathew Inwood0b8f8612018-08-08 14:52:47 +01002192 @UnsupportedAppUsage
Robert Greenwalt1b21f6c2010-02-23 18:58:05 -08002193 public boolean getMobileDataEnabled() {
Meng Wang91311c02019-11-18 17:10:00 -08002194 TelephonyManager tm = mContext.getSystemService(TelephonyManager.class);
2195 if (tm != null) {
2196 int subId = SubscriptionManager.getDefaultDataSubscriptionId();
2197 Log.d("ConnectivityManager", "getMobileDataEnabled()+ subId=" + subId);
2198 boolean retVal = tm.createForSubscriptionId(subId).isDataEnabled();
2199 Log.d("ConnectivityManager", "getMobileDataEnabled()- subId=" + subId
2200 + " retVal=" + retVal);
2201 return retVal;
Robert Greenwalt1b21f6c2010-02-23 18:58:05 -08002202 }
Wink Saville02eb35c2014-12-05 11:10:30 -08002203 Log.d("ConnectivityManager", "getMobileDataEnabled()- remote exception retVal=false");
Robert Greenwalt3d6c9582014-05-21 20:04:36 -07002204 return false;
Robert Greenwalt1b21f6c2010-02-23 18:58:05 -08002205 }
2206
The Android Open Source Project28527d22009-03-03 19:31:44 -08002207 /**
Robert Greenwalt2e4731f2014-09-04 16:44:35 -07002208 * Callback for use with {@link ConnectivityManager#addDefaultNetworkActiveListener}
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07002209 * to find out when the system default network has gone in to a high power state.
Dianne Hackbornb4b09e82014-02-26 16:20:52 -08002210 */
2211 public interface OnNetworkActiveListener {
2212 /**
2213 * Called on the main thread of the process to report that the current data network
2214 * has become active, and it is now a good time to perform any pending network
2215 * operations. Note that this listener only tells you when the network becomes
2216 * active; if at any other time you want to know whether it is active (and thus okay
2217 * to initiate network traffic), you can retrieve its instantaneous state with
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07002218 * {@link ConnectivityManager#isDefaultNetworkActive}.
Dianne Hackbornb4b09e82014-02-26 16:20:52 -08002219 */
Chalard Jean73d9db72018-06-04 16:52:49 +09002220 void onNetworkActive();
Dianne Hackbornb4b09e82014-02-26 16:20:52 -08002221 }
2222
Dianne Hackbornb4b09e82014-02-26 16:20:52 -08002223 private final ArrayMap<OnNetworkActiveListener, INetworkActivityListener>
Chalard Jean73d9db72018-06-04 16:52:49 +09002224 mNetworkActivityListeners = new ArrayMap<>();
Dianne Hackbornb4b09e82014-02-26 16:20:52 -08002225
2226 /**
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07002227 * Start listening to reports when the system's default data network is active, meaning it is
2228 * a good time to perform network traffic. Use {@link #isDefaultNetworkActive()}
2229 * to determine the current state of the system's default network after registering the
2230 * listener.
2231 * <p>
2232 * If the process default network has been set with
Paul Jensen895c3942015-03-10 10:54:12 -04002233 * {@link ConnectivityManager#bindProcessToNetwork} this function will not
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07002234 * reflect the process's default, but the system default.
Dianne Hackbornb4b09e82014-02-26 16:20:52 -08002235 *
2236 * @param l The listener to be told when the network is active.
2237 */
Robert Greenwalt2e4731f2014-09-04 16:44:35 -07002238 public void addDefaultNetworkActiveListener(final OnNetworkActiveListener l) {
Dianne Hackbornb4b09e82014-02-26 16:20:52 -08002239 INetworkActivityListener rl = new INetworkActivityListener.Stub() {
2240 @Override
2241 public void onNetworkActive() throws RemoteException {
2242 l.onNetworkActive();
2243 }
2244 };
2245
2246 try {
lucaslina5e9bdb2021-01-21 02:04:15 +08002247 mService.registerNetworkActivityListener(rl);
Dianne Hackbornb4b09e82014-02-26 16:20:52 -08002248 mNetworkActivityListeners.put(l, rl);
2249 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07002250 throw e.rethrowFromSystemServer();
Dianne Hackbornb4b09e82014-02-26 16:20:52 -08002251 }
2252 }
2253
2254 /**
2255 * Remove network active listener previously registered with
Robert Greenwalt2e4731f2014-09-04 16:44:35 -07002256 * {@link #addDefaultNetworkActiveListener}.
Dianne Hackbornb4b09e82014-02-26 16:20:52 -08002257 *
2258 * @param l Previously registered listener.
2259 */
Chalard Jean42a9c292019-01-07 19:26:34 +09002260 public void removeDefaultNetworkActiveListener(@NonNull OnNetworkActiveListener l) {
Dianne Hackbornb4b09e82014-02-26 16:20:52 -08002261 INetworkActivityListener rl = mNetworkActivityListeners.get(l);
Remi NGUYEN VAN00c531f2021-03-15 07:27:44 +00002262 Preconditions.checkArgument(rl != null, "Listener was not registered.");
Dianne Hackbornb4b09e82014-02-26 16:20:52 -08002263 try {
lucaslina5e9bdb2021-01-21 02:04:15 +08002264 mService.registerNetworkActivityListener(rl);
Dianne Hackbornb4b09e82014-02-26 16:20:52 -08002265 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07002266 throw e.rethrowFromSystemServer();
Dianne Hackbornb4b09e82014-02-26 16:20:52 -08002267 }
2268 }
2269
2270 /**
2271 * Return whether the data network is currently active. An active network means that
2272 * it is currently in a high power state for performing data transmission. On some
2273 * types of networks, it may be expensive to move and stay in such a state, so it is
2274 * more power efficient to batch network traffic together when the radio is already in
2275 * this state. This method tells you whether right now is currently a good time to
2276 * initiate network traffic, as the network is already active.
2277 */
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07002278 public boolean isDefaultNetworkActive() {
Dianne Hackbornb4b09e82014-02-26 16:20:52 -08002279 try {
lucaslina5e9bdb2021-01-21 02:04:15 +08002280 return mService.isDefaultNetworkActive();
Dianne Hackbornb4b09e82014-02-26 16:20:52 -08002281 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07002282 throw e.rethrowFromSystemServer();
Dianne Hackbornb4b09e82014-02-26 16:20:52 -08002283 }
Dianne Hackbornb4b09e82014-02-26 16:20:52 -08002284 }
2285
2286 /**
The Android Open Source Project28527d22009-03-03 19:31:44 -08002287 * {@hide}
2288 */
Lorenzo Colitti9b026fa2015-07-29 11:41:21 +09002289 public ConnectivityManager(Context context, IConnectivityManager service) {
Remi NGUYEN VAN00c531f2021-03-15 07:27:44 +00002290 mContext = Preconditions.checkNotNull(context, "missing context");
2291 mService = Preconditions.checkNotNull(service, "missing IConnectivityManager");
Automerger Merge Worker9b0c0c62020-03-06 00:38:43 +00002292 mTetheringManager = (TetheringManager) mContext.getSystemService(Context.TETHERING_SERVICE);
Paul Jensen12131352014-12-10 15:12:18 -05002293 sInstance = this;
The Android Open Source Project28527d22009-03-03 19:31:44 -08002294 }
Robert Greenwalt0c4828c2010-01-26 11:40:34 -08002295
Jeff Sharkey2d9e5a52012-04-04 20:40:58 -07002296 /** {@hide} */
Mathew Inwood0b8f8612018-08-08 14:52:47 +01002297 @UnsupportedAppUsage
Jeff Sharkey2d9e5a52012-04-04 20:40:58 -07002298 public static ConnectivityManager from(Context context) {
2299 return (ConnectivityManager) context.getSystemService(Context.CONNECTIVITY_SERVICE);
2300 }
2301
Remi NGUYEN VAN1becbe72018-12-27 16:43:56 +09002302 /** @hide */
2303 public NetworkRequest getDefaultRequest() {
2304 try {
2305 // This is not racy as the default request is final in ConnectivityService.
2306 return mService.getDefaultRequest();
2307 } catch (RemoteException e) {
2308 throw e.rethrowFromSystemServer();
2309 }
2310 }
2311
Robert Greenwalt0c4828c2010-01-26 11:40:34 -08002312 /**
Philip P. Moltmannddbcf5b2020-03-24 15:57:49 -07002313 * Check if the package is a allowed to write settings. This also accounts that such an access
2314 * happened.
2315 *
2316 * @return {@code true} iff the package is allowed to write settings.
2317 */
2318 // TODO: Remove method and replace with direct call once R code is pushed to AOSP
2319 private static boolean checkAndNoteWriteSettingsOperation(@NonNull Context context, int uid,
2320 @NonNull String callingPackage, @Nullable String callingAttributionTag,
2321 boolean throwException) {
2322 return Settings.checkAndNoteWriteSettingsOperation(context, uid, callingPackage,
2323 callingAttributionTag, throwException);
2324 }
2325
2326 /**
Paul Jensen12131352014-12-10 15:12:18 -05002327 * @deprecated - use getSystemService. This is a kludge to support static access in certain
2328 * situations where a Context pointer is unavailable.
2329 * @hide
2330 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -07002331 @Deprecated
Paul Jensen895c3942015-03-10 10:54:12 -04002332 static ConnectivityManager getInstanceOrNull() {
2333 return sInstance;
2334 }
2335
2336 /**
2337 * @deprecated - use getSystemService. This is a kludge to support static access in certain
2338 * situations where a Context pointer is unavailable.
2339 * @hide
2340 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -07002341 @Deprecated
Mathew Inwood0b8f8612018-08-08 14:52:47 +01002342 @UnsupportedAppUsage
Paul Jensen895c3942015-03-10 10:54:12 -04002343 private static ConnectivityManager getInstance() {
2344 if (getInstanceOrNull() == null) {
Paul Jensen12131352014-12-10 15:12:18 -05002345 throw new IllegalStateException("No ConnectivityManager yet constructed");
2346 }
Paul Jensen895c3942015-03-10 10:54:12 -04002347 return getInstanceOrNull();
Paul Jensen12131352014-12-10 15:12:18 -05002348 }
2349
2350 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -08002351 * Get the set of tetherable, available interfaces. This list is limited by
2352 * device configuration and current interface existence.
2353 *
2354 * @return an array of 0 or more Strings of tetherable interface names.
2355 *
markchien75721e42020-01-21 13:11:06 +08002356 * @deprecated Use {@link TetheringEventCallback#onTetherableInterfacesChanged(List)} instead.
Robert Greenwalt0c4828c2010-01-26 11:40:34 -08002357 * {@hide}
2358 */
Jeff Sharkey2ac62992017-04-24 11:18:03 -06002359 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Mathew Inwood0b8f8612018-08-08 14:52:47 +01002360 @UnsupportedAppUsage
markchien75721e42020-01-21 13:11:06 +08002361 @Deprecated
Robert Greenwalt0c4828c2010-01-26 11:40:34 -08002362 public String[] getTetherableIfaces() {
Automerger Merge Worker9b0c0c62020-03-06 00:38:43 +00002363 return mTetheringManager.getTetherableIfaces();
Robert Greenwalt0c4828c2010-01-26 11:40:34 -08002364 }
2365
2366 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -08002367 * Get the set of tethered interfaces.
2368 *
2369 * @return an array of 0 or more String of currently tethered interface names.
2370 *
markchien75721e42020-01-21 13:11:06 +08002371 * @deprecated Use {@link TetheringEventCallback#onTetherableInterfacesChanged(List)} instead.
Robert Greenwalt0c4828c2010-01-26 11:40:34 -08002372 * {@hide}
2373 */
Jeff Sharkey2ac62992017-04-24 11:18:03 -06002374 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Mathew Inwood0b8f8612018-08-08 14:52:47 +01002375 @UnsupportedAppUsage
markchien75721e42020-01-21 13:11:06 +08002376 @Deprecated
Robert Greenwalt0c4828c2010-01-26 11:40:34 -08002377 public String[] getTetheredIfaces() {
Automerger Merge Worker9b0c0c62020-03-06 00:38:43 +00002378 return mTetheringManager.getTetheredIfaces();
Robert Greenwalt0c4828c2010-01-26 11:40:34 -08002379 }
2380
2381 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -08002382 * Get the set of interface names which attempted to tether but
2383 * failed. Re-attempting to tether may cause them to reset to the Tethered
2384 * state. Alternatively, causing the interface to be destroyed and recreated
2385 * may cause them to reset to the available state.
2386 * {@link ConnectivityManager#getLastTetherError} can be used to get more
2387 * information on the cause of the errors.
2388 *
2389 * @return an array of 0 or more String indicating the interface names
2390 * which failed to tether.
2391 *
markchien75721e42020-01-21 13:11:06 +08002392 * @deprecated Use {@link TetheringEventCallback#onError(String, int)} instead.
Robert Greenwalt0c4828c2010-01-26 11:40:34 -08002393 * {@hide}
2394 */
Jeff Sharkey2ac62992017-04-24 11:18:03 -06002395 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Mathew Inwood0b8f8612018-08-08 14:52:47 +01002396 @UnsupportedAppUsage
markchien75721e42020-01-21 13:11:06 +08002397 @Deprecated
Robert Greenwalt4283ded2010-03-02 17:25:02 -08002398 public String[] getTetheringErroredIfaces() {
Automerger Merge Worker9b0c0c62020-03-06 00:38:43 +00002399 return mTetheringManager.getTetheringErroredIfaces();
Robert Greenwalt0c4828c2010-01-26 11:40:34 -08002400 }
2401
2402 /**
Robert Greenwalta75c4652014-06-23 14:53:42 -07002403 * Get the set of tethered dhcp ranges.
2404 *
markchien9e046242020-02-06 19:23:26 +08002405 * @deprecated This method is not supported.
2406 * TODO: remove this function when all of clients are removed.
Robert Greenwalta75c4652014-06-23 14:53:42 -07002407 * {@hide}
2408 */
paulhuec0a9632019-08-12 16:25:11 +08002409 @RequiresPermission(android.Manifest.permission.NETWORK_SETTINGS)
markchien75721e42020-01-21 13:11:06 +08002410 @Deprecated
Robert Greenwalta75c4652014-06-23 14:53:42 -07002411 public String[] getTetheredDhcpRanges() {
markchien9e046242020-02-06 19:23:26 +08002412 throw new UnsupportedOperationException("getTetheredDhcpRanges is not supported");
Robert Greenwalta75c4652014-06-23 14:53:42 -07002413 }
2414
2415 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -08002416 * Attempt to tether the named interface. This will setup a dhcp server
2417 * on the interface, forward and NAT IP packets and forward DNS requests
2418 * to the best active upstream network interface. Note that if no upstream
2419 * IP network interface is available, dhcp will still run and traffic will be
2420 * allowed between the tethered devices and this device, though upstream net
2421 * access will of course fail until an upstream network interface becomes
2422 * active.
Lorenzo Colitti91de63b2015-10-15 16:29:00 +09002423 *
2424 * <p>This method requires the caller to hold either the
2425 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
2426 * or the ability to modify system settings as determined by
2427 * {@link android.provider.Settings.System#canWrite}.</p>
Robert Greenwalt26744a52013-02-15 10:56:35 -08002428 *
Jeremy Klein9a36ec82016-01-22 14:11:45 -08002429 * <p>WARNING: New clients should not use this function. The only usages should be in PanService
2430 * and WifiStateMachine which need direct access. All other clients should use
2431 * {@link #startTethering} and {@link #stopTethering} which encapsulate proper provisioning
2432 * logic.</p>
2433 *
Robert Greenwalt26744a52013-02-15 10:56:35 -08002434 * @param iface the interface name to tether.
2435 * @return error a {@code TETHER_ERROR} value indicating success or failure type
markchien10ddd022020-01-20 19:31:56 +08002436 * @deprecated Use {@link TetheringManager#startTethering} instead
Robert Greenwalt26744a52013-02-15 10:56:35 -08002437 *
Robert Greenwalt0c4828c2010-01-26 11:40:34 -08002438 * {@hide}
2439 */
Mathew Inwoodd078d3d2020-10-27 11:47:29 +00002440 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
markchien10ddd022020-01-20 19:31:56 +08002441 @Deprecated
Robert Greenwalt4283ded2010-03-02 17:25:02 -08002442 public int tether(String iface) {
Automerger Merge Worker9b0c0c62020-03-06 00:38:43 +00002443 return mTetheringManager.tether(iface);
Robert Greenwalt4283ded2010-03-02 17:25:02 -08002444 }
2445
2446 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -08002447 * Stop tethering the named interface.
Lorenzo Colitti91de63b2015-10-15 16:29:00 +09002448 *
2449 * <p>This method requires the caller to hold either the
2450 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
2451 * or the ability to modify system settings as determined by
2452 * {@link android.provider.Settings.System#canWrite}.</p>
Robert Greenwalt26744a52013-02-15 10:56:35 -08002453 *
Jeremy Klein9a36ec82016-01-22 14:11:45 -08002454 * <p>WARNING: New clients should not use this function. The only usages should be in PanService
2455 * and WifiStateMachine which need direct access. All other clients should use
2456 * {@link #startTethering} and {@link #stopTethering} which encapsulate proper provisioning
2457 * logic.</p>
2458 *
Robert Greenwalt26744a52013-02-15 10:56:35 -08002459 * @param iface the interface name to untether.
2460 * @return error a {@code TETHER_ERROR} value indicating success or failure type
2461 *
Robert Greenwalt4283ded2010-03-02 17:25:02 -08002462 * {@hide}
2463 */
Mathew Inwood0b8f8612018-08-08 14:52:47 +01002464 @UnsupportedAppUsage
markchien75721e42020-01-21 13:11:06 +08002465 @Deprecated
Robert Greenwalt4283ded2010-03-02 17:25:02 -08002466 public int untether(String iface) {
Automerger Merge Worker9b0c0c62020-03-06 00:38:43 +00002467 return mTetheringManager.untether(iface);
Robert Greenwalt0c4828c2010-01-26 11:40:34 -08002468 }
Robert Greenwalt8e87f122010-02-11 18:18:40 -08002469
2470 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -08002471 * Check if the device allows for tethering. It may be disabled via
Dianne Hackbornb4b09e82014-02-26 16:20:52 -08002472 * {@code ro.tether.denied} system property, Settings.TETHER_SUPPORTED or
Robert Greenwalt26744a52013-02-15 10:56:35 -08002473 * due to device configuration.
2474 *
Chalard Jean4e1bb722017-09-26 15:45:18 +09002475 * <p>If this app does not have permission to use this API, it will always
2476 * return false rather than throw an exception.</p>
2477 *
2478 * <p>If the device has a hotspot provisioning app, the caller is required to hold the
2479 * {@link android.Manifest.permission.TETHER_PRIVILEGED} permission.</p>
2480 *
2481 * <p>Otherwise, this method requires the caller to hold the ability to modify system
2482 * settings as determined by {@link android.provider.Settings.System#canWrite}.</p>
2483 *
Robert Greenwalt26744a52013-02-15 10:56:35 -08002484 * @return a boolean - {@code true} indicating Tethering is supported.
2485 *
markchien75721e42020-01-21 13:11:06 +08002486 * @deprecated Use {@link TetheringEventCallback#onTetheringSupported(boolean)} instead.
Robert Greenwalt8e87f122010-02-11 18:18:40 -08002487 * {@hide}
2488 */
Jeremy Klein9a36ec82016-01-22 14:11:45 -08002489 @SystemApi
Chalard Jean4e1bb722017-09-26 15:45:18 +09002490 @RequiresPermission(anyOf = {android.Manifest.permission.TETHER_PRIVILEGED,
2491 android.Manifest.permission.WRITE_SETTINGS})
Robert Greenwalt8e87f122010-02-11 18:18:40 -08002492 public boolean isTetheringSupported() {
Automerger Merge Worker9b0c0c62020-03-06 00:38:43 +00002493 return mTetheringManager.isTetheringSupported();
Robert Greenwalt8e87f122010-02-11 18:18:40 -08002494 }
2495
2496 /**
Jeremy Klein9a36ec82016-01-22 14:11:45 -08002497 * Callback for use with {@link #startTethering} to find out whether tethering succeeded.
markchien10ddd022020-01-20 19:31:56 +08002498 *
2499 * @deprecated Use {@link TetheringManager.StartTetheringCallback} instead.
Jeremy Klein9a36ec82016-01-22 14:11:45 -08002500 * @hide
2501 */
2502 @SystemApi
markchien10ddd022020-01-20 19:31:56 +08002503 @Deprecated
Jeremy Klein9a36ec82016-01-22 14:11:45 -08002504 public static abstract class OnStartTetheringCallback {
2505 /**
2506 * Called when tethering has been successfully started.
2507 */
Chalard Jean73d9db72018-06-04 16:52:49 +09002508 public void onTetheringStarted() {}
Jeremy Klein9a36ec82016-01-22 14:11:45 -08002509
2510 /**
2511 * Called when starting tethering failed.
2512 */
Chalard Jean73d9db72018-06-04 16:52:49 +09002513 public void onTetheringFailed() {}
Jeremy Klein9a36ec82016-01-22 14:11:45 -08002514 }
2515
2516 /**
2517 * Convenient overload for
2518 * {@link #startTethering(int, boolean, OnStartTetheringCallback, Handler)} which passes a null
2519 * handler to run on the current thread's {@link Looper}.
markchien10ddd022020-01-20 19:31:56 +08002520 *
2521 * @deprecated Use {@link TetheringManager#startTethering} instead.
Jeremy Klein9a36ec82016-01-22 14:11:45 -08002522 * @hide
2523 */
2524 @SystemApi
markchien10ddd022020-01-20 19:31:56 +08002525 @Deprecated
Udam Saini15072332017-06-07 12:06:28 -07002526 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
Jeremy Klein9a36ec82016-01-22 14:11:45 -08002527 public void startTethering(int type, boolean showProvisioningUi,
2528 final OnStartTetheringCallback callback) {
2529 startTethering(type, showProvisioningUi, callback, null);
2530 }
2531
2532 /**
2533 * Runs tether provisioning for the given type if needed and then starts tethering if
2534 * the check succeeds. If no carrier provisioning is required for tethering, tethering is
2535 * enabled immediately. If provisioning fails, tethering will not be enabled. It also
2536 * schedules tether provisioning re-checks if appropriate.
2537 *
2538 * @param type The type of tethering to start. Must be one of
2539 * {@link ConnectivityManager.TETHERING_WIFI},
2540 * {@link ConnectivityManager.TETHERING_USB}, or
2541 * {@link ConnectivityManager.TETHERING_BLUETOOTH}.
2542 * @param showProvisioningUi a boolean indicating to show the provisioning app UI if there
2543 * is one. This should be true the first time this function is called and also any time
2544 * the user can see this UI. It gives users information from their carrier about the
2545 * check failing and how they can sign up for tethering if possible.
2546 * @param callback an {@link OnStartTetheringCallback} which will be called to notify the caller
2547 * of the result of trying to tether.
2548 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
markchien10ddd022020-01-20 19:31:56 +08002549 *
2550 * @deprecated Use {@link TetheringManager#startTethering} instead.
Jeremy Klein9a36ec82016-01-22 14:11:45 -08002551 * @hide
2552 */
2553 @SystemApi
markchien10ddd022020-01-20 19:31:56 +08002554 @Deprecated
Jeff Sharkeyb8c73032017-06-02 17:36:26 -06002555 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
Jeremy Klein9a36ec82016-01-22 14:11:45 -08002556 public void startTethering(int type, boolean showProvisioningUi,
2557 final OnStartTetheringCallback callback, Handler handler) {
Remi NGUYEN VAN00c531f2021-03-15 07:27:44 +00002558 Preconditions.checkNotNull(callback, "OnStartTetheringCallback cannot be null.");
Jeremy Klein49a57952016-03-12 16:29:54 -08002559
markchien10ddd022020-01-20 19:31:56 +08002560 final Executor executor = new Executor() {
Jeremy Klein9a36ec82016-01-22 14:11:45 -08002561 @Override
markchien10ddd022020-01-20 19:31:56 +08002562 public void execute(Runnable command) {
2563 if (handler == null) {
2564 command.run();
Jeremy Klein9a36ec82016-01-22 14:11:45 -08002565 } else {
markchien10ddd022020-01-20 19:31:56 +08002566 handler.post(command);
Jeremy Klein9a36ec82016-01-22 14:11:45 -08002567 }
2568 }
2569 };
Jeremy Klein49a57952016-03-12 16:29:54 -08002570
markchien10ddd022020-01-20 19:31:56 +08002571 final StartTetheringCallback tetheringCallback = new StartTetheringCallback() {
2572 @Override
2573 public void onTetheringStarted() {
2574 callback.onTetheringStarted();
2575 }
2576
2577 @Override
markchien68b67842020-03-19 13:37:43 +08002578 public void onTetheringFailed(final int error) {
markchien10ddd022020-01-20 19:31:56 +08002579 callback.onTetheringFailed();
2580 }
2581 };
2582
2583 final TetheringRequest request = new TetheringRequest.Builder(type)
markchien68b67842020-03-19 13:37:43 +08002584 .setShouldShowEntitlementUi(showProvisioningUi).build();
markchien10ddd022020-01-20 19:31:56 +08002585
Automerger Merge Worker9b0c0c62020-03-06 00:38:43 +00002586 mTetheringManager.startTethering(request, executor, tetheringCallback);
Jeremy Klein9a36ec82016-01-22 14:11:45 -08002587 }
2588
2589 /**
2590 * Stops tethering for the given type. Also cancels any provisioning rechecks for that type if
2591 * applicable.
2592 *
2593 * @param type The type of tethering to stop. Must be one of
2594 * {@link ConnectivityManager.TETHERING_WIFI},
2595 * {@link ConnectivityManager.TETHERING_USB}, or
2596 * {@link ConnectivityManager.TETHERING_BLUETOOTH}.
markchien75721e42020-01-21 13:11:06 +08002597 *
2598 * @deprecated Use {@link TetheringManager#stopTethering} instead.
Jeremy Klein9a36ec82016-01-22 14:11:45 -08002599 * @hide
2600 */
2601 @SystemApi
markchien75721e42020-01-21 13:11:06 +08002602 @Deprecated
Jeff Sharkeyb8c73032017-06-02 17:36:26 -06002603 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
Jeremy Klein9a36ec82016-01-22 14:11:45 -08002604 public void stopTethering(int type) {
Automerger Merge Worker9b0c0c62020-03-06 00:38:43 +00002605 mTetheringManager.stopTethering(type);
Jeremy Klein9a36ec82016-01-22 14:11:45 -08002606 }
2607
2608 /**
markchiena005c992019-02-27 14:56:11 +08002609 * Callback for use with {@link registerTetheringEventCallback} to find out tethering
2610 * upstream status.
2611 *
Nathan Haroldf6fc8ab2020-01-23 18:03:46 -08002612 * @deprecated Use {@link TetheringManager#OnTetheringEventCallback} instead.
markchien75721e42020-01-21 13:11:06 +08002613 * @hide
markchiena005c992019-02-27 14:56:11 +08002614 */
2615 @SystemApi
markchien75721e42020-01-21 13:11:06 +08002616 @Deprecated
markchiena005c992019-02-27 14:56:11 +08002617 public abstract static class OnTetheringEventCallback {
2618
2619 /**
2620 * Called when tethering upstream changed. This can be called multiple times and can be
2621 * called any time.
2622 *
2623 * @param network the {@link Network} of tethering upstream. Null means tethering doesn't
2624 * have any upstream.
2625 */
2626 public void onUpstreamChanged(@Nullable Network network) {}
2627 }
2628
markchien75721e42020-01-21 13:11:06 +08002629 @GuardedBy("mTetheringEventCallbacks")
2630 private final ArrayMap<OnTetheringEventCallback, TetheringEventCallback>
2631 mTetheringEventCallbacks = new ArrayMap<>();
2632
markchiena005c992019-02-27 14:56:11 +08002633 /**
2634 * Start listening to tethering change events. Any new added callback will receive the last
markchiend378cd32019-04-03 10:43:09 +08002635 * tethering status right away. If callback is registered when tethering has no upstream or
markchiena005c992019-02-27 14:56:11 +08002636 * disabled, {@link OnTetheringEventCallback#onUpstreamChanged} will immediately be called
2637 * with a null argument. The same callback object cannot be registered twice.
2638 *
2639 * @param executor the executor on which callback will be invoked.
2640 * @param callback the callback to be called when tethering has change events.
markchien75721e42020-01-21 13:11:06 +08002641 *
Nathan Haroldf6fc8ab2020-01-23 18:03:46 -08002642 * @deprecated Use {@link TetheringManager#registerTetheringEventCallback} instead.
markchiena005c992019-02-27 14:56:11 +08002643 * @hide
2644 */
2645 @SystemApi
markchien75721e42020-01-21 13:11:06 +08002646 @Deprecated
markchiena005c992019-02-27 14:56:11 +08002647 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
2648 public void registerTetheringEventCallback(
2649 @NonNull @CallbackExecutor Executor executor,
2650 @NonNull final OnTetheringEventCallback callback) {
Remi NGUYEN VAN00c531f2021-03-15 07:27:44 +00002651 Preconditions.checkNotNull(callback, "OnTetheringEventCallback cannot be null.");
markchiena005c992019-02-27 14:56:11 +08002652
markchien75721e42020-01-21 13:11:06 +08002653 final TetheringEventCallback tetherCallback =
2654 new TetheringEventCallback() {
2655 @Override
2656 public void onUpstreamChanged(@Nullable Network network) {
2657 callback.onUpstreamChanged(network);
2658 }
2659 };
2660
2661 synchronized (mTetheringEventCallbacks) {
2662 mTetheringEventCallbacks.put(callback, tetherCallback);
Automerger Merge Worker9b0c0c62020-03-06 00:38:43 +00002663 mTetheringManager.registerTetheringEventCallback(executor, tetherCallback);
markchien75721e42020-01-21 13:11:06 +08002664 }
markchiena005c992019-02-27 14:56:11 +08002665 }
2666
2667 /**
2668 * Remove tethering event callback previously registered with
2669 * {@link #registerTetheringEventCallback}.
2670 *
2671 * @param callback previously registered callback.
markchien75721e42020-01-21 13:11:06 +08002672 *
2673 * @deprecated Use {@link TetheringManager#unregisterTetheringEventCallback} instead.
markchiena005c992019-02-27 14:56:11 +08002674 * @hide
2675 */
2676 @SystemApi
markchien75721e42020-01-21 13:11:06 +08002677 @Deprecated
markchiena005c992019-02-27 14:56:11 +08002678 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
2679 public void unregisterTetheringEventCallback(
2680 @NonNull final OnTetheringEventCallback callback) {
markchien75721e42020-01-21 13:11:06 +08002681 Objects.requireNonNull(callback, "The callback must be non-null");
2682 synchronized (mTetheringEventCallbacks) {
2683 final TetheringEventCallback tetherCallback =
2684 mTetheringEventCallbacks.remove(callback);
Automerger Merge Worker9b0c0c62020-03-06 00:38:43 +00002685 mTetheringManager.unregisterTetheringEventCallback(tetherCallback);
markchien75721e42020-01-21 13:11:06 +08002686 }
markchiena005c992019-02-27 14:56:11 +08002687 }
2688
2689
2690 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -08002691 * Get the list of regular expressions that define any tetherable
2692 * USB network interfaces. If USB tethering is not supported by the
2693 * device, this list should be empty.
2694 *
2695 * @return an array of 0 or more regular expression Strings defining
2696 * what interfaces are considered tetherable usb interfaces.
2697 *
markchien75721e42020-01-21 13:11:06 +08002698 * @deprecated Use {@link TetheringEventCallback#onTetherableInterfaceRegexpsChanged} instead.
Robert Greenwalt8e87f122010-02-11 18:18:40 -08002699 * {@hide}
2700 */
Jeff Sharkey2ac62992017-04-24 11:18:03 -06002701 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Mathew Inwood0b8f8612018-08-08 14:52:47 +01002702 @UnsupportedAppUsage
markchien75721e42020-01-21 13:11:06 +08002703 @Deprecated
Robert Greenwalt8e87f122010-02-11 18:18:40 -08002704 public String[] getTetherableUsbRegexs() {
Automerger Merge Worker9b0c0c62020-03-06 00:38:43 +00002705 return mTetheringManager.getTetherableUsbRegexs();
Robert Greenwalt8e87f122010-02-11 18:18:40 -08002706 }
2707
2708 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -08002709 * Get the list of regular expressions that define any tetherable
2710 * Wifi network interfaces. If Wifi tethering is not supported by the
2711 * device, this list should be empty.
2712 *
2713 * @return an array of 0 or more regular expression Strings defining
2714 * what interfaces are considered tetherable wifi interfaces.
2715 *
markchien75721e42020-01-21 13:11:06 +08002716 * @deprecated Use {@link TetheringEventCallback#onTetherableInterfaceRegexpsChanged} instead.
Robert Greenwalt8e87f122010-02-11 18:18:40 -08002717 * {@hide}
2718 */
Jeff Sharkey2ac62992017-04-24 11:18:03 -06002719 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Mathew Inwood0b8f8612018-08-08 14:52:47 +01002720 @UnsupportedAppUsage
markchien75721e42020-01-21 13:11:06 +08002721 @Deprecated
Robert Greenwalt8e87f122010-02-11 18:18:40 -08002722 public String[] getTetherableWifiRegexs() {
Automerger Merge Worker9b0c0c62020-03-06 00:38:43 +00002723 return mTetheringManager.getTetherableWifiRegexs();
Robert Greenwalt8e87f122010-02-11 18:18:40 -08002724 }
Robert Greenwalt4283ded2010-03-02 17:25:02 -08002725
Danica Chang96567052010-08-11 14:54:43 -07002726 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -08002727 * Get the list of regular expressions that define any tetherable
2728 * Bluetooth network interfaces. If Bluetooth tethering is not supported by the
2729 * device, this list should be empty.
2730 *
2731 * @return an array of 0 or more regular expression Strings defining
2732 * what interfaces are considered tetherable bluetooth interfaces.
2733 *
markchien75721e42020-01-21 13:11:06 +08002734 * @deprecated Use {@link TetheringEventCallback#onTetherableInterfaceRegexpsChanged(
2735 *TetheringManager.TetheringInterfaceRegexps)} instead.
Danica Chang96567052010-08-11 14:54:43 -07002736 * {@hide}
2737 */
Jeff Sharkey2ac62992017-04-24 11:18:03 -06002738 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Mathew Inwood0b8f8612018-08-08 14:52:47 +01002739 @UnsupportedAppUsage
markchien75721e42020-01-21 13:11:06 +08002740 @Deprecated
Danica Chang96567052010-08-11 14:54:43 -07002741 public String[] getTetherableBluetoothRegexs() {
Automerger Merge Worker9b0c0c62020-03-06 00:38:43 +00002742 return mTetheringManager.getTetherableBluetoothRegexs();
Danica Chang96567052010-08-11 14:54:43 -07002743 }
2744
Mike Lockwooded4a1742011-07-19 13:04:47 -07002745 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -08002746 * Attempt to both alter the mode of USB and Tethering of USB. A
2747 * utility method to deal with some of the complexity of USB - will
2748 * attempt to switch to Rndis and subsequently tether the resulting
2749 * interface on {@code true} or turn off tethering and switch off
2750 * Rndis on {@code false}.
Lorenzo Colitti91de63b2015-10-15 16:29:00 +09002751 *
2752 * <p>This method requires the caller to hold either the
2753 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
2754 * or the ability to modify system settings as determined by
2755 * {@link android.provider.Settings.System#canWrite}.</p>
Robert Greenwalt26744a52013-02-15 10:56:35 -08002756 *
2757 * @param enable a boolean - {@code true} to enable tethering
2758 * @return error a {@code TETHER_ERROR} value indicating success or failure type
markchien10ddd022020-01-20 19:31:56 +08002759 * @deprecated Use {@link TetheringManager#startTethering} instead
Robert Greenwalt26744a52013-02-15 10:56:35 -08002760 *
Mike Lockwooded4a1742011-07-19 13:04:47 -07002761 * {@hide}
2762 */
Mathew Inwood0b8f8612018-08-08 14:52:47 +01002763 @UnsupportedAppUsage
markchien10ddd022020-01-20 19:31:56 +08002764 @Deprecated
Mike Lockwooded4a1742011-07-19 13:04:47 -07002765 public int setUsbTethering(boolean enable) {
Automerger Merge Worker9b0c0c62020-03-06 00:38:43 +00002766 return mTetheringManager.setUsbTethering(enable);
Mike Lockwooded4a1742011-07-19 13:04:47 -07002767 }
2768
markchien75721e42020-01-21 13:11:06 +08002769 /**
2770 * @deprecated Use {@link TetheringManager#TETHER_ERROR_NO_ERROR}.
2771 * {@hide}
2772 */
markchien5bd499c2019-01-16 17:44:13 +08002773 @SystemApi
markchien75721e42020-01-21 13:11:06 +08002774 @Deprecated
Remi NGUYEN VAN23b853b2021-02-15 18:52:06 +09002775 public static final int TETHER_ERROR_NO_ERROR = 0;
markchien75721e42020-01-21 13:11:06 +08002776 /**
2777 * @deprecated Use {@link TetheringManager#TETHER_ERROR_UNKNOWN_IFACE}.
2778 * {@hide}
2779 */
2780 @Deprecated
2781 public static final int TETHER_ERROR_UNKNOWN_IFACE =
2782 TetheringManager.TETHER_ERROR_UNKNOWN_IFACE;
2783 /**
2784 * @deprecated Use {@link TetheringManager#TETHER_ERROR_SERVICE_UNAVAIL}.
2785 * {@hide}
2786 */
2787 @Deprecated
2788 public static final int TETHER_ERROR_SERVICE_UNAVAIL =
2789 TetheringManager.TETHER_ERROR_SERVICE_UNAVAIL;
2790 /**
2791 * @deprecated Use {@link TetheringManager#TETHER_ERROR_UNSUPPORTED}.
2792 * {@hide}
2793 */
2794 @Deprecated
2795 public static final int TETHER_ERROR_UNSUPPORTED = TetheringManager.TETHER_ERROR_UNSUPPORTED;
2796 /**
2797 * @deprecated Use {@link TetheringManager#TETHER_ERROR_UNAVAIL_IFACE}.
2798 * {@hide}
2799 */
2800 @Deprecated
2801 public static final int TETHER_ERROR_UNAVAIL_IFACE =
2802 TetheringManager.TETHER_ERROR_UNAVAIL_IFACE;
2803 /**
markchien68b67842020-03-19 13:37:43 +08002804 * @deprecated Use {@link TetheringManager#TETHER_ERROR_INTERNAL_ERROR}.
markchien75721e42020-01-21 13:11:06 +08002805 * {@hide}
2806 */
2807 @Deprecated
markchien68b67842020-03-19 13:37:43 +08002808 public static final int TETHER_ERROR_MASTER_ERROR =
2809 TetheringManager.TETHER_ERROR_INTERNAL_ERROR;
markchien75721e42020-01-21 13:11:06 +08002810 /**
2811 * @deprecated Use {@link TetheringManager#TETHER_ERROR_TETHER_IFACE_ERROR}.
2812 * {@hide}
2813 */
2814 @Deprecated
2815 public static final int TETHER_ERROR_TETHER_IFACE_ERROR =
2816 TetheringManager.TETHER_ERROR_TETHER_IFACE_ERROR;
2817 /**
2818 * @deprecated Use {@link TetheringManager#TETHER_ERROR_UNTETHER_IFACE_ERROR}.
2819 * {@hide}
2820 */
2821 @Deprecated
2822 public static final int TETHER_ERROR_UNTETHER_IFACE_ERROR =
2823 TetheringManager.TETHER_ERROR_UNTETHER_IFACE_ERROR;
2824 /**
markchien68b67842020-03-19 13:37:43 +08002825 * @deprecated Use {@link TetheringManager#TETHER_ERROR_ENABLE_FORWARDING_ERROR}.
markchien75721e42020-01-21 13:11:06 +08002826 * {@hide}
2827 */
2828 @Deprecated
2829 public static final int TETHER_ERROR_ENABLE_NAT_ERROR =
markchien68b67842020-03-19 13:37:43 +08002830 TetheringManager.TETHER_ERROR_ENABLE_FORWARDING_ERROR;
markchien75721e42020-01-21 13:11:06 +08002831 /**
markchien68b67842020-03-19 13:37:43 +08002832 * @deprecated Use {@link TetheringManager#TETHER_ERROR_DISABLE_FORWARDING_ERROR}.
markchien75721e42020-01-21 13:11:06 +08002833 * {@hide}
2834 */
2835 @Deprecated
2836 public static final int TETHER_ERROR_DISABLE_NAT_ERROR =
markchien68b67842020-03-19 13:37:43 +08002837 TetheringManager.TETHER_ERROR_DISABLE_FORWARDING_ERROR;
markchien75721e42020-01-21 13:11:06 +08002838 /**
2839 * @deprecated Use {@link TetheringManager#TETHER_ERROR_IFACE_CFG_ERROR}.
2840 * {@hide}
2841 */
2842 @Deprecated
2843 public static final int TETHER_ERROR_IFACE_CFG_ERROR =
2844 TetheringManager.TETHER_ERROR_IFACE_CFG_ERROR;
2845 /**
markchien68b67842020-03-19 13:37:43 +08002846 * @deprecated Use {@link TetheringManager#TETHER_ERROR_PROVISIONING_FAILED}.
markchien75721e42020-01-21 13:11:06 +08002847 * {@hide}
2848 */
markchien5bd499c2019-01-16 17:44:13 +08002849 @SystemApi
markchien75721e42020-01-21 13:11:06 +08002850 @Deprecated
Remi NGUYEN VAN23b853b2021-02-15 18:52:06 +09002851 public static final int TETHER_ERROR_PROVISION_FAILED = 11;
markchien75721e42020-01-21 13:11:06 +08002852 /**
2853 * @deprecated Use {@link TetheringManager#TETHER_ERROR_DHCPSERVER_ERROR}.
2854 * {@hide}
2855 */
2856 @Deprecated
2857 public static final int TETHER_ERROR_DHCPSERVER_ERROR =
2858 TetheringManager.TETHER_ERROR_DHCPSERVER_ERROR;
2859 /**
2860 * @deprecated Use {@link TetheringManager#TETHER_ERROR_ENTITLEMENT_UNKNOWN}.
2861 * {@hide}
2862 */
markchien5bd499c2019-01-16 17:44:13 +08002863 @SystemApi
markchien75721e42020-01-21 13:11:06 +08002864 @Deprecated
Remi NGUYEN VAN23b853b2021-02-15 18:52:06 +09002865 public static final int TETHER_ERROR_ENTITLEMENT_UNKONWN = 13;
Robert Greenwalt4283ded2010-03-02 17:25:02 -08002866
2867 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -08002868 * Get a more detailed error code after a Tethering or Untethering
2869 * request asynchronously failed.
2870 *
2871 * @param iface The name of the interface of interest
Robert Greenwalt4283ded2010-03-02 17:25:02 -08002872 * @return error The error code of the last error tethering or untethering the named
2873 * interface
Robert Greenwalt26744a52013-02-15 10:56:35 -08002874 *
markchien75721e42020-01-21 13:11:06 +08002875 * @deprecated Use {@link TetheringEventCallback#onError(String, int)} instead.
Robert Greenwalt4283ded2010-03-02 17:25:02 -08002876 * {@hide}
2877 */
Jeff Sharkey2ac62992017-04-24 11:18:03 -06002878 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Mathew Inwoodd078d3d2020-10-27 11:47:29 +00002879 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
markchien75721e42020-01-21 13:11:06 +08002880 @Deprecated
Robert Greenwalt4283ded2010-03-02 17:25:02 -08002881 public int getLastTetherError(String iface) {
markchien68b67842020-03-19 13:37:43 +08002882 int error = mTetheringManager.getLastTetherError(iface);
2883 if (error == TetheringManager.TETHER_ERROR_UNKNOWN_TYPE) {
2884 // TETHER_ERROR_UNKNOWN_TYPE was introduced with TetheringManager and has never been
2885 // returned by ConnectivityManager. Convert it to the legacy TETHER_ERROR_UNKNOWN_IFACE
2886 // instead.
2887 error = TetheringManager.TETHER_ERROR_UNKNOWN_IFACE;
2888 }
2889 return error;
Robert Greenwalt93dc1042010-06-15 12:19:37 -07002890 }
2891
markchiendd41c822019-03-06 16:25:00 +08002892 /** @hide */
2893 @Retention(RetentionPolicy.SOURCE)
2894 @IntDef(value = {
2895 TETHER_ERROR_NO_ERROR,
2896 TETHER_ERROR_PROVISION_FAILED,
2897 TETHER_ERROR_ENTITLEMENT_UNKONWN,
2898 })
2899 public @interface EntitlementResultCode {
2900 }
2901
Robert Greenwalt93dc1042010-06-15 12:19:37 -07002902 /**
markchiendd41c822019-03-06 16:25:00 +08002903 * Callback for use with {@link #getLatestTetheringEntitlementResult} to find out whether
markchien5bd499c2019-01-16 17:44:13 +08002904 * entitlement succeeded.
markchien75721e42020-01-21 13:11:06 +08002905 *
2906 * @deprecated Use {@link TetheringManager#OnTetheringEntitlementResultListener} instead.
markchien5bd499c2019-01-16 17:44:13 +08002907 * @hide
2908 */
2909 @SystemApi
markchien75721e42020-01-21 13:11:06 +08002910 @Deprecated
markchiendd41c822019-03-06 16:25:00 +08002911 public interface OnTetheringEntitlementResultListener {
2912 /**
2913 * Called to notify entitlement result.
2914 *
2915 * @param resultCode an int value of entitlement result. It may be one of
2916 * {@link #TETHER_ERROR_NO_ERROR},
2917 * {@link #TETHER_ERROR_PROVISION_FAILED}, or
2918 * {@link #TETHER_ERROR_ENTITLEMENT_UNKONWN}.
2919 */
Jeremy Kleina9aad902019-03-12 13:32:08 -07002920 void onTetheringEntitlementResult(@EntitlementResultCode int resultCode);
markchiendd41c822019-03-06 16:25:00 +08002921 }
2922
2923 /**
markchien5bd499c2019-01-16 17:44:13 +08002924 * Get the last value of the entitlement check on this downstream. If the cached value is
2925 * {@link #TETHER_ERROR_NO_ERROR} or showEntitlementUi argument is false, it just return the
2926 * cached value. Otherwise, a UI-based entitlement check would be performed. It is not
2927 * guaranteed that the UI-based entitlement check will complete in any specific time period
2928 * and may in fact never complete. Any successful entitlement check the platform performs for
2929 * any reason will update the cached value.
2930 *
2931 * @param type the downstream type of tethering. Must be one of
2932 * {@link #TETHERING_WIFI},
2933 * {@link #TETHERING_USB}, or
2934 * {@link #TETHERING_BLUETOOTH}.
2935 * @param showEntitlementUi a boolean indicating whether to run UI-based entitlement check.
markchiendd41c822019-03-06 16:25:00 +08002936 * @param executor the executor on which callback will be invoked.
2937 * @param listener an {@link OnTetheringEntitlementResultListener} which will be called to
2938 * notify the caller of the result of entitlement check. The listener may be called zero
2939 * or one time.
markchien75721e42020-01-21 13:11:06 +08002940 * @deprecated Use {@link TetheringManager#requestLatestTetheringEntitlementResult} instead.
markchien5bd499c2019-01-16 17:44:13 +08002941 * {@hide}
2942 */
2943 @SystemApi
markchien75721e42020-01-21 13:11:06 +08002944 @Deprecated
markchien5bd499c2019-01-16 17:44:13 +08002945 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
markchiendd41c822019-03-06 16:25:00 +08002946 public void getLatestTetheringEntitlementResult(int type, boolean showEntitlementUi,
2947 @NonNull @CallbackExecutor Executor executor,
2948 @NonNull final OnTetheringEntitlementResultListener listener) {
Remi NGUYEN VAN00c531f2021-03-15 07:27:44 +00002949 Preconditions.checkNotNull(listener, "TetheringEntitlementResultListener cannot be null.");
markchiendd41c822019-03-06 16:25:00 +08002950 ResultReceiver wrappedListener = new ResultReceiver(null) {
2951 @Override
2952 protected void onReceiveResult(int resultCode, Bundle resultData) {
lucaslin9cc04192021-03-04 09:38:21 +08002953 final long token = Binder.clearCallingIdentity();
2954 try {
2955 executor.execute(() -> {
2956 listener.onTetheringEntitlementResult(resultCode);
2957 });
2958 } finally {
2959 Binder.restoreCallingIdentity(token);
2960 }
markchiendd41c822019-03-06 16:25:00 +08002961 }
2962 };
2963
Automerger Merge Worker9b0c0c62020-03-06 00:38:43 +00002964 mTetheringManager.requestLatestTetheringEntitlementResult(type, wrappedListener,
markchienb0bb7862019-12-16 20:15:20 +08002965 showEntitlementUi);
markchiendd41c822019-03-06 16:25:00 +08002966 }
2967
2968 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -08002969 * Report network connectivity status. This is currently used only
2970 * to alter status bar UI.
Paul Jensen19b3ee72015-05-06 11:10:18 -04002971 * <p>This method requires the caller to hold the permission
2972 * {@link android.Manifest.permission#STATUS_BAR}.
Robert Greenwalt26744a52013-02-15 10:56:35 -08002973 *
Robert Greenwalt986c7412010-09-08 15:24:47 -07002974 * @param networkType The type of network you want to report on
2975 * @param percentage The quality of the connection 0 is bad, 100 is good
Chalard Jean5acb7b72018-03-08 13:54:53 +09002976 * @deprecated Types are deprecated. Use {@link #reportNetworkConnectivity} instead.
Robert Greenwalt986c7412010-09-08 15:24:47 -07002977 * {@hide}
2978 */
2979 public void reportInetCondition(int networkType, int percentage) {
Soi, Yoshinari99efcbd2015-11-12 12:09:02 +09002980 printStackTrace();
Robert Greenwalt986c7412010-09-08 15:24:47 -07002981 try {
2982 mService.reportInetCondition(networkType, percentage);
2983 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07002984 throw e.rethrowFromSystemServer();
Robert Greenwalt986c7412010-09-08 15:24:47 -07002985 }
2986 }
Robert Greenwaltc3c5f862010-10-11 16:00:27 -07002987
2988 /**
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07002989 * Report a problem network to the framework. This provides a hint to the system
Ye Wen849c72a2014-07-21 14:19:01 -07002990 * that there might be connectivity problems on this network and may cause
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07002991 * the framework to re-evaluate network connectivity and/or switch to another
2992 * network.
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07002993 *
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07002994 * @param network The {@link Network} the application was attempting to use
2995 * or {@code null} to indicate the current default network.
Paul Jensen7aac1b32015-04-07 12:43:13 -04002996 * @deprecated Use {@link #reportNetworkConnectivity} which allows reporting both
2997 * working and non-working connectivity.
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07002998 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -07002999 @Deprecated
Chalard Jean42a9c292019-01-07 19:26:34 +09003000 public void reportBadNetwork(@Nullable Network network) {
Soi, Yoshinari99efcbd2015-11-12 12:09:02 +09003001 printStackTrace();
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003002 try {
Paul Jensen7aac1b32015-04-07 12:43:13 -04003003 // One of these will be ignored because it matches system's current state.
3004 // The other will trigger the necessary reevaluation.
3005 mService.reportNetworkConnectivity(network, true);
3006 mService.reportNetworkConnectivity(network, false);
3007 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07003008 throw e.rethrowFromSystemServer();
Paul Jensen7aac1b32015-04-07 12:43:13 -04003009 }
3010 }
3011
3012 /**
3013 * Report to the framework whether a network has working connectivity.
3014 * This provides a hint to the system that a particular network is providing
3015 * working connectivity or not. In response the framework may re-evaluate
3016 * the network's connectivity and might take further action thereafter.
3017 *
3018 * @param network The {@link Network} the application was attempting to use
3019 * or {@code null} to indicate the current default network.
3020 * @param hasConnectivity {@code true} if the application was able to successfully access the
3021 * Internet using {@code network} or {@code false} if not.
3022 */
Chalard Jean42a9c292019-01-07 19:26:34 +09003023 public void reportNetworkConnectivity(@Nullable Network network, boolean hasConnectivity) {
Soi, Yoshinari99efcbd2015-11-12 12:09:02 +09003024 printStackTrace();
Paul Jensen7aac1b32015-04-07 12:43:13 -04003025 try {
3026 mService.reportNetworkConnectivity(network, hasConnectivity);
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003027 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07003028 throw e.rethrowFromSystemServer();
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003029 }
3030 }
3031
3032 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -08003033 * Set a network-independent global http proxy. This is not normally what you want
3034 * for typical HTTP proxies - they are general network dependent. However if you're
3035 * doing something unusual like general internal filtering this may be useful. On
3036 * a private network where the proxy is not accessible, you may break HTTP using this.
Paul Jensen19b3ee72015-05-06 11:10:18 -04003037 *
3038 * @param p A {@link ProxyInfo} object defining the new global
3039 * HTTP proxy. A {@code null} value will clear the global HTTP proxy.
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07003040 * @hide
Robert Greenwaltc3c5f862010-10-11 16:00:27 -07003041 */
Chiachang Wang0cefc1c2021-03-18 09:44:34 +08003042 @SystemApi(client = MODULE_LIBRARIES)
paulhuec0a9632019-08-12 16:25:11 +08003043 @RequiresPermission(android.Manifest.permission.NETWORK_STACK)
Chiachang Wang0cefc1c2021-03-18 09:44:34 +08003044 public void setGlobalProxy(@Nullable ProxyInfo p) {
Robert Greenwaltc3c5f862010-10-11 16:00:27 -07003045 try {
3046 mService.setGlobalProxy(p);
3047 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07003048 throw e.rethrowFromSystemServer();
Robert Greenwaltc3c5f862010-10-11 16:00:27 -07003049 }
3050 }
3051
3052 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -08003053 * Retrieve any network-independent global HTTP proxy.
3054 *
Jason Monk1e3df5d2014-04-25 15:00:09 -04003055 * @return {@link ProxyInfo} for the current global HTTP proxy or {@code null}
Robert Greenwalt26744a52013-02-15 10:56:35 -08003056 * if no global HTTP proxy is set.
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07003057 * @hide
Robert Greenwaltc3c5f862010-10-11 16:00:27 -07003058 */
Chiachang Wang0cefc1c2021-03-18 09:44:34 +08003059 @SystemApi(client = MODULE_LIBRARIES)
3060 @Nullable
Jason Monk1e3df5d2014-04-25 15:00:09 -04003061 public ProxyInfo getGlobalProxy() {
Robert Greenwaltc3c5f862010-10-11 16:00:27 -07003062 try {
3063 return mService.getGlobalProxy();
3064 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07003065 throw e.rethrowFromSystemServer();
Robert Greenwaltc3c5f862010-10-11 16:00:27 -07003066 }
3067 }
3068
3069 /**
Paul Jensenfdec88b2015-05-06 07:32:40 -04003070 * Retrieve the global HTTP proxy, or if no global HTTP proxy is set, a
3071 * network-specific HTTP proxy. If {@code network} is null, the
3072 * network-specific proxy returned is the proxy of the default active
3073 * network.
3074 *
3075 * @return {@link ProxyInfo} for the current global HTTP proxy, or if no
3076 * global HTTP proxy is set, {@code ProxyInfo} for {@code network},
3077 * or when {@code network} is {@code null},
3078 * the {@code ProxyInfo} for the default active network. Returns
3079 * {@code null} when no proxy applies or the caller doesn't have
3080 * permission to use {@code network}.
3081 * @hide
3082 */
3083 public ProxyInfo getProxyForNetwork(Network network) {
3084 try {
3085 return mService.getProxyForNetwork(network);
3086 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07003087 throw e.rethrowFromSystemServer();
Paul Jensenfdec88b2015-05-06 07:32:40 -04003088 }
3089 }
3090
3091 /**
Paul Jensen12131352014-12-10 15:12:18 -05003092 * Get the current default HTTP proxy settings. If a global proxy is set it will be returned,
3093 * otherwise if this process is bound to a {@link Network} using
Paul Jensen895c3942015-03-10 10:54:12 -04003094 * {@link #bindProcessToNetwork} then that {@code Network}'s proxy is returned, otherwise
Paul Jensen12131352014-12-10 15:12:18 -05003095 * the default network's proxy is returned.
Robert Greenwalt26744a52013-02-15 10:56:35 -08003096 *
Jason Monk1e3df5d2014-04-25 15:00:09 -04003097 * @return the {@link ProxyInfo} for the current HTTP proxy, or {@code null} if no
Robert Greenwalt26744a52013-02-15 10:56:35 -08003098 * HTTP proxy is active.
Robert Greenwaltc3c5f862010-10-11 16:00:27 -07003099 */
Chalard Jean42a9c292019-01-07 19:26:34 +09003100 @Nullable
Paul Jensen12131352014-12-10 15:12:18 -05003101 public ProxyInfo getDefaultProxy() {
Paul Jensenfdec88b2015-05-06 07:32:40 -04003102 return getProxyForNetwork(getBoundNetworkForProcess());
Robert Greenwaltc3c5f862010-10-11 16:00:27 -07003103 }
Robert Greenwalt34848c02011-03-25 13:09:25 -07003104
3105 /**
Robert Greenwalt0114f6e2011-08-31 11:46:42 -07003106 * Returns true if the hardware supports the given network type
3107 * else it returns false. This doesn't indicate we have coverage
3108 * or are authorized onto a network, just whether or not the
Robert Greenwalt26744a52013-02-15 10:56:35 -08003109 * hardware supports it. For example a GSM phone without a SIM
3110 * should still return {@code true} for mobile data, but a wifi only
3111 * tablet would return {@code false}.
3112 *
3113 * @param networkType The network type we'd like to check
3114 * @return {@code true} if supported, else {@code false}
Chalard Jean5acb7b72018-03-08 13:54:53 +09003115 * @deprecated Types are deprecated. Use {@link NetworkCapabilities} instead.
Robert Greenwalt0114f6e2011-08-31 11:46:42 -07003116 * @hide
3117 */
Chalard Jean5acb7b72018-03-08 13:54:53 +09003118 @Deprecated
Jeff Sharkey2ac62992017-04-24 11:18:03 -06003119 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jeanaa91c9d2019-04-09 15:46:21 +09003120 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 130143562)
Robert Greenwalt0114f6e2011-08-31 11:46:42 -07003121 public boolean isNetworkSupported(int networkType) {
3122 try {
3123 return mService.isNetworkSupported(networkType);
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07003124 } catch (RemoteException e) {
3125 throw e.rethrowFromSystemServer();
3126 }
Robert Greenwalt0114f6e2011-08-31 11:46:42 -07003127 }
Jeff Sharkeyd00b1302012-04-12 18:34:54 -07003128
3129 /**
3130 * Returns if the currently active data network is metered. A network is
3131 * classified as metered when the user is sensitive to heavy data usage on
Robert Greenwalt26744a52013-02-15 10:56:35 -08003132 * that connection due to monetary costs, data limitations or
3133 * battery/performance issues. You should check this before doing large
3134 * data transfers, and warn the user or delay the operation until another
3135 * network is available.
3136 *
3137 * @return {@code true} if large transfers should be avoided, otherwise
3138 * {@code false}.
Jeff Sharkeyd00b1302012-04-12 18:34:54 -07003139 */
Jeff Sharkey2ac62992017-04-24 11:18:03 -06003140 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Jeff Sharkeyd00b1302012-04-12 18:34:54 -07003141 public boolean isActiveNetworkMetered() {
3142 try {
3143 return mService.isActiveNetworkMetered();
3144 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07003145 throw e.rethrowFromSystemServer();
Jeff Sharkeyd00b1302012-04-12 18:34:54 -07003146 }
3147 }
Jeff Sharkeyf2e722a2012-08-25 00:05:46 -07003148
Robert Greenwalt26744a52013-02-15 10:56:35 -08003149 /**
Sarah Chincab74db2020-11-25 12:15:14 -08003150 * Set sign in error notification to visible or invisible
Wink Saville89c87b92013-08-29 08:55:16 -07003151 *
Sarah Chincab74db2020-11-25 12:15:14 -08003152 * @hide
Paul Jensena8e6dc62015-03-18 12:23:02 -04003153 * @deprecated Doesn't properly deal with multiple connected networks of the same type.
Wink Saville89c87b92013-08-29 08:55:16 -07003154 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -07003155 @Deprecated
Wink Saville89c87b92013-08-29 08:55:16 -07003156 public void setProvisioningNotificationVisible(boolean visible, int networkType,
Paul Jensen82c7e422014-09-15 15:59:36 -04003157 String action) {
Wink Saville89c87b92013-08-29 08:55:16 -07003158 try {
Paul Jensen82c7e422014-09-15 15:59:36 -04003159 mService.setProvisioningNotificationVisible(visible, networkType, action);
Wink Saville89c87b92013-08-29 08:55:16 -07003160 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07003161 throw e.rethrowFromSystemServer();
Wink Saville89c87b92013-08-29 08:55:16 -07003162 }
3163 }
Yuhao Zheng15019892013-09-09 17:00:04 -07003164
3165 /**
3166 * Set the value for enabling/disabling airplane mode
3167 *
3168 * @param enable whether to enable airplane mode or not
3169 *
Yuhao Zheng15019892013-09-09 17:00:04 -07003170 * @hide
3171 */
Lorenzo Colittic4d01862018-10-09 18:55:11 +09003172 @RequiresPermission(anyOf = {
Edward Savage-Jones3b9fe322019-11-26 13:18:08 +01003173 android.Manifest.permission.NETWORK_AIRPLANE_MODE,
Lorenzo Colittic4d01862018-10-09 18:55:11 +09003174 android.Manifest.permission.NETWORK_SETTINGS,
3175 android.Manifest.permission.NETWORK_SETUP_WIZARD,
3176 android.Manifest.permission.NETWORK_STACK})
Lorenzo Colitti272a77d2018-10-09 18:50:32 +09003177 @SystemApi
Yuhao Zheng15019892013-09-09 17:00:04 -07003178 public void setAirplaneMode(boolean enable) {
3179 try {
3180 mService.setAirplaneMode(enable);
3181 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07003182 throw e.rethrowFromSystemServer();
Yuhao Zheng15019892013-09-09 17:00:04 -07003183 }
3184 }
Robert Greenwalt948aea52014-04-11 15:53:27 -07003185
Lorenzo Colitti92e6c272020-01-08 00:04:09 +09003186 /**
3187 * Registers the specified {@link NetworkProvider}.
3188 * Each listener must only be registered once. The listener can be unregistered with
3189 * {@link #unregisterNetworkProvider}.
3190 *
3191 * @param provider the provider to register
3192 * @return the ID of the provider. This ID must be used by the provider when registering
3193 * {@link android.net.NetworkAgent}s.
3194 * @hide
3195 */
3196 @SystemApi
Automerger Merge Workeref12b642020-03-04 18:04:01 +00003197 @RequiresPermission(anyOf = {
3198 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
3199 android.Manifest.permission.NETWORK_FACTORY})
Lorenzo Colitti92e6c272020-01-08 00:04:09 +09003200 public int registerNetworkProvider(@NonNull NetworkProvider provider) {
3201 if (provider.getProviderId() != NetworkProvider.ID_NONE) {
Lorenzo Colitti92e6c272020-01-08 00:04:09 +09003202 throw new IllegalStateException("NetworkProviders can only be registered once");
3203 }
3204
3205 try {
3206 int providerId = mService.registerNetworkProvider(provider.getMessenger(),
3207 provider.getName());
3208 provider.setProviderId(providerId);
3209 } catch (RemoteException e) {
3210 throw e.rethrowFromSystemServer();
3211 }
3212 return provider.getProviderId();
3213 }
3214
3215 /**
3216 * Unregisters the specified NetworkProvider.
3217 *
3218 * @param provider the provider to unregister
3219 * @hide
3220 */
3221 @SystemApi
Automerger Merge Workeref12b642020-03-04 18:04:01 +00003222 @RequiresPermission(anyOf = {
3223 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
3224 android.Manifest.permission.NETWORK_FACTORY})
Lorenzo Colitti92e6c272020-01-08 00:04:09 +09003225 public void unregisterNetworkProvider(@NonNull NetworkProvider provider) {
3226 try {
3227 mService.unregisterNetworkProvider(provider.getMessenger());
3228 } catch (RemoteException e) {
3229 throw e.rethrowFromSystemServer();
3230 }
3231 provider.setProviderId(NetworkProvider.ID_NONE);
3232 }
3233
3234
3235 /** @hide exposed via the NetworkProvider class. */
Automerger Merge Workeref12b642020-03-04 18:04:01 +00003236 @RequiresPermission(anyOf = {
3237 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
3238 android.Manifest.permission.NETWORK_FACTORY})
Lorenzo Colitti92e6c272020-01-08 00:04:09 +09003239 public void declareNetworkRequestUnfulfillable(@NonNull NetworkRequest request) {
3240 try {
3241 mService.declareNetworkRequestUnfulfillable(request);
3242 } catch (RemoteException e) {
3243 throw e.rethrowFromSystemServer();
3244 }
3245 }
3246
Paul Jensenc2569432015-02-13 14:18:39 -05003247 /**
3248 * @hide
3249 * Register a NetworkAgent with ConnectivityService.
Chalard Jean1aea87a2019-12-13 19:47:12 +09003250 * @return Network corresponding to NetworkAgent.
Paul Jensenc2569432015-02-13 14:18:39 -05003251 */
Automerger Merge Workeref12b642020-03-04 18:04:01 +00003252 @RequiresPermission(anyOf = {
3253 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
3254 android.Manifest.permission.NETWORK_FACTORY})
Remi NGUYEN VAN37ebfa82020-12-23 12:45:08 +09003255 public Network registerNetworkAgent(INetworkAgent na, NetworkInfo ni, LinkProperties lp,
Chalard Jeandd753522020-12-21 18:36:52 +09003256 NetworkCapabilities nc, @NonNull NetworkScore score, NetworkAgentConfig config,
3257 int providerId) {
Robert Greenwaltdb6fac52014-04-18 15:25:25 -07003258 try {
Remi NGUYEN VAN37ebfa82020-12-23 12:45:08 +09003259 return mService.registerNetworkAgent(na, ni, lp, nc, score, config, providerId);
Paul Jensenc2569432015-02-13 14:18:39 -05003260 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07003261 throw e.rethrowFromSystemServer();
Paul Jensenc2569432015-02-13 14:18:39 -05003262 }
Robert Greenwaltdb6fac52014-04-18 15:25:25 -07003263 }
3264
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003265 /**
Hugo Benichi45a49542017-03-06 09:17:06 +09003266 * Base class for {@code NetworkRequest} callbacks. Used for notifications about network
3267 * changes. Should be extended by applications wanting notifications.
3268 *
3269 * A {@code NetworkCallback} is registered by calling
3270 * {@link #requestNetwork(NetworkRequest, NetworkCallback)},
3271 * {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)},
Hugo Benichi7665a142018-02-07 21:17:43 +09003272 * or {@link #registerDefaultNetworkCallback(NetworkCallback)}. A {@code NetworkCallback} is
Hugo Benichi45a49542017-03-06 09:17:06 +09003273 * unregistered by calling {@link #unregisterNetworkCallback(NetworkCallback)}.
3274 * A {@code NetworkCallback} should be registered at most once at any time.
3275 * A {@code NetworkCallback} that has been unregistered can be registered again.
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003276 */
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07003277 public static class NetworkCallback {
Robert Greenwaltdb6fac52014-04-18 15:25:25 -07003278 /**
Roshan Pius7992afd2020-12-22 15:10:42 -08003279 * No flags associated with this callback.
3280 * @hide
3281 */
3282 public static final int FLAG_NONE = 0;
3283 /**
3284 * Use this flag to include any location sensitive data in {@link NetworkCapabilities} sent
3285 * via {@link #onCapabilitiesChanged(Network, NetworkCapabilities)}.
3286 * <p>
3287 * These include:
3288 * <li> Some transport info instances (retrieved via
3289 * {@link NetworkCapabilities#getTransportInfo()}) like {@link android.net.wifi.WifiInfo}
3290 * contain location sensitive information.
3291 * <li> OwnerUid (retrieved via {@link NetworkCapabilities#getOwnerUid()} is location
3292 * sensitive for wifi suggestor apps (i.e using {@link WifiNetworkSuggestion}).</li>
3293 * </p>
3294 * <p>
3295 * Note:
3296 * <li> Retrieving this location sensitive information (subject to app's location
3297 * permissions) will be noted by system. </li>
3298 * <li> Without this flag any {@link NetworkCapabilities} provided via the callback does
3299 * not include location sensitive info.
3300 * </p>
3301 */
3302 public static final int FLAG_INCLUDE_LOCATION_INFO = 1 << 0;
3303
3304 /** @hide */
3305 @Retention(RetentionPolicy.SOURCE)
3306 @IntDef(flag = true, prefix = "FLAG_", value = {
3307 FLAG_NONE,
3308 FLAG_INCLUDE_LOCATION_INFO
3309 })
3310 public @interface Flag { }
3311
3312 /**
3313 * All the valid flags for error checking.
3314 */
3315 private static final int VALID_FLAGS = FLAG_INCLUDE_LOCATION_INFO;
3316
3317 public NetworkCallback() {
3318 this(FLAG_NONE);
3319 }
3320
3321 public NetworkCallback(@Flag int flags) {
3322 Preconditions.checkArgument((flags & VALID_FLAGS) == flags);
3323 mFlags = flags;
3324 }
3325
3326 /**
Lorenzo Colitticcf82102015-04-24 12:23:24 +09003327 * Called when the framework connects to a new network to evaluate whether it satisfies this
3328 * request. If evaluation succeeds, this callback may be followed by an {@link #onAvailable}
3329 * callback. There is no guarantee that this new network will satisfy any requests, or that
3330 * the network will stay connected for longer than the time necessary to evaluate it.
3331 * <p>
3332 * Most applications <b>should not</b> act on this callback, and should instead use
3333 * {@link #onAvailable}. This callback is intended for use by applications that can assist
3334 * the framework in properly evaluating the network &mdash; for example, an application that
3335 * can automatically log in to a captive portal without user intervention.
3336 *
3337 * @param network The {@link Network} of the network that is being evaluated.
Lorenzo Colittia04936a2015-06-11 14:27:17 +09003338 *
3339 * @hide
Robert Greenwaltdb6fac52014-04-18 15:25:25 -07003340 */
paulhua9a6e2a2019-03-22 16:35:06 +08003341 public void onPreCheck(@NonNull Network network) {}
Robert Greenwaltdb6fac52014-04-18 15:25:25 -07003342
3343 /**
Lorenzo Colitticcf82102015-04-24 12:23:24 +09003344 * Called when the framework connects and has declared a new network ready for use.
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07003345 * This callback may be called more than once if the {@link Network} that is
3346 * satisfying the request changes.
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07003347 *
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07003348 * @param network The {@link Network} of the satisfying network.
Chalard Jeanb6a0c6d2018-01-30 22:41:41 +09003349 * @param networkCapabilities The {@link NetworkCapabilities} of the satisfying network.
3350 * @param linkProperties The {@link LinkProperties} of the satisfying network.
junyulai5ab727b2018-08-07 19:50:45 +08003351 * @param blocked Whether access to the {@link Network} is blocked due to system policy.
Chalard Jeanb6a0c6d2018-01-30 22:41:41 +09003352 * @hide
3353 */
paulhua9a6e2a2019-03-22 16:35:06 +08003354 public void onAvailable(@NonNull Network network,
3355 @NonNull NetworkCapabilities networkCapabilities,
3356 @NonNull LinkProperties linkProperties, boolean blocked) {
Chalard Jeanb6a0c6d2018-01-30 22:41:41 +09003357 // Internally only this method is called when a new network is available, and
3358 // it calls the callback in the same way and order that older versions used
3359 // to call so as not to change the behavior.
3360 onAvailable(network);
3361 if (!networkCapabilities.hasCapability(
3362 NetworkCapabilities.NET_CAPABILITY_NOT_SUSPENDED)) {
3363 onNetworkSuspended(network);
3364 }
3365 onCapabilitiesChanged(network, networkCapabilities);
3366 onLinkPropertiesChanged(network, linkProperties);
junyulai5ab727b2018-08-07 19:50:45 +08003367 onBlockedStatusChanged(network, blocked);
Chalard Jeanb6a0c6d2018-01-30 22:41:41 +09003368 }
3369
3370 /**
3371 * Called when the framework connects and has declared a new network ready for use.
Chalard Jean7f3a8742019-08-30 16:27:28 +09003372 *
3373 * <p>For callbacks registered with {@link #registerNetworkCallback}, multiple networks may
3374 * be available at the same time, and onAvailable will be called for each of these as they
3375 * appear.
3376 *
3377 * <p>For callbacks registered with {@link #requestNetwork} and
3378 * {@link #registerDefaultNetworkCallback}, this means the network passed as an argument
3379 * is the new best network for this request and is now tracked by this callback ; this
3380 * callback will no longer receive method calls about other networks that may have been
3381 * passed to this method previously. The previously-best network may have disconnected, or
3382 * it may still be around and the newly-best network may simply be better.
3383 *
3384 * <p>Starting with {@link android.os.Build.VERSION_CODES#O}, this will always immediately
3385 * be followed by a call to {@link #onCapabilitiesChanged(Network, NetworkCapabilities)}
3386 * then by a call to {@link #onLinkPropertiesChanged(Network, LinkProperties)}, and a call
3387 * to {@link #onBlockedStatusChanged(Network, boolean)}.
3388 *
3389 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
3390 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
3391 * this callback as this is prone to race conditions (there is no guarantee the objects
3392 * returned by these methods will be current). Instead, wait for a call to
3393 * {@link #onCapabilitiesChanged(Network, NetworkCapabilities)} and
3394 * {@link #onLinkPropertiesChanged(Network, LinkProperties)} whose arguments are guaranteed
3395 * to be well-ordered with respect to other callbacks.
Chalard Jeanb6a0c6d2018-01-30 22:41:41 +09003396 *
3397 * @param network The {@link Network} of the satisfying network.
Robert Greenwaltdb6fac52014-04-18 15:25:25 -07003398 */
paulhua9a6e2a2019-03-22 16:35:06 +08003399 public void onAvailable(@NonNull Network network) {}
Robert Greenwaltdb6fac52014-04-18 15:25:25 -07003400
3401 /**
Chalard Jean7f3a8742019-08-30 16:27:28 +09003402 * Called when the network is about to be lost, typically because there are no outstanding
3403 * requests left for it. This may be paired with a {@link NetworkCallback#onAvailable} call
3404 * with the new replacement network for graceful handover. This method is not guaranteed
3405 * to be called before {@link NetworkCallback#onLost} is called, for example in case a
3406 * network is suddenly disconnected.
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07003407 *
Chalard Jean7f3a8742019-08-30 16:27:28 +09003408 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
3409 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
3410 * this callback as this is prone to race conditions ; calling these methods while in a
3411 * callback may return an outdated or even a null object.
3412 *
3413 * @param network The {@link Network} that is about to be lost.
3414 * @param maxMsToLive The time in milliseconds the system intends to keep the network
3415 * connected for graceful handover; note that the network may still
3416 * suffer a hard loss at any time.
Robert Greenwaltdb6fac52014-04-18 15:25:25 -07003417 */
paulhua9a6e2a2019-03-22 16:35:06 +08003418 public void onLosing(@NonNull Network network, int maxMsToLive) {}
Robert Greenwaltdb6fac52014-04-18 15:25:25 -07003419
3420 /**
Chalard Jean7f3a8742019-08-30 16:27:28 +09003421 * Called when a network disconnects or otherwise no longer satisfies this request or
3422 * callback.
3423 *
3424 * <p>If the callback was registered with requestNetwork() or
3425 * registerDefaultNetworkCallback(), it will only be invoked against the last network
3426 * returned by onAvailable() when that network is lost and no other network satisfies
3427 * the criteria of the request.
3428 *
3429 * <p>If the callback was registered with registerNetworkCallback() it will be called for
3430 * each network which no longer satisfies the criteria of the callback.
3431 *
3432 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
3433 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
3434 * this callback as this is prone to race conditions ; calling these methods while in a
3435 * callback may return an outdated or even a null object.
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07003436 *
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07003437 * @param network The {@link Network} lost.
Robert Greenwaltdb6fac52014-04-18 15:25:25 -07003438 */
paulhua9a6e2a2019-03-22 16:35:06 +08003439 public void onLost(@NonNull Network network) {}
Robert Greenwaltdb6fac52014-04-18 15:25:25 -07003440
3441 /**
Chalard Jean7f3a8742019-08-30 16:27:28 +09003442 * Called if no network is found within the timeout time specified in
Etan Cohen06633de2019-01-08 12:09:18 -08003443 * {@link #requestNetwork(NetworkRequest, NetworkCallback, int)} call or if the
3444 * requested network request cannot be fulfilled (whether or not a timeout was
3445 * specified). When this callback is invoked the associated
Etan Cohen67e58a02017-03-01 12:47:28 -08003446 * {@link NetworkRequest} will have already been removed and released, as if
3447 * {@link #unregisterNetworkCallback(NetworkCallback)} had been called.
Robert Greenwaltdb6fac52014-04-18 15:25:25 -07003448 */
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07003449 public void onUnavailable() {}
Robert Greenwaltdb6fac52014-04-18 15:25:25 -07003450
3451 /**
Chalard Jean7f3a8742019-08-30 16:27:28 +09003452 * Called when the network corresponding to this request changes capabilities but still
3453 * satisfies the requested criteria.
3454 *
3455 * <p>Starting with {@link android.os.Build.VERSION_CODES#O} this method is guaranteed
3456 * to be called immediately after {@link #onAvailable}.
3457 *
3458 * <p>Do NOT call {@link #getLinkProperties(Network)} or other synchronous
3459 * ConnectivityManager methods in this callback as this is prone to race conditions :
3460 * calling these methods while in a callback may return an outdated or even a null object.
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07003461 *
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07003462 * @param network The {@link Network} whose capabilities have changed.
Roshan Pius7992afd2020-12-22 15:10:42 -08003463 * @param networkCapabilities The new {@link NetworkCapabilities} for this
Chalard Jeanb6a0c6d2018-01-30 22:41:41 +09003464 * network.
Robert Greenwaltdb6fac52014-04-18 15:25:25 -07003465 */
paulhua9a6e2a2019-03-22 16:35:06 +08003466 public void onCapabilitiesChanged(@NonNull Network network,
3467 @NonNull NetworkCapabilities networkCapabilities) {}
Robert Greenwaltdb6fac52014-04-18 15:25:25 -07003468
3469 /**
Chalard Jean7f3a8742019-08-30 16:27:28 +09003470 * Called when the network corresponding to this request changes {@link LinkProperties}.
3471 *
3472 * <p>Starting with {@link android.os.Build.VERSION_CODES#O} this method is guaranteed
3473 * to be called immediately after {@link #onAvailable}.
3474 *
3475 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or other synchronous
3476 * ConnectivityManager methods in this callback as this is prone to race conditions :
3477 * calling these methods while in a callback may return an outdated or even a null object.
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07003478 *
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07003479 * @param network The {@link Network} whose link properties have changed.
3480 * @param linkProperties The new {@link LinkProperties} for this network.
Robert Greenwaltdb6fac52014-04-18 15:25:25 -07003481 */
paulhua9a6e2a2019-03-22 16:35:06 +08003482 public void onLinkPropertiesChanged(@NonNull Network network,
3483 @NonNull LinkProperties linkProperties) {}
Robert Greenwaltdb6fac52014-04-18 15:25:25 -07003484
Robert Greenwalt41c19a02015-06-24 13:23:42 -07003485 /**
Chalard Jean7f3a8742019-08-30 16:27:28 +09003486 * Called when the network the framework connected to for this request suspends data
3487 * transmission temporarily.
3488 *
3489 * <p>This generally means that while the TCP connections are still live temporarily
3490 * network data fails to transfer. To give a specific example, this is used on cellular
3491 * networks to mask temporary outages when driving through a tunnel, etc. In general this
3492 * means read operations on sockets on this network will block once the buffers are
3493 * drained, and write operations will block once the buffers are full.
3494 *
3495 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
3496 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
3497 * this callback as this is prone to race conditions (there is no guarantee the objects
3498 * returned by these methods will be current).
3499 *
Robert Greenwalt41c19a02015-06-24 13:23:42 -07003500 * @hide
3501 */
paulhua9a6e2a2019-03-22 16:35:06 +08003502 public void onNetworkSuspended(@NonNull Network network) {}
Robert Greenwalt41c19a02015-06-24 13:23:42 -07003503
3504 /**
3505 * Called when the network the framework connected to for this request
Chalard Jeanb6a0c6d2018-01-30 22:41:41 +09003506 * returns from a {@link NetworkInfo.State#SUSPENDED} state. This should always be
3507 * preceded by a matching {@link NetworkCallback#onNetworkSuspended} call.
Chalard Jean7f3a8742019-08-30 16:27:28 +09003508
3509 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
3510 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
3511 * this callback as this is prone to race conditions : calling these methods while in a
3512 * callback may return an outdated or even a null object.
3513 *
Robert Greenwalt41c19a02015-06-24 13:23:42 -07003514 * @hide
3515 */
paulhua9a6e2a2019-03-22 16:35:06 +08003516 public void onNetworkResumed(@NonNull Network network) {}
Robert Greenwalt41c19a02015-06-24 13:23:42 -07003517
junyulai5ab727b2018-08-07 19:50:45 +08003518 /**
3519 * Called when access to the specified network is blocked or unblocked.
3520 *
Chalard Jean7f3a8742019-08-30 16:27:28 +09003521 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
3522 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
3523 * this callback as this is prone to race conditions : calling these methods while in a
3524 * callback may return an outdated or even a null object.
3525 *
junyulai5ab727b2018-08-07 19:50:45 +08003526 * @param network The {@link Network} whose blocked status has changed.
3527 * @param blocked The blocked status of this {@link Network}.
3528 */
junyulai61143782019-03-04 22:45:36 +08003529 public void onBlockedStatusChanged(@NonNull Network network, boolean blocked) {}
junyulai5ab727b2018-08-07 19:50:45 +08003530
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07003531 private NetworkRequest networkRequest;
Roshan Pius7992afd2020-12-22 15:10:42 -08003532 private final int mFlags;
Robert Greenwaltdb6fac52014-04-18 15:25:25 -07003533 }
3534
Hugo Benichi145e3792017-05-11 13:16:17 +09003535 /**
3536 * Constant error codes used by ConnectivityService to communicate about failures and errors
3537 * across a Binder boundary.
3538 * @hide
3539 */
3540 public interface Errors {
Chalard Jean73d9db72018-06-04 16:52:49 +09003541 int TOO_MANY_REQUESTS = 1;
Hugo Benichi145e3792017-05-11 13:16:17 +09003542 }
3543
3544 /** @hide */
3545 public static class TooManyRequestsException extends RuntimeException {}
3546
3547 private static RuntimeException convertServiceException(ServiceSpecificException e) {
3548 switch (e.errorCode) {
3549 case Errors.TOO_MANY_REQUESTS:
3550 return new TooManyRequestsException();
3551 default:
3552 Log.w(TAG, "Unknown service error code " + e.errorCode);
3553 return new RuntimeException(e);
3554 }
3555 }
3556
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003557 /** @hide */
Remi NGUYEN VANa711b3f2021-03-12 15:24:06 +09003558 public static final int CALLBACK_PRECHECK = 1;
Robert Greenwalt41c19a02015-06-24 13:23:42 -07003559 /** @hide */
Remi NGUYEN VANa711b3f2021-03-12 15:24:06 +09003560 public static final int CALLBACK_AVAILABLE = 2;
Robert Greenwalt41c19a02015-06-24 13:23:42 -07003561 /** @hide arg1 = TTL */
Remi NGUYEN VANa711b3f2021-03-12 15:24:06 +09003562 public static final int CALLBACK_LOSING = 3;
Robert Greenwalt41c19a02015-06-24 13:23:42 -07003563 /** @hide */
Remi NGUYEN VANa711b3f2021-03-12 15:24:06 +09003564 public static final int CALLBACK_LOST = 4;
Robert Greenwalt41c19a02015-06-24 13:23:42 -07003565 /** @hide */
Remi NGUYEN VANa711b3f2021-03-12 15:24:06 +09003566 public static final int CALLBACK_UNAVAIL = 5;
Robert Greenwalt41c19a02015-06-24 13:23:42 -07003567 /** @hide */
Remi NGUYEN VANa711b3f2021-03-12 15:24:06 +09003568 public static final int CALLBACK_CAP_CHANGED = 6;
Robert Greenwalt41c19a02015-06-24 13:23:42 -07003569 /** @hide */
Remi NGUYEN VANa711b3f2021-03-12 15:24:06 +09003570 public static final int CALLBACK_IP_CHANGED = 7;
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07003571 /** @hide obj = NetworkCapabilities, arg1 = seq number */
Remi NGUYEN VANa711b3f2021-03-12 15:24:06 +09003572 private static final int EXPIRE_LEGACY_REQUEST = 8;
Robert Greenwalt41c19a02015-06-24 13:23:42 -07003573 /** @hide */
Remi NGUYEN VANa711b3f2021-03-12 15:24:06 +09003574 public static final int CALLBACK_SUSPENDED = 9;
Robert Greenwalt41c19a02015-06-24 13:23:42 -07003575 /** @hide */
Remi NGUYEN VANa711b3f2021-03-12 15:24:06 +09003576 public static final int CALLBACK_RESUMED = 10;
junyulai5ab727b2018-08-07 19:50:45 +08003577 /** @hide */
Remi NGUYEN VANa711b3f2021-03-12 15:24:06 +09003578 public static final int CALLBACK_BLK_CHANGED = 11;
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003579
Erik Kline66721822015-11-25 12:49:38 +09003580 /** @hide */
3581 public static String getCallbackName(int whichCallback) {
3582 switch (whichCallback) {
3583 case CALLBACK_PRECHECK: return "CALLBACK_PRECHECK";
3584 case CALLBACK_AVAILABLE: return "CALLBACK_AVAILABLE";
3585 case CALLBACK_LOSING: return "CALLBACK_LOSING";
3586 case CALLBACK_LOST: return "CALLBACK_LOST";
3587 case CALLBACK_UNAVAIL: return "CALLBACK_UNAVAIL";
3588 case CALLBACK_CAP_CHANGED: return "CALLBACK_CAP_CHANGED";
3589 case CALLBACK_IP_CHANGED: return "CALLBACK_IP_CHANGED";
Erik Kline66721822015-11-25 12:49:38 +09003590 case EXPIRE_LEGACY_REQUEST: return "EXPIRE_LEGACY_REQUEST";
3591 case CALLBACK_SUSPENDED: return "CALLBACK_SUSPENDED";
3592 case CALLBACK_RESUMED: return "CALLBACK_RESUMED";
junyulai5ab727b2018-08-07 19:50:45 +08003593 case CALLBACK_BLK_CHANGED: return "CALLBACK_BLK_CHANGED";
Erik Kline66721822015-11-25 12:49:38 +09003594 default:
3595 return Integer.toString(whichCallback);
3596 }
3597 }
3598
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07003599 private class CallbackHandler extends Handler {
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003600 private static final String TAG = "ConnectivityManager.CallbackHandler";
Robert Greenwalt9b330772015-09-03 16:41:45 -07003601 private static final boolean DBG = false;
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003602
Hugo Benichife3325f2016-07-06 22:53:17 +09003603 CallbackHandler(Looper looper) {
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003604 super(looper);
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003605 }
3606
Hugo Benichicd5a0e02017-02-02 17:02:36 +09003607 CallbackHandler(Handler handler) {
Remi NGUYEN VAN00c531f2021-03-15 07:27:44 +00003608 this(Preconditions.checkNotNull(handler, "Handler cannot be null.").getLooper());
Hugo Benichicd5a0e02017-02-02 17:02:36 +09003609 }
3610
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003611 @Override
3612 public void handleMessage(Message message) {
Hugo Benichi3b926992017-05-09 14:36:02 +09003613 if (message.what == EXPIRE_LEGACY_REQUEST) {
3614 expireRequest((NetworkCapabilities) message.obj, message.arg1);
3615 return;
3616 }
3617
3618 final NetworkRequest request = getObject(message, NetworkRequest.class);
3619 final Network network = getObject(message, Network.class);
3620 final NetworkCallback callback;
3621 synchronized (sCallbacks) {
3622 callback = sCallbacks.get(request);
Etan Cohenbc3a4eb2019-05-21 12:06:04 -07003623 if (callback == null) {
3624 Log.w(TAG,
3625 "callback not found for " + getCallbackName(message.what) + " message");
3626 return;
3627 }
Etan Cohene0e2ca92019-04-16 15:07:55 -07003628 if (message.what == CALLBACK_UNAVAIL) {
3629 sCallbacks.remove(request);
3630 callback.networkRequest = ALREADY_UNREGISTERED;
3631 }
Hugo Benichi3b926992017-05-09 14:36:02 +09003632 }
Lorenzo Colitti7e286832016-03-01 22:56:37 +09003633 if (DBG) {
Hugo Benichi94f0bfc2017-03-22 17:07:57 +09003634 Log.d(TAG, getCallbackName(message.what) + " for network " + network);
Lorenzo Colitti7e286832016-03-01 22:56:37 +09003635 }
Hugo Benichi3b926992017-05-09 14:36:02 +09003636
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003637 switch (message.what) {
3638 case CALLBACK_PRECHECK: {
Hugo Benichi3b926992017-05-09 14:36:02 +09003639 callback.onPreCheck(network);
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003640 break;
3641 }
3642 case CALLBACK_AVAILABLE: {
Chalard Jeanb6a0c6d2018-01-30 22:41:41 +09003643 NetworkCapabilities cap = getObject(message, NetworkCapabilities.class);
3644 LinkProperties lp = getObject(message, LinkProperties.class);
junyulai5ab727b2018-08-07 19:50:45 +08003645 callback.onAvailable(network, cap, lp, message.arg1 != 0);
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003646 break;
3647 }
3648 case CALLBACK_LOSING: {
Hugo Benichi3b926992017-05-09 14:36:02 +09003649 callback.onLosing(network, message.arg1);
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003650 break;
3651 }
3652 case CALLBACK_LOST: {
Hugo Benichi3b926992017-05-09 14:36:02 +09003653 callback.onLost(network);
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003654 break;
3655 }
3656 case CALLBACK_UNAVAIL: {
Hugo Benichi3b926992017-05-09 14:36:02 +09003657 callback.onUnavailable();
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003658 break;
3659 }
3660 case CALLBACK_CAP_CHANGED: {
Hugo Benichi3b926992017-05-09 14:36:02 +09003661 NetworkCapabilities cap = getObject(message, NetworkCapabilities.class);
3662 callback.onCapabilitiesChanged(network, cap);
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003663 break;
3664 }
3665 case CALLBACK_IP_CHANGED: {
Hugo Benichi3b926992017-05-09 14:36:02 +09003666 LinkProperties lp = getObject(message, LinkProperties.class);
3667 callback.onLinkPropertiesChanged(network, lp);
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003668 break;
3669 }
Robert Greenwalt41c19a02015-06-24 13:23:42 -07003670 case CALLBACK_SUSPENDED: {
Hugo Benichi3b926992017-05-09 14:36:02 +09003671 callback.onNetworkSuspended(network);
Robert Greenwalt41c19a02015-06-24 13:23:42 -07003672 break;
3673 }
3674 case CALLBACK_RESUMED: {
Hugo Benichi3b926992017-05-09 14:36:02 +09003675 callback.onNetworkResumed(network);
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07003676 break;
3677 }
junyulai5ab727b2018-08-07 19:50:45 +08003678 case CALLBACK_BLK_CHANGED: {
3679 boolean blocked = message.arg1 != 0;
3680 callback.onBlockedStatusChanged(network, blocked);
3681 }
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003682 }
3683 }
3684
Hugo Benichife3325f2016-07-06 22:53:17 +09003685 private <T> T getObject(Message msg, Class<T> c) {
3686 return (T) msg.getData().getParcelable(c.getSimpleName());
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003687 }
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003688 }
3689
Hugo Benichicd5a0e02017-02-02 17:02:36 +09003690 private CallbackHandler getDefaultHandler() {
Hugo Benichi3a545552016-07-07 10:15:56 +09003691 synchronized (sCallbacks) {
3692 if (sCallbackHandler == null) {
3693 sCallbackHandler = new CallbackHandler(ConnectivityThread.getInstanceLooper());
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003694 }
Hugo Benichi3a545552016-07-07 10:15:56 +09003695 return sCallbackHandler;
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003696 }
3697 }
3698
Hugo Benichiec180d52017-02-03 14:18:44 +09003699 private static final HashMap<NetworkRequest, NetworkCallback> sCallbacks = new HashMap<>();
3700 private static CallbackHandler sCallbackHandler;
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003701
Hugo Benichiec180d52017-02-03 14:18:44 +09003702 private NetworkRequest sendRequestForNetwork(NetworkCapabilities need, NetworkCallback callback,
junyulaid1a78162021-01-11 16:53:38 +08003703 int timeoutMs, NetworkRequest.Type reqType, int legacyType, CallbackHandler handler) {
Soi, Yoshinari99efcbd2015-11-12 12:09:02 +09003704 printStackTrace();
Hugo Benichiff4bf602017-05-09 15:19:01 +09003705 checkCallbackNotNull(callback);
Remi NGUYEN VAN00c531f2021-03-15 07:27:44 +00003706 Preconditions.checkArgument(
3707 reqType == TRACK_DEFAULT || reqType == TRACK_SYSTEM_DEFAULT || need != null,
3708 "null NetworkCapabilities");
Hugo Benichife3325f2016-07-06 22:53:17 +09003709 final NetworkRequest request;
Roshan Piusd26ae412020-01-16 12:17:17 -08003710 final String callingPackageName = mContext.getOpPackageName();
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003711 try {
Hugo Benichife3325f2016-07-06 22:53:17 +09003712 synchronized(sCallbacks) {
Hugo Benichi1c027fe2017-06-17 13:14:12 +09003713 if (callback.networkRequest != null
3714 && callback.networkRequest != ALREADY_UNREGISTERED) {
Hugo Benichi45a49542017-03-06 09:17:06 +09003715 // TODO: throw exception instead and enforce 1:1 mapping of callbacks
3716 // and requests (http://b/20701525).
3717 Log.e(TAG, "NetworkCallback was already registered");
3718 }
Hugo Benichi3a545552016-07-07 10:15:56 +09003719 Messenger messenger = new Messenger(handler);
Hugo Benichife3325f2016-07-06 22:53:17 +09003720 Binder binder = new Binder();
Roshan Pius7992afd2020-12-22 15:10:42 -08003721 final int callbackFlags = callback.mFlags;
junyulaid1a78162021-01-11 16:53:38 +08003722 if (reqType == LISTEN) {
Roshan Piusd26ae412020-01-16 12:17:17 -08003723 request = mService.listenForNetwork(
Roshan Pius7992afd2020-12-22 15:10:42 -08003724 need, messenger, binder, callbackFlags, callingPackageName,
Roshan Piusc97d8062020-12-17 14:53:09 -08003725 getAttributionTag());
Paul Jensenf980a0f2014-06-27 11:05:32 -04003726 } else {
Hugo Benichife3325f2016-07-06 22:53:17 +09003727 request = mService.requestNetwork(
junyulaid1a78162021-01-11 16:53:38 +08003728 need, reqType.ordinal(), messenger, timeoutMs, binder, legacyType,
Roshan Pius7992afd2020-12-22 15:10:42 -08003729 callbackFlags, callingPackageName, getAttributionTag());
Paul Jensenf980a0f2014-06-27 11:05:32 -04003730 }
Hugo Benichife3325f2016-07-06 22:53:17 +09003731 if (request != null) {
Hugo Benichi3a545552016-07-07 10:15:56 +09003732 sCallbacks.put(request, callback);
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003733 }
Hugo Benichi3a545552016-07-07 10:15:56 +09003734 callback.networkRequest = request;
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003735 }
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07003736 } catch (RemoteException e) {
3737 throw e.rethrowFromSystemServer();
Hugo Benichi145e3792017-05-11 13:16:17 +09003738 } catch (ServiceSpecificException e) {
3739 throw convertServiceException(e);
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07003740 }
Hugo Benichife3325f2016-07-06 22:53:17 +09003741 return request;
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003742 }
3743
3744 /**
Erik Klinee0aed632016-03-16 15:31:39 +09003745 * Helper function to request a network with a particular legacy type.
Lorenzo Colitti873f7bb2015-11-25 12:00:52 +09003746 *
markchien0fe11402020-03-18 21:16:15 +08003747 * This API is only for use in internal system code that requests networks with legacy type and
3748 * relies on CONNECTIVITY_ACTION broadcasts instead of NetworkCallbacks. New caller should use
markchien769c5752020-01-14 12:54:40 +08003749 * {@link #requestNetwork(NetworkRequest, NetworkCallback, Handler)} instead.
Lorenzo Colitti873f7bb2015-11-25 12:00:52 +09003750 *
markchien769c5752020-01-14 12:54:40 +08003751 * @param request {@link NetworkRequest} describing this request.
markchien769c5752020-01-14 12:54:40 +08003752 * @param timeoutMs The time in milliseconds to attempt looking for a suitable network
3753 * before {@link NetworkCallback#onUnavailable()} is called. The timeout must
3754 * be a positive value (i.e. >0).
3755 * @param legacyType to specify the network type(#TYPE_*).
3756 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
markchien0fe11402020-03-18 21:16:15 +08003757 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
3758 * the callback must not be shared - it uniquely specifies this request.
Lorenzo Colitti873f7bb2015-11-25 12:00:52 +09003759 *
3760 * @hide
3761 */
markchien769c5752020-01-14 12:54:40 +08003762 @SystemApi
markchien0fe11402020-03-18 21:16:15 +08003763 @RequiresPermission(NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK)
Chalard Jean42a9c292019-01-07 19:26:34 +09003764 public void requestNetwork(@NonNull NetworkRequest request,
markchien0fe11402020-03-18 21:16:15 +08003765 int timeoutMs, int legacyType, @NonNull Handler handler,
3766 @NonNull NetworkCallback networkCallback) {
3767 if (legacyType == TYPE_NONE) {
3768 throw new IllegalArgumentException("TYPE_NONE is meaningless legacy type");
3769 }
Hugo Benichicd5a0e02017-02-02 17:02:36 +09003770 CallbackHandler cbHandler = new CallbackHandler(handler);
3771 NetworkCapabilities nc = request.networkCapabilities;
3772 sendRequestForNetwork(nc, networkCallback, timeoutMs, REQUEST, legacyType, cbHandler);
Lorenzo Colitti873f7bb2015-11-25 12:00:52 +09003773 }
3774
3775 /**
Roshan Pius7992afd2020-12-22 15:10:42 -08003776 * Request a network to satisfy a set of {@link NetworkCapabilities}.
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003777 *
Chalard Jean7f3a8742019-08-30 16:27:28 +09003778 * <p>This method will attempt to find the best network that matches the passed
3779 * {@link NetworkRequest}, and to bring up one that does if none currently satisfies the
3780 * criteria. The platform will evaluate which network is the best at its own discretion.
3781 * Throughput, latency, cost per byte, policy, user preference and other considerations
3782 * may be factored in the decision of what is considered the best network.
3783 *
3784 * <p>As long as this request is outstanding, the platform will try to maintain the best network
3785 * matching this request, while always attempting to match the request to a better network if
3786 * possible. If a better match is found, the platform will switch this request to the now-best
3787 * network and inform the app of the newly best network by invoking
3788 * {@link NetworkCallback#onAvailable(Network)} on the provided callback. Note that the platform
3789 * will not try to maintain any other network than the best one currently matching the request:
3790 * a network not matching any network request may be disconnected at any time.
3791 *
3792 * <p>For example, an application could use this method to obtain a connected cellular network
3793 * even if the device currently has a data connection over Ethernet. This may cause the cellular
3794 * radio to consume additional power. Or, an application could inform the system that it wants
3795 * a network supporting sending MMSes and have the system let it know about the currently best
3796 * MMS-supporting network through the provided {@link NetworkCallback}.
3797 *
3798 * <p>The status of the request can be followed by listening to the various callbacks described
3799 * in {@link NetworkCallback}. The {@link Network} object passed to the callback methods can be
3800 * used to direct traffic to the network (although accessing some networks may be subject to
3801 * holding specific permissions). Callers will learn about the specific characteristics of the
3802 * network through
3803 * {@link NetworkCallback#onCapabilitiesChanged(Network, NetworkCapabilities)} and
3804 * {@link NetworkCallback#onLinkPropertiesChanged(Network, LinkProperties)}. The methods of the
3805 * provided {@link NetworkCallback} will only be invoked due to changes in the best network
3806 * matching the request at any given time; therefore when a better network matching the request
3807 * becomes available, the {@link NetworkCallback#onAvailable(Network)} method is called
3808 * with the new network after which no further updates are given about the previously-best
3809 * network, unless it becomes the best again at some later time. All callbacks are invoked
3810 * in order on the same thread, which by default is a thread created by the framework running
3811 * in the app.
3812 * {@see #requestNetwork(NetworkRequest, NetworkCallback, Handler)} to change where the
3813 * callbacks are invoked.
3814 *
3815 * <p>This{@link NetworkRequest} will live until released via
3816 * {@link #unregisterNetworkCallback(NetworkCallback)} or the calling application exits, at
3817 * which point the system may let go of the network at any time.
3818 *
3819 * <p>A version of this method which takes a timeout is
3820 * {@link #requestNetwork(NetworkRequest, NetworkCallback, int)}, that an app can use to only
3821 * wait for a limited amount of time for the network to become unavailable.
3822 *
Paul Jensen1fcbf9c2015-06-16 15:11:58 -04003823 * <p>It is presently unsupported to request a network with mutable
3824 * {@link NetworkCapabilities} such as
3825 * {@link NetworkCapabilities#NET_CAPABILITY_VALIDATED} or
3826 * {@link NetworkCapabilities#NET_CAPABILITY_CAPTIVE_PORTAL}
3827 * as these {@code NetworkCapabilities} represent states that a particular
3828 * network may never attain, and whether a network will attain these states
3829 * is unknown prior to bringing up the network so the framework does not
Chalard Jean7f3a8742019-08-30 16:27:28 +09003830 * know how to go about satisfying a request with these capabilities.
Lorenzo Colitti91de63b2015-10-15 16:29:00 +09003831 *
3832 * <p>This method requires the caller to hold either the
3833 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
3834 * or the ability to modify system settings as determined by
3835 * {@link android.provider.Settings.System#canWrite}.</p>
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003836 *
Chalard Jean7f06b342020-05-20 16:11:50 +09003837 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
3838 * number of outstanding requests to 100 per app (identified by their UID), shared with
3839 * all variants of this method, of {@link #registerNetworkCallback} as well as
3840 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
3841 * Requesting a network with this method will count toward this limit. If this limit is
3842 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
3843 * make sure to unregister the callbacks with
3844 * {@link #unregisterNetworkCallback(NetworkCallback)}.
3845 *
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07003846 * @param request {@link NetworkRequest} describing this request.
Hugo Benichicd5a0e02017-02-02 17:02:36 +09003847 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
3848 * the callback must not be shared - it uniquely specifies this request.
3849 * The callback is invoked on the default internal Handler.
Chalard Jean9f1a7632019-05-13 15:13:58 +09003850 * @throws IllegalArgumentException if {@code request} contains invalid network capabilities.
3851 * @throws SecurityException if missing the appropriate permissions.
Chalard Jean7f06b342020-05-20 16:11:50 +09003852 * @throws RuntimeException if the app already has too many callbacks registered.
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003853 */
Chalard Jean42a9c292019-01-07 19:26:34 +09003854 public void requestNetwork(@NonNull NetworkRequest request,
3855 @NonNull NetworkCallback networkCallback) {
Hugo Benichicd5a0e02017-02-02 17:02:36 +09003856 requestNetwork(request, networkCallback, getDefaultHandler());
3857 }
3858
3859 /**
Roshan Pius7992afd2020-12-22 15:10:42 -08003860 * Request a network to satisfy a set of {@link NetworkCapabilities}.
Hugo Benichicd5a0e02017-02-02 17:02:36 +09003861 *
Chalard Jean7f3a8742019-08-30 16:27:28 +09003862 * This method behaves identically to {@link #requestNetwork(NetworkRequest, NetworkCallback)}
3863 * but runs all the callbacks on the passed Handler.
Hugo Benichicd5a0e02017-02-02 17:02:36 +09003864 *
Chalard Jean7f3a8742019-08-30 16:27:28 +09003865 * <p>This method has the same permission requirements as
Chalard Jean7f06b342020-05-20 16:11:50 +09003866 * {@link #requestNetwork(NetworkRequest, NetworkCallback)}, is subject to the same limitations,
3867 * and throws the same exceptions in the same conditions.
Hugo Benichicd5a0e02017-02-02 17:02:36 +09003868 *
3869 * @param request {@link NetworkRequest} describing this request.
3870 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
3871 * the callback must not be shared - it uniquely specifies this request.
3872 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
Hugo Benichicd5a0e02017-02-02 17:02:36 +09003873 */
Chalard Jean42a9c292019-01-07 19:26:34 +09003874 public void requestNetwork(@NonNull NetworkRequest request,
3875 @NonNull NetworkCallback networkCallback, @NonNull Handler handler) {
Hugo Benichicd5a0e02017-02-02 17:02:36 +09003876 CallbackHandler cbHandler = new CallbackHandler(handler);
markchien0fe11402020-03-18 21:16:15 +08003877 NetworkCapabilities nc = request.networkCapabilities;
3878 sendRequestForNetwork(nc, networkCallback, 0, REQUEST, TYPE_NONE, cbHandler);
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003879 }
3880
3881 /**
Roshan Pius7992afd2020-12-22 15:10:42 -08003882 * Request a network to satisfy a set of {@link NetworkCapabilities}, limited
Etan Cohen67e58a02017-03-01 12:47:28 -08003883 * by a timeout.
3884 *
3885 * This function behaves identically to the non-timed-out version
3886 * {@link #requestNetwork(NetworkRequest, NetworkCallback)}, but if a suitable network
3887 * is not found within the given time (in milliseconds) the
3888 * {@link NetworkCallback#onUnavailable()} callback is called. The request can still be
3889 * released normally by calling {@link #unregisterNetworkCallback(NetworkCallback)} but does
3890 * not have to be released if timed-out (it is automatically released). Unregistering a
3891 * request that timed out is not an error.
3892 *
3893 * <p>Do not use this method to poll for the existence of specific networks (e.g. with a small
3894 * timeout) - {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)} is provided
3895 * for that purpose. Calling this method will attempt to bring up the requested network.
3896 *
Chalard Jean7f3a8742019-08-30 16:27:28 +09003897 * <p>This method has the same permission requirements as
Chalard Jean7f06b342020-05-20 16:11:50 +09003898 * {@link #requestNetwork(NetworkRequest, NetworkCallback)}, is subject to the same limitations,
3899 * and throws the same exceptions in the same conditions.
Etan Cohen67e58a02017-03-01 12:47:28 -08003900 *
3901 * @param request {@link NetworkRequest} describing this request.
Lorenzo Colitti38ea8102017-04-28 00:56:30 +09003902 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
3903 * the callback must not be shared - it uniquely specifies this request.
Etan Cohen67e58a02017-03-01 12:47:28 -08003904 * @param timeoutMs The time in milliseconds to attempt looking for a suitable network
3905 * before {@link NetworkCallback#onUnavailable()} is called. The timeout must
3906 * be a positive value (i.e. >0).
Etan Cohen67e58a02017-03-01 12:47:28 -08003907 */
Chalard Jean42a9c292019-01-07 19:26:34 +09003908 public void requestNetwork(@NonNull NetworkRequest request,
3909 @NonNull NetworkCallback networkCallback, int timeoutMs) {
Hugo Benichiff4bf602017-05-09 15:19:01 +09003910 checkTimeout(timeoutMs);
markchien0fe11402020-03-18 21:16:15 +08003911 NetworkCapabilities nc = request.networkCapabilities;
3912 sendRequestForNetwork(nc, networkCallback, timeoutMs, REQUEST, TYPE_NONE,
3913 getDefaultHandler());
Hugo Benichicd5a0e02017-02-02 17:02:36 +09003914 }
3915
Hugo Benichicd5a0e02017-02-02 17:02:36 +09003916 /**
Roshan Pius7992afd2020-12-22 15:10:42 -08003917 * Request a network to satisfy a set of {@link NetworkCapabilities}, limited
Hugo Benichicd5a0e02017-02-02 17:02:36 +09003918 * by a timeout.
3919 *
Chalard Jean7f3a8742019-08-30 16:27:28 +09003920 * This method behaves identically to
3921 * {@link #requestNetwork(NetworkRequest, NetworkCallback, int)} but runs all the callbacks
3922 * on the passed Handler.
Etan Cohen67e58a02017-03-01 12:47:28 -08003923 *
Chalard Jean7f3a8742019-08-30 16:27:28 +09003924 * <p>This method has the same permission requirements as
Chalard Jean7f06b342020-05-20 16:11:50 +09003925 * {@link #requestNetwork(NetworkRequest, NetworkCallback)}, is subject to the same limitations,
3926 * and throws the same exceptions in the same conditions.
Hugo Benichicd5a0e02017-02-02 17:02:36 +09003927 *
3928 * @param request {@link NetworkRequest} describing this request.
Etan Cohen67e58a02017-03-01 12:47:28 -08003929 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
3930 * the callback must not be shared - it uniquely specifies this request.
Hugo Benichicd5a0e02017-02-02 17:02:36 +09003931 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
Lorenzo Colitti38ea8102017-04-28 00:56:30 +09003932 * @param timeoutMs The time in milliseconds to attempt looking for a suitable network
3933 * before {@link NetworkCallback#onUnavailable} is called.
Hugo Benichicd5a0e02017-02-02 17:02:36 +09003934 */
Chalard Jean42a9c292019-01-07 19:26:34 +09003935 public void requestNetwork(@NonNull NetworkRequest request,
3936 @NonNull NetworkCallback networkCallback, @NonNull Handler handler, int timeoutMs) {
Hugo Benichiff4bf602017-05-09 15:19:01 +09003937 checkTimeout(timeoutMs);
Hugo Benichicd5a0e02017-02-02 17:02:36 +09003938 CallbackHandler cbHandler = new CallbackHandler(handler);
markchien0fe11402020-03-18 21:16:15 +08003939 NetworkCapabilities nc = request.networkCapabilities;
3940 sendRequestForNetwork(nc, networkCallback, timeoutMs, REQUEST, TYPE_NONE, cbHandler);
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003941 }
3942
3943 /**
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07003944 * The lookup key for a {@link Network} object included with the intent after
Jeremy Joslin94c30992014-11-05 10:32:09 -08003945 * successfully finding a network for the applications request. Retrieve it with
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07003946 * {@link android.content.Intent#getParcelableExtra(String)}.
Jeremy Joslinfe76e0e2015-02-11 16:51:13 -08003947 * <p>
Paul Jensen895c3942015-03-10 10:54:12 -04003948 * Note that if you intend to invoke {@link Network#openConnection(java.net.URL)}
3949 * then you must get a ConnectivityManager instance before doing so.
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07003950 */
Erik Klinefb087f12014-11-19 12:12:24 +09003951 public static final String EXTRA_NETWORK = "android.net.extra.NETWORK";
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07003952
3953 /**
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07003954 * The lookup key for a {@link NetworkRequest} object included with the intent after
Jeremy Joslin94c30992014-11-05 10:32:09 -08003955 * successfully finding a network for the applications request. Retrieve it with
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07003956 * {@link android.content.Intent#getParcelableExtra(String)}.
3957 */
Erik Klinefb087f12014-11-19 12:12:24 +09003958 public static final String EXTRA_NETWORK_REQUEST = "android.net.extra.NETWORK_REQUEST";
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07003959
3960
3961 /**
Roshan Pius7992afd2020-12-22 15:10:42 -08003962 * Request a network to satisfy a set of {@link NetworkCapabilities}.
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003963 *
Jeremy Joslin94c30992014-11-05 10:32:09 -08003964 * This function behaves identically to the version that takes a NetworkCallback, but instead
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07003965 * of {@link NetworkCallback} a {@link PendingIntent} is used. This means
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07003966 * the request may outlive the calling application and get called back when a suitable
3967 * network is found.
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003968 * <p>
3969 * The operation is an Intent broadcast that goes to a broadcast receiver that
3970 * you registered with {@link Context#registerReceiver} or through the
3971 * &lt;receiver&gt; tag in an AndroidManifest.xml file
3972 * <p>
3973 * The operation Intent is delivered with two extras, a {@link Network} typed
Erik Klinefb087f12014-11-19 12:12:24 +09003974 * extra called {@link #EXTRA_NETWORK} and a {@link NetworkRequest}
3975 * typed extra called {@link #EXTRA_NETWORK_REQUEST} containing
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003976 * the original requests parameters. It is important to create a new,
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07003977 * {@link NetworkCallback} based request before completing the processing of the
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003978 * Intent to reserve the network or it will be released shortly after the Intent
3979 * is processed.
3980 * <p>
Paul Jensen9ceed862015-06-17 14:15:39 -04003981 * If there is already a request for this Intent registered (with the equality of
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003982 * two Intents defined by {@link Intent#filterEquals}), then it will be removed and
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07003983 * replaced by this one, effectively releasing the previous {@link NetworkRequest}.
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003984 * <p>
Jeremy Joslin94c30992014-11-05 10:32:09 -08003985 * The request may be released normally by calling
3986 * {@link #releaseNetworkRequest(android.app.PendingIntent)}.
Paul Jensen1fcbf9c2015-06-16 15:11:58 -04003987 * <p>It is presently unsupported to request a network with either
3988 * {@link NetworkCapabilities#NET_CAPABILITY_VALIDATED} or
3989 * {@link NetworkCapabilities#NET_CAPABILITY_CAPTIVE_PORTAL}
3990 * as these {@code NetworkCapabilities} represent states that a particular
3991 * network may never attain, and whether a network will attain these states
3992 * is unknown prior to bringing up the network so the framework does not
Chalard Jean73d9db72018-06-04 16:52:49 +09003993 * know how to go about satisfying a request with these capabilities.
Lorenzo Colitti91de63b2015-10-15 16:29:00 +09003994 *
Chalard Jean7f06b342020-05-20 16:11:50 +09003995 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
3996 * number of outstanding requests to 100 per app (identified by their UID), shared with
3997 * all variants of this method, of {@link #registerNetworkCallback} as well as
3998 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
3999 * Requesting a network with this method will count toward this limit. If this limit is
4000 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4001 * make sure to unregister the callbacks with {@link #unregisterNetworkCallback(PendingIntent)}
4002 * or {@link #releaseNetworkRequest(PendingIntent)}.
4003 *
Lorenzo Colitti91de63b2015-10-15 16:29:00 +09004004 * <p>This method requires the caller to hold either the
4005 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
4006 * or the ability to modify system settings as determined by
4007 * {@link android.provider.Settings.System#canWrite}.</p>
4008 *
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07004009 * @param request {@link NetworkRequest} describing this request.
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07004010 * @param operation Action to perform when the network is available (corresponds
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07004011 * to the {@link NetworkCallback#onAvailable} call. Typically
Jeremy Joslin94c30992014-11-05 10:32:09 -08004012 * comes from {@link PendingIntent#getBroadcast}. Cannot be null.
Chalard Jean9f1a7632019-05-13 15:13:58 +09004013 * @throws IllegalArgumentException if {@code request} contains invalid network capabilities.
4014 * @throws SecurityException if missing the appropriate permissions.
Chalard Jean7f06b342020-05-20 16:11:50 +09004015 * @throws RuntimeException if the app already has too many callbacks registered.
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07004016 */
Chalard Jean42a9c292019-01-07 19:26:34 +09004017 public void requestNetwork(@NonNull NetworkRequest request,
4018 @NonNull PendingIntent operation) {
Soi, Yoshinari99efcbd2015-11-12 12:09:02 +09004019 printStackTrace();
Hugo Benichiff4bf602017-05-09 15:19:01 +09004020 checkPendingIntentNotNull(operation);
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07004021 try {
Roshan Piusd26ae412020-01-16 12:17:17 -08004022 mService.pendingRequestForNetwork(
Philip P. Moltmannddbcf5b2020-03-24 15:57:49 -07004023 request.networkCapabilities, operation, mContext.getOpPackageName(),
4024 getAttributionTag());
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07004025 } catch (RemoteException e) {
4026 throw e.rethrowFromSystemServer();
Hugo Benichi145e3792017-05-11 13:16:17 +09004027 } catch (ServiceSpecificException e) {
4028 throw convertServiceException(e);
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07004029 }
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07004030 }
4031
4032 /**
Jeremy Joslin94c30992014-11-05 10:32:09 -08004033 * Removes a request made via {@link #requestNetwork(NetworkRequest, android.app.PendingIntent)}
4034 * <p>
Lorenzo Colittiad458ad2016-04-13 22:00:02 +09004035 * This method has the same behavior as
4036 * {@link #unregisterNetworkCallback(android.app.PendingIntent)} with respect to
Jeremy Joslin94c30992014-11-05 10:32:09 -08004037 * releasing network resources and disconnecting.
4038 *
4039 * @param operation A PendingIntent equal (as defined by {@link Intent#filterEquals}) to the
4040 * PendingIntent passed to
4041 * {@link #requestNetwork(NetworkRequest, android.app.PendingIntent)} with the
4042 * corresponding NetworkRequest you'd like to remove. Cannot be null.
4043 */
Chalard Jean42a9c292019-01-07 19:26:34 +09004044 public void releaseNetworkRequest(@NonNull PendingIntent operation) {
Soi, Yoshinari99efcbd2015-11-12 12:09:02 +09004045 printStackTrace();
Hugo Benichiff4bf602017-05-09 15:19:01 +09004046 checkPendingIntentNotNull(operation);
Jeremy Joslin94c30992014-11-05 10:32:09 -08004047 try {
4048 mService.releasePendingNetworkRequest(operation);
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07004049 } catch (RemoteException e) {
4050 throw e.rethrowFromSystemServer();
4051 }
Jeremy Joslin94c30992014-11-05 10:32:09 -08004052 }
4053
Hugo Benichiff4bf602017-05-09 15:19:01 +09004054 private static void checkPendingIntentNotNull(PendingIntent intent) {
Remi NGUYEN VAN00c531f2021-03-15 07:27:44 +00004055 Preconditions.checkNotNull(intent, "PendingIntent cannot be null.");
Hugo Benichiff4bf602017-05-09 15:19:01 +09004056 }
4057
4058 private static void checkCallbackNotNull(NetworkCallback callback) {
Remi NGUYEN VAN00c531f2021-03-15 07:27:44 +00004059 Preconditions.checkNotNull(callback, "null NetworkCallback");
Hugo Benichiff4bf602017-05-09 15:19:01 +09004060 }
4061
4062 private static void checkTimeout(int timeoutMs) {
Remi NGUYEN VAN00c531f2021-03-15 07:27:44 +00004063 Preconditions.checkArgumentPositive(timeoutMs, "timeoutMs must be strictly positive.");
Jeremy Joslin94c30992014-11-05 10:32:09 -08004064 }
4065
4066 /**
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07004067 * Registers to receive notifications about all networks which satisfy the given
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07004068 * {@link NetworkRequest}. The callbacks will continue to be called until
Chiachang Wang0d92d1a2019-02-27 17:14:50 +08004069 * either the application exits or {@link #unregisterNetworkCallback(NetworkCallback)} is
4070 * called.
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07004071 *
Chalard Jean7f06b342020-05-20 16:11:50 +09004072 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4073 * number of outstanding requests to 100 per app (identified by their UID), shared with
4074 * all variants of this method, of {@link #requestNetwork} as well as
4075 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4076 * Requesting a network with this method will count toward this limit. If this limit is
4077 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4078 * make sure to unregister the callbacks with
4079 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4080 *
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07004081 * @param request {@link NetworkRequest} describing this request.
4082 * @param networkCallback The {@link NetworkCallback} that the system will call as suitable
4083 * networks change state.
Hugo Benichicd5a0e02017-02-02 17:02:36 +09004084 * The callback is invoked on the default internal Handler.
Chalard Jean7f06b342020-05-20 16:11:50 +09004085 * @throws RuntimeException if the app already has too many callbacks registered.
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07004086 */
Jeff Sharkey2ac62992017-04-24 11:18:03 -06004087 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean42a9c292019-01-07 19:26:34 +09004088 public void registerNetworkCallback(@NonNull NetworkRequest request,
4089 @NonNull NetworkCallback networkCallback) {
Hugo Benichicd5a0e02017-02-02 17:02:36 +09004090 registerNetworkCallback(request, networkCallback, getDefaultHandler());
4091 }
4092
4093 /**
4094 * Registers to receive notifications about all networks which satisfy the given
4095 * {@link NetworkRequest}. The callbacks will continue to be called until
Chiachang Wang0d92d1a2019-02-27 17:14:50 +08004096 * either the application exits or {@link #unregisterNetworkCallback(NetworkCallback)} is
4097 * called.
Hugo Benichicd5a0e02017-02-02 17:02:36 +09004098 *
Chalard Jean7f06b342020-05-20 16:11:50 +09004099 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4100 * number of outstanding requests to 100 per app (identified by their UID), shared with
4101 * all variants of this method, of {@link #requestNetwork} as well as
4102 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4103 * Requesting a network with this method will count toward this limit. If this limit is
4104 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4105 * make sure to unregister the callbacks with
4106 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4107 *
4108 *
Hugo Benichicd5a0e02017-02-02 17:02:36 +09004109 * @param request {@link NetworkRequest} describing this request.
4110 * @param networkCallback The {@link NetworkCallback} that the system will call as suitable
4111 * networks change state.
4112 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
Chalard Jean7f06b342020-05-20 16:11:50 +09004113 * @throws RuntimeException if the app already has too many callbacks registered.
Hugo Benichicd5a0e02017-02-02 17:02:36 +09004114 */
Jeff Sharkey2ac62992017-04-24 11:18:03 -06004115 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean42a9c292019-01-07 19:26:34 +09004116 public void registerNetworkCallback(@NonNull NetworkRequest request,
4117 @NonNull NetworkCallback networkCallback, @NonNull Handler handler) {
Hugo Benichicd5a0e02017-02-02 17:02:36 +09004118 CallbackHandler cbHandler = new CallbackHandler(handler);
4119 NetworkCapabilities nc = request.networkCapabilities;
4120 sendRequestForNetwork(nc, networkCallback, 0, LISTEN, TYPE_NONE, cbHandler);
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07004121 }
4122
4123 /**
Paul Jensen9ceed862015-06-17 14:15:39 -04004124 * Registers a PendingIntent to be sent when a network is available which satisfies the given
4125 * {@link NetworkRequest}.
4126 *
4127 * This function behaves identically to the version that takes a NetworkCallback, but instead
4128 * of {@link NetworkCallback} a {@link PendingIntent} is used. This means
4129 * the request may outlive the calling application and get called back when a suitable
4130 * network is found.
4131 * <p>
4132 * The operation is an Intent broadcast that goes to a broadcast receiver that
4133 * you registered with {@link Context#registerReceiver} or through the
4134 * &lt;receiver&gt; tag in an AndroidManifest.xml file
4135 * <p>
4136 * The operation Intent is delivered with two extras, a {@link Network} typed
4137 * extra called {@link #EXTRA_NETWORK} and a {@link NetworkRequest}
4138 * typed extra called {@link #EXTRA_NETWORK_REQUEST} containing
4139 * the original requests parameters.
4140 * <p>
4141 * If there is already a request for this Intent registered (with the equality of
4142 * two Intents defined by {@link Intent#filterEquals}), then it will be removed and
4143 * replaced by this one, effectively releasing the previous {@link NetworkRequest}.
4144 * <p>
4145 * The request may be released normally by calling
Paul Jensen78f6b802015-06-30 14:29:18 -04004146 * {@link #unregisterNetworkCallback(android.app.PendingIntent)}.
Chalard Jean7f06b342020-05-20 16:11:50 +09004147 *
4148 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4149 * number of outstanding requests to 100 per app (identified by their UID), shared with
4150 * all variants of this method, of {@link #requestNetwork} as well as
4151 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4152 * Requesting a network with this method will count toward this limit. If this limit is
4153 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4154 * make sure to unregister the callbacks with {@link #unregisterNetworkCallback(PendingIntent)}
4155 * or {@link #releaseNetworkRequest(PendingIntent)}.
4156 *
Paul Jensen9ceed862015-06-17 14:15:39 -04004157 * @param request {@link NetworkRequest} describing this request.
4158 * @param operation Action to perform when the network is available (corresponds
4159 * to the {@link NetworkCallback#onAvailable} call. Typically
4160 * comes from {@link PendingIntent#getBroadcast}. Cannot be null.
Chalard Jean7f06b342020-05-20 16:11:50 +09004161 * @throws RuntimeException if the app already has too many callbacks registered.
Paul Jensen9ceed862015-06-17 14:15:39 -04004162 */
Jeff Sharkey2ac62992017-04-24 11:18:03 -06004163 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean42a9c292019-01-07 19:26:34 +09004164 public void registerNetworkCallback(@NonNull NetworkRequest request,
4165 @NonNull PendingIntent operation) {
Soi, Yoshinari99efcbd2015-11-12 12:09:02 +09004166 printStackTrace();
Hugo Benichiff4bf602017-05-09 15:19:01 +09004167 checkPendingIntentNotNull(operation);
Paul Jensen9ceed862015-06-17 14:15:39 -04004168 try {
Roshan Piusd26ae412020-01-16 12:17:17 -08004169 mService.pendingListenForNetwork(
Roshan Piusc97d8062020-12-17 14:53:09 -08004170 request.networkCapabilities, operation, mContext.getOpPackageName(),
4171 getAttributionTag());
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07004172 } catch (RemoteException e) {
4173 throw e.rethrowFromSystemServer();
Hugo Benichi145e3792017-05-11 13:16:17 +09004174 } catch (ServiceSpecificException e) {
4175 throw convertServiceException(e);
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07004176 }
Paul Jensen9ceed862015-06-17 14:15:39 -04004177 }
4178
4179 /**
Lorenzo Colitti80b48bc2021-01-29 20:14:04 +09004180 * Registers to receive notifications about changes in the application's default network. This
4181 * may be a physical network or a virtual network, such as a VPN that applies to the
4182 * application. The callbacks will continue to be called until either the application exits or
Lorenzo Colittiad458ad2016-04-13 22:00:02 +09004183 * {@link #unregisterNetworkCallback(NetworkCallback)} is called.
Erik Klinee0aed632016-03-16 15:31:39 +09004184 *
Chalard Jean7f06b342020-05-20 16:11:50 +09004185 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4186 * number of outstanding requests to 100 per app (identified by their UID), shared with
4187 * all variants of this method, of {@link #requestNetwork} as well as
4188 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4189 * Requesting a network with this method will count toward this limit. If this limit is
4190 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4191 * make sure to unregister the callbacks with
4192 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4193 *
Erik Klinee0aed632016-03-16 15:31:39 +09004194 * @param networkCallback The {@link NetworkCallback} that the system will call as the
Lorenzo Colitti80b48bc2021-01-29 20:14:04 +09004195 * application's default network changes.
Hugo Benichicd5a0e02017-02-02 17:02:36 +09004196 * The callback is invoked on the default internal Handler.
Chalard Jean7f06b342020-05-20 16:11:50 +09004197 * @throws RuntimeException if the app already has too many callbacks registered.
Erik Klinee0aed632016-03-16 15:31:39 +09004198 */
Jeff Sharkey2ac62992017-04-24 11:18:03 -06004199 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean42a9c292019-01-07 19:26:34 +09004200 public void registerDefaultNetworkCallback(@NonNull NetworkCallback networkCallback) {
Hugo Benichicd5a0e02017-02-02 17:02:36 +09004201 registerDefaultNetworkCallback(networkCallback, getDefaultHandler());
4202 }
4203
4204 /**
Lorenzo Colitti80b48bc2021-01-29 20:14:04 +09004205 * Registers to receive notifications about changes in the application's default network. This
4206 * may be a physical network or a virtual network, such as a VPN that applies to the
4207 * application. The callbacks will continue to be called until either the application exits or
4208 * {@link #unregisterNetworkCallback(NetworkCallback)} is called.
4209 *
4210 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4211 * number of outstanding requests to 100 per app (identified by their UID), shared with
4212 * all variants of this method, of {@link #requestNetwork} as well as
4213 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4214 * Requesting a network with this method will count toward this limit. If this limit is
4215 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4216 * make sure to unregister the callbacks with
4217 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4218 *
4219 * @param networkCallback The {@link NetworkCallback} that the system will call as the
4220 * application's default network changes.
4221 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
4222 * @throws RuntimeException if the app already has too many callbacks registered.
4223 */
4224 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
4225 public void registerDefaultNetworkCallback(@NonNull NetworkCallback networkCallback,
4226 @NonNull Handler handler) {
4227 CallbackHandler cbHandler = new CallbackHandler(handler);
4228 sendRequestForNetwork(null /* NetworkCapabilities need */, networkCallback, 0,
4229 TRACK_DEFAULT, TYPE_NONE, cbHandler);
4230 }
4231
4232 /**
Hugo Benichicd5a0e02017-02-02 17:02:36 +09004233 * Registers to receive notifications about changes in the system default network. The callbacks
4234 * will continue to be called until either the application exits or
4235 * {@link #unregisterNetworkCallback(NetworkCallback)} is called.
Hugo Benichicd5a0e02017-02-02 17:02:36 +09004236 *
Lorenzo Colitti80b48bc2021-01-29 20:14:04 +09004237 * This method should not be used to determine networking state seen by applications, because in
4238 * many cases, most or even all application traffic may not use the default network directly,
4239 * and traffic from different applications may go on different networks by default. As an
4240 * example, if a VPN is connected, traffic from all applications might be sent through the VPN
4241 * and not onto the system default network. Applications or system components desiring to do
4242 * determine network state as seen by applications should use other methods such as
4243 * {@link #registerDefaultNetworkCallback(NetworkCallback, Handler)}.
4244 *
Chalard Jean7f06b342020-05-20 16:11:50 +09004245 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4246 * number of outstanding requests to 100 per app (identified by their UID), shared with
4247 * all variants of this method, of {@link #requestNetwork} as well as
4248 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4249 * Requesting a network with this method will count toward this limit. If this limit is
4250 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4251 * make sure to unregister the callbacks with
4252 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4253 *
Hugo Benichicd5a0e02017-02-02 17:02:36 +09004254 * @param networkCallback The {@link NetworkCallback} that the system will call as the
4255 * system default network changes.
4256 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
Chalard Jean7f06b342020-05-20 16:11:50 +09004257 * @throws RuntimeException if the app already has too many callbacks registered.
Lorenzo Colitti80b48bc2021-01-29 20:14:04 +09004258 *
4259 * @hide
Hugo Benichicd5a0e02017-02-02 17:02:36 +09004260 */
Lorenzo Colitti80b48bc2021-01-29 20:14:04 +09004261 @SystemApi(client = MODULE_LIBRARIES)
4262 @SuppressLint({"ExecutorRegistration", "PairedRegistration"})
4263 @RequiresPermission(anyOf = {
4264 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
4265 android.Manifest.permission.NETWORK_SETTINGS})
4266 public void registerSystemDefaultNetworkCallback(@NonNull NetworkCallback networkCallback,
Chalard Jean42a9c292019-01-07 19:26:34 +09004267 @NonNull Handler handler) {
Hugo Benichicd5a0e02017-02-02 17:02:36 +09004268 CallbackHandler cbHandler = new CallbackHandler(handler);
Chalard Jean73d9db72018-06-04 16:52:49 +09004269 sendRequestForNetwork(null /* NetworkCapabilities need */, networkCallback, 0,
Lorenzo Colitti80b48bc2021-01-29 20:14:04 +09004270 TRACK_SYSTEM_DEFAULT, TYPE_NONE, cbHandler);
Erik Klinee0aed632016-03-16 15:31:39 +09004271 }
4272
4273 /**
junyulaibd622262021-03-15 11:48:48 +08004274 * Registers to receive notifications about the best matching network which satisfy the given
4275 * {@link NetworkRequest}. The callbacks will continue to be called until
4276 * either the application exits or {@link #unregisterNetworkCallback(NetworkCallback)} is
4277 * called.
4278 *
4279 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4280 * number of outstanding requests to 100 per app (identified by their UID), shared with
4281 * {@link #registerNetworkCallback} and its variants and {@link #requestNetwork} as well as
4282 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4283 * Requesting a network with this method will count toward this limit. If this limit is
4284 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4285 * make sure to unregister the callbacks with
4286 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4287 *
4288 *
4289 * @param request {@link NetworkRequest} describing this request.
4290 * @param networkCallback The {@link NetworkCallback} that the system will call as suitable
4291 * networks change state.
4292 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
4293 * @throws RuntimeException if the app already has too many callbacks registered.
junyulai6b0a6a22021-03-05 15:51:17 +08004294 */
junyulai6b0a6a22021-03-05 15:51:17 +08004295 @SuppressLint("ExecutorRegistration")
4296 public void registerBestMatchingNetworkCallback(@NonNull NetworkRequest request,
4297 @NonNull NetworkCallback networkCallback, @NonNull Handler handler) {
4298 final NetworkCapabilities nc = request.networkCapabilities;
4299 final CallbackHandler cbHandler = new CallbackHandler(handler);
junyulai8cae3c72021-03-12 20:05:08 +08004300 sendRequestForNetwork(nc, networkCallback, 0, LISTEN_FOR_BEST, TYPE_NONE, cbHandler);
junyulai6b0a6a22021-03-05 15:51:17 +08004301 }
4302
4303 /**
fenglu73169332015-04-21 17:12:05 -07004304 * Requests bandwidth update for a given {@link Network} and returns whether the update request
4305 * is accepted by ConnectivityService. Once accepted, ConnectivityService will poll underlying
4306 * network connection for updated bandwidth information. The caller will be notified via
4307 * {@link ConnectivityManager.NetworkCallback} if there is an update. Notice that this
Lorenzo Colittiad458ad2016-04-13 22:00:02 +09004308 * method assumes that the caller has previously called
4309 * {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)} to listen for network
4310 * changes.
fenglu76564332015-03-20 11:29:56 -07004311 *
fenglu41808e82015-04-27 14:28:04 -07004312 * @param network {@link Network} specifying which network you're interested.
fenglu73169332015-04-21 17:12:05 -07004313 * @return {@code true} on success, {@code false} if the {@link Network} is no longer valid.
fenglu76564332015-03-20 11:29:56 -07004314 */
Chalard Jean42a9c292019-01-07 19:26:34 +09004315 public boolean requestBandwidthUpdate(@NonNull Network network) {
fenglu76564332015-03-20 11:29:56 -07004316 try {
fenglu73169332015-04-21 17:12:05 -07004317 return mService.requestBandwidthUpdate(network);
fenglu76564332015-03-20 11:29:56 -07004318 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07004319 throw e.rethrowFromSystemServer();
fenglu76564332015-03-20 11:29:56 -07004320 }
4321 }
4322
4323 /**
Hugo Benichi45a49542017-03-06 09:17:06 +09004324 * Unregisters a {@code NetworkCallback} and possibly releases networks originating from
Lorenzo Colittiad458ad2016-04-13 22:00:02 +09004325 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} and
4326 * {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)} calls.
4327 * If the given {@code NetworkCallback} had previously been used with
Lorenzo Colittiefd396e2015-04-24 17:03:31 +09004328 * {@code #requestNetwork}, any networks that had been connected to only to satisfy that request
4329 * will be disconnected.
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07004330 *
Hugo Benichi45a49542017-03-06 09:17:06 +09004331 * Notifications that would have triggered that {@code NetworkCallback} will immediately stop
4332 * triggering it as soon as this call returns.
4333 *
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07004334 * @param networkCallback The {@link NetworkCallback} used when making the request.
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07004335 */
Chalard Jean42a9c292019-01-07 19:26:34 +09004336 public void unregisterNetworkCallback(@NonNull NetworkCallback networkCallback) {
Soi, Yoshinari99efcbd2015-11-12 12:09:02 +09004337 printStackTrace();
Hugo Benichiff4bf602017-05-09 15:19:01 +09004338 checkCallbackNotNull(networkCallback);
Hugo Benichi45a49542017-03-06 09:17:06 +09004339 final List<NetworkRequest> reqs = new ArrayList<>();
4340 // Find all requests associated to this callback and stop callback triggers immediately.
4341 // Callback is reusable immediately. http://b/20701525, http://b/35921499.
4342 synchronized (sCallbacks) {
Remi NGUYEN VAN00c531f2021-03-15 07:27:44 +00004343 Preconditions.checkArgument(networkCallback.networkRequest != null,
4344 "NetworkCallback was not registered");
Etan Cohene0e2ca92019-04-16 15:07:55 -07004345 if (networkCallback.networkRequest == ALREADY_UNREGISTERED) {
4346 Log.d(TAG, "NetworkCallback was already unregistered");
4347 return;
4348 }
Hugo Benichi45a49542017-03-06 09:17:06 +09004349 for (Map.Entry<NetworkRequest, NetworkCallback> e : sCallbacks.entrySet()) {
4350 if (e.getValue() == networkCallback) {
4351 reqs.add(e.getKey());
4352 }
4353 }
4354 // TODO: throw exception if callback was registered more than once (http://b/20701525).
4355 for (NetworkRequest r : reqs) {
4356 try {
4357 mService.releaseNetworkRequest(r);
4358 } catch (RemoteException e) {
4359 throw e.rethrowFromSystemServer();
4360 }
4361 // Only remove mapping if rpc was successful.
4362 sCallbacks.remove(r);
4363 }
Hugo Benichi1c027fe2017-06-17 13:14:12 +09004364 networkCallback.networkRequest = ALREADY_UNREGISTERED;
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07004365 }
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07004366 }
Paul Jensene98c6e02014-05-29 10:12:39 -04004367
4368 /**
Paul Jensen78f6b802015-06-30 14:29:18 -04004369 * Unregisters a callback previously registered via
4370 * {@link #registerNetworkCallback(NetworkRequest, android.app.PendingIntent)}.
4371 *
4372 * @param operation A PendingIntent equal (as defined by {@link Intent#filterEquals}) to the
4373 * PendingIntent passed to
4374 * {@link #registerNetworkCallback(NetworkRequest, android.app.PendingIntent)}.
4375 * Cannot be null.
4376 */
Chalard Jean42a9c292019-01-07 19:26:34 +09004377 public void unregisterNetworkCallback(@NonNull PendingIntent operation) {
Paul Jensen78f6b802015-06-30 14:29:18 -04004378 releaseNetworkRequest(operation);
4379 }
4380
4381 /**
Lorenzo Colitti36fbebe2015-04-03 16:38:52 +09004382 * Informs the system whether it should switch to {@code network} regardless of whether it is
4383 * validated or not. If {@code accept} is true, and the network was explicitly selected by the
4384 * user (e.g., by selecting a Wi-Fi network in the Settings app), then the network will become
4385 * the system default network regardless of any other network that's currently connected. If
4386 * {@code always} is true, then the choice is remembered, so that the next time the user
4387 * connects to this network, the system will switch to it.
4388 *
Lorenzo Colitti36fbebe2015-04-03 16:38:52 +09004389 * @param network The network to accept.
4390 * @param accept Whether to accept the network even if unvalidated.
4391 * @param always Whether to remember this choice in the future.
4392 *
4393 * @hide
4394 */
Chiachang Wang0cefc1c2021-03-18 09:44:34 +08004395 @SystemApi(client = MODULE_LIBRARIES)
4396 @RequiresPermission(anyOf = {
4397 android.Manifest.permission.NETWORK_SETTINGS,
4398 android.Manifest.permission.NETWORK_SETUP_WIZARD,
4399 android.Manifest.permission.NETWORK_STACK,
4400 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK})
4401 public void setAcceptUnvalidated(@NonNull Network network, boolean accept, boolean always) {
Lorenzo Colitti36fbebe2015-04-03 16:38:52 +09004402 try {
4403 mService.setAcceptUnvalidated(network, accept, always);
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07004404 } catch (RemoteException e) {
4405 throw e.rethrowFromSystemServer();
4406 }
Lorenzo Colitti36fbebe2015-04-03 16:38:52 +09004407 }
4408
4409 /**
lucaslin25a50472019-03-12 13:08:03 +08004410 * Informs the system whether it should consider the network as validated even if it only has
4411 * partial connectivity. If {@code accept} is true, then the network will be considered as
4412 * validated even if connectivity is only partial. If {@code always} is true, then the choice
4413 * is remembered, so that the next time the user connects to this network, the system will
4414 * switch to it.
4415 *
4416 * @param network The network to accept.
4417 * @param accept Whether to consider the network as validated even if it has partial
4418 * connectivity.
4419 * @param always Whether to remember this choice in the future.
4420 *
4421 * @hide
4422 */
Chiachang Wang0cefc1c2021-03-18 09:44:34 +08004423 @SystemApi(client = MODULE_LIBRARIES)
4424 @RequiresPermission(anyOf = {
4425 android.Manifest.permission.NETWORK_SETTINGS,
4426 android.Manifest.permission.NETWORK_SETUP_WIZARD,
4427 android.Manifest.permission.NETWORK_STACK,
4428 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK})
4429 public void setAcceptPartialConnectivity(@NonNull Network network, boolean accept,
4430 boolean always) {
lucaslin25a50472019-03-12 13:08:03 +08004431 try {
4432 mService.setAcceptPartialConnectivity(network, accept, always);
4433 } catch (RemoteException e) {
4434 throw e.rethrowFromSystemServer();
4435 }
4436 }
4437
4438 /**
Lorenzo Colittie98557f2016-09-19 01:00:19 +09004439 * Informs the system to penalize {@code network}'s score when it becomes unvalidated. This is
4440 * only meaningful if the system is configured not to penalize such networks, e.g., if the
4441 * {@code config_networkAvoidBadWifi} configuration variable is set to 0 and the {@code
4442 * NETWORK_AVOID_BAD_WIFI setting is unset}.
4443 *
Lorenzo Colittie98557f2016-09-19 01:00:19 +09004444 * @param network The network to accept.
4445 *
4446 * @hide
4447 */
Chiachang Wang0cefc1c2021-03-18 09:44:34 +08004448 @SystemApi(client = MODULE_LIBRARIES)
4449 @RequiresPermission(anyOf = {
4450 android.Manifest.permission.NETWORK_SETTINGS,
4451 android.Manifest.permission.NETWORK_SETUP_WIZARD,
4452 android.Manifest.permission.NETWORK_STACK,
4453 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK})
4454 public void setAvoidUnvalidated(@NonNull Network network) {
Lorenzo Colittie98557f2016-09-19 01:00:19 +09004455 try {
4456 mService.setAvoidUnvalidated(network);
4457 } catch (RemoteException e) {
4458 throw e.rethrowFromSystemServer();
4459 }
4460 }
4461
4462 /**
Lorenzo Colitti755e7962017-04-27 14:30:21 +09004463 * Requests that the system open the captive portal app on the specified network.
4464 *
4465 * @param network The network to log into.
4466 *
4467 * @hide
4468 */
paulhuec0a9632019-08-12 16:25:11 +08004469 @RequiresPermission(android.Manifest.permission.NETWORK_SETTINGS)
Lorenzo Colitti755e7962017-04-27 14:30:21 +09004470 public void startCaptivePortalApp(Network network) {
4471 try {
4472 mService.startCaptivePortalApp(network);
4473 } catch (RemoteException e) {
4474 throw e.rethrowFromSystemServer();
4475 }
4476 }
4477
4478 /**
Remi NGUYEN VANf363f5f2019-02-04 11:32:20 +09004479 * Requests that the system open the captive portal app with the specified extras.
4480 *
4481 * <p>This endpoint is exclusively for use by the NetworkStack and is protected by the
4482 * corresponding permission.
Remi NGUYEN VAN89fbdc32019-02-13 20:58:59 +09004483 * @param network Network on which the captive portal was detected.
Remi NGUYEN VANf363f5f2019-02-04 11:32:20 +09004484 * @param appExtras Extras to include in the app start intent.
4485 * @hide
4486 */
4487 @SystemApi
Remi NGUYEN VANf363f5f2019-02-04 11:32:20 +09004488 @RequiresPermission(NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK)
paulhu9bb04802019-03-08 16:35:20 +08004489 public void startCaptivePortalApp(@NonNull Network network, @NonNull Bundle appExtras) {
Remi NGUYEN VANf363f5f2019-02-04 11:32:20 +09004490 try {
Remi NGUYEN VAN89fbdc32019-02-13 20:58:59 +09004491 mService.startCaptivePortalAppInternal(network, appExtras);
Remi NGUYEN VANf363f5f2019-02-04 11:32:20 +09004492 } catch (RemoteException e) {
4493 throw e.rethrowFromSystemServer();
4494 }
4495 }
4496
4497 /**
Remi NGUYEN VAN3436b6f2019-01-20 20:35:06 +09004498 * Determine whether the device is configured to avoid bad wifi.
4499 * @hide
4500 */
4501 @SystemApi
Remi NGUYEN VAN338eb2a2019-03-22 11:14:13 +09004502 @RequiresPermission(anyOf = {
4503 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
4504 android.Manifest.permission.NETWORK_STACK})
4505 public boolean shouldAvoidBadWifi() {
Remi NGUYEN VAN3436b6f2019-01-20 20:35:06 +09004506 try {
Remi NGUYEN VAN338eb2a2019-03-22 11:14:13 +09004507 return mService.shouldAvoidBadWifi();
Remi NGUYEN VAN3436b6f2019-01-20 20:35:06 +09004508 } catch (RemoteException e) {
4509 throw e.rethrowFromSystemServer();
4510 }
4511 }
4512
4513 /**
Lorenzo Colitti231efb02017-01-24 18:08:41 +09004514 * It is acceptable to briefly use multipath data to provide seamless connectivity for
4515 * time-sensitive user-facing operations when the system default network is temporarily
Lorenzo Colitti38ea8102017-04-28 00:56:30 +09004516 * unresponsive. The amount of data should be limited (less than one megabyte for every call to
4517 * this method), and the operation should be infrequent to ensure that data usage is limited.
Lorenzo Colitti231efb02017-01-24 18:08:41 +09004518 *
4519 * An example of such an operation might be a time-sensitive foreground activity, such as a
4520 * voice command, that the user is performing while walking out of range of a Wi-Fi network.
4521 */
4522 public static final int MULTIPATH_PREFERENCE_HANDOVER = 1 << 0;
4523
4524 /**
4525 * It is acceptable to use small amounts of multipath data on an ongoing basis to provide
4526 * a backup channel for traffic that is primarily going over another network.
4527 *
4528 * An example might be maintaining backup connections to peers or servers for the purpose of
4529 * fast fallback if the default network is temporarily unresponsive or disconnects. The traffic
4530 * on backup paths should be negligible compared to the traffic on the main path.
4531 */
4532 public static final int MULTIPATH_PREFERENCE_RELIABILITY = 1 << 1;
4533
4534 /**
4535 * It is acceptable to use metered data to improve network latency and performance.
4536 */
4537 public static final int MULTIPATH_PREFERENCE_PERFORMANCE = 1 << 2;
4538
4539 /**
4540 * Return value to use for unmetered networks. On such networks we currently set all the flags
4541 * to true.
4542 * @hide
4543 */
4544 public static final int MULTIPATH_PREFERENCE_UNMETERED =
4545 MULTIPATH_PREFERENCE_HANDOVER |
4546 MULTIPATH_PREFERENCE_RELIABILITY |
4547 MULTIPATH_PREFERENCE_PERFORMANCE;
4548
4549 /** @hide */
4550 @Retention(RetentionPolicy.SOURCE)
4551 @IntDef(flag = true, value = {
4552 MULTIPATH_PREFERENCE_HANDOVER,
4553 MULTIPATH_PREFERENCE_RELIABILITY,
4554 MULTIPATH_PREFERENCE_PERFORMANCE,
4555 })
4556 public @interface MultipathPreference {
4557 }
4558
4559 /**
4560 * Provides a hint to the calling application on whether it is desirable to use the
4561 * multinetwork APIs (e.g., {@link Network#openConnection}, {@link Network#bindSocket}, etc.)
4562 * for multipath data transfer on this network when it is not the system default network.
4563 * Applications desiring to use multipath network protocols should call this method before
4564 * each such operation.
Lorenzo Colitti231efb02017-01-24 18:08:41 +09004565 *
4566 * @param network The network on which the application desires to use multipath data.
4567 * If {@code null}, this method will return the a preference that will generally
4568 * apply to metered networks.
4569 * @return a bitwise OR of zero or more of the {@code MULTIPATH_PREFERENCE_*} constants.
4570 */
Jeff Sharkey2ac62992017-04-24 11:18:03 -06004571 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean42a9c292019-01-07 19:26:34 +09004572 public @MultipathPreference int getMultipathPreference(@Nullable Network network) {
Lorenzo Colitti231efb02017-01-24 18:08:41 +09004573 try {
4574 return mService.getMultipathPreference(network);
4575 } catch (RemoteException e) {
4576 throw e.rethrowFromSystemServer();
4577 }
4578 }
4579
4580 /**
Stuart Scottd3bb5082015-03-30 13:17:11 -07004581 * Resets all connectivity manager settings back to factory defaults.
4582 * @hide
4583 */
Chiachang Wang0cefc1c2021-03-18 09:44:34 +08004584 @SystemApi(client = MODULE_LIBRARIES)
4585 @RequiresPermission(anyOf = {
4586 android.Manifest.permission.NETWORK_SETTINGS,
4587 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK})
Stuart Scottd3bb5082015-03-30 13:17:11 -07004588 public void factoryReset() {
Stuart Scottd3bb5082015-03-30 13:17:11 -07004589 try {
Stuart Scottca888bf2015-04-02 18:00:02 -07004590 mService.factoryReset();
Automerger Merge Worker9b0c0c62020-03-06 00:38:43 +00004591 mTetheringManager.stopAllTethering();
Stuart Scottd3bb5082015-03-30 13:17:11 -07004592 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07004593 throw e.rethrowFromSystemServer();
Stuart Scottd3bb5082015-03-30 13:17:11 -07004594 }
4595 }
4596
4597 /**
Paul Jensene98c6e02014-05-29 10:12:39 -04004598 * Binds the current process to {@code network}. All Sockets created in the future
4599 * (and not explicitly bound via a bound SocketFactory from
4600 * {@link Network#getSocketFactory() Network.getSocketFactory()}) will be bound to
4601 * {@code network}. All host name resolutions will be limited to {@code network} as well.
4602 * Note that if {@code network} ever disconnects, all Sockets created in this way will cease to
4603 * work and all host name resolutions will fail. This is by design so an application doesn't
4604 * accidentally use Sockets it thinks are still bound to a particular {@link Network}.
4605 * To clear binding pass {@code null} for {@code network}. Using individually bound
4606 * Sockets created by Network.getSocketFactory().createSocket() and
4607 * performing network-specific host name resolutions via
4608 * {@link Network#getAllByName Network.getAllByName} is preferred to calling
Paul Jensen895c3942015-03-10 10:54:12 -04004609 * {@code bindProcessToNetwork}.
Paul Jensene98c6e02014-05-29 10:12:39 -04004610 *
4611 * @param network The {@link Network} to bind the current process to, or {@code null} to clear
4612 * the current binding.
4613 * @return {@code true} on success, {@code false} if the {@link Network} is no longer valid.
4614 */
Chalard Jean42a9c292019-01-07 19:26:34 +09004615 public boolean bindProcessToNetwork(@Nullable Network network) {
Chalard Jean73d9db72018-06-04 16:52:49 +09004616 // Forcing callers to call through non-static function ensures ConnectivityManager
Paul Jensen895c3942015-03-10 10:54:12 -04004617 // instantiated.
4618 return setProcessDefaultNetwork(network);
4619 }
4620
4621 /**
4622 * Binds the current process to {@code network}. All Sockets created in the future
4623 * (and not explicitly bound via a bound SocketFactory from
4624 * {@link Network#getSocketFactory() Network.getSocketFactory()}) will be bound to
4625 * {@code network}. All host name resolutions will be limited to {@code network} as well.
4626 * Note that if {@code network} ever disconnects, all Sockets created in this way will cease to
4627 * work and all host name resolutions will fail. This is by design so an application doesn't
4628 * accidentally use Sockets it thinks are still bound to a particular {@link Network}.
4629 * To clear binding pass {@code null} for {@code network}. Using individually bound
4630 * Sockets created by Network.getSocketFactory().createSocket() and
4631 * performing network-specific host name resolutions via
4632 * {@link Network#getAllByName Network.getAllByName} is preferred to calling
4633 * {@code setProcessDefaultNetwork}.
4634 *
4635 * @param network The {@link Network} to bind the current process to, or {@code null} to clear
4636 * the current binding.
4637 * @return {@code true} on success, {@code false} if the {@link Network} is no longer valid.
4638 * @deprecated This function can throw {@link IllegalStateException}. Use
4639 * {@link #bindProcessToNetwork} instead. {@code bindProcessToNetwork}
4640 * is a direct replacement.
4641 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -07004642 @Deprecated
Chalard Jean42a9c292019-01-07 19:26:34 +09004643 public static boolean setProcessDefaultNetwork(@Nullable Network network) {
Paul Jensen99c36662014-08-27 12:38:45 -04004644 int netId = (network == null) ? NETID_UNSET : network.netId;
Lorenzo Colitti3fadff92019-01-31 13:08:24 +09004645 boolean isSameNetId = (netId == NetworkUtils.getBoundNetworkForProcess());
4646
Lorenzo Colitti580483e2019-01-30 23:04:54 +09004647 if (netId != NETID_UNSET) {
4648 netId = network.getNetIdForResolv();
Paul Jensen99c36662014-08-27 12:38:45 -04004649 }
Lorenzo Colitti3fadff92019-01-31 13:08:24 +09004650
4651 if (!NetworkUtils.bindProcessToNetwork(netId)) {
4652 return false;
4653 }
4654
4655 if (!isSameNetId) {
Paul Jensen12131352014-12-10 15:12:18 -05004656 // Set HTTP proxy system properties to match network.
4657 // TODO: Deprecate this static method and replace it with a non-static version.
Lorenzo Colitti40898252015-04-22 11:52:48 +09004658 try {
Remi NGUYEN VANa1860ff2021-02-03 10:18:20 +09004659 Proxy.setHttpProxyConfiguration(getInstance().getDefaultProxy());
Lorenzo Colitti40898252015-04-22 11:52:48 +09004660 } catch (SecurityException e) {
4661 // The process doesn't have ACCESS_NETWORK_STATE, so we can't fetch the proxy.
4662 Log.e(TAG, "Can't set proxy properties", e);
4663 }
Paul Jensen99c36662014-08-27 12:38:45 -04004664 // Must flush DNS cache as new network may have different DNS resolutions.
4665 InetAddress.clearDnsCache();
4666 // Must flush socket pool as idle sockets will be bound to previous network and may
4667 // cause subsequent fetches to be performed on old network.
4668 NetworkEventDispatcher.getInstance().onNetworkConfigurationChanged();
Paul Jensen99c36662014-08-27 12:38:45 -04004669 }
Lorenzo Colitti3fadff92019-01-31 13:08:24 +09004670
4671 return true;
Paul Jensene98c6e02014-05-29 10:12:39 -04004672 }
4673
4674 /**
4675 * Returns the {@link Network} currently bound to this process via
Paul Jensen895c3942015-03-10 10:54:12 -04004676 * {@link #bindProcessToNetwork}, or {@code null} if no {@link Network} is explicitly bound.
Paul Jensene98c6e02014-05-29 10:12:39 -04004677 *
4678 * @return {@code Network} to which this process is bound, or {@code null}.
4679 */
Chalard Jean42a9c292019-01-07 19:26:34 +09004680 @Nullable
Paul Jensen895c3942015-03-10 10:54:12 -04004681 public Network getBoundNetworkForProcess() {
4682 // Forcing callers to call thru non-static function ensures ConnectivityManager
4683 // instantiated.
4684 return getProcessDefaultNetwork();
4685 }
4686
4687 /**
4688 * Returns the {@link Network} currently bound to this process via
4689 * {@link #bindProcessToNetwork}, or {@code null} if no {@link Network} is explicitly bound.
4690 *
4691 * @return {@code Network} to which this process is bound, or {@code null}.
4692 * @deprecated Using this function can lead to other functions throwing
4693 * {@link IllegalStateException}. Use {@link #getBoundNetworkForProcess} instead.
4694 * {@code getBoundNetworkForProcess} is a direct replacement.
4695 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -07004696 @Deprecated
Chalard Jean42a9c292019-01-07 19:26:34 +09004697 @Nullable
Paul Jensene98c6e02014-05-29 10:12:39 -04004698 public static Network getProcessDefaultNetwork() {
Paul Jensen895c3942015-03-10 10:54:12 -04004699 int netId = NetworkUtils.getBoundNetworkForProcess();
Paul Jensen8b6260f2014-07-11 08:17:29 -04004700 if (netId == NETID_UNSET) return null;
Paul Jensene98c6e02014-05-29 10:12:39 -04004701 return new Network(netId);
4702 }
4703
Lorenzo Colitti9b026fa2015-07-29 11:41:21 +09004704 private void unsupportedStartingFrom(int version) {
4705 if (Process.myUid() == Process.SYSTEM_UID) {
Lorenzo Colitti62f752c2018-09-28 11:31:55 +09004706 // The getApplicationInfo() call we make below is not supported in system context. Let
4707 // the call through here, and rely on the fact that ConnectivityService will refuse to
4708 // allow the system to use these APIs anyway.
Lorenzo Colitti9b026fa2015-07-29 11:41:21 +09004709 return;
4710 }
4711
4712 if (mContext.getApplicationInfo().targetSdkVersion >= version) {
4713 throw new UnsupportedOperationException(
4714 "This method is not supported in target SDK version " + version + " and above");
4715 }
4716 }
4717
4718 // Checks whether the calling app can use the legacy routing API (startUsingNetworkFeature,
4719 // stopUsingNetworkFeature, requestRouteToHost), and if not throw UnsupportedOperationException.
Lifu Tangae4adaa2016-01-07 23:20:38 -08004720 // TODO: convert the existing system users (Tethering, GnssLocationProvider) to the new APIs and
Lorenzo Colitti9b026fa2015-07-29 11:41:21 +09004721 // remove these exemptions. Note that this check is not secure, and apps can still access these
4722 // functions by accessing ConnectivityService directly. However, it should be clear that doing
4723 // so is unsupported and may break in the future. http://b/22728205
4724 private void checkLegacyRoutingApiAccess() {
Dianne Hackbornc16abda2015-07-31 10:35:34 -07004725 unsupportedStartingFrom(VERSION_CODES.M);
Lorenzo Colitti9b026fa2015-07-29 11:41:21 +09004726 }
4727
Paul Jensene98c6e02014-05-29 10:12:39 -04004728 /**
4729 * Binds host resolutions performed by this process to {@code network}.
Paul Jensen895c3942015-03-10 10:54:12 -04004730 * {@link #bindProcessToNetwork} takes precedence over this setting.
Paul Jensene98c6e02014-05-29 10:12:39 -04004731 *
4732 * @param network The {@link Network} to bind host resolutions from the current process to, or
4733 * {@code null} to clear the current binding.
4734 * @return {@code true} on success, {@code false} if the {@link Network} is no longer valid.
4735 * @hide
4736 * @deprecated This is strictly for legacy usage to support {@link #startUsingNetworkFeature}.
4737 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -07004738 @Deprecated
Mathew Inwoodd078d3d2020-10-27 11:47:29 +00004739 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
Paul Jensene98c6e02014-05-29 10:12:39 -04004740 public static boolean setProcessDefaultNetworkForHostResolution(Network network) {
Paul Jensen8b6260f2014-07-11 08:17:29 -04004741 return NetworkUtils.bindProcessToNetworkForHostResolution(
Erik Klinef2420792018-04-27 22:48:33 +09004742 (network == null) ? NETID_UNSET : network.getNetIdForResolv());
Paul Jensene98c6e02014-05-29 10:12:39 -04004743 }
Felipe Lemed16384b2016-01-22 09:44:57 -08004744
4745 /**
4746 * Device is not restricting metered network activity while application is running on
4747 * background.
4748 */
4749 public static final int RESTRICT_BACKGROUND_STATUS_DISABLED = 1;
4750
4751 /**
4752 * Device is restricting metered network activity while application is running on background,
4753 * but application is allowed to bypass it.
4754 * <p>
4755 * In this state, application should take action to mitigate metered network access.
4756 * For example, a music streaming application should switch to a low-bandwidth bitrate.
4757 */
4758 public static final int RESTRICT_BACKGROUND_STATUS_WHITELISTED = 2;
4759
4760 /**
4761 * Device is restricting metered network activity while application is running on background.
Felipe Leme6a5b7692016-01-27 14:46:39 -08004762 * <p>
Felipe Lemed16384b2016-01-22 09:44:57 -08004763 * In this state, application should not try to use the network while running on background,
4764 * because it would be denied.
4765 */
4766 public static final int RESTRICT_BACKGROUND_STATUS_ENABLED = 3;
4767
Felipe Leme6a5b7692016-01-27 14:46:39 -08004768 /**
4769 * A change in the background metered network activity restriction has occurred.
4770 * <p>
4771 * Applications should call {@link #getRestrictBackgroundStatus()} to check if the restriction
4772 * applies to them.
4773 * <p>
4774 * This is only sent to registered receivers, not manifest receivers.
4775 */
4776 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
4777 public static final String ACTION_RESTRICT_BACKGROUND_CHANGED =
4778 "android.net.conn.RESTRICT_BACKGROUND_CHANGED";
4779
Felipe Leme1b42ef92016-01-25 11:48:04 -08004780 /** @hide */
4781 @Retention(RetentionPolicy.SOURCE)
Felipe Lemed16384b2016-01-22 09:44:57 -08004782 @IntDef(flag = false, value = {
4783 RESTRICT_BACKGROUND_STATUS_DISABLED,
4784 RESTRICT_BACKGROUND_STATUS_WHITELISTED,
4785 RESTRICT_BACKGROUND_STATUS_ENABLED,
4786 })
Felipe Lemed16384b2016-01-22 09:44:57 -08004787 public @interface RestrictBackgroundStatus {
4788 }
4789
Felipe Lemed16384b2016-01-22 09:44:57 -08004790 /**
4791 * Determines if the calling application is subject to metered network restrictions while
4792 * running on background.
Felipe Leme6bd46fc2016-05-16 13:57:19 -07004793 *
4794 * @return {@link #RESTRICT_BACKGROUND_STATUS_DISABLED},
4795 * {@link #RESTRICT_BACKGROUND_STATUS_ENABLED},
4796 * or {@link #RESTRICT_BACKGROUND_STATUS_WHITELISTED}
Felipe Lemed16384b2016-01-22 09:44:57 -08004797 */
4798 public @RestrictBackgroundStatus int getRestrictBackgroundStatus() {
4799 try {
Remi NGUYEN VAN92f20602021-03-18 14:23:12 +09004800 return mService.getRestrictBackgroundStatusByCaller();
Felipe Lemed16384b2016-01-22 09:44:57 -08004801 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07004802 throw e.rethrowFromSystemServer();
Felipe Lemed16384b2016-01-22 09:44:57 -08004803 }
4804 }
Ricky Waid53cf002018-01-23 04:09:45 +00004805
4806 /**
4807 * The network watchlist is a list of domains and IP addresses that are associated with
Ricky Wai573dcab2018-03-20 14:20:54 +00004808 * potentially harmful apps. This method returns the SHA-256 of the watchlist config file
4809 * currently used by the system for validation purposes.
Ricky Waid53cf002018-01-23 04:09:45 +00004810 *
4811 * @return Hash of network watchlist config file. Null if config does not exist.
4812 */
Chalard Jean42a9c292019-01-07 19:26:34 +09004813 @Nullable
Ricky Waid53cf002018-01-23 04:09:45 +00004814 public byte[] getNetworkWatchlistConfigHash() {
4815 try {
4816 return mService.getNetworkWatchlistConfigHash();
4817 } catch (RemoteException e) {
4818 Log.e(TAG, "Unable to get watchlist config hash");
4819 throw e.rethrowFromSystemServer();
4820 }
4821 }
Jeff Vander Stoepe7205d62018-07-23 10:57:53 -07004822
4823 /**
4824 * Returns the {@code uid} of the owner of a network connection.
4825 *
Benedict Wong8974a1c2020-01-20 22:14:59 -08004826 * @param protocol The protocol of the connection. Only {@code IPPROTO_TCP} and {@code
4827 * IPPROTO_UDP} currently supported.
Jeff Vander Stoepe7205d62018-07-23 10:57:53 -07004828 * @param local The local {@link InetSocketAddress} of a connection.
4829 * @param remote The remote {@link InetSocketAddress} of a connection.
Jeff Vander Stoepe7205d62018-07-23 10:57:53 -07004830 * @return {@code uid} if the connection is found and the app has permission to observe it
Benedict Wong8974a1c2020-01-20 22:14:59 -08004831 * (e.g., if it is associated with the calling VPN app's VpnService tunnel) or {@link
4832 * android.os.Process#INVALID_UID} if the connection is not found.
4833 * @throws {@link SecurityException} if the caller is not the active VpnService for the current
4834 * user.
4835 * @throws {@link IllegalArgumentException} if an unsupported protocol is requested.
Jeff Vander Stoepe7205d62018-07-23 10:57:53 -07004836 */
Benedict Wong8974a1c2020-01-20 22:14:59 -08004837 public int getConnectionOwnerUid(
4838 int protocol, @NonNull InetSocketAddress local, @NonNull InetSocketAddress remote) {
Jeff Vander Stoepe7205d62018-07-23 10:57:53 -07004839 ConnectionInfo connectionInfo = new ConnectionInfo(protocol, local, remote);
4840 try {
4841 return mService.getConnectionOwnerUid(connectionInfo);
4842 } catch (RemoteException e) {
4843 throw e.rethrowFromSystemServer();
4844 }
4845 }
Soi, Yoshinari99efcbd2015-11-12 12:09:02 +09004846
4847 private void printStackTrace() {
4848 if (DEBUG) {
4849 final StackTraceElement[] callStack = Thread.currentThread().getStackTrace();
4850 final StringBuffer sb = new StringBuffer();
4851 for (int i = 3; i < callStack.length; i++) {
4852 final String stackTrace = callStack[i].toString();
4853 if (stackTrace == null || stackTrace.contains("android.os")) {
4854 break;
4855 }
4856 sb.append(" [").append(stackTrace).append("]");
4857 }
4858 Log.d(TAG, "StackLog:" + sb.toString());
4859 }
4860 }
Cody Kestingb5c7abd2020-04-15 12:33:28 -07004861
Remi NGUYEN VANfe97b482021-01-15 23:02:47 +09004862 /** @hide */
4863 public TestNetworkManager startOrGetTestNetworkManager() {
4864 final IBinder tnBinder;
4865 try {
4866 tnBinder = mService.startOrGetTestNetworkService();
4867 } catch (RemoteException e) {
4868 throw e.rethrowFromSystemServer();
4869 }
4870
4871 return new TestNetworkManager(ITestNetworkManager.Stub.asInterface(tnBinder));
4872 }
4873
Remi NGUYEN VANfe97b482021-01-15 23:02:47 +09004874 /** @hide */
4875 public ConnectivityDiagnosticsManager createDiagnosticsManager() {
4876 return new ConnectivityDiagnosticsManager(mContext, mService);
4877 }
4878
Cody Kestingb5c7abd2020-04-15 12:33:28 -07004879 /**
4880 * Simulates a Data Stall for the specified Network.
4881 *
Remi NGUYEN VAN7d4530b2021-01-12 18:40:04 +09004882 * <p>This method should only be used for tests.
4883 *
Cody Kestingb5c7abd2020-04-15 12:33:28 -07004884 * <p>The caller must be the owner of the specified Network.
4885 *
4886 * @param detectionMethod The detection method used to identify the Data Stall.
4887 * @param timestampMillis The timestamp at which the stall 'occurred', in milliseconds.
4888 * @param network The Network for which a Data Stall is being simluated.
4889 * @param extras The PersistableBundle of extras included in the Data Stall notification.
4890 * @throws SecurityException if the caller is not the owner of the given network.
4891 * @hide
4892 */
Remi NGUYEN VAN7d4530b2021-01-12 18:40:04 +09004893 @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
Cody Kestingb5c7abd2020-04-15 12:33:28 -07004894 @RequiresPermission(anyOf = {android.Manifest.permission.MANAGE_TEST_NETWORKS,
4895 android.Manifest.permission.NETWORK_STACK})
4896 public void simulateDataStall(int detectionMethod, long timestampMillis,
4897 @NonNull Network network, @NonNull PersistableBundle extras) {
4898 try {
4899 mService.simulateDataStall(detectionMethod, timestampMillis, network, extras);
4900 } catch (RemoteException e) {
4901 e.rethrowFromSystemServer();
4902 }
4903 }
James Mattisdcea9fb2020-10-28 21:48:54 -07004904
Daniel Bright60f02ed2020-06-15 16:10:01 -07004905 @NonNull
4906 private final List<QosCallbackConnection> mQosCallbackConnections = new ArrayList<>();
4907
4908 /**
4909 * Registers a {@link QosSocketInfo} with an associated {@link QosCallback}. The callback will
4910 * receive available QoS events related to the {@link Network} and local ip + port
4911 * specified within socketInfo.
4912 * <p/>
4913 * The same {@link QosCallback} must be unregistered before being registered a second time,
4914 * otherwise {@link QosCallbackRegistrationException} is thrown.
4915 * <p/>
4916 * This API does not, in itself, require any permission if called with a network that is not
4917 * restricted. However, the underlying implementation currently only supports the IMS network,
4918 * which is always restricted. That means non-preinstalled callers can't possibly find this API
4919 * useful, because they'd never be called back on networks that they would have access to.
4920 *
4921 * @throws SecurityException if {@link QosSocketInfo#getNetwork()} is restricted and the app is
4922 * missing CONNECTIVITY_USE_RESTRICTED_NETWORKS permission.
4923 * @throws QosCallback.QosCallbackRegistrationException if qosCallback is already registered.
4924 * @throws RuntimeException if the app already has too many callbacks registered.
4925 *
4926 * Exceptions after the time of registration is passed through
4927 * {@link QosCallback#onError(QosCallbackException)}. see: {@link QosCallbackException}.
4928 *
4929 * @param socketInfo the socket information used to match QoS events
4930 * @param callback receives qos events that satisfy socketInfo
4931 * @param executor The executor on which the callback will be invoked. The provided
4932 * {@link Executor} must run callback sequentially, otherwise the order of
4933 * callbacks cannot be guaranteed.
4934 *
4935 * @hide
4936 */
4937 @SystemApi
4938 public void registerQosCallback(@NonNull final QosSocketInfo socketInfo,
4939 @NonNull final QosCallback callback,
4940 @CallbackExecutor @NonNull final Executor executor) {
4941 Objects.requireNonNull(socketInfo, "socketInfo must be non-null");
4942 Objects.requireNonNull(callback, "callback must be non-null");
4943 Objects.requireNonNull(executor, "executor must be non-null");
4944
4945 try {
4946 synchronized (mQosCallbackConnections) {
4947 if (getQosCallbackConnection(callback) == null) {
4948 final QosCallbackConnection connection =
4949 new QosCallbackConnection(this, callback, executor);
4950 mQosCallbackConnections.add(connection);
4951 mService.registerQosSocketCallback(socketInfo, connection);
4952 } else {
4953 Log.e(TAG, "registerQosCallback: Callback already registered");
4954 throw new QosCallbackRegistrationException();
4955 }
4956 }
4957 } catch (final RemoteException e) {
4958 Log.e(TAG, "registerQosCallback: Error while registering ", e);
4959
4960 // The same unregister method method is called for consistency even though nothing
4961 // will be sent to the ConnectivityService since the callback was never successfully
4962 // registered.
4963 unregisterQosCallback(callback);
4964 e.rethrowFromSystemServer();
4965 } catch (final ServiceSpecificException e) {
4966 Log.e(TAG, "registerQosCallback: Error while registering ", e);
4967 unregisterQosCallback(callback);
4968 throw convertServiceException(e);
4969 }
4970 }
4971
4972 /**
4973 * Unregisters the given {@link QosCallback}. The {@link QosCallback} will no longer receive
4974 * events once unregistered and can be registered a second time.
4975 * <p/>
4976 * If the {@link QosCallback} does not have an active registration, it is a no-op.
4977 *
4978 * @param callback the callback being unregistered
4979 *
4980 * @hide
4981 */
4982 @SystemApi
4983 public void unregisterQosCallback(@NonNull final QosCallback callback) {
4984 Objects.requireNonNull(callback, "The callback must be non-null");
4985 try {
4986 synchronized (mQosCallbackConnections) {
4987 final QosCallbackConnection connection = getQosCallbackConnection(callback);
4988 if (connection != null) {
4989 connection.stopReceivingMessages();
4990 mService.unregisterQosCallback(connection);
4991 mQosCallbackConnections.remove(connection);
4992 } else {
4993 Log.d(TAG, "unregisterQosCallback: Callback not registered");
4994 }
4995 }
4996 } catch (final RemoteException e) {
4997 Log.e(TAG, "unregisterQosCallback: Error while unregistering ", e);
4998 e.rethrowFromSystemServer();
4999 }
5000 }
5001
5002 /**
5003 * Gets the connection related to the callback.
5004 *
5005 * @param callback the callback to look up
5006 * @return the related connection
5007 */
5008 @Nullable
5009 private QosCallbackConnection getQosCallbackConnection(final QosCallback callback) {
5010 for (final QosCallbackConnection connection : mQosCallbackConnections) {
5011 // Checking by reference here is intentional
5012 if (connection.getCallback() == callback) {
5013 return connection;
5014 }
5015 }
5016 return null;
5017 }
Junyu Lai23568a42021-01-19 11:10:56 +00005018
5019 /**
Roshan Pius7992afd2020-12-22 15:10:42 -08005020 * Request a network to satisfy a set of {@link NetworkCapabilities}, but
Junyu Lai23568a42021-01-19 11:10:56 +00005021 * does not cause any networks to retain the NET_CAPABILITY_FOREGROUND capability. This can
5022 * be used to request that the system provide a network without causing the network to be
5023 * in the foreground.
5024 *
5025 * <p>This method will attempt to find the best network that matches the passed
5026 * {@link NetworkRequest}, and to bring up one that does if none currently satisfies the
5027 * criteria. The platform will evaluate which network is the best at its own discretion.
5028 * Throughput, latency, cost per byte, policy, user preference and other considerations
5029 * may be factored in the decision of what is considered the best network.
5030 *
5031 * <p>As long as this request is outstanding, the platform will try to maintain the best network
5032 * matching this request, while always attempting to match the request to a better network if
5033 * possible. If a better match is found, the platform will switch this request to the now-best
5034 * network and inform the app of the newly best network by invoking
5035 * {@link NetworkCallback#onAvailable(Network)} on the provided callback. Note that the platform
5036 * will not try to maintain any other network than the best one currently matching the request:
5037 * a network not matching any network request may be disconnected at any time.
5038 *
5039 * <p>For example, an application could use this method to obtain a connected cellular network
5040 * even if the device currently has a data connection over Ethernet. This may cause the cellular
5041 * radio to consume additional power. Or, an application could inform the system that it wants
5042 * a network supporting sending MMSes and have the system let it know about the currently best
5043 * MMS-supporting network through the provided {@link NetworkCallback}.
5044 *
5045 * <p>The status of the request can be followed by listening to the various callbacks described
5046 * in {@link NetworkCallback}. The {@link Network} object passed to the callback methods can be
5047 * used to direct traffic to the network (although accessing some networks may be subject to
5048 * holding specific permissions). Callers will learn about the specific characteristics of the
5049 * network through
5050 * {@link NetworkCallback#onCapabilitiesChanged(Network, NetworkCapabilities)} and
5051 * {@link NetworkCallback#onLinkPropertiesChanged(Network, LinkProperties)}. The methods of the
5052 * provided {@link NetworkCallback} will only be invoked due to changes in the best network
5053 * matching the request at any given time; therefore when a better network matching the request
5054 * becomes available, the {@link NetworkCallback#onAvailable(Network)} method is called
5055 * with the new network after which no further updates are given about the previously-best
5056 * network, unless it becomes the best again at some later time. All callbacks are invoked
5057 * in order on the same thread, which by default is a thread created by the framework running
5058 * in the app.
5059 *
5060 * <p>This{@link NetworkRequest} will live until released via
5061 * {@link #unregisterNetworkCallback(NetworkCallback)} or the calling application exits, at
5062 * which point the system may let go of the network at any time.
5063 *
5064 * <p>It is presently unsupported to request a network with mutable
5065 * {@link NetworkCapabilities} such as
5066 * {@link NetworkCapabilities#NET_CAPABILITY_VALIDATED} or
5067 * {@link NetworkCapabilities#NET_CAPABILITY_CAPTIVE_PORTAL}
5068 * as these {@code NetworkCapabilities} represent states that a particular
5069 * network may never attain, and whether a network will attain these states
5070 * is unknown prior to bringing up the network so the framework does not
5071 * know how to go about satisfying a request with these capabilities.
5072 *
5073 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
5074 * number of outstanding requests to 100 per app (identified by their UID), shared with
5075 * all variants of this method, of {@link #registerNetworkCallback} as well as
5076 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
5077 * Requesting a network with this method will count toward this limit. If this limit is
5078 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
5079 * make sure to unregister the callbacks with
5080 * {@link #unregisterNetworkCallback(NetworkCallback)}.
5081 *
5082 * @param request {@link NetworkRequest} describing this request.
5083 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
5084 * If null, the callback is invoked on the default internal Handler.
5085 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
5086 * the callback must not be shared - it uniquely specifies this request.
5087 * @throws IllegalArgumentException if {@code request} contains invalid network capabilities.
5088 * @throws SecurityException if missing the appropriate permissions.
5089 * @throws RuntimeException if the app already has too many callbacks registered.
5090 *
5091 * @hide
5092 */
5093 @SystemApi(client = MODULE_LIBRARIES)
5094 @SuppressLint("ExecutorRegistration")
5095 @RequiresPermission(anyOf = {
5096 android.Manifest.permission.NETWORK_SETTINGS,
5097 android.Manifest.permission.NETWORK_STACK,
5098 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK
5099 })
5100 public void requestBackgroundNetwork(@NonNull NetworkRequest request,
junyulaif4bc12f2021-03-09 20:49:48 +08005101 @NonNull Handler handler, @NonNull NetworkCallback networkCallback) {
Junyu Lai23568a42021-01-19 11:10:56 +00005102 final NetworkCapabilities nc = request.networkCapabilities;
5103 sendRequestForNetwork(nc, networkCallback, 0, BACKGROUND_REQUEST,
junyulaif4bc12f2021-03-09 20:49:48 +08005104 TYPE_NONE, new CallbackHandler(handler));
Junyu Lai23568a42021-01-19 11:10:56 +00005105 }
James Mattis6e6fabf2021-01-10 14:24:24 -08005106
5107 /**
James Mattis6e6fabf2021-01-10 14:24:24 -08005108 * Used by automotive devices to set the network preferences used to direct traffic at an
5109 * application level as per the given OemNetworkPreferences. An example use-case would be an
5110 * automotive OEM wanting to provide connectivity for applications critical to the usage of a
5111 * vehicle via a particular network.
5112 *
5113 * Calling this will overwrite the existing preference.
5114 *
5115 * @param preference {@link OemNetworkPreferences} The application network preference to be set.
5116 * @param executor the executor on which listener will be invoked.
5117 * @param listener {@link OnSetOemNetworkPreferenceListener} optional listener used to
5118 * communicate completion of setOemNetworkPreference(). This will only be
5119 * called once upon successful completion of setOemNetworkPreference().
5120 * @throws IllegalArgumentException if {@code preference} contains invalid preference values.
5121 * @throws SecurityException if missing the appropriate permissions.
5122 * @throws UnsupportedOperationException if called on a non-automotive device.
James Mattis7a253542021-01-26 16:23:52 -08005123 * @hide
James Mattis6e6fabf2021-01-10 14:24:24 -08005124 */
James Mattis7a253542021-01-26 16:23:52 -08005125 @SystemApi
James Mattis981865c2021-01-26 14:05:36 -08005126 @RequiresPermission(android.Manifest.permission.CONTROL_OEM_PAID_NETWORK_PREFERENCE)
James Mattis7a253542021-01-26 16:23:52 -08005127 public void setOemNetworkPreference(@NonNull final OemNetworkPreferences preference,
James Mattis6e6fabf2021-01-10 14:24:24 -08005128 @Nullable @CallbackExecutor final Executor executor,
Chalard Jeancc9ad152021-03-03 16:37:13 +09005129 @Nullable final Runnable listener) {
James Mattis6e6fabf2021-01-10 14:24:24 -08005130 Objects.requireNonNull(preference, "OemNetworkPreferences must be non-null");
5131 if (null != listener) {
5132 Objects.requireNonNull(executor, "Executor must be non-null");
5133 }
Chalard Jeancc9ad152021-03-03 16:37:13 +09005134 final IOnCompleteListener listenerInternal = listener == null ? null :
5135 new IOnCompleteListener.Stub() {
James Mattis6e6fabf2021-01-10 14:24:24 -08005136 @Override
5137 public void onComplete() {
Chalard Jeancc9ad152021-03-03 16:37:13 +09005138 executor.execute(listener::run);
James Mattis6e6fabf2021-01-10 14:24:24 -08005139 }
5140 };
5141
5142 try {
5143 mService.setOemNetworkPreference(preference, listenerInternal);
5144 } catch (RemoteException e) {
5145 Log.e(TAG, "setOemNetworkPreference() failed for preference: " + preference.toString());
5146 throw e.rethrowFromSystemServer();
5147 }
5148 }
lucaslin1a6095c2021-03-12 00:46:33 +08005149
Chalard Jean03433052021-02-25 17:23:40 +09005150 /**
5151 * Request that a user profile is put by default on a network matching a given preference.
5152 *
5153 * See the documentation for the individual preferences for a description of the supported
5154 * behaviors.
5155 *
5156 * @param profile the profile concerned.
5157 * @param preference the preference for this profile.
5158 * @param executor an executor to execute the listener on. Optional if listener is null.
5159 * @param listener an optional listener to listen for completion of the operation.
5160 * @throws IllegalArgumentException if {@code profile} is not a valid user profile.
5161 * @throws SecurityException if missing the appropriate permissions.
5162 * @hide
5163 */
Chalard Jeancc9ad152021-03-03 16:37:13 +09005164 // This function is for establishing per-profile default networking and can only be called by
5165 // the device policy manager, running as the system server. It would make no sense to call it
5166 // on a context for a user because it does not establish a setting on behalf of a user, rather
5167 // it establishes a setting for a user on behalf of the DPM.
5168 @SuppressLint({"UserHandle"})
5169 @SystemApi(client = MODULE_LIBRARIES)
Chalard Jean03433052021-02-25 17:23:40 +09005170 @RequiresPermission(android.Manifest.permission.NETWORK_STACK)
5171 public void setProfileNetworkPreference(@NonNull final UserHandle profile,
5172 @ProfileNetworkPreference final int preference,
5173 @Nullable @CallbackExecutor final Executor executor,
5174 @Nullable final Runnable listener) {
5175 if (null != listener) {
5176 Objects.requireNonNull(executor, "Pass a non-null executor, or a null listener");
5177 }
5178 final IOnCompleteListener proxy;
5179 if (null == listener) {
5180 proxy = null;
5181 } else {
5182 proxy = new IOnCompleteListener.Stub() {
5183 @Override
5184 public void onComplete() {
5185 executor.execute(listener::run);
5186 }
5187 };
5188 }
5189 try {
5190 mService.setProfileNetworkPreference(profile, preference, proxy);
5191 } catch (RemoteException e) {
5192 throw e.rethrowFromSystemServer();
5193 }
5194 }
5195
lucaslin1a6095c2021-03-12 00:46:33 +08005196 // The first network ID of IPSec tunnel interface.
lucaslin28633072021-03-15 17:24:12 +08005197 private static final int TUN_INTF_NETID_START = 0xFC00; // 0xFC00 = 64512
lucaslin1a6095c2021-03-12 00:46:33 +08005198 // The network ID range of IPSec tunnel interface.
lucaslin28633072021-03-15 17:24:12 +08005199 private static final int TUN_INTF_NETID_RANGE = 0x0400; // 0x0400 = 1024
lucaslin1a6095c2021-03-12 00:46:33 +08005200
5201 /**
5202 * Get the network ID range reserved for IPSec tunnel interfaces.
5203 *
5204 * @return A Range which indicates the network ID range of IPSec tunnel interface.
5205 * @hide
5206 */
5207 @SystemApi(client = MODULE_LIBRARIES)
5208 @NonNull
5209 public static Range<Integer> getIpSecNetIdRange() {
5210 return new Range(TUN_INTF_NETID_START, TUN_INTF_NETID_START + TUN_INTF_NETID_RANGE - 1);
5211 }
lucaslin50205af2021-03-12 16:11:27 +08005212
5213 /**
5214 * Get private DNS mode from settings.
5215 *
lucaslin73c98602021-03-17 14:53:35 +08005216 * @param context The Context to query the private DNS mode from settings.
lucaslin50205af2021-03-12 16:11:27 +08005217 * @return A string of private DNS mode as one of the PRIVATE_DNS_MODE_* constants.
5218 *
5219 * @hide
5220 */
5221 @SystemApi(client = MODULE_LIBRARIES)
5222 @NonNull
5223 @PrivateDnsMode
lucaslinacd3ded2021-03-16 17:11:14 +08005224 public static String getPrivateDnsMode(@NonNull Context context) {
5225 final ContentResolver cr = context.getContentResolver();
lucaslin50205af2021-03-12 16:11:27 +08005226 String mode = Settings.Global.getString(cr, PRIVATE_DNS_MODE);
5227 if (TextUtils.isEmpty(mode)) mode = Settings.Global.getString(cr, PRIVATE_DNS_DEFAULT_MODE);
5228 // If both PRIVATE_DNS_MODE and PRIVATE_DNS_DEFAULT_MODE are not set, choose
5229 // PRIVATE_DNS_MODE_OPPORTUNISTIC as default mode.
5230 if (TextUtils.isEmpty(mode)) mode = PRIVATE_DNS_MODE_OPPORTUNISTIC;
5231 return mode;
5232 }
The Android Open Source Project28527d22009-03-03 19:31:44 -08005233}