blob: 5a53af44f569c736f0fc13882e398120697366fd [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;
Junyu Lai23568a42021-01-19 11:10:56 +000019import static android.net.NetworkRequest.Type.BACKGROUND_REQUEST;
junyulaid1a78162021-01-11 16:53:38 +080020import static android.net.NetworkRequest.Type.LISTEN;
junyulai8cae3c72021-03-12 20:05:08 +080021import static android.net.NetworkRequest.Type.LISTEN_FOR_BEST;
junyulaid1a78162021-01-11 16:53:38 +080022import static android.net.NetworkRequest.Type.REQUEST;
23import static android.net.NetworkRequest.Type.TRACK_DEFAULT;
Lorenzo Colitti80b48bc2021-01-29 20:14:04 +090024import static android.net.NetworkRequest.Type.TRACK_SYSTEM_DEFAULT;
Daniel Bright60f02ed2020-06-15 16:10:01 -070025import static android.net.QosCallback.QosCallbackRegistrationException;
junyulai48a59382019-01-15 11:32:44 +080026
junyulaia86defc2018-12-27 17:25:29 +080027import android.annotation.CallbackExecutor;
Felipe Lemed16384b2016-01-22 09:44:57 -080028import android.annotation.IntDef;
Chalard Jean42a9c292019-01-07 19:26:34 +090029import android.annotation.NonNull;
Robin Lee33c73e22016-01-05 18:03:46 +000030import android.annotation.Nullable;
Jeff Sharkey2ac62992017-04-24 11:18:03 -060031import android.annotation.RequiresPermission;
The Android Open Source Project28527d22009-03-03 19:31:44 -080032import android.annotation.SdkConstant;
33import android.annotation.SdkConstant.SdkConstantType;
Junyu Lai23568a42021-01-19 11:10:56 +000034import android.annotation.SuppressLint;
Udam Saini53b71ee2016-01-04 12:16:14 -080035import android.annotation.SystemApi;
Jeff Sharkeyb8c73032017-06-02 17:36:26 -060036import android.annotation.SystemService;
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -070037import android.app.PendingIntent;
Lorenzo Colitti60104f52021-03-18 00:54:57 +090038import android.app.admin.DevicePolicyManager;
Artur Satayevb9ea02f2019-12-10 17:47:52 +000039import android.compat.annotation.UnsupportedAppUsage;
Lorenzo Colitti60104f52021-03-18 00:54:57 +090040import android.content.ComponentName;
Jeff Sharkey2d9e5a52012-04-04 20:40:58 -070041import android.content.Context;
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -070042import android.content.Intent;
Aaron Huang9ca37f52021-04-14 01:25:55 +080043import android.net.ConnectivityAnnotations.MultipathPreference;
44import android.net.ConnectivityAnnotations.RestrictBackgroundStatus;
Remi NGUYEN VAN5738b862021-04-08 16:26:20 +090045import android.net.ConnectivityDiagnosticsManager.DataStallReport.DetectionMethod;
junyulaia86defc2018-12-27 17:25:29 +080046import android.net.IpSecManager.UdpEncapsulationSocket;
47import android.net.SocketKeepalive.Callback;
markchien10ddd022020-01-20 19:31:56 +080048import android.net.TetheringManager.StartTetheringCallback;
markchien75721e42020-01-21 13:11:06 +080049import android.net.TetheringManager.TetheringEventCallback;
markchien10ddd022020-01-20 19:31:56 +080050import android.net.TetheringManager.TetheringRequest;
Roshan Pius7992afd2020-12-22 15:10:42 -080051import android.net.wifi.WifiNetworkSuggestion;
Robert Greenwalt2034b912009-08-12 16:08:25 -070052import android.os.Binder;
Mathew Inwoodac5968e2018-12-20 15:30:45 +000053import android.os.Build;
Jeff Sharkey39c01eb2011-08-16 14:37:57 -070054import android.os.Build.VERSION_CODES;
Jeremy Klein9a36ec82016-01-22 14:11:45 -080055import android.os.Bundle;
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -070056import android.os.Handler;
Dianne Hackbornb4b09e82014-02-26 16:20:52 -080057import android.os.IBinder;
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -070058import android.os.Looper;
59import android.os.Message;
Robert Greenwalt030e1d32012-08-21 19:27:00 -070060import android.os.Messenger;
junyulai61143782019-03-04 22:45:36 +080061import android.os.ParcelFileDescriptor;
Cody Kestingb5c7abd2020-04-15 12:33:28 -070062import android.os.PersistableBundle;
Lorenzo Colitti9b026fa2015-07-29 11:41:21 +090063import android.os.Process;
The Android Open Source Project28527d22009-03-03 19:31:44 -080064import android.os.RemoteException;
Jeremy Klein9a36ec82016-01-22 14:11:45 -080065import android.os.ResultReceiver;
Hugo Benichi145e3792017-05-11 13:16:17 +090066import android.os.ServiceSpecificException;
Chalard Jean03433052021-02-25 17:23:40 +090067import android.os.UserHandle;
Jeff Sharkey971cd162011-08-29 16:02:57 -070068import android.provider.Settings;
Wink Saville02eb35c2014-12-05 11:10:30 -080069import android.telephony.SubscriptionManager;
Meng Wang91311c02019-11-18 17:10:00 -080070import android.telephony.TelephonyManager;
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 *
lucaslin8a8cb5d2021-04-21 10:43:15 +0800424 * This action includes a {@link Network} typed extra which is called
425 * {@link ConnectivityManager#EXTRA_NETWORK} that represents the network which is unvalidated.
426 *
Lorenzo Colitti36fbebe2015-04-03 16:38:52 +0900427 * @hide
428 */
lucaslin1a0ca5f2021-03-04 17:09:51 +0800429 @SystemApi(client = MODULE_LIBRARIES)
430 public static final String ACTION_PROMPT_UNVALIDATED = "android.net.action.PROMPT_UNVALIDATED";
Lorenzo Colitti36fbebe2015-04-03 16:38:52 +0900431
432 /**
Lorenzo Colitti477bf5c2016-09-15 14:02:29 +0900433 * Action used to display a dialog that asks the user whether to avoid a network that is no
434 * longer validated. This intent is used to start the dialog in settings via startActivity.
435 *
lucaslin8a8cb5d2021-04-21 10:43:15 +0800436 * This action includes a {@link Network} typed extra which is called
437 * {@link ConnectivityManager#EXTRA_NETWORK} that represents the network which is no longer
438 * validated.
439 *
Lorenzo Colitti477bf5c2016-09-15 14:02:29 +0900440 * @hide
441 */
lucaslin1a0ca5f2021-03-04 17:09:51 +0800442 @SystemApi(client = MODULE_LIBRARIES)
Lorenzo Colitti477bf5c2016-09-15 14:02:29 +0900443 public static final String ACTION_PROMPT_LOST_VALIDATION =
lucaslin1a0ca5f2021-03-04 17:09:51 +0800444 "android.net.action.PROMPT_LOST_VALIDATION";
Lorenzo Colitti477bf5c2016-09-15 14:02:29 +0900445
446 /**
lucaslin25a50472019-03-12 13:08:03 +0800447 * Action used to display a dialog that asks the user whether to stay connected to a network
448 * that has not validated. This intent is used to start the dialog in settings via
449 * startActivity.
450 *
lucaslin8a8cb5d2021-04-21 10:43:15 +0800451 * This action includes a {@link Network} typed extra which is called
452 * {@link ConnectivityManager#EXTRA_NETWORK} that represents the network which has partial
453 * connectivity.
454 *
lucaslin25a50472019-03-12 13:08:03 +0800455 * @hide
456 */
lucaslin1a0ca5f2021-03-04 17:09:51 +0800457 @SystemApi(client = MODULE_LIBRARIES)
lucaslin25a50472019-03-12 13:08:03 +0800458 public static final String ACTION_PROMPT_PARTIAL_CONNECTIVITY =
lucaslin1a0ca5f2021-03-04 17:09:51 +0800459 "android.net.action.PROMPT_PARTIAL_CONNECTIVITY";
lucaslin25a50472019-03-12 13:08:03 +0800460
461 /**
paulhu164c97d2021-04-07 16:18:13 +0800462 * Clear DNS Cache Action: This is broadcast when networks have changed and old
463 * DNS entries should be cleared.
464 * @hide
465 */
466 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
467 @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
468 public static final String ACTION_CLEAR_DNS_CACHE = "android.net.action.CLEAR_DNS_CACHE";
469
470 /**
Jeremy Klein9a36ec82016-01-22 14:11:45 -0800471 * Invalid tethering type.
Chalard Jean73d9db72018-06-04 16:52:49 +0900472 * @see #startTethering(int, boolean, OnStartTetheringCallback)
Jeremy Klein9a36ec82016-01-22 14:11:45 -0800473 * @hide
474 */
markchien1f523702019-12-25 19:40:32 +0800475 public static final int TETHERING_INVALID = TetheringManager.TETHERING_INVALID;
Jeremy Klein9a36ec82016-01-22 14:11:45 -0800476
477 /**
478 * Wifi tethering type.
Chalard Jean73d9db72018-06-04 16:52:49 +0900479 * @see #startTethering(int, boolean, OnStartTetheringCallback)
Jeremy Klein9a36ec82016-01-22 14:11:45 -0800480 * @hide
481 */
482 @SystemApi
Remi NGUYEN VAN23b853b2021-02-15 18:52:06 +0900483 public static final int TETHERING_WIFI = 0;
Jeremy Klein9a36ec82016-01-22 14:11:45 -0800484
485 /**
486 * USB tethering type.
Chalard Jean73d9db72018-06-04 16:52:49 +0900487 * @see #startTethering(int, boolean, OnStartTetheringCallback)
Jeremy Klein9a36ec82016-01-22 14:11:45 -0800488 * @hide
489 */
490 @SystemApi
Remi NGUYEN VAN23b853b2021-02-15 18:52:06 +0900491 public static final int TETHERING_USB = 1;
Jeremy Klein9a36ec82016-01-22 14:11:45 -0800492
493 /**
494 * Bluetooth tethering type.
Chalard Jean73d9db72018-06-04 16:52:49 +0900495 * @see #startTethering(int, boolean, OnStartTetheringCallback)
Jeremy Klein9a36ec82016-01-22 14:11:45 -0800496 * @hide
497 */
498 @SystemApi
Remi NGUYEN VAN23b853b2021-02-15 18:52:06 +0900499 public static final int TETHERING_BLUETOOTH = 2;
Jeremy Klein9a36ec82016-01-22 14:11:45 -0800500
501 /**
Jimmy Chen87db1542019-07-15 18:03:23 +0800502 * Wifi P2p tethering type.
503 * Wifi P2p tethering is set through events automatically, and don't
504 * need to start from #startTethering(int, boolean, OnStartTetheringCallback).
505 * @hide
506 */
markchien1f523702019-12-25 19:40:32 +0800507 public static final int TETHERING_WIFI_P2P = TetheringManager.TETHERING_WIFI_P2P;
Jimmy Chen87db1542019-07-15 18:03:23 +0800508
509 /**
Jeremy Klein9a36ec82016-01-22 14:11:45 -0800510 * Extra used for communicating with the TetherService. Includes the type of tethering to
511 * enable if any.
512 * @hide
513 */
markchien75721e42020-01-21 13:11:06 +0800514 public static final String EXTRA_ADD_TETHER_TYPE = TetheringConstants.EXTRA_ADD_TETHER_TYPE;
Jeremy Klein9a36ec82016-01-22 14:11:45 -0800515
516 /**
517 * Extra used for communicating with the TetherService. Includes the type of tethering for
518 * which to cancel provisioning.
519 * @hide
520 */
markchien75721e42020-01-21 13:11:06 +0800521 public static final String EXTRA_REM_TETHER_TYPE = TetheringConstants.EXTRA_REM_TETHER_TYPE;
Jeremy Klein9a36ec82016-01-22 14:11:45 -0800522
523 /**
524 * Extra used for communicating with the TetherService. True to schedule a recheck of tether
525 * provisioning.
526 * @hide
527 */
markchien75721e42020-01-21 13:11:06 +0800528 public static final String EXTRA_SET_ALARM = TetheringConstants.EXTRA_SET_ALARM;
Jeremy Klein9a36ec82016-01-22 14:11:45 -0800529
530 /**
531 * Tells the TetherService to run a provision check now.
532 * @hide
533 */
markchien75721e42020-01-21 13:11:06 +0800534 public static final String EXTRA_RUN_PROVISION = TetheringConstants.EXTRA_RUN_PROVISION;
Jeremy Klein9a36ec82016-01-22 14:11:45 -0800535
536 /**
537 * Extra used for communicating with the TetherService. Contains the {@link ResultReceiver}
538 * which will receive provisioning results. Can be left empty.
539 * @hide
540 */
markchien75721e42020-01-21 13:11:06 +0800541 public static final String EXTRA_PROVISION_CALLBACK =
542 TetheringConstants.EXTRA_PROVISION_CALLBACK;
Jeremy Klein9a36ec82016-01-22 14:11:45 -0800543
544 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -0800545 * The absence of a connection type.
Robert Greenwalt33cdcdf2011-06-02 17:30:47 -0700546 * @hide
547 */
paulhu62af6122020-01-13 16:46:45 +0800548 @SystemApi
Robert Greenwalt33cdcdf2011-06-02 17:30:47 -0700549 public static final int TYPE_NONE = -1;
550
551 /**
Chalard Jean5acb7b72018-03-08 13:54:53 +0900552 * A Mobile data connection. Devices may support more than one.
553 *
554 * @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or
555 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an
556 * appropriate network. {@see NetworkCapabilities} for supported transports.
Robert Greenwalt2034b912009-08-12 16:08:25 -0700557 */
Chalard Jean5acb7b72018-03-08 13:54:53 +0900558 @Deprecated
Robert Greenwalt2034b912009-08-12 16:08:25 -0700559 public static final int TYPE_MOBILE = 0;
Chalard Jean5acb7b72018-03-08 13:54:53 +0900560
Robert Greenwalt2034b912009-08-12 16:08:25 -0700561 /**
Chalard Jean5acb7b72018-03-08 13:54:53 +0900562 * A WIFI data connection. Devices may support more than one.
563 *
564 * @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or
565 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an
566 * appropriate network. {@see NetworkCapabilities} for supported transports.
Robert Greenwalt2034b912009-08-12 16:08:25 -0700567 */
Chalard Jean5acb7b72018-03-08 13:54:53 +0900568 @Deprecated
Robert Greenwalt2034b912009-08-12 16:08:25 -0700569 public static final int TYPE_WIFI = 1;
Chalard Jean5acb7b72018-03-08 13:54:53 +0900570
Robert Greenwalt2034b912009-08-12 16:08:25 -0700571 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -0800572 * An MMS-specific Mobile data connection. This network type may use the
573 * same network interface as {@link #TYPE_MOBILE} or it may use a different
574 * one. This is used by applications needing to talk to the carrier's
575 * Multimedia Messaging Service servers.
Lorenzo Colitti7cc32c52015-04-23 15:32:42 +0900576 *
Chalard Jean5acb7b72018-03-08 13:54:53 +0900577 * @deprecated Applications should instead use {@link NetworkCapabilities#hasCapability} or
Lorenzo Colittiefd396e2015-04-24 17:03:31 +0900578 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request a network that
Lorenzo Colitti7cc32c52015-04-23 15:32:42 +0900579 * provides the {@link NetworkCapabilities#NET_CAPABILITY_MMS} capability.
Robert Greenwalt2034b912009-08-12 16:08:25 -0700580 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -0700581 @Deprecated
Robert Greenwalt2034b912009-08-12 16:08:25 -0700582 public static final int TYPE_MOBILE_MMS = 2;
Chalard Jean5acb7b72018-03-08 13:54:53 +0900583
Robert Greenwalt2034b912009-08-12 16:08:25 -0700584 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -0800585 * A SUPL-specific Mobile data connection. This network type may use the
586 * same network interface as {@link #TYPE_MOBILE} or it may use a different
587 * one. This is used by applications needing to talk to the carrier's
588 * Secure User Plane Location servers for help locating the device.
Lorenzo Colitti7cc32c52015-04-23 15:32:42 +0900589 *
Chalard Jean5acb7b72018-03-08 13:54:53 +0900590 * @deprecated Applications should instead use {@link NetworkCapabilities#hasCapability} or
Lorenzo Colittiefd396e2015-04-24 17:03:31 +0900591 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request a network that
Lorenzo Colitti7cc32c52015-04-23 15:32:42 +0900592 * provides the {@link NetworkCapabilities#NET_CAPABILITY_SUPL} capability.
Robert Greenwalt2034b912009-08-12 16:08:25 -0700593 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -0700594 @Deprecated
Robert Greenwalt2034b912009-08-12 16:08:25 -0700595 public static final int TYPE_MOBILE_SUPL = 3;
Chalard Jean5acb7b72018-03-08 13:54:53 +0900596
Robert Greenwalt2034b912009-08-12 16:08:25 -0700597 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -0800598 * A DUN-specific Mobile data connection. This network type may use the
599 * same network interface as {@link #TYPE_MOBILE} or it may use a different
600 * one. This is sometimes by the system when setting up an upstream connection
601 * for tethering so that the carrier is aware of DUN traffic.
Chalard Jean5acb7b72018-03-08 13:54:53 +0900602 *
603 * @deprecated Applications should instead use {@link NetworkCapabilities#hasCapability} or
604 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request a network that
605 * provides the {@link NetworkCapabilities#NET_CAPABILITY_DUN} capability.
Robert Greenwalt2034b912009-08-12 16:08:25 -0700606 */
Chalard Jean5acb7b72018-03-08 13:54:53 +0900607 @Deprecated
Robert Greenwalt2034b912009-08-12 16:08:25 -0700608 public static final int TYPE_MOBILE_DUN = 4;
Chalard Jean5acb7b72018-03-08 13:54:53 +0900609
Robert Greenwalt2034b912009-08-12 16:08:25 -0700610 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -0800611 * A High Priority Mobile data connection. This network type uses the
612 * same network interface as {@link #TYPE_MOBILE} but the routing setup
Lorenzo Colitti7cc32c52015-04-23 15:32:42 +0900613 * is different.
614 *
Chalard Jean5acb7b72018-03-08 13:54:53 +0900615 * @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.
Robert Greenwalt2034b912009-08-12 16:08:25 -0700618 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -0700619 @Deprecated
Robert Greenwalt2034b912009-08-12 16:08:25 -0700620 public static final int TYPE_MOBILE_HIPRI = 5;
Chalard Jean5acb7b72018-03-08 13:54:53 +0900621
jshbfa81722010-03-11 15:04:43 -0800622 /**
Chalard Jean5acb7b72018-03-08 13:54:53 +0900623 * A WiMAX data connection.
624 *
625 * @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or
626 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an
627 * appropriate network. {@see NetworkCapabilities} for supported transports.
jshbfa81722010-03-11 15:04:43 -0800628 */
Chalard Jean5acb7b72018-03-08 13:54:53 +0900629 @Deprecated
jshbfa81722010-03-11 15:04:43 -0800630 public static final int TYPE_WIMAX = 6;
Robert Greenwalteb123ac2010-12-06 13:56:24 -0800631
Jaikumar Ganesh0db51a02010-12-21 22:31:44 -0800632 /**
Chalard Jean5acb7b72018-03-08 13:54:53 +0900633 * A Bluetooth data connection.
634 *
635 * @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or
636 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an
637 * appropriate network. {@see NetworkCapabilities} for supported transports.
Jaikumar Ganesh0db51a02010-12-21 22:31:44 -0800638 */
Chalard Jean5acb7b72018-03-08 13:54:53 +0900639 @Deprecated
Jaikumar Ganesh0db51a02010-12-21 22:31:44 -0800640 public static final int TYPE_BLUETOOTH = 7;
641
Robert Greenwaltf76c55d2011-04-22 15:28:18 -0700642 /**
Chiachang Wang7d5f3782020-07-28 13:53:09 +0800643 * Fake data connection. This should not be used on shipping devices.
Chalard Jean5acb7b72018-03-08 13:54:53 +0900644 * @deprecated This is not used any more.
Robert Greenwaltf76c55d2011-04-22 15:28:18 -0700645 */
Chalard Jean5acb7b72018-03-08 13:54:53 +0900646 @Deprecated
Jaikumar Ganesh0db51a02010-12-21 22:31:44 -0800647 public static final int TYPE_DUMMY = 8;
Wink Savilleb7c92c72011-03-12 14:52:01 -0800648
Robert Greenwaltf76c55d2011-04-22 15:28:18 -0700649 /**
Chalard Jean5acb7b72018-03-08 13:54:53 +0900650 * An Ethernet data connection.
651 *
652 * @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or
653 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an
654 * appropriate network. {@see NetworkCapabilities} for supported transports.
Robert Greenwaltf76c55d2011-04-22 15:28:18 -0700655 */
Chalard Jean5acb7b72018-03-08 13:54:53 +0900656 @Deprecated
Robert Greenwalt9d077812011-01-28 14:48:37 -0800657 public static final int TYPE_ETHERNET = 9;
Robert Greenwaltf76c55d2011-04-22 15:28:18 -0700658
Wink Savilleb7c92c72011-03-12 14:52:01 -0800659 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -0800660 * Over the air Administration.
Chalard Jean5acb7b72018-03-08 13:54:53 +0900661 * @deprecated Use {@link NetworkCapabilities} instead.
Wink Savilleb7c92c72011-03-12 14:52:01 -0800662 * {@hide}
663 */
Chalard Jean5acb7b72018-03-08 13:54:53 +0900664 @Deprecated
Chalard Jeanaa91c9d2019-04-09 15:46:21 +0900665 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 130143562)
Wink Savilleb7c92c72011-03-12 14:52:01 -0800666 public static final int TYPE_MOBILE_FOTA = 10;
667
668 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -0800669 * IP Multimedia Subsystem.
Chalard Jean5acb7b72018-03-08 13:54:53 +0900670 * @deprecated Use {@link NetworkCapabilities#NET_CAPABILITY_IMS} instead.
Wink Savilleb7c92c72011-03-12 14:52:01 -0800671 * {@hide}
672 */
Chalard Jean5acb7b72018-03-08 13:54:53 +0900673 @Deprecated
Mathew Inwood0b8f8612018-08-08 14:52:47 +0100674 @UnsupportedAppUsage
Wink Savilleb7c92c72011-03-12 14:52:01 -0800675 public static final int TYPE_MOBILE_IMS = 11;
676
677 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -0800678 * Carrier Branded Services.
Chalard Jean5acb7b72018-03-08 13:54:53 +0900679 * @deprecated Use {@link NetworkCapabilities#NET_CAPABILITY_CBS} instead.
Wink Savilleb7c92c72011-03-12 14:52:01 -0800680 * {@hide}
681 */
Chalard Jean5acb7b72018-03-08 13:54:53 +0900682 @Deprecated
Chalard Jeanaa91c9d2019-04-09 15:46:21 +0900683 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 130143562)
Wink Savilleb7c92c72011-03-12 14:52:01 -0800684 public static final int TYPE_MOBILE_CBS = 12;
685
repo syncf5de5572011-07-29 23:55:49 -0700686 /**
687 * A Wi-Fi p2p connection. Only requesting processes will have access to
688 * the peers connected.
Chalard Jean5acb7b72018-03-08 13:54:53 +0900689 * @deprecated Use {@link NetworkCapabilities#NET_CAPABILITY_WIFI_P2P} instead.
repo syncf5de5572011-07-29 23:55:49 -0700690 * {@hide}
691 */
Chalard Jean5acb7b72018-03-08 13:54:53 +0900692 @Deprecated
paulhu028732e2020-01-15 15:38:23 +0800693 @SystemApi
repo syncf5de5572011-07-29 23:55:49 -0700694 public static final int TYPE_WIFI_P2P = 13;
Wink Savilleb7c92c72011-03-12 14:52:01 -0800695
Wink Saville70dbdcc2013-07-29 15:00:57 -0700696 /**
697 * The network to use for initially attaching to the network
Chalard Jean5acb7b72018-03-08 13:54:53 +0900698 * @deprecated Use {@link NetworkCapabilities#NET_CAPABILITY_IA} instead.
Wink Saville70dbdcc2013-07-29 15:00:57 -0700699 * {@hide}
700 */
Chalard Jean5acb7b72018-03-08 13:54:53 +0900701 @Deprecated
Mathew Inwood0b8f8612018-08-08 14:52:47 +0100702 @UnsupportedAppUsage
Wink Saville70dbdcc2013-07-29 15:00:57 -0700703 public static final int TYPE_MOBILE_IA = 14;
repo syncf5de5572011-07-29 23:55:49 -0700704
Lorenzo Colitti7cc32c52015-04-23 15:32:42 +0900705 /**
Robert Greenwalt9db5f3c2015-07-09 14:49:35 -0700706 * Emergency PDN connection for emergency services. This
707 * may include IMS and MMS in emergency situations.
Chalard Jean5acb7b72018-03-08 13:54:53 +0900708 * @deprecated Use {@link NetworkCapabilities#NET_CAPABILITY_EIMS} instead.
Ram201d45f2014-06-26 11:03:44 -0700709 * {@hide}
710 */
Chalard Jean5acb7b72018-03-08 13:54:53 +0900711 @Deprecated
Chalard Jeanaa91c9d2019-04-09 15:46:21 +0900712 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 130143562)
Ram201d45f2014-06-26 11:03:44 -0700713 public static final int TYPE_MOBILE_EMERGENCY = 15;
714
Hui Lu07f29332014-01-15 11:05:36 -0500715 /**
716 * The network that uses proxy to achieve connectivity.
Chalard Jean5acb7b72018-03-08 13:54:53 +0900717 * @deprecated Use {@link NetworkCapabilities} instead.
Hui Lu07f29332014-01-15 11:05:36 -0500718 * {@hide}
719 */
Chalard Jean5acb7b72018-03-08 13:54:53 +0900720 @Deprecated
Remi NGUYEN VANdaeafee2020-11-30 19:23:45 +0900721 @SystemApi
Hui Lu07f29332014-01-15 11:05:36 -0500722 public static final int TYPE_PROXY = 16;
Wink Saville70dbdcc2013-07-29 15:00:57 -0700723
Robert Greenwaltb2a03d12014-07-07 17:09:01 -0700724 /**
725 * A virtual network using one or more native bearers.
726 * It may or may not be providing security services.
Chalard Jean5acb7b72018-03-08 13:54:53 +0900727 * @deprecated Applications should use {@link NetworkCapabilities#TRANSPORT_VPN} instead.
Robert Greenwaltb2a03d12014-07-07 17:09:01 -0700728 */
Chalard Jean5acb7b72018-03-08 13:54:53 +0900729 @Deprecated
Robert Greenwaltb2a03d12014-07-07 17:09:01 -0700730 public static final int TYPE_VPN = 17;
Hui Lu07f29332014-01-15 11:05:36 -0500731
Benedict Wong80156022018-11-14 17:40:55 -0800732 /**
733 * A network that is exclusively meant to be used for testing
734 *
735 * @deprecated Use {@link NetworkCapabilities} instead.
736 * @hide
737 */
738 @Deprecated
739 public static final int TYPE_TEST = 18; // TODO: Remove this once NetworkTypes are unused.
Robert Greenwaltb2a03d12014-07-07 17:09:01 -0700740
Chalard Jean74fe1c72020-03-25 01:24:04 +0900741 /**
742 * @deprecated Use {@link NetworkCapabilities} instead.
743 * @hide
744 */
745 @Deprecated
746 @Retention(RetentionPolicy.SOURCE)
747 @IntDef(prefix = { "TYPE_" }, value = {
748 TYPE_NONE,
749 TYPE_MOBILE,
750 TYPE_WIFI,
751 TYPE_MOBILE_MMS,
752 TYPE_MOBILE_SUPL,
753 TYPE_MOBILE_DUN,
754 TYPE_MOBILE_HIPRI,
755 TYPE_WIMAX,
756 TYPE_BLUETOOTH,
757 TYPE_DUMMY,
758 TYPE_ETHERNET,
759 TYPE_MOBILE_FOTA,
760 TYPE_MOBILE_IMS,
761 TYPE_MOBILE_CBS,
762 TYPE_WIFI_P2P,
763 TYPE_MOBILE_IA,
764 TYPE_MOBILE_EMERGENCY,
765 TYPE_PROXY,
766 TYPE_VPN,
767 TYPE_TEST
768 })
769 public @interface LegacyNetworkType {}
770
Chalard Jean1f42df12019-11-21 14:48:00 +0900771 // Deprecated constants for return values of startUsingNetworkFeature. They used to live
772 // in com.android.internal.telephony.PhoneConstants until they were made inaccessible.
773 private static final int DEPRECATED_PHONE_CONSTANT_APN_ALREADY_ACTIVE = 0;
774 private static final int DEPRECATED_PHONE_CONSTANT_APN_REQUEST_STARTED = 1;
775 private static final int DEPRECATED_PHONE_CONSTANT_APN_REQUEST_FAILED = 3;
776
Robert Greenwaltb2a03d12014-07-07 17:09:01 -0700777 /** {@hide} */
Benedict Wong80156022018-11-14 17:40:55 -0800778 public static final int MAX_RADIO_TYPE = TYPE_TEST;
779
780 /** {@hide} */
781 public static final int MAX_NETWORK_TYPE = TYPE_TEST;
The Android Open Source Project28527d22009-03-03 19:31:44 -0800782
Hugo Benichi37d5c3c2017-06-20 14:07:59 +0900783 private static final int MIN_NETWORK_TYPE = TYPE_MOBILE;
784
Jianzheng Zhoua8aa1602012-11-16 13:45:20 +0800785 /**
786 * If you want to set the default network preference,you can directly
787 * change the networkAttributes array in framework's config.xml.
788 *
789 * @deprecated Since we support so many more networks now, the single
790 * network default network preference can't really express
Robert Greenwalt26744a52013-02-15 10:56:35 -0800791 * the hierarchy. Instead, the default is defined by the
Jianzheng Zhoua8aa1602012-11-16 13:45:20 +0800792 * networkAttributes in config.xml. You can determine
Robert Greenwalt1ee3d2c2012-12-07 09:56:50 -0800793 * the current value by calling {@link #getNetworkPreference()}
Jianzheng Zhoua8aa1602012-11-16 13:45:20 +0800794 * from an App.
795 */
796 @Deprecated
The Android Open Source Project28527d22009-03-03 19:31:44 -0800797 public static final int DEFAULT_NETWORK_PREFERENCE = TYPE_WIFI;
798
Jeff Sharkey5eccd9c2012-09-26 22:03:49 -0700799 /**
Robert Greenwalta1402df2014-03-19 17:56:12 -0700800 * @hide
801 */
Hugo Benichibcc81df2017-06-20 14:10:14 +0900802 public static final int REQUEST_ID_UNSET = 0;
Robert Greenwaltc34f83b2014-06-08 16:42:59 -0700803
Paul Jensen0478ace2014-07-11 12:28:19 -0400804 /**
Hugo Benichi1c027fe2017-06-17 13:14:12 +0900805 * Static unique request used as a tombstone for NetworkCallbacks that have been unregistered.
806 * This allows to distinguish when unregistering NetworkCallbacks those that were never
Chalard Jean73d9db72018-06-04 16:52:49 +0900807 * registered from those that were already unregistered.
Hugo Benichi1c027fe2017-06-17 13:14:12 +0900808 * @hide
809 */
Hugo Benichibcc81df2017-06-20 14:10:14 +0900810 private static final NetworkRequest ALREADY_UNREGISTERED =
Hugo Benichi1c027fe2017-06-17 13:14:12 +0900811 new NetworkRequest.Builder().clearCapabilities().build();
812
813 /**
Paul Jensen0478ace2014-07-11 12:28:19 -0400814 * A NetID indicating no Network is selected.
815 * Keep in sync with bionic/libc/dns/include/resolv_netid.h
816 * @hide
817 */
818 public static final int NETID_UNSET = 0;
819
Erik Kline1ecdd962017-10-30 15:29:44 +0900820 /**
Sudheer Shanka457dfd52021-03-23 08:12:28 +0000821 * Flag to indicate that an app is not subject to any restrictions that could result in its
822 * network access blocked.
823 *
824 * @hide
825 */
826 @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
827 public static final int BLOCKED_REASON_NONE = 0;
828
829 /**
830 * Flag to indicate that an app is subject to Battery saver restrictions that would
831 * result in its network access being blocked.
832 *
833 * @hide
834 */
835 @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
836 public static final int BLOCKED_REASON_BATTERY_SAVER = 1 << 0;
837
838 /**
839 * Flag to indicate that an app is subject to Doze restrictions that would
840 * result in its network access being blocked.
841 *
842 * @hide
843 */
844 @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
845 public static final int BLOCKED_REASON_DOZE = 1 << 1;
846
847 /**
848 * Flag to indicate that an app is subject to App Standby restrictions that would
849 * result in its network access being blocked.
850 *
851 * @hide
852 */
853 @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
854 public static final int BLOCKED_REASON_APP_STANDBY = 1 << 2;
855
856 /**
857 * Flag to indicate that an app is subject to Restricted mode restrictions that would
858 * result in its network access being blocked.
859 *
860 * @hide
861 */
862 @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
863 public static final int BLOCKED_REASON_RESTRICTED_MODE = 1 << 3;
864
865 /**
Lorenzo Colitti60104f52021-03-18 00:54:57 +0900866 * Flag to indicate that an app is blocked because it is subject to an always-on VPN but the VPN
867 * is not currently connected.
868 *
869 * @see DevicePolicyManager#setAlwaysOnVpnPackage(ComponentName, String, boolean)
870 *
871 * @hide
872 */
873 @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
874 public static final int BLOCKED_REASON_LOCKDOWN_VPN = 1 << 4;
875
876 /**
Sudheer Shanka457dfd52021-03-23 08:12:28 +0000877 * Flag to indicate that an app is subject to Data saver restrictions that would
878 * result in its metered network access being blocked.
879 *
880 * @hide
881 */
882 @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
883 public static final int BLOCKED_METERED_REASON_DATA_SAVER = 1 << 16;
884
885 /**
886 * Flag to indicate that an app is subject to user restrictions that would
887 * result in its metered network access being blocked.
888 *
889 * @hide
890 */
891 @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
892 public static final int BLOCKED_METERED_REASON_USER_RESTRICTED = 1 << 17;
893
894 /**
895 * Flag to indicate that an app is subject to Device admin restrictions that would
896 * result in its metered network access being blocked.
897 *
898 * @hide
899 */
900 @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
901 public static final int BLOCKED_METERED_REASON_ADMIN_DISABLED = 1 << 18;
902
903 /**
904 * @hide
905 */
906 @Retention(RetentionPolicy.SOURCE)
907 @IntDef(flag = true, prefix = {"BLOCKED_"}, value = {
908 BLOCKED_REASON_NONE,
909 BLOCKED_REASON_BATTERY_SAVER,
910 BLOCKED_REASON_DOZE,
911 BLOCKED_REASON_APP_STANDBY,
912 BLOCKED_REASON_RESTRICTED_MODE,
Lorenzo Colittia37eaff2021-03-25 23:17:36 +0900913 BLOCKED_REASON_LOCKDOWN_VPN,
Sudheer Shanka457dfd52021-03-23 08:12:28 +0000914 BLOCKED_METERED_REASON_DATA_SAVER,
915 BLOCKED_METERED_REASON_USER_RESTRICTED,
916 BLOCKED_METERED_REASON_ADMIN_DISABLED,
917 })
918 public @interface BlockedReason {}
919
Lorenzo Colitti60104f52021-03-18 00:54:57 +0900920 /**
921 * Set of blocked reasons that are only applicable on metered networks.
922 *
923 * @hide
924 */
925 @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
926 public static final int BLOCKED_METERED_REASON_MASK = 0xffff0000;
927
Chalard Jeanaa91c9d2019-04-09 15:46:21 +0900928 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 130143562)
Jeff Sharkey921ebf22011-05-19 17:12:49 -0700929 private final IConnectivityManager mService;
Lorenzo Colitti0dd4b6f2021-02-04 17:32:07 +0900930
Paul Jensen12131352014-12-10 15:12:18 -0500931 /**
932 * A kludge to facilitate static access where a Context pointer isn't available, like in the
933 * case of the static set/getProcessDefaultNetwork methods and from the Network class.
934 * TODO: Remove this after deprecating the static methods in favor of non-static methods or
935 * methods that take a Context argument.
936 */
937 private static ConnectivityManager sInstance;
The Android Open Source Project28527d22009-03-03 19:31:44 -0800938
Lorenzo Colitti9b026fa2015-07-29 11:41:21 +0900939 private final Context mContext;
940
Automerger Merge Worker9b0c0c62020-03-06 00:38:43 +0000941 private final TetheringManager mTetheringManager;
Dianne Hackbornb4b09e82014-02-26 16:20:52 -0800942
Robert Greenwalt26744a52013-02-15 10:56:35 -0800943 /**
944 * Tests if a given integer represents a valid network type.
945 * @param networkType the type to be tested
946 * @return a boolean. {@code true} if the type is valid, else {@code false}
Paul Jensen1c9f2e42015-05-06 10:42:25 -0400947 * @deprecated All APIs accepting a network type are deprecated. There should be no need to
948 * validate a network type.
Robert Greenwalt26744a52013-02-15 10:56:35 -0800949 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -0700950 @Deprecated
Jeff Sharkey21062e72011-05-28 20:56:34 -0700951 public static boolean isNetworkTypeValid(int networkType) {
Hugo Benichi37d5c3c2017-06-20 14:07:59 +0900952 return MIN_NETWORK_TYPE <= networkType && networkType <= MAX_NETWORK_TYPE;
The Android Open Source Project28527d22009-03-03 19:31:44 -0800953 }
954
Robert Greenwalt26744a52013-02-15 10:56:35 -0800955 /**
956 * Returns a non-localized string representing a given network type.
957 * ONLY used for debugging output.
958 * @param type the type needing naming
959 * @return a String for the given type, or a string version of the type ("87")
960 * if no name is known.
Chalard Jean5acb7b72018-03-08 13:54:53 +0900961 * @deprecated Types are deprecated. Use {@link NetworkCapabilities} instead.
Robert Greenwalt26744a52013-02-15 10:56:35 -0800962 * {@hide}
963 */
Chalard Jean5acb7b72018-03-08 13:54:53 +0900964 @Deprecated
Mathew Inwoodd078d3d2020-10-27 11:47:29 +0000965 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
Jeff Sharkey21062e72011-05-28 20:56:34 -0700966 public static String getNetworkTypeName(int type) {
967 switch (type) {
Hugo Benichi37d5c3c2017-06-20 14:07:59 +0900968 case TYPE_NONE:
969 return "NONE";
Jeff Sharkey21062e72011-05-28 20:56:34 -0700970 case TYPE_MOBILE:
971 return "MOBILE";
972 case TYPE_WIFI:
973 return "WIFI";
974 case TYPE_MOBILE_MMS:
975 return "MOBILE_MMS";
976 case TYPE_MOBILE_SUPL:
977 return "MOBILE_SUPL";
978 case TYPE_MOBILE_DUN:
979 return "MOBILE_DUN";
980 case TYPE_MOBILE_HIPRI:
981 return "MOBILE_HIPRI";
982 case TYPE_WIMAX:
983 return "WIMAX";
984 case TYPE_BLUETOOTH:
985 return "BLUETOOTH";
986 case TYPE_DUMMY:
987 return "DUMMY";
988 case TYPE_ETHERNET:
989 return "ETHERNET";
990 case TYPE_MOBILE_FOTA:
991 return "MOBILE_FOTA";
992 case TYPE_MOBILE_IMS:
993 return "MOBILE_IMS";
994 case TYPE_MOBILE_CBS:
995 return "MOBILE_CBS";
repo syncf5de5572011-07-29 23:55:49 -0700996 case TYPE_WIFI_P2P:
997 return "WIFI_P2P";
Wink Saville70dbdcc2013-07-29 15:00:57 -0700998 case TYPE_MOBILE_IA:
999 return "MOBILE_IA";
Ram201d45f2014-06-26 11:03:44 -07001000 case TYPE_MOBILE_EMERGENCY:
1001 return "MOBILE_EMERGENCY";
Hui Lu07f29332014-01-15 11:05:36 -05001002 case TYPE_PROXY:
1003 return "PROXY";
Erik Klineb1ff7002014-11-19 17:23:41 +09001004 case TYPE_VPN:
1005 return "VPN";
Jeff Sharkey21062e72011-05-28 20:56:34 -07001006 default:
1007 return Integer.toString(type);
1008 }
1009 }
1010
Robert Greenwalt26744a52013-02-15 10:56:35 -08001011 /**
Aaron Huangdfba5d12020-06-27 07:18:23 +08001012 * @hide
Aaron Huangdfba5d12020-06-27 07:18:23 +08001013 */
lucaslin8c121bf2021-03-17 14:16:01 +08001014 @SystemApi(client = MODULE_LIBRARIES)
Aaron Huangdfba5d12020-06-27 07:18:23 +08001015 public void systemReady() {
1016 try {
1017 mService.systemReady();
1018 } catch (RemoteException e) {
1019 throw e.rethrowFromSystemServer();
1020 }
1021 }
1022
1023 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -08001024 * Checks if a given type uses the cellular data connection.
1025 * This should be replaced in the future by a network property.
1026 * @param networkType the type to check
1027 * @return a boolean - {@code true} if uses cellular network, else {@code false}
Chalard Jean5acb7b72018-03-08 13:54:53 +09001028 * @deprecated Types are deprecated. Use {@link NetworkCapabilities} instead.
Robert Greenwalt26744a52013-02-15 10:56:35 -08001029 * {@hide}
1030 */
Chalard Jean5acb7b72018-03-08 13:54:53 +09001031 @Deprecated
Chalard Jeanaa91c9d2019-04-09 15:46:21 +09001032 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 130143562)
Jeff Sharkey21062e72011-05-28 20:56:34 -07001033 public static boolean isNetworkTypeMobile(int networkType) {
1034 switch (networkType) {
1035 case TYPE_MOBILE:
1036 case TYPE_MOBILE_MMS:
1037 case TYPE_MOBILE_SUPL:
1038 case TYPE_MOBILE_DUN:
1039 case TYPE_MOBILE_HIPRI:
1040 case TYPE_MOBILE_FOTA:
1041 case TYPE_MOBILE_IMS:
1042 case TYPE_MOBILE_CBS:
Wink Saville70dbdcc2013-07-29 15:00:57 -07001043 case TYPE_MOBILE_IA:
Ram201d45f2014-06-26 11:03:44 -07001044 case TYPE_MOBILE_EMERGENCY:
Jeff Sharkey21062e72011-05-28 20:56:34 -07001045 return true;
1046 default:
1047 return false;
1048 }
1049 }
1050
Robert Greenwalt26744a52013-02-15 10:56:35 -08001051 /**
Jeff Sharkeye9bda1d2013-06-04 12:29:00 -07001052 * Checks if the given network type is backed by a Wi-Fi radio.
1053 *
Chalard Jean5acb7b72018-03-08 13:54:53 +09001054 * @deprecated Types are deprecated. Use {@link NetworkCapabilities} instead.
Jeff Sharkeye9bda1d2013-06-04 12:29:00 -07001055 * @hide
1056 */
Chalard Jean5acb7b72018-03-08 13:54:53 +09001057 @Deprecated
Jeff Sharkeye9bda1d2013-06-04 12:29:00 -07001058 public static boolean isNetworkTypeWifi(int networkType) {
1059 switch (networkType) {
1060 case TYPE_WIFI:
1061 case TYPE_WIFI_P2P:
1062 return true;
1063 default:
1064 return false;
1065 }
1066 }
1067
1068 /**
Chalard Jean03433052021-02-25 17:23:40 +09001069 * Preference for {@link #setNetworkPreferenceForUser(UserHandle, int, Executor, Runnable)}.
1070 * Specify that the traffic for this user should by follow the default rules.
1071 * @hide
1072 */
Chalard Jean560d4032021-03-17 14:33:24 +09001073 @SystemApi(client = MODULE_LIBRARIES)
Chalard Jean03433052021-02-25 17:23:40 +09001074 public static final int PROFILE_NETWORK_PREFERENCE_DEFAULT = 0;
1075
1076 /**
1077 * Preference for {@link #setNetworkPreferenceForUser(UserHandle, int, Executor, Runnable)}.
1078 * Specify that the traffic for this user should by default go on a network with
1079 * {@link NetworkCapabilities#NET_CAPABILITY_ENTERPRISE}, and on the system default network
1080 * if no such network is available.
1081 * @hide
1082 */
Chalard Jean560d4032021-03-17 14:33:24 +09001083 @SystemApi(client = MODULE_LIBRARIES)
Chalard Jean03433052021-02-25 17:23:40 +09001084 public static final int PROFILE_NETWORK_PREFERENCE_ENTERPRISE = 1;
1085
1086 /** @hide */
1087 @Retention(RetentionPolicy.SOURCE)
1088 @IntDef(value = {
1089 PROFILE_NETWORK_PREFERENCE_DEFAULT,
1090 PROFILE_NETWORK_PREFERENCE_ENTERPRISE
1091 })
1092 public @interface ProfileNetworkPreference {
1093 }
1094
1095 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -08001096 * Specifies the preferred network type. When the device has more
1097 * than one type available the preferred network type will be used.
Robert Greenwalt26744a52013-02-15 10:56:35 -08001098 *
1099 * @param preference the network type to prefer over all others. It is
1100 * unspecified what happens to the old preferred network in the
1101 * overall ordering.
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07001102 * @deprecated Functionality has been removed as it no longer makes sense,
1103 * with many more than two networks - we'd need an array to express
1104 * preference. Instead we use dynamic network properties of
1105 * the networks to describe their precedence.
Robert Greenwalt26744a52013-02-15 10:56:35 -08001106 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -07001107 @Deprecated
The Android Open Source Project28527d22009-03-03 19:31:44 -08001108 public void setNetworkPreference(int preference) {
The Android Open Source Project28527d22009-03-03 19:31:44 -08001109 }
1110
Robert Greenwalt26744a52013-02-15 10:56:35 -08001111 /**
1112 * Retrieves the current preferred network type.
Robert Greenwalt26744a52013-02-15 10:56:35 -08001113 *
1114 * @return an integer representing the preferred network type
1115 *
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07001116 * @deprecated Functionality has been removed as it no longer makes sense,
1117 * with many more than two networks - we'd need an array to express
1118 * preference. Instead we use dynamic network properties of
1119 * the networks to describe their precedence.
Robert Greenwalt26744a52013-02-15 10:56:35 -08001120 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -07001121 @Deprecated
Jeff Sharkey2ac62992017-04-24 11:18:03 -06001122 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
The Android Open Source Project28527d22009-03-03 19:31:44 -08001123 public int getNetworkPreference() {
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07001124 return TYPE_NONE;
The Android Open Source Project28527d22009-03-03 19:31:44 -08001125 }
1126
Scott Mainf58b7d82011-10-06 19:02:28 -07001127 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -08001128 * Returns details about the currently active default data network. When
1129 * connected, this network is the default route for outgoing connections.
1130 * You should always check {@link NetworkInfo#isConnected()} before initiating
1131 * network traffic. This may return {@code null} when there is no default
1132 * network.
Chalard Jean7c85ba42018-03-29 17:45:24 +09001133 * Note that if the default network is a VPN, this method will return the
1134 * NetworkInfo for one of its underlying networks instead, or null if the
1135 * VPN agent did not specify any. Apps interested in learning about VPNs
1136 * should use {@link #getNetworkInfo(android.net.Network)} instead.
Robert Greenwalt26744a52013-02-15 10:56:35 -08001137 *
1138 * @return a {@link NetworkInfo} object for the current default network
Paul Jensena9208b92015-02-13 14:18:39 -05001139 * or {@code null} if no default network is currently active
junyulai5c2f6262018-12-13 12:47:51 +08001140 * @deprecated See {@link NetworkInfo}.
Jeff Sharkeyd00b1302012-04-12 18:34:54 -07001141 */
junyulai5c2f6262018-12-13 12:47:51 +08001142 @Deprecated
Jeff Sharkey2ac62992017-04-24 11:18:03 -06001143 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean42a9c292019-01-07 19:26:34 +09001144 @Nullable
The Android Open Source Project28527d22009-03-03 19:31:44 -08001145 public NetworkInfo getActiveNetworkInfo() {
1146 try {
1147 return mService.getActiveNetworkInfo();
1148 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07001149 throw e.rethrowFromSystemServer();
The Android Open Source Project28527d22009-03-03 19:31:44 -08001150 }
1151 }
1152
Robert Greenwalt26744a52013-02-15 10:56:35 -08001153 /**
Paul Jensenc2569432015-02-13 14:18:39 -05001154 * Returns a {@link Network} object corresponding to the currently active
1155 * default data network. In the event that the current active default data
1156 * network disconnects, the returned {@code Network} object will no longer
1157 * be usable. This will return {@code null} when there is no default
1158 * network.
1159 *
1160 * @return a {@link Network} object for the current default network or
1161 * {@code null} if no default network is currently active
Paul Jensenc2569432015-02-13 14:18:39 -05001162 */
Jeff Sharkey2ac62992017-04-24 11:18:03 -06001163 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean42a9c292019-01-07 19:26:34 +09001164 @Nullable
Paul Jensenc2569432015-02-13 14:18:39 -05001165 public Network getActiveNetwork() {
1166 try {
1167 return mService.getActiveNetwork();
1168 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07001169 throw e.rethrowFromSystemServer();
Paul Jensenc2569432015-02-13 14:18:39 -05001170 }
1171 }
1172
1173 /**
Robin Leeda4d2e22016-03-24 12:07:00 +00001174 * Returns a {@link Network} object corresponding to the currently active
1175 * default data network for a specific UID. In the event that the default data
1176 * network disconnects, the returned {@code Network} object will no longer
1177 * be usable. This will return {@code null} when there is no default
1178 * network for the UID.
Robin Leeda4d2e22016-03-24 12:07:00 +00001179 *
1180 * @return a {@link Network} object for the current default network for the
1181 * given UID or {@code null} if no default network is currently active
lifr5f1c1102021-03-30 21:04:53 +08001182 *
1183 * @hide
Robin Leeda4d2e22016-03-24 12:07:00 +00001184 */
paulhuec0a9632019-08-12 16:25:11 +08001185 @RequiresPermission(android.Manifest.permission.NETWORK_STACK)
Chalard Jean42a9c292019-01-07 19:26:34 +09001186 @Nullable
Robin Leeda4d2e22016-03-24 12:07:00 +00001187 public Network getActiveNetworkForUid(int uid) {
Jeff Sharkey833c35b2016-04-28 15:33:18 -06001188 return getActiveNetworkForUid(uid, false);
1189 }
1190
1191 /** {@hide} */
1192 public Network getActiveNetworkForUid(int uid, boolean ignoreBlocked) {
Robin Leeda4d2e22016-03-24 12:07:00 +00001193 try {
Jeff Sharkey833c35b2016-04-28 15:33:18 -06001194 return mService.getActiveNetworkForUid(uid, ignoreBlocked);
Robin Leeda4d2e22016-03-24 12:07:00 +00001195 } catch (RemoteException e) {
1196 throw e.rethrowFromSystemServer();
1197 }
1198 }
1199
1200 /**
Lorenzo Colittie8ce2052020-12-12 00:51:11 +09001201 * Adds or removes a requirement for given UID ranges to use the VPN.
1202 *
1203 * If set to {@code true}, informs the system that the UIDs in the specified ranges must not
1204 * have any connectivity except if a VPN is connected and applies to the UIDs, or if the UIDs
1205 * otherwise have permission to bypass the VPN (e.g., because they have the
1206 * {@link android.Manifest.permission.CONNECTIVITY_USE_RESTRICTED_NETWORKS} permission, or when
1207 * using a socket protected by a method such as {@link VpnService#protect(DatagramSocket)}. If
1208 * set to {@code false}, a previously-added restriction is removed.
1209 * <p>
1210 * Each of the UID ranges specified by this method is added and removed as is, and no processing
1211 * is performed on the ranges to de-duplicate, merge, split, or intersect them. In order to
1212 * remove a previously-added range, the exact range must be removed as is.
1213 * <p>
1214 * The changes are applied asynchronously and may not have been applied by the time the method
1215 * returns. Apps will be notified about any changes that apply to them via
1216 * {@link NetworkCallback#onBlockedStatusChanged} callbacks called after the changes take
1217 * effect.
1218 * <p>
1219 * This method should be called only by the VPN code.
1220 *
1221 * @param ranges the UID ranges to restrict
1222 * @param requireVpn whether the specified UID ranges must use a VPN
1223 *
Lorenzo Colittie8ce2052020-12-12 00:51:11 +09001224 * @hide
1225 */
1226 @RequiresPermission(anyOf = {
1227 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
lucaslin5140e482021-03-22 11:51:27 +08001228 android.Manifest.permission.NETWORK_STACK,
1229 android.Manifest.permission.NETWORK_SETTINGS})
1230 @SystemApi(client = MODULE_LIBRARIES)
Lorenzo Colittie8ce2052020-12-12 00:51:11 +09001231 public void setRequireVpnForUids(boolean requireVpn,
1232 @NonNull Collection<Range<Integer>> ranges) {
1233 Objects.requireNonNull(ranges);
1234 // The Range class is not parcelable. Convert to UidRange, which is what is used internally.
1235 // This method is not necessarily expected to be used outside the system server, so
1236 // parceling may not be necessary, but it could be used out-of-process, e.g., by the network
1237 // stack process, or by tests.
1238 UidRange[] rangesArray = new UidRange[ranges.size()];
1239 int index = 0;
1240 for (Range<Integer> range : ranges) {
1241 rangesArray[index++] = new UidRange(range.getLower(), range.getUpper());
1242 }
1243 try {
1244 mService.setRequireVpnForUids(requireVpn, rangesArray);
1245 } catch (RemoteException e) {
1246 throw e.rethrowFromSystemServer();
1247 }
1248 }
1249
1250 /**
Lorenzo Colitti549e9ac2021-01-15 01:29:01 +09001251 * Informs ConnectivityService of whether the legacy lockdown VPN, as implemented by
1252 * LockdownVpnTracker, is in use. This is deprecated for new devices starting from Android 12
1253 * but is still supported for backwards compatibility.
1254 * <p>
1255 * This type of VPN is assumed always to use the system default network, and must always declare
1256 * exactly one underlying network, which is the network that was the default when the VPN
1257 * connected.
1258 * <p>
1259 * Calling this method with {@code true} enables legacy behaviour, specifically:
1260 * <ul>
1261 * <li>Any VPN that applies to userId 0 behaves specially with respect to deprecated
1262 * {@link #CONNECTIVITY_ACTION} broadcasts. Any such broadcasts will have the state in the
1263 * {@link #EXTRA_NETWORK_INFO} replaced by state of the VPN network. Also, any time the VPN
1264 * connects, a {@link #CONNECTIVITY_ACTION} broadcast will be sent for the network
1265 * underlying the VPN.</li>
1266 * <li>Deprecated APIs that return {@link NetworkInfo} objects will have their state
1267 * similarly replaced by the VPN network state.</li>
1268 * <li>Information on current network interfaces passed to NetworkStatsService will not
1269 * include any VPN interfaces.</li>
1270 * </ul>
1271 *
1272 * @param enabled whether legacy lockdown VPN is enabled or disabled
1273 *
Lorenzo Colitti549e9ac2021-01-15 01:29:01 +09001274 * @hide
1275 */
1276 @RequiresPermission(anyOf = {
1277 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
lucaslin5140e482021-03-22 11:51:27 +08001278 android.Manifest.permission.NETWORK_STACK,
Lorenzo Colitti549e9ac2021-01-15 01:29:01 +09001279 android.Manifest.permission.NETWORK_SETTINGS})
lucaslin5140e482021-03-22 11:51:27 +08001280 @SystemApi(client = MODULE_LIBRARIES)
Lorenzo Colitti549e9ac2021-01-15 01:29:01 +09001281 public void setLegacyLockdownVpnEnabled(boolean enabled) {
1282 try {
1283 mService.setLegacyLockdownVpnEnabled(enabled);
1284 } catch (RemoteException e) {
1285 throw e.rethrowFromSystemServer();
1286 }
1287 }
1288
1289 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -08001290 * Returns details about the currently active default data network
1291 * for a given uid. This is for internal use only to avoid spying
1292 * other apps.
1293 *
1294 * @return a {@link NetworkInfo} object for the current default network
1295 * for the given uid or {@code null} if no default network is
1296 * available for the specified uid.
1297 *
Robert Greenwalt26744a52013-02-15 10:56:35 -08001298 * {@hide}
1299 */
paulhuec0a9632019-08-12 16:25:11 +08001300 @RequiresPermission(android.Manifest.permission.NETWORK_STACK)
Mathew Inwoodd078d3d2020-10-27 11:47:29 +00001301 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
Jeff Sharkey921ebf22011-05-19 17:12:49 -07001302 public NetworkInfo getActiveNetworkInfoForUid(int uid) {
Jeff Sharkey833c35b2016-04-28 15:33:18 -06001303 return getActiveNetworkInfoForUid(uid, false);
1304 }
1305
1306 /** {@hide} */
1307 public NetworkInfo getActiveNetworkInfoForUid(int uid, boolean ignoreBlocked) {
Jeff Sharkey921ebf22011-05-19 17:12:49 -07001308 try {
Jeff Sharkey833c35b2016-04-28 15:33:18 -06001309 return mService.getActiveNetworkInfoForUid(uid, ignoreBlocked);
Jeff Sharkey921ebf22011-05-19 17:12:49 -07001310 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07001311 throw e.rethrowFromSystemServer();
Jeff Sharkey921ebf22011-05-19 17:12:49 -07001312 }
1313 }
1314
Robert Greenwalt26744a52013-02-15 10:56:35 -08001315 /**
1316 * Returns connection status information about a particular
1317 * network type.
1318 *
1319 * @param networkType integer specifying which networkType in
1320 * which you're interested.
1321 * @return a {@link NetworkInfo} object for the requested
1322 * network type or {@code null} if the type is not
Chalard Jean7c85ba42018-03-29 17:45:24 +09001323 * supported by the device. If {@code networkType} is
1324 * TYPE_VPN and a VPN is active for the calling app,
1325 * then this method will try to return one of the
1326 * underlying networks for the VPN or null if the
1327 * VPN agent didn't specify any.
Robert Greenwalt26744a52013-02-15 10:56:35 -08001328 *
Paul Jensena8e6dc62015-03-18 12:23:02 -04001329 * @deprecated This method does not support multiple connected networks
1330 * of the same type. Use {@link #getAllNetworks} and
1331 * {@link #getNetworkInfo(android.net.Network)} instead.
Robert Greenwalt26744a52013-02-15 10:56:35 -08001332 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -07001333 @Deprecated
Jeff Sharkey2ac62992017-04-24 11:18:03 -06001334 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean42a9c292019-01-07 19:26:34 +09001335 @Nullable
The Android Open Source Project28527d22009-03-03 19:31:44 -08001336 public NetworkInfo getNetworkInfo(int networkType) {
1337 try {
1338 return mService.getNetworkInfo(networkType);
1339 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07001340 throw e.rethrowFromSystemServer();
The Android Open Source Project28527d22009-03-03 19:31:44 -08001341 }
1342 }
1343
Robert Greenwalt26744a52013-02-15 10:56:35 -08001344 /**
Robert Greenwalt701a5c32014-06-23 11:40:00 -07001345 * Returns connection status information about a particular
1346 * Network.
1347 *
1348 * @param network {@link Network} specifying which network
1349 * in which you're interested.
1350 * @return a {@link NetworkInfo} object for the requested
1351 * network or {@code null} if the {@code Network}
1352 * is not valid.
junyulai5c2f6262018-12-13 12:47:51 +08001353 * @deprecated See {@link NetworkInfo}.
Robert Greenwalt701a5c32014-06-23 11:40:00 -07001354 */
junyulai5c2f6262018-12-13 12:47:51 +08001355 @Deprecated
Jeff Sharkey2ac62992017-04-24 11:18:03 -06001356 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean42a9c292019-01-07 19:26:34 +09001357 @Nullable
1358 public NetworkInfo getNetworkInfo(@Nullable Network network) {
Jeff Sharkey833c35b2016-04-28 15:33:18 -06001359 return getNetworkInfoForUid(network, Process.myUid(), false);
1360 }
1361
1362 /** {@hide} */
1363 public NetworkInfo getNetworkInfoForUid(Network network, int uid, boolean ignoreBlocked) {
Robert Greenwalt701a5c32014-06-23 11:40:00 -07001364 try {
Jeff Sharkey833c35b2016-04-28 15:33:18 -06001365 return mService.getNetworkInfoForUid(network, uid, ignoreBlocked);
Robert Greenwalt701a5c32014-06-23 11:40:00 -07001366 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07001367 throw e.rethrowFromSystemServer();
Robert Greenwalt701a5c32014-06-23 11:40:00 -07001368 }
1369 }
1370
1371 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -08001372 * Returns connection status information about all network
1373 * types supported by the device.
1374 *
1375 * @return an array of {@link NetworkInfo} objects. Check each
1376 * {@link NetworkInfo#getType} for which type each applies.
1377 *
Paul Jensena8e6dc62015-03-18 12:23:02 -04001378 * @deprecated This method does not support multiple connected networks
1379 * of the same type. Use {@link #getAllNetworks} and
1380 * {@link #getNetworkInfo(android.net.Network)} instead.
Robert Greenwalt26744a52013-02-15 10:56:35 -08001381 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -07001382 @Deprecated
Jeff Sharkey2ac62992017-04-24 11:18:03 -06001383 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean42a9c292019-01-07 19:26:34 +09001384 @NonNull
The Android Open Source Project28527d22009-03-03 19:31:44 -08001385 public NetworkInfo[] getAllNetworkInfo() {
1386 try {
1387 return mService.getAllNetworkInfo();
1388 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07001389 throw e.rethrowFromSystemServer();
The Android Open Source Project28527d22009-03-03 19:31:44 -08001390 }
1391 }
1392
Robert Greenwalt26744a52013-02-15 10:56:35 -08001393 /**
junyulai57840802021-03-03 12:09:05 +08001394 * Return a list of {@link NetworkStateSnapshot}s, one for each network that is currently
1395 * connected.
1396 * @hide
1397 */
1398 @SystemApi(client = MODULE_LIBRARIES)
1399 @RequiresPermission(anyOf = {
1400 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
1401 android.Manifest.permission.NETWORK_STACK,
1402 android.Manifest.permission.NETWORK_SETTINGS})
1403 @NonNull
Aaron Huang20605e52021-04-17 13:46:25 +08001404 public List<NetworkStateSnapshot> getAllNetworkStateSnapshots() {
junyulai57840802021-03-03 12:09:05 +08001405 try {
Aaron Huang20605e52021-04-17 13:46:25 +08001406 return mService.getAllNetworkStateSnapshots();
junyulai57840802021-03-03 12:09:05 +08001407 } catch (RemoteException e) {
1408 throw e.rethrowFromSystemServer();
1409 }
1410 }
1411
1412 /**
Lorenzo Colitti2b2d73c2014-08-22 17:10:50 -07001413 * Returns the {@link Network} object currently serving a given type, or
1414 * null if the given type is not connected.
1415 *
Lorenzo Colitti2b2d73c2014-08-22 17:10:50 -07001416 * @hide
Paul Jensena8e6dc62015-03-18 12:23:02 -04001417 * @deprecated This method does not support multiple connected networks
1418 * of the same type. Use {@link #getAllNetworks} and
1419 * {@link #getNetworkInfo(android.net.Network)} instead.
Lorenzo Colitti2b2d73c2014-08-22 17:10:50 -07001420 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -07001421 @Deprecated
Jeff Sharkey2ac62992017-04-24 11:18:03 -06001422 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Mathew Inwood0b8f8612018-08-08 14:52:47 +01001423 @UnsupportedAppUsage
Lorenzo Colitti2b2d73c2014-08-22 17:10:50 -07001424 public Network getNetworkForType(int networkType) {
1425 try {
1426 return mService.getNetworkForType(networkType);
1427 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07001428 throw e.rethrowFromSystemServer();
Lorenzo Colitti2b2d73c2014-08-22 17:10:50 -07001429 }
1430 }
1431
1432 /**
Robert Greenwalt701a5c32014-06-23 11:40:00 -07001433 * Returns an array of all {@link Network} currently tracked by the
1434 * framework.
Paul Jensen19b3ee72015-05-06 11:10:18 -04001435 *
1436 * @return an array of {@link Network} objects.
Robert Greenwalt701a5c32014-06-23 11:40:00 -07001437 */
Jeff Sharkey2ac62992017-04-24 11:18:03 -06001438 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean42a9c292019-01-07 19:26:34 +09001439 @NonNull
Robert Greenwalt701a5c32014-06-23 11:40:00 -07001440 public Network[] getAllNetworks() {
1441 try {
1442 return mService.getAllNetworks();
1443 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07001444 throw e.rethrowFromSystemServer();
Robert Greenwalt701a5c32014-06-23 11:40:00 -07001445 }
1446 }
1447
1448 /**
Roshan Pius7992afd2020-12-22 15:10:42 -08001449 * Returns an array of {@link NetworkCapabilities} objects, representing
Lorenzo Colitti8db934a2014-11-28 11:21:30 +09001450 * the Networks that applications run by the given user will use by default.
1451 * @hide
1452 */
Mathew Inwood0b8f8612018-08-08 14:52:47 +01001453 @UnsupportedAppUsage
Lorenzo Colitti8db934a2014-11-28 11:21:30 +09001454 public NetworkCapabilities[] getDefaultNetworkCapabilitiesForUser(int userId) {
1455 try {
Qingxi Libf6bf082020-01-08 12:51:49 -08001456 return mService.getDefaultNetworkCapabilitiesForUser(
Roshan Piusc97d8062020-12-17 14:53:09 -08001457 userId, mContext.getOpPackageName(), getAttributionTag());
Lorenzo Colitti8db934a2014-11-28 11:21:30 +09001458 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07001459 throw e.rethrowFromSystemServer();
Lorenzo Colitti8db934a2014-11-28 11:21:30 +09001460 }
1461 }
1462
1463 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -08001464 * Returns the IP information for the current default network.
1465 *
1466 * @return a {@link LinkProperties} object describing the IP info
1467 * for the current default network, or {@code null} if there
1468 * is no current default network.
1469 *
Robert Greenwalt26744a52013-02-15 10:56:35 -08001470 * {@hide}
Chalard Jeancc47b522019-01-11 16:47:53 +09001471 * @deprecated please use {@link #getLinkProperties(Network)} on the return
1472 * value of {@link #getActiveNetwork()} instead. In particular,
1473 * this method will return non-null LinkProperties even if the
1474 * app is blocked by policy from using this network.
Robert Greenwalt26744a52013-02-15 10:56:35 -08001475 */
Jeff Sharkey2ac62992017-04-24 11:18:03 -06001476 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jeancc47b522019-01-11 16:47:53 +09001477 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 109783091)
Robert Greenwalt9f0ee4f2010-09-14 09:18:02 -07001478 public LinkProperties getActiveLinkProperties() {
1479 try {
1480 return mService.getActiveLinkProperties();
1481 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07001482 throw e.rethrowFromSystemServer();
Robert Greenwalt9f0ee4f2010-09-14 09:18:02 -07001483 }
1484 }
1485
Robert Greenwalt26744a52013-02-15 10:56:35 -08001486 /**
1487 * Returns the IP information for a given network type.
1488 *
1489 * @param networkType the network type of interest.
1490 * @return a {@link LinkProperties} object describing the IP info
1491 * for the given networkType, or {@code null} if there is
1492 * no current default network.
1493 *
Robert Greenwalt26744a52013-02-15 10:56:35 -08001494 * {@hide}
Paul Jensena8e6dc62015-03-18 12:23:02 -04001495 * @deprecated This method does not support multiple connected networks
1496 * of the same type. Use {@link #getAllNetworks},
1497 * {@link #getNetworkInfo(android.net.Network)}, and
1498 * {@link #getLinkProperties(android.net.Network)} instead.
Robert Greenwalt26744a52013-02-15 10:56:35 -08001499 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -07001500 @Deprecated
Jeff Sharkey2ac62992017-04-24 11:18:03 -06001501 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jeanaa91c9d2019-04-09 15:46:21 +09001502 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 130143562)
Robert Greenwalt9f0ee4f2010-09-14 09:18:02 -07001503 public LinkProperties getLinkProperties(int networkType) {
1504 try {
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07001505 return mService.getLinkPropertiesForType(networkType);
1506 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07001507 throw e.rethrowFromSystemServer();
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07001508 }
1509 }
1510
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07001511 /**
1512 * Get the {@link LinkProperties} for the given {@link Network}. This
1513 * will return {@code null} if the network is unknown.
1514 *
1515 * @param network The {@link Network} object identifying the network in question.
1516 * @return The {@link LinkProperties} for the network, or {@code null}.
Paul Jensen19b3ee72015-05-06 11:10:18 -04001517 */
Jeff Sharkey2ac62992017-04-24 11:18:03 -06001518 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean42a9c292019-01-07 19:26:34 +09001519 @Nullable
1520 public LinkProperties getLinkProperties(@Nullable Network network) {
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07001521 try {
1522 return mService.getLinkProperties(network);
1523 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07001524 throw e.rethrowFromSystemServer();
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07001525 }
1526 }
1527
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07001528 /**
Roshan Pius7992afd2020-12-22 15:10:42 -08001529 * Get the {@link NetworkCapabilities} for the given {@link Network}. This
Chalard Jean39b21a32021-04-30 20:22:10 +09001530 * will return {@code null} if the network is unknown or if the |network| argument is null.
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07001531 *
Roshan Pius7992afd2020-12-22 15:10:42 -08001532 * This will remove any location sensitive data in {@link TransportInfo} embedded in
1533 * {@link NetworkCapabilities#getTransportInfo()}. Some transport info instances like
1534 * {@link android.net.wifi.WifiInfo} contain location sensitive information. Retrieving
1535 * this location sensitive information (subject to app's location permissions) will be
1536 * noted by system. To include any location sensitive data in {@link TransportInfo},
1537 * use a {@link NetworkCallback} with
1538 * {@link NetworkCallback#FLAG_INCLUDE_LOCATION_INFO} flag.
1539 *
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07001540 * @param network The {@link Network} object identifying the network in question.
Roshan Pius7992afd2020-12-22 15:10:42 -08001541 * @return The {@link NetworkCapabilities} for the network, or {@code null}.
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07001542 */
Jeff Sharkey2ac62992017-04-24 11:18:03 -06001543 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean42a9c292019-01-07 19:26:34 +09001544 @Nullable
1545 public NetworkCapabilities getNetworkCapabilities(@Nullable Network network) {
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07001546 try {
Roshan Piusc97d8062020-12-17 14:53:09 -08001547 return mService.getNetworkCapabilities(
1548 network, mContext.getOpPackageName(), getAttributionTag());
Robert Greenwalt9f0ee4f2010-09-14 09:18:02 -07001549 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07001550 throw e.rethrowFromSystemServer();
Robert Greenwalt9f0ee4f2010-09-14 09:18:02 -07001551 }
1552 }
1553
Robert Greenwalt26744a52013-02-15 10:56:35 -08001554 /**
Remi NGUYEN VAN69a57cb2019-03-20 14:22:49 +09001555 * Gets a URL that can be used for resolving whether a captive portal is present.
Udam Saini53b71ee2016-01-04 12:16:14 -08001556 * 1. This URL should respond with a 204 response to a GET request to indicate no captive
1557 * portal is present.
1558 * 2. This URL must be HTTP as redirect responses are used to find captive portal
1559 * sign-in pages. Captive portals cannot respond to HTTPS requests with redirects.
1560 *
Remi NGUYEN VAN69a57cb2019-03-20 14:22:49 +09001561 * The system network validation may be using different strategies to detect captive portals,
1562 * so this method does not necessarily return a URL used by the system. It only returns a URL
1563 * that may be relevant for other components trying to detect captive portals.
paulhuec0a9632019-08-12 16:25:11 +08001564 *
Udam Saini53b71ee2016-01-04 12:16:14 -08001565 * @hide
paulhuec0a9632019-08-12 16:25:11 +08001566 * @deprecated This API returns URL which is not guaranteed to be one of the URLs used by the
1567 * system.
Udam Saini53b71ee2016-01-04 12:16:14 -08001568 */
paulhuec0a9632019-08-12 16:25:11 +08001569 @Deprecated
Udam Saini53b71ee2016-01-04 12:16:14 -08001570 @SystemApi
paulhuec0a9632019-08-12 16:25:11 +08001571 @RequiresPermission(android.Manifest.permission.NETWORK_SETTINGS)
Udam Saini53b71ee2016-01-04 12:16:14 -08001572 public String getCaptivePortalServerUrl() {
1573 try {
1574 return mService.getCaptivePortalServerUrl();
1575 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07001576 throw e.rethrowFromSystemServer();
Udam Saini53b71ee2016-01-04 12:16:14 -08001577 }
1578 }
1579
1580 /**
The Android Open Source Project28527d22009-03-03 19:31:44 -08001581 * Tells the underlying networking system that the caller wants to
1582 * begin using the named feature. The interpretation of {@code feature}
1583 * is completely up to each networking implementation.
Lorenzo Colitti91de63b2015-10-15 16:29:00 +09001584 *
1585 * <p>This method requires the caller to hold either the
1586 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
1587 * or the ability to modify system settings as determined by
1588 * {@link android.provider.Settings.System#canWrite}.</p>
1589 *
The Android Open Source Project28527d22009-03-03 19:31:44 -08001590 * @param networkType specifies which network the request pertains to
1591 * @param feature the name of the feature to be used
1592 * @return an integer value representing the outcome of the request.
1593 * The interpretation of this value is specific to each networking
1594 * implementation+feature combination, except that the value {@code -1}
1595 * always indicates failure.
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07001596 *
Lorenzo Colittiefd396e2015-04-24 17:03:31 +09001597 * @deprecated Deprecated in favor of the cleaner
1598 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} API.
Dianne Hackbornc16abda2015-07-31 10:35:34 -07001599 * In {@link VERSION_CODES#M}, and above, this method is unsupported and will
Lorenzo Colitti9b026fa2015-07-29 11:41:21 +09001600 * throw {@code UnsupportedOperationException} if called.
Lorenzo Colitti7cb18342016-12-09 18:39:30 +09001601 * @removed
The Android Open Source Project28527d22009-03-03 19:31:44 -08001602 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -07001603 @Deprecated
The Android Open Source Project28527d22009-03-03 19:31:44 -08001604 public int startUsingNetworkFeature(int networkType, String feature) {
Lorenzo Colitti9b026fa2015-07-29 11:41:21 +09001605 checkLegacyRoutingApiAccess();
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001606 NetworkCapabilities netCap = networkCapabilitiesForFeature(networkType, feature);
1607 if (netCap == null) {
1608 Log.d(TAG, "Can't satisfy startUsingNetworkFeature for " + networkType + ", " +
1609 feature);
Chalard Jean1f42df12019-11-21 14:48:00 +09001610 return DEPRECATED_PHONE_CONSTANT_APN_REQUEST_FAILED;
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001611 }
1612
1613 NetworkRequest request = null;
1614 synchronized (sLegacyRequests) {
1615 LegacyRequest l = sLegacyRequests.get(netCap);
1616 if (l != null) {
1617 Log.d(TAG, "renewing startUsingNetworkFeature request " + l.networkRequest);
1618 renewRequestLocked(l);
1619 if (l.currentNetwork != null) {
Chalard Jean1f42df12019-11-21 14:48:00 +09001620 return DEPRECATED_PHONE_CONSTANT_APN_ALREADY_ACTIVE;
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001621 } else {
Chalard Jean1f42df12019-11-21 14:48:00 +09001622 return DEPRECATED_PHONE_CONSTANT_APN_REQUEST_STARTED;
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001623 }
1624 }
1625
1626 request = requestNetworkForFeatureLocked(netCap);
1627 }
1628 if (request != null) {
Robert Greenwaltca3c5cf2014-06-20 10:58:45 -07001629 Log.d(TAG, "starting startUsingNetworkFeature for request " + request);
Chalard Jean1f42df12019-11-21 14:48:00 +09001630 return DEPRECATED_PHONE_CONSTANT_APN_REQUEST_STARTED;
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001631 } else {
1632 Log.d(TAG, " request Failed");
Chalard Jean1f42df12019-11-21 14:48:00 +09001633 return DEPRECATED_PHONE_CONSTANT_APN_REQUEST_FAILED;
The Android Open Source Project28527d22009-03-03 19:31:44 -08001634 }
1635 }
1636
1637 /**
1638 * Tells the underlying networking system that the caller is finished
1639 * using the named feature. The interpretation of {@code feature}
1640 * is completely up to each networking implementation.
Lorenzo Colitti91de63b2015-10-15 16:29:00 +09001641 *
1642 * <p>This method requires the caller to hold either the
1643 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
1644 * or the ability to modify system settings as determined by
1645 * {@link android.provider.Settings.System#canWrite}.</p>
1646 *
The Android Open Source Project28527d22009-03-03 19:31:44 -08001647 * @param networkType specifies which network the request pertains to
1648 * @param feature the name of the feature that is no longer needed
1649 * @return an integer value representing the outcome of the request.
1650 * The interpretation of this value is specific to each networking
1651 * implementation+feature combination, except that the value {@code -1}
1652 * always indicates failure.
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07001653 *
Lorenzo Colittiad458ad2016-04-13 22:00:02 +09001654 * @deprecated Deprecated in favor of the cleaner
1655 * {@link #unregisterNetworkCallback(NetworkCallback)} API.
Dianne Hackbornc16abda2015-07-31 10:35:34 -07001656 * In {@link VERSION_CODES#M}, and above, this method is unsupported and will
Lorenzo Colitti9b026fa2015-07-29 11:41:21 +09001657 * throw {@code UnsupportedOperationException} if called.
Lorenzo Colitti7cb18342016-12-09 18:39:30 +09001658 * @removed
The Android Open Source Project28527d22009-03-03 19:31:44 -08001659 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -07001660 @Deprecated
The Android Open Source Project28527d22009-03-03 19:31:44 -08001661 public int stopUsingNetworkFeature(int networkType, String feature) {
Lorenzo Colitti9b026fa2015-07-29 11:41:21 +09001662 checkLegacyRoutingApiAccess();
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001663 NetworkCapabilities netCap = networkCapabilitiesForFeature(networkType, feature);
1664 if (netCap == null) {
1665 Log.d(TAG, "Can't satisfy stopUsingNetworkFeature for " + networkType + ", " +
1666 feature);
The Android Open Source Project28527d22009-03-03 19:31:44 -08001667 return -1;
1668 }
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001669
Paul Jensen034dea32014-12-17 10:39:34 -05001670 if (removeRequestForFeature(netCap)) {
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001671 Log.d(TAG, "stopUsingNetworkFeature for " + networkType + ", " + feature);
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001672 }
1673 return 1;
1674 }
1675
Mathew Inwoodd078d3d2020-10-27 11:47:29 +00001676 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001677 private NetworkCapabilities networkCapabilitiesForFeature(int networkType, String feature) {
1678 if (networkType == TYPE_MOBILE) {
Erik Kline50068e52017-01-26 18:08:28 +09001679 switch (feature) {
1680 case "enableCBS":
1681 return networkCapabilitiesForType(TYPE_MOBILE_CBS);
1682 case "enableDUN":
1683 case "enableDUNAlways":
1684 return networkCapabilitiesForType(TYPE_MOBILE_DUN);
1685 case "enableFOTA":
1686 return networkCapabilitiesForType(TYPE_MOBILE_FOTA);
1687 case "enableHIPRI":
1688 return networkCapabilitiesForType(TYPE_MOBILE_HIPRI);
1689 case "enableIMS":
1690 return networkCapabilitiesForType(TYPE_MOBILE_IMS);
1691 case "enableMMS":
1692 return networkCapabilitiesForType(TYPE_MOBILE_MMS);
1693 case "enableSUPL":
1694 return networkCapabilitiesForType(TYPE_MOBILE_SUPL);
1695 default:
1696 return null;
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001697 }
Erik Kline50068e52017-01-26 18:08:28 +09001698 } else if (networkType == TYPE_WIFI && "p2p".equals(feature)) {
1699 return networkCapabilitiesForType(TYPE_WIFI_P2P);
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001700 }
1701 return null;
1702 }
1703
Robert Greenwalt5a367872014-06-02 15:32:02 -07001704 private int legacyTypeForNetworkCapabilities(NetworkCapabilities netCap) {
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001705 if (netCap == null) return TYPE_NONE;
1706 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_CBS)) {
1707 return TYPE_MOBILE_CBS;
1708 }
1709 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_IMS)) {
1710 return TYPE_MOBILE_IMS;
1711 }
1712 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_FOTA)) {
1713 return TYPE_MOBILE_FOTA;
1714 }
1715 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_DUN)) {
1716 return TYPE_MOBILE_DUN;
1717 }
1718 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_SUPL)) {
1719 return TYPE_MOBILE_SUPL;
1720 }
1721 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_MMS)) {
1722 return TYPE_MOBILE_MMS;
1723 }
1724 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_INTERNET)) {
1725 return TYPE_MOBILE_HIPRI;
1726 }
Robert Greenwalt5a367872014-06-02 15:32:02 -07001727 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_WIFI_P2P)) {
1728 return TYPE_WIFI_P2P;
1729 }
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001730 return TYPE_NONE;
1731 }
1732
1733 private static class LegacyRequest {
1734 NetworkCapabilities networkCapabilities;
1735 NetworkRequest networkRequest;
1736 int expireSequenceNumber;
1737 Network currentNetwork;
1738 int delay = -1;
Paul Jensen034dea32014-12-17 10:39:34 -05001739
1740 private void clearDnsBinding() {
1741 if (currentNetwork != null) {
1742 currentNetwork = null;
1743 setProcessDefaultNetworkForHostResolution(null);
1744 }
1745 }
1746
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07001747 NetworkCallback networkCallback = new NetworkCallback() {
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001748 @Override
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07001749 public void onAvailable(Network network) {
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001750 currentNetwork = network;
1751 Log.d(TAG, "startUsingNetworkFeature got Network:" + network);
Paul Jensene98c6e02014-05-29 10:12:39 -04001752 setProcessDefaultNetworkForHostResolution(network);
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001753 }
1754 @Override
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07001755 public void onLost(Network network) {
Paul Jensen034dea32014-12-17 10:39:34 -05001756 if (network.equals(currentNetwork)) clearDnsBinding();
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001757 Log.d(TAG, "startUsingNetworkFeature lost Network:" + network);
1758 }
1759 };
1760 }
1761
Mathew Inwoodd078d3d2020-10-27 11:47:29 +00001762 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
Chalard Jean73d9db72018-06-04 16:52:49 +09001763 private static final HashMap<NetworkCapabilities, LegacyRequest> sLegacyRequests =
1764 new HashMap<>();
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001765
1766 private NetworkRequest findRequestForFeature(NetworkCapabilities netCap) {
1767 synchronized (sLegacyRequests) {
1768 LegacyRequest l = sLegacyRequests.get(netCap);
1769 if (l != null) return l.networkRequest;
1770 }
1771 return null;
1772 }
1773
1774 private void renewRequestLocked(LegacyRequest l) {
1775 l.expireSequenceNumber++;
1776 Log.d(TAG, "renewing request to seqNum " + l.expireSequenceNumber);
1777 sendExpireMsgForFeature(l.networkCapabilities, l.expireSequenceNumber, l.delay);
1778 }
1779
1780 private void expireRequest(NetworkCapabilities netCap, int sequenceNum) {
1781 int ourSeqNum = -1;
1782 synchronized (sLegacyRequests) {
1783 LegacyRequest l = sLegacyRequests.get(netCap);
1784 if (l == null) return;
1785 ourSeqNum = l.expireSequenceNumber;
Paul Jensen034dea32014-12-17 10:39:34 -05001786 if (l.expireSequenceNumber == sequenceNum) removeRequestForFeature(netCap);
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001787 }
1788 Log.d(TAG, "expireRequest with " + ourSeqNum + ", " + sequenceNum);
1789 }
1790
Mathew Inwoodd078d3d2020-10-27 11:47:29 +00001791 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001792 private NetworkRequest requestNetworkForFeatureLocked(NetworkCapabilities netCap) {
1793 int delay = -1;
Robert Greenwalt5a367872014-06-02 15:32:02 -07001794 int type = legacyTypeForNetworkCapabilities(netCap);
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001795 try {
1796 delay = mService.getRestoreDefaultNetworkDelay(type);
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07001797 } catch (RemoteException e) {
1798 throw e.rethrowFromSystemServer();
1799 }
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001800 LegacyRequest l = new LegacyRequest();
1801 l.networkCapabilities = netCap;
1802 l.delay = delay;
1803 l.expireSequenceNumber = 0;
Hugo Benichicd5a0e02017-02-02 17:02:36 +09001804 l.networkRequest = sendRequestForNetwork(
1805 netCap, l.networkCallback, 0, REQUEST, type, getDefaultHandler());
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001806 if (l.networkRequest == null) return null;
1807 sLegacyRequests.put(netCap, l);
1808 sendExpireMsgForFeature(netCap, l.expireSequenceNumber, delay);
1809 return l.networkRequest;
1810 }
1811
1812 private void sendExpireMsgForFeature(NetworkCapabilities netCap, int seqNum, int delay) {
1813 if (delay >= 0) {
1814 Log.d(TAG, "sending expire msg with seqNum " + seqNum + " and delay " + delay);
Hugo Benichicd5a0e02017-02-02 17:02:36 +09001815 CallbackHandler handler = getDefaultHandler();
Hugo Benichiec180d52017-02-03 14:18:44 +09001816 Message msg = handler.obtainMessage(EXPIRE_LEGACY_REQUEST, seqNum, 0, netCap);
1817 handler.sendMessageDelayed(msg, delay);
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001818 }
1819 }
1820
Mathew Inwoodd078d3d2020-10-27 11:47:29 +00001821 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
Paul Jensen034dea32014-12-17 10:39:34 -05001822 private boolean removeRequestForFeature(NetworkCapabilities netCap) {
1823 final LegacyRequest l;
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001824 synchronized (sLegacyRequests) {
Paul Jensen034dea32014-12-17 10:39:34 -05001825 l = sLegacyRequests.remove(netCap);
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07001826 }
Paul Jensen034dea32014-12-17 10:39:34 -05001827 if (l == null) return false;
1828 unregisterNetworkCallback(l.networkCallback);
1829 l.clearDnsBinding();
1830 return true;
The Android Open Source Project28527d22009-03-03 19:31:44 -08001831 }
1832
Erik Kline50068e52017-01-26 18:08:28 +09001833 private static final SparseIntArray sLegacyTypeToTransport = new SparseIntArray();
1834 static {
1835 sLegacyTypeToTransport.put(TYPE_MOBILE, NetworkCapabilities.TRANSPORT_CELLULAR);
1836 sLegacyTypeToTransport.put(TYPE_MOBILE_CBS, NetworkCapabilities.TRANSPORT_CELLULAR);
1837 sLegacyTypeToTransport.put(TYPE_MOBILE_DUN, NetworkCapabilities.TRANSPORT_CELLULAR);
1838 sLegacyTypeToTransport.put(TYPE_MOBILE_FOTA, NetworkCapabilities.TRANSPORT_CELLULAR);
1839 sLegacyTypeToTransport.put(TYPE_MOBILE_HIPRI, NetworkCapabilities.TRANSPORT_CELLULAR);
1840 sLegacyTypeToTransport.put(TYPE_MOBILE_IMS, NetworkCapabilities.TRANSPORT_CELLULAR);
1841 sLegacyTypeToTransport.put(TYPE_MOBILE_MMS, NetworkCapabilities.TRANSPORT_CELLULAR);
1842 sLegacyTypeToTransport.put(TYPE_MOBILE_SUPL, NetworkCapabilities.TRANSPORT_CELLULAR);
1843 sLegacyTypeToTransport.put(TYPE_WIFI, NetworkCapabilities.TRANSPORT_WIFI);
1844 sLegacyTypeToTransport.put(TYPE_WIFI_P2P, NetworkCapabilities.TRANSPORT_WIFI);
1845 sLegacyTypeToTransport.put(TYPE_BLUETOOTH, NetworkCapabilities.TRANSPORT_BLUETOOTH);
1846 sLegacyTypeToTransport.put(TYPE_ETHERNET, NetworkCapabilities.TRANSPORT_ETHERNET);
1847 }
1848
1849 private static final SparseIntArray sLegacyTypeToCapability = new SparseIntArray();
1850 static {
1851 sLegacyTypeToCapability.put(TYPE_MOBILE_CBS, NetworkCapabilities.NET_CAPABILITY_CBS);
1852 sLegacyTypeToCapability.put(TYPE_MOBILE_DUN, NetworkCapabilities.NET_CAPABILITY_DUN);
1853 sLegacyTypeToCapability.put(TYPE_MOBILE_FOTA, NetworkCapabilities.NET_CAPABILITY_FOTA);
1854 sLegacyTypeToCapability.put(TYPE_MOBILE_IMS, NetworkCapabilities.NET_CAPABILITY_IMS);
1855 sLegacyTypeToCapability.put(TYPE_MOBILE_MMS, NetworkCapabilities.NET_CAPABILITY_MMS);
1856 sLegacyTypeToCapability.put(TYPE_MOBILE_SUPL, NetworkCapabilities.NET_CAPABILITY_SUPL);
1857 sLegacyTypeToCapability.put(TYPE_WIFI_P2P, NetworkCapabilities.NET_CAPABILITY_WIFI_P2P);
1858 }
1859
1860 /**
1861 * Given a legacy type (TYPE_WIFI, ...) returns a NetworkCapabilities
1862 * instance suitable for registering a request or callback. Throws an
1863 * IllegalArgumentException if no mapping from the legacy type to
1864 * NetworkCapabilities is known.
1865 *
Chalard Jean5acb7b72018-03-08 13:54:53 +09001866 * @deprecated Types are deprecated. Use {@link NetworkCallback} or {@link NetworkRequest}
1867 * to find the network instead.
Erik Kline50068e52017-01-26 18:08:28 +09001868 * @hide
1869 */
1870 public static NetworkCapabilities networkCapabilitiesForType(int type) {
1871 final NetworkCapabilities nc = new NetworkCapabilities();
1872
1873 // Map from type to transports.
1874 final int NOT_FOUND = -1;
1875 final int transport = sLegacyTypeToTransport.get(type, NOT_FOUND);
Remi NGUYEN VANc4dd8c92021-03-15 07:31:54 +00001876 if (transport == NOT_FOUND) {
1877 throw new IllegalArgumentException("unknown legacy type: " + type);
1878 }
Erik Kline50068e52017-01-26 18:08:28 +09001879 nc.addTransportType(transport);
1880
1881 // Map from type to capabilities.
1882 nc.addCapability(sLegacyTypeToCapability.get(
1883 type, NetworkCapabilities.NET_CAPABILITY_INTERNET));
1884 nc.maybeMarkCapabilitiesRestricted();
1885 return nc;
1886 }
1887
Lorenzo Colittid1039d12015-06-15 14:29:22 +09001888 /** @hide */
1889 public static class PacketKeepaliveCallback {
Mathew Inwoodd078d3d2020-10-27 11:47:29 +00001890 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
Artur Satayevfc03a992019-11-15 19:12:49 +00001891 public PacketKeepaliveCallback() {
1892 }
Lorenzo Colittid1039d12015-06-15 14:29:22 +09001893 /** The requested keepalive was successfully started. */
Mathew Inwoodd078d3d2020-10-27 11:47:29 +00001894 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
Lorenzo Colittid1039d12015-06-15 14:29:22 +09001895 public void onStarted() {}
1896 /** The keepalive was successfully stopped. */
Mathew Inwoodd078d3d2020-10-27 11:47:29 +00001897 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
Lorenzo Colittid1039d12015-06-15 14:29:22 +09001898 public void onStopped() {}
1899 /** An error occurred. */
Mathew Inwoodd078d3d2020-10-27 11:47:29 +00001900 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
Lorenzo Colittid1039d12015-06-15 14:29:22 +09001901 public void onError(int error) {}
1902 }
1903
1904 /**
1905 * Allows applications to request that the system periodically send specific packets on their
1906 * behalf, using hardware offload to save battery power.
1907 *
1908 * To request that the system send keepalives, call one of the methods that return a
1909 * {@link ConnectivityManager.PacketKeepalive} object, such as {@link #startNattKeepalive},
1910 * passing in a non-null callback. If the callback is successfully started, the callback's
1911 * {@code onStarted} method will be called. If an error occurs, {@code onError} will be called,
1912 * specifying one of the {@code ERROR_*} constants in this class.
1913 *
Chalard Jean73d9db72018-06-04 16:52:49 +09001914 * To stop an existing keepalive, call {@link PacketKeepalive#stop}. The system will call
1915 * {@link PacketKeepaliveCallback#onStopped} if the operation was successful or
1916 * {@link PacketKeepaliveCallback#onError} if an error occurred.
Lorenzo Colittid1039d12015-06-15 14:29:22 +09001917 *
junyulaia86defc2018-12-27 17:25:29 +08001918 * @deprecated Use {@link SocketKeepalive} instead.
1919 *
Lorenzo Colittid1039d12015-06-15 14:29:22 +09001920 * @hide
1921 */
1922 public class PacketKeepalive {
1923
1924 private static final String TAG = "PacketKeepalive";
1925
1926 /** @hide */
1927 public static final int SUCCESS = 0;
1928
1929 /** @hide */
1930 public static final int NO_KEEPALIVE = -1;
1931
1932 /** @hide */
1933 public static final int BINDER_DIED = -10;
1934
1935 /** The specified {@code Network} is not connected. */
1936 public static final int ERROR_INVALID_NETWORK = -20;
1937 /** The specified IP addresses are invalid. For example, the specified source IP address is
1938 * not configured on the specified {@code Network}. */
1939 public static final int ERROR_INVALID_IP_ADDRESS = -21;
1940 /** The requested port is invalid. */
1941 public static final int ERROR_INVALID_PORT = -22;
1942 /** The packet length is invalid (e.g., too long). */
1943 public static final int ERROR_INVALID_LENGTH = -23;
1944 /** The packet transmission interval is invalid (e.g., too short). */
1945 public static final int ERROR_INVALID_INTERVAL = -24;
1946
1947 /** The hardware does not support this request. */
1948 public static final int ERROR_HARDWARE_UNSUPPORTED = -30;
Lorenzo Colitti2aab7182015-09-08 16:46:36 +09001949 /** The hardware returned an error. */
1950 public static final int ERROR_HARDWARE_ERROR = -31;
Lorenzo Colittid1039d12015-06-15 14:29:22 +09001951
Nathan Harolde8ae0eb2018-02-14 13:09:45 -08001952 /** The NAT-T destination port for IPsec */
Lorenzo Colittid1039d12015-06-15 14:29:22 +09001953 public static final int NATT_PORT = 4500;
1954
Nathan Harolde8ae0eb2018-02-14 13:09:45 -08001955 /** The minimum interval in seconds between keepalive packet transmissions */
1956 public static final int MIN_INTERVAL = 10;
1957
Lorenzo Colittid1039d12015-06-15 14:29:22 +09001958 private final Network mNetwork;
junyulai9f872232019-01-16 20:23:34 +08001959 private final ISocketKeepaliveCallback mCallback;
1960 private final ExecutorService mExecutor;
Lorenzo Colittid1039d12015-06-15 14:29:22 +09001961
1962 private volatile Integer mSlot;
1963
Mathew Inwoodd078d3d2020-10-27 11:47:29 +00001964 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
Lorenzo Colittid1039d12015-06-15 14:29:22 +09001965 public void stop() {
1966 try {
junyulai9f872232019-01-16 20:23:34 +08001967 mExecutor.execute(() -> {
1968 try {
1969 if (mSlot != null) {
1970 mService.stopKeepalive(mNetwork, mSlot);
1971 }
1972 } catch (RemoteException e) {
1973 Log.e(TAG, "Error stopping packet keepalive: ", e);
1974 throw e.rethrowFromSystemServer();
1975 }
1976 });
1977 } catch (RejectedExecutionException e) {
1978 // The internal executor has already stopped due to previous event.
Lorenzo Colittid1039d12015-06-15 14:29:22 +09001979 }
1980 }
1981
1982 private PacketKeepalive(Network network, PacketKeepaliveCallback callback) {
Remi NGUYEN VANc4dd8c92021-03-15 07:31:54 +00001983 Objects.requireNonNull(network, "network cannot be null");
1984 Objects.requireNonNull(callback, "callback cannot be null");
Lorenzo Colittid1039d12015-06-15 14:29:22 +09001985 mNetwork = network;
junyulai9f872232019-01-16 20:23:34 +08001986 mExecutor = Executors.newSingleThreadExecutor();
1987 mCallback = new ISocketKeepaliveCallback.Stub() {
Lorenzo Colittid1039d12015-06-15 14:29:22 +09001988 @Override
junyulai9f872232019-01-16 20:23:34 +08001989 public void onStarted(int slot) {
lucaslinad369e32020-12-30 11:54:55 +08001990 final long token = Binder.clearCallingIdentity();
1991 try {
1992 mExecutor.execute(() -> {
1993 mSlot = slot;
1994 callback.onStarted();
1995 });
1996 } finally {
1997 Binder.restoreCallingIdentity(token);
1998 }
Lorenzo Colittid1039d12015-06-15 14:29:22 +09001999 }
junyulai9f872232019-01-16 20:23:34 +08002000
2001 @Override
2002 public void onStopped() {
lucaslinad369e32020-12-30 11:54:55 +08002003 final long token = Binder.clearCallingIdentity();
2004 try {
2005 mExecutor.execute(() -> {
2006 mSlot = null;
2007 callback.onStopped();
2008 });
2009 } finally {
2010 Binder.restoreCallingIdentity(token);
2011 }
junyulai9f872232019-01-16 20:23:34 +08002012 mExecutor.shutdown();
2013 }
2014
2015 @Override
2016 public void onError(int error) {
lucaslinad369e32020-12-30 11:54:55 +08002017 final long token = Binder.clearCallingIdentity();
2018 try {
2019 mExecutor.execute(() -> {
2020 mSlot = null;
2021 callback.onError(error);
2022 });
2023 } finally {
2024 Binder.restoreCallingIdentity(token);
2025 }
junyulai9f872232019-01-16 20:23:34 +08002026 mExecutor.shutdown();
2027 }
2028
2029 @Override
2030 public void onDataReceived() {
2031 // PacketKeepalive is only used for Nat-T keepalive and as such does not invoke
2032 // this callback when data is received.
2033 }
2034 };
Lorenzo Colittid1039d12015-06-15 14:29:22 +09002035 }
2036 }
2037
2038 /**
2039 * Starts an IPsec NAT-T keepalive packet with the specified parameters.
2040 *
junyulaia86defc2018-12-27 17:25:29 +08002041 * @deprecated Use {@link #createSocketKeepalive} instead.
2042 *
Lorenzo Colittid1039d12015-06-15 14:29:22 +09002043 * @hide
2044 */
Mathew Inwoodd078d3d2020-10-27 11:47:29 +00002045 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
Lorenzo Colittid1039d12015-06-15 14:29:22 +09002046 public PacketKeepalive startNattKeepalive(
2047 Network network, int intervalSeconds, PacketKeepaliveCallback callback,
2048 InetAddress srcAddr, int srcPort, InetAddress dstAddr) {
2049 final PacketKeepalive k = new PacketKeepalive(network, callback);
2050 try {
junyulai9f872232019-01-16 20:23:34 +08002051 mService.startNattKeepalive(network, intervalSeconds, k.mCallback,
Lorenzo Colittid1039d12015-06-15 14:29:22 +09002052 srcAddr.getHostAddress(), srcPort, dstAddr.getHostAddress());
2053 } catch (RemoteException e) {
2054 Log.e(TAG, "Error starting packet keepalive: ", e);
junyulai9f872232019-01-16 20:23:34 +08002055 throw e.rethrowFromSystemServer();
Lorenzo Colittid1039d12015-06-15 14:29:22 +09002056 }
2057 return k;
2058 }
2059
Chiachang Wangc5f86f42021-01-15 11:06:21 +08002060 // Construct an invalid fd.
2061 private ParcelFileDescriptor createInvalidFd() {
2062 final int invalidFd = -1;
2063 return ParcelFileDescriptor.adoptFd(invalidFd);
2064 }
2065
The Android Open Source Project28527d22009-03-03 19:31:44 -08002066 /**
junyulaia86defc2018-12-27 17:25:29 +08002067 * Request that keepalives be started on a IPsec NAT-T socket.
2068 *
2069 * @param network The {@link Network} the socket is on.
2070 * @param socket The socket that needs to be kept alive.
2071 * @param source The source address of the {@link UdpEncapsulationSocket}.
2072 * @param destination The destination address of the {@link UdpEncapsulationSocket}.
2073 * @param executor The executor on which callback will be invoked. The provided {@link Executor}
2074 * must run callback sequentially, otherwise the order of callbacks cannot be
2075 * guaranteed.
2076 * @param callback A {@link SocketKeepalive.Callback}. Used for notifications about keepalive
2077 * changes. Must be extended by applications that use this API.
2078 *
junyulaic7ea1242019-01-08 20:04:33 +08002079 * @return A {@link SocketKeepalive} object that can be used to control the keepalive on the
2080 * given socket.
junyulaia86defc2018-12-27 17:25:29 +08002081 **/
junyulai61143782019-03-04 22:45:36 +08002082 public @NonNull SocketKeepalive createSocketKeepalive(@NonNull Network network,
junyulaia86defc2018-12-27 17:25:29 +08002083 @NonNull UdpEncapsulationSocket socket,
2084 @NonNull InetAddress source,
2085 @NonNull InetAddress destination,
2086 @NonNull @CallbackExecutor Executor executor,
2087 @NonNull Callback callback) {
junyulai61143782019-03-04 22:45:36 +08002088 ParcelFileDescriptor dup;
2089 try {
junyulaic4fb2482019-03-27 11:00:37 +08002090 // Dup is needed here as the pfd inside the socket is owned by the IpSecService,
2091 // which cannot be obtained by the app process.
junyulai61143782019-03-04 22:45:36 +08002092 dup = ParcelFileDescriptor.dup(socket.getFileDescriptor());
2093 } catch (IOException ignored) {
2094 // Construct an invalid fd, so that if the user later calls start(), it will fail with
2095 // ERROR_INVALID_SOCKET.
Chiachang Wangc5f86f42021-01-15 11:06:21 +08002096 dup = createInvalidFd();
junyulai61143782019-03-04 22:45:36 +08002097 }
2098 return new NattSocketKeepalive(mService, network, dup, socket.getResourceId(), source,
2099 destination, executor, callback);
junyulai48a59382019-01-15 11:32:44 +08002100 }
2101
2102 /**
2103 * Request that keepalives be started on a IPsec NAT-T socket file descriptor. Directly called
2104 * by system apps which don't use IpSecService to create {@link UdpEncapsulationSocket}.
2105 *
2106 * @param network The {@link Network} the socket is on.
junyulai61143782019-03-04 22:45:36 +08002107 * @param pfd The {@link ParcelFileDescriptor} that needs to be kept alive. The provided
2108 * {@link ParcelFileDescriptor} must be bound to a port and the keepalives will be sent
2109 * from that port.
junyulai48a59382019-01-15 11:32:44 +08002110 * @param source The source address of the {@link UdpEncapsulationSocket}.
2111 * @param destination The destination address of the {@link UdpEncapsulationSocket}. The
2112 * keepalive packets will always be sent to port 4500 of the given {@code destination}.
2113 * @param executor The executor on which callback will be invoked. The provided {@link Executor}
2114 * must run callback sequentially, otherwise the order of callbacks cannot be
2115 * guaranteed.
2116 * @param callback A {@link SocketKeepalive.Callback}. Used for notifications about keepalive
2117 * changes. Must be extended by applications that use this API.
2118 *
junyulaic7ea1242019-01-08 20:04:33 +08002119 * @return A {@link SocketKeepalive} object that can be used to control the keepalive on the
2120 * given socket.
junyulai48a59382019-01-15 11:32:44 +08002121 * @hide
2122 */
2123 @SystemApi
2124 @RequiresPermission(android.Manifest.permission.PACKET_KEEPALIVE_OFFLOAD)
junyulai61143782019-03-04 22:45:36 +08002125 public @NonNull SocketKeepalive createNattKeepalive(@NonNull Network network,
2126 @NonNull ParcelFileDescriptor pfd,
junyulai48a59382019-01-15 11:32:44 +08002127 @NonNull InetAddress source,
2128 @NonNull InetAddress destination,
2129 @NonNull @CallbackExecutor Executor executor,
2130 @NonNull Callback callback) {
junyulai61143782019-03-04 22:45:36 +08002131 ParcelFileDescriptor dup;
2132 try {
junyulaic4fb2482019-03-27 11:00:37 +08002133 // TODO: Consider remove unnecessary dup.
junyulai61143782019-03-04 22:45:36 +08002134 dup = pfd.dup();
2135 } catch (IOException ignored) {
2136 // Construct an invalid fd, so that if the user later calls start(), it will fail with
2137 // ERROR_INVALID_SOCKET.
Chiachang Wangc5f86f42021-01-15 11:06:21 +08002138 dup = createInvalidFd();
junyulai61143782019-03-04 22:45:36 +08002139 }
2140 return new NattSocketKeepalive(mService, network, dup,
Remi NGUYEN VAN642d6ab2021-03-11 10:56:49 +00002141 -1 /* Unused */, source, destination, executor, callback);
junyulaia86defc2018-12-27 17:25:29 +08002142 }
2143
2144 /**
junyulaic7ea1242019-01-08 20:04:33 +08002145 * Request that keepalives be started on a TCP socket.
2146 * The socket must be established.
2147 *
2148 * @param network The {@link Network} the socket is on.
2149 * @param socket The socket that needs to be kept alive.
2150 * @param executor The executor on which callback will be invoked. This implementation assumes
2151 * the provided {@link Executor} runs the callbacks in sequence with no
2152 * concurrency. Failing this, no guarantee of correctness can be made. It is
2153 * the responsibility of the caller to ensure the executor provides this
2154 * guarantee. A simple way of creating such an executor is with the standard
2155 * tool {@code Executors.newSingleThreadExecutor}.
2156 * @param callback A {@link SocketKeepalive.Callback}. Used for notifications about keepalive
2157 * changes. Must be extended by applications that use this API.
2158 *
2159 * @return A {@link SocketKeepalive} object that can be used to control the keepalive on the
2160 * given socket.
2161 * @hide
2162 */
2163 @SystemApi
2164 @RequiresPermission(android.Manifest.permission.PACKET_KEEPALIVE_OFFLOAD)
junyulai61143782019-03-04 22:45:36 +08002165 public @NonNull SocketKeepalive createSocketKeepalive(@NonNull Network network,
junyulaic7ea1242019-01-08 20:04:33 +08002166 @NonNull Socket socket,
2167 @NonNull Executor executor,
2168 @NonNull Callback callback) {
junyulai61143782019-03-04 22:45:36 +08002169 ParcelFileDescriptor dup;
2170 try {
2171 dup = ParcelFileDescriptor.fromSocket(socket);
2172 } catch (UncheckedIOException ignored) {
2173 // Construct an invalid fd, so that if the user later calls start(), it will fail with
2174 // ERROR_INVALID_SOCKET.
Chiachang Wangc5f86f42021-01-15 11:06:21 +08002175 dup = createInvalidFd();
junyulai61143782019-03-04 22:45:36 +08002176 }
2177 return new TcpSocketKeepalive(mService, network, dup, executor, callback);
junyulaic7ea1242019-01-08 20:04:33 +08002178 }
2179
2180 /**
The Android Open Source Project28527d22009-03-03 19:31:44 -08002181 * Ensure that a network route exists to deliver traffic to the specified
2182 * host via the specified network interface. An attempt to add a route that
2183 * already exists is ignored, but treated as successful.
Lorenzo Colitti91de63b2015-10-15 16:29:00 +09002184 *
2185 * <p>This method requires the caller to hold either the
2186 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
2187 * or the ability to modify system settings as determined by
2188 * {@link android.provider.Settings.System#canWrite}.</p>
2189 *
The Android Open Source Project28527d22009-03-03 19:31:44 -08002190 * @param networkType the type of the network over which traffic to the specified
2191 * host is to be routed
2192 * @param hostAddress the IP address of the host to which the route is desired
2193 * @return {@code true} on success, {@code false} on failure
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07002194 *
Lorenzo Colittiefd396e2015-04-24 17:03:31 +09002195 * @deprecated Deprecated in favor of the
2196 * {@link #requestNetwork(NetworkRequest, NetworkCallback)},
2197 * {@link #bindProcessToNetwork} and {@link Network#getSocketFactory} API.
Dianne Hackbornc16abda2015-07-31 10:35:34 -07002198 * In {@link VERSION_CODES#M}, and above, this method is unsupported and will
Lorenzo Colitti9b026fa2015-07-29 11:41:21 +09002199 * throw {@code UnsupportedOperationException} if called.
Lorenzo Colitti7cb18342016-12-09 18:39:30 +09002200 * @removed
The Android Open Source Project28527d22009-03-03 19:31:44 -08002201 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -07002202 @Deprecated
The Android Open Source Project28527d22009-03-03 19:31:44 -08002203 public boolean requestRouteToHost(int networkType, int hostAddress) {
Sreeram Ramachandranc05e2a92014-07-19 23:21:46 -07002204 return requestRouteToHostAddress(networkType, NetworkUtils.intToInetAddress(hostAddress));
Robert Greenwalt7fe44cb2010-08-27 09:24:29 -07002205 }
2206
2207 /**
2208 * Ensure that a network route exists to deliver traffic to the specified
2209 * host via the specified network interface. An attempt to add a route that
2210 * already exists is ignored, but treated as successful.
Lorenzo Colitti91de63b2015-10-15 16:29:00 +09002211 *
2212 * <p>This method requires the caller to hold either the
2213 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
2214 * or the ability to modify system settings as determined by
2215 * {@link android.provider.Settings.System#canWrite}.</p>
2216 *
Robert Greenwalt7fe44cb2010-08-27 09:24:29 -07002217 * @param networkType the type of the network over which traffic to the specified
2218 * host is to be routed
2219 * @param hostAddress the IP address of the host to which the route is desired
2220 * @return {@code true} on success, {@code false} on failure
2221 * @hide
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07002222 * @deprecated Deprecated in favor of the {@link #requestNetwork} and
Lorenzo Colittiefd396e2015-04-24 17:03:31 +09002223 * {@link #bindProcessToNetwork} API.
Robert Greenwalt7fe44cb2010-08-27 09:24:29 -07002224 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -07002225 @Deprecated
Mathew Inwood0b8f8612018-08-08 14:52:47 +01002226 @UnsupportedAppUsage
lucaslin5140e482021-03-22 11:51:27 +08002227 @SystemApi(client = MODULE_LIBRARIES)
Robert Greenwalt7fe44cb2010-08-27 09:24:29 -07002228 public boolean requestRouteToHostAddress(int networkType, InetAddress hostAddress) {
Lorenzo Colitti9b026fa2015-07-29 11:41:21 +09002229 checkLegacyRoutingApiAccess();
The Android Open Source Project28527d22009-03-03 19:31:44 -08002230 try {
Philip P. Moltmannddbcf5b2020-03-24 15:57:49 -07002231 return mService.requestRouteToHostAddress(networkType, hostAddress.getAddress(),
2232 mContext.getOpPackageName(), getAttributionTag());
The Android Open Source Project28527d22009-03-03 19:31:44 -08002233 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07002234 throw e.rethrowFromSystemServer();
The Android Open Source Project28527d22009-03-03 19:31:44 -08002235 }
2236 }
2237
2238 /**
Philip P. Moltmannddbcf5b2020-03-24 15:57:49 -07002239 * @return the context's attribution tag
2240 */
2241 // TODO: Remove method and replace with direct call once R code is pushed to AOSP
2242 private @Nullable String getAttributionTag() {
2243 return mContext.getAttributionTag();
2244 }
2245
2246 /**
The Android Open Source Project28527d22009-03-03 19:31:44 -08002247 * Returns the value of the setting for background data usage. If false,
2248 * applications should not use the network if the application is not in the
2249 * foreground. Developers should respect this setting, and check the value
2250 * of this before performing any background data operations.
2251 * <p>
2252 * All applications that have background services that use the network
2253 * should listen to {@link #ACTION_BACKGROUND_DATA_SETTING_CHANGED}.
Jeff Sharkey39c01eb2011-08-16 14:37:57 -07002254 * <p>
Scott Main50589142011-10-06 18:32:43 -07002255 * @deprecated As of {@link VERSION_CODES#ICE_CREAM_SANDWICH}, availability of
Jeff Sharkey39c01eb2011-08-16 14:37:57 -07002256 * background data depends on several combined factors, and this method will
2257 * always return {@code true}. Instead, when background data is unavailable,
2258 * {@link #getActiveNetworkInfo()} will now appear disconnected.
Danica Chang96567052010-08-11 14:54:43 -07002259 *
The Android Open Source Project28527d22009-03-03 19:31:44 -08002260 * @return Whether background data usage is allowed.
2261 */
Jeff Sharkey39c01eb2011-08-16 14:37:57 -07002262 @Deprecated
The Android Open Source Project28527d22009-03-03 19:31:44 -08002263 public boolean getBackgroundDataSetting() {
Jeff Sharkey39c01eb2011-08-16 14:37:57 -07002264 // assume that background data is allowed; final authority is
2265 // NetworkInfo which may be blocked.
2266 return true;
The Android Open Source Project28527d22009-03-03 19:31:44 -08002267 }
2268
2269 /**
2270 * Sets the value of the setting for background data usage.
Robert Greenwalt1b21f6c2010-02-23 18:58:05 -08002271 *
The Android Open Source Project28527d22009-03-03 19:31:44 -08002272 * @param allowBackgroundData Whether an application should use data while
2273 * it is in the background.
Robert Greenwalt1b21f6c2010-02-23 18:58:05 -08002274 *
The Android Open Source Project28527d22009-03-03 19:31:44 -08002275 * @attr ref android.Manifest.permission#CHANGE_BACKGROUND_DATA_SETTING
2276 * @see #getBackgroundDataSetting()
2277 * @hide
2278 */
Jeff Sharkey39c01eb2011-08-16 14:37:57 -07002279 @Deprecated
Mathew Inwood0b8f8612018-08-08 14:52:47 +01002280 @UnsupportedAppUsage
The Android Open Source Project28527d22009-03-03 19:31:44 -08002281 public void setBackgroundDataSetting(boolean allowBackgroundData) {
Jeff Sharkey39c01eb2011-08-16 14:37:57 -07002282 // ignored
The Android Open Source Project28527d22009-03-03 19:31:44 -08002283 }
Robert Greenwalt1b21f6c2010-02-23 18:58:05 -08002284
Jeff Sharkey66fa9682011-08-02 17:22:34 -07002285 /**
Robert Greenwalt1b21f6c2010-02-23 18:58:05 -08002286 * @hide
Robert Greenwalt3d6c9582014-05-21 20:04:36 -07002287 * @deprecated Talk to TelephonyManager directly
Robert Greenwalt1b21f6c2010-02-23 18:58:05 -08002288 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -07002289 @Deprecated
Mathew Inwood0b8f8612018-08-08 14:52:47 +01002290 @UnsupportedAppUsage
Robert Greenwalt1b21f6c2010-02-23 18:58:05 -08002291 public boolean getMobileDataEnabled() {
Meng Wang91311c02019-11-18 17:10:00 -08002292 TelephonyManager tm = mContext.getSystemService(TelephonyManager.class);
2293 if (tm != null) {
2294 int subId = SubscriptionManager.getDefaultDataSubscriptionId();
2295 Log.d("ConnectivityManager", "getMobileDataEnabled()+ subId=" + subId);
2296 boolean retVal = tm.createForSubscriptionId(subId).isDataEnabled();
2297 Log.d("ConnectivityManager", "getMobileDataEnabled()- subId=" + subId
2298 + " retVal=" + retVal);
2299 return retVal;
Robert Greenwalt1b21f6c2010-02-23 18:58:05 -08002300 }
Wink Saville02eb35c2014-12-05 11:10:30 -08002301 Log.d("ConnectivityManager", "getMobileDataEnabled()- remote exception retVal=false");
Robert Greenwalt3d6c9582014-05-21 20:04:36 -07002302 return false;
Robert Greenwalt1b21f6c2010-02-23 18:58:05 -08002303 }
2304
The Android Open Source Project28527d22009-03-03 19:31:44 -08002305 /**
Robert Greenwalt2e4731f2014-09-04 16:44:35 -07002306 * Callback for use with {@link ConnectivityManager#addDefaultNetworkActiveListener}
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07002307 * to find out when the system default network has gone in to a high power state.
Dianne Hackbornb4b09e82014-02-26 16:20:52 -08002308 */
2309 public interface OnNetworkActiveListener {
2310 /**
2311 * Called on the main thread of the process to report that the current data network
2312 * has become active, and it is now a good time to perform any pending network
2313 * operations. Note that this listener only tells you when the network becomes
2314 * active; if at any other time you want to know whether it is active (and thus okay
2315 * to initiate network traffic), you can retrieve its instantaneous state with
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07002316 * {@link ConnectivityManager#isDefaultNetworkActive}.
Dianne Hackbornb4b09e82014-02-26 16:20:52 -08002317 */
Chalard Jean73d9db72018-06-04 16:52:49 +09002318 void onNetworkActive();
Dianne Hackbornb4b09e82014-02-26 16:20:52 -08002319 }
2320
Dianne Hackbornb4b09e82014-02-26 16:20:52 -08002321 private final ArrayMap<OnNetworkActiveListener, INetworkActivityListener>
Chalard Jean73d9db72018-06-04 16:52:49 +09002322 mNetworkActivityListeners = new ArrayMap<>();
Dianne Hackbornb4b09e82014-02-26 16:20:52 -08002323
2324 /**
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07002325 * Start listening to reports when the system's default data network is active, meaning it is
2326 * a good time to perform network traffic. Use {@link #isDefaultNetworkActive()}
2327 * to determine the current state of the system's default network after registering the
2328 * listener.
2329 * <p>
2330 * If the process default network has been set with
Paul Jensen895c3942015-03-10 10:54:12 -04002331 * {@link ConnectivityManager#bindProcessToNetwork} this function will not
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07002332 * reflect the process's default, but the system default.
Dianne Hackbornb4b09e82014-02-26 16:20:52 -08002333 *
2334 * @param l The listener to be told when the network is active.
2335 */
Robert Greenwalt2e4731f2014-09-04 16:44:35 -07002336 public void addDefaultNetworkActiveListener(final OnNetworkActiveListener l) {
Dianne Hackbornb4b09e82014-02-26 16:20:52 -08002337 INetworkActivityListener rl = new INetworkActivityListener.Stub() {
2338 @Override
2339 public void onNetworkActive() throws RemoteException {
2340 l.onNetworkActive();
2341 }
2342 };
2343
2344 try {
lucaslina5e9bdb2021-01-21 02:04:15 +08002345 mService.registerNetworkActivityListener(rl);
Dianne Hackbornb4b09e82014-02-26 16:20:52 -08002346 mNetworkActivityListeners.put(l, rl);
2347 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07002348 throw e.rethrowFromSystemServer();
Dianne Hackbornb4b09e82014-02-26 16:20:52 -08002349 }
2350 }
2351
2352 /**
2353 * Remove network active listener previously registered with
Robert Greenwalt2e4731f2014-09-04 16:44:35 -07002354 * {@link #addDefaultNetworkActiveListener}.
Dianne Hackbornb4b09e82014-02-26 16:20:52 -08002355 *
2356 * @param l Previously registered listener.
2357 */
Chalard Jean42a9c292019-01-07 19:26:34 +09002358 public void removeDefaultNetworkActiveListener(@NonNull OnNetworkActiveListener l) {
Dianne Hackbornb4b09e82014-02-26 16:20:52 -08002359 INetworkActivityListener rl = mNetworkActivityListeners.get(l);
Remi NGUYEN VANc4dd8c92021-03-15 07:31:54 +00002360 if (rl == null) {
2361 throw new IllegalArgumentException("Listener was not registered.");
2362 }
Dianne Hackbornb4b09e82014-02-26 16:20:52 -08002363 try {
lucaslina5e9bdb2021-01-21 02:04:15 +08002364 mService.registerNetworkActivityListener(rl);
Dianne Hackbornb4b09e82014-02-26 16:20:52 -08002365 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07002366 throw e.rethrowFromSystemServer();
Dianne Hackbornb4b09e82014-02-26 16:20:52 -08002367 }
2368 }
2369
2370 /**
2371 * Return whether the data network is currently active. An active network means that
2372 * it is currently in a high power state for performing data transmission. On some
2373 * types of networks, it may be expensive to move and stay in such a state, so it is
2374 * more power efficient to batch network traffic together when the radio is already in
2375 * this state. This method tells you whether right now is currently a good time to
2376 * initiate network traffic, as the network is already active.
2377 */
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07002378 public boolean isDefaultNetworkActive() {
Dianne Hackbornb4b09e82014-02-26 16:20:52 -08002379 try {
lucaslina5e9bdb2021-01-21 02:04:15 +08002380 return mService.isDefaultNetworkActive();
Dianne Hackbornb4b09e82014-02-26 16:20:52 -08002381 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07002382 throw e.rethrowFromSystemServer();
Dianne Hackbornb4b09e82014-02-26 16:20:52 -08002383 }
Dianne Hackbornb4b09e82014-02-26 16:20:52 -08002384 }
2385
2386 /**
The Android Open Source Project28527d22009-03-03 19:31:44 -08002387 * {@hide}
2388 */
Lorenzo Colitti9b026fa2015-07-29 11:41:21 +09002389 public ConnectivityManager(Context context, IConnectivityManager service) {
Remi NGUYEN VANc4dd8c92021-03-15 07:31:54 +00002390 mContext = Objects.requireNonNull(context, "missing context");
2391 mService = Objects.requireNonNull(service, "missing IConnectivityManager");
Automerger Merge Worker9b0c0c62020-03-06 00:38:43 +00002392 mTetheringManager = (TetheringManager) mContext.getSystemService(Context.TETHERING_SERVICE);
Paul Jensen12131352014-12-10 15:12:18 -05002393 sInstance = this;
The Android Open Source Project28527d22009-03-03 19:31:44 -08002394 }
Robert Greenwalt0c4828c2010-01-26 11:40:34 -08002395
Jeff Sharkey2d9e5a52012-04-04 20:40:58 -07002396 /** {@hide} */
Mathew Inwood0b8f8612018-08-08 14:52:47 +01002397 @UnsupportedAppUsage
Jeff Sharkey2d9e5a52012-04-04 20:40:58 -07002398 public static ConnectivityManager from(Context context) {
2399 return (ConnectivityManager) context.getSystemService(Context.CONNECTIVITY_SERVICE);
2400 }
2401
Remi NGUYEN VAN1becbe72018-12-27 16:43:56 +09002402 /** @hide */
2403 public NetworkRequest getDefaultRequest() {
2404 try {
2405 // This is not racy as the default request is final in ConnectivityService.
2406 return mService.getDefaultRequest();
2407 } catch (RemoteException e) {
2408 throw e.rethrowFromSystemServer();
2409 }
2410 }
2411
Robert Greenwalt0c4828c2010-01-26 11:40:34 -08002412 /**
Philip P. Moltmannddbcf5b2020-03-24 15:57:49 -07002413 * Check if the package is a allowed to write settings. This also accounts that such an access
2414 * happened.
2415 *
2416 * @return {@code true} iff the package is allowed to write settings.
2417 */
2418 // TODO: Remove method and replace with direct call once R code is pushed to AOSP
2419 private static boolean checkAndNoteWriteSettingsOperation(@NonNull Context context, int uid,
2420 @NonNull String callingPackage, @Nullable String callingAttributionTag,
2421 boolean throwException) {
2422 return Settings.checkAndNoteWriteSettingsOperation(context, uid, callingPackage,
2423 callingAttributionTag, throwException);
2424 }
2425
2426 /**
Paul Jensen12131352014-12-10 15:12:18 -05002427 * @deprecated - use getSystemService. This is a kludge to support static access in certain
2428 * situations where a Context pointer is unavailable.
2429 * @hide
2430 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -07002431 @Deprecated
Paul Jensen895c3942015-03-10 10:54:12 -04002432 static ConnectivityManager getInstanceOrNull() {
2433 return sInstance;
2434 }
2435
2436 /**
2437 * @deprecated - use getSystemService. This is a kludge to support static access in certain
2438 * situations where a Context pointer is unavailable.
2439 * @hide
2440 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -07002441 @Deprecated
Mathew Inwood0b8f8612018-08-08 14:52:47 +01002442 @UnsupportedAppUsage
Paul Jensen895c3942015-03-10 10:54:12 -04002443 private static ConnectivityManager getInstance() {
2444 if (getInstanceOrNull() == null) {
Paul Jensen12131352014-12-10 15:12:18 -05002445 throw new IllegalStateException("No ConnectivityManager yet constructed");
2446 }
Paul Jensen895c3942015-03-10 10:54:12 -04002447 return getInstanceOrNull();
Paul Jensen12131352014-12-10 15:12:18 -05002448 }
2449
2450 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -08002451 * Get the set of tetherable, available interfaces. This list is limited by
2452 * device configuration and current interface existence.
2453 *
2454 * @return an array of 0 or more Strings of tetherable interface names.
2455 *
markchien75721e42020-01-21 13:11:06 +08002456 * @deprecated Use {@link TetheringEventCallback#onTetherableInterfacesChanged(List)} instead.
Robert Greenwalt0c4828c2010-01-26 11:40:34 -08002457 * {@hide}
2458 */
Jeff Sharkey2ac62992017-04-24 11:18:03 -06002459 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Mathew Inwood0b8f8612018-08-08 14:52:47 +01002460 @UnsupportedAppUsage
markchien75721e42020-01-21 13:11:06 +08002461 @Deprecated
Robert Greenwalt0c4828c2010-01-26 11:40:34 -08002462 public String[] getTetherableIfaces() {
Automerger Merge Worker9b0c0c62020-03-06 00:38:43 +00002463 return mTetheringManager.getTetherableIfaces();
Robert Greenwalt0c4828c2010-01-26 11:40:34 -08002464 }
2465
2466 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -08002467 * Get the set of tethered interfaces.
2468 *
2469 * @return an array of 0 or more String of currently tethered interface names.
2470 *
markchien75721e42020-01-21 13:11:06 +08002471 * @deprecated Use {@link TetheringEventCallback#onTetherableInterfacesChanged(List)} instead.
Robert Greenwalt0c4828c2010-01-26 11:40:34 -08002472 * {@hide}
2473 */
Jeff Sharkey2ac62992017-04-24 11:18:03 -06002474 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Mathew Inwood0b8f8612018-08-08 14:52:47 +01002475 @UnsupportedAppUsage
markchien75721e42020-01-21 13:11:06 +08002476 @Deprecated
Robert Greenwalt0c4828c2010-01-26 11:40:34 -08002477 public String[] getTetheredIfaces() {
Automerger Merge Worker9b0c0c62020-03-06 00:38:43 +00002478 return mTetheringManager.getTetheredIfaces();
Robert Greenwalt0c4828c2010-01-26 11:40:34 -08002479 }
2480
2481 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -08002482 * Get the set of interface names which attempted to tether but
2483 * failed. Re-attempting to tether may cause them to reset to the Tethered
2484 * state. Alternatively, causing the interface to be destroyed and recreated
2485 * may cause them to reset to the available state.
2486 * {@link ConnectivityManager#getLastTetherError} can be used to get more
2487 * information on the cause of the errors.
2488 *
2489 * @return an array of 0 or more String indicating the interface names
2490 * which failed to tether.
2491 *
markchien75721e42020-01-21 13:11:06 +08002492 * @deprecated Use {@link TetheringEventCallback#onError(String, int)} instead.
Robert Greenwalt0c4828c2010-01-26 11:40:34 -08002493 * {@hide}
2494 */
Jeff Sharkey2ac62992017-04-24 11:18:03 -06002495 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Mathew Inwood0b8f8612018-08-08 14:52:47 +01002496 @UnsupportedAppUsage
markchien75721e42020-01-21 13:11:06 +08002497 @Deprecated
Robert Greenwalt4283ded2010-03-02 17:25:02 -08002498 public String[] getTetheringErroredIfaces() {
Automerger Merge Worker9b0c0c62020-03-06 00:38:43 +00002499 return mTetheringManager.getTetheringErroredIfaces();
Robert Greenwalt0c4828c2010-01-26 11:40:34 -08002500 }
2501
2502 /**
Robert Greenwalta75c4652014-06-23 14:53:42 -07002503 * Get the set of tethered dhcp ranges.
2504 *
markchien9e046242020-02-06 19:23:26 +08002505 * @deprecated This method is not supported.
2506 * TODO: remove this function when all of clients are removed.
Robert Greenwalta75c4652014-06-23 14:53:42 -07002507 * {@hide}
2508 */
paulhuec0a9632019-08-12 16:25:11 +08002509 @RequiresPermission(android.Manifest.permission.NETWORK_SETTINGS)
markchien75721e42020-01-21 13:11:06 +08002510 @Deprecated
Robert Greenwalta75c4652014-06-23 14:53:42 -07002511 public String[] getTetheredDhcpRanges() {
markchien9e046242020-02-06 19:23:26 +08002512 throw new UnsupportedOperationException("getTetheredDhcpRanges is not supported");
Robert Greenwalta75c4652014-06-23 14:53:42 -07002513 }
2514
2515 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -08002516 * Attempt to tether the named interface. This will setup a dhcp server
2517 * on the interface, forward and NAT IP packets and forward DNS requests
2518 * to the best active upstream network interface. Note that if no upstream
2519 * IP network interface is available, dhcp will still run and traffic will be
2520 * allowed between the tethered devices and this device, though upstream net
2521 * access will of course fail until an upstream network interface becomes
2522 * active.
Lorenzo Colitti91de63b2015-10-15 16:29:00 +09002523 *
2524 * <p>This method requires the caller to hold either the
2525 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
2526 * or the ability to modify system settings as determined by
2527 * {@link android.provider.Settings.System#canWrite}.</p>
Robert Greenwalt26744a52013-02-15 10:56:35 -08002528 *
Jeremy Klein9a36ec82016-01-22 14:11:45 -08002529 * <p>WARNING: New clients should not use this function. The only usages should be in PanService
2530 * and WifiStateMachine which need direct access. All other clients should use
2531 * {@link #startTethering} and {@link #stopTethering} which encapsulate proper provisioning
2532 * logic.</p>
2533 *
Robert Greenwalt26744a52013-02-15 10:56:35 -08002534 * @param iface the interface name to tether.
2535 * @return error a {@code TETHER_ERROR} value indicating success or failure type
markchien10ddd022020-01-20 19:31:56 +08002536 * @deprecated Use {@link TetheringManager#startTethering} instead
Robert Greenwalt26744a52013-02-15 10:56:35 -08002537 *
Robert Greenwalt0c4828c2010-01-26 11:40:34 -08002538 * {@hide}
2539 */
Mathew Inwoodd078d3d2020-10-27 11:47:29 +00002540 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
markchien10ddd022020-01-20 19:31:56 +08002541 @Deprecated
Robert Greenwalt4283ded2010-03-02 17:25:02 -08002542 public int tether(String iface) {
Automerger Merge Worker9b0c0c62020-03-06 00:38:43 +00002543 return mTetheringManager.tether(iface);
Robert Greenwalt4283ded2010-03-02 17:25:02 -08002544 }
2545
2546 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -08002547 * Stop tethering the named interface.
Lorenzo Colitti91de63b2015-10-15 16:29:00 +09002548 *
2549 * <p>This method requires the caller to hold either the
2550 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
2551 * or the ability to modify system settings as determined by
2552 * {@link android.provider.Settings.System#canWrite}.</p>
Robert Greenwalt26744a52013-02-15 10:56:35 -08002553 *
Jeremy Klein9a36ec82016-01-22 14:11:45 -08002554 * <p>WARNING: New clients should not use this function. The only usages should be in PanService
2555 * and WifiStateMachine which need direct access. All other clients should use
2556 * {@link #startTethering} and {@link #stopTethering} which encapsulate proper provisioning
2557 * logic.</p>
2558 *
Robert Greenwalt26744a52013-02-15 10:56:35 -08002559 * @param iface the interface name to untether.
2560 * @return error a {@code TETHER_ERROR} value indicating success or failure type
2561 *
Robert Greenwalt4283ded2010-03-02 17:25:02 -08002562 * {@hide}
2563 */
Mathew Inwood0b8f8612018-08-08 14:52:47 +01002564 @UnsupportedAppUsage
markchien75721e42020-01-21 13:11:06 +08002565 @Deprecated
Robert Greenwalt4283ded2010-03-02 17:25:02 -08002566 public int untether(String iface) {
Automerger Merge Worker9b0c0c62020-03-06 00:38:43 +00002567 return mTetheringManager.untether(iface);
Robert Greenwalt0c4828c2010-01-26 11:40:34 -08002568 }
Robert Greenwalt8e87f122010-02-11 18:18:40 -08002569
2570 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -08002571 * Check if the device allows for tethering. It may be disabled via
Dianne Hackbornb4b09e82014-02-26 16:20:52 -08002572 * {@code ro.tether.denied} system property, Settings.TETHER_SUPPORTED or
Robert Greenwalt26744a52013-02-15 10:56:35 -08002573 * due to device configuration.
2574 *
Chalard Jean4e1bb722017-09-26 15:45:18 +09002575 * <p>If this app does not have permission to use this API, it will always
2576 * return false rather than throw an exception.</p>
2577 *
2578 * <p>If the device has a hotspot provisioning app, the caller is required to hold the
2579 * {@link android.Manifest.permission.TETHER_PRIVILEGED} permission.</p>
2580 *
2581 * <p>Otherwise, this method requires the caller to hold the ability to modify system
2582 * settings as determined by {@link android.provider.Settings.System#canWrite}.</p>
2583 *
Robert Greenwalt26744a52013-02-15 10:56:35 -08002584 * @return a boolean - {@code true} indicating Tethering is supported.
2585 *
markchien75721e42020-01-21 13:11:06 +08002586 * @deprecated Use {@link TetheringEventCallback#onTetheringSupported(boolean)} instead.
Robert Greenwalt8e87f122010-02-11 18:18:40 -08002587 * {@hide}
2588 */
Jeremy Klein9a36ec82016-01-22 14:11:45 -08002589 @SystemApi
Chalard Jean4e1bb722017-09-26 15:45:18 +09002590 @RequiresPermission(anyOf = {android.Manifest.permission.TETHER_PRIVILEGED,
2591 android.Manifest.permission.WRITE_SETTINGS})
Robert Greenwalt8e87f122010-02-11 18:18:40 -08002592 public boolean isTetheringSupported() {
Automerger Merge Worker9b0c0c62020-03-06 00:38:43 +00002593 return mTetheringManager.isTetheringSupported();
Robert Greenwalt8e87f122010-02-11 18:18:40 -08002594 }
2595
2596 /**
Jeremy Klein9a36ec82016-01-22 14:11:45 -08002597 * Callback for use with {@link #startTethering} to find out whether tethering succeeded.
markchien10ddd022020-01-20 19:31:56 +08002598 *
2599 * @deprecated Use {@link TetheringManager.StartTetheringCallback} instead.
Jeremy Klein9a36ec82016-01-22 14:11:45 -08002600 * @hide
2601 */
2602 @SystemApi
markchien10ddd022020-01-20 19:31:56 +08002603 @Deprecated
Jeremy Klein9a36ec82016-01-22 14:11:45 -08002604 public static abstract class OnStartTetheringCallback {
2605 /**
2606 * Called when tethering has been successfully started.
2607 */
Chalard Jean73d9db72018-06-04 16:52:49 +09002608 public void onTetheringStarted() {}
Jeremy Klein9a36ec82016-01-22 14:11:45 -08002609
2610 /**
2611 * Called when starting tethering failed.
2612 */
Chalard Jean73d9db72018-06-04 16:52:49 +09002613 public void onTetheringFailed() {}
Jeremy Klein9a36ec82016-01-22 14:11:45 -08002614 }
2615
2616 /**
2617 * Convenient overload for
2618 * {@link #startTethering(int, boolean, OnStartTetheringCallback, Handler)} which passes a null
2619 * handler to run on the current thread's {@link Looper}.
markchien10ddd022020-01-20 19:31:56 +08002620 *
2621 * @deprecated Use {@link TetheringManager#startTethering} instead.
Jeremy Klein9a36ec82016-01-22 14:11:45 -08002622 * @hide
2623 */
2624 @SystemApi
markchien10ddd022020-01-20 19:31:56 +08002625 @Deprecated
Udam Saini15072332017-06-07 12:06:28 -07002626 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
Jeremy Klein9a36ec82016-01-22 14:11:45 -08002627 public void startTethering(int type, boolean showProvisioningUi,
2628 final OnStartTetheringCallback callback) {
2629 startTethering(type, showProvisioningUi, callback, null);
2630 }
2631
2632 /**
2633 * Runs tether provisioning for the given type if needed and then starts tethering if
2634 * the check succeeds. If no carrier provisioning is required for tethering, tethering is
2635 * enabled immediately. If provisioning fails, tethering will not be enabled. It also
2636 * schedules tether provisioning re-checks if appropriate.
2637 *
2638 * @param type The type of tethering to start. Must be one of
2639 * {@link ConnectivityManager.TETHERING_WIFI},
2640 * {@link ConnectivityManager.TETHERING_USB}, or
2641 * {@link ConnectivityManager.TETHERING_BLUETOOTH}.
2642 * @param showProvisioningUi a boolean indicating to show the provisioning app UI if there
2643 * is one. This should be true the first time this function is called and also any time
2644 * the user can see this UI. It gives users information from their carrier about the
2645 * check failing and how they can sign up for tethering if possible.
2646 * @param callback an {@link OnStartTetheringCallback} which will be called to notify the caller
2647 * of the result of trying to tether.
2648 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
markchien10ddd022020-01-20 19:31:56 +08002649 *
2650 * @deprecated Use {@link TetheringManager#startTethering} instead.
Jeremy Klein9a36ec82016-01-22 14:11:45 -08002651 * @hide
2652 */
2653 @SystemApi
markchien10ddd022020-01-20 19:31:56 +08002654 @Deprecated
Jeff Sharkeyb8c73032017-06-02 17:36:26 -06002655 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
Jeremy Klein9a36ec82016-01-22 14:11:45 -08002656 public void startTethering(int type, boolean showProvisioningUi,
2657 final OnStartTetheringCallback callback, Handler handler) {
Remi NGUYEN VANc4dd8c92021-03-15 07:31:54 +00002658 Objects.requireNonNull(callback, "OnStartTetheringCallback cannot be null.");
Jeremy Klein49a57952016-03-12 16:29:54 -08002659
markchien10ddd022020-01-20 19:31:56 +08002660 final Executor executor = new Executor() {
Jeremy Klein9a36ec82016-01-22 14:11:45 -08002661 @Override
markchien10ddd022020-01-20 19:31:56 +08002662 public void execute(Runnable command) {
2663 if (handler == null) {
2664 command.run();
Jeremy Klein9a36ec82016-01-22 14:11:45 -08002665 } else {
markchien10ddd022020-01-20 19:31:56 +08002666 handler.post(command);
Jeremy Klein9a36ec82016-01-22 14:11:45 -08002667 }
2668 }
2669 };
Jeremy Klein49a57952016-03-12 16:29:54 -08002670
markchien10ddd022020-01-20 19:31:56 +08002671 final StartTetheringCallback tetheringCallback = new StartTetheringCallback() {
2672 @Override
2673 public void onTetheringStarted() {
2674 callback.onTetheringStarted();
2675 }
2676
2677 @Override
markchien68b67842020-03-19 13:37:43 +08002678 public void onTetheringFailed(final int error) {
markchien10ddd022020-01-20 19:31:56 +08002679 callback.onTetheringFailed();
2680 }
2681 };
2682
2683 final TetheringRequest request = new TetheringRequest.Builder(type)
markchien68b67842020-03-19 13:37:43 +08002684 .setShouldShowEntitlementUi(showProvisioningUi).build();
markchien10ddd022020-01-20 19:31:56 +08002685
Automerger Merge Worker9b0c0c62020-03-06 00:38:43 +00002686 mTetheringManager.startTethering(request, executor, tetheringCallback);
Jeremy Klein9a36ec82016-01-22 14:11:45 -08002687 }
2688
2689 /**
2690 * Stops tethering for the given type. Also cancels any provisioning rechecks for that type if
2691 * applicable.
2692 *
2693 * @param type The type of tethering to stop. Must be one of
2694 * {@link ConnectivityManager.TETHERING_WIFI},
2695 * {@link ConnectivityManager.TETHERING_USB}, or
2696 * {@link ConnectivityManager.TETHERING_BLUETOOTH}.
markchien75721e42020-01-21 13:11:06 +08002697 *
2698 * @deprecated Use {@link TetheringManager#stopTethering} instead.
Jeremy Klein9a36ec82016-01-22 14:11:45 -08002699 * @hide
2700 */
2701 @SystemApi
markchien75721e42020-01-21 13:11:06 +08002702 @Deprecated
Jeff Sharkeyb8c73032017-06-02 17:36:26 -06002703 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
Jeremy Klein9a36ec82016-01-22 14:11:45 -08002704 public void stopTethering(int type) {
Automerger Merge Worker9b0c0c62020-03-06 00:38:43 +00002705 mTetheringManager.stopTethering(type);
Jeremy Klein9a36ec82016-01-22 14:11:45 -08002706 }
2707
2708 /**
markchiena005c992019-02-27 14:56:11 +08002709 * Callback for use with {@link registerTetheringEventCallback} to find out tethering
2710 * upstream status.
2711 *
Nathan Haroldf6fc8ab2020-01-23 18:03:46 -08002712 * @deprecated Use {@link TetheringManager#OnTetheringEventCallback} instead.
markchien75721e42020-01-21 13:11:06 +08002713 * @hide
markchiena005c992019-02-27 14:56:11 +08002714 */
2715 @SystemApi
markchien75721e42020-01-21 13:11:06 +08002716 @Deprecated
markchiena005c992019-02-27 14:56:11 +08002717 public abstract static class OnTetheringEventCallback {
2718
2719 /**
2720 * Called when tethering upstream changed. This can be called multiple times and can be
2721 * called any time.
2722 *
2723 * @param network the {@link Network} of tethering upstream. Null means tethering doesn't
2724 * have any upstream.
2725 */
2726 public void onUpstreamChanged(@Nullable Network network) {}
2727 }
2728
markchien75721e42020-01-21 13:11:06 +08002729 @GuardedBy("mTetheringEventCallbacks")
2730 private final ArrayMap<OnTetheringEventCallback, TetheringEventCallback>
2731 mTetheringEventCallbacks = new ArrayMap<>();
2732
markchiena005c992019-02-27 14:56:11 +08002733 /**
2734 * Start listening to tethering change events. Any new added callback will receive the last
markchiend378cd32019-04-03 10:43:09 +08002735 * tethering status right away. If callback is registered when tethering has no upstream or
markchiena005c992019-02-27 14:56:11 +08002736 * disabled, {@link OnTetheringEventCallback#onUpstreamChanged} will immediately be called
2737 * with a null argument. The same callback object cannot be registered twice.
2738 *
2739 * @param executor the executor on which callback will be invoked.
2740 * @param callback the callback to be called when tethering has change events.
markchien75721e42020-01-21 13:11:06 +08002741 *
Nathan Haroldf6fc8ab2020-01-23 18:03:46 -08002742 * @deprecated Use {@link TetheringManager#registerTetheringEventCallback} instead.
markchiena005c992019-02-27 14:56:11 +08002743 * @hide
2744 */
2745 @SystemApi
markchien75721e42020-01-21 13:11:06 +08002746 @Deprecated
markchiena005c992019-02-27 14:56:11 +08002747 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
2748 public void registerTetheringEventCallback(
2749 @NonNull @CallbackExecutor Executor executor,
2750 @NonNull final OnTetheringEventCallback callback) {
Remi NGUYEN VANc4dd8c92021-03-15 07:31:54 +00002751 Objects.requireNonNull(callback, "OnTetheringEventCallback cannot be null.");
markchiena005c992019-02-27 14:56:11 +08002752
markchien75721e42020-01-21 13:11:06 +08002753 final TetheringEventCallback tetherCallback =
2754 new TetheringEventCallback() {
2755 @Override
2756 public void onUpstreamChanged(@Nullable Network network) {
2757 callback.onUpstreamChanged(network);
2758 }
2759 };
2760
2761 synchronized (mTetheringEventCallbacks) {
2762 mTetheringEventCallbacks.put(callback, tetherCallback);
Automerger Merge Worker9b0c0c62020-03-06 00:38:43 +00002763 mTetheringManager.registerTetheringEventCallback(executor, tetherCallback);
markchien75721e42020-01-21 13:11:06 +08002764 }
markchiena005c992019-02-27 14:56:11 +08002765 }
2766
2767 /**
2768 * Remove tethering event callback previously registered with
2769 * {@link #registerTetheringEventCallback}.
2770 *
2771 * @param callback previously registered callback.
markchien75721e42020-01-21 13:11:06 +08002772 *
2773 * @deprecated Use {@link TetheringManager#unregisterTetheringEventCallback} instead.
markchiena005c992019-02-27 14:56:11 +08002774 * @hide
2775 */
2776 @SystemApi
markchien75721e42020-01-21 13:11:06 +08002777 @Deprecated
markchiena005c992019-02-27 14:56:11 +08002778 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
2779 public void unregisterTetheringEventCallback(
2780 @NonNull final OnTetheringEventCallback callback) {
markchien75721e42020-01-21 13:11:06 +08002781 Objects.requireNonNull(callback, "The callback must be non-null");
2782 synchronized (mTetheringEventCallbacks) {
2783 final TetheringEventCallback tetherCallback =
2784 mTetheringEventCallbacks.remove(callback);
Automerger Merge Worker9b0c0c62020-03-06 00:38:43 +00002785 mTetheringManager.unregisterTetheringEventCallback(tetherCallback);
markchien75721e42020-01-21 13:11:06 +08002786 }
markchiena005c992019-02-27 14:56:11 +08002787 }
2788
2789
2790 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -08002791 * Get the list of regular expressions that define any tetherable
2792 * USB network interfaces. If USB tethering is not supported by the
2793 * device, this list should be empty.
2794 *
2795 * @return an array of 0 or more regular expression Strings defining
2796 * what interfaces are considered tetherable usb interfaces.
2797 *
markchien75721e42020-01-21 13:11:06 +08002798 * @deprecated Use {@link TetheringEventCallback#onTetherableInterfaceRegexpsChanged} instead.
Robert Greenwalt8e87f122010-02-11 18:18:40 -08002799 * {@hide}
2800 */
Jeff Sharkey2ac62992017-04-24 11:18:03 -06002801 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Mathew Inwood0b8f8612018-08-08 14:52:47 +01002802 @UnsupportedAppUsage
markchien75721e42020-01-21 13:11:06 +08002803 @Deprecated
Robert Greenwalt8e87f122010-02-11 18:18:40 -08002804 public String[] getTetherableUsbRegexs() {
Automerger Merge Worker9b0c0c62020-03-06 00:38:43 +00002805 return mTetheringManager.getTetherableUsbRegexs();
Robert Greenwalt8e87f122010-02-11 18:18:40 -08002806 }
2807
2808 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -08002809 * Get the list of regular expressions that define any tetherable
2810 * Wifi network interfaces. If Wifi tethering is not supported by the
2811 * device, this list should be empty.
2812 *
2813 * @return an array of 0 or more regular expression Strings defining
2814 * what interfaces are considered tetherable wifi interfaces.
2815 *
markchien75721e42020-01-21 13:11:06 +08002816 * @deprecated Use {@link TetheringEventCallback#onTetherableInterfaceRegexpsChanged} instead.
Robert Greenwalt8e87f122010-02-11 18:18:40 -08002817 * {@hide}
2818 */
Jeff Sharkey2ac62992017-04-24 11:18:03 -06002819 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Mathew Inwood0b8f8612018-08-08 14:52:47 +01002820 @UnsupportedAppUsage
markchien75721e42020-01-21 13:11:06 +08002821 @Deprecated
Robert Greenwalt8e87f122010-02-11 18:18:40 -08002822 public String[] getTetherableWifiRegexs() {
Automerger Merge Worker9b0c0c62020-03-06 00:38:43 +00002823 return mTetheringManager.getTetherableWifiRegexs();
Robert Greenwalt8e87f122010-02-11 18:18:40 -08002824 }
Robert Greenwalt4283ded2010-03-02 17:25:02 -08002825
Danica Chang96567052010-08-11 14:54:43 -07002826 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -08002827 * Get the list of regular expressions that define any tetherable
2828 * Bluetooth network interfaces. If Bluetooth tethering is not supported by the
2829 * device, this list should be empty.
2830 *
2831 * @return an array of 0 or more regular expression Strings defining
2832 * what interfaces are considered tetherable bluetooth interfaces.
2833 *
markchien75721e42020-01-21 13:11:06 +08002834 * @deprecated Use {@link TetheringEventCallback#onTetherableInterfaceRegexpsChanged(
2835 *TetheringManager.TetheringInterfaceRegexps)} instead.
Danica Chang96567052010-08-11 14:54:43 -07002836 * {@hide}
2837 */
Jeff Sharkey2ac62992017-04-24 11:18:03 -06002838 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Mathew Inwood0b8f8612018-08-08 14:52:47 +01002839 @UnsupportedAppUsage
markchien75721e42020-01-21 13:11:06 +08002840 @Deprecated
Danica Chang96567052010-08-11 14:54:43 -07002841 public String[] getTetherableBluetoothRegexs() {
Automerger Merge Worker9b0c0c62020-03-06 00:38:43 +00002842 return mTetheringManager.getTetherableBluetoothRegexs();
Danica Chang96567052010-08-11 14:54:43 -07002843 }
2844
Mike Lockwooded4a1742011-07-19 13:04:47 -07002845 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -08002846 * Attempt to both alter the mode of USB and Tethering of USB. A
2847 * utility method to deal with some of the complexity of USB - will
2848 * attempt to switch to Rndis and subsequently tether the resulting
2849 * interface on {@code true} or turn off tethering and switch off
2850 * Rndis on {@code false}.
Lorenzo Colitti91de63b2015-10-15 16:29:00 +09002851 *
2852 * <p>This method requires the caller to hold either the
2853 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
2854 * or the ability to modify system settings as determined by
2855 * {@link android.provider.Settings.System#canWrite}.</p>
Robert Greenwalt26744a52013-02-15 10:56:35 -08002856 *
2857 * @param enable a boolean - {@code true} to enable tethering
2858 * @return error a {@code TETHER_ERROR} value indicating success or failure type
markchien10ddd022020-01-20 19:31:56 +08002859 * @deprecated Use {@link TetheringManager#startTethering} instead
Robert Greenwalt26744a52013-02-15 10:56:35 -08002860 *
Mike Lockwooded4a1742011-07-19 13:04:47 -07002861 * {@hide}
2862 */
Mathew Inwood0b8f8612018-08-08 14:52:47 +01002863 @UnsupportedAppUsage
markchien10ddd022020-01-20 19:31:56 +08002864 @Deprecated
Mike Lockwooded4a1742011-07-19 13:04:47 -07002865 public int setUsbTethering(boolean enable) {
Automerger Merge Worker9b0c0c62020-03-06 00:38:43 +00002866 return mTetheringManager.setUsbTethering(enable);
Mike Lockwooded4a1742011-07-19 13:04:47 -07002867 }
2868
markchien75721e42020-01-21 13:11:06 +08002869 /**
2870 * @deprecated Use {@link TetheringManager#TETHER_ERROR_NO_ERROR}.
2871 * {@hide}
2872 */
markchien5bd499c2019-01-16 17:44:13 +08002873 @SystemApi
markchien75721e42020-01-21 13:11:06 +08002874 @Deprecated
Remi NGUYEN VAN23b853b2021-02-15 18:52:06 +09002875 public static final int TETHER_ERROR_NO_ERROR = 0;
markchien75721e42020-01-21 13:11:06 +08002876 /**
2877 * @deprecated Use {@link TetheringManager#TETHER_ERROR_UNKNOWN_IFACE}.
2878 * {@hide}
2879 */
2880 @Deprecated
2881 public static final int TETHER_ERROR_UNKNOWN_IFACE =
2882 TetheringManager.TETHER_ERROR_UNKNOWN_IFACE;
2883 /**
2884 * @deprecated Use {@link TetheringManager#TETHER_ERROR_SERVICE_UNAVAIL}.
2885 * {@hide}
2886 */
2887 @Deprecated
2888 public static final int TETHER_ERROR_SERVICE_UNAVAIL =
2889 TetheringManager.TETHER_ERROR_SERVICE_UNAVAIL;
2890 /**
2891 * @deprecated Use {@link TetheringManager#TETHER_ERROR_UNSUPPORTED}.
2892 * {@hide}
2893 */
2894 @Deprecated
2895 public static final int TETHER_ERROR_UNSUPPORTED = TetheringManager.TETHER_ERROR_UNSUPPORTED;
2896 /**
2897 * @deprecated Use {@link TetheringManager#TETHER_ERROR_UNAVAIL_IFACE}.
2898 * {@hide}
2899 */
2900 @Deprecated
2901 public static final int TETHER_ERROR_UNAVAIL_IFACE =
2902 TetheringManager.TETHER_ERROR_UNAVAIL_IFACE;
2903 /**
markchien68b67842020-03-19 13:37:43 +08002904 * @deprecated Use {@link TetheringManager#TETHER_ERROR_INTERNAL_ERROR}.
markchien75721e42020-01-21 13:11:06 +08002905 * {@hide}
2906 */
2907 @Deprecated
markchien68b67842020-03-19 13:37:43 +08002908 public static final int TETHER_ERROR_MASTER_ERROR =
2909 TetheringManager.TETHER_ERROR_INTERNAL_ERROR;
markchien75721e42020-01-21 13:11:06 +08002910 /**
2911 * @deprecated Use {@link TetheringManager#TETHER_ERROR_TETHER_IFACE_ERROR}.
2912 * {@hide}
2913 */
2914 @Deprecated
2915 public static final int TETHER_ERROR_TETHER_IFACE_ERROR =
2916 TetheringManager.TETHER_ERROR_TETHER_IFACE_ERROR;
2917 /**
2918 * @deprecated Use {@link TetheringManager#TETHER_ERROR_UNTETHER_IFACE_ERROR}.
2919 * {@hide}
2920 */
2921 @Deprecated
2922 public static final int TETHER_ERROR_UNTETHER_IFACE_ERROR =
2923 TetheringManager.TETHER_ERROR_UNTETHER_IFACE_ERROR;
2924 /**
markchien68b67842020-03-19 13:37:43 +08002925 * @deprecated Use {@link TetheringManager#TETHER_ERROR_ENABLE_FORWARDING_ERROR}.
markchien75721e42020-01-21 13:11:06 +08002926 * {@hide}
2927 */
2928 @Deprecated
2929 public static final int TETHER_ERROR_ENABLE_NAT_ERROR =
markchien68b67842020-03-19 13:37:43 +08002930 TetheringManager.TETHER_ERROR_ENABLE_FORWARDING_ERROR;
markchien75721e42020-01-21 13:11:06 +08002931 /**
markchien68b67842020-03-19 13:37:43 +08002932 * @deprecated Use {@link TetheringManager#TETHER_ERROR_DISABLE_FORWARDING_ERROR}.
markchien75721e42020-01-21 13:11:06 +08002933 * {@hide}
2934 */
2935 @Deprecated
2936 public static final int TETHER_ERROR_DISABLE_NAT_ERROR =
markchien68b67842020-03-19 13:37:43 +08002937 TetheringManager.TETHER_ERROR_DISABLE_FORWARDING_ERROR;
markchien75721e42020-01-21 13:11:06 +08002938 /**
2939 * @deprecated Use {@link TetheringManager#TETHER_ERROR_IFACE_CFG_ERROR}.
2940 * {@hide}
2941 */
2942 @Deprecated
2943 public static final int TETHER_ERROR_IFACE_CFG_ERROR =
2944 TetheringManager.TETHER_ERROR_IFACE_CFG_ERROR;
2945 /**
markchien68b67842020-03-19 13:37:43 +08002946 * @deprecated Use {@link TetheringManager#TETHER_ERROR_PROVISIONING_FAILED}.
markchien75721e42020-01-21 13:11:06 +08002947 * {@hide}
2948 */
markchien5bd499c2019-01-16 17:44:13 +08002949 @SystemApi
markchien75721e42020-01-21 13:11:06 +08002950 @Deprecated
Remi NGUYEN VAN23b853b2021-02-15 18:52:06 +09002951 public static final int TETHER_ERROR_PROVISION_FAILED = 11;
markchien75721e42020-01-21 13:11:06 +08002952 /**
2953 * @deprecated Use {@link TetheringManager#TETHER_ERROR_DHCPSERVER_ERROR}.
2954 * {@hide}
2955 */
2956 @Deprecated
2957 public static final int TETHER_ERROR_DHCPSERVER_ERROR =
2958 TetheringManager.TETHER_ERROR_DHCPSERVER_ERROR;
2959 /**
2960 * @deprecated Use {@link TetheringManager#TETHER_ERROR_ENTITLEMENT_UNKNOWN}.
2961 * {@hide}
2962 */
markchien5bd499c2019-01-16 17:44:13 +08002963 @SystemApi
markchien75721e42020-01-21 13:11:06 +08002964 @Deprecated
Remi NGUYEN VAN23b853b2021-02-15 18:52:06 +09002965 public static final int TETHER_ERROR_ENTITLEMENT_UNKONWN = 13;
Robert Greenwalt4283ded2010-03-02 17:25:02 -08002966
2967 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -08002968 * Get a more detailed error code after a Tethering or Untethering
2969 * request asynchronously failed.
2970 *
2971 * @param iface The name of the interface of interest
Robert Greenwalt4283ded2010-03-02 17:25:02 -08002972 * @return error The error code of the last error tethering or untethering the named
2973 * interface
Robert Greenwalt26744a52013-02-15 10:56:35 -08002974 *
markchien75721e42020-01-21 13:11:06 +08002975 * @deprecated Use {@link TetheringEventCallback#onError(String, int)} instead.
Robert Greenwalt4283ded2010-03-02 17:25:02 -08002976 * {@hide}
2977 */
Jeff Sharkey2ac62992017-04-24 11:18:03 -06002978 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Mathew Inwoodd078d3d2020-10-27 11:47:29 +00002979 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
markchien75721e42020-01-21 13:11:06 +08002980 @Deprecated
Robert Greenwalt4283ded2010-03-02 17:25:02 -08002981 public int getLastTetherError(String iface) {
markchien68b67842020-03-19 13:37:43 +08002982 int error = mTetheringManager.getLastTetherError(iface);
2983 if (error == TetheringManager.TETHER_ERROR_UNKNOWN_TYPE) {
2984 // TETHER_ERROR_UNKNOWN_TYPE was introduced with TetheringManager and has never been
2985 // returned by ConnectivityManager. Convert it to the legacy TETHER_ERROR_UNKNOWN_IFACE
2986 // instead.
2987 error = TetheringManager.TETHER_ERROR_UNKNOWN_IFACE;
2988 }
2989 return error;
Robert Greenwalt93dc1042010-06-15 12:19:37 -07002990 }
2991
markchiendd41c822019-03-06 16:25:00 +08002992 /** @hide */
2993 @Retention(RetentionPolicy.SOURCE)
2994 @IntDef(value = {
2995 TETHER_ERROR_NO_ERROR,
2996 TETHER_ERROR_PROVISION_FAILED,
2997 TETHER_ERROR_ENTITLEMENT_UNKONWN,
2998 })
2999 public @interface EntitlementResultCode {
3000 }
3001
Robert Greenwalt93dc1042010-06-15 12:19:37 -07003002 /**
markchiendd41c822019-03-06 16:25:00 +08003003 * Callback for use with {@link #getLatestTetheringEntitlementResult} to find out whether
markchien5bd499c2019-01-16 17:44:13 +08003004 * entitlement succeeded.
markchien75721e42020-01-21 13:11:06 +08003005 *
3006 * @deprecated Use {@link TetheringManager#OnTetheringEntitlementResultListener} instead.
markchien5bd499c2019-01-16 17:44:13 +08003007 * @hide
3008 */
3009 @SystemApi
markchien75721e42020-01-21 13:11:06 +08003010 @Deprecated
markchiendd41c822019-03-06 16:25:00 +08003011 public interface OnTetheringEntitlementResultListener {
3012 /**
3013 * Called to notify entitlement result.
3014 *
3015 * @param resultCode an int value of entitlement result. It may be one of
3016 * {@link #TETHER_ERROR_NO_ERROR},
3017 * {@link #TETHER_ERROR_PROVISION_FAILED}, or
3018 * {@link #TETHER_ERROR_ENTITLEMENT_UNKONWN}.
3019 */
Jeremy Kleina9aad902019-03-12 13:32:08 -07003020 void onTetheringEntitlementResult(@EntitlementResultCode int resultCode);
markchiendd41c822019-03-06 16:25:00 +08003021 }
3022
3023 /**
markchien5bd499c2019-01-16 17:44:13 +08003024 * Get the last value of the entitlement check on this downstream. If the cached value is
3025 * {@link #TETHER_ERROR_NO_ERROR} or showEntitlementUi argument is false, it just return the
3026 * cached value. Otherwise, a UI-based entitlement check would be performed. It is not
3027 * guaranteed that the UI-based entitlement check will complete in any specific time period
3028 * and may in fact never complete. Any successful entitlement check the platform performs for
3029 * any reason will update the cached value.
3030 *
3031 * @param type the downstream type of tethering. Must be one of
3032 * {@link #TETHERING_WIFI},
3033 * {@link #TETHERING_USB}, or
3034 * {@link #TETHERING_BLUETOOTH}.
3035 * @param showEntitlementUi a boolean indicating whether to run UI-based entitlement check.
markchiendd41c822019-03-06 16:25:00 +08003036 * @param executor the executor on which callback will be invoked.
3037 * @param listener an {@link OnTetheringEntitlementResultListener} which will be called to
3038 * notify the caller of the result of entitlement check. The listener may be called zero
3039 * or one time.
markchien75721e42020-01-21 13:11:06 +08003040 * @deprecated Use {@link TetheringManager#requestLatestTetheringEntitlementResult} instead.
markchien5bd499c2019-01-16 17:44:13 +08003041 * {@hide}
3042 */
3043 @SystemApi
markchien75721e42020-01-21 13:11:06 +08003044 @Deprecated
markchien5bd499c2019-01-16 17:44:13 +08003045 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
markchiendd41c822019-03-06 16:25:00 +08003046 public void getLatestTetheringEntitlementResult(int type, boolean showEntitlementUi,
3047 @NonNull @CallbackExecutor Executor executor,
3048 @NonNull final OnTetheringEntitlementResultListener listener) {
Remi NGUYEN VANc4dd8c92021-03-15 07:31:54 +00003049 Objects.requireNonNull(listener, "TetheringEntitlementResultListener cannot be null.");
markchiendd41c822019-03-06 16:25:00 +08003050 ResultReceiver wrappedListener = new ResultReceiver(null) {
3051 @Override
3052 protected void onReceiveResult(int resultCode, Bundle resultData) {
lucaslin9cc04192021-03-04 09:38:21 +08003053 final long token = Binder.clearCallingIdentity();
3054 try {
3055 executor.execute(() -> {
3056 listener.onTetheringEntitlementResult(resultCode);
3057 });
3058 } finally {
3059 Binder.restoreCallingIdentity(token);
3060 }
markchiendd41c822019-03-06 16:25:00 +08003061 }
3062 };
3063
Automerger Merge Worker9b0c0c62020-03-06 00:38:43 +00003064 mTetheringManager.requestLatestTetheringEntitlementResult(type, wrappedListener,
markchienb0bb7862019-12-16 20:15:20 +08003065 showEntitlementUi);
markchiendd41c822019-03-06 16:25:00 +08003066 }
3067
3068 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -08003069 * Report network connectivity status. This is currently used only
3070 * to alter status bar UI.
Paul Jensen19b3ee72015-05-06 11:10:18 -04003071 * <p>This method requires the caller to hold the permission
3072 * {@link android.Manifest.permission#STATUS_BAR}.
Robert Greenwalt26744a52013-02-15 10:56:35 -08003073 *
Robert Greenwalt986c7412010-09-08 15:24:47 -07003074 * @param networkType The type of network you want to report on
3075 * @param percentage The quality of the connection 0 is bad, 100 is good
Chalard Jean5acb7b72018-03-08 13:54:53 +09003076 * @deprecated Types are deprecated. Use {@link #reportNetworkConnectivity} instead.
Robert Greenwalt986c7412010-09-08 15:24:47 -07003077 * {@hide}
3078 */
3079 public void reportInetCondition(int networkType, int percentage) {
Soi, Yoshinari99efcbd2015-11-12 12:09:02 +09003080 printStackTrace();
Robert Greenwalt986c7412010-09-08 15:24:47 -07003081 try {
3082 mService.reportInetCondition(networkType, percentage);
3083 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07003084 throw e.rethrowFromSystemServer();
Robert Greenwalt986c7412010-09-08 15:24:47 -07003085 }
3086 }
Robert Greenwaltc3c5f862010-10-11 16:00:27 -07003087
3088 /**
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07003089 * Report a problem network to the framework. This provides a hint to the system
Ye Wen849c72a2014-07-21 14:19:01 -07003090 * that there might be connectivity problems on this network and may cause
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07003091 * the framework to re-evaluate network connectivity and/or switch to another
3092 * network.
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003093 *
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07003094 * @param network The {@link Network} the application was attempting to use
3095 * or {@code null} to indicate the current default network.
Paul Jensen7aac1b32015-04-07 12:43:13 -04003096 * @deprecated Use {@link #reportNetworkConnectivity} which allows reporting both
3097 * working and non-working connectivity.
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003098 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -07003099 @Deprecated
Chalard Jean42a9c292019-01-07 19:26:34 +09003100 public void reportBadNetwork(@Nullable Network network) {
Soi, Yoshinari99efcbd2015-11-12 12:09:02 +09003101 printStackTrace();
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003102 try {
Paul Jensen7aac1b32015-04-07 12:43:13 -04003103 // One of these will be ignored because it matches system's current state.
3104 // The other will trigger the necessary reevaluation.
3105 mService.reportNetworkConnectivity(network, true);
3106 mService.reportNetworkConnectivity(network, false);
3107 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07003108 throw e.rethrowFromSystemServer();
Paul Jensen7aac1b32015-04-07 12:43:13 -04003109 }
3110 }
3111
3112 /**
3113 * Report to the framework whether a network has working connectivity.
3114 * This provides a hint to the system that a particular network is providing
3115 * working connectivity or not. In response the framework may re-evaluate
3116 * the network's connectivity and might take further action thereafter.
3117 *
3118 * @param network The {@link Network} the application was attempting to use
3119 * or {@code null} to indicate the current default network.
3120 * @param hasConnectivity {@code true} if the application was able to successfully access the
3121 * Internet using {@code network} or {@code false} if not.
3122 */
Chalard Jean42a9c292019-01-07 19:26:34 +09003123 public void reportNetworkConnectivity(@Nullable Network network, boolean hasConnectivity) {
Soi, Yoshinari99efcbd2015-11-12 12:09:02 +09003124 printStackTrace();
Paul Jensen7aac1b32015-04-07 12:43:13 -04003125 try {
3126 mService.reportNetworkConnectivity(network, hasConnectivity);
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003127 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07003128 throw e.rethrowFromSystemServer();
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003129 }
3130 }
3131
3132 /**
Chalard Jeanaac3b872021-03-17 17:03:34 +09003133 * Set a network-independent global HTTP proxy.
Paul Jensen19b3ee72015-05-06 11:10:18 -04003134 *
Chalard Jeanaac3b872021-03-17 17:03:34 +09003135 * This sets an HTTP proxy that applies to all networks and overrides any network-specific
3136 * proxy. If set, HTTP libraries that are proxy-aware will use this global proxy when
3137 * accessing any network, regardless of what the settings for that network are.
3138 *
3139 * Note that HTTP proxies are by nature typically network-dependent, and setting a global
3140 * proxy is likely to break networking on multiple networks. This method is only meant
3141 * for device policy clients looking to do general internal filtering or similar use cases.
3142 *
3143 * {@see #getGlobalProxy}
3144 * {@see LinkProperties#getHttpProxy}
3145 *
3146 * @param p A {@link ProxyInfo} object defining the new global HTTP proxy. Calling this
3147 * method with a {@code null} value will clear the global HTTP proxy.
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07003148 * @hide
Robert Greenwaltc3c5f862010-10-11 16:00:27 -07003149 */
Chalard Jeanaac3b872021-03-17 17:03:34 +09003150 // Used by Device Policy Manager to set the global proxy.
Chiachang Wang0cefc1c2021-03-18 09:44:34 +08003151 @SystemApi(client = MODULE_LIBRARIES)
paulhuec0a9632019-08-12 16:25:11 +08003152 @RequiresPermission(android.Manifest.permission.NETWORK_STACK)
Chalard Jeanaac3b872021-03-17 17:03:34 +09003153 public void setGlobalProxy(@Nullable final ProxyInfo p) {
Robert Greenwaltc3c5f862010-10-11 16:00:27 -07003154 try {
3155 mService.setGlobalProxy(p);
3156 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07003157 throw e.rethrowFromSystemServer();
Robert Greenwaltc3c5f862010-10-11 16:00:27 -07003158 }
3159 }
3160
3161 /**
Robert Greenwalt26744a52013-02-15 10:56:35 -08003162 * Retrieve any network-independent global HTTP proxy.
3163 *
Jason Monk1e3df5d2014-04-25 15:00:09 -04003164 * @return {@link ProxyInfo} for the current global HTTP proxy or {@code null}
Robert Greenwalt26744a52013-02-15 10:56:35 -08003165 * if no global HTTP proxy is set.
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07003166 * @hide
Robert Greenwaltc3c5f862010-10-11 16:00:27 -07003167 */
Chiachang Wang0cefc1c2021-03-18 09:44:34 +08003168 @SystemApi(client = MODULE_LIBRARIES)
3169 @Nullable
Jason Monk1e3df5d2014-04-25 15:00:09 -04003170 public ProxyInfo getGlobalProxy() {
Robert Greenwaltc3c5f862010-10-11 16:00:27 -07003171 try {
3172 return mService.getGlobalProxy();
3173 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07003174 throw e.rethrowFromSystemServer();
Robert Greenwaltc3c5f862010-10-11 16:00:27 -07003175 }
3176 }
3177
3178 /**
Paul Jensenfdec88b2015-05-06 07:32:40 -04003179 * Retrieve the global HTTP proxy, or if no global HTTP proxy is set, a
3180 * network-specific HTTP proxy. If {@code network} is null, the
3181 * network-specific proxy returned is the proxy of the default active
3182 * network.
3183 *
3184 * @return {@link ProxyInfo} for the current global HTTP proxy, or if no
3185 * global HTTP proxy is set, {@code ProxyInfo} for {@code network},
3186 * or when {@code network} is {@code null},
3187 * the {@code ProxyInfo} for the default active network. Returns
3188 * {@code null} when no proxy applies or the caller doesn't have
3189 * permission to use {@code network}.
3190 * @hide
3191 */
3192 public ProxyInfo getProxyForNetwork(Network network) {
3193 try {
3194 return mService.getProxyForNetwork(network);
3195 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07003196 throw e.rethrowFromSystemServer();
Paul Jensenfdec88b2015-05-06 07:32:40 -04003197 }
3198 }
3199
3200 /**
Paul Jensen12131352014-12-10 15:12:18 -05003201 * Get the current default HTTP proxy settings. If a global proxy is set it will be returned,
3202 * otherwise if this process is bound to a {@link Network} using
Paul Jensen895c3942015-03-10 10:54:12 -04003203 * {@link #bindProcessToNetwork} then that {@code Network}'s proxy is returned, otherwise
Paul Jensen12131352014-12-10 15:12:18 -05003204 * the default network's proxy is returned.
Robert Greenwalt26744a52013-02-15 10:56:35 -08003205 *
Jason Monk1e3df5d2014-04-25 15:00:09 -04003206 * @return the {@link ProxyInfo} for the current HTTP proxy, or {@code null} if no
Robert Greenwalt26744a52013-02-15 10:56:35 -08003207 * HTTP proxy is active.
Robert Greenwaltc3c5f862010-10-11 16:00:27 -07003208 */
Chalard Jean42a9c292019-01-07 19:26:34 +09003209 @Nullable
Paul Jensen12131352014-12-10 15:12:18 -05003210 public ProxyInfo getDefaultProxy() {
Paul Jensenfdec88b2015-05-06 07:32:40 -04003211 return getProxyForNetwork(getBoundNetworkForProcess());
Robert Greenwaltc3c5f862010-10-11 16:00:27 -07003212 }
Robert Greenwalt34848c02011-03-25 13:09:25 -07003213
3214 /**
Robert Greenwalt0114f6e2011-08-31 11:46:42 -07003215 * Returns true if the hardware supports the given network type
3216 * else it returns false. This doesn't indicate we have coverage
3217 * or are authorized onto a network, just whether or not the
Robert Greenwalt26744a52013-02-15 10:56:35 -08003218 * hardware supports it. For example a GSM phone without a SIM
3219 * should still return {@code true} for mobile data, but a wifi only
3220 * tablet would return {@code false}.
3221 *
3222 * @param networkType The network type we'd like to check
3223 * @return {@code true} if supported, else {@code false}
Chalard Jean5acb7b72018-03-08 13:54:53 +09003224 * @deprecated Types are deprecated. Use {@link NetworkCapabilities} instead.
Robert Greenwalt0114f6e2011-08-31 11:46:42 -07003225 * @hide
3226 */
Chalard Jean5acb7b72018-03-08 13:54:53 +09003227 @Deprecated
Jeff Sharkey2ac62992017-04-24 11:18:03 -06003228 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jeanaa91c9d2019-04-09 15:46:21 +09003229 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 130143562)
Robert Greenwalt0114f6e2011-08-31 11:46:42 -07003230 public boolean isNetworkSupported(int networkType) {
3231 try {
3232 return mService.isNetworkSupported(networkType);
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07003233 } catch (RemoteException e) {
3234 throw e.rethrowFromSystemServer();
3235 }
Robert Greenwalt0114f6e2011-08-31 11:46:42 -07003236 }
Jeff Sharkeyd00b1302012-04-12 18:34:54 -07003237
3238 /**
3239 * Returns if the currently active data network is metered. A network is
3240 * classified as metered when the user is sensitive to heavy data usage on
Robert Greenwalt26744a52013-02-15 10:56:35 -08003241 * that connection due to monetary costs, data limitations or
3242 * battery/performance issues. You should check this before doing large
3243 * data transfers, and warn the user or delay the operation until another
3244 * network is available.
3245 *
3246 * @return {@code true} if large transfers should be avoided, otherwise
3247 * {@code false}.
Jeff Sharkeyd00b1302012-04-12 18:34:54 -07003248 */
Jeff Sharkey2ac62992017-04-24 11:18:03 -06003249 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Jeff Sharkeyd00b1302012-04-12 18:34:54 -07003250 public boolean isActiveNetworkMetered() {
3251 try {
3252 return mService.isActiveNetworkMetered();
3253 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07003254 throw e.rethrowFromSystemServer();
Jeff Sharkeyd00b1302012-04-12 18:34:54 -07003255 }
3256 }
Jeff Sharkeyf2e722a2012-08-25 00:05:46 -07003257
Robert Greenwalt26744a52013-02-15 10:56:35 -08003258 /**
Sarah Chincab74db2020-11-25 12:15:14 -08003259 * Set sign in error notification to visible or invisible
Wink Saville89c87b92013-08-29 08:55:16 -07003260 *
Sarah Chincab74db2020-11-25 12:15:14 -08003261 * @hide
Paul Jensena8e6dc62015-03-18 12:23:02 -04003262 * @deprecated Doesn't properly deal with multiple connected networks of the same type.
Wink Saville89c87b92013-08-29 08:55:16 -07003263 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -07003264 @Deprecated
Wink Saville89c87b92013-08-29 08:55:16 -07003265 public void setProvisioningNotificationVisible(boolean visible, int networkType,
Paul Jensen82c7e422014-09-15 15:59:36 -04003266 String action) {
Wink Saville89c87b92013-08-29 08:55:16 -07003267 try {
Paul Jensen82c7e422014-09-15 15:59:36 -04003268 mService.setProvisioningNotificationVisible(visible, networkType, action);
Wink Saville89c87b92013-08-29 08:55:16 -07003269 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07003270 throw e.rethrowFromSystemServer();
Wink Saville89c87b92013-08-29 08:55:16 -07003271 }
3272 }
Yuhao Zheng15019892013-09-09 17:00:04 -07003273
3274 /**
3275 * Set the value for enabling/disabling airplane mode
3276 *
3277 * @param enable whether to enable airplane mode or not
3278 *
Yuhao Zheng15019892013-09-09 17:00:04 -07003279 * @hide
3280 */
Lorenzo Colittic4d01862018-10-09 18:55:11 +09003281 @RequiresPermission(anyOf = {
Edward Savage-Jones3b9fe322019-11-26 13:18:08 +01003282 android.Manifest.permission.NETWORK_AIRPLANE_MODE,
Lorenzo Colittic4d01862018-10-09 18:55:11 +09003283 android.Manifest.permission.NETWORK_SETTINGS,
3284 android.Manifest.permission.NETWORK_SETUP_WIZARD,
3285 android.Manifest.permission.NETWORK_STACK})
Lorenzo Colitti272a77d2018-10-09 18:50:32 +09003286 @SystemApi
Yuhao Zheng15019892013-09-09 17:00:04 -07003287 public void setAirplaneMode(boolean enable) {
3288 try {
3289 mService.setAirplaneMode(enable);
3290 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07003291 throw e.rethrowFromSystemServer();
Yuhao Zheng15019892013-09-09 17:00:04 -07003292 }
3293 }
Robert Greenwalt948aea52014-04-11 15:53:27 -07003294
Lorenzo Colitti92e6c272020-01-08 00:04:09 +09003295 /**
3296 * Registers the specified {@link NetworkProvider}.
3297 * Each listener must only be registered once. The listener can be unregistered with
3298 * {@link #unregisterNetworkProvider}.
3299 *
3300 * @param provider the provider to register
3301 * @return the ID of the provider. This ID must be used by the provider when registering
3302 * {@link android.net.NetworkAgent}s.
3303 * @hide
3304 */
3305 @SystemApi
Automerger Merge Workeref12b642020-03-04 18:04:01 +00003306 @RequiresPermission(anyOf = {
3307 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
3308 android.Manifest.permission.NETWORK_FACTORY})
Lorenzo Colitti92e6c272020-01-08 00:04:09 +09003309 public int registerNetworkProvider(@NonNull NetworkProvider provider) {
3310 if (provider.getProviderId() != NetworkProvider.ID_NONE) {
Lorenzo Colitti92e6c272020-01-08 00:04:09 +09003311 throw new IllegalStateException("NetworkProviders can only be registered once");
3312 }
3313
3314 try {
3315 int providerId = mService.registerNetworkProvider(provider.getMessenger(),
3316 provider.getName());
3317 provider.setProviderId(providerId);
3318 } catch (RemoteException e) {
3319 throw e.rethrowFromSystemServer();
3320 }
3321 return provider.getProviderId();
3322 }
3323
3324 /**
3325 * Unregisters the specified NetworkProvider.
3326 *
3327 * @param provider the provider to unregister
3328 * @hide
3329 */
3330 @SystemApi
Automerger Merge Workeref12b642020-03-04 18:04:01 +00003331 @RequiresPermission(anyOf = {
3332 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
3333 android.Manifest.permission.NETWORK_FACTORY})
Lorenzo Colitti92e6c272020-01-08 00:04:09 +09003334 public void unregisterNetworkProvider(@NonNull NetworkProvider provider) {
3335 try {
3336 mService.unregisterNetworkProvider(provider.getMessenger());
3337 } catch (RemoteException e) {
3338 throw e.rethrowFromSystemServer();
3339 }
3340 provider.setProviderId(NetworkProvider.ID_NONE);
3341 }
3342
Chalard Jean1ef1d902021-01-05 08:40:09 +09003343 /**
3344 * Register or update a network offer with ConnectivityService.
3345 *
3346 * ConnectivityService keeps track of offers made by the various providers and matches
Chalard Jeand7268cd2021-03-24 17:43:10 +09003347 * them to networking requests made by apps or the system. A callback identifies an offer
3348 * uniquely, and later calls with the same callback update the offer. The provider supplies a
3349 * score and the capabilities of the network it might be able to bring up ; these act as
3350 * filters used by ConnectivityService to only send those requests that can be fulfilled by the
Chalard Jean1ef1d902021-01-05 08:40:09 +09003351 * provider.
3352 *
3353 * The provider is under no obligation to be able to bring up the network it offers at any
3354 * given time. Instead, this mechanism is meant to limit requests received by providers
3355 * to those they actually have a chance to fulfill, as providers don't have a way to compare
3356 * the quality of the network satisfying a given request to their own offer.
3357 *
3358 * An offer can be updated by calling this again with the same callback object. This is
3359 * similar to calling unofferNetwork and offerNetwork again, but will only update the
3360 * provider with the changes caused by the changes in the offer.
3361 *
3362 * @param provider The provider making this offer.
3363 * @param score The prospective score of the network.
3364 * @param caps The prospective capabilities of the network.
3365 * @param callback The callback to call when this offer is needed or unneeded.
Chalard Jean7b6a33b2021-01-12 10:58:56 +09003366 * @hide exposed via the NetworkProvider class.
Chalard Jean1ef1d902021-01-05 08:40:09 +09003367 */
3368 @RequiresPermission(anyOf = {
3369 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
3370 android.Manifest.permission.NETWORK_FACTORY})
Chalard Jeanb004da52021-03-22 22:44:02 +09003371 public void offerNetwork(@NonNull final int providerId,
Chalard Jean1ef1d902021-01-05 08:40:09 +09003372 @NonNull final NetworkScore score, @NonNull final NetworkCapabilities caps,
3373 @NonNull final INetworkOfferCallback callback) {
3374 try {
Chalard Jeanb004da52021-03-22 22:44:02 +09003375 mService.offerNetwork(providerId,
Chalard Jean1ef1d902021-01-05 08:40:09 +09003376 Objects.requireNonNull(score, "null score"),
3377 Objects.requireNonNull(caps, "null caps"),
3378 Objects.requireNonNull(callback, "null callback"));
3379 } catch (RemoteException e) {
3380 throw e.rethrowFromSystemServer();
3381 }
3382 }
Lorenzo Colitti92e6c272020-01-08 00:04:09 +09003383
Chalard Jean1ef1d902021-01-05 08:40:09 +09003384 /**
3385 * Withdraw a network offer made with {@link #offerNetwork}.
3386 *
3387 * @param callback The callback passed at registration time. This must be the same object
3388 * that was passed to {@link #offerNetwork}
Chalard Jean7b6a33b2021-01-12 10:58:56 +09003389 * @hide exposed via the NetworkProvider class.
Chalard Jean1ef1d902021-01-05 08:40:09 +09003390 */
3391 public void unofferNetwork(@NonNull final INetworkOfferCallback callback) {
3392 try {
3393 mService.unofferNetwork(Objects.requireNonNull(callback));
3394 } catch (RemoteException e) {
3395 throw e.rethrowFromSystemServer();
3396 }
3397 }
Lorenzo Colitti92e6c272020-01-08 00:04:09 +09003398 /** @hide exposed via the NetworkProvider class. */
Automerger Merge Workeref12b642020-03-04 18:04:01 +00003399 @RequiresPermission(anyOf = {
3400 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
3401 android.Manifest.permission.NETWORK_FACTORY})
Lorenzo Colitti92e6c272020-01-08 00:04:09 +09003402 public void declareNetworkRequestUnfulfillable(@NonNull NetworkRequest request) {
3403 try {
3404 mService.declareNetworkRequestUnfulfillable(request);
3405 } catch (RemoteException e) {
3406 throw e.rethrowFromSystemServer();
3407 }
3408 }
3409
Paul Jensenc2569432015-02-13 14:18:39 -05003410 /**
3411 * @hide
3412 * Register a NetworkAgent with ConnectivityService.
Chalard Jean1aea87a2019-12-13 19:47:12 +09003413 * @return Network corresponding to NetworkAgent.
Paul Jensenc2569432015-02-13 14:18:39 -05003414 */
Automerger Merge Workeref12b642020-03-04 18:04:01 +00003415 @RequiresPermission(anyOf = {
3416 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
3417 android.Manifest.permission.NETWORK_FACTORY})
Remi NGUYEN VAN37ebfa82020-12-23 12:45:08 +09003418 public Network registerNetworkAgent(INetworkAgent na, NetworkInfo ni, LinkProperties lp,
Chalard Jeandd753522020-12-21 18:36:52 +09003419 NetworkCapabilities nc, @NonNull NetworkScore score, NetworkAgentConfig config,
3420 int providerId) {
Robert Greenwaltdb6fac52014-04-18 15:25:25 -07003421 try {
Remi NGUYEN VAN37ebfa82020-12-23 12:45:08 +09003422 return mService.registerNetworkAgent(na, ni, lp, nc, score, config, providerId);
Paul Jensenc2569432015-02-13 14:18:39 -05003423 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07003424 throw e.rethrowFromSystemServer();
Paul Jensenc2569432015-02-13 14:18:39 -05003425 }
Robert Greenwaltdb6fac52014-04-18 15:25:25 -07003426 }
3427
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003428 /**
Hugo Benichi45a49542017-03-06 09:17:06 +09003429 * Base class for {@code NetworkRequest} callbacks. Used for notifications about network
3430 * changes. Should be extended by applications wanting notifications.
3431 *
3432 * A {@code NetworkCallback} is registered by calling
3433 * {@link #requestNetwork(NetworkRequest, NetworkCallback)},
3434 * {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)},
Hugo Benichi7665a142018-02-07 21:17:43 +09003435 * or {@link #registerDefaultNetworkCallback(NetworkCallback)}. A {@code NetworkCallback} is
Hugo Benichi45a49542017-03-06 09:17:06 +09003436 * unregistered by calling {@link #unregisterNetworkCallback(NetworkCallback)}.
3437 * A {@code NetworkCallback} should be registered at most once at any time.
3438 * A {@code NetworkCallback} that has been unregistered can be registered again.
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003439 */
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07003440 public static class NetworkCallback {
Robert Greenwaltdb6fac52014-04-18 15:25:25 -07003441 /**
Roshan Pius7992afd2020-12-22 15:10:42 -08003442 * No flags associated with this callback.
3443 * @hide
3444 */
3445 public static final int FLAG_NONE = 0;
3446 /**
3447 * Use this flag to include any location sensitive data in {@link NetworkCapabilities} sent
3448 * via {@link #onCapabilitiesChanged(Network, NetworkCapabilities)}.
3449 * <p>
3450 * These include:
3451 * <li> Some transport info instances (retrieved via
3452 * {@link NetworkCapabilities#getTransportInfo()}) like {@link android.net.wifi.WifiInfo}
3453 * contain location sensitive information.
3454 * <li> OwnerUid (retrieved via {@link NetworkCapabilities#getOwnerUid()} is location
3455 * sensitive for wifi suggestor apps (i.e using {@link WifiNetworkSuggestion}).</li>
3456 * </p>
3457 * <p>
3458 * Note:
3459 * <li> Retrieving this location sensitive information (subject to app's location
3460 * permissions) will be noted by system. </li>
3461 * <li> Without this flag any {@link NetworkCapabilities} provided via the callback does
3462 * not include location sensitive info.
3463 * </p>
3464 */
Roshan Piusf75ffaa2021-03-11 21:16:44 -08003465 // Note: Some existing fields which are location sensitive may still be included without
3466 // this flag if the app targets SDK < S (to maintain backwards compatibility).
Roshan Pius7992afd2020-12-22 15:10:42 -08003467 public static final int FLAG_INCLUDE_LOCATION_INFO = 1 << 0;
3468
3469 /** @hide */
3470 @Retention(RetentionPolicy.SOURCE)
3471 @IntDef(flag = true, prefix = "FLAG_", value = {
3472 FLAG_NONE,
3473 FLAG_INCLUDE_LOCATION_INFO
3474 })
3475 public @interface Flag { }
3476
3477 /**
3478 * All the valid flags for error checking.
3479 */
3480 private static final int VALID_FLAGS = FLAG_INCLUDE_LOCATION_INFO;
3481
3482 public NetworkCallback() {
3483 this(FLAG_NONE);
3484 }
3485
3486 public NetworkCallback(@Flag int flags) {
Remi NGUYEN VANc4dd8c92021-03-15 07:31:54 +00003487 if ((flags & VALID_FLAGS) != flags) {
3488 throw new IllegalArgumentException("Invalid flags");
3489 }
Roshan Pius7992afd2020-12-22 15:10:42 -08003490 mFlags = flags;
3491 }
3492
3493 /**
Lorenzo Colitticcf82102015-04-24 12:23:24 +09003494 * Called when the framework connects to a new network to evaluate whether it satisfies this
3495 * request. If evaluation succeeds, this callback may be followed by an {@link #onAvailable}
3496 * callback. There is no guarantee that this new network will satisfy any requests, or that
3497 * the network will stay connected for longer than the time necessary to evaluate it.
3498 * <p>
3499 * Most applications <b>should not</b> act on this callback, and should instead use
3500 * {@link #onAvailable}. This callback is intended for use by applications that can assist
3501 * the framework in properly evaluating the network &mdash; for example, an application that
3502 * can automatically log in to a captive portal without user intervention.
3503 *
3504 * @param network The {@link Network} of the network that is being evaluated.
Lorenzo Colittia04936a2015-06-11 14:27:17 +09003505 *
3506 * @hide
Robert Greenwaltdb6fac52014-04-18 15:25:25 -07003507 */
paulhua9a6e2a2019-03-22 16:35:06 +08003508 public void onPreCheck(@NonNull Network network) {}
Robert Greenwaltdb6fac52014-04-18 15:25:25 -07003509
3510 /**
Lorenzo Colitticcf82102015-04-24 12:23:24 +09003511 * Called when the framework connects and has declared a new network ready for use.
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07003512 * This callback may be called more than once if the {@link Network} that is
3513 * satisfying the request changes.
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07003514 *
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07003515 * @param network The {@link Network} of the satisfying network.
Chalard Jeanb6a0c6d2018-01-30 22:41:41 +09003516 * @param networkCapabilities The {@link NetworkCapabilities} of the satisfying network.
3517 * @param linkProperties The {@link LinkProperties} of the satisfying network.
junyulai5ab727b2018-08-07 19:50:45 +08003518 * @param blocked Whether access to the {@link Network} is blocked due to system policy.
Chalard Jeanb6a0c6d2018-01-30 22:41:41 +09003519 * @hide
3520 */
Lorenzo Colitti60104f52021-03-18 00:54:57 +09003521 public final void onAvailable(@NonNull Network network,
paulhua9a6e2a2019-03-22 16:35:06 +08003522 @NonNull NetworkCapabilities networkCapabilities,
Lorenzo Colitti60104f52021-03-18 00:54:57 +09003523 @NonNull LinkProperties linkProperties, @BlockedReason int blocked) {
Chalard Jeanb6a0c6d2018-01-30 22:41:41 +09003524 // Internally only this method is called when a new network is available, and
3525 // it calls the callback in the same way and order that older versions used
3526 // to call so as not to change the behavior.
Lorenzo Colitti60104f52021-03-18 00:54:57 +09003527 onAvailable(network, networkCapabilities, linkProperties, blocked != 0);
3528 onBlockedStatusChanged(network, blocked);
3529 }
3530
3531 /**
3532 * Legacy variant of onAvailable that takes a boolean blocked reason.
3533 *
3534 * This method has never been public API, but it's not final, so there may be apps that
3535 * implemented it and rely on it being called. Do our best not to break them.
3536 * Note: such apps will also get a second call to onBlockedStatusChanged immediately after
3537 * this method is called. There does not seem to be a way to avoid this.
3538 * TODO: add a compat check to move apps off this method, and eventually stop calling it.
3539 *
3540 * @hide
3541 */
3542 public void onAvailable(@NonNull Network network,
3543 @NonNull NetworkCapabilities networkCapabilities,
3544 @NonNull LinkProperties linkProperties, boolean blocked) {
Chalard Jeanb6a0c6d2018-01-30 22:41:41 +09003545 onAvailable(network);
3546 if (!networkCapabilities.hasCapability(
3547 NetworkCapabilities.NET_CAPABILITY_NOT_SUSPENDED)) {
3548 onNetworkSuspended(network);
3549 }
3550 onCapabilitiesChanged(network, networkCapabilities);
3551 onLinkPropertiesChanged(network, linkProperties);
Lorenzo Colitti60104f52021-03-18 00:54:57 +09003552 // No call to onBlockedStatusChanged here. That is done by the caller.
Chalard Jeanb6a0c6d2018-01-30 22:41:41 +09003553 }
3554
3555 /**
3556 * Called when the framework connects and has declared a new network ready for use.
Chalard Jean7f3a8742019-08-30 16:27:28 +09003557 *
3558 * <p>For callbacks registered with {@link #registerNetworkCallback}, multiple networks may
3559 * be available at the same time, and onAvailable will be called for each of these as they
3560 * appear.
3561 *
3562 * <p>For callbacks registered with {@link #requestNetwork} and
3563 * {@link #registerDefaultNetworkCallback}, this means the network passed as an argument
3564 * is the new best network for this request and is now tracked by this callback ; this
3565 * callback will no longer receive method calls about other networks that may have been
3566 * passed to this method previously. The previously-best network may have disconnected, or
3567 * it may still be around and the newly-best network may simply be better.
3568 *
3569 * <p>Starting with {@link android.os.Build.VERSION_CODES#O}, this will always immediately
3570 * be followed by a call to {@link #onCapabilitiesChanged(Network, NetworkCapabilities)}
3571 * then by a call to {@link #onLinkPropertiesChanged(Network, LinkProperties)}, and a call
3572 * to {@link #onBlockedStatusChanged(Network, boolean)}.
3573 *
3574 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
3575 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
3576 * this callback as this is prone to race conditions (there is no guarantee the objects
3577 * returned by these methods will be current). Instead, wait for a call to
3578 * {@link #onCapabilitiesChanged(Network, NetworkCapabilities)} and
3579 * {@link #onLinkPropertiesChanged(Network, LinkProperties)} whose arguments are guaranteed
3580 * to be well-ordered with respect to other callbacks.
Chalard Jeanb6a0c6d2018-01-30 22:41:41 +09003581 *
3582 * @param network The {@link Network} of the satisfying network.
Robert Greenwaltdb6fac52014-04-18 15:25:25 -07003583 */
paulhua9a6e2a2019-03-22 16:35:06 +08003584 public void onAvailable(@NonNull Network network) {}
Robert Greenwaltdb6fac52014-04-18 15:25:25 -07003585
3586 /**
Chalard Jean7f3a8742019-08-30 16:27:28 +09003587 * Called when the network is about to be lost, typically because there are no outstanding
3588 * requests left for it. This may be paired with a {@link NetworkCallback#onAvailable} call
3589 * with the new replacement network for graceful handover. This method is not guaranteed
3590 * to be called before {@link NetworkCallback#onLost} is called, for example in case a
3591 * network is suddenly disconnected.
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07003592 *
Chalard Jean7f3a8742019-08-30 16:27:28 +09003593 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
3594 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
3595 * this callback as this is prone to race conditions ; calling these methods while in a
3596 * callback may return an outdated or even a null object.
3597 *
3598 * @param network The {@link Network} that is about to be lost.
3599 * @param maxMsToLive The time in milliseconds the system intends to keep the network
3600 * connected for graceful handover; note that the network may still
3601 * suffer a hard loss at any time.
Robert Greenwaltdb6fac52014-04-18 15:25:25 -07003602 */
paulhua9a6e2a2019-03-22 16:35:06 +08003603 public void onLosing(@NonNull Network network, int maxMsToLive) {}
Robert Greenwaltdb6fac52014-04-18 15:25:25 -07003604
3605 /**
Chalard Jean7f3a8742019-08-30 16:27:28 +09003606 * Called when a network disconnects or otherwise no longer satisfies this request or
3607 * callback.
3608 *
3609 * <p>If the callback was registered with requestNetwork() or
3610 * registerDefaultNetworkCallback(), it will only be invoked against the last network
3611 * returned by onAvailable() when that network is lost and no other network satisfies
3612 * the criteria of the request.
3613 *
3614 * <p>If the callback was registered with registerNetworkCallback() it will be called for
3615 * each network which no longer satisfies the criteria of the callback.
3616 *
3617 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
3618 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
3619 * this callback as this is prone to race conditions ; calling these methods while in a
3620 * callback may return an outdated or even a null object.
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07003621 *
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07003622 * @param network The {@link Network} lost.
Robert Greenwaltdb6fac52014-04-18 15:25:25 -07003623 */
paulhua9a6e2a2019-03-22 16:35:06 +08003624 public void onLost(@NonNull Network network) {}
Robert Greenwaltdb6fac52014-04-18 15:25:25 -07003625
3626 /**
Chalard Jean7f3a8742019-08-30 16:27:28 +09003627 * Called if no network is found within the timeout time specified in
Etan Cohen06633de2019-01-08 12:09:18 -08003628 * {@link #requestNetwork(NetworkRequest, NetworkCallback, int)} call or if the
3629 * requested network request cannot be fulfilled (whether or not a timeout was
3630 * specified). When this callback is invoked the associated
Etan Cohen67e58a02017-03-01 12:47:28 -08003631 * {@link NetworkRequest} will have already been removed and released, as if
3632 * {@link #unregisterNetworkCallback(NetworkCallback)} had been called.
Robert Greenwaltdb6fac52014-04-18 15:25:25 -07003633 */
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07003634 public void onUnavailable() {}
Robert Greenwaltdb6fac52014-04-18 15:25:25 -07003635
3636 /**
Chalard Jean7f3a8742019-08-30 16:27:28 +09003637 * Called when the network corresponding to this request changes capabilities but still
3638 * satisfies the requested criteria.
3639 *
3640 * <p>Starting with {@link android.os.Build.VERSION_CODES#O} this method is guaranteed
3641 * to be called immediately after {@link #onAvailable}.
3642 *
3643 * <p>Do NOT call {@link #getLinkProperties(Network)} or other synchronous
3644 * ConnectivityManager methods in this callback as this is prone to race conditions :
3645 * calling these methods while in a callback may return an outdated or even a null object.
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07003646 *
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07003647 * @param network The {@link Network} whose capabilities have changed.
Roshan Pius7992afd2020-12-22 15:10:42 -08003648 * @param networkCapabilities The new {@link NetworkCapabilities} for this
Chalard Jeanb6a0c6d2018-01-30 22:41:41 +09003649 * network.
Robert Greenwaltdb6fac52014-04-18 15:25:25 -07003650 */
paulhua9a6e2a2019-03-22 16:35:06 +08003651 public void onCapabilitiesChanged(@NonNull Network network,
3652 @NonNull NetworkCapabilities networkCapabilities) {}
Robert Greenwaltdb6fac52014-04-18 15:25:25 -07003653
3654 /**
Chalard Jean7f3a8742019-08-30 16:27:28 +09003655 * Called when the network corresponding to this request changes {@link LinkProperties}.
3656 *
3657 * <p>Starting with {@link android.os.Build.VERSION_CODES#O} this method is guaranteed
3658 * to be called immediately after {@link #onAvailable}.
3659 *
3660 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or other synchronous
3661 * ConnectivityManager methods in this callback as this is prone to race conditions :
3662 * calling these methods while in a callback may return an outdated or even a null object.
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07003663 *
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07003664 * @param network The {@link Network} whose link properties have changed.
3665 * @param linkProperties The new {@link LinkProperties} for this network.
Robert Greenwaltdb6fac52014-04-18 15:25:25 -07003666 */
paulhua9a6e2a2019-03-22 16:35:06 +08003667 public void onLinkPropertiesChanged(@NonNull Network network,
3668 @NonNull LinkProperties linkProperties) {}
Robert Greenwaltdb6fac52014-04-18 15:25:25 -07003669
Robert Greenwalt41c19a02015-06-24 13:23:42 -07003670 /**
Chalard Jean7f3a8742019-08-30 16:27:28 +09003671 * Called when the network the framework connected to for this request suspends data
3672 * transmission temporarily.
3673 *
3674 * <p>This generally means that while the TCP connections are still live temporarily
3675 * network data fails to transfer. To give a specific example, this is used on cellular
3676 * networks to mask temporary outages when driving through a tunnel, etc. In general this
3677 * means read operations on sockets on this network will block once the buffers are
3678 * drained, and write operations will block once the buffers are full.
3679 *
3680 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
3681 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
3682 * this callback as this is prone to race conditions (there is no guarantee the objects
3683 * returned by these methods will be current).
3684 *
Robert Greenwalt41c19a02015-06-24 13:23:42 -07003685 * @hide
3686 */
paulhua9a6e2a2019-03-22 16:35:06 +08003687 public void onNetworkSuspended(@NonNull Network network) {}
Robert Greenwalt41c19a02015-06-24 13:23:42 -07003688
3689 /**
3690 * Called when the network the framework connected to for this request
Chalard Jeanb6a0c6d2018-01-30 22:41:41 +09003691 * returns from a {@link NetworkInfo.State#SUSPENDED} state. This should always be
3692 * preceded by a matching {@link NetworkCallback#onNetworkSuspended} call.
Chalard Jean7f3a8742019-08-30 16:27:28 +09003693
3694 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
3695 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
3696 * this callback as this is prone to race conditions : calling these methods while in a
3697 * callback may return an outdated or even a null object.
3698 *
Robert Greenwalt41c19a02015-06-24 13:23:42 -07003699 * @hide
3700 */
paulhua9a6e2a2019-03-22 16:35:06 +08003701 public void onNetworkResumed(@NonNull Network network) {}
Robert Greenwalt41c19a02015-06-24 13:23:42 -07003702
junyulai5ab727b2018-08-07 19:50:45 +08003703 /**
3704 * Called when access to the specified network is blocked or unblocked.
3705 *
Chalard Jean7f3a8742019-08-30 16:27:28 +09003706 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
3707 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
3708 * this callback as this is prone to race conditions : calling these methods while in a
3709 * callback may return an outdated or even a null object.
3710 *
junyulai5ab727b2018-08-07 19:50:45 +08003711 * @param network The {@link Network} whose blocked status has changed.
3712 * @param blocked The blocked status of this {@link Network}.
3713 */
junyulai61143782019-03-04 22:45:36 +08003714 public void onBlockedStatusChanged(@NonNull Network network, boolean blocked) {}
junyulai5ab727b2018-08-07 19:50:45 +08003715
Lorenzo Colitti60104f52021-03-18 00:54:57 +09003716 /**
Lorenzo Colittia37eaff2021-03-25 23:17:36 +09003717 * Called when access to the specified network is blocked or unblocked, or the reason for
3718 * access being blocked changes.
Lorenzo Colitti60104f52021-03-18 00:54:57 +09003719 *
3720 * If a NetworkCallback object implements this method,
3721 * {@link #onBlockedStatusChanged(Network, boolean)} will not be called.
3722 *
3723 * <p>Do NOT call {@link #getNetworkCapabilities(Network)} or
3724 * {@link #getLinkProperties(Network)} or other synchronous ConnectivityManager methods in
3725 * this callback as this is prone to race conditions : calling these methods while in a
3726 * callback may return an outdated or even a null object.
3727 *
3728 * @param network The {@link Network} whose blocked status has changed.
3729 * @param blocked The blocked status of this {@link Network}.
3730 * @hide
3731 */
3732 @SystemApi(client = MODULE_LIBRARIES)
3733 public void onBlockedStatusChanged(@NonNull Network network, @BlockedReason int blocked) {
3734 onBlockedStatusChanged(network, blocked != 0);
3735 }
3736
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07003737 private NetworkRequest networkRequest;
Roshan Pius7992afd2020-12-22 15:10:42 -08003738 private final int mFlags;
Robert Greenwaltdb6fac52014-04-18 15:25:25 -07003739 }
3740
Hugo Benichi145e3792017-05-11 13:16:17 +09003741 /**
3742 * Constant error codes used by ConnectivityService to communicate about failures and errors
3743 * across a Binder boundary.
3744 * @hide
3745 */
3746 public interface Errors {
Chalard Jean73d9db72018-06-04 16:52:49 +09003747 int TOO_MANY_REQUESTS = 1;
Hugo Benichi145e3792017-05-11 13:16:17 +09003748 }
3749
3750 /** @hide */
3751 public static class TooManyRequestsException extends RuntimeException {}
3752
3753 private static RuntimeException convertServiceException(ServiceSpecificException e) {
3754 switch (e.errorCode) {
3755 case Errors.TOO_MANY_REQUESTS:
3756 return new TooManyRequestsException();
3757 default:
3758 Log.w(TAG, "Unknown service error code " + e.errorCode);
3759 return new RuntimeException(e);
3760 }
3761 }
3762
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003763 /** @hide */
Remi NGUYEN VANa711b3f2021-03-12 15:24:06 +09003764 public static final int CALLBACK_PRECHECK = 1;
Robert Greenwalt41c19a02015-06-24 13:23:42 -07003765 /** @hide */
Remi NGUYEN VANa711b3f2021-03-12 15:24:06 +09003766 public static final int CALLBACK_AVAILABLE = 2;
Robert Greenwalt41c19a02015-06-24 13:23:42 -07003767 /** @hide arg1 = TTL */
Remi NGUYEN VANa711b3f2021-03-12 15:24:06 +09003768 public static final int CALLBACK_LOSING = 3;
Robert Greenwalt41c19a02015-06-24 13:23:42 -07003769 /** @hide */
Remi NGUYEN VANa711b3f2021-03-12 15:24:06 +09003770 public static final int CALLBACK_LOST = 4;
Robert Greenwalt41c19a02015-06-24 13:23:42 -07003771 /** @hide */
Remi NGUYEN VANa711b3f2021-03-12 15:24:06 +09003772 public static final int CALLBACK_UNAVAIL = 5;
Robert Greenwalt41c19a02015-06-24 13:23:42 -07003773 /** @hide */
Remi NGUYEN VANa711b3f2021-03-12 15:24:06 +09003774 public static final int CALLBACK_CAP_CHANGED = 6;
Robert Greenwalt41c19a02015-06-24 13:23:42 -07003775 /** @hide */
Remi NGUYEN VANa711b3f2021-03-12 15:24:06 +09003776 public static final int CALLBACK_IP_CHANGED = 7;
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07003777 /** @hide obj = NetworkCapabilities, arg1 = seq number */
Remi NGUYEN VANa711b3f2021-03-12 15:24:06 +09003778 private static final int EXPIRE_LEGACY_REQUEST = 8;
Robert Greenwalt41c19a02015-06-24 13:23:42 -07003779 /** @hide */
Remi NGUYEN VANa711b3f2021-03-12 15:24:06 +09003780 public static final int CALLBACK_SUSPENDED = 9;
Robert Greenwalt41c19a02015-06-24 13:23:42 -07003781 /** @hide */
Remi NGUYEN VANa711b3f2021-03-12 15:24:06 +09003782 public static final int CALLBACK_RESUMED = 10;
junyulai5ab727b2018-08-07 19:50:45 +08003783 /** @hide */
Remi NGUYEN VANa711b3f2021-03-12 15:24:06 +09003784 public static final int CALLBACK_BLK_CHANGED = 11;
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003785
Erik Kline66721822015-11-25 12:49:38 +09003786 /** @hide */
3787 public static String getCallbackName(int whichCallback) {
3788 switch (whichCallback) {
3789 case CALLBACK_PRECHECK: return "CALLBACK_PRECHECK";
3790 case CALLBACK_AVAILABLE: return "CALLBACK_AVAILABLE";
3791 case CALLBACK_LOSING: return "CALLBACK_LOSING";
3792 case CALLBACK_LOST: return "CALLBACK_LOST";
3793 case CALLBACK_UNAVAIL: return "CALLBACK_UNAVAIL";
3794 case CALLBACK_CAP_CHANGED: return "CALLBACK_CAP_CHANGED";
3795 case CALLBACK_IP_CHANGED: return "CALLBACK_IP_CHANGED";
Erik Kline66721822015-11-25 12:49:38 +09003796 case EXPIRE_LEGACY_REQUEST: return "EXPIRE_LEGACY_REQUEST";
3797 case CALLBACK_SUSPENDED: return "CALLBACK_SUSPENDED";
3798 case CALLBACK_RESUMED: return "CALLBACK_RESUMED";
junyulai5ab727b2018-08-07 19:50:45 +08003799 case CALLBACK_BLK_CHANGED: return "CALLBACK_BLK_CHANGED";
Erik Kline66721822015-11-25 12:49:38 +09003800 default:
3801 return Integer.toString(whichCallback);
3802 }
3803 }
3804
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07003805 private class CallbackHandler extends Handler {
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003806 private static final String TAG = "ConnectivityManager.CallbackHandler";
Robert Greenwalt9b330772015-09-03 16:41:45 -07003807 private static final boolean DBG = false;
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003808
Hugo Benichife3325f2016-07-06 22:53:17 +09003809 CallbackHandler(Looper looper) {
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003810 super(looper);
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003811 }
3812
Hugo Benichicd5a0e02017-02-02 17:02:36 +09003813 CallbackHandler(Handler handler) {
Remi NGUYEN VANc4dd8c92021-03-15 07:31:54 +00003814 this(Objects.requireNonNull(handler, "Handler cannot be null.").getLooper());
Hugo Benichicd5a0e02017-02-02 17:02:36 +09003815 }
3816
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003817 @Override
3818 public void handleMessage(Message message) {
Hugo Benichi3b926992017-05-09 14:36:02 +09003819 if (message.what == EXPIRE_LEGACY_REQUEST) {
3820 expireRequest((NetworkCapabilities) message.obj, message.arg1);
3821 return;
3822 }
3823
3824 final NetworkRequest request = getObject(message, NetworkRequest.class);
3825 final Network network = getObject(message, Network.class);
3826 final NetworkCallback callback;
3827 synchronized (sCallbacks) {
3828 callback = sCallbacks.get(request);
Etan Cohenbc3a4eb2019-05-21 12:06:04 -07003829 if (callback == null) {
3830 Log.w(TAG,
3831 "callback not found for " + getCallbackName(message.what) + " message");
3832 return;
3833 }
Etan Cohene0e2ca92019-04-16 15:07:55 -07003834 if (message.what == CALLBACK_UNAVAIL) {
3835 sCallbacks.remove(request);
3836 callback.networkRequest = ALREADY_UNREGISTERED;
3837 }
Hugo Benichi3b926992017-05-09 14:36:02 +09003838 }
Lorenzo Colitti7e286832016-03-01 22:56:37 +09003839 if (DBG) {
Hugo Benichi94f0bfc2017-03-22 17:07:57 +09003840 Log.d(TAG, getCallbackName(message.what) + " for network " + network);
Lorenzo Colitti7e286832016-03-01 22:56:37 +09003841 }
Hugo Benichi3b926992017-05-09 14:36:02 +09003842
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003843 switch (message.what) {
3844 case CALLBACK_PRECHECK: {
Hugo Benichi3b926992017-05-09 14:36:02 +09003845 callback.onPreCheck(network);
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003846 break;
3847 }
3848 case CALLBACK_AVAILABLE: {
Chalard Jeanb6a0c6d2018-01-30 22:41:41 +09003849 NetworkCapabilities cap = getObject(message, NetworkCapabilities.class);
3850 LinkProperties lp = getObject(message, LinkProperties.class);
Lorenzo Colitti60104f52021-03-18 00:54:57 +09003851 callback.onAvailable(network, cap, lp, message.arg1);
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003852 break;
3853 }
3854 case CALLBACK_LOSING: {
Hugo Benichi3b926992017-05-09 14:36:02 +09003855 callback.onLosing(network, message.arg1);
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003856 break;
3857 }
3858 case CALLBACK_LOST: {
Hugo Benichi3b926992017-05-09 14:36:02 +09003859 callback.onLost(network);
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003860 break;
3861 }
3862 case CALLBACK_UNAVAIL: {
Hugo Benichi3b926992017-05-09 14:36:02 +09003863 callback.onUnavailable();
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003864 break;
3865 }
3866 case CALLBACK_CAP_CHANGED: {
Hugo Benichi3b926992017-05-09 14:36:02 +09003867 NetworkCapabilities cap = getObject(message, NetworkCapabilities.class);
3868 callback.onCapabilitiesChanged(network, cap);
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003869 break;
3870 }
3871 case CALLBACK_IP_CHANGED: {
Hugo Benichi3b926992017-05-09 14:36:02 +09003872 LinkProperties lp = getObject(message, LinkProperties.class);
3873 callback.onLinkPropertiesChanged(network, lp);
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003874 break;
3875 }
Robert Greenwalt41c19a02015-06-24 13:23:42 -07003876 case CALLBACK_SUSPENDED: {
Hugo Benichi3b926992017-05-09 14:36:02 +09003877 callback.onNetworkSuspended(network);
Robert Greenwalt41c19a02015-06-24 13:23:42 -07003878 break;
3879 }
3880 case CALLBACK_RESUMED: {
Hugo Benichi3b926992017-05-09 14:36:02 +09003881 callback.onNetworkResumed(network);
Robert Greenwaltb59a91b2014-05-15 18:07:26 -07003882 break;
3883 }
junyulai5ab727b2018-08-07 19:50:45 +08003884 case CALLBACK_BLK_CHANGED: {
Lorenzo Colitti60104f52021-03-18 00:54:57 +09003885 callback.onBlockedStatusChanged(network, message.arg1);
junyulai5ab727b2018-08-07 19:50:45 +08003886 }
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003887 }
3888 }
3889
Hugo Benichife3325f2016-07-06 22:53:17 +09003890 private <T> T getObject(Message msg, Class<T> c) {
3891 return (T) msg.getData().getParcelable(c.getSimpleName());
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003892 }
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003893 }
3894
Hugo Benichicd5a0e02017-02-02 17:02:36 +09003895 private CallbackHandler getDefaultHandler() {
Hugo Benichi3a545552016-07-07 10:15:56 +09003896 synchronized (sCallbacks) {
3897 if (sCallbackHandler == null) {
3898 sCallbackHandler = new CallbackHandler(ConnectivityThread.getInstanceLooper());
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003899 }
Hugo Benichi3a545552016-07-07 10:15:56 +09003900 return sCallbackHandler;
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003901 }
3902 }
3903
Hugo Benichiec180d52017-02-03 14:18:44 +09003904 private static final HashMap<NetworkRequest, NetworkCallback> sCallbacks = new HashMap<>();
3905 private static CallbackHandler sCallbackHandler;
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003906
Lorenzo Colittib199b962021-03-12 22:48:07 +09003907 private NetworkRequest sendRequestForNetwork(int asUid, NetworkCapabilities need,
3908 NetworkCallback callback, int timeoutMs, NetworkRequest.Type reqType, int legacyType,
3909 CallbackHandler handler) {
Soi, Yoshinari99efcbd2015-11-12 12:09:02 +09003910 printStackTrace();
Hugo Benichiff4bf602017-05-09 15:19:01 +09003911 checkCallbackNotNull(callback);
Remi NGUYEN VANc4dd8c92021-03-15 07:31:54 +00003912 if (reqType != TRACK_DEFAULT && reqType != TRACK_SYSTEM_DEFAULT && need == null) {
3913 throw new IllegalArgumentException("null NetworkCapabilities");
3914 }
Hugo Benichife3325f2016-07-06 22:53:17 +09003915 final NetworkRequest request;
Roshan Piusd26ae412020-01-16 12:17:17 -08003916 final String callingPackageName = mContext.getOpPackageName();
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003917 try {
Hugo Benichife3325f2016-07-06 22:53:17 +09003918 synchronized(sCallbacks) {
Hugo Benichi1c027fe2017-06-17 13:14:12 +09003919 if (callback.networkRequest != null
3920 && callback.networkRequest != ALREADY_UNREGISTERED) {
Hugo Benichi45a49542017-03-06 09:17:06 +09003921 // TODO: throw exception instead and enforce 1:1 mapping of callbacks
3922 // and requests (http://b/20701525).
3923 Log.e(TAG, "NetworkCallback was already registered");
3924 }
Hugo Benichi3a545552016-07-07 10:15:56 +09003925 Messenger messenger = new Messenger(handler);
Hugo Benichife3325f2016-07-06 22:53:17 +09003926 Binder binder = new Binder();
Roshan Pius7992afd2020-12-22 15:10:42 -08003927 final int callbackFlags = callback.mFlags;
junyulaid1a78162021-01-11 16:53:38 +08003928 if (reqType == LISTEN) {
Roshan Piusd26ae412020-01-16 12:17:17 -08003929 request = mService.listenForNetwork(
Roshan Pius7992afd2020-12-22 15:10:42 -08003930 need, messenger, binder, callbackFlags, callingPackageName,
Roshan Piusc97d8062020-12-17 14:53:09 -08003931 getAttributionTag());
Paul Jensenf980a0f2014-06-27 11:05:32 -04003932 } else {
Hugo Benichife3325f2016-07-06 22:53:17 +09003933 request = mService.requestNetwork(
Lorenzo Colittib199b962021-03-12 22:48:07 +09003934 asUid, need, reqType.ordinal(), messenger, timeoutMs, binder,
3935 legacyType, callbackFlags, callingPackageName, getAttributionTag());
Paul Jensenf980a0f2014-06-27 11:05:32 -04003936 }
Hugo Benichife3325f2016-07-06 22:53:17 +09003937 if (request != null) {
Hugo Benichi3a545552016-07-07 10:15:56 +09003938 sCallbacks.put(request, callback);
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003939 }
Hugo Benichi3a545552016-07-07 10:15:56 +09003940 callback.networkRequest = request;
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003941 }
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07003942 } catch (RemoteException e) {
3943 throw e.rethrowFromSystemServer();
Hugo Benichi145e3792017-05-11 13:16:17 +09003944 } catch (ServiceSpecificException e) {
3945 throw convertServiceException(e);
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07003946 }
Hugo Benichife3325f2016-07-06 22:53:17 +09003947 return request;
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003948 }
3949
Lorenzo Colittib199b962021-03-12 22:48:07 +09003950 private NetworkRequest sendRequestForNetwork(NetworkCapabilities need, NetworkCallback callback,
3951 int timeoutMs, NetworkRequest.Type reqType, int legacyType, CallbackHandler handler) {
3952 return sendRequestForNetwork(Process.INVALID_UID, need, callback, timeoutMs, reqType,
3953 legacyType, handler);
3954 }
3955
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003956 /**
Erik Klinee0aed632016-03-16 15:31:39 +09003957 * Helper function to request a network with a particular legacy type.
Lorenzo Colitti873f7bb2015-11-25 12:00:52 +09003958 *
markchien0fe11402020-03-18 21:16:15 +08003959 * This API is only for use in internal system code that requests networks with legacy type and
3960 * relies on CONNECTIVITY_ACTION broadcasts instead of NetworkCallbacks. New caller should use
markchien769c5752020-01-14 12:54:40 +08003961 * {@link #requestNetwork(NetworkRequest, NetworkCallback, Handler)} instead.
Lorenzo Colitti873f7bb2015-11-25 12:00:52 +09003962 *
markchien769c5752020-01-14 12:54:40 +08003963 * @param request {@link NetworkRequest} describing this request.
markchien769c5752020-01-14 12:54:40 +08003964 * @param timeoutMs The time in milliseconds to attempt looking for a suitable network
3965 * before {@link NetworkCallback#onUnavailable()} is called. The timeout must
3966 * be a positive value (i.e. >0).
3967 * @param legacyType to specify the network type(#TYPE_*).
3968 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
markchien0fe11402020-03-18 21:16:15 +08003969 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
3970 * the callback must not be shared - it uniquely specifies this request.
Lorenzo Colitti873f7bb2015-11-25 12:00:52 +09003971 *
3972 * @hide
3973 */
markchien769c5752020-01-14 12:54:40 +08003974 @SystemApi
markchien0fe11402020-03-18 21:16:15 +08003975 @RequiresPermission(NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK)
Chalard Jean42a9c292019-01-07 19:26:34 +09003976 public void requestNetwork(@NonNull NetworkRequest request,
markchien0fe11402020-03-18 21:16:15 +08003977 int timeoutMs, int legacyType, @NonNull Handler handler,
3978 @NonNull NetworkCallback networkCallback) {
3979 if (legacyType == TYPE_NONE) {
3980 throw new IllegalArgumentException("TYPE_NONE is meaningless legacy type");
3981 }
Hugo Benichicd5a0e02017-02-02 17:02:36 +09003982 CallbackHandler cbHandler = new CallbackHandler(handler);
3983 NetworkCapabilities nc = request.networkCapabilities;
3984 sendRequestForNetwork(nc, networkCallback, timeoutMs, REQUEST, legacyType, cbHandler);
Lorenzo Colitti873f7bb2015-11-25 12:00:52 +09003985 }
3986
3987 /**
Roshan Pius7992afd2020-12-22 15:10:42 -08003988 * Request a network to satisfy a set of {@link NetworkCapabilities}.
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07003989 *
Chalard Jean7f3a8742019-08-30 16:27:28 +09003990 * <p>This method will attempt to find the best network that matches the passed
3991 * {@link NetworkRequest}, and to bring up one that does if none currently satisfies the
3992 * criteria. The platform will evaluate which network is the best at its own discretion.
3993 * Throughput, latency, cost per byte, policy, user preference and other considerations
3994 * may be factored in the decision of what is considered the best network.
3995 *
3996 * <p>As long as this request is outstanding, the platform will try to maintain the best network
3997 * matching this request, while always attempting to match the request to a better network if
3998 * possible. If a better match is found, the platform will switch this request to the now-best
3999 * network and inform the app of the newly best network by invoking
4000 * {@link NetworkCallback#onAvailable(Network)} on the provided callback. Note that the platform
4001 * will not try to maintain any other network than the best one currently matching the request:
4002 * a network not matching any network request may be disconnected at any time.
4003 *
4004 * <p>For example, an application could use this method to obtain a connected cellular network
4005 * even if the device currently has a data connection over Ethernet. This may cause the cellular
4006 * radio to consume additional power. Or, an application could inform the system that it wants
4007 * a network supporting sending MMSes and have the system let it know about the currently best
4008 * MMS-supporting network through the provided {@link NetworkCallback}.
4009 *
4010 * <p>The status of the request can be followed by listening to the various callbacks described
4011 * in {@link NetworkCallback}. The {@link Network} object passed to the callback methods can be
4012 * used to direct traffic to the network (although accessing some networks may be subject to
4013 * holding specific permissions). Callers will learn about the specific characteristics of the
4014 * network through
4015 * {@link NetworkCallback#onCapabilitiesChanged(Network, NetworkCapabilities)} and
4016 * {@link NetworkCallback#onLinkPropertiesChanged(Network, LinkProperties)}. The methods of the
4017 * provided {@link NetworkCallback} will only be invoked due to changes in the best network
4018 * matching the request at any given time; therefore when a better network matching the request
4019 * becomes available, the {@link NetworkCallback#onAvailable(Network)} method is called
4020 * with the new network after which no further updates are given about the previously-best
4021 * network, unless it becomes the best again at some later time. All callbacks are invoked
4022 * in order on the same thread, which by default is a thread created by the framework running
4023 * in the app.
4024 * {@see #requestNetwork(NetworkRequest, NetworkCallback, Handler)} to change where the
4025 * callbacks are invoked.
4026 *
4027 * <p>This{@link NetworkRequest} will live until released via
4028 * {@link #unregisterNetworkCallback(NetworkCallback)} or the calling application exits, at
4029 * which point the system may let go of the network at any time.
4030 *
4031 * <p>A version of this method which takes a timeout is
4032 * {@link #requestNetwork(NetworkRequest, NetworkCallback, int)}, that an app can use to only
4033 * wait for a limited amount of time for the network to become unavailable.
4034 *
Paul Jensen1fcbf9c2015-06-16 15:11:58 -04004035 * <p>It is presently unsupported to request a network with mutable
4036 * {@link NetworkCapabilities} such as
4037 * {@link NetworkCapabilities#NET_CAPABILITY_VALIDATED} or
4038 * {@link NetworkCapabilities#NET_CAPABILITY_CAPTIVE_PORTAL}
4039 * as these {@code NetworkCapabilities} represent states that a particular
4040 * network may never attain, and whether a network will attain these states
4041 * is unknown prior to bringing up the network so the framework does not
Chalard Jean7f3a8742019-08-30 16:27:28 +09004042 * know how to go about satisfying a request with these capabilities.
Lorenzo Colitti91de63b2015-10-15 16:29:00 +09004043 *
4044 * <p>This method requires the caller to hold either the
4045 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
4046 * or the ability to modify system settings as determined by
4047 * {@link android.provider.Settings.System#canWrite}.</p>
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07004048 *
Chalard Jean7f06b342020-05-20 16:11:50 +09004049 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4050 * number of outstanding requests to 100 per app (identified by their UID), shared with
4051 * all variants of this method, of {@link #registerNetworkCallback} as well as
4052 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4053 * Requesting a network with this method will count toward this limit. If this limit is
4054 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4055 * make sure to unregister the callbacks with
4056 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4057 *
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07004058 * @param request {@link NetworkRequest} describing this request.
Hugo Benichicd5a0e02017-02-02 17:02:36 +09004059 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
4060 * the callback must not be shared - it uniquely specifies this request.
4061 * The callback is invoked on the default internal Handler.
Chalard Jean9f1a7632019-05-13 15:13:58 +09004062 * @throws IllegalArgumentException if {@code request} contains invalid network capabilities.
4063 * @throws SecurityException if missing the appropriate permissions.
Chalard Jean7f06b342020-05-20 16:11:50 +09004064 * @throws RuntimeException if the app already has too many callbacks registered.
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07004065 */
Chalard Jean42a9c292019-01-07 19:26:34 +09004066 public void requestNetwork(@NonNull NetworkRequest request,
4067 @NonNull NetworkCallback networkCallback) {
Hugo Benichicd5a0e02017-02-02 17:02:36 +09004068 requestNetwork(request, networkCallback, getDefaultHandler());
4069 }
4070
4071 /**
Roshan Pius7992afd2020-12-22 15:10:42 -08004072 * Request a network to satisfy a set of {@link NetworkCapabilities}.
Hugo Benichicd5a0e02017-02-02 17:02:36 +09004073 *
Chalard Jean7f3a8742019-08-30 16:27:28 +09004074 * This method behaves identically to {@link #requestNetwork(NetworkRequest, NetworkCallback)}
4075 * but runs all the callbacks on the passed Handler.
Hugo Benichicd5a0e02017-02-02 17:02:36 +09004076 *
Chalard Jean7f3a8742019-08-30 16:27:28 +09004077 * <p>This method has the same permission requirements as
Chalard Jean7f06b342020-05-20 16:11:50 +09004078 * {@link #requestNetwork(NetworkRequest, NetworkCallback)}, is subject to the same limitations,
4079 * and throws the same exceptions in the same conditions.
Hugo Benichicd5a0e02017-02-02 17:02:36 +09004080 *
4081 * @param request {@link NetworkRequest} describing this request.
4082 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
4083 * the callback must not be shared - it uniquely specifies this request.
4084 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
Hugo Benichicd5a0e02017-02-02 17:02:36 +09004085 */
Chalard Jean42a9c292019-01-07 19:26:34 +09004086 public void requestNetwork(@NonNull NetworkRequest request,
4087 @NonNull NetworkCallback networkCallback, @NonNull Handler handler) {
Hugo Benichicd5a0e02017-02-02 17:02:36 +09004088 CallbackHandler cbHandler = new CallbackHandler(handler);
markchien0fe11402020-03-18 21:16:15 +08004089 NetworkCapabilities nc = request.networkCapabilities;
4090 sendRequestForNetwork(nc, networkCallback, 0, REQUEST, TYPE_NONE, cbHandler);
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07004091 }
4092
4093 /**
Roshan Pius7992afd2020-12-22 15:10:42 -08004094 * Request a network to satisfy a set of {@link NetworkCapabilities}, limited
Etan Cohen67e58a02017-03-01 12:47:28 -08004095 * by a timeout.
4096 *
4097 * This function behaves identically to the non-timed-out version
4098 * {@link #requestNetwork(NetworkRequest, NetworkCallback)}, but if a suitable network
4099 * is not found within the given time (in milliseconds) the
4100 * {@link NetworkCallback#onUnavailable()} callback is called. The request can still be
4101 * released normally by calling {@link #unregisterNetworkCallback(NetworkCallback)} but does
4102 * not have to be released if timed-out (it is automatically released). Unregistering a
4103 * request that timed out is not an error.
4104 *
4105 * <p>Do not use this method to poll for the existence of specific networks (e.g. with a small
4106 * timeout) - {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)} is provided
4107 * for that purpose. Calling this method will attempt to bring up the requested network.
4108 *
Chalard Jean7f3a8742019-08-30 16:27:28 +09004109 * <p>This method has the same permission requirements as
Chalard Jean7f06b342020-05-20 16:11:50 +09004110 * {@link #requestNetwork(NetworkRequest, NetworkCallback)}, is subject to the same limitations,
4111 * and throws the same exceptions in the same conditions.
Etan Cohen67e58a02017-03-01 12:47:28 -08004112 *
4113 * @param request {@link NetworkRequest} describing this request.
Lorenzo Colitti38ea8102017-04-28 00:56:30 +09004114 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
4115 * the callback must not be shared - it uniquely specifies this request.
Etan Cohen67e58a02017-03-01 12:47:28 -08004116 * @param timeoutMs The time in milliseconds to attempt looking for a suitable network
4117 * before {@link NetworkCallback#onUnavailable()} is called. The timeout must
4118 * be a positive value (i.e. >0).
Etan Cohen67e58a02017-03-01 12:47:28 -08004119 */
Chalard Jean42a9c292019-01-07 19:26:34 +09004120 public void requestNetwork(@NonNull NetworkRequest request,
4121 @NonNull NetworkCallback networkCallback, int timeoutMs) {
Hugo Benichiff4bf602017-05-09 15:19:01 +09004122 checkTimeout(timeoutMs);
markchien0fe11402020-03-18 21:16:15 +08004123 NetworkCapabilities nc = request.networkCapabilities;
4124 sendRequestForNetwork(nc, networkCallback, timeoutMs, REQUEST, TYPE_NONE,
4125 getDefaultHandler());
Hugo Benichicd5a0e02017-02-02 17:02:36 +09004126 }
4127
Hugo Benichicd5a0e02017-02-02 17:02:36 +09004128 /**
Roshan Pius7992afd2020-12-22 15:10:42 -08004129 * Request a network to satisfy a set of {@link NetworkCapabilities}, limited
Hugo Benichicd5a0e02017-02-02 17:02:36 +09004130 * by a timeout.
4131 *
Chalard Jean7f3a8742019-08-30 16:27:28 +09004132 * This method behaves identically to
4133 * {@link #requestNetwork(NetworkRequest, NetworkCallback, int)} but runs all the callbacks
4134 * on the passed Handler.
Etan Cohen67e58a02017-03-01 12:47:28 -08004135 *
Chalard Jean7f3a8742019-08-30 16:27:28 +09004136 * <p>This method has the same permission requirements as
Chalard Jean7f06b342020-05-20 16:11:50 +09004137 * {@link #requestNetwork(NetworkRequest, NetworkCallback)}, is subject to the same limitations,
4138 * and throws the same exceptions in the same conditions.
Hugo Benichicd5a0e02017-02-02 17:02:36 +09004139 *
4140 * @param request {@link NetworkRequest} describing this request.
Etan Cohen67e58a02017-03-01 12:47:28 -08004141 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
4142 * the callback must not be shared - it uniquely specifies this request.
Hugo Benichicd5a0e02017-02-02 17:02:36 +09004143 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
Lorenzo Colitti38ea8102017-04-28 00:56:30 +09004144 * @param timeoutMs The time in milliseconds to attempt looking for a suitable network
4145 * before {@link NetworkCallback#onUnavailable} is called.
Hugo Benichicd5a0e02017-02-02 17:02:36 +09004146 */
Chalard Jean42a9c292019-01-07 19:26:34 +09004147 public void requestNetwork(@NonNull NetworkRequest request,
4148 @NonNull NetworkCallback networkCallback, @NonNull Handler handler, int timeoutMs) {
Hugo Benichiff4bf602017-05-09 15:19:01 +09004149 checkTimeout(timeoutMs);
Hugo Benichicd5a0e02017-02-02 17:02:36 +09004150 CallbackHandler cbHandler = new CallbackHandler(handler);
markchien0fe11402020-03-18 21:16:15 +08004151 NetworkCapabilities nc = request.networkCapabilities;
4152 sendRequestForNetwork(nc, networkCallback, timeoutMs, REQUEST, TYPE_NONE, cbHandler);
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07004153 }
4154
4155 /**
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07004156 * The lookup key for a {@link Network} object included with the intent after
Jeremy Joslin94c30992014-11-05 10:32:09 -08004157 * successfully finding a network for the applications request. Retrieve it with
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07004158 * {@link android.content.Intent#getParcelableExtra(String)}.
Jeremy Joslinfe76e0e2015-02-11 16:51:13 -08004159 * <p>
Paul Jensen895c3942015-03-10 10:54:12 -04004160 * Note that if you intend to invoke {@link Network#openConnection(java.net.URL)}
4161 * then you must get a ConnectivityManager instance before doing so.
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07004162 */
Erik Klinefb087f12014-11-19 12:12:24 +09004163 public static final String EXTRA_NETWORK = "android.net.extra.NETWORK";
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07004164
4165 /**
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07004166 * The lookup key for a {@link NetworkRequest} object included with the intent after
Jeremy Joslin94c30992014-11-05 10:32:09 -08004167 * successfully finding a network for the applications request. Retrieve it with
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07004168 * {@link android.content.Intent#getParcelableExtra(String)}.
4169 */
Erik Klinefb087f12014-11-19 12:12:24 +09004170 public static final String EXTRA_NETWORK_REQUEST = "android.net.extra.NETWORK_REQUEST";
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07004171
4172
4173 /**
Roshan Pius7992afd2020-12-22 15:10:42 -08004174 * Request a network to satisfy a set of {@link NetworkCapabilities}.
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07004175 *
Jeremy Joslin94c30992014-11-05 10:32:09 -08004176 * This function behaves identically to the version that takes a NetworkCallback, but instead
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07004177 * of {@link NetworkCallback} a {@link PendingIntent} is used. This means
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07004178 * the request may outlive the calling application and get called back when a suitable
4179 * network is found.
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07004180 * <p>
4181 * The operation is an Intent broadcast that goes to a broadcast receiver that
4182 * you registered with {@link Context#registerReceiver} or through the
4183 * &lt;receiver&gt; tag in an AndroidManifest.xml file
4184 * <p>
4185 * The operation Intent is delivered with two extras, a {@link Network} typed
Erik Klinefb087f12014-11-19 12:12:24 +09004186 * extra called {@link #EXTRA_NETWORK} and a {@link NetworkRequest}
4187 * typed extra called {@link #EXTRA_NETWORK_REQUEST} containing
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07004188 * the original requests parameters. It is important to create a new,
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07004189 * {@link NetworkCallback} based request before completing the processing of the
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07004190 * Intent to reserve the network or it will be released shortly after the Intent
4191 * is processed.
4192 * <p>
Paul Jensen9ceed862015-06-17 14:15:39 -04004193 * If there is already a request for this Intent registered (with the equality of
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07004194 * two Intents defined by {@link Intent#filterEquals}), then it will be removed and
Robert Greenwaltd0ebdbb2014-05-18 23:07:25 -07004195 * replaced by this one, effectively releasing the previous {@link NetworkRequest}.
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07004196 * <p>
Jeremy Joslin94c30992014-11-05 10:32:09 -08004197 * The request may be released normally by calling
4198 * {@link #releaseNetworkRequest(android.app.PendingIntent)}.
Paul Jensen1fcbf9c2015-06-16 15:11:58 -04004199 * <p>It is presently unsupported to request a network with either
4200 * {@link NetworkCapabilities#NET_CAPABILITY_VALIDATED} or
4201 * {@link NetworkCapabilities#NET_CAPABILITY_CAPTIVE_PORTAL}
4202 * as these {@code NetworkCapabilities} represent states that a particular
4203 * network may never attain, and whether a network will attain these states
4204 * is unknown prior to bringing up the network so the framework does not
Chalard Jean73d9db72018-06-04 16:52:49 +09004205 * know how to go about satisfying a request with these capabilities.
Lorenzo Colitti91de63b2015-10-15 16:29:00 +09004206 *
Chalard Jean7f06b342020-05-20 16:11:50 +09004207 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4208 * number of outstanding requests to 100 per app (identified by their UID), shared with
4209 * all variants of this method, of {@link #registerNetworkCallback} as well as
4210 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4211 * Requesting a network with this method will count toward this limit. If this limit is
4212 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4213 * make sure to unregister the callbacks with {@link #unregisterNetworkCallback(PendingIntent)}
4214 * or {@link #releaseNetworkRequest(PendingIntent)}.
4215 *
Lorenzo Colitti91de63b2015-10-15 16:29:00 +09004216 * <p>This method requires the caller to hold either the
4217 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
4218 * or the ability to modify system settings as determined by
4219 * {@link android.provider.Settings.System#canWrite}.</p>
4220 *
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07004221 * @param request {@link NetworkRequest} describing this request.
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07004222 * @param operation Action to perform when the network is available (corresponds
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07004223 * to the {@link NetworkCallback#onAvailable} call. Typically
Jeremy Joslin94c30992014-11-05 10:32:09 -08004224 * comes from {@link PendingIntent#getBroadcast}. Cannot be null.
Chalard Jean9f1a7632019-05-13 15:13:58 +09004225 * @throws IllegalArgumentException if {@code request} contains invalid network capabilities.
4226 * @throws SecurityException if missing the appropriate permissions.
Chalard Jean7f06b342020-05-20 16:11:50 +09004227 * @throws RuntimeException if the app already has too many callbacks registered.
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07004228 */
Chalard Jean42a9c292019-01-07 19:26:34 +09004229 public void requestNetwork(@NonNull NetworkRequest request,
4230 @NonNull PendingIntent operation) {
Soi, Yoshinari99efcbd2015-11-12 12:09:02 +09004231 printStackTrace();
Hugo Benichiff4bf602017-05-09 15:19:01 +09004232 checkPendingIntentNotNull(operation);
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07004233 try {
Roshan Piusd26ae412020-01-16 12:17:17 -08004234 mService.pendingRequestForNetwork(
Philip P. Moltmannddbcf5b2020-03-24 15:57:49 -07004235 request.networkCapabilities, operation, mContext.getOpPackageName(),
4236 getAttributionTag());
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07004237 } catch (RemoteException e) {
4238 throw e.rethrowFromSystemServer();
Hugo Benichi145e3792017-05-11 13:16:17 +09004239 } catch (ServiceSpecificException e) {
4240 throw convertServiceException(e);
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07004241 }
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07004242 }
4243
4244 /**
Jeremy Joslin94c30992014-11-05 10:32:09 -08004245 * Removes a request made via {@link #requestNetwork(NetworkRequest, android.app.PendingIntent)}
4246 * <p>
Lorenzo Colittiad458ad2016-04-13 22:00:02 +09004247 * This method has the same behavior as
4248 * {@link #unregisterNetworkCallback(android.app.PendingIntent)} with respect to
Jeremy Joslin94c30992014-11-05 10:32:09 -08004249 * releasing network resources and disconnecting.
4250 *
4251 * @param operation A PendingIntent equal (as defined by {@link Intent#filterEquals}) to the
4252 * PendingIntent passed to
4253 * {@link #requestNetwork(NetworkRequest, android.app.PendingIntent)} with the
4254 * corresponding NetworkRequest you'd like to remove. Cannot be null.
4255 */
Chalard Jean42a9c292019-01-07 19:26:34 +09004256 public void releaseNetworkRequest(@NonNull PendingIntent operation) {
Soi, Yoshinari99efcbd2015-11-12 12:09:02 +09004257 printStackTrace();
Hugo Benichiff4bf602017-05-09 15:19:01 +09004258 checkPendingIntentNotNull(operation);
Jeremy Joslin94c30992014-11-05 10:32:09 -08004259 try {
4260 mService.releasePendingNetworkRequest(operation);
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07004261 } catch (RemoteException e) {
4262 throw e.rethrowFromSystemServer();
4263 }
Jeremy Joslin94c30992014-11-05 10:32:09 -08004264 }
4265
Hugo Benichiff4bf602017-05-09 15:19:01 +09004266 private static void checkPendingIntentNotNull(PendingIntent intent) {
Remi NGUYEN VANc4dd8c92021-03-15 07:31:54 +00004267 Objects.requireNonNull(intent, "PendingIntent cannot be null.");
Hugo Benichiff4bf602017-05-09 15:19:01 +09004268 }
4269
4270 private static void checkCallbackNotNull(NetworkCallback callback) {
Remi NGUYEN VANc4dd8c92021-03-15 07:31:54 +00004271 Objects.requireNonNull(callback, "null NetworkCallback");
Hugo Benichiff4bf602017-05-09 15:19:01 +09004272 }
4273
4274 private static void checkTimeout(int timeoutMs) {
Remi NGUYEN VANc4dd8c92021-03-15 07:31:54 +00004275 if (timeoutMs <= 0) {
4276 throw new IllegalArgumentException("timeoutMs must be strictly positive.");
4277 }
Jeremy Joslin94c30992014-11-05 10:32:09 -08004278 }
4279
4280 /**
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07004281 * Registers to receive notifications about all networks which satisfy the given
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07004282 * {@link NetworkRequest}. The callbacks will continue to be called until
Chiachang Wang0d92d1a2019-02-27 17:14:50 +08004283 * either the application exits or {@link #unregisterNetworkCallback(NetworkCallback)} is
4284 * called.
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07004285 *
Chalard Jean7f06b342020-05-20 16:11:50 +09004286 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4287 * number of outstanding requests to 100 per app (identified by their UID), shared with
4288 * all variants of this method, of {@link #requestNetwork} as well as
4289 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4290 * Requesting a network with this method will count toward this limit. If this limit is
4291 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4292 * make sure to unregister the callbacks with
4293 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4294 *
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07004295 * @param request {@link NetworkRequest} describing this request.
4296 * @param networkCallback The {@link NetworkCallback} that the system will call as suitable
4297 * networks change state.
Hugo Benichicd5a0e02017-02-02 17:02:36 +09004298 * The callback is invoked on the default internal Handler.
Chalard Jean7f06b342020-05-20 16:11:50 +09004299 * @throws RuntimeException if the app already has too many callbacks registered.
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07004300 */
Jeff Sharkey2ac62992017-04-24 11:18:03 -06004301 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean42a9c292019-01-07 19:26:34 +09004302 public void registerNetworkCallback(@NonNull NetworkRequest request,
4303 @NonNull NetworkCallback networkCallback) {
Hugo Benichicd5a0e02017-02-02 17:02:36 +09004304 registerNetworkCallback(request, networkCallback, getDefaultHandler());
4305 }
4306
4307 /**
4308 * Registers to receive notifications about all networks which satisfy the given
4309 * {@link NetworkRequest}. The callbacks will continue to be called until
Chiachang Wang0d92d1a2019-02-27 17:14:50 +08004310 * either the application exits or {@link #unregisterNetworkCallback(NetworkCallback)} is
4311 * called.
Hugo Benichicd5a0e02017-02-02 17:02:36 +09004312 *
Chalard Jean7f06b342020-05-20 16:11:50 +09004313 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4314 * number of outstanding requests to 100 per app (identified by their UID), shared with
4315 * all variants of this method, of {@link #requestNetwork} as well as
4316 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4317 * Requesting a network with this method will count toward this limit. If this limit is
4318 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4319 * make sure to unregister the callbacks with
4320 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4321 *
4322 *
Hugo Benichicd5a0e02017-02-02 17:02:36 +09004323 * @param request {@link NetworkRequest} describing this request.
4324 * @param networkCallback The {@link NetworkCallback} that the system will call as suitable
4325 * networks change state.
4326 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
Chalard Jean7f06b342020-05-20 16:11:50 +09004327 * @throws RuntimeException if the app already has too many callbacks registered.
Hugo Benichicd5a0e02017-02-02 17:02:36 +09004328 */
Jeff Sharkey2ac62992017-04-24 11:18:03 -06004329 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean42a9c292019-01-07 19:26:34 +09004330 public void registerNetworkCallback(@NonNull NetworkRequest request,
4331 @NonNull NetworkCallback networkCallback, @NonNull Handler handler) {
Hugo Benichicd5a0e02017-02-02 17:02:36 +09004332 CallbackHandler cbHandler = new CallbackHandler(handler);
4333 NetworkCapabilities nc = request.networkCapabilities;
4334 sendRequestForNetwork(nc, networkCallback, 0, LISTEN, TYPE_NONE, cbHandler);
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07004335 }
4336
4337 /**
Paul Jensen9ceed862015-06-17 14:15:39 -04004338 * Registers a PendingIntent to be sent when a network is available which satisfies the given
4339 * {@link NetworkRequest}.
4340 *
4341 * This function behaves identically to the version that takes a NetworkCallback, but instead
4342 * of {@link NetworkCallback} a {@link PendingIntent} is used. This means
4343 * the request may outlive the calling application and get called back when a suitable
4344 * network is found.
4345 * <p>
4346 * The operation is an Intent broadcast that goes to a broadcast receiver that
4347 * you registered with {@link Context#registerReceiver} or through the
4348 * &lt;receiver&gt; tag in an AndroidManifest.xml file
4349 * <p>
4350 * The operation Intent is delivered with two extras, a {@link Network} typed
4351 * extra called {@link #EXTRA_NETWORK} and a {@link NetworkRequest}
4352 * typed extra called {@link #EXTRA_NETWORK_REQUEST} containing
4353 * the original requests parameters.
4354 * <p>
4355 * If there is already a request for this Intent registered (with the equality of
4356 * two Intents defined by {@link Intent#filterEquals}), then it will be removed and
4357 * replaced by this one, effectively releasing the previous {@link NetworkRequest}.
4358 * <p>
4359 * The request may be released normally by calling
Paul Jensen78f6b802015-06-30 14:29:18 -04004360 * {@link #unregisterNetworkCallback(android.app.PendingIntent)}.
Chalard Jean7f06b342020-05-20 16:11:50 +09004361 *
4362 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4363 * number of outstanding requests to 100 per app (identified by their UID), shared with
4364 * all variants of this method, of {@link #requestNetwork} as well as
4365 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4366 * Requesting a network with this method will count toward this limit. If this limit is
4367 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4368 * make sure to unregister the callbacks with {@link #unregisterNetworkCallback(PendingIntent)}
4369 * or {@link #releaseNetworkRequest(PendingIntent)}.
4370 *
Paul Jensen9ceed862015-06-17 14:15:39 -04004371 * @param request {@link NetworkRequest} describing this request.
4372 * @param operation Action to perform when the network is available (corresponds
4373 * to the {@link NetworkCallback#onAvailable} call. Typically
4374 * comes from {@link PendingIntent#getBroadcast}. Cannot be null.
Chalard Jean7f06b342020-05-20 16:11:50 +09004375 * @throws RuntimeException if the app already has too many callbacks registered.
Paul Jensen9ceed862015-06-17 14:15:39 -04004376 */
Jeff Sharkey2ac62992017-04-24 11:18:03 -06004377 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean42a9c292019-01-07 19:26:34 +09004378 public void registerNetworkCallback(@NonNull NetworkRequest request,
4379 @NonNull PendingIntent operation) {
Soi, Yoshinari99efcbd2015-11-12 12:09:02 +09004380 printStackTrace();
Hugo Benichiff4bf602017-05-09 15:19:01 +09004381 checkPendingIntentNotNull(operation);
Paul Jensen9ceed862015-06-17 14:15:39 -04004382 try {
Roshan Piusd26ae412020-01-16 12:17:17 -08004383 mService.pendingListenForNetwork(
Roshan Piusc97d8062020-12-17 14:53:09 -08004384 request.networkCapabilities, operation, mContext.getOpPackageName(),
4385 getAttributionTag());
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07004386 } catch (RemoteException e) {
4387 throw e.rethrowFromSystemServer();
Hugo Benichi145e3792017-05-11 13:16:17 +09004388 } catch (ServiceSpecificException e) {
4389 throw convertServiceException(e);
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07004390 }
Paul Jensen9ceed862015-06-17 14:15:39 -04004391 }
4392
4393 /**
Lorenzo Colitti80b48bc2021-01-29 20:14:04 +09004394 * Registers to receive notifications about changes in the application's default network. This
4395 * may be a physical network or a virtual network, such as a VPN that applies to the
4396 * application. The callbacks will continue to be called until either the application exits or
Lorenzo Colittiad458ad2016-04-13 22:00:02 +09004397 * {@link #unregisterNetworkCallback(NetworkCallback)} is called.
Erik Klinee0aed632016-03-16 15:31:39 +09004398 *
Chalard Jean7f06b342020-05-20 16:11:50 +09004399 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4400 * number of outstanding requests to 100 per app (identified by their UID), shared with
4401 * all variants of this method, of {@link #requestNetwork} as well as
4402 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4403 * Requesting a network with this method will count toward this limit. If this limit is
4404 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4405 * make sure to unregister the callbacks with
4406 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4407 *
Erik Klinee0aed632016-03-16 15:31:39 +09004408 * @param networkCallback The {@link NetworkCallback} that the system will call as the
Lorenzo Colitti80b48bc2021-01-29 20:14:04 +09004409 * application's default network changes.
Hugo Benichicd5a0e02017-02-02 17:02:36 +09004410 * The callback is invoked on the default internal Handler.
Chalard Jean7f06b342020-05-20 16:11:50 +09004411 * @throws RuntimeException if the app already has too many callbacks registered.
Erik Klinee0aed632016-03-16 15:31:39 +09004412 */
Jeff Sharkey2ac62992017-04-24 11:18:03 -06004413 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean42a9c292019-01-07 19:26:34 +09004414 public void registerDefaultNetworkCallback(@NonNull NetworkCallback networkCallback) {
Hugo Benichicd5a0e02017-02-02 17:02:36 +09004415 registerDefaultNetworkCallback(networkCallback, getDefaultHandler());
4416 }
4417
4418 /**
Lorenzo Colitti80b48bc2021-01-29 20:14:04 +09004419 * Registers to receive notifications about changes in the application's default network. This
4420 * may be a physical network or a virtual network, such as a VPN that applies to the
4421 * application. The callbacks will continue to be called until either the application exits or
4422 * {@link #unregisterNetworkCallback(NetworkCallback)} is called.
4423 *
4424 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4425 * number of outstanding requests to 100 per app (identified by their UID), shared with
4426 * all variants of this method, of {@link #requestNetwork} as well as
4427 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4428 * Requesting a network with this method will count toward this limit. If this limit is
4429 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4430 * make sure to unregister the callbacks with
4431 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4432 *
4433 * @param networkCallback The {@link NetworkCallback} that the system will call as the
4434 * application's default network changes.
4435 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
4436 * @throws RuntimeException if the app already has too many callbacks registered.
4437 */
4438 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
4439 public void registerDefaultNetworkCallback(@NonNull NetworkCallback networkCallback,
4440 @NonNull Handler handler) {
Chiachang Wang2e98f6c2021-04-20 15:41:24 +08004441 registerDefaultNetworkCallbackForUid(Process.INVALID_UID, networkCallback, handler);
Lorenzo Colittib199b962021-03-12 22:48:07 +09004442 }
4443
4444 /**
4445 * Registers to receive notifications about changes in the default network for the specified
4446 * UID. This may be a physical network or a virtual network, such as a VPN that applies to the
4447 * UID. The callbacks will continue to be called until either the application exits or
4448 * {@link #unregisterNetworkCallback(NetworkCallback)} is called.
4449 *
4450 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4451 * number of outstanding requests to 100 per app (identified by their UID), shared with
4452 * all variants of this method, of {@link #requestNetwork} as well as
4453 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4454 * Requesting a network with this method will count toward this limit. If this limit is
4455 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4456 * make sure to unregister the callbacks with
4457 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4458 *
4459 * @param uid the UID for which to track default network changes.
4460 * @param networkCallback The {@link NetworkCallback} that the system will call as the
4461 * UID's default network changes.
4462 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
4463 * @throws RuntimeException if the app already has too many callbacks registered.
4464 * @hide
4465 */
Lorenzo Colitti3949d6e2021-03-22 18:23:21 +09004466 @SystemApi(client = MODULE_LIBRARIES)
Lorenzo Colittib199b962021-03-12 22:48:07 +09004467 @SuppressLint({"ExecutorRegistration", "PairedRegistration"})
4468 @RequiresPermission(anyOf = {
4469 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
4470 android.Manifest.permission.NETWORK_SETTINGS})
Chiachang Wang2e98f6c2021-04-20 15:41:24 +08004471 public void registerDefaultNetworkCallbackForUid(int uid,
Lorenzo Colittib199b962021-03-12 22:48:07 +09004472 @NonNull NetworkCallback networkCallback, @NonNull Handler handler) {
Lorenzo Colitti80b48bc2021-01-29 20:14:04 +09004473 CallbackHandler cbHandler = new CallbackHandler(handler);
Lorenzo Colittib199b962021-03-12 22:48:07 +09004474 sendRequestForNetwork(uid, null /* need */, networkCallback, 0 /* timeoutMs */,
Lorenzo Colitti80b48bc2021-01-29 20:14:04 +09004475 TRACK_DEFAULT, TYPE_NONE, cbHandler);
4476 }
4477
4478 /**
Hugo Benichicd5a0e02017-02-02 17:02:36 +09004479 * Registers to receive notifications about changes in the system default network. The callbacks
4480 * will continue to be called until either the application exits or
4481 * {@link #unregisterNetworkCallback(NetworkCallback)} is called.
Hugo Benichicd5a0e02017-02-02 17:02:36 +09004482 *
Lorenzo Colitti80b48bc2021-01-29 20:14:04 +09004483 * This method should not be used to determine networking state seen by applications, because in
4484 * many cases, most or even all application traffic may not use the default network directly,
4485 * and traffic from different applications may go on different networks by default. As an
4486 * example, if a VPN is connected, traffic from all applications might be sent through the VPN
4487 * and not onto the system default network. Applications or system components desiring to do
4488 * determine network state as seen by applications should use other methods such as
4489 * {@link #registerDefaultNetworkCallback(NetworkCallback, Handler)}.
4490 *
Chalard Jean7f06b342020-05-20 16:11:50 +09004491 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4492 * number of outstanding requests to 100 per app (identified by their UID), shared with
4493 * all variants of this method, of {@link #requestNetwork} as well as
4494 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4495 * Requesting a network with this method will count toward this limit. If this limit is
4496 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4497 * make sure to unregister the callbacks with
4498 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4499 *
Hugo Benichicd5a0e02017-02-02 17:02:36 +09004500 * @param networkCallback The {@link NetworkCallback} that the system will call as the
4501 * system default network changes.
4502 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
Chalard Jean7f06b342020-05-20 16:11:50 +09004503 * @throws RuntimeException if the app already has too many callbacks registered.
Lorenzo Colitti80b48bc2021-01-29 20:14:04 +09004504 *
4505 * @hide
Hugo Benichicd5a0e02017-02-02 17:02:36 +09004506 */
Lorenzo Colitti80b48bc2021-01-29 20:14:04 +09004507 @SystemApi(client = MODULE_LIBRARIES)
4508 @SuppressLint({"ExecutorRegistration", "PairedRegistration"})
4509 @RequiresPermission(anyOf = {
4510 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
4511 android.Manifest.permission.NETWORK_SETTINGS})
4512 public void registerSystemDefaultNetworkCallback(@NonNull NetworkCallback networkCallback,
Chalard Jean42a9c292019-01-07 19:26:34 +09004513 @NonNull Handler handler) {
Hugo Benichicd5a0e02017-02-02 17:02:36 +09004514 CallbackHandler cbHandler = new CallbackHandler(handler);
Chalard Jean73d9db72018-06-04 16:52:49 +09004515 sendRequestForNetwork(null /* NetworkCapabilities need */, networkCallback, 0,
Lorenzo Colitti80b48bc2021-01-29 20:14:04 +09004516 TRACK_SYSTEM_DEFAULT, TYPE_NONE, cbHandler);
Erik Klinee0aed632016-03-16 15:31:39 +09004517 }
4518
4519 /**
junyulaibd622262021-03-15 11:48:48 +08004520 * Registers to receive notifications about the best matching network which satisfy the given
4521 * {@link NetworkRequest}. The callbacks will continue to be called until
4522 * either the application exits or {@link #unregisterNetworkCallback(NetworkCallback)} is
4523 * called.
4524 *
4525 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
4526 * number of outstanding requests to 100 per app (identified by their UID), shared with
4527 * {@link #registerNetworkCallback} and its variants and {@link #requestNetwork} as well as
4528 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
4529 * Requesting a network with this method will count toward this limit. If this limit is
4530 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
4531 * make sure to unregister the callbacks with
4532 * {@link #unregisterNetworkCallback(NetworkCallback)}.
4533 *
4534 *
4535 * @param request {@link NetworkRequest} describing this request.
4536 * @param networkCallback The {@link NetworkCallback} that the system will call as suitable
4537 * networks change state.
4538 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
4539 * @throws RuntimeException if the app already has too many callbacks registered.
junyulai6b0a6a22021-03-05 15:51:17 +08004540 */
junyulai6b0a6a22021-03-05 15:51:17 +08004541 @SuppressLint("ExecutorRegistration")
4542 public void registerBestMatchingNetworkCallback(@NonNull NetworkRequest request,
4543 @NonNull NetworkCallback networkCallback, @NonNull Handler handler) {
4544 final NetworkCapabilities nc = request.networkCapabilities;
4545 final CallbackHandler cbHandler = new CallbackHandler(handler);
junyulai8cae3c72021-03-12 20:05:08 +08004546 sendRequestForNetwork(nc, networkCallback, 0, LISTEN_FOR_BEST, TYPE_NONE, cbHandler);
junyulai6b0a6a22021-03-05 15:51:17 +08004547 }
4548
4549 /**
fenglu73169332015-04-21 17:12:05 -07004550 * Requests bandwidth update for a given {@link Network} and returns whether the update request
4551 * is accepted by ConnectivityService. Once accepted, ConnectivityService will poll underlying
4552 * network connection for updated bandwidth information. The caller will be notified via
4553 * {@link ConnectivityManager.NetworkCallback} if there is an update. Notice that this
Lorenzo Colittiad458ad2016-04-13 22:00:02 +09004554 * method assumes that the caller has previously called
4555 * {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)} to listen for network
4556 * changes.
fenglu76564332015-03-20 11:29:56 -07004557 *
fenglu41808e82015-04-27 14:28:04 -07004558 * @param network {@link Network} specifying which network you're interested.
fenglu73169332015-04-21 17:12:05 -07004559 * @return {@code true} on success, {@code false} if the {@link Network} is no longer valid.
fenglu76564332015-03-20 11:29:56 -07004560 */
Chalard Jean42a9c292019-01-07 19:26:34 +09004561 public boolean requestBandwidthUpdate(@NonNull Network network) {
fenglu76564332015-03-20 11:29:56 -07004562 try {
fenglu73169332015-04-21 17:12:05 -07004563 return mService.requestBandwidthUpdate(network);
fenglu76564332015-03-20 11:29:56 -07004564 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07004565 throw e.rethrowFromSystemServer();
fenglu76564332015-03-20 11:29:56 -07004566 }
4567 }
4568
4569 /**
Hugo Benichi45a49542017-03-06 09:17:06 +09004570 * Unregisters a {@code NetworkCallback} and possibly releases networks originating from
Lorenzo Colittiad458ad2016-04-13 22:00:02 +09004571 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} and
4572 * {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)} calls.
4573 * If the given {@code NetworkCallback} had previously been used with
Lorenzo Colittiefd396e2015-04-24 17:03:31 +09004574 * {@code #requestNetwork}, any networks that had been connected to only to satisfy that request
4575 * will be disconnected.
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07004576 *
Hugo Benichi45a49542017-03-06 09:17:06 +09004577 * Notifications that would have triggered that {@code NetworkCallback} will immediately stop
4578 * triggering it as soon as this call returns.
4579 *
Robert Greenwalt09e5cff2014-06-11 16:05:07 -07004580 * @param networkCallback The {@link NetworkCallback} used when making the request.
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07004581 */
Chalard Jean42a9c292019-01-07 19:26:34 +09004582 public void unregisterNetworkCallback(@NonNull NetworkCallback networkCallback) {
Soi, Yoshinari99efcbd2015-11-12 12:09:02 +09004583 printStackTrace();
Hugo Benichiff4bf602017-05-09 15:19:01 +09004584 checkCallbackNotNull(networkCallback);
Hugo Benichi45a49542017-03-06 09:17:06 +09004585 final List<NetworkRequest> reqs = new ArrayList<>();
4586 // Find all requests associated to this callback and stop callback triggers immediately.
4587 // Callback is reusable immediately. http://b/20701525, http://b/35921499.
4588 synchronized (sCallbacks) {
Remi NGUYEN VANc4dd8c92021-03-15 07:31:54 +00004589 if (networkCallback.networkRequest == null) {
4590 throw new IllegalArgumentException("NetworkCallback was not registered");
4591 }
Etan Cohene0e2ca92019-04-16 15:07:55 -07004592 if (networkCallback.networkRequest == ALREADY_UNREGISTERED) {
4593 Log.d(TAG, "NetworkCallback was already unregistered");
4594 return;
4595 }
Hugo Benichi45a49542017-03-06 09:17:06 +09004596 for (Map.Entry<NetworkRequest, NetworkCallback> e : sCallbacks.entrySet()) {
4597 if (e.getValue() == networkCallback) {
4598 reqs.add(e.getKey());
4599 }
4600 }
4601 // TODO: throw exception if callback was registered more than once (http://b/20701525).
4602 for (NetworkRequest r : reqs) {
4603 try {
4604 mService.releaseNetworkRequest(r);
4605 } catch (RemoteException e) {
4606 throw e.rethrowFromSystemServer();
4607 }
4608 // Only remove mapping if rpc was successful.
4609 sCallbacks.remove(r);
4610 }
Hugo Benichi1c027fe2017-06-17 13:14:12 +09004611 networkCallback.networkRequest = ALREADY_UNREGISTERED;
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07004612 }
Robert Greenwalt2bebbfb2014-03-26 16:47:06 -07004613 }
Paul Jensene98c6e02014-05-29 10:12:39 -04004614
4615 /**
Paul Jensen78f6b802015-06-30 14:29:18 -04004616 * Unregisters a callback previously registered via
4617 * {@link #registerNetworkCallback(NetworkRequest, android.app.PendingIntent)}.
4618 *
4619 * @param operation A PendingIntent equal (as defined by {@link Intent#filterEquals}) to the
4620 * PendingIntent passed to
4621 * {@link #registerNetworkCallback(NetworkRequest, android.app.PendingIntent)}.
4622 * Cannot be null.
4623 */
Chalard Jean42a9c292019-01-07 19:26:34 +09004624 public void unregisterNetworkCallback(@NonNull PendingIntent operation) {
Paul Jensen78f6b802015-06-30 14:29:18 -04004625 releaseNetworkRequest(operation);
4626 }
4627
4628 /**
Lorenzo Colitti36fbebe2015-04-03 16:38:52 +09004629 * Informs the system whether it should switch to {@code network} regardless of whether it is
4630 * validated or not. If {@code accept} is true, and the network was explicitly selected by the
4631 * user (e.g., by selecting a Wi-Fi network in the Settings app), then the network will become
4632 * the system default network regardless of any other network that's currently connected. If
4633 * {@code always} is true, then the choice is remembered, so that the next time the user
4634 * connects to this network, the system will switch to it.
4635 *
Lorenzo Colitti36fbebe2015-04-03 16:38:52 +09004636 * @param network The network to accept.
4637 * @param accept Whether to accept the network even if unvalidated.
4638 * @param always Whether to remember this choice in the future.
4639 *
4640 * @hide
4641 */
Chiachang Wang0cefc1c2021-03-18 09:44:34 +08004642 @SystemApi(client = MODULE_LIBRARIES)
4643 @RequiresPermission(anyOf = {
4644 android.Manifest.permission.NETWORK_SETTINGS,
4645 android.Manifest.permission.NETWORK_SETUP_WIZARD,
4646 android.Manifest.permission.NETWORK_STACK,
4647 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK})
4648 public void setAcceptUnvalidated(@NonNull Network network, boolean accept, boolean always) {
Lorenzo Colitti36fbebe2015-04-03 16:38:52 +09004649 try {
4650 mService.setAcceptUnvalidated(network, accept, always);
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07004651 } catch (RemoteException e) {
4652 throw e.rethrowFromSystemServer();
4653 }
Lorenzo Colitti36fbebe2015-04-03 16:38:52 +09004654 }
4655
4656 /**
lucaslin25a50472019-03-12 13:08:03 +08004657 * Informs the system whether it should consider the network as validated even if it only has
4658 * partial connectivity. If {@code accept} is true, then the network will be considered as
4659 * validated even if connectivity is only partial. If {@code always} is true, then the choice
4660 * is remembered, so that the next time the user connects to this network, the system will
4661 * switch to it.
4662 *
4663 * @param network The network to accept.
4664 * @param accept Whether to consider the network as validated even if it has partial
4665 * connectivity.
4666 * @param always Whether to remember this choice in the future.
4667 *
4668 * @hide
4669 */
Chiachang Wang0cefc1c2021-03-18 09:44:34 +08004670 @SystemApi(client = MODULE_LIBRARIES)
4671 @RequiresPermission(anyOf = {
4672 android.Manifest.permission.NETWORK_SETTINGS,
4673 android.Manifest.permission.NETWORK_SETUP_WIZARD,
4674 android.Manifest.permission.NETWORK_STACK,
4675 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK})
4676 public void setAcceptPartialConnectivity(@NonNull Network network, boolean accept,
4677 boolean always) {
lucaslin25a50472019-03-12 13:08:03 +08004678 try {
4679 mService.setAcceptPartialConnectivity(network, accept, always);
4680 } catch (RemoteException e) {
4681 throw e.rethrowFromSystemServer();
4682 }
4683 }
4684
4685 /**
Lorenzo Colittie98557f2016-09-19 01:00:19 +09004686 * Informs the system to penalize {@code network}'s score when it becomes unvalidated. This is
4687 * only meaningful if the system is configured not to penalize such networks, e.g., if the
4688 * {@code config_networkAvoidBadWifi} configuration variable is set to 0 and the {@code
4689 * NETWORK_AVOID_BAD_WIFI setting is unset}.
4690 *
Lorenzo Colittie98557f2016-09-19 01:00:19 +09004691 * @param network The network to accept.
4692 *
4693 * @hide
4694 */
Chiachang Wang0cefc1c2021-03-18 09:44:34 +08004695 @SystemApi(client = MODULE_LIBRARIES)
4696 @RequiresPermission(anyOf = {
4697 android.Manifest.permission.NETWORK_SETTINGS,
4698 android.Manifest.permission.NETWORK_SETUP_WIZARD,
4699 android.Manifest.permission.NETWORK_STACK,
4700 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK})
4701 public void setAvoidUnvalidated(@NonNull Network network) {
Lorenzo Colittie98557f2016-09-19 01:00:19 +09004702 try {
4703 mService.setAvoidUnvalidated(network);
4704 } catch (RemoteException e) {
4705 throw e.rethrowFromSystemServer();
4706 }
4707 }
4708
4709 /**
Lorenzo Colitti755e7962017-04-27 14:30:21 +09004710 * Requests that the system open the captive portal app on the specified network.
4711 *
Remi NGUYEN VANbffe51d2021-03-16 18:06:06 +09004712 * <p>This is to be used on networks where a captive portal was detected, as per
4713 * {@link NetworkCapabilities#NET_CAPABILITY_CAPTIVE_PORTAL}.
4714 *
Lorenzo Colitti755e7962017-04-27 14:30:21 +09004715 * @param network The network to log into.
4716 *
4717 * @hide
4718 */
Remi NGUYEN VANbffe51d2021-03-16 18:06:06 +09004719 @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
4720 @RequiresPermission(anyOf = {
4721 android.Manifest.permission.NETWORK_SETTINGS,
4722 android.Manifest.permission.NETWORK_STACK,
4723 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK
4724 })
4725 public void startCaptivePortalApp(@NonNull Network network) {
Lorenzo Colitti755e7962017-04-27 14:30:21 +09004726 try {
4727 mService.startCaptivePortalApp(network);
4728 } catch (RemoteException e) {
4729 throw e.rethrowFromSystemServer();
4730 }
4731 }
4732
4733 /**
Remi NGUYEN VANf363f5f2019-02-04 11:32:20 +09004734 * Requests that the system open the captive portal app with the specified extras.
4735 *
4736 * <p>This endpoint is exclusively for use by the NetworkStack and is protected by the
4737 * corresponding permission.
Remi NGUYEN VAN89fbdc32019-02-13 20:58:59 +09004738 * @param network Network on which the captive portal was detected.
Remi NGUYEN VANf363f5f2019-02-04 11:32:20 +09004739 * @param appExtras Extras to include in the app start intent.
4740 * @hide
4741 */
4742 @SystemApi
Remi NGUYEN VANf363f5f2019-02-04 11:32:20 +09004743 @RequiresPermission(NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK)
paulhu9bb04802019-03-08 16:35:20 +08004744 public void startCaptivePortalApp(@NonNull Network network, @NonNull Bundle appExtras) {
Remi NGUYEN VANf363f5f2019-02-04 11:32:20 +09004745 try {
Remi NGUYEN VAN89fbdc32019-02-13 20:58:59 +09004746 mService.startCaptivePortalAppInternal(network, appExtras);
Remi NGUYEN VANf363f5f2019-02-04 11:32:20 +09004747 } catch (RemoteException e) {
4748 throw e.rethrowFromSystemServer();
4749 }
4750 }
4751
4752 /**
Remi NGUYEN VAN3436b6f2019-01-20 20:35:06 +09004753 * Determine whether the device is configured to avoid bad wifi.
4754 * @hide
4755 */
4756 @SystemApi
Remi NGUYEN VAN338eb2a2019-03-22 11:14:13 +09004757 @RequiresPermission(anyOf = {
4758 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK,
4759 android.Manifest.permission.NETWORK_STACK})
4760 public boolean shouldAvoidBadWifi() {
Remi NGUYEN VAN3436b6f2019-01-20 20:35:06 +09004761 try {
Remi NGUYEN VAN338eb2a2019-03-22 11:14:13 +09004762 return mService.shouldAvoidBadWifi();
Remi NGUYEN VAN3436b6f2019-01-20 20:35:06 +09004763 } catch (RemoteException e) {
4764 throw e.rethrowFromSystemServer();
4765 }
4766 }
4767
4768 /**
Lorenzo Colitti231efb02017-01-24 18:08:41 +09004769 * It is acceptable to briefly use multipath data to provide seamless connectivity for
4770 * time-sensitive user-facing operations when the system default network is temporarily
Lorenzo Colitti38ea8102017-04-28 00:56:30 +09004771 * unresponsive. The amount of data should be limited (less than one megabyte for every call to
4772 * this method), and the operation should be infrequent to ensure that data usage is limited.
Lorenzo Colitti231efb02017-01-24 18:08:41 +09004773 *
4774 * An example of such an operation might be a time-sensitive foreground activity, such as a
4775 * voice command, that the user is performing while walking out of range of a Wi-Fi network.
4776 */
4777 public static final int MULTIPATH_PREFERENCE_HANDOVER = 1 << 0;
4778
4779 /**
4780 * It is acceptable to use small amounts of multipath data on an ongoing basis to provide
4781 * a backup channel for traffic that is primarily going over another network.
4782 *
4783 * An example might be maintaining backup connections to peers or servers for the purpose of
4784 * fast fallback if the default network is temporarily unresponsive or disconnects. The traffic
4785 * on backup paths should be negligible compared to the traffic on the main path.
4786 */
4787 public static final int MULTIPATH_PREFERENCE_RELIABILITY = 1 << 1;
4788
4789 /**
4790 * It is acceptable to use metered data to improve network latency and performance.
4791 */
4792 public static final int MULTIPATH_PREFERENCE_PERFORMANCE = 1 << 2;
4793
4794 /**
4795 * Return value to use for unmetered networks. On such networks we currently set all the flags
4796 * to true.
4797 * @hide
4798 */
4799 public static final int MULTIPATH_PREFERENCE_UNMETERED =
4800 MULTIPATH_PREFERENCE_HANDOVER |
4801 MULTIPATH_PREFERENCE_RELIABILITY |
4802 MULTIPATH_PREFERENCE_PERFORMANCE;
4803
Lorenzo Colitti231efb02017-01-24 18:08:41 +09004804 /**
4805 * Provides a hint to the calling application on whether it is desirable to use the
4806 * multinetwork APIs (e.g., {@link Network#openConnection}, {@link Network#bindSocket}, etc.)
4807 * for multipath data transfer on this network when it is not the system default network.
4808 * Applications desiring to use multipath network protocols should call this method before
4809 * each such operation.
Lorenzo Colitti231efb02017-01-24 18:08:41 +09004810 *
4811 * @param network The network on which the application desires to use multipath data.
4812 * If {@code null}, this method will return the a preference that will generally
4813 * apply to metered networks.
4814 * @return a bitwise OR of zero or more of the {@code MULTIPATH_PREFERENCE_*} constants.
4815 */
Jeff Sharkey2ac62992017-04-24 11:18:03 -06004816 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean42a9c292019-01-07 19:26:34 +09004817 public @MultipathPreference int getMultipathPreference(@Nullable Network network) {
Lorenzo Colitti231efb02017-01-24 18:08:41 +09004818 try {
4819 return mService.getMultipathPreference(network);
4820 } catch (RemoteException e) {
4821 throw e.rethrowFromSystemServer();
4822 }
4823 }
4824
4825 /**
Stuart Scottd3bb5082015-03-30 13:17:11 -07004826 * Resets all connectivity manager settings back to factory defaults.
4827 * @hide
4828 */
Chiachang Wang0cefc1c2021-03-18 09:44:34 +08004829 @SystemApi(client = MODULE_LIBRARIES)
4830 @RequiresPermission(anyOf = {
4831 android.Manifest.permission.NETWORK_SETTINGS,
4832 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK})
Stuart Scottd3bb5082015-03-30 13:17:11 -07004833 public void factoryReset() {
Stuart Scottd3bb5082015-03-30 13:17:11 -07004834 try {
Stuart Scottca888bf2015-04-02 18:00:02 -07004835 mService.factoryReset();
Automerger Merge Worker9b0c0c62020-03-06 00:38:43 +00004836 mTetheringManager.stopAllTethering();
Stuart Scottd3bb5082015-03-30 13:17:11 -07004837 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07004838 throw e.rethrowFromSystemServer();
Stuart Scottd3bb5082015-03-30 13:17:11 -07004839 }
4840 }
4841
4842 /**
Paul Jensene98c6e02014-05-29 10:12:39 -04004843 * Binds the current process to {@code network}. All Sockets created in the future
4844 * (and not explicitly bound via a bound SocketFactory from
4845 * {@link Network#getSocketFactory() Network.getSocketFactory()}) will be bound to
4846 * {@code network}. All host name resolutions will be limited to {@code network} as well.
4847 * Note that if {@code network} ever disconnects, all Sockets created in this way will cease to
4848 * work and all host name resolutions will fail. This is by design so an application doesn't
4849 * accidentally use Sockets it thinks are still bound to a particular {@link Network}.
4850 * To clear binding pass {@code null} for {@code network}. Using individually bound
4851 * Sockets created by Network.getSocketFactory().createSocket() and
4852 * performing network-specific host name resolutions via
4853 * {@link Network#getAllByName Network.getAllByName} is preferred to calling
Paul Jensen895c3942015-03-10 10:54:12 -04004854 * {@code bindProcessToNetwork}.
Paul Jensene98c6e02014-05-29 10:12:39 -04004855 *
4856 * @param network The {@link Network} to bind the current process to, or {@code null} to clear
4857 * the current binding.
4858 * @return {@code true} on success, {@code false} if the {@link Network} is no longer valid.
4859 */
Chalard Jean42a9c292019-01-07 19:26:34 +09004860 public boolean bindProcessToNetwork(@Nullable Network network) {
Chalard Jean73d9db72018-06-04 16:52:49 +09004861 // Forcing callers to call through non-static function ensures ConnectivityManager
Paul Jensen895c3942015-03-10 10:54:12 -04004862 // instantiated.
4863 return setProcessDefaultNetwork(network);
4864 }
4865
4866 /**
4867 * Binds the current process to {@code network}. All Sockets created in the future
4868 * (and not explicitly bound via a bound SocketFactory from
4869 * {@link Network#getSocketFactory() Network.getSocketFactory()}) will be bound to
4870 * {@code network}. All host name resolutions will be limited to {@code network} as well.
4871 * Note that if {@code network} ever disconnects, all Sockets created in this way will cease to
4872 * work and all host name resolutions will fail. This is by design so an application doesn't
4873 * accidentally use Sockets it thinks are still bound to a particular {@link Network}.
4874 * To clear binding pass {@code null} for {@code network}. Using individually bound
4875 * Sockets created by Network.getSocketFactory().createSocket() and
4876 * performing network-specific host name resolutions via
4877 * {@link Network#getAllByName Network.getAllByName} is preferred to calling
4878 * {@code setProcessDefaultNetwork}.
4879 *
4880 * @param network The {@link Network} to bind the current process to, or {@code null} to clear
4881 * the current binding.
4882 * @return {@code true} on success, {@code false} if the {@link Network} is no longer valid.
4883 * @deprecated This function can throw {@link IllegalStateException}. Use
4884 * {@link #bindProcessToNetwork} instead. {@code bindProcessToNetwork}
4885 * is a direct replacement.
4886 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -07004887 @Deprecated
Chalard Jean42a9c292019-01-07 19:26:34 +09004888 public static boolean setProcessDefaultNetwork(@Nullable Network network) {
Paul Jensen99c36662014-08-27 12:38:45 -04004889 int netId = (network == null) ? NETID_UNSET : network.netId;
Lorenzo Colitti3fadff92019-01-31 13:08:24 +09004890 boolean isSameNetId = (netId == NetworkUtils.getBoundNetworkForProcess());
4891
Lorenzo Colitti580483e2019-01-30 23:04:54 +09004892 if (netId != NETID_UNSET) {
4893 netId = network.getNetIdForResolv();
Paul Jensen99c36662014-08-27 12:38:45 -04004894 }
Lorenzo Colitti3fadff92019-01-31 13:08:24 +09004895
4896 if (!NetworkUtils.bindProcessToNetwork(netId)) {
4897 return false;
4898 }
4899
4900 if (!isSameNetId) {
Paul Jensen12131352014-12-10 15:12:18 -05004901 // Set HTTP proxy system properties to match network.
4902 // TODO: Deprecate this static method and replace it with a non-static version.
Lorenzo Colitti40898252015-04-22 11:52:48 +09004903 try {
Remi NGUYEN VANa1860ff2021-02-03 10:18:20 +09004904 Proxy.setHttpProxyConfiguration(getInstance().getDefaultProxy());
Lorenzo Colitti40898252015-04-22 11:52:48 +09004905 } catch (SecurityException e) {
4906 // The process doesn't have ACCESS_NETWORK_STATE, so we can't fetch the proxy.
4907 Log.e(TAG, "Can't set proxy properties", e);
4908 }
Paul Jensen99c36662014-08-27 12:38:45 -04004909 // Must flush DNS cache as new network may have different DNS resolutions.
Remi NGUYEN VAN33e3abb2021-03-18 23:27:19 +09004910 InetAddressCompat.clearDnsCache();
Paul Jensen99c36662014-08-27 12:38:45 -04004911 // Must flush socket pool as idle sockets will be bound to previous network and may
4912 // cause subsequent fetches to be performed on old network.
4913 NetworkEventDispatcher.getInstance().onNetworkConfigurationChanged();
Paul Jensen99c36662014-08-27 12:38:45 -04004914 }
Lorenzo Colitti3fadff92019-01-31 13:08:24 +09004915
4916 return true;
Paul Jensene98c6e02014-05-29 10:12:39 -04004917 }
4918
4919 /**
4920 * Returns the {@link Network} currently bound to this process via
Paul Jensen895c3942015-03-10 10:54:12 -04004921 * {@link #bindProcessToNetwork}, or {@code null} if no {@link Network} is explicitly bound.
Paul Jensene98c6e02014-05-29 10:12:39 -04004922 *
4923 * @return {@code Network} to which this process is bound, or {@code null}.
4924 */
Chalard Jean42a9c292019-01-07 19:26:34 +09004925 @Nullable
Paul Jensen895c3942015-03-10 10:54:12 -04004926 public Network getBoundNetworkForProcess() {
4927 // Forcing callers to call thru non-static function ensures ConnectivityManager
4928 // instantiated.
4929 return getProcessDefaultNetwork();
4930 }
4931
4932 /**
4933 * Returns the {@link Network} currently bound to this process via
4934 * {@link #bindProcessToNetwork}, or {@code null} if no {@link Network} is explicitly bound.
4935 *
4936 * @return {@code Network} to which this process is bound, or {@code null}.
4937 * @deprecated Using this function can lead to other functions throwing
4938 * {@link IllegalStateException}. Use {@link #getBoundNetworkForProcess} instead.
4939 * {@code getBoundNetworkForProcess} is a direct replacement.
4940 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -07004941 @Deprecated
Chalard Jean42a9c292019-01-07 19:26:34 +09004942 @Nullable
Paul Jensene98c6e02014-05-29 10:12:39 -04004943 public static Network getProcessDefaultNetwork() {
Paul Jensen895c3942015-03-10 10:54:12 -04004944 int netId = NetworkUtils.getBoundNetworkForProcess();
Paul Jensen8b6260f2014-07-11 08:17:29 -04004945 if (netId == NETID_UNSET) return null;
Paul Jensene98c6e02014-05-29 10:12:39 -04004946 return new Network(netId);
4947 }
4948
Lorenzo Colitti9b026fa2015-07-29 11:41:21 +09004949 private void unsupportedStartingFrom(int version) {
4950 if (Process.myUid() == Process.SYSTEM_UID) {
Lorenzo Colitti62f752c2018-09-28 11:31:55 +09004951 // The getApplicationInfo() call we make below is not supported in system context. Let
4952 // the call through here, and rely on the fact that ConnectivityService will refuse to
4953 // allow the system to use these APIs anyway.
Lorenzo Colitti9b026fa2015-07-29 11:41:21 +09004954 return;
4955 }
4956
4957 if (mContext.getApplicationInfo().targetSdkVersion >= version) {
4958 throw new UnsupportedOperationException(
4959 "This method is not supported in target SDK version " + version + " and above");
4960 }
4961 }
4962
4963 // Checks whether the calling app can use the legacy routing API (startUsingNetworkFeature,
4964 // stopUsingNetworkFeature, requestRouteToHost), and if not throw UnsupportedOperationException.
Lifu Tangae4adaa2016-01-07 23:20:38 -08004965 // TODO: convert the existing system users (Tethering, GnssLocationProvider) to the new APIs and
Lorenzo Colitti9b026fa2015-07-29 11:41:21 +09004966 // remove these exemptions. Note that this check is not secure, and apps can still access these
4967 // functions by accessing ConnectivityService directly. However, it should be clear that doing
4968 // so is unsupported and may break in the future. http://b/22728205
4969 private void checkLegacyRoutingApiAccess() {
Dianne Hackbornc16abda2015-07-31 10:35:34 -07004970 unsupportedStartingFrom(VERSION_CODES.M);
Lorenzo Colitti9b026fa2015-07-29 11:41:21 +09004971 }
4972
Paul Jensene98c6e02014-05-29 10:12:39 -04004973 /**
4974 * Binds host resolutions performed by this process to {@code network}.
Paul Jensen895c3942015-03-10 10:54:12 -04004975 * {@link #bindProcessToNetwork} takes precedence over this setting.
Paul Jensene98c6e02014-05-29 10:12:39 -04004976 *
4977 * @param network The {@link Network} to bind host resolutions from the current process to, or
4978 * {@code null} to clear the current binding.
4979 * @return {@code true} on success, {@code false} if the {@link Network} is no longer valid.
4980 * @hide
4981 * @deprecated This is strictly for legacy usage to support {@link #startUsingNetworkFeature}.
4982 */
Aurimas Liutikasa6bb0232016-05-24 15:22:55 -07004983 @Deprecated
Mathew Inwoodd078d3d2020-10-27 11:47:29 +00004984 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
Paul Jensene98c6e02014-05-29 10:12:39 -04004985 public static boolean setProcessDefaultNetworkForHostResolution(Network network) {
Paul Jensen8b6260f2014-07-11 08:17:29 -04004986 return NetworkUtils.bindProcessToNetworkForHostResolution(
Erik Klinef2420792018-04-27 22:48:33 +09004987 (network == null) ? NETID_UNSET : network.getNetIdForResolv());
Paul Jensene98c6e02014-05-29 10:12:39 -04004988 }
Felipe Lemed16384b2016-01-22 09:44:57 -08004989
4990 /**
4991 * Device is not restricting metered network activity while application is running on
4992 * background.
4993 */
4994 public static final int RESTRICT_BACKGROUND_STATUS_DISABLED = 1;
4995
4996 /**
4997 * Device is restricting metered network activity while application is running on background,
4998 * but application is allowed to bypass it.
4999 * <p>
5000 * In this state, application should take action to mitigate metered network access.
5001 * For example, a music streaming application should switch to a low-bandwidth bitrate.
5002 */
5003 public static final int RESTRICT_BACKGROUND_STATUS_WHITELISTED = 2;
5004
5005 /**
5006 * Device is restricting metered network activity while application is running on background.
Felipe Leme6a5b7692016-01-27 14:46:39 -08005007 * <p>
Felipe Lemed16384b2016-01-22 09:44:57 -08005008 * In this state, application should not try to use the network while running on background,
5009 * because it would be denied.
5010 */
5011 public static final int RESTRICT_BACKGROUND_STATUS_ENABLED = 3;
5012
Felipe Leme6a5b7692016-01-27 14:46:39 -08005013 /**
5014 * A change in the background metered network activity restriction has occurred.
5015 * <p>
5016 * Applications should call {@link #getRestrictBackgroundStatus()} to check if the restriction
5017 * applies to them.
5018 * <p>
5019 * This is only sent to registered receivers, not manifest receivers.
5020 */
5021 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
5022 public static final String ACTION_RESTRICT_BACKGROUND_CHANGED =
5023 "android.net.conn.RESTRICT_BACKGROUND_CHANGED";
5024
Felipe Lemed16384b2016-01-22 09:44:57 -08005025 /**
5026 * Determines if the calling application is subject to metered network restrictions while
5027 * running on background.
Felipe Leme6bd46fc2016-05-16 13:57:19 -07005028 *
5029 * @return {@link #RESTRICT_BACKGROUND_STATUS_DISABLED},
5030 * {@link #RESTRICT_BACKGROUND_STATUS_ENABLED},
5031 * or {@link #RESTRICT_BACKGROUND_STATUS_WHITELISTED}
Felipe Lemed16384b2016-01-22 09:44:57 -08005032 */
5033 public @RestrictBackgroundStatus int getRestrictBackgroundStatus() {
5034 try {
Remi NGUYEN VAN92f20602021-03-18 14:23:12 +09005035 return mService.getRestrictBackgroundStatusByCaller();
Felipe Lemed16384b2016-01-22 09:44:57 -08005036 } catch (RemoteException e) {
Jeff Sharkeya6066fd2016-03-01 19:27:23 -07005037 throw e.rethrowFromSystemServer();
Felipe Lemed16384b2016-01-22 09:44:57 -08005038 }
5039 }
Ricky Waid53cf002018-01-23 04:09:45 +00005040
5041 /**
5042 * The network watchlist is a list of domains and IP addresses that are associated with
Ricky Wai573dcab2018-03-20 14:20:54 +00005043 * potentially harmful apps. This method returns the SHA-256 of the watchlist config file
5044 * currently used by the system for validation purposes.
Ricky Waid53cf002018-01-23 04:09:45 +00005045 *
5046 * @return Hash of network watchlist config file. Null if config does not exist.
5047 */
Chalard Jean42a9c292019-01-07 19:26:34 +09005048 @Nullable
Ricky Waid53cf002018-01-23 04:09:45 +00005049 public byte[] getNetworkWatchlistConfigHash() {
5050 try {
5051 return mService.getNetworkWatchlistConfigHash();
5052 } catch (RemoteException e) {
5053 Log.e(TAG, "Unable to get watchlist config hash");
5054 throw e.rethrowFromSystemServer();
5055 }
5056 }
Jeff Vander Stoepe7205d62018-07-23 10:57:53 -07005057
5058 /**
5059 * Returns the {@code uid} of the owner of a network connection.
5060 *
Benedict Wong8974a1c2020-01-20 22:14:59 -08005061 * @param protocol The protocol of the connection. Only {@code IPPROTO_TCP} and {@code
5062 * IPPROTO_UDP} currently supported.
Jeff Vander Stoepe7205d62018-07-23 10:57:53 -07005063 * @param local The local {@link InetSocketAddress} of a connection.
5064 * @param remote The remote {@link InetSocketAddress} of a connection.
Jeff Vander Stoepe7205d62018-07-23 10:57:53 -07005065 * @return {@code uid} if the connection is found and the app has permission to observe it
Benedict Wong8974a1c2020-01-20 22:14:59 -08005066 * (e.g., if it is associated with the calling VPN app's VpnService tunnel) or {@link
5067 * android.os.Process#INVALID_UID} if the connection is not found.
5068 * @throws {@link SecurityException} if the caller is not the active VpnService for the current
5069 * user.
5070 * @throws {@link IllegalArgumentException} if an unsupported protocol is requested.
Jeff Vander Stoepe7205d62018-07-23 10:57:53 -07005071 */
Benedict Wong8974a1c2020-01-20 22:14:59 -08005072 public int getConnectionOwnerUid(
5073 int protocol, @NonNull InetSocketAddress local, @NonNull InetSocketAddress remote) {
Jeff Vander Stoepe7205d62018-07-23 10:57:53 -07005074 ConnectionInfo connectionInfo = new ConnectionInfo(protocol, local, remote);
5075 try {
5076 return mService.getConnectionOwnerUid(connectionInfo);
5077 } catch (RemoteException e) {
5078 throw e.rethrowFromSystemServer();
5079 }
5080 }
Soi, Yoshinari99efcbd2015-11-12 12:09:02 +09005081
5082 private void printStackTrace() {
5083 if (DEBUG) {
5084 final StackTraceElement[] callStack = Thread.currentThread().getStackTrace();
5085 final StringBuffer sb = new StringBuffer();
5086 for (int i = 3; i < callStack.length; i++) {
5087 final String stackTrace = callStack[i].toString();
5088 if (stackTrace == null || stackTrace.contains("android.os")) {
5089 break;
5090 }
5091 sb.append(" [").append(stackTrace).append("]");
5092 }
5093 Log.d(TAG, "StackLog:" + sb.toString());
5094 }
5095 }
Cody Kestingb5c7abd2020-04-15 12:33:28 -07005096
Remi NGUYEN VANfe97b482021-01-15 23:02:47 +09005097 /** @hide */
5098 public TestNetworkManager startOrGetTestNetworkManager() {
5099 final IBinder tnBinder;
5100 try {
5101 tnBinder = mService.startOrGetTestNetworkService();
5102 } catch (RemoteException e) {
5103 throw e.rethrowFromSystemServer();
5104 }
5105
5106 return new TestNetworkManager(ITestNetworkManager.Stub.asInterface(tnBinder));
5107 }
5108
Remi NGUYEN VANfe97b482021-01-15 23:02:47 +09005109 /** @hide */
5110 public ConnectivityDiagnosticsManager createDiagnosticsManager() {
5111 return new ConnectivityDiagnosticsManager(mContext, mService);
5112 }
5113
Cody Kestingb5c7abd2020-04-15 12:33:28 -07005114 /**
5115 * Simulates a Data Stall for the specified Network.
5116 *
Remi NGUYEN VAN7d4530b2021-01-12 18:40:04 +09005117 * <p>This method should only be used for tests.
5118 *
Remi NGUYEN VAN5738b862021-04-08 16:26:20 +09005119 * <p>The caller must be the owner of the specified Network. This simulates a data stall to
5120 * have the system behave as if it had happened, but does not actually stall connectivity.
Cody Kestingb5c7abd2020-04-15 12:33:28 -07005121 *
5122 * @param detectionMethod The detection method used to identify the Data Stall.
Remi NGUYEN VAN5738b862021-04-08 16:26:20 +09005123 * See ConnectivityDiagnosticsManager.DataStallReport.DETECTION_METHOD_*.
5124 * @param timestampMillis The timestamp at which the stall 'occurred', in milliseconds, as per
5125 * SystemClock.elapsedRealtime.
Cody Kestingb5c7abd2020-04-15 12:33:28 -07005126 * @param network The Network for which a Data Stall is being simluated.
5127 * @param extras The PersistableBundle of extras included in the Data Stall notification.
5128 * @throws SecurityException if the caller is not the owner of the given network.
5129 * @hide
5130 */
Remi NGUYEN VAN7d4530b2021-01-12 18:40:04 +09005131 @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
Cody Kestingb5c7abd2020-04-15 12:33:28 -07005132 @RequiresPermission(anyOf = {android.Manifest.permission.MANAGE_TEST_NETWORKS,
5133 android.Manifest.permission.NETWORK_STACK})
Remi NGUYEN VAN5738b862021-04-08 16:26:20 +09005134 public void simulateDataStall(@DetectionMethod int detectionMethod, long timestampMillis,
Cody Kestingb5c7abd2020-04-15 12:33:28 -07005135 @NonNull Network network, @NonNull PersistableBundle extras) {
5136 try {
5137 mService.simulateDataStall(detectionMethod, timestampMillis, network, extras);
5138 } catch (RemoteException e) {
5139 e.rethrowFromSystemServer();
5140 }
5141 }
James Mattisdcea9fb2020-10-28 21:48:54 -07005142
Daniel Bright60f02ed2020-06-15 16:10:01 -07005143 @NonNull
5144 private final List<QosCallbackConnection> mQosCallbackConnections = new ArrayList<>();
5145
5146 /**
5147 * Registers a {@link QosSocketInfo} with an associated {@link QosCallback}. The callback will
5148 * receive available QoS events related to the {@link Network} and local ip + port
5149 * specified within socketInfo.
5150 * <p/>
5151 * The same {@link QosCallback} must be unregistered before being registered a second time,
5152 * otherwise {@link QosCallbackRegistrationException} is thrown.
5153 * <p/>
5154 * This API does not, in itself, require any permission if called with a network that is not
5155 * restricted. However, the underlying implementation currently only supports the IMS network,
5156 * which is always restricted. That means non-preinstalled callers can't possibly find this API
5157 * useful, because they'd never be called back on networks that they would have access to.
5158 *
5159 * @throws SecurityException if {@link QosSocketInfo#getNetwork()} is restricted and the app is
5160 * missing CONNECTIVITY_USE_RESTRICTED_NETWORKS permission.
5161 * @throws QosCallback.QosCallbackRegistrationException if qosCallback is already registered.
5162 * @throws RuntimeException if the app already has too many callbacks registered.
5163 *
5164 * Exceptions after the time of registration is passed through
5165 * {@link QosCallback#onError(QosCallbackException)}. see: {@link QosCallbackException}.
5166 *
5167 * @param socketInfo the socket information used to match QoS events
Daniel Bright60f02ed2020-06-15 16:10:01 -07005168 * @param executor The executor on which the callback will be invoked. The provided
5169 * {@link Executor} must run callback sequentially, otherwise the order of
Daniel Brightb953a3e2021-03-10 11:51:50 -08005170 * callbacks cannot be guaranteed.onQosCallbackRegistered
5171 * @param callback receives qos events that satisfy socketInfo
Daniel Bright60f02ed2020-06-15 16:10:01 -07005172 *
5173 * @hide
5174 */
5175 @SystemApi
5176 public void registerQosCallback(@NonNull final QosSocketInfo socketInfo,
Daniel Brightb953a3e2021-03-10 11:51:50 -08005177 @CallbackExecutor @NonNull final Executor executor,
5178 @NonNull final QosCallback callback) {
Daniel Bright60f02ed2020-06-15 16:10:01 -07005179 Objects.requireNonNull(socketInfo, "socketInfo must be non-null");
Daniel Bright60f02ed2020-06-15 16:10:01 -07005180 Objects.requireNonNull(executor, "executor must be non-null");
Daniel Brightb953a3e2021-03-10 11:51:50 -08005181 Objects.requireNonNull(callback, "callback must be non-null");
Daniel Bright60f02ed2020-06-15 16:10:01 -07005182
5183 try {
5184 synchronized (mQosCallbackConnections) {
5185 if (getQosCallbackConnection(callback) == null) {
5186 final QosCallbackConnection connection =
5187 new QosCallbackConnection(this, callback, executor);
5188 mQosCallbackConnections.add(connection);
5189 mService.registerQosSocketCallback(socketInfo, connection);
5190 } else {
5191 Log.e(TAG, "registerQosCallback: Callback already registered");
5192 throw new QosCallbackRegistrationException();
5193 }
5194 }
5195 } catch (final RemoteException e) {
5196 Log.e(TAG, "registerQosCallback: Error while registering ", e);
5197
5198 // The same unregister method method is called for consistency even though nothing
5199 // will be sent to the ConnectivityService since the callback was never successfully
5200 // registered.
5201 unregisterQosCallback(callback);
5202 e.rethrowFromSystemServer();
5203 } catch (final ServiceSpecificException e) {
5204 Log.e(TAG, "registerQosCallback: Error while registering ", e);
5205 unregisterQosCallback(callback);
5206 throw convertServiceException(e);
5207 }
5208 }
5209
5210 /**
5211 * Unregisters the given {@link QosCallback}. The {@link QosCallback} will no longer receive
5212 * events once unregistered and can be registered a second time.
5213 * <p/>
5214 * If the {@link QosCallback} does not have an active registration, it is a no-op.
5215 *
5216 * @param callback the callback being unregistered
5217 *
5218 * @hide
5219 */
5220 @SystemApi
5221 public void unregisterQosCallback(@NonNull final QosCallback callback) {
5222 Objects.requireNonNull(callback, "The callback must be non-null");
5223 try {
5224 synchronized (mQosCallbackConnections) {
5225 final QosCallbackConnection connection = getQosCallbackConnection(callback);
5226 if (connection != null) {
5227 connection.stopReceivingMessages();
5228 mService.unregisterQosCallback(connection);
5229 mQosCallbackConnections.remove(connection);
5230 } else {
5231 Log.d(TAG, "unregisterQosCallback: Callback not registered");
5232 }
5233 }
5234 } catch (final RemoteException e) {
5235 Log.e(TAG, "unregisterQosCallback: Error while unregistering ", e);
5236 e.rethrowFromSystemServer();
5237 }
5238 }
5239
5240 /**
5241 * Gets the connection related to the callback.
5242 *
5243 * @param callback the callback to look up
5244 * @return the related connection
5245 */
5246 @Nullable
5247 private QosCallbackConnection getQosCallbackConnection(final QosCallback callback) {
5248 for (final QosCallbackConnection connection : mQosCallbackConnections) {
5249 // Checking by reference here is intentional
5250 if (connection.getCallback() == callback) {
5251 return connection;
5252 }
5253 }
5254 return null;
5255 }
Junyu Lai23568a42021-01-19 11:10:56 +00005256
5257 /**
Roshan Pius7992afd2020-12-22 15:10:42 -08005258 * Request a network to satisfy a set of {@link NetworkCapabilities}, but
Junyu Lai23568a42021-01-19 11:10:56 +00005259 * does not cause any networks to retain the NET_CAPABILITY_FOREGROUND capability. This can
5260 * be used to request that the system provide a network without causing the network to be
5261 * in the foreground.
5262 *
5263 * <p>This method will attempt to find the best network that matches the passed
5264 * {@link NetworkRequest}, and to bring up one that does if none currently satisfies the
5265 * criteria. The platform will evaluate which network is the best at its own discretion.
5266 * Throughput, latency, cost per byte, policy, user preference and other considerations
5267 * may be factored in the decision of what is considered the best network.
5268 *
5269 * <p>As long as this request is outstanding, the platform will try to maintain the best network
5270 * matching this request, while always attempting to match the request to a better network if
5271 * possible. If a better match is found, the platform will switch this request to the now-best
5272 * network and inform the app of the newly best network by invoking
5273 * {@link NetworkCallback#onAvailable(Network)} on the provided callback. Note that the platform
5274 * will not try to maintain any other network than the best one currently matching the request:
5275 * a network not matching any network request may be disconnected at any time.
5276 *
5277 * <p>For example, an application could use this method to obtain a connected cellular network
5278 * even if the device currently has a data connection over Ethernet. This may cause the cellular
5279 * radio to consume additional power. Or, an application could inform the system that it wants
5280 * a network supporting sending MMSes and have the system let it know about the currently best
5281 * MMS-supporting network through the provided {@link NetworkCallback}.
5282 *
5283 * <p>The status of the request can be followed by listening to the various callbacks described
5284 * in {@link NetworkCallback}. The {@link Network} object passed to the callback methods can be
5285 * used to direct traffic to the network (although accessing some networks may be subject to
5286 * holding specific permissions). Callers will learn about the specific characteristics of the
5287 * network through
5288 * {@link NetworkCallback#onCapabilitiesChanged(Network, NetworkCapabilities)} and
5289 * {@link NetworkCallback#onLinkPropertiesChanged(Network, LinkProperties)}. The methods of the
5290 * provided {@link NetworkCallback} will only be invoked due to changes in the best network
5291 * matching the request at any given time; therefore when a better network matching the request
5292 * becomes available, the {@link NetworkCallback#onAvailable(Network)} method is called
5293 * with the new network after which no further updates are given about the previously-best
5294 * network, unless it becomes the best again at some later time. All callbacks are invoked
5295 * in order on the same thread, which by default is a thread created by the framework running
5296 * in the app.
5297 *
5298 * <p>This{@link NetworkRequest} will live until released via
5299 * {@link #unregisterNetworkCallback(NetworkCallback)} or the calling application exits, at
5300 * which point the system may let go of the network at any time.
5301 *
5302 * <p>It is presently unsupported to request a network with mutable
5303 * {@link NetworkCapabilities} such as
5304 * {@link NetworkCapabilities#NET_CAPABILITY_VALIDATED} or
5305 * {@link NetworkCapabilities#NET_CAPABILITY_CAPTIVE_PORTAL}
5306 * as these {@code NetworkCapabilities} represent states that a particular
5307 * network may never attain, and whether a network will attain these states
5308 * is unknown prior to bringing up the network so the framework does not
5309 * know how to go about satisfying a request with these capabilities.
5310 *
5311 * <p>To avoid performance issues due to apps leaking callbacks, the system will limit the
5312 * number of outstanding requests to 100 per app (identified by their UID), shared with
5313 * all variants of this method, of {@link #registerNetworkCallback} as well as
5314 * {@link ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback}.
5315 * Requesting a network with this method will count toward this limit. If this limit is
5316 * exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources,
5317 * make sure to unregister the callbacks with
5318 * {@link #unregisterNetworkCallback(NetworkCallback)}.
5319 *
5320 * @param request {@link NetworkRequest} describing this request.
Junyu Lai23568a42021-01-19 11:10:56 +00005321 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
5322 * the callback must not be shared - it uniquely specifies this request.
junyulai56ed9a32021-04-15 00:39:49 +08005323 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
5324 * If null, the callback is invoked on the default internal Handler.
Junyu Lai23568a42021-01-19 11:10:56 +00005325 * @throws IllegalArgumentException if {@code request} contains invalid network capabilities.
5326 * @throws SecurityException if missing the appropriate permissions.
5327 * @throws RuntimeException if the app already has too many callbacks registered.
5328 *
5329 * @hide
5330 */
5331 @SystemApi(client = MODULE_LIBRARIES)
5332 @SuppressLint("ExecutorRegistration")
5333 @RequiresPermission(anyOf = {
5334 android.Manifest.permission.NETWORK_SETTINGS,
5335 android.Manifest.permission.NETWORK_STACK,
5336 NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK
5337 })
5338 public void requestBackgroundNetwork(@NonNull NetworkRequest request,
junyulai56ed9a32021-04-15 00:39:49 +08005339 @NonNull NetworkCallback networkCallback,
5340 @SuppressLint("ListenerLast") @NonNull Handler handler) {
Junyu Lai23568a42021-01-19 11:10:56 +00005341 final NetworkCapabilities nc = request.networkCapabilities;
5342 sendRequestForNetwork(nc, networkCallback, 0, BACKGROUND_REQUEST,
junyulaif4bc12f2021-03-09 20:49:48 +08005343 TYPE_NONE, new CallbackHandler(handler));
Junyu Lai23568a42021-01-19 11:10:56 +00005344 }
James Mattis6e6fabf2021-01-10 14:24:24 -08005345
5346 /**
James Mattis6e6fabf2021-01-10 14:24:24 -08005347 * Used by automotive devices to set the network preferences used to direct traffic at an
5348 * application level as per the given OemNetworkPreferences. An example use-case would be an
5349 * automotive OEM wanting to provide connectivity for applications critical to the usage of a
5350 * vehicle via a particular network.
5351 *
5352 * Calling this will overwrite the existing preference.
5353 *
5354 * @param preference {@link OemNetworkPreferences} The application network preference to be set.
5355 * @param executor the executor on which listener will be invoked.
5356 * @param listener {@link OnSetOemNetworkPreferenceListener} optional listener used to
5357 * communicate completion of setOemNetworkPreference(). This will only be
5358 * called once upon successful completion of setOemNetworkPreference().
5359 * @throws IllegalArgumentException if {@code preference} contains invalid preference values.
5360 * @throws SecurityException if missing the appropriate permissions.
5361 * @throws UnsupportedOperationException if called on a non-automotive device.
James Mattis7a253542021-01-26 16:23:52 -08005362 * @hide
James Mattis6e6fabf2021-01-10 14:24:24 -08005363 */
James Mattis7a253542021-01-26 16:23:52 -08005364 @SystemApi
James Mattis981865c2021-01-26 14:05:36 -08005365 @RequiresPermission(android.Manifest.permission.CONTROL_OEM_PAID_NETWORK_PREFERENCE)
James Mattis7a253542021-01-26 16:23:52 -08005366 public void setOemNetworkPreference(@NonNull final OemNetworkPreferences preference,
James Mattis6e6fabf2021-01-10 14:24:24 -08005367 @Nullable @CallbackExecutor final Executor executor,
Chalard Jeancc9ad152021-03-03 16:37:13 +09005368 @Nullable final Runnable listener) {
James Mattis6e6fabf2021-01-10 14:24:24 -08005369 Objects.requireNonNull(preference, "OemNetworkPreferences must be non-null");
5370 if (null != listener) {
5371 Objects.requireNonNull(executor, "Executor must be non-null");
5372 }
Chalard Jeancc9ad152021-03-03 16:37:13 +09005373 final IOnCompleteListener listenerInternal = listener == null ? null :
5374 new IOnCompleteListener.Stub() {
James Mattis6e6fabf2021-01-10 14:24:24 -08005375 @Override
5376 public void onComplete() {
Chalard Jeancc9ad152021-03-03 16:37:13 +09005377 executor.execute(listener::run);
James Mattis6e6fabf2021-01-10 14:24:24 -08005378 }
5379 };
5380
5381 try {
5382 mService.setOemNetworkPreference(preference, listenerInternal);
5383 } catch (RemoteException e) {
5384 Log.e(TAG, "setOemNetworkPreference() failed for preference: " + preference.toString());
5385 throw e.rethrowFromSystemServer();
5386 }
5387 }
lucaslin1a6095c2021-03-12 00:46:33 +08005388
Chalard Jean03433052021-02-25 17:23:40 +09005389 /**
5390 * Request that a user profile is put by default on a network matching a given preference.
5391 *
5392 * See the documentation for the individual preferences for a description of the supported
5393 * behaviors.
5394 *
5395 * @param profile the profile concerned.
5396 * @param preference the preference for this profile.
5397 * @param executor an executor to execute the listener on. Optional if listener is null.
5398 * @param listener an optional listener to listen for completion of the operation.
5399 * @throws IllegalArgumentException if {@code profile} is not a valid user profile.
5400 * @throws SecurityException if missing the appropriate permissions.
5401 * @hide
5402 */
Chalard Jeancc9ad152021-03-03 16:37:13 +09005403 // This function is for establishing per-profile default networking and can only be called by
5404 // the device policy manager, running as the system server. It would make no sense to call it
5405 // on a context for a user because it does not establish a setting on behalf of a user, rather
5406 // it establishes a setting for a user on behalf of the DPM.
5407 @SuppressLint({"UserHandle"})
5408 @SystemApi(client = MODULE_LIBRARIES)
Chalard Jean03433052021-02-25 17:23:40 +09005409 @RequiresPermission(android.Manifest.permission.NETWORK_STACK)
5410 public void setProfileNetworkPreference(@NonNull final UserHandle profile,
5411 @ProfileNetworkPreference final int preference,
5412 @Nullable @CallbackExecutor final Executor executor,
5413 @Nullable final Runnable listener) {
5414 if (null != listener) {
5415 Objects.requireNonNull(executor, "Pass a non-null executor, or a null listener");
5416 }
5417 final IOnCompleteListener proxy;
5418 if (null == listener) {
5419 proxy = null;
5420 } else {
5421 proxy = new IOnCompleteListener.Stub() {
5422 @Override
5423 public void onComplete() {
5424 executor.execute(listener::run);
5425 }
5426 };
5427 }
5428 try {
5429 mService.setProfileNetworkPreference(profile, preference, proxy);
5430 } catch (RemoteException e) {
5431 throw e.rethrowFromSystemServer();
5432 }
5433 }
5434
lucaslin1a6095c2021-03-12 00:46:33 +08005435 // The first network ID of IPSec tunnel interface.
lucaslin28633072021-03-15 17:24:12 +08005436 private static final int TUN_INTF_NETID_START = 0xFC00; // 0xFC00 = 64512
lucaslin1a6095c2021-03-12 00:46:33 +08005437 // The network ID range of IPSec tunnel interface.
lucaslin28633072021-03-15 17:24:12 +08005438 private static final int TUN_INTF_NETID_RANGE = 0x0400; // 0x0400 = 1024
lucaslin1a6095c2021-03-12 00:46:33 +08005439
5440 /**
5441 * Get the network ID range reserved for IPSec tunnel interfaces.
5442 *
5443 * @return A Range which indicates the network ID range of IPSec tunnel interface.
5444 * @hide
5445 */
5446 @SystemApi(client = MODULE_LIBRARIES)
5447 @NonNull
5448 public static Range<Integer> getIpSecNetIdRange() {
5449 return new Range(TUN_INTF_NETID_START, TUN_INTF_NETID_START + TUN_INTF_NETID_RANGE - 1);
5450 }
The Android Open Source Project28527d22009-03-03 19:31:44 -08005451}