blob: c1bce5e52a8d4f010c9bd62470ed699d34903c48 [file] [log] [blame]
The Android Open Source Project9066cfe2009-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 Project9066cfe2009-03-03 19:31:44 -080016package android.net;
17
junyulai215b8772019-01-15 11:32:44 +080018import static android.net.IpSecManager.INVALID_RESOURCE_ID;
19
junyulai48eac1d42018-12-27 17:25:29 +080020import android.annotation.CallbackExecutor;
Felipe Leme1b103232016-01-22 09:44:57 -080021import android.annotation.IntDef;
Chalard Jean50bea3d2019-01-07 19:26:34 +090022import android.annotation.NonNull;
Robin Lee244ce8e2016-01-05 18:03:46 +000023import android.annotation.Nullable;
Jeff Sharkey30e06bb2017-04-24 11:18:03 -060024import android.annotation.RequiresPermission;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080025import android.annotation.SdkConstant;
26import android.annotation.SdkConstant.SdkConstantType;
Udam Sainib7c24872016-01-04 12:16:14 -080027import android.annotation.SystemApi;
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -060028import android.annotation.SystemService;
Remi NGUYEN VAN7731c5b2019-01-17 14:38:31 +090029import android.annotation.TestApi;
Mathew Inwoodfa3a7462018-08-08 14:52:47 +010030import android.annotation.UnsupportedAppUsage;
Robert Greenwalt9258c642014-03-26 16:47:06 -070031import android.app.PendingIntent;
Jeff Sharkey8fc27e82012-04-04 20:40:58 -070032import android.content.Context;
Robert Greenwaltd19c41c2014-05-18 23:07:25 -070033import android.content.Intent;
junyulai48eac1d42018-12-27 17:25:29 +080034import android.net.IpSecManager.UdpEncapsulationSocket;
35import android.net.SocketKeepalive.Callback;
Robert Greenwalt42acef32009-08-12 16:08:25 -070036import android.os.Binder;
Mathew Inwood55418ea2018-12-20 15:30:45 +000037import android.os.Build;
Jeff Sharkey3a844fc2011-08-16 14:37:57 -070038import android.os.Build.VERSION_CODES;
Jeremy Klein36c7aa02016-01-22 14:11:45 -080039import android.os.Bundle;
Robert Greenwalt9258c642014-03-26 16:47:06 -070040import android.os.Handler;
41import android.os.HandlerThread;
Dianne Hackborn77b987f2014-02-26 16:20:52 -080042import android.os.IBinder;
43import android.os.INetworkActivityListener;
44import android.os.INetworkManagementService;
Robert Greenwalt9258c642014-03-26 16:47:06 -070045import android.os.Looper;
46import android.os.Message;
Robert Greenwalt665e1ae2012-08-21 19:27:00 -070047import android.os.Messenger;
Lorenzo Colittiffc42b02015-07-29 11:41:21 +090048import android.os.Process;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080049import android.os.RemoteException;
Jeremy Klein36c7aa02016-01-22 14:11:45 -080050import android.os.ResultReceiver;
Dianne Hackborn77b987f2014-02-26 16:20:52 -080051import android.os.ServiceManager;
Hugo Benichicb883232017-05-11 13:16:17 +090052import android.os.ServiceSpecificException;
Jeff Sharkey961e3042011-08-29 16:02:57 -070053import android.provider.Settings;
Wink Saville36ffb042014-12-05 11:10:30 -080054import android.telephony.SubscriptionManager;
Dianne Hackborn77b987f2014-02-26 16:20:52 -080055import android.util.ArrayMap;
Robert Greenwalt9258c642014-03-26 16:47:06 -070056import android.util.Log;
Erik Kline35bf06c2017-01-26 18:08:28 +090057import android.util.SparseIntArray;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080058
Robert Greenwaltafa05c02014-05-21 20:04:36 -070059import com.android.internal.telephony.ITelephony;
Robert Greenwalt562cc542014-05-15 18:07:26 -070060import com.android.internal.telephony.PhoneConstants;
Hugo Benichidafed3d2017-03-06 09:17:06 +090061import com.android.internal.util.Preconditions;
62import com.android.internal.util.Protocol;
Robert Greenwaltafa05c02014-05-21 20:04:36 -070063
Paul Jensenc91b5342014-08-27 12:38:45 -040064import libcore.net.event.NetworkEventDispatcher;
65
junyulai215b8772019-01-15 11:32:44 +080066import java.io.FileDescriptor;
Felipe Leme1b103232016-01-22 09:44:57 -080067import java.lang.annotation.Retention;
68import java.lang.annotation.RetentionPolicy;
Jeremy Kleind42209d2015-12-28 15:11:58 -080069import java.net.InetAddress;
Jeff Vander Stoep0ac2c092018-07-23 10:57:53 -070070import java.net.InetSocketAddress;
junyulai352dc2f2019-01-08 20:04:33 +080071import java.net.Socket;
Hugo Benichidafed3d2017-03-06 09:17:06 +090072import java.util.ArrayList;
Jeremy Kleind42209d2015-12-28 15:11:58 -080073import java.util.HashMap;
Hugo Benichidafed3d2017-03-06 09:17:06 +090074import java.util.List;
75import java.util.Map;
junyulai48eac1d42018-12-27 17:25:29 +080076import java.util.concurrent.Executor;
Jeremy Kleind42209d2015-12-28 15:11:58 -080077
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080078/**
79 * Class that answers queries about the state of network connectivity. It also
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -060080 * notifies applications when network connectivity changes.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080081 * <p>
82 * The primary responsibilities of this class are to:
83 * <ol>
84 * <li>Monitor network connections (Wi-Fi, GPRS, UMTS, etc.)</li>
85 * <li>Send broadcast intents when network connectivity changes</li>
86 * <li>Attempt to "fail over" to another network when connectivity to a network
87 * is lost</li>
88 * <li>Provide an API that allows applications to query the coarse-grained or fine-grained
89 * state of the available networks</li>
Robert Greenwaltd19c41c2014-05-18 23:07:25 -070090 * <li>Provide an API that allows applications to request and select networks for their data
91 * traffic</li>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080092 * </ol>
93 */
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -060094@SystemService(Context.CONNECTIVITY_SERVICE)
Jeff Sharkeyc006f1a2011-05-19 17:12:49 -070095public class ConnectivityManager {
96 private static final String TAG = "ConnectivityManager";
Soi, Yoshinaridee2aa42015-11-12 12:09:02 +090097 private static final boolean DEBUG = Log.isLoggable(TAG, Log.DEBUG);
Jeff Sharkeyc006f1a2011-05-19 17:12:49 -070098
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080099 /**
Robert Greenwaltd19c41c2014-05-18 23:07:25 -0700100 * A change in network connectivity has occurred. A default connection has either
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800101 * been established or lost. The NetworkInfo for the affected network is
102 * sent as an extra; it should be consulted to see what kind of
103 * connectivity event occurred.
104 * <p/>
Mark Lu33ec1062016-12-05 10:57:55 -0800105 * Apps targeting Android 7.0 (API level 24) and higher do not receive this
106 * broadcast if they declare the broadcast receiver in their manifest. Apps
107 * will still receive broadcasts if they register their
108 * {@link android.content.BroadcastReceiver} with
109 * {@link android.content.Context#registerReceiver Context.registerReceiver()}
110 * and that context is still valid.
111 * <p/>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800112 * If this is a connection that was the result of failing over from a
113 * disconnected network, then the FAILOVER_CONNECTION boolean extra is
114 * set to true.
115 * <p/>
116 * For a loss of connectivity, if the connectivity manager is attempting
117 * to connect (or has already connected) to another network, the
118 * NetworkInfo for the new network is also passed as an extra. This lets
119 * any receivers of the broadcast know that they should not necessarily
120 * tell the user that no data traffic will be possible. Instead, the
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800121 * receiver should expect another broadcast soon, indicating either that
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800122 * the failover attempt succeeded (and so there is still overall data
123 * connectivity), or that the failover attempt failed, meaning that all
124 * connectivity has been lost.
125 * <p/>
126 * For a disconnect event, the boolean extra EXTRA_NO_CONNECTIVITY
127 * is set to {@code true} if there are no connected networks at all.
Chalard Jean054cd162018-02-10 05:33:50 +0900128 *
129 * @deprecated apps should use the more versatile {@link #requestNetwork},
130 * {@link #registerNetworkCallback} or {@link #registerDefaultNetworkCallback}
131 * functions instead for faster and more detailed updates about the network
132 * changes they care about.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800133 */
Jeff Sharkey4fa63b22013-02-20 18:21:19 -0800134 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Chalard Jean054cd162018-02-10 05:33:50 +0900135 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800136 public static final String CONNECTIVITY_ACTION = "android.net.conn.CONNECTIVITY_CHANGE";
Jeff Sharkeyf0ceede2011-08-02 17:22:34 -0700137
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800138 /**
Robert Greenwalte94a6ff2015-09-01 08:23:04 -0700139 * A temporary hack until SUPL system can get off the legacy APIS.
140 * They do too many network requests and the long list of apps listening
Chalard Jean4d660112018-06-04 16:52:49 +0900141 * and waking due to the CONNECTIVITY_ACTION broadcast makes it expensive.
142 * Use this broadcast intent instead for SUPL requests.
Robert Greenwalte94a6ff2015-09-01 08:23:04 -0700143 * @hide
144 */
145 public static final String CONNECTIVITY_ACTION_SUPL =
146 "android.net.conn.CONNECTIVITY_CHANGE_SUPL";
147
148 /**
Paul Jensen25a217c2015-02-27 22:55:47 -0500149 * The device has connected to a network that has presented a captive
150 * portal, which is blocking Internet connectivity. The user was presented
151 * with a notification that network sign in is required,
152 * and the user invoked the notification's action indicating they
Paul Jensen49e3edf2015-05-22 10:50:39 -0400153 * desire to sign in to the network. Apps handling this activity should
Paul Jensen25a217c2015-02-27 22:55:47 -0500154 * facilitate signing in to the network. This action includes a
155 * {@link Network} typed extra called {@link #EXTRA_NETWORK} that represents
156 * the network presenting the captive portal; all communication with the
157 * captive portal must be done using this {@code Network} object.
158 * <p/>
Paul Jensen49e3edf2015-05-22 10:50:39 -0400159 * This activity includes a {@link CaptivePortal} extra named
160 * {@link #EXTRA_CAPTIVE_PORTAL} that can be used to indicate different
161 * outcomes of the captive portal sign in to the system:
162 * <ul>
163 * <li> When the app handling this action believes the user has signed in to
164 * the network and the captive portal has been dismissed, the app should
165 * call {@link CaptivePortal#reportCaptivePortalDismissed} so the system can
166 * reevaluate the network. If reevaluation finds the network no longer
167 * subject to a captive portal, the network may become the default active
Chalard Jean4d660112018-06-04 16:52:49 +0900168 * data network.</li>
Paul Jensen49e3edf2015-05-22 10:50:39 -0400169 * <li> When the app handling this action believes the user explicitly wants
Paul Jensen25a217c2015-02-27 22:55:47 -0500170 * to ignore the captive portal and the network, the app should call
Paul Jensen49e3edf2015-05-22 10:50:39 -0400171 * {@link CaptivePortal#ignoreNetwork}. </li>
172 * </ul>
Paul Jensen25a217c2015-02-27 22:55:47 -0500173 */
174 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
175 public static final String ACTION_CAPTIVE_PORTAL_SIGN_IN = "android.net.conn.CAPTIVE_PORTAL";
176
177 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800178 * The lookup key for a {@link NetworkInfo} object. Retrieve with
179 * {@link android.content.Intent#getParcelableExtra(String)}.
Jeff Sharkeyf0ceede2011-08-02 17:22:34 -0700180 *
Chalard Jeaneb1ea882019-01-11 16:47:53 +0900181 * @deprecated The {@link NetworkInfo} object is deprecated, as many of its properties
182 * can't accurately represent modern network characteristics.
183 * Please obtain information about networks from the {@link NetworkCapabilities}
184 * or {@link LinkProperties} objects instead.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800185 */
Jeff Sharkeyf0ceede2011-08-02 17:22:34 -0700186 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800187 public static final String EXTRA_NETWORK_INFO = "networkInfo";
Jeff Sharkeyf0ceede2011-08-02 17:22:34 -0700188
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800189 /**
Jeff Sharkey75fbb4b2012-08-06 11:41:50 -0700190 * Network type which triggered a {@link #CONNECTIVITY_ACTION} broadcast.
Jeff Sharkey75fbb4b2012-08-06 11:41:50 -0700191 *
192 * @see android.content.Intent#getIntExtra(String, int)
Chalard Jeaneb1ea882019-01-11 16:47:53 +0900193 * @deprecated The network type is not rich enough to represent the characteristics
194 * of modern networks. Please use {@link NetworkCapabilities} instead,
195 * in particular the transports.
Jeff Sharkey75fbb4b2012-08-06 11:41:50 -0700196 */
Chalard Jeaneb1ea882019-01-11 16:47:53 +0900197 @Deprecated
Jeff Sharkey75fbb4b2012-08-06 11:41:50 -0700198 public static final String EXTRA_NETWORK_TYPE = "networkType";
199
200 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800201 * The lookup key for a boolean that indicates whether a connect event
202 * is for a network to which the connectivity manager was failing over
203 * following a disconnect on another network.
204 * Retrieve it with {@link android.content.Intent#getBooleanExtra(String,boolean)}.
junyulai3822c8a2018-12-13 12:47:51 +0800205 *
206 * @deprecated See {@link NetworkInfo}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800207 */
junyulai3822c8a2018-12-13 12:47:51 +0800208 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800209 public static final String EXTRA_IS_FAILOVER = "isFailover";
210 /**
211 * The lookup key for a {@link NetworkInfo} object. This is supplied when
212 * there is another network that it may be possible to connect to. Retrieve with
213 * {@link android.content.Intent#getParcelableExtra(String)}.
junyulai3822c8a2018-12-13 12:47:51 +0800214 *
215 * @deprecated See {@link NetworkInfo}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800216 */
junyulai3822c8a2018-12-13 12:47:51 +0800217 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800218 public static final String EXTRA_OTHER_NETWORK_INFO = "otherNetwork";
219 /**
220 * The lookup key for a boolean that indicates whether there is a
221 * complete lack of connectivity, i.e., no network is available.
222 * Retrieve it with {@link android.content.Intent#getBooleanExtra(String,boolean)}.
223 */
224 public static final String EXTRA_NO_CONNECTIVITY = "noConnectivity";
225 /**
226 * The lookup key for a string that indicates why an attempt to connect
227 * to a network failed. The string has no particular structure. It is
228 * intended to be used in notifications presented to users. Retrieve
229 * it with {@link android.content.Intent#getStringExtra(String)}.
230 */
231 public static final String EXTRA_REASON = "reason";
232 /**
233 * The lookup key for a string that provides optionally supplied
234 * extra information about the network state. The information
235 * may be passed up from the lower networking layers, and its
236 * meaning may be specific to a particular network type. Retrieve
237 * it with {@link android.content.Intent#getStringExtra(String)}.
junyulai3822c8a2018-12-13 12:47:51 +0800238 *
239 * @deprecated See {@link NetworkInfo#getExtraInfo()}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800240 */
junyulai3822c8a2018-12-13 12:47:51 +0800241 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800242 public static final String EXTRA_EXTRA_INFO = "extraInfo";
Robert Greenwaltd7085fc2010-09-08 15:24:47 -0700243 /**
244 * The lookup key for an int that provides information about
245 * our connection to the internet at large. 0 indicates no connection,
246 * 100 indicates a great connection. Retrieve it with
Jeff Sharkeyc006f1a2011-05-19 17:12:49 -0700247 * {@link android.content.Intent#getIntExtra(String, int)}.
Robert Greenwaltd7085fc2010-09-08 15:24:47 -0700248 * {@hide}
249 */
250 public static final String EXTRA_INET_CONDITION = "inetCondition";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800251 /**
Paul Jensen49e3edf2015-05-22 10:50:39 -0400252 * The lookup key for a {@link CaptivePortal} object included with the
253 * {@link #ACTION_CAPTIVE_PORTAL_SIGN_IN} intent. The {@code CaptivePortal}
254 * object can be used to either indicate to the system that the captive
255 * portal has been dismissed or that the user does not want to pursue
256 * signing in to captive portal. Retrieve it with
257 * {@link android.content.Intent#getParcelableExtra(String)}.
Paul Jensen25a217c2015-02-27 22:55:47 -0500258 */
Paul Jensen49e3edf2015-05-22 10:50:39 -0400259 public static final String EXTRA_CAPTIVE_PORTAL = "android.net.extra.CAPTIVE_PORTAL";
Jan Nordqvist52eb29f2015-09-22 15:54:32 -0700260
261 /**
262 * Key for passing a URL to the captive portal login activity.
263 */
264 public static final String EXTRA_CAPTIVE_PORTAL_URL = "android.net.extra.CAPTIVE_PORTAL_URL";
265
Paul Jensen25a217c2015-02-27 22:55:47 -0500266 /**
Remi NGUYEN VAN8255c2d2018-05-22 10:01:53 +0900267 * Key for passing a {@link android.net.captiveportal.CaptivePortalProbeSpec} to the captive
268 * portal login activity.
269 * {@hide}
270 */
Remi NGUYEN VAN7731c5b2019-01-17 14:38:31 +0900271 @SystemApi
272 @TestApi
Remi NGUYEN VAN8255c2d2018-05-22 10:01:53 +0900273 public static final String EXTRA_CAPTIVE_PORTAL_PROBE_SPEC =
274 "android.net.extra.CAPTIVE_PORTAL_PROBE_SPEC";
275
276 /**
Hugo Benichicdf3ba42016-12-14 08:23:40 +0900277 * Key for passing a user agent string to the captive portal login activity.
278 * {@hide}
279 */
Remi NGUYEN VAN7731c5b2019-01-17 14:38:31 +0900280 @SystemApi
281 @TestApi
Hugo Benichicdf3ba42016-12-14 08:23:40 +0900282 public static final String EXTRA_CAPTIVE_PORTAL_USER_AGENT =
283 "android.net.extra.CAPTIVE_PORTAL_USER_AGENT";
284
285 /**
Haoyu Baidb3c8672012-06-20 14:29:57 -0700286 * Broadcast action to indicate the change of data activity status
287 * (idle or active) on a network in a recent period.
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800288 * The network becomes active when data transmission is started, or
289 * idle if there is no data transmission for a period of time.
Haoyu Baidb3c8672012-06-20 14:29:57 -0700290 * {@hide}
291 */
292 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Chalard Jean4d660112018-06-04 16:52:49 +0900293 public static final String ACTION_DATA_ACTIVITY_CHANGE =
294 "android.net.conn.DATA_ACTIVITY_CHANGE";
Haoyu Baidb3c8672012-06-20 14:29:57 -0700295 /**
296 * The lookup key for an enum that indicates the network device type on which this data activity
297 * change happens.
298 * {@hide}
299 */
300 public static final String EXTRA_DEVICE_TYPE = "deviceType";
301 /**
302 * The lookup key for a boolean that indicates the device is active or not. {@code true} means
303 * it is actively sending or receiving data and {@code false} means it is idle.
304 * {@hide}
305 */
306 public static final String EXTRA_IS_ACTIVE = "isActive";
Ashish Sharma0535a9f2014-03-12 18:42:23 -0700307 /**
308 * The lookup key for a long that contains the timestamp (nanos) of the radio state change.
309 * {@hide}
310 */
311 public static final String EXTRA_REALTIME_NS = "tsNanos";
Haoyu Baidb3c8672012-06-20 14:29:57 -0700312
313 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800314 * Broadcast Action: The setting for background data usage has changed
315 * values. Use {@link #getBackgroundDataSetting()} to get the current value.
316 * <p>
317 * If an application uses the network in the background, it should listen
318 * for this broadcast and stop using the background data if the value is
Jeff Sharkeyc006f1a2011-05-19 17:12:49 -0700319 * {@code false}.
Jeff Sharkey54ee2ad2012-01-30 16:29:24 -0800320 * <p>
321 *
322 * @deprecated As of {@link VERSION_CODES#ICE_CREAM_SANDWICH}, availability
323 * of background data depends on several combined factors, and
324 * this broadcast is no longer sent. Instead, when background
325 * data is unavailable, {@link #getActiveNetworkInfo()} will now
326 * appear disconnected. During first boot after a platform
327 * upgrade, this broadcast will be sent once if
328 * {@link #getBackgroundDataSetting()} was {@code false} before
329 * the upgrade.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800330 */
331 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey54ee2ad2012-01-30 16:29:24 -0800332 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800333 public static final String ACTION_BACKGROUND_DATA_SETTING_CHANGED =
334 "android.net.conn.BACKGROUND_DATA_SETTING_CHANGED";
335
Robert Greenwalt1e9aac22010-09-15 17:36:33 -0700336 /**
337 * Broadcast Action: The network connection may not be good
338 * uses {@code ConnectivityManager.EXTRA_INET_CONDITION} and
339 * {@code ConnectivityManager.EXTRA_NETWORK_INFO} to specify
340 * the network and it's condition.
341 * @hide
342 */
Jeff Sharkey4fa63b22013-02-20 18:21:19 -0800343 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Mathew Inwoodfa3a7462018-08-08 14:52:47 +0100344 @UnsupportedAppUsage
Robert Greenwalt1e9aac22010-09-15 17:36:33 -0700345 public static final String INET_CONDITION_ACTION =
346 "android.net.conn.INET_CONDITION_ACTION";
347
Robert Greenwalt42acef32009-08-12 16:08:25 -0700348 /**
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800349 * Broadcast Action: A tetherable connection has come or gone.
350 * Uses {@code ConnectivityManager.EXTRA_AVAILABLE_TETHER},
Erik Kline8351faa2017-04-17 16:47:23 +0900351 * {@code ConnectivityManager.EXTRA_ACTIVE_LOCAL_ONLY},
352 * {@code ConnectivityManager.EXTRA_ACTIVE_TETHER}, and
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800353 * {@code ConnectivityManager.EXTRA_ERRORED_TETHER} to indicate
354 * the current state of tethering. Each include a list of
355 * interface names in that state (may be empty).
Robert Greenwaltd0e18ff2010-01-26 11:40:34 -0800356 * @hide
357 */
Jeff Sharkey4fa63b22013-02-20 18:21:19 -0800358 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Mathew Inwoodfa3a7462018-08-08 14:52:47 +0100359 @UnsupportedAppUsage
Robert Greenwaltd0e18ff2010-01-26 11:40:34 -0800360 public static final String ACTION_TETHER_STATE_CHANGED =
361 "android.net.conn.TETHER_STATE_CHANGED";
362
363 /**
364 * @hide
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800365 * gives a String[] listing all the interfaces configured for
366 * tethering and currently available for tethering.
Robert Greenwaltd0e18ff2010-01-26 11:40:34 -0800367 */
Mathew Inwoodfa3a7462018-08-08 14:52:47 +0100368 @UnsupportedAppUsage
Robert Greenwalt2a091d72010-02-11 18:18:40 -0800369 public static final String EXTRA_AVAILABLE_TETHER = "availableArray";
Robert Greenwaltd0e18ff2010-01-26 11:40:34 -0800370
371 /**
372 * @hide
Erik Kline8351faa2017-04-17 16:47:23 +0900373 * gives a String[] listing all the interfaces currently in local-only
374 * mode (ie, has DHCPv4+IPv6-ULA support and no packet forwarding)
Robert Greenwaltd0e18ff2010-01-26 11:40:34 -0800375 */
Erik Kline8351faa2017-04-17 16:47:23 +0900376 public static final String EXTRA_ACTIVE_LOCAL_ONLY = "localOnlyArray";
377
378 /**
379 * @hide
380 * gives a String[] listing all the interfaces currently tethered
381 * (ie, has DHCPv4 support and packets potentially forwarded/NATed)
382 */
Mathew Inwoodfa3a7462018-08-08 14:52:47 +0100383 @UnsupportedAppUsage
Erik Kline8351faa2017-04-17 16:47:23 +0900384 public static final String EXTRA_ACTIVE_TETHER = "tetherArray";
Robert Greenwalt2a091d72010-02-11 18:18:40 -0800385
386 /**
387 * @hide
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800388 * gives a String[] listing all the interfaces we tried to tether and
389 * failed. Use {@link #getLastTetherError} to find the error code
390 * for any interfaces listed here.
Robert Greenwalt2a091d72010-02-11 18:18:40 -0800391 */
Mathew Inwoodfa3a7462018-08-08 14:52:47 +0100392 @UnsupportedAppUsage
Robert Greenwalt2a091d72010-02-11 18:18:40 -0800393 public static final String EXTRA_ERRORED_TETHER = "erroredArray";
Robert Greenwaltd0e18ff2010-01-26 11:40:34 -0800394
395 /**
Russell Brenner108da0c2013-02-12 10:03:14 -0800396 * Broadcast Action: The captive portal tracker has finished its test.
397 * Sent only while running Setup Wizard, in lieu of showing a user
398 * notification.
399 * @hide
400 */
Jeff Sharkey4fa63b22013-02-20 18:21:19 -0800401 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Russell Brenner108da0c2013-02-12 10:03:14 -0800402 public static final String ACTION_CAPTIVE_PORTAL_TEST_COMPLETED =
403 "android.net.conn.CAPTIVE_PORTAL_TEST_COMPLETED";
404 /**
405 * The lookup key for a boolean that indicates whether a captive portal was detected.
406 * Retrieve it with {@link android.content.Intent#getBooleanExtra(String,boolean)}.
407 * @hide
408 */
409 public static final String EXTRA_IS_CAPTIVE_PORTAL = "captivePortal";
410
411 /**
Lorenzo Colittie03c3c72015-04-03 16:38:52 +0900412 * Action used to display a dialog that asks the user whether to connect to a network that is
413 * not validated. This intent is used to start the dialog in settings via startActivity.
414 *
415 * @hide
416 */
417 public static final String ACTION_PROMPT_UNVALIDATED = "android.net.conn.PROMPT_UNVALIDATED";
418
419 /**
Lorenzo Colitti9be58c52016-09-15 14:02:29 +0900420 * Action used to display a dialog that asks the user whether to avoid a network that is no
421 * longer validated. This intent is used to start the dialog in settings via startActivity.
422 *
423 * @hide
424 */
425 public static final String ACTION_PROMPT_LOST_VALIDATION =
426 "android.net.conn.PROMPT_LOST_VALIDATION";
427
428 /**
Jeremy Klein36c7aa02016-01-22 14:11:45 -0800429 * Invalid tethering type.
Chalard Jean4d660112018-06-04 16:52:49 +0900430 * @see #startTethering(int, boolean, OnStartTetheringCallback)
Jeremy Klein36c7aa02016-01-22 14:11:45 -0800431 * @hide
432 */
433 public static final int TETHERING_INVALID = -1;
434
435 /**
436 * Wifi tethering type.
Chalard Jean4d660112018-06-04 16:52:49 +0900437 * @see #startTethering(int, boolean, OnStartTetheringCallback)
Jeremy Klein36c7aa02016-01-22 14:11:45 -0800438 * @hide
439 */
440 @SystemApi
441 public static final int TETHERING_WIFI = 0;
442
443 /**
444 * USB tethering type.
Chalard Jean4d660112018-06-04 16:52:49 +0900445 * @see #startTethering(int, boolean, OnStartTetheringCallback)
Jeremy Klein36c7aa02016-01-22 14:11:45 -0800446 * @hide
447 */
448 @SystemApi
449 public static final int TETHERING_USB = 1;
450
451 /**
452 * Bluetooth tethering type.
Chalard Jean4d660112018-06-04 16:52:49 +0900453 * @see #startTethering(int, boolean, OnStartTetheringCallback)
Jeremy Klein36c7aa02016-01-22 14:11:45 -0800454 * @hide
455 */
456 @SystemApi
457 public static final int TETHERING_BLUETOOTH = 2;
458
459 /**
460 * Extra used for communicating with the TetherService. Includes the type of tethering to
461 * enable if any.
462 * @hide
463 */
464 public static final String EXTRA_ADD_TETHER_TYPE = "extraAddTetherType";
465
466 /**
467 * Extra used for communicating with the TetherService. Includes the type of tethering for
468 * which to cancel provisioning.
469 * @hide
470 */
471 public static final String EXTRA_REM_TETHER_TYPE = "extraRemTetherType";
472
473 /**
474 * Extra used for communicating with the TetherService. True to schedule a recheck of tether
475 * provisioning.
476 * @hide
477 */
478 public static final String EXTRA_SET_ALARM = "extraSetAlarm";
479
480 /**
481 * Tells the TetherService to run a provision check now.
482 * @hide
483 */
484 public static final String EXTRA_RUN_PROVISION = "extraRunProvision";
485
486 /**
487 * Extra used for communicating with the TetherService. Contains the {@link ResultReceiver}
488 * which will receive provisioning results. Can be left empty.
489 * @hide
490 */
491 public static final String EXTRA_PROVISION_CALLBACK = "extraProvisionCallback";
492
493 /**
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800494 * The absence of a connection type.
Robert Greenwaltccf83af12011-06-02 17:30:47 -0700495 * @hide
496 */
Mathew Inwoodfa3a7462018-08-08 14:52:47 +0100497 @UnsupportedAppUsage
Robert Greenwaltccf83af12011-06-02 17:30:47 -0700498 public static final int TYPE_NONE = -1;
499
500 /**
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900501 * A Mobile data connection. Devices may support more than one.
502 *
503 * @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or
504 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an
505 * appropriate network. {@see NetworkCapabilities} for supported transports.
Robert Greenwalt42acef32009-08-12 16:08:25 -0700506 */
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900507 @Deprecated
Robert Greenwalt42acef32009-08-12 16:08:25 -0700508 public static final int TYPE_MOBILE = 0;
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900509
Robert Greenwalt42acef32009-08-12 16:08:25 -0700510 /**
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900511 * A WIFI data connection. Devices may support more than one.
512 *
513 * @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or
514 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an
515 * appropriate network. {@see NetworkCapabilities} for supported transports.
Robert Greenwalt42acef32009-08-12 16:08:25 -0700516 */
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900517 @Deprecated
Robert Greenwalt42acef32009-08-12 16:08:25 -0700518 public static final int TYPE_WIFI = 1;
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900519
Robert Greenwalt42acef32009-08-12 16:08:25 -0700520 /**
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800521 * An MMS-specific Mobile data connection. This network type may use the
522 * same network interface as {@link #TYPE_MOBILE} or it may use a different
523 * one. This is used by applications needing to talk to the carrier's
524 * Multimedia Messaging Service servers.
Lorenzo Colittie285b432015-04-23 15:32:42 +0900525 *
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900526 * @deprecated Applications should instead use {@link NetworkCapabilities#hasCapability} or
Lorenzo Colitti2ea89e52015-04-24 17:03:31 +0900527 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request a network that
Lorenzo Colittie285b432015-04-23 15:32:42 +0900528 * provides the {@link NetworkCapabilities#NET_CAPABILITY_MMS} capability.
Robert Greenwalt42acef32009-08-12 16:08:25 -0700529 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -0700530 @Deprecated
Robert Greenwalt42acef32009-08-12 16:08:25 -0700531 public static final int TYPE_MOBILE_MMS = 2;
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900532
Robert Greenwalt42acef32009-08-12 16:08:25 -0700533 /**
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800534 * A SUPL-specific Mobile data connection. This network type may use the
535 * same network interface as {@link #TYPE_MOBILE} or it may use a different
536 * one. This is used by applications needing to talk to the carrier's
537 * Secure User Plane Location servers for help locating the device.
Lorenzo Colittie285b432015-04-23 15:32:42 +0900538 *
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900539 * @deprecated Applications should instead use {@link NetworkCapabilities#hasCapability} or
Lorenzo Colitti2ea89e52015-04-24 17:03:31 +0900540 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request a network that
Lorenzo Colittie285b432015-04-23 15:32:42 +0900541 * provides the {@link NetworkCapabilities#NET_CAPABILITY_SUPL} capability.
Robert Greenwalt42acef32009-08-12 16:08:25 -0700542 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -0700543 @Deprecated
Robert Greenwalt42acef32009-08-12 16:08:25 -0700544 public static final int TYPE_MOBILE_SUPL = 3;
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900545
Robert Greenwalt42acef32009-08-12 16:08:25 -0700546 /**
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800547 * A DUN-specific Mobile data connection. This network type may use the
548 * same network interface as {@link #TYPE_MOBILE} or it may use a different
549 * one. This is sometimes by the system when setting up an upstream connection
550 * for tethering so that the carrier is aware of DUN traffic.
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900551 *
552 * @deprecated Applications should instead use {@link NetworkCapabilities#hasCapability} or
553 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request a network that
554 * provides the {@link NetworkCapabilities#NET_CAPABILITY_DUN} capability.
Robert Greenwalt42acef32009-08-12 16:08:25 -0700555 */
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900556 @Deprecated
Robert Greenwalt42acef32009-08-12 16:08:25 -0700557 public static final int TYPE_MOBILE_DUN = 4;
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900558
Robert Greenwalt42acef32009-08-12 16:08:25 -0700559 /**
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800560 * A High Priority Mobile data connection. This network type uses the
561 * same network interface as {@link #TYPE_MOBILE} but the routing setup
Lorenzo Colittie285b432015-04-23 15:32:42 +0900562 * is different.
563 *
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900564 * @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 Greenwalt42acef32009-08-12 16:08:25 -0700567 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -0700568 @Deprecated
Robert Greenwalt42acef32009-08-12 16:08:25 -0700569 public static final int TYPE_MOBILE_HIPRI = 5;
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900570
jsh8214deb2010-03-11 15:04:43 -0800571 /**
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900572 * A WiMAX data connection.
573 *
574 * @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or
575 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an
576 * appropriate network. {@see NetworkCapabilities} for supported transports.
jsh8214deb2010-03-11 15:04:43 -0800577 */
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900578 @Deprecated
jsh8214deb2010-03-11 15:04:43 -0800579 public static final int TYPE_WIMAX = 6;
Robert Greenwaltda3d5e62010-12-06 13:56:24 -0800580
Jaikumar Ganesh15c74392010-12-21 22:31:44 -0800581 /**
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900582 * A Bluetooth data connection.
583 *
584 * @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or
585 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an
586 * appropriate network. {@see NetworkCapabilities} for supported transports.
Jaikumar Ganesh15c74392010-12-21 22:31:44 -0800587 */
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900588 @Deprecated
Jaikumar Ganesh15c74392010-12-21 22:31:44 -0800589 public static final int TYPE_BLUETOOTH = 7;
590
Robert Greenwalt60810842011-04-22 15:28:18 -0700591 /**
592 * Dummy data connection. This should not be used on shipping devices.
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900593 * @deprecated This is not used any more.
Robert Greenwalt60810842011-04-22 15:28:18 -0700594 */
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900595 @Deprecated
Jaikumar Ganesh15c74392010-12-21 22:31:44 -0800596 public static final int TYPE_DUMMY = 8;
Wink Saville9d7d6282011-03-12 14:52:01 -0800597
Robert Greenwalt60810842011-04-22 15:28:18 -0700598 /**
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900599 * An Ethernet data connection.
600 *
601 * @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or
602 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an
603 * appropriate network. {@see NetworkCapabilities} for supported transports.
Robert Greenwalt60810842011-04-22 15:28:18 -0700604 */
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900605 @Deprecated
Robert Greenwalte12aec92011-01-28 14:48:37 -0800606 public static final int TYPE_ETHERNET = 9;
Robert Greenwalt60810842011-04-22 15:28:18 -0700607
Wink Saville9d7d6282011-03-12 14:52:01 -0800608 /**
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800609 * Over the air Administration.
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900610 * @deprecated Use {@link NetworkCapabilities} instead.
Wink Saville9d7d6282011-03-12 14:52:01 -0800611 * {@hide}
612 */
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900613 @Deprecated
Mathew Inwoodfa3a7462018-08-08 14:52:47 +0100614 @UnsupportedAppUsage
Wink Saville9d7d6282011-03-12 14:52:01 -0800615 public static final int TYPE_MOBILE_FOTA = 10;
616
617 /**
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800618 * IP Multimedia Subsystem.
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900619 * @deprecated Use {@link NetworkCapabilities#NET_CAPABILITY_IMS} instead.
Wink Saville9d7d6282011-03-12 14:52:01 -0800620 * {@hide}
621 */
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900622 @Deprecated
Mathew Inwoodfa3a7462018-08-08 14:52:47 +0100623 @UnsupportedAppUsage
Wink Saville9d7d6282011-03-12 14:52:01 -0800624 public static final int TYPE_MOBILE_IMS = 11;
625
626 /**
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800627 * Carrier Branded Services.
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900628 * @deprecated Use {@link NetworkCapabilities#NET_CAPABILITY_CBS} instead.
Wink Saville9d7d6282011-03-12 14:52:01 -0800629 * {@hide}
630 */
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900631 @Deprecated
Mathew Inwoodfa3a7462018-08-08 14:52:47 +0100632 @UnsupportedAppUsage
Wink Saville9d7d6282011-03-12 14:52:01 -0800633 public static final int TYPE_MOBILE_CBS = 12;
634
repo syncaea743a2011-07-29 23:55:49 -0700635 /**
636 * A Wi-Fi p2p connection. Only requesting processes will have access to
637 * the peers connected.
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900638 * @deprecated Use {@link NetworkCapabilities#NET_CAPABILITY_WIFI_P2P} instead.
repo syncaea743a2011-07-29 23:55:49 -0700639 * {@hide}
640 */
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900641 @Deprecated
Mathew Inwoodfa3a7462018-08-08 14:52:47 +0100642 @UnsupportedAppUsage
repo syncaea743a2011-07-29 23:55:49 -0700643 public static final int TYPE_WIFI_P2P = 13;
Wink Saville9d7d6282011-03-12 14:52:01 -0800644
Wink Saville5e56bc52013-07-29 15:00:57 -0700645 /**
646 * The network to use for initially attaching to the network
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900647 * @deprecated Use {@link NetworkCapabilities#NET_CAPABILITY_IA} instead.
Wink Saville5e56bc52013-07-29 15:00:57 -0700648 * {@hide}
649 */
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900650 @Deprecated
Mathew Inwoodfa3a7462018-08-08 14:52:47 +0100651 @UnsupportedAppUsage
Wink Saville5e56bc52013-07-29 15:00:57 -0700652 public static final int TYPE_MOBILE_IA = 14;
repo syncaea743a2011-07-29 23:55:49 -0700653
Lorenzo Colittie285b432015-04-23 15:32:42 +0900654 /**
Robert Greenwalt4bd43892015-07-09 14:49:35 -0700655 * Emergency PDN connection for emergency services. This
656 * may include IMS and MMS in emergency situations.
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900657 * @deprecated Use {@link NetworkCapabilities#NET_CAPABILITY_EIMS} instead.
Ram3e0e3bc2014-06-26 11:03:44 -0700658 * {@hide}
659 */
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900660 @Deprecated
Mathew Inwoodfa3a7462018-08-08 14:52:47 +0100661 @UnsupportedAppUsage
Ram3e0e3bc2014-06-26 11:03:44 -0700662 public static final int TYPE_MOBILE_EMERGENCY = 15;
663
Hui Lu1c5624a2014-01-15 11:05:36 -0500664 /**
665 * The network that uses proxy to achieve connectivity.
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900666 * @deprecated Use {@link NetworkCapabilities} instead.
Hui Lu1c5624a2014-01-15 11:05:36 -0500667 * {@hide}
668 */
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900669 @Deprecated
Mathew Inwoodfa3a7462018-08-08 14:52:47 +0100670 @UnsupportedAppUsage
Hui Lu1c5624a2014-01-15 11:05:36 -0500671 public static final int TYPE_PROXY = 16;
Wink Saville5e56bc52013-07-29 15:00:57 -0700672
Robert Greenwalt8283f882014-07-07 17:09:01 -0700673 /**
674 * A virtual network using one or more native bearers.
675 * It may or may not be providing security services.
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900676 * @deprecated Applications should use {@link NetworkCapabilities#TRANSPORT_VPN} instead.
Robert Greenwalt8283f882014-07-07 17:09:01 -0700677 */
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900678 @Deprecated
Robert Greenwalt8283f882014-07-07 17:09:01 -0700679 public static final int TYPE_VPN = 17;
Hui Lu1c5624a2014-01-15 11:05:36 -0500680
Benedict Wong89ce5e32018-11-14 17:40:55 -0800681 /**
682 * A network that is exclusively meant to be used for testing
683 *
684 * @deprecated Use {@link NetworkCapabilities} instead.
685 * @hide
686 */
687 @Deprecated
688 public static final int TYPE_TEST = 18; // TODO: Remove this once NetworkTypes are unused.
Robert Greenwalt8283f882014-07-07 17:09:01 -0700689
690 /** {@hide} */
Benedict Wong89ce5e32018-11-14 17:40:55 -0800691 public static final int MAX_RADIO_TYPE = TYPE_TEST;
692
693 /** {@hide} */
694 public static final int MAX_NETWORK_TYPE = TYPE_TEST;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800695
Hugo Benichi16f0a942017-06-20 14:07:59 +0900696 private static final int MIN_NETWORK_TYPE = TYPE_MOBILE;
697
Jianzheng Zhoudcf03f32012-11-16 13:45:20 +0800698 /**
699 * If you want to set the default network preference,you can directly
700 * change the networkAttributes array in framework's config.xml.
701 *
702 * @deprecated Since we support so many more networks now, the single
703 * network default network preference can't really express
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800704 * the hierarchy. Instead, the default is defined by the
Jianzheng Zhoudcf03f32012-11-16 13:45:20 +0800705 * networkAttributes in config.xml. You can determine
Robert Greenwalt4c8b7482012-12-07 09:56:50 -0800706 * the current value by calling {@link #getNetworkPreference()}
Jianzheng Zhoudcf03f32012-11-16 13:45:20 +0800707 * from an App.
708 */
709 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800710 public static final int DEFAULT_NETWORK_PREFERENCE = TYPE_WIFI;
711
Jeff Sharkey625239a2012-09-26 22:03:49 -0700712 /**
Robert Greenwalt9ba9c582014-03-19 17:56:12 -0700713 * @hide
714 */
Hugo Benichia5c1f7f2017-06-20 14:10:14 +0900715 public static final int REQUEST_ID_UNSET = 0;
Robert Greenwalt7569f182014-06-08 16:42:59 -0700716
Paul Jensen5d59e782014-07-11 12:28:19 -0400717 /**
Hugo Benichi31c176d2017-06-17 13:14:12 +0900718 * Static unique request used as a tombstone for NetworkCallbacks that have been unregistered.
719 * This allows to distinguish when unregistering NetworkCallbacks those that were never
Chalard Jean4d660112018-06-04 16:52:49 +0900720 * registered from those that were already unregistered.
Hugo Benichi31c176d2017-06-17 13:14:12 +0900721 * @hide
722 */
Hugo Benichia5c1f7f2017-06-20 14:10:14 +0900723 private static final NetworkRequest ALREADY_UNREGISTERED =
Hugo Benichi31c176d2017-06-17 13:14:12 +0900724 new NetworkRequest.Builder().clearCapabilities().build();
725
726 /**
Paul Jensen5d59e782014-07-11 12:28:19 -0400727 * A NetID indicating no Network is selected.
728 * Keep in sync with bionic/libc/dns/include/resolv_netid.h
729 * @hide
730 */
731 public static final int NETID_UNSET = 0;
732
Erik Kline4d092232017-10-30 15:29:44 +0900733 /**
734 * Private DNS Mode values.
735 *
736 * The "private_dns_mode" global setting stores a String value which is
737 * expected to be one of the following.
738 */
739
740 /**
741 * @hide
742 */
743 public static final String PRIVATE_DNS_MODE_OFF = "off";
744 /**
745 * @hide
746 */
747 public static final String PRIVATE_DNS_MODE_OPPORTUNISTIC = "opportunistic";
748 /**
749 * @hide
750 */
751 public static final String PRIVATE_DNS_MODE_PROVIDER_HOSTNAME = "hostname";
752 /**
753 * The default Private DNS mode.
754 *
755 * This may change from release to release or may become dependent upon
756 * the capabilities of the underlying platform.
757 *
758 * @hide
759 */
Erik Kline19841792018-05-16 16:41:57 +0900760 public static final String PRIVATE_DNS_DEFAULT_MODE_FALLBACK = PRIVATE_DNS_MODE_OPPORTUNISTIC;
Erik Kline4d092232017-10-30 15:29:44 +0900761
Mathew Inwoodfa3a7462018-08-08 14:52:47 +0100762 @UnsupportedAppUsage
Jeff Sharkeyc006f1a2011-05-19 17:12:49 -0700763 private final IConnectivityManager mService;
Paul Jensene0bef712014-12-10 15:12:18 -0500764 /**
765 * A kludge to facilitate static access where a Context pointer isn't available, like in the
766 * case of the static set/getProcessDefaultNetwork methods and from the Network class.
767 * TODO: Remove this after deprecating the static methods in favor of non-static methods or
768 * methods that take a Context argument.
769 */
770 private static ConnectivityManager sInstance;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800771
Lorenzo Colittiffc42b02015-07-29 11:41:21 +0900772 private final Context mContext;
773
Dianne Hackborn77b987f2014-02-26 16:20:52 -0800774 private INetworkManagementService mNMService;
Felipe Leme1b103232016-01-22 09:44:57 -0800775 private INetworkPolicyManager mNPManager;
Dianne Hackborn77b987f2014-02-26 16:20:52 -0800776
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800777 /**
778 * Tests if a given integer represents a valid network type.
779 * @param networkType the type to be tested
780 * @return a boolean. {@code true} if the type is valid, else {@code false}
Paul Jensen9e59e122015-05-06 10:42:25 -0400781 * @deprecated All APIs accepting a network type are deprecated. There should be no need to
782 * validate a network type.
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800783 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -0700784 @Deprecated
Jeff Sharkeyd2a45872011-05-28 20:56:34 -0700785 public static boolean isNetworkTypeValid(int networkType) {
Hugo Benichi16f0a942017-06-20 14:07:59 +0900786 return MIN_NETWORK_TYPE <= networkType && networkType <= MAX_NETWORK_TYPE;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800787 }
788
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800789 /**
790 * Returns a non-localized string representing a given network type.
791 * ONLY used for debugging output.
792 * @param type the type needing naming
793 * @return a String for the given type, or a string version of the type ("87")
794 * if no name is known.
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900795 * @deprecated Types are deprecated. Use {@link NetworkCapabilities} instead.
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800796 * {@hide}
797 */
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900798 @Deprecated
Mathew Inwoodfa3a7462018-08-08 14:52:47 +0100799 @UnsupportedAppUsage
Jeff Sharkeyd2a45872011-05-28 20:56:34 -0700800 public static String getNetworkTypeName(int type) {
801 switch (type) {
Hugo Benichi16f0a942017-06-20 14:07:59 +0900802 case TYPE_NONE:
803 return "NONE";
Jeff Sharkeyd2a45872011-05-28 20:56:34 -0700804 case TYPE_MOBILE:
805 return "MOBILE";
806 case TYPE_WIFI:
807 return "WIFI";
808 case TYPE_MOBILE_MMS:
809 return "MOBILE_MMS";
810 case TYPE_MOBILE_SUPL:
811 return "MOBILE_SUPL";
812 case TYPE_MOBILE_DUN:
813 return "MOBILE_DUN";
814 case TYPE_MOBILE_HIPRI:
815 return "MOBILE_HIPRI";
816 case TYPE_WIMAX:
817 return "WIMAX";
818 case TYPE_BLUETOOTH:
819 return "BLUETOOTH";
820 case TYPE_DUMMY:
821 return "DUMMY";
822 case TYPE_ETHERNET:
823 return "ETHERNET";
824 case TYPE_MOBILE_FOTA:
825 return "MOBILE_FOTA";
826 case TYPE_MOBILE_IMS:
827 return "MOBILE_IMS";
828 case TYPE_MOBILE_CBS:
829 return "MOBILE_CBS";
repo syncaea743a2011-07-29 23:55:49 -0700830 case TYPE_WIFI_P2P:
831 return "WIFI_P2P";
Wink Saville5e56bc52013-07-29 15:00:57 -0700832 case TYPE_MOBILE_IA:
833 return "MOBILE_IA";
Ram3e0e3bc2014-06-26 11:03:44 -0700834 case TYPE_MOBILE_EMERGENCY:
835 return "MOBILE_EMERGENCY";
Hui Lu1c5624a2014-01-15 11:05:36 -0500836 case TYPE_PROXY:
837 return "PROXY";
Erik Kline37fbfa12014-11-19 17:23:41 +0900838 case TYPE_VPN:
839 return "VPN";
Jeff Sharkeyd2a45872011-05-28 20:56:34 -0700840 default:
841 return Integer.toString(type);
842 }
843 }
844
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800845 /**
846 * Checks if a given type uses the cellular data connection.
847 * This should be replaced in the future by a network property.
848 * @param networkType the type to check
849 * @return a boolean - {@code true} if uses cellular network, else {@code false}
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900850 * @deprecated Types are deprecated. Use {@link NetworkCapabilities} instead.
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800851 * {@hide}
852 */
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900853 @Deprecated
Mathew Inwoodfa3a7462018-08-08 14:52:47 +0100854 @UnsupportedAppUsage
Jeff Sharkeyd2a45872011-05-28 20:56:34 -0700855 public static boolean isNetworkTypeMobile(int networkType) {
856 switch (networkType) {
857 case TYPE_MOBILE:
858 case TYPE_MOBILE_MMS:
859 case TYPE_MOBILE_SUPL:
860 case TYPE_MOBILE_DUN:
861 case TYPE_MOBILE_HIPRI:
862 case TYPE_MOBILE_FOTA:
863 case TYPE_MOBILE_IMS:
864 case TYPE_MOBILE_CBS:
Wink Saville5e56bc52013-07-29 15:00:57 -0700865 case TYPE_MOBILE_IA:
Ram3e0e3bc2014-06-26 11:03:44 -0700866 case TYPE_MOBILE_EMERGENCY:
Jeff Sharkeyd2a45872011-05-28 20:56:34 -0700867 return true;
868 default:
869 return false;
870 }
871 }
872
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800873 /**
Jeff Sharkey7a1c3fc2013-06-04 12:29:00 -0700874 * Checks if the given network type is backed by a Wi-Fi radio.
875 *
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900876 * @deprecated Types are deprecated. Use {@link NetworkCapabilities} instead.
Jeff Sharkey7a1c3fc2013-06-04 12:29:00 -0700877 * @hide
878 */
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900879 @Deprecated
Jeff Sharkey7a1c3fc2013-06-04 12:29:00 -0700880 public static boolean isNetworkTypeWifi(int networkType) {
881 switch (networkType) {
882 case TYPE_WIFI:
883 case TYPE_WIFI_P2P:
884 return true;
885 default:
886 return false;
887 }
888 }
889
890 /**
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800891 * Specifies the preferred network type. When the device has more
892 * than one type available the preferred network type will be used.
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800893 *
894 * @param preference the network type to prefer over all others. It is
895 * unspecified what happens to the old preferred network in the
896 * overall ordering.
Robert Greenwaltd19c41c2014-05-18 23:07:25 -0700897 * @deprecated Functionality has been removed as it no longer makes sense,
898 * with many more than two networks - we'd need an array to express
899 * preference. Instead we use dynamic network properties of
900 * the networks to describe their precedence.
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800901 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -0700902 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800903 public void setNetworkPreference(int preference) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800904 }
905
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800906 /**
907 * Retrieves the current preferred network type.
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800908 *
909 * @return an integer representing the preferred network type
910 *
Robert Greenwaltd19c41c2014-05-18 23:07:25 -0700911 * @deprecated Functionality has been removed as it no longer makes sense,
912 * with many more than two networks - we'd need an array to express
913 * preference. Instead we use dynamic network properties of
914 * the networks to describe their precedence.
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800915 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -0700916 @Deprecated
Jeff Sharkey30e06bb2017-04-24 11:18:03 -0600917 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800918 public int getNetworkPreference() {
Robert Greenwaltd19c41c2014-05-18 23:07:25 -0700919 return TYPE_NONE;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800920 }
921
Scott Main671644c2011-10-06 19:02:28 -0700922 /**
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800923 * Returns details about the currently active default data network. When
924 * connected, this network is the default route for outgoing connections.
925 * You should always check {@link NetworkInfo#isConnected()} before initiating
926 * network traffic. This may return {@code null} when there is no default
927 * network.
Chalard Jean5a041d12018-03-29 17:45:24 +0900928 * Note that if the default network is a VPN, this method will return the
929 * NetworkInfo for one of its underlying networks instead, or null if the
930 * VPN agent did not specify any. Apps interested in learning about VPNs
931 * should use {@link #getNetworkInfo(android.net.Network)} instead.
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800932 *
933 * @return a {@link NetworkInfo} object for the current default network
Paul Jensen0d719ca2015-02-13 14:18:39 -0500934 * or {@code null} if no default network is currently active
junyulai3822c8a2018-12-13 12:47:51 +0800935 * @deprecated See {@link NetworkInfo}.
Jeff Sharkey9f7cbf02012-04-12 18:34:54 -0700936 */
junyulai3822c8a2018-12-13 12:47:51 +0800937 @Deprecated
Jeff Sharkey30e06bb2017-04-24 11:18:03 -0600938 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean50bea3d2019-01-07 19:26:34 +0900939 @Nullable
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800940 public NetworkInfo getActiveNetworkInfo() {
941 try {
942 return mService.getActiveNetworkInfo();
943 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -0700944 throw e.rethrowFromSystemServer();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800945 }
946 }
947
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800948 /**
Paul Jensen31a94f42015-02-13 14:18:39 -0500949 * Returns a {@link Network} object corresponding to the currently active
950 * default data network. In the event that the current active default data
951 * network disconnects, the returned {@code Network} object will no longer
952 * be usable. This will return {@code null} when there is no default
953 * network.
954 *
955 * @return a {@link Network} object for the current default network or
956 * {@code null} if no default network is currently active
Paul Jensen31a94f42015-02-13 14:18:39 -0500957 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -0600958 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean50bea3d2019-01-07 19:26:34 +0900959 @Nullable
Paul Jensen31a94f42015-02-13 14:18:39 -0500960 public Network getActiveNetwork() {
961 try {
962 return mService.getActiveNetwork();
963 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -0700964 throw e.rethrowFromSystemServer();
Paul Jensen31a94f42015-02-13 14:18:39 -0500965 }
966 }
967
968 /**
Robin Leed2baf792016-03-24 12:07:00 +0000969 * Returns a {@link Network} object corresponding to the currently active
970 * default data network for a specific UID. In the event that the default data
971 * network disconnects, the returned {@code Network} object will no longer
972 * be usable. This will return {@code null} when there is no default
973 * network for the UID.
Robin Leed2baf792016-03-24 12:07:00 +0000974 *
975 * @return a {@link Network} object for the current default network for the
976 * given UID or {@code null} if no default network is currently active
977 *
978 * @hide
979 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -0600980 @RequiresPermission(android.Manifest.permission.CONNECTIVITY_INTERNAL)
Chalard Jean50bea3d2019-01-07 19:26:34 +0900981 @Nullable
Robin Leed2baf792016-03-24 12:07:00 +0000982 public Network getActiveNetworkForUid(int uid) {
Jeff Sharkey1b6519b2016-04-28 15:33:18 -0600983 return getActiveNetworkForUid(uid, false);
984 }
985
986 /** {@hide} */
987 public Network getActiveNetworkForUid(int uid, boolean ignoreBlocked) {
Robin Leed2baf792016-03-24 12:07:00 +0000988 try {
Jeff Sharkey1b6519b2016-04-28 15:33:18 -0600989 return mService.getActiveNetworkForUid(uid, ignoreBlocked);
Robin Leed2baf792016-03-24 12:07:00 +0000990 } catch (RemoteException e) {
991 throw e.rethrowFromSystemServer();
992 }
993 }
994
995 /**
Charles He36738632017-05-15 17:07:18 +0100996 * Checks if a VPN app supports always-on mode.
997 *
998 * In order to support the always-on feature, an app has to
999 * <ul>
1000 * <li>target {@link VERSION_CODES#N API 24} or above, and
Charles Hec57a01c2017-08-15 15:30:22 +01001001 * <li>not opt out through the {@link VpnService#SERVICE_META_DATA_SUPPORTS_ALWAYS_ON}
1002 * meta-data field.
Charles He36738632017-05-15 17:07:18 +01001003 * </ul>
1004 *
1005 * @param userId The identifier of the user for whom the VPN app is installed.
1006 * @param vpnPackage The canonical package name of the VPN app.
1007 * @return {@code true} if and only if the VPN app exists and supports always-on mode.
1008 * @hide
1009 */
1010 public boolean isAlwaysOnVpnPackageSupportedForUser(int userId, @Nullable String vpnPackage) {
1011 try {
1012 return mService.isAlwaysOnVpnPackageSupported(userId, vpnPackage);
1013 } catch (RemoteException e) {
1014 throw e.rethrowFromSystemServer();
1015 }
1016 }
1017
1018 /**
Robin Lee244ce8e2016-01-05 18:03:46 +00001019 * Configures an always-on VPN connection through a specific application.
1020 * This connection is automatically granted and persisted after a reboot.
1021 *
1022 * <p>The designated package should declare a {@link VpnService} in its
1023 * manifest guarded by {@link android.Manifest.permission.BIND_VPN_SERVICE},
1024 * otherwise the call will fail.
1025 *
1026 * @param userId The identifier of the user to set an always-on VPN for.
1027 * @param vpnPackage The package name for an installed VPN app on the device, or {@code null}
1028 * to remove an existing always-on VPN configuration.
Robin Leedc679712016-05-03 13:23:03 +01001029 * @param lockdownEnabled {@code true} to disallow networking when the VPN is not connected or
1030 * {@code false} otherwise.
Pavel Grafova462bcb2019-01-25 08:50:06 +00001031 * @param lockdownWhitelist The list of packages that are allowed to access network directly
1032 * when VPN is in lockdown mode but is not running. Non-existent packages are ignored so
1033 * this method must be called when a package that should be whitelisted is installed or
1034 * uninstalled.
Robin Lee244ce8e2016-01-05 18:03:46 +00001035 * @return {@code true} if the package is set as always-on VPN controller;
1036 * {@code false} otherwise.
1037 * @hide
1038 */
Pavel Grafova462bcb2019-01-25 08:50:06 +00001039 @RequiresPermission(android.Manifest.permission.CONTROL_ALWAYS_ON_VPN)
Robin Leedc679712016-05-03 13:23:03 +01001040 public boolean setAlwaysOnVpnPackageForUser(int userId, @Nullable String vpnPackage,
Pavel Grafova462bcb2019-01-25 08:50:06 +00001041 boolean lockdownEnabled, @Nullable List<String> lockdownWhitelist) {
Robin Lee244ce8e2016-01-05 18:03:46 +00001042 try {
Pavel Grafova462bcb2019-01-25 08:50:06 +00001043 return mService.setAlwaysOnVpnPackage(
1044 userId, vpnPackage, lockdownEnabled, lockdownWhitelist);
Robin Lee244ce8e2016-01-05 18:03:46 +00001045 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07001046 throw e.rethrowFromSystemServer();
Robin Lee244ce8e2016-01-05 18:03:46 +00001047 }
1048 }
1049
Pavel Grafova462bcb2019-01-25 08:50:06 +00001050 /**
Robin Lee244ce8e2016-01-05 18:03:46 +00001051 * Returns the package name of the currently set always-on VPN application.
1052 * If there is no always-on VPN set, or the VPN is provided by the system instead
1053 * of by an app, {@code null} will be returned.
1054 *
1055 * @return Package name of VPN controller responsible for always-on VPN,
1056 * or {@code null} if none is set.
1057 * @hide
1058 */
Pavel Grafova462bcb2019-01-25 08:50:06 +00001059 @RequiresPermission(android.Manifest.permission.CONTROL_ALWAYS_ON_VPN)
Robin Lee244ce8e2016-01-05 18:03:46 +00001060 public String getAlwaysOnVpnPackageForUser(int userId) {
1061 try {
1062 return mService.getAlwaysOnVpnPackage(userId);
1063 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07001064 throw e.rethrowFromSystemServer();
Robin Lee244ce8e2016-01-05 18:03:46 +00001065 }
1066 }
1067
1068 /**
Pavel Grafova462bcb2019-01-25 08:50:06 +00001069 * @return whether always-on VPN is in lockdown mode.
1070 *
1071 * @hide
1072 **/
1073 @RequiresPermission(android.Manifest.permission.CONTROL_ALWAYS_ON_VPN)
1074 public boolean isVpnLockdownEnabled(int userId) {
1075 try {
1076 return mService.isVpnLockdownEnabled(userId);
1077 } catch (RemoteException e) {
1078 throw e.rethrowFromSystemServer();
1079 }
1080
1081 }
1082
1083 /**
1084 * @return the list of packages that are allowed to access network when always-on VPN is in
1085 * lockdown mode but not connected. Returns {@code null} when VPN lockdown is not active.
1086 *
1087 * @hide
1088 **/
1089 @RequiresPermission(android.Manifest.permission.CONTROL_ALWAYS_ON_VPN)
1090 public List<String> getVpnLockdownWhitelist(int userId) {
1091 try {
1092 return mService.getVpnLockdownWhitelist(userId);
1093 } catch (RemoteException e) {
1094 throw e.rethrowFromSystemServer();
1095 }
1096 }
1097
1098 /**
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08001099 * Returns details about the currently active default data network
1100 * for a given uid. This is for internal use only to avoid spying
1101 * other apps.
1102 *
1103 * @return a {@link NetworkInfo} object for the current default network
1104 * for the given uid or {@code null} if no default network is
1105 * available for the specified uid.
1106 *
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08001107 * {@hide}
1108 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06001109 @RequiresPermission(android.Manifest.permission.CONNECTIVITY_INTERNAL)
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01001110 @UnsupportedAppUsage
Jeff Sharkeyc006f1a2011-05-19 17:12:49 -07001111 public NetworkInfo getActiveNetworkInfoForUid(int uid) {
Jeff Sharkey1b6519b2016-04-28 15:33:18 -06001112 return getActiveNetworkInfoForUid(uid, false);
1113 }
1114
1115 /** {@hide} */
1116 public NetworkInfo getActiveNetworkInfoForUid(int uid, boolean ignoreBlocked) {
Jeff Sharkeyc006f1a2011-05-19 17:12:49 -07001117 try {
Jeff Sharkey1b6519b2016-04-28 15:33:18 -06001118 return mService.getActiveNetworkInfoForUid(uid, ignoreBlocked);
Jeff Sharkeyc006f1a2011-05-19 17:12:49 -07001119 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07001120 throw e.rethrowFromSystemServer();
Jeff Sharkeyc006f1a2011-05-19 17:12:49 -07001121 }
1122 }
1123
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08001124 /**
1125 * Returns connection status information about a particular
1126 * network type.
1127 *
1128 * @param networkType integer specifying which networkType in
1129 * which you're interested.
1130 * @return a {@link NetworkInfo} object for the requested
1131 * network type or {@code null} if the type is not
Chalard Jean5a041d12018-03-29 17:45:24 +09001132 * supported by the device. If {@code networkType} is
1133 * TYPE_VPN and a VPN is active for the calling app,
1134 * then this method will try to return one of the
1135 * underlying networks for the VPN or null if the
1136 * VPN agent didn't specify any.
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08001137 *
Paul Jensen3541e9f2015-03-18 12:23:02 -04001138 * @deprecated This method does not support multiple connected networks
1139 * of the same type. Use {@link #getAllNetworks} and
1140 * {@link #getNetworkInfo(android.net.Network)} instead.
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08001141 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07001142 @Deprecated
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06001143 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean50bea3d2019-01-07 19:26:34 +09001144 @Nullable
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001145 public NetworkInfo getNetworkInfo(int networkType) {
1146 try {
1147 return mService.getNetworkInfo(networkType);
1148 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07001149 throw e.rethrowFromSystemServer();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001150 }
1151 }
1152
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08001153 /**
Robert Greenwalt73b6cbae2014-06-23 11:40:00 -07001154 * Returns connection status information about a particular
1155 * Network.
1156 *
1157 * @param network {@link Network} specifying which network
1158 * in which you're interested.
1159 * @return a {@link NetworkInfo} object for the requested
1160 * network or {@code null} if the {@code Network}
1161 * is not valid.
junyulai3822c8a2018-12-13 12:47:51 +08001162 * @deprecated See {@link NetworkInfo}.
Robert Greenwalt73b6cbae2014-06-23 11:40:00 -07001163 */
junyulai3822c8a2018-12-13 12:47:51 +08001164 @Deprecated
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06001165 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean50bea3d2019-01-07 19:26:34 +09001166 @Nullable
1167 public NetworkInfo getNetworkInfo(@Nullable Network network) {
Jeff Sharkey1b6519b2016-04-28 15:33:18 -06001168 return getNetworkInfoForUid(network, Process.myUid(), false);
1169 }
1170
1171 /** {@hide} */
1172 public NetworkInfo getNetworkInfoForUid(Network network, int uid, boolean ignoreBlocked) {
Robert Greenwalt73b6cbae2014-06-23 11:40:00 -07001173 try {
Jeff Sharkey1b6519b2016-04-28 15:33:18 -06001174 return mService.getNetworkInfoForUid(network, uid, ignoreBlocked);
Robert Greenwalt73b6cbae2014-06-23 11:40:00 -07001175 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07001176 throw e.rethrowFromSystemServer();
Robert Greenwalt73b6cbae2014-06-23 11:40:00 -07001177 }
1178 }
1179
1180 /**
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08001181 * Returns connection status information about all network
1182 * types supported by the device.
1183 *
1184 * @return an array of {@link NetworkInfo} objects. Check each
1185 * {@link NetworkInfo#getType} for which type each applies.
1186 *
Paul Jensen3541e9f2015-03-18 12:23:02 -04001187 * @deprecated This method does not support multiple connected networks
1188 * of the same type. Use {@link #getAllNetworks} and
1189 * {@link #getNetworkInfo(android.net.Network)} instead.
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08001190 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07001191 @Deprecated
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06001192 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean50bea3d2019-01-07 19:26:34 +09001193 @NonNull
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001194 public NetworkInfo[] getAllNetworkInfo() {
1195 try {
1196 return mService.getAllNetworkInfo();
1197 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07001198 throw e.rethrowFromSystemServer();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001199 }
1200 }
1201
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08001202 /**
Lorenzo Colittib57edc52014-08-22 17:10:50 -07001203 * Returns the {@link Network} object currently serving a given type, or
1204 * null if the given type is not connected.
1205 *
Lorenzo Colittib57edc52014-08-22 17:10:50 -07001206 * @hide
Paul Jensen3541e9f2015-03-18 12:23:02 -04001207 * @deprecated This method does not support multiple connected networks
1208 * of the same type. Use {@link #getAllNetworks} and
1209 * {@link #getNetworkInfo(android.net.Network)} instead.
Lorenzo Colittib57edc52014-08-22 17:10:50 -07001210 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07001211 @Deprecated
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06001212 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01001213 @UnsupportedAppUsage
Lorenzo Colittib57edc52014-08-22 17:10:50 -07001214 public Network getNetworkForType(int networkType) {
1215 try {
1216 return mService.getNetworkForType(networkType);
1217 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07001218 throw e.rethrowFromSystemServer();
Lorenzo Colittib57edc52014-08-22 17:10:50 -07001219 }
1220 }
1221
1222 /**
Robert Greenwalt73b6cbae2014-06-23 11:40:00 -07001223 * Returns an array of all {@link Network} currently tracked by the
1224 * framework.
Paul Jensenb2748922015-05-06 11:10:18 -04001225 *
1226 * @return an array of {@link Network} objects.
Robert Greenwalt73b6cbae2014-06-23 11:40:00 -07001227 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06001228 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean50bea3d2019-01-07 19:26:34 +09001229 @NonNull
Robert Greenwalt73b6cbae2014-06-23 11:40:00 -07001230 public Network[] getAllNetworks() {
1231 try {
1232 return mService.getAllNetworks();
1233 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07001234 throw e.rethrowFromSystemServer();
Robert Greenwalt73b6cbae2014-06-23 11:40:00 -07001235 }
1236 }
1237
1238 /**
Lorenzo Colittie285b432015-04-23 15:32:42 +09001239 * Returns an array of {@link android.net.NetworkCapabilities} objects, representing
Lorenzo Colitti403aa262014-11-28 11:21:30 +09001240 * the Networks that applications run by the given user will use by default.
1241 * @hide
1242 */
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01001243 @UnsupportedAppUsage
Lorenzo Colitti403aa262014-11-28 11:21:30 +09001244 public NetworkCapabilities[] getDefaultNetworkCapabilitiesForUser(int userId) {
1245 try {
1246 return mService.getDefaultNetworkCapabilitiesForUser(userId);
1247 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07001248 throw e.rethrowFromSystemServer();
Lorenzo Colitti403aa262014-11-28 11:21:30 +09001249 }
1250 }
1251
1252 /**
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08001253 * Returns the IP information for the current default network.
1254 *
1255 * @return a {@link LinkProperties} object describing the IP info
1256 * for the current default network, or {@code null} if there
1257 * is no current default network.
1258 *
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08001259 * {@hide}
Chalard Jeaneb1ea882019-01-11 16:47:53 +09001260 * @deprecated please use {@link #getLinkProperties(Network)} on the return
1261 * value of {@link #getActiveNetwork()} instead. In particular,
1262 * this method will return non-null LinkProperties even if the
1263 * app is blocked by policy from using this network.
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08001264 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06001265 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jeaneb1ea882019-01-11 16:47:53 +09001266 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 109783091)
Robert Greenwaltd192dad2010-09-14 09:18:02 -07001267 public LinkProperties getActiveLinkProperties() {
1268 try {
1269 return mService.getActiveLinkProperties();
1270 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07001271 throw e.rethrowFromSystemServer();
Robert Greenwaltd192dad2010-09-14 09:18:02 -07001272 }
1273 }
1274
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08001275 /**
1276 * Returns the IP information for a given network type.
1277 *
1278 * @param networkType the network type of interest.
1279 * @return a {@link LinkProperties} object describing the IP info
1280 * for the given networkType, or {@code null} if there is
1281 * no current default network.
1282 *
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08001283 * {@hide}
Paul Jensen3541e9f2015-03-18 12:23:02 -04001284 * @deprecated This method does not support multiple connected networks
1285 * of the same type. Use {@link #getAllNetworks},
1286 * {@link #getNetworkInfo(android.net.Network)}, and
1287 * {@link #getLinkProperties(android.net.Network)} instead.
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08001288 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07001289 @Deprecated
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06001290 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01001291 @UnsupportedAppUsage
Robert Greenwaltd192dad2010-09-14 09:18:02 -07001292 public LinkProperties getLinkProperties(int networkType) {
1293 try {
Robert Greenwalt9258c642014-03-26 16:47:06 -07001294 return mService.getLinkPropertiesForType(networkType);
1295 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07001296 throw e.rethrowFromSystemServer();
Robert Greenwalt9258c642014-03-26 16:47:06 -07001297 }
1298 }
1299
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07001300 /**
1301 * Get the {@link LinkProperties} for the given {@link Network}. This
1302 * will return {@code null} if the network is unknown.
1303 *
1304 * @param network The {@link Network} object identifying the network in question.
1305 * @return The {@link LinkProperties} for the network, or {@code null}.
Paul Jensenb2748922015-05-06 11:10:18 -04001306 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06001307 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean50bea3d2019-01-07 19:26:34 +09001308 @Nullable
1309 public LinkProperties getLinkProperties(@Nullable Network network) {
Robert Greenwalt9258c642014-03-26 16:47:06 -07001310 try {
1311 return mService.getLinkProperties(network);
1312 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07001313 throw e.rethrowFromSystemServer();
Robert Greenwalt9258c642014-03-26 16:47:06 -07001314 }
1315 }
1316
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07001317 /**
Lorenzo Colittie285b432015-04-23 15:32:42 +09001318 * Get the {@link android.net.NetworkCapabilities} for the given {@link Network}. This
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07001319 * will return {@code null} if the network is unknown.
1320 *
1321 * @param network The {@link Network} object identifying the network in question.
Lorenzo Colittie285b432015-04-23 15:32:42 +09001322 * @return The {@link android.net.NetworkCapabilities} for the network, or {@code null}.
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07001323 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06001324 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean50bea3d2019-01-07 19:26:34 +09001325 @Nullable
1326 public NetworkCapabilities getNetworkCapabilities(@Nullable Network network) {
Robert Greenwalt9258c642014-03-26 16:47:06 -07001327 try {
1328 return mService.getNetworkCapabilities(network);
Robert Greenwaltd192dad2010-09-14 09:18:02 -07001329 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07001330 throw e.rethrowFromSystemServer();
Robert Greenwaltd192dad2010-09-14 09:18:02 -07001331 }
1332 }
1333
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08001334 /**
Udam Sainib7c24872016-01-04 12:16:14 -08001335 * Gets the URL that should be used for resolving whether a captive portal is present.
1336 * 1. This URL should respond with a 204 response to a GET request to indicate no captive
1337 * portal is present.
1338 * 2. This URL must be HTTP as redirect responses are used to find captive portal
1339 * sign-in pages. Captive portals cannot respond to HTTPS requests with redirects.
1340 *
1341 * @hide
1342 */
1343 @SystemApi
Udam Saini0e94c362017-06-07 12:06:28 -07001344 @RequiresPermission(android.Manifest.permission.LOCAL_MAC_ADDRESS)
Udam Sainib7c24872016-01-04 12:16:14 -08001345 public String getCaptivePortalServerUrl() {
1346 try {
1347 return mService.getCaptivePortalServerUrl();
1348 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07001349 throw e.rethrowFromSystemServer();
Udam Sainib7c24872016-01-04 12:16:14 -08001350 }
1351 }
1352
1353 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001354 * Tells the underlying networking system that the caller wants to
1355 * begin using the named feature. The interpretation of {@code feature}
1356 * is completely up to each networking implementation.
Lorenzo Colittid5427052015-10-15 16:29:00 +09001357 *
1358 * <p>This method requires the caller to hold either the
1359 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
1360 * or the ability to modify system settings as determined by
1361 * {@link android.provider.Settings.System#canWrite}.</p>
1362 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001363 * @param networkType specifies which network the request pertains to
1364 * @param feature the name of the feature to be used
1365 * @return an integer value representing the outcome of the request.
1366 * The interpretation of this value is specific to each networking
1367 * implementation+feature combination, except that the value {@code -1}
1368 * always indicates failure.
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07001369 *
Lorenzo Colitti2ea89e52015-04-24 17:03:31 +09001370 * @deprecated Deprecated in favor of the cleaner
1371 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} API.
Dianne Hackborn692a2442015-07-31 10:35:34 -07001372 * In {@link VERSION_CODES#M}, and above, this method is unsupported and will
Lorenzo Colittiffc42b02015-07-29 11:41:21 +09001373 * throw {@code UnsupportedOperationException} if called.
Lorenzo Colitti2187df72016-12-09 18:39:30 +09001374 * @removed
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001375 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07001376 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001377 public int startUsingNetworkFeature(int networkType, String feature) {
Lorenzo Colittiffc42b02015-07-29 11:41:21 +09001378 checkLegacyRoutingApiAccess();
Robert Greenwalt562cc542014-05-15 18:07:26 -07001379 NetworkCapabilities netCap = networkCapabilitiesForFeature(networkType, feature);
1380 if (netCap == null) {
1381 Log.d(TAG, "Can't satisfy startUsingNetworkFeature for " + networkType + ", " +
1382 feature);
1383 return PhoneConstants.APN_REQUEST_FAILED;
1384 }
1385
1386 NetworkRequest request = null;
1387 synchronized (sLegacyRequests) {
1388 LegacyRequest l = sLegacyRequests.get(netCap);
1389 if (l != null) {
1390 Log.d(TAG, "renewing startUsingNetworkFeature request " + l.networkRequest);
1391 renewRequestLocked(l);
1392 if (l.currentNetwork != null) {
1393 return PhoneConstants.APN_ALREADY_ACTIVE;
1394 } else {
1395 return PhoneConstants.APN_REQUEST_STARTED;
1396 }
1397 }
1398
1399 request = requestNetworkForFeatureLocked(netCap);
1400 }
1401 if (request != null) {
Robert Greenwalt257ee5f2014-06-20 10:58:45 -07001402 Log.d(TAG, "starting startUsingNetworkFeature for request " + request);
Robert Greenwalt562cc542014-05-15 18:07:26 -07001403 return PhoneConstants.APN_REQUEST_STARTED;
1404 } else {
1405 Log.d(TAG, " request Failed");
1406 return PhoneConstants.APN_REQUEST_FAILED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001407 }
1408 }
1409
1410 /**
1411 * Tells the underlying networking system that the caller is finished
1412 * using the named feature. The interpretation of {@code feature}
1413 * is completely up to each networking implementation.
Lorenzo Colittid5427052015-10-15 16:29:00 +09001414 *
1415 * <p>This method requires the caller to hold either the
1416 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
1417 * or the ability to modify system settings as determined by
1418 * {@link android.provider.Settings.System#canWrite}.</p>
1419 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001420 * @param networkType specifies which network the request pertains to
1421 * @param feature the name of the feature that is no longer needed
1422 * @return an integer value representing the outcome of the request.
1423 * The interpretation of this value is specific to each networking
1424 * implementation+feature combination, except that the value {@code -1}
1425 * always indicates failure.
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07001426 *
Lorenzo Colitti88bc0bb2016-04-13 22:00:02 +09001427 * @deprecated Deprecated in favor of the cleaner
1428 * {@link #unregisterNetworkCallback(NetworkCallback)} API.
Dianne Hackborn692a2442015-07-31 10:35:34 -07001429 * In {@link VERSION_CODES#M}, and above, this method is unsupported and will
Lorenzo Colittiffc42b02015-07-29 11:41:21 +09001430 * throw {@code UnsupportedOperationException} if called.
Lorenzo Colitti2187df72016-12-09 18:39:30 +09001431 * @removed
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001432 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07001433 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001434 public int stopUsingNetworkFeature(int networkType, String feature) {
Lorenzo Colittiffc42b02015-07-29 11:41:21 +09001435 checkLegacyRoutingApiAccess();
Robert Greenwalt562cc542014-05-15 18:07:26 -07001436 NetworkCapabilities netCap = networkCapabilitiesForFeature(networkType, feature);
1437 if (netCap == null) {
1438 Log.d(TAG, "Can't satisfy stopUsingNetworkFeature for " + networkType + ", " +
1439 feature);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001440 return -1;
1441 }
Robert Greenwalt562cc542014-05-15 18:07:26 -07001442
Paul Jensen9ffb53c2014-12-17 10:39:34 -05001443 if (removeRequestForFeature(netCap)) {
Robert Greenwalt562cc542014-05-15 18:07:26 -07001444 Log.d(TAG, "stopUsingNetworkFeature for " + networkType + ", " + feature);
Robert Greenwalt562cc542014-05-15 18:07:26 -07001445 }
1446 return 1;
1447 }
1448
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01001449 @UnsupportedAppUsage
Robert Greenwalt562cc542014-05-15 18:07:26 -07001450 private NetworkCapabilities networkCapabilitiesForFeature(int networkType, String feature) {
1451 if (networkType == TYPE_MOBILE) {
Erik Kline35bf06c2017-01-26 18:08:28 +09001452 switch (feature) {
1453 case "enableCBS":
1454 return networkCapabilitiesForType(TYPE_MOBILE_CBS);
1455 case "enableDUN":
1456 case "enableDUNAlways":
1457 return networkCapabilitiesForType(TYPE_MOBILE_DUN);
1458 case "enableFOTA":
1459 return networkCapabilitiesForType(TYPE_MOBILE_FOTA);
1460 case "enableHIPRI":
1461 return networkCapabilitiesForType(TYPE_MOBILE_HIPRI);
1462 case "enableIMS":
1463 return networkCapabilitiesForType(TYPE_MOBILE_IMS);
1464 case "enableMMS":
1465 return networkCapabilitiesForType(TYPE_MOBILE_MMS);
1466 case "enableSUPL":
1467 return networkCapabilitiesForType(TYPE_MOBILE_SUPL);
1468 default:
1469 return null;
Robert Greenwalt562cc542014-05-15 18:07:26 -07001470 }
Erik Kline35bf06c2017-01-26 18:08:28 +09001471 } else if (networkType == TYPE_WIFI && "p2p".equals(feature)) {
1472 return networkCapabilitiesForType(TYPE_WIFI_P2P);
Robert Greenwalt562cc542014-05-15 18:07:26 -07001473 }
1474 return null;
1475 }
1476
Robert Greenwalt06314e42014-10-29 14:04:06 -07001477 /**
1478 * Guess what the network request was trying to say so that the resulting
1479 * network is accessible via the legacy (deprecated) API such as
1480 * requestRouteToHost.
Lorenzo Colittidef4cb02015-11-25 20:28:50 +09001481 *
1482 * This means we should try to be fairly precise about transport and
Robert Greenwalt06314e42014-10-29 14:04:06 -07001483 * capability but ignore things such as networkSpecifier.
1484 * If the request has more than one transport or capability it doesn't
1485 * match the old legacy requests (they selected only single transport/capability)
1486 * so this function cannot map the request to a single legacy type and
1487 * the resulting network will not be available to the legacy APIs.
1488 *
Lorenzo Colittidef4cb02015-11-25 20:28:50 +09001489 * This code is only called from the requestNetwork API (L and above).
1490 *
1491 * Setting a legacy type causes CONNECTIVITY_ACTION broadcasts, which are expensive
1492 * because they wake up lots of apps - see http://b/23350688 . So we currently only
1493 * do this for SUPL requests, which are the only ones that we know need it. If
1494 * omitting these broadcasts causes unacceptable app breakage, then for backwards
1495 * compatibility we can send them:
1496 *
1497 * if (targetSdkVersion < Build.VERSION_CODES.M) && // legacy API unsupported >= M
1498 * targetSdkVersion >= Build.VERSION_CODES.LOLLIPOP)) // requestNetwork not present < L
1499 *
Robert Greenwalt06314e42014-10-29 14:04:06 -07001500 * TODO - This should be removed when the legacy APIs are removed.
1501 */
Ye Wenb87875e2014-07-21 14:19:01 -07001502 private int inferLegacyTypeForNetworkCapabilities(NetworkCapabilities netCap) {
1503 if (netCap == null) {
1504 return TYPE_NONE;
1505 }
Robert Greenwalt06314e42014-10-29 14:04:06 -07001506
Ye Wenb87875e2014-07-21 14:19:01 -07001507 if (!netCap.hasTransport(NetworkCapabilities.TRANSPORT_CELLULAR)) {
1508 return TYPE_NONE;
1509 }
Robert Greenwalt06314e42014-10-29 14:04:06 -07001510
Lifu Tang30f95a72016-01-07 23:20:38 -08001511 // Do this only for SUPL, until GnssLocationProvider is fixed. http://b/25876485 .
Lorenzo Colittidef4cb02015-11-25 20:28:50 +09001512 if (!netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_SUPL)) {
1513 // NOTE: if this causes app breakage, we should not just comment out this early return;
1514 // instead, we should make this early return conditional on the requesting app's target
1515 // SDK version, as described in the comment above.
1516 return TYPE_NONE;
1517 }
1518
Robert Greenwalt06314e42014-10-29 14:04:06 -07001519 String type = null;
1520 int result = TYPE_NONE;
1521
Ye Wenb87875e2014-07-21 14:19:01 -07001522 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_CBS)) {
Robert Greenwalt06314e42014-10-29 14:04:06 -07001523 type = "enableCBS";
1524 result = TYPE_MOBILE_CBS;
1525 } else if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_IMS)) {
1526 type = "enableIMS";
1527 result = TYPE_MOBILE_IMS;
1528 } else if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_FOTA)) {
1529 type = "enableFOTA";
1530 result = TYPE_MOBILE_FOTA;
1531 } else if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_DUN)) {
1532 type = "enableDUN";
1533 result = TYPE_MOBILE_DUN;
1534 } else if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_SUPL)) {
Lorenzo Colittidef4cb02015-11-25 20:28:50 +09001535 type = "enableSUPL";
Robert Greenwalt06314e42014-10-29 14:04:06 -07001536 result = TYPE_MOBILE_SUPL;
Robert Greenwalt74ab4fa2015-08-28 12:37:54 -07001537 // back out this hack for mms as they no longer need this and it's causing
1538 // device slowdowns - b/23350688 (note, supl still needs this)
1539 //} else if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_MMS)) {
1540 // type = "enableMMS";
1541 // result = TYPE_MOBILE_MMS;
Robert Greenwalt06314e42014-10-29 14:04:06 -07001542 } else if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_INTERNET)) {
1543 type = "enableHIPRI";
1544 result = TYPE_MOBILE_HIPRI;
Ye Wenb87875e2014-07-21 14:19:01 -07001545 }
Robert Greenwalt06314e42014-10-29 14:04:06 -07001546 if (type != null) {
1547 NetworkCapabilities testCap = networkCapabilitiesForFeature(TYPE_MOBILE, type);
1548 if (testCap.equalsNetCapabilities(netCap) && testCap.equalsTransportTypes(netCap)) {
1549 return result;
Ye Wenb87875e2014-07-21 14:19:01 -07001550 }
1551 }
1552 return TYPE_NONE;
1553 }
1554
Robert Greenwalt32aa65a2014-06-02 15:32:02 -07001555 private int legacyTypeForNetworkCapabilities(NetworkCapabilities netCap) {
Robert Greenwalt562cc542014-05-15 18:07:26 -07001556 if (netCap == null) return TYPE_NONE;
1557 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_CBS)) {
1558 return TYPE_MOBILE_CBS;
1559 }
1560 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_IMS)) {
1561 return TYPE_MOBILE_IMS;
1562 }
1563 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_FOTA)) {
1564 return TYPE_MOBILE_FOTA;
1565 }
1566 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_DUN)) {
1567 return TYPE_MOBILE_DUN;
1568 }
1569 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_SUPL)) {
1570 return TYPE_MOBILE_SUPL;
1571 }
1572 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_MMS)) {
1573 return TYPE_MOBILE_MMS;
1574 }
1575 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_INTERNET)) {
1576 return TYPE_MOBILE_HIPRI;
1577 }
Robert Greenwalt32aa65a2014-06-02 15:32:02 -07001578 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_WIFI_P2P)) {
1579 return TYPE_WIFI_P2P;
1580 }
Robert Greenwalt562cc542014-05-15 18:07:26 -07001581 return TYPE_NONE;
1582 }
1583
1584 private static class LegacyRequest {
1585 NetworkCapabilities networkCapabilities;
1586 NetworkRequest networkRequest;
1587 int expireSequenceNumber;
1588 Network currentNetwork;
1589 int delay = -1;
Paul Jensen9ffb53c2014-12-17 10:39:34 -05001590
1591 private void clearDnsBinding() {
1592 if (currentNetwork != null) {
1593 currentNetwork = null;
1594 setProcessDefaultNetworkForHostResolution(null);
1595 }
1596 }
1597
Robert Greenwalt6078b502014-06-11 16:05:07 -07001598 NetworkCallback networkCallback = new NetworkCallback() {
Robert Greenwalt562cc542014-05-15 18:07:26 -07001599 @Override
Robert Greenwalt6078b502014-06-11 16:05:07 -07001600 public void onAvailable(Network network) {
Robert Greenwalt562cc542014-05-15 18:07:26 -07001601 currentNetwork = network;
1602 Log.d(TAG, "startUsingNetworkFeature got Network:" + network);
Paul Jensen6d3ff9e2014-05-29 10:12:39 -04001603 setProcessDefaultNetworkForHostResolution(network);
Robert Greenwalt562cc542014-05-15 18:07:26 -07001604 }
1605 @Override
Robert Greenwalt6078b502014-06-11 16:05:07 -07001606 public void onLost(Network network) {
Paul Jensen9ffb53c2014-12-17 10:39:34 -05001607 if (network.equals(currentNetwork)) clearDnsBinding();
Robert Greenwalt562cc542014-05-15 18:07:26 -07001608 Log.d(TAG, "startUsingNetworkFeature lost Network:" + network);
1609 }
1610 };
1611 }
1612
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01001613 @UnsupportedAppUsage
Chalard Jean4d660112018-06-04 16:52:49 +09001614 private static final HashMap<NetworkCapabilities, LegacyRequest> sLegacyRequests =
1615 new HashMap<>();
Robert Greenwalt562cc542014-05-15 18:07:26 -07001616
1617 private NetworkRequest findRequestForFeature(NetworkCapabilities netCap) {
1618 synchronized (sLegacyRequests) {
1619 LegacyRequest l = sLegacyRequests.get(netCap);
1620 if (l != null) return l.networkRequest;
1621 }
1622 return null;
1623 }
1624
1625 private void renewRequestLocked(LegacyRequest l) {
1626 l.expireSequenceNumber++;
1627 Log.d(TAG, "renewing request to seqNum " + l.expireSequenceNumber);
1628 sendExpireMsgForFeature(l.networkCapabilities, l.expireSequenceNumber, l.delay);
1629 }
1630
1631 private void expireRequest(NetworkCapabilities netCap, int sequenceNum) {
1632 int ourSeqNum = -1;
1633 synchronized (sLegacyRequests) {
1634 LegacyRequest l = sLegacyRequests.get(netCap);
1635 if (l == null) return;
1636 ourSeqNum = l.expireSequenceNumber;
Paul Jensen9ffb53c2014-12-17 10:39:34 -05001637 if (l.expireSequenceNumber == sequenceNum) removeRequestForFeature(netCap);
Robert Greenwalt562cc542014-05-15 18:07:26 -07001638 }
1639 Log.d(TAG, "expireRequest with " + ourSeqNum + ", " + sequenceNum);
1640 }
1641
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01001642 @UnsupportedAppUsage
Robert Greenwalt562cc542014-05-15 18:07:26 -07001643 private NetworkRequest requestNetworkForFeatureLocked(NetworkCapabilities netCap) {
1644 int delay = -1;
Robert Greenwalt32aa65a2014-06-02 15:32:02 -07001645 int type = legacyTypeForNetworkCapabilities(netCap);
Robert Greenwalt562cc542014-05-15 18:07:26 -07001646 try {
1647 delay = mService.getRestoreDefaultNetworkDelay(type);
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07001648 } catch (RemoteException e) {
1649 throw e.rethrowFromSystemServer();
1650 }
Robert Greenwalt562cc542014-05-15 18:07:26 -07001651 LegacyRequest l = new LegacyRequest();
1652 l.networkCapabilities = netCap;
1653 l.delay = delay;
1654 l.expireSequenceNumber = 0;
Hugo Benichi2583ef02017-02-02 17:02:36 +09001655 l.networkRequest = sendRequestForNetwork(
1656 netCap, l.networkCallback, 0, REQUEST, type, getDefaultHandler());
Robert Greenwalt562cc542014-05-15 18:07:26 -07001657 if (l.networkRequest == null) return null;
1658 sLegacyRequests.put(netCap, l);
1659 sendExpireMsgForFeature(netCap, l.expireSequenceNumber, delay);
1660 return l.networkRequest;
1661 }
1662
1663 private void sendExpireMsgForFeature(NetworkCapabilities netCap, int seqNum, int delay) {
1664 if (delay >= 0) {
1665 Log.d(TAG, "sending expire msg with seqNum " + seqNum + " and delay " + delay);
Hugo Benichi2583ef02017-02-02 17:02:36 +09001666 CallbackHandler handler = getDefaultHandler();
Hugo Benichi6f260f32017-02-03 14:18:44 +09001667 Message msg = handler.obtainMessage(EXPIRE_LEGACY_REQUEST, seqNum, 0, netCap);
1668 handler.sendMessageDelayed(msg, delay);
Robert Greenwalt562cc542014-05-15 18:07:26 -07001669 }
1670 }
1671
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01001672 @UnsupportedAppUsage
Paul Jensen9ffb53c2014-12-17 10:39:34 -05001673 private boolean removeRequestForFeature(NetworkCapabilities netCap) {
1674 final LegacyRequest l;
Robert Greenwalt562cc542014-05-15 18:07:26 -07001675 synchronized (sLegacyRequests) {
Paul Jensen9ffb53c2014-12-17 10:39:34 -05001676 l = sLegacyRequests.remove(netCap);
Robert Greenwalt562cc542014-05-15 18:07:26 -07001677 }
Paul Jensen9ffb53c2014-12-17 10:39:34 -05001678 if (l == null) return false;
1679 unregisterNetworkCallback(l.networkCallback);
1680 l.clearDnsBinding();
1681 return true;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001682 }
1683
Erik Kline35bf06c2017-01-26 18:08:28 +09001684 private static final SparseIntArray sLegacyTypeToTransport = new SparseIntArray();
1685 static {
1686 sLegacyTypeToTransport.put(TYPE_MOBILE, NetworkCapabilities.TRANSPORT_CELLULAR);
1687 sLegacyTypeToTransport.put(TYPE_MOBILE_CBS, NetworkCapabilities.TRANSPORT_CELLULAR);
1688 sLegacyTypeToTransport.put(TYPE_MOBILE_DUN, NetworkCapabilities.TRANSPORT_CELLULAR);
1689 sLegacyTypeToTransport.put(TYPE_MOBILE_FOTA, NetworkCapabilities.TRANSPORT_CELLULAR);
1690 sLegacyTypeToTransport.put(TYPE_MOBILE_HIPRI, NetworkCapabilities.TRANSPORT_CELLULAR);
1691 sLegacyTypeToTransport.put(TYPE_MOBILE_IMS, NetworkCapabilities.TRANSPORT_CELLULAR);
1692 sLegacyTypeToTransport.put(TYPE_MOBILE_MMS, NetworkCapabilities.TRANSPORT_CELLULAR);
1693 sLegacyTypeToTransport.put(TYPE_MOBILE_SUPL, NetworkCapabilities.TRANSPORT_CELLULAR);
1694 sLegacyTypeToTransport.put(TYPE_WIFI, NetworkCapabilities.TRANSPORT_WIFI);
1695 sLegacyTypeToTransport.put(TYPE_WIFI_P2P, NetworkCapabilities.TRANSPORT_WIFI);
1696 sLegacyTypeToTransport.put(TYPE_BLUETOOTH, NetworkCapabilities.TRANSPORT_BLUETOOTH);
1697 sLegacyTypeToTransport.put(TYPE_ETHERNET, NetworkCapabilities.TRANSPORT_ETHERNET);
1698 }
1699
1700 private static final SparseIntArray sLegacyTypeToCapability = new SparseIntArray();
1701 static {
1702 sLegacyTypeToCapability.put(TYPE_MOBILE_CBS, NetworkCapabilities.NET_CAPABILITY_CBS);
1703 sLegacyTypeToCapability.put(TYPE_MOBILE_DUN, NetworkCapabilities.NET_CAPABILITY_DUN);
1704 sLegacyTypeToCapability.put(TYPE_MOBILE_FOTA, NetworkCapabilities.NET_CAPABILITY_FOTA);
1705 sLegacyTypeToCapability.put(TYPE_MOBILE_IMS, NetworkCapabilities.NET_CAPABILITY_IMS);
1706 sLegacyTypeToCapability.put(TYPE_MOBILE_MMS, NetworkCapabilities.NET_CAPABILITY_MMS);
1707 sLegacyTypeToCapability.put(TYPE_MOBILE_SUPL, NetworkCapabilities.NET_CAPABILITY_SUPL);
1708 sLegacyTypeToCapability.put(TYPE_WIFI_P2P, NetworkCapabilities.NET_CAPABILITY_WIFI_P2P);
1709 }
1710
1711 /**
1712 * Given a legacy type (TYPE_WIFI, ...) returns a NetworkCapabilities
1713 * instance suitable for registering a request or callback. Throws an
1714 * IllegalArgumentException if no mapping from the legacy type to
1715 * NetworkCapabilities is known.
1716 *
Chalard Jean6b1da6e2018-03-08 13:54:53 +09001717 * @deprecated Types are deprecated. Use {@link NetworkCallback} or {@link NetworkRequest}
1718 * to find the network instead.
Erik Kline35bf06c2017-01-26 18:08:28 +09001719 * @hide
1720 */
1721 public static NetworkCapabilities networkCapabilitiesForType(int type) {
1722 final NetworkCapabilities nc = new NetworkCapabilities();
1723
1724 // Map from type to transports.
1725 final int NOT_FOUND = -1;
1726 final int transport = sLegacyTypeToTransport.get(type, NOT_FOUND);
Hugo Benichie7678512017-05-09 15:19:01 +09001727 Preconditions.checkArgument(transport != NOT_FOUND, "unknown legacy type: " + type);
Erik Kline35bf06c2017-01-26 18:08:28 +09001728 nc.addTransportType(transport);
1729
1730 // Map from type to capabilities.
1731 nc.addCapability(sLegacyTypeToCapability.get(
1732 type, NetworkCapabilities.NET_CAPABILITY_INTERNET));
1733 nc.maybeMarkCapabilitiesRestricted();
1734 return nc;
1735 }
1736
Lorenzo Colitti8bf977d2015-06-15 14:29:22 +09001737 /** @hide */
1738 public static class PacketKeepaliveCallback {
1739 /** The requested keepalive was successfully started. */
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01001740 @UnsupportedAppUsage
Lorenzo Colitti8bf977d2015-06-15 14:29:22 +09001741 public void onStarted() {}
1742 /** The keepalive was successfully stopped. */
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01001743 @UnsupportedAppUsage
Lorenzo Colitti8bf977d2015-06-15 14:29:22 +09001744 public void onStopped() {}
1745 /** An error occurred. */
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01001746 @UnsupportedAppUsage
Lorenzo Colitti8bf977d2015-06-15 14:29:22 +09001747 public void onError(int error) {}
1748 }
1749
1750 /**
1751 * Allows applications to request that the system periodically send specific packets on their
1752 * behalf, using hardware offload to save battery power.
1753 *
1754 * To request that the system send keepalives, call one of the methods that return a
1755 * {@link ConnectivityManager.PacketKeepalive} object, such as {@link #startNattKeepalive},
1756 * passing in a non-null callback. If the callback is successfully started, the callback's
1757 * {@code onStarted} method will be called. If an error occurs, {@code onError} will be called,
1758 * specifying one of the {@code ERROR_*} constants in this class.
1759 *
Chalard Jean4d660112018-06-04 16:52:49 +09001760 * To stop an existing keepalive, call {@link PacketKeepalive#stop}. The system will call
1761 * {@link PacketKeepaliveCallback#onStopped} if the operation was successful or
1762 * {@link PacketKeepaliveCallback#onError} if an error occurred.
Lorenzo Colitti8bf977d2015-06-15 14:29:22 +09001763 *
junyulai48eac1d42018-12-27 17:25:29 +08001764 * @deprecated Use {@link SocketKeepalive} instead.
1765 *
Lorenzo Colitti8bf977d2015-06-15 14:29:22 +09001766 * @hide
1767 */
1768 public class PacketKeepalive {
1769
1770 private static final String TAG = "PacketKeepalive";
1771
1772 /** @hide */
1773 public static final int SUCCESS = 0;
1774
1775 /** @hide */
1776 public static final int NO_KEEPALIVE = -1;
1777
1778 /** @hide */
1779 public static final int BINDER_DIED = -10;
1780
1781 /** The specified {@code Network} is not connected. */
1782 public static final int ERROR_INVALID_NETWORK = -20;
1783 /** The specified IP addresses are invalid. For example, the specified source IP address is
1784 * not configured on the specified {@code Network}. */
1785 public static final int ERROR_INVALID_IP_ADDRESS = -21;
1786 /** The requested port is invalid. */
1787 public static final int ERROR_INVALID_PORT = -22;
1788 /** The packet length is invalid (e.g., too long). */
1789 public static final int ERROR_INVALID_LENGTH = -23;
1790 /** The packet transmission interval is invalid (e.g., too short). */
1791 public static final int ERROR_INVALID_INTERVAL = -24;
1792
1793 /** The hardware does not support this request. */
1794 public static final int ERROR_HARDWARE_UNSUPPORTED = -30;
Lorenzo Colitti9d1284e2015-09-08 16:46:36 +09001795 /** The hardware returned an error. */
1796 public static final int ERROR_HARDWARE_ERROR = -31;
Lorenzo Colitti8bf977d2015-06-15 14:29:22 +09001797
Nathan Harold63dd8132018-02-14 13:09:45 -08001798 /** The NAT-T destination port for IPsec */
Lorenzo Colitti8bf977d2015-06-15 14:29:22 +09001799 public static final int NATT_PORT = 4500;
1800
Nathan Harold63dd8132018-02-14 13:09:45 -08001801 /** The minimum interval in seconds between keepalive packet transmissions */
1802 public static final int MIN_INTERVAL = 10;
1803
Lorenzo Colitti8bf977d2015-06-15 14:29:22 +09001804 private final Network mNetwork;
1805 private final PacketKeepaliveCallback mCallback;
1806 private final Looper mLooper;
1807 private final Messenger mMessenger;
1808
1809 private volatile Integer mSlot;
1810
1811 void stopLooper() {
1812 mLooper.quit();
1813 }
1814
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01001815 @UnsupportedAppUsage
Lorenzo Colitti8bf977d2015-06-15 14:29:22 +09001816 public void stop() {
1817 try {
1818 mService.stopKeepalive(mNetwork, mSlot);
1819 } catch (RemoteException e) {
1820 Log.e(TAG, "Error stopping packet keepalive: ", e);
1821 stopLooper();
1822 }
1823 }
1824
1825 private PacketKeepalive(Network network, PacketKeepaliveCallback callback) {
Hugo Benichidafed3d2017-03-06 09:17:06 +09001826 Preconditions.checkNotNull(network, "network cannot be null");
1827 Preconditions.checkNotNull(callback, "callback cannot be null");
Lorenzo Colitti8bf977d2015-06-15 14:29:22 +09001828 mNetwork = network;
1829 mCallback = callback;
1830 HandlerThread thread = new HandlerThread(TAG);
1831 thread.start();
1832 mLooper = thread.getLooper();
1833 mMessenger = new Messenger(new Handler(mLooper) {
1834 @Override
1835 public void handleMessage(Message message) {
1836 switch (message.what) {
junyulaie4135282019-01-03 18:50:15 +08001837 case NetworkAgent.EVENT_SOCKET_KEEPALIVE:
Lorenzo Colitti8bf977d2015-06-15 14:29:22 +09001838 int error = message.arg2;
1839 try {
1840 if (error == SUCCESS) {
1841 if (mSlot == null) {
1842 mSlot = message.arg1;
1843 mCallback.onStarted();
1844 } else {
1845 mSlot = null;
1846 stopLooper();
1847 mCallback.onStopped();
1848 }
1849 } else {
1850 stopLooper();
1851 mCallback.onError(error);
1852 }
1853 } catch (Exception e) {
1854 Log.e(TAG, "Exception in keepalive callback(" + error + ")", e);
1855 }
1856 break;
1857 default:
1858 Log.e(TAG, "Unhandled message " + Integer.toHexString(message.what));
1859 break;
1860 }
1861 }
1862 });
1863 }
1864 }
1865
1866 /**
1867 * Starts an IPsec NAT-T keepalive packet with the specified parameters.
1868 *
junyulai48eac1d42018-12-27 17:25:29 +08001869 * @deprecated Use {@link #createSocketKeepalive} instead.
1870 *
Lorenzo Colitti8bf977d2015-06-15 14:29:22 +09001871 * @hide
1872 */
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01001873 @UnsupportedAppUsage
Lorenzo Colitti8bf977d2015-06-15 14:29:22 +09001874 public PacketKeepalive startNattKeepalive(
1875 Network network, int intervalSeconds, PacketKeepaliveCallback callback,
1876 InetAddress srcAddr, int srcPort, InetAddress dstAddr) {
1877 final PacketKeepalive k = new PacketKeepalive(network, callback);
1878 try {
1879 mService.startNattKeepalive(network, intervalSeconds, k.mMessenger, new Binder(),
1880 srcAddr.getHostAddress(), srcPort, dstAddr.getHostAddress());
1881 } catch (RemoteException e) {
1882 Log.e(TAG, "Error starting packet keepalive: ", e);
1883 k.stopLooper();
1884 return null;
1885 }
1886 return k;
1887 }
1888
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001889 /**
junyulai48eac1d42018-12-27 17:25:29 +08001890 * Request that keepalives be started on a IPsec NAT-T socket.
1891 *
1892 * @param network The {@link Network} the socket is on.
1893 * @param socket The socket that needs to be kept alive.
1894 * @param source The source address of the {@link UdpEncapsulationSocket}.
1895 * @param destination The destination address of the {@link UdpEncapsulationSocket}.
1896 * @param executor The executor on which callback will be invoked. The provided {@link Executor}
1897 * must run callback sequentially, otherwise the order of callbacks cannot be
1898 * guaranteed.
1899 * @param callback A {@link SocketKeepalive.Callback}. Used for notifications about keepalive
1900 * changes. Must be extended by applications that use this API.
1901 *
junyulai352dc2f2019-01-08 20:04:33 +08001902 * @return A {@link SocketKeepalive} object that can be used to control the keepalive on the
1903 * given socket.
junyulai48eac1d42018-12-27 17:25:29 +08001904 **/
1905 public SocketKeepalive createSocketKeepalive(@NonNull Network network,
1906 @NonNull UdpEncapsulationSocket socket,
1907 @NonNull InetAddress source,
1908 @NonNull InetAddress destination,
1909 @NonNull @CallbackExecutor Executor executor,
1910 @NonNull Callback callback) {
junyulai215b8772019-01-15 11:32:44 +08001911 return new NattSocketKeepalive(mService, network, socket.getFileDescriptor(),
1912 socket.getResourceId(), source, destination, executor, callback);
1913 }
1914
1915 /**
1916 * Request that keepalives be started on a IPsec NAT-T socket file descriptor. Directly called
1917 * by system apps which don't use IpSecService to create {@link UdpEncapsulationSocket}.
1918 *
1919 * @param network The {@link Network} the socket is on.
1920 * @param fd The {@link FileDescriptor} that needs to be kept alive. The provided
1921 * {@link FileDescriptor} must be bound to a port and the keepalives will be sent from
1922 * that port.
1923 * @param source The source address of the {@link UdpEncapsulationSocket}.
1924 * @param destination The destination address of the {@link UdpEncapsulationSocket}. The
1925 * keepalive packets will always be sent to port 4500 of the given {@code destination}.
1926 * @param executor The executor on which callback will be invoked. The provided {@link Executor}
1927 * must run callback sequentially, otherwise the order of callbacks cannot be
1928 * guaranteed.
1929 * @param callback A {@link SocketKeepalive.Callback}. Used for notifications about keepalive
1930 * changes. Must be extended by applications that use this API.
1931 *
junyulai352dc2f2019-01-08 20:04:33 +08001932 * @return A {@link SocketKeepalive} object that can be used to control the keepalive on the
1933 * given socket.
junyulai215b8772019-01-15 11:32:44 +08001934 * @hide
1935 */
1936 @SystemApi
1937 @RequiresPermission(android.Manifest.permission.PACKET_KEEPALIVE_OFFLOAD)
1938 public SocketKeepalive createNattKeepalive(@NonNull Network network,
1939 @NonNull FileDescriptor fd,
1940 @NonNull InetAddress source,
1941 @NonNull InetAddress destination,
1942 @NonNull @CallbackExecutor Executor executor,
1943 @NonNull Callback callback) {
1944 return new NattSocketKeepalive(mService, network, fd, INVALID_RESOURCE_ID /* Unused */,
1945 source, destination, executor, callback);
junyulai48eac1d42018-12-27 17:25:29 +08001946 }
1947
1948 /**
junyulai352dc2f2019-01-08 20:04:33 +08001949 * Request that keepalives be started on a TCP socket.
1950 * The socket must be established.
1951 *
1952 * @param network The {@link Network} the socket is on.
1953 * @param socket The socket that needs to be kept alive.
1954 * @param executor The executor on which callback will be invoked. This implementation assumes
1955 * the provided {@link Executor} runs the callbacks in sequence with no
1956 * concurrency. Failing this, no guarantee of correctness can be made. It is
1957 * the responsibility of the caller to ensure the executor provides this
1958 * guarantee. A simple way of creating such an executor is with the standard
1959 * tool {@code Executors.newSingleThreadExecutor}.
1960 * @param callback A {@link SocketKeepalive.Callback}. Used for notifications about keepalive
1961 * changes. Must be extended by applications that use this API.
1962 *
1963 * @return A {@link SocketKeepalive} object that can be used to control the keepalive on the
1964 * given socket.
1965 * @hide
1966 */
1967 @SystemApi
1968 @RequiresPermission(android.Manifest.permission.PACKET_KEEPALIVE_OFFLOAD)
1969 public SocketKeepalive createSocketKeepalive(@NonNull Network network,
1970 @NonNull Socket socket,
1971 @NonNull Executor executor,
1972 @NonNull Callback callback) {
1973 return new TcpSocketKeepalive(mService, network, socket, executor, callback);
1974 }
1975
1976 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001977 * Ensure that a network route exists to deliver traffic to the specified
1978 * host via the specified network interface. An attempt to add a route that
1979 * already exists is ignored, but treated as successful.
Lorenzo Colittid5427052015-10-15 16:29:00 +09001980 *
1981 * <p>This method requires the caller to hold either the
1982 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
1983 * or the ability to modify system settings as determined by
1984 * {@link android.provider.Settings.System#canWrite}.</p>
1985 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001986 * @param networkType the type of the network over which traffic to the specified
1987 * host is to be routed
1988 * @param hostAddress the IP address of the host to which the route is desired
1989 * @return {@code true} on success, {@code false} on failure
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07001990 *
Lorenzo Colitti2ea89e52015-04-24 17:03:31 +09001991 * @deprecated Deprecated in favor of the
1992 * {@link #requestNetwork(NetworkRequest, NetworkCallback)},
1993 * {@link #bindProcessToNetwork} and {@link Network#getSocketFactory} API.
Dianne Hackborn692a2442015-07-31 10:35:34 -07001994 * In {@link VERSION_CODES#M}, and above, this method is unsupported and will
Lorenzo Colittiffc42b02015-07-29 11:41:21 +09001995 * throw {@code UnsupportedOperationException} if called.
Lorenzo Colitti2187df72016-12-09 18:39:30 +09001996 * @removed
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001997 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07001998 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001999 public boolean requestRouteToHost(int networkType, int hostAddress) {
Sreeram Ramachandran03666c72014-07-19 23:21:46 -07002000 return requestRouteToHostAddress(networkType, NetworkUtils.intToInetAddress(hostAddress));
Robert Greenwalt585ac0f2010-08-27 09:24:29 -07002001 }
2002
2003 /**
2004 * Ensure that a network route exists to deliver traffic to the specified
2005 * host via the specified network interface. An attempt to add a route that
2006 * already exists is ignored, but treated as successful.
Lorenzo Colittid5427052015-10-15 16:29:00 +09002007 *
2008 * <p>This method requires the caller to hold either the
2009 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
2010 * or the ability to modify system settings as determined by
2011 * {@link android.provider.Settings.System#canWrite}.</p>
2012 *
Robert Greenwalt585ac0f2010-08-27 09:24:29 -07002013 * @param networkType the type of the network over which traffic to the specified
2014 * host is to be routed
2015 * @param hostAddress the IP address of the host to which the route is desired
2016 * @return {@code true} on success, {@code false} on failure
2017 * @hide
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07002018 * @deprecated Deprecated in favor of the {@link #requestNetwork} and
Lorenzo Colitti2ea89e52015-04-24 17:03:31 +09002019 * {@link #bindProcessToNetwork} API.
Robert Greenwalt585ac0f2010-08-27 09:24:29 -07002020 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07002021 @Deprecated
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01002022 @UnsupportedAppUsage
Robert Greenwalt585ac0f2010-08-27 09:24:29 -07002023 public boolean requestRouteToHostAddress(int networkType, InetAddress hostAddress) {
Lorenzo Colittiffc42b02015-07-29 11:41:21 +09002024 checkLegacyRoutingApiAccess();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002025 try {
Sreeram Ramachandran03666c72014-07-19 23:21:46 -07002026 return mService.requestRouteToHostAddress(networkType, hostAddress.getAddress());
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002027 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002028 throw e.rethrowFromSystemServer();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002029 }
2030 }
2031
2032 /**
2033 * Returns the value of the setting for background data usage. If false,
2034 * applications should not use the network if the application is not in the
2035 * foreground. Developers should respect this setting, and check the value
2036 * of this before performing any background data operations.
2037 * <p>
2038 * All applications that have background services that use the network
2039 * should listen to {@link #ACTION_BACKGROUND_DATA_SETTING_CHANGED}.
Jeff Sharkey3a844fc2011-08-16 14:37:57 -07002040 * <p>
Scott Main4cc53332011-10-06 18:32:43 -07002041 * @deprecated As of {@link VERSION_CODES#ICE_CREAM_SANDWICH}, availability of
Jeff Sharkey3a844fc2011-08-16 14:37:57 -07002042 * background data depends on several combined factors, and this method will
2043 * always return {@code true}. Instead, when background data is unavailable,
2044 * {@link #getActiveNetworkInfo()} will now appear disconnected.
Danica Chang6fdd0c62010-08-11 14:54:43 -07002045 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002046 * @return Whether background data usage is allowed.
2047 */
Jeff Sharkey3a844fc2011-08-16 14:37:57 -07002048 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002049 public boolean getBackgroundDataSetting() {
Jeff Sharkey3a844fc2011-08-16 14:37:57 -07002050 // assume that background data is allowed; final authority is
2051 // NetworkInfo which may be blocked.
2052 return true;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002053 }
2054
2055 /**
2056 * Sets the value of the setting for background data usage.
Robert Greenwaltc03fa502010-02-23 18:58:05 -08002057 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002058 * @param allowBackgroundData Whether an application should use data while
2059 * it is in the background.
Robert Greenwaltc03fa502010-02-23 18:58:05 -08002060 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002061 * @attr ref android.Manifest.permission#CHANGE_BACKGROUND_DATA_SETTING
2062 * @see #getBackgroundDataSetting()
2063 * @hide
2064 */
Jeff Sharkey3a844fc2011-08-16 14:37:57 -07002065 @Deprecated
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01002066 @UnsupportedAppUsage
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002067 public void setBackgroundDataSetting(boolean allowBackgroundData) {
Jeff Sharkey3a844fc2011-08-16 14:37:57 -07002068 // ignored
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002069 }
Robert Greenwaltc03fa502010-02-23 18:58:05 -08002070
Jeff Sharkey43d2a172017-07-12 10:50:42 -06002071 /** {@hide} */
2072 @Deprecated
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01002073 @UnsupportedAppUsage
Jeff Sharkeyf0ceede2011-08-02 17:22:34 -07002074 public NetworkQuotaInfo getActiveNetworkQuotaInfo() {
2075 try {
2076 return mService.getActiveNetworkQuotaInfo();
2077 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002078 throw e.rethrowFromSystemServer();
Jeff Sharkeyf0ceede2011-08-02 17:22:34 -07002079 }
2080 }
2081
2082 /**
Robert Greenwaltc03fa502010-02-23 18:58:05 -08002083 * @hide
Robert Greenwaltafa05c02014-05-21 20:04:36 -07002084 * @deprecated Talk to TelephonyManager directly
Robert Greenwaltc03fa502010-02-23 18:58:05 -08002085 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07002086 @Deprecated
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01002087 @UnsupportedAppUsage
Robert Greenwaltc03fa502010-02-23 18:58:05 -08002088 public boolean getMobileDataEnabled() {
Robert Greenwaltafa05c02014-05-21 20:04:36 -07002089 IBinder b = ServiceManager.getService(Context.TELEPHONY_SERVICE);
2090 if (b != null) {
2091 try {
2092 ITelephony it = ITelephony.Stub.asInterface(b);
Shishir Agrawal7ea3e8b2016-01-25 13:03:07 -08002093 int subId = SubscriptionManager.getDefaultDataSubscriptionId();
Wink Saville36ffb042014-12-05 11:10:30 -08002094 Log.d("ConnectivityManager", "getMobileDataEnabled()+ subId=" + subId);
Malcolm Chenb455e722017-11-28 15:57:14 -08002095 boolean retVal = it.isUserDataEnabled(subId);
Wink Saville36ffb042014-12-05 11:10:30 -08002096 Log.d("ConnectivityManager", "getMobileDataEnabled()- subId=" + subId
2097 + " retVal=" + retVal);
2098 return retVal;
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002099 } catch (RemoteException e) {
2100 throw e.rethrowFromSystemServer();
2101 }
Robert Greenwaltc03fa502010-02-23 18:58:05 -08002102 }
Wink Saville36ffb042014-12-05 11:10:30 -08002103 Log.d("ConnectivityManager", "getMobileDataEnabled()- remote exception retVal=false");
Robert Greenwaltafa05c02014-05-21 20:04:36 -07002104 return false;
Robert Greenwaltc03fa502010-02-23 18:58:05 -08002105 }
2106
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002107 /**
Robert Greenwaltb2489872014-09-04 16:44:35 -07002108 * Callback for use with {@link ConnectivityManager#addDefaultNetworkActiveListener}
Robert Greenwalt6078b502014-06-11 16:05:07 -07002109 * to find out when the system default network has gone in to a high power state.
Dianne Hackborn77b987f2014-02-26 16:20:52 -08002110 */
2111 public interface OnNetworkActiveListener {
2112 /**
2113 * Called on the main thread of the process to report that the current data network
2114 * has become active, and it is now a good time to perform any pending network
2115 * operations. Note that this listener only tells you when the network becomes
2116 * active; if at any other time you want to know whether it is active (and thus okay
2117 * to initiate network traffic), you can retrieve its instantaneous state with
Robert Greenwalt6078b502014-06-11 16:05:07 -07002118 * {@link ConnectivityManager#isDefaultNetworkActive}.
Dianne Hackborn77b987f2014-02-26 16:20:52 -08002119 */
Chalard Jean4d660112018-06-04 16:52:49 +09002120 void onNetworkActive();
Dianne Hackborn77b987f2014-02-26 16:20:52 -08002121 }
2122
2123 private INetworkManagementService getNetworkManagementService() {
2124 synchronized (this) {
2125 if (mNMService != null) {
2126 return mNMService;
2127 }
2128 IBinder b = ServiceManager.getService(Context.NETWORKMANAGEMENT_SERVICE);
2129 mNMService = INetworkManagementService.Stub.asInterface(b);
2130 return mNMService;
2131 }
2132 }
2133
2134 private final ArrayMap<OnNetworkActiveListener, INetworkActivityListener>
Chalard Jean4d660112018-06-04 16:52:49 +09002135 mNetworkActivityListeners = new ArrayMap<>();
Dianne Hackborn77b987f2014-02-26 16:20:52 -08002136
2137 /**
Robert Greenwalt6078b502014-06-11 16:05:07 -07002138 * Start listening to reports when the system's default data network is active, meaning it is
2139 * a good time to perform network traffic. Use {@link #isDefaultNetworkActive()}
2140 * to determine the current state of the system's default network after registering the
2141 * listener.
2142 * <p>
2143 * If the process default network has been set with
Paul Jensen72db88e2015-03-10 10:54:12 -04002144 * {@link ConnectivityManager#bindProcessToNetwork} this function will not
Robert Greenwalt6078b502014-06-11 16:05:07 -07002145 * reflect the process's default, but the system default.
Dianne Hackborn77b987f2014-02-26 16:20:52 -08002146 *
2147 * @param l The listener to be told when the network is active.
2148 */
Robert Greenwaltb2489872014-09-04 16:44:35 -07002149 public void addDefaultNetworkActiveListener(final OnNetworkActiveListener l) {
Dianne Hackborn77b987f2014-02-26 16:20:52 -08002150 INetworkActivityListener rl = new INetworkActivityListener.Stub() {
2151 @Override
2152 public void onNetworkActive() throws RemoteException {
2153 l.onNetworkActive();
2154 }
2155 };
2156
2157 try {
2158 getNetworkManagementService().registerNetworkActivityListener(rl);
2159 mNetworkActivityListeners.put(l, rl);
2160 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002161 throw e.rethrowFromSystemServer();
Dianne Hackborn77b987f2014-02-26 16:20:52 -08002162 }
2163 }
2164
2165 /**
2166 * Remove network active listener previously registered with
Robert Greenwaltb2489872014-09-04 16:44:35 -07002167 * {@link #addDefaultNetworkActiveListener}.
Dianne Hackborn77b987f2014-02-26 16:20:52 -08002168 *
2169 * @param l Previously registered listener.
2170 */
Chalard Jean50bea3d2019-01-07 19:26:34 +09002171 public void removeDefaultNetworkActiveListener(@NonNull OnNetworkActiveListener l) {
Dianne Hackborn77b987f2014-02-26 16:20:52 -08002172 INetworkActivityListener rl = mNetworkActivityListeners.get(l);
Hugo Benichie7678512017-05-09 15:19:01 +09002173 Preconditions.checkArgument(rl != null, "Listener was not registered.");
Dianne Hackborn77b987f2014-02-26 16:20:52 -08002174 try {
2175 getNetworkManagementService().unregisterNetworkActivityListener(rl);
2176 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002177 throw e.rethrowFromSystemServer();
Dianne Hackborn77b987f2014-02-26 16:20:52 -08002178 }
2179 }
2180
2181 /**
2182 * Return whether the data network is currently active. An active network means that
2183 * it is currently in a high power state for performing data transmission. On some
2184 * types of networks, it may be expensive to move and stay in such a state, so it is
2185 * more power efficient to batch network traffic together when the radio is already in
2186 * this state. This method tells you whether right now is currently a good time to
2187 * initiate network traffic, as the network is already active.
2188 */
Robert Greenwalt6078b502014-06-11 16:05:07 -07002189 public boolean isDefaultNetworkActive() {
Dianne Hackborn77b987f2014-02-26 16:20:52 -08002190 try {
2191 return getNetworkManagementService().isNetworkActive();
2192 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002193 throw e.rethrowFromSystemServer();
Dianne Hackborn77b987f2014-02-26 16:20:52 -08002194 }
Dianne Hackborn77b987f2014-02-26 16:20:52 -08002195 }
2196
2197 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002198 * {@hide}
2199 */
Lorenzo Colittiffc42b02015-07-29 11:41:21 +09002200 public ConnectivityManager(Context context, IConnectivityManager service) {
Hugo Benichidafed3d2017-03-06 09:17:06 +09002201 mContext = Preconditions.checkNotNull(context, "missing context");
2202 mService = Preconditions.checkNotNull(service, "missing IConnectivityManager");
Paul Jensene0bef712014-12-10 15:12:18 -05002203 sInstance = this;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002204 }
Robert Greenwaltd0e18ff2010-01-26 11:40:34 -08002205
Jeff Sharkey8fc27e82012-04-04 20:40:58 -07002206 /** {@hide} */
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01002207 @UnsupportedAppUsage
Jeff Sharkey8fc27e82012-04-04 20:40:58 -07002208 public static ConnectivityManager from(Context context) {
2209 return (ConnectivityManager) context.getSystemService(Context.CONNECTIVITY_SERVICE);
2210 }
2211
Remi NGUYEN VANe67b0c32018-12-27 16:43:56 +09002212 /** @hide */
2213 public NetworkRequest getDefaultRequest() {
2214 try {
2215 // This is not racy as the default request is final in ConnectivityService.
2216 return mService.getDefaultRequest();
2217 } catch (RemoteException e) {
2218 throw e.rethrowFromSystemServer();
2219 }
2220 }
2221
Lorenzo Colittifbe9b1a2016-07-28 17:14:11 +09002222 /* TODO: These permissions checks don't belong in client-side code. Move them to
2223 * services.jar, possibly in com.android.server.net. */
2224
2225 /** {@hide} */
Lorenzo Colittid5427052015-10-15 16:29:00 +09002226 public static final void enforceChangePermission(Context context) {
2227 int uid = Binder.getCallingUid();
2228 Settings.checkAndNoteChangeNetworkStateOperation(context, uid, Settings
2229 .getPackageNameForUid(context, uid), true /* throwException */);
2230 }
2231
Tetsutoki Shiozawa335d2ed2016-03-16 23:30:57 +09002232 /** {@hide} */
2233 public static final void enforceTetherChangePermission(Context context, String callingPkg) {
Hugo Benichie7678512017-05-09 15:19:01 +09002234 Preconditions.checkNotNull(context, "Context cannot be null");
2235 Preconditions.checkNotNull(callingPkg, "callingPkg cannot be null");
Tetsutoki Shiozawa335d2ed2016-03-16 23:30:57 +09002236
Robert Greenwaltedb47662014-09-16 17:54:19 -07002237 if (context.getResources().getStringArray(
2238 com.android.internal.R.array.config_mobile_hotspot_provision_app).length == 2) {
2239 // Have a provisioning app - must only let system apps (which check this app)
2240 // turn on tethering
2241 context.enforceCallingOrSelfPermission(
Jeremy Kleind42209d2015-12-28 15:11:58 -08002242 android.Manifest.permission.TETHER_PRIVILEGED, "ConnectivityService");
Robert Greenwaltedb47662014-09-16 17:54:19 -07002243 } else {
Billy Laua7238a32015-08-01 12:45:02 +01002244 int uid = Binder.getCallingUid();
Tetsutoki Shiozawa335d2ed2016-03-16 23:30:57 +09002245 // If callingPkg's uid is not same as Binder.getCallingUid(),
2246 // AppOpsService throws SecurityException.
2247 Settings.checkAndNoteWriteSettingsOperation(context, uid, callingPkg,
2248 true /* throwException */);
Robert Greenwaltedb47662014-09-16 17:54:19 -07002249 }
2250 }
2251
Robert Greenwaltd0e18ff2010-01-26 11:40:34 -08002252 /**
Paul Jensene0bef712014-12-10 15:12:18 -05002253 * @deprecated - use getSystemService. This is a kludge to support static access in certain
2254 * situations where a Context pointer is unavailable.
2255 * @hide
2256 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07002257 @Deprecated
Paul Jensen72db88e2015-03-10 10:54:12 -04002258 static ConnectivityManager getInstanceOrNull() {
2259 return sInstance;
2260 }
2261
2262 /**
2263 * @deprecated - use getSystemService. This is a kludge to support static access in certain
2264 * situations where a Context pointer is unavailable.
2265 * @hide
2266 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07002267 @Deprecated
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01002268 @UnsupportedAppUsage
Paul Jensen72db88e2015-03-10 10:54:12 -04002269 private static ConnectivityManager getInstance() {
2270 if (getInstanceOrNull() == null) {
Paul Jensene0bef712014-12-10 15:12:18 -05002271 throw new IllegalStateException("No ConnectivityManager yet constructed");
2272 }
Paul Jensen72db88e2015-03-10 10:54:12 -04002273 return getInstanceOrNull();
Paul Jensene0bef712014-12-10 15:12:18 -05002274 }
2275
2276 /**
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002277 * Get the set of tetherable, available interfaces. This list is limited by
2278 * device configuration and current interface existence.
2279 *
2280 * @return an array of 0 or more Strings of tetherable interface names.
2281 *
Robert Greenwaltd0e18ff2010-01-26 11:40:34 -08002282 * {@hide}
2283 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06002284 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01002285 @UnsupportedAppUsage
Robert Greenwaltd0e18ff2010-01-26 11:40:34 -08002286 public String[] getTetherableIfaces() {
2287 try {
2288 return mService.getTetherableIfaces();
2289 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002290 throw e.rethrowFromSystemServer();
Robert Greenwaltd0e18ff2010-01-26 11:40:34 -08002291 }
2292 }
2293
2294 /**
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002295 * Get the set of tethered interfaces.
2296 *
2297 * @return an array of 0 or more String of currently tethered interface names.
2298 *
Robert Greenwaltd0e18ff2010-01-26 11:40:34 -08002299 * {@hide}
2300 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06002301 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01002302 @UnsupportedAppUsage
Robert Greenwaltd0e18ff2010-01-26 11:40:34 -08002303 public String[] getTetheredIfaces() {
2304 try {
2305 return mService.getTetheredIfaces();
2306 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002307 throw e.rethrowFromSystemServer();
Robert Greenwaltd0e18ff2010-01-26 11:40:34 -08002308 }
2309 }
2310
2311 /**
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002312 * Get the set of interface names which attempted to tether but
2313 * failed. Re-attempting to tether may cause them to reset to the Tethered
2314 * state. Alternatively, causing the interface to be destroyed and recreated
2315 * may cause them to reset to the available state.
2316 * {@link ConnectivityManager#getLastTetherError} can be used to get more
2317 * information on the cause of the errors.
2318 *
2319 * @return an array of 0 or more String indicating the interface names
2320 * which failed to tether.
2321 *
Robert Greenwaltd0e18ff2010-01-26 11:40:34 -08002322 * {@hide}
2323 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06002324 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01002325 @UnsupportedAppUsage
Robert Greenwalt5a735062010-03-02 17:25:02 -08002326 public String[] getTetheringErroredIfaces() {
Robert Greenwaltd0e18ff2010-01-26 11:40:34 -08002327 try {
Robert Greenwalt5a735062010-03-02 17:25:02 -08002328 return mService.getTetheringErroredIfaces();
Robert Greenwaltd0e18ff2010-01-26 11:40:34 -08002329 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002330 throw e.rethrowFromSystemServer();
Robert Greenwaltd0e18ff2010-01-26 11:40:34 -08002331 }
2332 }
2333
2334 /**
Robert Greenwalt9c7e2c22014-06-23 14:53:42 -07002335 * Get the set of tethered dhcp ranges.
2336 *
2337 * @return an array of 0 or more {@code String} of tethered dhcp ranges.
2338 * {@hide}
2339 */
2340 public String[] getTetheredDhcpRanges() {
2341 try {
2342 return mService.getTetheredDhcpRanges();
2343 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002344 throw e.rethrowFromSystemServer();
Robert Greenwalt9c7e2c22014-06-23 14:53:42 -07002345 }
2346 }
2347
2348 /**
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002349 * Attempt to tether the named interface. This will setup a dhcp server
2350 * on the interface, forward and NAT IP packets and forward DNS requests
2351 * to the best active upstream network interface. Note that if no upstream
2352 * IP network interface is available, dhcp will still run and traffic will be
2353 * allowed between the tethered devices and this device, though upstream net
2354 * access will of course fail until an upstream network interface becomes
2355 * active.
Lorenzo Colittid5427052015-10-15 16:29:00 +09002356 *
2357 * <p>This method requires the caller to hold either the
2358 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
2359 * or the ability to modify system settings as determined by
2360 * {@link android.provider.Settings.System#canWrite}.</p>
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002361 *
Jeremy Klein36c7aa02016-01-22 14:11:45 -08002362 * <p>WARNING: New clients should not use this function. The only usages should be in PanService
2363 * and WifiStateMachine which need direct access. All other clients should use
2364 * {@link #startTethering} and {@link #stopTethering} which encapsulate proper provisioning
2365 * logic.</p>
2366 *
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002367 * @param iface the interface name to tether.
2368 * @return error a {@code TETHER_ERROR} value indicating success or failure type
2369 *
Robert Greenwaltd0e18ff2010-01-26 11:40:34 -08002370 * {@hide}
2371 */
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01002372 @UnsupportedAppUsage
Robert Greenwalt5a735062010-03-02 17:25:02 -08002373 public int tether(String iface) {
2374 try {
Tetsutoki Shiozawa335d2ed2016-03-16 23:30:57 +09002375 String pkgName = mContext.getOpPackageName();
2376 Log.i(TAG, "tether caller:" + pkgName);
2377 return mService.tether(iface, pkgName);
Robert Greenwalt5a735062010-03-02 17:25:02 -08002378 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002379 throw e.rethrowFromSystemServer();
Robert Greenwalt5a735062010-03-02 17:25:02 -08002380 }
2381 }
2382
2383 /**
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002384 * Stop tethering the named interface.
Lorenzo Colittid5427052015-10-15 16:29:00 +09002385 *
2386 * <p>This method requires the caller to hold either the
2387 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
2388 * or the ability to modify system settings as determined by
2389 * {@link android.provider.Settings.System#canWrite}.</p>
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002390 *
Jeremy Klein36c7aa02016-01-22 14:11:45 -08002391 * <p>WARNING: New clients should not use this function. The only usages should be in PanService
2392 * and WifiStateMachine which need direct access. All other clients should use
2393 * {@link #startTethering} and {@link #stopTethering} which encapsulate proper provisioning
2394 * logic.</p>
2395 *
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002396 * @param iface the interface name to untether.
2397 * @return error a {@code TETHER_ERROR} value indicating success or failure type
2398 *
Robert Greenwalt5a735062010-03-02 17:25:02 -08002399 * {@hide}
2400 */
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01002401 @UnsupportedAppUsage
Robert Greenwalt5a735062010-03-02 17:25:02 -08002402 public int untether(String iface) {
Robert Greenwaltd0e18ff2010-01-26 11:40:34 -08002403 try {
Tetsutoki Shiozawa335d2ed2016-03-16 23:30:57 +09002404 String pkgName = mContext.getOpPackageName();
2405 Log.i(TAG, "untether caller:" + pkgName);
2406 return mService.untether(iface, pkgName);
Robert Greenwaltd0e18ff2010-01-26 11:40:34 -08002407 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002408 throw e.rethrowFromSystemServer();
Robert Greenwaltd0e18ff2010-01-26 11:40:34 -08002409 }
2410 }
Robert Greenwalt2a091d72010-02-11 18:18:40 -08002411
2412 /**
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002413 * Check if the device allows for tethering. It may be disabled via
Dianne Hackborn77b987f2014-02-26 16:20:52 -08002414 * {@code ro.tether.denied} system property, Settings.TETHER_SUPPORTED or
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002415 * due to device configuration.
2416 *
Chalard Jean8f76fc32017-09-26 15:45:18 +09002417 * <p>If this app does not have permission to use this API, it will always
2418 * return false rather than throw an exception.</p>
2419 *
2420 * <p>If the device has a hotspot provisioning app, the caller is required to hold the
2421 * {@link android.Manifest.permission.TETHER_PRIVILEGED} permission.</p>
2422 *
2423 * <p>Otherwise, this method requires the caller to hold the ability to modify system
2424 * settings as determined by {@link android.provider.Settings.System#canWrite}.</p>
2425 *
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002426 * @return a boolean - {@code true} indicating Tethering is supported.
2427 *
Robert Greenwalt2a091d72010-02-11 18:18:40 -08002428 * {@hide}
2429 */
Jeremy Klein36c7aa02016-01-22 14:11:45 -08002430 @SystemApi
Chalard Jean8f76fc32017-09-26 15:45:18 +09002431 @RequiresPermission(anyOf = {android.Manifest.permission.TETHER_PRIVILEGED,
2432 android.Manifest.permission.WRITE_SETTINGS})
Robert Greenwalt2a091d72010-02-11 18:18:40 -08002433 public boolean isTetheringSupported() {
Chalard Jean8f76fc32017-09-26 15:45:18 +09002434 String pkgName = mContext.getOpPackageName();
Robert Greenwalt2a091d72010-02-11 18:18:40 -08002435 try {
Udam Saini0e94c362017-06-07 12:06:28 -07002436 return mService.isTetheringSupported(pkgName);
Chalard Jean8f76fc32017-09-26 15:45:18 +09002437 } catch (SecurityException e) {
2438 // This API is not available to this caller, but for backward-compatibility
2439 // this will just return false instead of throwing.
2440 return false;
Robert Greenwalt2a091d72010-02-11 18:18:40 -08002441 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002442 throw e.rethrowFromSystemServer();
Robert Greenwalt2a091d72010-02-11 18:18:40 -08002443 }
2444 }
2445
2446 /**
Jeremy Klein36c7aa02016-01-22 14:11:45 -08002447 * Callback for use with {@link #startTethering} to find out whether tethering succeeded.
2448 * @hide
2449 */
2450 @SystemApi
2451 public static abstract class OnStartTetheringCallback {
2452 /**
2453 * Called when tethering has been successfully started.
2454 */
Chalard Jean4d660112018-06-04 16:52:49 +09002455 public void onTetheringStarted() {}
Jeremy Klein36c7aa02016-01-22 14:11:45 -08002456
2457 /**
2458 * Called when starting tethering failed.
2459 */
Chalard Jean4d660112018-06-04 16:52:49 +09002460 public void onTetheringFailed() {}
Jeremy Klein36c7aa02016-01-22 14:11:45 -08002461 }
2462
2463 /**
2464 * Convenient overload for
2465 * {@link #startTethering(int, boolean, OnStartTetheringCallback, Handler)} which passes a null
2466 * handler to run on the current thread's {@link Looper}.
2467 * @hide
2468 */
2469 @SystemApi
Udam Saini0e94c362017-06-07 12:06:28 -07002470 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
Jeremy Klein36c7aa02016-01-22 14:11:45 -08002471 public void startTethering(int type, boolean showProvisioningUi,
2472 final OnStartTetheringCallback callback) {
2473 startTethering(type, showProvisioningUi, callback, null);
2474 }
2475
2476 /**
2477 * Runs tether provisioning for the given type if needed and then starts tethering if
2478 * the check succeeds. If no carrier provisioning is required for tethering, tethering is
2479 * enabled immediately. If provisioning fails, tethering will not be enabled. It also
2480 * schedules tether provisioning re-checks if appropriate.
2481 *
2482 * @param type The type of tethering to start. Must be one of
2483 * {@link ConnectivityManager.TETHERING_WIFI},
2484 * {@link ConnectivityManager.TETHERING_USB}, or
2485 * {@link ConnectivityManager.TETHERING_BLUETOOTH}.
2486 * @param showProvisioningUi a boolean indicating to show the provisioning app UI if there
2487 * is one. This should be true the first time this function is called and also any time
2488 * the user can see this UI. It gives users information from their carrier about the
2489 * check failing and how they can sign up for tethering if possible.
2490 * @param callback an {@link OnStartTetheringCallback} which will be called to notify the caller
2491 * of the result of trying to tether.
2492 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
2493 * @hide
2494 */
2495 @SystemApi
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06002496 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
Jeremy Klein36c7aa02016-01-22 14:11:45 -08002497 public void startTethering(int type, boolean showProvisioningUi,
2498 final OnStartTetheringCallback callback, Handler handler) {
Hugo Benichidafed3d2017-03-06 09:17:06 +09002499 Preconditions.checkNotNull(callback, "OnStartTetheringCallback cannot be null.");
Jeremy Klein5f277e12016-03-12 16:29:54 -08002500
Jeremy Klein36c7aa02016-01-22 14:11:45 -08002501 ResultReceiver wrappedCallback = new ResultReceiver(handler) {
2502 @Override
2503 protected void onReceiveResult(int resultCode, Bundle resultData) {
2504 if (resultCode == TETHER_ERROR_NO_ERROR) {
2505 callback.onTetheringStarted();
2506 } else {
2507 callback.onTetheringFailed();
2508 }
2509 }
2510 };
Jeremy Klein5f277e12016-03-12 16:29:54 -08002511
Jeremy Klein36c7aa02016-01-22 14:11:45 -08002512 try {
Tetsutoki Shiozawa335d2ed2016-03-16 23:30:57 +09002513 String pkgName = mContext.getOpPackageName();
2514 Log.i(TAG, "startTethering caller:" + pkgName);
2515 mService.startTethering(type, wrappedCallback, showProvisioningUi, pkgName);
Jeremy Klein36c7aa02016-01-22 14:11:45 -08002516 } catch (RemoteException e) {
2517 Log.e(TAG, "Exception trying to start tethering.", e);
2518 wrappedCallback.send(TETHER_ERROR_SERVICE_UNAVAIL, null);
2519 }
2520 }
2521
2522 /**
2523 * Stops tethering for the given type. Also cancels any provisioning rechecks for that type if
2524 * applicable.
2525 *
2526 * @param type The type of tethering to stop. Must be one of
2527 * {@link ConnectivityManager.TETHERING_WIFI},
2528 * {@link ConnectivityManager.TETHERING_USB}, or
2529 * {@link ConnectivityManager.TETHERING_BLUETOOTH}.
2530 * @hide
2531 */
2532 @SystemApi
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06002533 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
Jeremy Klein36c7aa02016-01-22 14:11:45 -08002534 public void stopTethering(int type) {
2535 try {
Tetsutoki Shiozawa335d2ed2016-03-16 23:30:57 +09002536 String pkgName = mContext.getOpPackageName();
2537 Log.i(TAG, "stopTethering caller:" + pkgName);
2538 mService.stopTethering(type, pkgName);
Jeremy Klein36c7aa02016-01-22 14:11:45 -08002539 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002540 throw e.rethrowFromSystemServer();
Jeremy Klein36c7aa02016-01-22 14:11:45 -08002541 }
2542 }
2543
2544 /**
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002545 * Get the list of regular expressions that define any tetherable
2546 * USB network interfaces. If USB tethering is not supported by the
2547 * device, this list should be empty.
2548 *
2549 * @return an array of 0 or more regular expression Strings defining
2550 * what interfaces are considered tetherable usb interfaces.
2551 *
Robert Greenwalt2a091d72010-02-11 18:18:40 -08002552 * {@hide}
2553 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06002554 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01002555 @UnsupportedAppUsage
Robert Greenwalt2a091d72010-02-11 18:18:40 -08002556 public String[] getTetherableUsbRegexs() {
2557 try {
2558 return mService.getTetherableUsbRegexs();
2559 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002560 throw e.rethrowFromSystemServer();
Robert Greenwalt2a091d72010-02-11 18:18:40 -08002561 }
2562 }
2563
2564 /**
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002565 * Get the list of regular expressions that define any tetherable
2566 * Wifi network interfaces. If Wifi tethering is not supported by the
2567 * device, this list should be empty.
2568 *
2569 * @return an array of 0 or more regular expression Strings defining
2570 * what interfaces are considered tetherable wifi interfaces.
2571 *
Robert Greenwalt2a091d72010-02-11 18:18:40 -08002572 * {@hide}
2573 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06002574 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01002575 @UnsupportedAppUsage
Robert Greenwalt2a091d72010-02-11 18:18:40 -08002576 public String[] getTetherableWifiRegexs() {
2577 try {
2578 return mService.getTetherableWifiRegexs();
2579 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002580 throw e.rethrowFromSystemServer();
Robert Greenwalt2a091d72010-02-11 18:18:40 -08002581 }
2582 }
Robert Greenwalt5a735062010-03-02 17:25:02 -08002583
Danica Chang6fdd0c62010-08-11 14:54:43 -07002584 /**
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002585 * Get the list of regular expressions that define any tetherable
2586 * Bluetooth network interfaces. If Bluetooth tethering is not supported by the
2587 * device, this list should be empty.
2588 *
2589 * @return an array of 0 or more regular expression Strings defining
2590 * what interfaces are considered tetherable bluetooth interfaces.
2591 *
Danica Chang6fdd0c62010-08-11 14:54:43 -07002592 * {@hide}
2593 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06002594 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01002595 @UnsupportedAppUsage
Danica Chang6fdd0c62010-08-11 14:54:43 -07002596 public String[] getTetherableBluetoothRegexs() {
2597 try {
2598 return mService.getTetherableBluetoothRegexs();
2599 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002600 throw e.rethrowFromSystemServer();
Danica Chang6fdd0c62010-08-11 14:54:43 -07002601 }
2602 }
2603
Mike Lockwood6c2260b2011-07-19 13:04:47 -07002604 /**
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002605 * Attempt to both alter the mode of USB and Tethering of USB. A
2606 * utility method to deal with some of the complexity of USB - will
2607 * attempt to switch to Rndis and subsequently tether the resulting
2608 * interface on {@code true} or turn off tethering and switch off
2609 * Rndis on {@code false}.
Lorenzo Colittid5427052015-10-15 16:29:00 +09002610 *
2611 * <p>This method requires the caller to hold either the
2612 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
2613 * or the ability to modify system settings as determined by
2614 * {@link android.provider.Settings.System#canWrite}.</p>
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002615 *
2616 * @param enable a boolean - {@code true} to enable tethering
2617 * @return error a {@code TETHER_ERROR} value indicating success or failure type
2618 *
Mike Lockwood6c2260b2011-07-19 13:04:47 -07002619 * {@hide}
2620 */
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01002621 @UnsupportedAppUsage
Mike Lockwood6c2260b2011-07-19 13:04:47 -07002622 public int setUsbTethering(boolean enable) {
2623 try {
Tetsutoki Shiozawa335d2ed2016-03-16 23:30:57 +09002624 String pkgName = mContext.getOpPackageName();
2625 Log.i(TAG, "setUsbTethering caller:" + pkgName);
2626 return mService.setUsbTethering(enable, pkgName);
Mike Lockwood6c2260b2011-07-19 13:04:47 -07002627 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002628 throw e.rethrowFromSystemServer();
Mike Lockwood6c2260b2011-07-19 13:04:47 -07002629 }
2630 }
2631
Robert Greenwalt5a735062010-03-02 17:25:02 -08002632 /** {@hide} */
markchienf2731272019-01-16 17:44:13 +08002633 @SystemApi
Robert Greenwalt5a735062010-03-02 17:25:02 -08002634 public static final int TETHER_ERROR_NO_ERROR = 0;
2635 /** {@hide} */
2636 public static final int TETHER_ERROR_UNKNOWN_IFACE = 1;
2637 /** {@hide} */
2638 public static final int TETHER_ERROR_SERVICE_UNAVAIL = 2;
2639 /** {@hide} */
2640 public static final int TETHER_ERROR_UNSUPPORTED = 3;
2641 /** {@hide} */
2642 public static final int TETHER_ERROR_UNAVAIL_IFACE = 4;
2643 /** {@hide} */
2644 public static final int TETHER_ERROR_MASTER_ERROR = 5;
2645 /** {@hide} */
2646 public static final int TETHER_ERROR_TETHER_IFACE_ERROR = 6;
2647 /** {@hide} */
2648 public static final int TETHER_ERROR_UNTETHER_IFACE_ERROR = 7;
2649 /** {@hide} */
2650 public static final int TETHER_ERROR_ENABLE_NAT_ERROR = 8;
2651 /** {@hide} */
2652 public static final int TETHER_ERROR_DISABLE_NAT_ERROR = 9;
2653 /** {@hide} */
2654 public static final int TETHER_ERROR_IFACE_CFG_ERROR = 10;
Jeremy Klein36c7aa02016-01-22 14:11:45 -08002655 /** {@hide} */
markchienf2731272019-01-16 17:44:13 +08002656 @SystemApi
Jeremy Klein36c7aa02016-01-22 14:11:45 -08002657 public static final int TETHER_ERROR_PROVISION_FAILED = 11;
Remi NGUYEN VAN0e3d09232018-12-04 12:13:09 +09002658 /** {@hide} */
2659 public static final int TETHER_ERROR_DHCPSERVER_ERROR = 12;
markchienf2731272019-01-16 17:44:13 +08002660 /** {@hide} */
2661 @SystemApi
2662 public static final int TETHER_ERROR_ENTITLEMENT_UNKONWN = 13;
Robert Greenwalt5a735062010-03-02 17:25:02 -08002663
2664 /**
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002665 * Get a more detailed error code after a Tethering or Untethering
2666 * request asynchronously failed.
2667 *
2668 * @param iface The name of the interface of interest
Robert Greenwalt5a735062010-03-02 17:25:02 -08002669 * @return error The error code of the last error tethering or untethering the named
2670 * interface
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002671 *
Robert Greenwalt5a735062010-03-02 17:25:02 -08002672 * {@hide}
2673 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06002674 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01002675 @UnsupportedAppUsage
Robert Greenwalt5a735062010-03-02 17:25:02 -08002676 public int getLastTetherError(String iface) {
2677 try {
2678 return mService.getLastTetherError(iface);
2679 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002680 throw e.rethrowFromSystemServer();
Robert Greenwalt5a735062010-03-02 17:25:02 -08002681 }
Robert Greenwalt14f2ef42010-06-15 12:19:37 -07002682 }
2683
2684 /**
markchienf2731272019-01-16 17:44:13 +08002685 * Callback for use with {@link #getLatestTetheringEntitlementValue} to find out whether
2686 * entitlement succeeded.
2687 * @hide
2688 */
2689 @SystemApi
2690 public abstract static class TetheringEntitlementValueListener {
2691 /**
2692 * Called to notify entitlement result.
2693 *
2694 * @param resultCode a int value of entitlement result. It may be one of
2695 * {@link #TETHER_ERROR_NO_ERROR},
2696 * {@link #TETHER_ERROR_PROVISION_FAILED}, or
2697 * {@link #TETHER_ERROR_ENTITLEMENT_UNKONWN}.
2698 */
2699 public void onEntitlementResult(int resultCode) {}
2700 }
2701
2702 /**
2703 * Get the last value of the entitlement check on this downstream. If the cached value is
2704 * {@link #TETHER_ERROR_NO_ERROR} or showEntitlementUi argument is false, it just return the
2705 * cached value. Otherwise, a UI-based entitlement check would be performed. It is not
2706 * guaranteed that the UI-based entitlement check will complete in any specific time period
2707 * and may in fact never complete. Any successful entitlement check the platform performs for
2708 * any reason will update the cached value.
2709 *
2710 * @param type the downstream type of tethering. Must be one of
2711 * {@link #TETHERING_WIFI},
2712 * {@link #TETHERING_USB}, or
2713 * {@link #TETHERING_BLUETOOTH}.
2714 * @param showEntitlementUi a boolean indicating whether to run UI-based entitlement check.
2715 * @param listener an {@link TetheringEntitlementValueListener} which will be called to notify
2716 * the caller of the result of entitlement check. The listener may be called zero or
2717 * one time.
2718 * @param handler {@link Handler} to specify the thread upon which the listener will be invoked.
2719 * {@hide}
2720 */
2721 @SystemApi
2722 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
2723 public void getLatestTetheringEntitlementValue(int type, boolean showEntitlementUi,
2724 @NonNull final TetheringEntitlementValueListener listener, @Nullable Handler handler) {
2725 Preconditions.checkNotNull(listener, "TetheringEntitlementValueListener cannot be null.");
2726 ResultReceiver wrappedListener = new ResultReceiver(handler) {
2727 @Override
2728 protected void onReceiveResult(int resultCode, Bundle resultData) {
2729 listener.onEntitlementResult(resultCode);
2730 }
2731 };
2732
2733 try {
2734 String pkgName = mContext.getOpPackageName();
2735 Log.i(TAG, "getLatestTetheringEntitlementValue:" + pkgName);
2736 mService.getLatestTetheringEntitlementValue(type, wrappedListener,
2737 showEntitlementUi, pkgName);
2738 } catch (RemoteException e) {
2739 throw e.rethrowFromSystemServer();
2740 }
2741 }
2742
2743 /**
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002744 * Report network connectivity status. This is currently used only
2745 * to alter status bar UI.
Paul Jensenb2748922015-05-06 11:10:18 -04002746 * <p>This method requires the caller to hold the permission
2747 * {@link android.Manifest.permission#STATUS_BAR}.
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002748 *
Robert Greenwaltd7085fc2010-09-08 15:24:47 -07002749 * @param networkType The type of network you want to report on
2750 * @param percentage The quality of the connection 0 is bad, 100 is good
Chalard Jean6b1da6e2018-03-08 13:54:53 +09002751 * @deprecated Types are deprecated. Use {@link #reportNetworkConnectivity} instead.
Robert Greenwaltd7085fc2010-09-08 15:24:47 -07002752 * {@hide}
2753 */
2754 public void reportInetCondition(int networkType, int percentage) {
Soi, Yoshinaridee2aa42015-11-12 12:09:02 +09002755 printStackTrace();
Robert Greenwaltd7085fc2010-09-08 15:24:47 -07002756 try {
2757 mService.reportInetCondition(networkType, percentage);
2758 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002759 throw e.rethrowFromSystemServer();
Robert Greenwaltd7085fc2010-09-08 15:24:47 -07002760 }
2761 }
Robert Greenwalt434203a2010-10-11 16:00:27 -07002762
2763 /**
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07002764 * Report a problem network to the framework. This provides a hint to the system
Ye Wenb87875e2014-07-21 14:19:01 -07002765 * that there might be connectivity problems on this network and may cause
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07002766 * the framework to re-evaluate network connectivity and/or switch to another
2767 * network.
Robert Greenwalt9258c642014-03-26 16:47:06 -07002768 *
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07002769 * @param network The {@link Network} the application was attempting to use
2770 * or {@code null} to indicate the current default network.
Paul Jensenbfd17b72015-04-07 12:43:13 -04002771 * @deprecated Use {@link #reportNetworkConnectivity} which allows reporting both
2772 * working and non-working connectivity.
Robert Greenwalt9258c642014-03-26 16:47:06 -07002773 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07002774 @Deprecated
Chalard Jean50bea3d2019-01-07 19:26:34 +09002775 public void reportBadNetwork(@Nullable Network network) {
Soi, Yoshinaridee2aa42015-11-12 12:09:02 +09002776 printStackTrace();
Robert Greenwalt9258c642014-03-26 16:47:06 -07002777 try {
Paul Jensenbfd17b72015-04-07 12:43:13 -04002778 // One of these will be ignored because it matches system's current state.
2779 // The other will trigger the necessary reevaluation.
2780 mService.reportNetworkConnectivity(network, true);
2781 mService.reportNetworkConnectivity(network, false);
2782 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002783 throw e.rethrowFromSystemServer();
Paul Jensenbfd17b72015-04-07 12:43:13 -04002784 }
2785 }
2786
2787 /**
2788 * Report to the framework whether a network has working connectivity.
2789 * This provides a hint to the system that a particular network is providing
2790 * working connectivity or not. In response the framework may re-evaluate
2791 * the network's connectivity and might take further action thereafter.
2792 *
2793 * @param network The {@link Network} the application was attempting to use
2794 * or {@code null} to indicate the current default network.
2795 * @param hasConnectivity {@code true} if the application was able to successfully access the
2796 * Internet using {@code network} or {@code false} if not.
2797 */
Chalard Jean50bea3d2019-01-07 19:26:34 +09002798 public void reportNetworkConnectivity(@Nullable Network network, boolean hasConnectivity) {
Soi, Yoshinaridee2aa42015-11-12 12:09:02 +09002799 printStackTrace();
Paul Jensenbfd17b72015-04-07 12:43:13 -04002800 try {
2801 mService.reportNetworkConnectivity(network, hasConnectivity);
Robert Greenwalt9258c642014-03-26 16:47:06 -07002802 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002803 throw e.rethrowFromSystemServer();
Robert Greenwalt9258c642014-03-26 16:47:06 -07002804 }
2805 }
2806
2807 /**
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002808 * Set a network-independent global http proxy. This is not normally what you want
2809 * for typical HTTP proxies - they are general network dependent. However if you're
2810 * doing something unusual like general internal filtering this may be useful. On
2811 * a private network where the proxy is not accessible, you may break HTTP using this.
Paul Jensenb2748922015-05-06 11:10:18 -04002812 *
2813 * @param p A {@link ProxyInfo} object defining the new global
2814 * HTTP proxy. A {@code null} value will clear the global HTTP proxy.
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07002815 * @hide
Robert Greenwalt434203a2010-10-11 16:00:27 -07002816 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06002817 @RequiresPermission(android.Manifest.permission.CONNECTIVITY_INTERNAL)
Jason Monk207900c2014-04-25 15:00:09 -04002818 public void setGlobalProxy(ProxyInfo p) {
Robert Greenwalt434203a2010-10-11 16:00:27 -07002819 try {
2820 mService.setGlobalProxy(p);
2821 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002822 throw e.rethrowFromSystemServer();
Robert Greenwalt434203a2010-10-11 16:00:27 -07002823 }
2824 }
2825
2826 /**
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002827 * Retrieve any network-independent global HTTP proxy.
2828 *
Jason Monk207900c2014-04-25 15:00:09 -04002829 * @return {@link ProxyInfo} for the current global HTTP proxy or {@code null}
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002830 * if no global HTTP proxy is set.
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07002831 * @hide
Robert Greenwalt434203a2010-10-11 16:00:27 -07002832 */
Jason Monk207900c2014-04-25 15:00:09 -04002833 public ProxyInfo getGlobalProxy() {
Robert Greenwalt434203a2010-10-11 16:00:27 -07002834 try {
2835 return mService.getGlobalProxy();
2836 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002837 throw e.rethrowFromSystemServer();
Robert Greenwalt434203a2010-10-11 16:00:27 -07002838 }
2839 }
2840
2841 /**
Paul Jensencee9b512015-05-06 07:32:40 -04002842 * Retrieve the global HTTP proxy, or if no global HTTP proxy is set, a
2843 * network-specific HTTP proxy. If {@code network} is null, the
2844 * network-specific proxy returned is the proxy of the default active
2845 * network.
2846 *
2847 * @return {@link ProxyInfo} for the current global HTTP proxy, or if no
2848 * global HTTP proxy is set, {@code ProxyInfo} for {@code network},
2849 * or when {@code network} is {@code null},
2850 * the {@code ProxyInfo} for the default active network. Returns
2851 * {@code null} when no proxy applies or the caller doesn't have
2852 * permission to use {@code network}.
2853 * @hide
2854 */
2855 public ProxyInfo getProxyForNetwork(Network network) {
2856 try {
2857 return mService.getProxyForNetwork(network);
2858 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002859 throw e.rethrowFromSystemServer();
Paul Jensencee9b512015-05-06 07:32:40 -04002860 }
2861 }
2862
2863 /**
Paul Jensene0bef712014-12-10 15:12:18 -05002864 * Get the current default HTTP proxy settings. If a global proxy is set it will be returned,
2865 * otherwise if this process is bound to a {@link Network} using
Paul Jensen72db88e2015-03-10 10:54:12 -04002866 * {@link #bindProcessToNetwork} then that {@code Network}'s proxy is returned, otherwise
Paul Jensene0bef712014-12-10 15:12:18 -05002867 * the default network's proxy is returned.
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002868 *
Jason Monk207900c2014-04-25 15:00:09 -04002869 * @return the {@link ProxyInfo} for the current HTTP proxy, or {@code null} if no
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002870 * HTTP proxy is active.
Robert Greenwalt434203a2010-10-11 16:00:27 -07002871 */
Chalard Jean50bea3d2019-01-07 19:26:34 +09002872 @Nullable
Paul Jensene0bef712014-12-10 15:12:18 -05002873 public ProxyInfo getDefaultProxy() {
Paul Jensencee9b512015-05-06 07:32:40 -04002874 return getProxyForNetwork(getBoundNetworkForProcess());
Robert Greenwalt434203a2010-10-11 16:00:27 -07002875 }
Robert Greenwaltd55a6b42011-03-25 13:09:25 -07002876
2877 /**
Robert Greenwalt9b2886e2011-08-31 11:46:42 -07002878 * Returns true if the hardware supports the given network type
2879 * else it returns false. This doesn't indicate we have coverage
2880 * or are authorized onto a network, just whether or not the
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002881 * hardware supports it. For example a GSM phone without a SIM
2882 * should still return {@code true} for mobile data, but a wifi only
2883 * tablet would return {@code false}.
2884 *
2885 * @param networkType The network type we'd like to check
2886 * @return {@code true} if supported, else {@code false}
Chalard Jean6b1da6e2018-03-08 13:54:53 +09002887 * @deprecated Types are deprecated. Use {@link NetworkCapabilities} instead.
Robert Greenwalt9b2886e2011-08-31 11:46:42 -07002888 * @hide
2889 */
Chalard Jean6b1da6e2018-03-08 13:54:53 +09002890 @Deprecated
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06002891 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01002892 @UnsupportedAppUsage
Robert Greenwalt9b2886e2011-08-31 11:46:42 -07002893 public boolean isNetworkSupported(int networkType) {
2894 try {
2895 return mService.isNetworkSupported(networkType);
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002896 } catch (RemoteException e) {
2897 throw e.rethrowFromSystemServer();
2898 }
Robert Greenwalt9b2886e2011-08-31 11:46:42 -07002899 }
Jeff Sharkey9f7cbf02012-04-12 18:34:54 -07002900
2901 /**
2902 * Returns if the currently active data network is metered. A network is
2903 * classified as metered when the user is sensitive to heavy data usage on
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002904 * that connection due to monetary costs, data limitations or
2905 * battery/performance issues. You should check this before doing large
2906 * data transfers, and warn the user or delay the operation until another
2907 * network is available.
2908 *
2909 * @return {@code true} if large transfers should be avoided, otherwise
2910 * {@code false}.
Jeff Sharkey9f7cbf02012-04-12 18:34:54 -07002911 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06002912 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Jeff Sharkey9f7cbf02012-04-12 18:34:54 -07002913 public boolean isActiveNetworkMetered() {
2914 try {
2915 return mService.isActiveNetworkMetered();
2916 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002917 throw e.rethrowFromSystemServer();
Jeff Sharkey9f7cbf02012-04-12 18:34:54 -07002918 }
2919 }
Jeff Sharkey69ddab42012-08-25 00:05:46 -07002920
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002921 /**
2922 * If the LockdownVpn mechanism is enabled, updates the vpn
2923 * with a reload of its profile.
2924 *
2925 * @return a boolean with {@code} indicating success
2926 *
2927 * <p>This method can only be called by the system UID
2928 * {@hide}
2929 */
Jeff Sharkey69ddab42012-08-25 00:05:46 -07002930 public boolean updateLockdownVpn() {
2931 try {
2932 return mService.updateLockdownVpn();
2933 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002934 throw e.rethrowFromSystemServer();
Jeff Sharkey69ddab42012-08-25 00:05:46 -07002935 }
2936 }
Irfan Sheriffda6da092012-08-16 12:49:23 -07002937
2938 /**
Wink Saville948282b2013-08-29 08:55:16 -07002939 * Check mobile provisioning.
Wink Savilleab9321d2013-06-29 21:10:57 -07002940 *
Wink Savilleab9321d2013-06-29 21:10:57 -07002941 * @param suggestedTimeOutMs, timeout in milliseconds
Wink Savilleab9321d2013-06-29 21:10:57 -07002942 *
2943 * @return time out that will be used, maybe less that suggestedTimeOutMs
2944 * -1 if an error.
2945 *
2946 * {@hide}
2947 */
Wink Saville948282b2013-08-29 08:55:16 -07002948 public int checkMobileProvisioning(int suggestedTimeOutMs) {
Wink Savilleab9321d2013-06-29 21:10:57 -07002949 int timeOutMs = -1;
2950 try {
Wink Saville948282b2013-08-29 08:55:16 -07002951 timeOutMs = mService.checkMobileProvisioning(suggestedTimeOutMs);
Wink Savilleab9321d2013-06-29 21:10:57 -07002952 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002953 throw e.rethrowFromSystemServer();
Wink Savilleab9321d2013-06-29 21:10:57 -07002954 }
2955 return timeOutMs;
2956 }
Robert Greenwalte182bfe2013-07-16 12:06:09 -07002957
2958 /**
Wink Saville42d4f082013-07-20 20:31:59 -07002959 * Get the mobile provisioning url.
Robert Greenwalte182bfe2013-07-16 12:06:09 -07002960 * {@hide}
2961 */
2962 public String getMobileProvisioningUrl() {
2963 try {
2964 return mService.getMobileProvisioningUrl();
2965 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002966 throw e.rethrowFromSystemServer();
Robert Greenwalte182bfe2013-07-16 12:06:09 -07002967 }
Robert Greenwalte182bfe2013-07-16 12:06:09 -07002968 }
Wink Saville42d4f082013-07-20 20:31:59 -07002969
2970 /**
Wink Saville948282b2013-08-29 08:55:16 -07002971 * Set sign in error notification to visible or in visible
2972 *
Wink Saville948282b2013-08-29 08:55:16 -07002973 * {@hide}
Paul Jensen3541e9f2015-03-18 12:23:02 -04002974 * @deprecated Doesn't properly deal with multiple connected networks of the same type.
Wink Saville948282b2013-08-29 08:55:16 -07002975 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07002976 @Deprecated
Wink Saville948282b2013-08-29 08:55:16 -07002977 public void setProvisioningNotificationVisible(boolean visible, int networkType,
Paul Jensen89e0f092014-09-15 15:59:36 -04002978 String action) {
Wink Saville948282b2013-08-29 08:55:16 -07002979 try {
Paul Jensen89e0f092014-09-15 15:59:36 -04002980 mService.setProvisioningNotificationVisible(visible, networkType, action);
Wink Saville948282b2013-08-29 08:55:16 -07002981 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002982 throw e.rethrowFromSystemServer();
Wink Saville948282b2013-08-29 08:55:16 -07002983 }
2984 }
Yuhao Zheng5cd1a0e2013-09-09 17:00:04 -07002985
2986 /**
2987 * Set the value for enabling/disabling airplane mode
2988 *
2989 * @param enable whether to enable airplane mode or not
2990 *
Yuhao Zheng5cd1a0e2013-09-09 17:00:04 -07002991 * @hide
2992 */
Lorenzo Colittif5845d12018-10-09 18:55:11 +09002993 @RequiresPermission(anyOf = {
2994 android.Manifest.permission.NETWORK_SETTINGS,
2995 android.Manifest.permission.NETWORK_SETUP_WIZARD,
2996 android.Manifest.permission.NETWORK_STACK})
Lorenzo Colitti85eca482018-10-09 18:50:32 +09002997 @SystemApi
Yuhao Zheng5cd1a0e2013-09-09 17:00:04 -07002998 public void setAirplaneMode(boolean enable) {
2999 try {
3000 mService.setAirplaneMode(enable);
3001 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07003002 throw e.rethrowFromSystemServer();
Yuhao Zheng5cd1a0e2013-09-09 17:00:04 -07003003 }
3004 }
Robert Greenwalte049c232014-04-11 15:53:27 -07003005
Chalard Jean08577fc2018-05-02 21:14:54 +09003006 /** {@hide} - returns the factory serial number */
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01003007 @UnsupportedAppUsage
Chalard Jean08577fc2018-05-02 21:14:54 +09003008 public int registerNetworkFactory(Messenger messenger, String name) {
Robert Greenwalte049c232014-04-11 15:53:27 -07003009 try {
Chalard Jean08577fc2018-05-02 21:14:54 +09003010 return mService.registerNetworkFactory(messenger, name);
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07003011 } catch (RemoteException e) {
3012 throw e.rethrowFromSystemServer();
3013 }
Robert Greenwalta67be032014-05-16 15:49:14 -07003014 }
3015
3016 /** {@hide} */
Mathew Inwood55418ea2018-12-20 15:30:45 +00003017 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 115609023)
Robert Greenwalta67be032014-05-16 15:49:14 -07003018 public void unregisterNetworkFactory(Messenger messenger) {
3019 try {
3020 mService.unregisterNetworkFactory(messenger);
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07003021 } catch (RemoteException e) {
3022 throw e.rethrowFromSystemServer();
3023 }
Robert Greenwalte049c232014-04-11 15:53:27 -07003024 }
Robert Greenwalt7b816022014-04-18 15:25:25 -07003025
Chalard Jean08577fc2018-05-02 21:14:54 +09003026 // TODO : remove this method. It is a stopgap measure to help sheperding a number
3027 // of dependent changes that would conflict throughout the automerger graph. Having this
3028 // temporarily helps with the process of going through with all these dependent changes across
3029 // the entire tree.
Paul Jensen31a94f42015-02-13 14:18:39 -05003030 /**
3031 * @hide
3032 * Register a NetworkAgent with ConnectivityService.
3033 * @return NetID corresponding to NetworkAgent.
3034 */
3035 public int registerNetworkAgent(Messenger messenger, NetworkInfo ni, LinkProperties lp,
Sreeram Ramachandran8cd33ed2014-07-23 15:23:15 -07003036 NetworkCapabilities nc, int score, NetworkMisc misc) {
Chalard Jean08577fc2018-05-02 21:14:54 +09003037 return registerNetworkAgent(messenger, ni, lp, nc, score, misc,
3038 NetworkFactory.SerialNumber.NONE);
3039 }
3040
3041 /**
3042 * @hide
3043 * Register a NetworkAgent with ConnectivityService.
3044 * @return NetID corresponding to NetworkAgent.
3045 */
3046 public int registerNetworkAgent(Messenger messenger, NetworkInfo ni, LinkProperties lp,
3047 NetworkCapabilities nc, int score, NetworkMisc misc, int factorySerialNumber) {
Robert Greenwalt7b816022014-04-18 15:25:25 -07003048 try {
Chalard Jean08577fc2018-05-02 21:14:54 +09003049 return mService.registerNetworkAgent(messenger, ni, lp, nc, score, misc,
3050 factorySerialNumber);
Paul Jensen31a94f42015-02-13 14:18:39 -05003051 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07003052 throw e.rethrowFromSystemServer();
Paul Jensen31a94f42015-02-13 14:18:39 -05003053 }
Robert Greenwalt7b816022014-04-18 15:25:25 -07003054 }
3055
Robert Greenwalt9258c642014-03-26 16:47:06 -07003056 /**
Hugo Benichidafed3d2017-03-06 09:17:06 +09003057 * Base class for {@code NetworkRequest} callbacks. Used for notifications about network
3058 * changes. Should be extended by applications wanting notifications.
3059 *
3060 * A {@code NetworkCallback} is registered by calling
3061 * {@link #requestNetwork(NetworkRequest, NetworkCallback)},
3062 * {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)},
Hugo Benichica867dc2018-02-07 21:17:43 +09003063 * or {@link #registerDefaultNetworkCallback(NetworkCallback)}. A {@code NetworkCallback} is
Hugo Benichidafed3d2017-03-06 09:17:06 +09003064 * unregistered by calling {@link #unregisterNetworkCallback(NetworkCallback)}.
3065 * A {@code NetworkCallback} should be registered at most once at any time.
3066 * A {@code NetworkCallback} that has been unregistered can be registered again.
Robert Greenwalt9258c642014-03-26 16:47:06 -07003067 */
Robert Greenwalt6078b502014-06-11 16:05:07 -07003068 public static class NetworkCallback {
Robert Greenwalt7b816022014-04-18 15:25:25 -07003069 /**
Lorenzo Colitti07086932015-04-24 12:23:24 +09003070 * Called when the framework connects to a new network to evaluate whether it satisfies this
3071 * request. If evaluation succeeds, this callback may be followed by an {@link #onAvailable}
3072 * callback. There is no guarantee that this new network will satisfy any requests, or that
3073 * the network will stay connected for longer than the time necessary to evaluate it.
3074 * <p>
3075 * Most applications <b>should not</b> act on this callback, and should instead use
3076 * {@link #onAvailable}. This callback is intended for use by applications that can assist
3077 * the framework in properly evaluating the network &mdash; for example, an application that
3078 * can automatically log in to a captive portal without user intervention.
3079 *
3080 * @param network The {@link Network} of the network that is being evaluated.
Lorenzo Colitti66276122015-06-11 14:27:17 +09003081 *
3082 * @hide
Robert Greenwalt7b816022014-04-18 15:25:25 -07003083 */
Robert Greenwalt6078b502014-06-11 16:05:07 -07003084 public void onPreCheck(Network network) {}
Robert Greenwalt7b816022014-04-18 15:25:25 -07003085
3086 /**
Lorenzo Colitti07086932015-04-24 12:23:24 +09003087 * Called when the framework connects and has declared a new network ready for use.
Robert Greenwalt6078b502014-06-11 16:05:07 -07003088 * This callback may be called more than once if the {@link Network} that is
3089 * satisfying the request changes.
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07003090 *
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07003091 * @param network The {@link Network} of the satisfying network.
Chalard Jean804b8fb2018-01-30 22:41:41 +09003092 * @param networkCapabilities The {@link NetworkCapabilities} of the satisfying network.
3093 * @param linkProperties The {@link LinkProperties} of the satisfying network.
junyulai05986c62018-08-07 19:50:45 +08003094 * @param blocked Whether access to the {@link Network} is blocked due to system policy.
Chalard Jean804b8fb2018-01-30 22:41:41 +09003095 * @hide
3096 */
3097 public void onAvailable(Network network, NetworkCapabilities networkCapabilities,
junyulai05986c62018-08-07 19:50:45 +08003098 LinkProperties linkProperties, boolean blocked) {
Chalard Jean804b8fb2018-01-30 22:41:41 +09003099 // Internally only this method is called when a new network is available, and
3100 // it calls the callback in the same way and order that older versions used
3101 // to call so as not to change the behavior.
3102 onAvailable(network);
3103 if (!networkCapabilities.hasCapability(
3104 NetworkCapabilities.NET_CAPABILITY_NOT_SUSPENDED)) {
3105 onNetworkSuspended(network);
3106 }
3107 onCapabilitiesChanged(network, networkCapabilities);
3108 onLinkPropertiesChanged(network, linkProperties);
junyulai05986c62018-08-07 19:50:45 +08003109 onBlockedStatusChanged(network, blocked);
Chalard Jean804b8fb2018-01-30 22:41:41 +09003110 }
3111
3112 /**
3113 * Called when the framework connects and has declared a new network ready for use.
3114 * This callback may be called more than once if the {@link Network} that is
3115 * satisfying the request changes. This will always immediately be followed by a
3116 * call to {@link #onCapabilitiesChanged(Network, NetworkCapabilities)} then by a
junyulai05986c62018-08-07 19:50:45 +08003117 * call to {@link #onLinkPropertiesChanged(Network, LinkProperties)}, and a call to
3118 * {@link #onBlockedStatusChanged(Network, boolean)}.
Chalard Jean804b8fb2018-01-30 22:41:41 +09003119 *
3120 * @param network The {@link Network} of the satisfying network.
Robert Greenwalt7b816022014-04-18 15:25:25 -07003121 */
Robert Greenwalt6078b502014-06-11 16:05:07 -07003122 public void onAvailable(Network network) {}
Robert Greenwalt7b816022014-04-18 15:25:25 -07003123
3124 /**
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07003125 * Called when the network is about to be disconnected. Often paired with an
Robert Greenwalt6078b502014-06-11 16:05:07 -07003126 * {@link NetworkCallback#onAvailable} call with the new replacement network
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07003127 * for graceful handover. This may not be called if we have a hard loss
3128 * (loss without warning). This may be followed by either a
Robert Greenwalt6078b502014-06-11 16:05:07 -07003129 * {@link NetworkCallback#onLost} call or a
3130 * {@link NetworkCallback#onAvailable} call for this network depending
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07003131 * on whether we lose or regain it.
3132 *
Robert Greenwalt6078b502014-06-11 16:05:07 -07003133 * @param network The {@link Network} that is about to be disconnected.
3134 * @param maxMsToLive The time in ms the framework will attempt to keep the
3135 * network connected. Note that the network may suffer a
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07003136 * hard loss at any time.
Robert Greenwalt7b816022014-04-18 15:25:25 -07003137 */
Robert Greenwalt6078b502014-06-11 16:05:07 -07003138 public void onLosing(Network network, int maxMsToLive) {}
Robert Greenwalt7b816022014-04-18 15:25:25 -07003139
3140 /**
3141 * Called when the framework has a hard loss of the network or when the
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07003142 * graceful failure ends.
3143 *
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07003144 * @param network The {@link Network} lost.
Robert Greenwalt7b816022014-04-18 15:25:25 -07003145 */
Robert Greenwalt6078b502014-06-11 16:05:07 -07003146 public void onLost(Network network) {}
Robert Greenwalt7b816022014-04-18 15:25:25 -07003147
3148 /**
Etan Cohenaebf17e2017-03-01 12:47:28 -08003149 * Called if no network is found in the timeout time specified in
Etan Cohenae574a82019-01-08 12:09:18 -08003150 * {@link #requestNetwork(NetworkRequest, NetworkCallback, int)} call or if the
3151 * requested network request cannot be fulfilled (whether or not a timeout was
3152 * specified). When this callback is invoked the associated
Etan Cohenaebf17e2017-03-01 12:47:28 -08003153 * {@link NetworkRequest} will have already been removed and released, as if
3154 * {@link #unregisterNetworkCallback(NetworkCallback)} had been called.
Robert Greenwalt7b816022014-04-18 15:25:25 -07003155 */
Robert Greenwalt6078b502014-06-11 16:05:07 -07003156 public void onUnavailable() {}
Robert Greenwalt7b816022014-04-18 15:25:25 -07003157
3158 /**
3159 * Called when the network the framework connected to for this request
3160 * changes capabilities but still satisfies the stated need.
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07003161 *
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07003162 * @param network The {@link Network} whose capabilities have changed.
Chalard Jean804b8fb2018-01-30 22:41:41 +09003163 * @param networkCapabilities The new {@link android.net.NetworkCapabilities} for this
3164 * network.
Robert Greenwalt7b816022014-04-18 15:25:25 -07003165 */
Robert Greenwalt6078b502014-06-11 16:05:07 -07003166 public void onCapabilitiesChanged(Network network,
Robert Greenwalt7b816022014-04-18 15:25:25 -07003167 NetworkCapabilities networkCapabilities) {}
3168
3169 /**
3170 * Called when the network the framework connected to for this request
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07003171 * changes {@link LinkProperties}.
3172 *
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07003173 * @param network The {@link Network} whose link properties have changed.
3174 * @param linkProperties The new {@link LinkProperties} for this network.
Robert Greenwalt7b816022014-04-18 15:25:25 -07003175 */
Robert Greenwalt6078b502014-06-11 16:05:07 -07003176 public void onLinkPropertiesChanged(Network network, LinkProperties linkProperties) {}
Robert Greenwalt7b816022014-04-18 15:25:25 -07003177
Robert Greenwalt8d482522015-06-24 13:23:42 -07003178 /**
3179 * Called when the network the framework connected to for this request
Chalard Jean804b8fb2018-01-30 22:41:41 +09003180 * goes into {@link NetworkInfo.State#SUSPENDED}.
Robert Greenwalt8d482522015-06-24 13:23:42 -07003181 * This generally means that while the TCP connections are still live,
3182 * temporarily network data fails to transfer. Specifically this is used
3183 * on cellular networks to mask temporary outages when driving through
3184 * a tunnel, etc.
3185 * @hide
3186 */
3187 public void onNetworkSuspended(Network network) {}
3188
3189 /**
3190 * Called when the network the framework connected to for this request
Chalard Jean804b8fb2018-01-30 22:41:41 +09003191 * returns from a {@link NetworkInfo.State#SUSPENDED} state. This should always be
3192 * preceded by a matching {@link NetworkCallback#onNetworkSuspended} call.
Robert Greenwalt8d482522015-06-24 13:23:42 -07003193 * @hide
3194 */
3195 public void onNetworkResumed(Network network) {}
3196
junyulai05986c62018-08-07 19:50:45 +08003197 /**
3198 * Called when access to the specified network is blocked or unblocked.
3199 *
3200 * @param network The {@link Network} whose blocked status has changed.
3201 * @param blocked The blocked status of this {@link Network}.
3202 */
3203 public void onBlockedStatusChanged(Network network, boolean blocked) {}
3204
Robert Greenwalt6078b502014-06-11 16:05:07 -07003205 private NetworkRequest networkRequest;
Robert Greenwalt7b816022014-04-18 15:25:25 -07003206 }
3207
Hugo Benichicb883232017-05-11 13:16:17 +09003208 /**
3209 * Constant error codes used by ConnectivityService to communicate about failures and errors
3210 * across a Binder boundary.
3211 * @hide
3212 */
3213 public interface Errors {
Chalard Jean4d660112018-06-04 16:52:49 +09003214 int TOO_MANY_REQUESTS = 1;
Hugo Benichicb883232017-05-11 13:16:17 +09003215 }
3216
3217 /** @hide */
3218 public static class TooManyRequestsException extends RuntimeException {}
3219
3220 private static RuntimeException convertServiceException(ServiceSpecificException e) {
3221 switch (e.errorCode) {
3222 case Errors.TOO_MANY_REQUESTS:
3223 return new TooManyRequestsException();
3224 default:
3225 Log.w(TAG, "Unknown service error code " + e.errorCode);
3226 return new RuntimeException(e);
3227 }
3228 }
3229
Robert Greenwalt9258c642014-03-26 16:47:06 -07003230 private static final int BASE = Protocol.BASE_CONNECTIVITY_MANAGER;
Robert Greenwalt9258c642014-03-26 16:47:06 -07003231 /** @hide */
Robert Greenwalt8d482522015-06-24 13:23:42 -07003232 public static final int CALLBACK_PRECHECK = BASE + 1;
3233 /** @hide */
3234 public static final int CALLBACK_AVAILABLE = BASE + 2;
3235 /** @hide arg1 = TTL */
3236 public static final int CALLBACK_LOSING = BASE + 3;
3237 /** @hide */
3238 public static final int CALLBACK_LOST = BASE + 4;
3239 /** @hide */
3240 public static final int CALLBACK_UNAVAIL = BASE + 5;
3241 /** @hide */
3242 public static final int CALLBACK_CAP_CHANGED = BASE + 6;
3243 /** @hide */
3244 public static final int CALLBACK_IP_CHANGED = BASE + 7;
Robert Greenwalt562cc542014-05-15 18:07:26 -07003245 /** @hide obj = NetworkCapabilities, arg1 = seq number */
Hugo Benichidba33db2017-03-23 22:40:44 +09003246 private static final int EXPIRE_LEGACY_REQUEST = BASE + 8;
Robert Greenwalt8d482522015-06-24 13:23:42 -07003247 /** @hide */
Hugo Benichidba33db2017-03-23 22:40:44 +09003248 public static final int CALLBACK_SUSPENDED = BASE + 9;
Robert Greenwalt8d482522015-06-24 13:23:42 -07003249 /** @hide */
Hugo Benichidba33db2017-03-23 22:40:44 +09003250 public static final int CALLBACK_RESUMED = BASE + 10;
junyulai05986c62018-08-07 19:50:45 +08003251 /** @hide */
3252 public static final int CALLBACK_BLK_CHANGED = BASE + 11;
Robert Greenwalt9258c642014-03-26 16:47:06 -07003253
Erik Kline57faba92015-11-25 12:49:38 +09003254 /** @hide */
3255 public static String getCallbackName(int whichCallback) {
3256 switch (whichCallback) {
3257 case CALLBACK_PRECHECK: return "CALLBACK_PRECHECK";
3258 case CALLBACK_AVAILABLE: return "CALLBACK_AVAILABLE";
3259 case CALLBACK_LOSING: return "CALLBACK_LOSING";
3260 case CALLBACK_LOST: return "CALLBACK_LOST";
3261 case CALLBACK_UNAVAIL: return "CALLBACK_UNAVAIL";
3262 case CALLBACK_CAP_CHANGED: return "CALLBACK_CAP_CHANGED";
3263 case CALLBACK_IP_CHANGED: return "CALLBACK_IP_CHANGED";
Erik Kline57faba92015-11-25 12:49:38 +09003264 case EXPIRE_LEGACY_REQUEST: return "EXPIRE_LEGACY_REQUEST";
3265 case CALLBACK_SUSPENDED: return "CALLBACK_SUSPENDED";
3266 case CALLBACK_RESUMED: return "CALLBACK_RESUMED";
junyulai05986c62018-08-07 19:50:45 +08003267 case CALLBACK_BLK_CHANGED: return "CALLBACK_BLK_CHANGED";
Erik Kline57faba92015-11-25 12:49:38 +09003268 default:
3269 return Integer.toString(whichCallback);
3270 }
3271 }
3272
Robert Greenwalt562cc542014-05-15 18:07:26 -07003273 private class CallbackHandler extends Handler {
Robert Greenwalt9258c642014-03-26 16:47:06 -07003274 private static final String TAG = "ConnectivityManager.CallbackHandler";
Robert Greenwalta9ebeef2015-09-03 16:41:45 -07003275 private static final boolean DBG = false;
Robert Greenwalt9258c642014-03-26 16:47:06 -07003276
Hugo Benichid42650f2016-07-06 22:53:17 +09003277 CallbackHandler(Looper looper) {
Robert Greenwalt9258c642014-03-26 16:47:06 -07003278 super(looper);
Robert Greenwalt9258c642014-03-26 16:47:06 -07003279 }
3280
Hugo Benichi2583ef02017-02-02 17:02:36 +09003281 CallbackHandler(Handler handler) {
Hugo Benichie7678512017-05-09 15:19:01 +09003282 this(Preconditions.checkNotNull(handler, "Handler cannot be null.").getLooper());
Hugo Benichi2583ef02017-02-02 17:02:36 +09003283 }
3284
Robert Greenwalt9258c642014-03-26 16:47:06 -07003285 @Override
3286 public void handleMessage(Message message) {
Hugo Benichi2c684522017-05-09 14:36:02 +09003287 if (message.what == EXPIRE_LEGACY_REQUEST) {
3288 expireRequest((NetworkCapabilities) message.obj, message.arg1);
3289 return;
3290 }
3291
3292 final NetworkRequest request = getObject(message, NetworkRequest.class);
3293 final Network network = getObject(message, Network.class);
3294 final NetworkCallback callback;
3295 synchronized (sCallbacks) {
3296 callback = sCallbacks.get(request);
3297 }
Lorenzo Colittifcfa7d92016-03-01 22:56:37 +09003298 if (DBG) {
Hugo Benichia0385682017-03-22 17:07:57 +09003299 Log.d(TAG, getCallbackName(message.what) + " for network " + network);
Lorenzo Colittifcfa7d92016-03-01 22:56:37 +09003300 }
Hugo Benichi2c684522017-05-09 14:36:02 +09003301 if (callback == null) {
3302 Log.w(TAG, "callback not found for " + getCallbackName(message.what) + " message");
3303 return;
3304 }
3305
Robert Greenwalt9258c642014-03-26 16:47:06 -07003306 switch (message.what) {
3307 case CALLBACK_PRECHECK: {
Hugo Benichi2c684522017-05-09 14:36:02 +09003308 callback.onPreCheck(network);
Robert Greenwalt9258c642014-03-26 16:47:06 -07003309 break;
3310 }
3311 case CALLBACK_AVAILABLE: {
Chalard Jean804b8fb2018-01-30 22:41:41 +09003312 NetworkCapabilities cap = getObject(message, NetworkCapabilities.class);
3313 LinkProperties lp = getObject(message, LinkProperties.class);
junyulai05986c62018-08-07 19:50:45 +08003314 callback.onAvailable(network, cap, lp, message.arg1 != 0);
Robert Greenwalt9258c642014-03-26 16:47:06 -07003315 break;
3316 }
3317 case CALLBACK_LOSING: {
Hugo Benichi2c684522017-05-09 14:36:02 +09003318 callback.onLosing(network, message.arg1);
Robert Greenwalt9258c642014-03-26 16:47:06 -07003319 break;
3320 }
3321 case CALLBACK_LOST: {
Hugo Benichi2c684522017-05-09 14:36:02 +09003322 callback.onLost(network);
Robert Greenwalt9258c642014-03-26 16:47:06 -07003323 break;
3324 }
3325 case CALLBACK_UNAVAIL: {
Hugo Benichi2c684522017-05-09 14:36:02 +09003326 callback.onUnavailable();
Robert Greenwalt9258c642014-03-26 16:47:06 -07003327 break;
3328 }
3329 case CALLBACK_CAP_CHANGED: {
Hugo Benichi2c684522017-05-09 14:36:02 +09003330 NetworkCapabilities cap = getObject(message, NetworkCapabilities.class);
3331 callback.onCapabilitiesChanged(network, cap);
Robert Greenwalt9258c642014-03-26 16:47:06 -07003332 break;
3333 }
3334 case CALLBACK_IP_CHANGED: {
Hugo Benichi2c684522017-05-09 14:36:02 +09003335 LinkProperties lp = getObject(message, LinkProperties.class);
3336 callback.onLinkPropertiesChanged(network, lp);
Robert Greenwalt9258c642014-03-26 16:47:06 -07003337 break;
3338 }
Robert Greenwalt8d482522015-06-24 13:23:42 -07003339 case CALLBACK_SUSPENDED: {
Hugo Benichi2c684522017-05-09 14:36:02 +09003340 callback.onNetworkSuspended(network);
Robert Greenwalt8d482522015-06-24 13:23:42 -07003341 break;
3342 }
3343 case CALLBACK_RESUMED: {
Hugo Benichi2c684522017-05-09 14:36:02 +09003344 callback.onNetworkResumed(network);
Robert Greenwalt562cc542014-05-15 18:07:26 -07003345 break;
3346 }
junyulai05986c62018-08-07 19:50:45 +08003347 case CALLBACK_BLK_CHANGED: {
3348 boolean blocked = message.arg1 != 0;
3349 callback.onBlockedStatusChanged(network, blocked);
3350 }
Robert Greenwalt9258c642014-03-26 16:47:06 -07003351 }
3352 }
3353
Hugo Benichid42650f2016-07-06 22:53:17 +09003354 private <T> T getObject(Message msg, Class<T> c) {
3355 return (T) msg.getData().getParcelable(c.getSimpleName());
Robert Greenwalt9258c642014-03-26 16:47:06 -07003356 }
Robert Greenwalt9258c642014-03-26 16:47:06 -07003357 }
3358
Hugo Benichi2583ef02017-02-02 17:02:36 +09003359 private CallbackHandler getDefaultHandler() {
Hugo Benichi7724cdd2016-07-07 10:15:56 +09003360 synchronized (sCallbacks) {
3361 if (sCallbackHandler == null) {
3362 sCallbackHandler = new CallbackHandler(ConnectivityThread.getInstanceLooper());
Robert Greenwalt9258c642014-03-26 16:47:06 -07003363 }
Hugo Benichi7724cdd2016-07-07 10:15:56 +09003364 return sCallbackHandler;
Robert Greenwalt9258c642014-03-26 16:47:06 -07003365 }
3366 }
3367
Hugo Benichi6f260f32017-02-03 14:18:44 +09003368 private static final HashMap<NetworkRequest, NetworkCallback> sCallbacks = new HashMap<>();
3369 private static CallbackHandler sCallbackHandler;
Robert Greenwalt9258c642014-03-26 16:47:06 -07003370
Hugo Benichi6f260f32017-02-03 14:18:44 +09003371 private static final int LISTEN = 1;
3372 private static final int REQUEST = 2;
Robert Greenwalt9258c642014-03-26 16:47:06 -07003373
Hugo Benichi6f260f32017-02-03 14:18:44 +09003374 private NetworkRequest sendRequestForNetwork(NetworkCapabilities need, NetworkCallback callback,
3375 int timeoutMs, int action, int legacyType, CallbackHandler handler) {
Soi, Yoshinaridee2aa42015-11-12 12:09:02 +09003376 printStackTrace();
Hugo Benichie7678512017-05-09 15:19:01 +09003377 checkCallbackNotNull(callback);
Hugo Benichidafed3d2017-03-06 09:17:06 +09003378 Preconditions.checkArgument(action == REQUEST || need != null, "null NetworkCapabilities");
Hugo Benichid42650f2016-07-06 22:53:17 +09003379 final NetworkRequest request;
Robert Greenwalt9258c642014-03-26 16:47:06 -07003380 try {
Hugo Benichid42650f2016-07-06 22:53:17 +09003381 synchronized(sCallbacks) {
Hugo Benichi31c176d2017-06-17 13:14:12 +09003382 if (callback.networkRequest != null
3383 && callback.networkRequest != ALREADY_UNREGISTERED) {
Hugo Benichidafed3d2017-03-06 09:17:06 +09003384 // TODO: throw exception instead and enforce 1:1 mapping of callbacks
3385 // and requests (http://b/20701525).
3386 Log.e(TAG, "NetworkCallback was already registered");
3387 }
Hugo Benichi7724cdd2016-07-07 10:15:56 +09003388 Messenger messenger = new Messenger(handler);
Hugo Benichid42650f2016-07-06 22:53:17 +09003389 Binder binder = new Binder();
Paul Jensen7221cc32014-06-27 11:05:32 -04003390 if (action == LISTEN) {
Hugo Benichid42650f2016-07-06 22:53:17 +09003391 request = mService.listenForNetwork(need, messenger, binder);
Paul Jensen7221cc32014-06-27 11:05:32 -04003392 } else {
Hugo Benichid42650f2016-07-06 22:53:17 +09003393 request = mService.requestNetwork(
3394 need, messenger, timeoutMs, binder, legacyType);
Paul Jensen7221cc32014-06-27 11:05:32 -04003395 }
Hugo Benichid42650f2016-07-06 22:53:17 +09003396 if (request != null) {
Hugo Benichi7724cdd2016-07-07 10:15:56 +09003397 sCallbacks.put(request, callback);
Robert Greenwalt9258c642014-03-26 16:47:06 -07003398 }
Hugo Benichi7724cdd2016-07-07 10:15:56 +09003399 callback.networkRequest = request;
Robert Greenwalt9258c642014-03-26 16:47:06 -07003400 }
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07003401 } catch (RemoteException e) {
3402 throw e.rethrowFromSystemServer();
Hugo Benichicb883232017-05-11 13:16:17 +09003403 } catch (ServiceSpecificException e) {
3404 throw convertServiceException(e);
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07003405 }
Hugo Benichid42650f2016-07-06 22:53:17 +09003406 return request;
Robert Greenwalt9258c642014-03-26 16:47:06 -07003407 }
3408
3409 /**
Erik Klinea2d29402016-03-16 15:31:39 +09003410 * Helper function to request a network with a particular legacy type.
Lorenzo Colitti7de289f2015-11-25 12:00:52 +09003411 *
3412 * This is temporarily public @hide so it can be called by system code that uses the
3413 * NetworkRequest API to request networks but relies on CONNECTIVITY_ACTION broadcasts for
3414 * instead network notifications.
3415 *
3416 * TODO: update said system code to rely on NetworkCallbacks and make this method private.
3417 *
3418 * @hide
3419 */
Chalard Jean50bea3d2019-01-07 19:26:34 +09003420 public void requestNetwork(@NonNull NetworkRequest request,
3421 @NonNull NetworkCallback networkCallback, int timeoutMs, int legacyType,
3422 @NonNull Handler handler) {
Hugo Benichi2583ef02017-02-02 17:02:36 +09003423 CallbackHandler cbHandler = new CallbackHandler(handler);
3424 NetworkCapabilities nc = request.networkCapabilities;
3425 sendRequestForNetwork(nc, networkCallback, timeoutMs, REQUEST, legacyType, cbHandler);
Lorenzo Colitti7de289f2015-11-25 12:00:52 +09003426 }
3427
3428 /**
Lorenzo Colittie285b432015-04-23 15:32:42 +09003429 * Request a network to satisfy a set of {@link android.net.NetworkCapabilities}.
Robert Greenwalt9258c642014-03-26 16:47:06 -07003430 *
3431 * This {@link NetworkRequest} will live until released via
Etan Cohenaebf17e2017-03-01 12:47:28 -08003432 * {@link #unregisterNetworkCallback(NetworkCallback)} or the calling application exits. A
3433 * version of the method which takes a timeout is
Hugo Benichi0eec03f2017-05-15 15:15:33 +09003434 * {@link #requestNetwork(NetworkRequest, NetworkCallback, int)}.
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07003435 * Status of the request can be followed by listening to the various
Robert Greenwalt6078b502014-06-11 16:05:07 -07003436 * callbacks described in {@link NetworkCallback}. The {@link Network}
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07003437 * can be used to direct traffic to the network.
Paul Jensenbb2e0e92015-06-16 15:11:58 -04003438 * <p>It is presently unsupported to request a network with mutable
3439 * {@link NetworkCapabilities} such as
3440 * {@link NetworkCapabilities#NET_CAPABILITY_VALIDATED} or
3441 * {@link NetworkCapabilities#NET_CAPABILITY_CAPTIVE_PORTAL}
3442 * as these {@code NetworkCapabilities} represent states that a particular
3443 * network may never attain, and whether a network will attain these states
3444 * is unknown prior to bringing up the network so the framework does not
3445 * know how to go about satisfing a request with these capabilities.
Lorenzo Colittid5427052015-10-15 16:29:00 +09003446 *
3447 * <p>This method requires the caller to hold either the
3448 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
3449 * or the ability to modify system settings as determined by
3450 * {@link android.provider.Settings.System#canWrite}.</p>
Robert Greenwalt9258c642014-03-26 16:47:06 -07003451 *
Robert Greenwalt6078b502014-06-11 16:05:07 -07003452 * @param request {@link NetworkRequest} describing this request.
Hugo Benichi2583ef02017-02-02 17:02:36 +09003453 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
3454 * the callback must not be shared - it uniquely specifies this request.
3455 * The callback is invoked on the default internal Handler.
Paul Jensenbb2e0e92015-06-16 15:11:58 -04003456 * @throws IllegalArgumentException if {@code request} specifies any mutable
3457 * {@code NetworkCapabilities}.
Robert Greenwalt9258c642014-03-26 16:47:06 -07003458 */
Chalard Jean50bea3d2019-01-07 19:26:34 +09003459 public void requestNetwork(@NonNull NetworkRequest request,
3460 @NonNull NetworkCallback networkCallback) {
Hugo Benichi2583ef02017-02-02 17:02:36 +09003461 requestNetwork(request, networkCallback, getDefaultHandler());
3462 }
3463
3464 /**
3465 * Request a network to satisfy a set of {@link android.net.NetworkCapabilities}.
3466 *
3467 * This {@link NetworkRequest} will live until released via
Etan Cohenaebf17e2017-03-01 12:47:28 -08003468 * {@link #unregisterNetworkCallback(NetworkCallback)} or the calling application exits. A
3469 * version of the method which takes a timeout is
Hugo Benichi0eec03f2017-05-15 15:15:33 +09003470 * {@link #requestNetwork(NetworkRequest, NetworkCallback, int)}.
Hugo Benichi2583ef02017-02-02 17:02:36 +09003471 * Status of the request can be followed by listening to the various
3472 * callbacks described in {@link NetworkCallback}. The {@link Network}
3473 * can be used to direct traffic to the network.
3474 * <p>It is presently unsupported to request a network with mutable
3475 * {@link NetworkCapabilities} such as
3476 * {@link NetworkCapabilities#NET_CAPABILITY_VALIDATED} or
3477 * {@link NetworkCapabilities#NET_CAPABILITY_CAPTIVE_PORTAL}
3478 * as these {@code NetworkCapabilities} represent states that a particular
3479 * network may never attain, and whether a network will attain these states
3480 * is unknown prior to bringing up the network so the framework does not
Chalard Jean4d660112018-06-04 16:52:49 +09003481 * know how to go about satisfying a request with these capabilities.
Hugo Benichi2583ef02017-02-02 17:02:36 +09003482 *
3483 * <p>This method requires the caller to hold either the
3484 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
3485 * or the ability to modify system settings as determined by
3486 * {@link android.provider.Settings.System#canWrite}.</p>
3487 *
3488 * @param request {@link NetworkRequest} describing this request.
3489 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
3490 * the callback must not be shared - it uniquely specifies this request.
3491 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
3492 * @throws IllegalArgumentException if {@code request} specifies any mutable
3493 * {@code NetworkCapabilities}.
Hugo Benichi2583ef02017-02-02 17:02:36 +09003494 */
Chalard Jean50bea3d2019-01-07 19:26:34 +09003495 public void requestNetwork(@NonNull NetworkRequest request,
3496 @NonNull NetworkCallback networkCallback, @NonNull Handler handler) {
Hugo Benichi2583ef02017-02-02 17:02:36 +09003497 int legacyType = inferLegacyTypeForNetworkCapabilities(request.networkCapabilities);
3498 CallbackHandler cbHandler = new CallbackHandler(handler);
3499 requestNetwork(request, networkCallback, 0, legacyType, cbHandler);
Robert Greenwalt9258c642014-03-26 16:47:06 -07003500 }
3501
3502 /**
Etan Cohenaebf17e2017-03-01 12:47:28 -08003503 * Request a network to satisfy a set of {@link android.net.NetworkCapabilities}, limited
3504 * by a timeout.
3505 *
3506 * This function behaves identically to the non-timed-out version
3507 * {@link #requestNetwork(NetworkRequest, NetworkCallback)}, but if a suitable network
3508 * is not found within the given time (in milliseconds) the
3509 * {@link NetworkCallback#onUnavailable()} callback is called. The request can still be
3510 * released normally by calling {@link #unregisterNetworkCallback(NetworkCallback)} but does
3511 * not have to be released if timed-out (it is automatically released). Unregistering a
3512 * request that timed out is not an error.
3513 *
3514 * <p>Do not use this method to poll for the existence of specific networks (e.g. with a small
3515 * timeout) - {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)} is provided
3516 * for that purpose. Calling this method will attempt to bring up the requested network.
3517 *
3518 * <p>This method requires the caller to hold either the
3519 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
3520 * or the ability to modify system settings as determined by
3521 * {@link android.provider.Settings.System#canWrite}.</p>
3522 *
3523 * @param request {@link NetworkRequest} describing this request.
Lorenzo Colitti15fd4392017-04-28 00:56:30 +09003524 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
3525 * the callback must not be shared - it uniquely specifies this request.
Etan Cohenaebf17e2017-03-01 12:47:28 -08003526 * @param timeoutMs The time in milliseconds to attempt looking for a suitable network
3527 * before {@link NetworkCallback#onUnavailable()} is called. The timeout must
3528 * be a positive value (i.e. >0).
Etan Cohenaebf17e2017-03-01 12:47:28 -08003529 */
Chalard Jean50bea3d2019-01-07 19:26:34 +09003530 public void requestNetwork(@NonNull NetworkRequest request,
3531 @NonNull NetworkCallback networkCallback, int timeoutMs) {
Hugo Benichie7678512017-05-09 15:19:01 +09003532 checkTimeout(timeoutMs);
Hugo Benichi2583ef02017-02-02 17:02:36 +09003533 int legacyType = inferLegacyTypeForNetworkCapabilities(request.networkCapabilities);
Erik Klineb583b032017-02-22 12:58:24 +09003534 requestNetwork(request, networkCallback, timeoutMs, legacyType, getDefaultHandler());
Hugo Benichi2583ef02017-02-02 17:02:36 +09003535 }
3536
Hugo Benichi2583ef02017-02-02 17:02:36 +09003537 /**
3538 * Request a network to satisfy a set of {@link android.net.NetworkCapabilities}, limited
3539 * by a timeout.
3540 *
Chalard Jean4d660112018-06-04 16:52:49 +09003541 * This function behaves identically to the version without timeout, but if a suitable
Hugo Benichi2583ef02017-02-02 17:02:36 +09003542 * network is not found within the given time (in milliseconds) the
Etan Cohenaebf17e2017-03-01 12:47:28 -08003543 * {@link NetworkCallback#onUnavailable} callback is called. The request can still be
3544 * released normally by calling {@link #unregisterNetworkCallback(NetworkCallback)} but does
3545 * not have to be released if timed-out (it is automatically released). Unregistering a
3546 * request that timed out is not an error.
3547 *
3548 * <p>Do not use this method to poll for the existence of specific networks (e.g. with a small
3549 * timeout) - {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)} is provided
3550 * for that purpose. Calling this method will attempt to bring up the requested network.
Hugo Benichi2583ef02017-02-02 17:02:36 +09003551 *
3552 * <p>This method requires the caller to hold either the
3553 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
3554 * or the ability to modify system settings as determined by
3555 * {@link android.provider.Settings.System#canWrite}.</p>
3556 *
3557 * @param request {@link NetworkRequest} describing this request.
Etan Cohenaebf17e2017-03-01 12:47:28 -08003558 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
3559 * the callback must not be shared - it uniquely specifies this request.
Hugo Benichi2583ef02017-02-02 17:02:36 +09003560 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
Lorenzo Colitti15fd4392017-04-28 00:56:30 +09003561 * @param timeoutMs The time in milliseconds to attempt looking for a suitable network
3562 * before {@link NetworkCallback#onUnavailable} is called.
Hugo Benichi2583ef02017-02-02 17:02:36 +09003563 */
Chalard Jean50bea3d2019-01-07 19:26:34 +09003564 public void requestNetwork(@NonNull NetworkRequest request,
3565 @NonNull NetworkCallback networkCallback, @NonNull Handler handler, int timeoutMs) {
Hugo Benichie7678512017-05-09 15:19:01 +09003566 checkTimeout(timeoutMs);
Hugo Benichi2583ef02017-02-02 17:02:36 +09003567 int legacyType = inferLegacyTypeForNetworkCapabilities(request.networkCapabilities);
3568 CallbackHandler cbHandler = new CallbackHandler(handler);
3569 requestNetwork(request, networkCallback, timeoutMs, legacyType, cbHandler);
Robert Greenwalt9258c642014-03-26 16:47:06 -07003570 }
3571
3572 /**
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07003573 * The lookup key for a {@link Network} object included with the intent after
Jeremy Joslin46e3ac82014-11-05 10:32:09 -08003574 * successfully finding a network for the applications request. Retrieve it with
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07003575 * {@link android.content.Intent#getParcelableExtra(String)}.
Jeremy Joslinfcde58f2015-02-11 16:51:13 -08003576 * <p>
Paul Jensen72db88e2015-03-10 10:54:12 -04003577 * Note that if you intend to invoke {@link Network#openConnection(java.net.URL)}
3578 * then you must get a ConnectivityManager instance before doing so.
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07003579 */
Erik Kline90e93072014-11-19 12:12:24 +09003580 public static final String EXTRA_NETWORK = "android.net.extra.NETWORK";
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07003581
3582 /**
Robert Greenwalt6078b502014-06-11 16:05:07 -07003583 * The lookup key for a {@link NetworkRequest} object included with the intent after
Jeremy Joslin46e3ac82014-11-05 10:32:09 -08003584 * successfully finding a network for the applications request. Retrieve it with
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07003585 * {@link android.content.Intent#getParcelableExtra(String)}.
3586 */
Erik Kline90e93072014-11-19 12:12:24 +09003587 public static final String EXTRA_NETWORK_REQUEST = "android.net.extra.NETWORK_REQUEST";
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07003588
3589
3590 /**
Lorenzo Colittie285b432015-04-23 15:32:42 +09003591 * Request a network to satisfy a set of {@link android.net.NetworkCapabilities}.
Robert Greenwalt9258c642014-03-26 16:47:06 -07003592 *
Jeremy Joslin46e3ac82014-11-05 10:32:09 -08003593 * This function behaves identically to the version that takes a NetworkCallback, but instead
Robert Greenwalt6078b502014-06-11 16:05:07 -07003594 * of {@link NetworkCallback} a {@link PendingIntent} is used. This means
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07003595 * the request may outlive the calling application and get called back when a suitable
3596 * network is found.
Robert Greenwalt9258c642014-03-26 16:47:06 -07003597 * <p>
3598 * The operation is an Intent broadcast that goes to a broadcast receiver that
3599 * you registered with {@link Context#registerReceiver} or through the
3600 * &lt;receiver&gt; tag in an AndroidManifest.xml file
3601 * <p>
3602 * The operation Intent is delivered with two extras, a {@link Network} typed
Erik Kline90e93072014-11-19 12:12:24 +09003603 * extra called {@link #EXTRA_NETWORK} and a {@link NetworkRequest}
3604 * typed extra called {@link #EXTRA_NETWORK_REQUEST} containing
Robert Greenwalt9258c642014-03-26 16:47:06 -07003605 * the original requests parameters. It is important to create a new,
Robert Greenwalt6078b502014-06-11 16:05:07 -07003606 * {@link NetworkCallback} based request before completing the processing of the
Robert Greenwalt9258c642014-03-26 16:47:06 -07003607 * Intent to reserve the network or it will be released shortly after the Intent
3608 * is processed.
3609 * <p>
Paul Jensen694f2b82015-06-17 14:15:39 -04003610 * If there is already a request for this Intent registered (with the equality of
Robert Greenwalt9258c642014-03-26 16:47:06 -07003611 * two Intents defined by {@link Intent#filterEquals}), then it will be removed and
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07003612 * replaced by this one, effectively releasing the previous {@link NetworkRequest}.
Robert Greenwalt9258c642014-03-26 16:47:06 -07003613 * <p>
Jeremy Joslin46e3ac82014-11-05 10:32:09 -08003614 * The request may be released normally by calling
3615 * {@link #releaseNetworkRequest(android.app.PendingIntent)}.
Paul Jensenbb2e0e92015-06-16 15:11:58 -04003616 * <p>It is presently unsupported to request a network with either
3617 * {@link NetworkCapabilities#NET_CAPABILITY_VALIDATED} or
3618 * {@link NetworkCapabilities#NET_CAPABILITY_CAPTIVE_PORTAL}
3619 * as these {@code NetworkCapabilities} represent states that a particular
3620 * network may never attain, and whether a network will attain these states
3621 * is unknown prior to bringing up the network so the framework does not
Chalard Jean4d660112018-06-04 16:52:49 +09003622 * know how to go about satisfying a request with these capabilities.
Lorenzo Colittid5427052015-10-15 16:29:00 +09003623 *
3624 * <p>This method requires the caller to hold either the
3625 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
3626 * or the ability to modify system settings as determined by
3627 * {@link android.provider.Settings.System#canWrite}.</p>
3628 *
Robert Greenwalt6078b502014-06-11 16:05:07 -07003629 * @param request {@link NetworkRequest} describing this request.
Robert Greenwalt9258c642014-03-26 16:47:06 -07003630 * @param operation Action to perform when the network is available (corresponds
Robert Greenwalt6078b502014-06-11 16:05:07 -07003631 * to the {@link NetworkCallback#onAvailable} call. Typically
Jeremy Joslin46e3ac82014-11-05 10:32:09 -08003632 * comes from {@link PendingIntent#getBroadcast}. Cannot be null.
Paul Jensenbb2e0e92015-06-16 15:11:58 -04003633 * @throws IllegalArgumentException if {@code request} contains either
3634 * {@link NetworkCapabilities#NET_CAPABILITY_VALIDATED} or
3635 * {@link NetworkCapabilities#NET_CAPABILITY_CAPTIVE_PORTAL}.
Robert Greenwalt9258c642014-03-26 16:47:06 -07003636 */
Chalard Jean50bea3d2019-01-07 19:26:34 +09003637 public void requestNetwork(@NonNull NetworkRequest request,
3638 @NonNull PendingIntent operation) {
Soi, Yoshinaridee2aa42015-11-12 12:09:02 +09003639 printStackTrace();
Hugo Benichie7678512017-05-09 15:19:01 +09003640 checkPendingIntentNotNull(operation);
Robert Greenwalt9258c642014-03-26 16:47:06 -07003641 try {
Robert Greenwalt6078b502014-06-11 16:05:07 -07003642 mService.pendingRequestForNetwork(request.networkCapabilities, operation);
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07003643 } catch (RemoteException e) {
3644 throw e.rethrowFromSystemServer();
Hugo Benichicb883232017-05-11 13:16:17 +09003645 } catch (ServiceSpecificException e) {
3646 throw convertServiceException(e);
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07003647 }
Robert Greenwalt9258c642014-03-26 16:47:06 -07003648 }
3649
3650 /**
Jeremy Joslin46e3ac82014-11-05 10:32:09 -08003651 * Removes a request made via {@link #requestNetwork(NetworkRequest, android.app.PendingIntent)}
3652 * <p>
Lorenzo Colitti88bc0bb2016-04-13 22:00:02 +09003653 * This method has the same behavior as
3654 * {@link #unregisterNetworkCallback(android.app.PendingIntent)} with respect to
Jeremy Joslin46e3ac82014-11-05 10:32:09 -08003655 * releasing network resources and disconnecting.
3656 *
3657 * @param operation A PendingIntent equal (as defined by {@link Intent#filterEquals}) to the
3658 * PendingIntent passed to
3659 * {@link #requestNetwork(NetworkRequest, android.app.PendingIntent)} with the
3660 * corresponding NetworkRequest you'd like to remove. Cannot be null.
3661 */
Chalard Jean50bea3d2019-01-07 19:26:34 +09003662 public void releaseNetworkRequest(@NonNull PendingIntent operation) {
Soi, Yoshinaridee2aa42015-11-12 12:09:02 +09003663 printStackTrace();
Hugo Benichie7678512017-05-09 15:19:01 +09003664 checkPendingIntentNotNull(operation);
Jeremy Joslin46e3ac82014-11-05 10:32:09 -08003665 try {
3666 mService.releasePendingNetworkRequest(operation);
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07003667 } catch (RemoteException e) {
3668 throw e.rethrowFromSystemServer();
3669 }
Jeremy Joslin46e3ac82014-11-05 10:32:09 -08003670 }
3671
Hugo Benichie7678512017-05-09 15:19:01 +09003672 private static void checkPendingIntentNotNull(PendingIntent intent) {
3673 Preconditions.checkNotNull(intent, "PendingIntent cannot be null.");
3674 }
3675
3676 private static void checkCallbackNotNull(NetworkCallback callback) {
3677 Preconditions.checkNotNull(callback, "null NetworkCallback");
3678 }
3679
3680 private static void checkTimeout(int timeoutMs) {
3681 Preconditions.checkArgumentPositive(timeoutMs, "timeoutMs must be strictly positive.");
Jeremy Joslin46e3ac82014-11-05 10:32:09 -08003682 }
3683
3684 /**
Robert Greenwalt9258c642014-03-26 16:47:06 -07003685 * Registers to receive notifications about all networks which satisfy the given
Robert Greenwalt6078b502014-06-11 16:05:07 -07003686 * {@link NetworkRequest}. The callbacks will continue to be called until
Lorenzo Colitti88bc0bb2016-04-13 22:00:02 +09003687 * either the application exits or link #unregisterNetworkCallback(NetworkCallback)} is called.
Robert Greenwalt9258c642014-03-26 16:47:06 -07003688 *
Robert Greenwalt6078b502014-06-11 16:05:07 -07003689 * @param request {@link NetworkRequest} describing this request.
3690 * @param networkCallback The {@link NetworkCallback} that the system will call as suitable
3691 * networks change state.
Hugo Benichi2583ef02017-02-02 17:02:36 +09003692 * The callback is invoked on the default internal Handler.
Robert Greenwalt9258c642014-03-26 16:47:06 -07003693 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06003694 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean50bea3d2019-01-07 19:26:34 +09003695 public void registerNetworkCallback(@NonNull NetworkRequest request,
3696 @NonNull NetworkCallback networkCallback) {
Hugo Benichi2583ef02017-02-02 17:02:36 +09003697 registerNetworkCallback(request, networkCallback, getDefaultHandler());
3698 }
3699
3700 /**
3701 * Registers to receive notifications about all networks which satisfy the given
3702 * {@link NetworkRequest}. The callbacks will continue to be called until
3703 * either the application exits or link #unregisterNetworkCallback(NetworkCallback)} is called.
Hugo Benichi2583ef02017-02-02 17:02:36 +09003704 *
3705 * @param request {@link NetworkRequest} describing this request.
3706 * @param networkCallback The {@link NetworkCallback} that the system will call as suitable
3707 * networks change state.
3708 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
Hugo Benichi2583ef02017-02-02 17:02:36 +09003709 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06003710 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean50bea3d2019-01-07 19:26:34 +09003711 public void registerNetworkCallback(@NonNull NetworkRequest request,
3712 @NonNull NetworkCallback networkCallback, @NonNull Handler handler) {
Hugo Benichi2583ef02017-02-02 17:02:36 +09003713 CallbackHandler cbHandler = new CallbackHandler(handler);
3714 NetworkCapabilities nc = request.networkCapabilities;
3715 sendRequestForNetwork(nc, networkCallback, 0, LISTEN, TYPE_NONE, cbHandler);
Robert Greenwalt9258c642014-03-26 16:47:06 -07003716 }
3717
3718 /**
Paul Jensen694f2b82015-06-17 14:15:39 -04003719 * Registers a PendingIntent to be sent when a network is available which satisfies the given
3720 * {@link NetworkRequest}.
3721 *
3722 * This function behaves identically to the version that takes a NetworkCallback, but instead
3723 * of {@link NetworkCallback} a {@link PendingIntent} is used. This means
3724 * the request may outlive the calling application and get called back when a suitable
3725 * network is found.
3726 * <p>
3727 * The operation is an Intent broadcast that goes to a broadcast receiver that
3728 * you registered with {@link Context#registerReceiver} or through the
3729 * &lt;receiver&gt; tag in an AndroidManifest.xml file
3730 * <p>
3731 * The operation Intent is delivered with two extras, a {@link Network} typed
3732 * extra called {@link #EXTRA_NETWORK} and a {@link NetworkRequest}
3733 * typed extra called {@link #EXTRA_NETWORK_REQUEST} containing
3734 * the original requests parameters.
3735 * <p>
3736 * If there is already a request for this Intent registered (with the equality of
3737 * two Intents defined by {@link Intent#filterEquals}), then it will be removed and
3738 * replaced by this one, effectively releasing the previous {@link NetworkRequest}.
3739 * <p>
3740 * The request may be released normally by calling
Paul Jensenf2c1cfe2015-06-30 14:29:18 -04003741 * {@link #unregisterNetworkCallback(android.app.PendingIntent)}.
Paul Jensen694f2b82015-06-17 14:15:39 -04003742 * @param request {@link NetworkRequest} describing this request.
3743 * @param operation Action to perform when the network is available (corresponds
3744 * to the {@link NetworkCallback#onAvailable} call. Typically
3745 * comes from {@link PendingIntent#getBroadcast}. Cannot be null.
3746 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06003747 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean50bea3d2019-01-07 19:26:34 +09003748 public void registerNetworkCallback(@NonNull NetworkRequest request,
3749 @NonNull PendingIntent operation) {
Soi, Yoshinaridee2aa42015-11-12 12:09:02 +09003750 printStackTrace();
Hugo Benichie7678512017-05-09 15:19:01 +09003751 checkPendingIntentNotNull(operation);
Paul Jensen694f2b82015-06-17 14:15:39 -04003752 try {
3753 mService.pendingListenForNetwork(request.networkCapabilities, operation);
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07003754 } catch (RemoteException e) {
3755 throw e.rethrowFromSystemServer();
Hugo Benichicb883232017-05-11 13:16:17 +09003756 } catch (ServiceSpecificException e) {
3757 throw convertServiceException(e);
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07003758 }
Paul Jensen694f2b82015-06-17 14:15:39 -04003759 }
3760
3761 /**
Lorenzo Colitti88bc0bb2016-04-13 22:00:02 +09003762 * Registers to receive notifications about changes in the system default network. The callbacks
3763 * will continue to be called until either the application exits or
3764 * {@link #unregisterNetworkCallback(NetworkCallback)} is called.
Erik Klinea2d29402016-03-16 15:31:39 +09003765 *
3766 * @param networkCallback The {@link NetworkCallback} that the system will call as the
3767 * system default network changes.
Hugo Benichi2583ef02017-02-02 17:02:36 +09003768 * The callback is invoked on the default internal Handler.
Erik Klinea2d29402016-03-16 15:31:39 +09003769 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06003770 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean50bea3d2019-01-07 19:26:34 +09003771 public void registerDefaultNetworkCallback(@NonNull NetworkCallback networkCallback) {
Hugo Benichi2583ef02017-02-02 17:02:36 +09003772 registerDefaultNetworkCallback(networkCallback, getDefaultHandler());
3773 }
3774
3775 /**
3776 * Registers to receive notifications about changes in the system default network. The callbacks
3777 * will continue to be called until either the application exits or
3778 * {@link #unregisterNetworkCallback(NetworkCallback)} is called.
Hugo Benichi2583ef02017-02-02 17:02:36 +09003779 *
3780 * @param networkCallback The {@link NetworkCallback} that the system will call as the
3781 * system default network changes.
3782 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
Hugo Benichi2583ef02017-02-02 17:02:36 +09003783 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06003784 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean50bea3d2019-01-07 19:26:34 +09003785 public void registerDefaultNetworkCallback(@NonNull NetworkCallback networkCallback,
3786 @NonNull Handler handler) {
Erik Klinea2d29402016-03-16 15:31:39 +09003787 // This works because if the NetworkCapabilities are null,
3788 // ConnectivityService takes them from the default request.
3789 //
3790 // Since the capabilities are exactly the same as the default request's
3791 // capabilities, this request is guaranteed, at all times, to be
3792 // satisfied by the same network, if any, that satisfies the default
3793 // request, i.e., the system default network.
Hugo Benichi2583ef02017-02-02 17:02:36 +09003794 CallbackHandler cbHandler = new CallbackHandler(handler);
Chalard Jean4d660112018-06-04 16:52:49 +09003795 sendRequestForNetwork(null /* NetworkCapabilities need */, networkCallback, 0,
3796 REQUEST, TYPE_NONE, cbHandler);
Erik Klinea2d29402016-03-16 15:31:39 +09003797 }
3798
3799 /**
fengludb571472015-04-21 17:12:05 -07003800 * Requests bandwidth update for a given {@link Network} and returns whether the update request
3801 * is accepted by ConnectivityService. Once accepted, ConnectivityService will poll underlying
3802 * network connection for updated bandwidth information. The caller will be notified via
3803 * {@link ConnectivityManager.NetworkCallback} if there is an update. Notice that this
Lorenzo Colitti88bc0bb2016-04-13 22:00:02 +09003804 * method assumes that the caller has previously called
3805 * {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)} to listen for network
3806 * changes.
fenglub15e72b2015-03-20 11:29:56 -07003807 *
fengluae519192015-04-27 14:28:04 -07003808 * @param network {@link Network} specifying which network you're interested.
fengludb571472015-04-21 17:12:05 -07003809 * @return {@code true} on success, {@code false} if the {@link Network} is no longer valid.
fenglub15e72b2015-03-20 11:29:56 -07003810 */
Chalard Jean50bea3d2019-01-07 19:26:34 +09003811 public boolean requestBandwidthUpdate(@NonNull Network network) {
fenglub15e72b2015-03-20 11:29:56 -07003812 try {
fengludb571472015-04-21 17:12:05 -07003813 return mService.requestBandwidthUpdate(network);
fenglub15e72b2015-03-20 11:29:56 -07003814 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07003815 throw e.rethrowFromSystemServer();
fenglub15e72b2015-03-20 11:29:56 -07003816 }
3817 }
3818
3819 /**
Hugo Benichidafed3d2017-03-06 09:17:06 +09003820 * Unregisters a {@code NetworkCallback} and possibly releases networks originating from
Lorenzo Colitti88bc0bb2016-04-13 22:00:02 +09003821 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} and
3822 * {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)} calls.
3823 * If the given {@code NetworkCallback} had previously been used with
Lorenzo Colitti2ea89e52015-04-24 17:03:31 +09003824 * {@code #requestNetwork}, any networks that had been connected to only to satisfy that request
3825 * will be disconnected.
Robert Greenwalt9258c642014-03-26 16:47:06 -07003826 *
Hugo Benichidafed3d2017-03-06 09:17:06 +09003827 * Notifications that would have triggered that {@code NetworkCallback} will immediately stop
3828 * triggering it as soon as this call returns.
3829 *
Robert Greenwalt6078b502014-06-11 16:05:07 -07003830 * @param networkCallback The {@link NetworkCallback} used when making the request.
Robert Greenwalt9258c642014-03-26 16:47:06 -07003831 */
Chalard Jean50bea3d2019-01-07 19:26:34 +09003832 public void unregisterNetworkCallback(@NonNull NetworkCallback networkCallback) {
Soi, Yoshinaridee2aa42015-11-12 12:09:02 +09003833 printStackTrace();
Hugo Benichie7678512017-05-09 15:19:01 +09003834 checkCallbackNotNull(networkCallback);
Hugo Benichidafed3d2017-03-06 09:17:06 +09003835 final List<NetworkRequest> reqs = new ArrayList<>();
3836 // Find all requests associated to this callback and stop callback triggers immediately.
3837 // Callback is reusable immediately. http://b/20701525, http://b/35921499.
3838 synchronized (sCallbacks) {
Hugo Benichi31c176d2017-06-17 13:14:12 +09003839 Preconditions.checkArgument(networkCallback.networkRequest != null,
3840 "NetworkCallback was not registered");
3841 Preconditions.checkArgument(networkCallback.networkRequest != ALREADY_UNREGISTERED,
3842 "NetworkCallback was already unregistered");
Hugo Benichidafed3d2017-03-06 09:17:06 +09003843 for (Map.Entry<NetworkRequest, NetworkCallback> e : sCallbacks.entrySet()) {
3844 if (e.getValue() == networkCallback) {
3845 reqs.add(e.getKey());
3846 }
3847 }
3848 // TODO: throw exception if callback was registered more than once (http://b/20701525).
3849 for (NetworkRequest r : reqs) {
3850 try {
3851 mService.releaseNetworkRequest(r);
3852 } catch (RemoteException e) {
3853 throw e.rethrowFromSystemServer();
3854 }
3855 // Only remove mapping if rpc was successful.
3856 sCallbacks.remove(r);
3857 }
Hugo Benichi31c176d2017-06-17 13:14:12 +09003858 networkCallback.networkRequest = ALREADY_UNREGISTERED;
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07003859 }
Robert Greenwalt9258c642014-03-26 16:47:06 -07003860 }
Paul Jensen6d3ff9e2014-05-29 10:12:39 -04003861
3862 /**
Paul Jensenf2c1cfe2015-06-30 14:29:18 -04003863 * Unregisters a callback previously registered via
3864 * {@link #registerNetworkCallback(NetworkRequest, android.app.PendingIntent)}.
3865 *
3866 * @param operation A PendingIntent equal (as defined by {@link Intent#filterEquals}) to the
3867 * PendingIntent passed to
3868 * {@link #registerNetworkCallback(NetworkRequest, android.app.PendingIntent)}.
3869 * Cannot be null.
3870 */
Chalard Jean50bea3d2019-01-07 19:26:34 +09003871 public void unregisterNetworkCallback(@NonNull PendingIntent operation) {
Hugo Benichie7678512017-05-09 15:19:01 +09003872 checkPendingIntentNotNull(operation);
Paul Jensenf2c1cfe2015-06-30 14:29:18 -04003873 releaseNetworkRequest(operation);
3874 }
3875
3876 /**
Lorenzo Colittie03c3c72015-04-03 16:38:52 +09003877 * Informs the system whether it should switch to {@code network} regardless of whether it is
3878 * validated or not. If {@code accept} is true, and the network was explicitly selected by the
3879 * user (e.g., by selecting a Wi-Fi network in the Settings app), then the network will become
3880 * the system default network regardless of any other network that's currently connected. If
3881 * {@code always} is true, then the choice is remembered, so that the next time the user
3882 * connects to this network, the system will switch to it.
3883 *
Lorenzo Colittie03c3c72015-04-03 16:38:52 +09003884 * @param network The network to accept.
3885 * @param accept Whether to accept the network even if unvalidated.
3886 * @param always Whether to remember this choice in the future.
3887 *
3888 * @hide
3889 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06003890 @RequiresPermission(android.Manifest.permission.CONNECTIVITY_INTERNAL)
Lorenzo Colittie03c3c72015-04-03 16:38:52 +09003891 public void setAcceptUnvalidated(Network network, boolean accept, boolean always) {
3892 try {
3893 mService.setAcceptUnvalidated(network, accept, always);
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07003894 } catch (RemoteException e) {
3895 throw e.rethrowFromSystemServer();
3896 }
Lorenzo Colittie03c3c72015-04-03 16:38:52 +09003897 }
3898
3899 /**
Lorenzo Colitti165c51c2016-09-19 01:00:19 +09003900 * Informs the system to penalize {@code network}'s score when it becomes unvalidated. This is
3901 * only meaningful if the system is configured not to penalize such networks, e.g., if the
3902 * {@code config_networkAvoidBadWifi} configuration variable is set to 0 and the {@code
3903 * NETWORK_AVOID_BAD_WIFI setting is unset}.
3904 *
Lorenzo Colitti165c51c2016-09-19 01:00:19 +09003905 * @param network The network to accept.
3906 *
3907 * @hide
3908 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06003909 @RequiresPermission(android.Manifest.permission.CONNECTIVITY_INTERNAL)
Lorenzo Colitti165c51c2016-09-19 01:00:19 +09003910 public void setAvoidUnvalidated(Network network) {
3911 try {
3912 mService.setAvoidUnvalidated(network);
3913 } catch (RemoteException e) {
3914 throw e.rethrowFromSystemServer();
3915 }
3916 }
3917
3918 /**
Lorenzo Colitti4734cdb2017-04-27 14:30:21 +09003919 * Requests that the system open the captive portal app on the specified network.
3920 *
3921 * @param network The network to log into.
3922 *
3923 * @hide
3924 */
3925 @RequiresPermission(android.Manifest.permission.CONNECTIVITY_INTERNAL)
3926 public void startCaptivePortalApp(Network network) {
3927 try {
3928 mService.startCaptivePortalApp(network);
3929 } catch (RemoteException e) {
3930 throw e.rethrowFromSystemServer();
3931 }
3932 }
3933
3934 /**
Remi NGUYEN VANdc483562019-02-04 11:32:20 +09003935 * Requests that the system open the captive portal app with the specified extras.
3936 *
3937 * <p>This endpoint is exclusively for use by the NetworkStack and is protected by the
3938 * corresponding permission.
Remi NGUYEN VAN5a1b74b2019-02-13 20:58:59 +09003939 * @param network Network on which the captive portal was detected.
Remi NGUYEN VANdc483562019-02-04 11:32:20 +09003940 * @param appExtras Extras to include in the app start intent.
3941 * @hide
3942 */
3943 @SystemApi
3944 @TestApi
3945 @RequiresPermission(NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK)
Remi NGUYEN VAN5a1b74b2019-02-13 20:58:59 +09003946 public void startCaptivePortalApp(Network network, Bundle appExtras) {
Remi NGUYEN VANdc483562019-02-04 11:32:20 +09003947 try {
Remi NGUYEN VAN5a1b74b2019-02-13 20:58:59 +09003948 mService.startCaptivePortalAppInternal(network, appExtras);
Remi NGUYEN VANdc483562019-02-04 11:32:20 +09003949 } catch (RemoteException e) {
3950 throw e.rethrowFromSystemServer();
3951 }
3952 }
3953
3954 /**
Remi NGUYEN VAN97f69c22019-01-20 20:35:06 +09003955 * Determine whether the device is configured to avoid bad wifi.
3956 * @hide
3957 */
3958 @SystemApi
3959 public boolean getAvoidBadWifi() {
3960 try {
3961 return mService.getAvoidBadWifi();
3962 } catch (RemoteException e) {
3963 throw e.rethrowFromSystemServer();
3964 }
3965 }
3966
3967 /**
Lorenzo Colitti2de49252017-01-24 18:08:41 +09003968 * It is acceptable to briefly use multipath data to provide seamless connectivity for
3969 * time-sensitive user-facing operations when the system default network is temporarily
Lorenzo Colitti15fd4392017-04-28 00:56:30 +09003970 * unresponsive. The amount of data should be limited (less than one megabyte for every call to
3971 * this method), and the operation should be infrequent to ensure that data usage is limited.
Lorenzo Colitti2de49252017-01-24 18:08:41 +09003972 *
3973 * An example of such an operation might be a time-sensitive foreground activity, such as a
3974 * voice command, that the user is performing while walking out of range of a Wi-Fi network.
3975 */
3976 public static final int MULTIPATH_PREFERENCE_HANDOVER = 1 << 0;
3977
3978 /**
3979 * It is acceptable to use small amounts of multipath data on an ongoing basis to provide
3980 * a backup channel for traffic that is primarily going over another network.
3981 *
3982 * An example might be maintaining backup connections to peers or servers for the purpose of
3983 * fast fallback if the default network is temporarily unresponsive or disconnects. The traffic
3984 * on backup paths should be negligible compared to the traffic on the main path.
3985 */
3986 public static final int MULTIPATH_PREFERENCE_RELIABILITY = 1 << 1;
3987
3988 /**
3989 * It is acceptable to use metered data to improve network latency and performance.
3990 */
3991 public static final int MULTIPATH_PREFERENCE_PERFORMANCE = 1 << 2;
3992
3993 /**
3994 * Return value to use for unmetered networks. On such networks we currently set all the flags
3995 * to true.
3996 * @hide
3997 */
3998 public static final int MULTIPATH_PREFERENCE_UNMETERED =
3999 MULTIPATH_PREFERENCE_HANDOVER |
4000 MULTIPATH_PREFERENCE_RELIABILITY |
4001 MULTIPATH_PREFERENCE_PERFORMANCE;
4002
4003 /** @hide */
4004 @Retention(RetentionPolicy.SOURCE)
4005 @IntDef(flag = true, value = {
4006 MULTIPATH_PREFERENCE_HANDOVER,
4007 MULTIPATH_PREFERENCE_RELIABILITY,
4008 MULTIPATH_PREFERENCE_PERFORMANCE,
4009 })
4010 public @interface MultipathPreference {
4011 }
4012
4013 /**
4014 * Provides a hint to the calling application on whether it is desirable to use the
4015 * multinetwork APIs (e.g., {@link Network#openConnection}, {@link Network#bindSocket}, etc.)
4016 * for multipath data transfer on this network when it is not the system default network.
4017 * Applications desiring to use multipath network protocols should call this method before
4018 * each such operation.
Lorenzo Colitti2de49252017-01-24 18:08:41 +09004019 *
4020 * @param network The network on which the application desires to use multipath data.
4021 * If {@code null}, this method will return the a preference that will generally
4022 * apply to metered networks.
4023 * @return a bitwise OR of zero or more of the {@code MULTIPATH_PREFERENCE_*} constants.
4024 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06004025 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Chalard Jean50bea3d2019-01-07 19:26:34 +09004026 public @MultipathPreference int getMultipathPreference(@Nullable Network network) {
Lorenzo Colitti2de49252017-01-24 18:08:41 +09004027 try {
4028 return mService.getMultipathPreference(network);
4029 } catch (RemoteException e) {
4030 throw e.rethrowFromSystemServer();
4031 }
4032 }
4033
4034 /**
Stuart Scott984dc852015-03-30 13:17:11 -07004035 * Resets all connectivity manager settings back to factory defaults.
4036 * @hide
4037 */
4038 public void factoryReset() {
Stuart Scott984dc852015-03-30 13:17:11 -07004039 try {
Stuart Scottf1fb3972015-04-02 18:00:02 -07004040 mService.factoryReset();
Stuart Scott984dc852015-03-30 13:17:11 -07004041 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07004042 throw e.rethrowFromSystemServer();
Stuart Scott984dc852015-03-30 13:17:11 -07004043 }
4044 }
4045
4046 /**
Paul Jensen6d3ff9e2014-05-29 10:12:39 -04004047 * Binds the current process to {@code network}. All Sockets created in the future
4048 * (and not explicitly bound via a bound SocketFactory from
4049 * {@link Network#getSocketFactory() Network.getSocketFactory()}) will be bound to
4050 * {@code network}. All host name resolutions will be limited to {@code network} as well.
4051 * Note that if {@code network} ever disconnects, all Sockets created in this way will cease to
4052 * work and all host name resolutions will fail. This is by design so an application doesn't
4053 * accidentally use Sockets it thinks are still bound to a particular {@link Network}.
4054 * To clear binding pass {@code null} for {@code network}. Using individually bound
4055 * Sockets created by Network.getSocketFactory().createSocket() and
4056 * performing network-specific host name resolutions via
4057 * {@link Network#getAllByName Network.getAllByName} is preferred to calling
Paul Jensen72db88e2015-03-10 10:54:12 -04004058 * {@code bindProcessToNetwork}.
Paul Jensen6d3ff9e2014-05-29 10:12:39 -04004059 *
4060 * @param network The {@link Network} to bind the current process to, or {@code null} to clear
4061 * the current binding.
4062 * @return {@code true} on success, {@code false} if the {@link Network} is no longer valid.
4063 */
Chalard Jean50bea3d2019-01-07 19:26:34 +09004064 public boolean bindProcessToNetwork(@Nullable Network network) {
Chalard Jean4d660112018-06-04 16:52:49 +09004065 // Forcing callers to call through non-static function ensures ConnectivityManager
Paul Jensen72db88e2015-03-10 10:54:12 -04004066 // instantiated.
4067 return setProcessDefaultNetwork(network);
4068 }
4069
4070 /**
4071 * Binds the current process to {@code network}. All Sockets created in the future
4072 * (and not explicitly bound via a bound SocketFactory from
4073 * {@link Network#getSocketFactory() Network.getSocketFactory()}) will be bound to
4074 * {@code network}. All host name resolutions will be limited to {@code network} as well.
4075 * Note that if {@code network} ever disconnects, all Sockets created in this way will cease to
4076 * work and all host name resolutions will fail. This is by design so an application doesn't
4077 * accidentally use Sockets it thinks are still bound to a particular {@link Network}.
4078 * To clear binding pass {@code null} for {@code network}. Using individually bound
4079 * Sockets created by Network.getSocketFactory().createSocket() and
4080 * performing network-specific host name resolutions via
4081 * {@link Network#getAllByName Network.getAllByName} is preferred to calling
4082 * {@code setProcessDefaultNetwork}.
4083 *
4084 * @param network The {@link Network} to bind the current process to, or {@code null} to clear
4085 * the current binding.
4086 * @return {@code true} on success, {@code false} if the {@link Network} is no longer valid.
4087 * @deprecated This function can throw {@link IllegalStateException}. Use
4088 * {@link #bindProcessToNetwork} instead. {@code bindProcessToNetwork}
4089 * is a direct replacement.
4090 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07004091 @Deprecated
Chalard Jean50bea3d2019-01-07 19:26:34 +09004092 public static boolean setProcessDefaultNetwork(@Nullable Network network) {
Paul Jensenc91b5342014-08-27 12:38:45 -04004093 int netId = (network == null) ? NETID_UNSET : network.netId;
Lorenzo Colittie5ca1162019-01-31 13:08:24 +09004094 boolean isSameNetId = (netId == NetworkUtils.getBoundNetworkForProcess());
4095
Lorenzo Colitti65ceeb42019-01-30 23:04:54 +09004096 if (netId != NETID_UNSET) {
4097 netId = network.getNetIdForResolv();
Paul Jensenc91b5342014-08-27 12:38:45 -04004098 }
Lorenzo Colittie5ca1162019-01-31 13:08:24 +09004099
4100 if (!NetworkUtils.bindProcessToNetwork(netId)) {
4101 return false;
4102 }
4103
4104 if (!isSameNetId) {
Paul Jensene0bef712014-12-10 15:12:18 -05004105 // Set HTTP proxy system properties to match network.
4106 // TODO: Deprecate this static method and replace it with a non-static version.
Lorenzo Colittiec4c5552015-04-22 11:52:48 +09004107 try {
4108 Proxy.setHttpProxySystemProperty(getInstance().getDefaultProxy());
4109 } catch (SecurityException e) {
4110 // The process doesn't have ACCESS_NETWORK_STATE, so we can't fetch the proxy.
4111 Log.e(TAG, "Can't set proxy properties", e);
4112 }
Paul Jensenc91b5342014-08-27 12:38:45 -04004113 // Must flush DNS cache as new network may have different DNS resolutions.
4114 InetAddress.clearDnsCache();
4115 // Must flush socket pool as idle sockets will be bound to previous network and may
4116 // cause subsequent fetches to be performed on old network.
4117 NetworkEventDispatcher.getInstance().onNetworkConfigurationChanged();
Paul Jensenc91b5342014-08-27 12:38:45 -04004118 }
Lorenzo Colittie5ca1162019-01-31 13:08:24 +09004119
4120 return true;
Paul Jensen6d3ff9e2014-05-29 10:12:39 -04004121 }
4122
4123 /**
4124 * Returns the {@link Network} currently bound to this process via
Paul Jensen72db88e2015-03-10 10:54:12 -04004125 * {@link #bindProcessToNetwork}, or {@code null} if no {@link Network} is explicitly bound.
Paul Jensen6d3ff9e2014-05-29 10:12:39 -04004126 *
4127 * @return {@code Network} to which this process is bound, or {@code null}.
4128 */
Chalard Jean50bea3d2019-01-07 19:26:34 +09004129 @Nullable
Paul Jensen72db88e2015-03-10 10:54:12 -04004130 public Network getBoundNetworkForProcess() {
4131 // Forcing callers to call thru non-static function ensures ConnectivityManager
4132 // instantiated.
4133 return getProcessDefaultNetwork();
4134 }
4135
4136 /**
4137 * Returns the {@link Network} currently bound to this process via
4138 * {@link #bindProcessToNetwork}, or {@code null} if no {@link Network} is explicitly bound.
4139 *
4140 * @return {@code Network} to which this process is bound, or {@code null}.
4141 * @deprecated Using this function can lead to other functions throwing
4142 * {@link IllegalStateException}. Use {@link #getBoundNetworkForProcess} instead.
4143 * {@code getBoundNetworkForProcess} is a direct replacement.
4144 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07004145 @Deprecated
Chalard Jean50bea3d2019-01-07 19:26:34 +09004146 @Nullable
Paul Jensen6d3ff9e2014-05-29 10:12:39 -04004147 public static Network getProcessDefaultNetwork() {
Paul Jensen72db88e2015-03-10 10:54:12 -04004148 int netId = NetworkUtils.getBoundNetworkForProcess();
Paul Jensenbcc76d32014-07-11 08:17:29 -04004149 if (netId == NETID_UNSET) return null;
Paul Jensen6d3ff9e2014-05-29 10:12:39 -04004150 return new Network(netId);
4151 }
4152
Lorenzo Colittiffc42b02015-07-29 11:41:21 +09004153 private void unsupportedStartingFrom(int version) {
4154 if (Process.myUid() == Process.SYSTEM_UID) {
Lorenzo Colitti2e31a7c2018-09-28 11:31:55 +09004155 // The getApplicationInfo() call we make below is not supported in system context. Let
4156 // the call through here, and rely on the fact that ConnectivityService will refuse to
4157 // allow the system to use these APIs anyway.
Lorenzo Colittiffc42b02015-07-29 11:41:21 +09004158 return;
4159 }
4160
4161 if (mContext.getApplicationInfo().targetSdkVersion >= version) {
4162 throw new UnsupportedOperationException(
4163 "This method is not supported in target SDK version " + version + " and above");
4164 }
4165 }
4166
4167 // Checks whether the calling app can use the legacy routing API (startUsingNetworkFeature,
4168 // stopUsingNetworkFeature, requestRouteToHost), and if not throw UnsupportedOperationException.
Lifu Tang30f95a72016-01-07 23:20:38 -08004169 // TODO: convert the existing system users (Tethering, GnssLocationProvider) to the new APIs and
Lorenzo Colittiffc42b02015-07-29 11:41:21 +09004170 // remove these exemptions. Note that this check is not secure, and apps can still access these
4171 // functions by accessing ConnectivityService directly. However, it should be clear that doing
4172 // so is unsupported and may break in the future. http://b/22728205
4173 private void checkLegacyRoutingApiAccess() {
Dianne Hackborn692a2442015-07-31 10:35:34 -07004174 unsupportedStartingFrom(VERSION_CODES.M);
Lorenzo Colittiffc42b02015-07-29 11:41:21 +09004175 }
4176
Paul Jensen6d3ff9e2014-05-29 10:12:39 -04004177 /**
4178 * Binds host resolutions performed by this process to {@code network}.
Paul Jensen72db88e2015-03-10 10:54:12 -04004179 * {@link #bindProcessToNetwork} takes precedence over this setting.
Paul Jensen6d3ff9e2014-05-29 10:12:39 -04004180 *
4181 * @param network The {@link Network} to bind host resolutions from the current process to, or
4182 * {@code null} to clear the current binding.
4183 * @return {@code true} on success, {@code false} if the {@link Network} is no longer valid.
4184 * @hide
4185 * @deprecated This is strictly for legacy usage to support {@link #startUsingNetworkFeature}.
4186 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07004187 @Deprecated
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01004188 @UnsupportedAppUsage
Paul Jensen6d3ff9e2014-05-29 10:12:39 -04004189 public static boolean setProcessDefaultNetworkForHostResolution(Network network) {
Paul Jensenbcc76d32014-07-11 08:17:29 -04004190 return NetworkUtils.bindProcessToNetworkForHostResolution(
Erik Klinef4fa9822018-04-27 22:48:33 +09004191 (network == null) ? NETID_UNSET : network.getNetIdForResolv());
Paul Jensen6d3ff9e2014-05-29 10:12:39 -04004192 }
Felipe Leme1b103232016-01-22 09:44:57 -08004193
4194 /**
4195 * Device is not restricting metered network activity while application is running on
4196 * background.
4197 */
4198 public static final int RESTRICT_BACKGROUND_STATUS_DISABLED = 1;
4199
4200 /**
4201 * Device is restricting metered network activity while application is running on background,
4202 * but application is allowed to bypass it.
4203 * <p>
4204 * In this state, application should take action to mitigate metered network access.
4205 * For example, a music streaming application should switch to a low-bandwidth bitrate.
4206 */
4207 public static final int RESTRICT_BACKGROUND_STATUS_WHITELISTED = 2;
4208
4209 /**
4210 * Device is restricting metered network activity while application is running on background.
Felipe Leme9778f762016-01-27 14:46:39 -08004211 * <p>
Felipe Leme1b103232016-01-22 09:44:57 -08004212 * In this state, application should not try to use the network while running on background,
4213 * because it would be denied.
4214 */
4215 public static final int RESTRICT_BACKGROUND_STATUS_ENABLED = 3;
4216
Felipe Leme9778f762016-01-27 14:46:39 -08004217 /**
4218 * A change in the background metered network activity restriction has occurred.
4219 * <p>
4220 * Applications should call {@link #getRestrictBackgroundStatus()} to check if the restriction
4221 * applies to them.
4222 * <p>
4223 * This is only sent to registered receivers, not manifest receivers.
4224 */
4225 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
4226 public static final String ACTION_RESTRICT_BACKGROUND_CHANGED =
4227 "android.net.conn.RESTRICT_BACKGROUND_CHANGED";
4228
Felipe Lemeecfccea2016-01-25 11:48:04 -08004229 /** @hide */
4230 @Retention(RetentionPolicy.SOURCE)
Felipe Leme1b103232016-01-22 09:44:57 -08004231 @IntDef(flag = false, value = {
4232 RESTRICT_BACKGROUND_STATUS_DISABLED,
4233 RESTRICT_BACKGROUND_STATUS_WHITELISTED,
4234 RESTRICT_BACKGROUND_STATUS_ENABLED,
4235 })
Felipe Leme1b103232016-01-22 09:44:57 -08004236 public @interface RestrictBackgroundStatus {
4237 }
4238
4239 private INetworkPolicyManager getNetworkPolicyManager() {
4240 synchronized (this) {
4241 if (mNPManager != null) {
4242 return mNPManager;
4243 }
4244 mNPManager = INetworkPolicyManager.Stub.asInterface(ServiceManager
4245 .getService(Context.NETWORK_POLICY_SERVICE));
4246 return mNPManager;
4247 }
4248 }
4249
4250 /**
4251 * Determines if the calling application is subject to metered network restrictions while
4252 * running on background.
Felipe Lemec9c7be52016-05-16 13:57:19 -07004253 *
4254 * @return {@link #RESTRICT_BACKGROUND_STATUS_DISABLED},
4255 * {@link #RESTRICT_BACKGROUND_STATUS_ENABLED},
4256 * or {@link #RESTRICT_BACKGROUND_STATUS_WHITELISTED}
Felipe Leme1b103232016-01-22 09:44:57 -08004257 */
4258 public @RestrictBackgroundStatus int getRestrictBackgroundStatus() {
4259 try {
4260 return getNetworkPolicyManager().getRestrictBackgroundByCaller();
4261 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07004262 throw e.rethrowFromSystemServer();
Felipe Leme1b103232016-01-22 09:44:57 -08004263 }
4264 }
Ricky Wai44dcbde2018-01-23 04:09:45 +00004265
4266 /**
4267 * The network watchlist is a list of domains and IP addresses that are associated with
Ricky Waia86d5d52018-03-20 14:20:54 +00004268 * potentially harmful apps. This method returns the SHA-256 of the watchlist config file
4269 * currently used by the system for validation purposes.
Ricky Wai44dcbde2018-01-23 04:09:45 +00004270 *
4271 * @return Hash of network watchlist config file. Null if config does not exist.
4272 */
Chalard Jean50bea3d2019-01-07 19:26:34 +09004273 @Nullable
Ricky Wai44dcbde2018-01-23 04:09:45 +00004274 public byte[] getNetworkWatchlistConfigHash() {
4275 try {
4276 return mService.getNetworkWatchlistConfigHash();
4277 } catch (RemoteException e) {
4278 Log.e(TAG, "Unable to get watchlist config hash");
4279 throw e.rethrowFromSystemServer();
4280 }
4281 }
Jeff Vander Stoep0ac2c092018-07-23 10:57:53 -07004282
4283 /**
4284 * Returns the {@code uid} of the owner of a network connection.
4285 *
4286 * @param protocol The protocol of the connection. Only {@code IPPROTO_TCP} and
4287 * {@code IPPROTO_UDP} currently supported.
4288 * @param local The local {@link InetSocketAddress} of a connection.
4289 * @param remote The remote {@link InetSocketAddress} of a connection.
4290 *
4291 * @return {@code uid} if the connection is found and the app has permission to observe it
4292 * (e.g., if it is associated with the calling VPN app's tunnel) or
4293 * {@link android.os.Process#INVALID_UID} if the connection is not found.
4294 */
Chalard Jean50bea3d2019-01-07 19:26:34 +09004295 public int getConnectionOwnerUid(int protocol, @NonNull InetSocketAddress local,
4296 @NonNull InetSocketAddress remote) {
Jeff Vander Stoep0ac2c092018-07-23 10:57:53 -07004297 ConnectionInfo connectionInfo = new ConnectionInfo(protocol, local, remote);
4298 try {
4299 return mService.getConnectionOwnerUid(connectionInfo);
4300 } catch (RemoteException e) {
4301 throw e.rethrowFromSystemServer();
4302 }
4303 }
Soi, Yoshinaridee2aa42015-11-12 12:09:02 +09004304
4305 private void printStackTrace() {
4306 if (DEBUG) {
4307 final StackTraceElement[] callStack = Thread.currentThread().getStackTrace();
4308 final StringBuffer sb = new StringBuffer();
4309 for (int i = 3; i < callStack.length; i++) {
4310 final String stackTrace = callStack[i].toString();
4311 if (stackTrace == null || stackTrace.contains("android.os")) {
4312 break;
4313 }
4314 sb.append(" [").append(stackTrace).append("]");
4315 }
4316 Log.d(TAG, "StackLog:" + sb.toString());
4317 }
4318 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004319}