blob: 61d5a912774332b51d95d868fd1dda577f29bec4 [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
Felipe Leme1b103232016-01-22 09:44:57 -080018import android.annotation.IntDef;
Robin Lee244ce8e2016-01-05 18:03:46 +000019import android.annotation.Nullable;
Jeff Sharkey30e06bb2017-04-24 11:18:03 -060020import android.annotation.RequiresPermission;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080021import android.annotation.SdkConstant;
22import android.annotation.SdkConstant.SdkConstantType;
Udam Sainib7c24872016-01-04 12:16:14 -080023import android.annotation.SystemApi;
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -060024import android.annotation.SystemService;
Mathew Inwoodfa3a7462018-08-08 14:52:47 +010025import android.annotation.UnsupportedAppUsage;
Robert Greenwalt9258c642014-03-26 16:47:06 -070026import android.app.PendingIntent;
Jeff Sharkey8fc27e82012-04-04 20:40:58 -070027import android.content.Context;
Robert Greenwaltd19c41c2014-05-18 23:07:25 -070028import android.content.Intent;
Robert Greenwalt42acef32009-08-12 16:08:25 -070029import android.os.Binder;
Mathew Inwood55418ea2018-12-20 15:30:45 +000030import android.os.Build;
Jeff Sharkey3a844fc2011-08-16 14:37:57 -070031import android.os.Build.VERSION_CODES;
Jeremy Klein36c7aa02016-01-22 14:11:45 -080032import android.os.Bundle;
Robert Greenwalt9258c642014-03-26 16:47:06 -070033import android.os.Handler;
34import android.os.HandlerThread;
Dianne Hackborn77b987f2014-02-26 16:20:52 -080035import android.os.IBinder;
36import android.os.INetworkActivityListener;
37import android.os.INetworkManagementService;
Robert Greenwalt9258c642014-03-26 16:47:06 -070038import android.os.Looper;
39import android.os.Message;
Robert Greenwalt665e1ae2012-08-21 19:27:00 -070040import android.os.Messenger;
Lorenzo Colittiffc42b02015-07-29 11:41:21 +090041import android.os.Process;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080042import android.os.RemoteException;
Jeremy Klein36c7aa02016-01-22 14:11:45 -080043import android.os.ResultReceiver;
Dianne Hackborn77b987f2014-02-26 16:20:52 -080044import android.os.ServiceManager;
Hugo Benichicb883232017-05-11 13:16:17 +090045import android.os.ServiceSpecificException;
Jeff Sharkey961e3042011-08-29 16:02:57 -070046import android.provider.Settings;
Wink Saville36ffb042014-12-05 11:10:30 -080047import android.telephony.SubscriptionManager;
Dianne Hackborn77b987f2014-02-26 16:20:52 -080048import android.util.ArrayMap;
Robert Greenwalt9258c642014-03-26 16:47:06 -070049import android.util.Log;
Erik Kline35bf06c2017-01-26 18:08:28 +090050import android.util.SparseIntArray;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080051
Robert Greenwaltafa05c02014-05-21 20:04:36 -070052import com.android.internal.telephony.ITelephony;
Robert Greenwalt562cc542014-05-15 18:07:26 -070053import com.android.internal.telephony.PhoneConstants;
Hugo Benichidafed3d2017-03-06 09:17:06 +090054import com.android.internal.util.Preconditions;
55import com.android.internal.util.Protocol;
Robert Greenwaltafa05c02014-05-21 20:04:36 -070056
Paul Jensenc91b5342014-08-27 12:38:45 -040057import libcore.net.event.NetworkEventDispatcher;
58
Felipe Leme1b103232016-01-22 09:44:57 -080059import java.lang.annotation.Retention;
60import java.lang.annotation.RetentionPolicy;
Jeremy Kleind42209d2015-12-28 15:11:58 -080061import java.net.InetAddress;
Jeff Vander Stoep0ac2c092018-07-23 10:57:53 -070062import java.net.InetSocketAddress;
Hugo Benichidafed3d2017-03-06 09:17:06 +090063import java.util.ArrayList;
Jeremy Kleind42209d2015-12-28 15:11:58 -080064import java.util.HashMap;
Hugo Benichidafed3d2017-03-06 09:17:06 +090065import java.util.List;
66import java.util.Map;
Jeremy Kleind42209d2015-12-28 15:11:58 -080067
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080068/**
69 * Class that answers queries about the state of network connectivity. It also
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -060070 * notifies applications when network connectivity changes.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080071 * <p>
72 * The primary responsibilities of this class are to:
73 * <ol>
74 * <li>Monitor network connections (Wi-Fi, GPRS, UMTS, etc.)</li>
75 * <li>Send broadcast intents when network connectivity changes</li>
76 * <li>Attempt to "fail over" to another network when connectivity to a network
77 * is lost</li>
78 * <li>Provide an API that allows applications to query the coarse-grained or fine-grained
79 * state of the available networks</li>
Robert Greenwaltd19c41c2014-05-18 23:07:25 -070080 * <li>Provide an API that allows applications to request and select networks for their data
81 * traffic</li>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080082 * </ol>
83 */
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -060084@SystemService(Context.CONNECTIVITY_SERVICE)
Jeff Sharkeyc006f1a2011-05-19 17:12:49 -070085public class ConnectivityManager {
86 private static final String TAG = "ConnectivityManager";
Soi, Yoshinaridee2aa42015-11-12 12:09:02 +090087 private static final boolean DEBUG = Log.isLoggable(TAG, Log.DEBUG);
Jeff Sharkeyc006f1a2011-05-19 17:12:49 -070088
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080089 /**
Robert Greenwaltd19c41c2014-05-18 23:07:25 -070090 * A change in network connectivity has occurred. A default connection has either
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080091 * been established or lost. The NetworkInfo for the affected network is
92 * sent as an extra; it should be consulted to see what kind of
93 * connectivity event occurred.
94 * <p/>
Mark Lu33ec1062016-12-05 10:57:55 -080095 * Apps targeting Android 7.0 (API level 24) and higher do not receive this
96 * broadcast if they declare the broadcast receiver in their manifest. Apps
97 * will still receive broadcasts if they register their
98 * {@link android.content.BroadcastReceiver} with
99 * {@link android.content.Context#registerReceiver Context.registerReceiver()}
100 * and that context is still valid.
101 * <p/>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800102 * If this is a connection that was the result of failing over from a
103 * disconnected network, then the FAILOVER_CONNECTION boolean extra is
104 * set to true.
105 * <p/>
106 * For a loss of connectivity, if the connectivity manager is attempting
107 * to connect (or has already connected) to another network, the
108 * NetworkInfo for the new network is also passed as an extra. This lets
109 * any receivers of the broadcast know that they should not necessarily
110 * tell the user that no data traffic will be possible. Instead, the
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800111 * receiver should expect another broadcast soon, indicating either that
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800112 * the failover attempt succeeded (and so there is still overall data
113 * connectivity), or that the failover attempt failed, meaning that all
114 * connectivity has been lost.
115 * <p/>
116 * For a disconnect event, the boolean extra EXTRA_NO_CONNECTIVITY
117 * is set to {@code true} if there are no connected networks at all.
Chalard Jean054cd162018-02-10 05:33:50 +0900118 *
119 * @deprecated apps should use the more versatile {@link #requestNetwork},
120 * {@link #registerNetworkCallback} or {@link #registerDefaultNetworkCallback}
121 * functions instead for faster and more detailed updates about the network
122 * changes they care about.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800123 */
Jeff Sharkey4fa63b22013-02-20 18:21:19 -0800124 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Chalard Jean054cd162018-02-10 05:33:50 +0900125 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800126 public static final String CONNECTIVITY_ACTION = "android.net.conn.CONNECTIVITY_CHANGE";
Jeff Sharkeyf0ceede2011-08-02 17:22:34 -0700127
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800128 /**
Robert Greenwalte94a6ff2015-09-01 08:23:04 -0700129 * A temporary hack until SUPL system can get off the legacy APIS.
130 * They do too many network requests and the long list of apps listening
Chalard Jean4d660112018-06-04 16:52:49 +0900131 * and waking due to the CONNECTIVITY_ACTION broadcast makes it expensive.
132 * Use this broadcast intent instead for SUPL requests.
Robert Greenwalte94a6ff2015-09-01 08:23:04 -0700133 * @hide
134 */
135 public static final String CONNECTIVITY_ACTION_SUPL =
136 "android.net.conn.CONNECTIVITY_CHANGE_SUPL";
137
138 /**
Paul Jensen25a217c2015-02-27 22:55:47 -0500139 * The device has connected to a network that has presented a captive
140 * portal, which is blocking Internet connectivity. The user was presented
141 * with a notification that network sign in is required,
142 * and the user invoked the notification's action indicating they
Paul Jensen49e3edf2015-05-22 10:50:39 -0400143 * desire to sign in to the network. Apps handling this activity should
Paul Jensen25a217c2015-02-27 22:55:47 -0500144 * facilitate signing in to the network. This action includes a
145 * {@link Network} typed extra called {@link #EXTRA_NETWORK} that represents
146 * the network presenting the captive portal; all communication with the
147 * captive portal must be done using this {@code Network} object.
148 * <p/>
Paul Jensen49e3edf2015-05-22 10:50:39 -0400149 * This activity includes a {@link CaptivePortal} extra named
150 * {@link #EXTRA_CAPTIVE_PORTAL} that can be used to indicate different
151 * outcomes of the captive portal sign in to the system:
152 * <ul>
153 * <li> When the app handling this action believes the user has signed in to
154 * the network and the captive portal has been dismissed, the app should
155 * call {@link CaptivePortal#reportCaptivePortalDismissed} so the system can
156 * reevaluate the network. If reevaluation finds the network no longer
157 * subject to a captive portal, the network may become the default active
Chalard Jean4d660112018-06-04 16:52:49 +0900158 * data network.</li>
Paul Jensen49e3edf2015-05-22 10:50:39 -0400159 * <li> When the app handling this action believes the user explicitly wants
Paul Jensen25a217c2015-02-27 22:55:47 -0500160 * to ignore the captive portal and the network, the app should call
Paul Jensen49e3edf2015-05-22 10:50:39 -0400161 * {@link CaptivePortal#ignoreNetwork}. </li>
162 * </ul>
Paul Jensen25a217c2015-02-27 22:55:47 -0500163 */
164 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
165 public static final String ACTION_CAPTIVE_PORTAL_SIGN_IN = "android.net.conn.CAPTIVE_PORTAL";
166
167 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800168 * The lookup key for a {@link NetworkInfo} object. Retrieve with
169 * {@link android.content.Intent#getParcelableExtra(String)}.
Jeff Sharkeyf0ceede2011-08-02 17:22:34 -0700170 *
171 * @deprecated Since {@link NetworkInfo} can vary based on UID, applications
172 * should always obtain network information through
Paul Jensen3541e9f2015-03-18 12:23:02 -0400173 * {@link #getActiveNetworkInfo()}.
Jeff Sharkey75fbb4b2012-08-06 11:41:50 -0700174 * @see #EXTRA_NETWORK_TYPE
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800175 */
Jeff Sharkeyf0ceede2011-08-02 17:22:34 -0700176 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800177 public static final String EXTRA_NETWORK_INFO = "networkInfo";
Jeff Sharkeyf0ceede2011-08-02 17:22:34 -0700178
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800179 /**
Jeff Sharkey75fbb4b2012-08-06 11:41:50 -0700180 * Network type which triggered a {@link #CONNECTIVITY_ACTION} broadcast.
Jeff Sharkey75fbb4b2012-08-06 11:41:50 -0700181 *
182 * @see android.content.Intent#getIntExtra(String, int)
183 */
184 public static final String EXTRA_NETWORK_TYPE = "networkType";
185
186 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800187 * The lookup key for a boolean that indicates whether a connect event
188 * is for a network to which the connectivity manager was failing over
189 * following a disconnect on another network.
190 * Retrieve it with {@link android.content.Intent#getBooleanExtra(String,boolean)}.
junyulai3822c8a2018-12-13 12:47:51 +0800191 *
192 * @deprecated See {@link NetworkInfo}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800193 */
junyulai3822c8a2018-12-13 12:47:51 +0800194 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800195 public static final String EXTRA_IS_FAILOVER = "isFailover";
196 /**
197 * The lookup key for a {@link NetworkInfo} object. This is supplied when
198 * there is another network that it may be possible to connect to. Retrieve with
199 * {@link android.content.Intent#getParcelableExtra(String)}.
junyulai3822c8a2018-12-13 12:47:51 +0800200 *
201 * @deprecated See {@link NetworkInfo}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800202 */
junyulai3822c8a2018-12-13 12:47:51 +0800203 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800204 public static final String EXTRA_OTHER_NETWORK_INFO = "otherNetwork";
205 /**
206 * The lookup key for a boolean that indicates whether there is a
207 * complete lack of connectivity, i.e., no network is available.
208 * Retrieve it with {@link android.content.Intent#getBooleanExtra(String,boolean)}.
209 */
210 public static final String EXTRA_NO_CONNECTIVITY = "noConnectivity";
211 /**
212 * The lookup key for a string that indicates why an attempt to connect
213 * to a network failed. The string has no particular structure. It is
214 * intended to be used in notifications presented to users. Retrieve
215 * it with {@link android.content.Intent#getStringExtra(String)}.
216 */
217 public static final String EXTRA_REASON = "reason";
218 /**
219 * The lookup key for a string that provides optionally supplied
220 * extra information about the network state. The information
221 * may be passed up from the lower networking layers, and its
222 * meaning may be specific to a particular network type. Retrieve
223 * it with {@link android.content.Intent#getStringExtra(String)}.
junyulai3822c8a2018-12-13 12:47:51 +0800224 *
225 * @deprecated See {@link NetworkInfo#getExtraInfo()}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800226 */
junyulai3822c8a2018-12-13 12:47:51 +0800227 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800228 public static final String EXTRA_EXTRA_INFO = "extraInfo";
Robert Greenwaltd7085fc2010-09-08 15:24:47 -0700229 /**
230 * The lookup key for an int that provides information about
231 * our connection to the internet at large. 0 indicates no connection,
232 * 100 indicates a great connection. Retrieve it with
Jeff Sharkeyc006f1a2011-05-19 17:12:49 -0700233 * {@link android.content.Intent#getIntExtra(String, int)}.
Robert Greenwaltd7085fc2010-09-08 15:24:47 -0700234 * {@hide}
235 */
236 public static final String EXTRA_INET_CONDITION = "inetCondition";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800237 /**
Paul Jensen49e3edf2015-05-22 10:50:39 -0400238 * The lookup key for a {@link CaptivePortal} object included with the
239 * {@link #ACTION_CAPTIVE_PORTAL_SIGN_IN} intent. The {@code CaptivePortal}
240 * object can be used to either indicate to the system that the captive
241 * portal has been dismissed or that the user does not want to pursue
242 * signing in to captive portal. Retrieve it with
243 * {@link android.content.Intent#getParcelableExtra(String)}.
Paul Jensen25a217c2015-02-27 22:55:47 -0500244 */
Paul Jensen49e3edf2015-05-22 10:50:39 -0400245 public static final String EXTRA_CAPTIVE_PORTAL = "android.net.extra.CAPTIVE_PORTAL";
Jan Nordqvist52eb29f2015-09-22 15:54:32 -0700246
247 /**
248 * Key for passing a URL to the captive portal login activity.
249 */
250 public static final String EXTRA_CAPTIVE_PORTAL_URL = "android.net.extra.CAPTIVE_PORTAL_URL";
251
Paul Jensen25a217c2015-02-27 22:55:47 -0500252 /**
Remi NGUYEN VAN8255c2d2018-05-22 10:01:53 +0900253 * Key for passing a {@link android.net.captiveportal.CaptivePortalProbeSpec} to the captive
254 * portal login activity.
255 * {@hide}
256 */
257 public static final String EXTRA_CAPTIVE_PORTAL_PROBE_SPEC =
258 "android.net.extra.CAPTIVE_PORTAL_PROBE_SPEC";
259
260 /**
Hugo Benichicdf3ba42016-12-14 08:23:40 +0900261 * Key for passing a user agent string to the captive portal login activity.
262 * {@hide}
263 */
264 public static final String EXTRA_CAPTIVE_PORTAL_USER_AGENT =
265 "android.net.extra.CAPTIVE_PORTAL_USER_AGENT";
266
267 /**
Haoyu Baidb3c8672012-06-20 14:29:57 -0700268 * Broadcast action to indicate the change of data activity status
269 * (idle or active) on a network in a recent period.
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800270 * The network becomes active when data transmission is started, or
271 * idle if there is no data transmission for a period of time.
Haoyu Baidb3c8672012-06-20 14:29:57 -0700272 * {@hide}
273 */
274 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Chalard Jean4d660112018-06-04 16:52:49 +0900275 public static final String ACTION_DATA_ACTIVITY_CHANGE =
276 "android.net.conn.DATA_ACTIVITY_CHANGE";
Haoyu Baidb3c8672012-06-20 14:29:57 -0700277 /**
278 * The lookup key for an enum that indicates the network device type on which this data activity
279 * change happens.
280 * {@hide}
281 */
282 public static final String EXTRA_DEVICE_TYPE = "deviceType";
283 /**
284 * The lookup key for a boolean that indicates the device is active or not. {@code true} means
285 * it is actively sending or receiving data and {@code false} means it is idle.
286 * {@hide}
287 */
288 public static final String EXTRA_IS_ACTIVE = "isActive";
Ashish Sharma0535a9f2014-03-12 18:42:23 -0700289 /**
290 * The lookup key for a long that contains the timestamp (nanos) of the radio state change.
291 * {@hide}
292 */
293 public static final String EXTRA_REALTIME_NS = "tsNanos";
Haoyu Baidb3c8672012-06-20 14:29:57 -0700294
295 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800296 * Broadcast Action: The setting for background data usage has changed
297 * values. Use {@link #getBackgroundDataSetting()} to get the current value.
298 * <p>
299 * If an application uses the network in the background, it should listen
300 * for this broadcast and stop using the background data if the value is
Jeff Sharkeyc006f1a2011-05-19 17:12:49 -0700301 * {@code false}.
Jeff Sharkey54ee2ad2012-01-30 16:29:24 -0800302 * <p>
303 *
304 * @deprecated As of {@link VERSION_CODES#ICE_CREAM_SANDWICH}, availability
305 * of background data depends on several combined factors, and
306 * this broadcast is no longer sent. Instead, when background
307 * data is unavailable, {@link #getActiveNetworkInfo()} will now
308 * appear disconnected. During first boot after a platform
309 * upgrade, this broadcast will be sent once if
310 * {@link #getBackgroundDataSetting()} was {@code false} before
311 * the upgrade.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800312 */
313 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jeff Sharkey54ee2ad2012-01-30 16:29:24 -0800314 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800315 public static final String ACTION_BACKGROUND_DATA_SETTING_CHANGED =
316 "android.net.conn.BACKGROUND_DATA_SETTING_CHANGED";
317
Robert Greenwalt1e9aac22010-09-15 17:36:33 -0700318 /**
319 * Broadcast Action: The network connection may not be good
320 * uses {@code ConnectivityManager.EXTRA_INET_CONDITION} and
321 * {@code ConnectivityManager.EXTRA_NETWORK_INFO} to specify
322 * the network and it's condition.
323 * @hide
324 */
Jeff Sharkey4fa63b22013-02-20 18:21:19 -0800325 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Mathew Inwoodfa3a7462018-08-08 14:52:47 +0100326 @UnsupportedAppUsage
Robert Greenwalt1e9aac22010-09-15 17:36:33 -0700327 public static final String INET_CONDITION_ACTION =
328 "android.net.conn.INET_CONDITION_ACTION";
329
Robert Greenwalt42acef32009-08-12 16:08:25 -0700330 /**
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800331 * Broadcast Action: A tetherable connection has come or gone.
332 * Uses {@code ConnectivityManager.EXTRA_AVAILABLE_TETHER},
Erik Kline8351faa2017-04-17 16:47:23 +0900333 * {@code ConnectivityManager.EXTRA_ACTIVE_LOCAL_ONLY},
334 * {@code ConnectivityManager.EXTRA_ACTIVE_TETHER}, and
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800335 * {@code ConnectivityManager.EXTRA_ERRORED_TETHER} to indicate
336 * the current state of tethering. Each include a list of
337 * interface names in that state (may be empty).
Robert Greenwaltd0e18ff2010-01-26 11:40:34 -0800338 * @hide
339 */
Jeff Sharkey4fa63b22013-02-20 18:21:19 -0800340 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Mathew Inwoodfa3a7462018-08-08 14:52:47 +0100341 @UnsupportedAppUsage
Robert Greenwaltd0e18ff2010-01-26 11:40:34 -0800342 public static final String ACTION_TETHER_STATE_CHANGED =
343 "android.net.conn.TETHER_STATE_CHANGED";
344
345 /**
346 * @hide
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800347 * gives a String[] listing all the interfaces configured for
348 * tethering and currently available for tethering.
Robert Greenwaltd0e18ff2010-01-26 11:40:34 -0800349 */
Mathew Inwoodfa3a7462018-08-08 14:52:47 +0100350 @UnsupportedAppUsage
Robert Greenwalt2a091d72010-02-11 18:18:40 -0800351 public static final String EXTRA_AVAILABLE_TETHER = "availableArray";
Robert Greenwaltd0e18ff2010-01-26 11:40:34 -0800352
353 /**
354 * @hide
Erik Kline8351faa2017-04-17 16:47:23 +0900355 * gives a String[] listing all the interfaces currently in local-only
356 * mode (ie, has DHCPv4+IPv6-ULA support and no packet forwarding)
Robert Greenwaltd0e18ff2010-01-26 11:40:34 -0800357 */
Erik Kline8351faa2017-04-17 16:47:23 +0900358 public static final String EXTRA_ACTIVE_LOCAL_ONLY = "localOnlyArray";
359
360 /**
361 * @hide
362 * gives a String[] listing all the interfaces currently tethered
363 * (ie, has DHCPv4 support and packets potentially forwarded/NATed)
364 */
Mathew Inwoodfa3a7462018-08-08 14:52:47 +0100365 @UnsupportedAppUsage
Erik Kline8351faa2017-04-17 16:47:23 +0900366 public static final String EXTRA_ACTIVE_TETHER = "tetherArray";
Robert Greenwalt2a091d72010-02-11 18:18:40 -0800367
368 /**
369 * @hide
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800370 * gives a String[] listing all the interfaces we tried to tether and
371 * failed. Use {@link #getLastTetherError} to find the error code
372 * for any interfaces listed here.
Robert Greenwalt2a091d72010-02-11 18:18:40 -0800373 */
Mathew Inwoodfa3a7462018-08-08 14:52:47 +0100374 @UnsupportedAppUsage
Robert Greenwalt2a091d72010-02-11 18:18:40 -0800375 public static final String EXTRA_ERRORED_TETHER = "erroredArray";
Robert Greenwaltd0e18ff2010-01-26 11:40:34 -0800376
377 /**
Russell Brenner108da0c2013-02-12 10:03:14 -0800378 * Broadcast Action: The captive portal tracker has finished its test.
379 * Sent only while running Setup Wizard, in lieu of showing a user
380 * notification.
381 * @hide
382 */
Jeff Sharkey4fa63b22013-02-20 18:21:19 -0800383 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Russell Brenner108da0c2013-02-12 10:03:14 -0800384 public static final String ACTION_CAPTIVE_PORTAL_TEST_COMPLETED =
385 "android.net.conn.CAPTIVE_PORTAL_TEST_COMPLETED";
386 /**
387 * The lookup key for a boolean that indicates whether a captive portal was detected.
388 * Retrieve it with {@link android.content.Intent#getBooleanExtra(String,boolean)}.
389 * @hide
390 */
391 public static final String EXTRA_IS_CAPTIVE_PORTAL = "captivePortal";
392
393 /**
Lorenzo Colittie03c3c72015-04-03 16:38:52 +0900394 * Action used to display a dialog that asks the user whether to connect to a network that is
395 * not validated. This intent is used to start the dialog in settings via startActivity.
396 *
397 * @hide
398 */
399 public static final String ACTION_PROMPT_UNVALIDATED = "android.net.conn.PROMPT_UNVALIDATED";
400
401 /**
Lorenzo Colitti9be58c52016-09-15 14:02:29 +0900402 * Action used to display a dialog that asks the user whether to avoid a network that is no
403 * longer validated. This intent is used to start the dialog in settings via startActivity.
404 *
405 * @hide
406 */
407 public static final String ACTION_PROMPT_LOST_VALIDATION =
408 "android.net.conn.PROMPT_LOST_VALIDATION";
409
410 /**
Jeremy Klein36c7aa02016-01-22 14:11:45 -0800411 * Invalid tethering type.
Chalard Jean4d660112018-06-04 16:52:49 +0900412 * @see #startTethering(int, boolean, OnStartTetheringCallback)
Jeremy Klein36c7aa02016-01-22 14:11:45 -0800413 * @hide
414 */
415 public static final int TETHERING_INVALID = -1;
416
417 /**
418 * Wifi tethering type.
Chalard Jean4d660112018-06-04 16:52:49 +0900419 * @see #startTethering(int, boolean, OnStartTetheringCallback)
Jeremy Klein36c7aa02016-01-22 14:11:45 -0800420 * @hide
421 */
422 @SystemApi
423 public static final int TETHERING_WIFI = 0;
424
425 /**
426 * USB tethering type.
Chalard Jean4d660112018-06-04 16:52:49 +0900427 * @see #startTethering(int, boolean, OnStartTetheringCallback)
Jeremy Klein36c7aa02016-01-22 14:11:45 -0800428 * @hide
429 */
430 @SystemApi
431 public static final int TETHERING_USB = 1;
432
433 /**
434 * Bluetooth tethering type.
Chalard Jean4d660112018-06-04 16:52:49 +0900435 * @see #startTethering(int, boolean, OnStartTetheringCallback)
Jeremy Klein36c7aa02016-01-22 14:11:45 -0800436 * @hide
437 */
438 @SystemApi
439 public static final int TETHERING_BLUETOOTH = 2;
440
441 /**
442 * Extra used for communicating with the TetherService. Includes the type of tethering to
443 * enable if any.
444 * @hide
445 */
446 public static final String EXTRA_ADD_TETHER_TYPE = "extraAddTetherType";
447
448 /**
449 * Extra used for communicating with the TetherService. Includes the type of tethering for
450 * which to cancel provisioning.
451 * @hide
452 */
453 public static final String EXTRA_REM_TETHER_TYPE = "extraRemTetherType";
454
455 /**
456 * Extra used for communicating with the TetherService. True to schedule a recheck of tether
457 * provisioning.
458 * @hide
459 */
460 public static final String EXTRA_SET_ALARM = "extraSetAlarm";
461
462 /**
463 * Tells the TetherService to run a provision check now.
464 * @hide
465 */
466 public static final String EXTRA_RUN_PROVISION = "extraRunProvision";
467
468 /**
469 * Extra used for communicating with the TetherService. Contains the {@link ResultReceiver}
470 * which will receive provisioning results. Can be left empty.
471 * @hide
472 */
473 public static final String EXTRA_PROVISION_CALLBACK = "extraProvisionCallback";
474
475 /**
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800476 * The absence of a connection type.
Robert Greenwaltccf83af12011-06-02 17:30:47 -0700477 * @hide
478 */
Mathew Inwoodfa3a7462018-08-08 14:52:47 +0100479 @UnsupportedAppUsage
Robert Greenwaltccf83af12011-06-02 17:30:47 -0700480 public static final int TYPE_NONE = -1;
481
482 /**
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900483 * A Mobile data connection. Devices may support more than one.
484 *
485 * @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or
486 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an
487 * appropriate network. {@see NetworkCapabilities} for supported transports.
Robert Greenwalt42acef32009-08-12 16:08:25 -0700488 */
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900489 @Deprecated
Robert Greenwalt42acef32009-08-12 16:08:25 -0700490 public static final int TYPE_MOBILE = 0;
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900491
Robert Greenwalt42acef32009-08-12 16:08:25 -0700492 /**
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900493 * A WIFI data connection. Devices may support more than one.
494 *
495 * @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or
496 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an
497 * appropriate network. {@see NetworkCapabilities} for supported transports.
Robert Greenwalt42acef32009-08-12 16:08:25 -0700498 */
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900499 @Deprecated
Robert Greenwalt42acef32009-08-12 16:08:25 -0700500 public static final int TYPE_WIFI = 1;
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900501
Robert Greenwalt42acef32009-08-12 16:08:25 -0700502 /**
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800503 * An MMS-specific Mobile data connection. This network type may use the
504 * same network interface as {@link #TYPE_MOBILE} or it may use a different
505 * one. This is used by applications needing to talk to the carrier's
506 * Multimedia Messaging Service servers.
Lorenzo Colittie285b432015-04-23 15:32:42 +0900507 *
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900508 * @deprecated Applications should instead use {@link NetworkCapabilities#hasCapability} or
Lorenzo Colitti2ea89e52015-04-24 17:03:31 +0900509 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request a network that
Lorenzo Colittie285b432015-04-23 15:32:42 +0900510 * provides the {@link NetworkCapabilities#NET_CAPABILITY_MMS} capability.
Robert Greenwalt42acef32009-08-12 16:08:25 -0700511 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -0700512 @Deprecated
Robert Greenwalt42acef32009-08-12 16:08:25 -0700513 public static final int TYPE_MOBILE_MMS = 2;
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900514
Robert Greenwalt42acef32009-08-12 16:08:25 -0700515 /**
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800516 * A SUPL-specific Mobile data connection. This network type may use the
517 * same network interface as {@link #TYPE_MOBILE} or it may use a different
518 * one. This is used by applications needing to talk to the carrier's
519 * Secure User Plane Location servers for help locating the device.
Lorenzo Colittie285b432015-04-23 15:32:42 +0900520 *
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900521 * @deprecated Applications should instead use {@link NetworkCapabilities#hasCapability} or
Lorenzo Colitti2ea89e52015-04-24 17:03:31 +0900522 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request a network that
Lorenzo Colittie285b432015-04-23 15:32:42 +0900523 * provides the {@link NetworkCapabilities#NET_CAPABILITY_SUPL} capability.
Robert Greenwalt42acef32009-08-12 16:08:25 -0700524 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -0700525 @Deprecated
Robert Greenwalt42acef32009-08-12 16:08:25 -0700526 public static final int TYPE_MOBILE_SUPL = 3;
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900527
Robert Greenwalt42acef32009-08-12 16:08:25 -0700528 /**
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800529 * A DUN-specific Mobile data connection. This network type may use the
530 * same network interface as {@link #TYPE_MOBILE} or it may use a different
531 * one. This is sometimes by the system when setting up an upstream connection
532 * for tethering so that the carrier is aware of DUN traffic.
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900533 *
534 * @deprecated Applications should instead use {@link NetworkCapabilities#hasCapability} or
535 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request a network that
536 * provides the {@link NetworkCapabilities#NET_CAPABILITY_DUN} capability.
Robert Greenwalt42acef32009-08-12 16:08:25 -0700537 */
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900538 @Deprecated
Robert Greenwalt42acef32009-08-12 16:08:25 -0700539 public static final int TYPE_MOBILE_DUN = 4;
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900540
Robert Greenwalt42acef32009-08-12 16:08:25 -0700541 /**
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800542 * A High Priority Mobile data connection. This network type uses the
543 * same network interface as {@link #TYPE_MOBILE} but the routing setup
Lorenzo Colittie285b432015-04-23 15:32:42 +0900544 * is different.
545 *
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900546 * @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or
547 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an
548 * appropriate network. {@see NetworkCapabilities} for supported transports.
Robert Greenwalt42acef32009-08-12 16:08:25 -0700549 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -0700550 @Deprecated
Robert Greenwalt42acef32009-08-12 16:08:25 -0700551 public static final int TYPE_MOBILE_HIPRI = 5;
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900552
jsh8214deb2010-03-11 15:04:43 -0800553 /**
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900554 * A WiMAX data connection.
555 *
556 * @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or
557 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an
558 * appropriate network. {@see NetworkCapabilities} for supported transports.
jsh8214deb2010-03-11 15:04:43 -0800559 */
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900560 @Deprecated
jsh8214deb2010-03-11 15:04:43 -0800561 public static final int TYPE_WIMAX = 6;
Robert Greenwaltda3d5e62010-12-06 13:56:24 -0800562
Jaikumar Ganesh15c74392010-12-21 22:31:44 -0800563 /**
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900564 * A Bluetooth data connection.
565 *
566 * @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or
567 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an
568 * appropriate network. {@see NetworkCapabilities} for supported transports.
Jaikumar Ganesh15c74392010-12-21 22:31:44 -0800569 */
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900570 @Deprecated
Jaikumar Ganesh15c74392010-12-21 22:31:44 -0800571 public static final int TYPE_BLUETOOTH = 7;
572
Robert Greenwalt60810842011-04-22 15:28:18 -0700573 /**
574 * Dummy data connection. This should not be used on shipping devices.
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900575 * @deprecated This is not used any more.
Robert Greenwalt60810842011-04-22 15:28:18 -0700576 */
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900577 @Deprecated
Jaikumar Ganesh15c74392010-12-21 22:31:44 -0800578 public static final int TYPE_DUMMY = 8;
Wink Saville9d7d6282011-03-12 14:52:01 -0800579
Robert Greenwalt60810842011-04-22 15:28:18 -0700580 /**
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900581 * An Ethernet data connection.
582 *
583 * @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or
584 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an
585 * appropriate network. {@see NetworkCapabilities} for supported transports.
Robert Greenwalt60810842011-04-22 15:28:18 -0700586 */
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900587 @Deprecated
Robert Greenwalte12aec92011-01-28 14:48:37 -0800588 public static final int TYPE_ETHERNET = 9;
Robert Greenwalt60810842011-04-22 15:28:18 -0700589
Wink Saville9d7d6282011-03-12 14:52:01 -0800590 /**
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800591 * Over the air Administration.
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900592 * @deprecated Use {@link NetworkCapabilities} instead.
Wink Saville9d7d6282011-03-12 14:52:01 -0800593 * {@hide}
594 */
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900595 @Deprecated
Mathew Inwoodfa3a7462018-08-08 14:52:47 +0100596 @UnsupportedAppUsage
Wink Saville9d7d6282011-03-12 14:52:01 -0800597 public static final int TYPE_MOBILE_FOTA = 10;
598
599 /**
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800600 * IP Multimedia Subsystem.
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900601 * @deprecated Use {@link NetworkCapabilities#NET_CAPABILITY_IMS} instead.
Wink Saville9d7d6282011-03-12 14:52:01 -0800602 * {@hide}
603 */
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900604 @Deprecated
Mathew Inwoodfa3a7462018-08-08 14:52:47 +0100605 @UnsupportedAppUsage
Wink Saville9d7d6282011-03-12 14:52:01 -0800606 public static final int TYPE_MOBILE_IMS = 11;
607
608 /**
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800609 * Carrier Branded Services.
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900610 * @deprecated Use {@link NetworkCapabilities#NET_CAPABILITY_CBS} 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_CBS = 12;
616
repo syncaea743a2011-07-29 23:55:49 -0700617 /**
618 * A Wi-Fi p2p connection. Only requesting processes will have access to
619 * the peers connected.
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900620 * @deprecated Use {@link NetworkCapabilities#NET_CAPABILITY_WIFI_P2P} instead.
repo syncaea743a2011-07-29 23:55:49 -0700621 * {@hide}
622 */
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900623 @Deprecated
Mathew Inwoodfa3a7462018-08-08 14:52:47 +0100624 @UnsupportedAppUsage
repo syncaea743a2011-07-29 23:55:49 -0700625 public static final int TYPE_WIFI_P2P = 13;
Wink Saville9d7d6282011-03-12 14:52:01 -0800626
Wink Saville5e56bc52013-07-29 15:00:57 -0700627 /**
628 * The network to use for initially attaching to the network
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900629 * @deprecated Use {@link NetworkCapabilities#NET_CAPABILITY_IA} instead.
Wink Saville5e56bc52013-07-29 15:00:57 -0700630 * {@hide}
631 */
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900632 @Deprecated
Mathew Inwoodfa3a7462018-08-08 14:52:47 +0100633 @UnsupportedAppUsage
Wink Saville5e56bc52013-07-29 15:00:57 -0700634 public static final int TYPE_MOBILE_IA = 14;
repo syncaea743a2011-07-29 23:55:49 -0700635
Lorenzo Colittie285b432015-04-23 15:32:42 +0900636 /**
Robert Greenwalt4bd43892015-07-09 14:49:35 -0700637 * Emergency PDN connection for emergency services. This
638 * may include IMS and MMS in emergency situations.
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900639 * @deprecated Use {@link NetworkCapabilities#NET_CAPABILITY_EIMS} instead.
Ram3e0e3bc2014-06-26 11:03:44 -0700640 * {@hide}
641 */
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900642 @Deprecated
Mathew Inwoodfa3a7462018-08-08 14:52:47 +0100643 @UnsupportedAppUsage
Ram3e0e3bc2014-06-26 11:03:44 -0700644 public static final int TYPE_MOBILE_EMERGENCY = 15;
645
Hui Lu1c5624a2014-01-15 11:05:36 -0500646 /**
647 * The network that uses proxy to achieve connectivity.
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900648 * @deprecated Use {@link NetworkCapabilities} instead.
Hui Lu1c5624a2014-01-15 11:05:36 -0500649 * {@hide}
650 */
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900651 @Deprecated
Mathew Inwoodfa3a7462018-08-08 14:52:47 +0100652 @UnsupportedAppUsage
Hui Lu1c5624a2014-01-15 11:05:36 -0500653 public static final int TYPE_PROXY = 16;
Wink Saville5e56bc52013-07-29 15:00:57 -0700654
Robert Greenwalt8283f882014-07-07 17:09:01 -0700655 /**
656 * A virtual network using one or more native bearers.
657 * It may or may not be providing security services.
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900658 * @deprecated Applications should use {@link NetworkCapabilities#TRANSPORT_VPN} instead.
Robert Greenwalt8283f882014-07-07 17:09:01 -0700659 */
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900660 @Deprecated
Robert Greenwalt8283f882014-07-07 17:09:01 -0700661 public static final int TYPE_VPN = 17;
Hui Lu1c5624a2014-01-15 11:05:36 -0500662
663 /** {@hide} */
Robert Greenwalt8283f882014-07-07 17:09:01 -0700664 public static final int MAX_RADIO_TYPE = TYPE_VPN;
665
666 /** {@hide} */
667 public static final int MAX_NETWORK_TYPE = TYPE_VPN;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800668
Hugo Benichi16f0a942017-06-20 14:07:59 +0900669 private static final int MIN_NETWORK_TYPE = TYPE_MOBILE;
670
Jianzheng Zhoudcf03f32012-11-16 13:45:20 +0800671 /**
672 * If you want to set the default network preference,you can directly
673 * change the networkAttributes array in framework's config.xml.
674 *
675 * @deprecated Since we support so many more networks now, the single
676 * network default network preference can't really express
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800677 * the hierarchy. Instead, the default is defined by the
Jianzheng Zhoudcf03f32012-11-16 13:45:20 +0800678 * networkAttributes in config.xml. You can determine
Robert Greenwalt4c8b7482012-12-07 09:56:50 -0800679 * the current value by calling {@link #getNetworkPreference()}
Jianzheng Zhoudcf03f32012-11-16 13:45:20 +0800680 * from an App.
681 */
682 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800683 public static final int DEFAULT_NETWORK_PREFERENCE = TYPE_WIFI;
684
Jeff Sharkey625239a2012-09-26 22:03:49 -0700685 /**
Robert Greenwalt9ba9c582014-03-19 17:56:12 -0700686 * @hide
687 */
Hugo Benichia5c1f7f2017-06-20 14:10:14 +0900688 public static final int REQUEST_ID_UNSET = 0;
Robert Greenwalt7569f182014-06-08 16:42:59 -0700689
Paul Jensen5d59e782014-07-11 12:28:19 -0400690 /**
Hugo Benichi31c176d2017-06-17 13:14:12 +0900691 * Static unique request used as a tombstone for NetworkCallbacks that have been unregistered.
692 * This allows to distinguish when unregistering NetworkCallbacks those that were never
Chalard Jean4d660112018-06-04 16:52:49 +0900693 * registered from those that were already unregistered.
Hugo Benichi31c176d2017-06-17 13:14:12 +0900694 * @hide
695 */
Hugo Benichia5c1f7f2017-06-20 14:10:14 +0900696 private static final NetworkRequest ALREADY_UNREGISTERED =
Hugo Benichi31c176d2017-06-17 13:14:12 +0900697 new NetworkRequest.Builder().clearCapabilities().build();
698
699 /**
Paul Jensen5d59e782014-07-11 12:28:19 -0400700 * A NetID indicating no Network is selected.
701 * Keep in sync with bionic/libc/dns/include/resolv_netid.h
702 * @hide
703 */
704 public static final int NETID_UNSET = 0;
705
Erik Kline4d092232017-10-30 15:29:44 +0900706 /**
707 * Private DNS Mode values.
708 *
709 * The "private_dns_mode" global setting stores a String value which is
710 * expected to be one of the following.
711 */
712
713 /**
714 * @hide
715 */
716 public static final String PRIVATE_DNS_MODE_OFF = "off";
717 /**
718 * @hide
719 */
720 public static final String PRIVATE_DNS_MODE_OPPORTUNISTIC = "opportunistic";
721 /**
722 * @hide
723 */
724 public static final String PRIVATE_DNS_MODE_PROVIDER_HOSTNAME = "hostname";
725 /**
726 * The default Private DNS mode.
727 *
728 * This may change from release to release or may become dependent upon
729 * the capabilities of the underlying platform.
730 *
731 * @hide
732 */
Erik Kline19841792018-05-16 16:41:57 +0900733 public static final String PRIVATE_DNS_DEFAULT_MODE_FALLBACK = PRIVATE_DNS_MODE_OPPORTUNISTIC;
Erik Kline4d092232017-10-30 15:29:44 +0900734
Mathew Inwoodfa3a7462018-08-08 14:52:47 +0100735 @UnsupportedAppUsage
Jeff Sharkeyc006f1a2011-05-19 17:12:49 -0700736 private final IConnectivityManager mService;
Paul Jensene0bef712014-12-10 15:12:18 -0500737 /**
738 * A kludge to facilitate static access where a Context pointer isn't available, like in the
739 * case of the static set/getProcessDefaultNetwork methods and from the Network class.
740 * TODO: Remove this after deprecating the static methods in favor of non-static methods or
741 * methods that take a Context argument.
742 */
743 private static ConnectivityManager sInstance;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800744
Lorenzo Colittiffc42b02015-07-29 11:41:21 +0900745 private final Context mContext;
746
Dianne Hackborn77b987f2014-02-26 16:20:52 -0800747 private INetworkManagementService mNMService;
Felipe Leme1b103232016-01-22 09:44:57 -0800748 private INetworkPolicyManager mNPManager;
Dianne Hackborn77b987f2014-02-26 16:20:52 -0800749
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800750 /**
751 * Tests if a given integer represents a valid network type.
752 * @param networkType the type to be tested
753 * @return a boolean. {@code true} if the type is valid, else {@code false}
Paul Jensen9e59e122015-05-06 10:42:25 -0400754 * @deprecated All APIs accepting a network type are deprecated. There should be no need to
755 * validate a network type.
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800756 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -0700757 @Deprecated
Jeff Sharkeyd2a45872011-05-28 20:56:34 -0700758 public static boolean isNetworkTypeValid(int networkType) {
Hugo Benichi16f0a942017-06-20 14:07:59 +0900759 return MIN_NETWORK_TYPE <= networkType && networkType <= MAX_NETWORK_TYPE;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800760 }
761
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800762 /**
763 * Returns a non-localized string representing a given network type.
764 * ONLY used for debugging output.
765 * @param type the type needing naming
766 * @return a String for the given type, or a string version of the type ("87")
767 * if no name is known.
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900768 * @deprecated Types are deprecated. Use {@link NetworkCapabilities} instead.
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800769 * {@hide}
770 */
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900771 @Deprecated
Mathew Inwoodfa3a7462018-08-08 14:52:47 +0100772 @UnsupportedAppUsage
Jeff Sharkeyd2a45872011-05-28 20:56:34 -0700773 public static String getNetworkTypeName(int type) {
774 switch (type) {
Hugo Benichi16f0a942017-06-20 14:07:59 +0900775 case TYPE_NONE:
776 return "NONE";
Jeff Sharkeyd2a45872011-05-28 20:56:34 -0700777 case TYPE_MOBILE:
778 return "MOBILE";
779 case TYPE_WIFI:
780 return "WIFI";
781 case TYPE_MOBILE_MMS:
782 return "MOBILE_MMS";
783 case TYPE_MOBILE_SUPL:
784 return "MOBILE_SUPL";
785 case TYPE_MOBILE_DUN:
786 return "MOBILE_DUN";
787 case TYPE_MOBILE_HIPRI:
788 return "MOBILE_HIPRI";
789 case TYPE_WIMAX:
790 return "WIMAX";
791 case TYPE_BLUETOOTH:
792 return "BLUETOOTH";
793 case TYPE_DUMMY:
794 return "DUMMY";
795 case TYPE_ETHERNET:
796 return "ETHERNET";
797 case TYPE_MOBILE_FOTA:
798 return "MOBILE_FOTA";
799 case TYPE_MOBILE_IMS:
800 return "MOBILE_IMS";
801 case TYPE_MOBILE_CBS:
802 return "MOBILE_CBS";
repo syncaea743a2011-07-29 23:55:49 -0700803 case TYPE_WIFI_P2P:
804 return "WIFI_P2P";
Wink Saville5e56bc52013-07-29 15:00:57 -0700805 case TYPE_MOBILE_IA:
806 return "MOBILE_IA";
Ram3e0e3bc2014-06-26 11:03:44 -0700807 case TYPE_MOBILE_EMERGENCY:
808 return "MOBILE_EMERGENCY";
Hui Lu1c5624a2014-01-15 11:05:36 -0500809 case TYPE_PROXY:
810 return "PROXY";
Erik Kline37fbfa12014-11-19 17:23:41 +0900811 case TYPE_VPN:
812 return "VPN";
Jeff Sharkeyd2a45872011-05-28 20:56:34 -0700813 default:
814 return Integer.toString(type);
815 }
816 }
817
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800818 /**
819 * Checks if a given type uses the cellular data connection.
820 * This should be replaced in the future by a network property.
821 * @param networkType the type to check
822 * @return a boolean - {@code true} if uses cellular network, else {@code false}
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900823 * @deprecated Types are deprecated. Use {@link NetworkCapabilities} instead.
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800824 * {@hide}
825 */
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900826 @Deprecated
Mathew Inwoodfa3a7462018-08-08 14:52:47 +0100827 @UnsupportedAppUsage
Jeff Sharkeyd2a45872011-05-28 20:56:34 -0700828 public static boolean isNetworkTypeMobile(int networkType) {
829 switch (networkType) {
830 case TYPE_MOBILE:
831 case TYPE_MOBILE_MMS:
832 case TYPE_MOBILE_SUPL:
833 case TYPE_MOBILE_DUN:
834 case TYPE_MOBILE_HIPRI:
835 case TYPE_MOBILE_FOTA:
836 case TYPE_MOBILE_IMS:
837 case TYPE_MOBILE_CBS:
Wink Saville5e56bc52013-07-29 15:00:57 -0700838 case TYPE_MOBILE_IA:
Ram3e0e3bc2014-06-26 11:03:44 -0700839 case TYPE_MOBILE_EMERGENCY:
Jeff Sharkeyd2a45872011-05-28 20:56:34 -0700840 return true;
841 default:
842 return false;
843 }
844 }
845
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800846 /**
Jeff Sharkey7a1c3fc2013-06-04 12:29:00 -0700847 * Checks if the given network type is backed by a Wi-Fi radio.
848 *
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900849 * @deprecated Types are deprecated. Use {@link NetworkCapabilities} instead.
Jeff Sharkey7a1c3fc2013-06-04 12:29:00 -0700850 * @hide
851 */
Chalard Jean6b1da6e2018-03-08 13:54:53 +0900852 @Deprecated
Jeff Sharkey7a1c3fc2013-06-04 12:29:00 -0700853 public static boolean isNetworkTypeWifi(int networkType) {
854 switch (networkType) {
855 case TYPE_WIFI:
856 case TYPE_WIFI_P2P:
857 return true;
858 default:
859 return false;
860 }
861 }
862
863 /**
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800864 * Specifies the preferred network type. When the device has more
865 * than one type available the preferred network type will be used.
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800866 *
867 * @param preference the network type to prefer over all others. It is
868 * unspecified what happens to the old preferred network in the
869 * overall ordering.
Robert Greenwaltd19c41c2014-05-18 23:07:25 -0700870 * @deprecated Functionality has been removed as it no longer makes sense,
871 * with many more than two networks - we'd need an array to express
872 * preference. Instead we use dynamic network properties of
873 * the networks to describe their precedence.
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800874 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -0700875 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800876 public void setNetworkPreference(int preference) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800877 }
878
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800879 /**
880 * Retrieves the current preferred network type.
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800881 *
882 * @return an integer representing the preferred network type
883 *
Robert Greenwaltd19c41c2014-05-18 23:07:25 -0700884 * @deprecated Functionality has been removed as it no longer makes sense,
885 * with many more than two networks - we'd need an array to express
886 * preference. Instead we use dynamic network properties of
887 * the networks to describe their precedence.
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800888 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -0700889 @Deprecated
Jeff Sharkey30e06bb2017-04-24 11:18:03 -0600890 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800891 public int getNetworkPreference() {
Robert Greenwaltd19c41c2014-05-18 23:07:25 -0700892 return TYPE_NONE;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800893 }
894
Scott Main671644c2011-10-06 19:02:28 -0700895 /**
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800896 * Returns details about the currently active default data network. When
897 * connected, this network is the default route for outgoing connections.
898 * You should always check {@link NetworkInfo#isConnected()} before initiating
899 * network traffic. This may return {@code null} when there is no default
900 * network.
Chalard Jean5a041d12018-03-29 17:45:24 +0900901 * Note that if the default network is a VPN, this method will return the
902 * NetworkInfo for one of its underlying networks instead, or null if the
903 * VPN agent did not specify any. Apps interested in learning about VPNs
904 * should use {@link #getNetworkInfo(android.net.Network)} instead.
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800905 *
906 * @return a {@link NetworkInfo} object for the current default network
Paul Jensen0d719ca2015-02-13 14:18:39 -0500907 * or {@code null} if no default network is currently active
junyulai3822c8a2018-12-13 12:47:51 +0800908 * @deprecated See {@link NetworkInfo}.
Jeff Sharkey9f7cbf02012-04-12 18:34:54 -0700909 */
junyulai3822c8a2018-12-13 12:47:51 +0800910 @Deprecated
Jeff Sharkey30e06bb2017-04-24 11:18:03 -0600911 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800912 public NetworkInfo getActiveNetworkInfo() {
913 try {
914 return mService.getActiveNetworkInfo();
915 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -0700916 throw e.rethrowFromSystemServer();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800917 }
918 }
919
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -0800920 /**
Paul Jensen31a94f42015-02-13 14:18:39 -0500921 * Returns a {@link Network} object corresponding to the currently active
922 * default data network. In the event that the current active default data
923 * network disconnects, the returned {@code Network} object will no longer
924 * be usable. This will return {@code null} when there is no default
925 * network.
926 *
927 * @return a {@link Network} object for the current default network or
928 * {@code null} if no default network is currently active
Paul Jensen31a94f42015-02-13 14:18:39 -0500929 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -0600930 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Paul Jensen31a94f42015-02-13 14:18:39 -0500931 public Network getActiveNetwork() {
932 try {
933 return mService.getActiveNetwork();
934 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -0700935 throw e.rethrowFromSystemServer();
Paul Jensen31a94f42015-02-13 14:18:39 -0500936 }
937 }
938
939 /**
Robin Leed2baf792016-03-24 12:07:00 +0000940 * Returns a {@link Network} object corresponding to the currently active
941 * default data network for a specific UID. In the event that the default data
942 * network disconnects, the returned {@code Network} object will no longer
943 * be usable. This will return {@code null} when there is no default
944 * network for the UID.
Robin Leed2baf792016-03-24 12:07:00 +0000945 *
946 * @return a {@link Network} object for the current default network for the
947 * given UID or {@code null} if no default network is currently active
948 *
949 * @hide
950 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -0600951 @RequiresPermission(android.Manifest.permission.CONNECTIVITY_INTERNAL)
Robin Leed2baf792016-03-24 12:07:00 +0000952 public Network getActiveNetworkForUid(int uid) {
Jeff Sharkey1b6519b2016-04-28 15:33:18 -0600953 return getActiveNetworkForUid(uid, false);
954 }
955
956 /** {@hide} */
957 public Network getActiveNetworkForUid(int uid, boolean ignoreBlocked) {
Robin Leed2baf792016-03-24 12:07:00 +0000958 try {
Jeff Sharkey1b6519b2016-04-28 15:33:18 -0600959 return mService.getActiveNetworkForUid(uid, ignoreBlocked);
Robin Leed2baf792016-03-24 12:07:00 +0000960 } catch (RemoteException e) {
961 throw e.rethrowFromSystemServer();
962 }
963 }
964
965 /**
Charles He36738632017-05-15 17:07:18 +0100966 * Checks if a VPN app supports always-on mode.
967 *
968 * In order to support the always-on feature, an app has to
969 * <ul>
970 * <li>target {@link VERSION_CODES#N API 24} or above, and
Charles Hec57a01c2017-08-15 15:30:22 +0100971 * <li>not opt out through the {@link VpnService#SERVICE_META_DATA_SUPPORTS_ALWAYS_ON}
972 * meta-data field.
Charles He36738632017-05-15 17:07:18 +0100973 * </ul>
974 *
975 * @param userId The identifier of the user for whom the VPN app is installed.
976 * @param vpnPackage The canonical package name of the VPN app.
977 * @return {@code true} if and only if the VPN app exists and supports always-on mode.
978 * @hide
979 */
980 public boolean isAlwaysOnVpnPackageSupportedForUser(int userId, @Nullable String vpnPackage) {
981 try {
982 return mService.isAlwaysOnVpnPackageSupported(userId, vpnPackage);
983 } catch (RemoteException e) {
984 throw e.rethrowFromSystemServer();
985 }
986 }
987
988 /**
Robin Lee244ce8e2016-01-05 18:03:46 +0000989 * Configures an always-on VPN connection through a specific application.
990 * This connection is automatically granted and persisted after a reboot.
991 *
992 * <p>The designated package should declare a {@link VpnService} in its
993 * manifest guarded by {@link android.Manifest.permission.BIND_VPN_SERVICE},
994 * otherwise the call will fail.
995 *
996 * @param userId The identifier of the user to set an always-on VPN for.
997 * @param vpnPackage The package name for an installed VPN app on the device, or {@code null}
998 * to remove an existing always-on VPN configuration.
Robin Leedc679712016-05-03 13:23:03 +0100999 * @param lockdownEnabled {@code true} to disallow networking when the VPN is not connected or
1000 * {@code false} otherwise.
Robin Lee244ce8e2016-01-05 18:03:46 +00001001 * @return {@code true} if the package is set as always-on VPN controller;
1002 * {@code false} otherwise.
1003 * @hide
1004 */
Robin Leedc679712016-05-03 13:23:03 +01001005 public boolean setAlwaysOnVpnPackageForUser(int userId, @Nullable String vpnPackage,
1006 boolean lockdownEnabled) {
Robin Lee244ce8e2016-01-05 18:03:46 +00001007 try {
Robin Leedc679712016-05-03 13:23:03 +01001008 return mService.setAlwaysOnVpnPackage(userId, vpnPackage, lockdownEnabled);
Robin Lee244ce8e2016-01-05 18:03:46 +00001009 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07001010 throw e.rethrowFromSystemServer();
Robin Lee244ce8e2016-01-05 18:03:46 +00001011 }
1012 }
1013
1014 /**
1015 * Returns the package name of the currently set always-on VPN application.
1016 * If there is no always-on VPN set, or the VPN is provided by the system instead
1017 * of by an app, {@code null} will be returned.
1018 *
1019 * @return Package name of VPN controller responsible for always-on VPN,
1020 * or {@code null} if none is set.
1021 * @hide
1022 */
1023 public String getAlwaysOnVpnPackageForUser(int userId) {
1024 try {
1025 return mService.getAlwaysOnVpnPackage(userId);
1026 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07001027 throw e.rethrowFromSystemServer();
Robin Lee244ce8e2016-01-05 18:03:46 +00001028 }
1029 }
1030
1031 /**
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08001032 * Returns details about the currently active default data network
1033 * for a given uid. This is for internal use only to avoid spying
1034 * other apps.
1035 *
1036 * @return a {@link NetworkInfo} object for the current default network
1037 * for the given uid or {@code null} if no default network is
1038 * available for the specified uid.
1039 *
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08001040 * {@hide}
1041 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06001042 @RequiresPermission(android.Manifest.permission.CONNECTIVITY_INTERNAL)
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01001043 @UnsupportedAppUsage
Jeff Sharkeyc006f1a2011-05-19 17:12:49 -07001044 public NetworkInfo getActiveNetworkInfoForUid(int uid) {
Jeff Sharkey1b6519b2016-04-28 15:33:18 -06001045 return getActiveNetworkInfoForUid(uid, false);
1046 }
1047
1048 /** {@hide} */
1049 public NetworkInfo getActiveNetworkInfoForUid(int uid, boolean ignoreBlocked) {
Jeff Sharkeyc006f1a2011-05-19 17:12:49 -07001050 try {
Jeff Sharkey1b6519b2016-04-28 15:33:18 -06001051 return mService.getActiveNetworkInfoForUid(uid, ignoreBlocked);
Jeff Sharkeyc006f1a2011-05-19 17:12:49 -07001052 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07001053 throw e.rethrowFromSystemServer();
Jeff Sharkeyc006f1a2011-05-19 17:12:49 -07001054 }
1055 }
1056
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08001057 /**
1058 * Returns connection status information about a particular
1059 * network type.
1060 *
1061 * @param networkType integer specifying which networkType in
1062 * which you're interested.
1063 * @return a {@link NetworkInfo} object for the requested
1064 * network type or {@code null} if the type is not
Chalard Jean5a041d12018-03-29 17:45:24 +09001065 * supported by the device. If {@code networkType} is
1066 * TYPE_VPN and a VPN is active for the calling app,
1067 * then this method will try to return one of the
1068 * underlying networks for the VPN or null if the
1069 * VPN agent didn't specify any.
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08001070 *
Paul Jensen3541e9f2015-03-18 12:23:02 -04001071 * @deprecated This method does not support multiple connected networks
1072 * of the same type. Use {@link #getAllNetworks} and
1073 * {@link #getNetworkInfo(android.net.Network)} instead.
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08001074 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07001075 @Deprecated
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06001076 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001077 public NetworkInfo getNetworkInfo(int networkType) {
1078 try {
1079 return mService.getNetworkInfo(networkType);
1080 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07001081 throw e.rethrowFromSystemServer();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001082 }
1083 }
1084
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08001085 /**
Robert Greenwalt73b6cbae2014-06-23 11:40:00 -07001086 * Returns connection status information about a particular
1087 * Network.
1088 *
1089 * @param network {@link Network} specifying which network
1090 * in which you're interested.
1091 * @return a {@link NetworkInfo} object for the requested
1092 * network or {@code null} if the {@code Network}
1093 * is not valid.
junyulai3822c8a2018-12-13 12:47:51 +08001094 * @deprecated See {@link NetworkInfo}.
Robert Greenwalt73b6cbae2014-06-23 11:40:00 -07001095 */
junyulai3822c8a2018-12-13 12:47:51 +08001096 @Deprecated
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06001097 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Robert Greenwalt73b6cbae2014-06-23 11:40:00 -07001098 public NetworkInfo getNetworkInfo(Network network) {
Jeff Sharkey1b6519b2016-04-28 15:33:18 -06001099 return getNetworkInfoForUid(network, Process.myUid(), false);
1100 }
1101
1102 /** {@hide} */
1103 public NetworkInfo getNetworkInfoForUid(Network network, int uid, boolean ignoreBlocked) {
Robert Greenwalt73b6cbae2014-06-23 11:40:00 -07001104 try {
Jeff Sharkey1b6519b2016-04-28 15:33:18 -06001105 return mService.getNetworkInfoForUid(network, uid, ignoreBlocked);
Robert Greenwalt73b6cbae2014-06-23 11:40:00 -07001106 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07001107 throw e.rethrowFromSystemServer();
Robert Greenwalt73b6cbae2014-06-23 11:40:00 -07001108 }
1109 }
1110
1111 /**
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08001112 * Returns connection status information about all network
1113 * types supported by the device.
1114 *
1115 * @return an array of {@link NetworkInfo} objects. Check each
1116 * {@link NetworkInfo#getType} for which type each applies.
1117 *
Paul Jensen3541e9f2015-03-18 12:23:02 -04001118 * @deprecated This method does not support multiple connected networks
1119 * of the same type. Use {@link #getAllNetworks} and
1120 * {@link #getNetworkInfo(android.net.Network)} instead.
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08001121 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07001122 @Deprecated
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06001123 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001124 public NetworkInfo[] getAllNetworkInfo() {
1125 try {
1126 return mService.getAllNetworkInfo();
1127 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07001128 throw e.rethrowFromSystemServer();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001129 }
1130 }
1131
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08001132 /**
Lorenzo Colittib57edc52014-08-22 17:10:50 -07001133 * Returns the {@link Network} object currently serving a given type, or
1134 * null if the given type is not connected.
1135 *
Lorenzo Colittib57edc52014-08-22 17:10:50 -07001136 * @hide
Paul Jensen3541e9f2015-03-18 12:23:02 -04001137 * @deprecated This method does not support multiple connected networks
1138 * of the same type. Use {@link #getAllNetworks} and
1139 * {@link #getNetworkInfo(android.net.Network)} instead.
Lorenzo Colittib57edc52014-08-22 17:10:50 -07001140 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07001141 @Deprecated
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06001142 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01001143 @UnsupportedAppUsage
Lorenzo Colittib57edc52014-08-22 17:10:50 -07001144 public Network getNetworkForType(int networkType) {
1145 try {
1146 return mService.getNetworkForType(networkType);
1147 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07001148 throw e.rethrowFromSystemServer();
Lorenzo Colittib57edc52014-08-22 17:10:50 -07001149 }
1150 }
1151
1152 /**
Robert Greenwalt73b6cbae2014-06-23 11:40:00 -07001153 * Returns an array of all {@link Network} currently tracked by the
1154 * framework.
Paul Jensenb2748922015-05-06 11:10:18 -04001155 *
1156 * @return an array of {@link Network} objects.
Robert Greenwalt73b6cbae2014-06-23 11:40:00 -07001157 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06001158 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Robert Greenwalt73b6cbae2014-06-23 11:40:00 -07001159 public Network[] getAllNetworks() {
1160 try {
1161 return mService.getAllNetworks();
1162 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07001163 throw e.rethrowFromSystemServer();
Robert Greenwalt73b6cbae2014-06-23 11:40:00 -07001164 }
1165 }
1166
1167 /**
Lorenzo Colittie285b432015-04-23 15:32:42 +09001168 * Returns an array of {@link android.net.NetworkCapabilities} objects, representing
Lorenzo Colitti403aa262014-11-28 11:21:30 +09001169 * the Networks that applications run by the given user will use by default.
1170 * @hide
1171 */
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01001172 @UnsupportedAppUsage
Lorenzo Colitti403aa262014-11-28 11:21:30 +09001173 public NetworkCapabilities[] getDefaultNetworkCapabilitiesForUser(int userId) {
1174 try {
1175 return mService.getDefaultNetworkCapabilitiesForUser(userId);
1176 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07001177 throw e.rethrowFromSystemServer();
Lorenzo Colitti403aa262014-11-28 11:21:30 +09001178 }
1179 }
1180
1181 /**
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08001182 * Returns the IP information for the current default network.
1183 *
1184 * @return a {@link LinkProperties} object describing the IP info
1185 * for the current default network, or {@code null} if there
1186 * is no current default network.
1187 *
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08001188 * {@hide}
1189 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06001190 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01001191 @UnsupportedAppUsage
Robert Greenwaltd192dad2010-09-14 09:18:02 -07001192 public LinkProperties getActiveLinkProperties() {
1193 try {
1194 return mService.getActiveLinkProperties();
1195 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07001196 throw e.rethrowFromSystemServer();
Robert Greenwaltd192dad2010-09-14 09:18:02 -07001197 }
1198 }
1199
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08001200 /**
1201 * Returns the IP information for a given network type.
1202 *
1203 * @param networkType the network type of interest.
1204 * @return a {@link LinkProperties} object describing the IP info
1205 * for the given networkType, or {@code null} if there is
1206 * no current default network.
1207 *
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08001208 * {@hide}
Paul Jensen3541e9f2015-03-18 12:23:02 -04001209 * @deprecated This method does not support multiple connected networks
1210 * of the same type. Use {@link #getAllNetworks},
1211 * {@link #getNetworkInfo(android.net.Network)}, and
1212 * {@link #getLinkProperties(android.net.Network)} instead.
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08001213 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07001214 @Deprecated
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06001215 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01001216 @UnsupportedAppUsage
Robert Greenwaltd192dad2010-09-14 09:18:02 -07001217 public LinkProperties getLinkProperties(int networkType) {
1218 try {
Robert Greenwalt9258c642014-03-26 16:47:06 -07001219 return mService.getLinkPropertiesForType(networkType);
1220 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07001221 throw e.rethrowFromSystemServer();
Robert Greenwalt9258c642014-03-26 16:47:06 -07001222 }
1223 }
1224
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07001225 /**
1226 * Get the {@link LinkProperties} for the given {@link Network}. This
1227 * will return {@code null} if the network is unknown.
1228 *
1229 * @param network The {@link Network} object identifying the network in question.
1230 * @return The {@link LinkProperties} for the network, or {@code null}.
Paul Jensenb2748922015-05-06 11:10:18 -04001231 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06001232 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Robert Greenwalt9258c642014-03-26 16:47:06 -07001233 public LinkProperties getLinkProperties(Network network) {
1234 try {
1235 return mService.getLinkProperties(network);
1236 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07001237 throw e.rethrowFromSystemServer();
Robert Greenwalt9258c642014-03-26 16:47:06 -07001238 }
1239 }
1240
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07001241 /**
Lorenzo Colittie285b432015-04-23 15:32:42 +09001242 * Get the {@link android.net.NetworkCapabilities} for the given {@link Network}. This
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07001243 * will return {@code null} if the network is unknown.
1244 *
1245 * @param network The {@link Network} object identifying the network in question.
Lorenzo Colittie285b432015-04-23 15:32:42 +09001246 * @return The {@link android.net.NetworkCapabilities} for the network, or {@code null}.
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07001247 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06001248 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Robert Greenwalt9258c642014-03-26 16:47:06 -07001249 public NetworkCapabilities getNetworkCapabilities(Network network) {
1250 try {
1251 return mService.getNetworkCapabilities(network);
Robert Greenwaltd192dad2010-09-14 09:18:02 -07001252 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07001253 throw e.rethrowFromSystemServer();
Robert Greenwaltd192dad2010-09-14 09:18:02 -07001254 }
1255 }
1256
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08001257 /**
Udam Sainib7c24872016-01-04 12:16:14 -08001258 * Gets the URL that should be used for resolving whether a captive portal is present.
1259 * 1. This URL should respond with a 204 response to a GET request to indicate no captive
1260 * portal is present.
1261 * 2. This URL must be HTTP as redirect responses are used to find captive portal
1262 * sign-in pages. Captive portals cannot respond to HTTPS requests with redirects.
1263 *
1264 * @hide
1265 */
1266 @SystemApi
Udam Saini0e94c362017-06-07 12:06:28 -07001267 @RequiresPermission(android.Manifest.permission.LOCAL_MAC_ADDRESS)
Udam Sainib7c24872016-01-04 12:16:14 -08001268 public String getCaptivePortalServerUrl() {
1269 try {
1270 return mService.getCaptivePortalServerUrl();
1271 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07001272 throw e.rethrowFromSystemServer();
Udam Sainib7c24872016-01-04 12:16:14 -08001273 }
1274 }
1275
1276 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001277 * Tells the underlying networking system that the caller wants to
1278 * begin using the named feature. The interpretation of {@code feature}
1279 * is completely up to each networking implementation.
Lorenzo Colittid5427052015-10-15 16:29:00 +09001280 *
1281 * <p>This method requires the caller to hold either the
1282 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
1283 * or the ability to modify system settings as determined by
1284 * {@link android.provider.Settings.System#canWrite}.</p>
1285 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001286 * @param networkType specifies which network the request pertains to
1287 * @param feature the name of the feature to be used
1288 * @return an integer value representing the outcome of the request.
1289 * The interpretation of this value is specific to each networking
1290 * implementation+feature combination, except that the value {@code -1}
1291 * always indicates failure.
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07001292 *
Lorenzo Colitti2ea89e52015-04-24 17:03:31 +09001293 * @deprecated Deprecated in favor of the cleaner
1294 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} API.
Dianne Hackborn692a2442015-07-31 10:35:34 -07001295 * In {@link VERSION_CODES#M}, and above, this method is unsupported and will
Lorenzo Colittiffc42b02015-07-29 11:41:21 +09001296 * throw {@code UnsupportedOperationException} if called.
Lorenzo Colitti2187df72016-12-09 18:39:30 +09001297 * @removed
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001298 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07001299 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001300 public int startUsingNetworkFeature(int networkType, String feature) {
Lorenzo Colittiffc42b02015-07-29 11:41:21 +09001301 checkLegacyRoutingApiAccess();
Robert Greenwalt562cc542014-05-15 18:07:26 -07001302 NetworkCapabilities netCap = networkCapabilitiesForFeature(networkType, feature);
1303 if (netCap == null) {
1304 Log.d(TAG, "Can't satisfy startUsingNetworkFeature for " + networkType + ", " +
1305 feature);
1306 return PhoneConstants.APN_REQUEST_FAILED;
1307 }
1308
1309 NetworkRequest request = null;
1310 synchronized (sLegacyRequests) {
1311 LegacyRequest l = sLegacyRequests.get(netCap);
1312 if (l != null) {
1313 Log.d(TAG, "renewing startUsingNetworkFeature request " + l.networkRequest);
1314 renewRequestLocked(l);
1315 if (l.currentNetwork != null) {
1316 return PhoneConstants.APN_ALREADY_ACTIVE;
1317 } else {
1318 return PhoneConstants.APN_REQUEST_STARTED;
1319 }
1320 }
1321
1322 request = requestNetworkForFeatureLocked(netCap);
1323 }
1324 if (request != null) {
Robert Greenwalt257ee5f2014-06-20 10:58:45 -07001325 Log.d(TAG, "starting startUsingNetworkFeature for request " + request);
Robert Greenwalt562cc542014-05-15 18:07:26 -07001326 return PhoneConstants.APN_REQUEST_STARTED;
1327 } else {
1328 Log.d(TAG, " request Failed");
1329 return PhoneConstants.APN_REQUEST_FAILED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001330 }
1331 }
1332
1333 /**
1334 * Tells the underlying networking system that the caller is finished
1335 * using the named feature. The interpretation of {@code feature}
1336 * is completely up to each networking implementation.
Lorenzo Colittid5427052015-10-15 16:29:00 +09001337 *
1338 * <p>This method requires the caller to hold either the
1339 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
1340 * or the ability to modify system settings as determined by
1341 * {@link android.provider.Settings.System#canWrite}.</p>
1342 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001343 * @param networkType specifies which network the request pertains to
1344 * @param feature the name of the feature that is no longer needed
1345 * @return an integer value representing the outcome of the request.
1346 * The interpretation of this value is specific to each networking
1347 * implementation+feature combination, except that the value {@code -1}
1348 * always indicates failure.
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07001349 *
Lorenzo Colitti88bc0bb2016-04-13 22:00:02 +09001350 * @deprecated Deprecated in favor of the cleaner
1351 * {@link #unregisterNetworkCallback(NetworkCallback)} API.
Dianne Hackborn692a2442015-07-31 10:35:34 -07001352 * In {@link VERSION_CODES#M}, and above, this method is unsupported and will
Lorenzo Colittiffc42b02015-07-29 11:41:21 +09001353 * throw {@code UnsupportedOperationException} if called.
Lorenzo Colitti2187df72016-12-09 18:39:30 +09001354 * @removed
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001355 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07001356 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001357 public int stopUsingNetworkFeature(int networkType, String feature) {
Lorenzo Colittiffc42b02015-07-29 11:41:21 +09001358 checkLegacyRoutingApiAccess();
Robert Greenwalt562cc542014-05-15 18:07:26 -07001359 NetworkCapabilities netCap = networkCapabilitiesForFeature(networkType, feature);
1360 if (netCap == null) {
1361 Log.d(TAG, "Can't satisfy stopUsingNetworkFeature for " + networkType + ", " +
1362 feature);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001363 return -1;
1364 }
Robert Greenwalt562cc542014-05-15 18:07:26 -07001365
Paul Jensen9ffb53c2014-12-17 10:39:34 -05001366 if (removeRequestForFeature(netCap)) {
Robert Greenwalt562cc542014-05-15 18:07:26 -07001367 Log.d(TAG, "stopUsingNetworkFeature for " + networkType + ", " + feature);
Robert Greenwalt562cc542014-05-15 18:07:26 -07001368 }
1369 return 1;
1370 }
1371
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01001372 @UnsupportedAppUsage
Robert Greenwalt562cc542014-05-15 18:07:26 -07001373 private NetworkCapabilities networkCapabilitiesForFeature(int networkType, String feature) {
1374 if (networkType == TYPE_MOBILE) {
Erik Kline35bf06c2017-01-26 18:08:28 +09001375 switch (feature) {
1376 case "enableCBS":
1377 return networkCapabilitiesForType(TYPE_MOBILE_CBS);
1378 case "enableDUN":
1379 case "enableDUNAlways":
1380 return networkCapabilitiesForType(TYPE_MOBILE_DUN);
1381 case "enableFOTA":
1382 return networkCapabilitiesForType(TYPE_MOBILE_FOTA);
1383 case "enableHIPRI":
1384 return networkCapabilitiesForType(TYPE_MOBILE_HIPRI);
1385 case "enableIMS":
1386 return networkCapabilitiesForType(TYPE_MOBILE_IMS);
1387 case "enableMMS":
1388 return networkCapabilitiesForType(TYPE_MOBILE_MMS);
1389 case "enableSUPL":
1390 return networkCapabilitiesForType(TYPE_MOBILE_SUPL);
1391 default:
1392 return null;
Robert Greenwalt562cc542014-05-15 18:07:26 -07001393 }
Erik Kline35bf06c2017-01-26 18:08:28 +09001394 } else if (networkType == TYPE_WIFI && "p2p".equals(feature)) {
1395 return networkCapabilitiesForType(TYPE_WIFI_P2P);
Robert Greenwalt562cc542014-05-15 18:07:26 -07001396 }
1397 return null;
1398 }
1399
Robert Greenwalt06314e42014-10-29 14:04:06 -07001400 /**
1401 * Guess what the network request was trying to say so that the resulting
1402 * network is accessible via the legacy (deprecated) API such as
1403 * requestRouteToHost.
Lorenzo Colittidef4cb02015-11-25 20:28:50 +09001404 *
1405 * This means we should try to be fairly precise about transport and
Robert Greenwalt06314e42014-10-29 14:04:06 -07001406 * capability but ignore things such as networkSpecifier.
1407 * If the request has more than one transport or capability it doesn't
1408 * match the old legacy requests (they selected only single transport/capability)
1409 * so this function cannot map the request to a single legacy type and
1410 * the resulting network will not be available to the legacy APIs.
1411 *
Lorenzo Colittidef4cb02015-11-25 20:28:50 +09001412 * This code is only called from the requestNetwork API (L and above).
1413 *
1414 * Setting a legacy type causes CONNECTIVITY_ACTION broadcasts, which are expensive
1415 * because they wake up lots of apps - see http://b/23350688 . So we currently only
1416 * do this for SUPL requests, which are the only ones that we know need it. If
1417 * omitting these broadcasts causes unacceptable app breakage, then for backwards
1418 * compatibility we can send them:
1419 *
1420 * if (targetSdkVersion < Build.VERSION_CODES.M) && // legacy API unsupported >= M
1421 * targetSdkVersion >= Build.VERSION_CODES.LOLLIPOP)) // requestNetwork not present < L
1422 *
Robert Greenwalt06314e42014-10-29 14:04:06 -07001423 * TODO - This should be removed when the legacy APIs are removed.
1424 */
Ye Wenb87875e2014-07-21 14:19:01 -07001425 private int inferLegacyTypeForNetworkCapabilities(NetworkCapabilities netCap) {
1426 if (netCap == null) {
1427 return TYPE_NONE;
1428 }
Robert Greenwalt06314e42014-10-29 14:04:06 -07001429
Ye Wenb87875e2014-07-21 14:19:01 -07001430 if (!netCap.hasTransport(NetworkCapabilities.TRANSPORT_CELLULAR)) {
1431 return TYPE_NONE;
1432 }
Robert Greenwalt06314e42014-10-29 14:04:06 -07001433
Lifu Tang30f95a72016-01-07 23:20:38 -08001434 // Do this only for SUPL, until GnssLocationProvider is fixed. http://b/25876485 .
Lorenzo Colittidef4cb02015-11-25 20:28:50 +09001435 if (!netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_SUPL)) {
1436 // NOTE: if this causes app breakage, we should not just comment out this early return;
1437 // instead, we should make this early return conditional on the requesting app's target
1438 // SDK version, as described in the comment above.
1439 return TYPE_NONE;
1440 }
1441
Robert Greenwalt06314e42014-10-29 14:04:06 -07001442 String type = null;
1443 int result = TYPE_NONE;
1444
Ye Wenb87875e2014-07-21 14:19:01 -07001445 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_CBS)) {
Robert Greenwalt06314e42014-10-29 14:04:06 -07001446 type = "enableCBS";
1447 result = TYPE_MOBILE_CBS;
1448 } else if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_IMS)) {
1449 type = "enableIMS";
1450 result = TYPE_MOBILE_IMS;
1451 } else if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_FOTA)) {
1452 type = "enableFOTA";
1453 result = TYPE_MOBILE_FOTA;
1454 } else if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_DUN)) {
1455 type = "enableDUN";
1456 result = TYPE_MOBILE_DUN;
1457 } else if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_SUPL)) {
Lorenzo Colittidef4cb02015-11-25 20:28:50 +09001458 type = "enableSUPL";
Robert Greenwalt06314e42014-10-29 14:04:06 -07001459 result = TYPE_MOBILE_SUPL;
Robert Greenwalt74ab4fa2015-08-28 12:37:54 -07001460 // back out this hack for mms as they no longer need this and it's causing
1461 // device slowdowns - b/23350688 (note, supl still needs this)
1462 //} else if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_MMS)) {
1463 // type = "enableMMS";
1464 // result = TYPE_MOBILE_MMS;
Robert Greenwalt06314e42014-10-29 14:04:06 -07001465 } else if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_INTERNET)) {
1466 type = "enableHIPRI";
1467 result = TYPE_MOBILE_HIPRI;
Ye Wenb87875e2014-07-21 14:19:01 -07001468 }
Robert Greenwalt06314e42014-10-29 14:04:06 -07001469 if (type != null) {
1470 NetworkCapabilities testCap = networkCapabilitiesForFeature(TYPE_MOBILE, type);
1471 if (testCap.equalsNetCapabilities(netCap) && testCap.equalsTransportTypes(netCap)) {
1472 return result;
Ye Wenb87875e2014-07-21 14:19:01 -07001473 }
1474 }
1475 return TYPE_NONE;
1476 }
1477
Robert Greenwalt32aa65a2014-06-02 15:32:02 -07001478 private int legacyTypeForNetworkCapabilities(NetworkCapabilities netCap) {
Robert Greenwalt562cc542014-05-15 18:07:26 -07001479 if (netCap == null) return TYPE_NONE;
1480 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_CBS)) {
1481 return TYPE_MOBILE_CBS;
1482 }
1483 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_IMS)) {
1484 return TYPE_MOBILE_IMS;
1485 }
1486 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_FOTA)) {
1487 return TYPE_MOBILE_FOTA;
1488 }
1489 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_DUN)) {
1490 return TYPE_MOBILE_DUN;
1491 }
1492 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_SUPL)) {
1493 return TYPE_MOBILE_SUPL;
1494 }
1495 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_MMS)) {
1496 return TYPE_MOBILE_MMS;
1497 }
1498 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_INTERNET)) {
1499 return TYPE_MOBILE_HIPRI;
1500 }
Robert Greenwalt32aa65a2014-06-02 15:32:02 -07001501 if (netCap.hasCapability(NetworkCapabilities.NET_CAPABILITY_WIFI_P2P)) {
1502 return TYPE_WIFI_P2P;
1503 }
Robert Greenwalt562cc542014-05-15 18:07:26 -07001504 return TYPE_NONE;
1505 }
1506
1507 private static class LegacyRequest {
1508 NetworkCapabilities networkCapabilities;
1509 NetworkRequest networkRequest;
1510 int expireSequenceNumber;
1511 Network currentNetwork;
1512 int delay = -1;
Paul Jensen9ffb53c2014-12-17 10:39:34 -05001513
1514 private void clearDnsBinding() {
1515 if (currentNetwork != null) {
1516 currentNetwork = null;
1517 setProcessDefaultNetworkForHostResolution(null);
1518 }
1519 }
1520
Robert Greenwalt6078b502014-06-11 16:05:07 -07001521 NetworkCallback networkCallback = new NetworkCallback() {
Robert Greenwalt562cc542014-05-15 18:07:26 -07001522 @Override
Robert Greenwalt6078b502014-06-11 16:05:07 -07001523 public void onAvailable(Network network) {
Robert Greenwalt562cc542014-05-15 18:07:26 -07001524 currentNetwork = network;
1525 Log.d(TAG, "startUsingNetworkFeature got Network:" + network);
Paul Jensen6d3ff9e2014-05-29 10:12:39 -04001526 setProcessDefaultNetworkForHostResolution(network);
Robert Greenwalt562cc542014-05-15 18:07:26 -07001527 }
1528 @Override
Robert Greenwalt6078b502014-06-11 16:05:07 -07001529 public void onLost(Network network) {
Paul Jensen9ffb53c2014-12-17 10:39:34 -05001530 if (network.equals(currentNetwork)) clearDnsBinding();
Robert Greenwalt562cc542014-05-15 18:07:26 -07001531 Log.d(TAG, "startUsingNetworkFeature lost Network:" + network);
1532 }
1533 };
1534 }
1535
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01001536 @UnsupportedAppUsage
Chalard Jean4d660112018-06-04 16:52:49 +09001537 private static final HashMap<NetworkCapabilities, LegacyRequest> sLegacyRequests =
1538 new HashMap<>();
Robert Greenwalt562cc542014-05-15 18:07:26 -07001539
1540 private NetworkRequest findRequestForFeature(NetworkCapabilities netCap) {
1541 synchronized (sLegacyRequests) {
1542 LegacyRequest l = sLegacyRequests.get(netCap);
1543 if (l != null) return l.networkRequest;
1544 }
1545 return null;
1546 }
1547
1548 private void renewRequestLocked(LegacyRequest l) {
1549 l.expireSequenceNumber++;
1550 Log.d(TAG, "renewing request to seqNum " + l.expireSequenceNumber);
1551 sendExpireMsgForFeature(l.networkCapabilities, l.expireSequenceNumber, l.delay);
1552 }
1553
1554 private void expireRequest(NetworkCapabilities netCap, int sequenceNum) {
1555 int ourSeqNum = -1;
1556 synchronized (sLegacyRequests) {
1557 LegacyRequest l = sLegacyRequests.get(netCap);
1558 if (l == null) return;
1559 ourSeqNum = l.expireSequenceNumber;
Paul Jensen9ffb53c2014-12-17 10:39:34 -05001560 if (l.expireSequenceNumber == sequenceNum) removeRequestForFeature(netCap);
Robert Greenwalt562cc542014-05-15 18:07:26 -07001561 }
1562 Log.d(TAG, "expireRequest with " + ourSeqNum + ", " + sequenceNum);
1563 }
1564
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01001565 @UnsupportedAppUsage
Robert Greenwalt562cc542014-05-15 18:07:26 -07001566 private NetworkRequest requestNetworkForFeatureLocked(NetworkCapabilities netCap) {
1567 int delay = -1;
Robert Greenwalt32aa65a2014-06-02 15:32:02 -07001568 int type = legacyTypeForNetworkCapabilities(netCap);
Robert Greenwalt562cc542014-05-15 18:07:26 -07001569 try {
1570 delay = mService.getRestoreDefaultNetworkDelay(type);
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07001571 } catch (RemoteException e) {
1572 throw e.rethrowFromSystemServer();
1573 }
Robert Greenwalt562cc542014-05-15 18:07:26 -07001574 LegacyRequest l = new LegacyRequest();
1575 l.networkCapabilities = netCap;
1576 l.delay = delay;
1577 l.expireSequenceNumber = 0;
Hugo Benichi2583ef02017-02-02 17:02:36 +09001578 l.networkRequest = sendRequestForNetwork(
1579 netCap, l.networkCallback, 0, REQUEST, type, getDefaultHandler());
Robert Greenwalt562cc542014-05-15 18:07:26 -07001580 if (l.networkRequest == null) return null;
1581 sLegacyRequests.put(netCap, l);
1582 sendExpireMsgForFeature(netCap, l.expireSequenceNumber, delay);
1583 return l.networkRequest;
1584 }
1585
1586 private void sendExpireMsgForFeature(NetworkCapabilities netCap, int seqNum, int delay) {
1587 if (delay >= 0) {
1588 Log.d(TAG, "sending expire msg with seqNum " + seqNum + " and delay " + delay);
Hugo Benichi2583ef02017-02-02 17:02:36 +09001589 CallbackHandler handler = getDefaultHandler();
Hugo Benichi6f260f32017-02-03 14:18:44 +09001590 Message msg = handler.obtainMessage(EXPIRE_LEGACY_REQUEST, seqNum, 0, netCap);
1591 handler.sendMessageDelayed(msg, delay);
Robert Greenwalt562cc542014-05-15 18:07:26 -07001592 }
1593 }
1594
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01001595 @UnsupportedAppUsage
Paul Jensen9ffb53c2014-12-17 10:39:34 -05001596 private boolean removeRequestForFeature(NetworkCapabilities netCap) {
1597 final LegacyRequest l;
Robert Greenwalt562cc542014-05-15 18:07:26 -07001598 synchronized (sLegacyRequests) {
Paul Jensen9ffb53c2014-12-17 10:39:34 -05001599 l = sLegacyRequests.remove(netCap);
Robert Greenwalt562cc542014-05-15 18:07:26 -07001600 }
Paul Jensen9ffb53c2014-12-17 10:39:34 -05001601 if (l == null) return false;
1602 unregisterNetworkCallback(l.networkCallback);
1603 l.clearDnsBinding();
1604 return true;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001605 }
1606
Erik Kline35bf06c2017-01-26 18:08:28 +09001607 private static final SparseIntArray sLegacyTypeToTransport = new SparseIntArray();
1608 static {
1609 sLegacyTypeToTransport.put(TYPE_MOBILE, NetworkCapabilities.TRANSPORT_CELLULAR);
1610 sLegacyTypeToTransport.put(TYPE_MOBILE_CBS, NetworkCapabilities.TRANSPORT_CELLULAR);
1611 sLegacyTypeToTransport.put(TYPE_MOBILE_DUN, NetworkCapabilities.TRANSPORT_CELLULAR);
1612 sLegacyTypeToTransport.put(TYPE_MOBILE_FOTA, NetworkCapabilities.TRANSPORT_CELLULAR);
1613 sLegacyTypeToTransport.put(TYPE_MOBILE_HIPRI, NetworkCapabilities.TRANSPORT_CELLULAR);
1614 sLegacyTypeToTransport.put(TYPE_MOBILE_IMS, NetworkCapabilities.TRANSPORT_CELLULAR);
1615 sLegacyTypeToTransport.put(TYPE_MOBILE_MMS, NetworkCapabilities.TRANSPORT_CELLULAR);
1616 sLegacyTypeToTransport.put(TYPE_MOBILE_SUPL, NetworkCapabilities.TRANSPORT_CELLULAR);
1617 sLegacyTypeToTransport.put(TYPE_WIFI, NetworkCapabilities.TRANSPORT_WIFI);
1618 sLegacyTypeToTransport.put(TYPE_WIFI_P2P, NetworkCapabilities.TRANSPORT_WIFI);
1619 sLegacyTypeToTransport.put(TYPE_BLUETOOTH, NetworkCapabilities.TRANSPORT_BLUETOOTH);
1620 sLegacyTypeToTransport.put(TYPE_ETHERNET, NetworkCapabilities.TRANSPORT_ETHERNET);
1621 }
1622
1623 private static final SparseIntArray sLegacyTypeToCapability = new SparseIntArray();
1624 static {
1625 sLegacyTypeToCapability.put(TYPE_MOBILE_CBS, NetworkCapabilities.NET_CAPABILITY_CBS);
1626 sLegacyTypeToCapability.put(TYPE_MOBILE_DUN, NetworkCapabilities.NET_CAPABILITY_DUN);
1627 sLegacyTypeToCapability.put(TYPE_MOBILE_FOTA, NetworkCapabilities.NET_CAPABILITY_FOTA);
1628 sLegacyTypeToCapability.put(TYPE_MOBILE_IMS, NetworkCapabilities.NET_CAPABILITY_IMS);
1629 sLegacyTypeToCapability.put(TYPE_MOBILE_MMS, NetworkCapabilities.NET_CAPABILITY_MMS);
1630 sLegacyTypeToCapability.put(TYPE_MOBILE_SUPL, NetworkCapabilities.NET_CAPABILITY_SUPL);
1631 sLegacyTypeToCapability.put(TYPE_WIFI_P2P, NetworkCapabilities.NET_CAPABILITY_WIFI_P2P);
1632 }
1633
1634 /**
1635 * Given a legacy type (TYPE_WIFI, ...) returns a NetworkCapabilities
1636 * instance suitable for registering a request or callback. Throws an
1637 * IllegalArgumentException if no mapping from the legacy type to
1638 * NetworkCapabilities is known.
1639 *
Chalard Jean6b1da6e2018-03-08 13:54:53 +09001640 * @deprecated Types are deprecated. Use {@link NetworkCallback} or {@link NetworkRequest}
1641 * to find the network instead.
Erik Kline35bf06c2017-01-26 18:08:28 +09001642 * @hide
1643 */
1644 public static NetworkCapabilities networkCapabilitiesForType(int type) {
1645 final NetworkCapabilities nc = new NetworkCapabilities();
1646
1647 // Map from type to transports.
1648 final int NOT_FOUND = -1;
1649 final int transport = sLegacyTypeToTransport.get(type, NOT_FOUND);
Hugo Benichie7678512017-05-09 15:19:01 +09001650 Preconditions.checkArgument(transport != NOT_FOUND, "unknown legacy type: " + type);
Erik Kline35bf06c2017-01-26 18:08:28 +09001651 nc.addTransportType(transport);
1652
1653 // Map from type to capabilities.
1654 nc.addCapability(sLegacyTypeToCapability.get(
1655 type, NetworkCapabilities.NET_CAPABILITY_INTERNET));
1656 nc.maybeMarkCapabilitiesRestricted();
1657 return nc;
1658 }
1659
Lorenzo Colitti8bf977d2015-06-15 14:29:22 +09001660 /** @hide */
1661 public static class PacketKeepaliveCallback {
1662 /** The requested keepalive was successfully started. */
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01001663 @UnsupportedAppUsage
Lorenzo Colitti8bf977d2015-06-15 14:29:22 +09001664 public void onStarted() {}
1665 /** The keepalive was successfully stopped. */
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01001666 @UnsupportedAppUsage
Lorenzo Colitti8bf977d2015-06-15 14:29:22 +09001667 public void onStopped() {}
1668 /** An error occurred. */
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01001669 @UnsupportedAppUsage
Lorenzo Colitti8bf977d2015-06-15 14:29:22 +09001670 public void onError(int error) {}
1671 }
1672
1673 /**
1674 * Allows applications to request that the system periodically send specific packets on their
1675 * behalf, using hardware offload to save battery power.
1676 *
1677 * To request that the system send keepalives, call one of the methods that return a
1678 * {@link ConnectivityManager.PacketKeepalive} object, such as {@link #startNattKeepalive},
1679 * passing in a non-null callback. If the callback is successfully started, the callback's
1680 * {@code onStarted} method will be called. If an error occurs, {@code onError} will be called,
1681 * specifying one of the {@code ERROR_*} constants in this class.
1682 *
Chalard Jean4d660112018-06-04 16:52:49 +09001683 * To stop an existing keepalive, call {@link PacketKeepalive#stop}. The system will call
1684 * {@link PacketKeepaliveCallback#onStopped} if the operation was successful or
1685 * {@link PacketKeepaliveCallback#onError} if an error occurred.
Lorenzo Colitti8bf977d2015-06-15 14:29:22 +09001686 *
1687 * @hide
1688 */
1689 public class PacketKeepalive {
1690
1691 private static final String TAG = "PacketKeepalive";
1692
1693 /** @hide */
1694 public static final int SUCCESS = 0;
1695
1696 /** @hide */
1697 public static final int NO_KEEPALIVE = -1;
1698
1699 /** @hide */
1700 public static final int BINDER_DIED = -10;
1701
1702 /** The specified {@code Network} is not connected. */
1703 public static final int ERROR_INVALID_NETWORK = -20;
1704 /** The specified IP addresses are invalid. For example, the specified source IP address is
1705 * not configured on the specified {@code Network}. */
1706 public static final int ERROR_INVALID_IP_ADDRESS = -21;
1707 /** The requested port is invalid. */
1708 public static final int ERROR_INVALID_PORT = -22;
1709 /** The packet length is invalid (e.g., too long). */
1710 public static final int ERROR_INVALID_LENGTH = -23;
1711 /** The packet transmission interval is invalid (e.g., too short). */
1712 public static final int ERROR_INVALID_INTERVAL = -24;
1713
1714 /** The hardware does not support this request. */
1715 public static final int ERROR_HARDWARE_UNSUPPORTED = -30;
Lorenzo Colitti9d1284e2015-09-08 16:46:36 +09001716 /** The hardware returned an error. */
1717 public static final int ERROR_HARDWARE_ERROR = -31;
Lorenzo Colitti8bf977d2015-06-15 14:29:22 +09001718
Nathan Harold63dd8132018-02-14 13:09:45 -08001719 /** The NAT-T destination port for IPsec */
Lorenzo Colitti8bf977d2015-06-15 14:29:22 +09001720 public static final int NATT_PORT = 4500;
1721
Nathan Harold63dd8132018-02-14 13:09:45 -08001722 /** The minimum interval in seconds between keepalive packet transmissions */
1723 public static final int MIN_INTERVAL = 10;
1724
Lorenzo Colitti8bf977d2015-06-15 14:29:22 +09001725 private final Network mNetwork;
1726 private final PacketKeepaliveCallback mCallback;
1727 private final Looper mLooper;
1728 private final Messenger mMessenger;
1729
1730 private volatile Integer mSlot;
1731
1732 void stopLooper() {
1733 mLooper.quit();
1734 }
1735
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01001736 @UnsupportedAppUsage
Lorenzo Colitti8bf977d2015-06-15 14:29:22 +09001737 public void stop() {
1738 try {
1739 mService.stopKeepalive(mNetwork, mSlot);
1740 } catch (RemoteException e) {
1741 Log.e(TAG, "Error stopping packet keepalive: ", e);
1742 stopLooper();
1743 }
1744 }
1745
1746 private PacketKeepalive(Network network, PacketKeepaliveCallback callback) {
Hugo Benichidafed3d2017-03-06 09:17:06 +09001747 Preconditions.checkNotNull(network, "network cannot be null");
1748 Preconditions.checkNotNull(callback, "callback cannot be null");
Lorenzo Colitti8bf977d2015-06-15 14:29:22 +09001749 mNetwork = network;
1750 mCallback = callback;
1751 HandlerThread thread = new HandlerThread(TAG);
1752 thread.start();
1753 mLooper = thread.getLooper();
1754 mMessenger = new Messenger(new Handler(mLooper) {
1755 @Override
1756 public void handleMessage(Message message) {
1757 switch (message.what) {
1758 case NetworkAgent.EVENT_PACKET_KEEPALIVE:
1759 int error = message.arg2;
1760 try {
1761 if (error == SUCCESS) {
1762 if (mSlot == null) {
1763 mSlot = message.arg1;
1764 mCallback.onStarted();
1765 } else {
1766 mSlot = null;
1767 stopLooper();
1768 mCallback.onStopped();
1769 }
1770 } else {
1771 stopLooper();
1772 mCallback.onError(error);
1773 }
1774 } catch (Exception e) {
1775 Log.e(TAG, "Exception in keepalive callback(" + error + ")", e);
1776 }
1777 break;
1778 default:
1779 Log.e(TAG, "Unhandled message " + Integer.toHexString(message.what));
1780 break;
1781 }
1782 }
1783 });
1784 }
1785 }
1786
1787 /**
1788 * Starts an IPsec NAT-T keepalive packet with the specified parameters.
1789 *
1790 * @hide
1791 */
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01001792 @UnsupportedAppUsage
Lorenzo Colitti8bf977d2015-06-15 14:29:22 +09001793 public PacketKeepalive startNattKeepalive(
1794 Network network, int intervalSeconds, PacketKeepaliveCallback callback,
1795 InetAddress srcAddr, int srcPort, InetAddress dstAddr) {
1796 final PacketKeepalive k = new PacketKeepalive(network, callback);
1797 try {
1798 mService.startNattKeepalive(network, intervalSeconds, k.mMessenger, new Binder(),
1799 srcAddr.getHostAddress(), srcPort, dstAddr.getHostAddress());
1800 } catch (RemoteException e) {
1801 Log.e(TAG, "Error starting packet keepalive: ", e);
1802 k.stopLooper();
1803 return null;
1804 }
1805 return k;
1806 }
1807
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001808 /**
1809 * Ensure that a network route exists to deliver traffic to the specified
1810 * host via the specified network interface. An attempt to add a route that
1811 * already exists is ignored, but treated as successful.
Lorenzo Colittid5427052015-10-15 16:29:00 +09001812 *
1813 * <p>This method requires the caller to hold either the
1814 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
1815 * or the ability to modify system settings as determined by
1816 * {@link android.provider.Settings.System#canWrite}.</p>
1817 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001818 * @param networkType the type of the network over which traffic to the specified
1819 * host is to be routed
1820 * @param hostAddress the IP address of the host to which the route is desired
1821 * @return {@code true} on success, {@code false} on failure
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07001822 *
Lorenzo Colitti2ea89e52015-04-24 17:03:31 +09001823 * @deprecated Deprecated in favor of the
1824 * {@link #requestNetwork(NetworkRequest, NetworkCallback)},
1825 * {@link #bindProcessToNetwork} and {@link Network#getSocketFactory} API.
Dianne Hackborn692a2442015-07-31 10:35:34 -07001826 * In {@link VERSION_CODES#M}, and above, this method is unsupported and will
Lorenzo Colittiffc42b02015-07-29 11:41:21 +09001827 * throw {@code UnsupportedOperationException} if called.
Lorenzo Colitti2187df72016-12-09 18:39:30 +09001828 * @removed
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001829 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07001830 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001831 public boolean requestRouteToHost(int networkType, int hostAddress) {
Sreeram Ramachandran03666c72014-07-19 23:21:46 -07001832 return requestRouteToHostAddress(networkType, NetworkUtils.intToInetAddress(hostAddress));
Robert Greenwalt585ac0f2010-08-27 09:24:29 -07001833 }
1834
1835 /**
1836 * Ensure that a network route exists to deliver traffic to the specified
1837 * host via the specified network interface. An attempt to add a route that
1838 * already exists is ignored, but treated as successful.
Lorenzo Colittid5427052015-10-15 16:29:00 +09001839 *
1840 * <p>This method requires the caller to hold either the
1841 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
1842 * or the ability to modify system settings as determined by
1843 * {@link android.provider.Settings.System#canWrite}.</p>
1844 *
Robert Greenwalt585ac0f2010-08-27 09:24:29 -07001845 * @param networkType the type of the network over which traffic to the specified
1846 * host is to be routed
1847 * @param hostAddress the IP address of the host to which the route is desired
1848 * @return {@code true} on success, {@code false} on failure
1849 * @hide
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07001850 * @deprecated Deprecated in favor of the {@link #requestNetwork} and
Lorenzo Colitti2ea89e52015-04-24 17:03:31 +09001851 * {@link #bindProcessToNetwork} API.
Robert Greenwalt585ac0f2010-08-27 09:24:29 -07001852 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07001853 @Deprecated
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01001854 @UnsupportedAppUsage
Robert Greenwalt585ac0f2010-08-27 09:24:29 -07001855 public boolean requestRouteToHostAddress(int networkType, InetAddress hostAddress) {
Lorenzo Colittiffc42b02015-07-29 11:41:21 +09001856 checkLegacyRoutingApiAccess();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001857 try {
Sreeram Ramachandran03666c72014-07-19 23:21:46 -07001858 return mService.requestRouteToHostAddress(networkType, hostAddress.getAddress());
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001859 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07001860 throw e.rethrowFromSystemServer();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001861 }
1862 }
1863
1864 /**
1865 * Returns the value of the setting for background data usage. If false,
1866 * applications should not use the network if the application is not in the
1867 * foreground. Developers should respect this setting, and check the value
1868 * of this before performing any background data operations.
1869 * <p>
1870 * All applications that have background services that use the network
1871 * should listen to {@link #ACTION_BACKGROUND_DATA_SETTING_CHANGED}.
Jeff Sharkey3a844fc2011-08-16 14:37:57 -07001872 * <p>
Scott Main4cc53332011-10-06 18:32:43 -07001873 * @deprecated As of {@link VERSION_CODES#ICE_CREAM_SANDWICH}, availability of
Jeff Sharkey3a844fc2011-08-16 14:37:57 -07001874 * background data depends on several combined factors, and this method will
1875 * always return {@code true}. Instead, when background data is unavailable,
1876 * {@link #getActiveNetworkInfo()} will now appear disconnected.
Danica Chang6fdd0c62010-08-11 14:54:43 -07001877 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001878 * @return Whether background data usage is allowed.
1879 */
Jeff Sharkey3a844fc2011-08-16 14:37:57 -07001880 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001881 public boolean getBackgroundDataSetting() {
Jeff Sharkey3a844fc2011-08-16 14:37:57 -07001882 // assume that background data is allowed; final authority is
1883 // NetworkInfo which may be blocked.
1884 return true;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001885 }
1886
1887 /**
1888 * Sets the value of the setting for background data usage.
Robert Greenwaltc03fa502010-02-23 18:58:05 -08001889 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001890 * @param allowBackgroundData Whether an application should use data while
1891 * it is in the background.
Robert Greenwaltc03fa502010-02-23 18:58:05 -08001892 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001893 * @attr ref android.Manifest.permission#CHANGE_BACKGROUND_DATA_SETTING
1894 * @see #getBackgroundDataSetting()
1895 * @hide
1896 */
Jeff Sharkey3a844fc2011-08-16 14:37:57 -07001897 @Deprecated
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01001898 @UnsupportedAppUsage
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001899 public void setBackgroundDataSetting(boolean allowBackgroundData) {
Jeff Sharkey3a844fc2011-08-16 14:37:57 -07001900 // ignored
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001901 }
Robert Greenwaltc03fa502010-02-23 18:58:05 -08001902
Jeff Sharkey43d2a172017-07-12 10:50:42 -06001903 /** {@hide} */
1904 @Deprecated
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01001905 @UnsupportedAppUsage
Jeff Sharkeyf0ceede2011-08-02 17:22:34 -07001906 public NetworkQuotaInfo getActiveNetworkQuotaInfo() {
1907 try {
1908 return mService.getActiveNetworkQuotaInfo();
1909 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07001910 throw e.rethrowFromSystemServer();
Jeff Sharkeyf0ceede2011-08-02 17:22:34 -07001911 }
1912 }
1913
1914 /**
Robert Greenwaltc03fa502010-02-23 18:58:05 -08001915 * @hide
Robert Greenwaltafa05c02014-05-21 20:04:36 -07001916 * @deprecated Talk to TelephonyManager directly
Robert Greenwaltc03fa502010-02-23 18:58:05 -08001917 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07001918 @Deprecated
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01001919 @UnsupportedAppUsage
Robert Greenwaltc03fa502010-02-23 18:58:05 -08001920 public boolean getMobileDataEnabled() {
Robert Greenwaltafa05c02014-05-21 20:04:36 -07001921 IBinder b = ServiceManager.getService(Context.TELEPHONY_SERVICE);
1922 if (b != null) {
1923 try {
1924 ITelephony it = ITelephony.Stub.asInterface(b);
Shishir Agrawal7ea3e8b2016-01-25 13:03:07 -08001925 int subId = SubscriptionManager.getDefaultDataSubscriptionId();
Wink Saville36ffb042014-12-05 11:10:30 -08001926 Log.d("ConnectivityManager", "getMobileDataEnabled()+ subId=" + subId);
Malcolm Chenb455e722017-11-28 15:57:14 -08001927 boolean retVal = it.isUserDataEnabled(subId);
Wink Saville36ffb042014-12-05 11:10:30 -08001928 Log.d("ConnectivityManager", "getMobileDataEnabled()- subId=" + subId
1929 + " retVal=" + retVal);
1930 return retVal;
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07001931 } catch (RemoteException e) {
1932 throw e.rethrowFromSystemServer();
1933 }
Robert Greenwaltc03fa502010-02-23 18:58:05 -08001934 }
Wink Saville36ffb042014-12-05 11:10:30 -08001935 Log.d("ConnectivityManager", "getMobileDataEnabled()- remote exception retVal=false");
Robert Greenwaltafa05c02014-05-21 20:04:36 -07001936 return false;
Robert Greenwaltc03fa502010-02-23 18:58:05 -08001937 }
1938
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001939 /**
Robert Greenwaltb2489872014-09-04 16:44:35 -07001940 * Callback for use with {@link ConnectivityManager#addDefaultNetworkActiveListener}
Robert Greenwalt6078b502014-06-11 16:05:07 -07001941 * to find out when the system default network has gone in to a high power state.
Dianne Hackborn77b987f2014-02-26 16:20:52 -08001942 */
1943 public interface OnNetworkActiveListener {
1944 /**
1945 * Called on the main thread of the process to report that the current data network
1946 * has become active, and it is now a good time to perform any pending network
1947 * operations. Note that this listener only tells you when the network becomes
1948 * active; if at any other time you want to know whether it is active (and thus okay
1949 * to initiate network traffic), you can retrieve its instantaneous state with
Robert Greenwalt6078b502014-06-11 16:05:07 -07001950 * {@link ConnectivityManager#isDefaultNetworkActive}.
Dianne Hackborn77b987f2014-02-26 16:20:52 -08001951 */
Chalard Jean4d660112018-06-04 16:52:49 +09001952 void onNetworkActive();
Dianne Hackborn77b987f2014-02-26 16:20:52 -08001953 }
1954
1955 private INetworkManagementService getNetworkManagementService() {
1956 synchronized (this) {
1957 if (mNMService != null) {
1958 return mNMService;
1959 }
1960 IBinder b = ServiceManager.getService(Context.NETWORKMANAGEMENT_SERVICE);
1961 mNMService = INetworkManagementService.Stub.asInterface(b);
1962 return mNMService;
1963 }
1964 }
1965
1966 private final ArrayMap<OnNetworkActiveListener, INetworkActivityListener>
Chalard Jean4d660112018-06-04 16:52:49 +09001967 mNetworkActivityListeners = new ArrayMap<>();
Dianne Hackborn77b987f2014-02-26 16:20:52 -08001968
1969 /**
Robert Greenwalt6078b502014-06-11 16:05:07 -07001970 * Start listening to reports when the system's default data network is active, meaning it is
1971 * a good time to perform network traffic. Use {@link #isDefaultNetworkActive()}
1972 * to determine the current state of the system's default network after registering the
1973 * listener.
1974 * <p>
1975 * If the process default network has been set with
Paul Jensen72db88e2015-03-10 10:54:12 -04001976 * {@link ConnectivityManager#bindProcessToNetwork} this function will not
Robert Greenwalt6078b502014-06-11 16:05:07 -07001977 * reflect the process's default, but the system default.
Dianne Hackborn77b987f2014-02-26 16:20:52 -08001978 *
1979 * @param l The listener to be told when the network is active.
1980 */
Robert Greenwaltb2489872014-09-04 16:44:35 -07001981 public void addDefaultNetworkActiveListener(final OnNetworkActiveListener l) {
Dianne Hackborn77b987f2014-02-26 16:20:52 -08001982 INetworkActivityListener rl = new INetworkActivityListener.Stub() {
1983 @Override
1984 public void onNetworkActive() throws RemoteException {
1985 l.onNetworkActive();
1986 }
1987 };
1988
1989 try {
1990 getNetworkManagementService().registerNetworkActivityListener(rl);
1991 mNetworkActivityListeners.put(l, rl);
1992 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07001993 throw e.rethrowFromSystemServer();
Dianne Hackborn77b987f2014-02-26 16:20:52 -08001994 }
1995 }
1996
1997 /**
1998 * Remove network active listener previously registered with
Robert Greenwaltb2489872014-09-04 16:44:35 -07001999 * {@link #addDefaultNetworkActiveListener}.
Dianne Hackborn77b987f2014-02-26 16:20:52 -08002000 *
2001 * @param l Previously registered listener.
2002 */
Robert Greenwaltb2489872014-09-04 16:44:35 -07002003 public void removeDefaultNetworkActiveListener(OnNetworkActiveListener l) {
Dianne Hackborn77b987f2014-02-26 16:20:52 -08002004 INetworkActivityListener rl = mNetworkActivityListeners.get(l);
Hugo Benichie7678512017-05-09 15:19:01 +09002005 Preconditions.checkArgument(rl != null, "Listener was not registered.");
Dianne Hackborn77b987f2014-02-26 16:20:52 -08002006 try {
2007 getNetworkManagementService().unregisterNetworkActivityListener(rl);
2008 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002009 throw e.rethrowFromSystemServer();
Dianne Hackborn77b987f2014-02-26 16:20:52 -08002010 }
2011 }
2012
2013 /**
2014 * Return whether the data network is currently active. An active network means that
2015 * it is currently in a high power state for performing data transmission. On some
2016 * types of networks, it may be expensive to move and stay in such a state, so it is
2017 * more power efficient to batch network traffic together when the radio is already in
2018 * this state. This method tells you whether right now is currently a good time to
2019 * initiate network traffic, as the network is already active.
2020 */
Robert Greenwalt6078b502014-06-11 16:05:07 -07002021 public boolean isDefaultNetworkActive() {
Dianne Hackborn77b987f2014-02-26 16:20:52 -08002022 try {
2023 return getNetworkManagementService().isNetworkActive();
2024 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002025 throw e.rethrowFromSystemServer();
Dianne Hackborn77b987f2014-02-26 16:20:52 -08002026 }
Dianne Hackborn77b987f2014-02-26 16:20:52 -08002027 }
2028
2029 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002030 * {@hide}
2031 */
Lorenzo Colittiffc42b02015-07-29 11:41:21 +09002032 public ConnectivityManager(Context context, IConnectivityManager service) {
Hugo Benichidafed3d2017-03-06 09:17:06 +09002033 mContext = Preconditions.checkNotNull(context, "missing context");
2034 mService = Preconditions.checkNotNull(service, "missing IConnectivityManager");
Paul Jensene0bef712014-12-10 15:12:18 -05002035 sInstance = this;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002036 }
Robert Greenwaltd0e18ff2010-01-26 11:40:34 -08002037
Jeff Sharkey8fc27e82012-04-04 20:40:58 -07002038 /** {@hide} */
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01002039 @UnsupportedAppUsage
Jeff Sharkey8fc27e82012-04-04 20:40:58 -07002040 public static ConnectivityManager from(Context context) {
2041 return (ConnectivityManager) context.getSystemService(Context.CONNECTIVITY_SERVICE);
2042 }
2043
Lorenzo Colittifbe9b1a2016-07-28 17:14:11 +09002044 /* TODO: These permissions checks don't belong in client-side code. Move them to
2045 * services.jar, possibly in com.android.server.net. */
2046
2047 /** {@hide} */
Lorenzo Colittid5427052015-10-15 16:29:00 +09002048 public static final void enforceChangePermission(Context context) {
2049 int uid = Binder.getCallingUid();
2050 Settings.checkAndNoteChangeNetworkStateOperation(context, uid, Settings
2051 .getPackageNameForUid(context, uid), true /* throwException */);
2052 }
2053
Tetsutoki Shiozawa335d2ed2016-03-16 23:30:57 +09002054 /** {@hide} */
2055 public static final void enforceTetherChangePermission(Context context, String callingPkg) {
Hugo Benichie7678512017-05-09 15:19:01 +09002056 Preconditions.checkNotNull(context, "Context cannot be null");
2057 Preconditions.checkNotNull(callingPkg, "callingPkg cannot be null");
Tetsutoki Shiozawa335d2ed2016-03-16 23:30:57 +09002058
Robert Greenwaltedb47662014-09-16 17:54:19 -07002059 if (context.getResources().getStringArray(
2060 com.android.internal.R.array.config_mobile_hotspot_provision_app).length == 2) {
2061 // Have a provisioning app - must only let system apps (which check this app)
2062 // turn on tethering
2063 context.enforceCallingOrSelfPermission(
Jeremy Kleind42209d2015-12-28 15:11:58 -08002064 android.Manifest.permission.TETHER_PRIVILEGED, "ConnectivityService");
Robert Greenwaltedb47662014-09-16 17:54:19 -07002065 } else {
Billy Laua7238a32015-08-01 12:45:02 +01002066 int uid = Binder.getCallingUid();
Tetsutoki Shiozawa335d2ed2016-03-16 23:30:57 +09002067 // If callingPkg's uid is not same as Binder.getCallingUid(),
2068 // AppOpsService throws SecurityException.
2069 Settings.checkAndNoteWriteSettingsOperation(context, uid, callingPkg,
2070 true /* throwException */);
Robert Greenwaltedb47662014-09-16 17:54:19 -07002071 }
2072 }
2073
Robert Greenwaltd0e18ff2010-01-26 11:40:34 -08002074 /**
Paul Jensene0bef712014-12-10 15:12:18 -05002075 * @deprecated - use getSystemService. This is a kludge to support static access in certain
2076 * situations where a Context pointer is unavailable.
2077 * @hide
2078 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07002079 @Deprecated
Paul Jensen72db88e2015-03-10 10:54:12 -04002080 static ConnectivityManager getInstanceOrNull() {
2081 return sInstance;
2082 }
2083
2084 /**
2085 * @deprecated - use getSystemService. This is a kludge to support static access in certain
2086 * situations where a Context pointer is unavailable.
2087 * @hide
2088 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07002089 @Deprecated
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01002090 @UnsupportedAppUsage
Paul Jensen72db88e2015-03-10 10:54:12 -04002091 private static ConnectivityManager getInstance() {
2092 if (getInstanceOrNull() == null) {
Paul Jensene0bef712014-12-10 15:12:18 -05002093 throw new IllegalStateException("No ConnectivityManager yet constructed");
2094 }
Paul Jensen72db88e2015-03-10 10:54:12 -04002095 return getInstanceOrNull();
Paul Jensene0bef712014-12-10 15:12:18 -05002096 }
2097
2098 /**
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002099 * Get the set of tetherable, available interfaces. This list is limited by
2100 * device configuration and current interface existence.
2101 *
2102 * @return an array of 0 or more Strings of tetherable interface names.
2103 *
Robert Greenwaltd0e18ff2010-01-26 11:40:34 -08002104 * {@hide}
2105 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06002106 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01002107 @UnsupportedAppUsage
Robert Greenwaltd0e18ff2010-01-26 11:40:34 -08002108 public String[] getTetherableIfaces() {
2109 try {
2110 return mService.getTetherableIfaces();
2111 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002112 throw e.rethrowFromSystemServer();
Robert Greenwaltd0e18ff2010-01-26 11:40:34 -08002113 }
2114 }
2115
2116 /**
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002117 * Get the set of tethered interfaces.
2118 *
2119 * @return an array of 0 or more String of currently tethered interface names.
2120 *
Robert Greenwaltd0e18ff2010-01-26 11:40:34 -08002121 * {@hide}
2122 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06002123 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01002124 @UnsupportedAppUsage
Robert Greenwaltd0e18ff2010-01-26 11:40:34 -08002125 public String[] getTetheredIfaces() {
2126 try {
2127 return mService.getTetheredIfaces();
2128 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002129 throw e.rethrowFromSystemServer();
Robert Greenwaltd0e18ff2010-01-26 11:40:34 -08002130 }
2131 }
2132
2133 /**
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002134 * Get the set of interface names which attempted to tether but
2135 * failed. Re-attempting to tether may cause them to reset to the Tethered
2136 * state. Alternatively, causing the interface to be destroyed and recreated
2137 * may cause them to reset to the available state.
2138 * {@link ConnectivityManager#getLastTetherError} can be used to get more
2139 * information on the cause of the errors.
2140 *
2141 * @return an array of 0 or more String indicating the interface names
2142 * which failed to tether.
2143 *
Robert Greenwaltd0e18ff2010-01-26 11:40:34 -08002144 * {@hide}
2145 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06002146 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01002147 @UnsupportedAppUsage
Robert Greenwalt5a735062010-03-02 17:25:02 -08002148 public String[] getTetheringErroredIfaces() {
Robert Greenwaltd0e18ff2010-01-26 11:40:34 -08002149 try {
Robert Greenwalt5a735062010-03-02 17:25:02 -08002150 return mService.getTetheringErroredIfaces();
Robert Greenwaltd0e18ff2010-01-26 11:40:34 -08002151 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002152 throw e.rethrowFromSystemServer();
Robert Greenwaltd0e18ff2010-01-26 11:40:34 -08002153 }
2154 }
2155
2156 /**
Robert Greenwalt9c7e2c22014-06-23 14:53:42 -07002157 * Get the set of tethered dhcp ranges.
2158 *
2159 * @return an array of 0 or more {@code String} of tethered dhcp ranges.
2160 * {@hide}
2161 */
2162 public String[] getTetheredDhcpRanges() {
2163 try {
2164 return mService.getTetheredDhcpRanges();
2165 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002166 throw e.rethrowFromSystemServer();
Robert Greenwalt9c7e2c22014-06-23 14:53:42 -07002167 }
2168 }
2169
2170 /**
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002171 * Attempt to tether the named interface. This will setup a dhcp server
2172 * on the interface, forward and NAT IP packets and forward DNS requests
2173 * to the best active upstream network interface. Note that if no upstream
2174 * IP network interface is available, dhcp will still run and traffic will be
2175 * allowed between the tethered devices and this device, though upstream net
2176 * access will of course fail until an upstream network interface becomes
2177 * active.
Lorenzo Colittid5427052015-10-15 16:29:00 +09002178 *
2179 * <p>This method requires the caller to hold either the
2180 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
2181 * or the ability to modify system settings as determined by
2182 * {@link android.provider.Settings.System#canWrite}.</p>
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002183 *
Jeremy Klein36c7aa02016-01-22 14:11:45 -08002184 * <p>WARNING: New clients should not use this function. The only usages should be in PanService
2185 * and WifiStateMachine which need direct access. All other clients should use
2186 * {@link #startTethering} and {@link #stopTethering} which encapsulate proper provisioning
2187 * logic.</p>
2188 *
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002189 * @param iface the interface name to tether.
2190 * @return error a {@code TETHER_ERROR} value indicating success or failure type
2191 *
Robert Greenwaltd0e18ff2010-01-26 11:40:34 -08002192 * {@hide}
2193 */
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01002194 @UnsupportedAppUsage
Robert Greenwalt5a735062010-03-02 17:25:02 -08002195 public int tether(String iface) {
2196 try {
Tetsutoki Shiozawa335d2ed2016-03-16 23:30:57 +09002197 String pkgName = mContext.getOpPackageName();
2198 Log.i(TAG, "tether caller:" + pkgName);
2199 return mService.tether(iface, pkgName);
Robert Greenwalt5a735062010-03-02 17:25:02 -08002200 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002201 throw e.rethrowFromSystemServer();
Robert Greenwalt5a735062010-03-02 17:25:02 -08002202 }
2203 }
2204
2205 /**
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002206 * Stop tethering the named interface.
Lorenzo Colittid5427052015-10-15 16:29:00 +09002207 *
2208 * <p>This method requires the caller to hold either the
2209 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
2210 * or the ability to modify system settings as determined by
2211 * {@link android.provider.Settings.System#canWrite}.</p>
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002212 *
Jeremy Klein36c7aa02016-01-22 14:11:45 -08002213 * <p>WARNING: New clients should not use this function. The only usages should be in PanService
2214 * and WifiStateMachine which need direct access. All other clients should use
2215 * {@link #startTethering} and {@link #stopTethering} which encapsulate proper provisioning
2216 * logic.</p>
2217 *
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002218 * @param iface the interface name to untether.
2219 * @return error a {@code TETHER_ERROR} value indicating success or failure type
2220 *
Robert Greenwalt5a735062010-03-02 17:25:02 -08002221 * {@hide}
2222 */
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01002223 @UnsupportedAppUsage
Robert Greenwalt5a735062010-03-02 17:25:02 -08002224 public int untether(String iface) {
Robert Greenwaltd0e18ff2010-01-26 11:40:34 -08002225 try {
Tetsutoki Shiozawa335d2ed2016-03-16 23:30:57 +09002226 String pkgName = mContext.getOpPackageName();
2227 Log.i(TAG, "untether caller:" + pkgName);
2228 return mService.untether(iface, pkgName);
Robert Greenwaltd0e18ff2010-01-26 11:40:34 -08002229 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002230 throw e.rethrowFromSystemServer();
Robert Greenwaltd0e18ff2010-01-26 11:40:34 -08002231 }
2232 }
Robert Greenwalt2a091d72010-02-11 18:18:40 -08002233
2234 /**
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002235 * Check if the device allows for tethering. It may be disabled via
Dianne Hackborn77b987f2014-02-26 16:20:52 -08002236 * {@code ro.tether.denied} system property, Settings.TETHER_SUPPORTED or
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002237 * due to device configuration.
2238 *
Chalard Jean8f76fc32017-09-26 15:45:18 +09002239 * <p>If this app does not have permission to use this API, it will always
2240 * return false rather than throw an exception.</p>
2241 *
2242 * <p>If the device has a hotspot provisioning app, the caller is required to hold the
2243 * {@link android.Manifest.permission.TETHER_PRIVILEGED} permission.</p>
2244 *
2245 * <p>Otherwise, this method requires the caller to hold the ability to modify system
2246 * settings as determined by {@link android.provider.Settings.System#canWrite}.</p>
2247 *
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002248 * @return a boolean - {@code true} indicating Tethering is supported.
2249 *
Robert Greenwalt2a091d72010-02-11 18:18:40 -08002250 * {@hide}
2251 */
Jeremy Klein36c7aa02016-01-22 14:11:45 -08002252 @SystemApi
Chalard Jean8f76fc32017-09-26 15:45:18 +09002253 @RequiresPermission(anyOf = {android.Manifest.permission.TETHER_PRIVILEGED,
2254 android.Manifest.permission.WRITE_SETTINGS})
Robert Greenwalt2a091d72010-02-11 18:18:40 -08002255 public boolean isTetheringSupported() {
Chalard Jean8f76fc32017-09-26 15:45:18 +09002256 String pkgName = mContext.getOpPackageName();
Robert Greenwalt2a091d72010-02-11 18:18:40 -08002257 try {
Udam Saini0e94c362017-06-07 12:06:28 -07002258 return mService.isTetheringSupported(pkgName);
Chalard Jean8f76fc32017-09-26 15:45:18 +09002259 } catch (SecurityException e) {
2260 // This API is not available to this caller, but for backward-compatibility
2261 // this will just return false instead of throwing.
2262 return false;
Robert Greenwalt2a091d72010-02-11 18:18:40 -08002263 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002264 throw e.rethrowFromSystemServer();
Robert Greenwalt2a091d72010-02-11 18:18:40 -08002265 }
2266 }
2267
2268 /**
Jeremy Klein36c7aa02016-01-22 14:11:45 -08002269 * Callback for use with {@link #startTethering} to find out whether tethering succeeded.
2270 * @hide
2271 */
2272 @SystemApi
2273 public static abstract class OnStartTetheringCallback {
2274 /**
2275 * Called when tethering has been successfully started.
2276 */
Chalard Jean4d660112018-06-04 16:52:49 +09002277 public void onTetheringStarted() {}
Jeremy Klein36c7aa02016-01-22 14:11:45 -08002278
2279 /**
2280 * Called when starting tethering failed.
2281 */
Chalard Jean4d660112018-06-04 16:52:49 +09002282 public void onTetheringFailed() {}
Jeremy Klein36c7aa02016-01-22 14:11:45 -08002283 }
2284
2285 /**
2286 * Convenient overload for
2287 * {@link #startTethering(int, boolean, OnStartTetheringCallback, Handler)} which passes a null
2288 * handler to run on the current thread's {@link Looper}.
2289 * @hide
2290 */
2291 @SystemApi
Udam Saini0e94c362017-06-07 12:06:28 -07002292 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
Jeremy Klein36c7aa02016-01-22 14:11:45 -08002293 public void startTethering(int type, boolean showProvisioningUi,
2294 final OnStartTetheringCallback callback) {
2295 startTethering(type, showProvisioningUi, callback, null);
2296 }
2297
2298 /**
2299 * Runs tether provisioning for the given type if needed and then starts tethering if
2300 * the check succeeds. If no carrier provisioning is required for tethering, tethering is
2301 * enabled immediately. If provisioning fails, tethering will not be enabled. It also
2302 * schedules tether provisioning re-checks if appropriate.
2303 *
2304 * @param type The type of tethering to start. Must be one of
2305 * {@link ConnectivityManager.TETHERING_WIFI},
2306 * {@link ConnectivityManager.TETHERING_USB}, or
2307 * {@link ConnectivityManager.TETHERING_BLUETOOTH}.
2308 * @param showProvisioningUi a boolean indicating to show the provisioning app UI if there
2309 * is one. This should be true the first time this function is called and also any time
2310 * the user can see this UI. It gives users information from their carrier about the
2311 * check failing and how they can sign up for tethering if possible.
2312 * @param callback an {@link OnStartTetheringCallback} which will be called to notify the caller
2313 * of the result of trying to tether.
2314 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
2315 * @hide
2316 */
2317 @SystemApi
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06002318 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
Jeremy Klein36c7aa02016-01-22 14:11:45 -08002319 public void startTethering(int type, boolean showProvisioningUi,
2320 final OnStartTetheringCallback callback, Handler handler) {
Hugo Benichidafed3d2017-03-06 09:17:06 +09002321 Preconditions.checkNotNull(callback, "OnStartTetheringCallback cannot be null.");
Jeremy Klein5f277e12016-03-12 16:29:54 -08002322
Jeremy Klein36c7aa02016-01-22 14:11:45 -08002323 ResultReceiver wrappedCallback = new ResultReceiver(handler) {
2324 @Override
2325 protected void onReceiveResult(int resultCode, Bundle resultData) {
2326 if (resultCode == TETHER_ERROR_NO_ERROR) {
2327 callback.onTetheringStarted();
2328 } else {
2329 callback.onTetheringFailed();
2330 }
2331 }
2332 };
Jeremy Klein5f277e12016-03-12 16:29:54 -08002333
Jeremy Klein36c7aa02016-01-22 14:11:45 -08002334 try {
Tetsutoki Shiozawa335d2ed2016-03-16 23:30:57 +09002335 String pkgName = mContext.getOpPackageName();
2336 Log.i(TAG, "startTethering caller:" + pkgName);
2337 mService.startTethering(type, wrappedCallback, showProvisioningUi, pkgName);
Jeremy Klein36c7aa02016-01-22 14:11:45 -08002338 } catch (RemoteException e) {
2339 Log.e(TAG, "Exception trying to start tethering.", e);
2340 wrappedCallback.send(TETHER_ERROR_SERVICE_UNAVAIL, null);
2341 }
2342 }
2343
2344 /**
2345 * Stops tethering for the given type. Also cancels any provisioning rechecks for that type if
2346 * applicable.
2347 *
2348 * @param type The type of tethering to stop. Must be one of
2349 * {@link ConnectivityManager.TETHERING_WIFI},
2350 * {@link ConnectivityManager.TETHERING_USB}, or
2351 * {@link ConnectivityManager.TETHERING_BLUETOOTH}.
2352 * @hide
2353 */
2354 @SystemApi
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06002355 @RequiresPermission(android.Manifest.permission.TETHER_PRIVILEGED)
Jeremy Klein36c7aa02016-01-22 14:11:45 -08002356 public void stopTethering(int type) {
2357 try {
Tetsutoki Shiozawa335d2ed2016-03-16 23:30:57 +09002358 String pkgName = mContext.getOpPackageName();
2359 Log.i(TAG, "stopTethering caller:" + pkgName);
2360 mService.stopTethering(type, pkgName);
Jeremy Klein36c7aa02016-01-22 14:11:45 -08002361 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002362 throw e.rethrowFromSystemServer();
Jeremy Klein36c7aa02016-01-22 14:11:45 -08002363 }
2364 }
2365
2366 /**
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002367 * Get the list of regular expressions that define any tetherable
2368 * USB network interfaces. If USB tethering is not supported by the
2369 * device, this list should be empty.
2370 *
2371 * @return an array of 0 or more regular expression Strings defining
2372 * what interfaces are considered tetherable usb interfaces.
2373 *
Robert Greenwalt2a091d72010-02-11 18:18:40 -08002374 * {@hide}
2375 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06002376 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01002377 @UnsupportedAppUsage
Robert Greenwalt2a091d72010-02-11 18:18:40 -08002378 public String[] getTetherableUsbRegexs() {
2379 try {
2380 return mService.getTetherableUsbRegexs();
2381 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002382 throw e.rethrowFromSystemServer();
Robert Greenwalt2a091d72010-02-11 18:18:40 -08002383 }
2384 }
2385
2386 /**
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002387 * Get the list of regular expressions that define any tetherable
2388 * Wifi network interfaces. If Wifi tethering is not supported by the
2389 * device, this list should be empty.
2390 *
2391 * @return an array of 0 or more regular expression Strings defining
2392 * what interfaces are considered tetherable wifi interfaces.
2393 *
Robert Greenwalt2a091d72010-02-11 18:18:40 -08002394 * {@hide}
2395 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06002396 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01002397 @UnsupportedAppUsage
Robert Greenwalt2a091d72010-02-11 18:18:40 -08002398 public String[] getTetherableWifiRegexs() {
2399 try {
2400 return mService.getTetherableWifiRegexs();
2401 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002402 throw e.rethrowFromSystemServer();
Robert Greenwalt2a091d72010-02-11 18:18:40 -08002403 }
2404 }
Robert Greenwalt5a735062010-03-02 17:25:02 -08002405
Danica Chang6fdd0c62010-08-11 14:54:43 -07002406 /**
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002407 * Get the list of regular expressions that define any tetherable
2408 * Bluetooth network interfaces. If Bluetooth tethering is not supported by the
2409 * device, this list should be empty.
2410 *
2411 * @return an array of 0 or more regular expression Strings defining
2412 * what interfaces are considered tetherable bluetooth interfaces.
2413 *
Danica Chang6fdd0c62010-08-11 14:54:43 -07002414 * {@hide}
2415 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06002416 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01002417 @UnsupportedAppUsage
Danica Chang6fdd0c62010-08-11 14:54:43 -07002418 public String[] getTetherableBluetoothRegexs() {
2419 try {
2420 return mService.getTetherableBluetoothRegexs();
2421 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002422 throw e.rethrowFromSystemServer();
Danica Chang6fdd0c62010-08-11 14:54:43 -07002423 }
2424 }
2425
Mike Lockwood6c2260b2011-07-19 13:04:47 -07002426 /**
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002427 * Attempt to both alter the mode of USB and Tethering of USB. A
2428 * utility method to deal with some of the complexity of USB - will
2429 * attempt to switch to Rndis and subsequently tether the resulting
2430 * interface on {@code true} or turn off tethering and switch off
2431 * Rndis on {@code false}.
Lorenzo Colittid5427052015-10-15 16:29:00 +09002432 *
2433 * <p>This method requires the caller to hold either the
2434 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
2435 * or the ability to modify system settings as determined by
2436 * {@link android.provider.Settings.System#canWrite}.</p>
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002437 *
2438 * @param enable a boolean - {@code true} to enable tethering
2439 * @return error a {@code TETHER_ERROR} value indicating success or failure type
2440 *
Mike Lockwood6c2260b2011-07-19 13:04:47 -07002441 * {@hide}
2442 */
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01002443 @UnsupportedAppUsage
Mike Lockwood6c2260b2011-07-19 13:04:47 -07002444 public int setUsbTethering(boolean enable) {
2445 try {
Tetsutoki Shiozawa335d2ed2016-03-16 23:30:57 +09002446 String pkgName = mContext.getOpPackageName();
2447 Log.i(TAG, "setUsbTethering caller:" + pkgName);
2448 return mService.setUsbTethering(enable, pkgName);
Mike Lockwood6c2260b2011-07-19 13:04:47 -07002449 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002450 throw e.rethrowFromSystemServer();
Mike Lockwood6c2260b2011-07-19 13:04:47 -07002451 }
2452 }
2453
Robert Greenwalt5a735062010-03-02 17:25:02 -08002454 /** {@hide} */
2455 public static final int TETHER_ERROR_NO_ERROR = 0;
2456 /** {@hide} */
2457 public static final int TETHER_ERROR_UNKNOWN_IFACE = 1;
2458 /** {@hide} */
2459 public static final int TETHER_ERROR_SERVICE_UNAVAIL = 2;
2460 /** {@hide} */
2461 public static final int TETHER_ERROR_UNSUPPORTED = 3;
2462 /** {@hide} */
2463 public static final int TETHER_ERROR_UNAVAIL_IFACE = 4;
2464 /** {@hide} */
2465 public static final int TETHER_ERROR_MASTER_ERROR = 5;
2466 /** {@hide} */
2467 public static final int TETHER_ERROR_TETHER_IFACE_ERROR = 6;
2468 /** {@hide} */
2469 public static final int TETHER_ERROR_UNTETHER_IFACE_ERROR = 7;
2470 /** {@hide} */
2471 public static final int TETHER_ERROR_ENABLE_NAT_ERROR = 8;
2472 /** {@hide} */
2473 public static final int TETHER_ERROR_DISABLE_NAT_ERROR = 9;
2474 /** {@hide} */
2475 public static final int TETHER_ERROR_IFACE_CFG_ERROR = 10;
Jeremy Klein36c7aa02016-01-22 14:11:45 -08002476 /** {@hide} */
2477 public static final int TETHER_ERROR_PROVISION_FAILED = 11;
Robert Greenwalt5a735062010-03-02 17:25:02 -08002478
2479 /**
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002480 * Get a more detailed error code after a Tethering or Untethering
2481 * request asynchronously failed.
2482 *
2483 * @param iface The name of the interface of interest
Robert Greenwalt5a735062010-03-02 17:25:02 -08002484 * @return error The error code of the last error tethering or untethering the named
2485 * interface
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002486 *
Robert Greenwalt5a735062010-03-02 17:25:02 -08002487 * {@hide}
2488 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06002489 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01002490 @UnsupportedAppUsage
Robert Greenwalt5a735062010-03-02 17:25:02 -08002491 public int getLastTetherError(String iface) {
2492 try {
2493 return mService.getLastTetherError(iface);
2494 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002495 throw e.rethrowFromSystemServer();
Robert Greenwalt5a735062010-03-02 17:25:02 -08002496 }
Robert Greenwalt14f2ef42010-06-15 12:19:37 -07002497 }
2498
2499 /**
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002500 * Report network connectivity status. This is currently used only
2501 * to alter status bar UI.
Paul Jensenb2748922015-05-06 11:10:18 -04002502 * <p>This method requires the caller to hold the permission
2503 * {@link android.Manifest.permission#STATUS_BAR}.
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002504 *
Robert Greenwaltd7085fc2010-09-08 15:24:47 -07002505 * @param networkType The type of network you want to report on
2506 * @param percentage The quality of the connection 0 is bad, 100 is good
Chalard Jean6b1da6e2018-03-08 13:54:53 +09002507 * @deprecated Types are deprecated. Use {@link #reportNetworkConnectivity} instead.
Robert Greenwaltd7085fc2010-09-08 15:24:47 -07002508 * {@hide}
2509 */
2510 public void reportInetCondition(int networkType, int percentage) {
Soi, Yoshinaridee2aa42015-11-12 12:09:02 +09002511 printStackTrace();
Robert Greenwaltd7085fc2010-09-08 15:24:47 -07002512 try {
2513 mService.reportInetCondition(networkType, percentage);
2514 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002515 throw e.rethrowFromSystemServer();
Robert Greenwaltd7085fc2010-09-08 15:24:47 -07002516 }
2517 }
Robert Greenwalt434203a2010-10-11 16:00:27 -07002518
2519 /**
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07002520 * Report a problem network to the framework. This provides a hint to the system
Ye Wenb87875e2014-07-21 14:19:01 -07002521 * that there might be connectivity problems on this network and may cause
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07002522 * the framework to re-evaluate network connectivity and/or switch to another
2523 * network.
Robert Greenwalt9258c642014-03-26 16:47:06 -07002524 *
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07002525 * @param network The {@link Network} the application was attempting to use
2526 * or {@code null} to indicate the current default network.
Paul Jensenbfd17b72015-04-07 12:43:13 -04002527 * @deprecated Use {@link #reportNetworkConnectivity} which allows reporting both
2528 * working and non-working connectivity.
Robert Greenwalt9258c642014-03-26 16:47:06 -07002529 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07002530 @Deprecated
Robert Greenwalt9258c642014-03-26 16:47:06 -07002531 public void reportBadNetwork(Network network) {
Soi, Yoshinaridee2aa42015-11-12 12:09:02 +09002532 printStackTrace();
Robert Greenwalt9258c642014-03-26 16:47:06 -07002533 try {
Paul Jensenbfd17b72015-04-07 12:43:13 -04002534 // One of these will be ignored because it matches system's current state.
2535 // The other will trigger the necessary reevaluation.
2536 mService.reportNetworkConnectivity(network, true);
2537 mService.reportNetworkConnectivity(network, false);
2538 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002539 throw e.rethrowFromSystemServer();
Paul Jensenbfd17b72015-04-07 12:43:13 -04002540 }
2541 }
2542
2543 /**
2544 * Report to the framework whether a network has working connectivity.
2545 * This provides a hint to the system that a particular network is providing
2546 * working connectivity or not. In response the framework may re-evaluate
2547 * the network's connectivity and might take further action thereafter.
2548 *
2549 * @param network The {@link Network} the application was attempting to use
2550 * or {@code null} to indicate the current default network.
2551 * @param hasConnectivity {@code true} if the application was able to successfully access the
2552 * Internet using {@code network} or {@code false} if not.
2553 */
2554 public void reportNetworkConnectivity(Network network, boolean hasConnectivity) {
Soi, Yoshinaridee2aa42015-11-12 12:09:02 +09002555 printStackTrace();
Paul Jensenbfd17b72015-04-07 12:43:13 -04002556 try {
2557 mService.reportNetworkConnectivity(network, hasConnectivity);
Robert Greenwalt9258c642014-03-26 16:47:06 -07002558 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002559 throw e.rethrowFromSystemServer();
Robert Greenwalt9258c642014-03-26 16:47:06 -07002560 }
2561 }
2562
2563 /**
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002564 * Set a network-independent global http proxy. This is not normally what you want
2565 * for typical HTTP proxies - they are general network dependent. However if you're
2566 * doing something unusual like general internal filtering this may be useful. On
2567 * a private network where the proxy is not accessible, you may break HTTP using this.
Paul Jensenb2748922015-05-06 11:10:18 -04002568 *
2569 * @param p A {@link ProxyInfo} object defining the new global
2570 * HTTP proxy. A {@code null} value will clear the global HTTP proxy.
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07002571 * @hide
Robert Greenwalt434203a2010-10-11 16:00:27 -07002572 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06002573 @RequiresPermission(android.Manifest.permission.CONNECTIVITY_INTERNAL)
Jason Monk207900c2014-04-25 15:00:09 -04002574 public void setGlobalProxy(ProxyInfo p) {
Robert Greenwalt434203a2010-10-11 16:00:27 -07002575 try {
2576 mService.setGlobalProxy(p);
2577 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002578 throw e.rethrowFromSystemServer();
Robert Greenwalt434203a2010-10-11 16:00:27 -07002579 }
2580 }
2581
2582 /**
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002583 * Retrieve any network-independent global HTTP proxy.
2584 *
Jason Monk207900c2014-04-25 15:00:09 -04002585 * @return {@link ProxyInfo} for the current global HTTP proxy or {@code null}
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002586 * if no global HTTP proxy is set.
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07002587 * @hide
Robert Greenwalt434203a2010-10-11 16:00:27 -07002588 */
Jason Monk207900c2014-04-25 15:00:09 -04002589 public ProxyInfo getGlobalProxy() {
Robert Greenwalt434203a2010-10-11 16:00:27 -07002590 try {
2591 return mService.getGlobalProxy();
2592 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002593 throw e.rethrowFromSystemServer();
Robert Greenwalt434203a2010-10-11 16:00:27 -07002594 }
2595 }
2596
2597 /**
Paul Jensencee9b512015-05-06 07:32:40 -04002598 * Retrieve the global HTTP proxy, or if no global HTTP proxy is set, a
2599 * network-specific HTTP proxy. If {@code network} is null, the
2600 * network-specific proxy returned is the proxy of the default active
2601 * network.
2602 *
2603 * @return {@link ProxyInfo} for the current global HTTP proxy, or if no
2604 * global HTTP proxy is set, {@code ProxyInfo} for {@code network},
2605 * or when {@code network} is {@code null},
2606 * the {@code ProxyInfo} for the default active network. Returns
2607 * {@code null} when no proxy applies or the caller doesn't have
2608 * permission to use {@code network}.
2609 * @hide
2610 */
2611 public ProxyInfo getProxyForNetwork(Network network) {
2612 try {
2613 return mService.getProxyForNetwork(network);
2614 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002615 throw e.rethrowFromSystemServer();
Paul Jensencee9b512015-05-06 07:32:40 -04002616 }
2617 }
2618
2619 /**
Paul Jensene0bef712014-12-10 15:12:18 -05002620 * Get the current default HTTP proxy settings. If a global proxy is set it will be returned,
2621 * otherwise if this process is bound to a {@link Network} using
Paul Jensen72db88e2015-03-10 10:54:12 -04002622 * {@link #bindProcessToNetwork} then that {@code Network}'s proxy is returned, otherwise
Paul Jensene0bef712014-12-10 15:12:18 -05002623 * the default network's proxy is returned.
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002624 *
Jason Monk207900c2014-04-25 15:00:09 -04002625 * @return the {@link ProxyInfo} for the current HTTP proxy, or {@code null} if no
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002626 * HTTP proxy is active.
Robert Greenwalt434203a2010-10-11 16:00:27 -07002627 */
Paul Jensene0bef712014-12-10 15:12:18 -05002628 public ProxyInfo getDefaultProxy() {
Paul Jensencee9b512015-05-06 07:32:40 -04002629 return getProxyForNetwork(getBoundNetworkForProcess());
Robert Greenwalt434203a2010-10-11 16:00:27 -07002630 }
Robert Greenwaltd55a6b42011-03-25 13:09:25 -07002631
2632 /**
Robert Greenwalt9b2886e2011-08-31 11:46:42 -07002633 * Returns true if the hardware supports the given network type
2634 * else it returns false. This doesn't indicate we have coverage
2635 * or are authorized onto a network, just whether or not the
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002636 * hardware supports it. For example a GSM phone without a SIM
2637 * should still return {@code true} for mobile data, but a wifi only
2638 * tablet would return {@code false}.
2639 *
2640 * @param networkType The network type we'd like to check
2641 * @return {@code true} if supported, else {@code false}
Chalard Jean6b1da6e2018-03-08 13:54:53 +09002642 * @deprecated Types are deprecated. Use {@link NetworkCapabilities} instead.
Robert Greenwalt9b2886e2011-08-31 11:46:42 -07002643 * @hide
2644 */
Chalard Jean6b1da6e2018-03-08 13:54:53 +09002645 @Deprecated
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06002646 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01002647 @UnsupportedAppUsage
Robert Greenwalt9b2886e2011-08-31 11:46:42 -07002648 public boolean isNetworkSupported(int networkType) {
2649 try {
2650 return mService.isNetworkSupported(networkType);
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002651 } catch (RemoteException e) {
2652 throw e.rethrowFromSystemServer();
2653 }
Robert Greenwalt9b2886e2011-08-31 11:46:42 -07002654 }
Jeff Sharkey9f7cbf02012-04-12 18:34:54 -07002655
2656 /**
2657 * Returns if the currently active data network is metered. A network is
2658 * classified as metered when the user is sensitive to heavy data usage on
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002659 * that connection due to monetary costs, data limitations or
2660 * battery/performance issues. You should check this before doing large
2661 * data transfers, and warn the user or delay the operation until another
2662 * network is available.
2663 *
2664 * @return {@code true} if large transfers should be avoided, otherwise
2665 * {@code false}.
Jeff Sharkey9f7cbf02012-04-12 18:34:54 -07002666 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06002667 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Jeff Sharkey9f7cbf02012-04-12 18:34:54 -07002668 public boolean isActiveNetworkMetered() {
2669 try {
2670 return mService.isActiveNetworkMetered();
2671 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002672 throw e.rethrowFromSystemServer();
Jeff Sharkey9f7cbf02012-04-12 18:34:54 -07002673 }
2674 }
Jeff Sharkey69ddab42012-08-25 00:05:46 -07002675
Robert Greenwalt5a6bdc42013-02-15 10:56:35 -08002676 /**
2677 * If the LockdownVpn mechanism is enabled, updates the vpn
2678 * with a reload of its profile.
2679 *
2680 * @return a boolean with {@code} indicating success
2681 *
2682 * <p>This method can only be called by the system UID
2683 * {@hide}
2684 */
Jeff Sharkey69ddab42012-08-25 00:05:46 -07002685 public boolean updateLockdownVpn() {
2686 try {
2687 return mService.updateLockdownVpn();
2688 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002689 throw e.rethrowFromSystemServer();
Jeff Sharkey69ddab42012-08-25 00:05:46 -07002690 }
2691 }
Irfan Sheriffda6da092012-08-16 12:49:23 -07002692
2693 /**
Wink Saville948282b2013-08-29 08:55:16 -07002694 * Check mobile provisioning.
Wink Savilleab9321d2013-06-29 21:10:57 -07002695 *
Wink Savilleab9321d2013-06-29 21:10:57 -07002696 * @param suggestedTimeOutMs, timeout in milliseconds
Wink Savilleab9321d2013-06-29 21:10:57 -07002697 *
2698 * @return time out that will be used, maybe less that suggestedTimeOutMs
2699 * -1 if an error.
2700 *
2701 * {@hide}
2702 */
Wink Saville948282b2013-08-29 08:55:16 -07002703 public int checkMobileProvisioning(int suggestedTimeOutMs) {
Wink Savilleab9321d2013-06-29 21:10:57 -07002704 int timeOutMs = -1;
2705 try {
Wink Saville948282b2013-08-29 08:55:16 -07002706 timeOutMs = mService.checkMobileProvisioning(suggestedTimeOutMs);
Wink Savilleab9321d2013-06-29 21:10:57 -07002707 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002708 throw e.rethrowFromSystemServer();
Wink Savilleab9321d2013-06-29 21:10:57 -07002709 }
2710 return timeOutMs;
2711 }
Robert Greenwalte182bfe2013-07-16 12:06:09 -07002712
2713 /**
Wink Saville42d4f082013-07-20 20:31:59 -07002714 * Get the mobile provisioning url.
Robert Greenwalte182bfe2013-07-16 12:06:09 -07002715 * {@hide}
2716 */
2717 public String getMobileProvisioningUrl() {
2718 try {
2719 return mService.getMobileProvisioningUrl();
2720 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002721 throw e.rethrowFromSystemServer();
Robert Greenwalte182bfe2013-07-16 12:06:09 -07002722 }
Robert Greenwalte182bfe2013-07-16 12:06:09 -07002723 }
Wink Saville42d4f082013-07-20 20:31:59 -07002724
2725 /**
Wink Saville948282b2013-08-29 08:55:16 -07002726 * Set sign in error notification to visible or in visible
2727 *
Wink Saville948282b2013-08-29 08:55:16 -07002728 * {@hide}
Paul Jensen3541e9f2015-03-18 12:23:02 -04002729 * @deprecated Doesn't properly deal with multiple connected networks of the same type.
Wink Saville948282b2013-08-29 08:55:16 -07002730 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07002731 @Deprecated
Wink Saville948282b2013-08-29 08:55:16 -07002732 public void setProvisioningNotificationVisible(boolean visible, int networkType,
Paul Jensen89e0f092014-09-15 15:59:36 -04002733 String action) {
Wink Saville948282b2013-08-29 08:55:16 -07002734 try {
Paul Jensen89e0f092014-09-15 15:59:36 -04002735 mService.setProvisioningNotificationVisible(visible, networkType, action);
Wink Saville948282b2013-08-29 08:55:16 -07002736 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002737 throw e.rethrowFromSystemServer();
Wink Saville948282b2013-08-29 08:55:16 -07002738 }
2739 }
Yuhao Zheng5cd1a0e2013-09-09 17:00:04 -07002740
2741 /**
2742 * Set the value for enabling/disabling airplane mode
2743 *
2744 * @param enable whether to enable airplane mode or not
2745 *
Yuhao Zheng5cd1a0e2013-09-09 17:00:04 -07002746 * @hide
2747 */
Lorenzo Colittif5845d12018-10-09 18:55:11 +09002748 @RequiresPermission(anyOf = {
2749 android.Manifest.permission.NETWORK_SETTINGS,
2750 android.Manifest.permission.NETWORK_SETUP_WIZARD,
2751 android.Manifest.permission.NETWORK_STACK})
Lorenzo Colitti85eca482018-10-09 18:50:32 +09002752 @SystemApi
Yuhao Zheng5cd1a0e2013-09-09 17:00:04 -07002753 public void setAirplaneMode(boolean enable) {
2754 try {
2755 mService.setAirplaneMode(enable);
2756 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002757 throw e.rethrowFromSystemServer();
Yuhao Zheng5cd1a0e2013-09-09 17:00:04 -07002758 }
2759 }
Robert Greenwalte049c232014-04-11 15:53:27 -07002760
2761 /** {@hide} */
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01002762 @UnsupportedAppUsage
Robert Greenwalta67be032014-05-16 15:49:14 -07002763 public void registerNetworkFactory(Messenger messenger, String name) {
Robert Greenwalte049c232014-04-11 15:53:27 -07002764 try {
Robert Greenwalta67be032014-05-16 15:49:14 -07002765 mService.registerNetworkFactory(messenger, name);
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002766 } catch (RemoteException e) {
2767 throw e.rethrowFromSystemServer();
2768 }
Robert Greenwalta67be032014-05-16 15:49:14 -07002769 }
2770
2771 /** {@hide} */
Mathew Inwood55418ea2018-12-20 15:30:45 +00002772 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 115609023)
Robert Greenwalta67be032014-05-16 15:49:14 -07002773 public void unregisterNetworkFactory(Messenger messenger) {
2774 try {
2775 mService.unregisterNetworkFactory(messenger);
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002776 } catch (RemoteException e) {
2777 throw e.rethrowFromSystemServer();
2778 }
Robert Greenwalte049c232014-04-11 15:53:27 -07002779 }
Robert Greenwalt7b816022014-04-18 15:25:25 -07002780
Paul Jensen31a94f42015-02-13 14:18:39 -05002781 /**
2782 * @hide
2783 * Register a NetworkAgent with ConnectivityService.
2784 * @return NetID corresponding to NetworkAgent.
2785 */
2786 public int registerNetworkAgent(Messenger messenger, NetworkInfo ni, LinkProperties lp,
Sreeram Ramachandran8cd33ed2014-07-23 15:23:15 -07002787 NetworkCapabilities nc, int score, NetworkMisc misc) {
Robert Greenwalt7b816022014-04-18 15:25:25 -07002788 try {
Paul Jensen31a94f42015-02-13 14:18:39 -05002789 return mService.registerNetworkAgent(messenger, ni, lp, nc, score, misc);
2790 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07002791 throw e.rethrowFromSystemServer();
Paul Jensen31a94f42015-02-13 14:18:39 -05002792 }
Robert Greenwalt7b816022014-04-18 15:25:25 -07002793 }
2794
Robert Greenwalt9258c642014-03-26 16:47:06 -07002795 /**
Hugo Benichidafed3d2017-03-06 09:17:06 +09002796 * Base class for {@code NetworkRequest} callbacks. Used for notifications about network
2797 * changes. Should be extended by applications wanting notifications.
2798 *
2799 * A {@code NetworkCallback} is registered by calling
2800 * {@link #requestNetwork(NetworkRequest, NetworkCallback)},
2801 * {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)},
Hugo Benichica867dc2018-02-07 21:17:43 +09002802 * or {@link #registerDefaultNetworkCallback(NetworkCallback)}. A {@code NetworkCallback} is
Hugo Benichidafed3d2017-03-06 09:17:06 +09002803 * unregistered by calling {@link #unregisterNetworkCallback(NetworkCallback)}.
2804 * A {@code NetworkCallback} should be registered at most once at any time.
2805 * A {@code NetworkCallback} that has been unregistered can be registered again.
Robert Greenwalt9258c642014-03-26 16:47:06 -07002806 */
Robert Greenwalt6078b502014-06-11 16:05:07 -07002807 public static class NetworkCallback {
Robert Greenwalt7b816022014-04-18 15:25:25 -07002808 /**
Lorenzo Colitti07086932015-04-24 12:23:24 +09002809 * Called when the framework connects to a new network to evaluate whether it satisfies this
2810 * request. If evaluation succeeds, this callback may be followed by an {@link #onAvailable}
2811 * callback. There is no guarantee that this new network will satisfy any requests, or that
2812 * the network will stay connected for longer than the time necessary to evaluate it.
2813 * <p>
2814 * Most applications <b>should not</b> act on this callback, and should instead use
2815 * {@link #onAvailable}. This callback is intended for use by applications that can assist
2816 * the framework in properly evaluating the network &mdash; for example, an application that
2817 * can automatically log in to a captive portal without user intervention.
2818 *
2819 * @param network The {@link Network} of the network that is being evaluated.
Lorenzo Colitti66276122015-06-11 14:27:17 +09002820 *
2821 * @hide
Robert Greenwalt7b816022014-04-18 15:25:25 -07002822 */
Robert Greenwalt6078b502014-06-11 16:05:07 -07002823 public void onPreCheck(Network network) {}
Robert Greenwalt7b816022014-04-18 15:25:25 -07002824
2825 /**
Lorenzo Colitti07086932015-04-24 12:23:24 +09002826 * Called when the framework connects and has declared a new network ready for use.
Robert Greenwalt6078b502014-06-11 16:05:07 -07002827 * This callback may be called more than once if the {@link Network} that is
2828 * satisfying the request changes.
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07002829 *
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07002830 * @param network The {@link Network} of the satisfying network.
Chalard Jean804b8fb2018-01-30 22:41:41 +09002831 * @param networkCapabilities The {@link NetworkCapabilities} of the satisfying network.
2832 * @param linkProperties The {@link LinkProperties} of the satisfying network.
junyulai05986c62018-08-07 19:50:45 +08002833 * @param blocked Whether access to the {@link Network} is blocked due to system policy.
Chalard Jean804b8fb2018-01-30 22:41:41 +09002834 * @hide
2835 */
2836 public void onAvailable(Network network, NetworkCapabilities networkCapabilities,
junyulai05986c62018-08-07 19:50:45 +08002837 LinkProperties linkProperties, boolean blocked) {
Chalard Jean804b8fb2018-01-30 22:41:41 +09002838 // Internally only this method is called when a new network is available, and
2839 // it calls the callback in the same way and order that older versions used
2840 // to call so as not to change the behavior.
2841 onAvailable(network);
2842 if (!networkCapabilities.hasCapability(
2843 NetworkCapabilities.NET_CAPABILITY_NOT_SUSPENDED)) {
2844 onNetworkSuspended(network);
2845 }
2846 onCapabilitiesChanged(network, networkCapabilities);
2847 onLinkPropertiesChanged(network, linkProperties);
junyulai05986c62018-08-07 19:50:45 +08002848 onBlockedStatusChanged(network, blocked);
Chalard Jean804b8fb2018-01-30 22:41:41 +09002849 }
2850
2851 /**
2852 * Called when the framework connects and has declared a new network ready for use.
2853 * This callback may be called more than once if the {@link Network} that is
2854 * satisfying the request changes. This will always immediately be followed by a
2855 * call to {@link #onCapabilitiesChanged(Network, NetworkCapabilities)} then by a
junyulai05986c62018-08-07 19:50:45 +08002856 * call to {@link #onLinkPropertiesChanged(Network, LinkProperties)}, and a call to
2857 * {@link #onBlockedStatusChanged(Network, boolean)}.
Chalard Jean804b8fb2018-01-30 22:41:41 +09002858 *
2859 * @param network The {@link Network} of the satisfying network.
Robert Greenwalt7b816022014-04-18 15:25:25 -07002860 */
Robert Greenwalt6078b502014-06-11 16:05:07 -07002861 public void onAvailable(Network network) {}
Robert Greenwalt7b816022014-04-18 15:25:25 -07002862
2863 /**
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07002864 * Called when the network is about to be disconnected. Often paired with an
Robert Greenwalt6078b502014-06-11 16:05:07 -07002865 * {@link NetworkCallback#onAvailable} call with the new replacement network
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07002866 * for graceful handover. This may not be called if we have a hard loss
2867 * (loss without warning). This may be followed by either a
Robert Greenwalt6078b502014-06-11 16:05:07 -07002868 * {@link NetworkCallback#onLost} call or a
2869 * {@link NetworkCallback#onAvailable} call for this network depending
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07002870 * on whether we lose or regain it.
2871 *
Robert Greenwalt6078b502014-06-11 16:05:07 -07002872 * @param network The {@link Network} that is about to be disconnected.
2873 * @param maxMsToLive The time in ms the framework will attempt to keep the
2874 * network connected. Note that the network may suffer a
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07002875 * hard loss at any time.
Robert Greenwalt7b816022014-04-18 15:25:25 -07002876 */
Robert Greenwalt6078b502014-06-11 16:05:07 -07002877 public void onLosing(Network network, int maxMsToLive) {}
Robert Greenwalt7b816022014-04-18 15:25:25 -07002878
2879 /**
2880 * Called when the framework has a hard loss of the network or when the
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07002881 * graceful failure ends.
2882 *
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07002883 * @param network The {@link Network} lost.
Robert Greenwalt7b816022014-04-18 15:25:25 -07002884 */
Robert Greenwalt6078b502014-06-11 16:05:07 -07002885 public void onLost(Network network) {}
Robert Greenwalt7b816022014-04-18 15:25:25 -07002886
2887 /**
Etan Cohenaebf17e2017-03-01 12:47:28 -08002888 * Called if no network is found in the timeout time specified in
Hugo Benichi0eec03f2017-05-15 15:15:33 +09002889 * {@link #requestNetwork(NetworkRequest, NetworkCallback, int)} call. This callback is not
Etan Cohenaebf17e2017-03-01 12:47:28 -08002890 * called for the version of {@link #requestNetwork(NetworkRequest, NetworkCallback)}
2891 * without timeout. When this callback is invoked the associated
2892 * {@link NetworkRequest} will have already been removed and released, as if
2893 * {@link #unregisterNetworkCallback(NetworkCallback)} had been called.
Robert Greenwalt7b816022014-04-18 15:25:25 -07002894 */
Robert Greenwalt6078b502014-06-11 16:05:07 -07002895 public void onUnavailable() {}
Robert Greenwalt7b816022014-04-18 15:25:25 -07002896
2897 /**
2898 * Called when the network the framework connected to for this request
2899 * changes capabilities but still satisfies the stated need.
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07002900 *
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07002901 * @param network The {@link Network} whose capabilities have changed.
Chalard Jean804b8fb2018-01-30 22:41:41 +09002902 * @param networkCapabilities The new {@link android.net.NetworkCapabilities} for this
2903 * network.
Robert Greenwalt7b816022014-04-18 15:25:25 -07002904 */
Robert Greenwalt6078b502014-06-11 16:05:07 -07002905 public void onCapabilitiesChanged(Network network,
Robert Greenwalt7b816022014-04-18 15:25:25 -07002906 NetworkCapabilities networkCapabilities) {}
2907
2908 /**
2909 * Called when the network the framework connected to for this request
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07002910 * changes {@link LinkProperties}.
2911 *
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07002912 * @param network The {@link Network} whose link properties have changed.
2913 * @param linkProperties The new {@link LinkProperties} for this network.
Robert Greenwalt7b816022014-04-18 15:25:25 -07002914 */
Robert Greenwalt6078b502014-06-11 16:05:07 -07002915 public void onLinkPropertiesChanged(Network network, LinkProperties linkProperties) {}
Robert Greenwalt7b816022014-04-18 15:25:25 -07002916
Robert Greenwalt8d482522015-06-24 13:23:42 -07002917 /**
2918 * Called when the network the framework connected to for this request
Chalard Jean804b8fb2018-01-30 22:41:41 +09002919 * goes into {@link NetworkInfo.State#SUSPENDED}.
Robert Greenwalt8d482522015-06-24 13:23:42 -07002920 * This generally means that while the TCP connections are still live,
2921 * temporarily network data fails to transfer. Specifically this is used
2922 * on cellular networks to mask temporary outages when driving through
2923 * a tunnel, etc.
2924 * @hide
2925 */
2926 public void onNetworkSuspended(Network network) {}
2927
2928 /**
2929 * Called when the network the framework connected to for this request
Chalard Jean804b8fb2018-01-30 22:41:41 +09002930 * returns from a {@link NetworkInfo.State#SUSPENDED} state. This should always be
2931 * preceded by a matching {@link NetworkCallback#onNetworkSuspended} call.
Robert Greenwalt8d482522015-06-24 13:23:42 -07002932 * @hide
2933 */
2934 public void onNetworkResumed(Network network) {}
2935
junyulai05986c62018-08-07 19:50:45 +08002936 /**
2937 * Called when access to the specified network is blocked or unblocked.
2938 *
2939 * @param network The {@link Network} whose blocked status has changed.
2940 * @param blocked The blocked status of this {@link Network}.
2941 */
2942 public void onBlockedStatusChanged(Network network, boolean blocked) {}
2943
Robert Greenwalt6078b502014-06-11 16:05:07 -07002944 private NetworkRequest networkRequest;
Robert Greenwalt7b816022014-04-18 15:25:25 -07002945 }
2946
Hugo Benichicb883232017-05-11 13:16:17 +09002947 /**
2948 * Constant error codes used by ConnectivityService to communicate about failures and errors
2949 * across a Binder boundary.
2950 * @hide
2951 */
2952 public interface Errors {
Chalard Jean4d660112018-06-04 16:52:49 +09002953 int TOO_MANY_REQUESTS = 1;
Hugo Benichicb883232017-05-11 13:16:17 +09002954 }
2955
2956 /** @hide */
2957 public static class TooManyRequestsException extends RuntimeException {}
2958
2959 private static RuntimeException convertServiceException(ServiceSpecificException e) {
2960 switch (e.errorCode) {
2961 case Errors.TOO_MANY_REQUESTS:
2962 return new TooManyRequestsException();
2963 default:
2964 Log.w(TAG, "Unknown service error code " + e.errorCode);
2965 return new RuntimeException(e);
2966 }
2967 }
2968
Robert Greenwalt9258c642014-03-26 16:47:06 -07002969 private static final int BASE = Protocol.BASE_CONNECTIVITY_MANAGER;
Robert Greenwalt9258c642014-03-26 16:47:06 -07002970 /** @hide */
Robert Greenwalt8d482522015-06-24 13:23:42 -07002971 public static final int CALLBACK_PRECHECK = BASE + 1;
2972 /** @hide */
2973 public static final int CALLBACK_AVAILABLE = BASE + 2;
2974 /** @hide arg1 = TTL */
2975 public static final int CALLBACK_LOSING = BASE + 3;
2976 /** @hide */
2977 public static final int CALLBACK_LOST = BASE + 4;
2978 /** @hide */
2979 public static final int CALLBACK_UNAVAIL = BASE + 5;
2980 /** @hide */
2981 public static final int CALLBACK_CAP_CHANGED = BASE + 6;
2982 /** @hide */
2983 public static final int CALLBACK_IP_CHANGED = BASE + 7;
Robert Greenwalt562cc542014-05-15 18:07:26 -07002984 /** @hide obj = NetworkCapabilities, arg1 = seq number */
Hugo Benichidba33db2017-03-23 22:40:44 +09002985 private static final int EXPIRE_LEGACY_REQUEST = BASE + 8;
Robert Greenwalt8d482522015-06-24 13:23:42 -07002986 /** @hide */
Hugo Benichidba33db2017-03-23 22:40:44 +09002987 public static final int CALLBACK_SUSPENDED = BASE + 9;
Robert Greenwalt8d482522015-06-24 13:23:42 -07002988 /** @hide */
Hugo Benichidba33db2017-03-23 22:40:44 +09002989 public static final int CALLBACK_RESUMED = BASE + 10;
junyulai05986c62018-08-07 19:50:45 +08002990 /** @hide */
2991 public static final int CALLBACK_BLK_CHANGED = BASE + 11;
Robert Greenwalt9258c642014-03-26 16:47:06 -07002992
Erik Kline57faba92015-11-25 12:49:38 +09002993 /** @hide */
2994 public static String getCallbackName(int whichCallback) {
2995 switch (whichCallback) {
2996 case CALLBACK_PRECHECK: return "CALLBACK_PRECHECK";
2997 case CALLBACK_AVAILABLE: return "CALLBACK_AVAILABLE";
2998 case CALLBACK_LOSING: return "CALLBACK_LOSING";
2999 case CALLBACK_LOST: return "CALLBACK_LOST";
3000 case CALLBACK_UNAVAIL: return "CALLBACK_UNAVAIL";
3001 case CALLBACK_CAP_CHANGED: return "CALLBACK_CAP_CHANGED";
3002 case CALLBACK_IP_CHANGED: return "CALLBACK_IP_CHANGED";
Erik Kline57faba92015-11-25 12:49:38 +09003003 case EXPIRE_LEGACY_REQUEST: return "EXPIRE_LEGACY_REQUEST";
3004 case CALLBACK_SUSPENDED: return "CALLBACK_SUSPENDED";
3005 case CALLBACK_RESUMED: return "CALLBACK_RESUMED";
junyulai05986c62018-08-07 19:50:45 +08003006 case CALLBACK_BLK_CHANGED: return "CALLBACK_BLK_CHANGED";
Erik Kline57faba92015-11-25 12:49:38 +09003007 default:
3008 return Integer.toString(whichCallback);
3009 }
3010 }
3011
Robert Greenwalt562cc542014-05-15 18:07:26 -07003012 private class CallbackHandler extends Handler {
Robert Greenwalt9258c642014-03-26 16:47:06 -07003013 private static final String TAG = "ConnectivityManager.CallbackHandler";
Robert Greenwalta9ebeef2015-09-03 16:41:45 -07003014 private static final boolean DBG = false;
Robert Greenwalt9258c642014-03-26 16:47:06 -07003015
Hugo Benichid42650f2016-07-06 22:53:17 +09003016 CallbackHandler(Looper looper) {
Robert Greenwalt9258c642014-03-26 16:47:06 -07003017 super(looper);
Robert Greenwalt9258c642014-03-26 16:47:06 -07003018 }
3019
Hugo Benichi2583ef02017-02-02 17:02:36 +09003020 CallbackHandler(Handler handler) {
Hugo Benichie7678512017-05-09 15:19:01 +09003021 this(Preconditions.checkNotNull(handler, "Handler cannot be null.").getLooper());
Hugo Benichi2583ef02017-02-02 17:02:36 +09003022 }
3023
Robert Greenwalt9258c642014-03-26 16:47:06 -07003024 @Override
3025 public void handleMessage(Message message) {
Hugo Benichi2c684522017-05-09 14:36:02 +09003026 if (message.what == EXPIRE_LEGACY_REQUEST) {
3027 expireRequest((NetworkCapabilities) message.obj, message.arg1);
3028 return;
3029 }
3030
3031 final NetworkRequest request = getObject(message, NetworkRequest.class);
3032 final Network network = getObject(message, Network.class);
3033 final NetworkCallback callback;
3034 synchronized (sCallbacks) {
3035 callback = sCallbacks.get(request);
3036 }
Lorenzo Colittifcfa7d92016-03-01 22:56:37 +09003037 if (DBG) {
Hugo Benichia0385682017-03-22 17:07:57 +09003038 Log.d(TAG, getCallbackName(message.what) + " for network " + network);
Lorenzo Colittifcfa7d92016-03-01 22:56:37 +09003039 }
Hugo Benichi2c684522017-05-09 14:36:02 +09003040 if (callback == null) {
3041 Log.w(TAG, "callback not found for " + getCallbackName(message.what) + " message");
3042 return;
3043 }
3044
Robert Greenwalt9258c642014-03-26 16:47:06 -07003045 switch (message.what) {
3046 case CALLBACK_PRECHECK: {
Hugo Benichi2c684522017-05-09 14:36:02 +09003047 callback.onPreCheck(network);
Robert Greenwalt9258c642014-03-26 16:47:06 -07003048 break;
3049 }
3050 case CALLBACK_AVAILABLE: {
Chalard Jean804b8fb2018-01-30 22:41:41 +09003051 NetworkCapabilities cap = getObject(message, NetworkCapabilities.class);
3052 LinkProperties lp = getObject(message, LinkProperties.class);
junyulai05986c62018-08-07 19:50:45 +08003053 callback.onAvailable(network, cap, lp, message.arg1 != 0);
Robert Greenwalt9258c642014-03-26 16:47:06 -07003054 break;
3055 }
3056 case CALLBACK_LOSING: {
Hugo Benichi2c684522017-05-09 14:36:02 +09003057 callback.onLosing(network, message.arg1);
Robert Greenwalt9258c642014-03-26 16:47:06 -07003058 break;
3059 }
3060 case CALLBACK_LOST: {
Hugo Benichi2c684522017-05-09 14:36:02 +09003061 callback.onLost(network);
Robert Greenwalt9258c642014-03-26 16:47:06 -07003062 break;
3063 }
3064 case CALLBACK_UNAVAIL: {
Hugo Benichi2c684522017-05-09 14:36:02 +09003065 callback.onUnavailable();
Robert Greenwalt9258c642014-03-26 16:47:06 -07003066 break;
3067 }
3068 case CALLBACK_CAP_CHANGED: {
Hugo Benichi2c684522017-05-09 14:36:02 +09003069 NetworkCapabilities cap = getObject(message, NetworkCapabilities.class);
3070 callback.onCapabilitiesChanged(network, cap);
Robert Greenwalt9258c642014-03-26 16:47:06 -07003071 break;
3072 }
3073 case CALLBACK_IP_CHANGED: {
Hugo Benichi2c684522017-05-09 14:36:02 +09003074 LinkProperties lp = getObject(message, LinkProperties.class);
3075 callback.onLinkPropertiesChanged(network, lp);
Robert Greenwalt9258c642014-03-26 16:47:06 -07003076 break;
3077 }
Robert Greenwalt8d482522015-06-24 13:23:42 -07003078 case CALLBACK_SUSPENDED: {
Hugo Benichi2c684522017-05-09 14:36:02 +09003079 callback.onNetworkSuspended(network);
Robert Greenwalt8d482522015-06-24 13:23:42 -07003080 break;
3081 }
3082 case CALLBACK_RESUMED: {
Hugo Benichi2c684522017-05-09 14:36:02 +09003083 callback.onNetworkResumed(network);
Robert Greenwalt562cc542014-05-15 18:07:26 -07003084 break;
3085 }
junyulai05986c62018-08-07 19:50:45 +08003086 case CALLBACK_BLK_CHANGED: {
3087 boolean blocked = message.arg1 != 0;
3088 callback.onBlockedStatusChanged(network, blocked);
3089 }
Robert Greenwalt9258c642014-03-26 16:47:06 -07003090 }
3091 }
3092
Hugo Benichid42650f2016-07-06 22:53:17 +09003093 private <T> T getObject(Message msg, Class<T> c) {
3094 return (T) msg.getData().getParcelable(c.getSimpleName());
Robert Greenwalt9258c642014-03-26 16:47:06 -07003095 }
Robert Greenwalt9258c642014-03-26 16:47:06 -07003096 }
3097
Hugo Benichi2583ef02017-02-02 17:02:36 +09003098 private CallbackHandler getDefaultHandler() {
Hugo Benichi7724cdd2016-07-07 10:15:56 +09003099 synchronized (sCallbacks) {
3100 if (sCallbackHandler == null) {
3101 sCallbackHandler = new CallbackHandler(ConnectivityThread.getInstanceLooper());
Robert Greenwalt9258c642014-03-26 16:47:06 -07003102 }
Hugo Benichi7724cdd2016-07-07 10:15:56 +09003103 return sCallbackHandler;
Robert Greenwalt9258c642014-03-26 16:47:06 -07003104 }
3105 }
3106
Hugo Benichi6f260f32017-02-03 14:18:44 +09003107 private static final HashMap<NetworkRequest, NetworkCallback> sCallbacks = new HashMap<>();
3108 private static CallbackHandler sCallbackHandler;
Robert Greenwalt9258c642014-03-26 16:47:06 -07003109
Hugo Benichi6f260f32017-02-03 14:18:44 +09003110 private static final int LISTEN = 1;
3111 private static final int REQUEST = 2;
Robert Greenwalt9258c642014-03-26 16:47:06 -07003112
Hugo Benichi6f260f32017-02-03 14:18:44 +09003113 private NetworkRequest sendRequestForNetwork(NetworkCapabilities need, NetworkCallback callback,
3114 int timeoutMs, int action, int legacyType, CallbackHandler handler) {
Soi, Yoshinaridee2aa42015-11-12 12:09:02 +09003115 printStackTrace();
Hugo Benichie7678512017-05-09 15:19:01 +09003116 checkCallbackNotNull(callback);
Hugo Benichidafed3d2017-03-06 09:17:06 +09003117 Preconditions.checkArgument(action == REQUEST || need != null, "null NetworkCapabilities");
Hugo Benichid42650f2016-07-06 22:53:17 +09003118 final NetworkRequest request;
Robert Greenwalt9258c642014-03-26 16:47:06 -07003119 try {
Hugo Benichid42650f2016-07-06 22:53:17 +09003120 synchronized(sCallbacks) {
Hugo Benichi31c176d2017-06-17 13:14:12 +09003121 if (callback.networkRequest != null
3122 && callback.networkRequest != ALREADY_UNREGISTERED) {
Hugo Benichidafed3d2017-03-06 09:17:06 +09003123 // TODO: throw exception instead and enforce 1:1 mapping of callbacks
3124 // and requests (http://b/20701525).
3125 Log.e(TAG, "NetworkCallback was already registered");
3126 }
Hugo Benichi7724cdd2016-07-07 10:15:56 +09003127 Messenger messenger = new Messenger(handler);
Hugo Benichid42650f2016-07-06 22:53:17 +09003128 Binder binder = new Binder();
Paul Jensen7221cc32014-06-27 11:05:32 -04003129 if (action == LISTEN) {
Hugo Benichid42650f2016-07-06 22:53:17 +09003130 request = mService.listenForNetwork(need, messenger, binder);
Paul Jensen7221cc32014-06-27 11:05:32 -04003131 } else {
Hugo Benichid42650f2016-07-06 22:53:17 +09003132 request = mService.requestNetwork(
3133 need, messenger, timeoutMs, binder, legacyType);
Paul Jensen7221cc32014-06-27 11:05:32 -04003134 }
Hugo Benichid42650f2016-07-06 22:53:17 +09003135 if (request != null) {
Hugo Benichi7724cdd2016-07-07 10:15:56 +09003136 sCallbacks.put(request, callback);
Robert Greenwalt9258c642014-03-26 16:47:06 -07003137 }
Hugo Benichi7724cdd2016-07-07 10:15:56 +09003138 callback.networkRequest = request;
Robert Greenwalt9258c642014-03-26 16:47:06 -07003139 }
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07003140 } catch (RemoteException e) {
3141 throw e.rethrowFromSystemServer();
Hugo Benichicb883232017-05-11 13:16:17 +09003142 } catch (ServiceSpecificException e) {
3143 throw convertServiceException(e);
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07003144 }
Hugo Benichid42650f2016-07-06 22:53:17 +09003145 return request;
Robert Greenwalt9258c642014-03-26 16:47:06 -07003146 }
3147
3148 /**
Erik Klinea2d29402016-03-16 15:31:39 +09003149 * Helper function to request a network with a particular legacy type.
Lorenzo Colitti7de289f2015-11-25 12:00:52 +09003150 *
3151 * This is temporarily public @hide so it can be called by system code that uses the
3152 * NetworkRequest API to request networks but relies on CONNECTIVITY_ACTION broadcasts for
3153 * instead network notifications.
3154 *
3155 * TODO: update said system code to rely on NetworkCallbacks and make this method private.
3156 *
3157 * @hide
3158 */
Lorenzo Colittid1179462015-11-25 15:47:14 +09003159 public void requestNetwork(NetworkRequest request, NetworkCallback networkCallback,
Hugo Benichi2583ef02017-02-02 17:02:36 +09003160 int timeoutMs, int legacyType, Handler handler) {
3161 CallbackHandler cbHandler = new CallbackHandler(handler);
3162 NetworkCapabilities nc = request.networkCapabilities;
3163 sendRequestForNetwork(nc, networkCallback, timeoutMs, REQUEST, legacyType, cbHandler);
Lorenzo Colitti7de289f2015-11-25 12:00:52 +09003164 }
3165
3166 /**
Lorenzo Colittie285b432015-04-23 15:32:42 +09003167 * Request a network to satisfy a set of {@link android.net.NetworkCapabilities}.
Robert Greenwalt9258c642014-03-26 16:47:06 -07003168 *
3169 * This {@link NetworkRequest} will live until released via
Etan Cohenaebf17e2017-03-01 12:47:28 -08003170 * {@link #unregisterNetworkCallback(NetworkCallback)} or the calling application exits. A
3171 * version of the method which takes a timeout is
Hugo Benichi0eec03f2017-05-15 15:15:33 +09003172 * {@link #requestNetwork(NetworkRequest, NetworkCallback, int)}.
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07003173 * Status of the request can be followed by listening to the various
Robert Greenwalt6078b502014-06-11 16:05:07 -07003174 * callbacks described in {@link NetworkCallback}. The {@link Network}
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07003175 * can be used to direct traffic to the network.
Paul Jensenbb2e0e92015-06-16 15:11:58 -04003176 * <p>It is presently unsupported to request a network with mutable
3177 * {@link NetworkCapabilities} such as
3178 * {@link NetworkCapabilities#NET_CAPABILITY_VALIDATED} or
3179 * {@link NetworkCapabilities#NET_CAPABILITY_CAPTIVE_PORTAL}
3180 * as these {@code NetworkCapabilities} represent states that a particular
3181 * network may never attain, and whether a network will attain these states
3182 * is unknown prior to bringing up the network so the framework does not
3183 * know how to go about satisfing a request with these capabilities.
Lorenzo Colittid5427052015-10-15 16:29:00 +09003184 *
3185 * <p>This method requires the caller to hold either the
3186 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
3187 * or the ability to modify system settings as determined by
3188 * {@link android.provider.Settings.System#canWrite}.</p>
Robert Greenwalt9258c642014-03-26 16:47:06 -07003189 *
Robert Greenwalt6078b502014-06-11 16:05:07 -07003190 * @param request {@link NetworkRequest} describing this request.
Hugo Benichi2583ef02017-02-02 17:02:36 +09003191 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
3192 * the callback must not be shared - it uniquely specifies this request.
3193 * The callback is invoked on the default internal Handler.
Paul Jensenbb2e0e92015-06-16 15:11:58 -04003194 * @throws IllegalArgumentException if {@code request} specifies any mutable
3195 * {@code NetworkCapabilities}.
Robert Greenwalt9258c642014-03-26 16:47:06 -07003196 */
Robert Greenwalt6078b502014-06-11 16:05:07 -07003197 public void requestNetwork(NetworkRequest request, NetworkCallback networkCallback) {
Hugo Benichi2583ef02017-02-02 17:02:36 +09003198 requestNetwork(request, networkCallback, getDefaultHandler());
3199 }
3200
3201 /**
3202 * Request a network to satisfy a set of {@link android.net.NetworkCapabilities}.
3203 *
3204 * This {@link NetworkRequest} will live until released via
Etan Cohenaebf17e2017-03-01 12:47:28 -08003205 * {@link #unregisterNetworkCallback(NetworkCallback)} or the calling application exits. A
3206 * version of the method which takes a timeout is
Hugo Benichi0eec03f2017-05-15 15:15:33 +09003207 * {@link #requestNetwork(NetworkRequest, NetworkCallback, int)}.
Hugo Benichi2583ef02017-02-02 17:02:36 +09003208 * Status of the request can be followed by listening to the various
3209 * callbacks described in {@link NetworkCallback}. The {@link Network}
3210 * can be used to direct traffic to the network.
3211 * <p>It is presently unsupported to request a network with mutable
3212 * {@link NetworkCapabilities} such as
3213 * {@link NetworkCapabilities#NET_CAPABILITY_VALIDATED} or
3214 * {@link NetworkCapabilities#NET_CAPABILITY_CAPTIVE_PORTAL}
3215 * as these {@code NetworkCapabilities} represent states that a particular
3216 * network may never attain, and whether a network will attain these states
3217 * is unknown prior to bringing up the network so the framework does not
Chalard Jean4d660112018-06-04 16:52:49 +09003218 * know how to go about satisfying a request with these capabilities.
Hugo Benichi2583ef02017-02-02 17:02:36 +09003219 *
3220 * <p>This method requires the caller to hold either the
3221 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
3222 * or the ability to modify system settings as determined by
3223 * {@link android.provider.Settings.System#canWrite}.</p>
3224 *
3225 * @param request {@link NetworkRequest} describing this request.
3226 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
3227 * the callback must not be shared - it uniquely specifies this request.
3228 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
3229 * @throws IllegalArgumentException if {@code request} specifies any mutable
3230 * {@code NetworkCapabilities}.
Hugo Benichi2583ef02017-02-02 17:02:36 +09003231 */
3232 public void requestNetwork(
3233 NetworkRequest request, NetworkCallback networkCallback, Handler handler) {
3234 int legacyType = inferLegacyTypeForNetworkCapabilities(request.networkCapabilities);
3235 CallbackHandler cbHandler = new CallbackHandler(handler);
3236 requestNetwork(request, networkCallback, 0, legacyType, cbHandler);
Robert Greenwalt9258c642014-03-26 16:47:06 -07003237 }
3238
3239 /**
Etan Cohenaebf17e2017-03-01 12:47:28 -08003240 * Request a network to satisfy a set of {@link android.net.NetworkCapabilities}, limited
3241 * by a timeout.
3242 *
3243 * This function behaves identically to the non-timed-out version
3244 * {@link #requestNetwork(NetworkRequest, NetworkCallback)}, but if a suitable network
3245 * is not found within the given time (in milliseconds) the
3246 * {@link NetworkCallback#onUnavailable()} callback is called. The request can still be
3247 * released normally by calling {@link #unregisterNetworkCallback(NetworkCallback)} but does
3248 * not have to be released if timed-out (it is automatically released). Unregistering a
3249 * request that timed out is not an error.
3250 *
3251 * <p>Do not use this method to poll for the existence of specific networks (e.g. with a small
3252 * timeout) - {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)} is provided
3253 * for that purpose. Calling this method will attempt to bring up the requested network.
3254 *
3255 * <p>This method requires the caller to hold either the
3256 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
3257 * or the ability to modify system settings as determined by
3258 * {@link android.provider.Settings.System#canWrite}.</p>
3259 *
3260 * @param request {@link NetworkRequest} describing this request.
Lorenzo Colitti15fd4392017-04-28 00:56:30 +09003261 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
3262 * the callback must not be shared - it uniquely specifies this request.
Etan Cohenaebf17e2017-03-01 12:47:28 -08003263 * @param timeoutMs The time in milliseconds to attempt looking for a suitable network
3264 * before {@link NetworkCallback#onUnavailable()} is called. The timeout must
3265 * be a positive value (i.e. >0).
Etan Cohenaebf17e2017-03-01 12:47:28 -08003266 */
Lorenzo Colitti15fd4392017-04-28 00:56:30 +09003267 public void requestNetwork(NetworkRequest request, NetworkCallback networkCallback,
3268 int timeoutMs) {
Hugo Benichie7678512017-05-09 15:19:01 +09003269 checkTimeout(timeoutMs);
Hugo Benichi2583ef02017-02-02 17:02:36 +09003270 int legacyType = inferLegacyTypeForNetworkCapabilities(request.networkCapabilities);
Erik Klineb583b032017-02-22 12:58:24 +09003271 requestNetwork(request, networkCallback, timeoutMs, legacyType, getDefaultHandler());
Hugo Benichi2583ef02017-02-02 17:02:36 +09003272 }
3273
Hugo Benichi2583ef02017-02-02 17:02:36 +09003274 /**
3275 * Request a network to satisfy a set of {@link android.net.NetworkCapabilities}, limited
3276 * by a timeout.
3277 *
Chalard Jean4d660112018-06-04 16:52:49 +09003278 * This function behaves identically to the version without timeout, but if a suitable
Hugo Benichi2583ef02017-02-02 17:02:36 +09003279 * network is not found within the given time (in milliseconds) the
Etan Cohenaebf17e2017-03-01 12:47:28 -08003280 * {@link NetworkCallback#onUnavailable} callback is called. The request can still be
3281 * released normally by calling {@link #unregisterNetworkCallback(NetworkCallback)} but does
3282 * not have to be released if timed-out (it is automatically released). Unregistering a
3283 * request that timed out is not an error.
3284 *
3285 * <p>Do not use this method to poll for the existence of specific networks (e.g. with a small
3286 * timeout) - {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)} is provided
3287 * for that purpose. Calling this method will attempt to bring up the requested network.
Hugo Benichi2583ef02017-02-02 17:02:36 +09003288 *
3289 * <p>This method requires the caller to hold either the
3290 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
3291 * or the ability to modify system settings as determined by
3292 * {@link android.provider.Settings.System#canWrite}.</p>
3293 *
3294 * @param request {@link NetworkRequest} describing this request.
Etan Cohenaebf17e2017-03-01 12:47:28 -08003295 * @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
3296 * the callback must not be shared - it uniquely specifies this request.
Hugo Benichi2583ef02017-02-02 17:02:36 +09003297 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
Lorenzo Colitti15fd4392017-04-28 00:56:30 +09003298 * @param timeoutMs The time in milliseconds to attempt looking for a suitable network
3299 * before {@link NetworkCallback#onUnavailable} is called.
Hugo Benichi2583ef02017-02-02 17:02:36 +09003300 */
Lorenzo Colitti15fd4392017-04-28 00:56:30 +09003301 public void requestNetwork(NetworkRequest request, NetworkCallback networkCallback,
3302 Handler handler, int timeoutMs) {
Hugo Benichie7678512017-05-09 15:19:01 +09003303 checkTimeout(timeoutMs);
Hugo Benichi2583ef02017-02-02 17:02:36 +09003304 int legacyType = inferLegacyTypeForNetworkCapabilities(request.networkCapabilities);
3305 CallbackHandler cbHandler = new CallbackHandler(handler);
3306 requestNetwork(request, networkCallback, timeoutMs, legacyType, cbHandler);
Robert Greenwalt9258c642014-03-26 16:47:06 -07003307 }
3308
3309 /**
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07003310 * The lookup key for a {@link Network} object included with the intent after
Jeremy Joslin46e3ac82014-11-05 10:32:09 -08003311 * successfully finding a network for the applications request. Retrieve it with
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07003312 * {@link android.content.Intent#getParcelableExtra(String)}.
Jeremy Joslinfcde58f2015-02-11 16:51:13 -08003313 * <p>
Paul Jensen72db88e2015-03-10 10:54:12 -04003314 * Note that if you intend to invoke {@link Network#openConnection(java.net.URL)}
3315 * then you must get a ConnectivityManager instance before doing so.
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07003316 */
Erik Kline90e93072014-11-19 12:12:24 +09003317 public static final String EXTRA_NETWORK = "android.net.extra.NETWORK";
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07003318
3319 /**
Robert Greenwalt6078b502014-06-11 16:05:07 -07003320 * The lookup key for a {@link NetworkRequest} object included with the intent after
Jeremy Joslin46e3ac82014-11-05 10:32:09 -08003321 * successfully finding a network for the applications request. Retrieve it with
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07003322 * {@link android.content.Intent#getParcelableExtra(String)}.
3323 */
Erik Kline90e93072014-11-19 12:12:24 +09003324 public static final String EXTRA_NETWORK_REQUEST = "android.net.extra.NETWORK_REQUEST";
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07003325
3326
3327 /**
Lorenzo Colittie285b432015-04-23 15:32:42 +09003328 * Request a network to satisfy a set of {@link android.net.NetworkCapabilities}.
Robert Greenwalt9258c642014-03-26 16:47:06 -07003329 *
Jeremy Joslin46e3ac82014-11-05 10:32:09 -08003330 * This function behaves identically to the version that takes a NetworkCallback, but instead
Robert Greenwalt6078b502014-06-11 16:05:07 -07003331 * of {@link NetworkCallback} a {@link PendingIntent} is used. This means
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07003332 * the request may outlive the calling application and get called back when a suitable
3333 * network is found.
Robert Greenwalt9258c642014-03-26 16:47:06 -07003334 * <p>
3335 * The operation is an Intent broadcast that goes to a broadcast receiver that
3336 * you registered with {@link Context#registerReceiver} or through the
3337 * &lt;receiver&gt; tag in an AndroidManifest.xml file
3338 * <p>
3339 * The operation Intent is delivered with two extras, a {@link Network} typed
Erik Kline90e93072014-11-19 12:12:24 +09003340 * extra called {@link #EXTRA_NETWORK} and a {@link NetworkRequest}
3341 * typed extra called {@link #EXTRA_NETWORK_REQUEST} containing
Robert Greenwalt9258c642014-03-26 16:47:06 -07003342 * the original requests parameters. It is important to create a new,
Robert Greenwalt6078b502014-06-11 16:05:07 -07003343 * {@link NetworkCallback} based request before completing the processing of the
Robert Greenwalt9258c642014-03-26 16:47:06 -07003344 * Intent to reserve the network or it will be released shortly after the Intent
3345 * is processed.
3346 * <p>
Paul Jensen694f2b82015-06-17 14:15:39 -04003347 * If there is already a request for this Intent registered (with the equality of
Robert Greenwalt9258c642014-03-26 16:47:06 -07003348 * two Intents defined by {@link Intent#filterEquals}), then it will be removed and
Robert Greenwaltd19c41c2014-05-18 23:07:25 -07003349 * replaced by this one, effectively releasing the previous {@link NetworkRequest}.
Robert Greenwalt9258c642014-03-26 16:47:06 -07003350 * <p>
Jeremy Joslin46e3ac82014-11-05 10:32:09 -08003351 * The request may be released normally by calling
3352 * {@link #releaseNetworkRequest(android.app.PendingIntent)}.
Paul Jensenbb2e0e92015-06-16 15:11:58 -04003353 * <p>It is presently unsupported to request a network with either
3354 * {@link NetworkCapabilities#NET_CAPABILITY_VALIDATED} or
3355 * {@link NetworkCapabilities#NET_CAPABILITY_CAPTIVE_PORTAL}
3356 * as these {@code NetworkCapabilities} represent states that a particular
3357 * network may never attain, and whether a network will attain these states
3358 * is unknown prior to bringing up the network so the framework does not
Chalard Jean4d660112018-06-04 16:52:49 +09003359 * know how to go about satisfying a request with these capabilities.
Lorenzo Colittid5427052015-10-15 16:29:00 +09003360 *
3361 * <p>This method requires the caller to hold either the
3362 * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
3363 * or the ability to modify system settings as determined by
3364 * {@link android.provider.Settings.System#canWrite}.</p>
3365 *
Robert Greenwalt6078b502014-06-11 16:05:07 -07003366 * @param request {@link NetworkRequest} describing this request.
Robert Greenwalt9258c642014-03-26 16:47:06 -07003367 * @param operation Action to perform when the network is available (corresponds
Robert Greenwalt6078b502014-06-11 16:05:07 -07003368 * to the {@link NetworkCallback#onAvailable} call. Typically
Jeremy Joslin46e3ac82014-11-05 10:32:09 -08003369 * comes from {@link PendingIntent#getBroadcast}. Cannot be null.
Paul Jensenbb2e0e92015-06-16 15:11:58 -04003370 * @throws IllegalArgumentException if {@code request} contains either
3371 * {@link NetworkCapabilities#NET_CAPABILITY_VALIDATED} or
3372 * {@link NetworkCapabilities#NET_CAPABILITY_CAPTIVE_PORTAL}.
Robert Greenwalt9258c642014-03-26 16:47:06 -07003373 */
Robert Greenwalt6078b502014-06-11 16:05:07 -07003374 public void requestNetwork(NetworkRequest request, PendingIntent operation) {
Soi, Yoshinaridee2aa42015-11-12 12:09:02 +09003375 printStackTrace();
Hugo Benichie7678512017-05-09 15:19:01 +09003376 checkPendingIntentNotNull(operation);
Robert Greenwalt9258c642014-03-26 16:47:06 -07003377 try {
Robert Greenwalt6078b502014-06-11 16:05:07 -07003378 mService.pendingRequestForNetwork(request.networkCapabilities, operation);
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07003379 } catch (RemoteException e) {
3380 throw e.rethrowFromSystemServer();
Hugo Benichicb883232017-05-11 13:16:17 +09003381 } catch (ServiceSpecificException e) {
3382 throw convertServiceException(e);
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07003383 }
Robert Greenwalt9258c642014-03-26 16:47:06 -07003384 }
3385
3386 /**
Jeremy Joslin46e3ac82014-11-05 10:32:09 -08003387 * Removes a request made via {@link #requestNetwork(NetworkRequest, android.app.PendingIntent)}
3388 * <p>
Lorenzo Colitti88bc0bb2016-04-13 22:00:02 +09003389 * This method has the same behavior as
3390 * {@link #unregisterNetworkCallback(android.app.PendingIntent)} with respect to
Jeremy Joslin46e3ac82014-11-05 10:32:09 -08003391 * releasing network resources and disconnecting.
3392 *
3393 * @param operation A PendingIntent equal (as defined by {@link Intent#filterEquals}) to the
3394 * PendingIntent passed to
3395 * {@link #requestNetwork(NetworkRequest, android.app.PendingIntent)} with the
3396 * corresponding NetworkRequest you'd like to remove. Cannot be null.
3397 */
3398 public void releaseNetworkRequest(PendingIntent operation) {
Soi, Yoshinaridee2aa42015-11-12 12:09:02 +09003399 printStackTrace();
Hugo Benichie7678512017-05-09 15:19:01 +09003400 checkPendingIntentNotNull(operation);
Jeremy Joslin46e3ac82014-11-05 10:32:09 -08003401 try {
3402 mService.releasePendingNetworkRequest(operation);
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07003403 } catch (RemoteException e) {
3404 throw e.rethrowFromSystemServer();
3405 }
Jeremy Joslin46e3ac82014-11-05 10:32:09 -08003406 }
3407
Hugo Benichie7678512017-05-09 15:19:01 +09003408 private static void checkPendingIntentNotNull(PendingIntent intent) {
3409 Preconditions.checkNotNull(intent, "PendingIntent cannot be null.");
3410 }
3411
3412 private static void checkCallbackNotNull(NetworkCallback callback) {
3413 Preconditions.checkNotNull(callback, "null NetworkCallback");
3414 }
3415
3416 private static void checkTimeout(int timeoutMs) {
3417 Preconditions.checkArgumentPositive(timeoutMs, "timeoutMs must be strictly positive.");
Jeremy Joslin46e3ac82014-11-05 10:32:09 -08003418 }
3419
3420 /**
Robert Greenwalt9258c642014-03-26 16:47:06 -07003421 * Registers to receive notifications about all networks which satisfy the given
Robert Greenwalt6078b502014-06-11 16:05:07 -07003422 * {@link NetworkRequest}. The callbacks will continue to be called until
Lorenzo Colitti88bc0bb2016-04-13 22:00:02 +09003423 * either the application exits or link #unregisterNetworkCallback(NetworkCallback)} is called.
Robert Greenwalt9258c642014-03-26 16:47:06 -07003424 *
Robert Greenwalt6078b502014-06-11 16:05:07 -07003425 * @param request {@link NetworkRequest} describing this request.
3426 * @param networkCallback The {@link NetworkCallback} that the system will call as suitable
3427 * networks change state.
Hugo Benichi2583ef02017-02-02 17:02:36 +09003428 * The callback is invoked on the default internal Handler.
Robert Greenwalt9258c642014-03-26 16:47:06 -07003429 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06003430 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Robert Greenwalt6078b502014-06-11 16:05:07 -07003431 public void registerNetworkCallback(NetworkRequest request, NetworkCallback networkCallback) {
Hugo Benichi2583ef02017-02-02 17:02:36 +09003432 registerNetworkCallback(request, networkCallback, getDefaultHandler());
3433 }
3434
3435 /**
3436 * Registers to receive notifications about all networks which satisfy the given
3437 * {@link NetworkRequest}. The callbacks will continue to be called until
3438 * either the application exits or link #unregisterNetworkCallback(NetworkCallback)} is called.
Hugo Benichi2583ef02017-02-02 17:02:36 +09003439 *
3440 * @param request {@link NetworkRequest} describing this request.
3441 * @param networkCallback The {@link NetworkCallback} that the system will call as suitable
3442 * networks change state.
3443 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
Hugo Benichi2583ef02017-02-02 17:02:36 +09003444 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06003445 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Hugo Benichi2583ef02017-02-02 17:02:36 +09003446 public void registerNetworkCallback(
3447 NetworkRequest request, NetworkCallback networkCallback, Handler handler) {
3448 CallbackHandler cbHandler = new CallbackHandler(handler);
3449 NetworkCapabilities nc = request.networkCapabilities;
3450 sendRequestForNetwork(nc, networkCallback, 0, LISTEN, TYPE_NONE, cbHandler);
Robert Greenwalt9258c642014-03-26 16:47:06 -07003451 }
3452
3453 /**
Paul Jensen694f2b82015-06-17 14:15:39 -04003454 * Registers a PendingIntent to be sent when a network is available which satisfies the given
3455 * {@link NetworkRequest}.
3456 *
3457 * This function behaves identically to the version that takes a NetworkCallback, but instead
3458 * of {@link NetworkCallback} a {@link PendingIntent} is used. This means
3459 * the request may outlive the calling application and get called back when a suitable
3460 * network is found.
3461 * <p>
3462 * The operation is an Intent broadcast that goes to a broadcast receiver that
3463 * you registered with {@link Context#registerReceiver} or through the
3464 * &lt;receiver&gt; tag in an AndroidManifest.xml file
3465 * <p>
3466 * The operation Intent is delivered with two extras, a {@link Network} typed
3467 * extra called {@link #EXTRA_NETWORK} and a {@link NetworkRequest}
3468 * typed extra called {@link #EXTRA_NETWORK_REQUEST} containing
3469 * the original requests parameters.
3470 * <p>
3471 * If there is already a request for this Intent registered (with the equality of
3472 * two Intents defined by {@link Intent#filterEquals}), then it will be removed and
3473 * replaced by this one, effectively releasing the previous {@link NetworkRequest}.
3474 * <p>
3475 * The request may be released normally by calling
Paul Jensenf2c1cfe2015-06-30 14:29:18 -04003476 * {@link #unregisterNetworkCallback(android.app.PendingIntent)}.
Paul Jensen694f2b82015-06-17 14:15:39 -04003477 * @param request {@link NetworkRequest} describing this request.
3478 * @param operation Action to perform when the network is available (corresponds
3479 * to the {@link NetworkCallback#onAvailable} call. Typically
3480 * comes from {@link PendingIntent#getBroadcast}. Cannot be null.
3481 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06003482 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Paul Jensen694f2b82015-06-17 14:15:39 -04003483 public void registerNetworkCallback(NetworkRequest request, PendingIntent operation) {
Soi, Yoshinaridee2aa42015-11-12 12:09:02 +09003484 printStackTrace();
Hugo Benichie7678512017-05-09 15:19:01 +09003485 checkPendingIntentNotNull(operation);
Paul Jensen694f2b82015-06-17 14:15:39 -04003486 try {
3487 mService.pendingListenForNetwork(request.networkCapabilities, operation);
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07003488 } catch (RemoteException e) {
3489 throw e.rethrowFromSystemServer();
Hugo Benichicb883232017-05-11 13:16:17 +09003490 } catch (ServiceSpecificException e) {
3491 throw convertServiceException(e);
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07003492 }
Paul Jensen694f2b82015-06-17 14:15:39 -04003493 }
3494
3495 /**
Lorenzo Colitti88bc0bb2016-04-13 22:00:02 +09003496 * Registers to receive notifications about changes in the system default network. The callbacks
3497 * will continue to be called until either the application exits or
3498 * {@link #unregisterNetworkCallback(NetworkCallback)} is called.
Erik Klinea2d29402016-03-16 15:31:39 +09003499 *
3500 * @param networkCallback The {@link NetworkCallback} that the system will call as the
3501 * system default network changes.
Hugo Benichi2583ef02017-02-02 17:02:36 +09003502 * The callback is invoked on the default internal Handler.
Erik Klinea2d29402016-03-16 15:31:39 +09003503 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06003504 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Erik Klinea2d29402016-03-16 15:31:39 +09003505 public void registerDefaultNetworkCallback(NetworkCallback networkCallback) {
Hugo Benichi2583ef02017-02-02 17:02:36 +09003506 registerDefaultNetworkCallback(networkCallback, getDefaultHandler());
3507 }
3508
3509 /**
3510 * Registers to receive notifications about changes in the system default network. The callbacks
3511 * will continue to be called until either the application exits or
3512 * {@link #unregisterNetworkCallback(NetworkCallback)} is called.
Hugo Benichi2583ef02017-02-02 17:02:36 +09003513 *
3514 * @param networkCallback The {@link NetworkCallback} that the system will call as the
3515 * system default network changes.
3516 * @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
Hugo Benichi2583ef02017-02-02 17:02:36 +09003517 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06003518 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Hugo Benichi2583ef02017-02-02 17:02:36 +09003519 public void registerDefaultNetworkCallback(NetworkCallback networkCallback, Handler handler) {
Erik Klinea2d29402016-03-16 15:31:39 +09003520 // This works because if the NetworkCapabilities are null,
3521 // ConnectivityService takes them from the default request.
3522 //
3523 // Since the capabilities are exactly the same as the default request's
3524 // capabilities, this request is guaranteed, at all times, to be
3525 // satisfied by the same network, if any, that satisfies the default
3526 // request, i.e., the system default network.
Hugo Benichi2583ef02017-02-02 17:02:36 +09003527 CallbackHandler cbHandler = new CallbackHandler(handler);
Chalard Jean4d660112018-06-04 16:52:49 +09003528 sendRequestForNetwork(null /* NetworkCapabilities need */, networkCallback, 0,
3529 REQUEST, TYPE_NONE, cbHandler);
Erik Klinea2d29402016-03-16 15:31:39 +09003530 }
3531
3532 /**
fengludb571472015-04-21 17:12:05 -07003533 * Requests bandwidth update for a given {@link Network} and returns whether the update request
3534 * is accepted by ConnectivityService. Once accepted, ConnectivityService will poll underlying
3535 * network connection for updated bandwidth information. The caller will be notified via
3536 * {@link ConnectivityManager.NetworkCallback} if there is an update. Notice that this
Lorenzo Colitti88bc0bb2016-04-13 22:00:02 +09003537 * method assumes that the caller has previously called
3538 * {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)} to listen for network
3539 * changes.
fenglub15e72b2015-03-20 11:29:56 -07003540 *
fengluae519192015-04-27 14:28:04 -07003541 * @param network {@link Network} specifying which network you're interested.
fengludb571472015-04-21 17:12:05 -07003542 * @return {@code true} on success, {@code false} if the {@link Network} is no longer valid.
fenglub15e72b2015-03-20 11:29:56 -07003543 */
fengludb571472015-04-21 17:12:05 -07003544 public boolean requestBandwidthUpdate(Network network) {
fenglub15e72b2015-03-20 11:29:56 -07003545 try {
fengludb571472015-04-21 17:12:05 -07003546 return mService.requestBandwidthUpdate(network);
fenglub15e72b2015-03-20 11:29:56 -07003547 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07003548 throw e.rethrowFromSystemServer();
fenglub15e72b2015-03-20 11:29:56 -07003549 }
3550 }
3551
3552 /**
Hugo Benichidafed3d2017-03-06 09:17:06 +09003553 * Unregisters a {@code NetworkCallback} and possibly releases networks originating from
Lorenzo Colitti88bc0bb2016-04-13 22:00:02 +09003554 * {@link #requestNetwork(NetworkRequest, NetworkCallback)} and
3555 * {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)} calls.
3556 * If the given {@code NetworkCallback} had previously been used with
Lorenzo Colitti2ea89e52015-04-24 17:03:31 +09003557 * {@code #requestNetwork}, any networks that had been connected to only to satisfy that request
3558 * will be disconnected.
Robert Greenwalt9258c642014-03-26 16:47:06 -07003559 *
Hugo Benichidafed3d2017-03-06 09:17:06 +09003560 * Notifications that would have triggered that {@code NetworkCallback} will immediately stop
3561 * triggering it as soon as this call returns.
3562 *
Robert Greenwalt6078b502014-06-11 16:05:07 -07003563 * @param networkCallback The {@link NetworkCallback} used when making the request.
Robert Greenwalt9258c642014-03-26 16:47:06 -07003564 */
Robert Greenwalt6078b502014-06-11 16:05:07 -07003565 public void unregisterNetworkCallback(NetworkCallback networkCallback) {
Soi, Yoshinaridee2aa42015-11-12 12:09:02 +09003566 printStackTrace();
Hugo Benichie7678512017-05-09 15:19:01 +09003567 checkCallbackNotNull(networkCallback);
Hugo Benichidafed3d2017-03-06 09:17:06 +09003568 final List<NetworkRequest> reqs = new ArrayList<>();
3569 // Find all requests associated to this callback and stop callback triggers immediately.
3570 // Callback is reusable immediately. http://b/20701525, http://b/35921499.
3571 synchronized (sCallbacks) {
Hugo Benichi31c176d2017-06-17 13:14:12 +09003572 Preconditions.checkArgument(networkCallback.networkRequest != null,
3573 "NetworkCallback was not registered");
3574 Preconditions.checkArgument(networkCallback.networkRequest != ALREADY_UNREGISTERED,
3575 "NetworkCallback was already unregistered");
Hugo Benichidafed3d2017-03-06 09:17:06 +09003576 for (Map.Entry<NetworkRequest, NetworkCallback> e : sCallbacks.entrySet()) {
3577 if (e.getValue() == networkCallback) {
3578 reqs.add(e.getKey());
3579 }
3580 }
3581 // TODO: throw exception if callback was registered more than once (http://b/20701525).
3582 for (NetworkRequest r : reqs) {
3583 try {
3584 mService.releaseNetworkRequest(r);
3585 } catch (RemoteException e) {
3586 throw e.rethrowFromSystemServer();
3587 }
3588 // Only remove mapping if rpc was successful.
3589 sCallbacks.remove(r);
3590 }
Hugo Benichi31c176d2017-06-17 13:14:12 +09003591 networkCallback.networkRequest = ALREADY_UNREGISTERED;
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07003592 }
Robert Greenwalt9258c642014-03-26 16:47:06 -07003593 }
Paul Jensen6d3ff9e2014-05-29 10:12:39 -04003594
3595 /**
Paul Jensenf2c1cfe2015-06-30 14:29:18 -04003596 * Unregisters a callback previously registered via
3597 * {@link #registerNetworkCallback(NetworkRequest, android.app.PendingIntent)}.
3598 *
3599 * @param operation A PendingIntent equal (as defined by {@link Intent#filterEquals}) to the
3600 * PendingIntent passed to
3601 * {@link #registerNetworkCallback(NetworkRequest, android.app.PendingIntent)}.
3602 * Cannot be null.
3603 */
3604 public void unregisterNetworkCallback(PendingIntent operation) {
Hugo Benichie7678512017-05-09 15:19:01 +09003605 checkPendingIntentNotNull(operation);
Paul Jensenf2c1cfe2015-06-30 14:29:18 -04003606 releaseNetworkRequest(operation);
3607 }
3608
3609 /**
Lorenzo Colittie03c3c72015-04-03 16:38:52 +09003610 * Informs the system whether it should switch to {@code network} regardless of whether it is
3611 * validated or not. If {@code accept} is true, and the network was explicitly selected by the
3612 * user (e.g., by selecting a Wi-Fi network in the Settings app), then the network will become
3613 * the system default network regardless of any other network that's currently connected. If
3614 * {@code always} is true, then the choice is remembered, so that the next time the user
3615 * connects to this network, the system will switch to it.
3616 *
Lorenzo Colittie03c3c72015-04-03 16:38:52 +09003617 * @param network The network to accept.
3618 * @param accept Whether to accept the network even if unvalidated.
3619 * @param always Whether to remember this choice in the future.
3620 *
3621 * @hide
3622 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06003623 @RequiresPermission(android.Manifest.permission.CONNECTIVITY_INTERNAL)
Lorenzo Colittie03c3c72015-04-03 16:38:52 +09003624 public void setAcceptUnvalidated(Network network, boolean accept, boolean always) {
3625 try {
3626 mService.setAcceptUnvalidated(network, accept, always);
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07003627 } catch (RemoteException e) {
3628 throw e.rethrowFromSystemServer();
3629 }
Lorenzo Colittie03c3c72015-04-03 16:38:52 +09003630 }
3631
3632 /**
Lorenzo Colitti165c51c2016-09-19 01:00:19 +09003633 * Informs the system to penalize {@code network}'s score when it becomes unvalidated. This is
3634 * only meaningful if the system is configured not to penalize such networks, e.g., if the
3635 * {@code config_networkAvoidBadWifi} configuration variable is set to 0 and the {@code
3636 * NETWORK_AVOID_BAD_WIFI setting is unset}.
3637 *
Lorenzo Colitti165c51c2016-09-19 01:00:19 +09003638 * @param network The network to accept.
3639 *
3640 * @hide
3641 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06003642 @RequiresPermission(android.Manifest.permission.CONNECTIVITY_INTERNAL)
Lorenzo Colitti165c51c2016-09-19 01:00:19 +09003643 public void setAvoidUnvalidated(Network network) {
3644 try {
3645 mService.setAvoidUnvalidated(network);
3646 } catch (RemoteException e) {
3647 throw e.rethrowFromSystemServer();
3648 }
3649 }
3650
3651 /**
Lorenzo Colitti4734cdb2017-04-27 14:30:21 +09003652 * Requests that the system open the captive portal app on the specified network.
3653 *
3654 * @param network The network to log into.
3655 *
3656 * @hide
3657 */
3658 @RequiresPermission(android.Manifest.permission.CONNECTIVITY_INTERNAL)
3659 public void startCaptivePortalApp(Network network) {
3660 try {
3661 mService.startCaptivePortalApp(network);
3662 } catch (RemoteException e) {
3663 throw e.rethrowFromSystemServer();
3664 }
3665 }
3666
3667 /**
Lorenzo Colitti2de49252017-01-24 18:08:41 +09003668 * It is acceptable to briefly use multipath data to provide seamless connectivity for
3669 * time-sensitive user-facing operations when the system default network is temporarily
Lorenzo Colitti15fd4392017-04-28 00:56:30 +09003670 * unresponsive. The amount of data should be limited (less than one megabyte for every call to
3671 * this method), and the operation should be infrequent to ensure that data usage is limited.
Lorenzo Colitti2de49252017-01-24 18:08:41 +09003672 *
3673 * An example of such an operation might be a time-sensitive foreground activity, such as a
3674 * voice command, that the user is performing while walking out of range of a Wi-Fi network.
3675 */
3676 public static final int MULTIPATH_PREFERENCE_HANDOVER = 1 << 0;
3677
3678 /**
3679 * It is acceptable to use small amounts of multipath data on an ongoing basis to provide
3680 * a backup channel for traffic that is primarily going over another network.
3681 *
3682 * An example might be maintaining backup connections to peers or servers for the purpose of
3683 * fast fallback if the default network is temporarily unresponsive or disconnects. The traffic
3684 * on backup paths should be negligible compared to the traffic on the main path.
3685 */
3686 public static final int MULTIPATH_PREFERENCE_RELIABILITY = 1 << 1;
3687
3688 /**
3689 * It is acceptable to use metered data to improve network latency and performance.
3690 */
3691 public static final int MULTIPATH_PREFERENCE_PERFORMANCE = 1 << 2;
3692
3693 /**
3694 * Return value to use for unmetered networks. On such networks we currently set all the flags
3695 * to true.
3696 * @hide
3697 */
3698 public static final int MULTIPATH_PREFERENCE_UNMETERED =
3699 MULTIPATH_PREFERENCE_HANDOVER |
3700 MULTIPATH_PREFERENCE_RELIABILITY |
3701 MULTIPATH_PREFERENCE_PERFORMANCE;
3702
3703 /** @hide */
3704 @Retention(RetentionPolicy.SOURCE)
3705 @IntDef(flag = true, value = {
3706 MULTIPATH_PREFERENCE_HANDOVER,
3707 MULTIPATH_PREFERENCE_RELIABILITY,
3708 MULTIPATH_PREFERENCE_PERFORMANCE,
3709 })
3710 public @interface MultipathPreference {
3711 }
3712
3713 /**
3714 * Provides a hint to the calling application on whether it is desirable to use the
3715 * multinetwork APIs (e.g., {@link Network#openConnection}, {@link Network#bindSocket}, etc.)
3716 * for multipath data transfer on this network when it is not the system default network.
3717 * Applications desiring to use multipath network protocols should call this method before
3718 * each such operation.
Lorenzo Colitti2de49252017-01-24 18:08:41 +09003719 *
3720 * @param network The network on which the application desires to use multipath data.
3721 * If {@code null}, this method will return the a preference that will generally
3722 * apply to metered networks.
3723 * @return a bitwise OR of zero or more of the {@code MULTIPATH_PREFERENCE_*} constants.
3724 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06003725 @RequiresPermission(android.Manifest.permission.ACCESS_NETWORK_STATE)
Lorenzo Colitti2de49252017-01-24 18:08:41 +09003726 public @MultipathPreference int getMultipathPreference(Network network) {
3727 try {
3728 return mService.getMultipathPreference(network);
3729 } catch (RemoteException e) {
3730 throw e.rethrowFromSystemServer();
3731 }
3732 }
3733
3734 /**
Stuart Scott984dc852015-03-30 13:17:11 -07003735 * Resets all connectivity manager settings back to factory defaults.
3736 * @hide
3737 */
3738 public void factoryReset() {
Stuart Scott984dc852015-03-30 13:17:11 -07003739 try {
Stuart Scottf1fb3972015-04-02 18:00:02 -07003740 mService.factoryReset();
Stuart Scott984dc852015-03-30 13:17:11 -07003741 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07003742 throw e.rethrowFromSystemServer();
Stuart Scott984dc852015-03-30 13:17:11 -07003743 }
3744 }
3745
3746 /**
Paul Jensen6d3ff9e2014-05-29 10:12:39 -04003747 * Binds the current process to {@code network}. All Sockets created in the future
3748 * (and not explicitly bound via a bound SocketFactory from
3749 * {@link Network#getSocketFactory() Network.getSocketFactory()}) will be bound to
3750 * {@code network}. All host name resolutions will be limited to {@code network} as well.
3751 * Note that if {@code network} ever disconnects, all Sockets created in this way will cease to
3752 * work and all host name resolutions will fail. This is by design so an application doesn't
3753 * accidentally use Sockets it thinks are still bound to a particular {@link Network}.
3754 * To clear binding pass {@code null} for {@code network}. Using individually bound
3755 * Sockets created by Network.getSocketFactory().createSocket() and
3756 * performing network-specific host name resolutions via
3757 * {@link Network#getAllByName Network.getAllByName} is preferred to calling
Paul Jensen72db88e2015-03-10 10:54:12 -04003758 * {@code bindProcessToNetwork}.
Paul Jensen6d3ff9e2014-05-29 10:12:39 -04003759 *
3760 * @param network The {@link Network} to bind the current process to, or {@code null} to clear
3761 * the current binding.
3762 * @return {@code true} on success, {@code false} if the {@link Network} is no longer valid.
3763 */
Paul Jensen72db88e2015-03-10 10:54:12 -04003764 public boolean bindProcessToNetwork(Network network) {
Chalard Jean4d660112018-06-04 16:52:49 +09003765 // Forcing callers to call through non-static function ensures ConnectivityManager
Paul Jensen72db88e2015-03-10 10:54:12 -04003766 // instantiated.
3767 return setProcessDefaultNetwork(network);
3768 }
3769
3770 /**
3771 * Binds the current process to {@code network}. All Sockets created in the future
3772 * (and not explicitly bound via a bound SocketFactory from
3773 * {@link Network#getSocketFactory() Network.getSocketFactory()}) will be bound to
3774 * {@code network}. All host name resolutions will be limited to {@code network} as well.
3775 * Note that if {@code network} ever disconnects, all Sockets created in this way will cease to
3776 * work and all host name resolutions will fail. This is by design so an application doesn't
3777 * accidentally use Sockets it thinks are still bound to a particular {@link Network}.
3778 * To clear binding pass {@code null} for {@code network}. Using individually bound
3779 * Sockets created by Network.getSocketFactory().createSocket() and
3780 * performing network-specific host name resolutions via
3781 * {@link Network#getAllByName Network.getAllByName} is preferred to calling
3782 * {@code setProcessDefaultNetwork}.
3783 *
3784 * @param network The {@link Network} to bind the current process to, or {@code null} to clear
3785 * the current binding.
3786 * @return {@code true} on success, {@code false} if the {@link Network} is no longer valid.
3787 * @deprecated This function can throw {@link IllegalStateException}. Use
3788 * {@link #bindProcessToNetwork} instead. {@code bindProcessToNetwork}
3789 * is a direct replacement.
3790 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07003791 @Deprecated
Paul Jensen6d3ff9e2014-05-29 10:12:39 -04003792 public static boolean setProcessDefaultNetwork(Network network) {
Paul Jensenc91b5342014-08-27 12:38:45 -04003793 int netId = (network == null) ? NETID_UNSET : network.netId;
Paul Jensen72db88e2015-03-10 10:54:12 -04003794 if (netId == NetworkUtils.getBoundNetworkForProcess()) {
Paul Jensenc91b5342014-08-27 12:38:45 -04003795 return true;
3796 }
3797 if (NetworkUtils.bindProcessToNetwork(netId)) {
Paul Jensene0bef712014-12-10 15:12:18 -05003798 // Set HTTP proxy system properties to match network.
3799 // TODO: Deprecate this static method and replace it with a non-static version.
Lorenzo Colittiec4c5552015-04-22 11:52:48 +09003800 try {
3801 Proxy.setHttpProxySystemProperty(getInstance().getDefaultProxy());
3802 } catch (SecurityException e) {
3803 // The process doesn't have ACCESS_NETWORK_STATE, so we can't fetch the proxy.
3804 Log.e(TAG, "Can't set proxy properties", e);
3805 }
Paul Jensenc91b5342014-08-27 12:38:45 -04003806 // Must flush DNS cache as new network may have different DNS resolutions.
3807 InetAddress.clearDnsCache();
3808 // Must flush socket pool as idle sockets will be bound to previous network and may
3809 // cause subsequent fetches to be performed on old network.
3810 NetworkEventDispatcher.getInstance().onNetworkConfigurationChanged();
3811 return true;
3812 } else {
3813 return false;
3814 }
Paul Jensen6d3ff9e2014-05-29 10:12:39 -04003815 }
3816
3817 /**
3818 * Returns the {@link Network} currently bound to this process via
Paul Jensen72db88e2015-03-10 10:54:12 -04003819 * {@link #bindProcessToNetwork}, or {@code null} if no {@link Network} is explicitly bound.
Paul Jensen6d3ff9e2014-05-29 10:12:39 -04003820 *
3821 * @return {@code Network} to which this process is bound, or {@code null}.
3822 */
Paul Jensen72db88e2015-03-10 10:54:12 -04003823 public Network getBoundNetworkForProcess() {
3824 // Forcing callers to call thru non-static function ensures ConnectivityManager
3825 // instantiated.
3826 return getProcessDefaultNetwork();
3827 }
3828
3829 /**
3830 * Returns the {@link Network} currently bound to this process via
3831 * {@link #bindProcessToNetwork}, or {@code null} if no {@link Network} is explicitly bound.
3832 *
3833 * @return {@code Network} to which this process is bound, or {@code null}.
3834 * @deprecated Using this function can lead to other functions throwing
3835 * {@link IllegalStateException}. Use {@link #getBoundNetworkForProcess} instead.
3836 * {@code getBoundNetworkForProcess} is a direct replacement.
3837 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07003838 @Deprecated
Paul Jensen6d3ff9e2014-05-29 10:12:39 -04003839 public static Network getProcessDefaultNetwork() {
Paul Jensen72db88e2015-03-10 10:54:12 -04003840 int netId = NetworkUtils.getBoundNetworkForProcess();
Paul Jensenbcc76d32014-07-11 08:17:29 -04003841 if (netId == NETID_UNSET) return null;
Paul Jensen6d3ff9e2014-05-29 10:12:39 -04003842 return new Network(netId);
3843 }
3844
Lorenzo Colittiffc42b02015-07-29 11:41:21 +09003845 private void unsupportedStartingFrom(int version) {
3846 if (Process.myUid() == Process.SYSTEM_UID) {
Lorenzo Colitti2e31a7c2018-09-28 11:31:55 +09003847 // The getApplicationInfo() call we make below is not supported in system context. Let
3848 // the call through here, and rely on the fact that ConnectivityService will refuse to
3849 // allow the system to use these APIs anyway.
Lorenzo Colittiffc42b02015-07-29 11:41:21 +09003850 return;
3851 }
3852
3853 if (mContext.getApplicationInfo().targetSdkVersion >= version) {
3854 throw new UnsupportedOperationException(
3855 "This method is not supported in target SDK version " + version + " and above");
3856 }
3857 }
3858
3859 // Checks whether the calling app can use the legacy routing API (startUsingNetworkFeature,
3860 // stopUsingNetworkFeature, requestRouteToHost), and if not throw UnsupportedOperationException.
Lifu Tang30f95a72016-01-07 23:20:38 -08003861 // TODO: convert the existing system users (Tethering, GnssLocationProvider) to the new APIs and
Lorenzo Colittiffc42b02015-07-29 11:41:21 +09003862 // remove these exemptions. Note that this check is not secure, and apps can still access these
3863 // functions by accessing ConnectivityService directly. However, it should be clear that doing
3864 // so is unsupported and may break in the future. http://b/22728205
3865 private void checkLegacyRoutingApiAccess() {
Dianne Hackborn692a2442015-07-31 10:35:34 -07003866 unsupportedStartingFrom(VERSION_CODES.M);
Lorenzo Colittiffc42b02015-07-29 11:41:21 +09003867 }
3868
Paul Jensen6d3ff9e2014-05-29 10:12:39 -04003869 /**
3870 * Binds host resolutions performed by this process to {@code network}.
Paul Jensen72db88e2015-03-10 10:54:12 -04003871 * {@link #bindProcessToNetwork} takes precedence over this setting.
Paul Jensen6d3ff9e2014-05-29 10:12:39 -04003872 *
3873 * @param network The {@link Network} to bind host resolutions from the current process to, or
3874 * {@code null} to clear the current binding.
3875 * @return {@code true} on success, {@code false} if the {@link Network} is no longer valid.
3876 * @hide
3877 * @deprecated This is strictly for legacy usage to support {@link #startUsingNetworkFeature}.
3878 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07003879 @Deprecated
Mathew Inwoodfa3a7462018-08-08 14:52:47 +01003880 @UnsupportedAppUsage
Paul Jensen6d3ff9e2014-05-29 10:12:39 -04003881 public static boolean setProcessDefaultNetworkForHostResolution(Network network) {
Paul Jensenbcc76d32014-07-11 08:17:29 -04003882 return NetworkUtils.bindProcessToNetworkForHostResolution(
Erik Klinef4fa9822018-04-27 22:48:33 +09003883 (network == null) ? NETID_UNSET : network.getNetIdForResolv());
Paul Jensen6d3ff9e2014-05-29 10:12:39 -04003884 }
Felipe Leme1b103232016-01-22 09:44:57 -08003885
3886 /**
3887 * Device is not restricting metered network activity while application is running on
3888 * background.
3889 */
3890 public static final int RESTRICT_BACKGROUND_STATUS_DISABLED = 1;
3891
3892 /**
3893 * Device is restricting metered network activity while application is running on background,
3894 * but application is allowed to bypass it.
3895 * <p>
3896 * In this state, application should take action to mitigate metered network access.
3897 * For example, a music streaming application should switch to a low-bandwidth bitrate.
3898 */
3899 public static final int RESTRICT_BACKGROUND_STATUS_WHITELISTED = 2;
3900
3901 /**
3902 * Device is restricting metered network activity while application is running on background.
Felipe Leme9778f762016-01-27 14:46:39 -08003903 * <p>
Felipe Leme1b103232016-01-22 09:44:57 -08003904 * In this state, application should not try to use the network while running on background,
3905 * because it would be denied.
3906 */
3907 public static final int RESTRICT_BACKGROUND_STATUS_ENABLED = 3;
3908
Felipe Leme9778f762016-01-27 14:46:39 -08003909 /**
3910 * A change in the background metered network activity restriction has occurred.
3911 * <p>
3912 * Applications should call {@link #getRestrictBackgroundStatus()} to check if the restriction
3913 * applies to them.
3914 * <p>
3915 * This is only sent to registered receivers, not manifest receivers.
3916 */
3917 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3918 public static final String ACTION_RESTRICT_BACKGROUND_CHANGED =
3919 "android.net.conn.RESTRICT_BACKGROUND_CHANGED";
3920
Felipe Lemeecfccea2016-01-25 11:48:04 -08003921 /** @hide */
3922 @Retention(RetentionPolicy.SOURCE)
Felipe Leme1b103232016-01-22 09:44:57 -08003923 @IntDef(flag = false, value = {
3924 RESTRICT_BACKGROUND_STATUS_DISABLED,
3925 RESTRICT_BACKGROUND_STATUS_WHITELISTED,
3926 RESTRICT_BACKGROUND_STATUS_ENABLED,
3927 })
Felipe Leme1b103232016-01-22 09:44:57 -08003928 public @interface RestrictBackgroundStatus {
3929 }
3930
3931 private INetworkPolicyManager getNetworkPolicyManager() {
3932 synchronized (this) {
3933 if (mNPManager != null) {
3934 return mNPManager;
3935 }
3936 mNPManager = INetworkPolicyManager.Stub.asInterface(ServiceManager
3937 .getService(Context.NETWORK_POLICY_SERVICE));
3938 return mNPManager;
3939 }
3940 }
3941
3942 /**
3943 * Determines if the calling application is subject to metered network restrictions while
3944 * running on background.
Felipe Lemec9c7be52016-05-16 13:57:19 -07003945 *
3946 * @return {@link #RESTRICT_BACKGROUND_STATUS_DISABLED},
3947 * {@link #RESTRICT_BACKGROUND_STATUS_ENABLED},
3948 * or {@link #RESTRICT_BACKGROUND_STATUS_WHITELISTED}
Felipe Leme1b103232016-01-22 09:44:57 -08003949 */
3950 public @RestrictBackgroundStatus int getRestrictBackgroundStatus() {
3951 try {
3952 return getNetworkPolicyManager().getRestrictBackgroundByCaller();
3953 } catch (RemoteException e) {
Jeff Sharkeyc53962d2016-03-01 19:27:23 -07003954 throw e.rethrowFromSystemServer();
Felipe Leme1b103232016-01-22 09:44:57 -08003955 }
3956 }
Ricky Wai44dcbde2018-01-23 04:09:45 +00003957
3958 /**
3959 * The network watchlist is a list of domains and IP addresses that are associated with
Ricky Waia86d5d52018-03-20 14:20:54 +00003960 * potentially harmful apps. This method returns the SHA-256 of the watchlist config file
3961 * currently used by the system for validation purposes.
Ricky Wai44dcbde2018-01-23 04:09:45 +00003962 *
3963 * @return Hash of network watchlist config file. Null if config does not exist.
3964 */
3965 public byte[] getNetworkWatchlistConfigHash() {
3966 try {
3967 return mService.getNetworkWatchlistConfigHash();
3968 } catch (RemoteException e) {
3969 Log.e(TAG, "Unable to get watchlist config hash");
3970 throw e.rethrowFromSystemServer();
3971 }
3972 }
Jeff Vander Stoep0ac2c092018-07-23 10:57:53 -07003973
3974 /**
3975 * Returns the {@code uid} of the owner of a network connection.
3976 *
3977 * @param protocol The protocol of the connection. Only {@code IPPROTO_TCP} and
3978 * {@code IPPROTO_UDP} currently supported.
3979 * @param local The local {@link InetSocketAddress} of a connection.
3980 * @param remote The remote {@link InetSocketAddress} of a connection.
3981 *
3982 * @return {@code uid} if the connection is found and the app has permission to observe it
3983 * (e.g., if it is associated with the calling VPN app's tunnel) or
3984 * {@link android.os.Process#INVALID_UID} if the connection is not found.
3985 */
3986 public int getConnectionOwnerUid(int protocol, InetSocketAddress local,
3987 InetSocketAddress remote) {
3988 ConnectionInfo connectionInfo = new ConnectionInfo(protocol, local, remote);
3989 try {
3990 return mService.getConnectionOwnerUid(connectionInfo);
3991 } catch (RemoteException e) {
3992 throw e.rethrowFromSystemServer();
3993 }
3994 }
Soi, Yoshinaridee2aa42015-11-12 12:09:02 +09003995
3996 private void printStackTrace() {
3997 if (DEBUG) {
3998 final StackTraceElement[] callStack = Thread.currentThread().getStackTrace();
3999 final StringBuffer sb = new StringBuffer();
4000 for (int i = 3; i < callStack.length; i++) {
4001 final String stackTrace = callStack[i].toString();
4002 if (stackTrace == null || stackTrace.contains("android.os")) {
4003 break;
4004 }
4005 sb.append(" [").append(stackTrace).append("]");
4006 }
4007 Log.d(TAG, "StackLog:" + sb.toString());
4008 }
4009 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004010}