blob: b0635041194480b63fbb80b41d806e22154d8608 [file] [log] [blame]
Dianne Hackbornd6847842010-01-12 18:14:19 -08001/*
2 * Copyright (C) 2010 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 */
16
Dianne Hackborn87bba1e2010-02-26 17:25:54 -080017package android.app.admin;
Dianne Hackbornd6847842010-01-12 18:14:19 -080018
Nicolas Prevot8f7698a2016-02-11 16:05:33 +000019import android.annotation.ColorInt;
Alan Treadwayafad8782016-01-19 15:15:08 +000020import android.annotation.IntDef;
Robin Lee25e26452015-06-02 09:56:29 -070021import android.annotation.NonNull;
22import android.annotation.Nullable;
Dianne Hackbornd6847842010-01-12 18:14:19 -080023import android.annotation.SdkConstant;
24import android.annotation.SdkConstant.SdkConstantType;
Justin Moreyb5deda72014-07-24 10:53:40 -050025import android.annotation.SystemApi;
Nicolas Prevot8f7698a2016-02-11 16:05:33 +000026import android.annotation.UserIdInt;
Jason Monkd7b86212014-06-16 13:15:38 -040027import android.app.Activity;
Michal Karpinski6235a942016-03-15 12:07:23 +000028import android.app.admin.SecurityLog.SecurityEvent;
Dianne Hackbornd6847842010-01-12 18:14:19 -080029import android.content.ComponentName;
30import android.content.Context;
Adam Connors010cfd42014-04-16 12:48:13 +010031import android.content.Intent;
Sander Alewijnsef475ca32014-02-17 15:13:58 +000032import android.content.IntentFilter;
Dianne Hackbornd6847842010-01-12 18:14:19 -080033import android.content.pm.PackageManager;
Victor Changcd14c0a2016-03-16 19:10:15 +000034import android.content.pm.PackageManager.NameNotFoundException;
Rubin Xuc3cd05f2016-01-11 12:11:35 +000035import android.content.pm.ParceledListSlice;
Sudheer Shanka978fc0d2016-01-28 13:51:10 +000036import android.content.pm.UserInfo;
Julia Reynoldsfca04ca2015-02-17 13:39:12 -050037import android.graphics.Bitmap;
Jason Monk03bc9912014-05-13 09:44:57 -040038import android.net.ProxyInfo;
Nicolas Prevot8b7991c2015-11-12 17:40:12 +000039import android.net.Uri;
Robin Lee66e5d962014-04-09 16:44:21 +010040import android.os.Bundle;
Jim Millere303bf42014-08-26 17:12:29 -070041import android.os.PersistableBundle;
Adam Connors776c5552014-01-09 10:42:56 +000042import android.os.Process;
Dianne Hackborn8ea138c2010-01-26 18:01:04 -080043import android.os.RemoteCallback;
Dianne Hackbornd6847842010-01-12 18:14:19 -080044import android.os.RemoteException;
45import android.os.ServiceManager;
Amith Yamasani599dd7c2012-09-14 23:20:08 -070046import android.os.UserHandle;
Julia Reynolds1e958392014-05-16 14:25:21 -040047import android.os.UserManager;
Ricky Wai494b95d2015-11-20 16:07:15 +000048import android.provider.ContactsContract.Directory;
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +000049import android.provider.Settings;
Bernhard Bauer26408cc2014-09-08 14:07:31 +010050import android.security.Credentials;
Amith Yamasanid1d7c022014-08-19 17:03:41 -070051import android.service.restrictions.RestrictionsReceiver;
Mahaver Chopra1216ae52016-03-11 15:39:48 +000052import android.telephony.TelephonyManager;
Dianne Hackbornd6847842010-01-12 18:14:19 -080053import android.util.Log;
54
Makoto Onukicc4bbeb2015-09-17 10:28:24 -070055import com.android.internal.annotations.VisibleForTesting;
Maggie Benthallda51e682013-08-08 22:35:44 -040056import com.android.org.conscrypt.TrustedCertificateStore;
57
58import java.io.ByteArrayInputStream;
Dianne Hackbornd6847842010-01-12 18:14:19 -080059import java.io.IOException;
Alan Treadwayafad8782016-01-19 15:15:08 +000060import java.lang.annotation.Retention;
61import java.lang.annotation.RetentionPolicy;
Oscar Montemayor69238c62010-08-03 10:51:06 -070062import java.net.InetSocketAddress;
63import java.net.Proxy;
Robin Lee0d5ccb72014-09-12 17:41:44 +010064import java.security.KeyFactory;
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +000065import java.security.NoSuchAlgorithmException;
Bernhard Bauer26408cc2014-09-08 14:07:31 +010066import java.security.PrivateKey;
67import java.security.cert.Certificate;
Maggie Benthallda51e682013-08-08 22:35:44 -040068import java.security.cert.CertificateException;
69import java.security.cert.CertificateFactory;
70import java.security.cert.X509Certificate;
Robin Lee0d5ccb72014-09-12 17:41:44 +010071import java.security.spec.InvalidKeySpecException;
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +000072import java.security.spec.PKCS8EncodedKeySpec;
Jim Miller604e7552014-07-18 19:00:02 -070073import java.util.ArrayList;
Svetoslav976e8bd2014-07-16 15:12:03 -070074import java.util.Collections;
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -080075import java.util.List;
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +010076import java.util.Set;
Dianne Hackbornd6847842010-01-12 18:14:19 -080077
78/**
Alexandra Gherghina541afcd2014-11-07 11:18:12 +000079 * Public interface for managing policies enforced on a device. Most clients of this class must be
Suprabh Shukla34d92ef2016-03-14 13:49:37 -070080 * registered with the system as a <a href="{@docRoot}guide/topics/admin/device-admin.html">device
81 * administrator</a>. Additionally, a device administrator may be registered as either a profile or
82 * device owner. A given method is accessible to all device administrators unless the documentation
83 * for that method specifies that it is restricted to either device or profile owners. Any
84 * application calling an api may only pass as an argument a device administrator component it
85 * owns. Otherwise, a {@link SecurityException} will be thrown.
Joe Fernandez3aef8e1d2011-12-20 10:38:34 -080086 * <div class="special reference">
87 * <h3>Developer Guides</h3>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -070088 * <p>
89 * For more information about managing policies for device administration, read the <a href=
90 * "{@docRoot}guide/topics/admin/device-admin.html">Device Administration</a> developer
91 * guide. </div>
Dianne Hackbornd6847842010-01-12 18:14:19 -080092 */
93public class DevicePolicyManager {
94 private static String TAG = "DevicePolicyManager";
Dianne Hackbornd6847842010-01-12 18:14:19 -080095
96 private final Context mContext;
Dianne Hackbornd6847842010-01-12 18:14:19 -080097 private final IDevicePolicyManager mService;
Esteban Talavera62399912016-01-11 15:37:55 +000098 private final boolean mParentInstance;
Konstantin Lopyrev32558232010-05-20 16:18:05 -070099
Clara Bayarri3e826ef2015-12-14 17:51:22 +0000100 private DevicePolicyManager(Context context, boolean parentInstance) {
Esteban Talavera62399912016-01-11 15:37:55 +0000101 this(context,
102 IDevicePolicyManager.Stub.asInterface(
103 ServiceManager.getService(Context.DEVICE_POLICY_SERVICE)),
104 parentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -0800105 }
106
Dianne Hackborn87bba1e2010-02-26 17:25:54 -0800107 /** @hide */
Makoto Onukicc4bbeb2015-09-17 10:28:24 -0700108 @VisibleForTesting
Esteban Talavera62399912016-01-11 15:37:55 +0000109 protected DevicePolicyManager(
110 Context context, IDevicePolicyManager service, boolean parentInstance) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -0700111 mContext = context;
112 mService = service;
Esteban Talavera62399912016-01-11 15:37:55 +0000113 mParentInstance = parentInstance;
Makoto Onukicc4bbeb2015-09-17 10:28:24 -0700114 }
115
116 /** @hide */
117 public static DevicePolicyManager create(Context context) {
Clara Bayarri3e826ef2015-12-14 17:51:22 +0000118 DevicePolicyManager me = new DevicePolicyManager(context, false);
Dianne Hackborn21f1bd12010-02-19 17:02:21 -0800119 return me.mService != null ? me : null;
120 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700121
Makoto Onukicc4bbeb2015-09-17 10:28:24 -0700122 /** @hide test will override it. */
123 @VisibleForTesting
124 protected int myUserId() {
125 return UserHandle.myUserId();
126 }
127
Dianne Hackbornd6847842010-01-12 18:14:19 -0800128 /**
Jessica Hummelf72078b2014-03-06 16:13:12 +0000129 * Activity action: Starts the provisioning flow which sets up a managed profile.
Jessica Hummelf72078b2014-03-06 16:13:12 +0000130 *
Jessica Hummel9da60392014-05-21 12:32:57 +0100131 * <p>A managed profile allows data separation for example for the usage of a
132 * device as a personal and corporate device. The user which provisioning is started from and
133 * the managed profile share a launcher.
134 *
Andrew Solovay27f53372015-03-02 16:37:59 -0800135 * <p>This intent will typically be sent by a mobile device management application (MDM).
136 * Provisioning adds a managed profile and sets the MDM as the profile owner who has full
137 * control over the profile.
Jessica Hummel9da60392014-05-21 12:32:57 +0100138 *
Alan Treadway46dd4492015-11-09 13:57:19 +0000139 * <p>It is possible to check if provisioning is allowed or not by querying the method
140 * {@link #isProvisioningAllowed(String)}.
141 *
142 * <p>In version {@link android.os.Build.VERSION_CODES#LOLLIPOP}, this intent must contain the
Nicolas Prevot18440252015-03-09 14:07:17 +0000143 * extra {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME}.
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -0700144 * As of {@link android.os.Build.VERSION_CODES#M}, it should contain the extra
Nicolas Prevot18440252015-03-09 14:07:17 +0000145 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME} instead, although specifying only
146 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME} is still supported.
Nicolas Prevotcaf11cd2015-11-19 10:58:35 +0000147 *
Benjamin Franzea956242016-03-21 15:45:56 +0000148 * <p>The intent may also contain the following extras:
Nicolas Prevotcaf11cd2015-11-19 10:58:35 +0000149 * <ul>
Benjamin Franzea956242016-03-21 15:45:56 +0000150 * <li>{@link #EXTRA_PROVISIONING_ACCOUNT_TO_MIGRATE}, optional </li>
151 * <li>{@link #EXTRA_PROVISIONING_SKIP_ENCRYPTION}, optional, supported from
152 * {@link android.os.Build.VERSION_CODES#N}</li>
153 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li>
154 * <li>{@link #EXTRA_PROVISIONING_LOGO_URI}, optional</li>
155 * <li>{@link #EXTRA_PROVISIONING_MAIN_COLOR}, optional</li>
Nicolas Prevotcaf11cd2015-11-19 10:58:35 +0000156 * </ul>
Jessica Hummelf72078b2014-03-06 16:13:12 +0000157 *
Benjamin Franzea956242016-03-21 15:45:56 +0000158 * <p>When managed provisioning has completed, broadcasts are sent to the application specified
Alexandra Gherghinadb4bc572015-01-08 12:17:40 +0000159 * in the provisioning intent. The
160 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} broadcast is sent in the
161 * managed profile and the {@link #ACTION_MANAGED_PROFILE_PROVISIONED} broadcast is sent in
162 * the primary profile.
Jessica Hummel9da60392014-05-21 12:32:57 +0100163 *
Benjamin Franzea956242016-03-21 15:45:56 +0000164 * <p>If provisioning fails, the managedProfile is removed so the device returns to its
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100165 * previous state.
Alan Treadway4582f812015-07-28 11:49:35 +0100166 *
167 * <p>If launched with {@link android.app.Activity#startActivityForResult(Intent, int)} a
168 * result code of {@link android.app.Activity#RESULT_OK} implies that the synchronous part of
169 * the provisioning flow was successful, although this doesn't guarantee the full flow will
170 * succeed. Conversely a result code of {@link android.app.Activity#RESULT_CANCELED} implies
171 * that the user backed-out of provisioning, or some precondition for provisioning wasn't met.
Jessica Hummelf72078b2014-03-06 16:13:12 +0000172 */
173 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
174 public static final String ACTION_PROVISION_MANAGED_PROFILE
Esteban Talaveraef9c5232014-09-08 13:51:18 +0100175 = "android.app.action.PROVISION_MANAGED_PROFILE";
Jessica Hummelf72078b2014-03-06 16:13:12 +0000176
177 /**
Mahaver Chopra7830daa2015-11-10 18:12:43 +0000178 * Activity action: Starts the provisioning flow which sets up a managed user.
179 *
180 * <p>This intent will typically be sent by a mobile device management application (MDM).
Makoto Onuki32b30572015-12-11 14:29:51 -0800181 * Provisioning configures the user as managed user and sets the MDM as the profile
Mahaver Chopra7830daa2015-11-10 18:12:43 +0000182 * owner who has full control over the user. Provisioning can only happen before user setup has
183 * been completed. Use {@link #isProvisioningAllowed(String)} to check if provisioning is
184 * allowed.
185 *
Benjamin Franzea956242016-03-21 15:45:56 +0000186 * <p>The intent contains the following extras:
187 * <ul>
188 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}</li>
189 * <li>{@link #EXTRA_PROVISIONING_SKIP_ENCRYPTION}, optional</li>
190 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li>
191 * <li>{@link #EXTRA_PROVISIONING_LOGO_URI}, optional</li>
192 * <li>{@link #EXTRA_PROVISIONING_MAIN_COLOR}, optional</li>
193 * </ul>
Mahaver Chopra7830daa2015-11-10 18:12:43 +0000194 *
Benjamin Franzea956242016-03-21 15:45:56 +0000195 * <p>If provisioning fails, the device returns to its previous state.
Mahaver Chopra7830daa2015-11-10 18:12:43 +0000196 *
197 * <p>If launched with {@link android.app.Activity#startActivityForResult(Intent, int)} a
198 * result code of {@link android.app.Activity#RESULT_OK} implies that the synchronous part of
199 * the provisioning flow was successful, although this doesn't guarantee the full flow will
200 * succeed. Conversely a result code of {@link android.app.Activity#RESULT_CANCELED} implies
201 * that the user backed-out of provisioning, or some precondition for provisioning wasn't met.
Benjamin Franzea956242016-03-21 15:45:56 +0000202 *
203 * @hide
Mahaver Chopra5e732562015-11-05 11:55:12 +0000204 */
205 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
206 public static final String ACTION_PROVISION_MANAGED_USER
207 = "android.app.action.PROVISION_MANAGED_USER";
208
209 /**
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100210 * Activity action: Starts the provisioning flow which sets up a managed device.
211 * Must be started with {@link android.app.Activity#startActivityForResult(Intent, int)}.
212 *
213 * <p> During device owner provisioning a device admin app is set as the owner of the device.
214 * A device owner has full control over the device. The device owner can not be modified by the
215 * user.
216 *
217 * <p> A typical use case would be a device that is owned by a company, but used by either an
218 * employee or client.
219 *
220 * <p> An intent with this action can be sent only on an unprovisioned device.
Alan Treadway46dd4492015-11-09 13:57:19 +0000221 * It is possible to check if provisioning is allowed or not by querying the method
222 * {@link #isProvisioningAllowed(String)}.
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100223 *
Alan Treadway46dd4492015-11-09 13:57:19 +0000224 * <p>The intent contains the following extras:
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100225 * <ul>
226 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}</li>
227 * <li>{@link #EXTRA_PROVISIONING_SKIP_ENCRYPTION}, optional</li>
228 * <li>{@link #EXTRA_PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED}, optional</li>
Rubin Xua4f9dc12015-06-12 13:27:59 +0100229 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li>
Nicolas Prevot8b7991c2015-11-12 17:40:12 +0000230 * <li>{@link #EXTRA_PROVISIONING_LOGO_URI}, optional</li>
Nicolas Prevotcaf11cd2015-11-19 10:58:35 +0000231 * <li>{@link #EXTRA_PROVISIONING_MAIN_COLOR}, optional</li>
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100232 * </ul>
233 *
Benjamin Franzea956242016-03-21 15:45:56 +0000234 * <p>When device owner provisioning has completed, an intent of the type
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100235 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} is broadcast to the
236 * device owner.
237 *
Benjamin Franzea956242016-03-21 15:45:56 +0000238 * <p>If provisioning fails, the device is factory reset.
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100239 *
Alan Treadway4582f812015-07-28 11:49:35 +0100240 * <p>A result code of {@link android.app.Activity#RESULT_OK} implies that the synchronous part
241 * of the provisioning flow was successful, although this doesn't guarantee the full flow will
242 * succeed. Conversely a result code of {@link android.app.Activity#RESULT_CANCELED} implies
243 * that the user backed-out of provisioning, or some precondition for provisioning wasn't met.
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100244 */
245 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
246 public static final String ACTION_PROVISION_MANAGED_DEVICE
247 = "android.app.action.PROVISION_MANAGED_DEVICE";
248
249 /**
Alan Treadway46dd4492015-11-09 13:57:19 +0000250 * Activity action: Starts the provisioning flow which sets up a managed device.
Steven Ng980a1b62016-02-02 17:43:18 +0000251 *
252 * <p>During device owner provisioning, a device admin app is downloaded and set as the owner of
253 * the device. A device owner has full control over the device. The device owner can not be
254 * modified by the user and the only way of resetting the device is via factory reset.
255 *
256 * <p>A typical use case would be a device that is owned by a company, but used by either an
257 * employee or client.
258 *
259 * <p>The provisioning message should be sent to an unprovisioned device.
260 *
261 * <p>Unlike {@link #ACTION_PROVISION_MANAGED_DEVICE}, the provisioning message can only be sent
262 * by a privileged app with the permission
263 * {@link android.Manifest.permission#DISPATCH_PROVISIONING_MESSAGE}.
264 *
265 * <p>The provisioning intent contains the following properties:
266 * <ul>
267 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}</li>
268 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}, optional</li>
269 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER}, optional</li>
270 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM}, optional</li>
271 * <li>{@link #EXTRA_PROVISIONING_LOCAL_TIME} (convert to String), optional</li>
272 * <li>{@link #EXTRA_PROVISIONING_TIME_ZONE}, optional</li>
273 * <li>{@link #EXTRA_PROVISIONING_LOCALE}, optional</li>
274 * <li>{@link #EXTRA_PROVISIONING_WIFI_SSID}, optional</li>
275 * <li>{@link #EXTRA_PROVISIONING_WIFI_HIDDEN} (convert to String), optional</li>
276 * <li>{@link #EXTRA_PROVISIONING_WIFI_SECURITY_TYPE}, optional</li>
277 * <li>{@link #EXTRA_PROVISIONING_WIFI_PASSWORD}, optional</li>
278 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_HOST}, optional</li>
279 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_PORT} (convert to String), optional</li>
280 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_BYPASS}, optional</li>
281 * <li>{@link #EXTRA_PROVISIONING_WIFI_PAC_URL}, optional</li>
282 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li></ul>
283 *
284 * @hide
285 */
286 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
287 @SystemApi
288 public static final String ACTION_PROVISION_MANAGED_DEVICE_FROM_TRUSTED_SOURCE =
289 "android.app.action.PROVISION_MANAGED_DEVICE_FROM_TRUSTED_SOURCE";
290
291 /**
292 * Activity action: Starts the provisioning flow which sets up a managed device.
Alan Treadway46dd4492015-11-09 13:57:19 +0000293 * Must be started with {@link android.app.Activity#startActivityForResult(Intent, int)}.
294 *
295 * <p>NOTE: This is only supported on split system user devices, and puts the device into a
296 * management state that is distinct from that reached by
297 * {@link #ACTION_PROVISION_MANAGED_DEVICE} - specifically the device owner runs on the system
298 * user, and only has control over device-wide policies, not individual users and their data.
299 * The primary benefit is that multiple non-system users are supported when provisioning using
300 * this form of device management.
301 *
Benjamin Franzea956242016-03-21 15:45:56 +0000302 * <p>During device owner provisioning a device admin app is set as the owner of the device.
Alan Treadway46dd4492015-11-09 13:57:19 +0000303 * A device owner has full control over the device. The device owner can not be modified by the
304 * user.
305 *
Benjamin Franzea956242016-03-21 15:45:56 +0000306 * <p>A typical use case would be a device that is owned by a company, but used by either an
Alan Treadway46dd4492015-11-09 13:57:19 +0000307 * employee or client.
308 *
Benjamin Franzea956242016-03-21 15:45:56 +0000309 * <p>An intent with this action can be sent only on an unprovisioned device.
Alan Treadway46dd4492015-11-09 13:57:19 +0000310 * It is possible to check if provisioning is allowed or not by querying the method
311 * {@link #isProvisioningAllowed(String)}.
312 *
313 * <p>The intent contains the following extras:
314 * <ul>
315 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}</li>
316 * <li>{@link #EXTRA_PROVISIONING_SKIP_ENCRYPTION}, optional</li>
317 * <li>{@link #EXTRA_PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED}, optional</li>
318 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li>
Benjamin Franzea956242016-03-21 15:45:56 +0000319 * <li>{@link #EXTRA_PROVISIONING_LOGO_URI}, optional</li>
320 * <li>{@link #EXTRA_PROVISIONING_MAIN_COLOR}, optional</li>
Alan Treadway46dd4492015-11-09 13:57:19 +0000321 * </ul>
322 *
Benjamin Franzea956242016-03-21 15:45:56 +0000323 * <p>When device owner provisioning has completed, an intent of the type
Alan Treadway46dd4492015-11-09 13:57:19 +0000324 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} is broadcast to the
325 * device owner.
326 *
Benjamin Franzea956242016-03-21 15:45:56 +0000327 * <p>If provisioning fails, the device is factory reset.
Alan Treadway46dd4492015-11-09 13:57:19 +0000328 *
329 * <p>A result code of {@link android.app.Activity#RESULT_OK} implies that the synchronous part
330 * of the provisioning flow was successful, although this doesn't guarantee the full flow will
331 * succeed. Conversely a result code of {@link android.app.Activity#RESULT_CANCELED} implies
332 * that the user backed-out of provisioning, or some precondition for provisioning wasn't met.
333 *
334 * @hide
335 */
336 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
337 public static final String ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE
338 = "android.app.action.PROVISION_MANAGED_SHAREABLE_DEVICE";
339
340 /**
Alan Treadwayafad8782016-01-19 15:15:08 +0000341 * Activity action: Finalizes management provisioning, should be used after user-setup
342 * has been completed and {@link #getUserProvisioningState()} returns one of:
343 * <ul>
344 * <li>{@link #STATE_USER_SETUP_INCOMPLETE}</li>
345 * <li>{@link #STATE_USER_SETUP_COMPLETE}</li>
346 * <li>{@link #STATE_USER_PROFILE_COMPLETE}</li>
347 * </ul>
348 *
349 * @hide
350 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +0000351 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +0000352 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
353 public static final String ACTION_PROVISION_FINALIZATION
354 = "android.app.action.PROVISION_FINALIZATION";
355
356 /**
Michal Karpinskiba244092016-02-25 17:28:24 +0000357 * Action: Bugreport sharing with device owner has been accepted by the user.
358 *
359 * @hide
360 */
361 public static final String ACTION_BUGREPORT_SHARING_ACCEPTED =
362 "com.android.server.action.BUGREPORT_SHARING_ACCEPTED";
363
364 /**
365 * Action: Bugreport sharing with device owner has been declined by the user.
366 *
367 * @hide
368 */
369 public static final String ACTION_BUGREPORT_SHARING_DECLINED =
370 "com.android.server.action.BUGREPORT_SHARING_DECLINED";
371
372 /**
373 * Action: Bugreport has been collected and is dispatched to {@link DevicePolicyManagerService}.
374 *
375 * @hide
376 */
377 public static final String ACTION_REMOTE_BUGREPORT_DISPATCH =
378 "android.intent.action.REMOTE_BUGREPORT_DISPATCH";
379
380 /**
381 * Extra for shared bugreport's SHA-256 hash.
382 *
383 * @hide
384 */
385 public static final String EXTRA_REMOTE_BUGREPORT_HASH =
386 "android.intent.extra.REMOTE_BUGREPORT_HASH";
387
388 /**
389 * Extra for remote bugreport notification shown type.
390 *
391 * @hide
392 */
393 public static final String EXTRA_BUGREPORT_NOTIFICATION_TYPE =
394 "android.app.extra.bugreport_notification_type";
395
396 /**
397 * Notification type for a started remote bugreport flow.
398 *
399 * @hide
400 */
401 public static final int NOTIFICATION_BUGREPORT_STARTED = 1;
402
403 /**
404 * Notification type for a bugreport that has already been accepted to be shared, but is still
405 * being taken.
406 *
407 * @hide
408 */
409 public static final int NOTIFICATION_BUGREPORT_ACCEPTED_NOT_FINISHED = 2;
410
411 /**
412 * Notification type for a bugreport that has been taken and can be shared or declined.
413 *
414 * @hide
415 */
416 public static final int NOTIFICATION_BUGREPORT_FINISHED_NOT_ACCEPTED = 3;
417
418 /**
Rubin Xua4f9dc12015-06-12 13:27:59 +0100419 * A {@link android.os.Parcelable} extra of type {@link android.os.PersistableBundle} that
Rubin Xu41f2ccb92015-08-05 16:29:13 +0100420 * allows a mobile device management application or NFC programmer application which starts
421 * managed provisioning to pass data to the management application instance after provisioning.
Rubin Xua4f9dc12015-06-12 13:27:59 +0100422 * <p>
423 * If used with {@link #ACTION_PROVISION_MANAGED_PROFILE} it can be used by the application that
424 * sends the intent to pass data to itself on the newly created profile.
425 * If used with {@link #ACTION_PROVISION_MANAGED_DEVICE} it allows passing data to the same
426 * instance of the app on the primary user.
Rubin Xu41f2ccb92015-08-05 16:29:13 +0100427 * Starting from {@link android.os.Build.VERSION_CODES#M}, if used with
428 * {@link #MIME_TYPE_PROVISIONING_NFC} as part of NFC managed device provisioning, the NFC
429 * message should contain a stringified {@link java.util.Properties} instance, whose string
430 * properties will be converted into a {@link android.os.PersistableBundle} and passed to the
431 * management application after provisioning.
432 *
Rubin Xua4f9dc12015-06-12 13:27:59 +0100433 * <p>
434 * In both cases the application receives the data in
Brian Carlstromf1fe51b2014-09-03 08:55:05 -0700435 * {@link DeviceAdminReceiver#onProfileProvisioningComplete} via an intent with the action
436 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE}. The bundle is not changed
Rubin Xua4f9dc12015-06-12 13:27:59 +0100437 * during the managed provisioning.
Sander Alewijnse90f14bf2014-08-20 16:22:44 +0100438 */
439 public static final String EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE =
Esteban Talavera37f01842014-09-05 10:50:57 +0100440 "android.app.extra.PROVISIONING_ADMIN_EXTRAS_BUNDLE";
Sander Alewijnse90f14bf2014-08-20 16:22:44 +0100441
442 /**
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100443 * A String extra holding the package name of the mobile device management application that
444 * will be set as the profile owner or device owner.
445 *
446 * <p>If an application starts provisioning directly via an intent with action
447 * {@link #ACTION_PROVISION_MANAGED_PROFILE} this package has to match the package name of the
448 * application that started provisioning. The package will be set as profile owner in that case.
449 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000450 * <p>This package is set as device owner when device owner provisioning is started by an NFC
451 * message containing an NFC record with MIME type {@link #MIME_TYPE_PROVISIONING_NFC}.
Nicolas Prevot18440252015-03-09 14:07:17 +0000452 *
453 * <p> When this extra is set, the application must have exactly one device admin receiver.
Robin Lee25e26452015-06-02 09:56:29 -0700454 * This receiver will be set as the profile or device owner and active admin.
Benjamin Franzea956242016-03-21 15:45:56 +0000455 *
Nicolas Prevot18440252015-03-09 14:07:17 +0000456 * @see DeviceAdminReceiver
457 * @deprecated Use {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}. This extra is still
Nicolas Prevot8f78d6a2015-08-21 11:06:31 +0100458 * supported, but only if there is only one device admin receiver in the package that requires
459 * the permission {@link android.Manifest.permission#BIND_DEVICE_ADMIN}.
Jessica Hummelf72078b2014-03-06 16:13:12 +0000460 */
Nicolas Prevot18440252015-03-09 14:07:17 +0000461 @Deprecated
Jessica Hummelf72078b2014-03-06 16:13:12 +0000462 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME
Esteban Talaveraef9c5232014-09-08 13:51:18 +0100463 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME";
Jessica Hummelf72078b2014-03-06 16:13:12 +0000464
465 /**
Nicolas Prevot18440252015-03-09 14:07:17 +0000466 * A ComponentName extra indicating the device admin receiver of the mobile device management
467 * application that will be set as the profile owner or device owner and active admin.
468 *
469 * <p>If an application starts provisioning directly via an intent with action
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100470 * {@link #ACTION_PROVISION_MANAGED_PROFILE} or
471 * {@link #ACTION_PROVISION_MANAGED_DEVICE} the package name of this
472 * component has to match the package name of the application that started provisioning.
Nicolas Prevot18440252015-03-09 14:07:17 +0000473 *
474 * <p>This component is set as device owner and active admin when device owner provisioning is
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100475 * started by an intent with action {@link #ACTION_PROVISION_MANAGED_DEVICE} or by an NFC
476 * message containing an NFC record with MIME type
Benjamin Franzea956242016-03-21 15:45:56 +0000477 * {@link #MIME_TYPE_PROVISIONING_NFC}. For the NFC record, the component name must be
Rubin Xu44ef750b2015-03-23 16:51:33 +0000478 * flattened to a string, via {@link ComponentName#flattenToShortString()}.
Nicolas Prevot18440252015-03-09 14:07:17 +0000479 *
480 * @see DeviceAdminReceiver
481 */
482 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME
483 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME";
484
485 /**
Alexandra Gherghinaaaf2f3e2014-11-13 12:46:15 +0000486 * An {@link android.accounts.Account} extra holding the account to migrate during managed
487 * profile provisioning. If the account supplied is present in the primary user, it will be
488 * copied, along with its credentials to the managed profile and removed from the primary user.
489 *
490 * Use with {@link #ACTION_PROVISION_MANAGED_PROFILE}.
491 */
492
493 public static final String EXTRA_PROVISIONING_ACCOUNT_TO_MIGRATE
494 = "android.app.extra.PROVISIONING_ACCOUNT_TO_MIGRATE";
495
496 /**
Jessica Hummele3da7902014-08-20 15:20:11 +0100497 * A String extra that, holds the email address of the account which a managed profile is
498 * created for. Used with {@link #ACTION_PROVISION_MANAGED_PROFILE} and
499 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE}.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100500 *
Sander Alewijnse2b338a22014-09-12 12:28:40 +0100501 * <p> This extra is part of the {@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}.
502 *
Jessica Hummele3da7902014-08-20 15:20:11 +0100503 * <p> If the {@link #ACTION_PROVISION_MANAGED_PROFILE} intent that starts managed provisioning
504 * contains this extra, it is forwarded in the
505 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} intent to the mobile
506 * device management application that was set as the profile owner during provisioning.
507 * It is usually used to avoid that the user has to enter their email address twice.
Nicolas Prevot07ac20b2014-05-27 15:37:45 +0100508 */
Sander Alewijnse2b338a22014-09-12 12:28:40 +0100509 public static final String EXTRA_PROVISIONING_EMAIL_ADDRESS
510 = "android.app.extra.PROVISIONING_EMAIL_ADDRESS";
Nicolas Prevot07ac20b2014-05-27 15:37:45 +0100511
512 /**
Nicolas Prevotcd2d8592015-11-23 13:27:21 +0000513 * A integer extra indicating the predominant color to show during the provisioning.
514 * Refer to {@link android.graphics.Color} for how the color is represented.
Nicolas Prevotcaf11cd2015-11-19 10:58:35 +0000515 *
516 * <p>Use with {@link #ACTION_PROVISION_MANAGED_PROFILE} or
517 * {@link #ACTION_PROVISION_MANAGED_DEVICE}.
518 */
519 public static final String EXTRA_PROVISIONING_MAIN_COLOR =
520 "android.app.extra.PROVISIONING_MAIN_COLOR";
521
522 /**
Sander Alewijnse8c411562014-11-12 18:03:11 +0000523 * A Boolean extra that can be used by the mobile device management application to skip the
Robin Lee25e26452015-06-02 09:56:29 -0700524 * disabling of system apps during provisioning when set to {@code true}.
Sander Alewijnse8c411562014-11-12 18:03:11 +0000525 *
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100526 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} or an intent with action
527 * {@link #ACTION_PROVISION_MANAGED_DEVICE} that starts device owner provisioning.
Sander Alewijnse8c411562014-11-12 18:03:11 +0000528 */
Sander Alewijnse5a144252014-11-18 13:25:04 +0000529 public static final String EXTRA_PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED =
530 "android.app.extra.PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED";
Sander Alewijnse8c411562014-11-12 18:03:11 +0000531
532 /**
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100533 * A String extra holding the time zone {@link android.app.AlarmManager} that the device
534 * will be set to.
535 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000536 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
537 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100538 */
539 public static final String EXTRA_PROVISIONING_TIME_ZONE
Esteban Talavera37f01842014-09-05 10:50:57 +0100540 = "android.app.extra.PROVISIONING_TIME_ZONE";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100541
542 /**
Esteban Talaverad469a0b2014-08-20 13:54:25 +0100543 * A Long extra holding the wall clock time (in milliseconds) to be set on the device's
544 * {@link android.app.AlarmManager}.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100545 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000546 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
547 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100548 */
549 public static final String EXTRA_PROVISIONING_LOCAL_TIME
Esteban Talavera37f01842014-09-05 10:50:57 +0100550 = "android.app.extra.PROVISIONING_LOCAL_TIME";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100551
552 /**
553 * A String extra holding the {@link java.util.Locale} that the device will be set to.
554 * Format: xx_yy, where xx is the language code, and yy the country code.
555 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000556 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
557 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100558 */
559 public static final String EXTRA_PROVISIONING_LOCALE
Esteban Talavera37f01842014-09-05 10:50:57 +0100560 = "android.app.extra.PROVISIONING_LOCALE";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100561
562 /**
563 * A String extra holding the ssid of the wifi network that should be used during nfc device
564 * owner provisioning for downloading the mobile device management application.
565 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000566 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
567 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100568 */
569 public static final String EXTRA_PROVISIONING_WIFI_SSID
Esteban Talavera37f01842014-09-05 10:50:57 +0100570 = "android.app.extra.PROVISIONING_WIFI_SSID";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100571
572 /**
573 * A boolean extra indicating whether the wifi network in {@link #EXTRA_PROVISIONING_WIFI_SSID}
574 * is hidden or not.
575 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000576 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
577 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100578 */
579 public static final String EXTRA_PROVISIONING_WIFI_HIDDEN
Esteban Talavera37f01842014-09-05 10:50:57 +0100580 = "android.app.extra.PROVISIONING_WIFI_HIDDEN";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100581
582 /**
583 * A String extra indicating the security type of the wifi network in
Mahaver Chopra76b08a92015-10-08 17:58:45 +0100584 * {@link #EXTRA_PROVISIONING_WIFI_SSID} and could be one of {@code NONE}, {@code WPA} or
585 * {@code WEP}.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100586 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000587 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
588 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100589 */
590 public static final String EXTRA_PROVISIONING_WIFI_SECURITY_TYPE
Esteban Talavera37f01842014-09-05 10:50:57 +0100591 = "android.app.extra.PROVISIONING_WIFI_SECURITY_TYPE";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100592
593 /**
594 * A String extra holding the password of the wifi network in
595 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
596 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000597 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
598 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100599 */
600 public static final String EXTRA_PROVISIONING_WIFI_PASSWORD
Esteban Talavera37f01842014-09-05 10:50:57 +0100601 = "android.app.extra.PROVISIONING_WIFI_PASSWORD";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100602
603 /**
604 * A String extra holding the proxy host for the wifi network in
605 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
606 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000607 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
608 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100609 */
610 public static final String EXTRA_PROVISIONING_WIFI_PROXY_HOST
Esteban Talavera37f01842014-09-05 10:50:57 +0100611 = "android.app.extra.PROVISIONING_WIFI_PROXY_HOST";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100612
613 /**
614 * An int extra holding the proxy port for the wifi network in
615 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
616 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000617 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
618 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100619 */
620 public static final String EXTRA_PROVISIONING_WIFI_PROXY_PORT
Esteban Talavera37f01842014-09-05 10:50:57 +0100621 = "android.app.extra.PROVISIONING_WIFI_PROXY_PORT";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100622
623 /**
624 * A String extra holding the proxy bypass for the wifi network in
625 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
626 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000627 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
628 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100629 */
630 public static final String EXTRA_PROVISIONING_WIFI_PROXY_BYPASS
Esteban Talavera37f01842014-09-05 10:50:57 +0100631 = "android.app.extra.PROVISIONING_WIFI_PROXY_BYPASS";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100632
633 /**
634 * A String extra holding the proxy auto-config (PAC) URL for the wifi network in
635 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
636 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000637 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
638 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100639 */
640 public static final String EXTRA_PROVISIONING_WIFI_PAC_URL
Esteban Talavera37f01842014-09-05 10:50:57 +0100641 = "android.app.extra.PROVISIONING_WIFI_PAC_URL";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100642
643 /**
644 * A String extra holding a url that specifies the download location of the device admin
645 * package. When not provided it is assumed that the device admin package is already installed.
646 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000647 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
648 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100649 */
650 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION
Esteban Talavera37f01842014-09-05 10:50:57 +0100651 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100652
653 /**
Julia Reynoldsc1731742015-03-19 14:56:28 -0400654 * An int extra holding a minimum required version code for the device admin package. If the
655 * device admin is already installed on the device, it will only be re-downloaded from
656 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION} if the version of the
657 * installed package is less than this version code.
658 *
Craig Lafayette3cc72ba2015-06-26 11:51:04 -0400659 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
Julia Reynoldsc1731742015-03-19 14:56:28 -0400660 * provisioning via an NFC bump.
661 */
662 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_MINIMUM_VERSION_CODE
663 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_MINIMUM_VERSION_CODE";
664
665 /**
Sander Alewijnse681bce92014-07-24 16:46:26 +0100666 * A String extra holding a http cookie header which should be used in the http request to the
667 * url specified in {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}.
668 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000669 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
670 * provisioning via an NFC bump.
Sander Alewijnse681bce92014-07-24 16:46:26 +0100671 */
672 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER
Esteban Talavera37f01842014-09-05 10:50:57 +0100673 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER";
Sander Alewijnse681bce92014-07-24 16:46:26 +0100674
675 /**
Rubin Xud92e7572015-05-18 17:01:13 +0100676 * A String extra holding the URL-safe base64 encoded SHA-256 or SHA-1 hash (see notes below) of
677 * the file at download location specified in
678 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}.
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100679 *
Benjamin Franzea956242016-03-21 15:45:56 +0000680 * <p>Either this extra or {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_SIGNATURE_CHECKSUM} must be
681 * present. The provided checksum must match the checksum of the file at the download
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100682 * location. If the checksum doesn't match an error will be shown to the user and the user will
683 * be asked to factory reset the device.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100684 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000685 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
686 * provisioning via an NFC bump.
Rubin Xud92e7572015-05-18 17:01:13 +0100687 *
688 * <p><strong>Note:</strong> for devices running {@link android.os.Build.VERSION_CODES#LOLLIPOP}
689 * and {@link android.os.Build.VERSION_CODES#LOLLIPOP_MR1} only SHA-1 hash is supported.
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -0700690 * Starting from {@link android.os.Build.VERSION_CODES#M}, this parameter accepts SHA-256 in
Rubin Xud92e7572015-05-18 17:01:13 +0100691 * addition to SHA-1. Support for SHA-1 is likely to be removed in future OS releases.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100692 */
693 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM
Esteban Talavera37f01842014-09-05 10:50:57 +0100694 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100695
696 /**
Rubin Xud92e7572015-05-18 17:01:13 +0100697 * A String extra holding the URL-safe base64 encoded SHA-256 checksum of any signature of the
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100698 * android package archive at the download location specified in {@link
699 * #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}.
700 *
Rubin Xu5c82d2c2015-06-02 09:29:46 +0100701 * <p>The signatures of an android package archive can be obtained using
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100702 * {@link android.content.pm.PackageManager#getPackageArchiveInfo} with flag
703 * {@link android.content.pm.PackageManager#GET_SIGNATURES}.
704 *
Benjamin Franzea956242016-03-21 15:45:56 +0000705 * <p>Either this extra or {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM} must be
706 * present. The provided checksum must match the checksum of any signature of the file at
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100707 * the download location. If the checksum does not match an error will be shown to the user and
708 * the user will be asked to factory reset the device.
709 *
710 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
711 * provisioning via an NFC bump.
712 */
Rubin Xu5c82d2c2015-06-02 09:29:46 +0100713 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_SIGNATURE_CHECKSUM
714 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_SIGNATURE_CHECKSUM";
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100715
716 /**
Alexandra Gherghinadb4bc572015-01-08 12:17:40 +0000717 * Broadcast Action: This broadcast is sent to indicate that provisioning of a managed profile
718 * has completed successfully.
719 *
720 * <p>The broadcast is limited to the primary profile, to the app specified in the provisioning
Nicolas Prevotebe2d992015-05-12 18:14:53 -0700721 * intent with action {@link #ACTION_PROVISION_MANAGED_PROFILE}.
Alexandra Gherghinadb4bc572015-01-08 12:17:40 +0000722 *
Ying Wang7f38aab2015-02-20 11:50:09 -0800723 * <p>This intent will contain the extra {@link #EXTRA_PROVISIONING_ACCOUNT_TO_MIGRATE} which
Alexandra Gherghinadb4bc572015-01-08 12:17:40 +0000724 * corresponds to the account requested to be migrated at provisioning time, if any.
725 */
726 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
727 public static final String ACTION_MANAGED_PROFILE_PROVISIONED
728 = "android.app.action.MANAGED_PROFILE_PROVISIONED";
729
730 /**
Benjamin Franzea956242016-03-21 15:45:56 +0000731 * A boolean extra indicating whether device encryption can be skipped as part of device owner
732 * or managed profile provisioning.
Julia Reynoldsa9ec70b2015-02-02 09:54:26 -0500733 *
Craig Lafayette3cc72ba2015-06-26 11:51:04 -0400734 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} or an intent with action
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100735 * {@link #ACTION_PROVISION_MANAGED_DEVICE} that starts device owner provisioning.
Benjamin Franzea956242016-03-21 15:45:56 +0000736 *
737 * <p>From {@link android.os.Build.VERSION_CODES#N} onwards, this is also supported for an
738 * intent with action {@link #ACTION_PROVISION_MANAGED_PROFILE}.
Julia Reynoldsa9ec70b2015-02-02 09:54:26 -0500739 */
740 public static final String EXTRA_PROVISIONING_SKIP_ENCRYPTION =
741 "android.app.extra.PROVISIONING_SKIP_ENCRYPTION";
742
743 /**
Nicolas Prevot8b7991c2015-11-12 17:40:12 +0000744 * A {@link Uri} extra pointing to a logo image. This image will be shown during the
745 * provisioning. If this extra is not passed, a default image will be shown.
746 * <h5>The following URI schemes are accepted:</h5>
747 * <ul>
748 * <li>content ({@link android.content.ContentResolver#SCHEME_CONTENT})</li>
749 * <li>android.resource ({@link android.content.ContentResolver#SCHEME_ANDROID_RESOURCE})</li>
750 * </ul>
751 *
752 * <p> It is the responsability of the caller to provide an image with a reasonable
753 * pixed density for the device.
754 *
755 * <p> If a content: URI is passed, the intent should have the flag
756 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION} and the uri should be added to the
757 * {@link android.content.ClipData} of the intent too.
758 *
759 * <p>Use in an intent with action {@link #ACTION_PROVISION_MANAGED_PROFILE} or
760 * {@link #ACTION_PROVISION_MANAGED_DEVICE}
761 */
762 public static final String EXTRA_PROVISIONING_LOGO_URI =
763 "android.app.extra.PROVISIONING_LOGO_URI";
764
765 /**
Alan Treadway94de8c82016-01-11 10:25:23 +0000766 * A boolean extra indicating if user setup should be skipped, for when provisioning is started
767 * during setup-wizard.
768 *
769 * <p>If unspecified, defaults to {@code true} to match the behavior in
770 * {@link android.os.Build.VERSION_CODES#M} and earlier.
771 *
Alan Treadway1a538d02016-01-18 16:42:30 +0000772 * <p>Use in an intent with action {@link #ACTION_PROVISION_MANAGED_DEVICE} or
773 * {@link #ACTION_PROVISION_MANAGED_USER}.
Alan Treadway94de8c82016-01-11 10:25:23 +0000774 *
775 * @hide
776 */
777 public static final String EXTRA_PROVISIONING_SKIP_USER_SETUP =
778 "android.app.extra.PROVISIONING_SKIP_USER_SETUP";
779
780 /**
Benjamin Franzea956242016-03-21 15:45:56 +0000781 * This MIME type is used for starting the device owner provisioning.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100782 *
Craig Lafayette3cc72ba2015-06-26 11:51:04 -0400783 * <p>During device owner provisioning a device admin app is set as the owner of the device.
784 * A device owner has full control over the device. The device owner can not be modified by the
785 * user and the only way of resetting the device is if the device owner app calls a factory
786 * reset.
787 *
788 * <p> A typical use case would be a device that is owned by a company, but used by either an
789 * employee or client.
790 *
Benjamin Franzea956242016-03-21 15:45:56 +0000791 * <p> The NFC message must be sent to an unprovisioned device.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100792 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000793 * <p>The NFC record must contain a serialized {@link java.util.Properties} object which
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100794 * contains the following properties:
795 * <ul>
Andrei Kapishnikov35e71f52015-03-16 17:24:04 -0400796 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME}</li>
797 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}, optional</li>
Sander Alewijnse681bce92014-07-24 16:46:26 +0100798 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER}, optional</li>
Andrei Kapishnikov35e71f52015-03-16 17:24:04 -0400799 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM}, optional</li>
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100800 * <li>{@link #EXTRA_PROVISIONING_LOCAL_TIME} (convert to String), optional</li>
801 * <li>{@link #EXTRA_PROVISIONING_TIME_ZONE}, optional</li>
802 * <li>{@link #EXTRA_PROVISIONING_LOCALE}, optional</li>
803 * <li>{@link #EXTRA_PROVISIONING_WIFI_SSID}, optional</li>
804 * <li>{@link #EXTRA_PROVISIONING_WIFI_HIDDEN} (convert to String), optional</li>
805 * <li>{@link #EXTRA_PROVISIONING_WIFI_SECURITY_TYPE}, optional</li>
806 * <li>{@link #EXTRA_PROVISIONING_WIFI_PASSWORD}, optional</li>
807 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_HOST}, optional</li>
808 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_PORT} (convert to String), optional</li>
809 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_BYPASS}, optional</li>
Rubin Xu41f2ccb92015-08-05 16:29:13 +0100810 * <li>{@link #EXTRA_PROVISIONING_WIFI_PAC_URL}, optional</li>
811 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional, supported from
812 * {@link android.os.Build.VERSION_CODES#M} </li></ul>
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100813 *
Nicolas Prevot18440252015-03-09 14:07:17 +0000814 * <p>
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -0700815 * As of {@link android.os.Build.VERSION_CODES#M}, the properties should contain
Andrei Kapishnikov35e71f52015-03-16 17:24:04 -0400816 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME} instead of
817 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME}, (although specifying only
818 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME} is still supported).
Andrei Kapishnikov35e71f52015-03-16 17:24:04 -0400819 */
820 public static final String MIME_TYPE_PROVISIONING_NFC
821 = "application/com.android.managedprovisioning";
822
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100823 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -0800824 * Activity action: ask the user to add a new device administrator to the system.
825 * The desired policy is the ComponentName of the policy in the
826 * {@link #EXTRA_DEVICE_ADMIN} extra field. This will invoke a UI to
827 * bring the user through adding the device administrator to the system (or
828 * allowing them to reject it).
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700829 *
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800830 * <p>You can optionally include the {@link #EXTRA_ADD_EXPLANATION}
831 * field to provide the user with additional explanation (in addition
832 * to your component's description) about what is being added.
Andy Stadlerc25f70a2010-12-08 15:56:45 -0800833 *
834 * <p>If your administrator is already active, this will ordinarily return immediately (without
835 * user intervention). However, if your administrator has been updated and is requesting
836 * additional uses-policy flags, the user will be presented with the new list. New policies
837 * will not be available to the updated administrator until the user has accepted the new list.
Dianne Hackbornd6847842010-01-12 18:14:19 -0800838 */
839 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
840 public static final String ACTION_ADD_DEVICE_ADMIN
841 = "android.app.action.ADD_DEVICE_ADMIN";
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700842
Dianne Hackbornd6847842010-01-12 18:14:19 -0800843 /**
Amith Yamasanibf3a9462014-07-28 14:26:42 -0700844 * @hide
845 * Activity action: ask the user to add a new device administrator as the profile owner
Amith Yamasani814e9872015-03-23 14:04:53 -0700846 * for this user. Only system apps can launch this intent.
Amith Yamasanibf3a9462014-07-28 14:26:42 -0700847 *
Amith Yamasani814e9872015-03-23 14:04:53 -0700848 * <p>The ComponentName of the profile owner admin is passed in the {@link #EXTRA_DEVICE_ADMIN}
849 * extra field. This will invoke a UI to bring the user through adding the profile owner admin
Amith Yamasanibf3a9462014-07-28 14:26:42 -0700850 * to remotely control restrictions on the user.
851 *
Makoto Onukic8a5a552015-11-19 14:29:12 -0800852 * <p>The intent must be invoked via {@link Activity#startActivityForResult} to receive the
Amith Yamasanibf3a9462014-07-28 14:26:42 -0700853 * result of whether or not the user approved the action. If approved, the result will
854 * be {@link Activity#RESULT_OK} and the component will be set as an active admin as well
855 * as a profile owner.
856 *
857 * <p>You can optionally include the {@link #EXTRA_ADD_EXPLANATION}
858 * field to provide the user with additional explanation (in addition
859 * to your component's description) about what is being added.
860 *
Amith Yamasani814e9872015-03-23 14:04:53 -0700861 * <p>If there is already a profile owner active or the caller is not a system app, the
862 * operation will return a failure result.
Amith Yamasanibf3a9462014-07-28 14:26:42 -0700863 */
864 @SystemApi
865 public static final String ACTION_SET_PROFILE_OWNER
866 = "android.app.action.SET_PROFILE_OWNER";
867
868 /**
869 * @hide
870 * Name of the profile owner admin that controls the user.
871 */
872 @SystemApi
873 public static final String EXTRA_PROFILE_OWNER_NAME
874 = "android.app.extra.PROFILE_OWNER_NAME";
875
876 /**
Nicolas Prevot00799002015-07-27 18:15:20 +0100877 * Broadcast action: send when any policy admin changes a policy.
Jim Miller284b62e2010-06-08 14:27:42 -0700878 * This is generally used to find out when a new policy is in effect.
Jim Miller3e5d3fd2011-09-02 17:30:35 -0700879 *
Jim Miller284b62e2010-06-08 14:27:42 -0700880 * @hide
881 */
882 public static final String ACTION_DEVICE_POLICY_MANAGER_STATE_CHANGED
883 = "android.app.action.DEVICE_POLICY_MANAGER_STATE_CHANGED";
884
885 /**
Nicolas Prevot00799002015-07-27 18:15:20 +0100886 * Broadcast action: sent when the device owner is set or changed.
887 *
888 * This broadcast is sent only to the primary user.
889 * @see #ACTION_PROVISION_MANAGED_DEVICE
890 */
891 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
892 public static final String ACTION_DEVICE_OWNER_CHANGED
893 = "android.app.action.DEVICE_OWNER_CHANGED";
894
895 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -0800896 * The ComponentName of the administrator component.
897 *
898 * @see #ACTION_ADD_DEVICE_ADMIN
899 */
900 public static final String EXTRA_DEVICE_ADMIN = "android.app.extra.DEVICE_ADMIN";
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700901
Dianne Hackbornd6847842010-01-12 18:14:19 -0800902 /**
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800903 * An optional CharSequence providing additional explanation for why the
904 * admin is being added.
905 *
906 * @see #ACTION_ADD_DEVICE_ADMIN
907 */
908 public static final String EXTRA_ADD_EXPLANATION = "android.app.extra.ADD_EXPLANATION";
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700909
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800910 /**
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700911 * Activity action: have the user enter a new password. This activity should
912 * be launched after using {@link #setPasswordQuality(ComponentName, int)},
913 * or {@link #setPasswordMinimumLength(ComponentName, int)} to have the user
914 * enter a new password that meets the current requirements. You can use
915 * {@link #isActivePasswordSufficient()} to determine whether you need to
916 * have the user select a new password in order to meet the current
917 * constraints. Upon being resumed from this activity, you can check the new
918 * password characteristics to see if they are sufficient.
Benjamin Franzc9921092016-01-08 17:17:44 +0000919 *
920 * If the intent is launched from within a managed profile with a profile
921 * owner built against {@link android.os.Build.VERSION_CODES#M} or before,
922 * this will trigger entering a new password for the parent of the profile.
923 * For all other cases it will trigger entering a new password for the user
924 * or profile it is launched from.
Esteban Talaverac1c83592016-02-17 17:56:15 +0000925 *
926 * @see #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD
Dianne Hackbornd6847842010-01-12 18:14:19 -0800927 */
928 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
929 public static final String ACTION_SET_NEW_PASSWORD
930 = "android.app.action.SET_NEW_PASSWORD";
Amith Yamasanibf3a9462014-07-28 14:26:42 -0700931
Nicolas Prevot10fa67c2014-03-24 13:44:38 +0000932 /**
Benjamin Franzc9921092016-01-08 17:17:44 +0000933 * Activity action: have the user enter a new password for the parent profile.
934 * If the intent is launched from within a managed profile, this will trigger
935 * entering a new password for the parent of the profile. In all other cases
936 * the behaviour is identical to {@link #ACTION_SET_NEW_PASSWORD}.
937 */
938 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
939 public static final String ACTION_SET_NEW_PARENT_PROFILE_PASSWORD
940 = "android.app.action.SET_NEW_PARENT_PROFILE_PASSWORD";
941
942 /**
Nicolas Prevot2c1c5dd2015-01-12 12:32:56 +0000943 * Flag used by {@link #addCrossProfileIntentFilter} to allow activities in
944 * the parent profile to access intents sent from the managed profile.
945 * That is, when an app in the managed profile calls
946 * {@link Activity#startActivity(Intent)}, the intent can be resolved by a
947 * matching activity in the parent profile.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +0000948 */
Nicolas Prevot86a96732014-09-08 12:13:05 +0100949 public static final int FLAG_PARENT_CAN_ACCESS_MANAGED = 0x0001;
Nicolas Prevot10fa67c2014-03-24 13:44:38 +0000950
951 /**
Nicolas Prevot2c1c5dd2015-01-12 12:32:56 +0000952 * Flag used by {@link #addCrossProfileIntentFilter} to allow activities in
953 * the managed profile to access intents sent from the parent profile.
954 * That is, when an app in the parent profile calls
955 * {@link Activity#startActivity(Intent)}, the intent can be resolved by a
956 * matching activity in the managed profile.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +0000957 */
Nicolas Prevot86a96732014-09-08 12:13:05 +0100958 public static final int FLAG_MANAGED_CAN_ACCESS_PARENT = 0x0002;
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700959
Dianne Hackbornd6847842010-01-12 18:14:19 -0800960 /**
Rubin Xu5faad8e2015-04-20 17:43:48 +0100961 * Broadcast action: notify that a new local system update policy has been set by the device
962 * owner. The new policy can be retrieved by {@link #getSystemUpdatePolicy()}.
Rubin Xu8027a4f2015-03-10 17:52:37 +0000963 */
964 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Rubin Xu5faad8e2015-04-20 17:43:48 +0100965 public static final String ACTION_SYSTEM_UPDATE_POLICY_CHANGED
966 = "android.app.action.SYSTEM_UPDATE_POLICY_CHANGED";
Rubin Xu8027a4f2015-03-10 17:52:37 +0000967
Amith Yamasanid49489b2015-04-28 14:00:26 -0700968 /**
969 * Permission policy to prompt user for new permission requests for runtime permissions.
970 * Already granted or denied permissions are not affected by this.
971 */
972 public static final int PERMISSION_POLICY_PROMPT = 0;
973
974 /**
975 * Permission policy to always grant new permission requests for runtime permissions.
976 * Already granted or denied permissions are not affected by this.
977 */
978 public static final int PERMISSION_POLICY_AUTO_GRANT = 1;
979
980 /**
981 * Permission policy to always deny new permission requests for runtime permissions.
982 * Already granted or denied permissions are not affected by this.
983 */
984 public static final int PERMISSION_POLICY_AUTO_DENY = 2;
985
Svet Ganovd8ecc5a2015-05-20 10:45:43 -0700986 /**
987 * Runtime permission state: The user can manage the permission
988 * through the UI.
989 */
990 public static final int PERMISSION_GRANT_STATE_DEFAULT = 0;
991
992 /**
993 * Runtime permission state: The permission is granted to the app
994 * and the user cannot manage the permission through the UI.
995 */
996 public static final int PERMISSION_GRANT_STATE_GRANTED = 1;
997
998 /**
999 * Runtime permission state: The permission is denied to the app
1000 * and the user cannot manage the permission through the UI.
1001 */
1002 public static final int PERMISSION_GRANT_STATE_DENIED = 2;
Rubin Xu8027a4f2015-03-10 17:52:37 +00001003
1004 /**
Alan Treadwayafad8782016-01-19 15:15:08 +00001005 * No management for current user in-effect. This is the default.
1006 * @hide
1007 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00001008 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00001009 public static final int STATE_USER_UNMANAGED = 0;
1010
1011 /**
1012 * Management partially setup, user setup needs to be completed.
1013 * @hide
1014 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00001015 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00001016 public static final int STATE_USER_SETUP_INCOMPLETE = 1;
1017
1018 /**
1019 * Management partially setup, user setup completed.
1020 * @hide
1021 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00001022 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00001023 public static final int STATE_USER_SETUP_COMPLETE = 2;
1024
1025 /**
1026 * Management setup and active on current user.
1027 * @hide
1028 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00001029 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00001030 public static final int STATE_USER_SETUP_FINALIZED = 3;
1031
1032 /**
1033 * Management partially setup on a managed profile.
1034 * @hide
1035 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00001036 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00001037 public static final int STATE_USER_PROFILE_COMPLETE = 4;
1038
1039 /**
1040 * @hide
1041 */
1042 @IntDef({STATE_USER_UNMANAGED, STATE_USER_SETUP_INCOMPLETE, STATE_USER_SETUP_COMPLETE,
1043 STATE_USER_SETUP_FINALIZED, STATE_USER_PROFILE_COMPLETE})
1044 @Retention(RetentionPolicy.SOURCE)
1045 public @interface UserProvisioningState {}
1046
1047 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001048 * Return true if the given administrator component is currently active (enabled) in the system.
1049 *
1050 * @param admin The administrator component to check for.
1051 * @return {@code true} if {@code admin} is currently enabled in the system, {@code false}
1052 * otherwise
Dianne Hackbornd6847842010-01-12 18:14:19 -08001053 */
Robin Lee25e26452015-06-02 09:56:29 -07001054 public boolean isAdminActive(@NonNull ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001055 return isAdminActiveAsUser(admin, myUserId());
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01001056 }
1057
1058 /**
1059 * @see #isAdminActive(ComponentName)
1060 * @hide
1061 */
Robin Lee25e26452015-06-02 09:56:29 -07001062 public boolean isAdminActiveAsUser(@NonNull ComponentName admin, int userId) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001063 if (mService != null) {
1064 try {
Robin Lee25e26452015-06-02 09:56:29 -07001065 return mService.isAdminActive(admin, userId);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001066 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001067 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001068 }
1069 }
1070 return false;
1071 }
Fyodor Kupolov96fb9322014-12-01 15:08:09 -08001072 /**
1073 * Return true if the given administrator component is currently being removed
1074 * for the user.
1075 * @hide
1076 */
Robin Lee25e26452015-06-02 09:56:29 -07001077 public boolean isRemovingAdmin(@NonNull ComponentName admin, int userId) {
Fyodor Kupolov96fb9322014-12-01 15:08:09 -08001078 if (mService != null) {
1079 try {
Robin Lee25e26452015-06-02 09:56:29 -07001080 return mService.isRemovingAdmin(admin, userId);
Fyodor Kupolov96fb9322014-12-01 15:08:09 -08001081 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001082 throw e.rethrowFromSystemServer();
Fyodor Kupolov96fb9322014-12-01 15:08:09 -08001083 }
1084 }
1085 return false;
1086 }
1087
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001088
Dianne Hackbornd6847842010-01-12 18:14:19 -08001089 /**
Robin Lee25e26452015-06-02 09:56:29 -07001090 * Return a list of all currently active device administrators' component
1091 * names. If there are no administrators {@code null} may be
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001092 * returned.
1093 */
1094 public List<ComponentName> getActiveAdmins() {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001095 return getActiveAdminsAsUser(myUserId());
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01001096 }
1097
1098 /**
1099 * @see #getActiveAdmins()
1100 * @hide
1101 */
1102 public List<ComponentName> getActiveAdminsAsUser(int userId) {
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001103 if (mService != null) {
1104 try {
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01001105 return mService.getActiveAdmins(userId);
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001106 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001107 throw e.rethrowFromSystemServer();
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001108 }
1109 }
1110 return null;
1111 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001112
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001113 /**
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001114 * Used by package administration code to determine if a package can be stopped
1115 * or uninstalled.
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001116 * @hide
1117 */
1118 public boolean packageHasActiveAdmins(String packageName) {
Amith Yamasanica5d6d22016-02-16 13:58:46 -08001119 return packageHasActiveAdmins(packageName, myUserId());
1120 }
1121
1122 /**
1123 * Used by package administration code to determine if a package can be stopped
1124 * or uninstalled.
1125 * @hide
1126 */
1127 public boolean packageHasActiveAdmins(String packageName, int userId) {
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001128 if (mService != null) {
1129 try {
Amith Yamasanica5d6d22016-02-16 13:58:46 -08001130 return mService.packageHasActiveAdmins(packageName, userId);
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001131 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001132 throw e.rethrowFromSystemServer();
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001133 }
1134 }
1135 return false;
1136 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001137
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001138 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -08001139 * Remove a current administration component. This can only be called
1140 * by the application that owns the administration component; if you
1141 * try to remove someone else's component, a security exception will be
1142 * thrown.
Esteban Talavera552a5612016-02-19 17:02:24 +00001143 *
1144 * <p>Note that the operation is not synchronous and the admin might still be active (as
1145 * indicated by {@link #getActiveAdmins()}) by the time this method returns.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001146 *
1147 * @param admin The administration compononent to remove.
1148 * @throws SecurityException if the caller is not in the owner application of {@code admin}.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001149 */
Robin Lee25e26452015-06-02 09:56:29 -07001150 public void removeActiveAdmin(@NonNull ComponentName admin) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001151 if (mService != null) {
1152 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001153 mService.removeActiveAdmin(admin, myUserId());
Dianne Hackbornd6847842010-01-12 18:14:19 -08001154 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001155 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001156 }
1157 }
1158 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001159
Dianne Hackbornd6847842010-01-12 18:14:19 -08001160 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001161 * Returns true if an administrator has been granted a particular device policy. This can be
1162 * used to check whether the administrator was activated under an earlier set of policies, but
1163 * requires additional policies after an upgrade.
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001164 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001165 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. Must be an
1166 * active administrator, or an exception will be thrown.
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001167 * @param usesPolicy Which uses-policy to check, as defined in {@link DeviceAdminInfo}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001168 * @throws SecurityException if {@code admin} is not an active administrator.
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001169 */
Robin Lee25e26452015-06-02 09:56:29 -07001170 public boolean hasGrantedPolicy(@NonNull ComponentName admin, int usesPolicy) {
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001171 if (mService != null) {
1172 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001173 return mService.hasGrantedPolicy(admin, usesPolicy, myUserId());
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001174 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001175 throw e.rethrowFromSystemServer();
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001176 }
1177 }
1178 return false;
1179 }
1180
1181 /**
Clara Bayarria1771112015-12-18 16:29:18 +00001182 * Returns true if the Profile Challenge is available to use for the given profile user.
1183 *
1184 * @hide
1185 */
1186 public boolean isSeparateProfileChallengeAllowed(int userHandle) {
1187 if (mService != null) {
1188 try {
1189 return mService.isSeparateProfileChallengeAllowed(userHandle);
1190 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001191 throw e.rethrowFromSystemServer();
Clara Bayarria1771112015-12-18 16:29:18 +00001192 }
1193 }
1194 return false;
1195 }
1196
1197 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001198 * Constant for {@link #setPasswordQuality}: the policy has no requirements
1199 * for the password. Note that quality constants are ordered so that higher
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001200 * values are more restrictive.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001201 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001202 public static final int PASSWORD_QUALITY_UNSPECIFIED = 0;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001203
Dianne Hackbornd6847842010-01-12 18:14:19 -08001204 /**
Jim Miller3e5d3fd2011-09-02 17:30:35 -07001205 * Constant for {@link #setPasswordQuality}: the policy allows for low-security biometric
1206 * recognition technology. This implies technologies that can recognize the identity of
1207 * an individual to about a 3 digit PIN (false detection is less than 1 in 1,000).
1208 * Note that quality constants are ordered so that higher values are more restrictive.
1209 */
1210 public static final int PASSWORD_QUALITY_BIOMETRIC_WEAK = 0x8000;
1211
1212 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001213 * Constant for {@link #setPasswordQuality}: the policy requires some kind
Benjamin Franzc6a96532015-06-16 11:23:38 +01001214 * of password or pattern, but doesn't care what it is. Note that quality constants
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001215 * are ordered so that higher values are more restrictive.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001216 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001217 public static final int PASSWORD_QUALITY_SOMETHING = 0x10000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001218
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001219 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001220 * Constant for {@link #setPasswordQuality}: the user must have entered a
1221 * password containing at least numeric characters. Note that quality
1222 * constants are ordered so that higher values are more restrictive.
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001223 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001224 public static final int PASSWORD_QUALITY_NUMERIC = 0x20000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001225
Dianne Hackbornd6847842010-01-12 18:14:19 -08001226 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001227 * Constant for {@link #setPasswordQuality}: the user must have entered a
Jim Miller85516d02014-01-31 17:08:37 -08001228 * password containing at least numeric characters with no repeating (4444)
1229 * or ordered (1234, 4321, 2468) sequences. Note that quality
1230 * constants are ordered so that higher values are more restrictive.
1231 */
1232 public static final int PASSWORD_QUALITY_NUMERIC_COMPLEX = 0x30000;
1233
1234 /**
1235 * Constant for {@link #setPasswordQuality}: the user must have entered a
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -07001236 * password containing at least alphabetic (or other symbol) characters.
1237 * Note that quality constants are ordered so that higher values are more
1238 * restrictive.
1239 */
1240 public static final int PASSWORD_QUALITY_ALPHABETIC = 0x40000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001241
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -07001242 /**
1243 * Constant for {@link #setPasswordQuality}: the user must have entered a
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001244 * password containing at least <em>both></em> numeric <em>and</em>
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -07001245 * alphabetic (or other symbol) characters. Note that quality constants are
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001246 * ordered so that higher values are more restrictive.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001247 */
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -07001248 public static final int PASSWORD_QUALITY_ALPHANUMERIC = 0x50000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001249
Dianne Hackbornd6847842010-01-12 18:14:19 -08001250 /**
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001251 * Constant for {@link #setPasswordQuality}: the user must have entered a
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001252 * password containing at least a letter, a numerical digit and a special
1253 * symbol, by default. With this password quality, passwords can be
1254 * restricted to contain various sets of characters, like at least an
1255 * uppercase letter, etc. These are specified using various methods,
1256 * like {@link #setPasswordMinimumLowerCase(ComponentName, int)}. Note
1257 * that quality constants are ordered so that higher values are more
1258 * restrictive.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001259 */
1260 public static final int PASSWORD_QUALITY_COMPLEX = 0x60000;
1261
1262 /**
Oleksandr Peletskyi0fdcd3d2016-01-13 16:49:56 +01001263 * Constant for {@link #setPasswordQuality}: the user is not allowed to
1264 * modify password. In case this password quality is set, the password is
1265 * managed by a profile owner. The profile owner can set any password,
1266 * as if {@link #PASSWORD_QUALITY_UNSPECIFIED} is used. Note
1267 * that quality constants are ordered so that higher values are more
1268 * restrictive. The value of {@link #PASSWORD_QUALITY_MANAGED} is
1269 * the highest.
1270 * @hide
1271 */
1272 public static final int PASSWORD_QUALITY_MANAGED = 0x80000;
1273
1274 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001275 * Called by an application that is administering the device to set the password restrictions it
1276 * is imposing. After setting this, the user will not be able to enter a new password that is
1277 * not at least as restrictive as what has been set. Note that the current password will remain
1278 * until the user has set a new one, so the change does not take place immediately. To prompt
1279 * the user for a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
Esteban Talaverac1c83592016-02-17 17:56:15 +00001280 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after calling this method.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001281 * <p>
1282 * Quality constants are ordered so that higher values are more restrictive; thus the highest
1283 * requested quality constant (between the policy set here, the user's preference, and any other
1284 * considerations) is the one that is in effect.
1285 * <p>
1286 * The calling device admin must have requested
1287 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1288 * not, a security exception will be thrown.
1289 * <p>
1290 * This method can be called on the {@link DevicePolicyManager} instance returned by
1291 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1292 * profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00001293 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08001294 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001295 * @param quality The new desired quality. One of {@link #PASSWORD_QUALITY_UNSPECIFIED},
1296 * {@link #PASSWORD_QUALITY_SOMETHING}, {@link #PASSWORD_QUALITY_NUMERIC},
1297 * {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX}, {@link #PASSWORD_QUALITY_ALPHABETIC},
1298 * {@link #PASSWORD_QUALITY_ALPHANUMERIC} or {@link #PASSWORD_QUALITY_COMPLEX}.
1299 * @throws SecurityException if {@code admin} is not an active administrator or if {@code admin}
1300 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Dianne Hackbornd6847842010-01-12 18:14:19 -08001301 */
Robin Lee25e26452015-06-02 09:56:29 -07001302 public void setPasswordQuality(@NonNull ComponentName admin, int quality) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001303 if (mService != null) {
1304 try {
Clara Bayarri3e826ef2015-12-14 17:51:22 +00001305 mService.setPasswordQuality(admin, quality, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001306 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001307 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001308 }
1309 }
1310 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001311
Dianne Hackbornd6847842010-01-12 18:14:19 -08001312 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001313 * Retrieve the current minimum password quality for a particular admin or all admins that set
1314 * retrictions on this user and its participating profiles. Restrictions on profiles that have
1315 * a separate challenge are not taken into account.
1316 *
1317 * <p>This method can be called on the {@link DevicePolicyManager} instance
1318 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1319 * restrictions on the parent profile.
1320 *
Robin Lee25e26452015-06-02 09:56:29 -07001321 * @param admin The name of the admin component to check, or {@code null} to aggregate
Dianne Hackborn254cb442010-01-27 19:23:59 -08001322 * all admins.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001323 */
Robin Lee25e26452015-06-02 09:56:29 -07001324 public int getPasswordQuality(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001325 return getPasswordQuality(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001326 }
1327
1328 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001329 public int getPasswordQuality(@Nullable ComponentName admin, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001330 if (mService != null) {
1331 try {
Clara Bayarri3e826ef2015-12-14 17:51:22 +00001332 return mService.getPasswordQuality(admin, userHandle, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001333 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001334 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001335 }
1336 }
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001337 return PASSWORD_QUALITY_UNSPECIFIED;
Dianne Hackbornd6847842010-01-12 18:14:19 -08001338 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001339
Dianne Hackbornd6847842010-01-12 18:14:19 -08001340 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001341 * Called by an application that is administering the device to set the minimum allowed password
1342 * length. After setting this, the user will not be able to enter a new password that is not at
1343 * least as restrictive as what has been set. Note that the current password will remain until
1344 * the user has set a new one, so the change does not take place immediately. To prompt the user
1345 * for a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
1346 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This constraint is
1347 * only imposed if the administrator has also requested either {@link #PASSWORD_QUALITY_NUMERIC}
1348 * , {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX}, {@link #PASSWORD_QUALITY_ALPHABETIC},
1349 * {@link #PASSWORD_QUALITY_ALPHANUMERIC}, or {@link #PASSWORD_QUALITY_COMPLEX} with
1350 * {@link #setPasswordQuality}.
1351 * <p>
1352 * The calling device admin must have requested
1353 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1354 * not, a security exception will be thrown.
1355 * <p>
1356 * This method can be called on the {@link DevicePolicyManager} instance returned by
1357 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1358 * profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00001359 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08001360 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001361 * @param length The new desired minimum password length. A value of 0 means there is no
1362 * restriction.
1363 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1364 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Dianne Hackbornd6847842010-01-12 18:14:19 -08001365 */
Robin Lee25e26452015-06-02 09:56:29 -07001366 public void setPasswordMinimumLength(@NonNull ComponentName admin, int length) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001367 if (mService != null) {
1368 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001369 mService.setPasswordMinimumLength(admin, length, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001370 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001371 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001372 }
1373 }
1374 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001375
Dianne Hackbornd6847842010-01-12 18:14:19 -08001376 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001377 * Retrieve the current minimum password length for a particular admin or all admins that set
1378 * retrictions on this user and its participating profiles. Restrictions on profiles that have
1379 * a separate challenge are not taken into account.
1380 *
1381 * <p>This method can be called on the {@link DevicePolicyManager} instance
1382 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1383 * restrictions on the parent profile.
1384 *
Jessica Hummel91da58d2014-04-10 17:39:43 +01001385 * user and its profiles or a particular one.
Robin Lee25e26452015-06-02 09:56:29 -07001386 * @param admin The name of the admin component to check, or {@code null} to aggregate
Dianne Hackborn254cb442010-01-27 19:23:59 -08001387 * all admins.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001388 */
Robin Lee25e26452015-06-02 09:56:29 -07001389 public int getPasswordMinimumLength(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001390 return getPasswordMinimumLength(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001391 }
1392
1393 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001394 public int getPasswordMinimumLength(@Nullable ComponentName admin, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001395 if (mService != null) {
1396 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001397 return mService.getPasswordMinimumLength(admin, userHandle, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001398 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001399 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001400 }
1401 }
1402 return 0;
1403 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001404
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001405 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001406 * Called by an application that is administering the device to set the minimum number of upper
1407 * case letters required in the password. After setting this, the user will not be able to enter
1408 * a new password that is not at least as restrictive as what has been set. Note that the
1409 * current password will remain until the user has set a new one, so the change does not take
1410 * place immediately. To prompt the user for a new password, use
1411 * {@link #ACTION_SET_NEW_PASSWORD} or {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after
1412 * setting this value. This constraint is only imposed if the administrator has also requested
1413 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The default value is 0.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001414 * <p>
1415 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001416 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1417 * not, a security exception will be thrown.
1418 * <p>
1419 * This method can be called on the {@link DevicePolicyManager} instance returned by
1420 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1421 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001422 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001423 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1424 * @param length The new desired minimum number of upper case letters required in the password.
1425 * A value of 0 means there is no restriction.
1426 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1427 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001428 */
Robin Lee25e26452015-06-02 09:56:29 -07001429 public void setPasswordMinimumUpperCase(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001430 if (mService != null) {
1431 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001432 mService.setPasswordMinimumUpperCase(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001433 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001434 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001435 }
1436 }
1437 }
1438
1439 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001440 * Retrieve the current number of upper case letters required in the password
1441 * for a particular admin or all admins that set retrictions on this user and
1442 * its participating profiles. Restrictions on profiles that have a separate challenge
1443 * are not taken into account.
Jessica Hummel91da58d2014-04-10 17:39:43 +01001444 * This is the same value as set by
Esteban Talaverac1c83592016-02-17 17:56:15 +00001445 * {@link #setPasswordMinimumUpperCase(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001446 * and only applies when the password quality is
1447 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001448 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001449 * <p>This method can be called on the {@link DevicePolicyManager} instance
1450 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1451 * restrictions on the parent profile.
1452 *
Robin Lee25e26452015-06-02 09:56:29 -07001453 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001454 * aggregate all admins.
1455 * @return The minimum number of upper case letters required in the
1456 * password.
1457 */
Robin Lee25e26452015-06-02 09:56:29 -07001458 public int getPasswordMinimumUpperCase(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001459 return getPasswordMinimumUpperCase(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001460 }
1461
1462 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001463 public int getPasswordMinimumUpperCase(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001464 if (mService != null) {
1465 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001466 return mService.getPasswordMinimumUpperCase(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001467 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001468 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001469 }
1470 }
1471 return 0;
1472 }
1473
1474 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001475 * Called by an application that is administering the device to set the minimum number of lower
1476 * case letters required in the password. After setting this, the user will not be able to enter
1477 * a new password that is not at least as restrictive as what has been set. Note that the
1478 * current password will remain until the user has set a new one, so the change does not take
1479 * place immediately. To prompt the user for a new password, use
1480 * {@link #ACTION_SET_NEW_PASSWORD} or {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after
1481 * setting this value. This constraint is only imposed if the administrator has also requested
1482 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The default value is 0.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001483 * <p>
1484 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001485 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1486 * not, a security exception will be thrown.
1487 * <p>
1488 * This method can be called on the {@link DevicePolicyManager} instance returned by
1489 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1490 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001491 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001492 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1493 * @param length The new desired minimum number of lower case letters required in the password.
1494 * A value of 0 means there is no restriction.
1495 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1496 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001497 */
Robin Lee25e26452015-06-02 09:56:29 -07001498 public void setPasswordMinimumLowerCase(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001499 if (mService != null) {
1500 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001501 mService.setPasswordMinimumLowerCase(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001502 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001503 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001504 }
1505 }
1506 }
1507
1508 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001509 * Retrieve the current number of lower case letters required in the password
1510 * for a particular admin or all admins that set retrictions on this user
1511 * and its participating profiles. Restrictions on profiles that have
1512 * a separate challenge are not taken into account.
Jessica Hummel91da58d2014-04-10 17:39:43 +01001513 * This is the same value as set by
Esteban Talaverac1c83592016-02-17 17:56:15 +00001514 * {@link #setPasswordMinimumLowerCase(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001515 * and only applies when the password quality is
1516 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001517 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001518 * <p>This method can be called on the {@link DevicePolicyManager} instance
1519 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1520 * restrictions on the parent profile.
1521 *
Robin Lee25e26452015-06-02 09:56:29 -07001522 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001523 * aggregate all admins.
1524 * @return The minimum number of lower case letters required in the
1525 * password.
1526 */
Robin Lee25e26452015-06-02 09:56:29 -07001527 public int getPasswordMinimumLowerCase(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001528 return getPasswordMinimumLowerCase(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001529 }
1530
1531 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001532 public int getPasswordMinimumLowerCase(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001533 if (mService != null) {
1534 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001535 return mService.getPasswordMinimumLowerCase(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001536 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001537 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001538 }
1539 }
1540 return 0;
1541 }
1542
1543 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001544 * Called by an application that is administering the device to set the minimum number of
1545 * letters required in the password. After setting this, the user will not be able to enter a
1546 * new password that is not at least as restrictive as what has been set. Note that the current
1547 * password will remain until the user has set a new one, so the change does not take place
1548 * immediately. To prompt the user for a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
1549 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This constraint is
1550 * only imposed if the administrator has also requested {@link #PASSWORD_QUALITY_COMPLEX} with
1551 * {@link #setPasswordQuality}. The default value is 1.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001552 * <p>
1553 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001554 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1555 * not, a security exception will be thrown.
1556 * <p>
1557 * This method can be called on the {@link DevicePolicyManager} instance returned by
1558 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1559 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001560 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001561 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1562 * @param length The new desired minimum number of letters required in the password. A value of
1563 * 0 means there is no restriction.
1564 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1565 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001566 */
Robin Lee25e26452015-06-02 09:56:29 -07001567 public void setPasswordMinimumLetters(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001568 if (mService != null) {
1569 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001570 mService.setPasswordMinimumLetters(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001571 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001572 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001573 }
1574 }
1575 }
1576
1577 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001578 * Retrieve the current number of letters required in the password
1579 * for a particular admin or all admins that set retrictions on this user
1580 * and its participating profiles. Restrictions on profiles that have
1581 * a separate challenge are not taken into account.
1582 * This is the same value as set by
1583 * {@link #setPasswordMinimumLetters(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001584 * and only applies when the password quality is
1585 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001586 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001587 * <p>This method can be called on the {@link DevicePolicyManager} instance
1588 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1589 * restrictions on the parent profile.
1590 *
Robin Lee25e26452015-06-02 09:56:29 -07001591 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001592 * aggregate all admins.
1593 * @return The minimum number of letters required in the password.
1594 */
Robin Lee25e26452015-06-02 09:56:29 -07001595 public int getPasswordMinimumLetters(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001596 return getPasswordMinimumLetters(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001597 }
1598
1599 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001600 public int getPasswordMinimumLetters(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001601 if (mService != null) {
1602 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001603 return mService.getPasswordMinimumLetters(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001604 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001605 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001606 }
1607 }
1608 return 0;
1609 }
1610
1611 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001612 * Called by an application that is administering the device to set the minimum number of
1613 * numerical digits required in the password. After setting this, the user will not be able to
1614 * enter a new password that is not at least as restrictive as what has been set. Note that the
1615 * current password will remain until the user has set a new one, so the change does not take
1616 * place immediately. To prompt the user for a new password, use
1617 * {@link #ACTION_SET_NEW_PASSWORD} or {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after
1618 * setting this value. This constraint is only imposed if the administrator has also requested
1619 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The default value is 1.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001620 * <p>
1621 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001622 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1623 * not, a security exception will be thrown.
1624 * <p>
1625 * This method can be called on the {@link DevicePolicyManager} instance returned by
1626 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1627 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001628 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001629 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1630 * @param length The new desired minimum number of numerical digits required in the password. A
1631 * value of 0 means there is no restriction.
1632 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1633 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001634 */
Robin Lee25e26452015-06-02 09:56:29 -07001635 public void setPasswordMinimumNumeric(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001636 if (mService != null) {
1637 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001638 mService.setPasswordMinimumNumeric(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001639 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001640 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001641 }
1642 }
1643 }
1644
1645 /**
1646 * Retrieve the current number of numerical digits required in the password
Esteban Talaverac1c83592016-02-17 17:56:15 +00001647 * for a particular admin or all admins that set retrictions on this user
1648 * and its participating profiles. Restrictions on profiles that have
1649 * a separate challenge are not taken into account.
Jessica Hummel91da58d2014-04-10 17:39:43 +01001650 * This is the same value as set by
Esteban Talaverac1c83592016-02-17 17:56:15 +00001651 * {@link #setPasswordMinimumNumeric(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001652 * and only applies when the password quality is
1653 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001654 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001655 * <p>This method can be called on the {@link DevicePolicyManager} instance
1656 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1657 * restrictions on the parent profile.
1658 *
Robin Lee25e26452015-06-02 09:56:29 -07001659 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001660 * aggregate all admins.
1661 * @return The minimum number of numerical digits required in the password.
1662 */
Robin Lee25e26452015-06-02 09:56:29 -07001663 public int getPasswordMinimumNumeric(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001664 return getPasswordMinimumNumeric(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001665 }
1666
1667 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001668 public int getPasswordMinimumNumeric(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001669 if (mService != null) {
1670 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001671 return mService.getPasswordMinimumNumeric(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001672 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001673 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001674 }
1675 }
1676 return 0;
1677 }
1678
1679 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001680 * Called by an application that is administering the device to set the minimum number of
1681 * symbols required in the password. After setting this, the user will not be able to enter a
1682 * new password that is not at least as restrictive as what has been set. Note that the current
1683 * password will remain until the user has set a new one, so the change does not take place
1684 * immediately. To prompt the user for a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
1685 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This constraint is
1686 * only imposed if the administrator has also requested {@link #PASSWORD_QUALITY_COMPLEX} with
1687 * {@link #setPasswordQuality}. The default value is 1.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001688 * <p>
1689 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001690 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1691 * not, a security exception will be thrown.
1692 * <p>
1693 * This method can be called on the {@link DevicePolicyManager} instance returned by
1694 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1695 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001696 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001697 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1698 * @param length The new desired minimum number of symbols required in the password. A value of
1699 * 0 means there is no restriction.
1700 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1701 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001702 */
Robin Lee25e26452015-06-02 09:56:29 -07001703 public void setPasswordMinimumSymbols(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001704 if (mService != null) {
1705 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001706 mService.setPasswordMinimumSymbols(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001707 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001708 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001709 }
1710 }
1711 }
1712
1713 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001714 * Retrieve the current number of symbols required in the password
1715 * for a particular admin or all admins that set retrictions on this user
1716 * and its participating profiles. Restrictions on profiles that have
1717 * a separate challenge are not taken into account. This is the same value as
1718 * set by {@link #setPasswordMinimumSymbols(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001719 * and only applies when the password quality is
1720 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001721 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001722 * <p>This method can be called on the {@link DevicePolicyManager} instance
1723 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1724 * restrictions on the parent profile.
1725 *
Robin Lee25e26452015-06-02 09:56:29 -07001726 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001727 * aggregate all admins.
1728 * @return The minimum number of symbols required in the password.
1729 */
Robin Lee25e26452015-06-02 09:56:29 -07001730 public int getPasswordMinimumSymbols(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001731 return getPasswordMinimumSymbols(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001732 }
1733
1734 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001735 public int getPasswordMinimumSymbols(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001736 if (mService != null) {
1737 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001738 return mService.getPasswordMinimumSymbols(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001739 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001740 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001741 }
1742 }
1743 return 0;
1744 }
1745
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001746 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001747 * Called by an application that is administering the device to set the minimum number of
1748 * non-letter characters (numerical digits or symbols) required in the password. After setting
1749 * this, the user will not be able to enter a new password that is not at least as restrictive
1750 * as what has been set. Note that the current password will remain until the user has set a new
1751 * one, so the change does not take place immediately. To prompt the user for a new password,
1752 * use {@link #ACTION_SET_NEW_PASSWORD} or {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after
1753 * setting this value. This constraint is only imposed if the administrator has also requested
1754 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The default value is 0.
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001755 * <p>
1756 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001757 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1758 * not, a security exception will be thrown.
1759 * <p>
1760 * This method can be called on the {@link DevicePolicyManager} instance returned by
1761 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1762 * profile.
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001763 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001764 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1765 * @param length The new desired minimum number of letters required in the password. A value of
1766 * 0 means there is no restriction.
1767 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1768 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001769 */
Robin Lee25e26452015-06-02 09:56:29 -07001770 public void setPasswordMinimumNonLetter(@NonNull ComponentName admin, int length) {
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001771 if (mService != null) {
1772 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001773 mService.setPasswordMinimumNonLetter(admin, length, mParentInstance);
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001774 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001775 throw e.rethrowFromSystemServer();
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001776 }
1777 }
1778 }
1779
1780 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001781 * Retrieve the current number of non-letter characters required in the password
1782 * for a particular admin or all admins that set retrictions on this user
1783 * and its participating profiles. Restrictions on profiles that have
1784 * a separate challenge are not taken into account.
Jessica Hummel91da58d2014-04-10 17:39:43 +01001785 * This is the same value as set by
Esteban Talaverac1c83592016-02-17 17:56:15 +00001786 * {@link #setPasswordMinimumNonLetter(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001787 * and only applies when the password quality is
1788 * {@link #PASSWORD_QUALITY_COMPLEX}.
1789 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001790 * <p>This method can be called on the {@link DevicePolicyManager} instance
1791 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1792 * restrictions on the parent profile.
1793 *
Robin Lee25e26452015-06-02 09:56:29 -07001794 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001795 * aggregate all admins.
1796 * @return The minimum number of letters required in the password.
1797 */
Robin Lee25e26452015-06-02 09:56:29 -07001798 public int getPasswordMinimumNonLetter(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001799 return getPasswordMinimumNonLetter(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001800 }
1801
1802 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001803 public int getPasswordMinimumNonLetter(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001804 if (mService != null) {
1805 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001806 return mService.getPasswordMinimumNonLetter(admin, userHandle, mParentInstance);
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001807 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001808 throw e.rethrowFromSystemServer();
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001809 }
1810 }
1811 return 0;
1812 }
1813
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001814 /**
1815 * Called by an application that is administering the device to set the length of the password
1816 * history. After setting this, the user will not be able to enter a new password that is the
1817 * same as any password in the history. Note that the current password will remain until the
1818 * user has set a new one, so the change does not take place immediately. To prompt the user for
1819 * a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
1820 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This constraint is
1821 * only imposed if the administrator has also requested either {@link #PASSWORD_QUALITY_NUMERIC}
1822 * , {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX} {@link #PASSWORD_QUALITY_ALPHABETIC}, or
1823 * {@link #PASSWORD_QUALITY_ALPHANUMERIC} with {@link #setPasswordQuality}.
1824 * <p>
1825 * The calling device admin must have requested
1826 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1827 * not, a security exception will be thrown.
1828 * <p>
1829 * This method can be called on the {@link DevicePolicyManager} instance returned by
1830 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1831 * profile.
1832 *
1833 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1834 * @param length The new desired length of password history. A value of 0 means there is no
1835 * restriction.
1836 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1837 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
1838 */
Robin Lee25e26452015-06-02 09:56:29 -07001839 public void setPasswordHistoryLength(@NonNull ComponentName admin, int length) {
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001840 if (mService != null) {
1841 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001842 mService.setPasswordHistoryLength(admin, length, mParentInstance);
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001843 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001844 throw e.rethrowFromSystemServer();
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001845 }
1846 }
1847 }
1848
1849 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001850 * Called by a device admin to set the password expiration timeout. Calling this method will
1851 * restart the countdown for password expiration for the given admin, as will changing the
1852 * device password (for all admins).
1853 * <p>
1854 * The provided timeout is the time delta in ms and will be added to the current time. For
1855 * example, to have the password expire 5 days from now, timeout would be 5 * 86400 * 1000 =
1856 * 432000000 ms for timeout.
1857 * <p>
1858 * To disable password expiration, a value of 0 may be used for timeout.
1859 * <p>
1860 * The calling device admin must have requested
1861 * {@link DeviceAdminInfo#USES_POLICY_EXPIRE_PASSWORD} to be able to call this method; if it has
1862 * not, a security exception will be thrown.
1863 * <p>
1864 * Note that setting the password will automatically reset the expiration time for all active
1865 * admins. Active admins do not need to explicitly call this method in that case.
1866 * <p>
1867 * This method can be called on the {@link DevicePolicyManager} instance returned by
1868 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1869 * profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00001870 *
Jim Millera4e28d12010-11-08 16:15:47 -08001871 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001872 * @param timeout The limit (in ms) that a password can remain in effect. A value of 0 means
1873 * there is no restriction (unlimited).
1874 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1875 * does not use {@link DeviceAdminInfo#USES_POLICY_EXPIRE_PASSWORD}
Jim Millera4e28d12010-11-08 16:15:47 -08001876 */
Robin Lee25e26452015-06-02 09:56:29 -07001877 public void setPasswordExpirationTimeout(@NonNull ComponentName admin, long timeout) {
Jim Millera4e28d12010-11-08 16:15:47 -08001878 if (mService != null) {
1879 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001880 mService.setPasswordExpirationTimeout(admin, timeout, mParentInstance);
Jim Millera4e28d12010-11-08 16:15:47 -08001881 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001882 throw e.rethrowFromSystemServer();
Jim Millera4e28d12010-11-08 16:15:47 -08001883 }
1884 }
1885 }
1886
1887 /**
Jim Miller6b857682011-02-16 16:27:41 -08001888 * Get the password expiration timeout for the given admin. The expiration timeout is the
1889 * recurring expiration timeout provided in the call to
1890 * {@link #setPasswordExpirationTimeout(ComponentName, long)} for the given admin or the
Esteban Talaverac1c83592016-02-17 17:56:15 +00001891 * aggregate of all participating policy administrators if {@code admin} is null. Admins that
1892 * have set restrictions on profiles that have a separate challenge are not taken into account.
1893 *
1894 * <p>This method can be called on the {@link DevicePolicyManager} instance
1895 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1896 * restrictions on the parent profile.
Jim Millera4e28d12010-11-08 16:15:47 -08001897 *
Robin Lee25e26452015-06-02 09:56:29 -07001898 * @param admin The name of the admin component to check, or {@code null} to aggregate all admins.
Jim Millera4e28d12010-11-08 16:15:47 -08001899 * @return The timeout for the given admin or the minimum of all timeouts
1900 */
Robin Lee25e26452015-06-02 09:56:29 -07001901 public long getPasswordExpirationTimeout(@Nullable ComponentName admin) {
Jim Millera4e28d12010-11-08 16:15:47 -08001902 if (mService != null) {
1903 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001904 return mService.getPasswordExpirationTimeout(admin, myUserId(), mParentInstance);
Jim Millera4e28d12010-11-08 16:15:47 -08001905 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001906 throw e.rethrowFromSystemServer();
Jim Millera4e28d12010-11-08 16:15:47 -08001907 }
1908 }
1909 return 0;
1910 }
1911
1912 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001913 * Get the current password expiration time for a particular admin or all admins that set
1914 * retrictions on this user and its participating profiles. Restrictions on profiles that have
1915 * a separate challenge are not taken into account. If admin is {@code null}, then a composite
1916 * of all expiration times is returned - which will be the minimum of all of them.
1917 *
1918 * <p>This method can be called on the {@link DevicePolicyManager} instance
1919 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1920 * the password expiration for the parent profile.
Jim Millera4e28d12010-11-08 16:15:47 -08001921 *
Robin Lee25e26452015-06-02 09:56:29 -07001922 * @param admin The name of the admin component to check, or {@code null} to aggregate all admins.
Esteban Talaverac1c83592016-02-17 17:56:15 +00001923 * @return The password expiration time, in milliseconds since epoch.
Jim Millera4e28d12010-11-08 16:15:47 -08001924 */
Robin Lee25e26452015-06-02 09:56:29 -07001925 public long getPasswordExpiration(@Nullable ComponentName admin) {
Jim Millera4e28d12010-11-08 16:15:47 -08001926 if (mService != null) {
1927 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001928 return mService.getPasswordExpiration(admin, myUserId(), mParentInstance);
Jim Millera4e28d12010-11-08 16:15:47 -08001929 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001930 throw e.rethrowFromSystemServer();
Jim Millera4e28d12010-11-08 16:15:47 -08001931 }
1932 }
1933 return 0;
1934 }
1935
1936 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001937 * Retrieve the current password history length for a particular admin or all admins that
1938 * set retrictions on this user and its participating profiles. Restrictions on profiles that
1939 * have a separate challenge are not taken into account.
1940 *
1941 * <p>This method can be called on the {@link DevicePolicyManager} instance
1942 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1943 * restrictions on the parent profile.
1944 *
Robin Lee25e26452015-06-02 09:56:29 -07001945 * @param admin The name of the admin component to check, or {@code null} to aggregate
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001946 * all admins.
1947 * @return The length of the password history
1948 */
Robin Lee25e26452015-06-02 09:56:29 -07001949 public int getPasswordHistoryLength(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001950 return getPasswordHistoryLength(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001951 }
1952
1953 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001954 public int getPasswordHistoryLength(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001955 if (mService != null) {
1956 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001957 return mService.getPasswordHistoryLength(admin, userHandle, mParentInstance);
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001958 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001959 throw e.rethrowFromSystemServer();
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001960 }
1961 }
1962 return 0;
1963 }
1964
Dianne Hackbornd6847842010-01-12 18:14:19 -08001965 /**
Dianne Hackborn254cb442010-01-27 19:23:59 -08001966 * Return the maximum password length that the device supports for a
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001967 * particular password quality.
Dianne Hackborn364f6e32010-01-29 17:38:20 -08001968 * @param quality The quality being interrogated.
Dianne Hackborn254cb442010-01-27 19:23:59 -08001969 * @return Returns the maximum length that the user can enter.
1970 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001971 public int getPasswordMaximumLength(int quality) {
Dianne Hackborn254cb442010-01-27 19:23:59 -08001972 // Kind-of arbitrary.
1973 return 16;
1974 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001975
Dianne Hackborn254cb442010-01-27 19:23:59 -08001976 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001977 * Determine whether the current password the user has set is sufficient to meet the policy
1978 * requirements (e.g. quality, minimum length) that have been requested by the admins of this
1979 * user and its participating profiles. Restrictions on profiles that have a separate challenge
1980 * are not taken into account.
1981 * <p>
1982 * The calling device admin must have requested
1983 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1984 * not, a security exception will be thrown.
1985 * <p>
1986 * This method can be called on the {@link DevicePolicyManager} instance returned by
1987 * {@link #getParentProfileInstance(ComponentName)} in order to determine if the password set on
1988 * the parent profile is sufficient.
Esteban Talaverac1c83592016-02-17 17:56:15 +00001989 *
Jessica Hummel91da58d2014-04-10 17:39:43 +01001990 * @return Returns true if the password meets the current requirements, else false.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001991 * @throws SecurityException if the calling application does not own an active administrator
1992 * that uses {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Dianne Hackbornd6847842010-01-12 18:14:19 -08001993 */
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001994 public boolean isActivePasswordSufficient() {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001995 if (mService != null) {
1996 try {
Clara Bayarri3e826ef2015-12-14 17:51:22 +00001997 return mService.isActivePasswordSufficient(myUserId(), mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001998 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001999 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08002000 }
2001 }
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002002 return false;
Dianne Hackbornd6847842010-01-12 18:14:19 -08002003 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002004
Dianne Hackbornd6847842010-01-12 18:14:19 -08002005 /**
Clara Bayarrid7693912016-01-22 17:26:31 +00002006 * Determine whether the current profile password the user has set is sufficient
Esteban Talaverac1c83592016-02-17 17:56:15 +00002007 * to meet the policy requirements (e.g. quality, minimum length) that have been
Clara Bayarrid7693912016-01-22 17:26:31 +00002008 * requested by the admins of the parent user and its profiles.
2009 *
2010 * @param userHandle the userId of the profile to check the password for.
2011 * @return Returns true if the password would meet the current requirements, else false.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002012 * @throws SecurityException if {@code userHandle} is not a managed profile.
Clara Bayarrid7693912016-01-22 17:26:31 +00002013 * @hide
2014 */
2015 public boolean isProfileActivePasswordSufficientForParent(int userHandle) {
2016 if (mService != null) {
2017 try {
2018 return mService.isProfileActivePasswordSufficientForParent(userHandle);
2019 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002020 throw e.rethrowFromSystemServer();
Clara Bayarrid7693912016-01-22 17:26:31 +00002021 }
2022 }
2023 return false;
2024 }
2025
2026 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002027 * Retrieve the number of times the user has failed at entering a password since that last
2028 * successful password entry.
2029 * <p>
2030 * This method can be called on the {@link DevicePolicyManager} instance returned by
2031 * {@link #getParentProfileInstance(ComponentName)} in order to retrieve the number of failed
2032 * password attemts for the parent user.
2033 * <p>
2034 * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN}
2035 * to be able to call this method; if it has not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002036 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002037 * @return The number of times user has entered an incorrect password since the last correct
2038 * password entry.
2039 * @throws SecurityException if the calling application does not own an active administrator
2040 * that uses {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN}
Dianne Hackbornd6847842010-01-12 18:14:19 -08002041 */
2042 public int getCurrentFailedPasswordAttempts() {
Clara Bayarri51e41ad2016-02-11 17:48:53 +00002043 return getCurrentFailedPasswordAttempts(myUserId());
2044 }
2045
2046 /**
2047 * Retrieve the number of times the given user has failed at entering a
2048 * password since that last successful password entry.
2049 *
2050 * <p>The calling device admin must have requested
2051 * {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} to be able to call this method; if it has
2052 * not and it is not the system uid, a security exception will be thrown.
2053 *
2054 * @hide
2055 */
2056 public int getCurrentFailedPasswordAttempts(int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08002057 if (mService != null) {
2058 try {
Clara Bayarri51e41ad2016-02-11 17:48:53 +00002059 return mService.getCurrentFailedPasswordAttempts(userHandle, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002060 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002061 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08002062 }
2063 }
2064 return -1;
2065 }
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002066
2067 /**
Craig Lafayette4e401fa2015-05-07 10:24:02 -04002068 * Queries whether {@link #RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT} flag is set.
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002069 *
Craig Lafayette4e401fa2015-05-07 10:24:02 -04002070 * @return true if RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT flag is set.
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002071 * @hide
2072 */
2073 public boolean getDoNotAskCredentialsOnBoot() {
2074 if (mService != null) {
2075 try {
2076 return mService.getDoNotAskCredentialsOnBoot();
2077 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002078 throw e.rethrowFromSystemServer();
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002079 }
2080 }
2081 return false;
2082 }
2083
2084 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002085 * Setting this to a value greater than zero enables a built-in policy that will perform a
2086 * device or profile wipe after too many incorrect device-unlock passwords have been entered.
2087 * This built-in policy combines watching for failed passwords and wiping the device, and
2088 * requires that you request both {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} and
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002089 * {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA}}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002090 * <p>
2091 * To implement any other policy (e.g. wiping data for a particular application only, erasing or
2092 * revoking credentials, or reporting the failure to a server), you should implement
2093 * {@link DeviceAdminReceiver#onPasswordFailed(Context, android.content.Intent)} instead. Do not
2094 * use this API, because if the maximum count is reached, the device or profile will be wiped
2095 * immediately, and your callback will not be invoked.
2096 * <p>
2097 * This method can be called on the {@link DevicePolicyManager} instance returned by
2098 * {@link #getParentProfileInstance(ComponentName)} in order to set a value on the parent
2099 * profile.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002100 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08002101 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002102 * @param num The number of failed password attempts at which point the device or profile will
2103 * be wiped.
2104 * @throws SecurityException if {@code admin} is not an active administrator or does not use
2105 * both {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} and
2106 * {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA}.
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002107 */
Robin Lee25e26452015-06-02 09:56:29 -07002108 public void setMaximumFailedPasswordsForWipe(@NonNull ComponentName admin, int num) {
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002109 if (mService != null) {
2110 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002111 mService.setMaximumFailedPasswordsForWipe(admin, num, mParentInstance);
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002112 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002113 throw e.rethrowFromSystemServer();
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002114 }
2115 }
2116 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002117
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002118 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00002119 * Retrieve the current maximum number of login attempts that are allowed before the device
2120 * or profile is wiped, for a particular admin or all admins that set retrictions on this user
2121 * and its participating profiles. Restrictions on profiles that have a separate challenge are
2122 * not taken into account.
2123 *
2124 * <p>This method can be called on the {@link DevicePolicyManager} instance
2125 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
2126 * the value for the parent profile.
2127 *
Robin Lee25e26452015-06-02 09:56:29 -07002128 * @param admin The name of the admin component to check, or {@code null} to aggregate
Dianne Hackborn254cb442010-01-27 19:23:59 -08002129 * all admins.
2130 */
Robin Lee25e26452015-06-02 09:56:29 -07002131 public int getMaximumFailedPasswordsForWipe(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002132 return getMaximumFailedPasswordsForWipe(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002133 }
2134
2135 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07002136 public int getMaximumFailedPasswordsForWipe(@Nullable ComponentName admin, int userHandle) {
Dianne Hackborn254cb442010-01-27 19:23:59 -08002137 if (mService != null) {
2138 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002139 return mService.getMaximumFailedPasswordsForWipe(
2140 admin, userHandle, mParentInstance);
Dianne Hackborn254cb442010-01-27 19:23:59 -08002141 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002142 throw e.rethrowFromSystemServer();
Dianne Hackborn254cb442010-01-27 19:23:59 -08002143 }
2144 }
2145 return 0;
2146 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002147
Dianne Hackborn254cb442010-01-27 19:23:59 -08002148 /**
Amith Yamasani3a3d2122014-10-29 11:41:31 -07002149 * Returns the profile with the smallest maximum failed passwords for wipe,
2150 * for the given user. So for primary user, it might return the primary or
2151 * a managed profile. For a secondary user, it would be the same as the
2152 * user passed in.
2153 * @hide Used only by Keyguard
2154 */
2155 public int getProfileWithMinimumFailedPasswordsForWipe(int userHandle) {
2156 if (mService != null) {
2157 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002158 return mService.getProfileWithMinimumFailedPasswordsForWipe(
2159 userHandle, mParentInstance);
Amith Yamasani3a3d2122014-10-29 11:41:31 -07002160 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002161 throw e.rethrowFromSystemServer();
Amith Yamasani3a3d2122014-10-29 11:41:31 -07002162 }
2163 }
2164 return UserHandle.USER_NULL;
2165 }
2166
2167 /**
Dianne Hackborn87bba1e2010-02-26 17:25:54 -08002168 * Flag for {@link #resetPassword}: don't allow other admins to change
2169 * the password again until the user has entered it.
2170 */
2171 public static final int RESET_PASSWORD_REQUIRE_ENTRY = 0x0001;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002172
Dianne Hackborn87bba1e2010-02-26 17:25:54 -08002173 /**
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002174 * Flag for {@link #resetPassword}: don't ask for user credentials on device boot.
2175 * If the flag is set, the device can be booted without asking for user password.
2176 * The absence of this flag does not change the current boot requirements. This flag
2177 * can be set by the device owner only. If the app is not the device owner, the flag
2178 * is ignored. Once the flag is set, it cannot be reverted back without resetting the
2179 * device to factory defaults.
2180 */
Craig Lafayette4e401fa2015-05-07 10:24:02 -04002181 public static final int RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT = 0x0002;
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002182
2183 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002184 * Force a new device unlock password (the password needed to access the entire device, not for
2185 * individual accounts) on the user. This takes effect immediately.
2186 * <p>
2187 * Calling this from a managed profile that shares the password with the owner profile will
2188 * throw a security exception.
2189 * <p>
2190 * <em>Note: This API has been limited as of {@link android.os.Build.VERSION_CODES#N} for
Makoto Onuki70f929e2015-11-11 12:40:15 -08002191 * device admins that are not device owner and not profile owner.
2192 * The password can now only be changed if there is currently no password set. Device owner
2193 * and profile owner can still do this.</em>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002194 * <p>
2195 * The given password must be sufficient for the current password quality and length constraints
2196 * as returned by {@link #getPasswordQuality(ComponentName)} and
2197 * {@link #getPasswordMinimumLength(ComponentName)}; if it does not meet these constraints, then
2198 * it will be rejected and false returned. Note that the password may be a stronger quality
2199 * (containing alphanumeric characters when the requested quality is only numeric), in which
2200 * case the currently active quality will be increased to match.
2201 * <p>
2202 * Calling with a null or empty password will clear any existing PIN, pattern or password if the
2203 * current password constraints allow it. <em>Note: This will not
Makoto Onuki70f929e2015-11-11 12:40:15 -08002204 * work in {@link android.os.Build.VERSION_CODES#N} and later for device admins that are not
2205 * device owner and not profile owner. Once set, the password cannot be changed to null or
2206 * empty, except by device owner or profile owner.</em>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002207 * <p>
2208 * The calling device admin must have requested
2209 * {@link DeviceAdminInfo#USES_POLICY_RESET_PASSWORD} to be able to call this method; if it has
2210 * not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002211 *
Adrian Roosf8f56bc2014-11-20 23:55:34 +01002212 * @param password The new password for the user. Null or empty clears the password.
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002213 * @param flags May be 0 or combination of {@link #RESET_PASSWORD_REQUIRE_ENTRY} and
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002214 * {@link #RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT}.
2215 * @return Returns true if the password was applied, or false if it is not acceptable for the
2216 * current constraints or if the user has not been decrypted yet.
2217 * @throws SecurityException if the calling application does not own an active administrator
2218 * that uses {@link DeviceAdminInfo#USES_POLICY_RESET_PASSWORD}
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002219 */
Dianne Hackborn87bba1e2010-02-26 17:25:54 -08002220 public boolean resetPassword(String password, int flags) {
Clara Bayarri3e826ef2015-12-14 17:51:22 +00002221 if (mParentInstance) {
2222 throw new SecurityException("Reset password does not work across profiles.");
2223 }
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002224 if (mService != null) {
2225 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08002226 return mService.resetPassword(password, flags);
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002227 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002228 throw e.rethrowFromSystemServer();
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002229 }
2230 }
2231 return false;
2232 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002233
Dianne Hackbornd6847842010-01-12 18:14:19 -08002234 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002235 * Called by an application that is administering the device to set the maximum time for user
2236 * activity until the device will lock. This limits the length that the user can set. It takes
2237 * effect immediately.
2238 * <p>
2239 * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
2240 * to be able to call this method; if it has not, a security exception will be thrown.
2241 * <p>
2242 * This method can be called on the {@link DevicePolicyManager} instance returned by
2243 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
2244 * profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00002245 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08002246 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002247 * @param timeMs The new desired maximum time to lock in milliseconds. A value of 0 means there
2248 * is no restriction.
2249 * @throws SecurityException if {@code admin} is not an active administrator or it does not use
2250 * {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
Dianne Hackbornd6847842010-01-12 18:14:19 -08002251 */
Robin Lee25e26452015-06-02 09:56:29 -07002252 public void setMaximumTimeToLock(@NonNull ComponentName admin, long timeMs) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08002253 if (mService != null) {
2254 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002255 mService.setMaximumTimeToLock(admin, timeMs, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002256 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002257 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08002258 }
2259 }
2260 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002261
Dianne Hackbornd6847842010-01-12 18:14:19 -08002262 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00002263 * Retrieve the current maximum time to unlock for a particular admin or all admins that set
2264 * retrictions on this user and its participating profiles. Restrictions on profiles that have
2265 * a separate challenge are not taken into account.
2266 *
2267 * <p>This method can be called on the {@link DevicePolicyManager} instance
2268 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
2269 * restrictions on the parent profile.
2270 *
Robin Lee25e26452015-06-02 09:56:29 -07002271 * @param admin The name of the admin component to check, or {@code null} to aggregate
Dianne Hackborn254cb442010-01-27 19:23:59 -08002272 * all admins.
Jim Millerd4efaac2014-08-14 18:02:45 -07002273 * @return time in milliseconds for the given admin or the minimum value (strictest) of
Jim Miller76b9b8b2014-08-22 17:04:57 -07002274 * all admins if admin is null. Returns 0 if there are no restrictions.
Dianne Hackbornd6847842010-01-12 18:14:19 -08002275 */
Robin Lee25e26452015-06-02 09:56:29 -07002276 public long getMaximumTimeToLock(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002277 return getMaximumTimeToLock(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002278 }
2279
2280 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07002281 public long getMaximumTimeToLock(@Nullable ComponentName admin, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08002282 if (mService != null) {
2283 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002284 return mService.getMaximumTimeToLock(admin, userHandle, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002285 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002286 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08002287 }
2288 }
2289 return 0;
2290 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002291
Dianne Hackbornd6847842010-01-12 18:14:19 -08002292 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002293 * Make the device lock immediately, as if the lock screen timeout has expired at the point of
2294 * this call.
2295 * <p>
2296 * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
2297 * to be able to call this method; if it has not, a security exception will be thrown.
2298 * <p>
2299 * This method can be called on the {@link DevicePolicyManager} instance returned by
2300 * {@link #getParentProfileInstance(ComponentName)} in order to lock the parent profile.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002301 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002302 * @throws SecurityException if the calling application does not own an active administrator
2303 * that uses {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
Dianne Hackbornd6847842010-01-12 18:14:19 -08002304 */
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002305 public void lockNow() {
2306 if (mService != null) {
2307 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002308 mService.lockNow(mParentInstance);
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002309 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002310 throw e.rethrowFromSystemServer();
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002311 }
2312 }
2313 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002314
Dianne Hackbornd6847842010-01-12 18:14:19 -08002315 /**
Dianne Hackborn42499172010-10-15 18:45:07 -07002316 * Flag for {@link #wipeData(int)}: also erase the device's external
Paul Crowleya7e87ac2014-11-18 13:50:19 +00002317 * storage (such as SD cards).
Dianne Hackborn42499172010-10-15 18:45:07 -07002318 */
2319 public static final int WIPE_EXTERNAL_STORAGE = 0x0001;
2320
2321 /**
Paul Crowleya7e87ac2014-11-18 13:50:19 +00002322 * Flag for {@link #wipeData(int)}: also erase the factory reset protection
2323 * data.
2324 *
Paul Crowley2934b262014-12-02 11:21:13 +00002325 * <p>This flag may only be set by device owner admins; if it is set by
2326 * other admins a {@link SecurityException} will be thrown.
Paul Crowleya7e87ac2014-11-18 13:50:19 +00002327 */
2328 public static final int WIPE_RESET_PROTECTION_DATA = 0x0002;
2329
2330 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002331 * Ask the user data be wiped. Wiping the primary user will cause the device to reboot, erasing
2332 * all user data while next booting up.
2333 * <p>
2334 * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA} to
2335 * be able to call this method; if it has not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002336 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002337 * @param flags Bit mask of additional options: currently supported flags are
2338 * {@link #WIPE_EXTERNAL_STORAGE} and {@link #WIPE_RESET_PROTECTION_DATA}.
2339 * @throws SecurityException if the calling application does not own an active administrator
2340 * that uses {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA}
Dianne Hackbornd6847842010-01-12 18:14:19 -08002341 */
2342 public void wipeData(int flags) {
2343 if (mService != null) {
2344 try {
Makoto Onuki70f929e2015-11-11 12:40:15 -08002345 mService.wipeData(flags);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002346 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002347 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08002348 }
2349 }
2350 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002351
Dianne Hackbornd6847842010-01-12 18:14:19 -08002352 /**
Oscar Montemayor69238c62010-08-03 10:51:06 -07002353 * Called by an application that is administering the device to set the
2354 * global proxy and exclusion list.
2355 * <p>
2356 * The calling device admin must have requested
2357 * {@link DeviceAdminInfo#USES_POLICY_SETS_GLOBAL_PROXY} to be able to call
2358 * this method; if it has not, a security exception will be thrown.
2359 * Only the first device admin can set the proxy. If a second admin attempts
2360 * to set the proxy, the {@link ComponentName} of the admin originally setting the
Robin Lee25e26452015-06-02 09:56:29 -07002361 * proxy will be returned. If successful in setting the proxy, {@code null} will
Oscar Montemayor69238c62010-08-03 10:51:06 -07002362 * be returned.
2363 * The method can be called repeatedly by the device admin alrady setting the
2364 * proxy to update the proxy and exclusion list.
2365 *
Robin Lee25e26452015-06-02 09:56:29 -07002366 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Oscar Montemayor69238c62010-08-03 10:51:06 -07002367 * @param proxySpec the global proxy desired. Must be an HTTP Proxy.
2368 * Pass Proxy.NO_PROXY to reset the proxy.
2369 * @param exclusionList a list of domains to be excluded from the global proxy.
Robin Lee25e26452015-06-02 09:56:29 -07002370 * @return {@code null} if the proxy was successfully set, or otherwise a {@link ComponentName}
2371 * of the device admin that sets the proxy.
Andy Stadlerd2672722011-02-16 10:53:33 -08002372 * @hide
Oscar Montemayor69238c62010-08-03 10:51:06 -07002373 */
Robin Lee25e26452015-06-02 09:56:29 -07002374 public ComponentName setGlobalProxy(@NonNull ComponentName admin, Proxy proxySpec,
Oscar Montemayor69238c62010-08-03 10:51:06 -07002375 List<String> exclusionList ) {
2376 if (proxySpec == null) {
2377 throw new NullPointerException();
2378 }
2379 if (mService != null) {
2380 try {
2381 String hostSpec;
2382 String exclSpec;
2383 if (proxySpec.equals(Proxy.NO_PROXY)) {
2384 hostSpec = null;
2385 exclSpec = null;
2386 } else {
2387 if (!proxySpec.type().equals(Proxy.Type.HTTP)) {
2388 throw new IllegalArgumentException();
2389 }
2390 InetSocketAddress sa = (InetSocketAddress)proxySpec.address();
2391 String hostName = sa.getHostName();
2392 int port = sa.getPort();
2393 StringBuilder hostBuilder = new StringBuilder();
2394 hostSpec = hostBuilder.append(hostName)
2395 .append(":").append(Integer.toString(port)).toString();
2396 if (exclusionList == null) {
2397 exclSpec = "";
2398 } else {
2399 StringBuilder listBuilder = new StringBuilder();
2400 boolean firstDomain = true;
2401 for (String exclDomain : exclusionList) {
2402 if (!firstDomain) {
2403 listBuilder = listBuilder.append(",");
2404 } else {
2405 firstDomain = false;
2406 }
2407 listBuilder = listBuilder.append(exclDomain.trim());
2408 }
2409 exclSpec = listBuilder.toString();
2410 }
Yuhao Zheng90704842014-02-28 17:22:45 -08002411 if (android.net.Proxy.validate(hostName, Integer.toString(port), exclSpec)
2412 != android.net.Proxy.PROXY_VALID)
2413 throw new IllegalArgumentException();
Oscar Montemayor69238c62010-08-03 10:51:06 -07002414 }
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08002415 return mService.setGlobalProxy(admin, hostSpec, exclSpec);
Oscar Montemayor69238c62010-08-03 10:51:06 -07002416 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002417 throw e.rethrowFromSystemServer();
Oscar Montemayor69238c62010-08-03 10:51:06 -07002418 }
2419 }
2420 return null;
2421 }
2422
2423 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002424 * Set a network-independent global HTTP proxy. This is not normally what you want for typical
2425 * HTTP proxies - they are generally network dependent. However if you're doing something
2426 * unusual like general internal filtering this may be useful. On a private network where the
2427 * proxy is not accessible, you may break HTTP using this.
2428 * <p>
2429 * This method requires the caller to be the device owner.
2430 * <p>
2431 * This proxy is only a recommendation and it is possible that some apps will ignore it.
Jason Monk03bc9912014-05-13 09:44:57 -04002432 *
Jason Monk03bc9912014-05-13 09:44:57 -04002433 * @see ProxyInfo
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002434 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2435 * @param proxyInfo The a {@link ProxyInfo} object defining the new global HTTP proxy. A
2436 * {@code null} value will clear the global HTTP proxy.
2437 * @throws SecurityException if {@code admin} is not the device owner.
Jason Monk03bc9912014-05-13 09:44:57 -04002438 */
Robin Lee25e26452015-06-02 09:56:29 -07002439 public void setRecommendedGlobalProxy(@NonNull ComponentName admin, @Nullable ProxyInfo
2440 proxyInfo) {
Jason Monk03bc9912014-05-13 09:44:57 -04002441 if (mService != null) {
2442 try {
2443 mService.setRecommendedGlobalProxy(admin, proxyInfo);
2444 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002445 throw e.rethrowFromSystemServer();
Jason Monk03bc9912014-05-13 09:44:57 -04002446 }
2447 }
2448 }
2449
2450 /**
Oscar Montemayor69238c62010-08-03 10:51:06 -07002451 * Returns the component name setting the global proxy.
Robin Lee25e26452015-06-02 09:56:29 -07002452 * @return ComponentName object of the device admin that set the global proxy, or {@code null}
2453 * if no admin has set the proxy.
Andy Stadlerd2672722011-02-16 10:53:33 -08002454 * @hide
Oscar Montemayor69238c62010-08-03 10:51:06 -07002455 */
2456 public ComponentName getGlobalProxyAdmin() {
2457 if (mService != null) {
2458 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002459 return mService.getGlobalProxyAdmin(myUserId());
Oscar Montemayor69238c62010-08-03 10:51:06 -07002460 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002461 throw e.rethrowFromSystemServer();
Oscar Montemayor69238c62010-08-03 10:51:06 -07002462 }
2463 }
2464 return null;
2465 }
2466
2467 /**
Andy Stadler22dbfda2011-01-17 12:47:31 -08002468 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002469 * indicating that encryption is not supported.
2470 */
2471 public static final int ENCRYPTION_STATUS_UNSUPPORTED = 0;
2472
2473 /**
Andy Stadler22dbfda2011-01-17 12:47:31 -08002474 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002475 * indicating that encryption is supported, but is not currently active.
2476 */
2477 public static final int ENCRYPTION_STATUS_INACTIVE = 1;
2478
2479 /**
Robin Lee3795fb02015-02-16 14:17:23 +00002480 * Result code for {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002481 * indicating that encryption is not currently active, but is currently
2482 * being activated. This is only reported by devices that support
2483 * encryption of data and only when the storage is currently
2484 * undergoing a process of becoming encrypted. A device that must reboot and/or wipe data
2485 * to become encrypted will never return this value.
2486 */
Andy Stadler22dbfda2011-01-17 12:47:31 -08002487 public static final int ENCRYPTION_STATUS_ACTIVATING = 2;
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002488
2489 /**
Andy Stadler22dbfda2011-01-17 12:47:31 -08002490 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002491 * indicating that encryption is active.
2492 */
Andy Stadler22dbfda2011-01-17 12:47:31 -08002493 public static final int ENCRYPTION_STATUS_ACTIVE = 3;
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002494
2495 /**
Robin Lee3795fb02015-02-16 14:17:23 +00002496 * Result code for {@link #getStorageEncryptionStatus}:
2497 * indicating that encryption is active, but an encryption key has not
2498 * been set by the user.
2499 */
2500 public static final int ENCRYPTION_STATUS_ACTIVE_DEFAULT_KEY = 4;
2501
2502 /**
Makoto Onukid4c9e542016-02-25 18:17:30 -08002503 * Result code for {@link #getStorageEncryptionStatus}:
2504 * indicating that encryption is active and the encryption key is tied to the user.
2505 */
2506 public static final int ENCRYPTION_STATUS_ACTIVE_PER_USER = 5;
2507
2508 /**
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002509 * Activity action: begin the process of encrypting data on the device. This activity should
2510 * be launched after using {@link #setStorageEncryption} to request encryption be activated.
2511 * After resuming from this activity, use {@link #getStorageEncryption}
2512 * to check encryption status. However, on some devices this activity may never return, as
2513 * it may trigger a reboot and in some cases a complete data wipe of the device.
2514 */
2515 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2516 public static final String ACTION_START_ENCRYPTION
2517 = "android.app.action.START_ENCRYPTION";
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002518 /**
Jim Millerb8ec4702012-08-31 17:19:10 -07002519 * Widgets are enabled in keyguard
2520 */
Jim Miller48b9b0d2012-09-19 23:16:50 -07002521 public static final int KEYGUARD_DISABLE_FEATURES_NONE = 0;
Jim Millerb8ec4702012-08-31 17:19:10 -07002522
2523 /**
Jim Miller50e62182014-04-23 17:25:00 -07002524 * Disable all keyguard widgets. Has no effect.
Jim Millerb8ec4702012-08-31 17:19:10 -07002525 */
Jim Miller48b9b0d2012-09-19 23:16:50 -07002526 public static final int KEYGUARD_DISABLE_WIDGETS_ALL = 1 << 0;
2527
2528 /**
2529 * Disable the camera on secure keyguard screens (e.g. PIN/Pattern/Password)
2530 */
2531 public static final int KEYGUARD_DISABLE_SECURE_CAMERA = 1 << 1;
2532
2533 /**
Jim Miller50e62182014-04-23 17:25:00 -07002534 * Disable showing all notifications on secure keyguard screens (e.g. PIN/Pattern/Password)
2535 */
2536 public static final int KEYGUARD_DISABLE_SECURE_NOTIFICATIONS = 1 << 2;
2537
2538 /**
2539 * Only allow redacted notifications on secure keyguard screens (e.g. PIN/Pattern/Password)
2540 */
2541 public static final int KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS = 1 << 3;
2542
2543 /**
Adrian Roosa06d5ca2014-07-28 15:14:21 +02002544 * Ignore trust agent state on secure keyguard screens
Jim Miller50e62182014-04-23 17:25:00 -07002545 * (e.g. PIN/Pattern/Password).
2546 */
2547 public static final int KEYGUARD_DISABLE_TRUST_AGENTS = 1 << 4;
2548
2549 /**
Jim Miller06e34502014-07-17 14:46:05 -07002550 * Disable fingerprint sensor on keyguard secure screens (e.g. PIN/Pattern/Password).
2551 */
2552 public static final int KEYGUARD_DISABLE_FINGERPRINT = 1 << 5;
2553
2554 /**
Jim Miller35207742012-11-02 15:33:20 -07002555 * Disable all current and future keyguard customizations.
Jim Miller48b9b0d2012-09-19 23:16:50 -07002556 */
2557 public static final int KEYGUARD_DISABLE_FEATURES_ALL = 0x7fffffff;
Jim Millerb8ec4702012-08-31 17:19:10 -07002558
2559 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002560 * Called by an application that is administering the device to request that the storage system
2561 * be encrypted.
2562 * <p>
2563 * When multiple device administrators attempt to control device encryption, the most secure,
2564 * supported setting will always be used. If any device administrator requests device
2565 * encryption, it will be enabled; Conversely, if a device administrator attempts to disable
2566 * device encryption while another device administrator has enabled it, the call to disable will
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002567 * fail (most commonly returning {@link #ENCRYPTION_STATUS_ACTIVE}).
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002568 * <p>
2569 * This policy controls encryption of the secure (application data) storage area. Data written
2570 * to other storage areas may or may not be encrypted, and this policy does not require or
2571 * control the encryption of any other storage areas. There is one exception: If
2572 * {@link android.os.Environment#isExternalStorageEmulated()} is {@code true}, then the
2573 * directory returned by {@link android.os.Environment#getExternalStorageDirectory()} must be
2574 * written to disk within the encrypted storage area.
2575 * <p>
2576 * Important Note: On some devices, it is possible to encrypt storage without requiring the user
2577 * to create a device PIN or Password. In this case, the storage is encrypted, but the
2578 * encryption key may not be fully secured. For maximum security, the administrator should also
2579 * require (and check for) a pattern, PIN, or password.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002580 *
2581 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2582 * @param encrypt true to request encryption, false to release any previous request
Andy Stadler22dbfda2011-01-17 12:47:31 -08002583 * @return the new request status (for all active admins) - will be one of
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002584 * {@link #ENCRYPTION_STATUS_UNSUPPORTED}, {@link #ENCRYPTION_STATUS_INACTIVE}, or
2585 * {@link #ENCRYPTION_STATUS_ACTIVE}. This is the value of the requests; Use
2586 * {@link #getStorageEncryptionStatus()} to query the actual device state.
2587 * @throws SecurityException if {@code admin} is not an active administrator or does not use
2588 * {@link DeviceAdminInfo#USES_ENCRYPTED_STORAGE}
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002589 */
Robin Lee25e26452015-06-02 09:56:29 -07002590 public int setStorageEncryption(@NonNull ComponentName admin, boolean encrypt) {
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002591 if (mService != null) {
2592 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08002593 return mService.setStorageEncryption(admin, encrypt);
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002594 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002595 throw e.rethrowFromSystemServer();
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002596 }
2597 }
2598 return ENCRYPTION_STATUS_UNSUPPORTED;
2599 }
2600
2601 /**
2602 * Called by an application that is administering the device to
Andy Stadler22dbfda2011-01-17 12:47:31 -08002603 * determine the requested setting for secure storage.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002604 *
Andy Stadler22dbfda2011-01-17 12:47:31 -08002605 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. If null,
2606 * this will return the requested encryption setting as an aggregate of all active
2607 * administrators.
2608 * @return true if the admin(s) are requesting encryption, false if not.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002609 */
Robin Lee25e26452015-06-02 09:56:29 -07002610 public boolean getStorageEncryption(@Nullable ComponentName admin) {
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002611 if (mService != null) {
2612 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002613 return mService.getStorageEncryption(admin, myUserId());
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002614 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002615 throw e.rethrowFromSystemServer();
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002616 }
2617 }
Andy Stadler22dbfda2011-01-17 12:47:31 -08002618 return false;
2619 }
2620
2621 /**
2622 * Called by an application that is administering the device to
2623 * determine the current encryption status of the device.
2624 *
2625 * Depending on the returned status code, the caller may proceed in different
2626 * ways. If the result is {@link #ENCRYPTION_STATUS_UNSUPPORTED}, the
2627 * storage system does not support encryption. If the
2628 * result is {@link #ENCRYPTION_STATUS_INACTIVE}, use {@link
2629 * #ACTION_START_ENCRYPTION} to begin the process of encrypting or decrypting the
Robin Lee3795fb02015-02-16 14:17:23 +00002630 * storage. If the result is {@link #ENCRYPTION_STATUS_ACTIVE_DEFAULT_KEY}, the
2631 * storage system has enabled encryption but no password is set so further action
2632 * may be required. If the result is {@link #ENCRYPTION_STATUS_ACTIVATING} or
Andy Stadler22dbfda2011-01-17 12:47:31 -08002633 * {@link #ENCRYPTION_STATUS_ACTIVE}, no further action is required.
2634 *
Robin Lee7e678712014-07-24 16:41:31 +01002635 * @return current status of encryption. The value will be one of
Andy Stadler22dbfda2011-01-17 12:47:31 -08002636 * {@link #ENCRYPTION_STATUS_UNSUPPORTED}, {@link #ENCRYPTION_STATUS_INACTIVE},
Robin Lee3795fb02015-02-16 14:17:23 +00002637 * {@link #ENCRYPTION_STATUS_ACTIVATING}, {@link #ENCRYPTION_STATUS_ACTIVE_DEFAULT_KEY},
2638 * or {@link #ENCRYPTION_STATUS_ACTIVE}.
Andy Stadler22dbfda2011-01-17 12:47:31 -08002639 */
2640 public int getStorageEncryptionStatus() {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002641 return getStorageEncryptionStatus(myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002642 }
2643
2644 /** @hide per-user version */
2645 public int getStorageEncryptionStatus(int userHandle) {
Andy Stadler22dbfda2011-01-17 12:47:31 -08002646 if (mService != null) {
2647 try {
Makoto Onukid4c9e542016-02-25 18:17:30 -08002648 return mService.getStorageEncryptionStatus(mContext.getPackageName(), userHandle);
Andy Stadler22dbfda2011-01-17 12:47:31 -08002649 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002650 throw e.rethrowFromSystemServer();
Andy Stadler22dbfda2011-01-17 12:47:31 -08002651 }
2652 }
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002653 return ENCRYPTION_STATUS_UNSUPPORTED;
2654 }
2655
2656 /**
Robin Lee2f7e1e42016-03-21 10:50:01 +00002657 * Mark a CA certificate as approved by the device user. This means that they have been notified
2658 * of the installation, were made aware of the risks, viewed the certificate and still wanted to
2659 * keep the certificate on the device.
2660 *
2661 * Calling with {@param approval} as {@code true} will cancel any ongoing warnings related to
2662 * this certificate.
2663 *
2664 * @hide
2665 */
2666 public boolean approveCaCert(String alias, int userHandle, boolean approval) {
2667 if (mService != null) {
2668 try {
2669 return mService.approveCaCert(alias, userHandle, approval);
2670 } catch (RemoteException e) {
2671 throw e.rethrowFromSystemServer();
2672 }
2673 }
2674 return false;
2675 }
2676
2677 /**
2678 * Check whether a CA certificate has been approved by the device user.
2679 *
2680 * @hide
2681 */
2682 public boolean isCaCertApproved(String alias, int userHandle) {
2683 if (mService != null) {
2684 try {
2685 return mService.isCaCertApproved(alias, userHandle);
2686 } catch (RemoteException e) {
2687 throw e.rethrowFromSystemServer();
2688 }
2689 }
2690 return false;
2691 }
2692
2693 /**
Robin Lee7e678712014-07-24 16:41:31 +01002694 * Installs the given certificate as a user CA.
2695 *
Robin Lee25e26452015-06-02 09:56:29 -07002696 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2697 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01002698 * @param certBuffer encoded form of the certificate to install.
Maggie Benthallda51e682013-08-08 22:35:44 -04002699 *
2700 * @return false if the certBuffer cannot be parsed or installation is
Robin Lee7e678712014-07-24 16:41:31 +01002701 * interrupted, true otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002702 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2703 * owner.
Maggie Benthallda51e682013-08-08 22:35:44 -04002704 */
Robin Lee25e26452015-06-02 09:56:29 -07002705 public boolean installCaCert(@Nullable ComponentName admin, byte[] certBuffer) {
Maggie Benthallda51e682013-08-08 22:35:44 -04002706 if (mService != null) {
2707 try {
Robin Lee7e678712014-07-24 16:41:31 +01002708 return mService.installCaCert(admin, certBuffer);
Maggie Benthallda51e682013-08-08 22:35:44 -04002709 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002710 throw e.rethrowFromSystemServer();
Maggie Benthallda51e682013-08-08 22:35:44 -04002711 }
2712 }
2713 return false;
2714 }
2715
2716 /**
Robin Lee7e678712014-07-24 16:41:31 +01002717 * Uninstalls the given certificate from trusted user CAs, if present.
2718 *
Robin Lee25e26452015-06-02 09:56:29 -07002719 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2720 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01002721 * @param certBuffer encoded form of the certificate to remove.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002722 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2723 * owner.
Maggie Benthallda51e682013-08-08 22:35:44 -04002724 */
Robin Lee25e26452015-06-02 09:56:29 -07002725 public void uninstallCaCert(@Nullable ComponentName admin, byte[] certBuffer) {
Maggie Benthallda51e682013-08-08 22:35:44 -04002726 if (mService != null) {
2727 try {
Robin Lee306fe082014-06-19 14:04:24 +00002728 final String alias = getCaCertAlias(certBuffer);
Robin Lee83881bd2015-06-09 16:04:38 -07002729 mService.uninstallCaCerts(admin, new String[] {alias});
Robin Lee306fe082014-06-19 14:04:24 +00002730 } catch (CertificateException e) {
2731 Log.w(TAG, "Unable to parse certificate", e);
Maggie Benthallda51e682013-08-08 22:35:44 -04002732 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002733 throw e.rethrowFromSystemServer();
Maggie Benthallda51e682013-08-08 22:35:44 -04002734 }
2735 }
2736 }
2737
2738 /**
Robin Lee7e678712014-07-24 16:41:31 +01002739 * Returns all CA certificates that are currently trusted, excluding system CA certificates.
2740 * If a user has installed any certificates by other means than device policy these will be
2741 * included too.
2742 *
Robin Lee25e26452015-06-02 09:56:29 -07002743 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2744 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01002745 * @return a List of byte[] arrays, each encoding one user CA certificate.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002746 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2747 * owner.
Maggie Benthallda51e682013-08-08 22:35:44 -04002748 */
Robin Lee25e26452015-06-02 09:56:29 -07002749 public List<byte[]> getInstalledCaCerts(@Nullable ComponentName admin) {
Robin Lee7e678712014-07-24 16:41:31 +01002750 List<byte[]> certs = new ArrayList<byte[]>();
Esteban Talavera808f6ef2014-08-28 17:15:54 +01002751 if (mService != null) {
Robin Lee7e678712014-07-24 16:41:31 +01002752 try {
Esteban Talavera808f6ef2014-08-28 17:15:54 +01002753 mService.enforceCanManageCaCerts(admin);
2754 final TrustedCertificateStore certStore = new TrustedCertificateStore();
2755 for (String alias : certStore.userAliases()) {
2756 try {
2757 certs.add(certStore.getCertificate(alias).getEncoded());
2758 } catch (CertificateException ce) {
2759 Log.w(TAG, "Could not encode certificate: " + alias, ce);
2760 }
2761 }
2762 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002763 throw re.rethrowFromSystemServer();
Robin Lee7e678712014-07-24 16:41:31 +01002764 }
2765 }
2766 return certs;
Maggie Benthallda51e682013-08-08 22:35:44 -04002767 }
2768
2769 /**
Robin Lee7e678712014-07-24 16:41:31 +01002770 * Uninstalls all custom trusted CA certificates from the profile. Certificates installed by
2771 * means other than device policy will also be removed, except for system CA certificates.
2772 *
Robin Lee25e26452015-06-02 09:56:29 -07002773 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2774 * {@code null} if calling from a delegated certificate installer.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002775 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2776 * owner.
Robin Lee7e678712014-07-24 16:41:31 +01002777 */
Robin Lee25e26452015-06-02 09:56:29 -07002778 public void uninstallAllUserCaCerts(@Nullable ComponentName admin) {
Robin Lee7e678712014-07-24 16:41:31 +01002779 if (mService != null) {
Robin Lee83881bd2015-06-09 16:04:38 -07002780 try {
2781 mService.uninstallCaCerts(admin, new TrustedCertificateStore().userAliases()
2782 .toArray(new String[0]));
2783 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002784 throw re.rethrowFromSystemServer();
Robin Lee7e678712014-07-24 16:41:31 +01002785 }
2786 }
2787 }
2788
2789 /**
2790 * Returns whether this certificate is installed as a trusted CA.
2791 *
Robin Lee25e26452015-06-02 09:56:29 -07002792 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2793 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01002794 * @param certBuffer encoded form of the certificate to look up.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002795 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2796 * owner.
Maggie Benthallda51e682013-08-08 22:35:44 -04002797 */
Robin Lee25e26452015-06-02 09:56:29 -07002798 public boolean hasCaCertInstalled(@Nullable ComponentName admin, byte[] certBuffer) {
Esteban Talavera808f6ef2014-08-28 17:15:54 +01002799 if (mService != null) {
2800 try {
2801 mService.enforceCanManageCaCerts(admin);
2802 return getCaCertAlias(certBuffer) != null;
2803 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002804 throw re.rethrowFromSystemServer();
Esteban Talavera808f6ef2014-08-28 17:15:54 +01002805 } catch (CertificateException ce) {
2806 Log.w(TAG, "Could not parse certificate", ce);
2807 }
Maggie Benthallda51e682013-08-08 22:35:44 -04002808 }
2809 return false;
2810 }
2811
2812 /**
Robin Leece3399f2016-02-24 12:08:32 +00002813 * Called by a device or profile owner, or delegated certificate installer, to install a
2814 * certificate and corresponding private key. All apps within the profile will be able to access
2815 * the certificate and use the private key, given direct user approval.
2816 *
2817 * <p>Access to the installed credentials will not be granted to the caller of this API without
2818 * direct user approval. This is for security - should a certificate installer become
2819 * compromised, certificates it had already installed will be protected.
2820 *
2821 * <p>If the installer must have access to the credentials, call
2822 * {@link #installKeyPair(ComponentName, PrivateKey, Certificate, String, boolean)} instead.
Bernhard Bauer26408cc2014-09-08 14:07:31 +01002823 *
Robin Lee25e26452015-06-02 09:56:29 -07002824 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2825 * {@code null} if calling from a delegated certificate installer.
Bernhard Bauer26408cc2014-09-08 14:07:31 +01002826 * @param privKey The private key to install.
2827 * @param cert The certificate to install.
2828 * @param alias The private key alias under which to install the certificate. If a certificate
2829 * with that alias already exists, it will be overwritten.
2830 * @return {@code true} if the keys were installed, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002831 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2832 * owner.
Bernhard Bauer26408cc2014-09-08 14:07:31 +01002833 */
Robin Leefbc65642015-08-03 16:21:22 +01002834 public boolean installKeyPair(@Nullable ComponentName admin, @NonNull PrivateKey privKey,
2835 @NonNull Certificate cert, @NonNull String alias) {
Robin Leece3399f2016-02-24 12:08:32 +00002836 return installKeyPair(admin, privKey, cert, alias, false);
2837 }
2838
2839 /**
2840 * Called by a device or profile owner, or delegated certificate installer, to install a
2841 * certificate and corresponding private key. All apps within the profile will be able to access
2842 * the certificate and use the private key, given direct user approval.
2843 *
Robin Leea1b290e2016-03-09 14:38:36 +00002844 * <p>The caller of this API may grant itself access to the certificate and private key
2845 * immediately, without user approval. It is a best practice not to request this unless strictly
2846 * necessary since it opens up additional security vulnerabilities.
Robin Leece3399f2016-02-24 12:08:32 +00002847 *
2848 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
Robin Leea1b290e2016-03-09 14:38:36 +00002849 * {@code null} if calling from a delegated certificate installer.
Robin Leece3399f2016-02-24 12:08:32 +00002850 * @param privKey The private key to install.
2851 * @param cert The certificate to install.
2852 * @param alias The private key alias under which to install the certificate. If a certificate
Robin Leea1b290e2016-03-09 14:38:36 +00002853 * with that alias already exists, it will be overwritten.
Robin Leece3399f2016-02-24 12:08:32 +00002854 * @param requestAccess {@code true} to request that the calling app be granted access to the
Robin Leea1b290e2016-03-09 14:38:36 +00002855 * credentials immediately. Otherwise, access to the credentials will be gated by user
2856 * approval.
Robin Leece3399f2016-02-24 12:08:32 +00002857 * @return {@code true} if the keys were installed, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002858 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2859 * owner.
Robin Leece3399f2016-02-24 12:08:32 +00002860 */
2861 public boolean installKeyPair(@Nullable ComponentName admin, @NonNull PrivateKey privKey,
2862 @NonNull Certificate cert, @NonNull String alias, boolean requestAccess) {
Bernhard Bauer26408cc2014-09-08 14:07:31 +01002863 try {
2864 final byte[] pemCert = Credentials.convertToPem(cert);
Robin Lee0d5ccb72014-09-12 17:41:44 +01002865 final byte[] pkcs8Key = KeyFactory.getInstance(privKey.getAlgorithm())
2866 .getKeySpec(privKey, PKCS8EncodedKeySpec.class).getEncoded();
Robin Leece3399f2016-02-24 12:08:32 +00002867 return mService.installKeyPair(admin, pkcs8Key, pemCert, alias, requestAccess);
Bernhard Bauer26408cc2014-09-08 14:07:31 +01002868 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002869 throw e.rethrowFromSystemServer();
Robin Lee0d5ccb72014-09-12 17:41:44 +01002870 } catch (NoSuchAlgorithmException | InvalidKeySpecException e) {
2871 Log.w(TAG, "Failed to obtain private key material", e);
2872 } catch (CertificateException | IOException e) {
2873 Log.w(TAG, "Could not pem-encode certificate", e);
Bernhard Bauer26408cc2014-09-08 14:07:31 +01002874 }
2875 return false;
2876 }
2877
2878 /**
Robin Leea1b290e2016-03-09 14:38:36 +00002879 * Called by a device or profile owner, or delegated certificate installer, to remove a
2880 * certificate and private key pair installed under a given alias.
Robin Leefbc65642015-08-03 16:21:22 +01002881 *
2882 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
Robin Leea1b290e2016-03-09 14:38:36 +00002883 * {@code null} if calling from a delegated certificate installer.
Robin Leefbc65642015-08-03 16:21:22 +01002884 * @param alias The private key alias under which the certificate is installed.
Robin Leea1b290e2016-03-09 14:38:36 +00002885 * @return {@code true} if the private key alias no longer exists, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002886 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2887 * owner.
Robin Leefbc65642015-08-03 16:21:22 +01002888 */
2889 public boolean removeKeyPair(@Nullable ComponentName admin, @NonNull String alias) {
2890 try {
2891 return mService.removeKeyPair(admin, alias);
2892 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002893 throw e.rethrowFromSystemServer();
Robin Leefbc65642015-08-03 16:21:22 +01002894 }
Robin Leefbc65642015-08-03 16:21:22 +01002895 }
2896
2897 /**
Robin Lee25e26452015-06-02 09:56:29 -07002898 * @return the alias of a given CA certificate in the certificate store, or {@code null} if it
Robin Lee306fe082014-06-19 14:04:24 +00002899 * doesn't exist.
2900 */
2901 private static String getCaCertAlias(byte[] certBuffer) throws CertificateException {
2902 final CertificateFactory certFactory = CertificateFactory.getInstance("X.509");
2903 final X509Certificate cert = (X509Certificate) certFactory.generateCertificate(
2904 new ByteArrayInputStream(certBuffer));
2905 return new TrustedCertificateStore().getCertificateAlias(cert);
2906 }
2907
2908 /**
Rubin Xuec32b562015-03-03 17:34:05 +00002909 * Called by a profile owner or device owner to grant access to privileged certificate
Rubin Xuacdc1832015-04-02 12:40:20 +01002910 * manipulation APIs to a third-party certificate installer app. Granted APIs include
Rubin Xuec32b562015-03-03 17:34:05 +00002911 * {@link #getInstalledCaCerts}, {@link #hasCaCertInstalled}, {@link #installCaCert},
Rubin Xuacdc1832015-04-02 12:40:20 +01002912 * {@link #uninstallCaCert}, {@link #uninstallAllUserCaCerts} and {@link #installKeyPair}.
Rubin Xuec32b562015-03-03 17:34:05 +00002913 * <p>
2914 * Delegated certificate installer is a per-user state. The delegated access is persistent until
2915 * it is later cleared by calling this method with a null value or uninstallling the certificate
2916 * installer.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002917 * <p>
Rubin Xuf03d0a62016-02-10 14:54:15 +00002918 * <b>Note:</b>Starting from {@link android.os.Build.VERSION_CODES#N}, if the caller
2919 * application's target SDK version is {@link android.os.Build.VERSION_CODES#N} or newer, the
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002920 * supplied certificate installer package must be installed when calling this API, otherwise an
2921 * {@link IllegalArgumentException} will be thrown.
Rubin Xuec32b562015-03-03 17:34:05 +00002922 *
Robin Lee25e26452015-06-02 09:56:29 -07002923 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Rubin Xuec32b562015-03-03 17:34:05 +00002924 * @param installerPackage The package name of the certificate installer which will be given
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002925 * access. If {@code null} is given the current package will be cleared.
2926 * @throws SecurityException if {@code admin} is not a device or a profile owner.
Rubin Xuec32b562015-03-03 17:34:05 +00002927 */
Robin Lee25e26452015-06-02 09:56:29 -07002928 public void setCertInstallerPackage(@NonNull ComponentName admin, @Nullable String
2929 installerPackage) throws SecurityException {
Rubin Xuec32b562015-03-03 17:34:05 +00002930 if (mService != null) {
2931 try {
Robin Lee25e26452015-06-02 09:56:29 -07002932 mService.setCertInstallerPackage(admin, installerPackage);
Rubin Xuec32b562015-03-03 17:34:05 +00002933 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002934 throw e.rethrowFromSystemServer();
Rubin Xuec32b562015-03-03 17:34:05 +00002935 }
2936 }
2937 }
2938
2939 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002940 * Called by a profile owner or device owner to retrieve the certificate installer for the user.
2941 * null if none is set.
Rubin Xuec32b562015-03-03 17:34:05 +00002942 *
Robin Lee25e26452015-06-02 09:56:29 -07002943 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002944 * @return The package name of the current delegated certificate installer, or {@code null} if
2945 * none is set.
2946 * @throws SecurityException if {@code admin} is not a device or a profile owner.
Rubin Xuec32b562015-03-03 17:34:05 +00002947 */
Robin Lee25e26452015-06-02 09:56:29 -07002948 public String getCertInstallerPackage(@NonNull ComponentName admin) throws SecurityException {
Rubin Xuec32b562015-03-03 17:34:05 +00002949 if (mService != null) {
2950 try {
Robin Lee25e26452015-06-02 09:56:29 -07002951 return mService.getCertInstallerPackage(admin);
Rubin Xuec32b562015-03-03 17:34:05 +00002952 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002953 throw e.rethrowFromSystemServer();
Rubin Xuec32b562015-03-03 17:34:05 +00002954 }
2955 }
2956 return null;
2957 }
2958
2959 /**
Robin Lee244ce8e2016-01-05 18:03:46 +00002960 * Called by a device or profile owner to configure an always-on VPN connection through a
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002961 * specific application for the current user. This connection is automatically granted and
2962 * persisted after a reboot.
2963 * <p>
2964 * The designated package should declare a {@link android.net.VpnService} in its manifest
2965 * guarded by {@link android.Manifest.permission#BIND_VPN_SERVICE}, otherwise the call will
2966 * fail.
Robin Lee244ce8e2016-01-05 18:03:46 +00002967 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002968 * @param vpnPackage The package name for an installed VPN app on the device, or {@code null} to
2969 * remove an existing always-on VPN configuration.
2970 * @return {@code true} if the package is set as always-on VPN controller; {@code false}
2971 * otherwise.
2972 * @throws SecurityException if {@code admin} is not a device or a profile owner.
Robin Lee244ce8e2016-01-05 18:03:46 +00002973 */
2974 public boolean setAlwaysOnVpnPackage(@NonNull ComponentName admin,
2975 @Nullable String vpnPackage) {
2976 if (mService != null) {
2977 try {
2978 return mService.setAlwaysOnVpnPackage(admin, vpnPackage);
2979 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002980 throw e.rethrowFromSystemServer();
Robin Lee244ce8e2016-01-05 18:03:46 +00002981 }
2982 }
2983 return false;
2984 }
2985
2986 /**
2987 * Called by a device or profile owner to read the name of the package administering an
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002988 * always-on VPN connection for the current user. If there is no such package, or the always-on
2989 * VPN is provided by the system instead of by an application, {@code null} will be returned.
Robin Lee244ce8e2016-01-05 18:03:46 +00002990 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002991 * @return Package name of VPN controller responsible for always-on VPN, or {@code null} if none
2992 * is set.
2993 * @throws SecurityException if {@code admin} is not a device or a profile owner.
Robin Lee244ce8e2016-01-05 18:03:46 +00002994 */
2995 public String getAlwaysOnVpnPackage(@NonNull ComponentName admin) {
2996 if (mService != null) {
2997 try {
2998 return mService.getAlwaysOnVpnPackage(admin);
2999 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003000 throw e.rethrowFromSystemServer();
Robin Lee244ce8e2016-01-05 18:03:46 +00003001 }
3002 }
3003 return null;
3004 }
3005
3006 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003007 * Called by an application that is administering the device to disable all cameras on the
3008 * device, for this user. After setting this, no applications running as this user will be able
3009 * to access any cameras on the device.
3010 * <p>
3011 * If the caller is device owner, then the restriction will be applied to all users.
3012 * <p>
3013 * The calling device admin must have requested
3014 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_CAMERA} to be able to call this method; if it has
3015 * not, a security exception will be thrown.
Ben Komalo2447edd2011-05-09 16:05:33 -07003016 *
3017 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3018 * @param disabled Whether or not the camera should be disabled.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003019 * @throws SecurityException if {@code admin} is not an active administrator or does not use
3020 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_CAMERA}.
Ben Komalo2447edd2011-05-09 16:05:33 -07003021 */
Robin Lee25e26452015-06-02 09:56:29 -07003022 public void setCameraDisabled(@NonNull ComponentName admin, boolean disabled) {
Ben Komalo2447edd2011-05-09 16:05:33 -07003023 if (mService != null) {
3024 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08003025 mService.setCameraDisabled(admin, disabled);
Ben Komalo2447edd2011-05-09 16:05:33 -07003026 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003027 throw e.rethrowFromSystemServer();
Ben Komalo2447edd2011-05-09 16:05:33 -07003028 }
3029 }
3030 }
3031
3032 /**
Amith Yamasani242f4b12014-10-14 16:06:13 -07003033 * Determine whether or not the device's cameras have been disabled for this user,
Makoto Onuki32b30572015-12-11 14:29:51 -08003034 * either by the calling admin, if specified, or all admins.
Robin Lee25e26452015-06-02 09:56:29 -07003035 * @param admin The name of the admin component to check, or {@code null} to check whether any admins
Ben Komalo2447edd2011-05-09 16:05:33 -07003036 * have disabled the camera
3037 */
Robin Lee25e26452015-06-02 09:56:29 -07003038 public boolean getCameraDisabled(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003039 return getCameraDisabled(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003040 }
3041
3042 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07003043 public boolean getCameraDisabled(@Nullable ComponentName admin, int userHandle) {
Ben Komalo2447edd2011-05-09 16:05:33 -07003044 if (mService != null) {
3045 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003046 return mService.getCameraDisabled(admin, userHandle);
Ben Komalo2447edd2011-05-09 16:05:33 -07003047 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003048 throw e.rethrowFromSystemServer();
Ben Komalo2447edd2011-05-09 16:05:33 -07003049 }
3050 }
3051 return false;
3052 }
3053
3054 /**
Michal Karpinski3fc437e2015-12-15 10:09:00 +00003055 * Called by a device owner to request a bugreport.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003056 * <p>
3057 * There must be only one user on the device, managed by the device owner. Otherwise a
3058 * {@link SecurityException} will be thrown.
Michal Karpinski3fc437e2015-12-15 10:09:00 +00003059 *
3060 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003061 * @return {@code true} if the bugreport collection started successfully, or {@code false} if it
3062 * wasn't triggered because a previous bugreport operation is still active (either the
3063 * bugreport is still running or waiting for the user to share or decline)
3064 * @throws SecurityException if {@code admin} is not a device owner, or if there are users other
3065 * than the one managed by the device owner.
Michal Karpinski3fc437e2015-12-15 10:09:00 +00003066 */
3067 public boolean requestBugreport(@NonNull ComponentName admin) {
3068 if (mService != null) {
3069 try {
3070 return mService.requestBugreport(admin);
3071 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003072 throw e.rethrowFromSystemServer();
Michal Karpinski3fc437e2015-12-15 10:09:00 +00003073 }
3074 }
3075 return false;
3076 }
3077
3078 /**
Fyodor Kupolovcd86ebf2015-09-29 17:06:50 -07003079 * Determine whether or not creating a guest user has been disabled for the device
3080 *
3081 * @hide
3082 */
3083 public boolean getGuestUserDisabled(@Nullable ComponentName admin) {
3084 // Currently guest users can always be created if multi-user is enabled
3085 // TODO introduce a policy for guest user creation
3086 return false;
3087 }
3088
3089 /**
Esteban Talavera1aee98f2014-08-21 14:03:55 +01003090 * Called by a device/profile owner to set whether the screen capture is disabled. Disabling
3091 * screen capture also prevents the content from being shown on display devices that do not have
3092 * a secure video output. See {@link android.view.Display#FLAG_SECURE} for more details about
3093 * secure surfaces and secure displays.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003094 * <p>
3095 * The calling device admin must be a device or profile owner. If it is not, a security
3096 * exception will be thrown.
3097 * <p>
3098 * From version {@link android.os.Build.VERSION_CODES#M} disabling screen capture also blocks
3099 * assist requests for all activities of the relevant user.
Benjamin Franzc200f442015-06-25 18:20:04 +01003100 *
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003101 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003102 * @param disabled Whether screen capture is disabled or not.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003103 * @throws SecurityException if {@code admin} is not a device or profile owner.
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003104 */
Robin Lee25e26452015-06-02 09:56:29 -07003105 public void setScreenCaptureDisabled(@NonNull ComponentName admin, boolean disabled) {
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003106 if (mService != null) {
3107 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08003108 mService.setScreenCaptureDisabled(admin, disabled);
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003109 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003110 throw e.rethrowFromSystemServer();
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003111 }
3112 }
3113 }
3114
3115 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08003116 * Determine whether or not screen capture has been disabled by the calling
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003117 * admin, if specified, or all admins.
Robin Lee25e26452015-06-02 09:56:29 -07003118 * @param admin The name of the admin component to check, or {@code null} to check whether any admins
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003119 * have disabled screen capture.
3120 */
Robin Lee25e26452015-06-02 09:56:29 -07003121 public boolean getScreenCaptureDisabled(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003122 return getScreenCaptureDisabled(admin, myUserId());
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003123 }
3124
3125 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07003126 public boolean getScreenCaptureDisabled(@Nullable ComponentName admin, int userHandle) {
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003127 if (mService != null) {
3128 try {
3129 return mService.getScreenCaptureDisabled(admin, userHandle);
3130 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003131 throw e.rethrowFromSystemServer();
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003132 }
3133 }
3134 return false;
3135 }
3136
3137 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003138 * Called by a device owner to set whether auto time is required. If auto time is required the
3139 * user cannot set the date and time, but has to use network date and time.
3140 * <p>
3141 * Note: if auto time is required the user can still manually set the time zone.
3142 * <p>
3143 * The calling device admin must be a device owner. If it is not, a security exception will be
3144 * thrown.
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003145 *
3146 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3147 * @param required Whether auto time is set required or not.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003148 * @throws SecurityException if {@code admin} is not a device owner.
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003149 */
Robin Lee25e26452015-06-02 09:56:29 -07003150 public void setAutoTimeRequired(@NonNull ComponentName admin, boolean required) {
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003151 if (mService != null) {
3152 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08003153 mService.setAutoTimeRequired(admin, required);
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003154 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003155 throw e.rethrowFromSystemServer();
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003156 }
3157 }
3158 }
3159
3160 /**
3161 * @return true if auto time is required.
3162 */
3163 public boolean getAutoTimeRequired() {
3164 if (mService != null) {
3165 try {
3166 return mService.getAutoTimeRequired();
3167 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003168 throw e.rethrowFromSystemServer();
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003169 }
3170 }
3171 return false;
3172 }
3173
3174 /**
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003175 * Called by a device owner to set whether all users created on the device should be ephemeral.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003176 * <p>
3177 * The system user is exempt from this policy - it is never ephemeral.
3178 * <p>
3179 * The calling device admin must be the device owner. If it is not, a security exception will be
3180 * thrown.
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003181 *
3182 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3183 * @param forceEphemeralUsers If true, all the existing users will be deleted and all
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003184 * subsequently created users will be ephemeral.
3185 * @throws SecurityException if {@code admin} is not a device owner.
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003186 * @hide
3187 */
3188 public void setForceEphemeralUsers(
3189 @NonNull ComponentName admin, boolean forceEphemeralUsers) {
3190 if (mService != null) {
3191 try {
3192 mService.setForceEphemeralUsers(admin, forceEphemeralUsers);
3193 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003194 throw e.rethrowFromSystemServer();
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003195 }
3196 }
3197 }
3198
3199 /**
3200 * @return true if all users are created ephemeral.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003201 * @throws SecurityException if {@code admin} is not a device owner.
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003202 * @hide
3203 */
3204 public boolean getForceEphemeralUsers(@NonNull ComponentName admin) {
3205 if (mService != null) {
3206 try {
3207 return mService.getForceEphemeralUsers(admin);
3208 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003209 throw e.rethrowFromSystemServer();
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003210 }
3211 }
3212 return false;
3213 }
3214
3215 /**
Jim Miller48b9b0d2012-09-19 23:16:50 -07003216 * Called by an application that is administering the device to disable keyguard customizations,
3217 * such as widgets. After setting this, keyguard features will be disabled according to the
3218 * provided feature list.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003219 * <p>
3220 * The calling device admin must have requested
3221 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES} to be able to call this method;
3222 * if it has not, a security exception will be thrown.
3223 * <p>
3224 * Calling this from a managed profile before version {@link android.os.Build.VERSION_CODES#M}
3225 * will throw a security exception. From version {@link android.os.Build.VERSION_CODES#M} the
3226 * profile owner of a managed profile can set:
Kenny Guy0b7dd1e2015-03-12 17:14:38 +00003227 * <ul>
Esteban Talaverac1c83592016-02-17 17:56:15 +00003228 * <li>{@link #KEYGUARD_DISABLE_TRUST_AGENTS}, which affects the parent user, but only if there
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003229 * is no separate challenge set on the managed profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00003230 * <li>{@link #KEYGUARD_DISABLE_FINGERPRINT} which affects the managed profile challenge if
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003231 * there is one, or the parent user otherwise.
3232 * <li>{@link #KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS} which affects notifications generated
3233 * by applications in the managed profile.
Kenny Guy0b7dd1e2015-03-12 17:14:38 +00003234 * </ul>
Esteban Talaverac1c83592016-02-17 17:56:15 +00003235 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} and {@link #KEYGUARD_DISABLE_FINGERPRINT} can also be
3236 * set on the {@link DevicePolicyManager} instance returned by
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003237 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
3238 * profile.
3239 * <p>
3240 * Requests to disable other features on a managed profile will be ignored.
3241 * <p>
3242 * The admin can check which features have been disabled by calling
Kenny Guy0b7dd1e2015-03-12 17:14:38 +00003243 * {@link #getKeyguardDisabledFeatures(ComponentName)}
Amith Yamasani242f4b12014-10-14 16:06:13 -07003244 *
Jim Millerb8ec4702012-08-31 17:19:10 -07003245 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Jim Miller35207742012-11-02 15:33:20 -07003246 * @param which {@link #KEYGUARD_DISABLE_FEATURES_NONE} (default),
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003247 * {@link #KEYGUARD_DISABLE_WIDGETS_ALL}, {@link #KEYGUARD_DISABLE_SECURE_CAMERA},
3248 * {@link #KEYGUARD_DISABLE_SECURE_NOTIFICATIONS},
3249 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS},
3250 * {@link #KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS},
3251 * {@link #KEYGUARD_DISABLE_FINGERPRINT}, {@link #KEYGUARD_DISABLE_FEATURES_ALL}
3252 * @throws SecurityException if {@code admin} is not an active administrator or does not user
3253 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES}
Jim Millerb8ec4702012-08-31 17:19:10 -07003254 */
Robin Lee25e26452015-06-02 09:56:29 -07003255 public void setKeyguardDisabledFeatures(@NonNull ComponentName admin, int which) {
Jim Millerb8ec4702012-08-31 17:19:10 -07003256 if (mService != null) {
3257 try {
Esteban Talavera62399912016-01-11 15:37:55 +00003258 mService.setKeyguardDisabledFeatures(admin, which, mParentInstance);
Jim Millerb8ec4702012-08-31 17:19:10 -07003259 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003260 throw e.rethrowFromSystemServer();
Jim Millerb8ec4702012-08-31 17:19:10 -07003261 }
3262 }
3263 }
3264
3265 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08003266 * Determine whether or not features have been disabled in keyguard either by the calling
Esteban Talaverac1c83592016-02-17 17:56:15 +00003267 * admin, if specified, or all admins that set retrictions on this user and its participating
3268 * profiles. Restrictions on profiles that have a separate challenge are not taken into account.
3269 *
3270 * <p>This method can be called on the {@link DevicePolicyManager} instance
3271 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
3272 * restrictions on the parent profile.
3273 *
Esteban Talavera62399912016-01-11 15:37:55 +00003274 * @param admin The name of the admin component to check, or {@code null} to check whether any
3275 * admins have disabled features in keyguard.
Jim Miller35207742012-11-02 15:33:20 -07003276 * @return bitfield of flags. See {@link #setKeyguardDisabledFeatures(ComponentName, int)}
3277 * for a list.
Jim Millerb8ec4702012-08-31 17:19:10 -07003278 */
Robin Lee25e26452015-06-02 09:56:29 -07003279 public int getKeyguardDisabledFeatures(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003280 return getKeyguardDisabledFeatures(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003281 }
3282
3283 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07003284 public int getKeyguardDisabledFeatures(@Nullable ComponentName admin, int userHandle) {
Jim Millerb8ec4702012-08-31 17:19:10 -07003285 if (mService != null) {
3286 try {
Esteban Talavera62399912016-01-11 15:37:55 +00003287 return mService.getKeyguardDisabledFeatures(admin, userHandle, mParentInstance);
Jim Millerb8ec4702012-08-31 17:19:10 -07003288 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003289 throw e.rethrowFromSystemServer();
Jim Millerb8ec4702012-08-31 17:19:10 -07003290 }
3291 }
Jim Miller48b9b0d2012-09-19 23:16:50 -07003292 return KEYGUARD_DISABLE_FEATURES_NONE;
Jim Millerb8ec4702012-08-31 17:19:10 -07003293 }
3294
3295 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -08003296 * @hide
3297 */
Robin Lee25e26452015-06-02 09:56:29 -07003298 public void setActiveAdmin(@NonNull ComponentName policyReceiver, boolean refreshing,
3299 int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08003300 if (mService != null) {
3301 try {
Jessica Hummel6d36b602014-04-04 12:42:17 +01003302 mService.setActiveAdmin(policyReceiver, refreshing, userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08003303 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003304 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08003305 }
3306 }
3307 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07003308
Dianne Hackbornd6847842010-01-12 18:14:19 -08003309 /**
Jessica Hummel6d36b602014-04-04 12:42:17 +01003310 * @hide
3311 */
Robin Lee25e26452015-06-02 09:56:29 -07003312 public void setActiveAdmin(@NonNull ComponentName policyReceiver, boolean refreshing) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003313 setActiveAdmin(policyReceiver, refreshing, myUserId());
Jessica Hummel6d36b602014-04-04 12:42:17 +01003314 }
3315
3316 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -08003317 * @hide
3318 */
Robin Lee25e26452015-06-02 09:56:29 -07003319 public void getRemoveWarning(@Nullable ComponentName admin, RemoteCallback result) {
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08003320 if (mService != null) {
3321 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003322 mService.getRemoveWarning(admin, result, myUserId());
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08003323 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003324 throw e.rethrowFromSystemServer();
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08003325 }
3326 }
3327 }
3328
3329 /**
3330 * @hide
3331 */
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07003332 public void setActivePasswordState(int quality, int length, int letters, int uppercase,
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003333 int lowercase, int numbers, int symbols, int nonletter, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08003334 if (mService != null) {
3335 try {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07003336 mService.setActivePasswordState(quality, length, letters, uppercase, lowercase,
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003337 numbers, symbols, nonletter, userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08003338 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003339 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08003340 }
3341 }
3342 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07003343
Dianne Hackbornd6847842010-01-12 18:14:19 -08003344 /**
3345 * @hide
3346 */
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003347 public void reportFailedPasswordAttempt(int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08003348 if (mService != null) {
3349 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003350 mService.reportFailedPasswordAttempt(userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08003351 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003352 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08003353 }
3354 }
3355 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07003356
Dianne Hackbornd6847842010-01-12 18:14:19 -08003357 /**
3358 * @hide
3359 */
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003360 public void reportSuccessfulPasswordAttempt(int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08003361 if (mService != null) {
3362 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003363 mService.reportSuccessfulPasswordAttempt(userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08003364 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003365 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08003366 }
3367 }
3368 }
Amith Yamasani71e6c692013-03-24 17:39:28 -07003369
3370 /**
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003371 * @hide
3372 */
3373 public void reportFailedFingerprintAttempt(int userHandle) {
3374 if (mService != null) {
3375 try {
3376 mService.reportFailedFingerprintAttempt(userHandle);
3377 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003378 throw e.rethrowFromSystemServer();
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003379 }
3380 }
3381 }
3382
3383 /**
3384 * @hide
3385 */
3386 public void reportSuccessfulFingerprintAttempt(int userHandle) {
3387 if (mService != null) {
3388 try {
3389 mService.reportSuccessfulFingerprintAttempt(userHandle);
3390 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003391 throw e.rethrowFromSystemServer();
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003392 }
3393 }
3394 }
3395
3396 /**
Michal Karpinski31502d32016-01-25 16:43:07 +00003397 * Should be called when keyguard has been dismissed.
3398 * @hide
3399 */
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003400 public void reportKeyguardDismissed(int userHandle) {
Michal Karpinski31502d32016-01-25 16:43:07 +00003401 if (mService != null) {
3402 try {
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003403 mService.reportKeyguardDismissed(userHandle);
Michal Karpinski31502d32016-01-25 16:43:07 +00003404 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003405 throw e.rethrowFromSystemServer();
Michal Karpinski31502d32016-01-25 16:43:07 +00003406 }
3407 }
3408 }
3409
3410 /**
3411 * Should be called when keyguard view has been shown to the user.
3412 * @hide
3413 */
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003414 public void reportKeyguardSecured(int userHandle) {
Michal Karpinski31502d32016-01-25 16:43:07 +00003415 if (mService != null) {
3416 try {
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003417 mService.reportKeyguardSecured(userHandle);
Michal Karpinski31502d32016-01-25 16:43:07 +00003418 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003419 throw e.rethrowFromSystemServer();
Michal Karpinski31502d32016-01-25 16:43:07 +00003420 }
3421 }
3422 }
3423
3424 /**
Amith Yamasani71e6c692013-03-24 17:39:28 -07003425 * @hide
Nicolas Prevot28063742015-01-08 15:37:12 +00003426 * Sets the given package as the device owner.
Makoto Onukia52562c2015-10-01 16:12:31 -07003427 * Same as {@link #setDeviceOwner(ComponentName, String)} but without setting a device owner name.
3428 * @param who the component name to be registered as device owner.
Amith Yamasani71e6c692013-03-24 17:39:28 -07003429 * @return whether the package was successfully registered as the device owner.
3430 * @throws IllegalArgumentException if the package name is null or invalid
Nicolas Prevot28063742015-01-08 15:37:12 +00003431 * @throws IllegalStateException If the preconditions mentioned are not met.
Amith Yamasani71e6c692013-03-24 17:39:28 -07003432 */
Makoto Onukia52562c2015-10-01 16:12:31 -07003433 public boolean setDeviceOwner(ComponentName who) {
3434 return setDeviceOwner(who, null);
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003435 }
3436
3437 /**
3438 * @hide
Makoto Onuki58b684f2015-09-04 10:48:16 -07003439 */
Makoto Onukia52562c2015-10-01 16:12:31 -07003440 public boolean setDeviceOwner(ComponentName who, int userId) {
3441 return setDeviceOwner(who, null, userId);
Makoto Onuki58b684f2015-09-04 10:48:16 -07003442 }
3443
3444 /**
3445 * @hide
3446 */
Makoto Onukia52562c2015-10-01 16:12:31 -07003447 public boolean setDeviceOwner(ComponentName who, String ownerName) {
3448 return setDeviceOwner(who, ownerName, UserHandle.USER_SYSTEM);
Makoto Onuki58b684f2015-09-04 10:48:16 -07003449 }
3450
3451 /**
3452 * @hide
Nicolas Prevot28063742015-01-08 15:37:12 +00003453 * Sets the given package as the device owner. The package must already be installed. There
3454 * must not already be a device owner.
3455 * Only apps with the MANAGE_PROFILE_AND_DEVICE_OWNERS permission and the shell uid can call
3456 * this method.
3457 * Calling this after the setup phase of the primary user has completed is allowed only if
3458 * the caller is the shell uid, and there are no additional users and no accounts.
Makoto Onukia52562c2015-10-01 16:12:31 -07003459 * @param who the component name to be registered as device owner.
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003460 * @param ownerName the human readable name of the institution that owns this device.
Makoto Onuki58b684f2015-09-04 10:48:16 -07003461 * @param userId ID of the user on which the device owner runs.
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003462 * @return whether the package was successfully registered as the device owner.
3463 * @throws IllegalArgumentException if the package name is null or invalid
Nicolas Prevot28063742015-01-08 15:37:12 +00003464 * @throws IllegalStateException If the preconditions mentioned are not met.
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003465 */
Makoto Onukia52562c2015-10-01 16:12:31 -07003466 public boolean setDeviceOwner(ComponentName who, String ownerName, int userId)
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003467 throws IllegalArgumentException, IllegalStateException {
Amith Yamasani71e6c692013-03-24 17:39:28 -07003468 if (mService != null) {
3469 try {
Makoto Onukia52562c2015-10-01 16:12:31 -07003470 return mService.setDeviceOwner(who, ownerName, userId);
Amith Yamasani71e6c692013-03-24 17:39:28 -07003471 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003472 throw re.rethrowFromSystemServer();
Amith Yamasani71e6c692013-03-24 17:39:28 -07003473 }
3474 }
3475 return false;
3476 }
3477
3478 /**
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003479 * Used to determine if a particular package has been registered as a Device Owner app.
3480 * A device owner app is a special device admin that cannot be deactivated by the user, once
Robin Lee25e26452015-06-02 09:56:29 -07003481 * activated as a device admin. It also cannot be uninstalled. To check whether a particular
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003482 * package is currently registered as the device owner app, pass in the package name from
3483 * {@link Context#getPackageName()} to this method.<p/>This is useful for device
Robin Lee25e26452015-06-02 09:56:29 -07003484 * admin apps that want to check whether they are also registered as the device owner app. The
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003485 * exact mechanism by which a device admin app is registered as a device owner app is defined by
3486 * the setup process.
3487 * @param packageName the package name of the app, to compare with the registered device owner
3488 * app, if any.
Makoto Onukic8a5a552015-11-19 14:29:12 -08003489 * @return whether or not the package is registered as the device owner app.
Amith Yamasani71e6c692013-03-24 17:39:28 -07003490 */
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003491 public boolean isDeviceOwnerApp(String packageName) {
Makoto Onukic8a5a552015-11-19 14:29:12 -08003492 return isDeviceOwnerAppOnCallingUser(packageName);
3493 }
3494
3495 /**
3496 * @return true if a package is registered as device owner, only when it's running on the
3497 * calling user.
3498 *
3499 * <p>Same as {@link #isDeviceOwnerApp}, but bundled code should use it for clarity.
3500 * @hide
3501 */
3502 public boolean isDeviceOwnerAppOnCallingUser(String packageName) {
3503 return isDeviceOwnerAppOnAnyUserInner(packageName, /* callingUserOnly =*/ true);
3504 }
3505
3506 /**
3507 * @return true if a package is registered as device owner, even if it's running on a different
3508 * user.
3509 *
3510 * <p>Requires the MANAGE_USERS permission.
3511 *
3512 * @hide
3513 */
3514 public boolean isDeviceOwnerAppOnAnyUser(String packageName) {
3515 return isDeviceOwnerAppOnAnyUserInner(packageName, /* callingUserOnly =*/ false);
3516 }
3517
3518 /**
3519 * @return device owner component name, only when it's running on the calling user.
3520 *
3521 * @hide
3522 */
3523 public ComponentName getDeviceOwnerComponentOnCallingUser() {
3524 return getDeviceOwnerComponentInner(/* callingUserOnly =*/ true);
3525 }
3526
3527 /**
3528 * @return device owner component name, even if it's running on a different user.
3529 *
3530 * <p>Requires the MANAGE_USERS permission.
3531 *
3532 * @hide
3533 */
3534 public ComponentName getDeviceOwnerComponentOnAnyUser() {
3535 return getDeviceOwnerComponentInner(/* callingUserOnly =*/ false);
3536 }
3537
3538 private boolean isDeviceOwnerAppOnAnyUserInner(String packageName, boolean callingUserOnly) {
Makoto Onuki70f929e2015-11-11 12:40:15 -08003539 if (packageName == null) {
3540 return false;
Amith Yamasani71e6c692013-03-24 17:39:28 -07003541 }
Makoto Onukic8a5a552015-11-19 14:29:12 -08003542 final ComponentName deviceOwner = getDeviceOwnerComponentInner(callingUserOnly);
Makoto Onuki70f929e2015-11-11 12:40:15 -08003543 if (deviceOwner == null) {
3544 return false;
3545 }
3546 return packageName.equals(deviceOwner.getPackageName());
Amith Yamasani71e6c692013-03-24 17:39:28 -07003547 }
3548
Makoto Onukic8a5a552015-11-19 14:29:12 -08003549 private ComponentName getDeviceOwnerComponentInner(boolean callingUserOnly) {
3550 if (mService != null) {
3551 try {
3552 return mService.getDeviceOwnerComponent(callingUserOnly);
3553 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003554 throw re.rethrowFromSystemServer();
Makoto Onukic8a5a552015-11-19 14:29:12 -08003555 }
3556 }
3557 return null;
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003558 }
3559
Jason Monkb0dced82014-06-06 14:36:20 -04003560 /**
Makoto Onukic8a5a552015-11-19 14:29:12 -08003561 * @return ID of the user who runs device owner, or {@link UserHandle#USER_NULL} if there's
3562 * no device owner.
3563 *
3564 * <p>Requires the MANAGE_USERS permission.
Makoto Onukia52562c2015-10-01 16:12:31 -07003565 *
3566 * @hide
3567 */
Makoto Onukic8a5a552015-11-19 14:29:12 -08003568 public int getDeviceOwnerUserId() {
3569 if (mService != null) {
3570 try {
3571 return mService.getDeviceOwnerUserId();
3572 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003573 throw re.rethrowFromSystemServer();
Makoto Onukic8a5a552015-11-19 14:29:12 -08003574 }
3575 }
3576 return UserHandle.USER_NULL;
Makoto Onukia52562c2015-10-01 16:12:31 -07003577 }
3578
3579 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003580 * Clears the current device owner. The caller must be the device owner. This function should be
3581 * used cautiously as once it is called it cannot be undone. The device owner can only be set as
3582 * a part of device setup before setup completes.
Jason Monk94d2cf92014-06-18 09:53:34 -04003583 *
3584 * @param packageName The package name of the device owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003585 * @throws SecurityException if the caller is not in {@code packageName} or {@code packageName}
3586 * does not own the current device owner component.
Jason Monkb0dced82014-06-06 14:36:20 -04003587 */
Jason Monk94d2cf92014-06-18 09:53:34 -04003588 public void clearDeviceOwnerApp(String packageName) {
Jason Monkb0dced82014-06-06 14:36:20 -04003589 if (mService != null) {
3590 try {
Jason Monk94d2cf92014-06-18 09:53:34 -04003591 mService.clearDeviceOwner(packageName);
Jason Monkb0dced82014-06-06 14:36:20 -04003592 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003593 throw re.rethrowFromSystemServer();
Jason Monkb0dced82014-06-06 14:36:20 -04003594 }
3595 }
3596 }
3597
Makoto Onukia52562c2015-10-01 16:12:31 -07003598 /**
Makoto Onukic8a5a552015-11-19 14:29:12 -08003599 * Returns the device owner package name, only if it's running on the calling user.
3600 *
3601 * <p>Bundled components should use {@code getDeviceOwnerComponentOnCallingUser()} for clarity.
Makoto Onukia52562c2015-10-01 16:12:31 -07003602 *
3603 * @hide
3604 */
Nicolas Prevot465acf32014-08-06 17:03:25 +01003605 @SystemApi
Amith Yamasani71e6c692013-03-24 17:39:28 -07003606 public String getDeviceOwner() {
Makoto Onukic8a5a552015-11-19 14:29:12 -08003607 final ComponentName name = getDeviceOwnerComponentOnCallingUser();
3608 return name != null ? name.getPackageName() : null;
Makoto Onukia52562c2015-10-01 16:12:31 -07003609 }
3610
3611 /**
Makoto Onukic8a5a552015-11-19 14:29:12 -08003612 * @return true if the device is managed by any device owner.
3613 *
3614 * <p>Requires the MANAGE_USERS permission.
Makoto Onukia52562c2015-10-01 16:12:31 -07003615 *
3616 * @hide
3617 */
Makoto Onukic8a5a552015-11-19 14:29:12 -08003618 public boolean isDeviceManaged() {
3619 return getDeviceOwnerComponentOnAnyUser() != null;
3620 }
3621
3622 /**
3623 * Returns the device owner name. Note this method *will* return the device owner
3624 * name when it's running on a different user.
3625 *
3626 * <p>Requires the MANAGE_USERS permission.
3627 *
3628 * @hide
3629 */
Makoto Onukia2b274b2016-01-19 13:26:02 -08003630 @SystemApi
Makoto Onukic8a5a552015-11-19 14:29:12 -08003631 public String getDeviceOwnerNameOnAnyUser() {
Amith Yamasani71e6c692013-03-24 17:39:28 -07003632 if (mService != null) {
3633 try {
Makoto Onukia52562c2015-10-01 16:12:31 -07003634 return mService.getDeviceOwnerName();
Amith Yamasani71e6c692013-03-24 17:39:28 -07003635 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003636 throw re.rethrowFromSystemServer();
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003637 }
3638 }
3639 return null;
3640 }
Adam Connors776c5552014-01-09 10:42:56 +00003641
3642 /**
Julia Reynolds94e7bf62015-06-10 14:44:56 -04003643 * @hide
Craig Lafayettee7ee54e2015-09-21 13:48:53 -04003644 * @deprecated Do not use
3645 * @removed
Julia Reynolds20118f12015-02-11 12:34:08 -05003646 */
Craig Lafayettee7ee54e2015-09-21 13:48:53 -04003647 @Deprecated
Julia Reynolds20118f12015-02-11 12:34:08 -05003648 @SystemApi
3649 public String getDeviceInitializerApp() {
Julia Reynolds20118f12015-02-11 12:34:08 -05003650 return null;
3651 }
3652
3653 /**
Julia Reynoldseaafdf722015-04-02 08:49:47 -04003654 * @hide
Craig Lafayettee7ee54e2015-09-21 13:48:53 -04003655 * @deprecated Do not use
3656 * @removed
Julia Reynoldseaafdf722015-04-02 08:49:47 -04003657 */
Craig Lafayettee7ee54e2015-09-21 13:48:53 -04003658 @Deprecated
Julia Reynoldseaafdf722015-04-02 08:49:47 -04003659 @SystemApi
3660 public ComponentName getDeviceInitializerComponent() {
Julia Reynoldseaafdf722015-04-02 08:49:47 -04003661 return null;
3662 }
3663
Julia Reynolds20118f12015-02-11 12:34:08 -05003664 /**
Adam Connors776c5552014-01-09 10:42:56 +00003665 * @hide
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003666 * @deprecated Use #ACTION_SET_PROFILE_OWNER
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303667 * Sets the given component as an active admin and registers the package as the profile
3668 * owner for this user. The package must already be installed and there shouldn't be
3669 * an existing profile owner registered for this user. Also, this method must be called
3670 * before the user setup has been completed.
3671 * <p>
3672 * This method can only be called by system apps that hold MANAGE_USERS permission and
3673 * MANAGE_DEVICE_ADMINS permission.
3674 * @param admin The component to register as an active admin and profile owner.
3675 * @param ownerName The user-visible name of the entity that is managing this user.
3676 * @return whether the admin was successfully registered as the profile owner.
3677 * @throws IllegalArgumentException if packageName is null, the package isn't installed, or
3678 * the user has already been set up.
3679 */
Justin Morey80440cc2014-07-24 09:16:35 -05003680 @SystemApi
Robin Lee25e26452015-06-02 09:56:29 -07003681 public boolean setActiveProfileOwner(@NonNull ComponentName admin, @Deprecated String ownerName)
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303682 throws IllegalArgumentException {
3683 if (mService != null) {
3684 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003685 final int myUserId = myUserId();
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303686 mService.setActiveAdmin(admin, false, myUserId);
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003687 return mService.setProfileOwner(admin, ownerName, myUserId);
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303688 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003689 throw re.rethrowFromSystemServer();
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303690 }
3691 }
3692 return false;
3693 }
3694
3695 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003696 * Clears the active profile owner and removes all user restrictions. The caller must be from
3697 * the same package as the active profile owner for this user, otherwise a SecurityException
3698 * will be thrown.
3699 * <p>
3700 * This doesn't work for managed profile owners.
Makoto Onuki5bf68022016-01-27 13:49:19 -08003701 *
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003702 * @param admin The component to remove as the profile owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003703 * @throws SecurityException if {@code admin} is not an active profile owner.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003704 */
Robin Lee25e26452015-06-02 09:56:29 -07003705 public void clearProfileOwner(@NonNull ComponentName admin) {
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003706 if (mService != null) {
3707 try {
3708 mService.clearProfileOwner(admin);
3709 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003710 throw re.rethrowFromSystemServer();
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003711 }
3712 }
3713 }
3714
3715 /**
Julia Reynoldse9254402015-02-11 12:34:08 -05003716 * @hide
Robin Lee25e26452015-06-02 09:56:29 -07003717 * Checks whether the user was already setup.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003718 */
3719 public boolean hasUserSetupCompleted() {
3720 if (mService != null) {
3721 try {
3722 return mService.hasUserSetupCompleted();
3723 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003724 throw re.rethrowFromSystemServer();
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003725 }
3726 }
3727 return true;
3728 }
3729
3730 /**
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003731 * @hide
3732 * Sets the given component as the profile owner of the given user profile. The package must
Nicolas Prevot28063742015-01-08 15:37:12 +00003733 * already be installed. There must not already be a profile owner for this user.
3734 * Only apps with the MANAGE_PROFILE_AND_DEVICE_OWNERS permission and the shell uid can call
3735 * this method.
3736 * Calling this after the setup phase of the specified user has completed is allowed only if:
3737 * - the caller is SYSTEM_UID.
3738 * - or the caller is the shell uid, and there are no accounts on the specified user.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003739 * @param admin the component name to be registered as profile owner.
3740 * @param ownerName the human readable name of the organisation associated with this DPM.
3741 * @param userHandle the userId to set the profile owner for.
3742 * @return whether the component was successfully registered as the profile owner.
Nicolas Prevot28063742015-01-08 15:37:12 +00003743 * @throws IllegalArgumentException if admin is null, the package isn't installed, or the
3744 * preconditions mentioned are not met.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003745 */
Robin Lee25e26452015-06-02 09:56:29 -07003746 public boolean setProfileOwner(@NonNull ComponentName admin, @Deprecated String ownerName,
Robin Leeddd553f2015-04-30 14:18:22 +01003747 int userHandle) throws IllegalArgumentException {
Adam Connors776c5552014-01-09 10:42:56 +00003748 if (mService != null) {
3749 try {
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003750 if (ownerName == null) {
3751 ownerName = "";
3752 }
3753 return mService.setProfileOwner(admin, ownerName, userHandle);
Adam Connors776c5552014-01-09 10:42:56 +00003754 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003755 throw re.rethrowFromSystemServer();
Adam Connors776c5552014-01-09 10:42:56 +00003756 }
3757 }
3758 return false;
3759 }
3760
3761 /**
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003762 * Sets the device owner information to be shown on the lock screen.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003763 * <p>
3764 * If the device owner information is {@code null} or empty then the device owner info is
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003765 * cleared and the user owner info is shown on the lock screen if it is set.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003766 * <p>
3767 * If the device owner information contains only whitespaces then the message on the lock screen
3768 * will be blank and the user will not be allowed to change it.
3769 * <p>
3770 * If the device owner information needs to be localized, it is the responsibility of the
Benjamin Franz3e8a7092016-01-25 16:19:08 +00003771 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
3772 * and set a new version of this string accordingly.
3773 *
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003774 * @param admin The name of the admin component to check.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003775 * @param info Device owner information which will be displayed instead of the user owner info.
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003776 * @return Whether the device owner information has been set.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003777 * @throws SecurityException if {@code admin} is not a device owner.
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003778 */
3779 public boolean setDeviceOwnerLockScreenInfo(@NonNull ComponentName admin, String info) {
3780 if (mService != null) {
3781 try {
3782 return mService.setDeviceOwnerLockScreenInfo(admin, info);
3783 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003784 throw re.rethrowFromSystemServer();
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003785 }
3786 }
3787 return false;
3788 }
3789
3790 /**
3791 * @return The device owner information. If it is not set returns {@code null}.
3792 */
3793 public String getDeviceOwnerLockScreenInfo() {
3794 if (mService != null) {
3795 try {
3796 return mService.getDeviceOwnerLockScreenInfo();
3797 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003798 throw re.rethrowFromSystemServer();
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003799 }
3800 }
3801 return null;
3802 }
3803
3804 /**
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00003805 * Called by device or profile owners to suspend packages for this user.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003806 * <p>
3807 * A suspended package will not be able to start activities. Its notifications will be hidden,
3808 * it will not show up in recents, will not be able to show toasts or dialogs or ring the
3809 * device.
3810 * <p>
3811 * The package must already be installed. If the package is uninstalled while suspended the
3812 * package will no longer be suspended. The admin can block this by using
Kenny Guy871f3eb2016-03-09 20:06:16 +00003813 * {@link #setUninstallBlocked}.
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003814 *
3815 * @param admin The name of the admin component to check.
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00003816 * @param packageNames The package names to suspend or unsuspend.
3817 * @param suspended If set to {@code true} than the packages will be suspended, if set to
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003818 * {@code false} the packages will be unsuspended.
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00003819 * @return an array of package names for which the suspended status is not set as requested in
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003820 * this method.
3821 * @throws SecurityException if {@code admin} is not a device or profile owner.
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003822 */
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00003823 public String[] setPackagesSuspended(@NonNull ComponentName admin, String[] packageNames,
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003824 boolean suspended) {
3825 if (mService != null) {
3826 try {
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00003827 return mService.setPackagesSuspended(admin, packageNames, suspended);
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003828 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003829 throw re.rethrowFromSystemServer();
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003830 }
3831 }
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00003832 return packageNames;
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003833 }
3834
3835 /**
3836 * Called by device or profile owners to determine if a package is suspended.
3837 *
3838 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3839 * @param packageName The name of the package to retrieve the suspended status of.
Andrei Stingaceanu355b2322016-02-12 16:43:51 +00003840 * @return {@code true} if the package is suspended or {@code false} if the package is not
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003841 * suspended, could not be found or an error occurred.
3842 * @throws SecurityException if {@code admin} is not a device or profile owner.
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003843 */
3844 public boolean getPackageSuspended(@NonNull ComponentName admin, String packageName) {
3845 if (mService != null) {
3846 try {
3847 return mService.getPackageSuspended(admin, packageName);
3848 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003849 throw e.rethrowFromSystemServer();
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003850 }
3851 }
3852 return false;
3853 }
3854
3855 /**
Alexandra Gherghina512675b2014-04-02 11:23:54 +01003856 * Sets the enabled state of the profile. A profile should be enabled only once it is ready to
3857 * be used. Only the profile owner can call this.
3858 *
Alexandra Gherghinadf35d572014-04-09 13:54:39 +01003859 * @see #isProfileOwnerApp
Alexandra Gherghina512675b2014-04-02 11:23:54 +01003860 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003861 * @throws SecurityException if {@code admin} is not a profile owner.
Alexandra Gherghina512675b2014-04-02 11:23:54 +01003862 */
Robin Lee25e26452015-06-02 09:56:29 -07003863 public void setProfileEnabled(@NonNull ComponentName admin) {
Alexandra Gherghina512675b2014-04-02 11:23:54 +01003864 if (mService != null) {
3865 try {
3866 mService.setProfileEnabled(admin);
3867 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003868 throw e.rethrowFromSystemServer();
Alexandra Gherghina512675b2014-04-02 11:23:54 +01003869 }
3870 }
3871 }
3872
3873 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003874 * Sets the name of the profile. In the device owner case it sets the name of the user which it
3875 * is called from. Only a profile owner or device owner can call this. If this is never called
3876 * by the profile or device owner, the name will be set to default values.
Jessica Hummel1333ea12014-06-23 11:20:10 +01003877 *
3878 * @see #isProfileOwnerApp
3879 * @see #isDeviceOwnerApp
Robin Lee25e26452015-06-02 09:56:29 -07003880 * @param admin Which {@link DeviceAdminReceiver} this request is associate with.
Jessica Hummel1333ea12014-06-23 11:20:10 +01003881 * @param profileName The name of the profile.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003882 * @throws SecurityException if {@code admin} is not a device or profile owner.
Jessica Hummel1333ea12014-06-23 11:20:10 +01003883 */
Robin Lee25e26452015-06-02 09:56:29 -07003884 public void setProfileName(@NonNull ComponentName admin, String profileName) {
Jessica Hummel1333ea12014-06-23 11:20:10 +01003885 if (mService != null) {
3886 try {
Robin Lee25e26452015-06-02 09:56:29 -07003887 mService.setProfileName(admin, profileName);
Fyodor Kupolov78f13142015-05-27 16:52:45 -07003888 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003889 throw e.rethrowFromSystemServer();
Fyodor Kupolov78f13142015-05-27 16:52:45 -07003890 }
Jessica Hummel1333ea12014-06-23 11:20:10 +01003891 }
3892 }
Jessica Hummel1333ea12014-06-23 11:20:10 +01003893
3894 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07003895 * Used to determine if a particular package is registered as the profile owner for the
Makoto Onuki32b30572015-12-11 14:29:51 -08003896 * user. A profile owner is a special device admin that has additional privileges
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07003897 * within the profile.
Adam Connors776c5552014-01-09 10:42:56 +00003898 *
3899 * @param packageName The package name of the app to compare with the registered profile owner.
3900 * @return Whether or not the package is registered as the profile owner.
3901 */
3902 public boolean isProfileOwnerApp(String packageName) {
3903 if (mService != null) {
3904 try {
Makoto Onuki90b89652016-01-28 14:44:18 -08003905 ComponentName profileOwner = mService.getProfileOwner(myUserId());
Nicolas Prevot90af6d72014-07-30 14:19:12 +01003906 return profileOwner != null
3907 && profileOwner.getPackageName().equals(packageName);
Adam Connors776c5552014-01-09 10:42:56 +00003908 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003909 throw re.rethrowFromSystemServer();
Adam Connors776c5552014-01-09 10:42:56 +00003910 }
3911 }
3912 return false;
3913 }
3914
3915 /**
3916 * @hide
Robin Lee25e26452015-06-02 09:56:29 -07003917 * @return the packageName of the owner of the given user profile or {@code null} if no profile
Adam Connors776c5552014-01-09 10:42:56 +00003918 * owner has been set for that user.
3919 * @throws IllegalArgumentException if the userId is invalid.
3920 */
Nicolas Prevot465acf32014-08-06 17:03:25 +01003921 @SystemApi
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003922 public ComponentName getProfileOwner() throws IllegalArgumentException {
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01003923 return getProfileOwnerAsUser(Process.myUserHandle().getIdentifier());
3924 }
3925
3926 /**
3927 * @see #getProfileOwner()
3928 * @hide
3929 */
3930 public ComponentName getProfileOwnerAsUser(final int userId) throws IllegalArgumentException {
Adam Connors776c5552014-01-09 10:42:56 +00003931 if (mService != null) {
3932 try {
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01003933 return mService.getProfileOwner(userId);
Adam Connors776c5552014-01-09 10:42:56 +00003934 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003935 throw re.rethrowFromSystemServer();
Adam Connors776c5552014-01-09 10:42:56 +00003936 }
3937 }
3938 return null;
3939 }
3940
3941 /**
3942 * @hide
Robin Lee25e26452015-06-02 09:56:29 -07003943 * @return the human readable name of the organisation associated with this DPM or {@code null}
3944 * if one is not set.
Adam Connors776c5552014-01-09 10:42:56 +00003945 * @throws IllegalArgumentException if the userId is invalid.
3946 */
3947 public String getProfileOwnerName() throws IllegalArgumentException {
3948 if (mService != null) {
3949 try {
3950 return mService.getProfileOwnerName(Process.myUserHandle().getIdentifier());
3951 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003952 throw re.rethrowFromSystemServer();
Adam Connors776c5552014-01-09 10:42:56 +00003953 }
3954 }
3955 return null;
3956 }
Sander Alewijnsef475ca32014-02-17 15:13:58 +00003957
3958 /**
Amith Yamasani38f836b2014-08-20 14:51:15 -07003959 * @hide
Makoto Onukic8a5a552015-11-19 14:29:12 -08003960 * @param userId The user for whom to fetch the profile owner name, if any.
Amith Yamasani38f836b2014-08-20 14:51:15 -07003961 * @return the human readable name of the organisation associated with this profile owner or
3962 * null if one is not set.
3963 * @throws IllegalArgumentException if the userId is invalid.
3964 */
3965 @SystemApi
Selim Cinek24ac55e2014-08-27 12:51:45 +02003966 public String getProfileOwnerNameAsUser(int userId) throws IllegalArgumentException {
Amith Yamasani38f836b2014-08-20 14:51:15 -07003967 if (mService != null) {
3968 try {
Selim Cinek24ac55e2014-08-27 12:51:45 +02003969 return mService.getProfileOwnerName(userId);
Amith Yamasani38f836b2014-08-20 14:51:15 -07003970 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003971 throw re.rethrowFromSystemServer();
Amith Yamasani38f836b2014-08-20 14:51:15 -07003972 }
3973 }
3974 return null;
3975 }
3976
3977 /**
Sander Alewijnsef475ca32014-02-17 15:13:58 +00003978 * Called by a profile owner or device owner to add a default intent handler activity for
3979 * intents that match a certain intent filter. This activity will remain the default intent
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003980 * handler even if the set of potential event handlers for the intent filter changes and if the
3981 * intent preferences are reset.
3982 * <p>
3983 * The default disambiguation mechanism takes over if the activity is not installed (anymore).
3984 * When the activity is (re)installed, it is automatically reset as default intent handler for
3985 * the filter.
3986 * <p>
3987 * The calling device admin must be a profile owner or device owner. If it is not, a security
3988 * exception will be thrown.
Sander Alewijnsef475ca32014-02-17 15:13:58 +00003989 *
3990 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3991 * @param filter The IntentFilter for which a default handler is added.
3992 * @param activity The Activity that is added as default intent handler.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003993 * @throws SecurityException if {@code admin} is not a device or profile owner.
Sander Alewijnsef475ca32014-02-17 15:13:58 +00003994 */
Robin Lee25e26452015-06-02 09:56:29 -07003995 public void addPersistentPreferredActivity(@NonNull ComponentName admin, IntentFilter filter,
3996 @NonNull ComponentName activity) {
Sander Alewijnsef475ca32014-02-17 15:13:58 +00003997 if (mService != null) {
3998 try {
3999 mService.addPersistentPreferredActivity(admin, filter, activity);
4000 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004001 throw e.rethrowFromSystemServer();
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004002 }
4003 }
4004 }
4005
4006 /**
4007 * Called by a profile owner or device owner to remove all persistent intent handler preferences
Torne (Richard Coles)875e2102014-02-24 14:11:56 +00004008 * associated with the given package that were set by {@link #addPersistentPreferredActivity}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004009 * <p>
4010 * The calling device admin must be a profile owner. If it is not, a security exception will be
4011 * thrown.
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004012 *
4013 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4014 * @param packageName The name of the package for which preferences are removed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004015 * @throws SecurityException if {@code admin} is not a device or profile owner.
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004016 */
Robin Lee25e26452015-06-02 09:56:29 -07004017 public void clearPackagePersistentPreferredActivities(@NonNull ComponentName admin,
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004018 String packageName) {
4019 if (mService != null) {
4020 try {
4021 mService.clearPackagePersistentPreferredActivities(admin, packageName);
4022 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004023 throw e.rethrowFromSystemServer();
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004024 }
4025 }
4026 }
Robin Lee66e5d962014-04-09 16:44:21 +01004027
4028 /**
Esteban Talaverabf60f722015-12-10 16:26:44 +00004029 * Called by a profile owner or device owner to grant permission to a package to manage
4030 * application restrictions for the calling user via {@link #setApplicationRestrictions} and
4031 * {@link #getApplicationRestrictions}.
4032 * <p>
4033 * This permission is persistent until it is later cleared by calling this method with a
4034 * {@code null} value or uninstalling the managing package.
Rubin Xuf03d0a62016-02-10 14:54:15 +00004035 * <p>
4036 * The supplied application restriction managing package must be installed when calling this
Victor Changcd14c0a2016-03-16 19:10:15 +00004037 * API, otherwise an {@link NameNotFoundException} will be thrown.
Esteban Talaverabf60f722015-12-10 16:26:44 +00004038 *
4039 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4040 * @param packageName The package name which will be given access to application restrictions
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004041 * APIs. If {@code null} is given the current package will be cleared.
4042 * @throws SecurityException if {@code admin} is not a device or profile owner.
Victor Changcd14c0a2016-03-16 19:10:15 +00004043 * @throws NameNotFoundException if {@code packageName} is not found
Esteban Talaverabf60f722015-12-10 16:26:44 +00004044 */
4045 public void setApplicationRestrictionsManagingPackage(@NonNull ComponentName admin,
Victor Changcd14c0a2016-03-16 19:10:15 +00004046 @Nullable String packageName) throws NameNotFoundException {
Esteban Talaverabf60f722015-12-10 16:26:44 +00004047 if (mService != null) {
4048 try {
Victor Changcd14c0a2016-03-16 19:10:15 +00004049 if (!mService.setApplicationRestrictionsManagingPackage(admin, packageName)) {
4050 throw new NameNotFoundException(packageName);
4051 }
Esteban Talaverabf60f722015-12-10 16:26:44 +00004052 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004053 throw e.rethrowFromSystemServer();
Esteban Talaverabf60f722015-12-10 16:26:44 +00004054 }
4055 }
4056 }
4057
4058 /**
4059 * Called by a profile owner or device owner to retrieve the application restrictions managing
4060 * package for the current user, or {@code null} if none is set.
4061 *
4062 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4063 * @return The package name allowed to manage application restrictions on the current user, or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004064 * {@code null} if none is set.
4065 * @throws SecurityException if {@code admin} is not a device or profile owner.
Esteban Talaverabf60f722015-12-10 16:26:44 +00004066 */
4067 public String getApplicationRestrictionsManagingPackage(@NonNull ComponentName admin) {
4068 if (mService != null) {
4069 try {
4070 return mService.getApplicationRestrictionsManagingPackage(admin);
4071 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004072 throw e.rethrowFromSystemServer();
Esteban Talaverabf60f722015-12-10 16:26:44 +00004073 }
4074 }
4075 return null;
4076 }
4077
4078 /**
Esteban Talavera96895ca2016-03-16 12:00:40 +00004079 * Called by any application to find out whether it has been granted permission via
4080 * {@link #setApplicationRestrictionsManagingPackage} to manage application restrictions
4081 * for the calling user.
4082 *
4083 * <p>This is done by comparing the calling Linux uid with the uid of the package specified by
4084 * that method.
Esteban Talaverabf60f722015-12-10 16:26:44 +00004085 */
4086 public boolean isCallerApplicationRestrictionsManagingPackage() {
4087 if (mService != null) {
4088 try {
4089 return mService.isCallerApplicationRestrictionsManagingPackage();
4090 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004091 throw e.rethrowFromSystemServer();
Esteban Talaverabf60f722015-12-10 16:26:44 +00004092 }
4093 }
4094 return false;
4095 }
4096
4097 /**
4098 * Sets the application restrictions for a given target application running in the calling user.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004099 * <p>
4100 * The caller must be a profile or device owner on that user, or the package allowed to manage
4101 * application restrictions via {@link #setApplicationRestrictionsManagingPackage}; otherwise a
4102 * security exception will be thrown.
4103 * <p>
4104 * The provided {@link Bundle} consists of key-value pairs, where the types of values may be:
Esteban Talavera6b8e0642015-08-10 17:26:04 +01004105 * <ul>
4106 * <li>{@code boolean}
4107 * <li>{@code int}
4108 * <li>{@code String} or {@code String[]}
4109 * <li>From {@link android.os.Build.VERSION_CODES#M}, {@code Bundle} or {@code Bundle[]}
4110 * </ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004111 * <p>
4112 * If the restrictions are not available yet, but may be applied in the near future, the caller
4113 * can notify the target application of that by adding
Sander Alewijnse53d63dc2014-11-07 21:43:00 +00004114 * {@link UserManager#KEY_RESTRICTIONS_PENDING} to the settings parameter.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004115 * <p>
4116 * The application restrictions are only made visible to the target application via
4117 * {@link UserManager#getApplicationRestrictions(String)}, in addition to the profile or device
4118 * owner, and the application restrictions managing package via
Esteban Talaverabf60f722015-12-10 16:26:44 +00004119 * {@link #getApplicationRestrictions}.
Robin Lee66e5d962014-04-09 16:44:21 +01004120 *
Esteban Talaverabf60f722015-12-10 16:26:44 +00004121 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004122 * {@code null} if called by the application restrictions managing package.
Robin Lee66e5d962014-04-09 16:44:21 +01004123 * @param packageName The name of the package to update restricted settings for.
4124 * @param settings A {@link Bundle} to be parsed by the receiving application, conveying a new
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004125 * set of active restrictions.
4126 * @throws SecurityException if {@code admin} is not a device or profile owner.
Esteban Talaverabf60f722015-12-10 16:26:44 +00004127 * @see #setApplicationRestrictionsManagingPackage
Sander Alewijnse53d63dc2014-11-07 21:43:00 +00004128 * @see UserManager#KEY_RESTRICTIONS_PENDING
Robin Lee66e5d962014-04-09 16:44:21 +01004129 */
Esteban Talaverabf60f722015-12-10 16:26:44 +00004130 public void setApplicationRestrictions(@Nullable ComponentName admin, String packageName,
Robin Lee66e5d962014-04-09 16:44:21 +01004131 Bundle settings) {
4132 if (mService != null) {
4133 try {
4134 mService.setApplicationRestrictions(admin, packageName, settings);
4135 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004136 throw e.rethrowFromSystemServer();
Robin Lee66e5d962014-04-09 16:44:21 +01004137 }
4138 }
4139 }
4140
4141 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004142 * Sets a list of configuration features to enable for a TrustAgent component. This is meant to
4143 * be used in conjunction with {@link #KEYGUARD_DISABLE_TRUST_AGENTS}, which disables all trust
4144 * agents but those enabled by this function call. If flag
Jim Millere303bf42014-08-26 17:12:29 -07004145 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} is not set, then this call has no effect.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004146 * <p>
4147 * The calling device admin must have requested
4148 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES} to be able to call this method;
4149 * if not, a security exception will be thrown.
Jim Miller604e7552014-07-18 19:00:02 -07004150 *
4151 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Jim Millere303bf42014-08-26 17:12:29 -07004152 * @param target Component name of the agent to be enabled.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004153 * @param configuration TrustAgent-specific feature bundle. If null for any admin, agent will be
4154 * strictly disabled according to the state of the
4155 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} flag.
4156 * <p>
4157 * If {@link #KEYGUARD_DISABLE_TRUST_AGENTS} is set and options is not null for all
4158 * admins, then it's up to the TrustAgent itself to aggregate the values from all
4159 * device admins.
4160 * <p>
4161 * Consult documentation for the specific TrustAgent to determine legal options
4162 * parameters.
4163 * @throws SecurityException if {@code admin} is not an active administrator or does not use
4164 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES}
Jim Miller604e7552014-07-18 19:00:02 -07004165 */
Robin Lee25e26452015-06-02 09:56:29 -07004166 public void setTrustAgentConfiguration(@NonNull ComponentName admin,
4167 @NonNull ComponentName target, PersistableBundle configuration) {
Jim Miller604e7552014-07-18 19:00:02 -07004168 if (mService != null) {
4169 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08004170 mService.setTrustAgentConfiguration(admin, target, configuration);
Jim Miller604e7552014-07-18 19:00:02 -07004171 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004172 throw e.rethrowFromSystemServer();
Jim Miller604e7552014-07-18 19:00:02 -07004173 }
4174 }
4175 }
4176
4177 /**
Jim Millere303bf42014-08-26 17:12:29 -07004178 * Gets configuration for the given trust agent based on aggregating all calls to
4179 * {@link #setTrustAgentConfiguration(ComponentName, ComponentName, PersistableBundle)} for
4180 * all device admins.
Jim Miller604e7552014-07-18 19:00:02 -07004181 *
Jim Millerb5db57a2015-01-14 18:17:19 -08004182 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. If null,
4183 * this function returns a list of configurations for all admins that declare
4184 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS}. If any admin declares
4185 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} but doesn't call
4186 * {@link #setTrustAgentConfiguration(ComponentName, ComponentName, PersistableBundle)}
4187 * for this {@param agent} or calls it with a null configuration, null is returned.
Jim Miller604e7552014-07-18 19:00:02 -07004188 * @param agent Which component to get enabled features for.
Jim Millere303bf42014-08-26 17:12:29 -07004189 * @return configuration for the given trust agent.
Jim Miller604e7552014-07-18 19:00:02 -07004190 */
Robin Lee25e26452015-06-02 09:56:29 -07004191 public List<PersistableBundle> getTrustAgentConfiguration(@Nullable ComponentName admin,
4192 @NonNull ComponentName agent) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07004193 return getTrustAgentConfiguration(admin, agent, myUserId());
Jim Millere303bf42014-08-26 17:12:29 -07004194 }
4195
4196 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07004197 public List<PersistableBundle> getTrustAgentConfiguration(@Nullable ComponentName admin,
4198 @NonNull ComponentName agent, int userHandle) {
Jim Miller604e7552014-07-18 19:00:02 -07004199 if (mService != null) {
4200 try {
Jim Millere303bf42014-08-26 17:12:29 -07004201 return mService.getTrustAgentConfiguration(admin, agent, userHandle);
Jim Miller604e7552014-07-18 19:00:02 -07004202 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004203 throw e.rethrowFromSystemServer();
Jim Miller604e7552014-07-18 19:00:02 -07004204 }
4205 }
Jim Millere303bf42014-08-26 17:12:29 -07004206 return new ArrayList<PersistableBundle>(); // empty list
Jim Miller604e7552014-07-18 19:00:02 -07004207 }
4208
4209 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004210 * Called by a profile owner of a managed profile to set whether caller-Id information from the
4211 * managed profile will be shown in the parent profile, for incoming calls.
4212 * <p>
4213 * The calling device admin must be a profile owner. If it is not, a security exception will be
4214 * thrown.
Adam Connors210fe212014-07-17 15:41:43 +01004215 *
Robin Lee25e26452015-06-02 09:56:29 -07004216 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Adam Connors210fe212014-07-17 15:41:43 +01004217 * @param disabled If true caller-Id information in the managed profile is not displayed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004218 * @throws SecurityException if {@code admin} is not a device or profile owner.
Adam Connors210fe212014-07-17 15:41:43 +01004219 */
Robin Lee25e26452015-06-02 09:56:29 -07004220 public void setCrossProfileCallerIdDisabled(@NonNull ComponentName admin, boolean disabled) {
Adam Connors210fe212014-07-17 15:41:43 +01004221 if (mService != null) {
4222 try {
Robin Lee25e26452015-06-02 09:56:29 -07004223 mService.setCrossProfileCallerIdDisabled(admin, disabled);
Adam Connors210fe212014-07-17 15:41:43 +01004224 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004225 throw e.rethrowFromSystemServer();
Adam Connors210fe212014-07-17 15:41:43 +01004226 }
4227 }
4228 }
4229
4230 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07004231 * Called by a profile owner of a managed profile to determine whether or not caller-Id
4232 * information has been disabled.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004233 * <p>
4234 * The calling device admin must be a profile owner. If it is not, a security exception will be
4235 * thrown.
Adam Connors210fe212014-07-17 15:41:43 +01004236 *
Robin Lee25e26452015-06-02 09:56:29 -07004237 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004238 * @throws SecurityException if {@code admin} is not a device or profile owner.
Adam Connors210fe212014-07-17 15:41:43 +01004239 */
Robin Lee25e26452015-06-02 09:56:29 -07004240 public boolean getCrossProfileCallerIdDisabled(@NonNull ComponentName admin) {
Adam Connors210fe212014-07-17 15:41:43 +01004241 if (mService != null) {
4242 try {
Robin Lee25e26452015-06-02 09:56:29 -07004243 return mService.getCrossProfileCallerIdDisabled(admin);
Adam Connors210fe212014-07-17 15:41:43 +01004244 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004245 throw e.rethrowFromSystemServer();
Adam Connors210fe212014-07-17 15:41:43 +01004246 }
4247 }
4248 return false;
4249 }
4250
4251 /**
Amith Yamasani570002f2014-07-18 15:48:54 -07004252 * Determine whether or not caller-Id information has been disabled.
4253 *
4254 * @param userHandle The user for whom to check the caller-id permission
4255 * @hide
4256 */
4257 public boolean getCrossProfileCallerIdDisabled(UserHandle userHandle) {
4258 if (mService != null) {
4259 try {
4260 return mService.getCrossProfileCallerIdDisabledForUser(userHandle.getIdentifier());
4261 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004262 throw e.rethrowFromSystemServer();
Amith Yamasani570002f2014-07-18 15:48:54 -07004263 }
4264 }
4265 return false;
4266 }
4267
4268 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004269 * Called by a profile owner of a managed profile to set whether contacts search from the
4270 * managed profile will be shown in the parent profile, for incoming calls.
4271 * <p>
4272 * The calling device admin must be a profile owner. If it is not, a security exception will be
4273 * thrown.
Victor Chang1060c6182016-01-04 20:16:23 +00004274 *
4275 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4276 * @param disabled If true contacts search in the managed profile is not displayed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004277 * @throws SecurityException if {@code admin} is not a device or profile owner.
Victor Chang1060c6182016-01-04 20:16:23 +00004278 */
4279 public void setCrossProfileContactsSearchDisabled(@NonNull ComponentName admin,
4280 boolean disabled) {
4281 if (mService != null) {
4282 try {
4283 mService.setCrossProfileContactsSearchDisabled(admin, disabled);
4284 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004285 throw e.rethrowFromSystemServer();
Victor Chang1060c6182016-01-04 20:16:23 +00004286 }
4287 }
4288 }
4289
4290 /**
4291 * Called by a profile owner of a managed profile to determine whether or not contacts search
4292 * has been disabled.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004293 * <p>
4294 * The calling device admin must be a profile owner. If it is not, a security exception will be
4295 * thrown.
Victor Chang1060c6182016-01-04 20:16:23 +00004296 *
4297 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004298 * @throws SecurityException if {@code admin} is not a device or profile owner.
Victor Chang1060c6182016-01-04 20:16:23 +00004299 */
4300 public boolean getCrossProfileContactsSearchDisabled(@NonNull ComponentName admin) {
4301 if (mService != null) {
4302 try {
4303 return mService.getCrossProfileContactsSearchDisabled(admin);
4304 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004305 throw e.rethrowFromSystemServer();
Victor Chang1060c6182016-01-04 20:16:23 +00004306 }
4307 }
4308 return false;
4309 }
4310
4311
4312 /**
4313 * Determine whether or not contacts search has been disabled.
4314 *
4315 * @param userHandle The user for whom to check the contacts search permission
4316 * @hide
4317 */
4318 public boolean getCrossProfileContactsSearchDisabled(@NonNull UserHandle userHandle) {
4319 if (mService != null) {
4320 try {
4321 return mService
4322 .getCrossProfileContactsSearchDisabledForUser(userHandle.getIdentifier());
4323 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004324 throw e.rethrowFromSystemServer();
Victor Chang1060c6182016-01-04 20:16:23 +00004325 }
4326 }
4327 return false;
4328 }
4329
4330 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08004331 * Start Quick Contact on the managed profile for the user, if the policy allows.
Victor Chang97bdacc2016-01-21 22:24:11 +00004332 *
Makoto Onuki1040da12015-03-19 11:24:00 -07004333 * @hide
4334 */
4335 public void startManagedQuickContact(String actualLookupKey, long actualContactId,
Victor Chang97bdacc2016-01-21 22:24:11 +00004336 boolean isContactIdIgnored, long directoryId, Intent originalIntent) {
Makoto Onuki1040da12015-03-19 11:24:00 -07004337 if (mService != null) {
4338 try {
Victor Chang97bdacc2016-01-21 22:24:11 +00004339 mService.startManagedQuickContact(actualLookupKey, actualContactId,
4340 isContactIdIgnored, directoryId, originalIntent);
Makoto Onuki1040da12015-03-19 11:24:00 -07004341 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004342 throw e.rethrowFromSystemServer();
Makoto Onuki1040da12015-03-19 11:24:00 -07004343 }
4344 }
4345 }
4346
4347 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08004348 * Start Quick Contact on the managed profile for the user, if the policy allows.
Ricky Wai494b95d2015-11-20 16:07:15 +00004349 * @hide
4350 */
4351 public void startManagedQuickContact(String actualLookupKey, long actualContactId,
4352 Intent originalIntent) {
Victor Chang97bdacc2016-01-21 22:24:11 +00004353 startManagedQuickContact(actualLookupKey, actualContactId, false, Directory.DEFAULT,
Ricky Wai494b95d2015-11-20 16:07:15 +00004354 originalIntent);
4355 }
4356
4357 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004358 * Called by a profile owner of a managed profile to set whether bluetooth devices can access
4359 * enterprise contacts.
Ricky Wai778ba132015-03-31 14:21:22 +01004360 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004361 * The calling device admin must be a profile owner. If it is not, a security exception will be
4362 * thrown.
Ricky Wai778ba132015-03-31 14:21:22 +01004363 * <p>
4364 * This API works on managed profile only.
4365 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004366 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4367 * @param disabled If true, bluetooth devices cannot access enterprise contacts.
4368 * @throws SecurityException if {@code admin} is not a device or profile owner.
Ricky Wai778ba132015-03-31 14:21:22 +01004369 */
Robin Lee25e26452015-06-02 09:56:29 -07004370 public void setBluetoothContactSharingDisabled(@NonNull ComponentName admin, boolean disabled) {
Ricky Wai778ba132015-03-31 14:21:22 +01004371 if (mService != null) {
4372 try {
Robin Lee25e26452015-06-02 09:56:29 -07004373 mService.setBluetoothContactSharingDisabled(admin, disabled);
Ricky Wai778ba132015-03-31 14:21:22 +01004374 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004375 throw e.rethrowFromSystemServer();
Ricky Wai778ba132015-03-31 14:21:22 +01004376 }
4377 }
4378 }
4379
4380 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004381 * Called by a profile owner of a managed profile to determine whether or not Bluetooth devices
4382 * cannot access enterprise contacts.
Ricky Wai778ba132015-03-31 14:21:22 +01004383 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004384 * The calling device admin must be a profile owner. If it is not, a security exception will be
4385 * thrown.
Ricky Wai778ba132015-03-31 14:21:22 +01004386 * <p>
4387 * This API works on managed profile only.
4388 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004389 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4390 * @throws SecurityException if {@code admin} is not a device or profile owner.
Ricky Wai778ba132015-03-31 14:21:22 +01004391 */
Robin Lee25e26452015-06-02 09:56:29 -07004392 public boolean getBluetoothContactSharingDisabled(@NonNull ComponentName admin) {
Ricky Wai778ba132015-03-31 14:21:22 +01004393 if (mService != null) {
4394 try {
Robin Lee25e26452015-06-02 09:56:29 -07004395 return mService.getBluetoothContactSharingDisabled(admin);
Ricky Wai778ba132015-03-31 14:21:22 +01004396 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004397 throw e.rethrowFromSystemServer();
Ricky Wai778ba132015-03-31 14:21:22 +01004398 }
4399 }
4400 return true;
4401 }
4402
4403 /**
4404 * Determine whether or not Bluetooth devices cannot access contacts.
4405 * <p>
4406 * This API works on managed profile UserHandle only.
4407 *
4408 * @param userHandle The user for whom to check the caller-id permission
4409 * @hide
4410 */
4411 public boolean getBluetoothContactSharingDisabled(UserHandle userHandle) {
4412 if (mService != null) {
4413 try {
4414 return mService.getBluetoothContactSharingDisabledForUser(userHandle
4415 .getIdentifier());
4416 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004417 throw e.rethrowFromSystemServer();
Ricky Wai778ba132015-03-31 14:21:22 +01004418 }
4419 }
4420 return true;
4421 }
4422
4423 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07004424 * Called by the profile owner of a managed profile so that some intents sent in the managed
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004425 * profile can also be resolved in the parent, or vice versa. Only activity intents are
4426 * supported.
Nicolas Prevotfc7b4442014-12-17 15:28:29 +00004427 *
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004428 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Nicolas Prevot81948992014-05-16 18:25:26 +01004429 * @param filter The {@link IntentFilter} the intent has to match to be also resolved in the
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004430 * other profile
Nicolas Prevot41d926e2014-06-09 11:48:56 +01004431 * @param flags {@link DevicePolicyManager#FLAG_MANAGED_CAN_ACCESS_PARENT} and
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004432 * {@link DevicePolicyManager#FLAG_PARENT_CAN_ACCESS_MANAGED} are supported.
4433 * @throws SecurityException if {@code admin} is not a device or profile owner.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004434 */
Robin Lee25e26452015-06-02 09:56:29 -07004435 public void addCrossProfileIntentFilter(@NonNull ComponentName admin, IntentFilter filter, int flags) {
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004436 if (mService != null) {
4437 try {
Nicolas Prevot81948992014-05-16 18:25:26 +01004438 mService.addCrossProfileIntentFilter(admin, filter, flags);
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004439 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004440 throw e.rethrowFromSystemServer();
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004441 }
4442 }
4443 }
4444
4445 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07004446 * Called by a profile owner of a managed profile to remove the cross-profile intent filters
4447 * that go from the managed profile to the parent, or from the parent to the managed profile.
Nicolas Prevot3f7777f2014-07-24 15:58:39 +01004448 * Only removes those that have been set by the profile owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004449 *
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004450 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004451 * @throws SecurityException if {@code admin} is not a device or profile owner.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004452 */
Robin Lee25e26452015-06-02 09:56:29 -07004453 public void clearCrossProfileIntentFilters(@NonNull ComponentName admin) {
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004454 if (mService != null) {
4455 try {
Nicolas Prevot81948992014-05-16 18:25:26 +01004456 mService.clearCrossProfileIntentFilters(admin);
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004457 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004458 throw e.rethrowFromSystemServer();
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004459 }
4460 }
4461 }
4462
4463 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004464 * Called by a profile or device owner to set the permitted accessibility services. When set by
4465 * a device owner or profile owner the restriction applies to all profiles of the user the
4466 * device owner or profile owner is an admin for. By default the user can use any accessiblity
4467 * service. When zero or more packages have been added, accessiblity services that are not in
4468 * the list and not part of the system can not be enabled by the user.
4469 * <p>
4470 * Calling with a null value for the list disables the restriction so that all services can be
4471 * used, calling with an empty list only allows the builtin system's services.
4472 * <p>
4473 * System accesibility services are always available to the user the list can't modify this.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004474 *
4475 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4476 * @param packageNames List of accessibility service package names.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004477 * @return true if setting the restriction succeeded. It fail if there is one or more non-system
4478 * accessibility services enabled, that are not in the list.
4479 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004480 */
Robin Lee25e26452015-06-02 09:56:29 -07004481 public boolean setPermittedAccessibilityServices(@NonNull ComponentName admin,
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004482 List<String> packageNames) {
4483 if (mService != null) {
4484 try {
4485 return mService.setPermittedAccessibilityServices(admin, packageNames);
4486 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004487 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004488 }
4489 }
4490 return false;
4491 }
4492
4493 /**
4494 * Returns the list of permitted accessibility services set by this device or profile owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004495 * <p>
4496 * An empty list means no accessibility services except system services are allowed. Null means
4497 * all accessibility services are allowed.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004498 *
4499 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4500 * @return List of accessiblity service package names.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004501 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004502 */
Robin Lee25e26452015-06-02 09:56:29 -07004503 public List<String> getPermittedAccessibilityServices(@NonNull ComponentName admin) {
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004504 if (mService != null) {
4505 try {
4506 return mService.getPermittedAccessibilityServices(admin);
4507 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004508 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004509 }
4510 }
4511 return null;
4512 }
4513
4514 /**
Sudheer Shanka56925862016-01-28 19:43:59 +00004515 * Called by the system to check if a specific accessibility service is disabled by admin.
4516 *
4517 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4518 * @param packageName Accessibility service package name that needs to be checked.
4519 * @param userHandle user id the admin is running as.
4520 * @return true if the accessibility service is permitted, otherwise false.
4521 *
4522 * @hide
4523 */
4524 public boolean isAccessibilityServicePermittedByAdmin(@NonNull ComponentName admin,
4525 @NonNull String packageName, int userHandle) {
4526 if (mService != null) {
4527 try {
4528 return mService.isAccessibilityServicePermittedByAdmin(admin, packageName,
4529 userHandle);
4530 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004531 throw e.rethrowFromSystemServer();
Sudheer Shanka56925862016-01-28 19:43:59 +00004532 }
4533 }
4534 return false;
4535 }
4536
4537 /**
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004538 * Returns the list of accessibility services permitted by the device or profiles
4539 * owners of this user.
4540 *
4541 * <p>Null means all accessibility services are allowed, if a non-null list is returned
4542 * it will contain the intersection of the permitted lists for any device or profile
4543 * owners that apply to this user. It will also include any system accessibility services.
4544 *
4545 * @param userId which user to check for.
4546 * @return List of accessiblity service package names.
4547 * @hide
4548 */
4549 @SystemApi
4550 public List<String> getPermittedAccessibilityServices(int userId) {
4551 if (mService != null) {
4552 try {
4553 return mService.getPermittedAccessibilityServicesForUser(userId);
4554 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004555 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004556 }
4557 }
4558 return null;
4559 }
4560
4561 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004562 * Called by a profile or device owner to set the permitted input methods services. When set by
4563 * a device owner or profile owner the restriction applies to all profiles of the user the
4564 * device owner or profile owner is an admin for. By default the user can use any input method.
4565 * When zero or more packages have been added, input method that are not in the list and not
4566 * part of the system can not be enabled by the user. This method will fail if it is called for
4567 * a admin that is not for the foreground user or a profile of the foreground user.
4568 * <p>
4569 * Calling with a null value for the list disables the restriction so that all input methods can
4570 * be used, calling with an empty list disables all but the system's own input methods.
4571 * <p>
4572 * System input methods are always available to the user this method can't modify this.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004573 *
4574 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4575 * @param packageNames List of input method package names.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004576 * @return true if setting the restriction succeeded. It will fail if there are one or more
4577 * non-system input methods currently enabled that are not in the packageNames list.
4578 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004579 */
Robin Lee25e26452015-06-02 09:56:29 -07004580 public boolean setPermittedInputMethods(@NonNull ComponentName admin, List<String> packageNames) {
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004581 if (mService != null) {
4582 try {
4583 return mService.setPermittedInputMethods(admin, packageNames);
4584 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004585 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004586 }
4587 }
4588 return false;
4589 }
4590
4591
4592 /**
4593 * Returns the list of permitted input methods set by this device or profile owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004594 * <p>
4595 * An empty list means no input methods except system input methods are allowed. Null means all
4596 * input methods are allowed.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004597 *
4598 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4599 * @return List of input method package names.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004600 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004601 */
Robin Lee25e26452015-06-02 09:56:29 -07004602 public List<String> getPermittedInputMethods(@NonNull ComponentName admin) {
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004603 if (mService != null) {
4604 try {
4605 return mService.getPermittedInputMethods(admin);
4606 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004607 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004608 }
4609 }
4610 return null;
4611 }
4612
4613 /**
Sudheer Shanka56925862016-01-28 19:43:59 +00004614 * Called by the system to check if a specific input method is disabled by admin.
4615 *
4616 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4617 * @param packageName Input method package name that needs to be checked.
4618 * @param userHandle user id the admin is running as.
4619 * @return true if the input method is permitted, otherwise false.
4620 *
4621 * @hide
4622 */
4623 public boolean isInputMethodPermittedByAdmin(@NonNull ComponentName admin,
4624 @NonNull String packageName, int userHandle) {
4625 if (mService != null) {
4626 try {
4627 return mService.isInputMethodPermittedByAdmin(admin, packageName, userHandle);
4628 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004629 throw e.rethrowFromSystemServer();
Sudheer Shanka56925862016-01-28 19:43:59 +00004630 }
4631 }
4632 return false;
4633 }
4634
4635 /**
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004636 * Returns the list of input methods permitted by the device or profiles
Makoto Onuki32b30572015-12-11 14:29:51 -08004637 * owners of the current user. (*Not* calling user, due to a limitation in InputMethodManager.)
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004638 *
4639 * <p>Null means all input methods are allowed, if a non-null list is returned
4640 * it will contain the intersection of the permitted lists for any device or profile
4641 * owners that apply to this user. It will also include any system input methods.
4642 *
4643 * @return List of input method package names.
4644 * @hide
4645 */
4646 @SystemApi
4647 public List<String> getPermittedInputMethodsForCurrentUser() {
4648 if (mService != null) {
4649 try {
4650 return mService.getPermittedInputMethodsForCurrentUser();
4651 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004652 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004653 }
4654 }
4655 return null;
4656 }
4657
4658 /**
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08004659 * Called by a device owner to get the list of apps to keep around as APKs even if no user has
4660 * currently installed it.
4661 *
4662 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4663 *
4664 * @return List of package names to keep cached.
4665 * @hide
4666 */
4667 public List<String> getKeepUninstalledPackages(@NonNull ComponentName admin) {
4668 if (mService != null) {
4669 try {
4670 return mService.getKeepUninstalledPackages(admin);
4671 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004672 throw e.rethrowFromSystemServer();
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08004673 }
4674 }
4675 return null;
4676 }
4677
4678 /**
4679 * Called by a device owner to set a list of apps to keep around as APKs even if no user has
4680 * currently installed it.
4681 *
4682 * <p>Please note that setting this policy does not imply that specified apps will be
4683 * automatically pre-cached.</p>
4684 *
4685 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4686 * @param packageNames List of package names to keep cached.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004687 * @throws SecurityException if {@code admin} is not a device owner.
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08004688 * @hide
4689 */
4690 public void setKeepUninstalledPackages(@NonNull ComponentName admin,
4691 @NonNull List<String> packageNames) {
4692 if (mService != null) {
4693 try {
4694 mService.setKeepUninstalledPackages(admin, packageNames);
4695 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004696 throw e.rethrowFromSystemServer();
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08004697 }
4698 }
4699 }
4700
4701 /**
Julia Reynolds1e958392014-05-16 14:25:21 -04004702 * Called by a device owner to create a user with the specified name. The UserHandle returned
4703 * by this method should not be persisted as user handles are recycled as users are removed and
4704 * created. If you need to persist an identifier for this user, use
4705 * {@link UserManager#getSerialNumberForUser}.
4706 *
4707 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4708 * @param name the user's name
4709 * @see UserHandle
Robin Lee25e26452015-06-02 09:56:29 -07004710 * @return the {@link android.os.UserHandle} object for the created user, or {@code null} if the
4711 * user could not be created.
Kenny Guy14f48e52015-06-29 15:12:36 +01004712 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07004713 * @deprecated From {@link android.os.Build.VERSION_CODES#M}
phweiss27ee3342016-02-08 16:40:45 +01004714 * @removed From {@link android.os.Build.VERSION_CODES#N}
Julia Reynolds1e958392014-05-16 14:25:21 -04004715 */
Kenny Guy14f48e52015-06-29 15:12:36 +01004716 @Deprecated
Robin Lee25e26452015-06-02 09:56:29 -07004717 public UserHandle createUser(@NonNull ComponentName admin, String name) {
Julia Reynolds1e958392014-05-16 14:25:21 -04004718 return null;
4719 }
4720
4721 /**
Jason Monk03978a42014-06-10 15:05:30 -04004722 * Called by a device owner to create a user with the specified name. The UserHandle returned
4723 * by this method should not be persisted as user handles are recycled as users are removed and
4724 * created. If you need to persist an identifier for this user, use
4725 * {@link UserManager#getSerialNumberForUser}. The new user will be started in the background
4726 * immediately.
4727 *
4728 * <p> profileOwnerComponent is the {@link DeviceAdminReceiver} to be the profile owner as well
4729 * as registered as an active admin on the new user. The profile owner package will be
4730 * installed on the new user if it already is installed on the device.
4731 *
4732 * <p>If the optionalInitializeData is not null, then the extras will be passed to the
4733 * profileOwnerComponent when onEnable is called.
4734 *
4735 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4736 * @param name the user's name
4737 * @param ownerName the human readable name of the organisation associated with this DPM.
4738 * @param profileOwnerComponent The {@link DeviceAdminReceiver} that will be an active admin on
4739 * the user.
4740 * @param adminExtras Extras that will be passed to onEnable of the admin receiver
4741 * on the new user.
4742 * @see UserHandle
Robin Lee25e26452015-06-02 09:56:29 -07004743 * @return the {@link android.os.UserHandle} object for the created user, or {@code null} if the
4744 * user could not be created.
Kenny Guy14f48e52015-06-29 15:12:36 +01004745 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07004746 * @deprecated From {@link android.os.Build.VERSION_CODES#M}
phweiss27ee3342016-02-08 16:40:45 +01004747 * @removed From {@link android.os.Build.VERSION_CODES#N}
Jason Monk03978a42014-06-10 15:05:30 -04004748 */
Kenny Guy14f48e52015-06-29 15:12:36 +01004749 @Deprecated
Robin Lee25e26452015-06-02 09:56:29 -07004750 public UserHandle createAndInitializeUser(@NonNull ComponentName admin, String name,
4751 String ownerName, @NonNull ComponentName profileOwnerComponent, Bundle adminExtras) {
Jason Monk03978a42014-06-10 15:05:30 -04004752 return null;
4753 }
4754
4755 /**
phweissa92e1212016-01-25 17:14:10 +01004756 * Flag used by {@link #createAndManageUser} to skip setup wizard after creating a new user.
phweiss343fb332016-01-25 14:48:59 +01004757 */
4758 public static final int SKIP_SETUP_WIZARD = 0x0001;
4759
4760 /**
Lenka Trochtovac8202c82016-01-26 15:11:09 +01004761 * Flag used by {@link #createAndManageUser} to specify that the user should be created
4762 * ephemeral.
4763 * @hide
4764 */
4765 public static final int MAKE_USER_EPHEMERAL = 0x0002;
4766
4767 /**
phweissa92e1212016-01-25 17:14:10 +01004768 * Called by a device owner to create a user with the specified name and a given component of
4769 * the calling package as profile owner. The UserHandle returned by this method should not be
4770 * persisted as user handles are recycled as users are removed and created. If you need to
4771 * persist an identifier for this user, use {@link UserManager#getSerialNumberForUser}. The new
4772 * user will not be started in the background.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004773 * <p>
4774 * admin is the {@link DeviceAdminReceiver} which is the device owner. profileOwner is also a
4775 * DeviceAdminReceiver in the same package as admin, and will become the profile owner and will
4776 * be registered as an active admin on the new user. The profile owner package will be installed
4777 * on the new user.
4778 * <p>
4779 * If the adminExtras are not null, they will be stored on the device until the user is started
4780 * for the first time. Then the extras will be passed to the admin when onEnable is called.
phweiss343fb332016-01-25 14:48:59 +01004781 *
4782 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4783 * @param name The user's name.
phweissa92e1212016-01-25 17:14:10 +01004784 * @param profileOwner Which {@link DeviceAdminReceiver} will be profile owner. Has to be in the
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004785 * same package as admin, otherwise no user is created and an
4786 * IllegalArgumentException is thrown.
phweiss343fb332016-01-25 14:48:59 +01004787 * @param adminExtras Extras that will be passed to onEnable of the admin receiver on the new
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004788 * user.
phweissa92e1212016-01-25 17:14:10 +01004789 * @param flags {@link #SKIP_SETUP_WIZARD} is supported.
phweiss343fb332016-01-25 14:48:59 +01004790 * @see UserHandle
4791 * @return the {@link android.os.UserHandle} object for the created user, or {@code null} if the
4792 * user could not be created.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004793 * @throws SecurityException if {@code admin} is not a device owner.
phweiss343fb332016-01-25 14:48:59 +01004794 */
4795 public UserHandle createAndManageUser(@NonNull ComponentName admin, @NonNull String name,
phweissa92e1212016-01-25 17:14:10 +01004796 @NonNull ComponentName profileOwner, @Nullable PersistableBundle adminExtras,
4797 int flags) {
phweiss343fb332016-01-25 14:48:59 +01004798 try {
phweissa92e1212016-01-25 17:14:10 +01004799 return mService.createAndManageUser(admin, name, profileOwner, adminExtras, flags);
phweiss343fb332016-01-25 14:48:59 +01004800 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004801 throw re.rethrowFromSystemServer();
phweiss343fb332016-01-25 14:48:59 +01004802 }
phweiss343fb332016-01-25 14:48:59 +01004803 }
4804
4805 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004806 * Called by a device owner to remove a user and all associated data. The primary user can not
4807 * be removed.
Julia Reynolds1e958392014-05-16 14:25:21 -04004808 *
4809 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4810 * @param userHandle the user to remove.
4811 * @return {@code true} if the user was removed, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004812 * @throws SecurityException if {@code admin} is not a device owner.
Julia Reynolds1e958392014-05-16 14:25:21 -04004813 */
Robin Lee25e26452015-06-02 09:56:29 -07004814 public boolean removeUser(@NonNull ComponentName admin, UserHandle userHandle) {
Julia Reynolds1e958392014-05-16 14:25:21 -04004815 try {
4816 return mService.removeUser(admin, userHandle);
4817 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004818 throw re.rethrowFromSystemServer();
Julia Reynolds1e958392014-05-16 14:25:21 -04004819 }
4820 }
4821
4822 /**
Jason Monk582d9112014-07-09 19:57:08 -04004823 * Called by a device owner to switch the specified user to the foreground.
4824 *
4825 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4826 * @param userHandle the user to switch to; null will switch to primary.
4827 * @return {@code true} if the switch was successful, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004828 * @throws SecurityException if {@code admin} is not a device owner.
Jason Monk582d9112014-07-09 19:57:08 -04004829 * @see Intent#ACTION_USER_FOREGROUND
4830 */
Robin Lee25e26452015-06-02 09:56:29 -07004831 public boolean switchUser(@NonNull ComponentName admin, @Nullable UserHandle userHandle) {
Jason Monk582d9112014-07-09 19:57:08 -04004832 try {
4833 return mService.switchUser(admin, userHandle);
4834 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004835 throw re.rethrowFromSystemServer();
Jason Monk582d9112014-07-09 19:57:08 -04004836 }
4837 }
4838
4839 /**
Esteban Talaverabf60f722015-12-10 16:26:44 +00004840 * Retrieves the application restrictions for a given target application running in the calling
4841 * user.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004842 * <p>
4843 * The caller must be a profile or device owner on that user, or the package allowed to manage
4844 * application restrictions via {@link #setApplicationRestrictionsManagingPackage}; otherwise a
4845 * security exception will be thrown.
Robin Lee66e5d962014-04-09 16:44:21 +01004846 *
Esteban Talaverabf60f722015-12-10 16:26:44 +00004847 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004848 * {@code null} if called by the application restrictions managing package.
Robin Lee66e5d962014-04-09 16:44:21 +01004849 * @param packageName The name of the package to fetch restricted settings of.
4850 * @return {@link Bundle} of settings corresponding to what was set last time
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004851 * {@link DevicePolicyManager#setApplicationRestrictions} was called, or an empty
4852 * {@link Bundle} if no restrictions have been set.
4853 * @throws SecurityException if {@code admin} is not a device or profile owner.
Esteban Talaverabf60f722015-12-10 16:26:44 +00004854 * @see {@link #setApplicationRestrictionsManagingPackage}
Robin Lee66e5d962014-04-09 16:44:21 +01004855 */
Esteban Talaverabf60f722015-12-10 16:26:44 +00004856 public Bundle getApplicationRestrictions(@Nullable ComponentName admin, String packageName) {
Robin Lee66e5d962014-04-09 16:44:21 +01004857 if (mService != null) {
4858 try {
4859 return mService.getApplicationRestrictions(admin, packageName);
4860 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004861 throw e.rethrowFromSystemServer();
Robin Lee66e5d962014-04-09 16:44:21 +01004862 }
4863 }
4864 return null;
4865 }
Amith Yamasanibe465322014-04-24 13:45:17 -07004866
4867 /**
Julia Reynolds20118f12015-02-11 12:34:08 -05004868 * Called by a profile or device owner to set a user restriction specified by the key.
Amith Yamasanibe465322014-04-24 13:45:17 -07004869 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004870 * The calling device admin must be a profile or device owner; if it is not, a security
4871 * exception will be thrown.
Jim Millerdf2258b2014-04-27 20:10:26 -07004872 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004873 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4874 * @param key The key of the restriction. See the constants in {@link android.os.UserManager}
4875 * for the list of keys.
4876 * @throws SecurityException if {@code admin} is not a device or profile owner.
Amith Yamasanibe465322014-04-24 13:45:17 -07004877 */
Robin Lee25e26452015-06-02 09:56:29 -07004878 public void addUserRestriction(@NonNull ComponentName admin, String key) {
Amith Yamasanibe465322014-04-24 13:45:17 -07004879 if (mService != null) {
4880 try {
4881 mService.setUserRestriction(admin, key, true);
4882 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004883 throw e.rethrowFromSystemServer();
Amith Yamasanibe465322014-04-24 13:45:17 -07004884 }
4885 }
4886 }
4887
4888 /**
Julia Reynolds20118f12015-02-11 12:34:08 -05004889 * Called by a profile or device owner to clear a user restriction specified by the key.
Amith Yamasanibe465322014-04-24 13:45:17 -07004890 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004891 * The calling device admin must be a profile or device owner; if it is not, a security
4892 * exception will be thrown.
Jim Millerdf2258b2014-04-27 20:10:26 -07004893 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004894 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4895 * @param key The key of the restriction. See the constants in {@link android.os.UserManager}
4896 * for the list of keys.
4897 * @throws SecurityException if {@code admin} is not a device or profile owner.
Amith Yamasanibe465322014-04-24 13:45:17 -07004898 */
Robin Lee25e26452015-06-02 09:56:29 -07004899 public void clearUserRestriction(@NonNull ComponentName admin, String key) {
Amith Yamasanibe465322014-04-24 13:45:17 -07004900 if (mService != null) {
4901 try {
4902 mService.setUserRestriction(admin, key, false);
4903 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004904 throw e.rethrowFromSystemServer();
Amith Yamasanibe465322014-04-24 13:45:17 -07004905 }
4906 }
4907 }
Adam Connors010cfd42014-04-16 12:48:13 +01004908
4909 /**
Makoto Onuki3a3092f2015-10-30 11:07:51 -07004910 * Called by a profile or device owner to get user restrictions set with
4911 * {@link #addUserRestriction(ComponentName, String)}.
4912 * <p>
4913 * The target user may have more restrictions set by the system or other device owner / profile
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004914 * owner. To get all the user restrictions currently set, use
Makoto Onuki3a3092f2015-10-30 11:07:51 -07004915 * {@link UserManager#getUserRestrictions()}.
4916 *
4917 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004918 * @throws SecurityException if {@code admin} is not a device or profile owner.
Makoto Onuki3a3092f2015-10-30 11:07:51 -07004919 */
4920 public Bundle getUserRestrictions(@NonNull ComponentName admin) {
Sudheer Shanka1c277a52015-11-11 21:58:24 +00004921 return getUserRestrictions(admin, myUserId());
4922 }
4923
4924 /** @hide per-user version */
4925 public Bundle getUserRestrictions(@NonNull ComponentName admin, int userHandle) {
Makoto Onuki3a3092f2015-10-30 11:07:51 -07004926 Bundle ret = null;
4927 if (mService != null) {
4928 try {
Sudheer Shanka1c277a52015-11-11 21:58:24 +00004929 ret = mService.getUserRestrictions(admin, userHandle);
Makoto Onuki3a3092f2015-10-30 11:07:51 -07004930 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004931 throw e.rethrowFromSystemServer();
Makoto Onuki3a3092f2015-10-30 11:07:51 -07004932 }
4933 }
4934 return ret == null ? new Bundle() : ret;
4935 }
4936
4937 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004938 * Called by profile or device owners to hide or unhide packages. When a package is hidden it is
4939 * unavailable for use, but the data and actual package file remain.
Julia Reynolds966881e2014-05-14 12:23:08 -04004940 *
4941 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Amith Yamasanie5bcff62014-07-19 15:44:09 -07004942 * @param packageName The name of the package to hide or unhide.
4943 * @param hidden {@code true} if the package should be hidden, {@code false} if it should be
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004944 * unhidden.
Amith Yamasanie5bcff62014-07-19 15:44:09 -07004945 * @return boolean Whether the hidden setting of the package was successfully updated.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004946 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynolds966881e2014-05-14 12:23:08 -04004947 */
Robin Lee25e26452015-06-02 09:56:29 -07004948 public boolean setApplicationHidden(@NonNull ComponentName admin, String packageName,
Amith Yamasanie5bcff62014-07-19 15:44:09 -07004949 boolean hidden) {
Julia Reynolds966881e2014-05-14 12:23:08 -04004950 if (mService != null) {
4951 try {
Amith Yamasanie5bcff62014-07-19 15:44:09 -07004952 return mService.setApplicationHidden(admin, packageName, hidden);
Julia Reynolds966881e2014-05-14 12:23:08 -04004953 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004954 throw e.rethrowFromSystemServer();
Julia Reynolds966881e2014-05-14 12:23:08 -04004955 }
4956 }
4957 return false;
4958 }
4959
4960 /**
Julia Reynolds20118f12015-02-11 12:34:08 -05004961 * Called by profile or device owners to determine if a package is hidden.
Julia Reynolds966881e2014-05-14 12:23:08 -04004962 *
4963 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Amith Yamasanie5bcff62014-07-19 15:44:09 -07004964 * @param packageName The name of the package to retrieve the hidden status of.
4965 * @return boolean {@code true} if the package is hidden, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004966 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynolds966881e2014-05-14 12:23:08 -04004967 */
Robin Lee25e26452015-06-02 09:56:29 -07004968 public boolean isApplicationHidden(@NonNull ComponentName admin, String packageName) {
Julia Reynolds966881e2014-05-14 12:23:08 -04004969 if (mService != null) {
4970 try {
Amith Yamasanie5bcff62014-07-19 15:44:09 -07004971 return mService.isApplicationHidden(admin, packageName);
Julia Reynolds966881e2014-05-14 12:23:08 -04004972 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004973 throw e.rethrowFromSystemServer();
Julia Reynolds966881e2014-05-14 12:23:08 -04004974 }
4975 }
4976 return false;
4977 }
4978
4979 /**
Julia Reynolds20118f12015-02-11 12:34:08 -05004980 * Called by profile or device owners to re-enable a system app that was disabled by default
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07004981 * when the user was initialized.
Adam Connors655be2a2014-07-14 09:01:25 +00004982 *
4983 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Makoto Onuki32b30572015-12-11 14:29:51 -08004984 * @param packageName The package to be re-enabled in the calling profile.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004985 * @throws SecurityException if {@code admin} is not a device or profile owner.
Adam Connors655be2a2014-07-14 09:01:25 +00004986 */
Robin Lee25e26452015-06-02 09:56:29 -07004987 public void enableSystemApp(@NonNull ComponentName admin, String packageName) {
Adam Connors655be2a2014-07-14 09:01:25 +00004988 if (mService != null) {
4989 try {
4990 mService.enableSystemApp(admin, packageName);
4991 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004992 throw e.rethrowFromSystemServer();
Adam Connors655be2a2014-07-14 09:01:25 +00004993 }
4994 }
4995 }
4996
4997 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004998 * Called by profile or device owners to re-enable system apps by intent that were disabled by
4999 * default when the user was initialized.
Adam Connors655be2a2014-07-14 09:01:25 +00005000 *
5001 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5002 * @param intent An intent matching the app(s) to be installed. All apps that resolve for this
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005003 * intent will be re-enabled in the calling profile.
Adam Connors655be2a2014-07-14 09:01:25 +00005004 * @return int The number of activities that matched the intent and were installed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005005 * @throws SecurityException if {@code admin} is not a device or profile owner.
Adam Connors655be2a2014-07-14 09:01:25 +00005006 */
Robin Lee25e26452015-06-02 09:56:29 -07005007 public int enableSystemApp(@NonNull ComponentName admin, Intent intent) {
Adam Connors655be2a2014-07-14 09:01:25 +00005008 if (mService != null) {
5009 try {
5010 return mService.enableSystemAppWithIntent(admin, intent);
5011 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005012 throw e.rethrowFromSystemServer();
Adam Connors655be2a2014-07-14 09:01:25 +00005013 }
5014 }
5015 return 0;
5016 }
5017
5018 /**
Sander Alewijnse112e0532014-10-29 13:28:49 +00005019 * Called by a device owner or profile owner to disable account management for a specific type
5020 * of account.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005021 * <p>
5022 * The calling device admin must be a device owner or profile owner. If it is not, a security
5023 * exception will be thrown.
5024 * <p>
5025 * When account management is disabled for an account type, adding or removing an account of
5026 * that type will not be possible.
5027 * <p>
5028 * From {@link android.os.Build.VERSION_CODES#N} the profile or device owner can still use
Benjamin Franzb6c0ce42015-11-05 10:06:51 +00005029 * {@link android.accounts.AccountManager} APIs to add or remove accounts when account
5030 * management for a specific type is disabled.
5031 *
Sander Alewijnse650c3342014-05-08 18:00:50 +01005032 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5033 * @param accountType For which account management is disabled or enabled.
5034 * @param disabled The boolean indicating that account management will be disabled (true) or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005035 * enabled (false).
5036 * @throws SecurityException if {@code admin} is not a device or profile owner.
Sander Alewijnse650c3342014-05-08 18:00:50 +01005037 */
Robin Lee25e26452015-06-02 09:56:29 -07005038 public void setAccountManagementDisabled(@NonNull ComponentName admin, String accountType,
Sander Alewijnse650c3342014-05-08 18:00:50 +01005039 boolean disabled) {
5040 if (mService != null) {
5041 try {
5042 mService.setAccountManagementDisabled(admin, accountType, disabled);
5043 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005044 throw e.rethrowFromSystemServer();
Sander Alewijnse650c3342014-05-08 18:00:50 +01005045 }
5046 }
5047 }
5048
5049 /**
Sander Alewijnse5c02db62014-05-07 10:46:57 +01005050 * Gets the array of accounts for which account management is disabled by the profile owner.
5051 *
5052 * <p> Account management can be disabled/enabled by calling
5053 * {@link #setAccountManagementDisabled}.
5054 *
5055 * @return a list of account types for which account management has been disabled.
5056 *
5057 * @see #setAccountManagementDisabled
5058 */
5059 public String[] getAccountTypesWithManagementDisabled() {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07005060 return getAccountTypesWithManagementDisabledAsUser(myUserId());
Alexandra Gherghina999d3942014-07-03 11:40:08 +01005061 }
5062
5063 /**
5064 * @see #getAccountTypesWithManagementDisabled()
5065 * @hide
5066 */
5067 public String[] getAccountTypesWithManagementDisabledAsUser(int userId) {
Sander Alewijnse5c02db62014-05-07 10:46:57 +01005068 if (mService != null) {
5069 try {
Alexandra Gherghina999d3942014-07-03 11:40:08 +01005070 return mService.getAccountTypesWithManagementDisabledAsUser(userId);
Sander Alewijnse5c02db62014-05-07 10:46:57 +01005071 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005072 throw e.rethrowFromSystemServer();
Sander Alewijnse5c02db62014-05-07 10:46:57 +01005073 }
5074 }
5075
5076 return null;
5077 }
justinzhang511e0d82014-03-24 16:09:24 -04005078
5079 /**
Jason Monkd7b86212014-06-16 13:15:38 -04005080 * Sets which packages may enter lock task mode.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005081 * <p>
5082 * Any packages that shares uid with an allowed package will also be allowed to activate lock
5083 * task. From {@link android.os.Build.VERSION_CODES#M} removing packages from the lock task
5084 * package list results in locked tasks belonging to those packages to be finished. This
5085 * function can only be called by the device owner.
Jason Monkd7b86212014-06-16 13:15:38 -04005086 *
Jason Monkd7b86212014-06-16 13:15:38 -04005087 * @param packages The list of packages allowed to enter lock task mode
Jason Monk48aacba2014-08-13 16:29:08 -04005088 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005089 * @throws SecurityException if {@code admin} is not a device owner.
Jason Monkd7b86212014-06-16 13:15:38 -04005090 * @see Activity#startLockTask()
Benjamin Franz6cdb27e2015-02-26 12:26:53 +00005091 * @see DeviceAdminReceiver#onLockTaskModeEntering(Context, Intent, String)
5092 * @see DeviceAdminReceiver#onLockTaskModeExiting(Context, Intent)
Jason Monk1c7c3192014-06-26 12:52:18 -04005093 * @see UserManager#DISALLOW_CREATE_WINDOWS
justinzhang511e0d82014-03-24 16:09:24 -04005094 */
Robin Lee25e26452015-06-02 09:56:29 -07005095 public void setLockTaskPackages(@NonNull ComponentName admin, String[] packages)
Jason Monk48aacba2014-08-13 16:29:08 -04005096 throws SecurityException {
justinzhang511e0d82014-03-24 16:09:24 -04005097 if (mService != null) {
5098 try {
Jason Monk48aacba2014-08-13 16:29:08 -04005099 mService.setLockTaskPackages(admin, packages);
justinzhang511e0d82014-03-24 16:09:24 -04005100 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005101 throw e.rethrowFromSystemServer();
justinzhang511e0d82014-03-24 16:09:24 -04005102 }
5103 }
5104 }
5105
5106 /**
Jason Monkd7b86212014-06-16 13:15:38 -04005107 * This function returns the list of packages allowed to start the lock task mode.
Jason Monk48aacba2014-08-13 16:29:08 -04005108 *
5109 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
justinzhang511e0d82014-03-24 16:09:24 -04005110 * @hide
5111 */
Robin Lee25e26452015-06-02 09:56:29 -07005112 public String[] getLockTaskPackages(@NonNull ComponentName admin) {
justinzhang511e0d82014-03-24 16:09:24 -04005113 if (mService != null) {
5114 try {
Jason Monk48aacba2014-08-13 16:29:08 -04005115 return mService.getLockTaskPackages(admin);
justinzhang511e0d82014-03-24 16:09:24 -04005116 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005117 throw e.rethrowFromSystemServer();
justinzhang511e0d82014-03-24 16:09:24 -04005118 }
5119 }
5120 return null;
5121 }
5122
5123 /**
5124 * This function lets the caller know whether the given component is allowed to start the
5125 * lock task mode.
Jason Monkd7b86212014-06-16 13:15:38 -04005126 * @param pkg The package to check
justinzhang511e0d82014-03-24 16:09:24 -04005127 */
Jason Monkd7b86212014-06-16 13:15:38 -04005128 public boolean isLockTaskPermitted(String pkg) {
justinzhang511e0d82014-03-24 16:09:24 -04005129 if (mService != null) {
5130 try {
Jason Monkd7b86212014-06-16 13:15:38 -04005131 return mService.isLockTaskPermitted(pkg);
justinzhang511e0d82014-03-24 16:09:24 -04005132 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005133 throw e.rethrowFromSystemServer();
justinzhang511e0d82014-03-24 16:09:24 -04005134 }
5135 }
5136 return false;
5137 }
Julia Reynoldsda551652014-05-14 17:15:16 -04005138
5139 /**
5140 * Called by device owners to update {@link Settings.Global} settings. Validation that the value
5141 * of the setting is in the correct form for the setting type should be performed by the caller.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005142 * <p>
5143 * The settings that can be updated with this method are:
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005144 * <ul>
5145 * <li>{@link Settings.Global#ADB_ENABLED}</li>
5146 * <li>{@link Settings.Global#AUTO_TIME}</li>
5147 * <li>{@link Settings.Global#AUTO_TIME_ZONE}</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005148 * <li>{@link Settings.Global#DATA_ROAMING}</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005149 * <li>{@link Settings.Global#USB_MASS_STORAGE_ENABLED}</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005150 * <li>{@link Settings.Global#WIFI_SLEEP_POLICY}</li>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005151 * <li>{@link Settings.Global#STAY_ON_WHILE_PLUGGED_IN} This setting is only available from
5152 * {@link android.os.Build.VERSION_CODES#M} onwards and can only be set if
5153 * {@link #setMaximumTimeToLock} is not used to set a timeout.</li>
5154 * <li>{@link Settings.Global#WIFI_DEVICE_OWNER_CONFIGS_LOCKDOWN}</li> This setting is only
5155 * available from {@link android.os.Build.VERSION_CODES#M} onwards.</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005156 * </ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005157 * <p>
5158 * Changing the following settings has no effect as of {@link android.os.Build.VERSION_CODES#M}:
Esteban Talavera656fa7f2015-06-29 17:41:39 +01005159 * <ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005160 * <li>{@link Settings.Global#BLUETOOTH_ON}. Use
5161 * {@link android.bluetooth.BluetoothAdapter#enable()} and
5162 * {@link android.bluetooth.BluetoothAdapter#disable()} instead.</li>
Esteban Talavera656fa7f2015-06-29 17:41:39 +01005163 * <li>{@link Settings.Global#DEVELOPMENT_SETTINGS_ENABLED}</li>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005164 * <li>{@link Settings.Global#MODE_RINGER}. Use
5165 * {@link android.media.AudioManager#setRingerMode(int)} instead.</li>
Esteban Talavera656fa7f2015-06-29 17:41:39 +01005166 * <li>{@link Settings.Global#NETWORK_PREFERENCE}</li>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005167 * <li>{@link Settings.Global#WIFI_ON}. Use
5168 * {@link android.net.wifi.WifiManager#setWifiEnabled(boolean)} instead.</li>
Esteban Talavera656fa7f2015-06-29 17:41:39 +01005169 * </ul>
Julia Reynoldsda551652014-05-14 17:15:16 -04005170 *
5171 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5172 * @param setting The name of the setting to update.
5173 * @param value The value to update the setting to.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005174 * @throws SecurityException if {@code admin} is not a device owner.
Julia Reynoldsda551652014-05-14 17:15:16 -04005175 */
Robin Lee25e26452015-06-02 09:56:29 -07005176 public void setGlobalSetting(@NonNull ComponentName admin, String setting, String value) {
Julia Reynoldsda551652014-05-14 17:15:16 -04005177 if (mService != null) {
5178 try {
5179 mService.setGlobalSetting(admin, setting, value);
5180 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005181 throw e.rethrowFromSystemServer();
Julia Reynoldsda551652014-05-14 17:15:16 -04005182 }
5183 }
5184 }
5185
5186 /**
5187 * Called by profile or device owners to update {@link Settings.Secure} settings. Validation
5188 * that the value of the setting is in the correct form for the setting type should be performed
5189 * by the caller.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005190 * <p>
5191 * The settings that can be updated by a profile or device owner with this method are:
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005192 * <ul>
5193 * <li>{@link Settings.Secure#DEFAULT_INPUT_METHOD}</li>
Amith Yamasani52c39a12014-10-21 11:14:04 -07005194 * <li>{@link Settings.Secure#INSTALL_NON_MARKET_APPS}</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005195 * <li>{@link Settings.Secure#SKIP_FIRST_USE_HINTS}</li>
5196 * </ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005197 * <p>
5198 * A device owner can additionally update the following settings:
Julia Reynolds82735bc2014-09-04 16:43:30 -04005199 * <ul>
5200 * <li>{@link Settings.Secure#LOCATION_MODE}</li>
5201 * </ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005202 *
Julia Reynoldsda551652014-05-14 17:15:16 -04005203 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5204 * @param setting The name of the setting to update.
5205 * @param value The value to update the setting to.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005206 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynoldsda551652014-05-14 17:15:16 -04005207 */
Robin Lee25e26452015-06-02 09:56:29 -07005208 public void setSecureSetting(@NonNull ComponentName admin, String setting, String value) {
Julia Reynoldsda551652014-05-14 17:15:16 -04005209 if (mService != null) {
5210 try {
5211 mService.setSecureSetting(admin, setting, value);
5212 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005213 throw e.rethrowFromSystemServer();
Julia Reynoldsda551652014-05-14 17:15:16 -04005214 }
5215 }
5216 }
5217
Amith Yamasanif20d6402014-05-24 15:34:37 -07005218 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005219 * Designates a specific service component as the provider for making permission requests of a
5220 * local or remote administrator of the user.
Amith Yamasanif20d6402014-05-24 15:34:37 -07005221 * <p/>
5222 * Only a profile owner can designate the restrictions provider.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005223 *
Amith Yamasanif20d6402014-05-24 15:34:37 -07005224 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Amith Yamasanif6e2fcc2014-07-10 13:41:55 -07005225 * @param provider The component name of the service that implements
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005226 * {@link RestrictionsReceiver}. If this param is null, it removes the restrictions
5227 * provider previously assigned.
5228 * @throws SecurityException if {@code admin} is not a device or profile owner.
Amith Yamasanif20d6402014-05-24 15:34:37 -07005229 */
Robin Lee25e26452015-06-02 09:56:29 -07005230 public void setRestrictionsProvider(@NonNull ComponentName admin,
5231 @Nullable ComponentName provider) {
Amith Yamasanif20d6402014-05-24 15:34:37 -07005232 if (mService != null) {
5233 try {
Amith Yamasanif6e2fcc2014-07-10 13:41:55 -07005234 mService.setRestrictionsProvider(admin, provider);
Amith Yamasanif20d6402014-05-24 15:34:37 -07005235 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005236 throw re.rethrowFromSystemServer();
Amith Yamasanif20d6402014-05-24 15:34:37 -07005237 }
5238 }
5239 }
Julia Reynolds4a21b252014-06-04 11:11:43 -04005240
5241 /**
5242 * Called by profile or device owners to set the master volume mute on or off.
5243 *
5244 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5245 * @param on {@code true} to mute master volume, {@code false} to turn mute off.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005246 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynolds4a21b252014-06-04 11:11:43 -04005247 */
Robin Lee25e26452015-06-02 09:56:29 -07005248 public void setMasterVolumeMuted(@NonNull ComponentName admin, boolean on) {
Julia Reynolds4a21b252014-06-04 11:11:43 -04005249 if (mService != null) {
5250 try {
5251 mService.setMasterVolumeMuted(admin, on);
5252 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005253 throw re.rethrowFromSystemServer();
Julia Reynolds4a21b252014-06-04 11:11:43 -04005254 }
5255 }
5256 }
5257
5258 /**
5259 * Called by profile or device owners to check whether the master volume mute is on or off.
5260 *
5261 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5262 * @return {@code true} if master volume is muted, {@code false} if it's not.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005263 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynolds4a21b252014-06-04 11:11:43 -04005264 */
Robin Lee25e26452015-06-02 09:56:29 -07005265 public boolean isMasterVolumeMuted(@NonNull ComponentName admin) {
Julia Reynolds4a21b252014-06-04 11:11:43 -04005266 if (mService != null) {
5267 try {
5268 return mService.isMasterVolumeMuted(admin);
5269 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005270 throw re.rethrowFromSystemServer();
Julia Reynolds4a21b252014-06-04 11:11:43 -04005271 }
5272 }
5273 return false;
5274 }
Kenny Guyc13053b2014-05-29 14:17:17 +01005275
5276 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005277 * Called by profile or device owners to change whether a user can uninstall a package.
Kenny Guyc13053b2014-05-29 14:17:17 +01005278 *
5279 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5280 * @param packageName package to change.
Esteban Talaverad5c5c132014-08-20 11:35:57 +01005281 * @param uninstallBlocked true if the user shouldn't be able to uninstall the package.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005282 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyc13053b2014-05-29 14:17:17 +01005283 */
Robin Lee25e26452015-06-02 09:56:29 -07005284 public void setUninstallBlocked(@NonNull ComponentName admin, String packageName,
Esteban Talaverad5c5c132014-08-20 11:35:57 +01005285 boolean uninstallBlocked) {
Kenny Guyc13053b2014-05-29 14:17:17 +01005286 if (mService != null) {
5287 try {
Esteban Talaverad5c5c132014-08-20 11:35:57 +01005288 mService.setUninstallBlocked(admin, packageName, uninstallBlocked);
Kenny Guyc13053b2014-05-29 14:17:17 +01005289 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005290 throw re.rethrowFromSystemServer();
Kenny Guyc13053b2014-05-29 14:17:17 +01005291 }
5292 }
5293 }
5294
5295 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08005296 * Check whether the user has been blocked by device policy from uninstalling a package.
Rubin Xua97855b2014-11-07 05:41:00 +00005297 * Requires the caller to be the profile owner if checking a specific admin's policy.
Rubin Xue1e6faa2015-03-10 10:51:59 +00005298 * <p>
5299 * <strong>Note:</strong> Starting from {@link android.os.Build.VERSION_CODES#LOLLIPOP_MR1}, the
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005300 * behavior of this API is changed such that passing {@code null} as the {@code admin} parameter
5301 * will return if any admin has blocked the uninstallation. Before L MR1, passing {@code null}
5302 * will cause a NullPointerException to be raised.
Kenny Guyc13053b2014-05-29 14:17:17 +01005303 *
Robin Lee25e26452015-06-02 09:56:29 -07005304 * @param admin The name of the admin component whose blocking policy will be checked, or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005305 * {@code null} to check whether any admin has blocked the uninstallation.
Kenny Guyc13053b2014-05-29 14:17:17 +01005306 * @param packageName package to check.
Rubin Xua97855b2014-11-07 05:41:00 +00005307 * @return true if uninstallation is blocked.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005308 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyc13053b2014-05-29 14:17:17 +01005309 */
Robin Lee25e26452015-06-02 09:56:29 -07005310 public boolean isUninstallBlocked(@Nullable ComponentName admin, String packageName) {
Kenny Guyc13053b2014-05-29 14:17:17 +01005311 if (mService != null) {
5312 try {
Esteban Talavera729b2a62014-08-27 18:01:58 +01005313 return mService.isUninstallBlocked(admin, packageName);
Kenny Guyc13053b2014-05-29 14:17:17 +01005314 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005315 throw re.rethrowFromSystemServer();
Kenny Guyc13053b2014-05-29 14:17:17 +01005316 }
5317 }
5318 return false;
5319 }
Svetoslav976e8bd2014-07-16 15:12:03 -07005320
5321 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005322 * Called by the profile owner of a managed profile to enable widget providers from a given
5323 * package to be available in the parent profile. As a result the user will be able to add
5324 * widgets from the white-listed package running under the profile to a widget host which runs
5325 * under the parent profile, for example the home screen. Note that a package may have zero or
5326 * more provider components, where each component provides a different widget type.
Svetoslav976e8bd2014-07-16 15:12:03 -07005327 * <p>
5328 * <strong>Note:</strong> By default no widget provider package is white-listed.
Svetoslav976e8bd2014-07-16 15:12:03 -07005329 *
5330 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5331 * @param packageName The package from which widget providers are white-listed.
5332 * @return Whether the package was added.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005333 * @throws SecurityException if {@code admin} is not a profile owner.
Svetoslav976e8bd2014-07-16 15:12:03 -07005334 * @see #removeCrossProfileWidgetProvider(android.content.ComponentName, String)
5335 * @see #getCrossProfileWidgetProviders(android.content.ComponentName)
5336 */
Robin Lee25e26452015-06-02 09:56:29 -07005337 public boolean addCrossProfileWidgetProvider(@NonNull ComponentName admin, String packageName) {
Svetoslav976e8bd2014-07-16 15:12:03 -07005338 if (mService != null) {
5339 try {
5340 return mService.addCrossProfileWidgetProvider(admin, packageName);
5341 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005342 throw re.rethrowFromSystemServer();
Svetoslav976e8bd2014-07-16 15:12:03 -07005343 }
5344 }
5345 return false;
5346 }
5347
5348 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07005349 * Called by the profile owner of a managed profile to disable widget providers from a given
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005350 * package to be available in the parent profile. For this method to take effect the package
5351 * should have been added via
5352 * {@link #addCrossProfileWidgetProvider( android.content.ComponentName, String)}.
Svetoslav976e8bd2014-07-16 15:12:03 -07005353 * <p>
5354 * <strong>Note:</strong> By default no widget provider package is white-listed.
Svetoslav976e8bd2014-07-16 15:12:03 -07005355 *
5356 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005357 * @param packageName The package from which widget providers are no longer white-listed.
Svetoslav976e8bd2014-07-16 15:12:03 -07005358 * @return Whether the package was removed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005359 * @throws SecurityException if {@code admin} is not a profile owner.
Svetoslav976e8bd2014-07-16 15:12:03 -07005360 * @see #addCrossProfileWidgetProvider(android.content.ComponentName, String)
5361 * @see #getCrossProfileWidgetProviders(android.content.ComponentName)
5362 */
Esteban Talavera62399912016-01-11 15:37:55 +00005363 public boolean removeCrossProfileWidgetProvider(
5364 @NonNull ComponentName admin, String packageName) {
Svetoslav976e8bd2014-07-16 15:12:03 -07005365 if (mService != null) {
5366 try {
5367 return mService.removeCrossProfileWidgetProvider(admin, packageName);
5368 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005369 throw re.rethrowFromSystemServer();
Svetoslav976e8bd2014-07-16 15:12:03 -07005370 }
5371 }
5372 return false;
5373 }
5374
5375 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07005376 * Called by the profile owner of a managed profile to query providers from which packages are
Svetoslav976e8bd2014-07-16 15:12:03 -07005377 * available in the parent profile.
5378 *
5379 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5380 * @return The white-listed package list.
Svetoslav976e8bd2014-07-16 15:12:03 -07005381 * @see #addCrossProfileWidgetProvider(android.content.ComponentName, String)
5382 * @see #removeCrossProfileWidgetProvider(android.content.ComponentName, String)
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005383 * @throws SecurityException if {@code admin} is not a profile owner.
Svetoslav976e8bd2014-07-16 15:12:03 -07005384 */
Robin Lee25e26452015-06-02 09:56:29 -07005385 public List<String> getCrossProfileWidgetProviders(@NonNull ComponentName admin) {
Svetoslav976e8bd2014-07-16 15:12:03 -07005386 if (mService != null) {
5387 try {
5388 List<String> providers = mService.getCrossProfileWidgetProviders(admin);
5389 if (providers != null) {
5390 return providers;
5391 }
5392 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005393 throw re.rethrowFromSystemServer();
Svetoslav976e8bd2014-07-16 15:12:03 -07005394 }
5395 }
5396 return Collections.emptyList();
5397 }
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05005398
5399 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08005400 * Called by profile or device owners to set the user's photo.
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05005401 *
5402 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5403 * @param icon the bitmap to set as the photo.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005404 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05005405 */
Robin Lee25e26452015-06-02 09:56:29 -07005406 public void setUserIcon(@NonNull ComponentName admin, Bitmap icon) {
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05005407 try {
5408 mService.setUserIcon(admin, icon);
5409 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005410 throw re.rethrowFromSystemServer();
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05005411 }
5412 }
Craig Lafayettedbe31a62015-04-02 13:14:39 -04005413
5414 /**
Rubin Xu5faad8e2015-04-20 17:43:48 +01005415 * Called by device owners to set a local system update policy. When a new policy is set,
5416 * {@link #ACTION_SYSTEM_UPDATE_POLICY_CHANGED} is broadcasted.
Rubin Xu8027a4f2015-03-10 17:52:37 +00005417 *
Robin Lee25e26452015-06-02 09:56:29 -07005418 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. All
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005419 * components in the device owner package can set system update policies and the most
5420 * recent policy takes effect.
Robin Lee25e26452015-06-02 09:56:29 -07005421 * @param policy the new policy, or {@code null} to clear the current policy.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005422 * @throws SecurityException if {@code admin} is not a device owner.
Rubin Xu5faad8e2015-04-20 17:43:48 +01005423 * @see SystemUpdatePolicy
Rubin Xu8027a4f2015-03-10 17:52:37 +00005424 */
Robin Lee25e26452015-06-02 09:56:29 -07005425 public void setSystemUpdatePolicy(@NonNull ComponentName admin, SystemUpdatePolicy policy) {
Rubin Xu8027a4f2015-03-10 17:52:37 +00005426 if (mService != null) {
5427 try {
Robin Lee25e26452015-06-02 09:56:29 -07005428 mService.setSystemUpdatePolicy(admin, policy);
Rubin Xu8027a4f2015-03-10 17:52:37 +00005429 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005430 throw re.rethrowFromSystemServer();
Rubin Xu8027a4f2015-03-10 17:52:37 +00005431 }
5432 }
5433 }
5434
5435 /**
Rubin Xu5faad8e2015-04-20 17:43:48 +01005436 * Retrieve a local system update policy set previously by {@link #setSystemUpdatePolicy}.
Rubin Xu8027a4f2015-03-10 17:52:37 +00005437 *
Robin Lee25e26452015-06-02 09:56:29 -07005438 * @return The current policy object, or {@code null} if no policy is set.
Rubin Xu8027a4f2015-03-10 17:52:37 +00005439 */
Rubin Xu5faad8e2015-04-20 17:43:48 +01005440 public SystemUpdatePolicy getSystemUpdatePolicy() {
Rubin Xu8027a4f2015-03-10 17:52:37 +00005441 if (mService != null) {
5442 try {
Rubin Xud86d58c2015-05-05 16:57:37 +01005443 return mService.getSystemUpdatePolicy();
Rubin Xu8027a4f2015-03-10 17:52:37 +00005444 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005445 throw re.rethrowFromSystemServer();
Rubin Xu8027a4f2015-03-10 17:52:37 +00005446 }
5447 }
5448 return null;
5449 }
Benjamin Franze36087e2015-04-07 16:40:34 +01005450
5451 /**
5452 * Called by a device owner to disable the keyguard altogether.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005453 * <p>
5454 * Setting the keyguard to disabled has the same effect as choosing "None" as the screen lock
5455 * type. However, this call has no effect if a password, pin or pattern is currently set. If a
5456 * password, pin or pattern is set after the keyguard was disabled, the keyguard stops being
5457 * disabled.
Benjamin Franze36087e2015-04-07 16:40:34 +01005458 *
5459 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Benjamin Franzbece8062015-05-06 12:14:31 +01005460 * @param disabled {@code true} disables the keyguard, {@code false} reenables it.
Benjamin Franze36087e2015-04-07 16:40:34 +01005461 * @return {@code false} if attempting to disable the keyguard while a lock password was in
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005462 * place. {@code true} otherwise.
5463 * @throws SecurityException if {@code admin} is not a device owner.
Benjamin Franze36087e2015-04-07 16:40:34 +01005464 */
Robin Lee25e26452015-06-02 09:56:29 -07005465 public boolean setKeyguardDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franze36087e2015-04-07 16:40:34 +01005466 try {
Benjamin Franzbece8062015-05-06 12:14:31 +01005467 return mService.setKeyguardDisabled(admin, disabled);
Benjamin Franze36087e2015-04-07 16:40:34 +01005468 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005469 throw re.rethrowFromSystemServer();
Benjamin Franze36087e2015-04-07 16:40:34 +01005470 }
5471 }
Benjamin Franzea2ec972015-03-16 17:18:09 +00005472
5473 /**
Benjamin Franzbece8062015-05-06 12:14:31 +01005474 * Called by device owner to disable the status bar. Disabling the status bar blocks
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005475 * notifications, quick settings and other screen overlays that allow escaping from a single use
5476 * device.
Benjamin Franzea2ec972015-03-16 17:18:09 +00005477 *
5478 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Benjamin Franzbece8062015-05-06 12:14:31 +01005479 * @param disabled {@code true} disables the status bar, {@code false} reenables it.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005480 * @return {@code false} if attempting to disable the status bar failed. {@code true} otherwise.
5481 * @throws SecurityException if {@code admin} is not a device owner.
Benjamin Franzea2ec972015-03-16 17:18:09 +00005482 */
Robin Lee25e26452015-06-02 09:56:29 -07005483 public boolean setStatusBarDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzea2ec972015-03-16 17:18:09 +00005484 try {
Benjamin Franzbece8062015-05-06 12:14:31 +01005485 return mService.setStatusBarDisabled(admin, disabled);
Benjamin Franzea2ec972015-03-16 17:18:09 +00005486 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005487 throw re.rethrowFromSystemServer();
Benjamin Franzea2ec972015-03-16 17:18:09 +00005488 }
5489 }
Rubin Xudc105cc2015-04-14 23:38:01 +01005490
5491 /**
5492 * Callable by the system update service to notify device owners about pending updates.
5493 * The caller must hold {@link android.Manifest.permission#NOTIFY_PENDING_SYSTEM_UPDATE}
5494 * permission.
5495 *
5496 * @param updateReceivedTime The time as given by {@link System#currentTimeMillis()} indicating
5497 * when the current pending update was first available. -1 if no update is available.
5498 * @hide
5499 */
5500 @SystemApi
5501 public void notifyPendingSystemUpdate(long updateReceivedTime) {
5502 if (mService != null) {
5503 try {
5504 mService.notifyPendingSystemUpdate(updateReceivedTime);
5505 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005506 throw re.rethrowFromSystemServer();
Rubin Xudc105cc2015-04-14 23:38:01 +01005507 }
5508 }
5509 }
Julia Reynolds13c58ba2015-04-20 16:42:54 -04005510
5511 /**
Amith Yamasanid49489b2015-04-28 14:00:26 -07005512 * Called by profile or device owners to set the default response for future runtime permission
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005513 * requests by applications. The policy can allow for normal operation which prompts the user to
5514 * grant a permission, or can allow automatic granting or denying of runtime permission requests
5515 * by an application. This also applies to new permissions declared by app updates. When a
5516 * permission is denied or granted this way, the effect is equivalent to setting the permission
5517 * grant state via {@link #setPermissionGrantState}.
5518 * <p/>
5519 * As this policy only acts on runtime permission requests, it only applies to applications
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07005520 * built with a {@code targetSdkVersion} of {@link android.os.Build.VERSION_CODES#M} or later.
Benjamin Franz45dd6662015-07-08 14:24:14 +01005521 *
Amith Yamasanid49489b2015-04-28 14:00:26 -07005522 * @param admin Which profile or device owner this request is associated with.
5523 * @param policy One of the policy constants {@link #PERMISSION_POLICY_PROMPT},
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005524 * {@link #PERMISSION_POLICY_AUTO_GRANT} and {@link #PERMISSION_POLICY_AUTO_DENY}.
5525 * @throws SecurityException if {@code admin} is not a device or profile owner.
Benjamin Franz45dd6662015-07-08 14:24:14 +01005526 * @see #setPermissionGrantState
Amith Yamasanid49489b2015-04-28 14:00:26 -07005527 */
Robin Lee25e26452015-06-02 09:56:29 -07005528 public void setPermissionPolicy(@NonNull ComponentName admin, int policy) {
Amith Yamasanid49489b2015-04-28 14:00:26 -07005529 try {
5530 mService.setPermissionPolicy(admin, policy);
5531 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005532 throw re.rethrowFromSystemServer();
Amith Yamasanid49489b2015-04-28 14:00:26 -07005533 }
5534 }
5535
5536 /**
5537 * Returns the current runtime permission policy set by the device or profile owner. The
5538 * default is {@link #PERMISSION_POLICY_PROMPT}.
5539 * @param admin Which profile or device owner this request is associated with.
5540 * @return the current policy for future permission requests.
5541 */
Esteban Talavera28b95702015-06-24 15:23:42 +01005542 public int getPermissionPolicy(ComponentName admin) {
Amith Yamasanid49489b2015-04-28 14:00:26 -07005543 try {
5544 return mService.getPermissionPolicy(admin);
5545 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005546 throw re.rethrowFromSystemServer();
Amith Yamasanid49489b2015-04-28 14:00:26 -07005547 }
5548 }
5549
5550 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005551 * Sets the grant state of a runtime permission for a specific application. The state can be
5552 * {@link #PERMISSION_GRANT_STATE_DEFAULT default} in which a user can manage it through the UI,
5553 * {@link #PERMISSION_GRANT_STATE_DENIED denied}, in which the permission is denied and the user
5554 * cannot manage it through the UI, and {@link #PERMISSION_GRANT_STATE_GRANTED granted} in which
5555 * the permission is granted and the user cannot manage it through the UI. This might affect all
5556 * permissions in a group that the runtime permission belongs to. This method can only be called
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07005557 * by a profile or device owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005558 * <p/>
5559 * Setting the grant state to {@link #PERMISSION_GRANT_STATE_DEFAULT default} does not revoke
5560 * the permission. It retains the previous grant, if any.
5561 * <p/>
5562 * Permissions can be granted or revoked only for applications built with a
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07005563 * {@code targetSdkVersion} of {@link android.os.Build.VERSION_CODES#M} or later.
Amith Yamasani0bf8f7c2015-06-22 13:00:32 -07005564 *
Amith Yamasanid49489b2015-04-28 14:00:26 -07005565 * @param admin Which profile or device owner this request is associated with.
5566 * @param packageName The application to grant or revoke a permission to.
5567 * @param permission The permission to grant or revoke.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005568 * @param grantState The permission grant state which is one of
5569 * {@link #PERMISSION_GRANT_STATE_DENIED}, {@link #PERMISSION_GRANT_STATE_DEFAULT},
5570 * {@link #PERMISSION_GRANT_STATE_GRANTED},
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07005571 * @return whether the permission was successfully granted or revoked.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005572 * @throws SecurityException if {@code admin} is not a device or profile owner.
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07005573 * @see #PERMISSION_GRANT_STATE_DENIED
5574 * @see #PERMISSION_GRANT_STATE_DEFAULT
5575 * @see #PERMISSION_GRANT_STATE_GRANTED
Amith Yamasanid49489b2015-04-28 14:00:26 -07005576 */
Robin Lee25e26452015-06-02 09:56:29 -07005577 public boolean setPermissionGrantState(@NonNull ComponentName admin, String packageName,
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07005578 String permission, int grantState) {
Amith Yamasanid49489b2015-04-28 14:00:26 -07005579 try {
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07005580 return mService.setPermissionGrantState(admin, packageName, permission, grantState);
Amith Yamasanid49489b2015-04-28 14:00:26 -07005581 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005582 throw re.rethrowFromSystemServer();
Amith Yamasanid49489b2015-04-28 14:00:26 -07005583 }
5584 }
Amith Yamasani184b3752015-05-22 13:00:51 -07005585
5586 /**
5587 * Returns the current grant state of a runtime permission for a specific application.
5588 *
5589 * @param admin Which profile or device owner this request is associated with.
5590 * @param packageName The application to check the grant state for.
5591 * @param permission The permission to check for.
5592 * @return the current grant state specified by device policy. If the profile or device owner
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005593 * has not set a grant state, the return value is
5594 * {@link #PERMISSION_GRANT_STATE_DEFAULT}. This does not indicate whether or not the
5595 * permission is currently granted for the package.
5596 * <p/>
5597 * If a grant state was set by the profile or device owner, then the return value will
5598 * be one of {@link #PERMISSION_GRANT_STATE_DENIED} or
5599 * {@link #PERMISSION_GRANT_STATE_GRANTED}, which indicates if the permission is
5600 * currently denied or granted.
5601 * @throws SecurityException if {@code admin} is not a device or profile owner.
Amith Yamasani184b3752015-05-22 13:00:51 -07005602 * @see #setPermissionGrantState(ComponentName, String, String, int)
5603 * @see PackageManager#checkPermission(String, String)
5604 */
Robin Lee25e26452015-06-02 09:56:29 -07005605 public int getPermissionGrantState(@NonNull ComponentName admin, String packageName,
Amith Yamasani184b3752015-05-22 13:00:51 -07005606 String permission) {
5607 try {
5608 return mService.getPermissionGrantState(admin, packageName, permission);
5609 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005610 throw re.rethrowFromSystemServer();
Amith Yamasani184b3752015-05-22 13:00:51 -07005611 }
5612 }
Nicolas Prevot07387fe2015-10-30 17:53:30 +00005613
5614 /**
5615 * Returns if provisioning a managed profile or device is possible or not.
5616 * @param action One of {@link #ACTION_PROVISION_MANAGED_DEVICE},
5617 * {@link #ACTION_PROVISION_MANAGED_PROFILE}.
Nicolas Prevot07387fe2015-10-30 17:53:30 +00005618 * @return if provisioning a managed profile or device is possible or not.
5619 * @throws IllegalArgumentException if the supplied action is not valid.
5620 */
5621 public boolean isProvisioningAllowed(String action) {
5622 try {
5623 return mService.isProvisioningAllowed(action);
5624 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005625 throw re.rethrowFromSystemServer();
Nicolas Prevot07387fe2015-10-30 17:53:30 +00005626 }
5627 }
Mahaver Chopra15a46b02015-11-11 14:54:35 +00005628
5629 /**
5630 * @hide
5631 * Return if this user is a managed profile of another user. An admin can become the profile
5632 * owner of a managed profile with {@link #ACTION_PROVISION_MANAGED_PROFILE} and of a managed
5633 * user with {@link #ACTION_PROVISION_MANAGED_USER}.
5634 * @param admin Which profile owner this request is associated with.
5635 * @return if this user is a managed profile of another user.
5636 */
5637 public boolean isManagedProfile(@NonNull ComponentName admin) {
5638 try {
5639 return mService.isManagedProfile(admin);
5640 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005641 throw re.rethrowFromSystemServer();
Mahaver Chopra15a46b02015-11-11 14:54:35 +00005642 }
5643 }
5644
5645 /**
5646 * @hide
5647 * Return if this user is a system-only user. An admin can manage a device from a system only
5648 * user by calling {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE}.
5649 * @param admin Which device owner this request is associated with.
5650 * @return if this user is a system-only user.
5651 */
5652 public boolean isSystemOnlyUser(@NonNull ComponentName admin) {
5653 try {
5654 return mService.isSystemOnlyUser(admin);
5655 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005656 throw re.rethrowFromSystemServer();
Mahaver Chopra15a46b02015-11-11 14:54:35 +00005657 }
5658 }
Makoto Onukia31ebbc2015-11-23 17:15:21 -08005659
5660 /**
5661 * Called by device owner to get the MAC address of the Wi-Fi device.
5662 *
Sudheer Shanka3cb4da12016-03-07 18:51:49 -08005663 * @param admin Which device owner this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005664 * @return the MAC address of the Wi-Fi device, or null when the information is not available.
5665 * (For example, Wi-Fi hasn't been enabled, or the device doesn't support Wi-Fi.)
5666 * <p>
5667 * The address will be in the {@code XX:XX:XX:XX:XX:XX} format.
5668 * @throws SecurityException if {@code admin} is not a device owner.
Makoto Onukia31ebbc2015-11-23 17:15:21 -08005669 */
Sudheer Shanka3cb4da12016-03-07 18:51:49 -08005670 public String getWifiMacAddress(@NonNull ComponentName admin) {
Makoto Onukia31ebbc2015-11-23 17:15:21 -08005671 try {
Sudheer Shanka3cb4da12016-03-07 18:51:49 -08005672 return mService.getWifiMacAddress(admin);
Makoto Onukia31ebbc2015-11-23 17:15:21 -08005673 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005674 throw re.rethrowFromSystemServer();
Makoto Onukia31ebbc2015-11-23 17:15:21 -08005675 }
5676 }
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +00005677
5678 /**
Mahaver Chopra1216ae52016-03-11 15:39:48 +00005679 * Called by device owner to reboot the device. If there is an ongoing call on the device,
5680 * throws an {@link IllegalStateException}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005681 * @param admin Which device owner the request is associated with.
Mahaver Chopra1216ae52016-03-11 15:39:48 +00005682 * @throws IllegalStateException if device has an ongoing call.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005683 * @throws SecurityException if {@code admin} is not a device owner.
Mahaver Chopra1216ae52016-03-11 15:39:48 +00005684 * @see TelephonyManager#CALL_STATE_IDLE
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +00005685 */
5686 public void reboot(@NonNull ComponentName admin) {
5687 try {
5688 mService.reboot(admin);
5689 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005690 throw re.rethrowFromSystemServer();
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +00005691 }
5692 }
Kenny Guy06de4e72015-12-22 12:07:39 +00005693
5694 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005695 * Called by a device admin to set the short support message. This will be displayed to the user
5696 * in settings screens where funtionality has been disabled by the admin. The message should be
5697 * limited to a short statement such as "This setting is disabled by your administrator. Contact
5698 * someone@example.com for support." If the message is longer than 200 characters it may be
5699 * truncated.
5700 * <p>
5701 * If the short support message needs to be localized, it is the responsibility of the
Benjamin Franz3e8a7092016-01-25 16:19:08 +00005702 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
5703 * and set a new version of this string accordingly.
5704 *
Kenny Guy06de4e72015-12-22 12:07:39 +00005705 * @see #setLongSupportMessage
Kenny Guy06de4e72015-12-22 12:07:39 +00005706 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005707 * @param message Short message to be displayed to the user in settings or null to clear the
5708 * existing message.
5709 * @throws SecurityException if {@code admin} is not an active administrator.
Kenny Guy06de4e72015-12-22 12:07:39 +00005710 */
5711 public void setShortSupportMessage(@NonNull ComponentName admin,
5712 @Nullable String message) {
5713 if (mService != null) {
5714 try {
5715 mService.setShortSupportMessage(admin, message);
5716 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005717 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00005718 }
5719 }
5720 }
5721
5722 /**
5723 * Called by a device admin to get the short support message.
5724 *
5725 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005726 * @return The message set by {@link #setShortSupportMessage(ComponentName, String)} or null if
5727 * no message has been set.
5728 * @throws SecurityException if {@code admin} is not an active administrator.
Kenny Guy06de4e72015-12-22 12:07:39 +00005729 */
5730 public String getShortSupportMessage(@NonNull ComponentName admin) {
5731 if (mService != null) {
5732 try {
5733 return mService.getShortSupportMessage(admin);
5734 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005735 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00005736 }
5737 }
5738 return null;
5739 }
5740
5741 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005742 * Called by a device admin to set the long support message. This will be displayed to the user
5743 * in the device administators settings screen.
5744 * <p>
5745 * If the long support message needs to be localized, it is the responsibility of the
Benjamin Franz3e8a7092016-01-25 16:19:08 +00005746 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
5747 * and set a new version of this string accordingly.
5748 *
Kenny Guy06de4e72015-12-22 12:07:39 +00005749 * @see #setShortSupportMessage
Kenny Guy06de4e72015-12-22 12:07:39 +00005750 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005751 * @param message Long message to be displayed to the user in settings or null to clear the
5752 * existing message.
5753 * @throws SecurityException if {@code admin} is not an active administrator.
Kenny Guy06de4e72015-12-22 12:07:39 +00005754 */
5755 public void setLongSupportMessage(@NonNull ComponentName admin,
5756 @Nullable String message) {
5757 if (mService != null) {
5758 try {
5759 mService.setLongSupportMessage(admin, message);
5760 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005761 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00005762 }
5763 }
5764 }
5765
5766 /**
5767 * Called by a device admin to get the long support message.
5768 *
5769 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005770 * @return The message set by {@link #setLongSupportMessage(ComponentName, String)} or null if
5771 * no message has been set.
5772 * @throws SecurityException if {@code admin} is not an active administrator.
Kenny Guy06de4e72015-12-22 12:07:39 +00005773 */
5774 public String getLongSupportMessage(@NonNull ComponentName admin) {
5775 if (mService != null) {
5776 try {
5777 return mService.getLongSupportMessage(admin);
5778 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005779 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00005780 }
5781 }
5782 return null;
5783 }
5784
5785 /**
5786 * Called by the system to get the short support message.
5787 *
5788 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5789 * @param userHandle user id the admin is running as.
5790 * @return The message set by {@link #setShortSupportMessage(ComponentName, String)}
5791 *
5792 * @hide
5793 */
5794 public String getShortSupportMessageForUser(@NonNull ComponentName admin, int userHandle) {
5795 if (mService != null) {
5796 try {
5797 return mService.getShortSupportMessageForUser(admin, userHandle);
5798 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005799 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00005800 }
5801 }
5802 return null;
5803 }
5804
5805
5806 /**
5807 * Called by the system to get the long support message.
5808 *
5809 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5810 * @param userHandle user id the admin is running as.
5811 * @return The message set by {@link #setLongSupportMessage(ComponentName, String)}
5812 *
5813 * @hide
5814 */
5815 public String getLongSupportMessageForUser(@NonNull ComponentName admin, int userHandle) {
5816 if (mService != null) {
5817 try {
5818 return mService.getLongSupportMessageForUser(admin, userHandle);
5819 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005820 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00005821 }
5822 }
5823 return null;
5824 }
Clara Bayarri3e826ef2015-12-14 17:51:22 +00005825
5826 /**
Esteban Talavera62399912016-01-11 15:37:55 +00005827 * Called by the profile owner of a managed profile to obtain a {@link DevicePolicyManager}
5828 * whose calls act on the parent profile.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005829 * <p>
5830 * Note only some methods will work on the parent Manager.
Clara Bayarri3e826ef2015-12-14 17:51:22 +00005831 *
5832 * @return a new instance of {@link DevicePolicyManager} that acts on the parent profile.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005833 * @throws SecurityException if {@code admin} is not a profile owner.
Clara Bayarri3e826ef2015-12-14 17:51:22 +00005834 */
5835 public DevicePolicyManager getParentProfileInstance(@NonNull ComponentName admin) {
5836 try {
5837 if (!mService.isManagedProfile(admin)) {
5838 throw new SecurityException("The current user does not have a parent profile.");
5839 }
5840 return new DevicePolicyManager(mContext, true);
Rubin Xuc3cd05f2016-01-11 12:11:35 +00005841 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005842 throw e.rethrowFromSystemServer();
Rubin Xuc3cd05f2016-01-11 12:11:35 +00005843 }
5844 }
5845
5846 /**
Michal Karpinski6235a942016-03-15 12:07:23 +00005847 * Called by device owner to control the security logging feature. Logging can only be
5848 * enabled on single user devices where the sole user is managed by the device owner.
5849 *
5850 * <p> Security logs contain various information intended for security auditing purposes.
5851 * See {@link SecurityEvent} for details.
5852 *
5853 * <p>There must be only one user on the device, managed by the device owner.
5854 * Otherwise a {@link SecurityException} will be thrown.
Michal Karpinskib58e4962016-03-01 14:55:10 +00005855 *
Rubin Xuc3cd05f2016-01-11 12:11:35 +00005856 * @param admin Which device owner this request is associated with.
Michal Karpinski6235a942016-03-15 12:07:23 +00005857 * @param enabled whether security logging should be enabled or not.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005858 * @throws SecurityException if {@code admin} is not a device owner.
Michal Karpinski6235a942016-03-15 12:07:23 +00005859 * @see #retrieveSecurityLogs
5860 */
5861 public void setSecurityLoggingEnabled(@NonNull ComponentName admin, boolean enabled) {
5862 try {
5863 mService.setSecurityLoggingEnabled(admin, enabled);
5864 } catch (RemoteException re) {
5865 throw re.rethrowFromSystemServer();
5866 }
5867 }
5868
5869 /**
Michal Karpinski6235a942016-03-15 12:07:23 +00005870 * Return whether security logging is enabled or not by the device owner.
5871 *
5872 * <p>Can only be called by the device owner, otherwise a {@link SecurityException} will be
5873 * thrown.
5874 *
5875 * @param admin Which device owner this request is associated with.
5876 * @return {@code true} if security logging is enabled by device owner, {@code false} otherwise.
5877 * @throws SecurityException if {@code admin} is not a device owner.
5878 */
5879 public boolean isSecurityLoggingEnabled(@NonNull ComponentName admin) {
Rubin Xuc3cd05f2016-01-11 12:11:35 +00005880 try {
Michal Karpinski6235a942016-03-15 12:07:23 +00005881 return mService.isSecurityLoggingEnabled(admin);
Rubin Xuc3cd05f2016-01-11 12:11:35 +00005882 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005883 throw re.rethrowFromSystemServer();
Rubin Xuc3cd05f2016-01-11 12:11:35 +00005884 }
5885 }
5886
5887 /**
Michal Karpinski6235a942016-03-15 12:07:23 +00005888 * Called by device owner to retrieve all new security logging entries since the last call to
5889 * this API after device boots.
5890 *
5891 * <p> Access to the logs is rate limited and it will only return new logs after the device
5892 * owner has been notified via {@link DeviceAdminReceiver#onSecurityLogsAvailable}.
5893 *
5894 * <p>There must be only one user on the device, managed by the device owner.
5895 * Otherwise a {@link SecurityException} will be thrown.
Michal Karpinskib58e4962016-03-01 14:55:10 +00005896 *
Rubin Xuc3cd05f2016-01-11 12:11:35 +00005897 * @param admin Which device owner this request is associated with.
Michal Karpinski6235a942016-03-15 12:07:23 +00005898 * @return the new batch of security logs which is a list of {@link SecurityEvent},
5899 * or {@code null} if rate limitation is exceeded or if logging is currently disabled.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005900 * @throws SecurityException if {@code admin} is not a device owner.
Rubin Xuc3cd05f2016-01-11 12:11:35 +00005901 */
Michal Karpinski6235a942016-03-15 12:07:23 +00005902 public List<SecurityEvent> retrieveSecurityLogs(@NonNull ComponentName admin) {
Rubin Xuc3cd05f2016-01-11 12:11:35 +00005903 try {
Michal Karpinski6235a942016-03-15 12:07:23 +00005904 ParceledListSlice<SecurityEvent> list = mService.retrieveSecurityLogs(admin);
Rubin Xuc3cd05f2016-01-11 12:11:35 +00005905 if (list != null) {
5906 return list.getList();
5907 } else {
5908 // Rate limit exceeded.
5909 return null;
5910 }
Clara Bayarri3e826ef2015-12-14 17:51:22 +00005911 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005912 throw re.rethrowFromSystemServer();
Clara Bayarri3e826ef2015-12-14 17:51:22 +00005913 }
5914 }
Benjamin Franz59720bb2016-01-18 15:26:11 +00005915
5916 /**
Sudheer Shanka978fc0d2016-01-28 13:51:10 +00005917 * Called by the system to obtain a {@link DevicePolicyManager} whose calls act on the parent
5918 * profile.
5919 *
5920 * @hide
5921 */
5922 public DevicePolicyManager getParentProfileInstance(UserInfo uInfo) {
5923 mContext.checkSelfPermission(
5924 android.Manifest.permission.MANAGE_PROFILE_AND_DEVICE_OWNERS);
5925 if (!uInfo.isManagedProfile()) {
5926 throw new SecurityException("The user " + uInfo.id
5927 + " does not have a parent profile.");
5928 }
5929 return new DevicePolicyManager(mContext, true);
5930 }
5931
5932 /**
Rubin Xuc3cd05f2016-01-11 12:11:35 +00005933 * Called by device owners to retrieve device logs from before the device's last reboot.
Rubin Xuc3cd05f2016-01-11 12:11:35 +00005934 * <p>
5935 * <strong> The device logs are retrieved from a RAM region which is not guaranteed to be
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005936 * corruption-free during power cycles, due to hardware variations and limitations. As a result,
5937 * this API is provided as best-effort and the returned logs may contain corrupted
5938 * data. </strong>
5939 * <p>
5940 * There must be only one user on the device, managed by the device owner. Otherwise a
5941 * {@link SecurityException} will be thrown.
Michal Karpinskib58e4962016-03-01 14:55:10 +00005942 *
Rubin Xuc3cd05f2016-01-11 12:11:35 +00005943 * @param admin Which device owner this request is associated with.
5944 * @return Device logs from before the latest reboot of the system.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005945 * @throws SecurityException if {@code admin} is not a device owner.
Rubin Xuc3cd05f2016-01-11 12:11:35 +00005946 */
Michal Karpinski6235a942016-03-15 12:07:23 +00005947 public List<SecurityEvent> retrievePreRebootSecurityLogs(@NonNull ComponentName admin) {
Rubin Xuc3cd05f2016-01-11 12:11:35 +00005948 try {
Michal Karpinski6235a942016-03-15 12:07:23 +00005949 ParceledListSlice<SecurityEvent> list = mService.retrievePreRebootSecurityLogs(admin);
Rubin Xuc3cd05f2016-01-11 12:11:35 +00005950 return list.getList();
5951 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005952 throw re.rethrowFromSystemServer();
Rubin Xuc3cd05f2016-01-11 12:11:35 +00005953 }
5954 }
5955
5956 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005957 * Called by a profile owner of a managed profile to set the color used for customization. This
5958 * color is used as background color of the confirm credentials screen for that user. The
5959 * default color is {@link android.graphics.Color#GRAY}.
5960 * <p>
5961 * The confirm credentials screen can be created using
Benjamin Franz59720bb2016-01-18 15:26:11 +00005962 * {@link android.app.KeyguardManager#createConfirmDeviceCredentialIntent}.
5963 *
5964 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5965 * @param color The 32bit representation of the color to be used.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005966 * @throws SecurityException if {@code admin} is not a profile owner.
Benjamin Franz59720bb2016-01-18 15:26:11 +00005967 */
5968 public void setOrganizationColor(@NonNull ComponentName admin, int color) {
5969 try {
5970 mService.setOrganizationColor(admin, color);
5971 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005972 throw re.rethrowFromSystemServer();
Benjamin Franz59720bb2016-01-18 15:26:11 +00005973 }
5974 }
5975
5976 /**
Nicolas Prevot8f7698a2016-02-11 16:05:33 +00005977 * @hide
5978 *
5979 * Sets the color used for customization.
5980 *
5981 * @param color The 32bit representation of the color to be used.
5982 * @param userId which user to set the color to.
5983 * @RequiresPermission(allOf = {
5984 * Manifest.permission.MANAGE_USERS,
5985 * Manifest.permission.INTERACT_ACROSS_USERS_FULL})
5986 */
5987 public void setOrganizationColorForUser(@ColorInt int color, @UserIdInt int userId) {
5988 try {
5989 mService.setOrganizationColorForUser(color, userId);
5990 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005991 throw re.rethrowFromSystemServer();
Nicolas Prevot8f7698a2016-02-11 16:05:33 +00005992 }
5993 }
5994
5995 /**
Benjamin Franz59720bb2016-01-18 15:26:11 +00005996 * Called by a profile owner of a managed profile to retrieve the color used for customization.
5997 * This color is used as background color of the confirm credentials screen for that user.
5998 *
5999 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6000 * @return The 32bit representation of the color to be used.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006001 * @throws SecurityException if {@code admin} is not a profile owner.
Benjamin Franz59720bb2016-01-18 15:26:11 +00006002 */
6003 public int getOrganizationColor(@NonNull ComponentName admin) {
6004 try {
6005 return mService.getOrganizationColor(admin);
6006 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006007 throw re.rethrowFromSystemServer();
Benjamin Franz59720bb2016-01-18 15:26:11 +00006008 }
6009 }
6010
6011 /**
6012 * @hide
6013 * Retrieve the customization color for a given user.
6014 *
6015 * @param userHandle The user id of the user we're interested in.
6016 * @return The 32bit representation of the color to be used.
6017 */
6018 public int getOrganizationColorForUser(int userHandle) {
6019 try {
6020 return mService.getOrganizationColorForUser(userHandle);
6021 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006022 throw re.rethrowFromSystemServer();
Benjamin Franz59720bb2016-01-18 15:26:11 +00006023 }
6024 }
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01006025
6026 /**
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006027 * Called by a profile owner of a managed profile to set the name of the organization under
6028 * management.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006029 * <p>
6030 * If the organization name needs to be localized, it is the responsibility of the
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006031 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
6032 * and set a new version of this string accordingly.
6033 *
6034 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6035 * @param title The organization name or {@code null} to clear a previously set name.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006036 * @throws SecurityException if {@code admin} is not a profile owner.
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006037 */
6038 public void setOrganizationName(@NonNull ComponentName admin, @Nullable String title) {
6039 try {
6040 mService.setOrganizationName(admin, title);
6041 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006042 throw re.rethrowFromSystemServer();
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006043 }
6044 }
6045
6046 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006047 * Called by a profile owner of a managed profile to retrieve the name of the organization under
6048 * management.
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006049 *
6050 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6051 * @return The organization name or {@code null} if none is set.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006052 * @throws SecurityException if {@code admin} is not a profile owner.
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006053 */
6054 public String getOrganizationName(@NonNull ComponentName admin) {
6055 try {
6056 return mService.getOrganizationName(admin);
6057 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006058 throw re.rethrowFromSystemServer();
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006059 }
6060 }
6061
6062 /**
6063 * Retrieve the default title message used in the confirm credentials screen for a given user.
6064 *
6065 * @param userHandle The user id of the user we're interested in.
6066 * @return The organization name or {@code null} if none is set.
6067 *
6068 * @hide
6069 */
6070 public String getOrganizationNameForUser(int userHandle) {
6071 try {
6072 return mService.getOrganizationNameForUser(userHandle);
6073 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006074 throw re.rethrowFromSystemServer();
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006075 }
6076 }
6077
6078 /**
Alan Treadwayafad8782016-01-19 15:15:08 +00006079 * @return the {@link UserProvisioningState} for the current user - for unmanaged users will
6080 * return {@link #STATE_USER_UNMANAGED}
6081 * @hide
6082 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00006083 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00006084 @UserProvisioningState
6085 public int getUserProvisioningState() {
6086 if (mService != null) {
6087 try {
6088 return mService.getUserProvisioningState();
6089 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006090 throw e.rethrowFromSystemServer();
Alan Treadwayafad8782016-01-19 15:15:08 +00006091 }
6092 }
6093 return STATE_USER_UNMANAGED;
6094 }
6095
6096 /**
6097 * Set the {@link UserProvisioningState} for the supplied user, if they are managed.
6098 *
6099 * @param state to store
6100 * @param userHandle for user
6101 * @hide
6102 */
6103 public void setUserProvisioningState(@UserProvisioningState int state, int userHandle) {
6104 if (mService != null) {
6105 try {
6106 mService.setUserProvisioningState(state, userHandle);
6107 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006108 throw e.rethrowFromSystemServer();
Alan Treadwayafad8782016-01-19 15:15:08 +00006109 }
6110 }
6111 }
6112
6113 /**
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01006114 * @hide
6115 * Indicates the entity that controls the device or profile owner. A user/profile is considered
6116 * affiliated if it is managed by the same entity as the device.
6117 *
6118 * <p> By definition, the user that the device owner runs on is always affiliated. Any other
6119 * user/profile is considered affiliated if the following conditions are both met:
6120 * <ul>
6121 * <li>The device owner and the user's/profile's profile owner have called this method,
6122 * specifying a set of opaque affiliation ids each. If the sets specified by the device owner
6123 * and a profile owner intersect, they must have come from the same source, which means that
6124 * the device owner and profile owner are controlled by the same entity.</li>
6125 * <li>The device owner's and profile owner's package names are the same.</li>
6126 * </ul>
6127 *
6128 * @param admin Which profile or device owner this request is associated with.
6129 * @param ids A set of opaque affiliation ids.
6130 */
6131 public void setAffiliationIds(@NonNull ComponentName admin, Set<String> ids) {
6132 try {
6133 mService.setAffiliationIds(admin, new ArrayList<String>(ids));
6134 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006135 throw e.rethrowFromSystemServer();
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01006136 }
6137 }
6138
6139 /**
6140 * @hide
6141 * Returns whether this user/profile is affiliated with the device. See
6142 * {@link #setAffiliationIds} for the definition of affiliation.
6143 *
6144 * @return whether this user/profile is affiliated with the device.
6145 */
6146 public boolean isAffiliatedUser() {
6147 try {
6148 return mService != null && mService.isAffiliatedUser();
6149 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006150 throw e.rethrowFromSystemServer();
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01006151 }
6152 }
Suprabh Shuklaa2ae2232016-01-28 18:05:14 -08006153
6154 /**
6155 * @hide
6156 * Returns whether the uninstall for {@code packageName} for the current user is in queue
6157 * to be started
6158 * @param packageName the package to check for
6159 * @return whether the uninstall intent for {@code packageName} is pending
6160 */
6161 public boolean isUninstallInQueue(String packageName) {
6162 try {
6163 return mService.isUninstallInQueue(packageName);
6164 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006165 throw re.rethrowFromSystemServer();
Suprabh Shuklaa2ae2232016-01-28 18:05:14 -08006166 }
6167 }
6168
6169 /**
6170 * @hide
6171 * @param packageName the package containing active DAs to be uninstalled
6172 */
6173 public void uninstallPackageWithActiveAdmins(String packageName) {
6174 try {
6175 mService.uninstallPackageWithActiveAdmins(packageName);
6176 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006177 throw re.rethrowFromSystemServer();
Suprabh Shuklaa2ae2232016-01-28 18:05:14 -08006178 }
6179 }
Dianne Hackbornd6847842010-01-12 18:14:19 -08006180}