blob: f78ed1e032b71d3257a1fff72b0951ada6a5d079 [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 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001279 * Called by an application that is administering the device to set the password restrictions it
1280 * is imposing. After setting this, the user will not be able to enter a new password that is
1281 * not at least as restrictive as what has been set. Note that the current password will remain
1282 * until the user has set a new one, so the change does not take place immediately. To prompt
1283 * the user for a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
Esteban Talaverac1c83592016-02-17 17:56:15 +00001284 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after calling this method.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001285 * <p>
1286 * Quality constants are ordered so that higher values are more restrictive; thus the highest
1287 * requested quality constant (between the policy set here, the user's preference, and any other
1288 * considerations) is the one that is in effect.
1289 * <p>
1290 * The calling device admin must have requested
1291 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1292 * not, a security exception will be thrown.
1293 * <p>
1294 * This method can be called on the {@link DevicePolicyManager} instance returned by
1295 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1296 * profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00001297 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08001298 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001299 * @param quality The new desired quality. One of {@link #PASSWORD_QUALITY_UNSPECIFIED},
1300 * {@link #PASSWORD_QUALITY_SOMETHING}, {@link #PASSWORD_QUALITY_NUMERIC},
1301 * {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX}, {@link #PASSWORD_QUALITY_ALPHABETIC},
1302 * {@link #PASSWORD_QUALITY_ALPHANUMERIC} or {@link #PASSWORD_QUALITY_COMPLEX}.
1303 * @throws SecurityException if {@code admin} is not an active administrator or if {@code admin}
1304 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Dianne Hackbornd6847842010-01-12 18:14:19 -08001305 */
Robin Lee25e26452015-06-02 09:56:29 -07001306 public void setPasswordQuality(@NonNull ComponentName admin, int quality) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001307 if (mService != null) {
1308 try {
Clara Bayarri3e826ef2015-12-14 17:51:22 +00001309 mService.setPasswordQuality(admin, quality, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001310 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001311 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001312 }
1313 }
1314 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001315
Dianne Hackbornd6847842010-01-12 18:14:19 -08001316 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001317 * Retrieve the current minimum password quality for a particular admin or all admins that set
1318 * retrictions on this user and its participating profiles. Restrictions on profiles that have
1319 * a separate challenge are not taken into account.
1320 *
1321 * <p>This method can be called on the {@link DevicePolicyManager} instance
1322 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1323 * restrictions on the parent profile.
1324 *
Robin Lee25e26452015-06-02 09:56:29 -07001325 * @param admin The name of the admin component to check, or {@code null} to aggregate
Dianne Hackborn254cb442010-01-27 19:23:59 -08001326 * all admins.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001327 */
Robin Lee25e26452015-06-02 09:56:29 -07001328 public int getPasswordQuality(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001329 return getPasswordQuality(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001330 }
1331
1332 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001333 public int getPasswordQuality(@Nullable ComponentName admin, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001334 if (mService != null) {
1335 try {
Clara Bayarri3e826ef2015-12-14 17:51:22 +00001336 return mService.getPasswordQuality(admin, userHandle, 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 }
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001341 return PASSWORD_QUALITY_UNSPECIFIED;
Dianne Hackbornd6847842010-01-12 18:14:19 -08001342 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001343
Dianne Hackbornd6847842010-01-12 18:14:19 -08001344 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001345 * Called by an application that is administering the device to set the minimum allowed password
1346 * length. After setting this, the user will not be able to enter a new password that is not at
1347 * least as restrictive as what has been set. Note that the current password will remain until
1348 * the user has set a new one, so the change does not take place immediately. To prompt the user
1349 * for a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
1350 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This constraint is
1351 * only imposed if the administrator has also requested either {@link #PASSWORD_QUALITY_NUMERIC}
1352 * , {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX}, {@link #PASSWORD_QUALITY_ALPHABETIC},
1353 * {@link #PASSWORD_QUALITY_ALPHANUMERIC}, or {@link #PASSWORD_QUALITY_COMPLEX} with
1354 * {@link #setPasswordQuality}.
1355 * <p>
1356 * The calling device admin must have requested
1357 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1358 * not, a security exception will be thrown.
1359 * <p>
1360 * This method can be called on the {@link DevicePolicyManager} instance returned by
1361 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1362 * profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00001363 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08001364 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001365 * @param length The new desired minimum password length. A value of 0 means there is no
1366 * restriction.
1367 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1368 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Dianne Hackbornd6847842010-01-12 18:14:19 -08001369 */
Robin Lee25e26452015-06-02 09:56:29 -07001370 public void setPasswordMinimumLength(@NonNull ComponentName admin, int length) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001371 if (mService != null) {
1372 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001373 mService.setPasswordMinimumLength(admin, length, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001374 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001375 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001376 }
1377 }
1378 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001379
Dianne Hackbornd6847842010-01-12 18:14:19 -08001380 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001381 * Retrieve the current minimum password length for a particular admin or all admins that set
1382 * retrictions on this user and its participating profiles. Restrictions on profiles that have
1383 * a separate challenge are not taken into account.
1384 *
1385 * <p>This method can be called on the {@link DevicePolicyManager} instance
1386 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1387 * restrictions on the parent profile.
1388 *
Jessica Hummel91da58d2014-04-10 17:39:43 +01001389 * user and its profiles or a particular one.
Robin Lee25e26452015-06-02 09:56:29 -07001390 * @param admin The name of the admin component to check, or {@code null} to aggregate
Dianne Hackborn254cb442010-01-27 19:23:59 -08001391 * all admins.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001392 */
Robin Lee25e26452015-06-02 09:56:29 -07001393 public int getPasswordMinimumLength(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001394 return getPasswordMinimumLength(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001395 }
1396
1397 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001398 public int getPasswordMinimumLength(@Nullable ComponentName admin, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001399 if (mService != null) {
1400 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001401 return mService.getPasswordMinimumLength(admin, userHandle, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001402 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001403 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001404 }
1405 }
1406 return 0;
1407 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001408
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001409 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001410 * Called by an application that is administering the device to set the minimum number of upper
1411 * case letters required in the password. After setting this, the user will not be able to enter
1412 * a new password that is not at least as restrictive as what has been set. Note that the
1413 * current password will remain until the user has set a new one, so the change does not take
1414 * place immediately. To prompt the user for a new password, use
1415 * {@link #ACTION_SET_NEW_PASSWORD} or {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after
1416 * setting this value. This constraint is only imposed if the administrator has also requested
1417 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The default value is 0.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001418 * <p>
1419 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001420 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1421 * not, a security exception will be thrown.
1422 * <p>
1423 * This method can be called on the {@link DevicePolicyManager} instance returned by
1424 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1425 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001426 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001427 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1428 * @param length The new desired minimum number of upper case letters required in the password.
1429 * A value of 0 means there is no restriction.
1430 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1431 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001432 */
Robin Lee25e26452015-06-02 09:56:29 -07001433 public void setPasswordMinimumUpperCase(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001434 if (mService != null) {
1435 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001436 mService.setPasswordMinimumUpperCase(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001437 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001438 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001439 }
1440 }
1441 }
1442
1443 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001444 * Retrieve the current number of upper case letters required in the password
1445 * for a particular admin or all admins that set retrictions on this user and
1446 * its participating profiles. Restrictions on profiles that have a separate challenge
1447 * are not taken into account.
Jessica Hummel91da58d2014-04-10 17:39:43 +01001448 * This is the same value as set by
Esteban Talaverac1c83592016-02-17 17:56:15 +00001449 * {@link #setPasswordMinimumUpperCase(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001450 * and only applies when the password quality is
1451 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001452 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001453 * <p>This method can be called on the {@link DevicePolicyManager} instance
1454 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1455 * restrictions on the parent profile.
1456 *
Robin Lee25e26452015-06-02 09:56:29 -07001457 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001458 * aggregate all admins.
1459 * @return The minimum number of upper case letters required in the
1460 * password.
1461 */
Robin Lee25e26452015-06-02 09:56:29 -07001462 public int getPasswordMinimumUpperCase(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001463 return getPasswordMinimumUpperCase(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001464 }
1465
1466 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001467 public int getPasswordMinimumUpperCase(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001468 if (mService != null) {
1469 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001470 return mService.getPasswordMinimumUpperCase(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001471 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001472 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001473 }
1474 }
1475 return 0;
1476 }
1477
1478 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001479 * Called by an application that is administering the device to set the minimum number of lower
1480 * case letters required in the password. After setting this, the user will not be able to enter
1481 * a new password that is not at least as restrictive as what has been set. Note that the
1482 * current password will remain until the user has set a new one, so the change does not take
1483 * place immediately. To prompt the user for a new password, use
1484 * {@link #ACTION_SET_NEW_PASSWORD} or {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after
1485 * setting this value. This constraint is only imposed if the administrator has also requested
1486 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The default value is 0.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001487 * <p>
1488 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001489 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1490 * not, a security exception will be thrown.
1491 * <p>
1492 * This method can be called on the {@link DevicePolicyManager} instance returned by
1493 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1494 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001495 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001496 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1497 * @param length The new desired minimum number of lower case letters required in the password.
1498 * A value of 0 means there is no restriction.
1499 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1500 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001501 */
Robin Lee25e26452015-06-02 09:56:29 -07001502 public void setPasswordMinimumLowerCase(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001503 if (mService != null) {
1504 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001505 mService.setPasswordMinimumLowerCase(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001506 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001507 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001508 }
1509 }
1510 }
1511
1512 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001513 * Retrieve the current number of lower case letters required in the password
1514 * for a particular admin or all admins that set retrictions on this user
1515 * and its participating profiles. Restrictions on profiles that have
1516 * a separate challenge are not taken into account.
Jessica Hummel91da58d2014-04-10 17:39:43 +01001517 * This is the same value as set by
Esteban Talaverac1c83592016-02-17 17:56:15 +00001518 * {@link #setPasswordMinimumLowerCase(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001519 * and only applies when the password quality is
1520 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001521 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001522 * <p>This method can be called on the {@link DevicePolicyManager} instance
1523 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1524 * restrictions on the parent profile.
1525 *
Robin Lee25e26452015-06-02 09:56:29 -07001526 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001527 * aggregate all admins.
1528 * @return The minimum number of lower case letters required in the
1529 * password.
1530 */
Robin Lee25e26452015-06-02 09:56:29 -07001531 public int getPasswordMinimumLowerCase(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001532 return getPasswordMinimumLowerCase(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001533 }
1534
1535 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001536 public int getPasswordMinimumLowerCase(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001537 if (mService != null) {
1538 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001539 return mService.getPasswordMinimumLowerCase(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001540 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001541 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001542 }
1543 }
1544 return 0;
1545 }
1546
1547 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001548 * Called by an application that is administering the device to set the minimum number of
1549 * letters required in the password. After setting this, the user will not be able to enter a
1550 * new password that is not at least as restrictive as what has been set. Note that the current
1551 * password will remain until the user has set a new one, so the change does not take place
1552 * immediately. To prompt the user for a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
1553 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This constraint is
1554 * only imposed if the administrator has also requested {@link #PASSWORD_QUALITY_COMPLEX} with
1555 * {@link #setPasswordQuality}. The default value is 1.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001556 * <p>
1557 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001558 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1559 * not, a security exception will be thrown.
1560 * <p>
1561 * This method can be called on the {@link DevicePolicyManager} instance returned by
1562 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1563 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001564 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001565 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1566 * @param length The new desired minimum number of letters required in the password. A value of
1567 * 0 means there is no restriction.
1568 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1569 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001570 */
Robin Lee25e26452015-06-02 09:56:29 -07001571 public void setPasswordMinimumLetters(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001572 if (mService != null) {
1573 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001574 mService.setPasswordMinimumLetters(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001575 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001576 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001577 }
1578 }
1579 }
1580
1581 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001582 * Retrieve the current number of letters required in the password
1583 * for a particular admin or all admins that set retrictions on this user
1584 * and its participating profiles. Restrictions on profiles that have
1585 * a separate challenge are not taken into account.
1586 * This is the same value as set by
1587 * {@link #setPasswordMinimumLetters(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001588 * and only applies when the password quality is
1589 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001590 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001591 * <p>This method can be called on the {@link DevicePolicyManager} instance
1592 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1593 * restrictions on the parent profile.
1594 *
Robin Lee25e26452015-06-02 09:56:29 -07001595 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001596 * aggregate all admins.
1597 * @return The minimum number of letters required in the password.
1598 */
Robin Lee25e26452015-06-02 09:56:29 -07001599 public int getPasswordMinimumLetters(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001600 return getPasswordMinimumLetters(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001601 }
1602
1603 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001604 public int getPasswordMinimumLetters(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001605 if (mService != null) {
1606 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001607 return mService.getPasswordMinimumLetters(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001608 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001609 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001610 }
1611 }
1612 return 0;
1613 }
1614
1615 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001616 * Called by an application that is administering the device to set the minimum number of
1617 * numerical digits required in the password. After setting this, the user will not be able to
1618 * enter a new password that is not at least as restrictive as what has been set. Note that the
1619 * current password will remain until the user has set a new one, so the change does not take
1620 * place immediately. To prompt the user for a new password, use
1621 * {@link #ACTION_SET_NEW_PASSWORD} or {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after
1622 * setting this value. This constraint is only imposed if the administrator has also requested
1623 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The default value is 1.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001624 * <p>
1625 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001626 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1627 * not, a security exception will be thrown.
1628 * <p>
1629 * This method can be called on the {@link DevicePolicyManager} instance returned by
1630 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1631 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001632 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001633 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1634 * @param length The new desired minimum number of numerical digits required in the password. A
1635 * value of 0 means there is no restriction.
1636 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1637 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001638 */
Robin Lee25e26452015-06-02 09:56:29 -07001639 public void setPasswordMinimumNumeric(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001640 if (mService != null) {
1641 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001642 mService.setPasswordMinimumNumeric(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001643 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001644 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001645 }
1646 }
1647 }
1648
1649 /**
1650 * Retrieve the current number of numerical digits required in the password
Esteban Talaverac1c83592016-02-17 17:56:15 +00001651 * for a particular admin or all admins that set retrictions on this user
1652 * and its participating profiles. Restrictions on profiles that have
1653 * a separate challenge are not taken into account.
Jessica Hummel91da58d2014-04-10 17:39:43 +01001654 * This is the same value as set by
Esteban Talaverac1c83592016-02-17 17:56:15 +00001655 * {@link #setPasswordMinimumNumeric(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001656 * and only applies when the password quality is
1657 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001658 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001659 * <p>This method can be called on the {@link DevicePolicyManager} instance
1660 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1661 * restrictions on the parent profile.
1662 *
Robin Lee25e26452015-06-02 09:56:29 -07001663 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001664 * aggregate all admins.
1665 * @return The minimum number of numerical digits required in the password.
1666 */
Robin Lee25e26452015-06-02 09:56:29 -07001667 public int getPasswordMinimumNumeric(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001668 return getPasswordMinimumNumeric(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001669 }
1670
1671 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001672 public int getPasswordMinimumNumeric(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001673 if (mService != null) {
1674 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001675 return mService.getPasswordMinimumNumeric(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001676 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001677 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001678 }
1679 }
1680 return 0;
1681 }
1682
1683 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001684 * Called by an application that is administering the device to set the minimum number of
1685 * symbols required in the password. After setting this, the user will not be able to enter a
1686 * new password that is not at least as restrictive as what has been set. Note that the current
1687 * password will remain until the user has set a new one, so the change does not take place
1688 * immediately. To prompt the user for a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
1689 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This constraint is
1690 * only imposed if the administrator has also requested {@link #PASSWORD_QUALITY_COMPLEX} with
1691 * {@link #setPasswordQuality}. The default value is 1.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001692 * <p>
1693 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001694 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1695 * not, a security exception will be thrown.
1696 * <p>
1697 * This method can be called on the {@link DevicePolicyManager} instance returned by
1698 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1699 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001700 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001701 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1702 * @param length The new desired minimum number of symbols required in the password. A value of
1703 * 0 means there is no restriction.
1704 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1705 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001706 */
Robin Lee25e26452015-06-02 09:56:29 -07001707 public void setPasswordMinimumSymbols(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001708 if (mService != null) {
1709 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001710 mService.setPasswordMinimumSymbols(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001711 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001712 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001713 }
1714 }
1715 }
1716
1717 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001718 * Retrieve the current number of symbols required in the password
1719 * for a particular admin or all admins that set retrictions on this user
1720 * and its participating profiles. Restrictions on profiles that have
1721 * a separate challenge are not taken into account. This is the same value as
1722 * set by {@link #setPasswordMinimumSymbols(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001723 * and only applies when the password quality is
1724 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001725 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001726 * <p>This method can be called on the {@link DevicePolicyManager} instance
1727 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1728 * restrictions on the parent profile.
1729 *
Robin Lee25e26452015-06-02 09:56:29 -07001730 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001731 * aggregate all admins.
1732 * @return The minimum number of symbols required in the password.
1733 */
Robin Lee25e26452015-06-02 09:56:29 -07001734 public int getPasswordMinimumSymbols(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001735 return getPasswordMinimumSymbols(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001736 }
1737
1738 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001739 public int getPasswordMinimumSymbols(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001740 if (mService != null) {
1741 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001742 return mService.getPasswordMinimumSymbols(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001743 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001744 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001745 }
1746 }
1747 return 0;
1748 }
1749
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001750 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001751 * Called by an application that is administering the device to set the minimum number of
1752 * non-letter characters (numerical digits or symbols) required in the password. After setting
1753 * this, the user will not be able to enter a new password that is not at least as restrictive
1754 * as what has been set. Note that the current password will remain until the user has set a new
1755 * one, so the change does not take place immediately. To prompt the user for a new password,
1756 * use {@link #ACTION_SET_NEW_PASSWORD} or {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after
1757 * setting this value. This constraint is only imposed if the administrator has also requested
1758 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The default value is 0.
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001759 * <p>
1760 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001761 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1762 * not, a security exception will be thrown.
1763 * <p>
1764 * This method can be called on the {@link DevicePolicyManager} instance returned by
1765 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1766 * profile.
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001767 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001768 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1769 * @param length The new desired minimum number of letters required in the password. A value of
1770 * 0 means there is no restriction.
1771 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1772 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001773 */
Robin Lee25e26452015-06-02 09:56:29 -07001774 public void setPasswordMinimumNonLetter(@NonNull ComponentName admin, int length) {
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001775 if (mService != null) {
1776 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001777 mService.setPasswordMinimumNonLetter(admin, length, mParentInstance);
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001778 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001779 throw e.rethrowFromSystemServer();
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001780 }
1781 }
1782 }
1783
1784 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001785 * Retrieve the current number of non-letter characters required in the password
1786 * for a particular admin or all admins that set retrictions on this user
1787 * and its participating profiles. Restrictions on profiles that have
1788 * a separate challenge are not taken into account.
Jessica Hummel91da58d2014-04-10 17:39:43 +01001789 * This is the same value as set by
Esteban Talaverac1c83592016-02-17 17:56:15 +00001790 * {@link #setPasswordMinimumNonLetter(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001791 * and only applies when the password quality is
1792 * {@link #PASSWORD_QUALITY_COMPLEX}.
1793 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001794 * <p>This method can be called on the {@link DevicePolicyManager} instance
1795 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1796 * restrictions on the parent profile.
1797 *
Robin Lee25e26452015-06-02 09:56:29 -07001798 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001799 * aggregate all admins.
1800 * @return The minimum number of letters required in the password.
1801 */
Robin Lee25e26452015-06-02 09:56:29 -07001802 public int getPasswordMinimumNonLetter(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001803 return getPasswordMinimumNonLetter(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001804 }
1805
1806 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001807 public int getPasswordMinimumNonLetter(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001808 if (mService != null) {
1809 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001810 return mService.getPasswordMinimumNonLetter(admin, userHandle, mParentInstance);
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001811 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001812 throw e.rethrowFromSystemServer();
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001813 }
1814 }
1815 return 0;
1816 }
1817
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001818 /**
1819 * Called by an application that is administering the device to set the length of the password
1820 * history. After setting this, the user will not be able to enter a new password that is the
1821 * same as any password in the history. Note that the current password will remain until the
1822 * user has set a new one, so the change does not take place immediately. To prompt the user for
1823 * a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
1824 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This constraint is
1825 * only imposed if the administrator has also requested either {@link #PASSWORD_QUALITY_NUMERIC}
1826 * , {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX} {@link #PASSWORD_QUALITY_ALPHABETIC}, or
1827 * {@link #PASSWORD_QUALITY_ALPHANUMERIC} with {@link #setPasswordQuality}.
1828 * <p>
1829 * The calling device admin must have requested
1830 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1831 * not, a security exception will be thrown.
1832 * <p>
1833 * This method can be called on the {@link DevicePolicyManager} instance returned by
1834 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1835 * profile.
1836 *
1837 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1838 * @param length The new desired length of password history. A value of 0 means there is no
1839 * restriction.
1840 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1841 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
1842 */
Robin Lee25e26452015-06-02 09:56:29 -07001843 public void setPasswordHistoryLength(@NonNull ComponentName admin, int length) {
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001844 if (mService != null) {
1845 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001846 mService.setPasswordHistoryLength(admin, length, mParentInstance);
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001847 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001848 throw e.rethrowFromSystemServer();
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001849 }
1850 }
1851 }
1852
1853 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001854 * Called by a device admin to set the password expiration timeout. Calling this method will
1855 * restart the countdown for password expiration for the given admin, as will changing the
1856 * device password (for all admins).
1857 * <p>
1858 * The provided timeout is the time delta in ms and will be added to the current time. For
1859 * example, to have the password expire 5 days from now, timeout would be 5 * 86400 * 1000 =
1860 * 432000000 ms for timeout.
1861 * <p>
1862 * To disable password expiration, a value of 0 may be used for timeout.
1863 * <p>
1864 * The calling device admin must have requested
1865 * {@link DeviceAdminInfo#USES_POLICY_EXPIRE_PASSWORD} to be able to call this method; if it has
1866 * not, a security exception will be thrown.
1867 * <p>
1868 * Note that setting the password will automatically reset the expiration time for all active
1869 * admins. Active admins do not need to explicitly call this method in that case.
1870 * <p>
1871 * This method can be called on the {@link DevicePolicyManager} instance returned by
1872 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1873 * profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00001874 *
Jim Millera4e28d12010-11-08 16:15:47 -08001875 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001876 * @param timeout The limit (in ms) that a password can remain in effect. A value of 0 means
1877 * there is no restriction (unlimited).
1878 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1879 * does not use {@link DeviceAdminInfo#USES_POLICY_EXPIRE_PASSWORD}
Jim Millera4e28d12010-11-08 16:15:47 -08001880 */
Robin Lee25e26452015-06-02 09:56:29 -07001881 public void setPasswordExpirationTimeout(@NonNull ComponentName admin, long timeout) {
Jim Millera4e28d12010-11-08 16:15:47 -08001882 if (mService != null) {
1883 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001884 mService.setPasswordExpirationTimeout(admin, timeout, mParentInstance);
Jim Millera4e28d12010-11-08 16:15:47 -08001885 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001886 throw e.rethrowFromSystemServer();
Jim Millera4e28d12010-11-08 16:15:47 -08001887 }
1888 }
1889 }
1890
1891 /**
Jim Miller6b857682011-02-16 16:27:41 -08001892 * Get the password expiration timeout for the given admin. The expiration timeout is the
1893 * recurring expiration timeout provided in the call to
1894 * {@link #setPasswordExpirationTimeout(ComponentName, long)} for the given admin or the
Esteban Talaverac1c83592016-02-17 17:56:15 +00001895 * aggregate of all participating policy administrators if {@code admin} is null. Admins that
1896 * have set restrictions on profiles that have a separate challenge are not taken into account.
1897 *
1898 * <p>This method can be called on the {@link DevicePolicyManager} instance
1899 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1900 * restrictions on the parent profile.
Jim Millera4e28d12010-11-08 16:15:47 -08001901 *
Robin Lee25e26452015-06-02 09:56:29 -07001902 * @param admin The name of the admin component to check, or {@code null} to aggregate all admins.
Jim Millera4e28d12010-11-08 16:15:47 -08001903 * @return The timeout for the given admin or the minimum of all timeouts
1904 */
Robin Lee25e26452015-06-02 09:56:29 -07001905 public long getPasswordExpirationTimeout(@Nullable ComponentName admin) {
Jim Millera4e28d12010-11-08 16:15:47 -08001906 if (mService != null) {
1907 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001908 return mService.getPasswordExpirationTimeout(admin, myUserId(), mParentInstance);
Jim Millera4e28d12010-11-08 16:15:47 -08001909 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001910 throw e.rethrowFromSystemServer();
Jim Millera4e28d12010-11-08 16:15:47 -08001911 }
1912 }
1913 return 0;
1914 }
1915
1916 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001917 * Get the current password expiration time for a particular admin or all admins that set
1918 * retrictions on this user and its participating profiles. Restrictions on profiles that have
1919 * a separate challenge are not taken into account. If admin is {@code null}, then a composite
1920 * of all expiration times is returned - which will be the minimum of all of them.
1921 *
1922 * <p>This method can be called on the {@link DevicePolicyManager} instance
1923 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1924 * the password expiration for the parent profile.
Jim Millera4e28d12010-11-08 16:15:47 -08001925 *
Robin Lee25e26452015-06-02 09:56:29 -07001926 * @param admin The name of the admin component to check, or {@code null} to aggregate all admins.
Esteban Talaverac1c83592016-02-17 17:56:15 +00001927 * @return The password expiration time, in milliseconds since epoch.
Jim Millera4e28d12010-11-08 16:15:47 -08001928 */
Robin Lee25e26452015-06-02 09:56:29 -07001929 public long getPasswordExpiration(@Nullable ComponentName admin) {
Jim Millera4e28d12010-11-08 16:15:47 -08001930 if (mService != null) {
1931 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001932 return mService.getPasswordExpiration(admin, myUserId(), mParentInstance);
Jim Millera4e28d12010-11-08 16:15:47 -08001933 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001934 throw e.rethrowFromSystemServer();
Jim Millera4e28d12010-11-08 16:15:47 -08001935 }
1936 }
1937 return 0;
1938 }
1939
1940 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001941 * Retrieve the current password history length for a particular admin or all admins that
1942 * set retrictions on this user and its participating profiles. Restrictions on profiles that
1943 * have a separate challenge are not taken into account.
1944 *
1945 * <p>This method can be called on the {@link DevicePolicyManager} instance
1946 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1947 * restrictions on the parent profile.
1948 *
Robin Lee25e26452015-06-02 09:56:29 -07001949 * @param admin The name of the admin component to check, or {@code null} to aggregate
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001950 * all admins.
1951 * @return The length of the password history
1952 */
Robin Lee25e26452015-06-02 09:56:29 -07001953 public int getPasswordHistoryLength(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001954 return getPasswordHistoryLength(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001955 }
1956
1957 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001958 public int getPasswordHistoryLength(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001959 if (mService != null) {
1960 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001961 return mService.getPasswordHistoryLength(admin, userHandle, mParentInstance);
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001962 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001963 throw e.rethrowFromSystemServer();
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001964 }
1965 }
1966 return 0;
1967 }
1968
Dianne Hackbornd6847842010-01-12 18:14:19 -08001969 /**
Dianne Hackborn254cb442010-01-27 19:23:59 -08001970 * Return the maximum password length that the device supports for a
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001971 * particular password quality.
Dianne Hackborn364f6e32010-01-29 17:38:20 -08001972 * @param quality The quality being interrogated.
Dianne Hackborn254cb442010-01-27 19:23:59 -08001973 * @return Returns the maximum length that the user can enter.
1974 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001975 public int getPasswordMaximumLength(int quality) {
Dianne Hackborn254cb442010-01-27 19:23:59 -08001976 // Kind-of arbitrary.
1977 return 16;
1978 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001979
Dianne Hackborn254cb442010-01-27 19:23:59 -08001980 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001981 * Determine whether the current password the user has set is sufficient to meet the policy
1982 * requirements (e.g. quality, minimum length) that have been requested by the admins of this
1983 * user and its participating profiles. Restrictions on profiles that have a separate challenge
1984 * are not taken into account.
1985 * <p>
1986 * The calling device admin must have requested
1987 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1988 * not, a security exception will be thrown.
1989 * <p>
1990 * This method can be called on the {@link DevicePolicyManager} instance returned by
1991 * {@link #getParentProfileInstance(ComponentName)} in order to determine if the password set on
1992 * the parent profile is sufficient.
Esteban Talaverac1c83592016-02-17 17:56:15 +00001993 *
Jessica Hummel91da58d2014-04-10 17:39:43 +01001994 * @return Returns true if the password meets the current requirements, else false.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001995 * @throws SecurityException if the calling application does not own an active administrator
1996 * that uses {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Dianne Hackbornd6847842010-01-12 18:14:19 -08001997 */
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001998 public boolean isActivePasswordSufficient() {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001999 if (mService != null) {
2000 try {
Clara Bayarri3e826ef2015-12-14 17:51:22 +00002001 return mService.isActivePasswordSufficient(myUserId(), mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002002 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002003 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08002004 }
2005 }
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002006 return false;
Dianne Hackbornd6847842010-01-12 18:14:19 -08002007 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002008
Dianne Hackbornd6847842010-01-12 18:14:19 -08002009 /**
Clara Bayarrid7693912016-01-22 17:26:31 +00002010 * Determine whether the current profile password the user has set is sufficient
Esteban Talaverac1c83592016-02-17 17:56:15 +00002011 * to meet the policy requirements (e.g. quality, minimum length) that have been
Clara Bayarrid7693912016-01-22 17:26:31 +00002012 * requested by the admins of the parent user and its profiles.
2013 *
2014 * @param userHandle the userId of the profile to check the password for.
2015 * @return Returns true if the password would meet the current requirements, else false.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002016 * @throws SecurityException if {@code userHandle} is not a managed profile.
Clara Bayarrid7693912016-01-22 17:26:31 +00002017 * @hide
2018 */
2019 public boolean isProfileActivePasswordSufficientForParent(int userHandle) {
2020 if (mService != null) {
2021 try {
2022 return mService.isProfileActivePasswordSufficientForParent(userHandle);
2023 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002024 throw e.rethrowFromSystemServer();
Clara Bayarrid7693912016-01-22 17:26:31 +00002025 }
2026 }
2027 return false;
2028 }
2029
2030 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002031 * Retrieve the number of times the user has failed at entering a password since that last
2032 * successful password entry.
2033 * <p>
2034 * This method can be called on the {@link DevicePolicyManager} instance returned by
2035 * {@link #getParentProfileInstance(ComponentName)} in order to retrieve the number of failed
2036 * password attemts for the parent user.
2037 * <p>
2038 * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN}
2039 * to be able to call this method; if it has not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002040 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002041 * @return The number of times user has entered an incorrect password since the last correct
2042 * password entry.
2043 * @throws SecurityException if the calling application does not own an active administrator
2044 * that uses {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN}
Dianne Hackbornd6847842010-01-12 18:14:19 -08002045 */
2046 public int getCurrentFailedPasswordAttempts() {
Clara Bayarri51e41ad2016-02-11 17:48:53 +00002047 return getCurrentFailedPasswordAttempts(myUserId());
2048 }
2049
2050 /**
2051 * Retrieve the number of times the given user has failed at entering a
2052 * password since that last successful password entry.
2053 *
2054 * <p>The calling device admin must have requested
2055 * {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} to be able to call this method; if it has
2056 * not and it is not the system uid, a security exception will be thrown.
2057 *
2058 * @hide
2059 */
2060 public int getCurrentFailedPasswordAttempts(int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08002061 if (mService != null) {
2062 try {
Clara Bayarri51e41ad2016-02-11 17:48:53 +00002063 return mService.getCurrentFailedPasswordAttempts(userHandle, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002064 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002065 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08002066 }
2067 }
2068 return -1;
2069 }
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002070
2071 /**
Craig Lafayette4e401fa2015-05-07 10:24:02 -04002072 * Queries whether {@link #RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT} flag is set.
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002073 *
Craig Lafayette4e401fa2015-05-07 10:24:02 -04002074 * @return true if RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT flag is set.
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002075 * @hide
2076 */
2077 public boolean getDoNotAskCredentialsOnBoot() {
2078 if (mService != null) {
2079 try {
2080 return mService.getDoNotAskCredentialsOnBoot();
2081 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002082 throw e.rethrowFromSystemServer();
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002083 }
2084 }
2085 return false;
2086 }
2087
2088 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002089 * Setting this to a value greater than zero enables a built-in policy that will perform a
2090 * device or profile wipe after too many incorrect device-unlock passwords have been entered.
2091 * This built-in policy combines watching for failed passwords and wiping the device, and
2092 * requires that you request both {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} and
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002093 * {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA}}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002094 * <p>
2095 * To implement any other policy (e.g. wiping data for a particular application only, erasing or
2096 * revoking credentials, or reporting the failure to a server), you should implement
2097 * {@link DeviceAdminReceiver#onPasswordFailed(Context, android.content.Intent)} instead. Do not
2098 * use this API, because if the maximum count is reached, the device or profile will be wiped
2099 * immediately, and your callback will not be invoked.
2100 * <p>
2101 * This method can be called on the {@link DevicePolicyManager} instance returned by
2102 * {@link #getParentProfileInstance(ComponentName)} in order to set a value on the parent
2103 * profile.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002104 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08002105 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002106 * @param num The number of failed password attempts at which point the device or profile will
2107 * be wiped.
2108 * @throws SecurityException if {@code admin} is not an active administrator or does not use
2109 * both {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} and
2110 * {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA}.
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002111 */
Robin Lee25e26452015-06-02 09:56:29 -07002112 public void setMaximumFailedPasswordsForWipe(@NonNull ComponentName admin, int num) {
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002113 if (mService != null) {
2114 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002115 mService.setMaximumFailedPasswordsForWipe(admin, num, mParentInstance);
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002116 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002117 throw e.rethrowFromSystemServer();
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002118 }
2119 }
2120 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002121
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002122 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00002123 * Retrieve the current maximum number of login attempts that are allowed before the device
2124 * or profile is wiped, for a particular admin or all admins that set retrictions on this user
2125 * and its participating profiles. Restrictions on profiles that have a separate challenge are
2126 * not taken into account.
2127 *
2128 * <p>This method can be called on the {@link DevicePolicyManager} instance
2129 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
2130 * the value for the parent profile.
2131 *
Robin Lee25e26452015-06-02 09:56:29 -07002132 * @param admin The name of the admin component to check, or {@code null} to aggregate
Dianne Hackborn254cb442010-01-27 19:23:59 -08002133 * all admins.
2134 */
Robin Lee25e26452015-06-02 09:56:29 -07002135 public int getMaximumFailedPasswordsForWipe(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002136 return getMaximumFailedPasswordsForWipe(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002137 }
2138
2139 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07002140 public int getMaximumFailedPasswordsForWipe(@Nullable ComponentName admin, int userHandle) {
Dianne Hackborn254cb442010-01-27 19:23:59 -08002141 if (mService != null) {
2142 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002143 return mService.getMaximumFailedPasswordsForWipe(
2144 admin, userHandle, mParentInstance);
Dianne Hackborn254cb442010-01-27 19:23:59 -08002145 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002146 throw e.rethrowFromSystemServer();
Dianne Hackborn254cb442010-01-27 19:23:59 -08002147 }
2148 }
2149 return 0;
2150 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002151
Dianne Hackborn254cb442010-01-27 19:23:59 -08002152 /**
Amith Yamasani3a3d2122014-10-29 11:41:31 -07002153 * Returns the profile with the smallest maximum failed passwords for wipe,
2154 * for the given user. So for primary user, it might return the primary or
2155 * a managed profile. For a secondary user, it would be the same as the
2156 * user passed in.
2157 * @hide Used only by Keyguard
2158 */
2159 public int getProfileWithMinimumFailedPasswordsForWipe(int userHandle) {
2160 if (mService != null) {
2161 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002162 return mService.getProfileWithMinimumFailedPasswordsForWipe(
2163 userHandle, mParentInstance);
Amith Yamasani3a3d2122014-10-29 11:41:31 -07002164 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002165 throw e.rethrowFromSystemServer();
Amith Yamasani3a3d2122014-10-29 11:41:31 -07002166 }
2167 }
2168 return UserHandle.USER_NULL;
2169 }
2170
2171 /**
Dianne Hackborn87bba1e2010-02-26 17:25:54 -08002172 * Flag for {@link #resetPassword}: don't allow other admins to change
2173 * the password again until the user has entered it.
2174 */
2175 public static final int RESET_PASSWORD_REQUIRE_ENTRY = 0x0001;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002176
Dianne Hackborn87bba1e2010-02-26 17:25:54 -08002177 /**
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002178 * Flag for {@link #resetPassword}: don't ask for user credentials on device boot.
2179 * If the flag is set, the device can be booted without asking for user password.
2180 * The absence of this flag does not change the current boot requirements. This flag
2181 * can be set by the device owner only. If the app is not the device owner, the flag
2182 * is ignored. Once the flag is set, it cannot be reverted back without resetting the
2183 * device to factory defaults.
2184 */
Craig Lafayette4e401fa2015-05-07 10:24:02 -04002185 public static final int RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT = 0x0002;
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002186
2187 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002188 * Force a new device unlock password (the password needed to access the entire device, not for
2189 * individual accounts) on the user. This takes effect immediately.
2190 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002191 * <em>Note: This API has been limited as of {@link android.os.Build.VERSION_CODES#N} for
Makoto Onuki70f929e2015-11-11 12:40:15 -08002192 * device admins that are not device owner and not profile owner.
2193 * The password can now only be changed if there is currently no password set. Device owner
2194 * and profile owner can still do this.</em>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002195 * <p>
2196 * The given password must be sufficient for the current password quality and length constraints
2197 * as returned by {@link #getPasswordQuality(ComponentName)} and
2198 * {@link #getPasswordMinimumLength(ComponentName)}; if it does not meet these constraints, then
2199 * it will be rejected and false returned. Note that the password may be a stronger quality
2200 * (containing alphanumeric characters when the requested quality is only numeric), in which
2201 * case the currently active quality will be increased to match.
2202 * <p>
2203 * Calling with a null or empty password will clear any existing PIN, pattern or password if the
Robin Leece5c4002016-03-23 17:05:03 +00002204 * current password constraints allow it. <em>Note: This will not work in
2205 * {@link android.os.Build.VERSION_CODES#N} and later for managed profiles, or for device admins
2206 * that are not device owner or profile owner. Once set, the password cannot be changed to null
2207 * or empty except by these admins.</em>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002208 * <p>
2209 * The calling device admin must have requested
2210 * {@link DeviceAdminInfo#USES_POLICY_RESET_PASSWORD} to be able to call this method; if it has
2211 * not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002212 *
Adrian Roosf8f56bc2014-11-20 23:55:34 +01002213 * @param password The new password for the user. Null or empty clears the password.
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002214 * @param flags May be 0 or combination of {@link #RESET_PASSWORD_REQUIRE_ENTRY} and
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002215 * {@link #RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT}.
2216 * @return Returns true if the password was applied, or false if it is not acceptable for the
2217 * current constraints or if the user has not been decrypted yet.
2218 * @throws SecurityException if the calling application does not own an active administrator
2219 * that uses {@link DeviceAdminInfo#USES_POLICY_RESET_PASSWORD}
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002220 */
Dianne Hackborn87bba1e2010-02-26 17:25:54 -08002221 public boolean resetPassword(String password, int flags) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002222 throwIfParentInstance("resetPassword");
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002223 if (mService != null) {
2224 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08002225 return mService.resetPassword(password, flags);
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002226 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002227 throw e.rethrowFromSystemServer();
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002228 }
2229 }
2230 return false;
2231 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002232
Dianne Hackbornd6847842010-01-12 18:14:19 -08002233 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002234 * Called by an application that is administering the device to set the maximum time for user
2235 * activity until the device will lock. This limits the length that the user can set. It takes
2236 * effect immediately.
2237 * <p>
2238 * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
2239 * to be able to call this method; if it has not, a security exception will be thrown.
2240 * <p>
2241 * This method can be called on the {@link DevicePolicyManager} instance returned by
2242 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
2243 * profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00002244 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08002245 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002246 * @param timeMs The new desired maximum time to lock in milliseconds. A value of 0 means there
2247 * is no restriction.
2248 * @throws SecurityException if {@code admin} is not an active administrator or it does not use
2249 * {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
Dianne Hackbornd6847842010-01-12 18:14:19 -08002250 */
Robin Lee25e26452015-06-02 09:56:29 -07002251 public void setMaximumTimeToLock(@NonNull ComponentName admin, long timeMs) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08002252 if (mService != null) {
2253 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002254 mService.setMaximumTimeToLock(admin, timeMs, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002255 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002256 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08002257 }
2258 }
2259 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002260
Dianne Hackbornd6847842010-01-12 18:14:19 -08002261 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00002262 * Retrieve the current maximum time to unlock for a particular admin or all admins that set
2263 * retrictions on this user and its participating profiles. Restrictions on profiles that have
2264 * a separate challenge are not taken into account.
2265 *
2266 * <p>This method can be called on the {@link DevicePolicyManager} instance
2267 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
2268 * restrictions on the parent profile.
2269 *
Robin Lee25e26452015-06-02 09:56:29 -07002270 * @param admin The name of the admin component to check, or {@code null} to aggregate
Dianne Hackborn254cb442010-01-27 19:23:59 -08002271 * all admins.
Jim Millerd4efaac2014-08-14 18:02:45 -07002272 * @return time in milliseconds for the given admin or the minimum value (strictest) of
Jim Miller76b9b8b2014-08-22 17:04:57 -07002273 * all admins if admin is null. Returns 0 if there are no restrictions.
Dianne Hackbornd6847842010-01-12 18:14:19 -08002274 */
Robin Lee25e26452015-06-02 09:56:29 -07002275 public long getMaximumTimeToLock(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002276 return getMaximumTimeToLock(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002277 }
2278
2279 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07002280 public long getMaximumTimeToLock(@Nullable ComponentName admin, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08002281 if (mService != null) {
2282 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002283 return mService.getMaximumTimeToLock(admin, userHandle, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002284 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002285 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08002286 }
2287 }
2288 return 0;
2289 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002290
Dianne Hackbornd6847842010-01-12 18:14:19 -08002291 /**
Ricky Wai035e9242016-03-18 16:43:31 +00002292 * Returns maximum time to lock that applied by all profiles in this user. We do this because we
2293 * do not have a separate timeout to lock for work challenge only.
2294 *
2295 * @hide
2296 */
2297 public long getMaximumTimeToLockForUserAndProfiles(int userHandle) {
2298 if (mService != null) {
2299 try {
2300 return mService.getMaximumTimeToLockForUserAndProfiles(userHandle);
2301 } catch (RemoteException e) {
2302 throw e.rethrowFromSystemServer();
2303 }
2304 }
2305 return 0;
2306 }
2307
2308 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002309 * Make the device lock immediately, as if the lock screen timeout has expired at the point of
2310 * this call.
2311 * <p>
2312 * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
2313 * to be able to call this method; if it has not, a security exception will be thrown.
2314 * <p>
2315 * This method can be called on the {@link DevicePolicyManager} instance returned by
2316 * {@link #getParentProfileInstance(ComponentName)} in order to lock the parent profile.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002317 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002318 * @throws SecurityException if the calling application does not own an active administrator
2319 * that uses {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
Dianne Hackbornd6847842010-01-12 18:14:19 -08002320 */
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002321 public void lockNow() {
2322 if (mService != null) {
2323 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002324 mService.lockNow(mParentInstance);
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002325 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002326 throw e.rethrowFromSystemServer();
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002327 }
2328 }
2329 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002330
Dianne Hackbornd6847842010-01-12 18:14:19 -08002331 /**
Dianne Hackborn42499172010-10-15 18:45:07 -07002332 * Flag for {@link #wipeData(int)}: also erase the device's external
Paul Crowleya7e87ac2014-11-18 13:50:19 +00002333 * storage (such as SD cards).
Dianne Hackborn42499172010-10-15 18:45:07 -07002334 */
2335 public static final int WIPE_EXTERNAL_STORAGE = 0x0001;
2336
2337 /**
Paul Crowleya7e87ac2014-11-18 13:50:19 +00002338 * Flag for {@link #wipeData(int)}: also erase the factory reset protection
2339 * data.
2340 *
Paul Crowley2934b262014-12-02 11:21:13 +00002341 * <p>This flag may only be set by device owner admins; if it is set by
2342 * other admins a {@link SecurityException} will be thrown.
Paul Crowleya7e87ac2014-11-18 13:50:19 +00002343 */
2344 public static final int WIPE_RESET_PROTECTION_DATA = 0x0002;
2345
2346 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002347 * Ask the user data be wiped. Wiping the primary user will cause the device to reboot, erasing
2348 * all user data while next booting up.
2349 * <p>
2350 * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA} to
2351 * be able to call this method; if it has not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002352 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002353 * @param flags Bit mask of additional options: currently supported flags are
2354 * {@link #WIPE_EXTERNAL_STORAGE} and {@link #WIPE_RESET_PROTECTION_DATA}.
2355 * @throws SecurityException if the calling application does not own an active administrator
2356 * that uses {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA}
Dianne Hackbornd6847842010-01-12 18:14:19 -08002357 */
2358 public void wipeData(int flags) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002359 throwIfParentInstance("wipeData");
Dianne Hackbornd6847842010-01-12 18:14:19 -08002360 if (mService != null) {
2361 try {
Makoto Onuki70f929e2015-11-11 12:40:15 -08002362 mService.wipeData(flags);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002363 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002364 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08002365 }
2366 }
2367 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002368
Dianne Hackbornd6847842010-01-12 18:14:19 -08002369 /**
Oscar Montemayor69238c62010-08-03 10:51:06 -07002370 * Called by an application that is administering the device to set the
2371 * global proxy and exclusion list.
2372 * <p>
2373 * The calling device admin must have requested
2374 * {@link DeviceAdminInfo#USES_POLICY_SETS_GLOBAL_PROXY} to be able to call
2375 * this method; if it has not, a security exception will be thrown.
2376 * Only the first device admin can set the proxy. If a second admin attempts
2377 * to set the proxy, the {@link ComponentName} of the admin originally setting the
Robin Lee25e26452015-06-02 09:56:29 -07002378 * proxy will be returned. If successful in setting the proxy, {@code null} will
Oscar Montemayor69238c62010-08-03 10:51:06 -07002379 * be returned.
2380 * The method can be called repeatedly by the device admin alrady setting the
2381 * proxy to update the proxy and exclusion list.
2382 *
Robin Lee25e26452015-06-02 09:56:29 -07002383 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Oscar Montemayor69238c62010-08-03 10:51:06 -07002384 * @param proxySpec the global proxy desired. Must be an HTTP Proxy.
2385 * Pass Proxy.NO_PROXY to reset the proxy.
2386 * @param exclusionList a list of domains to be excluded from the global proxy.
Robin Lee25e26452015-06-02 09:56:29 -07002387 * @return {@code null} if the proxy was successfully set, or otherwise a {@link ComponentName}
2388 * of the device admin that sets the proxy.
Andy Stadlerd2672722011-02-16 10:53:33 -08002389 * @hide
Oscar Montemayor69238c62010-08-03 10:51:06 -07002390 */
Robin Lee25e26452015-06-02 09:56:29 -07002391 public ComponentName setGlobalProxy(@NonNull ComponentName admin, Proxy proxySpec,
Oscar Montemayor69238c62010-08-03 10:51:06 -07002392 List<String> exclusionList ) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002393 throwIfParentInstance("setGlobalProxy");
Oscar Montemayor69238c62010-08-03 10:51:06 -07002394 if (proxySpec == null) {
2395 throw new NullPointerException();
2396 }
2397 if (mService != null) {
2398 try {
2399 String hostSpec;
2400 String exclSpec;
2401 if (proxySpec.equals(Proxy.NO_PROXY)) {
2402 hostSpec = null;
2403 exclSpec = null;
2404 } else {
2405 if (!proxySpec.type().equals(Proxy.Type.HTTP)) {
2406 throw new IllegalArgumentException();
2407 }
2408 InetSocketAddress sa = (InetSocketAddress)proxySpec.address();
2409 String hostName = sa.getHostName();
2410 int port = sa.getPort();
2411 StringBuilder hostBuilder = new StringBuilder();
2412 hostSpec = hostBuilder.append(hostName)
2413 .append(":").append(Integer.toString(port)).toString();
2414 if (exclusionList == null) {
2415 exclSpec = "";
2416 } else {
2417 StringBuilder listBuilder = new StringBuilder();
2418 boolean firstDomain = true;
2419 for (String exclDomain : exclusionList) {
2420 if (!firstDomain) {
2421 listBuilder = listBuilder.append(",");
2422 } else {
2423 firstDomain = false;
2424 }
2425 listBuilder = listBuilder.append(exclDomain.trim());
2426 }
2427 exclSpec = listBuilder.toString();
2428 }
Yuhao Zheng90704842014-02-28 17:22:45 -08002429 if (android.net.Proxy.validate(hostName, Integer.toString(port), exclSpec)
2430 != android.net.Proxy.PROXY_VALID)
2431 throw new IllegalArgumentException();
Oscar Montemayor69238c62010-08-03 10:51:06 -07002432 }
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08002433 return mService.setGlobalProxy(admin, hostSpec, exclSpec);
Oscar Montemayor69238c62010-08-03 10:51:06 -07002434 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002435 throw e.rethrowFromSystemServer();
Oscar Montemayor69238c62010-08-03 10:51:06 -07002436 }
2437 }
2438 return null;
2439 }
2440
2441 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002442 * Set a network-independent global HTTP proxy. This is not normally what you want for typical
2443 * HTTP proxies - they are generally network dependent. However if you're doing something
2444 * unusual like general internal filtering this may be useful. On a private network where the
2445 * proxy is not accessible, you may break HTTP using this.
2446 * <p>
2447 * This method requires the caller to be the device owner.
2448 * <p>
2449 * This proxy is only a recommendation and it is possible that some apps will ignore it.
Jason Monk03bc9912014-05-13 09:44:57 -04002450 *
Jason Monk03bc9912014-05-13 09:44:57 -04002451 * @see ProxyInfo
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002452 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2453 * @param proxyInfo The a {@link ProxyInfo} object defining the new global HTTP proxy. A
2454 * {@code null} value will clear the global HTTP proxy.
2455 * @throws SecurityException if {@code admin} is not the device owner.
Jason Monk03bc9912014-05-13 09:44:57 -04002456 */
Robin Lee25e26452015-06-02 09:56:29 -07002457 public void setRecommendedGlobalProxy(@NonNull ComponentName admin, @Nullable ProxyInfo
2458 proxyInfo) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002459 throwIfParentInstance("setRecommendedGlobalProxy");
Jason Monk03bc9912014-05-13 09:44:57 -04002460 if (mService != null) {
2461 try {
2462 mService.setRecommendedGlobalProxy(admin, proxyInfo);
2463 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002464 throw e.rethrowFromSystemServer();
Jason Monk03bc9912014-05-13 09:44:57 -04002465 }
2466 }
2467 }
2468
2469 /**
Oscar Montemayor69238c62010-08-03 10:51:06 -07002470 * Returns the component name setting the global proxy.
Robin Lee25e26452015-06-02 09:56:29 -07002471 * @return ComponentName object of the device admin that set the global proxy, or {@code null}
2472 * if no admin has set the proxy.
Andy Stadlerd2672722011-02-16 10:53:33 -08002473 * @hide
Oscar Montemayor69238c62010-08-03 10:51:06 -07002474 */
2475 public ComponentName getGlobalProxyAdmin() {
2476 if (mService != null) {
2477 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002478 return mService.getGlobalProxyAdmin(myUserId());
Oscar Montemayor69238c62010-08-03 10:51:06 -07002479 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002480 throw e.rethrowFromSystemServer();
Oscar Montemayor69238c62010-08-03 10:51:06 -07002481 }
2482 }
2483 return null;
2484 }
2485
2486 /**
Andy Stadler22dbfda2011-01-17 12:47:31 -08002487 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002488 * indicating that encryption is not supported.
2489 */
2490 public static final int ENCRYPTION_STATUS_UNSUPPORTED = 0;
2491
2492 /**
Andy Stadler22dbfda2011-01-17 12:47:31 -08002493 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002494 * indicating that encryption is supported, but is not currently active.
2495 */
2496 public static final int ENCRYPTION_STATUS_INACTIVE = 1;
2497
2498 /**
Robin Lee3795fb02015-02-16 14:17:23 +00002499 * Result code for {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002500 * indicating that encryption is not currently active, but is currently
2501 * being activated. This is only reported by devices that support
2502 * encryption of data and only when the storage is currently
2503 * undergoing a process of becoming encrypted. A device that must reboot and/or wipe data
2504 * to become encrypted will never return this value.
2505 */
Andy Stadler22dbfda2011-01-17 12:47:31 -08002506 public static final int ENCRYPTION_STATUS_ACTIVATING = 2;
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002507
2508 /**
Andy Stadler22dbfda2011-01-17 12:47:31 -08002509 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002510 * indicating that encryption is active.
2511 */
Andy Stadler22dbfda2011-01-17 12:47:31 -08002512 public static final int ENCRYPTION_STATUS_ACTIVE = 3;
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002513
2514 /**
Robin Lee3795fb02015-02-16 14:17:23 +00002515 * Result code for {@link #getStorageEncryptionStatus}:
2516 * indicating that encryption is active, but an encryption key has not
2517 * been set by the user.
2518 */
2519 public static final int ENCRYPTION_STATUS_ACTIVE_DEFAULT_KEY = 4;
2520
2521 /**
Makoto Onukid4c9e542016-02-25 18:17:30 -08002522 * Result code for {@link #getStorageEncryptionStatus}:
2523 * indicating that encryption is active and the encryption key is tied to the user.
2524 */
2525 public static final int ENCRYPTION_STATUS_ACTIVE_PER_USER = 5;
2526
2527 /**
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002528 * Activity action: begin the process of encrypting data on the device. This activity should
2529 * be launched after using {@link #setStorageEncryption} to request encryption be activated.
2530 * After resuming from this activity, use {@link #getStorageEncryption}
2531 * to check encryption status. However, on some devices this activity may never return, as
2532 * it may trigger a reboot and in some cases a complete data wipe of the device.
2533 */
2534 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2535 public static final String ACTION_START_ENCRYPTION
2536 = "android.app.action.START_ENCRYPTION";
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002537 /**
Jim Millerb8ec4702012-08-31 17:19:10 -07002538 * Widgets are enabled in keyguard
2539 */
Jim Miller48b9b0d2012-09-19 23:16:50 -07002540 public static final int KEYGUARD_DISABLE_FEATURES_NONE = 0;
Jim Millerb8ec4702012-08-31 17:19:10 -07002541
2542 /**
Jim Miller50e62182014-04-23 17:25:00 -07002543 * Disable all keyguard widgets. Has no effect.
Jim Millerb8ec4702012-08-31 17:19:10 -07002544 */
Jim Miller48b9b0d2012-09-19 23:16:50 -07002545 public static final int KEYGUARD_DISABLE_WIDGETS_ALL = 1 << 0;
2546
2547 /**
2548 * Disable the camera on secure keyguard screens (e.g. PIN/Pattern/Password)
2549 */
2550 public static final int KEYGUARD_DISABLE_SECURE_CAMERA = 1 << 1;
2551
2552 /**
Jim Miller50e62182014-04-23 17:25:00 -07002553 * Disable showing all notifications on secure keyguard screens (e.g. PIN/Pattern/Password)
2554 */
2555 public static final int KEYGUARD_DISABLE_SECURE_NOTIFICATIONS = 1 << 2;
2556
2557 /**
2558 * Only allow redacted notifications on secure keyguard screens (e.g. PIN/Pattern/Password)
2559 */
2560 public static final int KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS = 1 << 3;
2561
2562 /**
Adrian Roosa06d5ca2014-07-28 15:14:21 +02002563 * Ignore trust agent state on secure keyguard screens
Jim Miller50e62182014-04-23 17:25:00 -07002564 * (e.g. PIN/Pattern/Password).
2565 */
2566 public static final int KEYGUARD_DISABLE_TRUST_AGENTS = 1 << 4;
2567
2568 /**
Jim Miller06e34502014-07-17 14:46:05 -07002569 * Disable fingerprint sensor on keyguard secure screens (e.g. PIN/Pattern/Password).
2570 */
2571 public static final int KEYGUARD_DISABLE_FINGERPRINT = 1 << 5;
2572
2573 /**
Adrian Roos7f06eed2016-02-05 15:21:02 -08002574 * Disable text entry into notifications on secure keyguard screens (e.g. PIN/Pattern/Password).
2575 */
2576 public static final int KEYGUARD_DISABLE_REMOTE_INPUT = 1 << 6;
2577
2578 /**
Jim Miller35207742012-11-02 15:33:20 -07002579 * Disable all current and future keyguard customizations.
Jim Miller48b9b0d2012-09-19 23:16:50 -07002580 */
2581 public static final int KEYGUARD_DISABLE_FEATURES_ALL = 0x7fffffff;
Jim Millerb8ec4702012-08-31 17:19:10 -07002582
2583 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002584 * Called by an application that is administering the device to request that the storage system
2585 * be encrypted.
2586 * <p>
2587 * When multiple device administrators attempt to control device encryption, the most secure,
2588 * supported setting will always be used. If any device administrator requests device
2589 * encryption, it will be enabled; Conversely, if a device administrator attempts to disable
2590 * device encryption while another device administrator has enabled it, the call to disable will
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002591 * fail (most commonly returning {@link #ENCRYPTION_STATUS_ACTIVE}).
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002592 * <p>
2593 * This policy controls encryption of the secure (application data) storage area. Data written
2594 * to other storage areas may or may not be encrypted, and this policy does not require or
2595 * control the encryption of any other storage areas. There is one exception: If
2596 * {@link android.os.Environment#isExternalStorageEmulated()} is {@code true}, then the
2597 * directory returned by {@link android.os.Environment#getExternalStorageDirectory()} must be
2598 * written to disk within the encrypted storage area.
2599 * <p>
2600 * Important Note: On some devices, it is possible to encrypt storage without requiring the user
2601 * to create a device PIN or Password. In this case, the storage is encrypted, but the
2602 * encryption key may not be fully secured. For maximum security, the administrator should also
2603 * require (and check for) a pattern, PIN, or password.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002604 *
2605 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2606 * @param encrypt true to request encryption, false to release any previous request
Andy Stadler22dbfda2011-01-17 12:47:31 -08002607 * @return the new request status (for all active admins) - will be one of
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002608 * {@link #ENCRYPTION_STATUS_UNSUPPORTED}, {@link #ENCRYPTION_STATUS_INACTIVE}, or
2609 * {@link #ENCRYPTION_STATUS_ACTIVE}. This is the value of the requests; Use
2610 * {@link #getStorageEncryptionStatus()} to query the actual device state.
2611 * @throws SecurityException if {@code admin} is not an active administrator or does not use
2612 * {@link DeviceAdminInfo#USES_ENCRYPTED_STORAGE}
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002613 */
Robin Lee25e26452015-06-02 09:56:29 -07002614 public int setStorageEncryption(@NonNull ComponentName admin, boolean encrypt) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002615 throwIfParentInstance("setStorageEncryption");
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002616 if (mService != null) {
2617 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08002618 return mService.setStorageEncryption(admin, encrypt);
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002619 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002620 throw e.rethrowFromSystemServer();
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002621 }
2622 }
2623 return ENCRYPTION_STATUS_UNSUPPORTED;
2624 }
2625
2626 /**
2627 * Called by an application that is administering the device to
Andy Stadler22dbfda2011-01-17 12:47:31 -08002628 * determine the requested setting for secure storage.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002629 *
Andy Stadler22dbfda2011-01-17 12:47:31 -08002630 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. If null,
2631 * this will return the requested encryption setting as an aggregate of all active
2632 * administrators.
2633 * @return true if the admin(s) are requesting encryption, false if not.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002634 */
Robin Lee25e26452015-06-02 09:56:29 -07002635 public boolean getStorageEncryption(@Nullable ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002636 throwIfParentInstance("getStorageEncryption");
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002637 if (mService != null) {
2638 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002639 return mService.getStorageEncryption(admin, myUserId());
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002640 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002641 throw e.rethrowFromSystemServer();
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002642 }
2643 }
Andy Stadler22dbfda2011-01-17 12:47:31 -08002644 return false;
2645 }
2646
2647 /**
2648 * Called by an application that is administering the device to
2649 * determine the current encryption status of the device.
2650 *
2651 * Depending on the returned status code, the caller may proceed in different
2652 * ways. If the result is {@link #ENCRYPTION_STATUS_UNSUPPORTED}, the
2653 * storage system does not support encryption. If the
2654 * result is {@link #ENCRYPTION_STATUS_INACTIVE}, use {@link
2655 * #ACTION_START_ENCRYPTION} to begin the process of encrypting or decrypting the
Robin Lee3795fb02015-02-16 14:17:23 +00002656 * storage. If the result is {@link #ENCRYPTION_STATUS_ACTIVE_DEFAULT_KEY}, the
2657 * storage system has enabled encryption but no password is set so further action
2658 * may be required. If the result is {@link #ENCRYPTION_STATUS_ACTIVATING} or
Andy Stadler22dbfda2011-01-17 12:47:31 -08002659 * {@link #ENCRYPTION_STATUS_ACTIVE}, no further action is required.
2660 *
Robin Lee7e678712014-07-24 16:41:31 +01002661 * @return current status of encryption. The value will be one of
Andy Stadler22dbfda2011-01-17 12:47:31 -08002662 * {@link #ENCRYPTION_STATUS_UNSUPPORTED}, {@link #ENCRYPTION_STATUS_INACTIVE},
Robin Lee3795fb02015-02-16 14:17:23 +00002663 * {@link #ENCRYPTION_STATUS_ACTIVATING}, {@link #ENCRYPTION_STATUS_ACTIVE_DEFAULT_KEY},
2664 * or {@link #ENCRYPTION_STATUS_ACTIVE}.
Andy Stadler22dbfda2011-01-17 12:47:31 -08002665 */
2666 public int getStorageEncryptionStatus() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002667 throwIfParentInstance("getStorageEncryptionStatus");
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002668 return getStorageEncryptionStatus(myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002669 }
2670
2671 /** @hide per-user version */
2672 public int getStorageEncryptionStatus(int userHandle) {
Andy Stadler22dbfda2011-01-17 12:47:31 -08002673 if (mService != null) {
2674 try {
Makoto Onukid4c9e542016-02-25 18:17:30 -08002675 return mService.getStorageEncryptionStatus(mContext.getPackageName(), userHandle);
Andy Stadler22dbfda2011-01-17 12:47:31 -08002676 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002677 throw e.rethrowFromSystemServer();
Andy Stadler22dbfda2011-01-17 12:47:31 -08002678 }
2679 }
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002680 return ENCRYPTION_STATUS_UNSUPPORTED;
2681 }
2682
2683 /**
Robin Lee2f7e1e42016-03-21 10:50:01 +00002684 * Mark a CA certificate as approved by the device user. This means that they have been notified
2685 * of the installation, were made aware of the risks, viewed the certificate and still wanted to
2686 * keep the certificate on the device.
2687 *
2688 * Calling with {@param approval} as {@code true} will cancel any ongoing warnings related to
2689 * this certificate.
2690 *
2691 * @hide
2692 */
2693 public boolean approveCaCert(String alias, int userHandle, boolean approval) {
2694 if (mService != null) {
2695 try {
2696 return mService.approveCaCert(alias, userHandle, approval);
2697 } catch (RemoteException e) {
2698 throw e.rethrowFromSystemServer();
2699 }
2700 }
2701 return false;
2702 }
2703
2704 /**
2705 * Check whether a CA certificate has been approved by the device user.
2706 *
2707 * @hide
2708 */
2709 public boolean isCaCertApproved(String alias, int userHandle) {
2710 if (mService != null) {
2711 try {
2712 return mService.isCaCertApproved(alias, userHandle);
2713 } catch (RemoteException e) {
2714 throw e.rethrowFromSystemServer();
2715 }
2716 }
2717 return false;
2718 }
2719
2720 /**
Robin Lee7e678712014-07-24 16:41:31 +01002721 * Installs the given certificate as a user CA.
2722 *
Robin Lee25e26452015-06-02 09:56:29 -07002723 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2724 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01002725 * @param certBuffer encoded form of the certificate to install.
Maggie Benthallda51e682013-08-08 22:35:44 -04002726 *
2727 * @return false if the certBuffer cannot be parsed or installation is
Robin Lee7e678712014-07-24 16:41:31 +01002728 * interrupted, true otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002729 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2730 * owner.
Maggie Benthallda51e682013-08-08 22:35:44 -04002731 */
Robin Lee25e26452015-06-02 09:56:29 -07002732 public boolean installCaCert(@Nullable ComponentName admin, byte[] certBuffer) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002733 throwIfParentInstance("installCaCert");
Maggie Benthallda51e682013-08-08 22:35:44 -04002734 if (mService != null) {
2735 try {
Robin Lee7e678712014-07-24 16:41:31 +01002736 return mService.installCaCert(admin, certBuffer);
Maggie Benthallda51e682013-08-08 22:35:44 -04002737 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002738 throw e.rethrowFromSystemServer();
Maggie Benthallda51e682013-08-08 22:35:44 -04002739 }
2740 }
2741 return false;
2742 }
2743
2744 /**
Robin Lee7e678712014-07-24 16:41:31 +01002745 * Uninstalls the given certificate from trusted user CAs, if present.
2746 *
Robin Lee25e26452015-06-02 09:56:29 -07002747 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2748 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01002749 * @param certBuffer encoded form of the certificate to remove.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002750 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2751 * owner.
Maggie Benthallda51e682013-08-08 22:35:44 -04002752 */
Robin Lee25e26452015-06-02 09:56:29 -07002753 public void uninstallCaCert(@Nullable ComponentName admin, byte[] certBuffer) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002754 throwIfParentInstance("uninstallCaCert");
Maggie Benthallda51e682013-08-08 22:35:44 -04002755 if (mService != null) {
2756 try {
Robin Lee306fe082014-06-19 14:04:24 +00002757 final String alias = getCaCertAlias(certBuffer);
Robin Lee83881bd2015-06-09 16:04:38 -07002758 mService.uninstallCaCerts(admin, new String[] {alias});
Robin Lee306fe082014-06-19 14:04:24 +00002759 } catch (CertificateException e) {
2760 Log.w(TAG, "Unable to parse certificate", e);
Maggie Benthallda51e682013-08-08 22:35:44 -04002761 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002762 throw e.rethrowFromSystemServer();
Maggie Benthallda51e682013-08-08 22:35:44 -04002763 }
2764 }
2765 }
2766
2767 /**
Robin Lee7e678712014-07-24 16:41:31 +01002768 * Returns all CA certificates that are currently trusted, excluding system CA certificates.
2769 * If a user has installed any certificates by other means than device policy these will be
2770 * included too.
2771 *
Robin Lee25e26452015-06-02 09:56:29 -07002772 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2773 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01002774 * @return a List of byte[] arrays, each encoding one user CA certificate.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002775 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2776 * owner.
Maggie Benthallda51e682013-08-08 22:35:44 -04002777 */
Robin Lee25e26452015-06-02 09:56:29 -07002778 public List<byte[]> getInstalledCaCerts(@Nullable ComponentName admin) {
Robin Lee7e678712014-07-24 16:41:31 +01002779 List<byte[]> certs = new ArrayList<byte[]>();
Benjamin Franzbc33c822016-04-15 08:57:52 +01002780 throwIfParentInstance("getInstalledCaCerts");
Esteban Talavera808f6ef2014-08-28 17:15:54 +01002781 if (mService != null) {
Robin Lee7e678712014-07-24 16:41:31 +01002782 try {
Esteban Talavera808f6ef2014-08-28 17:15:54 +01002783 mService.enforceCanManageCaCerts(admin);
2784 final TrustedCertificateStore certStore = new TrustedCertificateStore();
2785 for (String alias : certStore.userAliases()) {
2786 try {
2787 certs.add(certStore.getCertificate(alias).getEncoded());
2788 } catch (CertificateException ce) {
2789 Log.w(TAG, "Could not encode certificate: " + alias, ce);
2790 }
2791 }
2792 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002793 throw re.rethrowFromSystemServer();
Robin Lee7e678712014-07-24 16:41:31 +01002794 }
2795 }
2796 return certs;
Maggie Benthallda51e682013-08-08 22:35:44 -04002797 }
2798
2799 /**
Robin Lee7e678712014-07-24 16:41:31 +01002800 * Uninstalls all custom trusted CA certificates from the profile. Certificates installed by
2801 * means other than device policy will also be removed, except for system CA certificates.
2802 *
Robin Lee25e26452015-06-02 09:56:29 -07002803 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2804 * {@code null} if calling from a delegated certificate installer.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002805 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2806 * owner.
Robin Lee7e678712014-07-24 16:41:31 +01002807 */
Robin Lee25e26452015-06-02 09:56:29 -07002808 public void uninstallAllUserCaCerts(@Nullable ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002809 throwIfParentInstance("uninstallAllUserCaCerts");
Robin Lee7e678712014-07-24 16:41:31 +01002810 if (mService != null) {
Robin Lee83881bd2015-06-09 16:04:38 -07002811 try {
2812 mService.uninstallCaCerts(admin, new TrustedCertificateStore().userAliases()
2813 .toArray(new String[0]));
2814 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002815 throw re.rethrowFromSystemServer();
Robin Lee7e678712014-07-24 16:41:31 +01002816 }
2817 }
2818 }
2819
2820 /**
2821 * Returns whether this certificate is installed as a trusted CA.
2822 *
Robin Lee25e26452015-06-02 09:56:29 -07002823 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2824 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01002825 * @param certBuffer encoded form of the certificate to look up.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002826 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2827 * owner.
Maggie Benthallda51e682013-08-08 22:35:44 -04002828 */
Robin Lee25e26452015-06-02 09:56:29 -07002829 public boolean hasCaCertInstalled(@Nullable ComponentName admin, byte[] certBuffer) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002830 throwIfParentInstance("hasCaCertInstalled");
Esteban Talavera808f6ef2014-08-28 17:15:54 +01002831 if (mService != null) {
2832 try {
2833 mService.enforceCanManageCaCerts(admin);
2834 return getCaCertAlias(certBuffer) != null;
2835 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002836 throw re.rethrowFromSystemServer();
Esteban Talavera808f6ef2014-08-28 17:15:54 +01002837 } catch (CertificateException ce) {
2838 Log.w(TAG, "Could not parse certificate", ce);
2839 }
Maggie Benthallda51e682013-08-08 22:35:44 -04002840 }
2841 return false;
2842 }
2843
2844 /**
Robin Leece3399f2016-02-24 12:08:32 +00002845 * Called by a device or profile owner, or delegated certificate installer, to install a
2846 * certificate and corresponding private key. All apps within the profile will be able to access
2847 * the certificate and use the private key, given direct user approval.
2848 *
2849 * <p>Access to the installed credentials will not be granted to the caller of this API without
2850 * direct user approval. This is for security - should a certificate installer become
2851 * compromised, certificates it had already installed will be protected.
2852 *
2853 * <p>If the installer must have access to the credentials, call
Rubin Xub4365912016-03-23 12:13:22 +00002854 * {@link #installKeyPair(ComponentName, PrivateKey, Certificate[], String, boolean)} instead.
Bernhard Bauer26408cc2014-09-08 14:07:31 +01002855 *
Robin Lee25e26452015-06-02 09:56:29 -07002856 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2857 * {@code null} if calling from a delegated certificate installer.
Bernhard Bauer26408cc2014-09-08 14:07:31 +01002858 * @param privKey The private key to install.
2859 * @param cert The certificate to install.
2860 * @param alias The private key alias under which to install the certificate. If a certificate
2861 * with that alias already exists, it will be overwritten.
2862 * @return {@code true} if the keys were installed, {@code false} otherwise.
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.
Bernhard Bauer26408cc2014-09-08 14:07:31 +01002865 */
Robin Leefbc65642015-08-03 16:21:22 +01002866 public boolean installKeyPair(@Nullable ComponentName admin, @NonNull PrivateKey privKey,
2867 @NonNull Certificate cert, @NonNull String alias) {
Rubin Xub4365912016-03-23 12:13:22 +00002868 return installKeyPair(admin, privKey, new Certificate[] {cert}, alias, false);
Robin Leece3399f2016-02-24 12:08:32 +00002869 }
2870
2871 /**
2872 * Called by a device or profile owner, or delegated certificate installer, to install a
Rubin Xub4365912016-03-23 12:13:22 +00002873 * certificate chain and corresponding private key for the leaf certificate. All apps within the
2874 * profile will be able to access the certificate chain and use the private key, given direct
2875 * user approval.
Robin Leece3399f2016-02-24 12:08:32 +00002876 *
Robin Leea1b290e2016-03-09 14:38:36 +00002877 * <p>The caller of this API may grant itself access to the certificate and private key
2878 * immediately, without user approval. It is a best practice not to request this unless strictly
2879 * necessary since it opens up additional security vulnerabilities.
Robin Leece3399f2016-02-24 12:08:32 +00002880 *
2881 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
Robin Leea1b290e2016-03-09 14:38:36 +00002882 * {@code null} if calling from a delegated certificate installer.
Robin Leece3399f2016-02-24 12:08:32 +00002883 * @param privKey The private key to install.
Rubin Xub4365912016-03-23 12:13:22 +00002884 * @param certs The certificate chain to install. The chain should start with the leaf
2885 * certificate and include the chain of trust in order. This will be returned by
2886 * {@link android.security.KeyChain#getCertificateChain}.
Robin Leece3399f2016-02-24 12:08:32 +00002887 * @param alias The private key alias under which to install the certificate. If a certificate
Robin Leea1b290e2016-03-09 14:38:36 +00002888 * with that alias already exists, it will be overwritten.
Robin Leece3399f2016-02-24 12:08:32 +00002889 * @param requestAccess {@code true} to request that the calling app be granted access to the
Robin Leea1b290e2016-03-09 14:38:36 +00002890 * credentials immediately. Otherwise, access to the credentials will be gated by user
2891 * approval.
Robin Leece3399f2016-02-24 12:08:32 +00002892 * @return {@code true} if the keys were installed, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002893 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2894 * owner.
Rubin Xub4365912016-03-23 12:13:22 +00002895 * @see android.security.KeyChain#getCertificateChain
Robin Leece3399f2016-02-24 12:08:32 +00002896 */
2897 public boolean installKeyPair(@Nullable ComponentName admin, @NonNull PrivateKey privKey,
Rubin Xub4365912016-03-23 12:13:22 +00002898 @NonNull Certificate[] certs, @NonNull String alias, boolean requestAccess) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002899 throwIfParentInstance("installKeyPair");
Bernhard Bauer26408cc2014-09-08 14:07:31 +01002900 try {
Rubin Xub4365912016-03-23 12:13:22 +00002901 final byte[] pemCert = Credentials.convertToPem(certs[0]);
2902 byte[] pemChain = null;
2903 if (certs.length > 1) {
2904 pemChain = Credentials.convertToPem(Arrays.copyOfRange(certs, 1, certs.length));
2905 }
Robin Lee0d5ccb72014-09-12 17:41:44 +01002906 final byte[] pkcs8Key = KeyFactory.getInstance(privKey.getAlgorithm())
2907 .getKeySpec(privKey, PKCS8EncodedKeySpec.class).getEncoded();
Rubin Xub4365912016-03-23 12:13:22 +00002908 return mService.installKeyPair(admin, pkcs8Key, pemCert, pemChain, alias,
2909 requestAccess);
Bernhard Bauer26408cc2014-09-08 14:07:31 +01002910 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002911 throw e.rethrowFromSystemServer();
Robin Lee0d5ccb72014-09-12 17:41:44 +01002912 } catch (NoSuchAlgorithmException | InvalidKeySpecException e) {
2913 Log.w(TAG, "Failed to obtain private key material", e);
2914 } catch (CertificateException | IOException e) {
2915 Log.w(TAG, "Could not pem-encode certificate", e);
Bernhard Bauer26408cc2014-09-08 14:07:31 +01002916 }
2917 return false;
2918 }
2919
2920 /**
Robin Leea1b290e2016-03-09 14:38:36 +00002921 * Called by a device or profile owner, or delegated certificate installer, to remove a
2922 * certificate and private key pair installed under a given alias.
Robin Leefbc65642015-08-03 16:21:22 +01002923 *
2924 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
Robin Leea1b290e2016-03-09 14:38:36 +00002925 * {@code null} if calling from a delegated certificate installer.
Robin Leefbc65642015-08-03 16:21:22 +01002926 * @param alias The private key alias under which the certificate is installed.
Robin Leea1b290e2016-03-09 14:38:36 +00002927 * @return {@code true} if the private key alias no longer exists, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002928 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2929 * owner.
Robin Leefbc65642015-08-03 16:21:22 +01002930 */
2931 public boolean removeKeyPair(@Nullable ComponentName admin, @NonNull String alias) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002932 throwIfParentInstance("removeKeyPair");
Robin Leefbc65642015-08-03 16:21:22 +01002933 try {
2934 return mService.removeKeyPair(admin, alias);
2935 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002936 throw e.rethrowFromSystemServer();
Robin Leefbc65642015-08-03 16:21:22 +01002937 }
Robin Leefbc65642015-08-03 16:21:22 +01002938 }
2939
2940 /**
Robin Lee25e26452015-06-02 09:56:29 -07002941 * @return the alias of a given CA certificate in the certificate store, or {@code null} if it
Robin Lee306fe082014-06-19 14:04:24 +00002942 * doesn't exist.
2943 */
2944 private static String getCaCertAlias(byte[] certBuffer) throws CertificateException {
2945 final CertificateFactory certFactory = CertificateFactory.getInstance("X.509");
2946 final X509Certificate cert = (X509Certificate) certFactory.generateCertificate(
2947 new ByteArrayInputStream(certBuffer));
2948 return new TrustedCertificateStore().getCertificateAlias(cert);
2949 }
2950
2951 /**
Rubin Xuec32b562015-03-03 17:34:05 +00002952 * Called by a profile owner or device owner to grant access to privileged certificate
Rubin Xuacdc1832015-04-02 12:40:20 +01002953 * manipulation APIs to a third-party certificate installer app. Granted APIs include
Rubin Xuec32b562015-03-03 17:34:05 +00002954 * {@link #getInstalledCaCerts}, {@link #hasCaCertInstalled}, {@link #installCaCert},
Rubin Xuacdc1832015-04-02 12:40:20 +01002955 * {@link #uninstallCaCert}, {@link #uninstallAllUserCaCerts} and {@link #installKeyPair}.
Rubin Xuec32b562015-03-03 17:34:05 +00002956 * <p>
2957 * Delegated certificate installer is a per-user state. The delegated access is persistent until
2958 * it is later cleared by calling this method with a null value or uninstallling the certificate
2959 * installer.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002960 * <p>
Rubin Xuf03d0a62016-02-10 14:54:15 +00002961 * <b>Note:</b>Starting from {@link android.os.Build.VERSION_CODES#N}, if the caller
2962 * application's target SDK version is {@link android.os.Build.VERSION_CODES#N} or newer, the
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002963 * supplied certificate installer package must be installed when calling this API, otherwise an
2964 * {@link IllegalArgumentException} will be thrown.
Rubin Xuec32b562015-03-03 17:34:05 +00002965 *
Robin Lee25e26452015-06-02 09:56:29 -07002966 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Rubin Xuec32b562015-03-03 17:34:05 +00002967 * @param installerPackage The package name of the certificate installer which will be given
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002968 * access. If {@code null} is given the current package will be cleared.
2969 * @throws SecurityException if {@code admin} is not a device or a profile owner.
Rubin Xuec32b562015-03-03 17:34:05 +00002970 */
Robin Lee25e26452015-06-02 09:56:29 -07002971 public void setCertInstallerPackage(@NonNull ComponentName admin, @Nullable String
2972 installerPackage) throws SecurityException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002973 throwIfParentInstance("setCertInstallerPackage");
Rubin Xuec32b562015-03-03 17:34:05 +00002974 if (mService != null) {
2975 try {
Robin Lee25e26452015-06-02 09:56:29 -07002976 mService.setCertInstallerPackage(admin, installerPackage);
Rubin Xuec32b562015-03-03 17:34:05 +00002977 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002978 throw e.rethrowFromSystemServer();
Rubin Xuec32b562015-03-03 17:34:05 +00002979 }
2980 }
2981 }
2982
2983 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002984 * Called by a profile owner or device owner to retrieve the certificate installer for the user.
2985 * null if none is set.
Rubin Xuec32b562015-03-03 17:34:05 +00002986 *
Robin Lee25e26452015-06-02 09:56:29 -07002987 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002988 * @return The package name of the current delegated certificate installer, or {@code null} if
2989 * none is set.
2990 * @throws SecurityException if {@code admin} is not a device or a profile owner.
Rubin Xuec32b562015-03-03 17:34:05 +00002991 */
Robin Lee25e26452015-06-02 09:56:29 -07002992 public String getCertInstallerPackage(@NonNull ComponentName admin) throws SecurityException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01002993 throwIfParentInstance("getCertInstallerPackage");
Rubin Xuec32b562015-03-03 17:34:05 +00002994 if (mService != null) {
2995 try {
Robin Lee25e26452015-06-02 09:56:29 -07002996 return mService.getCertInstallerPackage(admin);
Rubin Xuec32b562015-03-03 17:34:05 +00002997 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002998 throw e.rethrowFromSystemServer();
Rubin Xuec32b562015-03-03 17:34:05 +00002999 }
3000 }
3001 return null;
3002 }
3003
3004 /**
Robin Lee244ce8e2016-01-05 18:03:46 +00003005 * Called by a device or profile owner to configure an always-on VPN connection through a
Robin Leedc679712016-05-03 13:23:03 +01003006 * specific application for the current user.
3007 *
3008 * @deprecated this version only exists for compability with previous developer preview builds.
3009 * TODO: delete once there are no longer any live references.
3010 * @hide
3011 */
3012 public void setAlwaysOnVpnPackage(@NonNull ComponentName admin, @Nullable String vpnPackage)
3013 throws NameNotFoundException, UnsupportedOperationException {
3014 setAlwaysOnVpnPackage(admin, vpnPackage, /* lockdownEnabled */ true);
3015 }
3016
3017 /**
3018 * Called by a device or profile owner to configure an always-on VPN connection through a
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003019 * specific application for the current user. This connection is automatically granted and
3020 * persisted after a reboot.
3021 * <p>
3022 * The designated package should declare a {@link android.net.VpnService} in its manifest
3023 * guarded by {@link android.Manifest.permission#BIND_VPN_SERVICE}, otherwise the call will
3024 * fail.
Robin Lee244ce8e2016-01-05 18:03:46 +00003025 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003026 * @param vpnPackage The package name for an installed VPN app on the device, or {@code null} to
Robin Leedc679712016-05-03 13:23:03 +01003027 * remove an existing always-on VPN configuration.
3028 * @param lockdownEnabled {@code true} to disallow networking when the VPN is not connected or
3029 * {@code false} otherwise. This carries the risk that any failure of the VPN provider
3030 * could break networking for all apps. This has no effect when clearing.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003031 * @return {@code true} if the package is set as always-on VPN controller; {@code false}
3032 * otherwise.
3033 * @throws SecurityException if {@code admin} is not a device or a profile owner.
Robin Leeee5eb932016-04-05 16:27:15 +01003034 * @throws NameNotFoundException if {@code vpnPackage} is not installed.
3035 * @throws UnsupportedOperationException if {@code vpnPackage} exists but does not support being
3036 * set as always-on, or if always-on VPN is not available.
Robin Lee244ce8e2016-01-05 18:03:46 +00003037 */
Robin Leedc679712016-05-03 13:23:03 +01003038 public void setAlwaysOnVpnPackage(@NonNull ComponentName admin, @Nullable String vpnPackage,
3039 boolean lockdownEnabled)
Robin Leeee5eb932016-04-05 16:27:15 +01003040 throws NameNotFoundException, UnsupportedOperationException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003041 throwIfParentInstance("setAlwaysOnVpnPackage");
Robin Lee244ce8e2016-01-05 18:03:46 +00003042 if (mService != null) {
3043 try {
Robin Leedc679712016-05-03 13:23:03 +01003044 if (!mService.setAlwaysOnVpnPackage(admin, vpnPackage, lockdownEnabled)) {
Robin Leeee5eb932016-04-05 16:27:15 +01003045 throw new NameNotFoundException(vpnPackage);
3046 }
Robin Lee244ce8e2016-01-05 18:03:46 +00003047 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003048 throw e.rethrowFromSystemServer();
Robin Lee244ce8e2016-01-05 18:03:46 +00003049 }
3050 }
Robin Lee244ce8e2016-01-05 18:03:46 +00003051 }
3052
3053 /**
3054 * Called by a device or profile owner to read the name of the package administering an
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003055 * always-on VPN connection for the current user. If there is no such package, or the always-on
3056 * VPN is provided by the system instead of by an application, {@code null} will be returned.
Robin Lee244ce8e2016-01-05 18:03:46 +00003057 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003058 * @return Package name of VPN controller responsible for always-on VPN, or {@code null} if none
3059 * is set.
3060 * @throws SecurityException if {@code admin} is not a device or a profile owner.
Robin Lee244ce8e2016-01-05 18:03:46 +00003061 */
3062 public String getAlwaysOnVpnPackage(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003063 throwIfParentInstance("getAlwaysOnVpnPackage");
Robin Lee244ce8e2016-01-05 18:03:46 +00003064 if (mService != null) {
3065 try {
3066 return mService.getAlwaysOnVpnPackage(admin);
3067 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003068 throw e.rethrowFromSystemServer();
Robin Lee244ce8e2016-01-05 18:03:46 +00003069 }
3070 }
3071 return null;
3072 }
3073
3074 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003075 * Called by an application that is administering the device to disable all cameras on the
3076 * device, for this user. After setting this, no applications running as this user will be able
3077 * to access any cameras on the device.
3078 * <p>
3079 * If the caller is device owner, then the restriction will be applied to all users.
3080 * <p>
3081 * The calling device admin must have requested
3082 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_CAMERA} to be able to call this method; if it has
3083 * not, a security exception will be thrown.
Ben Komalo2447edd2011-05-09 16:05:33 -07003084 *
3085 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3086 * @param disabled Whether or not the camera should be disabled.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003087 * @throws SecurityException if {@code admin} is not an active administrator or does not use
3088 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_CAMERA}.
Ben Komalo2447edd2011-05-09 16:05:33 -07003089 */
Robin Lee25e26452015-06-02 09:56:29 -07003090 public void setCameraDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003091 throwIfParentInstance("setCameraDisabled");
Ben Komalo2447edd2011-05-09 16:05:33 -07003092 if (mService != null) {
3093 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08003094 mService.setCameraDisabled(admin, disabled);
Ben Komalo2447edd2011-05-09 16:05:33 -07003095 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003096 throw e.rethrowFromSystemServer();
Ben Komalo2447edd2011-05-09 16:05:33 -07003097 }
3098 }
3099 }
3100
3101 /**
Amith Yamasani242f4b12014-10-14 16:06:13 -07003102 * Determine whether or not the device's cameras have been disabled for this user,
Makoto Onuki32b30572015-12-11 14:29:51 -08003103 * either by the calling admin, if specified, or all admins.
Robin Lee25e26452015-06-02 09:56:29 -07003104 * @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 -07003105 * have disabled the camera
3106 */
Robin Lee25e26452015-06-02 09:56:29 -07003107 public boolean getCameraDisabled(@Nullable ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003108 throwIfParentInstance("getCameraDisabled");
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003109 return getCameraDisabled(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003110 }
3111
3112 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07003113 public boolean getCameraDisabled(@Nullable ComponentName admin, int userHandle) {
Ben Komalo2447edd2011-05-09 16:05:33 -07003114 if (mService != null) {
3115 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003116 return mService.getCameraDisabled(admin, userHandle);
Ben Komalo2447edd2011-05-09 16:05:33 -07003117 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003118 throw e.rethrowFromSystemServer();
Ben Komalo2447edd2011-05-09 16:05:33 -07003119 }
3120 }
3121 return false;
3122 }
3123
3124 /**
Michal Karpinski3fc437e2015-12-15 10:09:00 +00003125 * Called by a device owner to request a bugreport.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003126 * <p>
3127 * There must be only one user on the device, managed by the device owner. Otherwise a
3128 * {@link SecurityException} will be thrown.
Michal Karpinski3fc437e2015-12-15 10:09:00 +00003129 *
3130 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003131 * @return {@code true} if the bugreport collection started successfully, or {@code false} if it
3132 * wasn't triggered because a previous bugreport operation is still active (either the
3133 * bugreport is still running or waiting for the user to share or decline)
3134 * @throws SecurityException if {@code admin} is not a device owner, or if there are users other
3135 * than the one managed by the device owner.
Michal Karpinski3fc437e2015-12-15 10:09:00 +00003136 */
3137 public boolean requestBugreport(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003138 throwIfParentInstance("requestBugreport");
Michal Karpinski3fc437e2015-12-15 10:09:00 +00003139 if (mService != null) {
3140 try {
3141 return mService.requestBugreport(admin);
3142 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003143 throw e.rethrowFromSystemServer();
Michal Karpinski3fc437e2015-12-15 10:09:00 +00003144 }
3145 }
3146 return false;
3147 }
3148
3149 /**
Fyodor Kupolovcd86ebf2015-09-29 17:06:50 -07003150 * Determine whether or not creating a guest user has been disabled for the device
3151 *
3152 * @hide
3153 */
3154 public boolean getGuestUserDisabled(@Nullable ComponentName admin) {
3155 // Currently guest users can always be created if multi-user is enabled
3156 // TODO introduce a policy for guest user creation
3157 return false;
3158 }
3159
3160 /**
Esteban Talavera1aee98f2014-08-21 14:03:55 +01003161 * Called by a device/profile owner to set whether the screen capture is disabled. Disabling
3162 * screen capture also prevents the content from being shown on display devices that do not have
3163 * a secure video output. See {@link android.view.Display#FLAG_SECURE} for more details about
3164 * secure surfaces and secure displays.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003165 * <p>
3166 * The calling device admin must be a device or profile owner. If it is not, a security
3167 * exception will be thrown.
3168 * <p>
3169 * From version {@link android.os.Build.VERSION_CODES#M} disabling screen capture also blocks
3170 * assist requests for all activities of the relevant user.
Benjamin Franzc200f442015-06-25 18:20:04 +01003171 *
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003172 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003173 * @param disabled Whether screen capture is disabled or not.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003174 * @throws SecurityException if {@code admin} is not a device or profile owner.
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003175 */
Robin Lee25e26452015-06-02 09:56:29 -07003176 public void setScreenCaptureDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003177 throwIfParentInstance("setScreenCaptureDisabled");
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003178 if (mService != null) {
3179 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08003180 mService.setScreenCaptureDisabled(admin, disabled);
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003181 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003182 throw e.rethrowFromSystemServer();
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003183 }
3184 }
3185 }
3186
3187 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08003188 * Determine whether or not screen capture has been disabled by the calling
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003189 * admin, if specified, or all admins.
Robin Lee25e26452015-06-02 09:56:29 -07003190 * @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 +01003191 * have disabled screen capture.
3192 */
Robin Lee25e26452015-06-02 09:56:29 -07003193 public boolean getScreenCaptureDisabled(@Nullable ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003194 throwIfParentInstance("getScreenCaptureDisabled");
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003195 return getScreenCaptureDisabled(admin, myUserId());
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003196 }
3197
3198 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07003199 public boolean getScreenCaptureDisabled(@Nullable ComponentName admin, int userHandle) {
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003200 if (mService != null) {
3201 try {
3202 return mService.getScreenCaptureDisabled(admin, userHandle);
3203 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003204 throw e.rethrowFromSystemServer();
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003205 }
3206 }
3207 return false;
3208 }
3209
3210 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003211 * Called by a device owner to set whether auto time is required. If auto time is required the
3212 * user cannot set the date and time, but has to use network date and time.
3213 * <p>
3214 * Note: if auto time is required the user can still manually set the time zone.
3215 * <p>
3216 * The calling device admin must be a device owner. If it is not, a security exception will be
3217 * thrown.
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003218 *
3219 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3220 * @param required Whether auto time is set required or not.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003221 * @throws SecurityException if {@code admin} is not a device owner.
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003222 */
Robin Lee25e26452015-06-02 09:56:29 -07003223 public void setAutoTimeRequired(@NonNull ComponentName admin, boolean required) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003224 throwIfParentInstance("setAutoTimeRequired");
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003225 if (mService != null) {
3226 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08003227 mService.setAutoTimeRequired(admin, required);
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003228 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003229 throw e.rethrowFromSystemServer();
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003230 }
3231 }
3232 }
3233
3234 /**
3235 * @return true if auto time is required.
3236 */
3237 public boolean getAutoTimeRequired() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003238 throwIfParentInstance("getAutoTimeRequired");
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003239 if (mService != null) {
3240 try {
3241 return mService.getAutoTimeRequired();
3242 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003243 throw e.rethrowFromSystemServer();
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003244 }
3245 }
3246 return false;
3247 }
3248
3249 /**
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003250 * Called by a device owner to set whether all users created on the device should be ephemeral.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003251 * <p>
3252 * The system user is exempt from this policy - it is never ephemeral.
3253 * <p>
3254 * The calling device admin must be the device owner. If it is not, a security exception will be
3255 * thrown.
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003256 *
3257 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3258 * @param forceEphemeralUsers If true, all the existing users will be deleted and all
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003259 * subsequently created users will be ephemeral.
3260 * @throws SecurityException if {@code admin} is not a device owner.
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003261 * @hide
3262 */
3263 public void setForceEphemeralUsers(
3264 @NonNull ComponentName admin, boolean forceEphemeralUsers) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003265 throwIfParentInstance("setForceEphemeralUsers");
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003266 if (mService != null) {
3267 try {
3268 mService.setForceEphemeralUsers(admin, forceEphemeralUsers);
3269 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003270 throw e.rethrowFromSystemServer();
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003271 }
3272 }
3273 }
3274
3275 /**
3276 * @return true if all users are created ephemeral.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003277 * @throws SecurityException if {@code admin} is not a device owner.
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003278 * @hide
3279 */
3280 public boolean getForceEphemeralUsers(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003281 throwIfParentInstance("getForceEphemeralUsers");
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003282 if (mService != null) {
3283 try {
3284 return mService.getForceEphemeralUsers(admin);
3285 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003286 throw e.rethrowFromSystemServer();
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003287 }
3288 }
3289 return false;
3290 }
3291
3292 /**
Jim Miller48b9b0d2012-09-19 23:16:50 -07003293 * Called by an application that is administering the device to disable keyguard customizations,
3294 * such as widgets. After setting this, keyguard features will be disabled according to the
3295 * provided feature list.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003296 * <p>
3297 * The calling device admin must have requested
3298 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES} to be able to call this method;
3299 * if it has not, a security exception will be thrown.
3300 * <p>
3301 * Calling this from a managed profile before version {@link android.os.Build.VERSION_CODES#M}
3302 * will throw a security exception. From version {@link android.os.Build.VERSION_CODES#M} the
3303 * profile owner of a managed profile can set:
Kenny Guy0b7dd1e2015-03-12 17:14:38 +00003304 * <ul>
Esteban Talaverac1c83592016-02-17 17:56:15 +00003305 * <li>{@link #KEYGUARD_DISABLE_TRUST_AGENTS}, which affects the parent user, but only if there
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003306 * is no separate challenge set on the managed profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00003307 * <li>{@link #KEYGUARD_DISABLE_FINGERPRINT} which affects the managed profile challenge if
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003308 * there is one, or the parent user otherwise.
3309 * <li>{@link #KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS} which affects notifications generated
3310 * by applications in the managed profile.
Kenny Guy0b7dd1e2015-03-12 17:14:38 +00003311 * </ul>
Esteban Talaverac1c83592016-02-17 17:56:15 +00003312 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} and {@link #KEYGUARD_DISABLE_FINGERPRINT} can also be
3313 * set on the {@link DevicePolicyManager} instance returned by
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003314 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
3315 * profile.
3316 * <p>
3317 * Requests to disable other features on a managed profile will be ignored.
3318 * <p>
3319 * The admin can check which features have been disabled by calling
Kenny Guy0b7dd1e2015-03-12 17:14:38 +00003320 * {@link #getKeyguardDisabledFeatures(ComponentName)}
Amith Yamasani242f4b12014-10-14 16:06:13 -07003321 *
Jim Millerb8ec4702012-08-31 17:19:10 -07003322 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Jim Miller35207742012-11-02 15:33:20 -07003323 * @param which {@link #KEYGUARD_DISABLE_FEATURES_NONE} (default),
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003324 * {@link #KEYGUARD_DISABLE_WIDGETS_ALL}, {@link #KEYGUARD_DISABLE_SECURE_CAMERA},
3325 * {@link #KEYGUARD_DISABLE_SECURE_NOTIFICATIONS},
3326 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS},
3327 * {@link #KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS},
3328 * {@link #KEYGUARD_DISABLE_FINGERPRINT}, {@link #KEYGUARD_DISABLE_FEATURES_ALL}
3329 * @throws SecurityException if {@code admin} is not an active administrator or does not user
3330 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES}
Jim Millerb8ec4702012-08-31 17:19:10 -07003331 */
Robin Lee25e26452015-06-02 09:56:29 -07003332 public void setKeyguardDisabledFeatures(@NonNull ComponentName admin, int which) {
Jim Millerb8ec4702012-08-31 17:19:10 -07003333 if (mService != null) {
3334 try {
Esteban Talavera62399912016-01-11 15:37:55 +00003335 mService.setKeyguardDisabledFeatures(admin, which, mParentInstance);
Jim Millerb8ec4702012-08-31 17:19:10 -07003336 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003337 throw e.rethrowFromSystemServer();
Jim Millerb8ec4702012-08-31 17:19:10 -07003338 }
3339 }
3340 }
3341
3342 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08003343 * Determine whether or not features have been disabled in keyguard either by the calling
Esteban Talaverac1c83592016-02-17 17:56:15 +00003344 * admin, if specified, or all admins that set retrictions on this user and its participating
3345 * profiles. Restrictions on profiles that have a separate challenge are not taken into account.
3346 *
3347 * <p>This method can be called on the {@link DevicePolicyManager} instance
3348 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
3349 * restrictions on the parent profile.
3350 *
Esteban Talavera62399912016-01-11 15:37:55 +00003351 * @param admin The name of the admin component to check, or {@code null} to check whether any
3352 * admins have disabled features in keyguard.
Jim Miller35207742012-11-02 15:33:20 -07003353 * @return bitfield of flags. See {@link #setKeyguardDisabledFeatures(ComponentName, int)}
3354 * for a list.
Jim Millerb8ec4702012-08-31 17:19:10 -07003355 */
Robin Lee25e26452015-06-02 09:56:29 -07003356 public int getKeyguardDisabledFeatures(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003357 return getKeyguardDisabledFeatures(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003358 }
3359
3360 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07003361 public int getKeyguardDisabledFeatures(@Nullable ComponentName admin, int userHandle) {
Jim Millerb8ec4702012-08-31 17:19:10 -07003362 if (mService != null) {
3363 try {
Esteban Talavera62399912016-01-11 15:37:55 +00003364 return mService.getKeyguardDisabledFeatures(admin, userHandle, mParentInstance);
Jim Millerb8ec4702012-08-31 17:19:10 -07003365 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003366 throw e.rethrowFromSystemServer();
Jim Millerb8ec4702012-08-31 17:19:10 -07003367 }
3368 }
Jim Miller48b9b0d2012-09-19 23:16:50 -07003369 return KEYGUARD_DISABLE_FEATURES_NONE;
Jim Millerb8ec4702012-08-31 17:19:10 -07003370 }
3371
3372 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -08003373 * @hide
3374 */
Robin Lee25e26452015-06-02 09:56:29 -07003375 public void setActiveAdmin(@NonNull ComponentName policyReceiver, boolean refreshing,
3376 int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08003377 if (mService != null) {
3378 try {
Jessica Hummel6d36b602014-04-04 12:42:17 +01003379 mService.setActiveAdmin(policyReceiver, refreshing, userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08003380 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003381 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08003382 }
3383 }
3384 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07003385
Dianne Hackbornd6847842010-01-12 18:14:19 -08003386 /**
Jessica Hummel6d36b602014-04-04 12:42:17 +01003387 * @hide
3388 */
Robin Lee25e26452015-06-02 09:56:29 -07003389 public void setActiveAdmin(@NonNull ComponentName policyReceiver, boolean refreshing) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003390 setActiveAdmin(policyReceiver, refreshing, myUserId());
Jessica Hummel6d36b602014-04-04 12:42:17 +01003391 }
3392
3393 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -08003394 * @hide
3395 */
Robin Lee25e26452015-06-02 09:56:29 -07003396 public void getRemoveWarning(@Nullable ComponentName admin, RemoteCallback result) {
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08003397 if (mService != null) {
3398 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003399 mService.getRemoveWarning(admin, result, myUserId());
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08003400 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003401 throw e.rethrowFromSystemServer();
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08003402 }
3403 }
3404 }
3405
3406 /**
3407 * @hide
3408 */
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07003409 public void setActivePasswordState(int quality, int length, int letters, int uppercase,
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003410 int lowercase, int numbers, int symbols, int nonletter, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08003411 if (mService != null) {
3412 try {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07003413 mService.setActivePasswordState(quality, length, letters, uppercase, lowercase,
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003414 numbers, symbols, nonletter, 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 /**
3422 * @hide
3423 */
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003424 public void reportFailedPasswordAttempt(int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08003425 if (mService != null) {
3426 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003427 mService.reportFailedPasswordAttempt(userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08003428 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003429 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08003430 }
3431 }
3432 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07003433
Dianne Hackbornd6847842010-01-12 18:14:19 -08003434 /**
3435 * @hide
3436 */
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003437 public void reportSuccessfulPasswordAttempt(int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08003438 if (mService != null) {
3439 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003440 mService.reportSuccessfulPasswordAttempt(userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08003441 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003442 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08003443 }
3444 }
3445 }
Amith Yamasani71e6c692013-03-24 17:39:28 -07003446
3447 /**
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003448 * @hide
3449 */
3450 public void reportFailedFingerprintAttempt(int userHandle) {
3451 if (mService != null) {
3452 try {
3453 mService.reportFailedFingerprintAttempt(userHandle);
3454 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003455 throw e.rethrowFromSystemServer();
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003456 }
3457 }
3458 }
3459
3460 /**
3461 * @hide
3462 */
3463 public void reportSuccessfulFingerprintAttempt(int userHandle) {
3464 if (mService != null) {
3465 try {
3466 mService.reportSuccessfulFingerprintAttempt(userHandle);
3467 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003468 throw e.rethrowFromSystemServer();
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003469 }
3470 }
3471 }
3472
3473 /**
Michal Karpinski31502d32016-01-25 16:43:07 +00003474 * Should be called when keyguard has been dismissed.
3475 * @hide
3476 */
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003477 public void reportKeyguardDismissed(int userHandle) {
Michal Karpinski31502d32016-01-25 16:43:07 +00003478 if (mService != null) {
3479 try {
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003480 mService.reportKeyguardDismissed(userHandle);
Michal Karpinski31502d32016-01-25 16:43:07 +00003481 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003482 throw e.rethrowFromSystemServer();
Michal Karpinski31502d32016-01-25 16:43:07 +00003483 }
3484 }
3485 }
3486
3487 /**
3488 * Should be called when keyguard view has been shown to the user.
3489 * @hide
3490 */
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003491 public void reportKeyguardSecured(int userHandle) {
Michal Karpinski31502d32016-01-25 16:43:07 +00003492 if (mService != null) {
3493 try {
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003494 mService.reportKeyguardSecured(userHandle);
Michal Karpinski31502d32016-01-25 16:43:07 +00003495 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003496 throw e.rethrowFromSystemServer();
Michal Karpinski31502d32016-01-25 16:43:07 +00003497 }
3498 }
3499 }
3500
3501 /**
Amith Yamasani71e6c692013-03-24 17:39:28 -07003502 * @hide
Nicolas Prevot28063742015-01-08 15:37:12 +00003503 * Sets the given package as the device owner.
Makoto Onukia52562c2015-10-01 16:12:31 -07003504 * Same as {@link #setDeviceOwner(ComponentName, String)} but without setting a device owner name.
3505 * @param who the component name to be registered as device owner.
Amith Yamasani71e6c692013-03-24 17:39:28 -07003506 * @return whether the package was successfully registered as the device owner.
3507 * @throws IllegalArgumentException if the package name is null or invalid
Nicolas Prevot28063742015-01-08 15:37:12 +00003508 * @throws IllegalStateException If the preconditions mentioned are not met.
Amith Yamasani71e6c692013-03-24 17:39:28 -07003509 */
Makoto Onukia52562c2015-10-01 16:12:31 -07003510 public boolean setDeviceOwner(ComponentName who) {
3511 return setDeviceOwner(who, null);
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003512 }
3513
3514 /**
3515 * @hide
Makoto Onuki58b684f2015-09-04 10:48:16 -07003516 */
Makoto Onukia52562c2015-10-01 16:12:31 -07003517 public boolean setDeviceOwner(ComponentName who, int userId) {
3518 return setDeviceOwner(who, null, userId);
Makoto Onuki58b684f2015-09-04 10:48:16 -07003519 }
3520
3521 /**
3522 * @hide
3523 */
Makoto Onukia52562c2015-10-01 16:12:31 -07003524 public boolean setDeviceOwner(ComponentName who, String ownerName) {
3525 return setDeviceOwner(who, ownerName, UserHandle.USER_SYSTEM);
Makoto Onuki58b684f2015-09-04 10:48:16 -07003526 }
3527
3528 /**
3529 * @hide
Nicolas Prevot28063742015-01-08 15:37:12 +00003530 * Sets the given package as the device owner. The package must already be installed. There
3531 * must not already be a device owner.
3532 * Only apps with the MANAGE_PROFILE_AND_DEVICE_OWNERS permission and the shell uid can call
3533 * this method.
3534 * Calling this after the setup phase of the primary user has completed is allowed only if
3535 * the caller is the shell uid, and there are no additional users and no accounts.
Makoto Onukia52562c2015-10-01 16:12:31 -07003536 * @param who the component name to be registered as device owner.
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003537 * @param ownerName the human readable name of the institution that owns this device.
Makoto Onuki58b684f2015-09-04 10:48:16 -07003538 * @param userId ID of the user on which the device owner runs.
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003539 * @return whether the package was successfully registered as the device owner.
3540 * @throws IllegalArgumentException if the package name is null or invalid
Nicolas Prevot28063742015-01-08 15:37:12 +00003541 * @throws IllegalStateException If the preconditions mentioned are not met.
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003542 */
Makoto Onukia52562c2015-10-01 16:12:31 -07003543 public boolean setDeviceOwner(ComponentName who, String ownerName, int userId)
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003544 throws IllegalArgumentException, IllegalStateException {
Amith Yamasani71e6c692013-03-24 17:39:28 -07003545 if (mService != null) {
3546 try {
Makoto Onukia52562c2015-10-01 16:12:31 -07003547 return mService.setDeviceOwner(who, ownerName, userId);
Amith Yamasani71e6c692013-03-24 17:39:28 -07003548 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003549 throw re.rethrowFromSystemServer();
Amith Yamasani71e6c692013-03-24 17:39:28 -07003550 }
3551 }
3552 return false;
3553 }
3554
3555 /**
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003556 * Used to determine if a particular package has been registered as a Device Owner app.
3557 * A device owner app is a special device admin that cannot be deactivated by the user, once
Robin Lee25e26452015-06-02 09:56:29 -07003558 * activated as a device admin. It also cannot be uninstalled. To check whether a particular
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003559 * package is currently registered as the device owner app, pass in the package name from
3560 * {@link Context#getPackageName()} to this method.<p/>This is useful for device
Robin Lee25e26452015-06-02 09:56:29 -07003561 * admin apps that want to check whether they are also registered as the device owner app. The
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003562 * exact mechanism by which a device admin app is registered as a device owner app is defined by
3563 * the setup process.
3564 * @param packageName the package name of the app, to compare with the registered device owner
3565 * app, if any.
Makoto Onukic8a5a552015-11-19 14:29:12 -08003566 * @return whether or not the package is registered as the device owner app.
Amith Yamasani71e6c692013-03-24 17:39:28 -07003567 */
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003568 public boolean isDeviceOwnerApp(String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003569 throwIfParentInstance("isDeviceOwnerApp");
Makoto Onukic8a5a552015-11-19 14:29:12 -08003570 return isDeviceOwnerAppOnCallingUser(packageName);
3571 }
3572
3573 /**
3574 * @return true if a package is registered as device owner, only when it's running on the
3575 * calling user.
3576 *
3577 * <p>Same as {@link #isDeviceOwnerApp}, but bundled code should use it for clarity.
3578 * @hide
3579 */
3580 public boolean isDeviceOwnerAppOnCallingUser(String packageName) {
3581 return isDeviceOwnerAppOnAnyUserInner(packageName, /* callingUserOnly =*/ true);
3582 }
3583
3584 /**
3585 * @return true if a package is registered as device owner, even if it's running on a different
3586 * user.
3587 *
3588 * <p>Requires the MANAGE_USERS permission.
3589 *
3590 * @hide
3591 */
3592 public boolean isDeviceOwnerAppOnAnyUser(String packageName) {
3593 return isDeviceOwnerAppOnAnyUserInner(packageName, /* callingUserOnly =*/ false);
3594 }
3595
3596 /**
3597 * @return device owner component name, only when it's running on the calling user.
3598 *
3599 * @hide
3600 */
3601 public ComponentName getDeviceOwnerComponentOnCallingUser() {
3602 return getDeviceOwnerComponentInner(/* callingUserOnly =*/ true);
3603 }
3604
3605 /**
3606 * @return device owner component name, even if it's running on a different user.
3607 *
3608 * <p>Requires the MANAGE_USERS permission.
3609 *
3610 * @hide
3611 */
3612 public ComponentName getDeviceOwnerComponentOnAnyUser() {
3613 return getDeviceOwnerComponentInner(/* callingUserOnly =*/ false);
3614 }
3615
3616 private boolean isDeviceOwnerAppOnAnyUserInner(String packageName, boolean callingUserOnly) {
Makoto Onuki70f929e2015-11-11 12:40:15 -08003617 if (packageName == null) {
3618 return false;
Amith Yamasani71e6c692013-03-24 17:39:28 -07003619 }
Makoto Onukic8a5a552015-11-19 14:29:12 -08003620 final ComponentName deviceOwner = getDeviceOwnerComponentInner(callingUserOnly);
Makoto Onuki70f929e2015-11-11 12:40:15 -08003621 if (deviceOwner == null) {
3622 return false;
3623 }
3624 return packageName.equals(deviceOwner.getPackageName());
Amith Yamasani71e6c692013-03-24 17:39:28 -07003625 }
3626
Makoto Onukic8a5a552015-11-19 14:29:12 -08003627 private ComponentName getDeviceOwnerComponentInner(boolean callingUserOnly) {
3628 if (mService != null) {
3629 try {
3630 return mService.getDeviceOwnerComponent(callingUserOnly);
3631 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003632 throw re.rethrowFromSystemServer();
Makoto Onukic8a5a552015-11-19 14:29:12 -08003633 }
3634 }
3635 return null;
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003636 }
3637
Jason Monkb0dced82014-06-06 14:36:20 -04003638 /**
Makoto Onukic8a5a552015-11-19 14:29:12 -08003639 * @return ID of the user who runs device owner, or {@link UserHandle#USER_NULL} if there's
3640 * no device owner.
3641 *
3642 * <p>Requires the MANAGE_USERS permission.
Makoto Onukia52562c2015-10-01 16:12:31 -07003643 *
3644 * @hide
3645 */
Makoto Onukic8a5a552015-11-19 14:29:12 -08003646 public int getDeviceOwnerUserId() {
3647 if (mService != null) {
3648 try {
3649 return mService.getDeviceOwnerUserId();
3650 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003651 throw re.rethrowFromSystemServer();
Makoto Onukic8a5a552015-11-19 14:29:12 -08003652 }
3653 }
3654 return UserHandle.USER_NULL;
Makoto Onukia52562c2015-10-01 16:12:31 -07003655 }
3656
3657 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003658 * Clears the current device owner. The caller must be the device owner. This function should be
3659 * used cautiously as once it is called it cannot be undone. The device owner can only be set as
3660 * a part of device setup before setup completes.
Jason Monk94d2cf92014-06-18 09:53:34 -04003661 *
3662 * @param packageName The package name of the device owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003663 * @throws SecurityException if the caller is not in {@code packageName} or {@code packageName}
3664 * does not own the current device owner component.
Jason Monkb0dced82014-06-06 14:36:20 -04003665 */
Jason Monk94d2cf92014-06-18 09:53:34 -04003666 public void clearDeviceOwnerApp(String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003667 throwIfParentInstance("clearDeviceOwnerApp");
Jason Monkb0dced82014-06-06 14:36:20 -04003668 if (mService != null) {
3669 try {
Jason Monk94d2cf92014-06-18 09:53:34 -04003670 mService.clearDeviceOwner(packageName);
Jason Monkb0dced82014-06-06 14:36:20 -04003671 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003672 throw re.rethrowFromSystemServer();
Jason Monkb0dced82014-06-06 14:36:20 -04003673 }
3674 }
3675 }
3676
Makoto Onukia52562c2015-10-01 16:12:31 -07003677 /**
Makoto Onukic8a5a552015-11-19 14:29:12 -08003678 * Returns the device owner package name, only if it's running on the calling user.
3679 *
3680 * <p>Bundled components should use {@code getDeviceOwnerComponentOnCallingUser()} for clarity.
Makoto Onukia52562c2015-10-01 16:12:31 -07003681 *
3682 * @hide
3683 */
Nicolas Prevot465acf32014-08-06 17:03:25 +01003684 @SystemApi
Amith Yamasani71e6c692013-03-24 17:39:28 -07003685 public String getDeviceOwner() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003686 throwIfParentInstance("getDeviceOwner");
Makoto Onukic8a5a552015-11-19 14:29:12 -08003687 final ComponentName name = getDeviceOwnerComponentOnCallingUser();
3688 return name != null ? name.getPackageName() : null;
Makoto Onukia52562c2015-10-01 16:12:31 -07003689 }
3690
3691 /**
Makoto Onukic8a5a552015-11-19 14:29:12 -08003692 * @return true if the device is managed by any device owner.
3693 *
3694 * <p>Requires the MANAGE_USERS permission.
Makoto Onukia52562c2015-10-01 16:12:31 -07003695 *
3696 * @hide
3697 */
Makoto Onukic8a5a552015-11-19 14:29:12 -08003698 public boolean isDeviceManaged() {
3699 return getDeviceOwnerComponentOnAnyUser() != null;
3700 }
3701
3702 /**
3703 * Returns the device owner name. Note this method *will* return the device owner
3704 * name when it's running on a different user.
3705 *
3706 * <p>Requires the MANAGE_USERS permission.
3707 *
3708 * @hide
3709 */
Makoto Onukia2b274b2016-01-19 13:26:02 -08003710 @SystemApi
Makoto Onukic8a5a552015-11-19 14:29:12 -08003711 public String getDeviceOwnerNameOnAnyUser() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003712 throwIfParentInstance("getDeviceOwnerNameOnAnyUser");
Amith Yamasani71e6c692013-03-24 17:39:28 -07003713 if (mService != null) {
3714 try {
Makoto Onukia52562c2015-10-01 16:12:31 -07003715 return mService.getDeviceOwnerName();
Amith Yamasani71e6c692013-03-24 17:39:28 -07003716 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003717 throw re.rethrowFromSystemServer();
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003718 }
3719 }
3720 return null;
3721 }
Adam Connors776c5552014-01-09 10:42:56 +00003722
3723 /**
Julia Reynolds94e7bf62015-06-10 14:44:56 -04003724 * @hide
Craig Lafayettee7ee54e2015-09-21 13:48:53 -04003725 * @deprecated Do not use
3726 * @removed
Julia Reynolds20118f12015-02-11 12:34:08 -05003727 */
Craig Lafayettee7ee54e2015-09-21 13:48:53 -04003728 @Deprecated
Julia Reynolds20118f12015-02-11 12:34:08 -05003729 @SystemApi
3730 public String getDeviceInitializerApp() {
Julia Reynolds20118f12015-02-11 12:34:08 -05003731 return null;
3732 }
3733
3734 /**
Julia Reynoldseaafdf722015-04-02 08:49:47 -04003735 * @hide
Craig Lafayettee7ee54e2015-09-21 13:48:53 -04003736 * @deprecated Do not use
3737 * @removed
Julia Reynoldseaafdf722015-04-02 08:49:47 -04003738 */
Craig Lafayettee7ee54e2015-09-21 13:48:53 -04003739 @Deprecated
Julia Reynoldseaafdf722015-04-02 08:49:47 -04003740 @SystemApi
3741 public ComponentName getDeviceInitializerComponent() {
Julia Reynoldseaafdf722015-04-02 08:49:47 -04003742 return null;
3743 }
3744
Julia Reynolds20118f12015-02-11 12:34:08 -05003745 /**
Adam Connors776c5552014-01-09 10:42:56 +00003746 * @hide
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003747 * @deprecated Use #ACTION_SET_PROFILE_OWNER
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303748 * Sets the given component as an active admin and registers the package as the profile
3749 * owner for this user. The package must already be installed and there shouldn't be
3750 * an existing profile owner registered for this user. Also, this method must be called
3751 * before the user setup has been completed.
3752 * <p>
3753 * This method can only be called by system apps that hold MANAGE_USERS permission and
3754 * MANAGE_DEVICE_ADMINS permission.
3755 * @param admin The component to register as an active admin and profile owner.
3756 * @param ownerName The user-visible name of the entity that is managing this user.
3757 * @return whether the admin was successfully registered as the profile owner.
3758 * @throws IllegalArgumentException if packageName is null, the package isn't installed, or
3759 * the user has already been set up.
3760 */
Justin Morey80440cc2014-07-24 09:16:35 -05003761 @SystemApi
Robin Lee25e26452015-06-02 09:56:29 -07003762 public boolean setActiveProfileOwner(@NonNull ComponentName admin, @Deprecated String ownerName)
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303763 throws IllegalArgumentException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003764 throwIfParentInstance("setActiveProfileOwner");
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303765 if (mService != null) {
3766 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003767 final int myUserId = myUserId();
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303768 mService.setActiveAdmin(admin, false, myUserId);
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003769 return mService.setProfileOwner(admin, ownerName, myUserId);
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303770 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003771 throw re.rethrowFromSystemServer();
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303772 }
3773 }
3774 return false;
3775 }
3776
3777 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003778 * Clears the active profile owner and removes all user restrictions. The caller must be from
3779 * the same package as the active profile owner for this user, otherwise a SecurityException
3780 * will be thrown.
3781 * <p>
3782 * This doesn't work for managed profile owners.
Makoto Onuki5bf68022016-01-27 13:49:19 -08003783 *
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003784 * @param admin The component to remove as the profile owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003785 * @throws SecurityException if {@code admin} is not an active profile owner.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003786 */
Robin Lee25e26452015-06-02 09:56:29 -07003787 public void clearProfileOwner(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003788 throwIfParentInstance("clearProfileOwner");
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003789 if (mService != null) {
3790 try {
3791 mService.clearProfileOwner(admin);
3792 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003793 throw re.rethrowFromSystemServer();
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003794 }
3795 }
3796 }
3797
3798 /**
Julia Reynoldse9254402015-02-11 12:34:08 -05003799 * @hide
Robin Lee25e26452015-06-02 09:56:29 -07003800 * Checks whether the user was already setup.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003801 */
3802 public boolean hasUserSetupCompleted() {
3803 if (mService != null) {
3804 try {
3805 return mService.hasUserSetupCompleted();
3806 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003807 throw re.rethrowFromSystemServer();
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003808 }
3809 }
3810 return true;
3811 }
3812
3813 /**
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003814 * @hide
3815 * Sets the given component as the profile owner of the given user profile. The package must
Nicolas Prevot28063742015-01-08 15:37:12 +00003816 * already be installed. There must not already be a profile owner for this user.
3817 * Only apps with the MANAGE_PROFILE_AND_DEVICE_OWNERS permission and the shell uid can call
3818 * this method.
3819 * Calling this after the setup phase of the specified user has completed is allowed only if:
3820 * - the caller is SYSTEM_UID.
3821 * - or the caller is the shell uid, and there are no accounts on the specified user.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003822 * @param admin the component name to be registered as profile owner.
3823 * @param ownerName the human readable name of the organisation associated with this DPM.
3824 * @param userHandle the userId to set the profile owner for.
3825 * @return whether the component was successfully registered as the profile owner.
Nicolas Prevot28063742015-01-08 15:37:12 +00003826 * @throws IllegalArgumentException if admin is null, the package isn't installed, or the
3827 * preconditions mentioned are not met.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003828 */
Robin Lee25e26452015-06-02 09:56:29 -07003829 public boolean setProfileOwner(@NonNull ComponentName admin, @Deprecated String ownerName,
Robin Leeddd553f2015-04-30 14:18:22 +01003830 int userHandle) throws IllegalArgumentException {
Adam Connors776c5552014-01-09 10:42:56 +00003831 if (mService != null) {
3832 try {
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003833 if (ownerName == null) {
3834 ownerName = "";
3835 }
3836 return mService.setProfileOwner(admin, ownerName, userHandle);
Adam Connors776c5552014-01-09 10:42:56 +00003837 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003838 throw re.rethrowFromSystemServer();
Adam Connors776c5552014-01-09 10:42:56 +00003839 }
3840 }
3841 return false;
3842 }
3843
3844 /**
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003845 * Sets the device owner information to be shown on the lock screen.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003846 * <p>
3847 * If the device owner information is {@code null} or empty then the device owner info is
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003848 * cleared and the user owner info is shown on the lock screen if it is set.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003849 * <p>
3850 * If the device owner information contains only whitespaces then the message on the lock screen
3851 * will be blank and the user will not be allowed to change it.
3852 * <p>
3853 * If the device owner information needs to be localized, it is the responsibility of the
Benjamin Franz3e8a7092016-01-25 16:19:08 +00003854 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
3855 * and set a new version of this string accordingly.
3856 *
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003857 * @param admin The name of the admin component to check.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003858 * @param info Device owner information which will be displayed instead of the user owner info.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003859 * @throws SecurityException if {@code admin} is not a device owner.
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003860 */
Andrei Stingaceanu16187902016-03-21 15:44:45 +00003861 public void setDeviceOwnerLockScreenInfo(@NonNull ComponentName admin, CharSequence info) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003862 throwIfParentInstance("setDeviceOwnerLockScreenInfo");
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003863 if (mService != null) {
3864 try {
Andrei Stingaceanu16187902016-03-21 15:44:45 +00003865 mService.setDeviceOwnerLockScreenInfo(admin, info);
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003866 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003867 throw re.rethrowFromSystemServer();
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003868 }
3869 }
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003870 }
3871
3872 /**
3873 * @return The device owner information. If it is not set returns {@code null}.
3874 */
Andrei Stingaceanu16187902016-03-21 15:44:45 +00003875 public CharSequence getDeviceOwnerLockScreenInfo() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003876 throwIfParentInstance("getDeviceOwnerLockScreenInfo");
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003877 if (mService != null) {
3878 try {
3879 return mService.getDeviceOwnerLockScreenInfo();
3880 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003881 throw re.rethrowFromSystemServer();
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003882 }
3883 }
3884 return null;
3885 }
3886
3887 /**
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00003888 * Called by device or profile owners to suspend packages for this user.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003889 * <p>
3890 * A suspended package will not be able to start activities. Its notifications will be hidden,
3891 * it will not show up in recents, will not be able to show toasts or dialogs or ring the
3892 * device.
3893 * <p>
3894 * The package must already be installed. If the package is uninstalled while suspended the
3895 * package will no longer be suspended. The admin can block this by using
Kenny Guy871f3eb2016-03-09 20:06:16 +00003896 * {@link #setUninstallBlocked}.
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003897 *
3898 * @param admin The name of the admin component to check.
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00003899 * @param packageNames The package names to suspend or unsuspend.
3900 * @param suspended If set to {@code true} than the packages will be suspended, if set to
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003901 * {@code false} the packages will be unsuspended.
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00003902 * @return an array of package names for which the suspended status is not set as requested in
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003903 * this method.
3904 * @throws SecurityException if {@code admin} is not a device or profile owner.
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003905 */
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00003906 public String[] setPackagesSuspended(@NonNull ComponentName admin, String[] packageNames,
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003907 boolean suspended) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003908 throwIfParentInstance("setPackagesSuspended");
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003909 if (mService != null) {
3910 try {
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00003911 return mService.setPackagesSuspended(admin, packageNames, suspended);
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003912 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003913 throw re.rethrowFromSystemServer();
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003914 }
3915 }
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00003916 return packageNames;
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003917 }
3918
3919 /**
3920 * Called by device or profile owners to determine if a package is suspended.
3921 *
3922 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3923 * @param packageName The name of the package to retrieve the suspended status of.
Andrei Stingaceanu355b2322016-02-12 16:43:51 +00003924 * @return {@code true} if the package is suspended or {@code false} if the package is not
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003925 * suspended, could not be found or an error occurred.
3926 * @throws SecurityException if {@code admin} is not a device or profile owner.
Andrei Stingaceanuefc4a342016-03-22 14:43:01 +00003927 * @throws NameNotFoundException if the package could not be found.
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003928 */
Andrei Stingaceanuefc4a342016-03-22 14:43:01 +00003929 public boolean isPackageSuspended(@NonNull ComponentName admin, String packageName)
3930 throws NameNotFoundException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003931 throwIfParentInstance("isPackageSuspended");
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003932 if (mService != null) {
3933 try {
Andrei Stingaceanuefc4a342016-03-22 14:43:01 +00003934 return mService.isPackageSuspended(admin, packageName);
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003935 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003936 throw e.rethrowFromSystemServer();
Andrei Stingaceanuefc4a342016-03-22 14:43:01 +00003937 } catch (IllegalArgumentException ex) {
3938 throw new NameNotFoundException(packageName);
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003939 }
3940 }
3941 return false;
3942 }
3943
3944 /**
Alexandra Gherghina512675b2014-04-02 11:23:54 +01003945 * Sets the enabled state of the profile. A profile should be enabled only once it is ready to
3946 * be used. Only the profile owner can call this.
3947 *
Alexandra Gherghinadf35d572014-04-09 13:54:39 +01003948 * @see #isProfileOwnerApp
Alexandra Gherghina512675b2014-04-02 11:23:54 +01003949 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003950 * @throws SecurityException if {@code admin} is not a profile owner.
Alexandra Gherghina512675b2014-04-02 11:23:54 +01003951 */
Robin Lee25e26452015-06-02 09:56:29 -07003952 public void setProfileEnabled(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003953 throwIfParentInstance("setProfileEnabled");
Alexandra Gherghina512675b2014-04-02 11:23:54 +01003954 if (mService != null) {
3955 try {
3956 mService.setProfileEnabled(admin);
3957 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003958 throw e.rethrowFromSystemServer();
Alexandra Gherghina512675b2014-04-02 11:23:54 +01003959 }
3960 }
3961 }
3962
3963 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003964 * Sets the name of the profile. In the device owner case it sets the name of the user which it
3965 * is called from. Only a profile owner or device owner can call this. If this is never called
3966 * by the profile or device owner, the name will be set to default values.
Jessica Hummel1333ea12014-06-23 11:20:10 +01003967 *
3968 * @see #isProfileOwnerApp
3969 * @see #isDeviceOwnerApp
Robin Lee25e26452015-06-02 09:56:29 -07003970 * @param admin Which {@link DeviceAdminReceiver} this request is associate with.
Jessica Hummel1333ea12014-06-23 11:20:10 +01003971 * @param profileName The name of the profile.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003972 * @throws SecurityException if {@code admin} is not a device or profile owner.
Jessica Hummel1333ea12014-06-23 11:20:10 +01003973 */
Robin Lee25e26452015-06-02 09:56:29 -07003974 public void setProfileName(@NonNull ComponentName admin, String profileName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003975 throwIfParentInstance("setProfileName");
Jessica Hummel1333ea12014-06-23 11:20:10 +01003976 if (mService != null) {
3977 try {
Robin Lee25e26452015-06-02 09:56:29 -07003978 mService.setProfileName(admin, profileName);
Fyodor Kupolov78f13142015-05-27 16:52:45 -07003979 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003980 throw e.rethrowFromSystemServer();
Fyodor Kupolov78f13142015-05-27 16:52:45 -07003981 }
Jessica Hummel1333ea12014-06-23 11:20:10 +01003982 }
3983 }
Jessica Hummel1333ea12014-06-23 11:20:10 +01003984
3985 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07003986 * Used to determine if a particular package is registered as the profile owner for the
Makoto Onuki32b30572015-12-11 14:29:51 -08003987 * user. A profile owner is a special device admin that has additional privileges
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07003988 * within the profile.
Adam Connors776c5552014-01-09 10:42:56 +00003989 *
3990 * @param packageName The package name of the app to compare with the registered profile owner.
3991 * @return Whether or not the package is registered as the profile owner.
3992 */
3993 public boolean isProfileOwnerApp(String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01003994 throwIfParentInstance("isProfileOwnerApp");
Adam Connors776c5552014-01-09 10:42:56 +00003995 if (mService != null) {
3996 try {
Makoto Onuki90b89652016-01-28 14:44:18 -08003997 ComponentName profileOwner = mService.getProfileOwner(myUserId());
Nicolas Prevot90af6d72014-07-30 14:19:12 +01003998 return profileOwner != null
3999 && profileOwner.getPackageName().equals(packageName);
Adam Connors776c5552014-01-09 10:42:56 +00004000 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004001 throw re.rethrowFromSystemServer();
Adam Connors776c5552014-01-09 10:42:56 +00004002 }
4003 }
4004 return false;
4005 }
4006
4007 /**
4008 * @hide
Robin Lee25e26452015-06-02 09:56:29 -07004009 * @return the packageName of the owner of the given user profile or {@code null} if no profile
Adam Connors776c5552014-01-09 10:42:56 +00004010 * owner has been set for that user.
4011 * @throws IllegalArgumentException if the userId is invalid.
4012 */
Nicolas Prevot465acf32014-08-06 17:03:25 +01004013 @SystemApi
Amith Yamasanibf3a9462014-07-28 14:26:42 -07004014 public ComponentName getProfileOwner() throws IllegalArgumentException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004015 throwIfParentInstance("getProfileOwner");
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01004016 return getProfileOwnerAsUser(Process.myUserHandle().getIdentifier());
4017 }
4018
4019 /**
4020 * @see #getProfileOwner()
4021 * @hide
4022 */
4023 public ComponentName getProfileOwnerAsUser(final int userId) throws IllegalArgumentException {
Adam Connors776c5552014-01-09 10:42:56 +00004024 if (mService != null) {
4025 try {
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01004026 return mService.getProfileOwner(userId);
Adam Connors776c5552014-01-09 10:42:56 +00004027 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004028 throw re.rethrowFromSystemServer();
Adam Connors776c5552014-01-09 10:42:56 +00004029 }
4030 }
4031 return null;
4032 }
4033
4034 /**
4035 * @hide
Robin Lee25e26452015-06-02 09:56:29 -07004036 * @return the human readable name of the organisation associated with this DPM or {@code null}
4037 * if one is not set.
Adam Connors776c5552014-01-09 10:42:56 +00004038 * @throws IllegalArgumentException if the userId is invalid.
4039 */
4040 public String getProfileOwnerName() throws IllegalArgumentException {
4041 if (mService != null) {
4042 try {
4043 return mService.getProfileOwnerName(Process.myUserHandle().getIdentifier());
4044 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004045 throw re.rethrowFromSystemServer();
Adam Connors776c5552014-01-09 10:42:56 +00004046 }
4047 }
4048 return null;
4049 }
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004050
4051 /**
Amith Yamasani38f836b2014-08-20 14:51:15 -07004052 * @hide
Makoto Onukic8a5a552015-11-19 14:29:12 -08004053 * @param userId The user for whom to fetch the profile owner name, if any.
Amith Yamasani38f836b2014-08-20 14:51:15 -07004054 * @return the human readable name of the organisation associated with this profile owner or
4055 * null if one is not set.
4056 * @throws IllegalArgumentException if the userId is invalid.
4057 */
4058 @SystemApi
Selim Cinek24ac55e2014-08-27 12:51:45 +02004059 public String getProfileOwnerNameAsUser(int userId) throws IllegalArgumentException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004060 throwIfParentInstance("getProfileOwnerNameAsUser");
Amith Yamasani38f836b2014-08-20 14:51:15 -07004061 if (mService != null) {
4062 try {
Selim Cinek24ac55e2014-08-27 12:51:45 +02004063 return mService.getProfileOwnerName(userId);
Amith Yamasani38f836b2014-08-20 14:51:15 -07004064 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004065 throw re.rethrowFromSystemServer();
Amith Yamasani38f836b2014-08-20 14:51:15 -07004066 }
4067 }
4068 return null;
4069 }
4070
4071 /**
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004072 * Called by a profile owner or device owner to add a default intent handler activity for
4073 * intents that match a certain intent filter. This activity will remain the default intent
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004074 * handler even if the set of potential event handlers for the intent filter changes and if the
4075 * intent preferences are reset.
4076 * <p>
4077 * The default disambiguation mechanism takes over if the activity is not installed (anymore).
4078 * When the activity is (re)installed, it is automatically reset as default intent handler for
4079 * the filter.
4080 * <p>
4081 * The calling device admin must be a profile owner or device owner. If it is not, a security
4082 * exception will be thrown.
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004083 *
4084 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4085 * @param filter The IntentFilter for which a default handler is added.
4086 * @param activity The Activity that is added as default intent handler.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004087 * @throws SecurityException if {@code admin} is not a device or profile owner.
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004088 */
Robin Lee25e26452015-06-02 09:56:29 -07004089 public void addPersistentPreferredActivity(@NonNull ComponentName admin, IntentFilter filter,
4090 @NonNull ComponentName activity) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004091 throwIfParentInstance("addPersistentPreferredActivity");
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004092 if (mService != null) {
4093 try {
4094 mService.addPersistentPreferredActivity(admin, filter, activity);
4095 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004096 throw e.rethrowFromSystemServer();
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004097 }
4098 }
4099 }
4100
4101 /**
4102 * Called by a profile owner or device owner to remove all persistent intent handler preferences
Torne (Richard Coles)875e2102014-02-24 14:11:56 +00004103 * associated with the given package that were set by {@link #addPersistentPreferredActivity}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004104 * <p>
4105 * The calling device admin must be a profile owner. If it is not, a security exception will be
4106 * thrown.
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004107 *
4108 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4109 * @param packageName The name of the package for which preferences are removed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004110 * @throws SecurityException if {@code admin} is not a device or profile owner.
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004111 */
Robin Lee25e26452015-06-02 09:56:29 -07004112 public void clearPackagePersistentPreferredActivities(@NonNull ComponentName admin,
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004113 String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004114 throwIfParentInstance("clearPackagePersistentPreferredActivities");
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004115 if (mService != null) {
4116 try {
4117 mService.clearPackagePersistentPreferredActivities(admin, packageName);
4118 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004119 throw e.rethrowFromSystemServer();
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004120 }
4121 }
4122 }
Robin Lee66e5d962014-04-09 16:44:21 +01004123
4124 /**
Esteban Talaverabf60f722015-12-10 16:26:44 +00004125 * Called by a profile owner or device owner to grant permission to a package to manage
4126 * application restrictions for the calling user via {@link #setApplicationRestrictions} and
4127 * {@link #getApplicationRestrictions}.
4128 * <p>
4129 * This permission is persistent until it is later cleared by calling this method with a
4130 * {@code null} value or uninstalling the managing package.
Rubin Xuf03d0a62016-02-10 14:54:15 +00004131 * <p>
4132 * The supplied application restriction managing package must be installed when calling this
Victor Changcd14c0a2016-03-16 19:10:15 +00004133 * API, otherwise an {@link NameNotFoundException} will be thrown.
Esteban Talaverabf60f722015-12-10 16:26:44 +00004134 *
4135 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4136 * @param packageName The package name which will be given access to application restrictions
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004137 * APIs. If {@code null} is given the current package will be cleared.
4138 * @throws SecurityException if {@code admin} is not a device or profile owner.
Victor Changcd14c0a2016-03-16 19:10:15 +00004139 * @throws NameNotFoundException if {@code packageName} is not found
Esteban Talaverabf60f722015-12-10 16:26:44 +00004140 */
4141 public void setApplicationRestrictionsManagingPackage(@NonNull ComponentName admin,
Victor Changcd14c0a2016-03-16 19:10:15 +00004142 @Nullable String packageName) throws NameNotFoundException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004143 throwIfParentInstance("setApplicationRestrictionsManagingPackage");
Esteban Talaverabf60f722015-12-10 16:26:44 +00004144 if (mService != null) {
4145 try {
Victor Changcd14c0a2016-03-16 19:10:15 +00004146 if (!mService.setApplicationRestrictionsManagingPackage(admin, packageName)) {
4147 throw new NameNotFoundException(packageName);
4148 }
Esteban Talaverabf60f722015-12-10 16:26:44 +00004149 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004150 throw e.rethrowFromSystemServer();
Esteban Talaverabf60f722015-12-10 16:26:44 +00004151 }
4152 }
4153 }
4154
4155 /**
4156 * Called by a profile owner or device owner to retrieve the application restrictions managing
4157 * package for the current user, or {@code null} if none is set.
4158 *
4159 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4160 * @return The package name allowed to manage application restrictions on the current user, or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004161 * {@code null} if none is set.
4162 * @throws SecurityException if {@code admin} is not a device or profile owner.
Esteban Talaverabf60f722015-12-10 16:26:44 +00004163 */
4164 public String getApplicationRestrictionsManagingPackage(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004165 throwIfParentInstance("getApplicationRestrictionsManagingPackage");
Esteban Talaverabf60f722015-12-10 16:26:44 +00004166 if (mService != null) {
4167 try {
4168 return mService.getApplicationRestrictionsManagingPackage(admin);
4169 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004170 throw e.rethrowFromSystemServer();
Esteban Talaverabf60f722015-12-10 16:26:44 +00004171 }
4172 }
4173 return null;
4174 }
4175
4176 /**
Esteban Talavera96895ca2016-03-16 12:00:40 +00004177 * Called by any application to find out whether it has been granted permission via
4178 * {@link #setApplicationRestrictionsManagingPackage} to manage application restrictions
4179 * for the calling user.
4180 *
4181 * <p>This is done by comparing the calling Linux uid with the uid of the package specified by
4182 * that method.
Esteban Talaverabf60f722015-12-10 16:26:44 +00004183 */
4184 public boolean isCallerApplicationRestrictionsManagingPackage() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004185 throwIfParentInstance("isCallerApplicationRestrictionsManagingPackage");
Esteban Talaverabf60f722015-12-10 16:26:44 +00004186 if (mService != null) {
4187 try {
4188 return mService.isCallerApplicationRestrictionsManagingPackage();
4189 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004190 throw e.rethrowFromSystemServer();
Esteban Talaverabf60f722015-12-10 16:26:44 +00004191 }
4192 }
4193 return false;
4194 }
4195
4196 /**
4197 * Sets the application restrictions for a given target application running in the calling user.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004198 * <p>
4199 * The caller must be a profile or device owner on that user, or the package allowed to manage
4200 * application restrictions via {@link #setApplicationRestrictionsManagingPackage}; otherwise a
4201 * security exception will be thrown.
4202 * <p>
4203 * The provided {@link Bundle} consists of key-value pairs, where the types of values may be:
Esteban Talavera6b8e0642015-08-10 17:26:04 +01004204 * <ul>
4205 * <li>{@code boolean}
4206 * <li>{@code int}
4207 * <li>{@code String} or {@code String[]}
4208 * <li>From {@link android.os.Build.VERSION_CODES#M}, {@code Bundle} or {@code Bundle[]}
4209 * </ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004210 * <p>
4211 * If the restrictions are not available yet, but may be applied in the near future, the caller
4212 * can notify the target application of that by adding
Sander Alewijnse53d63dc2014-11-07 21:43:00 +00004213 * {@link UserManager#KEY_RESTRICTIONS_PENDING} to the settings parameter.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004214 * <p>
4215 * The application restrictions are only made visible to the target application via
4216 * {@link UserManager#getApplicationRestrictions(String)}, in addition to the profile or device
4217 * owner, and the application restrictions managing package via
Esteban Talaverabf60f722015-12-10 16:26:44 +00004218 * {@link #getApplicationRestrictions}.
Robin Lee66e5d962014-04-09 16:44:21 +01004219 *
Esteban Talaverabf60f722015-12-10 16:26:44 +00004220 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004221 * {@code null} if called by the application restrictions managing package.
Robin Lee66e5d962014-04-09 16:44:21 +01004222 * @param packageName The name of the package to update restricted settings for.
4223 * @param settings A {@link Bundle} to be parsed by the receiving application, conveying a new
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004224 * set of active restrictions.
4225 * @throws SecurityException if {@code admin} is not a device or profile owner.
Esteban Talaverabf60f722015-12-10 16:26:44 +00004226 * @see #setApplicationRestrictionsManagingPackage
Sander Alewijnse53d63dc2014-11-07 21:43:00 +00004227 * @see UserManager#KEY_RESTRICTIONS_PENDING
Robin Lee66e5d962014-04-09 16:44:21 +01004228 */
Esteban Talaverabf60f722015-12-10 16:26:44 +00004229 public void setApplicationRestrictions(@Nullable ComponentName admin, String packageName,
Robin Lee66e5d962014-04-09 16:44:21 +01004230 Bundle settings) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004231 throwIfParentInstance("setApplicationRestrictions");
Robin Lee66e5d962014-04-09 16:44:21 +01004232 if (mService != null) {
4233 try {
4234 mService.setApplicationRestrictions(admin, packageName, settings);
4235 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004236 throw e.rethrowFromSystemServer();
Robin Lee66e5d962014-04-09 16:44:21 +01004237 }
4238 }
4239 }
4240
4241 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004242 * Sets a list of configuration features to enable for a TrustAgent component. This is meant to
4243 * be used in conjunction with {@link #KEYGUARD_DISABLE_TRUST_AGENTS}, which disables all trust
4244 * agents but those enabled by this function call. If flag
Jim Millere303bf42014-08-26 17:12:29 -07004245 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} is not set, then this call has no effect.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004246 * <p>
4247 * The calling device admin must have requested
4248 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES} to be able to call this method;
4249 * if not, a security exception will be thrown.
Tony Mak089d8402016-04-05 17:42:55 +01004250 * <p>
4251 * This method can be called on the {@link DevicePolicyManager} instance returned by
4252 * {@link #getParentProfileInstance(ComponentName)} in order to set the configuration for
4253 * the parent profile.
Jim Miller604e7552014-07-18 19:00:02 -07004254 *
4255 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Jim Millere303bf42014-08-26 17:12:29 -07004256 * @param target Component name of the agent to be enabled.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004257 * @param configuration TrustAgent-specific feature bundle. If null for any admin, agent will be
4258 * strictly disabled according to the state of the
4259 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} flag.
4260 * <p>
4261 * If {@link #KEYGUARD_DISABLE_TRUST_AGENTS} is set and options is not null for all
4262 * admins, then it's up to the TrustAgent itself to aggregate the values from all
4263 * device admins.
4264 * <p>
4265 * Consult documentation for the specific TrustAgent to determine legal options
4266 * parameters.
4267 * @throws SecurityException if {@code admin} is not an active administrator or does not use
4268 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES}
Jim Miller604e7552014-07-18 19:00:02 -07004269 */
Robin Lee25e26452015-06-02 09:56:29 -07004270 public void setTrustAgentConfiguration(@NonNull ComponentName admin,
4271 @NonNull ComponentName target, PersistableBundle configuration) {
Jim Miller604e7552014-07-18 19:00:02 -07004272 if (mService != null) {
4273 try {
Tony Mak089d8402016-04-05 17:42:55 +01004274 mService.setTrustAgentConfiguration(admin, target, configuration, mParentInstance);
Jim Miller604e7552014-07-18 19:00:02 -07004275 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004276 throw e.rethrowFromSystemServer();
Jim Miller604e7552014-07-18 19:00:02 -07004277 }
4278 }
4279 }
4280
4281 /**
Jim Millere303bf42014-08-26 17:12:29 -07004282 * Gets configuration for the given trust agent based on aggregating all calls to
4283 * {@link #setTrustAgentConfiguration(ComponentName, ComponentName, PersistableBundle)} for
4284 * all device admins.
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 retrieve the configuration set
4288 * on the parent profile.
Jim Miller604e7552014-07-18 19:00:02 -07004289 *
Jim Millerb5db57a2015-01-14 18:17:19 -08004290 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. If null,
4291 * this function returns a list of configurations for all admins that declare
4292 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS}. If any admin declares
4293 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} but doesn't call
4294 * {@link #setTrustAgentConfiguration(ComponentName, ComponentName, PersistableBundle)}
4295 * for this {@param agent} or calls it with a null configuration, null is returned.
Jim Miller604e7552014-07-18 19:00:02 -07004296 * @param agent Which component to get enabled features for.
Jim Millere303bf42014-08-26 17:12:29 -07004297 * @return configuration for the given trust agent.
Jim Miller604e7552014-07-18 19:00:02 -07004298 */
Robin Lee25e26452015-06-02 09:56:29 -07004299 public List<PersistableBundle> getTrustAgentConfiguration(@Nullable ComponentName admin,
4300 @NonNull ComponentName agent) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07004301 return getTrustAgentConfiguration(admin, agent, myUserId());
Jim Millere303bf42014-08-26 17:12:29 -07004302 }
4303
4304 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07004305 public List<PersistableBundle> getTrustAgentConfiguration(@Nullable ComponentName admin,
4306 @NonNull ComponentName agent, int userHandle) {
Jim Miller604e7552014-07-18 19:00:02 -07004307 if (mService != null) {
4308 try {
Tony Mak089d8402016-04-05 17:42:55 +01004309 return mService.getTrustAgentConfiguration(admin, agent, userHandle,
4310 mParentInstance);
Jim Miller604e7552014-07-18 19:00:02 -07004311 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004312 throw e.rethrowFromSystemServer();
Jim Miller604e7552014-07-18 19:00:02 -07004313 }
4314 }
Jim Millere303bf42014-08-26 17:12:29 -07004315 return new ArrayList<PersistableBundle>(); // empty list
Jim Miller604e7552014-07-18 19:00:02 -07004316 }
4317
4318 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004319 * Called by a profile owner of a managed profile to set whether caller-Id information from the
4320 * managed profile will be shown in the parent profile, for incoming calls.
4321 * <p>
4322 * The calling device admin must be a profile owner. If it is not, a security exception will be
4323 * thrown.
Adam Connors210fe212014-07-17 15:41:43 +01004324 *
Robin Lee25e26452015-06-02 09:56:29 -07004325 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Adam Connors210fe212014-07-17 15:41:43 +01004326 * @param disabled If true caller-Id information in the managed profile is not displayed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004327 * @throws SecurityException if {@code admin} is not a device or profile owner.
Adam Connors210fe212014-07-17 15:41:43 +01004328 */
Robin Lee25e26452015-06-02 09:56:29 -07004329 public void setCrossProfileCallerIdDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004330 throwIfParentInstance("setCrossProfileCallerIdDisabled");
Adam Connors210fe212014-07-17 15:41:43 +01004331 if (mService != null) {
4332 try {
Robin Lee25e26452015-06-02 09:56:29 -07004333 mService.setCrossProfileCallerIdDisabled(admin, disabled);
Adam Connors210fe212014-07-17 15:41:43 +01004334 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004335 throw e.rethrowFromSystemServer();
Adam Connors210fe212014-07-17 15:41:43 +01004336 }
4337 }
4338 }
4339
4340 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07004341 * Called by a profile owner of a managed profile to determine whether or not caller-Id
4342 * information has been disabled.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004343 * <p>
4344 * The calling device admin must be a profile owner. If it is not, a security exception will be
4345 * thrown.
Adam Connors210fe212014-07-17 15:41:43 +01004346 *
Robin Lee25e26452015-06-02 09:56:29 -07004347 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004348 * @throws SecurityException if {@code admin} is not a device or profile owner.
Adam Connors210fe212014-07-17 15:41:43 +01004349 */
Robin Lee25e26452015-06-02 09:56:29 -07004350 public boolean getCrossProfileCallerIdDisabled(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004351 throwIfParentInstance("getCrossProfileCallerIdDisabled");
Adam Connors210fe212014-07-17 15:41:43 +01004352 if (mService != null) {
4353 try {
Robin Lee25e26452015-06-02 09:56:29 -07004354 return mService.getCrossProfileCallerIdDisabled(admin);
Adam Connors210fe212014-07-17 15:41:43 +01004355 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004356 throw e.rethrowFromSystemServer();
Adam Connors210fe212014-07-17 15:41:43 +01004357 }
4358 }
4359 return false;
4360 }
4361
4362 /**
Amith Yamasani570002f2014-07-18 15:48:54 -07004363 * Determine whether or not caller-Id information has been disabled.
4364 *
4365 * @param userHandle The user for whom to check the caller-id permission
4366 * @hide
4367 */
4368 public boolean getCrossProfileCallerIdDisabled(UserHandle userHandle) {
4369 if (mService != null) {
4370 try {
4371 return mService.getCrossProfileCallerIdDisabledForUser(userHandle.getIdentifier());
4372 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004373 throw e.rethrowFromSystemServer();
Amith Yamasani570002f2014-07-18 15:48:54 -07004374 }
4375 }
4376 return false;
4377 }
4378
4379 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004380 * Called by a profile owner of a managed profile to set whether contacts search from the
4381 * managed profile will be shown in the parent profile, for incoming calls.
4382 * <p>
4383 * The calling device admin must be a profile owner. If it is not, a security exception will be
4384 * thrown.
Victor Chang1060c6182016-01-04 20:16:23 +00004385 *
4386 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4387 * @param disabled If true contacts search in the managed profile is not displayed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004388 * @throws SecurityException if {@code admin} is not a device or profile owner.
Victor Chang1060c6182016-01-04 20:16:23 +00004389 */
4390 public void setCrossProfileContactsSearchDisabled(@NonNull ComponentName admin,
4391 boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004392 throwIfParentInstance("setCrossProfileContactsSearchDisabled");
Victor Chang1060c6182016-01-04 20:16:23 +00004393 if (mService != null) {
4394 try {
4395 mService.setCrossProfileContactsSearchDisabled(admin, disabled);
4396 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004397 throw e.rethrowFromSystemServer();
Victor Chang1060c6182016-01-04 20:16:23 +00004398 }
4399 }
4400 }
4401
4402 /**
4403 * Called by a profile owner of a managed profile to determine whether or not contacts search
4404 * has been disabled.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004405 * <p>
4406 * The calling device admin must be a profile owner. If it is not, a security exception will be
4407 * thrown.
Victor Chang1060c6182016-01-04 20:16:23 +00004408 *
4409 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004410 * @throws SecurityException if {@code admin} is not a device or profile owner.
Victor Chang1060c6182016-01-04 20:16:23 +00004411 */
4412 public boolean getCrossProfileContactsSearchDisabled(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004413 throwIfParentInstance("getCrossProfileContactsSearchDisabled");
Victor Chang1060c6182016-01-04 20:16:23 +00004414 if (mService != null) {
4415 try {
4416 return mService.getCrossProfileContactsSearchDisabled(admin);
4417 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004418 throw e.rethrowFromSystemServer();
Victor Chang1060c6182016-01-04 20:16:23 +00004419 }
4420 }
4421 return false;
4422 }
4423
4424
4425 /**
4426 * Determine whether or not contacts search has been disabled.
4427 *
4428 * @param userHandle The user for whom to check the contacts search permission
4429 * @hide
4430 */
4431 public boolean getCrossProfileContactsSearchDisabled(@NonNull UserHandle userHandle) {
4432 if (mService != null) {
4433 try {
4434 return mService
4435 .getCrossProfileContactsSearchDisabledForUser(userHandle.getIdentifier());
4436 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004437 throw e.rethrowFromSystemServer();
Victor Chang1060c6182016-01-04 20:16:23 +00004438 }
4439 }
4440 return false;
4441 }
4442
4443 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08004444 * Start Quick Contact on the managed profile for the user, if the policy allows.
Victor Chang97bdacc2016-01-21 22:24:11 +00004445 *
Makoto Onuki1040da12015-03-19 11:24:00 -07004446 * @hide
4447 */
4448 public void startManagedQuickContact(String actualLookupKey, long actualContactId,
Victor Chang97bdacc2016-01-21 22:24:11 +00004449 boolean isContactIdIgnored, long directoryId, Intent originalIntent) {
Makoto Onuki1040da12015-03-19 11:24:00 -07004450 if (mService != null) {
4451 try {
Victor Chang97bdacc2016-01-21 22:24:11 +00004452 mService.startManagedQuickContact(actualLookupKey, actualContactId,
4453 isContactIdIgnored, directoryId, originalIntent);
Makoto Onuki1040da12015-03-19 11:24:00 -07004454 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004455 throw e.rethrowFromSystemServer();
Makoto Onuki1040da12015-03-19 11:24:00 -07004456 }
4457 }
4458 }
4459
4460 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08004461 * Start Quick Contact on the managed profile for the user, if the policy allows.
Ricky Wai494b95d2015-11-20 16:07:15 +00004462 * @hide
4463 */
4464 public void startManagedQuickContact(String actualLookupKey, long actualContactId,
4465 Intent originalIntent) {
Victor Chang97bdacc2016-01-21 22:24:11 +00004466 startManagedQuickContact(actualLookupKey, actualContactId, false, Directory.DEFAULT,
Ricky Wai494b95d2015-11-20 16:07:15 +00004467 originalIntent);
4468 }
4469
4470 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004471 * Called by a profile owner of a managed profile to set whether bluetooth devices can access
4472 * enterprise contacts.
Ricky Wai778ba132015-03-31 14:21:22 +01004473 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004474 * The calling device admin must be a profile owner. If it is not, a security exception will be
4475 * thrown.
Ricky Wai778ba132015-03-31 14:21:22 +01004476 * <p>
4477 * This API works on managed profile only.
4478 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004479 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4480 * @param disabled If true, bluetooth devices cannot access enterprise contacts.
4481 * @throws SecurityException if {@code admin} is not a device or profile owner.
Ricky Wai778ba132015-03-31 14:21:22 +01004482 */
Robin Lee25e26452015-06-02 09:56:29 -07004483 public void setBluetoothContactSharingDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004484 throwIfParentInstance("setBluetoothContactSharingDisabled");
Ricky Wai778ba132015-03-31 14:21:22 +01004485 if (mService != null) {
4486 try {
Robin Lee25e26452015-06-02 09:56:29 -07004487 mService.setBluetoothContactSharingDisabled(admin, disabled);
Ricky Wai778ba132015-03-31 14:21:22 +01004488 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004489 throw e.rethrowFromSystemServer();
Ricky Wai778ba132015-03-31 14:21:22 +01004490 }
4491 }
4492 }
4493
4494 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004495 * Called by a profile owner of a managed profile to determine whether or not Bluetooth devices
4496 * cannot access enterprise contacts.
Ricky Wai778ba132015-03-31 14:21:22 +01004497 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004498 * The calling device admin must be a profile owner. If it is not, a security exception will be
4499 * thrown.
Ricky Wai778ba132015-03-31 14:21:22 +01004500 * <p>
4501 * This API works on managed profile only.
4502 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004503 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4504 * @throws SecurityException if {@code admin} is not a device or profile owner.
Ricky Wai778ba132015-03-31 14:21:22 +01004505 */
Robin Lee25e26452015-06-02 09:56:29 -07004506 public boolean getBluetoothContactSharingDisabled(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004507 throwIfParentInstance("getBluetoothContactSharingDisabled");
Ricky Wai778ba132015-03-31 14:21:22 +01004508 if (mService != null) {
4509 try {
Robin Lee25e26452015-06-02 09:56:29 -07004510 return mService.getBluetoothContactSharingDisabled(admin);
Ricky Wai778ba132015-03-31 14:21:22 +01004511 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004512 throw e.rethrowFromSystemServer();
Ricky Wai778ba132015-03-31 14:21:22 +01004513 }
4514 }
4515 return true;
4516 }
4517
4518 /**
4519 * Determine whether or not Bluetooth devices cannot access contacts.
4520 * <p>
4521 * This API works on managed profile UserHandle only.
4522 *
4523 * @param userHandle The user for whom to check the caller-id permission
4524 * @hide
4525 */
4526 public boolean getBluetoothContactSharingDisabled(UserHandle userHandle) {
4527 if (mService != null) {
4528 try {
4529 return mService.getBluetoothContactSharingDisabledForUser(userHandle
4530 .getIdentifier());
4531 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004532 throw e.rethrowFromSystemServer();
Ricky Wai778ba132015-03-31 14:21:22 +01004533 }
4534 }
4535 return true;
4536 }
4537
4538 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07004539 * Called by the profile owner of a managed profile so that some intents sent in the managed
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004540 * profile can also be resolved in the parent, or vice versa. Only activity intents are
4541 * supported.
Nicolas Prevotfc7b4442014-12-17 15:28:29 +00004542 *
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004543 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Nicolas Prevot81948992014-05-16 18:25:26 +01004544 * @param filter The {@link IntentFilter} the intent has to match to be also resolved in the
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004545 * other profile
Nicolas Prevot41d926e2014-06-09 11:48:56 +01004546 * @param flags {@link DevicePolicyManager#FLAG_MANAGED_CAN_ACCESS_PARENT} and
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004547 * {@link DevicePolicyManager#FLAG_PARENT_CAN_ACCESS_MANAGED} are supported.
4548 * @throws SecurityException if {@code admin} is not a device or profile owner.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004549 */
Robin Lee25e26452015-06-02 09:56:29 -07004550 public void addCrossProfileIntentFilter(@NonNull ComponentName admin, IntentFilter filter, int flags) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004551 throwIfParentInstance("addCrossProfileIntentFilter");
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004552 if (mService != null) {
4553 try {
Nicolas Prevot81948992014-05-16 18:25:26 +01004554 mService.addCrossProfileIntentFilter(admin, filter, flags);
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004555 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004556 throw e.rethrowFromSystemServer();
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004557 }
4558 }
4559 }
4560
4561 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07004562 * Called by a profile owner of a managed profile to remove the cross-profile intent filters
4563 * that go from the managed profile to the parent, or from the parent to the managed profile.
Nicolas Prevot3f7777f2014-07-24 15:58:39 +01004564 * Only removes those that have been set by the profile owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004565 *
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004566 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004567 * @throws SecurityException if {@code admin} is not a device or profile owner.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004568 */
Robin Lee25e26452015-06-02 09:56:29 -07004569 public void clearCrossProfileIntentFilters(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004570 throwIfParentInstance("clearCrossProfileIntentFilters");
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004571 if (mService != null) {
4572 try {
Nicolas Prevot81948992014-05-16 18:25:26 +01004573 mService.clearCrossProfileIntentFilters(admin);
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004574 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004575 throw e.rethrowFromSystemServer();
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004576 }
4577 }
4578 }
4579
4580 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004581 * Called by a profile or device owner to set the permitted accessibility services. When set by
4582 * a device owner or profile owner the restriction applies to all profiles of the user the
4583 * device owner or profile owner is an admin for. By default the user can use any accessiblity
4584 * service. When zero or more packages have been added, accessiblity services that are not in
4585 * the list and not part of the system can not be enabled by the user.
4586 * <p>
4587 * Calling with a null value for the list disables the restriction so that all services can be
4588 * used, calling with an empty list only allows the builtin system's services.
4589 * <p>
4590 * System accesibility services are always available to the user the list can't modify this.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004591 *
4592 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4593 * @param packageNames List of accessibility service package names.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004594 * @return true if setting the restriction succeeded. It fail if there is one or more non-system
4595 * accessibility services enabled, that are not in the list.
4596 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004597 */
Robin Lee25e26452015-06-02 09:56:29 -07004598 public boolean setPermittedAccessibilityServices(@NonNull ComponentName admin,
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004599 List<String> packageNames) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004600 throwIfParentInstance("setPermittedAccessibilityServices");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004601 if (mService != null) {
4602 try {
4603 return mService.setPermittedAccessibilityServices(admin, packageNames);
4604 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004605 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004606 }
4607 }
4608 return false;
4609 }
4610
4611 /**
4612 * Returns the list of permitted accessibility services set by this device or profile owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004613 * <p>
4614 * An empty list means no accessibility services except system services are allowed. Null means
4615 * all accessibility services are allowed.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004616 *
4617 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4618 * @return List of accessiblity service package names.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004619 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004620 */
Robin Lee25e26452015-06-02 09:56:29 -07004621 public List<String> getPermittedAccessibilityServices(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004622 throwIfParentInstance("getPermittedAccessibilityServices");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004623 if (mService != null) {
4624 try {
4625 return mService.getPermittedAccessibilityServices(admin);
4626 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004627 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004628 }
4629 }
4630 return null;
4631 }
4632
4633 /**
Sudheer Shanka56925862016-01-28 19:43:59 +00004634 * Called by the system to check if a specific accessibility service is disabled by admin.
4635 *
4636 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4637 * @param packageName Accessibility service package name that needs to be checked.
4638 * @param userHandle user id the admin is running as.
4639 * @return true if the accessibility service is permitted, otherwise false.
4640 *
4641 * @hide
4642 */
4643 public boolean isAccessibilityServicePermittedByAdmin(@NonNull ComponentName admin,
4644 @NonNull String packageName, int userHandle) {
4645 if (mService != null) {
4646 try {
4647 return mService.isAccessibilityServicePermittedByAdmin(admin, packageName,
4648 userHandle);
4649 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004650 throw e.rethrowFromSystemServer();
Sudheer Shanka56925862016-01-28 19:43:59 +00004651 }
4652 }
4653 return false;
4654 }
4655
4656 /**
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004657 * Returns the list of accessibility services permitted by the device or profiles
4658 * owners of this user.
4659 *
4660 * <p>Null means all accessibility services are allowed, if a non-null list is returned
4661 * it will contain the intersection of the permitted lists for any device or profile
4662 * owners that apply to this user. It will also include any system accessibility services.
4663 *
4664 * @param userId which user to check for.
4665 * @return List of accessiblity service package names.
4666 * @hide
4667 */
4668 @SystemApi
4669 public List<String> getPermittedAccessibilityServices(int userId) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004670 throwIfParentInstance("getPermittedAccessibilityServices");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004671 if (mService != null) {
4672 try {
4673 return mService.getPermittedAccessibilityServicesForUser(userId);
4674 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004675 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004676 }
4677 }
4678 return null;
4679 }
4680
4681 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004682 * Called by a profile or device owner to set the permitted input methods services. When set by
4683 * a device owner or profile owner the restriction applies to all profiles of the user the
4684 * device owner or profile owner is an admin for. By default the user can use any input method.
4685 * When zero or more packages have been added, input method that are not in the list and not
4686 * part of the system can not be enabled by the user. This method will fail if it is called for
4687 * a admin that is not for the foreground user or a profile of the foreground user.
4688 * <p>
4689 * Calling with a null value for the list disables the restriction so that all input methods can
4690 * be used, calling with an empty list disables all but the system's own input methods.
4691 * <p>
4692 * System input methods are always available to the user this method can't modify this.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004693 *
4694 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4695 * @param packageNames List of input method package names.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004696 * @return true if setting the restriction succeeded. It will fail if there are one or more
4697 * non-system input methods currently enabled that are not in the packageNames list.
4698 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004699 */
Robin Lee25e26452015-06-02 09:56:29 -07004700 public boolean setPermittedInputMethods(@NonNull ComponentName admin, List<String> packageNames) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004701 throwIfParentInstance("setPermittedInputMethods");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004702 if (mService != null) {
4703 try {
4704 return mService.setPermittedInputMethods(admin, packageNames);
4705 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004706 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004707 }
4708 }
4709 return false;
4710 }
4711
4712
4713 /**
4714 * Returns the list of permitted input methods set by this device or profile owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004715 * <p>
4716 * An empty list means no input methods except system input methods are allowed. Null means all
4717 * input methods are allowed.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004718 *
4719 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4720 * @return List of input method package names.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004721 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004722 */
Robin Lee25e26452015-06-02 09:56:29 -07004723 public List<String> getPermittedInputMethods(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004724 throwIfParentInstance("getPermittedInputMethods");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004725 if (mService != null) {
4726 try {
4727 return mService.getPermittedInputMethods(admin);
4728 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004729 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004730 }
4731 }
4732 return null;
4733 }
4734
4735 /**
Sudheer Shanka56925862016-01-28 19:43:59 +00004736 * Called by the system to check if a specific input method is disabled by admin.
4737 *
4738 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4739 * @param packageName Input method package name that needs to be checked.
4740 * @param userHandle user id the admin is running as.
4741 * @return true if the input method is permitted, otherwise false.
4742 *
4743 * @hide
4744 */
4745 public boolean isInputMethodPermittedByAdmin(@NonNull ComponentName admin,
4746 @NonNull String packageName, int userHandle) {
4747 if (mService != null) {
4748 try {
4749 return mService.isInputMethodPermittedByAdmin(admin, packageName, userHandle);
4750 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004751 throw e.rethrowFromSystemServer();
Sudheer Shanka56925862016-01-28 19:43:59 +00004752 }
4753 }
4754 return false;
4755 }
4756
4757 /**
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004758 * Returns the list of input methods permitted by the device or profiles
Makoto Onuki32b30572015-12-11 14:29:51 -08004759 * owners of the current user. (*Not* calling user, due to a limitation in InputMethodManager.)
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004760 *
4761 * <p>Null means all input methods are allowed, if a non-null list is returned
4762 * it will contain the intersection of the permitted lists for any device or profile
4763 * owners that apply to this user. It will also include any system input methods.
4764 *
4765 * @return List of input method package names.
4766 * @hide
4767 */
4768 @SystemApi
4769 public List<String> getPermittedInputMethodsForCurrentUser() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004770 throwIfParentInstance("getPermittedInputMethodsForCurrentUser");
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004771 if (mService != null) {
4772 try {
4773 return mService.getPermittedInputMethodsForCurrentUser();
4774 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004775 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004776 }
4777 }
4778 return null;
4779 }
4780
4781 /**
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08004782 * Called by a device owner to get the list of apps to keep around as APKs even if no user has
4783 * currently installed it.
4784 *
4785 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4786 *
4787 * @return List of package names to keep cached.
4788 * @hide
4789 */
4790 public List<String> getKeepUninstalledPackages(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004791 throwIfParentInstance("getKeepUninstalledPackages");
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08004792 if (mService != null) {
4793 try {
4794 return mService.getKeepUninstalledPackages(admin);
4795 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004796 throw e.rethrowFromSystemServer();
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08004797 }
4798 }
4799 return null;
4800 }
4801
4802 /**
4803 * Called by a device owner to set a list of apps to keep around as APKs even if no user has
4804 * currently installed it.
4805 *
4806 * <p>Please note that setting this policy does not imply that specified apps will be
4807 * automatically pre-cached.</p>
4808 *
4809 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4810 * @param packageNames List of package names to keep cached.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004811 * @throws SecurityException if {@code admin} is not a device owner.
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08004812 * @hide
4813 */
4814 public void setKeepUninstalledPackages(@NonNull ComponentName admin,
4815 @NonNull List<String> packageNames) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004816 throwIfParentInstance("setKeepUninstalledPackages");
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08004817 if (mService != null) {
4818 try {
4819 mService.setKeepUninstalledPackages(admin, packageNames);
4820 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004821 throw e.rethrowFromSystemServer();
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08004822 }
4823 }
4824 }
4825
4826 /**
Julia Reynolds1e958392014-05-16 14:25:21 -04004827 * Called by a device owner to create a user with the specified name. The UserHandle returned
4828 * by this method should not be persisted as user handles are recycled as users are removed and
4829 * created. If you need to persist an identifier for this user, use
4830 * {@link UserManager#getSerialNumberForUser}.
4831 *
4832 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4833 * @param name the user's name
4834 * @see UserHandle
Robin Lee25e26452015-06-02 09:56:29 -07004835 * @return the {@link android.os.UserHandle} object for the created user, or {@code null} if the
4836 * user could not be created.
Kenny Guy14f48e52015-06-29 15:12:36 +01004837 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07004838 * @deprecated From {@link android.os.Build.VERSION_CODES#M}
phweiss27ee3342016-02-08 16:40:45 +01004839 * @removed From {@link android.os.Build.VERSION_CODES#N}
Julia Reynolds1e958392014-05-16 14:25:21 -04004840 */
Kenny Guy14f48e52015-06-29 15:12:36 +01004841 @Deprecated
Robin Lee25e26452015-06-02 09:56:29 -07004842 public UserHandle createUser(@NonNull ComponentName admin, String name) {
Julia Reynolds1e958392014-05-16 14:25:21 -04004843 return null;
4844 }
4845
4846 /**
Jason Monk03978a42014-06-10 15:05:30 -04004847 * Called by a device owner to create a user with the specified name. The UserHandle returned
4848 * by this method should not be persisted as user handles are recycled as users are removed and
4849 * created. If you need to persist an identifier for this user, use
4850 * {@link UserManager#getSerialNumberForUser}. The new user will be started in the background
4851 * immediately.
4852 *
4853 * <p> profileOwnerComponent is the {@link DeviceAdminReceiver} to be the profile owner as well
4854 * as registered as an active admin on the new user. The profile owner package will be
4855 * installed on the new user if it already is installed on the device.
4856 *
4857 * <p>If the optionalInitializeData is not null, then the extras will be passed to the
4858 * profileOwnerComponent when onEnable is called.
4859 *
4860 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4861 * @param name the user's name
4862 * @param ownerName the human readable name of the organisation associated with this DPM.
4863 * @param profileOwnerComponent The {@link DeviceAdminReceiver} that will be an active admin on
4864 * the user.
4865 * @param adminExtras Extras that will be passed to onEnable of the admin receiver
4866 * on the new user.
4867 * @see UserHandle
Robin Lee25e26452015-06-02 09:56:29 -07004868 * @return the {@link android.os.UserHandle} object for the created user, or {@code null} if the
4869 * user could not be created.
Kenny Guy14f48e52015-06-29 15:12:36 +01004870 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07004871 * @deprecated From {@link android.os.Build.VERSION_CODES#M}
phweiss27ee3342016-02-08 16:40:45 +01004872 * @removed From {@link android.os.Build.VERSION_CODES#N}
Jason Monk03978a42014-06-10 15:05:30 -04004873 */
Kenny Guy14f48e52015-06-29 15:12:36 +01004874 @Deprecated
Robin Lee25e26452015-06-02 09:56:29 -07004875 public UserHandle createAndInitializeUser(@NonNull ComponentName admin, String name,
4876 String ownerName, @NonNull ComponentName profileOwnerComponent, Bundle adminExtras) {
Jason Monk03978a42014-06-10 15:05:30 -04004877 return null;
4878 }
4879
4880 /**
phweissa92e1212016-01-25 17:14:10 +01004881 * Flag used by {@link #createAndManageUser} to skip setup wizard after creating a new user.
phweiss343fb332016-01-25 14:48:59 +01004882 */
4883 public static final int SKIP_SETUP_WIZARD = 0x0001;
4884
4885 /**
Lenka Trochtovac8202c82016-01-26 15:11:09 +01004886 * Flag used by {@link #createAndManageUser} to specify that the user should be created
4887 * ephemeral.
4888 * @hide
4889 */
4890 public static final int MAKE_USER_EPHEMERAL = 0x0002;
4891
4892 /**
phweissa92e1212016-01-25 17:14:10 +01004893 * Called by a device owner to create a user with the specified name and a given component of
4894 * the calling package as profile owner. The UserHandle returned by this method should not be
4895 * persisted as user handles are recycled as users are removed and created. If you need to
4896 * persist an identifier for this user, use {@link UserManager#getSerialNumberForUser}. The new
4897 * user will not be started in the background.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004898 * <p>
4899 * admin is the {@link DeviceAdminReceiver} which is the device owner. profileOwner is also a
4900 * DeviceAdminReceiver in the same package as admin, and will become the profile owner and will
4901 * be registered as an active admin on the new user. The profile owner package will be installed
4902 * on the new user.
4903 * <p>
4904 * If the adminExtras are not null, they will be stored on the device until the user is started
4905 * for the first time. Then the extras will be passed to the admin when onEnable is called.
phweiss343fb332016-01-25 14:48:59 +01004906 *
4907 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4908 * @param name The user's name.
phweissa92e1212016-01-25 17:14:10 +01004909 * @param profileOwner Which {@link DeviceAdminReceiver} will be profile owner. Has to be in the
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004910 * same package as admin, otherwise no user is created and an
4911 * IllegalArgumentException is thrown.
phweiss343fb332016-01-25 14:48:59 +01004912 * @param adminExtras Extras that will be passed to onEnable of the admin receiver on the new
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004913 * user.
phweissa92e1212016-01-25 17:14:10 +01004914 * @param flags {@link #SKIP_SETUP_WIZARD} is supported.
phweiss343fb332016-01-25 14:48:59 +01004915 * @see UserHandle
4916 * @return the {@link android.os.UserHandle} object for the created user, or {@code null} if the
4917 * user could not be created.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004918 * @throws SecurityException if {@code admin} is not a device owner.
phweiss343fb332016-01-25 14:48:59 +01004919 */
4920 public UserHandle createAndManageUser(@NonNull ComponentName admin, @NonNull String name,
phweissa92e1212016-01-25 17:14:10 +01004921 @NonNull ComponentName profileOwner, @Nullable PersistableBundle adminExtras,
4922 int flags) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004923 throwIfParentInstance("createAndManageUser");
phweiss343fb332016-01-25 14:48:59 +01004924 try {
phweissa92e1212016-01-25 17:14:10 +01004925 return mService.createAndManageUser(admin, name, profileOwner, adminExtras, flags);
phweiss343fb332016-01-25 14:48:59 +01004926 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004927 throw re.rethrowFromSystemServer();
phweiss343fb332016-01-25 14:48:59 +01004928 }
phweiss343fb332016-01-25 14:48:59 +01004929 }
4930
4931 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004932 * Called by a device owner to remove a user and all associated data. The primary user can not
4933 * be removed.
Julia Reynolds1e958392014-05-16 14:25:21 -04004934 *
4935 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4936 * @param userHandle the user to remove.
4937 * @return {@code true} if the user was removed, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004938 * @throws SecurityException if {@code admin} is not a device owner.
Julia Reynolds1e958392014-05-16 14:25:21 -04004939 */
Robin Lee25e26452015-06-02 09:56:29 -07004940 public boolean removeUser(@NonNull ComponentName admin, UserHandle userHandle) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004941 throwIfParentInstance("removeUser");
Julia Reynolds1e958392014-05-16 14:25:21 -04004942 try {
4943 return mService.removeUser(admin, userHandle);
4944 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004945 throw re.rethrowFromSystemServer();
Julia Reynolds1e958392014-05-16 14:25:21 -04004946 }
4947 }
4948
4949 /**
Jason Monk582d9112014-07-09 19:57:08 -04004950 * Called by a device owner to switch the specified user to the foreground.
4951 *
4952 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4953 * @param userHandle the user to switch to; null will switch to primary.
4954 * @return {@code true} if the switch was successful, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004955 * @throws SecurityException if {@code admin} is not a device owner.
Jason Monk582d9112014-07-09 19:57:08 -04004956 * @see Intent#ACTION_USER_FOREGROUND
4957 */
Robin Lee25e26452015-06-02 09:56:29 -07004958 public boolean switchUser(@NonNull ComponentName admin, @Nullable UserHandle userHandle) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004959 throwIfParentInstance("switchUser");
Jason Monk582d9112014-07-09 19:57:08 -04004960 try {
4961 return mService.switchUser(admin, userHandle);
4962 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004963 throw re.rethrowFromSystemServer();
Jason Monk582d9112014-07-09 19:57:08 -04004964 }
4965 }
4966
4967 /**
Esteban Talaverabf60f722015-12-10 16:26:44 +00004968 * Retrieves the application restrictions for a given target application running in the calling
4969 * user.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004970 * <p>
4971 * The caller must be a profile or device owner on that user, or the package allowed to manage
4972 * application restrictions via {@link #setApplicationRestrictionsManagingPackage}; otherwise a
4973 * security exception will be thrown.
Robin Lee66e5d962014-04-09 16:44:21 +01004974 *
Esteban Talaverabf60f722015-12-10 16:26:44 +00004975 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004976 * {@code null} if called by the application restrictions managing package.
Robin Lee66e5d962014-04-09 16:44:21 +01004977 * @param packageName The name of the package to fetch restricted settings of.
4978 * @return {@link Bundle} of settings corresponding to what was set last time
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004979 * {@link DevicePolicyManager#setApplicationRestrictions} was called, or an empty
4980 * {@link Bundle} if no restrictions have been set.
4981 * @throws SecurityException if {@code admin} is not a device or profile owner.
Esteban Talaverabf60f722015-12-10 16:26:44 +00004982 * @see {@link #setApplicationRestrictionsManagingPackage}
Robin Lee66e5d962014-04-09 16:44:21 +01004983 */
Esteban Talaverabf60f722015-12-10 16:26:44 +00004984 public Bundle getApplicationRestrictions(@Nullable ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01004985 throwIfParentInstance("getApplicationRestrictions");
Robin Lee66e5d962014-04-09 16:44:21 +01004986 if (mService != null) {
4987 try {
4988 return mService.getApplicationRestrictions(admin, packageName);
4989 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004990 throw e.rethrowFromSystemServer();
Robin Lee66e5d962014-04-09 16:44:21 +01004991 }
4992 }
4993 return null;
4994 }
Amith Yamasanibe465322014-04-24 13:45:17 -07004995
4996 /**
Julia Reynolds20118f12015-02-11 12:34:08 -05004997 * Called by a profile or device owner to set a user restriction specified by the key.
Amith Yamasanibe465322014-04-24 13:45:17 -07004998 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004999 * The calling device admin must be a profile or device owner; if it is not, a security
5000 * exception will be thrown.
Jim Millerdf2258b2014-04-27 20:10:26 -07005001 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005002 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5003 * @param key The key of the restriction. See the constants in {@link android.os.UserManager}
5004 * for the list of keys.
5005 * @throws SecurityException if {@code admin} is not a device or profile owner.
Amith Yamasanibe465322014-04-24 13:45:17 -07005006 */
Robin Lee25e26452015-06-02 09:56:29 -07005007 public void addUserRestriction(@NonNull ComponentName admin, String key) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005008 throwIfParentInstance("addUserRestriction");
Amith Yamasanibe465322014-04-24 13:45:17 -07005009 if (mService != null) {
5010 try {
5011 mService.setUserRestriction(admin, key, true);
5012 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005013 throw e.rethrowFromSystemServer();
Amith Yamasanibe465322014-04-24 13:45:17 -07005014 }
5015 }
5016 }
5017
5018 /**
Julia Reynolds20118f12015-02-11 12:34:08 -05005019 * Called by a profile or device owner to clear a user restriction specified by the key.
Amith Yamasanibe465322014-04-24 13:45:17 -07005020 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005021 * The calling device admin must be a profile or device owner; if it is not, a security
5022 * exception will be thrown.
Jim Millerdf2258b2014-04-27 20:10:26 -07005023 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005024 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5025 * @param key The key of the restriction. See the constants in {@link android.os.UserManager}
5026 * for the list of keys.
5027 * @throws SecurityException if {@code admin} is not a device or profile owner.
Amith Yamasanibe465322014-04-24 13:45:17 -07005028 */
Robin Lee25e26452015-06-02 09:56:29 -07005029 public void clearUserRestriction(@NonNull ComponentName admin, String key) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005030 throwIfParentInstance("clearUserRestriction");
Amith Yamasanibe465322014-04-24 13:45:17 -07005031 if (mService != null) {
5032 try {
5033 mService.setUserRestriction(admin, key, false);
5034 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005035 throw e.rethrowFromSystemServer();
Amith Yamasanibe465322014-04-24 13:45:17 -07005036 }
5037 }
5038 }
Adam Connors010cfd42014-04-16 12:48:13 +01005039
5040 /**
Makoto Onuki3a3092f2015-10-30 11:07:51 -07005041 * Called by a profile or device owner to get user restrictions set with
5042 * {@link #addUserRestriction(ComponentName, String)}.
5043 * <p>
5044 * The target user may have more restrictions set by the system or other device owner / profile
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005045 * owner. To get all the user restrictions currently set, use
Makoto Onuki3a3092f2015-10-30 11:07:51 -07005046 * {@link UserManager#getUserRestrictions()}.
5047 *
5048 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005049 * @throws SecurityException if {@code admin} is not a device or profile owner.
Makoto Onuki3a3092f2015-10-30 11:07:51 -07005050 */
5051 public Bundle getUserRestrictions(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005052 throwIfParentInstance("getUserRestrictions");
Makoto Onuki3a3092f2015-10-30 11:07:51 -07005053 Bundle ret = null;
5054 if (mService != null) {
5055 try {
Sudheer Shanka549b9692016-03-30 17:12:07 -07005056 ret = mService.getUserRestrictions(admin);
5057 } catch (RemoteException e) {
5058 throw e.rethrowFromSystemServer();
5059 }
5060 }
5061 return ret == null ? new Bundle() : ret;
5062 }
5063
5064 /**
5065 * Called by the system to get the user restrictions for a user.
5066 *
5067 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5068 * @param userHandle user id the admin is running as.
5069 *
5070 * @hide
5071 */
5072 public Bundle getUserRestrictionsForUser(@NonNull ComponentName admin, int userHandle) {
5073 Bundle ret = null;
5074 if (mService != null) {
5075 try {
5076 ret = mService.getUserRestrictionsForUser(admin, userHandle);
Makoto Onuki3a3092f2015-10-30 11:07:51 -07005077 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005078 throw e.rethrowFromSystemServer();
Makoto Onuki3a3092f2015-10-30 11:07:51 -07005079 }
5080 }
5081 return ret == null ? new Bundle() : ret;
5082 }
5083
5084 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005085 * Called by profile or device owners to hide or unhide packages. When a package is hidden it is
5086 * unavailable for use, but the data and actual package file remain.
Julia Reynolds966881e2014-05-14 12:23:08 -04005087 *
5088 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Amith Yamasanie5bcff62014-07-19 15:44:09 -07005089 * @param packageName The name of the package to hide or unhide.
5090 * @param hidden {@code true} if the package should be hidden, {@code false} if it should be
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005091 * unhidden.
Amith Yamasanie5bcff62014-07-19 15:44:09 -07005092 * @return boolean Whether the hidden setting of the package was successfully updated.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005093 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynolds966881e2014-05-14 12:23:08 -04005094 */
Robin Lee25e26452015-06-02 09:56:29 -07005095 public boolean setApplicationHidden(@NonNull ComponentName admin, String packageName,
Amith Yamasanie5bcff62014-07-19 15:44:09 -07005096 boolean hidden) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005097 throwIfParentInstance("setApplicationHidden");
Julia Reynolds966881e2014-05-14 12:23:08 -04005098 if (mService != null) {
5099 try {
Amith Yamasanie5bcff62014-07-19 15:44:09 -07005100 return mService.setApplicationHidden(admin, packageName, hidden);
Julia Reynolds966881e2014-05-14 12:23:08 -04005101 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005102 throw e.rethrowFromSystemServer();
Julia Reynolds966881e2014-05-14 12:23:08 -04005103 }
5104 }
5105 return false;
5106 }
5107
5108 /**
Julia Reynolds20118f12015-02-11 12:34:08 -05005109 * Called by profile or device owners to determine if a package is hidden.
Julia Reynolds966881e2014-05-14 12:23:08 -04005110 *
5111 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Amith Yamasanie5bcff62014-07-19 15:44:09 -07005112 * @param packageName The name of the package to retrieve the hidden status of.
5113 * @return boolean {@code true} if the package is hidden, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005114 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynolds966881e2014-05-14 12:23:08 -04005115 */
Robin Lee25e26452015-06-02 09:56:29 -07005116 public boolean isApplicationHidden(@NonNull ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005117 throwIfParentInstance("isApplicationHidden");
Julia Reynolds966881e2014-05-14 12:23:08 -04005118 if (mService != null) {
5119 try {
Amith Yamasanie5bcff62014-07-19 15:44:09 -07005120 return mService.isApplicationHidden(admin, packageName);
Julia Reynolds966881e2014-05-14 12:23:08 -04005121 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005122 throw e.rethrowFromSystemServer();
Julia Reynolds966881e2014-05-14 12:23:08 -04005123 }
5124 }
5125 return false;
5126 }
5127
5128 /**
Julia Reynolds20118f12015-02-11 12:34:08 -05005129 * Called by profile or device owners to re-enable a system app that was disabled by default
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07005130 * when the user was initialized.
Adam Connors655be2a2014-07-14 09:01:25 +00005131 *
5132 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Makoto Onuki32b30572015-12-11 14:29:51 -08005133 * @param packageName The package to be re-enabled in the calling profile.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005134 * @throws SecurityException if {@code admin} is not a device or profile owner.
Adam Connors655be2a2014-07-14 09:01:25 +00005135 */
Robin Lee25e26452015-06-02 09:56:29 -07005136 public void enableSystemApp(@NonNull ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005137 throwIfParentInstance("enableSystemApp");
Adam Connors655be2a2014-07-14 09:01:25 +00005138 if (mService != null) {
5139 try {
5140 mService.enableSystemApp(admin, packageName);
5141 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005142 throw e.rethrowFromSystemServer();
Adam Connors655be2a2014-07-14 09:01:25 +00005143 }
5144 }
5145 }
5146
5147 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005148 * Called by profile or device owners to re-enable system apps by intent that were disabled by
5149 * default when the user was initialized.
Adam Connors655be2a2014-07-14 09:01:25 +00005150 *
5151 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5152 * @param intent An intent matching the app(s) to be installed. All apps that resolve for this
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005153 * intent will be re-enabled in the calling profile.
Adam Connors655be2a2014-07-14 09:01:25 +00005154 * @return int The number of activities that matched the intent and were installed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005155 * @throws SecurityException if {@code admin} is not a device or profile owner.
Adam Connors655be2a2014-07-14 09:01:25 +00005156 */
Robin Lee25e26452015-06-02 09:56:29 -07005157 public int enableSystemApp(@NonNull ComponentName admin, Intent intent) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005158 throwIfParentInstance("enableSystemApp");
Adam Connors655be2a2014-07-14 09:01:25 +00005159 if (mService != null) {
5160 try {
5161 return mService.enableSystemAppWithIntent(admin, intent);
5162 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005163 throw e.rethrowFromSystemServer();
Adam Connors655be2a2014-07-14 09:01:25 +00005164 }
5165 }
5166 return 0;
5167 }
5168
5169 /**
Sander Alewijnse112e0532014-10-29 13:28:49 +00005170 * Called by a device owner or profile owner to disable account management for a specific type
5171 * of account.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005172 * <p>
5173 * The calling device admin must be a device owner or profile owner. If it is not, a security
5174 * exception will be thrown.
5175 * <p>
5176 * When account management is disabled for an account type, adding or removing an account of
5177 * that type will not be possible.
5178 * <p>
5179 * From {@link android.os.Build.VERSION_CODES#N} the profile or device owner can still use
Benjamin Franzb6c0ce42015-11-05 10:06:51 +00005180 * {@link android.accounts.AccountManager} APIs to add or remove accounts when account
5181 * management for a specific type is disabled.
5182 *
Sander Alewijnse650c3342014-05-08 18:00:50 +01005183 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5184 * @param accountType For which account management is disabled or enabled.
5185 * @param disabled The boolean indicating that account management will be disabled (true) or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005186 * enabled (false).
5187 * @throws SecurityException if {@code admin} is not a device or profile owner.
Sander Alewijnse650c3342014-05-08 18:00:50 +01005188 */
Robin Lee25e26452015-06-02 09:56:29 -07005189 public void setAccountManagementDisabled(@NonNull ComponentName admin, String accountType,
Sander Alewijnse650c3342014-05-08 18:00:50 +01005190 boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005191 throwIfParentInstance("setAccountManagementDisabled");
Sander Alewijnse650c3342014-05-08 18:00:50 +01005192 if (mService != null) {
5193 try {
5194 mService.setAccountManagementDisabled(admin, accountType, disabled);
5195 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005196 throw e.rethrowFromSystemServer();
Sander Alewijnse650c3342014-05-08 18:00:50 +01005197 }
5198 }
5199 }
5200
5201 /**
Sander Alewijnse5c02db62014-05-07 10:46:57 +01005202 * Gets the array of accounts for which account management is disabled by the profile owner.
5203 *
5204 * <p> Account management can be disabled/enabled by calling
5205 * {@link #setAccountManagementDisabled}.
5206 *
5207 * @return a list of account types for which account management has been disabled.
5208 *
5209 * @see #setAccountManagementDisabled
5210 */
5211 public String[] getAccountTypesWithManagementDisabled() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005212 throwIfParentInstance("getAccountTypesWithManagementDisabled");
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07005213 return getAccountTypesWithManagementDisabledAsUser(myUserId());
Alexandra Gherghina999d3942014-07-03 11:40:08 +01005214 }
5215
5216 /**
5217 * @see #getAccountTypesWithManagementDisabled()
5218 * @hide
5219 */
5220 public String[] getAccountTypesWithManagementDisabledAsUser(int userId) {
Sander Alewijnse5c02db62014-05-07 10:46:57 +01005221 if (mService != null) {
5222 try {
Alexandra Gherghina999d3942014-07-03 11:40:08 +01005223 return mService.getAccountTypesWithManagementDisabledAsUser(userId);
Sander Alewijnse5c02db62014-05-07 10:46:57 +01005224 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005225 throw e.rethrowFromSystemServer();
Sander Alewijnse5c02db62014-05-07 10:46:57 +01005226 }
5227 }
5228
5229 return null;
5230 }
justinzhang511e0d82014-03-24 16:09:24 -04005231
5232 /**
Jason Monkd7b86212014-06-16 13:15:38 -04005233 * Sets which packages may enter lock task mode.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005234 * <p>
5235 * Any packages that shares uid with an allowed package will also be allowed to activate lock
5236 * task. From {@link android.os.Build.VERSION_CODES#M} removing packages from the lock task
5237 * package list results in locked tasks belonging to those packages to be finished. This
5238 * function can only be called by the device owner.
Jason Monkd7b86212014-06-16 13:15:38 -04005239 *
Jason Monkd7b86212014-06-16 13:15:38 -04005240 * @param packages The list of packages allowed to enter lock task mode
Jason Monk48aacba2014-08-13 16:29:08 -04005241 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005242 * @throws SecurityException if {@code admin} is not a device owner.
Jason Monkd7b86212014-06-16 13:15:38 -04005243 * @see Activity#startLockTask()
Benjamin Franz6cdb27e2015-02-26 12:26:53 +00005244 * @see DeviceAdminReceiver#onLockTaskModeEntering(Context, Intent, String)
5245 * @see DeviceAdminReceiver#onLockTaskModeExiting(Context, Intent)
Jason Monk1c7c3192014-06-26 12:52:18 -04005246 * @see UserManager#DISALLOW_CREATE_WINDOWS
justinzhang511e0d82014-03-24 16:09:24 -04005247 */
Robin Lee25e26452015-06-02 09:56:29 -07005248 public void setLockTaskPackages(@NonNull ComponentName admin, String[] packages)
Jason Monk48aacba2014-08-13 16:29:08 -04005249 throws SecurityException {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005250 throwIfParentInstance("setLockTaskPackages");
justinzhang511e0d82014-03-24 16:09:24 -04005251 if (mService != null) {
5252 try {
Jason Monk48aacba2014-08-13 16:29:08 -04005253 mService.setLockTaskPackages(admin, packages);
justinzhang511e0d82014-03-24 16:09:24 -04005254 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005255 throw e.rethrowFromSystemServer();
justinzhang511e0d82014-03-24 16:09:24 -04005256 }
5257 }
5258 }
5259
5260 /**
Jason Monkd7b86212014-06-16 13:15:38 -04005261 * This function returns the list of packages allowed to start the lock task mode.
Jason Monk48aacba2014-08-13 16:29:08 -04005262 *
5263 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
justinzhang511e0d82014-03-24 16:09:24 -04005264 * @hide
5265 */
Robin Lee25e26452015-06-02 09:56:29 -07005266 public String[] getLockTaskPackages(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005267 throwIfParentInstance("getLockTaskPackages");
justinzhang511e0d82014-03-24 16:09:24 -04005268 if (mService != null) {
5269 try {
Jason Monk48aacba2014-08-13 16:29:08 -04005270 return mService.getLockTaskPackages(admin);
justinzhang511e0d82014-03-24 16:09:24 -04005271 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005272 throw e.rethrowFromSystemServer();
justinzhang511e0d82014-03-24 16:09:24 -04005273 }
5274 }
5275 return null;
5276 }
5277
5278 /**
5279 * This function lets the caller know whether the given component is allowed to start the
5280 * lock task mode.
Jason Monkd7b86212014-06-16 13:15:38 -04005281 * @param pkg The package to check
justinzhang511e0d82014-03-24 16:09:24 -04005282 */
Jason Monkd7b86212014-06-16 13:15:38 -04005283 public boolean isLockTaskPermitted(String pkg) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005284 throwIfParentInstance("isLockTaskPermitted");
justinzhang511e0d82014-03-24 16:09:24 -04005285 if (mService != null) {
5286 try {
Jason Monkd7b86212014-06-16 13:15:38 -04005287 return mService.isLockTaskPermitted(pkg);
justinzhang511e0d82014-03-24 16:09:24 -04005288 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005289 throw e.rethrowFromSystemServer();
justinzhang511e0d82014-03-24 16:09:24 -04005290 }
5291 }
5292 return false;
5293 }
Julia Reynoldsda551652014-05-14 17:15:16 -04005294
5295 /**
5296 * Called by device owners to update {@link Settings.Global} settings. Validation that the value
5297 * 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 -07005298 * <p>
5299 * The settings that can be updated with this method are:
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005300 * <ul>
5301 * <li>{@link Settings.Global#ADB_ENABLED}</li>
5302 * <li>{@link Settings.Global#AUTO_TIME}</li>
5303 * <li>{@link Settings.Global#AUTO_TIME_ZONE}</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005304 * <li>{@link Settings.Global#DATA_ROAMING}</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005305 * <li>{@link Settings.Global#USB_MASS_STORAGE_ENABLED}</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005306 * <li>{@link Settings.Global#WIFI_SLEEP_POLICY}</li>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005307 * <li>{@link Settings.Global#STAY_ON_WHILE_PLUGGED_IN} This setting is only available from
5308 * {@link android.os.Build.VERSION_CODES#M} onwards and can only be set if
5309 * {@link #setMaximumTimeToLock} is not used to set a timeout.</li>
5310 * <li>{@link Settings.Global#WIFI_DEVICE_OWNER_CONFIGS_LOCKDOWN}</li> This setting is only
5311 * available from {@link android.os.Build.VERSION_CODES#M} onwards.</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005312 * </ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005313 * <p>
5314 * Changing the following settings has no effect as of {@link android.os.Build.VERSION_CODES#M}:
Esteban Talavera656fa7f2015-06-29 17:41:39 +01005315 * <ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005316 * <li>{@link Settings.Global#BLUETOOTH_ON}. Use
5317 * {@link android.bluetooth.BluetoothAdapter#enable()} and
5318 * {@link android.bluetooth.BluetoothAdapter#disable()} instead.</li>
Esteban Talavera656fa7f2015-06-29 17:41:39 +01005319 * <li>{@link Settings.Global#DEVELOPMENT_SETTINGS_ENABLED}</li>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005320 * <li>{@link Settings.Global#MODE_RINGER}. Use
5321 * {@link android.media.AudioManager#setRingerMode(int)} instead.</li>
Esteban Talavera656fa7f2015-06-29 17:41:39 +01005322 * <li>{@link Settings.Global#NETWORK_PREFERENCE}</li>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005323 * <li>{@link Settings.Global#WIFI_ON}. Use
5324 * {@link android.net.wifi.WifiManager#setWifiEnabled(boolean)} instead.</li>
Esteban Talavera656fa7f2015-06-29 17:41:39 +01005325 * </ul>
Julia Reynoldsda551652014-05-14 17:15:16 -04005326 *
5327 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5328 * @param setting The name of the setting to update.
5329 * @param value The value to update the setting to.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005330 * @throws SecurityException if {@code admin} is not a device owner.
Julia Reynoldsda551652014-05-14 17:15:16 -04005331 */
Robin Lee25e26452015-06-02 09:56:29 -07005332 public void setGlobalSetting(@NonNull ComponentName admin, String setting, String value) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005333 throwIfParentInstance("setGlobalSetting");
Julia Reynoldsda551652014-05-14 17:15:16 -04005334 if (mService != null) {
5335 try {
5336 mService.setGlobalSetting(admin, setting, value);
5337 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005338 throw e.rethrowFromSystemServer();
Julia Reynoldsda551652014-05-14 17:15:16 -04005339 }
5340 }
5341 }
5342
5343 /**
5344 * Called by profile or device owners to update {@link Settings.Secure} settings. Validation
5345 * that the value of the setting is in the correct form for the setting type should be performed
5346 * by the caller.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005347 * <p>
5348 * The settings that can be updated by a profile or device owner with this method are:
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005349 * <ul>
5350 * <li>{@link Settings.Secure#DEFAULT_INPUT_METHOD}</li>
Amith Yamasani52c39a12014-10-21 11:14:04 -07005351 * <li>{@link Settings.Secure#INSTALL_NON_MARKET_APPS}</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005352 * <li>{@link Settings.Secure#SKIP_FIRST_USE_HINTS}</li>
5353 * </ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005354 * <p>
5355 * A device owner can additionally update the following settings:
Julia Reynolds82735bc2014-09-04 16:43:30 -04005356 * <ul>
5357 * <li>{@link Settings.Secure#LOCATION_MODE}</li>
5358 * </ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005359 *
Julia Reynoldsda551652014-05-14 17:15:16 -04005360 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5361 * @param setting The name of the setting to update.
5362 * @param value The value to update the setting to.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005363 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynoldsda551652014-05-14 17:15:16 -04005364 */
Robin Lee25e26452015-06-02 09:56:29 -07005365 public void setSecureSetting(@NonNull ComponentName admin, String setting, String value) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005366 throwIfParentInstance("setSecureSetting");
Julia Reynoldsda551652014-05-14 17:15:16 -04005367 if (mService != null) {
5368 try {
5369 mService.setSecureSetting(admin, setting, value);
5370 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005371 throw e.rethrowFromSystemServer();
Julia Reynoldsda551652014-05-14 17:15:16 -04005372 }
5373 }
5374 }
5375
Amith Yamasanif20d6402014-05-24 15:34:37 -07005376 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005377 * Designates a specific service component as the provider for making permission requests of a
5378 * local or remote administrator of the user.
Amith Yamasanif20d6402014-05-24 15:34:37 -07005379 * <p/>
5380 * Only a profile owner can designate the restrictions provider.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005381 *
Amith Yamasanif20d6402014-05-24 15:34:37 -07005382 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Amith Yamasanif6e2fcc2014-07-10 13:41:55 -07005383 * @param provider The component name of the service that implements
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005384 * {@link RestrictionsReceiver}. If this param is null, it removes the restrictions
5385 * provider previously assigned.
5386 * @throws SecurityException if {@code admin} is not a device or profile owner.
Amith Yamasanif20d6402014-05-24 15:34:37 -07005387 */
Robin Lee25e26452015-06-02 09:56:29 -07005388 public void setRestrictionsProvider(@NonNull ComponentName admin,
5389 @Nullable ComponentName provider) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005390 throwIfParentInstance("setRestrictionsProvider");
Amith Yamasanif20d6402014-05-24 15:34:37 -07005391 if (mService != null) {
5392 try {
Amith Yamasanif6e2fcc2014-07-10 13:41:55 -07005393 mService.setRestrictionsProvider(admin, provider);
Amith Yamasanif20d6402014-05-24 15:34:37 -07005394 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005395 throw re.rethrowFromSystemServer();
Amith Yamasanif20d6402014-05-24 15:34:37 -07005396 }
5397 }
5398 }
Julia Reynolds4a21b252014-06-04 11:11:43 -04005399
5400 /**
5401 * Called by profile or device owners to set the master volume mute on or off.
5402 *
5403 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5404 * @param on {@code true} to mute master volume, {@code false} to turn mute off.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005405 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynolds4a21b252014-06-04 11:11:43 -04005406 */
Robin Lee25e26452015-06-02 09:56:29 -07005407 public void setMasterVolumeMuted(@NonNull ComponentName admin, boolean on) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005408 throwIfParentInstance("setMasterVolumeMuted");
Julia Reynolds4a21b252014-06-04 11:11:43 -04005409 if (mService != null) {
5410 try {
5411 mService.setMasterVolumeMuted(admin, on);
5412 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005413 throw re.rethrowFromSystemServer();
Julia Reynolds4a21b252014-06-04 11:11:43 -04005414 }
5415 }
5416 }
5417
5418 /**
5419 * Called by profile or device owners to check whether the master volume mute is on or off.
5420 *
5421 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5422 * @return {@code true} if master volume is muted, {@code false} if it's not.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005423 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynolds4a21b252014-06-04 11:11:43 -04005424 */
Robin Lee25e26452015-06-02 09:56:29 -07005425 public boolean isMasterVolumeMuted(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005426 throwIfParentInstance("isMasterVolumeMuted");
Julia Reynolds4a21b252014-06-04 11:11:43 -04005427 if (mService != null) {
5428 try {
5429 return mService.isMasterVolumeMuted(admin);
5430 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005431 throw re.rethrowFromSystemServer();
Julia Reynolds4a21b252014-06-04 11:11:43 -04005432 }
5433 }
5434 return false;
5435 }
Kenny Guyc13053b2014-05-29 14:17:17 +01005436
5437 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005438 * Called by profile or device owners to change whether a user can uninstall a package.
Kenny Guyc13053b2014-05-29 14:17:17 +01005439 *
5440 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5441 * @param packageName package to change.
Esteban Talaverad5c5c132014-08-20 11:35:57 +01005442 * @param uninstallBlocked true if the user shouldn't be able to uninstall the package.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005443 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyc13053b2014-05-29 14:17:17 +01005444 */
Robin Lee25e26452015-06-02 09:56:29 -07005445 public void setUninstallBlocked(@NonNull ComponentName admin, String packageName,
Esteban Talaverad5c5c132014-08-20 11:35:57 +01005446 boolean uninstallBlocked) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005447 throwIfParentInstance("setUninstallBlocked");
Kenny Guyc13053b2014-05-29 14:17:17 +01005448 if (mService != null) {
5449 try {
Esteban Talaverad5c5c132014-08-20 11:35:57 +01005450 mService.setUninstallBlocked(admin, packageName, uninstallBlocked);
Kenny Guyc13053b2014-05-29 14:17:17 +01005451 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005452 throw re.rethrowFromSystemServer();
Kenny Guyc13053b2014-05-29 14:17:17 +01005453 }
5454 }
5455 }
5456
5457 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08005458 * Check whether the user has been blocked by device policy from uninstalling a package.
Rubin Xua97855b2014-11-07 05:41:00 +00005459 * Requires the caller to be the profile owner if checking a specific admin's policy.
Rubin Xue1e6faa2015-03-10 10:51:59 +00005460 * <p>
5461 * <strong>Note:</strong> Starting from {@link android.os.Build.VERSION_CODES#LOLLIPOP_MR1}, the
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005462 * behavior of this API is changed such that passing {@code null} as the {@code admin} parameter
5463 * will return if any admin has blocked the uninstallation. Before L MR1, passing {@code null}
5464 * will cause a NullPointerException to be raised.
Kenny Guyc13053b2014-05-29 14:17:17 +01005465 *
Robin Lee25e26452015-06-02 09:56:29 -07005466 * @param admin The name of the admin component whose blocking policy will be checked, or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005467 * {@code null} to check whether any admin has blocked the uninstallation.
Kenny Guyc13053b2014-05-29 14:17:17 +01005468 * @param packageName package to check.
Rubin Xua97855b2014-11-07 05:41:00 +00005469 * @return true if uninstallation is blocked.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005470 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyc13053b2014-05-29 14:17:17 +01005471 */
Robin Lee25e26452015-06-02 09:56:29 -07005472 public boolean isUninstallBlocked(@Nullable ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005473 throwIfParentInstance("isUninstallBlocked");
Kenny Guyc13053b2014-05-29 14:17:17 +01005474 if (mService != null) {
5475 try {
Esteban Talavera729b2a62014-08-27 18:01:58 +01005476 return mService.isUninstallBlocked(admin, packageName);
Kenny Guyc13053b2014-05-29 14:17:17 +01005477 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005478 throw re.rethrowFromSystemServer();
Kenny Guyc13053b2014-05-29 14:17:17 +01005479 }
5480 }
5481 return false;
5482 }
Svetoslav976e8bd2014-07-16 15:12:03 -07005483
5484 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005485 * Called by the profile owner of a managed profile to enable widget providers from a given
5486 * package to be available in the parent profile. As a result the user will be able to add
5487 * widgets from the white-listed package running under the profile to a widget host which runs
5488 * under the parent profile, for example the home screen. Note that a package may have zero or
5489 * more provider components, where each component provides a different widget type.
Svetoslav976e8bd2014-07-16 15:12:03 -07005490 * <p>
5491 * <strong>Note:</strong> By default no widget provider package is white-listed.
Svetoslav976e8bd2014-07-16 15:12:03 -07005492 *
5493 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5494 * @param packageName The package from which widget providers are white-listed.
5495 * @return Whether the package was added.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005496 * @throws SecurityException if {@code admin} is not a profile owner.
Svetoslav976e8bd2014-07-16 15:12:03 -07005497 * @see #removeCrossProfileWidgetProvider(android.content.ComponentName, String)
5498 * @see #getCrossProfileWidgetProviders(android.content.ComponentName)
5499 */
Robin Lee25e26452015-06-02 09:56:29 -07005500 public boolean addCrossProfileWidgetProvider(@NonNull ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005501 throwIfParentInstance("addCrossProfileWidgetProvider");
Svetoslav976e8bd2014-07-16 15:12:03 -07005502 if (mService != null) {
5503 try {
5504 return mService.addCrossProfileWidgetProvider(admin, packageName);
5505 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005506 throw re.rethrowFromSystemServer();
Svetoslav976e8bd2014-07-16 15:12:03 -07005507 }
5508 }
5509 return false;
5510 }
5511
5512 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07005513 * Called by the profile owner of a managed profile to disable widget providers from a given
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005514 * package to be available in the parent profile. For this method to take effect the package
5515 * should have been added via
5516 * {@link #addCrossProfileWidgetProvider( android.content.ComponentName, String)}.
Svetoslav976e8bd2014-07-16 15:12:03 -07005517 * <p>
5518 * <strong>Note:</strong> By default no widget provider package is white-listed.
Svetoslav976e8bd2014-07-16 15:12:03 -07005519 *
5520 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005521 * @param packageName The package from which widget providers are no longer white-listed.
Svetoslav976e8bd2014-07-16 15:12:03 -07005522 * @return Whether the package was removed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005523 * @throws SecurityException if {@code admin} is not a profile owner.
Svetoslav976e8bd2014-07-16 15:12:03 -07005524 * @see #addCrossProfileWidgetProvider(android.content.ComponentName, String)
5525 * @see #getCrossProfileWidgetProviders(android.content.ComponentName)
5526 */
Esteban Talavera62399912016-01-11 15:37:55 +00005527 public boolean removeCrossProfileWidgetProvider(
5528 @NonNull ComponentName admin, String packageName) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005529 throwIfParentInstance("removeCrossProfileWidgetProvider");
Svetoslav976e8bd2014-07-16 15:12:03 -07005530 if (mService != null) {
5531 try {
5532 return mService.removeCrossProfileWidgetProvider(admin, packageName);
5533 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005534 throw re.rethrowFromSystemServer();
Svetoslav976e8bd2014-07-16 15:12:03 -07005535 }
5536 }
5537 return false;
5538 }
5539
5540 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07005541 * Called by the profile owner of a managed profile to query providers from which packages are
Svetoslav976e8bd2014-07-16 15:12:03 -07005542 * available in the parent profile.
5543 *
5544 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5545 * @return The white-listed package list.
Svetoslav976e8bd2014-07-16 15:12:03 -07005546 * @see #addCrossProfileWidgetProvider(android.content.ComponentName, String)
5547 * @see #removeCrossProfileWidgetProvider(android.content.ComponentName, String)
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005548 * @throws SecurityException if {@code admin} is not a profile owner.
Svetoslav976e8bd2014-07-16 15:12:03 -07005549 */
Robin Lee25e26452015-06-02 09:56:29 -07005550 public List<String> getCrossProfileWidgetProviders(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005551 throwIfParentInstance("getCrossProfileWidgetProviders");
Svetoslav976e8bd2014-07-16 15:12:03 -07005552 if (mService != null) {
5553 try {
5554 List<String> providers = mService.getCrossProfileWidgetProviders(admin);
5555 if (providers != null) {
5556 return providers;
5557 }
5558 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005559 throw re.rethrowFromSystemServer();
Svetoslav976e8bd2014-07-16 15:12:03 -07005560 }
5561 }
5562 return Collections.emptyList();
5563 }
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05005564
5565 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08005566 * Called by profile or device owners to set the user's photo.
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05005567 *
5568 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5569 * @param icon the bitmap to set as the photo.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005570 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05005571 */
Robin Lee25e26452015-06-02 09:56:29 -07005572 public void setUserIcon(@NonNull ComponentName admin, Bitmap icon) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005573 throwIfParentInstance("setUserIcon");
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05005574 try {
5575 mService.setUserIcon(admin, icon);
5576 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005577 throw re.rethrowFromSystemServer();
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05005578 }
5579 }
Craig Lafayettedbe31a62015-04-02 13:14:39 -04005580
5581 /**
Rubin Xu5faad8e2015-04-20 17:43:48 +01005582 * Called by device owners to set a local system update policy. When a new policy is set,
5583 * {@link #ACTION_SYSTEM_UPDATE_POLICY_CHANGED} is broadcasted.
Rubin Xu8027a4f2015-03-10 17:52:37 +00005584 *
Robin Lee25e26452015-06-02 09:56:29 -07005585 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. All
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005586 * components in the device owner package can set system update policies and the most
5587 * recent policy takes effect.
Robin Lee25e26452015-06-02 09:56:29 -07005588 * @param policy the new policy, or {@code null} to clear the current policy.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005589 * @throws SecurityException if {@code admin} is not a device owner.
Rubin Xu5faad8e2015-04-20 17:43:48 +01005590 * @see SystemUpdatePolicy
Rubin Xu8027a4f2015-03-10 17:52:37 +00005591 */
Robin Lee25e26452015-06-02 09:56:29 -07005592 public void setSystemUpdatePolicy(@NonNull ComponentName admin, SystemUpdatePolicy policy) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005593 throwIfParentInstance("setSystemUpdatePolicy");
Rubin Xu8027a4f2015-03-10 17:52:37 +00005594 if (mService != null) {
5595 try {
Robin Lee25e26452015-06-02 09:56:29 -07005596 mService.setSystemUpdatePolicy(admin, policy);
Rubin Xu8027a4f2015-03-10 17:52:37 +00005597 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005598 throw re.rethrowFromSystemServer();
Rubin Xu8027a4f2015-03-10 17:52:37 +00005599 }
5600 }
5601 }
5602
5603 /**
Rubin Xu5faad8e2015-04-20 17:43:48 +01005604 * Retrieve a local system update policy set previously by {@link #setSystemUpdatePolicy}.
Rubin Xu8027a4f2015-03-10 17:52:37 +00005605 *
Robin Lee25e26452015-06-02 09:56:29 -07005606 * @return The current policy object, or {@code null} if no policy is set.
Rubin Xu8027a4f2015-03-10 17:52:37 +00005607 */
Rubin Xu5faad8e2015-04-20 17:43:48 +01005608 public SystemUpdatePolicy getSystemUpdatePolicy() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005609 throwIfParentInstance("getSystemUpdatePolicy");
Rubin Xu8027a4f2015-03-10 17:52:37 +00005610 if (mService != null) {
5611 try {
Rubin Xud86d58c2015-05-05 16:57:37 +01005612 return mService.getSystemUpdatePolicy();
Rubin Xu8027a4f2015-03-10 17:52:37 +00005613 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005614 throw re.rethrowFromSystemServer();
Rubin Xu8027a4f2015-03-10 17:52:37 +00005615 }
5616 }
5617 return null;
5618 }
Benjamin Franze36087e2015-04-07 16:40:34 +01005619
5620 /**
5621 * Called by a device owner to disable the keyguard altogether.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005622 * <p>
5623 * Setting the keyguard to disabled has the same effect as choosing "None" as the screen lock
5624 * type. However, this call has no effect if a password, pin or pattern is currently set. If a
5625 * password, pin or pattern is set after the keyguard was disabled, the keyguard stops being
5626 * disabled.
Benjamin Franze36087e2015-04-07 16:40:34 +01005627 *
5628 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Benjamin Franzbece8062015-05-06 12:14:31 +01005629 * @param disabled {@code true} disables the keyguard, {@code false} reenables it.
Benjamin Franze36087e2015-04-07 16:40:34 +01005630 * @return {@code false} if attempting to disable the keyguard while a lock password was in
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005631 * place. {@code true} otherwise.
5632 * @throws SecurityException if {@code admin} is not a device owner.
Benjamin Franze36087e2015-04-07 16:40:34 +01005633 */
Robin Lee25e26452015-06-02 09:56:29 -07005634 public boolean setKeyguardDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005635 throwIfParentInstance("setKeyguardDisabled");
Benjamin Franze36087e2015-04-07 16:40:34 +01005636 try {
Benjamin Franzbece8062015-05-06 12:14:31 +01005637 return mService.setKeyguardDisabled(admin, disabled);
Benjamin Franze36087e2015-04-07 16:40:34 +01005638 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005639 throw re.rethrowFromSystemServer();
Benjamin Franze36087e2015-04-07 16:40:34 +01005640 }
5641 }
Benjamin Franzea2ec972015-03-16 17:18:09 +00005642
5643 /**
Benjamin Franzbece8062015-05-06 12:14:31 +01005644 * Called by device owner to disable the status bar. Disabling the status bar blocks
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005645 * notifications, quick settings and other screen overlays that allow escaping from a single use
5646 * device.
Benjamin Franzea2ec972015-03-16 17:18:09 +00005647 *
5648 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Benjamin Franzbece8062015-05-06 12:14:31 +01005649 * @param disabled {@code true} disables the status bar, {@code false} reenables it.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005650 * @return {@code false} if attempting to disable the status bar failed. {@code true} otherwise.
5651 * @throws SecurityException if {@code admin} is not a device owner.
Benjamin Franzea2ec972015-03-16 17:18:09 +00005652 */
Robin Lee25e26452015-06-02 09:56:29 -07005653 public boolean setStatusBarDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005654 throwIfParentInstance("setStatusBarDisabled");
Benjamin Franzea2ec972015-03-16 17:18:09 +00005655 try {
Benjamin Franzbece8062015-05-06 12:14:31 +01005656 return mService.setStatusBarDisabled(admin, disabled);
Benjamin Franzea2ec972015-03-16 17:18:09 +00005657 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005658 throw re.rethrowFromSystemServer();
Benjamin Franzea2ec972015-03-16 17:18:09 +00005659 }
5660 }
Rubin Xudc105cc2015-04-14 23:38:01 +01005661
5662 /**
5663 * Callable by the system update service to notify device owners about pending updates.
5664 * The caller must hold {@link android.Manifest.permission#NOTIFY_PENDING_SYSTEM_UPDATE}
5665 * permission.
5666 *
5667 * @param updateReceivedTime The time as given by {@link System#currentTimeMillis()} indicating
5668 * when the current pending update was first available. -1 if no update is available.
5669 * @hide
5670 */
5671 @SystemApi
5672 public void notifyPendingSystemUpdate(long updateReceivedTime) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005673 throwIfParentInstance("notifyPendingSystemUpdate");
Rubin Xudc105cc2015-04-14 23:38:01 +01005674 if (mService != null) {
5675 try {
5676 mService.notifyPendingSystemUpdate(updateReceivedTime);
5677 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005678 throw re.rethrowFromSystemServer();
Rubin Xudc105cc2015-04-14 23:38:01 +01005679 }
5680 }
5681 }
Julia Reynolds13c58ba2015-04-20 16:42:54 -04005682
5683 /**
Amith Yamasanid49489b2015-04-28 14:00:26 -07005684 * Called by profile or device owners to set the default response for future runtime permission
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005685 * requests by applications. The policy can allow for normal operation which prompts the user to
5686 * grant a permission, or can allow automatic granting or denying of runtime permission requests
5687 * by an application. This also applies to new permissions declared by app updates. When a
5688 * permission is denied or granted this way, the effect is equivalent to setting the permission
5689 * grant state via {@link #setPermissionGrantState}.
5690 * <p/>
5691 * As this policy only acts on runtime permission requests, it only applies to applications
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07005692 * built with a {@code targetSdkVersion} of {@link android.os.Build.VERSION_CODES#M} or later.
Benjamin Franz45dd6662015-07-08 14:24:14 +01005693 *
Amith Yamasanid49489b2015-04-28 14:00:26 -07005694 * @param admin Which profile or device owner this request is associated with.
5695 * @param policy One of the policy constants {@link #PERMISSION_POLICY_PROMPT},
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005696 * {@link #PERMISSION_POLICY_AUTO_GRANT} and {@link #PERMISSION_POLICY_AUTO_DENY}.
5697 * @throws SecurityException if {@code admin} is not a device or profile owner.
Benjamin Franz45dd6662015-07-08 14:24:14 +01005698 * @see #setPermissionGrantState
Amith Yamasanid49489b2015-04-28 14:00:26 -07005699 */
Robin Lee25e26452015-06-02 09:56:29 -07005700 public void setPermissionPolicy(@NonNull ComponentName admin, int policy) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005701 throwIfParentInstance("setPermissionPolicy");
Amith Yamasanid49489b2015-04-28 14:00:26 -07005702 try {
5703 mService.setPermissionPolicy(admin, policy);
5704 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005705 throw re.rethrowFromSystemServer();
Amith Yamasanid49489b2015-04-28 14:00:26 -07005706 }
5707 }
5708
5709 /**
5710 * Returns the current runtime permission policy set by the device or profile owner. The
5711 * default is {@link #PERMISSION_POLICY_PROMPT}.
5712 * @param admin Which profile or device owner this request is associated with.
5713 * @return the current policy for future permission requests.
5714 */
Esteban Talavera28b95702015-06-24 15:23:42 +01005715 public int getPermissionPolicy(ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005716 throwIfParentInstance("getPermissionPolicy");
Amith Yamasanid49489b2015-04-28 14:00:26 -07005717 try {
5718 return mService.getPermissionPolicy(admin);
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 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005725 * Sets the grant state of a runtime permission for a specific application. The state can be
5726 * {@link #PERMISSION_GRANT_STATE_DEFAULT default} in which a user can manage it through the UI,
5727 * {@link #PERMISSION_GRANT_STATE_DENIED denied}, in which the permission is denied and the user
5728 * cannot manage it through the UI, and {@link #PERMISSION_GRANT_STATE_GRANTED granted} in which
5729 * the permission is granted and the user cannot manage it through the UI. This might affect all
5730 * permissions in a group that the runtime permission belongs to. This method can only be called
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07005731 * by a profile or device owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005732 * <p/>
5733 * Setting the grant state to {@link #PERMISSION_GRANT_STATE_DEFAULT default} does not revoke
5734 * the permission. It retains the previous grant, if any.
5735 * <p/>
5736 * Permissions can be granted or revoked only for applications built with a
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07005737 * {@code targetSdkVersion} of {@link android.os.Build.VERSION_CODES#M} or later.
Amith Yamasani0bf8f7c2015-06-22 13:00:32 -07005738 *
Amith Yamasanid49489b2015-04-28 14:00:26 -07005739 * @param admin Which profile or device owner this request is associated with.
5740 * @param packageName The application to grant or revoke a permission to.
5741 * @param permission The permission to grant or revoke.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005742 * @param grantState The permission grant state which is one of
5743 * {@link #PERMISSION_GRANT_STATE_DENIED}, {@link #PERMISSION_GRANT_STATE_DEFAULT},
5744 * {@link #PERMISSION_GRANT_STATE_GRANTED},
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07005745 * @return whether the permission was successfully granted or revoked.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005746 * @throws SecurityException if {@code admin} is not a device or profile owner.
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07005747 * @see #PERMISSION_GRANT_STATE_DENIED
5748 * @see #PERMISSION_GRANT_STATE_DEFAULT
5749 * @see #PERMISSION_GRANT_STATE_GRANTED
Amith Yamasanid49489b2015-04-28 14:00:26 -07005750 */
Robin Lee25e26452015-06-02 09:56:29 -07005751 public boolean setPermissionGrantState(@NonNull ComponentName admin, String packageName,
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07005752 String permission, int grantState) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005753 throwIfParentInstance("setPermissionGrantState");
Amith Yamasanid49489b2015-04-28 14:00:26 -07005754 try {
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07005755 return mService.setPermissionGrantState(admin, packageName, permission, grantState);
Amith Yamasanid49489b2015-04-28 14:00:26 -07005756 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005757 throw re.rethrowFromSystemServer();
Amith Yamasanid49489b2015-04-28 14:00:26 -07005758 }
5759 }
Amith Yamasani184b3752015-05-22 13:00:51 -07005760
5761 /**
5762 * Returns the current grant state of a runtime permission for a specific application.
5763 *
5764 * @param admin Which profile or device owner this request is associated with.
5765 * @param packageName The application to check the grant state for.
5766 * @param permission The permission to check for.
5767 * @return the current grant state specified by device policy. If the profile or device owner
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005768 * has not set a grant state, the return value is
5769 * {@link #PERMISSION_GRANT_STATE_DEFAULT}. This does not indicate whether or not the
5770 * permission is currently granted for the package.
5771 * <p/>
5772 * If a grant state was set by the profile or device owner, then the return value will
5773 * be one of {@link #PERMISSION_GRANT_STATE_DENIED} or
5774 * {@link #PERMISSION_GRANT_STATE_GRANTED}, which indicates if the permission is
5775 * currently denied or granted.
5776 * @throws SecurityException if {@code admin} is not a device or profile owner.
Amith Yamasani184b3752015-05-22 13:00:51 -07005777 * @see #setPermissionGrantState(ComponentName, String, String, int)
5778 * @see PackageManager#checkPermission(String, String)
5779 */
Robin Lee25e26452015-06-02 09:56:29 -07005780 public int getPermissionGrantState(@NonNull ComponentName admin, String packageName,
Amith Yamasani184b3752015-05-22 13:00:51 -07005781 String permission) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005782 throwIfParentInstance("getPermissionGrantState");
Amith Yamasani184b3752015-05-22 13:00:51 -07005783 try {
5784 return mService.getPermissionGrantState(admin, packageName, permission);
5785 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005786 throw re.rethrowFromSystemServer();
Amith Yamasani184b3752015-05-22 13:00:51 -07005787 }
5788 }
Nicolas Prevot07387fe2015-10-30 17:53:30 +00005789
5790 /**
5791 * Returns if provisioning a managed profile or device is possible or not.
5792 * @param action One of {@link #ACTION_PROVISION_MANAGED_DEVICE},
5793 * {@link #ACTION_PROVISION_MANAGED_PROFILE}.
Nicolas Prevot07387fe2015-10-30 17:53:30 +00005794 * @return if provisioning a managed profile or device is possible or not.
5795 * @throws IllegalArgumentException if the supplied action is not valid.
5796 */
5797 public boolean isProvisioningAllowed(String action) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005798 throwIfParentInstance("isProvisioningAllowed");
Nicolas Prevot07387fe2015-10-30 17:53:30 +00005799 try {
5800 return mService.isProvisioningAllowed(action);
5801 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005802 throw re.rethrowFromSystemServer();
Nicolas Prevot07387fe2015-10-30 17:53:30 +00005803 }
5804 }
Mahaver Chopra15a46b02015-11-11 14:54:35 +00005805
5806 /**
Mahaver Chopra15a46b02015-11-11 14:54:35 +00005807 * Return if this user is a managed profile of another user. An admin can become the profile
5808 * owner of a managed profile with {@link #ACTION_PROVISION_MANAGED_PROFILE} and of a managed
Kenny Guyffa38402016-03-31 16:40:57 +01005809 * user with {@link #createAndManageUser}
Mahaver Chopra15a46b02015-11-11 14:54:35 +00005810 * @param admin Which profile owner this request is associated with.
5811 * @return if this user is a managed profile of another user.
5812 */
5813 public boolean isManagedProfile(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005814 throwIfParentInstance("isManagedProfile");
Mahaver Chopra15a46b02015-11-11 14:54:35 +00005815 try {
5816 return mService.isManagedProfile(admin);
5817 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005818 throw re.rethrowFromSystemServer();
Mahaver Chopra15a46b02015-11-11 14:54:35 +00005819 }
5820 }
5821
5822 /**
5823 * @hide
5824 * Return if this user is a system-only user. An admin can manage a device from a system only
5825 * user by calling {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE}.
5826 * @param admin Which device owner this request is associated with.
5827 * @return if this user is a system-only user.
5828 */
5829 public boolean isSystemOnlyUser(@NonNull ComponentName admin) {
5830 try {
5831 return mService.isSystemOnlyUser(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 }
Makoto Onukia31ebbc2015-11-23 17:15:21 -08005836
5837 /**
5838 * Called by device owner to get the MAC address of the Wi-Fi device.
5839 *
Sudheer Shanka3cb4da12016-03-07 18:51:49 -08005840 * @param admin Which device owner this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005841 * @return the MAC address of the Wi-Fi device, or null when the information is not available.
5842 * (For example, Wi-Fi hasn't been enabled, or the device doesn't support Wi-Fi.)
5843 * <p>
5844 * The address will be in the {@code XX:XX:XX:XX:XX:XX} format.
5845 * @throws SecurityException if {@code admin} is not a device owner.
Makoto Onukia31ebbc2015-11-23 17:15:21 -08005846 */
Sudheer Shanka3cb4da12016-03-07 18:51:49 -08005847 public String getWifiMacAddress(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005848 throwIfParentInstance("getWifiMacAddress");
Makoto Onukia31ebbc2015-11-23 17:15:21 -08005849 try {
Sudheer Shanka3cb4da12016-03-07 18:51:49 -08005850 return mService.getWifiMacAddress(admin);
Makoto Onukia31ebbc2015-11-23 17:15:21 -08005851 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005852 throw re.rethrowFromSystemServer();
Makoto Onukia31ebbc2015-11-23 17:15:21 -08005853 }
5854 }
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +00005855
5856 /**
Mahaver Chopra1216ae52016-03-11 15:39:48 +00005857 * Called by device owner to reboot the device. If there is an ongoing call on the device,
5858 * throws an {@link IllegalStateException}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005859 * @param admin Which device owner the request is associated with.
Mahaver Chopra1216ae52016-03-11 15:39:48 +00005860 * @throws IllegalStateException if device has an ongoing call.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005861 * @throws SecurityException if {@code admin} is not a device owner.
Mahaver Chopra1216ae52016-03-11 15:39:48 +00005862 * @see TelephonyManager#CALL_STATE_IDLE
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +00005863 */
5864 public void reboot(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005865 throwIfParentInstance("reboot");
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +00005866 try {
5867 mService.reboot(admin);
5868 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005869 throw re.rethrowFromSystemServer();
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +00005870 }
5871 }
Kenny Guy06de4e72015-12-22 12:07:39 +00005872
5873 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005874 * Called by a device admin to set the short support message. This will be displayed to the user
5875 * in settings screens where funtionality has been disabled by the admin. The message should be
5876 * limited to a short statement such as "This setting is disabled by your administrator. Contact
5877 * someone@example.com for support." If the message is longer than 200 characters it may be
5878 * truncated.
5879 * <p>
5880 * If the short support message needs to be localized, it is the responsibility of the
Benjamin Franz3e8a7092016-01-25 16:19:08 +00005881 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
5882 * and set a new version of this string accordingly.
5883 *
Kenny Guy06de4e72015-12-22 12:07:39 +00005884 * @see #setLongSupportMessage
Kenny Guy06de4e72015-12-22 12:07:39 +00005885 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005886 * @param message Short message to be displayed to the user in settings or null to clear the
5887 * existing message.
5888 * @throws SecurityException if {@code admin} is not an active administrator.
Kenny Guy06de4e72015-12-22 12:07:39 +00005889 */
5890 public void setShortSupportMessage(@NonNull ComponentName admin,
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07005891 @Nullable CharSequence message) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005892 throwIfParentInstance("setShortSupportMessage");
Kenny Guy06de4e72015-12-22 12:07:39 +00005893 if (mService != null) {
5894 try {
5895 mService.setShortSupportMessage(admin, message);
5896 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005897 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00005898 }
5899 }
5900 }
5901
5902 /**
5903 * Called by a device admin to get the short support message.
5904 *
5905 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07005906 * @return The message set by {@link #setShortSupportMessage(ComponentName, CharSequence)} or
5907 * null if no message has been set.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005908 * @throws SecurityException if {@code admin} is not an active administrator.
Kenny Guy06de4e72015-12-22 12:07:39 +00005909 */
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07005910 public CharSequence getShortSupportMessage(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005911 throwIfParentInstance("getShortSupportMessage");
Kenny Guy06de4e72015-12-22 12:07:39 +00005912 if (mService != null) {
5913 try {
5914 return mService.getShortSupportMessage(admin);
5915 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005916 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00005917 }
5918 }
5919 return null;
5920 }
5921
5922 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005923 * Called by a device admin to set the long support message. This will be displayed to the user
5924 * in the device administators settings screen.
5925 * <p>
5926 * If the long support message needs to be localized, it is the responsibility of the
Benjamin Franz3e8a7092016-01-25 16:19:08 +00005927 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
5928 * and set a new version of this string accordingly.
5929 *
Kenny Guy06de4e72015-12-22 12:07:39 +00005930 * @see #setShortSupportMessage
Kenny Guy06de4e72015-12-22 12:07:39 +00005931 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005932 * @param message Long message to be displayed to the user in settings or null to clear the
5933 * existing message.
5934 * @throws SecurityException if {@code admin} is not an active administrator.
Kenny Guy06de4e72015-12-22 12:07:39 +00005935 */
5936 public void setLongSupportMessage(@NonNull ComponentName admin,
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07005937 @Nullable CharSequence message) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005938 throwIfParentInstance("setLongSupportMessage");
Kenny Guy06de4e72015-12-22 12:07:39 +00005939 if (mService != null) {
5940 try {
5941 mService.setLongSupportMessage(admin, message);
5942 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005943 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00005944 }
5945 }
5946 }
5947
5948 /**
5949 * Called by a device admin to get the long support message.
5950 *
5951 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07005952 * @return The message set by {@link #setLongSupportMessage(ComponentName, CharSequence)} or
5953 * null if no message has been set.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005954 * @throws SecurityException if {@code admin} is not an active administrator.
Kenny Guy06de4e72015-12-22 12:07:39 +00005955 */
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07005956 public CharSequence getLongSupportMessage(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01005957 throwIfParentInstance("getLongSupportMessage");
Kenny Guy06de4e72015-12-22 12:07:39 +00005958 if (mService != null) {
5959 try {
5960 return mService.getLongSupportMessage(admin);
5961 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005962 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00005963 }
5964 }
5965 return null;
5966 }
5967
5968 /**
5969 * Called by the system to get the short support message.
5970 *
5971 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5972 * @param userHandle user id the admin is running as.
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07005973 * @return The message set by {@link #setShortSupportMessage(ComponentName, CharSequence)}
Kenny Guy06de4e72015-12-22 12:07:39 +00005974 *
5975 * @hide
5976 */
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07005977 public CharSequence getShortSupportMessageForUser(@NonNull ComponentName admin,
5978 int userHandle) {
Kenny Guy06de4e72015-12-22 12:07:39 +00005979 if (mService != null) {
5980 try {
5981 return mService.getShortSupportMessageForUser(admin, userHandle);
5982 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005983 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00005984 }
5985 }
5986 return null;
5987 }
5988
5989
5990 /**
5991 * Called by the system to get the long support message.
5992 *
5993 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5994 * @param userHandle user id the admin is running as.
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07005995 * @return The message set by {@link #setLongSupportMessage(ComponentName, CharSequence)}
Kenny Guy06de4e72015-12-22 12:07:39 +00005996 *
5997 * @hide
5998 */
Sudheer Shanka3ccca91e2016-04-11 21:36:17 -07005999 public CharSequence getLongSupportMessageForUser(@NonNull ComponentName admin, int userHandle) {
Kenny Guy06de4e72015-12-22 12:07:39 +00006000 if (mService != null) {
6001 try {
6002 return mService.getLongSupportMessageForUser(admin, userHandle);
6003 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006004 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00006005 }
6006 }
6007 return null;
6008 }
Clara Bayarri3e826ef2015-12-14 17:51:22 +00006009
6010 /**
Esteban Talavera62399912016-01-11 15:37:55 +00006011 * Called by the profile owner of a managed profile to obtain a {@link DevicePolicyManager}
6012 * whose calls act on the parent profile.
Benjamin Franz66b45f02016-04-05 19:12:39 +01006013 *
6014 * <p>The following methods are supported for the parent instance, all other methods will
6015 * throw a SecurityException when called on the parent instance:
6016 * <ul>
6017 * <li>{@link #getPasswordQuality}</li>
6018 * <li>{@link #setPasswordQuality}</li>
6019 * <li>{@link #getPasswordMinimumLength}</li>
6020 * <li>{@link #setPasswordMinimumLength}</li>
6021 * <li>{@link #getPasswordMinimumUpperCase}</li>
6022 * <li>{@link #setPasswordMinimumUpperCase}</li>
6023 * <li>{@link #getPasswordMinimumLowerCase}</li>
6024 * <li>{@link #setPasswordMinimumLowerCase}</li>
6025 * <li>{@link #getPasswordMinimumLetters}</li>
6026 * <li>{@link #setPasswordMinimumLetters}</li>
6027 * <li>{@link #getPasswordMinimumNumeric}</li>
6028 * <li>{@link #setPasswordMinimumNumeric}</li>
6029 * <li>{@link #getPasswordMinimumSymbols}</li>
6030 * <li>{@link #setPasswordMinimumSymbols}</li>
6031 * <li>{@link #getPasswordMinimumNonLetter}</li>
6032 * <li>{@link #setPasswordMinimumNonLetter}</li>
6033 * <li>{@link #getPasswordHistoryLength}</li>
6034 * <li>{@link #setPasswordHistoryLength}</li>
6035 * <li>{@link #getPasswordExpirationTimeout}</li>
6036 * <li>{@link #setPasswordExpirationTimeout}</li>
6037 * <li>{@link #getPasswordExpiration}</li>
6038 * <li>{@link #isActivePasswordSufficient}</li>
6039 * <li>{@link #getCurrentFailedPasswordAttempts}</li>
6040 * <li>{@link #getMaximumFailedPasswordsForWipe}</li>
6041 * <li>{@link #setMaximumFailedPasswordsForWipe}</li>
6042 * <li>{@link #getMaximumTimeToLock}</li>
6043 * <li>{@link #setMaximumTimeToLock}</li>
6044 * <li>{@link #lockNow}</li>
6045 * <li>{@link #getKeyguardDisabledFeatures}</li>
6046 * <li>{@link #setKeyguardDisabledFeatures}</li>
6047 * <li>{@link #getTrustAgentConfiguration}</li>
6048 * <li>{@link #setTrustAgentConfiguration}</li>
6049 * </ul>
Clara Bayarri3e826ef2015-12-14 17:51:22 +00006050 *
6051 * @return a new instance of {@link DevicePolicyManager} that acts on the parent profile.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006052 * @throws SecurityException if {@code admin} is not a profile owner.
Clara Bayarri3e826ef2015-12-14 17:51:22 +00006053 */
6054 public DevicePolicyManager getParentProfileInstance(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006055 throwIfParentInstance("getParentProfileInstance");
Clara Bayarri3e826ef2015-12-14 17:51:22 +00006056 try {
6057 if (!mService.isManagedProfile(admin)) {
6058 throw new SecurityException("The current user does not have a parent profile.");
6059 }
6060 return new DevicePolicyManager(mContext, true);
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006061 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006062 throw e.rethrowFromSystemServer();
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006063 }
6064 }
6065
6066 /**
Michal Karpinski6235a942016-03-15 12:07:23 +00006067 * Called by device owner to control the security logging feature. Logging can only be
6068 * enabled on single user devices where the sole user is managed by the device owner.
6069 *
6070 * <p> Security logs contain various information intended for security auditing purposes.
6071 * See {@link SecurityEvent} for details.
6072 *
6073 * <p>There must be only one user on the device, managed by the device owner.
6074 * Otherwise a {@link SecurityException} will be thrown.
Michal Karpinskib58e4962016-03-01 14:55:10 +00006075 *
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006076 * @param admin Which device owner this request is associated with.
Michal Karpinski6235a942016-03-15 12:07:23 +00006077 * @param enabled whether security logging should be enabled or not.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006078 * @throws SecurityException if {@code admin} is not a device owner.
Michal Karpinski6235a942016-03-15 12:07:23 +00006079 * @see #retrieveSecurityLogs
6080 */
6081 public void setSecurityLoggingEnabled(@NonNull ComponentName admin, boolean enabled) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006082 throwIfParentInstance("setSecurityLoggingEnabled");
Michal Karpinski6235a942016-03-15 12:07:23 +00006083 try {
6084 mService.setSecurityLoggingEnabled(admin, enabled);
6085 } catch (RemoteException re) {
6086 throw re.rethrowFromSystemServer();
6087 }
6088 }
6089
6090 /**
Michal Karpinski6235a942016-03-15 12:07:23 +00006091 * Return whether security logging is enabled or not by the device owner.
6092 *
6093 * <p>Can only be called by the device owner, otherwise a {@link SecurityException} will be
6094 * thrown.
6095 *
6096 * @param admin Which device owner this request is associated with.
6097 * @return {@code true} if security logging is enabled by device owner, {@code false} otherwise.
6098 * @throws SecurityException if {@code admin} is not a device owner.
6099 */
6100 public boolean isSecurityLoggingEnabled(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006101 throwIfParentInstance("isSecurityLoggingEnabled");
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006102 try {
Michal Karpinski6235a942016-03-15 12:07:23 +00006103 return mService.isSecurityLoggingEnabled(admin);
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006104 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006105 throw re.rethrowFromSystemServer();
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006106 }
6107 }
6108
6109 /**
Michal Karpinski6235a942016-03-15 12:07:23 +00006110 * Called by device owner to retrieve all new security logging entries since the last call to
6111 * this API after device boots.
6112 *
6113 * <p> Access to the logs is rate limited and it will only return new logs after the device
6114 * owner has been notified via {@link DeviceAdminReceiver#onSecurityLogsAvailable}.
6115 *
6116 * <p>There must be only one user on the device, managed by the device owner.
6117 * Otherwise a {@link SecurityException} will be thrown.
Michal Karpinskib58e4962016-03-01 14:55:10 +00006118 *
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006119 * @param admin Which device owner this request is associated with.
Michal Karpinski6235a942016-03-15 12:07:23 +00006120 * @return the new batch of security logs which is a list of {@link SecurityEvent},
6121 * or {@code null} if rate limitation is exceeded or if logging is currently disabled.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006122 * @throws SecurityException if {@code admin} is not a device owner.
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006123 */
Michal Karpinski6235a942016-03-15 12:07:23 +00006124 public List<SecurityEvent> retrieveSecurityLogs(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006125 throwIfParentInstance("retrieveSecurityLogs");
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006126 try {
Michal Karpinski6235a942016-03-15 12:07:23 +00006127 ParceledListSlice<SecurityEvent> list = mService.retrieveSecurityLogs(admin);
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006128 if (list != null) {
6129 return list.getList();
6130 } else {
6131 // Rate limit exceeded.
6132 return null;
6133 }
Clara Bayarri3e826ef2015-12-14 17:51:22 +00006134 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006135 throw re.rethrowFromSystemServer();
Clara Bayarri3e826ef2015-12-14 17:51:22 +00006136 }
6137 }
Benjamin Franz59720bb2016-01-18 15:26:11 +00006138
6139 /**
Sudheer Shanka978fc0d2016-01-28 13:51:10 +00006140 * Called by the system to obtain a {@link DevicePolicyManager} whose calls act on the parent
6141 * profile.
6142 *
6143 * @hide
6144 */
6145 public DevicePolicyManager getParentProfileInstance(UserInfo uInfo) {
6146 mContext.checkSelfPermission(
6147 android.Manifest.permission.MANAGE_PROFILE_AND_DEVICE_OWNERS);
6148 if (!uInfo.isManagedProfile()) {
6149 throw new SecurityException("The user " + uInfo.id
6150 + " does not have a parent profile.");
6151 }
6152 return new DevicePolicyManager(mContext, true);
6153 }
6154
6155 /**
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006156 * Called by device owners to retrieve device logs from before the device's last reboot.
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006157 * <p>
Rubin Xu0fb6b9e2016-05-04 19:01:07 +01006158 * <strong> This API is not supported on all devices. Calling this API on unsupported devices
6159 * will result in {@code null} being returned. The device logs are retrieved from a RAM region
6160 * which is not guaranteed to be corruption-free during power cycles, as a result be cautious
6161 * about data corruption when parsing. </strong>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006162 * <p>
6163 * There must be only one user on the device, managed by the device owner. Otherwise a
6164 * {@link SecurityException} will be thrown.
Michal Karpinskib58e4962016-03-01 14:55:10 +00006165 *
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006166 * @param admin Which device owner this request is associated with.
Rubin Xu0fb6b9e2016-05-04 19:01:07 +01006167 * @return Device logs from before the latest reboot of the system, or {@code null} if this API
6168 * is not supported on the device.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006169 * @throws SecurityException if {@code admin} is not a device owner.
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006170 */
Michal Karpinski6235a942016-03-15 12:07:23 +00006171 public List<SecurityEvent> retrievePreRebootSecurityLogs(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006172 throwIfParentInstance("retrievePreRebootSecurityLogs");
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006173 try {
Michal Karpinski6235a942016-03-15 12:07:23 +00006174 ParceledListSlice<SecurityEvent> list = mService.retrievePreRebootSecurityLogs(admin);
Rubin Xu0fb6b9e2016-05-04 19:01:07 +01006175 if (list != null) {
6176 return list.getList();
6177 } else {
6178 return null;
6179 }
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006180 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006181 throw re.rethrowFromSystemServer();
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006182 }
6183 }
6184
6185 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006186 * Called by a profile owner of a managed profile to set the color used for customization. This
6187 * color is used as background color of the confirm credentials screen for that user. The
Clara Bayarri8d0bd7fa2016-03-30 14:59:58 +01006188 * default color is teal (#00796B).
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006189 * <p>
6190 * The confirm credentials screen can be created using
Benjamin Franz59720bb2016-01-18 15:26:11 +00006191 * {@link android.app.KeyguardManager#createConfirmDeviceCredentialIntent}.
6192 *
6193 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Michal Karpinski74cd7302016-04-12 15:17:36 +01006194 * @param color The 24bit (0xRRGGBB) representation of the color to be used.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006195 * @throws SecurityException if {@code admin} is not a profile owner.
Benjamin Franz59720bb2016-01-18 15:26:11 +00006196 */
6197 public void setOrganizationColor(@NonNull ComponentName admin, int color) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006198 throwIfParentInstance("setOrganizationColor");
Benjamin Franz59720bb2016-01-18 15:26:11 +00006199 try {
Michal Karpinski74cd7302016-04-12 15:17:36 +01006200 // always enforce alpha channel to have 100% opacity
6201 color |= 0xFF000000;
Benjamin Franz59720bb2016-01-18 15:26:11 +00006202 mService.setOrganizationColor(admin, color);
6203 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006204 throw re.rethrowFromSystemServer();
Benjamin Franz59720bb2016-01-18 15:26:11 +00006205 }
6206 }
6207
6208 /**
Nicolas Prevot8f7698a2016-02-11 16:05:33 +00006209 * @hide
6210 *
6211 * Sets the color used for customization.
6212 *
Michal Karpinski74cd7302016-04-12 15:17:36 +01006213 * @param color The 24bit (0xRRGGBB) representation of the color to be used.
Nicolas Prevot8f7698a2016-02-11 16:05:33 +00006214 * @param userId which user to set the color to.
6215 * @RequiresPermission(allOf = {
6216 * Manifest.permission.MANAGE_USERS,
6217 * Manifest.permission.INTERACT_ACROSS_USERS_FULL})
6218 */
6219 public void setOrganizationColorForUser(@ColorInt int color, @UserIdInt int userId) {
6220 try {
Michal Karpinski74cd7302016-04-12 15:17:36 +01006221 // always enforce alpha channel to have 100% opacity
6222 color |= 0xFF000000;
Nicolas Prevot8f7698a2016-02-11 16:05:33 +00006223 mService.setOrganizationColorForUser(color, userId);
6224 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006225 throw re.rethrowFromSystemServer();
Nicolas Prevot8f7698a2016-02-11 16:05:33 +00006226 }
6227 }
6228
6229 /**
Benjamin Franz59720bb2016-01-18 15:26:11 +00006230 * Called by a profile owner of a managed profile to retrieve the color used for customization.
6231 * This color is used as background color of the confirm credentials screen for that user.
6232 *
6233 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Michal Karpinski74cd7302016-04-12 15:17:36 +01006234 * @return The 24bit (0xRRGGBB) representation of the color to be used.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006235 * @throws SecurityException if {@code admin} is not a profile owner.
Benjamin Franz59720bb2016-01-18 15:26:11 +00006236 */
Michal Karpinski74cd7302016-04-12 15:17:36 +01006237 public @ColorInt int getOrganizationColor(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006238 throwIfParentInstance("getOrganizationColor");
Benjamin Franz59720bb2016-01-18 15:26:11 +00006239 try {
6240 return mService.getOrganizationColor(admin);
6241 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006242 throw re.rethrowFromSystemServer();
Benjamin Franz59720bb2016-01-18 15:26:11 +00006243 }
6244 }
6245
6246 /**
6247 * @hide
6248 * Retrieve the customization color for a given user.
6249 *
6250 * @param userHandle The user id of the user we're interested in.
Michal Karpinski74cd7302016-04-12 15:17:36 +01006251 * @return The 24bit (0xRRGGBB) representation of the color to be used.
Benjamin Franz59720bb2016-01-18 15:26:11 +00006252 */
Michal Karpinski74cd7302016-04-12 15:17:36 +01006253 public @ColorInt int getOrganizationColorForUser(int userHandle) {
Benjamin Franz59720bb2016-01-18 15:26:11 +00006254 try {
6255 return mService.getOrganizationColorForUser(userHandle);
6256 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006257 throw re.rethrowFromSystemServer();
Benjamin Franz59720bb2016-01-18 15:26:11 +00006258 }
6259 }
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01006260
6261 /**
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006262 * Called by a profile owner of a managed profile to set the name of the organization under
6263 * management.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006264 * <p>
6265 * If the organization name needs to be localized, it is the responsibility of the
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006266 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
6267 * and set a new version of this string accordingly.
6268 *
6269 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6270 * @param title The organization name or {@code null} to clear a previously set name.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006271 * @throws SecurityException if {@code admin} is not a profile owner.
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006272 */
Michal Karpinski74cd7302016-04-12 15:17:36 +01006273 public void setOrganizationName(@NonNull ComponentName admin, @Nullable CharSequence title) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006274 throwIfParentInstance("setOrganizationName");
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006275 try {
6276 mService.setOrganizationName(admin, title);
6277 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006278 throw re.rethrowFromSystemServer();
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006279 }
6280 }
6281
6282 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006283 * Called by a profile owner of a managed profile to retrieve the name of the organization under
6284 * management.
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006285 *
6286 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6287 * @return The organization name or {@code null} if none is set.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006288 * @throws SecurityException if {@code admin} is not a profile owner.
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006289 */
Michal Karpinski74cd7302016-04-12 15:17:36 +01006290 public CharSequence getOrganizationName(@NonNull ComponentName admin) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006291 throwIfParentInstance("getOrganizationName");
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006292 try {
6293 return mService.getOrganizationName(admin);
6294 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006295 throw re.rethrowFromSystemServer();
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006296 }
6297 }
6298
6299 /**
6300 * Retrieve the default title message used in the confirm credentials screen for a given user.
6301 *
6302 * @param userHandle The user id of the user we're interested in.
6303 * @return The organization name or {@code null} if none is set.
6304 *
6305 * @hide
6306 */
Michal Karpinski74cd7302016-04-12 15:17:36 +01006307 public CharSequence getOrganizationNameForUser(int userHandle) {
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006308 try {
6309 return mService.getOrganizationNameForUser(userHandle);
6310 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006311 throw re.rethrowFromSystemServer();
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006312 }
6313 }
6314
6315 /**
Alan Treadwayafad8782016-01-19 15:15:08 +00006316 * @return the {@link UserProvisioningState} for the current user - for unmanaged users will
6317 * return {@link #STATE_USER_UNMANAGED}
6318 * @hide
6319 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00006320 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00006321 @UserProvisioningState
6322 public int getUserProvisioningState() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006323 throwIfParentInstance("getUserProvisioningState");
Alan Treadwayafad8782016-01-19 15:15:08 +00006324 if (mService != null) {
6325 try {
6326 return mService.getUserProvisioningState();
6327 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006328 throw e.rethrowFromSystemServer();
Alan Treadwayafad8782016-01-19 15:15:08 +00006329 }
6330 }
6331 return STATE_USER_UNMANAGED;
6332 }
6333
6334 /**
6335 * Set the {@link UserProvisioningState} for the supplied user, if they are managed.
6336 *
6337 * @param state to store
6338 * @param userHandle for user
6339 * @hide
6340 */
6341 public void setUserProvisioningState(@UserProvisioningState int state, int userHandle) {
6342 if (mService != null) {
6343 try {
6344 mService.setUserProvisioningState(state, userHandle);
6345 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006346 throw e.rethrowFromSystemServer();
Alan Treadwayafad8782016-01-19 15:15:08 +00006347 }
6348 }
6349 }
6350
6351 /**
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01006352 * @hide
6353 * Indicates the entity that controls the device or profile owner. A user/profile is considered
6354 * affiliated if it is managed by the same entity as the device.
6355 *
6356 * <p> By definition, the user that the device owner runs on is always affiliated. Any other
6357 * user/profile is considered affiliated if the following conditions are both met:
6358 * <ul>
6359 * <li>The device owner and the user's/profile's profile owner have called this method,
6360 * specifying a set of opaque affiliation ids each. If the sets specified by the device owner
6361 * and a profile owner intersect, they must have come from the same source, which means that
6362 * the device owner and profile owner are controlled by the same entity.</li>
6363 * <li>The device owner's and profile owner's package names are the same.</li>
6364 * </ul>
6365 *
6366 * @param admin Which profile or device owner this request is associated with.
6367 * @param ids A set of opaque affiliation ids.
6368 */
6369 public void setAffiliationIds(@NonNull ComponentName admin, Set<String> ids) {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006370 throwIfParentInstance("setAffiliationIds");
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01006371 try {
6372 mService.setAffiliationIds(admin, new ArrayList<String>(ids));
6373 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006374 throw e.rethrowFromSystemServer();
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01006375 }
6376 }
6377
6378 /**
6379 * @hide
6380 * Returns whether this user/profile is affiliated with the device. See
6381 * {@link #setAffiliationIds} for the definition of affiliation.
6382 *
6383 * @return whether this user/profile is affiliated with the device.
6384 */
6385 public boolean isAffiliatedUser() {
Benjamin Franzbc33c822016-04-15 08:57:52 +01006386 throwIfParentInstance("isAffiliatedUser");
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01006387 try {
6388 return mService != null && mService.isAffiliatedUser();
6389 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006390 throw e.rethrowFromSystemServer();
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01006391 }
6392 }
Suprabh Shuklaa2ae2232016-01-28 18:05:14 -08006393
6394 /**
6395 * @hide
6396 * Returns whether the uninstall for {@code packageName} for the current user is in queue
6397 * to be started
6398 * @param packageName the package to check for
6399 * @return whether the uninstall intent for {@code packageName} is pending
6400 */
6401 public boolean isUninstallInQueue(String packageName) {
6402 try {
6403 return mService.isUninstallInQueue(packageName);
6404 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006405 throw re.rethrowFromSystemServer();
Suprabh Shuklaa2ae2232016-01-28 18:05:14 -08006406 }
6407 }
6408
6409 /**
6410 * @hide
6411 * @param packageName the package containing active DAs to be uninstalled
6412 */
6413 public void uninstallPackageWithActiveAdmins(String packageName) {
6414 try {
6415 mService.uninstallPackageWithActiveAdmins(packageName);
6416 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006417 throw re.rethrowFromSystemServer();
Suprabh Shuklaa2ae2232016-01-28 18:05:14 -08006418 }
6419 }
Benjamin Franzbc33c822016-04-15 08:57:52 +01006420
Kenny Guy38dcca52016-04-19 13:09:18 +01006421 /**
6422 * @hide
6423 * Remove a test admin synchronously without sending it a broadcast about being removed.
6424 * If the admin is a profile owner or device owner it will still be removed.
6425 *
6426 * @param userHandle user id to remove the admin for.
6427 * @param admin The administration compononent to remove.
6428 * @throws SecurityException if the caller is not shell / root or the admin package
6429 * isn't a test application see {@link ApplicationInfo#FLAG_TEST_APP}.
6430 */
6431 public void forceRemoveActiveAdmin(ComponentName adminReceiver, int userHandle) {
6432 try {
6433 mService.forceRemoveActiveAdmin(adminReceiver, userHandle);
6434 } catch (RemoteException re) {
6435 throw re.rethrowFromSystemServer();
6436 }
6437 }
6438
Benjamin Franzbc33c822016-04-15 08:57:52 +01006439 private void throwIfParentInstance(String functionName) {
6440 if (mParentInstance) {
6441 throw new SecurityException(functionName + " cannot be called on the parent instance");
6442 }
6443 }
Dianne Hackbornd6847842010-01-12 18:14:19 -08006444}