blob: 8c93676419497ebc4720ef9a0382c690952dc059 [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
markchien75721e42020-01-21 13:11:06 +080076import com.android.internal.annotations.GuardedBy;
Robert Greenwalt3d6c9582014-05-21 20:04:36 -070077
Paul Jensen99c36662014-08-27 12:38:45 -040078import libcore.net.event.NetworkEventDispatcher;
79
junyulai61143782019-03-04 22:45:36 +080080import java.io.IOException;
81import java.io.UncheckedIOException;
Felipe Lemed16384b2016-01-22 09:44:57 -080082import java.lang.annotation.Retention;
83import java.lang.annotation.RetentionPolicy;
Lorenzo Colittie8ce2052020-12-12 00:51:11 +090084import java.net.DatagramSocket;
Jeremy Klein04863332015-12-28 15:11:58 -080085import java.net.InetAddress;
Jeff Vander Stoepe7205d62018-07-23 10:57:53 -070086import java.net.InetSocketAddress;
junyulaic7ea1242019-01-08 20:04:33 +080087import java.net.Socket;
Hugo Benichi45a49542017-03-06 09:17:06 +090088import java.util.ArrayList;
Lorenzo Colittie8ce2052020-12-12 00:51:11 +090089import java.util.Collection;
Jeremy Klein04863332015-12-28 15:11:58 -080090import java.util.HashMap;
Hugo Benichi45a49542017-03-06 09:17:06 +090091import java.util.List;
92import java.util.Map;
markchien75721e42020-01-21 13:11:06 +080093import java.util.Objects;
junyulaia86defc2018-12-27 17:25:29 +080094import java.util.concurrent.Executor;
junyulai9f872232019-01-16 20:23:34 +080095import java.util.concurrent.ExecutorService;
96import java.util.concurrent.Executors;
97import java.util.concurrent.RejectedExecutionException;
Jeremy Klein04863332015-12-28 15:11:58 -080098
The Android Open Source Project28527d22009-03-03 19:31:44 -080099/**
100 * Class that answers queries about the state of network connectivity. It also
Jeff Sharkeyb8c73032017-06-02 17:36:26 -0600101 * notifies applications when network connectivity changes.
The Android Open Source Project28527d22009-03-03 19:31:44 -0800102 * <p>
103 * The primary responsibilities of this class are to:
104 * <ol>
105 * <li>Monitor network connections (Wi-Fi, GPRS, UMTS, etc.)</li>
106 * <li>Send broadcast intents when network connectivity changes</li>
107 * <li>Attempt to "fail over" to another network when connectivity to a network
108 * is lost</li>
109 * <li>Provide an API that allows applications to query the coarse-grained or fine-grained
110 * state of the available networks</li>
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -0700111 * <li>Provide an API that allows applications to request and select networks for their data
112 * traffic</li>
The Android Open Source Project28527d22009-03-03 19:31:44 -0800113 * </ol>
114 */
Jeff Sharkeyb8c73032017-06-02 17:36:26 -0600115@SystemService(Context.CONNECTIVITY_SERVICE)
Jeff Sharkey921ebf22011-05-19 17:12:49 -0700116public class ConnectivityManager {
117 private static final String TAG = "ConnectivityManager";
Soi, Yoshinari99efcbd2015-11-12 12:09:02 +0900118 private static final boolean DEBUG = Log.isLoggable(TAG, Log.DEBUG);
Jeff Sharkey921ebf22011-05-19 17:12:49 -0700119
The Android Open Source Project28527d22009-03-03 19:31:44 -0800120 /**
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -0700121 * A change in network connectivity has occurred. A default connection has either
The Android Open Source Project28527d22009-03-03 19:31:44 -0800122 * been established or lost. The NetworkInfo for the affected network is
123 * sent as an extra; it should be consulted to see what kind of
124 * connectivity event occurred.
125 * <p/>
Mark Lue1682a02016-12-05 10:57:55 -0800126 * Apps targeting Android 7.0 (API level 24) and higher do not receive this
127 * broadcast if they declare the broadcast receiver in their manifest. Apps
128 * will still receive broadcasts if they register their
129 * {@link android.content.BroadcastReceiver} with
130 * {@link android.content.Context#registerReceiver Context.registerReceiver()}
131 * and that context is still valid.
132 * <p/>
The Android Open Source Project28527d22009-03-03 19:31:44 -0800133 * If this is a connection that was the result of failing over from a
134 * disconnected network, then the FAILOVER_CONNECTION boolean extra is
135 * set to true.
136 * <p/>
137 * For a loss of connectivity, if the connectivity manager is attempting
138 * to connect (or has already connected) to another network, the
139 * NetworkInfo for the new network is also passed as an extra. This lets
140 * any receivers of the broadcast know that they should not necessarily
141 * tell the user that no data traffic will be possible. Instead, the
Robert Greenwalt26744a52013-02-15 10:56:35 -0800142 * receiver should expect another broadcast soon, indicating either that
The Android Open Source Project28527d22009-03-03 19:31:44 -0800143 * the failover attempt succeeded (and so there is still overall data
144 * connectivity), or that the failover attempt failed, meaning that all
145 * connectivity has been lost.
146 * <p/>
147 * For a disconnect event, the boolean extra EXTRA_NO_CONNECTIVITY
148 * is set to {@code true} if there are no connected networks at all.
Chalard Jeanae2424a2018-02-10 05:33:50 +0900149 *
150 * @deprecated apps should use the more versatile {@link #requestNetwork},
151 * {@link #registerNetworkCallback} or {@link #registerDefaultNetworkCallback}
152 * functions instead for faster and more detailed updates about the network
153 * changes they care about.
The Android Open Source Project28527d22009-03-03 19:31:44 -0800154 */
Jeff Sharkey6932ff62013-02-20 18:21:19 -0800155 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Chalard Jeanae2424a2018-02-10 05:33:50 +0900156 @Deprecated
The Android Open Source Project28527d22009-03-03 19:31:44 -0800157 public static final String CONNECTIVITY_ACTION = "android.net.conn.CONNECTIVITY_CHANGE";
Jeff Sharkey66fa9682011-08-02 17:22:34 -0700158
The Android Open Source Project28527d22009-03-03 19:31:44 -0800159 /**
Paul Jensened4d55c2015-02-27 22:55:47 -0500160 * The device has connected to a network that has presented a captive
161 * portal, which is blocking Internet connectivity. The user was presented
162 * with a notification that network sign in is required,
163 * and the user invoked the notification's action indicating they
Paul Jensen4173cce2015-05-22 10:50:39 -0400164 * desire to sign in to the network. Apps handling this activity should
Paul Jensened4d55c2015-02-27 22:55:47 -0500165 * facilitate signing in to the network. This action includes a
166 * {@link Network} typed extra called {@link #EXTRA_NETWORK} that represents
167 * the network presenting the captive portal; all communication with the
168 * captive portal must be done using this {@code Network} object.
169 * <p/>
Paul Jensen4173cce2015-05-22 10:50:39 -0400170 * This activity includes a {@link CaptivePortal} extra named
171 * {@link #EXTRA_CAPTIVE_PORTAL} that can be used to indicate different
172 * outcomes of the captive portal sign in to the system:
173 * <ul>
174 * <li> When the app handling this action believes the user has signed in to
175 * the network and the captive portal has been dismissed, the app should
176 * call {@link CaptivePortal#reportCaptivePortalDismissed} so the system can
177 * reevaluate the network. If reevaluation finds the network no longer
178 * subject to a captive portal, the network may become the default active
Chalard Jean73d9db72018-06-04 16:52:49 +0900179 * data network.</li>
Paul Jensen4173cce2015-05-22 10:50:39 -0400180 * <li> When the app handling this action believes the user explicitly wants
Paul Jensened4d55c2015-02-27 22:55:47 -0500181 * to ignore the captive portal and the network, the app should call
Paul Jensen4173cce2015-05-22 10:50:39 -0400182 * {@link CaptivePortal#ignoreNetwork}. </li>
183 * </ul>
Paul Jensened4d55c2015-02-27 22:55:47 -0500184 */
185 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
186 public static final String ACTION_CAPTIVE_PORTAL_SIGN_IN = "android.net.conn.CAPTIVE_PORTAL";
187
188 /**
The Android Open Source Project28527d22009-03-03 19:31:44 -0800189 * The lookup key for a {@link NetworkInfo} object. Retrieve with
190 * {@link android.content.Intent#getParcelableExtra(String)}.
Jeff Sharkey66fa9682011-08-02 17:22:34 -0700191 *
Chalard Jeancc47b522019-01-11 16:47:53 +0900192 * @deprecated The {@link NetworkInfo} object is deprecated, as many of its properties
193 * can't accurately represent modern network characteristics.
194 * Please obtain information about networks from the {@link NetworkCapabilities}
195 * or {@link LinkProperties} objects instead.
The Android Open Source Project28527d22009-03-03 19:31:44 -0800196 */
Jeff Sharkey66fa9682011-08-02 17:22:34 -0700197 @Deprecated
The Android Open Source Project28527d22009-03-03 19:31:44 -0800198 public static final String EXTRA_NETWORK_INFO = "networkInfo";
Jeff Sharkey66fa9682011-08-02 17:22:34 -0700199
The Android Open Source Project28527d22009-03-03 19:31:44 -0800200 /**
Jeff Sharkey47905d12012-08-06 11:41:50 -0700201 * Network type which triggered a {@link #CONNECTIVITY_ACTION} broadcast.
Jeff Sharkey47905d12012-08-06 11:41:50 -0700202 *
203 * @see android.content.Intent#getIntExtra(String, int)
Chalard Jeancc47b522019-01-11 16:47:53 +0900204 * @deprecated The network type is not rich enough to represent the characteristics
205 * of modern networks. Please use {@link NetworkCapabilities} instead,
206 * in particular the transports.
Jeff Sharkey47905d12012-08-06 11:41:50 -0700207 */
Chalard Jeancc47b522019-01-11 16:47:53 +0900208 @Deprecated
Jeff Sharkey47905d12012-08-06 11:41:50 -0700209 public static final String EXTRA_NETWORK_TYPE = "networkType";
210
211 /**
The Android Open Source Project28527d22009-03-03 19:31:44 -0800212 * The lookup key for a boolean that indicates whether a connect event
213 * is for a network to which the connectivity manager was failing over
214 * following a disconnect on another network.
215 * Retrieve it with {@link android.content.Intent#getBooleanExtra(String,boolean)}.
junyulai5c2f6262018-12-13 12:47:51 +0800216 *
217 * @deprecated See {@link NetworkInfo}.
The Android Open Source Project28527d22009-03-03 19:31:44 -0800218 */
junyulai5c2f6262018-12-13 12:47:51 +0800219 @Deprecated
The Android Open Source Project28527d22009-03-03 19:31:44 -0800220 public static final String EXTRA_IS_FAILOVER = "isFailover";
221 /**
222 * The lookup key for a {@link NetworkInfo} object. This is supplied when
223 * there is another network that it may be possible to connect to. Retrieve with
224 * {@link android.content.Intent#getParcelableExtra(String)}.
junyulai5c2f6262018-12-13 12:47:51 +0800225 *
226 * @deprecated See {@link NetworkInfo}.
The Android Open Source Project28527d22009-03-03 19:31:44 -0800227 */
junyulai5c2f6262018-12-13 12:47:51 +0800228 @Deprecated
The Android Open Source Project28527d22009-03-03 19:31:44 -0800229 public static final String EXTRA_OTHER_NETWORK_INFO = "otherNetwork";
230 /**
231 * The lookup key for a boolean that indicates whether there is a
232 * complete lack of connectivity, i.e., no network is available.
233 * Retrieve it with {@link android.content.Intent#getBooleanExtra(String,boolean)}.
234 */
235 public static final String EXTRA_NO_CONNECTIVITY = "noConnectivity";
236 /**
237 * The lookup key for a string that indicates why an attempt to connect
238 * to a network failed. The string has no particular structure. It is
239 * intended to be used in notifications presented to users. Retrieve
240 * it with {@link android.content.Intent#getStringExtra(String)}.
241 */
242 public static final String EXTRA_REASON = "reason";
243 /**
244 * The lookup key for a string that provides optionally supplied
245 * extra information about the network state. The information
246 * may be passed up from the lower networking layers, and its
247 * meaning may be specific to a particular network type. Retrieve
248 * it with {@link android.content.Intent#getStringExtra(String)}.
junyulai5c2f6262018-12-13 12:47:51 +0800249 *
250 * @deprecated See {@link NetworkInfo#getExtraInfo()}.
The Android Open Source Project28527d22009-03-03 19:31:44 -0800251 */
junyulai5c2f6262018-12-13 12:47:51 +0800252 @Deprecated
The Android Open Source Project28527d22009-03-03 19:31:44 -0800253 public static final String EXTRA_EXTRA_INFO = "extraInfo";
Robert Greenwalt986c7412010-09-08 15:24:47 -0700254 /**
255 * The lookup key for an int that provides information about
256 * our connection to the internet at large. 0 indicates no connection,
257 * 100 indicates a great connection. Retrieve it with
Jeff Sharkey921ebf22011-05-19 17:12:49 -0700258 * {@link android.content.Intent#getIntExtra(String, int)}.
Robert Greenwalt986c7412010-09-08 15:24:47 -0700259 * {@hide}
260 */
261 public static final String EXTRA_INET_CONDITION = "inetCondition";
The Android Open Source Project28527d22009-03-03 19:31:44 -0800262 /**
Paul Jensen4173cce2015-05-22 10:50:39 -0400263 * The lookup key for a {@link CaptivePortal} object included with the
264 * {@link #ACTION_CAPTIVE_PORTAL_SIGN_IN} intent. The {@code CaptivePortal}
265 * object can be used to either indicate to the system that the captive
266 * portal has been dismissed or that the user does not want to pursue
267 * signing in to captive portal. Retrieve it with
268 * {@link android.content.Intent#getParcelableExtra(String)}.
Paul Jensened4d55c2015-02-27 22:55:47 -0500269 */
Paul Jensen4173cce2015-05-22 10:50:39 -0400270 public static final String EXTRA_CAPTIVE_PORTAL = "android.net.extra.CAPTIVE_PORTAL";
Jan Nordqvist0f3b4442015-09-22 15:54:32 -0700271
272 /**
273 * Key for passing a URL to the captive portal login activity.
274 */
275 public static final String EXTRA_CAPTIVE_PORTAL_URL = "android.net.extra.CAPTIVE_PORTAL_URL";
276
Paul Jensened4d55c2015-02-27 22:55:47 -0500277 /**
Remi NGUYEN VANd937e3a2018-05-22 10:01:53 +0900278 * Key for passing a {@link android.net.captiveportal.CaptivePortalProbeSpec} to the captive
279 * portal login activity.
280 * {@hide}
281 */
Remi NGUYEN VANe541d182019-01-17 14:38:31 +0900282 @SystemApi
Remi NGUYEN VANd937e3a2018-05-22 10:01:53 +0900283 public static final String EXTRA_CAPTIVE_PORTAL_PROBE_SPEC =
284 "android.net.extra.CAPTIVE_PORTAL_PROBE_SPEC";
285
286 /**
Hugo Benichidce21c52016-12-14 08:23:40 +0900287 * Key for passing a user agent string to the captive portal login activity.
288 * {@hide}
289 */
Remi NGUYEN VANe541d182019-01-17 14:38:31 +0900290 @SystemApi
Hugo Benichidce21c52016-12-14 08:23:40 +0900291 public static final String EXTRA_CAPTIVE_PORTAL_USER_AGENT =
292 "android.net.extra.CAPTIVE_PORTAL_USER_AGENT";
293
294 /**
Haoyu Baib5da5752012-06-20 14:29:57 -0700295 * Broadcast action to indicate the change of data activity status
296 * (idle or active) on a network in a recent period.
Robert Greenwalt26744a52013-02-15 10:56:35 -0800297 * The network becomes active when data transmission is started, or
298 * idle if there is no data transmission for a period of time.
Haoyu Baib5da5752012-06-20 14:29:57 -0700299 * {@hide}
300 */
301 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Chalard Jean73d9db72018-06-04 16:52:49 +0900302 public static final String ACTION_DATA_ACTIVITY_CHANGE =
303 "android.net.conn.DATA_ACTIVITY_CHANGE";
Haoyu Baib5da5752012-06-20 14:29:57 -0700304 /**
305 * The lookup key for an enum that indicates the network device type on which this data activity
306 * change happens.
307 * {@hide}
308 */
309 public static final String EXTRA_DEVICE_TYPE = "deviceType";
310 /**
311 * The lookup key for a boolean that indicates the device is active or not. {@code true} means
312 * it is actively sending or receiving data and {@code false} means it is idle.
313 * {@hide}
314 */
315 public static final String EXTRA_IS_ACTIVE = "isActive";
Ashish Sharma601fba92014-03-12 18:42:23 -0700316 /**
317 * The lookup key for a long that contains the timestamp (nanos) of the radio state change.
318 * {@hide}
319 */
320 public static final String EXTRA_REALTIME_NS = "tsNanos";
Haoyu Baib5da5752012-06-20 14:29:57 -0700321
322 /**
The Android Open Source Project28527d22009-03-03 19:31:44 -0800323 * Broadcast Action: The setting for background data usage has changed
324 * values. Use {@link #getBackgroundDataSetting()} to get the current value.
325 * <p>
326 * If an application uses the network in the background, it should listen
327 * for this broadcast and stop using the background data if the value is
Jeff Sharkey921ebf22011-05-19 17:12:49 -0700328 * {@code false}.
Jeff Sharkeyc958c772012-01-30 16:29:24 -0800329 * <p>
330 *
331 * @deprecated As of {@link VERSION_CODES#ICE_CREAM_SANDWICH}, availability
332 * of background data depends on several combined factors, and
333 * this broadcast is no longer sent. Instead, when background
334 * data is unavailable, {@link #getActiveNetworkInfo()} will now
335 * appear disconnected. During first boot after a platform
336 * upgrade, this broadcast will be sent once if
337 * {@link #getBackgroundDataSetting()} was {@code false} before
338 * the upgrade.
The Android Open Source Project28527d22009-03-03 19:31:44 -0800339 */
340 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkeyc958c772012-01-30 16:29:24 -0800341 @Deprecated
The Android Open Source Project28527d22009-03-03 19:31:44 -0800342 public static final String ACTION_BACKGROUND_DATA_SETTING_CHANGED =
343 "android.net.conn.BACKGROUND_DATA_SETTING_CHANGED";
344
Robert Greenwaltd3401f92010-09-15 17:36:33 -0700345 /**
346 * Broadcast Action: The network connection may not be good
347 * uses {@code ConnectivityManager.EXTRA_INET_CONDITION} and
348 * {@code ConnectivityManager.EXTRA_NETWORK_INFO} to specify
349 * the network and it's condition.
350 * @hide
351 */
Jeff Sharkey6932ff62013-02-20 18:21:19 -0800352 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Mathew Inwood0b8f8612018-08-08 14:52:47 +0100353 @UnsupportedAppUsage
Robert Greenwaltd3401f92010-09-15 17:36:33 -0700354 public static final String INET_CONDITION_ACTION =
355 "android.net.conn.INET_CONDITION_ACTION";
356
Robert Greenwalt2034b912009-08-12 16:08:25 -0700357 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -0800358 * Broadcast Action: A tetherable connection has come or gone.
359 * Uses {@code ConnectivityManager.EXTRA_AVAILABLE_TETHER},
Erik Kline449ccfe2017-04-17 16:47:23 +0900360 * {@code ConnectivityManager.EXTRA_ACTIVE_LOCAL_ONLY},
361 * {@code ConnectivityManager.EXTRA_ACTIVE_TETHER}, and
Robert Greenwalt26744a52013-02-15 10:56:35 -0800362 * {@code ConnectivityManager.EXTRA_ERRORED_TETHER} to indicate
363 * the current state of tethering. Each include a list of
364 * interface names in that state (may be empty).
Robert Greenwalt0c4828c2010-01-26 11:40:34 -0800365 * @hide
366 */
Jeff Sharkey6932ff62013-02-20 18:21:19 -0800367 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Mathew Inwoodd078d3d2020-10-27 11:47:29 +0000368 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
Robert Greenwalt0c4828c2010-01-26 11:40:34 -0800369 public static final String ACTION_TETHER_STATE_CHANGED =
markchien1f523702019-12-25 19:40:32 +0800370 TetheringManager.ACTION_TETHER_STATE_CHANGED;
Robert Greenwalt0c4828c2010-01-26 11:40:34 -0800371
372 /**
373 * @hide
Robert Greenwalt26744a52013-02-15 10:56:35 -0800374 * gives a String[] listing all the interfaces configured for
375 * tethering and currently available for tethering.
Robert Greenwalt0c4828c2010-01-26 11:40:34 -0800376 */
Mathew Inwoodd078d3d2020-10-27 11:47:29 +0000377 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
markchien1f523702019-12-25 19:40:32 +0800378 public static final String EXTRA_AVAILABLE_TETHER = TetheringManager.EXTRA_AVAILABLE_TETHER;
Robert Greenwalt0c4828c2010-01-26 11:40:34 -0800379
380 /**
381 * @hide
Erik Kline449ccfe2017-04-17 16:47:23 +0900382 * gives a String[] listing all the interfaces currently in local-only
383 * mode (ie, has DHCPv4+IPv6-ULA support and no packet forwarding)
Robert Greenwalt0c4828c2010-01-26 11:40:34 -0800384 */
markchien1f523702019-12-25 19:40:32 +0800385 public static final String EXTRA_ACTIVE_LOCAL_ONLY = TetheringManager.EXTRA_ACTIVE_LOCAL_ONLY;
Erik Kline449ccfe2017-04-17 16:47:23 +0900386
387 /**
388 * @hide
389 * gives a String[] listing all the interfaces currently tethered
390 * (ie, has DHCPv4 support and packets potentially forwarded/NATed)
391 */
Mathew Inwoodd078d3d2020-10-27 11:47:29 +0000392 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
markchien1f523702019-12-25 19:40:32 +0800393 public static final String EXTRA_ACTIVE_TETHER = TetheringManager.EXTRA_ACTIVE_TETHER;
Robert Greenwalt8e87f122010-02-11 18:18:40 -0800394
395 /**
396 * @hide
Robert Greenwalt26744a52013-02-15 10:56:35 -0800397 * gives a String[] listing all the interfaces we tried to tether and
398 * failed. Use {@link #getLastTetherError} to find the error code
399 * for any interfaces listed here.
Robert Greenwalt8e87f122010-02-11 18:18:40 -0800400 */
Mathew Inwoodd078d3d2020-10-27 11:47:29 +0000401 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
markchien1f523702019-12-25 19:40:32 +0800402 public static final String EXTRA_ERRORED_TETHER = TetheringManager.EXTRA_ERRORED_TETHER;
Robert Greenwalt0c4828c2010-01-26 11:40:34 -0800403
404 /**
Russell Brenner4774b022013-02-12 10:03:14 -0800405 * Broadcast Action: The captive portal tracker has finished its test.
406 * Sent only while running Setup Wizard, in lieu of showing a user
407 * notification.
408 * @hide
409 */
Jeff Sharkey6932ff62013-02-20 18:21:19 -0800410 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Russell Brenner4774b022013-02-12 10:03:14 -0800411 public static final String ACTION_CAPTIVE_PORTAL_TEST_COMPLETED =
412 "android.net.conn.CAPTIVE_PORTAL_TEST_COMPLETED";
413 /**
414 * The lookup key for a boolean that indicates whether a captive portal was detected.
415 * Retrieve it with {@link android.content.Intent#getBooleanExtra(String,boolean)}.
416 * @hide
417 */
418 public static final String EXTRA_IS_CAPTIVE_PORTAL = "captivePortal";
419
420 /**
Lorenzo Colitti36fbebe2015-04-03 16:38:52 +0900421 * Action used to display a dialog that asks the user whether to connect to a network that is
422 * not validated. This intent is used to start the dialog in settings via startActivity.
423 *
424 * @hide
425 */
lucaslin1a0ca5f2021-03-04 17:09:51 +0800426 @SystemApi(client = MODULE_LIBRARIES)
427 public static final String ACTION_PROMPT_UNVALIDATED = "android.net.action.PROMPT_UNVALIDATED";
Lorenzo Colitti36fbebe2015-04-03 16:38:52 +0900428
429 /**
Lorenzo Colitti477bf5c2016-09-15 14:02:29 +0900430 * Action used to display a dialog that asks the user whether to avoid a network that is no
431 * longer validated. This intent is used to start the dialog in settings via startActivity.
432 *
433 * @hide
434 */
lucaslin1a0ca5f2021-03-04 17:09:51 +0800435 @SystemApi(client = MODULE_LIBRARIES)
Lorenzo Colitti477bf5c2016-09-15 14:02:29 +0900436 public static final String ACTION_PROMPT_LOST_VALIDATION =
lucaslin1a0ca5f2021-03-04 17:09:51 +0800437 "android.net.action.PROMPT_LOST_VALIDATION";
Lorenzo Colitti477bf5c2016-09-15 14:02:29 +0900438
439 /**
lucaslin25a50472019-03-12 13:08:03 +0800440 * Action used to display a dialog that asks the user whether to stay connected to a network
441 * that has not validated. This intent is used to start the dialog in settings via
442 * startActivity.
443 *
444 * @hide
445 */
lucaslin1a0ca5f2021-03-04 17:09:51 +0800446 @SystemApi(client = MODULE_LIBRARIES)
lucaslin25a50472019-03-12 13:08:03 +0800447 public static final String ACTION_PROMPT_PARTIAL_CONNECTIVITY =
lucaslin1a0ca5f2021-03-04 17:09:51 +0800448 "android.net.action.PROMPT_PARTIAL_CONNECTIVITY";
lucaslin25a50472019-03-12 13:08:03 +0800449
450 /**
Jeremy Klein9a36ec82016-01-22 14:11:45 -0800451 * Invalid tethering type.
Chalard Jean73d9db72018-06-04 16:52:49 +0900452 * @see #startTethering(int, boolean, OnStartTetheringCallback)
Jeremy Klein9a36ec82016-01-22 14:11:45 -0800453 * @hide
454 */
markchien1f523702019-12-25 19:40:32 +0800455 public static final int TETHERING_INVALID = TetheringManager.TETHERING_INVALID;
Jeremy Klein9a36ec82016-01-22 14:11:45 -0800456
457 /**
458 * Wifi tethering type.
Chalard Jean73d9db72018-06-04 16:52:49 +0900459 * @see #startTethering(int, boolean, OnStartTetheringCallback)
Jeremy Klein9a36ec82016-01-22 14:11:45 -0800460 * @hide
461 */
462 @SystemApi
Remi NGUYEN VAN23b853b2021-02-15 18:52:06 +0900463 public static final int TETHERING_WIFI = 0;
Jeremy Klein9a36ec82016-01-22 14:11:45 -0800464
465 /**
466 * USB tethering type.
Chalard Jean73d9db72018-06-04 16:52:49 +0900467 * @see #startTethering(int, boolean, OnStartTetheringCallback)
Jeremy Klein9a36ec82016-01-22 14:11:45 -0800468 * @hide
469 */
470 @SystemApi
Remi NGUYEN VAN23b853b2021-02-15 18:52:06 +0900471 public static final int TETHERING_USB = 1;
Jeremy Klein9a36ec82016-01-22 14:11:45 -0800472
473 /**
474 * Bluetooth tethering type.
Chalard Jean73d9db72018-06-04 16:52:49 +0900475 * @see #startTethering(int, boolean, OnStartTetheringCallback)
Jeremy Klein9a36ec82016-01-22 14:11:45 -0800476 * @hide
477 */
478 @SystemApi
Remi NGUYEN VAN23b853b2021-02-15 18:52:06 +0900479 public static final int TETHERING_BLUETOOTH = 2;
Jeremy Klein9a36ec82016-01-22 14:11:45 -0800480
481 /**
Jimmy Chen87db1542019-07-15 18:03:23 +0800482 * Wifi P2p tethering type.
483 * Wifi P2p tethering is set through events automatically, and don't
484 * need to start from #startTethering(int, boolean, OnStartTetheringCallback).
485 * @hide
486 */
markchien1f523702019-12-25 19:40:32 +0800487 public static final int TETHERING_WIFI_P2P = TetheringManager.TETHERING_WIFI_P2P;
Jimmy Chen87db1542019-07-15 18:03:23 +0800488
489 /**
Jeremy Klein9a36ec82016-01-22 14:11:45 -0800490 * Extra used for communicating with the TetherService. Includes the type of tethering to
491 * enable if any.
492 * @hide
493 */
markchien75721e42020-01-21 13:11:06 +0800494 public static final String EXTRA_ADD_TETHER_TYPE = TetheringConstants.EXTRA_ADD_TETHER_TYPE;
Jeremy Klein9a36ec82016-01-22 14:11:45 -0800495
496 /**
497 * Extra used for communicating with the TetherService. Includes the type of tethering for
498 * which to cancel provisioning.
499 * @hide
500 */
markchien75721e42020-01-21 13:11:06 +0800501 public static final String EXTRA_REM_TETHER_TYPE = TetheringConstants.EXTRA_REM_TETHER_TYPE;
Jeremy Klein9a36ec82016-01-22 14:11:45 -0800502
503 /**
504 * Extra used for communicating with the TetherService. True to schedule a recheck of tether
505 * provisioning.
506 * @hide
507 */
markchien75721e42020-01-21 13:11:06 +0800508 public static final String EXTRA_SET_ALARM = TetheringConstants.EXTRA_SET_ALARM;
Jeremy Klein9a36ec82016-01-22 14:11:45 -0800509
510 /**
511 * Tells the TetherService to run a provision check now.
512 * @hide
513 */
markchien75721e42020-01-21 13:11:06 +0800514 public static final String EXTRA_RUN_PROVISION = TetheringConstants.EXTRA_RUN_PROVISION;
Jeremy Klein9a36ec82016-01-22 14:11:45 -0800515
516 /**
517 * Extra used for communicating with the TetherService. Contains the {@link ResultReceiver}
518 * which will receive provisioning results. Can be left empty.
519 * @hide
520 */
markchien75721e42020-01-21 13:11:06 +0800521 public static final String EXTRA_PROVISION_CALLBACK =
522 TetheringConstants.EXTRA_PROVISION_CALLBACK;
Jeremy Klein9a36ec82016-01-22 14:11:45 -0800523
524 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -0800525 * The absence of a connection type.
Robert Greenwalt33cdcdf2011-06-02 17:30:47 -0700526 * @hide
527 */
paulhu62af6122020-01-13 16:46:45 +0800528 @SystemApi
Robert Greenwalt33cdcdf2011-06-02 17:30:47 -0700529 public static final int TYPE_NONE = -1;
530
531 /**
Chalard Jean5acb7b72018-03-08 13:54:53 +0900532 * A Mobile data connection. Devices may support more than one.
533 *
534 * @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or
535 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an
536 * appropriate network. {@see NetworkCapabilities} for supported transports.
Robert Greenwalt2034b912009-08-12 16:08:25 -0700537 */
Chalard Jean5acb7b72018-03-08 13:54:53 +0900538 @Deprecated
Robert Greenwalt2034b912009-08-12 16:08:25 -0700539 public static final int TYPE_MOBILE = 0;
Chalard Jean5acb7b72018-03-08 13:54:53 +0900540
Robert Greenwalt2034b912009-08-12 16:08:25 -0700541 /**
Chalard Jean5acb7b72018-03-08 13:54:53 +0900542 * A WIFI data connection. Devices may support more than one.
543 *
544 * @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or
545 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an
546 * appropriate network. {@see NetworkCapabilities} for supported transports.
Robert Greenwalt2034b912009-08-12 16:08:25 -0700547 */
Chalard Jean5acb7b72018-03-08 13:54:53 +0900548 @Deprecated
Robert Greenwalt2034b912009-08-12 16:08:25 -0700549 public static final int TYPE_WIFI = 1;
Chalard Jean5acb7b72018-03-08 13:54:53 +0900550
Robert Greenwalt2034b912009-08-12 16:08:25 -0700551 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -0800552 * An MMS-specific Mobile data connection. This network type may use the
553 * same network interface as {@link #TYPE_MOBILE} or it may use a different
554 * one. This is used by applications needing to talk to the carrier's
555 * Multimedia Messaging Service servers.
Lorenzo Colitti7cc32c52015-04-23 15:32:42 +0900556 *
Chalard Jean5acb7b72018-03-08 13:54:53 +0900557 * @deprecated Applications should instead use {@link NetworkCapabilities#hasCapability} or
Lorenzo Colittiefd396e2015-04-24 17:03:31 +0900558 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request a network that
Lorenzo Colitti7cc32c52015-04-23 15:32:42 +0900559 * provides the {@link NetworkCapabilities#NET_CAPABILITY_MMS} capability.
Robert Greenwalt2034b912009-08-12 16:08:25 -0700560 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -0700561 @Deprecated
Robert Greenwalt2034b912009-08-12 16:08:25 -0700562 public static final int TYPE_MOBILE_MMS = 2;
Chalard Jean5acb7b72018-03-08 13:54:53 +0900563
Robert Greenwalt2034b912009-08-12 16:08:25 -0700564 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -0800565 * A SUPL-specific Mobile data connection. This network type may use the
566 * same network interface as {@link #TYPE_MOBILE} or it may use a different
567 * one. This is used by applications needing to talk to the carrier's
568 * Secure User Plane Location servers for help locating the device.
Lorenzo Colitti7cc32c52015-04-23 15:32:42 +0900569 *
Chalard Jean5acb7b72018-03-08 13:54:53 +0900570 * @deprecated Applications should instead use {@link NetworkCapabilities#hasCapability} or
Lorenzo Colittiefd396e2015-04-24 17:03:31 +0900571 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request a network that
Lorenzo Colitti7cc32c52015-04-23 15:32:42 +0900572 * provides the {@link NetworkCapabilities#NET_CAPABILITY_SUPL} capability.
Robert Greenwalt2034b912009-08-12 16:08:25 -0700573 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -0700574 @Deprecated
Robert Greenwalt2034b912009-08-12 16:08:25 -0700575 public static final int TYPE_MOBILE_SUPL = 3;
Chalard Jean5acb7b72018-03-08 13:54:53 +0900576
Robert Greenwalt2034b912009-08-12 16:08:25 -0700577 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -0800578 * A DUN-specific Mobile data connection. This network type may use the
579 * same network interface as {@link #TYPE_MOBILE} or it may use a different
580 * one. This is sometimes by the system when setting up an upstream connection
581 * for tethering so that the carrier is aware of DUN traffic.
Chalard Jean5acb7b72018-03-08 13:54:53 +0900582 *
583 * @deprecated Applications should instead use {@link NetworkCapabilities#hasCapability} or
584 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request a network that
585 * provides the {@link NetworkCapabilities#NET_CAPABILITY_DUN} capability.
Robert Greenwalt2034b912009-08-12 16:08:25 -0700586 */
Chalard Jean5acb7b72018-03-08 13:54:53 +0900587 @Deprecated
Robert Greenwalt2034b912009-08-12 16:08:25 -0700588 public static final int TYPE_MOBILE_DUN = 4;
Chalard Jean5acb7b72018-03-08 13:54:53 +0900589
Robert Greenwalt2034b912009-08-12 16:08:25 -0700590 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -0800591 * A High Priority Mobile data connection. This network type uses the
592 * same network interface as {@link #TYPE_MOBILE} but the routing setup
Lorenzo Colitti7cc32c52015-04-23 15:32:42 +0900593 * is different.
594 *
Chalard Jean5acb7b72018-03-08 13:54:53 +0900595 * @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or
596 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an
597 * appropriate network. {@see NetworkCapabilities} for supported transports.
Robert Greenwalt2034b912009-08-12 16:08:25 -0700598 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -0700599 @Deprecated
Robert Greenwalt2034b912009-08-12 16:08:25 -0700600 public static final int TYPE_MOBILE_HIPRI = 5;
Chalard Jean5acb7b72018-03-08 13:54:53 +0900601
jshbfa81722010-03-11 15:04:43 -0800602 /**
Chalard Jean5acb7b72018-03-08 13:54:53 +0900603 * A WiMAX data connection.
604 *
605 * @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or
606 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an
607 * appropriate network. {@see NetworkCapabilities} for supported transports.
jshbfa81722010-03-11 15:04:43 -0800608 */
Chalard Jean5acb7b72018-03-08 13:54:53 +0900609 @Deprecated
jshbfa81722010-03-11 15:04:43 -0800610 public static final int TYPE_WIMAX = 6;
Robert Greenwalteb123ac2010-12-06 13:56:24 -0800611
Jaikumar Ganesh0db51a02010-12-21 22:31:44 -0800612 /**
Chalard Jean5acb7b72018-03-08 13:54:53 +0900613 * A Bluetooth data connection.
614 *
615 * @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or
616 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an
617 * appropriate network. {@see NetworkCapabilities} for supported transports.
Jaikumar Ganesh0db51a02010-12-21 22:31:44 -0800618 */
Chalard Jean5acb7b72018-03-08 13:54:53 +0900619 @Deprecated
Jaikumar Ganesh0db51a02010-12-21 22:31:44 -0800620 public static final int TYPE_BLUETOOTH = 7;
621
Robert Greenwaltf76c55d2011-04-22 15:28:18 -0700622 /**
Chiachang Wang7d5f3782020-07-28 13:53:09 +0800623 * Fake data connection. This should not be used on shipping devices.
Chalard Jean5acb7b72018-03-08 13:54:53 +0900624 * @deprecated This is not used any more.
Robert Greenwaltf76c55d2011-04-22 15:28:18 -0700625 */
Chalard Jean5acb7b72018-03-08 13:54:53 +0900626 @Deprecated
Jaikumar Ganesh0db51a02010-12-21 22:31:44 -0800627 public static final int TYPE_DUMMY = 8;
Wink Savilleb7c92c72011-03-12 14:52:01 -0800628
Robert Greenwaltf76c55d2011-04-22 15:28:18 -0700629 /**
Chalard Jean5acb7b72018-03-08 13:54:53 +0900630 * An Ethernet data connection.
631 *
632 * @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or
633 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an
634 * appropriate network. {@see NetworkCapabilities} for supported transports.
Robert Greenwaltf76c55d2011-04-22 15:28:18 -0700635 */
Chalard Jean5acb7b72018-03-08 13:54:53 +0900636 @Deprecated
Robert Greenwalt9d077812011-01-28 14:48:37 -0800637 public static final int TYPE_ETHERNET = 9;
Robert Greenwaltf76c55d2011-04-22 15:28:18 -0700638
Wink Savilleb7c92c72011-03-12 14:52:01 -0800639 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -0800640 * Over the air Administration.
Chalard Jean5acb7b72018-03-08 13:54:53 +0900641 * @deprecated Use {@link NetworkCapabilities} instead.
Wink Savilleb7c92c72011-03-12 14:52:01 -0800642 * {@hide}
643 */
Chalard Jean5acb7b72018-03-08 13:54:53 +0900644 @Deprecated
Chalard Jeanaa91c9d2019-04-09 15:46:21 +0900645 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 130143562)
Wink Savilleb7c92c72011-03-12 14:52:01 -0800646 public static final int TYPE_MOBILE_FOTA = 10;
647
648 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -0800649 * IP Multimedia Subsystem.
Chalard Jean5acb7b72018-03-08 13:54:53 +0900650 * @deprecated Use {@link NetworkCapabilities#NET_CAPABILITY_IMS} instead.
Wink Savilleb7c92c72011-03-12 14:52:01 -0800651 * {@hide}
652 */
Chalard Jean5acb7b72018-03-08 13:54:53 +0900653 @Deprecated
Mathew Inwood0b8f8612018-08-08 14:52:47 +0100654 @UnsupportedAppUsage
Wink Savilleb7c92c72011-03-12 14:52:01 -0800655 public static final int TYPE_MOBILE_IMS = 11;
656
657 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -0800658 * Carrier Branded Services.
Chalard Jean5acb7b72018-03-08 13:54:53 +0900659 * @deprecated Use {@link NetworkCapabilities#NET_CAPABILITY_CBS} instead.
Wink Savilleb7c92c72011-03-12 14:52:01 -0800660 * {@hide}
661 */
Chalard Jean5acb7b72018-03-08 13:54:53 +0900662 @Deprecated
Chalard Jeanaa91c9d2019-04-09 15:46:21 +0900663 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 130143562)
Wink Savilleb7c92c72011-03-12 14:52:01 -0800664 public static final int TYPE_MOBILE_CBS = 12;
665
repo syncf5de5572011-07-29 23:55:49 -0700666 /**
667 * A Wi-Fi p2p connection. Only requesting processes will have access to
668 * the peers connected.
Chalard Jean5acb7b72018-03-08 13:54:53 +0900669 * @deprecated Use {@link NetworkCapabilities#NET_CAPABILITY_WIFI_P2P} instead.
repo syncf5de5572011-07-29 23:55:49 -0700670 * {@hide}
671 */
Chalard Jean5acb7b72018-03-08 13:54:53 +0900672 @Deprecated
paulhu028732e2020-01-15 15:38:23 +0800673 @SystemApi
repo syncf5de5572011-07-29 23:55:49 -0700674 public static final int TYPE_WIFI_P2P = 13;
Wink Savilleb7c92c72011-03-12 14:52:01 -0800675
Wink Saville70dbdcc2013-07-29 15:00:57 -0700676 /**
677 * The network to use for initially attaching to the network
Chalard Jean5acb7b72018-03-08 13:54:53 +0900678 * @deprecated Use {@link NetworkCapabilities#NET_CAPABILITY_IA} instead.
Wink Saville70dbdcc2013-07-29 15:00:57 -0700679 * {@hide}
680 */
Chalard Jean5acb7b72018-03-08 13:54:53 +0900681 @Deprecated
Mathew Inwood0b8f8612018-08-08 14:52:47 +0100682 @UnsupportedAppUsage
Wink Saville70dbdcc2013-07-29 15:00:57 -0700683 public static final int TYPE_MOBILE_IA = 14;
repo syncf5de5572011-07-29 23:55:49 -0700684
Lorenzo Colitti7cc32c52015-04-23 15:32:42 +0900685 /**
Robert Greenwalt9db5f3c2015-07-09 14:49:35 -0700686 * Emergency PDN connection for emergency services. This
687 * may include IMS and MMS in emergency situations.
Chalard Jean5acb7b72018-03-08 13:54:53 +0900688 * @deprecated Use {@link NetworkCapabilities#NET_CAPABILITY_EIMS} instead.
Ram201d45f2014-06-26 11:03:44 -0700689 * {@hide}
690 */
Chalard Jean5acb7b72018-03-08 13:54:53 +0900691 @Deprecated
Chalard Jeanaa91c9d2019-04-09 15:46:21 +0900692 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 130143562)
Ram201d45f2014-06-26 11:03:44 -0700693 public static final int TYPE_MOBILE_EMERGENCY = 15;
694
Hui Lu07f29332014-01-15 11:05:36 -0500695 /**
696 * The network that uses proxy to achieve connectivity.
Chalard Jean5acb7b72018-03-08 13:54:53 +0900697 * @deprecated Use {@link NetworkCapabilities} instead.
Hui Lu07f29332014-01-15 11:05:36 -0500698 * {@hide}
699 */
Chalard Jean5acb7b72018-03-08 13:54:53 +0900700 @Deprecated
Remi NGUYEN VANdaeafee2020-11-30 19:23:45 +0900701 @SystemApi
Hui Lu07f29332014-01-15 11:05:36 -0500702 public static final int TYPE_PROXY = 16;
Wink Saville70dbdcc2013-07-29 15:00:57 -0700703
Robert Greenwaltb2a03d12014-07-07 17:09:01 -0700704 /**
705 * A virtual network using one or more native bearers.
706 * It may or may not be providing security services.
Chalard Jean5acb7b72018-03-08 13:54:53 +0900707 * @deprecated Applications should use {@link NetworkCapabilities#TRANSPORT_VPN} instead.
Robert Greenwaltb2a03d12014-07-07 17:09:01 -0700708 */
Chalard Jean5acb7b72018-03-08 13:54:53 +0900709 @Deprecated
Robert Greenwaltb2a03d12014-07-07 17:09:01 -0700710 public static final int TYPE_VPN = 17;
Hui Lu07f29332014-01-15 11:05:36 -0500711
Benedict Wong80156022018-11-14 17:40:55 -0800712 /**
713 * A network that is exclusively meant to be used for testing
714 *
715 * @deprecated Use {@link NetworkCapabilities} instead.
716 * @hide
717 */
718 @Deprecated
719 public static final int TYPE_TEST = 18; // TODO: Remove this once NetworkTypes are unused.
Robert Greenwaltb2a03d12014-07-07 17:09:01 -0700720
Chalard Jean74fe1c72020-03-25 01:24:04 +0900721 /**
722 * @deprecated Use {@link NetworkCapabilities} instead.
723 * @hide
724 */
725 @Deprecated
726 @Retention(RetentionPolicy.SOURCE)
727 @IntDef(prefix = { "TYPE_" }, value = {
728 TYPE_NONE,
729 TYPE_MOBILE,
730 TYPE_WIFI,
731 TYPE_MOBILE_MMS,
732 TYPE_MOBILE_SUPL,
733 TYPE_MOBILE_DUN,
734 TYPE_MOBILE_HIPRI,
735 TYPE_WIMAX,
736 TYPE_BLUETOOTH,
737 TYPE_DUMMY,
738 TYPE_ETHERNET,
739 TYPE_MOBILE_FOTA,
740 TYPE_MOBILE_IMS,
741 TYPE_MOBILE_CBS,
742 TYPE_WIFI_P2P,
743 TYPE_MOBILE_IA,
744 TYPE_MOBILE_EMERGENCY,
745 TYPE_PROXY,
746 TYPE_VPN,
747 TYPE_TEST
748 })
749 public @interface LegacyNetworkType {}
750
Chalard Jean1f42df12019-11-21 14:48:00 +0900751 // Deprecated constants for return values of startUsingNetworkFeature. They used to live
752 // in com.android.internal.telephony.PhoneConstants until they were made inaccessible.
753 private static final int DEPRECATED_PHONE_CONSTANT_APN_ALREADY_ACTIVE = 0;
754 private static final int DEPRECATED_PHONE_CONSTANT_APN_REQUEST_STARTED = 1;
755 private static final int DEPRECATED_PHONE_CONSTANT_APN_REQUEST_FAILED = 3;
756
Robert Greenwaltb2a03d12014-07-07 17:09:01 -0700757 /** {@hide} */
Benedict Wong80156022018-11-14 17:40:55 -0800758 public static final int MAX_RADIO_TYPE = TYPE_TEST;
759
760 /** {@hide} */
761 public static final int MAX_NETWORK_TYPE = TYPE_TEST;
The Android Open Source Project28527d22009-03-03 19:31:44 -0800762
Hugo Benichi37d5c3c2017-06-20 14:07:59 +0900763 private static final int MIN_NETWORK_TYPE = TYPE_MOBILE;
764
Jianzheng Zhoua8aa1602012-11-16 13:45:20 +0800765 /**
766 * If you want to set the default network preference,you can directly
767 * change the networkAttributes array in framework's config.xml.
768 *
769 * @deprecated Since we support so many more networks now, the single
770 * network default network preference can't really express
Robert Greenwalt26744a52013-02-15 10:56:35 -0800771 * the hierarchy. Instead, the default is defined by the
Jianzheng Zhoua8aa1602012-11-16 13:45:20 +0800772 * networkAttributes in config.xml. You can determine
Robert Greenwalt1ee3d2c2012-12-07 09:56:50 -0800773 * the current value by calling {@link #getNetworkPreference()}
Jianzheng Zhoua8aa1602012-11-16 13:45:20 +0800774 * from an App.
775 */
776 @Deprecated
The Android Open Source Project28527d22009-03-03 19:31:44 -0800777 public static final int DEFAULT_NETWORK_PREFERENCE = TYPE_WIFI;
778
Jeff Sharkey5eccd9c2012-09-26 22:03:49 -0700779 /**
Robert Greenwalta1402df2014-03-19 17:56:12 -0700780 * @hide
781 */
Hugo Benichibcc81df2017-06-20 14:10:14 +0900782 public static final int REQUEST_ID_UNSET = 0;
Robert Greenwaltc34f83b2014-06-08 16:42:59 -0700783
Paul Jensen0478ace2014-07-11 12:28:19 -0400784 /**
Hugo Benichi1c027fe2017-06-17 13:14:12 +0900785 * Static unique request used as a tombstone for NetworkCallbacks that have been unregistered.
786 * This allows to distinguish when unregistering NetworkCallbacks those that were never
Chalard Jean73d9db72018-06-04 16:52:49 +0900787 * registered from those that were already unregistered.
Hugo Benichi1c027fe2017-06-17 13:14:12 +0900788 * @hide
789 */
Hugo Benichibcc81df2017-06-20 14:10:14 +0900790 private static final NetworkRequest ALREADY_UNREGISTERED =
Hugo Benichi1c027fe2017-06-17 13:14:12 +0900791 new NetworkRequest.Builder().clearCapabilities().build();
792
793 /**
Paul Jensen0478ace2014-07-11 12:28:19 -0400794 * A NetID indicating no Network is selected.
795 * Keep in sync with bionic/libc/dns/include/resolv_netid.h
796 * @hide
797 */
798 public static final int NETID_UNSET = 0;
799
Erik Kline1ecdd962017-10-30 15:29:44 +0900800 /**
801 * Private DNS Mode values.
802 *
803 * The "private_dns_mode" global setting stores a String value which is
804 * expected to be one of the following.
805 */
806
807 /**
808 * @hide
809 */
lucaslin50205af2021-03-12 16:11:27 +0800810 @SystemApi(client = MODULE_LIBRARIES)
Erik Kline1ecdd962017-10-30 15:29:44 +0900811 public static final String PRIVATE_DNS_MODE_OFF = "off";
812 /**
813 * @hide
814 */
lucaslin50205af2021-03-12 16:11:27 +0800815 @SystemApi(client = MODULE_LIBRARIES)
Erik Kline1ecdd962017-10-30 15:29:44 +0900816 public static final String PRIVATE_DNS_MODE_OPPORTUNISTIC = "opportunistic";
817 /**
818 * @hide
819 */
lucaslin50205af2021-03-12 16:11:27 +0800820 @SystemApi(client = MODULE_LIBRARIES)
Erik Kline1ecdd962017-10-30 15:29:44 +0900821 public static final String PRIVATE_DNS_MODE_PROVIDER_HOSTNAME = "hostname";
lucaslin50205af2021-03-12 16:11:27 +0800822
823 /** @hide */
824 @Retention(RetentionPolicy.SOURCE)
825 @StringDef(value = {
826 PRIVATE_DNS_MODE_OFF,
827 PRIVATE_DNS_MODE_OPPORTUNISTIC,
828 PRIVATE_DNS_MODE_PROVIDER_HOSTNAME,
829 })
830 public @interface PrivateDnsMode {}
Erik Kline1ecdd962017-10-30 15:29:44 +0900831
Chalard Jeanaa91c9d2019-04-09 15:46:21 +0900832 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 130143562)
Jeff Sharkey921ebf22011-05-19 17:12:49 -0700833 private final IConnectivityManager mService;
Lorenzo Colitti0dd4b6f2021-02-04 17:32:07 +0900834
Paul Jensen12131352014-12-10 15:12:18 -0500835 /**
836 * A kludge to facilitate static access where a Context pointer isn't available, like in the
837 * case of the static set/getProcessDefaultNetwork methods and from the Network class.
838 * TODO: Remove this after deprecating the static methods in favor of non-static methods or
839 * methods that take a Context argument.
840 */
841 private static ConnectivityManager sInstance;
The Android Open Source Project28527d22009-03-03 19:31:44 -0800842
Lorenzo Colitti9b026fa2015-07-29 11:41:21 +0900843 private final Context mContext;
844
Automerger Merge Worker9b0c0c62020-03-06 00:38:43 +0000845 private final TetheringManager mTetheringManager;
Dianne Hackbornb4b09e82014-02-26 16:20:52 -0800846
Robert Greenwalt26744a52013-02-15 10:56:35 -0800847 /**
848 * Tests if a given integer represents a valid network type.
849 * @param networkType the type to be tested
850 * @return a boolean. {@code true} if the type is valid, else {@code false}
Paul Jensen1c9f2e42015-05-06 10:42:25 -0400851 * @deprecated All APIs accepting a network type are deprecated. There should be no need to
852 * validate a network type.
Robert Greenwalt26744a52013-02-15 10:56:35 -0800853 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -0700854 @Deprecated
Jeff Sharkey21062e72011-05-28 20:56:34 -0700855 public static boolean isNetworkTypeValid(int networkType) {
Hugo Benichi37d5c3c2017-06-20 14:07:59 +0900856 return MIN_NETWORK_TYPE <= networkType && networkType <= MAX_NETWORK_TYPE;
The Android Open Source Project28527d22009-03-03 19:31:44 -0800857 }
858
Robert Greenwalt26744a52013-02-15 10:56:35 -0800859 /**
860 * Returns a non-localized string representing a given network type.
861 * ONLY used for debugging output.
862 * @param type the type needing naming
863 * @return a String for the given type, or a string version of the type ("87")
864 * if no name is known.
Chalard Jean5acb7b72018-03-08 13:54:53 +0900865 * @deprecated Types are deprecated. Use {@link NetworkCapabilities} instead.
Robert Greenwalt26744a52013-02-15 10:56:35 -0800866 * {@hide}
867 */
Chalard Jean5acb7b72018-03-08 13:54:53 +0900868 @Deprecated
Mathew Inwoodd078d3d2020-10-27 11:47:29 +0000869 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
Jeff Sharkey21062e72011-05-28 20:56:34 -0700870 public static String getNetworkTypeName(int type) {
871 switch (type) {
Hugo Benichi37d5c3c2017-06-20 14:07:59 +0900872 case TYPE_NONE:
873 return "NONE";
Jeff Sharkey21062e72011-05-28 20:56:34 -0700874 case TYPE_MOBILE:
875 return "MOBILE";
876 case TYPE_WIFI:
877 return "WIFI";
878 case TYPE_MOBILE_MMS:
879 return "MOBILE_MMS";
880 case TYPE_MOBILE_SUPL:
881 return "MOBILE_SUPL";
882 case TYPE_MOBILE_DUN:
883 return "MOBILE_DUN";
884 case TYPE_MOBILE_HIPRI:
885 return "MOBILE_HIPRI";
886 case TYPE_WIMAX:
887 return "WIMAX";
888 case TYPE_BLUETOOTH:
889 return "BLUETOOTH";
890 case TYPE_DUMMY:
891 return "DUMMY";
892 case TYPE_ETHERNET:
893 return "ETHERNET";
894 case TYPE_MOBILE_FOTA:
895 return "MOBILE_FOTA";
896 case TYPE_MOBILE_IMS:
897 return "MOBILE_IMS";
898 case TYPE_MOBILE_CBS:
899 return "MOBILE_CBS";
repo syncf5de5572011-07-29 23:55:49 -0700900 case TYPE_WIFI_P2P:
901 return "WIFI_P2P";
Wink Saville70dbdcc2013-07-29 15:00:57 -0700902 case TYPE_MOBILE_IA:
903 return "MOBILE_IA";
Ram201d45f2014-06-26 11:03:44 -0700904 case TYPE_MOBILE_EMERGENCY:
905 return "MOBILE_EMERGENCY";
Hui Lu07f29332014-01-15 11:05:36 -0500906 case TYPE_PROXY:
907 return "PROXY";
Erik Klineb1ff7002014-11-19 17:23:41 +0900908 case TYPE_VPN:
909 return "VPN";
Jeff Sharkey21062e72011-05-28 20:56:34 -0700910 default:
911 return Integer.toString(type);
912 }
913 }
914
Robert Greenwalt26744a52013-02-15 10:56:35 -0800915 /**
Aaron Huangdfba5d12020-06-27 07:18:23 +0800916 * @hide
Aaron Huangdfba5d12020-06-27 07:18:23 +0800917 */
lucaslin8c121bf2021-03-17 14:16:01 +0800918 @SystemApi(client = MODULE_LIBRARIES)
Aaron Huangdfba5d12020-06-27 07:18:23 +0800919 public void systemReady() {
920 try {
921 mService.systemReady();
922 } catch (RemoteException e) {
923 throw e.rethrowFromSystemServer();
924 }
925 }
926
927 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -0800928 * Checks if a given type uses the cellular data connection.
929 * This should be replaced in the future by a network property.
930 * @param networkType the type to check
931 * @return a boolean - {@code true} if uses cellular network, else {@code false}
Chalard Jean5acb7b72018-03-08 13:54:53 +0900932 * @deprecated Types are deprecated. Use {@link NetworkCapabilities} instead.
Robert Greenwalt26744a52013-02-15 10:56:35 -0800933 * {@hide}
934 */
Chalard Jean5acb7b72018-03-08 13:54:53 +0900935 @Deprecated
Chalard Jeanaa91c9d2019-04-09 15:46:21 +0900936 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 130143562)
Jeff Sharkey21062e72011-05-28 20:56:34 -0700937 public static boolean isNetworkTypeMobile(int networkType) {
938 switch (networkType) {
939 case TYPE_MOBILE:
940 case TYPE_MOBILE_MMS:
941 case TYPE_MOBILE_SUPL:
942 case TYPE_MOBILE_DUN:
943 case TYPE_MOBILE_HIPRI:
944 case TYPE_MOBILE_FOTA:
945 case TYPE_MOBILE_IMS:
946 case TYPE_MOBILE_CBS:
Wink Saville70dbdcc2013-07-29 15:00:57 -0700947 case TYPE_MOBILE_IA:
Ram201d45f2014-06-26 11:03:44 -0700948 case TYPE_MOBILE_EMERGENCY:
Jeff Sharkey21062e72011-05-28 20:56:34 -0700949 return true;
950 default:
951 return false;
952 }
953 }
954
Robert Greenwalt26744a52013-02-15 10:56:35 -0800955 /**
Jeff Sharkeye9bda1d2013-06-04 12:29:00 -0700956 * Checks if the given network type is backed by a Wi-Fi radio.
957 *
Chalard Jean5acb7b72018-03-08 13:54:53 +0900958 * @deprecated Types are deprecated. Use {@link NetworkCapabilities} instead.
Jeff Sharkeye9bda1d2013-06-04 12:29:00 -0700959 * @hide
960 */
Chalard Jean5acb7b72018-03-08 13:54:53 +0900961 @Deprecated
Jeff Sharkeye9bda1d2013-06-04 12:29:00 -0700962 public static boolean isNetworkTypeWifi(int networkType) {
963 switch (networkType) {
964 case TYPE_WIFI:
965 case TYPE_WIFI_P2P:
966 return true;
967 default:
968 return false;
969 }
970 }
971
972 /**
Chalard Jean03433052021-02-25 17:23:40 +0900973 * Preference for {@link #setNetworkPreferenceForUser(UserHandle, int, Executor, Runnable)}.
974 * Specify that the traffic for this user should by follow the default rules.
975 * @hide
976 */
Chalard Jean560d4032021-03-17 14:33:24 +0900977 @SystemApi(client = MODULE_LIBRARIES)
Chalard Jean03433052021-02-25 17:23:40 +0900978 public static final int PROFILE_NETWORK_PREFERENCE_DEFAULT = 0;
979
980 /**
981 * Preference for {@link #setNetworkPreferenceForUser(UserHandle, int, Executor, Runnable)}.
982 * Specify that the traffic for this user should by default go on a network with
983 * {@link NetworkCapabilities#NET_CAPABILITY_ENTERPRISE}, and on the system default network
984 * if no such network is available.
985 * @hide
986 */
Chalard Jean560d4032021-03-17 14:33:24 +0900987 @SystemApi(client = MODULE_LIBRARIES)
Chalard Jean03433052021-02-25 17:23:40 +0900988 public static final int PROFILE_NETWORK_PREFERENCE_ENTERPRISE = 1;
989
990 /** @hide */
991 @Retention(RetentionPolicy.SOURCE)
992 @IntDef(value = {
993 PROFILE_NETWORK_PREFERENCE_DEFAULT,
994 PROFILE_NETWORK_PREFERENCE_ENTERPRISE
995 })
996 public @interface ProfileNetworkPreference {
997 }
998
999 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -08001000 * Specifies the preferred network type. When the device has more
1001 * than one type available the preferred network type will be used.
Robert Greenwalt26744a52013-02-15 10:56:35 -08001002 *
1003 * @param preference the network type to prefer over all others. It is
1004 * unspecified what happens to the old preferred network in the
1005 * overall ordering.
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07001006 * @deprecated Functionality has been removed as it no longer makes sense,
1007 * with many more than two networks - we'd need an array to express
1008 * preference. Instead we use dynamic network properties of
1009 * the networks to describe their precedence.
Robert Greenwalt26744a52013-02-15 10:56:35 -08001010 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -07001011 @Deprecated
The Android Open Source Project28527d22009-03-03 19:31:44 -08001012 public void setNetworkPreference(int preference) {
The Android Open Source Project28527d22009-03-03 19:31:44 -08001013 }
1014
Robert Greenwalt26744a52013-02-15 10:56:35 -08001015 /**
1016 * Retrieves the current preferred network type.
Robert Greenwalt26744a52013-02-15 10:56:35 -08001017 *
1018 * @return an integer representing the preferred network type
1019 *
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07001020 * @deprecated Functionality has been removed as it no longer makes sense,
1021 * with many more than two networks - we'd need an array to express
1022 * preference. Instead we use dynamic network properties of
1023 * the networks to describe their precedence.
Robert Greenwalt26744a52013-02-15 10:56:35 -08001024 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -07001025 @Deprecated
Jeff Sharkey2ac62992017-04-24 11:18:03 -06001026 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
The Android Open Source Project28527d22009-03-03 19:31:44 -08001027 public int getNetworkPreference() {
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07001028 return TYPE_NONE;
The Android Open Source Project28527d22009-03-03 19:31:44 -08001029 }
1030
Scott Mainf58b7d82011-10-06 19:02:28 -07001031 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -08001032 * Returns details about the currently active default data network. When
1033 * connected, this network is the default route for outgoing connections.
1034 * You should always check {@link NetworkInfo#isConnected()} before initiating
1035 * network traffic. This may return {@code null} when there is no default
1036 * network.
Chalard Jean7c85ba42018-03-29 17:45:24 +09001037 * Note that if the default network is a VPN, this method will return the
1038 * NetworkInfo for one of its underlying networks instead, or null if the
1039 * VPN agent did not specify any. Apps interested in learning about VPNs
1040 * should use {@link #getNetworkInfo(android.net.Network)} instead.
Robert Greenwalt26744a52013-02-15 10:56:35 -08001041 *
1042 * @return a {@link NetworkInfo} object for the current default network
Paul Jensena9208b92015-02-13 14:18:39 -05001043 * or {@code null} if no default network is currently active
junyulai5c2f6262018-12-13 12:47:51 +08001044 * @deprecated See {@link NetworkInfo}.
Jeff Sharkeyd00b1302012-04-12 18:34:54 -07001045 */
junyulai5c2f6262018-12-13 12:47:51 +08001046 @Deprecated
Jeff Sharkey2ac62992017-04-24 11:18:03 -06001047 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean42a9c292019-01-07 19:26:34 +09001048 @Nullable
The Android Open Source Project28527d22009-03-03 19:31:44 -08001049 public NetworkInfo getActiveNetworkInfo() {
1050 try {
1051 return mService.getActiveNetworkInfo();
1052 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07001053 throw e.rethrowFromSystemServer();
The Android Open Source Project28527d22009-03-03 19:31:44 -08001054 }
1055 }
1056
Robert Greenwalt26744a52013-02-15 10:56:35 -08001057 /**
Paul Jensenc2569432015-02-13 14:18:39 -05001058 * Returns a {@link Network} object corresponding to the currently active
1059 * default data network. In the event that the current active default data
1060 * network disconnects, the returned {@code Network} object will no longer
1061 * be usable. This will return {@code null} when there is no default
1062 * network.
1063 *
1064 * @return a {@link Network} object for the current default network or
1065 * {@code null} if no default network is currently active
Paul Jensenc2569432015-02-13 14:18:39 -05001066 */
Jeff Sharkey2ac62992017-04-24 11:18:03 -06001067 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean42a9c292019-01-07 19:26:34 +09001068 @Nullable
Paul Jensenc2569432015-02-13 14:18:39 -05001069 public Network getActiveNetwork() {
1070 try {
1071 return mService.getActiveNetwork();
1072 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07001073 throw e.rethrowFromSystemServer();
Paul Jensenc2569432015-02-13 14:18:39 -05001074 }
1075 }
1076
1077 /**
Robin Leeda4d2e22016-03-24 12:07:00 +00001078 * Returns a {@link Network} object corresponding to the currently active
1079 * default data network for a specific UID. In the event that the default data
1080 * network disconnects, the returned {@code Network} object will no longer
1081 * be usable. This will return {@code null} when there is no default
1082 * network for the UID.
Robin Leeda4d2e22016-03-24 12:07:00 +00001083 *
1084 * @return a {@link Network} object for the current default network for the
1085 * given UID or {@code null} if no default network is currently active
lifrb22da4e2021-03-11 20:11:09 +08001086 * TODO: b/183465229 Cleanup getActiveNetworkForUid once b/165835257 is fixed
Robin Leeda4d2e22016-03-24 12:07:00 +00001087 */
paulhuec0a9632019-08-12 16:25:11 +08001088 @RequiresPermission(android.Manifest.permission.NETWORK_STACK)
Chalard Jean42a9c292019-01-07 19:26:34 +09001089 @Nullable
Robin Leeda4d2e22016-03-24 12:07:00 +00001090 public Network getActiveNetworkForUid(int uid) {
Jeff Sharkey833c35b2016-04-28 15:33:18 -06001091 return getActiveNetworkForUid(uid, false);
1092 }
1093
1094 /** {@hide} */
1095 public Network getActiveNetworkForUid(int uid, boolean ignoreBlocked) {
Robin Leeda4d2e22016-03-24 12:07:00 +00001096 try {
Jeff Sharkey833c35b2016-04-28 15:33:18 -06001097 return mService.getActiveNetworkForUid(uid, ignoreBlocked);
Robin Leeda4d2e22016-03-24 12:07:00 +00001098 } catch (RemoteException e) {
1099 throw e.rethrowFromSystemServer();
1100 }
1101 }
1102
1103 /**
Lorenzo Colittie8ce2052020-12-12 00:51:11 +09001104 * Adds or removes a requirement for given UID ranges to use the VPN.
1105 *
1106 * If set to {@code true}, informs the system that the UIDs in the specified ranges must not
1107 * have any connectivity except if a VPN is connected and applies to the UIDs, or if the UIDs
1108 * otherwise have permission to bypass the VPN (e.g., because they have the
1109 * {@link android.Manifest.permission.CONNECTIVITY_USE_RESTRICTED_NETWORKS} permission, or when
1110 * using a socket protected by a method such as {@link VpnService#protect(DatagramSocket)}. If
1111 * set to {@code false}, a previously-added restriction is removed.
1112 * <p>
1113 * Each of the UID ranges specified by this method is added and removed as is, and no processing
1114 * is performed on the ranges to de-duplicate, merge, split, or intersect them. In order to
1115 * remove a previously-added range, the exact range must be removed as is.
1116 * <p>
1117 * The changes are applied asynchronously and may not have been applied by the time the method
1118 * returns. Apps will be notified about any changes that apply to them via
1119 * {@link NetworkCallback#onBlockedStatusChanged} callbacks called after the changes take
1120 * effect.
1121 * <p>
1122 * This method should be called only by the VPN code.
1123 *
1124 * @param ranges the UID ranges to restrict
1125 * @param requireVpn whether the specified UID ranges must use a VPN
1126 *
Lorenzo Colittie8ce2052020-12-12 00:51:11 +09001127 * @hide
1128 */
1129 @RequiresPermission(anyOf = {
1130 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
lucaslin5140e482021-03-22 11:51:27 +08001131 android.Manifest.permission.NETWORK_STACK,
1132 android.Manifest.permission.NETWORK_SETTINGS})
1133 @SystemApi(client = MODULE_LIBRARIES)
Lorenzo Colittie8ce2052020-12-12 00:51:11 +09001134 public void setRequireVpnForUids(boolean requireVpn,
1135 @NonNull Collection<Range<Integer>> ranges) {
1136 Objects.requireNonNull(ranges);
1137 // The Range class is not parcelable. Convert to UidRange, which is what is used internally.
1138 // This method is not necessarily expected to be used outside the system server, so
1139 // parceling may not be necessary, but it could be used out-of-process, e.g., by the network
1140 // stack process, or by tests.
1141 UidRange[] rangesArray = new UidRange[ranges.size()];
1142 int index = 0;
1143 for (Range<Integer> range : ranges) {
1144 rangesArray[index++] = new UidRange(range.getLower(), range.getUpper());
1145 }
1146 try {
1147 mService.setRequireVpnForUids(requireVpn, rangesArray);
1148 } catch (RemoteException e) {
1149 throw e.rethrowFromSystemServer();
1150 }
1151 }
1152
1153 /**
Lorenzo Colitti549e9ac2021-01-15 01:29:01 +09001154 * Informs ConnectivityService of whether the legacy lockdown VPN, as implemented by
1155 * LockdownVpnTracker, is in use. This is deprecated for new devices starting from Android 12
1156 * but is still supported for backwards compatibility.
1157 * <p>
1158 * This type of VPN is assumed always to use the system default network, and must always declare
1159 * exactly one underlying network, which is the network that was the default when the VPN
1160 * connected.
1161 * <p>
1162 * Calling this method with {@code true} enables legacy behaviour, specifically:
1163 * <ul>
1164 * <li>Any VPN that applies to userId 0 behaves specially with respect to deprecated
1165 * {@link #CONNECTIVITY_ACTION} broadcasts. Any such broadcasts will have the state in the
1166 * {@link #EXTRA_NETWORK_INFO} replaced by state of the VPN network. Also, any time the VPN
1167 * connects, a {@link #CONNECTIVITY_ACTION} broadcast will be sent for the network
1168 * underlying the VPN.</li>
1169 * <li>Deprecated APIs that return {@link NetworkInfo} objects will have their state
1170 * similarly replaced by the VPN network state.</li>
1171 * <li>Information on current network interfaces passed to NetworkStatsService will not
1172 * include any VPN interfaces.</li>
1173 * </ul>
1174 *
1175 * @param enabled whether legacy lockdown VPN is enabled or disabled
1176 *
Lorenzo Colitti549e9ac2021-01-15 01:29:01 +09001177 * @hide
1178 */
1179 @RequiresPermission(anyOf = {
1180 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
lucaslin5140e482021-03-22 11:51:27 +08001181 android.Manifest.permission.NETWORK_STACK,
Lorenzo Colitti549e9ac2021-01-15 01:29:01 +09001182 android.Manifest.permission.NETWORK_SETTINGS})
lucaslin5140e482021-03-22 11:51:27 +08001183 @SystemApi(client = MODULE_LIBRARIES)
Lorenzo Colitti549e9ac2021-01-15 01:29:01 +09001184 public void setLegacyLockdownVpnEnabled(boolean enabled) {
1185 try {
1186 mService.setLegacyLockdownVpnEnabled(enabled);
1187 } catch (RemoteException e) {
1188 throw e.rethrowFromSystemServer();
1189 }
1190 }
1191
1192 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -08001193 * Returns details about the currently active default data network
1194 * for a given uid. This is for internal use only to avoid spying
1195 * other apps.
1196 *
1197 * @return a {@link NetworkInfo} object for the current default network
1198 * for the given uid or {@code null} if no default network is
1199 * available for the specified uid.
1200 *
Robert Greenwalt26744a52013-02-15 10:56:35 -08001201 * {@hide}
1202 */
paulhuec0a9632019-08-12 16:25:11 +08001203 @RequiresPermission(android.Manifest.permission.NETWORK_STACK)
Mathew Inwoodd078d3d2020-10-27 11:47:29 +00001204 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
Jeff Sharkey921ebf22011-05-19 17:12:49 -07001205 public NetworkInfo getActiveNetworkInfoForUid(int uid) {
Jeff Sharkey833c35b2016-04-28 15:33:18 -06001206 return getActiveNetworkInfoForUid(uid, false);
1207 }
1208
1209 /** {@hide} */
1210 public NetworkInfo getActiveNetworkInfoForUid(int uid, boolean ignoreBlocked) {
Jeff Sharkey921ebf22011-05-19 17:12:49 -07001211 try {
Jeff Sharkey833c35b2016-04-28 15:33:18 -06001212 return mService.getActiveNetworkInfoForUid(uid, ignoreBlocked);
Jeff Sharkey921ebf22011-05-19 17:12:49 -07001213 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07001214 throw e.rethrowFromSystemServer();
Jeff Sharkey921ebf22011-05-19 17:12:49 -07001215 }
1216 }
1217
Robert Greenwalt26744a52013-02-15 10:56:35 -08001218 /**
1219 * Returns connection status information about a particular
1220 * network type.
1221 *
1222 * @param networkType integer specifying which networkType in
1223 * which you're interested.
1224 * @return a {@link NetworkInfo} object for the requested
1225 * network type or {@code null} if the type is not
Chalard Jean7c85ba42018-03-29 17:45:24 +09001226 * supported by the device. If {@code networkType} is
1227 * TYPE_VPN and a VPN is active for the calling app,
1228 * then this method will try to return one of the
1229 * underlying networks for the VPN or null if the
1230 * VPN agent didn't specify any.
Robert Greenwalt26744a52013-02-15 10:56:35 -08001231 *
Paul Jensena8e6dc62015-03-18 12:23:02 -04001232 * @deprecated This method does not support multiple connected networks
1233 * of the same type. Use {@link #getAllNetworks} and
1234 * {@link #getNetworkInfo(android.net.Network)} instead.
Robert Greenwalt26744a52013-02-15 10:56:35 -08001235 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -07001236 @Deprecated
Jeff Sharkey2ac62992017-04-24 11:18:03 -06001237 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean42a9c292019-01-07 19:26:34 +09001238 @Nullable
The Android Open Source Project28527d22009-03-03 19:31:44 -08001239 public NetworkInfo getNetworkInfo(int networkType) {
1240 try {
1241 return mService.getNetworkInfo(networkType);
1242 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07001243 throw e.rethrowFromSystemServer();
The Android Open Source Project28527d22009-03-03 19:31:44 -08001244 }
1245 }
1246
Robert Greenwalt26744a52013-02-15 10:56:35 -08001247 /**
Robert Greenwalt701a5c32014-06-23 11:40:00 -07001248 * Returns connection status information about a particular
1249 * Network.
1250 *
1251 * @param network {@link Network} specifying which network
1252 * in which you're interested.
1253 * @return a {@link NetworkInfo} object for the requested
1254 * network or {@code null} if the {@code Network}
1255 * is not valid.
junyulai5c2f6262018-12-13 12:47:51 +08001256 * @deprecated See {@link NetworkInfo}.
Robert Greenwalt701a5c32014-06-23 11:40:00 -07001257 */
junyulai5c2f6262018-12-13 12:47:51 +08001258 @Deprecated
Jeff Sharkey2ac62992017-04-24 11:18:03 -06001259 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean42a9c292019-01-07 19:26:34 +09001260 @Nullable
1261 public NetworkInfo getNetworkInfo(@Nullable Network network) {
Jeff Sharkey833c35b2016-04-28 15:33:18 -06001262 return getNetworkInfoForUid(network, Process.myUid(), false);
1263 }
1264
1265 /** {@hide} */
1266 public NetworkInfo getNetworkInfoForUid(Network network, int uid, boolean ignoreBlocked) {
Robert Greenwalt701a5c32014-06-23 11:40:00 -07001267 try {
Jeff Sharkey833c35b2016-04-28 15:33:18 -06001268 return mService.getNetworkInfoForUid(network, uid, ignoreBlocked);
Robert Greenwalt701a5c32014-06-23 11:40:00 -07001269 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07001270 throw e.rethrowFromSystemServer();
Robert Greenwalt701a5c32014-06-23 11:40:00 -07001271 }
1272 }
1273
1274 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -08001275 * Returns connection status information about all network
1276 * types supported by the device.
1277 *
1278 * @return an array of {@link NetworkInfo} objects. Check each
1279 * {@link NetworkInfo#getType} for which type each applies.
1280 *
Paul Jensena8e6dc62015-03-18 12:23:02 -04001281 * @deprecated This method does not support multiple connected networks
1282 * of the same type. Use {@link #getAllNetworks} and
1283 * {@link #getNetworkInfo(android.net.Network)} instead.
Robert Greenwalt26744a52013-02-15 10:56:35 -08001284 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -07001285 @Deprecated
Jeff Sharkey2ac62992017-04-24 11:18:03 -06001286 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean42a9c292019-01-07 19:26:34 +09001287 @NonNull
The Android Open Source Project28527d22009-03-03 19:31:44 -08001288 public NetworkInfo[] getAllNetworkInfo() {
1289 try {
1290 return mService.getAllNetworkInfo();
1291 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07001292 throw e.rethrowFromSystemServer();
The Android Open Source Project28527d22009-03-03 19:31:44 -08001293 }
1294 }
1295
Robert Greenwalt26744a52013-02-15 10:56:35 -08001296 /**
junyulai57840802021-03-03 12:09:05 +08001297 * Return a list of {@link NetworkStateSnapshot}s, one for each network that is currently
1298 * connected.
1299 * @hide
1300 */
1301 @SystemApi(client = MODULE_LIBRARIES)
1302 @RequiresPermission(anyOf = {
1303 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
1304 android.Manifest.permission.NETWORK_STACK,
1305 android.Manifest.permission.NETWORK_SETTINGS})
1306 @NonNull
1307 public List<NetworkStateSnapshot> getAllNetworkStateSnapshot() {
1308 try {
1309 return mService.getAllNetworkStateSnapshot();
1310 } catch (RemoteException e) {
1311 throw e.rethrowFromSystemServer();
1312 }
1313 }
1314
1315 /**
Lorenzo Colitti2b2d73c2014-08-22 17:10:50 -07001316 * Returns the {@link Network} object currently serving a given type, or
1317 * null if the given type is not connected.
1318 *
Lorenzo Colitti2b2d73c2014-08-22 17:10:50 -07001319 * @hide
Paul Jensena8e6dc62015-03-18 12:23:02 -04001320 * @deprecated This method does not support multiple connected networks
1321 * of the same type. Use {@link #getAllNetworks} and
1322 * {@link #getNetworkInfo(android.net.Network)} instead.
Lorenzo Colitti2b2d73c2014-08-22 17:10:50 -07001323 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -07001324 @Deprecated
Jeff Sharkey2ac62992017-04-24 11:18:03 -06001325 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Mathew Inwood0b8f8612018-08-08 14:52:47 +01001326 @UnsupportedAppUsage
Lorenzo Colitti2b2d73c2014-08-22 17:10:50 -07001327 public Network getNetworkForType(int networkType) {
1328 try {
1329 return mService.getNetworkForType(networkType);
1330 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07001331 throw e.rethrowFromSystemServer();
Lorenzo Colitti2b2d73c2014-08-22 17:10:50 -07001332 }
1333 }
1334
1335 /**
Robert Greenwalt701a5c32014-06-23 11:40:00 -07001336 * Returns an array of all {@link Network} currently tracked by the
1337 * framework.
Paul Jensen19b3ee72015-05-06 11:10:18 -04001338 *
1339 * @return an array of {@link Network} objects.
Robert Greenwalt701a5c32014-06-23 11:40:00 -07001340 */
Jeff Sharkey2ac62992017-04-24 11:18:03 -06001341 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean42a9c292019-01-07 19:26:34 +09001342 @NonNull
Robert Greenwalt701a5c32014-06-23 11:40:00 -07001343 public Network[] getAllNetworks() {
1344 try {
1345 return mService.getAllNetworks();
1346 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07001347 throw e.rethrowFromSystemServer();
Robert Greenwalt701a5c32014-06-23 11:40:00 -07001348 }
1349 }
1350
1351 /**
Roshan Pius7992afd2020-12-22 15:10:42 -08001352 * Returns an array of {@link NetworkCapabilities} objects, representing
Lorenzo Colitti8db934a2014-11-28 11:21:30 +09001353 * the Networks that applications run by the given user will use by default.
1354 * @hide
1355 */
Mathew Inwood0b8f8612018-08-08 14:52:47 +01001356 @UnsupportedAppUsage
Lorenzo Colitti8db934a2014-11-28 11:21:30 +09001357 public NetworkCapabilities[] getDefaultNetworkCapabilitiesForUser(int userId) {
1358 try {
Qingxi Libf6bf082020-01-08 12:51:49 -08001359 return mService.getDefaultNetworkCapabilitiesForUser(
Roshan Piusc97d8062020-12-17 14:53:09 -08001360 userId, mContext.getOpPackageName(), getAttributionTag());
Lorenzo Colitti8db934a2014-11-28 11:21:30 +09001361 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07001362 throw e.rethrowFromSystemServer();
Lorenzo Colitti8db934a2014-11-28 11:21:30 +09001363 }
1364 }
1365
1366 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -08001367 * Returns the IP information for the current default network.
1368 *
1369 * @return a {@link LinkProperties} object describing the IP info
1370 * for the current default network, or {@code null} if there
1371 * is no current default network.
1372 *
Robert Greenwalt26744a52013-02-15 10:56:35 -08001373 * {@hide}
Chalard Jeancc47b522019-01-11 16:47:53 +09001374 * @deprecated please use {@link #getLinkProperties(Network)} on the return
1375 * value of {@link #getActiveNetwork()} instead. In particular,
1376 * this method will return non-null LinkProperties even if the
1377 * app is blocked by policy from using this network.
Robert Greenwalt26744a52013-02-15 10:56:35 -08001378 */
Jeff Sharkey2ac62992017-04-24 11:18:03 -06001379 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jeancc47b522019-01-11 16:47:53 +09001380 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 109783091)
Robert Greenwalt9f0ee4f2010-09-14 09:18:02 -07001381 public LinkProperties getActiveLinkProperties() {
1382 try {
1383 return mService.getActiveLinkProperties();
1384 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07001385 throw e.rethrowFromSystemServer();
Robert Greenwalt9f0ee4f2010-09-14 09:18:02 -07001386 }
1387 }
1388
Robert Greenwalt26744a52013-02-15 10:56:35 -08001389 /**
1390 * Returns the IP information for a given network type.
1391 *
1392 * @param networkType the network type of interest.
1393 * @return a {@link LinkProperties} object describing the IP info
1394 * for the given networkType, or {@code null} if there is
1395 * no current default network.
1396 *
Robert Greenwalt26744a52013-02-15 10:56:35 -08001397 * {@hide}
Paul Jensena8e6dc62015-03-18 12:23:02 -04001398 * @deprecated This method does not support multiple connected networks
1399 * of the same type. Use {@link #getAllNetworks},
1400 * {@link #getNetworkInfo(android.net.Network)}, and
1401 * {@link #getLinkProperties(android.net.Network)} instead.
Robert Greenwalt26744a52013-02-15 10:56:35 -08001402 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -07001403 @Deprecated
Jeff Sharkey2ac62992017-04-24 11:18:03 -06001404 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jeanaa91c9d2019-04-09 15:46:21 +09001405 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 130143562)
Robert Greenwalt9f0ee4f2010-09-14 09:18:02 -07001406 public LinkProperties getLinkProperties(int networkType) {
1407 try {
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07001408 return mService.getLinkPropertiesForType(networkType);
1409 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07001410 throw e.rethrowFromSystemServer();
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07001411 }
1412 }
1413
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07001414 /**
1415 * Get the {@link LinkProperties} for the given {@link Network}. This
1416 * will return {@code null} if the network is unknown.
1417 *
1418 * @param network The {@link Network} object identifying the network in question.
1419 * @return The {@link LinkProperties} for the network, or {@code null}.
Paul Jensen19b3ee72015-05-06 11:10:18 -04001420 */
Jeff Sharkey2ac62992017-04-24 11:18:03 -06001421 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean42a9c292019-01-07 19:26:34 +09001422 @Nullable
1423 public LinkProperties getLinkProperties(@Nullable Network network) {
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07001424 try {
1425 return mService.getLinkProperties(network);
1426 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07001427 throw e.rethrowFromSystemServer();
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07001428 }
1429 }
1430
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07001431 /**
Roshan Pius7992afd2020-12-22 15:10:42 -08001432 * Get the {@link NetworkCapabilities} for the given {@link Network}. This
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07001433 * will return {@code null} if the network is unknown.
1434 *
Roshan Pius7992afd2020-12-22 15:10:42 -08001435 * This will remove any location sensitive data in {@link TransportInfo} embedded in
1436 * {@link NetworkCapabilities#getTransportInfo()}. Some transport info instances like
1437 * {@link android.net.wifi.WifiInfo} contain location sensitive information. Retrieving
1438 * this location sensitive information (subject to app's location permissions) will be
1439 * noted by system. To include any location sensitive data in {@link TransportInfo},
1440 * use a {@link NetworkCallback} with
1441 * {@link NetworkCallback#FLAG_INCLUDE_LOCATION_INFO} flag.
1442 *
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07001443 * @param network The {@link Network} object identifying the network in question.
Roshan Pius7992afd2020-12-22 15:10:42 -08001444 * @return The {@link NetworkCapabilities} for the network, or {@code null}.
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07001445 */
Jeff Sharkey2ac62992017-04-24 11:18:03 -06001446 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean42a9c292019-01-07 19:26:34 +09001447 @Nullable
1448 public NetworkCapabilities getNetworkCapabilities(@Nullable Network network) {
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07001449 try {
Roshan Piusc97d8062020-12-17 14:53:09 -08001450 return mService.getNetworkCapabilities(
1451 network, mContext.getOpPackageName(), getAttributionTag());
Robert Greenwalt9f0ee4f2010-09-14 09:18:02 -07001452 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07001453 throw e.rethrowFromSystemServer();
Robert Greenwalt9f0ee4f2010-09-14 09:18:02 -07001454 }
1455 }
1456
Robert Greenwalt26744a52013-02-15 10:56:35 -08001457 /**
Remi NGUYEN VAN69a57cb2019-03-20 14:22:49 +09001458 * Gets a URL that can be used for resolving whether a captive portal is present.
Udam Saini53b71ee2016-01-04 12:16:14 -08001459 * 1. This URL should respond with a 204 response to a GET request to indicate no captive
1460 * portal is present.
1461 * 2. This URL must be HTTP as redirect responses are used to find captive portal
1462 * sign-in pages. Captive portals cannot respond to HTTPS requests with redirects.
1463 *
Remi NGUYEN VAN69a57cb2019-03-20 14:22:49 +09001464 * The system network validation may be using different strategies to detect captive portals,
1465 * so this method does not necessarily return a URL used by the system. It only returns a URL
1466 * that may be relevant for other components trying to detect captive portals.
paulhuec0a9632019-08-12 16:25:11 +08001467 *
Udam Saini53b71ee2016-01-04 12:16:14 -08001468 * @hide
paulhuec0a9632019-08-12 16:25:11 +08001469 * @deprecated This API returns URL which is not guaranteed to be one of the URLs used by the
1470 * system.
Udam Saini53b71ee2016-01-04 12:16:14 -08001471 */
paulhuec0a9632019-08-12 16:25:11 +08001472 @Deprecated
Udam Saini53b71ee2016-01-04 12:16:14 -08001473 @SystemApi
paulhuec0a9632019-08-12 16:25:11 +08001474 @RequiresPermission(android.Manifest.permission.NETWORK_SETTINGS)
Udam Saini53b71ee2016-01-04 12:16:14 -08001475 public String getCaptivePortalServerUrl() {
1476 try {
1477 return mService.getCaptivePortalServerUrl();
1478 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07001479 throw e.rethrowFromSystemServer();
Udam Saini53b71ee2016-01-04 12:16:14 -08001480 }
1481 }
1482
1483 /**
The Android Open Source Project28527d22009-03-03 19:31:44 -08001484 * Tells the underlying networking system that the caller wants to
1485 * begin using the named feature. The interpretation of {@code feature}
1486 * is completely up to each networking implementation.
Lorenzo Colitti91de63b2015-10-15 16:29:00 +09001487 *
1488 * <p>This method requires the caller to hold either the
1489 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
1490 * or the ability to modify system settings as determined by
1491 * {@link android.provider.Settings.System#canWrite}.</p>
1492 *
The Android Open Source Project28527d22009-03-03 19:31:44 -08001493 * @param networkType specifies which network the request pertains to
1494 * @param feature the name of the feature to be used
1495 * @return an integer value representing the outcome of the request.
1496 * The interpretation of this value is specific to each networking
1497 * implementation+feature combination, except that the value {@code -1}
1498 * always indicates failure.
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07001499 *
Lorenzo Colittiefd396e2015-04-24 17:03:31 +09001500 * @deprecated Deprecated in favor of the cleaner
1501 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} API.
Dianne Hackbornc16abda2015-07-31 10:35:34 -07001502 * In {@link VERSION_CODES#M}, and above, this method is unsupported and will
Lorenzo Colitti9b026fa2015-07-29 11:41:21 +09001503 * throw {@code UnsupportedOperationException} if called.
Lorenzo Colitti7cb18342016-12-09 18:39:30 +09001504 * @removed
The Android Open Source Project28527d22009-03-03 19:31:44 -08001505 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -07001506 @Deprecated
The Android Open Source Project28527d22009-03-03 19:31:44 -08001507 public int startUsingNetworkFeature(int networkType, String feature) {
Lorenzo Colitti9b026fa2015-07-29 11:41:21 +09001508 checkLegacyRoutingApiAccess();
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001509 NetworkCapabilities netCap = networkCapabilitiesForFeature(networkType, feature);
1510 if (netCap == null) {
1511 Log.d(TAG, "Can't satisfy startUsingNetworkFeature for " + networkType + ", " +
1512 feature);
Chalard Jean1f42df12019-11-21 14:48:00 +09001513 return DEPRECATED_PHONE_CONSTANT_APN_REQUEST_FAILED;
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001514 }
1515
1516 NetworkRequest request = null;
1517 synchronized (sLegacyRequests) {
1518 LegacyRequest l = sLegacyRequests.get(netCap);
1519 if (l != null) {
1520 Log.d(TAG, "renewing startUsingNetworkFeature request " + l.networkRequest);
1521 renewRequestLocked(l);
1522 if (l.currentNetwork != null) {
Chalard Jean1f42df12019-11-21 14:48:00 +09001523 return DEPRECATED_PHONE_CONSTANT_APN_ALREADY_ACTIVE;
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001524 } else {
Chalard Jean1f42df12019-11-21 14:48:00 +09001525 return DEPRECATED_PHONE_CONSTANT_APN_REQUEST_STARTED;
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001526 }
1527 }
1528
1529 request = requestNetworkForFeatureLocked(netCap);
1530 }
1531 if (request != null) {
Robert Greenwaltca3c5cf2014-06-20 10:58:45 -07001532 Log.d(TAG, "starting startUsingNetworkFeature for request " + request);
Chalard Jean1f42df12019-11-21 14:48:00 +09001533 return DEPRECATED_PHONE_CONSTANT_APN_REQUEST_STARTED;
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001534 } else {
1535 Log.d(TAG, " request Failed");
Chalard Jean1f42df12019-11-21 14:48:00 +09001536 return DEPRECATED_PHONE_CONSTANT_APN_REQUEST_FAILED;
The Android Open Source Project28527d22009-03-03 19:31:44 -08001537 }
1538 }
1539
1540 /**
1541 * Tells the underlying networking system that the caller is finished
1542 * using the named feature. The interpretation of {@code feature}
1543 * is completely up to each networking implementation.
Lorenzo Colitti91de63b2015-10-15 16:29:00 +09001544 *
1545 * <p>This method requires the caller to hold either the
1546 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
1547 * or the ability to modify system settings as determined by
1548 * {@link android.provider.Settings.System#canWrite}.</p>
1549 *
The Android Open Source Project28527d22009-03-03 19:31:44 -08001550 * @param networkType specifies which network the request pertains to
1551 * @param feature the name of the feature that is no longer needed
1552 * @return an integer value representing the outcome of the request.
1553 * The interpretation of this value is specific to each networking
1554 * implementation+feature combination, except that the value {@code -1}
1555 * always indicates failure.
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07001556 *
Lorenzo Colittiad458ad2016-04-13 22:00:02 +09001557 * @deprecated Deprecated in favor of the cleaner
1558 * {@link #unregisterNetworkCallback(NetworkCallback)} API.
Dianne Hackbornc16abda2015-07-31 10:35:34 -07001559 * In {@link VERSION_CODES#M}, and above, this method is unsupported and will
Lorenzo Colitti9b026fa2015-07-29 11:41:21 +09001560 * throw {@code UnsupportedOperationException} if called.
Lorenzo Colitti7cb18342016-12-09 18:39:30 +09001561 * @removed
The Android Open Source Project28527d22009-03-03 19:31:44 -08001562 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -07001563 @Deprecated
The Android Open Source Project28527d22009-03-03 19:31:44 -08001564 public int stopUsingNetworkFeature(int networkType, String feature) {
Lorenzo Colitti9b026fa2015-07-29 11:41:21 +09001565 checkLegacyRoutingApiAccess();
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001566 NetworkCapabilities netCap = networkCapabilitiesForFeature(networkType, feature);
1567 if (netCap == null) {
1568 Log.d(TAG, "Can't satisfy stopUsingNetworkFeature for " + networkType + ", " +
1569 feature);
The Android Open Source Project28527d22009-03-03 19:31:44 -08001570 return -1;
1571 }
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001572
Paul Jensen034dea32014-12-17 10:39:34 -05001573 if (removeRequestForFeature(netCap)) {
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001574 Log.d(TAG, "stopUsingNetworkFeature for " + networkType + ", " + feature);
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001575 }
1576 return 1;
1577 }
1578
Mathew Inwoodd078d3d2020-10-27 11:47:29 +00001579 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001580 private NetworkCapabilities networkCapabilitiesForFeature(int networkType, String feature) {
1581 if (networkType == TYPE_MOBILE) {
Erik Kline50068e52017-01-26 18:08:28 +09001582 switch (feature) {
1583 case "enableCBS":
1584 return networkCapabilitiesForType(TYPE_MOBILE_CBS);
1585 case "enableDUN":
1586 case "enableDUNAlways":
1587 return networkCapabilitiesForType(TYPE_MOBILE_DUN);
1588 case "enableFOTA":
1589 return networkCapabilitiesForType(TYPE_MOBILE_FOTA);
1590 case "enableHIPRI":
1591 return networkCapabilitiesForType(TYPE_MOBILE_HIPRI);
1592 case "enableIMS":
1593 return networkCapabilitiesForType(TYPE_MOBILE_IMS);
1594 case "enableMMS":
1595 return networkCapabilitiesForType(TYPE_MOBILE_MMS);
1596 case "enableSUPL":
1597 return networkCapabilitiesForType(TYPE_MOBILE_SUPL);
1598 default:
1599 return null;
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001600 }
Erik Kline50068e52017-01-26 18:08:28 +09001601 } else if (networkType == TYPE_WIFI && "p2p".equals(feature)) {
1602 return networkCapabilitiesForType(TYPE_WIFI_P2P);
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001603 }
1604 return null;
1605 }
1606
Robert Greenwalt5a367872014-06-02 15:32:02 -07001607 private int legacyTypeForNetworkCapabilities(NetworkCapabilities netCap) {
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001608 if (netCap == null) return TYPE_NONE;
1609 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_CBS)) {
1610 return TYPE_MOBILE_CBS;
1611 }
1612 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_IMS)) {
1613 return TYPE_MOBILE_IMS;
1614 }
1615 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_FOTA)) {
1616 return TYPE_MOBILE_FOTA;
1617 }
1618 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_DUN)) {
1619 return TYPE_MOBILE_DUN;
1620 }
1621 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_SUPL)) {
1622 return TYPE_MOBILE_SUPL;
1623 }
1624 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_MMS)) {
1625 return TYPE_MOBILE_MMS;
1626 }
1627 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_INTERNET)) {
1628 return TYPE_MOBILE_HIPRI;
1629 }
Robert Greenwalt5a367872014-06-02 15:32:02 -07001630 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_WIFI_P2P)) {
1631 return TYPE_WIFI_P2P;
1632 }
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001633 return TYPE_NONE;
1634 }
1635
1636 private static class LegacyRequest {
1637 NetworkCapabilities networkCapabilities;
1638 NetworkRequest networkRequest;
1639 int expireSequenceNumber;
1640 Network currentNetwork;
1641 int delay = -1;
Paul Jensen034dea32014-12-17 10:39:34 -05001642
1643 private void clearDnsBinding() {
1644 if (currentNetwork != null) {
1645 currentNetwork = null;
1646 setProcessDefaultNetworkForHostResolution(null);
1647 }
1648 }
1649
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07001650 NetworkCallback networkCallback = new NetworkCallback() {
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001651 @Override
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07001652 public void onAvailable(Network network) {
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001653 currentNetwork = network;
1654 Log.d(TAG, "startUsingNetworkFeature got Network:" + network);
Paul Jensene98c6e02014-05-29 10:12:39 -04001655 setProcessDefaultNetworkForHostResolution(network);
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001656 }
1657 @Override
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07001658 public void onLost(Network network) {
Paul Jensen034dea32014-12-17 10:39:34 -05001659 if (network.equals(currentNetwork)) clearDnsBinding();
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001660 Log.d(TAG, "startUsingNetworkFeature lost Network:" + network);
1661 }
1662 };
1663 }
1664
Mathew Inwoodd078d3d2020-10-27 11:47:29 +00001665 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
Chalard Jean73d9db72018-06-04 16:52:49 +09001666 private static final HashMap<NetworkCapabilities, LegacyRequest> sLegacyRequests =
1667 new HashMap<>();
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001668
1669 private NetworkRequest findRequestForFeature(NetworkCapabilities netCap) {
1670 synchronized (sLegacyRequests) {
1671 LegacyRequest l = sLegacyRequests.get(netCap);
1672 if (l != null) return l.networkRequest;
1673 }
1674 return null;
1675 }
1676
1677 private void renewRequestLocked(LegacyRequest l) {
1678 l.expireSequenceNumber++;
1679 Log.d(TAG, "renewing request to seqNum " + l.expireSequenceNumber);
1680 sendExpireMsgForFeature(l.networkCapabilities, l.expireSequenceNumber, l.delay);
1681 }
1682
1683 private void expireRequest(NetworkCapabilities netCap, int sequenceNum) {
1684 int ourSeqNum = -1;
1685 synchronized (sLegacyRequests) {
1686 LegacyRequest l = sLegacyRequests.get(netCap);
1687 if (l == null) return;
1688 ourSeqNum = l.expireSequenceNumber;
Paul Jensen034dea32014-12-17 10:39:34 -05001689 if (l.expireSequenceNumber == sequenceNum) removeRequestForFeature(netCap);
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001690 }
1691 Log.d(TAG, "expireRequest with " + ourSeqNum + ", " + sequenceNum);
1692 }
1693
Mathew Inwoodd078d3d2020-10-27 11:47:29 +00001694 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001695 private NetworkRequest requestNetworkForFeatureLocked(NetworkCapabilities netCap) {
1696 int delay = -1;
Robert Greenwalt5a367872014-06-02 15:32:02 -07001697 int type = legacyTypeForNetworkCapabilities(netCap);
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001698 try {
1699 delay = mService.getRestoreDefaultNetworkDelay(type);
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07001700 } catch (RemoteException e) {
1701 throw e.rethrowFromSystemServer();
1702 }
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001703 LegacyRequest l = new LegacyRequest();
1704 l.networkCapabilities = netCap;
1705 l.delay = delay;
1706 l.expireSequenceNumber = 0;
Hugo Benichicd5a0e02017-02-02 17:02:36 +09001707 l.networkRequest = sendRequestForNetwork(
1708 netCap, l.networkCallback, 0, REQUEST, type, getDefaultHandler());
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001709 if (l.networkRequest == null) return null;
1710 sLegacyRequests.put(netCap, l);
1711 sendExpireMsgForFeature(netCap, l.expireSequenceNumber, delay);
1712 return l.networkRequest;
1713 }
1714
1715 private void sendExpireMsgForFeature(NetworkCapabilities netCap, int seqNum, int delay) {
1716 if (delay >= 0) {
1717 Log.d(TAG, "sending expire msg with seqNum " + seqNum + " and delay " + delay);
Hugo Benichicd5a0e02017-02-02 17:02:36 +09001718 CallbackHandler handler = getDefaultHandler();
Hugo Benichiec180d52017-02-03 14:18:44 +09001719 Message msg = handler.obtainMessage(EXPIRE_LEGACY_REQUEST, seqNum, 0, netCap);
1720 handler.sendMessageDelayed(msg, delay);
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001721 }
1722 }
1723
Mathew Inwoodd078d3d2020-10-27 11:47:29 +00001724 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
Paul Jensen034dea32014-12-17 10:39:34 -05001725 private boolean removeRequestForFeature(NetworkCapabilities netCap) {
1726 final LegacyRequest l;
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001727 synchronized (sLegacyRequests) {
Paul Jensen034dea32014-12-17 10:39:34 -05001728 l = sLegacyRequests.remove(netCap);
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001729 }
Paul Jensen034dea32014-12-17 10:39:34 -05001730 if (l == null) return false;
1731 unregisterNetworkCallback(l.networkCallback);
1732 l.clearDnsBinding();
1733 return true;
The Android Open Source Project28527d22009-03-03 19:31:44 -08001734 }
1735
Erik Kline50068e52017-01-26 18:08:28 +09001736 private static final SparseIntArray sLegacyTypeToTransport = new SparseIntArray();
1737 static {
1738 sLegacyTypeToTransport.put(TYPE_MOBILE, NetworkCapabilities.TRANSPORT_CELLULAR);
1739 sLegacyTypeToTransport.put(TYPE_MOBILE_CBS, NetworkCapabilities.TRANSPORT_CELLULAR);
1740 sLegacyTypeToTransport.put(TYPE_MOBILE_DUN, NetworkCapabilities.TRANSPORT_CELLULAR);
1741 sLegacyTypeToTransport.put(TYPE_MOBILE_FOTA, NetworkCapabilities.TRANSPORT_CELLULAR);
1742 sLegacyTypeToTransport.put(TYPE_MOBILE_HIPRI, NetworkCapabilities.TRANSPORT_CELLULAR);
1743 sLegacyTypeToTransport.put(TYPE_MOBILE_IMS, NetworkCapabilities.TRANSPORT_CELLULAR);
1744 sLegacyTypeToTransport.put(TYPE_MOBILE_MMS, NetworkCapabilities.TRANSPORT_CELLULAR);
1745 sLegacyTypeToTransport.put(TYPE_MOBILE_SUPL, NetworkCapabilities.TRANSPORT_CELLULAR);
1746 sLegacyTypeToTransport.put(TYPE_WIFI, NetworkCapabilities.TRANSPORT_WIFI);
1747 sLegacyTypeToTransport.put(TYPE_WIFI_P2P, NetworkCapabilities.TRANSPORT_WIFI);
1748 sLegacyTypeToTransport.put(TYPE_BLUETOOTH, NetworkCapabilities.TRANSPORT_BLUETOOTH);
1749 sLegacyTypeToTransport.put(TYPE_ETHERNET, NetworkCapabilities.TRANSPORT_ETHERNET);
1750 }
1751
1752 private static final SparseIntArray sLegacyTypeToCapability = new SparseIntArray();
1753 static {
1754 sLegacyTypeToCapability.put(TYPE_MOBILE_CBS, NetworkCapabilities.NET_CAPABILITY_CBS);
1755 sLegacyTypeToCapability.put(TYPE_MOBILE_DUN, NetworkCapabilities.NET_CAPABILITY_DUN);
1756 sLegacyTypeToCapability.put(TYPE_MOBILE_FOTA, NetworkCapabilities.NET_CAPABILITY_FOTA);
1757 sLegacyTypeToCapability.put(TYPE_MOBILE_IMS, NetworkCapabilities.NET_CAPABILITY_IMS);
1758 sLegacyTypeToCapability.put(TYPE_MOBILE_MMS, NetworkCapabilities.NET_CAPABILITY_MMS);
1759 sLegacyTypeToCapability.put(TYPE_MOBILE_SUPL, NetworkCapabilities.NET_CAPABILITY_SUPL);
1760 sLegacyTypeToCapability.put(TYPE_WIFI_P2P, NetworkCapabilities.NET_CAPABILITY_WIFI_P2P);
1761 }
1762
1763 /**
1764 * Given a legacy type (TYPE_WIFI, ...) returns a NetworkCapabilities
1765 * instance suitable for registering a request or callback. Throws an
1766 * IllegalArgumentException if no mapping from the legacy type to
1767 * NetworkCapabilities is known.
1768 *
Chalard Jean5acb7b72018-03-08 13:54:53 +09001769 * @deprecated Types are deprecated. Use {@link NetworkCallback} or {@link NetworkRequest}
1770 * to find the network instead.
Erik Kline50068e52017-01-26 18:08:28 +09001771 * @hide
1772 */
1773 public static NetworkCapabilities networkCapabilitiesForType(int type) {
1774 final NetworkCapabilities nc = new NetworkCapabilities();
1775
1776 // Map from type to transports.
1777 final int NOT_FOUND = -1;
1778 final int transport = sLegacyTypeToTransport.get(type, NOT_FOUND);
Remi NGUYEN VANc4dd8c92021-03-15 07:31:54 +00001779 if (transport == NOT_FOUND) {
1780 throw new IllegalArgumentException("unknown legacy type: " + type);
1781 }
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 VANc4dd8c92021-03-15 07:31:54 +00001886 Objects.requireNonNull(network, "network cannot be null");
1887 Objects.requireNonNull(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
lucaslin5140e482021-03-22 11:51:27 +08002130 @SystemApi(client = MODULE_LIBRARIES)
Robert Greenwalt7fe44cb2010-08-27 09:24:29 -07002131 public boolean requestRouteToHostAddress(int networkType, InetAddress hostAddress) {
Lorenzo Colitti9b026fa2015-07-29 11:41:21 +09002132 checkLegacyRoutingApiAccess();
The Android Open Source Project28527d22009-03-03 19:31:44 -08002133 try {
Philip P. Moltmannddbcf5b2020-03-24 15:57:49 -07002134 return mService.requestRouteToHostAddress(networkType, hostAddress.getAddress(),
2135 mContext.getOpPackageName(), getAttributionTag());
The Android Open Source Project28527d22009-03-03 19:31:44 -08002136 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07002137 throw e.rethrowFromSystemServer();
The Android Open Source Project28527d22009-03-03 19:31:44 -08002138 }
2139 }
2140
2141 /**
Philip P. Moltmannddbcf5b2020-03-24 15:57:49 -07002142 * @return the context's attribution tag
2143 */
2144 // TODO: Remove method and replace with direct call once R code is pushed to AOSP
2145 private @Nullable String getAttributionTag() {
2146 return mContext.getAttributionTag();
2147 }
2148
2149 /**
The Android Open Source Project28527d22009-03-03 19:31:44 -08002150 * Returns the value of the setting for background data usage. If false,
2151 * applications should not use the network if the application is not in the
2152 * foreground. Developers should respect this setting, and check the value
2153 * of this before performing any background data operations.
2154 * <p>
2155 * All applications that have background services that use the network
2156 * should listen to {@link #ACTION_BACKGROUND_DATA_SETTING_CHANGED}.
Jeff Sharkey39c01eb2011-08-16 14:37:57 -07002157 * <p>
Scott Main50589142011-10-06 18:32:43 -07002158 * @deprecated As of {@link VERSION_CODES#ICE_CREAM_SANDWICH}, availability of
Jeff Sharkey39c01eb2011-08-16 14:37:57 -07002159 * background data depends on several combined factors, and this method will
2160 * always return {@code true}. Instead, when background data is unavailable,
2161 * {@link #getActiveNetworkInfo()} will now appear disconnected.
Danica Chang96567052010-08-11 14:54:43 -07002162 *
The Android Open Source Project28527d22009-03-03 19:31:44 -08002163 * @return Whether background data usage is allowed.
2164 */
Jeff Sharkey39c01eb2011-08-16 14:37:57 -07002165 @Deprecated
The Android Open Source Project28527d22009-03-03 19:31:44 -08002166 public boolean getBackgroundDataSetting() {
Jeff Sharkey39c01eb2011-08-16 14:37:57 -07002167 // assume that background data is allowed; final authority is
2168 // NetworkInfo which may be blocked.
2169 return true;
The Android Open Source Project28527d22009-03-03 19:31:44 -08002170 }
2171
2172 /**
2173 * Sets the value of the setting for background data usage.
Robert Greenwalt1b21f6c2010-02-23 18:58:05 -08002174 *
The Android Open Source Project28527d22009-03-03 19:31:44 -08002175 * @param allowBackgroundData Whether an application should use data while
2176 * it is in the background.
Robert Greenwalt1b21f6c2010-02-23 18:58:05 -08002177 *
The Android Open Source Project28527d22009-03-03 19:31:44 -08002178 * @attr ref android.Manifest.permission#CHANGE_BACKGROUND_DATA_SETTING
2179 * @see #getBackgroundDataSetting()
2180 * @hide
2181 */
Jeff Sharkey39c01eb2011-08-16 14:37:57 -07002182 @Deprecated
Mathew Inwood0b8f8612018-08-08 14:52:47 +01002183 @UnsupportedAppUsage
The Android Open Source Project28527d22009-03-03 19:31:44 -08002184 public void setBackgroundDataSetting(boolean allowBackgroundData) {
Jeff Sharkey39c01eb2011-08-16 14:37:57 -07002185 // ignored
The Android Open Source Project28527d22009-03-03 19:31:44 -08002186 }
Robert Greenwalt1b21f6c2010-02-23 18:58:05 -08002187
Jeff Sharkey66fa9682011-08-02 17:22:34 -07002188 /**
Robert Greenwalt1b21f6c2010-02-23 18:58:05 -08002189 * @hide
Robert Greenwalt3d6c9582014-05-21 20:04:36 -07002190 * @deprecated Talk to TelephonyManager directly
Robert Greenwalt1b21f6c2010-02-23 18:58:05 -08002191 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -07002192 @Deprecated
Mathew Inwood0b8f8612018-08-08 14:52:47 +01002193 @UnsupportedAppUsage
Robert Greenwalt1b21f6c2010-02-23 18:58:05 -08002194 public boolean getMobileDataEnabled() {
Meng Wang91311c02019-11-18 17:10:00 -08002195 TelephonyManager tm = mContext.getSystemService(TelephonyManager.class);
2196 if (tm != null) {
2197 int subId = SubscriptionManager.getDefaultDataSubscriptionId();
2198 Log.d("ConnectivityManager", "getMobileDataEnabled()+ subId=" + subId);
2199 boolean retVal = tm.createForSubscriptionId(subId).isDataEnabled();
2200 Log.d("ConnectivityManager", "getMobileDataEnabled()- subId=" + subId
2201 + " retVal=" + retVal);
2202 return retVal;
Robert Greenwalt1b21f6c2010-02-23 18:58:05 -08002203 }
Wink Saville02eb35c2014-12-05 11:10:30 -08002204 Log.d("ConnectivityManager", "getMobileDataEnabled()- remote exception retVal=false");
Robert Greenwalt3d6c9582014-05-21 20:04:36 -07002205 return false;
Robert Greenwalt1b21f6c2010-02-23 18:58:05 -08002206 }
2207
The Android Open Source Project28527d22009-03-03 19:31:44 -08002208 /**
Robert Greenwalt2e4731f2014-09-04 16:44:35 -07002209 * Callback for use with {@link ConnectivityManager#addDefaultNetworkActiveListener}
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07002210 * to find out when the system default network has gone in to a high power state.
Dianne Hackbornb4b09e82014-02-26 16:20:52 -08002211 */
2212 public interface OnNetworkActiveListener {
2213 /**
2214 * Called on the main thread of the process to report that the current data network
2215 * has become active, and it is now a good time to perform any pending network
2216 * operations. Note that this listener only tells you when the network becomes
2217 * active; if at any other time you want to know whether it is active (and thus okay
2218 * to initiate network traffic), you can retrieve its instantaneous state with
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07002219 * {@link ConnectivityManager#isDefaultNetworkActive}.
Dianne Hackbornb4b09e82014-02-26 16:20:52 -08002220 */
Chalard Jean73d9db72018-06-04 16:52:49 +09002221 void onNetworkActive();
Dianne Hackbornb4b09e82014-02-26 16:20:52 -08002222 }
2223
Dianne Hackbornb4b09e82014-02-26 16:20:52 -08002224 private final ArrayMap<OnNetworkActiveListener, INetworkActivityListener>
Chalard Jean73d9db72018-06-04 16:52:49 +09002225 mNetworkActivityListeners = new ArrayMap<>();
Dianne Hackbornb4b09e82014-02-26 16:20:52 -08002226
2227 /**
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07002228 * Start listening to reports when the system's default data network is active, meaning it is
2229 * a good time to perform network traffic. Use {@link #isDefaultNetworkActive()}
2230 * to determine the current state of the system's default network after registering the
2231 * listener.
2232 * <p>
2233 * If the process default network has been set with
Paul Jensen895c3942015-03-10 10:54:12 -04002234 * {@link ConnectivityManager#bindProcessToNetwork} this function will not
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07002235 * reflect the process's default, but the system default.
Dianne Hackbornb4b09e82014-02-26 16:20:52 -08002236 *
2237 * @param l The listener to be told when the network is active.
2238 */
Robert Greenwalt2e4731f2014-09-04 16:44:35 -07002239 public void addDefaultNetworkActiveListener(final OnNetworkActiveListener l) {
Dianne Hackbornb4b09e82014-02-26 16:20:52 -08002240 INetworkActivityListener rl = new INetworkActivityListener.Stub() {
2241 @Override
2242 public void onNetworkActive() throws RemoteException {
2243 l.onNetworkActive();
2244 }
2245 };
2246
2247 try {
lucaslina5e9bdb2021-01-21 02:04:15 +08002248 mService.registerNetworkActivityListener(rl);
Dianne Hackbornb4b09e82014-02-26 16:20:52 -08002249 mNetworkActivityListeners.put(l, rl);
2250 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07002251 throw e.rethrowFromSystemServer();
Dianne Hackbornb4b09e82014-02-26 16:20:52 -08002252 }
2253 }
2254
2255 /**
2256 * Remove network active listener previously registered with
Robert Greenwalt2e4731f2014-09-04 16:44:35 -07002257 * {@link #addDefaultNetworkActiveListener}.
Dianne Hackbornb4b09e82014-02-26 16:20:52 -08002258 *
2259 * @param l Previously registered listener.
2260 */
Chalard Jean42a9c292019-01-07 19:26:34 +09002261 public void removeDefaultNetworkActiveListener(@NonNull OnNetworkActiveListener l) {
Dianne Hackbornb4b09e82014-02-26 16:20:52 -08002262 INetworkActivityListener rl = mNetworkActivityListeners.get(l);
Remi NGUYEN VANc4dd8c92021-03-15 07:31:54 +00002263 if (rl == null) {
2264 throw new IllegalArgumentException("Listener was not registered.");
2265 }
Dianne Hackbornb4b09e82014-02-26 16:20:52 -08002266 try {
lucaslina5e9bdb2021-01-21 02:04:15 +08002267 mService.registerNetworkActivityListener(rl);
Dianne Hackbornb4b09e82014-02-26 16:20:52 -08002268 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07002269 throw e.rethrowFromSystemServer();
Dianne Hackbornb4b09e82014-02-26 16:20:52 -08002270 }
2271 }
2272
2273 /**
2274 * Return whether the data network is currently active. An active network means that
2275 * it is currently in a high power state for performing data transmission. On some
2276 * types of networks, it may be expensive to move and stay in such a state, so it is
2277 * more power efficient to batch network traffic together when the radio is already in
2278 * this state. This method tells you whether right now is currently a good time to
2279 * initiate network traffic, as the network is already active.
2280 */
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07002281 public boolean isDefaultNetworkActive() {
Dianne Hackbornb4b09e82014-02-26 16:20:52 -08002282 try {
lucaslina5e9bdb2021-01-21 02:04:15 +08002283 return mService.isDefaultNetworkActive();
Dianne Hackbornb4b09e82014-02-26 16:20:52 -08002284 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07002285 throw e.rethrowFromSystemServer();
Dianne Hackbornb4b09e82014-02-26 16:20:52 -08002286 }
Dianne Hackbornb4b09e82014-02-26 16:20:52 -08002287 }
2288
2289 /**
The Android Open Source Project28527d22009-03-03 19:31:44 -08002290 * {@hide}
2291 */
Lorenzo Colitti9b026fa2015-07-29 11:41:21 +09002292 public ConnectivityManager(Context context, IConnectivityManager service) {
Remi NGUYEN VANc4dd8c92021-03-15 07:31:54 +00002293 mContext = Objects.requireNonNull(context, "missing context");
2294 mService = Objects.requireNonNull(service, "missing IConnectivityManager");
Automerger Merge Worker9b0c0c62020-03-06 00:38:43 +00002295 mTetheringManager = (TetheringManager) mContext.getSystemService(Context.TETHERING_SERVICE);
Paul Jensen12131352014-12-10 15:12:18 -05002296 sInstance = this;
The Android Open Source Project28527d22009-03-03 19:31:44 -08002297 }
Robert Greenwalt0c4828c2010-01-26 11:40:34 -08002298
Jeff Sharkey2d9e5a52012-04-04 20:40:58 -07002299 /** {@hide} */
Mathew Inwood0b8f8612018-08-08 14:52:47 +01002300 @UnsupportedAppUsage
Jeff Sharkey2d9e5a52012-04-04 20:40:58 -07002301 public static ConnectivityManager from(Context context) {
2302 return (ConnectivityManager) context.getSystemService(Context.CONNECTIVITY_SERVICE);
2303 }
2304
Remi NGUYEN VAN1becbe72018-12-27 16:43:56 +09002305 /** @hide */
2306 public NetworkRequest getDefaultRequest() {
2307 try {
2308 // This is not racy as the default request is final in ConnectivityService.
2309 return mService.getDefaultRequest();
2310 } catch (RemoteException e) {
2311 throw e.rethrowFromSystemServer();
2312 }
2313 }
2314
Robert Greenwalt0c4828c2010-01-26 11:40:34 -08002315 /**
Philip P. Moltmannddbcf5b2020-03-24 15:57:49 -07002316 * Check if the package is a allowed to write settings. This also accounts that such an access
2317 * happened.
2318 *
2319 * @return {@code true} iff the package is allowed to write settings.
2320 */
2321 // TODO: Remove method and replace with direct call once R code is pushed to AOSP
2322 private static boolean checkAndNoteWriteSettingsOperation(@NonNull Context context, int uid,
2323 @NonNull String callingPackage, @Nullable String callingAttributionTag,
2324 boolean throwException) {
2325 return Settings.checkAndNoteWriteSettingsOperation(context, uid, callingPackage,
2326 callingAttributionTag, throwException);
2327 }
2328
2329 /**
Paul Jensen12131352014-12-10 15:12:18 -05002330 * @deprecated - use getSystemService. This is a kludge to support static access in certain
2331 * situations where a Context pointer is unavailable.
2332 * @hide
2333 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -07002334 @Deprecated
Paul Jensen895c3942015-03-10 10:54:12 -04002335 static ConnectivityManager getInstanceOrNull() {
2336 return sInstance;
2337 }
2338
2339 /**
2340 * @deprecated - use getSystemService. This is a kludge to support static access in certain
2341 * situations where a Context pointer is unavailable.
2342 * @hide
2343 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -07002344 @Deprecated
Mathew Inwood0b8f8612018-08-08 14:52:47 +01002345 @UnsupportedAppUsage
Paul Jensen895c3942015-03-10 10:54:12 -04002346 private static ConnectivityManager getInstance() {
2347 if (getInstanceOrNull() == null) {
Paul Jensen12131352014-12-10 15:12:18 -05002348 throw new IllegalStateException("No ConnectivityManager yet constructed");
2349 }
Paul Jensen895c3942015-03-10 10:54:12 -04002350 return getInstanceOrNull();
Paul Jensen12131352014-12-10 15:12:18 -05002351 }
2352
2353 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -08002354 * Get the set of tetherable, available interfaces. This list is limited by
2355 * device configuration and current interface existence.
2356 *
2357 * @return an array of 0 or more Strings of tetherable interface names.
2358 *
markchien75721e42020-01-21 13:11:06 +08002359 * @deprecated Use {@link TetheringEventCallback#onTetherableInterfacesChanged(List)} instead.
Robert Greenwalt0c4828c2010-01-26 11:40:34 -08002360 * {@hide}
2361 */
Jeff Sharkey2ac62992017-04-24 11:18:03 -06002362 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Mathew Inwood0b8f8612018-08-08 14:52:47 +01002363 @UnsupportedAppUsage
markchien75721e42020-01-21 13:11:06 +08002364 @Deprecated
Robert Greenwalt0c4828c2010-01-26 11:40:34 -08002365 public String[] getTetherableIfaces() {
Automerger Merge Worker9b0c0c62020-03-06 00:38:43 +00002366 return mTetheringManager.getTetherableIfaces();
Robert Greenwalt0c4828c2010-01-26 11:40:34 -08002367 }
2368
2369 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -08002370 * Get the set of tethered interfaces.
2371 *
2372 * @return an array of 0 or more String of currently tethered interface names.
2373 *
markchien75721e42020-01-21 13:11:06 +08002374 * @deprecated Use {@link TetheringEventCallback#onTetherableInterfacesChanged(List)} instead.
Robert Greenwalt0c4828c2010-01-26 11:40:34 -08002375 * {@hide}
2376 */
Jeff Sharkey2ac62992017-04-24 11:18:03 -06002377 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Mathew Inwood0b8f8612018-08-08 14:52:47 +01002378 @UnsupportedAppUsage
markchien75721e42020-01-21 13:11:06 +08002379 @Deprecated
Robert Greenwalt0c4828c2010-01-26 11:40:34 -08002380 public String[] getTetheredIfaces() {
Automerger Merge Worker9b0c0c62020-03-06 00:38:43 +00002381 return mTetheringManager.getTetheredIfaces();
Robert Greenwalt0c4828c2010-01-26 11:40:34 -08002382 }
2383
2384 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -08002385 * Get the set of interface names which attempted to tether but
2386 * failed. Re-attempting to tether may cause them to reset to the Tethered
2387 * state. Alternatively, causing the interface to be destroyed and recreated
2388 * may cause them to reset to the available state.
2389 * {@link ConnectivityManager#getLastTetherError} can be used to get more
2390 * information on the cause of the errors.
2391 *
2392 * @return an array of 0 or more String indicating the interface names
2393 * which failed to tether.
2394 *
markchien75721e42020-01-21 13:11:06 +08002395 * @deprecated Use {@link TetheringEventCallback#onError(String, int)} instead.
Robert Greenwalt0c4828c2010-01-26 11:40:34 -08002396 * {@hide}
2397 */
Jeff Sharkey2ac62992017-04-24 11:18:03 -06002398 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Mathew Inwood0b8f8612018-08-08 14:52:47 +01002399 @UnsupportedAppUsage
markchien75721e42020-01-21 13:11:06 +08002400 @Deprecated
Robert Greenwalt4283ded2010-03-02 17:25:02 -08002401 public String[] getTetheringErroredIfaces() {
Automerger Merge Worker9b0c0c62020-03-06 00:38:43 +00002402 return mTetheringManager.getTetheringErroredIfaces();
Robert Greenwalt0c4828c2010-01-26 11:40:34 -08002403 }
2404
2405 /**
Robert Greenwalta75c4652014-06-23 14:53:42 -07002406 * Get the set of tethered dhcp ranges.
2407 *
markchien9e046242020-02-06 19:23:26 +08002408 * @deprecated This method is not supported.
2409 * TODO: remove this function when all of clients are removed.
Robert Greenwalta75c4652014-06-23 14:53:42 -07002410 * {@hide}
2411 */
paulhuec0a9632019-08-12 16:25:11 +08002412 @RequiresPermission(android.Manifest.permission.NETWORK_SETTINGS)
markchien75721e42020-01-21 13:11:06 +08002413 @Deprecated
Robert Greenwalta75c4652014-06-23 14:53:42 -07002414 public String[] getTetheredDhcpRanges() {
markchien9e046242020-02-06 19:23:26 +08002415 throw new UnsupportedOperationException("getTetheredDhcpRanges is not supported");
Robert Greenwalta75c4652014-06-23 14:53:42 -07002416 }
2417
2418 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -08002419 * Attempt to tether the named interface. This will setup a dhcp server
2420 * on the interface, forward and NAT IP packets and forward DNS requests
2421 * to the best active upstream network interface. Note that if no upstream
2422 * IP network interface is available, dhcp will still run and traffic will be
2423 * allowed between the tethered devices and this device, though upstream net
2424 * access will of course fail until an upstream network interface becomes
2425 * active.
Lorenzo Colitti91de63b2015-10-15 16:29:00 +09002426 *
2427 * <p>This method requires the caller to hold either the
2428 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
2429 * or the ability to modify system settings as determined by
2430 * {@link android.provider.Settings.System#canWrite}.</p>
Robert Greenwalt26744a52013-02-15 10:56:35 -08002431 *
Jeremy Klein9a36ec82016-01-22 14:11:45 -08002432 * <p>WARNING: New clients should not use this function. The only usages should be in PanService
2433 * and WifiStateMachine which need direct access. All other clients should use
2434 * {@link #startTethering} and {@link #stopTethering} which encapsulate proper provisioning
2435 * logic.</p>
2436 *
Robert Greenwalt26744a52013-02-15 10:56:35 -08002437 * @param iface the interface name to tether.
2438 * @return error a {@code TETHER_ERROR} value indicating success or failure type
markchien10ddd022020-01-20 19:31:56 +08002439 * @deprecated Use {@link TetheringManager#startTethering} instead
Robert Greenwalt26744a52013-02-15 10:56:35 -08002440 *
Robert Greenwalt0c4828c2010-01-26 11:40:34 -08002441 * {@hide}
2442 */
Mathew Inwoodd078d3d2020-10-27 11:47:29 +00002443 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
markchien10ddd022020-01-20 19:31:56 +08002444 @Deprecated
Robert Greenwalt4283ded2010-03-02 17:25:02 -08002445 public int tether(String iface) {
Automerger Merge Worker9b0c0c62020-03-06 00:38:43 +00002446 return mTetheringManager.tether(iface);
Robert Greenwalt4283ded2010-03-02 17:25:02 -08002447 }
2448
2449 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -08002450 * Stop tethering the named interface.
Lorenzo Colitti91de63b2015-10-15 16:29:00 +09002451 *
2452 * <p>This method requires the caller to hold either the
2453 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
2454 * or the ability to modify system settings as determined by
2455 * {@link android.provider.Settings.System#canWrite}.</p>
Robert Greenwalt26744a52013-02-15 10:56:35 -08002456 *
Jeremy Klein9a36ec82016-01-22 14:11:45 -08002457 * <p>WARNING: New clients should not use this function. The only usages should be in PanService
2458 * and WifiStateMachine which need direct access. All other clients should use
2459 * {@link #startTethering} and {@link #stopTethering} which encapsulate proper provisioning
2460 * logic.</p>
2461 *
Robert Greenwalt26744a52013-02-15 10:56:35 -08002462 * @param iface the interface name to untether.
2463 * @return error a {@code TETHER_ERROR} value indicating success or failure type
2464 *
Robert Greenwalt4283ded2010-03-02 17:25:02 -08002465 * {@hide}
2466 */
Mathew Inwood0b8f8612018-08-08 14:52:47 +01002467 @UnsupportedAppUsage
markchien75721e42020-01-21 13:11:06 +08002468 @Deprecated
Robert Greenwalt4283ded2010-03-02 17:25:02 -08002469 public int untether(String iface) {
Automerger Merge Worker9b0c0c62020-03-06 00:38:43 +00002470 return mTetheringManager.untether(iface);
Robert Greenwalt0c4828c2010-01-26 11:40:34 -08002471 }
Robert Greenwalt8e87f122010-02-11 18:18:40 -08002472
2473 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -08002474 * Check if the device allows for tethering. It may be disabled via
Dianne Hackbornb4b09e82014-02-26 16:20:52 -08002475 * {@code ro.tether.denied} system property, Settings.TETHER_SUPPORTED or
Robert Greenwalt26744a52013-02-15 10:56:35 -08002476 * due to device configuration.
2477 *
Chalard Jean4e1bb722017-09-26 15:45:18 +09002478 * <p>If this app does not have permission to use this API, it will always
2479 * return false rather than throw an exception.</p>
2480 *
2481 * <p>If the device has a hotspot provisioning app, the caller is required to hold the
2482 * {@link android.Manifest.permission.TETHER_PRIVILEGED} permission.</p>
2483 *
2484 * <p>Otherwise, this method requires the caller to hold the ability to modify system
2485 * settings as determined by {@link android.provider.Settings.System#canWrite}.</p>
2486 *
Robert Greenwalt26744a52013-02-15 10:56:35 -08002487 * @return a boolean - {@code true} indicating Tethering is supported.
2488 *
markchien75721e42020-01-21 13:11:06 +08002489 * @deprecated Use {@link TetheringEventCallback#onTetheringSupported(boolean)} instead.
Robert Greenwalt8e87f122010-02-11 18:18:40 -08002490 * {@hide}
2491 */
Jeremy Klein9a36ec82016-01-22 14:11:45 -08002492 @SystemApi
Chalard Jean4e1bb722017-09-26 15:45:18 +09002493 @RequiresPermission(anyOf = {android.Manifest.permission.TETHER_PRIVILEGED,
2494 android.Manifest.permission.WRITE_SETTINGS})
Robert Greenwalt8e87f122010-02-11 18:18:40 -08002495 public boolean isTetheringSupported() {
Automerger Merge Worker9b0c0c62020-03-06 00:38:43 +00002496 return mTetheringManager.isTetheringSupported();
Robert Greenwalt8e87f122010-02-11 18:18:40 -08002497 }
2498
2499 /**
Jeremy Klein9a36ec82016-01-22 14:11:45 -08002500 * Callback for use with {@link #startTethering} to find out whether tethering succeeded.
markchien10ddd022020-01-20 19:31:56 +08002501 *
2502 * @deprecated Use {@link TetheringManager.StartTetheringCallback} instead.
Jeremy Klein9a36ec82016-01-22 14:11:45 -08002503 * @hide
2504 */
2505 @SystemApi
markchien10ddd022020-01-20 19:31:56 +08002506 @Deprecated
Jeremy Klein9a36ec82016-01-22 14:11:45 -08002507 public static abstract class OnStartTetheringCallback {
2508 /**
2509 * Called when tethering has been successfully started.
2510 */
Chalard Jean73d9db72018-06-04 16:52:49 +09002511 public void onTetheringStarted() {}
Jeremy Klein9a36ec82016-01-22 14:11:45 -08002512
2513 /**
2514 * Called when starting tethering failed.
2515 */
Chalard Jean73d9db72018-06-04 16:52:49 +09002516 public void onTetheringFailed() {}
Jeremy Klein9a36ec82016-01-22 14:11:45 -08002517 }
2518
2519 /**
2520 * Convenient overload for
2521 * {@link #startTethering(int, boolean, OnStartTetheringCallback, Handler)} which passes a null
2522 * handler to run on the current thread's {@link Looper}.
markchien10ddd022020-01-20 19:31:56 +08002523 *
2524 * @deprecated Use {@link TetheringManager#startTethering} instead.
Jeremy Klein9a36ec82016-01-22 14:11:45 -08002525 * @hide
2526 */
2527 @SystemApi
markchien10ddd022020-01-20 19:31:56 +08002528 @Deprecated
Udam Saini15072332017-06-07 12:06:28 -07002529 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
Jeremy Klein9a36ec82016-01-22 14:11:45 -08002530 public void startTethering(int type, boolean showProvisioningUi,
2531 final OnStartTetheringCallback callback) {
2532 startTethering(type, showProvisioningUi, callback, null);
2533 }
2534
2535 /**
2536 * Runs tether provisioning for the given type if needed and then starts tethering if
2537 * the check succeeds. If no carrier provisioning is required for tethering, tethering is
2538 * enabled immediately. If provisioning fails, tethering will not be enabled. It also
2539 * schedules tether provisioning re-checks if appropriate.
2540 *
2541 * @param type The type of tethering to start. Must be one of
2542 * {@link ConnectivityManager.TETHERING_WIFI},
2543 * {@link ConnectivityManager.TETHERING_USB}, or
2544 * {@link ConnectivityManager.TETHERING_BLUETOOTH}.
2545 * @param showProvisioningUi a boolean indicating to show the provisioning app UI if there
2546 * is one. This should be true the first time this function is called and also any time
2547 * the user can see this UI. It gives users information from their carrier about the
2548 * check failing and how they can sign up for tethering if possible.
2549 * @param callback an {@link OnStartTetheringCallback} which will be called to notify the caller
2550 * of the result of trying to tether.
2551 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
markchien10ddd022020-01-20 19:31:56 +08002552 *
2553 * @deprecated Use {@link TetheringManager#startTethering} instead.
Jeremy Klein9a36ec82016-01-22 14:11:45 -08002554 * @hide
2555 */
2556 @SystemApi
markchien10ddd022020-01-20 19:31:56 +08002557 @Deprecated
Jeff Sharkeyb8c73032017-06-02 17:36:26 -06002558 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
Jeremy Klein9a36ec82016-01-22 14:11:45 -08002559 public void startTethering(int type, boolean showProvisioningUi,
2560 final OnStartTetheringCallback callback, Handler handler) {
Remi NGUYEN VANc4dd8c92021-03-15 07:31:54 +00002561 Objects.requireNonNull(callback, "OnStartTetheringCallback cannot be null.");
Jeremy Klein49a57952016-03-12 16:29:54 -08002562
markchien10ddd022020-01-20 19:31:56 +08002563 final Executor executor = new Executor() {
Jeremy Klein9a36ec82016-01-22 14:11:45 -08002564 @Override
markchien10ddd022020-01-20 19:31:56 +08002565 public void execute(Runnable command) {
2566 if (handler == null) {
2567 command.run();
Jeremy Klein9a36ec82016-01-22 14:11:45 -08002568 } else {
markchien10ddd022020-01-20 19:31:56 +08002569 handler.post(command);
Jeremy Klein9a36ec82016-01-22 14:11:45 -08002570 }
2571 }
2572 };
Jeremy Klein49a57952016-03-12 16:29:54 -08002573
markchien10ddd022020-01-20 19:31:56 +08002574 final StartTetheringCallback tetheringCallback = new StartTetheringCallback() {
2575 @Override
2576 public void onTetheringStarted() {
2577 callback.onTetheringStarted();
2578 }
2579
2580 @Override
markchien68b67842020-03-19 13:37:43 +08002581 public void onTetheringFailed(final int error) {
markchien10ddd022020-01-20 19:31:56 +08002582 callback.onTetheringFailed();
2583 }
2584 };
2585
2586 final TetheringRequest request = new TetheringRequest.Builder(type)
markchien68b67842020-03-19 13:37:43 +08002587 .setShouldShowEntitlementUi(showProvisioningUi).build();
markchien10ddd022020-01-20 19:31:56 +08002588
Automerger Merge Worker9b0c0c62020-03-06 00:38:43 +00002589 mTetheringManager.startTethering(request, executor, tetheringCallback);
Jeremy Klein9a36ec82016-01-22 14:11:45 -08002590 }
2591
2592 /**
2593 * Stops tethering for the given type. Also cancels any provisioning rechecks for that type if
2594 * applicable.
2595 *
2596 * @param type The type of tethering to stop. Must be one of
2597 * {@link ConnectivityManager.TETHERING_WIFI},
2598 * {@link ConnectivityManager.TETHERING_USB}, or
2599 * {@link ConnectivityManager.TETHERING_BLUETOOTH}.
markchien75721e42020-01-21 13:11:06 +08002600 *
2601 * @deprecated Use {@link TetheringManager#stopTethering} instead.
Jeremy Klein9a36ec82016-01-22 14:11:45 -08002602 * @hide
2603 */
2604 @SystemApi
markchien75721e42020-01-21 13:11:06 +08002605 @Deprecated
Jeff Sharkeyb8c73032017-06-02 17:36:26 -06002606 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
Jeremy Klein9a36ec82016-01-22 14:11:45 -08002607 public void stopTethering(int type) {
Automerger Merge Worker9b0c0c62020-03-06 00:38:43 +00002608 mTetheringManager.stopTethering(type);
Jeremy Klein9a36ec82016-01-22 14:11:45 -08002609 }
2610
2611 /**
markchiena005c992019-02-27 14:56:11 +08002612 * Callback for use with {@link registerTetheringEventCallback} to find out tethering
2613 * upstream status.
2614 *
Nathan Haroldf6fc8ab2020-01-23 18:03:46 -08002615 * @deprecated Use {@link TetheringManager#OnTetheringEventCallback} instead.
markchien75721e42020-01-21 13:11:06 +08002616 * @hide
markchiena005c992019-02-27 14:56:11 +08002617 */
2618 @SystemApi
markchien75721e42020-01-21 13:11:06 +08002619 @Deprecated
markchiena005c992019-02-27 14:56:11 +08002620 public abstract static class OnTetheringEventCallback {
2621
2622 /**
2623 * Called when tethering upstream changed. This can be called multiple times and can be
2624 * called any time.
2625 *
2626 * @param network the {@link Network} of tethering upstream. Null means tethering doesn't
2627 * have any upstream.
2628 */
2629 public void onUpstreamChanged(@Nullable Network network) {}
2630 }
2631
markchien75721e42020-01-21 13:11:06 +08002632 @GuardedBy("mTetheringEventCallbacks")
2633 private final ArrayMap<OnTetheringEventCallback, TetheringEventCallback>
2634 mTetheringEventCallbacks = new ArrayMap<>();
2635
markchiena005c992019-02-27 14:56:11 +08002636 /**
2637 * Start listening to tethering change events. Any new added callback will receive the last
markchiend378cd32019-04-03 10:43:09 +08002638 * tethering status right away. If callback is registered when tethering has no upstream or
markchiena005c992019-02-27 14:56:11 +08002639 * disabled, {@link OnTetheringEventCallback#onUpstreamChanged} will immediately be called
2640 * with a null argument. The same callback object cannot be registered twice.
2641 *
2642 * @param executor the executor on which callback will be invoked.
2643 * @param callback the callback to be called when tethering has change events.
markchien75721e42020-01-21 13:11:06 +08002644 *
Nathan Haroldf6fc8ab2020-01-23 18:03:46 -08002645 * @deprecated Use {@link TetheringManager#registerTetheringEventCallback} instead.
markchiena005c992019-02-27 14:56:11 +08002646 * @hide
2647 */
2648 @SystemApi
markchien75721e42020-01-21 13:11:06 +08002649 @Deprecated
markchiena005c992019-02-27 14:56:11 +08002650 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
2651 public void registerTetheringEventCallback(
2652 @NonNull @CallbackExecutor Executor executor,
2653 @NonNull final OnTetheringEventCallback callback) {
Remi NGUYEN VANc4dd8c92021-03-15 07:31:54 +00002654 Objects.requireNonNull(callback, "OnTetheringEventCallback cannot be null.");
markchiena005c992019-02-27 14:56:11 +08002655
markchien75721e42020-01-21 13:11:06 +08002656 final TetheringEventCallback tetherCallback =
2657 new TetheringEventCallback() {
2658 @Override
2659 public void onUpstreamChanged(@Nullable Network network) {
2660 callback.onUpstreamChanged(network);
2661 }
2662 };
2663
2664 synchronized (mTetheringEventCallbacks) {
2665 mTetheringEventCallbacks.put(callback, tetherCallback);
Automerger Merge Worker9b0c0c62020-03-06 00:38:43 +00002666 mTetheringManager.registerTetheringEventCallback(executor, tetherCallback);
markchien75721e42020-01-21 13:11:06 +08002667 }
markchiena005c992019-02-27 14:56:11 +08002668 }
2669
2670 /**
2671 * Remove tethering event callback previously registered with
2672 * {@link #registerTetheringEventCallback}.
2673 *
2674 * @param callback previously registered callback.
markchien75721e42020-01-21 13:11:06 +08002675 *
2676 * @deprecated Use {@link TetheringManager#unregisterTetheringEventCallback} instead.
markchiena005c992019-02-27 14:56:11 +08002677 * @hide
2678 */
2679 @SystemApi
markchien75721e42020-01-21 13:11:06 +08002680 @Deprecated
markchiena005c992019-02-27 14:56:11 +08002681 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
2682 public void unregisterTetheringEventCallback(
2683 @NonNull final OnTetheringEventCallback callback) {
markchien75721e42020-01-21 13:11:06 +08002684 Objects.requireNonNull(callback, "The callback must be non-null");
2685 synchronized (mTetheringEventCallbacks) {
2686 final TetheringEventCallback tetherCallback =
2687 mTetheringEventCallbacks.remove(callback);
Automerger Merge Worker9b0c0c62020-03-06 00:38:43 +00002688 mTetheringManager.unregisterTetheringEventCallback(tetherCallback);
markchien75721e42020-01-21 13:11:06 +08002689 }
markchiena005c992019-02-27 14:56:11 +08002690 }
2691
2692
2693 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -08002694 * Get the list of regular expressions that define any tetherable
2695 * USB network interfaces. If USB tethering is not supported by the
2696 * device, this list should be empty.
2697 *
2698 * @return an array of 0 or more regular expression Strings defining
2699 * what interfaces are considered tetherable usb interfaces.
2700 *
markchien75721e42020-01-21 13:11:06 +08002701 * @deprecated Use {@link TetheringEventCallback#onTetherableInterfaceRegexpsChanged} instead.
Robert Greenwalt8e87f122010-02-11 18:18:40 -08002702 * {@hide}
2703 */
Jeff Sharkey2ac62992017-04-24 11:18:03 -06002704 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Mathew Inwood0b8f8612018-08-08 14:52:47 +01002705 @UnsupportedAppUsage
markchien75721e42020-01-21 13:11:06 +08002706 @Deprecated
Robert Greenwalt8e87f122010-02-11 18:18:40 -08002707 public String[] getTetherableUsbRegexs() {
Automerger Merge Worker9b0c0c62020-03-06 00:38:43 +00002708 return mTetheringManager.getTetherableUsbRegexs();
Robert Greenwalt8e87f122010-02-11 18:18:40 -08002709 }
2710
2711 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -08002712 * Get the list of regular expressions that define any tetherable
2713 * Wifi network interfaces. If Wifi tethering is not supported by the
2714 * device, this list should be empty.
2715 *
2716 * @return an array of 0 or more regular expression Strings defining
2717 * what interfaces are considered tetherable wifi interfaces.
2718 *
markchien75721e42020-01-21 13:11:06 +08002719 * @deprecated Use {@link TetheringEventCallback#onTetherableInterfaceRegexpsChanged} instead.
Robert Greenwalt8e87f122010-02-11 18:18:40 -08002720 * {@hide}
2721 */
Jeff Sharkey2ac62992017-04-24 11:18:03 -06002722 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Mathew Inwood0b8f8612018-08-08 14:52:47 +01002723 @UnsupportedAppUsage
markchien75721e42020-01-21 13:11:06 +08002724 @Deprecated
Robert Greenwalt8e87f122010-02-11 18:18:40 -08002725 public String[] getTetherableWifiRegexs() {
Automerger Merge Worker9b0c0c62020-03-06 00:38:43 +00002726 return mTetheringManager.getTetherableWifiRegexs();
Robert Greenwalt8e87f122010-02-11 18:18:40 -08002727 }
Robert Greenwalt4283ded2010-03-02 17:25:02 -08002728
Danica Chang96567052010-08-11 14:54:43 -07002729 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -08002730 * Get the list of regular expressions that define any tetherable
2731 * Bluetooth network interfaces. If Bluetooth tethering is not supported by the
2732 * device, this list should be empty.
2733 *
2734 * @return an array of 0 or more regular expression Strings defining
2735 * what interfaces are considered tetherable bluetooth interfaces.
2736 *
markchien75721e42020-01-21 13:11:06 +08002737 * @deprecated Use {@link TetheringEventCallback#onTetherableInterfaceRegexpsChanged(
2738 *TetheringManager.TetheringInterfaceRegexps)} instead.
Danica Chang96567052010-08-11 14:54:43 -07002739 * {@hide}
2740 */
Jeff Sharkey2ac62992017-04-24 11:18:03 -06002741 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Mathew Inwood0b8f8612018-08-08 14:52:47 +01002742 @UnsupportedAppUsage
markchien75721e42020-01-21 13:11:06 +08002743 @Deprecated
Danica Chang96567052010-08-11 14:54:43 -07002744 public String[] getTetherableBluetoothRegexs() {
Automerger Merge Worker9b0c0c62020-03-06 00:38:43 +00002745 return mTetheringManager.getTetherableBluetoothRegexs();
Danica Chang96567052010-08-11 14:54:43 -07002746 }
2747
Mike Lockwooded4a1742011-07-19 13:04:47 -07002748 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -08002749 * Attempt to both alter the mode of USB and Tethering of USB. A
2750 * utility method to deal with some of the complexity of USB - will
2751 * attempt to switch to Rndis and subsequently tether the resulting
2752 * interface on {@code true} or turn off tethering and switch off
2753 * Rndis on {@code false}.
Lorenzo Colitti91de63b2015-10-15 16:29:00 +09002754 *
2755 * <p>This method requires the caller to hold either the
2756 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
2757 * or the ability to modify system settings as determined by
2758 * {@link android.provider.Settings.System#canWrite}.</p>
Robert Greenwalt26744a52013-02-15 10:56:35 -08002759 *
2760 * @param enable a boolean - {@code true} to enable tethering
2761 * @return error a {@code TETHER_ERROR} value indicating success or failure type
markchien10ddd022020-01-20 19:31:56 +08002762 * @deprecated Use {@link TetheringManager#startTethering} instead
Robert Greenwalt26744a52013-02-15 10:56:35 -08002763 *
Mike Lockwooded4a1742011-07-19 13:04:47 -07002764 * {@hide}
2765 */
Mathew Inwood0b8f8612018-08-08 14:52:47 +01002766 @UnsupportedAppUsage
markchien10ddd022020-01-20 19:31:56 +08002767 @Deprecated
Mike Lockwooded4a1742011-07-19 13:04:47 -07002768 public int setUsbTethering(boolean enable) {
Automerger Merge Worker9b0c0c62020-03-06 00:38:43 +00002769 return mTetheringManager.setUsbTethering(enable);
Mike Lockwooded4a1742011-07-19 13:04:47 -07002770 }
2771
markchien75721e42020-01-21 13:11:06 +08002772 /**
2773 * @deprecated Use {@link TetheringManager#TETHER_ERROR_NO_ERROR}.
2774 * {@hide}
2775 */
markchien5bd499c2019-01-16 17:44:13 +08002776 @SystemApi
markchien75721e42020-01-21 13:11:06 +08002777 @Deprecated
Remi NGUYEN VAN23b853b2021-02-15 18:52:06 +09002778 public static final int TETHER_ERROR_NO_ERROR = 0;
markchien75721e42020-01-21 13:11:06 +08002779 /**
2780 * @deprecated Use {@link TetheringManager#TETHER_ERROR_UNKNOWN_IFACE}.
2781 * {@hide}
2782 */
2783 @Deprecated
2784 public static final int TETHER_ERROR_UNKNOWN_IFACE =
2785 TetheringManager.TETHER_ERROR_UNKNOWN_IFACE;
2786 /**
2787 * @deprecated Use {@link TetheringManager#TETHER_ERROR_SERVICE_UNAVAIL}.
2788 * {@hide}
2789 */
2790 @Deprecated
2791 public static final int TETHER_ERROR_SERVICE_UNAVAIL =
2792 TetheringManager.TETHER_ERROR_SERVICE_UNAVAIL;
2793 /**
2794 * @deprecated Use {@link TetheringManager#TETHER_ERROR_UNSUPPORTED}.
2795 * {@hide}
2796 */
2797 @Deprecated
2798 public static final int TETHER_ERROR_UNSUPPORTED = TetheringManager.TETHER_ERROR_UNSUPPORTED;
2799 /**
2800 * @deprecated Use {@link TetheringManager#TETHER_ERROR_UNAVAIL_IFACE}.
2801 * {@hide}
2802 */
2803 @Deprecated
2804 public static final int TETHER_ERROR_UNAVAIL_IFACE =
2805 TetheringManager.TETHER_ERROR_UNAVAIL_IFACE;
2806 /**
markchien68b67842020-03-19 13:37:43 +08002807 * @deprecated Use {@link TetheringManager#TETHER_ERROR_INTERNAL_ERROR}.
markchien75721e42020-01-21 13:11:06 +08002808 * {@hide}
2809 */
2810 @Deprecated
markchien68b67842020-03-19 13:37:43 +08002811 public static final int TETHER_ERROR_MASTER_ERROR =
2812 TetheringManager.TETHER_ERROR_INTERNAL_ERROR;
markchien75721e42020-01-21 13:11:06 +08002813 /**
2814 * @deprecated Use {@link TetheringManager#TETHER_ERROR_TETHER_IFACE_ERROR}.
2815 * {@hide}
2816 */
2817 @Deprecated
2818 public static final int TETHER_ERROR_TETHER_IFACE_ERROR =
2819 TetheringManager.TETHER_ERROR_TETHER_IFACE_ERROR;
2820 /**
2821 * @deprecated Use {@link TetheringManager#TETHER_ERROR_UNTETHER_IFACE_ERROR}.
2822 * {@hide}
2823 */
2824 @Deprecated
2825 public static final int TETHER_ERROR_UNTETHER_IFACE_ERROR =
2826 TetheringManager.TETHER_ERROR_UNTETHER_IFACE_ERROR;
2827 /**
markchien68b67842020-03-19 13:37:43 +08002828 * @deprecated Use {@link TetheringManager#TETHER_ERROR_ENABLE_FORWARDING_ERROR}.
markchien75721e42020-01-21 13:11:06 +08002829 * {@hide}
2830 */
2831 @Deprecated
2832 public static final int TETHER_ERROR_ENABLE_NAT_ERROR =
markchien68b67842020-03-19 13:37:43 +08002833 TetheringManager.TETHER_ERROR_ENABLE_FORWARDING_ERROR;
markchien75721e42020-01-21 13:11:06 +08002834 /**
markchien68b67842020-03-19 13:37:43 +08002835 * @deprecated Use {@link TetheringManager#TETHER_ERROR_DISABLE_FORWARDING_ERROR}.
markchien75721e42020-01-21 13:11:06 +08002836 * {@hide}
2837 */
2838 @Deprecated
2839 public static final int TETHER_ERROR_DISABLE_NAT_ERROR =
markchien68b67842020-03-19 13:37:43 +08002840 TetheringManager.TETHER_ERROR_DISABLE_FORWARDING_ERROR;
markchien75721e42020-01-21 13:11:06 +08002841 /**
2842 * @deprecated Use {@link TetheringManager#TETHER_ERROR_IFACE_CFG_ERROR}.
2843 * {@hide}
2844 */
2845 @Deprecated
2846 public static final int TETHER_ERROR_IFACE_CFG_ERROR =
2847 TetheringManager.TETHER_ERROR_IFACE_CFG_ERROR;
2848 /**
markchien68b67842020-03-19 13:37:43 +08002849 * @deprecated Use {@link TetheringManager#TETHER_ERROR_PROVISIONING_FAILED}.
markchien75721e42020-01-21 13:11:06 +08002850 * {@hide}
2851 */
markchien5bd499c2019-01-16 17:44:13 +08002852 @SystemApi
markchien75721e42020-01-21 13:11:06 +08002853 @Deprecated
Remi NGUYEN VAN23b853b2021-02-15 18:52:06 +09002854 public static final int TETHER_ERROR_PROVISION_FAILED = 11;
markchien75721e42020-01-21 13:11:06 +08002855 /**
2856 * @deprecated Use {@link TetheringManager#TETHER_ERROR_DHCPSERVER_ERROR}.
2857 * {@hide}
2858 */
2859 @Deprecated
2860 public static final int TETHER_ERROR_DHCPSERVER_ERROR =
2861 TetheringManager.TETHER_ERROR_DHCPSERVER_ERROR;
2862 /**
2863 * @deprecated Use {@link TetheringManager#TETHER_ERROR_ENTITLEMENT_UNKNOWN}.
2864 * {@hide}
2865 */
markchien5bd499c2019-01-16 17:44:13 +08002866 @SystemApi
markchien75721e42020-01-21 13:11:06 +08002867 @Deprecated
Remi NGUYEN VAN23b853b2021-02-15 18:52:06 +09002868 public static final int TETHER_ERROR_ENTITLEMENT_UNKONWN = 13;
Robert Greenwalt4283ded2010-03-02 17:25:02 -08002869
2870 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -08002871 * Get a more detailed error code after a Tethering or Untethering
2872 * request asynchronously failed.
2873 *
2874 * @param iface The name of the interface of interest
Robert Greenwalt4283ded2010-03-02 17:25:02 -08002875 * @return error The error code of the last error tethering or untethering the named
2876 * interface
Robert Greenwalt26744a52013-02-15 10:56:35 -08002877 *
markchien75721e42020-01-21 13:11:06 +08002878 * @deprecated Use {@link TetheringEventCallback#onError(String, int)} instead.
Robert Greenwalt4283ded2010-03-02 17:25:02 -08002879 * {@hide}
2880 */
Jeff Sharkey2ac62992017-04-24 11:18:03 -06002881 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Mathew Inwoodd078d3d2020-10-27 11:47:29 +00002882 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
markchien75721e42020-01-21 13:11:06 +08002883 @Deprecated
Robert Greenwalt4283ded2010-03-02 17:25:02 -08002884 public int getLastTetherError(String iface) {
markchien68b67842020-03-19 13:37:43 +08002885 int error = mTetheringManager.getLastTetherError(iface);
2886 if (error == TetheringManager.TETHER_ERROR_UNKNOWN_TYPE) {
2887 // TETHER_ERROR_UNKNOWN_TYPE was introduced with TetheringManager and has never been
2888 // returned by ConnectivityManager. Convert it to the legacy TETHER_ERROR_UNKNOWN_IFACE
2889 // instead.
2890 error = TetheringManager.TETHER_ERROR_UNKNOWN_IFACE;
2891 }
2892 return error;
Robert Greenwalt93dc1042010-06-15 12:19:37 -07002893 }
2894
markchiendd41c822019-03-06 16:25:00 +08002895 /** @hide */
2896 @Retention(RetentionPolicy.SOURCE)
2897 @IntDef(value = {
2898 TETHER_ERROR_NO_ERROR,
2899 TETHER_ERROR_PROVISION_FAILED,
2900 TETHER_ERROR_ENTITLEMENT_UNKONWN,
2901 })
2902 public @interface EntitlementResultCode {
2903 }
2904
Robert Greenwalt93dc1042010-06-15 12:19:37 -07002905 /**
markchiendd41c822019-03-06 16:25:00 +08002906 * Callback for use with {@link #getLatestTetheringEntitlementResult} to find out whether
markchien5bd499c2019-01-16 17:44:13 +08002907 * entitlement succeeded.
markchien75721e42020-01-21 13:11:06 +08002908 *
2909 * @deprecated Use {@link TetheringManager#OnTetheringEntitlementResultListener} instead.
markchien5bd499c2019-01-16 17:44:13 +08002910 * @hide
2911 */
2912 @SystemApi
markchien75721e42020-01-21 13:11:06 +08002913 @Deprecated
markchiendd41c822019-03-06 16:25:00 +08002914 public interface OnTetheringEntitlementResultListener {
2915 /**
2916 * Called to notify entitlement result.
2917 *
2918 * @param resultCode an int value of entitlement result. It may be one of
2919 * {@link #TETHER_ERROR_NO_ERROR},
2920 * {@link #TETHER_ERROR_PROVISION_FAILED}, or
2921 * {@link #TETHER_ERROR_ENTITLEMENT_UNKONWN}.
2922 */
Jeremy Kleina9aad902019-03-12 13:32:08 -07002923 void onTetheringEntitlementResult(@EntitlementResultCode int resultCode);
markchiendd41c822019-03-06 16:25:00 +08002924 }
2925
2926 /**
markchien5bd499c2019-01-16 17:44:13 +08002927 * Get the last value of the entitlement check on this downstream. If the cached value is
2928 * {@link #TETHER_ERROR_NO_ERROR} or showEntitlementUi argument is false, it just return the
2929 * cached value. Otherwise, a UI-based entitlement check would be performed. It is not
2930 * guaranteed that the UI-based entitlement check will complete in any specific time period
2931 * and may in fact never complete. Any successful entitlement check the platform performs for
2932 * any reason will update the cached value.
2933 *
2934 * @param type the downstream type of tethering. Must be one of
2935 * {@link #TETHERING_WIFI},
2936 * {@link #TETHERING_USB}, or
2937 * {@link #TETHERING_BLUETOOTH}.
2938 * @param showEntitlementUi a boolean indicating whether to run UI-based entitlement check.
markchiendd41c822019-03-06 16:25:00 +08002939 * @param executor the executor on which callback will be invoked.
2940 * @param listener an {@link OnTetheringEntitlementResultListener} which will be called to
2941 * notify the caller of the result of entitlement check. The listener may be called zero
2942 * or one time.
markchien75721e42020-01-21 13:11:06 +08002943 * @deprecated Use {@link TetheringManager#requestLatestTetheringEntitlementResult} instead.
markchien5bd499c2019-01-16 17:44:13 +08002944 * {@hide}
2945 */
2946 @SystemApi
markchien75721e42020-01-21 13:11:06 +08002947 @Deprecated
markchien5bd499c2019-01-16 17:44:13 +08002948 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
markchiendd41c822019-03-06 16:25:00 +08002949 public void getLatestTetheringEntitlementResult(int type, boolean showEntitlementUi,
2950 @NonNull @CallbackExecutor Executor executor,
2951 @NonNull final OnTetheringEntitlementResultListener listener) {
Remi NGUYEN VANc4dd8c92021-03-15 07:31:54 +00002952 Objects.requireNonNull(listener, "TetheringEntitlementResultListener cannot be null.");
markchiendd41c822019-03-06 16:25:00 +08002953 ResultReceiver wrappedListener = new ResultReceiver(null) {
2954 @Override
2955 protected void onReceiveResult(int resultCode, Bundle resultData) {
lucaslin9cc04192021-03-04 09:38:21 +08002956 final long token = Binder.clearCallingIdentity();
2957 try {
2958 executor.execute(() -> {
2959 listener.onTetheringEntitlementResult(resultCode);
2960 });
2961 } finally {
2962 Binder.restoreCallingIdentity(token);
2963 }
markchiendd41c822019-03-06 16:25:00 +08002964 }
2965 };
2966
Automerger Merge Worker9b0c0c62020-03-06 00:38:43 +00002967 mTetheringManager.requestLatestTetheringEntitlementResult(type, wrappedListener,
markchienb0bb7862019-12-16 20:15:20 +08002968 showEntitlementUi);
markchiendd41c822019-03-06 16:25:00 +08002969 }
2970
2971 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -08002972 * Report network connectivity status. This is currently used only
2973 * to alter status bar UI.
Paul Jensen19b3ee72015-05-06 11:10:18 -04002974 * <p>This method requires the caller to hold the permission
2975 * {@link android.Manifest.permission#STATUS_BAR}.
Robert Greenwalt26744a52013-02-15 10:56:35 -08002976 *
Robert Greenwalt986c7412010-09-08 15:24:47 -07002977 * @param networkType The type of network you want to report on
2978 * @param percentage The quality of the connection 0 is bad, 100 is good
Chalard Jean5acb7b72018-03-08 13:54:53 +09002979 * @deprecated Types are deprecated. Use {@link #reportNetworkConnectivity} instead.
Robert Greenwalt986c7412010-09-08 15:24:47 -07002980 * {@hide}
2981 */
2982 public void reportInetCondition(int networkType, int percentage) {
Soi, Yoshinari99efcbd2015-11-12 12:09:02 +09002983 printStackTrace();
Robert Greenwalt986c7412010-09-08 15:24:47 -07002984 try {
2985 mService.reportInetCondition(networkType, percentage);
2986 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07002987 throw e.rethrowFromSystemServer();
Robert Greenwalt986c7412010-09-08 15:24:47 -07002988 }
2989 }
Robert Greenwaltc3c5f862010-10-11 16:00:27 -07002990
2991 /**
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07002992 * Report a problem network to the framework. This provides a hint to the system
Ye Wen849c72a2014-07-21 14:19:01 -07002993 * that there might be connectivity problems on this network and may cause
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07002994 * the framework to re-evaluate network connectivity and/or switch to another
2995 * network.
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07002996 *
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07002997 * @param network The {@link Network} the application was attempting to use
2998 * or {@code null} to indicate the current default network.
Paul Jensen7aac1b32015-04-07 12:43:13 -04002999 * @deprecated Use {@link #reportNetworkConnectivity} which allows reporting both
3000 * working and non-working connectivity.
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003001 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -07003002 @Deprecated
Chalard Jean42a9c292019-01-07 19:26:34 +09003003 public void reportBadNetwork(@Nullable Network network) {
Soi, Yoshinari99efcbd2015-11-12 12:09:02 +09003004 printStackTrace();
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003005 try {
Paul Jensen7aac1b32015-04-07 12:43:13 -04003006 // One of these will be ignored because it matches system's current state.
3007 // The other will trigger the necessary reevaluation.
3008 mService.reportNetworkConnectivity(network, true);
3009 mService.reportNetworkConnectivity(network, false);
3010 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07003011 throw e.rethrowFromSystemServer();
Paul Jensen7aac1b32015-04-07 12:43:13 -04003012 }
3013 }
3014
3015 /**
3016 * Report to the framework whether a network has working connectivity.
3017 * This provides a hint to the system that a particular network is providing
3018 * working connectivity or not. In response the framework may re-evaluate
3019 * the network's connectivity and might take further action thereafter.
3020 *
3021 * @param network The {@link Network} the application was attempting to use
3022 * or {@code null} to indicate the current default network.
3023 * @param hasConnectivity {@code true} if the application was able to successfully access the
3024 * Internet using {@code network} or {@code false} if not.
3025 */
Chalard Jean42a9c292019-01-07 19:26:34 +09003026 public void reportNetworkConnectivity(@Nullable Network network, boolean hasConnectivity) {
Soi, Yoshinari99efcbd2015-11-12 12:09:02 +09003027 printStackTrace();
Paul Jensen7aac1b32015-04-07 12:43:13 -04003028 try {
3029 mService.reportNetworkConnectivity(network, hasConnectivity);
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003030 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07003031 throw e.rethrowFromSystemServer();
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003032 }
3033 }
3034
3035 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -08003036 * Set a network-independent global http proxy. This is not normally what you want
3037 * for typical HTTP proxies - they are general network dependent. However if you're
3038 * doing something unusual like general internal filtering this may be useful. On
3039 * a private network where the proxy is not accessible, you may break HTTP using this.
Paul Jensen19b3ee72015-05-06 11:10:18 -04003040 *
3041 * @param p A {@link ProxyInfo} object defining the new global
3042 * HTTP proxy. A {@code null} value will clear the global HTTP proxy.
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07003043 * @hide
Robert Greenwaltc3c5f862010-10-11 16:00:27 -07003044 */
Chiachang Wang0cefc1c2021-03-18 09:44:34 +08003045 @SystemApi(client = MODULE_LIBRARIES)
paulhuec0a9632019-08-12 16:25:11 +08003046 @RequiresPermission(android.Manifest.permission.NETWORK_STACK)
Chiachang Wang0cefc1c2021-03-18 09:44:34 +08003047 public void setGlobalProxy(@Nullable ProxyInfo p) {
Robert Greenwaltc3c5f862010-10-11 16:00:27 -07003048 try {
3049 mService.setGlobalProxy(p);
3050 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07003051 throw e.rethrowFromSystemServer();
Robert Greenwaltc3c5f862010-10-11 16:00:27 -07003052 }
3053 }
3054
3055 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -08003056 * Retrieve any network-independent global HTTP proxy.
3057 *
Jason Monk1e3df5d2014-04-25 15:00:09 -04003058 * @return {@link ProxyInfo} for the current global HTTP proxy or {@code null}
Robert Greenwalt26744a52013-02-15 10:56:35 -08003059 * if no global HTTP proxy is set.
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07003060 * @hide
Robert Greenwaltc3c5f862010-10-11 16:00:27 -07003061 */
Chiachang Wang0cefc1c2021-03-18 09:44:34 +08003062 @SystemApi(client = MODULE_LIBRARIES)
3063 @Nullable
Jason Monk1e3df5d2014-04-25 15:00:09 -04003064 public ProxyInfo getGlobalProxy() {
Robert Greenwaltc3c5f862010-10-11 16:00:27 -07003065 try {
3066 return mService.getGlobalProxy();
3067 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07003068 throw e.rethrowFromSystemServer();
Robert Greenwaltc3c5f862010-10-11 16:00:27 -07003069 }
3070 }
3071
3072 /**
Paul Jensenfdec88b2015-05-06 07:32:40 -04003073 * Retrieve the global HTTP proxy, or if no global HTTP proxy is set, a
3074 * network-specific HTTP proxy. If {@code network} is null, the
3075 * network-specific proxy returned is the proxy of the default active
3076 * network.
3077 *
3078 * @return {@link ProxyInfo} for the current global HTTP proxy, or if no
3079 * global HTTP proxy is set, {@code ProxyInfo} for {@code network},
3080 * or when {@code network} is {@code null},
3081 * the {@code ProxyInfo} for the default active network. Returns
3082 * {@code null} when no proxy applies or the caller doesn't have
3083 * permission to use {@code network}.
3084 * @hide
3085 */
3086 public ProxyInfo getProxyForNetwork(Network network) {
3087 try {
3088 return mService.getProxyForNetwork(network);
3089 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07003090 throw e.rethrowFromSystemServer();
Paul Jensenfdec88b2015-05-06 07:32:40 -04003091 }
3092 }
3093
3094 /**
Paul Jensen12131352014-12-10 15:12:18 -05003095 * Get the current default HTTP proxy settings. If a global proxy is set it will be returned,
3096 * otherwise if this process is bound to a {@link Network} using
Paul Jensen895c3942015-03-10 10:54:12 -04003097 * {@link #bindProcessToNetwork} then that {@code Network}'s proxy is returned, otherwise
Paul Jensen12131352014-12-10 15:12:18 -05003098 * the default network's proxy is returned.
Robert Greenwalt26744a52013-02-15 10:56:35 -08003099 *
Jason Monk1e3df5d2014-04-25 15:00:09 -04003100 * @return the {@link ProxyInfo} for the current HTTP proxy, or {@code null} if no
Robert Greenwalt26744a52013-02-15 10:56:35 -08003101 * HTTP proxy is active.
Robert Greenwaltc3c5f862010-10-11 16:00:27 -07003102 */
Chalard Jean42a9c292019-01-07 19:26:34 +09003103 @Nullable
Paul Jensen12131352014-12-10 15:12:18 -05003104 public ProxyInfo getDefaultProxy() {
Paul Jensenfdec88b2015-05-06 07:32:40 -04003105 return getProxyForNetwork(getBoundNetworkForProcess());
Robert Greenwaltc3c5f862010-10-11 16:00:27 -07003106 }
Robert Greenwalt34848c02011-03-25 13:09:25 -07003107
3108 /**
Robert Greenwalt0114f6e2011-08-31 11:46:42 -07003109 * Returns true if the hardware supports the given network type
3110 * else it returns false. This doesn't indicate we have coverage
3111 * or are authorized onto a network, just whether or not the
Robert Greenwalt26744a52013-02-15 10:56:35 -08003112 * hardware supports it. For example a GSM phone without a SIM
3113 * should still return {@code true} for mobile data, but a wifi only
3114 * tablet would return {@code false}.
3115 *
3116 * @param networkType The network type we'd like to check
3117 * @return {@code true} if supported, else {@code false}
Chalard Jean5acb7b72018-03-08 13:54:53 +09003118 * @deprecated Types are deprecated. Use {@link NetworkCapabilities} instead.
Robert Greenwalt0114f6e2011-08-31 11:46:42 -07003119 * @hide
3120 */
Chalard Jean5acb7b72018-03-08 13:54:53 +09003121 @Deprecated
Jeff Sharkey2ac62992017-04-24 11:18:03 -06003122 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jeanaa91c9d2019-04-09 15:46:21 +09003123 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 130143562)
Robert Greenwalt0114f6e2011-08-31 11:46:42 -07003124 public boolean isNetworkSupported(int networkType) {
3125 try {
3126 return mService.isNetworkSupported(networkType);
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07003127 } catch (RemoteException e) {
3128 throw e.rethrowFromSystemServer();
3129 }
Robert Greenwalt0114f6e2011-08-31 11:46:42 -07003130 }
Jeff Sharkeyd00b1302012-04-12 18:34:54 -07003131
3132 /**
3133 * Returns if the currently active data network is metered. A network is
3134 * classified as metered when the user is sensitive to heavy data usage on
Robert Greenwalt26744a52013-02-15 10:56:35 -08003135 * that connection due to monetary costs, data limitations or
3136 * battery/performance issues. You should check this before doing large
3137 * data transfers, and warn the user or delay the operation until another
3138 * network is available.
3139 *
3140 * @return {@code true} if large transfers should be avoided, otherwise
3141 * {@code false}.
Jeff Sharkeyd00b1302012-04-12 18:34:54 -07003142 */
Jeff Sharkey2ac62992017-04-24 11:18:03 -06003143 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Jeff Sharkeyd00b1302012-04-12 18:34:54 -07003144 public boolean isActiveNetworkMetered() {
3145 try {
3146 return mService.isActiveNetworkMetered();
3147 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07003148 throw e.rethrowFromSystemServer();
Jeff Sharkeyd00b1302012-04-12 18:34:54 -07003149 }
3150 }
Jeff Sharkeyf2e722a2012-08-25 00:05:46 -07003151
Robert Greenwalt26744a52013-02-15 10:56:35 -08003152 /**
Sarah Chincab74db2020-11-25 12:15:14 -08003153 * Set sign in error notification to visible or invisible
Wink Saville89c87b92013-08-29 08:55:16 -07003154 *
Sarah Chincab74db2020-11-25 12:15:14 -08003155 * @hide
Paul Jensena8e6dc62015-03-18 12:23:02 -04003156 * @deprecated Doesn't properly deal with multiple connected networks of the same type.
Wink Saville89c87b92013-08-29 08:55:16 -07003157 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -07003158 @Deprecated
Wink Saville89c87b92013-08-29 08:55:16 -07003159 public void setProvisioningNotificationVisible(boolean visible, int networkType,
Paul Jensen82c7e422014-09-15 15:59:36 -04003160 String action) {
Wink Saville89c87b92013-08-29 08:55:16 -07003161 try {
Paul Jensen82c7e422014-09-15 15:59:36 -04003162 mService.setProvisioningNotificationVisible(visible, networkType, action);
Wink Saville89c87b92013-08-29 08:55:16 -07003163 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07003164 throw e.rethrowFromSystemServer();
Wink Saville89c87b92013-08-29 08:55:16 -07003165 }
3166 }
Yuhao Zheng15019892013-09-09 17:00:04 -07003167
3168 /**
3169 * Set the value for enabling/disabling airplane mode
3170 *
3171 * @param enable whether to enable airplane mode or not
3172 *
Yuhao Zheng15019892013-09-09 17:00:04 -07003173 * @hide
3174 */
Lorenzo Colittic4d01862018-10-09 18:55:11 +09003175 @RequiresPermission(anyOf = {
Edward Savage-Jones3b9fe322019-11-26 13:18:08 +01003176 android.Manifest.permission.NETWORK_AIRPLANE_MODE,
Lorenzo Colittic4d01862018-10-09 18:55:11 +09003177 android.Manifest.permission.NETWORK_SETTINGS,
3178 android.Manifest.permission.NETWORK_SETUP_WIZARD,
3179 android.Manifest.permission.NETWORK_STACK})
Lorenzo Colitti272a77d2018-10-09 18:50:32 +09003180 @SystemApi
Yuhao Zheng15019892013-09-09 17:00:04 -07003181 public void setAirplaneMode(boolean enable) {
3182 try {
3183 mService.setAirplaneMode(enable);
3184 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07003185 throw e.rethrowFromSystemServer();
Yuhao Zheng15019892013-09-09 17:00:04 -07003186 }
3187 }
Robert Greenwalt948aea52014-04-11 15:53:27 -07003188
Lorenzo Colitti92e6c272020-01-08 00:04:09 +09003189 /**
3190 * Registers the specified {@link NetworkProvider}.
3191 * Each listener must only be registered once. The listener can be unregistered with
3192 * {@link #unregisterNetworkProvider}.
3193 *
3194 * @param provider the provider to register
3195 * @return the ID of the provider. This ID must be used by the provider when registering
3196 * {@link android.net.NetworkAgent}s.
3197 * @hide
3198 */
3199 @SystemApi
Automerger Merge Workeref12b642020-03-04 18:04:01 +00003200 @RequiresPermission(anyOf = {
3201 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
3202 android.Manifest.permission.NETWORK_FACTORY})
Lorenzo Colitti92e6c272020-01-08 00:04:09 +09003203 public int registerNetworkProvider(@NonNull NetworkProvider provider) {
3204 if (provider.getProviderId() != NetworkProvider.ID_NONE) {
Lorenzo Colitti92e6c272020-01-08 00:04:09 +09003205 throw new IllegalStateException("NetworkProviders can only be registered once");
3206 }
3207
3208 try {
3209 int providerId = mService.registerNetworkProvider(provider.getMessenger(),
3210 provider.getName());
3211 provider.setProviderId(providerId);
3212 } catch (RemoteException e) {
3213 throw e.rethrowFromSystemServer();
3214 }
3215 return provider.getProviderId();
3216 }
3217
3218 /**
3219 * Unregisters the specified NetworkProvider.
3220 *
3221 * @param provider the provider to unregister
3222 * @hide
3223 */
3224 @SystemApi
Automerger Merge Workeref12b642020-03-04 18:04:01 +00003225 @RequiresPermission(anyOf = {
3226 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
3227 android.Manifest.permission.NETWORK_FACTORY})
Lorenzo Colitti92e6c272020-01-08 00:04:09 +09003228 public void unregisterNetworkProvider(@NonNull NetworkProvider provider) {
3229 try {
3230 mService.unregisterNetworkProvider(provider.getMessenger());
3231 } catch (RemoteException e) {
3232 throw e.rethrowFromSystemServer();
3233 }
3234 provider.setProviderId(NetworkProvider.ID_NONE);
3235 }
3236
Chalard Jean1ef1d902021-01-05 08:40:09 +09003237 /**
3238 * Register or update a network offer with ConnectivityService.
3239 *
3240 * ConnectivityService keeps track of offers made by the various providers and matches
3241 * them to networking requests made by apps or the system. The provider supplies a score
3242 * and the capabilities of the network it might be able to bring up ; these act as filters
3243 * used by ConnectivityService to only send those requests that can be fulfilled by the
3244 * provider.
3245 *
3246 * The provider is under no obligation to be able to bring up the network it offers at any
3247 * given time. Instead, this mechanism is meant to limit requests received by providers
3248 * to those they actually have a chance to fulfill, as providers don't have a way to compare
3249 * the quality of the network satisfying a given request to their own offer.
3250 *
3251 * An offer can be updated by calling this again with the same callback object. This is
3252 * similar to calling unofferNetwork and offerNetwork again, but will only update the
3253 * provider with the changes caused by the changes in the offer.
3254 *
3255 * @param provider The provider making this offer.
3256 * @param score The prospective score of the network.
3257 * @param caps The prospective capabilities of the network.
3258 * @param callback The callback to call when this offer is needed or unneeded.
3259 * @hide
3260 */
3261 @RequiresPermission(anyOf = {
3262 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
3263 android.Manifest.permission.NETWORK_FACTORY})
Chalard Jeanb004da52021-03-22 22:44:02 +09003264 public void offerNetwork(@NonNull final int providerId,
Chalard Jean1ef1d902021-01-05 08:40:09 +09003265 @NonNull final NetworkScore score, @NonNull final NetworkCapabilities caps,
3266 @NonNull final INetworkOfferCallback callback) {
3267 try {
Chalard Jeanb004da52021-03-22 22:44:02 +09003268 mService.offerNetwork(providerId,
Chalard Jean1ef1d902021-01-05 08:40:09 +09003269 Objects.requireNonNull(score, "null score"),
3270 Objects.requireNonNull(caps, "null caps"),
3271 Objects.requireNonNull(callback, "null callback"));
3272 } catch (RemoteException e) {
3273 throw e.rethrowFromSystemServer();
3274 }
3275 }
Lorenzo Colitti92e6c272020-01-08 00:04:09 +09003276
Chalard Jean1ef1d902021-01-05 08:40:09 +09003277 /**
3278 * Withdraw a network offer made with {@link #offerNetwork}.
3279 *
3280 * @param callback The callback passed at registration time. This must be the same object
3281 * that was passed to {@link #offerNetwork}
3282 * @hide
3283 */
3284 public void unofferNetwork(@NonNull final INetworkOfferCallback callback) {
3285 try {
3286 mService.unofferNetwork(Objects.requireNonNull(callback));
3287 } catch (RemoteException e) {
3288 throw e.rethrowFromSystemServer();
3289 }
3290 }
Lorenzo Colitti92e6c272020-01-08 00:04:09 +09003291 /** @hide exposed via the NetworkProvider class. */
Automerger Merge Workeref12b642020-03-04 18:04:01 +00003292 @RequiresPermission(anyOf = {
3293 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
3294 android.Manifest.permission.NETWORK_FACTORY})
Lorenzo Colitti92e6c272020-01-08 00:04:09 +09003295 public void declareNetworkRequestUnfulfillable(@NonNull NetworkRequest request) {
3296 try {
3297 mService.declareNetworkRequestUnfulfillable(request);
3298 } catch (RemoteException e) {
3299 throw e.rethrowFromSystemServer();
3300 }
3301 }
3302
Paul Jensenc2569432015-02-13 14:18:39 -05003303 /**
3304 * @hide
3305 * Register a NetworkAgent with ConnectivityService.
Chalard Jean1aea87a2019-12-13 19:47:12 +09003306 * @return Network corresponding to NetworkAgent.
Paul Jensenc2569432015-02-13 14:18:39 -05003307 */
Automerger Merge Workeref12b642020-03-04 18:04:01 +00003308 @RequiresPermission(anyOf = {
3309 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
3310 android.Manifest.permission.NETWORK_FACTORY})
Remi NGUYEN VAN37ebfa82020-12-23 12:45:08 +09003311 public Network registerNetworkAgent(INetworkAgent na, NetworkInfo ni, LinkProperties lp,
Chalard Jeandd753522020-12-21 18:36:52 +09003312 NetworkCapabilities nc, @NonNull NetworkScore score, NetworkAgentConfig config,
3313 int providerId) {
Robert Greenwaltdb6fac52014-04-18 15:25:25 -07003314 try {
Remi NGUYEN VAN37ebfa82020-12-23 12:45:08 +09003315 return mService.registerNetworkAgent(na, ni, lp, nc, score, config, providerId);
Paul Jensenc2569432015-02-13 14:18:39 -05003316 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07003317 throw e.rethrowFromSystemServer();
Paul Jensenc2569432015-02-13 14:18:39 -05003318 }
Robert Greenwaltdb6fac52014-04-18 15:25:25 -07003319 }
3320
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003321 /**
Hugo Benichi45a49542017-03-06 09:17:06 +09003322 * Base class for {@code NetworkRequest} callbacks. Used for notifications about network
3323 * changes. Should be extended by applications wanting notifications.
3324 *
3325 * A {@code NetworkCallback} is registered by calling
3326 * {@link #requestNetwork(NetworkRequest, NetworkCallback)},
3327 * {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)},
Hugo Benichi7665a142018-02-07 21:17:43 +09003328 * or {@link #registerDefaultNetworkCallback(NetworkCallback)}. A {@code NetworkCallback} is
Hugo Benichi45a49542017-03-06 09:17:06 +09003329 * unregistered by calling {@link #unregisterNetworkCallback(NetworkCallback)}.
3330 * A {@code NetworkCallback} should be registered at most once at any time.
3331 * A {@code NetworkCallback} that has been unregistered can be registered again.
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003332 */
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07003333 public static class NetworkCallback {
Robert Greenwaltdb6fac52014-04-18 15:25:25 -07003334 /**
Roshan Pius7992afd2020-12-22 15:10:42 -08003335 * No flags associated with this callback.
3336 * @hide
3337 */
3338 public static final int FLAG_NONE = 0;
3339 /**
3340 * Use this flag to include any location sensitive data in {@link NetworkCapabilities} sent
3341 * via {@link #onCapabilitiesChanged(Network, NetworkCapabilities)}.
3342 * <p>
3343 * These include:
3344 * <li> Some transport info instances (retrieved via
3345 * {@link NetworkCapabilities#getTransportInfo()}) like {@link android.net.wifi.WifiInfo}
3346 * contain location sensitive information.
3347 * <li> OwnerUid (retrieved via {@link NetworkCapabilities#getOwnerUid()} is location
3348 * sensitive for wifi suggestor apps (i.e using {@link WifiNetworkSuggestion}).</li>
3349 * </p>
3350 * <p>
3351 * Note:
3352 * <li> Retrieving this location sensitive information (subject to app's location
3353 * permissions) will be noted by system. </li>
3354 * <li> Without this flag any {@link NetworkCapabilities} provided via the callback does
3355 * not include location sensitive info.
3356 * </p>
3357 */
3358 public static final int FLAG_INCLUDE_LOCATION_INFO = 1 << 0;
3359
3360 /** @hide */
3361 @Retention(RetentionPolicy.SOURCE)
3362 @IntDef(flag = true, prefix = "FLAG_", value = {
3363 FLAG_NONE,
3364 FLAG_INCLUDE_LOCATION_INFO
3365 })
3366 public @interface Flag { }
3367
3368 /**
3369 * All the valid flags for error checking.
3370 */
3371 private static final int VALID_FLAGS = FLAG_INCLUDE_LOCATION_INFO;
3372
3373 public NetworkCallback() {
3374 this(FLAG_NONE);
3375 }
3376
3377 public NetworkCallback(@Flag int flags) {
Remi NGUYEN VANc4dd8c92021-03-15 07:31:54 +00003378 if ((flags & VALID_FLAGS) != flags) {
3379 throw new IllegalArgumentException("Invalid flags");
3380 }
Roshan Pius7992afd2020-12-22 15:10:42 -08003381 mFlags = flags;
3382 }
3383
3384 /**
Lorenzo Colitticcf82102015-04-24 12:23:24 +09003385 * Called when the framework connects to a new network to evaluate whether it satisfies this
3386 * request. If evaluation succeeds, this callback may be followed by an {@link #onAvailable}
3387 * callback. There is no guarantee that this new network will satisfy any requests, or that
3388 * the network will stay connected for longer than the time necessary to evaluate it.
3389 * <p>
3390 * Most applications <b>should not</b> act on this callback, and should instead use
3391 * {@link #onAvailable}. This callback is intended for use by applications that can assist
3392 * the framework in properly evaluating the network &mdash; for example, an application that
3393 * can automatically log in to a captive portal without user intervention.
3394 *
3395 * @param network The {@link Network} of the network that is being evaluated.
Lorenzo Colittia04936a2015-06-11 14:27:17 +09003396 *
3397 * @hide
Robert Greenwaltdb6fac52014-04-18 15:25:25 -07003398 */
paulhua9a6e2a2019-03-22 16:35:06 +08003399 public void onPreCheck(@NonNull Network network) {}
Robert Greenwaltdb6fac52014-04-18 15:25:25 -07003400
3401 /**
Lorenzo Colitticcf82102015-04-24 12:23:24 +09003402 * Called when the framework connects and has declared a new network ready for use.
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07003403 * This callback may be called more than once if the {@link Network} that is
3404 * satisfying the request changes.
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07003405 *
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07003406 * @param network The {@link Network} of the satisfying network.
Chalard Jeanb6a0c6d2018-01-30 22:41:41 +09003407 * @param networkCapabilities The {@link NetworkCapabilities} of the satisfying network.
3408 * @param linkProperties The {@link LinkProperties} of the satisfying network.
junyulai5ab727b2018-08-07 19:50:45 +08003409 * @param blocked Whether access to the {@link Network} is blocked due to system policy.
Chalard Jeanb6a0c6d2018-01-30 22:41:41 +09003410 * @hide
3411 */
paulhua9a6e2a2019-03-22 16:35:06 +08003412 public void onAvailable(@NonNull Network network,
3413 @NonNull NetworkCapabilities networkCapabilities,
3414 @NonNull LinkProperties linkProperties, boolean blocked) {
Chalard Jeanb6a0c6d2018-01-30 22:41:41 +09003415 // Internally only this method is called when a new network is available, and
3416 // it calls the callback in the same way and order that older versions used
3417 // to call so as not to change the behavior.
3418 onAvailable(network);
3419 if (!networkCapabilities.hasCapability(
3420 NetworkCapabilities.NET_CAPABILITY_NOT_SUSPENDED)) {
3421 onNetworkSuspended(network);
3422 }
3423 onCapabilitiesChanged(network, networkCapabilities);
3424 onLinkPropertiesChanged(network, linkProperties);
junyulai5ab727b2018-08-07 19:50:45 +08003425 onBlockedStatusChanged(network, blocked);
Chalard Jeanb6a0c6d2018-01-30 22:41:41 +09003426 }
3427
3428 /**
3429 * Called when the framework connects and has declared a new network ready for use.
Chalard Jean7f3a8742019-08-30 16:27:28 +09003430 *
3431 * <p>For callbacks registered with {@link #registerNetworkCallback}, multiple networks may
3432 * be available at the same time, and onAvailable will be called for each of these as they
3433 * appear.
3434 *
3435 * <p>For callbacks registered with {@link #requestNetwork} and
3436 * {@link #registerDefaultNetworkCallback}, this means the network passed as an argument
3437 * is the new best network for this request and is now tracked by this callback ; this
3438 * callback will no longer receive method calls about other networks that may have been
3439 * passed to this method previously. The previously-best network may have disconnected, or
3440 * it may still be around and the newly-best network may simply be better.
3441 *
3442 * <p>Starting with {@link android.os.Build.VERSION_CODES#O}, this will always immediately
3443 * be followed by a call to {@link #onCapabilitiesChanged(Network, NetworkCapabilities)}
3444 * then by a call to {@link #onLinkPropertiesChanged(Network, LinkProperties)}, and a call
3445 * to {@link #onBlockedStatusChanged(Network, boolean)}.
3446 *
3447 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
3448 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
3449 * this callback as this is prone to race conditions (there is no guarantee the objects
3450 * returned by these methods will be current). Instead, wait for a call to
3451 * {@link #onCapabilitiesChanged(Network, NetworkCapabilities)} and
3452 * {@link #onLinkPropertiesChanged(Network, LinkProperties)} whose arguments are guaranteed
3453 * to be well-ordered with respect to other callbacks.
Chalard Jeanb6a0c6d2018-01-30 22:41:41 +09003454 *
3455 * @param network The {@link Network} of the satisfying network.
Robert Greenwaltdb6fac52014-04-18 15:25:25 -07003456 */
paulhua9a6e2a2019-03-22 16:35:06 +08003457 public void onAvailable(@NonNull Network network) {}
Robert Greenwaltdb6fac52014-04-18 15:25:25 -07003458
3459 /**
Chalard Jean7f3a8742019-08-30 16:27:28 +09003460 * Called when the network is about to be lost, typically because there are no outstanding
3461 * requests left for it. This may be paired with a {@link NetworkCallback#onAvailable} call
3462 * with the new replacement network for graceful handover. This method is not guaranteed
3463 * to be called before {@link NetworkCallback#onLost} is called, for example in case a
3464 * network is suddenly disconnected.
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07003465 *
Chalard Jean7f3a8742019-08-30 16:27:28 +09003466 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
3467 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
3468 * this callback as this is prone to race conditions ; calling these methods while in a
3469 * callback may return an outdated or even a null object.
3470 *
3471 * @param network The {@link Network} that is about to be lost.
3472 * @param maxMsToLive The time in milliseconds the system intends to keep the network
3473 * connected for graceful handover; note that the network may still
3474 * suffer a hard loss at any time.
Robert Greenwaltdb6fac52014-04-18 15:25:25 -07003475 */
paulhua9a6e2a2019-03-22 16:35:06 +08003476 public void onLosing(@NonNull Network network, int maxMsToLive) {}
Robert Greenwaltdb6fac52014-04-18 15:25:25 -07003477
3478 /**
Chalard Jean7f3a8742019-08-30 16:27:28 +09003479 * Called when a network disconnects or otherwise no longer satisfies this request or
3480 * callback.
3481 *
3482 * <p>If the callback was registered with requestNetwork() or
3483 * registerDefaultNetworkCallback(), it will only be invoked against the last network
3484 * returned by onAvailable() when that network is lost and no other network satisfies
3485 * the criteria of the request.
3486 *
3487 * <p>If the callback was registered with registerNetworkCallback() it will be called for
3488 * each network which no longer satisfies the criteria of the callback.
3489 *
3490 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
3491 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
3492 * this callback as this is prone to race conditions ; calling these methods while in a
3493 * callback may return an outdated or even a null object.
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07003494 *
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07003495 * @param network The {@link Network} lost.
Robert Greenwaltdb6fac52014-04-18 15:25:25 -07003496 */
paulhua9a6e2a2019-03-22 16:35:06 +08003497 public void onLost(@NonNull Network network) {}
Robert Greenwaltdb6fac52014-04-18 15:25:25 -07003498
3499 /**
Chalard Jean7f3a8742019-08-30 16:27:28 +09003500 * Called if no network is found within the timeout time specified in
Etan Cohen06633de2019-01-08 12:09:18 -08003501 * {@link #requestNetwork(NetworkRequest, NetworkCallback, int)} call or if the
3502 * requested network request cannot be fulfilled (whether or not a timeout was
3503 * specified). When this callback is invoked the associated
Etan Cohen67e58a02017-03-01 12:47:28 -08003504 * {@link NetworkRequest} will have already been removed and released, as if
3505 * {@link #unregisterNetworkCallback(NetworkCallback)} had been called.
Robert Greenwaltdb6fac52014-04-18 15:25:25 -07003506 */
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07003507 public void onUnavailable() {}
Robert Greenwaltdb6fac52014-04-18 15:25:25 -07003508
3509 /**
Chalard Jean7f3a8742019-08-30 16:27:28 +09003510 * Called when the network corresponding to this request changes capabilities but still
3511 * satisfies the requested criteria.
3512 *
3513 * <p>Starting with {@link android.os.Build.VERSION_CODES#O} this method is guaranteed
3514 * to be called immediately after {@link #onAvailable}.
3515 *
3516 * <p>Do NOT call {@link #getLinkProperties(Network)} or other synchronous
3517 * ConnectivityManager methods in this callback as this is prone to race conditions :
3518 * calling these methods while in a callback may return an outdated or even a null object.
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07003519 *
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07003520 * @param network The {@link Network} whose capabilities have changed.
Roshan Pius7992afd2020-12-22 15:10:42 -08003521 * @param networkCapabilities The new {@link NetworkCapabilities} for this
Chalard Jeanb6a0c6d2018-01-30 22:41:41 +09003522 * network.
Robert Greenwaltdb6fac52014-04-18 15:25:25 -07003523 */
paulhua9a6e2a2019-03-22 16:35:06 +08003524 public void onCapabilitiesChanged(@NonNull Network network,
3525 @NonNull NetworkCapabilities networkCapabilities) {}
Robert Greenwaltdb6fac52014-04-18 15:25:25 -07003526
3527 /**
Chalard Jean7f3a8742019-08-30 16:27:28 +09003528 * Called when the network corresponding to this request changes {@link LinkProperties}.
3529 *
3530 * <p>Starting with {@link android.os.Build.VERSION_CODES#O} this method is guaranteed
3531 * to be called immediately after {@link #onAvailable}.
3532 *
3533 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or other synchronous
3534 * ConnectivityManager methods in this callback as this is prone to race conditions :
3535 * calling these methods while in a callback may return an outdated or even a null object.
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07003536 *
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07003537 * @param network The {@link Network} whose link properties have changed.
3538 * @param linkProperties The new {@link LinkProperties} for this network.
Robert Greenwaltdb6fac52014-04-18 15:25:25 -07003539 */
paulhua9a6e2a2019-03-22 16:35:06 +08003540 public void onLinkPropertiesChanged(@NonNull Network network,
3541 @NonNull LinkProperties linkProperties) {}
Robert Greenwaltdb6fac52014-04-18 15:25:25 -07003542
Robert Greenwalt41c19a02015-06-24 13:23:42 -07003543 /**
Chalard Jean7f3a8742019-08-30 16:27:28 +09003544 * Called when the network the framework connected to for this request suspends data
3545 * transmission temporarily.
3546 *
3547 * <p>This generally means that while the TCP connections are still live temporarily
3548 * network data fails to transfer. To give a specific example, this is used on cellular
3549 * networks to mask temporary outages when driving through a tunnel, etc. In general this
3550 * means read operations on sockets on this network will block once the buffers are
3551 * drained, and write operations will block once the buffers are full.
3552 *
3553 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
3554 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
3555 * this callback as this is prone to race conditions (there is no guarantee the objects
3556 * returned by these methods will be current).
3557 *
Robert Greenwalt41c19a02015-06-24 13:23:42 -07003558 * @hide
3559 */
paulhua9a6e2a2019-03-22 16:35:06 +08003560 public void onNetworkSuspended(@NonNull Network network) {}
Robert Greenwalt41c19a02015-06-24 13:23:42 -07003561
3562 /**
3563 * Called when the network the framework connected to for this request
Chalard Jeanb6a0c6d2018-01-30 22:41:41 +09003564 * returns from a {@link NetworkInfo.State#SUSPENDED} state. This should always be
3565 * preceded by a matching {@link NetworkCallback#onNetworkSuspended} call.
Chalard Jean7f3a8742019-08-30 16:27:28 +09003566
3567 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
3568 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
3569 * this callback as this is prone to race conditions : calling these methods while in a
3570 * callback may return an outdated or even a null object.
3571 *
Robert Greenwalt41c19a02015-06-24 13:23:42 -07003572 * @hide
3573 */
paulhua9a6e2a2019-03-22 16:35:06 +08003574 public void onNetworkResumed(@NonNull Network network) {}
Robert Greenwalt41c19a02015-06-24 13:23:42 -07003575
junyulai5ab727b2018-08-07 19:50:45 +08003576 /**
3577 * Called when access to the specified network is blocked or unblocked.
3578 *
Chalard Jean7f3a8742019-08-30 16:27:28 +09003579 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
3580 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
3581 * this callback as this is prone to race conditions : calling these methods while in a
3582 * callback may return an outdated or even a null object.
3583 *
junyulai5ab727b2018-08-07 19:50:45 +08003584 * @param network The {@link Network} whose blocked status has changed.
3585 * @param blocked The blocked status of this {@link Network}.
3586 */
junyulai61143782019-03-04 22:45:36 +08003587 public void onBlockedStatusChanged(@NonNull Network network, boolean blocked) {}
junyulai5ab727b2018-08-07 19:50:45 +08003588
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07003589 private NetworkRequest networkRequest;
Roshan Pius7992afd2020-12-22 15:10:42 -08003590 private final int mFlags;
Robert Greenwaltdb6fac52014-04-18 15:25:25 -07003591 }
3592
Hugo Benichi145e3792017-05-11 13:16:17 +09003593 /**
3594 * Constant error codes used by ConnectivityService to communicate about failures and errors
3595 * across a Binder boundary.
3596 * @hide
3597 */
3598 public interface Errors {
Chalard Jean73d9db72018-06-04 16:52:49 +09003599 int TOO_MANY_REQUESTS = 1;
Hugo Benichi145e3792017-05-11 13:16:17 +09003600 }
3601
3602 /** @hide */
3603 public static class TooManyRequestsException extends RuntimeException {}
3604
3605 private static RuntimeException convertServiceException(ServiceSpecificException e) {
3606 switch (e.errorCode) {
3607 case Errors.TOO_MANY_REQUESTS:
3608 return new TooManyRequestsException();
3609 default:
3610 Log.w(TAG, "Unknown service error code " + e.errorCode);
3611 return new RuntimeException(e);
3612 }
3613 }
3614
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003615 /** @hide */
Remi NGUYEN VANa711b3f2021-03-12 15:24:06 +09003616 public static final int CALLBACK_PRECHECK = 1;
Robert Greenwalt41c19a02015-06-24 13:23:42 -07003617 /** @hide */
Remi NGUYEN VANa711b3f2021-03-12 15:24:06 +09003618 public static final int CALLBACK_AVAILABLE = 2;
Robert Greenwalt41c19a02015-06-24 13:23:42 -07003619 /** @hide arg1 = TTL */
Remi NGUYEN VANa711b3f2021-03-12 15:24:06 +09003620 public static final int CALLBACK_LOSING = 3;
Robert Greenwalt41c19a02015-06-24 13:23:42 -07003621 /** @hide */
Remi NGUYEN VANa711b3f2021-03-12 15:24:06 +09003622 public static final int CALLBACK_LOST = 4;
Robert Greenwalt41c19a02015-06-24 13:23:42 -07003623 /** @hide */
Remi NGUYEN VANa711b3f2021-03-12 15:24:06 +09003624 public static final int CALLBACK_UNAVAIL = 5;
Robert Greenwalt41c19a02015-06-24 13:23:42 -07003625 /** @hide */
Remi NGUYEN VANa711b3f2021-03-12 15:24:06 +09003626 public static final int CALLBACK_CAP_CHANGED = 6;
Robert Greenwalt41c19a02015-06-24 13:23:42 -07003627 /** @hide */
Remi NGUYEN VANa711b3f2021-03-12 15:24:06 +09003628 public static final int CALLBACK_IP_CHANGED = 7;
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07003629 /** @hide obj = NetworkCapabilities, arg1 = seq number */
Remi NGUYEN VANa711b3f2021-03-12 15:24:06 +09003630 private static final int EXPIRE_LEGACY_REQUEST = 8;
Robert Greenwalt41c19a02015-06-24 13:23:42 -07003631 /** @hide */
Remi NGUYEN VANa711b3f2021-03-12 15:24:06 +09003632 public static final int CALLBACK_SUSPENDED = 9;
Robert Greenwalt41c19a02015-06-24 13:23:42 -07003633 /** @hide */
Remi NGUYEN VANa711b3f2021-03-12 15:24:06 +09003634 public static final int CALLBACK_RESUMED = 10;
junyulai5ab727b2018-08-07 19:50:45 +08003635 /** @hide */
Remi NGUYEN VANa711b3f2021-03-12 15:24:06 +09003636 public static final int CALLBACK_BLK_CHANGED = 11;
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003637
Erik Kline66721822015-11-25 12:49:38 +09003638 /** @hide */
3639 public static String getCallbackName(int whichCallback) {
3640 switch (whichCallback) {
3641 case CALLBACK_PRECHECK: return "CALLBACK_PRECHECK";
3642 case CALLBACK_AVAILABLE: return "CALLBACK_AVAILABLE";
3643 case CALLBACK_LOSING: return "CALLBACK_LOSING";
3644 case CALLBACK_LOST: return "CALLBACK_LOST";
3645 case CALLBACK_UNAVAIL: return "CALLBACK_UNAVAIL";
3646 case CALLBACK_CAP_CHANGED: return "CALLBACK_CAP_CHANGED";
3647 case CALLBACK_IP_CHANGED: return "CALLBACK_IP_CHANGED";
Erik Kline66721822015-11-25 12:49:38 +09003648 case EXPIRE_LEGACY_REQUEST: return "EXPIRE_LEGACY_REQUEST";
3649 case CALLBACK_SUSPENDED: return "CALLBACK_SUSPENDED";
3650 case CALLBACK_RESUMED: return "CALLBACK_RESUMED";
junyulai5ab727b2018-08-07 19:50:45 +08003651 case CALLBACK_BLK_CHANGED: return "CALLBACK_BLK_CHANGED";
Erik Kline66721822015-11-25 12:49:38 +09003652 default:
3653 return Integer.toString(whichCallback);
3654 }
3655 }
3656
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07003657 private class CallbackHandler extends Handler {
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003658 private static final String TAG = "ConnectivityManager.CallbackHandler";
Robert Greenwalt9b330772015-09-03 16:41:45 -07003659 private static final boolean DBG = false;
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003660
Hugo Benichife3325f2016-07-06 22:53:17 +09003661 CallbackHandler(Looper looper) {
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003662 super(looper);
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003663 }
3664
Hugo Benichicd5a0e02017-02-02 17:02:36 +09003665 CallbackHandler(Handler handler) {
Remi NGUYEN VANc4dd8c92021-03-15 07:31:54 +00003666 this(Objects.requireNonNull(handler, "Handler cannot be null.").getLooper());
Hugo Benichicd5a0e02017-02-02 17:02:36 +09003667 }
3668
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003669 @Override
3670 public void handleMessage(Message message) {
Hugo Benichi3b926992017-05-09 14:36:02 +09003671 if (message.what == EXPIRE_LEGACY_REQUEST) {
3672 expireRequest((NetworkCapabilities) message.obj, message.arg1);
3673 return;
3674 }
3675
3676 final NetworkRequest request = getObject(message, NetworkRequest.class);
3677 final Network network = getObject(message, Network.class);
3678 final NetworkCallback callback;
3679 synchronized (sCallbacks) {
3680 callback = sCallbacks.get(request);
Etan Cohenbc3a4eb2019-05-21 12:06:04 -07003681 if (callback == null) {
3682 Log.w(TAG,
3683 "callback not found for " + getCallbackName(message.what) + " message");
3684 return;
3685 }
Etan Cohene0e2ca92019-04-16 15:07:55 -07003686 if (message.what == CALLBACK_UNAVAIL) {
3687 sCallbacks.remove(request);
3688 callback.networkRequest = ALREADY_UNREGISTERED;
3689 }
Hugo Benichi3b926992017-05-09 14:36:02 +09003690 }
Lorenzo Colitti7e286832016-03-01 22:56:37 +09003691 if (DBG) {
Hugo Benichi94f0bfc2017-03-22 17:07:57 +09003692 Log.d(TAG, getCallbackName(message.what) + " for network " + network);
Lorenzo Colitti7e286832016-03-01 22:56:37 +09003693 }
Hugo Benichi3b926992017-05-09 14:36:02 +09003694
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003695 switch (message.what) {
3696 case CALLBACK_PRECHECK: {
Hugo Benichi3b926992017-05-09 14:36:02 +09003697 callback.onPreCheck(network);
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003698 break;
3699 }
3700 case CALLBACK_AVAILABLE: {
Chalard Jeanb6a0c6d2018-01-30 22:41:41 +09003701 NetworkCapabilities cap = getObject(message, NetworkCapabilities.class);
3702 LinkProperties lp = getObject(message, LinkProperties.class);
junyulai5ab727b2018-08-07 19:50:45 +08003703 callback.onAvailable(network, cap, lp, message.arg1 != 0);
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003704 break;
3705 }
3706 case CALLBACK_LOSING: {
Hugo Benichi3b926992017-05-09 14:36:02 +09003707 callback.onLosing(network, message.arg1);
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003708 break;
3709 }
3710 case CALLBACK_LOST: {
Hugo Benichi3b926992017-05-09 14:36:02 +09003711 callback.onLost(network);
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003712 break;
3713 }
3714 case CALLBACK_UNAVAIL: {
Hugo Benichi3b926992017-05-09 14:36:02 +09003715 callback.onUnavailable();
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003716 break;
3717 }
3718 case CALLBACK_CAP_CHANGED: {
Hugo Benichi3b926992017-05-09 14:36:02 +09003719 NetworkCapabilities cap = getObject(message, NetworkCapabilities.class);
3720 callback.onCapabilitiesChanged(network, cap);
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003721 break;
3722 }
3723 case CALLBACK_IP_CHANGED: {
Hugo Benichi3b926992017-05-09 14:36:02 +09003724 LinkProperties lp = getObject(message, LinkProperties.class);
3725 callback.onLinkPropertiesChanged(network, lp);
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003726 break;
3727 }
Robert Greenwalt41c19a02015-06-24 13:23:42 -07003728 case CALLBACK_SUSPENDED: {
Hugo Benichi3b926992017-05-09 14:36:02 +09003729 callback.onNetworkSuspended(network);
Robert Greenwalt41c19a02015-06-24 13:23:42 -07003730 break;
3731 }
3732 case CALLBACK_RESUMED: {
Hugo Benichi3b926992017-05-09 14:36:02 +09003733 callback.onNetworkResumed(network);
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07003734 break;
3735 }
junyulai5ab727b2018-08-07 19:50:45 +08003736 case CALLBACK_BLK_CHANGED: {
3737 boolean blocked = message.arg1 != 0;
3738 callback.onBlockedStatusChanged(network, blocked);
3739 }
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003740 }
3741 }
3742
Hugo Benichife3325f2016-07-06 22:53:17 +09003743 private <T> T getObject(Message msg, Class<T> c) {
3744 return (T) msg.getData().getParcelable(c.getSimpleName());
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003745 }
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003746 }
3747
Hugo Benichicd5a0e02017-02-02 17:02:36 +09003748 private CallbackHandler getDefaultHandler() {
Hugo Benichi3a545552016-07-07 10:15:56 +09003749 synchronized (sCallbacks) {
3750 if (sCallbackHandler == null) {
3751 sCallbackHandler = new CallbackHandler(ConnectivityThread.getInstanceLooper());
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003752 }
Hugo Benichi3a545552016-07-07 10:15:56 +09003753 return sCallbackHandler;
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003754 }
3755 }
3756
Hugo Benichiec180d52017-02-03 14:18:44 +09003757 private static final HashMap<NetworkRequest, NetworkCallback> sCallbacks = new HashMap<>();
3758 private static CallbackHandler sCallbackHandler;
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003759
Lorenzo Colittib199b962021-03-12 22:48:07 +09003760 private NetworkRequest sendRequestForNetwork(int asUid, NetworkCapabilities need,
3761 NetworkCallback callback, int timeoutMs, NetworkRequest.Type reqType, int legacyType,
3762 CallbackHandler handler) {
Soi, Yoshinari99efcbd2015-11-12 12:09:02 +09003763 printStackTrace();
Hugo Benichiff4bf602017-05-09 15:19:01 +09003764 checkCallbackNotNull(callback);
Remi NGUYEN VANc4dd8c92021-03-15 07:31:54 +00003765 if (reqType != TRACK_DEFAULT && reqType != TRACK_SYSTEM_DEFAULT && need == null) {
3766 throw new IllegalArgumentException("null NetworkCapabilities");
3767 }
Hugo Benichife3325f2016-07-06 22:53:17 +09003768 final NetworkRequest request;
Roshan Piusd26ae412020-01-16 12:17:17 -08003769 final String callingPackageName = mContext.getOpPackageName();
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003770 try {
Hugo Benichife3325f2016-07-06 22:53:17 +09003771 synchronized(sCallbacks) {
Hugo Benichi1c027fe2017-06-17 13:14:12 +09003772 if (callback.networkRequest != null
3773 && callback.networkRequest != ALREADY_UNREGISTERED) {
Hugo Benichi45a49542017-03-06 09:17:06 +09003774 // TODO: throw exception instead and enforce 1:1 mapping of callbacks
3775 // and requests (http://b/20701525).
3776 Log.e(TAG, "NetworkCallback was already registered");
3777 }
Hugo Benichi3a545552016-07-07 10:15:56 +09003778 Messenger messenger = new Messenger(handler);
Hugo Benichife3325f2016-07-06 22:53:17 +09003779 Binder binder = new Binder();
Roshan Pius7992afd2020-12-22 15:10:42 -08003780 final int callbackFlags = callback.mFlags;
junyulaid1a78162021-01-11 16:53:38 +08003781 if (reqType == LISTEN) {
Roshan Piusd26ae412020-01-16 12:17:17 -08003782 request = mService.listenForNetwork(
Roshan Pius7992afd2020-12-22 15:10:42 -08003783 need, messenger, binder, callbackFlags, callingPackageName,
Roshan Piusc97d8062020-12-17 14:53:09 -08003784 getAttributionTag());
Paul Jensenf980a0f2014-06-27 11:05:32 -04003785 } else {
Hugo Benichife3325f2016-07-06 22:53:17 +09003786 request = mService.requestNetwork(
Lorenzo Colittib199b962021-03-12 22:48:07 +09003787 asUid, need, reqType.ordinal(), messenger, timeoutMs, binder,
3788 legacyType, callbackFlags, callingPackageName, getAttributionTag());
Paul Jensenf980a0f2014-06-27 11:05:32 -04003789 }
Hugo Benichife3325f2016-07-06 22:53:17 +09003790 if (request != null) {
Hugo Benichi3a545552016-07-07 10:15:56 +09003791 sCallbacks.put(request, callback);
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003792 }
Hugo Benichi3a545552016-07-07 10:15:56 +09003793 callback.networkRequest = request;
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003794 }
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07003795 } catch (RemoteException e) {
3796 throw e.rethrowFromSystemServer();
Hugo Benichi145e3792017-05-11 13:16:17 +09003797 } catch (ServiceSpecificException e) {
3798 throw convertServiceException(e);
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07003799 }
Hugo Benichife3325f2016-07-06 22:53:17 +09003800 return request;
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003801 }
3802
Lorenzo Colittib199b962021-03-12 22:48:07 +09003803 private NetworkRequest sendRequestForNetwork(NetworkCapabilities need, NetworkCallback callback,
3804 int timeoutMs, NetworkRequest.Type reqType, int legacyType, CallbackHandler handler) {
3805 return sendRequestForNetwork(Process.INVALID_UID, need, callback, timeoutMs, reqType,
3806 legacyType, handler);
3807 }
3808
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003809 /**
Erik Klinee0aed632016-03-16 15:31:39 +09003810 * Helper function to request a network with a particular legacy type.
Lorenzo Colitti873f7bb2015-11-25 12:00:52 +09003811 *
markchien0fe11402020-03-18 21:16:15 +08003812 * This API is only for use in internal system code that requests networks with legacy type and
3813 * relies on CONNECTIVITY_ACTION broadcasts instead of NetworkCallbacks. New caller should use
markchien769c5752020-01-14 12:54:40 +08003814 * {@link #requestNetwork(NetworkRequest, NetworkCallback, Handler)} instead.
Lorenzo Colitti873f7bb2015-11-25 12:00:52 +09003815 *
markchien769c5752020-01-14 12:54:40 +08003816 * @param request {@link NetworkRequest} describing this request.
markchien769c5752020-01-14 12:54:40 +08003817 * @param timeoutMs The time in milliseconds to attempt looking for a suitable network
3818 * before {@link NetworkCallback#onUnavailable()} is called. The timeout must
3819 * be a positive value (i.e. >0).
3820 * @param legacyType to specify the network type(#TYPE_*).
3821 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
markchien0fe11402020-03-18 21:16:15 +08003822 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
3823 * the callback must not be shared - it uniquely specifies this request.
Lorenzo Colitti873f7bb2015-11-25 12:00:52 +09003824 *
3825 * @hide
3826 */
markchien769c5752020-01-14 12:54:40 +08003827 @SystemApi
markchien0fe11402020-03-18 21:16:15 +08003828 @RequiresPermission(NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK)
Chalard Jean42a9c292019-01-07 19:26:34 +09003829 public void requestNetwork(@NonNull NetworkRequest request,
markchien0fe11402020-03-18 21:16:15 +08003830 int timeoutMs, int legacyType, @NonNull Handler handler,
3831 @NonNull NetworkCallback networkCallback) {
3832 if (legacyType == TYPE_NONE) {
3833 throw new IllegalArgumentException("TYPE_NONE is meaningless legacy type");
3834 }
Hugo Benichicd5a0e02017-02-02 17:02:36 +09003835 CallbackHandler cbHandler = new CallbackHandler(handler);
3836 NetworkCapabilities nc = request.networkCapabilities;
3837 sendRequestForNetwork(nc, networkCallback, timeoutMs, REQUEST, legacyType, cbHandler);
Lorenzo Colitti873f7bb2015-11-25 12:00:52 +09003838 }
3839
3840 /**
Roshan Pius7992afd2020-12-22 15:10:42 -08003841 * Request a network to satisfy a set of {@link NetworkCapabilities}.
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003842 *
Chalard Jean7f3a8742019-08-30 16:27:28 +09003843 * <p>This method will attempt to find the best network that matches the passed
3844 * {@link NetworkRequest}, and to bring up one that does if none currently satisfies the
3845 * criteria. The platform will evaluate which network is the best at its own discretion.
3846 * Throughput, latency, cost per byte, policy, user preference and other considerations
3847 * may be factored in the decision of what is considered the best network.
3848 *
3849 * <p>As long as this request is outstanding, the platform will try to maintain the best network
3850 * matching this request, while always attempting to match the request to a better network if
3851 * possible. If a better match is found, the platform will switch this request to the now-best
3852 * network and inform the app of the newly best network by invoking
3853 * {@link NetworkCallback#onAvailable(Network)} on the provided callback. Note that the platform
3854 * will not try to maintain any other network than the best one currently matching the request:
3855 * a network not matching any network request may be disconnected at any time.
3856 *
3857 * <p>For example, an application could use this method to obtain a connected cellular network
3858 * even if the device currently has a data connection over Ethernet. This may cause the cellular
3859 * radio to consume additional power. Or, an application could inform the system that it wants
3860 * a network supporting sending MMSes and have the system let it know about the currently best
3861 * MMS-supporting network through the provided {@link NetworkCallback}.
3862 *
3863 * <p>The status of the request can be followed by listening to the various callbacks described
3864 * in {@link NetworkCallback}. The {@link Network} object passed to the callback methods can be
3865 * used to direct traffic to the network (although accessing some networks may be subject to
3866 * holding specific permissions). Callers will learn about the specific characteristics of the
3867 * network through
3868 * {@link NetworkCallback#onCapabilitiesChanged(Network, NetworkCapabilities)} and
3869 * {@link NetworkCallback#onLinkPropertiesChanged(Network, LinkProperties)}. The methods of the
3870 * provided {@link NetworkCallback} will only be invoked due to changes in the best network
3871 * matching the request at any given time; therefore when a better network matching the request
3872 * becomes available, the {@link NetworkCallback#onAvailable(Network)} method is called
3873 * with the new network after which no further updates are given about the previously-best
3874 * network, unless it becomes the best again at some later time. All callbacks are invoked
3875 * in order on the same thread, which by default is a thread created by the framework running
3876 * in the app.
3877 * {@see #requestNetwork(NetworkRequest, NetworkCallback, Handler)} to change where the
3878 * callbacks are invoked.
3879 *
3880 * <p>This{@link NetworkRequest} will live until released via
3881 * {@link #unregisterNetworkCallback(NetworkCallback)} or the calling application exits, at
3882 * which point the system may let go of the network at any time.
3883 *
3884 * <p>A version of this method which takes a timeout is
3885 * {@link #requestNetwork(NetworkRequest, NetworkCallback, int)}, that an app can use to only
3886 * wait for a limited amount of time for the network to become unavailable.
3887 *
Paul Jensen1fcbf9c2015-06-16 15:11:58 -04003888 * <p>It is presently unsupported to request a network with mutable
3889 * {@link NetworkCapabilities} such as
3890 * {@link NetworkCapabilities#NET_CAPABILITY_VALIDATED} or
3891 * {@link NetworkCapabilities#NET_CAPABILITY_CAPTIVE_PORTAL}
3892 * as these {@code NetworkCapabilities} represent states that a particular
3893 * network may never attain, and whether a network will attain these states
3894 * is unknown prior to bringing up the network so the framework does not
Chalard Jean7f3a8742019-08-30 16:27:28 +09003895 * know how to go about satisfying a request with these capabilities.
Lorenzo Colitti91de63b2015-10-15 16:29:00 +09003896 *
3897 * <p>This method requires the caller to hold either the
3898 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
3899 * or the ability to modify system settings as determined by
3900 * {@link android.provider.Settings.System#canWrite}.</p>
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003901 *
Chalard Jean7f06b342020-05-20 16:11:50 +09003902 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
3903 * number of outstanding requests to 100 per app (identified by their UID), shared with
3904 * all variants of this method, of {@link #registerNetworkCallback} as well as
3905 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
3906 * Requesting a network with this method will count toward this limit. If this limit is
3907 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
3908 * make sure to unregister the callbacks with
3909 * {@link #unregisterNetworkCallback(NetworkCallback)}.
3910 *
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07003911 * @param request {@link NetworkRequest} describing this request.
Hugo Benichicd5a0e02017-02-02 17:02:36 +09003912 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
3913 * the callback must not be shared - it uniquely specifies this request.
3914 * The callback is invoked on the default internal Handler.
Chalard Jean9f1a7632019-05-13 15:13:58 +09003915 * @throws IllegalArgumentException if {@code request} contains invalid network capabilities.
3916 * @throws SecurityException if missing the appropriate permissions.
Chalard Jean7f06b342020-05-20 16:11:50 +09003917 * @throws RuntimeException if the app already has too many callbacks registered.
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003918 */
Chalard Jean42a9c292019-01-07 19:26:34 +09003919 public void requestNetwork(@NonNull NetworkRequest request,
3920 @NonNull NetworkCallback networkCallback) {
Hugo Benichicd5a0e02017-02-02 17:02:36 +09003921 requestNetwork(request, networkCallback, getDefaultHandler());
3922 }
3923
3924 /**
Roshan Pius7992afd2020-12-22 15:10:42 -08003925 * Request a network to satisfy a set of {@link NetworkCapabilities}.
Hugo Benichicd5a0e02017-02-02 17:02:36 +09003926 *
Chalard Jean7f3a8742019-08-30 16:27:28 +09003927 * This method behaves identically to {@link #requestNetwork(NetworkRequest, NetworkCallback)}
3928 * but runs all the callbacks on the passed Handler.
Hugo Benichicd5a0e02017-02-02 17:02:36 +09003929 *
Chalard Jean7f3a8742019-08-30 16:27:28 +09003930 * <p>This method has the same permission requirements as
Chalard Jean7f06b342020-05-20 16:11:50 +09003931 * {@link #requestNetwork(NetworkRequest, NetworkCallback)}, is subject to the same limitations,
3932 * and throws the same exceptions in the same conditions.
Hugo Benichicd5a0e02017-02-02 17:02:36 +09003933 *
3934 * @param request {@link NetworkRequest} describing this request.
3935 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
3936 * the callback must not be shared - it uniquely specifies this request.
3937 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
Hugo Benichicd5a0e02017-02-02 17:02:36 +09003938 */
Chalard Jean42a9c292019-01-07 19:26:34 +09003939 public void requestNetwork(@NonNull NetworkRequest request,
3940 @NonNull NetworkCallback networkCallback, @NonNull Handler handler) {
Hugo Benichicd5a0e02017-02-02 17:02:36 +09003941 CallbackHandler cbHandler = new CallbackHandler(handler);
markchien0fe11402020-03-18 21:16:15 +08003942 NetworkCapabilities nc = request.networkCapabilities;
3943 sendRequestForNetwork(nc, networkCallback, 0, REQUEST, TYPE_NONE, cbHandler);
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003944 }
3945
3946 /**
Roshan Pius7992afd2020-12-22 15:10:42 -08003947 * Request a network to satisfy a set of {@link NetworkCapabilities}, limited
Etan Cohen67e58a02017-03-01 12:47:28 -08003948 * by a timeout.
3949 *
3950 * This function behaves identically to the non-timed-out version
3951 * {@link #requestNetwork(NetworkRequest, NetworkCallback)}, but if a suitable network
3952 * is not found within the given time (in milliseconds) the
3953 * {@link NetworkCallback#onUnavailable()} callback is called. The request can still be
3954 * released normally by calling {@link #unregisterNetworkCallback(NetworkCallback)} but does
3955 * not have to be released if timed-out (it is automatically released). Unregistering a
3956 * request that timed out is not an error.
3957 *
3958 * <p>Do not use this method to poll for the existence of specific networks (e.g. with a small
3959 * timeout) - {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)} is provided
3960 * for that purpose. Calling this method will attempt to bring up the requested network.
3961 *
Chalard Jean7f3a8742019-08-30 16:27:28 +09003962 * <p>This method has the same permission requirements as
Chalard Jean7f06b342020-05-20 16:11:50 +09003963 * {@link #requestNetwork(NetworkRequest, NetworkCallback)}, is subject to the same limitations,
3964 * and throws the same exceptions in the same conditions.
Etan Cohen67e58a02017-03-01 12:47:28 -08003965 *
3966 * @param request {@link NetworkRequest} describing this request.
Lorenzo Colitti38ea8102017-04-28 00:56:30 +09003967 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
3968 * the callback must not be shared - it uniquely specifies this request.
Etan Cohen67e58a02017-03-01 12:47:28 -08003969 * @param timeoutMs The time in milliseconds to attempt looking for a suitable network
3970 * before {@link NetworkCallback#onUnavailable()} is called. The timeout must
3971 * be a positive value (i.e. >0).
Etan Cohen67e58a02017-03-01 12:47:28 -08003972 */
Chalard Jean42a9c292019-01-07 19:26:34 +09003973 public void requestNetwork(@NonNull NetworkRequest request,
3974 @NonNull NetworkCallback networkCallback, int timeoutMs) {
Hugo Benichiff4bf602017-05-09 15:19:01 +09003975 checkTimeout(timeoutMs);
markchien0fe11402020-03-18 21:16:15 +08003976 NetworkCapabilities nc = request.networkCapabilities;
3977 sendRequestForNetwork(nc, networkCallback, timeoutMs, REQUEST, TYPE_NONE,
3978 getDefaultHandler());
Hugo Benichicd5a0e02017-02-02 17:02:36 +09003979 }
3980
Hugo Benichicd5a0e02017-02-02 17:02:36 +09003981 /**
Roshan Pius7992afd2020-12-22 15:10:42 -08003982 * Request a network to satisfy a set of {@link NetworkCapabilities}, limited
Hugo Benichicd5a0e02017-02-02 17:02:36 +09003983 * by a timeout.
3984 *
Chalard Jean7f3a8742019-08-30 16:27:28 +09003985 * This method behaves identically to
3986 * {@link #requestNetwork(NetworkRequest, NetworkCallback, int)} but runs all the callbacks
3987 * on the passed Handler.
Etan Cohen67e58a02017-03-01 12:47:28 -08003988 *
Chalard Jean7f3a8742019-08-30 16:27:28 +09003989 * <p>This method has the same permission requirements as
Chalard Jean7f06b342020-05-20 16:11:50 +09003990 * {@link #requestNetwork(NetworkRequest, NetworkCallback)}, is subject to the same limitations,
3991 * and throws the same exceptions in the same conditions.
Hugo Benichicd5a0e02017-02-02 17:02:36 +09003992 *
3993 * @param request {@link NetworkRequest} describing this request.
Etan Cohen67e58a02017-03-01 12:47:28 -08003994 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
3995 * the callback must not be shared - it uniquely specifies this request.
Hugo Benichicd5a0e02017-02-02 17:02:36 +09003996 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
Lorenzo Colitti38ea8102017-04-28 00:56:30 +09003997 * @param timeoutMs The time in milliseconds to attempt looking for a suitable network
3998 * before {@link NetworkCallback#onUnavailable} is called.
Hugo Benichicd5a0e02017-02-02 17:02:36 +09003999 */
Chalard Jean42a9c292019-01-07 19:26:34 +09004000 public void requestNetwork(@NonNull NetworkRequest request,
4001 @NonNull NetworkCallback networkCallback, @NonNull Handler handler, int timeoutMs) {
Hugo Benichiff4bf602017-05-09 15:19:01 +09004002 checkTimeout(timeoutMs);
Hugo Benichicd5a0e02017-02-02 17:02:36 +09004003 CallbackHandler cbHandler = new CallbackHandler(handler);
markchien0fe11402020-03-18 21:16:15 +08004004 NetworkCapabilities nc = request.networkCapabilities;
4005 sendRequestForNetwork(nc, networkCallback, timeoutMs, REQUEST, TYPE_NONE, cbHandler);
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07004006 }
4007
4008 /**
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07004009 * The lookup key for a {@link Network} object included with the intent after
Jeremy Joslin94c30992014-11-05 10:32:09 -08004010 * successfully finding a network for the applications request. Retrieve it with
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07004011 * {@link android.content.Intent#getParcelableExtra(String)}.
Jeremy Joslinfe76e0e2015-02-11 16:51:13 -08004012 * <p>
Paul Jensen895c3942015-03-10 10:54:12 -04004013 * Note that if you intend to invoke {@link Network#openConnection(java.net.URL)}
4014 * then you must get a ConnectivityManager instance before doing so.
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07004015 */
Erik Klinefb087f12014-11-19 12:12:24 +09004016 public static final String EXTRA_NETWORK = "android.net.extra.NETWORK";
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07004017
4018 /**
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07004019 * The lookup key for a {@link NetworkRequest} object included with the intent after
Jeremy Joslin94c30992014-11-05 10:32:09 -08004020 * successfully finding a network for the applications request. Retrieve it with
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07004021 * {@link android.content.Intent#getParcelableExtra(String)}.
4022 */
Erik Klinefb087f12014-11-19 12:12:24 +09004023 public static final String EXTRA_NETWORK_REQUEST = "android.net.extra.NETWORK_REQUEST";
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07004024
4025
4026 /**
Roshan Pius7992afd2020-12-22 15:10:42 -08004027 * Request a network to satisfy a set of {@link NetworkCapabilities}.
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07004028 *
Jeremy Joslin94c30992014-11-05 10:32:09 -08004029 * This function behaves identically to the version that takes a NetworkCallback, but instead
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07004030 * of {@link NetworkCallback} a {@link PendingIntent} is used. This means
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07004031 * the request may outlive the calling application and get called back when a suitable
4032 * network is found.
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07004033 * <p>
4034 * The operation is an Intent broadcast that goes to a broadcast receiver that
4035 * you registered with {@link Context#registerReceiver} or through the
4036 * &lt;receiver&gt; tag in an AndroidManifest.xml file
4037 * <p>
4038 * The operation Intent is delivered with two extras, a {@link Network} typed
Erik Klinefb087f12014-11-19 12:12:24 +09004039 * extra called {@link #EXTRA_NETWORK} and a {@link NetworkRequest}
4040 * typed extra called {@link #EXTRA_NETWORK_REQUEST} containing
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07004041 * the original requests parameters. It is important to create a new,
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07004042 * {@link NetworkCallback} based request before completing the processing of the
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07004043 * Intent to reserve the network or it will be released shortly after the Intent
4044 * is processed.
4045 * <p>
Paul Jensen9ceed862015-06-17 14:15:39 -04004046 * If there is already a request for this Intent registered (with the equality of
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07004047 * two Intents defined by {@link Intent#filterEquals}), then it will be removed and
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07004048 * replaced by this one, effectively releasing the previous {@link NetworkRequest}.
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07004049 * <p>
Jeremy Joslin94c30992014-11-05 10:32:09 -08004050 * The request may be released normally by calling
4051 * {@link #releaseNetworkRequest(android.app.PendingIntent)}.
Paul Jensen1fcbf9c2015-06-16 15:11:58 -04004052 * <p>It is presently unsupported to request a network with either
4053 * {@link NetworkCapabilities#NET_CAPABILITY_VALIDATED} or
4054 * {@link NetworkCapabilities#NET_CAPABILITY_CAPTIVE_PORTAL}
4055 * as these {@code NetworkCapabilities} represent states that a particular
4056 * network may never attain, and whether a network will attain these states
4057 * is unknown prior to bringing up the network so the framework does not
Chalard Jean73d9db72018-06-04 16:52:49 +09004058 * know how to go about satisfying a request with these capabilities.
Lorenzo Colitti91de63b2015-10-15 16:29:00 +09004059 *
Chalard Jean7f06b342020-05-20 16:11:50 +09004060 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4061 * number of outstanding requests to 100 per app (identified by their UID), shared with
4062 * all variants of this method, of {@link #registerNetworkCallback} as well as
4063 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4064 * Requesting a network with this method will count toward this limit. If this limit is
4065 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4066 * make sure to unregister the callbacks with {@link #unregisterNetworkCallback(PendingIntent)}
4067 * or {@link #releaseNetworkRequest(PendingIntent)}.
4068 *
Lorenzo Colitti91de63b2015-10-15 16:29:00 +09004069 * <p>This method requires the caller to hold either the
4070 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
4071 * or the ability to modify system settings as determined by
4072 * {@link android.provider.Settings.System#canWrite}.</p>
4073 *
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07004074 * @param request {@link NetworkRequest} describing this request.
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07004075 * @param operation Action to perform when the network is available (corresponds
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07004076 * to the {@link NetworkCallback#onAvailable} call. Typically
Jeremy Joslin94c30992014-11-05 10:32:09 -08004077 * comes from {@link PendingIntent#getBroadcast}. Cannot be null.
Chalard Jean9f1a7632019-05-13 15:13:58 +09004078 * @throws IllegalArgumentException if {@code request} contains invalid network capabilities.
4079 * @throws SecurityException if missing the appropriate permissions.
Chalard Jean7f06b342020-05-20 16:11:50 +09004080 * @throws RuntimeException if the app already has too many callbacks registered.
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07004081 */
Chalard Jean42a9c292019-01-07 19:26:34 +09004082 public void requestNetwork(@NonNull NetworkRequest request,
4083 @NonNull PendingIntent operation) {
Soi, Yoshinari99efcbd2015-11-12 12:09:02 +09004084 printStackTrace();
Hugo Benichiff4bf602017-05-09 15:19:01 +09004085 checkPendingIntentNotNull(operation);
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07004086 try {
Roshan Piusd26ae412020-01-16 12:17:17 -08004087 mService.pendingRequestForNetwork(
Philip P. Moltmannddbcf5b2020-03-24 15:57:49 -07004088 request.networkCapabilities, operation, mContext.getOpPackageName(),
4089 getAttributionTag());
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07004090 } catch (RemoteException e) {
4091 throw e.rethrowFromSystemServer();
Hugo Benichi145e3792017-05-11 13:16:17 +09004092 } catch (ServiceSpecificException e) {
4093 throw convertServiceException(e);
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07004094 }
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07004095 }
4096
4097 /**
Jeremy Joslin94c30992014-11-05 10:32:09 -08004098 * Removes a request made via {@link #requestNetwork(NetworkRequest, android.app.PendingIntent)}
4099 * <p>
Lorenzo Colittiad458ad2016-04-13 22:00:02 +09004100 * This method has the same behavior as
4101 * {@link #unregisterNetworkCallback(android.app.PendingIntent)} with respect to
Jeremy Joslin94c30992014-11-05 10:32:09 -08004102 * releasing network resources and disconnecting.
4103 *
4104 * @param operation A PendingIntent equal (as defined by {@link Intent#filterEquals}) to the
4105 * PendingIntent passed to
4106 * {@link #requestNetwork(NetworkRequest, android.app.PendingIntent)} with the
4107 * corresponding NetworkRequest you'd like to remove. Cannot be null.
4108 */
Chalard Jean42a9c292019-01-07 19:26:34 +09004109 public void releaseNetworkRequest(@NonNull PendingIntent operation) {
Soi, Yoshinari99efcbd2015-11-12 12:09:02 +09004110 printStackTrace();
Hugo Benichiff4bf602017-05-09 15:19:01 +09004111 checkPendingIntentNotNull(operation);
Jeremy Joslin94c30992014-11-05 10:32:09 -08004112 try {
4113 mService.releasePendingNetworkRequest(operation);
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07004114 } catch (RemoteException e) {
4115 throw e.rethrowFromSystemServer();
4116 }
Jeremy Joslin94c30992014-11-05 10:32:09 -08004117 }
4118
Hugo Benichiff4bf602017-05-09 15:19:01 +09004119 private static void checkPendingIntentNotNull(PendingIntent intent) {
Remi NGUYEN VANc4dd8c92021-03-15 07:31:54 +00004120 Objects.requireNonNull(intent, "PendingIntent cannot be null.");
Hugo Benichiff4bf602017-05-09 15:19:01 +09004121 }
4122
4123 private static void checkCallbackNotNull(NetworkCallback callback) {
Remi NGUYEN VANc4dd8c92021-03-15 07:31:54 +00004124 Objects.requireNonNull(callback, "null NetworkCallback");
Hugo Benichiff4bf602017-05-09 15:19:01 +09004125 }
4126
4127 private static void checkTimeout(int timeoutMs) {
Remi NGUYEN VANc4dd8c92021-03-15 07:31:54 +00004128 if (timeoutMs <= 0) {
4129 throw new IllegalArgumentException("timeoutMs must be strictly positive.");
4130 }
Jeremy Joslin94c30992014-11-05 10:32:09 -08004131 }
4132
4133 /**
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07004134 * Registers to receive notifications about all networks which satisfy the given
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07004135 * {@link NetworkRequest}. The callbacks will continue to be called until
Chiachang Wang0d92d1a2019-02-27 17:14:50 +08004136 * either the application exits or {@link #unregisterNetworkCallback(NetworkCallback)} is
4137 * called.
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07004138 *
Chalard Jean7f06b342020-05-20 16:11:50 +09004139 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4140 * number of outstanding requests to 100 per app (identified by their UID), shared with
4141 * all variants of this method, of {@link #requestNetwork} as well as
4142 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4143 * Requesting a network with this method will count toward this limit. If this limit is
4144 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4145 * make sure to unregister the callbacks with
4146 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4147 *
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07004148 * @param request {@link NetworkRequest} describing this request.
4149 * @param networkCallback The {@link NetworkCallback} that the system will call as suitable
4150 * networks change state.
Hugo Benichicd5a0e02017-02-02 17:02:36 +09004151 * The callback is invoked on the default internal Handler.
Chalard Jean7f06b342020-05-20 16:11:50 +09004152 * @throws RuntimeException if the app already has too many callbacks registered.
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07004153 */
Jeff Sharkey2ac62992017-04-24 11:18:03 -06004154 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean42a9c292019-01-07 19:26:34 +09004155 public void registerNetworkCallback(@NonNull NetworkRequest request,
4156 @NonNull NetworkCallback networkCallback) {
Hugo Benichicd5a0e02017-02-02 17:02:36 +09004157 registerNetworkCallback(request, networkCallback, getDefaultHandler());
4158 }
4159
4160 /**
4161 * Registers to receive notifications about all networks which satisfy the given
4162 * {@link NetworkRequest}. The callbacks will continue to be called until
Chiachang Wang0d92d1a2019-02-27 17:14:50 +08004163 * either the application exits or {@link #unregisterNetworkCallback(NetworkCallback)} is
4164 * called.
Hugo Benichicd5a0e02017-02-02 17:02:36 +09004165 *
Chalard Jean7f06b342020-05-20 16:11:50 +09004166 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4167 * number of outstanding requests to 100 per app (identified by their UID), shared with
4168 * all variants of this method, of {@link #requestNetwork} as well as
4169 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4170 * Requesting a network with this method will count toward this limit. If this limit is
4171 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4172 * make sure to unregister the callbacks with
4173 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4174 *
4175 *
Hugo Benichicd5a0e02017-02-02 17:02:36 +09004176 * @param request {@link NetworkRequest} describing this request.
4177 * @param networkCallback The {@link NetworkCallback} that the system will call as suitable
4178 * networks change state.
4179 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
Chalard Jean7f06b342020-05-20 16:11:50 +09004180 * @throws RuntimeException if the app already has too many callbacks registered.
Hugo Benichicd5a0e02017-02-02 17:02:36 +09004181 */
Jeff Sharkey2ac62992017-04-24 11:18:03 -06004182 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean42a9c292019-01-07 19:26:34 +09004183 public void registerNetworkCallback(@NonNull NetworkRequest request,
4184 @NonNull NetworkCallback networkCallback, @NonNull Handler handler) {
Hugo Benichicd5a0e02017-02-02 17:02:36 +09004185 CallbackHandler cbHandler = new CallbackHandler(handler);
4186 NetworkCapabilities nc = request.networkCapabilities;
4187 sendRequestForNetwork(nc, networkCallback, 0, LISTEN, TYPE_NONE, cbHandler);
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07004188 }
4189
4190 /**
Paul Jensen9ceed862015-06-17 14:15:39 -04004191 * Registers a PendingIntent to be sent when a network is available which satisfies the given
4192 * {@link NetworkRequest}.
4193 *
4194 * This function behaves identically to the version that takes a NetworkCallback, but instead
4195 * of {@link NetworkCallback} a {@link PendingIntent} is used. This means
4196 * the request may outlive the calling application and get called back when a suitable
4197 * network is found.
4198 * <p>
4199 * The operation is an Intent broadcast that goes to a broadcast receiver that
4200 * you registered with {@link Context#registerReceiver} or through the
4201 * &lt;receiver&gt; tag in an AndroidManifest.xml file
4202 * <p>
4203 * The operation Intent is delivered with two extras, a {@link Network} typed
4204 * extra called {@link #EXTRA_NETWORK} and a {@link NetworkRequest}
4205 * typed extra called {@link #EXTRA_NETWORK_REQUEST} containing
4206 * the original requests parameters.
4207 * <p>
4208 * If there is already a request for this Intent registered (with the equality of
4209 * two Intents defined by {@link Intent#filterEquals}), then it will be removed and
4210 * replaced by this one, effectively releasing the previous {@link NetworkRequest}.
4211 * <p>
4212 * The request may be released normally by calling
Paul Jensen78f6b802015-06-30 14:29:18 -04004213 * {@link #unregisterNetworkCallback(android.app.PendingIntent)}.
Chalard Jean7f06b342020-05-20 16:11:50 +09004214 *
4215 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4216 * number of outstanding requests to 100 per app (identified by their UID), shared with
4217 * all variants of this method, of {@link #requestNetwork} as well as
4218 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4219 * Requesting a network with this method will count toward this limit. If this limit is
4220 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4221 * make sure to unregister the callbacks with {@link #unregisterNetworkCallback(PendingIntent)}
4222 * or {@link #releaseNetworkRequest(PendingIntent)}.
4223 *
Paul Jensen9ceed862015-06-17 14:15:39 -04004224 * @param request {@link NetworkRequest} describing this request.
4225 * @param operation Action to perform when the network is available (corresponds
4226 * to the {@link NetworkCallback#onAvailable} call. Typically
4227 * comes from {@link PendingIntent#getBroadcast}. Cannot be null.
Chalard Jean7f06b342020-05-20 16:11:50 +09004228 * @throws RuntimeException if the app already has too many callbacks registered.
Paul Jensen9ceed862015-06-17 14:15:39 -04004229 */
Jeff Sharkey2ac62992017-04-24 11:18:03 -06004230 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean42a9c292019-01-07 19:26:34 +09004231 public void registerNetworkCallback(@NonNull NetworkRequest request,
4232 @NonNull PendingIntent operation) {
Soi, Yoshinari99efcbd2015-11-12 12:09:02 +09004233 printStackTrace();
Hugo Benichiff4bf602017-05-09 15:19:01 +09004234 checkPendingIntentNotNull(operation);
Paul Jensen9ceed862015-06-17 14:15:39 -04004235 try {
Roshan Piusd26ae412020-01-16 12:17:17 -08004236 mService.pendingListenForNetwork(
Roshan Piusc97d8062020-12-17 14:53:09 -08004237 request.networkCapabilities, operation, mContext.getOpPackageName(),
4238 getAttributionTag());
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07004239 } catch (RemoteException e) {
4240 throw e.rethrowFromSystemServer();
Hugo Benichi145e3792017-05-11 13:16:17 +09004241 } catch (ServiceSpecificException e) {
4242 throw convertServiceException(e);
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07004243 }
Paul Jensen9ceed862015-06-17 14:15:39 -04004244 }
4245
4246 /**
Lorenzo Colitti80b48bc2021-01-29 20:14:04 +09004247 * Registers to receive notifications about changes in the application's default network. This
4248 * may be a physical network or a virtual network, such as a VPN that applies to the
4249 * application. The callbacks will continue to be called until either the application exits or
Lorenzo Colittiad458ad2016-04-13 22:00:02 +09004250 * {@link #unregisterNetworkCallback(NetworkCallback)} is called.
Erik Klinee0aed632016-03-16 15:31:39 +09004251 *
Chalard Jean7f06b342020-05-20 16:11:50 +09004252 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4253 * number of outstanding requests to 100 per app (identified by their UID), shared with
4254 * all variants of this method, of {@link #requestNetwork} as well as
4255 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4256 * Requesting a network with this method will count toward this limit. If this limit is
4257 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4258 * make sure to unregister the callbacks with
4259 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4260 *
Erik Klinee0aed632016-03-16 15:31:39 +09004261 * @param networkCallback The {@link NetworkCallback} that the system will call as the
Lorenzo Colitti80b48bc2021-01-29 20:14:04 +09004262 * application's default network changes.
Hugo Benichicd5a0e02017-02-02 17:02:36 +09004263 * The callback is invoked on the default internal Handler.
Chalard Jean7f06b342020-05-20 16:11:50 +09004264 * @throws RuntimeException if the app already has too many callbacks registered.
Erik Klinee0aed632016-03-16 15:31:39 +09004265 */
Jeff Sharkey2ac62992017-04-24 11:18:03 -06004266 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean42a9c292019-01-07 19:26:34 +09004267 public void registerDefaultNetworkCallback(@NonNull NetworkCallback networkCallback) {
Hugo Benichicd5a0e02017-02-02 17:02:36 +09004268 registerDefaultNetworkCallback(networkCallback, getDefaultHandler());
4269 }
4270
4271 /**
Lorenzo Colitti80b48bc2021-01-29 20:14:04 +09004272 * Registers to receive notifications about changes in the application's default network. This
4273 * may be a physical network or a virtual network, such as a VPN that applies to the
4274 * application. The callbacks will continue to be called until either the application exits or
4275 * {@link #unregisterNetworkCallback(NetworkCallback)} is called.
4276 *
4277 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4278 * number of outstanding requests to 100 per app (identified by their UID), shared with
4279 * all variants of this method, of {@link #requestNetwork} as well as
4280 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4281 * Requesting a network with this method will count toward this limit. If this limit is
4282 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4283 * make sure to unregister the callbacks with
4284 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4285 *
4286 * @param networkCallback The {@link NetworkCallback} that the system will call as the
4287 * application's default network changes.
4288 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
4289 * @throws RuntimeException if the app already has too many callbacks registered.
4290 */
4291 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
4292 public void registerDefaultNetworkCallback(@NonNull NetworkCallback networkCallback,
4293 @NonNull Handler handler) {
Lorenzo Colittib199b962021-03-12 22:48:07 +09004294 registerDefaultNetworkCallbackAsUid(Process.INVALID_UID, networkCallback, handler);
4295 }
4296
4297 /**
4298 * Registers to receive notifications about changes in the default network for the specified
4299 * UID. This may be a physical network or a virtual network, such as a VPN that applies to the
4300 * UID. The callbacks will continue to be called until either the application exits or
4301 * {@link #unregisterNetworkCallback(NetworkCallback)} is called.
4302 *
4303 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4304 * number of outstanding requests to 100 per app (identified by their UID), shared with
4305 * all variants of this method, of {@link #requestNetwork} as well as
4306 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4307 * Requesting a network with this method will count toward this limit. If this limit is
4308 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4309 * make sure to unregister the callbacks with
4310 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4311 *
4312 * @param uid the UID for which to track default network changes.
4313 * @param networkCallback The {@link NetworkCallback} that the system will call as the
4314 * UID's default network changes.
4315 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
4316 * @throws RuntimeException if the app already has too many callbacks registered.
4317 * @hide
4318 */
Lorenzo Colitti3949d6e2021-03-22 18:23:21 +09004319 @SystemApi(client = MODULE_LIBRARIES)
Lorenzo Colittib199b962021-03-12 22:48:07 +09004320 @SuppressLint({"ExecutorRegistration", "PairedRegistration"})
4321 @RequiresPermission(anyOf = {
4322 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
4323 android.Manifest.permission.NETWORK_SETTINGS})
4324 public void registerDefaultNetworkCallbackAsUid(int uid,
4325 @NonNull NetworkCallback networkCallback, @NonNull Handler handler) {
Lorenzo Colitti80b48bc2021-01-29 20:14:04 +09004326 CallbackHandler cbHandler = new CallbackHandler(handler);
Lorenzo Colittib199b962021-03-12 22:48:07 +09004327 sendRequestForNetwork(uid, null /* need */, networkCallback, 0 /* timeoutMs */,
Lorenzo Colitti80b48bc2021-01-29 20:14:04 +09004328 TRACK_DEFAULT, TYPE_NONE, cbHandler);
4329 }
4330
4331 /**
Hugo Benichicd5a0e02017-02-02 17:02:36 +09004332 * Registers to receive notifications about changes in the system default network. The callbacks
4333 * will continue to be called until either the application exits or
4334 * {@link #unregisterNetworkCallback(NetworkCallback)} is called.
Hugo Benichicd5a0e02017-02-02 17:02:36 +09004335 *
Lorenzo Colitti80b48bc2021-01-29 20:14:04 +09004336 * This method should not be used to determine networking state seen by applications, because in
4337 * many cases, most or even all application traffic may not use the default network directly,
4338 * and traffic from different applications may go on different networks by default. As an
4339 * example, if a VPN is connected, traffic from all applications might be sent through the VPN
4340 * and not onto the system default network. Applications or system components desiring to do
4341 * determine network state as seen by applications should use other methods such as
4342 * {@link #registerDefaultNetworkCallback(NetworkCallback, Handler)}.
4343 *
Chalard Jean7f06b342020-05-20 16:11:50 +09004344 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4345 * number of outstanding requests to 100 per app (identified by their UID), shared with
4346 * all variants of this method, of {@link #requestNetwork} as well as
4347 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4348 * Requesting a network with this method will count toward this limit. If this limit is
4349 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4350 * make sure to unregister the callbacks with
4351 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4352 *
Hugo Benichicd5a0e02017-02-02 17:02:36 +09004353 * @param networkCallback The {@link NetworkCallback} that the system will call as the
4354 * system default network changes.
4355 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
Chalard Jean7f06b342020-05-20 16:11:50 +09004356 * @throws RuntimeException if the app already has too many callbacks registered.
Lorenzo Colitti80b48bc2021-01-29 20:14:04 +09004357 *
4358 * @hide
Hugo Benichicd5a0e02017-02-02 17:02:36 +09004359 */
Lorenzo Colitti80b48bc2021-01-29 20:14:04 +09004360 @SystemApi(client = MODULE_LIBRARIES)
4361 @SuppressLint({"ExecutorRegistration", "PairedRegistration"})
4362 @RequiresPermission(anyOf = {
4363 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
4364 android.Manifest.permission.NETWORK_SETTINGS})
4365 public void registerSystemDefaultNetworkCallback(@NonNull NetworkCallback networkCallback,
Chalard Jean42a9c292019-01-07 19:26:34 +09004366 @NonNull Handler handler) {
Hugo Benichicd5a0e02017-02-02 17:02:36 +09004367 CallbackHandler cbHandler = new CallbackHandler(handler);
Chalard Jean73d9db72018-06-04 16:52:49 +09004368 sendRequestForNetwork(null /* NetworkCapabilities need */, networkCallback, 0,
Lorenzo Colitti80b48bc2021-01-29 20:14:04 +09004369 TRACK_SYSTEM_DEFAULT, TYPE_NONE, cbHandler);
Erik Klinee0aed632016-03-16 15:31:39 +09004370 }
4371
4372 /**
junyulaibd622262021-03-15 11:48:48 +08004373 * Registers to receive notifications about the best matching network which satisfy the given
4374 * {@link NetworkRequest}. The callbacks will continue to be called until
4375 * either the application exits or {@link #unregisterNetworkCallback(NetworkCallback)} is
4376 * called.
4377 *
4378 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4379 * number of outstanding requests to 100 per app (identified by their UID), shared with
4380 * {@link #registerNetworkCallback} and its variants and {@link #requestNetwork} as well as
4381 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4382 * Requesting a network with this method will count toward this limit. If this limit is
4383 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4384 * make sure to unregister the callbacks with
4385 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4386 *
4387 *
4388 * @param request {@link NetworkRequest} describing this request.
4389 * @param networkCallback The {@link NetworkCallback} that the system will call as suitable
4390 * networks change state.
4391 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
4392 * @throws RuntimeException if the app already has too many callbacks registered.
junyulai6b0a6a22021-03-05 15:51:17 +08004393 */
junyulai6b0a6a22021-03-05 15:51:17 +08004394 @SuppressLint("ExecutorRegistration")
4395 public void registerBestMatchingNetworkCallback(@NonNull NetworkRequest request,
4396 @NonNull NetworkCallback networkCallback, @NonNull Handler handler) {
4397 final NetworkCapabilities nc = request.networkCapabilities;
4398 final CallbackHandler cbHandler = new CallbackHandler(handler);
junyulai8cae3c72021-03-12 20:05:08 +08004399 sendRequestForNetwork(nc, networkCallback, 0, LISTEN_FOR_BEST, TYPE_NONE, cbHandler);
junyulai6b0a6a22021-03-05 15:51:17 +08004400 }
4401
4402 /**
fenglu73169332015-04-21 17:12:05 -07004403 * Requests bandwidth update for a given {@link Network} and returns whether the update request
4404 * is accepted by ConnectivityService. Once accepted, ConnectivityService will poll underlying
4405 * network connection for updated bandwidth information. The caller will be notified via
4406 * {@link ConnectivityManager.NetworkCallback} if there is an update. Notice that this
Lorenzo Colittiad458ad2016-04-13 22:00:02 +09004407 * method assumes that the caller has previously called
4408 * {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)} to listen for network
4409 * changes.
fenglu76564332015-03-20 11:29:56 -07004410 *
fenglu41808e82015-04-27 14:28:04 -07004411 * @param network {@link Network} specifying which network you're interested.
fenglu73169332015-04-21 17:12:05 -07004412 * @return {@code true} on success, {@code false} if the {@link Network} is no longer valid.
fenglu76564332015-03-20 11:29:56 -07004413 */
Chalard Jean42a9c292019-01-07 19:26:34 +09004414 public boolean requestBandwidthUpdate(@NonNull Network network) {
fenglu76564332015-03-20 11:29:56 -07004415 try {
fenglu73169332015-04-21 17:12:05 -07004416 return mService.requestBandwidthUpdate(network);
fenglu76564332015-03-20 11:29:56 -07004417 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07004418 throw e.rethrowFromSystemServer();
fenglu76564332015-03-20 11:29:56 -07004419 }
4420 }
4421
4422 /**
Hugo Benichi45a49542017-03-06 09:17:06 +09004423 * Unregisters a {@code NetworkCallback} and possibly releases networks originating from
Lorenzo Colittiad458ad2016-04-13 22:00:02 +09004424 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} and
4425 * {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)} calls.
4426 * If the given {@code NetworkCallback} had previously been used with
Lorenzo Colittiefd396e2015-04-24 17:03:31 +09004427 * {@code #requestNetwork}, any networks that had been connected to only to satisfy that request
4428 * will be disconnected.
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07004429 *
Hugo Benichi45a49542017-03-06 09:17:06 +09004430 * Notifications that would have triggered that {@code NetworkCallback} will immediately stop
4431 * triggering it as soon as this call returns.
4432 *
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07004433 * @param networkCallback The {@link NetworkCallback} used when making the request.
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07004434 */
Chalard Jean42a9c292019-01-07 19:26:34 +09004435 public void unregisterNetworkCallback(@NonNull NetworkCallback networkCallback) {
Soi, Yoshinari99efcbd2015-11-12 12:09:02 +09004436 printStackTrace();
Hugo Benichiff4bf602017-05-09 15:19:01 +09004437 checkCallbackNotNull(networkCallback);
Hugo Benichi45a49542017-03-06 09:17:06 +09004438 final List<NetworkRequest> reqs = new ArrayList<>();
4439 // Find all requests associated to this callback and stop callback triggers immediately.
4440 // Callback is reusable immediately. http://b/20701525, http://b/35921499.
4441 synchronized (sCallbacks) {
Remi NGUYEN VANc4dd8c92021-03-15 07:31:54 +00004442 if (networkCallback.networkRequest == null) {
4443 throw new IllegalArgumentException("NetworkCallback was not registered");
4444 }
Etan Cohene0e2ca92019-04-16 15:07:55 -07004445 if (networkCallback.networkRequest == ALREADY_UNREGISTERED) {
4446 Log.d(TAG, "NetworkCallback was already unregistered");
4447 return;
4448 }
Hugo Benichi45a49542017-03-06 09:17:06 +09004449 for (Map.Entry<NetworkRequest, NetworkCallback> e : sCallbacks.entrySet()) {
4450 if (e.getValue() == networkCallback) {
4451 reqs.add(e.getKey());
4452 }
4453 }
4454 // TODO: throw exception if callback was registered more than once (http://b/20701525).
4455 for (NetworkRequest r : reqs) {
4456 try {
4457 mService.releaseNetworkRequest(r);
4458 } catch (RemoteException e) {
4459 throw e.rethrowFromSystemServer();
4460 }
4461 // Only remove mapping if rpc was successful.
4462 sCallbacks.remove(r);
4463 }
Hugo Benichi1c027fe2017-06-17 13:14:12 +09004464 networkCallback.networkRequest = ALREADY_UNREGISTERED;
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07004465 }
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07004466 }
Paul Jensene98c6e02014-05-29 10:12:39 -04004467
4468 /**
Paul Jensen78f6b802015-06-30 14:29:18 -04004469 * Unregisters a callback previously registered via
4470 * {@link #registerNetworkCallback(NetworkRequest, android.app.PendingIntent)}.
4471 *
4472 * @param operation A PendingIntent equal (as defined by {@link Intent#filterEquals}) to the
4473 * PendingIntent passed to
4474 * {@link #registerNetworkCallback(NetworkRequest, android.app.PendingIntent)}.
4475 * Cannot be null.
4476 */
Chalard Jean42a9c292019-01-07 19:26:34 +09004477 public void unregisterNetworkCallback(@NonNull PendingIntent operation) {
Paul Jensen78f6b802015-06-30 14:29:18 -04004478 releaseNetworkRequest(operation);
4479 }
4480
4481 /**
Lorenzo Colitti36fbebe2015-04-03 16:38:52 +09004482 * Informs the system whether it should switch to {@code network} regardless of whether it is
4483 * validated or not. If {@code accept} is true, and the network was explicitly selected by the
4484 * user (e.g., by selecting a Wi-Fi network in the Settings app), then the network will become
4485 * the system default network regardless of any other network that's currently connected. If
4486 * {@code always} is true, then the choice is remembered, so that the next time the user
4487 * connects to this network, the system will switch to it.
4488 *
Lorenzo Colitti36fbebe2015-04-03 16:38:52 +09004489 * @param network The network to accept.
4490 * @param accept Whether to accept the network even if unvalidated.
4491 * @param always Whether to remember this choice in the future.
4492 *
4493 * @hide
4494 */
Chiachang Wang0cefc1c2021-03-18 09:44:34 +08004495 @SystemApi(client = MODULE_LIBRARIES)
4496 @RequiresPermission(anyOf = {
4497 android.Manifest.permission.NETWORK_SETTINGS,
4498 android.Manifest.permission.NETWORK_SETUP_WIZARD,
4499 android.Manifest.permission.NETWORK_STACK,
4500 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK})
4501 public void setAcceptUnvalidated(@NonNull Network network, boolean accept, boolean always) {
Lorenzo Colitti36fbebe2015-04-03 16:38:52 +09004502 try {
4503 mService.setAcceptUnvalidated(network, accept, always);
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07004504 } catch (RemoteException e) {
4505 throw e.rethrowFromSystemServer();
4506 }
Lorenzo Colitti36fbebe2015-04-03 16:38:52 +09004507 }
4508
4509 /**
lucaslin25a50472019-03-12 13:08:03 +08004510 * Informs the system whether it should consider the network as validated even if it only has
4511 * partial connectivity. If {@code accept} is true, then the network will be considered as
4512 * validated even if connectivity is only partial. If {@code always} is true, then the choice
4513 * is remembered, so that the next time the user connects to this network, the system will
4514 * switch to it.
4515 *
4516 * @param network The network to accept.
4517 * @param accept Whether to consider the network as validated even if it has partial
4518 * connectivity.
4519 * @param always Whether to remember this choice in the future.
4520 *
4521 * @hide
4522 */
Chiachang Wang0cefc1c2021-03-18 09:44:34 +08004523 @SystemApi(client = MODULE_LIBRARIES)
4524 @RequiresPermission(anyOf = {
4525 android.Manifest.permission.NETWORK_SETTINGS,
4526 android.Manifest.permission.NETWORK_SETUP_WIZARD,
4527 android.Manifest.permission.NETWORK_STACK,
4528 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK})
4529 public void setAcceptPartialConnectivity(@NonNull Network network, boolean accept,
4530 boolean always) {
lucaslin25a50472019-03-12 13:08:03 +08004531 try {
4532 mService.setAcceptPartialConnectivity(network, accept, always);
4533 } catch (RemoteException e) {
4534 throw e.rethrowFromSystemServer();
4535 }
4536 }
4537
4538 /**
Lorenzo Colittie98557f2016-09-19 01:00:19 +09004539 * Informs the system to penalize {@code network}'s score when it becomes unvalidated. This is
4540 * only meaningful if the system is configured not to penalize such networks, e.g., if the
4541 * {@code config_networkAvoidBadWifi} configuration variable is set to 0 and the {@code
4542 * NETWORK_AVOID_BAD_WIFI setting is unset}.
4543 *
Lorenzo Colittie98557f2016-09-19 01:00:19 +09004544 * @param network The network to accept.
4545 *
4546 * @hide
4547 */
Chiachang Wang0cefc1c2021-03-18 09:44:34 +08004548 @SystemApi(client = MODULE_LIBRARIES)
4549 @RequiresPermission(anyOf = {
4550 android.Manifest.permission.NETWORK_SETTINGS,
4551 android.Manifest.permission.NETWORK_SETUP_WIZARD,
4552 android.Manifest.permission.NETWORK_STACK,
4553 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK})
4554 public void setAvoidUnvalidated(@NonNull Network network) {
Lorenzo Colittie98557f2016-09-19 01:00:19 +09004555 try {
4556 mService.setAvoidUnvalidated(network);
4557 } catch (RemoteException e) {
4558 throw e.rethrowFromSystemServer();
4559 }
4560 }
4561
4562 /**
Lorenzo Colitti755e7962017-04-27 14:30:21 +09004563 * Requests that the system open the captive portal app on the specified network.
4564 *
Remi NGUYEN VANbffe51d2021-03-16 18:06:06 +09004565 * <p>This is to be used on networks where a captive portal was detected, as per
4566 * {@link NetworkCapabilities#NET_CAPABILITY_CAPTIVE_PORTAL}.
4567 *
Lorenzo Colitti755e7962017-04-27 14:30:21 +09004568 * @param network The network to log into.
4569 *
4570 * @hide
4571 */
Remi NGUYEN VANbffe51d2021-03-16 18:06:06 +09004572 @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
4573 @RequiresPermission(anyOf = {
4574 android.Manifest.permission.NETWORK_SETTINGS,
4575 android.Manifest.permission.NETWORK_STACK,
4576 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK
4577 })
4578 public void startCaptivePortalApp(@NonNull Network network) {
Lorenzo Colitti755e7962017-04-27 14:30:21 +09004579 try {
4580 mService.startCaptivePortalApp(network);
4581 } catch (RemoteException e) {
4582 throw e.rethrowFromSystemServer();
4583 }
4584 }
4585
4586 /**
Remi NGUYEN VANf363f5f2019-02-04 11:32:20 +09004587 * Requests that the system open the captive portal app with the specified extras.
4588 *
4589 * <p>This endpoint is exclusively for use by the NetworkStack and is protected by the
4590 * corresponding permission.
Remi NGUYEN VAN89fbdc32019-02-13 20:58:59 +09004591 * @param network Network on which the captive portal was detected.
Remi NGUYEN VANf363f5f2019-02-04 11:32:20 +09004592 * @param appExtras Extras to include in the app start intent.
4593 * @hide
4594 */
4595 @SystemApi
Remi NGUYEN VANf363f5f2019-02-04 11:32:20 +09004596 @RequiresPermission(NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK)
paulhu9bb04802019-03-08 16:35:20 +08004597 public void startCaptivePortalApp(@NonNull Network network, @NonNull Bundle appExtras) {
Remi NGUYEN VANf363f5f2019-02-04 11:32:20 +09004598 try {
Remi NGUYEN VAN89fbdc32019-02-13 20:58:59 +09004599 mService.startCaptivePortalAppInternal(network, appExtras);
Remi NGUYEN VANf363f5f2019-02-04 11:32:20 +09004600 } catch (RemoteException e) {
4601 throw e.rethrowFromSystemServer();
4602 }
4603 }
4604
4605 /**
Remi NGUYEN VAN3436b6f2019-01-20 20:35:06 +09004606 * Determine whether the device is configured to avoid bad wifi.
4607 * @hide
4608 */
4609 @SystemApi
Remi NGUYEN VAN338eb2a2019-03-22 11:14:13 +09004610 @RequiresPermission(anyOf = {
4611 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
4612 android.Manifest.permission.NETWORK_STACK})
4613 public boolean shouldAvoidBadWifi() {
Remi NGUYEN VAN3436b6f2019-01-20 20:35:06 +09004614 try {
Remi NGUYEN VAN338eb2a2019-03-22 11:14:13 +09004615 return mService.shouldAvoidBadWifi();
Remi NGUYEN VAN3436b6f2019-01-20 20:35:06 +09004616 } catch (RemoteException e) {
4617 throw e.rethrowFromSystemServer();
4618 }
4619 }
4620
4621 /**
Lorenzo Colitti231efb02017-01-24 18:08:41 +09004622 * It is acceptable to briefly use multipath data to provide seamless connectivity for
4623 * time-sensitive user-facing operations when the system default network is temporarily
Lorenzo Colitti38ea8102017-04-28 00:56:30 +09004624 * unresponsive. The amount of data should be limited (less than one megabyte for every call to
4625 * this method), and the operation should be infrequent to ensure that data usage is limited.
Lorenzo Colitti231efb02017-01-24 18:08:41 +09004626 *
4627 * An example of such an operation might be a time-sensitive foreground activity, such as a
4628 * voice command, that the user is performing while walking out of range of a Wi-Fi network.
4629 */
4630 public static final int MULTIPATH_PREFERENCE_HANDOVER = 1 << 0;
4631
4632 /**
4633 * It is acceptable to use small amounts of multipath data on an ongoing basis to provide
4634 * a backup channel for traffic that is primarily going over another network.
4635 *
4636 * An example might be maintaining backup connections to peers or servers for the purpose of
4637 * fast fallback if the default network is temporarily unresponsive or disconnects. The traffic
4638 * on backup paths should be negligible compared to the traffic on the main path.
4639 */
4640 public static final int MULTIPATH_PREFERENCE_RELIABILITY = 1 << 1;
4641
4642 /**
4643 * It is acceptable to use metered data to improve network latency and performance.
4644 */
4645 public static final int MULTIPATH_PREFERENCE_PERFORMANCE = 1 << 2;
4646
4647 /**
4648 * Return value to use for unmetered networks. On such networks we currently set all the flags
4649 * to true.
4650 * @hide
4651 */
4652 public static final int MULTIPATH_PREFERENCE_UNMETERED =
4653 MULTIPATH_PREFERENCE_HANDOVER |
4654 MULTIPATH_PREFERENCE_RELIABILITY |
4655 MULTIPATH_PREFERENCE_PERFORMANCE;
4656
4657 /** @hide */
4658 @Retention(RetentionPolicy.SOURCE)
4659 @IntDef(flag = true, value = {
4660 MULTIPATH_PREFERENCE_HANDOVER,
4661 MULTIPATH_PREFERENCE_RELIABILITY,
4662 MULTIPATH_PREFERENCE_PERFORMANCE,
4663 })
4664 public @interface MultipathPreference {
4665 }
4666
4667 /**
4668 * Provides a hint to the calling application on whether it is desirable to use the
4669 * multinetwork APIs (e.g., {@link Network#openConnection}, {@link Network#bindSocket}, etc.)
4670 * for multipath data transfer on this network when it is not the system default network.
4671 * Applications desiring to use multipath network protocols should call this method before
4672 * each such operation.
Lorenzo Colitti231efb02017-01-24 18:08:41 +09004673 *
4674 * @param network The network on which the application desires to use multipath data.
4675 * If {@code null}, this method will return the a preference that will generally
4676 * apply to metered networks.
4677 * @return a bitwise OR of zero or more of the {@code MULTIPATH_PREFERENCE_*} constants.
4678 */
Jeff Sharkey2ac62992017-04-24 11:18:03 -06004679 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean42a9c292019-01-07 19:26:34 +09004680 public @MultipathPreference int getMultipathPreference(@Nullable Network network) {
Lorenzo Colitti231efb02017-01-24 18:08:41 +09004681 try {
4682 return mService.getMultipathPreference(network);
4683 } catch (RemoteException e) {
4684 throw e.rethrowFromSystemServer();
4685 }
4686 }
4687
4688 /**
Stuart Scottd3bb5082015-03-30 13:17:11 -07004689 * Resets all connectivity manager settings back to factory defaults.
4690 * @hide
4691 */
Chiachang Wang0cefc1c2021-03-18 09:44:34 +08004692 @SystemApi(client = MODULE_LIBRARIES)
4693 @RequiresPermission(anyOf = {
4694 android.Manifest.permission.NETWORK_SETTINGS,
4695 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK})
Stuart Scottd3bb5082015-03-30 13:17:11 -07004696 public void factoryReset() {
Stuart Scottd3bb5082015-03-30 13:17:11 -07004697 try {
Stuart Scottca888bf2015-04-02 18:00:02 -07004698 mService.factoryReset();
Automerger Merge Worker9b0c0c62020-03-06 00:38:43 +00004699 mTetheringManager.stopAllTethering();
Stuart Scottd3bb5082015-03-30 13:17:11 -07004700 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07004701 throw e.rethrowFromSystemServer();
Stuart Scottd3bb5082015-03-30 13:17:11 -07004702 }
4703 }
4704
4705 /**
Paul Jensene98c6e02014-05-29 10:12:39 -04004706 * Binds the current process to {@code network}. All Sockets created in the future
4707 * (and not explicitly bound via a bound SocketFactory from
4708 * {@link Network#getSocketFactory() Network.getSocketFactory()}) will be bound to
4709 * {@code network}. All host name resolutions will be limited to {@code network} as well.
4710 * Note that if {@code network} ever disconnects, all Sockets created in this way will cease to
4711 * work and all host name resolutions will fail. This is by design so an application doesn't
4712 * accidentally use Sockets it thinks are still bound to a particular {@link Network}.
4713 * To clear binding pass {@code null} for {@code network}. Using individually bound
4714 * Sockets created by Network.getSocketFactory().createSocket() and
4715 * performing network-specific host name resolutions via
4716 * {@link Network#getAllByName Network.getAllByName} is preferred to calling
Paul Jensen895c3942015-03-10 10:54:12 -04004717 * {@code bindProcessToNetwork}.
Paul Jensene98c6e02014-05-29 10:12:39 -04004718 *
4719 * @param network The {@link Network} to bind the current process to, or {@code null} to clear
4720 * the current binding.
4721 * @return {@code true} on success, {@code false} if the {@link Network} is no longer valid.
4722 */
Chalard Jean42a9c292019-01-07 19:26:34 +09004723 public boolean bindProcessToNetwork(@Nullable Network network) {
Chalard Jean73d9db72018-06-04 16:52:49 +09004724 // Forcing callers to call through non-static function ensures ConnectivityManager
Paul Jensen895c3942015-03-10 10:54:12 -04004725 // instantiated.
4726 return setProcessDefaultNetwork(network);
4727 }
4728
4729 /**
4730 * Binds the current process to {@code network}. All Sockets created in the future
4731 * (and not explicitly bound via a bound SocketFactory from
4732 * {@link Network#getSocketFactory() Network.getSocketFactory()}) will be bound to
4733 * {@code network}. All host name resolutions will be limited to {@code network} as well.
4734 * Note that if {@code network} ever disconnects, all Sockets created in this way will cease to
4735 * work and all host name resolutions will fail. This is by design so an application doesn't
4736 * accidentally use Sockets it thinks are still bound to a particular {@link Network}.
4737 * To clear binding pass {@code null} for {@code network}. Using individually bound
4738 * Sockets created by Network.getSocketFactory().createSocket() and
4739 * performing network-specific host name resolutions via
4740 * {@link Network#getAllByName Network.getAllByName} is preferred to calling
4741 * {@code setProcessDefaultNetwork}.
4742 *
4743 * @param network The {@link Network} to bind the current process to, or {@code null} to clear
4744 * the current binding.
4745 * @return {@code true} on success, {@code false} if the {@link Network} is no longer valid.
4746 * @deprecated This function can throw {@link IllegalStateException}. Use
4747 * {@link #bindProcessToNetwork} instead. {@code bindProcessToNetwork}
4748 * is a direct replacement.
4749 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -07004750 @Deprecated
Chalard Jean42a9c292019-01-07 19:26:34 +09004751 public static boolean setProcessDefaultNetwork(@Nullable Network network) {
Paul Jensen99c36662014-08-27 12:38:45 -04004752 int netId = (network == null) ? NETID_UNSET : network.netId;
Lorenzo Colitti3fadff92019-01-31 13:08:24 +09004753 boolean isSameNetId = (netId == NetworkUtils.getBoundNetworkForProcess());
4754
Lorenzo Colitti580483e2019-01-30 23:04:54 +09004755 if (netId != NETID_UNSET) {
4756 netId = network.getNetIdForResolv();
Paul Jensen99c36662014-08-27 12:38:45 -04004757 }
Lorenzo Colitti3fadff92019-01-31 13:08:24 +09004758
4759 if (!NetworkUtils.bindProcessToNetwork(netId)) {
4760 return false;
4761 }
4762
4763 if (!isSameNetId) {
Paul Jensen12131352014-12-10 15:12:18 -05004764 // Set HTTP proxy system properties to match network.
4765 // TODO: Deprecate this static method and replace it with a non-static version.
Lorenzo Colitti40898252015-04-22 11:52:48 +09004766 try {
Remi NGUYEN VANa1860ff2021-02-03 10:18:20 +09004767 Proxy.setHttpProxyConfiguration(getInstance().getDefaultProxy());
Lorenzo Colitti40898252015-04-22 11:52:48 +09004768 } catch (SecurityException e) {
4769 // The process doesn't have ACCESS_NETWORK_STATE, so we can't fetch the proxy.
4770 Log.e(TAG, "Can't set proxy properties", e);
4771 }
Paul Jensen99c36662014-08-27 12:38:45 -04004772 // Must flush DNS cache as new network may have different DNS resolutions.
Remi NGUYEN VAN33e3abb2021-03-18 23:27:19 +09004773 InetAddressCompat.clearDnsCache();
Paul Jensen99c36662014-08-27 12:38:45 -04004774 // Must flush socket pool as idle sockets will be bound to previous network and may
4775 // cause subsequent fetches to be performed on old network.
4776 NetworkEventDispatcher.getInstance().onNetworkConfigurationChanged();
Paul Jensen99c36662014-08-27 12:38:45 -04004777 }
Lorenzo Colitti3fadff92019-01-31 13:08:24 +09004778
4779 return true;
Paul Jensene98c6e02014-05-29 10:12:39 -04004780 }
4781
4782 /**
4783 * Returns the {@link Network} currently bound to this process via
Paul Jensen895c3942015-03-10 10:54:12 -04004784 * {@link #bindProcessToNetwork}, or {@code null} if no {@link Network} is explicitly bound.
Paul Jensene98c6e02014-05-29 10:12:39 -04004785 *
4786 * @return {@code Network} to which this process is bound, or {@code null}.
4787 */
Chalard Jean42a9c292019-01-07 19:26:34 +09004788 @Nullable
Paul Jensen895c3942015-03-10 10:54:12 -04004789 public Network getBoundNetworkForProcess() {
4790 // Forcing callers to call thru non-static function ensures ConnectivityManager
4791 // instantiated.
4792 return getProcessDefaultNetwork();
4793 }
4794
4795 /**
4796 * Returns the {@link Network} currently bound to this process via
4797 * {@link #bindProcessToNetwork}, or {@code null} if no {@link Network} is explicitly bound.
4798 *
4799 * @return {@code Network} to which this process is bound, or {@code null}.
4800 * @deprecated Using this function can lead to other functions throwing
4801 * {@link IllegalStateException}. Use {@link #getBoundNetworkForProcess} instead.
4802 * {@code getBoundNetworkForProcess} is a direct replacement.
4803 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -07004804 @Deprecated
Chalard Jean42a9c292019-01-07 19:26:34 +09004805 @Nullable
Paul Jensene98c6e02014-05-29 10:12:39 -04004806 public static Network getProcessDefaultNetwork() {
Paul Jensen895c3942015-03-10 10:54:12 -04004807 int netId = NetworkUtils.getBoundNetworkForProcess();
Paul Jensen8b6260f2014-07-11 08:17:29 -04004808 if (netId == NETID_UNSET) return null;
Paul Jensene98c6e02014-05-29 10:12:39 -04004809 return new Network(netId);
4810 }
4811
Lorenzo Colitti9b026fa2015-07-29 11:41:21 +09004812 private void unsupportedStartingFrom(int version) {
4813 if (Process.myUid() == Process.SYSTEM_UID) {
Lorenzo Colitti62f752c2018-09-28 11:31:55 +09004814 // The getApplicationInfo() call we make below is not supported in system context. Let
4815 // the call through here, and rely on the fact that ConnectivityService will refuse to
4816 // allow the system to use these APIs anyway.
Lorenzo Colitti9b026fa2015-07-29 11:41:21 +09004817 return;
4818 }
4819
4820 if (mContext.getApplicationInfo().targetSdkVersion >= version) {
4821 throw new UnsupportedOperationException(
4822 "This method is not supported in target SDK version " + version + " and above");
4823 }
4824 }
4825
4826 // Checks whether the calling app can use the legacy routing API (startUsingNetworkFeature,
4827 // stopUsingNetworkFeature, requestRouteToHost), and if not throw UnsupportedOperationException.
Lifu Tangae4adaa2016-01-07 23:20:38 -08004828 // TODO: convert the existing system users (Tethering, GnssLocationProvider) to the new APIs and
Lorenzo Colitti9b026fa2015-07-29 11:41:21 +09004829 // remove these exemptions. Note that this check is not secure, and apps can still access these
4830 // functions by accessing ConnectivityService directly. However, it should be clear that doing
4831 // so is unsupported and may break in the future. http://b/22728205
4832 private void checkLegacyRoutingApiAccess() {
Dianne Hackbornc16abda2015-07-31 10:35:34 -07004833 unsupportedStartingFrom(VERSION_CODES.M);
Lorenzo Colitti9b026fa2015-07-29 11:41:21 +09004834 }
4835
Paul Jensene98c6e02014-05-29 10:12:39 -04004836 /**
4837 * Binds host resolutions performed by this process to {@code network}.
Paul Jensen895c3942015-03-10 10:54:12 -04004838 * {@link #bindProcessToNetwork} takes precedence over this setting.
Paul Jensene98c6e02014-05-29 10:12:39 -04004839 *
4840 * @param network The {@link Network} to bind host resolutions from the current process to, or
4841 * {@code null} to clear the current binding.
4842 * @return {@code true} on success, {@code false} if the {@link Network} is no longer valid.
4843 * @hide
4844 * @deprecated This is strictly for legacy usage to support {@link #startUsingNetworkFeature}.
4845 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -07004846 @Deprecated
Mathew Inwoodd078d3d2020-10-27 11:47:29 +00004847 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
Paul Jensene98c6e02014-05-29 10:12:39 -04004848 public static boolean setProcessDefaultNetworkForHostResolution(Network network) {
Paul Jensen8b6260f2014-07-11 08:17:29 -04004849 return NetworkUtils.bindProcessToNetworkForHostResolution(
Erik Klinef2420792018-04-27 22:48:33 +09004850 (network == null) ? NETID_UNSET : network.getNetIdForResolv());
Paul Jensene98c6e02014-05-29 10:12:39 -04004851 }
Felipe Lemed16384b2016-01-22 09:44:57 -08004852
4853 /**
4854 * Device is not restricting metered network activity while application is running on
4855 * background.
4856 */
4857 public static final int RESTRICT_BACKGROUND_STATUS_DISABLED = 1;
4858
4859 /**
4860 * Device is restricting metered network activity while application is running on background,
4861 * but application is allowed to bypass it.
4862 * <p>
4863 * In this state, application should take action to mitigate metered network access.
4864 * For example, a music streaming application should switch to a low-bandwidth bitrate.
4865 */
4866 public static final int RESTRICT_BACKGROUND_STATUS_WHITELISTED = 2;
4867
4868 /**
4869 * Device is restricting metered network activity while application is running on background.
Felipe Leme6a5b7692016-01-27 14:46:39 -08004870 * <p>
Felipe Lemed16384b2016-01-22 09:44:57 -08004871 * In this state, application should not try to use the network while running on background,
4872 * because it would be denied.
4873 */
4874 public static final int RESTRICT_BACKGROUND_STATUS_ENABLED = 3;
4875
Felipe Leme6a5b7692016-01-27 14:46:39 -08004876 /**
4877 * A change in the background metered network activity restriction has occurred.
4878 * <p>
4879 * Applications should call {@link #getRestrictBackgroundStatus()} to check if the restriction
4880 * applies to them.
4881 * <p>
4882 * This is only sent to registered receivers, not manifest receivers.
4883 */
4884 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
4885 public static final String ACTION_RESTRICT_BACKGROUND_CHANGED =
4886 "android.net.conn.RESTRICT_BACKGROUND_CHANGED";
4887
Felipe Leme1b42ef92016-01-25 11:48:04 -08004888 /** @hide */
4889 @Retention(RetentionPolicy.SOURCE)
Felipe Lemed16384b2016-01-22 09:44:57 -08004890 @IntDef(flag = false, value = {
4891 RESTRICT_BACKGROUND_STATUS_DISABLED,
4892 RESTRICT_BACKGROUND_STATUS_WHITELISTED,
4893 RESTRICT_BACKGROUND_STATUS_ENABLED,
4894 })
Felipe Lemed16384b2016-01-22 09:44:57 -08004895 public @interface RestrictBackgroundStatus {
4896 }
4897
Felipe Lemed16384b2016-01-22 09:44:57 -08004898 /**
4899 * Determines if the calling application is subject to metered network restrictions while
4900 * running on background.
Felipe Leme6bd46fc2016-05-16 13:57:19 -07004901 *
4902 * @return {@link #RESTRICT_BACKGROUND_STATUS_DISABLED},
4903 * {@link #RESTRICT_BACKGROUND_STATUS_ENABLED},
4904 * or {@link #RESTRICT_BACKGROUND_STATUS_WHITELISTED}
Felipe Lemed16384b2016-01-22 09:44:57 -08004905 */
4906 public @RestrictBackgroundStatus int getRestrictBackgroundStatus() {
4907 try {
Remi NGUYEN VAN92f20602021-03-18 14:23:12 +09004908 return mService.getRestrictBackgroundStatusByCaller();
Felipe Lemed16384b2016-01-22 09:44:57 -08004909 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07004910 throw e.rethrowFromSystemServer();
Felipe Lemed16384b2016-01-22 09:44:57 -08004911 }
4912 }
Ricky Waid53cf002018-01-23 04:09:45 +00004913
4914 /**
4915 * The network watchlist is a list of domains and IP addresses that are associated with
Ricky Wai573dcab2018-03-20 14:20:54 +00004916 * potentially harmful apps. This method returns the SHA-256 of the watchlist config file
4917 * currently used by the system for validation purposes.
Ricky Waid53cf002018-01-23 04:09:45 +00004918 *
4919 * @return Hash of network watchlist config file. Null if config does not exist.
4920 */
Chalard Jean42a9c292019-01-07 19:26:34 +09004921 @Nullable
Ricky Waid53cf002018-01-23 04:09:45 +00004922 public byte[] getNetworkWatchlistConfigHash() {
4923 try {
4924 return mService.getNetworkWatchlistConfigHash();
4925 } catch (RemoteException e) {
4926 Log.e(TAG, "Unable to get watchlist config hash");
4927 throw e.rethrowFromSystemServer();
4928 }
4929 }
Jeff Vander Stoepe7205d62018-07-23 10:57:53 -07004930
4931 /**
4932 * Returns the {@code uid} of the owner of a network connection.
4933 *
Benedict Wong8974a1c2020-01-20 22:14:59 -08004934 * @param protocol The protocol of the connection. Only {@code IPPROTO_TCP} and {@code
4935 * IPPROTO_UDP} currently supported.
Jeff Vander Stoepe7205d62018-07-23 10:57:53 -07004936 * @param local The local {@link InetSocketAddress} of a connection.
4937 * @param remote The remote {@link InetSocketAddress} of a connection.
Jeff Vander Stoepe7205d62018-07-23 10:57:53 -07004938 * @return {@code uid} if the connection is found and the app has permission to observe it
Benedict Wong8974a1c2020-01-20 22:14:59 -08004939 * (e.g., if it is associated with the calling VPN app's VpnService tunnel) or {@link
4940 * android.os.Process#INVALID_UID} if the connection is not found.
4941 * @throws {@link SecurityException} if the caller is not the active VpnService for the current
4942 * user.
4943 * @throws {@link IllegalArgumentException} if an unsupported protocol is requested.
Jeff Vander Stoepe7205d62018-07-23 10:57:53 -07004944 */
Benedict Wong8974a1c2020-01-20 22:14:59 -08004945 public int getConnectionOwnerUid(
4946 int protocol, @NonNull InetSocketAddress local, @NonNull InetSocketAddress remote) {
Jeff Vander Stoepe7205d62018-07-23 10:57:53 -07004947 ConnectionInfo connectionInfo = new ConnectionInfo(protocol, local, remote);
4948 try {
4949 return mService.getConnectionOwnerUid(connectionInfo);
4950 } catch (RemoteException e) {
4951 throw e.rethrowFromSystemServer();
4952 }
4953 }
Soi, Yoshinari99efcbd2015-11-12 12:09:02 +09004954
4955 private void printStackTrace() {
4956 if (DEBUG) {
4957 final StackTraceElement[] callStack = Thread.currentThread().getStackTrace();
4958 final StringBuffer sb = new StringBuffer();
4959 for (int i = 3; i < callStack.length; i++) {
4960 final String stackTrace = callStack[i].toString();
4961 if (stackTrace == null || stackTrace.contains("android.os")) {
4962 break;
4963 }
4964 sb.append(" [").append(stackTrace).append("]");
4965 }
4966 Log.d(TAG, "StackLog:" + sb.toString());
4967 }
4968 }
Cody Kestingb5c7abd2020-04-15 12:33:28 -07004969
Remi NGUYEN VANfe97b482021-01-15 23:02:47 +09004970 /** @hide */
4971 public TestNetworkManager startOrGetTestNetworkManager() {
4972 final IBinder tnBinder;
4973 try {
4974 tnBinder = mService.startOrGetTestNetworkService();
4975 } catch (RemoteException e) {
4976 throw e.rethrowFromSystemServer();
4977 }
4978
4979 return new TestNetworkManager(ITestNetworkManager.Stub.asInterface(tnBinder));
4980 }
4981
Remi NGUYEN VANfe97b482021-01-15 23:02:47 +09004982 /** @hide */
4983 public ConnectivityDiagnosticsManager createDiagnosticsManager() {
4984 return new ConnectivityDiagnosticsManager(mContext, mService);
4985 }
4986
Cody Kestingb5c7abd2020-04-15 12:33:28 -07004987 /**
4988 * Simulates a Data Stall for the specified Network.
4989 *
Remi NGUYEN VAN7d4530b2021-01-12 18:40:04 +09004990 * <p>This method should only be used for tests.
4991 *
Cody Kestingb5c7abd2020-04-15 12:33:28 -07004992 * <p>The caller must be the owner of the specified Network.
4993 *
4994 * @param detectionMethod The detection method used to identify the Data Stall.
4995 * @param timestampMillis The timestamp at which the stall 'occurred', in milliseconds.
4996 * @param network The Network for which a Data Stall is being simluated.
4997 * @param extras The PersistableBundle of extras included in the Data Stall notification.
4998 * @throws SecurityException if the caller is not the owner of the given network.
4999 * @hide
5000 */
Remi NGUYEN VAN7d4530b2021-01-12 18:40:04 +09005001 @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
Cody Kestingb5c7abd2020-04-15 12:33:28 -07005002 @RequiresPermission(anyOf = {android.Manifest.permission.MANAGE_TEST_NETWORKS,
5003 android.Manifest.permission.NETWORK_STACK})
5004 public void simulateDataStall(int detectionMethod, long timestampMillis,
5005 @NonNull Network network, @NonNull PersistableBundle extras) {
5006 try {
5007 mService.simulateDataStall(detectionMethod, timestampMillis, network, extras);
5008 } catch (RemoteException e) {
5009 e.rethrowFromSystemServer();
5010 }
5011 }
James Mattisdcea9fb2020-10-28 21:48:54 -07005012
Daniel Bright60f02ed2020-06-15 16:10:01 -07005013 @NonNull
5014 private final List<QosCallbackConnection> mQosCallbackConnections = new ArrayList<>();
5015
5016 /**
5017 * Registers a {@link QosSocketInfo} with an associated {@link QosCallback}. The callback will
5018 * receive available QoS events related to the {@link Network} and local ip + port
5019 * specified within socketInfo.
5020 * <p/>
5021 * The same {@link QosCallback} must be unregistered before being registered a second time,
5022 * otherwise {@link QosCallbackRegistrationException} is thrown.
5023 * <p/>
5024 * This API does not, in itself, require any permission if called with a network that is not
5025 * restricted. However, the underlying implementation currently only supports the IMS network,
5026 * which is always restricted. That means non-preinstalled callers can't possibly find this API
5027 * useful, because they'd never be called back on networks that they would have access to.
5028 *
5029 * @throws SecurityException if {@link QosSocketInfo#getNetwork()} is restricted and the app is
5030 * missing CONNECTIVITY_USE_RESTRICTED_NETWORKS permission.
5031 * @throws QosCallback.QosCallbackRegistrationException if qosCallback is already registered.
5032 * @throws RuntimeException if the app already has too many callbacks registered.
5033 *
5034 * Exceptions after the time of registration is passed through
5035 * {@link QosCallback#onError(QosCallbackException)}. see: {@link QosCallbackException}.
5036 *
5037 * @param socketInfo the socket information used to match QoS events
Daniel Bright60f02ed2020-06-15 16:10:01 -07005038 * @param executor The executor on which the callback will be invoked. The provided
5039 * {@link Executor} must run callback sequentially, otherwise the order of
Daniel Brightb953a3e2021-03-10 11:51:50 -08005040 * callbacks cannot be guaranteed.onQosCallbackRegistered
5041 * @param callback receives qos events that satisfy socketInfo
Daniel Bright60f02ed2020-06-15 16:10:01 -07005042 *
5043 * @hide
5044 */
5045 @SystemApi
5046 public void registerQosCallback(@NonNull final QosSocketInfo socketInfo,
Daniel Brightb953a3e2021-03-10 11:51:50 -08005047 @CallbackExecutor @NonNull final Executor executor,
5048 @NonNull final QosCallback callback) {
Daniel Bright60f02ed2020-06-15 16:10:01 -07005049 Objects.requireNonNull(socketInfo, "socketInfo must be non-null");
Daniel Bright60f02ed2020-06-15 16:10:01 -07005050 Objects.requireNonNull(executor, "executor must be non-null");
Daniel Brightb953a3e2021-03-10 11:51:50 -08005051 Objects.requireNonNull(callback, "callback must be non-null");
Daniel Bright60f02ed2020-06-15 16:10:01 -07005052
5053 try {
5054 synchronized (mQosCallbackConnections) {
5055 if (getQosCallbackConnection(callback) == null) {
5056 final QosCallbackConnection connection =
5057 new QosCallbackConnection(this, callback, executor);
5058 mQosCallbackConnections.add(connection);
5059 mService.registerQosSocketCallback(socketInfo, connection);
5060 } else {
5061 Log.e(TAG, "registerQosCallback: Callback already registered");
5062 throw new QosCallbackRegistrationException();
5063 }
5064 }
5065 } catch (final RemoteException e) {
5066 Log.e(TAG, "registerQosCallback: Error while registering ", e);
5067
5068 // The same unregister method method is called for consistency even though nothing
5069 // will be sent to the ConnectivityService since the callback was never successfully
5070 // registered.
5071 unregisterQosCallback(callback);
5072 e.rethrowFromSystemServer();
5073 } catch (final ServiceSpecificException e) {
5074 Log.e(TAG, "registerQosCallback: Error while registering ", e);
5075 unregisterQosCallback(callback);
5076 throw convertServiceException(e);
5077 }
5078 }
5079
5080 /**
5081 * Unregisters the given {@link QosCallback}. The {@link QosCallback} will no longer receive
5082 * events once unregistered and can be registered a second time.
5083 * <p/>
5084 * If the {@link QosCallback} does not have an active registration, it is a no-op.
5085 *
5086 * @param callback the callback being unregistered
5087 *
5088 * @hide
5089 */
5090 @SystemApi
5091 public void unregisterQosCallback(@NonNull final QosCallback callback) {
5092 Objects.requireNonNull(callback, "The callback must be non-null");
5093 try {
5094 synchronized (mQosCallbackConnections) {
5095 final QosCallbackConnection connection = getQosCallbackConnection(callback);
5096 if (connection != null) {
5097 connection.stopReceivingMessages();
5098 mService.unregisterQosCallback(connection);
5099 mQosCallbackConnections.remove(connection);
5100 } else {
5101 Log.d(TAG, "unregisterQosCallback: Callback not registered");
5102 }
5103 }
5104 } catch (final RemoteException e) {
5105 Log.e(TAG, "unregisterQosCallback: Error while unregistering ", e);
5106 e.rethrowFromSystemServer();
5107 }
5108 }
5109
5110 /**
5111 * Gets the connection related to the callback.
5112 *
5113 * @param callback the callback to look up
5114 * @return the related connection
5115 */
5116 @Nullable
5117 private QosCallbackConnection getQosCallbackConnection(final QosCallback callback) {
5118 for (final QosCallbackConnection connection : mQosCallbackConnections) {
5119 // Checking by reference here is intentional
5120 if (connection.getCallback() == callback) {
5121 return connection;
5122 }
5123 }
5124 return null;
5125 }
Junyu Lai23568a42021-01-19 11:10:56 +00005126
5127 /**
Roshan Pius7992afd2020-12-22 15:10:42 -08005128 * Request a network to satisfy a set of {@link NetworkCapabilities}, but
Junyu Lai23568a42021-01-19 11:10:56 +00005129 * does not cause any networks to retain the NET_CAPABILITY_FOREGROUND capability. This can
5130 * be used to request that the system provide a network without causing the network to be
5131 * in the foreground.
5132 *
5133 * <p>This method will attempt to find the best network that matches the passed
5134 * {@link NetworkRequest}, and to bring up one that does if none currently satisfies the
5135 * criteria. The platform will evaluate which network is the best at its own discretion.
5136 * Throughput, latency, cost per byte, policy, user preference and other considerations
5137 * may be factored in the decision of what is considered the best network.
5138 *
5139 * <p>As long as this request is outstanding, the platform will try to maintain the best network
5140 * matching this request, while always attempting to match the request to a better network if
5141 * possible. If a better match is found, the platform will switch this request to the now-best
5142 * network and inform the app of the newly best network by invoking
5143 * {@link NetworkCallback#onAvailable(Network)} on the provided callback. Note that the platform
5144 * will not try to maintain any other network than the best one currently matching the request:
5145 * a network not matching any network request may be disconnected at any time.
5146 *
5147 * <p>For example, an application could use this method to obtain a connected cellular network
5148 * even if the device currently has a data connection over Ethernet. This may cause the cellular
5149 * radio to consume additional power. Or, an application could inform the system that it wants
5150 * a network supporting sending MMSes and have the system let it know about the currently best
5151 * MMS-supporting network through the provided {@link NetworkCallback}.
5152 *
5153 * <p>The status of the request can be followed by listening to the various callbacks described
5154 * in {@link NetworkCallback}. The {@link Network} object passed to the callback methods can be
5155 * used to direct traffic to the network (although accessing some networks may be subject to
5156 * holding specific permissions). Callers will learn about the specific characteristics of the
5157 * network through
5158 * {@link NetworkCallback#onCapabilitiesChanged(Network, NetworkCapabilities)} and
5159 * {@link NetworkCallback#onLinkPropertiesChanged(Network, LinkProperties)}. The methods of the
5160 * provided {@link NetworkCallback} will only be invoked due to changes in the best network
5161 * matching the request at any given time; therefore when a better network matching the request
5162 * becomes available, the {@link NetworkCallback#onAvailable(Network)} method is called
5163 * with the new network after which no further updates are given about the previously-best
5164 * network, unless it becomes the best again at some later time. All callbacks are invoked
5165 * in order on the same thread, which by default is a thread created by the framework running
5166 * in the app.
5167 *
5168 * <p>This{@link NetworkRequest} will live until released via
5169 * {@link #unregisterNetworkCallback(NetworkCallback)} or the calling application exits, at
5170 * which point the system may let go of the network at any time.
5171 *
5172 * <p>It is presently unsupported to request a network with mutable
5173 * {@link NetworkCapabilities} such as
5174 * {@link NetworkCapabilities#NET_CAPABILITY_VALIDATED} or
5175 * {@link NetworkCapabilities#NET_CAPABILITY_CAPTIVE_PORTAL}
5176 * as these {@code NetworkCapabilities} represent states that a particular
5177 * network may never attain, and whether a network will attain these states
5178 * is unknown prior to bringing up the network so the framework does not
5179 * know how to go about satisfying a request with these capabilities.
5180 *
5181 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
5182 * number of outstanding requests to 100 per app (identified by their UID), shared with
5183 * all variants of this method, of {@link #registerNetworkCallback} as well as
5184 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
5185 * Requesting a network with this method will count toward this limit. If this limit is
5186 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
5187 * make sure to unregister the callbacks with
5188 * {@link #unregisterNetworkCallback(NetworkCallback)}.
5189 *
5190 * @param request {@link NetworkRequest} describing this request.
5191 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
5192 * If null, the callback is invoked on the default internal Handler.
5193 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
5194 * the callback must not be shared - it uniquely specifies this request.
5195 * @throws IllegalArgumentException if {@code request} contains invalid network capabilities.
5196 * @throws SecurityException if missing the appropriate permissions.
5197 * @throws RuntimeException if the app already has too many callbacks registered.
5198 *
5199 * @hide
5200 */
5201 @SystemApi(client = MODULE_LIBRARIES)
5202 @SuppressLint("ExecutorRegistration")
5203 @RequiresPermission(anyOf = {
5204 android.Manifest.permission.NETWORK_SETTINGS,
5205 android.Manifest.permission.NETWORK_STACK,
5206 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK
5207 })
5208 public void requestBackgroundNetwork(@NonNull NetworkRequest request,
junyulaif4bc12f2021-03-09 20:49:48 +08005209 @NonNull Handler handler, @NonNull NetworkCallback networkCallback) {
Junyu Lai23568a42021-01-19 11:10:56 +00005210 final NetworkCapabilities nc = request.networkCapabilities;
5211 sendRequestForNetwork(nc, networkCallback, 0, BACKGROUND_REQUEST,
junyulaif4bc12f2021-03-09 20:49:48 +08005212 TYPE_NONE, new CallbackHandler(handler));
Junyu Lai23568a42021-01-19 11:10:56 +00005213 }
James Mattis6e6fabf2021-01-10 14:24:24 -08005214
5215 /**
James Mattis6e6fabf2021-01-10 14:24:24 -08005216 * Used by automotive devices to set the network preferences used to direct traffic at an
5217 * application level as per the given OemNetworkPreferences. An example use-case would be an
5218 * automotive OEM wanting to provide connectivity for applications critical to the usage of a
5219 * vehicle via a particular network.
5220 *
5221 * Calling this will overwrite the existing preference.
5222 *
5223 * @param preference {@link OemNetworkPreferences} The application network preference to be set.
5224 * @param executor the executor on which listener will be invoked.
5225 * @param listener {@link OnSetOemNetworkPreferenceListener} optional listener used to
5226 * communicate completion of setOemNetworkPreference(). This will only be
5227 * called once upon successful completion of setOemNetworkPreference().
5228 * @throws IllegalArgumentException if {@code preference} contains invalid preference values.
5229 * @throws SecurityException if missing the appropriate permissions.
5230 * @throws UnsupportedOperationException if called on a non-automotive device.
James Mattis7a253542021-01-26 16:23:52 -08005231 * @hide
James Mattis6e6fabf2021-01-10 14:24:24 -08005232 */
James Mattis7a253542021-01-26 16:23:52 -08005233 @SystemApi
James Mattis981865c2021-01-26 14:05:36 -08005234 @RequiresPermission(android.Manifest.permission.CONTROL_OEM_PAID_NETWORK_PREFERENCE)
James Mattis7a253542021-01-26 16:23:52 -08005235 public void setOemNetworkPreference(@NonNull final OemNetworkPreferences preference,
James Mattis6e6fabf2021-01-10 14:24:24 -08005236 @Nullable @CallbackExecutor final Executor executor,
Chalard Jeancc9ad152021-03-03 16:37:13 +09005237 @Nullable final Runnable listener) {
James Mattis6e6fabf2021-01-10 14:24:24 -08005238 Objects.requireNonNull(preference, "OemNetworkPreferences must be non-null");
5239 if (null != listener) {
5240 Objects.requireNonNull(executor, "Executor must be non-null");
5241 }
Chalard Jeancc9ad152021-03-03 16:37:13 +09005242 final IOnCompleteListener listenerInternal = listener == null ? null :
5243 new IOnCompleteListener.Stub() {
James Mattis6e6fabf2021-01-10 14:24:24 -08005244 @Override
5245 public void onComplete() {
Chalard Jeancc9ad152021-03-03 16:37:13 +09005246 executor.execute(listener::run);
James Mattis6e6fabf2021-01-10 14:24:24 -08005247 }
5248 };
5249
5250 try {
5251 mService.setOemNetworkPreference(preference, listenerInternal);
5252 } catch (RemoteException e) {
5253 Log.e(TAG, "setOemNetworkPreference() failed for preference: " + preference.toString());
5254 throw e.rethrowFromSystemServer();
5255 }
5256 }
lucaslin1a6095c2021-03-12 00:46:33 +08005257
Chalard Jean03433052021-02-25 17:23:40 +09005258 /**
5259 * Request that a user profile is put by default on a network matching a given preference.
5260 *
5261 * See the documentation for the individual preferences for a description of the supported
5262 * behaviors.
5263 *
5264 * @param profile the profile concerned.
5265 * @param preference the preference for this profile.
5266 * @param executor an executor to execute the listener on. Optional if listener is null.
5267 * @param listener an optional listener to listen for completion of the operation.
5268 * @throws IllegalArgumentException if {@code profile} is not a valid user profile.
5269 * @throws SecurityException if missing the appropriate permissions.
5270 * @hide
5271 */
Chalard Jeancc9ad152021-03-03 16:37:13 +09005272 // This function is for establishing per-profile default networking and can only be called by
5273 // the device policy manager, running as the system server. It would make no sense to call it
5274 // on a context for a user because it does not establish a setting on behalf of a user, rather
5275 // it establishes a setting for a user on behalf of the DPM.
5276 @SuppressLint({"UserHandle"})
5277 @SystemApi(client = MODULE_LIBRARIES)
Chalard Jean03433052021-02-25 17:23:40 +09005278 @RequiresPermission(android.Manifest.permission.NETWORK_STACK)
5279 public void setProfileNetworkPreference(@NonNull final UserHandle profile,
5280 @ProfileNetworkPreference final int preference,
5281 @Nullable @CallbackExecutor final Executor executor,
5282 @Nullable final Runnable listener) {
5283 if (null != listener) {
5284 Objects.requireNonNull(executor, "Pass a non-null executor, or a null listener");
5285 }
5286 final IOnCompleteListener proxy;
5287 if (null == listener) {
5288 proxy = null;
5289 } else {
5290 proxy = new IOnCompleteListener.Stub() {
5291 @Override
5292 public void onComplete() {
5293 executor.execute(listener::run);
5294 }
5295 };
5296 }
5297 try {
5298 mService.setProfileNetworkPreference(profile, preference, proxy);
5299 } catch (RemoteException e) {
5300 throw e.rethrowFromSystemServer();
5301 }
5302 }
5303
lucaslin1a6095c2021-03-12 00:46:33 +08005304 // The first network ID of IPSec tunnel interface.
lucaslin28633072021-03-15 17:24:12 +08005305 private static final int TUN_INTF_NETID_START = 0xFC00; // 0xFC00 = 64512
lucaslin1a6095c2021-03-12 00:46:33 +08005306 // The network ID range of IPSec tunnel interface.
lucaslin28633072021-03-15 17:24:12 +08005307 private static final int TUN_INTF_NETID_RANGE = 0x0400; // 0x0400 = 1024
lucaslin1a6095c2021-03-12 00:46:33 +08005308
5309 /**
5310 * Get the network ID range reserved for IPSec tunnel interfaces.
5311 *
5312 * @return A Range which indicates the network ID range of IPSec tunnel interface.
5313 * @hide
5314 */
5315 @SystemApi(client = MODULE_LIBRARIES)
5316 @NonNull
5317 public static Range<Integer> getIpSecNetIdRange() {
5318 return new Range(TUN_INTF_NETID_START, TUN_INTF_NETID_START + TUN_INTF_NETID_RANGE - 1);
5319 }
lucaslin50205af2021-03-12 16:11:27 +08005320
5321 /**
5322 * Get private DNS mode from settings.
5323 *
lucaslin73c98602021-03-17 14:53:35 +08005324 * @param context The Context to query the private DNS mode from settings.
lucaslin50205af2021-03-12 16:11:27 +08005325 * @return A string of private DNS mode as one of the PRIVATE_DNS_MODE_* constants.
5326 *
5327 * @hide
5328 */
5329 @SystemApi(client = MODULE_LIBRARIES)
5330 @NonNull
5331 @PrivateDnsMode
lucaslinacd3ded2021-03-16 17:11:14 +08005332 public static String getPrivateDnsMode(@NonNull Context context) {
5333 final ContentResolver cr = context.getContentResolver();
lucaslin50205af2021-03-12 16:11:27 +08005334 String mode = Settings.Global.getString(cr, PRIVATE_DNS_MODE);
5335 if (TextUtils.isEmpty(mode)) mode = Settings.Global.getString(cr, PRIVATE_DNS_DEFAULT_MODE);
5336 // If both PRIVATE_DNS_MODE and PRIVATE_DNS_DEFAULT_MODE are not set, choose
5337 // PRIVATE_DNS_MODE_OPPORTUNISTIC as default mode.
5338 if (TextUtils.isEmpty(mode)) mode = PRIVATE_DNS_MODE_OPPORTUNISTIC;
5339 return mode;
5340 }
The Android Open Source Project28527d22009-03-03 19:31:44 -08005341}