blob: 688876cb3891cb16e2843e4f218217a106167d8d [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;
Rubin Xub4365912016-03-23 12:13:22 +000074import java.util.Arrays;
Svetoslav976e8bd2014-07-16 15:12:03 -070075import java.util.Collections;
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -080076import java.util.List;
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +010077import java.util.Set;
Dianne Hackbornd6847842010-01-12 18:14:19 -080078
79/**
Alexandra Gherghina541afcd2014-11-07 11:18:12 +000080 * Public interface for managing policies enforced on a device. Most clients of this class must be
Suprabh Shukla34d92ef2016-03-14 13:49:37 -070081 * registered with the system as a <a href="{@docRoot}guide/topics/admin/device-admin.html">device
82 * administrator</a>. Additionally, a device administrator may be registered as either a profile or
83 * device owner. A given method is accessible to all device administrators unless the documentation
84 * for that method specifies that it is restricted to either device or profile owners. Any
85 * application calling an api may only pass as an argument a device administrator component it
86 * owns. Otherwise, a {@link SecurityException} will be thrown.
Joe Fernandez3aef8e1d2011-12-20 10:38:34 -080087 * <div class="special reference">
88 * <h3>Developer Guides</h3>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -070089 * <p>
90 * For more information about managing policies for device administration, read the <a href=
91 * "{@docRoot}guide/topics/admin/device-admin.html">Device Administration</a> developer
92 * guide. </div>
Dianne Hackbornd6847842010-01-12 18:14:19 -080093 */
94public class DevicePolicyManager {
95 private static String TAG = "DevicePolicyManager";
Dianne Hackbornd6847842010-01-12 18:14:19 -080096
97 private final Context mContext;
Dianne Hackbornd6847842010-01-12 18:14:19 -080098 private final IDevicePolicyManager mService;
Esteban Talavera62399912016-01-11 15:37:55 +000099 private final boolean mParentInstance;
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700100
Clara Bayarri3e826ef2015-12-14 17:51:22 +0000101 private DevicePolicyManager(Context context, boolean parentInstance) {
Esteban Talavera62399912016-01-11 15:37:55 +0000102 this(context,
103 IDevicePolicyManager.Stub.asInterface(
104 ServiceManager.getService(Context.DEVICE_POLICY_SERVICE)),
105 parentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -0800106 }
107
Dianne Hackborn87bba1e2010-02-26 17:25:54 -0800108 /** @hide */
Makoto Onukicc4bbeb2015-09-17 10:28:24 -0700109 @VisibleForTesting
Esteban Talavera62399912016-01-11 15:37:55 +0000110 protected DevicePolicyManager(
111 Context context, IDevicePolicyManager service, boolean parentInstance) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -0700112 mContext = context;
113 mService = service;
Esteban Talavera62399912016-01-11 15:37:55 +0000114 mParentInstance = parentInstance;
Makoto Onukicc4bbeb2015-09-17 10:28:24 -0700115 }
116
117 /** @hide */
118 public static DevicePolicyManager create(Context context) {
Clara Bayarri3e826ef2015-12-14 17:51:22 +0000119 DevicePolicyManager me = new DevicePolicyManager(context, false);
Dianne Hackborn21f1bd12010-02-19 17:02:21 -0800120 return me.mService != null ? me : null;
121 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700122
Makoto Onukicc4bbeb2015-09-17 10:28:24 -0700123 /** @hide test will override it. */
124 @VisibleForTesting
125 protected int myUserId() {
126 return UserHandle.myUserId();
127 }
128
Dianne Hackbornd6847842010-01-12 18:14:19 -0800129 /**
Jessica Hummelf72078b2014-03-06 16:13:12 +0000130 * Activity action: Starts the provisioning flow which sets up a managed profile.
Jessica Hummelf72078b2014-03-06 16:13:12 +0000131 *
Jessica Hummel9da60392014-05-21 12:32:57 +0100132 * <p>A managed profile allows data separation for example for the usage of a
133 * device as a personal and corporate device. The user which provisioning is started from and
134 * the managed profile share a launcher.
135 *
Andrew Solovay27f53372015-03-02 16:37:59 -0800136 * <p>This intent will typically be sent by a mobile device management application (MDM).
137 * Provisioning adds a managed profile and sets the MDM as the profile owner who has full
138 * control over the profile.
Jessica Hummel9da60392014-05-21 12:32:57 +0100139 *
Alan Treadway46dd4492015-11-09 13:57:19 +0000140 * <p>It is possible to check if provisioning is allowed or not by querying the method
141 * {@link #isProvisioningAllowed(String)}.
142 *
143 * <p>In version {@link android.os.Build.VERSION_CODES#LOLLIPOP}, this intent must contain the
Nicolas Prevot18440252015-03-09 14:07:17 +0000144 * extra {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME}.
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -0700145 * As of {@link android.os.Build.VERSION_CODES#M}, it should contain the extra
Nicolas Prevot18440252015-03-09 14:07:17 +0000146 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME} instead, although specifying only
147 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME} is still supported.
Nicolas Prevotcaf11cd2015-11-19 10:58:35 +0000148 *
Benjamin Franzea956242016-03-21 15:45:56 +0000149 * <p>The intent may also contain the following extras:
Nicolas Prevotcaf11cd2015-11-19 10:58:35 +0000150 * <ul>
Benjamin Franzea956242016-03-21 15:45:56 +0000151 * <li>{@link #EXTRA_PROVISIONING_ACCOUNT_TO_MIGRATE}, optional </li>
152 * <li>{@link #EXTRA_PROVISIONING_SKIP_ENCRYPTION}, optional, supported from
153 * {@link android.os.Build.VERSION_CODES#N}</li>
154 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li>
155 * <li>{@link #EXTRA_PROVISIONING_LOGO_URI}, optional</li>
156 * <li>{@link #EXTRA_PROVISIONING_MAIN_COLOR}, optional</li>
Nicolas Prevotcaf11cd2015-11-19 10:58:35 +0000157 * </ul>
Jessica Hummelf72078b2014-03-06 16:13:12 +0000158 *
Benjamin Franzea956242016-03-21 15:45:56 +0000159 * <p>When managed provisioning has completed, broadcasts are sent to the application specified
Alexandra Gherghinadb4bc572015-01-08 12:17:40 +0000160 * in the provisioning intent. The
161 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} broadcast is sent in the
162 * managed profile and the {@link #ACTION_MANAGED_PROFILE_PROVISIONED} broadcast is sent in
163 * the primary profile.
Jessica Hummel9da60392014-05-21 12:32:57 +0100164 *
Benjamin Franzea956242016-03-21 15:45:56 +0000165 * <p>If provisioning fails, the managedProfile is removed so the device returns to its
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100166 * previous state.
Alan Treadway4582f812015-07-28 11:49:35 +0100167 *
168 * <p>If launched with {@link android.app.Activity#startActivityForResult(Intent, int)} a
169 * result code of {@link android.app.Activity#RESULT_OK} implies that the synchronous part of
170 * the provisioning flow was successful, although this doesn't guarantee the full flow will
171 * succeed. Conversely a result code of {@link android.app.Activity#RESULT_CANCELED} implies
172 * that the user backed-out of provisioning, or some precondition for provisioning wasn't met.
Jessica Hummelf72078b2014-03-06 16:13:12 +0000173 */
174 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
175 public static final String ACTION_PROVISION_MANAGED_PROFILE
Esteban Talaveraef9c5232014-09-08 13:51:18 +0100176 = "android.app.action.PROVISION_MANAGED_PROFILE";
Jessica Hummelf72078b2014-03-06 16:13:12 +0000177
178 /**
Mahaver Chopra7830daa2015-11-10 18:12:43 +0000179 * Activity action: Starts the provisioning flow which sets up a managed user.
180 *
181 * <p>This intent will typically be sent by a mobile device management application (MDM).
Makoto Onuki32b30572015-12-11 14:29:51 -0800182 * Provisioning configures the user as managed user and sets the MDM as the profile
Mahaver Chopra7830daa2015-11-10 18:12:43 +0000183 * owner who has full control over the user. Provisioning can only happen before user setup has
184 * been completed. Use {@link #isProvisioningAllowed(String)} to check if provisioning is
185 * allowed.
186 *
Benjamin Franzea956242016-03-21 15:45:56 +0000187 * <p>The intent contains the following extras:
188 * <ul>
189 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}</li>
190 * <li>{@link #EXTRA_PROVISIONING_SKIP_ENCRYPTION}, optional</li>
191 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li>
192 * <li>{@link #EXTRA_PROVISIONING_LOGO_URI}, optional</li>
193 * <li>{@link #EXTRA_PROVISIONING_MAIN_COLOR}, optional</li>
194 * </ul>
Mahaver Chopra7830daa2015-11-10 18:12:43 +0000195 *
Benjamin Franzea956242016-03-21 15:45:56 +0000196 * <p>If provisioning fails, the device returns to its previous state.
Mahaver Chopra7830daa2015-11-10 18:12:43 +0000197 *
198 * <p>If launched with {@link android.app.Activity#startActivityForResult(Intent, int)} a
199 * result code of {@link android.app.Activity#RESULT_OK} implies that the synchronous part of
200 * the provisioning flow was successful, although this doesn't guarantee the full flow will
201 * succeed. Conversely a result code of {@link android.app.Activity#RESULT_CANCELED} implies
202 * that the user backed-out of provisioning, or some precondition for provisioning wasn't met.
Benjamin Franzea956242016-03-21 15:45:56 +0000203 *
204 * @hide
Mahaver Chopra5e732562015-11-05 11:55:12 +0000205 */
206 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
207 public static final String ACTION_PROVISION_MANAGED_USER
208 = "android.app.action.PROVISION_MANAGED_USER";
209
210 /**
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100211 * Activity action: Starts the provisioning flow which sets up a managed device.
212 * Must be started with {@link android.app.Activity#startActivityForResult(Intent, int)}.
213 *
214 * <p> During device owner provisioning a device admin app is set as the owner of the device.
215 * A device owner has full control over the device. The device owner can not be modified by the
216 * user.
217 *
218 * <p> A typical use case would be a device that is owned by a company, but used by either an
219 * employee or client.
220 *
221 * <p> An intent with this action can be sent only on an unprovisioned device.
Alan Treadway46dd4492015-11-09 13:57:19 +0000222 * It is possible to check if provisioning is allowed or not by querying the method
223 * {@link #isProvisioningAllowed(String)}.
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100224 *
Alan Treadway46dd4492015-11-09 13:57:19 +0000225 * <p>The intent contains the following extras:
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100226 * <ul>
227 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}</li>
228 * <li>{@link #EXTRA_PROVISIONING_SKIP_ENCRYPTION}, optional</li>
229 * <li>{@link #EXTRA_PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED}, optional</li>
Rubin Xua4f9dc12015-06-12 13:27:59 +0100230 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li>
Nicolas Prevot8b7991c2015-11-12 17:40:12 +0000231 * <li>{@link #EXTRA_PROVISIONING_LOGO_URI}, optional</li>
Nicolas Prevotcaf11cd2015-11-19 10:58:35 +0000232 * <li>{@link #EXTRA_PROVISIONING_MAIN_COLOR}, optional</li>
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100233 * </ul>
234 *
Benjamin Franzea956242016-03-21 15:45:56 +0000235 * <p>When device owner provisioning has completed, an intent of the type
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100236 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} is broadcast to the
237 * device owner.
238 *
Benjamin Franzea956242016-03-21 15:45:56 +0000239 * <p>If provisioning fails, the device is factory reset.
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100240 *
Alan Treadway4582f812015-07-28 11:49:35 +0100241 * <p>A result code of {@link android.app.Activity#RESULT_OK} implies that the synchronous part
242 * of the provisioning flow was successful, although this doesn't guarantee the full flow will
243 * succeed. Conversely a result code of {@link android.app.Activity#RESULT_CANCELED} implies
244 * that the user backed-out of provisioning, or some precondition for provisioning wasn't met.
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100245 */
246 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
247 public static final String ACTION_PROVISION_MANAGED_DEVICE
248 = "android.app.action.PROVISION_MANAGED_DEVICE";
249
250 /**
Alan Treadway46dd4492015-11-09 13:57:19 +0000251 * Activity action: Starts the provisioning flow which sets up a managed device.
Steven Ng980a1b62016-02-02 17:43:18 +0000252 *
253 * <p>During device owner provisioning, a device admin app is downloaded and set as the owner of
254 * the device. A device owner has full control over the device. The device owner can not be
255 * modified by the user and the only way of resetting the device is via factory reset.
256 *
257 * <p>A typical use case would be a device that is owned by a company, but used by either an
258 * employee or client.
259 *
260 * <p>The provisioning message should be sent to an unprovisioned device.
261 *
262 * <p>Unlike {@link #ACTION_PROVISION_MANAGED_DEVICE}, the provisioning message can only be sent
263 * by a privileged app with the permission
264 * {@link android.Manifest.permission#DISPATCH_PROVISIONING_MESSAGE}.
265 *
266 * <p>The provisioning intent contains the following properties:
267 * <ul>
268 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}</li>
269 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}, optional</li>
270 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER}, optional</li>
271 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM}, optional</li>
272 * <li>{@link #EXTRA_PROVISIONING_LOCAL_TIME} (convert to String), optional</li>
273 * <li>{@link #EXTRA_PROVISIONING_TIME_ZONE}, optional</li>
274 * <li>{@link #EXTRA_PROVISIONING_LOCALE}, optional</li>
275 * <li>{@link #EXTRA_PROVISIONING_WIFI_SSID}, optional</li>
276 * <li>{@link #EXTRA_PROVISIONING_WIFI_HIDDEN} (convert to String), optional</li>
277 * <li>{@link #EXTRA_PROVISIONING_WIFI_SECURITY_TYPE}, optional</li>
278 * <li>{@link #EXTRA_PROVISIONING_WIFI_PASSWORD}, optional</li>
279 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_HOST}, optional</li>
280 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_PORT} (convert to String), optional</li>
281 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_BYPASS}, optional</li>
282 * <li>{@link #EXTRA_PROVISIONING_WIFI_PAC_URL}, optional</li>
283 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li></ul>
284 *
285 * @hide
286 */
287 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
288 @SystemApi
289 public static final String ACTION_PROVISION_MANAGED_DEVICE_FROM_TRUSTED_SOURCE =
290 "android.app.action.PROVISION_MANAGED_DEVICE_FROM_TRUSTED_SOURCE";
291
292 /**
293 * Activity action: Starts the provisioning flow which sets up a managed device.
Alan Treadway46dd4492015-11-09 13:57:19 +0000294 * Must be started with {@link android.app.Activity#startActivityForResult(Intent, int)}.
295 *
296 * <p>NOTE: This is only supported on split system user devices, and puts the device into a
297 * management state that is distinct from that reached by
298 * {@link #ACTION_PROVISION_MANAGED_DEVICE} - specifically the device owner runs on the system
299 * user, and only has control over device-wide policies, not individual users and their data.
300 * The primary benefit is that multiple non-system users are supported when provisioning using
301 * this form of device management.
302 *
Benjamin Franzea956242016-03-21 15:45:56 +0000303 * <p>During device owner provisioning a device admin app is set as the owner of the device.
Alan Treadway46dd4492015-11-09 13:57:19 +0000304 * A device owner has full control over the device. The device owner can not be modified by the
305 * user.
306 *
Benjamin Franzea956242016-03-21 15:45:56 +0000307 * <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 +0000308 * employee or client.
309 *
Benjamin Franzea956242016-03-21 15:45:56 +0000310 * <p>An intent with this action can be sent only on an unprovisioned device.
Alan Treadway46dd4492015-11-09 13:57:19 +0000311 * It is possible to check if provisioning is allowed or not by querying the method
312 * {@link #isProvisioningAllowed(String)}.
313 *
314 * <p>The intent contains the following extras:
315 * <ul>
316 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}</li>
317 * <li>{@link #EXTRA_PROVISIONING_SKIP_ENCRYPTION}, optional</li>
318 * <li>{@link #EXTRA_PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED}, optional</li>
319 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li>
Benjamin Franzea956242016-03-21 15:45:56 +0000320 * <li>{@link #EXTRA_PROVISIONING_LOGO_URI}, optional</li>
321 * <li>{@link #EXTRA_PROVISIONING_MAIN_COLOR}, optional</li>
Alan Treadway46dd4492015-11-09 13:57:19 +0000322 * </ul>
323 *
Benjamin Franzea956242016-03-21 15:45:56 +0000324 * <p>When device owner provisioning has completed, an intent of the type
Alan Treadway46dd4492015-11-09 13:57:19 +0000325 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} is broadcast to the
326 * device owner.
327 *
Benjamin Franzea956242016-03-21 15:45:56 +0000328 * <p>If provisioning fails, the device is factory reset.
Alan Treadway46dd4492015-11-09 13:57:19 +0000329 *
330 * <p>A result code of {@link android.app.Activity#RESULT_OK} implies that the synchronous part
331 * of the provisioning flow was successful, although this doesn't guarantee the full flow will
332 * succeed. Conversely a result code of {@link android.app.Activity#RESULT_CANCELED} implies
333 * that the user backed-out of provisioning, or some precondition for provisioning wasn't met.
334 *
335 * @hide
336 */
337 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
338 public static final String ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE
339 = "android.app.action.PROVISION_MANAGED_SHAREABLE_DEVICE";
340
341 /**
Alan Treadwayafad8782016-01-19 15:15:08 +0000342 * Activity action: Finalizes management provisioning, should be used after user-setup
343 * has been completed and {@link #getUserProvisioningState()} returns one of:
344 * <ul>
345 * <li>{@link #STATE_USER_SETUP_INCOMPLETE}</li>
346 * <li>{@link #STATE_USER_SETUP_COMPLETE}</li>
347 * <li>{@link #STATE_USER_PROFILE_COMPLETE}</li>
348 * </ul>
349 *
350 * @hide
351 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +0000352 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +0000353 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
354 public static final String ACTION_PROVISION_FINALIZATION
355 = "android.app.action.PROVISION_FINALIZATION";
356
357 /**
Michal Karpinskiba244092016-02-25 17:28:24 +0000358 * Action: Bugreport sharing with device owner has been accepted by the user.
359 *
360 * @hide
361 */
362 public static final String ACTION_BUGREPORT_SHARING_ACCEPTED =
363 "com.android.server.action.BUGREPORT_SHARING_ACCEPTED";
364
365 /**
366 * Action: Bugreport sharing with device owner has been declined by the user.
367 *
368 * @hide
369 */
370 public static final String ACTION_BUGREPORT_SHARING_DECLINED =
371 "com.android.server.action.BUGREPORT_SHARING_DECLINED";
372
373 /**
374 * Action: Bugreport has been collected and is dispatched to {@link DevicePolicyManagerService}.
375 *
376 * @hide
377 */
378 public static final String ACTION_REMOTE_BUGREPORT_DISPATCH =
379 "android.intent.action.REMOTE_BUGREPORT_DISPATCH";
380
381 /**
382 * Extra for shared bugreport's SHA-256 hash.
383 *
384 * @hide
385 */
386 public static final String EXTRA_REMOTE_BUGREPORT_HASH =
387 "android.intent.extra.REMOTE_BUGREPORT_HASH";
388
389 /**
390 * Extra for remote bugreport notification shown type.
391 *
392 * @hide
393 */
394 public static final String EXTRA_BUGREPORT_NOTIFICATION_TYPE =
395 "android.app.extra.bugreport_notification_type";
396
397 /**
398 * Notification type for a started remote bugreport flow.
399 *
400 * @hide
401 */
402 public static final int NOTIFICATION_BUGREPORT_STARTED = 1;
403
404 /**
405 * Notification type for a bugreport that has already been accepted to be shared, but is still
406 * being taken.
407 *
408 * @hide
409 */
410 public static final int NOTIFICATION_BUGREPORT_ACCEPTED_NOT_FINISHED = 2;
411
412 /**
413 * Notification type for a bugreport that has been taken and can be shared or declined.
414 *
415 * @hide
416 */
417 public static final int NOTIFICATION_BUGREPORT_FINISHED_NOT_ACCEPTED = 3;
418
419 /**
Rubin Xua4f9dc12015-06-12 13:27:59 +0100420 * A {@link android.os.Parcelable} extra of type {@link android.os.PersistableBundle} that
Rubin Xu41f2ccb92015-08-05 16:29:13 +0100421 * allows a mobile device management application or NFC programmer application which starts
422 * managed provisioning to pass data to the management application instance after provisioning.
Rubin Xua4f9dc12015-06-12 13:27:59 +0100423 * <p>
424 * If used with {@link #ACTION_PROVISION_MANAGED_PROFILE} it can be used by the application that
425 * sends the intent to pass data to itself on the newly created profile.
426 * If used with {@link #ACTION_PROVISION_MANAGED_DEVICE} it allows passing data to the same
427 * instance of the app on the primary user.
Rubin Xu41f2ccb92015-08-05 16:29:13 +0100428 * Starting from {@link android.os.Build.VERSION_CODES#M}, if used with
429 * {@link #MIME_TYPE_PROVISIONING_NFC} as part of NFC managed device provisioning, the NFC
430 * message should contain a stringified {@link java.util.Properties} instance, whose string
431 * properties will be converted into a {@link android.os.PersistableBundle} and passed to the
432 * management application after provisioning.
433 *
Rubin Xua4f9dc12015-06-12 13:27:59 +0100434 * <p>
435 * In both cases the application receives the data in
Brian Carlstromf1fe51b2014-09-03 08:55:05 -0700436 * {@link DeviceAdminReceiver#onProfileProvisioningComplete} via an intent with the action
437 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE}. The bundle is not changed
Rubin Xua4f9dc12015-06-12 13:27:59 +0100438 * during the managed provisioning.
Sander Alewijnse90f14bf2014-08-20 16:22:44 +0100439 */
440 public static final String EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE =
Esteban Talavera37f01842014-09-05 10:50:57 +0100441 "android.app.extra.PROVISIONING_ADMIN_EXTRAS_BUNDLE";
Sander Alewijnse90f14bf2014-08-20 16:22:44 +0100442
443 /**
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100444 * A String extra holding the package name of the mobile device management application that
445 * will be set as the profile owner or device owner.
446 *
447 * <p>If an application starts provisioning directly via an intent with action
448 * {@link #ACTION_PROVISION_MANAGED_PROFILE} this package has to match the package name of the
449 * application that started provisioning. The package will be set as profile owner in that case.
450 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000451 * <p>This package is set as device owner when device owner provisioning is started by an NFC
452 * message containing an NFC record with MIME type {@link #MIME_TYPE_PROVISIONING_NFC}.
Nicolas Prevot18440252015-03-09 14:07:17 +0000453 *
454 * <p> When this extra is set, the application must have exactly one device admin receiver.
Robin Lee25e26452015-06-02 09:56:29 -0700455 * This receiver will be set as the profile or device owner and active admin.
Benjamin Franzea956242016-03-21 15:45:56 +0000456 *
Nicolas Prevot18440252015-03-09 14:07:17 +0000457 * @see DeviceAdminReceiver
458 * @deprecated Use {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}. This extra is still
Nicolas Prevot8f78d6a2015-08-21 11:06:31 +0100459 * supported, but only if there is only one device admin receiver in the package that requires
460 * the permission {@link android.Manifest.permission#BIND_DEVICE_ADMIN}.
Jessica Hummelf72078b2014-03-06 16:13:12 +0000461 */
Nicolas Prevot18440252015-03-09 14:07:17 +0000462 @Deprecated
Jessica Hummelf72078b2014-03-06 16:13:12 +0000463 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME
Esteban Talaveraef9c5232014-09-08 13:51:18 +0100464 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME";
Jessica Hummelf72078b2014-03-06 16:13:12 +0000465
466 /**
Nicolas Prevot18440252015-03-09 14:07:17 +0000467 * A ComponentName extra indicating the device admin receiver of the mobile device management
468 * application that will be set as the profile owner or device owner and active admin.
469 *
470 * <p>If an application starts provisioning directly via an intent with action
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100471 * {@link #ACTION_PROVISION_MANAGED_PROFILE} or
472 * {@link #ACTION_PROVISION_MANAGED_DEVICE} the package name of this
473 * component has to match the package name of the application that started provisioning.
Nicolas Prevot18440252015-03-09 14:07:17 +0000474 *
475 * <p>This component is set as device owner and active admin when device owner provisioning is
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100476 * started by an intent with action {@link #ACTION_PROVISION_MANAGED_DEVICE} or by an NFC
477 * message containing an NFC record with MIME type
Benjamin Franzea956242016-03-21 15:45:56 +0000478 * {@link #MIME_TYPE_PROVISIONING_NFC}. For the NFC record, the component name must be
Rubin Xu44ef750b2015-03-23 16:51:33 +0000479 * flattened to a string, via {@link ComponentName#flattenToShortString()}.
Nicolas Prevot18440252015-03-09 14:07:17 +0000480 *
481 * @see DeviceAdminReceiver
482 */
483 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME
484 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME";
485
486 /**
Alexandra Gherghinaaaf2f3e2014-11-13 12:46:15 +0000487 * An {@link android.accounts.Account} extra holding the account to migrate during managed
488 * profile provisioning. If the account supplied is present in the primary user, it will be
489 * copied, along with its credentials to the managed profile and removed from the primary user.
490 *
491 * Use with {@link #ACTION_PROVISION_MANAGED_PROFILE}.
492 */
493
494 public static final String EXTRA_PROVISIONING_ACCOUNT_TO_MIGRATE
495 = "android.app.extra.PROVISIONING_ACCOUNT_TO_MIGRATE";
496
497 /**
Jessica Hummele3da7902014-08-20 15:20:11 +0100498 * A String extra that, holds the email address of the account which a managed profile is
499 * created for. Used with {@link #ACTION_PROVISION_MANAGED_PROFILE} and
500 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE}.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100501 *
Sander Alewijnse2b338a22014-09-12 12:28:40 +0100502 * <p> This extra is part of the {@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}.
503 *
Jessica Hummele3da7902014-08-20 15:20:11 +0100504 * <p> If the {@link #ACTION_PROVISION_MANAGED_PROFILE} intent that starts managed provisioning
505 * contains this extra, it is forwarded in the
506 * {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} intent to the mobile
507 * device management application that was set as the profile owner during provisioning.
508 * It is usually used to avoid that the user has to enter their email address twice.
Nicolas Prevot07ac20b2014-05-27 15:37:45 +0100509 */
Sander Alewijnse2b338a22014-09-12 12:28:40 +0100510 public static final String EXTRA_PROVISIONING_EMAIL_ADDRESS
511 = "android.app.extra.PROVISIONING_EMAIL_ADDRESS";
Nicolas Prevot07ac20b2014-05-27 15:37:45 +0100512
513 /**
Nicolas Prevotcd2d8592015-11-23 13:27:21 +0000514 * A integer extra indicating the predominant color to show during the provisioning.
515 * Refer to {@link android.graphics.Color} for how the color is represented.
Nicolas Prevotcaf11cd2015-11-19 10:58:35 +0000516 *
517 * <p>Use with {@link #ACTION_PROVISION_MANAGED_PROFILE} or
518 * {@link #ACTION_PROVISION_MANAGED_DEVICE}.
519 */
520 public static final String EXTRA_PROVISIONING_MAIN_COLOR =
521 "android.app.extra.PROVISIONING_MAIN_COLOR";
522
523 /**
Sander Alewijnse8c411562014-11-12 18:03:11 +0000524 * A Boolean extra that can be used by the mobile device management application to skip the
Robin Lee25e26452015-06-02 09:56:29 -0700525 * disabling of system apps during provisioning when set to {@code true}.
Sander Alewijnse8c411562014-11-12 18:03:11 +0000526 *
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100527 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} or an intent with action
528 * {@link #ACTION_PROVISION_MANAGED_DEVICE} that starts device owner provisioning.
Sander Alewijnse8c411562014-11-12 18:03:11 +0000529 */
Sander Alewijnse5a144252014-11-18 13:25:04 +0000530 public static final String EXTRA_PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED =
531 "android.app.extra.PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED";
Sander Alewijnse8c411562014-11-12 18:03:11 +0000532
533 /**
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100534 * A String extra holding the time zone {@link android.app.AlarmManager} that the device
535 * will be set to.
536 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000537 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
538 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100539 */
540 public static final String EXTRA_PROVISIONING_TIME_ZONE
Esteban Talavera37f01842014-09-05 10:50:57 +0100541 = "android.app.extra.PROVISIONING_TIME_ZONE";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100542
543 /**
Esteban Talaverad469a0b2014-08-20 13:54:25 +0100544 * A Long extra holding the wall clock time (in milliseconds) to be set on the device's
545 * {@link android.app.AlarmManager}.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100546 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000547 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
548 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100549 */
550 public static final String EXTRA_PROVISIONING_LOCAL_TIME
Esteban Talavera37f01842014-09-05 10:50:57 +0100551 = "android.app.extra.PROVISIONING_LOCAL_TIME";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100552
553 /**
554 * A String extra holding the {@link java.util.Locale} that the device will be set to.
555 * Format: xx_yy, where xx is the language code, and yy the country code.
556 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000557 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
558 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100559 */
560 public static final String EXTRA_PROVISIONING_LOCALE
Esteban Talavera37f01842014-09-05 10:50:57 +0100561 = "android.app.extra.PROVISIONING_LOCALE";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100562
563 /**
564 * A String extra holding the ssid of the wifi network that should be used during nfc device
565 * owner provisioning for downloading the mobile device management application.
566 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000567 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
568 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100569 */
570 public static final String EXTRA_PROVISIONING_WIFI_SSID
Esteban Talavera37f01842014-09-05 10:50:57 +0100571 = "android.app.extra.PROVISIONING_WIFI_SSID";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100572
573 /**
574 * A boolean extra indicating whether the wifi network in {@link #EXTRA_PROVISIONING_WIFI_SSID}
575 * is hidden or not.
576 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000577 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
578 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100579 */
580 public static final String EXTRA_PROVISIONING_WIFI_HIDDEN
Esteban Talavera37f01842014-09-05 10:50:57 +0100581 = "android.app.extra.PROVISIONING_WIFI_HIDDEN";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100582
583 /**
584 * A String extra indicating the security type of the wifi network in
Mahaver Chopra76b08a92015-10-08 17:58:45 +0100585 * {@link #EXTRA_PROVISIONING_WIFI_SSID} and could be one of {@code NONE}, {@code WPA} or
586 * {@code WEP}.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100587 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000588 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
589 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100590 */
591 public static final String EXTRA_PROVISIONING_WIFI_SECURITY_TYPE
Esteban Talavera37f01842014-09-05 10:50:57 +0100592 = "android.app.extra.PROVISIONING_WIFI_SECURITY_TYPE";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100593
594 /**
595 * A String extra holding the password of the wifi network in
596 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
597 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000598 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
599 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100600 */
601 public static final String EXTRA_PROVISIONING_WIFI_PASSWORD
Esteban Talavera37f01842014-09-05 10:50:57 +0100602 = "android.app.extra.PROVISIONING_WIFI_PASSWORD";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100603
604 /**
605 * A String extra holding the proxy host for the wifi network in
606 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
607 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000608 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
609 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100610 */
611 public static final String EXTRA_PROVISIONING_WIFI_PROXY_HOST
Esteban Talavera37f01842014-09-05 10:50:57 +0100612 = "android.app.extra.PROVISIONING_WIFI_PROXY_HOST";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100613
614 /**
615 * An int extra holding the proxy port for the wifi network in
616 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
617 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000618 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
619 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100620 */
621 public static final String EXTRA_PROVISIONING_WIFI_PROXY_PORT
Esteban Talavera37f01842014-09-05 10:50:57 +0100622 = "android.app.extra.PROVISIONING_WIFI_PROXY_PORT";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100623
624 /**
625 * A String extra holding the proxy bypass for the wifi network in
626 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
627 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000628 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
629 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100630 */
631 public static final String EXTRA_PROVISIONING_WIFI_PROXY_BYPASS
Esteban Talavera37f01842014-09-05 10:50:57 +0100632 = "android.app.extra.PROVISIONING_WIFI_PROXY_BYPASS";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100633
634 /**
635 * A String extra holding the proxy auto-config (PAC) URL for the wifi network in
636 * {@link #EXTRA_PROVISIONING_WIFI_SSID}.
637 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000638 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
639 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100640 */
641 public static final String EXTRA_PROVISIONING_WIFI_PAC_URL
Esteban Talavera37f01842014-09-05 10:50:57 +0100642 = "android.app.extra.PROVISIONING_WIFI_PAC_URL";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100643
644 /**
645 * A String extra holding a url that specifies the download location of the device admin
646 * package. When not provided it is assumed that the device admin package is already installed.
647 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000648 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
649 * provisioning via an NFC bump.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100650 */
651 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION
Esteban Talavera37f01842014-09-05 10:50:57 +0100652 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100653
654 /**
Julia Reynoldsc1731742015-03-19 14:56:28 -0400655 * An int extra holding a minimum required version code for the device admin package. If the
656 * device admin is already installed on the device, it will only be re-downloaded from
657 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION} if the version of the
658 * installed package is less than this version code.
659 *
Craig Lafayette3cc72ba2015-06-26 11:51:04 -0400660 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
Julia Reynoldsc1731742015-03-19 14:56:28 -0400661 * provisioning via an NFC bump.
662 */
663 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_MINIMUM_VERSION_CODE
664 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_MINIMUM_VERSION_CODE";
665
666 /**
Sander Alewijnse681bce92014-07-24 16:46:26 +0100667 * A String extra holding a http cookie header which should be used in the http request to the
668 * url specified in {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}.
669 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000670 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
671 * provisioning via an NFC bump.
Sander Alewijnse681bce92014-07-24 16:46:26 +0100672 */
673 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER
Esteban Talavera37f01842014-09-05 10:50:57 +0100674 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER";
Sander Alewijnse681bce92014-07-24 16:46:26 +0100675
676 /**
Rubin Xud92e7572015-05-18 17:01:13 +0100677 * A String extra holding the URL-safe base64 encoded SHA-256 or SHA-1 hash (see notes below) of
678 * the file at download location specified in
679 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}.
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100680 *
Benjamin Franzea956242016-03-21 15:45:56 +0000681 * <p>Either this extra or {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_SIGNATURE_CHECKSUM} must be
682 * present. The provided checksum must match the checksum of the file at the download
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100683 * location. If the checksum doesn't match an error will be shown to the user and the user will
684 * be asked to factory reset the device.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100685 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000686 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
687 * provisioning via an NFC bump.
Rubin Xud92e7572015-05-18 17:01:13 +0100688 *
689 * <p><strong>Note:</strong> for devices running {@link android.os.Build.VERSION_CODES#LOLLIPOP}
690 * and {@link android.os.Build.VERSION_CODES#LOLLIPOP_MR1} only SHA-1 hash is supported.
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -0700691 * Starting from {@link android.os.Build.VERSION_CODES#M}, this parameter accepts SHA-256 in
Rubin Xud92e7572015-05-18 17:01:13 +0100692 * addition to SHA-1. Support for SHA-1 is likely to be removed in future OS releases.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100693 */
694 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM
Esteban Talavera37f01842014-09-05 10:50:57 +0100695 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM";
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100696
697 /**
Rubin Xud92e7572015-05-18 17:01:13 +0100698 * A String extra holding the URL-safe base64 encoded SHA-256 checksum of any signature of the
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100699 * android package archive at the download location specified in {@link
700 * #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}.
701 *
Rubin Xu5c82d2c2015-06-02 09:29:46 +0100702 * <p>The signatures of an android package archive can be obtained using
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100703 * {@link android.content.pm.PackageManager#getPackageArchiveInfo} with flag
704 * {@link android.content.pm.PackageManager#GET_SIGNATURES}.
705 *
Benjamin Franzea956242016-03-21 15:45:56 +0000706 * <p>Either this extra or {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM} must be
707 * present. The provided checksum must match the checksum of any signature of the file at
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100708 * the download location. If the checksum does not match an error will be shown to the user and
709 * the user will be asked to factory reset the device.
710 *
711 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
712 * provisioning via an NFC bump.
713 */
Rubin Xu5c82d2c2015-06-02 09:29:46 +0100714 public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_SIGNATURE_CHECKSUM
715 = "android.app.extra.PROVISIONING_DEVICE_ADMIN_SIGNATURE_CHECKSUM";
Sander Alewijnsee4f878cb2015-04-14 10:49:17 +0100716
717 /**
Alexandra Gherghinadb4bc572015-01-08 12:17:40 +0000718 * Broadcast Action: This broadcast is sent to indicate that provisioning of a managed profile
719 * has completed successfully.
720 *
721 * <p>The broadcast is limited to the primary profile, to the app specified in the provisioning
Nicolas Prevotebe2d992015-05-12 18:14:53 -0700722 * intent with action {@link #ACTION_PROVISION_MANAGED_PROFILE}.
Alexandra Gherghinadb4bc572015-01-08 12:17:40 +0000723 *
Ying Wang7f38aab2015-02-20 11:50:09 -0800724 * <p>This intent will contain the extra {@link #EXTRA_PROVISIONING_ACCOUNT_TO_MIGRATE} which
Alexandra Gherghinadb4bc572015-01-08 12:17:40 +0000725 * corresponds to the account requested to be migrated at provisioning time, if any.
726 */
727 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
728 public static final String ACTION_MANAGED_PROFILE_PROVISIONED
729 = "android.app.action.MANAGED_PROFILE_PROVISIONED";
730
731 /**
Benjamin Franzea956242016-03-21 15:45:56 +0000732 * A boolean extra indicating whether device encryption can be skipped as part of device owner
733 * or managed profile provisioning.
Julia Reynoldsa9ec70b2015-02-02 09:54:26 -0500734 *
Craig Lafayette3cc72ba2015-06-26 11:51:04 -0400735 * <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} or an intent with action
Nicolas Prevot64bf7b22015-04-29 14:43:49 +0100736 * {@link #ACTION_PROVISION_MANAGED_DEVICE} that starts device owner provisioning.
Benjamin Franzea956242016-03-21 15:45:56 +0000737 *
738 * <p>From {@link android.os.Build.VERSION_CODES#N} onwards, this is also supported for an
739 * intent with action {@link #ACTION_PROVISION_MANAGED_PROFILE}.
Julia Reynoldsa9ec70b2015-02-02 09:54:26 -0500740 */
741 public static final String EXTRA_PROVISIONING_SKIP_ENCRYPTION =
742 "android.app.extra.PROVISIONING_SKIP_ENCRYPTION";
743
744 /**
Nicolas Prevot8b7991c2015-11-12 17:40:12 +0000745 * A {@link Uri} extra pointing to a logo image. This image will be shown during the
746 * provisioning. If this extra is not passed, a default image will be shown.
747 * <h5>The following URI schemes are accepted:</h5>
748 * <ul>
749 * <li>content ({@link android.content.ContentResolver#SCHEME_CONTENT})</li>
750 * <li>android.resource ({@link android.content.ContentResolver#SCHEME_ANDROID_RESOURCE})</li>
751 * </ul>
752 *
753 * <p> It is the responsability of the caller to provide an image with a reasonable
754 * pixed density for the device.
755 *
756 * <p> If a content: URI is passed, the intent should have the flag
757 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION} and the uri should be added to the
758 * {@link android.content.ClipData} of the intent too.
759 *
760 * <p>Use in an intent with action {@link #ACTION_PROVISION_MANAGED_PROFILE} or
761 * {@link #ACTION_PROVISION_MANAGED_DEVICE}
762 */
763 public static final String EXTRA_PROVISIONING_LOGO_URI =
764 "android.app.extra.PROVISIONING_LOGO_URI";
765
766 /**
Alan Treadway94de8c82016-01-11 10:25:23 +0000767 * A boolean extra indicating if user setup should be skipped, for when provisioning is started
768 * during setup-wizard.
769 *
770 * <p>If unspecified, defaults to {@code true} to match the behavior in
771 * {@link android.os.Build.VERSION_CODES#M} and earlier.
772 *
Alan Treadway1a538d02016-01-18 16:42:30 +0000773 * <p>Use in an intent with action {@link #ACTION_PROVISION_MANAGED_DEVICE} or
774 * {@link #ACTION_PROVISION_MANAGED_USER}.
Alan Treadway94de8c82016-01-11 10:25:23 +0000775 *
776 * @hide
777 */
778 public static final String EXTRA_PROVISIONING_SKIP_USER_SETUP =
779 "android.app.extra.PROVISIONING_SKIP_USER_SETUP";
780
781 /**
Benjamin Franzea956242016-03-21 15:45:56 +0000782 * This MIME type is used for starting the device owner provisioning.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100783 *
Craig Lafayette3cc72ba2015-06-26 11:51:04 -0400784 * <p>During device owner provisioning a device admin app is set as the owner of the device.
785 * A device owner has full control over the device. The device owner can not be modified by the
786 * user and the only way of resetting the device is if the device owner app calls a factory
787 * reset.
788 *
789 * <p> A typical use case would be a device that is owned by a company, but used by either an
790 * employee or client.
791 *
Benjamin Franzea956242016-03-21 15:45:56 +0000792 * <p> The NFC message must be sent to an unprovisioned device.
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100793 *
Sander Alewijnse8c411562014-11-12 18:03:11 +0000794 * <p>The NFC record must contain a serialized {@link java.util.Properties} object which
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100795 * contains the following properties:
796 * <ul>
Andrei Kapishnikov35e71f52015-03-16 17:24:04 -0400797 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME}</li>
798 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}, optional</li>
Sander Alewijnse681bce92014-07-24 16:46:26 +0100799 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER}, optional</li>
Andrei Kapishnikov35e71f52015-03-16 17:24:04 -0400800 * <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM}, optional</li>
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100801 * <li>{@link #EXTRA_PROVISIONING_LOCAL_TIME} (convert to String), optional</li>
802 * <li>{@link #EXTRA_PROVISIONING_TIME_ZONE}, optional</li>
803 * <li>{@link #EXTRA_PROVISIONING_LOCALE}, optional</li>
804 * <li>{@link #EXTRA_PROVISIONING_WIFI_SSID}, optional</li>
805 * <li>{@link #EXTRA_PROVISIONING_WIFI_HIDDEN} (convert to String), optional</li>
806 * <li>{@link #EXTRA_PROVISIONING_WIFI_SECURITY_TYPE}, optional</li>
807 * <li>{@link #EXTRA_PROVISIONING_WIFI_PASSWORD}, optional</li>
808 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_HOST}, optional</li>
809 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_PORT} (convert to String), optional</li>
810 * <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_BYPASS}, optional</li>
Rubin Xu41f2ccb92015-08-05 16:29:13 +0100811 * <li>{@link #EXTRA_PROVISIONING_WIFI_PAC_URL}, optional</li>
812 * <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional, supported from
813 * {@link android.os.Build.VERSION_CODES#M} </li></ul>
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100814 *
Nicolas Prevot18440252015-03-09 14:07:17 +0000815 * <p>
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -0700816 * As of {@link android.os.Build.VERSION_CODES#M}, the properties should contain
Andrei Kapishnikov35e71f52015-03-16 17:24:04 -0400817 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME} instead of
818 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME}, (although specifying only
819 * {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME} is still supported).
Andrei Kapishnikov35e71f52015-03-16 17:24:04 -0400820 */
821 public static final String MIME_TYPE_PROVISIONING_NFC
822 = "application/com.android.managedprovisioning";
823
Sander Alewijnse1cc4ecc2014-06-23 19:56:52 +0100824 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -0800825 * Activity action: ask the user to add a new device administrator to the system.
826 * The desired policy is the ComponentName of the policy in the
827 * {@link #EXTRA_DEVICE_ADMIN} extra field. This will invoke a UI to
828 * bring the user through adding the device administrator to the system (or
829 * allowing them to reject it).
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700830 *
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800831 * <p>You can optionally include the {@link #EXTRA_ADD_EXPLANATION}
832 * field to provide the user with additional explanation (in addition
833 * to your component's description) about what is being added.
Andy Stadlerc25f70a2010-12-08 15:56:45 -0800834 *
835 * <p>If your administrator is already active, this will ordinarily return immediately (without
836 * user intervention). However, if your administrator has been updated and is requesting
837 * additional uses-policy flags, the user will be presented with the new list. New policies
838 * will not be available to the updated administrator until the user has accepted the new list.
Dianne Hackbornd6847842010-01-12 18:14:19 -0800839 */
840 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
841 public static final String ACTION_ADD_DEVICE_ADMIN
842 = "android.app.action.ADD_DEVICE_ADMIN";
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700843
Dianne Hackbornd6847842010-01-12 18:14:19 -0800844 /**
Amith Yamasanibf3a9462014-07-28 14:26:42 -0700845 * @hide
846 * Activity action: ask the user to add a new device administrator as the profile owner
Amith Yamasani814e9872015-03-23 14:04:53 -0700847 * for this user. Only system apps can launch this intent.
Amith Yamasanibf3a9462014-07-28 14:26:42 -0700848 *
Amith Yamasani814e9872015-03-23 14:04:53 -0700849 * <p>The ComponentName of the profile owner admin is passed in the {@link #EXTRA_DEVICE_ADMIN}
850 * extra field. This will invoke a UI to bring the user through adding the profile owner admin
Amith Yamasanibf3a9462014-07-28 14:26:42 -0700851 * to remotely control restrictions on the user.
852 *
Makoto Onukic8a5a552015-11-19 14:29:12 -0800853 * <p>The intent must be invoked via {@link Activity#startActivityForResult} to receive the
Amith Yamasanibf3a9462014-07-28 14:26:42 -0700854 * result of whether or not the user approved the action. If approved, the result will
855 * be {@link Activity#RESULT_OK} and the component will be set as an active admin as well
856 * as a profile owner.
857 *
858 * <p>You can optionally include the {@link #EXTRA_ADD_EXPLANATION}
859 * field to provide the user with additional explanation (in addition
860 * to your component's description) about what is being added.
861 *
Amith Yamasani814e9872015-03-23 14:04:53 -0700862 * <p>If there is already a profile owner active or the caller is not a system app, the
863 * operation will return a failure result.
Amith Yamasanibf3a9462014-07-28 14:26:42 -0700864 */
865 @SystemApi
866 public static final String ACTION_SET_PROFILE_OWNER
867 = "android.app.action.SET_PROFILE_OWNER";
868
869 /**
870 * @hide
871 * Name of the profile owner admin that controls the user.
872 */
873 @SystemApi
874 public static final String EXTRA_PROFILE_OWNER_NAME
875 = "android.app.extra.PROFILE_OWNER_NAME";
876
877 /**
Nicolas Prevot00799002015-07-27 18:15:20 +0100878 * Broadcast action: send when any policy admin changes a policy.
Jim Miller284b62e2010-06-08 14:27:42 -0700879 * This is generally used to find out when a new policy is in effect.
Jim Miller3e5d3fd2011-09-02 17:30:35 -0700880 *
Jim Miller284b62e2010-06-08 14:27:42 -0700881 * @hide
882 */
883 public static final String ACTION_DEVICE_POLICY_MANAGER_STATE_CHANGED
884 = "android.app.action.DEVICE_POLICY_MANAGER_STATE_CHANGED";
885
886 /**
Nicolas Prevot00799002015-07-27 18:15:20 +0100887 * Broadcast action: sent when the device owner is set or changed.
888 *
889 * This broadcast is sent only to the primary user.
890 * @see #ACTION_PROVISION_MANAGED_DEVICE
891 */
892 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
893 public static final String ACTION_DEVICE_OWNER_CHANGED
894 = "android.app.action.DEVICE_OWNER_CHANGED";
895
896 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -0800897 * The ComponentName of the administrator component.
898 *
899 * @see #ACTION_ADD_DEVICE_ADMIN
900 */
901 public static final String EXTRA_DEVICE_ADMIN = "android.app.extra.DEVICE_ADMIN";
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700902
Dianne Hackbornd6847842010-01-12 18:14:19 -0800903 /**
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800904 * An optional CharSequence providing additional explanation for why the
905 * admin is being added.
906 *
907 * @see #ACTION_ADD_DEVICE_ADMIN
908 */
909 public static final String EXTRA_ADD_EXPLANATION = "android.app.extra.ADD_EXPLANATION";
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700910
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800911 /**
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700912 * Activity action: have the user enter a new password. This activity should
913 * be launched after using {@link #setPasswordQuality(ComponentName, int)},
914 * or {@link #setPasswordMinimumLength(ComponentName, int)} to have the user
915 * enter a new password that meets the current requirements. You can use
916 * {@link #isActivePasswordSufficient()} to determine whether you need to
917 * have the user select a new password in order to meet the current
918 * constraints. Upon being resumed from this activity, you can check the new
919 * password characteristics to see if they are sufficient.
Benjamin Franzc9921092016-01-08 17:17:44 +0000920 *
921 * If the intent is launched from within a managed profile with a profile
922 * owner built against {@link android.os.Build.VERSION_CODES#M} or before,
923 * this will trigger entering a new password for the parent of the profile.
924 * For all other cases it will trigger entering a new password for the user
925 * or profile it is launched from.
Esteban Talaverac1c83592016-02-17 17:56:15 +0000926 *
927 * @see #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD
Dianne Hackbornd6847842010-01-12 18:14:19 -0800928 */
929 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
930 public static final String ACTION_SET_NEW_PASSWORD
931 = "android.app.action.SET_NEW_PASSWORD";
Amith Yamasanibf3a9462014-07-28 14:26:42 -0700932
Nicolas Prevot10fa67c2014-03-24 13:44:38 +0000933 /**
Benjamin Franzc9921092016-01-08 17:17:44 +0000934 * Activity action: have the user enter a new password for the parent profile.
935 * If the intent is launched from within a managed profile, this will trigger
936 * entering a new password for the parent of the profile. In all other cases
937 * the behaviour is identical to {@link #ACTION_SET_NEW_PASSWORD}.
938 */
939 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
940 public static final String ACTION_SET_NEW_PARENT_PROFILE_PASSWORD
941 = "android.app.action.SET_NEW_PARENT_PROFILE_PASSWORD";
942
943 /**
Nicolas Prevot2c1c5dd2015-01-12 12:32:56 +0000944 * Flag used by {@link #addCrossProfileIntentFilter} to allow activities in
945 * the parent profile to access intents sent from the managed profile.
946 * That is, when an app in the managed profile calls
947 * {@link Activity#startActivity(Intent)}, the intent can be resolved by a
948 * matching activity in the parent profile.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +0000949 */
Nicolas Prevot86a96732014-09-08 12:13:05 +0100950 public static final int FLAG_PARENT_CAN_ACCESS_MANAGED = 0x0001;
Nicolas Prevot10fa67c2014-03-24 13:44:38 +0000951
952 /**
Nicolas Prevot2c1c5dd2015-01-12 12:32:56 +0000953 * Flag used by {@link #addCrossProfileIntentFilter} to allow activities in
954 * the managed profile to access intents sent from the parent profile.
955 * That is, when an app in the parent profile calls
956 * {@link Activity#startActivity(Intent)}, the intent can be resolved by a
957 * matching activity in the managed profile.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +0000958 */
Nicolas Prevot86a96732014-09-08 12:13:05 +0100959 public static final int FLAG_MANAGED_CAN_ACCESS_PARENT = 0x0002;
Konstantin Lopyrev32558232010-05-20 16:18:05 -0700960
Dianne Hackbornd6847842010-01-12 18:14:19 -0800961 /**
Rubin Xu5faad8e2015-04-20 17:43:48 +0100962 * Broadcast action: notify that a new local system update policy has been set by the device
963 * owner. The new policy can be retrieved by {@link #getSystemUpdatePolicy()}.
Rubin Xu8027a4f2015-03-10 17:52:37 +0000964 */
965 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Rubin Xu5faad8e2015-04-20 17:43:48 +0100966 public static final String ACTION_SYSTEM_UPDATE_POLICY_CHANGED
967 = "android.app.action.SYSTEM_UPDATE_POLICY_CHANGED";
Rubin Xu8027a4f2015-03-10 17:52:37 +0000968
Amith Yamasanid49489b2015-04-28 14:00:26 -0700969 /**
970 * Permission policy to prompt user for new permission requests for runtime permissions.
971 * Already granted or denied permissions are not affected by this.
972 */
973 public static final int PERMISSION_POLICY_PROMPT = 0;
974
975 /**
976 * Permission policy to always grant new permission requests for runtime permissions.
977 * Already granted or denied permissions are not affected by this.
978 */
979 public static final int PERMISSION_POLICY_AUTO_GRANT = 1;
980
981 /**
982 * Permission policy to always deny new permission requests for runtime permissions.
983 * Already granted or denied permissions are not affected by this.
984 */
985 public static final int PERMISSION_POLICY_AUTO_DENY = 2;
986
Svet Ganovd8ecc5a2015-05-20 10:45:43 -0700987 /**
988 * Runtime permission state: The user can manage the permission
989 * through the UI.
990 */
991 public static final int PERMISSION_GRANT_STATE_DEFAULT = 0;
992
993 /**
994 * Runtime permission state: The permission is granted to the app
995 * and the user cannot manage the permission through the UI.
996 */
997 public static final int PERMISSION_GRANT_STATE_GRANTED = 1;
998
999 /**
1000 * Runtime permission state: The permission is denied to the app
1001 * and the user cannot manage the permission through the UI.
1002 */
1003 public static final int PERMISSION_GRANT_STATE_DENIED = 2;
Rubin Xu8027a4f2015-03-10 17:52:37 +00001004
1005 /**
Alan Treadwayafad8782016-01-19 15:15:08 +00001006 * No management for current user in-effect. This is the default.
1007 * @hide
1008 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00001009 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00001010 public static final int STATE_USER_UNMANAGED = 0;
1011
1012 /**
1013 * Management partially setup, user setup needs to be completed.
1014 * @hide
1015 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00001016 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00001017 public static final int STATE_USER_SETUP_INCOMPLETE = 1;
1018
1019 /**
1020 * Management partially setup, user setup completed.
1021 * @hide
1022 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00001023 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00001024 public static final int STATE_USER_SETUP_COMPLETE = 2;
1025
1026 /**
1027 * Management setup and active on current user.
1028 * @hide
1029 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00001030 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00001031 public static final int STATE_USER_SETUP_FINALIZED = 3;
1032
1033 /**
1034 * Management partially setup on a managed profile.
1035 * @hide
1036 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00001037 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00001038 public static final int STATE_USER_PROFILE_COMPLETE = 4;
1039
1040 /**
1041 * @hide
1042 */
1043 @IntDef({STATE_USER_UNMANAGED, STATE_USER_SETUP_INCOMPLETE, STATE_USER_SETUP_COMPLETE,
1044 STATE_USER_SETUP_FINALIZED, STATE_USER_PROFILE_COMPLETE})
1045 @Retention(RetentionPolicy.SOURCE)
1046 public @interface UserProvisioningState {}
1047
1048 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001049 * Return true if the given administrator component is currently active (enabled) in the system.
1050 *
1051 * @param admin The administrator component to check for.
1052 * @return {@code true} if {@code admin} is currently enabled in the system, {@code false}
1053 * otherwise
Dianne Hackbornd6847842010-01-12 18:14:19 -08001054 */
Robin Lee25e26452015-06-02 09:56:29 -07001055 public boolean isAdminActive(@NonNull ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001056 return isAdminActiveAsUser(admin, myUserId());
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01001057 }
1058
1059 /**
1060 * @see #isAdminActive(ComponentName)
1061 * @hide
1062 */
Robin Lee25e26452015-06-02 09:56:29 -07001063 public boolean isAdminActiveAsUser(@NonNull ComponentName admin, int userId) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001064 if (mService != null) {
1065 try {
Robin Lee25e26452015-06-02 09:56:29 -07001066 return mService.isAdminActive(admin, userId);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001067 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001068 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001069 }
1070 }
1071 return false;
1072 }
Fyodor Kupolov96fb9322014-12-01 15:08:09 -08001073 /**
1074 * Return true if the given administrator component is currently being removed
1075 * for the user.
1076 * @hide
1077 */
Robin Lee25e26452015-06-02 09:56:29 -07001078 public boolean isRemovingAdmin(@NonNull ComponentName admin, int userId) {
Fyodor Kupolov96fb9322014-12-01 15:08:09 -08001079 if (mService != null) {
1080 try {
Robin Lee25e26452015-06-02 09:56:29 -07001081 return mService.isRemovingAdmin(admin, userId);
Fyodor Kupolov96fb9322014-12-01 15:08:09 -08001082 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001083 throw e.rethrowFromSystemServer();
Fyodor Kupolov96fb9322014-12-01 15:08:09 -08001084 }
1085 }
1086 return false;
1087 }
1088
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001089
Dianne Hackbornd6847842010-01-12 18:14:19 -08001090 /**
Robin Lee25e26452015-06-02 09:56:29 -07001091 * Return a list of all currently active device administrators' component
1092 * names. If there are no administrators {@code null} may be
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001093 * returned.
1094 */
1095 public List<ComponentName> getActiveAdmins() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01001096 throwIfParentInstance("getActiveAdmins");
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001097 return getActiveAdminsAsUser(myUserId());
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01001098 }
1099
1100 /**
1101 * @see #getActiveAdmins()
1102 * @hide
1103 */
1104 public List<ComponentName> getActiveAdminsAsUser(int userId) {
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001105 if (mService != null) {
1106 try {
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01001107 return mService.getActiveAdmins(userId);
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001108 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001109 throw e.rethrowFromSystemServer();
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001110 }
1111 }
1112 return null;
1113 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001114
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001115 /**
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001116 * Used by package administration code to determine if a package can be stopped
1117 * or uninstalled.
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001118 * @hide
1119 */
1120 public boolean packageHasActiveAdmins(String packageName) {
Amith Yamasanica5d6d22016-02-16 13:58:46 -08001121 return packageHasActiveAdmins(packageName, myUserId());
1122 }
1123
1124 /**
1125 * Used by package administration code to determine if a package can be stopped
1126 * or uninstalled.
1127 * @hide
1128 */
1129 public boolean packageHasActiveAdmins(String packageName, int userId) {
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001130 if (mService != null) {
1131 try {
Amith Yamasanica5d6d22016-02-16 13:58:46 -08001132 return mService.packageHasActiveAdmins(packageName, userId);
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001133 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001134 throw e.rethrowFromSystemServer();
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001135 }
1136 }
1137 return false;
1138 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001139
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001140 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -08001141 * Remove a current administration component. This can only be called
1142 * by the application that owns the administration component; if you
1143 * try to remove someone else's component, a security exception will be
1144 * thrown.
Esteban Talavera552a5612016-02-19 17:02:24 +00001145 *
1146 * <p>Note that the operation is not synchronous and the admin might still be active (as
1147 * indicated by {@link #getActiveAdmins()}) by the time this method returns.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001148 *
1149 * @param admin The administration compononent to remove.
1150 * @throws SecurityException if the caller is not in the owner application of {@code admin}.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001151 */
Robin Lee25e26452015-06-02 09:56:29 -07001152 public void removeActiveAdmin(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01001153 throwIfParentInstance("removeActiveAdmin");
Dianne Hackbornd6847842010-01-12 18:14:19 -08001154 if (mService != null) {
1155 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001156 mService.removeActiveAdmin(admin, myUserId());
Dianne Hackbornd6847842010-01-12 18:14:19 -08001157 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001158 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001159 }
1160 }
1161 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001162
Dianne Hackbornd6847842010-01-12 18:14:19 -08001163 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001164 * Returns true if an administrator has been granted a particular device policy. This can be
1165 * used to check whether the administrator was activated under an earlier set of policies, but
1166 * requires additional policies after an upgrade.
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001167 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001168 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. Must be an
1169 * active administrator, or an exception will be thrown.
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001170 * @param usesPolicy Which uses-policy to check, as defined in {@link DeviceAdminInfo}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001171 * @throws SecurityException if {@code admin} is not an active administrator.
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001172 */
Robin Lee25e26452015-06-02 09:56:29 -07001173 public boolean hasGrantedPolicy(@NonNull ComponentName admin, int usesPolicy) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01001174 throwIfParentInstance("hasGrantedPolicy");
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001175 if (mService != null) {
1176 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001177 return mService.hasGrantedPolicy(admin, usesPolicy, myUserId());
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001178 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001179 throw e.rethrowFromSystemServer();
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001180 }
1181 }
1182 return false;
1183 }
1184
1185 /**
Clara Bayarria1771112015-12-18 16:29:18 +00001186 * Returns true if the Profile Challenge is available to use for the given profile user.
1187 *
1188 * @hide
1189 */
1190 public boolean isSeparateProfileChallengeAllowed(int userHandle) {
1191 if (mService != null) {
1192 try {
1193 return mService.isSeparateProfileChallengeAllowed(userHandle);
1194 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001195 throw e.rethrowFromSystemServer();
Clara Bayarria1771112015-12-18 16:29:18 +00001196 }
1197 }
1198 return false;
1199 }
1200
1201 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001202 * Constant for {@link #setPasswordQuality}: the policy has no requirements
1203 * for the password. Note that quality constants are ordered so that higher
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001204 * values are more restrictive.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001205 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001206 public static final int PASSWORD_QUALITY_UNSPECIFIED = 0;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001207
Dianne Hackbornd6847842010-01-12 18:14:19 -08001208 /**
Jim Miller3e5d3fd2011-09-02 17:30:35 -07001209 * Constant for {@link #setPasswordQuality}: the policy allows for low-security biometric
1210 * recognition technology. This implies technologies that can recognize the identity of
1211 * an individual to about a 3 digit PIN (false detection is less than 1 in 1,000).
1212 * Note that quality constants are ordered so that higher values are more restrictive.
1213 */
1214 public static final int PASSWORD_QUALITY_BIOMETRIC_WEAK = 0x8000;
1215
1216 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001217 * Constant for {@link #setPasswordQuality}: the policy requires some kind
Benjamin Franzc6a96532015-06-16 11:23:38 +01001218 * of password or pattern, but doesn't care what it is. Note that quality constants
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001219 * are ordered so that higher values are more restrictive.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001220 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001221 public static final int PASSWORD_QUALITY_SOMETHING = 0x10000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001222
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001223 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001224 * Constant for {@link #setPasswordQuality}: the user must have entered a
1225 * password containing at least numeric characters. Note that quality
1226 * constants are ordered so that higher values are more restrictive.
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001227 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001228 public static final int PASSWORD_QUALITY_NUMERIC = 0x20000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001229
Dianne Hackbornd6847842010-01-12 18:14:19 -08001230 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001231 * Constant for {@link #setPasswordQuality}: the user must have entered a
Jim Miller85516d02014-01-31 17:08:37 -08001232 * password containing at least numeric characters with no repeating (4444)
1233 * or ordered (1234, 4321, 2468) sequences. Note that quality
1234 * constants are ordered so that higher values are more restrictive.
1235 */
1236 public static final int PASSWORD_QUALITY_NUMERIC_COMPLEX = 0x30000;
1237
1238 /**
1239 * Constant for {@link #setPasswordQuality}: the user must have entered a
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -07001240 * password containing at least alphabetic (or other symbol) characters.
1241 * Note that quality constants are ordered so that higher values are more
1242 * restrictive.
1243 */
1244 public static final int PASSWORD_QUALITY_ALPHABETIC = 0x40000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001245
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -07001246 /**
1247 * Constant for {@link #setPasswordQuality}: the user must have entered a
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001248 * password containing at least <em>both></em> numeric <em>and</em>
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -07001249 * alphabetic (or other symbol) characters. Note that quality constants are
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001250 * ordered so that higher values are more restrictive.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001251 */
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -07001252 public static final int PASSWORD_QUALITY_ALPHANUMERIC = 0x50000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001253
Dianne Hackbornd6847842010-01-12 18:14:19 -08001254 /**
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001255 * Constant for {@link #setPasswordQuality}: the user must have entered a
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001256 * password containing at least a letter, a numerical digit and a special
1257 * symbol, by default. With this password quality, passwords can be
1258 * restricted to contain various sets of characters, like at least an
1259 * uppercase letter, etc. These are specified using various methods,
1260 * like {@link #setPasswordMinimumLowerCase(ComponentName, int)}. Note
1261 * that quality constants are ordered so that higher values are more
1262 * restrictive.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001263 */
1264 public static final int PASSWORD_QUALITY_COMPLEX = 0x60000;
1265
1266 /**
Oleksandr Peletskyi0fdcd3d2016-01-13 16:49:56 +01001267 * Constant for {@link #setPasswordQuality}: the user is not allowed to
1268 * modify password. In case this password quality is set, the password is
1269 * managed by a profile owner. The profile owner can set any password,
1270 * as if {@link #PASSWORD_QUALITY_UNSPECIFIED} is used. Note
1271 * that quality constants are ordered so that higher values are more
1272 * restrictive. The value of {@link #PASSWORD_QUALITY_MANAGED} is
1273 * the highest.
1274 * @hide
1275 */
1276 public static final int PASSWORD_QUALITY_MANAGED = 0x80000;
1277
1278 /**
Makoto Onuki5e7e06702016-09-01 18:02:01 -07001279 * @hide
1280 *
1281 * adb shell dpm set-{device,profile}-owner will normally not allow installing an owner to
1282 * a user with accounts. {@link #ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_ALLOWED}
1283 * and {@link #ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_DISALLOWED} are the account features
1284 * used by authenticator to exempt their accounts from this:
1285 *
1286 * <ul>
1287 * <li>Non-test-only DO/PO still can't be installed when there are accounts.
1288 * <p>In order to make an apk test-only, add android:testOnly="true" to the
1289 * &lt;application&gt; tag in the manifest.
1290 *
1291 * <li>Test-only DO/PO can be installed even when there are accounts, as long as all the
1292 * accounts have the {@link #ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_ALLOWED} feature.
1293 * Some authenticators claim to have any features, so to detect it, we also check
1294 * {@link #ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_DISALLOWED} and disallow installing
1295 * if any of the accounts have it.
1296 * </ul>
1297 */
1298 public static final String ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_ALLOWED =
1299 "android.account.DEVICE_OR_PROFILE_OWNER_ALLOWED";
1300
1301 /** @hide See {@link #ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_ALLOWED} */
1302 public static final String ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_DISALLOWED =
1303 "android.account.DEVICE_OR_PROFILE_OWNER_DISALLOWED";
1304
1305 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001306 * Called by an application that is administering the device to set the password restrictions it
1307 * is imposing. After setting this, the user will not be able to enter a new password that is
1308 * not at least as restrictive as what has been set. Note that the current password will remain
1309 * until the user has set a new one, so the change does not take place immediately. To prompt
1310 * the user for a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
Esteban Talaverac1c83592016-02-17 17:56:15 +00001311 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after calling this method.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001312 * <p>
1313 * Quality constants are ordered so that higher values are more restrictive; thus the highest
1314 * requested quality constant (between the policy set here, the user's preference, and any other
1315 * considerations) is the one that is in effect.
1316 * <p>
1317 * The calling device admin must have requested
1318 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1319 * not, a security exception will be thrown.
1320 * <p>
1321 * This method can be called on the {@link DevicePolicyManager} instance returned by
1322 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1323 * profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00001324 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08001325 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001326 * @param quality The new desired quality. One of {@link #PASSWORD_QUALITY_UNSPECIFIED},
1327 * {@link #PASSWORD_QUALITY_SOMETHING}, {@link #PASSWORD_QUALITY_NUMERIC},
1328 * {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX}, {@link #PASSWORD_QUALITY_ALPHABETIC},
1329 * {@link #PASSWORD_QUALITY_ALPHANUMERIC} or {@link #PASSWORD_QUALITY_COMPLEX}.
1330 * @throws SecurityException if {@code admin} is not an active administrator or if {@code admin}
1331 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Dianne Hackbornd6847842010-01-12 18:14:19 -08001332 */
Robin Lee25e26452015-06-02 09:56:29 -07001333 public void setPasswordQuality(@NonNull ComponentName admin, int quality) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001334 if (mService != null) {
1335 try {
Clara Bayarri3e826ef2015-12-14 17:51:22 +00001336 mService.setPasswordQuality(admin, quality, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001337 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001338 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001339 }
1340 }
1341 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001342
Dianne Hackbornd6847842010-01-12 18:14:19 -08001343 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001344 * Retrieve the current minimum password quality for a particular admin or all admins that set
Rubin Xud3609d42016-07-13 18:32:57 +01001345 * restrictions on this user and its participating profiles. Restrictions on profiles that have
Esteban Talaverac1c83592016-02-17 17:56:15 +00001346 * a separate challenge are not taken into account.
1347 *
1348 * <p>This method can be called on the {@link DevicePolicyManager} instance
1349 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1350 * restrictions on the parent profile.
1351 *
Robin Lee25e26452015-06-02 09:56:29 -07001352 * @param admin The name of the admin component to check, or {@code null} to aggregate
Dianne Hackborn254cb442010-01-27 19:23:59 -08001353 * all admins.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001354 */
Robin Lee25e26452015-06-02 09:56:29 -07001355 public int getPasswordQuality(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001356 return getPasswordQuality(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001357 }
1358
1359 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001360 public int getPasswordQuality(@Nullable ComponentName admin, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001361 if (mService != null) {
1362 try {
Clara Bayarri3e826ef2015-12-14 17:51:22 +00001363 return mService.getPasswordQuality(admin, userHandle, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001364 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001365 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001366 }
1367 }
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001368 return PASSWORD_QUALITY_UNSPECIFIED;
Dianne Hackbornd6847842010-01-12 18:14:19 -08001369 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001370
Dianne Hackbornd6847842010-01-12 18:14:19 -08001371 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001372 * Called by an application that is administering the device to set the minimum allowed password
1373 * length. After setting this, the user will not be able to enter a new password that is not at
1374 * least as restrictive as what has been set. Note that the current password will remain until
1375 * the user has set a new one, so the change does not take place immediately. To prompt the user
1376 * for a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
1377 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This constraint is
1378 * only imposed if the administrator has also requested either {@link #PASSWORD_QUALITY_NUMERIC}
1379 * , {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX}, {@link #PASSWORD_QUALITY_ALPHABETIC},
1380 * {@link #PASSWORD_QUALITY_ALPHANUMERIC}, or {@link #PASSWORD_QUALITY_COMPLEX} with
1381 * {@link #setPasswordQuality}.
1382 * <p>
1383 * The calling device admin must have requested
1384 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1385 * not, a security exception will be thrown.
1386 * <p>
1387 * This method can be called on the {@link DevicePolicyManager} instance returned by
1388 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1389 * profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00001390 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08001391 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001392 * @param length The new desired minimum password length. A value of 0 means there is no
1393 * restriction.
1394 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1395 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Dianne Hackbornd6847842010-01-12 18:14:19 -08001396 */
Robin Lee25e26452015-06-02 09:56:29 -07001397 public void setPasswordMinimumLength(@NonNull ComponentName admin, int length) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001398 if (mService != null) {
1399 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001400 mService.setPasswordMinimumLength(admin, length, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001401 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001402 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001403 }
1404 }
1405 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001406
Dianne Hackbornd6847842010-01-12 18:14:19 -08001407 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001408 * Retrieve the current minimum password length for a particular admin or all admins that set
Rubin Xud3609d42016-07-13 18:32:57 +01001409 * restrictions on this user and its participating profiles. Restrictions on profiles that have
Esteban Talaverac1c83592016-02-17 17:56:15 +00001410 * a separate challenge are not taken into account.
1411 *
1412 * <p>This method can be called on the {@link DevicePolicyManager} instance
1413 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1414 * restrictions on the parent profile.
1415 *
Jessica Hummel91da58d2014-04-10 17:39:43 +01001416 * user and its profiles or a particular one.
Robin Lee25e26452015-06-02 09:56:29 -07001417 * @param admin The name of the admin component to check, or {@code null} to aggregate
Dianne Hackborn254cb442010-01-27 19:23:59 -08001418 * all admins.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001419 */
Robin Lee25e26452015-06-02 09:56:29 -07001420 public int getPasswordMinimumLength(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001421 return getPasswordMinimumLength(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001422 }
1423
1424 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001425 public int getPasswordMinimumLength(@Nullable ComponentName admin, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001426 if (mService != null) {
1427 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001428 return mService.getPasswordMinimumLength(admin, userHandle, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001429 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001430 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001431 }
1432 }
1433 return 0;
1434 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001435
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001436 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001437 * Called by an application that is administering the device to set the minimum number of upper
1438 * case letters required in the password. After setting this, the user will not be able to enter
1439 * a new password that is not at least as restrictive as what has been set. Note that the
1440 * current password will remain until the user has set a new one, so the change does not take
1441 * place immediately. To prompt the user for a new password, use
1442 * {@link #ACTION_SET_NEW_PASSWORD} or {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after
1443 * setting this value. This constraint is only imposed if the administrator has also requested
1444 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The default value is 0.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001445 * <p>
1446 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001447 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1448 * not, a security exception will be thrown.
1449 * <p>
1450 * This method can be called on the {@link DevicePolicyManager} instance returned by
1451 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1452 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001453 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001454 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1455 * @param length The new desired minimum number of upper case letters required in the password.
1456 * A value of 0 means there is no restriction.
1457 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1458 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001459 */
Robin Lee25e26452015-06-02 09:56:29 -07001460 public void setPasswordMinimumUpperCase(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001461 if (mService != null) {
1462 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001463 mService.setPasswordMinimumUpperCase(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001464 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001465 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001466 }
1467 }
1468 }
1469
1470 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001471 * Retrieve the current number of upper case letters required in the password
Rubin Xud3609d42016-07-13 18:32:57 +01001472 * for a particular admin or all admins that set restrictions on this user and
Esteban Talaverac1c83592016-02-17 17:56:15 +00001473 * its participating profiles. Restrictions on profiles that have a separate challenge
1474 * are not taken into account.
Jessica Hummel91da58d2014-04-10 17:39:43 +01001475 * This is the same value as set by
Esteban Talaverac1c83592016-02-17 17:56:15 +00001476 * {@link #setPasswordMinimumUpperCase(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001477 * and only applies when the password quality is
1478 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001479 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001480 * <p>This method can be called on the {@link DevicePolicyManager} instance
1481 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1482 * restrictions on the parent profile.
1483 *
Robin Lee25e26452015-06-02 09:56:29 -07001484 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001485 * aggregate all admins.
1486 * @return The minimum number of upper case letters required in the
1487 * password.
1488 */
Robin Lee25e26452015-06-02 09:56:29 -07001489 public int getPasswordMinimumUpperCase(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001490 return getPasswordMinimumUpperCase(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001491 }
1492
1493 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001494 public int getPasswordMinimumUpperCase(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001495 if (mService != null) {
1496 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001497 return mService.getPasswordMinimumUpperCase(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001498 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001499 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001500 }
1501 }
1502 return 0;
1503 }
1504
1505 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001506 * Called by an application that is administering the device to set the minimum number of lower
1507 * case letters required in the password. After setting this, the user will not be able to enter
1508 * a new password that is not at least as restrictive as what has been set. Note that the
1509 * current password will remain until the user has set a new one, so the change does not take
1510 * place immediately. To prompt the user for a new password, use
1511 * {@link #ACTION_SET_NEW_PASSWORD} or {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after
1512 * setting this value. This constraint is only imposed if the administrator has also requested
1513 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The default value is 0.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001514 * <p>
1515 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001516 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1517 * not, a security exception will be thrown.
1518 * <p>
1519 * This method can be called on the {@link DevicePolicyManager} instance returned by
1520 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1521 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001522 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001523 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1524 * @param length The new desired minimum number of lower case letters required in the password.
1525 * A value of 0 means there is no restriction.
1526 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1527 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001528 */
Robin Lee25e26452015-06-02 09:56:29 -07001529 public void setPasswordMinimumLowerCase(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001530 if (mService != null) {
1531 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001532 mService.setPasswordMinimumLowerCase(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001533 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001534 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001535 }
1536 }
1537 }
1538
1539 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001540 * Retrieve the current number of lower case letters required in the password
Rubin Xud3609d42016-07-13 18:32:57 +01001541 * for a particular admin or all admins that set restrictions on this user
Esteban Talaverac1c83592016-02-17 17:56:15 +00001542 * and its participating profiles. Restrictions on profiles that have
1543 * a separate challenge are not taken into account.
Jessica Hummel91da58d2014-04-10 17:39:43 +01001544 * This is the same value as set by
Esteban Talaverac1c83592016-02-17 17:56:15 +00001545 * {@link #setPasswordMinimumLowerCase(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001546 * and only applies when the password quality is
1547 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001548 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001549 * <p>This method can be called on the {@link DevicePolicyManager} instance
1550 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1551 * restrictions on the parent profile.
1552 *
Robin Lee25e26452015-06-02 09:56:29 -07001553 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001554 * aggregate all admins.
1555 * @return The minimum number of lower case letters required in the
1556 * password.
1557 */
Robin Lee25e26452015-06-02 09:56:29 -07001558 public int getPasswordMinimumLowerCase(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001559 return getPasswordMinimumLowerCase(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001560 }
1561
1562 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001563 public int getPasswordMinimumLowerCase(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001564 if (mService != null) {
1565 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001566 return mService.getPasswordMinimumLowerCase(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001567 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001568 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001569 }
1570 }
1571 return 0;
1572 }
1573
1574 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001575 * Called by an application that is administering the device to set the minimum number of
1576 * letters required in the password. After setting this, the user will not be able to enter a
1577 * new password that is not at least as restrictive as what has been set. Note that the current
1578 * password will remain until the user has set a new one, so the change does not take place
1579 * immediately. To prompt the user for a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
1580 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This constraint is
1581 * only imposed if the administrator has also requested {@link #PASSWORD_QUALITY_COMPLEX} with
1582 * {@link #setPasswordQuality}. The default value is 1.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001583 * <p>
1584 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001585 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1586 * not, a security exception will be thrown.
1587 * <p>
1588 * This method can be called on the {@link DevicePolicyManager} instance returned by
1589 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1590 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001591 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001592 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1593 * @param length The new desired minimum number of letters required in the password. A value of
1594 * 0 means there is no restriction.
1595 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1596 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001597 */
Robin Lee25e26452015-06-02 09:56:29 -07001598 public void setPasswordMinimumLetters(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001599 if (mService != null) {
1600 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001601 mService.setPasswordMinimumLetters(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001602 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001603 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001604 }
1605 }
1606 }
1607
1608 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001609 * Retrieve the current number of letters required in the password
Rubin Xud3609d42016-07-13 18:32:57 +01001610 * for a particular admin or all admins that set restrictions on this user
Esteban Talaverac1c83592016-02-17 17:56:15 +00001611 * and its participating profiles. Restrictions on profiles that have
1612 * a separate challenge are not taken into account.
1613 * This is the same value as set by
1614 * {@link #setPasswordMinimumLetters(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001615 * and only applies when the password quality is
1616 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001617 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001618 * <p>This method can be called on the {@link DevicePolicyManager} instance
1619 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1620 * restrictions on the parent profile.
1621 *
Robin Lee25e26452015-06-02 09:56:29 -07001622 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001623 * aggregate all admins.
1624 * @return The minimum number of letters required in the password.
1625 */
Robin Lee25e26452015-06-02 09:56:29 -07001626 public int getPasswordMinimumLetters(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001627 return getPasswordMinimumLetters(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001628 }
1629
1630 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001631 public int getPasswordMinimumLetters(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001632 if (mService != null) {
1633 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001634 return mService.getPasswordMinimumLetters(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001635 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001636 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001637 }
1638 }
1639 return 0;
1640 }
1641
1642 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001643 * Called by an application that is administering the device to set the minimum number of
1644 * numerical digits required in the password. After setting this, the user will not be able to
1645 * enter a new password that is not at least as restrictive as what has been set. Note that the
1646 * current password will remain until the user has set a new one, so the change does not take
1647 * place immediately. To prompt the user for a new password, use
1648 * {@link #ACTION_SET_NEW_PASSWORD} or {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after
1649 * setting this value. This constraint is only imposed if the administrator has also requested
1650 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The default value is 1.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001651 * <p>
1652 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001653 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1654 * not, a security exception will be thrown.
1655 * <p>
1656 * This method can be called on the {@link DevicePolicyManager} instance returned by
1657 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1658 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001659 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001660 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1661 * @param length The new desired minimum number of numerical digits required in the password. A
1662 * value of 0 means there is no restriction.
1663 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1664 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001665 */
Robin Lee25e26452015-06-02 09:56:29 -07001666 public void setPasswordMinimumNumeric(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001667 if (mService != null) {
1668 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001669 mService.setPasswordMinimumNumeric(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001670 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001671 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001672 }
1673 }
1674 }
1675
1676 /**
1677 * Retrieve the current number of numerical digits required in the password
Rubin Xud3609d42016-07-13 18:32:57 +01001678 * for a particular admin or all admins that set restrictions on this user
Esteban Talaverac1c83592016-02-17 17:56:15 +00001679 * and its participating profiles. Restrictions on profiles that have
1680 * a separate challenge are not taken into account.
Jessica Hummel91da58d2014-04-10 17:39:43 +01001681 * This is the same value as set by
Esteban Talaverac1c83592016-02-17 17:56:15 +00001682 * {@link #setPasswordMinimumNumeric(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001683 * and only applies when the password quality is
1684 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001685 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001686 * <p>This method can be called on the {@link DevicePolicyManager} instance
1687 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1688 * restrictions on the parent profile.
1689 *
Robin Lee25e26452015-06-02 09:56:29 -07001690 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001691 * aggregate all admins.
1692 * @return The minimum number of numerical digits required in the password.
1693 */
Robin Lee25e26452015-06-02 09:56:29 -07001694 public int getPasswordMinimumNumeric(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001695 return getPasswordMinimumNumeric(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001696 }
1697
1698 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001699 public int getPasswordMinimumNumeric(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001700 if (mService != null) {
1701 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001702 return mService.getPasswordMinimumNumeric(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001703 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001704 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001705 }
1706 }
1707 return 0;
1708 }
1709
1710 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001711 * Called by an application that is administering the device to set the minimum number of
1712 * symbols required in the password. After setting this, the user will not be able to enter a
1713 * new password that is not at least as restrictive as what has been set. Note that the current
1714 * password will remain until the user has set a new one, so the change does not take place
1715 * immediately. To prompt the user for a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
1716 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This constraint is
1717 * only imposed if the administrator has also requested {@link #PASSWORD_QUALITY_COMPLEX} with
1718 * {@link #setPasswordQuality}. The default value is 1.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001719 * <p>
1720 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001721 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1722 * not, a security exception will be thrown.
1723 * <p>
1724 * This method can be called on the {@link DevicePolicyManager} instance returned by
1725 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1726 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001727 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001728 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1729 * @param length The new desired minimum number of symbols required in the password. A value of
1730 * 0 means there is no restriction.
1731 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1732 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001733 */
Robin Lee25e26452015-06-02 09:56:29 -07001734 public void setPasswordMinimumSymbols(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001735 if (mService != null) {
1736 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001737 mService.setPasswordMinimumSymbols(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001738 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001739 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001740 }
1741 }
1742 }
1743
1744 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001745 * Retrieve the current number of symbols required in the password
Rubin Xud3609d42016-07-13 18:32:57 +01001746 * for a particular admin or all admins that set restrictions on this user
Esteban Talaverac1c83592016-02-17 17:56:15 +00001747 * and its participating profiles. Restrictions on profiles that have
1748 * a separate challenge are not taken into account. This is the same value as
1749 * set by {@link #setPasswordMinimumSymbols(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001750 * and only applies when the password quality is
1751 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001752 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001753 * <p>This method can be called on the {@link DevicePolicyManager} instance
1754 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1755 * restrictions on the parent profile.
1756 *
Robin Lee25e26452015-06-02 09:56:29 -07001757 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001758 * aggregate all admins.
1759 * @return The minimum number of symbols required in the password.
1760 */
Robin Lee25e26452015-06-02 09:56:29 -07001761 public int getPasswordMinimumSymbols(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001762 return getPasswordMinimumSymbols(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001763 }
1764
1765 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001766 public int getPasswordMinimumSymbols(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001767 if (mService != null) {
1768 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001769 return mService.getPasswordMinimumSymbols(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001770 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001771 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001772 }
1773 }
1774 return 0;
1775 }
1776
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001777 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001778 * Called by an application that is administering the device to set the minimum number of
1779 * non-letter characters (numerical digits or symbols) required in the password. After setting
1780 * this, the user will not be able to enter a new password that is not at least as restrictive
1781 * as what has been set. Note that the current password will remain until the user has set a new
1782 * one, so the change does not take place immediately. To prompt the user for a new password,
1783 * use {@link #ACTION_SET_NEW_PASSWORD} or {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after
1784 * setting this value. This constraint is only imposed if the administrator has also requested
1785 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The default value is 0.
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001786 * <p>
1787 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001788 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1789 * not, a security exception will be thrown.
1790 * <p>
1791 * This method can be called on the {@link DevicePolicyManager} instance returned by
1792 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1793 * profile.
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001794 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001795 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1796 * @param length The new desired minimum number of letters required in the password. A value of
1797 * 0 means there is no restriction.
1798 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1799 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001800 */
Robin Lee25e26452015-06-02 09:56:29 -07001801 public void setPasswordMinimumNonLetter(@NonNull ComponentName admin, int length) {
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001802 if (mService != null) {
1803 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001804 mService.setPasswordMinimumNonLetter(admin, length, mParentInstance);
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001805 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001806 throw e.rethrowFromSystemServer();
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001807 }
1808 }
1809 }
1810
1811 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001812 * Retrieve the current number of non-letter characters required in the password
Rubin Xud3609d42016-07-13 18:32:57 +01001813 * for a particular admin or all admins that set restrictions on this user
Esteban Talaverac1c83592016-02-17 17:56:15 +00001814 * and its participating profiles. Restrictions on profiles that have
1815 * a separate challenge are not taken into account.
Jessica Hummel91da58d2014-04-10 17:39:43 +01001816 * This is the same value as set by
Esteban Talaverac1c83592016-02-17 17:56:15 +00001817 * {@link #setPasswordMinimumNonLetter(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001818 * and only applies when the password quality is
1819 * {@link #PASSWORD_QUALITY_COMPLEX}.
1820 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001821 * <p>This method can be called on the {@link DevicePolicyManager} instance
1822 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1823 * restrictions on the parent profile.
1824 *
Robin Lee25e26452015-06-02 09:56:29 -07001825 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001826 * aggregate all admins.
1827 * @return The minimum number of letters required in the password.
1828 */
Robin Lee25e26452015-06-02 09:56:29 -07001829 public int getPasswordMinimumNonLetter(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001830 return getPasswordMinimumNonLetter(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001831 }
1832
1833 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001834 public int getPasswordMinimumNonLetter(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001835 if (mService != null) {
1836 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001837 return mService.getPasswordMinimumNonLetter(admin, userHandle, mParentInstance);
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001838 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001839 throw e.rethrowFromSystemServer();
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001840 }
1841 }
1842 return 0;
1843 }
1844
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001845 /**
1846 * Called by an application that is administering the device to set the length of the password
1847 * history. After setting this, the user will not be able to enter a new password that is the
1848 * same as any password in the history. Note that the current password will remain until the
1849 * user has set a new one, so the change does not take place immediately. To prompt the user for
1850 * a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
1851 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This constraint is
1852 * only imposed if the administrator has also requested either {@link #PASSWORD_QUALITY_NUMERIC}
1853 * , {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX} {@link #PASSWORD_QUALITY_ALPHABETIC}, or
1854 * {@link #PASSWORD_QUALITY_ALPHANUMERIC} with {@link #setPasswordQuality}.
1855 * <p>
1856 * The calling device admin must have requested
1857 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1858 * not, a security exception will be thrown.
1859 * <p>
1860 * This method can be called on the {@link DevicePolicyManager} instance returned by
1861 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1862 * profile.
1863 *
1864 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1865 * @param length The new desired length of password history. A value of 0 means there is no
1866 * restriction.
1867 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1868 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
1869 */
Robin Lee25e26452015-06-02 09:56:29 -07001870 public void setPasswordHistoryLength(@NonNull ComponentName admin, int length) {
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001871 if (mService != null) {
1872 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001873 mService.setPasswordHistoryLength(admin, length, mParentInstance);
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001874 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001875 throw e.rethrowFromSystemServer();
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001876 }
1877 }
1878 }
1879
1880 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001881 * Called by a device admin to set the password expiration timeout. Calling this method will
1882 * restart the countdown for password expiration for the given admin, as will changing the
1883 * device password (for all admins).
1884 * <p>
1885 * The provided timeout is the time delta in ms and will be added to the current time. For
1886 * example, to have the password expire 5 days from now, timeout would be 5 * 86400 * 1000 =
1887 * 432000000 ms for timeout.
1888 * <p>
1889 * To disable password expiration, a value of 0 may be used for timeout.
1890 * <p>
1891 * The calling device admin must have requested
1892 * {@link DeviceAdminInfo#USES_POLICY_EXPIRE_PASSWORD} to be able to call this method; if it has
1893 * not, a security exception will be thrown.
1894 * <p>
1895 * Note that setting the password will automatically reset the expiration time for all active
1896 * admins. Active admins do not need to explicitly call this method in that case.
1897 * <p>
1898 * This method can be called on the {@link DevicePolicyManager} instance returned by
1899 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1900 * profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00001901 *
Jim Millera4e28d12010-11-08 16:15:47 -08001902 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001903 * @param timeout The limit (in ms) that a password can remain in effect. A value of 0 means
1904 * there is no restriction (unlimited).
1905 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1906 * does not use {@link DeviceAdminInfo#USES_POLICY_EXPIRE_PASSWORD}
Jim Millera4e28d12010-11-08 16:15:47 -08001907 */
Robin Lee25e26452015-06-02 09:56:29 -07001908 public void setPasswordExpirationTimeout(@NonNull ComponentName admin, long timeout) {
Jim Millera4e28d12010-11-08 16:15:47 -08001909 if (mService != null) {
1910 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001911 mService.setPasswordExpirationTimeout(admin, timeout, mParentInstance);
Jim Millera4e28d12010-11-08 16:15:47 -08001912 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001913 throw e.rethrowFromSystemServer();
Jim Millera4e28d12010-11-08 16:15:47 -08001914 }
1915 }
1916 }
1917
1918 /**
Jim Miller6b857682011-02-16 16:27:41 -08001919 * Get the password expiration timeout for the given admin. The expiration timeout is the
1920 * recurring expiration timeout provided in the call to
1921 * {@link #setPasswordExpirationTimeout(ComponentName, long)} for the given admin or the
Esteban Talaverac1c83592016-02-17 17:56:15 +00001922 * aggregate of all participating policy administrators if {@code admin} is null. Admins that
1923 * have set restrictions on profiles that have a separate challenge are not taken into account.
1924 *
1925 * <p>This method can be called on the {@link DevicePolicyManager} instance
1926 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1927 * restrictions on the parent profile.
Jim Millera4e28d12010-11-08 16:15:47 -08001928 *
Robin Lee25e26452015-06-02 09:56:29 -07001929 * @param admin The name of the admin component to check, or {@code null} to aggregate all admins.
Jim Millera4e28d12010-11-08 16:15:47 -08001930 * @return The timeout for the given admin or the minimum of all timeouts
1931 */
Robin Lee25e26452015-06-02 09:56:29 -07001932 public long getPasswordExpirationTimeout(@Nullable ComponentName admin) {
Jim Millera4e28d12010-11-08 16:15:47 -08001933 if (mService != null) {
1934 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001935 return mService.getPasswordExpirationTimeout(admin, myUserId(), mParentInstance);
Jim Millera4e28d12010-11-08 16:15:47 -08001936 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001937 throw e.rethrowFromSystemServer();
Jim Millera4e28d12010-11-08 16:15:47 -08001938 }
1939 }
1940 return 0;
1941 }
1942
1943 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001944 * Get the current password expiration time for a particular admin or all admins that set
Rubin Xud3609d42016-07-13 18:32:57 +01001945 * restrictions on this user and its participating profiles. Restrictions on profiles that have
Esteban Talaverac1c83592016-02-17 17:56:15 +00001946 * a separate challenge are not taken into account. If admin is {@code null}, then a composite
1947 * of all expiration times is returned - which will be the minimum of all of them.
1948 *
1949 * <p>This method can be called on the {@link DevicePolicyManager} instance
1950 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1951 * the password expiration for the parent profile.
Jim Millera4e28d12010-11-08 16:15:47 -08001952 *
Robin Lee25e26452015-06-02 09:56:29 -07001953 * @param admin The name of the admin component to check, or {@code null} to aggregate all admins.
Esteban Talaverac1c83592016-02-17 17:56:15 +00001954 * @return The password expiration time, in milliseconds since epoch.
Jim Millera4e28d12010-11-08 16:15:47 -08001955 */
Robin Lee25e26452015-06-02 09:56:29 -07001956 public long getPasswordExpiration(@Nullable ComponentName admin) {
Jim Millera4e28d12010-11-08 16:15:47 -08001957 if (mService != null) {
1958 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001959 return mService.getPasswordExpiration(admin, myUserId(), mParentInstance);
Jim Millera4e28d12010-11-08 16:15:47 -08001960 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001961 throw e.rethrowFromSystemServer();
Jim Millera4e28d12010-11-08 16:15:47 -08001962 }
1963 }
1964 return 0;
1965 }
1966
1967 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001968 * Retrieve the current password history length for a particular admin or all admins that
Rubin Xud3609d42016-07-13 18:32:57 +01001969 * set restrictions on this user and its participating profiles. Restrictions on profiles that
Esteban Talaverac1c83592016-02-17 17:56:15 +00001970 * have a separate challenge are not taken into account.
1971 *
1972 * <p>This method can be called on the {@link DevicePolicyManager} instance
1973 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1974 * restrictions on the parent profile.
1975 *
Robin Lee25e26452015-06-02 09:56:29 -07001976 * @param admin The name of the admin component to check, or {@code null} to aggregate
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001977 * all admins.
1978 * @return The length of the password history
1979 */
Robin Lee25e26452015-06-02 09:56:29 -07001980 public int getPasswordHistoryLength(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001981 return getPasswordHistoryLength(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001982 }
1983
1984 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001985 public int getPasswordHistoryLength(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001986 if (mService != null) {
1987 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001988 return mService.getPasswordHistoryLength(admin, userHandle, mParentInstance);
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001989 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001990 throw e.rethrowFromSystemServer();
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001991 }
1992 }
1993 return 0;
1994 }
1995
Dianne Hackbornd6847842010-01-12 18:14:19 -08001996 /**
Dianne Hackborn254cb442010-01-27 19:23:59 -08001997 * Return the maximum password length that the device supports for a
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001998 * particular password quality.
Dianne Hackborn364f6e32010-01-29 17:38:20 -08001999 * @param quality The quality being interrogated.
Dianne Hackborn254cb442010-01-27 19:23:59 -08002000 * @return Returns the maximum length that the user can enter.
2001 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08002002 public int getPasswordMaximumLength(int quality) {
Dianne Hackborn254cb442010-01-27 19:23:59 -08002003 // Kind-of arbitrary.
2004 return 16;
2005 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002006
Dianne Hackborn254cb442010-01-27 19:23:59 -08002007 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002008 * Determine whether the current password the user has set is sufficient to meet the policy
2009 * requirements (e.g. quality, minimum length) that have been requested by the admins of this
2010 * user and its participating profiles. Restrictions on profiles that have a separate challenge
2011 * are not taken into account.
2012 * <p>
2013 * The calling device admin must have requested
2014 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
2015 * not, a security exception will be thrown.
2016 * <p>
2017 * This method can be called on the {@link DevicePolicyManager} instance returned by
2018 * {@link #getParentProfileInstance(ComponentName)} in order to determine if the password set on
2019 * the parent profile is sufficient.
Esteban Talaverac1c83592016-02-17 17:56:15 +00002020 *
Jessica Hummel91da58d2014-04-10 17:39:43 +01002021 * @return Returns true if the password meets the current requirements, else false.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002022 * @throws SecurityException if the calling application does not own an active administrator
2023 * that uses {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Dianne Hackbornd6847842010-01-12 18:14:19 -08002024 */
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002025 public boolean isActivePasswordSufficient() {
Dianne Hackbornd6847842010-01-12 18:14:19 -08002026 if (mService != null) {
2027 try {
Clara Bayarri3e826ef2015-12-14 17:51:22 +00002028 return mService.isActivePasswordSufficient(myUserId(), mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002029 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002030 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08002031 }
2032 }
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002033 return false;
Dianne Hackbornd6847842010-01-12 18:14:19 -08002034 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002035
Dianne Hackbornd6847842010-01-12 18:14:19 -08002036 /**
Clara Bayarrid7693912016-01-22 17:26:31 +00002037 * Determine whether the current profile password the user has set is sufficient
Esteban Talaverac1c83592016-02-17 17:56:15 +00002038 * to meet the policy requirements (e.g. quality, minimum length) that have been
Clara Bayarrid7693912016-01-22 17:26:31 +00002039 * requested by the admins of the parent user and its profiles.
2040 *
2041 * @param userHandle the userId of the profile to check the password for.
2042 * @return Returns true if the password would meet the current requirements, else false.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002043 * @throws SecurityException if {@code userHandle} is not a managed profile.
Clara Bayarrid7693912016-01-22 17:26:31 +00002044 * @hide
2045 */
2046 public boolean isProfileActivePasswordSufficientForParent(int userHandle) {
2047 if (mService != null) {
2048 try {
2049 return mService.isProfileActivePasswordSufficientForParent(userHandle);
2050 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002051 throw e.rethrowFromSystemServer();
Clara Bayarrid7693912016-01-22 17:26:31 +00002052 }
2053 }
2054 return false;
2055 }
2056
2057 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002058 * Retrieve the number of times the user has failed at entering a password since that last
2059 * successful password entry.
2060 * <p>
2061 * This method can be called on the {@link DevicePolicyManager} instance returned by
2062 * {@link #getParentProfileInstance(ComponentName)} in order to retrieve the number of failed
2063 * password attemts for the parent user.
2064 * <p>
2065 * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN}
2066 * to be able to call this method; if it has not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002067 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002068 * @return The number of times user has entered an incorrect password since the last correct
2069 * password entry.
2070 * @throws SecurityException if the calling application does not own an active administrator
2071 * that uses {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN}
Dianne Hackbornd6847842010-01-12 18:14:19 -08002072 */
2073 public int getCurrentFailedPasswordAttempts() {
Clara Bayarri51e41ad2016-02-11 17:48:53 +00002074 return getCurrentFailedPasswordAttempts(myUserId());
2075 }
2076
2077 /**
2078 * Retrieve the number of times the given user has failed at entering a
2079 * password since that last successful password entry.
2080 *
2081 * <p>The calling device admin must have requested
2082 * {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} to be able to call this method; if it has
2083 * not and it is not the system uid, a security exception will be thrown.
2084 *
2085 * @hide
2086 */
2087 public int getCurrentFailedPasswordAttempts(int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08002088 if (mService != null) {
2089 try {
Clara Bayarri51e41ad2016-02-11 17:48:53 +00002090 return mService.getCurrentFailedPasswordAttempts(userHandle, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002091 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002092 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08002093 }
2094 }
2095 return -1;
2096 }
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002097
2098 /**
Craig Lafayette4e401fa2015-05-07 10:24:02 -04002099 * Queries whether {@link #RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT} flag is set.
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002100 *
Craig Lafayette4e401fa2015-05-07 10:24:02 -04002101 * @return true if RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT flag is set.
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002102 * @hide
2103 */
2104 public boolean getDoNotAskCredentialsOnBoot() {
2105 if (mService != null) {
2106 try {
2107 return mService.getDoNotAskCredentialsOnBoot();
2108 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002109 throw e.rethrowFromSystemServer();
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002110 }
2111 }
2112 return false;
2113 }
2114
2115 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002116 * Setting this to a value greater than zero enables a built-in policy that will perform a
2117 * device or profile wipe after too many incorrect device-unlock passwords have been entered.
2118 * This built-in policy combines watching for failed passwords and wiping the device, and
2119 * requires that you request both {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} and
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002120 * {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA}}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002121 * <p>
2122 * To implement any other policy (e.g. wiping data for a particular application only, erasing or
2123 * revoking credentials, or reporting the failure to a server), you should implement
2124 * {@link DeviceAdminReceiver#onPasswordFailed(Context, android.content.Intent)} instead. Do not
2125 * use this API, because if the maximum count is reached, the device or profile will be wiped
2126 * immediately, and your callback will not be invoked.
2127 * <p>
2128 * This method can be called on the {@link DevicePolicyManager} instance returned by
2129 * {@link #getParentProfileInstance(ComponentName)} in order to set a value on the parent
2130 * profile.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002131 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08002132 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002133 * @param num The number of failed password attempts at which point the device or profile will
2134 * be wiped.
2135 * @throws SecurityException if {@code admin} is not an active administrator or does not use
2136 * both {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} and
2137 * {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA}.
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002138 */
Robin Lee25e26452015-06-02 09:56:29 -07002139 public void setMaximumFailedPasswordsForWipe(@NonNull ComponentName admin, int num) {
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002140 if (mService != null) {
2141 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002142 mService.setMaximumFailedPasswordsForWipe(admin, num, mParentInstance);
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002143 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002144 throw e.rethrowFromSystemServer();
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002145 }
2146 }
2147 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002148
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002149 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00002150 * Retrieve the current maximum number of login attempts that are allowed before the device
Rubin Xud3609d42016-07-13 18:32:57 +01002151 * or profile is wiped, for a particular admin or all admins that set restrictions on this user
Esteban Talaverac1c83592016-02-17 17:56:15 +00002152 * and its participating profiles. Restrictions on profiles that have a separate challenge are
2153 * not taken into account.
2154 *
2155 * <p>This method can be called on the {@link DevicePolicyManager} instance
2156 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
2157 * the value for the parent profile.
2158 *
Robin Lee25e26452015-06-02 09:56:29 -07002159 * @param admin The name of the admin component to check, or {@code null} to aggregate
Dianne Hackborn254cb442010-01-27 19:23:59 -08002160 * all admins.
2161 */
Robin Lee25e26452015-06-02 09:56:29 -07002162 public int getMaximumFailedPasswordsForWipe(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002163 return getMaximumFailedPasswordsForWipe(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002164 }
2165
2166 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07002167 public int getMaximumFailedPasswordsForWipe(@Nullable ComponentName admin, int userHandle) {
Dianne Hackborn254cb442010-01-27 19:23:59 -08002168 if (mService != null) {
2169 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002170 return mService.getMaximumFailedPasswordsForWipe(
2171 admin, userHandle, mParentInstance);
Dianne Hackborn254cb442010-01-27 19:23:59 -08002172 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002173 throw e.rethrowFromSystemServer();
Dianne Hackborn254cb442010-01-27 19:23:59 -08002174 }
2175 }
2176 return 0;
2177 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002178
Dianne Hackborn254cb442010-01-27 19:23:59 -08002179 /**
Amith Yamasani3a3d2122014-10-29 11:41:31 -07002180 * Returns the profile with the smallest maximum failed passwords for wipe,
2181 * for the given user. So for primary user, it might return the primary or
2182 * a managed profile. For a secondary user, it would be the same as the
2183 * user passed in.
2184 * @hide Used only by Keyguard
2185 */
2186 public int getProfileWithMinimumFailedPasswordsForWipe(int userHandle) {
2187 if (mService != null) {
2188 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002189 return mService.getProfileWithMinimumFailedPasswordsForWipe(
2190 userHandle, mParentInstance);
Amith Yamasani3a3d2122014-10-29 11:41:31 -07002191 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002192 throw e.rethrowFromSystemServer();
Amith Yamasani3a3d2122014-10-29 11:41:31 -07002193 }
2194 }
2195 return UserHandle.USER_NULL;
2196 }
2197
2198 /**
Dianne Hackborn87bba1e2010-02-26 17:25:54 -08002199 * Flag for {@link #resetPassword}: don't allow other admins to change
2200 * the password again until the user has entered it.
2201 */
2202 public static final int RESET_PASSWORD_REQUIRE_ENTRY = 0x0001;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002203
Dianne Hackborn87bba1e2010-02-26 17:25:54 -08002204 /**
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002205 * Flag for {@link #resetPassword}: don't ask for user credentials on device boot.
2206 * If the flag is set, the device can be booted without asking for user password.
2207 * The absence of this flag does not change the current boot requirements. This flag
2208 * can be set by the device owner only. If the app is not the device owner, the flag
2209 * is ignored. Once the flag is set, it cannot be reverted back without resetting the
2210 * device to factory defaults.
2211 */
Craig Lafayette4e401fa2015-05-07 10:24:02 -04002212 public static final int RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT = 0x0002;
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002213
2214 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002215 * Force a new device unlock password (the password needed to access the entire device, not for
2216 * individual accounts) on the user. This takes effect immediately.
2217 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002218 * <em>Note: This API has been limited as of {@link android.os.Build.VERSION_CODES#N} for
Makoto Onuki70f929e2015-11-11 12:40:15 -08002219 * device admins that are not device owner and not profile owner.
2220 * The password can now only be changed if there is currently no password set. Device owner
Ricky Wai977ade22016-05-24 15:02:41 +01002221 * and profile owner can still do this when user is unlocked and does not have a managed
2222 * profile.</em>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002223 * <p>
2224 * The given password must be sufficient for the current password quality and length constraints
2225 * as returned by {@link #getPasswordQuality(ComponentName)} and
2226 * {@link #getPasswordMinimumLength(ComponentName)}; if it does not meet these constraints, then
2227 * it will be rejected and false returned. Note that the password may be a stronger quality
2228 * (containing alphanumeric characters when the requested quality is only numeric), in which
2229 * case the currently active quality will be increased to match.
2230 * <p>
2231 * Calling with a null or empty password will clear any existing PIN, pattern or password if the
Robin Leece5c4002016-03-23 17:05:03 +00002232 * current password constraints allow it. <em>Note: This will not work in
2233 * {@link android.os.Build.VERSION_CODES#N} and later for managed profiles, or for device admins
2234 * that are not device owner or profile owner. Once set, the password cannot be changed to null
2235 * or empty except by these admins.</em>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002236 * <p>
2237 * The calling device admin must have requested
2238 * {@link DeviceAdminInfo#USES_POLICY_RESET_PASSWORD} to be able to call this method; if it has
2239 * not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002240 *
Adrian Roosf8f56bc2014-11-20 23:55:34 +01002241 * @param password The new password for the user. Null or empty clears the password.
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002242 * @param flags May be 0 or combination of {@link #RESET_PASSWORD_REQUIRE_ENTRY} and
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002243 * {@link #RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT}.
2244 * @return Returns true if the password was applied, or false if it is not acceptable for the
2245 * current constraints or if the user has not been decrypted yet.
2246 * @throws SecurityException if the calling application does not own an active administrator
2247 * that uses {@link DeviceAdminInfo#USES_POLICY_RESET_PASSWORD}
Ricky Wai977ade22016-05-24 15:02:41 +01002248 * @throws IllegalStateException if the calling user is locked or has a managed profile.
Andrew Scull60df33d2016-07-29 16:29:58 +01002249 * @throws IllegalArgumentException if the password does not meet system requirements.
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002250 */
Dianne Hackborn87bba1e2010-02-26 17:25:54 -08002251 public boolean resetPassword(String password, int flags) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002252 throwIfParentInstance("resetPassword");
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002253 if (mService != null) {
2254 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08002255 return mService.resetPassword(password, flags);
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002256 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002257 throw e.rethrowFromSystemServer();
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002258 }
2259 }
2260 return false;
2261 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002262
Dianne Hackbornd6847842010-01-12 18:14:19 -08002263 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002264 * Called by an application that is administering the device to set the maximum time for user
2265 * activity until the device will lock. This limits the length that the user can set. It takes
2266 * effect immediately.
2267 * <p>
2268 * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
2269 * to be able to call this method; if it has not, a security exception will be thrown.
2270 * <p>
2271 * This method can be called on the {@link DevicePolicyManager} instance returned by
2272 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
2273 * profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00002274 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08002275 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002276 * @param timeMs The new desired maximum time to lock in milliseconds. A value of 0 means there
2277 * is no restriction.
2278 * @throws SecurityException if {@code admin} is not an active administrator or it does not use
2279 * {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
Dianne Hackbornd6847842010-01-12 18:14:19 -08002280 */
Robin Lee25e26452015-06-02 09:56:29 -07002281 public void setMaximumTimeToLock(@NonNull ComponentName admin, long timeMs) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08002282 if (mService != null) {
2283 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002284 mService.setMaximumTimeToLock(admin, timeMs, 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 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002290
Dianne Hackbornd6847842010-01-12 18:14:19 -08002291 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00002292 * Retrieve the current maximum time to unlock for a particular admin or all admins that set
Rubin Xud3609d42016-07-13 18:32:57 +01002293 * restrictions on this user and its participating profiles. Restrictions on profiles that have
Esteban Talaverac1c83592016-02-17 17:56:15 +00002294 * a separate challenge are not taken into account.
2295 *
2296 * <p>This method can be called on the {@link DevicePolicyManager} instance
2297 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
2298 * restrictions on the parent profile.
2299 *
Robin Lee25e26452015-06-02 09:56:29 -07002300 * @param admin The name of the admin component to check, or {@code null} to aggregate
Dianne Hackborn254cb442010-01-27 19:23:59 -08002301 * all admins.
Jim Millerd4efaac2014-08-14 18:02:45 -07002302 * @return time in milliseconds for the given admin or the minimum value (strictest) of
Jim Miller76b9b8b2014-08-22 17:04:57 -07002303 * all admins if admin is null. Returns 0 if there are no restrictions.
Dianne Hackbornd6847842010-01-12 18:14:19 -08002304 */
Robin Lee25e26452015-06-02 09:56:29 -07002305 public long getMaximumTimeToLock(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002306 return getMaximumTimeToLock(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002307 }
2308
2309 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07002310 public long getMaximumTimeToLock(@Nullable ComponentName admin, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08002311 if (mService != null) {
2312 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002313 return mService.getMaximumTimeToLock(admin, userHandle, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002314 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002315 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08002316 }
2317 }
2318 return 0;
2319 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002320
Dianne Hackbornd6847842010-01-12 18:14:19 -08002321 /**
Ricky Wai035e9242016-03-18 16:43:31 +00002322 * Returns maximum time to lock that applied by all profiles in this user. We do this because we
2323 * do not have a separate timeout to lock for work challenge only.
2324 *
2325 * @hide
2326 */
2327 public long getMaximumTimeToLockForUserAndProfiles(int userHandle) {
2328 if (mService != null) {
2329 try {
2330 return mService.getMaximumTimeToLockForUserAndProfiles(userHandle);
2331 } catch (RemoteException e) {
2332 throw e.rethrowFromSystemServer();
2333 }
2334 }
2335 return 0;
2336 }
2337
2338 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002339 * Make the device lock immediately, as if the lock screen timeout has expired at the point of
2340 * this call.
2341 * <p>
2342 * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
2343 * to be able to call this method; if it has not, a security exception will be thrown.
2344 * <p>
2345 * This method can be called on the {@link DevicePolicyManager} instance returned by
2346 * {@link #getParentProfileInstance(ComponentName)} in order to lock the parent profile.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002347 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002348 * @throws SecurityException if the calling application does not own an active administrator
2349 * that uses {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
Dianne Hackbornd6847842010-01-12 18:14:19 -08002350 */
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002351 public void lockNow() {
2352 if (mService != null) {
2353 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002354 mService.lockNow(mParentInstance);
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002355 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002356 throw e.rethrowFromSystemServer();
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002357 }
2358 }
2359 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002360
Dianne Hackbornd6847842010-01-12 18:14:19 -08002361 /**
Dianne Hackborn42499172010-10-15 18:45:07 -07002362 * Flag for {@link #wipeData(int)}: also erase the device's external
Paul Crowleya7e87ac2014-11-18 13:50:19 +00002363 * storage (such as SD cards).
Dianne Hackborn42499172010-10-15 18:45:07 -07002364 */
2365 public static final int WIPE_EXTERNAL_STORAGE = 0x0001;
2366
2367 /**
Paul Crowleya7e87ac2014-11-18 13:50:19 +00002368 * Flag for {@link #wipeData(int)}: also erase the factory reset protection
2369 * data.
2370 *
Paul Crowley2934b262014-12-02 11:21:13 +00002371 * <p>This flag may only be set by device owner admins; if it is set by
2372 * other admins a {@link SecurityException} will be thrown.
Paul Crowleya7e87ac2014-11-18 13:50:19 +00002373 */
2374 public static final int WIPE_RESET_PROTECTION_DATA = 0x0002;
2375
2376 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002377 * Ask the user data be wiped. Wiping the primary user will cause the device to reboot, erasing
2378 * all user data while next booting up.
2379 * <p>
2380 * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA} to
2381 * be able to call this method; if it has not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002382 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002383 * @param flags Bit mask of additional options: currently supported flags are
2384 * {@link #WIPE_EXTERNAL_STORAGE} and {@link #WIPE_RESET_PROTECTION_DATA}.
2385 * @throws SecurityException if the calling application does not own an active administrator
2386 * that uses {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA}
Dianne Hackbornd6847842010-01-12 18:14:19 -08002387 */
2388 public void wipeData(int flags) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002389 throwIfParentInstance("wipeData");
Dianne Hackbornd6847842010-01-12 18:14:19 -08002390 if (mService != null) {
2391 try {
Makoto Onuki70f929e2015-11-11 12:40:15 -08002392 mService.wipeData(flags);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002393 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002394 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08002395 }
2396 }
2397 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002398
Dianne Hackbornd6847842010-01-12 18:14:19 -08002399 /**
Oscar Montemayor69238c62010-08-03 10:51:06 -07002400 * Called by an application that is administering the device to set the
2401 * global proxy and exclusion list.
2402 * <p>
2403 * The calling device admin must have requested
2404 * {@link DeviceAdminInfo#USES_POLICY_SETS_GLOBAL_PROXY} to be able to call
2405 * this method; if it has not, a security exception will be thrown.
2406 * Only the first device admin can set the proxy. If a second admin attempts
2407 * to set the proxy, the {@link ComponentName} of the admin originally setting the
Robin Lee25e26452015-06-02 09:56:29 -07002408 * proxy will be returned. If successful in setting the proxy, {@code null} will
Oscar Montemayor69238c62010-08-03 10:51:06 -07002409 * be returned.
2410 * The method can be called repeatedly by the device admin alrady setting the
2411 * proxy to update the proxy and exclusion list.
2412 *
Robin Lee25e26452015-06-02 09:56:29 -07002413 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Oscar Montemayor69238c62010-08-03 10:51:06 -07002414 * @param proxySpec the global proxy desired. Must be an HTTP Proxy.
2415 * Pass Proxy.NO_PROXY to reset the proxy.
2416 * @param exclusionList a list of domains to be excluded from the global proxy.
Robin Lee25e26452015-06-02 09:56:29 -07002417 * @return {@code null} if the proxy was successfully set, or otherwise a {@link ComponentName}
2418 * of the device admin that sets the proxy.
Andy Stadlerd2672722011-02-16 10:53:33 -08002419 * @hide
Oscar Montemayor69238c62010-08-03 10:51:06 -07002420 */
Robin Lee25e26452015-06-02 09:56:29 -07002421 public ComponentName setGlobalProxy(@NonNull ComponentName admin, Proxy proxySpec,
Oscar Montemayor69238c62010-08-03 10:51:06 -07002422 List<String> exclusionList ) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002423 throwIfParentInstance("setGlobalProxy");
Oscar Montemayor69238c62010-08-03 10:51:06 -07002424 if (proxySpec == null) {
2425 throw new NullPointerException();
2426 }
2427 if (mService != null) {
2428 try {
2429 String hostSpec;
2430 String exclSpec;
2431 if (proxySpec.equals(Proxy.NO_PROXY)) {
2432 hostSpec = null;
2433 exclSpec = null;
2434 } else {
2435 if (!proxySpec.type().equals(Proxy.Type.HTTP)) {
2436 throw new IllegalArgumentException();
2437 }
2438 InetSocketAddress sa = (InetSocketAddress)proxySpec.address();
2439 String hostName = sa.getHostName();
2440 int port = sa.getPort();
2441 StringBuilder hostBuilder = new StringBuilder();
2442 hostSpec = hostBuilder.append(hostName)
2443 .append(":").append(Integer.toString(port)).toString();
2444 if (exclusionList == null) {
2445 exclSpec = "";
2446 } else {
2447 StringBuilder listBuilder = new StringBuilder();
2448 boolean firstDomain = true;
2449 for (String exclDomain : exclusionList) {
2450 if (!firstDomain) {
2451 listBuilder = listBuilder.append(",");
2452 } else {
2453 firstDomain = false;
2454 }
2455 listBuilder = listBuilder.append(exclDomain.trim());
2456 }
2457 exclSpec = listBuilder.toString();
2458 }
Yuhao Zheng90704842014-02-28 17:22:45 -08002459 if (android.net.Proxy.validate(hostName, Integer.toString(port), exclSpec)
2460 != android.net.Proxy.PROXY_VALID)
2461 throw new IllegalArgumentException();
Oscar Montemayor69238c62010-08-03 10:51:06 -07002462 }
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08002463 return mService.setGlobalProxy(admin, hostSpec, exclSpec);
Oscar Montemayor69238c62010-08-03 10:51:06 -07002464 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002465 throw e.rethrowFromSystemServer();
Oscar Montemayor69238c62010-08-03 10:51:06 -07002466 }
2467 }
2468 return null;
2469 }
2470
2471 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002472 * Set a network-independent global HTTP proxy. This is not normally what you want for typical
2473 * HTTP proxies - they are generally network dependent. However if you're doing something
2474 * unusual like general internal filtering this may be useful. On a private network where the
2475 * proxy is not accessible, you may break HTTP using this.
2476 * <p>
2477 * This method requires the caller to be the device owner.
2478 * <p>
2479 * This proxy is only a recommendation and it is possible that some apps will ignore it.
Jason Monk03bc9912014-05-13 09:44:57 -04002480 *
Jason Monk03bc9912014-05-13 09:44:57 -04002481 * @see ProxyInfo
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002482 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2483 * @param proxyInfo The a {@link ProxyInfo} object defining the new global HTTP proxy. A
2484 * {@code null} value will clear the global HTTP proxy.
2485 * @throws SecurityException if {@code admin} is not the device owner.
Jason Monk03bc9912014-05-13 09:44:57 -04002486 */
Robin Lee25e26452015-06-02 09:56:29 -07002487 public void setRecommendedGlobalProxy(@NonNull ComponentName admin, @Nullable ProxyInfo
2488 proxyInfo) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002489 throwIfParentInstance("setRecommendedGlobalProxy");
Jason Monk03bc9912014-05-13 09:44:57 -04002490 if (mService != null) {
2491 try {
2492 mService.setRecommendedGlobalProxy(admin, proxyInfo);
2493 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002494 throw e.rethrowFromSystemServer();
Jason Monk03bc9912014-05-13 09:44:57 -04002495 }
2496 }
2497 }
2498
2499 /**
Oscar Montemayor69238c62010-08-03 10:51:06 -07002500 * Returns the component name setting the global proxy.
Robin Lee25e26452015-06-02 09:56:29 -07002501 * @return ComponentName object of the device admin that set the global proxy, or {@code null}
2502 * if no admin has set the proxy.
Andy Stadlerd2672722011-02-16 10:53:33 -08002503 * @hide
Oscar Montemayor69238c62010-08-03 10:51:06 -07002504 */
2505 public ComponentName getGlobalProxyAdmin() {
2506 if (mService != null) {
2507 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002508 return mService.getGlobalProxyAdmin(myUserId());
Oscar Montemayor69238c62010-08-03 10:51:06 -07002509 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002510 throw e.rethrowFromSystemServer();
Oscar Montemayor69238c62010-08-03 10:51:06 -07002511 }
2512 }
2513 return null;
2514 }
2515
2516 /**
Andy Stadler22dbfda2011-01-17 12:47:31 -08002517 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002518 * indicating that encryption is not supported.
2519 */
2520 public static final int ENCRYPTION_STATUS_UNSUPPORTED = 0;
2521
2522 /**
Andy Stadler22dbfda2011-01-17 12:47:31 -08002523 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002524 * indicating that encryption is supported, but is not currently active.
2525 */
2526 public static final int ENCRYPTION_STATUS_INACTIVE = 1;
2527
2528 /**
Robin Lee3795fb02015-02-16 14:17:23 +00002529 * Result code for {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002530 * indicating that encryption is not currently active, but is currently
2531 * being activated. This is only reported by devices that support
2532 * encryption of data and only when the storage is currently
2533 * undergoing a process of becoming encrypted. A device that must reboot and/or wipe data
2534 * to become encrypted will never return this value.
2535 */
Andy Stadler22dbfda2011-01-17 12:47:31 -08002536 public static final int ENCRYPTION_STATUS_ACTIVATING = 2;
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002537
2538 /**
Andy Stadler22dbfda2011-01-17 12:47:31 -08002539 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002540 * indicating that encryption is active.
Amith Yamasani75db1252016-07-11 14:41:01 -07002541 * <p>
2542 * Also see {@link #ENCRYPTION_STATUS_ACTIVE_PER_USER}.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002543 */
Andy Stadler22dbfda2011-01-17 12:47:31 -08002544 public static final int ENCRYPTION_STATUS_ACTIVE = 3;
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002545
2546 /**
Robin Lee3795fb02015-02-16 14:17:23 +00002547 * Result code for {@link #getStorageEncryptionStatus}:
2548 * indicating that encryption is active, but an encryption key has not
2549 * been set by the user.
2550 */
2551 public static final int ENCRYPTION_STATUS_ACTIVE_DEFAULT_KEY = 4;
2552
2553 /**
Makoto Onukid4c9e542016-02-25 18:17:30 -08002554 * Result code for {@link #getStorageEncryptionStatus}:
Amith Yamasani75db1252016-07-11 14:41:01 -07002555 * indicating that encryption is active and the encryption key is tied to the user or profile.
2556 * <p>
2557 * This value is only returned to apps targeting API level 24 and above. For apps targeting
2558 * earlier API levels, {@link #ENCRYPTION_STATUS_ACTIVE} is returned, even if the
2559 * encryption key is specific to the user or profile.
Makoto Onukid4c9e542016-02-25 18:17:30 -08002560 */
2561 public static final int ENCRYPTION_STATUS_ACTIVE_PER_USER = 5;
2562
2563 /**
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002564 * Activity action: begin the process of encrypting data on the device. This activity should
2565 * be launched after using {@link #setStorageEncryption} to request encryption be activated.
2566 * After resuming from this activity, use {@link #getStorageEncryption}
2567 * to check encryption status. However, on some devices this activity may never return, as
2568 * it may trigger a reboot and in some cases a complete data wipe of the device.
2569 */
2570 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2571 public static final String ACTION_START_ENCRYPTION
2572 = "android.app.action.START_ENCRYPTION";
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002573 /**
Jim Millerb8ec4702012-08-31 17:19:10 -07002574 * Widgets are enabled in keyguard
2575 */
Jim Miller48b9b0d2012-09-19 23:16:50 -07002576 public static final int KEYGUARD_DISABLE_FEATURES_NONE = 0;
Jim Millerb8ec4702012-08-31 17:19:10 -07002577
2578 /**
Jim Miller50e62182014-04-23 17:25:00 -07002579 * Disable all keyguard widgets. Has no effect.
Jim Millerb8ec4702012-08-31 17:19:10 -07002580 */
Jim Miller48b9b0d2012-09-19 23:16:50 -07002581 public static final int KEYGUARD_DISABLE_WIDGETS_ALL = 1 << 0;
2582
2583 /**
2584 * Disable the camera on secure keyguard screens (e.g. PIN/Pattern/Password)
2585 */
2586 public static final int KEYGUARD_DISABLE_SECURE_CAMERA = 1 << 1;
2587
2588 /**
Jim Miller50e62182014-04-23 17:25:00 -07002589 * Disable showing all notifications on secure keyguard screens (e.g. PIN/Pattern/Password)
2590 */
2591 public static final int KEYGUARD_DISABLE_SECURE_NOTIFICATIONS = 1 << 2;
2592
2593 /**
2594 * Only allow redacted notifications on secure keyguard screens (e.g. PIN/Pattern/Password)
2595 */
2596 public static final int KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS = 1 << 3;
2597
2598 /**
Adrian Roosa06d5ca2014-07-28 15:14:21 +02002599 * Ignore trust agent state on secure keyguard screens
Jim Miller50e62182014-04-23 17:25:00 -07002600 * (e.g. PIN/Pattern/Password).
2601 */
2602 public static final int KEYGUARD_DISABLE_TRUST_AGENTS = 1 << 4;
2603
2604 /**
Jim Miller06e34502014-07-17 14:46:05 -07002605 * Disable fingerprint sensor on keyguard secure screens (e.g. PIN/Pattern/Password).
2606 */
2607 public static final int KEYGUARD_DISABLE_FINGERPRINT = 1 << 5;
2608
2609 /**
Adrian Roos7f06eed2016-02-05 15:21:02 -08002610 * Disable text entry into notifications on secure keyguard screens (e.g. PIN/Pattern/Password).
2611 */
2612 public static final int KEYGUARD_DISABLE_REMOTE_INPUT = 1 << 6;
2613
2614 /**
Jim Miller35207742012-11-02 15:33:20 -07002615 * Disable all current and future keyguard customizations.
Jim Miller48b9b0d2012-09-19 23:16:50 -07002616 */
2617 public static final int KEYGUARD_DISABLE_FEATURES_ALL = 0x7fffffff;
Jim Millerb8ec4702012-08-31 17:19:10 -07002618
2619 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002620 * Called by an application that is administering the device to request that the storage system
2621 * be encrypted.
2622 * <p>
2623 * When multiple device administrators attempt to control device encryption, the most secure,
2624 * supported setting will always be used. If any device administrator requests device
2625 * encryption, it will be enabled; Conversely, if a device administrator attempts to disable
2626 * device encryption while another device administrator has enabled it, the call to disable will
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002627 * fail (most commonly returning {@link #ENCRYPTION_STATUS_ACTIVE}).
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002628 * <p>
2629 * This policy controls encryption of the secure (application data) storage area. Data written
2630 * to other storage areas may or may not be encrypted, and this policy does not require or
2631 * control the encryption of any other storage areas. There is one exception: If
2632 * {@link android.os.Environment#isExternalStorageEmulated()} is {@code true}, then the
2633 * directory returned by {@link android.os.Environment#getExternalStorageDirectory()} must be
2634 * written to disk within the encrypted storage area.
2635 * <p>
2636 * Important Note: On some devices, it is possible to encrypt storage without requiring the user
2637 * to create a device PIN or Password. In this case, the storage is encrypted, but the
2638 * encryption key may not be fully secured. For maximum security, the administrator should also
2639 * require (and check for) a pattern, PIN, or password.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002640 *
2641 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2642 * @param encrypt true to request encryption, false to release any previous request
Andy Stadler22dbfda2011-01-17 12:47:31 -08002643 * @return the new request status (for all active admins) - will be one of
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002644 * {@link #ENCRYPTION_STATUS_UNSUPPORTED}, {@link #ENCRYPTION_STATUS_INACTIVE}, or
2645 * {@link #ENCRYPTION_STATUS_ACTIVE}. This is the value of the requests; Use
2646 * {@link #getStorageEncryptionStatus()} to query the actual device state.
2647 * @throws SecurityException if {@code admin} is not an active administrator or does not use
2648 * {@link DeviceAdminInfo#USES_ENCRYPTED_STORAGE}
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002649 */
Robin Lee25e26452015-06-02 09:56:29 -07002650 public int setStorageEncryption(@NonNull ComponentName admin, boolean encrypt) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002651 throwIfParentInstance("setStorageEncryption");
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002652 if (mService != null) {
2653 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08002654 return mService.setStorageEncryption(admin, encrypt);
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002655 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002656 throw e.rethrowFromSystemServer();
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002657 }
2658 }
2659 return ENCRYPTION_STATUS_UNSUPPORTED;
2660 }
2661
2662 /**
2663 * Called by an application that is administering the device to
Andy Stadler22dbfda2011-01-17 12:47:31 -08002664 * determine the requested setting for secure storage.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002665 *
Andy Stadler22dbfda2011-01-17 12:47:31 -08002666 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. If null,
2667 * this will return the requested encryption setting as an aggregate of all active
2668 * administrators.
2669 * @return true if the admin(s) are requesting encryption, false if not.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002670 */
Robin Lee25e26452015-06-02 09:56:29 -07002671 public boolean getStorageEncryption(@Nullable ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002672 throwIfParentInstance("getStorageEncryption");
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002673 if (mService != null) {
2674 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002675 return mService.getStorageEncryption(admin, myUserId());
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002676 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002677 throw e.rethrowFromSystemServer();
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002678 }
2679 }
Andy Stadler22dbfda2011-01-17 12:47:31 -08002680 return false;
2681 }
2682
2683 /**
2684 * Called by an application that is administering the device to
2685 * determine the current encryption status of the device.
Amith Yamasani75db1252016-07-11 14:41:01 -07002686 * <p>
Andy Stadler22dbfda2011-01-17 12:47:31 -08002687 * Depending on the returned status code, the caller may proceed in different
2688 * ways. If the result is {@link #ENCRYPTION_STATUS_UNSUPPORTED}, the
2689 * storage system does not support encryption. If the
2690 * result is {@link #ENCRYPTION_STATUS_INACTIVE}, use {@link
2691 * #ACTION_START_ENCRYPTION} to begin the process of encrypting or decrypting the
Robin Lee3795fb02015-02-16 14:17:23 +00002692 * storage. If the result is {@link #ENCRYPTION_STATUS_ACTIVE_DEFAULT_KEY}, the
2693 * storage system has enabled encryption but no password is set so further action
Amith Yamasani75db1252016-07-11 14:41:01 -07002694 * may be required. If the result is {@link #ENCRYPTION_STATUS_ACTIVATING},
2695 * {@link #ENCRYPTION_STATUS_ACTIVE} or {@link #ENCRYPTION_STATUS_ACTIVE_PER_USER},
2696 * no further action is required.
Andy Stadler22dbfda2011-01-17 12:47:31 -08002697 *
Robin Lee7e678712014-07-24 16:41:31 +01002698 * @return current status of encryption. The value will be one of
Andy Stadler22dbfda2011-01-17 12:47:31 -08002699 * {@link #ENCRYPTION_STATUS_UNSUPPORTED}, {@link #ENCRYPTION_STATUS_INACTIVE},
Robin Lee3795fb02015-02-16 14:17:23 +00002700 * {@link #ENCRYPTION_STATUS_ACTIVATING}, {@link #ENCRYPTION_STATUS_ACTIVE_DEFAULT_KEY},
Amith Yamasani75db1252016-07-11 14:41:01 -07002701 * {@link #ENCRYPTION_STATUS_ACTIVE}, or {@link #ENCRYPTION_STATUS_ACTIVE_PER_USER}.
Andy Stadler22dbfda2011-01-17 12:47:31 -08002702 */
2703 public int getStorageEncryptionStatus() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002704 throwIfParentInstance("getStorageEncryptionStatus");
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002705 return getStorageEncryptionStatus(myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002706 }
2707
2708 /** @hide per-user version */
2709 public int getStorageEncryptionStatus(int userHandle) {
Andy Stadler22dbfda2011-01-17 12:47:31 -08002710 if (mService != null) {
2711 try {
Makoto Onukid4c9e542016-02-25 18:17:30 -08002712 return mService.getStorageEncryptionStatus(mContext.getPackageName(), userHandle);
Andy Stadler22dbfda2011-01-17 12:47:31 -08002713 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002714 throw e.rethrowFromSystemServer();
Andy Stadler22dbfda2011-01-17 12:47:31 -08002715 }
2716 }
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002717 return ENCRYPTION_STATUS_UNSUPPORTED;
2718 }
2719
2720 /**
Robin Lee2f7e1e42016-03-21 10:50:01 +00002721 * Mark a CA certificate as approved by the device user. This means that they have been notified
2722 * of the installation, were made aware of the risks, viewed the certificate and still wanted to
2723 * keep the certificate on the device.
2724 *
2725 * Calling with {@param approval} as {@code true} will cancel any ongoing warnings related to
2726 * this certificate.
2727 *
2728 * @hide
2729 */
2730 public boolean approveCaCert(String alias, int userHandle, boolean approval) {
2731 if (mService != null) {
2732 try {
2733 return mService.approveCaCert(alias, userHandle, approval);
2734 } catch (RemoteException e) {
2735 throw e.rethrowFromSystemServer();
2736 }
2737 }
2738 return false;
2739 }
2740
2741 /**
2742 * Check whether a CA certificate has been approved by the device user.
2743 *
2744 * @hide
2745 */
2746 public boolean isCaCertApproved(String alias, int userHandle) {
2747 if (mService != null) {
2748 try {
2749 return mService.isCaCertApproved(alias, userHandle);
2750 } catch (RemoteException e) {
2751 throw e.rethrowFromSystemServer();
2752 }
2753 }
2754 return false;
2755 }
2756
2757 /**
Robin Lee7e678712014-07-24 16:41:31 +01002758 * Installs the given certificate as a user CA.
2759 *
Robin Lee25e26452015-06-02 09:56:29 -07002760 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2761 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01002762 * @param certBuffer encoded form of the certificate to install.
Maggie Benthallda51e682013-08-08 22:35:44 -04002763 *
2764 * @return false if the certBuffer cannot be parsed or installation is
Robin Lee7e678712014-07-24 16:41:31 +01002765 * interrupted, true otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002766 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2767 * owner.
Maggie Benthallda51e682013-08-08 22:35:44 -04002768 */
Robin Lee25e26452015-06-02 09:56:29 -07002769 public boolean installCaCert(@Nullable ComponentName admin, byte[] certBuffer) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002770 throwIfParentInstance("installCaCert");
Maggie Benthallda51e682013-08-08 22:35:44 -04002771 if (mService != null) {
2772 try {
Robin Lee7e678712014-07-24 16:41:31 +01002773 return mService.installCaCert(admin, certBuffer);
Maggie Benthallda51e682013-08-08 22:35:44 -04002774 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002775 throw e.rethrowFromSystemServer();
Maggie Benthallda51e682013-08-08 22:35:44 -04002776 }
2777 }
2778 return false;
2779 }
2780
2781 /**
Robin Lee7e678712014-07-24 16:41:31 +01002782 * Uninstalls the given certificate from trusted user CAs, if present.
2783 *
Robin Lee25e26452015-06-02 09:56:29 -07002784 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2785 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01002786 * @param certBuffer encoded form of the certificate to remove.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002787 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2788 * owner.
Maggie Benthallda51e682013-08-08 22:35:44 -04002789 */
Robin Lee25e26452015-06-02 09:56:29 -07002790 public void uninstallCaCert(@Nullable ComponentName admin, byte[] certBuffer) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002791 throwIfParentInstance("uninstallCaCert");
Maggie Benthallda51e682013-08-08 22:35:44 -04002792 if (mService != null) {
2793 try {
Robin Lee306fe082014-06-19 14:04:24 +00002794 final String alias = getCaCertAlias(certBuffer);
Robin Lee83881bd2015-06-09 16:04:38 -07002795 mService.uninstallCaCerts(admin, new String[] {alias});
Robin Lee306fe082014-06-19 14:04:24 +00002796 } catch (CertificateException e) {
2797 Log.w(TAG, "Unable to parse certificate", e);
Maggie Benthallda51e682013-08-08 22:35:44 -04002798 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002799 throw e.rethrowFromSystemServer();
Maggie Benthallda51e682013-08-08 22:35:44 -04002800 }
2801 }
2802 }
2803
2804 /**
Robin Lee7e678712014-07-24 16:41:31 +01002805 * Returns all CA certificates that are currently trusted, excluding system CA certificates.
2806 * If a user has installed any certificates by other means than device policy these will be
2807 * included too.
2808 *
Robin Lee25e26452015-06-02 09:56:29 -07002809 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2810 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01002811 * @return a List of byte[] arrays, each encoding one user CA certificate.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002812 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2813 * owner.
Maggie Benthallda51e682013-08-08 22:35:44 -04002814 */
Robin Lee25e26452015-06-02 09:56:29 -07002815 public List<byte[]> getInstalledCaCerts(@Nullable ComponentName admin) {
Robin Lee7e678712014-07-24 16:41:31 +01002816 List<byte[]> certs = new ArrayList<byte[]>();
Benjamin Franzbc33c822016-04-15 08:57:52 +01002817 throwIfParentInstance("getInstalledCaCerts");
Esteban Talavera808f6ef2014-08-28 17:15:54 +01002818 if (mService != null) {
Robin Lee7e678712014-07-24 16:41:31 +01002819 try {
Esteban Talavera808f6ef2014-08-28 17:15:54 +01002820 mService.enforceCanManageCaCerts(admin);
2821 final TrustedCertificateStore certStore = new TrustedCertificateStore();
2822 for (String alias : certStore.userAliases()) {
2823 try {
2824 certs.add(certStore.getCertificate(alias).getEncoded());
2825 } catch (CertificateException ce) {
2826 Log.w(TAG, "Could not encode certificate: " + alias, ce);
2827 }
2828 }
2829 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002830 throw re.rethrowFromSystemServer();
Robin Lee7e678712014-07-24 16:41:31 +01002831 }
2832 }
2833 return certs;
Maggie Benthallda51e682013-08-08 22:35:44 -04002834 }
2835
2836 /**
Robin Lee7e678712014-07-24 16:41:31 +01002837 * Uninstalls all custom trusted CA certificates from the profile. Certificates installed by
2838 * means other than device policy will also be removed, except for system CA certificates.
2839 *
Robin Lee25e26452015-06-02 09:56:29 -07002840 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2841 * {@code null} if calling from a delegated certificate installer.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002842 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2843 * owner.
Robin Lee7e678712014-07-24 16:41:31 +01002844 */
Robin Lee25e26452015-06-02 09:56:29 -07002845 public void uninstallAllUserCaCerts(@Nullable ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002846 throwIfParentInstance("uninstallAllUserCaCerts");
Robin Lee7e678712014-07-24 16:41:31 +01002847 if (mService != null) {
Robin Lee83881bd2015-06-09 16:04:38 -07002848 try {
2849 mService.uninstallCaCerts(admin, new TrustedCertificateStore().userAliases()
2850 .toArray(new String[0]));
2851 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002852 throw re.rethrowFromSystemServer();
Robin Lee7e678712014-07-24 16:41:31 +01002853 }
2854 }
2855 }
2856
2857 /**
2858 * Returns whether this certificate is installed as a trusted CA.
2859 *
Robin Lee25e26452015-06-02 09:56:29 -07002860 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2861 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01002862 * @param certBuffer encoded form of the certificate to look up.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002863 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2864 * owner.
Maggie Benthallda51e682013-08-08 22:35:44 -04002865 */
Robin Lee25e26452015-06-02 09:56:29 -07002866 public boolean hasCaCertInstalled(@Nullable ComponentName admin, byte[] certBuffer) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002867 throwIfParentInstance("hasCaCertInstalled");
Esteban Talavera808f6ef2014-08-28 17:15:54 +01002868 if (mService != null) {
2869 try {
2870 mService.enforceCanManageCaCerts(admin);
2871 return getCaCertAlias(certBuffer) != null;
2872 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002873 throw re.rethrowFromSystemServer();
Esteban Talavera808f6ef2014-08-28 17:15:54 +01002874 } catch (CertificateException ce) {
2875 Log.w(TAG, "Could not parse certificate", ce);
2876 }
Maggie Benthallda51e682013-08-08 22:35:44 -04002877 }
2878 return false;
2879 }
2880
2881 /**
Robin Leece3399f2016-02-24 12:08:32 +00002882 * Called by a device or profile owner, or delegated certificate installer, to install a
2883 * certificate and corresponding private key. All apps within the profile will be able to access
2884 * the certificate and use the private key, given direct user approval.
2885 *
2886 * <p>Access to the installed credentials will not be granted to the caller of this API without
2887 * direct user approval. This is for security - should a certificate installer become
2888 * compromised, certificates it had already installed will be protected.
2889 *
2890 * <p>If the installer must have access to the credentials, call
Rubin Xub4365912016-03-23 12:13:22 +00002891 * {@link #installKeyPair(ComponentName, PrivateKey, Certificate[], String, boolean)} instead.
Bernhard Bauer26408cc2014-09-08 14:07:31 +01002892 *
Robin Lee25e26452015-06-02 09:56:29 -07002893 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2894 * {@code null} if calling from a delegated certificate installer.
Bernhard Bauer26408cc2014-09-08 14:07:31 +01002895 * @param privKey The private key to install.
2896 * @param cert The certificate to install.
2897 * @param alias The private key alias under which to install the certificate. If a certificate
2898 * with that alias already exists, it will be overwritten.
2899 * @return {@code true} if the keys were installed, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002900 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2901 * owner.
Bernhard Bauer26408cc2014-09-08 14:07:31 +01002902 */
Robin Leefbc65642015-08-03 16:21:22 +01002903 public boolean installKeyPair(@Nullable ComponentName admin, @NonNull PrivateKey privKey,
2904 @NonNull Certificate cert, @NonNull String alias) {
Rubin Xub4365912016-03-23 12:13:22 +00002905 return installKeyPair(admin, privKey, new Certificate[] {cert}, alias, false);
Robin Leece3399f2016-02-24 12:08:32 +00002906 }
2907
2908 /**
2909 * Called by a device or profile owner, or delegated certificate installer, to install a
Rubin Xub4365912016-03-23 12:13:22 +00002910 * certificate chain and corresponding private key for the leaf certificate. All apps within the
2911 * profile will be able to access the certificate chain and use the private key, given direct
2912 * user approval.
Robin Leece3399f2016-02-24 12:08:32 +00002913 *
Robin Leea1b290e2016-03-09 14:38:36 +00002914 * <p>The caller of this API may grant itself access to the certificate and private key
2915 * immediately, without user approval. It is a best practice not to request this unless strictly
2916 * necessary since it opens up additional security vulnerabilities.
Robin Leece3399f2016-02-24 12:08:32 +00002917 *
2918 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
Robin Leea1b290e2016-03-09 14:38:36 +00002919 * {@code null} if calling from a delegated certificate installer.
Robin Leece3399f2016-02-24 12:08:32 +00002920 * @param privKey The private key to install.
Rubin Xub4365912016-03-23 12:13:22 +00002921 * @param certs The certificate chain to install. The chain should start with the leaf
2922 * certificate and include the chain of trust in order. This will be returned by
2923 * {@link android.security.KeyChain#getCertificateChain}.
Robin Leece3399f2016-02-24 12:08:32 +00002924 * @param alias The private key alias under which to install the certificate. If a certificate
Robin Leea1b290e2016-03-09 14:38:36 +00002925 * with that alias already exists, it will be overwritten.
Robin Leece3399f2016-02-24 12:08:32 +00002926 * @param requestAccess {@code true} to request that the calling app be granted access to the
Robin Leea1b290e2016-03-09 14:38:36 +00002927 * credentials immediately. Otherwise, access to the credentials will be gated by user
2928 * approval.
Robin Leece3399f2016-02-24 12:08:32 +00002929 * @return {@code true} if the keys were installed, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002930 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2931 * owner.
Rubin Xub4365912016-03-23 12:13:22 +00002932 * @see android.security.KeyChain#getCertificateChain
Robin Leece3399f2016-02-24 12:08:32 +00002933 */
2934 public boolean installKeyPair(@Nullable ComponentName admin, @NonNull PrivateKey privKey,
Rubin Xub4365912016-03-23 12:13:22 +00002935 @NonNull Certificate[] certs, @NonNull String alias, boolean requestAccess) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002936 throwIfParentInstance("installKeyPair");
Bernhard Bauer26408cc2014-09-08 14:07:31 +01002937 try {
Rubin Xub4365912016-03-23 12:13:22 +00002938 final byte[] pemCert = Credentials.convertToPem(certs[0]);
2939 byte[] pemChain = null;
2940 if (certs.length > 1) {
2941 pemChain = Credentials.convertToPem(Arrays.copyOfRange(certs, 1, certs.length));
2942 }
Robin Lee0d5ccb72014-09-12 17:41:44 +01002943 final byte[] pkcs8Key = KeyFactory.getInstance(privKey.getAlgorithm())
2944 .getKeySpec(privKey, PKCS8EncodedKeySpec.class).getEncoded();
Rubin Xub4365912016-03-23 12:13:22 +00002945 return mService.installKeyPair(admin, pkcs8Key, pemCert, pemChain, alias,
2946 requestAccess);
Bernhard Bauer26408cc2014-09-08 14:07:31 +01002947 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002948 throw e.rethrowFromSystemServer();
Robin Lee0d5ccb72014-09-12 17:41:44 +01002949 } catch (NoSuchAlgorithmException | InvalidKeySpecException e) {
2950 Log.w(TAG, "Failed to obtain private key material", e);
2951 } catch (CertificateException | IOException e) {
2952 Log.w(TAG, "Could not pem-encode certificate", e);
Bernhard Bauer26408cc2014-09-08 14:07:31 +01002953 }
2954 return false;
2955 }
2956
2957 /**
Robin Leea1b290e2016-03-09 14:38:36 +00002958 * Called by a device or profile owner, or delegated certificate installer, to remove a
2959 * certificate and private key pair installed under a given alias.
Robin Leefbc65642015-08-03 16:21:22 +01002960 *
2961 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
Robin Leea1b290e2016-03-09 14:38:36 +00002962 * {@code null} if calling from a delegated certificate installer.
Robin Leefbc65642015-08-03 16:21:22 +01002963 * @param alias The private key alias under which the certificate is installed.
Robin Leea1b290e2016-03-09 14:38:36 +00002964 * @return {@code true} if the private key alias no longer exists, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002965 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2966 * owner.
Robin Leefbc65642015-08-03 16:21:22 +01002967 */
2968 public boolean removeKeyPair(@Nullable ComponentName admin, @NonNull String alias) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002969 throwIfParentInstance("removeKeyPair");
Robin Leefbc65642015-08-03 16:21:22 +01002970 try {
2971 return mService.removeKeyPair(admin, alias);
2972 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002973 throw e.rethrowFromSystemServer();
Robin Leefbc65642015-08-03 16:21:22 +01002974 }
Robin Leefbc65642015-08-03 16:21:22 +01002975 }
2976
2977 /**
Robin Lee25e26452015-06-02 09:56:29 -07002978 * @return the alias of a given CA certificate in the certificate store, or {@code null} if it
Robin Lee306fe082014-06-19 14:04:24 +00002979 * doesn't exist.
2980 */
2981 private static String getCaCertAlias(byte[] certBuffer) throws CertificateException {
2982 final CertificateFactory certFactory = CertificateFactory.getInstance("X.509");
2983 final X509Certificate cert = (X509Certificate) certFactory.generateCertificate(
2984 new ByteArrayInputStream(certBuffer));
2985 return new TrustedCertificateStore().getCertificateAlias(cert);
2986 }
2987
2988 /**
Rubin Xuec32b562015-03-03 17:34:05 +00002989 * Called by a profile owner or device owner to grant access to privileged certificate
Rubin Xuacdc1832015-04-02 12:40:20 +01002990 * manipulation APIs to a third-party certificate installer app. Granted APIs include
Rubin Xuec32b562015-03-03 17:34:05 +00002991 * {@link #getInstalledCaCerts}, {@link #hasCaCertInstalled}, {@link #installCaCert},
Rubin Xuacdc1832015-04-02 12:40:20 +01002992 * {@link #uninstallCaCert}, {@link #uninstallAllUserCaCerts} and {@link #installKeyPair}.
Rubin Xuec32b562015-03-03 17:34:05 +00002993 * <p>
2994 * Delegated certificate installer is a per-user state. The delegated access is persistent until
2995 * it is later cleared by calling this method with a null value or uninstallling the certificate
2996 * installer.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002997 * <p>
Rubin Xuf03d0a62016-02-10 14:54:15 +00002998 * <b>Note:</b>Starting from {@link android.os.Build.VERSION_CODES#N}, if the caller
2999 * application's target SDK version is {@link android.os.Build.VERSION_CODES#N} or newer, the
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003000 * supplied certificate installer package must be installed when calling this API, otherwise an
3001 * {@link IllegalArgumentException} will be thrown.
Rubin Xuec32b562015-03-03 17:34:05 +00003002 *
Robin Lee25e26452015-06-02 09:56:29 -07003003 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Rubin Xuec32b562015-03-03 17:34:05 +00003004 * @param installerPackage The package name of the certificate installer which will be given
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003005 * access. If {@code null} is given the current package will be cleared.
3006 * @throws SecurityException if {@code admin} is not a device or a profile owner.
Rubin Xuec32b562015-03-03 17:34:05 +00003007 */
Robin Lee25e26452015-06-02 09:56:29 -07003008 public void setCertInstallerPackage(@NonNull ComponentName admin, @Nullable String
3009 installerPackage) throws SecurityException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003010 throwIfParentInstance("setCertInstallerPackage");
Rubin Xuec32b562015-03-03 17:34:05 +00003011 if (mService != null) {
3012 try {
Robin Lee25e26452015-06-02 09:56:29 -07003013 mService.setCertInstallerPackage(admin, installerPackage);
Rubin Xuec32b562015-03-03 17:34:05 +00003014 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003015 throw e.rethrowFromSystemServer();
Rubin Xuec32b562015-03-03 17:34:05 +00003016 }
3017 }
3018 }
3019
3020 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003021 * Called by a profile owner or device owner to retrieve the certificate installer for the user.
3022 * null if none is set.
Rubin Xuec32b562015-03-03 17:34:05 +00003023 *
Robin Lee25e26452015-06-02 09:56:29 -07003024 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003025 * @return The package name of the current delegated certificate installer, or {@code null} if
3026 * none is set.
3027 * @throws SecurityException if {@code admin} is not a device or a profile owner.
Rubin Xuec32b562015-03-03 17:34:05 +00003028 */
Robin Lee25e26452015-06-02 09:56:29 -07003029 public String getCertInstallerPackage(@NonNull ComponentName admin) throws SecurityException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003030 throwIfParentInstance("getCertInstallerPackage");
Rubin Xuec32b562015-03-03 17:34:05 +00003031 if (mService != null) {
3032 try {
Robin Lee25e26452015-06-02 09:56:29 -07003033 return mService.getCertInstallerPackage(admin);
Rubin Xuec32b562015-03-03 17:34:05 +00003034 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003035 throw e.rethrowFromSystemServer();
Rubin Xuec32b562015-03-03 17:34:05 +00003036 }
3037 }
3038 return null;
3039 }
3040
3041 /**
Robin Lee244ce8e2016-01-05 18:03:46 +00003042 * Called by a device or profile owner to configure an always-on VPN connection through a
Robin Leedc679712016-05-03 13:23:03 +01003043 * specific application for the current user.
3044 *
3045 * @deprecated this version only exists for compability with previous developer preview builds.
3046 * TODO: delete once there are no longer any live references.
3047 * @hide
3048 */
3049 public void setAlwaysOnVpnPackage(@NonNull ComponentName admin, @Nullable String vpnPackage)
3050 throws NameNotFoundException, UnsupportedOperationException {
3051 setAlwaysOnVpnPackage(admin, vpnPackage, /* lockdownEnabled */ true);
3052 }
3053
3054 /**
3055 * Called by a device or profile owner to configure an always-on VPN connection through a
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003056 * specific application for the current user. This connection is automatically granted and
3057 * persisted after a reboot.
3058 * <p>
3059 * The designated package should declare a {@link android.net.VpnService} in its manifest
3060 * guarded by {@link android.Manifest.permission#BIND_VPN_SERVICE}, otherwise the call will
3061 * fail.
Robin Lee244ce8e2016-01-05 18:03:46 +00003062 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003063 * @param vpnPackage The package name for an installed VPN app on the device, or {@code null} to
Robin Leedc679712016-05-03 13:23:03 +01003064 * remove an existing always-on VPN configuration.
3065 * @param lockdownEnabled {@code true} to disallow networking when the VPN is not connected or
3066 * {@code false} otherwise. This carries the risk that any failure of the VPN provider
3067 * could break networking for all apps. This has no effect when clearing.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003068 * @throws SecurityException if {@code admin} is not a device or a profile owner.
Robin Leeee5eb932016-04-05 16:27:15 +01003069 * @throws NameNotFoundException if {@code vpnPackage} is not installed.
3070 * @throws UnsupportedOperationException if {@code vpnPackage} exists but does not support being
3071 * set as always-on, or if always-on VPN is not available.
Robin Lee244ce8e2016-01-05 18:03:46 +00003072 */
Robin Leedc679712016-05-03 13:23:03 +01003073 public void setAlwaysOnVpnPackage(@NonNull ComponentName admin, @Nullable String vpnPackage,
3074 boolean lockdownEnabled)
Robin Leeee5eb932016-04-05 16:27:15 +01003075 throws NameNotFoundException, UnsupportedOperationException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003076 throwIfParentInstance("setAlwaysOnVpnPackage");
Robin Lee244ce8e2016-01-05 18:03:46 +00003077 if (mService != null) {
3078 try {
Robin Leedc679712016-05-03 13:23:03 +01003079 if (!mService.setAlwaysOnVpnPackage(admin, vpnPackage, lockdownEnabled)) {
Robin Leeee5eb932016-04-05 16:27:15 +01003080 throw new NameNotFoundException(vpnPackage);
3081 }
Robin Lee244ce8e2016-01-05 18:03:46 +00003082 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003083 throw e.rethrowFromSystemServer();
Robin Lee244ce8e2016-01-05 18:03:46 +00003084 }
3085 }
Robin Lee244ce8e2016-01-05 18:03:46 +00003086 }
3087
3088 /**
3089 * Called by a device or profile owner to read the name of the package administering an
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003090 * always-on VPN connection for the current user. If there is no such package, or the always-on
3091 * VPN is provided by the system instead of by an application, {@code null} will be returned.
Robin Lee244ce8e2016-01-05 18:03:46 +00003092 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003093 * @return Package name of VPN controller responsible for always-on VPN, or {@code null} if none
3094 * is set.
3095 * @throws SecurityException if {@code admin} is not a device or a profile owner.
Robin Lee244ce8e2016-01-05 18:03:46 +00003096 */
3097 public String getAlwaysOnVpnPackage(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003098 throwIfParentInstance("getAlwaysOnVpnPackage");
Robin Lee244ce8e2016-01-05 18:03:46 +00003099 if (mService != null) {
3100 try {
3101 return mService.getAlwaysOnVpnPackage(admin);
3102 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003103 throw e.rethrowFromSystemServer();
Robin Lee244ce8e2016-01-05 18:03:46 +00003104 }
3105 }
3106 return null;
3107 }
3108
3109 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003110 * Called by an application that is administering the device to disable all cameras on the
3111 * device, for this user. After setting this, no applications running as this user will be able
3112 * to access any cameras on the device.
3113 * <p>
3114 * If the caller is device owner, then the restriction will be applied to all users.
3115 * <p>
3116 * The calling device admin must have requested
3117 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_CAMERA} to be able to call this method; if it has
3118 * not, a security exception will be thrown.
Ben Komalo2447edd2011-05-09 16:05:33 -07003119 *
3120 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3121 * @param disabled Whether or not the camera should be disabled.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003122 * @throws SecurityException if {@code admin} is not an active administrator or does not use
3123 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_CAMERA}.
Ben Komalo2447edd2011-05-09 16:05:33 -07003124 */
Robin Lee25e26452015-06-02 09:56:29 -07003125 public void setCameraDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003126 throwIfParentInstance("setCameraDisabled");
Ben Komalo2447edd2011-05-09 16:05:33 -07003127 if (mService != null) {
3128 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08003129 mService.setCameraDisabled(admin, disabled);
Ben Komalo2447edd2011-05-09 16:05:33 -07003130 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003131 throw e.rethrowFromSystemServer();
Ben Komalo2447edd2011-05-09 16:05:33 -07003132 }
3133 }
3134 }
3135
3136 /**
Amith Yamasani242f4b12014-10-14 16:06:13 -07003137 * Determine whether or not the device's cameras have been disabled for this user,
Makoto Onuki32b30572015-12-11 14:29:51 -08003138 * either by the calling admin, if specified, or all admins.
Robin Lee25e26452015-06-02 09:56:29 -07003139 * @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 -07003140 * have disabled the camera
3141 */
Robin Lee25e26452015-06-02 09:56:29 -07003142 public boolean getCameraDisabled(@Nullable ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003143 throwIfParentInstance("getCameraDisabled");
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003144 return getCameraDisabled(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003145 }
3146
3147 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07003148 public boolean getCameraDisabled(@Nullable ComponentName admin, int userHandle) {
Ben Komalo2447edd2011-05-09 16:05:33 -07003149 if (mService != null) {
3150 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003151 return mService.getCameraDisabled(admin, userHandle);
Ben Komalo2447edd2011-05-09 16:05:33 -07003152 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003153 throw e.rethrowFromSystemServer();
Ben Komalo2447edd2011-05-09 16:05:33 -07003154 }
3155 }
3156 return false;
3157 }
3158
3159 /**
Michal Karpinski3fc437e2015-12-15 10:09:00 +00003160 * Called by a device owner to request a bugreport.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003161 * <p>
3162 * There must be only one user on the device, managed by the device owner. Otherwise a
3163 * {@link SecurityException} will be thrown.
Michal Karpinski3fc437e2015-12-15 10:09:00 +00003164 *
3165 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003166 * @return {@code true} if the bugreport collection started successfully, or {@code false} if it
3167 * wasn't triggered because a previous bugreport operation is still active (either the
3168 * bugreport is still running or waiting for the user to share or decline)
3169 * @throws SecurityException if {@code admin} is not a device owner, or if there are users other
3170 * than the one managed by the device owner.
Michal Karpinski3fc437e2015-12-15 10:09:00 +00003171 */
3172 public boolean requestBugreport(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003173 throwIfParentInstance("requestBugreport");
Michal Karpinski3fc437e2015-12-15 10:09:00 +00003174 if (mService != null) {
3175 try {
3176 return mService.requestBugreport(admin);
3177 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003178 throw e.rethrowFromSystemServer();
Michal Karpinski3fc437e2015-12-15 10:09:00 +00003179 }
3180 }
3181 return false;
3182 }
3183
3184 /**
Fyodor Kupolovcd86ebf2015-09-29 17:06:50 -07003185 * Determine whether or not creating a guest user has been disabled for the device
3186 *
3187 * @hide
3188 */
3189 public boolean getGuestUserDisabled(@Nullable ComponentName admin) {
3190 // Currently guest users can always be created if multi-user is enabled
3191 // TODO introduce a policy for guest user creation
3192 return false;
3193 }
3194
3195 /**
Esteban Talavera1aee98f2014-08-21 14:03:55 +01003196 * Called by a device/profile owner to set whether the screen capture is disabled. Disabling
3197 * screen capture also prevents the content from being shown on display devices that do not have
3198 * a secure video output. See {@link android.view.Display#FLAG_SECURE} for more details about
3199 * secure surfaces and secure displays.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003200 * <p>
3201 * The calling device admin must be a device or profile owner. If it is not, a security
3202 * exception will be thrown.
3203 * <p>
3204 * From version {@link android.os.Build.VERSION_CODES#M} disabling screen capture also blocks
3205 * assist requests for all activities of the relevant user.
Benjamin Franzc200f442015-06-25 18:20:04 +01003206 *
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003207 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003208 * @param disabled Whether screen capture is disabled or not.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003209 * @throws SecurityException if {@code admin} is not a device or profile owner.
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003210 */
Robin Lee25e26452015-06-02 09:56:29 -07003211 public void setScreenCaptureDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003212 throwIfParentInstance("setScreenCaptureDisabled");
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003213 if (mService != null) {
3214 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08003215 mService.setScreenCaptureDisabled(admin, disabled);
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003216 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003217 throw e.rethrowFromSystemServer();
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003218 }
3219 }
3220 }
3221
3222 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08003223 * Determine whether or not screen capture has been disabled by the calling
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003224 * admin, if specified, or all admins.
Robin Lee25e26452015-06-02 09:56:29 -07003225 * @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 +01003226 * have disabled screen capture.
3227 */
Robin Lee25e26452015-06-02 09:56:29 -07003228 public boolean getScreenCaptureDisabled(@Nullable ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003229 throwIfParentInstance("getScreenCaptureDisabled");
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003230 return getScreenCaptureDisabled(admin, myUserId());
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003231 }
3232
3233 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07003234 public boolean getScreenCaptureDisabled(@Nullable ComponentName admin, int userHandle) {
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003235 if (mService != null) {
3236 try {
3237 return mService.getScreenCaptureDisabled(admin, userHandle);
3238 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003239 throw e.rethrowFromSystemServer();
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003240 }
3241 }
3242 return false;
3243 }
3244
3245 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003246 * Called by a device owner to set whether auto time is required. If auto time is required the
3247 * user cannot set the date and time, but has to use network date and time.
3248 * <p>
3249 * Note: if auto time is required the user can still manually set the time zone.
3250 * <p>
3251 * The calling device admin must be a device owner. If it is not, a security exception will be
3252 * thrown.
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003253 *
3254 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3255 * @param required Whether auto time is set required or not.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003256 * @throws SecurityException if {@code admin} is not a device owner.
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003257 */
Robin Lee25e26452015-06-02 09:56:29 -07003258 public void setAutoTimeRequired(@NonNull ComponentName admin, boolean required) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003259 throwIfParentInstance("setAutoTimeRequired");
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003260 if (mService != null) {
3261 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08003262 mService.setAutoTimeRequired(admin, required);
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003263 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003264 throw e.rethrowFromSystemServer();
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003265 }
3266 }
3267 }
3268
3269 /**
3270 * @return true if auto time is required.
3271 */
3272 public boolean getAutoTimeRequired() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003273 throwIfParentInstance("getAutoTimeRequired");
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003274 if (mService != null) {
3275 try {
3276 return mService.getAutoTimeRequired();
3277 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003278 throw e.rethrowFromSystemServer();
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003279 }
3280 }
3281 return false;
3282 }
3283
3284 /**
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003285 * Called by a device owner to set whether all users created on the device should be ephemeral.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003286 * <p>
3287 * The system user is exempt from this policy - it is never ephemeral.
3288 * <p>
3289 * The calling device admin must be the device owner. If it is not, a security exception will be
3290 * thrown.
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003291 *
3292 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3293 * @param forceEphemeralUsers If true, all the existing users will be deleted and all
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003294 * subsequently created users will be ephemeral.
3295 * @throws SecurityException if {@code admin} is not a device owner.
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003296 * @hide
3297 */
3298 public void setForceEphemeralUsers(
3299 @NonNull ComponentName admin, boolean forceEphemeralUsers) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003300 throwIfParentInstance("setForceEphemeralUsers");
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003301 if (mService != null) {
3302 try {
3303 mService.setForceEphemeralUsers(admin, forceEphemeralUsers);
3304 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003305 throw e.rethrowFromSystemServer();
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003306 }
3307 }
3308 }
3309
3310 /**
3311 * @return true if all users are created ephemeral.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003312 * @throws SecurityException if {@code admin} is not a device owner.
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003313 * @hide
3314 */
3315 public boolean getForceEphemeralUsers(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003316 throwIfParentInstance("getForceEphemeralUsers");
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003317 if (mService != null) {
3318 try {
3319 return mService.getForceEphemeralUsers(admin);
3320 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003321 throw e.rethrowFromSystemServer();
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003322 }
3323 }
3324 return false;
3325 }
3326
3327 /**
Jim Miller48b9b0d2012-09-19 23:16:50 -07003328 * Called by an application that is administering the device to disable keyguard customizations,
3329 * such as widgets. After setting this, keyguard features will be disabled according to the
3330 * provided feature list.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003331 * <p>
3332 * The calling device admin must have requested
3333 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES} to be able to call this method;
3334 * if it has not, a security exception will be thrown.
3335 * <p>
3336 * Calling this from a managed profile before version {@link android.os.Build.VERSION_CODES#M}
3337 * will throw a security exception. From version {@link android.os.Build.VERSION_CODES#M} the
3338 * profile owner of a managed profile can set:
Kenny Guy0b7dd1e2015-03-12 17:14:38 +00003339 * <ul>
Esteban Talaverac1c83592016-02-17 17:56:15 +00003340 * <li>{@link #KEYGUARD_DISABLE_TRUST_AGENTS}, which affects the parent user, but only if there
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003341 * is no separate challenge set on the managed profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00003342 * <li>{@link #KEYGUARD_DISABLE_FINGERPRINT} which affects the managed profile challenge if
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003343 * there is one, or the parent user otherwise.
3344 * <li>{@link #KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS} which affects notifications generated
3345 * by applications in the managed profile.
Kenny Guy0b7dd1e2015-03-12 17:14:38 +00003346 * </ul>
Esteban Talaverac1c83592016-02-17 17:56:15 +00003347 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} and {@link #KEYGUARD_DISABLE_FINGERPRINT} can also be
3348 * set on the {@link DevicePolicyManager} instance returned by
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003349 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
3350 * profile.
3351 * <p>
3352 * Requests to disable other features on a managed profile will be ignored.
3353 * <p>
3354 * The admin can check which features have been disabled by calling
Kenny Guy0b7dd1e2015-03-12 17:14:38 +00003355 * {@link #getKeyguardDisabledFeatures(ComponentName)}
Amith Yamasani242f4b12014-10-14 16:06:13 -07003356 *
Jim Millerb8ec4702012-08-31 17:19:10 -07003357 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Jim Miller35207742012-11-02 15:33:20 -07003358 * @param which {@link #KEYGUARD_DISABLE_FEATURES_NONE} (default),
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003359 * {@link #KEYGUARD_DISABLE_WIDGETS_ALL}, {@link #KEYGUARD_DISABLE_SECURE_CAMERA},
3360 * {@link #KEYGUARD_DISABLE_SECURE_NOTIFICATIONS},
3361 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS},
3362 * {@link #KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS},
3363 * {@link #KEYGUARD_DISABLE_FINGERPRINT}, {@link #KEYGUARD_DISABLE_FEATURES_ALL}
3364 * @throws SecurityException if {@code admin} is not an active administrator or does not user
3365 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES}
Jim Millerb8ec4702012-08-31 17:19:10 -07003366 */
Robin Lee25e26452015-06-02 09:56:29 -07003367 public void setKeyguardDisabledFeatures(@NonNull ComponentName admin, int which) {
Jim Millerb8ec4702012-08-31 17:19:10 -07003368 if (mService != null) {
3369 try {
Esteban Talavera62399912016-01-11 15:37:55 +00003370 mService.setKeyguardDisabledFeatures(admin, which, mParentInstance);
Jim Millerb8ec4702012-08-31 17:19:10 -07003371 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003372 throw e.rethrowFromSystemServer();
Jim Millerb8ec4702012-08-31 17:19:10 -07003373 }
3374 }
3375 }
3376
3377 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08003378 * Determine whether or not features have been disabled in keyguard either by the calling
Rubin Xud3609d42016-07-13 18:32:57 +01003379 * admin, if specified, or all admins that set restrictions on this user and its participating
Esteban Talaverac1c83592016-02-17 17:56:15 +00003380 * profiles. Restrictions on profiles that have a separate challenge are not taken into account.
3381 *
3382 * <p>This method can be called on the {@link DevicePolicyManager} instance
3383 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
3384 * restrictions on the parent profile.
3385 *
Esteban Talavera62399912016-01-11 15:37:55 +00003386 * @param admin The name of the admin component to check, or {@code null} to check whether any
3387 * admins have disabled features in keyguard.
Jim Miller35207742012-11-02 15:33:20 -07003388 * @return bitfield of flags. See {@link #setKeyguardDisabledFeatures(ComponentName, int)}
3389 * for a list.
Jim Millerb8ec4702012-08-31 17:19:10 -07003390 */
Robin Lee25e26452015-06-02 09:56:29 -07003391 public int getKeyguardDisabledFeatures(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003392 return getKeyguardDisabledFeatures(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003393 }
3394
3395 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07003396 public int getKeyguardDisabledFeatures(@Nullable ComponentName admin, int userHandle) {
Jim Millerb8ec4702012-08-31 17:19:10 -07003397 if (mService != null) {
3398 try {
Esteban Talavera62399912016-01-11 15:37:55 +00003399 return mService.getKeyguardDisabledFeatures(admin, userHandle, mParentInstance);
Jim Millerb8ec4702012-08-31 17:19:10 -07003400 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003401 throw e.rethrowFromSystemServer();
Jim Millerb8ec4702012-08-31 17:19:10 -07003402 }
3403 }
Jim Miller48b9b0d2012-09-19 23:16:50 -07003404 return KEYGUARD_DISABLE_FEATURES_NONE;
Jim Millerb8ec4702012-08-31 17:19:10 -07003405 }
3406
3407 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -08003408 * @hide
3409 */
Robin Lee25e26452015-06-02 09:56:29 -07003410 public void setActiveAdmin(@NonNull ComponentName policyReceiver, boolean refreshing,
3411 int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08003412 if (mService != null) {
3413 try {
Jessica Hummel6d36b602014-04-04 12:42:17 +01003414 mService.setActiveAdmin(policyReceiver, refreshing, userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08003415 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003416 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08003417 }
3418 }
3419 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07003420
Dianne Hackbornd6847842010-01-12 18:14:19 -08003421 /**
Jessica Hummel6d36b602014-04-04 12:42:17 +01003422 * @hide
3423 */
Robin Lee25e26452015-06-02 09:56:29 -07003424 public void setActiveAdmin(@NonNull ComponentName policyReceiver, boolean refreshing) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003425 setActiveAdmin(policyReceiver, refreshing, myUserId());
Jessica Hummel6d36b602014-04-04 12:42:17 +01003426 }
3427
3428 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -08003429 * @hide
3430 */
Robin Lee25e26452015-06-02 09:56:29 -07003431 public void getRemoveWarning(@Nullable ComponentName admin, RemoteCallback result) {
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08003432 if (mService != null) {
3433 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003434 mService.getRemoveWarning(admin, result, myUserId());
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08003435 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003436 throw e.rethrowFromSystemServer();
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08003437 }
3438 }
3439 }
3440
3441 /**
3442 * @hide
3443 */
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07003444 public void setActivePasswordState(int quality, int length, int letters, int uppercase,
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003445 int lowercase, int numbers, int symbols, int nonletter, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08003446 if (mService != null) {
3447 try {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07003448 mService.setActivePasswordState(quality, length, letters, uppercase, lowercase,
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003449 numbers, symbols, nonletter, userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08003450 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003451 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08003452 }
3453 }
3454 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07003455
Dianne Hackbornd6847842010-01-12 18:14:19 -08003456 /**
3457 * @hide
3458 */
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003459 public void reportFailedPasswordAttempt(int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08003460 if (mService != null) {
3461 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003462 mService.reportFailedPasswordAttempt(userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08003463 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003464 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08003465 }
3466 }
3467 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07003468
Dianne Hackbornd6847842010-01-12 18:14:19 -08003469 /**
3470 * @hide
3471 */
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003472 public void reportSuccessfulPasswordAttempt(int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08003473 if (mService != null) {
3474 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003475 mService.reportSuccessfulPasswordAttempt(userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08003476 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003477 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08003478 }
3479 }
3480 }
Amith Yamasani71e6c692013-03-24 17:39:28 -07003481
3482 /**
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003483 * @hide
3484 */
3485 public void reportFailedFingerprintAttempt(int userHandle) {
3486 if (mService != null) {
3487 try {
3488 mService.reportFailedFingerprintAttempt(userHandle);
3489 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003490 throw e.rethrowFromSystemServer();
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003491 }
3492 }
3493 }
3494
3495 /**
3496 * @hide
3497 */
3498 public void reportSuccessfulFingerprintAttempt(int userHandle) {
3499 if (mService != null) {
3500 try {
3501 mService.reportSuccessfulFingerprintAttempt(userHandle);
3502 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003503 throw e.rethrowFromSystemServer();
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003504 }
3505 }
3506 }
3507
3508 /**
Michal Karpinski31502d32016-01-25 16:43:07 +00003509 * Should be called when keyguard has been dismissed.
3510 * @hide
3511 */
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003512 public void reportKeyguardDismissed(int userHandle) {
Michal Karpinski31502d32016-01-25 16:43:07 +00003513 if (mService != null) {
3514 try {
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003515 mService.reportKeyguardDismissed(userHandle);
Michal Karpinski31502d32016-01-25 16:43:07 +00003516 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003517 throw e.rethrowFromSystemServer();
Michal Karpinski31502d32016-01-25 16:43:07 +00003518 }
3519 }
3520 }
3521
3522 /**
3523 * Should be called when keyguard view has been shown to the user.
3524 * @hide
3525 */
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003526 public void reportKeyguardSecured(int userHandle) {
Michal Karpinski31502d32016-01-25 16:43:07 +00003527 if (mService != null) {
3528 try {
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003529 mService.reportKeyguardSecured(userHandle);
Michal Karpinski31502d32016-01-25 16:43:07 +00003530 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003531 throw e.rethrowFromSystemServer();
Michal Karpinski31502d32016-01-25 16:43:07 +00003532 }
3533 }
3534 }
3535
3536 /**
Amith Yamasani71e6c692013-03-24 17:39:28 -07003537 * @hide
Nicolas Prevot28063742015-01-08 15:37:12 +00003538 * Sets the given package as the device owner.
Makoto Onukia52562c2015-10-01 16:12:31 -07003539 * Same as {@link #setDeviceOwner(ComponentName, String)} but without setting a device owner name.
3540 * @param who the component name to be registered as device owner.
Amith Yamasani71e6c692013-03-24 17:39:28 -07003541 * @return whether the package was successfully registered as the device owner.
3542 * @throws IllegalArgumentException if the package name is null or invalid
Nicolas Prevot28063742015-01-08 15:37:12 +00003543 * @throws IllegalStateException If the preconditions mentioned are not met.
Amith Yamasani71e6c692013-03-24 17:39:28 -07003544 */
Makoto Onukia52562c2015-10-01 16:12:31 -07003545 public boolean setDeviceOwner(ComponentName who) {
3546 return setDeviceOwner(who, null);
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003547 }
3548
3549 /**
3550 * @hide
Makoto Onuki58b684f2015-09-04 10:48:16 -07003551 */
Makoto Onukia52562c2015-10-01 16:12:31 -07003552 public boolean setDeviceOwner(ComponentName who, int userId) {
3553 return setDeviceOwner(who, null, userId);
Makoto Onuki58b684f2015-09-04 10:48:16 -07003554 }
3555
3556 /**
3557 * @hide
3558 */
Makoto Onukia52562c2015-10-01 16:12:31 -07003559 public boolean setDeviceOwner(ComponentName who, String ownerName) {
3560 return setDeviceOwner(who, ownerName, UserHandle.USER_SYSTEM);
Makoto Onuki58b684f2015-09-04 10:48:16 -07003561 }
3562
3563 /**
3564 * @hide
Nicolas Prevot28063742015-01-08 15:37:12 +00003565 * Sets the given package as the device owner. The package must already be installed. There
3566 * must not already be a device owner.
3567 * Only apps with the MANAGE_PROFILE_AND_DEVICE_OWNERS permission and the shell uid can call
3568 * this method.
3569 * Calling this after the setup phase of the primary user has completed is allowed only if
3570 * the caller is the shell uid, and there are no additional users and no accounts.
Makoto Onukia52562c2015-10-01 16:12:31 -07003571 * @param who the component name to be registered as device owner.
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003572 * @param ownerName the human readable name of the institution that owns this device.
Makoto Onuki58b684f2015-09-04 10:48:16 -07003573 * @param userId ID of the user on which the device owner runs.
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003574 * @return whether the package was successfully registered as the device owner.
3575 * @throws IllegalArgumentException if the package name is null or invalid
Nicolas Prevot28063742015-01-08 15:37:12 +00003576 * @throws IllegalStateException If the preconditions mentioned are not met.
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003577 */
Makoto Onukia52562c2015-10-01 16:12:31 -07003578 public boolean setDeviceOwner(ComponentName who, String ownerName, int userId)
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003579 throws IllegalArgumentException, IllegalStateException {
Amith Yamasani71e6c692013-03-24 17:39:28 -07003580 if (mService != null) {
3581 try {
Makoto Onukia52562c2015-10-01 16:12:31 -07003582 return mService.setDeviceOwner(who, ownerName, userId);
Amith Yamasani71e6c692013-03-24 17:39:28 -07003583 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003584 throw re.rethrowFromSystemServer();
Amith Yamasani71e6c692013-03-24 17:39:28 -07003585 }
3586 }
3587 return false;
3588 }
3589
3590 /**
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003591 * Used to determine if a particular package has been registered as a Device Owner app.
3592 * A device owner app is a special device admin that cannot be deactivated by the user, once
Robin Lee25e26452015-06-02 09:56:29 -07003593 * activated as a device admin. It also cannot be uninstalled. To check whether a particular
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003594 * package is currently registered as the device owner app, pass in the package name from
3595 * {@link Context#getPackageName()} to this method.<p/>This is useful for device
Robin Lee25e26452015-06-02 09:56:29 -07003596 * admin apps that want to check whether they are also registered as the device owner app. The
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003597 * exact mechanism by which a device admin app is registered as a device owner app is defined by
3598 * the setup process.
3599 * @param packageName the package name of the app, to compare with the registered device owner
3600 * app, if any.
Makoto Onukic8a5a552015-11-19 14:29:12 -08003601 * @return whether or not the package is registered as the device owner app.
Amith Yamasani71e6c692013-03-24 17:39:28 -07003602 */
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003603 public boolean isDeviceOwnerApp(String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003604 throwIfParentInstance("isDeviceOwnerApp");
Makoto Onukic8a5a552015-11-19 14:29:12 -08003605 return isDeviceOwnerAppOnCallingUser(packageName);
3606 }
3607
3608 /**
3609 * @return true if a package is registered as device owner, only when it's running on the
3610 * calling user.
3611 *
3612 * <p>Same as {@link #isDeviceOwnerApp}, but bundled code should use it for clarity.
3613 * @hide
3614 */
3615 public boolean isDeviceOwnerAppOnCallingUser(String packageName) {
3616 return isDeviceOwnerAppOnAnyUserInner(packageName, /* callingUserOnly =*/ true);
3617 }
3618
3619 /**
3620 * @return true if a package is registered as device owner, even if it's running on a different
3621 * user.
3622 *
3623 * <p>Requires the MANAGE_USERS permission.
3624 *
3625 * @hide
3626 */
3627 public boolean isDeviceOwnerAppOnAnyUser(String packageName) {
3628 return isDeviceOwnerAppOnAnyUserInner(packageName, /* callingUserOnly =*/ false);
3629 }
3630
3631 /**
3632 * @return device owner component name, only when it's running on the calling user.
3633 *
3634 * @hide
3635 */
3636 public ComponentName getDeviceOwnerComponentOnCallingUser() {
3637 return getDeviceOwnerComponentInner(/* callingUserOnly =*/ true);
3638 }
3639
3640 /**
3641 * @return device owner component name, even if it's running on a different user.
3642 *
3643 * <p>Requires the MANAGE_USERS permission.
3644 *
3645 * @hide
3646 */
3647 public ComponentName getDeviceOwnerComponentOnAnyUser() {
3648 return getDeviceOwnerComponentInner(/* callingUserOnly =*/ false);
3649 }
3650
3651 private boolean isDeviceOwnerAppOnAnyUserInner(String packageName, boolean callingUserOnly) {
Makoto Onuki70f929e2015-11-11 12:40:15 -08003652 if (packageName == null) {
3653 return false;
Amith Yamasani71e6c692013-03-24 17:39:28 -07003654 }
Makoto Onukic8a5a552015-11-19 14:29:12 -08003655 final ComponentName deviceOwner = getDeviceOwnerComponentInner(callingUserOnly);
Makoto Onuki70f929e2015-11-11 12:40:15 -08003656 if (deviceOwner == null) {
3657 return false;
3658 }
3659 return packageName.equals(deviceOwner.getPackageName());
Amith Yamasani71e6c692013-03-24 17:39:28 -07003660 }
3661
Makoto Onukic8a5a552015-11-19 14:29:12 -08003662 private ComponentName getDeviceOwnerComponentInner(boolean callingUserOnly) {
3663 if (mService != null) {
3664 try {
3665 return mService.getDeviceOwnerComponent(callingUserOnly);
3666 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003667 throw re.rethrowFromSystemServer();
Makoto Onukic8a5a552015-11-19 14:29:12 -08003668 }
3669 }
3670 return null;
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003671 }
3672
Jason Monkb0dced82014-06-06 14:36:20 -04003673 /**
Makoto Onukic8a5a552015-11-19 14:29:12 -08003674 * @return ID of the user who runs device owner, or {@link UserHandle#USER_NULL} if there's
3675 * no device owner.
3676 *
3677 * <p>Requires the MANAGE_USERS permission.
Makoto Onukia52562c2015-10-01 16:12:31 -07003678 *
3679 * @hide
3680 */
Makoto Onukic8a5a552015-11-19 14:29:12 -08003681 public int getDeviceOwnerUserId() {
3682 if (mService != null) {
3683 try {
3684 return mService.getDeviceOwnerUserId();
3685 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003686 throw re.rethrowFromSystemServer();
Makoto Onukic8a5a552015-11-19 14:29:12 -08003687 }
3688 }
3689 return UserHandle.USER_NULL;
Makoto Onukia52562c2015-10-01 16:12:31 -07003690 }
3691
3692 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003693 * Clears the current device owner. The caller must be the device owner. This function should be
3694 * used cautiously as once it is called it cannot be undone. The device owner can only be set as
3695 * a part of device setup before setup completes.
Jason Monk94d2cf92014-06-18 09:53:34 -04003696 *
3697 * @param packageName The package name of the device owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003698 * @throws SecurityException if the caller is not in {@code packageName} or {@code packageName}
3699 * does not own the current device owner component.
Jason Monkb0dced82014-06-06 14:36:20 -04003700 */
Jason Monk94d2cf92014-06-18 09:53:34 -04003701 public void clearDeviceOwnerApp(String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003702 throwIfParentInstance("clearDeviceOwnerApp");
Jason Monkb0dced82014-06-06 14:36:20 -04003703 if (mService != null) {
3704 try {
Jason Monk94d2cf92014-06-18 09:53:34 -04003705 mService.clearDeviceOwner(packageName);
Jason Monkb0dced82014-06-06 14:36:20 -04003706 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003707 throw re.rethrowFromSystemServer();
Jason Monkb0dced82014-06-06 14:36:20 -04003708 }
3709 }
3710 }
3711
Makoto Onukia52562c2015-10-01 16:12:31 -07003712 /**
Makoto Onukic8a5a552015-11-19 14:29:12 -08003713 * Returns the device owner package name, only if it's running on the calling user.
3714 *
3715 * <p>Bundled components should use {@code getDeviceOwnerComponentOnCallingUser()} for clarity.
Makoto Onukia52562c2015-10-01 16:12:31 -07003716 *
3717 * @hide
3718 */
Nicolas Prevot465acf32014-08-06 17:03:25 +01003719 @SystemApi
Amith Yamasani71e6c692013-03-24 17:39:28 -07003720 public String getDeviceOwner() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003721 throwIfParentInstance("getDeviceOwner");
Makoto Onukic8a5a552015-11-19 14:29:12 -08003722 final ComponentName name = getDeviceOwnerComponentOnCallingUser();
3723 return name != null ? name.getPackageName() : null;
Makoto Onukia52562c2015-10-01 16:12:31 -07003724 }
3725
3726 /**
Makoto Onukic8a5a552015-11-19 14:29:12 -08003727 * @return true if the device is managed by any device owner.
3728 *
3729 * <p>Requires the MANAGE_USERS permission.
Makoto Onukia52562c2015-10-01 16:12:31 -07003730 *
3731 * @hide
3732 */
Makoto Onukic8a5a552015-11-19 14:29:12 -08003733 public boolean isDeviceManaged() {
3734 return getDeviceOwnerComponentOnAnyUser() != null;
3735 }
3736
3737 /**
3738 * Returns the device owner name. Note this method *will* return the device owner
3739 * name when it's running on a different user.
3740 *
3741 * <p>Requires the MANAGE_USERS permission.
3742 *
3743 * @hide
3744 */
Makoto Onukia2b274b2016-01-19 13:26:02 -08003745 @SystemApi
Makoto Onukic8a5a552015-11-19 14:29:12 -08003746 public String getDeviceOwnerNameOnAnyUser() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003747 throwIfParentInstance("getDeviceOwnerNameOnAnyUser");
Amith Yamasani71e6c692013-03-24 17:39:28 -07003748 if (mService != null) {
3749 try {
Makoto Onukia52562c2015-10-01 16:12:31 -07003750 return mService.getDeviceOwnerName();
Amith Yamasani71e6c692013-03-24 17:39:28 -07003751 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003752 throw re.rethrowFromSystemServer();
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003753 }
3754 }
3755 return null;
3756 }
Adam Connors776c5552014-01-09 10:42:56 +00003757
3758 /**
Julia Reynolds94e7bf62015-06-10 14:44:56 -04003759 * @hide
Craig Lafayettee7ee54e2015-09-21 13:48:53 -04003760 * @deprecated Do not use
3761 * @removed
Julia Reynolds20118f12015-02-11 12:34:08 -05003762 */
Craig Lafayettee7ee54e2015-09-21 13:48:53 -04003763 @Deprecated
Julia Reynolds20118f12015-02-11 12:34:08 -05003764 @SystemApi
3765 public String getDeviceInitializerApp() {
Julia Reynolds20118f12015-02-11 12:34:08 -05003766 return null;
3767 }
3768
3769 /**
Julia Reynoldseaafdf722015-04-02 08:49:47 -04003770 * @hide
Craig Lafayettee7ee54e2015-09-21 13:48:53 -04003771 * @deprecated Do not use
3772 * @removed
Julia Reynoldseaafdf722015-04-02 08:49:47 -04003773 */
Craig Lafayettee7ee54e2015-09-21 13:48:53 -04003774 @Deprecated
Julia Reynoldseaafdf722015-04-02 08:49:47 -04003775 @SystemApi
3776 public ComponentName getDeviceInitializerComponent() {
Julia Reynoldseaafdf722015-04-02 08:49:47 -04003777 return null;
3778 }
3779
Julia Reynolds20118f12015-02-11 12:34:08 -05003780 /**
Adam Connors776c5552014-01-09 10:42:56 +00003781 * @hide
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003782 * @deprecated Use #ACTION_SET_PROFILE_OWNER
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303783 * Sets the given component as an active admin and registers the package as the profile
3784 * owner for this user. The package must already be installed and there shouldn't be
3785 * an existing profile owner registered for this user. Also, this method must be called
3786 * before the user setup has been completed.
3787 * <p>
3788 * This method can only be called by system apps that hold MANAGE_USERS permission and
3789 * MANAGE_DEVICE_ADMINS permission.
3790 * @param admin The component to register as an active admin and profile owner.
3791 * @param ownerName The user-visible name of the entity that is managing this user.
3792 * @return whether the admin was successfully registered as the profile owner.
3793 * @throws IllegalArgumentException if packageName is null, the package isn't installed, or
3794 * the user has already been set up.
3795 */
Justin Morey80440cc2014-07-24 09:16:35 -05003796 @SystemApi
Robin Lee25e26452015-06-02 09:56:29 -07003797 public boolean setActiveProfileOwner(@NonNull ComponentName admin, @Deprecated String ownerName)
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303798 throws IllegalArgumentException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003799 throwIfParentInstance("setActiveProfileOwner");
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303800 if (mService != null) {
3801 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003802 final int myUserId = myUserId();
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303803 mService.setActiveAdmin(admin, false, myUserId);
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003804 return mService.setProfileOwner(admin, ownerName, myUserId);
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303805 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003806 throw re.rethrowFromSystemServer();
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303807 }
3808 }
3809 return false;
3810 }
3811
3812 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003813 * Clears the active profile owner and removes all user restrictions. The caller must be from
3814 * the same package as the active profile owner for this user, otherwise a SecurityException
3815 * will be thrown.
3816 * <p>
3817 * This doesn't work for managed profile owners.
Makoto Onuki5bf68022016-01-27 13:49:19 -08003818 *
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003819 * @param admin The component to remove as the profile owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003820 * @throws SecurityException if {@code admin} is not an active profile owner.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003821 */
Robin Lee25e26452015-06-02 09:56:29 -07003822 public void clearProfileOwner(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003823 throwIfParentInstance("clearProfileOwner");
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003824 if (mService != null) {
3825 try {
3826 mService.clearProfileOwner(admin);
3827 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003828 throw re.rethrowFromSystemServer();
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003829 }
3830 }
3831 }
3832
3833 /**
Julia Reynoldse9254402015-02-11 12:34:08 -05003834 * @hide
Robin Lee25e26452015-06-02 09:56:29 -07003835 * Checks whether the user was already setup.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003836 */
3837 public boolean hasUserSetupCompleted() {
3838 if (mService != null) {
3839 try {
3840 return mService.hasUserSetupCompleted();
3841 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003842 throw re.rethrowFromSystemServer();
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003843 }
3844 }
3845 return true;
3846 }
3847
3848 /**
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003849 * @hide
3850 * Sets the given component as the profile owner of the given user profile. The package must
Nicolas Prevot28063742015-01-08 15:37:12 +00003851 * already be installed. There must not already be a profile owner for this user.
3852 * Only apps with the MANAGE_PROFILE_AND_DEVICE_OWNERS permission and the shell uid can call
3853 * this method.
3854 * Calling this after the setup phase of the specified user has completed is allowed only if:
3855 * - the caller is SYSTEM_UID.
3856 * - or the caller is the shell uid, and there are no accounts on the specified user.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003857 * @param admin the component name to be registered as profile owner.
3858 * @param ownerName the human readable name of the organisation associated with this DPM.
3859 * @param userHandle the userId to set the profile owner for.
3860 * @return whether the component was successfully registered as the profile owner.
Nicolas Prevot28063742015-01-08 15:37:12 +00003861 * @throws IllegalArgumentException if admin is null, the package isn't installed, or the
3862 * preconditions mentioned are not met.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003863 */
Robin Lee25e26452015-06-02 09:56:29 -07003864 public boolean setProfileOwner(@NonNull ComponentName admin, @Deprecated String ownerName,
Robin Leeddd553f2015-04-30 14:18:22 +01003865 int userHandle) throws IllegalArgumentException {
Adam Connors776c5552014-01-09 10:42:56 +00003866 if (mService != null) {
3867 try {
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003868 if (ownerName == null) {
3869 ownerName = "";
3870 }
3871 return mService.setProfileOwner(admin, ownerName, userHandle);
Adam Connors776c5552014-01-09 10:42:56 +00003872 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003873 throw re.rethrowFromSystemServer();
Adam Connors776c5552014-01-09 10:42:56 +00003874 }
3875 }
3876 return false;
3877 }
3878
3879 /**
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003880 * Sets the device owner information to be shown on the lock screen.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003881 * <p>
3882 * If the device owner information is {@code null} or empty then the device owner info is
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003883 * cleared and the user owner info is shown on the lock screen if it is set.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003884 * <p>
3885 * If the device owner information contains only whitespaces then the message on the lock screen
3886 * will be blank and the user will not be allowed to change it.
3887 * <p>
3888 * If the device owner information needs to be localized, it is the responsibility of the
Benjamin Franz3e8a7092016-01-25 16:19:08 +00003889 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
3890 * and set a new version of this string accordingly.
3891 *
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003892 * @param admin The name of the admin component to check.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003893 * @param info Device owner information which will be displayed instead of the user owner info.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003894 * @throws SecurityException if {@code admin} is not a device owner.
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003895 */
Andrei Stingaceanu16187902016-03-21 15:44:45 +00003896 public void setDeviceOwnerLockScreenInfo(@NonNull ComponentName admin, CharSequence info) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003897 throwIfParentInstance("setDeviceOwnerLockScreenInfo");
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003898 if (mService != null) {
3899 try {
Andrei Stingaceanu16187902016-03-21 15:44:45 +00003900 mService.setDeviceOwnerLockScreenInfo(admin, info);
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003901 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003902 throw re.rethrowFromSystemServer();
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003903 }
3904 }
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003905 }
3906
3907 /**
3908 * @return The device owner information. If it is not set returns {@code null}.
3909 */
Andrei Stingaceanu16187902016-03-21 15:44:45 +00003910 public CharSequence getDeviceOwnerLockScreenInfo() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003911 throwIfParentInstance("getDeviceOwnerLockScreenInfo");
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003912 if (mService != null) {
3913 try {
3914 return mService.getDeviceOwnerLockScreenInfo();
3915 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003916 throw re.rethrowFromSystemServer();
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003917 }
3918 }
3919 return null;
3920 }
3921
3922 /**
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00003923 * Called by device or profile owners to suspend packages for this user.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003924 * <p>
3925 * A suspended package will not be able to start activities. Its notifications will be hidden,
3926 * it will not show up in recents, will not be able to show toasts or dialogs or ring the
3927 * device.
3928 * <p>
3929 * The package must already be installed. If the package is uninstalled while suspended the
3930 * package will no longer be suspended. The admin can block this by using
Kenny Guy871f3eb2016-03-09 20:06:16 +00003931 * {@link #setUninstallBlocked}.
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003932 *
3933 * @param admin The name of the admin component to check.
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00003934 * @param packageNames The package names to suspend or unsuspend.
3935 * @param suspended If set to {@code true} than the packages will be suspended, if set to
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003936 * {@code false} the packages will be unsuspended.
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00003937 * @return an array of package names for which the suspended status is not set as requested in
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003938 * this method.
3939 * @throws SecurityException if {@code admin} is not a device or profile owner.
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003940 */
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00003941 public String[] setPackagesSuspended(@NonNull ComponentName admin, String[] packageNames,
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003942 boolean suspended) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003943 throwIfParentInstance("setPackagesSuspended");
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003944 if (mService != null) {
3945 try {
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00003946 return mService.setPackagesSuspended(admin, packageNames, suspended);
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003947 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003948 throw re.rethrowFromSystemServer();
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003949 }
3950 }
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00003951 return packageNames;
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003952 }
3953
3954 /**
3955 * Called by device or profile owners to determine if a package is suspended.
3956 *
3957 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3958 * @param packageName The name of the package to retrieve the suspended status of.
Andrei Stingaceanu355b2322016-02-12 16:43:51 +00003959 * @return {@code true} if the package is suspended or {@code false} if the package is not
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003960 * suspended, could not be found or an error occurred.
3961 * @throws SecurityException if {@code admin} is not a device or profile owner.
Andrei Stingaceanuefc4a342016-03-22 14:43:01 +00003962 * @throws NameNotFoundException if the package could not be found.
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003963 */
Andrei Stingaceanuefc4a342016-03-22 14:43:01 +00003964 public boolean isPackageSuspended(@NonNull ComponentName admin, String packageName)
3965 throws NameNotFoundException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003966 throwIfParentInstance("isPackageSuspended");
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003967 if (mService != null) {
3968 try {
Andrei Stingaceanuefc4a342016-03-22 14:43:01 +00003969 return mService.isPackageSuspended(admin, packageName);
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003970 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003971 throw e.rethrowFromSystemServer();
Andrei Stingaceanuefc4a342016-03-22 14:43:01 +00003972 } catch (IllegalArgumentException ex) {
3973 throw new NameNotFoundException(packageName);
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003974 }
3975 }
3976 return false;
3977 }
3978
3979 /**
Alexandra Gherghina512675b2014-04-02 11:23:54 +01003980 * Sets the enabled state of the profile. A profile should be enabled only once it is ready to
3981 * be used. Only the profile owner can call this.
3982 *
Alexandra Gherghinadf35d572014-04-09 13:54:39 +01003983 * @see #isProfileOwnerApp
Alexandra Gherghina512675b2014-04-02 11:23:54 +01003984 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003985 * @throws SecurityException if {@code admin} is not a profile owner.
Alexandra Gherghina512675b2014-04-02 11:23:54 +01003986 */
Robin Lee25e26452015-06-02 09:56:29 -07003987 public void setProfileEnabled(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003988 throwIfParentInstance("setProfileEnabled");
Alexandra Gherghina512675b2014-04-02 11:23:54 +01003989 if (mService != null) {
3990 try {
3991 mService.setProfileEnabled(admin);
3992 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003993 throw e.rethrowFromSystemServer();
Alexandra Gherghina512675b2014-04-02 11:23:54 +01003994 }
3995 }
3996 }
3997
3998 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003999 * Sets the name of the profile. In the device owner case it sets the name of the user which it
4000 * is called from. Only a profile owner or device owner can call this. If this is never called
4001 * by the profile or device owner, the name will be set to default values.
Jessica Hummel1333ea12014-06-23 11:20:10 +01004002 *
4003 * @see #isProfileOwnerApp
4004 * @see #isDeviceOwnerApp
Robin Lee25e26452015-06-02 09:56:29 -07004005 * @param admin Which {@link DeviceAdminReceiver} this request is associate with.
Jessica Hummel1333ea12014-06-23 11:20:10 +01004006 * @param profileName The name of the profile.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004007 * @throws SecurityException if {@code admin} is not a device or profile owner.
Jessica Hummel1333ea12014-06-23 11:20:10 +01004008 */
Robin Lee25e26452015-06-02 09:56:29 -07004009 public void setProfileName(@NonNull ComponentName admin, String profileName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004010 throwIfParentInstance("setProfileName");
Jessica Hummel1333ea12014-06-23 11:20:10 +01004011 if (mService != null) {
4012 try {
Robin Lee25e26452015-06-02 09:56:29 -07004013 mService.setProfileName(admin, profileName);
Fyodor Kupolov78f13142015-05-27 16:52:45 -07004014 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004015 throw e.rethrowFromSystemServer();
Fyodor Kupolov78f13142015-05-27 16:52:45 -07004016 }
Jessica Hummel1333ea12014-06-23 11:20:10 +01004017 }
4018 }
Jessica Hummel1333ea12014-06-23 11:20:10 +01004019
4020 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07004021 * Used to determine if a particular package is registered as the profile owner for the
Makoto Onuki32b30572015-12-11 14:29:51 -08004022 * user. A profile owner is a special device admin that has additional privileges
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07004023 * within the profile.
Adam Connors776c5552014-01-09 10:42:56 +00004024 *
4025 * @param packageName The package name of the app to compare with the registered profile owner.
4026 * @return Whether or not the package is registered as the profile owner.
4027 */
4028 public boolean isProfileOwnerApp(String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004029 throwIfParentInstance("isProfileOwnerApp");
Adam Connors776c5552014-01-09 10:42:56 +00004030 if (mService != null) {
4031 try {
Makoto Onuki90b89652016-01-28 14:44:18 -08004032 ComponentName profileOwner = mService.getProfileOwner(myUserId());
Nicolas Prevot90af6d72014-07-30 14:19:12 +01004033 return profileOwner != null
4034 && profileOwner.getPackageName().equals(packageName);
Adam Connors776c5552014-01-09 10:42:56 +00004035 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004036 throw re.rethrowFromSystemServer();
Adam Connors776c5552014-01-09 10:42:56 +00004037 }
4038 }
4039 return false;
4040 }
4041
4042 /**
4043 * @hide
Robin Lee25e26452015-06-02 09:56:29 -07004044 * @return the packageName of the owner of the given user profile or {@code null} if no profile
Adam Connors776c5552014-01-09 10:42:56 +00004045 * owner has been set for that user.
4046 * @throws IllegalArgumentException if the userId is invalid.
4047 */
Nicolas Prevot465acf32014-08-06 17:03:25 +01004048 @SystemApi
Amith Yamasanibf3a9462014-07-28 14:26:42 -07004049 public ComponentName getProfileOwner() throws IllegalArgumentException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004050 throwIfParentInstance("getProfileOwner");
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01004051 return getProfileOwnerAsUser(Process.myUserHandle().getIdentifier());
4052 }
4053
4054 /**
4055 * @see #getProfileOwner()
4056 * @hide
4057 */
4058 public ComponentName getProfileOwnerAsUser(final int userId) throws IllegalArgumentException {
Adam Connors776c5552014-01-09 10:42:56 +00004059 if (mService != null) {
4060 try {
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01004061 return mService.getProfileOwner(userId);
Adam Connors776c5552014-01-09 10:42:56 +00004062 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004063 throw re.rethrowFromSystemServer();
Adam Connors776c5552014-01-09 10:42:56 +00004064 }
4065 }
4066 return null;
4067 }
4068
4069 /**
4070 * @hide
Robin Lee25e26452015-06-02 09:56:29 -07004071 * @return the human readable name of the organisation associated with this DPM or {@code null}
4072 * if one is not set.
Adam Connors776c5552014-01-09 10:42:56 +00004073 * @throws IllegalArgumentException if the userId is invalid.
4074 */
4075 public String getProfileOwnerName() throws IllegalArgumentException {
4076 if (mService != null) {
4077 try {
4078 return mService.getProfileOwnerName(Process.myUserHandle().getIdentifier());
4079 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004080 throw re.rethrowFromSystemServer();
Adam Connors776c5552014-01-09 10:42:56 +00004081 }
4082 }
4083 return null;
4084 }
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004085
4086 /**
Amith Yamasani38f836b2014-08-20 14:51:15 -07004087 * @hide
Makoto Onukic8a5a552015-11-19 14:29:12 -08004088 * @param userId The user for whom to fetch the profile owner name, if any.
Amith Yamasani38f836b2014-08-20 14:51:15 -07004089 * @return the human readable name of the organisation associated with this profile owner or
4090 * null if one is not set.
4091 * @throws IllegalArgumentException if the userId is invalid.
4092 */
4093 @SystemApi
Selim Cinek24ac55e2014-08-27 12:51:45 +02004094 public String getProfileOwnerNameAsUser(int userId) throws IllegalArgumentException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004095 throwIfParentInstance("getProfileOwnerNameAsUser");
Amith Yamasani38f836b2014-08-20 14:51:15 -07004096 if (mService != null) {
4097 try {
Selim Cinek24ac55e2014-08-27 12:51:45 +02004098 return mService.getProfileOwnerName(userId);
Amith Yamasani38f836b2014-08-20 14:51:15 -07004099 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004100 throw re.rethrowFromSystemServer();
Amith Yamasani38f836b2014-08-20 14:51:15 -07004101 }
4102 }
4103 return null;
4104 }
4105
4106 /**
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004107 * Called by a profile owner or device owner to add a default intent handler activity for
4108 * intents that match a certain intent filter. This activity will remain the default intent
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004109 * handler even if the set of potential event handlers for the intent filter changes and if the
4110 * intent preferences are reset.
4111 * <p>
4112 * The default disambiguation mechanism takes over if the activity is not installed (anymore).
4113 * When the activity is (re)installed, it is automatically reset as default intent handler for
4114 * the filter.
4115 * <p>
4116 * The calling device admin must be a profile owner or device owner. If it is not, a security
4117 * exception will be thrown.
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004118 *
4119 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4120 * @param filter The IntentFilter for which a default handler is added.
4121 * @param activity The Activity that is added as default intent handler.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004122 * @throws SecurityException if {@code admin} is not a device or profile owner.
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004123 */
Robin Lee25e26452015-06-02 09:56:29 -07004124 public void addPersistentPreferredActivity(@NonNull ComponentName admin, IntentFilter filter,
4125 @NonNull ComponentName activity) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004126 throwIfParentInstance("addPersistentPreferredActivity");
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004127 if (mService != null) {
4128 try {
4129 mService.addPersistentPreferredActivity(admin, filter, activity);
4130 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004131 throw e.rethrowFromSystemServer();
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004132 }
4133 }
4134 }
4135
4136 /**
4137 * Called by a profile owner or device owner to remove all persistent intent handler preferences
Torne (Richard Coles)875e2102014-02-24 14:11:56 +00004138 * associated with the given package that were set by {@link #addPersistentPreferredActivity}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004139 * <p>
4140 * The calling device admin must be a profile owner. If it is not, a security exception will be
4141 * thrown.
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004142 *
4143 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4144 * @param packageName The name of the package for which preferences are removed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004145 * @throws SecurityException if {@code admin} is not a device or profile owner.
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004146 */
Robin Lee25e26452015-06-02 09:56:29 -07004147 public void clearPackagePersistentPreferredActivities(@NonNull ComponentName admin,
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004148 String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004149 throwIfParentInstance("clearPackagePersistentPreferredActivities");
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004150 if (mService != null) {
4151 try {
4152 mService.clearPackagePersistentPreferredActivities(admin, packageName);
4153 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004154 throw e.rethrowFromSystemServer();
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004155 }
4156 }
4157 }
Robin Lee66e5d962014-04-09 16:44:21 +01004158
4159 /**
Esteban Talaverabf60f722015-12-10 16:26:44 +00004160 * Called by a profile owner or device owner to grant permission to a package to manage
4161 * application restrictions for the calling user via {@link #setApplicationRestrictions} and
4162 * {@link #getApplicationRestrictions}.
4163 * <p>
4164 * This permission is persistent until it is later cleared by calling this method with a
4165 * {@code null} value or uninstalling the managing package.
Rubin Xuf03d0a62016-02-10 14:54:15 +00004166 * <p>
4167 * The supplied application restriction managing package must be installed when calling this
Victor Changcd14c0a2016-03-16 19:10:15 +00004168 * API, otherwise an {@link NameNotFoundException} will be thrown.
Esteban Talaverabf60f722015-12-10 16:26:44 +00004169 *
4170 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4171 * @param packageName The package name which will be given access to application restrictions
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004172 * APIs. If {@code null} is given the current package will be cleared.
4173 * @throws SecurityException if {@code admin} is not a device or profile owner.
Victor Changcd14c0a2016-03-16 19:10:15 +00004174 * @throws NameNotFoundException if {@code packageName} is not found
Esteban Talaverabf60f722015-12-10 16:26:44 +00004175 */
4176 public void setApplicationRestrictionsManagingPackage(@NonNull ComponentName admin,
Victor Changcd14c0a2016-03-16 19:10:15 +00004177 @Nullable String packageName) throws NameNotFoundException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004178 throwIfParentInstance("setApplicationRestrictionsManagingPackage");
Esteban Talaverabf60f722015-12-10 16:26:44 +00004179 if (mService != null) {
4180 try {
Victor Changcd14c0a2016-03-16 19:10:15 +00004181 if (!mService.setApplicationRestrictionsManagingPackage(admin, packageName)) {
4182 throw new NameNotFoundException(packageName);
4183 }
Esteban Talaverabf60f722015-12-10 16:26:44 +00004184 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004185 throw e.rethrowFromSystemServer();
Esteban Talaverabf60f722015-12-10 16:26:44 +00004186 }
4187 }
4188 }
4189
4190 /**
4191 * Called by a profile owner or device owner to retrieve the application restrictions managing
4192 * package for the current user, or {@code null} if none is set.
4193 *
4194 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4195 * @return The package name allowed to manage application restrictions on the current user, or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004196 * {@code null} if none is set.
4197 * @throws SecurityException if {@code admin} is not a device or profile owner.
Esteban Talaverabf60f722015-12-10 16:26:44 +00004198 */
4199 public String getApplicationRestrictionsManagingPackage(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004200 throwIfParentInstance("getApplicationRestrictionsManagingPackage");
Esteban Talaverabf60f722015-12-10 16:26:44 +00004201 if (mService != null) {
4202 try {
4203 return mService.getApplicationRestrictionsManagingPackage(admin);
4204 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004205 throw e.rethrowFromSystemServer();
Esteban Talaverabf60f722015-12-10 16:26:44 +00004206 }
4207 }
4208 return null;
4209 }
4210
4211 /**
Esteban Talavera96895ca2016-03-16 12:00:40 +00004212 * Called by any application to find out whether it has been granted permission via
4213 * {@link #setApplicationRestrictionsManagingPackage} to manage application restrictions
4214 * for the calling user.
4215 *
4216 * <p>This is done by comparing the calling Linux uid with the uid of the package specified by
4217 * that method.
Esteban Talaverabf60f722015-12-10 16:26:44 +00004218 */
4219 public boolean isCallerApplicationRestrictionsManagingPackage() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004220 throwIfParentInstance("isCallerApplicationRestrictionsManagingPackage");
Esteban Talaverabf60f722015-12-10 16:26:44 +00004221 if (mService != null) {
4222 try {
4223 return mService.isCallerApplicationRestrictionsManagingPackage();
4224 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004225 throw e.rethrowFromSystemServer();
Esteban Talaverabf60f722015-12-10 16:26:44 +00004226 }
4227 }
4228 return false;
4229 }
4230
4231 /**
4232 * Sets the application restrictions for a given target application running in the calling user.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004233 * <p>
4234 * The caller must be a profile or device owner on that user, or the package allowed to manage
4235 * application restrictions via {@link #setApplicationRestrictionsManagingPackage}; otherwise a
4236 * security exception will be thrown.
4237 * <p>
4238 * The provided {@link Bundle} consists of key-value pairs, where the types of values may be:
Esteban Talavera6b8e0642015-08-10 17:26:04 +01004239 * <ul>
4240 * <li>{@code boolean}
4241 * <li>{@code int}
4242 * <li>{@code String} or {@code String[]}
4243 * <li>From {@link android.os.Build.VERSION_CODES#M}, {@code Bundle} or {@code Bundle[]}
4244 * </ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004245 * <p>
4246 * If the restrictions are not available yet, but may be applied in the near future, the caller
4247 * can notify the target application of that by adding
Sander Alewijnse53d63dc2014-11-07 21:43:00 +00004248 * {@link UserManager#KEY_RESTRICTIONS_PENDING} to the settings parameter.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004249 * <p>
4250 * The application restrictions are only made visible to the target application via
4251 * {@link UserManager#getApplicationRestrictions(String)}, in addition to the profile or device
4252 * owner, and the application restrictions managing package via
Esteban Talaverabf60f722015-12-10 16:26:44 +00004253 * {@link #getApplicationRestrictions}.
Robin Lee66e5d962014-04-09 16:44:21 +01004254 *
Esteban Talaverabf60f722015-12-10 16:26:44 +00004255 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004256 * {@code null} if called by the application restrictions managing package.
Robin Lee66e5d962014-04-09 16:44:21 +01004257 * @param packageName The name of the package to update restricted settings for.
4258 * @param settings A {@link Bundle} to be parsed by the receiving application, conveying a new
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004259 * set of active restrictions.
4260 * @throws SecurityException if {@code admin} is not a device or profile owner.
Esteban Talaverabf60f722015-12-10 16:26:44 +00004261 * @see #setApplicationRestrictionsManagingPackage
Sander Alewijnse53d63dc2014-11-07 21:43:00 +00004262 * @see UserManager#KEY_RESTRICTIONS_PENDING
Robin Lee66e5d962014-04-09 16:44:21 +01004263 */
Esteban Talaverabf60f722015-12-10 16:26:44 +00004264 public void setApplicationRestrictions(@Nullable ComponentName admin, String packageName,
Robin Lee66e5d962014-04-09 16:44:21 +01004265 Bundle settings) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004266 throwIfParentInstance("setApplicationRestrictions");
Robin Lee66e5d962014-04-09 16:44:21 +01004267 if (mService != null) {
4268 try {
4269 mService.setApplicationRestrictions(admin, packageName, settings);
4270 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004271 throw e.rethrowFromSystemServer();
Robin Lee66e5d962014-04-09 16:44:21 +01004272 }
4273 }
4274 }
4275
4276 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004277 * Sets a list of configuration features to enable for a TrustAgent component. This is meant to
4278 * be used in conjunction with {@link #KEYGUARD_DISABLE_TRUST_AGENTS}, which disables all trust
4279 * agents but those enabled by this function call. If flag
Jim Millere303bf42014-08-26 17:12:29 -07004280 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} is not set, then this call has no effect.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004281 * <p>
4282 * The calling device admin must have requested
4283 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES} to be able to call this method;
4284 * if not, a security exception will be thrown.
Tony Mak089d8402016-04-05 17:42:55 +01004285 * <p>
4286 * This method can be called on the {@link DevicePolicyManager} instance returned by
4287 * {@link #getParentProfileInstance(ComponentName)} in order to set the configuration for
4288 * the parent profile.
Jim Miller604e7552014-07-18 19:00:02 -07004289 *
4290 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Jim Millere303bf42014-08-26 17:12:29 -07004291 * @param target Component name of the agent to be enabled.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004292 * @param configuration TrustAgent-specific feature bundle. If null for any admin, agent will be
4293 * strictly disabled according to the state of the
4294 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} flag.
4295 * <p>
4296 * If {@link #KEYGUARD_DISABLE_TRUST_AGENTS} is set and options is not null for all
4297 * admins, then it's up to the TrustAgent itself to aggregate the values from all
4298 * device admins.
4299 * <p>
4300 * Consult documentation for the specific TrustAgent to determine legal options
4301 * parameters.
4302 * @throws SecurityException if {@code admin} is not an active administrator or does not use
4303 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES}
Jim Miller604e7552014-07-18 19:00:02 -07004304 */
Robin Lee25e26452015-06-02 09:56:29 -07004305 public void setTrustAgentConfiguration(@NonNull ComponentName admin,
4306 @NonNull ComponentName target, PersistableBundle configuration) {
Jim Miller604e7552014-07-18 19:00:02 -07004307 if (mService != null) {
4308 try {
Tony Mak089d8402016-04-05 17:42:55 +01004309 mService.setTrustAgentConfiguration(admin, target, configuration, mParentInstance);
Jim Miller604e7552014-07-18 19:00:02 -07004310 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004311 throw e.rethrowFromSystemServer();
Jim Miller604e7552014-07-18 19:00:02 -07004312 }
4313 }
4314 }
4315
4316 /**
Jim Millere303bf42014-08-26 17:12:29 -07004317 * Gets configuration for the given trust agent based on aggregating all calls to
4318 * {@link #setTrustAgentConfiguration(ComponentName, ComponentName, PersistableBundle)} for
4319 * all device admins.
Tony Mak089d8402016-04-05 17:42:55 +01004320 * <p>
4321 * This method can be called on the {@link DevicePolicyManager} instance returned by
4322 * {@link #getParentProfileInstance(ComponentName)} in order to retrieve the configuration set
4323 * on the parent profile.
Jim Miller604e7552014-07-18 19:00:02 -07004324 *
Jim Millerb5db57a2015-01-14 18:17:19 -08004325 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. If null,
4326 * this function returns a list of configurations for all admins that declare
4327 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS}. If any admin declares
4328 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} but doesn't call
4329 * {@link #setTrustAgentConfiguration(ComponentName, ComponentName, PersistableBundle)}
4330 * for this {@param agent} or calls it with a null configuration, null is returned.
Jim Miller604e7552014-07-18 19:00:02 -07004331 * @param agent Which component to get enabled features for.
Jim Millere303bf42014-08-26 17:12:29 -07004332 * @return configuration for the given trust agent.
Jim Miller604e7552014-07-18 19:00:02 -07004333 */
Robin Lee25e26452015-06-02 09:56:29 -07004334 public List<PersistableBundle> getTrustAgentConfiguration(@Nullable ComponentName admin,
4335 @NonNull ComponentName agent) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07004336 return getTrustAgentConfiguration(admin, agent, myUserId());
Jim Millere303bf42014-08-26 17:12:29 -07004337 }
4338
4339 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07004340 public List<PersistableBundle> getTrustAgentConfiguration(@Nullable ComponentName admin,
4341 @NonNull ComponentName agent, int userHandle) {
Jim Miller604e7552014-07-18 19:00:02 -07004342 if (mService != null) {
4343 try {
Tony Mak089d8402016-04-05 17:42:55 +01004344 return mService.getTrustAgentConfiguration(admin, agent, userHandle,
4345 mParentInstance);
Jim Miller604e7552014-07-18 19:00:02 -07004346 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004347 throw e.rethrowFromSystemServer();
Jim Miller604e7552014-07-18 19:00:02 -07004348 }
4349 }
Jim Millere303bf42014-08-26 17:12:29 -07004350 return new ArrayList<PersistableBundle>(); // empty list
Jim Miller604e7552014-07-18 19:00:02 -07004351 }
4352
4353 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004354 * Called by a profile owner of a managed profile to set whether caller-Id information from the
4355 * managed profile will be shown in the parent profile, for incoming calls.
4356 * <p>
4357 * The calling device admin must be a profile owner. If it is not, a security exception will be
4358 * thrown.
Adam Connors210fe212014-07-17 15:41:43 +01004359 *
Robin Lee25e26452015-06-02 09:56:29 -07004360 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Adam Connors210fe212014-07-17 15:41:43 +01004361 * @param disabled If true caller-Id information in the managed profile is not displayed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004362 * @throws SecurityException if {@code admin} is not a device or profile owner.
Adam Connors210fe212014-07-17 15:41:43 +01004363 */
Robin Lee25e26452015-06-02 09:56:29 -07004364 public void setCrossProfileCallerIdDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004365 throwIfParentInstance("setCrossProfileCallerIdDisabled");
Adam Connors210fe212014-07-17 15:41:43 +01004366 if (mService != null) {
4367 try {
Robin Lee25e26452015-06-02 09:56:29 -07004368 mService.setCrossProfileCallerIdDisabled(admin, disabled);
Adam Connors210fe212014-07-17 15:41:43 +01004369 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004370 throw e.rethrowFromSystemServer();
Adam Connors210fe212014-07-17 15:41:43 +01004371 }
4372 }
4373 }
4374
4375 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07004376 * Called by a profile owner of a managed profile to determine whether or not caller-Id
4377 * information has been disabled.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004378 * <p>
4379 * The calling device admin must be a profile owner. If it is not, a security exception will be
4380 * thrown.
Adam Connors210fe212014-07-17 15:41:43 +01004381 *
Robin Lee25e26452015-06-02 09:56:29 -07004382 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004383 * @throws SecurityException if {@code admin} is not a device or profile owner.
Adam Connors210fe212014-07-17 15:41:43 +01004384 */
Robin Lee25e26452015-06-02 09:56:29 -07004385 public boolean getCrossProfileCallerIdDisabled(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004386 throwIfParentInstance("getCrossProfileCallerIdDisabled");
Adam Connors210fe212014-07-17 15:41:43 +01004387 if (mService != null) {
4388 try {
Robin Lee25e26452015-06-02 09:56:29 -07004389 return mService.getCrossProfileCallerIdDisabled(admin);
Adam Connors210fe212014-07-17 15:41:43 +01004390 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004391 throw e.rethrowFromSystemServer();
Adam Connors210fe212014-07-17 15:41:43 +01004392 }
4393 }
4394 return false;
4395 }
4396
4397 /**
Amith Yamasani570002f2014-07-18 15:48:54 -07004398 * Determine whether or not caller-Id information has been disabled.
4399 *
4400 * @param userHandle The user for whom to check the caller-id permission
4401 * @hide
4402 */
4403 public boolean getCrossProfileCallerIdDisabled(UserHandle userHandle) {
4404 if (mService != null) {
4405 try {
4406 return mService.getCrossProfileCallerIdDisabledForUser(userHandle.getIdentifier());
4407 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004408 throw e.rethrowFromSystemServer();
Amith Yamasani570002f2014-07-18 15:48:54 -07004409 }
4410 }
4411 return false;
4412 }
4413
4414 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004415 * Called by a profile owner of a managed profile to set whether contacts search from the
4416 * managed profile will be shown in the parent profile, for incoming calls.
4417 * <p>
4418 * The calling device admin must be a profile owner. If it is not, a security exception will be
4419 * thrown.
Victor Chang1060c6182016-01-04 20:16:23 +00004420 *
4421 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4422 * @param disabled If true contacts search in the managed profile is not displayed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004423 * @throws SecurityException if {@code admin} is not a device or profile owner.
Victor Chang1060c6182016-01-04 20:16:23 +00004424 */
4425 public void setCrossProfileContactsSearchDisabled(@NonNull ComponentName admin,
4426 boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004427 throwIfParentInstance("setCrossProfileContactsSearchDisabled");
Victor Chang1060c6182016-01-04 20:16:23 +00004428 if (mService != null) {
4429 try {
4430 mService.setCrossProfileContactsSearchDisabled(admin, disabled);
4431 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004432 throw e.rethrowFromSystemServer();
Victor Chang1060c6182016-01-04 20:16:23 +00004433 }
4434 }
4435 }
4436
4437 /**
4438 * Called by a profile owner of a managed profile to determine whether or not contacts search
4439 * has been disabled.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004440 * <p>
4441 * The calling device admin must be a profile owner. If it is not, a security exception will be
4442 * thrown.
Victor Chang1060c6182016-01-04 20:16:23 +00004443 *
4444 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004445 * @throws SecurityException if {@code admin} is not a device or profile owner.
Victor Chang1060c6182016-01-04 20:16:23 +00004446 */
4447 public boolean getCrossProfileContactsSearchDisabled(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004448 throwIfParentInstance("getCrossProfileContactsSearchDisabled");
Victor Chang1060c6182016-01-04 20:16:23 +00004449 if (mService != null) {
4450 try {
4451 return mService.getCrossProfileContactsSearchDisabled(admin);
4452 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004453 throw e.rethrowFromSystemServer();
Victor Chang1060c6182016-01-04 20:16:23 +00004454 }
4455 }
4456 return false;
4457 }
4458
4459
4460 /**
4461 * Determine whether or not contacts search has been disabled.
4462 *
4463 * @param userHandle The user for whom to check the contacts search permission
4464 * @hide
4465 */
4466 public boolean getCrossProfileContactsSearchDisabled(@NonNull UserHandle userHandle) {
4467 if (mService != null) {
4468 try {
4469 return mService
4470 .getCrossProfileContactsSearchDisabledForUser(userHandle.getIdentifier());
4471 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004472 throw e.rethrowFromSystemServer();
Victor Chang1060c6182016-01-04 20:16:23 +00004473 }
4474 }
4475 return false;
4476 }
4477
4478 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08004479 * Start Quick Contact on the managed profile for the user, if the policy allows.
Victor Chang97bdacc2016-01-21 22:24:11 +00004480 *
Makoto Onuki1040da12015-03-19 11:24:00 -07004481 * @hide
4482 */
4483 public void startManagedQuickContact(String actualLookupKey, long actualContactId,
Victor Chang97bdacc2016-01-21 22:24:11 +00004484 boolean isContactIdIgnored, long directoryId, Intent originalIntent) {
Makoto Onuki1040da12015-03-19 11:24:00 -07004485 if (mService != null) {
4486 try {
Victor Chang97bdacc2016-01-21 22:24:11 +00004487 mService.startManagedQuickContact(actualLookupKey, actualContactId,
4488 isContactIdIgnored, directoryId, originalIntent);
Makoto Onuki1040da12015-03-19 11:24:00 -07004489 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004490 throw e.rethrowFromSystemServer();
Makoto Onuki1040da12015-03-19 11:24:00 -07004491 }
4492 }
4493 }
4494
4495 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08004496 * Start Quick Contact on the managed profile for the user, if the policy allows.
Ricky Wai494b95d2015-11-20 16:07:15 +00004497 * @hide
4498 */
4499 public void startManagedQuickContact(String actualLookupKey, long actualContactId,
4500 Intent originalIntent) {
Victor Chang97bdacc2016-01-21 22:24:11 +00004501 startManagedQuickContact(actualLookupKey, actualContactId, false, Directory.DEFAULT,
Ricky Wai494b95d2015-11-20 16:07:15 +00004502 originalIntent);
4503 }
4504
4505 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004506 * Called by a profile owner of a managed profile to set whether bluetooth devices can access
4507 * enterprise contacts.
Ricky Wai778ba132015-03-31 14:21:22 +01004508 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004509 * The calling device admin must be a profile owner. If it is not, a security exception will be
4510 * thrown.
Ricky Wai778ba132015-03-31 14:21:22 +01004511 * <p>
4512 * This API works on managed profile only.
4513 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004514 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4515 * @param disabled If true, bluetooth devices cannot access enterprise contacts.
4516 * @throws SecurityException if {@code admin} is not a device or profile owner.
Ricky Wai778ba132015-03-31 14:21:22 +01004517 */
Robin Lee25e26452015-06-02 09:56:29 -07004518 public void setBluetoothContactSharingDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004519 throwIfParentInstance("setBluetoothContactSharingDisabled");
Ricky Wai778ba132015-03-31 14:21:22 +01004520 if (mService != null) {
4521 try {
Robin Lee25e26452015-06-02 09:56:29 -07004522 mService.setBluetoothContactSharingDisabled(admin, disabled);
Ricky Wai778ba132015-03-31 14:21:22 +01004523 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004524 throw e.rethrowFromSystemServer();
Ricky Wai778ba132015-03-31 14:21:22 +01004525 }
4526 }
4527 }
4528
4529 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004530 * Called by a profile owner of a managed profile to determine whether or not Bluetooth devices
4531 * cannot access enterprise contacts.
Ricky Wai778ba132015-03-31 14:21:22 +01004532 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004533 * The calling device admin must be a profile owner. If it is not, a security exception will be
4534 * thrown.
Ricky Wai778ba132015-03-31 14:21:22 +01004535 * <p>
4536 * This API works on managed profile only.
4537 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004538 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4539 * @throws SecurityException if {@code admin} is not a device or profile owner.
Ricky Wai778ba132015-03-31 14:21:22 +01004540 */
Robin Lee25e26452015-06-02 09:56:29 -07004541 public boolean getBluetoothContactSharingDisabled(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004542 throwIfParentInstance("getBluetoothContactSharingDisabled");
Ricky Wai778ba132015-03-31 14:21:22 +01004543 if (mService != null) {
4544 try {
Robin Lee25e26452015-06-02 09:56:29 -07004545 return mService.getBluetoothContactSharingDisabled(admin);
Ricky Wai778ba132015-03-31 14:21:22 +01004546 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004547 throw e.rethrowFromSystemServer();
Ricky Wai778ba132015-03-31 14:21:22 +01004548 }
4549 }
4550 return true;
4551 }
4552
4553 /**
4554 * Determine whether or not Bluetooth devices cannot access contacts.
4555 * <p>
4556 * This API works on managed profile UserHandle only.
4557 *
4558 * @param userHandle The user for whom to check the caller-id permission
4559 * @hide
4560 */
4561 public boolean getBluetoothContactSharingDisabled(UserHandle userHandle) {
4562 if (mService != null) {
4563 try {
4564 return mService.getBluetoothContactSharingDisabledForUser(userHandle
4565 .getIdentifier());
4566 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004567 throw e.rethrowFromSystemServer();
Ricky Wai778ba132015-03-31 14:21:22 +01004568 }
4569 }
4570 return true;
4571 }
4572
4573 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07004574 * Called by the profile owner of a managed profile so that some intents sent in the managed
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004575 * profile can also be resolved in the parent, or vice versa. Only activity intents are
4576 * supported.
Nicolas Prevotfc7b4442014-12-17 15:28:29 +00004577 *
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004578 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Nicolas Prevot81948992014-05-16 18:25:26 +01004579 * @param filter The {@link IntentFilter} the intent has to match to be also resolved in the
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004580 * other profile
Nicolas Prevot41d926e2014-06-09 11:48:56 +01004581 * @param flags {@link DevicePolicyManager#FLAG_MANAGED_CAN_ACCESS_PARENT} and
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004582 * {@link DevicePolicyManager#FLAG_PARENT_CAN_ACCESS_MANAGED} are supported.
4583 * @throws SecurityException if {@code admin} is not a device or profile owner.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004584 */
Robin Lee25e26452015-06-02 09:56:29 -07004585 public void addCrossProfileIntentFilter(@NonNull ComponentName admin, IntentFilter filter, int flags) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004586 throwIfParentInstance("addCrossProfileIntentFilter");
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004587 if (mService != null) {
4588 try {
Nicolas Prevot81948992014-05-16 18:25:26 +01004589 mService.addCrossProfileIntentFilter(admin, filter, flags);
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004590 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004591 throw e.rethrowFromSystemServer();
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004592 }
4593 }
4594 }
4595
4596 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07004597 * Called by a profile owner of a managed profile to remove the cross-profile intent filters
4598 * that go from the managed profile to the parent, or from the parent to the managed profile.
Nicolas Prevot3f7777f2014-07-24 15:58:39 +01004599 * Only removes those that have been set by the profile owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004600 *
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004601 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004602 * @throws SecurityException if {@code admin} is not a device or profile owner.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004603 */
Robin Lee25e26452015-06-02 09:56:29 -07004604 public void clearCrossProfileIntentFilters(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004605 throwIfParentInstance("clearCrossProfileIntentFilters");
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004606 if (mService != null) {
4607 try {
Nicolas Prevot81948992014-05-16 18:25:26 +01004608 mService.clearCrossProfileIntentFilters(admin);
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004609 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004610 throw e.rethrowFromSystemServer();
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004611 }
4612 }
4613 }
4614
4615 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004616 * Called by a profile or device owner to set the permitted accessibility services. When set by
4617 * a device owner or profile owner the restriction applies to all profiles of the user the
4618 * device owner or profile owner is an admin for. By default the user can use any accessiblity
4619 * service. When zero or more packages have been added, accessiblity services that are not in
4620 * the list and not part of the system can not be enabled by the user.
4621 * <p>
4622 * Calling with a null value for the list disables the restriction so that all services can be
4623 * used, calling with an empty list only allows the builtin system's services.
4624 * <p>
4625 * System accesibility services are always available to the user the list can't modify this.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004626 *
4627 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4628 * @param packageNames List of accessibility service package names.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004629 * @return true if setting the restriction succeeded. It fail if there is one or more non-system
4630 * accessibility services enabled, that are not in the list.
4631 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004632 */
Robin Lee25e26452015-06-02 09:56:29 -07004633 public boolean setPermittedAccessibilityServices(@NonNull ComponentName admin,
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004634 List<String> packageNames) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004635 throwIfParentInstance("setPermittedAccessibilityServices");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004636 if (mService != null) {
4637 try {
4638 return mService.setPermittedAccessibilityServices(admin, packageNames);
4639 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004640 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004641 }
4642 }
4643 return false;
4644 }
4645
4646 /**
4647 * Returns the list of permitted accessibility services set by this device or profile owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004648 * <p>
4649 * An empty list means no accessibility services except system services are allowed. Null means
4650 * all accessibility services are allowed.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004651 *
4652 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4653 * @return List of accessiblity service package names.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004654 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004655 */
Robin Lee25e26452015-06-02 09:56:29 -07004656 public List<String> getPermittedAccessibilityServices(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004657 throwIfParentInstance("getPermittedAccessibilityServices");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004658 if (mService != null) {
4659 try {
4660 return mService.getPermittedAccessibilityServices(admin);
4661 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004662 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004663 }
4664 }
4665 return null;
4666 }
4667
4668 /**
Sudheer Shanka56925862016-01-28 19:43:59 +00004669 * Called by the system to check if a specific accessibility service is disabled by admin.
4670 *
4671 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4672 * @param packageName Accessibility service package name that needs to be checked.
4673 * @param userHandle user id the admin is running as.
4674 * @return true if the accessibility service is permitted, otherwise false.
4675 *
4676 * @hide
4677 */
4678 public boolean isAccessibilityServicePermittedByAdmin(@NonNull ComponentName admin,
4679 @NonNull String packageName, int userHandle) {
4680 if (mService != null) {
4681 try {
4682 return mService.isAccessibilityServicePermittedByAdmin(admin, packageName,
4683 userHandle);
4684 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004685 throw e.rethrowFromSystemServer();
Sudheer Shanka56925862016-01-28 19:43:59 +00004686 }
4687 }
4688 return false;
4689 }
4690
4691 /**
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004692 * Returns the list of accessibility services permitted by the device or profiles
4693 * owners of this user.
4694 *
4695 * <p>Null means all accessibility services are allowed, if a non-null list is returned
4696 * it will contain the intersection of the permitted lists for any device or profile
4697 * owners that apply to this user. It will also include any system accessibility services.
4698 *
4699 * @param userId which user to check for.
4700 * @return List of accessiblity service package names.
4701 * @hide
4702 */
4703 @SystemApi
4704 public List<String> getPermittedAccessibilityServices(int userId) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004705 throwIfParentInstance("getPermittedAccessibilityServices");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004706 if (mService != null) {
4707 try {
4708 return mService.getPermittedAccessibilityServicesForUser(userId);
4709 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004710 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004711 }
4712 }
4713 return null;
4714 }
4715
4716 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004717 * Called by a profile or device owner to set the permitted input methods services. When set by
4718 * a device owner or profile owner the restriction applies to all profiles of the user the
4719 * device owner or profile owner is an admin for. By default the user can use any input method.
4720 * When zero or more packages have been added, input method that are not in the list and not
4721 * part of the system can not be enabled by the user. This method will fail if it is called for
4722 * a admin that is not for the foreground user or a profile of the foreground user.
4723 * <p>
4724 * Calling with a null value for the list disables the restriction so that all input methods can
4725 * be used, calling with an empty list disables all but the system's own input methods.
4726 * <p>
4727 * System input methods are always available to the user this method can't modify this.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004728 *
4729 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4730 * @param packageNames List of input method package names.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004731 * @return true if setting the restriction succeeded. It will fail if there are one or more
4732 * non-system input methods currently enabled that are not in the packageNames list.
4733 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004734 */
Robin Lee25e26452015-06-02 09:56:29 -07004735 public boolean setPermittedInputMethods(@NonNull ComponentName admin, List<String> packageNames) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004736 throwIfParentInstance("setPermittedInputMethods");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004737 if (mService != null) {
4738 try {
4739 return mService.setPermittedInputMethods(admin, packageNames);
4740 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004741 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004742 }
4743 }
4744 return false;
4745 }
4746
4747
4748 /**
4749 * Returns the list of permitted input methods set by this device or profile owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004750 * <p>
4751 * An empty list means no input methods except system input methods are allowed. Null means all
4752 * input methods are allowed.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004753 *
4754 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4755 * @return List of input method package names.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004756 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004757 */
Robin Lee25e26452015-06-02 09:56:29 -07004758 public List<String> getPermittedInputMethods(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004759 throwIfParentInstance("getPermittedInputMethods");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004760 if (mService != null) {
4761 try {
4762 return mService.getPermittedInputMethods(admin);
4763 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004764 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004765 }
4766 }
4767 return null;
4768 }
4769
4770 /**
Sudheer Shanka56925862016-01-28 19:43:59 +00004771 * Called by the system to check if a specific input method is disabled by admin.
4772 *
4773 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4774 * @param packageName Input method package name that needs to be checked.
4775 * @param userHandle user id the admin is running as.
4776 * @return true if the input method is permitted, otherwise false.
4777 *
4778 * @hide
4779 */
4780 public boolean isInputMethodPermittedByAdmin(@NonNull ComponentName admin,
4781 @NonNull String packageName, int userHandle) {
4782 if (mService != null) {
4783 try {
4784 return mService.isInputMethodPermittedByAdmin(admin, packageName, userHandle);
4785 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004786 throw e.rethrowFromSystemServer();
Sudheer Shanka56925862016-01-28 19:43:59 +00004787 }
4788 }
4789 return false;
4790 }
4791
4792 /**
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004793 * Returns the list of input methods permitted by the device or profiles
Makoto Onuki32b30572015-12-11 14:29:51 -08004794 * owners of the current user. (*Not* calling user, due to a limitation in InputMethodManager.)
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004795 *
4796 * <p>Null means all input methods are allowed, if a non-null list is returned
4797 * it will contain the intersection of the permitted lists for any device or profile
4798 * owners that apply to this user. It will also include any system input methods.
4799 *
4800 * @return List of input method package names.
4801 * @hide
4802 */
4803 @SystemApi
4804 public List<String> getPermittedInputMethodsForCurrentUser() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004805 throwIfParentInstance("getPermittedInputMethodsForCurrentUser");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004806 if (mService != null) {
4807 try {
4808 return mService.getPermittedInputMethodsForCurrentUser();
4809 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004810 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004811 }
4812 }
4813 return null;
4814 }
4815
4816 /**
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08004817 * Called by a device owner to get the list of apps to keep around as APKs even if no user has
4818 * currently installed it.
4819 *
4820 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4821 *
4822 * @return List of package names to keep cached.
4823 * @hide
4824 */
4825 public List<String> getKeepUninstalledPackages(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004826 throwIfParentInstance("getKeepUninstalledPackages");
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08004827 if (mService != null) {
4828 try {
4829 return mService.getKeepUninstalledPackages(admin);
4830 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004831 throw e.rethrowFromSystemServer();
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08004832 }
4833 }
4834 return null;
4835 }
4836
4837 /**
4838 * Called by a device owner to set a list of apps to keep around as APKs even if no user has
4839 * currently installed it.
4840 *
4841 * <p>Please note that setting this policy does not imply that specified apps will be
4842 * automatically pre-cached.</p>
4843 *
4844 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4845 * @param packageNames List of package names to keep cached.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004846 * @throws SecurityException if {@code admin} is not a device owner.
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08004847 * @hide
4848 */
4849 public void setKeepUninstalledPackages(@NonNull ComponentName admin,
4850 @NonNull List<String> packageNames) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004851 throwIfParentInstance("setKeepUninstalledPackages");
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08004852 if (mService != null) {
4853 try {
4854 mService.setKeepUninstalledPackages(admin, packageNames);
4855 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004856 throw e.rethrowFromSystemServer();
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08004857 }
4858 }
4859 }
4860
4861 /**
Julia Reynolds1e958392014-05-16 14:25:21 -04004862 * Called by a device owner to create a user with the specified name. The UserHandle returned
4863 * by this method should not be persisted as user handles are recycled as users are removed and
4864 * created. If you need to persist an identifier for this user, use
4865 * {@link UserManager#getSerialNumberForUser}.
4866 *
4867 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4868 * @param name the user's name
4869 * @see UserHandle
Robin Lee25e26452015-06-02 09:56:29 -07004870 * @return the {@link android.os.UserHandle} object for the created user, or {@code null} if the
4871 * user could not be created.
Kenny Guy14f48e52015-06-29 15:12:36 +01004872 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07004873 * @deprecated From {@link android.os.Build.VERSION_CODES#M}
phweiss27ee3342016-02-08 16:40:45 +01004874 * @removed From {@link android.os.Build.VERSION_CODES#N}
Julia Reynolds1e958392014-05-16 14:25:21 -04004875 */
Kenny Guy14f48e52015-06-29 15:12:36 +01004876 @Deprecated
Robin Lee25e26452015-06-02 09:56:29 -07004877 public UserHandle createUser(@NonNull ComponentName admin, String name) {
Julia Reynolds1e958392014-05-16 14:25:21 -04004878 return null;
4879 }
4880
4881 /**
Jason Monk03978a42014-06-10 15:05:30 -04004882 * Called by a device owner to create a user with the specified name. The UserHandle returned
4883 * by this method should not be persisted as user handles are recycled as users are removed and
4884 * created. If you need to persist an identifier for this user, use
4885 * {@link UserManager#getSerialNumberForUser}. The new user will be started in the background
4886 * immediately.
4887 *
4888 * <p> profileOwnerComponent is the {@link DeviceAdminReceiver} to be the profile owner as well
4889 * as registered as an active admin on the new user. The profile owner package will be
4890 * installed on the new user if it already is installed on the device.
4891 *
4892 * <p>If the optionalInitializeData is not null, then the extras will be passed to the
4893 * profileOwnerComponent when onEnable is called.
4894 *
4895 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4896 * @param name the user's name
4897 * @param ownerName the human readable name of the organisation associated with this DPM.
4898 * @param profileOwnerComponent The {@link DeviceAdminReceiver} that will be an active admin on
4899 * the user.
4900 * @param adminExtras Extras that will be passed to onEnable of the admin receiver
4901 * on the new user.
4902 * @see UserHandle
Robin Lee25e26452015-06-02 09:56:29 -07004903 * @return the {@link android.os.UserHandle} object for the created user, or {@code null} if the
4904 * user could not be created.
Kenny Guy14f48e52015-06-29 15:12:36 +01004905 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07004906 * @deprecated From {@link android.os.Build.VERSION_CODES#M}
phweiss27ee3342016-02-08 16:40:45 +01004907 * @removed From {@link android.os.Build.VERSION_CODES#N}
Jason Monk03978a42014-06-10 15:05:30 -04004908 */
Kenny Guy14f48e52015-06-29 15:12:36 +01004909 @Deprecated
Robin Lee25e26452015-06-02 09:56:29 -07004910 public UserHandle createAndInitializeUser(@NonNull ComponentName admin, String name,
4911 String ownerName, @NonNull ComponentName profileOwnerComponent, Bundle adminExtras) {
Jason Monk03978a42014-06-10 15:05:30 -04004912 return null;
4913 }
4914
4915 /**
phweissa92e1212016-01-25 17:14:10 +01004916 * Flag used by {@link #createAndManageUser} to skip setup wizard after creating a new user.
phweiss343fb332016-01-25 14:48:59 +01004917 */
4918 public static final int SKIP_SETUP_WIZARD = 0x0001;
4919
4920 /**
Lenka Trochtovac8202c82016-01-26 15:11:09 +01004921 * Flag used by {@link #createAndManageUser} to specify that the user should be created
4922 * ephemeral.
4923 * @hide
4924 */
4925 public static final int MAKE_USER_EPHEMERAL = 0x0002;
4926
4927 /**
phweissa92e1212016-01-25 17:14:10 +01004928 * Called by a device owner to create a user with the specified name and a given component of
4929 * the calling package as profile owner. The UserHandle returned by this method should not be
4930 * persisted as user handles are recycled as users are removed and created. If you need to
4931 * persist an identifier for this user, use {@link UserManager#getSerialNumberForUser}. The new
4932 * user will not be started in the background.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004933 * <p>
4934 * admin is the {@link DeviceAdminReceiver} which is the device owner. profileOwner is also a
4935 * DeviceAdminReceiver in the same package as admin, and will become the profile owner and will
4936 * be registered as an active admin on the new user. The profile owner package will be installed
4937 * on the new user.
4938 * <p>
4939 * If the adminExtras are not null, they will be stored on the device until the user is started
4940 * for the first time. Then the extras will be passed to the admin when onEnable is called.
phweiss343fb332016-01-25 14:48:59 +01004941 *
4942 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4943 * @param name The user's name.
phweissa92e1212016-01-25 17:14:10 +01004944 * @param profileOwner Which {@link DeviceAdminReceiver} will be profile owner. Has to be in the
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004945 * same package as admin, otherwise no user is created and an
4946 * IllegalArgumentException is thrown.
phweiss343fb332016-01-25 14:48:59 +01004947 * @param adminExtras Extras that will be passed to onEnable of the admin receiver on the new
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004948 * user.
phweissa92e1212016-01-25 17:14:10 +01004949 * @param flags {@link #SKIP_SETUP_WIZARD} is supported.
phweiss343fb332016-01-25 14:48:59 +01004950 * @see UserHandle
4951 * @return the {@link android.os.UserHandle} object for the created user, or {@code null} if the
4952 * user could not be created.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004953 * @throws SecurityException if {@code admin} is not a device owner.
phweiss343fb332016-01-25 14:48:59 +01004954 */
4955 public UserHandle createAndManageUser(@NonNull ComponentName admin, @NonNull String name,
phweissa92e1212016-01-25 17:14:10 +01004956 @NonNull ComponentName profileOwner, @Nullable PersistableBundle adminExtras,
4957 int flags) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004958 throwIfParentInstance("createAndManageUser");
phweiss343fb332016-01-25 14:48:59 +01004959 try {
phweissa92e1212016-01-25 17:14:10 +01004960 return mService.createAndManageUser(admin, name, profileOwner, adminExtras, flags);
phweiss343fb332016-01-25 14:48:59 +01004961 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004962 throw re.rethrowFromSystemServer();
phweiss343fb332016-01-25 14:48:59 +01004963 }
phweiss343fb332016-01-25 14:48:59 +01004964 }
4965
4966 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004967 * Called by a device owner to remove a user and all associated data. The primary user can not
4968 * be removed.
Julia Reynolds1e958392014-05-16 14:25:21 -04004969 *
4970 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4971 * @param userHandle the user to remove.
4972 * @return {@code true} if the user was removed, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004973 * @throws SecurityException if {@code admin} is not a device owner.
Julia Reynolds1e958392014-05-16 14:25:21 -04004974 */
Robin Lee25e26452015-06-02 09:56:29 -07004975 public boolean removeUser(@NonNull ComponentName admin, UserHandle userHandle) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004976 throwIfParentInstance("removeUser");
Julia Reynolds1e958392014-05-16 14:25:21 -04004977 try {
4978 return mService.removeUser(admin, userHandle);
4979 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004980 throw re.rethrowFromSystemServer();
Julia Reynolds1e958392014-05-16 14:25:21 -04004981 }
4982 }
4983
4984 /**
Jason Monk582d9112014-07-09 19:57:08 -04004985 * Called by a device owner to switch the specified user to the foreground.
4986 *
4987 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4988 * @param userHandle the user to switch to; null will switch to primary.
4989 * @return {@code true} if the switch was successful, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004990 * @throws SecurityException if {@code admin} is not a device owner.
Jason Monk582d9112014-07-09 19:57:08 -04004991 * @see Intent#ACTION_USER_FOREGROUND
4992 */
Robin Lee25e26452015-06-02 09:56:29 -07004993 public boolean switchUser(@NonNull ComponentName admin, @Nullable UserHandle userHandle) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004994 throwIfParentInstance("switchUser");
Jason Monk582d9112014-07-09 19:57:08 -04004995 try {
4996 return mService.switchUser(admin, userHandle);
4997 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004998 throw re.rethrowFromSystemServer();
Jason Monk582d9112014-07-09 19:57:08 -04004999 }
5000 }
5001
5002 /**
Esteban Talaverabf60f722015-12-10 16:26:44 +00005003 * Retrieves the application restrictions for a given target application running in the calling
5004 * user.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005005 * <p>
5006 * The caller must be a profile or device owner on that user, or the package allowed to manage
5007 * application restrictions via {@link #setApplicationRestrictionsManagingPackage}; otherwise a
5008 * security exception will be thrown.
Robin Lee66e5d962014-04-09 16:44:21 +01005009 *
Esteban Talaverabf60f722015-12-10 16:26:44 +00005010 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005011 * {@code null} if called by the application restrictions managing package.
Robin Lee66e5d962014-04-09 16:44:21 +01005012 * @param packageName The name of the package to fetch restricted settings of.
5013 * @return {@link Bundle} of settings corresponding to what was set last time
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005014 * {@link DevicePolicyManager#setApplicationRestrictions} was called, or an empty
5015 * {@link Bundle} if no restrictions have been set.
5016 * @throws SecurityException if {@code admin} is not a device or profile owner.
Esteban Talaverabf60f722015-12-10 16:26:44 +00005017 * @see {@link #setApplicationRestrictionsManagingPackage}
Robin Lee66e5d962014-04-09 16:44:21 +01005018 */
Esteban Talaverabf60f722015-12-10 16:26:44 +00005019 public Bundle getApplicationRestrictions(@Nullable ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005020 throwIfParentInstance("getApplicationRestrictions");
Robin Lee66e5d962014-04-09 16:44:21 +01005021 if (mService != null) {
5022 try {
5023 return mService.getApplicationRestrictions(admin, packageName);
5024 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005025 throw e.rethrowFromSystemServer();
Robin Lee66e5d962014-04-09 16:44:21 +01005026 }
5027 }
5028 return null;
5029 }
Amith Yamasanibe465322014-04-24 13:45:17 -07005030
5031 /**
Julia Reynolds20118f12015-02-11 12:34:08 -05005032 * Called by a profile or device owner to set a user restriction specified by the key.
Amith Yamasanibe465322014-04-24 13:45:17 -07005033 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005034 * The calling device admin must be a profile or device owner; if it is not, a security
5035 * exception will be thrown.
Jim Millerdf2258b2014-04-27 20:10:26 -07005036 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005037 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5038 * @param key The key of the restriction. See the constants in {@link android.os.UserManager}
5039 * for the list of keys.
5040 * @throws SecurityException if {@code admin} is not a device or profile owner.
Amith Yamasanibe465322014-04-24 13:45:17 -07005041 */
Robin Lee25e26452015-06-02 09:56:29 -07005042 public void addUserRestriction(@NonNull ComponentName admin, String key) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005043 throwIfParentInstance("addUserRestriction");
Amith Yamasanibe465322014-04-24 13:45:17 -07005044 if (mService != null) {
5045 try {
5046 mService.setUserRestriction(admin, key, true);
5047 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005048 throw e.rethrowFromSystemServer();
Amith Yamasanibe465322014-04-24 13:45:17 -07005049 }
5050 }
5051 }
5052
5053 /**
Julia Reynolds20118f12015-02-11 12:34:08 -05005054 * Called by a profile or device owner to clear a user restriction specified by the key.
Amith Yamasanibe465322014-04-24 13:45:17 -07005055 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005056 * The calling device admin must be a profile or device owner; if it is not, a security
5057 * exception will be thrown.
Jim Millerdf2258b2014-04-27 20:10:26 -07005058 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005059 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5060 * @param key The key of the restriction. See the constants in {@link android.os.UserManager}
5061 * for the list of keys.
5062 * @throws SecurityException if {@code admin} is not a device or profile owner.
Amith Yamasanibe465322014-04-24 13:45:17 -07005063 */
Robin Lee25e26452015-06-02 09:56:29 -07005064 public void clearUserRestriction(@NonNull ComponentName admin, String key) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005065 throwIfParentInstance("clearUserRestriction");
Amith Yamasanibe465322014-04-24 13:45:17 -07005066 if (mService != null) {
5067 try {
5068 mService.setUserRestriction(admin, key, false);
5069 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005070 throw e.rethrowFromSystemServer();
Amith Yamasanibe465322014-04-24 13:45:17 -07005071 }
5072 }
5073 }
Adam Connors010cfd42014-04-16 12:48:13 +01005074
5075 /**
Makoto Onuki3a3092f2015-10-30 11:07:51 -07005076 * Called by a profile or device owner to get user restrictions set with
5077 * {@link #addUserRestriction(ComponentName, String)}.
5078 * <p>
5079 * The target user may have more restrictions set by the system or other device owner / profile
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005080 * owner. To get all the user restrictions currently set, use
Makoto Onuki3a3092f2015-10-30 11:07:51 -07005081 * {@link UserManager#getUserRestrictions()}.
5082 *
5083 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005084 * @throws SecurityException if {@code admin} is not a device or profile owner.
Makoto Onuki3a3092f2015-10-30 11:07:51 -07005085 */
5086 public Bundle getUserRestrictions(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005087 throwIfParentInstance("getUserRestrictions");
Makoto Onuki3a3092f2015-10-30 11:07:51 -07005088 Bundle ret = null;
5089 if (mService != null) {
5090 try {
Sudheer Shanka549b9692016-03-30 17:12:07 -07005091 ret = mService.getUserRestrictions(admin);
5092 } catch (RemoteException e) {
5093 throw e.rethrowFromSystemServer();
5094 }
5095 }
5096 return ret == null ? new Bundle() : ret;
5097 }
5098
5099 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005100 * Called by profile or device owners to hide or unhide packages. When a package is hidden it is
5101 * unavailable for use, but the data and actual package file remain.
Julia Reynolds966881e2014-05-14 12:23:08 -04005102 *
5103 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Amith Yamasanie5bcff62014-07-19 15:44:09 -07005104 * @param packageName The name of the package to hide or unhide.
5105 * @param hidden {@code true} if the package should be hidden, {@code false} if it should be
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005106 * unhidden.
Amith Yamasanie5bcff62014-07-19 15:44:09 -07005107 * @return boolean Whether the hidden setting of the package was successfully updated.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005108 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynolds966881e2014-05-14 12:23:08 -04005109 */
Robin Lee25e26452015-06-02 09:56:29 -07005110 public boolean setApplicationHidden(@NonNull ComponentName admin, String packageName,
Amith Yamasanie5bcff62014-07-19 15:44:09 -07005111 boolean hidden) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005112 throwIfParentInstance("setApplicationHidden");
Julia Reynolds966881e2014-05-14 12:23:08 -04005113 if (mService != null) {
5114 try {
Amith Yamasanie5bcff62014-07-19 15:44:09 -07005115 return mService.setApplicationHidden(admin, packageName, hidden);
Julia Reynolds966881e2014-05-14 12:23:08 -04005116 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005117 throw e.rethrowFromSystemServer();
Julia Reynolds966881e2014-05-14 12:23:08 -04005118 }
5119 }
5120 return false;
5121 }
5122
5123 /**
Julia Reynolds20118f12015-02-11 12:34:08 -05005124 * Called by profile or device owners to determine if a package is hidden.
Julia Reynolds966881e2014-05-14 12:23:08 -04005125 *
5126 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Amith Yamasanie5bcff62014-07-19 15:44:09 -07005127 * @param packageName The name of the package to retrieve the hidden status of.
5128 * @return boolean {@code true} if the package is hidden, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005129 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynolds966881e2014-05-14 12:23:08 -04005130 */
Robin Lee25e26452015-06-02 09:56:29 -07005131 public boolean isApplicationHidden(@NonNull ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005132 throwIfParentInstance("isApplicationHidden");
Julia Reynolds966881e2014-05-14 12:23:08 -04005133 if (mService != null) {
5134 try {
Amith Yamasanie5bcff62014-07-19 15:44:09 -07005135 return mService.isApplicationHidden(admin, packageName);
Julia Reynolds966881e2014-05-14 12:23:08 -04005136 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005137 throw e.rethrowFromSystemServer();
Julia Reynolds966881e2014-05-14 12:23:08 -04005138 }
5139 }
5140 return false;
5141 }
5142
5143 /**
Julia Reynolds20118f12015-02-11 12:34:08 -05005144 * Called by profile or device owners to re-enable a system app that was disabled by default
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07005145 * when the user was initialized.
Adam Connors655be2a2014-07-14 09:01:25 +00005146 *
5147 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Makoto Onuki32b30572015-12-11 14:29:51 -08005148 * @param packageName The package to be re-enabled in the calling profile.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005149 * @throws SecurityException if {@code admin} is not a device or profile owner.
Adam Connors655be2a2014-07-14 09:01:25 +00005150 */
Robin Lee25e26452015-06-02 09:56:29 -07005151 public void enableSystemApp(@NonNull ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005152 throwIfParentInstance("enableSystemApp");
Adam Connors655be2a2014-07-14 09:01:25 +00005153 if (mService != null) {
5154 try {
5155 mService.enableSystemApp(admin, packageName);
5156 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005157 throw e.rethrowFromSystemServer();
Adam Connors655be2a2014-07-14 09:01:25 +00005158 }
5159 }
5160 }
5161
5162 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005163 * Called by profile or device owners to re-enable system apps by intent that were disabled by
5164 * default when the user was initialized.
Adam Connors655be2a2014-07-14 09:01:25 +00005165 *
5166 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5167 * @param intent An intent matching the app(s) to be installed. All apps that resolve for this
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005168 * intent will be re-enabled in the calling profile.
Adam Connors655be2a2014-07-14 09:01:25 +00005169 * @return int The number of activities that matched the intent and were installed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005170 * @throws SecurityException if {@code admin} is not a device or profile owner.
Adam Connors655be2a2014-07-14 09:01:25 +00005171 */
Robin Lee25e26452015-06-02 09:56:29 -07005172 public int enableSystemApp(@NonNull ComponentName admin, Intent intent) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005173 throwIfParentInstance("enableSystemApp");
Adam Connors655be2a2014-07-14 09:01:25 +00005174 if (mService != null) {
5175 try {
5176 return mService.enableSystemAppWithIntent(admin, intent);
5177 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005178 throw e.rethrowFromSystemServer();
Adam Connors655be2a2014-07-14 09:01:25 +00005179 }
5180 }
5181 return 0;
5182 }
5183
5184 /**
Sander Alewijnse112e0532014-10-29 13:28:49 +00005185 * Called by a device owner or profile owner to disable account management for a specific type
5186 * of account.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005187 * <p>
5188 * The calling device admin must be a device owner or profile owner. If it is not, a security
5189 * exception will be thrown.
5190 * <p>
5191 * When account management is disabled for an account type, adding or removing an account of
5192 * that type will not be possible.
5193 * <p>
5194 * From {@link android.os.Build.VERSION_CODES#N} the profile or device owner can still use
Benjamin Franzb6c0ce42015-11-05 10:06:51 +00005195 * {@link android.accounts.AccountManager} APIs to add or remove accounts when account
5196 * management for a specific type is disabled.
5197 *
Sander Alewijnse650c3342014-05-08 18:00:50 +01005198 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5199 * @param accountType For which account management is disabled or enabled.
5200 * @param disabled The boolean indicating that account management will be disabled (true) or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005201 * enabled (false).
5202 * @throws SecurityException if {@code admin} is not a device or profile owner.
Sander Alewijnse650c3342014-05-08 18:00:50 +01005203 */
Robin Lee25e26452015-06-02 09:56:29 -07005204 public void setAccountManagementDisabled(@NonNull ComponentName admin, String accountType,
Sander Alewijnse650c3342014-05-08 18:00:50 +01005205 boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005206 throwIfParentInstance("setAccountManagementDisabled");
Sander Alewijnse650c3342014-05-08 18:00:50 +01005207 if (mService != null) {
5208 try {
5209 mService.setAccountManagementDisabled(admin, accountType, disabled);
5210 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005211 throw e.rethrowFromSystemServer();
Sander Alewijnse650c3342014-05-08 18:00:50 +01005212 }
5213 }
5214 }
5215
5216 /**
Sander Alewijnse5c02db62014-05-07 10:46:57 +01005217 * Gets the array of accounts for which account management is disabled by the profile owner.
5218 *
5219 * <p> Account management can be disabled/enabled by calling
5220 * {@link #setAccountManagementDisabled}.
5221 *
5222 * @return a list of account types for which account management has been disabled.
5223 *
5224 * @see #setAccountManagementDisabled
5225 */
5226 public String[] getAccountTypesWithManagementDisabled() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005227 throwIfParentInstance("getAccountTypesWithManagementDisabled");
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07005228 return getAccountTypesWithManagementDisabledAsUser(myUserId());
Alexandra Gherghina999d3942014-07-03 11:40:08 +01005229 }
5230
5231 /**
5232 * @see #getAccountTypesWithManagementDisabled()
5233 * @hide
5234 */
5235 public String[] getAccountTypesWithManagementDisabledAsUser(int userId) {
Sander Alewijnse5c02db62014-05-07 10:46:57 +01005236 if (mService != null) {
5237 try {
Alexandra Gherghina999d3942014-07-03 11:40:08 +01005238 return mService.getAccountTypesWithManagementDisabledAsUser(userId);
Sander Alewijnse5c02db62014-05-07 10:46:57 +01005239 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005240 throw e.rethrowFromSystemServer();
Sander Alewijnse5c02db62014-05-07 10:46:57 +01005241 }
5242 }
5243
5244 return null;
5245 }
justinzhang511e0d82014-03-24 16:09:24 -04005246
5247 /**
Jason Monkd7b86212014-06-16 13:15:38 -04005248 * Sets which packages may enter lock task mode.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005249 * <p>
5250 * Any packages that shares uid with an allowed package will also be allowed to activate lock
5251 * task. From {@link android.os.Build.VERSION_CODES#M} removing packages from the lock task
5252 * package list results in locked tasks belonging to those packages to be finished. This
5253 * function can only be called by the device owner.
Jason Monkd7b86212014-06-16 13:15:38 -04005254 *
Jason Monkd7b86212014-06-16 13:15:38 -04005255 * @param packages The list of packages allowed to enter lock task mode
Jason Monk48aacba2014-08-13 16:29:08 -04005256 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005257 * @throws SecurityException if {@code admin} is not a device owner.
Jason Monkd7b86212014-06-16 13:15:38 -04005258 * @see Activity#startLockTask()
Benjamin Franz6cdb27e2015-02-26 12:26:53 +00005259 * @see DeviceAdminReceiver#onLockTaskModeEntering(Context, Intent, String)
5260 * @see DeviceAdminReceiver#onLockTaskModeExiting(Context, Intent)
Jason Monk1c7c3192014-06-26 12:52:18 -04005261 * @see UserManager#DISALLOW_CREATE_WINDOWS
justinzhang511e0d82014-03-24 16:09:24 -04005262 */
Robin Lee25e26452015-06-02 09:56:29 -07005263 public void setLockTaskPackages(@NonNull ComponentName admin, String[] packages)
Jason Monk48aacba2014-08-13 16:29:08 -04005264 throws SecurityException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005265 throwIfParentInstance("setLockTaskPackages");
justinzhang511e0d82014-03-24 16:09:24 -04005266 if (mService != null) {
5267 try {
Jason Monk48aacba2014-08-13 16:29:08 -04005268 mService.setLockTaskPackages(admin, packages);
justinzhang511e0d82014-03-24 16:09:24 -04005269 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005270 throw e.rethrowFromSystemServer();
justinzhang511e0d82014-03-24 16:09:24 -04005271 }
5272 }
5273 }
5274
5275 /**
Jason Monkd7b86212014-06-16 13:15:38 -04005276 * This function returns the list of packages allowed to start the lock task mode.
Jason Monk48aacba2014-08-13 16:29:08 -04005277 *
5278 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
justinzhang511e0d82014-03-24 16:09:24 -04005279 * @hide
5280 */
Robin Lee25e26452015-06-02 09:56:29 -07005281 public String[] getLockTaskPackages(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005282 throwIfParentInstance("getLockTaskPackages");
justinzhang511e0d82014-03-24 16:09:24 -04005283 if (mService != null) {
5284 try {
Jason Monk48aacba2014-08-13 16:29:08 -04005285 return mService.getLockTaskPackages(admin);
justinzhang511e0d82014-03-24 16:09:24 -04005286 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005287 throw e.rethrowFromSystemServer();
justinzhang511e0d82014-03-24 16:09:24 -04005288 }
5289 }
5290 return null;
5291 }
5292
5293 /**
5294 * This function lets the caller know whether the given component is allowed to start the
5295 * lock task mode.
Jason Monkd7b86212014-06-16 13:15:38 -04005296 * @param pkg The package to check
justinzhang511e0d82014-03-24 16:09:24 -04005297 */
Jason Monkd7b86212014-06-16 13:15:38 -04005298 public boolean isLockTaskPermitted(String pkg) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005299 throwIfParentInstance("isLockTaskPermitted");
justinzhang511e0d82014-03-24 16:09:24 -04005300 if (mService != null) {
5301 try {
Jason Monkd7b86212014-06-16 13:15:38 -04005302 return mService.isLockTaskPermitted(pkg);
justinzhang511e0d82014-03-24 16:09:24 -04005303 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005304 throw e.rethrowFromSystemServer();
justinzhang511e0d82014-03-24 16:09:24 -04005305 }
5306 }
5307 return false;
5308 }
Julia Reynoldsda551652014-05-14 17:15:16 -04005309
5310 /**
5311 * Called by device owners to update {@link Settings.Global} settings. Validation that the value
5312 * 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 -07005313 * <p>
5314 * The settings that can be updated with this method are:
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005315 * <ul>
5316 * <li>{@link Settings.Global#ADB_ENABLED}</li>
5317 * <li>{@link Settings.Global#AUTO_TIME}</li>
5318 * <li>{@link Settings.Global#AUTO_TIME_ZONE}</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005319 * <li>{@link Settings.Global#DATA_ROAMING}</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005320 * <li>{@link Settings.Global#USB_MASS_STORAGE_ENABLED}</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005321 * <li>{@link Settings.Global#WIFI_SLEEP_POLICY}</li>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005322 * <li>{@link Settings.Global#STAY_ON_WHILE_PLUGGED_IN} This setting is only available from
5323 * {@link android.os.Build.VERSION_CODES#M} onwards and can only be set if
5324 * {@link #setMaximumTimeToLock} is not used to set a timeout.</li>
5325 * <li>{@link Settings.Global#WIFI_DEVICE_OWNER_CONFIGS_LOCKDOWN}</li> This setting is only
5326 * available from {@link android.os.Build.VERSION_CODES#M} onwards.</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005327 * </ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005328 * <p>
5329 * Changing the following settings has no effect as of {@link android.os.Build.VERSION_CODES#M}:
Esteban Talavera656fa7f2015-06-29 17:41:39 +01005330 * <ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005331 * <li>{@link Settings.Global#BLUETOOTH_ON}. Use
5332 * {@link android.bluetooth.BluetoothAdapter#enable()} and
5333 * {@link android.bluetooth.BluetoothAdapter#disable()} instead.</li>
Esteban Talavera656fa7f2015-06-29 17:41:39 +01005334 * <li>{@link Settings.Global#DEVELOPMENT_SETTINGS_ENABLED}</li>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005335 * <li>{@link Settings.Global#MODE_RINGER}. Use
5336 * {@link android.media.AudioManager#setRingerMode(int)} instead.</li>
Esteban Talavera656fa7f2015-06-29 17:41:39 +01005337 * <li>{@link Settings.Global#NETWORK_PREFERENCE}</li>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005338 * <li>{@link Settings.Global#WIFI_ON}. Use
5339 * {@link android.net.wifi.WifiManager#setWifiEnabled(boolean)} instead.</li>
Esteban Talavera656fa7f2015-06-29 17:41:39 +01005340 * </ul>
Julia Reynoldsda551652014-05-14 17:15:16 -04005341 *
5342 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5343 * @param setting The name of the setting to update.
5344 * @param value The value to update the setting to.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005345 * @throws SecurityException if {@code admin} is not a device owner.
Julia Reynoldsda551652014-05-14 17:15:16 -04005346 */
Robin Lee25e26452015-06-02 09:56:29 -07005347 public void setGlobalSetting(@NonNull ComponentName admin, String setting, String value) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005348 throwIfParentInstance("setGlobalSetting");
Julia Reynoldsda551652014-05-14 17:15:16 -04005349 if (mService != null) {
5350 try {
5351 mService.setGlobalSetting(admin, setting, value);
5352 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005353 throw e.rethrowFromSystemServer();
Julia Reynoldsda551652014-05-14 17:15:16 -04005354 }
5355 }
5356 }
5357
5358 /**
5359 * Called by profile or device owners to update {@link Settings.Secure} settings. Validation
5360 * that the value of the setting is in the correct form for the setting type should be performed
5361 * by the caller.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005362 * <p>
5363 * The settings that can be updated by a profile or device owner with this method are:
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005364 * <ul>
5365 * <li>{@link Settings.Secure#DEFAULT_INPUT_METHOD}</li>
Amith Yamasani52c39a12014-10-21 11:14:04 -07005366 * <li>{@link Settings.Secure#INSTALL_NON_MARKET_APPS}</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005367 * <li>{@link Settings.Secure#SKIP_FIRST_USE_HINTS}</li>
5368 * </ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005369 * <p>
5370 * A device owner can additionally update the following settings:
Julia Reynolds82735bc2014-09-04 16:43:30 -04005371 * <ul>
5372 * <li>{@link Settings.Secure#LOCATION_MODE}</li>
5373 * </ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005374 *
Julia Reynoldsda551652014-05-14 17:15:16 -04005375 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5376 * @param setting The name of the setting to update.
5377 * @param value The value to update the setting to.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005378 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynoldsda551652014-05-14 17:15:16 -04005379 */
Robin Lee25e26452015-06-02 09:56:29 -07005380 public void setSecureSetting(@NonNull ComponentName admin, String setting, String value) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005381 throwIfParentInstance("setSecureSetting");
Julia Reynoldsda551652014-05-14 17:15:16 -04005382 if (mService != null) {
5383 try {
5384 mService.setSecureSetting(admin, setting, value);
5385 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005386 throw e.rethrowFromSystemServer();
Julia Reynoldsda551652014-05-14 17:15:16 -04005387 }
5388 }
5389 }
5390
Amith Yamasanif20d6402014-05-24 15:34:37 -07005391 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005392 * Designates a specific service component as the provider for making permission requests of a
5393 * local or remote administrator of the user.
Amith Yamasanif20d6402014-05-24 15:34:37 -07005394 * <p/>
5395 * Only a profile owner can designate the restrictions provider.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005396 *
Amith Yamasanif20d6402014-05-24 15:34:37 -07005397 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Amith Yamasanif6e2fcc2014-07-10 13:41:55 -07005398 * @param provider The component name of the service that implements
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005399 * {@link RestrictionsReceiver}. If this param is null, it removes the restrictions
5400 * provider previously assigned.
5401 * @throws SecurityException if {@code admin} is not a device or profile owner.
Amith Yamasanif20d6402014-05-24 15:34:37 -07005402 */
Robin Lee25e26452015-06-02 09:56:29 -07005403 public void setRestrictionsProvider(@NonNull ComponentName admin,
5404 @Nullable ComponentName provider) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005405 throwIfParentInstance("setRestrictionsProvider");
Amith Yamasanif20d6402014-05-24 15:34:37 -07005406 if (mService != null) {
5407 try {
Amith Yamasanif6e2fcc2014-07-10 13:41:55 -07005408 mService.setRestrictionsProvider(admin, provider);
Amith Yamasanif20d6402014-05-24 15:34:37 -07005409 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005410 throw re.rethrowFromSystemServer();
Amith Yamasanif20d6402014-05-24 15:34:37 -07005411 }
5412 }
5413 }
Julia Reynolds4a21b252014-06-04 11:11:43 -04005414
5415 /**
5416 * Called by profile or device owners to set the master volume mute on or off.
5417 *
5418 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5419 * @param on {@code true} to mute master volume, {@code false} to turn mute off.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005420 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynolds4a21b252014-06-04 11:11:43 -04005421 */
Robin Lee25e26452015-06-02 09:56:29 -07005422 public void setMasterVolumeMuted(@NonNull ComponentName admin, boolean on) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005423 throwIfParentInstance("setMasterVolumeMuted");
Julia Reynolds4a21b252014-06-04 11:11:43 -04005424 if (mService != null) {
5425 try {
5426 mService.setMasterVolumeMuted(admin, on);
5427 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005428 throw re.rethrowFromSystemServer();
Julia Reynolds4a21b252014-06-04 11:11:43 -04005429 }
5430 }
5431 }
5432
5433 /**
5434 * Called by profile or device owners to check whether the master volume mute is on or off.
5435 *
5436 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5437 * @return {@code true} if master volume is muted, {@code false} if it's not.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005438 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynolds4a21b252014-06-04 11:11:43 -04005439 */
Robin Lee25e26452015-06-02 09:56:29 -07005440 public boolean isMasterVolumeMuted(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005441 throwIfParentInstance("isMasterVolumeMuted");
Julia Reynolds4a21b252014-06-04 11:11:43 -04005442 if (mService != null) {
5443 try {
5444 return mService.isMasterVolumeMuted(admin);
5445 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005446 throw re.rethrowFromSystemServer();
Julia Reynolds4a21b252014-06-04 11:11:43 -04005447 }
5448 }
5449 return false;
5450 }
Kenny Guyc13053b2014-05-29 14:17:17 +01005451
5452 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005453 * Called by profile or device owners to change whether a user can uninstall a package.
Kenny Guyc13053b2014-05-29 14:17:17 +01005454 *
5455 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5456 * @param packageName package to change.
Esteban Talaverad5c5c132014-08-20 11:35:57 +01005457 * @param uninstallBlocked true if the user shouldn't be able to uninstall the package.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005458 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyc13053b2014-05-29 14:17:17 +01005459 */
Robin Lee25e26452015-06-02 09:56:29 -07005460 public void setUninstallBlocked(@NonNull ComponentName admin, String packageName,
Esteban Talaverad5c5c132014-08-20 11:35:57 +01005461 boolean uninstallBlocked) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005462 throwIfParentInstance("setUninstallBlocked");
Kenny Guyc13053b2014-05-29 14:17:17 +01005463 if (mService != null) {
5464 try {
Esteban Talaverad5c5c132014-08-20 11:35:57 +01005465 mService.setUninstallBlocked(admin, packageName, uninstallBlocked);
Kenny Guyc13053b2014-05-29 14:17:17 +01005466 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005467 throw re.rethrowFromSystemServer();
Kenny Guyc13053b2014-05-29 14:17:17 +01005468 }
5469 }
5470 }
5471
5472 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08005473 * Check whether the user has been blocked by device policy from uninstalling a package.
Rubin Xua97855b2014-11-07 05:41:00 +00005474 * Requires the caller to be the profile owner if checking a specific admin's policy.
Rubin Xue1e6faa2015-03-10 10:51:59 +00005475 * <p>
5476 * <strong>Note:</strong> Starting from {@link android.os.Build.VERSION_CODES#LOLLIPOP_MR1}, the
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005477 * behavior of this API is changed such that passing {@code null} as the {@code admin} parameter
5478 * will return if any admin has blocked the uninstallation. Before L MR1, passing {@code null}
5479 * will cause a NullPointerException to be raised.
Kenny Guyc13053b2014-05-29 14:17:17 +01005480 *
Robin Lee25e26452015-06-02 09:56:29 -07005481 * @param admin The name of the admin component whose blocking policy will be checked, or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005482 * {@code null} to check whether any admin has blocked the uninstallation.
Kenny Guyc13053b2014-05-29 14:17:17 +01005483 * @param packageName package to check.
Rubin Xua97855b2014-11-07 05:41:00 +00005484 * @return true if uninstallation is blocked.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005485 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyc13053b2014-05-29 14:17:17 +01005486 */
Robin Lee25e26452015-06-02 09:56:29 -07005487 public boolean isUninstallBlocked(@Nullable ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005488 throwIfParentInstance("isUninstallBlocked");
Kenny Guyc13053b2014-05-29 14:17:17 +01005489 if (mService != null) {
5490 try {
Esteban Talavera729b2a62014-08-27 18:01:58 +01005491 return mService.isUninstallBlocked(admin, packageName);
Kenny Guyc13053b2014-05-29 14:17:17 +01005492 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005493 throw re.rethrowFromSystemServer();
Kenny Guyc13053b2014-05-29 14:17:17 +01005494 }
5495 }
5496 return false;
5497 }
Svetoslav976e8bd2014-07-16 15:12:03 -07005498
5499 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005500 * Called by the profile owner of a managed profile to enable widget providers from a given
5501 * package to be available in the parent profile. As a result the user will be able to add
5502 * widgets from the white-listed package running under the profile to a widget host which runs
5503 * under the parent profile, for example the home screen. Note that a package may have zero or
5504 * more provider components, where each component provides a different widget type.
Svetoslav976e8bd2014-07-16 15:12:03 -07005505 * <p>
5506 * <strong>Note:</strong> By default no widget provider package is white-listed.
Svetoslav976e8bd2014-07-16 15:12:03 -07005507 *
5508 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5509 * @param packageName The package from which widget providers are white-listed.
5510 * @return Whether the package was added.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005511 * @throws SecurityException if {@code admin} is not a profile owner.
Svetoslav976e8bd2014-07-16 15:12:03 -07005512 * @see #removeCrossProfileWidgetProvider(android.content.ComponentName, String)
5513 * @see #getCrossProfileWidgetProviders(android.content.ComponentName)
5514 */
Robin Lee25e26452015-06-02 09:56:29 -07005515 public boolean addCrossProfileWidgetProvider(@NonNull ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005516 throwIfParentInstance("addCrossProfileWidgetProvider");
Svetoslav976e8bd2014-07-16 15:12:03 -07005517 if (mService != null) {
5518 try {
5519 return mService.addCrossProfileWidgetProvider(admin, packageName);
5520 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005521 throw re.rethrowFromSystemServer();
Svetoslav976e8bd2014-07-16 15:12:03 -07005522 }
5523 }
5524 return false;
5525 }
5526
5527 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07005528 * Called by the profile owner of a managed profile to disable widget providers from a given
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005529 * package to be available in the parent profile. For this method to take effect the package
5530 * should have been added via
5531 * {@link #addCrossProfileWidgetProvider( android.content.ComponentName, String)}.
Svetoslav976e8bd2014-07-16 15:12:03 -07005532 * <p>
5533 * <strong>Note:</strong> By default no widget provider package is white-listed.
Svetoslav976e8bd2014-07-16 15:12:03 -07005534 *
5535 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005536 * @param packageName The package from which widget providers are no longer white-listed.
Svetoslav976e8bd2014-07-16 15:12:03 -07005537 * @return Whether the package was removed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005538 * @throws SecurityException if {@code admin} is not a profile owner.
Svetoslav976e8bd2014-07-16 15:12:03 -07005539 * @see #addCrossProfileWidgetProvider(android.content.ComponentName, String)
5540 * @see #getCrossProfileWidgetProviders(android.content.ComponentName)
5541 */
Esteban Talavera62399912016-01-11 15:37:55 +00005542 public boolean removeCrossProfileWidgetProvider(
5543 @NonNull ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005544 throwIfParentInstance("removeCrossProfileWidgetProvider");
Svetoslav976e8bd2014-07-16 15:12:03 -07005545 if (mService != null) {
5546 try {
5547 return mService.removeCrossProfileWidgetProvider(admin, packageName);
5548 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005549 throw re.rethrowFromSystemServer();
Svetoslav976e8bd2014-07-16 15:12:03 -07005550 }
5551 }
5552 return false;
5553 }
5554
5555 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07005556 * Called by the profile owner of a managed profile to query providers from which packages are
Svetoslav976e8bd2014-07-16 15:12:03 -07005557 * available in the parent profile.
5558 *
5559 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5560 * @return The white-listed package list.
Svetoslav976e8bd2014-07-16 15:12:03 -07005561 * @see #addCrossProfileWidgetProvider(android.content.ComponentName, String)
5562 * @see #removeCrossProfileWidgetProvider(android.content.ComponentName, String)
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005563 * @throws SecurityException if {@code admin} is not a profile owner.
Svetoslav976e8bd2014-07-16 15:12:03 -07005564 */
Robin Lee25e26452015-06-02 09:56:29 -07005565 public List<String> getCrossProfileWidgetProviders(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005566 throwIfParentInstance("getCrossProfileWidgetProviders");
Svetoslav976e8bd2014-07-16 15:12:03 -07005567 if (mService != null) {
5568 try {
5569 List<String> providers = mService.getCrossProfileWidgetProviders(admin);
5570 if (providers != null) {
5571 return providers;
5572 }
5573 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005574 throw re.rethrowFromSystemServer();
Svetoslav976e8bd2014-07-16 15:12:03 -07005575 }
5576 }
5577 return Collections.emptyList();
5578 }
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05005579
5580 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08005581 * Called by profile or device owners to set the user's photo.
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05005582 *
5583 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5584 * @param icon the bitmap to set as the photo.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005585 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05005586 */
Robin Lee25e26452015-06-02 09:56:29 -07005587 public void setUserIcon(@NonNull ComponentName admin, Bitmap icon) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005588 throwIfParentInstance("setUserIcon");
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05005589 try {
5590 mService.setUserIcon(admin, icon);
5591 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005592 throw re.rethrowFromSystemServer();
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05005593 }
5594 }
Craig Lafayettedbe31a62015-04-02 13:14:39 -04005595
5596 /**
Rubin Xu5faad8e2015-04-20 17:43:48 +01005597 * Called by device owners to set a local system update policy. When a new policy is set,
5598 * {@link #ACTION_SYSTEM_UPDATE_POLICY_CHANGED} is broadcasted.
Rubin Xu8027a4f2015-03-10 17:52:37 +00005599 *
Robin Lee25e26452015-06-02 09:56:29 -07005600 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. All
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005601 * components in the device owner package can set system update policies and the most
5602 * recent policy takes effect.
Robin Lee25e26452015-06-02 09:56:29 -07005603 * @param policy the new policy, or {@code null} to clear the current policy.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005604 * @throws SecurityException if {@code admin} is not a device owner.
Rubin Xu5faad8e2015-04-20 17:43:48 +01005605 * @see SystemUpdatePolicy
Rubin Xu8027a4f2015-03-10 17:52:37 +00005606 */
Robin Lee25e26452015-06-02 09:56:29 -07005607 public void setSystemUpdatePolicy(@NonNull ComponentName admin, SystemUpdatePolicy policy) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005608 throwIfParentInstance("setSystemUpdatePolicy");
Rubin Xu8027a4f2015-03-10 17:52:37 +00005609 if (mService != null) {
5610 try {
Robin Lee25e26452015-06-02 09:56:29 -07005611 mService.setSystemUpdatePolicy(admin, policy);
Rubin Xu8027a4f2015-03-10 17:52:37 +00005612 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005613 throw re.rethrowFromSystemServer();
Rubin Xu8027a4f2015-03-10 17:52:37 +00005614 }
5615 }
5616 }
5617
5618 /**
Rubin Xu5faad8e2015-04-20 17:43:48 +01005619 * Retrieve a local system update policy set previously by {@link #setSystemUpdatePolicy}.
Rubin Xu8027a4f2015-03-10 17:52:37 +00005620 *
Robin Lee25e26452015-06-02 09:56:29 -07005621 * @return The current policy object, or {@code null} if no policy is set.
Rubin Xu8027a4f2015-03-10 17:52:37 +00005622 */
Rubin Xu5faad8e2015-04-20 17:43:48 +01005623 public SystemUpdatePolicy getSystemUpdatePolicy() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005624 throwIfParentInstance("getSystemUpdatePolicy");
Rubin Xu8027a4f2015-03-10 17:52:37 +00005625 if (mService != null) {
5626 try {
Rubin Xud86d58c2015-05-05 16:57:37 +01005627 return mService.getSystemUpdatePolicy();
Rubin Xu8027a4f2015-03-10 17:52:37 +00005628 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005629 throw re.rethrowFromSystemServer();
Rubin Xu8027a4f2015-03-10 17:52:37 +00005630 }
5631 }
5632 return null;
5633 }
Benjamin Franze36087e2015-04-07 16:40:34 +01005634
5635 /**
5636 * Called by a device owner to disable the keyguard altogether.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005637 * <p>
5638 * Setting the keyguard to disabled has the same effect as choosing "None" as the screen lock
5639 * type. However, this call has no effect if a password, pin or pattern is currently set. If a
5640 * password, pin or pattern is set after the keyguard was disabled, the keyguard stops being
5641 * disabled.
Benjamin Franze36087e2015-04-07 16:40:34 +01005642 *
5643 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Benjamin Franzbece8062015-05-06 12:14:31 +01005644 * @param disabled {@code true} disables the keyguard, {@code false} reenables it.
Benjamin Franze36087e2015-04-07 16:40:34 +01005645 * @return {@code false} if attempting to disable the keyguard while a lock password was in
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005646 * place. {@code true} otherwise.
5647 * @throws SecurityException if {@code admin} is not a device owner.
Benjamin Franze36087e2015-04-07 16:40:34 +01005648 */
Robin Lee25e26452015-06-02 09:56:29 -07005649 public boolean setKeyguardDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005650 throwIfParentInstance("setKeyguardDisabled");
Benjamin Franze36087e2015-04-07 16:40:34 +01005651 try {
Benjamin Franzbece8062015-05-06 12:14:31 +01005652 return mService.setKeyguardDisabled(admin, disabled);
Benjamin Franze36087e2015-04-07 16:40:34 +01005653 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005654 throw re.rethrowFromSystemServer();
Benjamin Franze36087e2015-04-07 16:40:34 +01005655 }
5656 }
Benjamin Franzea2ec972015-03-16 17:18:09 +00005657
5658 /**
Benjamin Franzbece8062015-05-06 12:14:31 +01005659 * Called by device owner to disable the status bar. Disabling the status bar blocks
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005660 * notifications, quick settings and other screen overlays that allow escaping from a single use
5661 * device.
Benjamin Franzea2ec972015-03-16 17:18:09 +00005662 *
5663 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Benjamin Franzbece8062015-05-06 12:14:31 +01005664 * @param disabled {@code true} disables the status bar, {@code false} reenables it.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005665 * @return {@code false} if attempting to disable the status bar failed. {@code true} otherwise.
5666 * @throws SecurityException if {@code admin} is not a device owner.
Benjamin Franzea2ec972015-03-16 17:18:09 +00005667 */
Robin Lee25e26452015-06-02 09:56:29 -07005668 public boolean setStatusBarDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005669 throwIfParentInstance("setStatusBarDisabled");
Benjamin Franzea2ec972015-03-16 17:18:09 +00005670 try {
Benjamin Franzbece8062015-05-06 12:14:31 +01005671 return mService.setStatusBarDisabled(admin, disabled);
Benjamin Franzea2ec972015-03-16 17:18:09 +00005672 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005673 throw re.rethrowFromSystemServer();
Benjamin Franzea2ec972015-03-16 17:18:09 +00005674 }
5675 }
Rubin Xudc105cc2015-04-14 23:38:01 +01005676
5677 /**
5678 * Callable by the system update service to notify device owners about pending updates.
5679 * The caller must hold {@link android.Manifest.permission#NOTIFY_PENDING_SYSTEM_UPDATE}
5680 * permission.
5681 *
5682 * @param updateReceivedTime The time as given by {@link System#currentTimeMillis()} indicating
5683 * when the current pending update was first available. -1 if no update is available.
5684 * @hide
5685 */
5686 @SystemApi
5687 public void notifyPendingSystemUpdate(long updateReceivedTime) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005688 throwIfParentInstance("notifyPendingSystemUpdate");
Rubin Xudc105cc2015-04-14 23:38:01 +01005689 if (mService != null) {
5690 try {
5691 mService.notifyPendingSystemUpdate(updateReceivedTime);
5692 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005693 throw re.rethrowFromSystemServer();
Rubin Xudc105cc2015-04-14 23:38:01 +01005694 }
5695 }
5696 }
Julia Reynolds13c58ba2015-04-20 16:42:54 -04005697
5698 /**
Amith Yamasanid49489b2015-04-28 14:00:26 -07005699 * Called by profile or device owners to set the default response for future runtime permission
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005700 * requests by applications. The policy can allow for normal operation which prompts the user to
5701 * grant a permission, or can allow automatic granting or denying of runtime permission requests
5702 * by an application. This also applies to new permissions declared by app updates. When a
5703 * permission is denied or granted this way, the effect is equivalent to setting the permission
5704 * grant state via {@link #setPermissionGrantState}.
5705 * <p/>
5706 * As this policy only acts on runtime permission requests, it only applies to applications
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07005707 * built with a {@code targetSdkVersion} of {@link android.os.Build.VERSION_CODES#M} or later.
Benjamin Franz45dd6662015-07-08 14:24:14 +01005708 *
Amith Yamasanid49489b2015-04-28 14:00:26 -07005709 * @param admin Which profile or device owner this request is associated with.
5710 * @param policy One of the policy constants {@link #PERMISSION_POLICY_PROMPT},
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005711 * {@link #PERMISSION_POLICY_AUTO_GRANT} and {@link #PERMISSION_POLICY_AUTO_DENY}.
5712 * @throws SecurityException if {@code admin} is not a device or profile owner.
Benjamin Franz45dd6662015-07-08 14:24:14 +01005713 * @see #setPermissionGrantState
Amith Yamasanid49489b2015-04-28 14:00:26 -07005714 */
Robin Lee25e26452015-06-02 09:56:29 -07005715 public void setPermissionPolicy(@NonNull ComponentName admin, int policy) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005716 throwIfParentInstance("setPermissionPolicy");
Amith Yamasanid49489b2015-04-28 14:00:26 -07005717 try {
5718 mService.setPermissionPolicy(admin, policy);
5719 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005720 throw re.rethrowFromSystemServer();
Amith Yamasanid49489b2015-04-28 14:00:26 -07005721 }
5722 }
5723
5724 /**
5725 * Returns the current runtime permission policy set by the device or profile owner. The
5726 * default is {@link #PERMISSION_POLICY_PROMPT}.
5727 * @param admin Which profile or device owner this request is associated with.
5728 * @return the current policy for future permission requests.
5729 */
Esteban Talavera28b95702015-06-24 15:23:42 +01005730 public int getPermissionPolicy(ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005731 throwIfParentInstance("getPermissionPolicy");
Amith Yamasanid49489b2015-04-28 14:00:26 -07005732 try {
5733 return mService.getPermissionPolicy(admin);
5734 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005735 throw re.rethrowFromSystemServer();
Amith Yamasanid49489b2015-04-28 14:00:26 -07005736 }
5737 }
5738
5739 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005740 * Sets the grant state of a runtime permission for a specific application. The state can be
5741 * {@link #PERMISSION_GRANT_STATE_DEFAULT default} in which a user can manage it through the UI,
5742 * {@link #PERMISSION_GRANT_STATE_DENIED denied}, in which the permission is denied and the user
5743 * cannot manage it through the UI, and {@link #PERMISSION_GRANT_STATE_GRANTED granted} in which
5744 * the permission is granted and the user cannot manage it through the UI. This might affect all
5745 * permissions in a group that the runtime permission belongs to. This method can only be called
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07005746 * by a profile or device owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005747 * <p/>
5748 * Setting the grant state to {@link #PERMISSION_GRANT_STATE_DEFAULT default} does not revoke
5749 * the permission. It retains the previous grant, if any.
5750 * <p/>
5751 * Permissions can be granted or revoked only for applications built with a
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07005752 * {@code targetSdkVersion} of {@link android.os.Build.VERSION_CODES#M} or later.
Amith Yamasani0bf8f7c2015-06-22 13:00:32 -07005753 *
Amith Yamasanid49489b2015-04-28 14:00:26 -07005754 * @param admin Which profile or device owner this request is associated with.
5755 * @param packageName The application to grant or revoke a permission to.
5756 * @param permission The permission to grant or revoke.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005757 * @param grantState The permission grant state which is one of
5758 * {@link #PERMISSION_GRANT_STATE_DENIED}, {@link #PERMISSION_GRANT_STATE_DEFAULT},
5759 * {@link #PERMISSION_GRANT_STATE_GRANTED},
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07005760 * @return whether the permission was successfully granted or revoked.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005761 * @throws SecurityException if {@code admin} is not a device or profile owner.
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07005762 * @see #PERMISSION_GRANT_STATE_DENIED
5763 * @see #PERMISSION_GRANT_STATE_DEFAULT
5764 * @see #PERMISSION_GRANT_STATE_GRANTED
Amith Yamasanid49489b2015-04-28 14:00:26 -07005765 */
Robin Lee25e26452015-06-02 09:56:29 -07005766 public boolean setPermissionGrantState(@NonNull ComponentName admin, String packageName,
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07005767 String permission, int grantState) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005768 throwIfParentInstance("setPermissionGrantState");
Amith Yamasanid49489b2015-04-28 14:00:26 -07005769 try {
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07005770 return mService.setPermissionGrantState(admin, packageName, permission, grantState);
Amith Yamasanid49489b2015-04-28 14:00:26 -07005771 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005772 throw re.rethrowFromSystemServer();
Amith Yamasanid49489b2015-04-28 14:00:26 -07005773 }
5774 }
Amith Yamasani184b3752015-05-22 13:00:51 -07005775
5776 /**
5777 * Returns the current grant state of a runtime permission for a specific application.
5778 *
5779 * @param admin Which profile or device owner this request is associated with.
5780 * @param packageName The application to check the grant state for.
5781 * @param permission The permission to check for.
5782 * @return the current grant state specified by device policy. If the profile or device owner
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005783 * has not set a grant state, the return value is
5784 * {@link #PERMISSION_GRANT_STATE_DEFAULT}. This does not indicate whether or not the
5785 * permission is currently granted for the package.
5786 * <p/>
5787 * If a grant state was set by the profile or device owner, then the return value will
5788 * be one of {@link #PERMISSION_GRANT_STATE_DENIED} or
5789 * {@link #PERMISSION_GRANT_STATE_GRANTED}, which indicates if the permission is
5790 * currently denied or granted.
5791 * @throws SecurityException if {@code admin} is not a device or profile owner.
Amith Yamasani184b3752015-05-22 13:00:51 -07005792 * @see #setPermissionGrantState(ComponentName, String, String, int)
5793 * @see PackageManager#checkPermission(String, String)
5794 */
Robin Lee25e26452015-06-02 09:56:29 -07005795 public int getPermissionGrantState(@NonNull ComponentName admin, String packageName,
Amith Yamasani184b3752015-05-22 13:00:51 -07005796 String permission) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005797 throwIfParentInstance("getPermissionGrantState");
Amith Yamasani184b3752015-05-22 13:00:51 -07005798 try {
5799 return mService.getPermissionGrantState(admin, packageName, permission);
5800 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005801 throw re.rethrowFromSystemServer();
Amith Yamasani184b3752015-05-22 13:00:51 -07005802 }
5803 }
Nicolas Prevot07387fe2015-10-30 17:53:30 +00005804
5805 /**
5806 * Returns if provisioning a managed profile or device is possible or not.
5807 * @param action One of {@link #ACTION_PROVISION_MANAGED_DEVICE},
5808 * {@link #ACTION_PROVISION_MANAGED_PROFILE}.
Nicolas Prevot07387fe2015-10-30 17:53:30 +00005809 * @return if provisioning a managed profile or device is possible or not.
5810 * @throws IllegalArgumentException if the supplied action is not valid.
5811 */
5812 public boolean isProvisioningAllowed(String action) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005813 throwIfParentInstance("isProvisioningAllowed");
Nicolas Prevot07387fe2015-10-30 17:53:30 +00005814 try {
5815 return mService.isProvisioningAllowed(action);
5816 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005817 throw re.rethrowFromSystemServer();
Nicolas Prevot07387fe2015-10-30 17:53:30 +00005818 }
5819 }
Mahaver Chopra15a46b02015-11-11 14:54:35 +00005820
5821 /**
Mahaver Chopra15a46b02015-11-11 14:54:35 +00005822 * Return if this user is a managed profile of another user. An admin can become the profile
5823 * owner of a managed profile with {@link #ACTION_PROVISION_MANAGED_PROFILE} and of a managed
Kenny Guyffa38402016-03-31 16:40:57 +01005824 * user with {@link #createAndManageUser}
Mahaver Chopra15a46b02015-11-11 14:54:35 +00005825 * @param admin Which profile owner this request is associated with.
5826 * @return if this user is a managed profile of another user.
5827 */
5828 public boolean isManagedProfile(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005829 throwIfParentInstance("isManagedProfile");
Mahaver Chopra15a46b02015-11-11 14:54:35 +00005830 try {
5831 return mService.isManagedProfile(admin);
5832 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005833 throw re.rethrowFromSystemServer();
Mahaver Chopra15a46b02015-11-11 14:54:35 +00005834 }
5835 }
5836
5837 /**
5838 * @hide
5839 * Return if this user is a system-only user. An admin can manage a device from a system only
5840 * user by calling {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE}.
5841 * @param admin Which device owner this request is associated with.
5842 * @return if this user is a system-only user.
5843 */
5844 public boolean isSystemOnlyUser(@NonNull ComponentName admin) {
5845 try {
5846 return mService.isSystemOnlyUser(admin);
5847 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005848 throw re.rethrowFromSystemServer();
Mahaver Chopra15a46b02015-11-11 14:54:35 +00005849 }
5850 }
Makoto Onukia31ebbc2015-11-23 17:15:21 -08005851
5852 /**
5853 * Called by device owner to get the MAC address of the Wi-Fi device.
5854 *
Sudheer Shanka3cb4da12016-03-07 18:51:49 -08005855 * @param admin Which device owner this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005856 * @return the MAC address of the Wi-Fi device, or null when the information is not available.
5857 * (For example, Wi-Fi hasn't been enabled, or the device doesn't support Wi-Fi.)
5858 * <p>
5859 * The address will be in the {@code XX:XX:XX:XX:XX:XX} format.
5860 * @throws SecurityException if {@code admin} is not a device owner.
Makoto Onukia31ebbc2015-11-23 17:15:21 -08005861 */
Sudheer Shanka3cb4da12016-03-07 18:51:49 -08005862 public String getWifiMacAddress(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005863 throwIfParentInstance("getWifiMacAddress");
Makoto Onukia31ebbc2015-11-23 17:15:21 -08005864 try {
Sudheer Shanka3cb4da12016-03-07 18:51:49 -08005865 return mService.getWifiMacAddress(admin);
Makoto Onukia31ebbc2015-11-23 17:15:21 -08005866 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005867 throw re.rethrowFromSystemServer();
Makoto Onukia31ebbc2015-11-23 17:15:21 -08005868 }
5869 }
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +00005870
5871 /**
Mahaver Chopra1216ae52016-03-11 15:39:48 +00005872 * Called by device owner to reboot the device. If there is an ongoing call on the device,
5873 * throws an {@link IllegalStateException}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005874 * @param admin Which device owner the request is associated with.
Mahaver Chopra1216ae52016-03-11 15:39:48 +00005875 * @throws IllegalStateException if device has an ongoing call.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005876 * @throws SecurityException if {@code admin} is not a device owner.
Mahaver Chopra1216ae52016-03-11 15:39:48 +00005877 * @see TelephonyManager#CALL_STATE_IDLE
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +00005878 */
5879 public void reboot(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005880 throwIfParentInstance("reboot");
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +00005881 try {
5882 mService.reboot(admin);
5883 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005884 throw re.rethrowFromSystemServer();
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +00005885 }
5886 }
Kenny Guy06de4e72015-12-22 12:07:39 +00005887
5888 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005889 * Called by a device admin to set the short support message. This will be displayed to the user
5890 * in settings screens where funtionality has been disabled by the admin. The message should be
5891 * limited to a short statement such as "This setting is disabled by your administrator. Contact
5892 * someone@example.com for support." If the message is longer than 200 characters it may be
5893 * truncated.
5894 * <p>
5895 * If the short support message needs to be localized, it is the responsibility of the
Benjamin Franz3e8a7092016-01-25 16:19:08 +00005896 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
5897 * and set a new version of this string accordingly.
5898 *
Kenny Guy06de4e72015-12-22 12:07:39 +00005899 * @see #setLongSupportMessage
Kenny Guy06de4e72015-12-22 12:07:39 +00005900 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005901 * @param message Short message to be displayed to the user in settings or null to clear the
5902 * existing message.
5903 * @throws SecurityException if {@code admin} is not an active administrator.
Kenny Guy06de4e72015-12-22 12:07:39 +00005904 */
5905 public void setShortSupportMessage(@NonNull ComponentName admin,
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07005906 @Nullable CharSequence message) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005907 throwIfParentInstance("setShortSupportMessage");
Kenny Guy06de4e72015-12-22 12:07:39 +00005908 if (mService != null) {
5909 try {
5910 mService.setShortSupportMessage(admin, message);
5911 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005912 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00005913 }
5914 }
5915 }
5916
5917 /**
5918 * Called by a device admin to get the short support message.
5919 *
5920 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07005921 * @return The message set by {@link #setShortSupportMessage(ComponentName, CharSequence)} or
5922 * null if no message has been set.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005923 * @throws SecurityException if {@code admin} is not an active administrator.
Kenny Guy06de4e72015-12-22 12:07:39 +00005924 */
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07005925 public CharSequence getShortSupportMessage(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005926 throwIfParentInstance("getShortSupportMessage");
Kenny Guy06de4e72015-12-22 12:07:39 +00005927 if (mService != null) {
5928 try {
5929 return mService.getShortSupportMessage(admin);
5930 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005931 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00005932 }
5933 }
5934 return null;
5935 }
5936
5937 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005938 * Called by a device admin to set the long support message. This will be displayed to the user
5939 * in the device administators settings screen.
5940 * <p>
5941 * If the long support message needs to be localized, it is the responsibility of the
Benjamin Franz3e8a7092016-01-25 16:19:08 +00005942 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
5943 * and set a new version of this string accordingly.
5944 *
Kenny Guy06de4e72015-12-22 12:07:39 +00005945 * @see #setShortSupportMessage
Kenny Guy06de4e72015-12-22 12:07:39 +00005946 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005947 * @param message Long message to be displayed to the user in settings or null to clear the
5948 * existing message.
5949 * @throws SecurityException if {@code admin} is not an active administrator.
Kenny Guy06de4e72015-12-22 12:07:39 +00005950 */
5951 public void setLongSupportMessage(@NonNull ComponentName admin,
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07005952 @Nullable CharSequence message) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005953 throwIfParentInstance("setLongSupportMessage");
Kenny Guy06de4e72015-12-22 12:07:39 +00005954 if (mService != null) {
5955 try {
5956 mService.setLongSupportMessage(admin, message);
5957 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005958 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00005959 }
5960 }
5961 }
5962
5963 /**
5964 * Called by a device admin to get the long support message.
5965 *
5966 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07005967 * @return The message set by {@link #setLongSupportMessage(ComponentName, CharSequence)} or
5968 * null if no message has been set.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005969 * @throws SecurityException if {@code admin} is not an active administrator.
Kenny Guy06de4e72015-12-22 12:07:39 +00005970 */
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07005971 public CharSequence getLongSupportMessage(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005972 throwIfParentInstance("getLongSupportMessage");
Kenny Guy06de4e72015-12-22 12:07:39 +00005973 if (mService != null) {
5974 try {
5975 return mService.getLongSupportMessage(admin);
5976 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005977 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00005978 }
5979 }
5980 return null;
5981 }
5982
5983 /**
5984 * Called by the system to get the short support message.
5985 *
5986 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5987 * @param userHandle user id the admin is running as.
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07005988 * @return The message set by {@link #setShortSupportMessage(ComponentName, CharSequence)}
Kenny Guy06de4e72015-12-22 12:07:39 +00005989 *
5990 * @hide
5991 */
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07005992 public CharSequence getShortSupportMessageForUser(@NonNull ComponentName admin,
5993 int userHandle) {
Kenny Guy06de4e72015-12-22 12:07:39 +00005994 if (mService != null) {
5995 try {
5996 return mService.getShortSupportMessageForUser(admin, userHandle);
5997 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005998 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00005999 }
6000 }
6001 return null;
6002 }
6003
6004
6005 /**
6006 * Called by the system to get the long support message.
6007 *
6008 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6009 * @param userHandle user id the admin is running as.
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07006010 * @return The message set by {@link #setLongSupportMessage(ComponentName, CharSequence)}
Kenny Guy06de4e72015-12-22 12:07:39 +00006011 *
6012 * @hide
6013 */
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07006014 public CharSequence getLongSupportMessageForUser(@NonNull ComponentName admin, int userHandle) {
Kenny Guy06de4e72015-12-22 12:07:39 +00006015 if (mService != null) {
6016 try {
6017 return mService.getLongSupportMessageForUser(admin, userHandle);
6018 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006019 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00006020 }
6021 }
6022 return null;
6023 }
Clara Bayarri3e826ef2015-12-14 17:51:22 +00006024
6025 /**
Esteban Talavera62399912016-01-11 15:37:55 +00006026 * Called by the profile owner of a managed profile to obtain a {@link DevicePolicyManager}
6027 * whose calls act on the parent profile.
Benjamin Franz66b45f02016-04-05 19:12:39 +01006028 *
6029 * <p>The following methods are supported for the parent instance, all other methods will
6030 * throw a SecurityException when called on the parent instance:
6031 * <ul>
6032 * <li>{@link #getPasswordQuality}</li>
6033 * <li>{@link #setPasswordQuality}</li>
6034 * <li>{@link #getPasswordMinimumLength}</li>
6035 * <li>{@link #setPasswordMinimumLength}</li>
6036 * <li>{@link #getPasswordMinimumUpperCase}</li>
6037 * <li>{@link #setPasswordMinimumUpperCase}</li>
6038 * <li>{@link #getPasswordMinimumLowerCase}</li>
6039 * <li>{@link #setPasswordMinimumLowerCase}</li>
6040 * <li>{@link #getPasswordMinimumLetters}</li>
6041 * <li>{@link #setPasswordMinimumLetters}</li>
6042 * <li>{@link #getPasswordMinimumNumeric}</li>
6043 * <li>{@link #setPasswordMinimumNumeric}</li>
6044 * <li>{@link #getPasswordMinimumSymbols}</li>
6045 * <li>{@link #setPasswordMinimumSymbols}</li>
6046 * <li>{@link #getPasswordMinimumNonLetter}</li>
6047 * <li>{@link #setPasswordMinimumNonLetter}</li>
6048 * <li>{@link #getPasswordHistoryLength}</li>
6049 * <li>{@link #setPasswordHistoryLength}</li>
6050 * <li>{@link #getPasswordExpirationTimeout}</li>
6051 * <li>{@link #setPasswordExpirationTimeout}</li>
6052 * <li>{@link #getPasswordExpiration}</li>
6053 * <li>{@link #isActivePasswordSufficient}</li>
6054 * <li>{@link #getCurrentFailedPasswordAttempts}</li>
6055 * <li>{@link #getMaximumFailedPasswordsForWipe}</li>
6056 * <li>{@link #setMaximumFailedPasswordsForWipe}</li>
6057 * <li>{@link #getMaximumTimeToLock}</li>
6058 * <li>{@link #setMaximumTimeToLock}</li>
6059 * <li>{@link #lockNow}</li>
6060 * <li>{@link #getKeyguardDisabledFeatures}</li>
6061 * <li>{@link #setKeyguardDisabledFeatures}</li>
6062 * <li>{@link #getTrustAgentConfiguration}</li>
6063 * <li>{@link #setTrustAgentConfiguration}</li>
6064 * </ul>
Clara Bayarri3e826ef2015-12-14 17:51:22 +00006065 *
6066 * @return a new instance of {@link DevicePolicyManager} that acts on the parent profile.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006067 * @throws SecurityException if {@code admin} is not a profile owner.
Clara Bayarri3e826ef2015-12-14 17:51:22 +00006068 */
6069 public DevicePolicyManager getParentProfileInstance(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006070 throwIfParentInstance("getParentProfileInstance");
Clara Bayarri3e826ef2015-12-14 17:51:22 +00006071 try {
6072 if (!mService.isManagedProfile(admin)) {
6073 throw new SecurityException("The current user does not have a parent profile.");
6074 }
6075 return new DevicePolicyManager(mContext, true);
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006076 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006077 throw e.rethrowFromSystemServer();
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006078 }
6079 }
6080
6081 /**
Michal Karpinski6235a942016-03-15 12:07:23 +00006082 * Called by device owner to control the security logging feature. Logging can only be
6083 * enabled on single user devices where the sole user is managed by the device owner.
6084 *
6085 * <p> Security logs contain various information intended for security auditing purposes.
6086 * See {@link SecurityEvent} for details.
6087 *
6088 * <p>There must be only one user on the device, managed by the device owner.
6089 * Otherwise a {@link SecurityException} will be thrown.
Michal Karpinskib58e4962016-03-01 14:55:10 +00006090 *
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006091 * @param admin Which device owner this request is associated with.
Michal Karpinski6235a942016-03-15 12:07:23 +00006092 * @param enabled whether security logging should be enabled or not.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006093 * @throws SecurityException if {@code admin} is not a device owner.
Michal Karpinski6235a942016-03-15 12:07:23 +00006094 * @see #retrieveSecurityLogs
6095 */
6096 public void setSecurityLoggingEnabled(@NonNull ComponentName admin, boolean enabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006097 throwIfParentInstance("setSecurityLoggingEnabled");
Michal Karpinski6235a942016-03-15 12:07:23 +00006098 try {
6099 mService.setSecurityLoggingEnabled(admin, enabled);
6100 } catch (RemoteException re) {
6101 throw re.rethrowFromSystemServer();
6102 }
6103 }
6104
6105 /**
Michal Karpinski6235a942016-03-15 12:07:23 +00006106 * Return whether security logging is enabled or not by the device owner.
6107 *
6108 * <p>Can only be called by the device owner, otherwise a {@link SecurityException} will be
6109 * thrown.
6110 *
6111 * @param admin Which device owner this request is associated with.
6112 * @return {@code true} if security logging is enabled by device owner, {@code false} otherwise.
6113 * @throws SecurityException if {@code admin} is not a device owner.
6114 */
6115 public boolean isSecurityLoggingEnabled(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006116 throwIfParentInstance("isSecurityLoggingEnabled");
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006117 try {
Michal Karpinski6235a942016-03-15 12:07:23 +00006118 return mService.isSecurityLoggingEnabled(admin);
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006119 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006120 throw re.rethrowFromSystemServer();
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006121 }
6122 }
6123
6124 /**
Michal Karpinski6235a942016-03-15 12:07:23 +00006125 * Called by device owner to retrieve all new security logging entries since the last call to
6126 * this API after device boots.
6127 *
6128 * <p> Access to the logs is rate limited and it will only return new logs after the device
6129 * owner has been notified via {@link DeviceAdminReceiver#onSecurityLogsAvailable}.
6130 *
6131 * <p>There must be only one user on the device, managed by the device owner.
6132 * Otherwise a {@link SecurityException} will be thrown.
Michal Karpinskib58e4962016-03-01 14:55:10 +00006133 *
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006134 * @param admin Which device owner this request is associated with.
Michal Karpinski6235a942016-03-15 12:07:23 +00006135 * @return the new batch of security logs which is a list of {@link SecurityEvent},
6136 * or {@code null} if rate limitation is exceeded or if logging is currently disabled.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006137 * @throws SecurityException if {@code admin} is not a device owner.
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006138 */
Michal Karpinski6235a942016-03-15 12:07:23 +00006139 public List<SecurityEvent> retrieveSecurityLogs(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006140 throwIfParentInstance("retrieveSecurityLogs");
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006141 try {
Michal Karpinski6235a942016-03-15 12:07:23 +00006142 ParceledListSlice<SecurityEvent> list = mService.retrieveSecurityLogs(admin);
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006143 if (list != null) {
6144 return list.getList();
6145 } else {
6146 // Rate limit exceeded.
6147 return null;
6148 }
Clara Bayarri3e826ef2015-12-14 17:51:22 +00006149 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006150 throw re.rethrowFromSystemServer();
Clara Bayarri3e826ef2015-12-14 17:51:22 +00006151 }
6152 }
Benjamin Franz59720bb2016-01-18 15:26:11 +00006153
6154 /**
Sudheer Shanka978fc0d2016-01-28 13:51:10 +00006155 * Called by the system to obtain a {@link DevicePolicyManager} whose calls act on the parent
6156 * profile.
6157 *
6158 * @hide
6159 */
6160 public DevicePolicyManager getParentProfileInstance(UserInfo uInfo) {
6161 mContext.checkSelfPermission(
6162 android.Manifest.permission.MANAGE_PROFILE_AND_DEVICE_OWNERS);
6163 if (!uInfo.isManagedProfile()) {
6164 throw new SecurityException("The user " + uInfo.id
6165 + " does not have a parent profile.");
6166 }
6167 return new DevicePolicyManager(mContext, true);
6168 }
6169
6170 /**
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006171 * Called by device owners to retrieve device logs from before the device's last reboot.
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006172 * <p>
Rubin Xu0fb6b9e2016-05-04 19:01:07 +01006173 * <strong> This API is not supported on all devices. Calling this API on unsupported devices
6174 * will result in {@code null} being returned. The device logs are retrieved from a RAM region
6175 * which is not guaranteed to be corruption-free during power cycles, as a result be cautious
6176 * about data corruption when parsing. </strong>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006177 * <p>
6178 * There must be only one user on the device, managed by the device owner. Otherwise a
6179 * {@link SecurityException} will be thrown.
Michal Karpinskib58e4962016-03-01 14:55:10 +00006180 *
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006181 * @param admin Which device owner this request is associated with.
Rubin Xu0fb6b9e2016-05-04 19:01:07 +01006182 * @return Device logs from before the latest reboot of the system, or {@code null} if this API
6183 * is not supported on the device.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006184 * @throws SecurityException if {@code admin} is not a device owner.
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006185 */
Michal Karpinski6235a942016-03-15 12:07:23 +00006186 public List<SecurityEvent> retrievePreRebootSecurityLogs(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006187 throwIfParentInstance("retrievePreRebootSecurityLogs");
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006188 try {
Michal Karpinski6235a942016-03-15 12:07:23 +00006189 ParceledListSlice<SecurityEvent> list = mService.retrievePreRebootSecurityLogs(admin);
Rubin Xu0fb6b9e2016-05-04 19:01:07 +01006190 if (list != null) {
6191 return list.getList();
6192 } else {
6193 return null;
6194 }
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006195 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006196 throw re.rethrowFromSystemServer();
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006197 }
6198 }
6199
6200 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006201 * Called by a profile owner of a managed profile to set the color used for customization. This
6202 * color is used as background color of the confirm credentials screen for that user. The
Clara Bayarri8d0bd7fa2016-03-30 14:59:58 +01006203 * default color is teal (#00796B).
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006204 * <p>
6205 * The confirm credentials screen can be created using
Benjamin Franz59720bb2016-01-18 15:26:11 +00006206 * {@link android.app.KeyguardManager#createConfirmDeviceCredentialIntent}.
6207 *
6208 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Michal Karpinski74cd7302016-04-12 15:17:36 +01006209 * @param color The 24bit (0xRRGGBB) representation of the color to be used.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006210 * @throws SecurityException if {@code admin} is not a profile owner.
Benjamin Franz59720bb2016-01-18 15:26:11 +00006211 */
6212 public void setOrganizationColor(@NonNull ComponentName admin, int color) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006213 throwIfParentInstance("setOrganizationColor");
Benjamin Franz59720bb2016-01-18 15:26:11 +00006214 try {
Michal Karpinski74cd7302016-04-12 15:17:36 +01006215 // always enforce alpha channel to have 100% opacity
6216 color |= 0xFF000000;
Benjamin Franz59720bb2016-01-18 15:26:11 +00006217 mService.setOrganizationColor(admin, color);
6218 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006219 throw re.rethrowFromSystemServer();
Benjamin Franz59720bb2016-01-18 15:26:11 +00006220 }
6221 }
6222
6223 /**
Nicolas Prevot8f7698a2016-02-11 16:05:33 +00006224 * @hide
6225 *
6226 * Sets the color used for customization.
6227 *
Michal Karpinski74cd7302016-04-12 15:17:36 +01006228 * @param color The 24bit (0xRRGGBB) representation of the color to be used.
Nicolas Prevot8f7698a2016-02-11 16:05:33 +00006229 * @param userId which user to set the color to.
6230 * @RequiresPermission(allOf = {
6231 * Manifest.permission.MANAGE_USERS,
6232 * Manifest.permission.INTERACT_ACROSS_USERS_FULL})
6233 */
6234 public void setOrganizationColorForUser(@ColorInt int color, @UserIdInt int userId) {
6235 try {
Michal Karpinski74cd7302016-04-12 15:17:36 +01006236 // always enforce alpha channel to have 100% opacity
6237 color |= 0xFF000000;
Nicolas Prevot8f7698a2016-02-11 16:05:33 +00006238 mService.setOrganizationColorForUser(color, userId);
6239 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006240 throw re.rethrowFromSystemServer();
Nicolas Prevot8f7698a2016-02-11 16:05:33 +00006241 }
6242 }
6243
6244 /**
Benjamin Franz59720bb2016-01-18 15:26:11 +00006245 * Called by a profile owner of a managed profile to retrieve the color used for customization.
6246 * This color is used as background color of the confirm credentials screen for that user.
6247 *
6248 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Michal Karpinski74cd7302016-04-12 15:17:36 +01006249 * @return The 24bit (0xRRGGBB) representation of the color to be used.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006250 * @throws SecurityException if {@code admin} is not a profile owner.
Benjamin Franz59720bb2016-01-18 15:26:11 +00006251 */
Michal Karpinski74cd7302016-04-12 15:17:36 +01006252 public @ColorInt int getOrganizationColor(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006253 throwIfParentInstance("getOrganizationColor");
Benjamin Franz59720bb2016-01-18 15:26:11 +00006254 try {
6255 return mService.getOrganizationColor(admin);
6256 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006257 throw re.rethrowFromSystemServer();
Benjamin Franz59720bb2016-01-18 15:26:11 +00006258 }
6259 }
6260
6261 /**
6262 * @hide
6263 * Retrieve the customization color for a given user.
6264 *
6265 * @param userHandle The user id of the user we're interested in.
Michal Karpinski74cd7302016-04-12 15:17:36 +01006266 * @return The 24bit (0xRRGGBB) representation of the color to be used.
Benjamin Franz59720bb2016-01-18 15:26:11 +00006267 */
Michal Karpinski74cd7302016-04-12 15:17:36 +01006268 public @ColorInt int getOrganizationColorForUser(int userHandle) {
Benjamin Franz59720bb2016-01-18 15:26:11 +00006269 try {
6270 return mService.getOrganizationColorForUser(userHandle);
6271 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006272 throw re.rethrowFromSystemServer();
Benjamin Franz59720bb2016-01-18 15:26:11 +00006273 }
6274 }
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01006275
6276 /**
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006277 * Called by a profile owner of a managed profile to set the name of the organization under
6278 * management.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006279 * <p>
6280 * If the organization name needs to be localized, it is the responsibility of the
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006281 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
6282 * and set a new version of this string accordingly.
6283 *
6284 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6285 * @param title The organization name or {@code null} to clear a previously set name.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006286 * @throws SecurityException if {@code admin} is not a profile owner.
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006287 */
Michal Karpinski74cd7302016-04-12 15:17:36 +01006288 public void setOrganizationName(@NonNull ComponentName admin, @Nullable CharSequence title) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006289 throwIfParentInstance("setOrganizationName");
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006290 try {
6291 mService.setOrganizationName(admin, title);
6292 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006293 throw re.rethrowFromSystemServer();
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006294 }
6295 }
6296
6297 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006298 * Called by a profile owner of a managed profile to retrieve the name of the organization under
6299 * management.
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006300 *
6301 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6302 * @return The organization name or {@code null} if none is set.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006303 * @throws SecurityException if {@code admin} is not a profile owner.
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006304 */
Michal Karpinski74cd7302016-04-12 15:17:36 +01006305 public CharSequence getOrganizationName(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006306 throwIfParentInstance("getOrganizationName");
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006307 try {
6308 return mService.getOrganizationName(admin);
6309 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006310 throw re.rethrowFromSystemServer();
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006311 }
6312 }
6313
6314 /**
6315 * Retrieve the default title message used in the confirm credentials screen for a given user.
6316 *
6317 * @param userHandle The user id of the user we're interested in.
6318 * @return The organization name or {@code null} if none is set.
6319 *
6320 * @hide
6321 */
Michal Karpinski74cd7302016-04-12 15:17:36 +01006322 public CharSequence getOrganizationNameForUser(int userHandle) {
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006323 try {
6324 return mService.getOrganizationNameForUser(userHandle);
6325 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006326 throw re.rethrowFromSystemServer();
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006327 }
6328 }
6329
6330 /**
Alan Treadwayafad8782016-01-19 15:15:08 +00006331 * @return the {@link UserProvisioningState} for the current user - for unmanaged users will
6332 * return {@link #STATE_USER_UNMANAGED}
6333 * @hide
6334 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00006335 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00006336 @UserProvisioningState
6337 public int getUserProvisioningState() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006338 throwIfParentInstance("getUserProvisioningState");
Alan Treadwayafad8782016-01-19 15:15:08 +00006339 if (mService != null) {
6340 try {
6341 return mService.getUserProvisioningState();
6342 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006343 throw e.rethrowFromSystemServer();
Alan Treadwayafad8782016-01-19 15:15:08 +00006344 }
6345 }
6346 return STATE_USER_UNMANAGED;
6347 }
6348
6349 /**
6350 * Set the {@link UserProvisioningState} for the supplied user, if they are managed.
6351 *
6352 * @param state to store
6353 * @param userHandle for user
6354 * @hide
6355 */
6356 public void setUserProvisioningState(@UserProvisioningState int state, int userHandle) {
6357 if (mService != null) {
6358 try {
6359 mService.setUserProvisioningState(state, userHandle);
6360 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006361 throw e.rethrowFromSystemServer();
Alan Treadwayafad8782016-01-19 15:15:08 +00006362 }
6363 }
6364 }
6365
6366 /**
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01006367 * @hide
6368 * Indicates the entity that controls the device or profile owner. A user/profile is considered
6369 * affiliated if it is managed by the same entity as the device.
6370 *
6371 * <p> By definition, the user that the device owner runs on is always affiliated. Any other
6372 * user/profile is considered affiliated if the following conditions are both met:
6373 * <ul>
6374 * <li>The device owner and the user's/profile's profile owner have called this method,
6375 * specifying a set of opaque affiliation ids each. If the sets specified by the device owner
6376 * and a profile owner intersect, they must have come from the same source, which means that
6377 * the device owner and profile owner are controlled by the same entity.</li>
6378 * <li>The device owner's and profile owner's package names are the same.</li>
6379 * </ul>
6380 *
6381 * @param admin Which profile or device owner this request is associated with.
6382 * @param ids A set of opaque affiliation ids.
6383 */
6384 public void setAffiliationIds(@NonNull ComponentName admin, Set<String> ids) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006385 throwIfParentInstance("setAffiliationIds");
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01006386 try {
6387 mService.setAffiliationIds(admin, new ArrayList<String>(ids));
6388 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006389 throw e.rethrowFromSystemServer();
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01006390 }
6391 }
6392
6393 /**
6394 * @hide
6395 * Returns whether this user/profile is affiliated with the device. See
6396 * {@link #setAffiliationIds} for the definition of affiliation.
6397 *
6398 * @return whether this user/profile is affiliated with the device.
6399 */
6400 public boolean isAffiliatedUser() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006401 throwIfParentInstance("isAffiliatedUser");
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01006402 try {
6403 return mService != null && mService.isAffiliatedUser();
6404 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006405 throw e.rethrowFromSystemServer();
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01006406 }
6407 }
Suprabh Shuklaa2ae2232016-01-28 18:05:14 -08006408
6409 /**
6410 * @hide
6411 * Returns whether the uninstall for {@code packageName} for the current user is in queue
6412 * to be started
6413 * @param packageName the package to check for
6414 * @return whether the uninstall intent for {@code packageName} is pending
6415 */
6416 public boolean isUninstallInQueue(String packageName) {
6417 try {
6418 return mService.isUninstallInQueue(packageName);
6419 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006420 throw re.rethrowFromSystemServer();
Suprabh Shuklaa2ae2232016-01-28 18:05:14 -08006421 }
6422 }
6423
6424 /**
6425 * @hide
6426 * @param packageName the package containing active DAs to be uninstalled
6427 */
6428 public void uninstallPackageWithActiveAdmins(String packageName) {
6429 try {
6430 mService.uninstallPackageWithActiveAdmins(packageName);
6431 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006432 throw re.rethrowFromSystemServer();
Suprabh Shuklaa2ae2232016-01-28 18:05:14 -08006433 }
6434 }
Benjamin Franzbc33c822016-04-15 08:57:52 +01006435
Kenny Guy38dcca52016-04-19 13:09:18 +01006436 /**
6437 * @hide
6438 * Remove a test admin synchronously without sending it a broadcast about being removed.
6439 * If the admin is a profile owner or device owner it will still be removed.
6440 *
6441 * @param userHandle user id to remove the admin for.
6442 * @param admin The administration compononent to remove.
6443 * @throws SecurityException if the caller is not shell / root or the admin package
6444 * isn't a test application see {@link ApplicationInfo#FLAG_TEST_APP}.
6445 */
6446 public void forceRemoveActiveAdmin(ComponentName adminReceiver, int userHandle) {
6447 try {
6448 mService.forceRemoveActiveAdmin(adminReceiver, userHandle);
6449 } catch (RemoteException re) {
6450 throw re.rethrowFromSystemServer();
6451 }
6452 }
6453
Mahaver Chopra790d1982016-07-07 16:06:49 +01006454 /**
6455 * @hide
6456 * @return whether {@link android.provider.Settings.Global#DEVICE_PROVISIONED} has ever been set
6457 * to 1.
6458 */
6459 public boolean isDeviceProvisioned() {
6460 try {
6461 return mService.isDeviceProvisioned();
6462 } catch (RemoteException re) {
6463 throw re.rethrowFromSystemServer();
6464 }
6465 }
6466
Benjamin Franz2aa9bab2016-07-11 19:10:36 +01006467 /**
6468 * @hide
6469 * Writes that the provisioning configuration has been applied.
6470 */
6471 public void setDeviceProvisioningConfigApplied() {
6472 try {
6473 mService.setDeviceProvisioningConfigApplied();
6474 } catch (RemoteException re) {
6475 throw re.rethrowFromSystemServer();
6476 }
6477 }
6478
6479 /**
6480 * @hide
6481 * @return whether the provisioning configuration has been applied.
6482 */
6483 public boolean isDeviceProvisioningConfigApplied() {
6484 try {
6485 return mService.isDeviceProvisioningConfigApplied();
6486 } catch (RemoteException re) {
6487 throw re.rethrowFromSystemServer();
6488 }
6489 }
6490
Benjamin Franzbc33c822016-04-15 08:57:52 +01006491 private void throwIfParentInstance(String functionName) {
6492 if (mParentInstance) {
6493 throw new SecurityException(functionName + " cannot be called on the parent instance");
6494 }
6495 }
Dianne Hackbornd6847842010-01-12 18:14:19 -08006496}