blob: 96757bba510de32246a52c95514ea311b6224b25 [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() {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001096 return getActiveAdminsAsUser(myUserId());
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01001097 }
1098
1099 /**
1100 * @see #getActiveAdmins()
1101 * @hide
1102 */
1103 public List<ComponentName> getActiveAdminsAsUser(int userId) {
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001104 if (mService != null) {
1105 try {
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01001106 return mService.getActiveAdmins(userId);
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001107 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001108 throw e.rethrowFromSystemServer();
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001109 }
1110 }
1111 return null;
1112 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001113
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08001114 /**
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001115 * Used by package administration code to determine if a package can be stopped
1116 * or uninstalled.
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001117 * @hide
1118 */
1119 public boolean packageHasActiveAdmins(String packageName) {
Amith Yamasanica5d6d22016-02-16 13:58:46 -08001120 return packageHasActiveAdmins(packageName, myUserId());
1121 }
1122
1123 /**
1124 * Used by package administration code to determine if a package can be stopped
1125 * or uninstalled.
1126 * @hide
1127 */
1128 public boolean packageHasActiveAdmins(String packageName, int userId) {
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001129 if (mService != null) {
1130 try {
Amith Yamasanica5d6d22016-02-16 13:58:46 -08001131 return mService.packageHasActiveAdmins(packageName, userId);
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001132 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001133 throw e.rethrowFromSystemServer();
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001134 }
1135 }
1136 return false;
1137 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001138
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001139 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -08001140 * Remove a current administration component. This can only be called
1141 * by the application that owns the administration component; if you
1142 * try to remove someone else's component, a security exception will be
1143 * thrown.
Esteban Talavera552a5612016-02-19 17:02:24 +00001144 *
1145 * <p>Note that the operation is not synchronous and the admin might still be active (as
1146 * indicated by {@link #getActiveAdmins()}) by the time this method returns.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001147 *
1148 * @param admin The administration compononent to remove.
1149 * @throws SecurityException if the caller is not in the owner application of {@code admin}.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001150 */
Robin Lee25e26452015-06-02 09:56:29 -07001151 public void removeActiveAdmin(@NonNull ComponentName admin) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001152 if (mService != null) {
1153 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001154 mService.removeActiveAdmin(admin, myUserId());
Dianne Hackbornd6847842010-01-12 18:14:19 -08001155 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001156 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001157 }
1158 }
1159 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001160
Dianne Hackbornd6847842010-01-12 18:14:19 -08001161 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001162 * Returns true if an administrator has been granted a particular device policy. This can be
1163 * used to check whether the administrator was activated under an earlier set of policies, but
1164 * requires additional policies after an upgrade.
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001165 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001166 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. Must be an
1167 * active administrator, or an exception will be thrown.
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001168 * @param usesPolicy Which uses-policy to check, as defined in {@link DeviceAdminInfo}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001169 * @throws SecurityException if {@code admin} is not an active administrator.
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001170 */
Robin Lee25e26452015-06-02 09:56:29 -07001171 public boolean hasGrantedPolicy(@NonNull ComponentName admin, int usesPolicy) {
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001172 if (mService != null) {
1173 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001174 return mService.hasGrantedPolicy(admin, usesPolicy, myUserId());
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001175 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001176 throw e.rethrowFromSystemServer();
Andy Stadlerc25f70a2010-12-08 15:56:45 -08001177 }
1178 }
1179 return false;
1180 }
1181
1182 /**
Clara Bayarria1771112015-12-18 16:29:18 +00001183 * Returns true if the Profile Challenge is available to use for the given profile user.
1184 *
1185 * @hide
1186 */
1187 public boolean isSeparateProfileChallengeAllowed(int userHandle) {
1188 if (mService != null) {
1189 try {
1190 return mService.isSeparateProfileChallengeAllowed(userHandle);
1191 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001192 throw e.rethrowFromSystemServer();
Clara Bayarria1771112015-12-18 16:29:18 +00001193 }
1194 }
1195 return false;
1196 }
1197
1198 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001199 * Constant for {@link #setPasswordQuality}: the policy has no requirements
1200 * for the password. Note that quality constants are ordered so that higher
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001201 * values are more restrictive.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001202 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001203 public static final int PASSWORD_QUALITY_UNSPECIFIED = 0;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001204
Dianne Hackbornd6847842010-01-12 18:14:19 -08001205 /**
Jim Miller3e5d3fd2011-09-02 17:30:35 -07001206 * Constant for {@link #setPasswordQuality}: the policy allows for low-security biometric
1207 * recognition technology. This implies technologies that can recognize the identity of
1208 * an individual to about a 3 digit PIN (false detection is less than 1 in 1,000).
1209 * Note that quality constants are ordered so that higher values are more restrictive.
1210 */
1211 public static final int PASSWORD_QUALITY_BIOMETRIC_WEAK = 0x8000;
1212
1213 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001214 * Constant for {@link #setPasswordQuality}: the policy requires some kind
Benjamin Franzc6a96532015-06-16 11:23:38 +01001215 * of password or pattern, but doesn't care what it is. Note that quality constants
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001216 * are ordered so that higher values are more restrictive.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001217 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001218 public static final int PASSWORD_QUALITY_SOMETHING = 0x10000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001219
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001220 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001221 * Constant for {@link #setPasswordQuality}: the user must have entered a
1222 * password containing at least numeric characters. Note that quality
1223 * constants are ordered so that higher values are more restrictive.
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001224 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001225 public static final int PASSWORD_QUALITY_NUMERIC = 0x20000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001226
Dianne Hackbornd6847842010-01-12 18:14:19 -08001227 /**
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001228 * Constant for {@link #setPasswordQuality}: the user must have entered a
Jim Miller85516d02014-01-31 17:08:37 -08001229 * password containing at least numeric characters with no repeating (4444)
1230 * or ordered (1234, 4321, 2468) sequences. Note that quality
1231 * constants are ordered so that higher values are more restrictive.
1232 */
1233 public static final int PASSWORD_QUALITY_NUMERIC_COMPLEX = 0x30000;
1234
1235 /**
1236 * Constant for {@link #setPasswordQuality}: the user must have entered a
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -07001237 * password containing at least alphabetic (or other symbol) characters.
1238 * Note that quality constants are ordered so that higher values are more
1239 * restrictive.
1240 */
1241 public static final int PASSWORD_QUALITY_ALPHABETIC = 0x40000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001242
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -07001243 /**
1244 * Constant for {@link #setPasswordQuality}: the user must have entered a
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001245 * password containing at least <em>both></em> numeric <em>and</em>
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -07001246 * alphabetic (or other symbol) characters. Note that quality constants are
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001247 * ordered so that higher values are more restrictive.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001248 */
Dianne Hackborn85f2c9c2010-03-22 11:12:48 -07001249 public static final int PASSWORD_QUALITY_ALPHANUMERIC = 0x50000;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001250
Dianne Hackbornd6847842010-01-12 18:14:19 -08001251 /**
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001252 * Constant for {@link #setPasswordQuality}: the user must have entered a
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001253 * password containing at least a letter, a numerical digit and a special
1254 * symbol, by default. With this password quality, passwords can be
1255 * restricted to contain various sets of characters, like at least an
1256 * uppercase letter, etc. These are specified using various methods,
1257 * like {@link #setPasswordMinimumLowerCase(ComponentName, int)}. Note
1258 * that quality constants are ordered so that higher values are more
1259 * restrictive.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001260 */
1261 public static final int PASSWORD_QUALITY_COMPLEX = 0x60000;
1262
1263 /**
Oleksandr Peletskyi0fdcd3d2016-01-13 16:49:56 +01001264 * Constant for {@link #setPasswordQuality}: the user is not allowed to
1265 * modify password. In case this password quality is set, the password is
1266 * managed by a profile owner. The profile owner can set any password,
1267 * as if {@link #PASSWORD_QUALITY_UNSPECIFIED} is used. Note
1268 * that quality constants are ordered so that higher values are more
1269 * restrictive. The value of {@link #PASSWORD_QUALITY_MANAGED} is
1270 * the highest.
1271 * @hide
1272 */
1273 public static final int PASSWORD_QUALITY_MANAGED = 0x80000;
1274
1275 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001276 * Called by an application that is administering the device to set the password restrictions it
1277 * is imposing. After setting this, the user will not be able to enter a new password that is
1278 * not at least as restrictive as what has been set. Note that the current password will remain
1279 * until the user has set a new one, so the change does not take place immediately. To prompt
1280 * the user for a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
Esteban Talaverac1c83592016-02-17 17:56:15 +00001281 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after calling this method.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001282 * <p>
1283 * Quality constants are ordered so that higher values are more restrictive; thus the highest
1284 * requested quality constant (between the policy set here, the user's preference, and any other
1285 * considerations) is the one that is in effect.
1286 * <p>
1287 * The calling device admin must have requested
1288 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1289 * not, a security exception will be thrown.
1290 * <p>
1291 * This method can be called on the {@link DevicePolicyManager} instance returned by
1292 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1293 * profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00001294 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08001295 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001296 * @param quality The new desired quality. One of {@link #PASSWORD_QUALITY_UNSPECIFIED},
1297 * {@link #PASSWORD_QUALITY_SOMETHING}, {@link #PASSWORD_QUALITY_NUMERIC},
1298 * {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX}, {@link #PASSWORD_QUALITY_ALPHABETIC},
1299 * {@link #PASSWORD_QUALITY_ALPHANUMERIC} or {@link #PASSWORD_QUALITY_COMPLEX}.
1300 * @throws SecurityException if {@code admin} is not an active administrator or if {@code admin}
1301 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Dianne Hackbornd6847842010-01-12 18:14:19 -08001302 */
Robin Lee25e26452015-06-02 09:56:29 -07001303 public void setPasswordQuality(@NonNull ComponentName admin, int quality) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001304 if (mService != null) {
1305 try {
Clara Bayarri3e826ef2015-12-14 17:51:22 +00001306 mService.setPasswordQuality(admin, quality, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001307 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001308 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001309 }
1310 }
1311 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001312
Dianne Hackbornd6847842010-01-12 18:14:19 -08001313 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001314 * Retrieve the current minimum password quality for a particular admin or all admins that set
1315 * retrictions on this user and its participating profiles. Restrictions on profiles that have
1316 * a separate challenge are not taken into account.
1317 *
1318 * <p>This method can be called on the {@link DevicePolicyManager} instance
1319 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1320 * restrictions on the parent profile.
1321 *
Robin Lee25e26452015-06-02 09:56:29 -07001322 * @param admin The name of the admin component to check, or {@code null} to aggregate
Dianne Hackborn254cb442010-01-27 19:23:59 -08001323 * all admins.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001324 */
Robin Lee25e26452015-06-02 09:56:29 -07001325 public int getPasswordQuality(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001326 return getPasswordQuality(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001327 }
1328
1329 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001330 public int getPasswordQuality(@Nullable ComponentName admin, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001331 if (mService != null) {
1332 try {
Clara Bayarri3e826ef2015-12-14 17:51:22 +00001333 return mService.getPasswordQuality(admin, userHandle, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001334 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001335 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001336 }
1337 }
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001338 return PASSWORD_QUALITY_UNSPECIFIED;
Dianne Hackbornd6847842010-01-12 18:14:19 -08001339 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001340
Dianne Hackbornd6847842010-01-12 18:14:19 -08001341 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001342 * Called by an application that is administering the device to set the minimum allowed password
1343 * length. After setting this, the user will not be able to enter a new password that is not at
1344 * least as restrictive as what has been set. Note that the current password will remain until
1345 * the user has set a new one, so the change does not take place immediately. To prompt the user
1346 * for a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
1347 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This constraint is
1348 * only imposed if the administrator has also requested either {@link #PASSWORD_QUALITY_NUMERIC}
1349 * , {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX}, {@link #PASSWORD_QUALITY_ALPHABETIC},
1350 * {@link #PASSWORD_QUALITY_ALPHANUMERIC}, or {@link #PASSWORD_QUALITY_COMPLEX} with
1351 * {@link #setPasswordQuality}.
1352 * <p>
1353 * The calling device admin must have requested
1354 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1355 * not, a security exception will be thrown.
1356 * <p>
1357 * This method can be called on the {@link DevicePolicyManager} instance returned by
1358 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1359 * profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00001360 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08001361 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001362 * @param length The new desired minimum password length. A value of 0 means there is no
1363 * restriction.
1364 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1365 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Dianne Hackbornd6847842010-01-12 18:14:19 -08001366 */
Robin Lee25e26452015-06-02 09:56:29 -07001367 public void setPasswordMinimumLength(@NonNull ComponentName admin, int length) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001368 if (mService != null) {
1369 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001370 mService.setPasswordMinimumLength(admin, length, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001371 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001372 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001373 }
1374 }
1375 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001376
Dianne Hackbornd6847842010-01-12 18:14:19 -08001377 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001378 * Retrieve the current minimum password length for a particular admin or all admins that set
1379 * retrictions on this user and its participating profiles. Restrictions on profiles that have
1380 * a separate challenge are not taken into account.
1381 *
1382 * <p>This method can be called on the {@link DevicePolicyManager} instance
1383 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1384 * restrictions on the parent profile.
1385 *
Jessica Hummel91da58d2014-04-10 17:39:43 +01001386 * user and its profiles or a particular one.
Robin Lee25e26452015-06-02 09:56:29 -07001387 * @param admin The name of the admin component to check, or {@code null} to aggregate
Dianne Hackborn254cb442010-01-27 19:23:59 -08001388 * all admins.
Dianne Hackbornd6847842010-01-12 18:14:19 -08001389 */
Robin Lee25e26452015-06-02 09:56:29 -07001390 public int getPasswordMinimumLength(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001391 return getPasswordMinimumLength(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001392 }
1393
1394 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001395 public int getPasswordMinimumLength(@Nullable ComponentName admin, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001396 if (mService != null) {
1397 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001398 return mService.getPasswordMinimumLength(admin, userHandle, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001399 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001400 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08001401 }
1402 }
1403 return 0;
1404 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001405
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001406 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001407 * Called by an application that is administering the device to set the minimum number of upper
1408 * case letters required in the password. After setting this, the user will not be able to enter
1409 * a new password that is not at least as restrictive as what has been set. Note that the
1410 * current password will remain until the user has set a new one, so the change does not take
1411 * place immediately. To prompt the user for a new password, use
1412 * {@link #ACTION_SET_NEW_PASSWORD} or {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after
1413 * setting this value. This constraint is only imposed if the administrator has also requested
1414 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The default value is 0.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001415 * <p>
1416 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001417 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1418 * not, a security exception will be thrown.
1419 * <p>
1420 * This method can be called on the {@link DevicePolicyManager} instance returned by
1421 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1422 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001423 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001424 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1425 * @param length The new desired minimum number of upper case letters required in the password.
1426 * A value of 0 means there is no restriction.
1427 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1428 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001429 */
Robin Lee25e26452015-06-02 09:56:29 -07001430 public void setPasswordMinimumUpperCase(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001431 if (mService != null) {
1432 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001433 mService.setPasswordMinimumUpperCase(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001434 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001435 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001436 }
1437 }
1438 }
1439
1440 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001441 * Retrieve the current number of upper case letters required in the password
1442 * for a particular admin or all admins that set retrictions on this user and
1443 * its participating profiles. Restrictions on profiles that have a separate challenge
1444 * are not taken into account.
Jessica Hummel91da58d2014-04-10 17:39:43 +01001445 * This is the same value as set by
Esteban Talaverac1c83592016-02-17 17:56:15 +00001446 * {@link #setPasswordMinimumUpperCase(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001447 * and only applies when the password quality is
1448 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001449 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001450 * <p>This method can be called on the {@link DevicePolicyManager} instance
1451 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1452 * restrictions on the parent profile.
1453 *
Robin Lee25e26452015-06-02 09:56:29 -07001454 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001455 * aggregate all admins.
1456 * @return The minimum number of upper case letters required in the
1457 * password.
1458 */
Robin Lee25e26452015-06-02 09:56:29 -07001459 public int getPasswordMinimumUpperCase(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001460 return getPasswordMinimumUpperCase(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001461 }
1462
1463 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001464 public int getPasswordMinimumUpperCase(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001465 if (mService != null) {
1466 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001467 return mService.getPasswordMinimumUpperCase(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001468 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001469 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001470 }
1471 }
1472 return 0;
1473 }
1474
1475 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001476 * Called by an application that is administering the device to set the minimum number of lower
1477 * case letters required in the password. After setting this, the user will not be able to enter
1478 * a new password that is not at least as restrictive as what has been set. Note that the
1479 * current password will remain until the user has set a new one, so the change does not take
1480 * place immediately. To prompt the user for a new password, use
1481 * {@link #ACTION_SET_NEW_PASSWORD} or {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after
1482 * setting this value. This constraint is only imposed if the administrator has also requested
1483 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The default value is 0.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001484 * <p>
1485 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001486 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1487 * not, a security exception will be thrown.
1488 * <p>
1489 * This method can be called on the {@link DevicePolicyManager} instance returned by
1490 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1491 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001492 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001493 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1494 * @param length The new desired minimum number of lower case letters required in the password.
1495 * A value of 0 means there is no restriction.
1496 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1497 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001498 */
Robin Lee25e26452015-06-02 09:56:29 -07001499 public void setPasswordMinimumLowerCase(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001500 if (mService != null) {
1501 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001502 mService.setPasswordMinimumLowerCase(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001503 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001504 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001505 }
1506 }
1507 }
1508
1509 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001510 * Retrieve the current number of lower case letters required in the password
1511 * for a particular admin or all admins that set retrictions on this user
1512 * and its participating profiles. Restrictions on profiles that have
1513 * a separate challenge are not taken into account.
Jessica Hummel91da58d2014-04-10 17:39:43 +01001514 * This is the same value as set by
Esteban Talaverac1c83592016-02-17 17:56:15 +00001515 * {@link #setPasswordMinimumLowerCase(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001516 * and only applies when the password quality is
1517 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001518 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001519 * <p>This method can be called on the {@link DevicePolicyManager} instance
1520 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1521 * restrictions on the parent profile.
1522 *
Robin Lee25e26452015-06-02 09:56:29 -07001523 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001524 * aggregate all admins.
1525 * @return The minimum number of lower case letters required in the
1526 * password.
1527 */
Robin Lee25e26452015-06-02 09:56:29 -07001528 public int getPasswordMinimumLowerCase(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001529 return getPasswordMinimumLowerCase(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001530 }
1531
1532 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001533 public int getPasswordMinimumLowerCase(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001534 if (mService != null) {
1535 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001536 return mService.getPasswordMinimumLowerCase(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001537 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001538 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001539 }
1540 }
1541 return 0;
1542 }
1543
1544 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001545 * Called by an application that is administering the device to set the minimum number of
1546 * letters required in the password. After setting this, the user will not be able to enter a
1547 * new password that is not at least as restrictive as what has been set. Note that the current
1548 * password will remain until the user has set a new one, so the change does not take place
1549 * immediately. To prompt the user for a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
1550 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This constraint is
1551 * only imposed if the administrator has also requested {@link #PASSWORD_QUALITY_COMPLEX} with
1552 * {@link #setPasswordQuality}. The default value is 1.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001553 * <p>
1554 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001555 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1556 * not, a security exception will be thrown.
1557 * <p>
1558 * This method can be called on the {@link DevicePolicyManager} instance returned by
1559 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1560 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001561 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001562 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1563 * @param length The new desired minimum number of letters required in the password. A value of
1564 * 0 means there is no restriction.
1565 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1566 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001567 */
Robin Lee25e26452015-06-02 09:56:29 -07001568 public void setPasswordMinimumLetters(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001569 if (mService != null) {
1570 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001571 mService.setPasswordMinimumLetters(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001572 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001573 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001574 }
1575 }
1576 }
1577
1578 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001579 * Retrieve the current number of letters required in the password
1580 * for a particular admin or all admins that set retrictions on this user
1581 * and its participating profiles. Restrictions on profiles that have
1582 * a separate challenge are not taken into account.
1583 * This is the same value as set by
1584 * {@link #setPasswordMinimumLetters(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001585 * and only applies when the password quality is
1586 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001587 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001588 * <p>This method can be called on the {@link DevicePolicyManager} instance
1589 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1590 * restrictions on the parent profile.
1591 *
Robin Lee25e26452015-06-02 09:56:29 -07001592 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001593 * aggregate all admins.
1594 * @return The minimum number of letters required in the password.
1595 */
Robin Lee25e26452015-06-02 09:56:29 -07001596 public int getPasswordMinimumLetters(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001597 return getPasswordMinimumLetters(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001598 }
1599
1600 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001601 public int getPasswordMinimumLetters(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001602 if (mService != null) {
1603 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001604 return mService.getPasswordMinimumLetters(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001605 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001606 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001607 }
1608 }
1609 return 0;
1610 }
1611
1612 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001613 * Called by an application that is administering the device to set the minimum number of
1614 * numerical digits required in the password. After setting this, the user will not be able to
1615 * enter a new password that is not at least as restrictive as what has been set. Note that the
1616 * current password will remain until the user has set a new one, so the change does not take
1617 * place immediately. To prompt the user for a new password, use
1618 * {@link #ACTION_SET_NEW_PASSWORD} or {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after
1619 * setting this value. This constraint is only imposed if the administrator has also requested
1620 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The default value is 1.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001621 * <p>
1622 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001623 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1624 * not, a security exception will be thrown.
1625 * <p>
1626 * This method can be called on the {@link DevicePolicyManager} instance returned by
1627 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1628 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001629 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001630 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1631 * @param length The new desired minimum number of numerical digits required in the password. A
1632 * value of 0 means there is no restriction.
1633 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1634 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001635 */
Robin Lee25e26452015-06-02 09:56:29 -07001636 public void setPasswordMinimumNumeric(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001637 if (mService != null) {
1638 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001639 mService.setPasswordMinimumNumeric(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001640 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001641 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001642 }
1643 }
1644 }
1645
1646 /**
1647 * Retrieve the current number of numerical digits required in the password
Esteban Talaverac1c83592016-02-17 17:56:15 +00001648 * for a particular admin or all admins that set retrictions on this user
1649 * and its participating profiles. Restrictions on profiles that have
1650 * a separate challenge are not taken into account.
Jessica Hummel91da58d2014-04-10 17:39:43 +01001651 * This is the same value as set by
Esteban Talaverac1c83592016-02-17 17:56:15 +00001652 * {@link #setPasswordMinimumNumeric(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001653 * and only applies when the password quality is
1654 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001655 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001656 * <p>This method can be called on the {@link DevicePolicyManager} instance
1657 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1658 * restrictions on the parent profile.
1659 *
Robin Lee25e26452015-06-02 09:56:29 -07001660 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001661 * aggregate all admins.
1662 * @return The minimum number of numerical digits required in the password.
1663 */
Robin Lee25e26452015-06-02 09:56:29 -07001664 public int getPasswordMinimumNumeric(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001665 return getPasswordMinimumNumeric(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001666 }
1667
1668 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001669 public int getPasswordMinimumNumeric(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001670 if (mService != null) {
1671 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001672 return mService.getPasswordMinimumNumeric(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001673 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001674 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001675 }
1676 }
1677 return 0;
1678 }
1679
1680 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001681 * Called by an application that is administering the device to set the minimum number of
1682 * symbols required in the password. After setting this, the user will not be able to enter a
1683 * new password that is not at least as restrictive as what has been set. Note that the current
1684 * password will remain until the user has set a new one, so the change does not take place
1685 * immediately. To prompt the user for a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
1686 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This constraint is
1687 * only imposed if the administrator has also requested {@link #PASSWORD_QUALITY_COMPLEX} with
1688 * {@link #setPasswordQuality}. The default value is 1.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001689 * <p>
1690 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001691 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1692 * not, a security exception will be thrown.
1693 * <p>
1694 * This method can be called on the {@link DevicePolicyManager} instance returned by
1695 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1696 * profile.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001697 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001698 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1699 * @param length The new desired minimum number of symbols required in the password. A value of
1700 * 0 means there is no restriction.
1701 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1702 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001703 */
Robin Lee25e26452015-06-02 09:56:29 -07001704 public void setPasswordMinimumSymbols(@NonNull ComponentName admin, int length) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001705 if (mService != null) {
1706 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001707 mService.setPasswordMinimumSymbols(admin, length, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001708 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001709 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001710 }
1711 }
1712 }
1713
1714 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001715 * Retrieve the current number of symbols required in the password
1716 * for a particular admin or all admins that set retrictions on this user
1717 * and its participating profiles. Restrictions on profiles that have
1718 * a separate challenge are not taken into account. This is the same value as
1719 * set by {@link #setPasswordMinimumSymbols(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001720 * and only applies when the password quality is
1721 * {@link #PASSWORD_QUALITY_COMPLEX}.
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001722 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001723 * <p>This method can be called on the {@link DevicePolicyManager} instance
1724 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1725 * restrictions on the parent profile.
1726 *
Robin Lee25e26452015-06-02 09:56:29 -07001727 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001728 * aggregate all admins.
1729 * @return The minimum number of symbols required in the password.
1730 */
Robin Lee25e26452015-06-02 09:56:29 -07001731 public int getPasswordMinimumSymbols(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001732 return getPasswordMinimumSymbols(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001733 }
1734
1735 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001736 public int getPasswordMinimumSymbols(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001737 if (mService != null) {
1738 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001739 return mService.getPasswordMinimumSymbols(admin, userHandle, mParentInstance);
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001740 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001741 throw e.rethrowFromSystemServer();
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07001742 }
1743 }
1744 return 0;
1745 }
1746
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001747 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001748 * Called by an application that is administering the device to set the minimum number of
1749 * non-letter characters (numerical digits or symbols) required in the password. After setting
1750 * this, the user will not be able to enter a new password that is not at least as restrictive
1751 * as what has been set. Note that the current password will remain until the user has set a new
1752 * one, so the change does not take place immediately. To prompt the user for a new password,
1753 * use {@link #ACTION_SET_NEW_PASSWORD} or {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after
1754 * setting this value. This constraint is only imposed if the administrator has also requested
1755 * {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The default value is 0.
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001756 * <p>
1757 * The calling device admin must have requested
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001758 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1759 * not, a security exception will be thrown.
1760 * <p>
1761 * This method can be called on the {@link DevicePolicyManager} instance returned by
1762 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1763 * profile.
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001764 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001765 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1766 * @param length The new desired minimum number of letters required in the password. A value of
1767 * 0 means there is no restriction.
1768 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1769 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001770 */
Robin Lee25e26452015-06-02 09:56:29 -07001771 public void setPasswordMinimumNonLetter(@NonNull ComponentName admin, int length) {
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001772 if (mService != null) {
1773 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001774 mService.setPasswordMinimumNonLetter(admin, length, mParentInstance);
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001775 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001776 throw e.rethrowFromSystemServer();
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001777 }
1778 }
1779 }
1780
1781 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001782 * Retrieve the current number of non-letter characters required in the password
1783 * for a particular admin or all admins that set retrictions on this user
1784 * and its participating profiles. Restrictions on profiles that have
1785 * a separate challenge are not taken into account.
Jessica Hummel91da58d2014-04-10 17:39:43 +01001786 * This is the same value as set by
Esteban Talaverac1c83592016-02-17 17:56:15 +00001787 * {@link #setPasswordMinimumNonLetter(ComponentName, int)}
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001788 * and only applies when the password quality is
1789 * {@link #PASSWORD_QUALITY_COMPLEX}.
1790 *
Esteban Talaverac1c83592016-02-17 17:56:15 +00001791 * <p>This method can be called on the {@link DevicePolicyManager} instance
1792 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1793 * restrictions on the parent profile.
1794 *
Robin Lee25e26452015-06-02 09:56:29 -07001795 * @param admin The name of the admin component to check, or {@code null} to
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001796 * aggregate all admins.
1797 * @return The minimum number of letters required in the password.
1798 */
Robin Lee25e26452015-06-02 09:56:29 -07001799 public int getPasswordMinimumNonLetter(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001800 return getPasswordMinimumNonLetter(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001801 }
1802
1803 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001804 public int getPasswordMinimumNonLetter(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001805 if (mService != null) {
1806 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001807 return mService.getPasswordMinimumNonLetter(admin, userHandle, mParentInstance);
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001808 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001809 throw e.rethrowFromSystemServer();
Konstantin Lopyrevc8577402010-06-04 17:15:02 -07001810 }
1811 }
1812 return 0;
1813 }
1814
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001815 /**
1816 * Called by an application that is administering the device to set the length of the password
1817 * history. After setting this, the user will not be able to enter a new password that is the
1818 * same as any password in the history. Note that the current password will remain until the
1819 * user has set a new one, so the change does not take place immediately. To prompt the user for
1820 * a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
1821 * {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This constraint is
1822 * only imposed if the administrator has also requested either {@link #PASSWORD_QUALITY_NUMERIC}
1823 * , {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX} {@link #PASSWORD_QUALITY_ALPHABETIC}, or
1824 * {@link #PASSWORD_QUALITY_ALPHANUMERIC} with {@link #setPasswordQuality}.
1825 * <p>
1826 * The calling device admin must have requested
1827 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1828 * not, a security exception will be thrown.
1829 * <p>
1830 * This method can be called on the {@link DevicePolicyManager} instance returned by
1831 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1832 * profile.
1833 *
1834 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
1835 * @param length The new desired length of password history. A value of 0 means there is no
1836 * restriction.
1837 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1838 * does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
1839 */
Robin Lee25e26452015-06-02 09:56:29 -07001840 public void setPasswordHistoryLength(@NonNull ComponentName admin, int length) {
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001841 if (mService != null) {
1842 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001843 mService.setPasswordHistoryLength(admin, length, mParentInstance);
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001844 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001845 throw e.rethrowFromSystemServer();
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001846 }
1847 }
1848 }
1849
1850 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001851 * Called by a device admin to set the password expiration timeout. Calling this method will
1852 * restart the countdown for password expiration for the given admin, as will changing the
1853 * device password (for all admins).
1854 * <p>
1855 * The provided timeout is the time delta in ms and will be added to the current time. For
1856 * example, to have the password expire 5 days from now, timeout would be 5 * 86400 * 1000 =
1857 * 432000000 ms for timeout.
1858 * <p>
1859 * To disable password expiration, a value of 0 may be used for timeout.
1860 * <p>
1861 * The calling device admin must have requested
1862 * {@link DeviceAdminInfo#USES_POLICY_EXPIRE_PASSWORD} to be able to call this method; if it has
1863 * not, a security exception will be thrown.
1864 * <p>
1865 * Note that setting the password will automatically reset the expiration time for all active
1866 * admins. Active admins do not need to explicitly call this method in that case.
1867 * <p>
1868 * This method can be called on the {@link DevicePolicyManager} instance returned by
1869 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
1870 * profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00001871 *
Jim Millera4e28d12010-11-08 16:15:47 -08001872 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001873 * @param timeout The limit (in ms) that a password can remain in effect. A value of 0 means
1874 * there is no restriction (unlimited).
1875 * @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
1876 * does not use {@link DeviceAdminInfo#USES_POLICY_EXPIRE_PASSWORD}
Jim Millera4e28d12010-11-08 16:15:47 -08001877 */
Robin Lee25e26452015-06-02 09:56:29 -07001878 public void setPasswordExpirationTimeout(@NonNull ComponentName admin, long timeout) {
Jim Millera4e28d12010-11-08 16:15:47 -08001879 if (mService != null) {
1880 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001881 mService.setPasswordExpirationTimeout(admin, timeout, mParentInstance);
Jim Millera4e28d12010-11-08 16:15:47 -08001882 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001883 throw e.rethrowFromSystemServer();
Jim Millera4e28d12010-11-08 16:15:47 -08001884 }
1885 }
1886 }
1887
1888 /**
Jim Miller6b857682011-02-16 16:27:41 -08001889 * Get the password expiration timeout for the given admin. The expiration timeout is the
1890 * recurring expiration timeout provided in the call to
1891 * {@link #setPasswordExpirationTimeout(ComponentName, long)} for the given admin or the
Esteban Talaverac1c83592016-02-17 17:56:15 +00001892 * aggregate of all participating policy administrators if {@code admin} is null. Admins that
1893 * have set restrictions on profiles that have a separate challenge are not taken into account.
1894 *
1895 * <p>This method can be called on the {@link DevicePolicyManager} instance
1896 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1897 * restrictions on the parent profile.
Jim Millera4e28d12010-11-08 16:15:47 -08001898 *
Robin Lee25e26452015-06-02 09:56:29 -07001899 * @param admin The name of the admin component to check, or {@code null} to aggregate all admins.
Jim Millera4e28d12010-11-08 16:15:47 -08001900 * @return The timeout for the given admin or the minimum of all timeouts
1901 */
Robin Lee25e26452015-06-02 09:56:29 -07001902 public long getPasswordExpirationTimeout(@Nullable ComponentName admin) {
Jim Millera4e28d12010-11-08 16:15:47 -08001903 if (mService != null) {
1904 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001905 return mService.getPasswordExpirationTimeout(admin, myUserId(), mParentInstance);
Jim Millera4e28d12010-11-08 16:15:47 -08001906 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001907 throw e.rethrowFromSystemServer();
Jim Millera4e28d12010-11-08 16:15:47 -08001908 }
1909 }
1910 return 0;
1911 }
1912
1913 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001914 * Get the current password expiration time for a particular admin or all admins that set
1915 * retrictions on this user and its participating profiles. Restrictions on profiles that have
1916 * a separate challenge are not taken into account. If admin is {@code null}, then a composite
1917 * of all expiration times is returned - which will be the minimum of all of them.
1918 *
1919 * <p>This method can be called on the {@link DevicePolicyManager} instance
1920 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1921 * the password expiration for the parent profile.
Jim Millera4e28d12010-11-08 16:15:47 -08001922 *
Robin Lee25e26452015-06-02 09:56:29 -07001923 * @param admin The name of the admin component to check, or {@code null} to aggregate all admins.
Esteban Talaverac1c83592016-02-17 17:56:15 +00001924 * @return The password expiration time, in milliseconds since epoch.
Jim Millera4e28d12010-11-08 16:15:47 -08001925 */
Robin Lee25e26452015-06-02 09:56:29 -07001926 public long getPasswordExpiration(@Nullable ComponentName admin) {
Jim Millera4e28d12010-11-08 16:15:47 -08001927 if (mService != null) {
1928 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001929 return mService.getPasswordExpiration(admin, myUserId(), mParentInstance);
Jim Millera4e28d12010-11-08 16:15:47 -08001930 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001931 throw e.rethrowFromSystemServer();
Jim Millera4e28d12010-11-08 16:15:47 -08001932 }
1933 }
1934 return 0;
1935 }
1936
1937 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00001938 * Retrieve the current password history length for a particular admin or all admins that
1939 * set retrictions on this user and its participating profiles. Restrictions on profiles that
1940 * have a separate challenge are not taken into account.
1941 *
1942 * <p>This method can be called on the {@link DevicePolicyManager} instance
1943 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
1944 * restrictions on the parent profile.
1945 *
Robin Lee25e26452015-06-02 09:56:29 -07001946 * @param admin The name of the admin component to check, or {@code null} to aggregate
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001947 * all admins.
1948 * @return The length of the password history
1949 */
Robin Lee25e26452015-06-02 09:56:29 -07001950 public int getPasswordHistoryLength(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07001951 return getPasswordHistoryLength(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07001952 }
1953
1954 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07001955 public int getPasswordHistoryLength(@Nullable ComponentName admin, int userHandle) {
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001956 if (mService != null) {
1957 try {
Esteban Talavera62399912016-01-11 15:37:55 +00001958 return mService.getPasswordHistoryLength(admin, userHandle, mParentInstance);
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001959 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07001960 throw e.rethrowFromSystemServer();
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001961 }
1962 }
1963 return 0;
1964 }
1965
Dianne Hackbornd6847842010-01-12 18:14:19 -08001966 /**
Dianne Hackborn254cb442010-01-27 19:23:59 -08001967 * Return the maximum password length that the device supports for a
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001968 * particular password quality.
Dianne Hackborn364f6e32010-01-29 17:38:20 -08001969 * @param quality The quality being interrogated.
Dianne Hackborn254cb442010-01-27 19:23:59 -08001970 * @return Returns the maximum length that the user can enter.
1971 */
Dianne Hackborn9327f4f2010-01-29 10:38:29 -08001972 public int getPasswordMaximumLength(int quality) {
Dianne Hackborn254cb442010-01-27 19:23:59 -08001973 // Kind-of arbitrary.
1974 return 16;
1975 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07001976
Dianne Hackborn254cb442010-01-27 19:23:59 -08001977 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001978 * Determine whether the current password the user has set is sufficient to meet the policy
1979 * requirements (e.g. quality, minimum length) that have been requested by the admins of this
1980 * user and its participating profiles. Restrictions on profiles that have a separate challenge
1981 * are not taken into account.
1982 * <p>
1983 * The calling device admin must have requested
1984 * {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
1985 * not, a security exception will be thrown.
1986 * <p>
1987 * This method can be called on the {@link DevicePolicyManager} instance returned by
1988 * {@link #getParentProfileInstance(ComponentName)} in order to determine if the password set on
1989 * the parent profile is sufficient.
Esteban Talaverac1c83592016-02-17 17:56:15 +00001990 *
Jessica Hummel91da58d2014-04-10 17:39:43 +01001991 * @return Returns true if the password meets the current requirements, else false.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07001992 * @throws SecurityException if the calling application does not own an active administrator
1993 * that uses {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
Dianne Hackbornd6847842010-01-12 18:14:19 -08001994 */
Dianne Hackborndf83afa2010-01-20 13:37:26 -08001995 public boolean isActivePasswordSufficient() {
Dianne Hackbornd6847842010-01-12 18:14:19 -08001996 if (mService != null) {
1997 try {
Clara Bayarri3e826ef2015-12-14 17:51:22 +00001998 return mService.isActivePasswordSufficient(myUserId(), mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08001999 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002000 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08002001 }
2002 }
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002003 return false;
Dianne Hackbornd6847842010-01-12 18:14:19 -08002004 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002005
Dianne Hackbornd6847842010-01-12 18:14:19 -08002006 /**
Clara Bayarrid7693912016-01-22 17:26:31 +00002007 * Determine whether the current profile password the user has set is sufficient
Esteban Talaverac1c83592016-02-17 17:56:15 +00002008 * to meet the policy requirements (e.g. quality, minimum length) that have been
Clara Bayarrid7693912016-01-22 17:26:31 +00002009 * requested by the admins of the parent user and its profiles.
2010 *
2011 * @param userHandle the userId of the profile to check the password for.
2012 * @return Returns true if the password would meet the current requirements, else false.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002013 * @throws SecurityException if {@code userHandle} is not a managed profile.
Clara Bayarrid7693912016-01-22 17:26:31 +00002014 * @hide
2015 */
2016 public boolean isProfileActivePasswordSufficientForParent(int userHandle) {
2017 if (mService != null) {
2018 try {
2019 return mService.isProfileActivePasswordSufficientForParent(userHandle);
2020 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002021 throw e.rethrowFromSystemServer();
Clara Bayarrid7693912016-01-22 17:26:31 +00002022 }
2023 }
2024 return false;
2025 }
2026
2027 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002028 * Retrieve the number of times the user has failed at entering a password since that last
2029 * successful password entry.
2030 * <p>
2031 * This method can be called on the {@link DevicePolicyManager} instance returned by
2032 * {@link #getParentProfileInstance(ComponentName)} in order to retrieve the number of failed
2033 * password attemts for the parent user.
2034 * <p>
2035 * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN}
2036 * to be able to call this method; if it has not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002037 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002038 * @return The number of times user has entered an incorrect password since the last correct
2039 * password entry.
2040 * @throws SecurityException if the calling application does not own an active administrator
2041 * that uses {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN}
Dianne Hackbornd6847842010-01-12 18:14:19 -08002042 */
2043 public int getCurrentFailedPasswordAttempts() {
Clara Bayarri51e41ad2016-02-11 17:48:53 +00002044 return getCurrentFailedPasswordAttempts(myUserId());
2045 }
2046
2047 /**
2048 * Retrieve the number of times the given user has failed at entering a
2049 * password since that last successful password entry.
2050 *
2051 * <p>The calling device admin must have requested
2052 * {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} to be able to call this method; if it has
2053 * not and it is not the system uid, a security exception will be thrown.
2054 *
2055 * @hide
2056 */
2057 public int getCurrentFailedPasswordAttempts(int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08002058 if (mService != null) {
2059 try {
Clara Bayarri51e41ad2016-02-11 17:48:53 +00002060 return mService.getCurrentFailedPasswordAttempts(userHandle, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002061 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002062 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08002063 }
2064 }
2065 return -1;
2066 }
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002067
2068 /**
Craig Lafayette4e401fa2015-05-07 10:24:02 -04002069 * Queries whether {@link #RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT} flag is set.
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002070 *
Craig Lafayette4e401fa2015-05-07 10:24:02 -04002071 * @return true if RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT flag is set.
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002072 * @hide
2073 */
2074 public boolean getDoNotAskCredentialsOnBoot() {
2075 if (mService != null) {
2076 try {
2077 return mService.getDoNotAskCredentialsOnBoot();
2078 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002079 throw e.rethrowFromSystemServer();
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002080 }
2081 }
2082 return false;
2083 }
2084
2085 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002086 * Setting this to a value greater than zero enables a built-in policy that will perform a
2087 * device or profile wipe after too many incorrect device-unlock passwords have been entered.
2088 * This built-in policy combines watching for failed passwords and wiping the device, and
2089 * requires that you request both {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} and
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002090 * {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA}}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002091 * <p>
2092 * To implement any other policy (e.g. wiping data for a particular application only, erasing or
2093 * revoking credentials, or reporting the failure to a server), you should implement
2094 * {@link DeviceAdminReceiver#onPasswordFailed(Context, android.content.Intent)} instead. Do not
2095 * use this API, because if the maximum count is reached, the device or profile will be wiped
2096 * immediately, and your callback will not be invoked.
2097 * <p>
2098 * This method can be called on the {@link DevicePolicyManager} instance returned by
2099 * {@link #getParentProfileInstance(ComponentName)} in order to set a value on the parent
2100 * profile.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002101 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08002102 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002103 * @param num The number of failed password attempts at which point the device or profile will
2104 * be wiped.
2105 * @throws SecurityException if {@code admin} is not an active administrator or does not use
2106 * both {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} and
2107 * {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA}.
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002108 */
Robin Lee25e26452015-06-02 09:56:29 -07002109 public void setMaximumFailedPasswordsForWipe(@NonNull ComponentName admin, int num) {
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002110 if (mService != null) {
2111 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002112 mService.setMaximumFailedPasswordsForWipe(admin, num, mParentInstance);
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002113 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002114 throw e.rethrowFromSystemServer();
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002115 }
2116 }
2117 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002118
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002119 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00002120 * Retrieve the current maximum number of login attempts that are allowed before the device
2121 * or profile is wiped, for a particular admin or all admins that set retrictions on this user
2122 * and its participating profiles. Restrictions on profiles that have a separate challenge are
2123 * not taken into account.
2124 *
2125 * <p>This method can be called on the {@link DevicePolicyManager} instance
2126 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
2127 * the value for the parent profile.
2128 *
Robin Lee25e26452015-06-02 09:56:29 -07002129 * @param admin The name of the admin component to check, or {@code null} to aggregate
Dianne Hackborn254cb442010-01-27 19:23:59 -08002130 * all admins.
2131 */
Robin Lee25e26452015-06-02 09:56:29 -07002132 public int getMaximumFailedPasswordsForWipe(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002133 return getMaximumFailedPasswordsForWipe(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002134 }
2135
2136 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07002137 public int getMaximumFailedPasswordsForWipe(@Nullable ComponentName admin, int userHandle) {
Dianne Hackborn254cb442010-01-27 19:23:59 -08002138 if (mService != null) {
2139 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002140 return mService.getMaximumFailedPasswordsForWipe(
2141 admin, userHandle, mParentInstance);
Dianne Hackborn254cb442010-01-27 19:23:59 -08002142 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002143 throw e.rethrowFromSystemServer();
Dianne Hackborn254cb442010-01-27 19:23:59 -08002144 }
2145 }
2146 return 0;
2147 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002148
Dianne Hackborn254cb442010-01-27 19:23:59 -08002149 /**
Amith Yamasani3a3d2122014-10-29 11:41:31 -07002150 * Returns the profile with the smallest maximum failed passwords for wipe,
2151 * for the given user. So for primary user, it might return the primary or
2152 * a managed profile. For a secondary user, it would be the same as the
2153 * user passed in.
2154 * @hide Used only by Keyguard
2155 */
2156 public int getProfileWithMinimumFailedPasswordsForWipe(int userHandle) {
2157 if (mService != null) {
2158 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002159 return mService.getProfileWithMinimumFailedPasswordsForWipe(
2160 userHandle, mParentInstance);
Amith Yamasani3a3d2122014-10-29 11:41:31 -07002161 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002162 throw e.rethrowFromSystemServer();
Amith Yamasani3a3d2122014-10-29 11:41:31 -07002163 }
2164 }
2165 return UserHandle.USER_NULL;
2166 }
2167
2168 /**
Dianne Hackborn87bba1e2010-02-26 17:25:54 -08002169 * Flag for {@link #resetPassword}: don't allow other admins to change
2170 * the password again until the user has entered it.
2171 */
2172 public static final int RESET_PASSWORD_REQUIRE_ENTRY = 0x0001;
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002173
Dianne Hackborn87bba1e2010-02-26 17:25:54 -08002174 /**
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002175 * Flag for {@link #resetPassword}: don't ask for user credentials on device boot.
2176 * If the flag is set, the device can be booted without asking for user password.
2177 * The absence of this flag does not change the current boot requirements. This flag
2178 * can be set by the device owner only. If the app is not the device owner, the flag
2179 * is ignored. Once the flag is set, it cannot be reverted back without resetting the
2180 * device to factory defaults.
2181 */
Craig Lafayette4e401fa2015-05-07 10:24:02 -04002182 public static final int RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT = 0x0002;
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002183
2184 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002185 * Force a new device unlock password (the password needed to access the entire device, not for
2186 * individual accounts) on the user. This takes effect immediately.
2187 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002188 * <em>Note: This API has been limited as of {@link android.os.Build.VERSION_CODES#N} for
Makoto Onuki70f929e2015-11-11 12:40:15 -08002189 * device admins that are not device owner and not profile owner.
2190 * The password can now only be changed if there is currently no password set. Device owner
2191 * and profile owner can still do this.</em>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002192 * <p>
2193 * The given password must be sufficient for the current password quality and length constraints
2194 * as returned by {@link #getPasswordQuality(ComponentName)} and
2195 * {@link #getPasswordMinimumLength(ComponentName)}; if it does not meet these constraints, then
2196 * it will be rejected and false returned. Note that the password may be a stronger quality
2197 * (containing alphanumeric characters when the requested quality is only numeric), in which
2198 * case the currently active quality will be increased to match.
2199 * <p>
2200 * Calling with a null or empty password will clear any existing PIN, pattern or password if the
Robin Leece5c4002016-03-23 17:05:03 +00002201 * current password constraints allow it. <em>Note: This will not work in
2202 * {@link android.os.Build.VERSION_CODES#N} and later for managed profiles, or for device admins
2203 * that are not device owner or profile owner. Once set, the password cannot be changed to null
2204 * or empty except by these admins.</em>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002205 * <p>
2206 * The calling device admin must have requested
2207 * {@link DeviceAdminInfo#USES_POLICY_RESET_PASSWORD} to be able to call this method; if it has
2208 * not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002209 *
Adrian Roosf8f56bc2014-11-20 23:55:34 +01002210 * @param password The new password for the user. Null or empty clears the password.
Andrei Kapishnikov4eb6a362015-04-02 15:21:20 -04002211 * @param flags May be 0 or combination of {@link #RESET_PASSWORD_REQUIRE_ENTRY} and
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002212 * {@link #RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT}.
2213 * @return Returns true if the password was applied, or false if it is not acceptable for the
2214 * current constraints or if the user has not been decrypted yet.
2215 * @throws SecurityException if the calling application does not own an active administrator
2216 * that uses {@link DeviceAdminInfo#USES_POLICY_RESET_PASSWORD}
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002217 */
Dianne Hackborn87bba1e2010-02-26 17:25:54 -08002218 public boolean resetPassword(String password, int flags) {
Clara Bayarri3e826ef2015-12-14 17:51:22 +00002219 if (mParentInstance) {
2220 throw new SecurityException("Reset password does not work across profiles.");
2221 }
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002222 if (mService != null) {
2223 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08002224 return mService.resetPassword(password, flags);
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002225 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002226 throw e.rethrowFromSystemServer();
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002227 }
2228 }
2229 return false;
2230 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002231
Dianne Hackbornd6847842010-01-12 18:14:19 -08002232 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002233 * Called by an application that is administering the device to set the maximum time for user
2234 * activity until the device will lock. This limits the length that the user can set. It takes
2235 * effect immediately.
2236 * <p>
2237 * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
2238 * to be able to call this method; if it has not, a security exception will be thrown.
2239 * <p>
2240 * This method can be called on the {@link DevicePolicyManager} instance returned by
2241 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
2242 * profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00002243 *
Dianne Hackbornef6b22f2010-02-16 20:38:49 -08002244 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002245 * @param timeMs The new desired maximum time to lock in milliseconds. A value of 0 means there
2246 * is no restriction.
2247 * @throws SecurityException if {@code admin} is not an active administrator or it does not use
2248 * {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
Dianne Hackbornd6847842010-01-12 18:14:19 -08002249 */
Robin Lee25e26452015-06-02 09:56:29 -07002250 public void setMaximumTimeToLock(@NonNull ComponentName admin, long timeMs) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08002251 if (mService != null) {
2252 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002253 mService.setMaximumTimeToLock(admin, timeMs, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002254 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002255 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08002256 }
2257 }
2258 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002259
Dianne Hackbornd6847842010-01-12 18:14:19 -08002260 /**
Esteban Talaverac1c83592016-02-17 17:56:15 +00002261 * Retrieve the current maximum time to unlock for a particular admin or all admins that set
2262 * retrictions on this user and its participating profiles. Restrictions on profiles that have
2263 * a separate challenge are not taken into account.
2264 *
2265 * <p>This method can be called on the {@link DevicePolicyManager} instance
2266 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
2267 * restrictions on the parent profile.
2268 *
Robin Lee25e26452015-06-02 09:56:29 -07002269 * @param admin The name of the admin component to check, or {@code null} to aggregate
Dianne Hackborn254cb442010-01-27 19:23:59 -08002270 * all admins.
Jim Millerd4efaac2014-08-14 18:02:45 -07002271 * @return time in milliseconds for the given admin or the minimum value (strictest) of
Jim Miller76b9b8b2014-08-22 17:04:57 -07002272 * all admins if admin is null. Returns 0 if there are no restrictions.
Dianne Hackbornd6847842010-01-12 18:14:19 -08002273 */
Robin Lee25e26452015-06-02 09:56:29 -07002274 public long getMaximumTimeToLock(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002275 return getMaximumTimeToLock(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002276 }
2277
2278 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07002279 public long getMaximumTimeToLock(@Nullable ComponentName admin, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08002280 if (mService != null) {
2281 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002282 return mService.getMaximumTimeToLock(admin, userHandle, mParentInstance);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002283 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002284 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08002285 }
2286 }
2287 return 0;
2288 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002289
Dianne Hackbornd6847842010-01-12 18:14:19 -08002290 /**
Ricky Wai035e9242016-03-18 16:43:31 +00002291 * Returns maximum time to lock that applied by all profiles in this user. We do this because we
2292 * do not have a separate timeout to lock for work challenge only.
2293 *
2294 * @hide
2295 */
2296 public long getMaximumTimeToLockForUserAndProfiles(int userHandle) {
2297 if (mService != null) {
2298 try {
2299 return mService.getMaximumTimeToLockForUserAndProfiles(userHandle);
2300 } catch (RemoteException e) {
2301 throw e.rethrowFromSystemServer();
2302 }
2303 }
2304 return 0;
2305 }
2306
2307 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002308 * Make the device lock immediately, as if the lock screen timeout has expired at the point of
2309 * this call.
2310 * <p>
2311 * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
2312 * to be able to call this method; if it has not, a security exception will be thrown.
2313 * <p>
2314 * This method can be called on the {@link DevicePolicyManager} instance returned by
2315 * {@link #getParentProfileInstance(ComponentName)} in order to lock the parent profile.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002316 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002317 * @throws SecurityException if the calling application does not own an active administrator
2318 * that uses {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
Dianne Hackbornd6847842010-01-12 18:14:19 -08002319 */
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002320 public void lockNow() {
2321 if (mService != null) {
2322 try {
Esteban Talavera62399912016-01-11 15:37:55 +00002323 mService.lockNow(mParentInstance);
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002324 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002325 throw e.rethrowFromSystemServer();
Dianne Hackborndf83afa2010-01-20 13:37:26 -08002326 }
2327 }
2328 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002329
Dianne Hackbornd6847842010-01-12 18:14:19 -08002330 /**
Dianne Hackborn42499172010-10-15 18:45:07 -07002331 * Flag for {@link #wipeData(int)}: also erase the device's external
Paul Crowleya7e87ac2014-11-18 13:50:19 +00002332 * storage (such as SD cards).
Dianne Hackborn42499172010-10-15 18:45:07 -07002333 */
2334 public static final int WIPE_EXTERNAL_STORAGE = 0x0001;
2335
2336 /**
Paul Crowleya7e87ac2014-11-18 13:50:19 +00002337 * Flag for {@link #wipeData(int)}: also erase the factory reset protection
2338 * data.
2339 *
Paul Crowley2934b262014-12-02 11:21:13 +00002340 * <p>This flag may only be set by device owner admins; if it is set by
2341 * other admins a {@link SecurityException} will be thrown.
Paul Crowleya7e87ac2014-11-18 13:50:19 +00002342 */
2343 public static final int WIPE_RESET_PROTECTION_DATA = 0x0002;
2344
2345 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002346 * Ask the user data be wiped. Wiping the primary user will cause the device to reboot, erasing
2347 * all user data while next booting up.
2348 * <p>
2349 * The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA} to
2350 * be able to call this method; if it has not, a security exception will be thrown.
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002351 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002352 * @param flags Bit mask of additional options: currently supported flags are
2353 * {@link #WIPE_EXTERNAL_STORAGE} and {@link #WIPE_RESET_PROTECTION_DATA}.
2354 * @throws SecurityException if the calling application does not own an active administrator
2355 * that uses {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA}
Dianne Hackbornd6847842010-01-12 18:14:19 -08002356 */
2357 public void wipeData(int flags) {
2358 if (mService != null) {
2359 try {
Makoto Onuki70f929e2015-11-11 12:40:15 -08002360 mService.wipeData(flags);
Dianne Hackbornd6847842010-01-12 18:14:19 -08002361 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002362 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08002363 }
2364 }
2365 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07002366
Dianne Hackbornd6847842010-01-12 18:14:19 -08002367 /**
Oscar Montemayor69238c62010-08-03 10:51:06 -07002368 * Called by an application that is administering the device to set the
2369 * global proxy and exclusion list.
2370 * <p>
2371 * The calling device admin must have requested
2372 * {@link DeviceAdminInfo#USES_POLICY_SETS_GLOBAL_PROXY} to be able to call
2373 * this method; if it has not, a security exception will be thrown.
2374 * Only the first device admin can set the proxy. If a second admin attempts
2375 * to set the proxy, the {@link ComponentName} of the admin originally setting the
Robin Lee25e26452015-06-02 09:56:29 -07002376 * proxy will be returned. If successful in setting the proxy, {@code null} will
Oscar Montemayor69238c62010-08-03 10:51:06 -07002377 * be returned.
2378 * The method can be called repeatedly by the device admin alrady setting the
2379 * proxy to update the proxy and exclusion list.
2380 *
Robin Lee25e26452015-06-02 09:56:29 -07002381 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Oscar Montemayor69238c62010-08-03 10:51:06 -07002382 * @param proxySpec the global proxy desired. Must be an HTTP Proxy.
2383 * Pass Proxy.NO_PROXY to reset the proxy.
2384 * @param exclusionList a list of domains to be excluded from the global proxy.
Robin Lee25e26452015-06-02 09:56:29 -07002385 * @return {@code null} if the proxy was successfully set, or otherwise a {@link ComponentName}
2386 * of the device admin that sets the proxy.
Andy Stadlerd2672722011-02-16 10:53:33 -08002387 * @hide
Oscar Montemayor69238c62010-08-03 10:51:06 -07002388 */
Robin Lee25e26452015-06-02 09:56:29 -07002389 public ComponentName setGlobalProxy(@NonNull ComponentName admin, Proxy proxySpec,
Oscar Montemayor69238c62010-08-03 10:51:06 -07002390 List<String> exclusionList ) {
2391 if (proxySpec == null) {
2392 throw new NullPointerException();
2393 }
2394 if (mService != null) {
2395 try {
2396 String hostSpec;
2397 String exclSpec;
2398 if (proxySpec.equals(Proxy.NO_PROXY)) {
2399 hostSpec = null;
2400 exclSpec = null;
2401 } else {
2402 if (!proxySpec.type().equals(Proxy.Type.HTTP)) {
2403 throw new IllegalArgumentException();
2404 }
2405 InetSocketAddress sa = (InetSocketAddress)proxySpec.address();
2406 String hostName = sa.getHostName();
2407 int port = sa.getPort();
2408 StringBuilder hostBuilder = new StringBuilder();
2409 hostSpec = hostBuilder.append(hostName)
2410 .append(":").append(Integer.toString(port)).toString();
2411 if (exclusionList == null) {
2412 exclSpec = "";
2413 } else {
2414 StringBuilder listBuilder = new StringBuilder();
2415 boolean firstDomain = true;
2416 for (String exclDomain : exclusionList) {
2417 if (!firstDomain) {
2418 listBuilder = listBuilder.append(",");
2419 } else {
2420 firstDomain = false;
2421 }
2422 listBuilder = listBuilder.append(exclDomain.trim());
2423 }
2424 exclSpec = listBuilder.toString();
2425 }
Yuhao Zheng90704842014-02-28 17:22:45 -08002426 if (android.net.Proxy.validate(hostName, Integer.toString(port), exclSpec)
2427 != android.net.Proxy.PROXY_VALID)
2428 throw new IllegalArgumentException();
Oscar Montemayor69238c62010-08-03 10:51:06 -07002429 }
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08002430 return mService.setGlobalProxy(admin, hostSpec, exclSpec);
Oscar Montemayor69238c62010-08-03 10:51:06 -07002431 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002432 throw e.rethrowFromSystemServer();
Oscar Montemayor69238c62010-08-03 10:51:06 -07002433 }
2434 }
2435 return null;
2436 }
2437
2438 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002439 * Set a network-independent global HTTP proxy. This is not normally what you want for typical
2440 * HTTP proxies - they are generally network dependent. However if you're doing something
2441 * unusual like general internal filtering this may be useful. On a private network where the
2442 * proxy is not accessible, you may break HTTP using this.
2443 * <p>
2444 * This method requires the caller to be the device owner.
2445 * <p>
2446 * This proxy is only a recommendation and it is possible that some apps will ignore it.
Jason Monk03bc9912014-05-13 09:44:57 -04002447 *
Jason Monk03bc9912014-05-13 09:44:57 -04002448 * @see ProxyInfo
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002449 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2450 * @param proxyInfo The a {@link ProxyInfo} object defining the new global HTTP proxy. A
2451 * {@code null} value will clear the global HTTP proxy.
2452 * @throws SecurityException if {@code admin} is not the device owner.
Jason Monk03bc9912014-05-13 09:44:57 -04002453 */
Robin Lee25e26452015-06-02 09:56:29 -07002454 public void setRecommendedGlobalProxy(@NonNull ComponentName admin, @Nullable ProxyInfo
2455 proxyInfo) {
Jason Monk03bc9912014-05-13 09:44:57 -04002456 if (mService != null) {
2457 try {
2458 mService.setRecommendedGlobalProxy(admin, proxyInfo);
2459 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002460 throw e.rethrowFromSystemServer();
Jason Monk03bc9912014-05-13 09:44:57 -04002461 }
2462 }
2463 }
2464
2465 /**
Oscar Montemayor69238c62010-08-03 10:51:06 -07002466 * Returns the component name setting the global proxy.
Robin Lee25e26452015-06-02 09:56:29 -07002467 * @return ComponentName object of the device admin that set the global proxy, or {@code null}
2468 * if no admin has set the proxy.
Andy Stadlerd2672722011-02-16 10:53:33 -08002469 * @hide
Oscar Montemayor69238c62010-08-03 10:51:06 -07002470 */
2471 public ComponentName getGlobalProxyAdmin() {
2472 if (mService != null) {
2473 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002474 return mService.getGlobalProxyAdmin(myUserId());
Oscar Montemayor69238c62010-08-03 10:51:06 -07002475 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002476 throw e.rethrowFromSystemServer();
Oscar Montemayor69238c62010-08-03 10:51:06 -07002477 }
2478 }
2479 return null;
2480 }
2481
2482 /**
Andy Stadler22dbfda2011-01-17 12:47:31 -08002483 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002484 * indicating that encryption is not supported.
2485 */
2486 public static final int ENCRYPTION_STATUS_UNSUPPORTED = 0;
2487
2488 /**
Andy Stadler22dbfda2011-01-17 12:47:31 -08002489 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002490 * indicating that encryption is supported, but is not currently active.
2491 */
2492 public static final int ENCRYPTION_STATUS_INACTIVE = 1;
2493
2494 /**
Robin Lee3795fb02015-02-16 14:17:23 +00002495 * Result code for {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002496 * indicating that encryption is not currently active, but is currently
2497 * being activated. This is only reported by devices that support
2498 * encryption of data and only when the storage is currently
2499 * undergoing a process of becoming encrypted. A device that must reboot and/or wipe data
2500 * to become encrypted will never return this value.
2501 */
Andy Stadler22dbfda2011-01-17 12:47:31 -08002502 public static final int ENCRYPTION_STATUS_ACTIVATING = 2;
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002503
2504 /**
Andy Stadler22dbfda2011-01-17 12:47:31 -08002505 * Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002506 * indicating that encryption is active.
2507 */
Andy Stadler22dbfda2011-01-17 12:47:31 -08002508 public static final int ENCRYPTION_STATUS_ACTIVE = 3;
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002509
2510 /**
Robin Lee3795fb02015-02-16 14:17:23 +00002511 * Result code for {@link #getStorageEncryptionStatus}:
2512 * indicating that encryption is active, but an encryption key has not
2513 * been set by the user.
2514 */
2515 public static final int ENCRYPTION_STATUS_ACTIVE_DEFAULT_KEY = 4;
2516
2517 /**
Makoto Onukid4c9e542016-02-25 18:17:30 -08002518 * Result code for {@link #getStorageEncryptionStatus}:
2519 * indicating that encryption is active and the encryption key is tied to the user.
2520 */
2521 public static final int ENCRYPTION_STATUS_ACTIVE_PER_USER = 5;
2522
2523 /**
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002524 * Activity action: begin the process of encrypting data on the device. This activity should
2525 * be launched after using {@link #setStorageEncryption} to request encryption be activated.
2526 * After resuming from this activity, use {@link #getStorageEncryption}
2527 * to check encryption status. However, on some devices this activity may never return, as
2528 * it may trigger a reboot and in some cases a complete data wipe of the device.
2529 */
2530 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2531 public static final String ACTION_START_ENCRYPTION
2532 = "android.app.action.START_ENCRYPTION";
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002533 /**
Jim Millerb8ec4702012-08-31 17:19:10 -07002534 * Widgets are enabled in keyguard
2535 */
Jim Miller48b9b0d2012-09-19 23:16:50 -07002536 public static final int KEYGUARD_DISABLE_FEATURES_NONE = 0;
Jim Millerb8ec4702012-08-31 17:19:10 -07002537
2538 /**
Jim Miller50e62182014-04-23 17:25:00 -07002539 * Disable all keyguard widgets. Has no effect.
Jim Millerb8ec4702012-08-31 17:19:10 -07002540 */
Jim Miller48b9b0d2012-09-19 23:16:50 -07002541 public static final int KEYGUARD_DISABLE_WIDGETS_ALL = 1 << 0;
2542
2543 /**
2544 * Disable the camera on secure keyguard screens (e.g. PIN/Pattern/Password)
2545 */
2546 public static final int KEYGUARD_DISABLE_SECURE_CAMERA = 1 << 1;
2547
2548 /**
Jim Miller50e62182014-04-23 17:25:00 -07002549 * Disable showing all notifications on secure keyguard screens (e.g. PIN/Pattern/Password)
2550 */
2551 public static final int KEYGUARD_DISABLE_SECURE_NOTIFICATIONS = 1 << 2;
2552
2553 /**
2554 * Only allow redacted notifications on secure keyguard screens (e.g. PIN/Pattern/Password)
2555 */
2556 public static final int KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS = 1 << 3;
2557
2558 /**
Adrian Roosa06d5ca2014-07-28 15:14:21 +02002559 * Ignore trust agent state on secure keyguard screens
Jim Miller50e62182014-04-23 17:25:00 -07002560 * (e.g. PIN/Pattern/Password).
2561 */
2562 public static final int KEYGUARD_DISABLE_TRUST_AGENTS = 1 << 4;
2563
2564 /**
Jim Miller06e34502014-07-17 14:46:05 -07002565 * Disable fingerprint sensor on keyguard secure screens (e.g. PIN/Pattern/Password).
2566 */
2567 public static final int KEYGUARD_DISABLE_FINGERPRINT = 1 << 5;
2568
2569 /**
Jim Miller35207742012-11-02 15:33:20 -07002570 * Disable all current and future keyguard customizations.
Jim Miller48b9b0d2012-09-19 23:16:50 -07002571 */
2572 public static final int KEYGUARD_DISABLE_FEATURES_ALL = 0x7fffffff;
Jim Millerb8ec4702012-08-31 17:19:10 -07002573
2574 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002575 * Called by an application that is administering the device to request that the storage system
2576 * be encrypted.
2577 * <p>
2578 * When multiple device administrators attempt to control device encryption, the most secure,
2579 * supported setting will always be used. If any device administrator requests device
2580 * encryption, it will be enabled; Conversely, if a device administrator attempts to disable
2581 * device encryption while another device administrator has enabled it, the call to disable will
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002582 * fail (most commonly returning {@link #ENCRYPTION_STATUS_ACTIVE}).
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002583 * <p>
2584 * This policy controls encryption of the secure (application data) storage area. Data written
2585 * to other storage areas may or may not be encrypted, and this policy does not require or
2586 * control the encryption of any other storage areas. There is one exception: If
2587 * {@link android.os.Environment#isExternalStorageEmulated()} is {@code true}, then the
2588 * directory returned by {@link android.os.Environment#getExternalStorageDirectory()} must be
2589 * written to disk within the encrypted storage area.
2590 * <p>
2591 * Important Note: On some devices, it is possible to encrypt storage without requiring the user
2592 * to create a device PIN or Password. In this case, the storage is encrypted, but the
2593 * encryption key may not be fully secured. For maximum security, the administrator should also
2594 * require (and check for) a pattern, PIN, or password.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002595 *
2596 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
2597 * @param encrypt true to request encryption, false to release any previous request
Andy Stadler22dbfda2011-01-17 12:47:31 -08002598 * @return the new request status (for all active admins) - will be one of
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002599 * {@link #ENCRYPTION_STATUS_UNSUPPORTED}, {@link #ENCRYPTION_STATUS_INACTIVE}, or
2600 * {@link #ENCRYPTION_STATUS_ACTIVE}. This is the value of the requests; Use
2601 * {@link #getStorageEncryptionStatus()} to query the actual device state.
2602 * @throws SecurityException if {@code admin} is not an active administrator or does not use
2603 * {@link DeviceAdminInfo#USES_ENCRYPTED_STORAGE}
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002604 */
Robin Lee25e26452015-06-02 09:56:29 -07002605 public int setStorageEncryption(@NonNull ComponentName admin, boolean encrypt) {
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002606 if (mService != null) {
2607 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08002608 return mService.setStorageEncryption(admin, encrypt);
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002609 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002610 throw e.rethrowFromSystemServer();
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002611 }
2612 }
2613 return ENCRYPTION_STATUS_UNSUPPORTED;
2614 }
2615
2616 /**
2617 * Called by an application that is administering the device to
Andy Stadler22dbfda2011-01-17 12:47:31 -08002618 * determine the requested setting for secure storage.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002619 *
Andy Stadler22dbfda2011-01-17 12:47:31 -08002620 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. If null,
2621 * this will return the requested encryption setting as an aggregate of all active
2622 * administrators.
2623 * @return true if the admin(s) are requesting encryption, false if not.
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002624 */
Robin Lee25e26452015-06-02 09:56:29 -07002625 public boolean getStorageEncryption(@Nullable ComponentName admin) {
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002626 if (mService != null) {
2627 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002628 return mService.getStorageEncryption(admin, myUserId());
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002629 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002630 throw e.rethrowFromSystemServer();
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002631 }
2632 }
Andy Stadler22dbfda2011-01-17 12:47:31 -08002633 return false;
2634 }
2635
2636 /**
2637 * Called by an application that is administering the device to
2638 * determine the current encryption status of the device.
2639 *
2640 * Depending on the returned status code, the caller may proceed in different
2641 * ways. If the result is {@link #ENCRYPTION_STATUS_UNSUPPORTED}, the
2642 * storage system does not support encryption. If the
2643 * result is {@link #ENCRYPTION_STATUS_INACTIVE}, use {@link
2644 * #ACTION_START_ENCRYPTION} to begin the process of encrypting or decrypting the
Robin Lee3795fb02015-02-16 14:17:23 +00002645 * storage. If the result is {@link #ENCRYPTION_STATUS_ACTIVE_DEFAULT_KEY}, the
2646 * storage system has enabled encryption but no password is set so further action
2647 * may be required. If the result is {@link #ENCRYPTION_STATUS_ACTIVATING} or
Andy Stadler22dbfda2011-01-17 12:47:31 -08002648 * {@link #ENCRYPTION_STATUS_ACTIVE}, no further action is required.
2649 *
Robin Lee7e678712014-07-24 16:41:31 +01002650 * @return current status of encryption. The value will be one of
Andy Stadler22dbfda2011-01-17 12:47:31 -08002651 * {@link #ENCRYPTION_STATUS_UNSUPPORTED}, {@link #ENCRYPTION_STATUS_INACTIVE},
Robin Lee3795fb02015-02-16 14:17:23 +00002652 * {@link #ENCRYPTION_STATUS_ACTIVATING}, {@link #ENCRYPTION_STATUS_ACTIVE_DEFAULT_KEY},
2653 * or {@link #ENCRYPTION_STATUS_ACTIVE}.
Andy Stadler22dbfda2011-01-17 12:47:31 -08002654 */
2655 public int getStorageEncryptionStatus() {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07002656 return getStorageEncryptionStatus(myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07002657 }
2658
2659 /** @hide per-user version */
2660 public int getStorageEncryptionStatus(int userHandle) {
Andy Stadler22dbfda2011-01-17 12:47:31 -08002661 if (mService != null) {
2662 try {
Makoto Onukid4c9e542016-02-25 18:17:30 -08002663 return mService.getStorageEncryptionStatus(mContext.getPackageName(), userHandle);
Andy Stadler22dbfda2011-01-17 12:47:31 -08002664 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002665 throw e.rethrowFromSystemServer();
Andy Stadler22dbfda2011-01-17 12:47:31 -08002666 }
2667 }
Andy Stadler7b0f8f02011-01-12 14:59:52 -08002668 return ENCRYPTION_STATUS_UNSUPPORTED;
2669 }
2670
2671 /**
Robin Lee2f7e1e42016-03-21 10:50:01 +00002672 * Mark a CA certificate as approved by the device user. This means that they have been notified
2673 * of the installation, were made aware of the risks, viewed the certificate and still wanted to
2674 * keep the certificate on the device.
2675 *
2676 * Calling with {@param approval} as {@code true} will cancel any ongoing warnings related to
2677 * this certificate.
2678 *
2679 * @hide
2680 */
2681 public boolean approveCaCert(String alias, int userHandle, boolean approval) {
2682 if (mService != null) {
2683 try {
2684 return mService.approveCaCert(alias, userHandle, approval);
2685 } catch (RemoteException e) {
2686 throw e.rethrowFromSystemServer();
2687 }
2688 }
2689 return false;
2690 }
2691
2692 /**
2693 * Check whether a CA certificate has been approved by the device user.
2694 *
2695 * @hide
2696 */
2697 public boolean isCaCertApproved(String alias, int userHandle) {
2698 if (mService != null) {
2699 try {
2700 return mService.isCaCertApproved(alias, userHandle);
2701 } catch (RemoteException e) {
2702 throw e.rethrowFromSystemServer();
2703 }
2704 }
2705 return false;
2706 }
2707
2708 /**
Robin Lee7e678712014-07-24 16:41:31 +01002709 * Installs the given certificate as a user CA.
2710 *
Robin Lee25e26452015-06-02 09:56:29 -07002711 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2712 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01002713 * @param certBuffer encoded form of the certificate to install.
Maggie Benthallda51e682013-08-08 22:35:44 -04002714 *
2715 * @return false if the certBuffer cannot be parsed or installation is
Robin Lee7e678712014-07-24 16:41:31 +01002716 * interrupted, true otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002717 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2718 * owner.
Maggie Benthallda51e682013-08-08 22:35:44 -04002719 */
Robin Lee25e26452015-06-02 09:56:29 -07002720 public boolean installCaCert(@Nullable ComponentName admin, byte[] certBuffer) {
Maggie Benthallda51e682013-08-08 22:35:44 -04002721 if (mService != null) {
2722 try {
Robin Lee7e678712014-07-24 16:41:31 +01002723 return mService.installCaCert(admin, certBuffer);
Maggie Benthallda51e682013-08-08 22:35:44 -04002724 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002725 throw e.rethrowFromSystemServer();
Maggie Benthallda51e682013-08-08 22:35:44 -04002726 }
2727 }
2728 return false;
2729 }
2730
2731 /**
Robin Lee7e678712014-07-24 16:41:31 +01002732 * Uninstalls the given certificate from trusted user CAs, if present.
2733 *
Robin Lee25e26452015-06-02 09:56:29 -07002734 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2735 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01002736 * @param certBuffer encoded form of the certificate to remove.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002737 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2738 * owner.
Maggie Benthallda51e682013-08-08 22:35:44 -04002739 */
Robin Lee25e26452015-06-02 09:56:29 -07002740 public void uninstallCaCert(@Nullable ComponentName admin, byte[] certBuffer) {
Maggie Benthallda51e682013-08-08 22:35:44 -04002741 if (mService != null) {
2742 try {
Robin Lee306fe082014-06-19 14:04:24 +00002743 final String alias = getCaCertAlias(certBuffer);
Robin Lee83881bd2015-06-09 16:04:38 -07002744 mService.uninstallCaCerts(admin, new String[] {alias});
Robin Lee306fe082014-06-19 14:04:24 +00002745 } catch (CertificateException e) {
2746 Log.w(TAG, "Unable to parse certificate", e);
Maggie Benthallda51e682013-08-08 22:35:44 -04002747 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002748 throw e.rethrowFromSystemServer();
Maggie Benthallda51e682013-08-08 22:35:44 -04002749 }
2750 }
2751 }
2752
2753 /**
Robin Lee7e678712014-07-24 16:41:31 +01002754 * Returns all CA certificates that are currently trusted, excluding system CA certificates.
2755 * If a user has installed any certificates by other means than device policy these will be
2756 * included too.
2757 *
Robin Lee25e26452015-06-02 09:56:29 -07002758 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2759 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01002760 * @return a List of byte[] arrays, each encoding one user CA certificate.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002761 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2762 * owner.
Maggie Benthallda51e682013-08-08 22:35:44 -04002763 */
Robin Lee25e26452015-06-02 09:56:29 -07002764 public List<byte[]> getInstalledCaCerts(@Nullable ComponentName admin) {
Robin Lee7e678712014-07-24 16:41:31 +01002765 List<byte[]> certs = new ArrayList<byte[]>();
Esteban Talavera808f6ef2014-08-28 17:15:54 +01002766 if (mService != null) {
Robin Lee7e678712014-07-24 16:41:31 +01002767 try {
Esteban Talavera808f6ef2014-08-28 17:15:54 +01002768 mService.enforceCanManageCaCerts(admin);
2769 final TrustedCertificateStore certStore = new TrustedCertificateStore();
2770 for (String alias : certStore.userAliases()) {
2771 try {
2772 certs.add(certStore.getCertificate(alias).getEncoded());
2773 } catch (CertificateException ce) {
2774 Log.w(TAG, "Could not encode certificate: " + alias, ce);
2775 }
2776 }
2777 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002778 throw re.rethrowFromSystemServer();
Robin Lee7e678712014-07-24 16:41:31 +01002779 }
2780 }
2781 return certs;
Maggie Benthallda51e682013-08-08 22:35:44 -04002782 }
2783
2784 /**
Robin Lee7e678712014-07-24 16:41:31 +01002785 * Uninstalls all custom trusted CA certificates from the profile. Certificates installed by
2786 * means other than device policy will also be removed, except for system CA certificates.
2787 *
Robin Lee25e26452015-06-02 09:56:29 -07002788 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2789 * {@code null} if calling from a delegated certificate installer.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002790 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2791 * owner.
Robin Lee7e678712014-07-24 16:41:31 +01002792 */
Robin Lee25e26452015-06-02 09:56:29 -07002793 public void uninstallAllUserCaCerts(@Nullable ComponentName admin) {
Robin Lee7e678712014-07-24 16:41:31 +01002794 if (mService != null) {
Robin Lee83881bd2015-06-09 16:04:38 -07002795 try {
2796 mService.uninstallCaCerts(admin, new TrustedCertificateStore().userAliases()
2797 .toArray(new String[0]));
2798 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002799 throw re.rethrowFromSystemServer();
Robin Lee7e678712014-07-24 16:41:31 +01002800 }
2801 }
2802 }
2803
2804 /**
2805 * Returns whether this certificate is installed as a trusted CA.
2806 *
Robin Lee25e26452015-06-02 09:56:29 -07002807 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2808 * {@code null} if calling from a delegated certificate installer.
Robin Lee7e678712014-07-24 16:41:31 +01002809 * @param certBuffer encoded form of the certificate to look up.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002810 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2811 * owner.
Maggie Benthallda51e682013-08-08 22:35:44 -04002812 */
Robin Lee25e26452015-06-02 09:56:29 -07002813 public boolean hasCaCertInstalled(@Nullable ComponentName admin, byte[] certBuffer) {
Esteban Talavera808f6ef2014-08-28 17:15:54 +01002814 if (mService != null) {
2815 try {
2816 mService.enforceCanManageCaCerts(admin);
2817 return getCaCertAlias(certBuffer) != null;
2818 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002819 throw re.rethrowFromSystemServer();
Esteban Talavera808f6ef2014-08-28 17:15:54 +01002820 } catch (CertificateException ce) {
2821 Log.w(TAG, "Could not parse certificate", ce);
2822 }
Maggie Benthallda51e682013-08-08 22:35:44 -04002823 }
2824 return false;
2825 }
2826
2827 /**
Robin Leece3399f2016-02-24 12:08:32 +00002828 * Called by a device or profile owner, or delegated certificate installer, to install a
2829 * certificate and corresponding private key. All apps within the profile will be able to access
2830 * the certificate and use the private key, given direct user approval.
2831 *
2832 * <p>Access to the installed credentials will not be granted to the caller of this API without
2833 * direct user approval. This is for security - should a certificate installer become
2834 * compromised, certificates it had already installed will be protected.
2835 *
2836 * <p>If the installer must have access to the credentials, call
Rubin Xub4365912016-03-23 12:13:22 +00002837 * {@link #installKeyPair(ComponentName, PrivateKey, Certificate[], String, boolean)} instead.
Bernhard Bauer26408cc2014-09-08 14:07:31 +01002838 *
Robin Lee25e26452015-06-02 09:56:29 -07002839 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
2840 * {@code null} if calling from a delegated certificate installer.
Bernhard Bauer26408cc2014-09-08 14:07:31 +01002841 * @param privKey The private key to install.
2842 * @param cert The certificate to install.
2843 * @param alias The private key alias under which to install the certificate. If a certificate
2844 * with that alias already exists, it will be overwritten.
2845 * @return {@code true} if the keys were installed, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002846 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2847 * owner.
Bernhard Bauer26408cc2014-09-08 14:07:31 +01002848 */
Robin Leefbc65642015-08-03 16:21:22 +01002849 public boolean installKeyPair(@Nullable ComponentName admin, @NonNull PrivateKey privKey,
2850 @NonNull Certificate cert, @NonNull String alias) {
Rubin Xub4365912016-03-23 12:13:22 +00002851 return installKeyPair(admin, privKey, new Certificate[] {cert}, alias, false);
Robin Leece3399f2016-02-24 12:08:32 +00002852 }
2853
2854 /**
2855 * Called by a device or profile owner, or delegated certificate installer, to install a
Rubin Xub4365912016-03-23 12:13:22 +00002856 * certificate chain and corresponding private key for the leaf certificate. All apps within the
2857 * profile will be able to access the certificate chain and use the private key, given direct
2858 * user approval.
Robin Leece3399f2016-02-24 12:08:32 +00002859 *
Robin Leea1b290e2016-03-09 14:38:36 +00002860 * <p>The caller of this API may grant itself access to the certificate and private key
2861 * immediately, without user approval. It is a best practice not to request this unless strictly
2862 * necessary since it opens up additional security vulnerabilities.
Robin Leece3399f2016-02-24 12:08:32 +00002863 *
2864 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
Robin Leea1b290e2016-03-09 14:38:36 +00002865 * {@code null} if calling from a delegated certificate installer.
Robin Leece3399f2016-02-24 12:08:32 +00002866 * @param privKey The private key to install.
Rubin Xub4365912016-03-23 12:13:22 +00002867 * @param certs The certificate chain to install. The chain should start with the leaf
2868 * certificate and include the chain of trust in order. This will be returned by
2869 * {@link android.security.KeyChain#getCertificateChain}.
Robin Leece3399f2016-02-24 12:08:32 +00002870 * @param alias The private key alias under which to install the certificate. If a certificate
Robin Leea1b290e2016-03-09 14:38:36 +00002871 * with that alias already exists, it will be overwritten.
Robin Leece3399f2016-02-24 12:08:32 +00002872 * @param requestAccess {@code true} to request that the calling app be granted access to the
Robin Leea1b290e2016-03-09 14:38:36 +00002873 * credentials immediately. Otherwise, access to the credentials will be gated by user
2874 * approval.
Robin Leece3399f2016-02-24 12:08:32 +00002875 * @return {@code true} if the keys were installed, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002876 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2877 * owner.
Rubin Xub4365912016-03-23 12:13:22 +00002878 * @see android.security.KeyChain#getCertificateChain
Robin Leece3399f2016-02-24 12:08:32 +00002879 */
2880 public boolean installKeyPair(@Nullable ComponentName admin, @NonNull PrivateKey privKey,
Rubin Xub4365912016-03-23 12:13:22 +00002881 @NonNull Certificate[] certs, @NonNull String alias, boolean requestAccess) {
Bernhard Bauer26408cc2014-09-08 14:07:31 +01002882 try {
Rubin Xub4365912016-03-23 12:13:22 +00002883 final byte[] pemCert = Credentials.convertToPem(certs[0]);
2884 byte[] pemChain = null;
2885 if (certs.length > 1) {
2886 pemChain = Credentials.convertToPem(Arrays.copyOfRange(certs, 1, certs.length));
2887 }
Robin Lee0d5ccb72014-09-12 17:41:44 +01002888 final byte[] pkcs8Key = KeyFactory.getInstance(privKey.getAlgorithm())
2889 .getKeySpec(privKey, PKCS8EncodedKeySpec.class).getEncoded();
Rubin Xub4365912016-03-23 12:13:22 +00002890 return mService.installKeyPair(admin, pkcs8Key, pemCert, pemChain, alias,
2891 requestAccess);
Bernhard Bauer26408cc2014-09-08 14:07:31 +01002892 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002893 throw e.rethrowFromSystemServer();
Robin Lee0d5ccb72014-09-12 17:41:44 +01002894 } catch (NoSuchAlgorithmException | InvalidKeySpecException e) {
2895 Log.w(TAG, "Failed to obtain private key material", e);
2896 } catch (CertificateException | IOException e) {
2897 Log.w(TAG, "Could not pem-encode certificate", e);
Bernhard Bauer26408cc2014-09-08 14:07:31 +01002898 }
2899 return false;
2900 }
2901
2902 /**
Robin Leea1b290e2016-03-09 14:38:36 +00002903 * Called by a device or profile owner, or delegated certificate installer, to remove a
2904 * certificate and private key pair installed under a given alias.
Robin Leefbc65642015-08-03 16:21:22 +01002905 *
2906 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
Robin Leea1b290e2016-03-09 14:38:36 +00002907 * {@code null} if calling from a delegated certificate installer.
Robin Leefbc65642015-08-03 16:21:22 +01002908 * @param alias The private key alias under which the certificate is installed.
Robin Leea1b290e2016-03-09 14:38:36 +00002909 * @return {@code true} if the private key alias no longer exists, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002910 * @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
2911 * owner.
Robin Leefbc65642015-08-03 16:21:22 +01002912 */
2913 public boolean removeKeyPair(@Nullable ComponentName admin, @NonNull String alias) {
2914 try {
2915 return mService.removeKeyPair(admin, alias);
2916 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002917 throw e.rethrowFromSystemServer();
Robin Leefbc65642015-08-03 16:21:22 +01002918 }
Robin Leefbc65642015-08-03 16:21:22 +01002919 }
2920
2921 /**
Robin Lee25e26452015-06-02 09:56:29 -07002922 * @return the alias of a given CA certificate in the certificate store, or {@code null} if it
Robin Lee306fe082014-06-19 14:04:24 +00002923 * doesn't exist.
2924 */
2925 private static String getCaCertAlias(byte[] certBuffer) throws CertificateException {
2926 final CertificateFactory certFactory = CertificateFactory.getInstance("X.509");
2927 final X509Certificate cert = (X509Certificate) certFactory.generateCertificate(
2928 new ByteArrayInputStream(certBuffer));
2929 return new TrustedCertificateStore().getCertificateAlias(cert);
2930 }
2931
2932 /**
Rubin Xuec32b562015-03-03 17:34:05 +00002933 * Called by a profile owner or device owner to grant access to privileged certificate
Rubin Xuacdc1832015-04-02 12:40:20 +01002934 * manipulation APIs to a third-party certificate installer app. Granted APIs include
Rubin Xuec32b562015-03-03 17:34:05 +00002935 * {@link #getInstalledCaCerts}, {@link #hasCaCertInstalled}, {@link #installCaCert},
Rubin Xuacdc1832015-04-02 12:40:20 +01002936 * {@link #uninstallCaCert}, {@link #uninstallAllUserCaCerts} and {@link #installKeyPair}.
Rubin Xuec32b562015-03-03 17:34:05 +00002937 * <p>
2938 * Delegated certificate installer is a per-user state. The delegated access is persistent until
2939 * it is later cleared by calling this method with a null value or uninstallling the certificate
2940 * installer.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002941 * <p>
Rubin Xuf03d0a62016-02-10 14:54:15 +00002942 * <b>Note:</b>Starting from {@link android.os.Build.VERSION_CODES#N}, if the caller
2943 * application's target SDK version is {@link android.os.Build.VERSION_CODES#N} or newer, the
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002944 * supplied certificate installer package must be installed when calling this API, otherwise an
2945 * {@link IllegalArgumentException} will be thrown.
Rubin Xuec32b562015-03-03 17:34:05 +00002946 *
Robin Lee25e26452015-06-02 09:56:29 -07002947 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Rubin Xuec32b562015-03-03 17:34:05 +00002948 * @param installerPackage The package name of the certificate installer which will be given
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002949 * access. If {@code null} is given the current package will be cleared.
2950 * @throws SecurityException if {@code admin} is not a device or a profile owner.
Rubin Xuec32b562015-03-03 17:34:05 +00002951 */
Robin Lee25e26452015-06-02 09:56:29 -07002952 public void setCertInstallerPackage(@NonNull ComponentName admin, @Nullable String
2953 installerPackage) throws SecurityException {
Rubin Xuec32b562015-03-03 17:34:05 +00002954 if (mService != null) {
2955 try {
Robin Lee25e26452015-06-02 09:56:29 -07002956 mService.setCertInstallerPackage(admin, installerPackage);
Rubin Xuec32b562015-03-03 17:34:05 +00002957 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002958 throw e.rethrowFromSystemServer();
Rubin Xuec32b562015-03-03 17:34:05 +00002959 }
2960 }
2961 }
2962
2963 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002964 * Called by a profile owner or device owner to retrieve the certificate installer for the user.
2965 * null if none is set.
Rubin Xuec32b562015-03-03 17:34:05 +00002966 *
Robin Lee25e26452015-06-02 09:56:29 -07002967 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002968 * @return The package name of the current delegated certificate installer, or {@code null} if
2969 * none is set.
2970 * @throws SecurityException if {@code admin} is not a device or a profile owner.
Rubin Xuec32b562015-03-03 17:34:05 +00002971 */
Robin Lee25e26452015-06-02 09:56:29 -07002972 public String getCertInstallerPackage(@NonNull ComponentName admin) throws SecurityException {
Rubin Xuec32b562015-03-03 17:34:05 +00002973 if (mService != null) {
2974 try {
Robin Lee25e26452015-06-02 09:56:29 -07002975 return mService.getCertInstallerPackage(admin);
Rubin Xuec32b562015-03-03 17:34:05 +00002976 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07002977 throw e.rethrowFromSystemServer();
Rubin Xuec32b562015-03-03 17:34:05 +00002978 }
2979 }
2980 return null;
2981 }
2982
2983 /**
Robin Lee244ce8e2016-01-05 18:03:46 +00002984 * Called by a device or profile owner to configure an always-on VPN connection through a
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002985 * specific application for the current user. This connection is automatically granted and
2986 * persisted after a reboot.
2987 * <p>
2988 * The designated package should declare a {@link android.net.VpnService} in its manifest
2989 * guarded by {@link android.Manifest.permission#BIND_VPN_SERVICE}, otherwise the call will
2990 * fail.
Robin Lee244ce8e2016-01-05 18:03:46 +00002991 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07002992 * @param vpnPackage The package name for an installed VPN app on the device, or {@code null} to
2993 * remove an existing always-on VPN configuration.
2994 * @return {@code true} if the package is set as always-on VPN controller; {@code false}
2995 * otherwise.
2996 * @throws SecurityException if {@code admin} is not a device or a profile owner.
Robin Leeee5eb932016-04-05 16:27:15 +01002997 * @throws NameNotFoundException if {@code vpnPackage} is not installed.
2998 * @throws UnsupportedOperationException if {@code vpnPackage} exists but does not support being
2999 * set as always-on, or if always-on VPN is not available.
Robin Lee244ce8e2016-01-05 18:03:46 +00003000 */
Robin Leeee5eb932016-04-05 16:27:15 +01003001 public void setAlwaysOnVpnPackage(@NonNull ComponentName admin, @Nullable String vpnPackage)
3002 throws NameNotFoundException, UnsupportedOperationException {
Robin Lee244ce8e2016-01-05 18:03:46 +00003003 if (mService != null) {
3004 try {
Robin Leeee5eb932016-04-05 16:27:15 +01003005 if (!mService.setAlwaysOnVpnPackage(admin, vpnPackage)) {
3006 throw new NameNotFoundException(vpnPackage);
3007 }
Robin Lee244ce8e2016-01-05 18:03:46 +00003008 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003009 throw e.rethrowFromSystemServer();
Robin Lee244ce8e2016-01-05 18:03:46 +00003010 }
3011 }
Robin Lee244ce8e2016-01-05 18:03:46 +00003012 }
3013
3014 /**
3015 * Called by a device or profile owner to read the name of the package administering an
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003016 * always-on VPN connection for the current user. If there is no such package, or the always-on
3017 * VPN is provided by the system instead of by an application, {@code null} will be returned.
Robin Lee244ce8e2016-01-05 18:03:46 +00003018 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003019 * @return Package name of VPN controller responsible for always-on VPN, or {@code null} if none
3020 * is set.
3021 * @throws SecurityException if {@code admin} is not a device or a profile owner.
Robin Lee244ce8e2016-01-05 18:03:46 +00003022 */
3023 public String getAlwaysOnVpnPackage(@NonNull ComponentName admin) {
3024 if (mService != null) {
3025 try {
3026 return mService.getAlwaysOnVpnPackage(admin);
3027 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003028 throw e.rethrowFromSystemServer();
Robin Lee244ce8e2016-01-05 18:03:46 +00003029 }
3030 }
3031 return null;
3032 }
3033
3034 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003035 * Called by an application that is administering the device to disable all cameras on the
3036 * device, for this user. After setting this, no applications running as this user will be able
3037 * to access any cameras on the device.
3038 * <p>
3039 * If the caller is device owner, then the restriction will be applied to all users.
3040 * <p>
3041 * The calling device admin must have requested
3042 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_CAMERA} to be able to call this method; if it has
3043 * not, a security exception will be thrown.
Ben Komalo2447edd2011-05-09 16:05:33 -07003044 *
3045 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3046 * @param disabled Whether or not the camera should be disabled.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003047 * @throws SecurityException if {@code admin} is not an active administrator or does not use
3048 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_CAMERA}.
Ben Komalo2447edd2011-05-09 16:05:33 -07003049 */
Robin Lee25e26452015-06-02 09:56:29 -07003050 public void setCameraDisabled(@NonNull ComponentName admin, boolean disabled) {
Ben Komalo2447edd2011-05-09 16:05:33 -07003051 if (mService != null) {
3052 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08003053 mService.setCameraDisabled(admin, disabled);
Ben Komalo2447edd2011-05-09 16:05:33 -07003054 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003055 throw e.rethrowFromSystemServer();
Ben Komalo2447edd2011-05-09 16:05:33 -07003056 }
3057 }
3058 }
3059
3060 /**
Amith Yamasani242f4b12014-10-14 16:06:13 -07003061 * Determine whether or not the device's cameras have been disabled for this user,
Makoto Onuki32b30572015-12-11 14:29:51 -08003062 * either by the calling admin, if specified, or all admins.
Robin Lee25e26452015-06-02 09:56:29 -07003063 * @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 -07003064 * have disabled the camera
3065 */
Robin Lee25e26452015-06-02 09:56:29 -07003066 public boolean getCameraDisabled(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003067 return getCameraDisabled(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003068 }
3069
3070 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07003071 public boolean getCameraDisabled(@Nullable ComponentName admin, int userHandle) {
Ben Komalo2447edd2011-05-09 16:05:33 -07003072 if (mService != null) {
3073 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003074 return mService.getCameraDisabled(admin, userHandle);
Ben Komalo2447edd2011-05-09 16:05:33 -07003075 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003076 throw e.rethrowFromSystemServer();
Ben Komalo2447edd2011-05-09 16:05:33 -07003077 }
3078 }
3079 return false;
3080 }
3081
3082 /**
Michal Karpinski3fc437e2015-12-15 10:09:00 +00003083 * Called by a device owner to request a bugreport.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003084 * <p>
3085 * There must be only one user on the device, managed by the device owner. Otherwise a
3086 * {@link SecurityException} will be thrown.
Michal Karpinski3fc437e2015-12-15 10:09:00 +00003087 *
3088 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003089 * @return {@code true} if the bugreport collection started successfully, or {@code false} if it
3090 * wasn't triggered because a previous bugreport operation is still active (either the
3091 * bugreport is still running or waiting for the user to share or decline)
3092 * @throws SecurityException if {@code admin} is not a device owner, or if there are users other
3093 * than the one managed by the device owner.
Michal Karpinski3fc437e2015-12-15 10:09:00 +00003094 */
3095 public boolean requestBugreport(@NonNull ComponentName admin) {
3096 if (mService != null) {
3097 try {
3098 return mService.requestBugreport(admin);
3099 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003100 throw e.rethrowFromSystemServer();
Michal Karpinski3fc437e2015-12-15 10:09:00 +00003101 }
3102 }
3103 return false;
3104 }
3105
3106 /**
Fyodor Kupolovcd86ebf2015-09-29 17:06:50 -07003107 * Determine whether or not creating a guest user has been disabled for the device
3108 *
3109 * @hide
3110 */
3111 public boolean getGuestUserDisabled(@Nullable ComponentName admin) {
3112 // Currently guest users can always be created if multi-user is enabled
3113 // TODO introduce a policy for guest user creation
3114 return false;
3115 }
3116
3117 /**
Esteban Talavera1aee98f2014-08-21 14:03:55 +01003118 * Called by a device/profile owner to set whether the screen capture is disabled. Disabling
3119 * screen capture also prevents the content from being shown on display devices that do not have
3120 * a secure video output. See {@link android.view.Display#FLAG_SECURE} for more details about
3121 * secure surfaces and secure displays.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003122 * <p>
3123 * The calling device admin must be a device or profile owner. If it is not, a security
3124 * exception will be thrown.
3125 * <p>
3126 * From version {@link android.os.Build.VERSION_CODES#M} disabling screen capture also blocks
3127 * assist requests for all activities of the relevant user.
Benjamin Franzc200f442015-06-25 18:20:04 +01003128 *
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003129 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003130 * @param disabled Whether screen capture is disabled or not.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003131 * @throws SecurityException if {@code admin} is not a device or profile owner.
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003132 */
Robin Lee25e26452015-06-02 09:56:29 -07003133 public void setScreenCaptureDisabled(@NonNull ComponentName admin, boolean disabled) {
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003134 if (mService != null) {
3135 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08003136 mService.setScreenCaptureDisabled(admin, disabled);
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003137 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003138 throw e.rethrowFromSystemServer();
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003139 }
3140 }
3141 }
3142
3143 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08003144 * Determine whether or not screen capture has been disabled by the calling
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003145 * admin, if specified, or all admins.
Robin Lee25e26452015-06-02 09:56:29 -07003146 * @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 +01003147 * have disabled screen capture.
3148 */
Robin Lee25e26452015-06-02 09:56:29 -07003149 public boolean getScreenCaptureDisabled(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003150 return getScreenCaptureDisabled(admin, myUserId());
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003151 }
3152
3153 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07003154 public boolean getScreenCaptureDisabled(@Nullable ComponentName admin, int userHandle) {
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003155 if (mService != null) {
3156 try {
3157 return mService.getScreenCaptureDisabled(admin, userHandle);
3158 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003159 throw e.rethrowFromSystemServer();
Sander Alewijnsed2a1eec2014-07-09 12:57:05 +01003160 }
3161 }
3162 return false;
3163 }
3164
3165 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003166 * Called by a device owner to set whether auto time is required. If auto time is required the
3167 * user cannot set the date and time, but has to use network date and time.
3168 * <p>
3169 * Note: if auto time is required the user can still manually set the time zone.
3170 * <p>
3171 * The calling device admin must be a device owner. If it is not, a security exception will be
3172 * thrown.
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003173 *
3174 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3175 * @param required Whether auto time is set required or not.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003176 * @throws SecurityException if {@code admin} is not a device owner.
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003177 */
Robin Lee25e26452015-06-02 09:56:29 -07003178 public void setAutoTimeRequired(@NonNull ComponentName admin, boolean required) {
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003179 if (mService != null) {
3180 try {
Fyodor Kupolovbdc58c62015-01-29 13:24:03 -08003181 mService.setAutoTimeRequired(admin, required);
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003182 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003183 throw e.rethrowFromSystemServer();
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003184 }
3185 }
3186 }
3187
3188 /**
3189 * @return true if auto time is required.
3190 */
3191 public boolean getAutoTimeRequired() {
3192 if (mService != null) {
3193 try {
3194 return mService.getAutoTimeRequired();
3195 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003196 throw e.rethrowFromSystemServer();
Sander Alewijnse0ced6272014-08-26 11:18:26 +01003197 }
3198 }
3199 return false;
3200 }
3201
3202 /**
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003203 * Called by a device owner to set whether all users created on the device should be ephemeral.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003204 * <p>
3205 * The system user is exempt from this policy - it is never ephemeral.
3206 * <p>
3207 * The calling device admin must be the device owner. If it is not, a security exception will be
3208 * thrown.
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003209 *
3210 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3211 * @param forceEphemeralUsers If true, all the existing users will be deleted and all
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003212 * subsequently created users will be ephemeral.
3213 * @throws SecurityException if {@code admin} is not a device owner.
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003214 * @hide
3215 */
3216 public void setForceEphemeralUsers(
3217 @NonNull ComponentName admin, boolean forceEphemeralUsers) {
3218 if (mService != null) {
3219 try {
3220 mService.setForceEphemeralUsers(admin, forceEphemeralUsers);
3221 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003222 throw e.rethrowFromSystemServer();
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003223 }
3224 }
3225 }
3226
3227 /**
3228 * @return true if all users are created ephemeral.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003229 * @throws SecurityException if {@code admin} is not a device owner.
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003230 * @hide
3231 */
3232 public boolean getForceEphemeralUsers(@NonNull ComponentName admin) {
3233 if (mService != null) {
3234 try {
3235 return mService.getForceEphemeralUsers(admin);
3236 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003237 throw e.rethrowFromSystemServer();
Lenka Trochtovaf348e8e2016-01-07 17:20:34 +01003238 }
3239 }
3240 return false;
3241 }
3242
3243 /**
Jim Miller48b9b0d2012-09-19 23:16:50 -07003244 * Called by an application that is administering the device to disable keyguard customizations,
3245 * such as widgets. After setting this, keyguard features will be disabled according to the
3246 * provided feature list.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003247 * <p>
3248 * The calling device admin must have requested
3249 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES} to be able to call this method;
3250 * if it has not, a security exception will be thrown.
3251 * <p>
3252 * Calling this from a managed profile before version {@link android.os.Build.VERSION_CODES#M}
3253 * will throw a security exception. From version {@link android.os.Build.VERSION_CODES#M} the
3254 * profile owner of a managed profile can set:
Kenny Guy0b7dd1e2015-03-12 17:14:38 +00003255 * <ul>
Esteban Talaverac1c83592016-02-17 17:56:15 +00003256 * <li>{@link #KEYGUARD_DISABLE_TRUST_AGENTS}, which affects the parent user, but only if there
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003257 * is no separate challenge set on the managed profile.
Esteban Talaverac1c83592016-02-17 17:56:15 +00003258 * <li>{@link #KEYGUARD_DISABLE_FINGERPRINT} which affects the managed profile challenge if
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003259 * there is one, or the parent user otherwise.
3260 * <li>{@link #KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS} which affects notifications generated
3261 * by applications in the managed profile.
Kenny Guy0b7dd1e2015-03-12 17:14:38 +00003262 * </ul>
Esteban Talaverac1c83592016-02-17 17:56:15 +00003263 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} and {@link #KEYGUARD_DISABLE_FINGERPRINT} can also be
3264 * set on the {@link DevicePolicyManager} instance returned by
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003265 * {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
3266 * profile.
3267 * <p>
3268 * Requests to disable other features on a managed profile will be ignored.
3269 * <p>
3270 * The admin can check which features have been disabled by calling
Kenny Guy0b7dd1e2015-03-12 17:14:38 +00003271 * {@link #getKeyguardDisabledFeatures(ComponentName)}
Amith Yamasani242f4b12014-10-14 16:06:13 -07003272 *
Jim Millerb8ec4702012-08-31 17:19:10 -07003273 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Jim Miller35207742012-11-02 15:33:20 -07003274 * @param which {@link #KEYGUARD_DISABLE_FEATURES_NONE} (default),
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003275 * {@link #KEYGUARD_DISABLE_WIDGETS_ALL}, {@link #KEYGUARD_DISABLE_SECURE_CAMERA},
3276 * {@link #KEYGUARD_DISABLE_SECURE_NOTIFICATIONS},
3277 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS},
3278 * {@link #KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS},
3279 * {@link #KEYGUARD_DISABLE_FINGERPRINT}, {@link #KEYGUARD_DISABLE_FEATURES_ALL}
3280 * @throws SecurityException if {@code admin} is not an active administrator or does not user
3281 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES}
Jim Millerb8ec4702012-08-31 17:19:10 -07003282 */
Robin Lee25e26452015-06-02 09:56:29 -07003283 public void setKeyguardDisabledFeatures(@NonNull ComponentName admin, int which) {
Jim Millerb8ec4702012-08-31 17:19:10 -07003284 if (mService != null) {
3285 try {
Esteban Talavera62399912016-01-11 15:37:55 +00003286 mService.setKeyguardDisabledFeatures(admin, which, mParentInstance);
Jim Millerb8ec4702012-08-31 17:19:10 -07003287 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003288 throw e.rethrowFromSystemServer();
Jim Millerb8ec4702012-08-31 17:19:10 -07003289 }
3290 }
3291 }
3292
3293 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08003294 * Determine whether or not features have been disabled in keyguard either by the calling
Esteban Talaverac1c83592016-02-17 17:56:15 +00003295 * admin, if specified, or all admins that set retrictions on this user and its participating
3296 * profiles. Restrictions on profiles that have a separate challenge are not taken into account.
3297 *
3298 * <p>This method can be called on the {@link DevicePolicyManager} instance
3299 * returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
3300 * restrictions on the parent profile.
3301 *
Esteban Talavera62399912016-01-11 15:37:55 +00003302 * @param admin The name of the admin component to check, or {@code null} to check whether any
3303 * admins have disabled features in keyguard.
Jim Miller35207742012-11-02 15:33:20 -07003304 * @return bitfield of flags. See {@link #setKeyguardDisabledFeatures(ComponentName, int)}
3305 * for a list.
Jim Millerb8ec4702012-08-31 17:19:10 -07003306 */
Robin Lee25e26452015-06-02 09:56:29 -07003307 public int getKeyguardDisabledFeatures(@Nullable ComponentName admin) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003308 return getKeyguardDisabledFeatures(admin, myUserId());
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003309 }
3310
3311 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07003312 public int getKeyguardDisabledFeatures(@Nullable ComponentName admin, int userHandle) {
Jim Millerb8ec4702012-08-31 17:19:10 -07003313 if (mService != null) {
3314 try {
Esteban Talavera62399912016-01-11 15:37:55 +00003315 return mService.getKeyguardDisabledFeatures(admin, userHandle, mParentInstance);
Jim Millerb8ec4702012-08-31 17:19:10 -07003316 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003317 throw e.rethrowFromSystemServer();
Jim Millerb8ec4702012-08-31 17:19:10 -07003318 }
3319 }
Jim Miller48b9b0d2012-09-19 23:16:50 -07003320 return KEYGUARD_DISABLE_FEATURES_NONE;
Jim Millerb8ec4702012-08-31 17:19:10 -07003321 }
3322
3323 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -08003324 * @hide
3325 */
Robin Lee25e26452015-06-02 09:56:29 -07003326 public void setActiveAdmin(@NonNull ComponentName policyReceiver, boolean refreshing,
3327 int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08003328 if (mService != null) {
3329 try {
Jessica Hummel6d36b602014-04-04 12:42:17 +01003330 mService.setActiveAdmin(policyReceiver, refreshing, userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08003331 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003332 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08003333 }
3334 }
3335 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07003336
Dianne Hackbornd6847842010-01-12 18:14:19 -08003337 /**
Jessica Hummel6d36b602014-04-04 12:42:17 +01003338 * @hide
3339 */
Robin Lee25e26452015-06-02 09:56:29 -07003340 public void setActiveAdmin(@NonNull ComponentName policyReceiver, boolean refreshing) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003341 setActiveAdmin(policyReceiver, refreshing, myUserId());
Jessica Hummel6d36b602014-04-04 12:42:17 +01003342 }
3343
3344 /**
Dianne Hackbornd6847842010-01-12 18:14:19 -08003345 * @hide
3346 */
Robin Lee25e26452015-06-02 09:56:29 -07003347 public void getRemoveWarning(@Nullable ComponentName admin, RemoteCallback result) {
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08003348 if (mService != null) {
3349 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003350 mService.getRemoveWarning(admin, result, myUserId());
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08003351 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003352 throw e.rethrowFromSystemServer();
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08003353 }
3354 }
3355 }
3356
3357 /**
3358 * @hide
3359 */
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07003360 public void setActivePasswordState(int quality, int length, int letters, int uppercase,
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003361 int lowercase, int numbers, int symbols, int nonletter, int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08003362 if (mService != null) {
3363 try {
Konstantin Lopyreva15dcfa2010-05-24 17:10:56 -07003364 mService.setActivePasswordState(quality, length, letters, uppercase, lowercase,
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003365 numbers, symbols, nonletter, userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08003366 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003367 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08003368 }
3369 }
3370 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07003371
Dianne Hackbornd6847842010-01-12 18:14:19 -08003372 /**
3373 * @hide
3374 */
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003375 public void reportFailedPasswordAttempt(int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08003376 if (mService != null) {
3377 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003378 mService.reportFailedPasswordAttempt(userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08003379 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003380 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08003381 }
3382 }
3383 }
Konstantin Lopyrev32558232010-05-20 16:18:05 -07003384
Dianne Hackbornd6847842010-01-12 18:14:19 -08003385 /**
3386 * @hide
3387 */
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003388 public void reportSuccessfulPasswordAttempt(int userHandle) {
Dianne Hackbornd6847842010-01-12 18:14:19 -08003389 if (mService != null) {
3390 try {
Amith Yamasani599dd7c2012-09-14 23:20:08 -07003391 mService.reportSuccessfulPasswordAttempt(userHandle);
Dianne Hackbornd6847842010-01-12 18:14:19 -08003392 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003393 throw e.rethrowFromSystemServer();
Dianne Hackbornd6847842010-01-12 18:14:19 -08003394 }
3395 }
3396 }
Amith Yamasani71e6c692013-03-24 17:39:28 -07003397
3398 /**
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003399 * @hide
3400 */
3401 public void reportFailedFingerprintAttempt(int userHandle) {
3402 if (mService != null) {
3403 try {
3404 mService.reportFailedFingerprintAttempt(userHandle);
3405 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003406 throw e.rethrowFromSystemServer();
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003407 }
3408 }
3409 }
3410
3411 /**
3412 * @hide
3413 */
3414 public void reportSuccessfulFingerprintAttempt(int userHandle) {
3415 if (mService != null) {
3416 try {
3417 mService.reportSuccessfulFingerprintAttempt(userHandle);
3418 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003419 throw e.rethrowFromSystemServer();
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003420 }
3421 }
3422 }
3423
3424 /**
Michal Karpinski31502d32016-01-25 16:43:07 +00003425 * Should be called when keyguard has been dismissed.
3426 * @hide
3427 */
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003428 public void reportKeyguardDismissed(int userHandle) {
Michal Karpinski31502d32016-01-25 16:43:07 +00003429 if (mService != null) {
3430 try {
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003431 mService.reportKeyguardDismissed(userHandle);
Michal Karpinski31502d32016-01-25 16:43:07 +00003432 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003433 throw e.rethrowFromSystemServer();
Michal Karpinski31502d32016-01-25 16:43:07 +00003434 }
3435 }
3436 }
3437
3438 /**
3439 * Should be called when keyguard view has been shown to the user.
3440 * @hide
3441 */
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003442 public void reportKeyguardSecured(int userHandle) {
Michal Karpinski31502d32016-01-25 16:43:07 +00003443 if (mService != null) {
3444 try {
Michal Karpinskied5c8f02016-02-09 15:43:41 +00003445 mService.reportKeyguardSecured(userHandle);
Michal Karpinski31502d32016-01-25 16:43:07 +00003446 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003447 throw e.rethrowFromSystemServer();
Michal Karpinski31502d32016-01-25 16:43:07 +00003448 }
3449 }
3450 }
3451
3452 /**
Amith Yamasani71e6c692013-03-24 17:39:28 -07003453 * @hide
Nicolas Prevot28063742015-01-08 15:37:12 +00003454 * Sets the given package as the device owner.
Makoto Onukia52562c2015-10-01 16:12:31 -07003455 * Same as {@link #setDeviceOwner(ComponentName, String)} but without setting a device owner name.
3456 * @param who the component name to be registered as device owner.
Amith Yamasani71e6c692013-03-24 17:39:28 -07003457 * @return whether the package was successfully registered as the device owner.
3458 * @throws IllegalArgumentException if the package name is null or invalid
Nicolas Prevot28063742015-01-08 15:37:12 +00003459 * @throws IllegalStateException If the preconditions mentioned are not met.
Amith Yamasani71e6c692013-03-24 17:39:28 -07003460 */
Makoto Onukia52562c2015-10-01 16:12:31 -07003461 public boolean setDeviceOwner(ComponentName who) {
3462 return setDeviceOwner(who, null);
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003463 }
3464
3465 /**
3466 * @hide
Makoto Onuki58b684f2015-09-04 10:48:16 -07003467 */
Makoto Onukia52562c2015-10-01 16:12:31 -07003468 public boolean setDeviceOwner(ComponentName who, int userId) {
3469 return setDeviceOwner(who, null, userId);
Makoto Onuki58b684f2015-09-04 10:48:16 -07003470 }
3471
3472 /**
3473 * @hide
3474 */
Makoto Onukia52562c2015-10-01 16:12:31 -07003475 public boolean setDeviceOwner(ComponentName who, String ownerName) {
3476 return setDeviceOwner(who, ownerName, UserHandle.USER_SYSTEM);
Makoto Onuki58b684f2015-09-04 10:48:16 -07003477 }
3478
3479 /**
3480 * @hide
Nicolas Prevot28063742015-01-08 15:37:12 +00003481 * Sets the given package as the device owner. The package must already be installed. There
3482 * must not already be a device owner.
3483 * Only apps with the MANAGE_PROFILE_AND_DEVICE_OWNERS permission and the shell uid can call
3484 * this method.
3485 * Calling this after the setup phase of the primary user has completed is allowed only if
3486 * the caller is the shell uid, and there are no additional users and no accounts.
Makoto Onukia52562c2015-10-01 16:12:31 -07003487 * @param who the component name to be registered as device owner.
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003488 * @param ownerName the human readable name of the institution that owns this device.
Makoto Onuki58b684f2015-09-04 10:48:16 -07003489 * @param userId ID of the user on which the device owner runs.
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003490 * @return whether the package was successfully registered as the device owner.
3491 * @throws IllegalArgumentException if the package name is null or invalid
Nicolas Prevot28063742015-01-08 15:37:12 +00003492 * @throws IllegalStateException If the preconditions mentioned are not met.
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003493 */
Makoto Onukia52562c2015-10-01 16:12:31 -07003494 public boolean setDeviceOwner(ComponentName who, String ownerName, int userId)
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003495 throws IllegalArgumentException, IllegalStateException {
Amith Yamasani71e6c692013-03-24 17:39:28 -07003496 if (mService != null) {
3497 try {
Makoto Onukia52562c2015-10-01 16:12:31 -07003498 return mService.setDeviceOwner(who, ownerName, userId);
Amith Yamasani71e6c692013-03-24 17:39:28 -07003499 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003500 throw re.rethrowFromSystemServer();
Amith Yamasani71e6c692013-03-24 17:39:28 -07003501 }
3502 }
3503 return false;
3504 }
3505
3506 /**
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003507 * Used to determine if a particular package has been registered as a Device Owner app.
3508 * A device owner app is a special device admin that cannot be deactivated by the user, once
Robin Lee25e26452015-06-02 09:56:29 -07003509 * activated as a device admin. It also cannot be uninstalled. To check whether a particular
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003510 * package is currently registered as the device owner app, pass in the package name from
3511 * {@link Context#getPackageName()} to this method.<p/>This is useful for device
Robin Lee25e26452015-06-02 09:56:29 -07003512 * admin apps that want to check whether they are also registered as the device owner app. The
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003513 * exact mechanism by which a device admin app is registered as a device owner app is defined by
3514 * the setup process.
3515 * @param packageName the package name of the app, to compare with the registered device owner
3516 * app, if any.
Makoto Onukic8a5a552015-11-19 14:29:12 -08003517 * @return whether or not the package is registered as the device owner app.
Amith Yamasani71e6c692013-03-24 17:39:28 -07003518 */
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003519 public boolean isDeviceOwnerApp(String packageName) {
Makoto Onukic8a5a552015-11-19 14:29:12 -08003520 return isDeviceOwnerAppOnCallingUser(packageName);
3521 }
3522
3523 /**
3524 * @return true if a package is registered as device owner, only when it's running on the
3525 * calling user.
3526 *
3527 * <p>Same as {@link #isDeviceOwnerApp}, but bundled code should use it for clarity.
3528 * @hide
3529 */
3530 public boolean isDeviceOwnerAppOnCallingUser(String packageName) {
3531 return isDeviceOwnerAppOnAnyUserInner(packageName, /* callingUserOnly =*/ true);
3532 }
3533
3534 /**
3535 * @return true if a package is registered as device owner, even if it's running on a different
3536 * user.
3537 *
3538 * <p>Requires the MANAGE_USERS permission.
3539 *
3540 * @hide
3541 */
3542 public boolean isDeviceOwnerAppOnAnyUser(String packageName) {
3543 return isDeviceOwnerAppOnAnyUserInner(packageName, /* callingUserOnly =*/ false);
3544 }
3545
3546 /**
3547 * @return device owner component name, only when it's running on the calling user.
3548 *
3549 * @hide
3550 */
3551 public ComponentName getDeviceOwnerComponentOnCallingUser() {
3552 return getDeviceOwnerComponentInner(/* callingUserOnly =*/ true);
3553 }
3554
3555 /**
3556 * @return device owner component name, even if it's running on a different user.
3557 *
3558 * <p>Requires the MANAGE_USERS permission.
3559 *
3560 * @hide
3561 */
3562 public ComponentName getDeviceOwnerComponentOnAnyUser() {
3563 return getDeviceOwnerComponentInner(/* callingUserOnly =*/ false);
3564 }
3565
3566 private boolean isDeviceOwnerAppOnAnyUserInner(String packageName, boolean callingUserOnly) {
Makoto Onuki70f929e2015-11-11 12:40:15 -08003567 if (packageName == null) {
3568 return false;
Amith Yamasani71e6c692013-03-24 17:39:28 -07003569 }
Makoto Onukic8a5a552015-11-19 14:29:12 -08003570 final ComponentName deviceOwner = getDeviceOwnerComponentInner(callingUserOnly);
Makoto Onuki70f929e2015-11-11 12:40:15 -08003571 if (deviceOwner == null) {
3572 return false;
3573 }
3574 return packageName.equals(deviceOwner.getPackageName());
Amith Yamasani71e6c692013-03-24 17:39:28 -07003575 }
3576
Makoto Onukic8a5a552015-11-19 14:29:12 -08003577 private ComponentName getDeviceOwnerComponentInner(boolean callingUserOnly) {
3578 if (mService != null) {
3579 try {
3580 return mService.getDeviceOwnerComponent(callingUserOnly);
3581 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003582 throw re.rethrowFromSystemServer();
Makoto Onukic8a5a552015-11-19 14:29:12 -08003583 }
3584 }
3585 return null;
Amith Yamasani3b458ad2013-04-18 18:40:07 -07003586 }
3587
Jason Monkb0dced82014-06-06 14:36:20 -04003588 /**
Makoto Onukic8a5a552015-11-19 14:29:12 -08003589 * @return ID of the user who runs device owner, or {@link UserHandle#USER_NULL} if there's
3590 * no device owner.
3591 *
3592 * <p>Requires the MANAGE_USERS permission.
Makoto Onukia52562c2015-10-01 16:12:31 -07003593 *
3594 * @hide
3595 */
Makoto Onukic8a5a552015-11-19 14:29:12 -08003596 public int getDeviceOwnerUserId() {
3597 if (mService != null) {
3598 try {
3599 return mService.getDeviceOwnerUserId();
3600 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003601 throw re.rethrowFromSystemServer();
Makoto Onukic8a5a552015-11-19 14:29:12 -08003602 }
3603 }
3604 return UserHandle.USER_NULL;
Makoto Onukia52562c2015-10-01 16:12:31 -07003605 }
3606
3607 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003608 * Clears the current device owner. The caller must be the device owner. This function should be
3609 * used cautiously as once it is called it cannot be undone. The device owner can only be set as
3610 * a part of device setup before setup completes.
Jason Monk94d2cf92014-06-18 09:53:34 -04003611 *
3612 * @param packageName The package name of the device owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003613 * @throws SecurityException if the caller is not in {@code packageName} or {@code packageName}
3614 * does not own the current device owner component.
Jason Monkb0dced82014-06-06 14:36:20 -04003615 */
Jason Monk94d2cf92014-06-18 09:53:34 -04003616 public void clearDeviceOwnerApp(String packageName) {
Jason Monkb0dced82014-06-06 14:36:20 -04003617 if (mService != null) {
3618 try {
Jason Monk94d2cf92014-06-18 09:53:34 -04003619 mService.clearDeviceOwner(packageName);
Jason Monkb0dced82014-06-06 14:36:20 -04003620 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003621 throw re.rethrowFromSystemServer();
Jason Monkb0dced82014-06-06 14:36:20 -04003622 }
3623 }
3624 }
3625
Makoto Onukia52562c2015-10-01 16:12:31 -07003626 /**
Makoto Onukic8a5a552015-11-19 14:29:12 -08003627 * Returns the device owner package name, only if it's running on the calling user.
3628 *
3629 * <p>Bundled components should use {@code getDeviceOwnerComponentOnCallingUser()} for clarity.
Makoto Onukia52562c2015-10-01 16:12:31 -07003630 *
3631 * @hide
3632 */
Nicolas Prevot465acf32014-08-06 17:03:25 +01003633 @SystemApi
Amith Yamasani71e6c692013-03-24 17:39:28 -07003634 public String getDeviceOwner() {
Makoto Onukic8a5a552015-11-19 14:29:12 -08003635 final ComponentName name = getDeviceOwnerComponentOnCallingUser();
3636 return name != null ? name.getPackageName() : null;
Makoto Onukia52562c2015-10-01 16:12:31 -07003637 }
3638
3639 /**
Makoto Onukic8a5a552015-11-19 14:29:12 -08003640 * @return true if the device is managed by any 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 boolean isDeviceManaged() {
3647 return getDeviceOwnerComponentOnAnyUser() != null;
3648 }
3649
3650 /**
3651 * Returns the device owner name. Note this method *will* return the device owner
3652 * name when it's running on a different user.
3653 *
3654 * <p>Requires the MANAGE_USERS permission.
3655 *
3656 * @hide
3657 */
Makoto Onukia2b274b2016-01-19 13:26:02 -08003658 @SystemApi
Makoto Onukic8a5a552015-11-19 14:29:12 -08003659 public String getDeviceOwnerNameOnAnyUser() {
Amith Yamasani71e6c692013-03-24 17:39:28 -07003660 if (mService != null) {
3661 try {
Makoto Onukia52562c2015-10-01 16:12:31 -07003662 return mService.getDeviceOwnerName();
Amith Yamasani71e6c692013-03-24 17:39:28 -07003663 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003664 throw re.rethrowFromSystemServer();
Geoffrey Borggaard334c7e32013-08-08 14:31:36 -04003665 }
3666 }
3667 return null;
3668 }
Adam Connors776c5552014-01-09 10:42:56 +00003669
3670 /**
Julia Reynolds94e7bf62015-06-10 14:44:56 -04003671 * @hide
Craig Lafayettee7ee54e2015-09-21 13:48:53 -04003672 * @deprecated Do not use
3673 * @removed
Julia Reynolds20118f12015-02-11 12:34:08 -05003674 */
Craig Lafayettee7ee54e2015-09-21 13:48:53 -04003675 @Deprecated
Julia Reynolds20118f12015-02-11 12:34:08 -05003676 @SystemApi
3677 public String getDeviceInitializerApp() {
Julia Reynolds20118f12015-02-11 12:34:08 -05003678 return null;
3679 }
3680
3681 /**
Julia Reynoldseaafdf722015-04-02 08:49:47 -04003682 * @hide
Craig Lafayettee7ee54e2015-09-21 13:48:53 -04003683 * @deprecated Do not use
3684 * @removed
Julia Reynoldseaafdf722015-04-02 08:49:47 -04003685 */
Craig Lafayettee7ee54e2015-09-21 13:48:53 -04003686 @Deprecated
Julia Reynoldseaafdf722015-04-02 08:49:47 -04003687 @SystemApi
3688 public ComponentName getDeviceInitializerComponent() {
Julia Reynoldseaafdf722015-04-02 08:49:47 -04003689 return null;
3690 }
3691
Julia Reynolds20118f12015-02-11 12:34:08 -05003692 /**
Adam Connors776c5552014-01-09 10:42:56 +00003693 * @hide
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003694 * @deprecated Use #ACTION_SET_PROFILE_OWNER
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303695 * Sets the given component as an active admin and registers the package as the profile
3696 * owner for this user. The package must already be installed and there shouldn't be
3697 * an existing profile owner registered for this user. Also, this method must be called
3698 * before the user setup has been completed.
3699 * <p>
3700 * This method can only be called by system apps that hold MANAGE_USERS permission and
3701 * MANAGE_DEVICE_ADMINS permission.
3702 * @param admin The component to register as an active admin and profile owner.
3703 * @param ownerName The user-visible name of the entity that is managing this user.
3704 * @return whether the admin was successfully registered as the profile owner.
3705 * @throws IllegalArgumentException if packageName is null, the package isn't installed, or
3706 * the user has already been set up.
3707 */
Justin Morey80440cc2014-07-24 09:16:35 -05003708 @SystemApi
Robin Lee25e26452015-06-02 09:56:29 -07003709 public boolean setActiveProfileOwner(@NonNull ComponentName admin, @Deprecated String ownerName)
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303710 throws IllegalArgumentException {
3711 if (mService != null) {
3712 try {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07003713 final int myUserId = myUserId();
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303714 mService.setActiveAdmin(admin, false, myUserId);
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003715 return mService.setProfileOwner(admin, ownerName, myUserId);
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303716 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003717 throw re.rethrowFromSystemServer();
Amith Yamasaniaba4f1b2014-07-01 15:36:12 +05303718 }
3719 }
3720 return false;
3721 }
3722
3723 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003724 * Clears the active profile owner and removes all user restrictions. The caller must be from
3725 * the same package as the active profile owner for this user, otherwise a SecurityException
3726 * will be thrown.
3727 * <p>
3728 * This doesn't work for managed profile owners.
Makoto Onuki5bf68022016-01-27 13:49:19 -08003729 *
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003730 * @param admin The component to remove as the profile owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003731 * @throws SecurityException if {@code admin} is not an active profile owner.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003732 */
Robin Lee25e26452015-06-02 09:56:29 -07003733 public void clearProfileOwner(@NonNull ComponentName admin) {
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003734 if (mService != null) {
3735 try {
3736 mService.clearProfileOwner(admin);
3737 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003738 throw re.rethrowFromSystemServer();
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003739 }
3740 }
3741 }
3742
3743 /**
Julia Reynoldse9254402015-02-11 12:34:08 -05003744 * @hide
Robin Lee25e26452015-06-02 09:56:29 -07003745 * Checks whether the user was already setup.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003746 */
3747 public boolean hasUserSetupCompleted() {
3748 if (mService != null) {
3749 try {
3750 return mService.hasUserSetupCompleted();
3751 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003752 throw re.rethrowFromSystemServer();
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003753 }
3754 }
3755 return true;
3756 }
3757
3758 /**
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003759 * @hide
3760 * Sets the given component as the profile owner of the given user profile. The package must
Nicolas Prevot28063742015-01-08 15:37:12 +00003761 * already be installed. There must not already be a profile owner for this user.
3762 * Only apps with the MANAGE_PROFILE_AND_DEVICE_OWNERS permission and the shell uid can call
3763 * this method.
3764 * Calling this after the setup phase of the specified user has completed is allowed only if:
3765 * - the caller is SYSTEM_UID.
3766 * - or the caller is the shell uid, and there are no accounts on the specified user.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003767 * @param admin the component name to be registered as profile owner.
3768 * @param ownerName the human readable name of the organisation associated with this DPM.
3769 * @param userHandle the userId to set the profile owner for.
3770 * @return whether the component was successfully registered as the profile owner.
Nicolas Prevot28063742015-01-08 15:37:12 +00003771 * @throws IllegalArgumentException if admin is null, the package isn't installed, or the
3772 * preconditions mentioned are not met.
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003773 */
Robin Lee25e26452015-06-02 09:56:29 -07003774 public boolean setProfileOwner(@NonNull ComponentName admin, @Deprecated String ownerName,
Robin Leeddd553f2015-04-30 14:18:22 +01003775 int userHandle) throws IllegalArgumentException {
Adam Connors776c5552014-01-09 10:42:56 +00003776 if (mService != null) {
3777 try {
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003778 if (ownerName == null) {
3779 ownerName = "";
3780 }
3781 return mService.setProfileOwner(admin, ownerName, userHandle);
Adam Connors776c5552014-01-09 10:42:56 +00003782 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003783 throw re.rethrowFromSystemServer();
Adam Connors776c5552014-01-09 10:42:56 +00003784 }
3785 }
3786 return false;
3787 }
3788
3789 /**
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003790 * Sets the device owner information to be shown on the lock screen.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003791 * <p>
3792 * If the device owner information is {@code null} or empty then the device owner info is
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003793 * cleared and the user owner info is shown on the lock screen if it is set.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003794 * <p>
3795 * If the device owner information contains only whitespaces then the message on the lock screen
3796 * will be blank and the user will not be allowed to change it.
3797 * <p>
3798 * If the device owner information needs to be localized, it is the responsibility of the
Benjamin Franz3e8a7092016-01-25 16:19:08 +00003799 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
3800 * and set a new version of this string accordingly.
3801 *
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003802 * @param admin The name of the admin component to check.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003803 * @param info Device owner information which will be displayed instead of the user owner info.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003804 * @throws SecurityException if {@code admin} is not a device owner.
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003805 */
Andrei Stingaceanu16187902016-03-21 15:44:45 +00003806 public void setDeviceOwnerLockScreenInfo(@NonNull ComponentName admin, CharSequence info) {
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003807 if (mService != null) {
3808 try {
Andrei Stingaceanu16187902016-03-21 15:44:45 +00003809 mService.setDeviceOwnerLockScreenInfo(admin, info);
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003810 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003811 throw re.rethrowFromSystemServer();
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003812 }
3813 }
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003814 }
3815
3816 /**
3817 * @return The device owner information. If it is not set returns {@code null}.
3818 */
Andrei Stingaceanu16187902016-03-21 15:44:45 +00003819 public CharSequence getDeviceOwnerLockScreenInfo() {
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003820 if (mService != null) {
3821 try {
3822 return mService.getDeviceOwnerLockScreenInfo();
3823 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003824 throw re.rethrowFromSystemServer();
Andrei Stingaceanu6644cd92015-11-10 13:03:31 +00003825 }
3826 }
3827 return null;
3828 }
3829
3830 /**
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00003831 * Called by device or profile owners to suspend packages for this user.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003832 * <p>
3833 * A suspended package will not be able to start activities. Its notifications will be hidden,
3834 * it will not show up in recents, will not be able to show toasts or dialogs or ring the
3835 * device.
3836 * <p>
3837 * The package must already be installed. If the package is uninstalled while suspended the
3838 * package will no longer be suspended. The admin can block this by using
Kenny Guy871f3eb2016-03-09 20:06:16 +00003839 * {@link #setUninstallBlocked}.
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003840 *
3841 * @param admin The name of the admin component to check.
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00003842 * @param packageNames The package names to suspend or unsuspend.
3843 * @param suspended If set to {@code true} than the packages will be suspended, if set to
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003844 * {@code false} the packages will be unsuspended.
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00003845 * @return an array of package names for which the suspended status is not set as requested in
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003846 * this method.
3847 * @throws SecurityException if {@code admin} is not a device or profile owner.
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003848 */
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00003849 public String[] setPackagesSuspended(@NonNull ComponentName admin, String[] packageNames,
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003850 boolean suspended) {
3851 if (mService != null) {
3852 try {
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00003853 return mService.setPackagesSuspended(admin, packageNames, suspended);
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003854 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003855 throw re.rethrowFromSystemServer();
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003856 }
3857 }
Andrei Stingaceanueb84b182016-01-26 18:39:55 +00003858 return packageNames;
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003859 }
3860
3861 /**
3862 * Called by device or profile owners to determine if a package is suspended.
3863 *
3864 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
3865 * @param packageName The name of the package to retrieve the suspended status of.
Andrei Stingaceanu355b2322016-02-12 16:43:51 +00003866 * @return {@code true} if the package is suspended or {@code false} if the package is not
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003867 * suspended, could not be found or an error occurred.
3868 * @throws SecurityException if {@code admin} is not a device or profile owner.
Andrei Stingaceanuefc4a342016-03-22 14:43:01 +00003869 * @throws NameNotFoundException if the package could not be found.
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003870 */
Andrei Stingaceanuefc4a342016-03-22 14:43:01 +00003871 public boolean isPackageSuspended(@NonNull ComponentName admin, String packageName)
3872 throws NameNotFoundException {
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003873 if (mService != null) {
3874 try {
Andrei Stingaceanuefc4a342016-03-22 14:43:01 +00003875 return mService.isPackageSuspended(admin, packageName);
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003876 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003877 throw e.rethrowFromSystemServer();
Andrei Stingaceanuefc4a342016-03-22 14:43:01 +00003878 } catch (IllegalArgumentException ex) {
3879 throw new NameNotFoundException(packageName);
Andrei Stingaceanu1e283912015-11-26 15:26:28 +00003880 }
3881 }
3882 return false;
3883 }
3884
3885 /**
Alexandra Gherghina512675b2014-04-02 11:23:54 +01003886 * Sets the enabled state of the profile. A profile should be enabled only once it is ready to
3887 * be used. Only the profile owner can call this.
3888 *
Alexandra Gherghinadf35d572014-04-09 13:54:39 +01003889 * @see #isProfileOwnerApp
Alexandra Gherghina512675b2014-04-02 11:23:54 +01003890 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003891 * @throws SecurityException if {@code admin} is not a profile owner.
Alexandra Gherghina512675b2014-04-02 11:23:54 +01003892 */
Robin Lee25e26452015-06-02 09:56:29 -07003893 public void setProfileEnabled(@NonNull ComponentName admin) {
Alexandra Gherghina512675b2014-04-02 11:23:54 +01003894 if (mService != null) {
3895 try {
3896 mService.setProfileEnabled(admin);
3897 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003898 throw e.rethrowFromSystemServer();
Alexandra Gherghina512675b2014-04-02 11:23:54 +01003899 }
3900 }
3901 }
3902
3903 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003904 * Sets the name of the profile. In the device owner case it sets the name of the user which it
3905 * is called from. Only a profile owner or device owner can call this. If this is never called
3906 * by the profile or device owner, the name will be set to default values.
Jessica Hummel1333ea12014-06-23 11:20:10 +01003907 *
3908 * @see #isProfileOwnerApp
3909 * @see #isDeviceOwnerApp
Robin Lee25e26452015-06-02 09:56:29 -07003910 * @param admin Which {@link DeviceAdminReceiver} this request is associate with.
Jessica Hummel1333ea12014-06-23 11:20:10 +01003911 * @param profileName The name of the profile.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07003912 * @throws SecurityException if {@code admin} is not a device or profile owner.
Jessica Hummel1333ea12014-06-23 11:20:10 +01003913 */
Robin Lee25e26452015-06-02 09:56:29 -07003914 public void setProfileName(@NonNull ComponentName admin, String profileName) {
Jessica Hummel1333ea12014-06-23 11:20:10 +01003915 if (mService != null) {
3916 try {
Robin Lee25e26452015-06-02 09:56:29 -07003917 mService.setProfileName(admin, profileName);
Fyodor Kupolov78f13142015-05-27 16:52:45 -07003918 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003919 throw e.rethrowFromSystemServer();
Fyodor Kupolov78f13142015-05-27 16:52:45 -07003920 }
Jessica Hummel1333ea12014-06-23 11:20:10 +01003921 }
3922 }
Jessica Hummel1333ea12014-06-23 11:20:10 +01003923
3924 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07003925 * Used to determine if a particular package is registered as the profile owner for the
Makoto Onuki32b30572015-12-11 14:29:51 -08003926 * user. A profile owner is a special device admin that has additional privileges
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07003927 * within the profile.
Adam Connors776c5552014-01-09 10:42:56 +00003928 *
3929 * @param packageName The package name of the app to compare with the registered profile owner.
3930 * @return Whether or not the package is registered as the profile owner.
3931 */
3932 public boolean isProfileOwnerApp(String packageName) {
3933 if (mService != null) {
3934 try {
Makoto Onuki90b89652016-01-28 14:44:18 -08003935 ComponentName profileOwner = mService.getProfileOwner(myUserId());
Nicolas Prevot90af6d72014-07-30 14:19:12 +01003936 return profileOwner != null
3937 && profileOwner.getPackageName().equals(packageName);
Adam Connors776c5552014-01-09 10:42:56 +00003938 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003939 throw re.rethrowFromSystemServer();
Adam Connors776c5552014-01-09 10:42:56 +00003940 }
3941 }
3942 return false;
3943 }
3944
3945 /**
3946 * @hide
Robin Lee25e26452015-06-02 09:56:29 -07003947 * @return the packageName of the owner of the given user profile or {@code null} if no profile
Adam Connors776c5552014-01-09 10:42:56 +00003948 * owner has been set for that user.
3949 * @throws IllegalArgumentException if the userId is invalid.
3950 */
Nicolas Prevot465acf32014-08-06 17:03:25 +01003951 @SystemApi
Amith Yamasanibf3a9462014-07-28 14:26:42 -07003952 public ComponentName getProfileOwner() throws IllegalArgumentException {
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01003953 return getProfileOwnerAsUser(Process.myUserHandle().getIdentifier());
3954 }
3955
3956 /**
3957 * @see #getProfileOwner()
3958 * @hide
3959 */
3960 public ComponentName getProfileOwnerAsUser(final int userId) throws IllegalArgumentException {
Adam Connors776c5552014-01-09 10:42:56 +00003961 if (mService != null) {
3962 try {
Zoltan Szatmary-Ban3f1ddf82014-07-02 16:42:05 +01003963 return mService.getProfileOwner(userId);
Adam Connors776c5552014-01-09 10:42:56 +00003964 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003965 throw re.rethrowFromSystemServer();
Adam Connors776c5552014-01-09 10:42:56 +00003966 }
3967 }
3968 return null;
3969 }
3970
3971 /**
3972 * @hide
Robin Lee25e26452015-06-02 09:56:29 -07003973 * @return the human readable name of the organisation associated with this DPM or {@code null}
3974 * if one is not set.
Adam Connors776c5552014-01-09 10:42:56 +00003975 * @throws IllegalArgumentException if the userId is invalid.
3976 */
3977 public String getProfileOwnerName() throws IllegalArgumentException {
3978 if (mService != null) {
3979 try {
3980 return mService.getProfileOwnerName(Process.myUserHandle().getIdentifier());
3981 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07003982 throw re.rethrowFromSystemServer();
Adam Connors776c5552014-01-09 10:42:56 +00003983 }
3984 }
3985 return null;
3986 }
Sander Alewijnsef475ca32014-02-17 15:13:58 +00003987
3988 /**
Amith Yamasani38f836b2014-08-20 14:51:15 -07003989 * @hide
Makoto Onukic8a5a552015-11-19 14:29:12 -08003990 * @param userId The user for whom to fetch the profile owner name, if any.
Amith Yamasani38f836b2014-08-20 14:51:15 -07003991 * @return the human readable name of the organisation associated with this profile owner or
3992 * null if one is not set.
3993 * @throws IllegalArgumentException if the userId is invalid.
3994 */
3995 @SystemApi
Selim Cinek24ac55e2014-08-27 12:51:45 +02003996 public String getProfileOwnerNameAsUser(int userId) throws IllegalArgumentException {
Amith Yamasani38f836b2014-08-20 14:51:15 -07003997 if (mService != null) {
3998 try {
Selim Cinek24ac55e2014-08-27 12:51:45 +02003999 return mService.getProfileOwnerName(userId);
Amith Yamasani38f836b2014-08-20 14:51:15 -07004000 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004001 throw re.rethrowFromSystemServer();
Amith Yamasani38f836b2014-08-20 14:51:15 -07004002 }
4003 }
4004 return null;
4005 }
4006
4007 /**
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004008 * Called by a profile owner or device owner to add a default intent handler activity for
4009 * intents that match a certain intent filter. This activity will remain the default intent
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004010 * handler even if the set of potential event handlers for the intent filter changes and if the
4011 * intent preferences are reset.
4012 * <p>
4013 * The default disambiguation mechanism takes over if the activity is not installed (anymore).
4014 * When the activity is (re)installed, it is automatically reset as default intent handler for
4015 * the filter.
4016 * <p>
4017 * The calling device admin must be a profile owner or device owner. If it is not, a security
4018 * exception will be thrown.
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004019 *
4020 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4021 * @param filter The IntentFilter for which a default handler is added.
4022 * @param activity The Activity that is added as default intent handler.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004023 * @throws SecurityException if {@code admin} is not a device or profile owner.
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004024 */
Robin Lee25e26452015-06-02 09:56:29 -07004025 public void addPersistentPreferredActivity(@NonNull ComponentName admin, IntentFilter filter,
4026 @NonNull ComponentName activity) {
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004027 if (mService != null) {
4028 try {
4029 mService.addPersistentPreferredActivity(admin, filter, activity);
4030 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004031 throw e.rethrowFromSystemServer();
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004032 }
4033 }
4034 }
4035
4036 /**
4037 * Called by a profile owner or device owner to remove all persistent intent handler preferences
Torne (Richard Coles)875e2102014-02-24 14:11:56 +00004038 * associated with the given package that were set by {@link #addPersistentPreferredActivity}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004039 * <p>
4040 * The calling device admin must be a profile owner. If it is not, a security exception will be
4041 * thrown.
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004042 *
4043 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4044 * @param packageName The name of the package for which preferences are removed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004045 * @throws SecurityException if {@code admin} is not a device or profile owner.
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004046 */
Robin Lee25e26452015-06-02 09:56:29 -07004047 public void clearPackagePersistentPreferredActivities(@NonNull ComponentName admin,
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004048 String packageName) {
4049 if (mService != null) {
4050 try {
4051 mService.clearPackagePersistentPreferredActivities(admin, packageName);
4052 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004053 throw e.rethrowFromSystemServer();
Sander Alewijnsef475ca32014-02-17 15:13:58 +00004054 }
4055 }
4056 }
Robin Lee66e5d962014-04-09 16:44:21 +01004057
4058 /**
Esteban Talaverabf60f722015-12-10 16:26:44 +00004059 * Called by a profile owner or device owner to grant permission to a package to manage
4060 * application restrictions for the calling user via {@link #setApplicationRestrictions} and
4061 * {@link #getApplicationRestrictions}.
4062 * <p>
4063 * This permission is persistent until it is later cleared by calling this method with a
4064 * {@code null} value or uninstalling the managing package.
Rubin Xuf03d0a62016-02-10 14:54:15 +00004065 * <p>
4066 * The supplied application restriction managing package must be installed when calling this
Victor Changcd14c0a2016-03-16 19:10:15 +00004067 * API, otherwise an {@link NameNotFoundException} will be thrown.
Esteban Talaverabf60f722015-12-10 16:26:44 +00004068 *
4069 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4070 * @param packageName The package name which will be given access to application restrictions
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004071 * APIs. If {@code null} is given the current package will be cleared.
4072 * @throws SecurityException if {@code admin} is not a device or profile owner.
Victor Changcd14c0a2016-03-16 19:10:15 +00004073 * @throws NameNotFoundException if {@code packageName} is not found
Esteban Talaverabf60f722015-12-10 16:26:44 +00004074 */
4075 public void setApplicationRestrictionsManagingPackage(@NonNull ComponentName admin,
Victor Changcd14c0a2016-03-16 19:10:15 +00004076 @Nullable String packageName) throws NameNotFoundException {
Esteban Talaverabf60f722015-12-10 16:26:44 +00004077 if (mService != null) {
4078 try {
Victor Changcd14c0a2016-03-16 19:10:15 +00004079 if (!mService.setApplicationRestrictionsManagingPackage(admin, packageName)) {
4080 throw new NameNotFoundException(packageName);
4081 }
Esteban Talaverabf60f722015-12-10 16:26:44 +00004082 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004083 throw e.rethrowFromSystemServer();
Esteban Talaverabf60f722015-12-10 16:26:44 +00004084 }
4085 }
4086 }
4087
4088 /**
4089 * Called by a profile owner or device owner to retrieve the application restrictions managing
4090 * package for the current user, or {@code null} if none is set.
4091 *
4092 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4093 * @return The package name allowed to manage application restrictions on the current user, or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004094 * {@code null} if none is set.
4095 * @throws SecurityException if {@code admin} is not a device or profile owner.
Esteban Talaverabf60f722015-12-10 16:26:44 +00004096 */
4097 public String getApplicationRestrictionsManagingPackage(@NonNull ComponentName admin) {
4098 if (mService != null) {
4099 try {
4100 return mService.getApplicationRestrictionsManagingPackage(admin);
4101 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004102 throw e.rethrowFromSystemServer();
Esteban Talaverabf60f722015-12-10 16:26:44 +00004103 }
4104 }
4105 return null;
4106 }
4107
4108 /**
Esteban Talavera96895ca2016-03-16 12:00:40 +00004109 * Called by any application to find out whether it has been granted permission via
4110 * {@link #setApplicationRestrictionsManagingPackage} to manage application restrictions
4111 * for the calling user.
4112 *
4113 * <p>This is done by comparing the calling Linux uid with the uid of the package specified by
4114 * that method.
Esteban Talaverabf60f722015-12-10 16:26:44 +00004115 */
4116 public boolean isCallerApplicationRestrictionsManagingPackage() {
4117 if (mService != null) {
4118 try {
4119 return mService.isCallerApplicationRestrictionsManagingPackage();
4120 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004121 throw e.rethrowFromSystemServer();
Esteban Talaverabf60f722015-12-10 16:26:44 +00004122 }
4123 }
4124 return false;
4125 }
4126
4127 /**
4128 * Sets the application restrictions for a given target application running in the calling user.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004129 * <p>
4130 * The caller must be a profile or device owner on that user, or the package allowed to manage
4131 * application restrictions via {@link #setApplicationRestrictionsManagingPackage}; otherwise a
4132 * security exception will be thrown.
4133 * <p>
4134 * The provided {@link Bundle} consists of key-value pairs, where the types of values may be:
Esteban Talavera6b8e0642015-08-10 17:26:04 +01004135 * <ul>
4136 * <li>{@code boolean}
4137 * <li>{@code int}
4138 * <li>{@code String} or {@code String[]}
4139 * <li>From {@link android.os.Build.VERSION_CODES#M}, {@code Bundle} or {@code Bundle[]}
4140 * </ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004141 * <p>
4142 * If the restrictions are not available yet, but may be applied in the near future, the caller
4143 * can notify the target application of that by adding
Sander Alewijnse53d63dc2014-11-07 21:43:00 +00004144 * {@link UserManager#KEY_RESTRICTIONS_PENDING} to the settings parameter.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004145 * <p>
4146 * The application restrictions are only made visible to the target application via
4147 * {@link UserManager#getApplicationRestrictions(String)}, in addition to the profile or device
4148 * owner, and the application restrictions managing package via
Esteban Talaverabf60f722015-12-10 16:26:44 +00004149 * {@link #getApplicationRestrictions}.
Robin Lee66e5d962014-04-09 16:44:21 +01004150 *
Esteban Talaverabf60f722015-12-10 16:26:44 +00004151 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004152 * {@code null} if called by the application restrictions managing package.
Robin Lee66e5d962014-04-09 16:44:21 +01004153 * @param packageName The name of the package to update restricted settings for.
4154 * @param settings A {@link Bundle} to be parsed by the receiving application, conveying a new
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004155 * set of active restrictions.
4156 * @throws SecurityException if {@code admin} is not a device or profile owner.
Esteban Talaverabf60f722015-12-10 16:26:44 +00004157 * @see #setApplicationRestrictionsManagingPackage
Sander Alewijnse53d63dc2014-11-07 21:43:00 +00004158 * @see UserManager#KEY_RESTRICTIONS_PENDING
Robin Lee66e5d962014-04-09 16:44:21 +01004159 */
Esteban Talaverabf60f722015-12-10 16:26:44 +00004160 public void setApplicationRestrictions(@Nullable ComponentName admin, String packageName,
Robin Lee66e5d962014-04-09 16:44:21 +01004161 Bundle settings) {
4162 if (mService != null) {
4163 try {
4164 mService.setApplicationRestrictions(admin, packageName, settings);
4165 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004166 throw e.rethrowFromSystemServer();
Robin Lee66e5d962014-04-09 16:44:21 +01004167 }
4168 }
4169 }
4170
4171 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004172 * Sets a list of configuration features to enable for a TrustAgent component. This is meant to
4173 * be used in conjunction with {@link #KEYGUARD_DISABLE_TRUST_AGENTS}, which disables all trust
4174 * agents but those enabled by this function call. If flag
Jim Millere303bf42014-08-26 17:12:29 -07004175 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} is not set, then this call has no effect.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004176 * <p>
4177 * The calling device admin must have requested
4178 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES} to be able to call this method;
4179 * if not, a security exception will be thrown.
Tony Mak089d8402016-04-05 17:42:55 +01004180 * <p>
4181 * This method can be called on the {@link DevicePolicyManager} instance returned by
4182 * {@link #getParentProfileInstance(ComponentName)} in order to set the configuration for
4183 * the parent profile.
Jim Miller604e7552014-07-18 19:00:02 -07004184 *
4185 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Jim Millere303bf42014-08-26 17:12:29 -07004186 * @param target Component name of the agent to be enabled.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004187 * @param configuration TrustAgent-specific feature bundle. If null for any admin, agent will be
4188 * strictly disabled according to the state of the
4189 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} flag.
4190 * <p>
4191 * If {@link #KEYGUARD_DISABLE_TRUST_AGENTS} is set and options is not null for all
4192 * admins, then it's up to the TrustAgent itself to aggregate the values from all
4193 * device admins.
4194 * <p>
4195 * Consult documentation for the specific TrustAgent to determine legal options
4196 * parameters.
4197 * @throws SecurityException if {@code admin} is not an active administrator or does not use
4198 * {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES}
Jim Miller604e7552014-07-18 19:00:02 -07004199 */
Robin Lee25e26452015-06-02 09:56:29 -07004200 public void setTrustAgentConfiguration(@NonNull ComponentName admin,
4201 @NonNull ComponentName target, PersistableBundle configuration) {
Jim Miller604e7552014-07-18 19:00:02 -07004202 if (mService != null) {
4203 try {
Tony Mak089d8402016-04-05 17:42:55 +01004204 mService.setTrustAgentConfiguration(admin, target, configuration, mParentInstance);
Jim Miller604e7552014-07-18 19:00:02 -07004205 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004206 throw e.rethrowFromSystemServer();
Jim Miller604e7552014-07-18 19:00:02 -07004207 }
4208 }
4209 }
4210
4211 /**
Jim Millere303bf42014-08-26 17:12:29 -07004212 * Gets configuration for the given trust agent based on aggregating all calls to
4213 * {@link #setTrustAgentConfiguration(ComponentName, ComponentName, PersistableBundle)} for
4214 * all device admins.
Tony Mak089d8402016-04-05 17:42:55 +01004215 * <p>
4216 * This method can be called on the {@link DevicePolicyManager} instance returned by
4217 * {@link #getParentProfileInstance(ComponentName)} in order to retrieve the configuration set
4218 * on the parent profile.
Jim Miller604e7552014-07-18 19:00:02 -07004219 *
Jim Millerb5db57a2015-01-14 18:17:19 -08004220 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. If null,
4221 * this function returns a list of configurations for all admins that declare
4222 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS}. If any admin declares
4223 * {@link #KEYGUARD_DISABLE_TRUST_AGENTS} but doesn't call
4224 * {@link #setTrustAgentConfiguration(ComponentName, ComponentName, PersistableBundle)}
4225 * for this {@param agent} or calls it with a null configuration, null is returned.
Jim Miller604e7552014-07-18 19:00:02 -07004226 * @param agent Which component to get enabled features for.
Jim Millere303bf42014-08-26 17:12:29 -07004227 * @return configuration for the given trust agent.
Jim Miller604e7552014-07-18 19:00:02 -07004228 */
Robin Lee25e26452015-06-02 09:56:29 -07004229 public List<PersistableBundle> getTrustAgentConfiguration(@Nullable ComponentName admin,
4230 @NonNull ComponentName agent) {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07004231 return getTrustAgentConfiguration(admin, agent, myUserId());
Jim Millere303bf42014-08-26 17:12:29 -07004232 }
4233
4234 /** @hide per-user version */
Robin Lee25e26452015-06-02 09:56:29 -07004235 public List<PersistableBundle> getTrustAgentConfiguration(@Nullable ComponentName admin,
4236 @NonNull ComponentName agent, int userHandle) {
Jim Miller604e7552014-07-18 19:00:02 -07004237 if (mService != null) {
4238 try {
Tony Mak089d8402016-04-05 17:42:55 +01004239 return mService.getTrustAgentConfiguration(admin, agent, userHandle,
4240 mParentInstance);
Jim Miller604e7552014-07-18 19:00:02 -07004241 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004242 throw e.rethrowFromSystemServer();
Jim Miller604e7552014-07-18 19:00:02 -07004243 }
4244 }
Jim Millere303bf42014-08-26 17:12:29 -07004245 return new ArrayList<PersistableBundle>(); // empty list
Jim Miller604e7552014-07-18 19:00:02 -07004246 }
4247
4248 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004249 * Called by a profile owner of a managed profile to set whether caller-Id information from the
4250 * managed profile will be shown in the parent profile, for incoming calls.
4251 * <p>
4252 * The calling device admin must be a profile owner. If it is not, a security exception will be
4253 * thrown.
Adam Connors210fe212014-07-17 15:41:43 +01004254 *
Robin Lee25e26452015-06-02 09:56:29 -07004255 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Adam Connors210fe212014-07-17 15:41:43 +01004256 * @param disabled If true caller-Id information in the managed profile is not displayed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004257 * @throws SecurityException if {@code admin} is not a device or profile owner.
Adam Connors210fe212014-07-17 15:41:43 +01004258 */
Robin Lee25e26452015-06-02 09:56:29 -07004259 public void setCrossProfileCallerIdDisabled(@NonNull ComponentName admin, boolean disabled) {
Adam Connors210fe212014-07-17 15:41:43 +01004260 if (mService != null) {
4261 try {
Robin Lee25e26452015-06-02 09:56:29 -07004262 mService.setCrossProfileCallerIdDisabled(admin, disabled);
Adam Connors210fe212014-07-17 15:41:43 +01004263 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004264 throw e.rethrowFromSystemServer();
Adam Connors210fe212014-07-17 15:41:43 +01004265 }
4266 }
4267 }
4268
4269 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07004270 * Called by a profile owner of a managed profile to determine whether or not caller-Id
4271 * information has been disabled.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004272 * <p>
4273 * The calling device admin must be a profile owner. If it is not, a security exception will be
4274 * thrown.
Adam Connors210fe212014-07-17 15:41:43 +01004275 *
Robin Lee25e26452015-06-02 09:56:29 -07004276 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004277 * @throws SecurityException if {@code admin} is not a device or profile owner.
Adam Connors210fe212014-07-17 15:41:43 +01004278 */
Robin Lee25e26452015-06-02 09:56:29 -07004279 public boolean getCrossProfileCallerIdDisabled(@NonNull ComponentName admin) {
Adam Connors210fe212014-07-17 15:41:43 +01004280 if (mService != null) {
4281 try {
Robin Lee25e26452015-06-02 09:56:29 -07004282 return mService.getCrossProfileCallerIdDisabled(admin);
Adam Connors210fe212014-07-17 15:41:43 +01004283 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004284 throw e.rethrowFromSystemServer();
Adam Connors210fe212014-07-17 15:41:43 +01004285 }
4286 }
4287 return false;
4288 }
4289
4290 /**
Amith Yamasani570002f2014-07-18 15:48:54 -07004291 * Determine whether or not caller-Id information has been disabled.
4292 *
4293 * @param userHandle The user for whom to check the caller-id permission
4294 * @hide
4295 */
4296 public boolean getCrossProfileCallerIdDisabled(UserHandle userHandle) {
4297 if (mService != null) {
4298 try {
4299 return mService.getCrossProfileCallerIdDisabledForUser(userHandle.getIdentifier());
4300 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004301 throw e.rethrowFromSystemServer();
Amith Yamasani570002f2014-07-18 15:48:54 -07004302 }
4303 }
4304 return false;
4305 }
4306
4307 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004308 * Called by a profile owner of a managed profile to set whether contacts search from the
4309 * managed profile will be shown in the parent profile, for incoming calls.
4310 * <p>
4311 * The calling device admin must be a profile owner. If it is not, a security exception will be
4312 * thrown.
Victor Chang1060c6182016-01-04 20:16:23 +00004313 *
4314 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4315 * @param disabled If true contacts search in the managed profile is not displayed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004316 * @throws SecurityException if {@code admin} is not a device or profile owner.
Victor Chang1060c6182016-01-04 20:16:23 +00004317 */
4318 public void setCrossProfileContactsSearchDisabled(@NonNull ComponentName admin,
4319 boolean disabled) {
4320 if (mService != null) {
4321 try {
4322 mService.setCrossProfileContactsSearchDisabled(admin, disabled);
4323 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004324 throw e.rethrowFromSystemServer();
Victor Chang1060c6182016-01-04 20:16:23 +00004325 }
4326 }
4327 }
4328
4329 /**
4330 * Called by a profile owner of a managed profile to determine whether or not contacts search
4331 * has been disabled.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004332 * <p>
4333 * The calling device admin must be a profile owner. If it is not, a security exception will be
4334 * thrown.
Victor Chang1060c6182016-01-04 20:16:23 +00004335 *
4336 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004337 * @throws SecurityException if {@code admin} is not a device or profile owner.
Victor Chang1060c6182016-01-04 20:16:23 +00004338 */
4339 public boolean getCrossProfileContactsSearchDisabled(@NonNull ComponentName admin) {
4340 if (mService != null) {
4341 try {
4342 return mService.getCrossProfileContactsSearchDisabled(admin);
4343 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004344 throw e.rethrowFromSystemServer();
Victor Chang1060c6182016-01-04 20:16:23 +00004345 }
4346 }
4347 return false;
4348 }
4349
4350
4351 /**
4352 * Determine whether or not contacts search has been disabled.
4353 *
4354 * @param userHandle The user for whom to check the contacts search permission
4355 * @hide
4356 */
4357 public boolean getCrossProfileContactsSearchDisabled(@NonNull UserHandle userHandle) {
4358 if (mService != null) {
4359 try {
4360 return mService
4361 .getCrossProfileContactsSearchDisabledForUser(userHandle.getIdentifier());
4362 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004363 throw e.rethrowFromSystemServer();
Victor Chang1060c6182016-01-04 20:16:23 +00004364 }
4365 }
4366 return false;
4367 }
4368
4369 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08004370 * Start Quick Contact on the managed profile for the user, if the policy allows.
Victor Chang97bdacc2016-01-21 22:24:11 +00004371 *
Makoto Onuki1040da12015-03-19 11:24:00 -07004372 * @hide
4373 */
4374 public void startManagedQuickContact(String actualLookupKey, long actualContactId,
Victor Chang97bdacc2016-01-21 22:24:11 +00004375 boolean isContactIdIgnored, long directoryId, Intent originalIntent) {
Makoto Onuki1040da12015-03-19 11:24:00 -07004376 if (mService != null) {
4377 try {
Victor Chang97bdacc2016-01-21 22:24:11 +00004378 mService.startManagedQuickContact(actualLookupKey, actualContactId,
4379 isContactIdIgnored, directoryId, originalIntent);
Makoto Onuki1040da12015-03-19 11:24:00 -07004380 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004381 throw e.rethrowFromSystemServer();
Makoto Onuki1040da12015-03-19 11:24:00 -07004382 }
4383 }
4384 }
4385
4386 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08004387 * Start Quick Contact on the managed profile for the user, if the policy allows.
Ricky Wai494b95d2015-11-20 16:07:15 +00004388 * @hide
4389 */
4390 public void startManagedQuickContact(String actualLookupKey, long actualContactId,
4391 Intent originalIntent) {
Victor Chang97bdacc2016-01-21 22:24:11 +00004392 startManagedQuickContact(actualLookupKey, actualContactId, false, Directory.DEFAULT,
Ricky Wai494b95d2015-11-20 16:07:15 +00004393 originalIntent);
4394 }
4395
4396 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004397 * Called by a profile owner of a managed profile to set whether bluetooth devices can access
4398 * enterprise contacts.
Ricky Wai778ba132015-03-31 14:21:22 +01004399 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004400 * The calling device admin must be a profile owner. If it is not, a security exception will be
4401 * thrown.
Ricky Wai778ba132015-03-31 14:21:22 +01004402 * <p>
4403 * This API works on managed profile only.
4404 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004405 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4406 * @param disabled If true, bluetooth devices cannot access enterprise contacts.
4407 * @throws SecurityException if {@code admin} is not a device or profile owner.
Ricky Wai778ba132015-03-31 14:21:22 +01004408 */
Robin Lee25e26452015-06-02 09:56:29 -07004409 public void setBluetoothContactSharingDisabled(@NonNull ComponentName admin, boolean disabled) {
Ricky Wai778ba132015-03-31 14:21:22 +01004410 if (mService != null) {
4411 try {
Robin Lee25e26452015-06-02 09:56:29 -07004412 mService.setBluetoothContactSharingDisabled(admin, disabled);
Ricky Wai778ba132015-03-31 14:21:22 +01004413 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004414 throw e.rethrowFromSystemServer();
Ricky Wai778ba132015-03-31 14:21:22 +01004415 }
4416 }
4417 }
4418
4419 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004420 * Called by a profile owner of a managed profile to determine whether or not Bluetooth devices
4421 * cannot access enterprise contacts.
Ricky Wai778ba132015-03-31 14:21:22 +01004422 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004423 * The calling device admin must be a profile owner. If it is not, a security exception will be
4424 * thrown.
Ricky Wai778ba132015-03-31 14:21:22 +01004425 * <p>
4426 * This API works on managed profile only.
4427 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004428 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4429 * @throws SecurityException if {@code admin} is not a device or profile owner.
Ricky Wai778ba132015-03-31 14:21:22 +01004430 */
Robin Lee25e26452015-06-02 09:56:29 -07004431 public boolean getBluetoothContactSharingDisabled(@NonNull ComponentName admin) {
Ricky Wai778ba132015-03-31 14:21:22 +01004432 if (mService != null) {
4433 try {
Robin Lee25e26452015-06-02 09:56:29 -07004434 return mService.getBluetoothContactSharingDisabled(admin);
Ricky Wai778ba132015-03-31 14:21:22 +01004435 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004436 throw e.rethrowFromSystemServer();
Ricky Wai778ba132015-03-31 14:21:22 +01004437 }
4438 }
4439 return true;
4440 }
4441
4442 /**
4443 * Determine whether or not Bluetooth devices cannot access contacts.
4444 * <p>
4445 * This API works on managed profile UserHandle only.
4446 *
4447 * @param userHandle The user for whom to check the caller-id permission
4448 * @hide
4449 */
4450 public boolean getBluetoothContactSharingDisabled(UserHandle userHandle) {
4451 if (mService != null) {
4452 try {
4453 return mService.getBluetoothContactSharingDisabledForUser(userHandle
4454 .getIdentifier());
4455 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004456 throw e.rethrowFromSystemServer();
Ricky Wai778ba132015-03-31 14:21:22 +01004457 }
4458 }
4459 return true;
4460 }
4461
4462 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07004463 * Called by the profile owner of a managed profile so that some intents sent in the managed
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004464 * profile can also be resolved in the parent, or vice versa. Only activity intents are
4465 * supported.
Nicolas Prevotfc7b4442014-12-17 15:28:29 +00004466 *
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004467 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Nicolas Prevot81948992014-05-16 18:25:26 +01004468 * @param filter The {@link IntentFilter} the intent has to match to be also resolved in the
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004469 * other profile
Nicolas Prevot41d926e2014-06-09 11:48:56 +01004470 * @param flags {@link DevicePolicyManager#FLAG_MANAGED_CAN_ACCESS_PARENT} and
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004471 * {@link DevicePolicyManager#FLAG_PARENT_CAN_ACCESS_MANAGED} are supported.
4472 * @throws SecurityException if {@code admin} is not a device or profile owner.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004473 */
Robin Lee25e26452015-06-02 09:56:29 -07004474 public void addCrossProfileIntentFilter(@NonNull ComponentName admin, IntentFilter filter, int flags) {
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004475 if (mService != null) {
4476 try {
Nicolas Prevot81948992014-05-16 18:25:26 +01004477 mService.addCrossProfileIntentFilter(admin, filter, flags);
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004478 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004479 throw e.rethrowFromSystemServer();
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004480 }
4481 }
4482 }
4483
4484 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07004485 * Called by a profile owner of a managed profile to remove the cross-profile intent filters
4486 * that go from the managed profile to the parent, or from the parent to the managed profile.
Nicolas Prevot3f7777f2014-07-24 15:58:39 +01004487 * Only removes those that have been set by the profile owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004488 *
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004489 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004490 * @throws SecurityException if {@code admin} is not a device or profile owner.
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004491 */
Robin Lee25e26452015-06-02 09:56:29 -07004492 public void clearCrossProfileIntentFilters(@NonNull ComponentName admin) {
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004493 if (mService != null) {
4494 try {
Nicolas Prevot81948992014-05-16 18:25:26 +01004495 mService.clearCrossProfileIntentFilters(admin);
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004496 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004497 throw e.rethrowFromSystemServer();
Nicolas Prevot10fa67c2014-03-24 13:44:38 +00004498 }
4499 }
4500 }
4501
4502 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004503 * Called by a profile or device owner to set the permitted accessibility services. When set by
4504 * a device owner or profile owner the restriction applies to all profiles of the user the
4505 * device owner or profile owner is an admin for. By default the user can use any accessiblity
4506 * service. When zero or more packages have been added, accessiblity services that are not in
4507 * the list and not part of the system can not be enabled by the user.
4508 * <p>
4509 * Calling with a null value for the list disables the restriction so that all services can be
4510 * used, calling with an empty list only allows the builtin system's services.
4511 * <p>
4512 * System accesibility services are always available to the user the list can't modify this.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004513 *
4514 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4515 * @param packageNames List of accessibility service package names.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004516 * @return true if setting the restriction succeeded. It fail if there is one or more non-system
4517 * accessibility services enabled, that are not in the list.
4518 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004519 */
Robin Lee25e26452015-06-02 09:56:29 -07004520 public boolean setPermittedAccessibilityServices(@NonNull ComponentName admin,
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004521 List<String> packageNames) {
4522 if (mService != null) {
4523 try {
4524 return mService.setPermittedAccessibilityServices(admin, packageNames);
4525 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004526 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004527 }
4528 }
4529 return false;
4530 }
4531
4532 /**
4533 * Returns the list of permitted accessibility services set by this device or profile owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004534 * <p>
4535 * An empty list means no accessibility services except system services are allowed. Null means
4536 * all accessibility services are allowed.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004537 *
4538 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4539 * @return List of accessiblity service package names.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004540 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004541 */
Robin Lee25e26452015-06-02 09:56:29 -07004542 public List<String> getPermittedAccessibilityServices(@NonNull ComponentName admin) {
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004543 if (mService != null) {
4544 try {
4545 return mService.getPermittedAccessibilityServices(admin);
4546 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004547 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004548 }
4549 }
4550 return null;
4551 }
4552
4553 /**
Sudheer Shanka56925862016-01-28 19:43:59 +00004554 * Called by the system to check if a specific accessibility service is disabled by admin.
4555 *
4556 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4557 * @param packageName Accessibility service package name that needs to be checked.
4558 * @param userHandle user id the admin is running as.
4559 * @return true if the accessibility service is permitted, otherwise false.
4560 *
4561 * @hide
4562 */
4563 public boolean isAccessibilityServicePermittedByAdmin(@NonNull ComponentName admin,
4564 @NonNull String packageName, int userHandle) {
4565 if (mService != null) {
4566 try {
4567 return mService.isAccessibilityServicePermittedByAdmin(admin, packageName,
4568 userHandle);
4569 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004570 throw e.rethrowFromSystemServer();
Sudheer Shanka56925862016-01-28 19:43:59 +00004571 }
4572 }
4573 return false;
4574 }
4575
4576 /**
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004577 * Returns the list of accessibility services permitted by the device or profiles
4578 * owners of this user.
4579 *
4580 * <p>Null means all accessibility services are allowed, if a non-null list is returned
4581 * it will contain the intersection of the permitted lists for any device or profile
4582 * owners that apply to this user. It will also include any system accessibility services.
4583 *
4584 * @param userId which user to check for.
4585 * @return List of accessiblity service package names.
4586 * @hide
4587 */
4588 @SystemApi
4589 public List<String> getPermittedAccessibilityServices(int userId) {
4590 if (mService != null) {
4591 try {
4592 return mService.getPermittedAccessibilityServicesForUser(userId);
4593 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004594 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004595 }
4596 }
4597 return null;
4598 }
4599
4600 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004601 * Called by a profile or device owner to set the permitted input methods services. When set by
4602 * a device owner or profile owner the restriction applies to all profiles of the user the
4603 * device owner or profile owner is an admin for. By default the user can use any input method.
4604 * When zero or more packages have been added, input method that are not in the list and not
4605 * part of the system can not be enabled by the user. This method will fail if it is called for
4606 * a admin that is not for the foreground user or a profile of the foreground user.
4607 * <p>
4608 * Calling with a null value for the list disables the restriction so that all input methods can
4609 * be used, calling with an empty list disables all but the system's own input methods.
4610 * <p>
4611 * System input methods are always available to the user this method can't modify this.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004612 *
4613 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4614 * @param packageNames List of input method package names.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004615 * @return true if setting the restriction succeeded. It will fail if there are one or more
4616 * non-system input methods currently enabled that are not in the packageNames list.
4617 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004618 */
Robin Lee25e26452015-06-02 09:56:29 -07004619 public boolean setPermittedInputMethods(@NonNull ComponentName admin, List<String> packageNames) {
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004620 if (mService != null) {
4621 try {
4622 return mService.setPermittedInputMethods(admin, packageNames);
4623 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004624 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004625 }
4626 }
4627 return false;
4628 }
4629
4630
4631 /**
4632 * Returns the list of permitted input methods set by this device or profile owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004633 * <p>
4634 * An empty list means no input methods except system input methods are allowed. Null means all
4635 * input methods are allowed.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004636 *
4637 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4638 * @return List of input method package names.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004639 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004640 */
Robin Lee25e26452015-06-02 09:56:29 -07004641 public List<String> getPermittedInputMethods(@NonNull ComponentName admin) {
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004642 if (mService != null) {
4643 try {
4644 return mService.getPermittedInputMethods(admin);
4645 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004646 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004647 }
4648 }
4649 return null;
4650 }
4651
4652 /**
Sudheer Shanka56925862016-01-28 19:43:59 +00004653 * Called by the system to check if a specific input method is disabled by admin.
4654 *
4655 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4656 * @param packageName Input method package name that needs to be checked.
4657 * @param userHandle user id the admin is running as.
4658 * @return true if the input method is permitted, otherwise false.
4659 *
4660 * @hide
4661 */
4662 public boolean isInputMethodPermittedByAdmin(@NonNull ComponentName admin,
4663 @NonNull String packageName, int userHandle) {
4664 if (mService != null) {
4665 try {
4666 return mService.isInputMethodPermittedByAdmin(admin, packageName, userHandle);
4667 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004668 throw e.rethrowFromSystemServer();
Sudheer Shanka56925862016-01-28 19:43:59 +00004669 }
4670 }
4671 return false;
4672 }
4673
4674 /**
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004675 * Returns the list of input methods permitted by the device or profiles
Makoto Onuki32b30572015-12-11 14:29:51 -08004676 * owners of the current user. (*Not* calling user, due to a limitation in InputMethodManager.)
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004677 *
4678 * <p>Null means all input methods are allowed, if a non-null list is returned
4679 * it will contain the intersection of the permitted lists for any device or profile
4680 * owners that apply to this user. It will also include any system input methods.
4681 *
4682 * @return List of input method package names.
4683 * @hide
4684 */
4685 @SystemApi
4686 public List<String> getPermittedInputMethodsForCurrentUser() {
4687 if (mService != null) {
4688 try {
4689 return mService.getPermittedInputMethodsForCurrentUser();
4690 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004691 throw e.rethrowFromSystemServer();
Kenny Guyfa80a4f2014-08-20 19:40:59 +01004692 }
4693 }
4694 return null;
4695 }
4696
4697 /**
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08004698 * Called by a device owner to get the list of apps to keep around as APKs even if no user has
4699 * currently installed it.
4700 *
4701 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4702 *
4703 * @return List of package names to keep cached.
4704 * @hide
4705 */
4706 public List<String> getKeepUninstalledPackages(@NonNull ComponentName admin) {
4707 if (mService != null) {
4708 try {
4709 return mService.getKeepUninstalledPackages(admin);
4710 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004711 throw e.rethrowFromSystemServer();
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08004712 }
4713 }
4714 return null;
4715 }
4716
4717 /**
4718 * Called by a device owner to set a list of apps to keep around as APKs even if no user has
4719 * currently installed it.
4720 *
4721 * <p>Please note that setting this policy does not imply that specified apps will be
4722 * automatically pre-cached.</p>
4723 *
4724 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4725 * @param packageNames List of package names to keep cached.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004726 * @throws SecurityException if {@code admin} is not a device owner.
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08004727 * @hide
4728 */
4729 public void setKeepUninstalledPackages(@NonNull ComponentName admin,
4730 @NonNull List<String> packageNames) {
4731 if (mService != null) {
4732 try {
4733 mService.setKeepUninstalledPackages(admin, packageNames);
4734 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004735 throw e.rethrowFromSystemServer();
Fyodor Kupolovcb6fd802015-11-05 14:27:06 -08004736 }
4737 }
4738 }
4739
4740 /**
Julia Reynolds1e958392014-05-16 14:25:21 -04004741 * Called by a device owner to create a user with the specified name. The UserHandle returned
4742 * by this method should not be persisted as user handles are recycled as users are removed and
4743 * created. If you need to persist an identifier for this user, use
4744 * {@link UserManager#getSerialNumberForUser}.
4745 *
4746 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4747 * @param name the user's name
4748 * @see UserHandle
Robin Lee25e26452015-06-02 09:56:29 -07004749 * @return the {@link android.os.UserHandle} object for the created user, or {@code null} if the
4750 * user could not be created.
Kenny Guy14f48e52015-06-29 15:12:36 +01004751 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07004752 * @deprecated From {@link android.os.Build.VERSION_CODES#M}
phweiss27ee3342016-02-08 16:40:45 +01004753 * @removed From {@link android.os.Build.VERSION_CODES#N}
Julia Reynolds1e958392014-05-16 14:25:21 -04004754 */
Kenny Guy14f48e52015-06-29 15:12:36 +01004755 @Deprecated
Robin Lee25e26452015-06-02 09:56:29 -07004756 public UserHandle createUser(@NonNull ComponentName admin, String name) {
Julia Reynolds1e958392014-05-16 14:25:21 -04004757 return null;
4758 }
4759
4760 /**
Jason Monk03978a42014-06-10 15:05:30 -04004761 * Called by a device owner to create a user with the specified name. The UserHandle returned
4762 * by this method should not be persisted as user handles are recycled as users are removed and
4763 * created. If you need to persist an identifier for this user, use
4764 * {@link UserManager#getSerialNumberForUser}. The new user will be started in the background
4765 * immediately.
4766 *
4767 * <p> profileOwnerComponent is the {@link DeviceAdminReceiver} to be the profile owner as well
4768 * as registered as an active admin on the new user. The profile owner package will be
4769 * installed on the new user if it already is installed on the device.
4770 *
4771 * <p>If the optionalInitializeData is not null, then the extras will be passed to the
4772 * profileOwnerComponent when onEnable is called.
4773 *
4774 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4775 * @param name the user's name
4776 * @param ownerName the human readable name of the organisation associated with this DPM.
4777 * @param profileOwnerComponent The {@link DeviceAdminReceiver} that will be an active admin on
4778 * the user.
4779 * @param adminExtras Extras that will be passed to onEnable of the admin receiver
4780 * on the new user.
4781 * @see UserHandle
Robin Lee25e26452015-06-02 09:56:29 -07004782 * @return the {@link android.os.UserHandle} object for the created user, or {@code null} if the
4783 * user could not be created.
Kenny Guy14f48e52015-06-29 15:12:36 +01004784 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07004785 * @deprecated From {@link android.os.Build.VERSION_CODES#M}
phweiss27ee3342016-02-08 16:40:45 +01004786 * @removed From {@link android.os.Build.VERSION_CODES#N}
Jason Monk03978a42014-06-10 15:05:30 -04004787 */
Kenny Guy14f48e52015-06-29 15:12:36 +01004788 @Deprecated
Robin Lee25e26452015-06-02 09:56:29 -07004789 public UserHandle createAndInitializeUser(@NonNull ComponentName admin, String name,
4790 String ownerName, @NonNull ComponentName profileOwnerComponent, Bundle adminExtras) {
Jason Monk03978a42014-06-10 15:05:30 -04004791 return null;
4792 }
4793
4794 /**
phweissa92e1212016-01-25 17:14:10 +01004795 * Flag used by {@link #createAndManageUser} to skip setup wizard after creating a new user.
phweiss343fb332016-01-25 14:48:59 +01004796 */
4797 public static final int SKIP_SETUP_WIZARD = 0x0001;
4798
4799 /**
Lenka Trochtovac8202c82016-01-26 15:11:09 +01004800 * Flag used by {@link #createAndManageUser} to specify that the user should be created
4801 * ephemeral.
4802 * @hide
4803 */
4804 public static final int MAKE_USER_EPHEMERAL = 0x0002;
4805
4806 /**
phweissa92e1212016-01-25 17:14:10 +01004807 * Called by a device owner to create a user with the specified name and a given component of
4808 * the calling package as profile owner. The UserHandle returned by this method should not be
4809 * persisted as user handles are recycled as users are removed and created. If you need to
4810 * persist an identifier for this user, use {@link UserManager#getSerialNumberForUser}. The new
4811 * user will not be started in the background.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004812 * <p>
4813 * admin is the {@link DeviceAdminReceiver} which is the device owner. profileOwner is also a
4814 * DeviceAdminReceiver in the same package as admin, and will become the profile owner and will
4815 * be registered as an active admin on the new user. The profile owner package will be installed
4816 * on the new user.
4817 * <p>
4818 * If the adminExtras are not null, they will be stored on the device until the user is started
4819 * for the first time. Then the extras will be passed to the admin when onEnable is called.
phweiss343fb332016-01-25 14:48:59 +01004820 *
4821 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4822 * @param name The user's name.
phweissa92e1212016-01-25 17:14:10 +01004823 * @param profileOwner Which {@link DeviceAdminReceiver} will be profile owner. Has to be in the
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004824 * same package as admin, otherwise no user is created and an
4825 * IllegalArgumentException is thrown.
phweiss343fb332016-01-25 14:48:59 +01004826 * @param adminExtras Extras that will be passed to onEnable of the admin receiver on the new
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004827 * user.
phweissa92e1212016-01-25 17:14:10 +01004828 * @param flags {@link #SKIP_SETUP_WIZARD} is supported.
phweiss343fb332016-01-25 14:48:59 +01004829 * @see UserHandle
4830 * @return the {@link android.os.UserHandle} object for the created user, or {@code null} if the
4831 * user could not be created.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004832 * @throws SecurityException if {@code admin} is not a device owner.
phweiss343fb332016-01-25 14:48:59 +01004833 */
4834 public UserHandle createAndManageUser(@NonNull ComponentName admin, @NonNull String name,
phweissa92e1212016-01-25 17:14:10 +01004835 @NonNull ComponentName profileOwner, @Nullable PersistableBundle adminExtras,
4836 int flags) {
phweiss343fb332016-01-25 14:48:59 +01004837 try {
phweissa92e1212016-01-25 17:14:10 +01004838 return mService.createAndManageUser(admin, name, profileOwner, adminExtras, flags);
phweiss343fb332016-01-25 14:48:59 +01004839 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004840 throw re.rethrowFromSystemServer();
phweiss343fb332016-01-25 14:48:59 +01004841 }
phweiss343fb332016-01-25 14:48:59 +01004842 }
4843
4844 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004845 * Called by a device owner to remove a user and all associated data. The primary user can not
4846 * be removed.
Julia Reynolds1e958392014-05-16 14:25:21 -04004847 *
4848 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4849 * @param userHandle the user to remove.
4850 * @return {@code true} if the user was removed, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004851 * @throws SecurityException if {@code admin} is not a device owner.
Julia Reynolds1e958392014-05-16 14:25:21 -04004852 */
Robin Lee25e26452015-06-02 09:56:29 -07004853 public boolean removeUser(@NonNull ComponentName admin, UserHandle userHandle) {
Julia Reynolds1e958392014-05-16 14:25:21 -04004854 try {
4855 return mService.removeUser(admin, userHandle);
4856 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004857 throw re.rethrowFromSystemServer();
Julia Reynolds1e958392014-05-16 14:25:21 -04004858 }
4859 }
4860
4861 /**
Jason Monk582d9112014-07-09 19:57:08 -04004862 * Called by a device owner to switch the specified user to the foreground.
4863 *
4864 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4865 * @param userHandle the user to switch to; null will switch to primary.
4866 * @return {@code true} if the switch was successful, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004867 * @throws SecurityException if {@code admin} is not a device owner.
Jason Monk582d9112014-07-09 19:57:08 -04004868 * @see Intent#ACTION_USER_FOREGROUND
4869 */
Robin Lee25e26452015-06-02 09:56:29 -07004870 public boolean switchUser(@NonNull ComponentName admin, @Nullable UserHandle userHandle) {
Jason Monk582d9112014-07-09 19:57:08 -04004871 try {
4872 return mService.switchUser(admin, userHandle);
4873 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004874 throw re.rethrowFromSystemServer();
Jason Monk582d9112014-07-09 19:57:08 -04004875 }
4876 }
4877
4878 /**
Esteban Talaverabf60f722015-12-10 16:26:44 +00004879 * Retrieves the application restrictions for a given target application running in the calling
4880 * user.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004881 * <p>
4882 * The caller must be a profile or device owner on that user, or the package allowed to manage
4883 * application restrictions via {@link #setApplicationRestrictionsManagingPackage}; otherwise a
4884 * security exception will be thrown.
Robin Lee66e5d962014-04-09 16:44:21 +01004885 *
Esteban Talaverabf60f722015-12-10 16:26:44 +00004886 * @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004887 * {@code null} if called by the application restrictions managing package.
Robin Lee66e5d962014-04-09 16:44:21 +01004888 * @param packageName The name of the package to fetch restricted settings of.
4889 * @return {@link Bundle} of settings corresponding to what was set last time
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004890 * {@link DevicePolicyManager#setApplicationRestrictions} was called, or an empty
4891 * {@link Bundle} if no restrictions have been set.
4892 * @throws SecurityException if {@code admin} is not a device or profile owner.
Esteban Talaverabf60f722015-12-10 16:26:44 +00004893 * @see {@link #setApplicationRestrictionsManagingPackage}
Robin Lee66e5d962014-04-09 16:44:21 +01004894 */
Esteban Talaverabf60f722015-12-10 16:26:44 +00004895 public Bundle getApplicationRestrictions(@Nullable ComponentName admin, String packageName) {
Robin Lee66e5d962014-04-09 16:44:21 +01004896 if (mService != null) {
4897 try {
4898 return mService.getApplicationRestrictions(admin, packageName);
4899 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004900 throw e.rethrowFromSystemServer();
Robin Lee66e5d962014-04-09 16:44:21 +01004901 }
4902 }
4903 return null;
4904 }
Amith Yamasanibe465322014-04-24 13:45:17 -07004905
4906 /**
Julia Reynolds20118f12015-02-11 12:34:08 -05004907 * Called by a profile or device owner to set a user restriction specified by the key.
Amith Yamasanibe465322014-04-24 13:45:17 -07004908 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004909 * The calling device admin must be a profile or device owner; if it is not, a security
4910 * exception will be thrown.
Jim Millerdf2258b2014-04-27 20:10:26 -07004911 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004912 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4913 * @param key The key of the restriction. See the constants in {@link android.os.UserManager}
4914 * for the list of keys.
4915 * @throws SecurityException if {@code admin} is not a device or profile owner.
Amith Yamasanibe465322014-04-24 13:45:17 -07004916 */
Robin Lee25e26452015-06-02 09:56:29 -07004917 public void addUserRestriction(@NonNull ComponentName admin, String key) {
Amith Yamasanibe465322014-04-24 13:45:17 -07004918 if (mService != null) {
4919 try {
4920 mService.setUserRestriction(admin, key, true);
4921 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004922 throw e.rethrowFromSystemServer();
Amith Yamasanibe465322014-04-24 13:45:17 -07004923 }
4924 }
4925 }
4926
4927 /**
Julia Reynolds20118f12015-02-11 12:34:08 -05004928 * Called by a profile or device owner to clear a user restriction specified by the key.
Amith Yamasanibe465322014-04-24 13:45:17 -07004929 * <p>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004930 * The calling device admin must be a profile or device owner; if it is not, a security
4931 * exception will be thrown.
Jim Millerdf2258b2014-04-27 20:10:26 -07004932 *
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004933 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4934 * @param key The key of the restriction. See the constants in {@link android.os.UserManager}
4935 * for the list of keys.
4936 * @throws SecurityException if {@code admin} is not a device or profile owner.
Amith Yamasanibe465322014-04-24 13:45:17 -07004937 */
Robin Lee25e26452015-06-02 09:56:29 -07004938 public void clearUserRestriction(@NonNull ComponentName admin, String key) {
Amith Yamasanibe465322014-04-24 13:45:17 -07004939 if (mService != null) {
4940 try {
4941 mService.setUserRestriction(admin, key, false);
4942 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004943 throw e.rethrowFromSystemServer();
Amith Yamasanibe465322014-04-24 13:45:17 -07004944 }
4945 }
4946 }
Adam Connors010cfd42014-04-16 12:48:13 +01004947
4948 /**
Makoto Onuki3a3092f2015-10-30 11:07:51 -07004949 * Called by a profile or device owner to get user restrictions set with
4950 * {@link #addUserRestriction(ComponentName, String)}.
4951 * <p>
4952 * The target user may have more restrictions set by the system or other device owner / profile
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004953 * owner. To get all the user restrictions currently set, use
Makoto Onuki3a3092f2015-10-30 11:07:51 -07004954 * {@link UserManager#getUserRestrictions()}.
4955 *
4956 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004957 * @throws SecurityException if {@code admin} is not a device or profile owner.
Makoto Onuki3a3092f2015-10-30 11:07:51 -07004958 */
4959 public Bundle getUserRestrictions(@NonNull ComponentName admin) {
4960 Bundle ret = null;
4961 if (mService != null) {
4962 try {
Sudheer Shanka549b9692016-03-30 17:12:07 -07004963 ret = mService.getUserRestrictions(admin);
4964 } catch (RemoteException e) {
4965 throw e.rethrowFromSystemServer();
4966 }
4967 }
4968 return ret == null ? new Bundle() : ret;
4969 }
4970
4971 /**
4972 * Called by the system to get the user restrictions for a user.
4973 *
4974 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
4975 * @param userHandle user id the admin is running as.
4976 *
4977 * @hide
4978 */
4979 public Bundle getUserRestrictionsForUser(@NonNull ComponentName admin, int userHandle) {
4980 Bundle ret = null;
4981 if (mService != null) {
4982 try {
4983 ret = mService.getUserRestrictionsForUser(admin, userHandle);
Makoto Onuki3a3092f2015-10-30 11:07:51 -07004984 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07004985 throw e.rethrowFromSystemServer();
Makoto Onuki3a3092f2015-10-30 11:07:51 -07004986 }
4987 }
4988 return ret == null ? new Bundle() : ret;
4989 }
4990
4991 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004992 * Called by profile or device owners to hide or unhide packages. When a package is hidden it is
4993 * unavailable for use, but the data and actual package file remain.
Julia Reynolds966881e2014-05-14 12:23:08 -04004994 *
4995 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Amith Yamasanie5bcff62014-07-19 15:44:09 -07004996 * @param packageName The name of the package to hide or unhide.
4997 * @param hidden {@code true} if the package should be hidden, {@code false} if it should be
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07004998 * unhidden.
Amith Yamasanie5bcff62014-07-19 15:44:09 -07004999 * @return boolean Whether the hidden setting of the package was successfully updated.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005000 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynolds966881e2014-05-14 12:23:08 -04005001 */
Robin Lee25e26452015-06-02 09:56:29 -07005002 public boolean setApplicationHidden(@NonNull ComponentName admin, String packageName,
Amith Yamasanie5bcff62014-07-19 15:44:09 -07005003 boolean hidden) {
Julia Reynolds966881e2014-05-14 12:23:08 -04005004 if (mService != null) {
5005 try {
Amith Yamasanie5bcff62014-07-19 15:44:09 -07005006 return mService.setApplicationHidden(admin, packageName, hidden);
Julia Reynolds966881e2014-05-14 12:23:08 -04005007 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005008 throw e.rethrowFromSystemServer();
Julia Reynolds966881e2014-05-14 12:23:08 -04005009 }
5010 }
5011 return false;
5012 }
5013
5014 /**
Julia Reynolds20118f12015-02-11 12:34:08 -05005015 * Called by profile or device owners to determine if a package is hidden.
Julia Reynolds966881e2014-05-14 12:23:08 -04005016 *
5017 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Amith Yamasanie5bcff62014-07-19 15:44:09 -07005018 * @param packageName The name of the package to retrieve the hidden status of.
5019 * @return boolean {@code true} if the package is hidden, {@code false} otherwise.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005020 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynolds966881e2014-05-14 12:23:08 -04005021 */
Robin Lee25e26452015-06-02 09:56:29 -07005022 public boolean isApplicationHidden(@NonNull ComponentName admin, String packageName) {
Julia Reynolds966881e2014-05-14 12:23:08 -04005023 if (mService != null) {
5024 try {
Amith Yamasanie5bcff62014-07-19 15:44:09 -07005025 return mService.isApplicationHidden(admin, packageName);
Julia Reynolds966881e2014-05-14 12:23:08 -04005026 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005027 throw e.rethrowFromSystemServer();
Julia Reynolds966881e2014-05-14 12:23:08 -04005028 }
5029 }
5030 return false;
5031 }
5032
5033 /**
Julia Reynolds20118f12015-02-11 12:34:08 -05005034 * Called by profile or device owners to re-enable a system app that was disabled by default
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07005035 * when the user was initialized.
Adam Connors655be2a2014-07-14 09:01:25 +00005036 *
5037 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Makoto Onuki32b30572015-12-11 14:29:51 -08005038 * @param packageName The package to be re-enabled in the calling profile.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005039 * @throws SecurityException if {@code admin} is not a device or profile owner.
Adam Connors655be2a2014-07-14 09:01:25 +00005040 */
Robin Lee25e26452015-06-02 09:56:29 -07005041 public void enableSystemApp(@NonNull ComponentName admin, String packageName) {
Adam Connors655be2a2014-07-14 09:01:25 +00005042 if (mService != null) {
5043 try {
5044 mService.enableSystemApp(admin, packageName);
5045 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005046 throw e.rethrowFromSystemServer();
Adam Connors655be2a2014-07-14 09:01:25 +00005047 }
5048 }
5049 }
5050
5051 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005052 * Called by profile or device owners to re-enable system apps by intent that were disabled by
5053 * default when the user was initialized.
Adam Connors655be2a2014-07-14 09:01:25 +00005054 *
5055 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5056 * @param intent An intent matching the app(s) to be installed. All apps that resolve for this
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005057 * intent will be re-enabled in the calling profile.
Adam Connors655be2a2014-07-14 09:01:25 +00005058 * @return int The number of activities that matched the intent and were installed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005059 * @throws SecurityException if {@code admin} is not a device or profile owner.
Adam Connors655be2a2014-07-14 09:01:25 +00005060 */
Robin Lee25e26452015-06-02 09:56:29 -07005061 public int enableSystemApp(@NonNull ComponentName admin, Intent intent) {
Adam Connors655be2a2014-07-14 09:01:25 +00005062 if (mService != null) {
5063 try {
5064 return mService.enableSystemAppWithIntent(admin, intent);
5065 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005066 throw e.rethrowFromSystemServer();
Adam Connors655be2a2014-07-14 09:01:25 +00005067 }
5068 }
5069 return 0;
5070 }
5071
5072 /**
Sander Alewijnse112e0532014-10-29 13:28:49 +00005073 * Called by a device owner or profile owner to disable account management for a specific type
5074 * of account.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005075 * <p>
5076 * The calling device admin must be a device owner or profile owner. If it is not, a security
5077 * exception will be thrown.
5078 * <p>
5079 * When account management is disabled for an account type, adding or removing an account of
5080 * that type will not be possible.
5081 * <p>
5082 * From {@link android.os.Build.VERSION_CODES#N} the profile or device owner can still use
Benjamin Franzb6c0ce42015-11-05 10:06:51 +00005083 * {@link android.accounts.AccountManager} APIs to add or remove accounts when account
5084 * management for a specific type is disabled.
5085 *
Sander Alewijnse650c3342014-05-08 18:00:50 +01005086 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5087 * @param accountType For which account management is disabled or enabled.
5088 * @param disabled The boolean indicating that account management will be disabled (true) or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005089 * enabled (false).
5090 * @throws SecurityException if {@code admin} is not a device or profile owner.
Sander Alewijnse650c3342014-05-08 18:00:50 +01005091 */
Robin Lee25e26452015-06-02 09:56:29 -07005092 public void setAccountManagementDisabled(@NonNull ComponentName admin, String accountType,
Sander Alewijnse650c3342014-05-08 18:00:50 +01005093 boolean disabled) {
5094 if (mService != null) {
5095 try {
5096 mService.setAccountManagementDisabled(admin, accountType, disabled);
5097 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005098 throw e.rethrowFromSystemServer();
Sander Alewijnse650c3342014-05-08 18:00:50 +01005099 }
5100 }
5101 }
5102
5103 /**
Sander Alewijnse5c02db62014-05-07 10:46:57 +01005104 * Gets the array of accounts for which account management is disabled by the profile owner.
5105 *
5106 * <p> Account management can be disabled/enabled by calling
5107 * {@link #setAccountManagementDisabled}.
5108 *
5109 * @return a list of account types for which account management has been disabled.
5110 *
5111 * @see #setAccountManagementDisabled
5112 */
5113 public String[] getAccountTypesWithManagementDisabled() {
Makoto Onukicc4bbeb2015-09-17 10:28:24 -07005114 return getAccountTypesWithManagementDisabledAsUser(myUserId());
Alexandra Gherghina999d3942014-07-03 11:40:08 +01005115 }
5116
5117 /**
5118 * @see #getAccountTypesWithManagementDisabled()
5119 * @hide
5120 */
5121 public String[] getAccountTypesWithManagementDisabledAsUser(int userId) {
Sander Alewijnse5c02db62014-05-07 10:46:57 +01005122 if (mService != null) {
5123 try {
Alexandra Gherghina999d3942014-07-03 11:40:08 +01005124 return mService.getAccountTypesWithManagementDisabledAsUser(userId);
Sander Alewijnse5c02db62014-05-07 10:46:57 +01005125 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005126 throw e.rethrowFromSystemServer();
Sander Alewijnse5c02db62014-05-07 10:46:57 +01005127 }
5128 }
5129
5130 return null;
5131 }
justinzhang511e0d82014-03-24 16:09:24 -04005132
5133 /**
Jason Monkd7b86212014-06-16 13:15:38 -04005134 * Sets which packages may enter lock task mode.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005135 * <p>
5136 * Any packages that shares uid with an allowed package will also be allowed to activate lock
5137 * task. From {@link android.os.Build.VERSION_CODES#M} removing packages from the lock task
5138 * package list results in locked tasks belonging to those packages to be finished. This
5139 * function can only be called by the device owner.
Jason Monkd7b86212014-06-16 13:15:38 -04005140 *
Jason Monkd7b86212014-06-16 13:15:38 -04005141 * @param packages The list of packages allowed to enter lock task mode
Jason Monk48aacba2014-08-13 16:29:08 -04005142 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005143 * @throws SecurityException if {@code admin} is not a device owner.
Jason Monkd7b86212014-06-16 13:15:38 -04005144 * @see Activity#startLockTask()
Benjamin Franz6cdb27e2015-02-26 12:26:53 +00005145 * @see DeviceAdminReceiver#onLockTaskModeEntering(Context, Intent, String)
5146 * @see DeviceAdminReceiver#onLockTaskModeExiting(Context, Intent)
Jason Monk1c7c3192014-06-26 12:52:18 -04005147 * @see UserManager#DISALLOW_CREATE_WINDOWS
justinzhang511e0d82014-03-24 16:09:24 -04005148 */
Robin Lee25e26452015-06-02 09:56:29 -07005149 public void setLockTaskPackages(@NonNull ComponentName admin, String[] packages)
Jason Monk48aacba2014-08-13 16:29:08 -04005150 throws SecurityException {
justinzhang511e0d82014-03-24 16:09:24 -04005151 if (mService != null) {
5152 try {
Jason Monk48aacba2014-08-13 16:29:08 -04005153 mService.setLockTaskPackages(admin, packages);
justinzhang511e0d82014-03-24 16:09:24 -04005154 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005155 throw e.rethrowFromSystemServer();
justinzhang511e0d82014-03-24 16:09:24 -04005156 }
5157 }
5158 }
5159
5160 /**
Jason Monkd7b86212014-06-16 13:15:38 -04005161 * This function returns the list of packages allowed to start the lock task mode.
Jason Monk48aacba2014-08-13 16:29:08 -04005162 *
5163 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
justinzhang511e0d82014-03-24 16:09:24 -04005164 * @hide
5165 */
Robin Lee25e26452015-06-02 09:56:29 -07005166 public String[] getLockTaskPackages(@NonNull ComponentName admin) {
justinzhang511e0d82014-03-24 16:09:24 -04005167 if (mService != null) {
5168 try {
Jason Monk48aacba2014-08-13 16:29:08 -04005169 return mService.getLockTaskPackages(admin);
justinzhang511e0d82014-03-24 16:09:24 -04005170 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005171 throw e.rethrowFromSystemServer();
justinzhang511e0d82014-03-24 16:09:24 -04005172 }
5173 }
5174 return null;
5175 }
5176
5177 /**
5178 * This function lets the caller know whether the given component is allowed to start the
5179 * lock task mode.
Jason Monkd7b86212014-06-16 13:15:38 -04005180 * @param pkg The package to check
justinzhang511e0d82014-03-24 16:09:24 -04005181 */
Jason Monkd7b86212014-06-16 13:15:38 -04005182 public boolean isLockTaskPermitted(String pkg) {
justinzhang511e0d82014-03-24 16:09:24 -04005183 if (mService != null) {
5184 try {
Jason Monkd7b86212014-06-16 13:15:38 -04005185 return mService.isLockTaskPermitted(pkg);
justinzhang511e0d82014-03-24 16:09:24 -04005186 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005187 throw e.rethrowFromSystemServer();
justinzhang511e0d82014-03-24 16:09:24 -04005188 }
5189 }
5190 return false;
5191 }
Julia Reynoldsda551652014-05-14 17:15:16 -04005192
5193 /**
5194 * Called by device owners to update {@link Settings.Global} settings. Validation that the value
5195 * 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 -07005196 * <p>
5197 * The settings that can be updated with this method are:
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005198 * <ul>
5199 * <li>{@link Settings.Global#ADB_ENABLED}</li>
5200 * <li>{@link Settings.Global#AUTO_TIME}</li>
5201 * <li>{@link Settings.Global#AUTO_TIME_ZONE}</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005202 * <li>{@link Settings.Global#DATA_ROAMING}</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005203 * <li>{@link Settings.Global#USB_MASS_STORAGE_ENABLED}</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005204 * <li>{@link Settings.Global#WIFI_SLEEP_POLICY}</li>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005205 * <li>{@link Settings.Global#STAY_ON_WHILE_PLUGGED_IN} This setting is only available from
5206 * {@link android.os.Build.VERSION_CODES#M} onwards and can only be set if
5207 * {@link #setMaximumTimeToLock} is not used to set a timeout.</li>
5208 * <li>{@link Settings.Global#WIFI_DEVICE_OWNER_CONFIGS_LOCKDOWN}</li> This setting is only
5209 * available from {@link android.os.Build.VERSION_CODES#M} onwards.</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005210 * </ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005211 * <p>
5212 * Changing the following settings has no effect as of {@link android.os.Build.VERSION_CODES#M}:
Esteban Talavera656fa7f2015-06-29 17:41:39 +01005213 * <ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005214 * <li>{@link Settings.Global#BLUETOOTH_ON}. Use
5215 * {@link android.bluetooth.BluetoothAdapter#enable()} and
5216 * {@link android.bluetooth.BluetoothAdapter#disable()} instead.</li>
Esteban Talavera656fa7f2015-06-29 17:41:39 +01005217 * <li>{@link Settings.Global#DEVELOPMENT_SETTINGS_ENABLED}</li>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005218 * <li>{@link Settings.Global#MODE_RINGER}. Use
5219 * {@link android.media.AudioManager#setRingerMode(int)} instead.</li>
Esteban Talavera656fa7f2015-06-29 17:41:39 +01005220 * <li>{@link Settings.Global#NETWORK_PREFERENCE}</li>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005221 * <li>{@link Settings.Global#WIFI_ON}. Use
5222 * {@link android.net.wifi.WifiManager#setWifiEnabled(boolean)} instead.</li>
Esteban Talavera656fa7f2015-06-29 17:41:39 +01005223 * </ul>
Julia Reynoldsda551652014-05-14 17:15:16 -04005224 *
5225 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5226 * @param setting The name of the setting to update.
5227 * @param value The value to update the setting to.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005228 * @throws SecurityException if {@code admin} is not a device owner.
Julia Reynoldsda551652014-05-14 17:15:16 -04005229 */
Robin Lee25e26452015-06-02 09:56:29 -07005230 public void setGlobalSetting(@NonNull ComponentName admin, String setting, String value) {
Julia Reynoldsda551652014-05-14 17:15:16 -04005231 if (mService != null) {
5232 try {
5233 mService.setGlobalSetting(admin, setting, value);
5234 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005235 throw e.rethrowFromSystemServer();
Julia Reynoldsda551652014-05-14 17:15:16 -04005236 }
5237 }
5238 }
5239
5240 /**
5241 * Called by profile or device owners to update {@link Settings.Secure} settings. Validation
5242 * that the value of the setting is in the correct form for the setting type should be performed
5243 * by the caller.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005244 * <p>
5245 * The settings that can be updated by a profile or device owner with this method are:
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005246 * <ul>
5247 * <li>{@link Settings.Secure#DEFAULT_INPUT_METHOD}</li>
Amith Yamasani52c39a12014-10-21 11:14:04 -07005248 * <li>{@link Settings.Secure#INSTALL_NON_MARKET_APPS}</li>
Julia Reynolds9ed66da2014-08-26 15:42:03 -04005249 * <li>{@link Settings.Secure#SKIP_FIRST_USE_HINTS}</li>
5250 * </ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005251 * <p>
5252 * A device owner can additionally update the following settings:
Julia Reynolds82735bc2014-09-04 16:43:30 -04005253 * <ul>
5254 * <li>{@link Settings.Secure#LOCATION_MODE}</li>
5255 * </ul>
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005256 *
Julia Reynoldsda551652014-05-14 17:15:16 -04005257 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5258 * @param setting The name of the setting to update.
5259 * @param value The value to update the setting to.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005260 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynoldsda551652014-05-14 17:15:16 -04005261 */
Robin Lee25e26452015-06-02 09:56:29 -07005262 public void setSecureSetting(@NonNull ComponentName admin, String setting, String value) {
Julia Reynoldsda551652014-05-14 17:15:16 -04005263 if (mService != null) {
5264 try {
5265 mService.setSecureSetting(admin, setting, value);
5266 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005267 throw e.rethrowFromSystemServer();
Julia Reynoldsda551652014-05-14 17:15:16 -04005268 }
5269 }
5270 }
5271
Amith Yamasanif20d6402014-05-24 15:34:37 -07005272 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005273 * Designates a specific service component as the provider for making permission requests of a
5274 * local or remote administrator of the user.
Amith Yamasanif20d6402014-05-24 15:34:37 -07005275 * <p/>
5276 * Only a profile owner can designate the restrictions provider.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005277 *
Amith Yamasanif20d6402014-05-24 15:34:37 -07005278 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Amith Yamasanif6e2fcc2014-07-10 13:41:55 -07005279 * @param provider The component name of the service that implements
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005280 * {@link RestrictionsReceiver}. If this param is null, it removes the restrictions
5281 * provider previously assigned.
5282 * @throws SecurityException if {@code admin} is not a device or profile owner.
Amith Yamasanif20d6402014-05-24 15:34:37 -07005283 */
Robin Lee25e26452015-06-02 09:56:29 -07005284 public void setRestrictionsProvider(@NonNull ComponentName admin,
5285 @Nullable ComponentName provider) {
Amith Yamasanif20d6402014-05-24 15:34:37 -07005286 if (mService != null) {
5287 try {
Amith Yamasanif6e2fcc2014-07-10 13:41:55 -07005288 mService.setRestrictionsProvider(admin, provider);
Amith Yamasanif20d6402014-05-24 15:34:37 -07005289 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005290 throw re.rethrowFromSystemServer();
Amith Yamasanif20d6402014-05-24 15:34:37 -07005291 }
5292 }
5293 }
Julia Reynolds4a21b252014-06-04 11:11:43 -04005294
5295 /**
5296 * Called by profile or device owners to set the master volume mute on or off.
5297 *
5298 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5299 * @param on {@code true} to mute master volume, {@code false} to turn mute off.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005300 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynolds4a21b252014-06-04 11:11:43 -04005301 */
Robin Lee25e26452015-06-02 09:56:29 -07005302 public void setMasterVolumeMuted(@NonNull ComponentName admin, boolean on) {
Julia Reynolds4a21b252014-06-04 11:11:43 -04005303 if (mService != null) {
5304 try {
5305 mService.setMasterVolumeMuted(admin, on);
5306 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005307 throw re.rethrowFromSystemServer();
Julia Reynolds4a21b252014-06-04 11:11:43 -04005308 }
5309 }
5310 }
5311
5312 /**
5313 * Called by profile or device owners to check whether the master volume mute is on or off.
5314 *
5315 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5316 * @return {@code true} if master volume is muted, {@code false} if it's not.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005317 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynolds4a21b252014-06-04 11:11:43 -04005318 */
Robin Lee25e26452015-06-02 09:56:29 -07005319 public boolean isMasterVolumeMuted(@NonNull ComponentName admin) {
Julia Reynolds4a21b252014-06-04 11:11:43 -04005320 if (mService != null) {
5321 try {
5322 return mService.isMasterVolumeMuted(admin);
5323 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005324 throw re.rethrowFromSystemServer();
Julia Reynolds4a21b252014-06-04 11:11:43 -04005325 }
5326 }
5327 return false;
5328 }
Kenny Guyc13053b2014-05-29 14:17:17 +01005329
5330 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005331 * Called by profile or device owners to change whether a user can uninstall a package.
Kenny Guyc13053b2014-05-29 14:17:17 +01005332 *
5333 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5334 * @param packageName package to change.
Esteban Talaverad5c5c132014-08-20 11:35:57 +01005335 * @param uninstallBlocked true if the user shouldn't be able to uninstall the package.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005336 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyc13053b2014-05-29 14:17:17 +01005337 */
Robin Lee25e26452015-06-02 09:56:29 -07005338 public void setUninstallBlocked(@NonNull ComponentName admin, String packageName,
Esteban Talaverad5c5c132014-08-20 11:35:57 +01005339 boolean uninstallBlocked) {
Kenny Guyc13053b2014-05-29 14:17:17 +01005340 if (mService != null) {
5341 try {
Esteban Talaverad5c5c132014-08-20 11:35:57 +01005342 mService.setUninstallBlocked(admin, packageName, uninstallBlocked);
Kenny Guyc13053b2014-05-29 14:17:17 +01005343 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005344 throw re.rethrowFromSystemServer();
Kenny Guyc13053b2014-05-29 14:17:17 +01005345 }
5346 }
5347 }
5348
5349 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08005350 * Check whether the user has been blocked by device policy from uninstalling a package.
Rubin Xua97855b2014-11-07 05:41:00 +00005351 * Requires the caller to be the profile owner if checking a specific admin's policy.
Rubin Xue1e6faa2015-03-10 10:51:59 +00005352 * <p>
5353 * <strong>Note:</strong> Starting from {@link android.os.Build.VERSION_CODES#LOLLIPOP_MR1}, the
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005354 * behavior of this API is changed such that passing {@code null} as the {@code admin} parameter
5355 * will return if any admin has blocked the uninstallation. Before L MR1, passing {@code null}
5356 * will cause a NullPointerException to be raised.
Kenny Guyc13053b2014-05-29 14:17:17 +01005357 *
Robin Lee25e26452015-06-02 09:56:29 -07005358 * @param admin The name of the admin component whose blocking policy will be checked, or
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005359 * {@code null} to check whether any admin has blocked the uninstallation.
Kenny Guyc13053b2014-05-29 14:17:17 +01005360 * @param packageName package to check.
Rubin Xua97855b2014-11-07 05:41:00 +00005361 * @return true if uninstallation is blocked.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005362 * @throws SecurityException if {@code admin} is not a device or profile owner.
Kenny Guyc13053b2014-05-29 14:17:17 +01005363 */
Robin Lee25e26452015-06-02 09:56:29 -07005364 public boolean isUninstallBlocked(@Nullable ComponentName admin, String packageName) {
Kenny Guyc13053b2014-05-29 14:17:17 +01005365 if (mService != null) {
5366 try {
Esteban Talavera729b2a62014-08-27 18:01:58 +01005367 return mService.isUninstallBlocked(admin, packageName);
Kenny Guyc13053b2014-05-29 14:17:17 +01005368 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005369 throw re.rethrowFromSystemServer();
Kenny Guyc13053b2014-05-29 14:17:17 +01005370 }
5371 }
5372 return false;
5373 }
Svetoslav976e8bd2014-07-16 15:12:03 -07005374
5375 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005376 * Called by the profile owner of a managed profile to enable widget providers from a given
5377 * package to be available in the parent profile. As a result the user will be able to add
5378 * widgets from the white-listed package running under the profile to a widget host which runs
5379 * under the parent profile, for example the home screen. Note that a package may have zero or
5380 * more provider components, where each component provides a different widget type.
Svetoslav976e8bd2014-07-16 15:12:03 -07005381 * <p>
5382 * <strong>Note:</strong> By default no widget provider package is white-listed.
Svetoslav976e8bd2014-07-16 15:12:03 -07005383 *
5384 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5385 * @param packageName The package from which widget providers are white-listed.
5386 * @return Whether the package was added.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005387 * @throws SecurityException if {@code admin} is not a profile owner.
Svetoslav976e8bd2014-07-16 15:12:03 -07005388 * @see #removeCrossProfileWidgetProvider(android.content.ComponentName, String)
5389 * @see #getCrossProfileWidgetProviders(android.content.ComponentName)
5390 */
Robin Lee25e26452015-06-02 09:56:29 -07005391 public boolean addCrossProfileWidgetProvider(@NonNull ComponentName admin, String packageName) {
Svetoslav976e8bd2014-07-16 15:12:03 -07005392 if (mService != null) {
5393 try {
5394 return mService.addCrossProfileWidgetProvider(admin, packageName);
5395 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005396 throw re.rethrowFromSystemServer();
Svetoslav976e8bd2014-07-16 15:12:03 -07005397 }
5398 }
5399 return false;
5400 }
5401
5402 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07005403 * Called by the profile owner of a managed profile to disable widget providers from a given
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005404 * package to be available in the parent profile. For this method to take effect the package
5405 * should have been added via
5406 * {@link #addCrossProfileWidgetProvider( android.content.ComponentName, String)}.
Svetoslav976e8bd2014-07-16 15:12:03 -07005407 * <p>
5408 * <strong>Note:</strong> By default no widget provider package is white-listed.
Svetoslav976e8bd2014-07-16 15:12:03 -07005409 *
5410 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005411 * @param packageName The package from which widget providers are no longer white-listed.
Svetoslav976e8bd2014-07-16 15:12:03 -07005412 * @return Whether the package was removed.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005413 * @throws SecurityException if {@code admin} is not a profile owner.
Svetoslav976e8bd2014-07-16 15:12:03 -07005414 * @see #addCrossProfileWidgetProvider(android.content.ComponentName, String)
5415 * @see #getCrossProfileWidgetProviders(android.content.ComponentName)
5416 */
Esteban Talavera62399912016-01-11 15:37:55 +00005417 public boolean removeCrossProfileWidgetProvider(
5418 @NonNull ComponentName admin, String packageName) {
Svetoslav976e8bd2014-07-16 15:12:03 -07005419 if (mService != null) {
5420 try {
5421 return mService.removeCrossProfileWidgetProvider(admin, packageName);
5422 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005423 throw re.rethrowFromSystemServer();
Svetoslav976e8bd2014-07-16 15:12:03 -07005424 }
5425 }
5426 return false;
5427 }
5428
5429 /**
Amith Yamasanic34dc7c2014-09-18 09:42:42 -07005430 * Called by the profile owner of a managed profile to query providers from which packages are
Svetoslav976e8bd2014-07-16 15:12:03 -07005431 * available in the parent profile.
5432 *
5433 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5434 * @return The white-listed package list.
Svetoslav976e8bd2014-07-16 15:12:03 -07005435 * @see #addCrossProfileWidgetProvider(android.content.ComponentName, String)
5436 * @see #removeCrossProfileWidgetProvider(android.content.ComponentName, String)
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005437 * @throws SecurityException if {@code admin} is not a profile owner.
Svetoslav976e8bd2014-07-16 15:12:03 -07005438 */
Robin Lee25e26452015-06-02 09:56:29 -07005439 public List<String> getCrossProfileWidgetProviders(@NonNull ComponentName admin) {
Svetoslav976e8bd2014-07-16 15:12:03 -07005440 if (mService != null) {
5441 try {
5442 List<String> providers = mService.getCrossProfileWidgetProviders(admin);
5443 if (providers != null) {
5444 return providers;
5445 }
5446 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005447 throw re.rethrowFromSystemServer();
Svetoslav976e8bd2014-07-16 15:12:03 -07005448 }
5449 }
5450 return Collections.emptyList();
5451 }
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05005452
5453 /**
Makoto Onuki32b30572015-12-11 14:29:51 -08005454 * Called by profile or device owners to set the user's photo.
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05005455 *
5456 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5457 * @param icon the bitmap to set as the photo.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005458 * @throws SecurityException if {@code admin} is not a device or profile owner.
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05005459 */
Robin Lee25e26452015-06-02 09:56:29 -07005460 public void setUserIcon(@NonNull ComponentName admin, Bitmap icon) {
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05005461 try {
5462 mService.setUserIcon(admin, icon);
5463 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005464 throw re.rethrowFromSystemServer();
Julia Reynoldsfca04ca2015-02-17 13:39:12 -05005465 }
5466 }
Craig Lafayettedbe31a62015-04-02 13:14:39 -04005467
5468 /**
Rubin Xu5faad8e2015-04-20 17:43:48 +01005469 * Called by device owners to set a local system update policy. When a new policy is set,
5470 * {@link #ACTION_SYSTEM_UPDATE_POLICY_CHANGED} is broadcasted.
Rubin Xu8027a4f2015-03-10 17:52:37 +00005471 *
Robin Lee25e26452015-06-02 09:56:29 -07005472 * @param admin Which {@link DeviceAdminReceiver} this request is associated with. All
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005473 * components in the device owner package can set system update policies and the most
5474 * recent policy takes effect.
Robin Lee25e26452015-06-02 09:56:29 -07005475 * @param policy the new policy, or {@code null} to clear the current policy.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005476 * @throws SecurityException if {@code admin} is not a device owner.
Rubin Xu5faad8e2015-04-20 17:43:48 +01005477 * @see SystemUpdatePolicy
Rubin Xu8027a4f2015-03-10 17:52:37 +00005478 */
Robin Lee25e26452015-06-02 09:56:29 -07005479 public void setSystemUpdatePolicy(@NonNull ComponentName admin, SystemUpdatePolicy policy) {
Rubin Xu8027a4f2015-03-10 17:52:37 +00005480 if (mService != null) {
5481 try {
Robin Lee25e26452015-06-02 09:56:29 -07005482 mService.setSystemUpdatePolicy(admin, policy);
Rubin Xu8027a4f2015-03-10 17:52:37 +00005483 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005484 throw re.rethrowFromSystemServer();
Rubin Xu8027a4f2015-03-10 17:52:37 +00005485 }
5486 }
5487 }
5488
5489 /**
Rubin Xu5faad8e2015-04-20 17:43:48 +01005490 * Retrieve a local system update policy set previously by {@link #setSystemUpdatePolicy}.
Rubin Xu8027a4f2015-03-10 17:52:37 +00005491 *
Robin Lee25e26452015-06-02 09:56:29 -07005492 * @return The current policy object, or {@code null} if no policy is set.
Rubin Xu8027a4f2015-03-10 17:52:37 +00005493 */
Rubin Xu5faad8e2015-04-20 17:43:48 +01005494 public SystemUpdatePolicy getSystemUpdatePolicy() {
Rubin Xu8027a4f2015-03-10 17:52:37 +00005495 if (mService != null) {
5496 try {
Rubin Xud86d58c2015-05-05 16:57:37 +01005497 return mService.getSystemUpdatePolicy();
Rubin Xu8027a4f2015-03-10 17:52:37 +00005498 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005499 throw re.rethrowFromSystemServer();
Rubin Xu8027a4f2015-03-10 17:52:37 +00005500 }
5501 }
5502 return null;
5503 }
Benjamin Franze36087e2015-04-07 16:40:34 +01005504
5505 /**
5506 * Called by a device owner to disable the keyguard altogether.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005507 * <p>
5508 * Setting the keyguard to disabled has the same effect as choosing "None" as the screen lock
5509 * type. However, this call has no effect if a password, pin or pattern is currently set. If a
5510 * password, pin or pattern is set after the keyguard was disabled, the keyguard stops being
5511 * disabled.
Benjamin Franze36087e2015-04-07 16:40:34 +01005512 *
5513 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Benjamin Franzbece8062015-05-06 12:14:31 +01005514 * @param disabled {@code true} disables the keyguard, {@code false} reenables it.
Benjamin Franze36087e2015-04-07 16:40:34 +01005515 * @return {@code false} if attempting to disable the keyguard while a lock password was in
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005516 * place. {@code true} otherwise.
5517 * @throws SecurityException if {@code admin} is not a device owner.
Benjamin Franze36087e2015-04-07 16:40:34 +01005518 */
Robin Lee25e26452015-06-02 09:56:29 -07005519 public boolean setKeyguardDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franze36087e2015-04-07 16:40:34 +01005520 try {
Benjamin Franzbece8062015-05-06 12:14:31 +01005521 return mService.setKeyguardDisabled(admin, disabled);
Benjamin Franze36087e2015-04-07 16:40:34 +01005522 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005523 throw re.rethrowFromSystemServer();
Benjamin Franze36087e2015-04-07 16:40:34 +01005524 }
5525 }
Benjamin Franzea2ec972015-03-16 17:18:09 +00005526
5527 /**
Benjamin Franzbece8062015-05-06 12:14:31 +01005528 * Called by device owner to disable the status bar. Disabling the status bar blocks
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005529 * notifications, quick settings and other screen overlays that allow escaping from a single use
5530 * device.
Benjamin Franzea2ec972015-03-16 17:18:09 +00005531 *
5532 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Benjamin Franzbece8062015-05-06 12:14:31 +01005533 * @param disabled {@code true} disables the status bar, {@code false} reenables it.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005534 * @return {@code false} if attempting to disable the status bar failed. {@code true} otherwise.
5535 * @throws SecurityException if {@code admin} is not a device owner.
Benjamin Franzea2ec972015-03-16 17:18:09 +00005536 */
Robin Lee25e26452015-06-02 09:56:29 -07005537 public boolean setStatusBarDisabled(@NonNull ComponentName admin, boolean disabled) {
Benjamin Franzea2ec972015-03-16 17:18:09 +00005538 try {
Benjamin Franzbece8062015-05-06 12:14:31 +01005539 return mService.setStatusBarDisabled(admin, disabled);
Benjamin Franzea2ec972015-03-16 17:18:09 +00005540 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005541 throw re.rethrowFromSystemServer();
Benjamin Franzea2ec972015-03-16 17:18:09 +00005542 }
5543 }
Rubin Xudc105cc2015-04-14 23:38:01 +01005544
5545 /**
5546 * Callable by the system update service to notify device owners about pending updates.
5547 * The caller must hold {@link android.Manifest.permission#NOTIFY_PENDING_SYSTEM_UPDATE}
5548 * permission.
5549 *
5550 * @param updateReceivedTime The time as given by {@link System#currentTimeMillis()} indicating
5551 * when the current pending update was first available. -1 if no update is available.
5552 * @hide
5553 */
5554 @SystemApi
5555 public void notifyPendingSystemUpdate(long updateReceivedTime) {
5556 if (mService != null) {
5557 try {
5558 mService.notifyPendingSystemUpdate(updateReceivedTime);
5559 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005560 throw re.rethrowFromSystemServer();
Rubin Xudc105cc2015-04-14 23:38:01 +01005561 }
5562 }
5563 }
Julia Reynolds13c58ba2015-04-20 16:42:54 -04005564
5565 /**
Amith Yamasanid49489b2015-04-28 14:00:26 -07005566 * Called by profile or device owners to set the default response for future runtime permission
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005567 * requests by applications. The policy can allow for normal operation which prompts the user to
5568 * grant a permission, or can allow automatic granting or denying of runtime permission requests
5569 * by an application. This also applies to new permissions declared by app updates. When a
5570 * permission is denied or granted this way, the effect is equivalent to setting the permission
5571 * grant state via {@link #setPermissionGrantState}.
5572 * <p/>
5573 * As this policy only acts on runtime permission requests, it only applies to applications
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07005574 * built with a {@code targetSdkVersion} of {@link android.os.Build.VERSION_CODES#M} or later.
Benjamin Franz45dd6662015-07-08 14:24:14 +01005575 *
Amith Yamasanid49489b2015-04-28 14:00:26 -07005576 * @param admin Which profile or device owner this request is associated with.
5577 * @param policy One of the policy constants {@link #PERMISSION_POLICY_PROMPT},
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005578 * {@link #PERMISSION_POLICY_AUTO_GRANT} and {@link #PERMISSION_POLICY_AUTO_DENY}.
5579 * @throws SecurityException if {@code admin} is not a device or profile owner.
Benjamin Franz45dd6662015-07-08 14:24:14 +01005580 * @see #setPermissionGrantState
Amith Yamasanid49489b2015-04-28 14:00:26 -07005581 */
Robin Lee25e26452015-06-02 09:56:29 -07005582 public void setPermissionPolicy(@NonNull ComponentName admin, int policy) {
Amith Yamasanid49489b2015-04-28 14:00:26 -07005583 try {
5584 mService.setPermissionPolicy(admin, policy);
5585 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005586 throw re.rethrowFromSystemServer();
Amith Yamasanid49489b2015-04-28 14:00:26 -07005587 }
5588 }
5589
5590 /**
5591 * Returns the current runtime permission policy set by the device or profile owner. The
5592 * default is {@link #PERMISSION_POLICY_PROMPT}.
5593 * @param admin Which profile or device owner this request is associated with.
5594 * @return the current policy for future permission requests.
5595 */
Esteban Talavera28b95702015-06-24 15:23:42 +01005596 public int getPermissionPolicy(ComponentName admin) {
Amith Yamasanid49489b2015-04-28 14:00:26 -07005597 try {
5598 return mService.getPermissionPolicy(admin);
5599 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005600 throw re.rethrowFromSystemServer();
Amith Yamasanid49489b2015-04-28 14:00:26 -07005601 }
5602 }
5603
5604 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005605 * Sets the grant state of a runtime permission for a specific application. The state can be
5606 * {@link #PERMISSION_GRANT_STATE_DEFAULT default} in which a user can manage it through the UI,
5607 * {@link #PERMISSION_GRANT_STATE_DENIED denied}, in which the permission is denied and the user
5608 * cannot manage it through the UI, and {@link #PERMISSION_GRANT_STATE_GRANTED granted} in which
5609 * the permission is granted and the user cannot manage it through the UI. This might affect all
5610 * permissions in a group that the runtime permission belongs to. This method can only be called
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07005611 * by a profile or device owner.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005612 * <p/>
5613 * Setting the grant state to {@link #PERMISSION_GRANT_STATE_DEFAULT default} does not revoke
5614 * the permission. It retains the previous grant, if any.
5615 * <p/>
5616 * Permissions can be granted or revoked only for applications built with a
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07005617 * {@code targetSdkVersion} of {@link android.os.Build.VERSION_CODES#M} or later.
Amith Yamasani0bf8f7c2015-06-22 13:00:32 -07005618 *
Amith Yamasanid49489b2015-04-28 14:00:26 -07005619 * @param admin Which profile or device owner this request is associated with.
5620 * @param packageName The application to grant or revoke a permission to.
5621 * @param permission The permission to grant or revoke.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005622 * @param grantState The permission grant state which is one of
5623 * {@link #PERMISSION_GRANT_STATE_DENIED}, {@link #PERMISSION_GRANT_STATE_DEFAULT},
5624 * {@link #PERMISSION_GRANT_STATE_GRANTED},
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07005625 * @return whether the permission was successfully granted or revoked.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005626 * @throws SecurityException if {@code admin} is not a device or profile owner.
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07005627 * @see #PERMISSION_GRANT_STATE_DENIED
5628 * @see #PERMISSION_GRANT_STATE_DEFAULT
5629 * @see #PERMISSION_GRANT_STATE_GRANTED
Amith Yamasanid49489b2015-04-28 14:00:26 -07005630 */
Robin Lee25e26452015-06-02 09:56:29 -07005631 public boolean setPermissionGrantState(@NonNull ComponentName admin, String packageName,
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07005632 String permission, int grantState) {
Amith Yamasanid49489b2015-04-28 14:00:26 -07005633 try {
Svet Ganovd8ecc5a2015-05-20 10:45:43 -07005634 return mService.setPermissionGrantState(admin, packageName, permission, grantState);
Amith Yamasanid49489b2015-04-28 14:00:26 -07005635 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005636 throw re.rethrowFromSystemServer();
Amith Yamasanid49489b2015-04-28 14:00:26 -07005637 }
5638 }
Amith Yamasani184b3752015-05-22 13:00:51 -07005639
5640 /**
5641 * Returns the current grant state of a runtime permission for a specific application.
5642 *
5643 * @param admin Which profile or device owner this request is associated with.
5644 * @param packageName The application to check the grant state for.
5645 * @param permission The permission to check for.
5646 * @return the current grant state specified by device policy. If the profile or device owner
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005647 * has not set a grant state, the return value is
5648 * {@link #PERMISSION_GRANT_STATE_DEFAULT}. This does not indicate whether or not the
5649 * permission is currently granted for the package.
5650 * <p/>
5651 * If a grant state was set by the profile or device owner, then the return value will
5652 * be one of {@link #PERMISSION_GRANT_STATE_DENIED} or
5653 * {@link #PERMISSION_GRANT_STATE_GRANTED}, which indicates if the permission is
5654 * currently denied or granted.
5655 * @throws SecurityException if {@code admin} is not a device or profile owner.
Amith Yamasani184b3752015-05-22 13:00:51 -07005656 * @see #setPermissionGrantState(ComponentName, String, String, int)
5657 * @see PackageManager#checkPermission(String, String)
5658 */
Robin Lee25e26452015-06-02 09:56:29 -07005659 public int getPermissionGrantState(@NonNull ComponentName admin, String packageName,
Amith Yamasani184b3752015-05-22 13:00:51 -07005660 String permission) {
5661 try {
5662 return mService.getPermissionGrantState(admin, packageName, permission);
5663 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005664 throw re.rethrowFromSystemServer();
Amith Yamasani184b3752015-05-22 13:00:51 -07005665 }
5666 }
Nicolas Prevot07387fe2015-10-30 17:53:30 +00005667
5668 /**
5669 * Returns if provisioning a managed profile or device is possible or not.
5670 * @param action One of {@link #ACTION_PROVISION_MANAGED_DEVICE},
5671 * {@link #ACTION_PROVISION_MANAGED_PROFILE}.
Nicolas Prevot07387fe2015-10-30 17:53:30 +00005672 * @return if provisioning a managed profile or device is possible or not.
5673 * @throws IllegalArgumentException if the supplied action is not valid.
5674 */
5675 public boolean isProvisioningAllowed(String action) {
5676 try {
5677 return mService.isProvisioningAllowed(action);
5678 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005679 throw re.rethrowFromSystemServer();
Nicolas Prevot07387fe2015-10-30 17:53:30 +00005680 }
5681 }
Mahaver Chopra15a46b02015-11-11 14:54:35 +00005682
5683 /**
Mahaver Chopra15a46b02015-11-11 14:54:35 +00005684 * Return if this user is a managed profile of another user. An admin can become the profile
5685 * owner of a managed profile with {@link #ACTION_PROVISION_MANAGED_PROFILE} and of a managed
Kenny Guyffa38402016-03-31 16:40:57 +01005686 * user with {@link #createAndManageUser}
Mahaver Chopra15a46b02015-11-11 14:54:35 +00005687 * @param admin Which profile owner this request is associated with.
5688 * @return if this user is a managed profile of another user.
5689 */
5690 public boolean isManagedProfile(@NonNull ComponentName admin) {
5691 try {
5692 return mService.isManagedProfile(admin);
5693 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005694 throw re.rethrowFromSystemServer();
Mahaver Chopra15a46b02015-11-11 14:54:35 +00005695 }
5696 }
5697
5698 /**
5699 * @hide
5700 * Return if this user is a system-only user. An admin can manage a device from a system only
5701 * user by calling {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE}.
5702 * @param admin Which device owner this request is associated with.
5703 * @return if this user is a system-only user.
5704 */
5705 public boolean isSystemOnlyUser(@NonNull ComponentName admin) {
5706 try {
5707 return mService.isSystemOnlyUser(admin);
5708 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005709 throw re.rethrowFromSystemServer();
Mahaver Chopra15a46b02015-11-11 14:54:35 +00005710 }
5711 }
Makoto Onukia31ebbc2015-11-23 17:15:21 -08005712
5713 /**
5714 * Called by device owner to get the MAC address of the Wi-Fi device.
5715 *
Sudheer Shanka3cb4da12016-03-07 18:51:49 -08005716 * @param admin Which device owner this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005717 * @return the MAC address of the Wi-Fi device, or null when the information is not available.
5718 * (For example, Wi-Fi hasn't been enabled, or the device doesn't support Wi-Fi.)
5719 * <p>
5720 * The address will be in the {@code XX:XX:XX:XX:XX:XX} format.
5721 * @throws SecurityException if {@code admin} is not a device owner.
Makoto Onukia31ebbc2015-11-23 17:15:21 -08005722 */
Sudheer Shanka3cb4da12016-03-07 18:51:49 -08005723 public String getWifiMacAddress(@NonNull ComponentName admin) {
Makoto Onukia31ebbc2015-11-23 17:15:21 -08005724 try {
Sudheer Shanka3cb4da12016-03-07 18:51:49 -08005725 return mService.getWifiMacAddress(admin);
Makoto Onukia31ebbc2015-11-23 17:15:21 -08005726 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005727 throw re.rethrowFromSystemServer();
Makoto Onukia31ebbc2015-11-23 17:15:21 -08005728 }
5729 }
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +00005730
5731 /**
Mahaver Chopra1216ae52016-03-11 15:39:48 +00005732 * Called by device owner to reboot the device. If there is an ongoing call on the device,
5733 * throws an {@link IllegalStateException}.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005734 * @param admin Which device owner the request is associated with.
Mahaver Chopra1216ae52016-03-11 15:39:48 +00005735 * @throws IllegalStateException if device has an ongoing call.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005736 * @throws SecurityException if {@code admin} is not a device owner.
Mahaver Chopra1216ae52016-03-11 15:39:48 +00005737 * @see TelephonyManager#CALL_STATE_IDLE
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +00005738 */
5739 public void reboot(@NonNull ComponentName admin) {
5740 try {
5741 mService.reboot(admin);
5742 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005743 throw re.rethrowFromSystemServer();
Mahaver Chopra1ce53bc2015-12-14 13:35:14 +00005744 }
5745 }
Kenny Guy06de4e72015-12-22 12:07:39 +00005746
5747 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005748 * Called by a device admin to set the short support message. This will be displayed to the user
5749 * in settings screens where funtionality has been disabled by the admin. The message should be
5750 * limited to a short statement such as "This setting is disabled by your administrator. Contact
5751 * someone@example.com for support." If the message is longer than 200 characters it may be
5752 * truncated.
5753 * <p>
5754 * If the short support message needs to be localized, it is the responsibility of the
Benjamin Franz3e8a7092016-01-25 16:19:08 +00005755 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
5756 * and set a new version of this string accordingly.
5757 *
Kenny Guy06de4e72015-12-22 12:07:39 +00005758 * @see #setLongSupportMessage
Kenny Guy06de4e72015-12-22 12:07:39 +00005759 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005760 * @param message Short message to be displayed to the user in settings or null to clear the
5761 * existing message.
5762 * @throws SecurityException if {@code admin} is not an active administrator.
Kenny Guy06de4e72015-12-22 12:07:39 +00005763 */
5764 public void setShortSupportMessage(@NonNull ComponentName admin,
5765 @Nullable String message) {
5766 if (mService != null) {
5767 try {
5768 mService.setShortSupportMessage(admin, message);
5769 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005770 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00005771 }
5772 }
5773 }
5774
5775 /**
5776 * Called by a device admin to get the short support message.
5777 *
5778 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005779 * @return The message set by {@link #setShortSupportMessage(ComponentName, String)} or null if
5780 * no message has been set.
5781 * @throws SecurityException if {@code admin} is not an active administrator.
Kenny Guy06de4e72015-12-22 12:07:39 +00005782 */
5783 public String getShortSupportMessage(@NonNull ComponentName admin) {
5784 if (mService != null) {
5785 try {
5786 return mService.getShortSupportMessage(admin);
5787 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005788 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00005789 }
5790 }
5791 return null;
5792 }
5793
5794 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005795 * Called by a device admin to set the long support message. This will be displayed to the user
5796 * in the device administators settings screen.
5797 * <p>
5798 * If the long support message needs to be localized, it is the responsibility of the
Benjamin Franz3e8a7092016-01-25 16:19:08 +00005799 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
5800 * and set a new version of this string accordingly.
5801 *
Kenny Guy06de4e72015-12-22 12:07:39 +00005802 * @see #setShortSupportMessage
Kenny Guy06de4e72015-12-22 12:07:39 +00005803 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005804 * @param message Long message to be displayed to the user in settings or null to clear the
5805 * existing message.
5806 * @throws SecurityException if {@code admin} is not an active administrator.
Kenny Guy06de4e72015-12-22 12:07:39 +00005807 */
5808 public void setLongSupportMessage(@NonNull ComponentName admin,
5809 @Nullable String message) {
5810 if (mService != null) {
5811 try {
5812 mService.setLongSupportMessage(admin, message);
5813 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005814 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00005815 }
5816 }
5817 }
5818
5819 /**
5820 * Called by a device admin to get the long support message.
5821 *
5822 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005823 * @return The message set by {@link #setLongSupportMessage(ComponentName, String)} or null if
5824 * no message has been set.
5825 * @throws SecurityException if {@code admin} is not an active administrator.
Kenny Guy06de4e72015-12-22 12:07:39 +00005826 */
5827 public String getLongSupportMessage(@NonNull ComponentName admin) {
5828 if (mService != null) {
5829 try {
5830 return mService.getLongSupportMessage(admin);
5831 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005832 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00005833 }
5834 }
5835 return null;
5836 }
5837
5838 /**
5839 * Called by the system to get the short support message.
5840 *
5841 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5842 * @param userHandle user id the admin is running as.
5843 * @return The message set by {@link #setShortSupportMessage(ComponentName, String)}
5844 *
5845 * @hide
5846 */
5847 public String getShortSupportMessageForUser(@NonNull ComponentName admin, int userHandle) {
5848 if (mService != null) {
5849 try {
5850 return mService.getShortSupportMessageForUser(admin, userHandle);
5851 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005852 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00005853 }
5854 }
5855 return null;
5856 }
5857
5858
5859 /**
5860 * Called by the system to get the long support message.
5861 *
5862 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
5863 * @param userHandle user id the admin is running as.
5864 * @return The message set by {@link #setLongSupportMessage(ComponentName, String)}
5865 *
5866 * @hide
5867 */
5868 public String getLongSupportMessageForUser(@NonNull ComponentName admin, int userHandle) {
5869 if (mService != null) {
5870 try {
5871 return mService.getLongSupportMessageForUser(admin, userHandle);
5872 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005873 throw e.rethrowFromSystemServer();
Kenny Guy06de4e72015-12-22 12:07:39 +00005874 }
5875 }
5876 return null;
5877 }
Clara Bayarri3e826ef2015-12-14 17:51:22 +00005878
5879 /**
Esteban Talavera62399912016-01-11 15:37:55 +00005880 * Called by the profile owner of a managed profile to obtain a {@link DevicePolicyManager}
5881 * whose calls act on the parent profile.
Benjamin Franz66b45f02016-04-05 19:12:39 +01005882 *
5883 * <p>The following methods are supported for the parent instance, all other methods will
5884 * throw a SecurityException when called on the parent instance:
5885 * <ul>
5886 * <li>{@link #getPasswordQuality}</li>
5887 * <li>{@link #setPasswordQuality}</li>
5888 * <li>{@link #getPasswordMinimumLength}</li>
5889 * <li>{@link #setPasswordMinimumLength}</li>
5890 * <li>{@link #getPasswordMinimumUpperCase}</li>
5891 * <li>{@link #setPasswordMinimumUpperCase}</li>
5892 * <li>{@link #getPasswordMinimumLowerCase}</li>
5893 * <li>{@link #setPasswordMinimumLowerCase}</li>
5894 * <li>{@link #getPasswordMinimumLetters}</li>
5895 * <li>{@link #setPasswordMinimumLetters}</li>
5896 * <li>{@link #getPasswordMinimumNumeric}</li>
5897 * <li>{@link #setPasswordMinimumNumeric}</li>
5898 * <li>{@link #getPasswordMinimumSymbols}</li>
5899 * <li>{@link #setPasswordMinimumSymbols}</li>
5900 * <li>{@link #getPasswordMinimumNonLetter}</li>
5901 * <li>{@link #setPasswordMinimumNonLetter}</li>
5902 * <li>{@link #getPasswordHistoryLength}</li>
5903 * <li>{@link #setPasswordHistoryLength}</li>
5904 * <li>{@link #getPasswordExpirationTimeout}</li>
5905 * <li>{@link #setPasswordExpirationTimeout}</li>
5906 * <li>{@link #getPasswordExpiration}</li>
5907 * <li>{@link #isActivePasswordSufficient}</li>
5908 * <li>{@link #getCurrentFailedPasswordAttempts}</li>
5909 * <li>{@link #getMaximumFailedPasswordsForWipe}</li>
5910 * <li>{@link #setMaximumFailedPasswordsForWipe}</li>
5911 * <li>{@link #getMaximumTimeToLock}</li>
5912 * <li>{@link #setMaximumTimeToLock}</li>
5913 * <li>{@link #lockNow}</li>
5914 * <li>{@link #getKeyguardDisabledFeatures}</li>
5915 * <li>{@link #setKeyguardDisabledFeatures}</li>
5916 * <li>{@link #getTrustAgentConfiguration}</li>
5917 * <li>{@link #setTrustAgentConfiguration}</li>
5918 * </ul>
Clara Bayarri3e826ef2015-12-14 17:51:22 +00005919 *
5920 * @return a new instance of {@link DevicePolicyManager} that acts on the parent profile.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005921 * @throws SecurityException if {@code admin} is not a profile owner.
Clara Bayarri3e826ef2015-12-14 17:51:22 +00005922 */
5923 public DevicePolicyManager getParentProfileInstance(@NonNull ComponentName admin) {
5924 try {
5925 if (!mService.isManagedProfile(admin)) {
5926 throw new SecurityException("The current user does not have a parent profile.");
5927 }
5928 return new DevicePolicyManager(mContext, true);
Rubin Xuc3cd05f2016-01-11 12:11:35 +00005929 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005930 throw e.rethrowFromSystemServer();
Rubin Xuc3cd05f2016-01-11 12:11:35 +00005931 }
5932 }
5933
5934 /**
Michal Karpinski6235a942016-03-15 12:07:23 +00005935 * Called by device owner to control the security logging feature. Logging can only be
5936 * enabled on single user devices where the sole user is managed by the device owner.
5937 *
5938 * <p> Security logs contain various information intended for security auditing purposes.
5939 * See {@link SecurityEvent} for details.
5940 *
5941 * <p>There must be only one user on the device, managed by the device owner.
5942 * Otherwise a {@link SecurityException} will be thrown.
Michal Karpinskib58e4962016-03-01 14:55:10 +00005943 *
Rubin Xuc3cd05f2016-01-11 12:11:35 +00005944 * @param admin Which device owner this request is associated with.
Michal Karpinski6235a942016-03-15 12:07:23 +00005945 * @param enabled whether security logging should be enabled or not.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005946 * @throws SecurityException if {@code admin} is not a device owner.
Michal Karpinski6235a942016-03-15 12:07:23 +00005947 * @see #retrieveSecurityLogs
5948 */
5949 public void setSecurityLoggingEnabled(@NonNull ComponentName admin, boolean enabled) {
5950 try {
5951 mService.setSecurityLoggingEnabled(admin, enabled);
5952 } catch (RemoteException re) {
5953 throw re.rethrowFromSystemServer();
5954 }
5955 }
5956
5957 /**
Michal Karpinski6235a942016-03-15 12:07:23 +00005958 * Return whether security logging is enabled or not by the device owner.
5959 *
5960 * <p>Can only be called by the device owner, otherwise a {@link SecurityException} will be
5961 * thrown.
5962 *
5963 * @param admin Which device owner this request is associated with.
5964 * @return {@code true} if security logging is enabled by device owner, {@code false} otherwise.
5965 * @throws SecurityException if {@code admin} is not a device owner.
5966 */
5967 public boolean isSecurityLoggingEnabled(@NonNull ComponentName admin) {
Rubin Xuc3cd05f2016-01-11 12:11:35 +00005968 try {
Michal Karpinski6235a942016-03-15 12:07:23 +00005969 return mService.isSecurityLoggingEnabled(admin);
Rubin Xuc3cd05f2016-01-11 12:11:35 +00005970 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07005971 throw re.rethrowFromSystemServer();
Rubin Xuc3cd05f2016-01-11 12:11:35 +00005972 }
5973 }
5974
5975 /**
Michal Karpinski6235a942016-03-15 12:07:23 +00005976 * Called by device owner to retrieve all new security logging entries since the last call to
5977 * this API after device boots.
5978 *
5979 * <p> Access to the logs is rate limited and it will only return new logs after the device
5980 * owner has been notified via {@link DeviceAdminReceiver#onSecurityLogsAvailable}.
5981 *
5982 * <p>There must be only one user on the device, managed by the device owner.
5983 * Otherwise a {@link SecurityException} will be thrown.
Michal Karpinskib58e4962016-03-01 14:55:10 +00005984 *
Rubin Xuc3cd05f2016-01-11 12:11:35 +00005985 * @param admin Which device owner this request is associated with.
Michal Karpinski6235a942016-03-15 12:07:23 +00005986 * @return the new batch of security logs which is a list of {@link SecurityEvent},
5987 * or {@code null} if rate limitation is exceeded or if logging is currently disabled.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07005988 * @throws SecurityException if {@code admin} is not a device owner.
Rubin Xuc3cd05f2016-01-11 12:11:35 +00005989 */
Michal Karpinski6235a942016-03-15 12:07:23 +00005990 public List<SecurityEvent> retrieveSecurityLogs(@NonNull ComponentName admin) {
Rubin Xuc3cd05f2016-01-11 12:11:35 +00005991 try {
Michal Karpinski6235a942016-03-15 12:07:23 +00005992 ParceledListSlice<SecurityEvent> list = mService.retrieveSecurityLogs(admin);
Rubin Xuc3cd05f2016-01-11 12:11:35 +00005993 if (list != null) {
5994 return list.getList();
5995 } else {
5996 // Rate limit exceeded.
5997 return null;
5998 }
Clara Bayarri3e826ef2015-12-14 17:51:22 +00005999 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006000 throw re.rethrowFromSystemServer();
Clara Bayarri3e826ef2015-12-14 17:51:22 +00006001 }
6002 }
Benjamin Franz59720bb2016-01-18 15:26:11 +00006003
6004 /**
Sudheer Shanka978fc0d2016-01-28 13:51:10 +00006005 * Called by the system to obtain a {@link DevicePolicyManager} whose calls act on the parent
6006 * profile.
6007 *
6008 * @hide
6009 */
6010 public DevicePolicyManager getParentProfileInstance(UserInfo uInfo) {
6011 mContext.checkSelfPermission(
6012 android.Manifest.permission.MANAGE_PROFILE_AND_DEVICE_OWNERS);
6013 if (!uInfo.isManagedProfile()) {
6014 throw new SecurityException("The user " + uInfo.id
6015 + " does not have a parent profile.");
6016 }
6017 return new DevicePolicyManager(mContext, true);
6018 }
6019
6020 /**
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006021 * Called by device owners to retrieve device logs from before the device's last reboot.
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006022 * <p>
6023 * <strong> The device logs are retrieved from a RAM region which is not guaranteed to be
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006024 * corruption-free during power cycles, due to hardware variations and limitations. As a result,
Michal Karpinskie0e100982016-03-30 15:02:26 +01006025 * this API is provided as best-effort and the returned logs may be empty or contain corrupted
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006026 * data. </strong>
6027 * <p>
6028 * There must be only one user on the device, managed by the device owner. Otherwise a
6029 * {@link SecurityException} will be thrown.
Michal Karpinskib58e4962016-03-01 14:55:10 +00006030 *
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006031 * @param admin Which device owner this request is associated with.
6032 * @return Device logs from before the latest reboot of the system.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006033 * @throws SecurityException if {@code admin} is not a device owner.
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006034 */
Michal Karpinski6235a942016-03-15 12:07:23 +00006035 public List<SecurityEvent> retrievePreRebootSecurityLogs(@NonNull ComponentName admin) {
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006036 try {
Michal Karpinski6235a942016-03-15 12:07:23 +00006037 ParceledListSlice<SecurityEvent> list = mService.retrievePreRebootSecurityLogs(admin);
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006038 return list.getList();
6039 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006040 throw re.rethrowFromSystemServer();
Rubin Xuc3cd05f2016-01-11 12:11:35 +00006041 }
6042 }
6043
6044 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006045 * Called by a profile owner of a managed profile to set the color used for customization. This
6046 * color is used as background color of the confirm credentials screen for that user. The
Clara Bayarri8d0bd7fa2016-03-30 14:59:58 +01006047 * default color is teal (#00796B).
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006048 * <p>
6049 * The confirm credentials screen can be created using
Benjamin Franz59720bb2016-01-18 15:26:11 +00006050 * {@link android.app.KeyguardManager#createConfirmDeviceCredentialIntent}.
6051 *
6052 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6053 * @param color The 32bit representation of the color to be used.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006054 * @throws SecurityException if {@code admin} is not a profile owner.
Benjamin Franz59720bb2016-01-18 15:26:11 +00006055 */
6056 public void setOrganizationColor(@NonNull ComponentName admin, int color) {
6057 try {
6058 mService.setOrganizationColor(admin, color);
6059 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006060 throw re.rethrowFromSystemServer();
Benjamin Franz59720bb2016-01-18 15:26:11 +00006061 }
6062 }
6063
6064 /**
Nicolas Prevot8f7698a2016-02-11 16:05:33 +00006065 * @hide
6066 *
6067 * Sets the color used for customization.
6068 *
6069 * @param color The 32bit representation of the color to be used.
6070 * @param userId which user to set the color to.
6071 * @RequiresPermission(allOf = {
6072 * Manifest.permission.MANAGE_USERS,
6073 * Manifest.permission.INTERACT_ACROSS_USERS_FULL})
6074 */
6075 public void setOrganizationColorForUser(@ColorInt int color, @UserIdInt int userId) {
6076 try {
6077 mService.setOrganizationColorForUser(color, userId);
6078 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006079 throw re.rethrowFromSystemServer();
Nicolas Prevot8f7698a2016-02-11 16:05:33 +00006080 }
6081 }
6082
6083 /**
Benjamin Franz59720bb2016-01-18 15:26:11 +00006084 * Called by a profile owner of a managed profile to retrieve the color used for customization.
6085 * This color is used as background color of the confirm credentials screen for that user.
6086 *
6087 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6088 * @return The 32bit representation of the color to be used.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006089 * @throws SecurityException if {@code admin} is not a profile owner.
Benjamin Franz59720bb2016-01-18 15:26:11 +00006090 */
6091 public int getOrganizationColor(@NonNull ComponentName admin) {
6092 try {
6093 return mService.getOrganizationColor(admin);
6094 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006095 throw re.rethrowFromSystemServer();
Benjamin Franz59720bb2016-01-18 15:26:11 +00006096 }
6097 }
6098
6099 /**
6100 * @hide
6101 * Retrieve the customization color for a given user.
6102 *
6103 * @param userHandle The user id of the user we're interested in.
6104 * @return The 32bit representation of the color to be used.
6105 */
6106 public int getOrganizationColorForUser(int userHandle) {
6107 try {
6108 return mService.getOrganizationColorForUser(userHandle);
6109 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006110 throw re.rethrowFromSystemServer();
Benjamin Franz59720bb2016-01-18 15:26:11 +00006111 }
6112 }
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01006113
6114 /**
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006115 * Called by a profile owner of a managed profile to set the name of the organization under
6116 * management.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006117 * <p>
6118 * If the organization name needs to be localized, it is the responsibility of the
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006119 * {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
6120 * and set a new version of this string accordingly.
6121 *
6122 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6123 * @param title The organization name or {@code null} to clear a previously set name.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006124 * @throws SecurityException if {@code admin} is not a profile owner.
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006125 */
6126 public void setOrganizationName(@NonNull ComponentName admin, @Nullable String title) {
6127 try {
6128 mService.setOrganizationName(admin, title);
6129 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006130 throw re.rethrowFromSystemServer();
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006131 }
6132 }
6133
6134 /**
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006135 * Called by a profile owner of a managed profile to retrieve the name of the organization under
6136 * management.
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006137 *
6138 * @param admin Which {@link DeviceAdminReceiver} this request is associated with.
6139 * @return The organization name or {@code null} if none is set.
Suprabh Shukla34d92ef2016-03-14 13:49:37 -07006140 * @throws SecurityException if {@code admin} is not a profile owner.
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006141 */
6142 public String getOrganizationName(@NonNull ComponentName admin) {
6143 try {
6144 return mService.getOrganizationName(admin);
6145 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006146 throw re.rethrowFromSystemServer();
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006147 }
6148 }
6149
6150 /**
6151 * Retrieve the default title message used in the confirm credentials screen for a given user.
6152 *
6153 * @param userHandle The user id of the user we're interested in.
6154 * @return The organization name or {@code null} if none is set.
6155 *
6156 * @hide
6157 */
6158 public String getOrganizationNameForUser(int userHandle) {
6159 try {
6160 return mService.getOrganizationNameForUser(userHandle);
6161 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006162 throw re.rethrowFromSystemServer();
Benjamin Franz3e8a7092016-01-25 16:19:08 +00006163 }
6164 }
6165
6166 /**
Alan Treadwayafad8782016-01-19 15:15:08 +00006167 * @return the {@link UserProvisioningState} for the current user - for unmanaged users will
6168 * return {@link #STATE_USER_UNMANAGED}
6169 * @hide
6170 */
Benjamin Franzeed2a8e2016-02-19 14:19:05 +00006171 @SystemApi
Alan Treadwayafad8782016-01-19 15:15:08 +00006172 @UserProvisioningState
6173 public int getUserProvisioningState() {
6174 if (mService != null) {
6175 try {
6176 return mService.getUserProvisioningState();
6177 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006178 throw e.rethrowFromSystemServer();
Alan Treadwayafad8782016-01-19 15:15:08 +00006179 }
6180 }
6181 return STATE_USER_UNMANAGED;
6182 }
6183
6184 /**
6185 * Set the {@link UserProvisioningState} for the supplied user, if they are managed.
6186 *
6187 * @param state to store
6188 * @param userHandle for user
6189 * @hide
6190 */
6191 public void setUserProvisioningState(@UserProvisioningState int state, int userHandle) {
6192 if (mService != null) {
6193 try {
6194 mService.setUserProvisioningState(state, userHandle);
6195 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006196 throw e.rethrowFromSystemServer();
Alan Treadwayafad8782016-01-19 15:15:08 +00006197 }
6198 }
6199 }
6200
6201 /**
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01006202 * @hide
6203 * Indicates the entity that controls the device or profile owner. A user/profile is considered
6204 * affiliated if it is managed by the same entity as the device.
6205 *
6206 * <p> By definition, the user that the device owner runs on is always affiliated. Any other
6207 * user/profile is considered affiliated if the following conditions are both met:
6208 * <ul>
6209 * <li>The device owner and the user's/profile's profile owner have called this method,
6210 * specifying a set of opaque affiliation ids each. If the sets specified by the device owner
6211 * and a profile owner intersect, they must have come from the same source, which means that
6212 * the device owner and profile owner are controlled by the same entity.</li>
6213 * <li>The device owner's and profile owner's package names are the same.</li>
6214 * </ul>
6215 *
6216 * @param admin Which profile or device owner this request is associated with.
6217 * @param ids A set of opaque affiliation ids.
6218 */
6219 public void setAffiliationIds(@NonNull ComponentName admin, Set<String> ids) {
6220 try {
6221 mService.setAffiliationIds(admin, new ArrayList<String>(ids));
6222 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006223 throw e.rethrowFromSystemServer();
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01006224 }
6225 }
6226
6227 /**
6228 * @hide
6229 * Returns whether this user/profile is affiliated with the device. See
6230 * {@link #setAffiliationIds} for the definition of affiliation.
6231 *
6232 * @return whether this user/profile is affiliated with the device.
6233 */
6234 public boolean isAffiliatedUser() {
6235 try {
6236 return mService != null && mService.isAffiliatedUser();
6237 } catch (RemoteException e) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006238 throw e.rethrowFromSystemServer();
Bartosz Fabianowski4c052f22016-01-25 14:18:43 +01006239 }
6240 }
Suprabh Shuklaa2ae2232016-01-28 18:05:14 -08006241
6242 /**
6243 * @hide
6244 * Returns whether the uninstall for {@code packageName} for the current user is in queue
6245 * to be started
6246 * @param packageName the package to check for
6247 * @return whether the uninstall intent for {@code packageName} is pending
6248 */
6249 public boolean isUninstallInQueue(String packageName) {
6250 try {
6251 return mService.isUninstallInQueue(packageName);
6252 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006253 throw re.rethrowFromSystemServer();
Suprabh Shuklaa2ae2232016-01-28 18:05:14 -08006254 }
6255 }
6256
6257 /**
6258 * @hide
6259 * @param packageName the package containing active DAs to be uninstalled
6260 */
6261 public void uninstallPackageWithActiveAdmins(String packageName) {
6262 try {
6263 mService.uninstallPackageWithActiveAdmins(packageName);
6264 } catch (RemoteException re) {
Jeff Sharkeydbff9ca2016-03-01 19:46:25 -07006265 throw re.rethrowFromSystemServer();
Suprabh Shuklaa2ae2232016-01-28 18:05:14 -08006266 }
6267 }
Dianne Hackbornd6847842010-01-12 18:14:19 -08006268}